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

package/src/rlc-common/buildClientDefinitions.ts

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import * as path from "path";
 import {
   CallSignatureDeclarationStructure,
   InterfaceDeclarationStructure,
@@ -8,41 +9,32 @@ import {
   Project,
   SourceFile,
   StructureKind,
-  Writers
+  Writers,
 } from "ts-morph";
-import * as path from "path";
 
+import { REST_CLIENT_RESERVED } from "./buildMethodShortcuts.js";
+import { getImportSpecifier } from "./helpers/importsUtil.js";
+import { getClientName, getImportModuleName } from "./helpers/nameConstructors.js";
+import { CasingConvention, NameType, normalizeName, pascalCase } from "./helpers/nameUtils.js";
 import {
   buildMethodDefinitions,
   getGeneratedWrapperTypes,
-  getPathParamDefinitions
+  getPathParamDefinitions,
 } from "./helpers/operationHelpers.js";
-import { PathMetadata, Paths, RLCModel } from "./interfaces.js";
 import { generateMethodShortcuts } from "./helpers/shortcutMethods.js";
-import { REST_CLIENT_RESERVED } from "./buildMethodShortcuts.js";
-import {
-  CasingConvention,
-  NameType,
-  normalizeName
-} from "./helpers/nameUtils.js";
-import { pascalCase } from "./helpers/nameUtils.js";
-import {
-  getClientName,
-  getImportModuleName
-} from "./helpers/nameConstructors.js";
-import { getImportSpecifier } from "./helpers/importsUtil.js";
+import { PathMetadata, Paths, RLCModel } from "./interfaces.js";
 
 export function buildClientDefinitions(model: RLCModel) {
   const options = {
     importedParameters: new Set<string>(),
     importedResponses: new Set<string>(),
-    clientImports: new Set<string>()
+    clientImports: new Set<string>(),
   };
   const project = new Project();
   const srcPath = model.srcPath;
   const filePath = path.join(srcPath, `clientDefinitions.ts`);
   const clientDefinitionsFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true
+    overwrite: true,
   });
 
   // Get all paths
@@ -66,8 +58,8 @@ export function buildClientDefinitions(model: RLCModel) {
     callSignatures: getPathFirstRoutesInterfaceDefinition(
       pathDictionary,
       clientDefinitionsFile,
-      options
-    )
+      options,
+    ),
   });
 
   const clientInterfaceName = getClientName(model);
@@ -77,19 +69,14 @@ export function buildClientDefinitions(model: RLCModel) {
     type: Writers.intersectionType(
       "Client",
       Writers.objectType({
-        properties: [
-          { name: "path", type: "Routes" },
-          ...shortcutsInOperationGroup
-        ]
+        properties: [{ name: "path", type: "Routes" }, ...shortcutsInOperationGroup],
       }),
       // If the length of shortcuts in operation group and all shortcutsInOperationGroup
       // is the same, then we don't have any operations at the client level
       // Otherwise we need to make the client interface name an union with the
       // definition of all client level shortcut methods
-      ...(shortcutsInOperationGroup.length !== shortcuts.length
-        ? [`ClientOperations`]
-        : [])
-    )
+      ...(shortcutsInOperationGroup.length !== shortcuts.length ? [`ClientOperations`] : []),
+    ),
   });
 
   if (options.importedParameters.size) {
@@ -98,8 +85,8 @@ export function buildClientDefinitions(model: RLCModel) {
       namedImports: [...options.importedParameters],
       moduleSpecifier: getImportModuleName(
         { cjsName: "./parameters", esModulesName: "./parameters.js" },
-        model
-      )
+        model,
+      ),
     });
   }
 
@@ -109,24 +96,19 @@ export function buildClientDefinitions(model: RLCModel) {
       namedImports: [...options.importedResponses],
       moduleSpecifier: getImportModuleName(
         { cjsName: "./responses", esModulesName: "./responses.js" },
-        model
-      )
+        model,
+      ),
     });
   }
 
-  if (
-    (model.importInfo.internalImports.rlcClientDefinition.importsSet?.size ??
-      0) > 0
-  ) {
+  if ((model.importInfo.internalImports.rlcClientDefinition.importsSet?.size ?? 0) > 0) {
     clientDefinitionsFile.addImportDeclaration({
       isTypeOnly: true,
-      namedImports: Array.from(
-        model.importInfo.internalImports.rlcClientDefinition.importsSet!
-      ),
+      namedImports: Array.from(model.importInfo.internalImports.rlcClientDefinition.importsSet!),
       moduleSpecifier: getImportModuleName(
         { cjsName: "./models", esModulesName: "./models.js" },
-        model
-      )
+        model,
+      ),
     });
   }
 
@@ -136,11 +118,8 @@ export function buildClientDefinitions(model: RLCModel) {
     {
       isTypeOnly: true,
       namedImports: [...options.clientImports],
-      moduleSpecifier: getImportSpecifier(
-        "restClient",
-        model.importInfo.runtimeImports
-      )
-    }
+      moduleSpecifier: getImportSpecifier("restClient", model.importInfo.runtimeImports),
+    },
   ]);
 
   return { path: filePath, content: clientDefinitionsFile.getFullText() };
@@ -153,7 +132,7 @@ function getPathFirstRoutesInterfaceDefinition(
     importedParameters: Set<string>;
     importedResponses: Set<string>;
     clientImports: Set<string>;
-  }
+  },
 ): CallSignatureDeclarationStructure[] {
   const operationGroupCount = getOperationGroupCount(paths);
 
@@ -170,40 +149,26 @@ function getPathFirstRoutesInterfaceDefinition(
       }
       for (const method of methods) {
         options.importedParameters.add(method.optionsName);
-        method.returnType
-          .split(" | ")
-          .forEach((item) => options.importedResponses.add(item));
+        method.returnType.split(" | ").forEach((item) => options.importedResponses.add(item));
       }
     }
-    generatePathFirstRouteMethodsDefinition(
-      pathMetadata,
-      operationGroupCount,
-      sourcefile
-    );
+    generatePathFirstRouteMethodsDefinition(pathMetadata, operationGroupCount, sourcefile);
     const pathParams = pathMetadata.pathParameters;
     getGeneratedWrapperTypes(pathParams).forEach((p) =>
-      options.importedParameters.add(p.name ?? p.type)
+      options.importedParameters.add(p.name ?? p.type),
     );
     signatures.push({
       docs: [
         `Resource for '${key
+          .replace(/\\/g, "\\\\")
           .replace(/}/g, "\\}")
-          .replace(
-            /{/g,
-            "\\{"
-          )}' has methods for the following verbs: ${Object.keys(
-          pathMetadata.methods
-        ).join(", ")}`
-      ],
-      parameters: [
-        { name: "path", type: `"${key}"` },
-        ...getPathParamDefinitions(pathParams)
+          .replace(/{/g, "\\{")}' has methods for the following verbs: ${Object.keys(
+          pathMetadata.methods,
+        ).join(", ")}`,
       ],
-      returnType: getOperationReturnTypeName(
-        pathMetadata,
-        getOperationGroupCount(paths)
-      ),
-      kind: StructureKind.CallSignature
+      parameters: [{ name: "path", type: `"${key}"` }, ...getPathParamDefinitions(pathParams)],
+      returnType: getOperationReturnTypeName(pathMetadata, getOperationGroupCount(paths)),
+      kind: StructureKind.CallSignature,
     });
   }
   return signatures;
@@ -220,16 +185,12 @@ function getOperationGroupCount(paths: Paths) {
 
 function getOperationReturnTypeName(
   { operationGroupName, name }: PathMetadata,
-  operationGroupCount: number
+  operationGroupCount: number,
 ) {
-  if (
-    operationGroupCount > 1 &&
-    operationGroupName &&
-    operationGroupName !== "Client"
-  ) {
+  if (operationGroupCount > 1 && operationGroupName && operationGroupName !== "Client") {
     return normalizeName(
       `${pascalCase(operationGroupName)}${pascalCase(name)}`,
-      NameType.Interface
+      NameType.Interface,
     );
   }
 
@@ -239,13 +200,13 @@ function getOperationReturnTypeName(
 function generatePathFirstRouteMethodsDefinition(
   path: PathMetadata,
   operationGroupCount: number,
-  file: SourceFile
+  file: SourceFile,
 ): void {
   const methodDefinitions = buildMethodDefinitions(path.methods);
   const interfaceDef = {
     methods: methodDefinitions,
     name: getOperationReturnTypeName(path, operationGroupCount),
-    isExported: true
+    isExported: true,
   };
   file.addInterface(interfaceDef);
 }
@@ -259,20 +220,16 @@ function getShortcutName(interfaceName: string) {
     NameType.OperationGroup,
     true,
     REST_CLIENT_RESERVED,
-    CasingConvention.Camel
+    CasingConvention.Camel,
   );
 
   return {
     name: clientProperty,
-    type: interfaceName
+    type: interfaceName,
   };
 }
 
 function shouldKeepSuffix(name: string) {
-  const reservedNames = [
-    "pipelineOperations",
-    "pathOperations",
-    "pathUncheckedOperations"
-  ];
+  const reservedNames = ["pipelineOperations", "pathOperations", "pathUncheckedOperations"];
   return reservedNames.some((r) => r.toLowerCase() === name.toLowerCase());
 }

package/src/rlc-common/buildIndexFile.ts

@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import * as path from "path";
 import { Project, SourceFile } from "ts-morph";
+import { getImportModuleName } from "./helpers/nameConstructors.js";
 import { NameType, normalizeName } from "./helpers/nameUtils.js";
 import {
   hasCsvCollection,
@@ -13,12 +15,10 @@ import {
   hasPollingOperations,
   hasSsvCollection,
   hasTsvCollection,
-  hasUnexpectedHelper
+  hasUnexpectedHelper,
 } from "./helpers/operationHelpers.js";
 import { isAzurePackage } from "./helpers/packageUtil.js";
 import { RLCModel } from "./interfaces.js";
-import * as path from "path";
-import { getImportModuleName } from "./helpers/nameConstructors.js";
 
 export function buildIndexFile(model: RLCModel) {
   const multiClient = Boolean(model.options?.multiClient),
@@ -27,7 +27,7 @@ export function buildIndexFile(model: RLCModel) {
   const { srcPath } = model;
   const filePath = path.join(srcPath, `index.ts`);
   const indexFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true
+    overwrite: true,
   });
 
   if (!multiClient || !batch || batch?.length === 1) {
@@ -38,7 +38,7 @@ export function buildIndexFile(model: RLCModel) {
   }
   return {
     path: filePath,
-    content: indexFile.getFullText()
+    content: indexFile.getFullText(),
   };
 }
 
@@ -52,16 +52,16 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
     namespaceImport: "Parameters",
     moduleSpecifier: getImportModuleName(
       { cjsName: "./parameters", esModulesName: "./parameters.js" },
-      model
-    )
+      model,
+    ),
   });
 
   file.addImportDeclaration({
     namespaceImport: "Responses",
     moduleSpecifier: getImportModuleName(
       { cjsName: "./responses", esModulesName: "./responses.js" },
-      model
-    )
+      model,
+    ),
   });
 
   file.addImportDeclaration({
@@ -69,10 +69,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
     moduleSpecifier: getImportModuleName(
       {
         cjsName: "./clientDefinitions",
-        esModulesName: "./clientDefinitions.js"
+        esModulesName: "./clientDefinitions.js",
       },
-      model
-    )
+      model,
+    ),
   });
 
   const exports = ["Parameters", "Responses", "Client"];
@@ -82,10 +82,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./models",
-          esModulesName: "./models.js"
+          esModulesName: "./models.js",
         },
-        model
-      )
+        model,
+      ),
     });
     exports.push("Models");
   }
@@ -96,10 +96,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./outputModels",
-          esModulesName: "./outputModels.js"
+          esModulesName: "./outputModels.js",
         },
-        model
-      )
+        model,
+      ),
     });
     exports.push("OutputModels");
   }
@@ -110,10 +110,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./paginateHelper",
-          esModulesName: "./paginateHelper.js"
+          esModulesName: "./paginateHelper.js",
         },
-        model
-      )
+        model,
+      ),
     });
     exports.push("PaginateHelper");
   }
@@ -124,10 +124,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./isUnexpected",
-          esModulesName: "./isUnexpected.js"
+          esModulesName: "./isUnexpected.js",
         },
-        model
-      )
+        model,
+      ),
     });
     exports.push("UnexpectedHelper");
   }
@@ -138,10 +138,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./pollingHelper",
-          esModulesName: "./pollingHelper.js"
+          esModulesName: "./pollingHelper.js",
         },
-        model
-      )
+        model,
+      ),
     });
     exports.push("PollingHelper");
   }
@@ -158,10 +158,10 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: "./serializeHelper",
-          esModulesName: "./serializeHelper.js"
+          esModulesName: "./serializeHelper.js",
         },
-        model
-      )
+        model,
+      ),
     });
     exports.push("SerializeHelper");
   }
@@ -171,15 +171,15 @@ function generateRLCIndexForMultiClient(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: `./${moduleName}`,
-          esModulesName: `./${moduleName}.js`
+          esModulesName: `./${moduleName}.js`,
         },
-        model
+        model,
       ),
-      namedExports: [`${createClientFuncName}`, `${clientName}ClientOptions`]
+      namedExports: [`${createClientFuncName}`, `${clientName}ClientOptions`],
     },
     {
-      namedExports: [...exports]
-    }
+      namedExports: [...exports],
+    },
   ]);
 }
 
@@ -192,11 +192,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
     moduleSpecifier: getImportModuleName(
       {
         cjsName: `./${moduleName}`,
-        esModulesName: `./${moduleName}.js`
+        esModulesName: `./${moduleName}.js`,
       },
-      model
+      model,
     ),
-    defaultImport: createClientFuncName
+    defaultImport: createClientFuncName,
   });
 
   file.addExportDeclarations([
@@ -204,38 +204,38 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: `./${moduleName}`,
-          esModulesName: `./${moduleName}.js`
+          esModulesName: `./${moduleName}.js`,
         },
-        model
-      )
+        model,
+      ),
     },
     {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: `./parameters`,
-          esModulesName: `./parameters.js`
+          esModulesName: `./parameters.js`,
         },
-        model
-      )
+        model,
+      ),
     },
     {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: `./responses`,
-          esModulesName: `./responses.js`
+          esModulesName: `./responses.js`,
         },
-        model
-      )
+        model,
+      ),
     },
     {
       moduleSpecifier: getImportModuleName(
         {
           cjsName: `./clientDefinitions`,
-          esModulesName: `./clientDefinitions.js`
+          esModulesName: `./clientDefinitions.js`,
         },
-        model
-      )
-    }
+        model,
+      ),
+    },
   ]);
 
   if (hasUnexpectedHelper(model)) {
@@ -244,11 +244,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./isUnexpected`,
-            esModulesName: `./isUnexpected.js`
+            esModulesName: `./isUnexpected.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -258,11 +258,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./models`,
-            esModulesName: `./models.js`
+            esModulesName: `./models.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -272,11 +272,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./outputModels`,
-            esModulesName: `./outputModels.js`
+            esModulesName: `./outputModels.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -286,11 +286,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./paginateHelper`,
-            esModulesName: `./paginateHelper.js`
+            esModulesName: `./paginateHelper.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -300,11 +300,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./pollingHelper`,
-            esModulesName: `./pollingHelper.js`
+            esModulesName: `./pollingHelper.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -320,11 +320,11 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./serializeHelper`,
-            esModulesName: `./serializeHelper.js`
+            esModulesName: `./serializeHelper.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
 
@@ -332,13 +332,13 @@ function generateRLCIndex(file: SourceFile, model: RLCModel) {
     file.addExportDeclarations([
       {
         moduleSpecifier: "@azure/core-rest-pipeline",
-        namedExports: ["RestError", "isRestError"]
-      }
+        namedExports: ["RestError", "isRestError"],
+      },
     ]);
   }
 
   file.addExportAssignment({
     expression: createClientFuncName,
-    isExportEquals: false
+    isExportEquals: false,
   });
 }