@azure-tools/typespec-ts 0.55.0-dev.8 → 0.55.0

package/src/modular/emit-samples.ts

@@ -316,12 +316,36 @@ function prepareExampleParameters(
 
   let subscriptionIdValue = `"00000000-0000-0000-0000-000000000000"`;
   let isSubscriptionIdAdded = false;
-  // required parameters
+
+  // Map each HTTP parameter to its method parameter via `methodParameterSegments`
+  // and place its example value at that path, yielding one argument per method
+  // parameter regardless of flat, nested, or grouped shape. Client- and
+  // body-carried roots are emitted by their own sections and skipped here.
+  const bodyParam = method.operation.bodyParam;
+  let bodyRootName: string | undefined;
+  if (
+    bodyParam &&
+    !isSpreadBodyParameter(bodyParam) &&
+    bodyParam.methodParameterSegments.length === 1 &&
+    bodyParam.methodParameterSegments[0] !== undefined &&
+    bodyParam.methodParameterSegments[0].length >= 1
+  ) {
+    bodyRootName = bodyParam.methodParameterSegments[0][0]!.name;
+  }
+
+  const methodArguments = new Map<
+    string,
+    { name: string; isOptional: boolean; value: ValueTreeNode | string }
+  >();
   for (const param of method.operation.parameters) {
-    if (param.optional === true || param.type.kind === "constant" || param.clientDefaultValue) {
+    if (param.type.kind === "constant" || param.clientDefaultValue) {
       continue;
     }
-
+    const path = param.methodParameterSegments[0];
+    if (path === undefined || path.length === 0) {
+      continue;
+    }
+    const root = path[0]!;
     const exampleValue = parameterMap[param.serializedName];
 
     // Handle subscriptionId parameter separately for ARM clients
@@ -343,28 +367,27 @@ function prepareExampleParameters(
       continue;
     }
 
+    // Roots emitted by the client and body sections.
+    if (root.onClient || (bodyRootName !== undefined && root.name === bodyRootName)) {
+      continue;
+    }
+
     if (!exampleValue || !exampleValue.value) {
       // report diagnostic if required parameter is missing
-      reportDiagnostic(dpgContext.program, {
-        code: "required-sample-parameter",
-        format: {
-          exampleName: method.oriName ?? method.name,
-          paramName: param.name,
-        },
-        target: NoTarget,
-      });
+      if (path.length === 1 && !param.optional) {
+        reportDiagnostic(dpgContext.program, {
+          code: "required-sample-parameter",
+          format: {
+            exampleName: method.oriName ?? method.name,
+            paramName: param.name,
+          },
+          target: NoTarget,
+        });
+      }
       continue;
     }
 
-    result.push(
-      prepareExampleValue(
-        dpgContext,
-        exampleValue.parameter.name,
-        exampleValue.value,
-        param.optional,
-        param.onClient,
-      ),
-    );
+    placeMethodArgument(methodArguments, path, getParameterValue(dpgContext, exampleValue.value));
   }
 
   // If client-level subscriptionId is needed on the client for this method, then add it
@@ -381,7 +404,6 @@ function prepareExampleParameters(
   }
 
   // required/optional body parameters
-  const bodyParam = method.operation.bodyParam;
   const bodySerializeName = bodyParam?.serializedName;
   const bodyExample = parameterMap[bodySerializeName ?? ""];
   if (bodyParam && bodyExample && bodyExample.value) {
@@ -441,28 +463,87 @@ function prepareExampleParameters(
       }
     }
   }
-  // optional parameters
-  method.operation.parameters
-    .filter(
-      (param) =>
-        param.optional === true && parameterMap[param.serializedName] && !param.clientDefaultValue,
-    )
-    .map((param) => parameterMap[param.serializedName]!)
-    .forEach((param) => {
-      result.push(
-        prepareExampleValue(
-          dpgContext,
-          param.parameter.name,
-          param.value,
-          true,
-          param.parameter.onClient,
-        ),
-      );
+  // Emit one argument per top-level method parameter. A normal parameter carries
+  // a scalar value; a parameter with nested leaves carries an object literal.
+  for (const arg of methodArguments.values()) {
+    result.push({
+      name: normalizeName(arg.name, NameType.Parameter, true),
+      value: serializeNestedValue(arg.value),
+      isOptional: arg.isOptional,
+      onClient: false,
     });
+  }
 
   return result;
 }
 
+/** A nested value tree: leaves are TypeScript value expressions, interior nodes are objects. */
+interface ValueTreeNode {
+  [key: string]: ValueTreeNode | string;
+}
+
+/**
+ * Records `leaf` for the method parameter addressed by `path`. `path[0]` is the
+ * top-level method parameter (the argument key); a single-segment path stores a
+ * scalar, a longer path stores the leaf inside a nested object merged with
+ * sibling leaves sharing the same root.
+ */
+function placeMethodArgument(
+  methodArguments: Map<
+    string,
+    { name: string; isOptional: boolean; value: ValueTreeNode | string }
+  >,
+  path: readonly { name: string; optional?: boolean }[],
+  leaf: string,
+): void {
+  const root = path[0]!;
+  let arg = methodArguments.get(root.name);
+  if (!arg) {
+    arg = { name: root.name, isOptional: Boolean(root.optional), value: {} };
+    methodArguments.set(root.name, arg);
+  }
+  if (path.length === 1) {
+    arg.value = leaf;
+    return;
+  }
+  if (typeof arg.value !== "object") {
+    arg.value = {};
+  }
+  setNestedValue(arg.value, path.slice(1), leaf);
+}
+
+/** Places `leaf` at `path` (segments after the root), creating intermediate objects as needed. */
+function setNestedValue(
+  root: ValueTreeNode,
+  path: readonly { name: string }[],
+  leaf: string,
+): void {
+  let node = root;
+  for (let i = 0; i < path.length; i++) {
+    const key = normalizeName(path[i]!.name, NameType.Property, true);
+    if (i === path.length - 1) {
+      node[key] = leaf;
+    } else {
+      const existing = node[key];
+      if (typeof existing !== "object" || existing === null) {
+        node[key] = {};
+      }
+      node = node[key] as ValueTreeNode;
+    }
+  }
+}
+
+/** Serializes a {@link ValueTreeNode} into a TypeScript object literal string. */
+function serializeNestedValue(node: ValueTreeNode | string): string {
+  if (typeof node === "string") {
+    return node;
+  }
+  const entries = Object.entries(node).map(
+    ([key, value]) => `${key}: ${serializeNestedValue(value)}`,
+  );
+  return `{ ${entries.join(", ")} }`;
+}
+
 function getCredentialExampleValue(
   _dpgContext: SdkContext,
   initialization: SdkClientInitializationType,

package/src/modular/serialization/serialize-utils.ts

@@ -61,7 +61,7 @@ export function isSupportedSerializeType(type: SdkType): boolean {
  * 6. nested model i.e. model with property that is a model with one of the above three conditions.
  * If we consider array type, with all the above 6 types as the element types.
  */
-const specialVariantMap = new Map<SdkType, boolean>();
+const specialVariantMap = new WeakMap<SdkType, boolean>();
 export function isSpecialUnionVariant(
   t: SdkType & { isNonExhaustive?: boolean },
   variantStack: SdkType[] = [],
@@ -146,7 +146,7 @@ export function isSpecialHandledUnion(t: SdkType & { isNonExhaustive?: boolean }
   return isDiscriminatedUnion(t!) || isPolymorphicUnion(t);
 }
 
-const polymorphicUnionMap = new Map<SdkType, boolean>();
+const polymorphicUnionMap = new WeakMap<SdkType, boolean>();
 export function isPolymorphicUnion(t: SdkType): boolean {
   if (polymorphicUnionMap.has(t)) {
     return polymorphicUnionMap.get(t) ?? false;

package/src/rlc-common/helpers/name-constructors.ts

@@ -77,14 +77,7 @@ export function getParameterTypeName(baseNameOrOperationGroup: string, operation
 }
 
 export function getClientName(model: RLCModel) {
-  const clientName = model.libraryName;
-  const clientInterfaceName = model.options?.isModularLibrary
-    ? model.libraryName
-    : clientName.endsWith("Client")
-      ? `${clientName}`
-      : `${clientName}Client`;
-
-  return clientInterfaceName;
+  return model.libraryName;
 }
 
 export function getMultipartPartTypeName(schemaName: string, partName: string) {

package/src/rlc-common/index.ts

@@ -1,27 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-export * from "./build-client-definitions.js";
-export * from "./build-client.js";
-export * from "./build-index-file.js";
-export * from "./build-is-unexpected-helper.js";
-export * from "./build-logger.js";
-export * from "./build-paginate-helper.js";
-export * from "./build-parameter-types.js";
-export * from "./build-polling-helper.js";
-export * from "./build-response-types.js";
-export * from "./build-samples.js";
-export * from "./build-schema-type.js";
-export * from "./build-serialize-helper.js";
-export * from "./build-top-level-index-file.js";
 export * from "./helpers/api-version-util.js";
 export * from "./helpers/imports-util.js";
 export * from "./helpers/name-constructors.js";
 export * from "./helpers/name-utils.js";
 export * from "./helpers/operation-helpers.js";
 export * from "./helpers/schema-helpers.js";
-export * from "./helpers/shortcut-methods.js";
-export * from "./helpers/value-generation-util.js";
 export * from "./interfaces.js";
 export * from "./metadata/build-api-extractor-config.js";
 export * from "./metadata/build-changelog-file.js";
@@ -38,4 +23,3 @@ export * from "./test/build-karma-config.js";
 export * from "./test/build-recorded-client.js";
 export * from "./test/build-sample-test.js";
 export * from "./test/build-snippets.js";
-export * from "./transform-sample-groups.js";

package/src/rlc-common/interfaces.ts

@@ -195,8 +195,6 @@ 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;
@@ -226,12 +224,8 @@ export interface RLCOptions {
   generateSample?: boolean;
   azureOutputDirectory?: string;
   isTypeSpecTest?: boolean;
-  title?: string;
-  dependencyInfo?: DependencyInfo;
-  productDocLink?: string;
   serviceInfo?: ServiceInfo;
   azureArm?: boolean;
-  isModularLibrary?: boolean;
   enableOperationGroup?: boolean;
   enableModelNamespace?: boolean;
   hierarchyClient?: boolean;
@@ -275,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-package-file.ts

@@ -2,9 +2,7 @@
 // Licensed under the MIT License.
 
 import { Project, SourceFile } from "ts-morph";
-import { NameType, normalizeName } from "../helpers/name-utils.js";
 import { hasPollingOperations } from "../helpers/operation-helpers.js";
-import { getRelativePartFromSrcPath } from "../helpers/path-utils.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";
@@ -29,13 +27,11 @@ export function buildPackageFile(
     nameWithoutScope: model.options?.packageDetails?.nameWithoutScope,
     exports,
     azureArm: model.options?.azureArm,
-    isModularLibrary: model.options?.isModularLibrary ?? false,
     generateReactNativeTarget: model.options?.generateReactNativeTarget,
   };
 
   const extendedConfig = {
     ...config,
-    clientFilePaths: [getClientFilePath(model)],
     hasLro: hasPollingOperations(model),
     monorepoPackageDirectory: model.options?.azureOutputDirectory,
     dependencies,
@@ -182,12 +178,3 @@ function getDescription(model: RLCModel): string {
   }
   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`;
-}

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

@@ -8,80 +8,6 @@ import { getClientName } from "../helpers/name-constructors.js";
 import { NameType, normalizeName } from "../helpers/name-utils.js";
 import { RLCModel } from "../interfaces.js";
 
-const azureReadmeRLCTemplate = `# {{ clientDescriptiveName }} library for JavaScript
-
-{{ description }}
-
-{{#if azureArm}}
-**If you are not familiar with our REST client, please spend 5 minutes to take a look at {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library, the REST client provides a light-weighted & developer friendly way to call azure rest api
-{{else}}
-**Please rely heavily on {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
-{{/if}}
-
-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
-
-### Prerequisites
-
-- You must have an [Azure subscription](https://azure.microsoft.com/free/){{#if dependencyLink}} and follow [these]({{ dependencyLink }}) instructions{{/if}} to use this package.
-
-### Install the \`{{ clientPackageName }}\` package
-
-Install the {{ clientDescriptiveName }} REST client library for JavaScript with \`npm\`:
-
-\`\`\`bash
-npm install {{ clientPackageName }}
-\`\`\`
-
-### Create and authenticate a \`{{ clientClassName }}\`
-
-To use a [Microsoft Entra token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
-provide an instance of the desired credential type obtained from the
-[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
-
-To authenticate with Microsoft Entra ID, you must first \`npm\` install [\`@azure/identity\`](https://www.npmjs.com/package/@azure/identity) {{#if dependencyLink}}and
-[{{dependencyDescription }}]({{ dependencyLink }}){{/if}}
-
-After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from \`@azure/identity\` to use.
-As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
-can be used to authenticate the client.
-
-## Troubleshooting
-
-### Logging
-
-Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the \`AZURE_LOG_LEVEL\` environment variable to \`info\`. Alternatively, logging can be enabled at runtime by calling \`setLogLevel\` in the \`@azure/logger\`:
-
-\`\`\`ts {{#if generateTest}}snippet:SetLogLevel{{/if}}
-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](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
-`;
-
 const azureReadmeModularTemplate = `# {{ clientDescriptiveName }} library for JavaScript
 
 This package contains an isomorphic SDK (runs both in Node.js and in browsers) for {{ clientDescriptiveName }}.
@@ -346,11 +272,7 @@ interface Metadata {
 export function buildReadmeFile(model: RLCModel) {
   const metadata = createMetadata(model) ?? {};
   const readmeFileContents = hbs.compile(
-    model.options
-      ? model.options.isModularLibrary
-        ? azureReadmeModularTemplate
-        : azureReadmeRLCTemplate
-      : nonBrandedReadmeTemplate,
+    model.options ? azureReadmeModularTemplate : nonBrandedReadmeTemplate,
     { noEscape: true },
   );
   return {
@@ -407,16 +329,7 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     return;
   }
   // const packageDetails = model.options.packageDetails;
-  const {
-    packageDetails,
-    azureOutputDirectory,
-    productDocLink,
-    dependencyInfo,
-    multiClient,
-    batch,
-    serviceInfo,
-    isTypeSpecTest,
-  } = model.options;
+  const { packageDetails, azureOutputDirectory, serviceInfo, isTypeSpecTest } = model.options;
 
   const azureHuh =
     packageDetails?.scopeName === "azure" || packageDetails?.scopeName === "azure-rest";
@@ -444,11 +357,8 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     serviceName,
     clientClassName,
     clientPackageName: clientPackageName,
-    clientDescriptiveName: model.options.isModularLibrary
-      ? `${serviceName} client`
-      : `${serviceName} REST client`,
+    clientDescriptiveName: `${serviceName} client`,
     description: serviceInfo?.description ?? packageDetails.description,
-    serviceDocURL: productDocLink,
     packageSourceURL: packageSourceURL,
     packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
     samplesURL:
@@ -456,9 +366,6 @@ function createMetadata(model: RLCModel): Metadata | undefined {
     apiRefURL: azureHuh
       ? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
       : undefined,
-    dependencyDescription: dependencyInfo?.description,
-    dependencyLink: dependencyInfo?.link,
-    hasMultiClients: multiClient && batch && batch.length > 1,
     azureArm: Boolean(model.options.azureArm),
     azure: azureHuh,
     isReleasablePackage: !isTypeSpecTest,
@@ -477,9 +384,7 @@ function getServiceName(model: RLCModel) {
     model?.options?.packageDetails?.scopeName === "azure" ||
     model?.options?.packageDetails?.scopeName === "azure-rest";
   const libraryName = model.libraryName;
-  const serviceTitle = model.options?.isModularLibrary
-    ? model.libraryName
-    : (model.options?.serviceInfo?.title ?? model.libraryName);
+  const serviceTitle = model.libraryName;
   const batch = model?.options?.batch,
     packageDetails = model?.options?.packageDetails;
   let simpleServiceName =

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

@@ -6,7 +6,6 @@ import { getCommonPackageScripts, getPackageCommonInfo } from "./package-common.
 
 export interface AzureMonorepoInfoConfig extends AzurePackageInfoConfig {
   monorepoPackageDirectory?: string;
-  clientFilePaths: string[];
   clientContextPaths?: string[];
 }
 
@@ -128,7 +127,7 @@ function getSampleMetadata({ name, version, withSamples }: AzureMonorepoInfoConf
 
 function getAzureMonorepoScripts(config: AzureMonorepoInfoConfig) {
   const esmScripts = getEsmScripts();
-  const skipLinting = config.azureArm && config.isModularLibrary;
+  const skipLinting = config.azureArm;
   const buildSampleScripts = config.azureArm
     ? "tsc -p config/tsconfig.samples.json && dev-tool samples publish -f"
     : "tsc -p config/tsconfig.samples.json";
@@ -168,7 +167,7 @@ function getMetadataInfo(config: AzureMonorepoInfoConfig) {
   const metadata: Record<string, any> = {
     constantPaths: [],
   };
-  const paths = config.isModularLibrary ? config.clientContextPaths : config.clientFilePaths;
+  const paths = config.clientContextPaths;
   for (const path of paths ?? []) {
     metadata["constantPaths"].push({
       path: path,

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

@@ -11,7 +11,6 @@ export interface PackageCommonInfoConfig {
   exports?: Record<string, any>;
   dependencies?: Record<string, string>;
   azureArm?: boolean;
-  isModularLibrary?: boolean;
   /**
    * When true, generates React Native build targets (dist/react-native, exports condition).
    * Defaults to false.

package/src/rlc-common/test/build-snippets.ts

@@ -17,7 +17,6 @@ export function buildSnippets(model: RLCModel, clientName?: string) {
       content: hbs.compile(snippetsContent, { noEscape: true })({
         clientClassName: clientName ? clientName : getClientName(model),
         azureArm: model.options?.azureArm,
-        isModularLibrary: model.options.isModularLibrary,
         hasSubscriptionId: model.options.hasSubscriptionId,
       }),
     };

package/src/rlc-common/test/template.ts

@@ -182,15 +182,12 @@ describe("My test", () => {
 `;
 
 export const snippetsContent = `
-{{#if isModularLibrary}}
 import { {{ clientClassName }} } from "../src/index.js";
 import { DefaultAzureCredential, InteractiveBrowserCredential } from "@azure/identity";
-{{/if}}
 import { setLogLevel } from "@azure/logger";
 import { describe, it } from "vitest";
 
 describe("snippets", () => {
-{{#if isModularLibrary}}
   it("ReadmeSampleCreateClient_Node", async () => {
     {{#if azureArm}}
     {{#if hasSubscriptionId}}
@@ -224,7 +221,6 @@ describe("snippets", () => {
     const client = new {{ clientClassName }}("<endpoint>", credential);
     {{/if}}
   });
-  {{/if}}
 
   it("SetLogLevel", async () => {
     setLogLevel("info");

package/src/transform/transform-schemas.ts

@@ -78,7 +78,7 @@ export function transformSchemas(client: SdkClient, dpgContext: SdkContext) {
     }
   }
   function transformHostParameters() {
-    const serviceNs = getDefaultService(program, dpgContext.rlcOptions?.isModularLibrary)?.type;
+    const serviceNs = getDefaultService(program)?.type;
     if (serviceNs) {
       const host = getServers(program, serviceNs);
       if (host && host?.[0] && host?.[0]?.parameters) {

package/src/transform/transform.ts

@@ -18,7 +18,6 @@ import {
   RLCOptions,
   Schema,
   SchemaContext,
-  transformSampleGroups,
   UrlInfo,
 } from "../rlc-common/index.js";
 import { SdkContext } from "../utils/interfaces.js";
@@ -53,12 +52,7 @@ export async function transformRLCModel(
       : "",
   );
   const libraryName = normalizeName(
-    options.batch && (options.isModularLibrary || options.batch.length > 1)
-      ? client.name
-      : (options?.title ??
-          client.name ??
-          getDefaultService(program, options.isModularLibrary)?.title ??
-          ""),
+    options.batch ? client.name : (client.name ?? getDefaultService(program)?.title ?? ""),
     NameType.Class,
   );
   const importSet = initInternalImports();
@@ -95,13 +89,9 @@ export async function transformRLCModel(
     },
     rlcSourceDir,
   };
-  model.sampleGroups = transformSampleGroups(
-    model,
-    options?.generateSample === true /* Enable mock sample content if generateSample === true */,
-  );
-  options.generateSample =
-    (options.generateSample === true || options.generateSample === undefined) &&
-    (model.sampleGroups ?? []).length > 0;
+  // RLC sample generation has been removed; modular samples are emitted separately,
+  // so the RLC model never carries sample groups.
+  options.generateSample = false;
   return model;
 }