@koloseum/utils 0.1.14 → 0.1.16

package/dist/utils.d.ts

@@ -1,11 +1,11 @@
 import type { Database } from "@koloseum/types/database";
-import type { CustomError, Microservice, MicroserviceGroup, MicroserviceObject, UserWithAppMetadata } from "@koloseum/types/general";
+import type { CustomError, Microservice, MicroserviceGroup, MicroserviceObject } from "@koloseum/types/general";
 import type { PronounsCheckboxes, SocialMediaPlatform } from "@koloseum/types/public-auth";
 import type { Page } from "@sveltejs/kit";
 import type { SupabaseClient, PostgrestError } from "@supabase/supabase-js";
-import type { SubscriberResponseDto } from "@novu/api/models/components/subscriberresponsedto.js";
+import type { suprsend } from "@suprsend/node-sdk";
+import type { IOptions } from "@suprsend/web-components/dist/types/interface.d.ts";
 import type { MobilePhoneLocale } from "validator";
-import { Novu } from "@novu/api";
 export declare const Status: {
     /**
      * A generic error message.
@@ -74,12 +74,12 @@ export declare const Utility: {
      */
     getAge: (dateOfBirth: string) => number;
     /**
-     * Get a Novu subscriber.
-     * @param novu - The Novu client.
-     * @param user - The user object.
-     * @returns The subscriber object or `null` if no Novu client or user is provided.
+     * Generate a SuprSend configuration object for a user.
+     * @param {string} userId - The user ID to generate the configuration for.
+     * @param {string} publicApiKey - The public API key to use for SuprSend.
+     * @returns The SuprSend configuration object.
      */
-    getNovuSubscriber: (novu: Novu, user: UserWithAppMetadata | null) => Promise<SubscriberResponseDto | null>;
+    getSuprSendConfig: (userId: string, publicApiKey: string) => IOptions;
     /**
      * Handles the click event for pronouns checkboxes.
      * @param {MouseEvent} e - The click event
@@ -174,4 +174,20 @@ export declare const Utility: {
      * @returns `true` if the handle is valid; `false` otherwise
      */
     validateSocialMediaHandle: (handle: string) => boolean;
+    /**
+     * Validates a SuprSend subscriber. If the subscriber does not exist, it will be created with the provided person data.
+     * @param {suprsend.Suprsend} suprSend - The SuprSend instance.
+     * @param {string} userId - The user ID.
+     * @param {Object} personData - The person data; required if the subscriber does not exist.
+     * @returns {Promise<{ error?: CustomError; success?: true }>} A promise that resolves to an object with an error if the subscriber validation fails, or indicating success otherwise.
+     */
+    validateSuprSendSubscriber: (suprSend: suprsend.Suprsend, userId: string, personData?: {
+        firstName: string;
+        lastName: string;
+        phone: string;
+        pseudonym?: string;
+    }) => Promise<{
+        error?: CustomError;
+        success?: true;
+    }>;
 };

package/dist/utils.js

@@ -1,6 +1,5 @@
 import { error as svelteError } from "@sveltejs/kit";
 import { FunctionsFetchError, FunctionsHttpError, FunctionsRelayError } from "@supabase/supabase-js";
-import { ErrorDto } from "@novu/api/models/errors/errordto.js";
 import sanitize from "sanitize-html";
 import validator from "validator";
 /* Helper functions */
@@ -181,52 +180,148 @@ export const Utility = {
         return monthDiff < 0 || (monthDiff === 0 && currentDate.getDate() < birthDate.getDate()) ? --age : age;
     },
     /**
-     * Get a Novu subscriber.
-     * @param novu - The Novu client.
-     * @param user - The user object.
-     * @returns The subscriber object or `null` if no Novu client or user is provided.
+     * Generate a SuprSend configuration object for a user.
+     * @param {string} userId - The user ID to generate the configuration for.
+     * @param {string} publicApiKey - The public API key to use for SuprSend.
+     * @returns The SuprSend configuration object.
      */
-    getNovuSubscriber: async (novu, user) => {
-        // Initialise subscriber as null
-        let subscriber = null;
-        // Return null if no Novu client or user is provided
-        if (!novu || !user)
-            return subscriber;
-        // Return null if no person data is provided
-        if (!user.app_metadata.person_data)
-            return subscriber;
-        try {
-            // Get subscriber
-            ({ result: subscriber } = await novu.subscribers.retrieve(user.id));
-        }
-        catch (error) {
-            // Create subscriber if not found
-            if (error instanceof ErrorDto && error.statusCode === 404 && user.app_metadata.person_data) {
-                // Get person data from user metadata
-                const { first_name: firstName, last_name: lastName, pseudonym } = user.app_metadata.person_data;
-                // Create subscriber
-                try {
-                    ({ result: subscriber } = await novu.subscribers.create({
-                        subscriberId: user.id,
-                        firstName,
-                        lastName,
-                        phone: user.phone,
-                        timezone: "Africa/Nairobi",
-                        locale: "en_KE",
-                        data: { pseudonym }
-                    }));
+    getSuprSendConfig: (userId, publicApiKey) => ({
+        distinctId: userId,
+        publicApiKey,
+        inbox: {
+            stores: [
+                { storeId: "all", label: "Inbox", query: { archived: false } },
+                { storeId: "archived", label: "Archived", query: { archived: true } }
+            ],
+            theme: {
+                bell: {
+                    color: "var(--color-accent)"
+                },
+                badge: {
+                    backgroundColor: "var(--color-primary)",
+                    color: "var(--color-primary-content)"
+                },
+                header: {
+                    container: {
+                        backgroundColor: "var(--color-base-100)",
+                        borderColor: "var(--color-base-200)"
+                    },
+                    headerText: {
+                        color: "var(--color-neutral)"
+                    },
+                    markAllReadText: {
+                        color: "var(--color-accent)"
+                    }
+                },
+                tabs: {
+                    color: "var(--color-primary)",
+                    unselectedColor: "var(--color-accent)",
+                    bottomColor: "var(--color-primary)",
+                    badgeColor: "var(--color-base-200)",
+                    badgeText: "var(--color-accent)"
+                },
+                notificationsContainer: {
+                    container: {
+                        backgroundColor: "var(--color-base-100)",
+                        borderColor: "var(--color-base-200)",
+                        height: "75vh",
+                        marginTop: "0.75rem"
+                    },
+                    noNotificationsText: {
+                        color: "var(--color-warning)"
+                    },
+                    noNotificationsSubtext: {
+                        color: "var(--color-neutral)"
+                    },
+                    loader: {
+                        color: "var(--color-primary)"
+                    }
+                },
+                notification: {
+                    container: {
+                        borderColor: "var(--color-base-200)",
+                        readBackgroundColor: "var(--color-base-100)",
+                        unreadBackgroundColor: "var(--color-base-150)",
+                        hoverBackgroundColor: "var(--color-base-200)"
+                    },
+                    headerText: {
+                        color: "var(--color-secondary)"
+                    },
+                    bodyText: {
+                        color: "var(--color-neutral)",
+                        linkColor: "var(--color-secondary)"
+                    },
+                    unseenDot: {
+                        backgroundColor: "var(--color-warning)"
+                    },
+                    createdOnText: {
+                        color: "var(--color-accent)"
+                    },
+                    subtext: {
+                        color: "var(--color-neutral)"
+                    },
+                    expiresText: {
+                        color: "var(--color-warning)",
+                        expiringBackgroundColor: "var(--color-warning)",
+                        expiringColor: "var(--color-neutral)"
+                    },
+                    actions: [
+                        {
+                            text: {
+                                color: "var(--color-primary-content)"
+                            },
+                            container: {
+                                backgroundColor: "var(--color-primary)",
+                                hoverBackgroundColor: "var(--color-secondary)",
+                                border: "unset"
+                            }
+                        },
+                        {
+                            text: {
+                                color: "var(--color-primary-content)"
+                            },
+                            container: {
+                                backgroundColor: "var(--color-primary)",
+                                hoverBackgroundColor: "var(--color-secondary)",
+                                border: "unset"
+                            }
+                        }
+                    ],
+                    actionsMenuIcon: {
+                        hoverBackgroundColor: "var(--color-base-200)",
+                        color: "var(--color-neutral)"
+                    },
+                    actionsMenu: {
+                        backgroundColor: "var(--color-base-100)",
+                        borderColor: "var(--color-base-200)"
+                    },
+                    actionsMenuItem: {
+                        hoverBackgroundColor: "var(--color-base-200)"
+                    },
+                    actionsMenuItemIcon: {
+                        color: "var(--color-accent)"
+                    },
+                    actionsMenuItemText: {
+                        color: "var(--color-neutral)"
+                    }
                 }
-                catch (error) {
-                    console.error(error);
+            }
+        },
+        toast: {
+            theme: {
+                container: {
+                    backgroundColor: "var(--color-base-100)",
+                    borderColor: "var(--color-base-200)"
+                },
+                headerText: {
+                    color: "var(--color-primary)"
+                },
+                bodyText: {
+                    color: "var(--color-neutral)"
                 }
             }
-            // Otherwise, log error
-            else
-                console.error(error);
         }
-        // Return subscriber
-        return subscriber;
-    },
+    }),
     /**
      * Handles the click event for pronouns checkboxes.
      * @param {MouseEvent} e - The click event
@@ -595,5 +690,43 @@ export const Utility = {
      */
     validateSocialMediaHandle: (handle) => !isURL(handle, { require_protocol: false }) &&
         !handle.startsWith("@") &&
-        Boolean(handle.match(Utility.socialMediaHandleRegex))
+        Boolean(handle.match(Utility.socialMediaHandleRegex)),
+    /**
+     * Validates a SuprSend subscriber. If the subscriber does not exist, it will be created with the provided person data.
+     * @param {suprsend.Suprsend} suprSend - The SuprSend instance.
+     * @param {string} userId - The user ID.
+     * @param {Object} personData - The person data; required if the subscriber does not exist.
+     * @returns {Promise<{ error?: CustomError; success?: true }>} A promise that resolves to an object with an error if the subscriber validation fails, or indicating success otherwise.
+     */
+    validateSuprSendSubscriber: async (suprSend, userId, personData) => {
+        // Check if subscriber exists
+        try {
+            await suprSend.users.get(userId);
+        }
+        catch (_err) {
+            // If person data is not provided, return an error
+            if (!personData)
+                return { error: Utility.customError(400, "Person data is required to create a SuprSend subscriber.") };
+            // Destructure person data
+            const { firstName, lastName, phone, pseudonym } = personData;
+            // Create subscriber
+            const subscriber = suprSend.user.get_instance(userId);
+            if (!subscriber)
+                return { error: Utility.customError(500, Status.ERROR) };
+            // Set subscriber details
+            subscriber.set_preferred_language("en");
+            subscriber.set_timezone("Africa/Nairobi");
+            subscriber.set("firstName", firstName);
+            subscriber.set("lastName", lastName);
+            subscriber.set("phone", `+${phone}`);
+            if (pseudonym)
+                subscriber.set("pseudonym", pseudonym);
+            // Save subscriber
+            const response = await subscriber.save();
+            if (!response.success)
+                return { error: Utility.customError(500, Status.ERROR) };
+        }
+        // Return success
+        return { success: true };
+    }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.1.14",
+	"version": "0.1.16",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -29,7 +29,6 @@
 		"test": "vitest --run"
 	},
 	"dependencies": {
-		"@novu/api": "^0.6.1",
 		"@supabase/supabase-js": "^2.48.1",
 		"@sveltejs/kit": "^2.17.1",
 		"sanitize-html": "^2.14.0",
@@ -38,6 +37,8 @@
 	"devDependencies": {
 		"@koloseum/types": "^0.1.12",
 		"@playwright/test": "^1.50.1",
+		"@suprsend/node-sdk": "^1.13.0",
+		"@suprsend/web-components": "^0.2.1",
 		"@types/sanitize-html": "^2.13.0",
 		"@types/validator": "^13.12.2",
 		"prettier": "^3.5.1",