@azure-tools/rlc-common 0.52.3 → 0.53.0

package/test/integration/packageJson.spec.ts

@@ -132,10 +132,12 @@ describe("Package file generation", () => {
       const packageFile = JSON.parse(packageFileContent?.content ?? "{}");
 
       expect(packageFile).to.have.property("sdk-type", "client");
-      expect(packageFile).to.have.property(
-        "repository",
-        "github:Azure/azure-sdk-for-js"
-      );
+      expect(packageFile).to.have.property("repository");
+      expect(packageFile.repository).to.deep.equal({
+        type: "git",
+        url: "git+https://github.com/Azure/azure-sdk-for-js",
+        directory: "test"
+      });
       expect(packageFile).to.have.property("bugs");
       expect(packageFile.bugs).to.have.property(
         "url",
@@ -151,6 +153,21 @@ describe("Package file generation", () => {
       );
     });
 
+    it("should set a default repository directory when package directory is unavailable", () => {
+      const model = createMockModel({
+        ...baseConfig
+      });
+      const packageFileContent = buildPackageFile(model);
+      const packageFile = JSON.parse(packageFileContent?.content ?? "{}");
+
+      expect(packageFile).to.have.property("repository");
+      expect(packageFile.repository).to.deep.equal({
+        type: "git",
+        url: "git+https://github.com/Azure/azure-sdk-for-js",
+        directory: "sdk/"
+      });
+    });
+
     it("should have monorepo metadata", () => {
       const model = createMockModel({ ...baseConfig });
       const packageFileContent = buildPackageFile(model);
@@ -396,7 +413,7 @@ describe("Package file generation", () => {
 
       expect(packageFile.scripts).to.have.property(
         "build:samples",
-        "tsc -p tsconfig.samples.json && dev-tool samples publish -f"
+        "tsc -p config/tsconfig.samples.json && dev-tool samples publish -f"
       );
     });
 
@@ -411,7 +428,7 @@ describe("Package file generation", () => {
 
       expect(packageFile.scripts).to.have.property(
         "build:samples",
-        "tsc -p tsconfig.samples.json"
+        "tsc -p config/tsconfig.samples.json"
       );
     });
 
@@ -901,8 +918,12 @@ describe("Package file generation", () => {
         clientContextPaths: []
       });
 
-      // Should return undefined when nothing needs to be updated
-      expect(packageFileContent).to.be.undefined;
+      // Should still return a result (imports are added for warp packages),
+      // but constantPaths should remain unchanged
+      const packageInfo = JSON.parse(packageFileContent!.content);
+      expect(packageInfo["//metadata"].constantPaths).to.deep.equal([
+        { path: "src/old-path.ts", prefix: "userAgentInfo" }
+      ]);
     });
 
     it("should not update constantPaths for non-Azure packages", () => {
@@ -932,6 +953,131 @@ describe("Package file generation", () => {
         { path: "src/old-path.ts", prefix: "userAgentInfo" }
       ]);
     });
+
+    it("should migrate @azure/core-client to @azure-rest/core-client", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        flavor: "azure",
+        isMonorepo: true,
+        hasLro: false
+      });
+
+      const initialPackageInfo = {
+        name: "@azure/test-package",
+        version: "1.0.0",
+        dependencies: {
+          "@azure/core-client": "^1.9.3",
+          "@azure/core-rest-pipeline": "^1.19.1",
+          "tslib": "^2.6.2"
+        }
+      };
+
+      const packageFileContent = updatePackageFile(model, initialPackageInfo);
+      expect(packageFileContent).to.not.be.undefined;
+      const packageFile = JSON.parse(packageFileContent?.content ?? "{}");
+
+      expect(packageFile.dependencies).to.not.have.property("@azure/core-client");
+      expect(packageFile.dependencies).to.have.property(
+        "@azure-rest/core-client",
+        "^2.3.1"
+      );
+      expect(packageFile.dependencies).to.have.property(
+        "@azure/core-rest-pipeline",
+        "^1.19.1"
+      );
+    });
+
+    it("should not add duplicate @azure-rest/core-client if already present", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        flavor: "azure",
+        isMonorepo: true,
+        hasLro: false
+      });
+
+      const initialPackageInfo = {
+        name: "@azure/test-package",
+        version: "1.0.0",
+        dependencies: {
+          "@azure/core-client": "^1.9.3",
+          "@azure-rest/core-client": "^2.0.0",
+          "tslib": "^2.6.2"
+        }
+      };
+
+      const packageFileContent = updatePackageFile(model, initialPackageInfo);
+      expect(packageFileContent).to.not.be.undefined;
+      const packageFile = JSON.parse(packageFileContent?.content ?? "{}");
+
+      expect(packageFile.dependencies).to.not.have.property("@azure/core-client");
+      // Existing version should be preserved, not overwritten
+      expect(packageFile.dependencies).to.have.property(
+        "@azure-rest/core-client",
+        "^2.0.0"
+      );
+    });
+
+    it("should only add platform imports when no @azure/core-client and no other update triggers", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        flavor: "azure",
+        isMonorepo: true,
+        hasLro: false
+      });
+
+      const initialPackageInfo = {
+        name: "@azure/test-package",
+        version: "1.0.0",
+        dependencies: {
+          "@azure-rest/core-client": "^2.3.1",
+          "@azure/core-rest-pipeline": "^1.20.0",
+          "tslib": "^2.8.1"
+        }
+      };
+
+      const packageFileContent = updatePackageFile(model, initialPackageInfo);
+      expect(packageFileContent).to.not.be.undefined;
+      const packageFile = JSON.parse(packageFileContent?.content ?? "{}");
+
+      // Dependencies should remain unchanged
+      expect(packageFile.dependencies).to.not.have.property("@azure/core-client");
+      expect(packageFile.dependencies).to.have.property(
+        "@azure-rest/core-client",
+        "^2.3.1"
+      );
+
+      // Platform imports should be added for Azure monorepo ESM packages
+      expect(packageFile).to.have.property("imports");
+      expect(packageFile.imports).to.have.property("#platform/*.js");
+    });
+
+    it("should migrate @azure/core-client for non-monorepo Azure packages", () => {
+      const model = createMockModel({
+        moduleKind: "cjs",
+        flavor: "azure",
+        isMonorepo: false,
+        hasLro: false
+      });
+
+      const initialPackageInfo = {
+        name: "@azure/test-package",
+        version: "1.0.0",
+        dependencies: {
+          "@azure/core-client": "^1.9.3",
+          "tslib": "^2.6.2"
+        }
+      };
+
+      const packageFileContent = updatePackageFile(model, initialPackageInfo);
+      expect(packageFileContent).to.not.be.undefined;
+      const packageFile = JSON.parse(packageFileContent?.content ?? "{}");
+
+      expect(packageFile.dependencies).to.not.have.property("@azure/core-client");
+      expect(packageFile.dependencies).to.have.property(
+        "@azure-rest/core-client",
+        "^2.3.1"
+      );
+    });
   });
 
   describe("Flavorless lib", () => {

package/test/integration/vitestConfig.spec.ts

@@ -14,7 +14,7 @@ describe("vitest.config", () => {
 
       const result = buildVitestConfig(model, "browser");
       expect(result?.content).includes(
-        `export default viteConfig;`
+        `export { default } from "../../../eng/vitestconfigs/browser.config.ts";`
       );
     });
   });

package/test/integration/warpConfig.spec.ts

@@ -0,0 +1,97 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { describe, it, expect } from "vitest";
+
+import { buildWarpConfig } from "../../src/metadata/buildWarpConfig.js";
+import { createMockModel } from "./mockHelper.js";
+
+describe("warp.config.yml generation", () => {
+  describe("azure monorepo", () => {
+    it("should generate a self-contained config without polyfillSuffix", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        isMonorepo: true,
+        flavor: "azure"
+      });
+
+      const result = buildWarpConfig(model);
+      expect(result).toBeDefined();
+      expect(result!.path).toBe("warp.config.yml");
+      expect(result!.content).not.toContain("extends:");
+      // polyfillSuffix is no longer used — polyfill resolution is handled
+      // via package.json subpath imports instead.
+      expect(result!.content).not.toContain("polyfillSuffix");
+      // All four targets with tsconfig paths
+      expect(result!.content).toContain("name: browser");
+      expect(result!.content).toContain("name: react-native");
+      expect(result!.content).toContain("name: esm");
+      expect(result!.content).toContain("name: commonjs");
+      expect(result!.content).toContain("tsconfig:");
+      // Base exports should be included
+      expect(result!.content).toContain('"./package.json"');
+      expect(result!.content).toContain('"."');
+    });
+
+    it("should include custom exports alongside base exports", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        isMonorepo: true,
+        flavor: "azure"
+      });
+
+      const result = buildWarpConfig(model, {
+        exports: {
+          ".": "./src/index.ts",
+          "./models": "./src/models/index.ts"
+        }
+      });
+      expect(result).toBeDefined();
+      expect(result!.content).not.toContain("extends:");
+      expect(result!.content).not.toContain("polyfillSuffix");
+      expect(result!.content).toContain("./models");
+      expect(result!.content).toContain("./package.json");
+      expect(result!.content).toContain("moduleType: commonjs");
+    });
+
+    it("should not return config for non-esm module kind", () => {
+      const model = createMockModel({
+        moduleKind: "cjs",
+        isMonorepo: true,
+        flavor: "azure"
+      });
+
+      const result = buildWarpConfig(model);
+      expect(result).toBeUndefined();
+    });
+  });
+
+  describe("non-monorepo", () => {
+    it("should generate a self-contained config without polyfillSuffix", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        isMonorepo: false
+      });
+
+      const result = buildWarpConfig(model);
+      expect(result).toBeDefined();
+      expect(result!.path).toBe("warp.config.yml");
+      expect(result!.content).not.toContain("extends:");
+      expect(result!.content).not.toContain("polyfillSuffix");
+    });
+
+    it("should include all target definitions", () => {
+      const model = createMockModel({
+        moduleKind: "esm",
+        isMonorepo: false
+      });
+
+      const result = buildWarpConfig(model);
+      expect(result).toBeDefined();
+      expect(result!.content).toContain("name: browser");
+      expect(result!.content).toContain("name: react-native");
+      expect(result!.content).toContain("name: esm");
+      expect(result!.content).toContain("name: commonjs");
+    });
+  });
+});

package/types/metadata/buildPackageFile.d.ts

@@ -9,8 +9,13 @@ export declare function buildPackageFile(model: RLCModel, { exports, dependencie
     content: string;
 } | undefined;
 /**
- * Automatically updates the package.json with correct paging and LRO dependencies for Azure SDK.
- * Also updates tshy.exports if provided.
+ * Automatically updates the package.json for an existing Azure SDK package.
+ * - Migrates `@azure/core-client` → `@azure-rest/core-client` when found in dependencies.
+ * - Updates `@azure/core-lro` from `^2.x` to `^3.1.0`.
+ * - Adds LRO dependencies (`@azure/core-lro`, `@azure/abort-controller`) when the package has
+ *   polling operations (for non-monorepo Azure packages).
+ * - Updates exports (tshy or warp) when `exports` is provided.
+ * - Updates `//metadata.constantPaths` when `clientContextPaths` is provided.
  */
 export declare function updatePackageFile(model: RLCModel, existingFilePathOrContent: string | Record<string, any>, { exports, clientContextPaths }?: PackageFileOptions): {
     path: string;

package/types/metadata/buildTestConfig.d.ts

@@ -1,13 +1,15 @@
 import { RLCModel } from "../interfaces.js";
+/**
+ * Builds config/tsconfig.test.browser.json — extends eng/tsconfigs/test.browser.json
+ */
 export declare function buildTestBrowserTsConfig(model: RLCModel): {
     path: string;
     content: string;
 } | undefined;
+/**
+ * Builds config/tsconfig.test.node.json — extends eng/tsconfigs/test.node.json
+ */
 export declare function buildTestNodeTsConfig(model: RLCModel): {
     path: string;
     content: string;
 } | undefined;
-export declare function buildTestMainTsConfig(model: RLCModel): {
-    path: string;
-    content: string;
-} | undefined;

package/types/metadata/buildTsConfig.d.ts

@@ -1,20 +1,52 @@
 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 declare function buildTsConfig(model: RLCModel): {
     path: string;
     content: string;
 };
-export declare function buildTsSrcConfig(): {
+/**
+ * Builds config/tsconfig.src.esm.json — extends eng/tsconfigs/src.esm.json
+ */
+export declare function buildTsSrcEsmConfig(): {
     path: string;
     content: string;
 };
-export declare function buildTsSampleConfig(model: RLCModel): {
+/**
+ * Builds config/tsconfig.src.browser.json — extends eng/tsconfigs/src.browser.json
+ */
+export declare function buildTsSrcBrowserConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.src.react-native.json — extends eng/tsconfigs/src.react-native.json
+ */
+export declare function buildTsSrcReactNativeConfig(): {
     path: string;
     content: string;
 };
-export declare function buildTsTestConfig(): {
+/**
+ * Builds config/tsconfig.src.cjs.json — extends eng/tsconfigs/src.cjs.json
+ */
+export declare function buildTsSrcCjsConfig(): {
+    path: string;
+    content: string;
+};
+/**
+ * Builds config/tsconfig.samples.json — extends eng/tsconfigs/samples.json
+ */
+export declare function buildTsSampleConfig(model: RLCModel): {
     path: string;
     content: string;
 };
+/**
+ * Builds config/tsconfig.snippets.json — extends eng/tsconfigs/snippets.json
+ */
 export declare function buildTsSnippetsConfig(): {
     path: string;
     content: string;

package/types/metadata/buildVitestConfig.d.ts

@@ -1,5 +1,5 @@
 import { RLCModel } from "../interfaces.js";
-export declare function buildVitestConfig(model: RLCModel, platform: "browser" | "node" | "esm"): {
+export declare function buildVitestConfig(model: RLCModel, platform: "browser" | "node"): {
     path: string;
     content: string;
 } | undefined;

package/types/metadata/buildWarpConfig.d.ts

@@ -3,10 +3,14 @@ export interface WarpConfigOptions {
     /** Source-level exports, e.g. { ".": "./src/index.ts", "./models": "./src/models/index.ts" } */
     exports?: Record<string, string>;
 }
-export declare const WarpConfigTemplate = "# warp.config.yml \u2014 build configuration\n\nexports:\n{{exports}}\n\ntargets:\n  - name: browser\n    tsconfig: \"../../../tsconfig.src.browser.json\"\n    polyfillSuffix: \"-browser\"\n\n  - name: react-native\n    tsconfig: \"../../../tsconfig.src.react-native.json\"\n    polyfillSuffix: \"-react-native\"\n\n  - name: esm\n    condition: import\n    tsconfig: \"../../../tsconfig.src.esm.json\"\n\n  - name: commonjs\n    condition: require\n    tsconfig: \"../../../tsconfig.src.cjs.json\"\n";
+/** Full inline warp config template. */
+export declare const WarpConfigTemplate = "# warp.config.yml \u2014 build configuration\n\nexports:\n{{exports}}\n\ntargets:\n  - name: browser\n    tsconfig: \"./config/tsconfig.src.browser.json\"\n\n  - name: react-native\n    tsconfig: \"./config/tsconfig.src.react-native.json\"\n\n  - name: esm\n    condition: import\n    tsconfig: \"./config/tsconfig.src.esm.json\"\n\n  - name: commonjs\n    condition: require\n    tsconfig: \"./config/tsconfig.src.cjs.json\"\n    moduleType: commonjs\n";
 /**
- * Builds a warp.config.yml file for Azure SDK monorepo packages.
- * Only generated when azureSdkForJs is true.
+ * 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/*).
  */
 export declare function buildWarpConfig(model: RLCModel, { exports }?: WarpConfigOptions): {
     path: string;

package/types/metadata/packageJson/packageCommon.d.ts

@@ -34,6 +34,13 @@ export declare function getPackageCommonInfo(config: PackageCommonInfoConfig): {
     types: string;
     browser: string;
     "react-native": string;
+    imports: {
+        "#platform/*.js": {
+            browser: string;
+            "react-native": string;
+            default: string;
+        };
+    };
     exports: Record<string, any>;
     tshy?: undefined;
     name: string;
@@ -52,6 +59,7 @@ export declare function getPackageCommonInfo(config: PackageCommonInfoConfig): {
     main?: string | undefined;
     module?: string | undefined;
     types?: string | undefined;
+    imports?: undefined;
     exports?: undefined;
     name: string;
     version: string;