@fraym/streams 0.2.0 → 0.3.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/README.md

@@ -37,6 +37,9 @@ await client.publish("topic", [
         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.
@@ -135,38 +138,3 @@ You won't lose any data if you don't. Use it for your peace of mind.
 ```typescript
 client.close();
 ```
-
-## Development
-
-You'll need the following apps for a smooth development experience:
-
--   minikube
--   lens
--   okteto
--   helm
-
-### Running the dev environment
-
--   Start minikube if not already done:
-
-```shell
-minikube start
-```
-
--   add mongodb and minio to your lokal kubernetes
-    -   use Makefiles in `./.dev/*`
--   copy `.env.build` to `.env.build.local`
-    -   add your personal access token (needs read access for private fraym org repositories)
--   deploy the app to your cluster
-
-```
-make init
-```
-
--   start okteto
-
-```
-make dev
-```
-
--   connect your IDE to that okteto instance

package/dist/client/client.d.ts

@@ -1,13 +1,17 @@
+import { ServiceClient } from "@fraym/streams-proto";
 import { ClientConfig } from "./config";
 import { HandlerFunc, PublishEvent, SubscriptionEvent } from "./event";
 export interface Client {
     getAllEvents: (handler: HandlerFunc, includedTopics?: string[], excludedTopics?: 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

@@ -13,6 +13,8 @@ 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 newClient = async (config) => {
     config = (0, config_1.useConfigDefaults)(config);
     const serviceClient = new streams_proto_1.ServiceClient(config.serverAddress, grpc_js_1.credentials.createInsecure(), {
@@ -27,6 +29,9 @@ const newClient = async (config) => {
         getAllEvents: async (handler, includedTopics = [], excludedTopics = []) => {
             await (0, allEvents_1.getAllEvents)(includedTopics, excludedTopics, 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 +50,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

@@ -16,10 +16,13 @@ export interface BaseEvent {
     causationId?: string;
     reason?: string;
 }
-export type EventData = string | GdprEventData;
+export type EventData = any | GdprEventData;
 export interface GdprEventData {
-    value: string;
-    gdprDefault: string;
+    id?: string;
+    value: any;
+    gdprDefault: any;
+    isInvalidated: boolean;
 }
+export declare const isGdprEventData: (value: EventData) => value is GdprEventData;
 export type HandlerFunc = (event: SubscriptionEvent) => Promise<void>;
 export declare const getSubscriptionEvent: (eventEnvelope: PublishEventEnvelope) => SubscriptionEvent | null;

package/dist/client/event.js

@@ -1,8 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSubscriptionEvent = void 0;
+exports.getSubscriptionEvent = exports.isGdprEventData = void 0;
+const isGdprEventData = (value) => {
+    return (value &&
+        typeof value === "object" &&
+        Object.keys(value).length == 2 &&
+        value.hasOwnProperty("value") &&
+        value.hasOwnProperty("gdprDefault"));
+};
+exports.isGdprEventData = isGdprEventData;
 const getSubscriptionEvent = (eventEnvelope) => {
-    var _a;
     const event = eventEnvelope.event;
     if (!event) {
         return null;
@@ -13,12 +20,15 @@ const getSubscriptionEvent = (eventEnvelope) => {
             const data = event.payload[key];
             if (data.metadata && data.metadata.gdpr) {
                 payload[key] = {
-                    value: data.value,
-                    gdprDefault: (_a = data.metadata.gdpr.default) !== null && _a !== void 0 ? _a : "",
+                    value: JSON.parse(data.value),
+                    gdprDefault: data.metadata.gdpr.default
+                        ? JSON.parse(data.metadata.gdpr.default)
+                        : "",
+                    isInvalidated: data.metadata.gdpr.invalidated,
                 };
             }
             else {
-                payload[key] = data.value;
+                payload[key] = JSON.parse(data.value);
             }
         }
     }

package/dist/client/getEvent.d.ts

@@ -0,0 +1,3 @@
+import { ServiceClient } from "@fraym/streams-proto";
+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/introduceGdpr.d.ts

@@ -0,0 +1,3 @@
+import { ServiceClient } from "@fraym/streams-proto";
+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/publish.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sendPublish = void 0;
+const event_1 = require("./event");
 const sendPublish = async (topic, events, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.publish({
@@ -17,36 +18,36 @@ 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];
-        payload[key] =
-            typeof currentData === "string"
-                ? {
-                    value: currentData,
-                }
-                : {
-                    value: currentData.value,
-                    metadata: {
-                        $case: "gdpr",
-                        gdpr: {
-                            default: currentData.gdprDefault,
-                            id: "",
-                        },
+        payload[key] = (0, event_1.isGdprEventData)(currentData)
+            ? {
+                value: JSON.stringify(currentData.value),
+                metadata: {
+                    $case: "gdpr",
+                    gdpr: {
+                        default: JSON.stringify(currentData.gdprDefault),
+                        id: (_a = currentData.id) !== null && _a !== void 0 ? _a : "",
+                        invalidated: false,
                     },
-                };
+                },
+            }
+            : {
+                value: JSON.stringify(currentData),
+            };
     }
     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",
         },

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.0",
-    "license": "UNLICENSED",
+    "version": "0.3.0",
+    "license": "MIT",
     "homepage": "https://github.com/fraym/streams-nodejs",
     "repository": {
         "type": "git",
@@ -24,16 +24,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/streams-proto": "^7.1.2",
+        "@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"
 }