@bardioc/app-sdk 0.4.11 → 0.5.0

package/dist/host-bridge.d.ts

@@ -1,3 +1,3 @@
 import type { HostBridge, HostBridgeConfig } from './types.js';
-/** Create a bridge between an iframe app and its host OS via `postMessage`. */
+/** Create a bridge between an app and its host OS, over `postMessage` unless `config.channel` says otherwise. */
 export declare function createHostBridge(config: HostBridgeConfig): HostBridge;

package/dist/host-bridge.js

@@ -13,29 +13,49 @@ function assertStoreName(storeName) {
     }
     return normalized;
 }
-/** Create a bridge between an iframe app and its host OS via `postMessage`. */
+/** Create a bridge between an app and its host OS, over `postMessage` unless `config.channel` says otherwise. */
 export function createHostBridge(config) {
     const { appId: hintAppId, connectTimeout = 5000, debug = false } = config;
-    const hostWindow = globalThis.window;
-    // When inside an iframe, document.referrer gives us the parent's origin.
-    const inferredHostOrigin = (() => {
-        try {
-            if (hostWindow.parent !== hostWindow && document.referrer) {
-                return new URL(document.referrer).origin;
-            }
-        }
-        catch {
-            // ignore parse errors
-        }
-        return hostWindow.location.origin;
-    })();
-    const targetOrigin = config.targetOrigin ?? inferredHostOrigin;
-    const isInsideIframe = hostWindow.parent !== hostWindow;
     function log(...args) {
         if (debug)
             console.log('[app-sdk]', ...args);
     }
-    log('createHostBridge', { appId: hintAppId, targetOrigin, isInsideIframe });
+    function windowChannel() {
+        const hostWindow = globalThis.window;
+        // When inside an iframe, document.referrer gives us the parent's origin.
+        const inferredHostOrigin = (() => {
+            try {
+                if (hostWindow.parent !== hostWindow && document.referrer) {
+                    return new URL(document.referrer).origin;
+                }
+            }
+            catch {
+                // ignore parse errors
+            }
+            return hostWindow.location.origin;
+        })();
+        const targetOrigin = config.targetOrigin ?? inferredHostOrigin;
+        const isInsideIframe = hostWindow.parent !== hostWindow;
+        log('createHostBridge', { appId: hintAppId, targetOrigin, isInsideIframe });
+        function isAllowedMessageOrigin(origin) {
+            return origin === targetOrigin || origin === hostWindow.location.origin;
+        }
+        return {
+            post: message => hostWindow.parent.postMessage(message, targetOrigin),
+            subscribe(receive) {
+                const onMessage = (event) => {
+                    if (!isAllowedMessageOrigin(event.origin)) {
+                        log('ignoring message from', event.origin, '(expected', targetOrigin, ')');
+                        return;
+                    }
+                    receive(event.data);
+                };
+                hostWindow.addEventListener('message', onMessage);
+                return () => hostWindow.removeEventListener('message', onMessage);
+            },
+        };
+    }
+    const channel = config.channel ?? windowChannel();
     let _connected = false;
     let _context = null;
     let _destroyed = false;
@@ -43,9 +63,6 @@ export function createHostBridge(config) {
     const osConfigUpdateCallbacks = new Set();
     const eventHandlers = new Map();
     const pending = new Map();
-    function isAllowedMessageOrigin(origin) {
-        return origin === targetOrigin || origin === hostWindow.location.origin;
-    }
     function handleCommandInvoke(data) {
         const { commandId } = data.payload;
         const handler = commandHandlers.get(commandId);
@@ -102,12 +119,7 @@ export function createHostBridge(config) {
         }
         request.resolve(data.payload);
     }
-    function onMessage(event) {
-        if (!isAllowedMessageOrigin(event.origin)) {
-            log('ignoring message from', event.origin, '(expected', targetOrigin, ')');
-            return;
-        }
-        const data = event.data;
+    function receive(data) {
         if (!data || typeof data.type !== 'string')
             return;
         if (!data.id)
@@ -131,9 +143,9 @@ export function createHostBridge(config) {
                 return;
         }
     }
-    hostWindow.addEventListener('message', onMessage);
+    const unsubscribe = channel.subscribe(receive);
     function postToHost(message) {
-        hostWindow.parent.postMessage(message, targetOrigin);
+        channel.post(message);
     }
     function respondToHost(id, payload, error) {
         postToHost({
@@ -293,7 +305,7 @@ export function createHostBridge(config) {
             }
             eventHandlers.clear();
             _destroyed = true;
-            hostWindow.removeEventListener('message', onMessage);
+            unsubscribe();
             for (const [, p] of pending)
                 p.reject(new Error('Bridge destroyed'));
             pending.clear();

package/dist/index.d.ts

@@ -5,4 +5,4 @@ export { SDK_CONTRACT_MATRIX, getRequiredPermissionForSdkMessage } from './contr
 export { ALLOWED_KERNEL_MESSAGES, SDK_MSG } from './protocol.js';
 export type { SdkMessageType } from './protocol.js';
 export { EntityNotFoundError, NetworkError, PermissionError, SdkError, TimeoutError, ValidationError, } from './errors.js';
-export type { Application, BackendRequestOptions, BackendTransport, BatchResult, CombinedQueryOptions, Configuration, CreateMemberInput, CreateUnitInput, DeleteOptions, EventSubscribeRequest, EventSubscribeResponse, EventUnsubscribeRequest, EventsApi, FileEntry, GetNodeOptions, GraphEdgeRaw, GraphEvent, GraphEventPushPayload, GraphEventType, GraphNodeRaw, GraphTransport, GremlinOptions, HistoryEntry, HistoryOptions, HostBridge, HostBridgeConfig, InstanceList, MutationOptions, NotifyLevel, OrgMember, OrgStructure, OrgUnit, OsConfig, OsRequestOptions, OsTransport, QueryOptions, SdkCommandDefinition, SdkCommandHandler, SdkCommandInvokePayload, SdkIdbDeletePayload, SdkIdbEntry, SdkIdbGetPayload, SdkIdbPutPayload, SdkIdbQueryPayload, SdkIdbStore, SdkInitResponse, SdkKernelProxyPayload, SdkMenuItem, SdkMenuRoot, SdkMessage, SdkNotifyPayload, SdkResponse, SdkSetActiveTabPayload, SdkSetCommandsPayload, SdkSetMenuPayload, SdkShortcutEventPayload, SdkStorage, SdkStorageDeletePayload, SdkStorageGetPayload, SdkStorageSetPayload, SdkTransport, SdkTransportPayload, TimeseriesAggregate, TimeseriesHistory, TimeseriesHistoryOptions, TimeseriesOptions, TimeseriesQueryOptions, TimeseriesValue, TransportScopeOptions, UpdateMemberInput, UpdateUnitInput, UserProfile, } from './types.js';
+export type { Application, BackendRequestOptions, BackendTransport, BatchResult, CombinedQueryOptions, Configuration, CreateMemberInput, CreateUnitInput, DeleteOptions, EventSubscribeRequest, EventSubscribeResponse, EventUnsubscribeRequest, EventsApi, FileEntry, GetNodeOptions, GraphEdgeRaw, GraphEvent, GraphEventPushPayload, GraphEventType, GraphNodeRaw, GraphTransport, GremlinOptions, HistoryEntry, HistoryOptions, HostBridge, HostBridgeConfig, InstanceList, MutationOptions, NotifyLevel, OrgMember, OrgStructure, OrgUnit, OsConfig, OsRequestOptions, OsTransport, QueryOptions, SdkChannel, SdkCommandDefinition, SdkCommandHandler, SdkCommandInvokePayload, SdkIdbDeletePayload, SdkIdbEntry, SdkIdbGetPayload, SdkIdbPutPayload, SdkIdbQueryPayload, SdkIdbStore, SdkInitResponse, SdkKernelProxyPayload, SdkMenuItem, SdkMenuRoot, SdkMessage, SdkNotifyPayload, SdkResponse, SdkSetActiveTabPayload, SdkSetCommandsPayload, SdkSetMenuPayload, SdkShortcutEventPayload, SdkStorage, SdkStorageDeletePayload, SdkStorageGetPayload, SdkStorageSetPayload, SdkTransport, SdkTransportPayload, TimeseriesAggregate, TimeseriesHistory, TimeseriesHistoryOptions, TimeseriesOptions, TimeseriesQueryOptions, TimeseriesValue, TransportScopeOptions, UpdateMemberInput, UpdateUnitInput, UserProfile, } from './types.js';

package/dist/react.d.ts

@@ -2,12 +2,14 @@ import { type ReactNode } from 'react';
 import type { GraphEvent, HostBridge, HostBridgeConfig, NotifyLevel, OsConfig, SdkCommandDefinition, SdkCommandHandler, SdkMenuRoot } from './types.js';
 export interface AppSdkProviderProps extends HostBridgeConfig {
     children: ReactNode;
+    /** Apply theme, language and size to this document. Default: `true`; `false` when the app shares the host document. */
+    applyOsConfig?: boolean;
 }
 export interface AppCommand extends SdkCommandDefinition {
     handler: SdkCommandHandler;
 }
 /** Mounts the SDK bridge and makes it available to descendant hooks. */
-export declare function AppSdkProvider({ children, ...config }: Readonly<AppSdkProviderProps>): import("react/jsx-runtime").JSX.Element | null;
+export declare function AppSdkProvider({ children, applyOsConfig, ...config }: Readonly<AppSdkProviderProps>): import("react/jsx-runtime").JSX.Element | null;
 /** Returns the raw {@link HostBridge}. Must be used inside `<AppSdkProvider>`. */
 export declare function useSdk(): HostBridge;
 /** Returns a stable callback that fires a host notification toast. */

package/dist/react.js

@@ -2,6 +2,8 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { createContext, useCallback, useContext, useEffect, useRef, useState, } from 'react';
 import { createHostBridge } from './host-bridge.js';
 const SdkContext = createContext(null);
+// One handshake per bridge, however often the effect that owns it reconnects.
+const connections = new WeakMap();
 const SYSTEM_SIZE_CLASS_NAMES = ['text-sm', 'text-base', 'text-lg', 'text-xl'];
 function applyOsConfigToDocument(osConfig) {
     if (!osConfig) {
@@ -39,28 +41,46 @@ function hasShortcutRoots(menu) {
     return menu.some(root => hasShortcutItems(root.items));
 }
 /** Mounts the SDK bridge and makes it available to descendant hooks. */
-export function AppSdkProvider({ children, ...config }) {
+export function AppSdkProvider({ children, applyOsConfig = true, ...config }) {
     const bridgeRef = useRef(null);
-    const { appId, connectTimeout, debug, targetOrigin } = config;
+    const { appId, channel, connectTimeout, debug, targetOrigin } = config;
     const configKey = JSON.stringify([
         appId ?? null,
         connectTimeout ?? null,
         debug ?? false,
         targetOrigin ?? null,
     ]);
-    const bridgeConfig = { appId, connectTimeout, debug, targetOrigin };
+    const bridgeConfig = { appId, channel, connectTimeout, debug, targetOrigin };
     const bridgeConfigKeyRef = useRef(null);
+    const pendingDestroyRef = useRef(null);
     const [readyConfigKey, setReadyConfigKey] = useState(null);
     const [errorState, setErrorState] = useState(null);
     useEffect(() => {
         let cancelled = false;
-        setReadyConfigKey(null);
-        setErrorState(null);
-        const bridge = createHostBridge(bridgeConfig);
+        // A disconnect followed at once by a reconnect (StrictMode, Activity) keeps the live bridge:
+        // the children holding it reconnect their own effects over it before this one runs.
+        const pending = pendingDestroyRef.current;
+        pendingDestroyRef.current = null;
+        if (pending)
+            clearTimeout(pending.timer);
+        let bridge;
+        if (pending && pending.configKey === configKey && pending.channel === channel) {
+            bridge = pending.bridge;
+        }
+        else {
+            pending?.destroy();
+            setReadyConfigKey(null);
+            setErrorState(null);
+            bridge = createHostBridge(bridgeConfig);
+        }
         bridgeRef.current = bridge;
         bridgeConfigKeyRef.current = configKey;
-        bridge
-            .connect()
+        let connecting = connections.get(bridge);
+        if (!connecting) {
+            connecting = bridge.connect();
+            connections.set(bridge, connecting);
+        }
+        connecting
             .then(() => {
             if (!cancelled) {
                 setReadyConfigKey(configKey);
@@ -75,17 +95,28 @@ export function AppSdkProvider({ children, ...config }) {
         });
         return () => {
             cancelled = true;
-            bridge.destroy();
-            if (bridgeRef.current === bridge) {
-                bridgeRef.current = null;
-            }
-            if (bridgeConfigKeyRef.current === configKey) {
-                bridgeConfigKeyRef.current = null;
-            }
+            const destroy = () => {
+                bridge.destroy();
+                if (bridgeRef.current === bridge) {
+                    bridgeRef.current = null;
+                    bridgeConfigKeyRef.current = null;
+                }
+            };
+            pendingDestroyRef.current = {
+                bridge,
+                configKey,
+                channel,
+                destroy,
+                timer: setTimeout(() => {
+                    pendingDestroyRef.current = null;
+                    destroy();
+                }),
+            };
         };
-    }, [appId, configKey, connectTimeout, debug, targetOrigin]);
+    }, [appId, channel, configKey, connectTimeout, debug, targetOrigin]);
     useEffect(() => {
-        if (readyConfigKey !== configKey ||
+        if (!applyOsConfig ||
+            readyConfigKey !== configKey ||
             bridgeConfigKeyRef.current !== configKey ||
             !bridgeRef.current) {
             return;
@@ -95,7 +126,7 @@ export function AppSdkProvider({ children, ...config }) {
             applyOsConfigToDocument(newConfig);
         });
         return unsubscribe;
-    }, [configKey, readyConfigKey]);
+    }, [applyOsConfig, configKey, readyConfigKey]);
     if (errorState?.configKey === configKey) {
         return _jsx("div", { "data-sdk-error": true, children: errorState.message });
     }

package/dist/types.d.ts

@@ -168,9 +168,18 @@ export interface SdkIdbQueryPayload {
     prefix?: string;
     limit?: number;
 }
+/** How bridge messages travel between an app and its host. */
+export interface SdkChannel {
+    /** Delivers one message to the host. */
+    post(message: SdkMessage | SdkResponse): void;
+    /** Hands every message from the host to `receive`; returns the unsubscribe. */
+    subscribe(receive: (message: SdkResponse) => void): () => void;
+}
 /** Configuration passed to {@link createHostBridge}. */
 export interface HostBridgeConfig {
     appId?: string;
+    /** Message transport. Default: `postMessage` with the parent window. */
+    channel?: SdkChannel;
     /** Override the host origin for `postMessage`. Inferred from `document.referrer` by default. */
     targetOrigin?: string;
     /** Handshake timeout in ms. Default: `5000`. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bardioc/app-sdk",
-  "version": "0.4.11",
+  "version": "0.5.0",
   "description": "SDK for building apps for the Bardioc OS",
   "license": "MIT",
   "private": false,