@azure-tools/rlc-common 0.11.0

package/dist-esm/static/pollingContent.js

@@ -0,0 +1,95 @@
+export const pollingContent = `
+import { Client, HttpResponse } from "@azure-rest/core-client";
+{{#if useLegacyLro}}
+import {
+  LongRunningOperation,
+  LroEngine,
+  LroEngineOptions,
+  LroResponse,
+  PollerLike,
+  PollOperationState
+} from "@azure/core-lro";
+{{else}}
+import {
+  CreateHttpPollerOptions,
+  LongRunningOperation,
+  LroResponse,
+  OperationState,
+  SimplePollerLike,
+  createHttpPoller
+} from "@azure/core-lro";
+{{/if}}
+/**
+ * Helper function that builds a Poller object to help polling a long running operation.
+ * @param client - Client to use for sending the request to get additional pages.
+ * @param initialResponse - The initial response.
+ * @param options - Options to set a resume state or custom polling interval.
+ * @returns - A poller object to poll for operation state updates and eventually get the final response.
+ */
+export {{#unless useLegacyLro}}async {{/unless}}function getLongRunningPoller<TResult extends HttpResponse>(
+  client: Client,
+  initialResponse: TResult,
+  {{#if useLegacyLro}}
+  options: LroEngineOptions<TResult, PollOperationState<TResult>> = {}
+  ): PollerLike<PollOperationState<TResult>, TResult> {
+    {{else}}
+    options: CreateHttpPollerOptions<TResult, OperationState<TResult>> = {}
+    ): Promise<SimplePollerLike<OperationState<TResult>, TResult>> {
+    {{/if}}  
+    const poller: LongRunningOperation<TResult> = {
+    requestMethod: initialResponse.request.method,
+    requestPath: initialResponse.request.url,
+    sendInitialRequest: async () => {
+      // In the case of Rest Clients we are building the LRO poller object from a response that's the reason
+      // we are not triggering the initial request here, just extracting the information from the
+      // response we were provided.
+      return getLroResponse(initialResponse);
+    },
+    sendPollRequest: async path => {
+      // This is the callback that is going to be called to poll the service
+      // to get the latest status. We use the client provided and the polling path
+      // which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location
+      // depending on the lro pattern that the service implements. If non is provided we default to the initial path.
+      const response = await client
+        .pathUnchecked(path ?? initialResponse.request.url)
+        .get();
+      const lroResponse = getLroResponse(response as TResult);
+      lroResponse.rawResponse.headers["x-ms-original-url"] =
+        initialResponse.request.url;
+      return lroResponse;
+    }
+  };
+
+  {{#if useLegacyLro}}
+  return new LroEngine(poller, options);
+  {{else}}
+  options.resolveOnUnsuccessful = options.resolveOnUnsuccessful ?? true;
+  return await createHttpPoller(poller, options);
+  {{/if}}
+}
+
+/**
+ * Converts a Rest Client response to a response that the LRO implementation understands
+ * @param response - a rest client http response
+ * @returns - An LRO response that the LRO implementation understands
+ */
+function getLroResponse<TResult extends HttpResponse>(
+  response: TResult
+): LroResponse<TResult> {
+  if (Number.isNaN(response.status)) {
+    throw new TypeError(
+      \`Status code of the response is not a number. Value: \${response.status}\`
+    );
+  }
+
+  return {
+    flatResponse: response,
+    rawResponse: {
+      ...response,
+      statusCode: Number.parseInt(response.status),
+      body: response.body
+    }
+  };
+}
+`;
+//# sourceMappingURL=pollingContent.js.map

package/dist-esm/static/pollingContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pollingContent.js","sourceRoot":"","sources":["../../src/static/pollingContent.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6F7B,CAAC"}

package/dist-esm/static/serializeHelper.js

@@ -0,0 +1,27 @@
+export const buildMultiCollectionContent = `
+export function buildMultiCollection(
+  queryParameters: string[],
+  parameterName: string
+) {
+  return queryParameters
+    .map((item, index) => {
+      if (index === 0) {
+        return item;
+      }
+      return \`\${parameterName}=\${item}\`;
+    })
+    .join("&");
+}`;
+export const buildPipeCollectionContent = `
+export function buildPipeCollection(queryParameters: string[]): string {
+  return queryParameters.join("|");
+}`;
+export const buildSsvCollectionContent = `
+export function buildSsvCollection(queryParameters: string[]): string {
+  return queryParameters.join(" ");
+}`;
+export const buildTsvCollectionContent = `
+export function buildTsvCollection(queryParameters: string[]) {
+  return queryParameters.join("\\t");
+}`;
+//# sourceMappingURL=serializeHelper.js.map

package/dist-esm/static/serializeHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializeHelper.js","sourceRoot":"","sources":["../../src/static/serializeHelper.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,2BAA2B,GAAG;;;;;;;;;;;;;EAazC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG;;;EAGxC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG;;;EAGvC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG;;;EAGvC,CAAC"}

package/dist-esm/test/buildEnvFile.js

@@ -0,0 +1,24 @@
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { envContent } from "./template.js";
+export function buildEnvFile(model) {
+    const generateTest = Boolean(model.options?.generateTest);
+    if (!generateTest) {
+        return;
+    }
+    return {
+        path: "test/public/utils/env.ts",
+        content: hbs.compile(envContent, { noEscape: true })({})
+    };
+}
+export function buildEnvBrowserFile(model) {
+    const generateTest = Boolean(model.options?.generateTest);
+    if (!generateTest) {
+        return;
+    }
+    return {
+        path: "test/public/utils/env.browser.ts",
+        content: hbs.compile("", { noEscape: true })({})
+    };
+}
+//# sourceMappingURL=buildEnvFile.js.map

package/dist-esm/test/buildEnvFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildEnvFile.js","sourceRoot":"","sources":["../../src/test/buildEnvFile.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,MAAM,UAAU,YAAY,CAAC,KAAe;IAC1C,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IACD,OAAO;QACL,IAAI,EAAE,0BAA0B;QAChC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAe;IACjD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IACD,OAAO;QACL,IAAI,EAAE,kCAAkC;QACxC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KACjD,CAAC;AACJ,CAAC"}

package/dist-esm/test/buildKarmaConfig.js

@@ -0,0 +1,14 @@
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { karmaConfig } from "./template.js";
+export function buildKarmaConfigFile(model) {
+    const generateTest = Boolean(model.options?.generateTest);
+    if (!generateTest) {
+        return;
+    }
+    return {
+        path: "karma.conf.js",
+        content: hbs.compile(karmaConfig, { noEscape: true })({})
+    };
+}
+//# sourceMappingURL=buildKarmaConfig.js.map

package/dist-esm/test/buildKarmaConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildKarmaConfig.js","sourceRoot":"","sources":["../../src/test/buildKarmaConfig.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,UAAU,oBAAoB,CAAC,KAAe;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IACD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KAC1D,CAAC;AACJ,CAAC"}

package/dist-esm/test/buildRecordedClient.js

@@ -0,0 +1,17 @@
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { recordedClientContent } from "./template.js";
+export function buildRecordedClientFile(model) {
+    const generateTest = Boolean(model.options?.generateTest);
+    if (!generateTest) {
+        return;
+    }
+    const recordedClientFileContents = hbs.compile(recordedClientContent, {
+        noEscape: true
+    });
+    return {
+        path: "test/public/utils/recordedClient.ts",
+        content: recordedClientFileContents({})
+    };
+}
+//# sourceMappingURL=buildRecordedClient.js.map

package/dist-esm/test/buildRecordedClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildRecordedClient.js","sourceRoot":"","sources":["../../src/test/buildRecordedClient.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,MAAM,UAAU,uBAAuB,CAAC,KAAe;IACrD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IACD,MAAM,0BAA0B,GAAG,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE;QACpE,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,OAAO;QACL,IAAI,EAAE,qCAAqC;QAC3C,OAAO,EAAE,0BAA0B,CAAC,EAAE,CAAC;KACxC,CAAC;AACJ,CAAC"}

package/dist-esm/test/buildSampleTest.js

@@ -0,0 +1,14 @@
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { sampleTestContent } from "./template.js";
+export function buildSampleTest(model) {
+    const generateTest = Boolean(model.options?.generateTest);
+    if (!generateTest) {
+        return;
+    }
+    return {
+        path: "test/public/sampleTest.spec.ts",
+        content: hbs.compile(sampleTestContent, { noEscape: true })({})
+    };
+}
+//# sourceMappingURL=buildSampleTest.js.map

package/dist-esm/test/buildSampleTest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildSampleTest.js","sourceRoot":"","sources":["../../src/test/buildSampleTest.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAGlD,MAAM,UAAU,eAAe,CAAC,KAAe;IAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IACD,OAAO;QACL,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KAChE,CAAC;AACJ,CAAC"}

package/dist-esm/test/template.js

@@ -0,0 +1,188 @@
+export const envContent = `
+import * as dotenv from "dotenv";
+
+dotenv.config();
+`;
+export const envBrowserContent = `
+import * as dotenv from "dotenv";
+
+dotenv.config();
+`;
+export const karmaConfig = `
+// 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-firefox-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",
+      "RECORDINGS_RELATIVE_PATH",
+    ],
+
+    // 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",
+      },
+    },
+  });
+};
+`;
+export const recordedClientContent = `
+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;
+}
+`;
+export const sampleTestContent = `
+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);
+  });
+});
+`;
+//# sourceMappingURL=template.js.map

package/dist-esm/test/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../../src/test/template.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG;;;;CAIzB,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG;;;;CAIhC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8H1B,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BpC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG;;;;;;;;;;;;;;;;;;;;;CAqBhC,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@azure-tools/rlc-common",
+  "version": "0.11.0",
+  "description": "",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist-esm/index.js",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist-esm/index.js"
+    }
+  },
+  "types": "./types/index.d.ts",
+  "scripts": {
+    "lint": "eslint src --ext .ts --max-warnings=0",
+    "lint:fix": "eslint src --fix --ext .ts",
+    "format": "npm run -s prettier -- --write",
+    "check-format": "npm run prettier -- --check",
+    "prettier": "prettier --config ./.prettierrc src/**/*.ts",
+    "build": "rimraf dist/* dist-esm/* types/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && node publishPackage.js",
+    "build:cjs": "rimraf dist/* dist-esm/* types/* && tsc -p tsconfig-cjs.json && node publishPackage.js",
+    "build:esm": "rimraf dist/* dist-esm/* types/* && tsc -p tsconfig.json && node publishPackage.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "ts-morph": "^15.1.0",
+    "lodash": "^4.17.21",
+    "handlebars": "^4.7.7"
+  },
+  "devDependencies": {
+    "@types/node": "^18.0.0",
+    "eslint": "^8.9.0",
+    "prettier": "~2.7.1",
+    "typescript": "~4.8.0",
+    "rimraf": "^3.0.2",
+    "@types/lodash": "^4.14.182",
+    "fs-extra": "^10.0.0",
+    "@types/fs-extra": "^8.1.0",
+    "ts-node": "^10.7.0"
+  }
+}

package/publishPackage.js

@@ -0,0 +1,11 @@
+import { writeFileSync } from "fs";
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const p = require("./package.json");
+
+const cjsPackage = { ...p, type: "commonjs" };
+writeFileSync("./dist/package.json", JSON.stringify(cjsPackage));
+
+
+const esmPackage = { ...p, type: "module" };
+writeFileSync("./dist-esm/package.json", JSON.stringify(esmPackage));

package/rlc-common.build.log

@@ -0,0 +1,2 @@
+Invoking: rimraf dist/* dist-esm/* types/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && node publishPackage.js 
+