@azure-tools/typespec-ts 0.55.0-dev.1 → 0.55.0-dev.10

package/src/rlc-common/interfaces.ts

@@ -39,7 +39,6 @@ export type ImportType =
   | "coreUtil"
   | "coreLogger"
   // this is a fallback import if above imports are not available
-  // mainly used in non-branded scope
   | "commonFallback"
   /**azure specific imports */
   | "azureEslintPlugin"
@@ -191,18 +190,11 @@ export interface OperationLroDetail {
   precedence?: number;
 }
 
-/**
- * Flavor of the package to generate. If "azure", an Azure-branded package should be generated. If left undefined, a package without Azure branding will be generated.
- */
-export type PackageFlavor = "azure" | undefined;
-
 export interface RLCOptions {
   /**
    * Whether to include response headers in the generated response types. If true, the generated response types will include headers as properties.
    */
   includeHeadersInResponse?: boolean;
-  includeShortcuts?: boolean;
-  multiClient?: boolean;
   batch?: any[];
   packageDetails?: PackageDetails;
   addCredentials?: boolean;
@@ -230,19 +222,11 @@ export interface RLCOptions {
    */
   generateTest?: boolean;
   generateSample?: boolean;
-  azureSdkForJs?: boolean;
   azureOutputDirectory?: string;
   isTypeSpecTest?: boolean;
-  title?: string;
-  dependencyInfo?: DependencyInfo;
-  productDocLink?: string;
   serviceInfo?: ServiceInfo;
   azureArm?: boolean;
-  sourceFrom?: "TypeSpec" | "Swagger";
-  isModularLibrary?: boolean;
-  moduleKind?: "esm" | "cjs";
   enableOperationGroup?: boolean;
-  flavor?: PackageFlavor;
   enableModelNamespace?: boolean;
   hierarchyClient?: boolean;
   compatibilityMode?: boolean;
@@ -259,7 +243,7 @@ export interface RLCOptions {
   /**
    * When set to true, non-model return types (arrays, scalars, enums, bytes with binary content type)
    * will be wrapped in an XxxResponse type to maintain backward compatibility with HLC.
-   * This option defaults to true for Azure flavor and to false otherwise, unless explicitly set.
+   * This option defaults to true unless explicitly set.
    */
   wrapNonModelReturn?: boolean;
   /**
@@ -275,7 +259,7 @@ export interface RLCOptions {
   treatUnknownAsRecord?: boolean;
   /**
    * When set to true, generates React Native build targets (tsconfig, warp target, package.json exports).
-   * Defaults to false. Only applicable when azureSdkForJs is true.
+   * Defaults to false.
    */
   generateReactNativeTarget?: boolean;
 }
@@ -285,11 +269,6 @@ export interface ServiceInfo {
   description?: string;
 }
 
-export interface DependencyInfo {
-  link: string;
-  description: string;
-}
-
 export interface File {
   path: string;
   content: string;

package/src/rlc-common/metadata/build-api-extractor-config.ts

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { Project } from "ts-morph";
+import { RLCModel } from "../interfaces.js";
+
+export function buildApiExtractorConfig(_model: RLCModel) {
+  const project = new Project({ useInMemoryFileSystem: true });
+
+  const config = {
+    extends: "../../../api-extractor-base.json",
+  };
+
+  const filePath = "api-extractor.json";
+  const configFile = project.createSourceFile(filePath, JSON.stringify(config), {
+    overwrite: true,
+  });
+  return {
+    path: filePath,
+    content: configFile.getFullText(),
+  };
+}

package/src/rlc-common/metadata/build-es-lint-config.ts

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { Project } from "ts-morph";
+import { RLCModel } from "../interfaces.js";
+
+const esLintConfigEsmAzureSdk = `import azsdkEslint from "@azure/eslint-plugin-azure-sdk";
+
+export default [
+  ...azsdkEslint.config([
+    {
+      rules: {
+        "@azure/azure-sdk/ts-modules-only-named": "warn",
+        "@azure/azure-sdk/ts-package-json-types": "warn",
+        "@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
+        "@azure/azure-sdk/ts-package-json-files-required": "off",
+        "@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
+        "tsdoc/syntax": "warn"
+      }
+    },
+  ]),
+  {
+    files: ["src/**/*.ts", "src/**/*.mts", "test/**/*.ts"],
+    languageOptions: {
+      parserOptions: {
+        projectService: false,
+        project: "./config/tsconfig.lint.json",
+      },
+    },
+  },
+];
+`;
+
+export function buildEsLintConfig(_model: RLCModel) {
+  const project = new Project({ useInMemoryFileSystem: true });
+  const filePath = "eslint.config.mjs";
+
+  const configFile = project.createSourceFile("eslint.config.mjs", esLintConfigEsmAzureSdk, {
+    overwrite: true,
+  });
+  return {
+    path: filePath,
+    content: configFile.getFullText(),
+  };
+}

package/src/rlc-common/metadata/build-package-file.ts

@@ -0,0 +1,180 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { Project, SourceFile } from "ts-morph";
+import { hasPollingOperations } from "../helpers/operation-helpers.js";
+import { RLCModel } from "../interfaces.js";
+import { buildAzureMonorepoPackage } from "./package-json/build-azure-monorepo-package.js";
+import { PackageCommonInfoConfig, resolveWarpExports } from "./package-json/package-common.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),
+    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,
+    generateReactNativeTarget: model.options?.generateReactNativeTarget,
+  };
+
+  const extendedConfig = {
+    ...config,
+    hasLro: hasPollingOperations(model),
+    monorepoPackageDirectory: model.options?.azureOutputDirectory,
+    dependencies,
+    clientContextPaths,
+  };
+
+  const packageInfo: Record<string, any> = buildAzureMonorepoPackage(extendedConfig);
+
+  const project = new Project({ useInMemoryFileSystem: true });
+  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 needsLroUpdate = hasLro;
+  const needsExportsUpdate = exports;
+  const needsConstantPathsUpdate = clientContextPaths && clientContextPaths.length > 0;
+
+  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;
+  }
+
+  // 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).
+  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 (warp: resolved exports in package.json)
+  if (needsExportsUpdate) {
+    packageInfo.exports = resolveWarpExports(exports, model.options?.generateReactNativeTarget);
+  }
+
+  // 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 && 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;
+}