@azure/cosmos 4.3.0 → 4.4.0

package/dist/commonjs/CosmosClientOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CosmosClientOptions.js.map

package/dist/commonjs/CosmosClientOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CosmosClientOptions.js","sourceRoot":"","sources":["../../src/CosmosClientOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { TokenProvider } from \"./auth.js\";\nimport type { PermissionDefinition } from \"./client/index.js\";\nimport type { ConnectionPolicy, ConsistencyLevel } from \"./documents/index.js\";\nimport type { PluginConfig } from \"./plugins/Plugin.js\";\nimport type { CosmosHeaders } from \"./queryExecutionContext/CosmosHeaders.js\";\nimport type { CosmosDbDiagnosticLevel } from \"./diagnostics/CosmosDbDiagnosticLevel.js\";\nimport type { HttpClient } from \"@azure/core-rest-pipeline\";\nimport type { ClientEncryptionOptions } from \"./encryption/ClientEncryptionOptions.js\";\n\n// We expose our own Agent interface to avoid taking a dependency on and leaking node types. This interface should mirror the node Agent interface\nexport interface Agent {\n  maxFreeSockets: number;\n  maxSockets: number;\n  sockets: any;\n  requests: any;\n  destroy(): void;\n}\n\nexport interface CosmosClientOptions {\n  /** The service endpoint to use to create the client. */\n  endpoint?: string;\n  /** The account master or readonly key */\n  key?: string;\n  /** An object that contains resources tokens.\n   * Keys for the object are resource Ids and values are the resource tokens.\n   */\n  resourceTokens?: { [resourcePath: string]: string };\n  /** A user supplied function for resolving header authorization tokens.\n   * Allows users to generating their own auth tokens, potentially using a separate service\n   */\n  tokenProvider?: TokenProvider;\n  /** AAD token from `@azure/identity`\n   * Obtain a credential object by creating an `@azure/identity` credential object\n   * We will then use your credential object and a scope URL (your cosmos db endpoint)\n   * to authenticate requests to Cosmos\n   */\n  aadCredentials?: TokenCredential;\n  /** An array of {@link Permission} objects. */\n  permissionFeed?: PermissionDefinition[];\n  /** An instance of {@link ConnectionPolicy} class.\n   * This parameter is optional and the default connectionPolicy will be used if omitted.\n   */\n  connectionPolicy?: ConnectionPolicy;\n  /** An optional parameter that represents the consistency level.\n   * It can take any value from {@link ConsistencyLevel}.\n   */\n  consistencyLevel?: keyof typeof ConsistencyLevel;\n  defaultHeaders?: CosmosHeaders;\n  /** An optional custom http(s) Agent to be used in NodeJS environments\n   * Use an agent such as https://github.com/TooTallNate/node-proxy-agent if you need to connect to Cosmos via a proxy\n   */\n  agent?: Agent;\n  /** An optional custom `HttpClient` shape to customize how requests are made by the HTTP pipeline.\n   * See `@azure/core-rest-pipeline` for details on how to implement this interface. */\n  httpClient?: HttpClient;\n  /** A custom string to append to the default SDK user agent. */\n  userAgentSuffix?: string;\n  diagnosticLevel?: CosmosDbDiagnosticLevel;\n  /** encryption policy for operations involving encryption\n   * must be set on the client if using client-side encryption\n   * @see {@link ClientEncryptionOptions}\n   */\n  clientEncryptionOptions?: ClientEncryptionOptions;\n  /** @internal */\n  plugins?: PluginConfig[];\n\n  /** An optional parameter to set throughput bucket number. This value can be overridden at request level\n   * For more information, visit [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).\n   */\n  throughputBucket?: number;\n\n  /** An optional parameter that represents the connection string. Your database connection string can be found in the Azure Portal. */\n  connectionString?: string;\n}\n"]}

package/dist/commonjs/CosmosDiagnostics.d.ts

@@ -0,0 +1,219 @@
+import type { OperationType, ResourceType } from "./common/index.js";
+import type { CosmosDbDiagnosticLevel } from "./diagnostics/CosmosDbDiagnosticLevel.js";
+import type { DiagnosticNodeInternal } from "./diagnostics/DiagnosticNodeInternal.js";
+import type { ConsistencyLevel } from "./documents/index.js";
+/**
+ *  * This is a Cosmos Diagnostic type that holds collected diagnostic information during a client operations. ie. Item.read(), Container.create().
+ * It has three members -
+ * 1. `clientSideRequestStatistics` member contains aggregate diagnostic information, including -
+ *   - metadata lookups. Here all the server requests, apart from the final intended resource are considered as metadata calls.
+ *    i.e. for item.read(id), if the client makes server call to discover endpoints it would be considered as metadata call.
+ *   - retries
+ *   - endpoints contacted.
+ *   - request, response payload stats.
+ *   - gatewayStatistics - Information corresponding to main operation. For example during Item.read(), the client might perform many operations
+ *    i.e. metadata lookup etc, but gatewayStatistics represents the diagnostics information for actual read operation.
+ *
+ * 2. diagnosticNode - Is a tree like structure which captures detailed diagnostic information. By default it is disabled, and is intended to be
+ * used only for debugging on non production environments. The kind of details captured in diagnosticNode is controlled by `CosmosDbDiagnosticLevel`.
+ * - CosmosDbDiagnosticLevel.info - Is default value. In this level only clientSideRequestStatistics are captured. Is is meant for production environments.
+ * - CosmosDbDiagnosticLevel.debug - Captures diagnosticNode and clientConfig. No request and response payloads are captured. Is not meant to be used
+ * in production environment.
+ * - CosmosDbDiagnosticLevel.debug-unsafe - In addition to data captured in CosmosDbDiagnosticLevel.debug, also captures request and response payloads.
+ * Is not meant to be used in production environment.
+ * 3. clientConfig - Captures information related to how client was configured during initialization.
+ */
+export declare class CosmosDiagnostics {
+    readonly clientSideRequestStatistics: ClientSideRequestStatistics;
+    readonly diagnosticNode: DiagnosticNode;
+    readonly clientConfig?: ClientConfigDiagnostic;
+}
+/**
+ * This type holds information related to initialization of `CosmosClient`
+ */
+export type ClientConfigDiagnostic = {
+    /**
+     * End point configured during client initialization.
+     */
+    endpoint: string;
+    /**
+     * True if `resourceTokens` was supplied during client initialization.
+     */
+    resourceTokensConfigured: boolean;
+    /**
+     * True if `tokenProvider` was supplied during client initialization.
+     */
+    tokenProviderConfigured: boolean;
+    /**
+     * True if `aadCredentials` was supplied during client initialization.
+     */
+    aadCredentialsConfigured: boolean;
+    /**
+     * True if `connectionPolicy` was supplied during client initialization.
+     */
+    connectionPolicyConfigured: boolean;
+    /**
+     * `consistencyLevel` supplied during client initialization.
+     */
+    consistencyLevel?: keyof typeof ConsistencyLevel;
+    /**
+     * `defaultHeaders` supplied during client initialization.
+     */
+    defaultHeaders?: {
+        [key: string]: any;
+    };
+    /**
+     * True if `connectionPolicy` were supplied during client initialization.
+     */
+    agentConfigured: boolean;
+    /**
+     * `userAgentSuffix` supplied during client initialization.
+     */
+    userAgentSuffix: string;
+    /**
+     * `diagnosticLevel` supplied during client initialization.
+     */
+    diagnosticLevel?: CosmosDbDiagnosticLevel;
+    /**
+     * True if `plugins` were supplied during client initialization.
+     */
+    pluginsConfigured: boolean;
+    /**
+     * SDK version
+     */
+    sDKVersion: string;
+};
+/**
+ * This type contains diagnostic information regarding all metadata request to server during an CosmosDB client operation.
+ */
+export type MetadataLookUpDiagnostics = {
+    metadataLookups: MetadataLookUpDiagnostic[];
+};
+/**
+ * This type captures diagnostic information regarding retries attempt during an CosmosDB client operation.
+ */
+export type RetryDiagnostics = {
+    failedAttempts: FailedRequestAttemptDiagnostic[];
+};
+export type GatewayStatistics = {
+    /**
+     * This is the activityId for request, made to server for fetching the requested resource. (As opposed to other potential meta data requests)
+     */
+    activityId?: string;
+    correlatedActivityId?: string;
+    startTimeUTCInMs: number;
+    durationInMs: number;
+    operationType?: OperationType;
+    resourceType?: ResourceType;
+    statusCode?: number;
+    subStatusCode?: number;
+    requestCharge?: number;
+    requestPayloadLengthInBytes: number;
+    responsePayloadLengthInBytes: number;
+};
+/**
+ * This type contains diagnostic information regarding a single metadata request to server.
+ */
+export interface MetadataLookUpDiagnostic {
+    activityId: string;
+    startTimeUTCInMs: number;
+    durationInMs: number;
+    operationType?: OperationType;
+    resourceType?: ResourceType;
+    metaDataType: MetadataLookUpType;
+    requestPayloadLengthInBytes: number;
+    responsePayloadLengthInBytes: number;
+}
+/**
+ * This type captures diagnostic information regarding a failed request to server api.
+ */
+export interface FailedRequestAttemptDiagnostic {
+    attemptNumber: number;
+    activityId: string;
+    startTimeUTCInMs: number;
+    durationInMs: number;
+    operationType?: OperationType;
+    resourceType?: ResourceType;
+    statusCode: number;
+    substatusCode?: number;
+    requestPayloadLengthInBytes: number;
+    responsePayloadLengthInBytes: number;
+}
+/**
+ * @hidden
+ * Represents the diagnostics information for encryption operations.
+ */
+export interface EncryptionDiagnostics {
+    /** shows start time, duration and properties count for encryption*/
+    encryptContent: Record<string, any>;
+    /** shows start time, duration and properties count for decryption*/
+    decryptContent: Record<string, any>;
+    /** represents total processing duration for encryption/decryption*/
+    processingDurationInMs: number;
+}
+/**
+ * This is enum for Type of Metadata lookups possible.
+ */
+export declare enum MetadataLookUpType {
+    PartitionKeyRangeLookUp = "PARTITION_KEY_RANGE_LOOK_UP",
+    DatabaseAccountLookUp = "DATABASE_ACCOUNT_LOOK_UP",
+    QueryPlanLookUp = "QUERY_PLAN_LOOK_UP",
+    DatabaseLookUp = "DATABASE_LOOK_UP",
+    ContainerLookUp = "CONTAINER_LOOK_UP"
+}
+/**
+ * This is a collection type for all client side diagnostic information.
+ */
+export type ClientSideRequestStatistics = {
+    /**
+     * This is the UTC timestamp for start of client operation.
+     */
+    requestStartTimeUTCInMs: number;
+    /**
+     * This is the duration in milli seconds taken by client operation.
+     */
+    requestDurationInMs: number;
+    /**
+     * This is the list of Location Endpoints contacted during the client operation.
+     */
+    locationEndpointsContacted: string[];
+    /**
+     * This field captures diagnostic information for retries happened during client operation.
+     */
+    retryDiagnostics: RetryDiagnostics;
+    /**
+     * This field captures diagnostic information for meta data lookups happened during client operation.
+     */
+    metadataDiagnostics: MetadataLookUpDiagnostics;
+    /**
+     * These are the statistics for main point look operation.
+     */
+    gatewayStatistics: GatewayStatistics[];
+    /**
+     * This is the cumulated Request Payload Length n bytes, this includes metadata calls along with the main operation.
+     */
+    totalRequestPayloadLengthInBytes: number;
+    /**
+     * This is the cumulated Response Payload Length n bytes, this includes metadata calls along with the main operation.
+     */
+    totalResponsePayloadLengthInBytes: number;
+    /**
+     * This field captures diagnostic information for encryption/decryption happened during CRUD operation if encryption is enabled.
+     */
+    encryptionDiagnostics?: EncryptionDiagnostics;
+};
+export declare function getRootNode(node: DiagnosticNodeInternal): DiagnosticNodeInternal;
+/**
+ * Represents a tree like structure, for capturing diagnostic information.
+ */
+export interface DiagnosticNode {
+    id: string;
+    nodeType: string;
+    children: DiagnosticNode[];
+    data: {
+        [key: string]: any;
+    };
+    startTimeUTCInMs: number;
+    durationInMs: number;
+}
+//# sourceMappingURL=CosmosDiagnostics.d.ts.map

package/dist/commonjs/CosmosDiagnostics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CosmosDiagnostics.d.ts","sourceRoot":"","sources":["../../src/CosmosDiagnostics.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,iBAAiB;IAC5B,SAAgB,2BAA2B,EAAE,2BAA2B,CAAC;IACzE,SAAgB,cAAc,EAAE,cAAc,CAAC;IAC/C,SAAgB,YAAY,CAAC,EAAE,sBAAsB,CAAC;CAavD;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,OAAO,gBAAgB,CAAC;IACjD;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACxC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAC1C;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,eAAe,EAAE,wBAAwB,EAAE,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,8BAA8B,EAAE,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2BAA2B,EAAE,MAAM,CAAC;IACpC,4BAA4B,EAAE,MAAM,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,YAAY,EAAE,kBAAkB,CAAC;IACjC,2BAA2B,EAAE,MAAM,CAAC;IACpC,4BAA4B,EAAE,MAAM,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2BAA2B,EAAE,MAAM,CAAC;IACpC,4BAA4B,EAAE,MAAM,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,oEAAoE;IACpE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,oEAAoE;IACpE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,oEAAoE;IACpE,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,uBAAuB,gCAAgC;IACvD,qBAAqB,6BAA6B;IAClD,eAAe,uBAAuB;IACtC,cAAc,qBAAqB;IACnC,eAAe,sBAAsB;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,0BAA0B,EAAE,MAAM,EAAE,CAAC;IACrC;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACH,mBAAmB,EAAE,yBAAyB,CAAC;IAC/C;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IACvC;;OAEG;IACH,gCAAgC,EAAE,MAAM,CAAC;IACzC;;OAEG;IACH,iCAAiC,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;CAC/C,CAAC;AAEF,wBAAgB,WAAW,CAAC,IAAI,EAAE,sBAAsB,GAAG,sBAAsB,CAGhF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/commonjs/CosmosDiagnostics.js

@@ -0,0 +1,56 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataLookUpType = exports.CosmosDiagnostics = void 0;
+exports.getRootNode = getRootNode;
+/**
+ *  * This is a Cosmos Diagnostic type that holds collected diagnostic information during a client operations. ie. Item.read(), Container.create().
+ * It has three members -
+ * 1. `clientSideRequestStatistics` member contains aggregate diagnostic information, including -
+ *   - metadata lookups. Here all the server requests, apart from the final intended resource are considered as metadata calls.
+ *    i.e. for item.read(id), if the client makes server call to discover endpoints it would be considered as metadata call.
+ *   - retries
+ *   - endpoints contacted.
+ *   - request, response payload stats.
+ *   - gatewayStatistics - Information corresponding to main operation. For example during Item.read(), the client might perform many operations
+ *    i.e. metadata lookup etc, but gatewayStatistics represents the diagnostics information for actual read operation.
+ *
+ * 2. diagnosticNode - Is a tree like structure which captures detailed diagnostic information. By default it is disabled, and is intended to be
+ * used only for debugging on non production environments. The kind of details captured in diagnosticNode is controlled by `CosmosDbDiagnosticLevel`.
+ * - CosmosDbDiagnosticLevel.info - Is default value. In this level only clientSideRequestStatistics are captured. Is is meant for production environments.
+ * - CosmosDbDiagnosticLevel.debug - Captures diagnosticNode and clientConfig. No request and response payloads are captured. Is not meant to be used
+ * in production environment.
+ * - CosmosDbDiagnosticLevel.debug-unsafe - In addition to data captured in CosmosDbDiagnosticLevel.debug, also captures request and response payloads.
+ * Is not meant to be used in production environment.
+ * 3. clientConfig - Captures information related to how client was configured during initialization.
+ */
+class CosmosDiagnostics {
+    /**
+     * @internal
+     */
+    constructor(clientSideRequestStatistics, diagnosticNode, clientConfig) {
+        this.clientSideRequestStatistics = clientSideRequestStatistics;
+        this.diagnosticNode = diagnosticNode;
+        this.clientConfig = clientConfig;
+    }
+}
+exports.CosmosDiagnostics = CosmosDiagnostics;
+/**
+ * This is enum for Type of Metadata lookups possible.
+ */
+var MetadataLookUpType;
+(function (MetadataLookUpType) {
+    MetadataLookUpType["PartitionKeyRangeLookUp"] = "PARTITION_KEY_RANGE_LOOK_UP";
+    MetadataLookUpType["DatabaseAccountLookUp"] = "DATABASE_ACCOUNT_LOOK_UP";
+    MetadataLookUpType["QueryPlanLookUp"] = "QUERY_PLAN_LOOK_UP";
+    MetadataLookUpType["DatabaseLookUp"] = "DATABASE_LOOK_UP";
+    MetadataLookUpType["ContainerLookUp"] = "CONTAINER_LOOK_UP";
+})(MetadataLookUpType || (exports.MetadataLookUpType = MetadataLookUpType = {}));
+function getRootNode(node) {
+    if (node.parent)
+        return getRootNode(node.parent);
+    else
+        return node;
+}
+//# sourceMappingURL=CosmosDiagnostics.js.map

package/dist/commonjs/CosmosDiagnostics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CosmosDiagnostics.js","sourceRoot":"","sources":["../../src/CosmosDiagnostics.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAuOlC,kCAGC;AAnOD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,iBAAiB;IAI5B;;OAEG;IACH,YACE,2BAAwD,EACxD,cAA+B,EAC/B,YAAqC;QAErC,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;CACF;AAhBD,8CAgBC;AAsID;;GAEG;AACH,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6EAAuD,CAAA;IACvD,wEAAkD,CAAA;IAClD,4DAAsC,CAAA;IACtC,yDAAmC,CAAA;IACnC,2DAAqC,CAAA;AACvC,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AA4CD,SAAgB,WAAW,CAAC,IAA4B;IACtD,IAAI,IAAI,CAAC,MAAM;QAAE,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;;QAC5C,OAAO,IAAI,CAAC;AACnB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OperationType, ResourceType } from \"./common/index.js\";\nimport type { CosmosDbDiagnosticLevel } from \"./diagnostics/CosmosDbDiagnosticLevel.js\";\nimport type { DiagnosticNodeInternal } from \"./diagnostics/DiagnosticNodeInternal.js\";\nimport type { ConsistencyLevel } from \"./documents/index.js\";\n\n/**\n *  * This is a Cosmos Diagnostic type that holds collected diagnostic information during a client operations. ie. Item.read(), Container.create().\n * It has three members -\n * 1. `clientSideRequestStatistics` member contains aggregate diagnostic information, including -\n *   - metadata lookups. Here all the server requests, apart from the final intended resource are considered as metadata calls.\n *    i.e. for item.read(id), if the client makes server call to discover endpoints it would be considered as metadata call.\n *   - retries\n *   - endpoints contacted.\n *   - request, response payload stats.\n *   - gatewayStatistics - Information corresponding to main operation. For example during Item.read(), the client might perform many operations\n *    i.e. metadata lookup etc, but gatewayStatistics represents the diagnostics information for actual read operation.\n *\n * 2. diagnosticNode - Is a tree like structure which captures detailed diagnostic information. By default it is disabled, and is intended to be\n * used only for debugging on non production environments. The kind of details captured in diagnosticNode is controlled by `CosmosDbDiagnosticLevel`.\n * - CosmosDbDiagnosticLevel.info - Is default value. In this level only clientSideRequestStatistics are captured. Is is meant for production environments.\n * - CosmosDbDiagnosticLevel.debug - Captures diagnosticNode and clientConfig. No request and response payloads are captured. Is not meant to be used\n * in production environment.\n * - CosmosDbDiagnosticLevel.debug-unsafe - In addition to data captured in CosmosDbDiagnosticLevel.debug, also captures request and response payloads.\n * Is not meant to be used in production environment.\n * 3. clientConfig - Captures information related to how client was configured during initialization.\n */\nexport class CosmosDiagnostics {\n  public readonly clientSideRequestStatistics: ClientSideRequestStatistics;\n  public readonly diagnosticNode: DiagnosticNode;\n  public readonly clientConfig?: ClientConfigDiagnostic;\n  /**\n   * @internal\n   */\n  constructor(\n    clientSideRequestStatistics: ClientSideRequestStatistics,\n    diagnosticNode?: DiagnosticNode,\n    clientConfig?: ClientConfigDiagnostic,\n  ) {\n    this.clientSideRequestStatistics = clientSideRequestStatistics;\n    this.diagnosticNode = diagnosticNode;\n    this.clientConfig = clientConfig;\n  }\n}\n\n/**\n * This type holds information related to initialization of `CosmosClient`\n */\nexport type ClientConfigDiagnostic = {\n  /**\n   * End point configured during client initialization.\n   */\n  endpoint: string;\n  /**\n   * True if `resourceTokens` was supplied during client initialization.\n   */\n  resourceTokensConfigured: boolean;\n  /**\n   * True if `tokenProvider` was supplied during client initialization.\n   */\n  tokenProviderConfigured: boolean;\n  /**\n   * True if `aadCredentials` was supplied during client initialization.\n   */\n  aadCredentialsConfigured: boolean;\n  /**\n   * True if `connectionPolicy` was supplied during client initialization.\n   */\n  connectionPolicyConfigured: boolean;\n  /**\n   * `consistencyLevel` supplied during client initialization.\n   */\n  consistencyLevel?: keyof typeof ConsistencyLevel;\n  /**\n   * `defaultHeaders` supplied during client initialization.\n   */\n  defaultHeaders?: { [key: string]: any };\n  /**\n   * True if `connectionPolicy` were supplied during client initialization.\n   */\n  agentConfigured: boolean;\n  /**\n   * `userAgentSuffix` supplied during client initialization.\n   */\n  userAgentSuffix: string;\n  /**\n   * `diagnosticLevel` supplied during client initialization.\n   */\n  diagnosticLevel?: CosmosDbDiagnosticLevel;\n  /**\n   * True if `plugins` were supplied during client initialization.\n   */\n  pluginsConfigured: boolean;\n  /**\n   * SDK version\n   */\n  sDKVersion: string;\n};\n\n/**\n * This type contains diagnostic information regarding all metadata request to server during an CosmosDB client operation.\n */\nexport type MetadataLookUpDiagnostics = {\n  metadataLookups: MetadataLookUpDiagnostic[];\n};\n\n/**\n * This type captures diagnostic information regarding retries attempt during an CosmosDB client operation.\n */\nexport type RetryDiagnostics = {\n  failedAttempts: FailedRequestAttemptDiagnostic[];\n};\n\nexport type GatewayStatistics = {\n  /**\n   * This is the activityId for request, made to server for fetching the requested resource. (As opposed to other potential meta data requests)\n   */\n  activityId?: string;\n  /*\n   * The correlated activity ID is added in the header of every request made to the backend for a query. This aids in troubleshooting by linking all\n   * requests associated with a particular query.\n   */\n  correlatedActivityId?: string;\n  startTimeUTCInMs: number;\n  durationInMs: number;\n  operationType?: OperationType;\n  resourceType?: ResourceType;\n  statusCode?: number;\n  subStatusCode?: number;\n  requestCharge?: number;\n  requestPayloadLengthInBytes: number;\n  responsePayloadLengthInBytes: number;\n};\n\n/**\n * This type contains diagnostic information regarding a single metadata request to server.\n */\nexport interface MetadataLookUpDiagnostic {\n  activityId: string;\n  startTimeUTCInMs: number;\n  durationInMs: number;\n  operationType?: OperationType;\n  resourceType?: ResourceType;\n  metaDataType: MetadataLookUpType;\n  requestPayloadLengthInBytes: number;\n  responsePayloadLengthInBytes: number;\n}\n\n/**\n * This type captures diagnostic information regarding a failed request to server api.\n */\nexport interface FailedRequestAttemptDiagnostic {\n  attemptNumber: number;\n  activityId: string;\n  startTimeUTCInMs: number;\n  durationInMs: number;\n  operationType?: OperationType;\n  resourceType?: ResourceType;\n  statusCode: number;\n  substatusCode?: number;\n  requestPayloadLengthInBytes: number;\n  responsePayloadLengthInBytes: number;\n}\n\n/**\n * @hidden\n * Represents the diagnostics information for encryption operations.\n */\nexport interface EncryptionDiagnostics {\n  /** shows start time, duration and properties count for encryption*/\n  encryptContent: Record<string, any>;\n  /** shows start time, duration and properties count for decryption*/\n  decryptContent: Record<string, any>;\n  /** represents total processing duration for encryption/decryption*/\n  processingDurationInMs: number;\n}\n\n/**\n * This is enum for Type of Metadata lookups possible.\n */\nexport enum MetadataLookUpType {\n  PartitionKeyRangeLookUp = \"PARTITION_KEY_RANGE_LOOK_UP\",\n  DatabaseAccountLookUp = \"DATABASE_ACCOUNT_LOOK_UP\",\n  QueryPlanLookUp = \"QUERY_PLAN_LOOK_UP\",\n  DatabaseLookUp = \"DATABASE_LOOK_UP\",\n  ContainerLookUp = \"CONTAINER_LOOK_UP\",\n}\n\n/**\n * This is a collection type for all client side diagnostic information.\n */\nexport type ClientSideRequestStatistics = {\n  /**\n   * This is the UTC timestamp for start of client operation.\n   */\n  requestStartTimeUTCInMs: number;\n  /**\n   * This is the duration in milli seconds taken by client operation.\n   */\n  requestDurationInMs: number;\n  /**\n   * This is the list of Location Endpoints contacted during the client operation.\n   */\n  locationEndpointsContacted: string[];\n  /**\n   * This field captures diagnostic information for retries happened during client operation.\n   */\n  retryDiagnostics: RetryDiagnostics;\n  /**\n   * This field captures diagnostic information for meta data lookups happened during client operation.\n   */\n  metadataDiagnostics: MetadataLookUpDiagnostics;\n  /**\n   * These are the statistics for main point look operation.\n   */\n  gatewayStatistics: GatewayStatistics[];\n  /**\n   * This is the cumulated Request Payload Length n bytes, this includes metadata calls along with the main operation.\n   */\n  totalRequestPayloadLengthInBytes: number;\n  /**\n   * This is the cumulated Response Payload Length n bytes, this includes metadata calls along with the main operation.\n   */\n  totalResponsePayloadLengthInBytes: number;\n  /**\n   * This field captures diagnostic information for encryption/decryption happened during CRUD operation if encryption is enabled.\n   */\n  encryptionDiagnostics?: EncryptionDiagnostics;\n};\n\nexport function getRootNode(node: DiagnosticNodeInternal): DiagnosticNodeInternal {\n  if (node.parent) return getRootNode(node.parent);\n  else return node;\n}\n\n/**\n * Represents a tree like structure, for capturing diagnostic information.\n */\nexport interface DiagnosticNode {\n  id: string;\n  nodeType: string;\n  children: DiagnosticNode[];\n  data: { [key: string]: any };\n  startTimeUTCInMs: number;\n  durationInMs: number;\n}\n"]}

package/dist/commonjs/auth.d.ts

@@ -0,0 +1,29 @@
+import type { HTTPMethod } from "./common/index.js";
+import { ResourceType } from "./common/index.js";
+import type { CosmosClientOptions } from "./CosmosClientOptions.js";
+import type { CosmosHeaders } from "./queryExecutionContext/index.js";
+/** @hidden */
+export interface RequestInfo {
+    verb: HTTPMethod;
+    path: string;
+    resourceId: string;
+    resourceType: ResourceType;
+    headers: CosmosHeaders;
+}
+export type TokenProvider = (requestInfo: RequestInfo) => Promise<string>;
+/**
+ * @hidden
+ */
+export declare function setAuthorizationHeader(clientOptions: CosmosClientOptions, verb: HTTPMethod, path: string, resourceId: string, resourceType: ResourceType, headers: CosmosHeaders): Promise<void>;
+/**
+ * The default function for setting header token using the masterKey
+ * @hidden
+ */
+export declare function setAuthorizationTokenHeaderUsingMasterKey(verb: HTTPMethod, resourceId: string, resourceType: ResourceType, headers: CosmosHeaders, masterKey: string): Promise<void>;
+/**
+ * @hidden
+ */
+export declare function getAuthorizationTokenUsingResourceTokens(resourceTokens: {
+    [resourceId: string]: string;
+}, path: string, resourceId: string): string;
+//# sourceMappingURL=auth.d.ts.map

package/dist/commonjs/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAGL,YAAY,EAEb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE1E;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,aAAa,EAAE,mBAAmB,EAClC,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED;;;GAGG;AACH,wBAAsB,yCAAyC,CAC7D,IAAI,EAAE,UAAU,EAChB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CASf;AAED;;GAEG;AAEH,wBAAgB,wCAAwC,CACtD,cAAc,EAAE;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAChD,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,MAAM,CA+CR"}

package/dist/commonjs/auth.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setAuthorizationHeader = setAuthorizationHeader;
+exports.setAuthorizationTokenHeaderUsingMasterKey = setAuthorizationTokenHeaderUsingMasterKey;
+exports.getAuthorizationTokenUsingResourceTokens = getAuthorizationTokenUsingResourceTokens;
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+const headers_js_1 = require("./utils/headers.js");
+const index_js_1 = require("./common/index.js");
+/**
+ * @hidden
+ */
+async function setAuthorizationHeader(clientOptions, verb, path, resourceId, resourceType, headers) {
+    if (clientOptions.permissionFeed) {
+        clientOptions.resourceTokens = {};
+        for (const permission of clientOptions.permissionFeed) {
+            const id = (0, index_js_1.getResourceIdFromPath)(permission.resource);
+            if (!id) {
+                throw new Error(`authorization error: ${id} \
+                          is an invalid resourceId in permissionFeed`);
+            }
+            clientOptions.resourceTokens[id] = permission._token; // TODO: any
+        }
+    }
+    if (clientOptions.key) {
+        await setAuthorizationTokenHeaderUsingMasterKey(verb, resourceId, resourceType, headers, clientOptions.key);
+    }
+    else if (clientOptions.resourceTokens) {
+        headers[index_js_1.Constants.HttpHeaders.Authorization] = encodeURIComponent(getAuthorizationTokenUsingResourceTokens(clientOptions.resourceTokens, path, resourceId));
+    }
+    else if (clientOptions.tokenProvider) {
+        headers[index_js_1.Constants.HttpHeaders.Authorization] = encodeURIComponent(await clientOptions.tokenProvider({ verb, path, resourceId, resourceType, headers }));
+    }
+}
+/**
+ * The default function for setting header token using the masterKey
+ * @hidden
+ */
+async function setAuthorizationTokenHeaderUsingMasterKey(verb, resourceId, resourceType, headers, masterKey) {
+    // TODO This should live in cosmos-sign
+    if (resourceType === index_js_1.ResourceType.offer) {
+        resourceId = resourceId && resourceId.toLowerCase();
+    }
+    headers = Object.assign(headers, await (0, headers_js_1.generateHeaders)(masterKey, verb, resourceType, resourceId));
+}
+/**
+ * @hidden
+ */
+// TODO: Resource tokens
+function getAuthorizationTokenUsingResourceTokens(resourceTokens, path, resourceId) {
+    if (resourceTokens && Object.keys(resourceTokens).length > 0) {
+        // For database account access(through getDatabaseAccount API), path and resourceId are "",
+        // so in this case we return the first token to be used for creating the auth header as the
+        // service will accept any token in this case
+        if (!path && !resourceId) {
+            return resourceTokens[Object.keys(resourceTokens)[0]];
+        }
+        // If we have exact resource token for the path use it
+        if (resourceId && resourceTokens[resourceId]) {
+            return resourceTokens[resourceId];
+        }
+        // minimum valid path /dbs
+        if (!path || path.length < 4) {
+            // TODO: This should throw an error
+            return null;
+        }
+        path = (0, index_js_1.trimSlashFromLeftAndRight)(path);
+        const pathSegments = (path && path.split("/")) || [];
+        // Item path
+        if (pathSegments.length === 6) {
+            // Look for a container token matching the item path
+            const containerPath = pathSegments.slice(0, 4).map(decodeURIComponent).join("/");
+            if (resourceTokens[containerPath]) {
+                return resourceTokens[containerPath];
+            }
+        }
+        // TODO remove in v4: This is legacy behavior that lets someone use a resource token pointing ONLY at an ID
+        // It was used when _rid was exposed by the SDK, but now that we are using user provided ids it is not needed
+        // However removing it now would be a breaking change
+        // if it's an incomplete path like /dbs/db1/colls/, start from the parent resource
+        let index = pathSegments.length % 2 === 0 ? pathSegments.length - 1 : pathSegments.length - 2;
+        for (; index > 0; index -= 2) {
+            const id = decodeURI(pathSegments[index]);
+            if (resourceTokens[id]) {
+                return resourceTokens[id];
+            }
+        }
+    }
+    // TODO: This should throw an error
+    return null;
+}
+//# sourceMappingURL=auth.js.map

package/dist/commonjs/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":";;AA2BA,wDAsCC;AAMD,8FAeC;AAMD,4FAmDC;AA/ID,uCAAuC;AACvC,kCAAkC;AAClC,mDAAqD;AAErD,gDAK2B;AAe3B;;GAEG;AACI,KAAK,UAAU,sBAAsB,CAC1C,aAAkC,EAClC,IAAgB,EAChB,IAAY,EACZ,UAAkB,EAClB,YAA0B,EAC1B,OAAsB;IAEtB,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC;QACjC,aAAa,CAAC,cAAc,GAAG,EAAE,CAAC;QAClC,KAAK,MAAM,UAAU,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC;YACtD,MAAM,EAAE,GAAG,IAAA,gCAAqB,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACtD,IAAI,CAAC,EAAE,EAAE,CAAC;gBACR,MAAM,IAAI,KAAK,CAAC,wBAAwB,EAAE;qEACmB,CAAC,CAAC;YACjE,CAAC;YAED,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC,GAAI,UAAkB,CAAC,MAAM,CAAC,CAAC,YAAY;QAC7E,CAAC;IACH,CAAC;IAED,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;QACtB,MAAM,yCAAyC,CAC7C,IAAI,EACJ,UAAU,EACV,YAAY,EACZ,OAAO,EACP,aAAa,CAAC,GAAG,CAClB,CAAC;IACJ,CAAC;SAAM,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC;QACxC,OAAO,CAAC,oBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,kBAAkB,CAC/D,wCAAwC,CAAC,aAAa,CAAC,cAAc,EAAE,IAAI,EAAE,UAAU,CAAC,CACzF,CAAC;IACJ,CAAC;SAAM,IAAI,aAAa,CAAC,aAAa,EAAE,CAAC;QACvC,OAAO,CAAC,oBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,kBAAkB,CAC/D,MAAM,aAAa,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CACrF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,yCAAyC,CAC7D,IAAgB,EAChB,UAAkB,EAClB,YAA0B,EAC1B,OAAsB,EACtB,SAAiB;IAEjB,uCAAuC;IACvC,IAAI,YAAY,KAAK,uBAAY,CAAC,KAAK,EAAE,CAAC;QACxC,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;IACtD,CAAC;IACD,OAAO,GAAG,MAAM,CAAC,MAAM,CACrB,OAAO,EACP,MAAM,IAAA,4BAAe,EAAC,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,CACjE,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,wBAAwB;AACxB,SAAgB,wCAAwC,CACtD,cAAgD,EAChD,IAAY,EACZ,UAAkB;IAElB,IAAI,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7D,2FAA2F;QAC3F,2FAA2F;QAC3F,6CAA6C;QAC7C,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACzB,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,sDAAsD;QACtD,IAAI,UAAU,IAAI,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7C,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;QAED,0BAA0B;QAC1B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,mCAAmC;YACnC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,GAAG,IAAA,oCAAyB,EAAC,IAAI,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAErD,YAAY;QACZ,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,oDAAoD;YACpD,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjF,IAAI,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;gBAClC,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAED,2GAA2G;QAC3G,6GAA6G;QAC7G,qDAAqD;QACrD,kFAAkF;QAClF,IAAI,KAAK,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9F,OAAO,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,EAAE,GAAG,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,IAAI,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC;gBACvB,OAAO,cAAc,CAAC,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IAED,mCAAmC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport { generateHeaders } from \"./utils/headers.js\";\nimport type { HTTPMethod } from \"./common/index.js\";\nimport {\n  Constants,\n  getResourceIdFromPath,\n  ResourceType,\n  trimSlashFromLeftAndRight,\n} from \"./common/index.js\";\nimport type { CosmosClientOptions } from \"./CosmosClientOptions.js\";\nimport type { CosmosHeaders } from \"./queryExecutionContext/index.js\";\n\n/** @hidden */\nexport interface RequestInfo {\n  verb: HTTPMethod;\n  path: string;\n  resourceId: string;\n  resourceType: ResourceType;\n  headers: CosmosHeaders;\n}\n\nexport type TokenProvider = (requestInfo: RequestInfo) => Promise<string>;\n\n/**\n * @hidden\n */\nexport async function setAuthorizationHeader(\n  clientOptions: CosmosClientOptions,\n  verb: HTTPMethod,\n  path: string,\n  resourceId: string,\n  resourceType: ResourceType,\n  headers: CosmosHeaders,\n): Promise<void> {\n  if (clientOptions.permissionFeed) {\n    clientOptions.resourceTokens = {};\n    for (const permission of clientOptions.permissionFeed) {\n      const id = getResourceIdFromPath(permission.resource);\n      if (!id) {\n        throw new Error(`authorization error: ${id} \\\n                          is an invalid resourceId in permissionFeed`);\n      }\n\n      clientOptions.resourceTokens[id] = (permission as any)._token; // TODO: any\n    }\n  }\n\n  if (clientOptions.key) {\n    await setAuthorizationTokenHeaderUsingMasterKey(\n      verb,\n      resourceId,\n      resourceType,\n      headers,\n      clientOptions.key,\n    );\n  } else if (clientOptions.resourceTokens) {\n    headers[Constants.HttpHeaders.Authorization] = encodeURIComponent(\n      getAuthorizationTokenUsingResourceTokens(clientOptions.resourceTokens, path, resourceId),\n    );\n  } else if (clientOptions.tokenProvider) {\n    headers[Constants.HttpHeaders.Authorization] = encodeURIComponent(\n      await clientOptions.tokenProvider({ verb, path, resourceId, resourceType, headers }),\n    );\n  }\n}\n\n/**\n * The default function for setting header token using the masterKey\n * @hidden\n */\nexport async function setAuthorizationTokenHeaderUsingMasterKey(\n  verb: HTTPMethod,\n  resourceId: string,\n  resourceType: ResourceType,\n  headers: CosmosHeaders,\n  masterKey: string,\n): Promise<void> {\n  // TODO This should live in cosmos-sign\n  if (resourceType === ResourceType.offer) {\n    resourceId = resourceId && resourceId.toLowerCase();\n  }\n  headers = Object.assign(\n    headers,\n    await generateHeaders(masterKey, verb, resourceType, resourceId),\n  );\n}\n\n/**\n * @hidden\n */\n// TODO: Resource tokens\nexport function getAuthorizationTokenUsingResourceTokens(\n  resourceTokens: { [resourceId: string]: string },\n  path: string,\n  resourceId: string,\n): string {\n  if (resourceTokens && Object.keys(resourceTokens).length > 0) {\n    // For database account access(through getDatabaseAccount API), path and resourceId are \"\",\n    // so in this case we return the first token to be used for creating the auth header as the\n    // service will accept any token in this case\n    if (!path && !resourceId) {\n      return resourceTokens[Object.keys(resourceTokens)[0]];\n    }\n\n    // If we have exact resource token for the path use it\n    if (resourceId && resourceTokens[resourceId]) {\n      return resourceTokens[resourceId];\n    }\n\n    // minimum valid path /dbs\n    if (!path || path.length < 4) {\n      // TODO: This should throw an error\n      return null;\n    }\n\n    path = trimSlashFromLeftAndRight(path);\n    const pathSegments = (path && path.split(\"/\")) || [];\n\n    // Item path\n    if (pathSegments.length === 6) {\n      // Look for a container token matching the item path\n      const containerPath = pathSegments.slice(0, 4).map(decodeURIComponent).join(\"/\");\n      if (resourceTokens[containerPath]) {\n        return resourceTokens[containerPath];\n      }\n    }\n\n    // TODO remove in v4: This is legacy behavior that lets someone use a resource token pointing ONLY at an ID\n    // It was used when _rid was exposed by the SDK, but now that we are using user provided ids it is not needed\n    // However removing it now would be a breaking change\n    // if it's an incomplete path like /dbs/db1/colls/, start from the parent resource\n    let index = pathSegments.length % 2 === 0 ? pathSegments.length - 1 : pathSegments.length - 2;\n    for (; index > 0; index -= 2) {\n      const id = decodeURI(pathSegments[index]);\n      if (resourceTokens[id]) {\n        return resourceTokens[id];\n      }\n    }\n  }\n\n  // TODO: This should throw an error\n  return null;\n}\n"]}

package/dist/commonjs/bulk/Batcher.d.ts

@@ -0,0 +1,41 @@
+import type { CosmosDbDiagnosticLevel } from "../diagnostics/CosmosDbDiagnosticLevel.js";
+import type { EncryptionProcessor } from "../encryption/EncryptionProcessor.js";
+import type { ClientConfigDiagnostic } from "../index.js";
+import type { ExecuteCallback, RetryCallback } from "../utils/batch.js";
+import type { PartitionMetric } from "./PartitionMetric.js";
+import type { ItemOperation } from "./index.js";
+import type { LimiterQueue } from "./Limiter.js";
+/**
+ * Maintains a batch of operations and dispatches it as a unit of work.
+ * Execution of the request is done by the @see {@link ExecuteCallback} and retry is done by the @see {@link RetryCallback}.
+ * @hidden
+ */
+export declare class Batcher {
+    private batchOperationsList;
+    private currentSize;
+    private toBeDispatched;
+    private readonly executor;
+    private readonly retrier;
+    private readonly diagnosticLevel;
+    private readonly encryptionEnabled;
+    private readonly encryptionProcessor;
+    private readonly clientConfigDiagnostics;
+    private readonly limiter;
+    private processedOperationCountRef;
+    constructor(limiter: LimiterQueue, executor: ExecuteCallback, retrier: RetryCallback, diagnosticLevel: CosmosDbDiagnosticLevel, encryptionEnabled: boolean, clientConfig: ClientConfigDiagnostic, encryptionProcessor: EncryptionProcessor, processedOperationCountRef: {
+        count: number;
+    });
+    /**
+     * Attempts to add an operation to the current batch.
+     * Returns false if the batch is full or already dispatched.
+     */
+    tryAdd(operation: ItemOperation): boolean;
+    isEmpty(): boolean;
+    /**
+     * Dispatches the current batch of operations.
+     * Handles retries for failed operations and updates the ordered response.
+     */
+    dispatch(partitionMetric: PartitionMetric): Promise<void>;
+    getOperations(): ItemOperation[];
+}
+//# sourceMappingURL=Batcher.d.ts.map

package/dist/commonjs/bulk/Batcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Batcher.d.ts","sourceRoot":"","sources":["../../../src/bulk/Batcher.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAKzF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAuB,MAAM,mBAAmB,CAAC;AAG7F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;;;GAIG;AAEH,qBAAa,OAAO;IAClB,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAC5C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAsB;IAC1D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAyB;IACjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,0BAA0B,CAAoB;gBAGpD,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,eAAe,EACzB,OAAO,EAAE,aAAa,EACtB,eAAe,EAAE,uBAAuB,EACxC,iBAAiB,EAAE,OAAO,EAC1B,YAAY,EAAE,sBAAsB,EACpC,mBAAmB,EAAE,mBAAmB,EACxC,0BAA0B,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE;IAe/C;;;OAGG;IACI,MAAM,CAAC,SAAS,EAAE,aAAa,GAAG,OAAO;IA0BzC,OAAO,IAAI,OAAO;IAIzB;;;OAGG;IACU,QAAQ,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAuG/D,aAAa,IAAI,aAAa,EAAE;CAGxC"}