@welshman/util 0.1.2 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jon Staab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/lib/src/Deferred.d.ts

@@ -0,0 +1,21 @@
+/** Promise type with strongly typed error */
+export type CustomPromise<T, E> = Promise<T> & {
+    __errorType: E;
+};
+/**
+ * Creates a Promise with strongly typed error
+ * @param executor - Promise executor function
+ * @returns Promise with typed error
+ */
+export declare function makePromise<T, E>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason: E) => void) => void): CustomPromise<T, E>;
+/** Promise with exposed resolve/reject functions and typed error */
+export type Deferred<T, E = T> = CustomPromise<T, E> & {
+    resolve: (arg: T) => void;
+    reject: (arg: E) => void;
+};
+/**
+ * Creates a Deferred promise
+ * @returns Promise with resolve/reject methods exposed
+ */
+export declare const defer: <T, E = T>() => Deferred<T, E>;
+//# sourceMappingURL=Deferred.d.ts.map

package/dist/lib/src/Deferred.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deferred.d.ts","sourceRoot":"","sources":["../../../../lib/src/Deferred.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG;IAC7C,WAAW,EAAE,CAAC,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAC9B,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,KAAK,IAAI,GAC5F,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAErB;AAED,oEAAoE;AACpE,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IACrD,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAA;IACzB,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,CAQ/C,CAAA"}

package/dist/lib/src/Deferred.js

@@ -0,0 +1,21 @@
+/**
+ * Creates a Promise with strongly typed error
+ * @param executor - Promise executor function
+ * @returns Promise with typed error
+ */
+export function makePromise(executor) {
+    return new Promise(executor);
+}
+/**
+ * Creates a Deferred promise
+ * @returns Promise with resolve/reject methods exposed
+ */
+export const defer = () => {
+    let resolve, reject;
+    const p = makePromise((resolve_, reject_) => {
+        resolve = resolve_;
+        reject = reject_;
+    });
+    return Object.assign(p, { resolve, reject });
+};
+//# sourceMappingURL=Deferred.js.map

package/dist/lib/src/Deferred.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deferred.js","sourceRoot":"","sources":["../../../../lib/src/Deferred.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,UAAU,WAAW,CACzB,QAA6F;IAE7F,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAwB,CAAA;AACrD,CAAC;AAQD;;;GAGG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,GAA6B,EAAE;IAClD,IAAI,OAAO,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;QAC1C,OAAO,GAAG,QAAQ,CAAA;QAClB,MAAM,GAAG,OAAO,CAAA;IAClB,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAC,OAAO,EAAE,MAAM,EAAC,CAA8B,CAAA;AACzE,CAAC,CAAA"}

package/dist/lib/src/Emitter.d.ts

@@ -0,0 +1,14 @@
+import { EventEmitter } from "events";
+/**
+ * Extended EventEmitter that also emits all events to '*' listeners
+ */
+export declare class Emitter extends EventEmitter {
+    /**
+     * Emits an event to listeners and to '*' listeners
+     * @param type - Event type/name
+     * @param args - Arguments to pass to listeners
+     * @returns True if event had listeners
+     */
+    emit(type: string, ...args: any[]): boolean;
+}
+//# sourceMappingURL=Emitter.d.ts.map

package/dist/lib/src/Emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Emitter.d.ts","sourceRoot":"","sources":["../../../../lib/src/Emitter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,QAAQ,CAAA;AAEnC;;GAEG;AACH,qBAAa,OAAQ,SAAQ,YAAY;IACvC;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;CAMlC"}

package/dist/lib/src/Emitter.js

@@ -0,0 +1,18 @@
+import { EventEmitter } from "events";
+/**
+ * Extended EventEmitter that also emits all events to '*' listeners
+ */
+export class Emitter extends EventEmitter {
+    /**
+     * Emits an event to listeners and to '*' listeners
+     * @param type - Event type/name
+     * @param args - Arguments to pass to listeners
+     * @returns True if event had listeners
+     */
+    emit(type, ...args) {
+        const a = super.emit(type, ...args);
+        const b = super.emit("*", type, ...args);
+        return a && b;
+    }
+}
+//# sourceMappingURL=Emitter.js.map

package/dist/lib/src/Emitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Emitter.js","sourceRoot":"","sources":["../../../../lib/src/Emitter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,QAAQ,CAAA;AAEnC;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC;;;;;OAKG;IACH,IAAI,CAAC,IAAY,EAAE,GAAG,IAAW;QAC/B,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAA;QACnC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAA;QAExC,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF"}

package/dist/lib/src/LRUCache.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Least Recently Used (LRU) cache implementation
+ * @template T - Type of cache keys
+ * @template U - Type of cache values
+ */
+export declare class LRUCache<T, U> {
+    readonly maxSize: number;
+    map: Map<T, U>;
+    keys: T[];
+    constructor(maxSize?: number);
+    has(k: T): boolean;
+    get(k: T): U | undefined;
+    set(k: T, v: U): void;
+}
+/**
+ * Creates a memoized function with LRU caching
+ * @template T - Cache key type
+ * @template V - Cache value type
+ * @template Args - Function argument types
+ */
+export declare function cached<T, V, Args extends any[]>({ maxSize, getKey, getValue, }: {
+    maxSize: number;
+    getKey: (args: Args) => T;
+    getValue: (args: Args) => V;
+}): {
+    (...args: Args): NonNullable<V>;
+    cache: LRUCache<T, V>;
+    getKey: (args: Args) => T;
+    getValue: (args: Args) => V;
+};
+/**
+ * Creates a simple memoized function with default settings
+ * @template V - Cache value type
+ * @template Args - Function argument types
+ */
+export declare function simpleCache<V, Args extends any[]>(getValue: (args: Args) => V): {
+    (...args: Args): NonNullable<V>;
+    cache: LRUCache<string, V>;
+    getKey: (args: Args) => string;
+    getValue: (args: Args) => V;
+};
+//# sourceMappingURL=LRUCache.d.ts.map

package/dist/lib/src/LRUCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LRUCache.d.ts","sourceRoot":"","sources":["../../../../lib/src/LRUCache.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,QAAQ,CAAC,CAAC,EAAE,CAAC;IAIZ,QAAQ,CAAC,OAAO,EAAE,MAAM;IAHpC,GAAG,YAAkB;IACrB,IAAI,EAAE,CAAC,EAAE,CAAK;gBAEO,OAAO,GAAE,MAAiB;IAE/C,GAAG,CAAC,CAAC,EAAE,CAAC;IAIR,GAAG,CAAC,CAAC,EAAE,CAAC;IAcR,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;CAQf;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,SAAS,GAAG,EAAE,EAAE,EAC/C,OAAO,EACP,MAAM,EACN,QAAQ,GACT,EAAE;IACD,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,CAAA;IACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,CAAA;CAC5B;cAGuB,IAAI;;mBALX,IAAI,KAAK,CAAC;qBACR,IAAI,KAAK,CAAC;EAmB5B;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,IAAI,SAAS,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC;;;;;EAE7E"}

package/dist/lib/src/LRUCache.js

@@ -0,0 +1,62 @@
+/**
+ * Least Recently Used (LRU) cache implementation
+ * @template T - Type of cache keys
+ * @template U - Type of cache values
+ */
+export class LRUCache {
+    maxSize;
+    map = new Map();
+    keys = [];
+    constructor(maxSize = Infinity) {
+        this.maxSize = maxSize;
+    }
+    has(k) {
+        return this.map.has(k);
+    }
+    get(k) {
+        const v = this.map.get(k);
+        if (v !== undefined) {
+            this.keys.push(k);
+            if (this.keys.length > this.maxSize * 2) {
+                this.keys = this.keys.splice(-this.maxSize);
+            }
+        }
+        return v;
+    }
+    set(k, v) {
+        this.map.set(k, v);
+        this.keys.push(k);
+        if (this.map.size > this.maxSize) {
+            this.map.delete(this.keys.shift());
+        }
+    }
+}
+/**
+ * Creates a memoized function with LRU caching
+ * @template T - Cache key type
+ * @template V - Cache value type
+ * @template Args - Function argument types
+ */
+export function cached({ maxSize, getKey, getValue, }) {
+    const cache = new LRUCache(maxSize);
+    const get = (...args) => {
+        const k = getKey(args);
+        if (!cache.has(k)) {
+            cache.set(k, getValue(args));
+        }
+        return cache.get(k);
+    };
+    get.cache = cache;
+    get.getKey = getKey;
+    get.getValue = getValue;
+    return get;
+}
+/**
+ * Creates a simple memoized function with default settings
+ * @template V - Cache value type
+ * @template Args - Function argument types
+ */
+export function simpleCache(getValue) {
+    return cached({ maxSize: 10 ** 5, getKey: xs => xs.join(":"), getValue });
+}
+//# sourceMappingURL=LRUCache.js.map

package/dist/lib/src/LRUCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LRUCache.js","sourceRoot":"","sources":["../../../../lib/src/LRUCache.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,QAAQ;IAIE;IAHrB,GAAG,GAAG,IAAI,GAAG,EAAQ,CAAA;IACrB,IAAI,GAAQ,EAAE,CAAA;IAEd,YAAqB,UAAkB,QAAQ;QAA1B,YAAO,GAAP,OAAO,CAAmB;IAAG,CAAC;IAEnD,GAAG,CAAC,CAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACxB,CAAC;IAED,GAAG,CAAC,CAAI;QACN,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QAEzB,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAM,CAAC,CAAA;YAEtB,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,CAAC,CAAA;IACV,CAAC;IAED,GAAG,CAAC,CAAI,EAAE,CAAI;QACZ,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEjB,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAO,CAAC,CAAA;QACzC,CAAC;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAA2B,EAC/C,OAAO,EACP,MAAM,EACN,QAAQ,GAKT;IACC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAO,OAAO,CAAC,CAAA;IAEzC,MAAM,GAAG,GAAG,CAAC,GAAG,IAAU,EAAE,EAAE;QAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QAEtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;QAC9B,CAAC;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,CAAA;IACtB,CAAC,CAAA;IAED,GAAG,CAAC,KAAK,GAAG,KAAK,CAAA;IACjB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAA;IACnB,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAEvB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAwB,QAA2B;IAC5E,OAAO,MAAM,CAAC,EAAC,OAAO,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAC,CAAC,CAAA;AACzE,CAAC"}

package/dist/lib/src/TaskQueue.d.ts

@@ -0,0 +1,18 @@
+export type TaskQueueOptions<Item> = {
+    batchSize: number;
+    processItem: (item: Item) => unknown;
+};
+export declare class TaskQueue<Item> {
+    readonly options: TaskQueueOptions<Item>;
+    items: Item[];
+    isPaused: boolean;
+    isProcessing: boolean;
+    constructor(options: TaskQueueOptions<Item>);
+    push(item: Item): void;
+    remove(item: Item): void;
+    process(): Promise<void>;
+    stop(): void;
+    start(): void;
+    clear(): void;
+}
+//# sourceMappingURL=TaskQueue.d.ts.map

package/dist/lib/src/TaskQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskQueue.d.ts","sourceRoot":"","sources":["../../../../lib/src/TaskQueue.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,CAAC,IAAI,IAAI;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAA;CACrC,CAAA;AAED,qBAAa,SAAS,CAAC,IAAI;IAKb,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAJpD,KAAK,EAAE,IAAI,EAAE,CAAK;IAClB,QAAQ,UAAQ;IAChB,YAAY,UAAQ;gBAEC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAEpD,IAAI,CAAC,IAAI,EAAE,IAAI;IAKf,MAAM,CAAC,IAAI,EAAE,IAAI;IAIX,OAAO;IAwBb,IAAI;IAIJ,KAAK;IAKL,KAAK;CAGN"}

package/dist/lib/src/TaskQueue.js

@@ -0,0 +1,47 @@
+import { remove, yieldThread } from "./Tools.js";
+export class TaskQueue {
+    options;
+    items = [];
+    isPaused = false;
+    isProcessing = false;
+    constructor(options) {
+        this.options = options;
+    }
+    push(item) {
+        this.items.push(item);
+        this.process();
+    }
+    remove(item) {
+        this.items = remove(item, this.items);
+    }
+    async process() {
+        if (this.isProcessing || this.isPaused || this.items.length === 0) {
+            return;
+        }
+        this.isProcessing = true;
+        await yieldThread();
+        for (const item of this.items.splice(0, this.options.batchSize)) {
+            try {
+                await this.options.processItem(item);
+            }
+            catch (e) {
+                console.error(e);
+            }
+        }
+        this.isProcessing = false;
+        if (this.items.length > 0) {
+            this.process();
+        }
+    }
+    stop() {
+        this.isPaused = true;
+    }
+    start() {
+        this.isPaused = false;
+        this.process();
+    }
+    clear() {
+        this.items = [];
+    }
+}
+//# sourceMappingURL=TaskQueue.js.map

package/dist/lib/src/TaskQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskQueue.js","sourceRoot":"","sources":["../../../../lib/src/TaskQueue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,YAAY,CAAA;AAO9C,MAAM,OAAO,SAAS;IAKC;IAJrB,KAAK,GAAW,EAAE,CAAA;IAClB,QAAQ,GAAG,KAAK,CAAA;IAChB,YAAY,GAAG,KAAK,CAAA;IAEpB,YAAqB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;IAAG,CAAC;IAExD,IAAI,CAAC,IAAU;QACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrB,IAAI,CAAC,OAAO,EAAE,CAAA;IAChB,CAAC;IAED,MAAM,CAAC,IAAU;QACf,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClE,OAAM;QACR,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;QAExB,MAAM,WAAW,EAAE,CAAA;QAEnB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAChE,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;YACtC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAClB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QAEzB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,EAAE,CAAA;QAChB,CAAC;IACH,CAAC;IAED,IAAI;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;IACtB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,OAAO,EAAE,CAAA;IAChB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;IACjB,CAAC;CACF"}