@autorest/typescript 6.0.38 → 6.0.39

package/src/generators/static/apiExtractorConfig.ts

@@ -5,7 +5,7 @@ import { Project } from "ts-morph";
 import { getAutorestOptions } from "../../autorestSession";
 
 export function generateApiExtractorConfig(project: Project) {
-  const { generateMetadata, packageDetails, generateTest, restLevelClient } = getAutorestOptions();
+  const { generateMetadata, packageDetails } = getAutorestOptions();
 
   if (!generateMetadata) {
     return;
@@ -14,7 +14,7 @@ export function generateApiExtractorConfig(project: Project) {
   const config = {
     $schema:
       "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-    mainEntryPointFilePath: `${restLevelClient ? "./types" : "./dist-esm"}${generateTest ? "/src" : ""}/index.d.ts`,
+    mainEntryPointFilePath: `dist/esm/index.d.ts`,
     docModel: {
       enabled: true
     },
@@ -25,7 +25,7 @@ export function generateApiExtractorConfig(project: Project) {
     dtsRollup: {
       enabled: true,
       untrimmedFilePath: "",
-      publicTrimmedFilePath: `./types/${packageDetails.nameWithoutScope}.d.ts`
+      publicTrimmedFilePath: `dist/${packageDetails.nameWithoutScope}.d.ts`
     },
     messages: {
       tsdocMessageReporting: {
@@ -44,7 +44,7 @@ export function generateApiExtractorConfig(project: Project) {
     }
   };
 
-  project.createSourceFile("api-extractor.json", JSON.stringify(config), {
+  project.createSourceFile("api-extractor.json", JSON.stringify(config, null, 2), {
     overwrite: true
   });
 }

package/src/generators/static/lroImpl.ts

@@ -1,5 +1,3 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
 
 import { AbortSignalLike } from "@azure/abort-controller";
 import { LongRunningOperation, LroResponse } from "@azure/core-lro";

package/src/generators/static/packageFileGenerator.ts

@@ -60,7 +60,8 @@ function regularAutorestPackage(
     generateTest,
     generateSample,
     coreHttpCompatMode,
-    azureSdkForJs
+    azureSdkForJs,
+    isTestPackage
   } = getAutorestOptions();
   const { model } = getSession();
   const { addCredentials } = getSecurityInfoFromModel(model.security);
@@ -88,22 +89,23 @@ function regularAutorestPackage(
     dependencies: {
       ...(hasLro && { "@azure/core-lro": "^2.5.4" }),
       ...(hasLro && { "@azure/abort-controller": "^2.1.2" }),
-      ...(hasAsyncIterators && { "@azure/core-paging": "^1.2.0" }),
-      ...(useCoreV2 && { "@azure/core-client": "^1.7.0" }),
-      ...(useCoreV2 && addCredentials && { "@azure/core-auth": "^1.6.0" }),
+      ...(hasAsyncIterators && { "@azure/core-paging": "^1.6.2" }),
+      ...(useCoreV2 && { "@azure/core-client": "^1.9.2" }),
+      ...(useCoreV2 && addCredentials && { "@azure/core-auth": "^1.9.0" }),
       ...(useCoreV2 && {
-        "@azure/core-rest-pipeline": "^1.14.0"
+        "@azure/core-rest-pipeline": "^1.19.0"
       }),
       ...(tracingInfo && {
-        "@azure/core-tracing": "^1.0.0"
+        "@azure/core-tracing": "^1.2.0"
       }),
-      tslib: "^2.2.0"
+      tslib: "^2.8.1"
     },
-    keywords: ["node", "azure", "typescript", "browser", "isomorphic"],
+    keywords: ["node", "azure", "typescript", "browser", "isomorphic", "cloud"],
     license: "MIT",
-    main: `./dist/index.js`,
-    module: `./dist-esm/index.js`,
-    types: `./types/${packageDetails.nameWithoutScope}.d.ts`,
+    main: "./dist/commonjs/index.js",
+    module: "./dist/esm/index.js",
+    types: "./dist/commonjs/index.d.ts",
+    type: "module",
     devDependencies: {
       "@microsoft/api-extractor": "^7.40.3",
       mkdirp: "^3.0.1",
@@ -111,37 +113,24 @@ function regularAutorestPackage(
       rimraf: "^5.0.0",
       dotenv: "^16.0.0"
     },
-    repository: {
-      type: "git",
-      url: "https://github.com/Azure/azure-sdk-for-js.git"
-    },
+    repository: "github:Azure/azure-sdk-for-js",
     bugs: {
       url: "https://github.com/Azure/azure-sdk-for-js/issues"
     },
     files: [
-      "dist/**/*.js",
-      "dist/**/*.js.map",
-      "dist/**/*.d.ts",
-      "dist/**/*.d.ts.map",
-      "dist-esm/**/*.js",
-      "dist-esm/**/*.js.map",
-      "dist-esm/**/*.d.ts",
-      "dist-esm/**/*.d.ts.map",
-      `${srcPath}/**/*.ts`,
+      "dist/",
       "README.md",
       "LICENSE",
-      "tsconfig.json",
       "review/*",
       "CHANGELOG.md",
-      "types/*"
     ],
     scripts: {
       build:
-        "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
+        "npm run clean && tshy && npm run extract-api",
       minify: `uglifyjs -c -m --comments --source-map "content='./dist/index.js.map'" -o ./dist/index.min.js ./dist/index.js`,
       prepack: "npm run build",
       pack: "npm pack 2>&1",
-      "extract-api": "api-extractor run --local",
+      "extract-api": "rimraf review && mkdirp ./review && api-extractor run --local",
       lint: "echo skipped",
       clean:
         "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
@@ -171,23 +160,36 @@ function regularAutorestPackage(
         }
       ]
     },
-    autoPublish: true
+    autoPublish: true,
+    browser: "./dist/browser/index.js",
+    "react-native": "./dist/react-native/index.js"
   };
   if (azureOutputDirectory) {
     packageInfo.homepage = `https://github.com/Azure/azure-sdk-for-js/tree/main/${azureOutputDirectory}`;
   }
-
   if (azureSdkForJs) {
+    packageInfo["tshy"] = {
+      project: "./tsconfig.src.json",
+      exports: {
+        "./package.json": "./package.json",
+        ".": "./src/index.ts",
+      },
+      dialects: ["esm", "commonjs"],
+      esmDialects: ["browser", "react-native"],
+      selfLink: false,
+    };
     packageInfo.devDependencies["@azure/dev-tool"] = "^1.0.0";
     delete packageInfo.devDependencies["@microsoft/api-extractor"];
     delete packageInfo.devDependencies["rimraf"];
     delete packageInfo.devDependencies["mkdirp"];
     packageInfo.scripts["build"] =
-      "npm run clean && tsc && dev-tool run bundle && npm run minify && dev-tool run vendored mkdirp ./review && npm run extract-api";
+      "npm run clean && dev-tool run build-package && dev-tool run extract-api";
     packageInfo.scripts["clean"] = "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log";
     packageInfo.scripts["extract-api"] = "dev-tool run extract-api";
     packageInfo.scripts["update-snippets"] = "dev-tool run update-snippets";
     packageInfo.scripts["minify"] = `dev-tool run vendored uglifyjs -c -m --comments --source-map "content='./dist/index.js.map'" -o ./dist/index.min.js ./dist/index.js`;
+    packageInfo.scripts["check-format"] = "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ";
+    packageInfo.scripts["format"] = "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ";
   } else {
     packageInfo.devDependencies["@rollup/plugin-commonjs"] = "^24.0.0";
     packageInfo.devDependencies["@rollup/plugin-json"] = "^6.0.0";
@@ -196,21 +198,23 @@ function regularAutorestPackage(
     packageInfo.devDependencies["rollup"] = "^2.66.1";
     packageInfo.devDependencies["rollup-plugin-sourcemaps"] = "^0.6.3";
     packageInfo.devDependencies["uglify-js"] = "^3.4.9";
+    packageInfo.devDependencies["tshy"] = "^2.0.0";
   }
 
   if (generateTest) {
-    packageInfo.module = `./dist-esm/src/index.js`;
-    packageInfo.devDependencies["@azure/identity"] = "^4.2.1";
+    packageInfo.devDependencies["@azure/identity"] = "^4.6.0";
     packageInfo.devDependencies["@azure/logger"] = "^1.1.4";
-    packageInfo.devDependencies["@azure-tools/test-recorder"] = "^3.0.0";
-    packageInfo.devDependencies["@azure-tools/test-credential"] = "^1.1.0";
-    packageInfo.devDependencies["mocha"] = "^11.0.2";
-    packageInfo.devDependencies["@types/mocha"] = "^10.0.0";
-    packageInfo.devDependencies["tsx"] = "^4.7.1";
-    packageInfo.devDependencies["@types/chai"] = "^4.2.8";
-    packageInfo.devDependencies["chai"] = "^4.2.0";
+    // TODO need unify the version when 4.1.0 released
+    packageInfo.devDependencies["@azure-tools/test-recorder"] = azureSdkForJs ? "^4.1.0" : "^4.0.0";
+    packageInfo.devDependencies["@azure-tools/test-credential"] = "^2.0.0";
+    if (azureSdkForJs) {
+      packageInfo.devDependencies["@azure-tools/test-utils-vitest"] = "^1.0.0";
+    }
     packageInfo.devDependencies["@types/node"] = "^18.0.0";
-    packageInfo.devDependencies["ts-node"] = "^10.0.0";
+    packageInfo.devDependencies["@vitest/browser"] = "^3.0.9";
+    packageInfo.devDependencies["@vitest/coverage-istanbul"] = "^3.0.9";
+    packageInfo.devDependencies["playwright"] = "^1.50.1";
+    packageInfo.devDependencies["vitest"] = "^3.0.9";
 
     packageInfo.scripts["test"] = "npm run integration-test";
     packageInfo.scripts["unit-test"] =
@@ -220,9 +224,9 @@ function regularAutorestPackage(
 
     if (azureSdkForJs) {
       packageInfo.scripts["unit-test:node"] =
-        "dev-tool run vendored cross-env TEST_MODE=playback npm run integration-test:node";
+        "dev-tool run test:vitest";
       packageInfo.scripts["integration-test:node"] =
-        "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'";
+        "dev-tool run test:vitest --esm";
     } else {
       packageInfo.devDependencies["cross-env"] = "^7.0.2";
       packageInfo.scripts["unit-test:node"] =

package/src/generators/static/tsConfigBrowserFileGenerator.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { Project } from "ts-morph";
+import { getAutorestOptions } from "../../autorestSession";
+
+const highLevelTsBrowserConfig: Record<string, any> = {
+    "extends": [
+        "./tsconfig.test.json",
+        "../../../tsconfig.browser.base.json"
+    ]
+};
+
+export function generateTsBrowserConfig(project: Project) {
+    const {
+        generateMetadata,
+    } = getAutorestOptions();
+
+    if (!generateMetadata) {
+        return;
+    }
+    project.createSourceFile("tsconfig.browser.config.json", JSON.stringify(highLevelTsBrowserConfig), {
+        overwrite: true
+    });
+}

package/src/generators/static/tsConfigFileGenerator.ts

@@ -18,7 +18,8 @@ const highLevelTsConfig: Record<string, any> = {
     lib: ["es6", "dom"],
     declaration: true,
     outDir: "./dist-esm",
-    importHelpers: true
+    importHelpers: true,
+    skipLibCheck: true
   },
   include: ["src/**/*.ts"],
   exclude: ["node_modules"]

package/src/generators/test/sampleTest.ts.hbs

@@ -1,13 +1,11 @@
-import { Recorder, RecorderStartOptions, env } from "@azure-tools/test-recorder";
-import { assert } from "chai";
-import { Context } from "mocha";
-
+import { Recorder,RecorderStartOptions } from "@azure-tools/test-recorder";
+import { afterEach, beforeEach, describe, it, assert } from "vitest";
 
 const replaceableVariables: Record<string, string> = {
   AZURE_CLIENT_ID: "azure_client_id",
   AZURE_CLIENT_SECRET: "azure_client_secret",
   AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
-  SUBSCRIPTION_ID: "azure_subscription_id"
+  SUBSCRIPTION_ID: "azure_subscription_id",
 };
 
 const recorderOptions: RecorderStartOptions = {
@@ -17,16 +15,16 @@ const recorderOptions: RecorderStartOptions = {
 describe("My test", () => {
   let recorder: Recorder;
 
-  beforeEach(async function (this: Context) {
-    recorder = new Recorder(this.currentTest);
+  beforeEach(async () => {
+    recorder = new Recorder();
     await recorder.start(recorderOptions);
   });
 
-  afterEach(async function () {
+  afterEach(async () => {
     await recorder.stop();
   });
 
-  it("sample test", async function () {
-    console.log("Hi, I'm a test!");
+  it("sample test", async () => {
+    assert(true);
   });
-});
+});

package/src/generators/test/sampleTestGenerator.ts

@@ -14,7 +14,7 @@ export function generateSampleTestFile(project: Project) {
     encoding: "utf-8"
   });
   const readmeFileContents = hbs.compile(file, { noEscape: true });
-  project.createSourceFile("test/sampleTest.ts", readmeFileContents(metadata), {
+  project.createSourceFile("test/sampleTest.spec.ts", readmeFileContents(metadata), {
     overwrite: true
   });
 }

package/src/generators/test/vitestGenerator.ts

@@ -0,0 +1,66 @@
+import { Project } from "ts-morph";
+import { getAutorestOptions } from "../../autorestSession";
+
+const nodeConfig = `
+import { defineConfig, mergeConfig } from "vitest/config";
+import viteConfig from "../../../vitest.shared.config.ts";
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      testTimeout: 1200000,
+      hookTimeout: 1200000,
+    },
+  }),
+);`;
+
+const browserConfig = `
+import { defineConfig, mergeConfig } from "vitest/config";
+import viteConfig from "../../../vitest.browser.shared.config.ts";
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      include: ["dist-test/browser/test/**/*.spec.js"],
+      testTimeout: 1200000,
+      hookTimeout: 1200000,
+    },
+  }),
+);`;
+
+const esmConfig = `
+import { mergeConfig } from "vitest/config";
+import vitestConfig from "./vitest.config.ts";
+import vitestEsmConfig from "../../../vitest.esm.shared.config.ts";
+
+export default mergeConfig(vitestConfig, vitestEsmConfig);`;
+
+export function generateVitestConfig(
+  project: Project,
+  platform: "browser" | "node" | "esm"
+) {
+  const { generateTest, generateMetadata, azureSdkForJs } = getAutorestOptions();
+  if (
+    azureSdkForJs === false ||
+    generateMetadata === false ||
+    generateTest === false
+  ) {
+    return;
+  }
+  switch (platform) {
+    case "browser":
+      project.createSourceFile("vitest.browser.config.ts", browserConfig, {
+        overwrite: true
+      });
+    case "node":
+      project.createSourceFile("vitest.config.ts", nodeConfig, {
+        overwrite: true
+      });
+    case "esm":
+      project.createSourceFile("vitest.esm.config.ts", esmConfig, {
+        overwrite: true
+      });
+  }
+}

package/src/generators/utils/pagingOperations.ts

@@ -55,7 +55,7 @@ export function addPagingImports(
   sourceFile: SourceFile,
   isClient = false
 ) {
-  const { disablePagingAsyncIterators, moduleKind } = getAutorestOptions();
+  const { disablePagingAsyncIterators, isTestPackage } = getAutorestOptions();
   if (!disablePagingAsyncIterators && hasAsyncIteratorOperations(operations)) {
     const pagingHelperPath = isClient ? "./pagingHelper" : "../pagingHelper";
     sourceFile.addImportDeclarations([
@@ -65,7 +65,7 @@ export function addPagingImports(
       },
       {
         namedImports: ["setContinuationToken"],
-        moduleSpecifier: getImportModuleName(pagingHelperPath, moduleKind)
+        moduleSpecifier: getImportModuleName(pagingHelperPath, isTestPackage)
       }
     ]);
   }

package/src/generators/utils/tracingUtils.ts

@@ -11,12 +11,12 @@ export function addTracingOperationImports(
   sourceFile: SourceFile,
   traverseToRoot = ".."
 ) {
-  const { tracingInfo, moduleKind } = getAutorestOptions();
+  const { tracingInfo, isTestPackage } = getAutorestOptions();
   if (tracingInfo) {
     sourceFile.addImportDeclarations([
       {
         namedImports: ["tracingClient"],
-        moduleSpecifier: getImportModuleName(`${traverseToRoot}/tracing`, moduleKind)
+        moduleSpecifier: getImportModuleName(`${traverseToRoot}/tracing`, isTestPackage)
       }
     ]);
   }

package/src/typescriptGenerator.ts

@@ -31,6 +31,8 @@ import { generateTracingFile } from "./generators/tracingFileGenerator";
 import { getAutorestOptions } from "./autorestSession";
 import { conflictResolver } from "./conflictResolver";
 import { generateSnippetsFile } from "./generators/test/snippetsGenerator";
+import { generateVitestConfig } from "./generators/test/vitestGenerator";
+import { generateTsBrowserConfig } from "./generators/static/tsConfigBrowserFileGenerator";
 
 const prettierTypeScriptOptions: prettier.Options = {
   parser: "typescript",
@@ -85,6 +87,11 @@ export async function generateTypeScriptLibrary(
   if (generateTest) {
     generateSnippetsFile(codeModel, project, clientDetails);
     generateSampleTestFile(project);
+    if (azureSdkForJs) {
+      generateVitestConfig(project, "node");
+      generateVitestConfig(project, "browser");
+      generateVitestConfig(project, "esm");
+    }
   }
   generateTsConfig(project);
   if (azureSdkForJs && generateMetadata) {
@@ -94,6 +101,7 @@ export async function generateTypeScriptLibrary(
     }
     if (generateTest) {
       generateTsTestConfig(project);
+      generateTsBrowserConfig(project);
     }
   }
 

package/src/utils/autorestOptions.ts

@@ -46,8 +46,6 @@ export async function extractAutorestOptions(): Promise<AutorestOptions> {
   const dependencyInfo = await getDependencyInfo(host);
   const flavor = await getFlavor(host);
 
-  const moduleKind = await getModuleKind(host);
-
   return {
     azureArm,
     addCredentials,
@@ -82,7 +80,6 @@ export async function extractAutorestOptions(): Promise<AutorestOptions> {
     dependencyInfo,
     useLegacyLro,
     flavor,
-    moduleKind
   };
 }
 
@@ -401,8 +398,4 @@ async function getDependencyInfo(
   throw new Error(
     "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

@@ -1,8 +1,8 @@
 export type ModuleName =
-  | string
-  | {
-      esModulesName: string;
-      cjsName: string;
+    | string
+    | {
+        esModulesName: string;
+        cjsName: string;
     };
 
 /**
@@ -10,26 +10,24 @@ export type ModuleName =
  * 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".
+ * @param isTestPackage If isTestPackage is true which means we will not generate .js suffix when importing files
  *
  * @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"
+ * getImportModuleName("myModule", true) // returns "myModule"
+ * getImportModuleName("myModule", false) // returns "myModule.js"
+ * getImportModuleName({ cjsName: "myModule", esModulesName: "myModule/index.js" }, true) // returns "myModule"
+ * getImportModuleName({ cjsName: "myModule", esModulesName: "myModule/index.js" }, false) // returns "myModule/index.js"
  */
+// TODO remove this function after migrating the configs for integration. Issue: https://github.com/Azure/autorest.typescript/issues/3166
 export function getImportModuleName(
-  name: ModuleName,
-  moduleKind?: "cjs" | "esm"
+    name: ModuleName,
+    isTestPackage?: boolean
 ): 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;
-}
+    if (isTestPackage) {
+        return typeof name === "string" ? name : name.cjsName;
+    } else {
+        return typeof name === "string" ? `${name}.js` : name.esModulesName;
+    }
+}