@azure-tools/typespec-ts 0.56.0-dev.1 → 0.56.0-dev.11

package/src/rlc-common/static/polling-content.ts

@@ -1,225 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-export const pollingContent = `
-import type { Client, HttpResponse } from "@azure-rest/core-client";
-import type { AbortSignalLike } from "@azure/abort-controller";
-import type {
-  CancelOnProgress,
-  CreateHttpPollerOptions,
-  RunningOperation,
-  OperationResponse,
-  OperationState,
-} from "@azure/core-lro";
- import { createHttpPoller } from "@azure/core-lro";
-{{#if clientOverload}}
-import type {
-  {{#each importedResponses}}
-  {{this}},
-  {{/each}}
-} from "./responses.js";
-{{/if}}
-
-/**
- * A simple poller that can be used to poll a long running operation.
- */
-export interface SimplePollerLike<
-  TState extends OperationState<TResult>,
-  TResult
-> {
-  /**
-   * Returns true if the poller has finished polling.
-   */
-  isDone(): boolean;
-  /**
-   * Returns the state of the operation.
-   */
-  getOperationState(): TState;
-  /**
-   * Returns the result value of the operation,
-   * regardless of the state of the poller.
-   * It can return undefined or an incomplete form of the final TResult value
-   * depending on the implementation.
-   */
-  getResult(): TResult | undefined;
-  /**
-   * Returns a promise that will resolve once a single polling request finishes.
-   * It does this by calling the update method of the Poller's operation.
-   */
-  poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>;
-  /**
-   * Returns a promise that will resolve once the underlying operation is completed.
-   */
-  pollUntilDone(pollOptions?: {
-    abortSignal?: AbortSignalLike;
-  }): Promise<TResult>;
-  /**
-   * Invokes the provided callback after each polling is completed,
-   * sending the current state of the poller's operation.
-   *
-   * It returns a method that can be used to stop receiving updates on the given callback function.
-   */
-  onProgress(callback: (state: TState) => void): CancelOnProgress;
-
-  /**
-   * Returns a promise that could be used for serialized version of the poller's operation
-   * by invoking the operation's serialize method.
-   */
-  serialize(): Promise<string>;
-
-  /**
-   * Wait the poller to be submitted.
-   */
-  submitted(): Promise<void>;
-
-  /**
-   * Returns a string representation of the poller's operation. Similar to serialize but returns a string.
-   * @deprecated Use serialize() instead.
-   */
-  toString(): string;
-
-  /**
-   * Stops the poller from continuing to poll. Please note this will only stop the client-side polling
-   * @deprecated Use abortSignal to stop polling instead.
-   */
-  stopPolling(): void;
-
-  /**
-   * Returns true if the poller is stopped.
-   * @deprecated Use abortSignal status to track this instead.
-   */
-  isStopped(): boolean;
-}
-
-/**
- * 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.
- */
-{{#if clientOverload}}
-{{#each overloadMap}}
-export async function getLongRunningPoller<
-  TResult extends {{ this.finalResponses }}
->(
-  client: Client,
-  initialResponse: {{ this.initialResponses }},
-  options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>
-): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
-{{/each}}
-{{/if}}
-export async function getLongRunningPoller<TResult extends HttpResponse>(
-    client: Client,
-    initialResponse: TResult,
-    options: CreateHttpPollerOptions<TResult, OperationState<TResult>> = {}
-    ): Promise<SimplePollerLike<OperationState<TResult>, TResult>> { 
-  const abortController = new AbortController();
-  const poller: RunningOperation<TResult> = {
-    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: string,
-      pollOptions?: { abortSignal?: AbortSignalLike }
-    ) => {
-      // 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.
-      function abortListener(): void {
-        abortController.abort();
-      }
-      const inputAbortSignal = pollOptions?.abortSignal;
-      const abortSignal = abortController.signal;
-      if (inputAbortSignal?.aborted) {
-        abortController.abort();
-      } else if (!abortSignal.aborted) {
-        inputAbortSignal?.addEventListener("abort", abortListener, {
-          once: true
-        });
-      }
-      let response;
-      try {
-        response = await client
-          .pathUnchecked(path ?? initialResponse.request.url)
-          .get({ abortSignal });
-      } finally {
-        inputAbortSignal?.removeEventListener("abort", abortListener);
-      }
-      const lroResponse = getLroResponse(response as TResult);
-      lroResponse.rawResponse.headers["x-ms-original-url"] =
-        initialResponse.request.url;
-      return lroResponse;
-    }
-  };
-
-  options.resolveOnUnsuccessful = options.resolveOnUnsuccessful ?? true;
-  const httpPoller = createHttpPoller(poller, options);
-  const simplePoller: SimplePollerLike<OperationState<TResult>, TResult> = {
-    isDone() {
-      return httpPoller.isDone;
-    },
-    isStopped() {
-      return abortController.signal.aborted;
-    },
-    getOperationState() {
-      if (!httpPoller.operationState) {
-        throw new Error(
-          "Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState()."
-        );
-      }
-      return httpPoller.operationState;
-    },
-    getResult() {
-      return httpPoller.result;
-    },
-    toString() {
-      if (!httpPoller.operationState) {
-        throw new Error(
-          "Operation state is not available. The poller may not have been started and you could await submitted() before calling getOperationState()."
-        );
-      }
-      return JSON.stringify({
-        state: httpPoller.operationState
-      });
-    },
-    stopPolling() {
-      abortController.abort();
-    },
-    onProgress: httpPoller.onProgress,
-    poll: httpPoller.poll,
-    pollUntilDone: httpPoller.pollUntilDone,
-    serialize: httpPoller.serialize,
-    submitted: httpPoller.submitted
-  };
-  return simplePoller;
-}
-
-/**
- * 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
-): OperationResponse<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
-    }
-  };
-}
-`;

package/src/rlc-common/static/sample-template.ts

@@ -1,56 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-export const sampleTemplate = `
-{{#each importedTypes}}
-{{this}}
-{{/each}}
-import "dotenv/config";
-
-{{#each samples}}
-/**
- * This sample demonstrates how to {{this.description}}
- *
- * @summary {{this.description}}
- {{#if this.originalFileLocation}}
- * x-ms-original-file: {{this.originalFileLocation}}
- {{/if}}
- */
-async function {{name}}(): Promise<void>  {
-  {{#each this.clientParamAssignments}}
-  {{this}}
-  {{/each}}
-  const client = {{this.defaultFactoryName}}({{this.clientParamNames}});
-  {{#each this.pathParamAssignments}}
-  {{this}}
-  {{/each}}
-  {{#each this.methodParamAssignments}}
-  {{this}}
-  {{/each}}
-  {{#if this.isPaging}}
-  const initialResponse = await client.path({{this.pathParamNames}}).{{method}}({{methodParamNames}});
-  const pageData = paginate(client, initialResponse);
-  const result = [];
-  for await (const item of pageData) {
-    result.push(item);
-  }
-  {{else if this.isLRO}}
-  const initialResponse ={{#unless this.useLegacyLro}} await{{/unless}} client.path({{this.pathParamNames}}).{{method}}({{methodParamNames}});
-  const poller = await getLongRunningPoller(client, initialResponse);
-  const result = await poller.pollUntilDone();
-  {{else}}
-  const result = await client.path({{this.pathParamNames}}).{{method}}({{methodParamNames}});
-  {{/if}}
-  console.log(result);
-}
-
-{{/each}}
-
-async function main(): Promise<void> {
-{{#each samples}}
-  await {{this.name}}();
-{{/each}}
-}
-
-main().catch(console.error);
-`;

package/src/rlc-common/static/serialize-helper.ts

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

package/src/rlc-common/test/build-karma-config.ts

@@ -1,12 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
-import { RLCModel } from "../interfaces.js";
-import { karmaConfig } from "./template.js";
-
-export function buildKarmaConfigFile(_model: RLCModel) {
-  return {
-    path: "karma.conf.js",
-    content: hbs.compile(karmaConfig, { noEscape: true })({}),
-  };
-}

package/src/rlc-common/test/build-recorded-client.ts

@@ -1,15 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
-import { RLCModel } from "../interfaces.js";
-import { recordedClientContent } from "./template.js";
-
-export function buildRecordedClientFile(_model: RLCModel) {
-  const recordedClientFileContents = hbs.compile(recordedClientContent, {
-    noEscape: true,
-  });
-  return {
-    path: "test/public/utils/recordedClient.ts",
-    content: recordedClientFileContents({}),
-  };
-}

package/src/rlc-common/test/build-sample-test.ts

@@ -1,12 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
-import { RLCModel } from "../interfaces.js";
-import { sampleTestContent } from "./template.js";
-
-export function buildSampleTest(_model: RLCModel) {
-  return {
-    path: "test/public/sampleTest.spec.ts",
-    content: hbs.compile(sampleTestContent, { noEscape: true })({}),
-  };
-}

package/src/rlc-common/test/template.ts

@@ -1,229 +0,0 @@
-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 {
-  Recorder,
-  RecorderStartOptions,
-  VitestTestContext,
-} from "@azure-tools/test-recorder";
-
-const replaceableVariables: Record<string, string> = {
-  SUBSCRIPTION_ID: "azure_subscription_id"
-};
-
-const recorderEnvSetup: RecorderStartOptions = {
-  envSetupForPlayback: replaceableVariables,
-};
-
-/**
- * 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: VitestTestContext): Promise<Recorder> {
-  const recorder = new Recorder(context);
-  await recorder.start(recorderEnvSetup);
-  return recorder;
-}
-`;
-
-export const sampleTestContent = `
-// import { Recorder } from "@azure-tools/test-recorder";
-// import { createRecorder } from "./utils/recordedClient.js";
-import { assert, 
-         // beforeEach,
-         // afterEach,
-         it,
-         describe
-} from "vitest";
-
-describe("My test", () => {
-  // let recorder: Recorder;
-
-  // beforeEach(async function(ctx) {
-    // recorder = await createRecorder(ctx);
-  // });
-
-  // afterEach(async function() {
-    // await recorder.stop();
-  // });
-
-  it("sample test", async function() {
-    assert.equal(1, 1);
-  });
-});
-`;
-
-export const snippetsContent = `
-import { {{ clientClassName }} } from "../src/index.js";
-import { DefaultAzureCredential, InteractiveBrowserCredential } from "@azure/identity";
-import { setLogLevel } from "@azure/logger";
-import { describe, it } from "vitest";
-
-describe("snippets", () => {
-  it("ReadmeSampleCreateClient_Node", async () => {
-    {{#if azureArm}}
-    {{#if hasSubscriptionId}}
-    const subscriptionId = "00000000-0000-0000-0000-000000000000";
-    const client = new {{ clientClassName }}(new DefaultAzureCredential(), subscriptionId);
-    {{else}}
-    const client = new {{ clientClassName }}(new DefaultAzureCredential());
-    {{/if}}
-    {{else}}
-    const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredential());
-    {{/if}}
-  });
-
-  it("ReadmeSampleCreateClient_Browser", async () => {
-    {{#if azureArm}}
-    const credential = new InteractiveBrowserCredential({
-      tenantId: "<YOUR_TENANT_ID>",
-      clientId: "<YOUR_CLIENT_ID>",
-    });
-    {{#if hasSubscriptionId}}
-    const subscriptionId = "00000000-0000-0000-0000-000000000000";
-    const client = new {{ clientClassName }}(credential, subscriptionId);
-    {{else}}
-    const client = new {{ clientClassName }}(credential);
-    {{/if}}
-    {{else}}
-    const credential = new InteractiveBrowserCredential({
-      tenantId: "<YOUR_TENANT_ID>",
-      clientId: "<YOUR_CLIENT_ID>",
-    });
-    const client = new {{ clientClassName }}("<endpoint>", credential);
-    {{/if}}
-  });
-
-  it("SetLogLevel", async () => {
-    setLogLevel("info");
-  });
-});
-`;