@autorest/typescript 6.0.0-beta.13 → 6.0.0-beta.16

package/src/generators/indexGenerator.ts

@@ -4,12 +4,15 @@ import { getAutorestOptions, getSession } from "../autorestSession";
 import { NameType, normalizeName } from "../utils/nameUtils";
 import { hasPagingOperations } from "../utils/extractPaginationDetails";
 import { hasPollingOperations } from "../restLevelClient/helpers/hasPollingOperations";
-
+import {
+  hasInputModels,
+  hasOutputModels
+} from "../restLevelClient/helpers/modelHelpers";
 export function generateIndexFile(
   project: Project,
   clientDetails?: ClientDetails
 ) {
-  const { restLevelClient, srcPath } = getAutorestOptions();
+  const { restLevelClient, srcPath, multiClient, batch } = getAutorestOptions();
   const indexFile = project.createSourceFile(`${srcPath}/index.ts`, undefined, {
     overwrite: true
   });
@@ -21,36 +24,122 @@ export function generateIndexFile(
       );
     }
     generateHLCIndex(clientDetails, indexFile);
-  } else {
+  } else if (!multiClient || !batch || batch?.length === 1) {
+    // if we are generate single client package for RLC
     generateRLCIndex(indexFile);
+  } else {
+    generateRLCIndexForMultiClient(indexFile);
   }
 }
 
-function generateRLCIndex(file: SourceFile) {
+// to generate a index.ts for each single module inside the multi client RLC package
+function generateRLCIndexForMultiClient(file: SourceFile) {
   const { model } = getSession();
   const clientName = model.language.default.name;
+  const createClientFuncName = `${clientName}`;
   const moduleName = normalizeName(clientName, NameType.File);
 
   file.addImportDeclaration({
-    moduleSpecifier: `./${moduleName}`,
-    defaultImport: clientName
+    namespaceImport: "Parameters",
+    moduleSpecifier: "./parameters"
   });
 
+  file.addImportDeclaration({
+    namespaceImport: "Responses",
+    moduleSpecifier: "./responses"
+  });
+
+  file.addImportDeclaration({
+    namespaceImport: "Client",
+    moduleSpecifier: "./clientDefinitions"
+  })
+
+  const exports = ['Parameters', 'Responses', 'Client'];
+  if (hasInputModels(model)) {
+    file.addImportDeclaration({
+      namespaceImport: "Models",
+      moduleSpecifier: "./models",
+    });
+    exports.push("Models");
+  }
+
+  if (hasOutputModels(model)) {
+    file.addImportDeclaration({
+      namespaceImport: "OutputModels",
+      moduleSpecifier: "./outputModels",
+    });
+    exports.push("OutputModels");
+  }
+
+  if (hasPagingOperations(model)) {
+    file.addImportDeclaration({
+      namespaceImport: "PaginateHelper",
+      moduleSpecifier: './paginateHelper',
+    });
+    exports.push("PaginateHelper");
+  }
+
+  if (hasPollingOperations(model)) {
+    file.addImportDeclaration({
+      namespaceImport: 'PollingHelper',
+      moduleSpecifier: './pollingHelper',
+    })
+    exports.push("PollingHelper");
+  }
+
   file.addExportDeclarations([
     {
-      moduleSpecifier: `./${moduleName}`
+      moduleSpecifier: `./${moduleName}`,
+      namedExports: [createClientFuncName],
     },
     {
-      moduleSpecifier: "./models"
+      namedExports: [...exports]
+    }
+  ]);
+}
+
+function generateRLCIndex(file: SourceFile) {
+  const { model } = getSession();
+  const clientName = model.language.default.name;
+  const createClientFuncName = `${clientName}`;
+  const moduleName = normalizeName(clientName, NameType.File);
+
+  file.addImportDeclaration({
+    moduleSpecifier: `./${moduleName}`,
+    defaultImport: createClientFuncName
+  });
+
+  file.addExportDeclarations([
+    {
+      moduleSpecifier: `./${moduleName}`,
     },
     {
       moduleSpecifier: "./parameters"
     },
     {
       moduleSpecifier: "./responses"
+    },
+    {
+      moduleSpecifier: "./clientDefinitions"
     }
   ]);
 
+  if (hasInputModels(model)) {
+    file.addExportDeclarations([
+      {
+        moduleSpecifier: "./models"
+      }
+    ]);
+  }
+
+  if (hasOutputModels(model)) {
+    file.addExportDeclarations([
+      {
+        moduleSpecifier: "./outputModels"
+      }
+    ]);
+  }
+
   if (hasPagingOperations(model)) {
     file.addExportDeclarations([
       {
@@ -68,7 +157,7 @@ function generateRLCIndex(file: SourceFile) {
   }
 
   file.addExportAssignment({
-    expression: clientName,
+    expression: createClientFuncName,
     isExportEquals: false
   });
 }
@@ -86,10 +175,6 @@ function generateHLCIndex(clientDetails: ClientDetails, file: SourceFile) {
     {
       moduleSpecifier: `./${clientDetails.sourceFileName}`,
       namedExports: [clientDetails.className]
-    },
-    {
-      moduleSpecifier: `./${clientDetails.sourceFileName}Context`,
-      namedExports: [`${clientDetails.className}Context`]
     }
   ]);
 

package/src/generators/mappersGenerator.ts

@@ -19,7 +19,7 @@ import {
   MapperConstraints
 } from "@azure/core-http";
 import { ModelProperties } from "../transforms/mapperTransforms";
-import { keys, isEmpty, isString, isNil, isEqual } from "lodash";
+import { keys, isEmpty, isString, isNil, isEqual, List } from "lodash";
 import { getStringForValue, MapperTypes } from "../utils/valueHelpers";
 import { PolymorphicObjectDetails, ObjectKind } from "../models/modelDetails";
 import { logger } from "../utils/logger";
@@ -57,14 +57,89 @@ export function generateMappers(
   mappersFile.fixUnusedIdentifiers();
 }
 
+function getParents(
+  mapperParentMap: Map<string, Array<string>>,
+  parent: string
+) {
+  const list: Array<string> = new Array<string>();
+  const parents = mapperParentMap.get(parent);
+
+  if (!parents) {
+    parents!.forEach(pnt => {
+      if (!list.includes(pnt)) {
+        getParents(mapperParentMap, pnt).forEach(str => list.push(str));
+      }
+    });
+  }
+
+  if (!list.includes(parent)) {
+    list.push(parent);
+  }
+
+  return list;
+}
+
+function traverse(mapperParentMap: Map<string, Array<string>>) {
+  const list: Array<string> = new Array<string>();
+  mapperParentMap.forEach((value: string[], key: string) => {
+    value.forEach(parent => {
+      if (!list.includes(parent)) {
+        getParents(mapperParentMap, parent).forEach(str => list.push(str));
+      }
+    });
+    if (!list.includes(key)) {
+      list.push(key);
+    }
+  });
+  return list;
+}
+
 /**
  * This function writes to the mappers.ts file all the mappers to be used by @azure/core-http for serialization
  */
 function writeMappers(sourceFile: SourceFile, { mappers }: ClientDetails) {
+  const mapperParentMap: Map<string, Array<string>> = new Map<
+    string,
+    Array<string>
+  >();
+  const mapperPositionMap: Map<string, number> = new Map<string, number>();
+  let position = 0;
+  mappers.forEach(mapper => {
+    const compositeMapper = mapper as CompositeMapper;
+    const mapperClassName = compositeMapper.type.className;
+    if (!mapperClassName) return;
+    mapperPositionMap.set(mapperClassName, position);
+    position += 1;
+    let listOfParents = mapperParentMap.get(mapperClassName);
+    if (!listOfParents) {
+      listOfParents = new Array<string>();
+    }
+
+    if (
+      compositeMapper.type.modelProperties &&
+      compositeMapper.type.modelProperties.parentsRefs
+    ) {
+      const { parentsRefs } = (compositeMapper.type.modelProperties ||
+        {}) as ModelProperties;
+
+      if (parentsRefs) {
+        (parentsRefs as string[]).forEach(parentsRef => {
+          listOfParents!.push(parentsRef);
+        });
+      }
+    }
+
+    mapperParentMap.set(mapperClassName, listOfParents);
+  });
+
+  const modifiedList = traverse(mapperParentMap);
   const { useCoreV2 } = getAutorestOptions();
   const generatedMappers: Map<string, Mapper> = new Map<string, Mapper>();
 
-  mappers.forEach(mapper => {
+  modifiedList.forEach(name => {
+    const arrayIndex = mapperPositionMap.get(name) || 0;
+    const mapper = mappers[arrayIndex];
+
     const mapperClassName = (mapper as CompositeMapper).type.className;
     if (!mapperClassName) {
       logger.warning(`Expected a mapper with a className, skipping generation`);
@@ -103,6 +178,19 @@ function writeMappers(sourceFile: SourceFile, { mappers }: ClientDetails) {
       leadingTrivia: writer => writer.blankLine()
     });
 
+    const { polymorphicDiscriminator } = mapper.type as CompositeMapperType;
+
+    if (polymorphicDiscriminator) {
+      if (
+        isString(polymorphicDiscriminator) &&
+        `${polymorphicDiscriminator}`.startsWith(mapper.serializedName!)
+      ) {
+        sourceFile.addStatements(
+          `${polymorphicDiscriminator}=${polymorphicDiscriminator};`
+        );
+      }
+    }
+
     // Keep track of the mapper we just generated
     generatedMappers.set(mapperClassName, mapper);
   });
@@ -178,7 +266,7 @@ export function writeMapper(writer: CodeBlockWriter, mapper: Mapper) {
       .write("type:")
       .block(() => {
         // Write tipe properties for the current mapper
-        writeMapperType(writer, mapper.type, parents);
+        writeMapperType(writer, mapper, parents);
       });
   });
 }
@@ -189,14 +277,16 @@ export function writeMapper(writer: CodeBlockWriter, mapper: Mapper) {
  */
 function writeMapperType(
   writer: CodeBlockWriter,
-  mapperType: MapperType,
+  mapper: Mapper,
   parents: string[]
 ) {
+  const mapperType = mapper.type;
+
   if (isSequenceMapperType(mapperType)) {
     return writeSequenceMapperType(writer, mapperType);
   }
 
-  return writeCompositeMapperType(writer, mapperType, parents);
+  return writeCompositeMapperType(writer, mapper, parents);
 }
 
 /**
@@ -213,9 +303,10 @@ function isSequenceMapperType(
  */
 function writeCompositeMapperType(
   writer: CodeBlockWriter,
-  mapperType: MapperType,
+  mapper: Mapper,
   parents: string[]
 ) {
+  const mapperType = mapper.type;
   const {
     modelProperties,
     polymorphicDiscriminator,
@@ -223,7 +314,14 @@ function writeCompositeMapperType(
   } = mapperType as CompositeMapperType;
   writeObjectProps(restType, writer);
   // Write type properties that need special handling
-  writePolymorphicDiscriminator(writer, polymorphicDiscriminator);
+  if (polymorphicDiscriminator) {
+    if (
+      !isString(polymorphicDiscriminator) ||
+      !`${polymorphicDiscriminator}`.startsWith(mapper.serializedName!)
+    ) {
+      writePolymorphicDiscriminator(writer, polymorphicDiscriminator);
+    }
+  }
   writeModelProperties(writer, parents, modelProperties);
 }
 
@@ -258,7 +356,9 @@ function writeMapperContraints(
     .block(() => {
       if (Pattern) {
         writer.write(
-          `Pattern: new RegExp("${Pattern.source.replace(/\\/g, "\\\\")}"), `
+          `Pattern: new RegExp("${Pattern.source
+            .replace(/\\/g, "\\\\")
+            .replace(/"/g, '\\"')}"), `
         );
       }
 

package/src/generators/modelsGenerator.ts

@@ -69,6 +69,10 @@ export function generateModels(clientDetails: ClientDetails, project: Project) {
       namespaceImport: "coreRestPipeline",
       moduleSpecifier: "@azure/core-rest-pipeline"
     });
+    modelsIndexFile.addImportDeclaration({
+      namespaceImport: "coreHttpCompat",
+      moduleSpecifier: "@azure/core-http-compat"
+    });
   }
 
   writeUniontypes(clientDetails, modelsIndexFile);
@@ -77,13 +81,21 @@ export function generateModels(clientDetails: ClientDetails, project: Project) {
   writeOperationModels(clientDetails, modelsIndexFile);
   writeClientModels(clientDetails, modelsIndexFile);
   modelsIndexFile.fixUnusedIdentifiers();
+  const allTypes = modelsIndexFile.getTypeAliases();
+  clientDetails.allTypes = allTypes
+    .filter(item => {
+      return item.isExported();
+    })
+    .map(item => {
+      return item.getName();
+    });
 }
 
 const writeClientModels = (
   clientDetails: ClientDetails,
   modelsIndexFile: SourceFile
 ) => {
-  const { useCoreV2 } = getAutorestOptions();
+  const { useCoreV2, coreHttpCompatMode } = getAutorestOptions();
   let clientOptionalParams = clientDetails.parameters.filter(
     p =>
       (!p.required || p.defaultValue) &&
@@ -97,6 +109,8 @@ const writeClientModels = (
     {
       baseClass: !useCoreV2
         ? "coreHttp.ServiceClientOptions"
+        : coreHttpCompatMode
+        ? "coreHttpCompat.ExtendedServiceClientOptions"
         : "coreClient.ServiceClientOptions"
     }
   );
@@ -771,6 +785,12 @@ function getPropertyTypeName(
   ignoreNullableOnOptional: boolean
 ) {
   if (property.isConstant) {
+    if (
+      property.type === SchemaType.Number ||
+      property.type === SchemaType.Boolean
+    ) {
+      return `${property.defaultValue}`;
+    }
     return `"${getStringForValue(
       property.defaultValue,
       property.type,

package/src/generators/operationGenerator.ts

@@ -475,7 +475,7 @@ function addClass(
     name: "client",
     isReadonly: true,
     scope: Scope.Private,
-    type: `${clientDetails.className}Context`
+    type: `${clientDetails.className}`
   });
   const constructorDefinition = operationGroupClass.addConstructor({
     docs: [
@@ -487,7 +487,7 @@ function addClass(
       {
         name: "client",
         hasQuestionToken: false,
-        type: `${clientDetails.className}Context`
+        type: `${clientDetails.className}`
       }
     ]
   });
@@ -1319,16 +1319,16 @@ function addImports(
     });
   }
 
-  const clientContextClassName = `${className}Context`;
+  const clientClassName = `${className}`;
 
-  const clientContextFileName = normalizeName(
-    clientContextClassName,
+  const clientFileName = normalizeName(
+    clientClassName,
     NameType.File
   );
 
   operationGroupFile.addImportDeclaration({
-    namedImports: [`${clientContextClassName}`],
-    moduleSpecifier: `../${clientContextFileName}`
+    namedImports: [`${clientClassName}`],
+    moduleSpecifier: `../${clientFileName}`
   });
 
   if (hasLroOperation(operationGroupDetails)) {

package/src/generators/samples/sampleEnv.hbs

@@ -0,0 +1,4 @@
+# App registration secret for AAD authentication
+AZURE_CLIENT_SECRET=
+AZURE_CLIENT_ID=
+AZURE_TENANT_ID= 

package/src/generators/samples/sampleEnvGenerator.ts

@@ -0,0 +1,14 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import * as hbs from 'handlebars';
+import { Project } from 'ts-morph';
+
+export function generateSampleEnv(project: Project) {
+    const file = fs.readFileSync(path.join(__dirname, "sampleEnv.hbs"), {
+        encoding: "utf-8"
+    });
+    const readmeFileContents = hbs.compile(file, { noEscape: true });
+    project.createSourceFile("sample.env", readmeFileContents({}), {
+        overwrite: true
+    });
+}

package/src/generators/samples/sampleGenerator.ts

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import {
+  Project,
+  SourceFile
+} from "ts-morph";
+import * as fs from 'fs';
+import * as path from 'path';
+import * as hbs from "handlebars";
+import { getAutorestOptions, getSession } from "../../autorestSession";
+import { ClientDetails } from "../../models/clientDetails";
+import { SampleGroup } from "../../models/sampleDetails";
+
+/**
+ * Function that writes the code for all the operations.
+ * It will generate one file per operation group and each file contains:
+ *    - A class definition for the operation group
+ *    - Methods and overrides for each operation
+ *    - OperationSpecs for each operation
+ * @param clientDetails client details
+ * @param project project for code generation
+ */
+export function generateSamples(
+  clientDetails: ClientDetails,
+  project: Project
+): void {
+  // Toplevel operations are inlined in the client
+  const sampleGroups = clientDetails.samples;
+  const session = getSession();
+  if (!sampleGroups) {
+    session.error("No samples are found! ", []);
+  }
+  for (const sampleGroup of sampleGroups as SampleGroup[]) {
+    try {
+      const file = fs.readFileSync(path.join(__dirname, "../static/samples.ts.hbs"), {
+        encoding: "utf-8"
+      });
+
+      const sampleGroupFileContents = hbs.compile(file, { noEscape: true });
+      project.createSourceFile(`samples-dev/${sampleGroup.sampleFileName}.ts`, sampleGroupFileContents(sampleGroup), {
+        overwrite: true
+      });
+    } catch (error) {
+      session.error("An error was encountered while handling sample generation", [sampleGroup.sampleFileName]);
+      throw error;
+    }
+  }
+}
+

package/src/generators/static/README.md.hbs

@@ -24,6 +24,8 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 - [LTS versions of Node.js](https://nodejs.org/about/releases/)
 - Latest versions of Safari, Chrome, Edge and Firefox.
 
+See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
+
 {{#if azure}}
 ### Prerequisites
 
@@ -64,17 +66,38 @@ For more information about how to create an Azure AD Application check out [this
 ```javascript
 const { {{ clientClassName }} } = require("{{ clientPackageName }}");
 const { DefaultAzureCredential } = require("@azure/identity");
+// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
+
 const subscriptionId = "00000000-0000-0000-0000-000000000000";
 const client = new {{ clientClassName }}(new DefaultAzureCredential(), subscriptionId);
+
+// For client-side applications running in the browser, use this code instead:
+// const credential = new InteractiveBrowserCredential({
+//   tenantId: "<YOUR_TENANT_ID>",
+//   clientId: "<YOUR_CLIENT_ID>"
+// });
+// const client = new {{ clientClassName }}(credential, subscriptionId);
 ```
 {{else}}
 ```javascript
 const { {{ clientClassName }} } = require("{{ clientPackageName }}");
 const { DefaultAzureCredential } = require("@azure/identity");
+// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
+
 const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredential());
+// For client-side applications running in the browser, use this code instead:
+// const credential = new InteractiveBrowserCredential({
+//   tenantId: "<YOUR_TENANT_ID>",
+//   clientId: "<YOUR_CLIENT_ID>"
+// });
+// const client = new {{ clientClassName }}("<endpoint>", credential);
 ```
 {{/if}}
 {{/if}}{{/if}}
+
+### JavaScript Bundle
+To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
+
 ## Key concepts
 
 ### {{ clientClassName }}