@webview-native-ui/engine 0.0.0-stage → 0.0.2

package/dist/projection/web.d.ts

@@ -0,0 +1,52 @@
+import type { WebProjectionSource, ScopedWebProjectionSource as Candidate, WebProjectionTransport } from '../types.js';
+import type { WebProjectionScope } from './scope.js';
+import { type ProjectionEvents } from './events.js';
+export interface WebProjectionOptions {
+    /** Existing plugin notifications, scoped to this presentation surface. */
+    events?: ProjectionEvents;
+    /** Debounce before preparing replacement pixels, in milliseconds. Defaults to 50; never delays handoff. */
+    captureDelayMs?: number;
+    wake(): void;
+    blocked(): boolean;
+    revision?(): number;
+    /** Content version for native pixel reuse; layout revision remains independent. */
+    captureRevision?(): number;
+    /** Select this surface's sources, e.g. the underlying page or the active overlay. */
+    eligible?(source: Candidate): boolean;
+    /** Reject a cached image when its owning surface has changed. */
+    current?(sources: HTMLElement[]): boolean;
+    /** Temporary movement handoff: rebase return pixels to the current display DOM. */
+    transient?: boolean;
+    /** Opaque full-view pixels map to the host border box and may paint beneath native. */
+    opaqueUnderlay?: boolean;
+}
+/** Images are prepared after accepted native updates, never on the overlay's critical path. */
+declare const createProjectionEngine: (scope: WebProjectionScope, transport: WebProjectionTransport, callbacks: WebProjectionOptions) => Promise<{
+    readonly owners: readonly HTMLElement[];
+    readonly visibleOwners: readonly HTMLElement[];
+    readonly preparedOwners: readonly HTMLElement[];
+    consider: (revision: number, candidates: Candidate[]) => void;
+    changed: (scrollOwner?: EventTarget) => void;
+    moved: () => void;
+    readonly token: string | undefined;
+    begin: () => void;
+    readonly restoring: boolean;
+    readonly handoffPending: boolean;
+    retireRestoration: () => void;
+    end: () => void;
+    updated: (token: string | undefined, restoredIDs?: string[], revision?: number) => void;
+    invalidate: () => void;
+    destroy(): Promise<void>;
+}>;
+type Engine = Awaited<ReturnType<typeof createProjectionEngine>>;
+export type WebProjection = Omit<Engine, 'consider'> & {
+    consider(revision: number, sources: WebProjectionSource[]): void;
+};
+export type WebProjectionBatch = Omit<Engine, 'consider'> & {
+    consider(revision: number, sources: Candidate[]): void;
+};
+/** One existing fallback DOM, with no separate document or rendering destination. */
+export declare const createWebProjection: (scope: WebProjectionScope, transport: WebProjectionTransport, options: WebProjectionOptions) => Promise<WebProjection>;
+/** A single Native transaction for multiple fixed fallback DOMs. */
+export declare const createWebProjectionBatch: (transport: WebProjectionTransport, options: WebProjectionOptions) => Promise<WebProjectionBatch>;
+export {};