@fraym/streams 0.2.1 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Becklyn Studios
+
+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/client/allEvents.d.ts

@@ -1,3 +1,3 @@
-import { ServiceClient } from "@fraym/streams-proto";
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
 import { HandlerFunc } from "./event";
 export declare const getAllEvents: (includedTopics: string[], excludedTopics: string[], handler: HandlerFunc, serviceClient: ServiceClient) => Promise<void>;

package/dist/client/allEventsFiltered.d.ts

@@ -0,0 +1,3 @@
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
+import { HandlerFunc } from "./event";
+export declare const getAllEventsFiltered: (includedTopics: string[], includedEventTypes: string[], handler: HandlerFunc, serviceClient: ServiceClient) => Promise<void>;

package/dist/client/allEventsFiltered.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllEventsFiltered = void 0;
+const event_1 = require("./event");
+const getAllEventsFiltered = async (includedTopics, includedEventTypes, handler, serviceClient) => {
+    const stream = serviceClient.getFilteredEventsFromStart({
+        includedTopics,
+        includedEventTypes,
+    });
+    return new Promise((resolve, reject) => {
+        stream.on("data", (data) => {
+            const event = (0, event_1.getSubscriptionEvent)(data);
+            if (event) {
+                handler(event);
+            }
+        });
+        stream.on("end", () => {
+            resolve();
+        });
+        stream.on("error", e => {
+            reject(e);
+        });
+    });
+};
+exports.getAllEventsFiltered = getAllEventsFiltered;

package/dist/client/client.d.ts

@@ -1,13 +1,18 @@
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
 import { ClientConfig } from "./config";
 import { HandlerFunc, PublishEvent, SubscriptionEvent } from "./event";
 export interface Client {
     getAllEvents: (handler: HandlerFunc, includedTopics?: string[], excludedTopics?: string[]) => Promise<void>;
+    getAllEventsFiltered: (handler: HandlerFunc, includedTopics: string[], includedEventTypes: string[]) => Promise<void>;
+    getEvent: (tenantId: string, topic: string, eventId: string) => Promise<SubscriptionEvent>;
     getStream: (tenantId: string, stream: string) => Promise<SubscriptionEvent[]>;
     useEventHandler: (type: string, handler: HandlerFunc) => void;
     useEventHandlerForAllEventTypes: (handler: HandlerFunc) => void;
     subscribe: (includedTopics?: string[], excludedTopics?: string[]) => Promise<void>;
     publish: (topic: string, events: PublishEvent[]) => Promise<void>;
     invalidateGdprData: (tenantId: string, topic: string, gdprId: string) => Promise<void>;
+    introduceGdprOnField: (defaultValue: string, topic: string, eventType: string, fieldName: string, serviceClient: ServiceClient) => Promise<void>;
+    introduceGdprOnEventField: (tenantId: string, defaultValue: string, topic: string, eventId: string, fieldName: string, serviceClient: ServiceClient) => Promise<void>;
     createSnapshot: (topic: string, toTime: Date) => Promise<void>;
     close: () => void;
 }

package/dist/client/client.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.newClient = void 0;
-const streams_proto_1 = require("@fraym/streams-proto");
+const clientchannel_1 = require("@fraym/proto/freym/streams/clientchannel");
 const grpc_js_1 = require("@grpc/grpc-js");
 const allEvents_1 = require("./allEvents");
 const config_1 = require("./config");
@@ -13,9 +13,12 @@ const publish_1 = require("./publish");
 const snapshot_1 = require("./snapshot");
 const stream_1 = require("./stream");
 const subscribe_1 = require("./subscribe");
+const getEvent_1 = require("./getEvent");
+const introduceGdpr_1 = require("./introduceGdpr");
+const allEventsFiltered_1 = require("./allEventsFiltered");
 const newClient = async (config) => {
     config = (0, config_1.useConfigDefaults)(config);
-    const serviceClient = new streams_proto_1.ServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
+    const serviceClient = new clientchannel_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,
@@ -27,6 +30,12 @@ const newClient = async (config) => {
         getAllEvents: async (handler, includedTopics = [], excludedTopics = []) => {
             await (0, allEvents_1.getAllEvents)(includedTopics, excludedTopics, handler, serviceClient);
         },
+        getAllEventsFiltered: async (handler, includedTopics, includedEventTypes) => {
+            await (0, allEventsFiltered_1.getAllEventsFiltered)(includedTopics, includedEventTypes, handler, serviceClient);
+        },
+        getEvent: async (tenantId, topic, eventId) => {
+            return await (0, getEvent_1.getEvent)(tenantId, topic, eventId, serviceClient);
+        },
         getStream: async (tenantId, stream) => {
             return await (0, stream_1.getStream)(tenantId, stream, serviceClient);
         },
@@ -45,6 +54,12 @@ const newClient = async (config) => {
         publish: async (topic, events) => {
             return (0, publish_1.sendPublish)(topic, events, serviceClient);
         },
+        introduceGdprOnField: async (defaultValue, topic, eventType, fieldName) => {
+            return await (0, introduceGdpr_1.introduceGdprOnField)(defaultValue, topic, eventType, fieldName, serviceClient);
+        },
+        introduceGdprOnEventField: async (tenantId, defaultValue, topic, eventId, fieldName) => {
+            return (0, introduceGdpr_1.introduceGdprOnEventField)(tenantId, defaultValue, topic, eventId, fieldName, serviceClient);
+        },
         invalidateGdprData: async (tenantId, topic, gdprId) => {
             return await (0, invalidateGdpr_1.sendInvalidateGdpr)(tenantId, topic, gdprId, serviceClient);
         },

package/dist/client/event.d.ts

@@ -1,4 +1,4 @@
-import { PublishEventEnvelope } from "@fraym/streams-proto";
+import { PublishEventEnvelope } from "@fraym/proto/freym/streams/clientchannel";
 export interface SubscriptionEvent extends BaseEvent {
     topic: string;
     raisedAt: Date;
@@ -18,8 +18,10 @@ export interface BaseEvent {
 }
 export type EventData = any | GdprEventData;
 export interface GdprEventData {
+    id?: string;
     value: any;
     gdprDefault: any;
+    isInvalidated: boolean;
 }
 export declare const isGdprEventData: (value: EventData) => value is GdprEventData;
 export type HandlerFunc = (event: SubscriptionEvent) => Promise<void>;

package/dist/client/event.js

@@ -24,6 +24,7 @@ const getSubscriptionEvent = (eventEnvelope) => {
                     gdprDefault: data.metadata.gdpr.default
                         ? JSON.parse(data.metadata.gdpr.default)
                         : "",
+                    isInvalidated: data.metadata.gdpr.invalidated,
                 };
             }
             else {
@@ -36,7 +37,7 @@ const getSubscriptionEvent = (eventEnvelope) => {
         topic: eventEnvelope.topic,
         tenantId: eventEnvelope.tenantId,
         payload,
-        raisedAt: new Date(parseInt(event.raisedAt.slice(0, -6))),
+        raisedAt: new Date(parseInt(event.raisedAt.toString().slice(0, -6))),
         stream: event.stream || undefined,
         type: event.type || undefined,
         causationId: event.causationId || undefined,

package/dist/client/getEvent.d.ts

@@ -0,0 +1,3 @@
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
+import { SubscriptionEvent } from "./event";
+export declare const getEvent: (tenantId: string, topic: string, eventId: string, serviceClient: ServiceClient) => Promise<SubscriptionEvent>;

package/dist/client/getEvent.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEvent = void 0;
+const event_1 = require("./event");
+const getEvent = async (tenantId, topic, eventId, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.getEvent({
+            tenantId,
+            topic,
+            eventId,
+        }, (error, response) => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            const event = (0, event_1.getSubscriptionEvent)(response);
+            if (event) {
+                resolve(event);
+            }
+            reject("unable to resolve event from event data");
+        });
+    });
+};
+exports.getEvent = getEvent;

package/dist/client/init.d.ts

@@ -1,5 +1,5 @@
 import { ClientConfig } from "./config";
 import { ClientDuplexStream } from "@grpc/grpc-js";
-import { SubscribeRequest, ServiceClient, SubscribeResponse } from "@fraym/streams-proto";
+import { SubscribeRequest, ServiceClient, SubscribeResponse } from "@fraym/proto/freym/streams/clientchannel";
 export type Stream = ClientDuplexStream<SubscribeRequest, SubscribeResponse>;
 export declare const initStream: (config: ClientConfig, serviceClient: ServiceClient) => Promise<Stream>;

package/dist/client/introduceGdpr.d.ts

@@ -0,0 +1,3 @@
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
+export declare const introduceGdprOnField: (defaultValue: string, topic: string, eventType: string, fieldName: string, serviceClient: ServiceClient) => Promise<void>;
+export declare const introduceGdprOnEventField: (tenantId: string, defaultValue: string, topic: string, eventId: string, fieldName: string, serviceClient: ServiceClient) => Promise<void>;

package/dist/client/introduceGdpr.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.introduceGdprOnEventField = exports.introduceGdprOnField = void 0;
+const introduceGdprOnField = async (defaultValue, topic, eventType, fieldName, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.introduceGdprOnField({
+            defaultValue,
+            topic,
+            eventType,
+            fieldName,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.introduceGdprOnField = introduceGdprOnField;
+const introduceGdprOnEventField = async (tenantId, defaultValue, topic, eventId, fieldName, serviceClient) => {
+    return new Promise((resolve, reject) => {
+        serviceClient.introduceGdprOnEventField({
+            tenant: tenantId,
+            defaultValue,
+            topic,
+            eventId,
+            fieldName,
+        }, error => {
+            if (error) {
+                reject(error.message);
+                return;
+            }
+            resolve();
+        });
+    });
+};
+exports.introduceGdprOnEventField = introduceGdprOnEventField;

package/dist/client/invalidateGdpr.d.ts

@@ -1,2 +1,2 @@
-import { ServiceClient } from "@fraym/streams-proto";
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
 export declare const sendInvalidateGdpr: (tenantId: string, topic: string, gdprId: string, serviceClient: ServiceClient) => Promise<void>;

package/dist/client/publish.d.ts

@@ -1,3 +1,3 @@
 import { PublishEvent } from "./event";
-import { ServiceClient } from "@fraym/streams-proto";
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
 export declare const sendPublish: (topic: string, events: PublishEvent[], serviceClient: ServiceClient) => Promise<void>;

package/dist/client/publish.js

@@ -18,7 +18,7 @@ const sendPublish = async (topic, events, serviceClient) => {
 };
 exports.sendPublish = sendPublish;
 const getEventEnvelopeFromPublishedEvent = (event) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     const payload = {};
     for (const key in event.payload) {
         const currentData = event.payload[key];
@@ -29,7 +29,8 @@ const getEventEnvelopeFromPublishedEvent = (event) => {
                     $case: "gdpr",
                     gdpr: {
                         default: JSON.stringify(currentData.gdprDefault),
-                        id: "",
+                        id: (_a = currentData.id) !== null && _a !== void 0 ? _a : "",
+                        invalidated: false,
                     },
                 },
             }
@@ -38,17 +39,17 @@ const getEventEnvelopeFromPublishedEvent = (event) => {
             };
     }
     return {
-        broadcast: (_a = event.broadcast) !== null && _a !== void 0 ? _a : false,
+        broadcast: (_b = event.broadcast) !== null && _b !== void 0 ? _b : false,
         tenantId: event.tenantId,
         event: {
             id: event.id,
-            type: (_b = event.type) !== null && _b !== void 0 ? _b : "",
-            reason: (_c = event.reason) !== null && _c !== void 0 ? _c : "",
-            stream: (_d = event.stream) !== null && _d !== void 0 ? _d : "",
-            correlationId: (_e = event.correlationId) !== null && _e !== void 0 ? _e : "",
-            causationId: (_f = event.causationId) !== null && _f !== void 0 ? _f : "",
+            type: (_c = event.type) !== null && _c !== void 0 ? _c : "",
+            reason: (_d = event.reason) !== null && _d !== void 0 ? _d : "",
+            stream: (_e = event.stream) !== null && _e !== void 0 ? _e : "",
+            correlationId: (_f = event.correlationId) !== null && _f !== void 0 ? _f : "",
+            causationId: (_g = event.causationId) !== null && _g !== void 0 ? _g : "",
             payload,
-            raisedAt: "0",
+            raisedAt: 0,
         },
     };
 };

package/dist/client/snapshot.d.ts

@@ -1,2 +1,2 @@
-import { ServiceClient } from "@fraym/streams-proto";
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
 export declare const sendSnapshot: (topic: string, toTime: Date, serviceClient: ServiceClient) => Promise<void>;

package/dist/client/stream.d.ts

@@ -1,3 +1,3 @@
 import { SubscriptionEvent } from "./event";
-import { ServiceClient } from "@fraym/streams-proto";
+import { ServiceClient } from "@fraym/proto/freym/streams/clientchannel";
 export declare const getStream: (tenantId: string, stream: string, serviceClient: ServiceClient) => Promise<SubscriptionEvent[]>;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export * from "./client/client";
-export { HandlerFunc, PublishEvent, SubscriptionEvent } from "./client/event";
+export { HandlerFunc, PublishEvent, SubscriptionEvent, BaseEvent, EventData, GdprEventData, } from "./client/event";
 export { ClientConfig } from "./client/config";

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@fraym/streams",
-    "version": "0.2.1",
-    "license": "UNLICENSED",
+    "version": "0.4.0",
+    "license": "MIT",
     "homepage": "https://github.com/fraym/streams-nodejs",
     "repository": {
         "type": "git",
@@ -15,25 +15,27 @@
         "build": "npm run clean && tsc",
         "clean": "rm -rf dist",
         "prepublishOnly": "npm test && npm run lint && npm run build",
-        "preversion": "npm run lint",
-        "protobuf": "./protobuf.sh"
+        "preversion": "npm run lint"
     },
     "files": [
         "dist/**/*"
     ],
+    "engines": {
+        "node": ">=16"
+    },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "dependencies": {
-        "@fraym/streams-proto": "^7.0.0-alpha.1",
-        "@grpc/grpc-js": "^1.8.7",
+        "@fraym/proto": "^0.3.0",
+        "@grpc/grpc-js": "^1.8.17",
         "ts-node": "^10.9.1",
         "uuid": "^9.0.0"
     },
     "devDependencies": {
         "@becklyn/prettier": "^1.0.2",
         "@types/uuid": "^8.3.4",
-        "prettier": "^2.7.1",
-        "typescript": "^4.8.4"
+        "prettier": "^2.8.8",
+        "typescript": "^4.9.5"
     },
     "prettier": "@becklyn/prettier"
 }