@azure/cosmos 4.3.0 → 4.4.0

package/dist/commonjs/queryExecutionContext/EndpointComponent/UnorderedDistinctEndpointComponent.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnorderedDistinctEndpointComponent = void 0;
+const hashObject_js_1 = require("../../utils/hashObject.js");
+/** @hidden */
+class UnorderedDistinctEndpointComponent {
+    constructor(executionContext) {
+        this.executionContext = executionContext;
+        this.hashedResults = new Set();
+    }
+    hasMoreResults() {
+        return this.executionContext.hasMoreResults();
+    }
+    async fetchMore(diagnosticNode) {
+        const buffer = [];
+        const response = await this.executionContext.fetchMore(diagnosticNode);
+        if (response === undefined || response.result === undefined) {
+            return { result: undefined, headers: response.headers };
+        }
+        for (const item of response.result) {
+            if (item) {
+                const hashedResult = await (0, hashObject_js_1.hashObject)(item);
+                if (!this.hashedResults.has(hashedResult)) {
+                    buffer.push(item);
+                    this.hashedResults.add(hashedResult);
+                }
+            }
+        }
+        return { result: buffer, headers: response.headers };
+    }
+}
+exports.UnorderedDistinctEndpointComponent = UnorderedDistinctEndpointComponent;
+//# sourceMappingURL=UnorderedDistinctEndpointComponent.js.map

package/dist/commonjs/queryExecutionContext/EndpointComponent/UnorderedDistinctEndpointComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnorderedDistinctEndpointComponent.js","sourceRoot":"","sources":["../../../../src/queryExecutionContext/EndpointComponent/UnorderedDistinctEndpointComponent.ts"],"names":[],"mappings":";;;AAIA,6DAAuD;AAGvD,cAAc;AACd,MAAa,kCAAkC;IAE7C,YAAoB,gBAAkC;QAAlC,qBAAgB,GAAhB,gBAAgB,CAAkB;QACpD,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAEM,cAAc;QACnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,cAAuC;QAC5D,MAAM,MAAM,GAAU,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACvE,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC1D,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAU,EAAC,IAAI,CAAC,CAAC;gBAC5C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;oBAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAClB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IACvD,CAAC;CACF;AA3BD,gFA2BC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { Response } from \"../../request/index.js\";\nimport type { ExecutionContext } from \"../ExecutionContext.js\";\nimport { hashObject } from \"../../utils/hashObject.js\";\nimport type { DiagnosticNodeInternal } from \"../../diagnostics/DiagnosticNodeInternal.js\";\n\n/** @hidden */\nexport class UnorderedDistinctEndpointComponent implements ExecutionContext {\n  private hashedResults: Set<string>;\n  constructor(private executionContext: ExecutionContext) {\n    this.hashedResults = new Set();\n  }\n\n  public hasMoreResults(): boolean {\n    return this.executionContext.hasMoreResults();\n  }\n\n  public async fetchMore(diagnosticNode?: DiagnosticNodeInternal): Promise<Response<any>> {\n    const buffer: any[] = [];\n    const response = await this.executionContext.fetchMore(diagnosticNode);\n    if (response === undefined || response.result === undefined) {\n      return { result: undefined, headers: response.headers };\n    }\n    for (const item of response.result) {\n      if (item) {\n        const hashedResult = await hashObject(item);\n        if (!this.hashedResults.has(hashedResult)) {\n          buffer.push(item);\n          this.hashedResults.add(hashedResult);\n        }\n      }\n    }\n    return { result: buffer, headers: response.headers };\n  }\n}\n"]}

package/dist/commonjs/queryExecutionContext/EndpointComponent/emptyGroup.d.ts

@@ -0,0 +1,6 @@
+export declare const emptyGroup = "__empty__";
+export declare const extractAggregateResult: (payload: {
+    item2?: unknown;
+    item: unknown;
+}) => any;
+//# sourceMappingURL=emptyGroup.d.ts.map

package/dist/commonjs/queryExecutionContext/EndpointComponent/emptyGroup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emptyGroup.d.ts","sourceRoot":"","sources":["../../../../src/queryExecutionContext/EndpointComponent/emptyGroup.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,UAAU,cAAc,CAAC;AAItC,eAAO,MAAM,sBAAsB,GAAI,SAAS;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,KAAG,GACI,CAAC"}

package/dist/commonjs/queryExecutionContext/EndpointComponent/emptyGroup.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractAggregateResult = exports.emptyGroup = void 0;
+// All aggregates are effectively a group by operation
+// The empty group is used for aggregates without a GROUP BY clause
+exports.emptyGroup = "__empty__";
+// Newer API versions rewrite the query to return `item2`. It fixes some legacy issues with the original `item` result
+// Aggregator code should use item2 when available
+const extractAggregateResult = (payload) => Object.keys(payload).length > 0 ? (payload.item2 ? payload.item2 : payload.item) : null;
+exports.extractAggregateResult = extractAggregateResult;
+//# sourceMappingURL=emptyGroup.js.map

package/dist/commonjs/queryExecutionContext/EndpointComponent/emptyGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emptyGroup.js","sourceRoot":"","sources":["../../../../src/queryExecutionContext/EndpointComponent/emptyGroup.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,sDAAsD;AACtD,mEAAmE;AACtD,QAAA,UAAU,GAAG,WAAW,CAAC;AAEtC,sHAAsH;AACtH,kDAAkD;AAC3C,MAAM,sBAAsB,GAAG,CAAC,OAA2C,EAAO,EAAE,CACzF,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAD7E,QAAA,sBAAsB,0BACuD","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n// All aggregates are effectively a group by operation\n// The empty group is used for aggregates without a GROUP BY clause\nexport const emptyGroup = \"__empty__\";\n\n// Newer API versions rewrite the query to return `item2`. It fixes some legacy issues with the original `item` result\n// Aggregator code should use item2 when available\nexport const extractAggregateResult = (payload: { item2?: unknown; item: unknown }): any =>\n  Object.keys(payload).length > 0 ? (payload.item2 ? payload.item2 : payload.item) : null;\n"]}

package/dist/commonjs/queryExecutionContext/ExecutionContext.d.ts

@@ -0,0 +1,9 @@
+import type { DiagnosticNodeInternal } from "../diagnostics/DiagnosticNodeInternal.js";
+import type { Response } from "../request/index.js";
+/** @hidden */
+export interface ExecutionContext {
+    nextItem?: (diagnosticNode: DiagnosticNodeInternal) => Promise<Response<any>>;
+    hasMoreResults: () => boolean;
+    fetchMore?: (diagnosticNode: DiagnosticNodeInternal) => Promise<Response<any>>;
+}
+//# sourceMappingURL=ExecutionContext.d.ts.map

package/dist/commonjs/queryExecutionContext/ExecutionContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExecutionContext.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/ExecutionContext.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,sBAAsB,KAAK,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9E,cAAc,EAAE,MAAM,OAAO,CAAC;IAC9B,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,sBAAsB,KAAK,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;CAChF"}

package/dist/commonjs/queryExecutionContext/ExecutionContext.js

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

package/dist/commonjs/queryExecutionContext/ExecutionContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExecutionContext.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/ExecutionContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { DiagnosticNodeInternal } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport type { Response } from \"../request/index.js\";\n\n/** @hidden */\nexport interface ExecutionContext {\n  nextItem?: (diagnosticNode: DiagnosticNodeInternal) => Promise<Response<any>>;\n  hasMoreResults: () => boolean;\n  fetchMore?: (diagnosticNode: DiagnosticNodeInternal) => Promise<Response<any>>;\n}\n"]}

package/dist/commonjs/queryExecutionContext/FetchResult.d.ts

@@ -0,0 +1,23 @@
+/** @hidden */
+export declare enum FetchResultType {
+    "Done" = 0,
+    "Exception" = 1,
+    "Result" = 2
+}
+/** @hidden */
+export declare class FetchResult {
+    feedResponse: any;
+    headers: any;
+    fetchResultType: FetchResultType;
+    error: any;
+    /**
+     * Wraps fetch results for the document producer.
+     * This allows the document producer to buffer exceptions so that actual results don't get flushed during splits.
+     *
+     * @param feedReponse - The response the document producer got back on a successful fetch
+     * @param error - The exception meant to be buffered on an unsuccessful fetch
+     * @hidden
+     */
+    constructor(feedResponse: unknown, error: unknown, headers?: unknown);
+}
+//# sourceMappingURL=FetchResult.d.ts.map

package/dist/commonjs/queryExecutionContext/FetchResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchResult.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/FetchResult.ts"],"names":[],"mappings":"AAEA,cAAc;AACd,oBAAY,eAAe;IACzB,MAAM,IAAI;IACV,WAAW,IAAI;IACf,QAAQ,IAAI;CACb;AAED,cAAc;AACd,qBAAa,WAAW;IACf,YAAY,EAAE,GAAG,CAAC;IAClB,OAAO,EAAE,GAAG,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;IACjC,KAAK,EAAE,GAAG,CAAC;IAClB;;;;;;;OAOG;gBACS,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO;CAWrE"}

package/dist/commonjs/queryExecutionContext/FetchResult.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchResult = exports.FetchResultType = void 0;
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/** @hidden */
+var FetchResultType;
+(function (FetchResultType) {
+    FetchResultType[FetchResultType["Done"] = 0] = "Done";
+    FetchResultType[FetchResultType["Exception"] = 1] = "Exception";
+    FetchResultType[FetchResultType["Result"] = 2] = "Result";
+})(FetchResultType || (exports.FetchResultType = FetchResultType = {}));
+/** @hidden */
+class FetchResult {
+    /**
+     * Wraps fetch results for the document producer.
+     * This allows the document producer to buffer exceptions so that actual results don't get flushed during splits.
+     *
+     * @param feedReponse - The response the document producer got back on a successful fetch
+     * @param error - The exception meant to be buffered on an unsuccessful fetch
+     * @hidden
+     */
+    constructor(feedResponse, error, headers) {
+        // TODO: feedResponse/error
+        if (feedResponse !== undefined) {
+            this.feedResponse = feedResponse;
+            this.headers = headers;
+            this.fetchResultType = FetchResultType.Result;
+        }
+        else {
+            this.error = error;
+            this.fetchResultType = FetchResultType.Exception;
+        }
+    }
+}
+exports.FetchResult = FetchResult;
+//# sourceMappingURL=FetchResult.js.map

package/dist/commonjs/queryExecutionContext/FetchResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchResult.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/FetchResult.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AACvC,kCAAkC;AAClC,cAAc;AACd,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,qDAAU,CAAA;IACV,+DAAe,CAAA;IACf,yDAAY,CAAA;AACd,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAED,cAAc;AACd,MAAa,WAAW;IAKtB;;;;;;;OAOG;IACH,YAAY,YAAqB,EAAE,KAAc,EAAE,OAAiB;QAClE,2BAA2B;QAC3B,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,SAAS,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AAxBD,kCAwBC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n/** @hidden */\nexport enum FetchResultType {\n  \"Done\" = 0,\n  \"Exception\" = 1,\n  \"Result\" = 2,\n}\n\n/** @hidden */\nexport class FetchResult {\n  public feedResponse: any;\n  public headers: any;\n  public fetchResultType: FetchResultType;\n  public error: any;\n  /**\n   * Wraps fetch results for the document producer.\n   * This allows the document producer to buffer exceptions so that actual results don't get flushed during splits.\n   *\n   * @param feedReponse - The response the document producer got back on a successful fetch\n   * @param error - The exception meant to be buffered on an unsuccessful fetch\n   * @hidden\n   */\n  constructor(feedResponse: unknown, error: unknown, headers?: unknown) {\n    // TODO: feedResponse/error\n    if (feedResponse !== undefined) {\n      this.feedResponse = feedResponse;\n      this.headers = headers;\n      this.fetchResultType = FetchResultType.Result;\n    } else {\n      this.error = error;\n      this.fetchResultType = FetchResultType.Exception;\n    }\n  }\n}\n"]}

package/dist/commonjs/queryExecutionContext/SqlQuerySpec.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Represents a SQL query in the Azure Cosmos DB service.
+ *
+ * Queries with inputs should be parameterized to protect against SQL injection.
+ *
+ * @example Parameterized SQL Query
+ * ```ts snippet:SqlQuerySpecParameterizedSqlQuery
+ * import { SqlQuerySpec } from "@azure/cosmos";
+ *
+ * const query: SqlQuerySpec = {
+ *   query: `SELECT * FROM Families f where f.lastName = @lastName`,
+ *   parameters: [{ name: "@lastName", value: "Wakefield" }],
+ * };
+ * ```
+ */
+export interface SqlQuerySpec {
+    /** The text of the SQL query */
+    query: string;
+    /** The parameters you provide in the query */
+    parameters?: SqlParameter[];
+}
+/**
+ * Represents a parameter in a Parameterized SQL query, specified in {@link SqlQuerySpec}
+ */
+export interface SqlParameter {
+    /** Name of the parameter. (i.e. `@lastName`) */
+    name: string;
+    /** Value of the parameter (this is safe to come from users, assuming they are authorized) */
+    value: JSONValue;
+}
+export type JSONValue = boolean | number | string | null | JSONArray | JSONObject | Date;
+export interface JSONObject {
+    [key: string]: JSONValue;
+}
+export interface JSONArray extends ArrayLike<JSONValue> {
+}
+//# sourceMappingURL=SqlQuerySpec.d.ts.map

package/dist/commonjs/queryExecutionContext/SqlQuerySpec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlQuerySpec.d.ts","sourceRoot":"","sources":["../../../src/queryExecutionContext/SqlQuerySpec.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,6FAA6F;IAC7F,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;AACzF,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AACD,MAAM,WAAW,SAAU,SAAQ,SAAS,CAAC,SAAS,CAAC;CAAG"}

package/dist/commonjs/queryExecutionContext/SqlQuerySpec.js

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

package/dist/commonjs/queryExecutionContext/SqlQuerySpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlQuerySpec.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/SqlQuerySpec.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n/**\n * Represents a SQL query in the Azure Cosmos DB service.\n *\n * Queries with inputs should be parameterized to protect against SQL injection.\n *\n * @example Parameterized SQL Query\n * ```ts snippet:SqlQuerySpecParameterizedSqlQuery\n * import { SqlQuerySpec } from \"@azure/cosmos\";\n *\n * const query: SqlQuerySpec = {\n *   query: `SELECT * FROM Families f where f.lastName = @lastName`,\n *   parameters: [{ name: \"@lastName\", value: \"Wakefield\" }],\n * };\n * ```\n */\nexport interface SqlQuerySpec {\n  /** The text of the SQL query */\n  query: string;\n  /** The parameters you provide in the query */\n  parameters?: SqlParameter[];\n}\n\n/**\n * Represents a parameter in a Parameterized SQL query, specified in {@link SqlQuerySpec}\n */\nexport interface SqlParameter {\n  /** Name of the parameter. (i.e. `@lastName`) */\n  name: string;\n  /** Value of the parameter (this is safe to come from users, assuming they are authorized) */\n  value: JSONValue;\n}\n\nexport type JSONValue = boolean | number | string | null | JSONArray | JSONObject | Date;\nexport interface JSONObject {\n  [key: string]: JSONValue;\n}\nexport interface JSONArray extends ArrayLike<JSONValue> {}\n"]}

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

@@ -0,0 +1,52 @@
+import type { FeedOptions, Response } from "../request/index.js";
+import type { ExecutionContext } from "./index.js";
+import type { DiagnosticNodeInternal } from "../diagnostics/DiagnosticNodeInternal.js";
+/** @hidden */
+export type FetchFunctionCallback = (diagnosticNode: DiagnosticNodeInternal, options: FeedOptions, correlatedActivityId: string) => Promise<Response<any>>;
+/** @hidden */
+export declare class DefaultQueryExecutionContext implements ExecutionContext {
+    private static readonly STATES;
+    private resources;
+    private currentIndex;
+    private currentPartitionIndex;
+    private fetchFunctions;
+    private options;
+    continuationToken: string;
+    get continuation(): string;
+    private state;
+    private nextFetchFunction;
+    private correlatedActivityId;
+    /**
+     * Provides the basic Query Execution Context.
+     * This wraps the internal logic query execution using provided fetch functions
+     *
+     * @param clientContext  - Is used to read the partitionKeyRanges for split proofing
+     * @param query          - A SQL query.
+     * @param options        - Represents the feed options.
+     * @param fetchFunctions - A function to retrieve each page of data.
+     *                          An array of functions may be used to query more than one partition.
+     * @hidden
+     */
+    constructor(options: FeedOptions, fetchFunctions: FetchFunctionCallback | FetchFunctionCallback[], correlatedActivityId: string);
+    /**
+     * Execute a provided callback on the next element in the execution context.
+     */
+    nextItem(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>>;
+    /**
+     * Retrieve the current element on the execution context.
+     */
+    current(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>>;
+    /**
+     * Determine if there are still remaining resources to processs based on
+     * the value of the continuation token or the elements remaining on the current batch in the execution context.
+     *
+     * @returns true if there is other elements to process in the DefaultQueryExecutionContext.
+     */
+    hasMoreResults(): boolean;
+    /**
+     * Fetches the next batch of the feed and pass them as an array to a callback
+     */
+    fetchMore(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>>;
+    private _canFetchMore;
+}
+//# sourceMappingURL=defaultQueryExecutionContext.d.ts.map

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

@@ -0,0 +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"}

package/dist/commonjs/queryExecutionContext/defaultQueryExecutionContext.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultQueryExecutionContext = void 0;
+const logger_1 = require("@azure/logger");
+const index_js_1 = require("../common/index.js");
+const index_js_2 = require("../queryMetrics/index.js");
+const headerUtils_js_1 = require("./headerUtils.js");
+const DiagnosticNodeInternal_js_1 = require("../diagnostics/DiagnosticNodeInternal.js");
+const diagnostics_js_1 = require("../utils/diagnostics.js");
+const CosmosDbDiagnosticLevel_js_1 = require("../diagnostics/CosmosDbDiagnosticLevel.js");
+const logger = (0, logger_1.createClientLogger)("ClientContext");
+/** @hidden */
+var STATES;
+(function (STATES) {
+    STATES["start"] = "start";
+    STATES["inProgress"] = "inProgress";
+    STATES["ended"] = "ended";
+})(STATES || (STATES = {}));
+/** @hidden */
+class DefaultQueryExecutionContext {
+    get continuation() {
+        return this.continuationToken;
+    }
+    /**
+     * Provides the basic Query Execution Context.
+     * This wraps the internal logic query execution using provided fetch functions
+     *
+     * @param clientContext  - Is used to read the partitionKeyRanges for split proofing
+     * @param query          - A SQL query.
+     * @param options        - Represents the feed options.
+     * @param fetchFunctions - A function to retrieve each page of data.
+     *                          An array of functions may be used to query more than one partition.
+     * @hidden
+     */
+    constructor(options, fetchFunctions, correlatedActivityId) {
+        this.resources = [];
+        this.currentIndex = 0;
+        this.currentPartitionIndex = 0;
+        this.fetchFunctions = Array.isArray(fetchFunctions) ? fetchFunctions : [fetchFunctions];
+        this.options = options || {};
+        this.continuationToken = this.options.continuationToken || this.options.continuation || null;
+        this.state = DefaultQueryExecutionContext.STATES.start;
+        this.correlatedActivityId = correlatedActivityId;
+    }
+    /**
+     * Execute a provided callback on the next element in the execution context.
+     */
+    async nextItem(diagnosticNode) {
+        ++this.currentIndex;
+        const response = await this.current(diagnosticNode);
+        return response;
+    }
+    /**
+     * Retrieve the current element on the execution context.
+     */
+    async current(diagnosticNode) {
+        if (this.currentIndex < this.resources.length) {
+            return {
+                result: this.resources[this.currentIndex],
+                headers: (0, headerUtils_js_1.getInitialHeader)(),
+            };
+        }
+        if (this._canFetchMore()) {
+            const { result: resources, headers } = await this.fetchMore(diagnosticNode);
+            this.resources = resources;
+            if (this.resources.length === 0) {
+                if (!this.continuationToken && this.currentPartitionIndex >= this.fetchFunctions.length) {
+                    this.state = DefaultQueryExecutionContext.STATES.ended;
+                    return { result: undefined, headers };
+                }
+                else {
+                    return this.current(diagnosticNode);
+                }
+            }
+            return { result: this.resources[this.currentIndex], headers };
+        }
+        else {
+            this.state = DefaultQueryExecutionContext.STATES.ended;
+            return {
+                result: undefined,
+                headers: (0, headerUtils_js_1.getInitialHeader)(),
+            };
+        }
+    }
+    /**
+     * Determine if there are still remaining resources to processs based on
+     * the value of the continuation token or the elements remaining on the current batch in the execution context.
+     *
+     * @returns true if there is other elements to process in the DefaultQueryExecutionContext.
+     */
+    hasMoreResults() {
+        return (this.state === DefaultQueryExecutionContext.STATES.start ||
+            this.continuationToken !== undefined ||
+            this.currentIndex < this.resources.length - 1 ||
+            this.currentPartitionIndex < this.fetchFunctions.length);
+    }
+    /**
+     * Fetches the next batch of the feed and pass them as an array to a callback
+     */
+    async fetchMore(diagnosticNode) {
+        return (0, diagnostics_js_1.addDiagnosticChild)(async (childDiagnosticNode) => {
+            if (this.currentPartitionIndex >= this.fetchFunctions.length) {
+                return {
+                    headers: (0, headerUtils_js_1.getInitialHeader)(),
+                    result: undefined,
+                };
+            }
+            // Keep to the original continuation and to restore the value after fetchFunction call
+            const originalContinuation = this.options.continuationToken || this.options.continuation;
+            this.options.continuationToken = this.continuationToken;
+            // Return undefined if there is no more results
+            if (this.currentPartitionIndex >= this.fetchFunctions.length) {
+                return {
+                    headers: (0, headerUtils_js_1.getInitialHeader)(),
+                    result: undefined,
+                };
+            }
+            let resources;
+            let responseHeaders;
+            try {
+                let p;
+                if (this.nextFetchFunction !== undefined) {
+                    logger.verbose("using prefetch");
+                    p = this.nextFetchFunction;
+                    this.nextFetchFunction = undefined;
+                }
+                else {
+                    logger.verbose("using fresh fetch");
+                    p = this.fetchFunctions[this.currentPartitionIndex](childDiagnosticNode, this.options, this.correlatedActivityId);
+                }
+                const response = await p;
+                resources = response.result;
+                childDiagnosticNode.recordQueryResult(resources, CosmosDbDiagnosticLevel_js_1.CosmosDbDiagnosticLevel.debugUnsafe);
+                responseHeaders = response.headers;
+                this.continuationToken = responseHeaders[index_js_1.Constants.HttpHeaders.Continuation];
+                if (!this.continuationToken) {
+                    ++this.currentPartitionIndex;
+                }
+                if (this.options && this.options.bufferItems === true) {
+                    const fetchFunction = this.fetchFunctions[this.currentPartitionIndex];
+                    this.nextFetchFunction = fetchFunction
+                        ? fetchFunction(childDiagnosticNode, Object.assign(Object.assign({}, this.options), { continuationToken: this.continuationToken }), this.correlatedActivityId)
+                        : undefined;
+                }
+            }
+            catch (err) {
+                this.state = DefaultQueryExecutionContext.STATES.ended;
+                // return callback(err, undefined, responseHeaders);
+                // TODO: Error and data being returned is an antipattern, this might broken
+                throw err;
+            }
+            this.state = DefaultQueryExecutionContext.STATES.inProgress;
+            this.currentIndex = 0;
+            this.options.continuationToken = originalContinuation;
+            this.options.continuation = originalContinuation;
+            // deserializing query metrics so that we aren't working with delimited strings in the rest of the code base
+            if (index_js_1.Constants.HttpHeaders.QueryMetrics in responseHeaders) {
+                const delimitedString = responseHeaders[index_js_1.Constants.HttpHeaders.QueryMetrics];
+                let queryMetrics = index_js_2.QueryMetrics.createFromDelimitedString(delimitedString);
+                // Add the request charge to the query metrics so that we can have per partition request charge.
+                if (index_js_1.Constants.HttpHeaders.RequestCharge in responseHeaders) {
+                    const requestCharge = Number(responseHeaders[index_js_1.Constants.HttpHeaders.RequestCharge]) || 0;
+                    queryMetrics = new index_js_2.QueryMetrics(queryMetrics.retrievedDocumentCount, queryMetrics.retrievedDocumentSize, queryMetrics.outputDocumentCount, queryMetrics.outputDocumentSize, queryMetrics.indexHitDocumentCount, queryMetrics.totalQueryExecutionTime, queryMetrics.queryPreparationTimes, queryMetrics.indexLookupTime, queryMetrics.documentLoadTime, queryMetrics.vmExecutionTime, queryMetrics.runtimeExecutionTimes, queryMetrics.documentWriteTime, new index_js_2.ClientSideMetrics(requestCharge));
+                }
+                // Wraping query metrics in a object where the key is '0' just so single partition
+                // and partition queries have the same response schema
+                responseHeaders[index_js_1.Constants.HttpHeaders.QueryMetrics] = {};
+                responseHeaders[index_js_1.Constants.HttpHeaders.QueryMetrics]["0"] = queryMetrics;
+            }
+            return { result: resources, headers: responseHeaders };
+        }, diagnosticNode, DiagnosticNodeInternal_js_1.DiagnosticNodeType.DEFAULT_QUERY_NODE, {
+            queryMethodIdentifier: "fetchMore",
+        });
+    }
+    _canFetchMore() {
+        const res = this.state === DefaultQueryExecutionContext.STATES.start ||
+            (this.continuationToken && this.state === DefaultQueryExecutionContext.STATES.inProgress) ||
+            (this.currentPartitionIndex < this.fetchFunctions.length &&
+                this.state === DefaultQueryExecutionContext.STATES.inProgress);
+        return res;
+    }
+}
+exports.DefaultQueryExecutionContext = DefaultQueryExecutionContext;
+DefaultQueryExecutionContext.STATES = STATES;
+//# sourceMappingURL=defaultQueryExecutionContext.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"defaultQueryExecutionContext.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/defaultQueryExecutionContext.ts"],"names":[],"mappings":";;;AAGA,0CAAmD;AACnD,iDAA+C;AAC/C,uDAA2E;AAE3E,qDAAoD;AAGpD,wFAA8E;AAC9E,4DAA6D;AAC7D,0FAAoF;AAEpF,MAAM,MAAM,GAAgB,IAAA,2BAAkB,EAAC,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,MAAa,4BAA4B;IAQvC,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAID;;;;;;;;;;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,IAAA,iCAAgB,GAAE;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,IAAA,iCAAgB,GAAE;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,IAAA,mCAAkB,EACvB,KAAK,EAAE,mBAA2C,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC7D,OAAO;oBACL,OAAO,EAAE,IAAA,iCAAgB,GAAE;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,IAAA,iCAAgB,GAAE;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,oDAAuB,CAAC,WAAW,CAAC,CAAC;gBACtF,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;gBACnC,IAAI,CAAC,iBAAiB,GAAG,eAAe,CAAC,oBAAS,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,kCAEd,IAAI,CAAC,OAAO,KACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,KAE3C,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,oBAAS,CAAC,WAAW,CAAC,YAAY,IAAI,eAAe,EAAE,CAAC;gBAC1D,MAAM,eAAe,GAAG,eAAe,CAAC,oBAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBAC5E,IAAI,YAAY,GAAG,uBAAY,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAC;gBAE3E,gGAAgG;gBAChG,IAAI,oBAAS,CAAC,WAAW,CAAC,aAAa,IAAI,eAAe,EAAE,CAAC;oBAC3D,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,oBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC;oBACxF,YAAY,GAAG,IAAI,uBAAY,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,4BAAiB,CAAC,aAAa,CAAC,CACrC,CAAC;gBACJ,CAAC;gBAED,kFAAkF;gBAClF,sDAAsD;gBACtD,eAAe,CAAC,oBAAS,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;gBACzD,eAAe,CAAC,oBAAS,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,8CAAkB,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;;AA3NH,oEA4NC;AA3NyB,mCAAM,GAAG,MAAM,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"]}

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

@@ -0,0 +1,64 @@
+import type { PartitionKeyRange } from "../client/index.js";
+import type { ClientContext } from "../ClientContext.js";
+import type { DiagnosticNodeInternal } from "../diagnostics/DiagnosticNodeInternal.js";
+import type { FeedOptions } from "../request/index.js";
+import type { Response } from "../request/index.js";
+import type { FetchFunctionCallback } from "./defaultQueryExecutionContext.js";
+import { FetchResult } from "./FetchResult.js";
+import type { SqlQuerySpec } from "./index.js";
+/** @hidden */
+export declare class DocumentProducer {
+    private clientContext;
+    private collectionLink;
+    private query;
+    targetPartitionKeyRange: PartitionKeyRange;
+    fetchResults: FetchResult[];
+    allFetched: boolean;
+    private err;
+    previousContinuationToken: string;
+    continuationToken: string;
+    generation: number;
+    private respHeaders;
+    private internalExecutionContext;
+    startEpk: string;
+    endEpk: string;
+    populateEpkRangeHeaders: boolean;
+    /**
+     * Provides the Target Partition Range Query Execution Context.
+     * @param clientContext  - The service endpoint to use to create the client.
+     * @param collectionLink - Represents collection link
+     * @param query          - A SQL query.
+     * @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);
+    peekBufferedItems(): any[];
+    fetchFunction: FetchFunctionCallback;
+    hasMoreResults(): boolean;
+    gotSplit(): boolean;
+    private _getAndResetActiveResponseHeaders;
+    private _updateStates;
+    private static _needPartitionKeyRangeCacheRefresh;
+    /**
+     * Fetches and bufferes the next page of results in internal buffer
+     */
+    bufferMore(diagnosticNode: DiagnosticNodeInternal): Promise<void>;
+    getTargetParitionKeyRange(): PartitionKeyRange;
+    /**
+     * Peak the next item in the buffer
+     */
+    peakNextItem(): any;
+    /**
+     * Returns the first item in the buffered results if any, or [] otherwise.
+     */
+    fetchNextItem(): Promise<Response<any>>;
+    /**
+     * Fetches all the buffered results
+     */
+    fetchBufferedItems(): Promise<Response<any[]>>;
+    /**
+     * Retrieve the current element on the DocumentProducer.
+     */
+    private current;
+}
+//# sourceMappingURL=documentProducer.d.ts.map

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

@@ -0,0 +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;AAGhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,cAAc;AACd,qBAAa,gBAAgB;IAyBzB,OAAO,CAAC,aAAa;IAxBvB,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,WAAW,CAAgB;IACnC,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;IAwBnC,iBAAiB,IAAI,GAAG,EAAE;IAmB1B,aAAa,EAAE,qBAAqB,CAwBzC;IAEK,cAAc,IAAI,OAAO;IAIzB,QAAQ,IAAI,OAAO;IAY1B,OAAO,CAAC,iCAAiC;IAMzC,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,MAAM,CAAC,kCAAkC;IASjD;;OAEG;IACU,UAAU,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkDvE,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;IA4B3D;;OAEG;IACH,OAAO,CAAC,OAAO;CAiChB"}