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

package/{src/generators/static/README.md.hbs → dist/src/generators/static/hlcREADME.md.hbs}

@@ -24,12 +24,15 @@ 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
 
 - An [Azure subscription][azure_sub].
 {{/if}}
 
+{{#if isReleasablePackage}}
 ### Install the `{{ clientPackageName }}` package
 
 Install the {{ clientDescriptiveName }} library for JavaScript with `npm`:
@@ -37,6 +40,7 @@ Install the {{ clientDescriptiveName }} library for JavaScript with `npm`:
 ```bash
 npm install {{ clientPackageName }}
 ```
+{{/if}}
 
 {{#if azure}}
 {{#if addCredentials}}
@@ -45,23 +49,55 @@ npm install {{ clientPackageName }}
 To create a client object to access the {{ serviceName }} API, you will need the `endpoint` of your {{ serviceName }} resource and a `credential`. The {{ clientDescriptiveName }} can use Azure Active Directory credentials to authenticate.
 You can find the endpoint for your {{ serviceName }} resource in the [Azure Portal][azure_portal].
 
-#### Using an Azure Active Directory Credential
+You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
 
-You can authenticate with Azure Active Directory using the [Azure Identity library][azure_identity]. To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
+To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
 
 ```bash
 npm install @azure/identity
 ```
 
-You will also need to register a new AAD application and grant access to {{ serviceName}} by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
+You will also need to **register a new AAD application and grant access to {{ serviceName}}** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
 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`.
 
+For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
+
+{{#if azureArm}}
 ```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 }}
@@ -76,11 +112,11 @@ const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredentia
 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";
+const { setLogLevel } = require("@azure/logger");
 setLogLevel("info");
 ```
 
-For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs]({{ repoURL }}/tree/master/sdk/core/logger).
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs]({{ repoURL }}/tree/main/sdk/core/logger).
 
 {{#if samplesURL}}
 ## Next steps

package/dist/src/generators/static/karma.conf.js.hbs

@@ -0,0 +1,126 @@
+// https://github.com/karma-runner/karma-chrome-launcher
+process.env.CHROME_BIN = require("puppeteer").executablePath();
+require("dotenv").config();
+const { relativeRecordingsPath } = require("@azure-tools/test-recorder");
+process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();
+
+module.exports = function (config) {
+  config.set({
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: "./",
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ["source-map-support", "mocha"],
+
+    plugins: [
+      "karma-mocha",
+      "karma-mocha-reporter",
+      "karma-chrome-launcher",
+      "karma-edge-launcher",
+      "karma-firefox-launcher",
+      "karma-ie-launcher",
+      "karma-env-preprocessor",
+      "karma-coverage",
+      "karma-sourcemap-loader",
+      "karma-junit-reporter",
+      "karma-source-map-support",
+    ],
+
+    // list of files / patterns to load in the browser
+    files: [
+      "dist-test/index.browser.js",
+      { pattern: "dist-test/index.browser.js.map", type: "html", included: false, served: true },
+    ],
+
+    // list of files / patterns to exclude
+    exclude: [],
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      "**/*.js": ["sourcemap", "env"],
+      // IMPORTANT: COMMENT following line if you want to debug in your browsers!!
+      // Preprocess source file to calculate code coverage, however this will make source file unreadable
+      // "dist-test/index.js": ["coverage"]
+    },
+
+    envPreprocessor: [
+      "TEST_MODE",
+      "ENDPOINT",
+      "AZURE_CLIENT_SECRET",
+      "AZURE_CLIENT_ID",
+      "AZURE_TENANT_ID",
+      "SUBSCRIPTION_ID",
+    ],
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ["mocha", "coverage", "junit"],
+
+    coverageReporter: {
+      // specify a common output directory
+      dir: "coverage-browser/",
+      reporters: [
+        { type: "json", subdir: ".", file: "coverage.json" },
+        { type: "lcovonly", subdir: ".", file: "lcov.info" },
+        { type: "html", subdir: "html" },
+        { type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" },
+      ],
+    },
+
+    junitReporter: {
+      outputDir: "", // results will be saved as $outputDir/$browserName.xml
+      outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile
+      suite: "", // suite will become the package name attribute in xml testsuite element
+      useBrowserName: false, // add browser name to report and classes names
+      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element
+      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element
+      properties: {}, // key value pair of properties to add to the <properties> section of the report
+    },
+
+    // web server port
+    port: 9876,
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+    // --no-sandbox allows our tests to run in Linux without having to change the system.
+    // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.
+    browsers: ["ChromeHeadlessNoSandbox"],
+    customLaunchers: {
+      ChromeHeadlessNoSandbox: {
+        base: "ChromeHeadless",
+        flags: ["--no-sandbox", "--disable-web-security"],
+      },
+    },
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: false,
+
+    // Concurrency level
+    // how many browser should be started simultaneous
+    concurrency: 1,
+
+    browserNoActivityTimeout: 60000000,
+    browserDisconnectTimeout: 10000,
+    browserDisconnectTolerance: 3,
+
+    client: {
+      mocha: {
+        // change Karma's debug.html to the mocha web reporter
+        reporter: "html",
+        timeout: "600000",
+      },
+    },
+  });
+};

package/dist/src/generators/static/karmaConfigFileGenerator.d.ts

@@ -0,0 +1,3 @@
+import { Project } from "ts-morph";
+export declare function generateKarmaConfigFile(project: Project): void;
+//# sourceMappingURL=karmaConfigFileGenerator.d.ts.map

package/dist/src/generators/static/karmaConfigFileGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"karmaConfigFileGenerator.d.ts","sourceRoot":"","sources":["../../../../src/generators/static/karmaConfigFileGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAMnC,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,QAavD"}

package/dist/src/generators/static/karmaConfigFileGenerator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateKarmaConfigFile = void 0;
+const path = require("path");
+const fs = require("fs");
+const hbs = require("handlebars");
+const autorestSession_1 = require("../../autorestSession");
+function generateKarmaConfigFile(project) {
+    const { generateTest, restLevelClient } = (0, autorestSession_1.getAutorestOptions)();
+    if (!generateTest || !restLevelClient) {
+        return;
+    }
+    const metadata = {};
+    const file = fs.readFileSync(path.join(__dirname, "karma.conf.js.hbs"), {
+        encoding: "utf-8"
+    });
+    const karmaConfigFileContents = hbs.compile(file, { noEscape: true });
+    project.createSourceFile("karma.conf.js", karmaConfigFileContents(metadata), {
+        overwrite: true
+    });
+}
+exports.generateKarmaConfigFile = generateKarmaConfigFile;
+//# sourceMappingURL=karmaConfigFileGenerator.js.map

package/dist/src/generators/static/karmaConfigFileGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"karmaConfigFileGenerator.js","sourceRoot":"","sources":["../../../../src/generators/static/karmaConfigFileGenerator.ts"],"names":[],"mappings":";;;AACA,6BAA6B;AAC7B,yBAAyB;AACzB,kCAAkC;AAClC,2DAA2D;AAE3D,SAAgB,uBAAuB,CAAC,OAAgB;IACtD,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,IAAA,oCAAkB,GAAE,CAAC;IAC/D,IAAI,CAAC,YAAY,IAAI,CAAC,eAAe,EAAE;QACrC,OAAO;KACR;IACD,MAAM,QAAQ,GAAG,EAAE,CAAA;IACnB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE;QACtE,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;IACH,MAAM,uBAAuB,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,OAAO,CAAC,gBAAgB,CAAC,eAAe,EAAE,uBAAuB,CAAC,QAAQ,CAAC,EAAE;QAC3E,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;AACL,CAAC;AAbD,0DAaC"}

package/dist/src/generators/static/licenseFileGenerator.js

@@ -28,7 +28,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 `;
 function generateLicenseFile(project) {
-    const { licenseHeader, generateMetadata } = autorestSession_1.getAutorestOptions();
+    const { licenseHeader, generateMetadata } = (0, autorestSession_1.getAutorestOptions)();
     if (!generateMetadata) {
         return;
     }

package/dist/src/generators/static/licenseFileGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"licenseFileGenerator.js","sourceRoot":"","sources":["../../../../src/generators/static/licenseFileGenerator.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,2DAA2D;AAE3D,MAAM,cAAc,GAAG;;;gBAGP,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;;;;;;;;;;;;;;;;;;;CAmBvC,CAAC;AAEF,SAAgB,mBAAmB,CAAC,OAAgB;IAClD,MAAM,EAAE,aAAa,EAAE,gBAAgB,EAAE,GAAG,oCAAkB,EAAE,CAAC;IACjE,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO;KACR;IAED,IAAI,aAAa,EAAE;QACjB,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,IAAI,EAAE,EAAE;YACzD,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;KACJ;AACH,CAAC;AAXD,kDAWC"}
+{"version":3,"file":"licenseFileGenerator.js","sourceRoot":"","sources":["../../../../src/generators/static/licenseFileGenerator.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,2DAA2D;AAE3D,MAAM,cAAc,GAAG;;;gBAGP,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;;;;;;;;;;;;;;;;;;;CAmBvC,CAAC;AAEF,SAAgB,mBAAmB,CAAC,OAAgB;IAClD,MAAM,EAAE,aAAa,EAAE,gBAAgB,EAAE,GAAG,IAAA,oCAAkB,GAAE,CAAC;IACjE,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO;KACR;IAED,IAAI,aAAa,EAAE;QACjB,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,IAAI,EAAE,EAAE;YACzD,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;KACJ;AACH,CAAC;AAXD,kDAWC"}

package/dist/src/generators/static/packageFileGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageFileGenerator.d.ts","sourceRoot":"","sources":["../../../../src/generators/static/packageFileGenerator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAI3D,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,aAAa,CAAC,EAAE,aAAa,QA+B9B"}
+{"version":3,"file":"packageFileGenerator.d.ts","sourceRoot":"","sources":["../../../../src/generators/static/packageFileGenerator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAS3D,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,aAAa,CAAC,EAAE,aAAa,QA+B9B"}