@azure-tools/typespec-ts 0.11.0-alpha.20230413.3

package/test/integration/generated/resiliency/devDriven/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@msinternal/dev-driven",
+  "sdk-type": "client",
+  "author": "Microsoft Corporation",
+  "version": "1.0.0",
+  "description": "Dev Driven Test Service",
+  "keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "./dist-esm/index.js",
+  "types": "./types/dev-driven.d.ts",
+  "repository": "github:Azure/azure-sdk-for-js",
+  "bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
+  "files": [
+    "dist/",
+    "dist-esm/",
+    "types/dev-driven.d.ts",
+    "README.md",
+    "LICENSE",
+    "review/*"
+  ],
+  "engines": { "node": ">=14.0.0" },
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build:browser": "echo skipped.",
+    "build:node": "echo skipped.",
+    "build:samples": "echo skipped.",
+    "build:test": "echo skipped.",
+    "build:debug": "echo skipped.",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\" ",
+    "clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+    "execute:samples": "echo skipped",
+    "extract-api": "rimraf review && mkdirp ./review && api-extractor run --local",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\" ",
+    "generate:client": "echo skipped",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "echo skipped",
+    "integration-test": "echo skipped",
+    "lint:fix": "eslint package.json api-extractor.json src  --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json src  --ext .ts",
+    "pack": "npm pack 2>&1",
+    "test:browser": "echo skipped",
+    "test:node": "echo skipped",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "unit-test": "echo skipped",
+    "unit-test:node": "echo skipped",
+    "unit-test:browser": "echo skipped",
+    "build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
+    "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js"
+  },
+  "sideEffects": false,
+  "autoPublish": false,
+  "dependencies": {
+    "@azure/core-auth": "^1.3.0",
+    "@azure-rest/core-client": "^1.1.2",
+    "@azure/core-rest-pipeline": "^1.8.0",
+    "@azure/logger": "^1.0.0",
+    "tslib": "^2.2.0",
+    "@azure/core-paging": "^1.5.0"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.31.1",
+    "autorest": "latest",
+    "@types/node": "^14.0.0",
+    "dotenv": "^16.0.0",
+    "eslint": "^8.0.0",
+    "mkdirp": "^2.1.2",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.0",
+    "source-map-support": "^0.5.9",
+    "typescript": "~5.0.0",
+    "@rollup/plugin-commonjs": "^24.0.0",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-multi-entry": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "rollup": "^2.66.1",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "uglify-js": "^3.4.9"
+  },
+  "type": "module"
+}

package/test/integration/generated/resiliency/devDriven/rollup.config.js

@@ -0,0 +1,118 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollup warning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEval(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+    (warning.id.includes("node_modules/nise") ||
+      warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependency(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer &&
+    warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"],
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true,
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"],
+      }),
+      cjs(),
+      json(),
+      sourcemaps(),
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false,
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false,
+};
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {}),
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies),
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve()],
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/test/integration/generated/resiliency/devDriven/src/clientDefinitions.ts

@@ -0,0 +1,75 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  GetModelParameters,
+  PostModelParameters,
+  GetProtocolPagesParameters,
+  GetConveniencePagesParameters,
+  LroParameters,
+} from "./parameters";
+import {
+  GetModel200Response,
+  PostModel200Response,
+  GetProtocolPages200Response,
+  GetProtocolPagesDefaultResponse,
+  GetConveniencePages200Response,
+  GetConveniencePagesDefaultResponse,
+  Lro200Response,
+} from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface GetModel {
+  /** Get models that you will either return to end users as a raw body, or with a model added during grow up. */
+  get(options?: GetModelParameters): StreamableMethod<GetModel200Response>;
+  /** Post either raw response as a model and pass in 'raw' for mode, or grow up your operation to take a model instead, and put in 'model' as mode. */
+  post(options: PostModelParameters): StreamableMethod<PostModel200Response>;
+}
+
+export interface GetProtocolPages {
+  /** Get pages of protocol bodies. */
+  get(
+    options?: GetProtocolPagesParameters
+  ): StreamableMethod<
+    GetProtocolPages200Response | GetProtocolPagesDefaultResponse
+  >;
+}
+
+export interface GetConveniencePages {
+  /** Get pages of models. */
+  get(
+    options?: GetConveniencePagesParameters
+  ): StreamableMethod<
+    GetConveniencePages200Response | GetConveniencePagesDefaultResponse
+  >;
+}
+
+export interface Lro {
+  /** Long running put request that will either return to end users a final payload of a raw body, or a final payload of a model after the SDK has grown up. */
+  put(options?: LroParameters): StreamableMethod<Lro200Response>;
+}
+
+export interface Routes {
+  /** Resource for '/resiliency/devdriven/customization/model/\{mode\}' has methods for the following verbs: get, post */
+  (
+    path: "/resiliency/devdriven/customization/model/{mode}",
+    mode: "raw" | "model"
+  ): GetModel;
+  /** Resource for '/resiliency/devdriven/customization/paging/protocol/products' has methods for the following verbs: get */
+  (
+    path: "/resiliency/devdriven/customization/paging/protocol/products"
+  ): GetProtocolPages;
+  /** Resource for '/resiliency/devdriven/customization/paging/convenience/products' has methods for the following verbs: get */
+  (
+    path: "/resiliency/devdriven/customization/paging/convenience/products"
+  ): GetConveniencePages;
+  /** Resource for '/resiliency/devdriven/customization/lro/\{mode\}' has methods for the following verbs: put */
+  (
+    path: "/resiliency/devdriven/customization/lro/{mode}",
+    mode: "raw" | "model"
+  ): Lro;
+}
+
+export type ResiliencyDevDrivenClient = Client & {
+  path: Routes;
+};

package/test/integration/generated/resiliency/devDriven/src/index.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import ResiliencyDevDriven from "./resiliencyDevDriven";
+
+export * from "./resiliencyDevDriven";
+export * from "./parameters";
+export * from "./responses";
+export * from "./clientDefinitions";
+export * from "./isUnexpected";
+export * from "./models";
+export * from "./outputModels";
+export * from "./paginateHelper";
+
+export default ResiliencyDevDriven;

package/test/integration/generated/resiliency/devDriven/src/isUnexpected.ts

@@ -0,0 +1,117 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  GetProtocolPages200Response,
+  GetProtocolPagesDefaultResponse,
+  GetConveniencePages200Response,
+  GetConveniencePagesDefaultResponse,
+} from "./responses";
+
+const responseMap: Record<string, string[]> = {
+  "GET /resiliency/devdriven/customization/model/{mode}": ["200"],
+  "POST /resiliency/devdriven/customization/model/{mode}": ["200"],
+  "GET /resiliency/devdriven/customization/paging/protocol/products": ["200"],
+  "GET /resiliency/devdriven/customization/paging/convenience/products": [
+    "200",
+  ],
+  "PUT /resiliency/devdriven/customization/lro/{mode}": ["200"],
+};
+
+export function isUnexpected(
+  response: GetProtocolPages200Response | GetProtocolPagesDefaultResponse
+): response is GetProtocolPagesDefaultResponse;
+export function isUnexpected(
+  response: GetConveniencePages200Response | GetConveniencePagesDefaultResponse
+): response is GetConveniencePagesDefaultResponse;
+export function isUnexpected(
+  response:
+    | GetProtocolPages200Response
+    | GetProtocolPagesDefaultResponse
+    | GetConveniencePages200Response
+    | GetConveniencePagesDefaultResponse
+): response is
+  | GetProtocolPagesDefaultResponse
+  | GetConveniencePagesDefaultResponse {
+  const lroOriginal = response.headers["x-ms-original-url"];
+  const url = new URL(lroOriginal ?? response.request.url);
+  const method = response.request.method;
+  let pathDetails = responseMap[`${method} ${url.pathname}`];
+  if (!pathDetails) {
+    pathDetails = getParametrizedPathSuccess(method, url.pathname);
+  }
+  return !pathDetails.includes(response.status);
+}
+
+function getParametrizedPathSuccess(method: string, path: string): string[] {
+  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 = candidateParts.length - 1, j = pathParts.length - 1;
+      i >= 1 && j >= 1;
+      i--, j--
+    ) {
+      if (
+        candidateParts[i]?.startsWith("{") &&
+        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
+        // 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[j]) {
+        found = false;
+        break;
+      }
+    }
+
+    // We finished evaluating the current candidate parts
+    // Update the matched value if and only if we found the longer pattern
+    if (found && candidatePath.length > matchedLen) {
+      matchedLen = candidatePath.length;
+      matchedValue = value;
+    }
+  }
+
+  return matchedValue;
+}
+
+function getPathFromMapKey(mapKey: string): string {
+  const pathStart = mapKey.indexOf("/");
+  return mapKey.slice(pathStart);
+}

package/test/integration/generated/resiliency/devDriven/src/models.ts

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Input to LRO call */
+export interface Input {
+  /** property on the input */
+  hello: string;
+}

package/test/integration/generated/resiliency/devDriven/src/outputModels.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { Paged } from "@azure/core-paging";
+
+/** Product resource */
+export interface ProductOutput {
+  /** key of product */
+  readonly key: string;
+  /**
+   * received mode
+   *
+   * Possible values: raw, model
+   */
+  received: string;
+}
+
+/** Final response from LRO call */
+export interface LroProductOutput extends ProductOutput {
+  /** Provisioning state returned by the service */
+  provisioningState: string;
+}
+
+/** Paged collection of Product items */
+export type ProductListOutput = Paged<ProductOutput>;

package/test/integration/generated/resiliency/devDriven/src/paginateHelper.ts

@@ -0,0 +1,154 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  getPagedAsyncIterator,
+  PagedAsyncIterableIterator,
+  PagedResult,
+} from "@azure/core-paging";
+import {
+  Client,
+  createRestError,
+  PathUncheckedResponse,
+} from "@azure-rest/core-client";
+
+/**
+ * Helper type to extract the type of an array
+ */
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+
+/**
+ * The type of a custom function that defines how to get a page and a link to the next one if any.
+ */
+export type GetPage<TPage> = (
+  pageLink: string,
+  maxPageSize?: number
+) => Promise<{
+  page: TPage;
+  nextPageLink?: string;
+}>;
+
+/**
+ * Options for the paging helper
+ */
+export interface PagingOptions<TResponse> {
+  /**
+   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
+   */
+  customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+
+/**
+ * Helper type to infer the Type of the paged elements from the response type
+ * This type is generated based on the swagger information for x-ms-pageable
+ * specifically on the itemName property which indicates the property of the response
+ * where the page items are found. The default value is `value`.
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
+ */
+export type PaginateReturn<TResult> = TResult extends {
+  body: { value?: infer TPage };
+}
+  ? GetArrayType<TPage>
+  : Array<unknown>;
+
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+export function paginate<TResponse extends PathUncheckedResponse>(
+  client: Client,
+  initialResponse: TResponse,
+  options: PagingOptions<TResponse> = {}
+): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {
+  // Extract element type from initial response
+  type TElement = PaginateReturn<TResponse>;
+  let firstRun = true;
+  const itemName = "value";
+  const nextLinkName = "nextLink";
+  const { customGetPage } = options;
+  const pagedResult: PagedResult<TElement[]> = {
+    firstPageLink: "",
+    getPage:
+      typeof customGetPage === "function"
+        ? customGetPage
+        : async (pageLink: string) => {
+            const result = firstRun
+              ? initialResponse
+              : await client.pathUnchecked(pageLink).get();
+            firstRun = false;
+            checkPagingRequest(result);
+            const nextLink = getNextLink(result.body, nextLinkName);
+            const values = getElements<TElement>(result.body, itemName);
+            return {
+              page: values,
+              nextPageLink: nextLink,
+            };
+          },
+  };
+
+  return getPagedAsyncIterator(pagedResult);
+}
+
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body: unknown, nextLinkName?: string): string | undefined {
+  if (!nextLinkName) {
+    return undefined;
+  }
+
+  const nextLink = (body as Record<string, unknown>)[nextLinkName];
+
+  if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+    throw new Error(
+      `Body Property ${nextLinkName} should be a string or undefined`
+    );
+  }
+
+  return nextLink;
+}
+
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements<T = unknown>(body: unknown, itemName: string): T[] {
+  const value = (body as Record<string, unknown>)[itemName] as T[];
+
+  // value has to be an array according to the x-ms-pageable extension.
+  // The fact that this must be an array is used above to calculate the
+  // type of elements in the page in PaginateReturn
+  if (!Array.isArray(value)) {
+    throw new Error(
+      `Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`
+    );
+  }
+
+  return value ?? [];
+}
+
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response: PathUncheckedResponse): void {
+  const Http2xxStatusCodes = [
+    "200",
+    "201",
+    "202",
+    "203",
+    "204",
+    "205",
+    "206",
+    "207",
+    "208",
+    "226",
+  ];
+  if (!Http2xxStatusCodes.includes(response.status)) {
+    throw createRestError(
+      `Pagination failed with unexpected statusCode ${response.status}`,
+      response
+    );
+  }
+}

package/test/integration/generated/resiliency/devDriven/src/parameters.ts

@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+import { Input } from "./models";
+
+export type GetModelParameters = RequestParameters;
+
+export interface PostModelBodyParam {
+  /** Please put {'hello': 'world!'} */
+  body: Input;
+}
+
+export type PostModelParameters = PostModelBodyParam & RequestParameters;
+export type GetProtocolPagesParameters = RequestParameters;
+export type GetConveniencePagesParameters = RequestParameters;
+export type LroParameters = RequestParameters;

package/test/integration/generated/resiliency/devDriven/src/resiliencyDevDriven.ts

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { ResiliencyDevDrivenClient } from "./clientDefinitions";
+
+/**
+ * Initialize a new instance of `ResiliencyDevDrivenClient`
+ * @param options type: ClientOptions, the parameter for all optional parameters
+ */
+export default function createClient(
+  options: ClientOptions = {}
+): ResiliencyDevDrivenClient {
+  const baseUrl = options.baseUrl ?? `http://localhost:3000`;
+  options.apiVersion = options.apiVersion ?? "1.0.0";
+  const userAgentInfo = `azsdk-js-dev-driven-rest/1.0.0`;
+  const userAgentPrefix =
+    options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+      : `${userAgentInfo}`;
+  options = {
+    ...options,
+    userAgentOptions: {
+      userAgentPrefix,
+    },
+  };
+
+  const client = getClient(baseUrl, options) as ResiliencyDevDrivenClient;
+
+  return client;
+}