@floegence/redevplugin-ui 0.4.3 → 0.6.5

package/dist/surface.d.ts

@@ -1,9 +1,10 @@
-import { PluginBridgeError } from "./errors.js";
+import { PluginBridgeError, type PluginMutationOutcome } from "./errors.js";
 import { pluginUIProtocolVersion } from "./contracts.gen.js";
-import { type OpaqueSurfaceAllowedTag } from "./opaque-surface-policy.gen.js";
 import { type FetchLike } from "./http.js";
 import { type PluginSurfaceScope } from "./surface-scope.js";
-export declare const opaqueSurfaceDocumentSchemaVersion: "redevplugin.opaque_surface_document.v2";
+import { type PluginUIVNode } from "./ui-reconciler.js";
+export type { PluginUIAttributeValue, PluginUIElementVNode, PluginUIPatchOperation, PluginUIVNode, } from "./ui-reconciler.js";
+export declare const opaqueSurfaceDocumentSchemaVersion: "redevplugin.opaque_surface_document.v3";
 export declare const pluginRiskPlanSchemaVersion: "redevplugin.capability.risk_plan.v1";
 export type PluginJSONValue = null | boolean | number | string | PluginJSONValue[] | PluginJSONObject;
 export type PluginJSONObject = {
@@ -26,7 +27,7 @@ export type TrustedParentBridgeHandshake = {
     active_fingerprint: string;
     bridge_nonce: string;
     asset_session_nonce: string;
-    plugin_state_version: number;
+    management_revision: number;
     revoke_epoch: number;
     ui_protocol_version: typeof pluginUIProtocolVersion;
 };
@@ -53,6 +54,7 @@ export type PluginBridgeResponse = {
     error_code: string;
     error: string;
     error_details?: PluginJSONObject;
+    mutation_outcome?: PluginMutationOutcome;
 };
 export type PluginBridgeCancelMessage = {
     type: "redevplugin.bridge.cancel";
@@ -70,6 +72,9 @@ export type PluginBridgeLifecycleAckMessage = {
 export type PluginUIActionEvent = {
     action: string;
     event: "click" | "input" | "change" | "submit" | "escape";
+    targetKey: string;
+    editRevision: number;
+    isComposing: boolean;
     value?: string;
     checked?: boolean;
     form_data?: Record<string, string>;
@@ -117,13 +122,6 @@ export type PluginCanvasPointerEvent = {
     pressure: number;
 };
 export type PluginCanvasInputEvent = PluginCanvasFocusEvent | PluginCanvasResizeEvent | PluginCanvasKeyEvent | PluginCanvasPointerEvent;
-export type PluginUIAttributeValue = string | number | boolean;
-export type PluginUIVNode = string | {
-    type: "element";
-    tag: OpaqueSurfaceAllowedTag;
-    attributes?: Record<string, PluginUIAttributeValue>;
-    children?: PluginUIVNode[];
-};
 export type PluginMethodResult<T = unknown> = {
     data: T;
     operation_id?: string;
@@ -227,16 +225,19 @@ export type PluginBridgeClientOptions = {
     port?: MessagePortLike;
     surfaceHandle?: string;
 };
+export type PluginBridgeRequestOptions = {
+    signal?: AbortSignal;
+};
 export declare class PluginBridgeClient {
     #private;
     readonly surfaceHandle: string;
     readonly timeoutMs: number;
     constructor(options?: PluginBridgeClientOptions);
     ready(): Promise<void>;
-    call<T = unknown>(method: string, params?: PluginJSONObject): Promise<T>;
-    readStream(streamHandle: string): Promise<PluginStreamReadResult>;
-    cancelOperation(operationID: string, reason?: string): Promise<void>;
-    render(tree: PluginUIVNode | PluginUIVNode[]): Promise<void>;
+    call<T = unknown>(method: string, params?: PluginJSONObject, options?: PluginBridgeRequestOptions): Promise<T>;
+    readStream(streamHandle: string, options?: PluginBridgeRequestOptions): Promise<PluginStreamReadResult>;
+    cancelOperation(operationID: string, reason?: string, options?: PluginBridgeRequestOptions): Promise<void>;
+    render(tree: PluginUIVNode): Promise<void>;
     openCanvas(canvasId: string): Promise<PluginCanvasSurface>;
     updateCanvasAccessibility(canvasId: string, state: PluginCanvasAccessibilityState): Promise<void>;
     loadImageAsset(assetId: string): Promise<ImageBitmap>;
@@ -322,7 +323,7 @@ export type PluginSurfacePreparationResult = {
     asset_session_nonce: string;
     entry_path: string;
     entry_sha256: string;
-    plugin_state_version: number;
+    management_revision: number;
     revoke_epoch: number;
     issued_at: string;
     expires_at: string;
@@ -340,7 +341,7 @@ export type PluginSurfaceHostBootstrap = {
     entrySHA256: string;
     assetTicket: string;
     assetSessionNonce: string;
-    pluginStateVersion: number;
+    managementRevision: number;
     revokeEpoch: number;
     runtimeGenerationId: string;
 };
@@ -348,6 +349,22 @@ export type PluginSurfaceOpeningProgress = {
     phase: "opening";
     elapsedMs: number;
 };
+export type PluginSurfaceHost = {
+    readonly element: HTMLIFrameElement;
+    readonly surfaceInstanceId: string;
+    sendLifecycle(event: Exclude<BridgeLifecycleEvent, {
+        type: "ready" | "dispose";
+    }>): void;
+    close(): Promise<PluginSurfaceCloseResult>;
+    dispose(): Promise<void>;
+};
+export type PreparedPluginSurfaceHost = PluginSurfaceHost & {
+    readonly bootstrap: PluginSurfaceHostBootstrap;
+    readonly bridgeChannelId: string;
+    readonly frameGenerationId: string;
+    readonly surfaceHandle: string;
+    open(): Promise<void>;
+};
 export type PluginSurfaceHostOptions = {
     bootstrap: PluginSurfaceHostBootstrap;
     hostTransport: ReDevPluginSurfaceTransport;
@@ -361,6 +378,13 @@ export type PluginSurfaceHostOptions = {
     onOpeningProgress?: (progress: PluginSurfaceOpeningProgress) => void;
     onError?: (error: PluginBridgeError) => void;
 };
+type PluginSurfaceOpeningRequest = {
+    pluginInstanceId: string;
+    surfaceScope: PluginSurfaceScope;
+    signal?: AbortSignal;
+    abortError: () => Error;
+    open: () => Promise<PluginSurfaceHostOptions>;
+};
 declare const redevPluginSurfaceTransportBrand: unique symbol;
 export type ReDevPluginSurfaceTransport = {
     readonly [redevPluginSurfaceTransportBrand]: true;
@@ -373,21 +397,30 @@ export declare function createReDevPluginSurfaceTransport(options?: ReDevPluginS
 export type OpaquePluginBootstrapHTMLOptions = {
     scriptNonce?: string;
 };
+export type PluginSurfaceQuiesceResult = {
+    outcome: "acknowledged" | "not_ready" | "timed_out";
+    durationMs: number;
+};
+export type PluginSurfaceCloseResult = {
+    quiesce: PluginSurfaceQuiesceResult;
+    revokeDurationMs: number;
+    totalDurationMs: number;
+};
 export declare function createOpaquePluginBootstrapHTML(options?: OpaquePluginBootstrapHTMLOptions): string;
-export declare class PluginSurfaceHost {
+export declare function createPreparedPluginSurfaceHost(options: PluginSurfaceHostOptions): PreparedPluginSurfaceHost;
+export type PluginSurfaceSlotState = "empty" | "opening" | "ready" | "error" | "disposed";
+export type PluginSurfaceSlotOptions = {
+    stage: HTMLElement;
+    onStateChange?: (state: PluginSurfaceSlotState, error?: PluginBridgeError) => void;
+    onSurfaceClosed?: (result: PluginSurfaceCloseResult) => void;
+};
+export declare function openPluginSurfaceInSlot(slot: PluginSurfaceSlot, request: PluginSurfaceOpeningRequest): Promise<PluginSurfaceHost>;
+export declare function openPreparedPluginSurfaceInSlot(slot: PluginSurfaceSlot, options: PluginSurfaceHostOptions | PromiseLike<PluginSurfaceHostOptions>): Promise<PluginSurfaceHost>;
+export declare class PluginSurfaceSlot {
     #private;
-    readonly element: HTMLIFrameElement;
-    readonly bootstrap: PluginSurfaceHostBootstrap;
-    readonly bridgeChannelId: string;
-    readonly frameGenerationId: string;
-    readonly surfaceHandle: string;
-    static create(options: PluginSurfaceHostOptions): PluginSurfaceHost;
+    readonly element: HTMLElement;
+    static create(options: PluginSurfaceSlotOptions): PluginSurfaceSlot;
     private constructor();
-    open(): Promise<void>;
-    sendLifecycle(event: Exclude<BridgeLifecycleEvent, {
-        type: "ready" | "dispose";
-    }>): void;
-    close(): Promise<void>;
-    dispose(): void;
+    close(): Promise<PluginSurfaceCloseResult | undefined>;
+    dispose(): Promise<void>;
 }
-export {};