@typespec/ts-http-runtime 0.1.0 → 0.2.0-alpha.20250326.3

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2020 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

package/README.md

@@ -31,7 +31,7 @@ A `PipelineResponse` describes the HTTP response (body, headers, and status code
 
 A `SendRequest` method is a method that given a `PipelineRequest` can asynchronously return a `PipelineResponse`.
 
-```ts snippet:send_request
+```ts snippet:ReadmeSampleSendRequest
 import { PipelineRequest, PipelineResponse } from "@typespec/ts-http-runtime";
 
 type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
@@ -41,7 +41,7 @@ type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
 
 An `HttpClient` is any object that satisfies the following interface to implement a `SendRequest` method:
 
-```ts snippet:http_request
+```ts snippet:ReadmeSampleHttpRequest
 import { SendRequest } from "@typespec/ts-http-runtime";
 
 interface HttpClient {
@@ -58,7 +58,7 @@ interface HttpClient {
 
 A `PipelinePolicy` is a simple object that implements the following interface:
 
-```ts snippet:pipeline_policy
+```ts snippet:ReadmeSamplePipelinePolicy
 import { PipelineRequest, SendRequest, PipelineResponse } from "@typespec/ts-http-runtime";
 
 interface PipelinePolicy {
@@ -81,7 +81,7 @@ One can view the role of policies as that of `middleware`, a concept that is fam
 
 The `sendRequest` implementation can both transform the outgoing request as well as the incoming response:
 
-```ts snippet:custom_policy
+```ts snippet:ReadmeSampleCustomPolicy
 import { PipelineRequest, SendRequest, PipelineResponse } from "@typespec/ts-http-runtime";
 
 const customPolicy = {
@@ -93,6 +93,7 @@ const customPolicy = {
     if (result.status === 403) {
       // Do something special if this policy sees Forbidden
     }
+
     return result;
   },
 };
@@ -108,10 +109,10 @@ You can think of policies being applied like a stack (first-in/last-out.) The fi
 
 A `Pipeline` satisfies the following interface:
 
-```ts snippet:pipeline
+```ts snippet:ReadmeSamplePipeline
 import {
   PipelinePolicy,
-  AddPipelineOptions,
+  AddPolicyOptions,
   PipelinePhase,
   HttpClient,
   PipelineRequest,
@@ -119,7 +120,7 @@ import {
 } from "@typespec/ts-http-runtime";
 
 interface Pipeline {
-  addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions): void;
+  addPolicy(policy: PipelinePolicy, options?: AddPolicyOptions): void;
   removePolicy(options: { name?: string; phase?: PipelinePhase }): PipelinePolicy[];
   sendRequest(httpClient: HttpClient, request: PipelineRequest): Promise<PipelineResponse>;
   getOrderedPolicies(): PipelinePolicy[];
@@ -140,7 +141,7 @@ Phases occur in the above order, with serialization policies being applied first
 
 When adding a policy to the pipeline you can specify not only what phase a policy is in, but also if it has any dependencies:
 
-```ts snippet:add_policy_options
+```ts snippet:ReadmeSampleAddPipelineOptions
 import { PipelinePhase } from "@typespec/ts-http-runtime";
 
 interface AddPipelineOptions {
@@ -174,5 +175,3 @@ If you run into issues while using this library, please feel free to [file an is
 ## Contributing
 
 If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
-
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcore%2Fts-http-runtime%2FREADME.png)

package/dist/browser/abort-controller/AbortError.d.ts

@@ -4,17 +4,20 @@
  * error matches `"AbortError"`.
  *
  * @example
- * ```ts snippet:abort_error
+ * ```ts snippet:ReadmeSampleAbortError
  * import { AbortError } from "@typespec/ts-http-runtime";
  *
  * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  *   if (options.abortSignal.aborted) {
  *     throw new AbortError();
  *   }
+ *
  *   // do async work
  * }
+ *
  * const controller = new AbortController();
  * controller.abort();
+ *
  * try {
  *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {

package/dist/browser/abort-controller/AbortError.js

@@ -6,17 +6,20 @@
  * error matches `"AbortError"`.
  *
  * @example
- * ```ts snippet:abort_error
+ * ```ts snippet:ReadmeSampleAbortError
  * import { AbortError } from "@typespec/ts-http-runtime";
  *
  * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  *   if (options.abortSignal.aborted) {
  *     throw new AbortError();
  *   }
+ *
  *   // do async work
  * }
+ *
  * const controller = new AbortController();
  * controller.abort();
+ *
  * try {
  *   doAsyncWork({ abortSignal: controller.signal });
  * } catch (e) {

package/dist/browser/abort-controller/AbortError.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbortError.js","sourceRoot":"","sources":["../../../src/abort-controller/AbortError.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAgB;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * This error is thrown when an asynchronous operation has been aborted.\n * Check for this error by testing the `name` that the name property of the\n * error matches `\"AbortError\"`.\n *\n * @example\n * ```ts snippet:abort_error\n * import { AbortError } from \"@typespec/ts-http-runtime\";\n *\n * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {\n *   if (options.abortSignal.aborted) {\n *     throw new AbortError();\n *   }\n *   // do async work\n * }\n * const controller = new AbortController();\n * controller.abort();\n * try {\n *   doAsyncWork({ abortSignal: controller.signal });\n * } catch (e) {\n *   if (e instanceof Error && e.name === \"AbortError\") {\n *     // handle abort error here.\n *   }\n * }\n * ```\n */\nexport class AbortError extends Error {\n  constructor(message?: string) {\n    super(message);\n    this.name = \"AbortError\";\n  }\n}\n"]}
+{"version":3,"file":"AbortError.js","sourceRoot":"","sources":["../../../src/abort-controller/AbortError.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAgB;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * This error is thrown when an asynchronous operation has been aborted.\n * Check for this error by testing the `name` that the name property of the\n * error matches `\"AbortError\"`.\n *\n * @example\n * ```ts snippet:ReadmeSampleAbortError\n * import { AbortError } from \"@typespec/ts-http-runtime\";\n *\n * async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {\n *   if (options.abortSignal.aborted) {\n *     throw new AbortError();\n *   }\n *\n *   // do async work\n * }\n *\n * const controller = new AbortController();\n * controller.abort();\n *\n * try {\n *   doAsyncWork({ abortSignal: controller.signal });\n * } catch (e) {\n *   if (e instanceof Error && e.name === \"AbortError\") {\n *     // handle abort error here.\n *   }\n * }\n * ```\n */\nexport class AbortError extends Error {\n  constructor(message?: string) {\n    super(message);\n    this.name = \"AbortError\";\n  }\n}\n"]}

package/dist/browser/auth/credentials.d.ts

@@ -0,0 +1,77 @@
+import type { OAuth2Flow } from "./oauth2Flows.js";
+/**
+ * Options used when creating and sending get OAuth 2 requests for this operation.
+ */
+export interface GetOAuth2TokenOptions {
+    /** Abort signal for the request */
+    abortSignal?: AbortSignal;
+}
+/**
+ * Options used when creating and sending get bearer token requests for this operation.
+ */
+export interface GetBearerTokenOptions {
+    /** Abort signal for the request */
+    abortSignal?: AbortSignal;
+}
+/**
+ * Credential for OAuth2 authentication flows.
+ */
+export interface OAuth2TokenCredential<TFlows extends OAuth2Flow> {
+    /**
+     * Gets an OAuth2 token for the specified flows.
+     * @param flows - The OAuth2 flows to use.
+     * @param options - Options for the request.
+     * @returns - a valid access token which was obtained through one of the flows specified in `flows`.
+     */
+    getOAuth2Token(flows: TFlows[], options?: GetOAuth2TokenOptions): Promise<string>;
+}
+/**
+ * Credential for Bearer token authentication.
+ */
+export interface BearerTokenCredential {
+    /**
+     * Gets a Bearer token for the specified flows.
+     * @param options - Options for the request.
+     * @returns - a valid access token.
+     */
+    getBearerToken(options?: GetBearerTokenOptions): Promise<string>;
+}
+/**
+ * Credential for HTTP Basic authentication.
+ * Provides username and password for basic authentication headers.
+ */
+export interface BasicCredential {
+    /** The username for basic authentication. */
+    username: string;
+    /** The password for basic authentication. */
+    password: string;
+}
+/**
+ * Credential for API Key authentication.
+ * Provides an API key that will be used in the request headers.
+ */
+export interface ApiKeyCredential {
+    /** The API key for authentication. */
+    key: string;
+}
+/**
+ * Union type of all supported authentication credentials.
+ */
+export type ClientCredential = OAuth2TokenCredential<OAuth2Flow> | BearerTokenCredential | BasicCredential | ApiKeyCredential;
+/**
+ * Type guard to check if a credential is an OAuth2 token credential.
+ */
+export declare function isOAuth2TokenCredential(credential: ClientCredential): credential is OAuth2TokenCredential<OAuth2Flow>;
+/**
+ * Type guard to check if a credential is a Bearer token credential.
+ */
+export declare function isBearerTokenCredential(credential: ClientCredential): credential is BearerTokenCredential;
+/**
+ * Type guard to check if a credential is a Basic auth credential.
+ */
+export declare function isBasicCredential(credential: ClientCredential): credential is BasicCredential;
+/**
+ * Type guard to check if a credential is an API key credential.
+ */
+export declare function isApiKeyCredential(credential: ClientCredential): credential is ApiKeyCredential;
+//# sourceMappingURL=credentials.d.ts.map

package/dist/browser/auth/credentials.js

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Type guard to check if a credential is an OAuth2 token credential.
+ */
+export function isOAuth2TokenCredential(credential) {
+    return "getOAuth2Token" in credential;
+}
+/**
+ * Type guard to check if a credential is a Bearer token credential.
+ */
+export function isBearerTokenCredential(credential) {
+    return "getBearerToken" in credential;
+}
+/**
+ * Type guard to check if a credential is a Basic auth credential.
+ */
+export function isBasicCredential(credential) {
+    return "username" in credential && "password" in credential;
+}
+/**
+ * Type guard to check if a credential is an API key credential.
+ */
+export function isApiKeyCredential(credential) {
+    return "key" in credential;
+}
+//# sourceMappingURL=credentials.js.map

package/dist/browser/auth/credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../../src/auth/credentials.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA0ElC;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAA4B;IAE5B,OAAO,gBAAgB,IAAI,UAAU,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAA4B;IAE5B,OAAO,gBAAgB,IAAI,UAAU,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAA4B;IAC5D,OAAO,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,UAAU,CAAC;AAC9D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,UAA4B;IAC7D,OAAO,KAAK,IAAI,UAAU,CAAC;AAC7B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OAuth2Flow } from \"./oauth2Flows.js\";\n\n/**\n * Options used when creating and sending get OAuth 2 requests for this operation.\n */\nexport interface GetOAuth2TokenOptions {\n  /** Abort signal for the request */\n  abortSignal?: AbortSignal;\n}\n\n/**\n * Options used when creating and sending get bearer token requests for this operation.\n */\nexport interface GetBearerTokenOptions {\n  /** Abort signal for the request */\n  abortSignal?: AbortSignal;\n}\n\n/**\n * Credential for OAuth2 authentication flows.\n */\nexport interface OAuth2TokenCredential<TFlows extends OAuth2Flow> {\n  /**\n   * Gets an OAuth2 token for the specified flows.\n   * @param flows - The OAuth2 flows to use.\n   * @param options - Options for the request.\n   * @returns - a valid access token which was obtained through one of the flows specified in `flows`.\n   */\n  getOAuth2Token(flows: TFlows[], options?: GetOAuth2TokenOptions): Promise<string>;\n}\n\n/**\n * Credential for Bearer token authentication.\n */\nexport interface BearerTokenCredential {\n  /**\n   * Gets a Bearer token for the specified flows.\n   * @param options - Options for the request.\n   * @returns - a valid access token.\n   */\n  getBearerToken(options?: GetBearerTokenOptions): Promise<string>;\n}\n\n/**\n * Credential for HTTP Basic authentication.\n * Provides username and password for basic authentication headers.\n */\nexport interface BasicCredential {\n  /** The username for basic authentication. */\n  username: string;\n  /** The password for basic authentication. */\n  password: string;\n}\n\n/**\n * Credential for API Key authentication.\n * Provides an API key that will be used in the request headers.\n */\nexport interface ApiKeyCredential {\n  /** The API key for authentication. */\n  key: string;\n}\n\n/**\n * Union type of all supported authentication credentials.\n */\nexport type ClientCredential =\n  | OAuth2TokenCredential<OAuth2Flow>\n  | BearerTokenCredential\n  | BasicCredential\n  | ApiKeyCredential;\n\n/**\n * Type guard to check if a credential is an OAuth2 token credential.\n */\nexport function isOAuth2TokenCredential(\n  credential: ClientCredential,\n): credential is OAuth2TokenCredential<OAuth2Flow> {\n  return \"getOAuth2Token\" in credential;\n}\n\n/**\n * Type guard to check if a credential is a Bearer token credential.\n */\nexport function isBearerTokenCredential(\n  credential: ClientCredential,\n): credential is BearerTokenCredential {\n  return \"getBearerToken\" in credential;\n}\n\n/**\n * Type guard to check if a credential is a Basic auth credential.\n */\nexport function isBasicCredential(credential: ClientCredential): credential is BasicCredential {\n  return \"username\" in credential && \"password\" in credential;\n}\n\n/**\n * Type guard to check if a credential is an API key credential.\n */\nexport function isApiKeyCredential(credential: ClientCredential): credential is ApiKeyCredential {\n  return \"key\" in credential;\n}\n"]}

package/dist/browser/auth/oauth2Flows.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Represents OAuth2 Authorization Code flow configuration.
+ */
+export interface AuthorizationCodeFlow {
+    /** Type of OAuth2 flow */
+    kind: "authorizationCode";
+    /** Authorization endpoint */
+    authorizationUrl: string;
+    /** Token endpoint */
+    tokenUrl: string;
+    /** Refresh token endpoint */
+    refreshUrl?: string;
+    /** OAuth2 scopes */
+    scopes?: string[];
+}
+/**
+ * Represents OAuth2 Client Credentials flow configuration.
+ */
+export interface ClientCredentialsFlow {
+    /** Type of OAuth2 flow */
+    kind: "clientCredentials";
+    /** Token endpoint */
+    tokenUrl: string;
+    /** Refresh token endpoints */
+    refreshUrl?: string[];
+    /** OAuth2 scopes */
+    scopes?: string[];
+}
+/**
+ * Represents OAuth2 Implicit flow configuration.
+ */
+export interface ImplicitFlow {
+    /** Type of OAuth2 flow */
+    kind: "implicit";
+    /** Authorization endpoint */
+    authorizationUrl: string;
+    /** Refresh token endpoint */
+    refreshUrl?: string;
+    /** OAuth2 scopes */
+    scopes?: string[];
+}
+/**
+ * Represents OAuth2 Password flow configuration.
+ */
+export interface PasswordFlow {
+    /** Type of OAuth2 flow */
+    kind: "password";
+    /** Token endpoint */
+    tokenUrl: string;
+    /** Refresh token endpoint */
+    refreshUrl?: string;
+    /** OAuth2 scopes */
+    scopes?: string[];
+}
+/** Union type of all supported OAuth2 flows */
+export type OAuth2Flow = AuthorizationCodeFlow | ClientCredentialsFlow | ImplicitFlow | PasswordFlow;
+//# sourceMappingURL=oauth2Flows.d.ts.map

package/dist/{esm/abort-controller/AbortSignalLike.js → browser/auth/oauth2Flows.js}

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 export {};
-//# sourceMappingURL=AbortSignalLike.js.map
+//# sourceMappingURL=oauth2Flows.js.map

package/dist/browser/auth/oauth2Flows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth2Flows.js","sourceRoot":"","sources":["../../../src/auth/oauth2Flows.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Represents OAuth2 Authorization Code flow configuration.\n */\nexport interface AuthorizationCodeFlow {\n  /** Type of OAuth2 flow */\n  kind: \"authorizationCode\";\n  /** Authorization endpoint */\n  authorizationUrl: string;\n  /** Token endpoint */\n  tokenUrl: string;\n  /** Refresh token endpoint */\n  refreshUrl?: string;\n  /** OAuth2 scopes */\n  scopes?: string[];\n}\n\n/**\n * Represents OAuth2 Client Credentials flow configuration.\n */\nexport interface ClientCredentialsFlow {\n  /** Type of OAuth2 flow */\n  kind: \"clientCredentials\";\n  /** Token endpoint */\n  tokenUrl: string;\n  /** Refresh token endpoints */\n  refreshUrl?: string[];\n  /** OAuth2 scopes */\n  scopes?: string[];\n}\n\n/**\n * Represents OAuth2 Implicit flow configuration.\n */\nexport interface ImplicitFlow {\n  /** Type of OAuth2 flow */\n  kind: \"implicit\";\n  /** Authorization endpoint */\n  authorizationUrl: string;\n  /** Refresh token endpoint */\n  refreshUrl?: string;\n  /** OAuth2 scopes */\n  scopes?: string[];\n}\n\n/**\n * Represents OAuth2 Password flow configuration.\n */\nexport interface PasswordFlow {\n  /** Type of OAuth2 flow */\n  kind: \"password\";\n  /** Token endpoint */\n  tokenUrl: string;\n  /** Refresh token endpoint */\n  refreshUrl?: string;\n  /** OAuth2 scopes */\n  scopes?: string[];\n}\n\n/** Union type of all supported OAuth2 flows */\nexport type OAuth2Flow =\n  | AuthorizationCodeFlow\n  | ClientCredentialsFlow\n  | ImplicitFlow\n  | PasswordFlow;\n"]}

package/dist/browser/auth/schemes.d.ts

@@ -0,0 +1,53 @@
+import type { OAuth2Flow } from "./oauth2Flows.js";
+/**
+ * Represents HTTP Basic authentication scheme.
+ * Basic authentication scheme requires a username and password to be provided with each request.
+ * The credentials are encoded using Base64 and included in the Authorization header.
+ */
+export interface BasicAuthScheme {
+    /** Type of auth scheme */
+    kind: "http";
+    /** Basic authentication scheme */
+    scheme: "basic";
+}
+/**
+ * Represents HTTP Bearer authentication scheme.
+ * Bearer authentication scheme requires a bearer token to be provided with each request.
+ * The token is included in the Authorization header with the "Bearer" prefix.
+ */
+export interface BearerAuthScheme {
+    /** Type of auth scheme */
+    kind: "http";
+    /** Bearer authentication scheme */
+    scheme: "bearer";
+}
+/**
+ * Represents an endpoint or operation that requires no authentication.
+ */
+export interface NoAuthAuthScheme {
+    /** Type of auth scheme */
+    kind: "noAuth";
+}
+/**
+ * Represents API Key authentication scheme.
+ * API Key authentication requires a key to be provided with each request.
+ * The key can be provided in different locations: query parameter, header, or cookie.
+ */
+export interface ApiKeyAuthScheme {
+    /** Type of auth scheme */
+    kind: "apiKey";
+    /** Location of the API key */
+    apiKeyLocation: "query" | "header" | "cookie";
+    /** Name of the API key parameter */
+    name: string;
+}
+/** Represents OAuth2 authentication scheme with specified flows */
+export interface OAuth2AuthScheme<TFlows extends OAuth2Flow[]> {
+    /** Type of auth scheme */
+    kind: "oauth2";
+    /** Supported OAuth2 flows */
+    flows: TFlows;
+}
+/** Union type of all supported authentication schemes */
+export type AuthScheme = BasicAuthScheme | BearerAuthScheme | NoAuthAuthScheme | ApiKeyAuthScheme | OAuth2AuthScheme<OAuth2Flow[]>;
+//# sourceMappingURL=schemes.d.ts.map

package/dist/{react-native/abort-controller/AbortSignalLike.js → browser/auth/schemes.js}

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 export {};
-//# sourceMappingURL=AbortSignalLike.js.map
+//# sourceMappingURL=schemes.js.map

package/dist/browser/auth/schemes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemes.js","sourceRoot":"","sources":["../../../src/auth/schemes.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OAuth2Flow } from \"./oauth2Flows.js\";\n\n/**\n * Represents HTTP Basic authentication scheme.\n * Basic authentication scheme requires a username and password to be provided with each request.\n * The credentials are encoded using Base64 and included in the Authorization header.\n */\nexport interface BasicAuthScheme {\n  /** Type of auth scheme */\n  kind: \"http\";\n  /** Basic authentication scheme */\n  scheme: \"basic\";\n}\n\n/**\n * Represents HTTP Bearer authentication scheme.\n * Bearer authentication scheme requires a bearer token to be provided with each request.\n * The token is included in the Authorization header with the \"Bearer\" prefix.\n */\nexport interface BearerAuthScheme {\n  /** Type of auth scheme */\n  kind: \"http\";\n  /** Bearer authentication scheme */\n  scheme: \"bearer\";\n}\n\n/**\n * Represents an endpoint or operation that requires no authentication.\n */\nexport interface NoAuthAuthScheme {\n  /** Type of auth scheme */\n  kind: \"noAuth\";\n}\n\n/**\n * Represents API Key authentication scheme.\n * API Key authentication requires a key to be provided with each request.\n * The key can be provided in different locations: query parameter, header, or cookie.\n */\nexport interface ApiKeyAuthScheme {\n  /** Type of auth scheme */\n  kind: \"apiKey\";\n  /** Location of the API key */\n  apiKeyLocation: \"query\" | \"header\" | \"cookie\";\n  /** Name of the API key parameter */\n  name: string;\n}\n\n/** Represents OAuth2 authentication scheme with specified flows */\nexport interface OAuth2AuthScheme<TFlows extends OAuth2Flow[]> {\n  /** Type of auth scheme */\n  kind: \"oauth2\";\n  /** Supported OAuth2 flows */\n  flows: TFlows;\n}\n\n/** Union type of all supported authentication schemes */\nexport type AuthScheme =\n  | BasicAuthScheme\n  | BearerAuthScheme\n  | NoAuthAuthScheme\n  | ApiKeyAuthScheme\n  | OAuth2AuthScheme<OAuth2Flow[]>;\n"]}

package/dist/browser/client/clientHelpers.d.ts

@@ -1,28 +1,9 @@
 import type { HttpClient } from "../interfaces.js";
 import type { Pipeline } from "../pipeline.js";
-import type { TokenCredential } from "../auth/tokenCredential.js";
-import type { KeyCredential } from "../auth/keyCredential.js";
 import type { ClientOptions } from "./common.js";
-/**
- * Optional parameters for adding a credential policy to the pipeline.
- */
-export interface AddCredentialPipelinePolicyOptions {
-    /**
-     * Options related to the client.
-     */
-    clientOptions?: ClientOptions;
-    /**
-     * The credential to use.
-     */
-    credential?: TokenCredential | KeyCredential;
-}
-/**
- * Adds a credential policy to the pipeline if a credential is provided. If none is provided, no policy is added.
- */
-export declare function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions): void;
 /**
  * Creates a default rest pipeline to re-use accross Rest Level Clients
  */
-export declare function createDefaultPipeline(endpoint: string, credential?: TokenCredential | KeyCredential, options?: ClientOptions): Pipeline;
+export declare function createDefaultPipeline(options?: ClientOptions): Pipeline;
 export declare function getCachedDefaultHttpsClient(): HttpClient;
 //# sourceMappingURL=clientHelpers.d.ts.map

package/dist/browser/client/clientHelpers.js

@@ -1,44 +1,35 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { bearerTokenAuthenticationPolicy } from "../policies/bearerTokenAuthenticationPolicy.js";
 import { createDefaultHttpClient } from "../defaultHttpClient.js";
 import { createPipelineFromOptions } from "../createPipelineFromOptions.js";
-import { isTokenCredential } from "../auth/tokenCredential.js";
-import { isKeyCredential } from "../auth/keyCredential.js";
 import { apiVersionPolicy } from "./apiVersionPolicy.js";
-import { keyCredentialAuthenticationPolicy } from "./keyCredentialAuthenticationPolicy.js";
+import { isApiKeyCredential, isBasicCredential, isBearerTokenCredential, isOAuth2TokenCredential, } from "../auth/credentials.js";
+import { apiKeyAuthenticationPolicy } from "../policies/auth/apiKeyAuthenticationPolicy.js";
+import { basicAuthenticationPolicy } from "../policies/auth/basicAuthenticationPolicy.js";
+import { bearerAuthenticationPolicy } from "../policies/auth/bearerAuthenticationPolicy.js";
+import { oauth2AuthenticationPolicy } from "../policies/auth/oauth2AuthenticationPolicy.js";
 let cachedHttpClient;
-/**
- * Adds a credential policy to the pipeline if a credential is provided. If none is provided, no policy is added.
- */
-export function addCredentialPipelinePolicy(pipeline, endpoint, options = {}) {
-    var _a, _b, _c, _d;
-    const { credential, clientOptions } = options;
-    if (!credential) {
-        return;
-    }
-    if (isTokenCredential(credential)) {
-        const tokenPolicy = bearerTokenAuthenticationPolicy({
-            credential,
-            scopes: (_b = (_a = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.credentials) === null || _a === void 0 ? void 0 : _a.scopes) !== null && _b !== void 0 ? _b : `${endpoint}/.default`,
-        });
-        pipeline.addPolicy(tokenPolicy);
-    }
-    else if (isKeyCredential(credential)) {
-        if (!((_c = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.credentials) === null || _c === void 0 ? void 0 : _c.apiKeyHeaderName)) {
-            throw new Error(`Missing API Key Header Name`);
-        }
-        const keyPolicy = keyCredentialAuthenticationPolicy(credential, (_d = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.credentials) === null || _d === void 0 ? void 0 : _d.apiKeyHeaderName);
-        pipeline.addPolicy(keyPolicy);
-    }
-}
 /**
  * Creates a default rest pipeline to re-use accross Rest Level Clients
  */
-export function createDefaultPipeline(endpoint, credential, options = {}) {
+export function createDefaultPipeline(options = {}) {
     const pipeline = createPipelineFromOptions(options);
     pipeline.addPolicy(apiVersionPolicy(options));
-    addCredentialPipelinePolicy(pipeline, endpoint, { credential, clientOptions: options });
+    const { credential, authSchemes } = options;
+    if (credential) {
+        if (isApiKeyCredential(credential)) {
+            pipeline.addPolicy(apiKeyAuthenticationPolicy({ authSchemes, credential }));
+        }
+        else if (isBasicCredential(credential)) {
+            pipeline.addPolicy(basicAuthenticationPolicy({ authSchemes, credential }));
+        }
+        else if (isBearerTokenCredential(credential)) {
+            pipeline.addPolicy(bearerAuthenticationPolicy({ authSchemes, credential }));
+        }
+        else if (isOAuth2TokenCredential(credential)) {
+            pipeline.addPolicy(oauth2AuthenticationPolicy({ authSchemes, credential }));
+        }
+    }
     return pipeline;
 }
 export function getCachedDefaultHttpsClient() {

package/dist/browser/client/clientHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"clientHelpers.js","sourceRoot":"","sources":["../../../src/client/clientHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAE5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAE3F,IAAI,gBAAwC,CAAC;AAgB7C;;GAEG;AACH,MAAM,UAAU,2BAA2B,CACzC,QAAkB,EAClB,QAAgB,EAChB,UAA8C,EAAE;;IAEhD,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC9C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,+BAA+B,CAAC;YAClD,UAAU;YACV,MAAM,EAAE,MAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,WAAW,0CAAE,MAAM,mCAAI,GAAG,QAAQ,WAAW;SACrE,CAAC,CAAC;QACH,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,CAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,WAAW,0CAAE,gBAAgB,CAAA,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,SAAS,GAAG,iCAAiC,CACjD,UAAU,EACV,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,WAAW,0CAAE,gBAAgB,CAC7C,CAAC;QACF,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAgB,EAChB,UAA4C,EAC5C,UAAyB,EAAE;IAE3B,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEpD,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9C,2BAA2B,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;IACxF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,2BAA2B;IACzC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { HttpClient } from \"../interfaces.js\";\nimport type { Pipeline } from \"../pipeline.js\";\nimport { bearerTokenAuthenticationPolicy } from \"../policies/bearerTokenAuthenticationPolicy.js\";\nimport { createDefaultHttpClient } from \"../defaultHttpClient.js\";\nimport { createPipelineFromOptions } from \"../createPipelineFromOptions.js\";\nimport type { TokenCredential } from \"../auth/tokenCredential.js\";\nimport { isTokenCredential } from \"../auth/tokenCredential.js\";\nimport type { KeyCredential } from \"../auth/keyCredential.js\";\nimport { isKeyCredential } from \"../auth/keyCredential.js\";\nimport type { ClientOptions } from \"./common.js\";\nimport { apiVersionPolicy } from \"./apiVersionPolicy.js\";\nimport { keyCredentialAuthenticationPolicy } from \"./keyCredentialAuthenticationPolicy.js\";\n\nlet cachedHttpClient: HttpClient | undefined;\n\n/**\n * Optional parameters for adding a credential policy to the pipeline.\n */\nexport interface AddCredentialPipelinePolicyOptions {\n  /**\n   * Options related to the client.\n   */\n  clientOptions?: ClientOptions;\n  /**\n   * The credential to use.\n   */\n  credential?: TokenCredential | KeyCredential;\n}\n\n/**\n * Adds a credential policy to the pipeline if a credential is provided. If none is provided, no policy is added.\n */\nexport function addCredentialPipelinePolicy(\n  pipeline: Pipeline,\n  endpoint: string,\n  options: AddCredentialPipelinePolicyOptions = {},\n): void {\n  const { credential, clientOptions } = options;\n  if (!credential) {\n    return;\n  }\n\n  if (isTokenCredential(credential)) {\n    const tokenPolicy = bearerTokenAuthenticationPolicy({\n      credential,\n      scopes: clientOptions?.credentials?.scopes ?? `${endpoint}/.default`,\n    });\n    pipeline.addPolicy(tokenPolicy);\n  } else if (isKeyCredential(credential)) {\n    if (!clientOptions?.credentials?.apiKeyHeaderName) {\n      throw new Error(`Missing API Key Header Name`);\n    }\n    const keyPolicy = keyCredentialAuthenticationPolicy(\n      credential,\n      clientOptions?.credentials?.apiKeyHeaderName,\n    );\n    pipeline.addPolicy(keyPolicy);\n  }\n}\n\n/**\n * Creates a default rest pipeline to re-use accross Rest Level Clients\n */\nexport function createDefaultPipeline(\n  endpoint: string,\n  credential?: TokenCredential | KeyCredential,\n  options: ClientOptions = {},\n): Pipeline {\n  const pipeline = createPipelineFromOptions(options);\n\n  pipeline.addPolicy(apiVersionPolicy(options));\n\n  addCredentialPipelinePolicy(pipeline, endpoint, { credential, clientOptions: options });\n  return pipeline;\n}\n\nexport function getCachedDefaultHttpsClient(): HttpClient {\n  if (!cachedHttpClient) {\n    cachedHttpClient = createDefaultHttpClient();\n  }\n\n  return cachedHttpClient;\n}\n"]}
+{"version":3,"file":"clientHelpers.js","sourceRoot":"","sources":["../../../src/client/clientHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAE5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAC5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,+CAA+C,CAAC;AAC1F,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAE5F,IAAI,gBAAwC,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAyB,EAAE;IAC/D,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEpD,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAC5C,IAAI,UAAU,EAAE,CAAC;QACf,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,QAAQ,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9E,CAAC;aAAM,IAAI,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,QAAQ,CAAC,SAAS,CAAC,yBAAyB,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,uBAAuB,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/C,QAAQ,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9E,CAAC;aAAM,IAAI,uBAAuB,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/C,QAAQ,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,2BAA2B;IACzC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { HttpClient } from \"../interfaces.js\";\nimport type { Pipeline } from \"../pipeline.js\";\nimport { createDefaultHttpClient } from \"../defaultHttpClient.js\";\nimport { createPipelineFromOptions } from \"../createPipelineFromOptions.js\";\nimport type { ClientOptions } from \"./common.js\";\nimport { apiVersionPolicy } from \"./apiVersionPolicy.js\";\nimport {\n  isApiKeyCredential,\n  isBasicCredential,\n  isBearerTokenCredential,\n  isOAuth2TokenCredential,\n} from \"../auth/credentials.js\";\nimport { apiKeyAuthenticationPolicy } from \"../policies/auth/apiKeyAuthenticationPolicy.js\";\nimport { basicAuthenticationPolicy } from \"../policies/auth/basicAuthenticationPolicy.js\";\nimport { bearerAuthenticationPolicy } from \"../policies/auth/bearerAuthenticationPolicy.js\";\nimport { oauth2AuthenticationPolicy } from \"../policies/auth/oauth2AuthenticationPolicy.js\";\n\nlet cachedHttpClient: HttpClient | undefined;\n\n/**\n * Creates a default rest pipeline to re-use accross Rest Level Clients\n */\nexport function createDefaultPipeline(options: ClientOptions = {}): Pipeline {\n  const pipeline = createPipelineFromOptions(options);\n\n  pipeline.addPolicy(apiVersionPolicy(options));\n\n  const { credential, authSchemes } = options;\n  if (credential) {\n    if (isApiKeyCredential(credential)) {\n      pipeline.addPolicy(apiKeyAuthenticationPolicy({ authSchemes, credential }));\n    } else if (isBasicCredential(credential)) {\n      pipeline.addPolicy(basicAuthenticationPolicy({ authSchemes, credential }));\n    } else if (isBearerTokenCredential(credential)) {\n      pipeline.addPolicy(bearerAuthenticationPolicy({ authSchemes, credential }));\n    } else if (isOAuth2TokenCredential(credential)) {\n      pipeline.addPolicy(oauth2AuthenticationPolicy({ authSchemes, credential }));\n    }\n  }\n\n  return pipeline;\n}\n\nexport function getCachedDefaultHttpsClient(): HttpClient {\n  if (!cachedHttpClient) {\n    cachedHttpClient = createDefaultHttpClient();\n  }\n\n  return cachedHttpClient;\n}\n"]}

package/dist/browser/client/common.d.ts

@@ -1,8 +1,9 @@
 import type { HttpClient, PipelineRequest, PipelineResponse, RawHttpHeaders, RequestBodyType, TransferProgressEvent, RawHttpHeadersInput } from "../interfaces.js";
 import type { Pipeline, PipelinePolicy } from "../pipeline.js";
-import type { AbortSignalLike } from "../abort-controller/AbortSignalLike.js";
 import type { PipelineOptions } from "../createPipelineFromOptions.js";
 import type { LogPolicyOptions } from "../policies/logPolicy.js";
+import type { AuthScheme } from "../auth/schemes.js";
+import type { ClientCredential } from "../auth/credentials.js";
 /**
  * Shape of the default request parameters, this may be overridden by the specific
  * request types to provide strong types
@@ -54,7 +55,7 @@ export type RequestParameters = {
     /**
      * The signal which can be used to abort requests.
      */
-    abortSignal?: AbortSignalLike;
+    abortSignal?: AbortSignal;
     /**
      * A function to be called each time a response is received from the server
      * while performing the requested operation.
@@ -93,7 +94,7 @@ export interface OperationOptions {
     /**
      * The signal which can be used to abort requests.
      */
-    abortSignal?: AbortSignalLike;
+    abortSignal?: AbortSignal;
     /**
      * Options used when creating and sending HTTP requests for this operation.
      */
@@ -153,7 +154,7 @@ export interface Client {
      * This method will be used to send request that would check the path to provide
      * strong types. When used by the codegen this type gets overridden with the generated
      * types. For example:
-     * ```typescript snippet:path_example
+     * ```typescript snippet:ReadmeSamplePathExample
      * import { Client } from "@typespec/ts-http-runtime";
      *
      * type MyClient = Client & {
@@ -190,7 +191,14 @@ export type HttpBrowserStreamResponse = HttpResponse & {
  * a raw stream
  */
 export type StreamableMethod<TResponse = PathUncheckedResponse> = PromiseLike<TResponse> & {
+    /**
+     * Returns the response body as a NodeJS stream. Only available in Node-like environments.
+     */
     asNodeStream: () => Promise<HttpNodeStreamResponse>;
+    /**
+     * Returns the response body as a browser (Web) stream. Only available in the browser. If you require a Web Stream of the response in Node, consider using the
+     * `Readable.toWeb` Node API on the result of `asNodeStream`.
+     */
     asBrowserStream: () => Promise<HttpBrowserStreamResponse>;
 };
 /**
@@ -255,18 +263,15 @@ export interface AdditionalPolicyConfig {
  */
 export type ClientOptions = PipelineOptions & {
     /**
-     * Credentials information
-     */
-    credentials?: {
-        /**
-         * Authentication scopes for AAD
-         */
-        scopes?: string[];
-        /**
-         * Heder name for Client Secret authentication
-         */
-        apiKeyHeaderName?: string;
-    };
+     * List of authentication schemes supported by the client.
+     * These schemes define how the client can authenticate requests.
+     */
+    authSchemes?: AuthScheme[];
+    /**
+     * The credential used to authenticate requests.
+     * Must be compatible with one of the specified authentication schemes.
+     */
+    credential?: ClientCredential;
     /**
      * Endpoint for the client
      */