@fraym/streams 0.10.6 → 0.30.0-alpha.18

package/dist/client/allEvents.d.ts

@@ -1,5 +1,6 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 import { HandlerFunc } from "./event";
 import { StopLoadingMoreFunc } from "./util";
 export declare const getAllEvents: (tenantId: string, topic: string, types: string[], perPage: number, handler: HandlerFunc, stopLoadingMore: StopLoadingMoreFunc, serviceClient: ServiceClient) => Promise<void>;
 export declare const getAllEventsAfterEvent: (tenantId: string, topic: string, types: string[], eventId: string, perPage: number, handler: HandlerFunc, stopLoadingMore: StopLoadingMoreFunc, serviceClient: ServiceClient) => Promise<void>;
+//# sourceMappingURL=allEvents.d.ts.map

package/dist/client/allEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allEvents.d.ts","sourceRoot":"","sources":["../../client/allEvents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,EAAE,WAAW,EAA2C,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAS,MAAM,QAAQ,CAAC;AAEpD,eAAO,MAAM,YAAY,aACX,MAAM,SACT,MAAM,SACN,MAAM,EAAE,WACN,MAAM,WACN,WAAW,mBACH,mBAAmB,iBACrB,aAAa,KAC7B,OAAO,CAAC,IAAI,CAkCd,CAAC;AAkCF,eAAO,MAAM,sBAAsB,aACrB,MAAM,SACT,MAAM,SACN,MAAM,EAAE,WACN,MAAM,WACN,MAAM,WACN,WAAW,mBACH,mBAAmB,iBACrB,aAAa,KAC7B,OAAO,CAAC,IAAI,CA8Bd,CAAC"}

package/dist/client/client.d.ts

@@ -22,3 +22,4 @@ export interface Client {
     close: () => void;
 }
 export declare const newClient: (config: ClientConfig) => Promise<Client>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../client/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAqB,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAQvE,OAAO,EAAE,YAAY,EAAmB,MAAM,aAAa,CAAC;AAE5D,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,iBAAiB,EAAE,CACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,KAC3C,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CACnC;AAID,MAAM,WAAW,MAAM;IACnB,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3F,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;IACrF,mBAAmB,EAAE,CACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EAAE,KACd,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;IACvC,gBAAgB,EAAE,CACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAAE,EAC5B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,WAAW,KACnB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,0BAA0B,EAAE,CACxB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAAE,EAC5B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,WAAW,KACnB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE,iBAAiB,EAAE,CACf,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,KACd,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7B,iBAAiB,EAAE,CACf,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,KACd,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7B,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,qBAAqB,CAAC,EAAE,OAAO,KAAK,YAAY,CAAC;IAChF,kBAAkB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvF,yBAAyB,EAAE,CACvB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,KAChB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,oBAAoB,EAAE,CAClB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,sBAAsB,EAAE,MAAM,EAC9B,aAAa,EAAE,YAAY,KAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,KAAK,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,eAAO,MAAM,SAAS,WAAkB,YAAY,KAAG,OAAO,CAAC,MAAM,CA6MpE,CAAC"}

package/dist/client/client.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.newClient = void 0;
-const management_1 = require("@fraym/proto/freym/streams/management");
+const index_freym_streams_management_1 = require("@fraym/proto/dist/index.freym.streams.management");
 const grpc_js_1 = require("@grpc/grpc-js");
 const allEvents_1 = require("./allEvents");
 const config_1 = require("./config");
@@ -15,7 +15,7 @@ const stream_1 = require("./stream");
 const subscribe_1 = require("./subscribe");
 const newClient = async (config) => {
     config = (0, config_1.useConfigDefaults)(config);
-    const serviceClient = new management_1.ServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
+    const serviceClient = new index_freym_streams_management_1.ServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
         "grpc.keepalive_time_ms": config.keepaliveInterval,
         "grpc.keepalive_timeout_ms": config.keepaliveTimeout,
         "grpc.keepalive_permit_without_calls": 1,
@@ -48,7 +48,7 @@ const newClient = async (config) => {
                 }
                 return await (0, stream_1.getStream)(topic, tenantId, stream, perPage, async (event) => {
                     callback(event);
-                }, lastEventCheck, serviceClient);
+                }, lastEventCheck, config.deploymentId ?? null, serviceClient);
             },
             forEachAfterEvent: async (eventId, callback) => {
                 const lastEventCheck = await getLastEventCheck(tenantId, topic);
@@ -57,7 +57,7 @@ const newClient = async (config) => {
                 }
                 return await (0, stream_1.getStreamAfterEvent)(topic, tenantId, stream, eventId, perPage, async (event) => {
                     callback(event);
-                }, lastEventCheck, serviceClient);
+                }, lastEventCheck, config.deploymentId ?? null, serviceClient);
             },
             isEmpty: async () => {
                 return (0, stream_1.isStreamEmpty)(topic, tenantId, stream, serviceClient);
@@ -89,7 +89,7 @@ const newClient = async (config) => {
             await (0, allEvents_1.getAllEventsAfterEvent)(tenantId, topic, includedEventTypes, eventId, perPage, handler, lastEventCheck, serviceClient);
         },
         publish: async (topic, events) => {
-            return await (0, publish_1.sendPublish)(topic, events, serviceClient);
+            return await (0, publish_1.sendPublish)(topic, events, config.deploymentId ?? null, serviceClient);
         },
         getStreamItarator: async (topic, tenantId, stream, perPage) => {
             return await getStreamIterator(topic, tenantId, stream, perPage);
@@ -109,7 +109,7 @@ const newClient = async (config) => {
             return await (0, invalidateGdpr_1.sendInvalidateGdpr)(tenantId, topic, gdprId, serviceClient);
         },
         createStreamSnapshot: async (tenantId, topic, stream, idOfLastEventThatGotSnapshotted, snapshotEvent) => {
-            return await (0, stream_1.createStreamSnapshot)(tenantId, topic, stream, idOfLastEventThatGotSnapshotted, snapshotEvent, serviceClient);
+            return await (0, stream_1.createStreamSnapshot)(tenantId, topic, stream, idOfLastEventThatGotSnapshotted, snapshotEvent, config.deploymentId ?? null, serviceClient);
         },
         close: () => {
             closeFunctions.forEach(close => close());

package/dist/client/config.d.ts

@@ -1,8 +1,10 @@
 export interface ClientConfig {
     serverAddress: string;
     groupId: string;
+    deploymentId?: number | null;
     ackTimeout?: number;
     keepaliveInterval?: number;
     keepaliveTimeout?: number;
 }
 export declare const useConfigDefaults: (config: ClientConfig) => Required<ClientConfig>;
+//# sourceMappingURL=config.d.ts.map

package/dist/client/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../client/config.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAEzB,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,MAAM,CAAC;IAEhB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,iBAAiB,WAAY,YAAY,KAAG,QAAQ,CAAC,YAAY,CAS7E,CAAC"}

package/dist/client/config.js

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useConfigDefaults = void 0;
 const useConfigDefaults = (config) => {
-    var _a, _b, _c;
     return {
         serverAddress: config.serverAddress,
         groupId: config.groupId,
-        ackTimeout: (_a = config.ackTimeout) !== null && _a !== void 0 ? _a : 1000,
-        keepaliveTimeout: (_b = config.keepaliveTimeout) !== null && _b !== void 0 ? _b : 3 * 1000,
-        keepaliveInterval: (_c = config.keepaliveInterval) !== null && _c !== void 0 ? _c : 40 * 1000,
+        deploymentId: config.deploymentId || null,
+        ackTimeout: config.ackTimeout ?? 1000,
+        keepaliveTimeout: config.keepaliveTimeout ?? 3 * 1000,
+        keepaliveInterval: config.keepaliveInterval ?? 40 * 1000,
     };
 };
 exports.useConfigDefaults = useConfigDefaults;

package/dist/client/event.d.ts

@@ -1,8 +1,9 @@
-import { Event } from "@fraym/proto/freym/streams/management";
+import { Event } from "@fraym/proto/dist/index.freym.streams.management";
 export interface SubscriptionEvent extends BaseEvent {
     topic: string;
     raisedAt: Date;
     orderSerial?: number;
+    deploymentId?: number;
 }
 export interface PublishEvent extends BaseEvent {
     broadcast?: boolean;
@@ -16,6 +17,7 @@ export interface BaseEvent {
     correlationId?: string;
     causationId?: string;
     reason?: string;
+    userId?: string;
 }
 export type EventData = any | GdprEventData;
 export interface GdprEventData {
@@ -27,3 +29,4 @@ export interface GdprEventData {
 export declare const isGdprEventData: (value: EventData) => value is GdprEventData;
 export type HandlerFunc = (event: SubscriptionEvent) => Promise<void>;
 export declare const getSubscriptionEvent: (event: Event) => SubscriptionEvent | null;
+//# sourceMappingURL=event.d.ts.map

package/dist/client/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../client/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kDAAkD,CAAC;AAEzE,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC3C,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,MAAM,SAAS,GAAG,GAAG,GAAG,aAAa,CAAC;AAE5C,MAAM,WAAW,aAAa;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,KAAK,EAAE,GAAG,CAAC;IAEX,WAAW,EAAE,GAAG,CAAC;IACjB,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED,eAAO,MAAM,eAAe,UAAW,SAAS,KAAG,KAAK,IAAI,aAQ3D,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtE,eAAO,MAAM,oBAAoB,UAAW,KAAK,KAAG,iBAAiB,GAAG,IAwCvE,CAAC"}

package/dist/client/event.js

@@ -5,26 +5,27 @@ const isGdprEventData = (value) => {
     return (value &&
         typeof value === "object" &&
         Object.keys(value).length == 2 &&
-        value.hasOwnProperty("value") &&
-        value.hasOwnProperty("gdprDefault"));
+        Object.prototype.hasOwnProperty.call(value, "value") &&
+        Object.prototype.hasOwnProperty.call(value, "gdprDefault"));
 };
 exports.isGdprEventData = isGdprEventData;
 const getSubscriptionEvent = (event) => {
     const payload = {};
     for (const key in event.payload) {
-        if (Object.prototype.hasOwnProperty.call(event.payload, key)) {
-            const data = event.payload[key];
-            if (data.gdpr) {
-                payload[key] = {
-                    id: data.gdpr.id,
-                    value: JSON.parse(data.value),
-                    gdprDefault: data.gdpr.default ? JSON.parse(data.gdpr.default) : "",
-                    isInvalidated: data.gdpr.isInvalidated,
-                };
-            }
-            else {
-                payload[key] = JSON.parse(data.value);
-            }
+        const data = event.payload[key];
+        if (data === undefined) {
+            continue;
+        }
+        if (data.gdpr) {
+            payload[key] = {
+                id: data.gdpr.id,
+                value: JSON.parse(data.value),
+                gdprDefault: data.gdpr.default ? JSON.parse(data.gdpr.default) : "",
+                isInvalidated: data.gdpr.isInvalidated,
+            };
+        }
+        else {
+            payload[key] = JSON.parse(data.value);
         }
     }
     return {
@@ -39,6 +40,10 @@ const getSubscriptionEvent = (event) => {
         correlationId: event.metadata ? event.metadata.correlationId : undefined,
         reason: event.reason || undefined,
         orderSerial: event.metadata ? parseInt(event.metadata.orderSerial) : undefined,
+        deploymentId: event.metadata && event.metadata.deploymentId
+            ? parseInt(event.metadata.deploymentId)
+            : undefined,
+        userId: event.metadata ? event.metadata.userId || undefined : undefined,
     };
 };
 exports.getSubscriptionEvent = getSubscriptionEvent;

package/dist/client/getEvent.d.ts

@@ -1,3 +1,4 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 import { SubscriptionEvent } from "./event";
 export declare const getEvent: (tenantId: string, topic: string, eventId: string, serviceClient: ServiceClient) => Promise<SubscriptionEvent>;
+//# sourceMappingURL=getEvent.d.ts.map

package/dist/client/getEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getEvent.d.ts","sourceRoot":"","sources":["../../client/getEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAwB,MAAM,SAAS,CAAC;AAGlE,eAAO,MAAM,QAAQ,aACP,MAAM,SACT,MAAM,WACJ,MAAM,iBACA,aAAa,+BA4B/B,CAAC"}

package/dist/client/getLastEvent.d.ts

@@ -1,3 +1,4 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 import { SubscriptionEvent } from "./event";
 export declare const getLastEvent: (tenantId: string, topic: string, serviceClient: ServiceClient) => Promise<SubscriptionEvent | null>;
+//# sourceMappingURL=getLastEvent.d.ts.map

package/dist/client/getLastEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLastEvent.d.ts","sourceRoot":"","sources":["../../client/getLastEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAwB,MAAM,SAAS,CAAC;AAGlE,eAAO,MAAM,YAAY,aACX,MAAM,SACT,MAAM,iBACE,aAAa,sCAgC/B,CAAC"}

package/dist/client/getLastEvent.js

@@ -9,7 +9,7 @@ const getLastEvent = async (tenantId, topic, serviceClient) => {
             tenantId,
             topic,
         }, (error, response) => {
-            if (error === null || error === void 0 ? void 0 : error.details.includes("unable to find last event")) {
+            if (error?.details.includes("unable to find last event")) {
                 resolve(null);
                 return;
             }

package/dist/client/getLastEventByTypes.d.ts

@@ -1,3 +1,4 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 import { SubscriptionEvent } from "./event";
 export declare const getLastEventByTypes: (tenantId: string, topic: string, types: string[], serviceClient: ServiceClient) => Promise<SubscriptionEvent | null>;
+//# sourceMappingURL=getLastEventByTypes.d.ts.map

package/dist/client/getLastEventByTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLastEventByTypes.d.ts","sourceRoot":"","sources":["../../client/getLastEventByTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAwB,MAAM,SAAS,CAAC;AAGlE,eAAO,MAAM,mBAAmB,aAClB,MAAM,SACT,MAAM,SACN,MAAM,EAAE,iBACA,aAAa,sCAiC/B,CAAC"}

package/dist/client/getLastEventByTypes.js

@@ -10,7 +10,7 @@ const getLastEventByTypes = async (tenantId, topic, types, serviceClient) => {
             topic,
             types,
         }, (error, response) => {
-            if (error === null || error === void 0 ? void 0 : error.details.includes("unable to find last event by types")) {
+            if (error?.details.includes("unable to find last event by types")) {
                 resolve(null);
                 return;
             }

package/dist/client/introduceGdpr.d.ts

@@ -1,2 +1,3 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 export declare const introduceGdprOnEventField: (tenantId: string, defaultValue: string, topic: string, eventId: string, fieldName: string, serviceClient: ServiceClient) => Promise<void>;
+//# sourceMappingURL=introduceGdpr.d.ts.map

package/dist/client/introduceGdpr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introduceGdpr.d.ts","sourceRoot":"","sources":["../../client/introduceGdpr.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAGjF,eAAO,MAAM,yBAAyB,aACxB,MAAM,gBACF,MAAM,SACb,MAAM,WACJ,MAAM,aACJ,MAAM,iBACF,aAAa,kBAwB/B,CAAC"}

package/dist/client/invalidateGdpr.d.ts

@@ -1,2 +1,3 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 export declare const sendInvalidateGdpr: (tenantId: string, topic: string, gdprId: string, serviceClient: ServiceClient) => Promise<void>;
+//# sourceMappingURL=invalidateGdpr.d.ts.map

package/dist/client/invalidateGdpr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalidateGdpr.d.ts","sourceRoot":"","sources":["../../client/invalidateGdpr.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAGjF,eAAO,MAAM,kBAAkB,aACjB,MAAM,SACT,MAAM,UACL,MAAM,iBACC,aAAa,kBAsB/B,CAAC"}

package/dist/client/publish.d.ts

@@ -1,4 +1,5 @@
-import { PublishEvent as ProtobufPublishEvent, ServiceClient } from "@fraym/proto/freym/streams/management";
+import { PublishEvent as ProtobufPublishEvent, ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 import { PublishEvent } from "./event";
-export declare const sendPublish: (topic: string, events: PublishEvent[], serviceClient: ServiceClient) => Promise<void>;
-export declare const getProtobufPublishEventFromPublishedEvent: (event: PublishEvent) => ProtobufPublishEvent;
+export declare const sendPublish: (topic: string, events: PublishEvent[], deploymentId: number | null, serviceClient: ServiceClient) => Promise<void>;
+export declare const getProtobufPublishEventFromPublishedEvent: (event: PublishEvent, deploymentId: number | null) => ProtobufPublishEvent;
+//# sourceMappingURL=publish.d.ts.map

package/dist/client/publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../../client/publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,IAAI,oBAAoB,EACpC,aAAa,EAChB,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAmB,MAAM,SAAS,CAAC;AAGxD,eAAO,MAAM,WAAW,UACb,MAAM,UACL,YAAY,EAAE,gBACR,MAAM,GAAG,IAAI,iBACZ,aAAa,kBAuB/B,CAAC;AAEF,eAAO,MAAM,yCAAyC,UAC3C,YAAY,gBACL,MAAM,GAAG,IAAI,KAC5B,oBAuCF,CAAC"}

package/dist/client/publish.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProtobufPublishEventFromPublishedEvent = exports.sendPublish = void 0;
 const event_1 = require("./event");
 const util_1 = require("./util");
-const sendPublish = async (topic, events, serviceClient) => {
+const sendPublish = async (topic, events, deploymentId, serviceClient) => {
     return (0, util_1.retry)(() => new Promise((resolve, reject) => {
         serviceClient.publish({
-            events: events.map(exports.getProtobufPublishEventFromPublishedEvent),
+            events: events.map(event => (0, exports.getProtobufPublishEventFromPublishedEvent)(event, deploymentId)),
             topic,
         }, error => {
             if (error) {
@@ -18,8 +18,7 @@ const sendPublish = async (topic, events, serviceClient) => {
     }));
 };
 exports.sendPublish = sendPublish;
-const getProtobufPublishEventFromPublishedEvent = (event) => {
-    var _a, _b, _c, _d, _e, _f, _g;
+const getProtobufPublishEventFromPublishedEvent = (event, deploymentId) => {
     const payload = {};
     for (const key in event.payload) {
         const currentData = event.payload[key];
@@ -28,7 +27,7 @@ const getProtobufPublishEventFromPublishedEvent = (event) => {
                 value: JSON.stringify(currentData.value),
                 gdpr: {
                     default: JSON.stringify(currentData.gdprDefault),
-                    id: (_a = currentData.id) !== null && _a !== void 0 ? _a : "",
+                    id: currentData.id ?? "",
                     isInvalidated: false,
                 },
             }
@@ -40,17 +39,19 @@ const getProtobufPublishEventFromPublishedEvent = (event) => {
     return {
         id: event.id,
         metadata: {
-            causationId: (_b = event.causationId) !== null && _b !== void 0 ? _b : "",
-            correlationId: (_c = event.correlationId) !== null && _c !== void 0 ? _c : "",
+            causationId: event.causationId ?? "",
+            correlationId: event.correlationId ?? "",
             orderSerial: "0",
+            deploymentId: deploymentId?.toString() ?? "",
+            userId: event.userId ?? "",
         },
         options: {
-            broadcast: (_d = event.broadcast) !== null && _d !== void 0 ? _d : false,
+            broadcast: event.broadcast ?? false,
         },
-        reason: (_e = event.reason) !== null && _e !== void 0 ? _e : "",
-        stream: (_f = event.stream) !== null && _f !== void 0 ? _f : "",
+        reason: event.reason ?? "",
+        stream: event.stream ?? "",
         tenantId: event.tenantId,
-        type: (_g = event.type) !== null && _g !== void 0 ? _g : "",
+        type: event.type ?? "",
         payload,
     };
 };

package/dist/client/stream.d.ts

@@ -1,7 +1,8 @@
-import { ServiceClient } from "@fraym/proto/freym/streams/management";
+import { ServiceClient } from "@fraym/proto/dist/index.freym.streams.management";
 import { HandlerFunc, PublishEvent } from "./event";
 import { StopLoadingMoreFunc } from "./util";
-export declare const getStream: (topic: string, tenantId: string, stream: string, perPage: number, handler: HandlerFunc, stopLoadingMore: StopLoadingMoreFunc, serviceClient: ServiceClient) => Promise<void>;
-export declare const getStreamAfterEvent: (topic: string, tenantId: string, stream: string, eventId: string, perPage: number, handler: HandlerFunc, stopLoadingMore: StopLoadingMoreFunc, serviceClient: ServiceClient) => Promise<void>;
+export declare const getStream: (topic: string, tenantId: string, stream: string, perPage: number, handler: HandlerFunc, stopLoadingMore: StopLoadingMoreFunc, deploymentId: number | null, serviceClient: ServiceClient) => Promise<void>;
+export declare const getStreamAfterEvent: (topic: string, tenantId: string, stream: string, eventId: string, perPage: number, handler: HandlerFunc, stopLoadingMore: StopLoadingMoreFunc, deploymentId: number | null, serviceClient: ServiceClient) => Promise<void>;
 export declare const isStreamEmpty: (topic: string, tenantId: string, stream: string, serviceClient: ServiceClient) => Promise<boolean>;
-export declare const createStreamSnapshot: (tenantId: string, topic: string, stream: string, lastSnapshottedEventId: string, snapshotEvent: PublishEvent, serviceClient: ServiceClient) => Promise<void>;
+export declare const createStreamSnapshot: (tenantId: string, topic: string, stream: string, lastSnapshottedEventId: string, snapshotEvent: PublishEvent, deploymentId: number | null, serviceClient: ServiceClient) => Promise<void>;
+//# sourceMappingURL=stream.d.ts.map

package/dist/client/stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../client/stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,YAAY,EAA2C,MAAM,SAAS,CAAC;AAE7F,OAAO,EAAE,mBAAmB,EAAS,MAAM,QAAQ,CAAC;AAEpD,eAAO,MAAM,SAAS,UACX,MAAM,YACH,MAAM,UACR,MAAM,WACL,MAAM,WACN,WAAW,mBACH,mBAAmB,gBACtB,MAAM,GAAG,IAAI,iBACZ,aAAa,KAC7B,OAAO,CAAC,IAAI,CAsDd,CAAC;AAoCF,eAAO,MAAM,mBAAmB,UACrB,MAAM,YACH,MAAM,UACR,MAAM,WACL,MAAM,WACN,MAAM,WACN,WAAW,mBACH,mBAAmB,gBACtB,MAAM,GAAG,IAAI,iBACZ,aAAa,KAC7B,OAAO,CAAC,IAAI,CA+Bd,CAAC;AAsCF,eAAO,MAAM,aAAa,UACf,MAAM,YACH,MAAM,UACR,MAAM,iBACC,aAAa,KAC7B,OAAO,CAAC,OAAO,CAkBjB,CAAC;AAEF,eAAO,MAAM,oBAAoB,aACnB,MAAM,SACT,MAAM,UACL,MAAM,0BACU,MAAM,iBACf,YAAY,gBACb,MAAM,GAAG,IAAI,iBACZ,aAAa,KAC7B,OAAO,CAAC,IAAI,CAuBd,CAAC"}

package/dist/client/stream.js

@@ -4,19 +4,32 @@ exports.createStreamSnapshot = exports.isStreamEmpty = exports.getStreamAfterEve
 const event_1 = require("./event");
 const publish_1 = require("./publish");
 const util_1 = require("./util");
-const getStream = async (topic, tenantId, stream, perPage, handler, stopLoadingMore, serviceClient) => {
-    let page = 0;
-    let snapshotEventId = null;
+const getStream = async (topic, tenantId, stream, perPage, handler, stopLoadingMore, deploymentId, serviceClient) => {
+    let lastEventId = null;
+    let possibleSnapshotEventId = null;
+    let events = [];
     while (true) {
-        const response = await getStreamPage(topic, tenantId, stream, perPage, page, snapshotEventId, serviceClient);
-        snapshotEventId = response.snapshotEventId;
-        page++;
+        if (!lastEventId) {
+            events = await getStreamPage(topic, tenantId, stream, perPage, 0, deploymentId, serviceClient);
+            if (events.length > 0) {
+                possibleSnapshotEventId = events[0].id;
+            }
+        }
+        else {
+            events = await getStreamPageAfterEvent(topic, tenantId, stream, lastEventId, perPage, 0, deploymentId, serviceClient);
+        }
         let lastEvent = null;
-        for (const eventData of response.events) {
+        for (const eventData of events) {
             const event = (0, event_1.getSubscriptionEvent)(eventData);
             if (event) {
+                if (lastEventId != null && possibleSnapshotEventId) {
+                    if (event.id === possibleSnapshotEventId) {
+                        continue;
+                    }
+                }
                 await handler(event);
                 lastEvent = event;
+                lastEventId = event.id;
             }
         }
         if (stopLoadingMore(lastEvent)) {
@@ -25,7 +38,7 @@ const getStream = async (topic, tenantId, stream, perPage, handler, stopLoadingM
     }
 };
 exports.getStream = getStream;
-const getStreamPage = async (topic, tenantId, stream, perPage, page, snapshotEventId, serviceClient) => {
+const getStreamPage = async (topic, tenantId, stream, perPage, page, deploymentId, serviceClient) => {
     return (0, util_1.retry)(() => new Promise((resolve, reject) => {
         serviceClient.paginateStream({
             stream,
@@ -33,25 +46,23 @@ const getStreamPage = async (topic, tenantId, stream, perPage, page, snapshotEve
             topic,
             page: page.toString(),
             perPage: perPage.toString(),
-            snapshotEventId: snapshotEventId !== null && snapshotEventId !== void 0 ? snapshotEventId : "",
+            deploymentId: deploymentId?.toString() ?? "",
         }, async (error, data) => {
             if (error) {
                 reject(error);
                 return;
             }
-            resolve(data);
+            resolve(data.events);
         });
     }));
 };
-const getStreamAfterEvent = async (topic, tenantId, stream, eventId, perPage, handler, stopLoadingMore, serviceClient) => {
+const getStreamAfterEvent = async (topic, tenantId, stream, eventId, perPage, handler, stopLoadingMore, deploymentId, serviceClient) => {
     let page = 0;
-    let snapshotEventId = null;
     while (true) {
-        const response = await getStreamPageAfterEvent(topic, tenantId, stream, eventId, perPage, page, snapshotEventId, serviceClient);
-        snapshotEventId = response.snapshotEventId;
+        const events = await getStreamPageAfterEvent(topic, tenantId, stream, eventId, perPage, page, deploymentId, serviceClient);
         page++;
         let lastEvent = null;
-        for (const eventData of response.events) {
+        for (const eventData of events) {
             const event = (0, event_1.getSubscriptionEvent)(eventData);
             if (event) {
                 await handler(event);
@@ -64,7 +75,7 @@ const getStreamAfterEvent = async (topic, tenantId, stream, eventId, perPage, ha
     }
 };
 exports.getStreamAfterEvent = getStreamAfterEvent;
-const getStreamPageAfterEvent = async (topic, tenantId, stream, eventId, perPage, page, snapshotEventId, serviceClient) => {
+const getStreamPageAfterEvent = async (topic, tenantId, stream, eventId, perPage, page, deploymentId, serviceClient) => {
     return (0, util_1.retry)(() => new Promise((resolve, reject) => {
         serviceClient.paginateStreamAfterEventId({
             stream,
@@ -73,13 +84,13 @@ const getStreamPageAfterEvent = async (topic, tenantId, stream, eventId, perPage
             eventId,
             page: page.toString(),
             perPage: perPage.toString(),
-            snapshotEventId: snapshotEventId !== null && snapshotEventId !== void 0 ? snapshotEventId : "",
+            deploymentId: deploymentId?.toString() ?? "",
         }, async (error, data) => {
             if (error) {
                 reject(error);
                 return;
             }
-            resolve(data);
+            resolve(data.events);
         });
     }));
 };
@@ -99,14 +110,14 @@ const isStreamEmpty = async (topic, tenantId, stream, serviceClient) => {
     });
 };
 exports.isStreamEmpty = isStreamEmpty;
-const createStreamSnapshot = async (tenantId, topic, stream, lastSnapshottedEventId, snapshotEvent, serviceClient) => {
+const createStreamSnapshot = async (tenantId, topic, stream, lastSnapshottedEventId, snapshotEvent, deploymentId, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.createStreamSnapshot({
             topic,
             stream,
             tenantId,
             lastSnapshottedEventId,
-            snapshotEvent: (0, publish_1.getProtobufPublishEventFromPublishedEvent)(snapshotEvent),
+            snapshotEvent: (0, publish_1.getProtobufPublishEventFromPublishedEvent)(snapshotEvent, deploymentId),
         }, error => {
             if (error) {
                 reject(error);

package/dist/client/subscribe.d.ts

@@ -1,4 +1,4 @@
-import { ServiceClient, SubscribeRequest, SubscribeResponse } from "@fraym/proto/freym/streams/management";
+import { ServiceClient, SubscribeRequest, SubscribeResponse } from "@fraym/proto/dist/index.freym.streams.management";
 import { ClientDuplexStream } from "@grpc/grpc-js";
 import { ClientConfig } from "./config";
 import { HandlerFunc } from "./event";
@@ -11,3 +11,4 @@ export interface Subscription {
 export type Stream = ClientDuplexStream<SubscribeRequest, SubscribeResponse>;
 export declare const newSubscription: (topics: string[], ignoreUnhandledEvents: boolean, config: ClientConfig, serviceClient: ServiceClient) => Subscription;
 export declare const initStream: (topics: string[], config: ClientConfig, stream: Stream) => Promise<Stream>;
+//# sourceMappingURL=subscribe.d.ts.map

package/dist/client/subscribe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribe.d.ts","sourceRoot":"","sources":["../../client/subscribe.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACpB,MAAM,kDAAkD,CAAC;AAE1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,WAAW,EAAwB,MAAM,SAAS,CAAC;AAE5D,MAAM,WAAW,YAAY;IACzB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;IACzD,qBAAqB,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;IACtD,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;AAE7E,eAAO,MAAM,eAAe,WAChB,MAAM,EAAE,yBACO,OAAO,UACtB,YAAY,iBACL,aAAa,KAC7B,YAoHF,CAAC;AAEF,eAAO,MAAM,UAAU,WACX,MAAM,EAAE,UACR,YAAY,UACZ,MAAM,KACf,OAAO,CAAC,MAAM,CA8BhB,CAAC"}

package/dist/client/subscribe.js

@@ -26,6 +26,7 @@ const newSubscription = (topics, ignoreUnhandledEvents, config, serviceClient) =
             }
             rebuildConnection(newStream, retries - 1);
         });
+        /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
         newStream.on("error", (err) => {
             if (closed) {
                 return;
@@ -37,10 +38,9 @@ const newSubscription = (topics, ignoreUnhandledEvents, config, serviceClient) =
             rebuildConnection(newStream, retries - 1);
         });
         const dataFn = async (data) => {
-            var _a, _b, _c, _d;
             if (!data.payload ||
-                ((_a = data.payload) === null || _a === void 0 ? void 0 : _a.$case) === "panic" ||
-                ((_b = data.payload) === null || _b === void 0 ? void 0 : _b.$case) === "subscribed") {
+                data.payload?.$case === "panic" ||
+                data.payload?.$case === "subscribed") {
                 newStream.cancel();
                 return;
             }
@@ -48,7 +48,7 @@ const newSubscription = (topics, ignoreUnhandledEvents, config, serviceClient) =
             if (!event) {
                 return;
             }
-            const currentHandlers = (_d = typeHandlerMap[(_c = event.type) !== null && _c !== void 0 ? _c : ""]) !== null && _d !== void 0 ? _d : [];
+            const currentHandlers = typeHandlerMap[event.type ?? ""] ?? [];
             currentHandlers.push(...globalHandlers);
             if (currentHandlers.length === 0) {
                 if (ignoreUnhandledEvents) {
@@ -108,14 +108,14 @@ const initStream = async (topics, config, stream) => {
                     metadata: {
                         group: config.groupId,
                         subscriberId: (0, uuid_1.v4)(),
+                        deploymentId: config.deploymentId?.toString() ?? "",
                     },
                     topics,
                 },
             },
         });
         stream.once("data", (data) => {
-            var _a;
-            if (((_a = data.payload) === null || _a === void 0 ? void 0 : _a.$case) !== "subscribed") {
+            if (data.payload?.$case !== "subscribed") {
                 reject("connection to streams service was not initialized correctly");
                 return;
             }
@@ -135,7 +135,7 @@ const newHandledRequest = (tenantId, topic, error) => {
             handled: {
                 tenantId,
                 topic,
-                error: error !== null && error !== void 0 ? error : "",
+                error: error ?? "",
             },
         },
     };

package/dist/client/util.d.ts

@@ -1,4 +1,5 @@
 import { SubscriptionEvent } from "client/event";
 export declare const sleep: (delay: number) => Promise<void>;
-export declare const retry: <T extends unknown>(fn: () => Promise<T>, pause?: number, retries?: number) => Promise<T>;
+export declare const retry: <T>(fn: () => Promise<T>, pause?: number, retries?: number) => Promise<T>;
 export type StopLoadingMoreFunc = (lastEvent: SubscriptionEvent | null) => boolean;
+//# sourceMappingURL=util.d.ts.map

package/dist/client/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../client/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGjD,eAAO,MAAM,KAAK,UAAW,MAAM,kBAG7B,CAAC;AAEP,eAAO,MAAM,KAAK,GAAU,CAAC,MACrB,MAAM,OAAO,CAAC,CAAC,CAAC,UACb,MAAM,YACJ,MAAM,KAChB,OAAO,CAAC,CAAC,CAaX,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,KAAK,OAAO,CAAC"}

package/dist/client/util.js

@@ -9,6 +9,7 @@ exports.sleep = sleep;
 const retry = async (fn, pause = 100, retries = 50) => {
     try {
         return await fn();
+        /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
     }
     catch (err) {
         if (retries === 0 || (err && err.code && err.code === constants_1.Status.UNKNOWN)) {

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./client/client";
-export { HandlerFunc, PublishEvent, SubscriptionEvent, BaseEvent, EventData, GdprEventData, } from "./client/event";
-export { ClientConfig } from "./client/config";
+export type { HandlerFunc, PublishEvent, SubscriptionEvent, BaseEvent, EventData, GdprEventData, } from "./client/event";
+export type { ClientConfig } from "./client/config";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,YAAY,EACR,WAAW,EACX,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,SAAS,EACT,aAAa,GAChB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -1,41 +1,33 @@
 {
     "name": "@fraym/streams",
-    "version": "0.10.6",
+    "version": "0.30.0-alpha.18",
     "license": "MIT",
-    "homepage": "https://github.com/fraym/streams-nodejs",
+    "homepage": "https://github.com/fraym/freym-api",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/fraym/streams-nodejs.git"
+        "url": "git+https://github.com/fraym/freym-api.git"
     },
-    "description": "nodejs client implementation for our event streaming service",
+    "description": "JS client implementation for Freyms streams service",
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 0",
-        "format": "prettier --write \"**/*.{ts,tsx,json}\"",
-        "lint": "prettier --check \"**/*.{ts,tsx,json}\"",
-        "build": "npm run clean && tsc",
-        "clean": "rm -rf dist",
-        "prepublishOnly": "npm test && npm run lint && npm run build",
-        "preversion": "npm run lint"
+        "build": "rm -rf dist && tsc",
+        "lint": "eslint && prettier --check \"**/*.{ts,tsx,json,scss,css}\"",
+        "fix": "eslint --fix && prettier --write \"**/*.{ts,tsx,json,scss,css}\""
     },
     "files": [
         "dist/**/*"
     ],
     "engines": {
-        "node": ">=16"
+        "node": ">=20"
     },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "dependencies": {
-        "@fraym/proto": "^0.28.2",
-        "@grpc/grpc-js": "^1.12.6",
+        "@fraym/proto": "^0.30.0-alpha.18",
+        "@grpc/grpc-js": "^1.12.5",
         "uuid": "^11.0.5"
     },
     "devDependencies": {
-        "@becklyn/prettier": "^2.1.1",
-        "@types/uuid": "^10.0.0",
-        "prettier": "^3.5.0",
-        "ts-node": "^10.9.2",
-        "typescript": "^5.7.3"
+        "@types/uuid": "^10.0.0"
     },
     "prettier": "@becklyn/prettier"
 }

package/README.md

@@ -1,140 +0,0 @@
-# streams-nodejs
-
-Client implementation in javascript for the event streaming service [streams](https://github.com/fraym/streams).
-
-## Installation
-
-```shell
-npm i @fraym/streams
-```
-
-## Usage
-
-### Create the client
-
-```typescript
-const client = await newClient({
-    serverAddress: "127.0.0.1:9000",
-    groupId: "your-services-group-identifier",
-});
-```
-
-### Publish events
-
-Events are published in a transactional manner:
-
--   you can publish a set of events in a transaction
--   if one event in your set cannot be published no event will be published
--   as soon as all events are published they appear in their streams
-
-You can only publish events of one topic per transaction.
-Most of the fields of an event are optional. You do not have to use or specify them, but you can use them if you want to.
-
-```typescript
-await client.publish("topic", [
-    {
-        id: uuid(),
-        tenantId: "tenantId",
-        payload: {
-            key: "value",
-			object: {
-				key: "objectKeyValue"
-			},
-        },
-        // set `broadcast` to true if you want all subscribers of a group to process the event.
-        // set to false (or remove) if you want this event to be handled only once by a group of subscribers.
-        broadcast: false,
-        type: "event-type",
-        stream: "stream-name",
-        correlationId: uuid(),
-        causationId: uuid(),
-        reason: "the reason why this event was triggered",
-    },
-]);
-```
-
-### Get events of a stream
-
-If you want to get all events that belong to a given stream you can do this by calling `getStream``:
-
-```typescript
-const streamEvents = await client.getStream("tenantId", "stream");
-```
-
-### Register event handlers for event subscriptions
-
-```typescript
-// this handler is called for events of all types
-client.useEventHandlerForAllEventTypes(async (event: SubscriptionEvent) => {
-    // @todo: handle the event in this callback
-});
-
-// this handler is only called for events of the given type "event-type"
-client.useEventHandler("event-type", async (event: SubscriptionEvent) => {
-    // @todo: handle the event in this callback
-});
-```
-
-### Subscribe to events
-
-You can subscribe to events of all topics by not providing any parameters to the subscribe function:
-
-```typescript
-await client.subscribe();
-```
-
-You can subscribe to events of a given set of topics by specifying the `includedTopics` list:
-
-```typescript
-await client.subscribe(["topic-1", "topic-2"]);
-```
-
-You can subscribe to all events except of a given set of topics by specifying the `excludedTopics` list:
-
-```typescript
-await client.subscribe([], ["topic-1", "topic-2"]);
-```
-
-One client instance is only able to subscribe once. If you try to subscribe twice you will get an error.
-
-### Get all events for a given topic filter
-
-The `getAllEvents` function uses the same topic filter parameters as described for the [subscribe](#subscribe-to-events) function
-
-```typescript
-await client.getAllEvents(async (event: SubscriptionEvent) => {
-    // @todo: handle the event in this callback
-});
-```
-
-### Invalidate gdpr data
-
-You will not need to use this if you use our GDPR service.
-
-```typescript
-await client.invalidateGdprData("tenantId", "topic-1", "grprId");
-```
-
-### Create a snapshot of a topic
-
-A snapshot moves events from the "fast access" database to a "long time storage".
-The long time storage will have slower access time.
-Use this if you have topics that have a lot of old events which are not queried regularly.
-
-Creating a snapshot will only affect performance. You will not lose any of your events.
-
-Snapshots can be used to clean up your "fast access" event database and therefore increase performance on new events.
-
-```typescript
-await client.createSnapshot("topic-1", new Date());
-```
-
-The second parameter is a date. All events that are older than that date will be moved to the snapshot.
-
-### Gracefully close the client
-
-You won't lose any data if you don't. Use it for your peace of mind.
-
-```typescript
-client.close();
-```