ag-common 0.0.732 → 0.0.735

package/dist/api/helpers/dynamo.js

@@ -1,370 +0,0 @@
-"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());
-    });
-};
-var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
-var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
-    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
-    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
-    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
-    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
-    function fulfill(value) { resume("next", value); }
-    function reject(value) { resume("throw", value); }
-    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDynamoUpdates = exports.wipeTable = exports.getDynamoTtlMinutes = exports.getDynamoTtlDays = exports.queryDynamo = exports.getItemDynamo = exports.getItemsDynamo = exports.scan = exports.batchDelete = exports.batchWrite = exports.putDynamo = exports.setDynamo = exports.dynamoDb = void 0;
-exports.scanWithGenerator = scanWithGenerator;
-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 withRetry_1 = require("./withRetry");
-const isError = (result) => 'error' in result;
-/**
- * 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, {
-        marshallOptions: { removeUndefinedValues: true },
-    });
-    return exports.dynamoDb;
-};
-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 (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'putDynamo');
-        return { data: undefined };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-exports.putDynamo = putDynamo;
-/**
- * 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 { 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 (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'batchWrite', {
-                maxRetries: (opt === null || opt === void 0 ? void 0 : opt.alwaysRetry) ? null : undefined,
-            });
-        }));
-        return { data: undefined };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-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 { 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: {
-                    [params.tableName]: chunk.map((key) => ({
-                        DeleteRequest: { Key: { [params.pkName]: key } },
-                    })),
-                },
-            });
-            yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(command), 'batchDelete', {
-                maxRetries: alwaysRetry ? null : undefined,
-            });
-        }));
-        return { data: undefined };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-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 {
-        const Items = [];
-        let ExclusiveStartKey;
-        const projectionAttrs = (_a = options === null || options === void 0 ? void 0 : options.requiredAttributeList) === null || _a === void 0 ? void 0 : _a.reduce((acc, attr, index) => {
-            acc[`#proj${index}`] = attr;
-            return acc;
-        }, {});
-        const expressionAttributeNames = Object.assign(Object.assign({}, projectionAttrs), (_b = options === null || options === void 0 ? void 0 : options.filter) === null || _b === void 0 ? void 0 : _b.attrNames);
-        do {
-            const params = new lib_dynamodb_1.ScanCommand(Object.assign(Object.assign(Object.assign(Object.assign({ TableName: tableName, IndexName: options === null || options === void 0 ? void 0 : options.indexName }, ((options === null || options === void 0 ? void 0 : options.filter) && Object.assign({ FilterExpression: options.filter.filterExpression }, (options.filter.attrValues && {
-                ExpressionAttributeValues: options.filter.attrValues,
-            })))), (Object.keys(expressionAttributeNames).length > 0 && {
-                ExpressionAttributeNames: expressionAttributeNames,
-            })), ((options === null || options === void 0 ? void 0 : options.requiredAttributeList) && {
-                ProjectionExpression: options.requiredAttributeList
-                    .map((_, index) => `#proj${index}`)
-                    .join(', '),
-            })), { ExclusiveStartKey }));
-            const result = yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(params), 'scan');
-            if (result.Items) {
-                Items.push(...result.Items);
-            }
-            ExclusiveStartKey = result.LastEvaluatedKey;
-        } while (ExclusiveStartKey);
-        return { data: Items };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-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;
-        const BATCH_SIZE = (_a = options === null || options === void 0 ? void 0 : options.BATCH_SIZE) !== null && _a !== void 0 ? _a : 100;
-        let items = [];
-        let exclusiveStartKey;
-        try {
-            const projectionAttrs = (_b = options === null || options === void 0 ? void 0 : options.requiredAttributeList) === null || _b === void 0 ? void 0 : _b.reduce((acc, attr, index) => {
-                acc[`#proj${index}`] = attr;
-                return acc;
-            }, {});
-            const expressionAttributeNames = Object.assign(Object.assign({}, projectionAttrs), (_c = options === null || options === void 0 ? void 0 : options.filter) === null || _c === void 0 ? void 0 : _c.attrNames);
-            do {
-                const params = new lib_dynamodb_1.ScanCommand(Object.assign(Object.assign(Object.assign(Object.assign({ TableName: tableName, IndexName: options === null || options === void 0 ? void 0 : options.indexName, Limit: BATCH_SIZE }, ((options === null || options === void 0 ? void 0 : options.filter) && Object.assign({ FilterExpression: options.filter.filterExpression }, (options.filter.attrValues && {
-                    ExpressionAttributeValues: options.filter.attrValues,
-                })))), (Object.keys(expressionAttributeNames).length > 0 && {
-                    ExpressionAttributeNames: expressionAttributeNames,
-                })), ((options === null || options === void 0 ? void 0 : options.requiredAttributeList) && {
-                    ProjectionExpression: options.requiredAttributeList
-                        .map((_, index) => `#proj${index}`)
-                        .join(', '),
-                })), { ExclusiveStartKey: exclusiveStartKey }));
-                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
-                    while (items.length >= BATCH_SIZE) {
-                        const batch = items.slice(0, BATCH_SIZE);
-                        items = items.slice(BATCH_SIZE);
-                        yield yield __await(batch);
-                    }
-                }
-                exclusiveStartKey = result.LastEvaluatedKey;
-            } while (exclusiveStartKey);
-            // Yield any remaining items
-            if (items.length > 0) {
-                yield yield __await(items);
-            }
-        }
-        catch (e) {
-            throw new Error(`Scan generator error: ${e.toString()}`);
-        }
-    });
-}
-const getItemsDynamo = (params) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    try {
-        const command = new lib_dynamodb_1.BatchGetCommand({
-            RequestItems: {
-                [params.tableName]: {
-                    Keys: params.items.map(({ pkName, pkValue }) => ({
-                        [pkName]: pkValue,
-                    })),
-                },
-            },
-        });
-        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 : [],
-        };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-exports.getItemsDynamo = getItemsDynamo;
-const getItemDynamo = (params) => __awaiter(void 0, void 0, void 0, function* () {
-    const result = yield (0, exports.getItemsDynamo)({
-        tableName: params.tableName,
-        items: [{ pkName: params.pkName, pkValue: params.pkValue }],
-    });
-    if (isError(result)) {
-        return result;
-    }
-    return { data: result.data[0] };
-});
-exports.getItemDynamo = getItemDynamo;
-const queryDynamo = (params) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c;
-    try {
-        let kce = `#${params.pkName.toLowerCase()} ${(_a = params.pkOperator) !== null && _a !== void 0 ? _a : '='} :${params.pkName.toLowerCase()}`;
-        const ean = {
-            [`#${params.pkName.toLowerCase()}`]: params.pkName,
-        };
-        const eav = {
-            [`:${params.pkName.toLowerCase()}`]: params.pkValue,
-        };
-        if (params.skName && params.skValue !== undefined) {
-            const { skName, skValue, skOperator = '=' } = params;
-            if (skOperator === 'BETWEEN' && Array.isArray(skValue)) {
-                const [start, end] = skValue;
-                kce += ` AND #${skName.toLowerCase()} BETWEEN :${skName}1 AND :${skName}2`;
-                ean[`#${skName.toLowerCase()}`] = skName;
-                eav[`:${skName}1`] = start;
-                eav[`:${skName}2`] = end;
-            }
-            else if (skOperator === 'BEGINS_WITH') {
-                kce += ` AND begins_with(#${skName.toLowerCase()}, :${skName.toLowerCase()})`;
-                ean[`#${skName.toLowerCase()}`] = skName;
-                eav[`:${skName.toLowerCase()}`] = skValue;
-            }
-            else {
-                kce += ` AND #${skName.toLowerCase()} ${skOperator} :${skName.toLowerCase()}`;
-                ean[`#${skName.toLowerCase()}`] = skName;
-                eav[`:${skName.toLowerCase()}`] = skValue;
-            }
-        }
-        let FilterExpression;
-        if (params.filterName && params.filterValue !== undefined) {
-            ean[`#${params.filterName.toLowerCase()}`] = params.filterName;
-            eav[`:${params.filterName.toLowerCase()}`] = params.filterValue;
-            FilterExpression =
-                params.filterOperator === 'contains'
-                    ? `contains(#${params.filterName.toLowerCase()}, :${params.filterName.toLowerCase()})`
-                    : `#${params.filterName.toLowerCase()} ${(_b = params.filterOperator) !== null && _b !== void 0 ? _b : '='} :${params.filterName.toLowerCase()}`;
-        }
-        const items = [];
-        let { startKey } = params;
-        do {
-            const queryParams = new lib_dynamodb_1.QueryCommand({
-                TableName: params.tableName,
-                KeyConditionExpression: kce,
-                ExpressionAttributeNames: ean,
-                ExpressionAttributeValues: eav,
-                ScanIndexForward: (_c = params.sortAscending) !== null && _c !== void 0 ? _c : true,
-                Limit: params.limit,
-                IndexName: params.indexName,
-                ExclusiveStartKey: startKey,
-                FilterExpression,
-            });
-            const result = yield (0, withRetry_1.withRetry)(() => exports.dynamoDb.send(queryParams), 'queryDynamo');
-            if (result.Items) {
-                items.push(...result.Items);
-            }
-            startKey = result.LastEvaluatedKey;
-            if (params.limit && items.length >= params.limit) {
-                return {
-                    data: items.slice(0, params.limit),
-                    startKey,
-                };
-            }
-        } while (startKey && Object.keys(startKey).length > 0);
-        return { data: items };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-exports.queryDynamo = queryDynamo;
-const getDynamoTtlDays = (days) => Math.ceil(Date.now() / 1000) + days * 86400;
-exports.getDynamoTtlDays = getDynamoTtlDays;
-const getDynamoTtlMinutes = (minutes) => Math.ceil(Date.now() / 1000) + minutes * 60;
-exports.getDynamoTtlMinutes = getDynamoTtlMinutes;
-const wipeTable = (tableName) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c;
-    try {
-        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');
-        }
-        const scanResult = yield (0, exports.scan)(tableName);
-        if (isError(scanResult)) {
-            throw new Error(scanResult.error);
-        }
-        yield (0, exports.batchDelete)({
-            tableName,
-            keys: scanResult.data.map((item) => item[keyHash]),
-            pkName: keyHash,
-        });
-        return { data: undefined };
-    }
-    catch (e) {
-        return { error: e.toString() };
-    }
-});
-exports.wipeTable = wipeTable;
-const getDynamoUpdates = (item, options) => {
-    var _a;
-    const excludeKeys = ((_a = options === null || options === void 0 ? void 0 : options.excludeKeys) !== null && _a !== void 0 ? _a : ['PK']).map((k) => k.toLowerCase());
-    const validEntries = Object.entries(item).filter(([key, value]) => !excludeKeys.includes(key.toLowerCase()) && value != null);
-    const ExpressionAttributeNames = {};
-    const ExpressionAttributeValues = {};
-    const UpdateExpression = validEntries.reduce((expr, [key, value], index) => {
-        ExpressionAttributeNames[`#${key}`] = key;
-        ExpressionAttributeValues[`:${key}`] = value;
-        return `${expr}${index > 0 ? ', ' : ''}#${key} = :${key}`;
-    }, 'SET ');
-    return {
-        UpdateExpression,
-        ExpressionAttributeNames,
-        ExpressionAttributeValues,
-        ReturnValues: 'UPDATED_NEW',
-    };
-};
-exports.getDynamoUpdates = getDynamoUpdates;