@koloseum/utils 0.3.2 → 0.3.4

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import type { BrowserInfo, Microservice, MicroserviceFeature, MicroserviceGroup, MicroserviceObject, MicroserviceRole, UserWithCustomMetadata } from "@koloseum/types/general";
-import type { PronounsCheckboxes } from "@koloseum/types/public-auth";
+import type { PronounsCheckboxes } from "@koloseum/types/public/auth";
 import type { IOptions } from "@suprsend/web-components/dist/types/interface.d.ts";
 import type { Page, SubmitFunction } from "@sveltejs/kit";
 export declare const Browser: {
@@ -128,4 +128,15 @@ export declare const Interface: {
      * @returns `true` if the page is active, `false` otherwise.
      */
     pageIsActive: (page: Page, slug: string | undefined, microservice?: Microservice<MicroserviceGroup>, base?: string) => boolean;
+    /**
+     * Resolves a path and returns the result.
+     * Wraps around the `resolve` function in SvelteKit's `$app/paths` module.
+     *
+     * https://svelte.dev/docs/kit/$app-paths#resolve
+     *
+     * @param path - The path to resolve
+     * @param params - The parameters to resolve the path with
+     * @returns {string} The resolved path without the leading dot
+     */
+    resolvePath: (path: string, params?: Record<string, string>) => Promise<string>;
 };

package/dist/client.js

@@ -117,7 +117,7 @@ export const Browser = {
         if (typeof window === "undefined")
             return {
                 title: "Browser compatibility issue",
-                message: "Browser detection is not available on theserver.",
+                message: "Browser detection is not available on the server.",
                 recommendations: [],
                 critical: false
             };
@@ -309,18 +309,21 @@ export const Access = {
             .map(({ roles }) => roles)
             .flat();
         let slugs;
-        // Check if the user's role is a top-level microservice role
+        // Check if the user's role is a sub-role of a microservice
+        // Check sub-roles before root roles so that when the same slug appears in multiple microservices
+        // (e.g. "Manager" in Operations with `root` and in Account with `featureSlugs`), we return
+        // the most restrictive definition and avoid granting root where a scoped role was intended.
+        const subRoles = roles.filter((role) => role !== null && !("root" in role)).filter((role) => role !== null);
+        slugs = subRoles.map((role) => role.slug);
+        if (slugs.includes(role))
+            return subRoles.find(({ slug }) => slug === role);
+        // Check if the user's role is a top-level microservice role (root)
         const topLevelRoles = roles
             .filter((role) => role !== null && "root" in role && !("superuser" in role) && role.root === true)
             .filter((role) => role !== null);
         slugs = topLevelRoles.map((role) => role.slug);
         if (slugs.includes(role))
             return topLevelRoles.find(({ slug }) => slug === role);
-        // Check if the user's role is a sub-role of a microservice
-        const subRoles = roles.filter((role) => role !== null && !("root" in role)).filter((role) => role !== null);
-        slugs = subRoles.map((role) => role.slug);
-        if (slugs.includes(role))
-            return subRoles.find(({ slug }) => slug === role);
         // Return null
         return null;
     },
@@ -393,50 +396,34 @@ export const Access = {
         // Return true if the role is superuser
         if ("superuser" in role && role.superuser === true)
             return true;
-        /* LOUNGES */
+        // Define helpers
+        const featureMatches = (f) => "slug" in f && f.slug ? f.slug === feature.slug : feature.slug === undefined;
+        const isRootFeature = feature.slug === undefined;
+        const roleHasFeature = (r) => isRootFeature ||
+            ("root" in r && r.root === true) ||
+            ("featureSlugs" in r && feature.slug !== undefined && (r.featureSlugs?.includes(feature.slug) ?? false));
+        // Check through Lounges microservices
         if (type === "lounges") {
-            // Branches
-            const { features: branchesFeatures, roles: branchesRoles } = Config.microservices.lounges.find(({ slug }) => slug === "branches");
-            if (branchesFeatures.some((f) => f.slug === feature.slug) && branchesRoles.some((r) => r.slug === role.slug)) {
-                if ("root" in role && role.root === true)
+            const microservices = Config.microservices.lounges;
+            for (const ms of microservices) {
+                if (!ms.roles)
+                    continue;
+                const featureInMs = ms.features.some(featureMatches);
+                const msRole = ms.roles.find((r) => r.slug === role.slug);
+                if (featureInMs && msRole && roleHasFeature(msRole))
                     return true;
-                if ("featureSlugs" in role)
-                    return role.featureSlugs.includes(feature.slug);
-            }
-            // Staff
-            const { features: staffFeatures, roles: staffRoles } = Config.microservices.lounges.find(({ slug }) => slug === "staff");
-            if (staffFeatures.some((f) => f.slug === feature.slug) && staffRoles.some((r) => r.slug === role.slug)) {
-                if ("root" in role && role.root === true)
-                    return true;
-                if ("featureSlugs" in role)
-                    return role.featureSlugs.includes(feature.slug);
             }
         }
-        /* BACKROOM */
+        // Check through Backroom microservices
         if (type === "backroom") {
-            // Compliance
-            const { features: complianceFeatures, roles: complianceRoles } = Config.microservices.backroom.find(({ slug }) => slug === "compliance");
-            if (complianceFeatures.some((f) => f.slug === feature.slug) && complianceRoles.some((r) => r.slug === role.slug)) {
-                if ("root" in role && role.root === true)
+            const microservices = Config.microservices.backroom;
+            for (const ms of microservices) {
+                if (!ms.roles)
+                    continue;
+                const featureInMs = ms.features.some(featureMatches);
+                const msRole = ms.roles.find((r) => r.slug === role.slug);
+                if (featureInMs && msRole && roleHasFeature(msRole))
                     return true;
-                if ("featureSlugs" in role)
-                    return role.featureSlugs.includes(feature.slug);
-            }
-            // Commerce
-            const { features: commerceFeatures, roles: commerceRoles } = Config.microservices.backroom.find(({ slug }) => slug === "commerce");
-            if (commerceFeatures.some((f) => f.slug === feature.slug) && commerceRoles.some((r) => r.slug === role.slug)) {
-                if ("root" in role && role.root === true)
-                    return true;
-                if ("featureSlugs" in role)
-                    return role.featureSlugs.includes(feature.slug);
-            }
-            // Staff
-            const { features: staffFeatures, roles: staffRoles } = Config.microservices.backroom.find(({ slug }) => slug === "staff");
-            if (staffFeatures.some((f) => f.slug === feature.slug) && staffRoles.some((r) => r.slug === role.slug)) {
-                if ("root" in role && role.root === true)
-                    return true;
-                if ("featureSlugs" in role)
-                    return role.featureSlugs.includes(feature.slug);
             }
         }
         // Return false
@@ -467,9 +454,12 @@ export const Interface = {
                     await goto(result.location);
                     return;
                 }
-                // Update form and restore button if not an OTP button
+                // Update form
+                // OTP buttons are not restored on failure/error so OTP flows keep the loading state
                 await update();
-                if (result.type === "failure" || result.type === "error" || !button.classList.contains("otp-button")) {
+                const isOtpButton = button.classList.contains("otp-button");
+                const isFailureOrError = result.type === "failure" || result.type === "error";
+                if (!isOtpButton || !isFailureOrError) {
                     button.disabled = false;
                     button.innerHTML = innerHTML;
                 }
@@ -707,5 +697,20 @@ export const Interface = {
         // Match exact or subpath otherwise
         const target = `${cleanBase}/${slug}`;
         return page.url.pathname === target || page.url.pathname.startsWith(`${target}/`);
+    },
+    /**
+     * Resolves a path and returns the result.
+     * Wraps around the `resolve` function in SvelteKit's `$app/paths` module.
+     *
+     * https://svelte.dev/docs/kit/$app-paths#resolve
+     *
+     * @param path - The path to resolve
+     * @param params - The parameters to resolve the path with
+     * @returns {string} The resolved path without the leading dot
+     */
+    resolvePath: async (path, params = {}) => {
+        const { resolve } = await import("$app/paths");
+        const resolved = resolve(path, params);
+        return resolved.charAt(0) === "." ? resolved.slice(1) : resolved;
     }
 };

package/dist/formatting.d.ts

@@ -1,4 +1,4 @@
-import type { IdentityType, PronounsItem, Sex, SocialMediaPlatform, SocialMediaPlatformObject } from "@koloseum/types/public-auth";
+import type { IdentityType, PronounsItem, Sex, SocialMediaPlatform, SocialMediaPlatformObject } from "@koloseum/types/public/auth";
 import type { MobilePhoneLocale } from "validator";
 export declare const Transform: {
     /**
@@ -13,6 +13,12 @@ export declare const Transform: {
      * @returns {string} The cleaned URL
      */
     cleanUrl: (url: string) => string;
+    /**
+     * Formats a Koloseum Credits balance in Kenyan shillings (e.g. "Ksh 12.34").
+     * @param {number | null | undefined} cents - The balance to be formatted
+     * @returns {string} The formatted balance string, or "—" if the input is invalid
+     */
+    formatCreditsBalance: (cents: number | null | undefined) => string;
     /**
      * Formats a date in the format DD/MM/YYYY (by default) or YYYY-MM-DD (for client).
      * @param {string} date - Date to be formatted
@@ -20,6 +26,12 @@ export declare const Transform: {
      * @returns The formatted date string, or `null` if invalid input or in case of an error
      */
     formatDate: (date: string, forClient?: boolean) => string | null;
+    /**
+     * Formats a Koloseum Experience Points (KXP) balance as an integer (e.g. "1,234 KXP").
+     * @param {number | null | undefined} kxp - The balance to be formatted
+     * @returns {string} The formatted balance string, or "—" if the input is invalid
+     */
+    formatKxpBalance: (kxp: number | null | undefined) => string;
     /**
      * Formats a social media platform for display.
      * @param {SocialMediaPlatform} platform - The social media platform to be formatted

package/dist/formatting.js

@@ -21,6 +21,27 @@ export const Transform = {
      * @returns {string} The cleaned URL
      */
     cleanUrl: (url) => url.replace(/^https?:\/\//, "").replace(/\/+$/, ""),
+    /**
+     * Formats a Koloseum Credits balance in Kenyan shillings (e.g. "Ksh 12.34").
+     * @param {number | null | undefined} cents - The balance to be formatted
+     * @returns {string} The formatted balance string, or "—" if the input is invalid
+     */
+    formatCreditsBalance: (cents) => {
+        // Return placeholder if no balance is provided or input is invalid
+        if (cents == null || typeof cents !== "number")
+            return "—";
+        // Format balance
+        const value = cents / 100;
+        let formatted = new Intl.NumberFormat("en-KE", {
+            style: "currency",
+            currency: "KES",
+            minimumFractionDigits: 2,
+            maximumFractionDigits: 2
+        }).format(value);
+        formatted = formatted.replace(/\u00A0/g, " ");
+        // Return formatted string
+        return formatted;
+    },
     /**
      * Formats a date in the format DD/MM/YYYY (by default) or YYYY-MM-DD (for client).
      * @param {string} date - Date to be formatted
@@ -53,6 +74,17 @@ export const Transform = {
             return null;
         }
     },
+    /**
+     * Formats a Koloseum Experience Points (KXP) balance as an integer (e.g. "1,234 KXP").
+     * @param {number | null | undefined} kxp - The balance to be formatted
+     * @returns {string} The formatted balance string, or "—" if the input is invalid
+     */
+    formatKxpBalance: (kxp) => {
+        if (kxp == null || typeof kxp !== "number")
+            return "—";
+        const formatted = new Intl.NumberFormat("en-KE").format(kxp);
+        return `${formatted} KXP`;
+    },
     /**
      * Formats a social media platform for display.
      * @param {SocialMediaPlatform} platform - The social media platform to be formatted

package/dist/platform.d.ts

@@ -1,5 +1,5 @@
 import type { CustomError, MicroserviceGroup, MicroserviceObject, UserWithCustomMetadata } from "@koloseum/types/general";
-import type { BranchAddressObject, County } from "@koloseum/types/public-auth";
+import type { BranchAddressObject, County } from "@koloseum/types/public/auth";
 export declare const Config: {
     /**
      * 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:

package/dist/platform.js

@@ -16,427 +16,505 @@ export const Config = {
      * - `roles`: An array of roles attached to the microservice.
      */
     microservices: {
-        backroom: [
+        public: [
             {
-                name: "Compliance",
-                description: "Management of compliance and regulatory adherence for Players and Lounges.",
-                slug: "compliance",
+                name: "Koloseum",
+                description: "Level up your gaming experience on Kenya's premier esports platform.",
+                slug: "landing",
                 features: [
                     {
-                        name: "Players",
-                        description: "Search, review, and manage Player data.",
-                        slug: "players",
-                        tabs: [
-                            {
-                                name: "Profile",
-                                description: "Review basic Player data.",
-                                root: true
-                            },
-                            {
-                                name: "Documents",
-                                description: "Review Player documents.",
-                                slug: "documents"
-                            },
-                            {
-                                name: "Data updates",
-                                description: "Review Player data updates.",
-                                slug: "data-updates",
-                                tabs: [
-                                    {
-                                        name: "Requests",
-                                        description: "Review Player data update requests.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "History",
-                                        description: "Review Player data update history.",
-                                        slug: "history"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Credits",
-                                description: "Review Koloseum Credits data for the Player.",
-                                slug: "credits",
-                                tabs: [
-                                    {
-                                        name: "Transactions",
-                                        description: "Review Player transactions with Koloseum Credits.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "Transfers",
-                                        description: "Review Player transfers with Koloseum Credits.",
-                                        slug: "transfers"
-                                    },
-                                    {
-                                        name: "Subscriptions",
-                                        description: "Review Player subscriptions with Koloseum Credits.",
-                                        slug: "subscriptions"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Misconduct",
-                                description: "Review Player reports and sanctions.",
-                                slug: "misconduct",
-                                tabs: [
-                                    {
-                                        name: "Reports",
-                                        description: "Review Player reports.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "Sanctions",
-                                        description: "Review Player sanctions.",
-                                        slug: "sanctions"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Points / KXP",
-                                description: "Review Koloseum Experience Points (KXP) transactions for the Player.",
-                                slug: "points"
-                            }
-                        ]
+                        name: "Home",
+                        description: "Discover Koloseum and its offerings for Players and Lounges.",
+                        root: true
+                    }
+                ],
+                roles: null
+            },
+            {
+                name: "Authentication",
+                description: "Sign in or create an account as a Player or Lounge.",
+                slug: "auth",
+                features: [
+                    {
+                        name: "Login",
+                        description: "Sign in with phone and OTP or password.",
+                        slug: "login"
                     },
                     {
-                        name: "Lounges",
-                        description: "Search, review, and manage Lounge data.",
-                        slug: "lounges",
-                        tabs: [
-                            {
-                                name: "Profile",
-                                description: "Review basic Lounge data.",
-                                root: true
-                            },
-                            {
-                                name: "Documents",
-                                description: "Review Lounge documents.",
-                                slug: "documents"
-                            },
-                            {
-                                name: "Staff",
-                                description: "Search, review, and manage Lounge staff data.",
-                                slug: "staff"
-                            },
-                            {
-                                name: "Branches",
-                                description: "Review Lounge branches.",
-                                slug: "branches",
-                                tabs: [
-                                    {
-                                        name: "Profile",
-                                        description: "Review basic Lounge branch data.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "Amenities",
-                                        description: "Review Lounge branch amenities.",
-                                        slug: "amenities"
-                                    },
-                                    {
-                                        name: "Staff",
-                                        description: "Search, review, and manage Lounge branchstaff data.",
-                                        slug: "staff"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Data updates",
-                                description: "Review Lounge data updates.",
-                                slug: "data-updates",
-                                tabs: [
-                                    {
-                                        name: "Requests",
-                                        description: "Review Lounge data update requests.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "History",
-                                        description: "Review Lounge data update history.",
-                                        slug: "history"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Credits",
-                                description: "Review Koloseum Credits data for the Lounge.",
-                                slug: "credits",
-                                tabs: [
-                                    {
-                                        name: "Transactions",
-                                        description: "Review Lounge transactions with Koloseum Credits.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "Transfers",
-                                        description: "Review Lounge transfers with Koloseum Credits.",
-                                        slug: "transfers"
-                                    },
-                                    {
-                                        name: "Subscriptions",
-                                        description: "Review Lounge subscriptions with Koloseum Credits.",
-                                        slug: "subscriptions"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Misconduct",
-                                description: "Review Lounge reports and sanctions.",
-                                slug: "misconduct",
-                                tabs: [
-                                    {
-                                        name: "Reports",
-                                        description: "Review Lounge reports.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "Sanctions",
-                                        description: "Review Lounge sanctions.",
-                                        slug: "sanctions"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Points / KXP",
-                                description: "Review Koloseum Experience Points (KXP) transactions for the Lounge.",
-                                slug: "points"
-                            }
-                        ]
+                        name: "Registration",
+                        description: "Register as a Player (individual) or Lounge (business).",
+                        slug: "registration"
                     }
                 ],
-                roles: [
+                roles: null
+            },
+            {
+                name: "Help",
+                description: "Knowledge base and support ticket tracking for authenticated users.",
+                slug: "help",
+                features: [
                     {
-                        name: "Compliance",
-                        slug: "compliance",
+                        name: "Knowledge base",
+                        description: "Browse and read help articles and basic guides.",
+                        slug: "knowledge-base"
+                    },
+                    {
+                        name: "Support tickets",
+                        description: "View support ticket list and status. Create a new ticket for assistance.",
+                        slug: "tickets"
+                    }
+                ],
+                roles: null
+            },
+            {
+                name: "Legal",
+                description: "Review our legal policy documents.",
+                slug: "legal",
+                features: [
+                    {
+                        name: "Terms of Use",
+                        description: "Find out how you can use Koloseum and the expectations we have of you.",
+                        slug: "terms"
+                    },
+                    {
+                        name: "Privacy Policy",
+                        description: "Learn more about how we collect, use, and protect your data.",
+                        slug: "privacy"
+                    },
+                    {
+                        name: "Code of Conduct",
+                        description: "Learn more about how you can help ensure a safe and enjoyable experience for all users.",
+                        slug: "conduct"
+                    }
+                ],
+                roles: null
+            }
+        ],
+        players: [
+            {
+                name: "Sessions",
+                description: "Track your gaming sessions at registered Lounges.",
+                slug: "sessions",
+                features: [
+                    {
+                        name: "Home",
+                        description: "Start a session, find a Lounge, or view and manage your active session.",
                         root: true
                     },
                     {
-                        name: "Players",
-                        slug: "players",
-                        featureSlugs: ["players"]
+                        name: "Start Session",
+                        description: "Search for a Lounge, choose game and station, check in or reserve, and manage your session to checkout.",
+                        slug: "start-session"
                     },
                     {
-                        name: "Lounges",
-                        slug: "lounges",
-                        featureSlugs: ["lounges"]
+                        name: "Find a Lounge",
+                        description: "Browse Lounges, view branches and stations, start a session, or file a report.",
+                        slug: "find-lounge"
                     }
-                ]
+                ],
+                roles: null
             },
             {
                 name: "Competitions",
-                description: "Management of competitions data and live events across Markets.",
+                description: "One-stop shop for all your competitive gaming needs.",
                 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",
-                        tabs: [
-                            {
-                                name: "Savanna Circuit",
-                                description: "Manage competition data for the Savanna Circuit.",
-                                slug: "league",
-                                tabs: [
-                                    {
-                                        name: "Rankings",
-                                        description: "Manage rankings for any Savanna Circuit season.",
-                                        root: true
-                                    },
-                                    {
-                                        name: "Tournaments",
-                                        description: "Manage tournaments for any Savanna Circuit season.",
-                                        slug: "tournaments",
-                                        tabs: [
-                                            {
-                                                name: "Events",
-                                                description: "Manage events for any Savanna Circuit tournament.",
-                                                root: true
-                                            },
-                                            {
-                                                name: "Tickets",
-                                                description: "Manage tickets for any Savanna Circuit tournament.",
-                                                slug: "tickets"
-                                            },
-                                            {
-                                                name: "Settings",
-                                                description: "Manage settings for any Savanna Circuit tournament.",
-                                                slug: "settings"
-                                            }
-                                        ]
-                                    },
-                                    {
-                                        name: "Settings",
-                                        description: "Manage settings for any Savanna Circuit season.",
-                                        slug: "settings"
-                                    }
-                                ]
-                            },
-                            {
-                                name: "Savanna Fight Night",
-                                description: "Manage competition data for Savanna Fight Night.",
-                                slug: "challenges"
-                            }
-                        ]
-                    },
-                    {
-                        name: "Hit List",
-                        description: "Manage battle royale esports data for Hit List.",
-                        slug: "bryl"
-                    }
-                ],
-                roles: [
-                    {
-                        name: "Competitions",
-                        slug: "competitions",
+                        name: "Home",
+                        description: "Discover and participate in Leagues, Challenges, and Locals. Register as an organiser to host your own events.",
                         root: true
                     },
                     {
-                        name: "Ma Esto",
-                        slug: "fbl",
-                        featureSlugs: ["fbl"]
+                        name: "Leagues",
+                        description: "Browse leagues, view rankings and results, purchase tournament tickets.",
+                        slug: "leagues"
+                    },
+                    {
+                        name: "Challenges",
+                        description: "Browse challenges, view editions, issue challenges, purchase tickets.",
+                        slug: "challenges"
                     },
                     {
-                        name: "Savanna FGC",
-                        slug: "fgc",
-                        featureSlugs: ["fgc"]
+                        name: "Locals",
+                        description: "Browse one-off tournaments and purchase tickets.",
+                        slug: "locals"
                     },
                     {
-                        name: "Hit List",
-                        slug: "bryl",
-                        featureSlugs: ["bryl"]
+                        name: "Organisers",
+                        description: "Register as an organiser, manage staff, view ratings and reviews.",
+                        slug: "organisers"
                     }
-                ]
+                ],
+                roles: null
             },
             {
                 name: "KLSM",
-                description: "Management of game and console trades between users.",
+                description: "Trade used games and consoles with other users at affordable prices.",
                 slug: "commerce",
-                features: [],
+                features: [
+                    {
+                        name: "Store",
+                        description: "Browse and buy Koloseum merchandise.",
+                        slug: "store"
+                    },
+                    {
+                        name: "Events",
+                        description: "Buy tickets to register for Competitions events as a participant or spectator.",
+                        slug: "events"
+                    },
+                    {
+                        name: "Game Exchange",
+                        description: "Discover and reserve used games and consoles for sale.",
+                        slug: "game-exchange"
+                    }
+                ],
+                roles: null
+            },
+            {
+                name: "Account",
+                description: "Review Player account settings and preferences.",
+                slug: "account",
+                features: [
+                    {
+                        name: "General",
+                        description: "Review and manage your general settings.",
+                        slug: "general"
+                    },
+                    {
+                        name: "Notifications",
+                        description: "Review and manage your notification preferences.",
+                        slug: "notifications"
+                    },
+                    {
+                        name: "Security",
+                        description: "Review and manage your security preferences.",
+                        slug: "security"
+                    },
+                    {
+                        name: "Finances",
+                        description: "Review and manage your Koloseum Credits and prize money balances.",
+                        slug: "finances"
+                    },
+                    {
+                        name: "Loyalty",
+                        description: "Review your Koloseum Experience Points (KXP) balance and transaction history.",
+                        slug: "loyalty"
+                    },
+                    {
+                        name: "Documents",
+                        description: "Review and manage your ID documents.",
+                        slug: "documents"
+                    },
+                    {
+                        name: "Personal information",
+                        description: "Review and manage your personal information.",
+                        slug: "personal"
+                    },
+                    {
+                        name: "Gaming and socials",
+                        description: "Review and manage your gaming and social media information.",
+                        slug: "gaming-socials"
+                    },
+                    {
+                        name: "Lounges",
+                        description: "Review your access to Lounges microservices.",
+                        slug: "lounges"
+                    },
+                    {
+                        name: "Backroom",
+                        description: "Review your access to Backroom microservices.",
+                        slug: "backroom"
+                    }
+                ],
+                roles: null
+            }
+        ],
+        lounges: [
+            {
+                name: "Operations",
+                description: "Review and manage your branch's day-to-day operations.",
+                slug: "operations",
+                features: [
+                    {
+                        name: "Dashboard",
+                        description: "Review a summary of your branch's recent activity.",
+                        root: true
+                    },
+                    {
+                        name: "Branches",
+                        description: "Review and manage your existing branches.",
+                        slug: "branches"
+                    },
+                    {
+                        name: "Inventory",
+                        description: "Manage games, stations, and KLSM trading for your branch.",
+                        slug: "inventory"
+                    },
+                    {
+                        name: "Front Desk",
+                        description: "Process check-in, station-change, and check-out requests at your branch. Open or close for the day.",
+                        slug: "front-desk"
+                    },
+                    {
+                        name: "Sessions",
+                        description: "Review and manage sessions, discounts, and special events at your branch.",
+                        slug: "sessions"
+                    },
+                    {
+                        name: "Eatery",
+                        description: "Review and manage menu items and orders at your branch.",
+                        slug: "eatery"
+                    },
+                    {
+                        name: "Reputation",
+                        description: "Review and manage reviews, sanctions, and misconduct reports across your branches.",
+                        slug: "reputation"
+                    }
+                ],
                 roles: [
                     {
-                        name: "Commerce",
-                        slug: "commerce",
+                        name: "Superuser",
+                        slug: "superuser",
+                        root: true
+                    },
+                    {
+                        name: "Manager",
+                        slug: "manager",
                         root: true
+                    },
+                    {
+                        name: "Branch Manager",
+                        slug: "branch-manager",
+                        featureSlugs: ["branches", "inventory", "front-desk", "sessions", "reputation"]
+                    },
+                    {
+                        name: "Front Desk",
+                        slug: "front-desk",
+                        featureSlugs: ["front-desk", "sessions", "reputation"]
+                    },
+                    {
+                        name: "Inventory",
+                        slug: "inventory",
+                        featureSlugs: ["inventory", "reputation"]
+                    },
+                    {
+                        name: "Kitchen",
+                        slug: "kitchen",
+                        featureSlugs: ["eatery", "reputation"]
                     }
                 ]
             },
             {
                 name: "Staff",
-                description: "Management of Backroom staff authorisation.",
+                description: "Recruit staff members for your Lounge.",
                 slug: "staff",
                 features: [
+                    {
+                        name: "Dashboard",
+                        description: "Review a summary of your Lounge's staff recruitment.",
+                        root: true
+                    },
                     {
                         name: "Roles",
-                        description: "Review and manage Backroom roles.",
+                        description: "Review the default platform roles and their permissions.",
                         slug: "roles"
                     },
                     {
                         name: "Users",
-                        description: "Review and manage Backroom users.",
+                        description: "Review and manage your Lounge's staff members and their roles.",
                         slug: "users"
                     }
                 ],
                 roles: [
+                    {
+                        name: "Superuser",
+                        slug: "superuser",
+                        root: true
+                    },
                     {
                         name: "Human Resources",
                         slug: "hr",
+                        featureSlugs: ["roles", "users"]
+                    }
+                ]
+            },
+            {
+                name: "Account",
+                description: "Review your Lounge's account settings and preferences.",
+                slug: "account",
+                features: [
+                    {
+                        name: "Company information",
+                        description: "Review and update your Lounge's company information.",
+                        slug: "company"
+                    },
+                    {
+                        name: "Finances",
+                        description: "Review your Lounge's Koloseum Credits balance, transaction history, and service subscriptions.",
+                        slug: "finances"
+                    },
+                    {
+                        name: "Ownership transfer",
+                        description: "Request a transfer of ownership for your Lounge account.",
+                        slug: "transfer"
+                    }
+                ],
+                roles: [
+                    {
+                        name: "Superuser",
+                        slug: "superuser",
                         root: true
+                    },
+                    {
+                        name: "Manager",
+                        slug: "manager",
+                        featureSlugs: ["finances"]
                     }
                 ]
             }
         ],
-        players: [
+        backroom: [
             {
-                name: "Sessions",
-                description: "Track your gaming sessions at registered lounges.",
-                slug: "sessions",
-                features: [],
-                roles: null
+                name: "Compliance",
+                description: "Review and manage compliance and regulatory adherence for Players and Lounges.",
+                slug: "compliance",
+                features: [
+                    {
+                        name: "Dashboard",
+                        description: "Review a summary of platform registration and usage.",
+                        slug: "dashboard"
+                    },
+                    {
+                        name: "Players",
+                        description: "Search, review, and manage Player data.",
+                        slug: "players"
+                    },
+                    {
+                        name: "Lounges",
+                        description: "Search, review, and manage Lounge data.",
+                        slug: "lounges"
+                    }
+                ],
+                roles: [
+                    {
+                        name: "Superuser",
+                        slug: "superuser",
+                        root: true
+                    },
+                    {
+                        name: "Compliance",
+                        slug: "compliance",
+                        root: true
+                    },
+                    {
+                        name: "Players",
+                        slug: "players",
+                        featureSlugs: ["dashboard", "players"]
+                    },
+                    {
+                        name: "Lounges",
+                        slug: "lounges",
+                        featureSlugs: ["dashboard", "lounges"]
+                    }
+                ]
             },
             {
                 name: "KLSM",
-                description: "Trade used games and consoles with other users at affordable prices.",
+                description: "Monitor and regulate commercial activity on the platform.",
                 slug: "commerce",
-                features: [],
-                roles: null
-            },
-            {
-                name: "Savanna FGC",
-                description: "Check out the latest news and competitions from Savanna FGC.",
-                slug: "fgc",
                 features: [
                     {
-                        name: "Home",
-                        description: "Learn more about the Savanna Circuit.",
-                        root: true
+                        name: "Dashboard",
+                        description: "Review a summary of commercial activity on the platform.",
+                        slug: "dashboard"
                     },
                     {
-                        name: "Rules",
-                        description: "Review the rules and regulations of the Savanna Circuit.",
-                        slug: "rules"
+                        name: "Storefront",
+                        description: "Review and manage merchandise listings and discounts. Track orders and revenue.",
+                        slug: "storefront"
                     },
                     {
-                        name: "Tournaments",
-                        description: "Review and join upcoming tournaments on the Savanna Circuit.",
-                        slug: "tournaments"
+                        name: "Warehouse",
+                        description: "Review and manage merchandise inventory. Process orders and track deliveries.",
+                        slug: "warehouse"
+                    },
+                    {
+                        name: "Events",
+                        description: "Review and manage competition tickets. Track attendance and revenue.",
+                        slug: "events"
+                    },
+                    {
+                        name: "Game Exchange",
+                        description: "Review and manage used game and console listings and track revenue.",
+                        slug: "game-exchange"
                     }
                 ],
-                roles: null
-            },
-            {
-                name: "Account",
-                description: "Review Player account settings and preferences.",
-                slug: "account",
-                features: [
+                roles: [
                     {
-                        name: "General",
-                        description: "Review and manage your general settings.",
-                        slug: "general"
+                        name: "Superuser",
+                        slug: "superuser",
+                        root: true
                     },
                     {
-                        name: "Documents",
-                        description: "Review and manage your ID documents.",
-                        slug: "documents"
+                        name: "Commerce",
+                        slug: "commerce",
+                        root: true
                     },
                     {
-                        name: "Personal",
-                        description: "Review and manage your personal information.",
-                        slug: "personal"
+                        name: "Storefront",
+                        slug: "storefront",
+                        featureSlugs: ["dashboard", "storefront"]
                     },
                     {
-                        name: "Gaming & Socials",
-                        description: "Review and manage your gaming and social media information.",
-                        slug: "gaming-socials"
+                        name: "Warehouse",
+                        slug: "warehouse",
+                        featureSlugs: ["dashboard", "warehouse"]
                     },
                     {
-                        name: "Notifications",
-                        description: "Review and manage your notification preferences.",
-                        slug: "notifications"
+                        name: "Box Office",
+                        slug: "box-office",
+                        featureSlugs: ["dashboard", "events"]
                     },
                     {
-                        name: "Security",
-                        description: "Review and manage your security preferences.",
-                        slug: "security"
+                        name: "Game Exchange",
+                        slug: "game-exchange",
+                        featureSlugs: ["dashboard", "game-exchange"]
+                    }
+                ]
+            },
+            {
+                name: "Staff",
+                description: "Review and manage Koloseum staff and their roles.",
+                slug: "staff",
+                features: [
+                    {
+                        name: "Dashboard",
+                        description: "Review a summary of staff recruitment for the platform.",
+                        root: true
                     },
                     {
-                        name: "Lounges",
-                        description: "Review your access to Lounges microservices.",
-                        slug: "lounges"
+                        name: "Roles",
+                        description: "Review and manage Backroom roles and their permissions.",
+                        slug: "roles"
                     },
                     {
-                        name: "Backroom",
-                        description: "Review your access to Backroom microservices.",
-                        slug: "backroom"
+                        name: "Users",
+                        description: "Review and manage Backroom users and their roles.",
+                        slug: "users"
                     }
                 ],
-                roles: null
+                roles: [
+                    {
+                        name: "Superuser",
+                        slug: "superuser",
+                        root: true
+                    },
+                    {
+                        name: "Human Resources",
+                        slug: "hr",
+                        root: true
+                    }
+                ]
             }
         ]
     }
@@ -581,7 +659,7 @@ export const Resource = {
             }
             // Handle Landing microservice
             else if (path.startsWith("landing")) {
-                port = 5184;
+                port = 5186;
                 path = path.replace("landing", "");
             }
             // Return redirect URL

package/dist/server.d.ts

@@ -16,6 +16,18 @@ export declare const Instance: {
         error?: string;
         context?: Record<string, any>;
     }>;
+    /**
+     * Gets the current Koloseum Experience Points (KXP) and Koloseum Credits balances for the authenticated Player.
+     * @param {SupabaseClient<Database>} supabase - The Supabase client
+     * @returns {Promise<{ balances?: { kxp: number; credits: number }; error?: CustomError }>} The Player's current `balances`, or an `error` if any has occurred
+     */
+    getPlayerBalances: (supabase: SupabaseClient<Database>) => Promise<{
+        balances?: {
+            kxp: number;
+            credits: number;
+        };
+        error?: CustomError;
+    }>;
     /**
      * Checks if a user is authorised to access a microservice.
      * @param {SupabaseClient<Database>} supabase - The Supabase client.

package/dist/server.js

@@ -71,6 +71,28 @@ export const Instance = {
             return { code: 500, error: Status.ERROR };
         }
     },
+    /**
+     * Gets the current Koloseum Experience Points (KXP) and Koloseum Credits balances for the authenticated Player.
+     * @param {SupabaseClient<Database>} supabase - The Supabase client
+     * @returns {Promise<{ balances?: { kxp: number; credits: number }; error?: CustomError }>} The Player's current `balances`, or an `error` if any has occurred
+     */
+    getPlayerBalances: async (supabase) => {
+        // Initialise balances
+        let kxp = 0;
+        let credits = 0;
+        // Get Player balances
+        const { data: balances, error: balancesError } = await supabase.schema("compliance").rpc("get_player_balances");
+        if (balancesError)
+            return Exception.parsePostgrestError(balancesError);
+        // Assign balances
+        if (balances && typeof balances === "object" && "kxp" in balances && "credits" in balances) {
+            const b = balances;
+            kxp = b.kxp ?? 0;
+            credits = b.credits ?? 0;
+        }
+        // Return balances
+        return { balances: { kxp, credits } };
+    },
     /**
      * Checks if a user is authorised to access a microservice.
      * @param {SupabaseClient<Database>} supabase - The Supabase client.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.3.2",
+	"version": "0.3.4",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -48,7 +48,8 @@
 		"build": "rm -rf dist && npx tsc",
 		"check": "npx tsc --noEmit && prettier --check .",
 		"format": "prettier --write .",
-		"test": "vitest --run"
+		"test": "vitest --run",
+		"test:coverage": "vitest run --coverage"
 	},
 	"dependencies": {
 		"@supabase/supabase-js": "^2.57.4",
@@ -61,12 +62,13 @@
 		"validator": "^13.15.15"
 	},
 	"devDependencies": {
-		"@koloseum/types": "^0.3.0",
+		"@koloseum/types": "^0.3.3",
 		"@playwright/test": "^1.55.0",
 		"@suprsend/web-components": "^0.4.0",
 		"@types/sanitize-html": "^2.16.0",
 		"@types/uuid": "^10.0.0",
 		"@types/validator": "^13.15.3",
+		"@vitest/coverage-v8": "^3.2.4",
 		"prettier": "^3.6.2",
 		"typescript": "^5.9.2",
 		"vitest": "^3.2.4"