@azure-tools/typespec-ts 0.55.0 → 0.55.2

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

@@ -2,9 +2,9 @@
 // Licensed under the MIT License.
 
 import { Project } from "ts-morph";
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 
-export function buildApiExtractorConfig(_model: RLCModel) {
+export function buildApiExtractorConfig(_model: ClientModel) {
   const project = new Project({ useInMemoryFileSystem: true });
 
   const config = {

package/src/{rlc-common/metadata → metadata}/build-changelog-file.ts

@@ -1,13 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 
-function getPackageVersion(model: RLCModel): string {
+function getPackageVersion(model: ClientModel): string {
   return model.options?.packageDetails?.version ?? "1.0.0-beta.1";
 }
 
-export function buildChangelogFile(model: RLCModel) {
+export function buildChangelogFile(model: ClientModel) {
   const version = getPackageVersion(model);
   const content = `# Release History
 

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

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { Project } from "ts-morph";
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 
 const esLintConfigEsmAzureSdk = `import azsdkEslint from "@azure/eslint-plugin-azure-sdk";
 
@@ -31,7 +31,7 @@ export default [
 ];
 `;
 
-export function buildEsLintConfig(_model: RLCModel) {
+export function buildEsLintConfig(_model: ClientModel) {
   const project = new Project({ useInMemoryFileSystem: true });
   const filePath = "eslint.config.mjs";
 

package/src/{rlc-common/metadata → metadata}/build-package-file.ts

@@ -2,8 +2,8 @@
 // Licensed under the MIT License.
 
 import { Project, SourceFile } from "ts-morph";
-import { hasPollingOperations } from "../helpers/operation-helpers.js";
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
+import { hasPollingOperations } from "../utils/operation-helpers.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";
@@ -15,7 +15,7 @@ interface PackageFileOptions {
 }
 
 export function buildPackageFile(
-  model: RLCModel,
+  model: ClientModel,
   { exports, dependencies, clientContextPaths }: PackageFileOptions = {},
 ) {
   const config: PackageCommonInfoConfig = {
@@ -66,7 +66,7 @@ export function buildPackageFile(
  * - Updates `//metadata.constantPaths` when `clientContextPaths` is provided.
  */
 export function updatePackageFile(
-  model: RLCModel,
+  model: ClientModel,
   existingFilePathOrContent: string | Record<string, any>,
   { exports, clientContextPaths }: PackageFileOptions = {},
 ) {
@@ -167,11 +167,11 @@ export function updatePackageFile(
   };
 }
 
-function getPackageVersion(model: RLCModel): string {
+function getPackageVersion(model: ClientModel): string {
   return model.options?.packageDetails?.version ?? "1.0.0-beta.1";
 }
 
-function getDescription(model: RLCModel): string {
+function getDescription(model: ClientModel): string {
   const description = model.options?.packageDetails?.description;
   if (!description) {
     return `A generated SDK for ${model.libraryName}.`;

package/src/{rlc-common/metadata → metadata}/build-readme-file.ts

@@ -1,12 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
-import { getClientName } from "../helpers/name-constructors.js";
-import { NameType, normalizeName } from "../helpers/name-utils.js";
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
+import { getClientName } from "../utils/name-constructors.js";
+import { NameType, normalizeName } from "../utils/name-utils.js";
+import { renderTemplate } from "./render-template.js";
 
 const azureReadmeModularTemplate = `# {{ clientDescriptiveName }} library for JavaScript
 
@@ -38,13 +36,10 @@ Key links:
 
 See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
 
-{{#if azure}}
 ### Prerequisites
 
 - An [Azure subscription][azure_sub].
-{{/if}}
 
-{{#if isReleasablePackage}}
 ### Install the \`{{ clientPackageName }}\` package
 
 Install the {{ clientDescriptiveName }} library for JavaScript with \`npm\`:
@@ -52,9 +47,7 @@ Install the {{ clientDescriptiveName }} library for JavaScript with \`npm\`:
 \`\`\`bash
 npm install {{ clientPackageName }}
 \`\`\`
-{{/if}}
 
-{{#if azure}}
 {{#if addCredentials}}
 ### Create and authenticate a \`{{ clientClassName}}\`
 
@@ -129,7 +122,8 @@ const credential = new InteractiveBrowserCredential({
 const client = new {{ clientClassName }}("<endpoint>", credential);
 \`\`\`
 {{/if}}
-{{/if}}{{/if}}
+{{/if}}
+
 
 ### JavaScript Bundle
 To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
@@ -140,7 +134,6 @@ To use this client library in the browser, first you need to use a bundler. For
 
 \`{{ clientClassName }}\` is the primary interface for developers using the {{ clientDescriptiveName }} library. Explore the methods on this client object to understand the different features of the {{ serviceName }} service that you can access.
 
-{{#if azure}}
 ## Troubleshooting
 
 ### Logging
@@ -153,7 +146,7 @@ import { setLogLevel } from "@azure/logger";
 setLogLevel("info");
 \`\`\`
 
-For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs]({{ repoURL }}/tree/main/sdk/core/logger).
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 {{#if samplesURL}}
 ## Next steps
@@ -163,54 +156,16 @@ Please take a look at the [samples]({{ samplesURL }}) directory for detailed exa
 
 ## Contributing
 
-If you'd like to contribute to this library, please read the [contributing guide]({{ contributingGuideURL }}) to learn more about how to build and test the code.
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
 
 ## Related projects
 
-- [{{ projectName }}]({{ repoURL }})
+- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
 
 [azure_sub]: https://azure.microsoft.com/free/
 [azure_portal]: https://portal.azure.com
-{{#if identityPackageURL}}[azure_identity]: {{ identityPackageURL }}
-{{/if}}[defaultazurecredential]: {{ identityPackageURL }}#defaultazurecredential
-{{/if}}
-`;
-
-const nonBrandedReadmeTemplate = `# {{ clientDescriptiveName }} library for JavaScript
-
-{{ description }}
-
-Key links:
-
-{{#if packageSourceURL}}
-- [Source code]({{ packageSourceURL }})
-{{/if}}
-{{#if packageNPMURL}}
-- [Package (NPM)]({{ packageNPMURL }})
-{{/if}}
-{{#if apiRefURL}}
-- [API reference documentation]({{ apiRefURL }})
-{{/if}}
-{{#if serviceDocURL}}
-- [Product documentation]({{ serviceDocURL }})
-{{/if}}
-{{#if samplesURL}}
-- [Samples]({{ samplesURL }})
-{{/if}}
-
-## Getting started
-
-### Currently supported environments
-
-- LTS versions of Node.js
-
-### Install the \`{{ clientPackageName }}\` package
-
-Install the {{ clientDescriptiveName }} library for JavaScript with \`npm\`:
-
-\`\`\`bash
-npm install {{ clientPackageName }}
-\`\`\`
+[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
+[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
 `;
 
 const apiReferenceTemplate = `{{#if apiRefURL}}
@@ -228,8 +183,6 @@ interface Metadata {
   clientPackageName: string;
   /** The name of the client class */
   clientClassName: string;
-  /** The URL of the repository the package lives in */
-  repoURL?: string;
   /** The URL to the package directory in the repository */
   packageSourceURL?: string;
   /** The URL to the package's samples */
@@ -240,48 +193,28 @@ interface Metadata {
   description?: string;
   /** The URL to the package on npmjs.org */
   packageNPMURL?: string;
-  /** The name of the project that lives in the repository */
-  projectName?: string;
   /** whether the client accepts standard credentials */
   addCredentials?: boolean;
-  /** The link to the identity package in the repository */
-  identityPackageURL?: string;
-  /** The URL for the service document */
-  serviceDocURL?: string;
-  /** The dependency info for this service */
-  dependencyDescription?: string;
-  dependencyLink?: string;
-  /** Indicates if the package is a multi-client */
-  hasMultiClients?: boolean;
   /** The URL to the API reference */
   apiRefURL?: string;
   /** Check if the rp is management plane */
   azureArm?: boolean;
-  /** Whether the package being generated is for an Azure service */
-  azure: boolean;
-  /** Indicates if the package is a test/releasable package. */
-  isReleasablePackage?: boolean;
-  /** The link to the contributing guide in the repository */
-  contributingGuideURL?: string;
   /** Indicates if the package need generate test files */
   generateTest?: boolean;
   /** Indicates if the package need SubscriptionId as the client parameter */
   hasSubscriptionId?: boolean;
 }
 
-export function buildReadmeFile(model: RLCModel) {
+export function buildReadmeFile(model: ClientModel) {
   const metadata = createMetadata(model) ?? {};
-  const readmeFileContents = hbs.compile(
-    model.options ? azureReadmeModularTemplate : nonBrandedReadmeTemplate,
-    { noEscape: true },
-  );
+  const content = renderTemplate(azureReadmeModularTemplate, metadata as Record<string, unknown>);
   return {
     path: "README.md",
-    content: readmeFileContents(metadata),
+    content,
   };
 }
 
-export function hasClientNameChanged(model: RLCModel, existingReadmeContent: string): boolean {
+export function hasClientNameChanged(model: ClientModel, existingReadmeContent: string): boolean {
   try {
     const importMatch = existingReadmeContent.match(
       /import\s*\{\s*([A-Za-z0-9_]+)\s*\}\s*from\s*["'][^"']*["']/,
@@ -295,13 +228,16 @@ export function hasClientNameChanged(model: RLCModel, existingReadmeContent: str
 }
 
 export function updateReadmeFile(
-  model: RLCModel,
+  model: ClientModel,
   existingReadmeContent: string,
 ): { path: string; content: string } | undefined {
   try {
     const metadata = createMetadata(model) ?? {};
 
-    const newApiRefLink = hbs.compile(apiReferenceTemplate, { noEscape: true })(metadata).trim();
+    const newApiRefLink = renderTemplate(
+      apiReferenceTemplate,
+      metadata as Record<string, unknown>,
+    ).trim();
 
     if (!newApiRefLink) {
       return { path: "README.md", content: existingReadmeContent };
@@ -324,19 +260,17 @@ export function updateReadmeFile(
  * @param codeModel - include the client details
  * @returns inferred metadata about the service, the package, and the client
  */
-function createMetadata(model: RLCModel): Metadata | undefined {
+function createMetadata(model: ClientModel): Metadata | undefined {
   if (!model.options || !model.options.packageDetails) {
     return;
   }
   // const packageDetails = model.options.packageDetails;
-  const { packageDetails, azureOutputDirectory, serviceInfo, isTypeSpecTest } = model.options;
+  const { packageDetails, azureOutputDirectory, serviceInfo } = model.options;
 
-  const azureHuh =
-    packageDetails?.scopeName === "azure" || packageDetails?.scopeName === "azure-rest";
   const repoURL = "https://github.com/Azure/azure-sdk-for-js";
   const relativePackageSourcePath = azureOutputDirectory;
   const packageSourceURL =
-    relativePackageSourcePath && repoURL && `${repoURL}/tree/main/${relativePackageSourcePath}`;
+    relativePackageSourcePath && `${repoURL}/tree/main/${relativePackageSourcePath}`;
 
   const clientPackageName = packageDetails?.name;
   const clientClassName = getClientName(model);
@@ -363,23 +297,15 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
     samplesURL:
       model.options.generateSample && packageSourceURL ? `${packageSourceURL}/samples` : undefined,
-    apiRefURL: azureHuh
-      ? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
-      : undefined,
+    apiRefURL: `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`,
     azureArm: Boolean(model.options.azureArm),
-    azure: azureHuh,
-    isReleasablePackage: !isTypeSpecTest,
-    repoURL: repoURL,
-    projectName: azureHuh ? "Microsoft Azure SDK for JavaScript" : undefined,
-    identityPackageURL: repoURL && `${repoURL}/tree/main/sdk/identity/identity`,
     addCredentials: model.options.addCredentials,
-    contributingGuideURL: repoURL && `${repoURL}/blob/main/CONTRIBUTING.md`,
     generateTest: model.options.generateTest,
     hasSubscriptionId: model.options.hasSubscriptionId,
   };
 }
 
-function getServiceName(model: RLCModel) {
+function getServiceName(model: ClientModel) {
   const azureHuh =
     model?.options?.packageDetails?.scopeName === "azure" ||
     model?.options?.packageDetails?.scopeName === "azure-rest";

package/src/{rlc-common/metadata → metadata}/build-sample-env-file.ts

@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 
 const sampleEnvText = `
 # Feel free to add your own environment variables.
 `;
 
-export function buildSampleEnvFile(model: RLCModel) {
+export function buildSampleEnvFile(model: ClientModel) {
   if (model.options?.generateMetadata === true || model.options?.generateSample === true) {
     const filePath = "sample.env";
     return {

package/src/{rlc-common/metadata → metadata}/build-test-config.ts

@@ -1,17 +1,17 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 import { getPackageName } from "./utils.js";
 
-function shouldGenerateTestConfig(model: RLCModel): boolean {
+function shouldGenerateTestConfig(model: ClientModel): boolean {
   return !(model.options?.generateMetadata === false || model.options?.generateTest === false);
 }
 
 /**
  * Builds config/tsconfig.test.browser.json — extends eng/tsconfigs/test.browser.json
  */
-export function buildTestBrowserTsConfig(model: RLCModel) {
+export function buildTestBrowserTsConfig(model: ClientModel) {
   if (!shouldGenerateTestConfig(model)) {
     return;
   }
@@ -40,7 +40,7 @@ export function buildTestBrowserTsConfig(model: RLCModel) {
 /**
  * Builds config/tsconfig.test.node.json — extends eng/tsconfigs/test.node.json
  */
-export function buildTestNodeTsConfig(model: RLCModel) {
+export function buildTestNodeTsConfig(model: ClientModel) {
   if (!shouldGenerateTestConfig(model)) {
     return;
   }

package/src/{rlc-common/metadata → metadata}/build-ts-config.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { Project } from "ts-morph";
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 
 /**
  * Builds the root tsconfig.json.
@@ -10,7 +10,7 @@ import { RLCModel } from "../interfaces.js";
  * Emits project references pointing into the `config/` subfolder
  * (following the eng/tsconfigs pattern).
  */
-export function buildTsConfig(model: RLCModel) {
+export function buildTsConfig(model: ClientModel) {
   const { generateTest, generateSample, generateReactNativeTarget } = model.options || {};
   const project = new Project({ useInMemoryFileSystem: true });
 
@@ -52,16 +52,33 @@ export function buildTsConfig(model: RLCModel) {
   };
 }
 
+/**
+ * Derives the tsconfig `include` list from the warp `exports` map so every
+ * exported client entry point is compiled and emitted to `dist`; if they drift
+ * out of sync, warp fails the build with `DIST_MISSING`. Root index is the fallback.
+ */
+export function getSrcIncludePaths(exports?: Record<string, string>): string[] {
+  const includes = new Set<string>(["../src/index.ts"]);
+  if (exports) {
+    for (const value of Object.values(exports)) {
+      if (typeof value === "string" && value.endsWith(".ts")) {
+        includes.add(value.replace(/^\.\//, "../"));
+      }
+    }
+  }
+  return Array.from(includes);
+}
+
 /**
  * Builds config/tsconfig.src.esm.json — extends eng/tsconfigs/src.esm.json
  */
-export function buildTsSrcEsmConfig() {
+export function buildTsSrcEsmConfig(exports?: Record<string, string>) {
   return {
     path: "config/tsconfig.src.esm.json",
     content: JSON.stringify(
       {
         extends: "../../../../eng/tsconfigs/src.esm.json",
-        include: ["../src/index.ts"],
+        include: getSrcIncludePaths(exports),
       },
       null,
       2,
@@ -72,13 +89,13 @@ export function buildTsSrcEsmConfig() {
 /**
  * Builds config/tsconfig.src.browser.json — extends eng/tsconfigs/src.browser.json
  */
-export function buildTsSrcBrowserConfig() {
+export function buildTsSrcBrowserConfig(exports?: Record<string, string>) {
   return {
     path: "config/tsconfig.src.browser.json",
     content: JSON.stringify(
       {
         extends: "../../../../eng/tsconfigs/src.browser.json",
-        include: ["../src/index.ts"],
+        include: getSrcIncludePaths(exports),
       },
       null,
       2,
@@ -89,13 +106,13 @@ export function buildTsSrcBrowserConfig() {
 /**
  * Builds config/tsconfig.src.react-native.json — extends eng/tsconfigs/src.react-native.json
  */
-export function buildTsSrcReactNativeConfig() {
+export function buildTsSrcReactNativeConfig(exports?: Record<string, string>) {
   return {
     path: "config/tsconfig.src.react-native.json",
     content: JSON.stringify(
       {
         extends: "../../../../eng/tsconfigs/src.react-native.json",
-        include: ["../src/index.ts"],
+        include: getSrcIncludePaths(exports),
       },
       null,
       2,
@@ -106,13 +123,13 @@ export function buildTsSrcReactNativeConfig() {
 /**
  * Builds config/tsconfig.src.cjs.json — extends eng/tsconfigs/src.cjs.json
  */
-export function buildTsSrcCjsConfig() {
+export function buildTsSrcCjsConfig(exports?: Record<string, string>) {
   return {
     path: "config/tsconfig.src.cjs.json",
     content: JSON.stringify(
       {
         extends: "../../../../eng/tsconfigs/src.cjs.json",
-        include: ["../src/index.ts"],
+        include: getSrcIncludePaths(exports),
       },
       null,
       2,
@@ -123,7 +140,7 @@ export function buildTsSrcCjsConfig() {
 /**
  * Builds config/tsconfig.samples.json — extends eng/tsconfigs/samples.json
  */
-export function buildTsSampleConfig(model: RLCModel) {
+export function buildTsSampleConfig(model: ClientModel) {
   const { packageDetails } = model.options || {};
   const clientPackageName = packageDetails?.name ?? "";
   return {

package/src/{rlc-common/metadata → metadata}/build-vitest-config.ts

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

package/src/{rlc-common/metadata → metadata}/build-warp-config.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { RLCModel } from "../interfaces.js";
+import { ClientModel } from "../interfaces.js";
 
 export interface WarpConfigOptions {
   /** Source-level exports, e.g. { ".": "./src/index.ts", "./models": "./src/models/index.ts" } */
@@ -67,7 +67,7 @@ targets:
  * By default, react-native target is NOT included. Set `generateReactNativeTarget: true`
  * in options to include it.
  */
-export function buildWarpConfig(model: RLCModel, { exports }: WarpConfigOptions = {}) {
+export function buildWarpConfig(model: ClientModel, { exports }: WarpConfigOptions = {}) {
   const allExports: Record<string, string> = {
     ...BASE_EXPORTS,
     ...exports,

package/src/{rlc-common/metadata → metadata}/package-json/build-azure-monorepo-package.ts

@@ -43,7 +43,7 @@ export function getAzureMonorepoDependencies(config: AzureMonorepoInfoConfig) {
     "@azure/core-rest-pipeline": "^1.20.0",
     "@azure/core-util": "^1.12.0",
     "@azure/logger": "^1.2.0",
-    tslib: "^2.8.1",
+    tslib: "catalog:",
   };
 
   const testDeps = withTests