@azure/cosmos 4.8.0 → 4.9.0

package/dist/esm/documents/ContinuationToken/CompositeQueryContinuationToken.js

@@ -0,0 +1,84 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { QueryRange } from "../../routing/QueryRange.js";
+/**
+ * Creates a new CompositeQueryContinuationToken
+ * @hidden
+ */
+export function createCompositeQueryContinuationToken(rid, rangeMappings, offset, limit) {
+    if (!rangeMappings || rangeMappings.length === 0) {
+        throw new Error("Failed to create composite continuation token: No partition range mappings provided. " +
+            "This typically indicates an issue with query execution context initialization or partition key range resolution. " +
+            "Ensure the query is properly configured and the container has valid partition ranges.");
+    }
+    return {
+        rid,
+        rangeMappings: rangeMappings,
+        offset,
+        limit,
+    };
+}
+/**
+ * Serializes the composite continuation token to a JSON string
+ * @hidden
+ */
+export function serializeCompositeToken(token) {
+    return JSON.stringify(token);
+}
+/**
+ * Deserializes a JSON string to a CompositeQueryContinuationToken
+ * @hidden
+ */
+export function parseCompositeQueryContinuationToken(tokenString) {
+    return JSON.parse(tokenString);
+}
+/**
+ * Deserializes a JSON string to a CompositeQueryContinuationToken
+ * @hidden
+ */
+export function parseBaseContinuationToken(tokenString) {
+    return JSON.parse(tokenString);
+}
+/**
+ * Converts QueryRangeMapping to QueryRangeWithContinuationToken using simplified range format
+ * @param rangeMapping - The QueryRangeMapping to convert
+ * @returns QueryRangeWithContinuationToken with simplified boundaries and continuation token
+ * @hidden
+ */
+export function convertRangeMappingToQueryRange(rangeMapping) {
+    if (!rangeMapping.partitionKeyRange) {
+        throw new Error("Failed to convert range mapping: Missing partition key range information. " +
+            "The QueryRangeMapping object must contain a valid partitionKeyRange with min and max boundaries. " +
+            "This may indicate an incomplete partition key range resolution during query setup.");
+    }
+    const pkRange = rangeMapping.partitionKeyRange;
+    // Create simplified range assuming min is inclusive and max is exclusive
+    const simplifiedRange = {
+        min: pkRange.minInclusive,
+        max: pkRange.maxExclusive,
+    };
+    return {
+        queryRange: simplifiedRange,
+        continuationToken: rangeMapping.continuationToken,
+    };
+}
+/**
+ * Converts an array of QueryRangeMapping to an array of QueryRangeWithContinuationToken
+ * @param rangeMappings - Array of QueryRangeMapping to convert
+ * @returns Array of QueryRangeWithContinuationToken with simplified boundaries and continuation tokens
+ * @hidden
+ */
+export function convertRangeMappingsToQueryRangesWithTokens(rangeMappings) {
+    return rangeMappings.map((mapping) => convertRangeMappingToQueryRange(mapping));
+}
+/**
+ * Converts a SimplifiedQueryRange back to a QueryRange for internal use
+ * @param simplifiedRange - The simplified range to convert
+ * @returns QueryRange with standard assumptions (min inclusive, max exclusive)
+ * @hidden
+ */
+export function convertSimplifiedRangeToQueryRange(simplifiedRange) {
+    return new QueryRange(simplifiedRange.min, simplifiedRange.max, true, // minInclusive = true (assumption)
+    false);
+}
+//# sourceMappingURL=CompositeQueryContinuationToken.js.map

package/dist/esm/documents/ContinuationToken/CompositeQueryContinuationToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositeQueryContinuationToken.js","sourceRoot":"","sources":["../../../../src/documents/ContinuationToken/CompositeQueryContinuationToken.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAiDzD;;;GAGG;AACH,MAAM,UAAU,qCAAqC,CACnD,GAAW,EACX,aAAgD,EAChD,MAAe,EACf,KAAc;IAEd,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CACb,uFAAuF;YACrF,mHAAmH;YACnH,uFAAuF,CAC1F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG;QACH,aAAa,EAAE,aAAa;QAC5B,MAAM;QACN,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAsC;IAC5E,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oCAAoC,CAClD,WAAmB;IAEnB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAAC,WAAmB;IAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AACjC,CAAC;AAkBD;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAC7C,YAA+B;IAE/B,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CACb,4EAA4E;YAC1E,mGAAmG;YACnG,oFAAoF,CACvF,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,iBAAiB,CAAC;IAE/C,yEAAyE;IACzE,MAAM,eAAe,GAAkB;QACrC,GAAG,EAAE,OAAO,CAAC,YAAY;QACzB,GAAG,EAAE,OAAO,CAAC,YAAY;KAC1B,CAAC;IAEF,OAAO;QACL,UAAU,EAAE,eAAe;QAC3B,iBAAiB,EAAE,YAAY,CAAC,iBAAiB;KAClD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2CAA2C,CACzD,aAAkC;IAElC,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC,CAAC;AAClF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kCAAkC,CAAC,eAA8B;IAC/E,OAAO,IAAI,UAAU,CACnB,eAAe,CAAC,GAAG,EACnB,eAAe,CAAC,GAAG,EACnB,IAAI,EAAE,mCAAmC;IACzC,KAAK,CACN,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { QueryRange } from \"../../routing/QueryRange.js\";\nimport type { QueryRangeMapping } from \"../../queryExecutionContext/queryRangeMapping.js\";\n\n/**\n * @hidden\n */\nexport interface RangeBoundary {\n  /**\n   * Minimum boundary (inclusive)\n   */\n  min: string;\n  /**\n   * Maximum boundary (exclusive)\n   */\n  max: string;\n}\n\n/**\n * @hidden\n * Base interface for all continuation tokens containing common fields\n */\nexport interface BaseContinuationToken {\n  /**\n   * Resource ID of the container for which the continuation token is issued\n   */\n  rid: string;\n\n  /**\n   * List of query ranges with their continuation tokens\n   */\n  rangeMappings: QueryRangeWithContinuationToken[];\n\n  /**\n   * Current offset value for OFFSET/LIMIT queries\n   */\n  offset?: number;\n\n  /**\n   * Current limit value for OFFSET/LIMIT queries\n   */\n  limit?: number;\n}\n\n/**\n * @hidden\n * Composite continuation token for parallel query execution across multiple partition ranges\n */\nexport interface CompositeQueryContinuationToken extends BaseContinuationToken {}\n\n/**\n * Creates a new CompositeQueryContinuationToken\n * @hidden\n */\nexport function createCompositeQueryContinuationToken(\n  rid: string,\n  rangeMappings: QueryRangeWithContinuationToken[],\n  offset?: number,\n  limit?: number,\n): CompositeQueryContinuationToken {\n  if (!rangeMappings || rangeMappings.length === 0) {\n    throw new Error(\n      \"Failed to create composite continuation token: No partition range mappings provided. \" +\n        \"This typically indicates an issue with query execution context initialization or partition key range resolution. \" +\n        \"Ensure the query is properly configured and the container has valid partition ranges.\",\n    );\n  }\n\n  return {\n    rid,\n    rangeMappings: rangeMappings,\n    offset,\n    limit,\n  };\n}\n\n/**\n * Serializes the composite continuation token to a JSON string\n * @hidden\n */\nexport function serializeCompositeToken(token: CompositeQueryContinuationToken): string {\n  return JSON.stringify(token);\n}\n\n/**\n * Deserializes a JSON string to a CompositeQueryContinuationToken\n * @hidden\n */\nexport function parseCompositeQueryContinuationToken(\n  tokenString: string,\n): CompositeQueryContinuationToken {\n  return JSON.parse(tokenString);\n}\n\n/**\n * Deserializes a JSON string to a CompositeQueryContinuationToken\n * @hidden\n */\nexport function parseBaseContinuationToken(tokenString: string): BaseContinuationToken {\n  return JSON.parse(tokenString);\n}\n\n/**\n * @hidden\n * Represents a query range with its associated continuation token\n */\nexport interface QueryRangeWithContinuationToken {\n  /**\n   * The simplified query range containing min/max boundaries\n   */\n  queryRange: RangeBoundary;\n\n  /**\n   * The continuation token for this specific range\n   */\n  continuationToken: string | undefined;\n}\n\n/**\n * Converts QueryRangeMapping to QueryRangeWithContinuationToken using simplified range format\n * @param rangeMapping - The QueryRangeMapping to convert\n * @returns QueryRangeWithContinuationToken with simplified boundaries and continuation token\n * @hidden\n */\nexport function convertRangeMappingToQueryRange(\n  rangeMapping: QueryRangeMapping,\n): QueryRangeWithContinuationToken {\n  if (!rangeMapping.partitionKeyRange) {\n    throw new Error(\n      \"Failed to convert range mapping: Missing partition key range information. \" +\n        \"The QueryRangeMapping object must contain a valid partitionKeyRange with min and max boundaries. \" +\n        \"This may indicate an incomplete partition key range resolution during query setup.\",\n    );\n  }\n\n  const pkRange = rangeMapping.partitionKeyRange;\n\n  // Create simplified range assuming min is inclusive and max is exclusive\n  const simplifiedRange: RangeBoundary = {\n    min: pkRange.minInclusive,\n    max: pkRange.maxExclusive,\n  };\n\n  return {\n    queryRange: simplifiedRange,\n    continuationToken: rangeMapping.continuationToken,\n  };\n}\n\n/**\n * Converts an array of QueryRangeMapping to an array of QueryRangeWithContinuationToken\n * @param rangeMappings - Array of QueryRangeMapping to convert\n * @returns Array of QueryRangeWithContinuationToken with simplified boundaries and continuation tokens\n * @hidden\n */\nexport function convertRangeMappingsToQueryRangesWithTokens(\n  rangeMappings: QueryRangeMapping[],\n): QueryRangeWithContinuationToken[] {\n  return rangeMappings.map((mapping) => convertRangeMappingToQueryRange(mapping));\n}\n\n/**\n * Converts a SimplifiedQueryRange back to a QueryRange for internal use\n * @param simplifiedRange - The simplified range to convert\n * @returns QueryRange with standard assumptions (min inclusive, max exclusive)\n * @hidden\n */\nexport function convertSimplifiedRangeToQueryRange(simplifiedRange: RangeBoundary): QueryRange {\n  return new QueryRange(\n    simplifiedRange.min,\n    simplifiedRange.max,\n    true, // minInclusive = true (assumption)\n    false, // maxInclusive = false (max is exclusive, assumption)\n  );\n}\n"]}

package/dist/esm/documents/ContinuationToken/OrderByQueryContinuationToken.d.ts

@@ -0,0 +1,40 @@
+import type { QueryRangeWithContinuationToken, BaseContinuationToken } from "./CompositeQueryContinuationToken.js";
+/**
+ * Continuation token for order by queries.
+ * @hidden
+ */
+export interface OrderByQueryContinuationToken extends BaseContinuationToken {
+    /**
+     * Order by items for the query
+     */
+    orderByItems: any[];
+    /**
+     * Number of items to skip in the query
+     */
+    skipCount: number;
+    /**
+     * Document ID of the last document result
+     */
+    documentRid: string;
+    /**
+     * Hash of the last document result for distinct order queries
+     * Used to ensure duplicates are not returned across continuation boundaries
+     */
+    hashedLastResult?: string;
+}
+/**
+ * Creates an OrderByQueryContinuationToken
+ * @hidden
+ */
+export declare function createOrderByQueryContinuationToken(rangeMappings: QueryRangeWithContinuationToken[], orderByItems: any[], rid: string, skipCount: number, documentRid?: string, offset?: number, limit?: number, hashedLastResult?: string): OrderByQueryContinuationToken;
+/**
+ * Serializes an OrderByQueryContinuationToken to a JSON string
+ * @hidden
+ */
+export declare function serializeOrderByQueryContinuationToken(token: OrderByQueryContinuationToken): string;
+/**
+ * Deserializes a JSON string to an OrderByQueryContinuationToken
+ * @hidden
+ */
+export declare function parseOrderByQueryContinuationToken(tokenString: string): OrderByQueryContinuationToken;
+//# sourceMappingURL=OrderByQueryContinuationToken.d.ts.map

package/dist/esm/documents/ContinuationToken/OrderByQueryContinuationToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderByQueryContinuationToken.d.ts","sourceRoot":"","sources":["../../../../src/documents/ContinuationToken/OrderByQueryContinuationToken.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,+BAA+B,EAC/B,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;OAEG;IACH,YAAY,EAAE,GAAG,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,wBAAgB,mCAAmC,CACjD,aAAa,EAAE,+BAA+B,EAAE,EAChD,YAAY,EAAE,GAAG,EAAE,EACnB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,gBAAgB,CAAC,EAAE,MAAM,GACxB,6BAA6B,CAmB/B;AAED;;;GAGG;AACH,wBAAgB,sCAAsC,CACpD,KAAK,EAAE,6BAA6B,GACnC,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,kCAAkC,CAChD,WAAW,EAAE,MAAM,GAClB,6BAA6B,CAE/B"}

package/dist/esm/documents/ContinuationToken/OrderByQueryContinuationToken.js

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Creates an OrderByQueryContinuationToken
+ * @hidden
+ */
+export function createOrderByQueryContinuationToken(rangeMappings, orderByItems, rid, skipCount, documentRid, offset, limit, hashedLastResult) {
+    if (!rangeMappings || rangeMappings.length === 0) {
+        throw new Error("rangeMappings must contain at least one element");
+    }
+    if (!orderByItems || orderByItems.length === 0) {
+        throw new Error("orderByItems must contain at least one element");
+    }
+    return {
+        rangeMappings,
+        orderByItems,
+        rid,
+        skipCount,
+        documentRid,
+        offset,
+        limit,
+        hashedLastResult,
+    };
+}
+/**
+ * Serializes an OrderByQueryContinuationToken to a JSON string
+ * @hidden
+ */
+export function serializeOrderByQueryContinuationToken(token) {
+    return JSON.stringify(token);
+}
+/**
+ * Deserializes a JSON string to an OrderByQueryContinuationToken
+ * @hidden
+ */
+export function parseOrderByQueryContinuationToken(tokenString) {
+    return JSON.parse(tokenString);
+}
+//# sourceMappingURL=OrderByQueryContinuationToken.js.map

package/dist/esm/documents/ContinuationToken/OrderByQueryContinuationToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderByQueryContinuationToken.js","sourceRoot":"","sources":["../../../../src/documents/ContinuationToken/OrderByQueryContinuationToken.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkClC;;;GAGG;AACH,MAAM,UAAU,mCAAmC,CACjD,aAAgD,EAChD,YAAmB,EACnB,GAAW,EACX,SAAiB,EACjB,WAAoB,EACpB,MAAe,EACf,KAAc,EACd,gBAAyB;IAEzB,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED,OAAO;QACL,aAAa;QACb,YAAY;QACZ,GAAG;QACH,SAAS;QACT,WAAW;QACX,MAAM;QACN,KAAK;QACL,gBAAgB;KACgB,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sCAAsC,CACpD,KAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kCAAkC,CAChD,WAAmB;IAEnB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  QueryRangeWithContinuationToken,\n  BaseContinuationToken,\n} from \"./CompositeQueryContinuationToken.js\";\n\n/**\n * Continuation token for order by queries.\n * @hidden\n */\nexport interface OrderByQueryContinuationToken extends BaseContinuationToken {\n  /**\n   * Order by items for the query\n   */\n  orderByItems: any[];\n\n  /**\n   * Number of items to skip in the query\n   */\n  skipCount: number;\n\n  /**\n   * Document ID of the last document result\n   */\n  documentRid: string;\n\n  /**\n   * Hash of the last document result for distinct order queries\n   * Used to ensure duplicates are not returned across continuation boundaries\n   */\n  hashedLastResult?: string;\n}\n\n/**\n * Creates an OrderByQueryContinuationToken\n * @hidden\n */\nexport function createOrderByQueryContinuationToken(\n  rangeMappings: QueryRangeWithContinuationToken[],\n  orderByItems: any[],\n  rid: string,\n  skipCount: number,\n  documentRid?: string,\n  offset?: number,\n  limit?: number,\n  hashedLastResult?: string,\n): OrderByQueryContinuationToken {\n  if (!rangeMappings || rangeMappings.length === 0) {\n    throw new Error(\"rangeMappings must contain at least one element\");\n  }\n\n  if (!orderByItems || orderByItems.length === 0) {\n    throw new Error(\"orderByItems must contain at least one element\");\n  }\n\n  return {\n    rangeMappings,\n    orderByItems,\n    rid,\n    skipCount,\n    documentRid,\n    offset,\n    limit,\n    hashedLastResult,\n  } as OrderByQueryContinuationToken;\n}\n\n/**\n * Serializes an OrderByQueryContinuationToken to a JSON string\n * @hidden\n */\nexport function serializeOrderByQueryContinuationToken(\n  token: OrderByQueryContinuationToken,\n): string {\n  return JSON.stringify(token);\n}\n\n/**\n * Deserializes a JSON string to an OrderByQueryContinuationToken\n * @hidden\n */\nexport function parseOrderByQueryContinuationToken(\n  tokenString: string,\n): OrderByQueryContinuationToken {\n  return JSON.parse(tokenString);\n}\n"]}

package/dist/esm/documents/ContinuationToken/PartitionRangeUpdate.d.ts

@@ -0,0 +1,21 @@
+import type { QueryRange } from "../../index.js";
+/**
+ * Represents information about a partition range update that occurred during query execution.
+ * This includes the original range, new ranges after split/merge, and the continuation token.
+ * @hidden
+ */
+export interface PartitionRangeUpdate {
+    /** The original partition key range before the split/merge operation */
+    oldRange: QueryRange;
+    /** The new partition key ranges after the split/merge operation */
+    newRanges: QueryRange[];
+    /** The continuation token associated with this range update */
+    continuationToken: string | undefined;
+}
+/**
+ * A collection of partition range updates indexed by range keys.
+ * The key is typically in the format "minInclusive-maxExclusive".
+ * @hidden
+ */
+export type PartitionRangeUpdates = Record<string, PartitionRangeUpdate>;
+//# sourceMappingURL=PartitionRangeUpdate.d.ts.map

package/dist/esm/documents/ContinuationToken/PartitionRangeUpdate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PartitionRangeUpdate.d.ts","sourceRoot":"","sources":["../../../../src/documents/ContinuationToken/PartitionRangeUpdate.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,wEAAwE;IACxE,QAAQ,EAAE,UAAU,CAAC;IACrB,mEAAmE;IACnE,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB,+DAA+D;IAC/D,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC"}

package/dist/esm/documents/ContinuationToken/PartitionRangeUpdate.js

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

package/dist/esm/documents/ContinuationToken/PartitionRangeUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PartitionRangeUpdate.js","sourceRoot":"","sources":["../../../../src/documents/ContinuationToken/PartitionRangeUpdate.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { QueryRange } from \"../../index.js\";\n\n/**\n * Represents information about a partition range update that occurred during query execution.\n * This includes the original range, new ranges after split/merge, and the continuation token.\n * @hidden\n */\nexport interface PartitionRangeUpdate {\n  /** The original partition key range before the split/merge operation */\n  oldRange: QueryRange;\n  /** The new partition key ranges after the split/merge operation */\n  newRanges: QueryRange[];\n  /** The continuation token associated with this range update */\n  continuationToken: string | undefined;\n}\n\n/**\n * A collection of partition range updates indexed by range keys.\n * The key is typically in the format \"minInclusive-maxExclusive\".\n * @hidden\n */\nexport type PartitionRangeUpdates = Record<string, PartitionRangeUpdate>;\n"]}

package/dist/esm/queryExecutionContext/ContinuationTokenManager/BaseContinuationTokenManager.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=BaseContinuationTokenManager.d.ts.map

package/dist/esm/queryExecutionContext/ContinuationTokenManager/BaseContinuationTokenManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseContinuationTokenManager.d.ts","sourceRoot":"","sources":["../../../../src/queryExecutionContext/ContinuationTokenManager/BaseContinuationTokenManager.ts"],"names":[],"mappings":""}

package/dist/esm/queryExecutionContext/ContinuationTokenManager/BaseContinuationTokenManager.js

@@ -0,0 +1,174 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { parseBaseContinuationToken, } from "../../documents/ContinuationToken/CompositeQueryContinuationToken.js";
+import { PartitionRangeManager } from "../PartitionRangeManager.js";
+/**
+ * Base abstract class for continuation token management.
+ * Provides common functionality shared between parallel and ORDER BY query token managers.
+ * @internal
+ */
+export class BaseContinuationTokenManager {
+    ranges = [];
+    partitionRangeManager = new PartitionRangeManager();
+    constructor(initialContinuationToken) {
+        if (initialContinuationToken) {
+            const token = parseBaseContinuationToken(initialContinuationToken);
+            if (token?.rangeMappings) {
+                this.ranges = token.rangeMappings;
+            }
+        }
+    }
+    /**
+     * Provides controlled access to partition range manager for subclasses.
+     * This is the only protected access point needed.
+     */
+    get partitionManager() {
+        return this.partitionRangeManager;
+    }
+    /**
+     * Provides controlled access to ranges for subclasses.
+     * Made protected to allow subclass range management.
+     */
+    get rangeList() {
+        return this.ranges;
+    }
+    /**
+     * Processes query results and generates continuation tokens for pagination.
+     * Handles response data processing, range management, and token generation.
+     *
+     * @param pageSize - Maximum number of items to return in this page
+     * @param isResponseEmpty - Whether the current response contains no data
+     * @param responseResult - Optional response data containing partition mappings and query-specific data
+     * @returns Object containing the end index for slicing results and optional continuation token for next page
+     */
+    paginateResults(pageSize, isResponseEmpty, responseResult) {
+        // Process response data
+        if (responseResult) {
+            this.processResponseResult(responseResult);
+        }
+        this.removeExhaustedRangesFromRanges();
+        const result = this.processRangesForPagination(pageSize, isResponseEmpty);
+        const tokenString = this.generateContinuationTokenString();
+        // Clean up processed ranges
+        this.trimProcessedData(result.processedRanges, result.endIndex);
+        return {
+            endIndex: result.endIndex,
+            continuationToken: tokenString,
+        };
+    }
+    /**
+     * Generates continuation token string using the appropriate serialization function.
+     * This provides a common implementation that delegates to query-specific logic.
+     */
+    generateContinuationTokenString() {
+        const token = this.getCurrentContinuationToken();
+        if (!token) {
+            return undefined;
+        }
+        const serializeFunction = this.getSerializationFunction();
+        return serializeFunction(token);
+    }
+    /**
+     * Cleans up processed data after a page has been returned.
+     * Handles both common and query-specific cleanup.
+     */
+    trimProcessedData(processedRanges, endIndex) {
+        processedRanges.forEach((rangeId) => {
+            this.partitionRangeManager.removePartitionRangeMapping(rangeId);
+        });
+        // Delegate query-specific cleanup to subclass
+        this.performQuerySpecificDataTrim(processedRanges, endIndex);
+    }
+    addPartitionKeyRangeMap(partitionKeyRangeMap) {
+        this.partitionRangeManager.addPartitionKeyRangeMap(partitionKeyRangeMap);
+    }
+    /**
+     * Processes the entire response result and updates the continuation token manager state.
+     * This encapsulates all response handling logic in one place.
+     */
+    processResponseResult(responseResult) {
+        // Handle partition key range map
+        if (responseResult.partitionKeyRangeMap) {
+            this.addPartitionKeyRangeMap(responseResult.partitionKeyRangeMap);
+        }
+        // Handle partition range updates
+        if (responseResult.updatedContinuationRanges) {
+            this.handlePartitionRangeChanges(responseResult.updatedContinuationRanges);
+        }
+        this.processQuerySpecificResponse(responseResult);
+    }
+    isPartitionExhausted(continuationToken) {
+        return (!continuationToken ||
+            continuationToken === "" ||
+            continuationToken === "null" ||
+            continuationToken.toLowerCase() === "null");
+    }
+    removeExhaustedRangesFromRanges() {
+        if (!this.ranges || !Array.isArray(this.ranges)) {
+            return;
+        }
+        this.ranges = this.ranges.filter((mapping) => {
+            if (!mapping) {
+                return false;
+            }
+            const isExhausted = this.isPartitionExhausted(mapping.continuationToken);
+            return !isExhausted;
+        });
+    }
+    handlePartitionRangeChanges(updatedContinuationRanges) {
+        if (updatedContinuationRanges && Object.keys(updatedContinuationRanges).length === 0) {
+            return;
+        }
+        Object.entries(updatedContinuationRanges).forEach(([rangeKey, rangeChange]) => {
+            this.processRangeChange(rangeKey, rangeChange);
+        });
+    }
+    processRangeChange(_rangeKey, rangeChange) {
+        const { oldRange, newRanges, continuationToken } = rangeChange;
+        if (newRanges.length === 1) {
+            this.handleRangeMerge(oldRange, newRanges[0], continuationToken);
+        }
+        else {
+            this.handleRangeSplit(oldRange, newRanges, continuationToken);
+        }
+    }
+    handleRangeMerge(oldRange, newRange, continuationToken) {
+        // Find existing range mapping to update in the common ranges array
+        const existingMappingIndex = this.ranges.findIndex((mapping) => mapping.queryRange.min === oldRange.min && mapping.queryRange.max === oldRange.max);
+        if (existingMappingIndex < 0) {
+            return;
+        }
+        // Update existing mapping with new range properties
+        const existingMapping = this.ranges[existingMappingIndex];
+        // Create new simplified QueryRange with updated boundaries
+        const updatedQueryRange = {
+            min: newRange.min,
+            max: newRange.max,
+        };
+        // Update the mapping
+        existingMapping.queryRange = updatedQueryRange;
+        existingMapping.continuationToken = continuationToken;
+    }
+    handleRangeSplit(oldRange, newRanges, continuationToken) {
+        // Remove the old range mapping from the common ranges array
+        this.ranges = this.ranges.filter((mapping) => !(mapping.queryRange.min === oldRange.min && mapping.queryRange.max === oldRange.max));
+        // Add new range mappings for each split range
+        newRanges.forEach((newRange) => {
+            this.createNewRangeMapping(newRange, continuationToken);
+        });
+    }
+    createNewRangeMapping(partitionKeyRange, continuationToken) {
+        // Create new simplified QueryRange
+        const queryRange = {
+            min: partitionKeyRange.min,
+            max: partitionKeyRange.max,
+        };
+        // Create new QueryRangeWithContinuationToken
+        const newRangeWithToken = {
+            queryRange: queryRange,
+            continuationToken: continuationToken,
+        };
+        this.ranges.push(newRangeWithToken);
+    }
+}
+//# sourceMappingURL=BaseContinuationTokenManager.js.map

package/dist/esm/queryExecutionContext/ContinuationTokenManager/BaseContinuationTokenManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseContinuationTokenManager.js","sourceRoot":"","sources":["../../../../src/queryExecutionContext/ContinuationTokenManager/BaseContinuationTokenManager.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EACL,0BAA0B,GAG3B,MAAM,sEAAsE,CAAC;AAK9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE;;;;GAIG;AACH,MAAM,OAAgB,4BAA4B;IACxC,MAAM,GAAsC,EAAE,CAAC;IACtC,qBAAqB,GAA0B,IAAI,qBAAqB,EAAE,CAAC;IAE5F,YAAY,wBAAiC;QAC3C,IAAI,wBAAwB,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,0BAA0B,CAAC,wBAAwB,CAAC,CAAC;YACnE,IAAI,KAAK,EAAE,aAAa,EAAE,CAAC;gBACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAc,gBAAgB;QAC5B,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAc,SAAS;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAQD;;;;;;;;OAQG;IACI,eAAe,CACpB,QAAgB,EAChB,eAAwB,EACxB,cAAoC;QAKpC,wBAAwB;QACxB,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,+BAA+B,EAAE,CAAC;QAE3D,4BAA4B;QAC5B,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEhE,OAAO;YACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,iBAAiB,EAAE,WAAW;SAC/B,CAAC;IACJ,CAAC;IAqBD;;;OAGG;IACK,+BAA+B;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACjD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC1D,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACK,iBAAiB,CAAC,eAAyB,EAAE,QAAgB;QACnE,eAAe,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAClC,IAAI,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,CAAC,4BAA4B,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAEO,uBAAuB,CAAC,oBAAoD;QAClF,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACK,qBAAqB,CAAC,cAAmC;QAC/D,iCAAiC;QACjC,IAAI,cAAc,CAAC,oBAAoB,EAAE,CAAC;YACxC,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;QACpE,CAAC;QAED,iCAAiC;QACjC,IAAI,cAAc,CAAC,yBAAyB,EAAE,CAAC;YAC7C,IAAI,CAAC,2BAA2B,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IAEO,oBAAoB,CAAC,iBAAqC;QAChE,OAAO,CACL,CAAC,iBAAiB;YAClB,iBAAiB,KAAK,EAAE;YACxB,iBAAiB,KAAK,MAAM;YAC5B,iBAAiB,CAAC,WAAW,EAAE,KAAK,MAAM,CAC3C,CAAC;IACJ,CAAC;IAEO,+BAA+B;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAChD,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,WAAW,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;YACzE,OAAO,CAAC,WAAW,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,2BAA2B,CAAC,yBAAgD;QAClF,IAAI,yBAAyB,IAAI,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrF,OAAO;QACT,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,EAAE;YAC5E,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,kBAAkB,CAAC,SAAiB,EAAE,WAAiC;QAC7E,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,WAAW,CAAC;QAC/D,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,QAAa,EAAE,QAAa,EAAE,iBAAyB;QAC9E,mEAAmE;QACnE,MAAM,oBAAoB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAChD,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ,CAAC,GAAG,CACrF,CAAC;QAEF,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,oDAAoD;QACpD,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAE1D,2DAA2D;QAC3D,MAAM,iBAAiB,GAAkB;YACvC,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;SAClB,CAAC;QAEF,qBAAqB;QACrB,eAAe,CAAC,UAAU,GAAG,iBAAiB,CAAC;QAC/C,eAAe,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IACxD,CAAC;IAEO,gBAAgB,CAAC,QAAa,EAAE,SAAgB,EAAE,iBAAyB;QACjF,4DAA4D;QAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAC9B,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ,CAAC,GAAG,CAAC,CACxF,CAAC;QAEF,8CAA8C;QAC9C,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7B,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,iBAAsB,EAAE,iBAAyB;QAC7E,mCAAmC;QACnC,MAAM,UAAU,GAAkB;YAChC,GAAG,EAAE,iBAAiB,CAAC,GAAG;YAC1B,GAAG,EAAE,iBAAiB,CAAC,GAAG;SAC3B,CAAC;QAEF,6CAA6C;QAC7C,MAAM,iBAAiB,GAAoC;YACzD,UAAU,EAAE,UAAU;YACtB,iBAAiB,EAAE,iBAAiB;SACrC,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACtC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { QueryRangeMapping } from \"../queryRangeMapping.js\";\nimport {\n  parseBaseContinuationToken,\n  type QueryRangeWithContinuationToken,\n  type RangeBoundary,\n} from \"../../documents/ContinuationToken/CompositeQueryContinuationToken.js\";\nimport type {\n  PartitionRangeUpdate,\n  PartitionRangeUpdates,\n} from \"../../documents/ContinuationToken/PartitionRangeUpdate.js\";\nimport { PartitionRangeManager } from \"../PartitionRangeManager.js\";\nimport type { ParallelQueryResult } from \"../parallelQueryResult.js\";\n\n/**\n * Base abstract class for continuation token management.\n * Provides common functionality shared between parallel and ORDER BY query token managers.\n * @internal\n */\nexport abstract class BaseContinuationTokenManager {\n  private ranges: QueryRangeWithContinuationToken[] = [];\n  private readonly partitionRangeManager: PartitionRangeManager = new PartitionRangeManager();\n\n  constructor(initialContinuationToken?: string) {\n    if (initialContinuationToken) {\n      const token = parseBaseContinuationToken(initialContinuationToken);\n      if (token?.rangeMappings) {\n        this.ranges = token.rangeMappings;\n      }\n    }\n  }\n\n  /**\n   * Provides controlled access to partition range manager for subclasses.\n   * This is the only protected access point needed.\n   */\n  protected get partitionManager(): PartitionRangeManager {\n    return this.partitionRangeManager;\n  }\n\n  /**\n   * Provides controlled access to ranges for subclasses.\n   * Made protected to allow subclass range management.\n   */\n  protected get rangeList(): QueryRangeWithContinuationToken[] {\n    return this.ranges;\n  }\n\n  /**\n   * Gets the current continuation token for serialization.\n   * Returns undefined if no token exists or query is exhausted.\n   */\n  protected abstract getCurrentContinuationToken(): any;\n\n  /**\n   * Processes query results and generates continuation tokens for pagination.\n   * Handles response data processing, range management, and token generation.\n   *\n   * @param pageSize - Maximum number of items to return in this page\n   * @param isResponseEmpty - Whether the current response contains no data\n   * @param responseResult - Optional response data containing partition mappings and query-specific data\n   * @returns Object containing the end index for slicing results and optional continuation token for next page\n   */\n  public paginateResults(\n    pageSize: number,\n    isResponseEmpty: boolean,\n    responseResult?: ParallelQueryResult,\n  ): {\n    endIndex: number;\n    continuationToken?: string;\n  } {\n    // Process response data\n    if (responseResult) {\n      this.processResponseResult(responseResult);\n    }\n\n    this.removeExhaustedRangesFromRanges();\n    const result = this.processRangesForPagination(pageSize, isResponseEmpty);\n    const tokenString = this.generateContinuationTokenString();\n\n    // Clean up processed ranges\n    this.trimProcessedData(result.processedRanges, result.endIndex);\n\n    return {\n      endIndex: result.endIndex,\n      continuationToken: tokenString,\n    };\n  }\n\n  protected abstract processRangesForPagination(\n    pageSize: number,\n    isResponseEmpty: boolean,\n  ): {\n    endIndex: number;\n    processedRanges: string[];\n  };\n\n  protected abstract processQuerySpecificResponse(responseResult: ParallelQueryResult): void;\n  protected abstract performQuerySpecificDataTrim(\n    processedRanges: string[],\n    endIndex: number,\n  ): void;\n\n  /**\n   * Gets the serialization function for the specific continuation token type.\n   */\n  protected abstract getSerializationFunction(): (token: any) => string;\n\n  /**\n   * Generates continuation token string using the appropriate serialization function.\n   * This provides a common implementation that delegates to query-specific logic.\n   */\n  private generateContinuationTokenString(): string | undefined {\n    const token = this.getCurrentContinuationToken();\n    if (!token) {\n      return undefined;\n    }\n\n    const serializeFunction = this.getSerializationFunction();\n    return serializeFunction(token);\n  }\n\n  /**\n   * Cleans up processed data after a page has been returned.\n   * Handles both common and query-specific cleanup.\n   */\n  private trimProcessedData(processedRanges: string[], endIndex: number): void {\n    processedRanges.forEach((rangeId) => {\n      this.partitionRangeManager.removePartitionRangeMapping(rangeId);\n    });\n\n    // Delegate query-specific cleanup to subclass\n    this.performQuerySpecificDataTrim(processedRanges, endIndex);\n  }\n\n  private addPartitionKeyRangeMap(partitionKeyRangeMap: Map<string, QueryRangeMapping>): void {\n    this.partitionRangeManager.addPartitionKeyRangeMap(partitionKeyRangeMap);\n  }\n\n  /**\n   * Processes the entire response result and updates the continuation token manager state.\n   * This encapsulates all response handling logic in one place.\n   */\n  private processResponseResult(responseResult: ParallelQueryResult): void {\n    // Handle partition key range map\n    if (responseResult.partitionKeyRangeMap) {\n      this.addPartitionKeyRangeMap(responseResult.partitionKeyRangeMap);\n    }\n\n    // Handle partition range updates\n    if (responseResult.updatedContinuationRanges) {\n      this.handlePartitionRangeChanges(responseResult.updatedContinuationRanges);\n    }\n\n    this.processQuerySpecificResponse(responseResult);\n  }\n\n  private isPartitionExhausted(continuationToken: string | undefined): boolean {\n    return (\n      !continuationToken ||\n      continuationToken === \"\" ||\n      continuationToken === \"null\" ||\n      continuationToken.toLowerCase() === \"null\"\n    );\n  }\n\n  private removeExhaustedRangesFromRanges(): void {\n    if (!this.ranges || !Array.isArray(this.ranges)) {\n      return;\n    }\n    this.ranges = this.ranges.filter((mapping) => {\n      if (!mapping) {\n        return false;\n      }\n      const isExhausted = this.isPartitionExhausted(mapping.continuationToken);\n      return !isExhausted;\n    });\n  }\n\n  private handlePartitionRangeChanges(updatedContinuationRanges: PartitionRangeUpdates): void {\n    if (updatedContinuationRanges && Object.keys(updatedContinuationRanges).length === 0) {\n      return;\n    }\n    Object.entries(updatedContinuationRanges).forEach(([rangeKey, rangeChange]) => {\n      this.processRangeChange(rangeKey, rangeChange);\n    });\n  }\n\n  private processRangeChange(_rangeKey: string, rangeChange: PartitionRangeUpdate): void {\n    const { oldRange, newRanges, continuationToken } = rangeChange;\n    if (newRanges.length === 1) {\n      this.handleRangeMerge(oldRange, newRanges[0], continuationToken);\n    } else {\n      this.handleRangeSplit(oldRange, newRanges, continuationToken);\n    }\n  }\n\n  private handleRangeMerge(oldRange: any, newRange: any, continuationToken: string): void {\n    // Find existing range mapping to update in the common ranges array\n    const existingMappingIndex = this.ranges.findIndex(\n      (mapping) =>\n        mapping.queryRange.min === oldRange.min && mapping.queryRange.max === oldRange.max,\n    );\n\n    if (existingMappingIndex < 0) {\n      return;\n    }\n\n    // Update existing mapping with new range properties\n    const existingMapping = this.ranges[existingMappingIndex];\n\n    // Create new simplified QueryRange with updated boundaries\n    const updatedQueryRange: RangeBoundary = {\n      min: newRange.min,\n      max: newRange.max,\n    };\n\n    // Update the mapping\n    existingMapping.queryRange = updatedQueryRange;\n    existingMapping.continuationToken = continuationToken;\n  }\n\n  private handleRangeSplit(oldRange: any, newRanges: any[], continuationToken: string): void {\n    // Remove the old range mapping from the common ranges array\n    this.ranges = this.ranges.filter(\n      (mapping) =>\n        !(mapping.queryRange.min === oldRange.min && mapping.queryRange.max === oldRange.max),\n    );\n\n    // Add new range mappings for each split range\n    newRanges.forEach((newRange) => {\n      this.createNewRangeMapping(newRange, continuationToken);\n    });\n  }\n\n  private createNewRangeMapping(partitionKeyRange: any, continuationToken: string): void {\n    // Create new simplified QueryRange\n    const queryRange: RangeBoundary = {\n      min: partitionKeyRange.min,\n      max: partitionKeyRange.max,\n    };\n\n    // Create new QueryRangeWithContinuationToken\n    const newRangeWithToken: QueryRangeWithContinuationToken = {\n      queryRange: queryRange,\n      continuationToken: continuationToken,\n    };\n\n    this.ranges.push(newRangeWithToken);\n  }\n}\n"]}

package/dist/esm/queryExecutionContext/ContinuationTokenManager/ContinuationTokenManagerFactory.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ContinuationTokenManagerFactory.d.ts.map

package/dist/esm/queryExecutionContext/ContinuationTokenManager/ContinuationTokenManagerFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContinuationTokenManagerFactory.d.ts","sourceRoot":"","sources":["../../../../src/queryExecutionContext/ContinuationTokenManager/ContinuationTokenManagerFactory.ts"],"names":[],"mappings":""}

package/dist/esm/queryExecutionContext/ContinuationTokenManager/ContinuationTokenManagerFactory.js

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { ParallelQueryContinuationTokenManager } from "./ParallelQueryContinuationTokenManager.js";
+import { OrderByQueryContinuationTokenManager } from "./OrderByQueryContinuationTokenManager.js";
+/**
+ * Factory for creating appropriate continuation token managers based on query type.
+ * @internal
+ */
+export const ContinuationTokenManagerFactory = {
+    /**
+     * Creates the appropriate continuation token manager based on query type.
+     * Only call this for queries that support continuation tokens.
+     * @param collectionLink - Collection link/RID
+     * @param initialContinuationToken - Optional initial continuation token
+     * @param isOrderByQuery - Whether this is an ORDER BY query
+     * @returns Appropriate continuation token manager instance
+     * @internal
+     */
+    create(collectionLink, initialContinuationToken, isOrderByQuery = false) {
+        if (isOrderByQuery) {
+            return new OrderByQueryContinuationTokenManager(collectionLink, initialContinuationToken);
+        }
+        else {
+            return new ParallelQueryContinuationTokenManager(collectionLink, initialContinuationToken);
+        }
+    },
+};
+//# sourceMappingURL=ContinuationTokenManagerFactory.js.map

package/dist/esm/queryExecutionContext/ContinuationTokenManager/ContinuationTokenManagerFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContinuationTokenManagerFactory.js","sourceRoot":"","sources":["../../../../src/queryExecutionContext/ContinuationTokenManager/ContinuationTokenManagerFactory.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,qCAAqC,EAAE,MAAM,4CAA4C,CAAC;AACnG,OAAO,EAAE,oCAAoC,EAAE,MAAM,2CAA2C,CAAC;AAEjG;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG;IAC7C;;;;;;;;OAQG;IACH,MAAM,CACJ,cAAsB,EACtB,wBAAiC,EACjC,iBAA0B,KAAK;QAE/B,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,IAAI,oCAAoC,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;QAC5F,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,qCAAqC,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;QAC7F,CAAC;IACH,CAAC;CACF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { BaseContinuationTokenManager } from \"./BaseContinuationTokenManager.js\";\nimport { ParallelQueryContinuationTokenManager } from \"./ParallelQueryContinuationTokenManager.js\";\nimport { OrderByQueryContinuationTokenManager } from \"./OrderByQueryContinuationTokenManager.js\";\n\n/**\n * Factory for creating appropriate continuation token managers based on query type.\n * @internal\n */\nexport const ContinuationTokenManagerFactory = {\n  /**\n   * Creates the appropriate continuation token manager based on query type.\n   * Only call this for queries that support continuation tokens.\n   * @param collectionLink - Collection link/RID\n   * @param initialContinuationToken - Optional initial continuation token\n   * @param isOrderByQuery - Whether this is an ORDER BY query\n   * @returns Appropriate continuation token manager instance\n   * @internal\n   */\n  create(\n    collectionLink: string,\n    initialContinuationToken?: string,\n    isOrderByQuery: boolean = false,\n  ): BaseContinuationTokenManager {\n    if (isOrderByQuery) {\n      return new OrderByQueryContinuationTokenManager(collectionLink, initialContinuationToken);\n    } else {\n      return new ParallelQueryContinuationTokenManager(collectionLink, initialContinuationToken);\n    }\n  },\n};\n"]}

package/dist/esm/queryExecutionContext/ContinuationTokenManager/OrderByQueryContinuationTokenManager.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=OrderByQueryContinuationTokenManager.d.ts.map

package/dist/esm/queryExecutionContext/ContinuationTokenManager/OrderByQueryContinuationTokenManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderByQueryContinuationTokenManager.d.ts","sourceRoot":"","sources":["../../../../src/queryExecutionContext/ContinuationTokenManager/OrderByQueryContinuationTokenManager.ts"],"names":[],"mappings":""}

package/dist/esm/queryExecutionContext/ContinuationTokenManager/OrderByQueryContinuationTokenManager.js

@@ -0,0 +1,129 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { BaseContinuationTokenManager } from "./BaseContinuationTokenManager.js";
+import { createOrderByQueryContinuationToken, parseOrderByQueryContinuationToken, serializeOrderByQueryContinuationToken, } from "../../documents/ContinuationToken/OrderByQueryContinuationToken.js";
+import { convertRangeMappingToQueryRange } from "../../documents/ContinuationToken/CompositeQueryContinuationToken.js";
+/**
+ * Manages continuation tokens for ORDER BY queries using single-range sequential processing.
+ * Uses OrderByQueryContinuationToken for tracking ORDER BY items and skip counts.
+ * @internal
+ */
+export class OrderByQueryContinuationTokenManager extends BaseContinuationTokenManager {
+    continuationToken;
+    orderByItemsArray;
+    collectionLink;
+    constructor(collectionLink, initialContinuationToken) {
+        super(initialContinuationToken);
+        this.collectionLink = collectionLink;
+        this.orderByItemsArray = [];
+        if (initialContinuationToken) {
+            this.continuationToken = parseOrderByQueryContinuationToken(initialContinuationToken);
+        }
+    }
+    processQuerySpecificResponse(responseResult) {
+        // Clear existing items and add new ones without reassigning the array reference
+        this.orderByItemsArray.length = 0;
+        if (responseResult.orderByItems) {
+            this.orderByItemsArray.push(...responseResult.orderByItems);
+        }
+    }
+    performQuerySpecificDataTrim(_processedRanges, endIndex) {
+        this.sliceOrderByItemsArray(endIndex);
+    }
+    sliceOrderByItemsArray(endIndex) {
+        if (endIndex === 0 || endIndex >= this.orderByItemsArray.length) {
+            // Clear the array without reassigning
+            this.orderByItemsArray.length = 0;
+        }
+        else {
+            // Remove items from 0 to endIndex-1, keeping items from endIndex onwards
+            this.orderByItemsArray.splice(0, endIndex);
+        }
+    }
+    processRangesForPagination(pageSize, isResponseEmpty = false) {
+        // Handle empty response case - update the previous valid continuation token
+        if (isResponseEmpty && this.continuationToken) {
+            let rangeProcessingResult;
+            if (this.rangeList.length === 0) {
+                rangeProcessingResult = this.partitionManager.processOrderByRanges(pageSize);
+            }
+            else {
+                rangeProcessingResult = this.partitionManager.processEmptyOrderByRanges(this.rangeList);
+            }
+            const { lastRangeBeforePageLimit } = rangeProcessingResult;
+            if (lastRangeBeforePageLimit) {
+                // Use the range matching the continuation token for empty response
+                this.continuationToken.rangeMappings = [
+                    convertRangeMappingToQueryRange(lastRangeBeforePageLimit),
+                ];
+            }
+            else {
+                // Range is exhausted - clear the continuation token
+                this.continuationToken = undefined;
+            }
+            return {
+                endIndex: rangeProcessingResult.endIndex,
+                processedRanges: rangeProcessingResult.processedRanges,
+            };
+        }
+        // Normal processing path - handle non-empty responses
+        const rangeProcessingResult = this.partitionManager.processOrderByRanges(pageSize);
+        const { lastRangeBeforePageLimit } = rangeProcessingResult;
+        // Check if we have a valid range to continue with
+        if (!lastRangeBeforePageLimit) {
+            this.continuationToken = undefined;
+            return {
+                endIndex: rangeProcessingResult.endIndex,
+                processedRanges: rangeProcessingResult.processedRanges,
+            };
+        }
+        const queryRange = convertRangeMappingToQueryRange(lastRangeBeforePageLimit);
+        // Extract ORDER BY items from the last item on the page
+        let lastOrderByItems;
+        let documentRid;
+        let skipCount = 0;
+        if (rangeProcessingResult.endIndex > 0 && this.orderByItemsArray.length > 0) {
+            const lastItemIndexOnPage = rangeProcessingResult.endIndex - 1;
+            if (lastItemIndexOnPage < this.orderByItemsArray.length) {
+                lastOrderByItems = this.orderByItemsArray[lastItemIndexOnPage].orderByItems;
+                documentRid = this.orderByItemsArray[lastItemIndexOnPage]._rid;
+                // Calculate skip count: count how many documents in the page have the same RID
+                // This handles JOIN queries where multiple documents can have the same RID
+                skipCount = 0;
+                for (let i = 0; i <= lastItemIndexOnPage; i++) {
+                    if (this.orderByItemsArray[i]._rid === documentRid) {
+                        skipCount++;
+                    }
+                }
+            }
+        }
+        // If we don't have valid ORDER BY items, we cannot create a proper continuation token
+        // This can happen when the response doesn't contain ORDER BY metadata or when there are no results
+        if (!lastOrderByItems || lastOrderByItems.length === 0) {
+            this.continuationToken = undefined;
+            return {
+                endIndex: rangeProcessingResult.endIndex,
+                processedRanges: rangeProcessingResult.processedRanges,
+            };
+        }
+        const rangeMappings = [queryRange];
+        // Create new ORDER BY continuation token
+        this.continuationToken = createOrderByQueryContinuationToken(rangeMappings, lastOrderByItems, this.collectionLink, // Container RID/link
+        skipCount, // Number of documents with the same RID already processed
+        documentRid, // Document RID from the last item in the page
+        lastRangeBeforePageLimit.offset, // Current offset for OFFSET/LIMIT queries
+        lastRangeBeforePageLimit.limit, // Current limit for OFFSET/LIMIT queries
+        lastRangeBeforePageLimit.hashedLastResult);
+        return {
+            endIndex: rangeProcessingResult.endIndex,
+            processedRanges: rangeProcessingResult.processedRanges,
+        };
+    }
+    getCurrentContinuationToken() {
+        return this.continuationToken;
+    }
+    getSerializationFunction() {
+        return serializeOrderByQueryContinuationToken;
+    }
+}
+//# sourceMappingURL=OrderByQueryContinuationTokenManager.js.map