@azure-tools/typespec-ts 0.11.0 → 0.12.0-alpha.20230501.1

package/test/integration/generated/lro/lroRPC/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "plugins": ["@azure/azure-sdk"],
+  "extends": ["plugin:@azure/azure-sdk/azure-sdk-base"],
+  "rules": {
+    "@azure/azure-sdk/ts-modules-only-named": "warn",
+    "@azure/azure-sdk/ts-apiextractor-json-types": "warn",
+    "@azure/azure-sdk/ts-package-json-types": "warn",
+    "@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
+    "tsdoc/syntax": "warn"
+  }
+}

package/test/integration/generated/lro/{lroBasic → lroRPC}/README.md

@@ -1,12 +1,12 @@
-# AzureLro REST client library for JavaScript
+# SpecsAzureCoreLroRpc REST client library for JavaScript
 
-All the basic lro test shall be added in this file
+Illustrates bodies templated with Azure Core with long-running operation
 
 **Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
 
 Key links:
 
-- [Package (NPM)](https://www.npmjs.com/package/@msinternal/lro-basic)
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/lro-rpc)
 
 ## Getting started
 
@@ -18,15 +18,15 @@ Key links:
 
 - You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
 
-### Install the `@msinternal/lro-basic` package
+### Install the `@msinternal/lro-rpc` package
 
-Install the AzureLro REST client REST client library for JavaScript with `npm`:
+Install the SpecsAzureCoreLroRpc REST client REST client library for JavaScript with `npm`:
 
 ```bash
-npm install @msinternal/lro-basic
+npm install @msinternal/lro-rpc
 ```
 
-### Create and authenticate a `AzureLroClient`
+### Create and authenticate a `SpecsAzureCoreLroRpcClient`
 
 To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
 provide an instance of the desired credential type obtained from the

package/test/integration/generated/lro/lroRPC/api-extractor.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "./types/index.d.ts",
+  "docModel": { "enabled": true },
+  "apiReport": { "enabled": true, "reportFolder": "./review" },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "./types/lro-rpc.d.ts"
+  },
+  "messages": {
+    "tsdocMessageReporting": { "default": { "logLevel": "none" } },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": { "logLevel": "none" },
+      "ae-unresolved-link": { "logLevel": "none" }
+    }
+  }
+}

package/test/integration/generated/lro/lroRPC/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@msinternal/lro-rpc",
+  "sdk-type": "client",
+  "author": "Microsoft Corporation",
+  "version": "1.0.0",
+  "description": "LRO RPC Test Service",
+  "keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "./dist-esm/index.js",
+  "types": "./types/lro-rpc.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/lro-rpc.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-lro": "^2.5.0",
+    "@azure/abort-controller": "^1.0.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/lro/lroRPC/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/lro/lroRPC/src/clientDefinitions.ts

@@ -0,0 +1,79 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  CreateJobParameters,
+  GetJobParameters,
+  CreateJobFinalOnLocationParameters,
+  GetPollParameters,
+} from "./parameters";
+import {
+  CreateJob200Response,
+  CreateJob202Response,
+  CreateJobDefaultResponse,
+  GetJob200Response,
+  GetJobDefaultResponse,
+  CreateJobFinalOnLocation200Response,
+  CreateJobFinalOnLocation202Response,
+  CreateJobFinalOnLocationDefaultResponse,
+  GetPoll200Response,
+  GetPollDefaultResponse,
+} from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface CreateJob {
+  /** Creates a Job */
+  post(
+    options?: CreateJobParameters
+  ): StreamableMethod<
+    CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse
+  >;
+}
+
+export interface GetJob {
+  /** Gets the status of a Job */
+  get(
+    options?: GetJobParameters
+  ): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
+}
+
+export interface CreateJobFinalOnLocation {
+  /** Creates a Job */
+  post(
+    options?: CreateJobFinalOnLocationParameters
+  ): StreamableMethod<
+    | CreateJobFinalOnLocation200Response
+    | CreateJobFinalOnLocation202Response
+    | CreateJobFinalOnLocationDefaultResponse
+  >;
+}
+
+export interface GetPoll {
+  /** Gets the status of a Job */
+  get(
+    options?: GetPollParameters
+  ): StreamableMethod<GetPoll200Response | GetPollDefaultResponse>;
+}
+
+export interface Routes {
+  /** Resource for '/azure/core/lro/rpc/same-poll-result/jobs' has methods for the following verbs: post */
+  (path: "/azure/core/lro/rpc/same-poll-result/jobs"): CreateJob;
+  /** Resource for '/azure/core/lro/rpc/same-poll-result/jobs/\{jobId\}' has methods for the following verbs: get */
+  (
+    path: "/azure/core/lro/rpc/same-poll-result/jobs/{jobId}",
+    jobId: string
+  ): GetJob;
+  /** Resource for '/azure/core/lro/rpc/different-poll-result/jobs' has methods for the following verbs: post */
+  (
+    path: "/azure/core/lro/rpc/different-poll-result/jobs"
+  ): CreateJobFinalOnLocation;
+  /** Resource for '/azure/core/lro/rpc/different-poll-result/jobs/operations/\{operationId\}' has methods for the following verbs: get */
+  (
+    path: "/azure/core/lro/rpc/different-poll-result/jobs/operations/{operationId}",
+    operationId: string
+  ): GetPoll;
+}
+
+export type SpecsAzureCoreLroRpcClient = Client & {
+  path: Routes;
+};

package/test/integration/generated/lro/lroRPC/src/index.ts

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

package/test/integration/generated/lro/lroRPC/src/isUnexpected.ts

@@ -0,0 +1,153 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  CreateJob200Response,
+  CreateJob202Response,
+  CreateJobLogicalResponse,
+  CreateJobDefaultResponse,
+  GetJob200Response,
+  GetJobLogicalResponse,
+  GetJobDefaultResponse,
+  CreateJobFinalOnLocation200Response,
+  CreateJobFinalOnLocation202Response,
+  CreateJobFinalOnLocationLogicalResponse,
+  CreateJobFinalOnLocationDefaultResponse,
+  GetPoll200Response,
+  GetPollLogicalResponse,
+  GetPollDefaultResponse,
+} from "./responses";
+
+const responseMap: Record<string, string[]> = {
+  "POST /azure/core/lro/rpc/same-poll-result/jobs": ["200", "202"],
+  "GET /azure/core/lro/rpc/same-poll-result/jobs": ["200", "202"],
+  "GET /azure/core/lro/rpc/same-poll-result/jobs/{jobId}": ["200"],
+  "POST /azure/core/lro/rpc/different-poll-result/jobs": ["200", "202"],
+  "GET /azure/core/lro/rpc/different-poll-result/jobs": ["200", "202"],
+  "GET /azure/core/lro/rpc/different-poll-result/jobs/operations/{operationId}":
+    ["200"],
+};
+
+export function isUnexpected(
+  response:
+    | CreateJob200Response
+    | CreateJob202Response
+    | CreateJobLogicalResponse
+    | CreateJobDefaultResponse
+): response is CreateJobDefaultResponse;
+export function isUnexpected(
+  response: GetJob200Response | GetJobLogicalResponse | GetJobDefaultResponse
+): response is GetJobDefaultResponse;
+export function isUnexpected(
+  response:
+    | CreateJobFinalOnLocation200Response
+    | CreateJobFinalOnLocation202Response
+    | CreateJobFinalOnLocationLogicalResponse
+    | CreateJobFinalOnLocationDefaultResponse
+): response is CreateJobFinalOnLocationDefaultResponse;
+export function isUnexpected(
+  response: GetPoll200Response | GetPollLogicalResponse | GetPollDefaultResponse
+): response is GetPollDefaultResponse;
+export function isUnexpected(
+  response:
+    | CreateJob200Response
+    | CreateJob202Response
+    | CreateJobLogicalResponse
+    | CreateJobDefaultResponse
+    | GetJob200Response
+    | GetJobLogicalResponse
+    | GetJobDefaultResponse
+    | CreateJobFinalOnLocation200Response
+    | CreateJobFinalOnLocation202Response
+    | CreateJobFinalOnLocationLogicalResponse
+    | CreateJobFinalOnLocationDefaultResponse
+    | GetPoll200Response
+    | GetPollLogicalResponse
+    | GetPollDefaultResponse
+): response is
+  | CreateJobDefaultResponse
+  | GetJobDefaultResponse
+  | CreateJobFinalOnLocationDefaultResponse
+  | GetPollDefaultResponse {
+  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/lro/lroRPC/src/models.ts

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Data of the job */
+export interface JobData {
+  /** Comment. */
+  comment: string;
+}

package/test/integration/generated/lro/lroRPC/src/outputModels.ts

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { ErrorModel } from "@azure-rest/core-client";
+
+/** Result of the job */
+export interface JobResultOutput {
+  /** A processing job identifier. */
+  readonly jobId: string;
+  /** Comment. */
+  readonly comment: string;
+  /**
+   * The status of the processing job.
+   *
+   * Possible values: InProgress, Succeeded, Failed, Canceled
+   */
+  readonly status: string;
+  /** Error objects that describes the error when status is "Failed". */
+  readonly errors?: Array<ErrorResponseOutput>;
+  /** The results. */
+  readonly results: string[];
+}
+
+/** A response containing error details. */
+export interface ErrorResponseOutput {
+  /** The error object. */
+  error: ErrorModel;
+}
+
+/** Result of the poll */
+export interface JobPollResultOutput {
+  /** Operation identifier. */
+  readonly operationId: string;
+  /**
+   * The status of the processing job.
+   *
+   * Possible values: InProgress, Succeeded, Failed, Canceled
+   */
+  readonly status: string;
+}

package/test/integration/generated/lro/lroRPC/src/parameters.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+import { JobData } from "./models";
+
+export interface CreateJobBodyParam {
+  body?: JobData;
+}
+
+export type CreateJobParameters = CreateJobBodyParam & RequestParameters;
+export type GetJobParameters = RequestParameters;
+
+export interface CreateJobFinalOnLocationBodyParam {
+  body?: JobData;
+}
+
+export type CreateJobFinalOnLocationParameters =
+  CreateJobFinalOnLocationBodyParam & RequestParameters;
+export type GetPollParameters = RequestParameters;