@autorest/typescript 6.0.31 → 6.0.32

package/src/generators/operationGenerator.ts

@@ -51,6 +51,7 @@ import {
 import { calculateMethodName } from "./utils/operationsUtils";
 import { getAutorestOptions } from "../autorestSession";
 import { createLroImports, createLroType } from "../utils/lroHelpers";
+import { getImportModuleName } from "../utils/nameConstructors";
 
 /**
  * Function that writes the code for all the operations.
@@ -65,7 +66,7 @@ export function generateOperations(
   clientDetails: ClientDetails,
   project: Project
 ): void {
-  const { srcPath } = getAutorestOptions();
+  const { srcPath, moduleKind } = getAutorestOptions();
   let fileNames: string[] = [];
 
   // Toplevel operations are inlined in the client
@@ -88,7 +89,7 @@ export function generateOperations(
     operationIndexFile.addExportDeclarations(
       fileNames.map(fileName => {
         return {
-          moduleSpecifier: `./${fileName}`
+          moduleSpecifier: getImportModuleName(`./${fileName}`, moduleKind)
         } as ExportDeclarationStructure;
       })
     );
@@ -328,8 +329,8 @@ function buildRequestBody({
       required = rb.required
         ? rb.required
         : rb.parameter.groupedBy && rb.parameter.groupedBy.required
-        ? rb.parameter.groupedBy.required
-        : required;
+          ? rb.parameter.groupedBy.required
+          : required;
 
       if (required) break;
     }
@@ -465,6 +466,7 @@ function addClass(
   clientDetails: ClientDetails
 ) {
   let importedModels = new Set<string>();
+  const { moduleKind } = getAutorestOptions();
 
   let allModelsNames = getAllModelsNames(clientDetails);
 
@@ -526,7 +528,7 @@ function addClass(
 
     operationGroupFile.addImportDeclaration({
       namedImports,
-      moduleSpecifier: "../models"
+      moduleSpecifier: getImportModuleName({ cjsName: "../models", esModulesName: "../models/index.js" }, moduleKind)
     });
   }
 }
@@ -750,14 +752,13 @@ function compileOperationOptionsToRequestOptionsBase(
   // In Lro we have a couple extra properties to add that's why we use
   // the private getOperationOptions function instead of the one in core-http
   return isLro
-    ? `this.getOperationOptions(${options}${
-        lroResourceLocationConfig === undefined
-          ? ""
-          : `, "${lroResourceLocationConfig}"`
-      })`
+    ? `this.getOperationOptions(${options}${lroResourceLocationConfig === undefined
+      ? ""
+      : `, "${lroResourceLocationConfig}"`
+    })`
     : !useCoreV2
-    ? `coreHttp.operationOptionsToRequestOptionsBase(options || {})`
-    : `options || {}`;
+      ? `coreHttp.operationOptionsToRequestOptionsBase(options || {})`
+      : `options || {}`;
 }
 
 function writeNoOverloadsOperationBody(
@@ -910,11 +911,11 @@ function writeLroOperationBody(
   const sendOperationStatement = !useCoreV2
     ? `const directSendOperation = async (args: coreHttp.OperationArguments, spec: coreHttp.OperationSpec): Promise<${responseName}> => {
       ${getTracingClientWithSpanStatement(
-        sendRequestStatement,
-        responseName,
-        isTracingEnabled,
-        spanName
-      )}
+      sendRequestStatement,
+      responseName,
+      isTracingEnabled,
+      spanName
+    )}
       };
       const sendOperation = async (args: coreHttp.OperationArguments, spec: coreHttp.OperationSpec) => {
         const response = await directSendOperation(args, spec);
@@ -956,21 +957,18 @@ function writeLroOperationBody(
       }};
   }`;
 
-  const commonOptions = `intervalInMs: options?.updateIntervalInMs${
-    lroResourceLocationConfig
-      ? `, ${
-          useLegacyLro ? "lroResourceLocationConfig" : "resourceLocationConfig"
-        }: "${lroResourceLocationConfig.toLowerCase()}"`
-      : ""
-  }`;
+  const commonOptions = `intervalInMs: options?.updateIntervalInMs${lroResourceLocationConfig
+    ? `, ${useLegacyLro ? "lroResourceLocationConfig" : "resourceLocationConfig"
+    }: "${lroResourceLocationConfig.toLowerCase()}"`
+    : ""
+    }`;
   methodDeclaration.addStatements([
     sendOperationStatement,
     `const lro = createLroSpec({sendOperationFn, args: ${operationParamsName},
       spec: ${operationSpecName}})`,
-    `const poller = ${
-      useLegacyLro
-        ? `new LroEngine(lro, { resumeFrom: options?.resumeFrom, ${commonOptions} })`
-        : `await createHttpPoller<${responseName}, OperationState<${responseName}>>(lro, { restoreFrom: options?.resumeFrom, ${commonOptions} })`
+    `const poller = ${useLegacyLro
+      ? `new LroEngine(lro, { resumeFrom: options?.resumeFrom, ${commonOptions} })`
+      : `await createHttpPoller<${responseName}, OperationState<${responseName}>>(lro, { restoreFrom: options?.resumeFrom, ${commonOptions} })`
     };`,
     "await poller.poll();",
     "return poller;"
@@ -1239,7 +1237,7 @@ function addImports(
   operationGroupFile: SourceFile,
   clientDetails: ClientDetails
 ) {
-  const { useCoreV2, useLegacyLro } = getAutorestOptions();
+  const { useCoreV2, useLegacyLro, moduleKind } = getAutorestOptions();
 
   const { className, mappers } = clientDetails;
   addPagingEsNextRef(operationGroupDetails.operations, operationGroupFile);
@@ -1254,7 +1252,7 @@ function addImports(
 
   operationGroupFile.addImportDeclaration({
     namedImports: [`${operationGroupInterfaceName}`],
-    moduleSpecifier: "../operationsInterfaces"
+    moduleSpecifier: getImportModuleName({ cjsName: "../operationsInterfaces", esModulesName: "../operationsInterfaces/index.js" }, moduleKind)
   });
 
   if (!useCoreV2) {
@@ -1284,14 +1282,14 @@ function addImports(
   if (mappers.length) {
     operationGroupFile.addImportDeclaration({
       namespaceImport: "Mappers",
-      moduleSpecifier: "../models/mappers"
+      moduleSpecifier: getImportModuleName("../models/mappers", moduleKind)
     });
   }
 
   if (shouldImportParameters(clientDetails)) {
     operationGroupFile.addImportDeclaration({
       namespaceImport: "Parameters",
-      moduleSpecifier: "../models/parameters"
+      moduleSpecifier: getImportModuleName("../models/parameters", moduleKind)
     });
   }
 
@@ -1301,7 +1299,7 @@ function addImports(
 
   operationGroupFile.addImportDeclaration({
     namedImports: [`${clientClassName}`],
-    moduleSpecifier: `../${clientFileName}`
+    moduleSpecifier: getImportModuleName(`../${clientFileName}`, moduleKind)
   });
 
   if (hasLroOperation(operationGroupDetails)) {
@@ -1311,7 +1309,7 @@ function addImports(
     });
     operationGroupFile.addImportDeclaration({
       namedImports: ["createLroSpec"],
-      moduleSpecifier: `../lroImpl`
+      moduleSpecifier: getImportModuleName(`../lroImpl`, moduleKind)
     });
   }
 }

package/src/generators/operationInterfaceGenerator.ts

@@ -30,6 +30,7 @@ import {
 import { calculateMethodName } from "./utils/operationsUtils";
 import { getAutorestOptions } from "../autorestSession";
 import { createLroType } from "../utils/lroHelpers";
+import { getImportModuleName } from "../utils/nameConstructors";
 
 /**
  * Function that writes the code for all the operations.
@@ -44,7 +45,7 @@ export function generateOperationsInterfaces(
   clientDetails: ClientDetails,
   project: Project
 ): void {
-  const { srcPath } = getAutorestOptions();
+  const { srcPath, moduleKind } = getAutorestOptions();
   let fileNames: string[] = [];
 
   // Toplevel operations are inlined in the client
@@ -67,7 +68,7 @@ export function generateOperationsInterfaces(
     operationIndexFile.addExportDeclarations(
       fileNames.map(fileName => {
         return {
-          moduleSpecifier: `./${fileName}`
+          moduleSpecifier: getImportModuleName(`./${fileName}`, moduleKind)
         } as ExportDeclarationStructure;
       })
     );
@@ -128,6 +129,8 @@ function addInterface(
   operationGroupDetails: OperationGroupDetails,
   clientDetails: ClientDetails
 ) {
+  const { moduleKind } = getAutorestOptions();
+
   let importedModels = new Set<string>();
 
   let allModelsNames = getAllModelsNames(clientDetails);
@@ -164,7 +167,7 @@ function addInterface(
 
     operationGroupFile.addImportDeclaration({
       namedImports,
-      moduleSpecifier: "../models"
+      moduleSpecifier: getImportModuleName({ cjsName: "../models", esModulesName: "../models/index.js" }, moduleKind)
     });
   }
 }

package/src/generators/parametersGenerator.ts

@@ -15,12 +15,13 @@ import { writeMapper } from "./mappersGenerator";
 import { shouldImportParameters } from "./utils/importUtils";
 import { logger } from "../utils/logger";
 import { getAutorestOptions } from "../autorestSession";
+import { getImportModuleName } from "../utils/nameConstructors";
 
 export function generateParameters(
   clientDetails: ClientDetails,
   project: Project
 ): void {
-  const { useCoreV2, srcPath } = getAutorestOptions();
+  const { useCoreV2, srcPath, moduleKind } = getAutorestOptions();
   if (!shouldImportParameters(clientDetails)) {
     logger.verbose(
       "There are no parameters to generate, skipping parameters file generation"
@@ -46,7 +47,7 @@ export function generateParameters(
   if (importedMappers.length) {
     parametersFile.addImportDeclaration({
       namedImports: importedMappers,
-      moduleSpecifier: "../models/mappers"
+      moduleSpecifier: getImportModuleName("../models/mappers", moduleKind)
     });
   }
 

package/src/generators/static/hlcREADME.md.hbs

@@ -59,7 +59,7 @@ npm install @azure/identity
 
 You will also need to **register a new AAD application and grant access to {{ serviceName}}** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
 
-For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
+For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
 
 {{#if azureArm}}
 ```javascript
@@ -146,7 +146,7 @@ If you'd like to contribute to this library, please read the [contributing guide
 {{#if impressionURL}}![Impressions]({{ impressionURL }})
 {{/if}}
 
-[azure_cli]: https://docs.microsoft.com/cli/azure
+[azure_cli]: https://learn.microsoft.com/cli/azure
 [azure_sub]: https://azure.microsoft.com/free/
 [azure_sub]: https://azure.microsoft.com/free/
 [azure_portal]: https://portal.azure.com

package/src/generators/static/packageFileGenerator.ts

@@ -238,7 +238,7 @@ function regularAutorestPackage(
       productName: description,
       productSlugs: ["azure"],
       disableDocsMs: true,
-      apiRefLink: `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
+      apiRefLink: `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
     };
   }
   return packageInfo;

package/src/generators/static/readmeFileGenerator.ts

@@ -155,7 +155,7 @@ function createMetadata(
     clientDescriptiveName: `${serviceName} client`,
     description: codeModel.info?.description,
     apiRefURL: azureHuh
-      ? `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
+      ? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
       : undefined,
     packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
     contributingGuideURL: repoURL && `${repoURL}/blob/main/CONTRIBUTING.md`,

package/src/generators/utils/pagingOperations.ts

@@ -20,6 +20,7 @@ import {
   getPagingResponseBodyType
 } from "./responseTypeUtils";
 import { getAutorestOptions } from "../../autorestSession";
+import { getImportModuleName } from "../../utils/nameConstructors";
 
 type MethodParameter = OptionalKind<
   ParameterDeclarationStructure & {
@@ -54,8 +55,9 @@ export function addPagingImports(
   sourceFile: SourceFile,
   isClient = false
 ) {
-  const { disablePagingAsyncIterators } = getAutorestOptions();
+  const { disablePagingAsyncIterators, moduleKind } = getAutorestOptions();
   if (!disablePagingAsyncIterators && hasAsyncIteratorOperations(operations)) {
+    const pagingHelperPath = isClient ? "./pagingHelper" : "../pagingHelper";
     sourceFile.addImportDeclarations([
       {
         namedImports: ["PagedAsyncIterableIterator", "PageSettings"],
@@ -63,7 +65,7 @@ export function addPagingImports(
       },
       {
         namedImports: ["setContinuationToken"],
-        moduleSpecifier: isClient ? "./pagingHelper" : "../pagingHelper"
+        moduleSpecifier: getImportModuleName(pagingHelperPath, moduleKind)
       }
     ]);
   }
@@ -227,9 +229,9 @@ export function writeAsyncIterators(
         },
         nextMethod: nextMethodParameters
           ? {
-              name: `${operation.namePrefix}${nextOperationName}`,
-              parameters: nextMethodParameters
-            }
+            name: `${operation.namePrefix}${nextOperationName}`,
+            parameters: nextMethodParameters
+          }
           : undefined,
         publicMethod: {
           name: getPublicMethodName(operation),

package/src/generators/utils/tracingUtils.ts

@@ -1,5 +1,6 @@
 import { SourceFile } from "ts-morph";
 import { getAutorestOptions } from "../../autorestSession";
+import { getImportModuleName } from "../../utils/nameConstructors";
 
 /**
  * Adds the required imports to have operations tracing
@@ -10,12 +11,12 @@ export function addTracingOperationImports(
   sourceFile: SourceFile,
   traverseToRoot = ".."
 ) {
-  const { tracingInfo } = getAutorestOptions();
+  const { tracingInfo, moduleKind } = getAutorestOptions();
   if (tracingInfo) {
     sourceFile.addImportDeclarations([
       {
         namedImports: ["tracingClient"],
-        moduleSpecifier: `${traverseToRoot}/tracing`
+        moduleSpecifier: getImportModuleName(`${traverseToRoot}/tracing`, moduleKind)
       }
     ]);
   }

package/src/utils/autorestOptions.ts

@@ -46,6 +46,8 @@ export async function extractAutorestOptions(): Promise<AutorestOptions> {
   const dependencyInfo = await getDependencyInfo(host);
   const flavor = await getFlavor(host);
 
+  const moduleKind = await getModuleKind(host);
+
   return {
     azureArm,
     addCredentials,
@@ -79,7 +81,8 @@ export async function extractAutorestOptions(): Promise<AutorestOptions> {
     coreHttpCompatMode,
     dependencyInfo,
     useLegacyLro,
-    flavor
+    flavor,
+    moduleKind
   };
 }
 
@@ -399,3 +402,7 @@ async function getDependencyInfo(
     "Invalid dependency-info. Make sure that link and description are defined"
   );
 }
+
+async function getModuleKind(host: AutorestExtensionHost): Promise<AutorestOptions["moduleKind"]> {
+  return (await host.getValue("module-kind")) || "cjs";
+}

package/src/utils/nameConstructors.ts

@@ -0,0 +1,35 @@
+export type ModuleName =
+  | string
+  | {
+      esModulesName: string;
+      cjsName: string;
+    };
+
+/**
+ * This is a helper function that gets the right import module depending on the type of
+ * library being generated.
+ *
+ * @param name The name of the module to import - this can be a string representing the base name of the module or an object with the cjsName and esModulesName properties. *
+ * @param moduleKind The type of module being generated. This can be either "cjs" or "esm".
+ *
+ * @example
+ *
+ * ```ts
+ * getImportModuleName("myModule", "cjs") // returns "myModule"
+ * getImportModuleName("myModule", "esm") // returns "myModule.js"
+ * getImportModuleName({ cjsName: "myModule", esModulesName: "myModule/index.js" }, "cjs") // returns "myModule"
+ * getImportModuleName({ cjsName: "myModule", esModulesName: "myModule/index.js" }, "esm") // returns "myModule/index.js"
+ */
+export function getImportModuleName(
+  name: ModuleName,
+  moduleKind?: "cjs" | "esm"
+): string {
+  const cjsName = typeof name === "string" ? name : name.cjsName;
+  const esModulesName =
+    typeof name === "string" ? `${name}.js` : name.esModulesName;
+  if (moduleKind === "esm") {
+    return esModulesName;
+  }
+  // CJS is considered the default in autorest.typescript
+  return cjsName;
+}