ag-common 0.0.741 → 0.0.743

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/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/api/helpers/ssmInfra/apigw.d.ts

@@ -0,0 +1,22 @@
+import type { Stack } from 'aws-cdk-lib';
+import { aws_iam as iam } from 'aws-cdk-lib';
+import type { IWebSocketApi, WebSocketStage } from 'aws-cdk-lib/aws-apigatewayv2';
+import { WebSocketApi } from 'aws-cdk-lib/aws-apigatewayv2';
+import type { IUser } from 'aws-cdk-lib/aws-iam';
+export declare const generateApigwRef: ({ stack, baseKey, }: {
+    stack: Stack;
+    baseKey: string;
+}) => {
+    api: IWebSocketApi;
+    stageName: string;
+};
+export declare const generateApigwSSMParams: ({ stack, api, baseKey, stage, }: {
+    stack: Stack;
+    api: WebSocketApi;
+    baseKey: string;
+    stage: WebSocketStage;
+}) => void;
+export declare function grantWebSocketManageConnectionsToUser(stack: Stack, apiGw: IWebSocketApi, stage: string, user: IUser): void;
+export declare function grantWebSocketManageConnectionsToRole(stack: Stack, apiGw: IWebSocketApi, stage: string, ref: {
+    addToRolePolicy: (statement: iam.PolicyStatement) => void;
+}): void;

package/dist/api/helpers/ssmInfra/apigw.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApigwSSMParams = exports.generateApigwRef = void 0;
+exports.grantWebSocketManageConnectionsToUser = grantWebSocketManageConnectionsToUser;
+exports.grantWebSocketManageConnectionsToRole = grantWebSocketManageConnectionsToRole;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const aws_apigatewayv2_1 = require("aws-cdk-lib/aws-apigatewayv2");
+const ssm_1 = require("../ssm");
+const generateApigwRef = ({ stack, baseKey, }) => {
+    const webSocketId = (0, ssm_1.loadSsmString)({ stack, path: `${baseKey}/id` });
+    const apiEndpoint = (0, ssm_1.loadSsmString)({ stack, path: `${baseKey}/endpoint` });
+    const stageName = (0, ssm_1.loadSsmString)({ stack, path: `${baseKey}/stage` });
+    const api = aws_apigatewayv2_1.WebSocketApi.fromWebSocketApiAttributes(stack, baseKey, {
+        webSocketId,
+        apiEndpoint,
+    });
+    return { api, stageName };
+};
+exports.generateApigwRef = generateApigwRef;
+const generateApigwSSMParams = ({ stack, api, baseKey, stage, }) => {
+    (0, ssm_1.saveToSsm)({ stack, path: `${baseKey}/id`, value: api.apiId });
+    (0, ssm_1.saveToSsm)({ stack, path: `${baseKey}/endpoint`, value: api.apiEndpoint });
+    (0, ssm_1.saveToSsm)({ stack, path: `${baseKey}/stage`, value: stage.stageName });
+};
+exports.generateApigwSSMParams = generateApigwSSMParams;
+function grantWebSocketManageConnectionsToUser(stack, apiGw, stage, user) {
+    const statement = new aws_cdk_lib_1.aws_iam.PolicyStatement({
+        actions: ['execute-api:ManageConnections'],
+        resources: [
+            `arn:aws:execute-api:${stack.region}:${stack.account}:${apiGw.apiId}/${stage}/*`,
+        ],
+    });
+    const policy = new aws_cdk_lib_1.aws_iam.ManagedPolicy(stack, 'WebSocketConnectionPolicy', {
+        statements: [statement],
+    });
+    user.addManagedPolicy(policy);
+}
+function grantWebSocketManageConnectionsToRole(stack, apiGw, stage, ref) {
+    const statement = new aws_cdk_lib_1.aws_iam.PolicyStatement({
+        actions: ['execute-api:ManageConnections'],
+        resources: [
+            `arn:aws:execute-api:${stack.region}:${stack.account}:${apiGw.apiId}/${stage}/*`,
+        ],
+    });
+    ref.addToRolePolicy(statement);
+}

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

@@ -1,3 +1,4 @@
+export * from './apigw';
 export * from './dynamo';
 export * from './s3';
 export * from './sqs';

package/dist/api/helpers/ssmInfra/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./apigw"), exports);
 __exportStar(require("./dynamo"), exports);
 __exportStar(require("./s3"), exports);
 __exportStar(require("./sqs"), 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.741",
+  "version": "0.0.743",
   "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",