@azure-tools/rlc-common 1.0.0-beta.1 → 1.0.0-beta.4

package/src/buildIsUnexpectedHelper.ts

@@ -22,9 +22,9 @@ export function buildIsUnexpectedHelper(model: RLCModel) {
   });
 
   let map: Record<string, string[]> = {};
-  let allResponseTypes: Set<string> = new Set();
-  let allErrorTypes: Set<string> = new Set();
-  let overloads: OptionalKind<FunctionDeclarationOverloadStructure>[] = [];
+  const allResponseTypes: Set<string> = new Set();
+  const allErrorTypes: Set<string> = new Set();
+  const overloads: OptionalKind<FunctionDeclarationOverloadStructure>[] = [];
   const pathDictionary = model.paths;
 
   for (const [path, details] of Object.entries(pathDictionary)) {
@@ -112,7 +112,7 @@ export function buildIsUnexpectedHelper(model: RLCModel) {
           } pathDetails = responseMap[\`\${method} \${url.pathname}\`];
           if (!pathDetails) {`,
         hasTemplate
-          ? "pathDetails = geParametrizedPathSuccess(method, url.pathname);"
+          ? "pathDetails = getParametrizedPathSuccess(method, url.pathname);"
           : `return true;`,
         `  }
           return !pathDetails.includes(response.status);
@@ -122,7 +122,7 @@ export function buildIsUnexpectedHelper(model: RLCModel) {
     if (hasTemplate) {
       isErrorHelper.addFunction({
         isExported: false,
-        name: "geParametrizedPathSuccess",
+        name: "getParametrizedPathSuccess",
         parameters: [
           {
             name: "method",
@@ -136,75 +136,75 @@ export function buildIsUnexpectedHelper(model: RLCModel) {
         returnType: `string[]`,
         statements: [
           `
-        const pathParts = path.split("/");
-
-        // Iterate the responseMap to find a match
-        for (const [key, value] of Object.entries(responseMap)) {
-          // Extracting the path from the map key which is in format
-          // GET /path/foo
-          if (!key.startsWith(method)) {
-            continue;
-          }
-          const candidatePath = getPathFromMapKey(key);
-          // Get each part of the url path
-          const candidateParts = candidatePath.split("/");
-      
-          // If the candidate and actual paths don't match in size
-          // we move on to the next candidate path
-          if (
-            candidateParts.length === pathParts.length &&
-            hasParametrizedPath(key)
-          ) {
+          const pathParts = path.split("/");
+            
+          // Traverse list to match the longest candidate
+          // matchedLen: the length of candidate path
+          // matchedValue: the matched status code array
+          let matchedLen = -1,
+            matchedValue: string[] = [];
+          
+          // Iterate the responseMap to find a match
+          for (const [key, value] of Object.entries(responseMap)) {
+            // Extracting the path from the map key which is in format
+            // GET /path/foo
+            if (!key.startsWith(method)) {
+              continue;
+            }
+            const candidatePath = getPathFromMapKey(key);
+            // Get each part of the url path
+            const candidateParts = candidatePath.split("/");
+        
             // track if we have found a match to return the values found.
             let found = true;
-            for (let i = 0; i < candidateParts.length; i++) {
+            for (
+              let i = candidateParts.length - 1, j = pathParts.length - 1;
+              i >= 1 && j >= 1;
+              i--, j--
+            ) {
               if (
                 candidateParts[i]?.startsWith("{") &&
-                candidateParts[i]?.endsWith("}")
+                candidateParts[i]?.indexOf("}") !== -1
               ) {
+                const start = candidateParts[i]!.indexOf("}") + 1,
+                  end = candidateParts[i]?.length;
                 // If the current part of the candidate is a "template" part
-                // it is a match with the actual path part on hand
-                // skip as the parameterized part can match anything
+                // Try to use the suffix of pattern to match the path
+                // {guid} ==> $
+                // {guid}:export ==> :export$
+                const isMatched = new RegExp(
+                  \`\${candidateParts[i]?.slice(start, end)}\`
+                ).test(pathParts[j] || '');
+        
+                if (!isMatched) {
+                  found = false;
+                  break;
+                }
                 continue;
               }
-      
+        
               // If the candidate part is not a template and
               // the parts don't match mark the candidate as not found
               // to move on with the next candidate path.
-              if (candidateParts[i] !== pathParts[i]) {
+              if (candidateParts[i] !== pathParts[j]) {
                 found = false;
                 break;
               }
             }
-      
+        
             // We finished evaluating the current candidate parts
-            // if all parts matched we return the success values form
-            // the path mapping.
-            if (found) {
-              return value;
+            // Update the matched value if and only if we found the longer pattern
+            if (found && candidatePath.length > matchedLen) {
+              matchedLen = candidatePath.length;
+              matchedValue = value;
             }
           }
-        }
-      
-        // No match was found, return an empty array.
-        return [];
+        
+          return matchedValue;
         `
         ]
       });
 
-      isErrorHelper.addFunction({
-        isExported: false,
-        name: "hasParametrizedPath",
-        parameters: [
-          {
-            name: "path",
-            type: "string"
-          }
-        ],
-        returnType: `boolean`,
-        statements: [`return path.includes("/{");`]
-      });
-
       isErrorHelper.addFunction({
         isExported: false,
         name: "getPathFromMapKey",

package/src/buildMethodShortcuts.ts

@@ -22,7 +22,7 @@ export const REST_CLIENT_RESERVED: ReservedName[] = [
 ];
 
 export function buildMethodShortcutImplementation(paths: Paths) {
-  let keys: Record<string, string[]> = {};
+  const keys: Record<string, string[]> = {};
   for (const path of Object.keys(paths)) {
     const groupName = normalizeName(
       paths[path].operationGroupName,

package/src/buildObjectTypes.ts

@@ -123,7 +123,7 @@ function getPolymorphicTypeAlias(
   }
 
   const description = objectSchema.description;
-  
+
   return {
     kind: StructureKind.TypeAlias,
     ...(description && { docs: [{ description }] }),
@@ -316,7 +316,7 @@ function getImmediateParentsNames(
     return [];
   }
 
-  let extendFrom: string[] = [];
+  const extendFrom: string[] = [];
 
   // If an immediate parent is a DictionarySchema, that means that the object has been marked
   // with additional properties. We need to add Record<string, unknown> to the extend list and
@@ -350,7 +350,13 @@ function getPropertySignatures(
   schemaUsage: SchemaContext[],
   importedModels: Set<string>
 ) {
-  return Object.keys(properties).map((p) =>
+  let validProperties = Object.keys(properties);
+  if (schemaUsage.includes(SchemaContext.Input)) {
+    validProperties = validProperties.filter((p) => {
+      return !properties[p].readOnly;
+    });
+  }
+  return validProperties.map((p) =>
     getPropertySignature(
       { ...properties[p], name: p },
       schemaUsage,
@@ -374,11 +380,7 @@ export function getPropertySignature(
 
   const description = property.description;
   const type =
-    ((schemaUsage.includes(SchemaContext.Output) &&
-      property.usage?.includes(SchemaContext.Output)) ||
-      (schemaUsage.includes(SchemaContext.Exception) &&
-        property.usage?.includes(SchemaContext.Exception))) &&
-    property.outputTypeName
+    generateForOutput(schemaUsage, property.usage) && property.outputTypeName
       ? property.outputTypeName
       : property.typeName
       ? property.typeName
@@ -387,7 +389,21 @@ export function getPropertySignature(
     name: propertyName,
     ...(description && { docs: [{ description }] }),
     hasQuestionToken: !property.required,
+    isReadonly:
+      generateForOutput(schemaUsage, property.usage) && property.readOnly,
     type,
     kind: StructureKind.PropertySignature
   };
 }
+
+function generateForOutput(
+  schemaUsage: SchemaContext[],
+  propertyUsage?: SchemaContext[]
+) {
+  return (
+    (schemaUsage.includes(SchemaContext.Output) &&
+      propertyUsage?.includes(SchemaContext.Output)) ||
+    (schemaUsage.includes(SchemaContext.Exception) &&
+      propertyUsage?.includes(SchemaContext.Exception))
+  );
+}

package/src/buildParameterTypes.ts

@@ -11,12 +11,12 @@ import {
 import * as path from "path";
 import {
   ImportKind,
+  ObjectSchema,
   ParameterMetadata,
   ParameterMetadatas,
   RLCModel,
   Schema
 } from "./interfaces.js";
-import { NameType, normalizeName } from "./helpers/nameUtils.js";
 import {
   getParameterBaseName,
   getParameterTypeName
@@ -92,6 +92,11 @@ export function buildParameterTypes(model: RLCModel) {
         i
       );
 
+      const bodyTypeAlias = buildBodyTypeAlias(parameter);
+      if (bodyTypeAlias) {
+        parametersFile.addTypeAlias(bodyTypeAlias);
+      }
+
       // Add interfaces for body and query parameters
       parametersFile.addInterfaces([
         ...(bodyParameterDefinition ?? []),
@@ -215,7 +220,7 @@ function getPropertyFromSchema(schema: Schema): PropertySignatureStructure {
     name: schema.name,
     ...(description && { docs: [{ description }] }),
     type: schema.type,
-    hasQuestionToken: !Boolean(schema.required),
+    hasQuestionToken: !schema.required,
     kind: StructureKind.PropertySignature
   };
 }
@@ -296,8 +301,12 @@ function buildHeaderParameterDefinitions(
     baseName
   );
 
+  let isOptional = true;
   if (headersInterface) {
     parametersFile.addInterface(headersInterface);
+    isOptional = !(headersInterface.properties || []).some(
+      (prop) => prop.hasQuestionToken === false
+    );
   }
 
   internalReferences.add(headerParameterInterfaceName);
@@ -310,7 +319,8 @@ function buildHeaderParameterDefinitions(
       {
         name: "headers",
         type: `RawHttpHeadersInput & ${baseName}Headers`,
-        kind: StructureKind.PropertySignature
+        kind: StructureKind.PropertySignature,
+        hasQuestionToken: isOptional
       }
     ]
   };
@@ -433,3 +443,49 @@ function buildBodyParametersDefinition(
     ];
   }
 }
+
+export function buildBodyTypeAlias(parameters: ParameterMetadatas) {
+  const bodyParameters = parameters.body;
+  if (
+    !bodyParameters ||
+    !bodyParameters?.body ||
+    !bodyParameters?.body.length
+  ) {
+    return undefined;
+  }
+  const schema = bodyParameters.body[0] as ObjectSchema;
+  const headerParameters = (parameters.parameters || []).filter(
+    (p) => p.type === "header" && p.name === "contentType"
+  );
+  if (!headerParameters.length || headerParameters.length > 1) {
+    return undefined;
+  }
+
+  const contentType = headerParameters[0].param.type;
+  const readOnlyProperties = [];
+  if (schema.properties) {
+    for (const propertyName of Object.keys(schema.properties)) {
+      const prop = schema.properties[propertyName];
+      if (prop?.readOnly) {
+        if (propertyName.startsWith('"') && propertyName.endsWith('"')) {
+          readOnlyProperties.push(`${propertyName}`);
+        } else {
+          readOnlyProperties.push(`"${propertyName}"`);
+        }
+      }
+    }
+  }
+
+  const description = `${schema.description}`;
+  const typeName = `${schema.typeName}ResourceMergeAndPatch`;
+  if (contentType.includes("application/merge-patch+json")) {
+    const type = `Partial<${schema.typeName}>`;
+    return {
+      // kind: StructureKind.TypeAlias,
+      ...(description && { docs: [{ description }] }),
+      name: `${typeName}`,
+      type,
+      isExported: true
+    };
+  }
+}

package/src/buildResponseTypes.ts

@@ -125,7 +125,7 @@ function getResponseHeaderInterfaceDefinition(
         name: h.name,
         ...(description && { docs: [{ description }] }),
         type: h.type,
-        hasQuestionToken: !Boolean(h.required)
+        hasQuestionToken: !h.required
       };
     })
   };

package/src/helpers/nameConstructors.ts

@@ -18,7 +18,7 @@ export function getResponseTypeName(
   operationName?: string,
   statusCode?: string
 ): string {
-  if (Boolean(operationName)) {
+  if (operationName) {
     baseNameOrOperationGroup = getResponseBaseName(
       baseNameOrOperationGroup,
       operationName!,
@@ -79,7 +79,7 @@ export function getParameterTypeName(
   baseNameOrOperationGroup: string,
   operationName?: string
 ) {
-  if (Boolean(operationName)) {
+  if (operationName) {
     baseNameOrOperationGroup = getParameterBaseName(
       baseNameOrOperationGroup,
       operationName!

package/src/helpers/nameUtils.ts

@@ -202,7 +202,7 @@ function toCasing(str: string, casing: CasingConvention): string {
 }
 
 function getNameParts(name: string) {
-  let parts = name.split(/[-._ ]+/);
+  const parts = name.split(/[-._ ]+/);
 
   return parts.length > 0 ? parts : [name];
 }

package/src/helpers/operationHelpers.ts

@@ -26,7 +26,7 @@ export function buildMethodDefinitions(
 
     for (const method of verbMethods) {
       const description = method.description;
-      let areAllOptional = method.hasOptionalOptions;
+      const areAllOptional = method.hasOptionalOptions;
 
       methodDefinitions.push({
         name: key,

package/src/helpers/schemaHelpers.ts

@@ -22,4 +22,4 @@ export function isConstantSchema(schema: Schema) {
     return true;
   }
   return false;
-}
+}

package/src/helpers/shortcutMethods.ts

@@ -13,7 +13,7 @@ import { NameType, normalizeName } from "./nameUtils.js";
 export function generateMethodShortcuts(
   paths: Paths
 ): OptionalKind<InterfaceDeclarationStructure>[] {
-  let keys: Record<string, OptionalKind<MethodSignatureStructure>[]> = {};
+  const keys: Record<string, OptionalKind<MethodSignatureStructure>[]> = {};
   for (const path in paths) {
     const groupName = paths[path].operationGroupName;
     const definitions = buildOperationDefinitions(paths[path]);

package/src/interfaces.ts

@@ -14,9 +14,15 @@ export interface RLCModel {
   urlInfo?: UrlInfo;
 }
 
+export interface PathTemplateApiVersion {
+  value: string;
+  templateName: string;
+}
+
 export interface UrlInfo {
   endpoint?: string;
   urlParameters?: PathParameter[];
+  pathTemplateApiVersion?: PathTemplateApiVersion;
 }
 export interface AnnotationDetails {
   hasPaging?: boolean;
@@ -63,6 +69,7 @@ export type PathParameter = {
   name: string;
   type: string;
   description?: string;
+  value?: string | number | boolean;
 };
 
 export interface OperationAnnotations {
@@ -89,6 +96,7 @@ export interface RLCOptions {
   productDocLink?: string;
   serviceInfo?: ServiceInfo;
   azureArm?: boolean;
+  "sdk-folder"?: string;
 }
 
 export interface ServiceInfo {

package/src/metadata/buildPackageFile.ts

@@ -57,7 +57,6 @@ function restLevelPackage(model: RLCModel, hasSamplesGenerated: boolean) {
   if (packageDetails.version.includes("beta")) {
     apiRefUrlQueryParameter = "?view=azure-node-preview";
   }
-  const description = packageDetails.description;
   const hasPaging = hasPagingOperations(model);
   const hasLRO = hasPollingOperations(model);
   const packageInfo: Record<string, any> = {
@@ -146,7 +145,7 @@ function restLevelPackage(model: RLCModel, hasSamplesGenerated: boolean) {
       prettier: "2.2.1",
       rimraf: "^3.0.0",
       "source-map-support": "^0.5.9",
-      typescript: "~4.6.0"
+      typescript: "~4.8.0"
     }
   };
 
@@ -196,6 +195,7 @@ function restLevelPackage(model: RLCModel, hasSamplesGenerated: boolean) {
     packageInfo.devDependencies["@azure/identity"] = "^2.0.1";
     packageInfo.devDependencies["@azure-tools/test-recorder"] = "^2.0.0";
     packageInfo.devDependencies["mocha"] = "^7.1.1";
+    packageInfo.devDependencies["@types/mocha"] = "^7.0.2";
     packageInfo.devDependencies["mocha-junit-reporter"] = "^1.18.0";
     packageInfo.devDependencies["cross-env"] = "^7.0.2";
     packageInfo.devDependencies["@types/chai"] = "^4.2.8";

package/src/metadata/buildReadmeFile.ts

@@ -35,7 +35,7 @@ Key links:
 
 ### Currently supported environments
 
-- Node.js version 14.x.x or higher
+- LTS versions of Node.js
 
 ### Prerequisites
 
@@ -72,7 +72,7 @@ AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
 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");
 \`\`\`
@@ -168,7 +168,7 @@ function createMetadata(model: RLCModel): Metadata | undefined {
   const clientPackageName = packageDetails?.name;
   const clientClassName = getClientName(model);
   const serviceName = getServiceName(model);
-  var apiRefUrlQueryParameter: string = "";
+  let apiRefUrlQueryParameter: string = "";
   if (packageDetails?.version.includes("beta")) {
     apiRefUrlQueryParameter = "?view=azure-node-preview";
   }

package/src/static/paginateContent.ts

@@ -156,7 +156,7 @@ function checkPagingRequest(response: PathUncheckedResponse): void {
   ];
   if (!Http2xxStatusCodes.includes(response.status)) {
     throw createRestError(
-      \`Pagination failed with unexpected statusCode \${response.status\}\`,
+      \`Pagination failed with unexpected statusCode \${response.status}\`,
       response
     );
   }

package/src/test/template.ts

@@ -65,6 +65,7 @@ module.exports = function (config) {
       "AZURE_CLIENT_ID",
       "AZURE_TENANT_ID",
       "SUBSCRIPTION_ID",
+      "RECORDINGS_RELATIVE_PATH",
     ],
 
     // test results reporter to use

package/types/buildParameterTypes.d.ts

@@ -1,5 +1,13 @@
-import { RLCModel } from "./interfaces.js";
+import { ParameterMetadatas, RLCModel } from "./interfaces.js";
 export declare function buildParameterTypes(model: RLCModel): {
     path: string;
     content: string;
 } | undefined;
+export declare function buildBodyTypeAlias(parameters: ParameterMetadatas): {
+    name: string;
+    type: string;
+    isExported: boolean;
+    docs?: {
+        description: string;
+    }[] | undefined;
+} | undefined;

package/types/interfaces.d.ts

@@ -11,9 +11,14 @@ export interface RLCModel {
     annotations?: AnnotationDetails;
     urlInfo?: UrlInfo;
 }
+export interface PathTemplateApiVersion {
+    value: string;
+    templateName: string;
+}
 export interface UrlInfo {
     endpoint?: string;
     urlParameters?: PathParameter[];
+    pathTemplateApiVersion?: PathTemplateApiVersion;
 }
 export interface AnnotationDetails {
     hasPaging?: boolean;
@@ -54,6 +59,7 @@ export declare type PathParameter = {
     name: string;
     type: string;
     description?: string;
+    value?: string | number | boolean;
 };
 export interface OperationAnnotations {
     isLongRunning?: boolean;
@@ -78,6 +84,7 @@ export interface RLCOptions {
     productDocLink?: string;
     serviceInfo?: ServiceInfo;
     azureArm?: boolean;
+    "sdk-folder"?: string;
 }
 export interface ServiceInfo {
     title?: string;

package/types/test/template.d.ts

@@ -1,5 +1,5 @@
 export declare const envContent = "\nimport * as dotenv from \"dotenv\";\n\ndotenv.config();\n";
 export declare const envBrowserContent = "\nimport * as dotenv from \"dotenv\";\n\ndotenv.config();\n";
-export declare const karmaConfig = "\n// https://github.com/karma-runner/karma-chrome-launcher\nprocess.env.CHROME_BIN = require(\"puppeteer\").executablePath();\nrequire(\"dotenv\").config();\nconst { relativeRecordingsPath } = require(\"@azure-tools/test-recorder\");\nprocess.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();\n\nmodule.exports = function (config) {\n  config.set({\n    // base path that will be used to resolve all patterns (eg. files, exclude)\n    basePath: \"./\",\n\n    // frameworks to use\n    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter\n    frameworks: [\"source-map-support\", \"mocha\"],\n\n    plugins: [\n      \"karma-mocha\",\n      \"karma-mocha-reporter\",\n      \"karma-chrome-launcher\",\n      \"karma-edge-launcher\",\n      \"karma-firefox-launcher\",\n      \"karma-ie-launcher\",\n      \"karma-env-preprocessor\",\n      \"karma-coverage\",\n      \"karma-sourcemap-loader\",\n      \"karma-junit-reporter\",\n      \"karma-source-map-support\",\n    ],\n\n    // list of files / patterns to load in the browser\n    files: [\n      \"dist-test/index.browser.js\",\n      { pattern: \"dist-test/index.browser.js.map\", type: \"html\", included: false, served: true },\n    ],\n\n    // list of files / patterns to exclude\n    exclude: [],\n\n    // preprocess matching files before serving them to the browser\n    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor\n    preprocessors: {\n      \"**/*.js\": [\"sourcemap\", \"env\"],\n      // IMPORTANT: COMMENT following line if you want to debug in your browsers!!\n      // Preprocess source file to calculate code coverage, however this will make source file unreadable\n      // \"dist-test/index.js\": [\"coverage\"]\n    },\n\n    envPreprocessor: [\n      \"TEST_MODE\",\n      \"ENDPOINT\",\n      \"AZURE_CLIENT_SECRET\",\n      \"AZURE_CLIENT_ID\",\n      \"AZURE_TENANT_ID\",\n      \"SUBSCRIPTION_ID\",\n    ],\n\n    // test results reporter to use\n    // possible values: 'dots', 'progress'\n    // available reporters: https://npmjs.org/browse/keyword/karma-reporter\n    reporters: [\"mocha\", \"coverage\", \"junit\"],\n\n    coverageReporter: {\n      // specify a common output directory\n      dir: \"coverage-browser/\",\n      reporters: [\n        { type: \"json\", subdir: \".\", file: \"coverage.json\" },\n        { type: \"lcovonly\", subdir: \".\", file: \"lcov.info\" },\n        { type: \"html\", subdir: \"html\" },\n        { type: \"cobertura\", subdir: \".\", file: \"cobertura-coverage.xml\" },\n      ],\n    },\n\n    junitReporter: {\n      outputDir: \"\", // results will be saved as $outputDir/$browserName.xml\n      outputFile: \"test-results.browser.xml\", // if included, results will be saved as $outputDir/$browserName/$outputFile\n      suite: \"\", // suite will become the package name attribute in xml testsuite element\n      useBrowserName: false, // add browser name to report and classes names\n      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element\n      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element\n      properties: {}, // key value pair of properties to add to the <properties> section of the report\n    },\n\n    // web server port\n    port: 9876,\n\n    // enable / disable colors in the output (reporters and logs)\n    colors: true,\n\n    // level of logging\n    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG\n    logLevel: config.LOG_INFO,\n\n    // enable / disable watching file and executing tests whenever any file changes\n    autoWatch: false,\n\n    // --no-sandbox allows our tests to run in Linux without having to change the system.\n    // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.\n    browsers: [\"ChromeHeadlessNoSandbox\"],\n    customLaunchers: {\n      ChromeHeadlessNoSandbox: {\n        base: \"ChromeHeadless\",\n        flags: [\"--no-sandbox\", \"--disable-web-security\"],\n      },\n    },\n\n    // Continuous Integration mode\n    // if true, Karma captures browsers, runs the tests and exits\n    singleRun: false,\n\n    // Concurrency level\n    // how many browser should be started simultaneous\n    concurrency: 1,\n\n    browserNoActivityTimeout: 60000000,\n    browserDisconnectTimeout: 10000,\n    browserDisconnectTolerance: 3,\n\n    client: {\n      mocha: {\n        // change Karma's debug.html to the mocha web reporter\n        reporter: \"html\",\n        timeout: \"600000\",\n      },\n    },\n  });\n};\n";
+export declare const karmaConfig = "\n// https://github.com/karma-runner/karma-chrome-launcher\nprocess.env.CHROME_BIN = require(\"puppeteer\").executablePath();\nrequire(\"dotenv\").config();\nconst { relativeRecordingsPath } = require(\"@azure-tools/test-recorder\");\nprocess.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();\n\nmodule.exports = function (config) {\n  config.set({\n    // base path that will be used to resolve all patterns (eg. files, exclude)\n    basePath: \"./\",\n\n    // frameworks to use\n    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter\n    frameworks: [\"source-map-support\", \"mocha\"],\n\n    plugins: [\n      \"karma-mocha\",\n      \"karma-mocha-reporter\",\n      \"karma-chrome-launcher\",\n      \"karma-edge-launcher\",\n      \"karma-firefox-launcher\",\n      \"karma-ie-launcher\",\n      \"karma-env-preprocessor\",\n      \"karma-coverage\",\n      \"karma-sourcemap-loader\",\n      \"karma-junit-reporter\",\n      \"karma-source-map-support\",\n    ],\n\n    // list of files / patterns to load in the browser\n    files: [\n      \"dist-test/index.browser.js\",\n      { pattern: \"dist-test/index.browser.js.map\", type: \"html\", included: false, served: true },\n    ],\n\n    // list of files / patterns to exclude\n    exclude: [],\n\n    // preprocess matching files before serving them to the browser\n    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor\n    preprocessors: {\n      \"**/*.js\": [\"sourcemap\", \"env\"],\n      // IMPORTANT: COMMENT following line if you want to debug in your browsers!!\n      // Preprocess source file to calculate code coverage, however this will make source file unreadable\n      // \"dist-test/index.js\": [\"coverage\"]\n    },\n\n    envPreprocessor: [\n      \"TEST_MODE\",\n      \"ENDPOINT\",\n      \"AZURE_CLIENT_SECRET\",\n      \"AZURE_CLIENT_ID\",\n      \"AZURE_TENANT_ID\",\n      \"SUBSCRIPTION_ID\",\n      \"RECORDINGS_RELATIVE_PATH\",\n    ],\n\n    // test results reporter to use\n    // possible values: 'dots', 'progress'\n    // available reporters: https://npmjs.org/browse/keyword/karma-reporter\n    reporters: [\"mocha\", \"coverage\", \"junit\"],\n\n    coverageReporter: {\n      // specify a common output directory\n      dir: \"coverage-browser/\",\n      reporters: [\n        { type: \"json\", subdir: \".\", file: \"coverage.json\" },\n        { type: \"lcovonly\", subdir: \".\", file: \"lcov.info\" },\n        { type: \"html\", subdir: \"html\" },\n        { type: \"cobertura\", subdir: \".\", file: \"cobertura-coverage.xml\" },\n      ],\n    },\n\n    junitReporter: {\n      outputDir: \"\", // results will be saved as $outputDir/$browserName.xml\n      outputFile: \"test-results.browser.xml\", // if included, results will be saved as $outputDir/$browserName/$outputFile\n      suite: \"\", // suite will become the package name attribute in xml testsuite element\n      useBrowserName: false, // add browser name to report and classes names\n      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element\n      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element\n      properties: {}, // key value pair of properties to add to the <properties> section of the report\n    },\n\n    // web server port\n    port: 9876,\n\n    // enable / disable colors in the output (reporters and logs)\n    colors: true,\n\n    // level of logging\n    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG\n    logLevel: config.LOG_INFO,\n\n    // enable / disable watching file and executing tests whenever any file changes\n    autoWatch: false,\n\n    // --no-sandbox allows our tests to run in Linux without having to change the system.\n    // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.\n    browsers: [\"ChromeHeadlessNoSandbox\"],\n    customLaunchers: {\n      ChromeHeadlessNoSandbox: {\n        base: \"ChromeHeadless\",\n        flags: [\"--no-sandbox\", \"--disable-web-security\"],\n      },\n    },\n\n    // Continuous Integration mode\n    // if true, Karma captures browsers, runs the tests and exits\n    singleRun: false,\n\n    // Concurrency level\n    // how many browser should be started simultaneous\n    concurrency: 1,\n\n    browserNoActivityTimeout: 60000000,\n    browserDisconnectTimeout: 10000,\n    browserDisconnectTolerance: 3,\n\n    client: {\n      mocha: {\n        // change Karma's debug.html to the mocha web reporter\n        reporter: \"html\",\n        timeout: \"600000\",\n      },\n    },\n  });\n};\n";
 export declare const recordedClientContent = "\nimport { Context } from \"mocha\";\nimport { Recorder, RecorderStartOptions } from \"@azure-tools/test-recorder\";\nimport \"./env\";\n\nconst envSetupForPlayback: Record<string, string> = {\n  ENDPOINT: \"https://endpoint\",\n  AZURE_CLIENT_ID: \"azure_client_id\",\n  AZURE_CLIENT_SECRET: \"azure_client_secret\",\n  AZURE_TENANT_ID: \"88888888-8888-8888-8888-888888888888\",\n  SUBSCRIPTION_ID: \"azure_subscription_id\"\n};\n\nconst recorderEnvSetup: RecorderStartOptions = {\n  envSetupForPlayback\n};\n\n/**\n* creates the recorder and reads the environment variables from the `.env` file.\n* Should be called first in the test suite to make sure environment variables are\n* read before they are being used.\n*/\nexport async function createRecorder(context: Context): Promise<Recorder> {\n  const recorder = new Recorder(context.currentTest);\n  await recorder.start(recorderEnvSetup);\n  return recorder;\n}\n";
 export declare const sampleTestContent = "\nimport { Recorder } from \"@azure-tools/test-recorder\";\nimport { assert } from \"chai\";\nimport { createRecorder } from \"./utils/recordedClient\";\nimport { Context } from \"mocha\";\n\ndescribe(\"My test\", () => {\n  let recorder: Recorder;\n\n  beforeEach(async function(this: Context) {\n    recorder = await createRecorder(this);\n  });\n\n  afterEach(async function() {\n    await recorder.stop();\n  });\n\n  it(\"sample test\", async function() {\n    assert.equal(1, 1);\n  });\n});\n";