@azure-tools/rlc-common 1.0.0-beta.8 → 1.0.0-beta.9

package/src/test/template.ts

@@ -30,9 +30,7 @@ module.exports = function (config) {
       "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",

package/types/buildSerializeHelper.d.ts

@@ -0,0 +1,5 @@
+import { RLCModel } from "./interfaces.js";
+export declare function buildSerializeHelper(model: RLCModel): {
+    path: string;
+    content: any;
+} | undefined;

package/types/helpers/operationHelpers.d.ts

@@ -4,6 +4,10 @@ export declare function buildMethodDefinitions(methods: Methods, pathParams?: Pa
 export declare function getPathParamDefinitions(pathParams: PathParameter[]): OptionalKind<ParameterDeclarationStructure>[];
 export declare function hasPagingOperations(model: RLCModel): boolean;
 export declare function hasPollingOperations(model: RLCModel): boolean;
+export declare function hasMultiCollection(model: RLCModel): boolean;
+export declare function hasPipeCollection(model: RLCModel): boolean;
+export declare function hasSsvCollection(model: RLCModel): boolean;
+export declare function hasTsvCollection(model: RLCModel): boolean;
 export declare function hasUnexpectedHelper(model: RLCModel): boolean;
 export declare function hasInputModels(model: RLCModel): boolean;
 export declare function hasOutputModels(model: RLCModel): boolean;

package/types/helpers/pathUtils.d.ts

@@ -0,0 +1 @@
+export declare function getRelativePartFromSrcPath(srcPath: string): string;

package/types/index.d.ts

@@ -23,3 +23,4 @@ export * from "./metadata/buildRollupConfig.js";
 export * from "./metadata/buildTsConfig.js";
 export * from "./metadata/buildESLintConfig.js";
 export * from "./metadata/buildLicenseFile.js";
+export * from "./buildSerializeHelper.js";

package/types/interfaces.d.ts

@@ -24,6 +24,10 @@ export interface AnnotationDetails {
     hasPaging?: boolean;
     hasLongRunning?: boolean;
     pageDetails?: PagingDetails;
+    hasMultiCollection?: boolean;
+    hasPipeCollection?: boolean;
+    hasSsvCollection?: boolean;
+    hasTsvCollection?: boolean;
 }
 export interface PagingDetails {
     itemNames: string[];
@@ -84,6 +88,7 @@ export interface RLCOptions {
     productDocLink?: string;
     serviceInfo?: ServiceInfo;
     azureArm?: boolean;
+    sourceFrom?: "Cadl" | "Swagger";
 }
 export interface ServiceInfo {
     title?: string;

package/types/static/pollingContent.d.ts

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

package/types/static/serializeHelper.d.ts

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

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      \"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 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-firefox-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";