ag-common 0.0.730 → 0.0.732

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

@@ -46,17 +46,70 @@ interface DynamoQueryParams {
     sortAscending?: boolean;
 }
 export declare let dynamoDb: DynamoDBDocument;
+/**
+ * Sets up the DynamoDB client with the specified region and credentials.
+ * @param region - AWS region to connect to
+ * @param credentials - Optional AWS credentials
+ * @returns Configured DynamoDBDocument client
+ */
 export declare const setDynamo: (region: string, credentials?: AwsCredentialIdentity) => DynamoDBDocument;
+/**
+ * Puts a single item into a DynamoDB table.
+ * @param item - The item to put into the table
+ * @param tableName - Name of the DynamoDB table
+ * @param opt - Optional parameters including primary key name for conditional put
+ * @returns Promise resolving to void on success or error message on failure
+ */
 export declare const putDynamo: <T extends Record<string, unknown>>(item: T, tableName: string, opt?: {
     pkName?: string;
 }) => Promise<DynamoDBResult<void>>;
-export declare const batchWrite: <T extends Record<string, unknown>>(tableName: string, items: T[]) => Promise<DynamoDBResult<void>>;
+/**
+ * Writes multiple items to a DynamoDB table in batches.
+ * Automatically chunks items into batches of 20 (or specified size) to comply with DynamoDB limits.
+ * @param tableName - Name of the DynamoDB table
+ * @param items - Array of items to write
+ * @param opt - Optional parameters including batch size and retry behavior
+ * @returns Promise resolving to void on success or error message on failure
+ */
+export declare const batchWrite: <T extends Record<string, unknown>>(tableName: string, items: T[], opt?: {
+    /** option to always retry on 429 until done */
+    alwaysRetry?: boolean;
+    /** default 20 */
+    batchSize?: number;
+}) => Promise<DynamoDBResult<void>>;
+/**
+ * Deletes multiple items from a DynamoDB table in batches.
+ * Automatically chunks keys into batches of 20 (or specified size) to comply with DynamoDB limits.
+ * @param params - Parameters including table name, keys to delete, and options
+ * @returns Promise resolving to void on success or error message on failure
+ */
 export declare const batchDelete: (params: {
     tableName: string;
     keys: string[];
     pkName: string;
+    opt?: {
+        /** default 20 */
+        batchSize?: number;
+        /** option to always retry on 429 until done. default false */
+        alwaysRetry?: boolean;
+    };
 }) => Promise<DynamoDBResult<void>>;
+/**
+ * Scans a DynamoDB table and returns all matching items.
+ * Handles pagination automatically and supports filtering and projection.
+ * @param tableName - Name of the DynamoDB table
+ * @param options - Optional parameters for filtering, projection, and index usage
+ * @returns Promise resolving to array of items on success or error message on failure
+ */
 export declare const scan: <T>(tableName: string, options?: ScanOptions) => Promise<DynamoDBResult<T[]>>;
+/**
+ * Scans a DynamoDB table and yields items in batches.
+ * Useful for processing large tables without loading all items into memory.
+ * @param tableName - Name of the DynamoDB table
+ * @param options - Optional parameters including batch size, filtering, and projection
+ * @returns AsyncGenerator yielding batches of items
+ * @throws Error if the scan operation fails
+ */
 export declare function scanWithGenerator<T>(tableName: string, options?: ScanOptions & {
     /** how many to return in scan generator. default 100 */
     BATCH_SIZE?: number;

package/dist/api/helpers/dynamo.js

@@ -28,39 +28,14 @@ const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 const array_1 = require("../../common/helpers/array");
 const async_1 = require("../../common/helpers/async");
-const log_1 = require("../../common/helpers/log");
-const sleep_1 = require("../../common/helpers/sleep");
-const RETRY_CONFIG = {
-    maxRetries: 3,
-    baseDelay: 2000,
-};
+const withRetry_1 = require("./withRetry");
 const isError = (result) => 'error' in result;
-const withRetry = (operation, operationName) => __awaiter(void 0, void 0, void 0, function* () {
-    let retryCount = 0;
-    // eslint-disable-next-line
-    while (true) {
-        try {
-            return yield operation();
-        }
-        catch (e) {
-            const error = e;
-            const errorString = error.toString();
-            if (errorString.includes('429') ||
-                errorString.includes('ProvisionedThroughputExceeded')) {
-                retryCount++;
-                if (retryCount >= RETRY_CONFIG.maxRetries) {
-                    (0, log_1.warn)(`${operationName}: Max retries exceeded`);
-                    throw error;
-                }
-                const delay = RETRY_CONFIG.baseDelay * Math.pow(2, retryCount - 1);
-                (0, log_1.warn)(`${operationName}: Throttled. Retry ${retryCount}`);
-                yield (0, sleep_1.sleep)(delay);
-                continue;
-            }
-            throw error;
-        }
-    }
-});
+/**
+ * Sets up the DynamoDB client with the specified region and credentials.
+ * @param region - AWS region to connect to
+ * @param credentials - Optional AWS credentials
+ * @returns Configured DynamoDBDocument client
+ */
 const setDynamo = (region, credentials) => {
     const client = new client_dynamodb_1.DynamoDBClient({ region, credentials });
     exports.dynamoDb = lib_dynamodb_1.DynamoDBDocument.from(client, {
@@ -70,12 +45,19 @@ const setDynamo = (region, credentials) => {
 };
 exports.setDynamo = setDynamo;
 exports.dynamoDb = (0, exports.setDynamo)('ap-southeast-2');
+/**
+ * Puts a single item into a DynamoDB table.
+ * @param item - The item to put into the table
+ * @param tableName - Name of the DynamoDB table
+ * @param opt - Optional parameters including primary key name for conditional put
+ * @returns Promise resolving to void on success or error message on failure
+ */
 const putDynamo = (item, tableName, opt) => __awaiter(void 0, void 0, void 0, function* () {
     const params = new lib_dynamodb_1.PutCommand(Object.assign({ TableName: tableName, Item: item }, ((opt === null || opt === void 0 ? void 0 : opt.pkName) && {
         ConditionExpression: `attribute_not_exists(${opt.pkName})`,
     })));
     try {
-        yield withRetry(() => exports.dynamoDb.send(params), 'putDynamo');
+        yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'putDynamo');
         return { data: undefined };
     }
     catch (e) {
@@ -83,16 +65,27 @@ const putDynamo = (item, tableName, opt) => __awaiter(void 0, void 0, void 0, fu
     }
 });
 exports.putDynamo = putDynamo;
-const batchWrite = (tableName, items) => __awaiter(void 0, void 0, void 0, function* () {
+/**
+ * Writes multiple items to a DynamoDB table in batches.
+ * Automatically chunks items into batches of 20 (or specified size) to comply with DynamoDB limits.
+ * @param tableName - Name of the DynamoDB table
+ * @param items - Array of items to write
+ * @param opt - Optional parameters including batch size and retry behavior
+ * @returns Promise resolving to void on success or error message on failure
+ */
+const batchWrite = (tableName, items, opt) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const chunked = (0, array_1.chunk)(items, 20);
+        const { batchSize = 20 } = opt !== null && opt !== void 0 ? opt : {};
+        const chunked = (0, array_1.chunk)(items, batchSize);
         yield (0, async_1.asyncForEach)(chunked, (chunk) => __awaiter(void 0, void 0, void 0, function* () {
             const params = new lib_dynamodb_1.BatchWriteCommand({
                 RequestItems: {
                     [tableName]: chunk.map((Item) => ({ PutRequest: { Item } })),
                 },
             });
-            yield withRetry(() => exports.dynamoDb.send(params), 'batchWrite');
+            yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'batchWrite', {
+                maxRetries: (opt === null || opt === void 0 ? void 0 : opt.alwaysRetry) ? null : undefined,
+            });
         }));
         return { data: undefined };
     }
@@ -101,9 +94,17 @@ const batchWrite = (tableName, items) => __awaiter(void 0, void 0, void 0, funct
     }
 });
 exports.batchWrite = batchWrite;
+/**
+ * Deletes multiple items from a DynamoDB table in batches.
+ * Automatically chunks keys into batches of 20 (or specified size) to comply with DynamoDB limits.
+ * @param params - Parameters including table name, keys to delete, and options
+ * @returns Promise resolving to void on success or error message on failure
+ */
 const batchDelete = (params) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
     try {
-        const chunked = (0, array_1.chunk)(params.keys, 20);
+        const { batchSize = 20, alwaysRetry = false } = (_a = params.opt) !== null && _a !== void 0 ? _a : {};
+        const chunked = (0, array_1.chunk)(params.keys, batchSize);
         yield (0, async_1.asyncForEach)(chunked, (chunk) => __awaiter(void 0, void 0, void 0, function* () {
             const command = new lib_dynamodb_1.BatchWriteCommand({
                 RequestItems: {
@@ -112,7 +113,9 @@ const batchDelete = (params) => __awaiter(void 0, void 0, void 0, function* () {
                     })),
                 },
             });
-            yield withRetry(() => exports.dynamoDb.send(command), 'batchDelete');
+            yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(command), 'batchDelete', {
+                maxRetries: alwaysRetry ? null : undefined,
+            });
         }));
         return { data: undefined };
     }
@@ -121,6 +124,13 @@ const batchDelete = (params) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 exports.batchDelete = batchDelete;
+/**
+ * Scans a DynamoDB table and returns all matching items.
+ * Handles pagination automatically and supports filtering and projection.
+ * @param tableName - Name of the DynamoDB table
+ * @param options - Optional parameters for filtering, projection, and index usage
+ * @returns Promise resolving to array of items on success or error message on failure
+ */
 const scan = (tableName, options) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     try {
@@ -141,7 +151,7 @@ const scan = (tableName, options) => __awaiter(void 0, void 0, void 0, function*
                     .map((_, index) => `#proj${index}`)
                     .join(', '),
             })), { ExclusiveStartKey }));
-            const result = yield withRetry(() => exports.dynamoDb.send(params), 'scan');
+            const result = yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'scan');
             if (result.Items) {
                 Items.push(...result.Items);
             }
@@ -154,6 +164,14 @@ const scan = (tableName, options) => __awaiter(void 0, void 0, void 0, function*
     }
 });
 exports.scan = scan;
+/**
+ * Scans a DynamoDB table and yields items in batches.
+ * Useful for processing large tables without loading all items into memory.
+ * @param tableName - Name of the DynamoDB table
+ * @param options - Optional parameters including batch size, filtering, and projection
+ * @returns AsyncGenerator yielding batches of items
+ * @throws Error if the scan operation fails
+ */
 function scanWithGenerator(tableName, options) {
     return __asyncGenerator(this, arguments, function* scanWithGenerator_1() {
         var _a, _b, _c;
@@ -176,7 +194,7 @@ function scanWithGenerator(tableName, options) {
                         .map((_, index) => `#proj${index}`)
                         .join(', '),
                 })), { ExclusiveStartKey: exclusiveStartKey }));
-                const result = yield __await(withRetry(() => exports.dynamoDb.send(params), 'scanWithGenerator'));
+                const result = yield __await((0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'scanWithGenerator'));
                 if (result.Items) {
                     items.push(...result.Items);
                     // Process items in chunks of BATCH_SIZE
@@ -210,7 +228,7 @@ const getItemsDynamo = (params) => __awaiter(void 0, void 0, void 0, function* (
                 },
             },
         });
-        const result = yield withRetry(() => exports.dynamoDb.send(command), 'getItemsDynamo');
+        const result = yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(command), 'getItemsDynamo');
         return {
             data: (_b = (_a = result.Responses) === null || _a === void 0 ? void 0 : _a[params.tableName]) !== null && _b !== void 0 ? _b : [],
         };
@@ -284,7 +302,7 @@ const queryDynamo = (params) => __awaiter(void 0, void 0, void 0, function* () {
                 ExclusiveStartKey: startKey,
                 FilterExpression,
             });
-            const result = yield withRetry(() => exports.dynamoDb.send(queryParams), 'queryDynamo');
+            const result = yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(queryParams), 'queryDynamo');
             if (result.Items) {
                 items.push(...result.Items);
             }
@@ -310,7 +328,7 @@ exports.getDynamoTtlMinutes = getDynamoTtlMinutes;
 const wipeTable = (tableName) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c;
     try {
-        const info = yield withRetry(() => exports.dynamoDb.send(new client_dynamodb_1.DescribeTableCommand({ TableName: tableName })), 'wipeTable-describe');
+        const info = yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(new client_dynamodb_1.DescribeTableCommand({ TableName: tableName })), 'wipeTable-describe');
         const keyHash = (_c = (_b = (_a = info.Table) === null || _a === void 0 ? void 0 : _a.KeySchema) === null || _b === void 0 ? void 0 : _b.find((k) => k.KeyType === 'HASH')) === null || _c === void 0 ? void 0 : _c.AttributeName;
         if (!keyHash) {
             throw new Error('Could not find hash key');

package/dist/api/helpers/withRetry.d.ts

@@ -0,0 +1,4 @@
+export declare const withRetry: <T>(operation: () => Promise<T>, operationName: string, opt?: {
+    /** default 3. null for infinite */
+    maxRetries?: number | null;
+}) => Promise<T>;

package/dist/api/helpers/withRetry.js

@@ -0,0 +1,44 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withRetry = void 0;
+const log_1 = require("../../common/helpers/log");
+const sleep_1 = require("../../common/helpers/sleep");
+const withRetry = (operation, operationName, opt) => __awaiter(void 0, void 0, void 0, function* () {
+    let retryCount = 0;
+    var baseDelay = 1000;
+    let { maxRetries = 3 } = opt !== null && opt !== void 0 ? opt : {};
+    // eslint-disable-next-line
+    while (true) {
+        try {
+            return yield operation();
+        }
+        catch (e) {
+            const error = e;
+            const errorString = error.toString().toLowerCase();
+            if (errorString.includes('429') ||
+                errorString.includes('provisionedthroughputexceeded') ||
+                errorString.includes('too large')) {
+                retryCount++;
+                if (maxRetries !== null && retryCount >= maxRetries) {
+                    (0, log_1.warn)(`${operationName}: Max retries exceeded`);
+                    throw error;
+                }
+                const delay = baseDelay * retryCount;
+                (0, log_1.warn)(`${operationName}: Throttled. Retry ${retryCount}. Sleeping for ${delay}ms`);
+                yield (0, sleep_1.sleep)(delay);
+                continue;
+            }
+            throw error;
+        }
+    }
+});
+exports.withRetry = withRetry;

package/dist/common/helpers/stream.js

@@ -17,7 +17,7 @@ function getStringFromStream(stream) {
         const reader = stream.getReader();
         let result = '';
         try {
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition,no-constant-condition
             while (true) {
                 const { done, value } = yield reader.read();
                 if (done)

package/dist/ui/helpers/cookie/get.js

@@ -23,7 +23,7 @@ function getCookieRawWrapper({ name, cookieDocument, defaultValue, parse: parseR
     };
     let raw = '';
     let currentCount = 0;
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition,no-constant-condition
     while (true) {
         const newv = (0, raw_1.getCookie)({
             name: name + currentCount,

package/dist/ui/helpers/cookie/raw.js

@@ -48,7 +48,7 @@ function wipeCookies(name) {
         return;
     }
     let currentCount = 0;
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition,no-constant-condition
     while (true) {
         if ((0, exports.getCookie)({
             name: name + currentCount,

package/package.json

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