mindoodb-app-sdk 0.0.6 → 0.0.8

package/dist/{types-BDY_80wd.d.ts → types-C_kZcG24.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";
@@ -126,6 +126,11 @@ interface MindooDBAppAttachmentPreviewOptions {
     /** Historical snapshot timestamp previously obtained from `documents.history.getAtTimestamp()`. */
     timestamp?: number;
 }
+/** Resolved Haven preview session prepared for opening in a separate tab or window. */
+interface MindooDBAppAttachmentPreviewSession {
+    sessionId: string;
+    previewUrl: string;
+}
 /** Database entry visible to the app during launch and database listing. */
 interface MindooDBAppDatabaseInfo {
     id: string;
@@ -331,28 +336,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[]>;
@@ -361,6 +463,7 @@ interface MindooDBAppAttachmentApi {
     }>;
     openReadStream(docId: string, attachmentName: string): Promise<MindooDBAppReadableAttachmentStream>;
     openWriteStream(docId: string, attachmentName: string, contentType?: string): Promise<MindooDBAppWritableAttachmentStream>;
+    preparePreviewSession(docId: string, attachmentName: string, options?: MindooDBAppAttachmentPreviewOptions): Promise<MindooDBAppAttachmentPreviewSession>;
     openPreview(docId: string, attachmentName: string, options?: MindooDBAppAttachmentPreviewOptions): Promise<{
         ok: true;
     }>;
@@ -376,8 +479,8 @@ 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>;
     onThemeChange(listener: (theme: MindooDBAppHostTheme) => void): () => void;
     onViewportChange(listener: (viewport: MindooDBAppViewport) => void): () => void;
     disconnect(): Promise<void>;
@@ -387,4 +490,4 @@ interface MindooDBAppBridge {
     connect(options?: MindooDBAppBridgeConnectOptions): Promise<MindooDBAppSession>;
 }
 
-export type { MindooDBAppHostTheme as $, MindooDBAppConfiguredViewColumn as A, MindooDBAppConfiguredViewColumnRole as B, MindooDBAppConfiguredViewExpressionMode as C, MindooDBAppConfiguredViewFieldExpression as D, MindooDBAppConfiguredViewFilterDefinition as E, MindooDBAppConfiguredViewFilterMode as F, MindooDBAppConfiguredViewFilterRule as G, MindooDBAppConfiguredViewFormulaExpression as H, MindooDBAppConfiguredViewFormulaFilterDefinition as I, MindooDBAppConfiguredViewPreviewMode as J, MindooDBAppConfiguredViewRuleFilterDefinition as K, MindooDBAppConfiguredViewRuleMatchMode as L, MindooDBAppAttachmentPreviewMode as M, MindooDBAppConfiguredViewRuleOperator as N, MindooDBAppConfiguredViewValueExpression as O, MindooDBAppCreateDocumentInput as P, MindooDBAppCreateViewInput as Q, MindooDBAppDatabase as R, MindooDBAppDatabaseInfo as S, MindooDBAppDocument as T, MindooDBAppDocumentApi as U, MindooDBAppDocumentHistoryEntry as V, MindooDBAppDocumentListQuery as W, MindooDBAppDocumentListResult as X, MindooDBAppDocumentSummary as Y, MindooDBAppHistoricalDocument as Z, MindooDBAppHistoryQuery as _, MindooDBAppBridge as a, MindooDBAppLaunchContext as a0, MindooDBAppReadableAttachmentStream as a1, MindooDBAppResolvedViewDefinition as a2, MindooDBAppResolvedViewSource as a3, MindooDBAppRuntime as a4, MindooDBAppSession as a5, MindooDBAppThemeMode as a6, MindooDBAppUpdateDocumentInput as a7, MindooDBAppViewHandle as a8, MindooDBAppViewport as a9, MindooDBAppWritableAttachmentStream as aa, MindooDBAppAttachmentApi as b, MindooDBAppAttachmentChunk as c, MindooDBAppAttachmentInfo as d, MindooDBAppAttachmentPreviewOptions as e, MindooDBAppBridgeConnectMessage as f, MindooDBAppBridgeConnectOptions as g, MindooDBAppBridgeConnectedMessage as h, MindooDBAppBridgeErrorPayload as i, MindooDBAppBridgePortMessage as j, MindooDBAppBridgeRpcError as k, MindooDBAppBridgeRpcMessage as l, MindooDBAppBridgeRpcRequest as m, MindooDBAppBridgeRpcSuccess as n, MindooDBAppBridgeStreamAbortRequest as o, MindooDBAppBridgeStreamAck as p, MindooDBAppBridgeStreamCloseRequest as q, MindooDBAppBridgeStreamError as r, MindooDBAppBridgeStreamMessage as s, MindooDBAppBridgeStreamOpenResult as t, MindooDBAppBridgeStreamReadRequest as u, MindooDBAppBridgeStreamWriteRequest as v, MindooDBAppBridgeThemeChangedMessage as w, MindooDBAppBridgeViewportChangedMessage as x, MindooDBAppCapability as y, MindooDBAppConfiguredViewCategorizationStyle 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, MindooDBAppReadableAttachmentStream as a3, MindooDBAppResolvedViewDefinition as a4, MindooDBAppResolvedViewSource as a5, MindooDBAppRuntime as a6, MindooDBAppScopedDocId as a7, MindooDBAppSession as a8, MindooDBAppThemeMode as a9, MindooDBAppUpdateDocumentInput as aa, MindooDBAppViewEntry as ab, MindooDBAppViewEntryKind as ac, MindooDBAppViewNavigator as ad, MindooDBAppViewNavigatorExpansionState as ae, MindooDBAppViewNavigatorOpenOptions as af, MindooDBAppViewNavigatorPageOptions as ag, MindooDBAppViewNavigatorPageResult as ah, MindooDBAppViewNavigatorRangeQuery as ai, MindooDBAppViewNavigatorSelectionState as aj, MindooDBAppViewport as ak, MindooDBAppWritableAttachmentStream as al, 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.6",
+  "version": "0.0.8",
   "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.6"
+    "mindoodb-view-language": "0.0.7"
   },
   "devDependencies": {
     "@types/node": "^25.5.0",