@hyperfrontend/list-utils 0.0.1

package/index.esm.js

@@ -0,0 +1,174 @@
+import { getType } from '@hyperfrontend/data-utils';
+
+/**
+ * Creates a FIFO (First-In-First-Out) list.
+ *
+ * @template T The type of elements in the list, must be an object.
+ * @returns {FifoList<T>} A FIFO list with methods to manipulate and query the list.
+ */
+function createFifoList() {
+    const list = new Set();
+    const push = (item) => {
+        if (getType(item) !== 'object') {
+            throw new Error('A fifo list only non-primitive values');
+        }
+        if (list.has(item)) {
+            throw new Error('Cannot a item that already exists');
+        }
+        list.add(item);
+    };
+    const pull = () => {
+        const value = list.values().next().value;
+        list.delete(value);
+        return value;
+    };
+    const map = (callback) => {
+        return Array.from(list.values()).map(callback);
+    };
+    const forEach = (callback) => {
+        list.forEach(callback);
+    };
+    const remove = (item) => list.delete(item);
+    const has = (item) => list.has(item);
+    const size = () => list.size;
+    const clear = () => list.clear();
+    const result = {
+        push,
+        pull,
+        map,
+        forEach,
+        remove,
+        has,
+        size,
+        clear,
+    };
+    return Object.freeze(result);
+}
+
+/**
+ * Creates a LIFO (Last-In-First-Out) list.
+ *
+ * @template T The type of elements in the list, must be an object.
+ * @returns {LifoList<T>} A LIFO list with methods to manipulate and query the list.
+ */
+function createLifoList() {
+    const list = new Set();
+    const push = (item) => {
+        if (getType(item) !== 'object') {
+            throw new Error('A lifo list only supports non-primitive values');
+        }
+        list.add(item);
+    };
+    const pull = () => {
+        const lastItem = Array.from(list).pop();
+        if (lastItem) {
+            list.delete(lastItem);
+        }
+        return lastItem;
+    };
+    const map = (callback) => {
+        return Array.from(list).map(callback);
+    };
+    const forEach = (callback) => {
+        list.forEach(callback);
+    };
+    const remove = (item) => list.delete(item);
+    const has = (item) => list.has(item);
+    const size = () => list.size;
+    const clear = () => {
+        list.clear();
+    };
+    const result = {
+        push,
+        pull,
+        map,
+        forEach,
+        remove,
+        has,
+        size,
+        clear,
+    };
+    return Object.freeze(result);
+}
+
+/**
+ * Creates an array of numbers within a specified range (inclusive).
+ *
+ * @param start - The starting number of the range
+ * @param end - The ending number of the range (inclusive)
+ * @returns An array containing all numbers from start to end
+ */
+function createRange(start, end) {
+    const range = [];
+    for (let i = start; i <= end; i += 1) {
+        range.push(i);
+    }
+    return range;
+}
+
+/**
+ * Creates a value picker that cycles through a list of string values.
+ *
+ * @param values - The array of string values to cycle through
+ * @returns A ValuePicker instance with current and next methods
+ */
+function createValuePicker(values) {
+    if (!values || !values.length) {
+        throw new Error('Expected values not to be an empty list.');
+    }
+    let index = -1;
+    /**
+     * Returns the current value without advancing the picker.
+     *
+     * @returns The current value in the list
+     */
+    function current() {
+        if (index < 0)
+            index = 0;
+        return values[index];
+    }
+    /**
+     * Advances to and returns the next value, cycling back to the start when reaching the end.
+     *
+     * @returns The next value in the list
+     */
+    function next() {
+        if (index < 0)
+            return current();
+        index = ++index < values.length ? index : 0;
+        return values[index];
+    }
+    return {
+        current: current,
+        next: next,
+    };
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const getLastKeyInMap = (map) => {
+    const items = [...map.keys()];
+    return items[items.length - 1];
+};
+
+/**
+ * Filters out empty, null, undefined, and whitespace-only strings from an array.
+ *
+ * @param values - The array of strings to filter
+ * @returns A new array containing only non-empty strings with content
+ */
+function nonEmptyStrings(values) {
+    return values.filter((value) => ![undefined, null, ''].includes(value) && value.trim() !== '');
+}
+
+/**
+ * Removes duplicate strings from an array, preserving insertion order.
+ *
+ * @param values - The array of strings to deduplicate
+ * @returns A new array containing only unique strings
+ */
+function uniqueStrings(values) {
+    return Array.from(new Set(values));
+}
+
+export { createFifoList, createLifoList, createRange, createValuePicker, getLastKeyInMap, nonEmptyStrings, uniqueStrings };
+//# sourceMappingURL=index.esm.js.map

package/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../../../../libs/utils/list/src/create-fifo-list.ts","../../../../libs/utils/list/src/create-lifo-list.ts","../../../../libs/utils/list/src/create-range.ts","../../../../libs/utils/list/src/create-value-picker.ts","../../../../libs/utils/list/src/get-last-key-in-map.ts","../../../../libs/utils/list/src/non-empty-strings.ts","../../../../libs/utils/list/src/unique-strings.ts"],"sourcesContent":[null,null,null,null,null,null,null],"names":[],"mappings":";;AAaA;;;;;AAKG;SACa,cAAc,GAAA;AAC5B,IAAA,MAAM,IAAI,GAAW,IAAI,GAAG,EAAE;AAE9B,IAAA,MAAM,IAAI,GAAG,CAAC,IAAO,KAAU;AAC7B,QAAA,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE;AAC9B,YAAA,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC;QAC1D;AACA,QAAA,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAClB,YAAA,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;QACtD;AACA,QAAA,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AAChB,IAAA,CAAC;IAED,MAAM,IAAI,GAAG,MAAQ;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK;AACxC,QAAA,IAAI,CAAC,MAAM,CAAI,KAAK,CAAC;AACrB,QAAA,OAAU,KAAK;AACjB,IAAA,CAAC;AAED,IAAA,MAAM,GAAG,GAAG,CAAI,QAAwB,KAAS;AAC/C,QAAA,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;AAChD,IAAA,CAAC;AAED,IAAA,MAAM,OAAO,GAAG,CAAC,QAA2B,KAAU;AACpD,QAAA,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;AACxB,IAAA,CAAC;AAED,IAAA,MAAM,MAAM,GAAG,CAAC,IAAO,KAAc,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEtD,IAAA,MAAM,GAAG,GAAG,CAAC,IAAO,KAAc,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;IAEhD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI;IAE5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE;AAEhC,IAAA,MAAM,MAAM,GAAgB;QAC1B,IAAI;QACJ,IAAI;QACJ,GAAG;QACH,OAAO;QACP,MAAM;QACN,GAAG;QACH,IAAI;QACJ,KAAK;KACN;AAED,IAAA,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;AAC9B;;ACrDA;;;;;AAKG;SACa,cAAc,GAAA;AAC5B,IAAA,MAAM,IAAI,GAAW,IAAI,GAAG,EAAE;AAE9B,IAAA,MAAM,IAAI,GAAG,CAAC,IAAO,KAAU;AAC7B,QAAA,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE;AAC9B,YAAA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC;QACnE;AACA,QAAA,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AAChB,IAAA,CAAC;IAED,MAAM,IAAI,GAAG,MAAoB;QAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE;QACvC,IAAI,QAAQ,EAAE;AACZ,YAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB;AACA,QAAA,OAAO,QAAQ;AACjB,IAAA,CAAC;AAED,IAAA,MAAM,GAAG,GAAG,CAAI,QAAwB,KAAS;QAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;AACvC,IAAA,CAAC;AAED,IAAA,MAAM,OAAO,GAAG,CAAC,QAA2B,KAAU;AACpD,QAAA,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;AACxB,IAAA,CAAC;AAED,IAAA,MAAM,MAAM,GAAG,CAAC,IAAO,KAAc,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEtD,IAAA,MAAM,GAAG,GAAG,CAAC,IAAO,KAAc,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;IAEhD,MAAM,IAAI,GAAG,MAAc,IAAI,CAAC,IAAI;IAEpC,MAAM,KAAK,GAAG,MAAW;QACvB,IAAI,CAAC,KAAK,EAAE;AACd,IAAA,CAAC;AAED,IAAA,MAAM,MAAM,GAAgB;QAC1B,IAAI;QACJ,IAAI;QACJ,GAAG;QACH,OAAO;QACP,MAAM;QACN,GAAG;QACH,IAAI;QACJ,KAAK;KACN;AAED,IAAA,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;AAC9B;;ACnEA;;;;;;AAMG;AACG,SAAU,WAAW,CAAC,KAAa,EAAE,GAAW,EAAA;IACpD,MAAM,KAAK,GAAa,EAAE;AAC1B,IAAA,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE;AACpC,QAAA,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACf;AACA,IAAA,OAAO,KAAK;AACd;;ACRA;;;;;AAKG;AACG,SAAU,iBAAiB,CAAC,MAAgB,EAAA;IAChD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;AAC7B,QAAA,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC;IAC7D;AACA,IAAA,IAAI,KAAK,GAAG,EAAE;AACd;;;;AAIG;AACH,IAAA,SAAS,OAAO,GAAA;QACd,IAAI,KAAK,GAAG,CAAC;YAAE,KAAK,GAAG,CAAC;AACxB,QAAA,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB;AACA;;;;AAIG;AACH,IAAA,SAAS,IAAI,GAAA;QACX,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,OAAO,EAAE;AAC/B,QAAA,KAAK,GAAG,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,KAAK,GAAG,CAAC;AAC3C,QAAA,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB;IACA,OAAO;AACL,QAAA,OAAO,EAAE,OAAO;AAChB,QAAA,IAAI,EAAE,IAAI;KACX;AACH;;ACvCA;AACO,MAAM,eAAe,GAAG,CAAU,GAAgB,KAAO;IAC9D,MAAM,KAAK,GAAG,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC7B,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAM;AACrC;;ACJA;;;;;AAKG;AACG,SAAU,eAAe,CAAC,MAAgB,EAAA;AAC9C,IAAA,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAChG;;ACRA;;;;;AAKG;AACG,SAAU,aAAa,CAAC,MAAgB,EAAA;IAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;AACpC;;;;"}

package/non-empty-strings.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Filters out empty, null, undefined, and whitespace-only strings from an array.
+ *
+ * @param values - The array of strings to filter
+ * @returns A new array containing only non-empty strings with content
+ */
+export declare function nonEmptyStrings(values: string[]): string[];
+//# sourceMappingURL=non-empty-strings.d.ts.map

package/non-empty-strings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"non-empty-strings.d.ts","sourceRoot":"","sources":["../../../../libs/utils/list/src/non-empty-strings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAE1D"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@hyperfrontend/list-utils",
+  "version": "0.0.1",
+  "description": "Purpose-built collection utilities for queue management, filtering, and iteration patterns.",
+  "license": "MIT",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=8.0.0"
+  },
+  "keywords": [
+    "list",
+    "array",
+    "queue",
+    "fifo",
+    "lifo",
+    "stack",
+    "collections",
+    "iterator",
+    "round-robin",
+    "deduplication",
+    "string-sanitization",
+    "typescript",
+    "immutable",
+    "functional",
+    "zero-dependencies"
+  ],
+  "main": "./index.cjs.js",
+  "dependencies": {
+    "@hyperfrontend/data-utils": "0.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AndrewRedican/hyperfrontend.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AndrewRedican/hyperfrontend/issues"
+  },
+  "homepage": "https://github.com/AndrewRedican/hyperfrontend#readme",
+  "author": {
+    "name": "andrew.redican.mejia@gmail.com",
+    "url": "https://hyperfrontend.dev"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.esm.js",
+      "require": "./index.cjs.js"
+    },
+    "./bundle": {
+      "import": "./bundle/index.iife.min.js",
+      "require": "./bundle/index.iife.min.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "types": "./index.d.ts",
+  "unpkg": "./bundle/index.umd.min.js",
+  "jsdelivr": "./bundle/index.umd.min.js"
+}

package/unique-strings.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Removes duplicate strings from an array, preserving insertion order.
+ *
+ * @param values - The array of strings to deduplicate
+ * @returns A new array containing only unique strings
+ */
+export declare function uniqueStrings(values: string[]): string[];
+//# sourceMappingURL=unique-strings.d.ts.map

package/unique-strings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unique-strings.d.ts","sourceRoot":"","sources":["../../../../libs/utils/list/src/unique-strings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAExD"}