@azure-tools/typespec-ts 0.43.0 → 0.44.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.43.0",
+  "version": "0.44.0",
   "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
@@ -18,15 +18,15 @@
   "license": "MIT",
   "devDependencies": {
     "@azure-rest/core-client": "^2.3.1",
-    "@typespec/http-specs": "0.1.0-alpha.26-dev.0",
-    "@typespec/spector": "0.1.0-alpha.18-dev.0",
-    "@typespec/spec-api": "0.1.0-alpha.9-dev.0",
+    "@typespec/http-specs": "0.1.0-alpha.27-dev.0",
+    "@typespec/spector": "0.1.0-alpha.19-dev.0",
+    "@typespec/spec-api": "0.1.0-alpha.10-dev.0",
     "@typespec/tspd": "0.72.1",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.26-dev.1",
-    "@azure-tools/typespec-autorest": "^0.59.0",
-    "@azure-tools/typespec-azure-core": "^0.59.0",
-    "@azure-tools/typespec-azure-resource-manager": "^0.59.0",
-    "@azure-tools/typespec-client-generator-core": "^0.59.0",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.29-dev.0",
+    "@azure-tools/typespec-autorest": "^0.60.0",
+    "@azure-tools/typespec-azure-core": "^0.60.0",
+    "@azure-tools/typespec-azure-resource-manager": "^0.60.0",
+    "@azure-tools/typespec-client-generator-core": "^0.60.0",
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.6.0",
     "@azure/core-lro": "^3.1.0",
@@ -41,12 +41,12 @@
     "@types/node": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^8.28.0",
     "@typescript-eslint/parser": "^8.28.0",
-    "@typespec/compiler": "^1.3.0",
-    "@typespec/http": "^1.3.0",
-    "@typespec/openapi": "^1.3.0",
-    "@typespec/rest": "^0.73.0",
+    "@typespec/compiler": "^1.4.0",
+    "@typespec/http": "^1.4.0",
+    "@typespec/openapi": "^1.4.0",
+    "@typespec/rest": "^0.74.0",
     "@typespec/ts-http-runtime": "^0.1.0",
-    "@typespec/versioning": "^0.73.0",
+    "@typespec/versioning": "^0.74.0",
     "chai": "^4.3.6",
     "chalk": "^4.0.0",
     "cross-env": "^7.0.3",
@@ -68,16 +68,16 @@
     "js-yaml": "^4.1.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.59.0",
-    "@azure-tools/typespec-client-generator-core": "^0.59.0",
-    "@typespec/compiler": "^1.3.0",
-    "@typespec/http": "^1.3.0",
-    "@typespec/rest": "^0.73.0",
-    "@typespec/versioning": "^0.73.0",
-    "@typespec/xml": "^0.73.0"
+    "@azure-tools/typespec-azure-core": "^0.60.0",
+    "@azure-tools/typespec-client-generator-core": "^0.60.0",
+    "@typespec/compiler": "^1.4.0",
+    "@typespec/http": "^1.4.0",
+    "@typespec/rest": "^0.74.0",
+    "@typespec/versioning": "^0.74.0",
+    "@typespec/xml": "^0.74.0"
   },
   "dependencies": {
-    "@azure-tools/rlc-common": "^0.43.0",
+    "@azure-tools/rlc-common": "^0.44.0",
     "fs-extra": "^11.1.0",
     "lodash": "^4.17.21",
     "prettier": "^3.3.3",

package/src/index.ts

@@ -210,9 +210,15 @@ export async function $onEmit(context: EmitContext) {
   async function calculateGenerationDir(): Promise<GenerationDirDetail> {
     const projectRoot = context.emitterOutputDir ?? "";
     const customizationFolder = join(projectRoot, "generated");
+    const srcGeneratedFolder = join(projectRoot, "src", "generated");
     // if customization folder exists, use it as sources root
-    const sourcesRoot = (await fsextra.pathExists(customizationFolder))
-      ? customizationFolder
+    const finalCustomizationFolder = (await fsextra.pathExists(
+      srcGeneratedFolder
+    ))
+      ? srcGeneratedFolder
+      : customizationFolder;
+    const sourcesRoot = (await fsextra.pathExists(finalCustomizationFolder))
+      ? finalCustomizationFolder
       : join(projectRoot, "src");
     return {
       rootDir: projectRoot,

package/src/modular/buildClientContext.ts

@@ -108,7 +108,7 @@ export function buildClientContext(
   const propertiesInOptions = getClientParameters(client, dpgContext, {
     optionalOnly: true
   })
-    .filter((p) => p.name !== "endpoint")
+    .filter((p) => getClientParameterName(p) !== "endpoint")
     .map((p) => {
       return {
         name: getClientParameterName(p),

package/src/modular/buildRestorePoller.ts

@@ -126,6 +126,7 @@ export function buildRestorePoller(
     }
     
     interface DeserializationHelper {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
       deserializer: Function;
       expectedStatuses: string[];
     }

package/src/modular/buildRootIndex.ts

@@ -294,7 +294,7 @@ function exportModules(
     }
 
     const exported = [...indexFile.getExportedDeclarations().keys()];
-
+    const serializerOrDeserializerRegex = /.*(Serializer|Deserializer)(_\d+)?$/;
     const namedExports = [...modelsFile.getExportedDeclarations().entries()]
       .filter((exDeclaration) => {
         if (exDeclaration[0].startsWith("_")) {
@@ -310,8 +310,7 @@ function exportModules(
           if (
             moduleName === "models" &&
             ex.getKindName() === "FunctionDeclaration" &&
-            (exDeclaration[0].endsWith("Serializer") ||
-              exDeclaration[0].endsWith("Deserializer"))
+            serializerOrDeserializerRegex.test(exDeclaration[0])
           ) {
             return false;
           }

package/src/modular/buildSubpathIndex.ts

@@ -72,6 +72,8 @@ export function buildSubpathIndexFile(
     const indexFile = project.createSourceFile(`${folder}/index.ts`);
     for (const file of apiFiles) {
       const filePath = file.getFilePath();
+      const serializerOrDeserializerRegex =
+        /.*(Serializer|Deserializer)(_\d+)?$/;
       if (!options.exportIndex && filePath.endsWith("index.ts")) {
         continue;
       }
@@ -100,8 +102,7 @@ export function buildSubpathIndexFile(
             if (
               subpath === "models" &&
               ex.getKindName() === "FunctionDeclaration" &&
-              (exDeclaration[0].endsWith("Serializer") ||
-                exDeclaration[0].endsWith("Deserializer"))
+              serializerOrDeserializerRegex.test(exDeclaration[0])
             ) {
               return false;
             }

package/src/modular/emitModels.ts

@@ -396,7 +396,7 @@ export function buildEnumTypes(
   const docs = type.doc ? type.doc : "Type of " + enumAsUnion.name;
   enumAsUnion.docs =
     isExtensibleEnum(context, type) && type.doc
-      ? [getExtensibleEnumDescription(type) ?? docs]
+      ? [getExtensibleEnumDescription(context, type) ?? docs]
       : [docs];
   enumDeclaration.docs = type.doc
     ? [type.doc]
@@ -405,7 +405,10 @@ export function buildEnumTypes(
   return [enumAsUnion, enumDeclaration];
 }
 
-function getExtensibleEnumDescription(model: SdkEnumType): string | undefined {
+function getExtensibleEnumDescription(
+  context: SdkContext,
+  model: SdkEnumType
+): string | undefined {
   if (model.isFixed && model.name && model.values) {
     return;
   }
@@ -415,7 +418,7 @@ function getExtensibleEnumDescription(model: SdkEnumType): string | undefined {
     // Escape the character / to make sure we don't incorrectly announce a comment blocks /** */
     .replace(/^\//g, "\\/")
     .replace(/([^\\])(\/)/g, "$1\\/");
-  const enumLink = `{@link Known${model.name}} can be used interchangeably with ${model.name},\n this enum contains the known values that the service supports.`;
+  const enumLink = `{@link Known${normalizeModelName(context, model)}} can be used interchangeably with ${normalizeModelName(context, model)},\n this enum contains the known values that the service supports.`;
 
   return [
     `${model.doc} \\`,

package/src/modular/serialization/buildDeserializerFunction.ts

@@ -165,7 +165,7 @@ function buildPolymorphicDeserializer(
   });
 
   statements.push(`
-      switch (item.${type.discriminatorProperty.name}) {
+      switch (item.${normalizeName(type.discriminatorProperty.name, NameType.Property)}) {
        ${cases.join("\n")}
         default:
           return item;
@@ -232,7 +232,7 @@ function buildDiscriminatedUnionDeserializer(
     `);
   }
   output.push(`
-    switch (item.${type.discriminatorProperty?.name}) {
+    switch (item.${type.discriminatorProperty ? normalizeName(type.discriminatorProperty.name, NameType.Property) : "unknown"}) {
      ${cases.join("\n")}
       default:
         return ${baseDeserializerName}(item);

package/src/modular/serialization/buildSerializerFunction.ts

@@ -172,7 +172,7 @@ function buildPolymorphicSerializer(
   });
 
   statements.push(`
-      switch (item.${type.discriminatorProperty.name}) {
+      switch (item.${normalizeName(type.discriminatorProperty.name, NameType.Property)}) {
        ${cases.join("\n")}
         default:
           return item;
@@ -239,7 +239,7 @@ function buildDiscriminatedUnionSerializer(
     `);
   }
   output.push(`
-    switch (item.${type.discriminatorProperty?.name}) {
+    switch (item.${type.discriminatorProperty ? normalizeName(type.discriminatorProperty.name, NameType.Property) : "unknown"}) {
      ${cases.join("\n")}
       default:
         return ${baseSerializerName}(item);

package/static/static-helpers/cloudSettingHelpers.ts

@@ -1,4 +1,7 @@
-/** An enum to describe Azure Cloud. */
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
 export enum AzureClouds {
   /** Azure public cloud, which is the default cloud for Azure SDKs. */
   AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
@@ -11,6 +14,12 @@ export enum AzureClouds {
 /** The supported values for cloud setting as a string literal type */
 export type AzureSupportedClouds = `${AzureClouds}`;
 
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
 export function getArmEndpoint(
   cloudSetting?: AzureSupportedClouds
 ): string | undefined {

package/static/static-helpers/urlTemplate.ts

@@ -1,6 +1,6 @@
-//---------------------
+// ---------------------
 // interfaces
-//---------------------
+// ---------------------
 interface ValueOptions {
   isFirst: boolean; // is first value in the expression
   op?: string; // operator
@@ -18,27 +18,27 @@ export interface UrlTemplateOptions {
 // ---------------------
 // helpers
 // ---------------------
-function encodeComponent(val: string, reserved?: boolean, op?: string) {
+function encodeComponent(val: string, reserved?: boolean, op?: string): string {
   return (reserved ?? op === "+") || op === "#"
     ? encodeReservedComponent(val)
     : encodeRFC3986URIComponent(val);
 }
 
-function encodeReservedComponent(str: string) {
+function encodeReservedComponent(str: string): string {
   return str
     .split(/(%[0-9A-Fa-f]{2})/g)
     .map((part) => (!/%[0-9A-Fa-f]/.test(part) ? encodeURI(part) : part))
     .join("");
 }
 
-function encodeRFC3986URIComponent(str: string) {
+function encodeRFC3986URIComponent(str: string): string {
   return encodeURIComponent(str).replace(
     /[!'()*]/g,
     (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`
   );
 }
 
-function isDefined(val: any) {
+function isDefined(val: any): boolean {
   return val !== undefined && val !== null;
 }
 
@@ -49,7 +49,7 @@ function getNamedAndIfEmpty(op?: string): [boolean, string] {
   ];
 }
 
-function getFirstOrSep(op?: string, isFirst = false) {
+function getFirstOrSep(op?: string, isFirst = false): string {
   if (isFirst) {
     return !op || op === "+" ? "" : op;
   } else if (!op || op === "+" || op === "#") {
@@ -61,7 +61,7 @@ function getFirstOrSep(op?: string, isFirst = false) {
   }
 }
 
-function getExpandedValue(option: ValueOptions) {
+function getExpandedValue(option: ValueOptions): string {
   let isFirst = option.isFirst;
   const { op, varName, varValue: value, reserved } = option;
   const vals: string[] = [];
@@ -73,7 +73,11 @@ function getExpandedValue(option: ValueOptions) {
       vals.push(`${getFirstOrSep(op, isFirst)}`);
       if (named && varName) {
         vals.push(`${encodeURIComponent(varName)}`);
-        val === "" ? vals.push(ifEmpty) : vals.push("=");
+        if (val === "") {
+          vals.push(ifEmpty);
+        } else {
+          vals.push("=");
+        }
       }
       vals.push(encodeComponent(val, reserved, op));
       isFirst = false;
@@ -88,7 +92,11 @@ function getExpandedValue(option: ValueOptions) {
       vals.push(`${getFirstOrSep(op, isFirst)}`);
       if (key) {
         vals.push(`${encodeURIComponent(key)}`);
-        named && val === "" ? vals.push(ifEmpty) : vals.push("=");
+        if (named && val === "") {
+          vals.push(ifEmpty);
+        } else {
+          vals.push("=");
+        }
       }
       vals.push(encodeComponent(val, reserved, op));
       isFirst = false;
@@ -97,7 +105,7 @@ function getExpandedValue(option: ValueOptions) {
   return vals.join("");
 }
 
-function getNonExpandedValue(option: ValueOptions) {
+function getNonExpandedValue(option: ValueOptions): string | undefined {
   const { op, varName, varValue: value, isFirst, reserved } = option;
   const vals: string[] = [];
   const first = getFirstOrSep(op, isFirst);
@@ -143,7 +151,11 @@ function getVarValue(option: ValueOptions): string | undefined {
     if (named && varName) {
       // No need to encode varName considering it is already encoded
       vals.push(varName);
-      val === "" ? vals.push(ifEmpty) : vals.push("=");
+      if (val === "") {
+        vals.push(ifEmpty);
+      } else {
+        vals.push("=");
+      }
     }
     if (modifier && modifier !== "*") {
       val = val.substring(0, parseInt(modifier, 10));
@@ -165,7 +177,7 @@ export function expandUrlTemplate(
   context: Record<string, any>,
   option?: UrlTemplateOptions
 ): string {
-  return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, (_, expr, text) => {
+  return template.replace(/\{([^{}]+)\}|([^{}]+)/g, (_, expr, text) => {
     if (!expr) {
       return encodeReservedComponent(text);
     }
@@ -177,7 +189,7 @@ export function expandUrlTemplate(
     const varList = expr.split(/,/g);
     const result = [];
     for (const varSpec of varList) {
-      const varMatch = /([^:\*]*)(?::(\d+)|(\*))?/.exec(varSpec);
+      const varMatch = /([^:*]*)(?::(\d+)|(\*))?/.exec(varSpec);
       if (!varMatch || !varMatch[1]) {
         continue;
       }