@mmstack/primitives 19.3.5 → 19.3.6

package/fesm2022/mmstack-primitives.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { isDevMode, inject, Injector, untracked, effect, DestroyRef, linkedSignal, computed, signal, isSignal, ElementRef, PLATFORM_ID, Injectable, runInInjectionContext } from '@angular/core';
+import { isDevMode, inject, Injector, untracked, effect, DestroyRef, linkedSignal, computed, signal, isSignal, PLATFORM_ID, ElementRef, Injectable, runInInjectionContext } from '@angular/core';
 import { isPlatformServer } from '@angular/common';
 import { SIGNAL } from '@angular/core/primitives/signals';
 
@@ -351,9 +351,9 @@ function debounce(source, opt) {
 const { is } = Object;
 function mutable(initial, opt) {
     const baseEqual = opt?.equal ?? is;
-    let trigger = false;
+    let cnt = 0;
     const equal = (a, b) => {
-        if (trigger)
+        if (cnt > 0)
             return false;
         return baseEqual(a, b);
     };
@@ -363,9 +363,9 @@ function mutable(initial, opt) {
     });
     const internalUpdate = sig.update;
     sig.mutate = (updater) => {
-        trigger = true;
+        cnt++;
         internalUpdate(updater);
-        trigger = false;
+        cnt--;
     };
     sig.inline = (updater) => {
         sig.mutate((prev) => {
@@ -432,10 +432,10 @@ function derived(source, optOrKey, opt) {
                 };
     const rest = typeof optOrKey === 'object' ? { ...optOrKey, ...opt } : opt;
     const baseEqual = rest?.equal ?? Object.is;
-    let trigger = false;
+    let cnt = 0;
     const equal = isMutable(source)
         ? (a, b) => {
-            if (trigger)
+            if (cnt > 0)
                 return false;
             return baseEqual(a, b);
         }
@@ -444,9 +444,9 @@ function derived(source, optOrKey, opt) {
     sig.from = from;
     if (isMutable(source)) {
         sig.mutate = (updater) => {
-            trigger = true;
+            cnt++;
             sig.update(updater);
-            trigger = false;
+            cnt--;
         };
         sig.inline = (updater) => {
             sig.mutate((prev) => {
@@ -551,9 +551,11 @@ function indexArray(source, map, opt = {}) {
         });
     if (isWritableSignal(data) && isMutable(data) && !opt.equal) {
         opt.equal = (a, b) => {
-            if (a !== b)
-                return false; // actually check primitives and references
-            return false; // opt out for same refs
+            if (typeof a !== typeof b)
+                return false;
+            if (typeof a === 'object' || typeof a === 'function')
+                return false;
+            return a === b;
         };
     }
     return linkedSignal({
@@ -775,10 +777,35 @@ const filter = (predicate) => (src) => linkedSignal({
     },
 });
 /** tap into the value */
-const tap = (fn) => (src) => {
-    effect(() => fn(src()));
+const tap = (fn, injector) => (src) => {
+    effect(() => fn(src()), {
+        injector,
+    });
     return src;
 };
+/**
+ * Like {@link filter}, but emits `initial` until a value passes the predicate
+ * for the first time. Avoids the `T | undefined` return type.
+ */
+const filterWith = (predicate, initial) => (src) => linkedSignal({
+    source: src,
+    computation: (next, prev) => predicate(next) ? next : (prev?.value ?? initial),
+});
+/** Emits `initial` first, then mirrors source. */
+const startWith = (initial) => (src) => linkedSignal({
+    source: src,
+    computation: (next, prev) => (prev === undefined ? initial : next),
+});
+/** Emits `[prev, curr]` pairs. The first emission has prev = undefined. */
+const pairwise = () => (src) => linkedSignal({
+    source: src,
+    computation: (next, prev) => [prev?.source, next],
+});
+/** Reduce-like accumulator across emissions. */
+const scan = (reducer, seed) => (src) => linkedSignal({
+    source: src,
+    computation: (next, prev) => reducer(prev?.value ?? seed, next),
+});
 
 /**
  * Decorate any `Signal<T>` with a chainable `.pipe(...)` method.
@@ -882,12 +909,10 @@ function pooled({ create, reset, computation, ...opt }) {
         const next = other ?? untracked(() => create());
         if (current !== undefined) {
             if (currentFresh) {
-                // never-mutated buffer leaving the active slot; nothing to clean
                 other = current;
             }
             else {
-                // reset on release: clean the dirty buffer as it goes back into the pool
-                // (also threads the swap-return correctly into the pool's spare slot)
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- guarded by the `current !== undefined` check above
                 other = untracked(() => reset(current)) ?? current;
             }
         }
@@ -934,6 +959,87 @@ function pooledMap(optOrComputation, signalOpt) {
     return pooled(toPooledOptions(optOrComputation, createEmptyMap, resetClearable, signalOpt));
 }
 
+const EVENTS = [
+    'chargingchange',
+    'levelchange',
+    'chargingtimechange',
+    'dischargingtimechange',
+];
+/**
+ * Creates a read-only signal that tracks the system battery status using the
+ * Battery Status API. Returns `null` until the underlying `getBattery()`
+ * promise resolves, or permanently when the API is unsupported (Firefox /
+ * Safari at the time of writing). SSR-safe.
+ */
+function batteryStatus(debugName = 'batteryStatus') {
+    if (isPlatformServer(inject(PLATFORM_ID)) ||
+        typeof navigator === 'undefined' ||
+        typeof navigator.getBattery !== 'function') {
+        return computed(() => null, { debugName });
+    }
+    const state = signal(null, { debugName });
+    const abortController = new AbortController();
+    inject(DestroyRef).onDestroy(() => abortController.abort());
+    navigator.getBattery().then((battery) => {
+        if (abortController.signal.aborted)
+            return;
+        const read = () => ({
+            level: battery.level,
+            charging: battery.charging,
+            chargingTime: battery.chargingTime,
+            dischargingTime: battery.dischargingTime,
+        });
+        const onChange = () => state.set(read());
+        state.set(read());
+        for (const ev of EVENTS) {
+            battery.addEventListener(ev, onChange, {
+                signal: abortController.signal,
+            });
+        }
+    });
+    return state.asReadonly();
+}
+
+/**
+ * Creates a read-only signal mirroring the system clipboard contents.
+ *
+ * The signal value starts empty and updates whenever a `copy` event fires on
+ * the document (or {@link ClipboardSignal.copy} is invoked from this app).
+ * SSR-safe — returns `''` and `isSupported: false` on the server.
+ *
+ * Note: read access requires the Clipboard API and an active permission grant
+ * in browsers that gate it. Errors from `navigator.clipboard.readText` are
+ * swallowed silently to keep the signal value stable.
+ */
+function clipboard(debugName = 'clipboard') {
+    if (isPlatformServer(inject(PLATFORM_ID)) ||
+        typeof navigator === 'undefined' ||
+        !navigator.clipboard) {
+        const sig = computed(() => '', { debugName });
+        sig.copy = () => Promise.resolve();
+        sig.isSupported = computed(() => false);
+        return sig;
+    }
+    const state = signal('', { debugName });
+    const refresh = () => {
+        navigator.clipboard.readText().then((value) => state.set(value), () => {
+            // permission denied / focus required — ignore
+        });
+    };
+    const abortController = new AbortController();
+    const onCopy = () => refresh();
+    document.addEventListener('copy', onCopy, { signal: abortController.signal });
+    document.addEventListener('cut', onCopy, { signal: abortController.signal });
+    inject(DestroyRef).onDestroy(() => abortController.abort());
+    const sig = state.asReadonly();
+    sig.copy = async (value) => {
+        await navigator.clipboard.writeText(value);
+        state.set(value);
+    };
+    sig.isSupported = computed(() => true);
+    return sig;
+}
+
 function observerSupported$1() {
     return typeof ResizeObserver !== 'undefined';
 }
@@ -1134,6 +1240,167 @@ function elementVisibility(target = inject(ElementRef), opt) {
     return base;
 }
 
+function unwrap$1(target) {
+    if (!target)
+        return null;
+    return target instanceof ElementRef ? target.nativeElement : target;
+}
+/**
+ * Creates a read-only signal that tracks whether the focused element is the
+ * target or a descendant of it. Mirrors the CSS `:focus-within` pseudo-class.
+ *
+ * Defaults `target` to the current `ElementRef` so it can be used inline in a
+ * component's `class` field. SSR-safe — returns a constant `false` signal on
+ * the server.
+ */
+function focusWithin(target = inject(ElementRef)) {
+    if (isPlatformServer(inject(PLATFORM_ID))) {
+        return computed(() => false, { debugName: 'focusWithin' });
+    }
+    const state = signal(false, { debugName: 'focusWithin' });
+    const attach = (el) => {
+        state.set(el.contains(document.activeElement));
+        const abortController = new AbortController();
+        el.addEventListener('focusin', () => state.set(true), {
+            signal: abortController.signal,
+        });
+        el.addEventListener('focusout', () => {
+            // Defer so `document.activeElement` reflects the focus move.
+            queueMicrotask(() => state.set(el.contains(document.activeElement)));
+        }, { signal: abortController.signal });
+        return () => abortController.abort();
+    };
+    if (isSignal(target)) {
+        const targetSig = target;
+        effect((cleanup) => {
+            const el = unwrap$1(targetSig());
+            if (!el) {
+                state.set(false);
+                return;
+            }
+            cleanup(attach(el));
+        });
+    }
+    else {
+        const el = unwrap$1(target);
+        if (el) {
+            const detach = attach(el);
+            inject(DestroyRef).onDestroy(detach);
+        }
+    }
+    return state.asReadonly();
+}
+
+/**
+ * Creates a read-only signal that exposes the current geolocation position.
+ *
+ * The returned signal carries `error` and `loading` sub-signals for permission
+ * failures and the in-flight initial fetch respectively. SSR-safe — on the
+ * server the position is `null`, loading is `false`, and no API calls are made.
+ *
+ * @example
+ * ```ts
+ * const where = geolocation({ watch: true, enableHighAccuracy: true });
+ * effect(() => console.log(where()?.coords, where.error()));
+ * ```
+ */
+function geolocation(opt) {
+    if (isPlatformServer(inject(PLATFORM_ID)) || typeof navigator === 'undefined' || !navigator.geolocation) {
+        const sig = computed(() => null, {
+            debugName: opt?.debugName ?? 'geolocation',
+        });
+        sig.error = computed(() => null);
+        sig.loading = computed(() => false);
+        return sig;
+    }
+    const position = signal(null, {
+        debugName: opt?.debugName ?? 'geolocation',
+    });
+    const error = signal(null);
+    const loading = signal(true);
+    const onSuccess = (p) => {
+        position.set(p);
+        error.set(null);
+        loading.set(false);
+    };
+    const onError = (e) => {
+        error.set(e);
+        loading.set(false);
+    };
+    if (opt?.watch) {
+        const watchId = navigator.geolocation.watchPosition(onSuccess, onError, opt);
+        inject(DestroyRef).onDestroy(() => navigator.geolocation.clearWatch(watchId));
+    }
+    else {
+        navigator.geolocation.getCurrentPosition(onSuccess, onError, opt);
+    }
+    const sig = position.asReadonly();
+    sig.error = error.asReadonly();
+    sig.loading = loading.asReadonly();
+    return sig;
+}
+
+const DEFAULT_EVENTS = [
+    'mousemove',
+    'keydown',
+    'touchstart',
+    'scroll',
+    'visibilitychange',
+];
+const serverDate$1 = new Date();
+/**
+ * Creates a read-only signal that flips to `true` after a window of user
+ * inactivity. Any of the configured `events` (default: pointer/keyboard/scroll
+ * activity) resets the timer and flips the signal back to `false`.
+ *
+ * SSR-safe — always `false` with a frozen `since` date on the server.
+ */
+function idle(opt) {
+    if (isPlatformServer(inject(PLATFORM_ID))) {
+        const sig = computed(() => false, {
+            debugName: opt?.debugName ?? 'idle',
+        });
+        sig.since = computed(() => serverDate$1);
+        return sig;
+    }
+    const ms = opt?.ms ?? 60_000;
+    const events = opt?.events ?? DEFAULT_EVENTS;
+    const state = signal(false, { debugName: opt?.debugName ?? 'idle' });
+    const since = signal(new Date());
+    let timer;
+    const goIdle = () => {
+        if (state())
+            return;
+        state.set(true);
+        since.set(new Date());
+    };
+    const reset = () => {
+        if (timer)
+            clearTimeout(timer);
+        if (state()) {
+            state.set(false);
+            since.set(new Date());
+        }
+        timer = setTimeout(goIdle, ms);
+    };
+    const abortController = new AbortController();
+    for (const ev of events) {
+        window.addEventListener(ev, reset, {
+            passive: true,
+            signal: abortController.signal,
+        });
+    }
+    timer = setTimeout(goIdle, ms);
+    inject(DestroyRef).onDestroy(() => {
+        if (timer)
+            clearTimeout(timer);
+        abortController.abort();
+    });
+    const sig = state.asReadonly();
+    sig.since = since.asReadonly();
+    return sig;
+}
+
 /**
  * Creates a read-only signal that reactively tracks whether a CSS media query
  * string currently matches.
@@ -1295,26 +1562,41 @@ function throttled(initial, opt) {
  */
 function throttle(source, opt) {
     const ms = opt?.ms ?? 0;
+    const leading = opt?.leading ?? false;
+    const trailing = opt?.trailing ?? true;
     const trigger = signal(false);
+    const fire = () => trigger.update((c) => !c);
     let timeout;
+    let pendingTrailing = false;
     try {
         const destroyRef = opt?.destroyRef ?? inject(DestroyRef, { optional: true });
         destroyRef?.onDestroy(() => {
             if (timeout)
                 clearTimeout(timeout);
             timeout = undefined;
+            pendingTrailing = false;
         });
     }
     catch {
         // not in injection context & no destroyRef provided opting out of cleanup
     }
     const tick = () => {
-        if (timeout)
+        if (!timeout) {
+            if (leading)
+                fire();
+            else
+                pendingTrailing = trailing;
+            timeout = setTimeout(() => {
+                timeout = undefined;
+                if (trailing && pendingTrailing) {
+                    pendingTrailing = false;
+                    fire();
+                }
+            }, ms);
             return;
-        timeout = setTimeout(() => {
-            trigger.update((c) => !c);
-            timeout = undefined;
-        }, ms);
+        }
+        if (trailing)
+            pendingTrailing = true;
     };
     const set = (value) => {
         source.set(value);
@@ -1467,6 +1749,37 @@ function networkStatus(debugName = 'networkStatus') {
     return sig;
 }
 
+const SSR_FALLBACK = {
+    angle: 0,
+    type: 'portrait-primary',
+};
+/**
+ * Creates a read-only signal that tracks `screen.orientation`.
+ *
+ * SSR-safe — returns a constant `portrait-primary / 0°` signal on the server
+ * and in environments without `screen.orientation` support.
+ */
+function orientation(debugName = 'orientation') {
+    if (isPlatformServer(inject(PLATFORM_ID)) ||
+        typeof screen === 'undefined' ||
+        !screen.orientation) {
+        return computed(() => SSR_FALLBACK, { debugName });
+    }
+    const so = screen.orientation;
+    const read = () => ({
+        angle: so.angle,
+        type: so.type,
+    });
+    const state = signal(read(), {
+        debugName,
+        equal: (a, b) => a.angle === b.angle && a.type === b.type,
+    });
+    const onChange = () => state.set(read());
+    so.addEventListener('change', onChange);
+    inject(DestroyRef).onDestroy(() => so.removeEventListener('change', onChange));
+    return state.asReadonly();
+}
+
 /**
  * Creates a read-only signal that tracks the page's visibility state.
  *
@@ -1683,35 +1996,42 @@ function windowSize(opt) {
  * @internal
  */
 function sensor(type, options) {
+    const opts = options;
     switch (type) {
         case 'mousePosition':
-            return mousePosition(options);
+            return mousePosition(opts);
         case 'networkStatus':
-            return networkStatus(options?.debugName);
+            return networkStatus(opts?.debugName);
         case 'pageVisibility':
-            return pageVisibility(options?.debugName);
+            return pageVisibility(opts?.debugName);
         case 'darkMode':
         case 'dark-mode':
-            return prefersDarkMode(options?.debugName);
+            return prefersDarkMode(opts?.debugName);
         case 'reducedMotion':
         case 'reduced-motion':
-            return prefersReducedMotion(options?.debugName);
-        case 'mediaQuery': {
-            const opt = options;
-            return mediaQuery(opt.query, opt.debugName);
-        }
+            return prefersReducedMotion(opts?.debugName);
+        case 'mediaQuery':
+            return mediaQuery(opts.query, opts.debugName);
         case 'windowSize':
-            return windowSize(options);
+            return windowSize(opts);
         case 'scrollPosition':
-            return scrollPosition(options);
-        case 'elementVisibility': {
-            const opt = options;
-            return elementVisibility(opt.target, opt);
-        }
-        case 'elementSize': {
-            const opt = options;
-            return elementSize(opt.target, opt);
-        }
+            return scrollPosition(opts);
+        case 'elementVisibility':
+            return elementVisibility(opts?.target, opts);
+        case 'elementSize':
+            return elementSize(opts?.target, opts);
+        case 'geolocation':
+            return geolocation(opts);
+        case 'clipboard':
+            return clipboard(opts?.debugName);
+        case 'orientation':
+            return orientation(opts?.debugName);
+        case 'batteryStatus':
+            return batteryStatus(opts?.debugName);
+        case 'idle':
+            return idle(opts);
+        case 'focusWithin':
+            return focusWithin(opts?.target);
         default:
             throw new Error(`Unknown sensor type: ${type}`);
     }
@@ -1723,6 +2043,49 @@ function sensors(track, opt) {
     }, {});
 }
 
+function unwrap(t) {
+    if (!t)
+        return null;
+    return t instanceof ElementRef ? t.nativeElement : t;
+}
+function signalFromEvent(target, eventName, initial, projectOrOpt, maybeOpt) {
+    const project = typeof projectOrOpt === 'function' ? projectOrOpt : undefined;
+    const opt = typeof projectOrOpt === 'function' ? maybeOpt : projectOrOpt;
+    const injector = opt?.injector ?? inject(Injector);
+    if (isPlatformServer(injector.get(PLATFORM_ID))) {
+        return computed(() => initial, { debugName: opt?.debugName });
+    }
+    const state = signal(initial, {
+        debugName: opt?.debugName,
+    });
+    const handler = (event) => {
+        if (project)
+            state.set(project(event));
+        else
+            state.set(event);
+    };
+    const { destroyRef: providedDestroyRef, ...listenerOpts } = opt ?? {};
+    if (isSignal(target)) {
+        const targetSig = target;
+        effect((cleanup) => {
+            const resolved = unwrap(targetSig());
+            if (!resolved)
+                return;
+            resolved.addEventListener(eventName, handler, listenerOpts);
+            cleanup(() => resolved.removeEventListener(eventName, handler, listenerOpts));
+        }, { injector });
+    }
+    else {
+        const resolved = unwrap(target);
+        if (resolved) {
+            resolved.addEventListener(eventName, handler, listenerOpts);
+            const destroyRef = providedDestroyRef ?? injector.get(DestroyRef);
+            destroyRef.onDestroy(() => resolved.removeEventListener(eventName, handler, listenerOpts));
+        }
+    }
+    return untracked(() => state.asReadonly());
+}
+
 const IS_STORE = Symbol('MMSTACK::IS_STORE');
 const PROXY_CACHE = new WeakMap();
 const SIGNAL_FN_PROP = new Set([
@@ -2215,14 +2578,11 @@ function generateDeterministicID() {
  *
  * @template T - The type of the WritableSignal
  * @param sig - The WritableSignal to synchronize across tabs
- * @param opt - Optional configuration object
- * @param opt.id - Explicit channel ID for synchronization. If not provided,
- *                 a deterministic ID is generated based on the call site.
- *                 Use explicit IDs in production for reliability.
+ * @param opt - configuration object
+ * @param opt.id - Explicit channel ID for synchronization.
  *
  * @returns The same WritableSignal instance, now synchronized across tabs
  *
- * @throws {Error} When deterministic ID generation fails and no explicit ID is provided
  *
  * @example
  * ```typescript
@@ -2246,7 +2606,7 @@ function generateDeterministicID() {
 function tabSync(sig, opt) {
     if (isPlatformServer(inject(PLATFORM_ID)))
         return sig;
-    const id = opt?.id || generateDeterministicID();
+    const id = typeof opt === 'string' ? opt : (opt?.id ?? generateDeterministicID());
     const bus = inject(MessageBus);
     const { unsub, post } = bus.subscribe(id, (next) => sig.set(next));
     let first = false;
@@ -2378,8 +2738,13 @@ function getSignalEquality(sig) {
  * console.log('Can undo:', name.canUndo()); // false
  * ```
  */
-function withHistory(source, opt) {
-    const equal = opt?.equal ?? getSignalEquality(source);
+function withHistory(sourceOrValue, opt) {
+    const equal = (opt?.equal ?? isSignal(sourceOrValue))
+        ? getSignalEquality(sourceOrValue)
+        : Object.is;
+    const source = isSignal(sourceOrValue)
+        ? sourceOrValue
+        : signal(sourceOrValue);
     const maxSize = opt?.maxSize ?? Infinity;
     const history = mutable([], {
         ...opt,
@@ -2387,20 +2752,22 @@ function withHistory(source, opt) {
     });
     const redoArray = mutable([]);
     const originalSet = source.set;
+    const trim = (arr) => {
+        if (arr.length < maxSize)
+            return arr;
+        if (opt?.cleanupStrategy === 'shift') {
+            arr.shift();
+            return arr;
+        }
+        return arr.slice(Math.floor(maxSize / 2));
+    };
     const set = (value) => {
         const current = untracked(source);
         if (equal(value, current))
             return;
         source.set(value);
         history.mutate((c) => {
-            if (c.length >= maxSize) {
-                if (opt?.cleanupStrategy === 'shift') {
-                    c.shift();
-                }
-                else {
-                    c = c.slice(Math.floor(maxSize / 2));
-                }
-            }
+            c = trim(c);
             c.push(current);
             return c;
         });
@@ -2424,7 +2791,11 @@ function withHistory(source, opt) {
             return;
         originalSet.call(source, valueToRestore);
         history.inline((h) => h.pop());
-        redoArray.inline((r) => r.push(valueForRedo));
+        redoArray.mutate((r) => {
+            r = trim(r);
+            r.push(valueForRedo);
+            return r;
+        });
     };
     internal.redo = () => {
         const redoStack = untracked(redoArray);
@@ -2437,14 +2808,7 @@ function withHistory(source, opt) {
         originalSet.call(source, valueToRestore);
         redoArray.inline((r) => r.pop());
         history.mutate((h) => {
-            if (h.length >= maxSize) {
-                if (opt?.cleanupStrategy === 'shift') {
-                    h.shift();
-                }
-                else {
-                    h = h.slice(Math.floor(maxSize / 2));
-                }
-            }
+            h = trim(h);
             h.push(valueForUndo);
             return h;
         });
@@ -2463,5 +2827,5 @@ function withHistory(source, opt) {
  * Generated bundle index. Do not edit.
  */
 
-export { chunked, combineWith, debounce, debounced, derived, distinct, elementSize, elementVisibility, filter, indexArray, isDerivation, isMutable, isStore, keyArray, map, mapArray, mapObject, mediaQuery, mousePosition, mutable, mutableStore, nestedEffect, networkStatus, pageVisibility, pipeable, piped, pooled, pooledArray, pooledMap, pooledSet, prefersDarkMode, prefersReducedMotion, scrollPosition, select, sensor, sensors, store, stored, tabSync, tap, throttle, throttled, toFakeDerivation, toFakeSignalDerivation, toStore, toWritable, until, windowSize, withHistory };
+export { batteryStatus, chunked, clipboard, combineWith, debounce, debounced, derived, distinct, elementSize, elementVisibility, filter, filterWith, focusWithin, geolocation, idle, indexArray, isDerivation, isMutable, isStore, keyArray, map, mapArray, mapObject, mediaQuery, mousePosition, mutable, mutableStore, nestedEffect, networkStatus, orientation, pageVisibility, pairwise, pipeable, piped, pooled, pooledArray, pooledMap, pooledSet, prefersDarkMode, prefersReducedMotion, scan, scrollPosition, select, sensor, sensors, signalFromEvent, startWith, store, stored, tabSync, tap, throttle, throttled, toFakeDerivation, toFakeSignalDerivation, toStore, toWritable, until, windowSize, withHistory };
 //# sourceMappingURL=mmstack-primitives.mjs.map