@azure-tools/typespec-ts 0.54.0-dev.6 → 0.54.0-dev.8

package/src/modular/buildClientContext.ts

@@ -1,50 +1,43 @@
-import { ModularEmitterOptions } from "./interfaces.js";
-import {
-  NameType,
-  isAzurePackage,
-  normalizeName
-} from "../rlc-common/index.js";
+import { NameType, isAzurePackage, normalizeName } from "../rlc-common/index.js";
 import {
   buildGetClientCredentialParam,
   buildGetClientEndpointParam,
   buildGetClientOptionsParam,
   getClientParameterName,
   getClientParameters,
-  getClientParametersDeclaration
+  getClientParametersDeclaration,
 } from "./helpers/clientHelpers.js";
+import { ModularEmitterOptions } from "./interfaces.js";
 
-import { SdkContext } from "../utils/interfaces.js";
-import { SourceFile } from "ts-morph";
-import {
-  getClassicalClientName,
-  getClientName
-} from "./helpers/namingHelpers.js";
-import { getDocsFromDescription } from "./helpers/docsHelpers.js";
-import { getTypeExpression } from "./type-expressions/get-type-expression.js";
-import { resolveReference } from "../framework/reference.js";
-import { useDependencies } from "../framework/hooks/useDependencies.js";
-import { buildEnumTypes, getApiVersionEnum } from "./emitModels.js";
 import {
   SdkClientType,
   SdkCredentialParameter,
   SdkEndpointParameter,
   SdkHttpParameter,
   SdkMethodParameter,
-  SdkServiceOperation
+  SdkServiceOperation,
 } from "@azure-tools/typespec-client-generator-core";
-import { getModularClientOptions } from "../utils/clientUtils.js";
+import { NoTarget } from "@typespec/compiler";
+import { SourceFile } from "ts-morph";
 import { useContext } from "../contextManager.js";
+import { useDependencies } from "../framework/hooks/useDependencies.js";
+import { resolveReference } from "../framework/reference.js";
 import { refkey } from "../framework/refkey.js";
 import { reportDiagnostic } from "../lib.js";
-import { NoTarget } from "@typespec/compiler";
+import { getModularClientOptions } from "../utils/clientUtils.js";
+import { SdkContext } from "../utils/interfaces.js";
+import { buildEnumTypes, getApiVersionEnum } from "./emitModels.js";
+import { getDocsFromDescription } from "./helpers/docsHelpers.js";
+import { getClassicalClientName, getClientName } from "./helpers/namingHelpers.js";
 import { CloudSettingHelpers } from "./static-helpers-metadata.js";
+import { getTypeExpression } from "./type-expressions/get-type-expression.js";
 
 /**
  * This function gets the path of the file containing the modular client context
  */
 export function getClientContextPath(
   clientMap: [string[], SdkClientType<SdkServiceOperation>],
-  emitterOptions: ModularEmitterOptions
+  emitterOptions: ModularEmitterOptions,
 ): string {
   const [_, client] = clientMap;
   const { subfolder } = getModularClientOptions(clientMap);
@@ -62,7 +55,7 @@ export function getClientContextPath(
 export function buildClientContext(
   dpgContext: SdkContext,
   clientMap: [string[], SdkClientType<SdkServiceOperation>],
-  emitterOptions: ModularEmitterOptions
+  emitterOptions: ModularEmitterOptions,
 ): SourceFile {
   const project = useContext("outputProject");
   const dependencies = useDependencies();
@@ -72,40 +65,36 @@ export function buildClientContext(
   const requiredParams = getClientParametersDeclaration(client, dpgContext, {
     onClientOnly: false,
     requiredOnly: true,
-    apiVersionAsRequired: true
+    apiVersionAsRequired: true,
   });
   const clientContextFile = project.createSourceFile(
-    getClientContextPath(clientMap, emitterOptions)
+    getClientContextPath(clientMap, emitterOptions),
   );
 
   // Get all client parameters (both required and optional) for the interface
   const requiredInterfaceProperties = getClientParameters(client, dpgContext, {
     onClientOnly: false,
-    requiredOnly: true
+    requiredOnly: true,
   })
     .filter((p) => {
       const clientParamName = getClientParameterName(p);
-      return (
-        clientParamName !== "endpointParam" && clientParamName !== "credential"
-      );
+      return clientParamName !== "endpointParam" && clientParamName !== "credential";
     })
     .map((p) => {
       return {
         name: getClientParameterName(p),
         type: getTypeExpression(dpgContext, p.type),
         hasQuestionToken: false,
-        docs: getDocsWithKnownVersion(dpgContext, p)
+        docs: getDocsWithKnownVersion(dpgContext, p),
       };
     });
 
   // Collect names of required properties to avoid duplicates
-  const requiredPropertyNames = new Set(
-    requiredInterfaceProperties.map((p) => p.name)
-  );
+  const requiredPropertyNames = new Set(requiredInterfaceProperties.map((p) => p.name));
 
   const optionalInterfaceProperties = getClientParameters(client, dpgContext, {
     onClientOnly: false,
-    optionalOnly: true
+    optionalOnly: true,
   })
     .filter((p) => {
       const clientParamName = getClientParameterName(p);
@@ -121,7 +110,7 @@ export function buildClientContext(
         name: getClientParameterName(p),
         type: getTypeExpression(dpgContext, p.type),
         hasQuestionToken: true,
-        docs: getDocsWithKnownVersion(dpgContext, p)
+        docs: getDocsWithKnownVersion(dpgContext, p),
       };
     });
 
@@ -130,22 +119,20 @@ export function buildClientContext(
     name: `${rlcClientName}`,
     extends: [resolveReference(dependencies.Client)],
     docs: getDocsFromDescription(client.doc),
-    properties: [...requiredInterfaceProperties, ...optionalInterfaceProperties]
+    properties: [...requiredInterfaceProperties, ...optionalInterfaceProperties],
   });
 
   const propertiesInOptions = getClientParameters(client, dpgContext, {
-    optionalOnly: true
+    optionalOnly: true,
   })
     .filter((p) => getClientParameterName(p) !== "endpoint")
     .map((p) => {
       return {
         name: getClientParameterName(p),
         type:
-          p.name.toLowerCase() === "apiversion"
-            ? "string"
-            : getTypeExpression(dpgContext, p.type),
+          p.name.toLowerCase() === "apiversion" ? "string" : getTypeExpression(dpgContext, p.type),
         hasQuestionToken: true,
-        docs: getDocsWithKnownVersion(dpgContext, p)
+        docs: getDocsWithKnownVersion(dpgContext, p),
       };
     });
   if (dpgContext.arm) {
@@ -153,7 +140,7 @@ export function buildClientContext(
       name: "cloudSetting",
       type: `${resolveReference(CloudSettingHelpers.AzureSupportedClouds)}`,
       hasQuestionToken: true,
-      docs: [`Specifies the Azure cloud environment for the client.`]
+      docs: [`Specifies the Azure cloud environment for the client.`],
     });
   }
   // check if we have duplication options
@@ -163,7 +150,7 @@ export function buildClientContext(
       reportDiagnostic(dpgContext.program, {
         code: "parameter-name-conflict",
         format: { parameterName: property.name },
-        target: NoTarget
+        target: NoTarget,
       });
     }
     existingOptionNames.add(property.name);
@@ -173,7 +160,7 @@ export function buildClientContext(
     isExported: true,
     extends: [resolveReference(dependencies.ClientOptions)],
     properties: propertiesInOptions,
-    docs: ["Optional parameters for the client."]
+    docs: ["Optional parameters for the client."],
   });
 
   // TODO use binder here
@@ -181,7 +168,7 @@ export function buildClientContext(
   if (isAzurePackage(emitterOptions)) {
     clientContextFile.addImportDeclaration({
       moduleSpecifier: "../".repeat(hierarchy.length + 1) + "logger.js",
-      namedImports: ["logger"]
+      namedImports: ["logger"],
     });
   }
 
@@ -191,38 +178,36 @@ export function buildClientContext(
     returnType: `${rlcClientName}`,
     parameters: getClientParametersDeclaration(client, dpgContext, {
       onClientOnly: false,
-      requiredOnly: true
+      requiredOnly: true,
     }),
-    isExported: true
+    isExported: true,
   });
 
-  const { endpointParamName: endpointParam, assignedOptionalParams } =
-    buildGetClientEndpointParam(factoryFunction, dpgContext, client);
+  const { endpointParamName: endpointParam, assignedOptionalParams } = buildGetClientEndpointParam(
+    factoryFunction,
+    dpgContext,
+    client,
+  );
   const credentialParam = buildGetClientCredentialParam(client, emitterOptions);
 
   // Get api version param early so we can use its name when building options
-  const apiVersionParam = getClientParameters(client, dpgContext).find(
-    (x) => x.isApiVersionParam
-  );
-  const apiVersionParamName = apiVersionParam
-    ? getClientParameterName(apiVersionParam)
-    : undefined;
+  const apiVersionParam = getClientParameters(client, dpgContext).find((x) => x.isApiVersionParam);
+  const apiVersionParamName = apiVersionParam ? getClientParameterName(apiVersionParam) : undefined;
 
   const optionsParam = buildGetClientOptionsParam(
     factoryFunction,
     emitterOptions,
     endpointParam,
-    apiVersionParamName
+    apiVersionParamName,
   );
 
   factoryFunction.addStatements(
     `const clientContext = ${resolveReference(
-      dependencies.getClient
-    )}(${endpointParam}, ${credentialParam}, ${optionsParam});`
+      dependencies.getClient,
+    )}(${endpointParam}, ${credentialParam}, ${optionsParam});`,
   );
 
-  const { customHttpAuthHeaderName, customHttpAuthSharedKeyPrefix } =
-    emitterOptions.options;
+  const { customHttpAuthHeaderName, customHttpAuthSharedKeyPrefix } = emitterOptions.options;
 
   if (customHttpAuthHeaderName && customHttpAuthSharedKeyPrefix) {
     factoryFunction.addStatements(`
@@ -242,7 +227,7 @@ export function buildClientContext(
   const endpointParameter = getClientParameters(client, dpgContext, {
     onClientOnly: false,
     requiredOnly: true,
-    skipEndpointTemplate: true
+    skipEndpointTemplate: true,
   }).find((x) => x.kind === "endpoint");
   if (apiVersionParam) {
     const templateArguments =
@@ -270,10 +255,7 @@ export function buildClientContext(
   factoryFunction.addStatements(apiVersionStatement);
 
   const contextRequiredParam = requiredParams.filter(
-    (p) =>
-      p.name !== "endpointParam" &&
-      p.name !== "credential" &&
-      p.name !== "options"
+    (p) => p.name !== "endpointParam" && p.name !== "credential" && p.name !== "options",
   );
 
   // Collect names of required parameters to avoid duplicates
@@ -282,7 +264,7 @@ export function buildClientContext(
   // Also include optional parameters from clientInitialization that should be passed through
   const contextOptionalParams = getClientParameters(client, dpgContext, {
     optionalOnly: true,
-    onClientOnly: false
+    onClientOnly: false,
   }).filter((p) => {
     const clientParamName = getClientParameterName(p);
     return (
@@ -307,21 +289,18 @@ export function buildClientContext(
         return clientParamName;
       }
       return `${clientParamName}: options.${clientParamName}`;
-    })
+    }),
   ];
 
   if (allContextParams.length) {
     factoryFunction.addStatements(
-      `return { ...clientContext, ${allContextParams.join(", ")}} as ${rlcClientName};`
+      `return { ...clientContext, ${allContextParams.join(", ")}} as ${rlcClientName};`,
     );
   } else {
     factoryFunction.addStatements(`return clientContext;`);
   }
 
-  clientContextFile.fixMissingImports(
-    {},
-    { importModuleSpecifierEnding: "js" }
-  );
+  clientContextFile.fixMissingImports({}, { importModuleSpecifierEnding: "js" });
 
   clientContextFile.fixUnusedIdentifiers();
   return clientContextFile;
@@ -329,11 +308,7 @@ export function buildClientContext(
 
 function getDocsWithKnownVersion(
   dpgContext: SdkContext,
-  param:
-    | SdkMethodParameter
-    | SdkEndpointParameter
-    | SdkCredentialParameter
-    | SdkHttpParameter
+  param: SdkMethodParameter | SdkEndpointParameter | SdkCredentialParameter | SdkHttpParameter,
 ) {
   const docs = getDocsFromDescription(param.doc);
   if (param.name.toLowerCase() !== "apiversion") {
@@ -341,13 +316,9 @@ function getDocsWithKnownVersion(
   }
   const apiVersionEnum = getApiVersionEnum(dpgContext);
   if (apiVersionEnum) {
-    const [_, knownValuesEnum] = buildEnumTypes(
-      dpgContext,
-      apiVersionEnum,
-      true
-    );
+    const [_, knownValuesEnum] = buildEnumTypes(dpgContext, apiVersionEnum, true);
     docs.push(
-      `Known values of {@link ${resolveReference(refkey(knownValuesEnum.name, "knownValues"))}} that the service accepts.`
+      `Known values of {@link ${resolveReference(refkey(knownValuesEnum.name, "knownValues"))}} that the service accepts.`,
     );
   }
   return docs;

package/src/modular/buildModularOptions.ts

@@ -1,12 +1,12 @@
-import { ModularEmitterOptions } from "./interfaces.js";
 import { SdkContext } from "../utils/interfaces.js";
+import { ModularEmitterOptions } from "./interfaces.js";
 
 let CASING: "camel" | "snake" = "snake";
 
 export function transformModularEmitterOptions(
   dpgContext: SdkContext,
   modularSourcesRoot: string,
-  options: { casing: "snake" | "camel" } = { casing: "snake" }
+  options: { casing: "snake" | "camel" } = { casing: "snake" },
 ): ModularEmitterOptions {
   CASING = options.casing ?? CASING;
   const emitterOptions: ModularEmitterOptions = {
@@ -14,9 +14,8 @@ export function transformModularEmitterOptions(
     modularOptions: {
       sourceRoot: modularSourcesRoot,
       compatibilityMode: !!dpgContext.rlcOptions?.compatibilityMode,
-      experimentalExtensibleEnums:
-        !!dpgContext.rlcOptions?.experimentalExtensibleEnums
-    }
+      experimentalExtensibleEnums: !!dpgContext.rlcOptions?.experimentalExtensibleEnums,
+    },
   };
 
   return emitterOptions;

package/src/modular/buildOperations.ts

@@ -1,46 +1,39 @@
-import { ModularEmitterOptions } from "./interfaces.js";
+import { InterfaceDeclarationStructure, SourceFile, StructureKind } from "ts-morph";
 import { NameType, normalizeName } from "../rlc-common/index.js";
 import {
-  SourceFile,
-  InterfaceDeclarationStructure,
-  StructureKind
-} from "ts-morph";
-import {
-  getDeserializePrivateFunction,
-  getDeserializeHeadersPrivateFunction,
   getDeserializeExceptionHeadersPrivateFunction,
+  getDeserializeHeadersPrivateFunction,
+  getDeserializePrivateFunction,
   getExpectedStatuses,
   getOperationFunction,
   getOperationOptionsName,
   getSendPrivateFunction,
+  isLroAndPagingOperation,
   isLroOnlyOperation,
-  isLroAndPagingOperation
 } from "./helpers/operationHelpers.js";
+import { ModularEmitterOptions } from "./interfaces.js";
 
-import { OperationPathAndDeserDetails } from "./interfaces.js";
-import { SdkContext } from "../utils/interfaces.js";
-import { getDocsFromDescription } from "./helpers/docsHelpers.js";
-import { getOperationName } from "./helpers/namingHelpers.js";
-import {
-  getModularClientOptions,
-  isRLCMultiEndpoint
-} from "../utils/clientUtils.js";
-import { getTypeExpression } from "./type-expressions/get-type-expression.js";
 import {
   SdkClientType,
   SdkMethodParameter,
-  SdkServiceOperation
+  SdkServiceOperation,
 } from "@azure-tools/typespec-client-generator-core";
+import { useContext } from "../contextManager.js";
+import { addDeclaration } from "../framework/declaration.js";
+import { useDependencies } from "../framework/hooks/useDependencies.js";
+import { resolveReference } from "../framework/reference.js";
+import { refkey } from "../framework/refkey.js";
+import { getModularClientOptions, isRLCMultiEndpoint } from "../utils/clientUtils.js";
+import { SdkContext } from "../utils/interfaces.js";
 import {
   getMethodHierarchiesMap,
+  hasDualFormatSupport,
   ServiceOperation,
-  hasDualFormatSupport
 } from "../utils/operationUtil.js";
-import { resolveReference } from "../framework/reference.js";
-import { useDependencies } from "../framework/hooks/useDependencies.js";
-import { addDeclaration } from "../framework/declaration.js";
-import { refkey } from "../framework/refkey.js";
-import { useContext } from "../contextManager.js";
+import { getDocsFromDescription } from "./helpers/docsHelpers.js";
+import { getOperationName } from "./helpers/namingHelpers.js";
+import { OperationPathAndDeserDetails } from "./interfaces.js";
+import { getTypeExpression } from "./type-expressions/get-type-expression.js";
 
 /**
  * This function creates a file under /api for each operation group.
@@ -50,7 +43,7 @@ import { useContext } from "../contextManager.js";
 export function buildOperationFiles(
   dpgContext: SdkContext,
   clientMap: [string[], SdkClientType<SdkServiceOperation>],
-  emitterOptions: ModularEmitterOptions
+  emitterOptions: ModularEmitterOptions,
 ) {
   const project = useContext("outputProject");
   const [_, client] = clientMap;
@@ -79,29 +72,23 @@ export function buildOperationFiles(
 
     const operationGroupFile = project.createSourceFile(filepath);
     operations.forEach((op) => {
-      const operationDeclaration = getOperationFunction(
-        dpgContext,
-        [prefixes, op],
-        clientType
-      );
+      const operationDeclaration = getOperationFunction(dpgContext, [prefixes, op], clientType);
       const sendOperationDeclaration = getSendPrivateFunction(
         dpgContext,
         [prefixes, op],
         clientType,
-        client
+        client,
       );
-      const deserializeOperationDeclaration = getDeserializePrivateFunction(
+      const deserializeOperationDeclaration = getDeserializePrivateFunction(dpgContext, [
+        prefixes,
+        op,
+      ]);
+      const deserializeHeadersDeclaration = getDeserializeHeadersPrivateFunction(dpgContext, op);
+      const deserializeExceptionHeadersDeclaration = getDeserializeExceptionHeadersPrivateFunction(
         dpgContext,
-        [prefixes, op]
+        op,
       );
-      const deserializeHeadersDeclaration =
-        getDeserializeHeadersPrivateFunction(dpgContext, op);
-      const deserializeExceptionHeadersDeclaration =
-        getDeserializeExceptionHeadersPrivateFunction(dpgContext, op);
-      const functionsToAdd = [
-        sendOperationDeclaration,
-        deserializeOperationDeclaration
-      ];
+      const functionsToAdd = [sendOperationDeclaration, deserializeOperationDeclaration];
       if (deserializeHeadersDeclaration) {
         functionsToAdd.push(deserializeHeadersDeclaration);
       }
@@ -110,18 +97,13 @@ export function buildOperationFiles(
       }
 
       operationGroupFile.addFunctions(functionsToAdd);
-      addDeclaration(
-        operationGroupFile,
-        operationDeclaration,
-        refkey(op, "api")
-      );
+      addDeclaration(operationGroupFile, operationDeclaration, refkey(op, "api"));
     });
 
-    const indexPathPrefix =
-      "../".repeat(prefixKey === "" ? 0 : prefixes.length) || "./";
+    const indexPathPrefix = "../".repeat(prefixKey === "" ? 0 : prefixes.length) || "./";
     operationGroupFile.addImportDeclaration({
       namedImports: [`${rlcClientName} as Client`],
-      moduleSpecifier: `${indexPathPrefix}index.js`
+      moduleSpecifier: `${indexPathPrefix}index.js`,
     });
     operationGroupFile.fixUnusedIdentifiers();
 
@@ -136,7 +118,7 @@ export function buildOperationFiles(
 export function buildOperationOptions(
   context: SdkContext,
   method: [string[], ServiceOperation],
-  sourceFile: SourceFile
+  sourceFile: SourceFile,
 ) {
   const dependencies = useDependencies();
   const operation = method[1];
@@ -144,10 +126,7 @@ export function buildOperationOptions(
     .filter(
       (p) =>
         p.onClient === false &&
-        !(
-          p.isGeneratedName &&
-          (p.name === "contentType" || p.name !== "accept")
-        )
+        !(p.isGeneratedName && (p.name === "contentType" || p.name !== "accept")),
     )
     .filter((p) => p.optional || p.clientDefaultValue);
   const options: SdkMethodParameter[] = [...optionalParameters];
@@ -157,7 +136,7 @@ export function buildOperationOptions(
     name: "updateIntervalInMs",
     type: "number",
     hasQuestionToken: true,
-    docs: ["Delay to wait until next poll, in milliseconds."]
+    docs: ["Delay to wait until next poll, in milliseconds."],
   };
 
   // Check if this operation supports both JSON and XML content types
@@ -170,17 +149,15 @@ export function buildOperationOptions(
     type: "string",
     hasQuestionToken: true,
     docs: [
-      'The content type for the request body. Defaults to "application/json". Use "application/xml" for XML serialization.'
-    ]
+      'The content type for the request body. Defaults to "application/json". Use "application/xml" for XML serialization.',
+    ],
   };
 
   // handle optional body parameter
   // if (operation.operation.bodyParam?.optional === true) {
   //   options.push(operation.operation.bodyParam);
   // }
-  const operationOptionsReference = resolveReference(
-    dependencies.OperationOptions
-  );
+  const operationOptionsReference = resolveReference(dependencies.OperationOptions);
 
   // Build the additional options array
   const additionalOptions: {
@@ -207,17 +184,13 @@ export function buildOperationOptions(
           docs: getDocsFromDescription(p.doc),
           hasQuestionToken: true,
           type: getTypeExpression(context, p.type, { isOptional: true }),
-          name: normalizeName(p.name, NameType.Parameter)
+          name: normalizeName(p.name, NameType.Parameter),
         };
-      })
+      }),
     ),
-    docs: [`Optional parameters.`]
+    docs: [`Optional parameters.`],
   };
-  addDeclaration(
-    sourceFile,
-    operationOptionsInterface,
-    refkey(method[1], "operationOptions")
-  );
+  addDeclaration(sourceFile, operationOptionsInterface, refkey(method[1], "operationOptions"));
 }
 
 /**
@@ -225,7 +198,7 @@ export function buildOperationOptions(
  */
 export function buildLroDeserDetailMap(
   context: SdkContext,
-  client: SdkClientType<SdkServiceOperation>
+  client: SdkClientType<SdkServiceOperation>,
 ) {
   const map = new Map<string, OperationPathAndDeserDetails[]>();
   const existingNames = new Set<string>();
@@ -257,7 +230,7 @@ export function buildLroDeserDetailMap(
         if (existingNames.has(deserName)) {
           const newName = `${name}Deserialize${normalizeName(
             operationFileName.split("/").slice(0, -1).join("_"),
-            NameType.Interface
+            NameType.Interface,
           )}`;
           renamedDeserName = `_${newName}`;
         }
@@ -266,9 +239,9 @@ export function buildLroDeserDetailMap(
           path: `${o.operation.verb.toUpperCase()} ${o.operation.path}`,
           expectedStatusesExpression: getExpectedStatuses(o),
           deserName,
-          renamedDeserName
+          renamedDeserName,
         };
-      })
+      }),
     );
   }
   return map;