@salesforce/sf-embedding-bridge 2.2.2 → 2.2.3-rc.0

package/dist/bootstrap-session.d.ts

@@ -1,9 +1,10 @@
-import { JsonRpcClient } from "@salesforce/jsonrpc";
-import { type HostMetaData } from "@salesforce/sf-embedding-contract";
+import { type JsonRpcMeta, type Transport } from "@salesforce/jsonrpc";
+import { type EventsDispatchParams, type EventsSubscribeResult, type HostMetaData, type ResizeParams, type UiStateChangedParams, type UiStateSubscribeResult } from "@salesforce/sf-embedding-contract";
+import { EmbeddingResizer, JsonRpcRouter, type RequestHandler, type Unregister } from "utils";
 import { type BootstrapFailureReason } from "./bootstrap-listener";
 export type HostInitializedPayload = Record<string, unknown>;
 export interface SessionHandle {
-    client: JsonRpcClient;
+    bridge: EmbeddingBridge;
     hostMetaData: HostMetaData;
     hostInitialized: HostInitializedPayload;
 }
@@ -13,17 +14,49 @@ export declare class SessionFailureError extends Error {
     constructor(reason: SessionFailureReason, cause?: unknown);
 }
 export interface BootstrapSessionOptions {
-    /**
-     * Cancellation signal. The browser MessagePort API has no port-close event,
-     * so the consumer owns the deadline (e.g. AbortSignal.timeout(30_000)).
-     * Honored only on the first call; subsequent calls return the cached promise.
-     */
+    /** Cancellation signal. Consumer owns the deadline (e.g. AbortSignal.timeout(30_000)). */
     signal?: AbortSignal;
 }
 /**
- * Bootstraps the sf-embedding session. Single-attempt per iframe — recovery
- * from failure requires a host-driven remount (`port1` is one-shot; a new
- * session needs a new `MessageChannel` + `instanceId`).
+ * Embedding-side peer. One object that routes inbound requests (via
+ * `JsonRpcRouter`), handles inbound notifications, and exposes named methods
+ * for the embedding's outbound traffic. Register inbound handlers in the
+ * constructor; add outbound methods as the protocol grows.
  */
+export declare class EmbeddingBridge extends JsonRpcRouter {
+    private readonly hostInitialized;
+    private resizer;
+    constructor(transport: Transport);
+    /** Await the host's `host-initialized` notification. */
+    waitForHostInitialized(): Promise<HostInitializedPayload>;
+    /** Announce that the embedding has initialized. */
+    sendInitializedNotification(): void;
+    /** Subscribe to host UI-state. Returns the initial snapshot + active subscription id. */
+    sendUiStateSubscribe(): Promise<UiStateSubscribeResult>;
+    /** Tear down an active UI-state subscription. */
+    sendUiStateUnsubscribe(subscriptionId: string): Promise<void>;
+    /** Register a handler for `ui/notifications/ui-state-changed`. */
+    onUiStateChanged(handler: (params: UiStateChangedParams, meta?: JsonRpcMeta) => void): void;
+    /** Fire-and-forget dispatch of a custom event (bidirectional `ui/events/dispatch`).
+     * `options` controls DOM-event flags on the receiving side; defaults bubble + composed = true. */
+    sendEventDispatch(eventType: string, detail: unknown, options?: {
+        bubbles?: boolean;
+        composed?: boolean;
+        cancelable?: boolean;
+    }): void;
+    /** Subscribe to host-driven events. One subscription per session — local fan-out by eventType is the SDK's job. */
+    sendEventSubscribe(): Promise<EventsSubscribeResult>;
+    /** Tear down a host-event subscription. */
+    sendEventUnsubscribe(subscriptionId: string): Promise<void>;
+    /** Register a handler for inbound `ui/events/dispatch` (host → embedding). */
+    onEventDispatch(handler: (params: EventsDispatchParams, meta?: JsonRpcMeta) => void): void;
+    /** Fire-and-forget resize hint (`ui/notifications/resize`). */
+    sendResize(dimensions: ResizeParams): void;
+    /** Attach an auto-emit resizer; stopped on dispose. Replaces any prior resizer. */
+    attachResizer(resizer: EmbeddingResizer): void;
+    dispose(): void;
+}
+export type { RequestHandler, Unregister };
+/** Single-attempt per iframe; recovery from failure requires a host-driven remount. */
 export declare function bootstrapSession(options?: BootstrapSessionOptions): Promise<SessionHandle>;
 //# sourceMappingURL=bootstrap-session.d.ts.map