@koloseum/utils 0.1.11 → 0.1.13

package/dist/utils.d.ts

@@ -1,7 +1,9 @@
-import type { CustomError, UserWithAppMetadata } from "@koloseum/types/general";
+import type { Database } from "@koloseum/types/database";
+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 { 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: {
@@ -19,6 +21,20 @@ export declare const Status: {
     PASSWORD_RESET_REQUESTED: string;
 };
 export declare const Utility: {
+    /**
+     * Calls a Supabase Edge function.
+     * @param {boolean} browser - Whether the function is being called in the browser
+     * @param {SupabaseClient} supabase - The Supabase client
+     * @param {string} path - The path to the Edge function
+     * @param {"GET" | "POST"} [method="GET"] - The HTTP method to use
+     * @returns The response from the Edge function
+     */
+    callEdgeFunction: (browser: boolean, supabase: SupabaseClient<Database>, path: string, method?: "GET" | "POST") => Promise<{
+        code: number;
+        data?: any;
+        error?: string;
+        context?: Record<string, any>;
+    }>;
     /**
      * Capitalises a given word.
      * @param {string} word - The word to be capitalised
@@ -82,10 +98,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 { 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";
@@ -21,6 +22,76 @@ export const Status = {
 };
 /* Utility functions */
 export const Utility = {
+    /**
+     * Calls a Supabase Edge function.
+     * @param {boolean} browser - Whether the function is being called in the browser
+     * @param {SupabaseClient} supabase - The Supabase client
+     * @param {string} path - The path to the Edge function
+     * @param {"GET" | "POST"} [method="GET"] - The HTTP method to use
+     * @returns The response from the Edge function
+     */
+    callEdgeFunction: async (browser, supabase, path, method = "GET") => {
+        try {
+            // Set up headers with safe origin handling for SSR
+            const headers = {
+                "Content-Type": "application/json",
+                Accept: "application/json"
+            };
+            // Only add Origin header in browser environment
+            if (browser)
+                headers["Origin"] = window.location.origin;
+            // Fetch response with additional options for better cross-origin handling
+            const { data, error } = await supabase.functions.invoke(path, {
+                method,
+                headers
+            });
+            // Handle different error types
+            if (error) {
+                // Define context
+                const context = {};
+                // Define error code and message
+                const code = Number(error.context.status) || 500;
+                let message = Status.ERROR;
+                // Handle HTTP errors
+                if (error instanceof FunctionsHttpError) {
+                    // Get error data
+                    try {
+                        // Get content type header
+                        const contentType = error.context.headers.get("content-type");
+                        // If content type is JSON, get error data
+                        if (contentType.includes("application/json")) {
+                            // Get error data
+                            const data = await error.context.json();
+                            // Assign error message
+                            message = data.message;
+                        }
+                        // If content type is plain text, get error message
+                        else if (contentType.includes("text/plain"))
+                            message = await error.context.text();
+                        // If any other content type, use the status text
+                        else
+                            message = error.context.statusText;
+                        // Assign attempt ID to context if present
+                        if (path.includes("verify-id") && data.attemptId)
+                            context.attemptId = data.attemptId;
+                    }
+                    catch (error) {
+                        console.error(error);
+                    }
+                }
+                // Handle relay and fetch errors
+                else if (error instanceof FunctionsRelayError || error instanceof FunctionsFetchError)
+                    message = error.message;
+                // Return error
+                return { code: code, error: message, context };
+            }
+            // Return response
+            return { code: 200, data };
+        }
+        catch (_err) {
+            return { code: 500, error: Status.ERROR };
+        }
+    },
     /**
      * Capitalises a given word.
      * @param {string} word - The word to be capitalised
@@ -134,15 +205,20 @@ export const Utility = {
                 // 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 }
-                }));
+                try {
+                    ({ result: subscriber } = await novu.subscribers.create({
+                        subscriberId: user.id,
+                        firstName,
+                        lastName,
+                        phone: user.phone,
+                        timezone: "Africa/Nairobi",
+                        locale: "en_KE",
+                        data: { pseudonym }
+                    }));
+                }
+                catch (error) {
+                    console.error(error);
+                }
             }
             // Otherwise, log error
             else
@@ -213,6 +289,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`
      */
@@ -224,6 +481,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.11",
+	"version": "0.1.13",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -36,7 +36,7 @@
 		"validator": "^13.12.0"
 	},
 	"devDependencies": {
-		"@koloseum/types": "^0.1.11",
+		"@koloseum/types": "^0.1.12",
 		"@playwright/test": "^1.50.1",
 		"@types/sanitize-html": "^2.13.0",
 		"@types/validator": "^13.12.2",