@koloseum/utils 0.1.4 → 0.1.6

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 import type { Database } from "@koloseum/types/database";
-import type { CustomError, SocialMediaPlatform } from "@koloseum/types/public/auth";
+import type { CustomError, PronounsCheckboxes, SocialMediaPlatform } from "@koloseum/types/public/auth";
 import type { PostgrestError, SupabaseClient } from "@supabase/supabase-js";
 import type { MobilePhoneLocale } from "validator";
 export declare const Status: {
@@ -66,6 +66,12 @@ export declare const Utility: {
      * @returns The age in years, or `NaN` if the input is invalid
      */
     getAge: (dateOfBirth: string) => number;
+    /**
+     * 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;
     /**
      * A regular expression for Koloseum Lounge Branch IDs. It covers the following rules:
      * - 9 characters long

package/dist/utils.js

@@ -18,7 +18,7 @@ export const Status = {
     /**
      * A generic password reset request message.
      */
-    PASSWORD_RESET_REQUESTED: "If the provided email address is registered, you will receive a password reset link shortly.",
+    PASSWORD_RESET_REQUESTED: "If the provided email address is registered, you will receive a password reset link shortly."
 };
 /* Utility functions */
 export const Utility = {
@@ -59,7 +59,7 @@ export const Utility = {
      * @param {string} message - The error message
      * @returns An object with the error `code` and `message`
      */
-    customError: (code, message) => (!code || code < 400 || code > 599 ? { code: 500, message: Status.ERROR } : { code, message }),
+    customError: (code, message) => !code || code < 400 || code > 599 ? { code: 500, message: Status.ERROR } : { code, message },
     /**
      * A regular expression for E.164 phone numbers.
      *
@@ -79,7 +79,7 @@ export const Utility = {
             const formattedDate = new Intl.DateTimeFormat(forClient ? "fr-CA" : "en-KE", {
                 day: "2-digit",
                 month: "2-digit",
-                year: "numeric",
+                year: "numeric"
                 // @ts-ignore: .fromString method exists but is not typed in `any-date-parser` package
             }).format(parser.fromString(date));
             return formattedDate;
@@ -120,6 +120,56 @@ export const Utility = {
         const monthDiff = currentDate.getMonth() - birthDate.getMonth();
         return monthDiff < 0 || (monthDiff === 0 && currentDate.getDate() < birthDate.getDate()) ? --age : age;
     },
+    /**
+     * Handles the click event for pronouns checkboxes.
+     * @param {MouseEvent} e - The click event
+     * @param {PronounsCheckboxes} checkboxes - The pronouns checkboxes
+     */
+    handlePronounsCheckboxClick: (e, checkboxes) => {
+        const target = e.target;
+        if (target.value === "none") {
+            for (let checkbox of Object.values(checkboxes))
+                if (checkbox && checkbox !== target && checkbox.checked) {
+                    e.preventDefault();
+                    return;
+                }
+            for (let checkbox of Object.values(checkboxes))
+                if (checkbox && checkbox !== target) {
+                    checkbox.checked = false;
+                    checkbox.disabled = !checkbox.disabled;
+                }
+        }
+        else {
+            if (checkboxes.none?.checked) {
+                e.preventDefault();
+                return;
+            }
+            if (target.value === "male" || target.value === "female") {
+                const oppositeIndex = target.value === "male" ? "female" : "male";
+                const oppositeCheckbox = checkboxes[oppositeIndex];
+                if (oppositeCheckbox?.checked) {
+                    e.preventDefault();
+                    return;
+                }
+                if (oppositeCheckbox) {
+                    oppositeCheckbox.checked = false;
+                    oppositeCheckbox.disabled = !oppositeCheckbox.disabled;
+                }
+                if (checkboxes.none) {
+                    checkboxes.none.checked = false;
+                    if (!checkboxes.neutral?.checked)
+                        checkboxes.none.disabled = !checkboxes.none.disabled;
+                }
+            }
+            else {
+                if (checkboxes.none) {
+                    checkboxes.none.checked = false;
+                    if (checkboxes.neutral && !checkboxes.male?.checked && !checkboxes.female?.checked)
+                        checkboxes.none.disabled = checkboxes.neutral.checked;
+                }
+            }
+        }
+    },
     /**
      * A regular expression for Koloseum Lounge Branch IDs. It covers the following rules:
      * - 9 characters long
@@ -148,7 +198,7 @@ export const Utility = {
      * @param {CustomError} error - The error object
      * @returns A new `Error` object if the error is unexpected, or a Svelte error otherwise
      */
-    parseLoadError: (error) => (error.code === 500 ? new Error(error.message) : svelteError(error.code, { message: error.message })),
+    parseLoadError: (error) => error.code === 500 ? new Error(error.message) : svelteError(error.code, { message: error.message }),
     /**
      * Parses a `PostgrestError` object and returns a custom error object if any has occurred.
      * @param {PostgrestError | null} postgrestError - The `PostgrestError` object, or `null` if no error occurred
@@ -195,7 +245,7 @@ export const Utility = {
             { code: "42883", status: 404 },
             { code: "42P01", status: 404 },
             { code: "42P17", status: 500 },
-            { code: "42501", status: 403 },
+            { code: "42501", status: 403 }
         ];
         // Return custom error if Postgrest error code is found
         for (const { code, status } of errorMap)
@@ -227,7 +277,7 @@ export const Utility = {
      * @param {string} input - The input to be sanitised
      * @returns A sanitised string, or an empty string if the input is invalid
      */
-    sanitiseHtml: (input) => (typeof input !== "string" ? "" : sanitize(input, { allowedTags: [], allowedAttributes: {} })),
+    sanitiseHtml: (input) => typeof input !== "string" ? "" : sanitize(input, { allowedTags: [], allowedAttributes: {} }),
     /**
      * A regular expression for social media handles, without a leading slash or @ character.
      *
@@ -246,5 +296,7 @@ export const Utility = {
      * @param {string} handle - The social media handle to be validated
      * @returns `true` if the handle is valid; `false` otherwise
      */
-    validateSocialMediaHandle: (handle) => !isURL(handle, { require_protocol: false }) && !handle.startsWith("@") && Boolean(handle.match(Utility.socialMediaHandleRegex)),
+    validateSocialMediaHandle: (handle) => !isURL(handle, { require_protocol: false }) &&
+        !handle.startsWith("@") &&
+        Boolean(handle.match(Utility.socialMediaHandleRegex))
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.1.4",
+	"version": "0.1.6",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -24,7 +24,9 @@
 		"./dist/**/*"
 	],
 	"scripts": {
-		"build": "npx tsc",
+		"build": "rm -rf dist && npx tsc",
+		"check": "npx tsc --noEmit && prettier --check .",
+		"format": "prettier --write .",
 		"test": "vitest --run"
 	},
 	"dependencies": {
@@ -39,6 +41,7 @@
 		"@playwright/test": "^1.50.1",
 		"@types/sanitize-html": "^2.13.0",
 		"@types/validator": "^13.12.2",
+		"prettier": "^3.5.1",
 		"typescript": "^5.0.0",
 		"vitest": "^3.0.5"
 	}

package/src/utils.test.ts

@@ -28,7 +28,7 @@ describe("Utility helper", () => {
 		parsePostgrestError,
 		sanitiseHtml,
 		validateE164,
-		validateSocialMediaHandle,
+		validateSocialMediaHandle
 	} = Utility;
 
 	// Test each helper
@@ -103,7 +103,7 @@ describe("Utility helper", () => {
 				name: "insufficient_privilege",
 				message: 'Insufficient privileges: permission denied for relation "restricted_table"',
 				details: 'User does not have the necessary permissions to access the relation "restricted_table".',
-				hint: "",
+				hint: ""
 			})
 		).toEqual({ error: { code: 403, message: Status.ERROR } });
 		expect(
@@ -112,7 +112,7 @@ describe("Utility helper", () => {
 				name: "undefined_function",
 				message: "Undefined function: function non_existent_function() does not exist",
 				details: "Function non_existent_function() does not exist.",
-				hint: "No function matches the given name and argument types. You might need to add explicit type casts.",
+				hint: "No function matches the given name and argument types. You might need to add explicit type casts."
 			})
 		).toEqual({ error: { code: 404, message: Status.ERROR } });
 		expect(
@@ -121,7 +121,7 @@ describe("Utility helper", () => {
 				name: "read_only_sql_transaction",
 				message: "Read only SQL transaction: cannot execute INSERT in a read-only transaction",
 				details: "Cannot execute INSERT in a read-only transaction.",
-				hint: "",
+				hint: ""
 			})
 		).toEqual({ error: { code: 405, message: Status.ERROR } });
 		expect(
@@ -130,7 +130,7 @@ describe("Utility helper", () => {
 				name: "unique_violation",
 				message: 'Uniqueness violation: duplicate key value violates unique constraint "users_username_key"',
 				details: "Key (username)=(john_doe) already exists.",
-				hint: "",
+				hint: ""
 			})
 		).toEqual({ error: { code: 409, message: Status.ERROR } });
 		expect(
@@ -139,7 +139,7 @@ describe("Utility helper", () => {
 				name: "configuration_file_error",
 				message: "invalid page header in block 0 of relation base/12345/67890",
 				details: "The page header is corrupted. This may indicate hardware or file system issues.",
-				hint: "",
+				hint: ""
 			})
 		).toEqual({ error: { code: 500, message: Status.ERROR } });
 		expect(
@@ -148,7 +148,7 @@ describe("Utility helper", () => {
 				name: "connection_does_not_exist",
 				message: "connection does not exist",
 				details: "The connection to the database was lost or never established.",
-				hint: "",
+				hint: ""
 			})
 		).toEqual({ error: { code: 503, message: Status.ERROR } });
 		expect(
@@ -157,7 +157,7 @@ describe("Utility helper", () => {
 				name: "raise_exception",
 				message: "I'm a teapot!",
 				details: "Pretty simple",
-				hint: "418",
+				hint: "418"
 			})
 		).toEqual({ error: { code: 418, message: "I'm a teapot!" } });
 	});

package/src/utils.ts

@@ -1,5 +1,5 @@
 import type { Database } from "@koloseum/types/database";
-import type { CustomError, SocialMediaPlatform } from "@koloseum/types/public/auth";
+import type { CustomError, PronounsCheckboxes, SocialMediaPlatform } from "@koloseum/types/public/auth";
 
 import type { PostgrestError, SupabaseClient } from "@supabase/supabase-js";
 import type { MobilePhoneLocale } from "validator";
@@ -27,7 +27,7 @@ export const Status = {
 	/**
 	 * A generic password reset request message.
 	 */
-	PASSWORD_RESET_REQUESTED: "If the provided email address is registered, you will receive a password reset link shortly.",
+	PASSWORD_RESET_REQUESTED: "If the provided email address is registered, you will receive a password reset link shortly."
 };
 
 /* Utility functions */
@@ -39,12 +39,16 @@ export const Utility = {
 	 * @param {"GET" | "POST"} [method="GET"] - The HTTP method to use
 	 * @returns The response from the Edge function
 	 */
-	callEdgeFunction: async (supabase: SupabaseClient<Database>, path: string, method: "GET" | "POST" = "GET"): Promise<{ data?: any; error?: string }> => {
+	callEdgeFunction: async (
+		supabase: SupabaseClient<Database>,
+		path: string,
+		method: "GET" | "POST" = "GET"
+	): Promise<{ data?: any; error?: string }> => {
 		// Fetch response
 		const { data, error } = await supabase.functions.invoke(path, { method });
 
 		// Return error if any
-		if (error instanceof FunctionsHttpError) return { error: await error.context.json() };
+		if (error instanceof FunctionsHttpError) return { error: (await error.context.json()).message };
 		else if (error instanceof FunctionsRelayError) return { error: error.message };
 		else if (error instanceof FunctionsFetchError) return { error: error.message };
 
@@ -69,7 +73,8 @@ export const Utility = {
 	 * @param {string} message - The error message
 	 * @returns An object with the error `code` and `message`
 	 */
-	customError: (code: number | undefined, message: string): CustomError => (!code || code < 400 || code > 599 ? { code: 500, message: Status.ERROR } : { code, message }),
+	customError: (code: number | undefined, message: string): CustomError =>
+		!code || code < 400 || code > 599 ? { code: 500, message: Status.ERROR } : { code, message },
 	/**
 	 * A regular expression for E.164 phone numbers.
 	 *
@@ -88,7 +93,7 @@ export const Utility = {
 			const formattedDate = new Intl.DateTimeFormat(forClient ? "fr-CA" : "en-KE", {
 				day: "2-digit",
 				month: "2-digit",
-				year: "numeric",
+				year: "numeric"
 				// @ts-ignore: .fromString method exists but is not typed in `any-date-parser` package
 			}).format(parser.fromString(date));
 
@@ -129,6 +134,59 @@ export const Utility = {
 
 		return monthDiff < 0 || (monthDiff === 0 && currentDate.getDate() < birthDate.getDate()) ? --age : age;
 	},
+	/**
+	 * Handles the click event for pronouns checkboxes.
+	 * @param {MouseEvent} e - The click event
+	 * @param {PronounsCheckboxes} checkboxes - The pronouns checkboxes
+	 */
+	handlePronounsCheckboxClick: (e: MouseEvent, checkboxes: PronounsCheckboxes) => {
+		const target = e.target as EventTarget & HTMLInputElement;
+
+		if (target.value === "none") {
+			for (let checkbox of Object.values(checkboxes))
+				if (checkbox && checkbox !== target && checkbox.checked) {
+					e.preventDefault();
+					return;
+				}
+
+			for (let checkbox of Object.values(checkboxes))
+				if (checkbox && checkbox !== target) {
+					checkbox.checked = false;
+					checkbox.disabled = !checkbox.disabled;
+				}
+		} else {
+			if (checkboxes.none?.checked) {
+				e.preventDefault();
+				return;
+			}
+
+			if (target.value === "male" || target.value === "female") {
+				const oppositeIndex = target.value === "male" ? "female" : "male";
+				const oppositeCheckbox = checkboxes[oppositeIndex];
+
+				if (oppositeCheckbox?.checked) {
+					e.preventDefault();
+					return;
+				}
+
+				if (oppositeCheckbox) {
+					oppositeCheckbox.checked = false;
+					oppositeCheckbox.disabled = !oppositeCheckbox.disabled;
+				}
+
+				if (checkboxes.none) {
+					checkboxes.none.checked = false;
+					if (!checkboxes.neutral?.checked) checkboxes.none.disabled = !checkboxes.none.disabled;
+				}
+			} else {
+				if (checkboxes.none) {
+					checkboxes.none.checked = false;
+					if (checkboxes.neutral && !checkboxes.male?.checked && !checkboxes.female?.checked)
+						checkboxes.none.disabled = checkboxes.neutral.checked;
+				}
+			}
+		}
+	},
 	/**
 	 * A regular expression for Koloseum Lounge Branch IDs. It covers the following rules:
 	 * - 9 characters long
@@ -159,7 +217,8 @@ export const Utility = {
 	 * @param {CustomError} error - The error object
 	 * @returns A new `Error` object if the error is unexpected, or a Svelte error otherwise
 	 */
-	parseLoadError: (error: CustomError) => (error.code === 500 ? new Error(error.message) : svelteError(error.code, { message: error.message })),
+	parseLoadError: (error: CustomError) =>
+		error.code === 500 ? new Error(error.message) : svelteError(error.code, { message: error.message }),
 	/**
 	 * Parses a `PostgrestError` object and returns a custom error object if any has occurred.
 	 * @param {PostgrestError | null} postgrestError - The `PostgrestError` object, or `null` if no error occurred
@@ -207,7 +266,7 @@ export const Utility = {
 			{ code: "42883", status: 404 },
 			{ code: "42P01", status: 404 },
 			{ code: "42P17", status: 500 },
-			{ code: "42501", status: 403 },
+			{ code: "42501", status: 403 }
 		];
 
 		// Return custom error if Postgrest error code is found
@@ -241,7 +300,8 @@ export const Utility = {
 	 * @param {string} input - The input to be sanitised
 	 * @returns A sanitised string, or an empty string if the input is invalid
 	 */
-	sanitiseHtml: (input: string) => (typeof input !== "string" ? "" : sanitize(input, { allowedTags: [], allowedAttributes: {} })),
+	sanitiseHtml: (input: string) =>
+		typeof input !== "string" ? "" : sanitize(input, { allowedTags: [], allowedAttributes: {} }),
 	/**
 	 * A regular expression for social media handles, without a leading slash or @ character.
 	 *
@@ -254,11 +314,15 @@ export const Utility = {
 	 * @param {"any" | MobilePhoneLocale | MobilePhoneLocale[]} [locale="any"] - The locale(s) to validate the phone number against
 	 * @returns `true` if the phone number is valid; `false` otherwise
 	 */
-	validateE164: (phoneNumber: string, locale: "any" | MobilePhoneLocale | MobilePhoneLocale[] = "en-KE") => isMobilePhone(phoneNumber, locale) && Boolean(phoneNumber.match(Utility.e164Regex)),
+	validateE164: (phoneNumber: string, locale: "any" | MobilePhoneLocale | MobilePhoneLocale[] = "en-KE") =>
+		isMobilePhone(phoneNumber, locale) && Boolean(phoneNumber.match(Utility.e164Regex)),
 	/**
 	 * Validates a social media handle.
 	 * @param {string} handle - The social media handle to be validated
 	 * @returns `true` if the handle is valid; `false` otherwise
 	 */
-	validateSocialMediaHandle: (handle: string) => !isURL(handle, { require_protocol: false }) && !handle.startsWith("@") && Boolean(handle.match(Utility.socialMediaHandleRegex)),
+	validateSocialMediaHandle: (handle: string) =>
+		!isURL(handle, { require_protocol: false }) &&
+		!handle.startsWith("@") &&
+		Boolean(handle.match(Utility.socialMediaHandleRegex))
 };