@tutti-os/browser-node 0.0.1

package/dist/electron-main/index.d.ts

@@ -0,0 +1,158 @@
+import { BrowserWindow, WebContents, WebPreferences } from 'electron';
+
+interface BrowserNodeLoopbackPreviewTarget {
+    readonly targetUrl: string;
+    readonly workspaceId?: string;
+}
+interface BrowserNodeLoopbackPreviewResolver {
+    resolveTarget(input: {
+        port: number;
+        url: string;
+    }): BrowserNodeLoopbackPreviewTarget | Promise<BrowserNodeLoopbackPreviewTarget | null> | null;
+}
+interface BrowserNodeLoopbackPreviewRoutingOptions {
+    readonly resolver: BrowserNodeLoopbackPreviewResolver;
+    readonly fallback?: "deny" | "direct";
+    readonly cacheTtlMs?: number;
+}
+
+type BrowserPreferredColorScheme = "dark" | "light";
+interface BrowserNodeElectronLogger {
+    debug?(message: string, metadata?: Record<string, unknown>): void;
+    info?(message: string, metadata?: Record<string, unknown>): void;
+    warn?(message: string, metadata?: Record<string, unknown>): void;
+}
+interface BrowserGuestWindowOpenHandlerResponse {
+    action: "allow" | "deny";
+    outlivesOpener?: boolean;
+    overrideBrowserWindowOptions?: Record<string, unknown>;
+}
+interface BrowserGuestWebContents {
+    readonly id?: number;
+    readonly navigationHistory?: {
+        canGoBack(): boolean;
+        canGoForward(): boolean;
+        goBack(): void;
+        goForward(): void;
+    };
+    canGoBack(): boolean;
+    canGoForward(): boolean;
+    capturePage?(): Promise<BrowserGuestNativeImage>;
+    getTitle(): string;
+    getURL(): string;
+    getUserAgent?(): string;
+    goBack(): void;
+    goForward(): void;
+    isDestroyed(): boolean;
+    isLoading(): boolean;
+    loadURL(url: string): Promise<void>;
+    off(event: string, listener: (...args: unknown[]) => void): this;
+    on(event: string, listener: (...args: unknown[]) => void): this;
+    openDevTools?(options?: BrowserGuestOpenDevToolsOptions): void;
+    reload(): void;
+    setUserAgent?(userAgent: string): void;
+    setWindowOpenHandler?(handler: (details: {
+        url: string;
+    }) => BrowserGuestWindowOpenHandlerResponse): void;
+}
+interface BrowserGuestOpenDevToolsOptions {
+    activate?: boolean;
+    mode: "left" | "right" | "bottom" | "undocked" | "detach";
+}
+interface BrowserGuestNativeImage {
+    getSize?(): {
+        height: number;
+        width: number;
+    };
+    isEmpty?(): boolean;
+    resize?(options: {
+        height?: number;
+        quality?: "best" | "good" | "better" | "nearest";
+        width?: number;
+    }): BrowserGuestNativeImage;
+    toDataURL(): string;
+}
+
+interface BrowserNodeElectronMainChannels {
+    readonly activate: string;
+    readonly capturePreview?: string;
+    readonly close: string;
+    readonly debugDump?: string;
+    readonly event: string;
+    readonly goBack: string;
+    readonly goForward: string;
+    readonly guestOpenUrl?: string;
+    readonly navigate: string;
+    readonly openDevTools?: string;
+    readonly openExternal?: string;
+    readonly prepareSession: string;
+    readonly registerGuest: string;
+    readonly reload: string;
+    readonly showDevToolsContextMenu?: string;
+    readonly unregisterGuest: string;
+}
+interface BrowserNodeElectronDevToolsContextMenuInput {
+    readonly label: string;
+    readonly openDevTools: () => Promise<void> | void;
+    readonly ownerWindow: BrowserWindow;
+    readonly point: {
+        x: number;
+        y: number;
+    };
+}
+interface RegisterBrowserNodeElectronMainInput {
+    readonly channels: BrowserNodeElectronMainChannels;
+    readonly getOwnerWindow: (event: unknown) => BrowserWindow | null;
+    readonly getPreferredColorScheme?: () => BrowserPreferredColorScheme;
+    readonly logger?: BrowserNodeElectronLogger;
+    readonly loopbackPreviewRouting?: BrowserNodeLoopbackPreviewRoutingOptions;
+    readonly openExternal: (url: string) => Promise<void> | void;
+    readonly registerHandler: <TPayload, TResult>(channel: string, handler: (event: unknown, payload: TPayload) => Promise<TResult> | TResult) => void;
+    readonly registerListener?: <TPayload>(channel: string, handler: (event: unknown, payload: TPayload) => void) => void;
+    readonly resolveWebContents: (input: {
+        event: unknown;
+        ownerWindow: BrowserWindow;
+        webContentsId: number;
+    }) => BrowserGuestWebContents | null;
+    readonly showDevToolsContextMenu?: (input: BrowserNodeElectronDevToolsContextMenuInput) => Promise<void> | void;
+    readonly syncPreferredColorScheme?: (contents: BrowserGuestWebContents, scheme: BrowserPreferredColorScheme) => Promise<void> | void;
+    readonly subscribePreferredColorScheme?: (listener: (scheme: BrowserPreferredColorScheme) => void) => () => void;
+}
+declare function registerBrowserNodeElectronMain(input: RegisterBrowserNodeElectronMainInput): void;
+
+declare function sanitizeBrowserGuestUserAgent(userAgent: string): string;
+declare function applyBrowserGuestUserAgent(contents: WebContents, logger?: BrowserNodeElectronLogger): void;
+
+interface BrowserSessionPartitionAllowedOptions {
+    additionalAllowedPrefixes?: readonly string[];
+}
+
+interface BrowserWebviewSecurityInput {
+    allowedSessionPartitions?: BrowserSessionPartitionAllowedOptions;
+    params: Record<string, string>;
+    resolvePreload?: BrowserWebviewPreloadResolver;
+    webPreferences: WebPreferences;
+}
+interface BrowserWebviewSecurityResult {
+    allowed: boolean;
+    reason: string | null;
+}
+type BrowserNodeWebviewMatcher = (params: Record<string, string>) => boolean;
+interface BrowserWebviewPreloadResolverInput {
+    params: Readonly<Record<string, string>>;
+}
+type BrowserWebviewPreloadResolver = (input: BrowserWebviewPreloadResolverInput) => string | null | undefined;
+declare function isBrowserNodeWebviewAttach(params: Record<string, string>, allowedSessionPartitions?: BrowserSessionPartitionAllowedOptions): boolean;
+declare function enforceBrowserWebviewSecurity({ allowedSessionPartitions, params, resolvePreload, webPreferences }: BrowserWebviewSecurityInput): BrowserWebviewSecurityResult;
+interface InstallBrowserWebviewSecurityInput {
+    allowedSessionPartitions?: BrowserSessionPartitionAllowedOptions;
+    contents: WebContents;
+    logger?: BrowserNodeElectronLogger;
+    onGuestAttached?: (guestContents: WebContents) => void;
+    openExternal: (url: string) => Promise<void> | void;
+    resolvePreload?: BrowserWebviewPreloadResolver;
+    shouldHandleWebview?: BrowserNodeWebviewMatcher;
+}
+declare function installBrowserWebviewSecurity({ allowedSessionPartitions, contents, logger, onGuestAttached, openExternal, resolvePreload, shouldHandleWebview }: InstallBrowserWebviewSecurityInput): () => void;
+
+export { type BrowserNodeElectronDevToolsContextMenuInput, type BrowserNodeElectronLogger, type BrowserNodeElectronMainChannels, type BrowserNodeLoopbackPreviewResolver, type BrowserNodeLoopbackPreviewRoutingOptions, type BrowserNodeLoopbackPreviewTarget, type BrowserNodeWebviewMatcher, type BrowserWebviewPreloadResolver, type BrowserWebviewPreloadResolverInput, type BrowserWebviewSecurityInput, type BrowserWebviewSecurityResult, type InstallBrowserWebviewSecurityInput, type RegisterBrowserNodeElectronMainInput, applyBrowserGuestUserAgent, enforceBrowserWebviewSecurity, installBrowserWebviewSecurity, isBrowserNodeWebviewAttach, registerBrowserNodeElectronMain, sanitizeBrowserGuestUserAgent };