@azure/cosmos 4.8.0 → 4.9.0

package/dist/browser/queryExecutionContext/PartitionRangeUtils.js

@@ -0,0 +1,105 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Calculates offset/limit values after consuming each partition range sequentially
+ * @param partitionKeyRangeMap - Map of range IDs to range mappings
+ * @param initialOffset - Initial offset value
+ * @param initialLimit - Initial limit value
+ * @returns Updated partition key range map with calculated offset/limit values and updated itemCount
+ * @hidden
+ */
+export function calculateOffsetLimitForPartitionRanges(partitionKeyRangeMap, initialOffset, initialLimit) {
+    if (!partitionKeyRangeMap || partitionKeyRangeMap.size === 0) {
+        return partitionKeyRangeMap;
+    }
+    const updatedMap = new Map();
+    let currentOffset = initialOffset;
+    let currentLimit = initialLimit;
+    for (const [rangeId, rangeMapping] of partitionKeyRangeMap) {
+        const { itemCount } = rangeMapping;
+        let offsetAfterThisRange = currentOffset;
+        let limitAfterThisRange = currentLimit;
+        let updatedItemCount = itemCount;
+        if (itemCount > 0) {
+            if (currentOffset > 0) {
+                // Calculate how much offset this range consumes
+                const offsetConsumption = Math.min(currentOffset, itemCount);
+                offsetAfterThisRange = currentOffset - offsetConsumption;
+                // Calculate remaining items after offset consumption
+                const remainingItems = itemCount - offsetConsumption;
+                if (remainingItems > 0 && currentLimit > 0) {
+                    // Apply limit to remaining items
+                    const limitConsumption = Math.min(currentLimit, remainingItems);
+                    limitAfterThisRange = currentLimit - limitConsumption;
+                    // Update item count to reflect actual items that will be returned from this range
+                    updatedItemCount = limitConsumption;
+                }
+                else {
+                    // No items left after offset, or no limit remaining
+                    updatedItemCount = 0;
+                    limitAfterThisRange = currentLimit;
+                }
+            }
+            else if (currentLimit > 0) {
+                // No offset, but limit applies
+                const limitConsumption = Math.min(currentLimit, itemCount);
+                limitAfterThisRange = currentLimit - limitConsumption;
+                offsetAfterThisRange = 0;
+                // Update item count to reflect actual items that will be returned from this range
+                updatedItemCount = limitConsumption;
+            }
+            else {
+                // No limit remaining - this range contributes 0 items
+                updatedItemCount = 0;
+            }
+            // Update running totals for next iteration
+            currentOffset = offsetAfterThisRange;
+            currentLimit = limitAfterThisRange;
+        }
+        else {
+            // Range has no items to begin with
+            updatedItemCount = 0;
+        }
+        updatedMap.set(rangeId, {
+            ...rangeMapping,
+            offset: offsetAfterThisRange,
+            limit: limitAfterThisRange,
+            itemCount: updatedItemCount,
+        });
+    }
+    return updatedMap;
+}
+/**
+ * Processes distinct query logic and updates partition key range map with hashedLastResult
+ * @param originalBuffer - Original buffer containing query results
+ * @param partitionKeyRangeMap - Map of partition key ranges
+ * @param hashFunction - Hash function for items
+ * @returns Updated partition key range map with hashedLastResult for each range
+ * @hidden
+ */
+export async function processDistinctQueryAndUpdateRangeMap(originalBuffer, partitionKeyRangeMap, hashFunction) {
+    if (!partitionKeyRangeMap || partitionKeyRangeMap.size === 0) {
+        return partitionKeyRangeMap;
+    }
+    const updatedMap = new Map();
+    let bufferIndex = 0;
+    for (const [rangeId, rangeMapping] of partitionKeyRangeMap) {
+        const { itemCount } = rangeMapping;
+        let lastHashForThisRange;
+        if (itemCount > 0 && bufferIndex <= originalBuffer.length) {
+            const rangeEndIndex = Math.min(bufferIndex + itemCount, originalBuffer.length);
+            const lastItemIndex = rangeEndIndex - 1;
+            const lastItem = originalBuffer[lastItemIndex];
+            if (lastItem) {
+                lastHashForThisRange = await hashFunction(lastItem);
+            }
+            bufferIndex = rangeEndIndex;
+        }
+        updatedMap.set(rangeId, {
+            ...rangeMapping,
+            hashedLastResult: lastHashForThisRange,
+        });
+    }
+    return updatedMap;
+}
+//# sourceMappingURL=PartitionRangeUtils.js.map

package/dist/browser/queryExecutionContext/PartitionRangeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PartitionRangeUtils.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/PartitionRangeUtils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;GAOG;AACH,MAAM,UAAU,sCAAsC,CACpD,oBAAsC,EACtC,aAAqB,EACrB,YAAoB;IAEpB,IAAI,CAAC,oBAAoB,IAAI,oBAAoB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC7D,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAe,CAAC;IAC1C,IAAI,aAAa,GAAG,aAAa,CAAC;IAClC,IAAI,YAAY,GAAG,YAAY,CAAC;IAEhC,KAAK,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,oBAAoB,EAAE,CAAC;QAC3D,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC;QAEnC,IAAI,oBAAoB,GAAG,aAAa,CAAC;QACzC,IAAI,mBAAmB,GAAG,YAAY,CAAC;QACvC,IAAI,gBAAgB,GAAG,SAAS,CAAC;QAEjC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACtB,gDAAgD;gBAChD,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;gBAC7D,oBAAoB,GAAG,aAAa,GAAG,iBAAiB,CAAC;gBAEzD,qDAAqD;gBACrD,MAAM,cAAc,GAAG,SAAS,GAAG,iBAAiB,CAAC;gBAErD,IAAI,cAAc,GAAG,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;oBAC3C,iCAAiC;oBACjC,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;oBAChE,mBAAmB,GAAG,YAAY,GAAG,gBAAgB,CAAC;oBACtD,kFAAkF;oBAClF,gBAAgB,GAAG,gBAAgB,CAAC;gBACtC,CAAC;qBAAM,CAAC;oBACN,oDAAoD;oBACpD,gBAAgB,GAAG,CAAC,CAAC;oBACrB,mBAAmB,GAAG,YAAY,CAAC;gBACrC,CAAC;YACH,CAAC;iBAAM,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;gBAC5B,+BAA+B;gBAC/B,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;gBAC3D,mBAAmB,GAAG,YAAY,GAAG,gBAAgB,CAAC;gBACtD,oBAAoB,GAAG,CAAC,CAAC;gBACzB,kFAAkF;gBAClF,gBAAgB,GAAG,gBAAgB,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,sDAAsD;gBACtD,gBAAgB,GAAG,CAAC,CAAC;YACvB,CAAC;YAED,2CAA2C;YAC3C,aAAa,GAAG,oBAAoB,CAAC;YACrC,YAAY,GAAG,mBAAmB,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,mCAAmC;YACnC,gBAAgB,GAAG,CAAC,CAAC;QACvB,CAAC;QAED,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE;YACtB,GAAG,YAAY;YACf,MAAM,EAAE,oBAAoB;YAC5B,KAAK,EAAE,mBAAmB;YAC1B,SAAS,EAAE,gBAAgB;SAC5B,CAAC,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qCAAqC,CACzD,cAAqB,EACrB,oBAAsC,EACtC,YAA4C;IAE5C,IAAI,CAAC,oBAAoB,IAAI,oBAAoB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC7D,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAe,CAAC;IAC1C,IAAI,WAAW,GAAG,CAAC,CAAC;IAEpB,KAAK,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,oBAAoB,EAAE,CAAC;QAC3D,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC;QAEnC,IAAI,oBAAwC,CAAC;QAC7C,IAAI,SAAS,GAAG,CAAC,IAAI,WAAW,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;YAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;YAC/E,MAAM,aAAa,GAAG,aAAa,GAAG,CAAC,CAAC;YAExC,MAAM,QAAQ,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;YAC/C,IAAI,QAAQ,EAAE,CAAC;gBACb,oBAAoB,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;YACD,WAAW,GAAG,aAAa,CAAC;QAC9B,CAAC;QAED,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE;YACtB,GAAG,YAAY;YACf,gBAAgB,EAAE,oBAAoB;SACvC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Calculates offset/limit values after consuming each partition range sequentially\n * @param partitionKeyRangeMap - Map of range IDs to range mappings\n * @param initialOffset - Initial offset value\n * @param initialLimit - Initial limit value\n * @returns Updated partition key range map with calculated offset/limit values and updated itemCount\n * @hidden\n */\nexport function calculateOffsetLimitForPartitionRanges(\n  partitionKeyRangeMap: Map<string, any>,\n  initialOffset: number,\n  initialLimit: number,\n): Map<string, any> {\n  if (!partitionKeyRangeMap || partitionKeyRangeMap.size === 0) {\n    return partitionKeyRangeMap;\n  }\n\n  const updatedMap = new Map<string, any>();\n  let currentOffset = initialOffset;\n  let currentLimit = initialLimit;\n\n  for (const [rangeId, rangeMapping] of partitionKeyRangeMap) {\n    const { itemCount } = rangeMapping;\n\n    let offsetAfterThisRange = currentOffset;\n    let limitAfterThisRange = currentLimit;\n    let updatedItemCount = itemCount;\n\n    if (itemCount > 0) {\n      if (currentOffset > 0) {\n        // Calculate how much offset this range consumes\n        const offsetConsumption = Math.min(currentOffset, itemCount);\n        offsetAfterThisRange = currentOffset - offsetConsumption;\n\n        // Calculate remaining items after offset consumption\n        const remainingItems = itemCount - offsetConsumption;\n\n        if (remainingItems > 0 && currentLimit > 0) {\n          // Apply limit to remaining items\n          const limitConsumption = Math.min(currentLimit, remainingItems);\n          limitAfterThisRange = currentLimit - limitConsumption;\n          // Update item count to reflect actual items that will be returned from this range\n          updatedItemCount = limitConsumption;\n        } else {\n          // No items left after offset, or no limit remaining\n          updatedItemCount = 0;\n          limitAfterThisRange = currentLimit;\n        }\n      } else if (currentLimit > 0) {\n        // No offset, but limit applies\n        const limitConsumption = Math.min(currentLimit, itemCount);\n        limitAfterThisRange = currentLimit - limitConsumption;\n        offsetAfterThisRange = 0;\n        // Update item count to reflect actual items that will be returned from this range\n        updatedItemCount = limitConsumption;\n      } else {\n        // No limit remaining - this range contributes 0 items\n        updatedItemCount = 0;\n      }\n\n      // Update running totals for next iteration\n      currentOffset = offsetAfterThisRange;\n      currentLimit = limitAfterThisRange;\n    } else {\n      // Range has no items to begin with\n      updatedItemCount = 0;\n    }\n\n    updatedMap.set(rangeId, {\n      ...rangeMapping,\n      offset: offsetAfterThisRange,\n      limit: limitAfterThisRange,\n      itemCount: updatedItemCount,\n    });\n  }\n\n  return updatedMap;\n}\n\n/**\n * Processes distinct query logic and updates partition key range map with hashedLastResult\n * @param originalBuffer - Original buffer containing query results\n * @param partitionKeyRangeMap - Map of partition key ranges\n * @param hashFunction - Hash function for items\n * @returns Updated partition key range map with hashedLastResult for each range\n * @hidden\n */\nexport async function processDistinctQueryAndUpdateRangeMap(\n  originalBuffer: any[],\n  partitionKeyRangeMap: Map<string, any>,\n  hashFunction: (item: any) => Promise<string>,\n): Promise<Map<string, any>> {\n  if (!partitionKeyRangeMap || partitionKeyRangeMap.size === 0) {\n    return partitionKeyRangeMap;\n  }\n\n  const updatedMap = new Map<string, any>();\n  let bufferIndex = 0;\n\n  for (const [rangeId, rangeMapping] of partitionKeyRangeMap) {\n    const { itemCount } = rangeMapping;\n\n    let lastHashForThisRange: string | undefined;\n    if (itemCount > 0 && bufferIndex <= originalBuffer.length) {\n      const rangeEndIndex = Math.min(bufferIndex + itemCount, originalBuffer.length);\n      const lastItemIndex = rangeEndIndex - 1;\n\n      const lastItem = originalBuffer[lastItemIndex];\n      if (lastItem) {\n        lastHashForThisRange = await hashFunction(lastItem);\n      }\n      bufferIndex = rangeEndIndex;\n    }\n\n    updatedMap.set(rangeId, {\n      ...rangeMapping,\n      hashedLastResult: lastHashForThisRange,\n    });\n  }\n\n  return updatedMap;\n}\n"]}

package/dist/browser/queryExecutionContext/QueryControlFetchImplementation.d.ts

@@ -0,0 +1,20 @@
+import type { Response } from "../request/index.js";
+import type { DiagnosticNodeInternal } from "../diagnostics/DiagnosticNodeInternal.js";
+import type { ExecutionContext } from "./ExecutionContext.js";
+/**
+ * Query control enabled fetch implementation with continuation token support
+ * @hidden
+ */
+export declare class QueryControlFetchImplementation {
+    private endpoint;
+    private pageSize;
+    private readonly continuationTokenManager;
+    private readonly querySupportsTokens;
+    constructor(endpoint: ExecutionContext, pageSize: number, collectionLink: string, continuationToken: string | undefined, isOrderByQuery: boolean, querySupportsTokens: boolean);
+    fetchMore(diagnosticNode: DiagnosticNodeInternal, fetchBuffer: any[]): Promise<Response<any>>;
+    private _handleSimpleBufferFetch;
+    private _handleQueryFetch;
+    private _setContinuationTokenInHeaders;
+    private _createEmptyResult;
+}
+//# sourceMappingURL=QueryControlFetchImplementation.d.ts.map

package/dist/browser/queryExecutionContext/QueryControlFetchImplementation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryControlFetchImplementation.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/QueryControlFetchImplementation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAKvF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;;GAGG;AACH,qBAAa,+BAA+B;IAMxC,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,QAAQ;IALlB,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA+B;IACxE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;gBAGpC,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,EACtB,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,cAAc,EAAE,OAAO,EACvB,mBAAmB,EAAE,OAAO;IAYxB,SAAS,CACb,cAAc,EAAE,sBAAsB,EACtC,WAAW,EAAE,GAAG,EAAE,GACjB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAaX,wBAAwB;YA6BxB,iBAAiB;IA8C/B,OAAO,CAAC,8BAA8B;IAWtC,OAAO,CAAC,kBAAkB;CAI3B"}

package/dist/browser/queryExecutionContext/QueryControlFetchImplementation.js

@@ -0,0 +1,93 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { mergeHeaders, getInitialHeader } from "./headerUtils.js";
+import { ContinuationTokenManagerFactory } from "./ContinuationTokenManager/ContinuationTokenManagerFactory.js";
+import { Constants } from "../common/index.js";
+/**
+ * Query control enabled fetch implementation with continuation token support
+ * @hidden
+ */
+export class QueryControlFetchImplementation {
+    endpoint;
+    pageSize;
+    // Required fields for query control - not optional
+    continuationTokenManager;
+    querySupportsTokens;
+    constructor(endpoint, pageSize, collectionLink, continuationToken, isOrderByQuery, querySupportsTokens) {
+        this.endpoint = endpoint;
+        this.pageSize = pageSize;
+        this.querySupportsTokens = querySupportsTokens;
+        // Initialize continuation token manager immediately for query control
+        this.continuationTokenManager = ContinuationTokenManagerFactory.create(collectionLink, continuationToken, isOrderByQuery);
+    }
+    async fetchMore(diagnosticNode, fetchBuffer) {
+        // Initialize headers fresh for each fetchMore call
+        const fetchMoreRespHeaders = getInitialHeader();
+        // Use continuation token logic for supported queries when query control is enabled
+        // Otherwise use simplified buffer-only logic
+        if (this.querySupportsTokens) {
+            return this._handleQueryFetch(diagnosticNode, fetchBuffer, fetchMoreRespHeaders);
+        }
+        else {
+            return this._handleSimpleBufferFetch(diagnosticNode, fetchBuffer, fetchMoreRespHeaders);
+        }
+    }
+    async _handleSimpleBufferFetch(diagnosticNode, fetchBuffer, fetchMoreRespHeaders) {
+        // Return buffered data if available
+        if (fetchBuffer.length > 0) {
+            const temp = fetchBuffer.slice(0, this.pageSize);
+            fetchBuffer.splice(0, this.pageSize); // Remove items in place
+            return { result: temp, headers: fetchMoreRespHeaders };
+        }
+        // Fetch new data from endpoint
+        const response = await this.endpoint.fetchMore(diagnosticNode);
+        mergeHeaders(fetchMoreRespHeaders, response.headers);
+        if (!response?.result?.buffer?.length) {
+            return this._createEmptyResult(response?.headers);
+        }
+        // Buffer new data and return up to pageSize
+        fetchBuffer.length = 0; // Clear existing items
+        fetchBuffer.push(...response.result.buffer); // Add new items
+        const temp = fetchBuffer.slice(0, this.pageSize);
+        fetchBuffer.splice(0, this.pageSize); // Remove returned items in place
+        return { result: temp, headers: fetchMoreRespHeaders };
+    }
+    async _handleQueryFetch(diagnosticNode, fetchBuffer, fetchMoreRespHeaders) {
+        if (fetchBuffer.length > 0) {
+            const { endIndex, continuationToken } = this.continuationTokenManager.paginateResults(this.pageSize, false);
+            const temp = fetchBuffer.slice(0, endIndex);
+            fetchBuffer.splice(0, endIndex); // Remove returned items in place
+            this._setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders);
+            return { result: temp, headers: fetchMoreRespHeaders };
+        }
+        // Fetch new data from endpoint
+        fetchBuffer.length = 0; // Clear existing items in place
+        const response = await this.endpoint.fetchMore(diagnosticNode);
+        mergeHeaders(fetchMoreRespHeaders, response.headers);
+        if (!response?.result?.buffer || response.result.buffer.length === 0) {
+            const { continuationToken } = this.continuationTokenManager.paginateResults(this.pageSize, true, // isResponseEmpty = true
+            response?.result);
+            this._setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders);
+            return this._createEmptyResult(fetchMoreRespHeaders);
+        }
+        fetchBuffer.push(...response.result.buffer); // Add new items to existing buffer
+        const { endIndex, continuationToken } = this.continuationTokenManager.paginateResults(this.pageSize, false, // isResponseEmpty = false
+        response.result);
+        const temp = fetchBuffer.slice(0, endIndex);
+        fetchBuffer.splice(0, endIndex); // Remove returned items in place
+        this._setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders);
+        return { result: temp, headers: fetchMoreRespHeaders };
+    }
+    _setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders) {
+        if (continuationToken) {
+            Object.assign(fetchMoreRespHeaders, {
+                [Constants.HttpHeaders.Continuation]: continuationToken,
+            });
+        }
+    }
+    _createEmptyResult(headers) {
+        const hdrs = headers || getInitialHeader();
+        return { result: [], headers: hdrs };
+    }
+}
+//# sourceMappingURL=QueryControlFetchImplementation.js.map

package/dist/browser/queryExecutionContext/QueryControlFetchImplementation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryControlFetchImplementation.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/QueryControlFetchImplementation.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAElE,OAAO,EAAE,+BAA+B,EAAE,MAAM,+DAA+D,CAAC;AAChH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAG/C;;;GAGG;AACH,MAAM,OAAO,+BAA+B;IAMhC;IACA;IANV,mDAAmD;IAClC,wBAAwB,CAA+B;IACvD,mBAAmB,CAAU;IAE9C,YACU,QAA0B,EAC1B,QAAgB,EACxB,cAAsB,EACtB,iBAAqC,EACrC,cAAuB,EACvB,mBAA4B;QALpB,aAAQ,GAAR,QAAQ,CAAkB;QAC1B,aAAQ,GAAR,QAAQ,CAAQ;QAMxB,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAE/C,sEAAsE;QACtE,IAAI,CAAC,wBAAwB,GAAG,+BAA+B,CAAC,MAAM,CACpE,cAAc,EACd,iBAAiB,EACjB,cAAc,CACf,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CACb,cAAsC,EACtC,WAAkB;QAElB,mDAAmD;QACnD,MAAM,oBAAoB,GAAG,gBAAgB,EAAE,CAAC;QAEhD,mFAAmF;QACnF,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,WAAW,EAAE,oBAAoB,CAAC,CAAC;QACnF,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,WAAW,EAAE,oBAAoB,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,cAAsC,EACtC,WAAkB,EAClB,oBAAyC;QAEzC,oCAAoC;QACpC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjD,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wBAAwB;YAC9D,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;QACzD,CAAC;QAED,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAU,CAAC,cAAc,CAAC,CAAC;QAChE,YAAY,CAAC,oBAAoB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QAErD,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;QAED,4CAA4C;QAC5C,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,uBAAuB;QAC/C,WAAW,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB;QAC7D,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjD,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iCAAiC;QAEvE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IACzD,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,cAAsC,EACtC,WAAkB,EAClB,oBAAyC;QAEzC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,eAAe,CACnF,IAAI,CAAC,QAAQ,EACb,KAAK,CACN,CAAC;YACF,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC5C,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,iCAAiC;YAClE,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;YAE7E,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;QACzD,CAAC;QAED,+BAA+B;QAC/B,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,gCAAgC;QACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAU,CAAC,cAAc,CAAC,CAAC;QAChE,YAAY,CAAC,oBAAoB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QAErD,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,eAAe,CACzE,IAAI,CAAC,QAAQ,EACb,IAAI,EAAE,yBAAyB;YAC/B,QAAQ,EAAE,MAAM,CACjB,CAAC;YACF,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;YAC7E,OAAO,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;QACvD,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,mCAAmC;QAChF,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,eAAe,CACnF,IAAI,CAAC,QAAQ,EACb,KAAK,EAAE,0BAA0B;QACjC,QAAQ,CAAC,MAAM,CAChB,CAAC;QAEF,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC5C,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,iCAAiC;QAClE,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;QAE7E,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IACzD,CAAC;IAEO,8BAA8B,CACpC,iBAAqC,EACrC,oBAAyC;QAEzC,IAAI,iBAAiB,EAAE,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE;gBAClC,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,iBAAiB;aACxD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,OAAa;QACtC,MAAM,IAAI,GAAG,OAAO,IAAI,gBAAgB,EAAE,CAAC;QAC3C,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Response } from \"../request/index.js\";\nimport type { DiagnosticNodeInternal } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport { mergeHeaders, getInitialHeader } from \"./headerUtils.js\";\nimport type { BaseContinuationTokenManager } from \"./ContinuationTokenManager/BaseContinuationTokenManager.js\";\nimport { ContinuationTokenManagerFactory } from \"./ContinuationTokenManager/ContinuationTokenManagerFactory.js\";\nimport { Constants } from \"../common/index.js\";\nimport type { ExecutionContext } from \"./ExecutionContext.js\";\n\n/**\n * Query control enabled fetch implementation with continuation token support\n * @hidden\n */\nexport class QueryControlFetchImplementation {\n  // Required fields for query control - not optional\n  private readonly continuationTokenManager: BaseContinuationTokenManager;\n  private readonly querySupportsTokens: boolean;\n\n  constructor(\n    private endpoint: ExecutionContext,\n    private pageSize: number,\n    collectionLink: string,\n    continuationToken: string | undefined,\n    isOrderByQuery: boolean,\n    querySupportsTokens: boolean,\n  ) {\n    this.querySupportsTokens = querySupportsTokens;\n\n    // Initialize continuation token manager immediately for query control\n    this.continuationTokenManager = ContinuationTokenManagerFactory.create(\n      collectionLink,\n      continuationToken,\n      isOrderByQuery,\n    );\n  }\n\n  async fetchMore(\n    diagnosticNode: DiagnosticNodeInternal,\n    fetchBuffer: any[],\n  ): Promise<Response<any>> {\n    // Initialize headers fresh for each fetchMore call\n    const fetchMoreRespHeaders = getInitialHeader();\n\n    // Use continuation token logic for supported queries when query control is enabled\n    // Otherwise use simplified buffer-only logic\n    if (this.querySupportsTokens) {\n      return this._handleQueryFetch(diagnosticNode, fetchBuffer, fetchMoreRespHeaders);\n    } else {\n      return this._handleSimpleBufferFetch(diagnosticNode, fetchBuffer, fetchMoreRespHeaders);\n    }\n  }\n\n  private async _handleSimpleBufferFetch(\n    diagnosticNode: DiagnosticNodeInternal,\n    fetchBuffer: any[],\n    fetchMoreRespHeaders: Record<string, any>,\n  ): Promise<Response<any>> {\n    // Return buffered data if available\n    if (fetchBuffer.length > 0) {\n      const temp = fetchBuffer.slice(0, this.pageSize);\n      fetchBuffer.splice(0, this.pageSize); // Remove items in place\n      return { result: temp, headers: fetchMoreRespHeaders };\n    }\n\n    // Fetch new data from endpoint\n    const response = await this.endpoint.fetchMore!(diagnosticNode);\n    mergeHeaders(fetchMoreRespHeaders, response.headers);\n\n    if (!response?.result?.buffer?.length) {\n      return this._createEmptyResult(response?.headers);\n    }\n\n    // Buffer new data and return up to pageSize\n    fetchBuffer.length = 0; // Clear existing items\n    fetchBuffer.push(...response.result.buffer); // Add new items\n    const temp = fetchBuffer.slice(0, this.pageSize);\n    fetchBuffer.splice(0, this.pageSize); // Remove returned items in place\n\n    return { result: temp, headers: fetchMoreRespHeaders };\n  }\n\n  private async _handleQueryFetch(\n    diagnosticNode: DiagnosticNodeInternal,\n    fetchBuffer: any[],\n    fetchMoreRespHeaders: Record<string, any>,\n  ): Promise<Response<any>> {\n    if (fetchBuffer.length > 0) {\n      const { endIndex, continuationToken } = this.continuationTokenManager.paginateResults(\n        this.pageSize,\n        false,\n      );\n      const temp = fetchBuffer.slice(0, endIndex);\n      fetchBuffer.splice(0, endIndex); // Remove returned items in place\n      this._setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders);\n\n      return { result: temp, headers: fetchMoreRespHeaders };\n    }\n\n    // Fetch new data from endpoint\n    fetchBuffer.length = 0; // Clear existing items in place\n    const response = await this.endpoint.fetchMore!(diagnosticNode);\n    mergeHeaders(fetchMoreRespHeaders, response.headers);\n\n    if (!response?.result?.buffer || response.result.buffer.length === 0) {\n      const { continuationToken } = this.continuationTokenManager.paginateResults(\n        this.pageSize,\n        true, // isResponseEmpty = true\n        response?.result, // Pass response data for processing\n      );\n      this._setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders);\n      return this._createEmptyResult(fetchMoreRespHeaders);\n    }\n\n    fetchBuffer.push(...response.result.buffer); // Add new items to existing buffer\n    const { endIndex, continuationToken } = this.continuationTokenManager.paginateResults(\n      this.pageSize,\n      false, // isResponseEmpty = false\n      response.result, // Pass response data for processing\n    );\n\n    const temp = fetchBuffer.slice(0, endIndex);\n    fetchBuffer.splice(0, endIndex); // Remove returned items in place\n    this._setContinuationTokenInHeaders(continuationToken, fetchMoreRespHeaders);\n\n    return { result: temp, headers: fetchMoreRespHeaders };\n  }\n\n  private _setContinuationTokenInHeaders(\n    continuationToken: string | undefined,\n    fetchMoreRespHeaders: Record<string, any>,\n  ): void {\n    if (continuationToken) {\n      Object.assign(fetchMoreRespHeaders, {\n        [Constants.HttpHeaders.Continuation]: continuationToken,\n      });\n    }\n  }\n\n  private _createEmptyResult(headers?: any): Response<any> {\n    const hdrs = headers || getInitialHeader();\n    return { result: [], headers: hdrs };\n  }\n}\n"]}

package/dist/browser/queryExecutionContext/QueryValidationHelper.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Rejects continuation token usage for unsupported query types
+ * @param continuationToken - The continuation token if provided
+ * @param unsupportedQueryTypes - Array of query types that don't support continuation tokens
+ * @throws ErrorResponse if continuation token is provided for any unsupported query type
+ * @hidden
+ */
+export declare function rejectContinuationTokenForUnsupportedQueries(continuationToken: string | undefined, unsupportedQueryTypes: UnsupportedQueryType[]): void;
+//# sourceMappingURL=QueryValidationHelper.d.ts.map

package/dist/browser/queryExecutionContext/QueryValidationHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryValidationHelper.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/QueryValidationHelper.ts"],"names":[],"mappings":"AAcA;;;;;;GAMG;AACH,wBAAgB,4CAA4C,CAC1D,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,qBAAqB,EAAE,oBAAoB,EAAE,GAC5C,IAAI,CAWN"}

package/dist/browser/queryExecutionContext/QueryValidationHelper.js

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { ErrorResponse } from "../request/ErrorResponse.js";
+/**
+ * Rejects continuation token usage for unsupported query types
+ * @param continuationToken - The continuation token if provided
+ * @param unsupportedQueryTypes - Array of query types that don't support continuation tokens
+ * @throws ErrorResponse if continuation token is provided for any unsupported query type
+ * @hidden
+ */
+export function rejectContinuationTokenForUnsupportedQueries(continuationToken, unsupportedQueryTypes) {
+    if (!continuationToken) {
+        return;
+    }
+    // Find the first unsupported query type that is present
+    const conflictingQueryType = unsupportedQueryTypes.find((queryType) => queryType.isPresent);
+    if (conflictingQueryType) {
+        throw new ErrorResponse(conflictingQueryType.errorMessage);
+    }
+}
+/**
+ * Factory functions for creating unsupported query type descriptors
+ * @internal
+ */
+export const QueryTypes = {
+    nonStreamingOrderBy: (isPresent) => ({
+        name: "NonStreamingOrderBy",
+        isPresent,
+        errorMessage: "Continuation tokens are not supported for non-streaming ORDER BY queries. " +
+            "These queries must process all results to ensure correct ordering and cannot be resumed from an intermediate state. " +
+            "Consider removing the continuation token and using fetchAll() instead for complete results.",
+    }),
+    groupBy: (isPresent) => ({
+        name: "GroupBy",
+        isPresent,
+        errorMessage: "Continuation tokens are not supported for GROUP BY queries. " +
+            "These queries must process all results to compute aggregations and cannot be resumed from an intermediate state. " +
+            "Consider removing the continuation token and using fetchAll() instead for complete results.",
+    }),
+    unorderedDistinct: (isPresent) => ({
+        name: "UnorderedDistinct",
+        isPresent,
+        errorMessage: "Continuation tokens are not supported for unordered DISTINCT queries. " +
+            "These queries require tracking large amounts of duplicate data in continuation tokens which is not practical. " +
+            "Consider removing the continuation token and using fetchAll() instead, or use ordered DISTINCT queries which are supported.",
+    }),
+    hybridSearch: (isPresent) => ({
+        name: "HybridSearch",
+        isPresent,
+        errorMessage: "Continuation tokens are not supported for hybrid search queries. " +
+            "Hybrid search queries require processing and ranking of all component query results " +
+            "to compute accurate Reciprocal Rank Fusion (RRF) scores and cannot be resumed from an intermediate state. " +
+            "Consider removing the continuation token and using fetchAll() instead for complete results.",
+    }),
+    // Easy to add new unsupported query types here
+    vectorSearch: (isPresent) => ({
+        name: "VectorSearch",
+        isPresent,
+        errorMessage: "Continuation tokens are not supported for vector search queries. " +
+            "Vector search queries require processing similarity calculations across all data " +
+            "and cannot be resumed from an intermediate state. " +
+            "Consider removing the continuation token and using fetchAll() instead for complete results.",
+    }),
+};
+//# sourceMappingURL=QueryValidationHelper.js.map

package/dist/browser/queryExecutionContext/QueryValidationHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryValidationHelper.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/QueryValidationHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAY5D;;;;;;GAMG;AACH,MAAM,UAAU,4CAA4C,CAC1D,iBAAqC,EACrC,qBAA6C;IAE7C,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,wDAAwD;IACxD,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAE5F,IAAI,oBAAoB,EAAE,CAAC;QACzB,MAAM,IAAI,aAAa,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,mBAAmB,EAAE,CAAC,SAAkB,EAAwB,EAAE,CAAC,CAAC;QAClE,IAAI,EAAE,qBAAqB;QAC3B,SAAS;QACT,YAAY,EACV,4EAA4E;YAC5E,sHAAsH;YACtH,6FAA6F;KAChG,CAAC;IAEF,OAAO,EAAE,CAAC,SAAkB,EAAwB,EAAE,CAAC,CAAC;QACtD,IAAI,EAAE,SAAS;QACf,SAAS;QACT,YAAY,EACV,8DAA8D;YAC9D,mHAAmH;YACnH,6FAA6F;KAChG,CAAC;IAEF,iBAAiB,EAAE,CAAC,SAAkB,EAAwB,EAAE,CAAC,CAAC;QAChE,IAAI,EAAE,mBAAmB;QACzB,SAAS;QACT,YAAY,EACV,wEAAwE;YACxE,gHAAgH;YAChH,6HAA6H;KAChI,CAAC;IAEF,YAAY,EAAE,CAAC,SAAkB,EAAwB,EAAE,CAAC,CAAC;QAC3D,IAAI,EAAE,cAAc;QACpB,SAAS;QACT,YAAY,EACV,mEAAmE;YACnE,sFAAsF;YACtF,4GAA4G;YAC5G,6FAA6F;KAChG,CAAC;IAEF,+CAA+C;IAC/C,YAAY,EAAE,CAAC,SAAkB,EAAwB,EAAE,CAAC,CAAC;QAC3D,IAAI,EAAE,cAAc;QACpB,SAAS;QACT,YAAY,EACV,mEAAmE;YACnE,mFAAmF;YACnF,oDAAoD;YACpD,6FAA6F;KAChG,CAAC;CACM,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport { ErrorResponse } from \"../request/ErrorResponse.js\";\n\n/**\n * Represents a query type that doesn't support continuation tokens\n * @internal\n */\nexport interface UnsupportedQueryType {\n  readonly name: string;\n  readonly isPresent: boolean;\n  readonly errorMessage: string;\n}\n\n/**\n * Rejects continuation token usage for unsupported query types\n * @param continuationToken - The continuation token if provided\n * @param unsupportedQueryTypes - Array of query types that don't support continuation tokens\n * @throws ErrorResponse if continuation token is provided for any unsupported query type\n * @hidden\n */\nexport function rejectContinuationTokenForUnsupportedQueries(\n  continuationToken: string | undefined,\n  unsupportedQueryTypes: UnsupportedQueryType[],\n): void {\n  if (!continuationToken) {\n    return;\n  }\n\n  // Find the first unsupported query type that is present\n  const conflictingQueryType = unsupportedQueryTypes.find((queryType) => queryType.isPresent);\n\n  if (conflictingQueryType) {\n    throw new ErrorResponse(conflictingQueryType.errorMessage);\n  }\n}\n\n/**\n * Factory functions for creating unsupported query type descriptors\n * @internal\n */\nexport const QueryTypes = {\n  nonStreamingOrderBy: (isPresent: boolean): UnsupportedQueryType => ({\n    name: \"NonStreamingOrderBy\",\n    isPresent,\n    errorMessage:\n      \"Continuation tokens are not supported for non-streaming ORDER BY queries. \" +\n      \"These queries must process all results to ensure correct ordering and cannot be resumed from an intermediate state. \" +\n      \"Consider removing the continuation token and using fetchAll() instead for complete results.\",\n  }),\n\n  groupBy: (isPresent: boolean): UnsupportedQueryType => ({\n    name: \"GroupBy\",\n    isPresent,\n    errorMessage:\n      \"Continuation tokens are not supported for GROUP BY queries. \" +\n      \"These queries must process all results to compute aggregations and cannot be resumed from an intermediate state. \" +\n      \"Consider removing the continuation token and using fetchAll() instead for complete results.\",\n  }),\n\n  unorderedDistinct: (isPresent: boolean): UnsupportedQueryType => ({\n    name: \"UnorderedDistinct\",\n    isPresent,\n    errorMessage:\n      \"Continuation tokens are not supported for unordered DISTINCT queries. \" +\n      \"These queries require tracking large amounts of duplicate data in continuation tokens which is not practical. \" +\n      \"Consider removing the continuation token and using fetchAll() instead, or use ordered DISTINCT queries which are supported.\",\n  }),\n\n  hybridSearch: (isPresent: boolean): UnsupportedQueryType => ({\n    name: \"HybridSearch\",\n    isPresent,\n    errorMessage:\n      \"Continuation tokens are not supported for hybrid search queries. \" +\n      \"Hybrid search queries require processing and ranking of all component query results \" +\n      \"to compute accurate Reciprocal Rank Fusion (RRF) scores and cannot be resumed from an intermediate state. \" +\n      \"Consider removing the continuation token and using fetchAll() instead for complete results.\",\n  }),\n\n  // Easy to add new unsupported query types here\n  vectorSearch: (isPresent: boolean): UnsupportedQueryType => ({\n    name: \"VectorSearch\",\n    isPresent,\n    errorMessage:\n      \"Continuation tokens are not supported for vector search queries. \" +\n      \"Vector search queries require processing similarity calculations across all data \" +\n      \"and cannot be resumed from an intermediate state. \" +\n      \"Consider removing the continuation token and using fetchAll() instead for complete results.\",\n  }),\n} as const;\n"]}

package/dist/browser/queryExecutionContext/defaultQueryExecutionContext.d.ts

@@ -11,8 +11,8 @@ export declare class DefaultQueryExecutionContext implements ExecutionContext {
     private currentPartitionIndex;
     private fetchFunctions;
     private options;
-    continuationToken: string;
-    get continuation(): string;
+    continuationToken: string | undefined;
+    get continuation(): string | undefined;
     private state;
     private nextFetchFunction;
     private correlatedActivityId;

package/dist/browser/queryExecutionContext/defaultQueryExecutionContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultQueryExecutionContext.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/defaultQueryExecutionContext.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAMvF,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG,CAClC,cAAc,EAAE,sBAAsB,EACtC,OAAO,EAAE,WAAW,EACpB,oBAAoB,EAAE,MAAM,KACzB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AAS5B,cAAc;AACd,qBAAa,4BAA6B,YAAW,gBAAgB;IACnE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAU;IACxC,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,cAAc,CAA0B;IAChD,OAAO,CAAC,OAAO,CAAc;IACtB,iBAAiB,EAAE,MAAM,CAAC;IACjC,IAAW,YAAY,IAAI,MAAM,CAEhC;IACD,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,oBAAoB,CAAS;IACrC;;;;;;;;;;OAUG;gBAED,OAAO,EAAE,WAAW,EACpB,cAAc,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,EAC/D,oBAAoB,EAAE,MAAM;IAY9B;;OAEG;IACU,QAAQ,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAMrF;;OAEG;IACU,OAAO,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IA6BpF;;;;;OAKG;IACI,cAAc,IAAI,OAAO;IAShC;;OAEG;IACU,SAAS,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAiHtF,OAAO,CAAC,aAAa;CAQtB"}
+{"version":3,"file":"defaultQueryExecutionContext.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/defaultQueryExecutionContext.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAMvF,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG,CAClC,cAAc,EAAE,sBAAsB,EACtC,OAAO,EAAE,WAAW,EACpB,oBAAoB,EAAE,MAAM,KACzB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AAS5B,cAAc;AACd,qBAAa,4BAA6B,YAAW,gBAAgB;IACnE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAU;IACxC,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,cAAc,CAA0B;IAChD,OAAO,CAAC,OAAO,CAAc;IACtB,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAE5C;IACD,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,oBAAoB,CAAS;IACrC;;;;;;;;;;OAUG;gBAED,OAAO,EAAE,WAAW,EACpB,cAAc,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,EAC/D,oBAAoB,EAAE,MAAM;IAa9B;;OAEG;IACU,QAAQ,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAMrF;;OAEG;IACU,OAAO,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IA6BpF;;;;;OAKG;IACI,cAAc,IAAI,OAAO;IAShC;;OAEG;IACU,SAAS,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAiHtF,OAAO,CAAC,aAAa;CAQtB"}

package/dist/browser/queryExecutionContext/defaultQueryExecutionContext.js

@@ -45,7 +45,8 @@ export class DefaultQueryExecutionContext {
         this.currentPartitionIndex = 0;
         this.fetchFunctions = Array.isArray(fetchFunctions) ? fetchFunctions : [fetchFunctions];
         this.options = options || {};
-        this.continuationToken = this.options.continuationToken || this.options.continuation || null;
+        this.continuationToken =
+            this.options.continuationToken || this.options.continuation || undefined;
         this.state = DefaultQueryExecutionContext.STATES.start;
         this.correlatedActivityId = correlatedActivityId;
     }

package/dist/browser/queryExecutionContext/defaultQueryExecutionContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaultQueryExecutionContext.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/defaultQueryExecutionContext.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAEpF,MAAM,MAAM,GAAgB,kBAAkB,CAAC,eAAe,CAAC,CAAC;AAQhE,cAAc;AACd,IAAK,MAIJ;AAJD,WAAK,MAAM;IACT,yBAAe,CAAA;IACf,mCAAyB,CAAA;IACzB,yBAAe,CAAA;AACjB,CAAC,EAJI,MAAM,KAAN,MAAM,QAIV;AAED,cAAc;AACd,MAAM,OAAO,4BAA4B;IAC/B,MAAM,CAAU,MAAM,GAAG,MAAM,CAAC;IAChC,SAAS,CAAQ,CAAC,sBAAsB;IACxC,YAAY,CAAS;IACrB,qBAAqB,CAAS;IAC9B,cAAc,CAA0B;IACxC,OAAO,CAAc,CAAC,oBAAoB;IAC3C,iBAAiB,CAAS,CAAC,yBAAyB;IAC3D,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACO,KAAK,CAAS;IACd,iBAAiB,CAAyB;IAC1C,oBAAoB,CAAS;IACrC;;;;;;;;;;OAUG;IACH,YACE,OAAoB,EACpB,cAA+D,EAC/D,oBAA4B;QAE5B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;QAC7F,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;QACvD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,cAAsC;QAC1D,EAAE,IAAI,CAAC,YAAY,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,cAAsC;QACzD,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC9C,OAAO;gBACL,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;gBACzC,OAAO,EAAE,gBAAgB,EAAE;aAC5B,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;oBACxF,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;oBACvD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;YACvD,OAAO;gBACL,MAAM,EAAE,SAAS;gBACjB,OAAO,EAAE,gBAAgB,EAAE;aAC5B,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,OAAO,CACL,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,KAAK;YACxD,IAAI,CAAC,iBAAiB,KAAK,SAAS;YACpC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAC7C,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CACxD,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,cAAsC;QAC3D,OAAO,kBAAkB,CACvB,KAAK,EAAE,mBAA2C,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC7D,OAAO;oBACL,OAAO,EAAE,gBAAgB,EAAE;oBAC3B,MAAM,EAAE,SAAS;iBAClB,CAAC;YACJ,CAAC;YAED,sFAAsF;YACtF,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YACzF,IAAI,CAAC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YAExD,+CAA+C;YAC/C,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC7D,OAAO;oBACL,OAAO,EAAE,gBAAgB,EAAE;oBAC3B,MAAM,EAAE,SAAS;iBAClB,CAAC;YACJ,CAAC;YAED,IAAI,SAAS,CAAC;YACd,IAAI,eAAe,CAAC;YACpB,IAAI,CAAC;gBACH,IAAI,CAAyB,CAAC;gBAC9B,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;oBACzC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;oBACjC,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;oBAC3B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;gBACrC,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;oBACpC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CACjD,mBAAmB,EACnB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,oBAAoB,CAC1B,CAAC;gBACJ,CAAC;gBACD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC;gBACzB,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAC5B,mBAAmB,CAAC,iBAAiB,CAAC,SAAS,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;gBACtF,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;gBACnC,IAAI,CAAC,iBAAiB,GAAG,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBAC7E,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC5B,EAAE,IAAI,CAAC,qBAAqB,CAAC;gBAC/B,CAAC;gBAED,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;oBACtD,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;oBACtE,IAAI,CAAC,iBAAiB,GAAG,aAAa;wBACpC,CAAC,CAAC,aAAa,CACX,mBAAmB,EACnB;4BACE,GAAG,IAAI,CAAC,OAAO;4BACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;yBAC1C,EACD,IAAI,CAAC,oBAAoB,CAC1B;wBACH,CAAC,CAAC,SAAS,CAAC;gBAChB,CAAC;YACH,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;gBACvD,oDAAoD;gBACpD,2EAA2E;gBAC3E,MAAM,GAAG,CAAC;YACZ,CAAC;YAED,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,UAAU,CAAC;YAC5D,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC;YACtD,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,oBAAoB,CAAC;YAEjD,4GAA4G;YAC5G,IAAI,SAAS,CAAC,WAAW,CAAC,YAAY,IAAI,eAAe,EAAE,CAAC;gBAC1D,MAAM,eAAe,GAAG,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBAC5E,IAAI,YAAY,GAAG,YAAY,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAC;gBAE3E,gGAAgG;gBAChG,IAAI,SAAS,CAAC,WAAW,CAAC,aAAa,IAAI,eAAe,EAAE,CAAC;oBAC3D,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC;oBACxF,YAAY,GAAG,IAAI,YAAY,CAC7B,YAAY,CAAC,sBAAsB,EACnC,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,mBAAmB,EAChC,YAAY,CAAC,kBAAkB,EAC/B,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,uBAAuB,EACpC,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,gBAAgB,EAC7B,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,iBAAiB,EAC9B,IAAI,iBAAiB,CAAC,aAAa,CAAC,CACrC,CAAC;gBACJ,CAAC;gBAED,kFAAkF;gBAClF,sDAAsD;gBACtD,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;gBACzD,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAC1E,CAAC;YAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;QACzD,CAAC,EACD,cAAc,EACd,kBAAkB,CAAC,kBAAkB,EACrC;YACE,qBAAqB,EAAE,WAAW;SACnC,CACF,CAAC;IACJ,CAAC;IAEO,aAAa;QACnB,MAAM,GAAG,GACP,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,KAAK;YACxD,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,UAAU,CAAC;YACzF,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM;gBACtD,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { AzureLogger } from \"@azure/logger\";\nimport { createClientLogger } from \"@azure/logger\";\nimport { Constants } from \"../common/index.js\";\nimport { ClientSideMetrics, QueryMetrics } from \"../queryMetrics/index.js\";\nimport type { FeedOptions, Response } from \"../request/index.js\";\nimport { getInitialHeader } from \"./headerUtils.js\";\nimport type { ExecutionContext } from \"./index.js\";\nimport type { DiagnosticNodeInternal } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport { DiagnosticNodeType } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport { addDiagnosticChild } from \"../utils/diagnostics.js\";\nimport { CosmosDbDiagnosticLevel } from \"../diagnostics/CosmosDbDiagnosticLevel.js\";\n\nconst logger: AzureLogger = createClientLogger(\"ClientContext\");\n/** @hidden */\nexport type FetchFunctionCallback = (\n  diagnosticNode: DiagnosticNodeInternal,\n  options: FeedOptions,\n  correlatedActivityId: string,\n) => Promise<Response<any>>;\n\n/** @hidden */\nenum STATES {\n  start = \"start\",\n  inProgress = \"inProgress\",\n  ended = \"ended\",\n}\n\n/** @hidden */\nexport class DefaultQueryExecutionContext implements ExecutionContext {\n  private static readonly STATES = STATES;\n  private resources: any[]; // TODO: any resources\n  private currentIndex: number;\n  private currentPartitionIndex: number;\n  private fetchFunctions: FetchFunctionCallback[];\n  private options: FeedOptions; // TODO: any options\n  public continuationToken: string; // TODO: any continuation\n  public get continuation(): string {\n    return this.continuationToken;\n  }\n  private state: STATES;\n  private nextFetchFunction: Promise<Response<any>>;\n  private correlatedActivityId: string;\n  /**\n   * Provides the basic Query Execution Context.\n   * This wraps the internal logic query execution using provided fetch functions\n   *\n   * @param clientContext  - Is used to read the partitionKeyRanges for split proofing\n   * @param query          - A SQL query.\n   * @param options        - Represents the feed options.\n   * @param fetchFunctions - A function to retrieve each page of data.\n   *                          An array of functions may be used to query more than one partition.\n   * @hidden\n   */\n  constructor(\n    options: FeedOptions,\n    fetchFunctions: FetchFunctionCallback | FetchFunctionCallback[],\n    correlatedActivityId: string,\n  ) {\n    this.resources = [];\n    this.currentIndex = 0;\n    this.currentPartitionIndex = 0;\n    this.fetchFunctions = Array.isArray(fetchFunctions) ? fetchFunctions : [fetchFunctions];\n    this.options = options || {};\n    this.continuationToken = this.options.continuationToken || this.options.continuation || null;\n    this.state = DefaultQueryExecutionContext.STATES.start;\n    this.correlatedActivityId = correlatedActivityId;\n  }\n\n  /**\n   * Execute a provided callback on the next element in the execution context.\n   */\n  public async nextItem(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    ++this.currentIndex;\n    const response = await this.current(diagnosticNode);\n    return response;\n  }\n\n  /**\n   * Retrieve the current element on the execution context.\n   */\n  public async current(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    if (this.currentIndex < this.resources.length) {\n      return {\n        result: this.resources[this.currentIndex],\n        headers: getInitialHeader(),\n      };\n    }\n\n    if (this._canFetchMore()) {\n      const { result: resources, headers } = await this.fetchMore(diagnosticNode);\n      this.resources = resources;\n      if (this.resources.length === 0) {\n        if (!this.continuationToken && this.currentPartitionIndex >= this.fetchFunctions.length) {\n          this.state = DefaultQueryExecutionContext.STATES.ended;\n          return { result: undefined, headers };\n        } else {\n          return this.current(diagnosticNode);\n        }\n      }\n      return { result: this.resources[this.currentIndex], headers };\n    } else {\n      this.state = DefaultQueryExecutionContext.STATES.ended;\n      return {\n        result: undefined,\n        headers: getInitialHeader(),\n      };\n    }\n  }\n\n  /**\n   * Determine if there are still remaining resources to processs based on\n   * the value of the continuation token or the elements remaining on the current batch in the execution context.\n   *\n   * @returns true if there is other elements to process in the DefaultQueryExecutionContext.\n   */\n  public hasMoreResults(): boolean {\n    return (\n      this.state === DefaultQueryExecutionContext.STATES.start ||\n      this.continuationToken !== undefined ||\n      this.currentIndex < this.resources.length - 1 ||\n      this.currentPartitionIndex < this.fetchFunctions.length\n    );\n  }\n\n  /**\n   * Fetches the next batch of the feed and pass them as an array to a callback\n   */\n  public async fetchMore(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    return addDiagnosticChild(\n      async (childDiagnosticNode: DiagnosticNodeInternal) => {\n        if (this.currentPartitionIndex >= this.fetchFunctions.length) {\n          return {\n            headers: getInitialHeader(),\n            result: undefined,\n          };\n        }\n\n        // Keep to the original continuation and to restore the value after fetchFunction call\n        const originalContinuation = this.options.continuationToken || this.options.continuation;\n        this.options.continuationToken = this.continuationToken;\n\n        // Return undefined if there is no more results\n        if (this.currentPartitionIndex >= this.fetchFunctions.length) {\n          return {\n            headers: getInitialHeader(),\n            result: undefined,\n          };\n        }\n\n        let resources;\n        let responseHeaders;\n        try {\n          let p: Promise<Response<any>>;\n          if (this.nextFetchFunction !== undefined) {\n            logger.verbose(\"using prefetch\");\n            p = this.nextFetchFunction;\n            this.nextFetchFunction = undefined;\n          } else {\n            logger.verbose(\"using fresh fetch\");\n            p = this.fetchFunctions[this.currentPartitionIndex](\n              childDiagnosticNode,\n              this.options,\n              this.correlatedActivityId,\n            );\n          }\n          const response = await p;\n          resources = response.result;\n          childDiagnosticNode.recordQueryResult(resources, CosmosDbDiagnosticLevel.debugUnsafe);\n          responseHeaders = response.headers;\n          this.continuationToken = responseHeaders[Constants.HttpHeaders.Continuation];\n          if (!this.continuationToken) {\n            ++this.currentPartitionIndex;\n          }\n\n          if (this.options && this.options.bufferItems === true) {\n            const fetchFunction = this.fetchFunctions[this.currentPartitionIndex];\n            this.nextFetchFunction = fetchFunction\n              ? fetchFunction(\n                  childDiagnosticNode,\n                  {\n                    ...this.options,\n                    continuationToken: this.continuationToken,\n                  },\n                  this.correlatedActivityId,\n                )\n              : undefined;\n          }\n        } catch (err: any) {\n          this.state = DefaultQueryExecutionContext.STATES.ended;\n          // return callback(err, undefined, responseHeaders);\n          // TODO: Error and data being returned is an antipattern, this might broken\n          throw err;\n        }\n\n        this.state = DefaultQueryExecutionContext.STATES.inProgress;\n        this.currentIndex = 0;\n        this.options.continuationToken = originalContinuation;\n        this.options.continuation = originalContinuation;\n\n        // deserializing query metrics so that we aren't working with delimited strings in the rest of the code base\n        if (Constants.HttpHeaders.QueryMetrics in responseHeaders) {\n          const delimitedString = responseHeaders[Constants.HttpHeaders.QueryMetrics];\n          let queryMetrics = QueryMetrics.createFromDelimitedString(delimitedString);\n\n          // Add the request charge to the query metrics so that we can have per partition request charge.\n          if (Constants.HttpHeaders.RequestCharge in responseHeaders) {\n            const requestCharge = Number(responseHeaders[Constants.HttpHeaders.RequestCharge]) || 0;\n            queryMetrics = new QueryMetrics(\n              queryMetrics.retrievedDocumentCount,\n              queryMetrics.retrievedDocumentSize,\n              queryMetrics.outputDocumentCount,\n              queryMetrics.outputDocumentSize,\n              queryMetrics.indexHitDocumentCount,\n              queryMetrics.totalQueryExecutionTime,\n              queryMetrics.queryPreparationTimes,\n              queryMetrics.indexLookupTime,\n              queryMetrics.documentLoadTime,\n              queryMetrics.vmExecutionTime,\n              queryMetrics.runtimeExecutionTimes,\n              queryMetrics.documentWriteTime,\n              new ClientSideMetrics(requestCharge),\n            );\n          }\n\n          // Wraping query metrics in a object where the key is '0' just so single partition\n          // and partition queries have the same response schema\n          responseHeaders[Constants.HttpHeaders.QueryMetrics] = {};\n          responseHeaders[Constants.HttpHeaders.QueryMetrics][\"0\"] = queryMetrics;\n        }\n\n        return { result: resources, headers: responseHeaders };\n      },\n      diagnosticNode,\n      DiagnosticNodeType.DEFAULT_QUERY_NODE,\n      {\n        queryMethodIdentifier: \"fetchMore\",\n      },\n    );\n  }\n\n  private _canFetchMore(): boolean {\n    const res =\n      this.state === DefaultQueryExecutionContext.STATES.start ||\n      (this.continuationToken && this.state === DefaultQueryExecutionContext.STATES.inProgress) ||\n      (this.currentPartitionIndex < this.fetchFunctions.length &&\n        this.state === DefaultQueryExecutionContext.STATES.inProgress);\n    return res;\n  }\n}\n"]}
+{"version":3,"file":"defaultQueryExecutionContext.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/defaultQueryExecutionContext.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAEpF,MAAM,MAAM,GAAgB,kBAAkB,CAAC,eAAe,CAAC,CAAC;AAQhE,cAAc;AACd,IAAK,MAIJ;AAJD,WAAK,MAAM;IACT,yBAAe,CAAA;IACf,mCAAyB,CAAA;IACzB,yBAAe,CAAA;AACjB,CAAC,EAJI,MAAM,KAAN,MAAM,QAIV;AAED,cAAc;AACd,MAAM,OAAO,4BAA4B;IAC/B,MAAM,CAAU,MAAM,GAAG,MAAM,CAAC;IAChC,SAAS,CAAQ,CAAC,sBAAsB;IACxC,YAAY,CAAS;IACrB,qBAAqB,CAAS;IAC9B,cAAc,CAA0B;IACxC,OAAO,CAAc,CAAC,oBAAoB;IAC3C,iBAAiB,CAAqB,CAAC,yBAAyB;IACvE,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACO,KAAK,CAAS;IACd,iBAAiB,CAAyB;IAC1C,oBAAoB,CAAS;IACrC;;;;;;;;;;OAUG;IACH,YACE,OAAoB,EACpB,cAA+D,EAC/D,oBAA4B;QAE5B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,iBAAiB;YACpB,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,SAAS,CAAC;QAC3E,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;QACvD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,cAAsC;QAC1D,EAAE,IAAI,CAAC,YAAY,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,cAAsC;QACzD,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC9C,OAAO;gBACL,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;gBACzC,OAAO,EAAE,gBAAgB,EAAE;aAC5B,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzB,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;oBACxF,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;oBACvD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;YACvD,OAAO;gBACL,MAAM,EAAE,SAAS;gBACjB,OAAO,EAAE,gBAAgB,EAAE;aAC5B,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,OAAO,CACL,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,KAAK;YACxD,IAAI,CAAC,iBAAiB,KAAK,SAAS;YACpC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAC7C,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CACxD,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,cAAsC;QAC3D,OAAO,kBAAkB,CACvB,KAAK,EAAE,mBAA2C,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC7D,OAAO;oBACL,OAAO,EAAE,gBAAgB,EAAE;oBAC3B,MAAM,EAAE,SAAS;iBAClB,CAAC;YACJ,CAAC;YAED,sFAAsF;YACtF,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YACzF,IAAI,CAAC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YAExD,+CAA+C;YAC/C,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC7D,OAAO;oBACL,OAAO,EAAE,gBAAgB,EAAE;oBAC3B,MAAM,EAAE,SAAS;iBAClB,CAAC;YACJ,CAAC;YAED,IAAI,SAAS,CAAC;YACd,IAAI,eAAe,CAAC;YACpB,IAAI,CAAC;gBACH,IAAI,CAAyB,CAAC;gBAC9B,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;oBACzC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;oBACjC,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;oBAC3B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;gBACrC,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;oBACpC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CACjD,mBAAmB,EACnB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,oBAAoB,CAC1B,CAAC;gBACJ,CAAC;gBACD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC;gBACzB,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAC5B,mBAAmB,CAAC,iBAAiB,CAAC,SAAS,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;gBACtF,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;gBACnC,IAAI,CAAC,iBAAiB,GAAG,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBAC7E,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC5B,EAAE,IAAI,CAAC,qBAAqB,CAAC;gBAC/B,CAAC;gBAED,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;oBACtD,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;oBACtE,IAAI,CAAC,iBAAiB,GAAG,aAAa;wBACpC,CAAC,CAAC,aAAa,CACX,mBAAmB,EACnB;4BACE,GAAG,IAAI,CAAC,OAAO;4BACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;yBAC1C,EACD,IAAI,CAAC,oBAAoB,CAC1B;wBACH,CAAC,CAAC,SAAS,CAAC;gBAChB,CAAC;YACH,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,KAAK,CAAC;gBACvD,oDAAoD;gBACpD,2EAA2E;gBAC3E,MAAM,GAAG,CAAC;YACZ,CAAC;YAED,IAAI,CAAC,KAAK,GAAG,4BAA4B,CAAC,MAAM,CAAC,UAAU,CAAC;YAC5D,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC;YACtD,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,oBAAoB,CAAC;YAEjD,4GAA4G;YAC5G,IAAI,SAAS,CAAC,WAAW,CAAC,YAAY,IAAI,eAAe,EAAE,CAAC;gBAC1D,MAAM,eAAe,GAAG,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBAC5E,IAAI,YAAY,GAAG,YAAY,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAC;gBAE3E,gGAAgG;gBAChG,IAAI,SAAS,CAAC,WAAW,CAAC,aAAa,IAAI,eAAe,EAAE,CAAC;oBAC3D,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC;oBACxF,YAAY,GAAG,IAAI,YAAY,CAC7B,YAAY,CAAC,sBAAsB,EACnC,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,mBAAmB,EAChC,YAAY,CAAC,kBAAkB,EAC/B,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,uBAAuB,EACpC,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,gBAAgB,EAC7B,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,iBAAiB,EAC9B,IAAI,iBAAiB,CAAC,aAAa,CAAC,CACrC,CAAC;gBACJ,CAAC;gBAED,kFAAkF;gBAClF,sDAAsD;gBACtD,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;gBACzD,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAC1E,CAAC;YAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;QACzD,CAAC,EACD,cAAc,EACd,kBAAkB,CAAC,kBAAkB,EACrC;YACE,qBAAqB,EAAE,WAAW;SACnC,CACF,CAAC;IACJ,CAAC;IAEO,aAAa;QACnB,MAAM,GAAG,GACP,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,KAAK;YACxD,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,UAAU,CAAC;YACzF,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM;gBACtD,IAAI,CAAC,KAAK,KAAK,4BAA4B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { AzureLogger } from \"@azure/logger\";\nimport { createClientLogger } from \"@azure/logger\";\nimport { Constants } from \"../common/index.js\";\nimport { ClientSideMetrics, QueryMetrics } from \"../queryMetrics/index.js\";\nimport type { FeedOptions, Response } from \"../request/index.js\";\nimport { getInitialHeader } from \"./headerUtils.js\";\nimport type { ExecutionContext } from \"./index.js\";\nimport type { DiagnosticNodeInternal } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport { DiagnosticNodeType } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport { addDiagnosticChild } from \"../utils/diagnostics.js\";\nimport { CosmosDbDiagnosticLevel } from \"../diagnostics/CosmosDbDiagnosticLevel.js\";\n\nconst logger: AzureLogger = createClientLogger(\"ClientContext\");\n/** @hidden */\nexport type FetchFunctionCallback = (\n  diagnosticNode: DiagnosticNodeInternal,\n  options: FeedOptions,\n  correlatedActivityId: string,\n) => Promise<Response<any>>;\n\n/** @hidden */\nenum STATES {\n  start = \"start\",\n  inProgress = \"inProgress\",\n  ended = \"ended\",\n}\n\n/** @hidden */\nexport class DefaultQueryExecutionContext implements ExecutionContext {\n  private static readonly STATES = STATES;\n  private resources: any[]; // TODO: any resources\n  private currentIndex: number;\n  private currentPartitionIndex: number;\n  private fetchFunctions: FetchFunctionCallback[];\n  private options: FeedOptions; // TODO: any options\n  public continuationToken: string | undefined; // TODO: any continuation\n  public get continuation(): string | undefined {\n    return this.continuationToken;\n  }\n  private state: STATES;\n  private nextFetchFunction: Promise<Response<any>>;\n  private correlatedActivityId: string;\n  /**\n   * Provides the basic Query Execution Context.\n   * This wraps the internal logic query execution using provided fetch functions\n   *\n   * @param clientContext  - Is used to read the partitionKeyRanges for split proofing\n   * @param query          - A SQL query.\n   * @param options        - Represents the feed options.\n   * @param fetchFunctions - A function to retrieve each page of data.\n   *                          An array of functions may be used to query more than one partition.\n   * @hidden\n   */\n  constructor(\n    options: FeedOptions,\n    fetchFunctions: FetchFunctionCallback | FetchFunctionCallback[],\n    correlatedActivityId: string,\n  ) {\n    this.resources = [];\n    this.currentIndex = 0;\n    this.currentPartitionIndex = 0;\n    this.fetchFunctions = Array.isArray(fetchFunctions) ? fetchFunctions : [fetchFunctions];\n    this.options = options || {};\n    this.continuationToken =\n      this.options.continuationToken || this.options.continuation || undefined;\n    this.state = DefaultQueryExecutionContext.STATES.start;\n    this.correlatedActivityId = correlatedActivityId;\n  }\n\n  /**\n   * Execute a provided callback on the next element in the execution context.\n   */\n  public async nextItem(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    ++this.currentIndex;\n    const response = await this.current(diagnosticNode);\n    return response;\n  }\n\n  /**\n   * Retrieve the current element on the execution context.\n   */\n  public async current(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    if (this.currentIndex < this.resources.length) {\n      return {\n        result: this.resources[this.currentIndex],\n        headers: getInitialHeader(),\n      };\n    }\n\n    if (this._canFetchMore()) {\n      const { result: resources, headers } = await this.fetchMore(diagnosticNode);\n      this.resources = resources;\n      if (this.resources.length === 0) {\n        if (!this.continuationToken && this.currentPartitionIndex >= this.fetchFunctions.length) {\n          this.state = DefaultQueryExecutionContext.STATES.ended;\n          return { result: undefined, headers };\n        } else {\n          return this.current(diagnosticNode);\n        }\n      }\n      return { result: this.resources[this.currentIndex], headers };\n    } else {\n      this.state = DefaultQueryExecutionContext.STATES.ended;\n      return {\n        result: undefined,\n        headers: getInitialHeader(),\n      };\n    }\n  }\n\n  /**\n   * Determine if there are still remaining resources to processs based on\n   * the value of the continuation token or the elements remaining on the current batch in the execution context.\n   *\n   * @returns true if there is other elements to process in the DefaultQueryExecutionContext.\n   */\n  public hasMoreResults(): boolean {\n    return (\n      this.state === DefaultQueryExecutionContext.STATES.start ||\n      this.continuationToken !== undefined ||\n      this.currentIndex < this.resources.length - 1 ||\n      this.currentPartitionIndex < this.fetchFunctions.length\n    );\n  }\n\n  /**\n   * Fetches the next batch of the feed and pass them as an array to a callback\n   */\n  public async fetchMore(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    return addDiagnosticChild(\n      async (childDiagnosticNode: DiagnosticNodeInternal) => {\n        if (this.currentPartitionIndex >= this.fetchFunctions.length) {\n          return {\n            headers: getInitialHeader(),\n            result: undefined,\n          };\n        }\n\n        // Keep to the original continuation and to restore the value after fetchFunction call\n        const originalContinuation = this.options.continuationToken || this.options.continuation;\n        this.options.continuationToken = this.continuationToken;\n\n        // Return undefined if there is no more results\n        if (this.currentPartitionIndex >= this.fetchFunctions.length) {\n          return {\n            headers: getInitialHeader(),\n            result: undefined,\n          };\n        }\n\n        let resources;\n        let responseHeaders;\n        try {\n          let p: Promise<Response<any>>;\n          if (this.nextFetchFunction !== undefined) {\n            logger.verbose(\"using prefetch\");\n            p = this.nextFetchFunction;\n            this.nextFetchFunction = undefined;\n          } else {\n            logger.verbose(\"using fresh fetch\");\n            p = this.fetchFunctions[this.currentPartitionIndex](\n              childDiagnosticNode,\n              this.options,\n              this.correlatedActivityId,\n            );\n          }\n          const response = await p;\n          resources = response.result;\n          childDiagnosticNode.recordQueryResult(resources, CosmosDbDiagnosticLevel.debugUnsafe);\n          responseHeaders = response.headers;\n          this.continuationToken = responseHeaders[Constants.HttpHeaders.Continuation];\n          if (!this.continuationToken) {\n            ++this.currentPartitionIndex;\n          }\n\n          if (this.options && this.options.bufferItems === true) {\n            const fetchFunction = this.fetchFunctions[this.currentPartitionIndex];\n            this.nextFetchFunction = fetchFunction\n              ? fetchFunction(\n                  childDiagnosticNode,\n                  {\n                    ...this.options,\n                    continuationToken: this.continuationToken,\n                  },\n                  this.correlatedActivityId,\n                )\n              : undefined;\n          }\n        } catch (err: any) {\n          this.state = DefaultQueryExecutionContext.STATES.ended;\n          // return callback(err, undefined, responseHeaders);\n          // TODO: Error and data being returned is an antipattern, this might broken\n          throw err;\n        }\n\n        this.state = DefaultQueryExecutionContext.STATES.inProgress;\n        this.currentIndex = 0;\n        this.options.continuationToken = originalContinuation;\n        this.options.continuation = originalContinuation;\n\n        // deserializing query metrics so that we aren't working with delimited strings in the rest of the code base\n        if (Constants.HttpHeaders.QueryMetrics in responseHeaders) {\n          const delimitedString = responseHeaders[Constants.HttpHeaders.QueryMetrics];\n          let queryMetrics = QueryMetrics.createFromDelimitedString(delimitedString);\n\n          // Add the request charge to the query metrics so that we can have per partition request charge.\n          if (Constants.HttpHeaders.RequestCharge in responseHeaders) {\n            const requestCharge = Number(responseHeaders[Constants.HttpHeaders.RequestCharge]) || 0;\n            queryMetrics = new QueryMetrics(\n              queryMetrics.retrievedDocumentCount,\n              queryMetrics.retrievedDocumentSize,\n              queryMetrics.outputDocumentCount,\n              queryMetrics.outputDocumentSize,\n              queryMetrics.indexHitDocumentCount,\n              queryMetrics.totalQueryExecutionTime,\n              queryMetrics.queryPreparationTimes,\n              queryMetrics.indexLookupTime,\n              queryMetrics.documentLoadTime,\n              queryMetrics.vmExecutionTime,\n              queryMetrics.runtimeExecutionTimes,\n              queryMetrics.documentWriteTime,\n              new ClientSideMetrics(requestCharge),\n            );\n          }\n\n          // Wraping query metrics in a object where the key is '0' just so single partition\n          // and partition queries have the same response schema\n          responseHeaders[Constants.HttpHeaders.QueryMetrics] = {};\n          responseHeaders[Constants.HttpHeaders.QueryMetrics][\"0\"] = queryMetrics;\n        }\n\n        return { result: resources, headers: responseHeaders };\n      },\n      diagnosticNode,\n      DiagnosticNodeType.DEFAULT_QUERY_NODE,\n      {\n        queryMethodIdentifier: \"fetchMore\",\n      },\n    );\n  }\n\n  private _canFetchMore(): boolean {\n    const res =\n      this.state === DefaultQueryExecutionContext.STATES.start ||\n      (this.continuationToken && this.state === DefaultQueryExecutionContext.STATES.inProgress) ||\n      (this.currentPartitionIndex < this.fetchFunctions.length &&\n        this.state === DefaultQueryExecutionContext.STATES.inProgress);\n    return res;\n  }\n}\n"]}

package/dist/browser/queryExecutionContext/documentProducer.d.ts

@@ -6,7 +6,7 @@ import type { Response } from "../request/index.js";
 import type { FetchFunctionCallback } from "./defaultQueryExecutionContext.js";
 import { FetchResult } from "./FetchResult.js";
 import type { CosmosHeaders } from "./headerUtils.js";
-import type { SqlQuerySpec } from "./index.js";
+import type { SqlQuerySpec, FilterStrategy } from "./index.js";
 /** @hidden */
 export declare class DocumentProducer {
     private clientContext;
@@ -23,6 +23,8 @@ export declare class DocumentProducer {
     startEpk: string;
     endEpk: string;
     populateEpkRangeHeaders: boolean;
+    private filter?;
+    private queryExecutionInfo?;
     /**
      * Provides the Target Partition Range Query Execution Context.
      * @param clientContext  - The service endpoint to use to create the client.
@@ -31,7 +33,7 @@ export declare class DocumentProducer {
      * @param targetPartitionKeyRange - Query Target Partition key Range
      * @hidden
      */
-    constructor(clientContext: ClientContext, collectionLink: string, query: SqlQuerySpec, targetPartitionKeyRange: PartitionKeyRange, options: FeedOptions, correlatedActivityId: string, startEpk?: string, endEpk?: string, populateEpkRangeHeaders?: boolean);
+    constructor(clientContext: ClientContext, collectionLink: string, query: SqlQuerySpec, targetPartitionKeyRange: PartitionKeyRange, options: FeedOptions, correlatedActivityId: string, startEpk?: string, endEpk?: string, populateEpkRangeHeaders?: boolean, filter?: FilterStrategy);
     peekBufferedItems(): any[];
     fetchFunction: FetchFunctionCallback;
     hasMoreResults(): boolean;
@@ -42,7 +44,7 @@ export declare class DocumentProducer {
      * Fetches and bufferes the next page of results in internal buffer
      */
     bufferMore(diagnosticNode: DiagnosticNodeInternal): Promise<CosmosHeaders>;
-    getTargetParitionKeyRange(): PartitionKeyRange;
+    getTargetPartitionKeyRange(): PartitionKeyRange;
     /**
      * Peak the next item in the buffer
      */
@@ -59,5 +61,9 @@ export declare class DocumentProducer {
      * Retrieve the current element on the DocumentProducer.
      */
     private current;
+    getQueryExecutionInfo(): {
+        reverseRidEnabled: boolean;
+        reverseIndexScan: boolean;
+    } | undefined;
 }
 //# sourceMappingURL=documentProducer.d.ts.map

package/dist/browser/queryExecutionContext/documentProducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documentProducer.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/documentProducer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAY,MAAM,oBAAoB,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AASzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAmB,MAAM,kBAAkB,CAAC;AAEhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,cAAc;AACd,qBAAa,gBAAgB;IAwBzB,OAAO,CAAC,aAAa;IAvBvB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,KAAK,CAAwB;IAC9B,uBAAuB,EAAE,iBAAiB,CAAC;IAC3C,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAQ;IACZ,yBAAyB,EAAE,MAAM,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAK;IAC9B,OAAO,CAAC,wBAAwB,CAA+B;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB,EAAE,OAAO,CAAC;IAExC;;;;;;;OAOG;gBAEO,aAAa,EAAE,aAAa,EACpC,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,YAAY,EACnB,uBAAuB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,WAAW,EACpB,oBAAoB,EAAE,MAAM,EAC5B,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,uBAAuB,GAAE,OAAe;IAuBnC,iBAAiB,IAAI,GAAG,EAAE;IAmB1B,aAAa,EAAE,qBAAqB,CAwBzC;IAEK,cAAc,IAAI,OAAO;IAIzB,QAAQ,IAAI,OAAO;IAY1B,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,MAAM,CAAC,kCAAkC;IASjD;;OAEG;IACU,UAAU,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;IAkDhF,yBAAyB,IAAI,iBAAiB;IAGrD;;OAEG;IACI,YAAY,IAAI,GAAG;IAqB1B;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAoBpD;;OAEG;IACU,kBAAkB,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;IA6B3D;;OAEG;IACH,OAAO,CAAC,OAAO;CAiChB"}
+{"version":3,"file":"documentProducer.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/documentProducer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAY,MAAM,oBAAoB,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AASzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAmB,MAAM,kBAAkB,CAAC;AAEhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE/D,cAAc;AACd,qBAAa,gBAAgB;IA0BzB,OAAO,CAAC,aAAa;IAzBvB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,KAAK,CAAwB;IAC9B,uBAAuB,EAAE,iBAAiB,CAAC;IAC3C,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAQ;IACZ,yBAAyB,EAAE,MAAM,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAK;IAC9B,OAAO,CAAC,wBAAwB,CAA+B;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB,EAAE,OAAO,CAAC;IACxC,OAAO,CAAC,MAAM,CAAC,CAAiB;IAChC,OAAO,CAAC,kBAAkB,CAAC,CAA4D;IAEvF;;;;;;;OAOG;gBAEO,aAAa,EAAE,aAAa,EACpC,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,YAAY,EACnB,uBAAuB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,WAAW,EACpB,oBAAoB,EAAE,MAAM,EAC5B,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,uBAAuB,GAAE,OAAe,EACxC,MAAM,CAAC,EAAE,cAAc;IAwBlB,iBAAiB,IAAI,GAAG,EAAE;IAmB1B,aAAa,EAAE,qBAAqB,CAwBzC;IAEK,cAAc,IAAI,OAAO;IAIzB,QAAQ,IAAI,OAAO;IAY1B,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,MAAM,CAAC,kCAAkC;IASjD;;OAEG;IACU,UAAU,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;IA2DhF,0BAA0B,IAAI,iBAAiB;IAGtD;;OAEG;IACI,YAAY,IAAI,GAAG;IAqB1B;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAoBpD;;OAEG;IACU,kBAAkB,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;IA6B3D;;OAEG;IACH,OAAO,CAAC,OAAO;IAkCR,qBAAqB,IACxB;QAAE,iBAAiB,EAAE,OAAO,CAAC;QAAC,gBAAgB,EAAE,OAAO,CAAA;KAAE,GACzD,SAAS;CAGd"}

package/dist/browser/queryExecutionContext/documentProducer.js

@@ -18,6 +18,8 @@ export class DocumentProducer {
     startEpk;
     endEpk;
     populateEpkRangeHeaders;
+    filter;
+    queryExecutionInfo;
     /**
      * Provides the Target Partition Range Query Execution Context.
      * @param clientContext  - The service endpoint to use to create the client.
@@ -26,7 +28,7 @@ export class DocumentProducer {
      * @param targetPartitionKeyRange - Query Target Partition key Range
      * @hidden
      */
-    constructor(clientContext, collectionLink, query, targetPartitionKeyRange, options, correlatedActivityId, startEpk, endEpk, populateEpkRangeHeaders = false) {
+    constructor(clientContext, collectionLink, query, targetPartitionKeyRange, options, correlatedActivityId, startEpk, endEpk, populateEpkRangeHeaders = false, filter) {
         this.clientContext = clientContext;
         // TODO: any options
         this.collectionLink = collectionLink;
@@ -41,6 +43,7 @@ export class DocumentProducer {
         this.startEpk = startEpk;
         this.endEpk = endEpk;
         this.populateEpkRangeHeaders = populateEpkRangeHeaders;
+        this.filter = filter;
     }
     peekBufferedItems() {
         const bufferedResults = [];
@@ -123,9 +126,16 @@ export class DocumentProducer {
             throw this.err;
         }
         try {
-            const { result: resources, headers: headerResponse } = await this.internalExecutionContext.fetchMore(diagnosticNode);
+            const { result: resourcesResult, headers: headerResponse } = await this.internalExecutionContext.fetchMore(diagnosticNode);
+            let resources = resourcesResult;
             ++this.generation;
             this._updateStates(undefined, resources === undefined);
+            if (headerResponse && headerResponse["x-ms-cosmos-query-execution-info"]) {
+                this.queryExecutionInfo = JSON.parse(headerResponse["x-ms-cosmos-query-execution-info"]);
+            }
+            if (this.filter && resources) {
+                resources = this.filter.applyFilter(resources);
+            }
             if (resources !== undefined) {
                 // add fetched header to the 1st element in the buffer
                 let addHeaderToFetchResult = true;
@@ -159,7 +169,7 @@ export class DocumentProducer {
             }
         }
     }
-    getTargetParitionKeyRange() {
+    getTargetPartitionKeyRange() {
         return this.targetPartitionKeyRange;
     }
     /**
@@ -199,7 +209,7 @@ export class DocumentProducer {
             if (result === undefined || result.length === 0) {
                 return { result: undefined, headers };
             }
-            return { result, headers }; //
+            return { result, headers };
         }
         catch (err) {
             this._updateStates(err, err.item === undefined);
@@ -273,5 +283,8 @@ export class DocumentProducer {
         // If the internal buffer is empty, return empty result
         return { result: [], headers: getInitialHeader() };
     }
+    getQueryExecutionInfo() {
+        return this.queryExecutionInfo;
+    }
 }
 //# sourceMappingURL=documentProducer.js.map