@mmstack/primitives 20.4.4 → 20.4.5

package/fesm2022/mmstack-primitives.mjs

@@ -1,4 +1,5 @@
-import { untracked, signal, inject, DestroyRef, computed, PLATFORM_ID, isSignal, effect, ElementRef, linkedSignal, isDevMode, Injector, runInInjectionContext } from '@angular/core';
+import * as i0 from '@angular/core';
+import { untracked, signal, inject, DestroyRef, computed, PLATFORM_ID, isSignal, effect, ElementRef, linkedSignal, isDevMode, Injectable, Injector, runInInjectionContext } from '@angular/core';
 import { isPlatformServer } from '@angular/common';
 import { SIGNAL } from '@angular/core/primitives/signals';
 
@@ -1293,6 +1294,122 @@ function stored(fallback, { key, store: providedStore, serialize = JSON.stringif
     return writable;
 }
 
+class MessageBus {
+    channel = new BroadcastChannel('mmstack-tab-sync-bus');
+    listeners = new Map();
+    subscribe(id, listener) {
+        this.unsubscribe(id); // Ensure no duplicate listeners
+        const wrapped = (ev) => {
+            try {
+                if (ev.data?.id === id)
+                    listener(ev.data?.value);
+            }
+            catch {
+                // noop
+            }
+        };
+        this.channel.addEventListener('message', wrapped);
+        this.listeners.set(id, wrapped);
+        return {
+            unsub: (() => this.unsubscribe(id)).bind(this),
+            post: ((value) => this.channel.postMessage({ id, value })).bind(this),
+        };
+    }
+    unsubscribe(id) {
+        const listener = this.listeners.get(id);
+        if (!listener)
+            return;
+        this.channel.removeEventListener('message', listener);
+        this.listeners.delete(id);
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.1", ngImport: i0, type: MessageBus, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.1", ngImport: i0, type: MessageBus, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.1", ngImport: i0, type: MessageBus, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }] });
+function generateDeterministicID() {
+    const stack = new Error().stack;
+    if (stack) {
+        // Look for the actual caller (first non-internal frame)
+        const lines = stack.split('\n');
+        for (let i = 2; i < lines.length; i++) {
+            const line = lines[i];
+            if (line && !line.includes('tabSync') && !line.includes('MessageBus')) {
+                let hash = 0;
+                for (let j = 0; j < line.length; j++) {
+                    const char = line.charCodeAt(j);
+                    hash = (hash << 5) - hash + char;
+                    hash = hash & hash;
+                }
+                return `auto-${Math.abs(hash)}`;
+            }
+        }
+    }
+    throw new Error('Could not generate deterministic ID, please provide one manually.');
+}
+/**
+ * Synchronizes a WritableSignal across browser tabs using BroadcastChannel API.
+ *
+ * Creates a shared signal that automatically syncs its value between all tabs
+ * of the same application. When the signal is updated in one tab, all other
+ * tabs will receive the new value automatically.
+ *
+ * @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.
+ *
+ * @returns The same WritableSignal instance, now synchronized across tabs
+ *
+ * @throws {Error} When deterministic ID generation fails and no explicit ID is provided
+ *
+ * @example
+ * ```typescript
+ * // Basic usage - auto-generates channel ID from call site
+ * const theme = tabSync(signal('dark'));
+ *
+ * // With explicit ID (recommended for production)
+ * const userPrefs = tabSync(signal({ lang: 'en' }), { id: 'user-preferences' });
+ *
+ * // Changes in one tab will sync to all other tabs
+ * theme.set('light'); // All tabs will update to 'light'
+ * ```
+ *
+ * @remarks
+ * - Only works in browser environments (returns original signal on server)
+ * - Uses a single BroadcastChannel for all synchronized signals
+ * - Automatically cleans up listeners when the injection context is destroyed
+ * - Initial signal value after sync setup is not broadcasted to prevent loops
+ *
+ */
+function tabSync(sig, opt) {
+    if (isPlatformServer(inject(PLATFORM_ID)))
+        return sig;
+    const id = opt?.id || generateDeterministicID();
+    const bus = inject(MessageBus);
+    const { unsub, post } = bus.subscribe(id, (next) => sig.set(next));
+    let first = false;
+    const effectRef = effect(() => {
+        const val = sig();
+        if (!first) {
+            first = true;
+            return;
+        }
+        post(val);
+    }, ...(ngDevMode ? [{ debugName: "effectRef" }] : []));
+    inject(DestroyRef).onDestroy(() => {
+        effectRef.destroy();
+        unsub();
+    });
+    return sig;
+}
+
 function until(sourceSignal, predicate, options = {}) {
     const injector = options.injector ?? inject(Injector);
     return new Promise((resolve, reject) => {
@@ -1491,5 +1608,5 @@ function withHistory(source, opt) {
  * Generated bundle index. Do not edit.
  */
 
-export { combineWith, debounce, debounced, derived, distinct, elementVisibility, filter, isDerivation, isMutable, map, mapArray, mediaQuery, mousePosition, mutable, networkStatus, pageVisibility, pipeable, piped, prefersDarkMode, prefersReducedMotion, scrollPosition, select, sensor, stored, tap, throttle, throttled, toFakeDerivation, toFakeSignalDerivation, toWritable, until, windowSize, withHistory };
+export { combineWith, debounce, debounced, derived, distinct, elementVisibility, filter, isDerivation, isMutable, map, mapArray, mediaQuery, mousePosition, mutable, networkStatus, pageVisibility, pipeable, piped, prefersDarkMode, prefersReducedMotion, scrollPosition, select, sensor, stored, tabSync, tap, throttle, throttled, toFakeDerivation, toFakeSignalDerivation, toWritable, until, windowSize, withHistory };
 //# sourceMappingURL=mmstack-primitives.mjs.map