@azure-tools/typespec-ts 0.54.0 → 0.55.0-dev.6

package/src/rlc-common/index.ts

@@ -1,43 +1,43 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-export * from "./interfaces.js";
+export * from "./buildClient.js";
 export * from "./buildClientDefinitions.js";
+export * from "./buildIndexFile.js";
+export * from "./buildIsUnexpectedHelper.js";
+export * from "./buildLogger.js";
+export * from "./buildPaginateHelper.js";
+export * from "./buildParameterTypes.js";
+export * from "./buildPollingHelper.js";
+export * from "./buildResponseTypes.js";
+export * from "./buildSamples.js";
 export * from "./buildSchemaType.js";
-export * from "./buildClient.js";
+export * from "./buildSerializeHelper.js";
+export * from "./buildTopLevelIndexFile.js";
+export * from "./helpers/apiVersionUtil.js";
+export * from "./helpers/importsUtil.js";
 export * from "./helpers/nameConstructors.js";
-export * from "./buildResponseTypes.js";
-export * from "./helpers/shortcutMethods.js";
 export * from "./helpers/nameUtils.js";
 export * from "./helpers/operationHelpers.js";
-export * from "./helpers/valueGenerationUtil.js";
+export * from "./helpers/packageUtil.js";
 export * from "./helpers/schemaHelpers.js";
-export * from "./buildParameterTypes.js";
-export * from "./buildIsUnexpectedHelper.js";
-export * from "./buildTopLevelIndexFile.js";
-export * from "./buildIndexFile.js";
-export * from "./buildPaginateHelper.js";
-export * from "./buildPollingHelper.js";
-export * from "./test/buildKarmaConfig.js";
-export * from "./test/buildRecordedClient.js";
-export * from "./test/buildSampleTest.js";
-export * from "./test/buildSnippets.js";
-export * from "./metadata/buildReadmeFile.js";
+export * from "./helpers/shortcutMethods.js";
+export * from "./helpers/valueGenerationUtil.js";
+export * from "./interfaces.js";
 export * from "./metadata/buildApiExtractorConfig.js";
+export * from "./metadata/buildChangelogFile.js";
+export * from "./metadata/buildESLintConfig.js";
+export * from "./metadata/buildLicenseFile.js";
 export * from "./metadata/buildPackageFile.js";
+export * from "./metadata/buildReadmeFile.js";
 export * from "./metadata/buildRollupConfig.js";
+export * from "./metadata/buildSampleEnvFile.js";
+export * from "./metadata/buildTestConfig.js";
 export * from "./metadata/buildTsConfig.js";
-export * from "./metadata/buildWarpConfig.js";
-export * from "./metadata/buildESLintConfig.js";
-export * from "./metadata/buildLicenseFile.js";
-export * from "./metadata/buildChangelogFile.js";
 export * from "./metadata/buildVitestConfig.js";
-export * from "./metadata/buildSampleEnvFile.js";
-export * from "./buildSerializeHelper.js";
-export * from "./helpers/apiVersionUtil.js";
-export * from "./buildLogger.js";
-export * from "./buildSamples.js";
+export * from "./metadata/buildWarpConfig.js";
+export * from "./test/buildKarmaConfig.js";
+export * from "./test/buildRecordedClient.js";
+export * from "./test/buildSampleTest.js";
+export * from "./test/buildSnippets.js";
 export * from "./transformSampleGroups.js";
-export * from "./helpers/importsUtil.js";
-export * from "./metadata/buildTestConfig.js";
-export * from "./helpers/packageUtil.js";

package/src/rlc-common/interfaces.ts

@@ -115,12 +115,7 @@ export interface ApiVersionInfo {
   required?: boolean;
 }
 
-export type ApiVersionPosition =
-  | "path"
-  | "query"
-  | "baseurl"
-  | "duplicate"
-  | "none";
+export type ApiVersionPosition = "path" | "query" | "baseurl" | "duplicate" | "none";
 export interface HelperFunctionDetails {
   hasPaging?: boolean;
   hasLongRunning?: boolean;
@@ -306,7 +301,7 @@ export enum SchemaContext {
   /** Schema is used as an output from an operation. */
   Output = "output",
   /** Schema is used as an exception from an operation. */
-  Exception = "exception"
+  Exception = "exception",
 }
 
 export interface Schema {
@@ -429,10 +424,7 @@ export type ContentBuilder = {
 
 export type SampleParameterPosition = "client" | "path" | "method";
 
-export type SampleParameters = Record<
-  SampleParameterPosition,
-  SampleParameter[]
->;
+export type SampleParameters = Record<SampleParameterPosition, SampleParameter[]>;
 
 export interface SampleParameter {
   name: string;

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

@@ -5,67 +5,60 @@ import { Project } from "ts-morph";
 import { RLCModel } from "../interfaces.js";
 
 export function buildApiExtractorConfig(model: RLCModel) {
-  const { packageDetails, isModularLibrary, generateTest, azureSdkForJs } =
-    model.options || {};
+  const { packageDetails, isModularLibrary, generateTest, azureSdkForJs } = model.options || {};
   const project = new Project();
 
   let mainEntryPointFilePath = "dist/esm/index.d.ts";
 
   if (model.options?.moduleKind === "cjs") {
-    mainEntryPointFilePath = `./types${
-      generateTest || isModularLibrary ? "/src" : ""
-    }/index.d.ts`;
+    mainEntryPointFilePath = `./types${generateTest || isModularLibrary ? "/src" : ""}/index.d.ts`;
   }
 
   const config = azureSdkForJs
     ? {
-        extends: "../../../api-extractor-base.json"
+        extends: "../../../api-extractor-base.json",
       }
     : {
         $schema:
           "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
         mainEntryPointFilePath,
         docModel: {
-          enabled: true
+          enabled: true,
         },
         apiReport: {
           enabled: true,
-          reportFolder: "./review"
+          reportFolder: "./review",
         },
         dtsRollup: {
           enabled: true,
           untrimmedFilePath: "",
           publicTrimmedFilePath: `dist/${
             packageDetails?.nameWithoutScope ?? packageDetails?.name
-          }.d.ts`
+          }.d.ts`,
         },
         messages: {
           tsdocMessageReporting: {
             default: {
-              logLevel: "none"
-            }
+              logLevel: "none",
+            },
           },
           extractorMessageReporting: {
             "ae-missing-release-tag": {
-              logLevel: "none"
+              logLevel: "none",
             },
             "ae-unresolved-link": {
-              logLevel: "none"
-            }
-          }
-        }
+              logLevel: "none",
+            },
+          },
+        },
       };
 
   const filePath = "api-extractor.json";
-  const configFile = project.createSourceFile(
-    filePath,
-    JSON.stringify(config),
-    {
-      overwrite: true
-    }
-  );
+  const configFile = project.createSourceFile(filePath, JSON.stringify(config), {
+    overwrite: true,
+  });
   return {
     path: filePath,
-    content: configFile.getFullText()
+    content: configFile.getFullText(),
   };
 }

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

@@ -24,6 +24,6 @@ export function buildChangelogFile(model: RLCModel) {
 
   return {
     path: "CHANGELOG.md",
-    content
+    content,
   };
 }

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

@@ -70,17 +70,15 @@ export function buildEsLintConfig(model: RLCModel) {
 
   let template: string;
   if (model.options?.moduleKind === "esm") {
-    template = model.options?.azureSdkForJs
-      ? esLintConfigEsmAzureSdk
-      : esLintConfigEsm;
+    template = model.options?.azureSdkForJs ? esLintConfigEsmAzureSdk : esLintConfigEsm;
   } else {
     template = eslintConfig;
   }
   const configFile = project.createSourceFile("eslint.config.mjs", template, {
-    overwrite: true
+    overwrite: true,
   });
   return {
     path: filePath,
-    content: configFile.getFullText()
+    content: configFile.getFullText(),
   };
 }

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

@@ -28,6 +28,6 @@ SOFTWARE.
 export function buildLicenseFile() {
   return {
     path: "LICENSE",
-    content: mitLicenseText.trim()
+    content: mitLicenseText.trim(),
   };
 }

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

@@ -1,24 +1,24 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import { Project, SourceFile } from "ts-morph";
 import { NameType, normalizeName } from "../helpers/nameUtils.js";
 import { hasPollingOperations } from "../helpers/operationHelpers.js";
 import {
   isAzureMonorepoPackage,
   isAzurePackage,
-  isAzureStandalonePackage
+  isAzureStandalonePackage,
 } from "../helpers/packageUtil.js";
-import {
-  PackageCommonInfoConfig,
-  getTshyConfig,
-  resolveWarpExports
-} from "./packageJson/packageCommon.js";
-import { Project, SourceFile } from "ts-morph";
+import { getRelativePartFromSrcPath } from "../helpers/pathUtils.js";
 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 {
+  PackageCommonInfoConfig,
+  getTshyConfig,
+  resolveWarpExports,
+} from "./packageJson/packageCommon.js";
 import { getPackageName } from "./utils.js";
 
 interface PackageFileOptions {
@@ -29,7 +29,7 @@ interface PackageFileOptions {
 
 export function buildPackageFile(
   model: RLCModel,
-  { exports, dependencies, clientContextPaths }: PackageFileOptions = {}
+  { exports, dependencies, clientContextPaths }: PackageFileOptions = {},
 ) {
   const config: PackageCommonInfoConfig = {
     description: getDescription(model),
@@ -43,7 +43,7 @@ export function buildPackageFile(
     azureArm: model.options?.azureArm,
     isModularLibrary: model.options?.isModularLibrary ?? false,
     azureSdkForJs: model.options?.azureSdkForJs,
-    generateReactNativeTarget: model.options?.generateReactNativeTarget
+    generateReactNativeTarget: model.options?.generateReactNativeTarget,
   };
 
   let packageInfo: Record<string, any> = buildFlavorlessPackage(config);
@@ -55,7 +55,7 @@ export function buildPackageFile(
     monorepoPackageDirectory: model.options?.azureOutputDirectory,
     specSource: model.options?.sourceFrom ?? "TypeSpec",
     dependencies,
-    clientContextPaths
+    clientContextPaths,
   };
 
   if (isAzureMonorepoPackage(model)) {
@@ -73,16 +73,12 @@ export function buildPackageFile(
     return;
   }
 
-  const packageFile = project.createSourceFile(
-    filePath,
-    JSON.stringify(packageInfo, null, 2),
-    {
-      overwrite: true
-    }
-  );
+  const packageFile = project.createSourceFile(filePath, JSON.stringify(packageInfo, null, 2), {
+    overwrite: true,
+  });
   return {
     path: filePath,
-    content: packageFile.getFullText()
+    content: packageFile.getFullText(),
   };
 }
 
@@ -98,14 +94,13 @@ export function buildPackageFile(
 export function updatePackageFile(
   model: RLCModel,
   existingFilePathOrContent: string | Record<string, any>,
-  { exports, clientContextPaths }: PackageFileOptions = {}
+  { 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 needsConstantPathsUpdate = clientContextPaths && clientContextPaths.length > 0;
   const needsPlatformImportsUpdate =
     model.options?.azureSdkForJs && model.options?.moduleKind === "esm";
 
@@ -151,7 +146,7 @@ export function updatePackageFile(
   if (needsPlatformImportsUpdate) {
     const platformImports: Record<string, string> = {
       browser: "./src/*-browser.mts",
-      default: "./src/*.ts"
+      default: "./src/*.ts",
     };
     if (model.options?.generateReactNativeTarget) {
       // Insert `react-native` before `default` so Node's conditional
@@ -160,12 +155,12 @@ export function updatePackageFile(
         "#platform/*": {
           browser: platformImports["browser"],
           "react-native": "./src/*-react-native.mts",
-          default: platformImports["default"]
-        }
+          default: platformImports["default"],
+        },
       };
     } else {
       packageInfo.imports = {
-        "#platform/*": platformImports
+        "#platform/*": platformImports,
       };
     }
   }
@@ -174,16 +169,13 @@ export function updatePackageFile(
   if (needsExportsUpdate) {
     if (model.options?.azureSdkForJs) {
       // Warp: update resolved exports in package.json
-      packageInfo.exports = resolveWarpExports(
-        exports,
-        model.options?.generateReactNativeTarget
-      );
+      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
+        generateReactNativeTarget: model.options?.generateReactNativeTarget,
       } as PackageCommonInfoConfig);
       packageInfo.tshy["exports"] = newTshy["exports"];
     }
@@ -203,7 +195,7 @@ export function updatePackageFile(
     packageInfo.dependencies = {
       ...packageInfo.dependencies,
       "@azure/core-lro": "^3.1.0",
-      "@azure/abort-controller": "^2.1.2"
+      "@azure/abort-controller": "^2.1.2",
     };
   }
 
@@ -212,19 +204,19 @@ export function updatePackageFile(
     const metadata = packageInfo["//metadata"];
     // Filter out existing userAgentInfo entries
     const nonUserAgentPaths = (metadata.constantPaths || []).filter(
-      (item: any) => item.prefix !== "userAgentInfo"
+      (item: any) => item.prefix !== "userAgentInfo",
     );
     // Add new userAgentInfo entries from clientContextPaths
     const newUserAgentPaths = clientContextPaths!.map((path) => ({
       path: path,
-      prefix: "userAgentInfo"
+      prefix: "userAgentInfo",
     }));
     metadata.constantPaths = [...nonUserAgentPaths, ...newUserAgentPaths];
   }
 
   return {
     path: "package.json",
-    content: JSON.stringify(packageInfo, null, 2)
+    content: JSON.stringify(packageInfo, null, 2),
   };
 }
 

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

@@ -4,11 +4,11 @@
 import { RLCModel } from "../interfaces.js";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore: to fix the handlebars issue
+import { readFileSync } from "fs";
 import hbs from "handlebars";
+import { getClientName } from "../helpers/nameConstructors.js";
 import { NameType, normalizeName } from "../helpers/nameUtils.js";
 import { isAzurePackage } from "../helpers/packageUtil.js";
-import { getClientName } from "../helpers/nameConstructors.js";
-import { readFileSync } from "fs";
 
 const azureReadmeRLCTemplate = `# {{ clientDescriptiveName }} library for JavaScript
 
@@ -355,22 +355,19 @@ export function buildReadmeFile(model: RLCModel) {
         ? azureReadmeModularTemplate
         : azureReadmeRLCTemplate
       : nonBrandedReadmeTemplate,
-    { noEscape: true }
+    { noEscape: true },
   );
   return {
     path: "README.md",
-    content: readmeFileContents(metadata)
+    content: readmeFileContents(metadata),
   };
 }
 
-export function hasClientNameChanged(
-  model: RLCModel,
-  existingReadmeFilePath: string
-): boolean {
+export function hasClientNameChanged(model: RLCModel, existingReadmeFilePath: string): boolean {
   try {
     const existingContent = readFileSync(existingReadmeFilePath, "utf8");
     const importMatch = existingContent.match(
-      /import\s*\{\s*([A-Za-z0-9_]+)\s*\}\s*from\s*["'][^"']*["']/
+      /import\s*\{\s*([A-Za-z0-9_]+)\s*\}\s*from\s*["'][^"']*["']/,
     );
     const existingClientName = importMatch?.[1];
     const newClientName = getClientName(model);
@@ -382,15 +379,13 @@ export function hasClientNameChanged(
 
 export function updateReadmeFile(
   model: RLCModel,
-  existingReadmeFilePath: string
+  existingReadmeFilePath: string,
 ): { path: string; content: string } | undefined {
   try {
     const existingContent = readFileSync(existingReadmeFilePath, "utf8");
     const metadata = createMetadata(model) ?? {};
 
-    const newApiRefLink = hbs
-      .compile(apiReferenceTemplate, { noEscape: true })(metadata)
-      .trim();
+    const newApiRefLink = hbs.compile(apiReferenceTemplate, { noEscape: true })(metadata).trim();
 
     if (!newApiRefLink) {
       return { path: "README.md", content: existingContent };
@@ -399,7 +394,7 @@ export function updateReadmeFile(
     const apiRefRegex =
       /^- \[API reference documentation\]\(https:\/\/learn\.microsoft\.com\/javascript\/api\/[^)]+\)$/m;
     const updatedContent = existingContent.replace(apiRefRegex, (match) =>
-      match ? newApiRefLink : match
+      match ? newApiRefLink : match,
     );
 
     return { path: "README.md", content: updatedContent };
@@ -426,27 +421,21 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     multiClient,
     batch,
     serviceInfo,
-    isTypeSpecTest
+    isTypeSpecTest,
   } = model.options;
 
   const azureHuh =
-    packageDetails?.scopeName === "azure" ||
-    packageDetails?.scopeName === "azure-rest";
+    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 && `${repoURL}/tree/main/${relativePackageSourcePath}`;
 
   const clientPackageName = packageDetails?.name;
   const clientClassName = getClientName(model);
   const serviceName = getServiceName(model);
   let apiRefUrlQueryParameter: string = "";
-  if (
-    !packageDetails?.isVersionUserProvided &&
-    model.apiVersionInfo?.defaultValue
-  ) {
+  if (!packageDetails?.isVersionUserProvided && model.apiVersionInfo?.defaultValue) {
     if (model.apiVersionInfo?.defaultValue?.toLowerCase().includes("preview")) {
       apiRefUrlQueryParameter = "?view=azure-node-preview";
     }
@@ -469,9 +458,7 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     packageSourceURL: packageSourceURL,
     packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
     samplesURL:
-      model.options.generateSample && packageSourceURL
-        ? `${packageSourceURL}/samples`
-        : undefined,
+      model.options.generateSample && packageSourceURL ? `${packageSourceURL}/samples` : undefined,
     apiRefURL: azureHuh
       ? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
       : undefined,
@@ -488,7 +475,7 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     contributingGuideURL: repoURL && `${repoURL}/blob/main/CONTRIBUTING.md`,
     azureSdkForJs: model.options.azureSdkForJs,
     generateTest: model.options.generateTest,
-    hasSubscriptionId: model.options.hasSubscriptionId
+    hasSubscriptionId: model.options.hasSubscriptionId,
   };
 }
 
@@ -506,7 +493,7 @@ function getServiceName(model: RLCModel) {
     batch && batch.length > 1
       ? normalizeName(
           packageDetails!.nameWithoutScope ?? packageDetails?.name ?? "",
-          NameType.Class
+          NameType.Class,
         )
       : normalizeName(serviceTitle, NameType.Class);
   simpleServiceName =

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

@@ -2,23 +2,20 @@
 // Licensed under the MIT License.
 
 import { Project } from "ts-morph";
-import { RLCModel } from "../interfaces.js";
 import { isAzurePackage } from "../helpers/packageUtil.js";
+import { RLCModel } from "../interfaces.js";
 
 export function buildRollupConfig(model: RLCModel) {
   const azureSdkForJs = Boolean(model.options?.azureSdkForJs);
   // Only generate the file when it is not in sdk repo
-  if (
-    isAzurePackage(model) &&
-    (azureSdkForJs === true || azureSdkForJs === undefined)
-  ) {
+  if (isAzurePackage(model) && (azureSdkForJs === true || azureSdkForJs === undefined)) {
     return;
   }
 
   const project = new Project();
   const filePath = "rollup.config.js";
   const rollupFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true
+    overwrite: true,
   });
 
   rollupFile.addStatements(
@@ -140,11 +137,11 @@ export function buildRollupConfig(model: RLCModel) {
       return config;
     }
     
-    export default makeConfig(require("./package.json"));`
+    export default makeConfig(require("./package.json"));`,
   );
 
   return {
     path: filePath,
-    content: rollupFile.getFullText()
+    content: rollupFile.getFullText(),
   };
 }

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

@@ -8,14 +8,13 @@ const sampleEnvText = `
 
 export function buildSampleEnvFile(model: RLCModel) {
   if (
-    (model.options?.generateMetadata === true ||
-      model.options?.generateSample === true) &&
+    (model.options?.generateMetadata === true || model.options?.generateSample === true) &&
     model.options?.flavor === "azure"
   ) {
     const filePath = "sample.env";
     return {
       path: filePath,
-      content: sampleEnvText.trim()
+      content: sampleEnvText.trim(),
     };
   }
   return undefined;

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

@@ -32,13 +32,13 @@ export function buildTestBrowserTsConfig(model: RLCModel) {
           paths: {
             [name]: ["../src/index.ts"],
             [`${name}/*`]: ["../src/*"],
-            "$internal/*": ["../src/*"]
-          }
-        }
+            "$internal/*": ["../src/*"],
+          },
+        },
       },
       null,
-      2
-    )
+      2,
+    ),
   };
 }
 
@@ -61,12 +61,12 @@ export function buildTestNodeTsConfig(model: RLCModel) {
           paths: {
             [name]: ["../src/index.ts"],
             [`${name}/*`]: ["../src/*"],
-            "$internal/*": ["../src/*"]
-          }
-        }
+            "$internal/*": ["../src/*"],
+          },
+        },
       },
       null,
-      2
-    )
+      2,
+    ),
   };
 }