From 92766df286bbb6ca47c04b59bc4c5d6cfd5c0703 Mon Sep 17 00:00:00 2001 From: Chenjie Shi Date: Fri, 15 Dec 2023 06:29:36 +0800 Subject: [PATCH] Add type info for additional properties in model type (#18) --- .../additional_properties_2023-12-13-06-56.json | 10 ++++++++++ packages/typespec-client-generator-core/doc/types.tsp | 4 ++-- .../typespec-client-generator-core/src/interfaces.ts | 2 +- packages/typespec-client-generator-core/src/types.ts | 10 +++++++--- .../typespec-client-generator-core/test/types.test.ts | 10 +++++----- 5 files changed, 25 insertions(+), 11 deletions(-) create mode 100644 common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json diff --git a/common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json b/common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json new file mode 100644 index 0000000000..71cf19e637 --- /dev/null +++ b/common/changes/@azure-tools/typespec-client-generator-core/additional_properties_2023-12-13-06-56.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@azure-tools/typespec-client-generator-core", + "comment": "Add type info for additional properties in model type.", + "type": "none" + } + ], + "packageName": "@azure-tools/typespec-client-generator-core" +} \ No newline at end of file diff --git a/packages/typespec-client-generator-core/doc/types.tsp b/packages/typespec-client-generator-core/doc/types.tsp index e060584800..0b601e25a6 100644 --- a/packages/typespec-client-generator-core/doc/types.tsp +++ b/packages/typespec-client-generator-core/doc/types.tsp @@ -219,7 +219,7 @@ model SdkUnionType extends SdkType { * @property properties: List of properties on the model * @property access: Access level of the model * @property usage: Usage cases for the model. Used to filter when people only want input or output models. - * @property additionalProperties: Whether the model has additional properties + * @property additionalProperties: Model's additional properties type, if no additional properties, then undefined * @property discriminatorValue: Value of the discriminator if this is a discriminated subtype. Will be undefined if not. * @property discriminatedSubtypes: Mapping of discriminator value to this models discriminated subtypes if there are any. * @property baseModel: The base model class of this model type if one exists. @@ -233,7 +233,7 @@ model SdkModelType extends SdkType { properties: SdkModelPropertyType[]; access: AccessFlags; usage: UsageFlags; - additionalProperties: boolean; + additionalProperties?: SdkType; dicriminatorValue?: string; discriminatedSubtypes?: Record; baseModel?: SdkModelType; diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts index eef8f936ff..5332019d26 100644 --- a/packages/typespec-client-generator-core/src/interfaces.ts +++ b/packages/typespec-client-generator-core/src/interfaces.ts @@ -197,7 +197,7 @@ export interface SdkModelType extends SdkTypeBase { details?: string; access: AccessFlags | undefined; usage: UsageFlags; - additionalProperties: boolean; + additionalProperties: SdkType | undefined; discriminatorValue?: string; discriminatedSubtypes?: Record; baseModel?: SdkModelType; diff --git a/packages/typespec-client-generator-core/src/types.ts b/packages/typespec-client-generator-core/src/types.ts index a337246d95..4ed10a81b7 100644 --- a/packages/typespec-client-generator-core/src/types.ts +++ b/packages/typespec-client-generator-core/src/types.ts @@ -493,7 +493,7 @@ export function getSdkModel(context: SdkContext, type: Model, operation?: Operat description: docWrapper.description, details: docWrapper.details, properties: [], - additionalProperties: false, // going to set additional properties in the next few lines when we look at base model + additionalProperties: undefined, // going to set additional properties in the next few lines when we look at base model access: undefined, // dummy value since we need to update models map before we can set this usage: UsageFlags.None, // dummy value since we need to update models map before we can set this crossLanguageDefinitionId: getCrossLanguageDefinitionId(type), @@ -502,7 +502,11 @@ export function getSdkModel(context: SdkContext, type: Model, operation?: Operat updateModelsMap(context, type, sdkType, operation); // model MyModel is Record<> {} should be model with additional properties if (type.sourceModel?.kind === "Model" && type.sourceModel?.name === "Record") { - sdkType.additionalProperties = true; + sdkType.additionalProperties = getClientType( + context, + type.sourceModel!.indexer!.value!, + operation + ); } if (type.baseModel) { sdkType.baseModel = context.modelsMap?.get(type.baseModel) as SdkModelType | undefined; @@ -512,7 +516,7 @@ export function getSdkModel(context: SdkContext, type: Model, operation?: Operat | SdkModelType; if (baseModel.kind === "dict") { // model MyModel extends Record<> {} should be model with additional properties - sdkType.additionalProperties = true; + sdkType.additionalProperties = baseModel.valueType; } else { sdkType.baseModel = baseModel; updateModelsMap(context, type.baseModel, sdkType.baseModel, operation); diff --git a/packages/typespec-client-generator-core/test/types.test.ts b/packages/typespec-client-generator-core/test/types.test.ts index 5ca1888f51..0a740fb226 100644 --- a/packages/typespec-client-generator-core/test/types.test.ts +++ b/packages/typespec-client-generator-core/test/types.test.ts @@ -1727,7 +1727,7 @@ describe("typespec-client-generator-core: types", () => { const Test6 = models.find((x) => x.name === "Test6")!; strictEqual(Test6.access, undefined); }); - it("additionalProperties true", async () => { + it("additionalProperties string", async () => { await runner.compileWithBuiltInService(` @usage(Usage.input | Usage.output) @access(Access.public) @@ -1736,7 +1736,7 @@ describe("typespec-client-generator-core: types", () => { } @usage(Usage.input | Usage.output) @access(Access.public) - model AdditionalPropertiesModel2 is Record { + model AdditionalPropertiesModel2 is Record { prop: string; } @usage(Usage.input | Usage.output) @@ -1756,11 +1756,11 @@ describe("typespec-client-generator-core: types", () => { const NonAdditionalPropertiesModel = models.find( (x) => x.name === "NoAdditionalPropertiesModel" )! as SdkModelType; - strictEqual(AdditionalPropertiesModel.additionalProperties, true); + strictEqual(AdditionalPropertiesModel.additionalProperties?.kind, "string"); strictEqual(AdditionalPropertiesModel.baseModel, undefined); - strictEqual(AdditionalPropertiesModel2.additionalProperties, true); + strictEqual(AdditionalPropertiesModel2.additionalProperties?.kind, "any"); strictEqual(AdditionalPropertiesModel2.baseModel, undefined); - strictEqual(NonAdditionalPropertiesModel.additionalProperties, false); + strictEqual(NonAdditionalPropertiesModel.additionalProperties, undefined); }); it("crossLanguageDefinitionId", async () => { await runner.compile(`