@koloseum/utils 0.1.10 → 0.1.12

package/dist/utils.d.ts

@@ -1,7 +1,10 @@
-import type { CustomError } 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 { SubscriberResponseDto } from "@novu/api/models/components/subscriberresponsedto.js";
 import type { PostgrestError } from "@supabase/supabase-js";
+import type { Page } from "@sveltejs/kit";
 import type { MobilePhoneLocale } from "validator";
+import { Novu } from "@novu/api";
 export declare const Status: {
     /**
      * A generic error message.
@@ -55,6 +58,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
@@ -73,10 +83,28 @@ export declare const Utility: {
      * - begins with "KL" followed by 7 digits
      */
     loungeIdRegex: RegExp;
+    /**
+     * A reference of microservices available on the platform, represented as an object with each user group (i.e. `public`, `players`, `lounges`, and `backroom`) having its own array of microservices. Each microservice in a list is an object with the following properties:
+     * - `name`: The name of the microservice.
+     * - `description`: A description of the microservice.
+     * - `slug`: The slug of the microservice.
+     * - `features`: An array of features that the microservice has.
+     * - `roles`: An array of roles attached to the microservice.
+     */
+    microservices: { [key in MicroserviceGroup]: MicroserviceObject<key>[]; };
     /**
      * The minimum birth date (from today's date) for a user who is a minor, i.e. `YYYY-MM-DD`
      */
     minimumMinorBirthDate: string;
+    /**
+     * Check if a page is active based on the slug and microservice.
+     * @param page - The current page object.
+     * @param slug - The slug of the page to check.
+     * @param microservice - The microservice to check against.
+     * @param base - The base path of the application; defaults to an empty string.
+     * @returns `true` if the page is active, `false` otherwise.
+     */
+    pageIsActive: (page: Page, slug: string, microservice?: Microservice<MicroserviceGroup>, base?: string) => boolean;
     /**
      * Parses a `CustomError` object within a page/layout server load function and returns an error to be thrown.
      * @param {CustomError} error - The error object

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
@@ -170,6 +213,187 @@ export const Utility = {
      * - begins with "KL" followed by 7 digits
      */
     loungeIdRegex: /^KL\d{7}$/,
+    /**
+     * A reference of microservices available on the platform, represented as an object with each user group (i.e. `public`, `players`, `lounges`, and `backroom`) having its own array of microservices. Each microservice in a list is an object with the following properties:
+     * - `name`: The name of the microservice.
+     * - `description`: A description of the microservice.
+     * - `slug`: The slug of the microservice.
+     * - `features`: An array of features that the microservice has.
+     * - `roles`: An array of roles attached to the microservice.
+     */
+    microservices: {
+        backroom: [
+            {
+                name: "Compliance",
+                description: "Management of compliance and regulatory requirements for Players and Lounges.",
+                slug: "compliance",
+                features: [
+                    {
+                        name: "Players",
+                        description: "Manage Player data.",
+                        slug: "players"
+                    },
+                    {
+                        name: "Lounges",
+                        description: "Manage Lounge data.",
+                        slug: "lounges"
+                    }
+                ],
+                roles: [
+                    {
+                        name: "Compliance",
+                        slug: "compliance",
+                        root: true
+                    },
+                    {
+                        name: "Players",
+                        slug: "players",
+                        featureSlugs: ["players"]
+                    },
+                    {
+                        name: "Lounges",
+                        slug: "lounges",
+                        featureSlugs: ["lounges"]
+                    }
+                ]
+            },
+            {
+                name: "Competitions",
+                description: "Management of competitions data and live events across Markets.",
+                slug: "competitions",
+                features: [
+                    {
+                        name: "Ma Esto",
+                        description: "Manage football esports data for Ma Esto.",
+                        slug: "fbl"
+                    },
+                    {
+                        name: "Savanna FGC",
+                        description: "Manage fighting games esports data for Savanna FGC.",
+                        slug: "fgc"
+                    },
+                    {
+                        name: "Hit List",
+                        description: "Manage battle royale esports data for Hit List.",
+                        slug: "bryl"
+                    }
+                ],
+                roles: [
+                    {
+                        name: "Competitions",
+                        slug: "competitions",
+                        root: true
+                    },
+                    {
+                        name: "Ma Esto",
+                        slug: "fbl",
+                        featureSlugs: ["fbl"]
+                    },
+                    {
+                        name: "Savanna FGC",
+                        slug: "fgc",
+                        featureSlugs: ["fgc"]
+                    },
+                    {
+                        name: "Hit List",
+                        slug: "bryl",
+                        featureSlugs: ["bryl"]
+                    }
+                ]
+            },
+            {
+                name: "KLSM",
+                description: "Management of store products and tracking of orders and payments.",
+                slug: "commerce",
+                features: [
+                    {
+                        name: "Sections",
+                        description: "Manage store sections.",
+                        slug: "sections"
+                    },
+                    {
+                        name: "Products",
+                        description: "Manage store products.",
+                        slug: "products"
+                    },
+                    {
+                        name: "Bundles",
+                        description: "Manage store bundles.",
+                        slug: "bundles"
+                    },
+                    {
+                        name: "Inventory",
+                        description: "Manage store inventory.",
+                        slug: "inventory"
+                    },
+                    {
+                        name: "Orders",
+                        description: "Manage store orders.",
+                        slug: "orders"
+                    }
+                ],
+                roles: [
+                    {
+                        name: "Commerce",
+                        slug: "commerce",
+                        root: true
+                    },
+                    {
+                        name: "Storefront",
+                        slug: "storefront",
+                        featureSlugs: ["sections", "products", "bundles"]
+                    },
+                    {
+                        name: "Warehouse",
+                        slug: "warehouse",
+                        featureSlugs: ["inventory", "orders"]
+                    }
+                ]
+            },
+            {
+                name: "Staff",
+                description: "Management of staff authorisation.",
+                slug: "staff",
+                features: [
+                    {
+                        name: "Roles",
+                        description: "Review and manage Backroom roles.",
+                        slug: "roles"
+                    },
+                    {
+                        name: "Users",
+                        description: "Review and manage Backroom users.",
+                        slug: "users"
+                    }
+                ],
+                roles: [
+                    {
+                        name: "Human Resources",
+                        slug: "hr",
+                        root: true
+                    }
+                ]
+            },
+            {
+                name: "Account",
+                description: "Review of access and notifications.",
+                slug: "account",
+                features: [
+                    {
+                        name: "Access",
+                        description: "Review access to Backroom microservices.",
+                        slug: "access"
+                    },
+                    {
+                        name: "Notifications",
+                        description: "Review and manage Backroom notifications.",
+                        slug: "notifications"
+                    }
+                ],
+                roles: null
+            }
+        ]
+    },
     /**
      * The minimum birth date (from today's date) for a user who is a minor, i.e. `YYYY-MM-DD`
      */
@@ -181,6 +405,15 @@ export const Utility = {
         tomorrow.setFullYear(tomorrow18YearsAgo);
         return tomorrow.toISOString().split("T")[0];
     })(),
+    /**
+     * Check if a page is active based on the slug and microservice.
+     * @param page - The current page object.
+     * @param slug - The slug of the page to check.
+     * @param microservice - The microservice to check against.
+     * @param base - The base path of the application; defaults to an empty string.
+     * @returns `true` if the page is active, `false` otherwise.
+     */
+    pageIsActive: (page, slug, microservice, base = "") => slug === microservice || page.url.pathname.startsWith(`${base === "." ? "" : base}/${slug}`),
     /**
      * Parses a `CustomError` object within a page/layout server load function and returns an error to be thrown.
      * @param {CustomError} error - The error object

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.1.10",
+	"version": "0.1.12",
 	"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.12",
 		"@playwright/test": "^1.50.1",
 		"@types/sanitize-html": "^2.13.0",
 		"@types/validator": "^13.12.2",