mindoodb-app-sdk 0.0.49 → 0.0.53

package/dist/testing/index.d.ts

@@ -1,4 +1,4 @@
-import { as as MindooDBAppCreateViewNavigatorInput, cl as MindooDBAppViewNavigator, bd as MindooDBAppLaunchContext, at as MindooDBAppDatabaseInfo, aB as MindooDBAppDocumentApi, cn as MindooDBAppViewNavigatorOpenOptions, v as MindooDBAppAttachmentApi, b1 as MindooDBAppIdentityApi, cb as MindooDBAppTimestampApi, az as MindooDBAppDirectoryApi, j as MindooDBAppDocument, aZ as MindooDBAppFulltextSetup, aY as MindooDBAppExtractionSetup, bs as MindooDBAppProposeAppInput, bt as MindooDBAppProposeAppResult, e as MindooDBAppBridge, c0 as MindooDBAppSession, V as MindooDBAppBridgeRpcRequest, b0 as MindooDBAppHostTheme, ct as MindooDBAppViewport, cf as MindooDBAppUiPreferences, by as MindooDBAppQueryResult, cs as MindooDBAppViewUpdateStats, R as MindooDBAppBridgePortMessage, c as MindooDBAppDragStartResult, aS as MindooDBAppDragProfile } from '../types-C-eyC839.js';
+import { ay as MindooDBAppCreateViewNavigatorInput, cC as MindooDBAppViewNavigator, $ as MindooDBAppBridgeRpcRequest, b7 as MindooDBAppHostTheme, ag as MindooDBAppCapability, i as MindooDBAppDefinition, e as MindooDBAppBridge, cc as MindooDBAppSession, bE as MindooDBAppProposeAppInput, cK as MindooDBAppViewport, cw as MindooDBAppUiPreferences, bK as MindooDBAppQueryResult, cJ as MindooDBAppViewUpdateStats, X as MindooDBAppBridgePortMessage, bl as MindooDBAppLaunchContext, az as MindooDBAppDatabaseInfo, aI as MindooDBAppDocumentApi, cE as MindooDBAppViewNavigatorOpenOptions, A as MindooDBAppAttachmentApi, b8 as MindooDBAppIdentityApi, cs as MindooDBAppTimestampApi, aG as MindooDBAppDirectoryApi, k as MindooDBAppDocument, b4 as MindooDBAppFulltextSetup, b3 as MindooDBAppExtractionSetup, ck as MindooDBAppSummarySetup, bF as MindooDBAppProposeAppResult, c as MindooDBAppDragStartResult, aZ as MindooDBAppDragProfile } from '../types-CsKw_niD.js';
 import * as mindoodb from 'mindoodb';
 import 'mindoodb-view-language';
 
@@ -21,6 +21,92 @@ declare function loadMindoodbForTesting(): Promise<MindoodbVirtualViews | null>;
  */
 declare function createEvaluatingViewNavigator(input: MindooDBAppCreateViewNavigatorInput, documents: EvaluatingViewDocument[]): Promise<MindooDBAppViewNavigator | null>;
 
+/**
+ * A stand-in Haven for a real browser: the app runs in an iframe, exactly as Haven frames
+ * it, and talks to the same in-memory mock host the Vitest helpers use.
+ *
+ * This is what an app's test URL (`/__haven-test/` in the starter) mounts, so Playwright
+ * and a developer's own eyes see the real app — real bridge handshake, real DOM — with
+ * seeded data and scriptable host services, and without setting up an identity, a
+ * tenant and an install in a real Haven. It is never meant to be deployed where end
+ * users can reach it.
+ */
+/** A scan the test host hands out on the app's next `attachments.scan()` call. */
+interface BrowserTestHostScan {
+    fileName: string;
+    mimeType: "image/jpeg" | "image/png" | "application/pdf";
+    size: number;
+}
+/** What the test host recorded, in the order the app asked. */
+interface BrowserTestHostLog {
+    notifications: Array<{
+        id?: string;
+        severity?: string;
+        text?: string;
+        durationMs?: number;
+    }>;
+    previews: Array<{
+        databaseId: string;
+        docId: string;
+        attachmentName: string;
+    }>;
+    scans: Array<{
+        databaseId: string;
+        docId: string;
+        result: "scanned" | "cancelled";
+    }>;
+    focusRequests: number;
+    requests: MindooDBAppBridgeRpcRequest[];
+}
+interface CreateBrowserTestHostOptions extends CreateFakeBridgeHostOptions {
+    /** The iframe the app runs in. Its `src` is set by the host. */
+    frame: HTMLIFrameElement;
+    /** URL of the app page, relative to the test page or absolute. */
+    appUrl: string;
+    /** Called after every request, e.g. to re-render a control panel. */
+    onChange?: () => void;
+}
+interface BrowserTestHost {
+    host: FakeBridgeHostController;
+    log: BrowserTestHostLog;
+    /**
+     * Decides the outcome of the app's next `attachments.scan()`: a file description to
+     * "scan", or `null` to act as if the user cancelled. Without a call, scans cancel.
+     */
+    setNextScan(scan: BrowserTestHostScan | null): void;
+    setTheme(theme: MindooDBAppHostTheme): void;
+    setHostFocus(focused: boolean): void;
+    /** Reloads the app frame. The mock data survives; the app's in-memory state does not. */
+    reloadApp(): void;
+    dispose(): void;
+}
+/**
+ * The capabilities Haven grants for the permissions a definition requests. `read` is
+ * implied by the mapping, `write` is create plus update.
+ */
+declare function capabilitiesForDefinitionPermissions(permissions: readonly string[] | undefined): MindooDBAppCapability[];
+/** Mock databases for every database a `haven-app.json` declares, granted as requested. */
+declare function mockDatabasesFromDefinition(definition: Pick<MindooDBAppDefinition, "databases">, seed?: Record<string, MockMindooDBAppDatabaseDefinition["documents"]>): MockMindooDBAppDatabaseDefinition[];
+declare function createBrowserTestHost(options: CreateBrowserTestHostOptions): BrowserTestHost;
+interface MountHavenTestHostOptions extends Omit<CreateBrowserTestHostOptions, "frame" | "onChange"> {
+    /** Element to render into. Defaults to `document.body`, which is cleared. */
+    container?: HTMLElement;
+    /** Heading of the control panel, e.g. the app label. */
+    title?: string;
+}
+declare global {
+    interface Window {
+        /** Set by {@link mountHavenTestHost} so Playwright can script the host. */
+        __havenTestHost?: BrowserTestHost;
+    }
+}
+/**
+ * Renders the full test page: the app frame plus a control panel for theme, host focus
+ * and the next scan, and a live log of notifications, previews, scans and requests.
+ * The returned host is also available as `window.__havenTestHost`.
+ */
+declare function mountHavenTestHost(options: MountHavenTestHostOptions): BrowserTestHost;
+
 type MaybePromise<T> = T | Promise<T>;
 type MockViewApi = {
     create(input: MindooDBAppCreateViewNavigatorInput): MaybePromise<MindooDBAppViewNavigator>;
@@ -72,6 +158,13 @@ interface MockMindooDBAppDatabaseDefinition {
      * their setup/bootstrap logic.
      */
     extractionSetup?: MindooDBAppExtractionSetup | null;
+    /**
+     * Initial summary buffer configuration returned by `getSummarySetup()`.
+     * `setSummarySetup()` overwrites it for the lifetime of the handle. The
+     * mock's `query()` reads the seeded documents directly and ignores this
+     * config — it exists so apps can test their setup/bootstrap logic.
+     */
+    summarySetup?: MindooDBAppSummarySetup | null;
 }
 /**
  * Stands in for the host-owned sealed channel.
@@ -122,6 +215,8 @@ interface MockMindooDBAppSessionController {
     emitLocaleChange(locale: string): void;
     /** Runs the app's `onBeforeClose` listeners, as the host does before a teardown. */
     emitBeforeClose(): Promise<void>;
+    /** Sets whether this mock launch has host focus and notifies listeners. */
+    emitHostFocusChange(focused: boolean): void;
     resolveDrag(result: MindooDBAppDragStartResult): void;
     getDragProfile(): MindooDBAppDragProfile | null;
 }
@@ -140,6 +235,8 @@ type FakeBridgePortMessageHandler = (message: Exclude<MindooDBAppBridgePortMessa
 interface CreateFakeBridgeHostOptions extends CreateMockMindooDBAppSessionOptions {
     windowMode?: "parent" | "opener";
     requestHandlers?: Record<string, FakeBridgeRequestHandler>;
+    /** Called for every RPC request the app sends, before it is answered. */
+    onRequest?: (request: MindooDBAppBridgeRpcRequest) => void;
     onPortMessage?: FakeBridgePortMessageHandler;
 }
 interface FakeBridgeHostController {
@@ -150,11 +247,19 @@ interface FakeBridgeHostController {
     /** Every `apps.propose` call the app under test made, in order. */
     readonly proposedApps: ReadonlyArray<MindooDBAppProposeAppInput>;
     install(): void;
+    /**
+     * Answers a `mindoodb-app:connect` handshake received some other way than through
+     * `install()` — in a real browser, from the app frame's `message` event
+     * (`host.acceptConnection(event.data, event.ports)`). Returns `false` for messages
+     * that are not a handshake for this launch.
+     */
+    acceptConnection(message: unknown, transfer?: readonly Transferable[]): boolean;
     dispose(): void;
     emitThemeChange(theme: MindooDBAppHostTheme): void;
     emitViewportChange(viewport: MindooDBAppViewport): void;
     emitUiPreferencesChange(uiPreferences: MindooDBAppUiPreferences): void;
     emitLocaleChange(locale: string): void;
+    emitHostFocusChange(focused: boolean): void;
     /** Push a live-query result to connected apps, as the Haven host would. */
     emitQueryResult(subscriptionId: string, result: MindooDBAppQueryResult): void;
     /** Push a navigator view-changed event to connected apps. */
@@ -170,4 +275,4 @@ interface FakeBridgeHostController {
 }
 declare function createFakeBridgeHost(options?: CreateFakeBridgeHostOptions): FakeBridgeHostController;
 
-export { type CreateFakeBridgeHostOptions, type CreateMockMindooDBAppSessionOptions, type EvaluatingViewDocument, type FakeBridgeHostController, type FakeBridgePortMessageHandler, type FakeBridgeRequestHandler, type MockMindooDBAppDatabaseDefinition, type MockMindooDBAppSessionController, type MockSealedChannelOptions, type MockSeedDocument, createEvaluatingViewNavigator, createFakeBridgeHost, createMockMindooDBAppBridge, createMockMindooDBAppSession, loadMindoodbForTesting };
+export { type BrowserTestHost, type BrowserTestHostLog, type BrowserTestHostScan, type CreateBrowserTestHostOptions, type CreateFakeBridgeHostOptions, type CreateMockMindooDBAppSessionOptions, type EvaluatingViewDocument, type FakeBridgeHostController, type FakeBridgePortMessageHandler, type FakeBridgeRequestHandler, type MockMindooDBAppDatabaseDefinition, type MockMindooDBAppSessionController, type MockSealedChannelOptions, type MockSeedDocument, type MountHavenTestHostOptions, capabilitiesForDefinitionPermissions, createBrowserTestHost, createEvaluatingViewNavigator, createFakeBridgeHost, createMockMindooDBAppBridge, createMockMindooDBAppSession, loadMindoodbForTesting, mockDatabasesFromDefinition, mountHavenTestHost };