@azure-tools/typespec-ts 0.11.0 → 0.12.0

package/test/integration/generated/azure/core/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/azure/core/src/parameters.ts

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { RequestParameters } from "@azure-rest/core-client";
+import { User } from "./models";
+
+/** The resource instance. */
+export type UserResourceMergeAndPatch = Partial<User>;
+
+export interface CreateOrUpdateBodyParam {
+  /** The resource instance. */
+  body: UserResourceMergeAndPatch;
+}
+
+export interface CreateOrUpdateMediaTypesParam {
+  /** This request has a JSON Merge Patch body. */
+  contentType: "application/merge-patch+json";
+}
+
+export type CreateOrUpdateParameters = CreateOrUpdateMediaTypesParam &
+  CreateOrUpdateBodyParam &
+  RequestParameters;
+
+export interface CreateOrReplaceBodyParam {
+  /** The resource instance. */
+  body: User;
+}
+
+export type CreateOrReplaceParameters = CreateOrReplaceBodyParam &
+  RequestParameters;
+export type GetParameters = RequestParameters;
+
+export interface ListQueryParamProperties {
+  /** The number of result items to return. */
+  top?: number;
+  /** The number of result items to skip. */
+  skip?: number;
+  /** The maximum number of result items per page. */
+  maxpagesize?: number;
+  /** Expressions that specify the order of returned results. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */
+  orderby?: string;
+  /** Filter the result list using the given expression. */
+  filter?: string;
+  /** Select the specified fields to be included in the response. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */
+  select?: string;
+  /** Expand the indicated resources into the response. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */
+  expand?: string;
+}
+
+export interface ListQueryParam {
+  queryParameters?: ListQueryParamProperties;
+}
+
+export type ListParameters = ListQueryParam & RequestParameters;
+export type ListWithPageParameters = 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/azure/core/src/responses.ts

@@ -0,0 +1,136 @@
+// 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, UserListOutput, PagedUserOutput } from "./outputModels";
+
+/** The request has succeeded. */
+export interface CreateOrUpdate200Response extends HttpResponse {
+  status: "200";
+  body: UserOutput;
+}
+
+/** The request has succeeded and a new resource has been created as a result. */
+export interface CreateOrUpdate201Response extends HttpResponse {
+  status: "201";
+  body: UserOutput;
+}
+
+export interface CreateOrUpdateDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface CreateOrUpdateDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & CreateOrUpdateDefaultHeaders;
+}
+
+/** The request has succeeded. */
+export interface CreateOrReplace200Response extends HttpResponse {
+  status: "200";
+  body: UserOutput;
+}
+
+/** The request has succeeded and a new resource has been created as a result. */
+export interface CreateOrReplace201Response extends HttpResponse {
+  status: "201";
+  body: UserOutput;
+}
+
+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 request has succeeded. */
+export interface Get200Response extends HttpResponse {
+  status: "200";
+  body: UserOutput;
+}
+
+export interface GetDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface GetDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & GetDefaultHeaders;
+}
+
+/** The request has succeeded. */
+export interface List200Response extends HttpResponse {
+  status: "200";
+  body: UserListOutput;
+}
+
+export interface ListDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface ListDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & ListDefaultHeaders;
+}
+
+/** The request has succeeded. */
+export interface ListWithPage200Response extends HttpResponse {
+  status: "200";
+  body: PagedUserOutput;
+}
+
+export interface ListWithPageDefaultHeaders {
+  /** String error code indicating what went wrong. */
+  "x-ms-error-code"?: string;
+}
+
+export interface ListWithPageDefaultResponse extends HttpResponse {
+  status: string;
+  body: ErrorResponse;
+  headers: RawHttpHeaders & ListWithPageDefaultHeaders;
+}
+
+/** There is no content to send for this request, but the headers may be useful. */
+export interface Delete204Response extends HttpResponse {
+  status: "204";
+}
+
+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 request has succeeded. */
+export interface Export200Response extends HttpResponse {
+  status: "200";
+  body: UserOutput;
+}
+
+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;
+}

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

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export function buildMultiCollection(
+  queryParameters: string[],
+  parameterName: string
+) {
+  return queryParameters
+    .map((item, index) => {
+      if (index === 0) {
+        return item;
+      }
+      return `${parameterName}=${item}`;
+    })
+    .join("&");
+}

package/test/integration/generated/azure/core/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/azure/core/tspconfig.yaml

@@ -0,0 +1,15 @@
+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
+    title: AzureCoreClient
+    packageDetails:
+      name: "@msinternal/azurecore"
+      description: "AzureCore Test Service"
+      version: "1.0.0"

package/test/integration/generated/azure/core-traits/.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/azure/core-traits/README.md

@@ -0,0 +1,56 @@
+# AzureCoreTraits REST client library for JavaScript
+
+Illustrates Azure Core operation customizations by traits
+
+**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/azurecoretraits)
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
+
+### Install the `@msinternal/azurecoretraits` package
+
+Install the AzureCoreTraits REST client REST client library for JavaScript with `npm`:
+
+```bash
+npm install @msinternal/azurecoretraits
+```
+
+### Create and authenticate a `AzureCoreTraitsClient`
+
+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
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) 
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```javascript
+const { setLogLevel } = require("@azure/logger");
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

package/test/integration/generated/azure/core-traits/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/azurecoretraits.d.ts"
+  },
+  "messages": {
+    "tsdocMessageReporting": { "default": { "logLevel": "none" } },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": { "logLevel": "none" },
+      "ae-unresolved-link": { "logLevel": "none" }
+    }
+  }
+}

package/test/integration/generated/azure/core-traits/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@msinternal/azurecoretraits",
+  "sdk-type": "client",
+  "author": "Microsoft Corporation",
+  "version": "1.0.0",
+  "description": "AzureCoreTraits Test Service",
+  "keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "./dist-esm/index.js",
+  "types": "./types/azurecoretraits.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/azurecoretraits.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"
+  },
+  "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"
+}