@stryke/helpers 0.1.0

package/dist/remove-accents.mjs

@@ -0,0 +1 @@
+export const characterMap={\u00C0:"A",\u00C1:"A",\u00C2:"A",\u00C3:"A",\u00C4:"A",\u00C5:"A",\u1EA4:"A",\u1EAE:"A",\u1EB2:"A",\u1EB4:"A",\u1EB6:"A",\u00C6:"AE",\u1EA6:"A",\u1EB0:"A",\u0202:"A",\u00C7:"C",\u1E08:"C",\u00C8:"E",\u00C9:"E",\u00CA:"E",\u00CB:"E",\u1EBE:"E",\u1E16:"E",\u1EC0:"E",\u1E14:"E",\u1E1C:"E",\u0206:"E",\u00CC:"I",\u00CD:"I",\u00CE:"I",\u00CF:"I",\u1E2E:"I",\u020A:"I",\u00D0:"D",\u00D1:"N",\u00D2:"O",\u00D3:"O",\u00D4:"O",\u00D5:"O",\u00D6:"O",\u00D8:"O",\u1ED0:"O",\u1E4C:"O",\u1E52:"O",\u020E:"O",\u00D9:"U",\u00DA:"U",\u00DB:"U",\u00DC:"U",\u00DD:"Y",\u00E0:"a",\u00E1:"a",\u00E2:"a",\u00E3:"a",\u00E4:"a",\u00E5:"a",\u1EA5:"a",\u1EAF:"a",\u1EB3:"a",\u1EB5:"a",\u1EB7:"a",\u00E6:"ae",\u1EA7:"a",\u1EB1:"a",\u0203:"a",\u00E7:"c",\u1E09:"c",\u00E8:"e",\u00E9:"e",\u00EA:"e",\u00EB:"e",\u1EBF:"e",\u1E17:"e",\u1EC1:"e",\u1E15:"e",\u1E1D:"e",\u0207:"e",\u00EC:"i",\u00ED:"i",\u00EE:"i",\u00EF:"i",\u1E2F:"i",\u020B:"i",\u00F0:"d",\u00F1:"n",\u00F2:"o",\u00F3:"o",\u00F4:"o",\u00F5:"o",\u00F6:"o",\u00F8:"o",\u1ED1:"o",\u1E4D:"o",\u1E53:"o",\u020F:"o",\u00F9:"u",\u00FA:"u",\u00FB:"u",\u00FC:"u",\u00FD:"y",\u00FF:"y",\u0100:"A",\u0101:"a",\u0102:"A",\u0103:"a",\u0104:"A",\u0105:"a",\u0106:"C",\u0107:"c",\u0108:"C",\u0109:"c",\u010A:"C",\u010B:"c",\u010C:"C",\u010D:"c",C\u0306:"C",c\u0306:"c",\u010E:"D",\u010F:"d",\u0110:"D",\u0111:"d",\u0112:"E",\u0113:"e",\u0114:"E",\u0115:"e",\u0116:"E",\u0117:"e",\u0118:"E",\u0119:"e",\u011A:"E",\u011B:"e",\u011C:"G",\u01F4:"G",\u011D:"g",\u01F5:"g",\u011E:"G",\u011F:"g",\u0120:"G",\u0121:"g",\u0122:"G",\u0123:"g",\u0124:"H",\u0125:"h",\u0126:"H",\u0127:"h",\u1E2A:"H",\u1E2B:"h",\u0128:"I",\u0129:"i",\u012A:"I",\u012B:"i",\u012C:"I",\u012D:"i",\u012E:"I",\u012F:"i",\u0130:"I",\u0131:"i",\u0132:"IJ",\u0133:"ij",\u0134:"J",\u0135:"j",\u0136:"K",\u0137:"k",\u1E30:"K",\u1E31:"k",K\u0306:"K",k\u0306:"k",\u0139:"L",\u013A:"l",\u013B:"L",\u013C:"l",\u013D:"L",\u013E:"l",\u013F:"L",\u0140:"l",\u0141:"l",\u0142:"l",\u1E3E:"M",\u1E3F:"m",M\u0306:"M",m\u0306:"m",\u0143:"N",\u0144:"n",\u0145:"N",\u0146:"n",\u0147:"N",\u0148:"n",\u0149:"n",N\u0306:"N",n\u0306:"n",\u014C:"O",\u014D:"o",\u014E:"O",\u014F:"o",\u0150:"O",\u0151:"o",\u0152:"OE",\u0153:"oe",P\u0306:"P",p\u0306:"p",\u0154:"R",\u0155:"r",\u0156:"R",\u0157:"r",\u0158:"R",\u0159:"r",R\u0306:"R",r\u0306:"r",\u0212:"R",\u0213:"r",\u015A:"S",\u015B:"s",\u015C:"S",\u015D:"s",\u015E:"S",\u0218:"S",\u0219:"s",\u015F:"s",\u0160:"S",\u0161:"s",\u0162:"T",\u0163:"t",\u021B:"t",\u021A:"T",\u0164:"T",\u0165:"t",\u0166:"T",\u0167:"t",T\u0306:"T",t\u0306:"t",\u0168:"U",\u0169:"u",\u016A:"U",\u016B:"u",\u016C:"U",\u016D:"u",\u016E:"U",\u016F:"u",\u0170:"U",\u0171:"u",\u0172:"U",\u0173:"u",\u0216:"U",\u0217:"u",V\u0306:"V",v\u0306:"v",\u0174:"W",\u0175:"w",\u1E82:"W",\u1E83:"w",X\u0306:"X",x\u0306:"x",\u0176:"Y",\u0177:"y",\u0178:"Y",Y\u0306:"Y",y\u0306:"y",\u0179:"Z",\u017A:"z",\u017B:"Z",\u017C:"z",\u017D:"Z",\u017E:"z",\u017F:"s",\u0192:"f",\u01A0:"O",\u01A1:"o",\u01AF:"U",\u01B0:"u",\u01CD:"A",\u01CE:"a",\u01CF:"I",\u01D0:"i",\u01D1:"O",\u01D2:"o",\u01D3:"U",\u01D4:"u",\u01D5:"U",\u01D6:"u",\u01D7:"U",\u01D8:"u",\u01D9:"U",\u01DA:"u",\u01DB:"U",\u01DC:"u",\u1EE8:"U",\u1EE9:"u",\u1E78:"U",\u1E79:"u",\u01FA:"A",\u01FB:"a",\u01FC:"AE",\u01FD:"ae",\u01FE:"O",\u01FF:"o",\u00DE:"TH",\u00FE:"th",\u1E54:"P",\u1E55:"p",\u1E64:"S",\u1E65:"s",X\u0301:"X",x\u0301:"x",\u0403:"\u0413",\u0453:"\u0433",\u040C:"\u041A",\u045C:"\u043A",A\u030B:"A",a\u030B:"a",E\u030B:"E",e\u030B:"e",I\u030B:"I",i\u030B:"i",\u01F8:"N",\u01F9:"n",\u1ED2:"O",\u1ED3:"o",\u1E50:"O",\u1E51:"o",\u1EEA:"U",\u1EEB:"u",\u1E80:"W",\u1E81:"w",\u1EF2:"Y",\u1EF3:"y",\u0200:"A",\u0201:"a",\u0204:"E",\u0205:"e",\u0208:"I",\u0209:"i",\u020C:"O",\u020D:"o",\u0210:"R",\u0211:"r",\u0214:"U",\u0215:"u",B\u030C:"B",b\u030C:"b",\u010C\u0323:"C",\u010D\u0323:"c",\u00CA\u030C:"E",\u00EA\u030C:"e",F\u030C:"F",f\u030C:"f",\u01E6:"G",\u01E7:"g",\u021E:"H",\u021F:"h",J\u030C:"J",\u01F0:"j",\u01E8:"K",\u01E9:"k",M\u030C:"M",m\u030C:"m",P\u030C:"P",p\u030C:"p",Q\u030C:"Q",q\u030C:"q",\u0158\u0329:"R",\u0159\u0329:"r",\u1E66:"S",\u1E67:"s",V\u030C:"V",v\u030C:"v",W\u030C:"W",w\u030C:"w",X\u030C:"X",x\u030C:"x",Y\u030C:"Y",y\u030C:"y",A\u0327:"A",a\u0327:"a",B\u0327:"B",b\u0327:"b",\u1E10:"D",\u1E11:"d",\u0228:"E",\u0229:"e",\u0190\u0327:"E",\u025B\u0327:"e",\u1E28:"H",\u1E29:"h",I\u0327:"I",i\u0327:"i",\u0197\u0327:"I",\u0268\u0327:"i",M\u0327:"M",m\u0327:"m",O\u0327:"O",o\u0327:"o",Q\u0327:"Q",q\u0327:"q",U\u0327:"U",u\u0327:"u",X\u0327:"X",x\u0327:"x",Z\u0327:"Z",z\u0327:"z"};const o=Object.keys(characterMap).join("|"),A=new RegExp(o,"g");export const removeAccents=e=>e.replace(A,a=>characterMap[a]);

package/dist/remove-empty-items.cjs

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeEmptyItems = void 0;
+const removeEmptyItems = e => e.filter(Boolean);
+exports.removeEmptyItems = removeEmptyItems;

package/dist/remove-empty-items.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes empty items from an array
+ *
+ * @param arr - The array to remove empty items from
+ * @returns The array with empty items removed
+ */
+export declare const removeEmptyItems: <T = any>(arr: (T | undefined | null)[]) => NonNullable<T>[];

package/dist/remove-empty-items.mjs

@@ -0,0 +1 @@
+export const removeEmptyItems=e=>e.filter(Boolean);

package/dist/set-field.cjs

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setField = setField;
+var _types = require("@stryke/types");
+var _toPath = require("./to-path.cjs");
+function setField(i, t, s) {
+  const r = Array.isArray(t) ? t : (0, _types.isString)(t) ? (0, _toPath.toPath)(t) : [t];
+  for (const e of r) if (e === "__proto__" || e === "constructor" || e === "prototype") throw new Error("Invalid key in path: " + e);
+  let n = i;
+  for (let e = 0; e < r.length - 1; e++) {
+    const o = r[e],
+      y = r[e + 1];
+    n[o] === null && (n[o] = (0, _types.isObjectIndex)(y) ? [] : {}), n = n[o];
+  }
+  const c = r.at(-1);
+  return c && (n[c] = s), i;
+}

package/dist/set-field.d.ts

@@ -0,0 +1,10 @@
+import { type DeepKey } from "@stryke/types";
+/**
+ * Sets a value at a given deep path in an object.
+ *
+ * @param object - The object to set the value in.
+ * @param path - The deep path to set the value at.
+ * @param value - The value to set.
+ * @returns The object with the value set at the given deep path.
+ */
+export declare function setField<TObject extends Record<string, any> = Record<string, any>>(object: TObject, path: DeepKey<TObject>, value: unknown): TObject;

package/dist/set-field.mjs

@@ -0,0 +1 @@
+import{isObjectIndex as f,isString as l}from"@stryke/types";import{toPath as a}from"./to-path";export function setField(i,t,s){const r=Array.isArray(t)?t:l(t)?a(t):[t];for(const e of r)if(e==="__proto__"||e==="constructor"||e==="prototype")throw new Error("Invalid key in path: "+e);let n=i;for(let e=0;e<r.length-1;e++){const o=r[e],y=r[e+1];n[o]===null&&(n[o]=f(y)?[]:{}),n=n[o]}const c=r.at(-1);return c&&(n[c]=s),i}

package/dist/throttle.cjs

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.throttle = throttle;
+function throttle(e, o) {
+  let t;
+  return (...l) => {
+    const n = Date.now();
+    (t == null || n - t >= o) && (t = n, e(...l));
+  };
+}

package/dist/throttle.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Creates a throttled function that only invokes the provided function at most once
+ * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
+ * within the wait time will not trigger the execution of the original function.
+ *
+ * @example
+ * ```typescript
+ * const throttledFunction = throttle(() => {
+ *   console.log('Function executed');
+ * }, 1000);
+ *
+ * // Will log 'Function executed' immediately
+ * throttledFunction();
+ *
+ * // Will not log anything as it is within the throttle time
+ * throttledFunction();
+ *
+ * // After 1 second
+ * setTimeout(() => {
+ *   throttledFunction(); // Will log 'Function executed'
+ * }, 1000);
+ * ```
+ *
+ * @param func - The function to throttle.
+ * @param throttleMs - The number of milliseconds to throttle executions to.
+ * @returns A new throttled function that accepts the same parameters as the original function.
+ */
+export declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number): F;

package/dist/throttle.mjs

@@ -0,0 +1 @@
+export function throttle(e,o){let t;return(...l)=>{const n=Date.now();(t==null||n-t>=o)&&(t=n,e(...l))}}

package/dist/timeout.cjs

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.timeout = timeout;
+var _delay = require("./delay.cjs");
+var _errors = require("./errors.cjs");
+async function timeout(r) {
+  throw await (0, _delay.delay)(r), new _errors.TimeoutError();
+}

package/dist/timeout.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a promise that rejects with a `TimeoutError` after a specified delay.
+ *
+ * @param ms - The delay duration in milliseconds.
+ * @returns A promise that rejects with a `TimeoutError` after the specified delay.
+ * @throws Throws a `TimeoutError` after the specified delay.
+ */
+export declare function timeout(ms: number): Promise<never>;

package/dist/timeout.mjs

@@ -0,0 +1 @@
+import{delay as o}from"./delay";import{TimeoutError as e}from"./errors";export async function timeout(r){throw await o(r),new e}

package/dist/to-deep-key.cjs

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addPathToDeepKey = addPathToDeepKey;
+exports.toDeepKey = toDeepKey;
+var _types = require("@stryke/types");
+function toDeepKey(n) {
+  return n.reduce((r, t) => addPathToDeepKey(r, t));
+}
+function addPathToDeepKey(n, r) {
+  return (0, _types.isNumber)(r) || Number.isInteger(r) ? n + `[${r}]` : (0, _types.isSetString)(r) ? n + `.${r}` : n;
+}

package/dist/to-deep-key.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Converts an array of path segments into a deep key string.
+ *
+ * This function takes an array of strings and numbers representing path segments and combines them into a deep key string.
+ *
+ * @example
+ * toDeepKey(['a', 'b', 'c']) // Returns 'a.b.c'
+ * toDeepKey(['a', 0, 'c']) // Returns 'a[0].c'
+ * toDeepKey(['', 'a', 'b', 'c']) // Returns '.a.b.c'
+ * toDeepKey(['a', 'b.c', 'd']) // Returns 'a.b.c.d'
+ * toDeepKey([]) // Returns ''
+ * toDeepKey(['', 'a', 'b', 'c', 'd', 'e', 'f.g', 'h']) // Returns '.a.b.c.d.e.f.g.h'
+ *
+ * @param path - An array of strings and numbers representing path segments.
+ * @returns A deep key string.
+ */
+export declare function toDeepKey(path: string[]): string;
+/**
+ * Adds a path segment to a deep key string.
+ *
+ * This function takes a deep key string and a path segment and combines them into a new deep key string.
+ *
+ * @param deepKey - The deep key string to add the path segment to.
+ * @param path - The path segment to add to the deep key string.
+ * @returns A new deep key string.
+ *
+ * @example
+ * addPathToDeepKey('a.b', 'c') // Returns 'a.b.c'
+ * addPathToDeepKey('a[0]', 'c') // Returns 'a[0].c'
+ * addPathToDeepKey('.a.b', 'c') // Returns '.a.b.c'
+ * addPathToDeepKey('a.b', 'b.c') // Returns 'a.b.b.c'
+ * addPathToDeepKey('', 'a') // Returns 'a'
+ * addPathToDeepKey('.a.b', 'c.d') // Returns '.a.b.c.d'
+ */
+export declare function addPathToDeepKey(deepKey: string, path: string | number): string;

package/dist/to-deep-key.mjs

@@ -0,0 +1 @@
+import{isNumber as e,isSetString as i}from"@stryke/types";export function toDeepKey(n){return n.reduce((r,t)=>addPathToDeepKey(r,t))}export function addPathToDeepKey(n,r){return e(r)||Number.isInteger(r)?n+`[${r}]`:i(r)?n+`.${r}`:n}

package/dist/to-path.cjs

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.toPath = toPath;
+const a = /^[\w.]+$/g,
+  E = /\\(?<temp1>\\)?/g,
+  e = new RegExp(String.raw`[^.[\]]+` + "|" + String.raw`\[(?:` + `([^"'][^[]*)|` + String.raw`(["'])((?:(?!\2)[^\\]|\\.)*?)\2` + String.raw`)\]` + "|" + String.raw`(?=(?:\.|\[\])(?:\.|\[\]|$))`, "g");
+function toPath(t) {
+  if (a.test(t)) return t.split(".");
+  const n = [];
+  t[0] === "." && n.push("");
+  const i = t.matchAll(e);
+  for (const r of i) {
+    let s = r[0];
+    const o = r[1],
+      g = r[2],
+      c = r[3];
+    g && c ? s = c.replace(E, "$1") : o && (s = o), n.push(s);
+  }
+  return n;
+}

package/dist/to-path.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Converts a deep key string into an array of path segments.
+ *
+ * This function takes a string representing a deep key (e.g., 'a.b.c' or 'a[b][c]') and breaks it down into an array of strings, each representing a segment of the path.
+ *
+ * @param {string} deepKey - The deep key string to convert.
+ * @returns {string[]} An array of strings, each representing a segment of the path.
+ *
+ * Examples:
+ *
+ * toPath('a.b.c') // Returns ['a', 'b', 'c']
+ * toPath('a[b][c]') // Returns ['a', 'b', 'c']
+ * toPath('.a.b.c') // Returns ['', 'a', 'b', 'c']
+ * toPath('a["b.c"].d') // Returns ['a', 'b.c', 'd']
+ * toPath('') // Returns []
+ * toPath('.a[b].c.d[e]["f.g"].h') // Returns ['', 'a', 'b', 'c', 'd', 'e', 'f.g', 'h']
+ */
+export declare function toPath(deepKey: string): string[];

package/dist/to-path.mjs

@@ -0,0 +1 @@
+const a=/^[\w.]+$/g,E=/\\(?<temp1>\\)?/g,e=new RegExp(String.raw`[^.[\]]+`+"|"+String.raw`\[(?:`+`([^"'][^[]*)|`+String.raw`(["'])((?:(?!\2)[^\\]|\\.)*?)\2`+String.raw`)\]`+"|"+String.raw`(?=(?:\.|\[\])(?:\.|\[\]|$))`,"g");export function toPath(t){if(a.test(t))return t.split(".");const n=[];t[0]==="."&&n.push("");const i=t.matchAll(e);for(const r of i){let s=r[0];const o=r[1],g=r[2],c=r[3];g&&c?s=c.replace(E,"$1"):o&&(s=o),n.push(s)}return n}

package/dist/unflatten-object.cjs

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unflattenObject = unflattenObject;
+var _setField = require("./set-field.cjs");
+function unflattenObject(e) {
+  return Object.entries(e).reduce((t, [c, n]) => (0, _setField.setField)(t, c, n), {});
+}

package/dist/unflatten-object.d.ts

@@ -0,0 +1,33 @@
+import type { DeepKey, DeepValue } from "@stryke/types";
+/**
+ * Flattens a nested object into a single level object with dot-separated keys.
+ *
+ * @example
+ * ```typescript
+ * const nestedObject = {
+ *   a: {
+ *     b: {
+ *       c: 1
+ *     }
+ *   },
+ *   d: [2, 3]
+ * };
+ *
+ * const flattened = flattenObject(nestedObject);
+ * console.log(flattened);
+ * // Output:
+ * // {
+ * //   'a.b.c': 1,
+ * //   'd.0': 2,
+ * //   'd.1': 3
+ * // }
+ * ```
+ *
+ * @param object - The object to flatten.
+ * @returns - The flattened object.
+ */
+export declare function unflattenObject<TObject extends Record<string, any> = Record<string, any>, TDeepKeyObject extends {
+    [TKey in DeepKey<TObject>]: DeepValue<TObject, TKey>;
+} = {
+    [TKey in DeepKey<TObject>]: DeepValue<TObject, TKey>;
+}>(deepKeyObject: TDeepKeyObject): TObject;

package/dist/unflatten-object.mjs

@@ -0,0 +1 @@
+import{setField as r}from"./set-field";export function unflattenObject(e){return Object.entries(e).reduce((t,[c,n])=>r(t,c,n),{})}

package/dist/union.cjs

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.union = union;
+var _getUnique = require("./get-unique.cjs");
+function union(n, o) {
+  return (0, _getUnique.getUnique)([...n, ...o]);
+}

package/dist/union.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Creates an array of unique values from all given arrays.
+ *
+ * @remarks
+ * This function takes two arrays, merges them into a single array, and returns a new array
+ * containing only the unique values from the merged array.
+ *
+ * @example
+ * ```ts
+ * const array1 = [1, 2, 3];
+ * const array2 = [3, 4, 5];
+ * const result = union(array1, array2);
+ * // result will be [1, 2, 3, 4, 5]
+ * ```
+ *
+ * @param arr1 - The first array to merge and filter for unique values.
+ * @param arr2 - The second array to merge and filter for unique values.
+ * @returns A new array of unique values.
+ */
+export declare function union<T>(arr1: readonly T[], arr2: readonly T[]): T[];

package/dist/union.mjs

@@ -0,0 +1 @@
+import{getUnique as r}from"./get-unique";export function union(n,o){return r([...n,...o])}

package/dist/with-timeout.cjs

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.withTimeout = withTimeout;
+var _timeout = require("./timeout.cjs");
+async function withTimeout(r, e) {
+  return Promise.race([r(), (0, _timeout.timeout)(e)]);
+}

package/dist/with-timeout.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Executes an async function and enforces a timeout.
+ *
+ * If the promise does not resolve within the specified time,
+ * the timeout will trigger and the returned promise will be rejected.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await withTimeout(() => {}, 1000); // Timeout exception after 1 second
+ * } catch (error) {
+ *   console.error(error); // Will log 'TimeoutError'
+ * }
+ * ```
+ *
+ * @param run - A function that returns a promise to be executed.
+ * @param ms - The timeout duration in milliseconds.
+ * @returns A promise that resolves with the result of the `run` function or rejects if the timeout is reached.
+ */
+export declare function withTimeout<T>(run: () => Promise<T>, ms: number): Promise<T>;

package/dist/with-timeout.mjs

@@ -0,0 +1 @@
+import{timeout as o}from"./timeout";export async function withTimeout(r,e){return Promise.race([r(),o(e)])}