@autorest/typescript 6.0.0-beta.9 → 6.0.0-rc.1

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

@@ -0,0 +1,71 @@
+# {{ clientDescriptiveName }} library for JavaScript
+
+{{ description }}
+
+**Please rely heavily on {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+
+Key links:
+
+{{#if packageSourceURL}}
+- [Source code]({{ packageSourceURL }})
+{{/if}}
+{{#if packageNPMURL}}
+- [Package (NPM)]({{ packageNPMURL }})
+{{/if}}
+{{#if apiRefURL}}
+- [API reference documentation]({{ apiRefURL }})
+{{/if}}
+{{#if serviceDocURL}}
+- [Product documentation]({{ serviceDocURL }})
+{{/if}}
+{{#if samplesURL}}
+- [Samples]({{ samplesURL }})
+{{/if}}
+
+## Getting started
+
+### Currently supported environments
+
+- Node.js version 14.x.x or higher
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/){{#if dependencyLink}} and follow [these]({{ dependencyLink }}) instructions{{/if}} to use this package.
+
+### Install the `{{ clientPackageName }}` package
+
+Install the {{ clientDescriptiveName }} REST client library for JavaScript with `npm`:
+
+```bash
+npm install {{ clientPackageName }}
+```
+
+### Create and authenticate a `{{ clientClassName }}`
+
+To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
+provide an instance of the desired credential type obtained from the
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) {{#if dependencyLink}}and
+[{{dependencyDescription }}]({{ dependencyLink }}){{/if}}
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```javascript
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

package/src/generators/static/rollupConfigFileGenerator.ts

@@ -5,12 +5,17 @@ import { Project } from "ts-morph";
 import { getAutorestOptions } from "../../autorestSession";
 
 export function generateRollupConfig(project: Project) {
-  const { generateMetadata } = getAutorestOptions();
+  const { generateMetadata, restLevelClient, azureSdkForJs } = getAutorestOptions();
 
   if (!generateMetadata) {
     return;
   }
 
+  // when it's generating rlc codes, only generate rollup config in codegen test
+  if (restLevelClient && azureSdkForJs) {
+    return;
+  }
+
   const rollupFile = project.createSourceFile("rollup.config.js", undefined, {
     overwrite: true
   });
@@ -24,62 +29,14 @@ export function generateRollupConfig(project: Project) {
     
     import nodeBuiltins from "builtin-modules";
     
-    /**
-     * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
-     *
-     * NOTE: this manual configuration is only needed because OpenTelemetry uses an
-     * __exportStar downleveled helper function to declare its exports which confuses
-     * rollup's automatic discovery mechanism.
-     *
-     * @returns an object reference that can be \`...\`'d into your cjs() configuration.
-     */
-    export function openTelemetryCommonJs() {
-      const namedExports = {};
-    
-      for (const key of [
-        "@opentelemetry/api",
-        "@azure/core-tracing/node_modules/@opentelemetry/api"
-      ]) {
-        namedExports[key] = [
-          "SpanKind",
-          "TraceFlags",
-          "getSpan",
-          "setSpan",
-          "SpanStatusCode",
-          "getSpanContext",
-          "setSpanContext"
-        ];
-      }
-    
-      const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
-    
-      for (const version of releasedOpenTelemetryVersions) {
-        namedExports[
-          // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
-          \`../../../common/temp/node_modules/.pnpm/@opentelemetry/api@\${version}/node_modules/@opentelemetry/api/build/src/index.js\`
-        ] = [
-            "SpanKind",
-            "TraceFlags",
-            "getSpan",
-            "setSpan",
-            "StatusCode",
-            "CanonicalCode",
-            "getSpanContext",
-            "setSpanContext"
-          ];
-      }
-    
-      return namedExports;
-    }
-    
     // #region Warning Handler
     
     /**
-     * A function that can determine whether a rollupwarning should be ignored. If
+     * A function that can determine whether a rollup warning should be ignored. If
      * the function returns \`true\`, then the warning will not be displayed.
      */
     
-    function ignoreNiseSinonEvalWarnings(warning) {
+    function ignoreNiseSinonEval(warning) {
       return (
         warning.code === "EVAL" &&
         (warning.id && ((warning.id.includes("node_modules/nise")) ||
@@ -87,7 +44,7 @@ export function generateRollupConfig(project: Project) {
       );
     }
     
-    function ignoreChaiCircularDependencyWarnings(warning) {
+    function ignoreChaiCircularDependency(warning) {
       return (
         warning.code === "CIRCULAR_DEPENDENCY" &&
         (warning.importer && warning.importer.includes("node_modules/chai") === true)
@@ -95,8 +52,8 @@ export function generateRollupConfig(project: Project) {
     }
     
     const warningInhibitors = [
-      ignoreChaiCircularDependencyWarnings,
-      ignoreNiseSinonEvalWarnings
+      ignoreChaiCircularDependency,
+      ignoreNiseSinonEval
     ];
     
     /**
@@ -131,22 +88,7 @@ export function generateRollupConfig(project: Project) {
           nodeResolve({
             mainFields: ["module", "browser"]
           }),
-          cjs({
-            namedExports: {
-              // Chai's strange internal architecture makes it impossible to statically
-              // analyze its exports.
-              chai: [
-                "version",
-                "use",
-                "util",
-                "config",
-                "expect",
-                "should",
-                "assert"
-              ],
-              ...openTelemetryCommonJs()
-            }
-          }),
+          cjs(),
           json(),
           sourcemaps()
           //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
@@ -185,7 +127,7 @@ export function generateRollupConfig(project: Project) {
         ],
         output: { file: "dist/index.js", format: "cjs", sourcemap: true },
         preserveSymlinks: false,
-        plugins: [sourcemaps(), nodeResolve(), cjs()]
+        plugins: [sourcemaps(), nodeResolve()]
       };
     
       const config = [baseConfig];

package/src/generators/static/tsConfigFileGenerator.ts

@@ -4,7 +4,7 @@
 import { Project } from "ts-morph";
 import { getAutorestOptions } from "../../autorestSession";
 
-const highLevelTsConfig = {
+const highLevelTsConfig: Record<string, any> = {
   compilerOptions: {
     module: "es6",
     moduleResolution: "node",
@@ -24,33 +24,68 @@ const highLevelTsConfig = {
   exclude: ["node_modules"]
 };
 
-const restLevelTsConfig = {
-  compilerOptions: {
-    module: "es6",
-    target: "es2015",
-    moduleResolution: "node",
-    declaration: true,
-    declarationMap: true,
-    outDir: "./dist-esm"
+
+const restLevelTsConfigInAzureSdkForJs: Record<string, any> = {
+  "extends": "../../../tsconfig.package",
+  "compilerOptions": {
+    "outDir": "./dist-esm",
+    "declarationDir": "./types",
   },
-  exclude: [
-    "node_modules",
-    "types",
-    "temp",
-    "browser",
-    "dist",
-    "dist-esm",
-    "./samples/**/*.ts"
-  ]
+  "include": ["src/**/*.ts"]
 };
 
+const restLevelTsConfigNotInAzureSdkForJs: Record<string, any> = {
+  "compilerOptions": {
+    "target": "ES2017",
+    "module": "es6",
+    "lib": [],
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "strict": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "outDir": "./dist-esm",
+    "declarationDir": "./types"
+  },
+  "include": ["./src/**/*.ts"]
+}
+
+
 export function generateTsConfig(project: Project) {
-  const { generateMetadata, restLevelClient } = getAutorestOptions();
+  const { generateMetadata, restLevelClient, generateTest, packageDetails, generateSample, azureSdkForJs } = getAutorestOptions();
 
   if (!generateMetadata) {
     return;
   }
 
+  const clientPackageName = packageDetails.name;
+
+  const restLevelTsConfig = azureSdkForJs ? restLevelTsConfigInAzureSdkForJs : restLevelTsConfigNotInAzureSdkForJs;
+
+  if (generateTest) {
+    highLevelTsConfig.include.push("./test/**/*.ts");
+    restLevelTsConfig.include.push("./test/**/*.ts");
+  }
+
+  if (generateSample) {
+    highLevelTsConfig.include.push("samples-dev/**/*.ts");
+    highLevelTsConfig.compilerOptions["paths"] = {};
+    highLevelTsConfig.compilerOptions["paths"][clientPackageName] = ["./src/index"];
+    restLevelTsConfig.include.push("samples-dev/**/*.ts");
+    restLevelTsConfig.compilerOptions["paths"] = {};
+    restLevelTsConfig.compilerOptions["paths"][clientPackageName] = ["./src/index"];
+  }
+
   const tsConfigContents = restLevelClient
     ? restLevelTsConfig
     : highLevelTsConfig;

package/src/generators/test/envBrowserFileGenerator.ts

@@ -0,0 +1,14 @@
+import { Project } from "ts-morph";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateEnvBrowserFile(
+  project: Project
+) {
+  const { generateTest, restLevelClient } = getAutorestOptions();
+  if (!generateTest || !restLevelClient) {
+    return;
+  }
+  project.createSourceFile("test/public/utils/env.browser.ts", "", {
+    overwrite: true
+  });
+}

package/src/generators/test/envFileGenerator.ts

@@ -0,0 +1,22 @@
+import { Project } from "ts-morph";
+import * as path from 'path';
+import * as fs from 'fs';
+import * as hbs from "handlebars";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateEnvFile(
+    project: Project
+  ) {
+    const { generateTest, restLevelClient } = getAutorestOptions();
+    if (!generateTest || !restLevelClient) {
+      return;
+    }
+    const metadata = {}
+    const file = fs.readFileSync(path.join(__dirname, "rlcEnv.ts.hbs"), {
+      encoding: "utf-8"
+    });
+    const envFileContents = hbs.compile(file, { noEscape: true });
+    project.createSourceFile("test/public/utils/env.ts", envFileContents(metadata), {
+      overwrite: true
+    });
+  }

package/src/generators/test/recordedClientFileGenerator.ts

@@ -0,0 +1,22 @@
+import { Project } from "ts-morph";
+import * as path from 'path';
+import * as fs from 'fs';
+import * as hbs from "handlebars";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateRecordedClientFile(
+    project: Project
+  ) {
+    const { generateTest, restLevelClient } = getAutorestOptions();
+    if (!generateTest || !restLevelClient) {
+      return;
+    }
+    const metadata = {}
+    const file = fs.readFileSync(path.join(__dirname, "rlcRecordedClient.ts.hbs"), {
+      encoding: "utf-8"
+    });
+    const recordedClientFileContents = hbs.compile(file, { noEscape: true });
+    project.createSourceFile("test/public/utils/recordedClient.ts", recordedClientFileContents(metadata), {
+      overwrite: true
+    });
+  }

package/src/generators/test/rlcEnv.ts.hbs

@@ -0,0 +1,3 @@
+import * as dotenv from "dotenv";
+
+dotenv.config();

package/src/generators/test/rlcRecordedClient.ts.hbs

@@ -0,0 +1,26 @@
+import { Context } from "mocha";
+import { Recorder, RecorderStartOptions } from "@azure-tools/test-recorder";
+import "./env";
+
+const envSetupForPlayback: Record<string, string> = {
+  ENDPOINT: "https://endpoint",
+  AZURE_CLIENT_ID: "azure_client_id",
+  AZURE_CLIENT_SECRET: "azure_client_secret",
+  AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
+  SUBSCRIPTION_ID: "azure_subscription_id"
+};
+
+const recorderEnvSetup: RecorderStartOptions = {
+  envSetupForPlayback
+};
+
+/**
+* creates the recorder and reads the environment variables from the `.env` file.
+* Should be called first in the test suite to make sure environment variables are
+* read before they are being used.
+*/
+export async function createRecorder(context: Context): Promise<Recorder> {
+  const recorder = new Recorder(context.currentTest);
+  await recorder.start(recorderEnvSetup);
+  return recorder;
+}

package/src/generators/test/rlcSampleTest.spec.ts.hbs

@@ -0,0 +1,20 @@
+import { Recorder } from "@azure-tools/test-recorder";
+import { assert } from "chai";
+import { createRecorder } from "./utils/recordedClient";
+import { Context } from "mocha";
+
+describe("My test", () => {
+  let recorder: Recorder;
+
+  beforeEach(async function(this: Context) {
+    recorder = await createRecorder(this);
+  });
+
+  afterEach(async function() {
+    await recorder.stop();
+  });
+
+  it("sample test", async function() {
+    assert.equal(1, 1);
+  });
+});

package/src/generators/test/sampleTest.ts.hbs

@@ -0,0 +1,32 @@
+import { Recorder, RecorderStartOptions, env } from "@azure-tools/test-recorder";
+import { assert } from "chai";
+import { Context } from "mocha";
+
+
+const replaceableVariables: Record<string, string> = {
+  AZURE_CLIENT_ID: "azure_client_id",
+  AZURE_CLIENT_SECRET: "azure_client_secret",
+  AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
+  SUBSCRIPTION_ID: "azure_subscription_id"
+};
+
+const recorderOptions: RecorderStartOptions = {
+  envSetupForPlayback: replaceableVariables,
+};
+
+describe("My test", () => {
+  let recorder: Recorder;
+
+  beforeEach(async function (this: Context) {
+    recorder = new Recorder(this.currentTest);
+    await recorder.start(recorderOptions);
+  });
+
+  afterEach(async function () {
+    await recorder.stop();
+  });
+
+  it("sample test", async function () {
+    console.log("Hi, I'm a test!");
+  });
+});

package/src/generators/test/sampleTestGenerator.ts

@@ -0,0 +1,32 @@
+import { Project } from "ts-morph";
+import * as path from 'path';
+import * as fs from 'fs';
+import * as hbs from "handlebars";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateSampleTestFile(
+    project: Project
+  ) {
+    const { generateTest, restLevelClient } = getAutorestOptions();
+    if (!generateTest) {
+      return;
+    }
+    const metadata = {}
+    if (restLevelClient) {
+      const file = fs.readFileSync(path.join(__dirname, "rlcSampleTest.spec.ts.hbs"), {
+        encoding: "utf-8"
+      });
+      const readmeFileContents = hbs.compile(file, { noEscape: true });
+      project.createSourceFile("test/public/sampleTest.spec.ts", readmeFileContents(metadata), {
+        overwrite: true
+      });
+    } else {
+      const file = fs.readFileSync(path.join(__dirname, "sampleTest.ts.hbs"), {
+        encoding: "utf-8"
+      });
+      const readmeFileContents = hbs.compile(file, { noEscape: true });
+      project.createSourceFile("test/sampleTest.ts", readmeFileContents(metadata), {
+        overwrite: true
+      });
+    }
+  }

package/src/generators/tracingFileGenerator.ts

@@ -2,8 +2,6 @@
 // Licensed under the MIT License.
 
 import { Project, SourceFile, VariableDeclarationKind } from "ts-morph";
-import { PackageDetails } from "../models/packageDetails";
-import { NameType, normalizeName } from "../utils/nameUtils";
 import { getAutorestOptions } from "../autorestSession";
 
 export function generateTracingFile(project: Project) {
@@ -18,7 +16,7 @@ export function generateTracingFile(project: Project) {
 
   file.addImportDeclarations([
     {
-      namedImports: ["createSpanFunction"],
+      namedImports: ["createTracingClient"],
       moduleSpecifier: "@azure/core-tracing"
     }
   ]);
@@ -28,7 +26,7 @@ export function generateTracingFile(project: Project) {
 }
 
 function writeCreateSpanFunction(file: SourceFile) {
-  const { tracingInfo } = getAutorestOptions();
+  const { tracingInfo, packageDetails } = getAutorestOptions();
 
   if (!tracingInfo) {
     return;
@@ -39,29 +37,13 @@ function writeCreateSpanFunction(file: SourceFile) {
     declarationKind: VariableDeclarationKind.Const,
     declarations: [
       {
-        name: "createSpan",
-        initializer: `createSpanFunction({
+        name: "tracingClient",
+        initializer: `createTracingClient({
         namespace: "${tracingInfo.namespace}",
-        packagePrefix: "${tracingInfo.packagePrefix}"
+        packageName: "${packageDetails.name}",
+        packageVersion: "${packageDetails.version}"
       });`
       }
     ]
   });
 }
-
-function getTelemetryPackageName({ nameWithoutScope }: PackageDetails) {
-  return nameWithoutScope
-    .split(/[-._ ]+/)
-    .map(part => normalizeName(part, NameType.Class));
-}
-
-function getTelemetryNamespace(packageDetails: PackageDetails) {
-  const { scopeName } = packageDetails;
-
-  return [
-    ...(scopeName ? [scopeName] : []),
-    ...getTelemetryPackageName(packageDetails)
-  ]
-    .map(part => normalizeName(part, NameType.Class))
-    .join(".");
-}

package/src/generators/utils/pagingOperations.ts

@@ -52,7 +52,6 @@ export function addPagingImports(
   const { disablePagingAsyncIterators } = getAutorestOptions();
   if (!disablePagingAsyncIterators && hasAsyncIteratorOperations(operations)) {
     sourceFile.addImportDeclarations([
-      { moduleSpecifier: "@azure/core-paging" },
       {
         namedImports: ["PagedAsyncIterableIterator"],
         moduleSpecifier: "@azure/core-paging"
@@ -231,7 +230,7 @@ export function writeAsyncIterators(
  * This method enforces Azure SDK Typescript guideline that paging methods should be named list*
  * https://azure.github.io/azure-sdk/typescript_design.html#ts-pagination-provide-list
  */
-function getPublicMethodName(operation: OperationDetails) {
+export function getPublicMethodName(operation: OperationDetails) {
   let initialOperationName = normalizeName(operation.name, NameType.Operation);
   if (initialOperationName.indexOf("list") === 0) {
     initialOperationName = initialOperationName.replace("list", "");

package/src/generators/utils/tracingUtils.ts

@@ -14,11 +14,7 @@ export function addTracingOperationImports(
   if (tracingInfo) {
     sourceFile.addImportDeclarations([
       {
-        namedImports: ["CanonicalCode"],
-        moduleSpecifier: "@opentelemetry/api"
-      },
-      {
-        namedImports: ["createSpan"],
+        namedImports: ["tracingClient"],
         moduleSpecifier: `${traverseToRoot}/tracing`
       }
     ]);

package/src/main.ts

@@ -1,7 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { AutoRestExtension, Host } from "@autorest/extension-base";
+import {
+  AutoRestExtension,
+  AutorestExtensionHost
+} from "@autorest/extension-base";
 import { generateTypeScriptLibrary } from "./typescriptGenerator";
 import { generateRestLevelClient } from "./restLevelClient/generateRestLevel";
 import {
@@ -10,7 +13,7 @@ import {
   getAutorestOptions
 } from "./autorestSession";
 
-export async function processRequest(host: Host) {
+export async function processRequest(host: AutorestExtensionHost) {
   await initializeSession(host);
   const session = getSession();
   const { restLevelClient } = getAutorestOptions();
@@ -19,7 +22,7 @@ export async function processRequest(host: Host) {
     restLevelClient
       ? await generateRestLevelClient()
       : await generateTypeScriptLibrary(session.model, host);
-    session.log(`Autorest.Typescript took ${Date.now() - start}ms`, "");
+    session.info(`Autorest.Typescript took ${Date.now() - start}ms`);
   } catch (err) {
     session.error("An error was encountered while handling a request:", err);
     throw err;
@@ -28,8 +31,8 @@ export async function processRequest(host: Host) {
 
 async function main() {
   const pluginHost = new AutoRestExtension();
-  pluginHost.Add("typescript", processRequest);
-  await pluginHost.Run();
+  pluginHost.add("typescript", processRequest);
+  await pluginHost.run();
 }
 
 main();

package/src/models/clientDetails.ts

@@ -9,6 +9,8 @@ import { ObjectDetails } from "./modelDetails";
 import { EndpointDetails } from "../transforms/urlTransforms";
 import { KnownMediaType } from "@azure-tools/codegen";
 import { Info } from "@autorest/codemodel";
+import { SampleGroup } from "./sampleDetails";
+import { Security } from "@autorest/codemodel";
 
 export interface ClientOptions {
   mediaTypes?: Set<KnownMediaType>;
@@ -17,7 +19,12 @@ export interface ClientOptions {
 
 export interface TracingInfo {
   namespace: string;
-  packagePrefix: string;
+  packagePrefix?: string;
+}
+
+export interface DependencyInfo {
+  link: string;
+  description: string;
 }
 
 export interface ClientDetails {
@@ -32,4 +39,7 @@ export interface ClientDetails {
   parameters: ParameterDetails[];
   options: ClientOptions;
   endpoint: EndpointDetails;
+  samples?: SampleGroup[];
+  allTypes: string[];
+  security: Security
 }

package/src/models/modelDetails.ts

@@ -65,7 +65,7 @@ export type PolymorphicObjectDetails = BasicObjectDetails & {
 export interface PropertyDetails {
   name: string;
   description?: string;
-  defaultValue?: string;
+  defaultValue?: string | number | boolean;
   serializedName: string;
   type: string;
   required: boolean;
@@ -83,7 +83,7 @@ export interface TypeDetails {
   typeName: string;
   isConstant?: boolean;
   nullable?: boolean;
-  defaultValue?: string;
+  defaultValue?: string | number | boolean;
   kind: PropertyKind;
   usedModels: string[];
 }

package/src/models/operationDetails.ts

@@ -103,6 +103,7 @@ export interface OperationSpecDetails {
 export interface OperationGroupDetails {
   key: string;
   name: string;
+  originalKey: string;
   operations: OperationDetails[];
   mediaTypes: Set<KnownMediaType>;
   isTopLevel: boolean;