@koloseum/utils 0.1.10 → 0.1.11

package/dist/utils.d.ts

@@ -1,7 +1,9 @@
-import type { CustomError } from "@koloseum/types/general";
+import type { CustomError, UserWithAppMetadata } from "@koloseum/types/general";
 import type { PronounsCheckboxes, SocialMediaPlatform } from "@koloseum/types/public-auth";
+import type { SubscriberResponseDto } from "@novu/api/models/components/subscriberresponsedto.js";
 import type { PostgrestError } from "@supabase/supabase-js";
 import type { MobilePhoneLocale } from "validator";
+import { Novu } from "@novu/api";
 export declare const Status: {
     /**
      * A generic error message.
@@ -55,6 +57,13 @@ export declare const Utility: {
      * @returns The age in years, or `NaN` if the input is invalid
      */
     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.
+     */
+    getNovuSubscriber: (novu: Novu, user: UserWithAppMetadata | null) => Promise<SubscriberResponseDto | null>;
     /**
      * Handles the click event for pronouns checkboxes.
      * @param {MouseEvent} e - The click event

package/dist/utils.js

@@ -1,4 +1,5 @@
 import { error as svelteError } from "@sveltejs/kit";
+import { ErrorDto } from "@novu/api/models/errors/errordto.js";
 import sanitize from "sanitize-html";
 import validator from "validator";
 /* Helper functions */
@@ -108,6 +109,48 @@ export const Utility = {
         const monthDiff = currentDate.getMonth() - birthDate.getMonth();
         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.
+     */
+    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
+                ({ result: subscriber } = await novu.subscribers.create({
+                    subscriberId: user.id,
+                    firstName,
+                    lastName,
+                    phone: user.phone,
+                    timezone: "Africa/Nairobi",
+                    locale: "en_KE",
+                    data: { pseudonym }
+                }));
+            }
+            // Otherwise, log error
+            else
+                console.error(error);
+        }
+        // Return subscriber
+        return subscriber;
+    },
     /**
      * Handles the click event for pronouns checkboxes.
      * @param {MouseEvent} e - The click event

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.1.10",
+	"version": "0.1.11",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -29,13 +29,14 @@
 		"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",
 		"validator": "^13.12.0"
 	},
 	"devDependencies": {
-		"@koloseum/types": "^0.1.9",
+		"@koloseum/types": "^0.1.11",
 		"@playwright/test": "^1.50.1",
 		"@types/sanitize-html": "^2.13.0",
 		"@types/validator": "^13.12.2",