@notifizz/nodejs 1.0.0

package/README.md

@@ -0,0 +1,65 @@
+# 📦 Notifizz Client SDK
+
+A **JavaScript/TypeScript** client for sending and tracking events with **Notifizz**.  
+It allows you to:
+
+- Send events (`track`) with workflows and recipients
+- Configure enrichment functions
+- Handle authentication via `sdkSecretKey` and `authSecretKey`
+- Send notifications directly to the **Notification Center**
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install notifizz-client
+# or
+yarn add notifizz-client
+
+## Initialize the client
+
+import { NotifizzClient } from "notifizz-client";
+
+const client = new NotifizzClient(
+  "AUTH_SECRET_KEY", // provided by Notifizz
+  "SDK_SECRET_KEY"   // provided by Notifizz
+);
+
+## Track Events
+
+await client
+  .track({
+    eventName: "user_signed_up",
+    sdkSecretKey: "SDK_SECRET_KEY",
+    properties: {
+      plan: "pro",
+      source: "landing_page",
+    },
+  })
+  .workflow("campaign_123", [
+    { id: "user_1", email: "test@test.com" },
+    { id: "user_2", email: "hello@test.com" },
+  ]);
+
+## Generate a user token
+
+const token = client.generateHashedToken("user_123");
+
+
+## Configure enrichment functions
+
+NotifizzClient.configureEnrich("workflow_abc", (properties) => ({
+  recipients: [{ id: "user_1", email: "test@test.com" }],
+  ...properties,
+}));
+
+## Send a notification to the notification center
+
+await client.send({
+  notifId: "notif_123",
+  properties: {
+    recipients: [{ id: "user_1", email: "test@test.com" }],
+    message: "Hello world",
+  },
+});

package/dist/NotifizzClient.d.ts

@@ -0,0 +1,62 @@
+export type TrackProps = {
+    eventName: string;
+    sdkSecretKey: string;
+    properties: {
+        [k: string]: any;
+    };
+};
+type NotifizzOptions = {
+    autoSendDelayMs?: number;
+};
+type EnrichFunction = (properties: {
+    [k: string]: any;
+}) => {
+    recipients: [EventRecipient];
+    [k: string]: any;
+};
+type EventProperties = {
+    notifId: string;
+    properties: {
+        recipients: [EventRecipient];
+        [k: string]: any;
+    };
+};
+type EventRecipient = {
+    id: string;
+    email: string;
+};
+declare class TrackContext {
+    private readonly event;
+    private readonly workflows;
+    private hasSent;
+    private readonly autoSendTimer;
+    private readonly options;
+    private readonly sdkSecretKey;
+    private readonly baseUrl;
+    constructor(event: TrackProps, options: NotifizzOptions, sdkSecretKey: string);
+    workflow(campaignId: string, recipients: {
+        id: string;
+        email: string;
+        [k: string]: any;
+    }[]): this;
+    private send;
+    then(resolve: any, reject: any): Promise<void>;
+}
+export declare class NotifizzClient {
+    private readonly authSecretKey;
+    private readonly sdkSecretKey;
+    private readonly baseUrl;
+    private readonly algorithm;
+    private readonly encoding;
+    private options;
+    static enrichFunctions: Map<string, EnrichFunction[]>;
+    private sha256;
+    constructor(authSecretKey: string, sdkSecretKey: string);
+    generateHashedToken(userId: string): string;
+    static configureEnrich(workflowIds: string | string[], enrichFn: EnrichFunction): void;
+    private static addEnrichmentFunction;
+    track(props: TrackProps): TrackContext;
+    config(opts: Partial<NotifizzOptions>): void;
+    send(request: EventProperties): Promise<any>;
+}
+export {};

package/dist/NotifizzClient.js

@@ -0,0 +1,141 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotifizzClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const defaultOptions = {
+    autoSendDelayMs: 1000,
+};
+class TrackContext {
+    constructor(event, options, sdkSecretKey) {
+        this.workflows = [];
+        this.hasSent = false;
+        this.autoSendTimer = null;
+        this.baseUrl = "http://localhost:6001/v1";
+        this.event = event;
+        this.options = options;
+        this.sdkSecretKey = sdkSecretKey;
+        if (options.autoSendDelayMs !== undefined) {
+            this.autoSendTimer = setTimeout(() => {
+                if (!this.hasSent) {
+                    this.send();
+                }
+            }, options.autoSendDelayMs);
+        }
+    }
+    workflow(campaignId, recipients) {
+        if (this.hasSent)
+            throw new Error("Cannot add workflows after sending the event.");
+        this.workflows.push({ campaignId, recipients });
+        return this;
+    }
+    send() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.hasSent)
+                return;
+            if (this.autoSendTimer)
+                clearTimeout(this.autoSendTimer);
+            this.hasSent = true;
+            const payload = Object.assign(Object.assign({}, this.event), { workflows: this.workflows, sdkSecretKey: this.sdkSecretKey });
+            try {
+                yield axios_1.default.post(`${this.baseUrl}/events/track`, payload, {
+                    headers: {
+                        Authorization: `Bearer ${this.sdkSecretKey}`
+                    }
+                });
+            }
+            catch (e) {
+                console.log('Error', e);
+                throw e;
+            }
+        });
+    }
+    // Optional for promise-like behavior
+    then(resolve, reject) {
+        return this.send().then(resolve, reject);
+    }
+}
+class NotifizzClient {
+    sha256(textToHash) {
+        return node_crypto_1.default.createHash(this.algorithm).update(textToHash).digest(this.encoding);
+    }
+    constructor(authSecretKey, sdkSecretKey) {
+        this.baseUrl = "http://localhost:6001/v1";
+        this.algorithm = 'sha256';
+        this.encoding = 'hex';
+        this.options = Object.assign({}, defaultOptions);
+        this.authSecretKey = authSecretKey;
+        this.sdkSecretKey = sdkSecretKey;
+    }
+    generateHashedToken(userId) {
+        return this.sha256(userId + this.authSecretKey);
+    }
+    static configureEnrich(workflowIds, enrichFn) {
+        if (typeof workflowIds === "string") {
+            this.addEnrichmentFunction(workflowIds, enrichFn);
+        }
+        else {
+            workflowIds.forEach(workflowId => {
+                this.addEnrichmentFunction(workflowId, enrichFn);
+            });
+        }
+    }
+    static addEnrichmentFunction(workflowId, enrichFn) {
+        var _a;
+        if (this.enrichFunctions.has(workflowId)) {
+            (_a = this.enrichFunctions.get(workflowId)) === null || _a === void 0 ? void 0 : _a.push(enrichFn);
+        }
+        else {
+            this.enrichFunctions.set(workflowId, [enrichFn]);
+        }
+    }
+    track(props) {
+        return new TrackContext(props, this.options, this.sdkSecretKey);
+    }
+    config(opts) {
+        this.options = Object.assign(Object.assign({}, this.options), opts);
+    }
+    send(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const _a = request.properties, { recipients } = _a, eventProperties = __rest(_a, ["recipients"]);
+                const { data } = yield axios_1.default.post(`${this.baseUrl}/notification/channel/notificationcenter/config/${request.notifId}/track`, { properties: eventProperties, recipients: recipients }, {
+                    headers: {
+                        Authorization: `Bearer ${this.sdkSecretKey}`
+                    }
+                });
+                return data;
+            }
+            catch (e) {
+                console.log('Error', e);
+                throw e;
+            }
+        });
+    }
+}
+exports.NotifizzClient = NotifizzClient;
+NotifizzClient.enrichFunctions = new Map();
+//# sourceMappingURL=NotifizzClient.js.map

package/dist/NotifizzClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotifizzClient.js","sourceRoot":"","sources":["../src/NotifizzClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,8DAAiC;AAwBjC,MAAM,cAAc,GAAoB;IACtC,eAAe,EAAE,IAAI;CACtB,CAAC;AAeF,MAAM,YAAY;IAWhB,YAAY,KAAiB,EAAE,OAAwB,EAAE,YAAoB;QAT5D,cAAS,GAAsB,EAAE,CAAC;QAC3C,YAAO,GAAG,KAAK,CAAC;QACP,kBAAa,GAA0B,IAAI,CAAC;QAI5C,YAAO,GAAW,0BAA0B,CAAC;QAI5D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QAEjC,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC1C,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;gBACnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,CAAC;YACH,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,UAAkB,EAAE,UAA8D;QACzF,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAEa,IAAI;;YAChB,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO;YACzB,IAAI,IAAI,CAAC,aAAa;gBAAE,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAEzD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YAEpB,MAAM,OAAO,mCACR,IAAI,CAAC,KAAK,KACb,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,YAAY,EAAE,IAAI,CAAC,YAAY,GAChC,CAAC;YACF,IAAI,CAAC;gBACH,MAAM,eAAK,CAAC,IAAI,CACd,GAAG,IAAI,CAAC,OAAO,eAAe,EAAC,OAAO,EACtC;oBACE,OAAO,EAAE;wBACP,aAAa,EAAE,UAAU,IAAI,CAAC,YAAY,EAAE;qBAC7C;iBACF,CACF,CAAC;YACJ,CAAC;YAAA,OAAM,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBACxB,MAAM,CAAC,CAAC;YACV,CAAC;QAGH,CAAC;KAAA;IAED,qCAAqC;IACrC,IAAI,CAAC,OAAY,EAAE,MAAW;QAC5B,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,MAAa,cAAc;IASjB,MAAM,CAAC,UAAkB;QAC/B,OAAO,qBAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpF,CAAC;IAED,YAAY,aAAqB,EAAE,YAAoB;QAVtC,YAAO,GAAW,0BAA0B,CAAC;QAC7C,cAAS,GAAW,QAAQ,CAAC;QAC7B,aAAQ,GAAgC,KAAK,CAAC;QACvD,YAAO,qBAAyB,cAAc,EAAG;QAQvD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,mBAAmB,CAAC,MAAc;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,WAA8B,EAAE,QAAwB;QAC7E,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBAC/B,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,UAAkB,EAAE,QAAwB;;QAC/E,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,MAAA,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAiB;QACrB,OAAO,IAAI,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,IAA8B;QACnC,IAAI,CAAC,OAAO,mCAAQ,IAAI,CAAC,OAAO,GAAK,IAAI,CAAE,CAAC;IAC9C,CAAC;IAEK,IAAI,CAAC,OAAwB;;YACjC,IAAI,CAAC;gBACH,MAAM,KAAqC,OAAO,CAAC,UAAU,EAAvD,EAAE,UAAU,OAA2C,EAAtC,eAAe,cAAhC,cAAkC,CAAqB,CAAA;gBAE7D,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,GAAG,IAAI,CAAC,OAAO,mDAAmD,OAAO,CAAC,OAAO,QAAQ,EACzF,EAAC,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAC,EACrD;oBACE,OAAO,EAAE;wBACP,aAAa,EAAE,UAAU,IAAI,CAAC,YAAY,EAAE;qBAC7C;iBACF,CACF,CAAC;gBACF,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBACxB,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;KAAA;;AAlEH,wCAmEC;AA5DQ,8BAAe,GAAkC,IAAI,GAAG,EAAE,AAA3C,CAA4C"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { NotifizzClient } from "./NotifizzClient";

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotifizzClient = void 0;
+var NotifizzClient_1 = require("./NotifizzClient");
+Object.defineProperty(exports, "NotifizzClient", { enumerable: true, get: function () { return NotifizzClient_1.NotifizzClient; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAAvC,gHAAA,cAAc,OAAA"}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@notifizz/nodejs",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "damiencosset",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "axios": "^1.8.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.2"
+  }
+}

package/src/NotifizzClient.ts

@@ -0,0 +1,175 @@
+import axios from "axios";
+import crypto from "node:crypto";
+
+export type TrackProps = {
+  eventName: string;
+  sdkSecretKey: string;
+  properties: {
+    [k: string]: any;
+  },
+};
+
+type WorkflowContext = {
+  campaignId: string;
+  recipients: { id: string; email: string; [k: string]: any; }[];
+};
+
+type NotifizzOptions = {
+  autoSendDelayMs?: number;
+};
+
+type EnrichFunction = (properties: {[k: string]: any}) => {
+  recipients: [EventRecipient];
+  [k: string]: any;
+};
+
+const defaultOptions: NotifizzOptions = {
+  autoSendDelayMs: 1000,
+};
+
+type EventProperties = {
+  notifId: string;
+  properties: {
+    recipients: [EventRecipient];
+    [k: string]: any;
+  },
+}
+
+type EventRecipient = {
+  id: string,
+  email: string,
+}
+
+class TrackContext {
+  private readonly event: TrackProps;
+  private readonly workflows: WorkflowContext[] = [];
+  private hasSent = false;
+  private readonly autoSendTimer: NodeJS.Timeout | null = null;
+  private readonly options: NotifizzOptions;
+  private readonly sdkSecretKey: string;
+
+  private readonly baseUrl: string = "http://localhost:6001/v1";
+
+
+  constructor(event: TrackProps, options: NotifizzOptions, sdkSecretKey: string) {
+    this.event = event;
+    this.options = options;
+    this.sdkSecretKey = sdkSecretKey;
+
+    if (options.autoSendDelayMs !== undefined) {
+      this.autoSendTimer = setTimeout(() => {
+        if (!this.hasSent) {
+          this.send();
+        }
+      }, options.autoSendDelayMs);
+    }
+  }
+
+  workflow(campaignId: string, recipients: { id: string; email: string; [k: string]: any; }[]) {
+    if (this.hasSent) throw new Error("Cannot add workflows after sending the event.");
+    this.workflows.push({ campaignId, recipients });
+    return this;
+  }
+
+  private async send() {
+    if (this.hasSent) return;
+    if (this.autoSendTimer) clearTimeout(this.autoSendTimer);
+
+    this.hasSent = true;
+
+    const payload = {
+      ...this.event,
+      workflows: this.workflows,
+      sdkSecretKey: this.sdkSecretKey,
+    };
+    try {
+      await axios.post(
+        `${this.baseUrl}/events/track`,payload,
+        {
+          headers: {
+            Authorization: `Bearer ${this.sdkSecretKey}`
+          }
+        }
+      );
+    }catch(e) {
+      console.log('Error', e);
+      throw e;
+    }
+
+
+  }
+
+  // Optional for promise-like behavior
+  then(resolve: any, reject: any) {
+    return this.send().then(resolve, reject);
+  }
+}
+
+export class NotifizzClient {
+  private readonly authSecretKey: string;
+  private readonly sdkSecretKey: string;
+  private readonly baseUrl: string = "http://localhost:6001/v1";
+  private readonly algorithm: string = 'sha256';
+  private readonly encoding: crypto.BinaryToTextEncoding = 'hex';
+  private options: NotifizzOptions = { ...defaultOptions };
+  static enrichFunctions: Map<string, EnrichFunction[]> = new Map();
+
+  private sha256(textToHash: string): string {
+    return crypto.createHash(this.algorithm).update(textToHash).digest(this.encoding);
+  }
+
+  constructor(authSecretKey: string, sdkSecretKey: string) {
+    this.authSecretKey = authSecretKey;
+    this.sdkSecretKey = sdkSecretKey;
+  }
+
+  generateHashedToken(userId: string): string{
+    return this.sha256(userId + this.authSecretKey)
+  }
+
+  static configureEnrich(workflowIds: string | string[], enrichFn: EnrichFunction) {
+    if (typeof workflowIds === "string") {
+      this.addEnrichmentFunction(workflowIds, enrichFn);
+    } else {
+      workflowIds.forEach(workflowId => {
+        this.addEnrichmentFunction(workflowId, enrichFn);
+      });
+    }
+  }
+
+  private static addEnrichmentFunction(workflowId: string, enrichFn: EnrichFunction) {
+    if (this.enrichFunctions.has(workflowId)) {
+      this.enrichFunctions.get(workflowId)?.push(enrichFn);
+    } else {
+      this.enrichFunctions.set(workflowId, [enrichFn]);
+    }
+  }
+
+  track(props: TrackProps): TrackContext {
+    return new TrackContext(props, this.options, this.sdkSecretKey);
+  }
+
+  config(opts: Partial<NotifizzOptions>) {
+    this.options = { ...this.options, ...opts };
+  }
+
+  async send(request: EventProperties) {
+    try {
+      const { recipients, ...eventProperties } = request.properties
+
+      const { data } = await axios.post(
+        `${this.baseUrl}/notification/channel/notificationcenter/config/${request.notifId}/track`,
+        {properties: eventProperties, recipients: recipients},
+        {
+          headers: {
+            Authorization: `Bearer ${this.sdkSecretKey}`
+          }
+        }
+      );
+      return data;
+    } catch (e) {
+      console.log('Error', e);
+      throw e;
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export {NotifizzClient} from "./NotifizzClient"

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "outDir": "dist",
+        "module": "CommonJS",
+        "target": "ES6",
+        "declaration": true,
+        "sourceMap": true,
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true
+    },
+    "include": ["src"],
+    "exclude": ["node_modules", "dist"]
+}