ag-common 0.0.800 → 0.0.801

package/dist/api/helpers/dynamo/get.js

@@ -32,7 +32,7 @@ const isError = (result) => 'error' in result;
 /**
  * Helper function that builds the query parameters and executes the query
  */
-const executeQuery = (params, startKey) => __awaiter(void 0, void 0, void 0, function* () {
+const executeQuery = (params, exclusiveStartKey) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c, _d, _e;
     let kce = `#${params.pkName.toLowerCase()} ${(_a = params.pkOperator) !== null && _a !== void 0 ? _a : '='} :${params.pkName.toLowerCase()}`;
     const ean = {
@@ -61,7 +61,7 @@ const executeQuery = (params, startKey) => __awaiter(void 0, void 0, void 0, fun
             eav[`:${skName.toLowerCase()}`] = skValue;
         }
     }
-    const queryParams = Object.assign({ TableName: params.tableName, KeyConditionExpression: kce, ExpressionAttributeNames: Object.assign(Object.assign({}, ean), (_b = params.filter) === null || _b === void 0 ? void 0 : _b.attrNames), ExpressionAttributeValues: Object.assign(Object.assign({}, eav), (_c = params.filter) === null || _c === void 0 ? void 0 : _c.attrValues), ScanIndexForward: (_d = params.sortAscending) !== null && _d !== void 0 ? _d : true, Limit: (_e = params.BATCH_SIZE) !== null && _e !== void 0 ? _e : params.limit, IndexName: params.indexName, ExclusiveStartKey: startKey }, (params.filter && Object.assign({ FilterExpression: params.filter.filterExpression }, (params.filter.attrValues && {
+    const queryParams = Object.assign({ TableName: params.tableName, KeyConditionExpression: kce, ExpressionAttributeNames: Object.assign(Object.assign({}, ean), (_b = params.filter) === null || _b === void 0 ? void 0 : _b.attrNames), ExpressionAttributeValues: Object.assign(Object.assign({}, eav), (_c = params.filter) === null || _c === void 0 ? void 0 : _c.attrValues), ScanIndexForward: (_d = params.sortAscending) !== null && _d !== void 0 ? _d : true, Limit: (_e = params.BATCH_SIZE) !== null && _e !== void 0 ? _e : params.limit, IndexName: params.indexName, ExclusiveStartKey: exclusiveStartKey }, (params.filter && Object.assign({ FilterExpression: params.filter.filterExpression }, (params.filter.attrValues && {
         ExpressionAttributeValues: Object.assign(Object.assign({}, eav), params.filter.attrValues),
     }))));
     return (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.QueryCommand(queryParams)), 'queryDynamo:' + JSON.stringify(params), {
@@ -127,21 +127,27 @@ exports.getItemDynamo = getItemDynamo;
 const queryDynamo = (params) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const items = [];
-        let startKey;
+        let lastEvaluatedKey = params.exclusiveStartKey;
         do {
-            const result = yield executeQuery(params, startKey);
+            const result = yield executeQuery(params, lastEvaluatedKey);
             if (result.Items) {
                 items.push(...result.Items);
             }
-            startKey = result.LastEvaluatedKey;
+            lastEvaluatedKey = result.LastEvaluatedKey;
             // If we have a limit and we've reached it, stop processing
             if (params.limit && items.length >= params.limit) {
                 return {
                     data: items.slice(0, params.limit),
+                    lastEvaluatedKey,
                 };
             }
-        } while (startKey && Object.keys(startKey).length > 0);
-        return { data: items };
+            // If a start key was provided but no limit, we don't want to endlessly page
+            // so we stop after the first batch
+            if (params.exclusiveStartKey && !params.limit) {
+                break;
+            }
+        } while (lastEvaluatedKey && Object.keys(lastEvaluatedKey).length > 0);
+        return { data: items, lastEvaluatedKey };
     }
     catch (e) {
         return { error: e.toString() };
@@ -305,10 +311,10 @@ function queryWithGenerator(params) {
         var _a;
         const BATCH_SIZE = (_a = params.BATCH_SIZE) !== null && _a !== void 0 ? _a : 100;
         let items = [];
-        let startKey;
+        let lastEvaluatedKey = params.exclusiveStartKey;
         try {
             do {
-                const result = yield __await(executeQuery(params, startKey));
+                const result = yield __await(executeQuery(params, lastEvaluatedKey));
                 if (result.Items) {
                     items.push(...result.Items);
                     // Process items in chunks of BATCH_SIZE
@@ -318,8 +324,8 @@ function queryWithGenerator(params) {
                         yield yield __await(batch);
                     }
                 }
-                startKey = result.LastEvaluatedKey;
-            } while (startKey && Object.keys(startKey).length > 0);
+                lastEvaluatedKey = result.LastEvaluatedKey;
+            } while (lastEvaluatedKey && Object.keys(lastEvaluatedKey).length > 0);
             // Yield any remaining items
             if (items.length > 0) {
                 yield yield __await(items);

package/dist/api/helpers/dynamo/types.d.ts

@@ -1,8 +1,10 @@
+import type { Key } from '../../types';
 export type DynamoDBError = {
     error: string;
 };
 export type DynamoDBSuccess<T> = {
     data: T;
+    lastEvaluatedKey?: Key;
 };
 export type DynamoDBResult<T> = DynamoDBSuccess<T> | DynamoDBError;
 export interface DynamoFilter {
@@ -39,6 +41,7 @@ export interface DynamoQueryParams {
     sortAscending?: boolean;
     /** default 3, set to null to disable retries */
     maxRetries?: number | null;
+    exclusiveStartKey?: Key;
 }
 export interface DynamoBatchQueryParams {
     tableName: string;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.800",
+  "version": "0.0.801",
   "name": "ag-common",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",