@ixfx/events 0.36.0

package/dist/__tests__/test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test.d.ts.map

package/dist/__tests__/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../__tests__/test.ts"],"names":[],"mappings":""}

package/dist/__tests__/test.js

@@ -0,0 +1 @@
+export {};

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './race.js';
+export { SimpleEventEmitter } from './simple-event-emitter.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,cAAc,YAAY,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,3 @@
+export * from './race.js';
+export { SimpleEventEmitter } from './simple-event-emitter.js';
+export * from './types.js';

package/dist/src/map-of.d.ts

@@ -0,0 +1,34 @@
+export declare class MapOfSimple<T> {
+    #private;
+    /**
+     * Gets a copy of the underlying array storing values at `key`, or an empty array if
+     * key does not exist
+     * @param key
+     * @returns
+     */
+    get(key: string): T[];
+    /**
+     * Returns the number of values stored under `key`
+     * @param key
+     * @returns
+     */
+    size(key: string): number;
+    /**
+     * Iterate over all values contained under `key`
+     * @param key
+     * @returns
+     */
+    iterateKey(key: string): Generator<T>;
+    /**
+     * Iterate all values, regardless of key
+     */
+    iterateValues(): Generator<T>;
+    /**
+     * Iterate all keys
+     */
+    iterateKeys(): Generator<string>;
+    addKeyedValues(key: string, ...values: T[]): void;
+    deleteKeyValue(key: string, value: T): boolean;
+    clear(): void;
+}
+//# sourceMappingURL=map-of.d.ts.map

package/dist/src/map-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-of.d.ts","sourceRoot":"","sources":["../../src/map-of.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAW,CAAC,CAAC;;IAGxB;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM;IAMf;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM;IAMhB;;;;OAIG;IACF,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAMtC;;OAEG;IACF,aAAa,IAAI,SAAS,CAAC,CAAC,CAAC;IAM9B;;OAEG;IACF,WAAW,IAAI,SAAS,CAAC,MAAM,CAAC;IAIjC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE;IAS1C,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IASpC,KAAK;CAGN"}

package/dist/src/map-of.js

@@ -0,0 +1,72 @@
+export class MapOfSimple {
+    #store = new Map();
+    /**
+     * Gets a copy of the underlying array storing values at `key`, or an empty array if
+     * key does not exist
+     * @param key
+     * @returns
+     */
+    get(key) {
+        const arr = this.#store.get(key);
+        if (!arr)
+            return [];
+        return [...arr];
+    }
+    /**
+     * Returns the number of values stored under `key`
+     * @param key
+     * @returns
+     */
+    size(key) {
+        const arr = this.#store.get(key);
+        if (!arr)
+            return 0;
+        return arr.length;
+    }
+    /**
+     * Iterate over all values contained under `key`
+     * @param key
+     * @returns
+     */
+    *iterateKey(key) {
+        const arr = this.#store.get(key);
+        if (!arr)
+            return;
+        yield* arr.values();
+    }
+    /**
+     * Iterate all values, regardless of key
+     */
+    *iterateValues() {
+        for (const key of this.#store.keys()) {
+            yield* this.iterateKey(key);
+        }
+    }
+    /**
+     * Iterate all keys
+     */
+    *iterateKeys() {
+        yield* this.#store.keys();
+    }
+    addKeyedValues(key, ...values) {
+        let arr = this.#store.get(key);
+        if (!arr) {
+            arr = [];
+            this.#store.set(key, arr);
+        }
+        arr.push(...values);
+    }
+    deleteKeyValue(key, value) {
+        const arr = this.#store.get(key);
+        if (!arr)
+            return false;
+        const arrCopy = arr.filter(v => v !== value);
+        if (arrCopy.length === arr.length)
+            return false;
+        this.#store.set(key, arrCopy);
+        return true;
+    }
+    clear() {
+        this.#store.clear();
+    }
+}

package/dist/src/race.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Subscribes to events on `target`, returning the event data
+ * from the first event that fires.
+ *
+ * By default waits a maximum of 1 minute.
+ *
+ * Automatically unsubscribes on success or failure (ie. timeout)
+ *
+ * ```js
+ * // Event will be data from either event, whichever fires first
+ * // Exception is thrown if neither fires within 1 second
+ * const event = await eventRace(document.body, [`pointermove`, `pointerdown`], { timeout: 1000 });
+ * ```
+ * @param target Event source
+ * @param eventNames Event name(s)
+ * @param options Options
+ * @returns
+ */
+export declare const eventRace: (target: EventTarget, eventNames: Array<string>, options?: Partial<{
+    timeoutMs: number;
+    signal: AbortSignal;
+}>) => Promise<Event>;
+//# sourceMappingURL=race.d.ts.map

package/dist/src/race.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"race.d.ts","sourceRoot":"","sources":["../../src/race.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,WAAW,EAAE,YAAY,KAAK,CAAC,MAAM,CAAC,EAAE,UAAS,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,CAAM,mBAmD1I,CAAA"}

package/dist/src/race.js

@@ -0,0 +1,70 @@
+/**
+ * Subscribes to events on `target`, returning the event data
+ * from the first event that fires.
+ *
+ * By default waits a maximum of 1 minute.
+ *
+ * Automatically unsubscribes on success or failure (ie. timeout)
+ *
+ * ```js
+ * // Event will be data from either event, whichever fires first
+ * // Exception is thrown if neither fires within 1 second
+ * const event = await eventRace(document.body, [`pointermove`, `pointerdown`], { timeout: 1000 });
+ * ```
+ * @param target Event source
+ * @param eventNames Event name(s)
+ * @param options Options
+ * @returns
+ */
+export const eventRace = (target, eventNames, options = {}) => {
+    const intervalMs = options.timeoutMs ?? 60_1000; //intervalToMs(options.timeout, 60 * 1000);
+    const signal = options.signal;
+    let triggered = false;
+    let disposed = false;
+    let timeout;
+    const promise = new Promise((resolve, reject) => {
+        const onEvent = (event) => {
+            if (`type` in event) {
+                if (eventNames.includes(event.type)) {
+                    triggered = true;
+                    resolve(event);
+                    dispose();
+                }
+                else {
+                    console.warn(`eventRace: Got event '${event.type}' that is not in race list`);
+                }
+            }
+            else {
+                console.warn(`eventRace: Event data does not have expected 'type' field`);
+                console.log(event);
+            }
+        };
+        for (const name of eventNames) {
+            target.addEventListener(name, onEvent);
+        }
+        const dispose = () => {
+            if (disposed)
+                return;
+            if (timeout !== undefined)
+                clearTimeout(timeout);
+            timeout = undefined;
+            disposed = true;
+            for (const name of eventNames) {
+                target.removeEventListener(name, onEvent);
+            }
+        };
+        timeout = setTimeout(() => {
+            if (triggered || disposed)
+                return;
+            dispose();
+            reject(new Error(`eventRace: Events not fired within interval. Events: ${JSON.stringify(eventNames)} Interval: ${intervalMs}`));
+        }, intervalMs);
+        signal?.addEventListener(`abort`, () => {
+            if (triggered || disposed)
+                return;
+            dispose();
+            reject(new Error(`Abort signal received ${signal.reason}`));
+        });
+    });
+    return promise;
+};

package/dist/src/simple-event-emitter.d.ts

@@ -0,0 +1,34 @@
+import type { ISimpleEventEmitter } from "./types.js";
+export declare class SimpleEventEmitter<Events> implements ISimpleEventEmitter<Events> {
+    #private;
+    dispose(): void;
+    get isDisposed(): boolean;
+    /**
+     * Fire event
+     * @param type Type of event
+     * @param args Arguments for event
+     * @returns
+     */
+    protected fireEvent<K extends keyof Events>(type: K, args: Events[K]): void;
+    /**
+     * Adds event listener.
+     *
+     * @throws Error if emitter is disposed
+     * @typeParam K - Events
+     * @param name Event name
+     * @param listener Event handler
+     */
+    addEventListener<K extends keyof Events>(name: K, listener: (event: Events[K], sender: SimpleEventEmitter<Events>) => void): void;
+    /**
+     * Remove event listener
+     *
+     * @param listener
+     */
+    removeEventListener<K extends keyof Events>(type: K, listener: (event: Events[K], sender: SimpleEventEmitter<Events>) => void): void;
+    /**
+     * Clear all event listeners
+     * @private
+     */
+    clearEventListeners(): void;
+}
+//# sourceMappingURL=simple-event-emitter.d.ts.map

package/dist/src/simple-event-emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-event-emitter.d.ts","sourceRoot":"","sources":["../../src/simple-event-emitter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAY,MAAM,YAAY,CAAC;AAEhE,qBAAa,kBAAkB,CAAC,MAAM,CAAE,YAAW,mBAAmB,CAAC,MAAM,CAAC;;IAI5E,OAAO;IAKP,IAAI,UAAU,YAEb;IAED;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,MAAM,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAE,CAAC,CAAE;IAQtE;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,MAAM,MAAM,EACrC,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,CAAE,CAAC,CAAE,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI,GACzE,IAAI;IAQP;;;;OAIG;IACH,mBAAmB,CAAC,CAAC,SAAS,MAAM,MAAM,EACxC,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,CAAE,CAAC,CAAE,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,KAAK,IAAI;IAW5E;;;OAGG;IACH,mBAAmB;CAIpB"}

package/dist/src/simple-event-emitter.js

@@ -0,0 +1,60 @@
+import { MapOfSimple } from "./map-of.js";
+export class SimpleEventEmitter {
+    #listeners = new MapOfSimple();
+    #disposed = false;
+    dispose() {
+        if (this.#disposed)
+            return;
+        this.clearEventListeners();
+    }
+    get isDisposed() {
+        return this.#disposed;
+    }
+    /**
+     * Fire event
+     * @param type Type of event
+     * @param args Arguments for event
+     * @returns
+     */
+    fireEvent(type, args) {
+        if (this.#disposed)
+            throw new Error(`Disposed`);
+        //console.log(`Firing ${ type as string }. Listeners: ${ this.#listeners.size(type as string) }`);
+        for (const l of this.#listeners.iterateKey(type)) {
+            l(args, this);
+        }
+    }
+    /**
+     * Adds event listener.
+     *
+     * @throws Error if emitter is disposed
+     * @typeParam K - Events
+     * @param name Event name
+     * @param listener Event handler
+     */
+    addEventListener(name, listener) {
+        if (this.#disposed)
+            throw new Error(`Disposed`);
+        this.#listeners.addKeyedValues(name, listener);
+    }
+    /**
+     * Remove event listener
+     *
+     * @param listener
+     */
+    removeEventListener(type, listener) {
+        if (this.#disposed)
+            return;
+        // listener: Listener<Events>): void {
+        this.#listeners.deleteKeyValue(type, listener);
+    }
+    /**
+     * Clear all event listeners
+     * @private
+     */
+    clearEventListeners() {
+        if (this.#disposed)
+            return;
+        this.#listeners.clear();
+    }
+}

package/dist/src/types.d.ts

@@ -0,0 +1,6 @@
+export type Listener<Events> = (event: unknown, sender: ISimpleEventEmitter<Events>) => void;
+export type ISimpleEventEmitter<Events> = {
+    addEventListener<K extends keyof Events>(type: K, listener: (event: Events[K], sender: ISimpleEventEmitter<Events>) => void): void;
+    removeEventListener<K extends keyof Events>(type: K, listener: (event: Events[K], sender: ISimpleEventEmitter<Events>) => void): void;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAE7F,MAAM,MAAM,mBAAmB,CAAC,MAAM,IAAI;IACxC,gBAAgB,CAAC,CAAC,SAAS,MAAM,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,CAAE,CAAC,CAAE,EAAE,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IACrI,mBAAmB,CAAC,CAAC,SAAS,MAAM,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,CAAE,CAAC,CAAE,EAAE,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;CACzI,CAAC"}

package/dist/src/types.js

@@ -0,0 +1 @@
+export {};

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/map-of.ts","../src/race.ts","../src/simple-event-emitter.ts","../src/types.ts","../__tests__/test.ts"],"version":"5.8.3"}

package/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "@ixfx/events",
+	"version": "0.36.0",
+	"license": "MIT",
+	"type": "module",
+	"sideEffects": false,
+	"files": [
+		"dist/"
+	],
+	"scripts": {
+		"build-test": "npx rimraf dist && tsc --build"
+	},
+	"exports": {
+		".": {
+			"types": "./src/index.ts",
+			"import": "./src/index.ts"
+		}
+	},
+	"dependencies": {},
+	"publishConfig": {
+		"main": "dist/src/index.js",
+		"exports": {
+			".": {
+				"types": "./dist/src/index.d.ts",
+				"import": "./dist/src/index.js"
+			}
+		}
+	}
+}