@koloseum/utils 0.2.28 → 0.3.1

package/dist/client.d.ts

@@ -0,0 +1,131 @@
+import type { BrowserInfo, Microservice, MicroserviceFeature, MicroserviceGroup, MicroserviceObject, MicroserviceRole, UserWithCustomMetadata } from "@koloseum/types/general";
+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: {
+    /**
+     * Checks if a specific feature is supported by the browser.
+     * @param feature - The feature to check
+     * @param browserName - The name of the browser
+     * @param browserVersion - The version of the browser
+     * @returns `true` if the feature is supported, `false` otherwise
+     */
+    checkFeatureSupport: (feature: string, browserName: string, browserVersion: number) => boolean;
+    /**
+     * Gets detailed browser information for debugging.
+     */
+    getDetailedInfo: () => {
+        browser: string;
+        os: string;
+        platform: string;
+        engine: string;
+        userAgent: string;
+    };
+    /**
+     * Gets comprehensive browser information using Bowser.
+     */
+    getInfo: () => BrowserInfo;
+    /**
+     * Gets specific browser recommendations based on the detected browser.
+     */
+    getRecommendations: () => {
+        title: string;
+        message: string;
+        recommendations: string[];
+        critical: boolean;
+    };
+    /**
+     * Checks if the current browser is compatible with the application.
+     */
+    isBrowserCompatible: () => boolean;
+    /**
+     * Checks if the browser is Internet Explorer.
+     */
+    isInternetExplorer: () => boolean;
+    /**
+     * Checks if the browser is iOS Safari.
+     */
+    isIOSSafari: () => boolean;
+    /**
+     * Checks if the browser is a legacy version that needs updating.
+     */
+    isLegacyBrowser: () => boolean;
+    /**
+     * Checks if the browser is an old version of Safari.
+     */
+    isOldSafari: () => boolean;
+};
+export declare const Access: {
+    /**
+     * Get the current role of the user.
+     * @param user - The user object
+     * @param type - The type of role to get, i.e. "backroom" or "lounges"
+     * @returns The current role of the user.
+     */
+    getCurrentRole: (user: UserWithCustomMetadata, type: "backroom" | "lounges") => MicroserviceRole | null;
+    /**
+     * Get a microservice feature by slug.
+     * @param featureSlug - The slug of the feature to get.
+     * @param type - The type of microservice to get the feature for, i.e. "backroom" or "lounges"
+     * @returns The feature object or `null` if the feature does not exist.
+     */
+    getMicroserviceFeature: (featureSlug: string, type: "backroom" | "lounges") => MicroserviceFeature | null;
+    /**
+     * Get the microservices that a role has access to.
+     * @param role - The role to check.
+     * @param type - The type of microservice to get the features for, i.e. "backroom" or "lounges"
+     * @returns The microservices that the role has access to.
+     */
+    getMicroservicesForRole: (role: MicroserviceRole, type: "backroom" | "lounges") => MicroserviceObject<"backroom" | "lounges">[];
+    /**
+     * Renders the microservice features for the current user.
+     * @param user - The user to render the features for.
+     * @returns The microservice features for the current user, or `null` if no user is provided.
+     */
+    renderMicroserviceFeatures: (user: UserWithCustomMetadata) => MicroserviceFeature[] | null;
+    /**
+     * Check if a role has access to a microservice's feature.
+     * @param role - The role to check.
+     * @param feature - The feature to check.
+     * @param type - The type of microservice to check the feature for, i.e. "backroom" or "lounges"
+     * @returns `true` if the role has access to the feature, `false` otherwise.
+     */
+    roleHasAccessToFeature: (role: MicroserviceRole, feature: MicroserviceFeature, type: "backroom" | "lounges") => boolean;
+};
+export declare const Interface: {
+    /**
+     * Progressive-enhancement submit function for SvelteKit.
+     * Disables the submit button and shows a loading spinner; navigates via `goto` on redirect, otherwise calls `update` and restores the button.
+     * Buttons with class `otp-button` are not restored on failure/error so OTP flows can keep the loading state.
+     */
+    formEnhance: SubmitFunction;
+    /**
+     * Returns the URL for a menu item based on the slug.
+     * @param {string} base - The base URL
+     * @param {string} slug - The slug of the menu item
+     * @returns {string} The URL for the menu item
+     */
+    getMenuItemUrl: (base: string, slug: string | undefined) => string;
+    /**
+     * Generate a SuprSend notification inbox configuration object for a user.
+     * @param {string} userId - The user ID to generate the configuration for.
+     * @param {string} publicApiKey - The public API key to use for SuprSend.
+     * @returns The SuprSend notification inbox configuration object.
+     */
+    getSuprSendInboxConfig: (userId: string, publicApiKey: string) => IOptions;
+    /**
+     * Handles the click event for pronouns checkboxes.
+     * @param {MouseEvent} e - The click event
+     * @param {PronounsCheckboxes} checkboxes - The pronouns checkboxes
+     */
+    handlePronounsCheckboxClick: (e: MouseEvent, checkboxes: PronounsCheckboxes) => void;
+    /**
+     * 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 | undefined, microservice?: Microservice<MicroserviceGroup>, base?: string) => boolean;
+};