ag-common 0.0.740 → 0.0.742

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

@@ -0,0 +1,30 @@
+/**
+ * Sends a message to a specific WebSocket connection
+ */
+export declare function sendWebSocketMessage<T>({ connectionId, message, endpoint, }: {
+    connectionId: string;
+    message: T;
+    endpoint: string;
+}): Promise<boolean>;
+/**
+ * Deletes a WebSocket connection
+ */
+export declare function deleteConnection({ connectionId, endpoint, }: {
+    connectionId: string;
+    endpoint: string;
+}): Promise<boolean>;
+/**
+ * Checks if a WebSocket connection is still active
+ */
+export declare function isConnectionActive({ connectionId, endpoint, }: {
+    connectionId: string;
+    endpoint: string;
+}): Promise<boolean>;
+/**
+ * Broadcasts a message to multiple WebSocket connections
+ */
+export declare function broadcastMessage<T>({ connectionIds, message, endpoint, }: {
+    connectionIds: string[];
+    message: T;
+    endpoint: string;
+}): Promise<boolean>;

package/dist/api/helpers/apigw.js

@@ -0,0 +1,100 @@
+"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.sendWebSocketMessage = sendWebSocketMessage;
+exports.deleteConnection = deleteConnection;
+exports.isConnectionActive = isConnectionActive;
+exports.broadcastMessage = broadcastMessage;
+const client_apigatewaymanagementapi_1 = require("@aws-sdk/client-apigatewaymanagementapi");
+const common_1 = require("../../common");
+/**
+ * Sends a message to a specific WebSocket connection
+ */
+function sendWebSocketMessage(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ connectionId, message, endpoint, }) {
+        const wsClient = new client_apigatewaymanagementapi_1.ApiGatewayManagementApiClient({
+            endpoint,
+        });
+        try {
+            const s = yield wsClient.send(new client_apigatewaymanagementapi_1.PostToConnectionCommand({
+                ConnectionId: connectionId,
+                Data: JSON.stringify(message),
+            }));
+            if (s.$metadata.httpStatusCode === 200) {
+                return true;
+            }
+            return false;
+        }
+        catch (e) {
+            (0, common_1.warn)('Failed to send WebSocket message:', e.message);
+            return false;
+        }
+    });
+}
+/**
+ * Deletes a WebSocket connection
+ */
+function deleteConnection(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ connectionId, endpoint, }) {
+        const wsClient = new client_apigatewaymanagementapi_1.ApiGatewayManagementApiClient({
+            endpoint,
+        });
+        try {
+            const s = yield wsClient.send(new client_apigatewaymanagementapi_1.DeleteConnectionCommand({
+                ConnectionId: connectionId,
+            }));
+            if (s.$metadata.httpStatusCode === 200) {
+                return true;
+            }
+            return false;
+        }
+        catch (e) {
+            (0, common_1.warn)('Failed to delete WebSocket connection:', e.message);
+            return false;
+        }
+    });
+}
+/**
+ * Checks if a WebSocket connection is still active
+ */
+function isConnectionActive(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ connectionId, endpoint, }) {
+        const wsClient = new client_apigatewaymanagementapi_1.ApiGatewayManagementApiClient({
+            endpoint,
+        });
+        try {
+            const s = yield wsClient.send(new client_apigatewaymanagementapi_1.GetConnectionCommand({
+                ConnectionId: connectionId,
+            }));
+            if (s.$metadata.httpStatusCode === 200) {
+                return true;
+            }
+            return false;
+        }
+        catch (e) {
+            (0, common_1.warn)('Failed to check if WebSocket connection is active:', e.message);
+            return false;
+        }
+    });
+}
+/**
+ * Broadcasts a message to multiple WebSocket connections
+ */
+function broadcastMessage(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ connectionIds, message, endpoint, }) {
+        const results = yield Promise.all(connectionIds.map((connectionId) => sendWebSocketMessage({
+            connectionId,
+            message,
+            endpoint,
+        })));
+        return results.every((r) => r);
+    });
+}

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

@@ -30,14 +30,14 @@ const batchDelete = (params) => __awaiter(void 0, void 0, void 0, function* () {
         const chunked = (0, array_1.chunk)(params.keys, batchSize);
         let processed = 0;
         yield (0, async_1.asyncForEach)(chunked, (chunk) => __awaiter(void 0, void 0, void 0, function* () {
-            const command = new lib_dynamodb_1.BatchWriteCommand({
+            const batchDeleteParams = {
                 RequestItems: {
                     [params.tableName]: chunk.map((key) => ({
                         DeleteRequest: { Key: { [params.pkName]: key } },
                     })),
                 },
-            });
-            yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(command), `batchdelete ${processed}/${params.keys.length}. size=${batchSize}`, {
+            };
+            yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.BatchWriteCommand(batchDeleteParams)), `batchdelete ${processed}/${params.keys.length}. size=${batchSize}`, {
                 maxRetries: alwaysRetry ? null : undefined,
             });
             processed += chunk.length;

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

@@ -62,11 +62,10 @@ const executeQuery = (params, startKey) => __awaiter(void 0, void 0, void 0, fun
             eav[`:${skName.toLowerCase()}`] = skValue;
         }
     }
-    const queryParams = new lib_dynamodb_1.QueryCommand(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: startKey }, (params.filter && Object.assign({ FilterExpression: params.filter.filterExpression }, (params.filter.attrValues && {
         ExpressionAttributeValues: Object.assign(Object.assign({}, eav), params.filter.attrValues),
-    })))));
-    // eslint-disable-next-line no-return-await
-    return yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(queryParams), 'queryDynamo');
+    }))));
+    return (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.QueryCommand(queryParams)), 'queryDynamo');
 });
 /**
  * Helper function that builds the scan parameters and executes the scan
@@ -78,7 +77,7 @@ const executeScan = (tableName, options, exclusiveStartKey) => __awaiter(void 0,
         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);
-    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: options === null || options === void 0 ? void 0 : options.BATCH_SIZE }, ((options === null || options === void 0 ? void 0 : options.filter) && Object.assign({ FilterExpression: options.filter.filterExpression }, (options.filter.attrValues && {
+    const scanParams = Object.assign(Object.assign(Object.assign(Object.assign({ TableName: tableName, IndexName: options === null || options === void 0 ? void 0 : options.indexName, Limit: options === null || options === void 0 ? void 0 : options.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,
@@ -86,16 +85,15 @@ const executeScan = (tableName, options, exclusiveStartKey) => __awaiter(void 0,
         ProjectionExpression: options.requiredAttributeList
             .map((_, index) => `#proj${index}`)
             .join(', '),
-    })), { ExclusiveStartKey: exclusiveStartKey }));
-    // eslint-disable-next-line no-return-await
-    return yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(params), `scan. already seen=${exclusiveStartKey ? 'some' : '0'} items`, {
+    })), { ExclusiveStartKey: exclusiveStartKey });
+    return (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.ScanCommand(scanParams)), `scan. already seen=${exclusiveStartKey ? 'some' : '0'} items`, {
         maxRetries: (options === null || options === void 0 ? void 0 : options.alwaysRetry) ? null : undefined,
     });
 });
 const getItemsDynamo = (params) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     try {
-        const command = new lib_dynamodb_1.BatchGetCommand({
+        const batchGetParams = {
             RequestItems: {
                 [params.tableName]: {
                     Keys: params.items.map(({ pkName, pkValue }) => ({
@@ -103,8 +101,8 @@ const getItemsDynamo = (params) => __awaiter(void 0, void 0, void 0, function* (
                     })),
                 },
             },
-        });
-        const result = yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(command), 'getItemsDynamo');
+        };
+        const result = yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.BatchGetCommand(batchGetParams)), 'getItemsDynamo');
         return {
             data: (_b = (_a = result.Responses) === null || _a === void 0 ? void 0 : _a[params.tableName]) !== null && _b !== void 0 ? _b : [],
         };

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

@@ -16,11 +16,11 @@ const async_1 = require("../../../common/helpers/async");
 const withRetry_1 = require("../withRetry");
 const _1 = require(".");
 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) && {
+    const putParams = 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)(() => _1.dynamoDb.send(params), 'putDynamo');
+        yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.PutCommand(putParams)), 'putDynamo');
         return { data: undefined };
     }
     catch (e) {
@@ -34,12 +34,12 @@ const batchWrite = (tableName, items, opt) => __awaiter(void 0, void 0, void 0,
         let processed = 0;
         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({
+            const batchWriteParams = {
                 RequestItems: {
                     [tableName]: chunk.map((Item) => ({ PutRequest: { Item } })),
                 },
-            });
-            yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(params), `batchwrite ${processed}/${items.length}. size=${batchSize}`, {
+            };
+            yield (0, withRetry_1.withRetry)(() => _1.dynamoDb.send(new lib_dynamodb_1.BatchWriteCommand(batchWriteParams)), `batchwrite ${processed}/${items.length}. size=${batchSize}`, {
                 maxRetries: (opt === null || opt === void 0 ? void 0 : opt.alwaysRetry) ? null : undefined,
             });
             processed += chunk.length;

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

@@ -1,4 +1,5 @@
 export * from './api';
+export * from './apigw';
 export * from './aws';
 export * from './dynamo';
 export * from './enforceDynamoProvisionCap';

package/dist/api/helpers/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api"), exports);
+__exportStar(require("./apigw"), exports);
 __exportStar(require("./aws"), exports);
 __exportStar(require("./dynamo"), exports);
 __exportStar(require("./enforceDynamoProvisionCap"), exports);

package/dist/ui/helpers/cookie/raw.d.ts

@@ -10,7 +10,7 @@ export declare const getCookie: ({ name, cookieDocument, }: {
     cookieDocument?: string;
 }) => string | undefined;
 /**
- * expiryDays <0 will delete
+ * Sets a cookie with the specified name and value
  * @param param0
  * @returns
  */
@@ -18,7 +18,11 @@ export declare function setCookie({ name, value, expiryDays, }: {
     name: string;
     value: string;
     /**
-     * defaults to 1
+     * Number of days until the cookie expires
+     * - Default: 1 day
+     * - Use 0 to set a session cookie (expires when browser closes)
+     * - Use a very large number (e.g. 36500 for ~100 years) to effectively disable expiration
+     * - Use negative number to delete the cookie
      */
     expiryDays?: number;
 }): void;

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

@@ -28,7 +28,7 @@ exports.getAllCookies = getAllCookies;
 const getCookie = ({ name, cookieDocument, }) => (0, exports.getAllCookies)(cookieDocument)[name];
 exports.getCookie = getCookie;
 /**
- * expiryDays <0 will delete
+ * Sets a cookie with the specified name and value
  * @param param0
  * @returns
  */

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.740",
+  "version": "0.0.742",
   "name": "ag-common",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,6 +18,7 @@
     "test": "globstar -- node --import tsx --test \"src/**/*.test.ts\""
   },
   "dependencies": {
+    "@aws-sdk/client-apigatewaymanagementapi": "^3.804.0",
     "@aws-sdk/client-dynamodb": "^3.788.0",
     "@aws-sdk/client-s3": "^3.787.0",
     "@aws-sdk/client-ses": "^3.787.0",