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

package/src/modular/type-expressions/get-type-expression.ts

@@ -2,15 +2,15 @@ import {
   SdkHttpParameter,
   SdkModelPropertyType,
   SdkServiceResponseHeader,
-  SdkType
+  SdkType,
 } from "@azure-tools/typespec-client-generator-core";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
+import { SdkContext } from "../../utils/interfaces.js";
 import { getCredentialExpression } from "./get-credential-expression.js";
 import { getEnumExpression } from "./get-enum-expression.js";
 import { getModelExpression } from "./get-model-expression.js";
-import { getUnionExpression } from "./get-union-expression.js";
-import { NameType, normalizeName } from "../../rlc-common/index.js";
-import { SdkContext } from "../../utils/interfaces.js";
 import { getNullableExpression } from "./get-nullable-expression.js";
+import { getUnionExpression } from "./get-union-expression.js";
 
 export interface EmitTypeOptions {
   emitInline?: boolean;
@@ -19,7 +19,7 @@ export interface EmitTypeOptions {
 
 export function normalizeModelPropertyName(
   context: SdkContext,
-  property: SdkModelPropertyType | SdkHttpParameter | SdkServiceResponseHeader
+  property: SdkModelPropertyType | SdkHttpParameter | SdkServiceResponseHeader,
 ): string {
   const normalizedPropName = normalizeName(property.name, NameType.Property);
   return context.rlcOptions?.ignorePropertyNameNormalize
@@ -30,7 +30,7 @@ export function normalizeModelPropertyName(
 export function getTypeExpression(
   context: SdkContext,
   type: SdkType,
-  options?: EmitTypeOptions
+  options?: EmitTypeOptions,
 ): string {
   switch (type.kind) {
     case "array": {
@@ -40,9 +40,7 @@ export function getTypeExpression(
     case "enum":
       return getEnumExpression(context, type);
     case "unknown":
-      return context.rlcOptions?.treatUnknownAsRecord
-        ? "Record<string, unknown>"
-        : "any";
+      return context.rlcOptions?.treatUnknownAsRecord ? "Record<string, unknown>" : "any";
     case "boolean":
       return "boolean";
     case "decimal":
@@ -98,9 +96,7 @@ export function getTypeExpression(
     case "offsetDateTime":
       return "string";
     case "tuple": {
-      const types = type.valueTypes
-        .map((v) => getTypeExpression(context, v, options))
-        .join(", ");
+      const types = type.valueTypes.map((v) => getTypeExpression(context, v, options)).join(", ");
       return `[${types}]`;
     }
     case "union":

package/src/modular/type-expressions/get-union-expression.ts

@@ -1,17 +1,17 @@
 import { SdkUnionType } from "@azure-tools/typespec-client-generator-core";
 import { resolveReference } from "../../framework/reference.js";
-import { getTypeExpression, EmitTypeOptions } from "./get-type-expression.js";
-import { shouldEmitInline } from "./utils.js";
 import { SdkContext } from "../../utils/interfaces.js";
+import { EmitTypeOptions, getTypeExpression } from "./get-type-expression.js";
+import { shouldEmitInline } from "./utils.js";
 
 export function getUnionExpression(
   context: SdkContext,
   type: SdkUnionType,
-  options: EmitTypeOptions = {}
+  options: EmitTypeOptions = {},
 ): string {
   if (shouldEmitInline(type, options)) {
     const variantTypes = new Set(
-      type.variantTypes.map((v) => `${getTypeExpression(context, v, options)}`)
+      type.variantTypes.map((v) => `${getTypeExpression(context, v, options)}`),
     );
     return `(${[...variantTypes].join(" | ")})`;
   } else {

package/src/modular/type-expressions/utils.ts

@@ -2,7 +2,7 @@ import { EmitTypeOptions } from "./get-type-expression.js";
 
 export function shouldEmitInline(
   type: { isGeneratedName?: boolean },
-  options: EmitTypeOptions = {}
+  options: EmitTypeOptions = {},
 ): boolean {
   const emitInline = options.emitInline;
 

package/src/rlc-common/buildClient.ts

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import * as path from "path";
 import {
   InterfaceDeclarationStructure,
   OptionalKind,
@@ -9,28 +10,21 @@ import {
   StructureKind,
   VariableDeclarationKind,
   VariableStatementStructure,
-  WriterFunction
+  WriterFunction,
 } from "ts-morph";
-import * as path from "path";
-import { NameType, normalizeName } from "./helpers/nameUtils.js";
 import { buildMethodShortcutImplementation } from "./buildMethodShortcuts.js";
-import { RLCModel, File, PathParameter } from "./interfaces.js";
-import {
-  getClientName,
-  getImportModuleName
-} from "./helpers/nameConstructors.js";
 import { getImportSpecifier } from "./helpers/importsUtil.js";
+import { getClientName, getImportModuleName } from "./helpers/nameConstructors.js";
+import { NameType, normalizeName } from "./helpers/nameUtils.js";
 import { isAzurePackage } from "./helpers/packageUtil.js";
+import { File, PathParameter, RLCModel } from "./interfaces.js";
 
 function getClientOptionsInterface(
   model: RLCModel,
   clientName: string,
-  optionalUrlParameters?: PathParameter[]
+  optionalUrlParameters?: PathParameter[],
 ): OptionalKind<InterfaceDeclarationStructure> | undefined {
-  if (
-    (!optionalUrlParameters || optionalUrlParameters.length === 0) &&
-    !model.apiVersionInfo
-  ) {
+  if ((!optionalUrlParameters || optionalUrlParameters.length === 0) && !model.apiVersionInfo) {
     return undefined;
   }
 
@@ -40,9 +34,7 @@ function getClientOptionsInterface(
         name: param.name,
         type: param.type,
         hasQuestionToken: true,
-        docs: [
-          param.description ?? "client level optional parameter " + param.name
-        ]
+        docs: [param.description ?? "client level optional parameter " + param.name],
       };
     }) ?? [];
 
@@ -55,7 +47,7 @@ function getClientOptionsInterface(
       name: "apiVersion",
       type: "string",
       hasQuestionToken: true,
-      docs: ["The api version option of the client"]
+      docs: ["The api version option of the client"],
     });
   }
   return {
@@ -63,7 +55,7 @@ function getClientOptionsInterface(
     extends: ["ClientOptions"],
     isExported: true,
     properties,
-    docs: ["The optional parameters for the client"]
+    docs: ["The optional parameters for the client"],
   };
 }
 
@@ -73,7 +65,7 @@ export function buildClient(model: RLCModel): File | undefined {
   const project = new Project();
   const filePath = path.join(srcPath, `${name}.ts`);
   const clientFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true
+    overwrite: true,
   });
 
   // Get all paths
@@ -82,18 +74,18 @@ export function buildClient(model: RLCModel): File | undefined {
   normalizeUrlInfo(model);
   const urlParameters = model?.urlInfo?.urlParameters?.filter(
     // Do not include parameters with constant values in the signature, these should go in the options bag
-    (p) => p.value === undefined
+    (p) => p.value === undefined,
   );
 
   const optionalUrlParameters = model?.urlInfo?.urlParameters?.filter(
     // Do not include parameters with constant values in the signature, these should go in the options bag
-    (p) => Boolean(p.value)
+    (p) => Boolean(p.value),
   );
 
   const clientOptionsInterface = getClientOptionsInterface(
     model,
     clientInterfaceName,
-    optionalUrlParameters
+    optionalUrlParameters,
   );
 
   if (clientOptionsInterface) {
@@ -109,7 +101,7 @@ export function buildClient(model: RLCModel): File | undefined {
     credentialScopes,
     credentialKeyHeaderName,
     customHttpAuthHeaderName,
-    customHttpAuthSharedKeyPrefix
+    customHttpAuthSharedKeyPrefix,
   } = model.options;
   const credentialTypes = credentialScopes ? ["TokenCredential"] : [];
 
@@ -120,33 +112,23 @@ export function buildClient(model: RLCModel): File | undefined {
   const commonClientParams = [
     ...(urlParameters ?? []),
     ...(addCredentials === false ||
-    !isSecurityInfoDefined(
-      credentialScopes,
-      credentialKeyHeaderName,
-      customHttpAuthHeaderName
-    )
+    !isSecurityInfoDefined(credentialScopes, credentialKeyHeaderName, customHttpAuthHeaderName)
       ? []
       : [
           {
             name: "credentials",
             type: credentialTypes.join(" | "),
-            description: `uniquely identify client credential`
-          }
-        ])
+            description: `uniquely identify client credential`,
+          },
+        ]),
   ];
 
   let apiVersionStatement: string = "";
   // Set the default api-version when we have a default AND its position is query
-  if (
-    model.apiVersionInfo?.isCrossedVersion === false &&
-    !!model.apiVersionInfo?.defaultValue
-  ) {
+  if (model.apiVersionInfo?.isCrossedVersion === false && !!model.apiVersionInfo?.defaultValue) {
     apiVersionStatement = `
     apiVersion = "${model.apiVersionInfo?.defaultValue}"`;
-  } else if (
-    model.apiVersionInfo?.isCrossedVersion === false &&
-    !model.apiVersionInfo.required
-  ) {
+  } else if (model.apiVersionInfo?.isCrossedVersion === false && !model.apiVersionInfo.required) {
     apiVersionStatement = `
     apiVersion`;
   }
@@ -154,14 +136,11 @@ export function buildClient(model: RLCModel): File | undefined {
   const allClientParams = [
     ...commonClientParams,
     {
-      name:
-        apiVersionStatement === ""
-          ? "options"
-          : `{${apiVersionStatement}, ...options}`,
+      name: apiVersionStatement === "" ? "options" : `{${apiVersionStatement}, ...options}`,
       documentName: "options",
       type: `${clientOptionsInterface?.name ?? "ClientOptions"} = {}`,
-      description: "the parameter for all optional parameters"
-    }
+      description: "the parameter for all optional parameters",
+    },
   ];
   const functionStatement = {
     isExported: true,
@@ -177,14 +156,14 @@ export function buildClient(model: RLCModel): File | undefined {
                 param.description ?? "The parameter " + param.name
               }`;
             })
-            .join("\n")
-      }
+            .join("\n"),
+      },
     ],
     returnType: clientInterfaceName,
     isDefaultExport: false,
     statements: getClientFactoryBody(model, clientInterfaceName, {
-      isMultipleCredential: credentialTypes.length > 1
-    })
+      isMultipleCredential: credentialTypes.length > 1,
+    }),
   };
 
   if (!multiClient || !batch || batch.length === 1) {
@@ -197,31 +176,21 @@ export function buildClient(model: RLCModel): File | undefined {
     paths.pop();
   }
   const parentPath =
-    paths.lastIndexOf("src") > -1
-      ? paths.length - 1 - paths.lastIndexOf("src")
-      : 0;
+    paths.lastIndexOf("src") > -1 ? paths.length - 1 - paths.lastIndexOf("src") : 0;
 
-  const loggerPath = `${
-    parentPath > 0 ? "../".repeat(parentPath) : "./"
-  }logger`;
+  const loggerPath = `${parentPath > 0 ? "../".repeat(parentPath) : "./"}logger`;
   clientFile.addImportDeclarations([
     {
       isTypeOnly: true,
       namedImports: ["ClientOptions"],
-      moduleSpecifier: getImportSpecifier(
-        "restClient",
-        model.importInfo.runtimeImports
-      )
-    }
+      moduleSpecifier: getImportSpecifier("restClient", model.importInfo.runtimeImports),
+    },
   ]);
   clientFile.addImportDeclarations([
     {
       namedImports: ["getClient"],
-      moduleSpecifier: getImportSpecifier(
-        "restClient",
-        model.importInfo.runtimeImports
-      )
-    }
+      moduleSpecifier: getImportSpecifier("restClient", model.importInfo.runtimeImports),
+    },
   ]);
   if (isAzurePackage(model)) {
     clientFile.addImportDeclarations([
@@ -230,11 +199,11 @@ export function buildClient(model: RLCModel): File | undefined {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: loggerPath,
-            esModulesName: `${loggerPath}.js`
+            esModulesName: `${loggerPath}.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -245,31 +214,21 @@ export function buildClient(model: RLCModel): File | undefined {
     credentialTypes.includes("KeyCredential");
   if (
     addCredentials &&
-    isSecurityInfoDefined(
-      credentialScopes,
-      credentialKeyHeaderName,
-      customHttpAuthHeaderName
-    )
+    isSecurityInfoDefined(credentialScopes, credentialKeyHeaderName, customHttpAuthHeaderName)
   ) {
     clientFile.addImportDeclarations([
       {
         isTypeOnly: true,
         namedImports: credentialTypes,
-        moduleSpecifier: getImportSpecifier(
-          "coreAuth",
-          model.importInfo.runtimeImports
-        )
-      }
+        moduleSpecifier: getImportSpecifier("coreAuth", model.importInfo.runtimeImports),
+      },
     ]);
     if (includeKeyCredentialHelper) {
       clientFile.addImportDeclarations([
         {
           namedImports: ["isKeyCredential"],
-          moduleSpecifier: getImportSpecifier(
-            "coreAuth",
-            model.importInfo.runtimeImports
-          )
-        }
+          moduleSpecifier: getImportSpecifier("coreAuth", model.importInfo.runtimeImports),
+        },
       ]);
     }
   }
@@ -280,30 +239,25 @@ export function buildClient(model: RLCModel): File | undefined {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./clientDefinitions",
-          esModulesName: "./clientDefinitions.js"
+          esModulesName: "./clientDefinitions.js",
         },
-        model
-      )
-    }
+        model,
+      ),
+    },
   ]);
-  if (
-    (model.importInfo.internalImports?.rlcClientFactory?.importsSet?.size ??
-      0) > 0
-  ) {
+  if ((model.importInfo.internalImports?.rlcClientFactory?.importsSet?.size ?? 0) > 0) {
     clientFile.addImportDeclarations([
       {
         isTypeOnly: true,
-        namedImports: Array.from(
-          model.importInfo.internalImports.rlcClientFactory.importsSet!
-        ),
+        namedImports: Array.from(model.importInfo.internalImports.rlcClientFactory.importsSet!),
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./models`,
-            esModulesName: `./models.js`
+            esModulesName: `./models.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
   return { path: filePath, content: clientFile.getFullText() };
@@ -312,11 +266,9 @@ export function buildClient(model: RLCModel): File | undefined {
 function isSecurityInfoDefined(
   credentialScopes?: string[],
   credentialKeyHeaderName?: string,
-  customHttpAuthHeaderName?: string
+  customHttpAuthHeaderName?: string,
 ) {
-  return (
-    credentialScopes || credentialKeyHeaderName || customHttpAuthHeaderName
-  );
+  return credentialScopes || credentialKeyHeaderName || customHttpAuthHeaderName;
 }
 
 interface GetClientFactoryOptions {
@@ -326,14 +278,13 @@ interface GetClientFactoryOptions {
 export function getClientFactoryBody(
   model: RLCModel,
   clientTypeName: string,
-  options: GetClientFactoryOptions = { isMultipleCredential: false }
+  options: GetClientFactoryOptions = { isMultipleCredential: false },
 ): string | WriterFunction | (string | WriterFunction | StatementStructures)[] {
   if (!model.options || !model.options.packageDetails || !model.urlInfo) {
     return "";
   }
   const { includeShortcuts, packageDetails, addCredentials } = model.options;
-  let clientPackageName =
-    packageDetails!.nameWithoutScope ?? packageDetails?.name ?? "";
+  let clientPackageName = packageDetails!.nameWithoutScope ?? packageDetails?.name ?? "";
   const packageVersion = packageDetails.version;
   const { endpoint, urlParameters } = model.urlInfo;
 
@@ -344,11 +295,8 @@ export function getClientFactoryBody(
       continue;
     }
     if (param.value) {
-      const value =
-        typeof param.value === "string" ? `"${param.value}"` : param.value;
-      optionalUrlParameters.push(
-        `const ${param.name} = options.${param.name} ?? ${value};`
-      );
+      const value = typeof param.value === "string" ? `"${param.value}"` : param.value;
+      optionalUrlParameters.push(`const ${param.name} = options.${param.name} ?? ${value};`);
     }
   }
 
@@ -356,10 +304,7 @@ export function getClientFactoryBody(
   if (urlParameters && endpoint) {
     let parsedEndpoint = endpoint;
     urlParameters.forEach((urlParameter) => {
-      parsedEndpoint = parsedEndpoint.replace(
-        `{${urlParameter.name}}`,
-        `\${${urlParameter.name}}`
-      );
+      parsedEndpoint = parsedEndpoint.replace(`{${urlParameter.name}}`, `\${${urlParameter.name}}`);
     });
     endpointUrl = `options.endpoint ?? \`${parsedEndpoint}\``;
   } else {
@@ -371,17 +316,13 @@ export function getClientFactoryBody(
   }
 
   const userAgentInfoStatement =
-    "const userAgentInfo = `azsdk-js-" +
-    clientPackageName +
-    "/" +
-    packageVersion +
-    "`;";
+    "const userAgentInfo = `azsdk-js-" + clientPackageName + "/" + packageVersion + "`;";
   const userAgentPrefix =
     "options.userAgentOptions && options.userAgentOptions.userAgentPrefix ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`: `${userAgentInfo}`;";
   const userAgentStatement: VariableStatementStructure = {
     kind: StructureKind.VariableStatement,
     declarationKind: VariableDeclarationKind.Const,
-    declarations: [{ name: "userAgentPrefix", initializer: userAgentPrefix }]
+    declarations: [{ name: "userAgentPrefix", initializer: userAgentPrefix }],
   };
 
   const customHeaderOptions = model.telemetryOptions?.customRequestIdHeaderName
@@ -396,17 +337,14 @@ export function getClientFactoryBody(
   const endpointUrlStatement: VariableStatementStructure = {
     kind: StructureKind.VariableStatement,
     declarationKind: VariableDeclarationKind.Const,
-    declarations: [{ name: "endpointUrl", initializer: endpointUrl }]
+    declarations: [{ name: "endpointUrl", initializer: endpointUrl }],
   };
 
   const { credentialScopes, credentialKeyHeaderName } = model.options;
   const scopesString = credentialScopes
-    ? credentialScopes.map((cs) => `"${cs}"`).join(", ") ||
-      "`${endpointUrl}/.default`"
-    : "";
-  const scopes = scopesString
-    ? `scopes: options.credentials?.scopes ?? [${scopesString}],`
+    ? credentialScopes.map((cs) => `"${cs}"`).join(", ") || "`${endpointUrl}/.default`"
     : "";
+  const scopes = scopesString ? `scopes: options.credentials?.scopes ?? [${scopesString}],` : "";
 
   const apiKeyHeaderName = credentialKeyHeaderName
     ? `apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? "${credentialKeyHeaderName}",`
@@ -436,8 +374,7 @@ export function getClientFactoryBody(
         endpointUrl, ${credentialsOptions ? "credentials," : ""} options
       ) as ${clientTypeName};
       `;
-  const { customHttpAuthHeaderName, customHttpAuthSharedKeyPrefix } =
-    model.options;
+  const { customHttpAuthHeaderName, customHttpAuthSharedKeyPrefix } = model.options;
   let customHttpAuthStatement = "";
   if (customHttpAuthHeaderName && customHttpAuthSharedKeyPrefix) {
     if (options.isMultipleCredential) {
@@ -463,10 +400,7 @@ export function getClientFactoryBody(
   }
 
   let apiVersionPolicyStatement = `client.pipeline.removePolicy({ name: "ApiVersionPolicy" });`;
-  if (
-    isAzurePackage(model) &&
-    model.apiVersionInfo?.isCrossedVersion !== false
-  ) {
+  if (isAzurePackage(model) && model.apiVersionInfo?.isCrossedVersion !== false) {
     apiVersionPolicyStatement += `
       if (options.apiVersion) {
         logger.warning("This client does not support client api-version, please change it at the operation level");
@@ -505,9 +439,7 @@ export function getClientFactoryBody(
   let returnStatement = `return client;`;
 
   if (includeShortcuts) {
-    const shortcutImplementations = buildMethodShortcutImplementation(
-      model.paths
-    );
+    const shortcutImplementations = buildMethodShortcutImplementation(model.paths);
     const shortcutBody = Object.keys(shortcutImplementations).map((key) => {
       // If the operation group has an empty name, it means its operations are client
       // level operations so we need to spread the definitions. Otherwise they are
@@ -529,7 +461,7 @@ export function getClientFactoryBody(
     getClient,
     apiVersionPolicyStatement,
     customHttpAuthStatement,
-    returnStatement
+    returnStatement,
   ];
 }
 
@@ -551,10 +483,7 @@ function normalizeUrlInfo(model: RLCModel) {
     const normalizedName = normalizeName(name, NameType.Parameter);
     if (name !== normalizedName) {
       urlParameter.name = normalizedName;
-      parsedEndpoint = parsedEndpoint.replace(
-        `{${name}}`,
-        `{${normalizedName}}`
-      );
+      parsedEndpoint = parsedEndpoint.replace(`{${name}}`, `{${normalizedName}}`);
     }
   });
   model.urlInfo.endpoint = parsedEndpoint;