@azure-tools/typespec-ts 0.54.0-dev.5 → 0.54.0-dev.7

package/src/rlc-common/buildResponseTypes.ts

@@ -1,25 +1,21 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import * as path from "path";
 import {
   InterfaceDeclarationStructure,
   OptionalKind,
   Project,
   PropertySignatureStructure,
-  StructureKind
+  StructureKind,
 } from "ts-morph";
-import {
-  ResponseHeaderSchema,
-  ResponseMetadata,
-  RLCModel
-} from "./interfaces.js";
-import * as path from "path";
+import { getImportSpecifier } from "./helpers/importsUtil.js";
 import {
   getImportModuleName,
   getResponseBaseName,
-  getResponseTypeName
+  getResponseTypeName,
 } from "./helpers/nameConstructors.js";
-import { getImportSpecifier } from "./helpers/importsUtil.js";
+import { ResponseHeaderSchema, ResponseMetadata, RLCModel } from "./interfaces.js";
 
 let hasErrorResponse = false;
 export function buildResponseTypes(model: RLCModel) {
@@ -28,7 +24,7 @@ export function buildResponseTypes(model: RLCModel) {
   const filePath = path.join(srcPath, `responses.ts`);
   hasErrorResponse = false;
   const responsesFile = project.createSourceFile(filePath, undefined, {
-    overwrite: true
+    overwrite: true,
   });
   // Set used to track down which models need to be imported
   // Track if we need to import RawHttpHeaders
@@ -42,7 +38,7 @@ export function buildResponseTypes(model: RLCModel) {
       const baseResponseName = getResponseBaseName(
         operationResponse.operationGroup,
         operationResponse.operationName,
-        response.statusCode
+        response.statusCode,
       );
 
       // Build the response header
@@ -54,27 +50,20 @@ export function buildResponseTypes(model: RLCModel) {
       }
 
       // Get the information to build the Response Interface
-      const responseTypeName =
-        response.predefinedName ?? getResponseTypeName(baseResponseName);
-      const responseProperties = getResponseInterfaceProperties(
-        response,
-        headersInterface?.name
-      );
+      const responseTypeName = response.predefinedName ?? getResponseTypeName(baseResponseName);
+      const responseProperties = getResponseInterfaceProperties(response, headersInterface?.name);
 
-      const responseInterfaceDefinition: OptionalKind<InterfaceDeclarationStructure> =
-        {
-          name: responseTypeName,
-          properties: responseProperties,
-          isExported: true,
-          extends: ["HttpResponse"]
-        };
+      const responseInterfaceDefinition: OptionalKind<InterfaceDeclarationStructure> = {
+        name: responseTypeName,
+        properties: responseProperties,
+        isExported: true,
+        extends: ["HttpResponse"],
+      };
 
       // Only add a description if one was provided in the Swagger
       // otherwise skip to avoid having empty TSDoc lines
       if (response.description) {
-        responseInterfaceDefinition.docs = [
-          { description: response.description }
-        ];
+        responseInterfaceDefinition.docs = [{ description: response.description }];
       }
 
       // Add the response interface to the responses file
@@ -87,11 +76,8 @@ export function buildResponseTypes(model: RLCModel) {
       {
         isTypeOnly: true,
         namedImports: ["RawHttpHeaders"],
-        moduleSpecifier: getImportSpecifier(
-          "restPipeline",
-          model.importInfo.runtimeImports
-        )
-      }
+        moduleSpecifier: getImportSpecifier("restPipeline", model.importInfo.runtimeImports),
+      },
     ]);
   }
   const namedImports = ["HttpResponse"];
@@ -102,16 +88,13 @@ export function buildResponseTypes(model: RLCModel) {
     {
       isTypeOnly: true,
       namedImports,
-      moduleSpecifier: getImportSpecifier(
-        "restClient",
-        model.importInfo.runtimeImports
-      )
-    }
+      moduleSpecifier: getImportSpecifier("restClient", model.importInfo.runtimeImports),
+    },
   ]);
 
   if ((model.importInfo.internalImports.response?.importsSet?.size ?? 0) > 0) {
     const modelNamedImports = Array.from(
-      model.importInfo.internalImports.response!.importsSet!
+      model.importInfo.internalImports.response!.importsSet!,
     ).filter((modelName) => {
       return !(modelName === "ErrorResponseOutput" && hasErrorResponse);
     });
@@ -122,11 +105,11 @@ export function buildResponseTypes(model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `./outputModels`,
-            esModulesName: `./outputModels.js`
+            esModulesName: `./outputModels.js`,
           },
-          model
-        )
-      }
+          model,
+        ),
+      },
     ]);
   }
   return { path: filePath, content: responsesFile.getFullText() };
@@ -134,7 +117,7 @@ export function buildResponseTypes(model: RLCModel) {
 
 function getResponseHeaderInterfaceDefinition(
   response: ResponseMetadata,
-  baseName: string
+  baseName: string,
 ): undefined | InterfaceDeclarationStructure {
   // Check if there are any required headers
   if (!response.headers) {
@@ -151,35 +134,29 @@ function getResponseHeaderInterfaceDefinition(
         name: h.name,
         ...(description && { docs: [{ description }] }),
         type: h.type,
-        hasQuestionToken: !h.required
+        hasQuestionToken: !h.required,
       };
-    })
+    }),
   };
 }
 
 /**
  * Gets the properties that need to be part of the response interface
  */
-function getResponseInterfaceProperties(
-  response: ResponseMetadata,
-  headersInterfaceName?: string
-) {
+function getResponseInterfaceProperties(response: ResponseMetadata, headersInterfaceName?: string) {
   const statusCode = response.statusCode;
   const responseProperties: PropertySignatureStructure[] = [
     {
       name: "status",
       type: statusCode === "default" ? `string` : `"${statusCode}"`,
-      kind: StructureKind.PropertySignature
-    }
+      kind: StructureKind.PropertySignature,
+    },
   ];
 
   if (response.body) {
     const description = response.body.description;
     let type = response.body.type;
-    if (
-      response.body.type === "ErrorResponseOutput" &&
-      response.body.fromCore
-    ) {
+    if (response.body.type === "ErrorResponseOutput" && response.body.fromCore) {
       type = "ErrorResponse";
       hasErrorResponse = true;
     }
@@ -187,7 +164,7 @@ function getResponseInterfaceProperties(
       name: "body",
       type,
       kind: StructureKind.PropertySignature,
-      ...(description && { docs: [{ description }] })
+      ...(description && { docs: [{ description }] }),
     });
   }
 
@@ -195,7 +172,7 @@ function getResponseInterfaceProperties(
     responseProperties.push({
       name: "headers",
       type: `RawHttpHeaders & ${headersInterfaceName}`,
-      kind: StructureKind.PropertySignature
+      kind: StructureKind.PropertySignature,
     });
   }
 

package/src/rlc-common/buildSamples.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { RLCModel, RLCSampleGroup, File as RLCFile } from "./interfaces.js";
+import { File as RLCFile, RLCModel, RLCSampleGroup } from "./interfaces.js";
 import { sampleTemplate } from "./static/sampleTemplate.js";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore: to fix the handlebars issue
@@ -20,12 +20,12 @@ export function buildSamples(model: RLCModel) {
   const sampleFiles: RLCFile[] = [];
   for (const sampleGroup of sampleGroups) {
     const sampleGroupFileContents = hbs.compile(sampleTemplate, {
-      noEscape: true
+      noEscape: true,
     });
     const filePath = path.join("samples-dev", `${sampleGroup.filename}.ts`);
     sampleFiles.push({
       path: filePath,
-      content: sampleGroupFileContents(sampleGroup)
+      content: sampleGroupFileContents(sampleGroup),
     });
   }
   return sampleFiles;

package/src/rlc-common/buildSchemaType.ts

@@ -1,15 +1,15 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Project } from "ts-morph";
 import * as path from "path";
+import { Project } from "ts-morph";
 import {
   buildObjectAliases,
   buildObjectInterfaces,
-  buildPolymorphicAliases
+  buildPolymorphicAliases,
 } from "./buildObjectTypes.js";
-import { RLCModel, SchemaContext } from "./interfaces.js";
 import { getImportSpecifier } from "./helpers/importsUtil.js";
+import { RLCModel, SchemaContext } from "./interfaces.js";
 
 /**
  * Generates types to represent schema definitions in the swagger
@@ -18,13 +18,11 @@ export function buildSchemaTypes(model: RLCModel) {
   const { srcPath } = model;
   const project = new Project();
   let filePath = path.join(srcPath, `models.ts`);
-  const inputModelFile = generateModelFiles(model, project, filePath, [
-    SchemaContext.Input
-  ]);
+  const inputModelFile = generateModelFiles(model, project, filePath, [SchemaContext.Input]);
   filePath = path.join(srcPath, `outputModels.ts`);
   const outputModelFile = generateModelFiles(model, project, filePath, [
     SchemaContext.Output,
-    SchemaContext.Exception
+    SchemaContext.Exception,
   ]);
   return { inputModelFile, outputModelFile };
 }
@@ -33,31 +31,19 @@ export function generateModelFiles(
   model: RLCModel,
   project: Project,
   filePath: string,
-  schemaContext: SchemaContext[]
+  schemaContext: SchemaContext[],
 ) {
   // Track models that need to be imported
   const importedModels = new Set<string>();
-  const objectsDefinitions = buildObjectInterfaces(
-    model,
-    importedModels,
-    schemaContext
-  );
+  const objectsDefinitions = buildObjectInterfaces(model, importedModels, schemaContext);
 
   const objectTypeAliases = buildPolymorphicAliases(model, schemaContext);
 
-  const objectAliases = buildObjectAliases(
-    model,
-    importedModels,
-    schemaContext
-  );
+  const objectAliases = buildObjectAliases(model, importedModels, schemaContext);
 
-  if (
-    objectTypeAliases.length ||
-    objectsDefinitions.length ||
-    objectAliases.length
-  ) {
+  if (objectTypeAliases.length || objectsDefinitions.length || objectAliases.length) {
     const modelsFile = project.createSourceFile(filePath, undefined, {
-      overwrite: true
+      overwrite: true,
     });
 
     modelsFile.addInterfaces(objectsDefinitions);
@@ -68,11 +54,8 @@ export function generateModelFiles(
         {
           isTypeOnly: true,
           namedImports: [...Array.from(importedModels || [])],
-          moduleSpecifier: getImportSpecifier(
-            "restClient",
-            model.importInfo.runtimeImports
-          )
-        }
+          moduleSpecifier: getImportSpecifier("restClient", model.importInfo.runtimeImports),
+        },
       ]);
     }
     return { path: filePath, content: modelsFile.getFullText() };

package/src/rlc-common/buildSerializeHelper.ts

@@ -1,5 +1,5 @@
-import { RLCModel } from "./interfaces.js";
 import * as path from "path";
+import { RLCModel } from "./interfaces.js";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore: to fix the handlebars issue
 import hbs from "handlebars";
@@ -8,14 +8,14 @@ import {
   hasMultiCollection,
   hasPipeCollection,
   hasSsvCollection,
-  hasTsvCollection
+  hasTsvCollection,
 } from "./helpers/operationHelpers.js";
 import {
   buildCsvCollectionContent,
   buildMultiCollectionContent,
   buildPipeCollectionContent,
   buildSsvCollectionContent,
-  buildTsvCollectionContent
+  buildTsvCollectionContent,
 } from "./static/serializeHelper.js";
 
 export function buildSerializeHelper(model: RLCModel) {
@@ -37,12 +37,12 @@ export function buildSerializeHelper(model: RLCModel) {
   }
   if (serializeHelperContent !== "") {
     const readmeFileContents = hbs.compile(serializeHelperContent, {
-      noEscape: true
+      noEscape: true,
     });
     const { srcPath } = model;
     return {
       path: path.join(srcPath, "serializeHelper.ts"),
-      content: readmeFileContents({})
+      content: readmeFileContents({}),
     };
   }
   return undefined;

package/src/rlc-common/buildTopLevelIndexFile.ts

@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { NameType, normalizeName } from "./helpers/nameUtils.js";
-import { RLCModel } from "./interfaces.js";
-import { Project } from "ts-morph";
 import * as path from "path";
-import { getRelativePartFromSrcPath } from "./helpers/pathUtils.js";
+import { Project } from "ts-morph";
 import { getImportModuleName } from "./helpers/nameConstructors.js";
+import { NameType, normalizeName } from "./helpers/nameUtils.js";
+import { getRelativePartFromSrcPath } from "./helpers/pathUtils.js";
+import { RLCModel } from "./interfaces.js";
 
 const batchOutputFolder: [string, string, string][] = [];
 
@@ -21,19 +21,12 @@ export function buildTopLevelIndex(model: RLCModel) {
   if (srcPath) {
     const clientName = model.libraryName;
     const moduleName = normalizeName(clientName, NameType.File);
-    const relativePath =
-      "./" +
-      getRelativePartFromSrcPath(srcPath, model.options.isModularLibrary);
+    const relativePath = "./" + getRelativePartFromSrcPath(srcPath, model.options.isModularLibrary);
     batchOutputFolder.push([relativePath, clientName, moduleName]);
   }
-  if (
-    multiClient &&
-    batch &&
-    batch.length > 1 &&
-    batchOutputFolder.length === batch.length
-  ) {
+  if (multiClient && batch && batch.length > 1 && batchOutputFolder.length === batch.length) {
     const indexFile = project.createSourceFile("index.ts", undefined, {
-      overwrite: true
+      overwrite: true,
     });
     const allModules: string[] = [];
     batchOutputFolder.forEach((item) => {
@@ -43,21 +36,21 @@ export function buildTopLevelIndex(model: RLCModel) {
         moduleSpecifier: getImportModuleName(
           {
             cjsName: `${item[0]}`,
-            esModulesName: `${item[0]}/index.js`
+            esModulesName: `${item[0]}/index.js`,
           },
-          model
-        )
+          model,
+        ),
       });
       allModules.push(item[1]);
     });
     indexFile.addExportDeclaration({
-      namedExports: [...allModules]
+      namedExports: [...allModules],
     });
     const content = indexFile.getFullText();
     const filePath = path.join(
       srcPath.substring(0, srcPath.lastIndexOf("src") + 4),
       model.options.isModularLibrary ? "rest" : "",
-      `index.ts`
+      `index.ts`,
     );
     return { path: filePath, content };
   }

package/src/rlc-common/helpers/apiVersionUtil.ts

@@ -5,16 +5,12 @@ import { ApiVersionInfo, ApiVersionPosition, UrlInfo } from "../interfaces.js";
  * @param urlInfo UrlInfo detail
  * @returns path api-version detail
  */
-export function extractPathApiVersion(
-  urlInfo?: UrlInfo
-): ApiVersionInfo | undefined {
+export function extractPathApiVersion(urlInfo?: UrlInfo): ApiVersionInfo | undefined {
   if (!urlInfo) {
     return;
   }
   const param = urlInfo.urlParameters?.filter(
-    (p) =>
-      p.name.toLowerCase() === "api-version" ||
-      p.name.toLowerCase() === "apiversion"
+    (p) => p.name.toLowerCase() === "api-version" || p.name.toLowerCase() === "apiversion",
   );
   if (!param || param?.length < 1) {
     return;
@@ -22,9 +18,8 @@ export function extractPathApiVersion(
   const detail: ApiVersionInfo = {
     definedPosition: "path",
     isCrossedVersion: Boolean(param?.length > 1),
-    defaultValue:
-      param.length === 1 ? (param[0]?.value as string | undefined) : undefined,
-    required: true
+    defaultValue: param.length === 1 ? (param[0]?.value as string | undefined) : undefined,
+    required: true,
   };
   return detail;
 }
@@ -39,7 +34,7 @@ export function extractPathApiVersion(
  */
 export function extractDefinedPosition(
   operationApiVersion?: ApiVersionInfo,
-  urlVersionDetail?: ApiVersionInfo
+  urlVersionDetail?: ApiVersionInfo,
 ): ApiVersionPosition {
   let pos: ApiVersionPosition = "none";
   if (operationApiVersion && urlVersionDetail) {

package/src/rlc-common/helpers/importsUtil.ts

@@ -12,42 +12,42 @@ export function buildRuntimeImports(flavor?: PackageFlavor): Imports {
       restClient: {
         type: "restClient",
         specifier: "@azure-rest/core-client",
-        version: "^2.0.0"
+        version: "^2.0.0",
       },
       coreAuth: {
         type: "coreAuth",
         specifier: "@azure/core-auth",
-        version: "^1.6.0"
+        version: "^1.6.0",
       },
       restPipeline: {
         type: "restPipeline",
         specifier: "@azure/core-rest-pipeline",
-        version: "^1.14.0"
+        version: "^1.14.0",
       },
       coreUtil: {
         type: "coreUtil",
         specifier: "@azure/core-util",
-        version: "^1.4.0"
+        version: "^1.4.0",
       },
       coreLogger: {
         type: "coreLogger",
         specifier: "@azure/logger",
-        version: "^1.0.4"
+        version: "^1.0.4",
       },
       azureEslintPlugin: {
         type: "azureEslintPlugin",
         specifier: "@azure/eslint-plugin-azure-sdk",
-        version: "^3.0.0"
+        version: "^3.0.0",
       },
       azureTestRecorder: {
         type: "azureTestRecorder",
         specifier: "@azure-tools/test-recorder",
-        version: "^3.0.0"
+        version: "^3.0.0",
       },
       azureCoreLro: {
         type: "azureCoreLro",
-        specifier: "@azure/core-lro"
-      }
+        specifier: "@azure/core-lro",
+      },
     } as Imports;
   } else {
     // In non-azure branded scope we only have one dependency that is ts-http-runtime
@@ -55,8 +55,8 @@ export function buildRuntimeImports(flavor?: PackageFlavor): Imports {
       commonFallback: {
         type: "commonFallback",
         specifier: "@typespec/ts-http-runtime",
-        version: "0.1.0"
-      }
+        version: "0.1.0",
+      },
     } as Imports;
   }
 }
@@ -69,39 +69,39 @@ export function initInternalImports(): Imports {
   return {
     parameter: {
       type: "parameter",
-      importsSet: new Set<string>()
+      importsSet: new Set<string>(),
     },
     response: {
       type: "response",
-      importsSet: new Set<string>()
+      importsSet: new Set<string>(),
     },
     rlcIndex: {
       type: "rlcIndex",
-      importsSet: new Set<string>()
+      importsSet: new Set<string>(),
     },
     modularModel: {
       type: "modularModel",
-      importsSet: new Set<string>()
+      importsSet: new Set<string>(),
     },
     rlcClientFactory: {
       type: "rlcClientFactory",
-      importsSet: new Set<string>()
+      importsSet: new Set<string>(),
     },
     rlcClientDefinition: {
       type: "rlcClientDefinition",
-      importsSet: new Set<string>()
+      importsSet: new Set<string>(),
     },
     serializerHelpers: {
       type: "serializerHelpers",
-      importsSet: new Set<string>()
-    }
+      importsSet: new Set<string>(),
+    },
   } as Imports;
 }
 
 export function getImportSpecifier(
   importType: ImportType,
   imports?: Imports,
-  includeFallback = true
+  includeFallback = true,
 ): string {
   imports = imports ?? ({} as Imports);
   const defaultPackageMap: Record<ImportType, string> = {
@@ -110,7 +110,7 @@ export function getImportSpecifier(
     restPipeline: "@azure/core-rest-pipeline",
     coreUtil: "@azure/core-util",
     coreLogger: "@azure/logger",
-    azureCoreLro: "@azure/core-lro"
+    azureCoreLro: "@azure/core-lro",
   } as any;
   if (!includeFallback) {
     return imports[importType]?.specifier ?? "";
@@ -125,7 +125,7 @@ export function getImportSpecifier(
 export function addImportToSpecifier(
   importType: ImportType,
   runtimeImports: Imports,
-  importedName: string
+  importedName: string,
 ): void {
   const specifier = getImportSpecifier(importType, runtimeImports);
   const importSet = runtimeImports[importType]?.importsSet;
@@ -133,7 +133,7 @@ export function addImportToSpecifier(
     runtimeImports[importType] = {
       type: importType,
       specifier,
-      importsSet: new Set<string>().add(importedName)
+      importsSet: new Set<string>().add(importedName),
     };
   } else {
     importSet.add(importedName);
@@ -149,15 +149,14 @@ export function clearImportSets(runtimeImports: Imports): void {
 export function addImportsToFiles(
   runtimeImports: Imports,
   file: SourceFile,
-  internalSpecifierMap?: Record<string, string>
+  internalSpecifierMap?: Record<string, string>,
 ): void {
   Object.values(runtimeImports)
     .filter((importType) => {
       return importType.importsSet?.size;
     })
     .forEach((importType) => {
-      const specifier =
-        internalSpecifierMap?.[importType.type] ?? importType.specifier!;
+      const specifier = internalSpecifierMap?.[importType.type] ?? importType.specifier!;
       let hasModifier = false;
       if (!specifier) {
         return;
@@ -169,16 +168,14 @@ export function addImportsToFiles(
         })
         .forEach((importDeclaration) => {
           hasModifier = true;
-          importDeclaration.addNamedImports([
-            ...importType.importsSet!.values()
-          ]);
+          importDeclaration.addNamedImports([...importType.importsSet!.values()]);
         });
 
       if (!hasModifier) {
         file.addImportDeclaration({
           isTypeOnly: true,
           moduleSpecifier: specifier,
-          namedImports: [...importType.importsSet!.values()]
+          namedImports: [...importType.importsSet!.values()],
         });
         return;
       }