@alanszp/eventbridge-client 7.0.1

package/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*.log
+dist

package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+*.log

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alan Szpigiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/aws/awsEventbridgeClient.d.ts

@@ -0,0 +1,2 @@
+import AWS from "aws-sdk";
+export declare const eventbridgeClient: AWS.EventBridge;

package/dist/aws/awsEventbridgeClient.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventbridgeClient = void 0;
+const aws_sdk_1 = __importDefault(require("aws-sdk"));
+exports.eventbridgeClient = new aws_sdk_1.default.EventBridge();
+//# sourceMappingURL=awsEventbridgeClient.js.map

package/dist/aws/awsEventbridgeClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"awsEventbridgeClient.js","sourceRoot":"","sources":["../../src/aws/awsEventbridgeClient.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA0B;AAEb,QAAA,iBAAiB,GAAG,IAAI,iBAAG,CAAC,WAAW,EAAE,CAAC"}

package/dist/aws/awsTypes.d.ts

@@ -0,0 +1,9 @@
+import { PromiseResult as AWSPromiseResult } from "aws-sdk/lib/request";
+export declare type EventRequest = AWS.EventBridge.Types.PutEventsRequest;
+export declare type EventResponse = AWS.EventBridge.Types.PutEventsResponse;
+export declare type AWSResponse<D, E> = AWS.Response<D, E>;
+export declare type PromiseResult<D, E> = AWSPromiseResult<D, E>;
+export declare type PutEventEntryResponse = AWS.EventBridge.PutEventsResultEntry;
+export declare type PutEventEntryRequest = AWS.EventBridge.PutEventsRequestEntry;
+export declare type EventError = AWS.AWSError;
+export declare type PromiseEventResponse = PromiseResult<EventResponse, EventError>;

package/dist/aws/awsTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=awsTypes.js.map

package/dist/aws/awsTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"awsTypes.js","sourceRoot":"","sources":["../../src/aws/awsTypes.ts"],"names":[],"mappings":""}

package/dist/aws/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./awsEventbridgeClient";
+export * from "./awsTypes";

package/dist/aws/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./awsEventbridgeClient"), exports);
+__exportStar(require("./awsTypes"), exports);
+//# sourceMappingURL=index.js.map

package/dist/aws/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/aws/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAuC;AACvC,6CAA2B"}

package/dist/basicEventbridgeClient.d.ts

@@ -0,0 +1,34 @@
+import { ILogger } from "@alanszp/logger";
+import { SharedContext } from "@alanszp/shared-context";
+import { PutEventEntryResponse } from "./aws";
+/**
+ * Represents an event that is sent in the Lara ecosystem.
+ *
+ * @property topic: The topic of the event. E.g.: if an employee was created, topid would be employee.created.
+ * @property lid: The lifecycle id to identify the execution that generated the event.
+ * @property body: The body of the event. This will be used to match in the rules, along with the topic and maybe the id. If it has a property id it
+ *                  will be overwritten by the id sent to this method in the parameters.
+ */
+export declare type LaraEvent = {
+    topic: string;
+    entity: Record<string, unknown>;
+    modifiedKeys: string[];
+};
+export interface EventDispatchResult {
+    successful: PutEventEntryResponse[];
+    failed: PutEventEntryResponse[];
+    failedCount: number | undefined;
+}
+/**
+ * Basic client for Eventbridge.
+ * Usage will be done by extending this class and implementing methods that internally call the protected sendEvents method.
+ */
+export declare class BasicEventbridgeClient {
+    private appName;
+    private env;
+    private bus;
+    protected getLogger: () => ILogger;
+    protected context: SharedContext;
+    constructor(appName: string, env: string, getLogger: () => ILogger, context: SharedContext, bus?: string);
+    protected sendEvents(events: LaraEvent[]): Promise<EventDispatchResult>;
+}

package/dist/basicEventbridgeClient.js

@@ -0,0 +1,51 @@
+"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.BasicEventbridgeClient = void 0;
+const lodash_1 = require("lodash");
+const aws_1 = require("./aws");
+const mapLaraEventToAWSEvent_1 = require("./helpers/mapLaraEventToAWSEvent");
+const DEFAULT_CUSTOM_BUS_NAME_SUFFIX = "lara-eventbus";
+/**
+ * Basic client for Eventbridge.
+ * Usage will be done by extending this class and implementing methods that internally call the protected sendEvents method.
+ */
+class BasicEventbridgeClient {
+    constructor(appName, env, getLogger, context, bus = `${env}-${DEFAULT_CUSTOM_BUS_NAME_SUFFIX}`) {
+        this.appName = appName;
+        this.env = env;
+        this.bus = bus;
+        this.getLogger = getLogger;
+        this.context = context;
+    }
+    sendEvents(events) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const logger = this.getLogger();
+            const eventsToSend = {
+                Entries: (0, lodash_1.compact)(events.map((event) => (0, mapLaraEventToAWSEvent_1.mapLaraEventToAWSEvent)(event, this.env, this.appName, this.bus, logger, this.context))),
+            };
+            const result = yield aws_1.eventbridgeClient.putEvents(eventsToSend).promise();
+            const { Entries, FailedEntryCount: failedCount } = result;
+            const [successful, failed] = (0, lodash_1.partition)(Entries, (entry) => entry.EventId);
+            logger.info("eventbridge.client.sendEvents.end", {
+                successful,
+                failed,
+            });
+            return {
+                successful,
+                failed,
+                failedCount,
+            };
+        });
+    }
+}
+exports.BasicEventbridgeClient = BasicEventbridgeClient;
+//# sourceMappingURL=basicEventbridgeClient.js.map

package/dist/basicEventbridgeClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basicEventbridgeClient.js","sourceRoot":"","sources":["../src/basicEventbridgeClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,mCAA4C;AAC5C,+BAA+E;AAC/E,6EAA0E;AAsB1E,MAAM,8BAA8B,GAAG,eAAe,CAAC;AAEvD;;;GAGG;AACH,MAAa,sBAAsB;IAQjC,YACE,OAAe,EACf,GAAW,EACX,SAAwB,EACxB,OAAsB,EACtB,GAAG,GAAG,GAAG,GAAG,IAAI,8BAA8B,EAAE;QAEhD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEe,UAAU,CACxB,MAAmB;;YAEnB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAEhC,MAAM,YAAY,GAAiB;gBACjC,OAAO,EAAE,IAAA,gBAAO,EACd,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACnB,IAAA,+CAAsB,EACpB,KAAK,EACL,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,GAAG,EACR,MAAM,EACN,IAAI,CAAC,OAAO,CACb,CACF,CACF;aACF,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,uBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC;YACzE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;YAC1D,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,IAAA,kBAAS,EAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE1E,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE;gBAC/C,UAAU;gBACV,MAAM;aACP,CAAC,CAAC;YAEH,OAAO;gBACL,UAAU;gBACV,MAAM;gBACN,WAAW;aACZ,CAAC;QACJ,CAAC;KAAA;CACF;AAzDD,wDAyDC"}

package/dist/helpers/mapLaraEventToAWSEvent.d.ts

@@ -0,0 +1,5 @@
+import { LaraEvent } from "../basicEventbridgeClient";
+import { PutEventsRequestEntry } from "aws-sdk/clients/eventbridge";
+import type { ILogger } from "@alanszp/logger";
+import type { SharedContext } from "@alanszp/shared-context";
+export declare function mapLaraEventToAWSEvent({ topic, entity }: LaraEvent, env: string, appName: string, bus: string, logger: ILogger, context: SharedContext): PutEventsRequestEntry | undefined;

package/dist/helpers/mapLaraEventToAWSEvent.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapLaraEventToAWSEvent = void 0;
+const lodash_1 = require("lodash");
+const cuid_1 = __importDefault(require("cuid"));
+function mapLaraEventToAWSEvent({ topic, entity }, env, appName, bus, logger, context) {
+    const lid = context.getLifecycleId() || (0, cuid_1.default)();
+    const oldlLch = context.getLifecycleChain();
+    const lch = (0, lodash_1.compact)([oldlLch, "aws.eventbridge"]).join(",");
+    try {
+        return {
+            DetailType: topic,
+            Detail: JSON.stringify(Object.assign(Object.assign({}, entity), { lch })),
+            Source: `${env}.lara.${appName}`,
+            EventBusName: bus,
+            Time: new Date(),
+            TraceHeader: lid,
+        };
+    }
+    catch (_a) {
+        const org = entity.organizationReference;
+        logger.error("eventbridge.client.map_lara_to_aws_event.parse_error", {
+            topic,
+            org,
+            lid,
+        });
+        return undefined;
+    }
+}
+exports.mapLaraEventToAWSEvent = mapLaraEventToAWSEvent;
+//# sourceMappingURL=mapLaraEventToAWSEvent.js.map

package/dist/helpers/mapLaraEventToAWSEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapLaraEventToAWSEvent.js","sourceRoot":"","sources":["../../src/helpers/mapLaraEventToAWSEvent.ts"],"names":[],"mappings":";;;;;;AAIA,mCAAiC;AACjC,gDAAwB;AAExB,SAAgB,sBAAsB,CACpC,EAAE,KAAK,EAAE,MAAM,EAAa,EAC5B,GAAW,EACX,OAAe,EACf,GAAW,EACX,MAAe,EACf,OAAsB;IAEtB,MAAM,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,IAAI,IAAA,cAAI,GAAE,CAAC;IAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAC5C,MAAM,GAAG,GAAG,IAAA,gBAAO,EAAC,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5D,IAAI;QACF,OAAO;YACL,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,SAAS,iCAAM,MAAM,KAAE,GAAG,IAAG;YAC1C,MAAM,EAAE,GAAG,GAAG,SAAS,OAAO,EAAE;YAChC,YAAY,EAAE,GAAG;YACjB,IAAI,EAAE,IAAI,IAAI,EAAE;YAChB,WAAW,EAAE,GAAG;SACjB,CAAC;KACH;IAAC,WAAM;QACN,MAAM,GAAG,GAAG,MAAM,CAAC,qBAA+B,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,sDAAsD,EAAE;YACnE,KAAK;YACL,GAAG;YACH,GAAG;SACJ,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AA7BD,wDA6BC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./basicEventbridgeClient";
+export * from "./aws/awsTypes";

package/dist/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./basicEventbridgeClient"), exports);
+__exportStar(require("./aws/awsTypes"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2DAAyC;AACzC,iDAA+B"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@alanszp/eventbridge-client",
+  "version": "7.0.1",
+  "description": "Alan's basic eventbridge client.",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "files": [
+    "**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "compile": "rm -rf ./dist && tsc --declaration",
+    "compile-watch": "tsc -w",
+    "build": "yarn run compile",
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
+  },
+  "devDependencies": {
+    "@types/node": "^15.12.3",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.3.4"
+  },
+  "dependencies": {
+    "@alanszp/logger": "^7.0.0",
+    "@alanszp/shared-context": "^7.0.0",
+    "aws-sdk": "^2.1204.0",
+    "cuid": "^2.1.8",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "67e6ad3d56d02ee10f45ca59f7e68bc77d574f41"
+}

package/src/aws/awsEventbridgeClient.ts

@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+export const eventbridgeClient = new AWS.EventBridge();

package/src/aws/awsTypes.ts

@@ -0,0 +1,10 @@
+import { PromiseResult as AWSPromiseResult } from "aws-sdk/lib/request";
+
+export type EventRequest = AWS.EventBridge.Types.PutEventsRequest;
+export type EventResponse = AWS.EventBridge.Types.PutEventsResponse;
+export type AWSResponse<D, E> = AWS.Response<D, E>;
+export type PromiseResult<D, E> = AWSPromiseResult<D, E>;
+export type PutEventEntryResponse = AWS.EventBridge.PutEventsResultEntry;
+export type PutEventEntryRequest = AWS.EventBridge.PutEventsRequestEntry;
+export type EventError = AWS.AWSError;
+export type PromiseEventResponse = PromiseResult<EventResponse, EventError>;

package/src/aws/index.ts

@@ -0,0 +1,2 @@
+export * from "./awsEventbridgeClient";
+export * from "./awsTypes";

package/src/basicEventbridgeClient.ts

@@ -0,0 +1,90 @@
+import { ILogger } from "@alanszp/logger";
+import { SharedContext } from "@alanszp/shared-context";
+import { compact, partition } from "lodash";
+import { eventbridgeClient, EventRequest, PutEventEntryResponse } from "./aws";
+import { mapLaraEventToAWSEvent } from "./helpers/mapLaraEventToAWSEvent";
+
+/**
+ * Represents an event that is sent in the Lara ecosystem.
+ *
+ * @property topic: The topic of the event. E.g.: if an employee was created, topid would be employee.created.
+ * @property lid: The lifecycle id to identify the execution that generated the event.
+ * @property body: The body of the event. This will be used to match in the rules, along with the topic and maybe the id. If it has a property id it
+ *                  will be overwritten by the id sent to this method in the parameters.
+ */
+export type LaraEvent = {
+  topic: string;
+  entity: Record<string, unknown>;
+  modifiedKeys: string[];
+};
+
+export interface EventDispatchResult {
+  successful: PutEventEntryResponse[];
+  failed: PutEventEntryResponse[];
+  failedCount: number | undefined;
+}
+
+const DEFAULT_CUSTOM_BUS_NAME_SUFFIX = "lara-eventbus";
+
+/**
+ * Basic client for Eventbridge.
+ * Usage will be done by extending this class and implementing methods that internally call the protected sendEvents method.
+ */
+export class BasicEventbridgeClient {
+  private appName: string;
+  private env: string;
+  private bus: string;
+
+  protected getLogger: () => ILogger;
+  protected context: SharedContext;
+
+  constructor(
+    appName: string,
+    env: string,
+    getLogger: () => ILogger,
+    context: SharedContext,
+    bus = `${env}-${DEFAULT_CUSTOM_BUS_NAME_SUFFIX}`
+  ) {
+    this.appName = appName;
+    this.env = env;
+    this.bus = bus;
+    this.getLogger = getLogger;
+    this.context = context;
+  }
+
+  protected async sendEvents(
+    events: LaraEvent[]
+  ): Promise<EventDispatchResult> {
+    const logger = this.getLogger();
+
+    const eventsToSend: EventRequest = {
+      Entries: compact(
+        events.map((event) =>
+          mapLaraEventToAWSEvent(
+            event,
+            this.env,
+            this.appName,
+            this.bus,
+            logger,
+            this.context
+          )
+        )
+      ),
+    };
+
+    const result = await eventbridgeClient.putEvents(eventsToSend).promise();
+    const { Entries, FailedEntryCount: failedCount } = result;
+    const [successful, failed] = partition(Entries, (entry) => entry.EventId);
+
+    logger.info("eventbridge.client.sendEvents.end", {
+      successful,
+      failed,
+    });
+
+    return {
+      successful,
+      failed,
+      failedCount,
+    };
+  }
+}

package/src/helpers/mapLaraEventToAWSEvent.ts

@@ -0,0 +1,37 @@
+import { LaraEvent } from "../basicEventbridgeClient";
+import { PutEventsRequestEntry } from "aws-sdk/clients/eventbridge";
+import type { ILogger } from "@alanszp/logger";
+import type { SharedContext } from "@alanszp/shared-context";
+import { compact } from "lodash";
+import cuid from "cuid";
+
+export function mapLaraEventToAWSEvent(
+  { topic, entity }: LaraEvent,
+  env: string,
+  appName: string,
+  bus: string,
+  logger: ILogger,
+  context: SharedContext
+): PutEventsRequestEntry | undefined {
+  const lid = context.getLifecycleId() || cuid();
+  const oldlLch = context.getLifecycleChain();
+  const lch = compact([oldlLch, "aws.eventbridge"]).join(",");
+  try {
+    return {
+      DetailType: topic,
+      Detail: JSON.stringify({ ...entity, lch }),
+      Source: `${env}.lara.${appName}`,
+      EventBusName: bus,
+      Time: new Date(),
+      TraceHeader: lid,
+    };
+  } catch {
+    const org = entity.organizationReference as string;
+    logger.error("eventbridge.client.map_lara_to_aws_event.parse_error", {
+      topic,
+      org,
+      lid,
+    });
+    return undefined;
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./basicEventbridgeClient";
+export * from "./aws/awsTypes";

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "es6",
+    "types": ["node"],
+    "esModuleInterop": true,
+    "sourceMap": true,
+
+    "alwaysStrict": true,
+    "strictNullChecks": true
+  },
+  "exclude": ["node_modules"]
+}