@koloseum/utils 0.1.15 → 0.1.17

package/dist/utils.d.ts

@@ -1,10 +1,22 @@
 import type { Database } from "@koloseum/types/database";
-import type { CustomError, Microservice, MicroserviceGroup, MicroserviceObject } from "@koloseum/types/general";
+import type { CustomError, Microservice, MicroserviceGroup, MicroserviceObject, UserWithAppMetadata } 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 { suprsend } from "@suprsend/node-sdk";
 import type { IOptions } from "@suprsend/web-components/dist/types/interface.d.ts";
 import type { MobilePhoneLocale } from "validator";
+export declare const Data: {
+    /**
+     * A generic authenticated user.
+     * @param {string} id - The user ID; defaults to a random UUID
+     * @param {Date} date - The date and time; defaults to the current date and time
+     * @param {string} phone - The phone number; defaults to a generic Kenyan phone number
+     * @param {string} identityId - A default identity ID; defaults to a random UUID
+     * @returns A generic authenticated user.
+     */
+    authenticatedUser: (id?: string, date?: Date, phone?: string, identityId?: string) => UserWithAppMetadata;
+};
 export declare const Status: {
     /**
      * A generic error message.
@@ -173,4 +185,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,9 +1,67 @@
+import { v4 as uuidv4 } from "uuid";
 import { error as svelteError } from "@sveltejs/kit";
 import { FunctionsFetchError, FunctionsHttpError, FunctionsRelayError } from "@supabase/supabase-js";
 import sanitize from "sanitize-html";
 import validator from "validator";
 /* Helper functions */
 const { isMobilePhone, isURL } = validator;
+/* Dummy data */
+export const Data = {
+    /**
+     * A generic authenticated user.
+     * @param {string} id - The user ID; defaults to a random UUID
+     * @param {Date} date - The date and time; defaults to the current date and time
+     * @param {string} phone - The phone number; defaults to a generic Kenyan phone number
+     * @param {string} identityId - A default identity ID; defaults to a random UUID
+     * @returns A generic authenticated user.
+     */
+    authenticatedUser: (id = uuidv4(), date = new Date(), phone = "254111222333", identityId = uuidv4()) => {
+        // Convert date to ISO string
+        const time = date.toISOString();
+        // User data
+        return {
+            id,
+            aud: "authenticated",
+            role: "authenticated",
+            email: "",
+            phone,
+            phone_confirmed_at: time,
+            confirmation_sent_at: time,
+            confirmed_at: time,
+            last_sign_in_at: time,
+            app_metadata: {
+                person_data: { first_name: "John", last_name: "Test", pseudonym: "JDtest" },
+                provider: "phone",
+                providers: ["phone"],
+                roles: ["player", "backroom_superuser"]
+            },
+            user_metadata: {
+                email_verified: false,
+                phone_verified: false,
+                sub: id
+            },
+            identities: [
+                {
+                    identity_id: identityId,
+                    id,
+                    user_id: id,
+                    identity_data: {
+                        email_verified: false,
+                        phone_verified: false,
+                        sub: id
+                    },
+                    provider: "phone",
+                    last_sign_in_at: time,
+                    created_at: time,
+                    updated_at: time
+                }
+            ],
+            created_at: time,
+            updated_at: time,
+            is_anonymous: false
+        };
+    }
+};
 /* Status messages */
 export const Status = {
     /**
@@ -690,5 +748,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.15",
+	"version": "0.1.17",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -37,8 +37,10 @@
 	"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/uuid": "^10.0.0",
 		"@types/validator": "^13.12.2",
 		"prettier": "^3.5.1",
 		"typescript": "^5.0.0",