@splendidlabz/utils 1.12.0 → 1.13.0

package/dist/types/lib/numbers/split-unit.d.cts

@@ -0,0 +1,8 @@
+/**
+ * Splits a value into its numeric part and unit.
+ * @param {string|number} string - Value like `'2rem'`, `'30 days'`, or a plain number.
+ * @returns {[number, string|null]} `[value, unit]` — unit is null when there isn't one.
+ */
+declare function splitUnit(string: string | number): [number, string | null];
+
+export { splitUnit };

package/dist/types/lib/strings/index.d.cts

@@ -1,5 +1,5 @@
 export { toCamel, toKebab, toLower, toPascal, toSentence, toSlug, toTitle, toUpper } from './convert-case/convert-case.cjs';
 export { markdown, treatMarkdownWhitespace } from './markdown.cjs';
 export { parseFullName } from './name.cjs';
-export { pluralize } from './pluralize.cjs';
-export { parseQueryString, plural, stripNumbers, toQueryString } from './query-string.cjs';
+export { createPluralize, isPlural, isSingular, plural, pluralize, singular } from './pluralize.cjs';
+export { parseQueryString, stripNumbers, toQueryString } from './query-string.cjs';

package/dist/types/lib/strings/pluralize.d.cts

@@ -1,3 +1,25 @@
-declare const pluralize: any;
+/**
+ * Create a pluralizer with its own rule tables. Config rules are appended to
+ * the English base and take precedence (newest matching rule wins).
+ *
+ * @param  {Object} [config]
+ * @param  {Array}  [config.plural]      - `[rule, replacement]` pairs.
+ * @param  {Array}  [config.singular]    - `[rule, replacement]` pairs.
+ * @param  {Array}  [config.irregular]   - `[single, plural]` pairs.
+ * @param  {Array}  [config.uncountable] - words or regexes with no plural.
+ * @return {Function} A callable `pluralize` with `.plural`, `.singular`,
+ *                    `.isPlural`, `.isSingular` attached.
+ */
+declare function createPluralize(config?: {
+    plural?: any[];
+    singular?: any[];
+    irregular?: any[];
+    uncountable?: any[];
+}): Function;
+declare const pluralize: Function;
+declare const plural: any;
+declare const singular: any;
+declare const isPlural: any;
+declare const isSingular: any;
 
-export { pluralize };
+export { createPluralize, isPlural, isSingular, plural, pluralize, singular };

package/dist/types/lib/strings/query-string.d.cts

@@ -13,7 +13,6 @@ declare function toQueryString(object: any): string;
  * @returns {Object}
  */
 declare function parseQueryString(string?: string): any;
-declare function plural(count: any, noun: any, suffix?: string): string;
 declare function stripNumbers(string: any): any;
 
-export { parseQueryString, plural, stripNumbers, toQueryString };
+export { parseQueryString, stripNumbers, toQueryString };

package/dist/types/lib/style/index.d.cts

@@ -1,3 +1,2 @@
-declare function toStyleString(style: any): string;
-
-export { toStyleString };
+export { ScatterItem, scatter } from './scatter.cjs';
+export { toStyleString } from './to-style-string.cjs';

package/dist/types/lib/style/scatter.d.cts

@@ -0,0 +1,48 @@
+/**
+ * @typedef {Object} ScatterItem
+ * @property {number} x Horizontal offset, in % of the element's own size
+ * @property {number} y Vertical offset, in % of the element's own size
+ * @property {number} rotation Rotation in degrees
+ * @property {string} transform Ready-to-use CSS transform value
+ */
+/**
+ * Places elements off a perfect grid so they read as laid down by hand rather
+ * than generated. Offsets are in % so they scale with the element.
+ *
+ * Seeded, so the same seed always produces the same arrangement — which is what
+ * keeps SSR and hydration in agreement.
+ *
+ * @param {number} count Number of elements to place
+ * @param {Object} [options]
+ * @param {number} [options.seed] Change for a different arrangement
+ * @param {number} [options.spread] Max offset, in % of the element's own size
+ * @param {number} [options.rotation] Max rotation in degrees
+ * @param {number} [options.amount] 0–1 dial over both spread and rotation
+ * @returns {ScatterItem[]}
+ */
+declare function scatter(count: number, options?: {
+    seed?: number;
+    spread?: number;
+    rotation?: number;
+    amount?: number;
+}): ScatterItem[];
+type ScatterItem = {
+    /**
+     * Horizontal offset, in % of the element's own size
+     */
+    x: number;
+    /**
+     * Vertical offset, in % of the element's own size
+     */
+    y: number;
+    /**
+     * Rotation in degrees
+     */
+    rotation: number;
+    /**
+     * Ready-to-use CSS transform value
+     */
+    transform: string;
+};
+
+export { type ScatterItem, scatter };

package/dist/types/lib/style/to-style-string.d.cts

@@ -0,0 +1,8 @@
+/**
+ * Converts a style object into a CSS style string. Passes strings through untouched.
+ * @param {string|Object} style - Style string or object of camelCase/custom properties.
+ * @returns {string|null} CSS style string, or null if no style given.
+ */
+declare function toStyleString(style: string | any): string | null;
+
+export { toStyleString };

package/dist/types/lib/svg/displace.d.cts

@@ -0,0 +1,54 @@
+/**
+ * Merge a preset with explicit overrides. Explicit always wins.
+ * @param {Partial<DisplacePreset> & { preset?: string }} [opts]
+ */
+declare function displaceSettings(opts?: Partial<DisplacePreset> & {
+    preset?: string;
+}): {
+    type: string;
+    frequency: string;
+    animateTo: string;
+    duration: number;
+    octaves: number;
+    scale: number;
+    seed: number;
+};
+/**
+ * Two numbers govern the effect.
+ *
+ *   frequency — wavelength of the distortion, roughly (1 / frequency) px
+ *   scale     — how far each pixel is pushed
+ *
+ * Their ratio decides the outcome. Once scale approaches the wavelength,
+ * neighbouring pixels displace past each other and the form comes apart.
+ *
+ *   scale < wavelength × 0.25   warp     — shape survives, edges soften
+ *   scale ≈ wavelength × 0.5    distress — edges tear, holes open
+ *   scale > wavelength          shred    — shape is destroyed
+ *
+ * type='fractalNoise' is smooth and symmetric — warps.
+ * type='turbulence' takes the absolute value, so it creases — wisps and tears.
+ */
+/**
+ * @typedef {Object} DisplacePreset
+ * @property {string} type
+ * @property {number|number[]} frequency
+ * @property {number|number[]} [animateTo]
+ * @property {number} [duration]
+ * @property {number} octaves
+ * @property {number} scale
+ * @property {number} seed
+ */
+/** @type {Record<string, DisplacePreset>} */
+declare const displacePresets: Record<string, DisplacePreset>;
+type DisplacePreset = {
+    type: string;
+    frequency: number | number[];
+    animateTo?: number | number[];
+    duration?: number;
+    octaves: number;
+    scale: number;
+    seed: number;
+};
+
+export { type DisplacePreset, displacePresets, displaceSettings };

package/dist/types/lib/svg/index.d.cts

@@ -0,0 +1,2 @@
+export { DisplacePreset, displacePresets, displaceSettings } from './displace.cjs';
+export { noiseColorMatrix, noisePresets } from './noise.cjs';

package/dist/types/lib/svg/noise.d.cts

@@ -0,0 +1,24 @@
+/**
+ * Build the feColorMatrix values for a noise colour.
+ *
+ * feTurbulence outputs independent noise per RGB channel, so colour is the
+ * natural state — the matrix decides what survives:
+ * - no color or 'rainbow' → RGB passes through: coloured static (default)
+ * - preset name ('black', 'sepia', 'synthwave') or hex → constant tint,
+ *   alpha still noise-driven
+ *
+ * strength scales the per-pixel alpha. 0–1 fades the grain; above 1 the
+ * alpha saturates, so the grain gets denser rather than stronger.
+ *
+ * @param {string} [color] - 'rainbow' (default), a preset name, or a hex colour.
+ * @param {number} strength - Per-pixel alpha multiplier.
+ * @returns {string}
+ */
+declare function noiseColorMatrix(color?: string, strength: number): string;
+declare namespace noisePresets {
+    let black: string;
+    let sepia: string;
+    let synthwave: string;
+}
+
+export { noiseColorMatrix, noisePresets };

package/dist/types/node/dirname.d.cts

@@ -3,7 +3,7 @@
  * @param url — import.meta.url
  * @returns
  */
-declare function __dirname$1(url: any): string;
-declare function dirname(url: any): string;
+declare function __dirname$1(url: any): any;
+declare function dirname(url: any): any;
 
 export { __dirname$1 as __dirname, dirname };

package/dist/types/node/file.d.cts

@@ -1,4 +1,4 @@
-declare function mkdir(path: any): Promise<string>;
+declare function mkdir(path: any): Promise<any>;
 declare function copyFile(from: any, to: any): Promise<void>;
 
 export { copyFile, mkdir };

package/dist/types/node/hash.d.cts

@@ -1,3 +1,3 @@
-declare function sha256Hash(string: any): string;
+declare function sha256Hash(string: any): any;
 
 export { sha256Hash };

package/dist/types/node/pkce.d.cts

@@ -1,7 +1,7 @@
 declare function PKCE(): Promise<{
-    state: string;
-    code_verifier: string;
-    code_challenge: string;
+    state: any;
+    code_verifier: any;
+    code_challenge: any;
     code_challenge_method: string;
 }>;
 /**
@@ -9,6 +9,6 @@ declare function PKCE(): Promise<{
  * @param {string} verifier
  * @returns string
  */
-declare function getCodeChallenge(verifier: string): string;
+declare function getCodeChallenge(verifier: string): any;
 
 export { PKCE, getCodeChallenge };

package/dist/types/node/random-string.d.cts

@@ -1,3 +1,3 @@
-declare function randomString(length?: number): string;
+declare function randomString(length?: number): any;
 
 export { randomString };

package/dist/types/node/uuid.d.cts

@@ -1,3 +1,3 @@
-declare function uuid(): `${string}-${string}-${string}-${string}-${string}`;
+declare function uuid(): any;
 
 export { uuid };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splendidlabz/utils",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "",
   "type": "module",
   "homepage": "https://splendidlabz.com/docs/utils",
@@ -64,13 +64,10 @@
     "marked": "^18.0.2",
     "marked-gfm-heading-id": "^4.1.4",
     "marked-mangle": "^1.1.13",
-    "pluralize": "^8.0.0",
-    "sanitize-html": "^2.17.3",
-    "statuses": "^2.0.2"
+    "sanitize-html": "^2.17.3"
   },
   "devDependencies": {
-    "@splendidlabz/eslint-config": "2.1.5",
-    "jsdom": "^29.0.2",
+    "@splendidlabz/eslint-config": "2.1.6",
     "np": "^11.1.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",