@fy-stack/event-construct 0.0.124 → 0.0.126

package/README.md

@@ -1,7 +1,18 @@
-# event-construct
+# Event Construct Documentation
 
-This library was generated with [Nx](https://nx.dev).
+## `EventConstruct`
 
-## Building
+The `EventConstruct` class is a specialized construct in the AWS CDK that manages SNS topics and scheduled events. This construct implements the `Attachable` and `Grantable` interfaces.
+
+- **Properties**
+    - `topic: sns.Topic`
+        - The SNS topic managed by this construct.
+
+- **Constructor**
+    - `constructor(scope: Construct, id: string, props: EventConstructProps)`
+        - Initializes the event construct with a unique identifier and configuration options defined by `EventConstructProps`.
+        - **Parameters**
+            - `scope`: The scope in which this construct is defined.
+            - `id`: The unique identifier for this construct.
+            - `props`: Properties required to set up the event construct.
 
-Run `nx build event-construct` to build the library.

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export { EventConstruct } from './lib/event-construct';
-export type { AppCron, AppMessage, AppRef, EventConstructProps } from './lib/types';
+export { WebsocketConstruct } from './lib/websocket-construct';
+export type { AppCron, AppMessage, EventConstructProps, WebsocketConstructProps, } from './lib/types';
+export { AuthProviderCapability } from './lib/types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,YAAY,EACV,OAAO,EACP,UAAU,EACV,mBAAmB,EACnB,uBAAuB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventConstruct = void 0;
+exports.AuthProviderCapability = exports.WebsocketConstruct = exports.EventConstruct = void 0;
 var event_construct_1 = require("./lib/event-construct");
 Object.defineProperty(exports, "EventConstruct", { enumerable: true, get: function () { return event_construct_1.EventConstruct; } });
+var websocket_construct_1 = require("./lib/websocket-construct");
+Object.defineProperty(exports, "WebsocketConstruct", { enumerable: true, get: function () { return websocket_construct_1.WebsocketConstruct; } });
+var types_1 = require("./lib/types");
+Object.defineProperty(exports, "AuthProviderCapability", { enumerable: true, get: function () { return types_1.AuthProviderCapability; } });

package/dist/lib/event-construct.d.ts

@@ -3,6 +3,12 @@ import { IGrantable } from 'aws-cdk-lib/aws-iam';
 import * as sns from 'aws-cdk-lib/aws-sns';
 import { Construct } from 'constructs';
 import { EventConstructProps } from './types';
+/**
+ * The EventConstruct class is a custom construct that creates an SNS topic and manages event subscriptions
+ * and scheduled jobs for the given resources and event definitions.
+ *
+ * It extends the Construct class and implements the {@link Attachable `Attachable`} and {@link Grantable `Grantable`} interfaces.
+ */
 export declare class EventConstruct extends Construct implements Attachable, Grantable {
     readonly topic: sns.Topic;
     constructor(scope: Construct, id: string, props: EventConstructProps);

package/dist/lib/event-construct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-construct.d.ts","sourceRoot":"","sources":["../../src/lib/event-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGxD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C,qBAAa,cAAe,SAAQ,SAAU,YAAW,UAAU,EAAE,SAAS;IAC5E,SAAgB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;gBAErB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB;IA4CpE,UAAU;;;IAMV,SAAS,CAAC,KAAK,EAAE,UAAU;CAG5B"}
+{"version":3,"file":"event-construct.d.ts","sourceRoot":"","sources":["../../src/lib/event-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGxD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,SAAU,YAAW,UAAU,EAAE,SAAS;IAC5E,SAAgB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;gBAErB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB;IA4CpE,UAAU;;;IAMV,SAAS,CAAC,KAAK,EAAE,UAAU;CAG5B"}

package/dist/lib/event-construct.js

@@ -6,6 +6,12 @@ const events = tslib_1.__importStar(require("aws-cdk-lib/aws-events"));
 const eventsTarget = tslib_1.__importStar(require("aws-cdk-lib/aws-events-targets"));
 const sns = tslib_1.__importStar(require("aws-cdk-lib/aws-sns"));
 const constructs_1 = require("constructs");
+/**
+ * The EventConstruct class is a custom construct that creates an SNS topic and manages event subscriptions
+ * and scheduled jobs for the given resources and event definitions.
+ *
+ * It extends the Construct class and implements the {@link Attachable `Attachable`} and {@link Grantable `Grantable`} interfaces.
+ */
 class EventConstruct extends constructs_1.Construct {
     topic;
     constructor(scope, id, props) {
@@ -15,9 +21,9 @@ class EventConstruct extends constructs_1.Construct {
             const appMessage = props.events?.messages?.[i];
             if (!appMessage)
                 continue;
-            const app = props.resources?.[appMessage.$app];
+            const app = props.resources?.[appMessage.$resource];
             if (!app)
-                throw new Error(`${appMessage.$app} not found`);
+                throw new Error(`${appMessage.$resource} not found`);
             const filterPolicy = {
                 filterPolicyWithMessageBody: {
                     message: sns.FilterOrPolicy.filter(sns.SubscriptionFilter.stringFilter({

package/dist/lib/types.d.ts

@@ -1,21 +1,68 @@
-import type { Event } from '@fy-stack/types';
+import type { Event, ResourceRef } from '@fy-stack/types';
 import type { CronOptions } from 'aws-cdk-lib/aws-events';
-export type AppRef = {
-    $app: string;
-};
-export type AppMessage = AppRef & {
+import { AuthorizationType, CfnApiProps, LambdaAuthorizerConfig } from 'aws-cdk-lib/aws-appsync';
+import { UserPool } from 'aws-cdk-lib/aws-cognito';
+export type AppMessage = ResourceRef & {
     messages: string[];
-    publish?: boolean;
 };
 export type AppCron = {
     messages: string[];
     cron: CronOptions;
 };
 export interface EventConstructProps {
+    /**
+     * A collection of resource objects, where each resource is keyed by a unique string.
+     * Each value in the collection implements the Event interface.
+     */
     resources?: Record<string, Event>;
+    /**
+     * Represents events associated with the construct.
+     */
     events?: {
+        /**
+         * List of resource to messages mapping
+         * */
         messages?: AppMessage[];
+        /**
+         * List of cron objects
+         * */
         cron?: AppCron[];
     };
 }
+export declare enum AuthProviderCapability {
+    CONNECT = "CONNECT",
+    PUBLISH = "PUBLISH",
+    SUBSCRIBE = "SUBSCRIBE"
+}
+export interface WebsocketConstructProps extends Omit<CfnApiProps, 'eventConfig' | 'name'> {
+    /** Api Name */
+    name?: string;
+    /**
+     * Available authorization providers and capabilities
+     * */
+    authProviders: (({
+        /** Generates Api Key to be used for authorization */
+        type: AuthorizationType.API_KEY;
+        /**
+         * Time after the Api key should expire, expressed in days
+         *  */
+        expires: number;
+    } | {
+        /**
+         * User pool authorization
+         * */
+        type: AuthorizationType.USER_POOL;
+        userPool: UserPool;
+    } | ({
+        /**
+         * Lambda function authorization
+         * */
+        type: AuthorizationType.LAMBDA;
+    } & LambdaAuthorizerConfig)) & {
+        /**
+         * Determine actions authorization can be used for
+         * */
+        capabilities: AuthProviderCapability[];
+    })[];
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D,MAAM,MAAM,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAChC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;QACxB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;KAClB,CAAC;CACH"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EACL,iBAAiB,EACjB,WAAW,EACX,sBAAsB,EACvB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAEnD,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG;IACrC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;aAEK;QACL,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;QACxB;;aAEK;QACL,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;KAClB,CAAC;CACH;AAED,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,MAAM,WAAW,uBACf,SAAQ,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,MAAM,CAAC;IACjD,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;SAEK;IACL,aAAa,EAAE,CAAC,CACZ;QACE,qDAAqD;QACrD,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;QAChC;;cAEM;QACN,OAAO,EAAE,MAAM,CAAC;KACjB,GACD;QACE;;aAEK;QACL,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC;QAClC,QAAQ,EAAE,QAAQ,CAAC;KACpB,GACD,CAAC;QACC;;aAEK;QACL,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC;KAChC,GAAG,sBAAsB,CAAC,CAC9B,GAAG;QACF;;aAEK;QACL,YAAY,EAAE,sBAAsB,EAAE,CAAC;KACxC,CAAC,EAAE,CAAC;CACN"}

package/dist/lib/types.js

@@ -1,2 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthProviderCapability = void 0;
+var AuthProviderCapability;
+(function (AuthProviderCapability) {
+    AuthProviderCapability["CONNECT"] = "CONNECT";
+    AuthProviderCapability["PUBLISH"] = "PUBLISH";
+    AuthProviderCapability["SUBSCRIBE"] = "SUBSCRIBE";
+})(AuthProviderCapability || (exports.AuthProviderCapability = AuthProviderCapability = {}));

package/dist/lib/websocket-construct.d.ts

@@ -0,0 +1,16 @@
+import { Construct } from 'constructs';
+import { CfnApi, CfnApiKey } from 'aws-cdk-lib/aws-appsync';
+import { WebsocketConstructProps } from './types';
+import { Attachable } from '@fy-stack/types';
+/**
+ * The Websocket class is a custom construct that creates an Appsync Event Api along with the various event configuration
+ *
+ * It extends the Construct class and implements the {@link Attachable `Attachable`} interface.
+ */
+export declare class WebsocketConstruct extends Construct implements Attachable {
+    socket: CfnApi;
+    apiKey: CfnApiKey | undefined;
+    constructor(scope: Construct, id: string, props: WebsocketConstructProps);
+    attachable(): Record<string, string>;
+}
+//# sourceMappingURL=websocket-construct.d.ts.map

package/dist/lib/websocket-construct.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-construct.d.ts","sourceRoot":"","sources":["../../src/lib/websocket-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAqB,MAAM,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAA0B,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,SAAU,YAAW,UAAU;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;gBAElB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,uBAAuB;IA+ExE,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAarC"}

package/dist/lib/websocket-construct.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketConstruct = void 0;
+const constructs_1 = require("constructs");
+const aws_appsync_1 = require("aws-cdk-lib/aws-appsync");
+const types_1 = require("./types");
+/**
+ * The Websocket class is a custom construct that creates an Appsync Event Api along with the various event configuration
+ *
+ * It extends the Construct class and implements the {@link Attachable `Attachable`} interface.
+ */
+class WebsocketConstruct extends constructs_1.Construct {
+    socket;
+    apiKey;
+    constructor(scope, id, props) {
+        super(scope, id);
+        const { authProviders, name, ...otherProps } = props;
+        let withApiKey;
+        const formattedAuthProviders = [];
+        const connectionAuthModes = [];
+        const defaultPublishAuthModes = [];
+        const defaultSubscribeAuthModes = [];
+        for (const provider of authProviders) {
+            if (provider.type === aws_appsync_1.AuthorizationType.API_KEY) {
+                withApiKey = {
+                    expires: Math.round(new Date().setDate(new Date().getDate() + provider.expires) / 1000),
+                };
+                formattedAuthProviders.push({
+                    authType: provider.type,
+                });
+            }
+            else if (provider.type === aws_appsync_1.AuthorizationType.USER_POOL) {
+                formattedAuthProviders.push({
+                    authType: provider.type,
+                    cognitoConfig: {
+                        userPoolId: provider.userPool.userPoolId,
+                        awsRegion: provider.userPool.stack.region,
+                    },
+                });
+            }
+            else if (provider.type === aws_appsync_1.AuthorizationType.LAMBDA) {
+                formattedAuthProviders.push({
+                    authType: provider.type,
+                    lambdaAuthorizerConfig: {
+                        authorizerUri: provider.handler.functionArn,
+                        authorizerResultTtlInSeconds: provider.resultsCacheTtl?.toSeconds() ?? 0,
+                        identityValidationExpression: provider.validationRegex,
+                    },
+                });
+            }
+            else
+                continue;
+            for (const capability of provider.capabilities) {
+                if (capability === types_1.AuthProviderCapability.CONNECT)
+                    connectionAuthModes.push(provider.type);
+                if (capability === types_1.AuthProviderCapability.PUBLISH)
+                    defaultPublishAuthModes.push(provider.type);
+                if (capability === types_1.AuthProviderCapability.SUBSCRIBE)
+                    defaultSubscribeAuthModes.push(provider.type);
+            }
+        }
+        this.socket = new aws_appsync_1.CfnApi(this, 'Socket', {
+            name: name ?? `${id}-socket`,
+            eventConfig: {
+                authProviders: formattedAuthProviders,
+                connectionAuthModes: connectionAuthModes.map((mode) => ({
+                    authType: mode,
+                })),
+                defaultPublishAuthModes: defaultPublishAuthModes.map((mode) => ({
+                    authType: mode,
+                })),
+                defaultSubscribeAuthModes: defaultSubscribeAuthModes.map((mode) => ({
+                    authType: mode,
+                })),
+            },
+            ...otherProps,
+        });
+        if (withApiKey) {
+            this.apiKey = new aws_appsync_1.CfnApiKey(this, 'ApiKey', {
+                apiId: this.socket.attrApiId,
+                expires: withApiKey.expires,
+            });
+        }
+    }
+    attachable() {
+        const params = {
+            arn: this.socket.attrApiArn,
+            httpDns: this.socket.getAtt('Dns.Http').toString(),
+            realtimeDnS: this.socket.getAtt('Dns.Realtime').toString(),
+        };
+        if (this.apiKey) {
+            Object.assign(params, { apiKey: this.apiKey?.attrApiKey });
+        }
+        return params;
+    }
+}
+exports.WebsocketConstruct = WebsocketConstruct;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@fy-stack/event-construct",
-  "version": "0.0.124",
+  "version": "0.0.126",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@fy-stack/types": "0.0.124"
+    "@fy-stack/types": "0.0.126"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "2.164.1",
+    "aws-cdk-lib": "2.166.0",
     "constructs": "10.4.2"
   },
   "type": "commonjs",