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

package/test/integration/generated/arrays/itemTypes/src/responses.ts

@@ -102,3 +102,14 @@ export interface ModelValueGet200Response extends HttpResponse {
 export interface ModelValuePut204Response extends HttpResponse {
   status: "204";
 }
+
+/** The request has succeeded. */
+export interface NullableFloatValueGet200Response extends HttpResponse {
+  status: "200";
+  body: (number | null)[];
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface NullableFloatValuePut204Response extends HttpResponse {
+  status: "204";
+}

package/test/integration/generated/arrays/itemTypes/tspconfig.yaml

@@ -1,5 +1,8 @@
-emitters:
-  "../../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     generateMetadata: false
     generateTest: false
     addCredentials: false

package/test/integration/generated/authentication/apiKey/package.json

@@ -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"
@@ -67,7 +67,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/authentication/apiKey/tspconfig.yaml

@@ -1,5 +1,8 @@
-emitters:
-  "../../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     azureSdkForJs: false
     addCredentials: false
     isCadlTest: true

package/test/integration/generated/authentication/oauth2/tspconfig.yaml

@@ -1,5 +1,8 @@
-emitters:
-  "../../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     generateMetadata: false
     generateTest: true
     addCredentials: false

package/test/integration/generated/authentication/union/tspconfig.yaml

@@ -1,5 +1,8 @@
-emitters:
-  "../../../../../../../../../../../packages/typespec-ts/dist/src/index.js":
+emit:
+  - "@azure-tools/typespec-ts"
+options:
+  "@azure-tools/typespec-ts":
+    "emitter-output-dir": "{project-root}"
     generateMetadata: false
     generateTest: true
     addCredentials: false

package/test/integration/generated/{resiliency/devDriven → azure/core}/README.md

@@ -1,12 +1,12 @@
-# ResiliencyDevDriven REST client library for JavaScript
+# AzureCore REST client library for JavaScript
 
-DPG Swagger that tests our ability to grow up.
+Illustrates bodies templated with Azure Core
 
 **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/dev-driven)
+- [Package (NPM)](https://www.npmjs.com/package/@msinternal/azurecore)
 
 ## 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/dev-driven` package
+### Install the `@msinternal/azurecore` package
 
-Install the ResiliencyDevDriven REST client REST client library for JavaScript with `npm`:
+Install the AzureCore REST client REST client library for JavaScript with `npm`:
 
 ```bash
-npm install @msinternal/dev-driven
+npm install @msinternal/azurecore
 ```
 
-### Create and authenticate a `ResiliencyDevDrivenClient`
+### Create and authenticate a `AzureCoreClient`
 
 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/lroBasic → azure/core}/api-extractor.json

@@ -6,7 +6,7 @@
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "",
-    "publicTrimmedFilePath": "./types/lro-basic.d.ts"
+    "publicTrimmedFilePath": "./types/azurecore.d.ts"
   },
   "messages": {
     "tsdocMessageReporting": { "default": { "logLevel": "none" } },

package/test/integration/generated/{resiliency/devDriven → azure/core}/package.json

@@ -1,20 +1,20 @@
 {
-  "name": "@msinternal/dev-driven",
+  "name": "@msinternal/azurecore",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
   "version": "1.0.0",
-  "description": "Dev Driven Test Service",
+  "description": "AzureCore 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",
+  "types": "./types/azurecore.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",
+    "types/azurecore.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",
@@ -68,7 +68,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/azure/core/src/azureCoreClient.ts

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

package/test/integration/generated/azure/core/src/clientDefinitions.ts

@@ -0,0 +1,108 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  CreateOrUpdateParameters,
+  CreateOrReplaceParameters,
+  GetParameters,
+  DeleteParameters,
+  ListParameters,
+  ListWithPageParameters,
+  ListWithCustomPageModelParameters,
+  ExportParameters,
+} from "./parameters";
+import {
+  CreateOrUpdate200Response,
+  CreateOrUpdate201Response,
+  CreateOrUpdateDefaultResponse,
+  CreateOrReplace200Response,
+  CreateOrReplace201Response,
+  CreateOrReplaceDefaultResponse,
+  Get200Response,
+  GetDefaultResponse,
+  Delete204Response,
+  DeleteDefaultResponse,
+  List200Response,
+  ListDefaultResponse,
+  ListWithPage200Response,
+  ListWithPageDefaultResponse,
+  ListWithCustomPageModel200Response,
+  ListWithCustomPageModelDefaultResponse,
+  Export200Response,
+  ExportDefaultResponse,
+} from "./responses";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+
+export interface CreateOrUpdate {
+  /** Creates or updates a User */
+  patch(
+    options: CreateOrUpdateParameters
+  ): StreamableMethod<
+    | CreateOrUpdate200Response
+    | CreateOrUpdate201Response
+    | CreateOrUpdateDefaultResponse
+  >;
+  /** Creates or replaces a User */
+  put(
+    options: CreateOrReplaceParameters
+  ): StreamableMethod<
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceDefaultResponse
+  >;
+  /** Gets a User */
+  get(
+    options?: GetParameters
+  ): StreamableMethod<Get200Response | GetDefaultResponse>;
+  /** Deletes a User */
+  delete(
+    options?: DeleteParameters
+  ): StreamableMethod<Delete204Response | DeleteDefaultResponse>;
+}
+
+export interface List {
+  /** Lists all Users */
+  get(
+    options?: ListParameters
+  ): StreamableMethod<List200Response | ListDefaultResponse>;
+}
+
+export interface ListWithPage {
+  /** List with Azure.Core.Page<>. */
+  get(
+    options?: ListWithPageParameters
+  ): StreamableMethod<ListWithPage200Response | ListWithPageDefaultResponse>;
+}
+
+export interface ListWithCustomPageModel {
+  /** List with custom page model. */
+  get(
+    options?: ListWithCustomPageModelParameters
+  ): StreamableMethod<
+    ListWithCustomPageModel200Response | ListWithCustomPageModelDefaultResponse
+  >;
+}
+
+export interface Export {
+  /** Exports a User */
+  post(
+    options: ExportParameters
+  ): StreamableMethod<Export200Response | ExportDefaultResponse>;
+}
+
+export interface Routes {
+  /** Resource for '/azure/core/basic/users/\{id\}' has methods for the following verbs: patch, put, get, delete */
+  (path: "/azure/core/basic/users/{id}", id: number): CreateOrUpdate;
+  /** Resource for '/azure/core/basic/users' has methods for the following verbs: get */
+  (path: "/azure/core/basic/users"): List;
+  /** Resource for '/azure/core/basic/page' has methods for the following verbs: get */
+  (path: "/azure/core/basic/page"): ListWithPage;
+  /** Resource for '/azure/core/basic/custom-page' has methods for the following verbs: get */
+  (path: "/azure/core/basic/custom-page"): ListWithCustomPageModel;
+  /** Resource for '/azure/core/basic/users/\{id\}:export' has methods for the following verbs: post */
+  (path: "/azure/core/basic/users/{id}:export", id: number): Export;
+}
+
+export type AzureCoreClient = Client & {
+  path: Routes;
+};

package/test/integration/generated/{resiliency/devDriven → azure/core}/src/index.ts

@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import ResiliencyDevDriven from "./resiliencyDevDriven";
+import AzureCoreClient from "./azureCoreClient";
 
-export * from "./resiliencyDevDriven";
+export * from "./azureCoreClient";
 export * from "./parameters";
 export * from "./responses";
 export * from "./clientDefinitions";
@@ -11,5 +11,6 @@ export * from "./isUnexpected";
 export * from "./models";
 export * from "./outputModels";
 export * from "./paginateHelper";
+export * from "./serializeHelper";
 
-export default ResiliencyDevDriven;
+export default AzureCoreClient;

package/test/integration/generated/azure/core/src/isUnexpected.ts

@@ -0,0 +1,178 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  CreateOrUpdate200Response,
+  CreateOrUpdate201Response,
+  CreateOrUpdateDefaultResponse,
+  CreateOrReplace200Response,
+  CreateOrReplace201Response,
+  CreateOrReplaceDefaultResponse,
+  Get200Response,
+  GetDefaultResponse,
+  Delete204Response,
+  DeleteDefaultResponse,
+  List200Response,
+  ListDefaultResponse,
+  ListWithPage200Response,
+  ListWithPageDefaultResponse,
+  ListWithCustomPageModel200Response,
+  ListWithCustomPageModelDefaultResponse,
+  Export200Response,
+  ExportDefaultResponse,
+} from "./responses";
+
+const responseMap: Record<string, string[]> = {
+  "PATCH /azure/core/basic/users/{id}": ["200", "201"],
+  "PUT /azure/core/basic/users/{id}": ["200", "201"],
+  "GET /azure/core/basic/users/{id}": ["200"],
+  "DELETE /azure/core/basic/users/{id}": ["204"],
+  "GET /azure/core/basic/users": ["200"],
+  "GET /azure/core/basic/page": ["200"],
+  "GET /azure/core/basic/custom-page": ["200"],
+  "POST /azure/core/basic/users/{id}:export": ["200"],
+};
+
+export function isUnexpected(
+  response:
+    | CreateOrUpdate200Response
+    | CreateOrUpdate201Response
+    | CreateOrUpdateDefaultResponse
+): response is CreateOrUpdateDefaultResponse;
+export function isUnexpected(
+  response:
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceDefaultResponse
+): response is CreateOrReplaceDefaultResponse;
+export function isUnexpected(
+  response: Get200Response | GetDefaultResponse
+): response is GetDefaultResponse;
+export function isUnexpected(
+  response: Delete204Response | DeleteDefaultResponse
+): response is DeleteDefaultResponse;
+export function isUnexpected(
+  response: List200Response | ListDefaultResponse
+): response is ListDefaultResponse;
+export function isUnexpected(
+  response: ListWithPage200Response | ListWithPageDefaultResponse
+): response is ListWithPageDefaultResponse;
+export function isUnexpected(
+  response:
+    | ListWithCustomPageModel200Response
+    | ListWithCustomPageModelDefaultResponse
+): response is ListWithCustomPageModelDefaultResponse;
+export function isUnexpected(
+  response: Export200Response | ExportDefaultResponse
+): response is ExportDefaultResponse;
+export function isUnexpected(
+  response:
+    | CreateOrUpdate200Response
+    | CreateOrUpdate201Response
+    | CreateOrUpdateDefaultResponse
+    | CreateOrReplace200Response
+    | CreateOrReplace201Response
+    | CreateOrReplaceDefaultResponse
+    | Get200Response
+    | GetDefaultResponse
+    | Delete204Response
+    | DeleteDefaultResponse
+    | List200Response
+    | ListDefaultResponse
+    | ListWithPage200Response
+    | ListWithPageDefaultResponse
+    | ListWithCustomPageModel200Response
+    | ListWithCustomPageModelDefaultResponse
+    | Export200Response
+    | ExportDefaultResponse
+): response is
+  | CreateOrUpdateDefaultResponse
+  | CreateOrReplaceDefaultResponse
+  | GetDefaultResponse
+  | DeleteDefaultResponse
+  | ListDefaultResponse
+  | ListWithPageDefaultResponse
+  | ListWithCustomPageModelDefaultResponse
+  | 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/azure/core/src/models.ts

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/** Details about a user. */
+export interface User {
+  /** The user's name. */
+  name: string;
+  /** The user's order list */
+  orders?: Array<UserOrder>;
+}
+
+/** UserOrder for testing list with expand. */
+export interface UserOrder {
+  /** The user's id. */
+  userId: number;
+  /** The user's order detail */
+  detail: string;
+}

package/test/integration/generated/azure/core/src/outputModels.ts

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { Paged } from "@azure/core-paging";
+
+/** Details about a user. */
+export interface UserOutput {
+  /** The user's id. */
+  readonly id: number;
+  /** The user's name. */
+  name: string;
+  /** The user's order list */
+  orders?: Array<UserOrderOutput>;
+  /** The entity tag for this resource. */
+  readonly etag: string;
+}
+
+/** UserOrder for testing list with expand. */
+export interface UserOrderOutput {
+  /** The user's id. */
+  readonly id: number;
+  /** The user's id. */
+  userId: number;
+  /** The user's order detail */
+  detail: string;
+}
+
+/** Paged collection of User items */
+export type UserListOutput = Paged<UserOutput>;
+/** Paged collection of User items */
+export type PagedUserOutput = Paged<UserOutput>;
+export type UserListResultsOutput = Paged<UserOutput>;

package/test/integration/generated/{resiliency/devDriven → azure/core}/src/paginateHelper.ts

@@ -45,9 +45,13 @@ export interface PagingOptions<TResponse> {
  * 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 };
-}
+export type PaginateReturn<TResult> = TResult extends
+  | {
+      body: { value?: infer TPage };
+    }
+  | {
+      body: { items?: infer TPage };
+    }
   ? GetArrayType<TPage>
   : Array<unknown>;
 
@@ -66,8 +70,10 @@ export function paginate<TResponse extends PathUncheckedResponse>(
   // Extract element type from initial response
   type TElement = PaginateReturn<TResponse>;
   let firstRun = true;
-  const itemName = "value";
-  const nextLinkName = "nextLink";
+  // We need to check the response for success before trying to inspect it looking for
+  // the properties to use for nextLink and itemName
+  checkPagingRequest(initialResponse);
+  const { itemName, nextLinkName } = getPaginationProperties(initialResponse);
   const { customGetPage } = options;
   const pagedResult: PagedResult<TElement[]> = {
     firstPageLink: "",
@@ -152,3 +158,47 @@ function checkPagingRequest(response: PathUncheckedResponse): void {
     );
   }
 }
+
+/**
+ * Extracts the itemName and nextLinkName from the initial response to use them for pagination
+ */
+function getPaginationProperties(initialResponse: PathUncheckedResponse) {
+  // Build a set with the passed custom nextLinkNames
+  const nextLinkNames = new Set(["nextLink"]);
+
+  // Build a set with the passed custom set of itemNames
+  const itemNames = new Set(["value", "items"]);
+
+  let nextLinkName: string | undefined;
+  let itemName: string | undefined;
+
+  for (const name of nextLinkNames) {
+    const nextLink = (initialResponse.body as Record<string, unknown>)[
+      name
+    ] as string;
+    if (nextLink) {
+      nextLinkName = name;
+      break;
+    }
+  }
+
+  for (const name of itemNames) {
+    const item = (initialResponse.body as Record<string, unknown>)[
+      name
+    ] as string;
+    if (item) {
+      itemName = name;
+      break;
+    }
+  }
+
+  if (!itemName) {
+    throw new Error(
+      `Couldn't paginate response\n Body doesn't contain an array property with name: ${[
+        ...itemNames,
+      ].join(" OR ")}`
+    );
+  }
+
+  return { itemName, nextLinkName };
+}