support title config for typespec generation (#2941)

* support title config for typespec generation * update * format * update * add ut * fix yaml config missing * update ut * fix ci * update * update * update sample ut * fix ci * ut * Update emitUtil.ts * Update README.md * Update README.md * Update README.md * resolve comment * Update buildRootIndex.ts --------- Co-authored-by: Qiaoqiao Zhang <qiaozha@microsoft.com> Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
Azure · Jan 13, 2025 · 5fa4524 · 5fa4524
1 parent a4c8ba4
commit 5fa4524
Show file tree

Hide file tree

Showing 42 changed files with 479 additions and 109 deletions.
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/packages/rlc-common/src/interfaces.ts b/packages/rlc-common/src/interfaces.ts
@@ -251,6 +251,7 @@ export interface RLCOptions {
   clearOutputFolder?: boolean;
   ignorePropertyNameNormalize?: boolean;
   compatibilityQueryMultiFormat?: boolean;
+  typespecTitleMap?: Record<string, string>;
 }
 
 export interface ServiceInfo {

diff --git a/...ment/generated/typespec-ts/sdk/test/arm-test/review/arm-networkanalytics.api.md b/...ment/generated/typespec-ts/sdk/test/arm-test/review/arm-networkanalytics.api.md
@@ -430,8 +430,8 @@ export interface ManagedServiceIdentityV4 {
 }
 
 // @public (undocumented)
-export class NetworkAnalyticsClient {
-    constructor(credential: TokenCredential, subscriptionId: string, options?: NetworkAnalyticsClientOptionalParams);
+export class NetworkAnalyticsApi {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: NetworkAnalyticsApiOptionalParams);
     readonly dataProducts: DataProductsOperations;
     readonly dataProductsCatalogs: DataProductsCatalogsOperations;
     readonly dataTypes: DataTypesOperations;
@@ -440,7 +440,7 @@ export class NetworkAnalyticsClient {
 }
 
 // @public
-export interface NetworkAnalyticsClientOptionalParams extends ClientOptions {
+export interface NetworkAnalyticsApiOptionalParams extends ClientOptions {
     apiVersion?: string;
 }
 
@@ -507,7 +507,7 @@ export interface Resource {
 }
 
 // @public
-export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: NetworkAnalyticsClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: NetworkAnalyticsApi, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
 
 // @public (undocumented)
 export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {

diff --git a/...ment/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsAddUserRoleSample.ts b/...ment/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsAddUserRoleSample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsAddUserRoleMaximumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   const result = await client.dataProducts.addUserRole(
     "aoiresourceGroupName",
     "dataproduct01",

diff --git a/...anagement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsCreateSample.ts b/...anagement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsCreateSample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsCreateMaximumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   const result = await client.dataProducts.create(
     "aoiresourceGroupName",
     "dataproduct01",

diff --git a/...anagement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsDeleteSample.ts b/...anagement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsDeleteSample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsDeleteMaximumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   await client.dataProducts.delete("aoiresourceGroupName", "dataproduct01");
 }
 

diff --git a/...spec-ts/sdk/test/arm-test/samples-dev/dataProductsGenerateStorageAccountSasTokenSample.ts b/...spec-ts/sdk/test/arm-test/samples-dev/dataProductsGenerateStorageAccountSasTokenSample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsGenerateStorageAccountSasTokenMaximumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   const result = await client.dataProducts.generateStorageAccountSasToken(
     "aoiresourceGroupName",
     "dataproduct01",

diff --git a/...erated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsListByResourceGroupSample.ts b/...erated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsListByResourceGroupSample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsListByResourceGroupMaximumSetGenGeneratedByMinimumSetRuleMinimumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   const resArray = new Array();
   for await (let item of client.dataProducts.listByResourceGroup(
     "aoiresourceGroupName",

diff --git a/...gement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsRotateKeySample.ts b/...gement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsRotateKeySample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsRotateKeyMaximumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   await client.dataProducts.rotateKey("aoiresourceGroupName", "dataproduct01", {
     keyVaultUrl: "https://myKeyVault.vault.azure.net",
   });

diff --git a/...anagement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsUpdateSample.ts b/...anagement/generated/typespec-ts/sdk/test/arm-test/samples-dev/dataProductsUpdateSample.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsClient } from "@azure/arm-networkanalytics";
+import { NetworkAnalyticsApi } from "@azure/arm-networkanalytics";
 import { DefaultAzureCredential } from "@azure/identity";
 
 /**
@@ -13,7 +13,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 async function dataProductsUpdateMaximumSetGen() {
   const credential = new DefaultAzureCredential();
   const subscriptionId = "00000000-0000-0000-0000-00000000000";
-  const client = new NetworkAnalyticsClient(credential, subscriptionId);
+  const client = new NetworkAnalyticsApi(credential, subscriptionId);
   const result = await client.dataProducts.update(
     "aoiresourceGroupName",
     "dataproduct01",

diff --git a/...nalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/dataProducts/index.ts b/...nalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/dataProducts/index.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import {
-  NetworkAnalyticsContext as Client,
+  NetworkAnalyticsApiContext as Client,
   DataProductsAddUserRoleOptionalParams,
   DataProductsCreateOptionalParams,
   DataProductsDeleteOptionalParams,

diff --git a/....Management/generated/typespec-ts/sdk/test/arm-test/src/api/dataProductsCatalogs/index.ts b/....Management/generated/typespec-ts/sdk/test/arm-test/src/api/dataProductsCatalogs/index.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import {
-  NetworkAnalyticsContext as Client,
+  NetworkAnalyticsApiContext as Client,
   DataProductsCatalogsGetOptionalParams,
   DataProductsCatalogsListByResourceGroupOptionalParams,
   DataProductsCatalogsListBySubscriptionOptionalParams,

diff --git a/...rkAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/dataTypes/index.ts b/...rkAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/dataTypes/index.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import {
-  NetworkAnalyticsContext as Client,
+  NetworkAnalyticsApiContext as Client,
   DataTypesCreateOptionalParams,
   DataTypesDeleteDataOptionalParams,
   DataTypesDeleteOptionalParams,

diff --git a/...test/NetworkAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/index.ts b/...test/NetworkAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/index.ts
@@ -2,10 +2,10 @@
 // Licensed under the MIT License.
 
 export {
-  createNetworkAnalytics,
-  NetworkAnalyticsContext,
-  NetworkAnalyticsClientOptionalParams,
-} from "./networkAnalyticsContext.js";
+  createNetworkAnalyticsApi,
+  NetworkAnalyticsApiContext,
+  NetworkAnalyticsApiOptionalParams,
+} from "./networkAnalyticsApiContext.js";
 export {
   DataProductsListBySubscriptionOptionalParams,
   DataProductsListByResourceGroupOptionalParams,

diff --git a/...m-test/src/api/networkAnalyticsContext.ts → ...est/src/api/networkAnalyticsApiContext.ts b/...m-test/src/api/networkAnalyticsContext.ts → ...est/src/api/networkAnalyticsApiContext.ts
@@ -6,7 +6,7 @@ import { KnownVersions } from "../models/models.js";
 import { Client, ClientOptions, getClient } from "@azure-rest/core-client";
 import { TokenCredential } from "@azure/core-auth";
 
-export interface NetworkAnalyticsContext extends Client {
+export interface NetworkAnalyticsApiContext extends Client {
   /** The API version to use for this operation. */
   /** Known values of {@link KnownVersions} that the service accepts. */
   apiVersion: string;
@@ -15,17 +15,17 @@ export interface NetworkAnalyticsContext extends Client {
 }
 
 /** Optional parameters for the client. */
-export interface NetworkAnalyticsClientOptionalParams extends ClientOptions {
+export interface NetworkAnalyticsApiOptionalParams extends ClientOptions {
   /** The API version to use for this operation. */
   /** Known values of {@link KnownVersions} that the service accepts. */
   apiVersion?: string;
 }
 
-export function createNetworkAnalytics(
+export function createNetworkAnalyticsApi(
   credential: TokenCredential,
   subscriptionId: string,
-  options: NetworkAnalyticsClientOptionalParams = {},
-): NetworkAnalyticsContext {
+  options: NetworkAnalyticsApiOptionalParams = {},
+): NetworkAnalyticsApiContext {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? "https://management.azure.com";
   const prefixFromOptions = options?.userAgentOptions?.userAgentPrefix;
@@ -63,5 +63,5 @@ export function createNetworkAnalytics(
     ...clientContext,
     apiVersion,
     subscriptionId,
-  } as NetworkAnalyticsContext;
+  } as NetworkAnalyticsApiContext;
 }
diff --git a/...kAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/operations/index.ts b/...kAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/api/operations/index.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import {
-  NetworkAnalyticsContext as Client,
+  NetworkAnalyticsApiContext as Client,
   OperationsListOptionalParams,
 } from "../index.js";
 import {

diff --git a/...tics.Management/generated/typespec-ts/sdk/test/arm-test/src/classic/dataProducts/index.ts b/...tics.Management/generated/typespec-ts/sdk/test/arm-test/src/classic/dataProducts/index.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsContext } from "../../api/networkAnalyticsContext.js";
+import { NetworkAnalyticsApiContext } from "../../api/networkAnalyticsApiContext.js";
 import {
   listBySubscription,
   listByResourceGroup,
@@ -120,7 +120,7 @@ export interface DataProductsOperations {
   ) => PollerLike<OperationState<DataProduct>, DataProduct>;
 }
 
-function _getDataProducts(context: NetworkAnalyticsContext) {
+function _getDataProducts(context: NetworkAnalyticsApiContext) {
   return {
     listBySubscription: (
       options?: DataProductsListBySubscriptionOptionalParams,
@@ -208,7 +208,7 @@ function _getDataProducts(context: NetworkAnalyticsContext) {
 }
 
 export function getDataProductsOperations(
-  context: NetworkAnalyticsContext,
+  context: NetworkAnalyticsApiContext,
 ): DataProductsOperations {
   return {
     ..._getDataProducts(context),

diff --git a/...agement/generated/typespec-ts/sdk/test/arm-test/src/classic/dataProductsCatalogs/index.ts b/...agement/generated/typespec-ts/sdk/test/arm-test/src/classic/dataProductsCatalogs/index.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsContext } from "../../api/networkAnalyticsContext.js";
+import { NetworkAnalyticsApiContext } from "../../api/networkAnalyticsApiContext.js";
 import {
   listBySubscription,
   listByResourceGroup,
@@ -33,7 +33,7 @@ export interface DataProductsCatalogsOperations {
   ) => Promise<DataProductsCatalog>;
 }
 
-function _getDataProductsCatalogs(context: NetworkAnalyticsContext) {
+function _getDataProductsCatalogs(context: NetworkAnalyticsApiContext) {
   return {
     listBySubscription: (
       options?: DataProductsCatalogsListBySubscriptionOptionalParams,
@@ -50,7 +50,7 @@ function _getDataProductsCatalogs(context: NetworkAnalyticsContext) {
 }
 
 export function getDataProductsCatalogsOperations(
-  context: NetworkAnalyticsContext,
+  context: NetworkAnalyticsApiContext,
 ): DataProductsCatalogsOperations {
   return {
     ..._getDataProductsCatalogs(context),

diff --git a/...alytics.Management/generated/typespec-ts/sdk/test/arm-test/src/classic/dataTypes/index.ts b/...alytics.Management/generated/typespec-ts/sdk/test/arm-test/src/classic/dataTypes/index.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NetworkAnalyticsContext } from "../../api/networkAnalyticsContext.js";
+import { NetworkAnalyticsApiContext } from "../../api/networkAnalyticsApiContext.js";
 import {
   listByDataProduct,
   generateStorageContainerSasToken,
@@ -90,7 +90,7 @@ export interface DataTypesOperations {
   ) => PollerLike<OperationState<DataType>, DataType>;
 }
 
-function _getDataTypes(context: NetworkAnalyticsContext) {
+function _getDataTypes(context: NetworkAnalyticsApiContext) {
   return {
     listByDataProduct: (
       resourceGroupName: string,
@@ -182,7 +182,7 @@ function _getDataTypes(context: NetworkAnalyticsContext) {
 }
 
 export function getDataTypesOperations(
-  context: NetworkAnalyticsContext,
+  context: NetworkAnalyticsApiContext,
 ): DataTypesOperations {
   return {
     ..._getDataTypes(context),