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

package/test/integration/generated/lro/{lroBasic → lroCore}/package.json

@@ -1,20 +1,20 @@
 {
-  "name": "@msinternal/lro-basic",
+  "name": "@msinternal/lro-core",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
   "version": "1.0.0",
-  "description": "LRO Basic Test Service",
+  "description": "LRO Core Test Service",
   "keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
   "license": "MIT",
   "main": "dist/index.js",
   "module": "./dist-esm/index.js",
-  "types": "./types/lro-basic.d.ts",
+  "types": "./types/lro-core.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-basic.d.ts",
+    "types/lro-core.d.ts",
     "README.md",
     "LICENSE",
     "review/*"
@@ -52,7 +52,7 @@
   "autoPublish": false,
   "dependencies": {
     "@azure/core-auth": "^1.3.0",
-    "@azure-rest/core-client": "^1.1.0",
+    "@azure-rest/core-client": "^1.1.2",
     "@azure/core-rest-pipeline": "^1.8.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0",
@@ -69,7 +69,7 @@
     "prettier": "^2.5.1",
     "rimraf": "^3.0.0",
     "source-map-support": "^0.5.9",
-    "typescript": "~4.8.0",
+    "typescript": "~5.0.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-multi-entry": "^6.0.0",

package/test/integration/generated/lro/lroCore/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/lroCore/src/clientDefinitions.ts

@@ -0,0 +1,54 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  CreateOrReplaceParameters,
+  DeleteParameters,
+  ExportParameters,
+} from "./parameters";
+import {
+  CreateOrReplace200Response,
+  CreateOrReplace201Response,
+  CreateOrReplaceDefaultResponse,
+  Delete202Response,
+  DeleteDefaultResponse,
+  Export202Response,
+  ExportDefaultResponse,
+} from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface CreateOrReplace {
+  /** Creates or replaces a User */
+  put(
+    options: CreateOrReplaceParameters
+  ): StreamableMethod<
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceDefaultResponse
+  >;
+  /** Deletes a User */
+  delete(
+    options?: DeleteParameters
+  ): StreamableMethod<Delete202Response | DeleteDefaultResponse>;
+}
+
+export interface Export {
+  /** Exports a User */
+  post(
+    options: ExportParameters
+  ): StreamableMethod<Export202Response | ExportDefaultResponse>;
+}
+
+export interface Routes {
+  /** Resource for '/azure/core/lro/standard/users/\{name\}' has methods for the following verbs: put, delete */
+  (
+    path: "/azure/core/lro/standard/users/{name}",
+    name: string
+  ): CreateOrReplace;
+  /** Resource for '/azure/core/lro/standard/users/\{name\}:export' has methods for the following verbs: post */
+  (path: "/azure/core/lro/standard/users/{name}:export", name: string): Export;
+}
+
+export type SpecsAzureCoreLroStandardClient = Client & {
+  path: Routes;
+};

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

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

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

@@ -0,0 +1,135 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  CreateOrReplace200Response,
+  CreateOrReplace201Response,
+  CreateOrReplaceLogicalResponse,
+  CreateOrReplaceDefaultResponse,
+  Delete202Response,
+  DeleteLogicalResponse,
+  DeleteDefaultResponse,
+  Export202Response,
+  ExportLogicalResponse,
+  ExportDefaultResponse,
+} from "./responses";
+
+const responseMap: Record<string, string[]> = {
+  "PUT /azure/core/lro/standard/users/{name}": ["200", "201"],
+  "GET /azure/core/lro/standard/users/{name}": ["200", "202"],
+  "DELETE /azure/core/lro/standard/users/{name}": ["202"],
+  "POST /azure/core/lro/standard/users/{name}:export": ["202"],
+  "GET /azure/core/lro/standard/users/{name}:export": ["200", "202"],
+};
+
+export function isUnexpected(
+  response:
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceLogicalResponse
+    | CreateOrReplaceDefaultResponse
+): response is CreateOrReplaceDefaultResponse;
+export function isUnexpected(
+  response: Delete202Response | DeleteLogicalResponse | DeleteDefaultResponse
+): response is DeleteDefaultResponse;
+export function isUnexpected(
+  response: Export202Response | ExportLogicalResponse | ExportDefaultResponse
+): response is ExportDefaultResponse;
+export function isUnexpected(
+  response:
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceLogicalResponse
+    | CreateOrReplaceDefaultResponse
+    | Delete202Response
+    | DeleteLogicalResponse
+    | DeleteDefaultResponse
+    | Export202Response
+    | ExportLogicalResponse
+    | ExportDefaultResponse
+): response is
+  | CreateOrReplaceDefaultResponse
+  | DeleteDefaultResponse
+  | ExportDefaultResponse {
+  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/lroCore/src/models.ts

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Details about a user. */
+export interface User {
+  /** The role of user */
+  role: string;
+}

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

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { ErrorModel } from "@azure-rest/core-client";
+
+/** Details about a user. */
+export interface UserOutput {
+  /** The name of user. */
+  readonly name: string;
+  /** The role of user */
+  role: string;
+}
+
+/** Provides status details for long running operations. */
+export interface OperationStatusOutput {
+  /** The unique ID of the operation. */
+  id: string;
+  /**
+   * The status of the operation
+   *
+   * Possible values: InProgress, Succeeded, Failed, Canceled
+   */
+  status: string;
+  /** Error object that describes the error when status is "Failed". */
+  error?: ErrorModel;
+}
+
+/** Provides status details for long running operations. */
+export interface ResourceOperationStatusOutput {
+  /** The unique ID of the operation. */
+  id: string;
+  /**
+   * The status of the operation
+   *
+   * Possible values: InProgress, Succeeded, Failed, Canceled
+   */
+  status: string;
+  /** Error object that describes the error when status is "Failed". */
+  error?: ErrorModel;
+  /** The result of the operation. */
+  result?: ExportedUserOutput;
+}
+
+/** The exported user data. */
+export interface ExportedUserOutput {
+  /** The name of user. */
+  name: string;
+  /** The exported URI. */
+  resourceUri: string;
+}

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

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+import { User } from "./models";
+
+export interface CreateOrReplaceBodyParam {
+  /** The resource instance. */
+  body: User;
+}
+
+export type CreateOrReplaceParameters = CreateOrReplaceBodyParam &
+  RequestParameters;
+export type DeleteParameters = RequestParameters;
+
+export interface ExportQueryParamProperties {
+  /** The format of the data. */
+  format: string;
+}
+
+export interface ExportQueryParam {
+  queryParameters: ExportQueryParamProperties;
+}
+
+export type ExportParameters = ExportQueryParam & RequestParameters;

package/test/integration/generated/lro/{lroBasic → lroCore}/src/pollingHelper.ts

@@ -10,6 +10,18 @@ import {
   SimplePollerLike,
   createHttpPoller,
 } from "@azure/core-lro";
+import {
+  CreateOrReplace200Response,
+  CreateOrReplace201Response,
+  CreateOrReplaceDefaultResponse,
+  CreateOrReplaceLogicalResponse,
+  Delete202Response,
+  DeleteDefaultResponse,
+  DeleteLogicalResponse,
+  Export202Response,
+  ExportDefaultResponse,
+  ExportLogicalResponse,
+} from "./responses";
 /**
  * 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.
@@ -17,6 +29,32 @@ import {
  * @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 async function getLongRunningPoller<
+  TResult extends ExportLogicalResponse | ExportDefaultResponse
+>(
+  client: Client,
+  initialResponse: Export202Response | ExportDefaultResponse,
+  options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>
+): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
+export async function getLongRunningPoller<
+  TResult extends
+    | CreateOrReplaceLogicalResponse
+    | CreateOrReplaceDefaultResponse
+>(
+  client: Client,
+  initialResponse:
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceDefaultResponse,
+  options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>
+): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
+export async function getLongRunningPoller<
+  TResult extends DeleteLogicalResponse | DeleteDefaultResponse
+>(
+  client: Client,
+  initialResponse: Delete202Response | DeleteDefaultResponse,
+  options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>
+): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
 export async function getLongRunningPoller<TResult extends HttpResponse>(
   client: Client,
   initialResponse: TResult,

package/test/integration/generated/lro/lroCore/src/responses.ts

@@ -0,0 +1,109 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RawHttpHeaders } from "@azure/core-rest-pipeline";
+import { HttpResponse, ErrorResponse } from "@azure-rest/core-client";
+import {
+  UserOutput,
+  OperationStatusOutput,
+  ResourceOperationStatusOutput,
+} from "./outputModels";
+
+export interface CreateOrReplace200Headers {
+  /** The location for monitoring the operation state. */
+  "operation-location": string;
+}
+
+/** The request has succeeded. */
+export interface CreateOrReplace200Response extends HttpResponse {
+  status: "200";
+  body: UserOutput;
+  headers: RawHttpHeaders & CreateOrReplace200Headers;
+}
+
+export interface CreateOrReplace201Headers {
+  /** The location for monitoring the operation state. */
+  "operation-location": string;
+}
+
+/** The request has succeeded and a new resource has been created as a result. */
+export interface CreateOrReplace201Response extends HttpResponse {
+  status: "201";
+  body: UserOutput;
+  headers: RawHttpHeaders & CreateOrReplace201Headers;
+}
+
+export interface CreateOrReplaceDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface CreateOrReplaceDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & CreateOrReplaceDefaultHeaders;
+}
+
+/** The final response for long-running createOrReplace operation */
+export interface CreateOrReplaceLogicalResponse extends HttpResponse {
+  status: "200";
+  body: UserOutput;
+}
+
+export interface Delete202Headers {
+  /** The location for monitoring the operation state. */
+  "operation-location": string;
+}
+
+/** The request has been accepted for processing, but processing has not yet completed. */
+export interface Delete202Response extends HttpResponse {
+  status: "202";
+  body: OperationStatusOutput;
+  headers: RawHttpHeaders & Delete202Headers;
+}
+
+export interface DeleteDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface DeleteDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & DeleteDefaultHeaders;
+}
+
+/** The final response for long-running delete operation */
+export interface DeleteLogicalResponse extends HttpResponse {
+  status: "200";
+  body: OperationStatusOutput;
+}
+
+export interface Export202Headers {
+  /** The location for monitoring the operation state. */
+  "operation-location": string;
+}
+
+/** The request has been accepted for processing, but processing has not yet completed. */
+export interface Export202Response extends HttpResponse {
+  status: "202";
+  body: ResourceOperationStatusOutput;
+  headers: RawHttpHeaders & Export202Headers;
+}
+
+export interface ExportDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface ExportDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & ExportDefaultHeaders;
+}
+
+/** The final response for long-running export operation */
+export interface ExportLogicalResponse extends HttpResponse {
+  status: "200";
+  body: ResourceOperationStatusOutput;
+}

package/test/integration/generated/lro/lroCore/src/specsAzureCoreLroStandard.ts

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { getClient, ClientOptions } from "@azure-rest/core-client";
+import { SpecsAzureCoreLroStandardClient } from "./clientDefinitions";
+
+/**
+ * Initialize a new instance of `SpecsAzureCoreLroStandardClient`
+ * @param options type: ClientOptions, the parameter for all optional parameters
+ */
+export default function createClient(
+  options: ClientOptions = {}
+): SpecsAzureCoreLroStandardClient {
+  const baseUrl = options.baseUrl ?? `http://localhost:3000`;
+  options.apiVersion = options.apiVersion ?? "2022-12-01-preview";
+  const userAgentInfo = `azsdk-js-lro-core-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 SpecsAzureCoreLroStandardClient;
+
+  return client;
+}

package/test/integration/generated/lro/lroCore/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "module": "es6",
+    "lib": [],
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "strict": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "outDir": "./dist-esm",
+    "declarationDir": "./types"
+  },
+  "include": ["./src/**/*.ts"]
+}

package/test/integration/generated/lro/lroCore/tspconfig.yaml

@@ -0,0 +1,14 @@
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
+    generateMetadata: true
+    generateTest: false
+    addCredentials: false
+    azureSdkForJs: false
+    isCadlTest: true
+    packageDetails:
+      name: "@msinternal/lro-core"
+      description: "LRO Core Test Service"
+      version: "1.0.0"