@azure-tools/typespec-ts 0.28.0 → 0.29.0-alpha.20240531.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.28.0",
+  "version": "0.29.0-alpha.20240531.1",
   "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
@@ -21,40 +21,41 @@
     "ts-node": "~10.9.1",
     "typescript": "~5.4.5",
     "prettier": "^3.1.0",
-    "@azure-tools/cadl-ranch-specs": "^0.31.8",
-    "@azure-tools/cadl-ranch-expect": "^0.13.3",
-    "@azure-tools/cadl-ranch": "^0.12.7",
+    "@azure-tools/cadl-ranch-specs": "^0.33.4",
+    "@azure-tools/cadl-ranch-expect": "^0.13.4",
+    "@azure-tools/cadl-ranch": "^0.12.8",
     "chalk": "^4.0.0",
     "@azure-rest/core-client": "^2.0.0",
     "@azure/core-auth": "^1.6.0",
     "cross-env": "^7.0.3",
     "@azure/core-paging": "^1.5.0",
-    "@azure/core-lro": "^2.5.4",
+    "@azure/core-lro": "3.0.0-beta.1",
     "@azure/core-rest-pipeline": "^1.14.0",
+    "@azure/abort-controller": "^2.0.0",
     "@azure/logger": "^1.0.4",
     "@azure/core-util": "^1.4.0",
     "eslint-plugin-require-extensions": "0.1.3",
     "@typespec/ts-http-runtime": "1.0.0-alpha.20240314.2",
-    "@azure-tools/typespec-azure-core": ">=0.41.0 <1.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.41.5 <1.0.0",
-    "@typespec/compiler": ">=0.55.0 <1.0.0",
-    "@typespec/http": ">=0.55.0 <1.0.0",
-    "@typespec/rest": ">=0.55.0 <1.0.0",
-    "@typespec/versioning": ">=0.55.0 <1.0.0",
+    "@azure-tools/typespec-azure-core": ">=0.42.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.42.2 <1.0.0",
+    "@typespec/compiler": ">=0.56.0 <1.0.0",
+    "@typespec/http": ">=0.56.0 <1.0.0",
+    "@typespec/rest": ">=0.56.0 <1.0.0",
+    "@typespec/versioning": ">=0.56.0 <1.0.0",
     "npm-run-all": "~4.1.5"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": ">=0.41.0 <1.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.41.5 <1.0.0",
-    "@typespec/compiler": ">=0.55.0 <1.0.0",
-    "@typespec/http": ">=0.55.0 <1.0.0",
-    "@typespec/rest": ">=0.55.0 <1.0.0",
-    "@typespec/versioning": ">=0.55.0 <1.0.0"
+    "@azure-tools/typespec-azure-core": ">=0.42.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.42.2 <1.0.0",
+    "@typespec/compiler": ">=0.56.0 <1.0.0",
+    "@typespec/http": ">=0.56.0 <1.0.0",
+    "@typespec/rest": ">=0.56.0 <1.0.0",
+    "@typespec/versioning": ">=0.56.0 <1.0.0"
   },
   "dependencies": {
     "prettier": "^3.1.0",
     "tslib": "^2.3.1",
-    "@azure-tools/rlc-common": "^0.28.0",
+    "@azure-tools/rlc-common": "^0.29.0",
     "ts-morph": "^15.1.0",
     "fs-extra": "^11.1.0"
   },

package/src/index.ts

@@ -62,6 +62,10 @@ import {
 } from "./modular/buildPagingFiles.js";
 import { EmitterOptions } from "./lib.js";
 import { getModuleExports } from "./modular/buildProjectFiles.js";
+import {
+  buildGetPollerHelper,
+  buildRestorePollerHelper
+} from "./modular/buildLroFiles.js";
 
 export * from "./lib.js";
 
@@ -124,28 +128,6 @@ export async function $onEmit(context: EmitContext) {
     };
   }
 
-  function createContextWithDefaultOptions(
-    context: EmitContext<Record<string, any>>
-  ): SdkContext {
-    const tcgcSettings = {
-      "generate-protocol-methods": true,
-      "generate-convenience-methods": true,
-      "flatten-union-as-enum": false,
-      emitters: [
-        {
-          main: "@azure-tools/typespec-ts",
-          metadata: { name: "@azure-tools/typespec-ts" }
-        }
-      ]
-    };
-    context.options = {
-      ...context.options,
-      ...tcgcSettings
-    };
-
-    return createSdkContext(context) as SdkContext;
-  }
-
   async function clearSrcFolder() {
     await fsextra.emptyDir(
       dpgContext.generationPathDetail?.modularSourcesDir ??
@@ -216,6 +198,7 @@ export async function $onEmit(context: EmitContext) {
         const hasClientUnexpectedHelper =
           needUnexpectedHelper.get(subClient.rlcClientName) ?? false;
         buildSerializeUtils(modularCodeModel);
+        // build paging files
         buildPagingTypes(subClient, modularCodeModel);
         buildModularPagingHelpers(
           subClient,
@@ -223,6 +206,7 @@ export async function $onEmit(context: EmitContext) {
           hasClientUnexpectedHelper,
           isMultiClients
         );
+        // build operation files
         buildOperationFiles(
           subClient,
           dpgContext,
@@ -231,6 +215,14 @@ export async function $onEmit(context: EmitContext) {
         );
         buildClientContext(subClient, dpgContext, modularCodeModel);
         buildSubpathIndexFile(subClient, modularCodeModel, "models");
+        // build lro files
+        buildGetPollerHelper(
+          modularCodeModel,
+          subClient,
+          hasClientUnexpectedHelper,
+          isMultiClients
+        );
+        buildRestorePollerHelper(modularCodeModel, subClient);
         if (dpgContext.rlcOptions?.hierarchyClient) {
           buildSubpathIndexFile(subClient, modularCodeModel, "api");
         } else {
@@ -333,3 +325,25 @@ export async function $onEmit(context: EmitContext) {
     }
   }
 }
+
+export function createContextWithDefaultOptions(
+  context: EmitContext<Record<string, any>>
+): SdkContext {
+  const tcgcSettings = {
+    "generate-protocol-methods": true,
+    "generate-convenience-methods": true,
+    "flatten-union-as-enum": false,
+    emitters: [
+      {
+        main: "@azure-tools/typespec-ts",
+        metadata: { name: "@azure-tools/typespec-ts" }
+      }
+    ]
+  };
+  context.options = {
+    ...context.options,
+    ...tcgcSettings
+  };
+
+  return createSdkContext(context) as SdkContext;
+}

package/src/lib.ts

@@ -11,6 +11,7 @@ import { Options } from "prettier";
 
 export interface EmitterOptions extends RLCOptions {
   branded?: boolean;
+  compatibilityMode?: boolean;
 }
 
 export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
@@ -88,7 +89,8 @@ export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
       nullable: true,
       enum: ["esm", "cjs"],
       default: "esm"
-    }
+    },
+    compatibilityMode: { type: "boolean", nullable: true }
   },
   required: []
 };
@@ -150,7 +152,7 @@ const libDef = {
     "invalid-schema": {
       severity: "error",
       messages: {
-        default: paramMessage`Couldn't get schema for type ${"type"}`
+        default: paramMessage`Couldn't get schema for type ${"type"} with property ${"property"}`
       }
     },
     "union-null": {
@@ -221,6 +223,12 @@ const libDef = {
       messages: {
         default: paramMessage`Please note the header ${"type"} is not serializable.`
       }
+    },
+    "compatible-additional-properties": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`Please note that only compatible additional properties is supported for now. You can enable compatibilityMode to generate compatible additional properties for the model - ${"modelName"}.`
+      }
     }
   },
   emitter: {

package/src/modular/buildClassicalClient.ts

@@ -21,6 +21,7 @@ import { Imports as RuntimeImports } from "@azure-tools/rlc-common";
 import { NameType, normalizeName } from "@azure-tools/rlc-common";
 import { getOperationFunction } from "./helpers/operationHelpers.js";
 import { getImportSpecifier } from "@azure-tools/rlc-common";
+import { importLroCoreDependencies } from "./buildLroFiles.js";
 
 export function buildClassicalClient(
   client: Client,
@@ -89,6 +90,7 @@ export function buildClassicalClient(
       .join(",")})`
   ]);
   constructor.addStatements(`this.pipeline = this._client.pipeline`);
+  importLroCoreDependencies(clientFile);
   importCredential(codeModel.runtimeImports, clientFile);
   importPipeline(codeModel.runtimeImports, clientFile);
   importAllModels(clientFile, srcPath, subfolder);

package/src/modular/buildClassicalOperationGroups.ts

@@ -8,6 +8,7 @@ import { getClassicalOperation } from "./helpers/classicalOperationHelpers.js";
 import { getClassicalLayerPrefix } from "./helpers/namingHelpers.js";
 import { SourceFile } from "ts-morph";
 import { importModels, importPagingDependencies } from "./buildOperations.js";
+import { importLroCoreDependencies } from "./buildLroFiles.js";
 
 export function buildClassicOperationFiles(
   codeModel: ModularCodeModel,
@@ -60,6 +61,7 @@ export function buildClassicOperationFiles(
         subfolder,
         operationGroup.namespaceHierarchies.length
       );
+      importLroCoreDependencies(classicFile);
       classicFile.fixMissingImports();
       classicFile.fixUnusedIdentifiers();
       classicOperationFiles.set(classicOperationFileName, classicFile);
@@ -107,6 +109,8 @@ export function buildClassicOperationFiles(
           subfolder,
           operationGroup.namespaceHierarchies.length
         );
+        importLroCoreDependencies(classicFile);
+
         classicFile.fixMissingImports();
         classicFile.fixUnusedIdentifiers();
         classicOperationFiles.set(classicOperationFileName, classicFile);

package/src/modular/buildCodeModel.ts

@@ -1,4 +1,7 @@
-import { getPagedResult } from "@azure-tools/typespec-azure-core";
+import {
+  getPagedResult,
+  getLroMetadata
+} from "@azure-tools/typespec-azure-core";
 import {
   Enum,
   getDoc,
@@ -17,7 +20,6 @@ import {
   ModelProperty,
   Namespace,
   Program,
-  getEffectiveModelType,
   getDiscriminator,
   Operation,
   Scalar,
@@ -34,20 +36,17 @@ import {
   isNullType,
   getEncode,
   isTemplateDeclarationOrInstance,
-  UsageFlags
+  UsageFlags,
+  isVoidType
 } from "@typespec/compiler";
 import {
   getAuthentication,
-  getHeaderFieldName,
-  getPathParamName,
-  getQueryParamName,
   getServers,
   HttpAuth,
   HttpOperationParameter,
   HttpOperationResponse,
   HttpOperationResponseContent,
   HttpServer,
-  isStatusCode,
   HttpOperation,
   getHttpOperation,
   isSharedRoute
@@ -81,9 +80,12 @@ import {
   Property
 } from "./modularCodeModel.js";
 import {
+  buildCoreTypeInfo,
   getBodyType,
   getDefaultApiVersionString,
-  isAzureCoreErrorType
+  getEffectiveSchemaType,
+  isAzureCoreErrorType,
+  isSchemaProperty
 } from "../utils/modelUtils.js";
 import { camelToSnakeCase, toCamelCase } from "../utils/casingUtils.js";
 import {
@@ -107,6 +109,7 @@ import { buildRuntimeImports } from "@azure-tools/rlc-common";
 import { getModelNamespaceName } from "../utils/namespaceUtils.js";
 import { reportDiagnostic } from "../lib.js";
 import { getType as getTypeName } from "./helpers/typeHelpers.js";
+import { isModelWithAdditionalProperties } from "./emitModels.js";
 
 interface HttpServerParameter {
   type: "endpointPath";
@@ -235,47 +238,6 @@ function handleDiscriminator(
   return undefined;
 }
 
-function isSchemaProperty(program: Program, property: ModelProperty): boolean {
-  const headerInfo = getHeaderFieldName(program, property);
-  const queryInfo = getQueryParamName(program, property);
-  const pathInfo = getPathParamName(program, property);
-  const statusCodeinfo = isStatusCode(program, property);
-  return !(headerInfo || queryInfo || pathInfo || statusCodeinfo);
-}
-
-function getEffectiveSchemaType(program: Program, type: Model | Union): Model {
-  function isSchemaProperty(property: ModelProperty): boolean {
-    const headerInfo = getHeaderFieldName(program, property);
-    const queryInfo = getQueryParamName(program, property);
-    const pathInfo = getPathParamName(program, property);
-    const statusCodeinfo = isStatusCode(program, property);
-    return !(headerInfo || queryInfo || pathInfo || statusCodeinfo);
-  }
-
-  // If type is an anonymous model, tries to find a named model that has the same properties
-  let effective: Model | undefined = undefined;
-  if (type.kind === "Union") {
-    const nonNullOptions = [...type.variants.values()]
-      .map((x) => x.type)
-      .filter((t) => !isNullType(t));
-    if (
-      nonNullOptions.length === 1 &&
-      nonNullOptions[0]?.kind === "Model" &&
-      nonNullOptions[0]?.name === ""
-    ) {
-      effective = getEffectiveModelType(program, nonNullOptions[0]);
-    }
-    return type as any;
-  } else if (type.name === "") {
-    effective = getEffectiveModelType(program, type, isSchemaProperty);
-  }
-
-  if (effective?.name) {
-    return effective;
-  }
-  return type as Model;
-}
-
 function processModelProperties(
   context: SdkContext,
   newValue: any,
@@ -381,6 +343,10 @@ function getType(
     if (type.kind === "Model") {
       // need to do properties after insertion to avoid infinite recursion
       processModelProperties(context, newValue, type, options.usage!);
+      if (newValue.type === "dict") {
+        newValue = { ...emitModel(context, type, options.usage!), ...newValue };
+        typesMap.set(effectiveModel, newValue);
+      }
     }
   } else {
     const key = JSON.stringify(newValue);
@@ -391,7 +357,19 @@ function getType(
       simpleTypesMap.set(key, newValue);
     }
   }
-
+  if (
+    type.kind === "Model" &&
+    isModelWithAdditionalProperties(newValue) &&
+    !context.rlcOptions?.compatibilityMode
+  ) {
+    reportDiagnostic(context.program, {
+      code: "compatible-additional-properties",
+      format: {
+        modelName: type?.name ?? ""
+      },
+      target: type
+    });
+  }
   return newValue;
 }
 
@@ -583,13 +561,14 @@ function emitResponseHeaders(
 
 function emitResponse(
   context: SdkContext,
+  operation: Operation,
   response: HttpOperationResponse,
   innerResponse: HttpOperationResponseContent
 ): Response {
   let type = undefined;
   if (
     innerResponse.body?.type &&
-    !isAzureCoreErrorType(innerResponse.body?.type)
+    !isAzureCoreErrorType(context.program, innerResponse.body?.type)
   ) {
     // temporary logic. It can be removed after compiler optimize the response
     const candidate = [
@@ -604,10 +583,18 @@ function emitResponse(
     ) {
       const modelType = getEffectiveSchemaType(context.program, originType);
       type = getType(context, modelType, { usage: UsageFlags.Output });
+    } else if (isLroResponse()) {
+      const metadata = getLroMetadata(context.program, operation);
+      type =
+        metadata?.finalResult === "void" || metadata?.finalResult === undefined
+          ? undefined
+          : getType(context, metadata.finalResult);
     } else {
-      type = getType(context, innerResponse.body.type, {
-        usage: UsageFlags.Output
-      });
+      type = isVoidType(innerResponse.body.type)
+        ? undefined
+        : getType(context, innerResponse.body.type, {
+            usage: UsageFlags.Output
+          });
     }
   }
   const statusCodes: (number | "default")[] = [];
@@ -630,6 +617,14 @@ function emitResponse(
         )
       : false
   };
+
+  function isLroResponse() {
+    return (
+      typeof response.statusCodes === "number" &&
+      ["200", "201", "202"]?.includes(`${response.statusCodes}`) &&
+      !!getLroMetadata(context.program, operation)
+    );
+  }
 }
 
 function emitOperation(
@@ -640,15 +635,16 @@ function emitOperation(
   hierarchies: string[]
 ): HrlcOperation {
   const isAzureFlavor = rlcModels.options?.flavor === "azure";
+  const emittedOperation = emitBasicOperation(
+    context,
+    operation,
+    operationGroupName,
+    rlcModels,
+    hierarchies
+  );
   // Skip to extract paging and lro information for non-branded clients.
   if (!isAzureFlavor) {
-    return emitBasicOperation(
-      context,
-      operation,
-      operationGroupName,
-      rlcModels,
-      hierarchies
-    );
+    return emittedOperation;
   }
   const lro = isLongRunningOperation(
     context.program,
@@ -673,51 +669,46 @@ function emitOperation(
     });
   }
 
-  if (lro && paging) {
-    return emitLroPagingOperation(
-      context,
-      operation,
-      operationGroupName,
-      rlcModels,
-      hierarchies
-    );
-  } else if (paging) {
-    return emitPagingOperation(
-      context,
-      operation,
-      operationGroupName,
-      rlcModels,
-      hierarchies
-    );
-  } else if (lro) {
-    return emitLroOperation(
-      context,
-      operation,
-      operationGroupName,
-      rlcModels,
-      hierarchies
-    );
+  emitExtraInfoForOperation(emittedOperation);
+  return emittedOperation;
+
+  function emitExtraInfoForOperation(emittedOperation: HrlcOperation) {
+    if (lro) {
+      addLroInformation(context, operation, emittedOperation);
+    }
+    if (paging) {
+      addPagingInformation(context, operation, emittedOperation);
+    }
+    if (lro && paging) {
+      emittedOperation["discriminator"] = "lropaging";
+    }
   }
-  return emitBasicOperation(
-    context,
-    operation,
-    operationGroupName,
-    rlcModels,
-    hierarchies
-  );
 }
 
-function addLroInformation(emittedOperation: HrlcOperation) {
+function addLroInformation(
+  context: SdkContext,
+  operation: Operation,
+  emittedOperation: HrlcOperation
+) {
   emittedOperation["discriminator"] = "lro";
+  const metadata = getLroMetadata(context.program, operation);
+  emittedOperation["lroMetadata"] = {
+    finalResult:
+      metadata?.finalResult === "void" || metadata?.finalResult === undefined
+        ? undefined
+        : getType(context, metadata.finalResult),
+    finalStateVia: metadata?.finalStateVia,
+    finalResultPath: metadata?.finalResultPath
+  };
 }
 
 function addPagingInformation(
-  program: Program,
+  context: SdkContext,
   operation: Operation,
   emittedOperation: Record<string, any>
 ) {
   emittedOperation["discriminator"] = "paging";
-  const pagedResult = getPagedResult(program, operation);
+  const pagedResult = getPagedResult(context.program, operation);
   if (pagedResult === undefined) {
     throw Error(
       "Trying to add paging information, but not paging metadata for this operation"
@@ -727,62 +718,6 @@ function addPagingInformation(
   emittedOperation["continuationTokenName"] = parseNextLinkName(pagedResult);
 }
 
-function emitLroPagingOperation(
-  context: SdkContext,
-  operation: Operation,
-  operationGroupName: string,
-  rlcModels: RLCModel,
-  hierarchies: string[]
-): HrlcOperation {
-  const emittedOperation = emitBasicOperation(
-    context,
-    operation,
-    operationGroupName,
-    rlcModels,
-    hierarchies
-  );
-  addLroInformation(emittedOperation);
-  addPagingInformation(context.program, operation, emittedOperation);
-  emittedOperation["discriminator"] = "lropaging";
-  return emittedOperation;
-}
-
-function emitLroOperation(
-  context: SdkContext,
-  operation: Operation,
-  operationGroupName: string,
-  rlcModels: RLCModel,
-  hierarchies: string[]
-): HrlcOperation {
-  const emittedOperation = emitBasicOperation(
-    context,
-    operation,
-    operationGroupName,
-    rlcModels,
-    hierarchies
-  );
-  addLroInformation(emittedOperation);
-  return emittedOperation;
-}
-
-function emitPagingOperation(
-  context: SdkContext,
-  operation: Operation,
-  operationGroupName: string,
-  rlcModels: RLCModel,
-  hierarchies: string[]
-): HrlcOperation {
-  const emittedOperation = emitBasicOperation(
-    context,
-    operation,
-    operationGroupName,
-    rlcModels,
-    hierarchies
-  );
-  addPagingInformation(context.program, operation, emittedOperation);
-  return emittedOperation;
-}
-
 function emitBasicOperation(
   context: SdkContext,
   operation: Operation,
@@ -853,6 +788,7 @@ function emitBasicOperation(
     for (const innerResponse of response.responses) {
       const emittedResponse: Response = emitResponse(
         context,
+        operation,
         response,
         innerResponse
       );
@@ -868,7 +804,10 @@ function emitBasicOperation(
   }
 
   let bodyParameter: any | undefined;
-  if (httpOperation.parameters.body === undefined) {
+  if (
+    httpOperation.parameters.body === undefined ||
+    isVoidType(httpOperation.parameters.body.type)
+  ) {
     bodyParameter = undefined;
   } else {
     bodyParameter = emitBodyParameter(context, httpOperation);
@@ -1080,7 +1019,7 @@ function emitModel(
       ? applyCasing(modelName, { casing: CASING })
       : modelName,
     base: modelName === "" ? "json" : "dpg",
-    isCoreErrorType: isAzureCoreErrorType(type),
+    coreTypeInfo: buildCoreTypeInfo(context.program, type),
     usage
   };
 }
@@ -1116,7 +1055,8 @@ function emitEnum(context: SdkContext, type: Enum): Record<string, any> {
     description: getDocStr(program, type),
     valueType: { type: enumMemberType(type.members.values().next().value) },
     values: enumValues,
-    isFixed: true
+    isFixed: true,
+    coreTypeInfo: buildCoreTypeInfo(program, type)
   };
 }
 
@@ -1346,6 +1286,7 @@ function emitListOrDict(
       if (name === "string") {
         return {
           type: "dict",
+          name: type.name,
           elementType: getType(context, type.indexer.value!, { usage })
         };
       } else if (name === "integer") {
@@ -1694,6 +1635,7 @@ function emitServerParams(
       if (isApiVersion(context, serverParameter as any)) {
         emittedParameter.isApiVersion = true;
         serverApiVersionParam = emittedParameter;
+        emittedParameter.isApiVersion = true;
       }
       params.push(emittedParameter);
     }
@@ -1870,7 +1812,10 @@ export function emitCodeModel(
   // Get types
   const codeModel: ModularCodeModel = {
     options: dpgContext.rlcOptions ?? {},
-    modularOptions: { sourceRoot: modularSourcesRoot },
+    modularOptions: {
+      sourceRoot: modularSourcesRoot,
+      compatibilityMode: !!dpgContext.rlcOptions?.compatibilityMode
+    },
     namespace: clientNamespaceString,
     subnamespaceToClients: {},
     clients: [],