@ikonai/sdk-ui 0.0.11 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikonai/sdk-ui",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",

package/ui-store-ops.d.ts

@@ -0,0 +1,61 @@
+import { UIPayload } from '../../../shared/generated/src/index.ts';
+import { UiNode, UiOptimisticPatchState } from './ui-types';
+export interface UiStreamSnapshotWire {
+    streamId: string;
+    category?: string;
+    version: number;
+    rootViewId?: string;
+    views: Array<[viewId: string, node: UiNode]>;
+    payloads: Array<[key: string, payload: UIPayload]>;
+    optimisticPatches: Array<[viewId: string, patches: UiOptimisticPatchState[]]>;
+}
+export type UiStoreOp = {
+    type: 'ReplaceStreamSnapshot';
+    snapshot: UiStreamSnapshotWire;
+} | {
+    type: 'PatchStreamSnapshot';
+    streamId: string;
+    nextVersion: number;
+    expectedBaseVersion?: number;
+    rootViewId?: string;
+    upsertViews?: Array<[viewId: string, node: UiNode]>;
+    deleteViews?: string[];
+    upsertPayloads?: Array<[key: string, payload: UIPayload]>;
+    deletePayloads?: string[];
+    upsertOptimisticPatches?: Array<[viewId: string, patches: UiOptimisticPatchState[]]>;
+    deleteOptimisticPatchesForViews?: string[];
+    category?: string;
+} | {
+    type: 'SetStreamCategory';
+    streamId: string;
+    category?: string;
+} | {
+    type: 'ClearStream';
+    streamId: string;
+} | {
+    type: 'RemoveStream';
+    streamId: string;
+} | {
+    type: 'UpsertUiStyle';
+    style: {
+        styleId: string;
+        css?: string;
+        common?: string;
+    };
+} | {
+    type: 'RemoveUiStyle';
+    styleId: string;
+};
+export interface UiStoreOpBatch {
+    batchId: string;
+    createdAtMs: number;
+    ops: UiStoreOp[];
+    acks?: Array<{
+        trackId: number;
+        version: number;
+    }>;
+    stats?: {
+        uiMessagesConsumed: number;
+        bytesConsumed?: number;
+    };
+}

package/ui-store.d.ts

@@ -1,4 +1,5 @@
 import { ParsedUiUpdate, UiStoreSnapshot } from './ui-types';
+import { UiStoreOp, UiStreamSnapshotWire } from './ui-store-ops';
 type StreamListener = (streamId: string) => void;
 type StoreListener = () => void;
 export interface StreamSnapshot extends UiStoreSnapshot {
@@ -6,12 +7,18 @@ export interface StreamSnapshot extends UiStoreSnapshot {
     readonly category?: string;
 }
 export declare class UiStreamStore {
-    private readonly containers;
+    private readonly views;
     private readonly listeners;
     private readonly payloads;
+    private snapshotMode;
     private snapshot;
-    private rootContainerId?;
+    private rootViewId?;
     apply(update: ParsedUiUpdate): boolean;
+    replaceFromWire(wire: UiStreamSnapshotWire): boolean;
+    patchFromOp(op: Extract<UiStoreOp, {
+        type: 'PatchStreamSnapshot';
+    }>): boolean;
+    replaceSnapshot(next: UiStoreSnapshot): boolean;
     clear(): void;
     getSnapshot(): UiStoreSnapshot;
     subscribe(listener: StoreListener): () => void;
@@ -22,6 +29,8 @@ export declare class UiStore {
     private readonly streams;
     private readonly listeners;
     apply(streamId: string, update: ParsedUiUpdate): boolean;
+    applyStoreOp(op: UiStoreOp): boolean;
+    applyStoreOps(ops: readonly UiStoreOp[]): void;
     clear(streamId: string): void;
     remove(streamId: string): void;
     setCategory(streamId: string, category?: string): void;

package/ui-types.d.ts

@@ -1,11 +1,11 @@
 import { UIPayload } from '../../../shared/generated/src/index.ts';
 export type UiUpdateType = 'full' | 'diff';
-export type UiElementProps = Record<string, unknown>;
-export interface UiElementNode {
+export type UiNodeProps = Record<string, unknown>;
+export interface UiNode {
     readonly id: string;
     readonly type: string;
-    readonly props: UiElementProps;
-    readonly children: readonly UiElementNode[];
+    readonly props: UiNodeProps;
+    readonly children: readonly UiNode[];
     readonly styleIds: readonly string[];
 }
 export interface TextDelta {
@@ -15,18 +15,17 @@ export interface TextDelta {
     readonly end?: number;
     readonly insertedText: string;
 }
-export interface UiElementDiffNode {
+export interface UiNodeDiff {
     readonly id: string;
     readonly type: string;
-    readonly added: readonly UiElementNode[];
+    readonly added: readonly UiNode[];
     readonly removed: readonly string[];
-    readonly updated: readonly UiElementDiffNode[];
+    readonly updated: readonly UiNodeDiff[];
     readonly changedProps: ReadonlyMap<string, unknown>;
     readonly textUpdates: readonly TextDelta[];
-    readonly replaceProps?: UiElementProps;
 }
 export interface UiSnapshotMetadata {
-    readonly containerId: string;
+    readonly viewId: string;
     readonly optimisticActionId?: string | null;
     readonly isOptimistic?: boolean;
     readonly isUpdate?: boolean;
@@ -51,8 +50,8 @@ export interface UiOptimisticPatchState {
     readonly baseVersion: number;
 }
 export interface UiStoreSnapshot {
-    readonly rootContainerId?: string;
-    readonly containers: ReadonlyMap<string, UiElementNode>;
+    readonly rootViewId?: string;
+    readonly views: ReadonlyMap<string, UiNode>;
     readonly payloads: ReadonlyMap<string, UIPayload>;
     readonly optimisticPatches: ReadonlyMap<string, readonly UiOptimisticPatchState[]>;
     readonly version?: number;
@@ -64,11 +63,11 @@ interface UiSnapshotBase {
 }
 export interface UiFullSnapshot extends UiSnapshotBase {
     readonly type: 'full';
-    readonly root: UiElementNode;
+    readonly root: UiNode;
 }
 export interface UiDiffSnapshot extends UiSnapshotBase {
     readonly type: 'diff';
-    readonly diff: UiElementDiffNode;
+    readonly diff: UiNodeDiff;
 }
 export type UiSnapshot = UiFullSnapshot | UiDiffSnapshot;
 export interface ParsedUiUpdate {

package/ui-worker.d.ts

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