@splendidlabz/utils 1.12.0 → 1.13.0

package/dist/esm/lib/strings/pluralize.js

@@ -1,5 +1,368 @@
-import pluralizeLib from "pluralize";
-const pluralize = pluralizeLib;
+function sanitizeRule(rule) {
+  if (typeof rule === "string") return new RegExp("^" + rule + "$", "i");
+  return rule;
+}
+function restoreCase(word, token) {
+  if (word === token) return token;
+  if (word === word.toLowerCase()) return token.toLowerCase();
+  if (word === word.toUpperCase()) return token.toUpperCase();
+  if (word[0] === word[0].toUpperCase()) {
+    return token.charAt(0).toUpperCase() + token.substr(1).toLowerCase();
+  }
+  return token.toLowerCase();
+}
+function interpolate(str, args) {
+  return str.replace(/\$(\d{1,2})/g, (match, index) => args[index] || "");
+}
+function replace(word, rule) {
+  return word.replace(rule[0], function(match, index) {
+    const result = interpolate(rule[1], arguments);
+    if (match === "") return restoreCase(word[index - 1], result);
+    return restoreCase(match, result);
+  });
+}
+function sanitizeWord(token, word, rules, uncountables) {
+  if (!token.length || uncountables.hasOwnProperty(token)) return word;
+  let len = rules.length;
+  while (len--) {
+    const rule = rules[len];
+    if (rule[0].test(word)) return replace(word, rule);
+  }
+  return word;
+}
+function replaceWord(replaceMap, keepMap, rules, uncountables) {
+  return function(word) {
+    const token = word.toLowerCase();
+    if (keepMap.hasOwnProperty(token)) return restoreCase(word, token);
+    if (replaceMap.hasOwnProperty(token)) {
+      return restoreCase(word, replaceMap[token]);
+    }
+    return sanitizeWord(token, word, rules, uncountables);
+  };
+}
+function checkWord(replaceMap, keepMap, rules, uncountables) {
+  return function(word) {
+    const token = word.toLowerCase();
+    if (keepMap.hasOwnProperty(token)) return true;
+    if (replaceMap.hasOwnProperty(token)) return false;
+    return sanitizeWord(token, token, rules, uncountables) === token;
+  };
+}
+const BASE_IRREGULAR = [
+  // Pronouns.
+  ["I", "we"],
+  ["me", "us"],
+  ["he", "they"],
+  ["she", "they"],
+  ["them", "them"],
+  ["myself", "ourselves"],
+  ["yourself", "yourselves"],
+  ["itself", "themselves"],
+  ["herself", "themselves"],
+  ["himself", "themselves"],
+  ["themself", "themselves"],
+  ["is", "are"],
+  ["was", "were"],
+  ["has", "have"],
+  ["this", "these"],
+  ["that", "those"],
+  // Words ending with a consonant and `o`.
+  ["echo", "echoes"],
+  ["dingo", "dingoes"],
+  ["volcano", "volcanoes"],
+  ["tornado", "tornadoes"],
+  ["torpedo", "torpedoes"],
+  // Ends with `us`.
+  ["genus", "genera"],
+  ["viscus", "viscera"],
+  // Ends with `ma`.
+  ["stigma", "stigmata"],
+  ["stoma", "stomata"],
+  ["dogma", "dogmata"],
+  ["lemma", "lemmata"],
+  ["schema", "schemata"],
+  ["anathema", "anathemata"],
+  // Other irregular rules.
+  ["ox", "oxen"],
+  ["axe", "axes"],
+  ["die", "dice"],
+  ["yes", "yeses"],
+  ["foot", "feet"],
+  ["eave", "eaves"],
+  ["goose", "geese"],
+  ["tooth", "teeth"],
+  ["quiz", "quizzes"],
+  ["human", "humans"],
+  ["proof", "proofs"],
+  ["carve", "carves"],
+  ["valve", "valves"],
+  ["looey", "looies"],
+  ["thief", "thieves"],
+  ["groove", "grooves"],
+  ["pickaxe", "pickaxes"],
+  ["passerby", "passersby"]
+];
+const BASE_PLURAL = [
+  [/s?$/i, "s"],
+  // eslint-disable-next-line no-control-regex
+  [/[^\u0000-\u007F]$/i, "$0"],
+  [/([^aeiou]ese)$/i, "$1"],
+  [/(ax|test)is$/i, "$1es"],
+  [/(alias|[^aou]us|t[lm]as|gas|ris)$/i, "$1es"],
+  [/(e[mn]u)s?$/i, "$1s"],
+  [/([^l]ias|[aeiou]las|[ejzr]as|[iu]am)$/i, "$1"],
+  [
+    /(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$/i,
+    "$1i"
+  ],
+  [/(alumn|alg|vertebr)(?:a|ae)$/i, "$1ae"],
+  [/(seraph|cherub)(?:im)?$/i, "$1im"],
+  [/(her|at|gr)o$/i, "$1oes"],
+  [
+    /(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|automat|quor)(?:a|um)$/i,
+    "$1a"
+  ],
+  [
+    /(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)(?:a|on)$/i,
+    "$1a"
+  ],
+  [/sis$/i, "ses"],
+  [/(?:(kni|wi|li)fe|(ar|l|ea|eo|oa|hoo)f)$/i, "$1$2ves"],
+  [/([^aeiouy]|qu)y$/i, "$1ies"],
+  [/([^ch][ieo][ln])ey$/i, "$1ies"],
+  [/(x|ch|ss|sh|zz)$/i, "$1es"],
+  [/(matr|cod|mur|sil|vert|ind|append)(?:ix|ex)$/i, "$1ices"],
+  [/\b((?:tit)?m|l)(?:ice|ouse)$/i, "$1ice"],
+  [/(pe)(?:rson|ople)$/i, "$1ople"],
+  [/(child)(?:ren)?$/i, "$1ren"],
+  [/eaux$/i, "$0"],
+  [/m[ae]n$/i, "men"],
+  ["thou", "you"]
+];
+const BASE_SINGULAR = [
+  [/s$/i, ""],
+  [/(ss)$/i, "$1"],
+  [/(wi|kni|(?:after|half|high|low|mid|non|night|[^\w]|^)li)ves$/i, "$1fe"],
+  [/(ar|(?:wo|[ae])l|[eo][ao])ves$/i, "$1f"],
+  [/ies$/i, "y"],
+  [
+    /\b([pl]|zomb|(?:neck|cross)?t|coll|faer|food|gen|goon|group|lass|talk|goal|cut)ies$/i,
+    "$1ie"
+  ],
+  [/\b(mon|smil)ies$/i, "$1ey"],
+  [/\b((?:tit)?m|l)ice$/i, "$1ouse"],
+  [/(seraph|cherub)im$/i, "$1"],
+  [
+    /(x|ch|ss|sh|zz|tto|go|cho|alias|[^aou]us|t[lm]as|gas|(?:her|at|gr)o|[aeiou]ris)(?:es)?$/i,
+    "$1"
+  ],
+  [
+    /(analy|diagno|parenthe|progno|synop|the|empha|cri|ne)(?:sis|ses)$/i,
+    "$1sis"
+  ],
+  [/(movie|twelve|abuse|e[mn]u)s$/i, "$1"],
+  [/(test)(?:is|es)$/i, "$1is"],
+  [
+    /(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$/i,
+    "$1us"
+  ],
+  [
+    /(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|quor)a$/i,
+    "$1um"
+  ],
+  [
+    /(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)a$/i,
+    "$1on"
+  ],
+  [/(alumn|alg|vertebr)ae$/i, "$1a"],
+  [/(cod|mur|sil|vert|ind)ices$/i, "$1ex"],
+  [/(matr|append)ices$/i, "$1ix"],
+  [/(pe)(rson|ople)$/i, "$1rson"],
+  [/(child)ren$/i, "$1"],
+  [/(eau)x?$/i, "$1"],
+  [/men$/i, "man"]
+];
+const BASE_UNCOUNTABLE = [
+  // Singular words with no plurals.
+  "adulthood",
+  "advice",
+  "agenda",
+  "aid",
+  "aircraft",
+  "alcohol",
+  "ammo",
+  "analytics",
+  "anime",
+  "athletics",
+  "audio",
+  "bison",
+  "blood",
+  "bream",
+  "buffalo",
+  "butter",
+  "carp",
+  "cash",
+  "chassis",
+  "chess",
+  "clothing",
+  "cod",
+  "commerce",
+  "cooperation",
+  "corps",
+  "debris",
+  "diabetes",
+  "digestion",
+  "elk",
+  "energy",
+  "equipment",
+  "excretion",
+  "expertise",
+  "firmware",
+  "flounder",
+  "fun",
+  "gallows",
+  "garbage",
+  "graffiti",
+  "hardware",
+  "headquarters",
+  "health",
+  "herpes",
+  "highjinks",
+  "homework",
+  "housework",
+  "information",
+  "jeans",
+  "justice",
+  "kudos",
+  "labour",
+  "literature",
+  "machinery",
+  "mackerel",
+  "mail",
+  "media",
+  "mews",
+  "moose",
+  "music",
+  "mud",
+  "manga",
+  "news",
+  "only",
+  "personnel",
+  "pike",
+  "plankton",
+  "pliers",
+  "police",
+  "pollution",
+  "premises",
+  "rain",
+  "research",
+  "rice",
+  "salmon",
+  "scissors",
+  "series",
+  "sewage",
+  "shambles",
+  "shrimp",
+  "software",
+  "species",
+  "staff",
+  "swine",
+  "tennis",
+  "traffic",
+  "transportation",
+  "trout",
+  "tuna",
+  "wealth",
+  "welfare",
+  "whiting",
+  "wildebeest",
+  "wildlife",
+  "you",
+  /pok[eé]mon$/i,
+  // Regexes.
+  /[^aeiou]ese$/i,
+  // "chinese", "japanese"
+  /deer$/i,
+  // "deer", "reindeer"
+  /fish$/i,
+  // "fish", "blowfish", "angelfish"
+  /measles$/i,
+  /o[iu]s$/i,
+  // "carnivorous"
+  /pox$/i,
+  // "chickpox", "smallpox"
+  /sheep$/i
+];
+function createPluralize(config = {}) {
+  const pluralRules = [];
+  const singularRules = [];
+  const uncountables = {};
+  const irregularPlurals = {};
+  const irregularSingles = {};
+  for (const [single, plur] of [
+    ...BASE_IRREGULAR,
+    ...config.irregular || []
+  ]) {
+    irregularSingles[single.toLowerCase()] = plur.toLowerCase();
+    irregularPlurals[plur.toLowerCase()] = single.toLowerCase();
+  }
+  for (const [rule, replacement] of [...BASE_PLURAL, ...config.plural || []]) {
+    pluralRules.push([sanitizeRule(rule), replacement]);
+  }
+  for (const [rule, replacement] of [
+    ...BASE_SINGULAR,
+    ...config.singular || []
+  ]) {
+    singularRules.push([sanitizeRule(rule), replacement]);
+  }
+  for (const word of [...BASE_UNCOUNTABLE, ...config.uncountable || []]) {
+    if (typeof word === "string") {
+      uncountables[word.toLowerCase()] = true;
+    } else {
+      pluralRules.push([sanitizeRule(word), "$0"]);
+      singularRules.push([sanitizeRule(word), "$0"]);
+    }
+  }
+  const plural2 = replaceWord(
+    irregularSingles,
+    irregularPlurals,
+    pluralRules,
+    uncountables
+  );
+  const singular2 = replaceWord(
+    irregularPlurals,
+    irregularSingles,
+    singularRules,
+    uncountables
+  );
+  const isPlural2 = checkWord(
+    irregularSingles,
+    irregularPlurals,
+    pluralRules,
+    uncountables
+  );
+  const isSingular2 = checkWord(
+    irregularPlurals,
+    irregularSingles,
+    singularRules,
+    uncountables
+  );
+  function pluralize2(word, count, inclusive) {
+    const out = count === 1 ? singular2(word) : plural2(word);
+    return (inclusive ? count + " " : "") + out;
+  }
+  return Object.assign(pluralize2, { plural: plural2, singular: singular2, isPlural: isPlural2, isSingular: isSingular2 });
+}
+const pluralize = createPluralize();
+const plural = pluralize.plural;
+const singular = pluralize.singular;
+const isPlural = pluralize.isPlural;
+const isSingular = pluralize.isSingular;
 export {
-  pluralize
+  createPluralize,
+  isPlural,
+  isSingular,
+  plural,
+  pluralize,
+  singular
 };

package/dist/esm/lib/strings/query-string.js

@@ -29,16 +29,11 @@ function parseQueryString(string = "") {
   }
   return result;
 }
-function plural(count, noun, suffix = "s") {
-  console.warn("plural is deprecated. Use pluralize instead");
-  return `${count} ${noun}${count !== 1 ? suffix : ""}`;
-}
 function stripNumbers(string) {
   return string.replace(/\d*/, "");
 }
 export {
   parseQueryString,
-  plural,
   stripNumbers,
   toQueryString
 };

package/dist/esm/lib/style/index.js

@@ -1,12 +1,2 @@
-import { toKebab } from "../strings/convert-case/convert-case.js";
-function toStyleString(style) {
-  if (!style) return null;
-  if (typeof style === "string") return style;
-  return Object.entries(style).map(([k, v]) => {
-    if (k.startsWith("--")) return `${k}:${v}`;
-    else return `${toKebab(k)}:${v}`;
-  }).join("; ").concat(";");
-}
-export {
-  toStyleString
-};
+export * from "./scatter.js";
+export * from "./to-style-string.js";

package/dist/esm/lib/style/scatter.js

@@ -0,0 +1,25 @@
+import { seededRandom } from "../numbers/random.js";
+const round = (n) => {
+  const value = Math.round(n * 100) / 100;
+  return value === 0 ? 0 : value;
+};
+function scatter(count, options = {}) {
+  const { seed = 1, spread = 20, rotation = 6, amount = 1 } = options;
+  const random = seededRandom(seed);
+  const items = [];
+  for (let i = 0; i < count; i++) {
+    const x = round((random() - 0.5) * 2 * spread * amount);
+    const y = round((random() - 0.5) * 2 * spread * amount);
+    const r = round((random() - 0.5) * 2 * rotation * amount);
+    items.push({
+      x,
+      y,
+      rotation: r,
+      transform: `translate(${x}%, ${y}%) rotate(${r}deg)`
+    });
+  }
+  return items;
+}
+export {
+  scatter
+};

package/dist/esm/lib/style/to-style-string.js

@@ -0,0 +1,12 @@
+import { toKebab } from "../strings/convert-case/convert-case.js";
+function toStyleString(style) {
+  if (!style) return null;
+  if (typeof style === "string") return style;
+  return Object.entries(style).map(([k, v]) => {
+    if (k.startsWith("--")) return `${k}:${v}`;
+    else return `${toKebab(k)}:${v}`;
+  }).join("; ").concat(";");
+}
+export {
+  toStyleString
+};

package/dist/esm/lib/svg/displace.js

@@ -0,0 +1,68 @@
+const displacePresets = {
+  // Ink bleeding into absorbent paper. Long wavelength, small push.
+  "wet-ink": {
+    type: "fractalNoise",
+    frequency: 0.015,
+    octaves: 3,
+    scale: 9,
+    seed: 2
+  },
+  // Ink bitten into paper tooth. The edge roughens without the letterform
+  // moving, so this is the only preset that survives at body sizes.
+  letterpress: {
+    type: "fractalNoise",
+    frequency: 0.09,
+    octaves: 1,
+    scale: 2,
+    seed: 5
+  },
+  // Air over heat. Anisotropic so the shimmer rises instead of swimming.
+  // Reads as nothing unless animated.
+  "heat-haze": {
+    type: "fractalNoise",
+    frequency: [4e-3, 0.02],
+    animateTo: [6e-3, 0.03],
+    duration: 8,
+    octaves: 2,
+    scale: 7,
+    seed: 11
+  },
+  // Tracking error on worn tape. A near-infinite horizontal wavelength against
+  // a very short vertical one is what tears rather than blobs.
+  "bad-tape": {
+    type: "turbulence",
+    frequency: [8e-4, 0.06],
+    animateTo: [8e-4, 0.09],
+    duration: 2.5,
+    octaves: 1,
+    scale: 14,
+    seed: 3
+  },
+  // Past the shred threshold on purpose.
+  shred: {
+    type: "turbulence",
+    frequency: 0.055,
+    octaves: 2,
+    scale: 32,
+    seed: 7
+  }
+};
+const format = (f) => Array.isArray(f) ? f.join(" ") : String(f);
+function displaceSettings(opts = {}) {
+  const base = opts.preset && displacePresets[opts.preset] || displacePresets["wet-ink"];
+  const frequency = opts.frequency ?? base.frequency;
+  const animateTo = opts.animateTo ?? base.animateTo;
+  return {
+    type: opts.type ?? base.type,
+    frequency: format(frequency),
+    animateTo: animateTo ? format(animateTo) : null,
+    duration: opts.duration ?? base.duration ?? 6,
+    octaves: opts.octaves ?? base.octaves,
+    scale: opts.scale ?? base.scale,
+    seed: opts.seed ?? base.seed
+  };
+}
+export {
+  displacePresets,
+  displaceSettings
+};

package/dist/esm/lib/svg/index.js

@@ -0,0 +1,2 @@
+export * from "./displace.js";
+export * from "./noise.js";

package/dist/esm/lib/svg/noise.js

@@ -0,0 +1,16 @@
+import { hexToRgb } from "../colors.js";
+const noisePresets = {
+  black: "#000000",
+  sepia: "#a67c52",
+  synthwave: "#ff2bd6"
+};
+function noiseColorMatrix(color, strength) {
+  if (!color || color === "rainbow")
+    return `1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 ${strength} 0`;
+  const { r, g, b } = hexToRgb(noisePresets[color] ?? color);
+  return `0 0 0 0 ${r} 0 0 0 0 ${g} 0 0 0 0 ${b} 0 0 0 ${strength} 0`;
+}
+export {
+  noiseColorMatrix,
+  noisePresets
+};

package/dist/types/dom/font-size.d.cts

@@ -1,4 +1,4 @@
-declare function getUnit(value: any): any;
+declare function getUnit(value: any): string;
 declare function rem(multiple?: number): number;
 declare function em(element?: HTMLElement, multiple?: number): number;
 declare function rlh(multiple?: number): number;

package/dist/types/lib/colors.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Parse #rgb or #rrggbb into 0–1 channels (3dp, keeps the data URI short).
+ * @param {string} hex
+ * @returns {{r: number, g: number, b: number}}
+ */
+declare function hexToRgb(hex: string): {
+    r: number;
+    g: number;
+    b: number;
+};
+
+export { hexToRgb };

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

@@ -0,0 +1 @@
+export { statusText, statusTexts } from './status-text.cjs';

package/dist/types/lib/http/status-text.d.cts

@@ -0,0 +1,73 @@
+/**
+ * Reason phrase for an HTTP status code.
+ * @param {number} code - HTTP status code.
+ * @returns {string|undefined} The reason phrase, or undefined if unknown.
+ */
+declare function statusText(code: number): string | undefined;
+declare const statusTexts: {
+    100: string;
+    101: string;
+    102: string;
+    103: string;
+    200: string;
+    201: string;
+    202: string;
+    203: string;
+    204: string;
+    205: string;
+    206: string;
+    207: string;
+    208: string;
+    226: string;
+    300: string;
+    301: string;
+    302: string;
+    303: string;
+    304: string;
+    305: string;
+    307: string;
+    308: string;
+    400: string;
+    401: string;
+    402: string;
+    403: string;
+    404: string;
+    405: string;
+    406: string;
+    407: string;
+    408: string;
+    409: string;
+    410: string;
+    411: string;
+    412: string;
+    413: string;
+    414: string;
+    415: string;
+    416: string;
+    417: string;
+    418: string;
+    421: string;
+    422: string;
+    423: string;
+    424: string;
+    425: string;
+    426: string;
+    428: string;
+    429: string;
+    431: string;
+    451: string;
+    500: string;
+    501: string;
+    502: string;
+    503: string;
+    504: string;
+    505: string;
+    506: string;
+    507: string;
+    508: string;
+    509: string;
+    510: string;
+    511: string;
+};
+
+export { statusText, statusTexts };

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

@@ -6,6 +6,7 @@ export { splitArray } from './arrays/split-array.cjs';
 export { uniqueArray } from './arrays/unique.cjs';
 export { AuthManager, RouteManager } from './auth/route-manager.cjs';
 export { getType, isArray, isFunction, isObject, notObject } from './checks.cjs';
+export { hexToRgb } from './colors.cjs';
 export { DAYS } from './date/days.cjs';
 export { MONTHS } from './date/months.cjs';
 export { getTimeInMs, ms, toDays, toHours, toMinutes, toReadableTime, toSeconds, toWeeks } from './date/time.cjs';
@@ -17,7 +18,10 @@ export { compose, composeAsync, curry, pipe, pipeAsync, times } from './function
 export { throttle } from './functions/throttle.cjs';
 export { delay, timeout, wait } from './functions/timeout.cjs';
 export { isHashedValue } from './hash.cjs';
-export { splitUnit } from './numbers/index.cjs';
+export { statusText, statusTexts } from './http/status-text.cjs';
+export { toDegrees, toRadians } from './numbers/math.cjs';
+export { seededRandom } from './numbers/random.cjs';
+export { splitUnit } from './numbers/split-unit.cjs';
 export { camelCaseKeys } from './objects/camelcase-keys.cjs';
 export { isEmpty, notEmpty } from './objects/empty.cjs';
 export { isEqual, notEqual } from './objects/equal.cjs';
@@ -36,8 +40,10 @@ export { createSSE, parseSSE } from './sse.cjs';
 export { toCamel, toKebab, toLower, toPascal, toSentence, toSlug, toTitle, toUpper } from './strings/convert-case/convert-case.cjs';
 export { markdown, treatMarkdownWhitespace } from './strings/markdown.cjs';
 export { parseFullName } from './strings/name.cjs';
-export { pluralize } from './strings/pluralize.cjs';
-export { parseQueryString, plural, stripNumbers, toQueryString } from './strings/query-string.cjs';
-export { toStyleString } from './style/index.cjs';
+export { createPluralize, isPlural, isSingular, plural, pluralize, singular } from './strings/pluralize.cjs';
+export { parseQueryString, stripNumbers, toQueryString } from './strings/query-string.cjs';
+export { ScatterItem, scatter } from './style/scatter.cjs';
+export { toStyleString } from './style/to-style-string.cjs';
+export { DisplacePreset, displacePresets, displaceSettings } from './svg/displace.cjs';
+export { noiseColorMatrix, noisePresets } from './svg/noise.cjs';
 export { getSymbol, getSymbolValue } from './symbols/symbols.cjs';
-export { toDegrees, toRadians } from './numbers/math.cjs';

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

@@ -1,5 +1,3 @@
 export { toDegrees, toRadians } from './math.cjs';
-
-declare function splitUnit(string: any): any[];
-
-export { splitUnit };
+export { seededRandom } from './random.cjs';
+export { splitUnit } from './split-unit.cjs';

package/dist/types/lib/numbers/random.d.cts

@@ -0,0 +1,14 @@
+/**
+ * Deterministic pseudo-random generator.
+ *
+ * Math.random() runs once on the server and again on the client, so anything
+ * built from it disagrees between SSR and hydration and jumps on load. Seeding
+ * makes both passes produce the same sequence. Change the seed for a different
+ * arrangement.
+ *
+ * @param {number} [seed]
+ * @returns {() => number} Generator returning a value in [0, 1)
+ */
+declare function seededRandom(seed?: number): () => number;
+
+export { seededRandom };