@azure-tools/typespec-ts 0.53.3 → 0.54.0

package/src/rlc-common/metadata/buildTestConfig.ts

@@ -0,0 +1,72 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { RLCModel } from "../interfaces.js";
+import { getPackageName } from "./utils.js";
+
+function shouldGenerateTestConfig(model: RLCModel): boolean {
+  const isAzureSdkForJs = model.options?.azureSdkForJs ?? false;
+  return !(
+    model.options?.generateMetadata === false ||
+    model.options?.generateTest === false ||
+    isAzureSdkForJs !== true
+  );
+}
+
+/**
+ * Builds config/tsconfig.test.browser.json — extends eng/tsconfigs/test.browser.json
+ */
+export function buildTestBrowserTsConfig(model: RLCModel) {
+  if (!shouldGenerateTestConfig(model)) {
+    return;
+  }
+
+  const name = getPackageName(model);
+
+  return {
+    path: "config/tsconfig.test.browser.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/test.browser.json",
+        compilerOptions: {
+          paths: {
+            [name]: ["../src/index.ts"],
+            [`${name}/*`]: ["../src/*"],
+            "$internal/*": ["../src/*"]
+          }
+        }
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.test.node.json — extends eng/tsconfigs/test.node.json
+ */
+export function buildTestNodeTsConfig(model: RLCModel) {
+  if (!shouldGenerateTestConfig(model)) {
+    return;
+  }
+
+  const name = getPackageName(model);
+
+  return {
+    path: "config/tsconfig.test.node.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/test.node.json",
+        compilerOptions: {
+          paths: {
+            [name]: ["../src/index.ts"],
+            [`${name}/*`]: ["../src/*"],
+            "$internal/*": ["../src/*"]
+          }
+        }
+      },
+      null,
+      2
+    )
+  };
+}

package/src/rlc-common/metadata/buildTsConfig.ts

@@ -0,0 +1,222 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { Project } from "ts-morph";
+import { RLCModel } from "../interfaces.js";
+
+/**
+ * Builds the root tsconfig.json.
+ *
+ * For azureSdkForJs packages, emits project references pointing into the
+ * `config/` subfolder (following the eng/tsconfigs pattern).
+ */
+export function buildTsConfig(model: RLCModel) {
+  const { packageDetails, azureSdkForJs } = model.options || {};
+  const { generateTest, generateSample, generateReactNativeTarget } =
+    model.options || {};
+  const clientPackageName = packageDetails?.name ?? "";
+  const project = new Project();
+
+  let tsConfig: Record<string, any>;
+
+  if (azureSdkForJs) {
+    const references: { path: string }[] = [
+      { path: "./config/tsconfig.src.esm.json" },
+      { path: "./config/tsconfig.src.browser.json" }
+    ];
+
+    if (generateReactNativeTarget) {
+      references.push({ path: "./config/tsconfig.src.react-native.json" });
+    }
+
+    references.push({ path: "./config/tsconfig.src.cjs.json" });
+
+    if (generateTest) {
+      references.push(
+        { path: "./config/tsconfig.test.node.json" },
+        { path: "./config/tsconfig.test.browser.json" }
+      );
+    }
+
+    if (generateSample) {
+      references.push({ path: "./config/tsconfig.samples.json" });
+    }
+
+    if (generateTest) {
+      references.push({ path: "./config/tsconfig.snippets.json" });
+    }
+
+    tsConfig = { references, files: [] };
+  } else {
+    const { options } = model;
+    tsConfig = {
+      compilerOptions: {
+        target: "ES2017",
+        module: options?.moduleKind === "esm" ? "NodeNext" : "es6",
+        lib: [],
+        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: options?.moduleKind === "esm" ? "NodeNext" : "node",
+        allowSyntheticDefaultImports: true,
+        esModuleInterop: true,
+        outDir: options?.moduleKind === "cjs" ? "./dist-esm" : undefined,
+        declarationDir: options?.moduleKind === "cjs" ? "./types" : undefined
+      },
+      include: ["src/**/*.ts"]
+    };
+
+    if (generateTest) {
+      tsConfig["include"].push("test/**/*.ts");
+    }
+    if (generateSample) {
+      tsConfig["include"].push("samples-dev/**/*.ts");
+      tsConfig["compilerOptions"]["paths"] = {};
+      tsConfig["compilerOptions"]["paths"][clientPackageName] = ["./src/index"];
+    }
+  }
+
+  const filePath = "tsconfig.json";
+  const configFile = project.createSourceFile(
+    filePath,
+    JSON.stringify(tsConfig, null, 2),
+    { overwrite: true }
+  );
+  return {
+    path: filePath,
+    content: configFile.getFullText()
+  };
+}
+
+/**
+ * Builds config/tsconfig.src.esm.json — extends eng/tsconfigs/src.esm.json
+ */
+export function buildTsSrcEsmConfig() {
+  return {
+    path: "config/tsconfig.src.esm.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/src.esm.json",
+        include: ["../src/index.ts"]
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.src.browser.json — extends eng/tsconfigs/src.browser.json
+ */
+export function buildTsSrcBrowserConfig() {
+  return {
+    path: "config/tsconfig.src.browser.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/src.browser.json",
+        include: ["../src/index.ts"]
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.src.react-native.json — extends eng/tsconfigs/src.react-native.json
+ */
+export function buildTsSrcReactNativeConfig() {
+  return {
+    path: "config/tsconfig.src.react-native.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/src.react-native.json",
+        include: ["../src/index.ts"]
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.src.cjs.json — extends eng/tsconfigs/src.cjs.json
+ */
+export function buildTsSrcCjsConfig() {
+  return {
+    path: "config/tsconfig.src.cjs.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/src.cjs.json",
+        include: ["../src/index.ts"]
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.samples.json — extends eng/tsconfigs/samples.json
+ */
+export function buildTsSampleConfig(model: RLCModel) {
+  const { packageDetails } = model.options || {};
+  const clientPackageName = packageDetails?.name ?? "";
+  return {
+    path: "config/tsconfig.samples.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/samples.json",
+        compilerOptions: {
+          paths: {
+            [clientPackageName]: ["../dist/esm"]
+          }
+        }
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.lint.json — used by eslint.config.mjs for type-aware linting
+ */
+export function buildTsLintConfig() {
+  return {
+    path: "config/tsconfig.lint.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../tsconfig.json",
+        include: ["../src", "../test"]
+      },
+      null,
+      2
+    )
+  };
+}
+
+/**
+ * Builds config/tsconfig.snippets.json — extends eng/tsconfigs/snippets.json
+ */
+export function buildTsSnippetsConfig() {
+  return {
+    path: "config/tsconfig.snippets.json",
+    content: JSON.stringify(
+      {
+        extends: "../../../../eng/tsconfigs/snippets.json"
+      },
+      null,
+      2
+    )
+  };
+}

package/src/rlc-common/metadata/buildVitestConfig.ts

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { RLCModel } from "../interfaces.js";
+
+const nodeConfig = `import viteConfig from "../../../vitest.shared.config.ts";
+
+export default viteConfig;
+`;
+
+const browserConfig = `export { default } from "../../../eng/vitestconfigs/browser.config.ts";
+`;
+
+export function buildVitestConfig(
+  model: RLCModel,
+  platform: "browser" | "node"
+) {
+  if (
+    model.options?.generateMetadata === false ||
+    model.options?.generateTest === false
+  ) {
+    return;
+  }
+  switch (platform) {
+    case "browser":
+      return {
+        path: "vitest.browser.config.ts",
+        content: browserConfig
+      };
+    case "node":
+      return {
+        path: "vitest.config.ts",
+        content: nodeConfig
+      };
+  }
+}

package/src/rlc-common/metadata/buildWarpConfig.ts

@@ -0,0 +1,94 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { RLCModel } from "../interfaces.js";
+
+export interface WarpConfigOptions {
+  /** Source-level exports, e.g. { ".": "./src/index.ts", "./models": "./src/models/index.ts" } */
+  exports?: Record<string, string>;
+}
+
+/** Default exports included in every warp config. */
+const BASE_EXPORTS: Record<string, string> = {
+  "./package.json": "./package.json",
+  ".": "./src/index.ts"
+};
+
+/** Full inline warp config template with react-native target. */
+const WarpConfigTemplateWithReactNative = `# warp.config.yml — build configuration
+
+exports:
+{{exports}}
+
+targets:
+  - name: browser
+    tsconfig: "./config/tsconfig.src.browser.json"
+
+  - name: react-native
+    tsconfig: "./config/tsconfig.src.react-native.json"
+
+  - name: esm
+    condition: import
+    tsconfig: "./config/tsconfig.src.esm.json"
+
+  - name: commonjs
+    condition: require
+    tsconfig: "./config/tsconfig.src.cjs.json"
+    moduleType: commonjs
+`;
+
+/** Warp config template without react-native target (default). */
+const WarpConfigTemplateDefault = `# warp.config.yml — build configuration
+
+exports:
+{{exports}}
+
+targets:
+  - name: browser
+    tsconfig: "./config/tsconfig.src.browser.json"
+
+  - name: esm
+    condition: import
+    tsconfig: "./config/tsconfig.src.esm.json"
+
+  - name: commonjs
+    condition: require
+    tsconfig: "./config/tsconfig.src.cjs.json"
+    moduleType: commonjs
+`;
+
+/**
+ * Builds a self-contained warp.config.yml file.
+ *
+ * Emits a full inline config with all exports and targets.
+ * Polyfill resolution (browser/react-native file substitution) is handled
+ * via package.json `imports` subpath imports (#platform/*).
+ *
+ * By default, react-native target is NOT included. Set `generateReactNativeTarget: true`
+ * in options to include it.
+ */
+export function buildWarpConfig(
+  model: RLCModel,
+  { exports }: WarpConfigOptions = {}
+) {
+  if (model.options?.moduleKind !== "esm") {
+    return;
+  }
+
+  const allExports: Record<string, string> = {
+    ...BASE_EXPORTS,
+    ...exports
+  };
+
+  const exportsContent = Object.entries(allExports)
+    .map(([key, value]) => `  ${JSON.stringify(key)}: ${JSON.stringify(value)}`)
+    .join("\n");
+
+  const template = model.options?.generateReactNativeTarget
+    ? WarpConfigTemplateWithReactNative
+    : WarpConfigTemplateDefault;
+
+  const content = template.replace("{{exports}}", exportsContent);
+
+  return { path: "warp.config.yml", content };
+}

package/src/rlc-common/metadata/packageJson/azurePackageCommon.ts

@@ -0,0 +1,161 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import {
+  PackageCommonInfoConfig,
+  getCommonPackageDevDependencies
+} from "./packageCommon.js";
+
+export interface AzurePackageInfoConfig extends PackageCommonInfoConfig {
+  hasLro: boolean;
+  specSource: "Swagger" | "TypeSpec";
+}
+
+/**
+ * Build the common package.json config for an Azure package.
+ */
+export function getAzureCommonPackageInfo(config: AzurePackageInfoConfig) {
+  return {
+    keywords: ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
+    author: "Microsoft Corporation",
+    license: "MIT",
+    ...getAzureCjsCommonInfo(config),
+    ...getAzureEsmCommonInfo(config)
+  };
+}
+
+/**
+ * Builds the common dependencies for an Azure package.
+ */
+export function getAzurePackageDependencies({
+  hasLro,
+  specSource,
+  dependencies
+}: AzurePackageInfoConfig) {
+  let azureDependencies: Record<string, string> = {
+    ...dependencies,
+    "@azure-rest/core-client": specSource === "Swagger" ? "^1.4.0" : "^2.3.1",
+    "@azure/core-auth": "^1.6.0",
+    "@azure/core-rest-pipeline": "^1.5.0",
+    "@azure/logger": "^1.0.0",
+    tslib: "^2.6.2"
+  };
+
+  if (hasLro) {
+    azureDependencies = {
+      ...azureDependencies,
+      "@azure/core-lro": "^3.1.0",
+      "@azure/abort-controller": "^2.1.2"
+    };
+  }
+
+  return azureDependencies;
+}
+
+function getAzureCjsCommonInfo({
+  withTests,
+  withSamples,
+  name,
+  nameWithoutScope,
+  moduleKind
+}: AzurePackageInfoConfig) {
+  if (moduleKind !== "cjs") {
+    return {};
+  }
+
+  return {
+    files: [
+      "dist/",
+      "!dist/**/*.d.*ts.map",
+      withTests || withSamples ? "dist-esm/src/" : "dist-esm/",
+      `types/${nameWithoutScope ?? name}.d.ts`,
+      "README.md",
+      "LICENSE"
+    ]
+  };
+}
+
+function getAzureEsmCommonInfo({ moduleKind }: AzurePackageInfoConfig) {
+  if (moduleKind !== "esm") {
+    return {};
+  }
+  return {
+    files: ["dist/", "!dist/**/*.d.*ts.map", "README.md", "LICENSE"]
+  };
+}
+
+function getAzurePackageCjsDevDependencies({
+  moduleKind,
+  withTests
+}: AzurePackageInfoConfig) {
+  if (moduleKind !== "cjs") {
+    return {};
+  }
+  const testDevDependencies = {
+    "@azure-tools/test-credential": "^1.1.0",
+    "@azure-tools/test-recorder": "^3.0.0",
+    nyc: "^15.1.0",
+    mocha: "^11.0.2",
+    "@types/mocha": "^10.0.0",
+    "@types/chai": "^4.2.8",
+    chai: "^4.2.0",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^2.1.3",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-mocha": "^2.0.1",
+    "karma-source-map-support": "~1.4.0",
+    "karma-sourcemap-loader": "^0.4.0",
+    karma: "^6.2.0"
+  };
+
+  return {
+    ...(withTests && testDevDependencies),
+    "source-map-support": "^0.5.9"
+  };
+}
+
+function getAzurePackageEsmDevDependencies({
+  moduleKind,
+  withTests
+}: AzurePackageInfoConfig) {
+  if (moduleKind !== "esm") {
+    return {};
+  }
+
+  let devDependencies: Record<string, string> = {};
+
+  if (withTests) {
+    devDependencies = {
+      ...devDependencies,
+      "@vitest/browser-playwright": "^4.0.6",
+      "@vitest/coverage-istanbul": "^4.0.6",
+      playwright: "^1.41.2",
+      vitest: "^4.0.6",
+      "@azure-tools/test-credential": "^2.0.0",
+      "@azure-tools/test-recorder": "^4.0.0"
+    };
+  }
+
+  return devDependencies;
+}
+
+export function getAzurePackageDevDependencies(config: AzurePackageInfoConfig) {
+  const esmDevDependencies = getAzurePackageEsmDevDependencies(config);
+  const cjsDevDependencies = getAzurePackageCjsDevDependencies(config);
+
+  const testDevDependencies = {
+    "@azure/identity": "^4.2.1"
+  };
+
+  return {
+    dotenv: "^16.0.0",
+    ...getCommonPackageDevDependencies(config),
+    ...(config.withTests && testDevDependencies),
+    ...(config.specSource === "Swagger" && { autorest: "latest" }),
+    ...esmDevDependencies,
+    ...cjsDevDependencies
+  };
+}