@azure-tools/typespec-ts 0.28.0 → 0.29.0-alpha.20240531.1

package/src/modular/buildProjectFiles.ts

@@ -1,31 +1,7 @@
-import { Project } from "ts-morph";
 import { ModularCodeModel } from "./modularCodeModel.js";
 import { NameType, normalizeName } from "@azure-tools/rlc-common";
-import {
-  hasLROOperation,
-  hasPagingOperation
-} from "./helpers/operationHelpers.js";
 import { getClassicalLayerPrefix } from "./helpers/namingHelpers.js";
 
-// =========== utils =============
-function appendPathWhenFormat(
-  generateTest?: boolean,
-  generateSample?: boolean
-) {
-  let path = "";
-  if (generateTest) {
-    path = path + ` "test/**/*.ts"`;
-  }
-  if (generateSample) {
-    path = path + ` "samples-dev/**/*.ts"`;
-  }
-  return path;
-}
-
-function appendPathWhenLint(generateTest?: boolean) {
-  return generateTest ? "test" : "";
-}
-
 function buildExportsForMultiClient(
   codeModel: ModularCodeModel,
   packageInfo: any
@@ -82,450 +58,3 @@ export function getModuleExports(codeModel: ModularCodeModel) {
 
   return buildExportsForMultiClient(codeModel, exports);
 }
-
-// Prepare package info without scripts and devDependencies and dependencies ect
-function initPackageInfo(codeModel: ModularCodeModel) {
-  const { packageDetails, generateTest, flavor } = codeModel.options;
-  const description = packageDetails!.description
-    ? packageDetails!.description
-    : `A generated SDK for ${codeModel.clients[0]?.name}.`;
-  const packageInfo = {
-    name: `${packageDetails!.name}`,
-    "sdk-type": "client",
-    ...(flavor === "azure"
-      ? {
-          author: "Microsoft Corporation"
-        }
-      : {}),
-    version: `${packageDetails!.version}`,
-    description,
-    keywords: [
-      "node",
-      ...(flavor === "azure" ? ["azure", "cloud"] : []),
-      "typescript",
-      "browser",
-      "isomorphic"
-    ],
-    license: "MIT",
-    type: "module",
-    main: "dist/index.js",
-    module: "./dist-esm/src/index.js",
-    types: `./types/${packageDetails!.nameWithoutScope}.d.ts`,
-    exports: {
-      ".": {
-        types: "./types/src/index.d.ts",
-        require: "./dist/index.cjs",
-        import: "./dist-esm/src/index.js"
-      },
-      "./api": {
-        types: "./types/src/api/index.d.ts",
-        import: "./dist-esm/src/api/index.js"
-      },
-      "./models": {
-        types: "./types/src/models/index.d.ts",
-        import: "./dist-esm/src/models/index.js"
-      }
-    },
-    ...(flavor === "azure"
-      ? {
-          repository: "github:Azure/azure-sdk-for-js",
-          bugs: {
-            url: "https://github.com/Azure/azure-sdk-for-js/issues"
-          }
-        }
-      : {}),
-    files: [
-      "dist/",
-      generateTest && flavor === "azure" ? "dist-esm/src/" : "dist-esm/",
-      `types/${packageDetails!.nameWithoutScope}.d.ts`,
-      "README.md",
-      "LICENSE",
-      "review/*"
-    ],
-    engines: {
-      node: ">=18.0.0"
-    }
-  } as any;
-  return packageInfo;
-}
-
-// =========== emit package.json =============
-export function emitPackage(
-  project: Project,
-  metadataDir: string,
-  codeModel: ModularCodeModel
-) {
-  const packageJsonFile = project.createSourceFile(
-    `${metadataDir}/package.json`,
-    "",
-    {
-      overwrite: true
-    }
-  );
-  const packageInfo =
-    codeModel.options?.flavor === "azure"
-      ? emitBrandedPackage(codeModel)
-      : emitNonBrandedPackage(codeModel);
-  packageJsonFile.addStatements(JSON.stringify(packageInfo));
-  return packageJsonFile;
-}
-
-function emitNonBrandedPackage(codeModel: ModularCodeModel) {
-  const runtimeLibVersion =
-    codeModel.runtimeImports?.commonFallback?.version ??
-    "1.0.0-alpha.20240314.2";
-  const packageInfo = {
-    ...initPackageInfo(codeModel),
-    scripts: {
-      "check-format":
-        'prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.ts" "*.{js,json}" ',
-      clean:
-        "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
-      "extract-api":
-        "rimraf review && mkdirp ./review && api-extractor run --local",
-      format:
-        'prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.ts" "*.{js,json}" ',
-      "lint:fix": "echo skipped",
-      lint: "echo skipped",
-      pack: "npm pack 2>&1",
-      test: 'echo "Error: no test specified" && exit 1',
-      build:
-        "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
-      minify:
-        "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js"
-    },
-    sideEffects: false,
-    autoPublish: false,
-    dependencies: {
-      tslib: "^2.2.0",
-      "@typespec/ts-http-runtime": runtimeLibVersion
-    },
-    devDependencies: {
-      "@microsoft/api-extractor": "^7.31.1",
-      "@types/node": "^18.0.0",
-      mkdirp: "^3.0.1",
-      prettier: "^3.1.0",
-      rimraf: "^5.0.0",
-      "source-map-support": "^0.5.9",
-      typescript: "~5.4.5",
-      "@rollup/plugin-commonjs": "^24.0.0",
-      "@rollup/plugin-json": "^6.0.0",
-      "@rollup/plugin-multi-entry": "^6.0.0",
-      "@rollup/plugin-node-resolve": "^13.1.3",
-      rollup: "^2.66.1",
-      "rollup-plugin-sourcemaps": "^0.6.3",
-      "uglify-js": "^3.4.9"
-    }
-  } as any;
-  buildExportsForMultiClient(codeModel, packageInfo);
-  return packageInfo;
-}
-
-function emitBrandedPackage(codeModel: ModularCodeModel) {
-  const hasLRO = hasLROOperation(codeModel, true),
-    hasPaging = hasPagingOperation(codeModel, true);
-  const {
-    azureOutputDirectory,
-    azureSdkForJs,
-    sourceFrom,
-    isModularLibrary,
-    generateTest,
-    generateSample,
-    packageDetails
-  } = codeModel.options;
-  const clientPackageName = packageDetails!.name;
-  let apiRefUrlQueryParameter: string = "";
-  if (packageDetails!.version!.includes("beta")) {
-    apiRefUrlQueryParameter = "?view=azure-node-preview";
-  }
-  const packageInfo = {
-    ...initPackageInfo(codeModel),
-    scripts: {
-      "build:browser": "echo skipped.",
-      "build:node": "echo skipped.",
-      "build:samples": "echo skipped.",
-      "build:test": "echo skipped.",
-      "build:debug": "echo skipped.",
-      "check-format": `prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.ts" "*.{js,json}" ${appendPathWhenFormat(
-        generateTest,
-        generateSample
-      )}`,
-      clean:
-        "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
-      "execute:samples": "echo skipped",
-      "extract-api":
-        "rimraf review && mkdirp ./review && api-extractor run --local",
-      format: `prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore "src/**/*.ts" "*.{js,json}" ${appendPathWhenFormat(
-        generateTest,
-        generateSample
-      )}`,
-      "generate:client":
-        sourceFrom === "Swagger"
-          ? "autorest --typescript swagger/README.md && npm run format"
-          : "echo skipped",
-      "integration-test:browser": "echo skipped",
-      "integration-test:node": "echo skipped",
-      "integration-test": "echo skipped",
-      "lint:fix": `eslint package.json api-extractor.json src ${appendPathWhenLint(
-        generateTest
-      )} --ext .ts --fix --fix-type [problem,suggestion]`,
-      lint: `eslint package.json api-extractor.json src ${appendPathWhenLint(
-        generateTest
-      )} --ext .ts`,
-      pack: "npm pack 2>&1",
-      "test:browser": "echo skipped",
-      "test:node": "echo skipped",
-      test: 'echo "Error: no test specified" && exit 1',
-      "unit-test": "echo skipped",
-      "unit-test:node": "echo skipped",
-      "unit-test:browser": "echo skipped"
-    },
-    sideEffects: false,
-    autoPublish: false,
-    dependencies: {
-      "@azure/core-auth": "^1.6.0",
-      "@azure-rest/core-client": "^1.4.0",
-      "@azure/core-rest-pipeline": "^1.14.0",
-      "@azure/logger": "^1.0.0",
-      tslib: "^2.2.0",
-      ...(hasPaging && {
-        "@azure/core-paging": "^1.5.0"
-      }),
-      ...(hasLRO && {
-        "@azure/core-lro": "^2.5.4",
-        "@azure/abort-controller": "^1.0.0"
-      }),
-      ...(isModularLibrary && {
-        "@azure/core-util": "^1.4.0"
-      })
-    },
-    devDependencies: {
-      "@microsoft/api-extractor": "^7.31.1",
-      autorest: "latest",
-      "@types/node": "^18.0.0",
-      dotenv: "^16.0.0",
-      eslint: "^8.0.0",
-      mkdirp: "^3.0.1",
-      prettier: "^3.1.0",
-      rimraf: "^5.0.0",
-      "source-map-support": "^0.5.9",
-      typescript: "~5.4.5"
-    }
-  } as any;
-
-  if (azureOutputDirectory) {
-    packageInfo["homepage"] =
-      `https://github.com/Azure/azure-sdk-for-js/tree/main/${azureOutputDirectory}/README.md`;
-  }
-
-  if (azureSdkForJs) {
-    packageInfo["//metadata"] = {
-      constantPaths: []
-    };
-    // TODO: remember to put the userAgent path into metadata
-    // Only generate this from Swagger spec
-    if (sourceFrom === "Swagger") {
-      packageInfo["//metadata"].constantPaths.push({
-        path: "swagger/README.md",
-        prefix: "package-version"
-      });
-    }
-    packageInfo.scripts["build"] =
-      "npm run clean && tsc -p . && dev-tool run bundle && mkdirp ./review && dev-tool run extract-api";
-    packageInfo.scripts["build:debug"] =
-      "tsc -p . && dev-tool run bundle && dev-tool run extract-api";
-    packageInfo.scripts["build:browser"] = "tsc -p . && dev-tool run bundle";
-    packageInfo.scripts["build:node"] = "tsc -p . && dev-tool run bundle";
-    packageInfo.scripts["extract-api"] = "dev-tool run extract-api";
-    packageInfo.devDependencies["@azure/dev-tool"] = "^1.0.0";
-    packageInfo.devDependencies["@azure/eslint-plugin-azure-sdk"] = "^3.0.0";
-    // azsdkjs repo use dev-tool to run vendored prettier
-    const dtxPrettierCmd = "dev-tool run vendored ";
-    packageInfo.scripts["check-format"] =
-      dtxPrettierCmd + packageInfo.scripts["check-format"];
-    packageInfo.scripts["format"] =
-      dtxPrettierCmd + packageInfo.scripts["format"];
-    delete packageInfo.devDependencies.prettier;
-  } else {
-    packageInfo.scripts["build"] =
-      "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api";
-    packageInfo.scripts["minify"] =
-      `uglifyjs -c -m --comments --source-map "content='./dist/index.js.map'" -o ./dist/index.min.js ./dist/index.js`;
-    packageInfo.devDependencies["@rollup/plugin-commonjs"] = "^24.0.0";
-    packageInfo.devDependencies["@rollup/plugin-json"] = "^6.0.0";
-    packageInfo.devDependencies["@rollup/plugin-multi-entry"] = "^6.0.0";
-    packageInfo.devDependencies["@rollup/plugin-node-resolve"] = "^13.1.3";
-    packageInfo.devDependencies["rollup"] = "^2.66.1";
-    packageInfo.devDependencies["rollup-plugin-sourcemaps"] = "^0.6.3";
-    packageInfo.devDependencies["uglify-js"] = "^3.4.9";
-  }
-
-  if (generateTest) {
-    packageInfo.module = `./dist-esm/src/index.js`;
-    packageInfo.devDependencies["@azure-tools/test-credential"] = "^1.0.0";
-    packageInfo.devDependencies["@azure/identity"] = "^4.0.1";
-    packageInfo.devDependencies["@azure-tools/test-recorder"] = "^3.0.0";
-    packageInfo.devDependencies["mocha"] = "^10.0.0";
-    packageInfo.devDependencies["@types/mocha"] = "^10.0.0";
-    packageInfo.devDependencies["cross-env"] = "^7.0.2";
-    packageInfo.devDependencies["@types/chai"] = "^4.2.8";
-    packageInfo.devDependencies["chai"] = "^4.2.0";
-    packageInfo.devDependencies["cross-env"] = "^7.0.2";
-    packageInfo.devDependencies["karma-chrome-launcher"] = "^3.0.0";
-    packageInfo.devDependencies["karma-coverage"] = "^2.0.0";
-    packageInfo.devDependencies["karma-env-preprocessor"] = "^0.1.1";
-    packageInfo.devDependencies["karma-firefox-launcher"] = "^2.1.2";
-    packageInfo.devDependencies["karma-junit-reporter"] = "^2.0.1";
-    packageInfo.devDependencies["karma-mocha-reporter"] = "^2.2.5";
-    packageInfo.devDependencies["karma-mocha"] = "^2.0.1";
-    packageInfo.devDependencies["karma-source-map-support"] = "~1.4.0";
-    packageInfo.devDependencies["karma-sourcemap-loader"] = "^0.4.0";
-    packageInfo.devDependencies["karma"] = "^6.2.0";
-    packageInfo.devDependencies["nyc"] = "^15.1.0";
-    packageInfo.devDependencies["source-map-support"] = "^0.5.9";
-    packageInfo.devDependencies["ts-node"] = "^10.0.0";
-    packageInfo.scripts["test"] =
-      "npm run clean && npm run build:test && npm run unit-test";
-    packageInfo.scripts["test:node"] =
-      "npm run clean && npm run build:test && npm run unit-test:node";
-    packageInfo.scripts["test:browser"] =
-      "npm run clean && npm run build:test && npm run unit-test:browser";
-    packageInfo.scripts["build:browser"] =
-      "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1";
-    packageInfo.scripts["build:node"] =
-      "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1";
-    packageInfo.scripts["build:test"] = "tsc -p . && rollup -c 2>&1";
-    packageInfo.scripts["unit-test"] =
-      "npm run unit-test:node && npm run unit-test:browser";
-    packageInfo.scripts["unit-test:node"] =
-      'mocha --full-trace "test/{,!(browser)/**/}*.spec.ts"';
-    packageInfo.scripts["unit-test:browser"] = "karma start --single-run";
-    packageInfo.scripts["integration-test:browser"] =
-      "karma start --single-run";
-    packageInfo.scripts["integration-test:node"] =
-      'nyc mocha --require source-map-support/register.js --timeout 5000000 --full-trace "dist-esm/test/{,!(browser)/**/}*.spec.js"';
-    packageInfo.scripts["integration-test"] =
-      "npm run integration-test:node && npm run integration-test:browser";
-    if (azureSdkForJs) {
-      packageInfo.scripts["build:test"] = "tsc -p . && dev-tool run bundle";
-      packageInfo.scripts["integration-test:browser"] =
-        "dev-tool run test:browser";
-      packageInfo.scripts["unit-test:browser"] = "dev-tool run test:browser";
-      packageInfo.scripts["unit-test:node"] =
-        "dev-tool run test:node-ts-input -- --timeout 1200000 --exclude 'test/**/browser/*.spec.ts' 'test/**/*.spec.ts'";
-      packageInfo.scripts["integration-test:node"] =
-        "dev-tool run test:node-js-input -- --timeout 5000000 'dist-esm/test/**/*.spec.js'";
-    }
-
-    packageInfo["browser"] = {
-      "./dist-esm/test/public/utils/env.js":
-        "./dist-esm/test/public/utils/env.browser.js"
-    };
-
-    packageInfo["mocha"] = {
-      extension: ["ts"],
-      timeout: "1200000",
-      loader: "ts-node/esm"
-    };
-  }
-
-  if (generateSample) {
-    packageInfo["//sampleConfiguration"] = {
-      productName:
-        codeModel.options.serviceInfo?.title ?? codeModel.clients[0]?.name,
-      productSlugs: ["azure"],
-      disableDocsMs: true,
-      apiRefLink: `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
-    };
-    if (azureSdkForJs) {
-      packageInfo.scripts["execute:samples"] =
-        "dev-tool samples run samples-dev";
-    }
-  }
-
-  buildExportsForMultiClient(codeModel, packageInfo);
-  return packageInfo;
-}
-
-// =========== emit tsconfig.json =============
-const modularTsConfigInSDKRepo: Record<string, any> = {
-  extends: "../../../tsconfig.package",
-  compilerOptions: {
-    outDir: "./dist-esm",
-    declarationDir: "./types",
-    module: "NodeNext",
-    moduleResolution: "NodeNext",
-    lib: ["esnext", "dom"],
-    rootDir: "."
-  },
-  "ts-node": { esm: true },
-  include: ["src/**/*.ts"]
-};
-
-const modularTsConfigNotInSDKRepo: Record<string, any> = {
-  compilerOptions: {
-    target: "ES2017",
-    module: "NodeNext",
-    lib: ["esnext", "dom"],
-    declaration: true,
-    declarationMap: true,
-    inlineSources: true,
-    sourceMap: true,
-    importHelpers: true,
-    strict: true,
-    alwaysStrict: true,
-    noUnusedLocals: true,
-    noUnusedParameters: true,
-    noImplicitReturns: true,
-    noFallthroughCasesInSwitch: true,
-    forceConsistentCasingInFileNames: true,
-    moduleResolution: "NodeNext",
-    allowSyntheticDefaultImports: true,
-    esModuleInterop: true,
-    outDir: "./dist-esm",
-    declarationDir: "./types",
-    rootDir: "."
-  },
-  "ts-node": { esm: true },
-  include: ["./src/**/*.ts"]
-};
-
-export function emitTsConfig(
-  project: Project,
-  srcPath: string,
-  codeModel: ModularCodeModel
-) {
-  const tsConfigFile = project.createSourceFile(
-    `${srcPath}/tsconfig.json`,
-    "",
-    {
-      overwrite: true
-    }
-  );
-
-  const { packageDetails, azureSdkForJs } = codeModel.options || {};
-  const { generateTest, generateSample } = codeModel.options || {};
-  const isAzureFlavor = codeModel.options?.flavor === "azure";
-  // Take the undefined as true by default
-  const clientPackageName = packageDetails!.name;
-  const tsConfig = (
-    !isAzureFlavor
-      ? modularTsConfigNotInSDKRepo
-      : azureSdkForJs
-        ? modularTsConfigInSDKRepo
-        : modularTsConfigNotInSDKRepo
-  ) as any;
-
-  if (generateTest && isAzureFlavor) {
-    tsConfig.include.push("./test/**/*.ts");
-  }
-  if (generateSample && isAzureFlavor) {
-    tsConfig.include.push("samples-dev/**/*.ts");
-    tsConfig.compilerOptions["paths"] = {};
-    tsConfig.compilerOptions["paths"][clientPackageName] = ["./src/index"];
-  }
-
-  tsConfigFile.addStatements(JSON.stringify(tsConfig));
-
-  return tsConfigFile;
-}

package/src/modular/buildRootIndex.ts

@@ -29,6 +29,14 @@ export function buildRootIndex(
   }
 
   exportClassicalClient(client, rootIndexFile, subfolder);
+  exportRestoreHelpers(
+    rootIndexFile,
+    project,
+    srcPath,
+    clientName,
+    subfolder,
+    true
+  );
   exportModules(
     rootIndexFile,
     project,
@@ -49,6 +57,40 @@ export function buildRootIndex(
   );
 }
 
+function exportRestoreHelpers(
+  indexFile: SourceFile,
+  project: Project,
+  srcPath: string,
+  clientName: string,
+  subfolder: string = "",
+  isTopLevel: boolean = false
+) {
+  const helperFile = project.getSourceFile(
+    `${srcPath}/${
+      subfolder !== "" ? subfolder + "/" : ""
+    }restorePollerHelpers.ts`
+  );
+  if (!helperFile) {
+    return;
+  }
+  const exported = [...indexFile.getExportedDeclarations().keys()];
+  const namedExports = [...helperFile.getExportedDeclarations().keys()].map(
+    (helper) => {
+      if (exported.indexOf(helper) > -1) {
+        return `${helper} as ${clientName}${helper}`;
+      }
+      return helper;
+    }
+  );
+  const moduleSpecifier = `./${
+    isTopLevel && subfolder !== "" ? subfolder + "/" : ""
+  }restorePollerHelpers.js`;
+  indexFile.addExportDeclaration({
+    moduleSpecifier,
+    namedExports
+  });
+}
+
 function exportClassicalClient(
   client: Client,
   indexFile: SourceFile,
@@ -122,6 +164,13 @@ export function buildSubClientIndexFile(
   }
 
   exportClassicalClient(client, subClientIndexFile, subfolder, true);
+  exportRestoreHelpers(
+    subClientIndexFile,
+    codeModel.project,
+    srcPath,
+    clientName,
+    subfolder
+  );
   exportModules(
     subClientIndexFile,
     codeModel.project,

package/src/modular/buildSubpathIndex.ts

@@ -14,7 +14,8 @@ export function buildSubpathIndexFile(
 ) {
   const { subfolder } = client;
   const srcPath = codeModel.modularOptions.sourceRoot;
-
+  // Skip to export these files because they are used internally.
+  const skipFiles = ["pagingHelpers.ts", "pollingHelpers.ts"];
   const apiFilePattern = join(srcPath, client.subfolder ?? "", subpath);
   const apiFiles = codeModel.project.getSourceFiles().filter((file) => {
     return file
@@ -32,9 +33,8 @@ export function buildSubpathIndexFile(
     if (!options.exportIndex && file.getFilePath().endsWith("index.ts")) {
       continue;
     }
-    // Skip to export pagingHelpers.ts
-    // pagingHelpers.ts is a file that is used internally and is not exported.
-    if (file.getFilePath().endsWith("pagingHelpers.ts")) {
+    // Skip to export these files because they are used internally.
+    if (skipFiles.some((skipFile) => file.getFilePath().endsWith(skipFile))) {
       continue;
     }
     if (file.getFilePath() === indexFile.getFilePath()) {