meticulous-ui 3.1.3 → 3.2.0

package/README.md

@@ -362,14 +362,48 @@ import blue from 'meticulous-ui/colors/blue';
 
 ## 📦 Utils
 
-| Functions         | Description                                                                                                    |
-| ----------------- | -------------------------------------------------------------------------------------------------------------- |
-| `capFirstLetter`  | Takes a string and returns with first letter capitalised                                                       |
-| `compose`         | Performs right-to-left function composition using transforming function                                        |
-| `hasEqualProps`   | Takes two args: Component’s previous props & its new props; returns true if all-non functional props are equal |
-| `isNonEmptyArray` | Takes an array & returns true if is not empty                                                                  |
-| `randomInt`       | Takes min, max integer & returns random integer between them                                                   |
-| `randomValue`     | Takes min, max value & returns random value between them                                                       |
+### General
+
+| Function      | Signature                  | Description                               |
+| ------------- | -------------------------- | ----------------------------------------- |
+| `compose`     | `(...funcs) → (val) → any` | Right-to-left function composition        |
+| `randomInt`   | `(min, max) → number`      | Random integer in `[min, floor(max + 1))` |
+| `randomValue` | `(min, max) → number`      | Random float in `[min, max + 1)`          |
+
+### Data Utilities
+
+| Function          | Signature                        | Description                                                              |
+| ----------------- | -------------------------------- | ------------------------------------------------------------------------ |
+| `deepClone`       | `(obj) → any`                    | Recursively clones objects, arrays, and Dates with no shared references  |
+| `mergeDeep`       | `(target, source) → object`      | Deep-merges source into target; source wins on conflicts                 |
+| `pick`            | `(obj, keys) → object`           | Returns a new object with only the specified keys                        |
+| `omit`            | `(obj, keys) → object`           | Returns a new object without the specified keys                          |
+| `isEmpty`         | `(value) → boolean`              | `true` for `null`, `undefined`, `""`, `[]`, `{}`                         |
+| `isEqual`         | `(a, b) → boolean`               | Deep structural equality — handles objects, arrays, and Dates            |
+| `hasEqualProps`   | `(oldProps, newProps) → boolean` | Deep equality ignoring function-valued keys; ideal for `React.memo`      |
+| `isNonEmptyArray` | `(arr) → boolean`                | `true` only when the value is an array with at least one element         |
+| `flattenObject`   | `(obj, prefix?) → object`        | Collapses nested object to dot-notation keys                             |
+| `groupBy`         | `(array, key) → object`          | Groups array items into an object of arrays keyed by a field or function |
+| `keyBy`           | `(array, key) → object`          | Converts an array into a lookup object keyed by a field or function      |
+| `uniqueBy`        | `(array, key) → array`           | Removes duplicates by a field or function; first occurrence wins         |
+| `sortBy`          | `(array, key) → array`           | Ascending sort by a field or function; non-mutating                      |
+| `chunk`           | `(array, size) → array[]`        | Splits array into consecutive chunks of the given size                   |
+
+### String Utilities
+
+| Function            | Signature               | Description                                                         |
+| ------------------- | ----------------------- | ------------------------------------------------------------------- |
+| `capitalize`        | `(str) → string`        | Uppercases first character, lowercases the rest                     |
+| `titleCase`         | `(str) → string`        | Capitalizes the first letter of every word                          |
+| `camelCase`         | `(str) → string`        | Converts to `camelCase` from spaces, hyphens, or underscores        |
+| `snakeCase`         | `(str) → string`        | Converts to `snake_case` from camelCase, spaces, or hyphens         |
+| `kebabCase`         | `(str) → string`        | Converts to `kebab-case` from camelCase, spaces, or underscores     |
+| `truncate`          | `(str, limit) → string` | Trims to `limit` characters and appends `…`                         |
+| `slugify`           | `(str) → string`        | URL-safe slug — strips diacritics, removes special chars            |
+| `removeExtraSpaces` | `(str) → string`        | Trims and collapses internal whitespace runs to a single space      |
+| `maskEmail`         | `(str) → string`        | Shows only the first character of the local part, e.g. `j***@x.com` |
+| `maskPhone`         | `(str) → string`        | Masks all digits except the last four; preserves formatting chars   |
+| `generateInitials`  | `(name) → string`       | Extracts uppercased first letter of each word, e.g. `"JD"`          |
 
 ## 🌱 Features
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "meticulous-ui",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "license": "MIT",
   "description": "A comprehensive React UI component library with a wide range of customizable components, icons, colors, and utilities for building modern web applications.",
   "main": "./index.js",

package/utils/camelCase.js

@@ -0,0 +1,4 @@
+const a = (e) => typeof e != "string" ? e : e.trim().toLowerCase().replace(/[-_\s]+(.)?/g, (r, t) => t ? t.toUpperCase() : "");
+export {
+  a as default
+};

package/utils/{capFirstLetter.js → capitalize.js}

@@ -1,4 +1,4 @@
-const t = (e) => typeof e != "string" || e.length === 0 ? e : e.charAt(0).toUpperCase() + e.slice(1);
+const t = (e) => typeof e != "string" || e.length === 0 ? e : e.charAt(0).toUpperCase() + e.slice(1).toLowerCase();
 export {
   t as default
 };

package/utils/chunk.js

@@ -0,0 +1,9 @@
+const s = (e, l) => {
+  const n = [];
+  for (let t = 0; t < e.length; t += l)
+    n.push(e.slice(t, t + l));
+  return n;
+};
+export {
+  s as default
+};

package/utils/deepClone.js

@@ -0,0 +1,4 @@
+const t = (e) => e === null || typeof e != "object" ? e : e instanceof Date ? new Date(e.getTime()) : Array.isArray(e) ? e.map(t) : Object.fromEntries(Object.entries(e).map(([r, n]) => [r, t(n)]));
+export {
+  t as default
+};

package/utils/flattenObject.js

@@ -0,0 +1,7 @@
+const u = (o, r = "") => Object.entries(o).reduce((t, [s, e]) => {
+  const n = r ? `${r}.${s}` : s;
+  return e !== null && typeof e == "object" && !Array.isArray(e) ? Object.assign(t, u(e, n)) : t[n] = e, t;
+}, {});
+export {
+  u as default
+};

package/utils/generateInitials.js

@@ -0,0 +1,4 @@
+const e = (t) => typeof t != "string" ? t : t.trim().split(/\s+/).filter(Boolean).map((r) => r.charAt(0).toUpperCase()).join("");
+export {
+  e as default
+};

package/utils/groupBy.js

@@ -0,0 +1,7 @@
+const s = (r, o) => r.reduce((n, t) => {
+  const u = typeof o == "function" ? o(t) : t[o];
+  return (n[u] ?? (n[u] = [])).push(t), n;
+}, {});
+export {
+  s as default
+};

package/utils/index.js

@@ -1,13 +1,62 @@
-import o from "./capFirstLetter.js";
-import r from "./compose.js";
-import t from "./hasEqualProps.js";
-import m from "./isNonEmptyArray.js";
-const e = {
-  capFirstLetter: o,
-  compose: r,
-  hasEqualProps: t,
-  isNonEmptyArray: m
+import r from "./capitalize.js";
+import o from "./camelCase.js";
+import m from "./chunk.js";
+import t from "./compose.js";
+import i from "./deepClone.js";
+import p from "./flattenObject.js";
+import e from "./generateInitials.js";
+import f from "./groupBy.js";
+import a from "./hasEqualProps.js";
+import s from "./isEmpty.js";
+import n from "./isEqual.js";
+import l from "./isNonEmptyArray.js";
+import c from "./kebabCase.js";
+import u from "./keyBy.js";
+import y from "./maskEmail.js";
+import k from "./maskPhone.js";
+import E from "./mergeDeep.js";
+import d from "./omit.js";
+import C from "./pick.js";
+import g from "./randomInt.js";
+import B from "./randomValue.js";
+import b from "./removeExtraSpaces.js";
+import h from "./slugify.js";
+import q from "./snakeCase.js";
+import x from "./sortBy.js";
+import I from "./titleCase.js";
+import P from "./truncate.js";
+import j from "./uniqueBy.js";
+const mr = {
+  capFirstLetter: r,
+  capitalize: r,
+  camelCase: o,
+  chunk: m,
+  compose: t,
+  deepClone: i,
+  flattenObject: p,
+  generateInitials: e,
+  groupBy: f,
+  hasEqualProps: a,
+  isEmpty: s,
+  isEqual: n,
+  isNonEmptyArray: l,
+  kebabCase: c,
+  keyBy: u,
+  maskEmail: y,
+  maskPhone: k,
+  mergeDeep: E,
+  omit: d,
+  pick: C,
+  randomInt: g,
+  randomValue: B,
+  removeExtraSpaces: b,
+  slugify: h,
+  snakeCase: q,
+  sortBy: x,
+  titleCase: I,
+  truncate: P,
+  uniqueBy: j
 };
 export {
-  e as default
+  mr as default
 };

package/utils/isEmpty.js

@@ -0,0 +1,4 @@
+const r = (t) => t == null ? !0 : typeof t == "string" || Array.isArray(t) ? t.length === 0 : typeof t == "object" ? Object.keys(t).length === 0 : !1;
+export {
+  r as default
+};

package/utils/isEqual.js

@@ -0,0 +1,10 @@
+const f = (e, t) => {
+  if (e === t) return !0;
+  if (e instanceof Date && t instanceof Date) return e.getTime() === t.getTime();
+  if (typeof e != "object" || typeof t != "object" || e === null || t === null || Array.isArray(e) !== Array.isArray(t)) return !1;
+  const r = Object.keys(e), s = Object.keys(t);
+  return r.length !== s.length ? !1 : r.every((n) => f(e[n], t[n]));
+};
+export {
+  f as default
+};

package/utils/kebabCase.js

@@ -0,0 +1,4 @@
+const a = (e) => typeof e != "string" ? e : e.trim().replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[_\s]+/g, "-").toLowerCase();
+export {
+  a as default
+};

package/utils/keyBy.js

@@ -0,0 +1,4 @@
+const u = (t, n) => t.reduce((r, o) => (r[typeof n == "function" ? n(o) : o[n]] = o, r), {});
+export {
+  u as default
+};

package/utils/maskEmail.js

@@ -0,0 +1,8 @@
+const e = (t) => {
+  if (typeof t != "string") return t;
+  const [n, a] = t.split("@");
+  return a ? n.charAt(0) + "***@" + a : t;
+};
+export {
+  e as default
+};

package/utils/maskPhone.js

@@ -0,0 +1,9 @@
+const o = (e) => {
+  if (typeof e != "string") return e;
+  const t = e.replace(/\D/g, ""), a = Math.max(0, t.length - 4);
+  let n = 0;
+  return e.replace(/\d/g, () => n++ < a ? "*" : t[n - 1]);
+};
+export {
+  o as default
+};

package/utils/mergeDeep.js

@@ -0,0 +1,9 @@
+const s = (e) => e !== null && typeof e == "object" && !Array.isArray(e), l = (e, n) => {
+  const o = { ...e };
+  for (const t of Object.keys(n))
+    o[t] = s(e[t]) && s(n[t]) ? l(e[t], n[t]) : n[t];
+  return o;
+};
+export {
+  l as default
+};

package/utils/omit.js

@@ -0,0 +1,7 @@
+const n = (t, e) => {
+  const r = new Set(e);
+  return Object.fromEntries(Object.entries(t).filter(([s]) => !r.has(s)));
+};
+export {
+  n as default
+};

package/utils/pick.js

@@ -0,0 +1,4 @@
+const r = (e, i) => Object.fromEntries(i.filter((t) => t in e).map((t) => [t, e[t]]));
+export {
+  r as default
+};

package/utils/randomInt.js

@@ -0,0 +1,5 @@
+import t from "./randomValue.js";
+const n = (o, r) => Math.floor(t(o, r));
+export {
+  n as default
+};

package/utils/randomValue.js

@@ -0,0 +1,4 @@
+const t = (a, r) => Math.random() * (r - a + 1) + a;
+export {
+  t as default
+};

package/utils/removeExtraSpaces.js

@@ -0,0 +1,4 @@
+const r = (e) => typeof e != "string" ? e : e.trim().replace(/\s+/g, " ");
+export {
+  r as default
+};

package/utils/slugify.js

@@ -0,0 +1,4 @@
+const r = (e) => typeof e != "string" ? e : e.trim().toLowerCase().normalize("NFD").replace(/[̀-ͯ]/g, "").replace(/[^a-z0-9\s-]/g, "").replace(/\s+/g, "-").replace(/-+/g, "-");
+export {
+  r as default
+};

package/utils/snakeCase.js

@@ -0,0 +1,4 @@
+const a = (e) => typeof e != "string" ? e : e.trim().replace(/([a-z])([A-Z])/g, "$1_$2").replace(/[-\s]+/g, "_").toLowerCase();
+export {
+  a as default
+};

package/utils/sortBy.js

@@ -0,0 +1,7 @@
+const r = (f, t) => [...f].sort((o, n) => {
+  const s = typeof t == "function" ? t(o) : o[t], c = typeof t == "function" ? t(n) : n[t];
+  return s < c ? -1 : s > c ? 1 : 0;
+});
+export {
+  r as default
+};

package/utils/titleCase.js

@@ -0,0 +1,4 @@
+const a = (e) => typeof e != "string" ? e : e.toLowerCase().split(" ").map((t) => t.charAt(0).toUpperCase() + t.slice(1)).join(" ");
+export {
+  a as default
+};

package/utils/truncate.js

@@ -0,0 +1,4 @@
+const t = (e, n) => typeof e != "string" || e.length <= n ? e : e.slice(0, n) + "…";
+export {
+  t as default
+};

package/utils/uniqueBy.js

@@ -0,0 +1,10 @@
+const s = (u, t) => {
+  const e = /* @__PURE__ */ new Set();
+  return u.filter((n) => {
+    const r = typeof t == "function" ? t(n) : n[t];
+    return e.has(r) ? !1 : (e.add(r), !0);
+  });
+};
+export {
+  s as default
+};