mindoodb-app-sdk 0.0.7 → 0.0.9

package/dist/{types-u5bAeQwY.d.ts → types-Bh1Q2qGN.d.ts}

@@ -1,4 +1,4 @@
-import { MindooDBAppBooleanExpression, MindooDBAppExpression, MindooDBAppViewSortDirection, MindooDBAppViewTotalMode, MindooDBAppViewDefinition, MindooDBAppViewPageRequest, MindooDBAppViewPageResult, MindooDBAppViewExpansionState, MindooDBAppViewRow, MindooDBAppViewLookupByPath, MindooDBAppViewCategoryChildrenPageRequest } from 'mindoodb-view-language';
+import { MindooDBAppBooleanExpression, MindooDBAppExpression, MindooDBAppViewSortDirection, MindooDBAppViewTotalMode, MindooDBAppViewDefinition } from 'mindoodb-view-language';
 
 /** Launch target used by the Administrator when opening an app. */
 type MindooDBAppRuntime = "iframe" | "window";
@@ -313,6 +313,74 @@ interface MindooDBAppBridgeViewportChangedMessage {
 }
 /** Any message that can travel across the dedicated bridge MessagePort. */
 type MindooDBAppBridgePortMessage = MindooDBAppBridgeRpcMessage | MindooDBAppBridgeStreamMessage | MindooDBAppBridgeThemeChangedMessage | MindooDBAppBridgeViewportChangedMessage;
+/** Placement hint for a host-rendered overlay menu. */
+type MindooDBAppMenuPlacement = "auto" | "bottom-start" | "bottom-end" | "top-start" | "top-end" | "right-start" | "left-start";
+/** Semantic hint allowing Haven to tune menu behavior or styling. */
+type MindooDBAppMenuKind = "context" | "dropdown" | "picker";
+/** Rectangle expressed in app-viewport coordinates. */
+interface MindooDBAppMenuRect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+/** Point anchor used for context menus or other click-triggered overlays. */
+interface MindooDBAppMenuPointAnchor {
+    type: "point";
+    x: number;
+    y: number;
+}
+/** Rectangle anchor used for toolbar menus or picker buttons. */
+interface MindooDBAppMenuRectAnchor {
+    type: "rect";
+    rect: MindooDBAppMenuRect;
+}
+/** Anchor describing where the host should position the rendered menu. */
+type MindooDBAppMenuAnchor = MindooDBAppMenuPointAnchor | MindooDBAppMenuRectAnchor;
+/** Visual separator between menu groups. */
+interface MindooDBAppMenuSeparatorItem {
+    separator: true;
+}
+/** One actionable entry in a structured host-rendered menu. */
+interface MindooDBAppMenuCommandItem {
+    id: string;
+    label: string;
+    enabled?: boolean;
+    destructive?: boolean;
+    checked?: boolean;
+    items?: MindooDBAppMenuItem[];
+}
+/** Structured menu item transported over the app bridge. */
+type MindooDBAppMenuItem = MindooDBAppMenuSeparatorItem | MindooDBAppMenuCommandItem;
+/** Request payload for a host-rendered overlay menu. */
+interface MindooDBAppShowMenuInput {
+    anchor: MindooDBAppMenuAnchor;
+    placement?: MindooDBAppMenuPlacement;
+    kind?: MindooDBAppMenuKind;
+    items: MindooDBAppMenuItem[];
+    dismissOnOutsideClick?: boolean;
+    dismissOnEscape?: boolean;
+    dismissOnViewportChange?: boolean;
+}
+/** Reason why a host-rendered menu was dismissed without a selection. */
+type MindooDBAppMenuDismissReason = "outside_click" | "escape" | "app_blur" | "viewport_change" | "hide" | "replaced";
+/** Successful selection result returned from a host-rendered menu. */
+interface MindooDBAppMenuSelectionResult {
+    action: "selected";
+    itemId: string;
+}
+/** Dismissal result returned from a host-rendered menu. */
+interface MindooDBAppMenuDismissedResult {
+    action: "dismissed";
+    reason: MindooDBAppMenuDismissReason;
+}
+/** Result returned when Haven closes or resolves a host-rendered menu. */
+type MindooDBAppShowMenuResult = MindooDBAppMenuSelectionResult | MindooDBAppMenuDismissedResult;
+/** Overlay menu operations exposed by the host session. */
+interface MindooDBAppMenuApi {
+    show(input: MindooDBAppShowMenuInput): Promise<MindooDBAppShowMenuResult>;
+    hide(): Promise<void>;
+}
 /** Pull-based read stream for document attachments. */
 interface MindooDBAppReadableAttachmentStream {
     read(): Promise<Uint8Array | null>;
@@ -336,28 +404,125 @@ interface MindooDBAppDocumentApi {
     listHistory(docId: string): Promise<MindooDBAppDocumentHistoryEntry[]>;
     getAtTimestamp(docId: string, timestamp: number): Promise<MindooDBAppHistoricalDocument>;
 }
-/** Handle for one created or opened virtual view. */
-interface MindooDBAppViewHandle {
+type MindooDBAppViewEntryKind = "category" | "document";
+/** Unique document identity within a multi-source view. */
+interface MindooDBAppScopedDocId {
+    origin: string;
+    docId: string;
+}
+/** Serialized view entry returned by the navigator APIs. */
+interface MindooDBAppViewEntry {
+    /** Unique occurrence key within the current navigator session. */
+    key: string;
+    kind: MindooDBAppViewEntryKind;
+    origin: string;
+    docId: string | null;
+    level: number;
+    parentKey: string | null;
+    categoryPath: unknown[];
+    columnValues: Record<string, unknown>;
+    descendantDocumentCount: number;
+    childCategoryCount: number;
+    childDocumentCount: number;
+    /** Stable continuation token for the current occurrence. */
+    position: string | null;
+    expanded: boolean;
+    selected: boolean;
+    isVisible: boolean;
+}
+/** Options that shape which subtree and entry kinds a navigator exposes. */
+interface MindooDBAppViewNavigatorOpenOptions {
+    includeCategories?: boolean;
+    includeDocuments?: boolean;
+    hideEmptyCategories?: boolean;
+    rootCategoryPath?: unknown[];
+    rootEntryKey?: string;
+}
+/** Input used when creating a dynamic view and immediately opening a navigator. */
+interface MindooDBAppCreateViewNavigatorInput {
+    databaseIds: string[];
+    definition: MindooDBAppViewDefinition;
+    options?: MindooDBAppViewNavigatorOpenOptions;
+}
+/** @deprecated Use `MindooDBAppCreateViewNavigatorInput`. */
+type MindooDBAppCreateViewInput = MindooDBAppCreateViewNavigatorInput;
+/** Range query options for key and key-range lookups within a category. */
+interface MindooDBAppViewNavigatorRangeQuery {
+    startKey?: unknown;
+    endKey?: unknown;
+    descending?: boolean;
+    exact?: boolean;
+}
+/** Options for batched navigator reads. */
+interface MindooDBAppViewNavigatorPageOptions {
+    limit?: number;
+    selectedOnly?: boolean;
+    startPosition?: string | null;
+}
+/** Paged batch of navigator entries. */
+interface MindooDBAppViewNavigatorPageResult {
+    entries: MindooDBAppViewEntry[];
+    nextPosition: string | null;
+    hasMore: boolean;
+}
+/** Serializable selection state for restoring a navigator session. */
+interface MindooDBAppViewNavigatorSelectionState {
+    selectAllByDefault: boolean;
+    entryKeys: string[];
+}
+/** Serializable expansion state for restoring a navigator session. */
+interface MindooDBAppViewNavigatorExpansionState {
+    expandAllByDefault: boolean;
+    expandLevel: number;
+    entryKeys: string[];
+}
+/** Stateful view navigator that closely mirrors the core VirtualViewNavigator. */
+interface MindooDBAppViewNavigator {
     getDefinition(): Promise<MindooDBAppViewDefinition>;
     refresh(): Promise<void>;
-    page(input?: MindooDBAppViewPageRequest): Promise<MindooDBAppViewPageResult>;
-    getExpansionState(): Promise<MindooDBAppViewExpansionState>;
-    setExpansionState(state: MindooDBAppViewExpansionState): Promise<MindooDBAppViewExpansionState>;
-    expand(rowKey: string): Promise<MindooDBAppViewExpansionState>;
-    collapse(rowKey: string): Promise<MindooDBAppViewExpansionState>;
-    expandAll(): Promise<MindooDBAppViewExpansionState>;
-    collapseAll(): Promise<MindooDBAppViewExpansionState>;
-    getRow(rowKey: string): Promise<MindooDBAppViewRow | null>;
-    getCategory(input: MindooDBAppViewLookupByPath): Promise<MindooDBAppViewRow | null>;
-    pageCategory(categoryKey: string, input?: MindooDBAppViewCategoryChildrenPageRequest): Promise<MindooDBAppViewPageResult>;
-    listCategoryDocumentIds(categoryKey: string): Promise<string[]>;
+    getCurrentEntry(): Promise<MindooDBAppViewEntry | null>;
+    gotoFirst(): Promise<boolean>;
+    gotoLast(): Promise<boolean>;
+    gotoNext(): Promise<boolean>;
+    gotoPrev(): Promise<boolean>;
+    gotoNextSibling(): Promise<boolean>;
+    gotoPrevSibling(): Promise<boolean>;
+    gotoParent(): Promise<boolean>;
+    gotoFirstChild(): Promise<boolean>;
+    gotoLastChild(): Promise<boolean>;
+    gotoPos(position: string): Promise<boolean>;
+    getPos(position: string): Promise<MindooDBAppViewEntry | null>;
+    findCategoryEntryByParts(parts: unknown[]): Promise<MindooDBAppViewEntry | null>;
+    entriesForward(options?: MindooDBAppViewNavigatorPageOptions): Promise<MindooDBAppViewNavigatorPageResult>;
+    entriesBackward(options?: MindooDBAppViewNavigatorPageOptions): Promise<MindooDBAppViewNavigatorPageResult>;
+    gotoNextSelected(): Promise<boolean>;
+    gotoPrevSelected(): Promise<boolean>;
+    select(origin: string, docId: string, selectParentCategories?: boolean): Promise<void>;
+    deselect(origin: string, docId: string): Promise<void>;
+    selectAllEntries(): Promise<void>;
+    deselectAllEntries(): Promise<void>;
+    isSelected(origin: string, docId: string): Promise<boolean>;
+    getSelectionState(): Promise<MindooDBAppViewNavigatorSelectionState>;
+    setSelectionState(state: MindooDBAppViewNavigatorSelectionState): Promise<void>;
+    expand(origin: string, docId: string): Promise<void>;
+    collapse(origin: string, docId: string): Promise<void>;
+    expandAll(): Promise<void>;
+    collapseAll(): Promise<void>;
+    expandToLevel(level: number): Promise<void>;
+    isExpanded(entryKey: string): Promise<boolean>;
+    getExpansionState(): Promise<MindooDBAppViewNavigatorExpansionState>;
+    setExpansionState(state: MindooDBAppViewNavigatorExpansionState): Promise<void>;
+    childEntries(entryKey: string, descending?: boolean): Promise<MindooDBAppViewEntry[]>;
+    childCategories(entryKey: string, descending?: boolean): Promise<MindooDBAppViewEntry[]>;
+    childDocuments(entryKey: string, descending?: boolean): Promise<MindooDBAppViewEntry[]>;
+    childCategoriesByKey(entryKey: string, key: unknown, exact?: boolean, descending?: boolean): Promise<MindooDBAppViewEntry[]>;
+    childDocumentsByKey(entryKey: string, key: unknown, exact?: boolean, descending?: boolean): Promise<MindooDBAppViewEntry[]>;
+    childCategoriesBetween(entryKey: string, range: MindooDBAppViewNavigatorRangeQuery): Promise<MindooDBAppViewEntry[]>;
+    childDocumentsBetween(entryKey: string, range: MindooDBAppViewNavigatorRangeQuery): Promise<MindooDBAppViewEntry[]>;
+    getSortedDocIds(descending?: boolean): Promise<MindooDBAppScopedDocId[]>;
+    getSortedDocIdsScoped(entryKey: string, descending?: boolean): Promise<MindooDBAppScopedDocId[]>;
     dispose(): Promise<void>;
 }
-/** Payload used when creating one dynamic view inside the current app session. */
-interface MindooDBAppCreateViewInput {
-    databaseId: string;
-    definition: MindooDBAppViewDefinition;
-}
 /** Attachment operations exposed by an opened database handle. */
 interface MindooDBAppAttachmentApi {
     list(docId: string): Promise<MindooDBAppAttachmentInfo[]>;
@@ -382,8 +547,9 @@ interface MindooDBAppSession {
     getLaunchContext(): Promise<MindooDBAppLaunchContext>;
     listDatabases(): Promise<MindooDBAppDatabaseInfo[]>;
     openDatabase(databaseId: string): Promise<MindooDBAppDatabase>;
-    createView(input: MindooDBAppCreateViewInput): Promise<MindooDBAppViewHandle>;
-    openView(viewId: string): Promise<MindooDBAppViewHandle>;
+    createViewNavigator(input: MindooDBAppCreateViewNavigatorInput): Promise<MindooDBAppViewNavigator>;
+    openViewNavigator(viewId: string, options?: MindooDBAppViewNavigatorOpenOptions): Promise<MindooDBAppViewNavigator>;
+    menus: MindooDBAppMenuApi;
     onThemeChange(listener: (theme: MindooDBAppHostTheme) => void): () => void;
     onViewportChange(listener: (viewport: MindooDBAppViewport) => void): () => void;
     disconnect(): Promise<void>;
@@ -393,4 +559,4 @@ interface MindooDBAppBridge {
     connect(options?: MindooDBAppBridgeConnectOptions): Promise<MindooDBAppSession>;
 }
 
-export type { MindooDBAppHistoryQuery as $, MindooDBAppConfiguredViewCategorizationStyle as A, MindooDBAppConfiguredViewColumn as B, MindooDBAppConfiguredViewColumnRole as C, MindooDBAppConfiguredViewExpressionMode as D, MindooDBAppConfiguredViewFieldExpression as E, MindooDBAppConfiguredViewFilterDefinition as F, MindooDBAppConfiguredViewFilterMode as G, MindooDBAppConfiguredViewFilterRule as H, MindooDBAppConfiguredViewFormulaExpression as I, MindooDBAppConfiguredViewFormulaFilterDefinition as J, MindooDBAppConfiguredViewPreviewMode as K, MindooDBAppConfiguredViewRuleFilterDefinition as L, MindooDBAppAttachmentPreviewMode as M, MindooDBAppConfiguredViewRuleMatchMode as N, MindooDBAppConfiguredViewRuleOperator as O, MindooDBAppConfiguredViewValueExpression as P, MindooDBAppCreateDocumentInput as Q, MindooDBAppCreateViewInput as R, MindooDBAppDatabase as S, MindooDBAppDatabaseInfo as T, MindooDBAppDocument as U, MindooDBAppDocumentApi as V, MindooDBAppDocumentHistoryEntry as W, MindooDBAppDocumentListQuery as X, MindooDBAppDocumentListResult as Y, MindooDBAppDocumentSummary as Z, MindooDBAppHistoricalDocument as _, MindooDBAppBridge as a, MindooDBAppHostTheme as a0, MindooDBAppLaunchContext as a1, MindooDBAppReadableAttachmentStream as a2, MindooDBAppResolvedViewDefinition as a3, MindooDBAppResolvedViewSource as a4, MindooDBAppRuntime as a5, MindooDBAppSession as a6, MindooDBAppThemeMode as a7, MindooDBAppUpdateDocumentInput as a8, MindooDBAppViewHandle as a9, MindooDBAppViewport as aa, MindooDBAppWritableAttachmentStream as ab, MindooDBAppAttachmentApi as b, MindooDBAppAttachmentChunk as c, MindooDBAppAttachmentInfo as d, MindooDBAppAttachmentPreviewOptions as e, MindooDBAppAttachmentPreviewSession as f, MindooDBAppBridgeConnectMessage as g, MindooDBAppBridgeConnectOptions as h, MindooDBAppBridgeConnectedMessage as i, MindooDBAppBridgeErrorPayload as j, MindooDBAppBridgePortMessage as k, MindooDBAppBridgeRpcError as l, MindooDBAppBridgeRpcMessage as m, MindooDBAppBridgeRpcRequest as n, MindooDBAppBridgeRpcSuccess as o, MindooDBAppBridgeStreamAbortRequest as p, MindooDBAppBridgeStreamAck as q, MindooDBAppBridgeStreamCloseRequest as r, MindooDBAppBridgeStreamError as s, MindooDBAppBridgeStreamMessage as t, MindooDBAppBridgeStreamOpenResult as u, MindooDBAppBridgeStreamReadRequest as v, MindooDBAppBridgeStreamWriteRequest as w, MindooDBAppBridgeThemeChangedMessage as x, MindooDBAppBridgeViewportChangedMessage as y, MindooDBAppCapability as z };
+export type { MindooDBAppHistoricalDocument as $, MindooDBAppConfiguredViewCategorizationStyle as A, MindooDBAppConfiguredViewColumn as B, MindooDBAppConfiguredViewColumnRole as C, MindooDBAppConfiguredViewExpressionMode as D, MindooDBAppConfiguredViewFieldExpression as E, MindooDBAppConfiguredViewFilterDefinition as F, MindooDBAppConfiguredViewFilterMode as G, MindooDBAppConfiguredViewFilterRule as H, MindooDBAppConfiguredViewFormulaExpression as I, MindooDBAppConfiguredViewFormulaFilterDefinition as J, MindooDBAppConfiguredViewPreviewMode as K, MindooDBAppConfiguredViewRuleFilterDefinition as L, MindooDBAppAttachmentPreviewMode as M, MindooDBAppConfiguredViewRuleMatchMode as N, MindooDBAppConfiguredViewRuleOperator as O, MindooDBAppConfiguredViewValueExpression as P, MindooDBAppCreateDocumentInput as Q, MindooDBAppCreateViewInput as R, MindooDBAppCreateViewNavigatorInput as S, MindooDBAppDatabase as T, MindooDBAppDatabaseInfo as U, MindooDBAppDocument as V, MindooDBAppDocumentApi as W, MindooDBAppDocumentHistoryEntry as X, MindooDBAppDocumentListQuery as Y, MindooDBAppDocumentListResult as Z, MindooDBAppDocumentSummary as _, MindooDBAppBridge as a, MindooDBAppHistoryQuery as a0, MindooDBAppHostTheme as a1, MindooDBAppLaunchContext as a2, MindooDBAppMenuAnchor as a3, MindooDBAppMenuApi as a4, MindooDBAppMenuCommandItem as a5, MindooDBAppMenuDismissReason as a6, MindooDBAppMenuDismissedResult as a7, MindooDBAppMenuItem as a8, MindooDBAppMenuKind as a9, MindooDBAppWritableAttachmentStream as aA, MindooDBAppMenuPlacement as aa, MindooDBAppMenuPointAnchor as ab, MindooDBAppMenuRect as ac, MindooDBAppMenuRectAnchor as ad, MindooDBAppMenuSelectionResult as ae, MindooDBAppMenuSeparatorItem as af, MindooDBAppReadableAttachmentStream as ag, MindooDBAppResolvedViewDefinition as ah, MindooDBAppResolvedViewSource as ai, MindooDBAppRuntime as aj, MindooDBAppScopedDocId as ak, MindooDBAppSession as al, MindooDBAppShowMenuInput as am, MindooDBAppShowMenuResult as an, MindooDBAppThemeMode as ao, MindooDBAppUpdateDocumentInput as ap, MindooDBAppViewEntry as aq, MindooDBAppViewEntryKind as ar, MindooDBAppViewNavigator as as, MindooDBAppViewNavigatorExpansionState as at, MindooDBAppViewNavigatorOpenOptions as au, MindooDBAppViewNavigatorPageOptions as av, MindooDBAppViewNavigatorPageResult as aw, MindooDBAppViewNavigatorRangeQuery as ax, MindooDBAppViewNavigatorSelectionState as ay, MindooDBAppViewport as az, MindooDBAppAttachmentApi as b, MindooDBAppAttachmentChunk as c, MindooDBAppAttachmentInfo as d, MindooDBAppAttachmentPreviewOptions as e, MindooDBAppAttachmentPreviewSession as f, MindooDBAppBridgeConnectMessage as g, MindooDBAppBridgeConnectOptions as h, MindooDBAppBridgeConnectedMessage as i, MindooDBAppBridgeErrorPayload as j, MindooDBAppBridgePortMessage as k, MindooDBAppBridgeRpcError as l, MindooDBAppBridgeRpcMessage as m, MindooDBAppBridgeRpcRequest as n, MindooDBAppBridgeRpcSuccess as o, MindooDBAppBridgeStreamAbortRequest as p, MindooDBAppBridgeStreamAck as q, MindooDBAppBridgeStreamCloseRequest as r, MindooDBAppBridgeStreamError as s, MindooDBAppBridgeStreamMessage as t, MindooDBAppBridgeStreamOpenResult as u, MindooDBAppBridgeStreamReadRequest as v, MindooDBAppBridgeStreamWriteRequest as w, MindooDBAppBridgeThemeChangedMessage as x, MindooDBAppBridgeViewportChangedMessage as y, MindooDBAppCapability as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mindoodb-app-sdk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "MindooDB app SDK for building apps that connect to the Haven host bridge",
   "license": "ISC",
   "author": "Mindoo GmbH",
@@ -40,7 +40,7 @@
     "prepublishOnly": "npm run build && npm run test"
   },
   "dependencies": {
-    "mindoodb-view-language": "0.0.7"
+    "mindoodb-view-language": "0.0.9"
   },
   "devDependencies": {
     "@types/node": "^25.5.0",