@azure-tools/typespec-ts 0.15.0 → 0.16.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.15.0",
-  "description": "An experimental CADL emitter for TypeScript RLC",
+  "version": "0.16.0",
+  "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
   "author": "Jose Heredia <joheredi@microsoft.com>",
@@ -18,7 +18,7 @@
     "mkdirp": "^2.1.2",
     "eslint": "^8.9.0",
     "mocha": "^9.2.2",
-    "rimraf": "^3.0.2",
+    "rimraf": "^5.0.0",
     "ts-node": "^10.9.1",
     "typescript": "~5.0.0",
     "prettier": "~2.7.1",
@@ -46,7 +46,7 @@
   "dependencies": {
     "prettier": "^2.6.1",
     "tslib": "^2.3.1",
-    "@azure-tools/rlc-common": "^0.15.0",
+    "@azure-tools/rlc-common": "^0.16.0",
     "ts-morph": "^15.1.0",
     "fs-extra": "^11.1.0"
   },
@@ -68,7 +68,7 @@
   },
   "homepage": "https://github.com/Azure/autorest.typescript/tree/main/packages/typespec-ts/",
   "scripts": {
-    "clean": "rimraf ./dist ./cadl-output",
+    "clean": "rimraf ./dist ./typespec-output",
     "build": "tsc -p .",
     "test": "npm run unit-test && npm run integration-test-ci",
     "lint": "eslint src --ext .ts --max-warnings=0",
@@ -84,15 +84,17 @@
     "start-test-server:rlc": "mkdirp -p coverage && npx cadl-ranch serve ./node_modules/@azure-tools/cadl-ranch-specs/http  --coverageFile ./coverage/cadl-ranch-coverage-typescript-rlc.json",
     "start-test-server:modular": "mkdirp -p coverage && npx cadl-ranch serve ./node_modules/@azure-tools/cadl-ranch-specs/http  --coverageFile ./coverage/cadl-ranch-coverage-typescript-modular.json",
     "copy:typespec": "rm -rf temp && mkdirp -p temp && cp -r ./node_modules/@azure-tools/cadl-ranch-specs/http ./temp && cp -r ./test/integration/typespec/* ./temp/http",
-    "generate-and-run:rlc": "npm run generate-cadl-only:rlc && npm run integration-test:alone:rlc && npm run stop-test-server",
-    "generate-and-run:modular": "npm run generate-cadl-only:modular && npm run integration-test:alone:modular && npm run stop-test-server",
-    "generate-cadl-only": "npm run generate-cadl-only:rlc && npm run generate-cadl-only:modular",
-    "generate-cadl-only:rlc": "ts-node ./test/commands/gen-cadl-ranch.ts --tag=rlc",
-    "generate-cadl-only:modular": "ts-node ./test/commands/gen-cadl-ranch.ts --tag=modular",
+    "generate-and-run:rlc": "npm run generate-tsp-only:rlc && npm run integration-test:alone:rlc && npm run stop-test-server",
+    "generate-and-run:modular": "npm run generate-tsp-only:modular && npm run integration-test:alone:modular && npm run stop-test-server",
+    "generate-tsp-only": "npm run generate-tsp-only:rlc && npm run generate-tsp-only:modular",
+    "generate-tsp-only:rlc": "ts-node ./test/commands/gen-cadl-ranch.ts --tag=rlc",
+    "generate-tsp-only:modular": "ts-node ./test/commands/gen-cadl-ranch.ts --tag=modular",
     "integration-test:alone": "npm run integration-test:alone:rlc && npm run integration-test:alone:modular",
     "integration-test:alone:rlc": "cross-env TS_NODE_PROJECT=tsconfig.test.json mocha -r ts-node/register --experimental-specifier-resolution=node --timeout 4000 ./test/integration/*.spec.ts",
     "integration-test:alone:modular": "cross-env TS_NODE_PROJECT=tsconfig.test.json mocha -r ts-node/register --experimental-specifier-resolution=node --timeout 4000 ./test/modularIntegration/*.spec.ts",
     "stop-test-server": "npx cadl-ranch server stop",
-    "unit-test": "cross-env TS_NODE_PROJECT=tsconfig.json mocha -r ts-node/register --experimental-specifier-resolution=node --experimental-modules=true  --timeout 4000 './test/unit/**/*.spec.ts'"
+    "unit-test": "npm run unit-test:rlc && npm run unit-test:modular",
+    "unit-test:rlc": "cross-env TS_NODE_PROJECT=tsconfig.json mocha -r ts-node/register --experimental-specifier-resolution=node --experimental-modules=true  --timeout 4000 './test/unit/**/*.spec.ts'",
+    "unit-test:modular": "cross-env TS_NODE_PROJECT=tsconfig.json mocha -r ts-node/register --experimental-specifier-resolution=node --experimental-modules=true  --no-timeout './test/modularUnit/**/*.spec.ts'"
   }
 }

package/src/index.ts

@@ -28,8 +28,6 @@ import {
   buildSerializeHelper,
   buildLogger,
   RLCOptions,
-  normalizeName,
-  NameType,
   hasUnexpectedHelper,
   RLCModel
 } from "@azure-tools/rlc-common";
@@ -53,6 +51,7 @@ import { join } from "path";
 import { GenerationDirDetail, SdkContext } from "./utils/interfaces.js";
 import { transformRLCOptions } from "./transform/transfromRLCOptions.js";
 import { ModularCodeModel } from "./modular/modularCodeModel.js";
+import { getClientName } from "@azure-tools/rlc-common";
 
 export * from "./lib.js";
 
@@ -121,7 +120,10 @@ export async function $onEmit(context: EmitContext) {
       const rlcModels = await transformRLCModel(client, dpgContext);
       rlcCodeModels.push(rlcModels);
       serviceNameToRlcModelsMap.set(client.service.name, rlcModels);
-      needUnexpectedHelper.set(client.name, hasUnexpectedHelper(rlcModels));
+      needUnexpectedHelper.set(
+        getClientName(rlcModels),
+        hasUnexpectedHelper(rlcModels)
+      );
 
       await emitModels(rlcModels, program);
       await emitContentByBuilder(program, buildClientDefinitions, rlcModels);
@@ -144,9 +146,15 @@ export async function $onEmit(context: EmitContext) {
       const modularSourcesRoot =
         dpgContext.generationPathDetail?.modularSourcesDir ?? "src";
       const project = new Project();
-      modularCodeModel = emitCodeModel(context, serviceNameToRlcModelsMap, {
-        casing: "camel"
-      });
+      modularCodeModel = emitCodeModel(
+        dpgContext,
+        serviceNameToRlcModelsMap,
+        modularSourcesRoot,
+        project,
+        {
+          casing: "camel"
+        }
+      );
       const rootIndexFile = project.createSourceFile(
         `${modularSourcesRoot}/index.ts`,
         "",
@@ -155,59 +163,24 @@ export async function $onEmit(context: EmitContext) {
         }
       );
       for (const subClient of modularCodeModel.clients) {
-        let subfolder = "";
-        if (modularCodeModel.clients.length > 1) {
-          subfolder = normalizeName(
-            subClient.name.replace("Client", ""),
-            NameType.File
-          );
-        }
-
-        buildModels(modularCodeModel, project, modularSourcesRoot, subfolder);
-        buildModelsOptions(subClient, project, modularSourcesRoot, subfolder);
+        buildModels(modularCodeModel, subClient);
+        buildModelsOptions(modularCodeModel, subClient);
         const hasClientUnexpectedHelper =
-          needUnexpectedHelper.get(
-            subClient.rlcClientName.replace("Context", "Client")
-          ) ?? false;
+          needUnexpectedHelper.get(subClient.rlcClientName) ?? false;
         buildOperationFiles(
           dpgContext,
+          modularCodeModel,
           subClient,
-          project,
-          modularSourcesRoot,
-          subfolder,
           hasClientUnexpectedHelper
         );
-        buildClientContext(
-          dpgContext,
-          subClient,
-          project,
-          modularSourcesRoot,
-          subfolder
-        );
-        buildSubpathIndexFile(project, modularSourcesRoot, "models", subfolder);
-        buildSubpathIndexFile(project, modularSourcesRoot, "api", subfolder);
-        buildClassicalClient(
-          dpgContext,
-          subClient,
-          project,
-          modularSourcesRoot,
-          subfolder
-        );
+        buildClientContext(dpgContext, modularCodeModel, subClient);
+        buildSubpathIndexFile(modularCodeModel, subClient, "models");
+        buildSubpathIndexFile(modularCodeModel, subClient, "api");
+        buildClassicalClient(dpgContext, modularCodeModel, subClient);
         if (modularCodeModel.clients.length > 1) {
-          buildSubClientIndexFile(
-            subClient,
-            project,
-            modularSourcesRoot,
-            subfolder
-          );
+          buildSubClientIndexFile(modularCodeModel, subClient);
         }
-        buildRootIndex(
-          subClient,
-          project,
-          rootIndexFile,
-          modularSourcesRoot,
-          subfolder
-        );
+        buildRootIndex(modularCodeModel, subClient, rootIndexFile);
       }
 
       removeUnusedInterfaces(project);

package/src/lib.ts

@@ -3,7 +3,7 @@
 
 import {
   paramMessage,
-  createCadlLibrary,
+  createTypeSpecLibrary,
   JSONSchemaType
 } from "@typespec/compiler";
 import { RLCOptions } from "@azure-tools/rlc-common";
@@ -49,7 +49,7 @@ export const RLCOptionsSchema: JSONSchemaType<RLCOptions> = {
     generateSample: { type: "boolean", nullable: true },
     azureSdkForJs: { type: "boolean", nullable: true },
     azureOutputDirectory: { type: "string", nullable: true },
-    isCadlTest: { type: "boolean", nullable: true },
+    isTypeSpecTest: { type: "boolean", nullable: true },
     title: { type: "string", nullable: true },
     dependencyInfo: {
       type: "object",
@@ -189,7 +189,7 @@ const libDef = {
   }
 } as const;
 
-export const $lib = createCadlLibrary(libDef);
+export const $lib = createTypeSpecLibrary(libDef);
 export const { reportDiagnostic } = $lib;
 
 export const prettierTypeScriptOptions: Options = {

package/src/modular/buildClassicalClient.ts

@@ -3,7 +3,6 @@ import {
   FunctionDeclarationStructure,
   MethodDeclarationStructure,
   OptionalKind,
-  Project,
   Scope,
   SourceFile,
   StructureKind
@@ -12,24 +11,24 @@ import { toCamelCase } from "../utils/casingUtils.js";
 import { getClientParameters } from "./helpers/clientHelpers.js";
 import { getClientName } from "./helpers/namingHelpers.js";
 import { getOperationFunction } from "./helpers/operationHelpers.js";
-import { Client } from "./modularCodeModel.js";
+import { Client, ModularCodeModel } from "./modularCodeModel.js";
 import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
 import { getDocsFromDescription } from "./helpers/docsHelpers.js";
 import { SdkContext } from "../utils/interfaces.js";
 
 export function buildClassicalClient(
   dpgContext: SdkContext,
-  client: Client,
-  project: Project,
-  srcPath: string,
-  subfolder: string
+  codeModel: ModularCodeModel,
+  client: Client
 ) {
   const { description } = client;
   const modularClientName = getClientName(client);
   const classicalClientname = `${getClientName(client)}Client`;
   const params = getClientParameters(client);
+  const srcPath = codeModel.modularOptions.sourceRoot;
+  const subfolder = client.subfolder ?? "";
 
-  const clientFile = project.createSourceFile(
+  const clientFile = codeModel.project.createSourceFile(
     `${srcPath}/${
       subfolder !== "" ? subfolder + "/" : ""
     }${classicalClientname}.ts`
@@ -116,10 +115,12 @@ function importAllModels(
 
   const exported = [...apiModels.getExportedDeclarations().keys()];
 
-  clientFile.addImportDeclaration({
-    moduleSpecifier: `./models/models.js`,
-    namedImports: exported
-  });
+  if (exported.length > 0) {
+    clientFile.addImportDeclaration({
+      moduleSpecifier: `./models/models.js`,
+      namedImports: exported
+    });
+  }
 
   const apiModelsOptions = project.getSourceFile(
     `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}models/options.ts`
@@ -151,6 +152,10 @@ function buildClientOperationGroups(
   clientClass: ClassDeclaration,
   subfolder: string
 ) {
+  const operationMap = new Map<
+    OptionalKind<FunctionDeclarationStructure>,
+    string | undefined
+  >();
   for (const operationGroup of client.operationGroups) {
     const operationGroupName = toCamelCase(operationGroup.propertyName);
     let clientType = "Client";
@@ -158,9 +163,11 @@ function buildClientOperationGroups(
       clientType = `Client.${clientClass.getName()}`;
     }
     const operationDeclarations: OptionalKind<FunctionDeclarationStructure>[] =
-      operationGroup.operations.map((operation) =>
-        getOperationFunction(operation, clientType)
-      );
+      operationGroup.operations.map((operation) => {
+        const declarations = getOperationFunction(operation, clientType);
+        operationMap.set(declarations, operation.oriName);
+        return declarations;
+      });
 
     if (operationGroupName && operationGroupName !== "") {
       clientClass.addProperty({
@@ -168,7 +175,7 @@ function buildClientOperationGroups(
         initializer: `
       {
         ${operationDeclarations.map((d) => {
-          return `${d.name}: (${d.parameters
+          return `${getClassicalMethodName(d)}: (${d.parameters
             ?.filter((p) => p.name !== "context")
             .map(
               (p) => p.name + (p.name === "options" ? "?" : "") + ": " + p.type
@@ -186,7 +193,7 @@ function buildClientOperationGroups(
         operationDeclarations.map((d) => {
           const method: MethodDeclarationStructure = {
             docs: d.docs,
-            name: d.name ?? "FIXME",
+            name: getClassicalMethodName(d),
             kind: StructureKind.Method,
             returnType: d.returnType,
             parameters: d.parameters?.filter((p) => p.name !== "context"),
@@ -203,4 +210,10 @@ function buildClientOperationGroups(
       );
     }
   }
+
+  function getClassicalMethodName(
+    declaration: OptionalKind<FunctionDeclarationStructure>
+  ) {
+    return operationMap.get(declaration) ?? declaration.name ?? "FIXME";
+  }
 }

package/src/modular/buildClientContext.ts

@@ -1,8 +1,8 @@
-import { FunctionDeclaration, Project, SourceFile } from "ts-morph";
+import { FunctionDeclaration, SourceFile } from "ts-morph";
 import { getClientParameters } from "./helpers/clientHelpers.js";
 import { importCredential } from "./helpers/credentialHelpers.js";
 import { getClientName } from "./helpers/namingHelpers.js";
-import { Client, Parameter } from "./modularCodeModel.js";
+import { Client, ModularCodeModel, Parameter } from "./modularCodeModel.js";
 import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
 import { getDocsFromDescription } from "./helpers/docsHelpers.js";
 import { importModels } from "./buildOperations.js";
@@ -13,21 +13,20 @@ import { SdkContext } from "../utils/interfaces.js";
  */
 export function buildClientContext(
   dpgContext: SdkContext,
-  client: Client,
-  project: Project,
-  srcPath: string = "src",
-  subfolder: string = ""
+  codeModel: ModularCodeModel,
+  client: Client
 ): SourceFile {
-  const { description, parameters } = client;
+  const { description, parameters, subfolder } = client;
   const name = getClientName(client);
-  const clientContextFile = project.createSourceFile(
+  const srcPath = codeModel.modularOptions.sourceRoot;
+  const clientContextFile = codeModel.project.createSourceFile(
     `${srcPath}/${
       subfolder && subfolder !== "" ? subfolder + "/" : ""
     }/api/${name}Context.ts`
   );
 
   let factoryFunction;
-  importModels(srcPath, clientContextFile, project, subfolder);
+  importModels(srcPath, clientContextFile, codeModel.project, subfolder);
   clientContextFile.addImportDeclaration({
     moduleSpecifier: "@azure-rest/core-client",
     namedImports: ["ClientOptions"]