grist-widget-sdk 0.3.26 → 0.4.0

package/dist/create-grist-emulator-BCqp1BF9.d.ts

@@ -1,81 +0,0 @@
-import { E as EmulatorDocumentState, g as EventBus, c as EmulatorApiBundle, f as EmulatorTransport, I as InlineGristGlobal } from './inline-DpcT8tV9.js';
-import { d as GristWidgetColumnMap, b as GristReplicaDocument } from './types-D3JxUCfL.js';
-
-/**
- * Top-level emulator factory. Produces a fully-wired emulator instance:
- *
- *   - typed in-memory document state,
- *   - shared event bus,
- *   - the six host API impls,
- *   - one transport (inline by default, iframe when an iframe is provided),
- *   - imperative helpers (`mutate`, `apply`, `selectRow`, `selectTable`)
- *     that drive the document via the action engine and emit corresponding
- *     events.
- *
- * The instance is multi-instance friendly: nothing is stored on `window`.
- */
-
-type CreateGristEmulatorOptions = {
-    /** The starting document (must satisfy {@link parseDocument}). */
-    document: GristReplicaDocument;
-    /**
-     * Pick a transport:
-     *   - omit / "inline" → synthesises `window.grist` directly (or onto `target`),
-     *   - "iframe" → wires a real iframe loading `grist-plugin-api.js`.
-     */
-    transport?: {
-        kind: "inline";
-        target?: Window & typeof globalThis;
-    } | {
-        kind: "iframe";
-        iframe: HTMLIFrameElement;
-        targetOrigin?: string;
-    };
-    /** Initial widget options exposed via `WidgetAPI`. */
-    widgetOptions?: Record<string, unknown>;
-    /**
-     * Initial widget interaction info (`access_level` and friends) sent
-     * alongside `onOptions`. Defaults to `{ access_level: "read table" }`.
-     */
-    widgetInteraction?: Record<string, unknown>;
-    /** Initial document theme replayed on widget ready (host `message` channel). */
-    initialTheme?: "light" | "dark";
-};
-type GristEmulator = {
-    /** Underlying mutable document. Treat as read-only outside of `mutate(...)`. */
-    state: EmulatorDocumentState;
-    bus: EventBus;
-    api: EmulatorApiBundle;
-    transport: EmulatorTransport;
-    /** Synthesised `grist` global (only for the inline transport). */
-    grist?: InlineGristGlobal;
-    /** Apply a list of Grist user actions; emits the matching events. */
-    apply: (actions: unknown[][]) => {
-        retValues: unknown[];
-    };
-    /** Convenience helpers for tests and demos. */
-    mutate: {
-        addRow: (tableId: string, fields: Record<string, unknown>) => number;
-        updateRow: (tableId: string, rowId: number, fields: Record<string, unknown>) => void;
-        removeRow: (tableId: string, rowId: number) => void;
-    };
-    selectRow: (rowId: number | "new" | null) => void;
-    selectTable: (tableId: string) => void;
-    /**
-     * Set logical→real column mappings for the playground inspector (and tests).
-     * Pass `undefined` to clear — `mappings()` becomes `null` until set again.
-     */
-    setColumnMappings: (mappings: GristWidgetColumnMap | undefined) => void;
-    setOptions: (options: Record<string, unknown>) => Promise<void>;
-    setInteraction: (interaction: Record<string, unknown>) => void;
-    /** Host theme controls (`grist.on("message")` / `msg.theme`). */
-    theme: {
-        set: (theme: "light" | "dark") => void;
-    };
-    /** Tear down the emulator. Idempotent. */
-    dispose: () => void;
-};
-declare function createGristEmulator(options: CreateGristEmulatorOptions): GristEmulator;
-
-export { createGristEmulator as c };
-export type { CreateGristEmulatorOptions as C, GristEmulator as G };

package/dist/create-grist-emulator-DBM8OSIR.d.cts

@@ -1,81 +0,0 @@
-import { E as EmulatorDocumentState, g as EventBus, c as EmulatorApiBundle, f as EmulatorTransport, I as InlineGristGlobal } from './inline-C7DkvuET.cjs';
-import { d as GristWidgetColumnMap, b as GristReplicaDocument } from './types-D3JxUCfL.cjs';
-
-/**
- * Top-level emulator factory. Produces a fully-wired emulator instance:
- *
- *   - typed in-memory document state,
- *   - shared event bus,
- *   - the six host API impls,
- *   - one transport (inline by default, iframe when an iframe is provided),
- *   - imperative helpers (`mutate`, `apply`, `selectRow`, `selectTable`)
- *     that drive the document via the action engine and emit corresponding
- *     events.
- *
- * The instance is multi-instance friendly: nothing is stored on `window`.
- */
-
-type CreateGristEmulatorOptions = {
-    /** The starting document (must satisfy {@link parseDocument}). */
-    document: GristReplicaDocument;
-    /**
-     * Pick a transport:
-     *   - omit / "inline" → synthesises `window.grist` directly (or onto `target`),
-     *   - "iframe" → wires a real iframe loading `grist-plugin-api.js`.
-     */
-    transport?: {
-        kind: "inline";
-        target?: Window & typeof globalThis;
-    } | {
-        kind: "iframe";
-        iframe: HTMLIFrameElement;
-        targetOrigin?: string;
-    };
-    /** Initial widget options exposed via `WidgetAPI`. */
-    widgetOptions?: Record<string, unknown>;
-    /**
-     * Initial widget interaction info (`access_level` and friends) sent
-     * alongside `onOptions`. Defaults to `{ access_level: "read table" }`.
-     */
-    widgetInteraction?: Record<string, unknown>;
-    /** Initial document theme replayed on widget ready (host `message` channel). */
-    initialTheme?: "light" | "dark";
-};
-type GristEmulator = {
-    /** Underlying mutable document. Treat as read-only outside of `mutate(...)`. */
-    state: EmulatorDocumentState;
-    bus: EventBus;
-    api: EmulatorApiBundle;
-    transport: EmulatorTransport;
-    /** Synthesised `grist` global (only for the inline transport). */
-    grist?: InlineGristGlobal;
-    /** Apply a list of Grist user actions; emits the matching events. */
-    apply: (actions: unknown[][]) => {
-        retValues: unknown[];
-    };
-    /** Convenience helpers for tests and demos. */
-    mutate: {
-        addRow: (tableId: string, fields: Record<string, unknown>) => number;
-        updateRow: (tableId: string, rowId: number, fields: Record<string, unknown>) => void;
-        removeRow: (tableId: string, rowId: number) => void;
-    };
-    selectRow: (rowId: number | "new" | null) => void;
-    selectTable: (tableId: string) => void;
-    /**
-     * Set logical→real column mappings for the playground inspector (and tests).
-     * Pass `undefined` to clear — `mappings()` becomes `null` until set again.
-     */
-    setColumnMappings: (mappings: GristWidgetColumnMap | undefined) => void;
-    setOptions: (options: Record<string, unknown>) => Promise<void>;
-    setInteraction: (interaction: Record<string, unknown>) => void;
-    /** Host theme controls (`grist.on("message")` / `msg.theme`). */
-    theme: {
-        set: (theme: "light" | "dark") => void;
-    };
-    /** Tear down the emulator. Idempotent. */
-    dispose: () => void;
-};
-declare function createGristEmulator(options: CreateGristEmulatorOptions): GristEmulator;
-
-export { createGristEmulator as c };
-export type { CreateGristEmulatorOptions as C, GristEmulator as G };