@volontariapp/messaging 2.15.2 → 2.16.0-snap-68b0301

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.16.0
+
+### Minor Changes
+
+- feat(messaging): contrats et registres de complétion des Sagas Scatter-Gather - [#197](https://github.com/Volontariapp/npm-packages/issues/197)
+
 ## 2.15.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export type { EventRegistry } from './events/index.js';
 export * from './jobs/index.js';
 export * from './websockets/index.js';
 export * from './helpers/index.js';
+export * from './sagas/index.js';
 //# 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,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -3,4 +3,5 @@ export { EventMessagingType } from './events/index.js';
 export * from './jobs/index.js';
 export * from './websockets/index.js';
 export * from './helpers/index.js';
+export * from './sagas/index.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/dist/sagas/gather-registry.d.ts

@@ -0,0 +1,12 @@
+import type { IGatherCompletionConfig } from './types.js';
+export declare const SagaGatherType: {
+    readonly EVENT_CREATION: "EVENT_CREATION_GATHER";
+    readonly EVENT_DELETION: "EVENT_DELETION_GATHER";
+    readonly POST_CREATION: "POST_CREATION_GATHER";
+    readonly POST_DELETION: "POST_DELETION_GATHER";
+    readonly USER_DELETION: "USER_DELETION_GATHER";
+};
+export type SagaGatherType = (typeof SagaGatherType)[keyof typeof SagaGatherType];
+export declare const SAGA_GATHER_COMPLETION_MAPPING: Record<SagaGatherType, IGatherCompletionConfig>;
+export declare function getGatherCompletionConfig(gatherType: SagaGatherType): IGatherCompletionConfig;
+//# sourceMappingURL=gather-registry.d.ts.map

package/dist/sagas/gather-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gather-registry.d.ts","sourceRoot":"","sources":["../../src/sagas/gather-registry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAK1D,eAAO,MAAM,cAAc;;;;;;CAMjB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAKlF,eAAO,MAAM,8BAA8B,EAAE,MAAM,CAAC,cAAc,EAAE,uBAAuB,CA0BjF,CAAC;AAKX,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,cAAc,GAAG,uBAAuB,CAM7F"}

package/dist/sagas/gather-registry.js

@@ -0,0 +1,44 @@
+import { EventMessagingType } from '../events/index.js';
+import { WebsocketMessagingType } from '../websockets/index.js';
+export const SagaGatherType = {
+    EVENT_CREATION: 'EVENT_CREATION_GATHER',
+    EVENT_DELETION: 'EVENT_DELETION_GATHER',
+    POST_CREATION: 'POST_CREATION_GATHER',
+    POST_DELETION: 'POST_DELETION_GATHER',
+    USER_DELETION: 'USER_DELETION_GATHER',
+};
+export const SAGA_GATHER_COMPLETION_MAPPING = {
+    [SagaGatherType.EVENT_CREATION]: {
+        targetEvent: EventMessagingType.EVENT_CREATED,
+        stream: 'event:created',
+        wsEvent: WebsocketMessagingType.EVENT_CREATED,
+    },
+    [SagaGatherType.EVENT_DELETION]: {
+        targetEvent: EventMessagingType.EVENT_DELETED,
+        stream: 'event:deleted',
+        wsEvent: WebsocketMessagingType.EVENT_DELETED,
+    },
+    [SagaGatherType.POST_CREATION]: {
+        targetEvent: EventMessagingType.POST_CREATED,
+        stream: 'post:created',
+        wsEvent: WebsocketMessagingType.POST_CREATED,
+    },
+    [SagaGatherType.POST_DELETION]: {
+        targetEvent: EventMessagingType.POST_DELETED,
+        stream: 'post:deleted',
+        wsEvent: WebsocketMessagingType.POST_DELETED,
+    },
+    [SagaGatherType.USER_DELETION]: {
+        targetEvent: EventMessagingType.USER_DELETED,
+        stream: 'user:deleted',
+        wsEvent: WebsocketMessagingType.USER_DELETED,
+    },
+};
+export function getGatherCompletionConfig(gatherType) {
+    const config = SAGA_GATHER_COMPLETION_MAPPING[gatherType];
+    if (!config) {
+        throw new Error(`[Messaging] No completion config found for saga gather type: ${gatherType}`);
+    }
+    return config;
+}
+//# sourceMappingURL=gather-registry.js.map

package/dist/sagas/gather-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gather-registry.js","sourceRoot":"","sources":["../../src/sagas/gather-registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAMhE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,cAAc,EAAE,uBAAuB;IACvC,cAAc,EAAE,uBAAuB;IACvC,aAAa,EAAE,sBAAsB;IACrC,aAAa,EAAE,sBAAsB;IACrC,aAAa,EAAE,sBAAsB;CAC7B,CAAC;AAOX,MAAM,CAAC,MAAM,8BAA8B,GAAoD;IAC7F,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE;QAC/B,WAAW,EAAE,kBAAkB,CAAC,aAAa;QAC7C,MAAM,EAAE,eAAe;QACvB,OAAO,EAAE,sBAAsB,CAAC,aAAa;KAC9C;IACD,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE;QAC/B,WAAW,EAAE,kBAAkB,CAAC,aAAa;QAC7C,MAAM,EAAE,eAAe;QACvB,OAAO,EAAE,sBAAsB,CAAC,aAAa;KAC9C;IACD,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE;QAC9B,WAAW,EAAE,kBAAkB,CAAC,YAAY;QAC5C,MAAM,EAAE,cAAc;QACtB,OAAO,EAAE,sBAAsB,CAAC,YAAY;KAC7C;IACD,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE;QAC9B,WAAW,EAAE,kBAAkB,CAAC,YAAY;QAC5C,MAAM,EAAE,cAAc;QACtB,OAAO,EAAE,sBAAsB,CAAC,YAAY;KAC7C;IACD,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE;QAC9B,WAAW,EAAE,kBAAkB,CAAC,YAAY;QAC5C,MAAM,EAAE,cAAc;QACtB,OAAO,EAAE,sBAAsB,CAAC,YAAY;KAC7C;CACO,CAAC;AAKX,MAAM,UAAU,yBAAyB,CAAC,UAA0B;IAClE,MAAM,MAAM,GAAG,8BAA8B,CAAC,UAAU,CAAC,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,gEAAgE,UAAU,EAAE,CAAC,CAAC;IAChG,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/sagas/gather-registry.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gather-registry.test.d.ts.map

package/dist/sagas/gather-registry.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gather-registry.test.d.ts","sourceRoot":"","sources":["../../src/sagas/gather-registry.test.ts"],"names":[],"mappings":""}

package/dist/sagas/gather-registry.test.js

@@ -0,0 +1,27 @@
+import { describe, it, expect } from '@jest/globals';
+import { SagaGatherType, SAGA_GATHER_COMPLETION_MAPPING, getGatherCompletionConfig, } from './gather-registry.js';
+import { EventMessagingType } from '../events/index.js';
+import { WebsocketMessagingType } from '../websockets/index.js';
+describe('SagaGatherRegistry', () => {
+    it('should return valid completion config for EVENT_CREATION', () => {
+        const config = getGatherCompletionConfig(SagaGatherType.EVENT_CREATION);
+        expect(config).toEqual(SAGA_GATHER_COMPLETION_MAPPING[SagaGatherType.EVENT_CREATION]);
+        expect(config).toEqual({
+            targetEvent: EventMessagingType.EVENT_CREATED,
+            stream: 'event:created',
+            wsEvent: WebsocketMessagingType.EVENT_CREATED,
+        });
+    });
+    it('should return valid completion config for EVENT_DELETION', () => {
+        const config = getGatherCompletionConfig(SagaGatherType.EVENT_DELETION);
+        expect(config).toEqual({
+            targetEvent: EventMessagingType.EVENT_DELETED,
+            stream: 'event:deleted',
+            wsEvent: WebsocketMessagingType.EVENT_DELETED,
+        });
+    });
+    it('should throw an error if an invalid gather type is requested', () => {
+        expect(() => getGatherCompletionConfig('INVALID_GATHER')).toThrow('[Messaging] No completion config found for saga gather type: INVALID_GATHER');
+    });
+});
+//# sourceMappingURL=gather-registry.test.js.map

package/dist/sagas/gather-registry.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gather-registry.test.js","sourceRoot":"","sources":["../../src/sagas/gather-registry.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EACL,cAAc,EACd,8BAA8B,EAC9B,yBAAyB,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAG,yBAAyB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC;QACtF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,WAAW,EAAE,kBAAkB,CAAC,aAAa;YAC7C,MAAM,EAAE,eAAe;YACvB,OAAO,EAAE,sBAAsB,CAAC,aAAa;SAC9C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAG,yBAAyB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,WAAW,EAAE,kBAAkB,CAAC,aAAa;YAC7C,MAAM,EAAE,eAAe;YACvB,OAAO,EAAE,sBAAsB,CAAC,aAAa;SAC9C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC,gBAAuB,CAAC,CAAC,CAAC,OAAO,CACtE,6EAA6E,CAC9E,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/sagas/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './gather-registry.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/sagas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/sagas/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC"}

package/dist/sagas/index.js

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './gather-registry.js';
+//# sourceMappingURL=index.js.map

package/dist/sagas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/sagas/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC"}

package/dist/sagas/types.d.ts

@@ -0,0 +1,14 @@
+import type { EventMessagingType, EventRegistry } from '../events/index.js';
+import type { WebsocketMessagingType } from '../websockets/index.js';
+export interface IGatherCompletionOutput<TEvent extends EventMessagingType = EventMessagingType, TPayload = TEvent extends keyof EventRegistry ? EventRegistry[TEvent] : Record<string, unknown>> {
+    targetEvent: TEvent;
+    stream: string;
+    payload: TPayload;
+    wsEvent?: WebsocketMessagingType;
+}
+export interface IGatherCompletionConfig<TEvent extends EventMessagingType = EventMessagingType> {
+    targetEvent: TEvent;
+    stream: string;
+    wsEvent?: WebsocketMessagingType;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/sagas/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAKrE,MAAM,WAAW,uBAAuB,CACtC,MAAM,SAAS,kBAAkB,GAAG,kBAAkB,EACtD,QAAQ,GAAG,MAAM,SAAS,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAG/F,WAAW,EAAE,MAAM,CAAC;IAGpB,MAAM,EAAE,MAAM,CAAC;IAGf,OAAO,EAAE,QAAQ,CAAC;IAGlB,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC;AAKD,MAAM,WAAW,uBAAuB,CACtC,MAAM,SAAS,kBAAkB,GAAG,kBAAkB;IAEtD,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC"}

package/dist/sagas/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/sagas/types.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volontariapp/messaging",
-  "version": "2.15.2",
+  "version": "2.16.0-snap-68b0301",
   "publishConfig": {
     "access": "public",
     "provenance": true