@koloseum/utils 0.2.4 → 0.2.7

package/dist/utils.d.ts

@@ -85,24 +85,37 @@ export declare const Utility: {
     formatSocialMediaPlatform: (platform: SocialMediaPlatform) => string;
     /**
      * Returns an age in years given a birth date.
-     * @param {string} dateOfBirth - The date of birth as a string, e.g. `DD-MM-YYYY`
+     * @param {Date | string | number | null} dateOfBirth - The date of birth
      * @returns The age in years, or `NaN` if the input is invalid
      */
-    getAge: (dateOfBirth: string) => number;
+    getAge: (dateOfBirth: Date | string | number | null) => number;
     /**
      * Formats a date as a locale-specific string.
-     * @param {Date | string} date - Date to be formatted
+     * @param {Date | string | number | null} date - Date to be formatted
      * @param {boolean} withTime - Specify whether the date should include time; defaults to `false`
      * @param {string} timeZone - The time zone to use for formatting; defaults to `Africa/Nairobi`
-     * @returns The formatted date string, or `null` if invalid input
+     * @returns The formatted date string, or an empty string if invalid input
      */
-    getDateString: (date: Date | string | null, withTime?: boolean, timeZone?: string) => string | null;
+    getDateString: (date: Date | string | number | null, withTime?: boolean, timeZone?: string) => string;
     /**
      * Formats an identity type for display.
      * @param {IdentityType} identityType - The identity type to be formatted
      * @returns The formatted identity type string
      */
     getIdentityTypeString: (identityType: IdentityType) => string;
+    /**
+     * 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;
+    /**
+     * Returns the parent URL for a given base URL.
+     * @param {string} base - The base URL
+     * @returns {string} The parent URL
+     */
+    getParentUrl: (base: string) => string;
     /**
      * Returns a pronoun given pronouns and a type.
      * @param {PronounsItem | null} pronouns - The pronouns to be formatted

package/dist/utils.js

@@ -230,44 +230,77 @@ export const Utility = {
     },
     /**
      * Returns an age in years given a birth date.
-     * @param {string} dateOfBirth - The date of birth as a string, e.g. `DD-MM-YYYY`
+     * @param {Date | string | number | null} dateOfBirth - The date of birth
      * @returns The age in years, or `NaN` if the input is invalid
      */
     getAge: (dateOfBirth) => {
-        if (dateOfBirth === "" || typeof dateOfBirth !== "string")
+        // Return NaN if no date is provided
+        if (!dateOfBirth)
             return NaN;
-        dateOfBirth = Utility.formatDate(dateOfBirth, true);
-        const birthDate = new Date(dateOfBirth);
+        // Validate and process date of birth
+        let birthDate;
+        if (dateOfBirth instanceof Date) {
+            if (isNaN(dateOfBirth.getTime()))
+                return NaN;
+            birthDate = dateOfBirth;
+        }
+        else if (typeof dateOfBirth === "string") {
+            if (dateOfBirth === "" || isNaN(Date.parse(dateOfBirth)))
+                return NaN;
+            // Format date of birth if it's a string
+            const formattedDate = Utility.formatDate(dateOfBirth, true);
+            if (!formattedDate)
+                return NaN;
+            birthDate = new Date(formattedDate);
+        }
+        else if (typeof dateOfBirth === "number") {
+            if (isNaN(dateOfBirth))
+                return NaN;
+            birthDate = new Date(dateOfBirth);
+        }
+        else {
+            return NaN;
+        }
+        // Validate the final date object
+        if (isNaN(birthDate.getTime()))
+            return NaN;
+        // Calculate age
         const currentDate = new Date();
-        let age = currentDate.getFullYear() - birthDate.getFullYear();
         const monthDiff = currentDate.getMonth() - birthDate.getMonth();
+        let age = currentDate.getFullYear() - birthDate.getFullYear();
+        // Return age
         return monthDiff < 0 || (monthDiff === 0 && currentDate.getDate() < birthDate.getDate()) ? --age : age;
     },
     /**
      * Formats a date as a locale-specific string.
-     * @param {Date | string} date - Date to be formatted
+     * @param {Date | string | number | null} date - Date to be formatted
      * @param {boolean} withTime - Specify whether the date should include time; defaults to `false`
      * @param {string} timeZone - The time zone to use for formatting; defaults to `Africa/Nairobi`
-     * @returns The formatted date string, or `null` if invalid input
+     * @returns The formatted date string, or an empty string if invalid input
      */
     getDateString: (date, withTime = false, timeZone = "Africa/Nairobi") => {
-        // Return null if no date is provided
+        // Return empty string if no date is provided
         if (!date)
-            return null;
+            return "";
         // Validate date to format
         let dateToFormat;
-        if (typeof date === "string") {
-            if (date === "" || isNaN(Date.parse(date)))
-                return null;
-            dateToFormat = new Date(date);
-        }
-        else if (date instanceof Date) {
+        if (date instanceof Date) {
             if (isNaN(date.getTime()))
-                return null;
+                return "";
             dateToFormat = date;
         }
+        else if (typeof date === "string" || typeof date === "number") {
+            if (typeof date === "string" && (date === "" || isNaN(Date.parse(date))))
+                return "";
+            if (typeof date === "number" && isNaN(date))
+                return "";
+            dateToFormat = new Date(date);
+        }
         else
-            return null;
+            return "";
+        // Validate the final date object
+        if (isNaN(dateToFormat.getTime()))
+            return "";
         // Format date
         return dateToFormat.toLocaleString("en-KE", {
             timeZone,
@@ -295,6 +328,31 @@ export const Utility = {
             return "Driver's licence";
         return "";
     },
+    /**
+     * 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, slug) => {
+        // Validate base URL
+        if (base === "" || typeof base !== "string")
+            return "";
+        // Return URL
+        return `${base}${slug && typeof slug === "string" ? `/${slug}` : ""}`;
+    },
+    /**
+     * Returns the parent URL for a given base URL.
+     * @param {string} base - The base URL
+     * @returns {string} The parent URL
+     */
+    getParentUrl: (base) => {
+        // Validate input
+        if (base === "" || typeof base !== "string")
+            return "";
+        // Return parent URL
+        return base.replace(/\/$/, "").split("/").slice(0, -1).join("/") || "/";
+    },
     /**
      * Returns a pronoun given pronouns and a type.
      * @param {PronounsItem | null} pronouns - The pronouns to be formatted

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.2.4",
+	"version": "0.2.7",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",