@apple-pie/slice 0.1.46 → 0.1.47

package/dist/types/stores/browserChannel/_types.d.ts

@@ -0,0 +1,24 @@
+import type { BrowserChannel, BrowserChannelMessage, ChannelConfig } from '../../utils';
+/**
+ * What the store's own `addChannel` / `addChannels` accept: a regular
+ * {@link ChannelConfig} minus its callbacks. The store always supplies its
+ * own `onMessageCallback` / `onErrorCallback` internally - since every
+ * `BrowserChannel` message (data or error) now flows through one unified
+ * callback, there's nothing left for a caller-supplied callback to do here.
+ * Reach for `useMessage` / `getMessage` to read what a channel receives, or
+ * use `BrowserChannel` directly when you need full control over callbacks.
+ */
+export type BrowserChannelConfig<T> = Omit<ChannelConfig<T>, 'onMessageCallback' | 'onErrorCallback'>;
+export interface BrowserChannelsStore {
+    channels: Record<string, BrowserChannel<any>> | null;
+    message: any;
+    messages: Record<string, BrowserChannelMessage<unknown>> | null;
+    actions: {
+        addChannel: (config: BrowserChannelConfig<any>, replace?: boolean) => void;
+        removeChannel: (channelName: string) => boolean;
+        addChannels: (configs: BrowserChannelConfig<any>[], replace?: boolean) => void;
+        removeChannels: () => boolean;
+        isActiveChannel: (channelName: string) => boolean;
+        post: <T>(channelName: string, message: T) => boolean;
+    };
+}

package/dist/types/stores/browserChannel/browserChannelsStore.d.ts

@@ -0,0 +1,42 @@
+import { BrowserChannel, type BrowserChannelMessage, type MessageType } from '../../utils';
+import type { BrowserChannelConfig, BrowserChannelsStore } from './_types';
+export declare const useBrowserChannelsStore: import("zustand").UseBoundStore<import("zustand").StoreApi<BrowserChannelsStore>>;
+export declare const useBrowserChannels: () => Record<string, BrowserChannel<any>> | null;
+export declare const useBrowserChannelActions: () => {
+    addChannel: (config: BrowserChannelConfig<any>, replace?: boolean) => void;
+    removeChannel: (channelName: string) => boolean;
+    addChannels: (configs: BrowserChannelConfig<any>[], replace?: boolean) => void;
+    removeChannels: () => boolean;
+    isActiveChannel: (channelName: string) => boolean;
+    post: <T>(channelName: string, message: T) => boolean;
+};
+export declare const useIsActiveChannel: (channelName: string) => boolean;
+/**
+ * Returns the latest message on one named channel, typed as `T`, optionally
+ * narrowed to one `MessageType`. Data and error messages share the same slot
+ * per channel - errors aren't tracked separately - so `useMessage(name)`
+ * always reflects whichever arrived most recently, while
+ * `useMessage(name, type)` returns `null` if the latest message doesn't
+ * match that type. Unlike the shared `message` field, this is scoped
+ * strictly to the named channel and never reflects any other channel's
+ * messages.
+ */
+export declare function useMessage<T = unknown>(channelName: string): BrowserChannelMessage<T> | null;
+export declare function useMessage<T = unknown>(channelName: string, type: MessageType): BrowserChannelMessage<T> | null;
+export declare const browserChannelActions: {
+    addChannel: (config: BrowserChannelConfig<any>, replace?: boolean) => void;
+    removeChannel: (channelName: string) => boolean;
+    addChannels: (configs: BrowserChannelConfig<any>[], replace?: boolean) => void;
+    removeChannels: () => boolean;
+    isActiveChannel: (channelName: string) => boolean;
+    post: <T>(channelName: string, message: T) => boolean;
+};
+export declare const getBrowserChannels: () => Record<string, BrowserChannel<any>> | null;
+export declare const getLastBrowserChannelMessage: () => any;
+/**
+ * Imperative, non-reactive counterpart to `useMessage`: snapshot-reads the
+ * latest message envelope for one named channel, typed as `T`, optionally
+ * narrowed to one `MessageType`.
+ */
+export declare function getMessage<T = unknown>(channelName: string): BrowserChannelMessage<T> | null;
+export declare function getMessage<T = unknown>(channelName: string, type: MessageType): BrowserChannelMessage<T> | null;

package/dist/types/stores/browserChannel/browserChannelsStore.test.d.ts

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

package/dist/types/stores/browserChannel/index.d.ts

@@ -0,0 +1,2 @@
+export { useBrowserChannelsStore, useBrowserChannels, useBrowserChannelActions, useIsActiveChannel, useMessage, browserChannelActions, getBrowserChannels, getLastBrowserChannelMessage, getMessage, } from './browserChannelsStore';
+export type { BrowserChannelConfig, BrowserChannelsStore } from './_types';

package/dist/types/stores/index.d.ts

@@ -9,3 +9,5 @@ export * from './volume';
 export * from './WebRTC';
 export * from './window';
 export * from './video';
+export { useBrowserChannelsStore, useBrowserChannels, useBrowserChannelActions, useIsActiveChannel, useMessage as useBrowserChannelMessage, browserChannelActions, getBrowserChannels, getLastBrowserChannelMessage, getMessage as getBrowserChannelMessage, } from './browserChannel';
+export type { BrowserChannelConfig, BrowserChannelsStore } from './browserChannel';

package/dist/types/utils/index.d.ts

@@ -2,5 +2,5 @@ export { copyToClipboard, hexToRgb } from './functions/misc';
 export { debounce } from './functions/debounce';
 export { rafThrottle } from './functions/rafThrottle';
 export * from './functions/colors';
-export { AudioVisualizer, IndexedDB, MdBuffer, SSEConnection, WebRTCConnection, WSConnection, } from './objects';
-export type { AudioVisualizerOptions, AudioVisualizerSource, IndexedDBOptions, MarkdownAutoCloseRule, MarkdownStreamBufferOptions, MarkdownStreamBufferSnapshot, SSECustomEvent, SSEConnectionCloseOption, SSEConnectionOptions, SSEEventMap, SSEUnifiedBuiltInMessage, SSEUnifiedCustomMessage, SSEUnifiedMessage, UnifiedMessageEvent, WebRTCConnectionOptions, WSConnectionOptions, } from './objects';
+export { AudioVisualizer, BrowserChannel, IndexedDB, MdBuffer, MessageType, SSEConnection, WebRTCConnection, WSConnection, } from './objects';
+export type { AudioVisualizerOptions, AudioVisualizerSource, BrowserChannelMessage, ChannelConfig, IndexedDBOptions, MarkdownAutoCloseRule, MarkdownStreamBufferOptions, MarkdownStreamBufferSnapshot, SSECustomEvent, SSEConnectionCloseOption, SSEConnectionOptions, SSEEventMap, SSEUnifiedBuiltInMessage, SSEUnifiedCustomMessage, SSEUnifiedMessage, UnifiedMessageEvent, WebRTCConnectionOptions, WSConnectionOptions, } from './objects';

package/dist/types/utils/objects/browserChannel/broadcastChannel.d.ts

@@ -0,0 +1,67 @@
+export declare enum MessageType {
+    Data = "data",
+    Error = "error"
+}
+/**
+ * Options for constructing a {@link BrowserChannel}.
+ */
+export interface ChannelConfig<T> {
+    name: string;
+    /**
+     * Optional human-readable label for this channel instance. The instance's
+     * actual {@link BrowserChannel.origin} is always unique - it is always
+     * this label joined with a generated UUID by a `.`, e.g. `'tab-1.<uuid>'`,
+     * or just `.<uuid>` (with an empty label) when none is given. The `.` is
+     * always present, so `origin.split('.')` reliably splits into
+     * `[label, uuid]`.
+     */
+    origin?: string;
+    onMessageCallback: (message: BrowserChannelMessage<T>) => void;
+    onErrorCallback: (event: MessageEvent) => void;
+}
+/**
+ * The envelope every {@link BrowserChannel} sends and receives. `origin`
+ * identifies which channel instance posted the message, so a receiver can
+ * tell messages from different senders on the same channel name apart.
+ */
+export type BrowserChannelMessage<T> = {
+    content: T | string;
+    type: MessageType;
+    origin: string;
+};
+/**
+ * A typed wrapper around the native `BroadcastChannel` API for posting and
+ * receiving messages between same-origin browsing contexts (tabs, windows,
+ * iframes, workers).
+ */
+export declare class BrowserChannel<T> {
+    readonly name: string;
+    /**
+     * Unique identifier for this channel instance, attached as `origin` to
+     * every message it posts. Always unique per instance, even across
+     * instances created with the same `name` or `origin` label.
+     */
+    readonly origin: string;
+    readonly channel: BroadcastChannel;
+    private readonly onMessageCallback;
+    private readonly onErrorCallback;
+    /**
+     * Open the underlying `BroadcastChannel` and attach listeners.
+     */
+    constructor(options: ChannelConfig<T>);
+    private attachListeners;
+    private cleanUpListeners;
+    private onMessage;
+    private onError;
+    /**
+     * Post a message to every other same-origin context listening on this
+     * channel. The message is wrapped with this instance's `origin` before
+     * being sent.
+     */
+    post(message: T): void;
+    /**
+     * Close the channel and remove its listeners. The instance should not be
+     * reused after calling this.
+     */
+    close(): void;
+}

package/dist/types/utils/objects/browserChannel/broadcastChannel.test.d.ts

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

package/dist/types/utils/objects/index.d.ts

@@ -10,3 +10,5 @@ export type { SSECustomEvent, SSEConnectionCloseOption, SSEConnectionOptions, SS
 export type { UnifiedMessageEvent, WSConnectionOptions, } from './WSConnection/WSConnection';
 export { WebRTCConnection } from './WebRTCConnection/WebRTCConnection';
 export type { WebRTCConnectionOptions } from './WebRTCConnection/_types';
+export { BrowserChannel, MessageType } from './browserChannel/broadcastChannel';
+export type { BrowserChannelMessage, ChannelConfig } from './browserChannel/broadcastChannel';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@apple-pie/slice",
-	"version": "0.1.46",
+	"version": "0.1.47",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.mjs",
 	"exports": {