@azure-tools/typespec-ts 0.53.3 → 0.54.0

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

@@ -0,0 +1,250 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { NameType, normalizeName } from "../helpers/nameUtils.js";
+import { hasPollingOperations } from "../helpers/operationHelpers.js";
+import {
+  isAzureMonorepoPackage,
+  isAzurePackage,
+  isAzureStandalonePackage
+} from "../helpers/packageUtil.js";
+import {
+  PackageCommonInfoConfig,
+  getTshyConfig,
+  resolveWarpExports
+} from "./packageJson/packageCommon.js";
+import { Project, SourceFile } from "ts-morph";
+import { RLCModel } from "../interfaces.js";
+import { buildAzureMonorepoPackage } from "./packageJson/buildAzureMonorepoPackage.js";
+import { buildAzureStandalonePackage } from "./packageJson/buildAzureStandalonePackage.js";
+import { buildFlavorlessPackage } from "./packageJson/buildFlavorlessPackage.js";
+import { getRelativePartFromSrcPath } from "../helpers/pathUtils.js";
+import { getPackageName } from "./utils.js";
+
+interface PackageFileOptions {
+  exports?: Record<string, any>;
+  dependencies?: Record<string, string>;
+  clientContextPaths?: string[];
+}
+
+export function buildPackageFile(
+  model: RLCModel,
+  { exports, dependencies, clientContextPaths }: PackageFileOptions = {}
+) {
+  const config: PackageCommonInfoConfig = {
+    description: getDescription(model),
+    moduleKind: model.options?.moduleKind ?? "esm",
+    name: getPackageName(model),
+    version: getPackageVersion(model),
+    withSamples: model.options?.generateSample === true,
+    withTests: model.options?.generateTest === true,
+    nameWithoutScope: model.options?.packageDetails?.nameWithoutScope,
+    exports,
+    azureArm: model.options?.azureArm,
+    isModularLibrary: model.options?.isModularLibrary ?? false,
+    azureSdkForJs: model.options?.azureSdkForJs,
+    generateReactNativeTarget: model.options?.generateReactNativeTarget
+  };
+
+  let packageInfo: Record<string, any> = buildFlavorlessPackage(config);
+
+  const extendedConfig = {
+    ...config,
+    clientFilePaths: [getClientFilePath(model)],
+    hasLro: hasPollingOperations(model),
+    monorepoPackageDirectory: model.options?.azureOutputDirectory,
+    specSource: model.options?.sourceFrom ?? "TypeSpec",
+    dependencies,
+    clientContextPaths
+  };
+
+  if (isAzureMonorepoPackage(model)) {
+    packageInfo = buildAzureMonorepoPackage(extendedConfig);
+  }
+
+  if (isAzureStandalonePackage(model)) {
+    packageInfo = buildAzureStandalonePackage(extendedConfig);
+  }
+
+  const project = new Project();
+  const filePath = "package.json";
+
+  if (!packageInfo) {
+    return;
+  }
+
+  const packageFile = project.createSourceFile(
+    filePath,
+    JSON.stringify(packageInfo, null, 2),
+    {
+      overwrite: true
+    }
+  );
+  return {
+    path: filePath,
+    content: packageFile.getFullText()
+  };
+}
+
+/**
+ * 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 function updatePackageFile(
+  model: RLCModel,
+  existingFilePathOrContent: string | Record<string, any>,
+  { exports, clientContextPaths }: PackageFileOptions = {}
+) {
+  const hasLro = hasPollingOperations(model);
+  const isAzure = isAzurePackage(model);
+  const needsLroUpdate = isAzure && hasLro;
+  const needsExportsUpdate = exports;
+  const needsConstantPathsUpdate =
+    clientContextPaths && clientContextPaths.length > 0;
+  const needsPlatformImportsUpdate =
+    model.options?.azureSdkForJs && model.options?.moduleKind === "esm";
+
+  let packageInfo;
+  if (typeof existingFilePathOrContent === "string") {
+    let packageFile: SourceFile;
+    try {
+      const project = new Project();
+      packageFile = project.addSourceFileAtPath(existingFilePathOrContent);
+    } catch (_e) {
+      // If the file doesn't exist, we don't need to update it.
+      return;
+    }
+    packageInfo = JSON.parse(packageFile.getFullText());
+  } else {
+    packageInfo = existingFilePathOrContent;
+  }
+
+  // Migrate AutoRest-specific dependency names and versions to their TypeSpec equivalents.
+  const deps: Record<string, string> = { ...(packageInfo.dependencies ?? {}) };
+  let needsCoreClientUpdate = false;
+
+  // @azure/core-client is AutoRest-only; TypeSpec uses @azure-rest/core-client.
+  if ("@azure/core-client" in deps) {
+    needsCoreClientUpdate = true;
+  }
+
+  // Early return if nothing needs to be updated
+  if (
+    !needsLroUpdate &&
+    !needsExportsUpdate &&
+    !needsConstantPathsUpdate &&
+    !needsPlatformImportsUpdate &&
+    !needsCoreClientUpdate
+  ) {
+    return;
+  }
+
+  // Ensure warp packages have #platform/* imports for polyfill resolution.
+  // The `react-native` condition is only added when explicitly opted in via
+  // `generateReactNativeTarget`, matching the fresh-generation path in
+  // `getEsmEntrypointInformation` (packageCommon.ts).
+  if (needsPlatformImportsUpdate) {
+    const platformImports: Record<string, string> = {
+      browser: "./src/*-browser.mts",
+      default: "./src/*.ts"
+    };
+    if (model.options?.generateReactNativeTarget) {
+      // Insert `react-native` before `default` so Node's conditional
+      // resolution order matches the fresh-generation output.
+      packageInfo.imports = {
+        "#platform/*": {
+          browser: platformImports["browser"],
+          "react-native": "./src/*-react-native.mts",
+          default: platformImports["default"]
+        }
+      };
+    } else {
+      packageInfo.imports = {
+        "#platform/*": platformImports
+      };
+    }
+  }
+
+  // Update exports based on build system (warp for monorepo, tshy for others)
+  if (needsExportsUpdate) {
+    if (model.options?.azureSdkForJs) {
+      // Warp: update resolved exports in package.json
+      packageInfo.exports = resolveWarpExports(
+        exports,
+        model.options?.generateReactNativeTarget
+      );
+    } else if (packageInfo.tshy) {
+      // Tshy: update tshy.exports in package.json
+      const newTshy = getTshyConfig({
+        exports,
+        azureSdkForJs: model.options?.azureSdkForJs,
+        generateReactNativeTarget: model.options?.generateReactNativeTarget
+      } as PackageCommonInfoConfig);
+      packageInfo.tshy["exports"] = newTshy["exports"];
+    }
+  }
+
+  // Update Core Client dependency
+  if (needsCoreClientUpdate) {
+    delete deps["@azure/core-client"];
+    if (!("@azure-rest/core-client" in deps)) {
+      deps["@azure-rest/core-client"] = "^2.3.1";
+    }
+    packageInfo.dependencies = deps;
+  }
+
+  // Update LRO dependencies for Azure packages
+  if (needsLroUpdate) {
+    packageInfo.dependencies = {
+      ...packageInfo.dependencies,
+      "@azure/core-lro": "^3.1.0",
+      "@azure/abort-controller": "^2.1.2"
+    };
+  }
+
+  // Update constantPaths metadata for Azure packages
+  if (needsConstantPathsUpdate && isAzure && packageInfo["//metadata"]) {
+    const metadata = packageInfo["//metadata"];
+    // Filter out existing userAgentInfo entries
+    const nonUserAgentPaths = (metadata.constantPaths || []).filter(
+      (item: any) => item.prefix !== "userAgentInfo"
+    );
+    // Add new userAgentInfo entries from clientContextPaths
+    const newUserAgentPaths = clientContextPaths!.map((path) => ({
+      path: path,
+      prefix: "userAgentInfo"
+    }));
+    metadata.constantPaths = [...nonUserAgentPaths, ...newUserAgentPaths];
+  }
+
+  return {
+    path: "package.json",
+    content: JSON.stringify(packageInfo, null, 2)
+  };
+}
+
+function getPackageVersion(model: RLCModel): string {
+  return model.options?.packageDetails?.version ?? "1.0.0-beta.1";
+}
+
+function getDescription(model: RLCModel): string {
+  const description = model.options?.packageDetails?.description;
+  if (!description) {
+    return `A generated SDK for ${model.libraryName}.`;
+  }
+  return description;
+}
+
+function getClientFilePath(model: RLCModel) {
+  const { srcPath } = model;
+  const sdkReletivePart = getRelativePartFromSrcPath(srcPath);
+  const clientFilename = normalizeName(model.libraryName, NameType.File);
+  return sdkReletivePart
+    ? `src/${sdkReletivePart}/${clientFilename}.ts`
+    : `src/${clientFilename}.ts`;
+}