@alanszp/eventbridge-client 7.0.1 → 7.1.0

package/dist/basicEventbridgeClient.d.ts

@@ -5,14 +5,12 @@ 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[];
+    body: Record<string, unknown>;
 };
 export interface EventDispatchResult {
     successful: PutEventEntryResponse[];

package/dist/basicEventbridgeClient.js.map

@@ -1 +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"}
+{"version":3,"file":"basicEventbridgeClient.js","sourceRoot":"","sources":["../src/basicEventbridgeClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,mCAA4C;AAC5C,+BAA+E;AAC/E,6EAA0E;AAoB1E,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

@@ -2,4 +2,4 @@ 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;
+export declare function mapLaraEventToAWSEvent({ topic, body }: LaraEvent, env: string, appName: string, bus: string, logger: ILogger, context: SharedContext): PutEventsRequestEntry | undefined;

package/dist/helpers/mapLaraEventToAWSEvent.js

@@ -6,14 +6,14 @@ 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) {
+function mapLaraEventToAWSEvent({ topic, body }, 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 })),
+            Detail: JSON.stringify(Object.assign(Object.assign({}, body), { lch })),
             Source: `${env}.lara.${appName}`,
             EventBusName: bus,
             Time: new Date(),
@@ -21,7 +21,7 @@ function mapLaraEventToAWSEvent({ topic, entity }, env, appName, bus, logger, co
         };
     }
     catch (_a) {
-        const org = entity.organizationReference;
+        const org = body.organizationReference;
         logger.error("eventbridge.client.map_lara_to_aws_event.parse_error", {
             topic,
             org,

package/dist/helpers/mapLaraEventToAWSEvent.js.map

@@ -1 +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"}
+{"version":3,"file":"mapLaraEventToAWSEvent.js","sourceRoot":"","sources":["../../src/helpers/mapLaraEventToAWSEvent.ts"],"names":[],"mappings":";;;;;;AAIA,mCAAiC;AACjC,gDAAwB;AAExB,SAAgB,sBAAsB,CACpC,EAAE,KAAK,EAAE,IAAI,EAAa,EAC1B,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,IAAI,KAAE,GAAG,IAAG;YACxC,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,IAAI,CAAC,qBAA+B,CAAC;QACjD,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

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

package/dist/index.js

@@ -12,4 +12,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./basicEventbridgeClient"), exports);
 __exportStar(require("./aws/awsTypes"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/types/UpdatedEvent.d.ts

@@ -0,0 +1,15 @@
+declare type PropertyKeys<T> = {
+    [K in keyof T as T[K] extends Function ? never : K]: T[K];
+};
+declare type UpdatedIdentifiers<Entity, Identifiers extends keyof PropertyKeys<Entity>, PartialEntity = Pick<PropertyKeys<Entity>, Identifiers>> = {
+    [K in keyof PartialEntity]: PartialEntity[K];
+};
+declare type UpdatedFields<Entity, Identifiers extends keyof PropertyKeys<Entity>, PartialEntity = Omit<PropertyKeys<Entity>, Identifiers>> = {
+    [K in keyof PartialEntity]?: PartialEntity[K];
+};
+export declare type CreatedEvent<Entity, Identifiers extends keyof PropertyKeys<Entity>> = UpdatedFields<Entity, Identifiers>;
+export declare type UpdatedEvent<Entity, Identifiers extends keyof PropertyKeys<Entity>> = UpdatedFields<Entity, Identifiers> & UpdatedIdentifiers<Entity, Identifiers> & {
+    _previousValues?: UpdatedFields<Entity, Identifiers>;
+    modifiedKeys: (keyof UpdatedFields<Entity, Identifiers>)[];
+};
+export {};

package/dist/types/UpdatedEvent.js

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

package/dist/types/UpdatedEvent.js.map

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

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./UpdatedEvent";

package/dist/types/index.js

@@ -0,0 +1,14 @@
+"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("./UpdatedEvent"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alanszp/eventbridge-client",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "description": "Alan's basic eventbridge client.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -30,5 +30,5 @@
     "cuid": "^2.1.8",
     "lodash": "^4.17.21"
   },
-  "gitHead": "67e6ad3d56d02ee10f45ca59f7e68bc77d574f41"
+  "gitHead": "d6d13089bfd66943887f9cee0cadc28210cf0116"
 }

package/src/basicEventbridgeClient.ts

@@ -8,14 +8,12 @@ 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[];
+  body: Record<string, unknown>;
 };
 
 export interface EventDispatchResult {

package/src/helpers/mapLaraEventToAWSEvent.ts

@@ -6,7 +6,7 @@ import { compact } from "lodash";
 import cuid from "cuid";
 
 export function mapLaraEventToAWSEvent(
-  { topic, entity }: LaraEvent,
+  { topic, body }: LaraEvent,
   env: string,
   appName: string,
   bus: string,
@@ -19,14 +19,14 @@ export function mapLaraEventToAWSEvent(
   try {
     return {
       DetailType: topic,
-      Detail: JSON.stringify({ ...entity, lch }),
+      Detail: JSON.stringify({ ...body, lch }),
       Source: `${env}.lara.${appName}`,
       EventBusName: bus,
       Time: new Date(),
       TraceHeader: lid,
     };
   } catch {
-    const org = entity.organizationReference as string;
+    const org = body.organizationReference as string;
     logger.error("eventbridge.client.map_lara_to_aws_event.parse_error", {
       topic,
       org,

package/src/index.ts

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

package/src/types/UpdatedEvent.ts

@@ -0,0 +1,34 @@
+// eslint-disable-next-line @typescript-eslint/ban-types
+type PropertyKeys<T> = {
+  [K in keyof T as T[K] extends Function ? never : K]: T[K];
+};
+
+type UpdatedIdentifiers<
+  Entity,
+  Identifiers extends keyof PropertyKeys<Entity>,
+  PartialEntity = Pick<PropertyKeys<Entity>, Identifiers>
+> = {
+  [K in keyof PartialEntity]: PartialEntity[K];
+};
+
+type UpdatedFields<
+  Entity,
+  Identifiers extends keyof PropertyKeys<Entity>,
+  PartialEntity = Omit<PropertyKeys<Entity>, Identifiers>
+> = {
+  [K in keyof PartialEntity]?: PartialEntity[K];
+};
+
+export type CreatedEvent<
+  Entity,
+  Identifiers extends keyof PropertyKeys<Entity>
+> = UpdatedFields<Entity, Identifiers>;
+
+export type UpdatedEvent<
+  Entity,
+  Identifiers extends keyof PropertyKeys<Entity>
+> = UpdatedFields<Entity, Identifiers> &
+  UpdatedIdentifiers<Entity, Identifiers> & {
+    _previousValues?: UpdatedFields<Entity, Identifiers>;
+    modifiedKeys: (keyof UpdatedFields<Entity, Identifiers>)[];
+  };

package/src/types/index.ts

@@ -0,0 +1 @@
+export * from "./UpdatedEvent";