@typespec/ts-http-runtime 1.0.0-alpha.20240214.1 → 1.0.0-alpha.20240223.2

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA0B,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,SAAS,EAAoB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC1E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAoB,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAA6B,MAAM,kCAAkC,CAAC;AACjG,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAoB9D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,iBAAiB;AACjB,OAAO,EAAE,KAAK,EAAgB,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAEL,qBAAqB,GAEtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,sBAAsB,GAEvB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAiB,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC5F,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACL,SAAS,EACT,KAAK,EACL,MAAM,EACN,MAAM,EACN,aAAa,EACb,WAAW,GACZ,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAgB,MAAM,yBAAyB,CAAC;AAC/F,OAAO,EAEL,qBAAqB,GAGtB,MAAM,oBAAoB,CAAC;AAC5B,SAAS;AACT,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EACL,2BAA2B,GAE5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mCAAmC,EAAE,MAAM,oCAAoC,CAAC;AACzF,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\ndeclare global {\n  interface FormData {}\n  interface Blob {}\n  interface File {}\n  interface ReadableStream<R = any> {}\n  interface TransformStream<I = any, O = any> {}\n}\n/* eslint-enable @typescript-eslint/no-unused-vars */\n\nexport {\n  Agent,\n  BodyPart,\n  FormDataMap,\n  FormDataValue,\n  HttpClient,\n  HttpHeaders,\n  HttpMethods,\n  KeyObject,\n  MultipartRequestBody,\n  PipelineRequest,\n  PipelineResponse,\n  PipelineRetryOptions,\n  ProxySettings,\n  PxfObject,\n  RawHttpHeaders,\n  RawHttpHeadersInput,\n  RequestBodyType,\n  SendRequest,\n  TlsSettings,\n  TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n  AddPolicyOptions as AddPipelineOptions,\n  PipelinePhase,\n  PipelinePolicy,\n  Pipeline,\n  createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n  createPipelineFromOptions,\n  TelemetryOptions,\n  InternalPipelineOptions,\n  PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n  decompressResponsePolicy,\n  decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport { logPolicy, logPolicyName, LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n  redirectPolicy,\n  redirectPolicyName,\n  RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n  tracingPolicy,\n  tracingPolicyName,\n  TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport { defaultRetryPolicy, DefaultRetryPolicyOptions } from \"./policies/defaultRetryPolicy.js\";\nexport {\n  userAgentPolicy,\n  userAgentPolicyName,\n  UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n  bearerTokenAuthenticationPolicy,\n  BearerTokenAuthenticationPolicyOptions,\n  bearerTokenAuthenticationPolicyName,\n  ChallengeCallbacks,\n  AuthorizeRequestOptions,\n  AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { AbortSignalLike } from \"./abort-controller/AbortSignalLike.js\";\nexport { AbortError } from \"./abort-controller/AbortError.js\";\nexport { AccessToken, GetTokenOptions, TokenCredential } from \"./auth/tokenCredential.js\";\nexport { KeyCredential } from \"./auth/keyCredential.js\";\nexport {\n  Instrumenter,\n  InstrumenterSpanOptions,\n  OperationTracingOptions,\n  OptionsWithTracingContext,\n  Resolved,\n  SpanStatus,\n  SpanStatusError,\n  SpanStatusSuccess,\n  TracingClient,\n  TracingClientOptions,\n  TracingContext,\n  TracingSpan,\n  TracingSpanKind,\n  TracingSpanLink,\n  TracingSpanOptions,\n} from \"./tracing/interfaces.js\";\nexport { useInstrumenter } from \"./tracing/instrumenter.js\";\nexport { createTracingClient } from \"./tracing/tracingClient.js\";\n// from core-util\nexport { delay, DelayOptions } from \"./util/delay.js\";\nexport {\n  AbortOptions,\n  cancelablePromiseRace,\n  AbortablePromiseBuilder,\n} from \"./util/aborterUtils.js\";\nexport {\n  createAbortablePromise,\n  CreateAbortablePromiseOptions,\n} from \"./util/createAbortablePromise.js\";\nexport { getRandomIntegerInclusive } from \"./util/random.js\";\nexport { isObject, UnknownObject } from \"./util/object.js\";\nexport { isError, getErrorMessage } from \"./util/error.js\";\nexport {\n  createFile,\n  createFileFromStream,\n  CreateFileOptions,\n  CreateFileFromStreamOptions,\n} from \"./util/file.js\";\nexport { computeSha256Hash, computeSha256Hmac } from \"./util/sha256.js\";\nexport { isDefined, isObjectWithProperties, objectHasProperty } from \"./util/typeGuards.js\";\nexport { randomUUID } from \"./util/uuidUtils.js\";\nexport {\n  isBrowser,\n  isBun,\n  isNode,\n  isDeno,\n  isReactNative,\n  isWebWorker,\n} from \"./util/checkEnvironment.js\";\nexport { uint8ArrayToString, stringToUint8Array, EncodingType } from \"./util/bytesEncoding.js\";\nexport {\n  Debugger,\n  TypeSpecRuntimeLogger,\n  TypeSpecRuntimeLogLevel,\n  TypeSpecRuntimeClientLogger,\n} from \"./logger/logger.js\";\n// client\nexport { createRestError } from \"./client/restError.js\";\nexport {\n  addCredentialPipelinePolicy,\n  AddCredentialPipelinePolicyOptions,\n} from \"./client/clientHelpers.js\";\nexport { operationOptionsToRequestParameters } from \"./client/operationOptionHelpers.js\";\nexport * from \"./client/getClient.js\";\nexport * from \"./client/common.js\";\n"]}

package/dist/esm/interfaces.d.ts

@@ -0,0 +1,447 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { AbortSignalLike } from "./abort-controller/AbortSignalLike.js";
+import { OperationTracingOptions } from "./tracing/interfaces.js";
+/**
+ * A HttpHeaders collection represented as a simple JSON object.
+ */
+export type RawHttpHeaders = {
+    [headerName: string]: string;
+};
+/**
+ * A HttpHeaders collection for input, represented as a simple JSON object.
+ */
+export type RawHttpHeadersInput = Record<string, string | number | boolean>;
+/**
+ * Represents a set of HTTP headers on a request/response.
+ * Header names are treated as case insensitive.
+ */
+export interface HttpHeaders extends Iterable<[string, string]> {
+    /**
+     * Returns the value of a specific header or undefined if not set.
+     * @param name - The name of the header to retrieve.
+     */
+    get(name: string): string | undefined;
+    /**
+     * Returns true if the specified header exists.
+     * @param name - The name of the header to check.
+     */
+    has(name: string): boolean;
+    /**
+     * Sets a specific header with a given value.
+     * @param name - The name of the header to set.
+     * @param value - The value to use for the header.
+     */
+    set(name: string, value: string | number | boolean): void;
+    /**
+     * Removes a specific header from the collection.
+     * @param name - The name of the header to delete.
+     */
+    delete(name: string): void;
+    /**
+     * Accesses a raw JS object that acts as a simple map
+     * of header names to values.
+     */
+    toJSON(options?: {
+        preserveCase?: boolean;
+    }): RawHttpHeaders;
+}
+/**
+ * A part of the request body in a multipart request.
+ */
+export interface BodyPart {
+    /**
+     * The headers for this part of the multipart request.
+     */
+    headers: HttpHeaders;
+    /**
+     * The body of this part of the multipart request.
+     */
+    body: ((() => ReadableStream<Uint8Array>) | (() => NodeJS.ReadableStream)) | ReadableStream<Uint8Array> | NodeJS.ReadableStream | Uint8Array | Blob;
+}
+/**
+ * A request body consisting of multiple parts.
+ */
+export interface MultipartRequestBody {
+    /**
+     * The parts of the request body.
+     */
+    parts: BodyPart[];
+    /**
+     * The boundary separating each part of the request body.
+     * If not specified, a random boundary will be generated.
+     *
+     * When specified, '--' will be prepended to the boundary in the request to ensure the boundary follows the specification.
+     */
+    boundary?: string;
+}
+/**
+ * Types of bodies supported on the request.
+ * NodeJS.ReadableStream and () =\> NodeJS.ReadableStream is Node only.
+ * Blob, ReadableStream<Uint8Array>, and () =\> ReadableStream<Uint8Array> are browser only.
+ */
+export type RequestBodyType = NodeJS.ReadableStream | (() => NodeJS.ReadableStream) | ReadableStream<Uint8Array> | (() => ReadableStream<Uint8Array>) | Blob | ArrayBuffer | ArrayBufferView | FormData | string | null;
+/**
+ * An interface compatible with NodeJS's `http.Agent`.
+ * We want to avoid publicly re-exporting the actual interface,
+ * since it might vary across runtime versions.
+ */
+export interface Agent {
+    /**
+     * Destroy any sockets that are currently in use by the agent.
+     */
+    destroy(): void;
+    /**
+     * For agents with keepAlive enabled, this sets the maximum number of sockets that will be left open in the free state.
+     */
+    maxFreeSockets: number;
+    /**
+     * Determines how many concurrent sockets the agent can have open per origin.
+     */
+    maxSockets: number;
+    /**
+     * An object which contains queues of requests that have not yet been assigned to sockets.
+     */
+    requests: unknown;
+    /**
+     * An object which contains arrays of sockets currently in use by the agent.
+     */
+    sockets: unknown;
+}
+/**
+ * Metadata about a request being made by the pipeline.
+ */
+export interface PipelineRequest {
+    /**
+     * The URL to make the request to.
+     */
+    url: string;
+    /**
+     * The HTTP method to use when making the request.
+     */
+    method: HttpMethods;
+    /**
+     * The HTTP headers to use when making the request.
+     */
+    headers: HttpHeaders;
+    /**
+     * The number of milliseconds a request can take before automatically being terminated.
+     * If the request is terminated, an `AbortError` is thrown.
+     * Defaults to 0, which disables the timeout.
+     */
+    timeout: number;
+    /**
+     * Indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests.
+     * Defaults to false.
+     */
+    withCredentials: boolean;
+    /**
+     * A unique identifier for the request. Used for logging and tracing.
+     */
+    requestId: string;
+    /**
+     * The HTTP body content (if any)
+     */
+    body?: RequestBodyType;
+    /**
+     * Body for a multipart request.
+     */
+    multipartBody?: MultipartRequestBody;
+    /**
+     * To simulate a browser form post
+     */
+    formData?: FormDataMap;
+    /**
+     * A list of response status codes whose corresponding PipelineResponse body should be treated as a stream.
+     * When streamResponseStatusCodes contains the value Number.POSITIVE_INFINITY any status would be treated as a stream.
+     */
+    streamResponseStatusCodes?: Set<number>;
+    /**
+     * Proxy configuration.
+     */
+    proxySettings?: ProxySettings;
+    /**
+     * If the connection should not be reused.
+     */
+    disableKeepAlive?: boolean;
+    /**
+     * Used to abort the request later.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Tracing options to use for any created Spans.
+     */
+    tracingOptions?: OperationTracingOptions;
+    /**
+     * Callback which fires upon upload progress.
+     */
+    onUploadProgress?: (progress: TransferProgressEvent) => void;
+    /** Callback which fires upon download progress. */
+    onDownloadProgress?: (progress: TransferProgressEvent) => void;
+    /** Set to true if the request is sent over HTTP instead of HTTPS */
+    allowInsecureConnection?: boolean;
+    /**
+     * NODEJS ONLY
+     *
+     * A Node-only option to provide a custom `http.Agent`/`https.Agent`.
+     * Does nothing when running in the browser.
+     */
+    agent?: Agent;
+    /**
+     * BROWSER ONLY
+     *
+     * A browser only option to enable browser Streams. If this option is set and a response is a stream
+     * the response will have a property `browserStream` instead of `blobBody` which will be undefined.
+     *
+     * Default value is false
+     */
+    enableBrowserStreams?: boolean;
+    /** Settings for configuring TLS authentication */
+    tlsSettings?: TlsSettings;
+}
+/**
+ * Metadata about a response received by the pipeline.
+ */
+export interface PipelineResponse {
+    /**
+     * The request that generated this response.
+     */
+    request: PipelineRequest;
+    /**
+     * The HTTP status code of the response.
+     */
+    status: number;
+    /**
+     * The HTTP response headers.
+     */
+    headers: HttpHeaders;
+    /**
+     * The response body as text (string format)
+     */
+    bodyAsText?: string | null;
+    /**
+     * BROWSER ONLY
+     *
+     * The response body as a browser Blob.
+     * Always undefined in node.js.
+     */
+    blobBody?: Promise<Blob>;
+    /**
+     * BROWSER ONLY
+     *
+     * The response body as a browser ReadableStream.
+     * Always undefined in node.js.
+     */
+    browserStreamBody?: ReadableStream<Uint8Array>;
+    /**
+     * NODEJS ONLY
+     *
+     * The response body as a node.js Readable stream.
+     * Always undefined in the browser.
+     */
+    readableStreamBody?: NodeJS.ReadableStream;
+}
+/**
+ * A simple interface for making a pipeline request and receiving a response.
+ */
+export type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
+/**
+ * The required interface for a client that makes HTTP requests
+ * on behalf of a pipeline.
+ */
+export interface HttpClient {
+    /**
+     * The method that makes the request and returns a response.
+     */
+    sendRequest: SendRequest;
+}
+/**
+ * Fired in response to upload or download progress.
+ */
+export type TransferProgressEvent = {
+    /**
+     * The number of bytes loaded so far.
+     */
+    loadedBytes: number;
+};
+/**
+ * Supported HTTP methods to use when making requests.
+ */
+export type HttpMethods = "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE";
+/**
+ * Options to configure a proxy for outgoing requests (Node.js only).
+ */
+export interface ProxySettings {
+    /**
+     * The proxy's host address.
+     */
+    host: string;
+    /**
+     * The proxy host's port.
+     */
+    port: number;
+    /**
+     * The user name to authenticate with the proxy, if required.
+     */
+    username?: string;
+    /**
+     * The password to authenticate with the proxy, if required.
+     */
+    password?: string;
+}
+/**
+ * Each form data entry can be a string, Blob, or a File. If you wish to pass a file with a name but do not have
+ * access to the File class, you can use the createFile helper to create one.
+ */
+export type FormDataValue = string | Blob | File;
+/**
+ * A simple object that provides form data, as if from a browser form.
+ */
+export type FormDataMap = {
+    [key: string]: FormDataValue | FormDataValue[];
+};
+/**
+ * Options that control how to retry failed requests.
+ */
+export interface PipelineRetryOptions {
+    /**
+     * The maximum number of retry attempts. Defaults to 3.
+     */
+    maxRetries?: number;
+    /**
+     * The amount of delay in milliseconds between retry attempts. Defaults to 1000
+     * (1 second). The delay increases exponentially with each retry up to a maximum
+     * specified by maxRetryDelayInMs.
+     */
+    retryDelayInMs?: number;
+    /**
+     * The maximum delay in milliseconds allowed before retrying an operation. Defaults
+     * to 64000 (64 seconds).
+     */
+    maxRetryDelayInMs?: number;
+}
+/**
+ * Represents a certificate credential for authentication.
+ */
+export interface CertificateCredential {
+    /**
+     * Optionally override the trusted CA certificates. Default is to trust
+     * the well-known CAs curated by Mozilla. Mozilla's CAs are completely
+     * replaced when CAs are explicitly specified using this option.
+     */
+    ca?: string | Buffer | Array<string | Buffer> | undefined;
+    /**
+     *  Cert chains in PEM format. One cert chain should be provided per
+     *  private key. Each cert chain should consist of the PEM formatted
+     *  certificate for a provided private key, followed by the PEM
+     *  formatted intermediate certificates (if any), in order, and not
+     *  including the root CA (the root CA must be pre-known to the peer,
+     *  see ca). When providing multiple cert chains, they do not have to
+     *  be in the same order as their private keys in key. If the
+     *  intermediate certificates are not provided, the peer will not be
+     *  able to validate the certificate, and the handshake will fail.
+     */
+    cert?: string | Buffer | Array<string | Buffer> | undefined;
+    /**
+     * Private keys in PEM format. PEM allows the option of private keys
+     * being encrypted. Encrypted keys will be decrypted with
+     * options.passphrase. Multiple keys using different algorithms can be
+     * provided either as an array of unencrypted key strings or buffers,
+     * or an array of objects in the form `{pem: <string|buffer>[,passphrase: <string>]}`.
+     * The object form can only occur in an array.object.passphrase is optional.
+     * Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
+     */
+    key?: string | Buffer | Array<Buffer | KeyObject> | undefined;
+    /**
+     * Shared passphrase used for a single private key and/or a PFX.
+     */
+    passphrase?: string | undefined;
+    /**
+     * PFX or PKCS12 encoded private key and certificate chain. pfx is an
+     * alternative to providing key and cert individually. PFX is usually
+     * encrypted, if it is, passphrase will be used to decrypt it. Multiple
+     * PFX can be provided either as an array of unencrypted PFX buffers,
+     * or an array of objects in the form `{buf: <string|buffer>[,passphrase: <string>]}`.
+     * The object form can only occur in an array.object.passphrase is optional.
+     * Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
+     */
+    pfx?: string | Buffer | Array<string | Buffer | PxfObject> | undefined;
+}
+/**
+ * Represents a certificate for TLS authentication.
+ */
+export interface TlsSettings {
+    /**
+     * Optionally override the trusted CA certificates. Default is to trust
+     * the well-known CAs curated by Mozilla. Mozilla's CAs are completely
+     * replaced when CAs are explicitly specified using this option.
+     */
+    ca?: string | Buffer | Array<string | Buffer> | undefined;
+    /**
+     *  Cert chains in PEM format. One cert chain should be provided per
+     *  private key. Each cert chain should consist of the PEM formatted
+     *  certificate for a provided private key, followed by the PEM
+     *  formatted intermediate certificates (if any), in order, and not
+     *  including the root CA (the root CA must be pre-known to the peer,
+     *  see ca). When providing multiple cert chains, they do not have to
+     *  be in the same order as their private keys in key. If the
+     *  intermediate certificates are not provided, the peer will not be
+     *  able to validate the certificate, and the handshake will fail.
+     */
+    cert?: string | Buffer | Array<string | Buffer> | undefined;
+    /**
+     * Private keys in PEM format. PEM allows the option of private keys
+     * being encrypted. Encrypted keys will be decrypted with
+     * options.passphrase. Multiple keys using different algorithms can be
+     * provided either as an array of unencrypted key strings or buffers,
+     * or an array of objects in the form `{pem: <string|buffer>[,passphrase: <string>]}`.
+     * The object form can only occur in an array.object.passphrase is optional.
+     * Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
+     */
+    key?: string | Buffer | Array<Buffer | KeyObject> | undefined;
+    /**
+     * Shared passphrase used for a single private key and/or a PFX.
+     */
+    passphrase?: string | undefined;
+    /**
+     * PFX or PKCS12 encoded private key and certificate chain. pfx is an
+     * alternative to providing key and cert individually. PFX is usually
+     * encrypted, if it is, passphrase will be used to decrypt it. Multiple
+     * PFX can be provided either as an array of unencrypted PFX buffers,
+     * or an array of objects in the form `{buf: <string|buffer>[,passphrase: <string>]}`.
+     * The object form can only occur in an array.object.passphrase is optional.
+     * Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.
+     */
+    pfx?: string | Buffer | Array<string | Buffer | PxfObject> | undefined;
+}
+/**
+ * An interface compatible with NodeJS's `tls.KeyObject`.
+ * We want to avoid publicly re-exporting the actual interface,
+ * since it might vary across runtime versions.
+ */
+export interface KeyObject {
+    /**
+     * Private keys in PEM format.
+     */
+    pem: string | Buffer;
+    /**
+     * Optional passphrase.
+     */
+    passphrase?: string | undefined;
+}
+/**
+ * An interface compatible with NodeJS's `tls.PxfObject`.
+ * We want to avoid publicly re-exporting the actual interface,
+ * since it might vary across runtime versions.
+ */
+export interface PxfObject {
+    /**
+     * PFX or PKCS12 encoded private key and certificate chain.
+     */
+    buf: string | Buffer;
+    /**
+     * Optional passphrase.
+     */
+    passphrase?: string | undefined;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/esm/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACtC;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAC1D;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,cAAc,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,IAAI,EACA,CAAC,CAAC,MAAM,cAAc,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,GACpE,cAAc,CAAC,UAAU,CAAC,GAC1B,MAAM,CAAC,cAAc,GACrB,UAAU,GACV,IAAI,CAAC;CACV;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,QAAQ,EAAE,CAAC;IAElB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,CAAC,cAAc,GACrB,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,GAC7B,cAAc,CAAC,UAAU,CAAC,GAC1B,CAAC,MAAM,cAAc,CAAC,UAAU,CAAC,CAAC,GAClC,IAAI,GACJ,WAAW,GACX,eAAe,GACf,QAAQ,GACR,MAAM,GACN,IAAI,CAAC;AAET;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IAErB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;;OAGG;IACH,yBAAyB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAExC;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAE7D,mDAAmD;IACnD,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAE/D,oEAAoE;IACpE,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,kDAAkD;IAClD,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAElF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,OAAO,GACP,MAAM,GACN,SAAS,GACT,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,aAAa,EAAE,CAAA;CAAE,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;IAC1D;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5D;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAC9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;IAC1D;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5D;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAC9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;CACxE;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC"}

package/dist/esm/interfaces.js

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

package/dist/esm/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortSignalLike } from \"./abort-controller/AbortSignalLike.js\";\nimport { OperationTracingOptions } from \"./tracing/interfaces.js\";\n\n/**\n * A HttpHeaders collection represented as a simple JSON object.\n */\nexport type RawHttpHeaders = { [headerName: string]: string };\n\n/**\n * A HttpHeaders collection for input, represented as a simple JSON object.\n */\nexport type RawHttpHeadersInput = Record<string, string | number | boolean>;\n\n/**\n * Represents a set of HTTP headers on a request/response.\n * Header names are treated as case insensitive.\n */\nexport interface HttpHeaders extends Iterable<[string, string]> {\n  /**\n   * Returns the value of a specific header or undefined if not set.\n   * @param name - The name of the header to retrieve.\n   */\n  get(name: string): string | undefined;\n  /**\n   * Returns true if the specified header exists.\n   * @param name - The name of the header to check.\n   */\n  has(name: string): boolean;\n  /**\n   * Sets a specific header with a given value.\n   * @param name - The name of the header to set.\n   * @param value - The value to use for the header.\n   */\n  set(name: string, value: string | number | boolean): void;\n  /**\n   * Removes a specific header from the collection.\n   * @param name - The name of the header to delete.\n   */\n  delete(name: string): void;\n  /**\n   * Accesses a raw JS object that acts as a simple map\n   * of header names to values.\n   */\n  toJSON(options?: { preserveCase?: boolean }): RawHttpHeaders;\n}\n\n/**\n * A part of the request body in a multipart request.\n */\nexport interface BodyPart {\n  /**\n   * The headers for this part of the multipart request.\n   */\n  headers: HttpHeaders;\n\n  /**\n   * The body of this part of the multipart request.\n   */\n  body:\n    | ((() => ReadableStream<Uint8Array>) | (() => NodeJS.ReadableStream))\n    | ReadableStream<Uint8Array>\n    | NodeJS.ReadableStream\n    | Uint8Array\n    | Blob;\n}\n\n/**\n * A request body consisting of multiple parts.\n */\nexport interface MultipartRequestBody {\n  /**\n   * The parts of the request body.\n   */\n  parts: BodyPart[];\n\n  /**\n   * The boundary separating each part of the request body.\n   * If not specified, a random boundary will be generated.\n   *\n   * When specified, '--' will be prepended to the boundary in the request to ensure the boundary follows the specification.\n   */\n  boundary?: string;\n}\n\n/**\n * Types of bodies supported on the request.\n * NodeJS.ReadableStream and () =\\> NodeJS.ReadableStream is Node only.\n * Blob, ReadableStream<Uint8Array>, and () =\\> ReadableStream<Uint8Array> are browser only.\n */\nexport type RequestBodyType =\n  | NodeJS.ReadableStream\n  | (() => NodeJS.ReadableStream)\n  | ReadableStream<Uint8Array>\n  | (() => ReadableStream<Uint8Array>)\n  | Blob\n  | ArrayBuffer\n  | ArrayBufferView\n  | FormData\n  | string\n  | null;\n\n/**\n * An interface compatible with NodeJS's `http.Agent`.\n * We want to avoid publicly re-exporting the actual interface,\n * since it might vary across runtime versions.\n */\nexport interface Agent {\n  /**\n   * Destroy any sockets that are currently in use by the agent.\n   */\n  destroy(): void;\n  /**\n   * For agents with keepAlive enabled, this sets the maximum number of sockets that will be left open in the free state.\n   */\n  maxFreeSockets: number;\n  /**\n   * Determines how many concurrent sockets the agent can have open per origin.\n   */\n  maxSockets: number;\n  /**\n   * An object which contains queues of requests that have not yet been assigned to sockets.\n   */\n  requests: unknown;\n  /**\n   * An object which contains arrays of sockets currently in use by the agent.\n   */\n  sockets: unknown;\n}\n\n/**\n * Metadata about a request being made by the pipeline.\n */\nexport interface PipelineRequest {\n  /**\n   * The URL to make the request to.\n   */\n  url: string;\n\n  /**\n   * The HTTP method to use when making the request.\n   */\n  method: HttpMethods;\n\n  /**\n   * The HTTP headers to use when making the request.\n   */\n  headers: HttpHeaders;\n\n  /**\n   * The number of milliseconds a request can take before automatically being terminated.\n   * If the request is terminated, an `AbortError` is thrown.\n   * Defaults to 0, which disables the timeout.\n   */\n  timeout: number;\n\n  /**\n   * Indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests.\n   * Defaults to false.\n   */\n  withCredentials: boolean;\n\n  /**\n   * A unique identifier for the request. Used for logging and tracing.\n   */\n  requestId: string;\n\n  /**\n   * The HTTP body content (if any)\n   */\n  body?: RequestBodyType;\n\n  /**\n   * Body for a multipart request.\n   */\n  multipartBody?: MultipartRequestBody;\n\n  /**\n   * To simulate a browser form post\n   */\n  formData?: FormDataMap;\n\n  /**\n   * A list of response status codes whose corresponding PipelineResponse body should be treated as a stream.\n   * When streamResponseStatusCodes contains the value Number.POSITIVE_INFINITY any status would be treated as a stream.\n   */\n  streamResponseStatusCodes?: Set<number>;\n\n  /**\n   * Proxy configuration.\n   */\n  proxySettings?: ProxySettings;\n\n  /**\n   * If the connection should not be reused.\n   */\n  disableKeepAlive?: boolean;\n\n  /**\n   * Used to abort the request later.\n   */\n  abortSignal?: AbortSignalLike;\n\n  /**\n   * Tracing options to use for any created Spans.\n   */\n  tracingOptions?: OperationTracingOptions;\n\n  /**\n   * Callback which fires upon upload progress.\n   */\n  onUploadProgress?: (progress: TransferProgressEvent) => void;\n\n  /** Callback which fires upon download progress. */\n  onDownloadProgress?: (progress: TransferProgressEvent) => void;\n\n  /** Set to true if the request is sent over HTTP instead of HTTPS */\n  allowInsecureConnection?: boolean;\n\n  /**\n   * NODEJS ONLY\n   *\n   * A Node-only option to provide a custom `http.Agent`/`https.Agent`.\n   * Does nothing when running in the browser.\n   */\n  agent?: Agent;\n\n  /**\n   * BROWSER ONLY\n   *\n   * A browser only option to enable browser Streams. If this option is set and a response is a stream\n   * the response will have a property `browserStream` instead of `blobBody` which will be undefined.\n   *\n   * Default value is false\n   */\n  enableBrowserStreams?: boolean;\n\n  /** Settings for configuring TLS authentication */\n  tlsSettings?: TlsSettings;\n}\n\n/**\n * Metadata about a response received by the pipeline.\n */\nexport interface PipelineResponse {\n  /**\n   * The request that generated this response.\n   */\n  request: PipelineRequest;\n  /**\n   * The HTTP status code of the response.\n   */\n  status: number;\n  /**\n   * The HTTP response headers.\n   */\n  headers: HttpHeaders;\n\n  /**\n   * The response body as text (string format)\n   */\n  bodyAsText?: string | null;\n\n  /**\n   * BROWSER ONLY\n   *\n   * The response body as a browser Blob.\n   * Always undefined in node.js.\n   */\n  blobBody?: Promise<Blob>;\n\n  /**\n   * BROWSER ONLY\n   *\n   * The response body as a browser ReadableStream.\n   * Always undefined in node.js.\n   */\n  browserStreamBody?: ReadableStream<Uint8Array>;\n\n  /**\n   * NODEJS ONLY\n   *\n   * The response body as a node.js Readable stream.\n   * Always undefined in the browser.\n   */\n  readableStreamBody?: NodeJS.ReadableStream;\n}\n\n/**\n * A simple interface for making a pipeline request and receiving a response.\n */\nexport type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;\n\n/**\n * The required interface for a client that makes HTTP requests\n * on behalf of a pipeline.\n */\nexport interface HttpClient {\n  /**\n   * The method that makes the request and returns a response.\n   */\n  sendRequest: SendRequest;\n}\n\n/**\n * Fired in response to upload or download progress.\n */\nexport type TransferProgressEvent = {\n  /**\n   * The number of bytes loaded so far.\n   */\n  loadedBytes: number;\n};\n\n/**\n * Supported HTTP methods to use when making requests.\n */\nexport type HttpMethods =\n  | \"GET\"\n  | \"PUT\"\n  | \"POST\"\n  | \"DELETE\"\n  | \"PATCH\"\n  | \"HEAD\"\n  | \"OPTIONS\"\n  | \"TRACE\";\n\n/**\n * Options to configure a proxy for outgoing requests (Node.js only).\n */\nexport interface ProxySettings {\n  /**\n   * The proxy's host address.\n   */\n  host: string;\n\n  /**\n   * The proxy host's port.\n   */\n  port: number;\n\n  /**\n   * The user name to authenticate with the proxy, if required.\n   */\n  username?: string;\n\n  /**\n   * The password to authenticate with the proxy, if required.\n   */\n  password?: string;\n}\n\n/**\n * Each form data entry can be a string, Blob, or a File. If you wish to pass a file with a name but do not have\n * access to the File class, you can use the createFile helper to create one.\n */\nexport type FormDataValue = string | Blob | File;\n\n/**\n * A simple object that provides form data, as if from a browser form.\n */\nexport type FormDataMap = { [key: string]: FormDataValue | FormDataValue[] };\n\n/**\n * Options that control how to retry failed requests.\n */\nexport interface PipelineRetryOptions {\n  /**\n   * The maximum number of retry attempts. Defaults to 3.\n   */\n  maxRetries?: number;\n\n  /**\n   * The amount of delay in milliseconds between retry attempts. Defaults to 1000\n   * (1 second). The delay increases exponentially with each retry up to a maximum\n   * specified by maxRetryDelayInMs.\n   */\n  retryDelayInMs?: number;\n\n  /**\n   * The maximum delay in milliseconds allowed before retrying an operation. Defaults\n   * to 64000 (64 seconds).\n   */\n  maxRetryDelayInMs?: number;\n}\n\n/**\n * Represents a certificate credential for authentication.\n */\nexport interface CertificateCredential {\n  /**\n   * Optionally override the trusted CA certificates. Default is to trust\n   * the well-known CAs curated by Mozilla. Mozilla's CAs are completely\n   * replaced when CAs are explicitly specified using this option.\n   */\n  ca?: string | Buffer | Array<string | Buffer> | undefined;\n  /**\n   *  Cert chains in PEM format. One cert chain should be provided per\n   *  private key. Each cert chain should consist of the PEM formatted\n   *  certificate for a provided private key, followed by the PEM\n   *  formatted intermediate certificates (if any), in order, and not\n   *  including the root CA (the root CA must be pre-known to the peer,\n   *  see ca). When providing multiple cert chains, they do not have to\n   *  be in the same order as their private keys in key. If the\n   *  intermediate certificates are not provided, the peer will not be\n   *  able to validate the certificate, and the handshake will fail.\n   */\n  cert?: string | Buffer | Array<string | Buffer> | undefined;\n  /**\n   * Private keys in PEM format. PEM allows the option of private keys\n   * being encrypted. Encrypted keys will be decrypted with\n   * options.passphrase. Multiple keys using different algorithms can be\n   * provided either as an array of unencrypted key strings or buffers,\n   * or an array of objects in the form `{pem: <string|buffer>[,passphrase: <string>]}`.\n   * The object form can only occur in an array.object.passphrase is optional.\n   * Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.\n   */\n  key?: string | Buffer | Array<Buffer | KeyObject> | undefined;\n  /**\n   * Shared passphrase used for a single private key and/or a PFX.\n   */\n  passphrase?: string | undefined;\n  /**\n   * PFX or PKCS12 encoded private key and certificate chain. pfx is an\n   * alternative to providing key and cert individually. PFX is usually\n   * encrypted, if it is, passphrase will be used to decrypt it. Multiple\n   * PFX can be provided either as an array of unencrypted PFX buffers,\n   * or an array of objects in the form `{buf: <string|buffer>[,passphrase: <string>]}`.\n   * The object form can only occur in an array.object.passphrase is optional.\n   * Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.\n   */\n  pfx?: string | Buffer | Array<string | Buffer | PxfObject> | undefined;\n}\n\n/**\n * Represents a certificate for TLS authentication.\n */\nexport interface TlsSettings {\n  /**\n   * Optionally override the trusted CA certificates. Default is to trust\n   * the well-known CAs curated by Mozilla. Mozilla's CAs are completely\n   * replaced when CAs are explicitly specified using this option.\n   */\n  ca?: string | Buffer | Array<string | Buffer> | undefined;\n  /**\n   *  Cert chains in PEM format. One cert chain should be provided per\n   *  private key. Each cert chain should consist of the PEM formatted\n   *  certificate for a provided private key, followed by the PEM\n   *  formatted intermediate certificates (if any), in order, and not\n   *  including the root CA (the root CA must be pre-known to the peer,\n   *  see ca). When providing multiple cert chains, they do not have to\n   *  be in the same order as their private keys in key. If the\n   *  intermediate certificates are not provided, the peer will not be\n   *  able to validate the certificate, and the handshake will fail.\n   */\n  cert?: string | Buffer | Array<string | Buffer> | undefined;\n  /**\n   * Private keys in PEM format. PEM allows the option of private keys\n   * being encrypted. Encrypted keys will be decrypted with\n   * options.passphrase. Multiple keys using different algorithms can be\n   * provided either as an array of unencrypted key strings or buffers,\n   * or an array of objects in the form `{pem: <string|buffer>[,passphrase: <string>]}`.\n   * The object form can only occur in an array.object.passphrase is optional.\n   * Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.\n   */\n  key?: string | Buffer | Array<Buffer | KeyObject> | undefined;\n  /**\n   * Shared passphrase used for a single private key and/or a PFX.\n   */\n  passphrase?: string | undefined;\n  /**\n   * PFX or PKCS12 encoded private key and certificate chain. pfx is an\n   * alternative to providing key and cert individually. PFX is usually\n   * encrypted, if it is, passphrase will be used to decrypt it. Multiple\n   * PFX can be provided either as an array of unencrypted PFX buffers,\n   * or an array of objects in the form `{buf: <string|buffer>[,passphrase: <string>]}`.\n   * The object form can only occur in an array.object.passphrase is optional.\n   * Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.\n   */\n  pfx?: string | Buffer | Array<string | Buffer | PxfObject> | undefined;\n}\n\n/**\n * An interface compatible with NodeJS's `tls.KeyObject`.\n * We want to avoid publicly re-exporting the actual interface,\n * since it might vary across runtime versions.\n */\nexport interface KeyObject {\n  /**\n   * Private keys in PEM format.\n   */\n  pem: string | Buffer;\n  /**\n   * Optional passphrase.\n   */\n  passphrase?: string | undefined;\n}\n\n/**\n * An interface compatible with NodeJS's `tls.PxfObject`.\n * We want to avoid publicly re-exporting the actual interface,\n * since it might vary across runtime versions.\n */\nexport interface PxfObject {\n  /**\n   * PFX or PKCS12 encoded private key and certificate chain.\n   */\n  buf: string | Buffer;\n  /**\n   * Optional passphrase.\n   */\n  passphrase?: string | undefined;\n}\n"]}

package/dist/esm/log.d.ts

@@ -0,0 +1,2 @@
+export declare const logger: import("./logger/logger.js").TypeSpecRuntimeLogger;
+//# sourceMappingURL=log.d.ts.map

package/dist/esm/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/log.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM,oDAAwC,CAAC"}

package/dist/esm/log.js

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { createClientLogger } from "./logger/logger.js";
+export const logger = createClientLogger("ts-http-runtime");
+//# sourceMappingURL=log.js.map

package/dist/esm/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/log.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"./logger/logger.js\";\nexport const logger = createClientLogger(\"ts-http-runtime\");\n"]}

package/dist/esm/logger/debug.d.ts

@@ -0,0 +1,63 @@
+/**
+ * A simple mechanism for enabling logging.
+ * Intended to mimic the publicly available `debug` package.
+ */
+export interface Debug {
+    /**
+     * Creates a new logger with the given namespace.
+     */
+    (namespace: string): Debugger;
+    /**
+     * The default log method (defaults to console)
+     */
+    log: (...args: any[]) => void;
+    /**
+     * Enables a particular set of namespaces.
+     * To enable multiple separate them with commas, e.g. "info,debug".
+     * Supports wildcards, e.g. "typeSpecRuntime:*"
+     * Supports skip syntax, e.g. "typeSpecRuntime:*,-typeSpecRuntime:storage:*" will enable
+     * everything under typeSpecRuntime except for things under typeSpecRuntime:storage.
+     */
+    enable: (namespaces: string) => void;
+    /**
+     * Checks if a particular namespace is enabled.
+     */
+    enabled: (namespace: string) => boolean;
+    /**
+     * Disables all logging, returns what was previously enabled.
+     */
+    disable: () => string;
+}
+/**
+ * A log function that can be dynamically enabled and redirected.
+ */
+export interface Debugger {
+    /**
+     * Logs the given arguments to the `log` method.
+     */
+    (...args: any[]): void;
+    /**
+     * True if this logger is active and logging.
+     */
+    enabled: boolean;
+    /**
+     * Used to cleanup/remove this logger.
+     */
+    destroy: () => boolean;
+    /**
+     * The current log method. Can be overridden to redirect output.
+     */
+    log: (...args: any[]) => void;
+    /**
+     * The namespace of this logger.
+     */
+    namespace: string;
+    /**
+     * Extends this logger with a child namespace.
+     * Namespaces are separated with a ':' character.
+     */
+    extend: (namespace: string) => Debugger;
+}
+declare const debugObj: Debug;
+export default debugObj;
+//# sourceMappingURL=debug.d.ts.map

package/dist/esm/logger/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../../src/logger/debug.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC9B;;OAEG;IACH,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC9B;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC;;OAEG;IACH,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;IACxC;;OAEG;IACH,OAAO,EAAE,MAAM,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC;IACvB;;OAEG;IACH,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,QAAQ,CAAC;CACzC;AAcD,QAAA,MAAM,QAAQ,EAAE,KAUf,CAAC;AAmFF,eAAe,QAAQ,CAAC"}