@ikonai/sdk-react-ui 1.0.67 → 1.0.68

package/app/use-ikon-app.d.ts

@@ -77,11 +77,17 @@ export interface UseIkonAppOptions {
      */
     proxy?: boolean;
     /**
-     * Persist the last rendered UI to `localStorage` and re-seed it on the next load so the cached
-     * tree paints before the WebSocket connects (return-visit fast paint). Default: true. The cache
-     * is keyed per app + user and pruned across users on a shared device.
+     * Live snapshot: persist the last rendered UI to `localStorage` and re-seed it on the next load so
+     * the cached tree paints before the WebSocket connects (return-visit fast paint). Default: true.
+     * Keyed per app + user and pruned across users on a shared device.
      */
-    uiCache?: boolean;
+    liveSnapshot?: boolean;
+    /**
+     * Boot snapshot: seed the build-time `boot-snapshot.json` (present when the app was bundled with
+     * `--snapshot`) before the WebSocket connects, for instant first paint on a first visit. Default:
+     * true. Set false to skip both the prefetch and the seed.
+     */
+    bootSnapshot?: boolean;
 }
 /**
  * Result returned by the useIkonApp hook.
@@ -138,6 +144,13 @@ export interface UseIkonAppResult {
      * Whether the connection is ready to render UI.
      */
     isReady: boolean;
+    /**
+     * True once the live server UI is displayed — i.e. the first live UI update has replaced the
+     * seeded pre-render (boot snapshot or live snapshot) and the connection is not
+     * offline. Stays false while only the instant pre-render is on screen. Also exposed on the
+     * document element as `data-ikon-live`.
+     */
+    isLive: boolean;
     /**
      * True when the backend asked the client to display the platform branding banner (set for
      * low-tier app creators by the connect handshake). Defaults to false until connected.

package/ikon-ui.d.ts

@@ -1,11 +1,13 @@
 import { IkonClient } from '../../sdk/src/index.ts';
-import { IkonUiCore, IkonUiCoreConfig, IkonUiStreamListener, UiStyleListener, UiStyleDeleteListener, UiStylePayload } from '../../sdk-ui/src/index.ts';
+import { IkonUiCore, IkonUiCoreConfig, IkonUiStreamListener, IkonUiUpdateListener, UiStyleListener, UiStyleDeleteListener, UiStylePayload } from '../../sdk-ui/src/index.ts';
 import { IkonUiStoreEntry } from './surface';
 export interface IkonUiConfig {
     client?: IkonClient | null;
     core?: IkonUiCore;
-    /** Last-snapshot cache config, forwarded to the owned IkonUiCore. Ignored when `core` is supplied. */
-    cache?: IkonUiCoreConfig['cache'];
+    /** Live snapshot config, forwarded to the owned IkonUiCore. Ignored when `core` is supplied. */
+    liveSnapshot?: IkonUiCoreConfig['liveSnapshot'];
+    /** Boot snapshot toggle, forwarded to the owned IkonUiCore. Ignored when `core` is supplied. */
+    bootSnapshot?: IkonUiCoreConfig['bootSnapshot'];
 }
 type IkonUiListener = IkonUiStreamListener;
 export declare class IkonUi {
@@ -20,6 +22,7 @@ export declare class IkonUi {
     getStores(): ReadonlyMap<string, IkonUiStoreEntry>;
     getUiStyles(): readonly UiStylePayload[];
     subscribe(listener: IkonUiListener): () => void;
+    subscribeToUiUpdates(listener: IkonUiUpdateListener): () => void;
     subscribeToStyles(listener: UiStyleListener): () => void;
     subscribeToStyleDeletes(listener: UiStyleDeleteListener): () => void;
     private handleUiStreamCleared;