hyperstack-typescript 0.2.4 → 0.3.0

package/dist/index.d.ts

@@ -51,6 +51,7 @@ interface HyperStackOptions<TStack extends StackDefinition> {
     reconnectIntervals?: number[];
     maxReconnectAttempts?: number;
 }
+declare const DEFAULT_MAX_ENTRIES_PER_VIEW = 10000;
 interface HyperStackConfig {
     websocketUrl?: string;
     reconnectIntervals?: number[];
@@ -113,11 +114,11 @@ interface SnapshotFrame<T = unknown> {
 }
 type Frame<T = unknown> = EntityFrame<T> | SnapshotFrame<T>;
 declare function isSnapshotFrame<T>(frame: Frame<T>): frame is SnapshotFrame<T>;
-declare function parseFrame(data: ArrayBuffer | string): EntityFrame;
-declare function parseFrameFromBlob(blob: Blob): Promise<EntityFrame>;
+declare function parseFrame(data: ArrayBuffer | string): Frame;
+declare function parseFrameFromBlob(blob: Blob): Promise<Frame>;
 declare function isValidFrame(frame: unknown): frame is Frame;
 
-type FrameHandler = <T>(frame: EntityFrame<T>) => void;
+type FrameHandler = <T>(frame: Frame<T>) => void;
 declare class ConnectionManager {
     private ws;
     private websocketUrl;
@@ -151,36 +152,31 @@ declare class ConnectionManager {
     private stopPingInterval;
 }
 
-interface EntityStoreConfig {
+type UpdateCallback<T = unknown> = (viewPath: string, key: string, update: Update<T>) => void;
+type RichUpdateCallback<T = unknown> = (viewPath: string, key: string, update: RichUpdate<T>) => void;
+interface StorageAdapterConfig {
     maxEntriesPerView?: number | null;
 }
-type EntityUpdateCallback = (viewPath: string, key: string, update: Update<unknown>) => void;
-type RichUpdateCallback = (viewPath: string, key: string, update: RichUpdate<unknown>) => void;
-declare class EntityStore {
-    private views;
-    private updateCallbacks;
-    private richUpdateCallbacks;
-    private maxEntriesPerView;
-    constructor(config?: EntityStoreConfig);
-    private enforceMaxEntries;
-    handleFrame<T>(frame: Frame<T>): void;
-    private handleSnapshotFrame;
-    private handleEntityFrame;
-    getAll<T>(viewPath: string): T[];
+/**
+ * Storage adapter interface for HyperStack entity storage.
+ * Implement this to integrate with Zustand, Pinia, Svelte stores, Redux, IndexedDB, etc.
+ */
+interface StorageAdapter {
     get<T>(viewPath: string, key: string): T | null;
+    getAll<T>(viewPath: string): T[];
     getAllSync<T>(viewPath: string): T[] | undefined;
     getSync<T>(viewPath: string, key: string): T | null | undefined;
+    has(viewPath: string, key: string): boolean;
     keys(viewPath: string): string[];
     size(viewPath: string): number;
-    clear(): void;
-    clearView(viewPath: string): void;
-    onUpdate(callback: EntityUpdateCallback): UnsubscribeFn;
-    onRichUpdate(callback: RichUpdateCallback): UnsubscribeFn;
-    subscribe<T>(viewPath: string, callback: SubscribeCallback<T>): UnsubscribeFn;
-    subscribeToKey<T>(viewPath: string, key: string, callback: SubscribeCallback<T>): UnsubscribeFn;
-    private notifyUpdate;
-    private notifyRichUpdate;
-    private notifyRichDelete;
+    set<T>(viewPath: string, key: string, data: T): void;
+    delete(viewPath: string, key: string): void;
+    clear(viewPath?: string): void;
+    evictOldest?(viewPath: string): string | undefined;
+    onUpdate(callback: UpdateCallback): () => void;
+    onRichUpdate(callback: RichUpdateCallback): () => void;
+    notifyUpdate<T>(viewPath: string, key: string, update: Update<T>): void;
+    notifyRichUpdate<T>(viewPath: string, key: string, update: RichUpdate<T>): void;
 }
 
 declare class SubscriptionRegistry {
@@ -195,34 +191,76 @@ declare class SubscriptionRegistry {
     private makeSubKey;
 }
 
+interface HyperStackOptionsWithStorage<TStack extends StackDefinition> extends HyperStackOptions<TStack> {
+    storage?: StorageAdapter;
+    maxEntriesPerView?: number | null;
+}
 declare class HyperStack<TStack extends StackDefinition> {
     private readonly connection;
-    private readonly store;
+    private readonly storage;
+    private readonly processor;
     private readonly subscriptionRegistry;
     private readonly _views;
     private readonly stack;
     private constructor();
-    static connect<T extends StackDefinition>(url: string, options: HyperStackOptions<T>): Promise<HyperStack<T>>;
+    static connect<T extends StackDefinition>(url: string, options: HyperStackOptionsWithStorage<T>): Promise<HyperStack<T>>;
     get views(): TypedViews<TStack['views']>;
     get connectionState(): ConnectionState;
     get stackName(): string;
+    get store(): StorageAdapter;
     onConnectionStateChange(callback: ConnectionStateCallback): UnsubscribeFn;
-    onFrame(callback: (frame: EntityFrame) => void): UnsubscribeFn;
+    onFrame(callback: (frame: Frame) => void): UnsubscribeFn;
     connect(): Promise<void>;
     disconnect(): void;
     isConnected(): boolean;
     clearStore(): void;
-    getStore(): EntityStore;
+    getStore(): StorageAdapter;
     getConnection(): ConnectionManager;
     getSubscriptionRegistry(): SubscriptionRegistry;
 }
 
-declare function createUpdateStream<T>(store: EntityStore, subscriptionRegistry: SubscriptionRegistry, subscription: Subscription, keyFilter?: string): AsyncIterable<Update<T>>;
-declare function createRichUpdateStream<T>(store: EntityStore, subscriptionRegistry: SubscriptionRegistry, subscription: Subscription, keyFilter?: string): AsyncIterable<RichUpdate<T>>;
+interface FrameProcessorConfig {
+    maxEntriesPerView?: number | null;
+}
+declare class FrameProcessor {
+    private storage;
+    private maxEntriesPerView;
+    constructor(storage: StorageAdapter, config?: FrameProcessorConfig);
+    handleFrame<T>(frame: Frame<T>): void;
+    private handleSnapshotFrame;
+    private handleEntityFrame;
+    private emitRichUpdate;
+    private enforceMaxEntries;
+}
+
+declare class MemoryAdapter implements StorageAdapter {
+    private views;
+    private updateCallbacks;
+    private richUpdateCallbacks;
+    constructor(_config?: StorageAdapterConfig);
+    get<T>(viewPath: string, key: string): T | null;
+    getAll<T>(viewPath: string): T[];
+    getAllSync<T>(viewPath: string): T[] | undefined;
+    getSync<T>(viewPath: string, key: string): T | null | undefined;
+    has(viewPath: string, key: string): boolean;
+    keys(viewPath: string): string[];
+    size(viewPath: string): number;
+    set<T>(viewPath: string, key: string, data: T): void;
+    delete(viewPath: string, key: string): void;
+    clear(viewPath?: string): void;
+    evictOldest(viewPath: string): string | undefined;
+    onUpdate(callback: UpdateCallback): () => void;
+    onRichUpdate(callback: RichUpdateCallback): () => void;
+    notifyUpdate<T>(viewPath: string, key: string, update: Update<T>): void;
+    notifyRichUpdate<T>(viewPath: string, key: string, update: RichUpdate<T>): void;
+}
+
+declare function createUpdateStream<T>(storage: StorageAdapter, subscriptionRegistry: SubscriptionRegistry, subscription: Subscription, keyFilter?: string): AsyncIterable<Update<T>>;
+declare function createRichUpdateStream<T>(storage: StorageAdapter, subscriptionRegistry: SubscriptionRegistry, subscription: Subscription, keyFilter?: string): AsyncIterable<RichUpdate<T>>;
 
-declare function createTypedStateView<T>(viewDef: ViewDef<T, 'state'>, store: EntityStore, subscriptionRegistry: SubscriptionRegistry): TypedStateView<T>;
-declare function createTypedListView<T>(viewDef: ViewDef<T, 'list'>, store: EntityStore, subscriptionRegistry: SubscriptionRegistry): TypedListView<T>;
-declare function createTypedViews<TStack extends StackDefinition>(stack: TStack, store: EntityStore, subscriptionRegistry: SubscriptionRegistry): TypedViews<TStack['views']>;
+declare function createTypedStateView<T>(viewDef: ViewDef<T, 'state'>, storage: StorageAdapter, subscriptionRegistry: SubscriptionRegistry): TypedStateView<T>;
+declare function createTypedListView<T>(viewDef: ViewDef<T, 'list'>, storage: StorageAdapter, subscriptionRegistry: SubscriptionRegistry): TypedListView<T>;
+declare function createTypedViews<TStack extends StackDefinition>(stack: TStack, storage: StorageAdapter, subscriptionRegistry: SubscriptionRegistry): TypedViews<TStack['views']>;
 
-export { ConnectionManager, DEFAULT_CONFIG, EntityStore, HyperStack, HyperStackError, SubscriptionRegistry, createRichUpdateStream, createTypedListView, createTypedStateView, createTypedViews, createUpdateStream, isSnapshotFrame, isValidFrame, parseFrame, parseFrameFromBlob };
-export type { ConnectionState, ConnectionStateCallback, EntityFrame, Frame, FrameMode, FrameOp, HyperStackConfig, HyperStackOptions, RichUpdate, SnapshotEntity, SnapshotFrame, StackDefinition, SubscribeCallback, Subscription, TypedListView, TypedStateView, TypedViewGroup, TypedViews, UnsubscribeFn, Update, ViewDef, ViewGroup };
+export { ConnectionManager, DEFAULT_CONFIG, DEFAULT_MAX_ENTRIES_PER_VIEW, FrameProcessor, HyperStack, HyperStackError, MemoryAdapter, SubscriptionRegistry, createRichUpdateStream, createTypedListView, createTypedStateView, createTypedViews, createUpdateStream, isSnapshotFrame, isValidFrame, parseFrame, parseFrameFromBlob };
+export type { ConnectionState, ConnectionStateCallback, EntityFrame, Frame, FrameMode, FrameOp, FrameProcessorConfig, HyperStackConfig, HyperStackOptions, HyperStackOptionsWithStorage, RichUpdate, RichUpdateCallback, SnapshotEntity, SnapshotFrame, StackDefinition, StorageAdapter, StorageAdapterConfig, SubscribeCallback, Subscription, TypedListView, TypedStateView, TypedViewGroup, TypedViews, UnsubscribeFn, Update, UpdateCallback, ViewDef, ViewGroup };