mindoodb-app-sdk 0.0.18 → 0.0.20

package/dist/{types-jzokkBX5.d.ts → types-CQt2ObMu.d.ts}

@@ -277,6 +277,103 @@ interface MindooDBAppTextPatch {
     baseHeads?: string[];
     edits: MindooDBAppTextEdit[];
 }
+type MindooDBAppRichTextScalar = string | number | boolean | null;
+interface MindooDBAppRichTextImmutableString {
+    type: "immutableString";
+    value: string;
+}
+type MindooDBAppRichTextMaterializeValue = MindooDBAppRichTextScalar | MindooDBAppRichTextImmutableString | MindooDBAppRichTextMaterializeValue[] | {
+    [key: string]: MindooDBAppRichTextMaterializeValue;
+};
+interface MindooDBAppRichTextTextSpan {
+    type: "text";
+    value: string;
+    marks?: Record<string, MindooDBAppRichTextMaterializeValue>;
+}
+interface MindooDBAppRichTextBlockSpan {
+    type: "block";
+    value: Record<string, MindooDBAppRichTextMaterializeValue>;
+}
+type MindooDBAppRichTextSpan = MindooDBAppRichTextTextSpan | MindooDBAppRichTextBlockSpan;
+interface MindooDBAppRichTextMarkRange {
+    index: number;
+    length: number;
+    marks: Record<string, MindooDBAppRichTextMaterializeValue>;
+}
+interface MindooDBAppRichTextSpliceStep {
+    type: "splice";
+    index: number;
+    deleteCount: number;
+    insert?: string;
+    marks?: MindooDBAppRichTextMarkRange[];
+}
+type MindooDBAppRichTextStep = MindooDBAppRichTextSpliceStep;
+interface MindooDBAppRichTextStepPatch {
+    /** Path to the Automerge rich-text field inside the document payload. */
+    path: Array<string | number>;
+    /** Automerge heads of the document state these positional steps were based on. */
+    baseHeads?: string[];
+    /** Ordered rich-text positional operations to apply with Automerge splice/mark. */
+    steps: MindooDBAppRichTextStep[];
+}
+interface MindooDBAppRichTextPatch {
+    /** Path to the Automerge rich-text field inside the document payload. */
+    path: Array<string | number>;
+    /** Automerge heads of the document state this rich-text snapshot was based on. */
+    baseHeads?: string[];
+    /** Full JSON-safe span snapshot to apply with Automerge `updateSpans`. */
+    spans?: MindooDBAppRichTextSpan[];
+    /** Ordered snapshots to apply one-by-one so each `updateSpans` diff stays transaction-sized. */
+    spansSequence?: MindooDBAppRichTextSpan[][];
+    /** Optional Automerge `updateSpans` configuration, kept JSON-safe over the bridge. */
+    updateSpansConfig?: Record<string, unknown>;
+}
+interface MindooDBAppRichTextSnapshot {
+    path: Array<string | number>;
+    heads?: string[];
+    spans: MindooDBAppRichTextSpan[];
+}
+interface MindooDBAppRichTextGetOptions {
+    /** Stable revision id previously obtained from `documents.listHistory()`. */
+    revisionId?: MindooDBAppDocumentRevisionId;
+}
+/** Binary Automerge snapshot of the full internal document. */
+interface MindooDBAppAutomergeSnapshot {
+    binary: Uint8Array;
+    heads: string[];
+}
+interface MindooDBAppAutomergeGetOptions {
+    /** Stable revision id previously obtained from `documents.listHistory()`. */
+    revisionId?: MindooDBAppDocumentRevisionId;
+}
+/** Raw Automerge change bytes produced by a local replica. */
+interface MindooDBAppAutomergeChangesPatch {
+    /** Heads the client had when authoring `changes`; optional, for correlation only. */
+    baseHeads?: string[];
+    /**
+     * Heads of the local replica after authoring `changes`. When provided, the
+     * apply response includes `changesSince` for incremental reconciliation.
+     */
+    replicaHeads?: string[];
+    /** Change bytes from `Automerge.getChangesSince`; merged into Haven's current doc. */
+    changes: Uint8Array[];
+}
+/** Incremental catch-up bytes for a local replica after an apply merge. */
+interface MindooDBAppAutomergeChangesSince {
+    /** Echo of `replicaHeads` from the request. */
+    sinceHeads: string[];
+    /** Changes on the merged canonical doc that the replica is missing. */
+    changes: Uint8Array[];
+}
+interface MindooDBAppAutomergePatchResult {
+    document: MindooDBAppDocument;
+    heads: string[];
+    /**
+     * Present when the request included `replicaHeads`. Apply locally with
+     * `Automerge.applyChanges` instead of reloading a full snapshot.
+     */
+    changesSince?: MindooDBAppAutomergeChangesSince;
+}
 /**
  * Sets the value at `path` inside the document payload.
  *
@@ -319,6 +416,33 @@ interface MindooDBAppJsonListDeletePatch {
     index: number;
     deleteCount: number;
 }
+/**
+ * Splices text at `path` using Automerge text semantics.
+ */
+interface MindooDBAppJsonTextSplicePatch {
+    path: Array<string | number>;
+    index: number;
+    deleteCount: number;
+    insert?: string;
+}
+/**
+ * Applies one or more marks to a text range at `path`.
+ */
+interface MindooDBAppJsonTextMarkPatch {
+    path: Array<string | number>;
+    index: number;
+    length: number;
+    marks: Record<string, MindooDBAppRichTextMaterializeValue>;
+}
+/**
+ * Removes marks from a text range at `path`.
+ */
+interface MindooDBAppJsonTextUnmarkPatch {
+    path: Array<string | number>;
+    index: number;
+    length: number;
+    names: string[];
+}
 interface MindooDBAppJsonPatch {
     /**
      * Automerge heads of the document snapshot this JSON patch was authored
@@ -330,6 +454,9 @@ interface MindooDBAppJsonPatch {
     unset?: MindooDBAppJsonUnsetPatch[];
     listInsert?: MindooDBAppJsonListInsertPatch[];
     listDelete?: MindooDBAppJsonListDeletePatch[];
+    textSplice?: MindooDBAppJsonTextSplicePatch[];
+    textMark?: MindooDBAppJsonTextMarkPatch[];
+    textUnmark?: MindooDBAppJsonTextUnmarkPatch[];
 }
 /**
  * Sparse patch payload used when updating an existing document.
@@ -347,6 +474,10 @@ interface MindooDBAppUpdateDocumentInput {
     json?: MindooDBAppJsonPatch;
     /** Granular text edits to apply at document paths. */
     text?: MindooDBAppTextPatch[];
+    /** Rich-text span snapshots to apply at document paths. */
+    richText?: MindooDBAppRichTextPatch[];
+    /** Rich-text positional steps to apply at document paths. */
+    richTextSteps?: MindooDBAppRichTextStepPatch[];
 }
 /** Query used for history lookups at a specific timestamp. */
 interface MindooDBAppHistoryQuery {
@@ -560,6 +691,23 @@ interface MindooDBAppDocumentApi {
     list(query?: MindooDBAppDocumentListQuery): Promise<MindooDBAppDocumentListResult>;
     getHeadCursor(): Promise<MindooDBAppDocumentHeadCursorResult>;
     get(docId: string): Promise<MindooDBAppDocument | null>;
+    getRichText(docId: string, path: Array<string | number>, options?: MindooDBAppRichTextGetOptions): Promise<MindooDBAppRichTextSnapshot>;
+    /**
+     * Export the full internal Automerge document as binary.
+     *
+     * **Discouraged** — prefer `getRichText`, `get`, and `documents.update` (`set`,
+     * `unset`, `text`, `richText`, `json`) unless those APIs cannot express your
+     * edits. Added for TeamEdit Word/.docx (local Automerge replica + binary flush).
+     */
+    getAutomergeSnapshot(docId: string, options?: MindooDBAppAutomergeGetOptions): Promise<MindooDBAppAutomergeSnapshot>;
+    /**
+     * Merge raw Automerge change bytes into the canonical document on Haven.
+     *
+     * **Discouraged** — prefer `documents.update` patch operations. Escape hatch
+     * for apps that host a local Automerge replica when JSON patches are insufficient.
+     * Include `replicaHeads` to receive incremental `changesSince` in the response.
+     */
+    applyAutomergeChanges(docId: string, patch: MindooDBAppAutomergeChangesPatch): Promise<MindooDBAppAutomergePatchResult>;
     create(input: MindooDBAppCreateDocumentInput): Promise<MindooDBAppDocument>;
     update(docId: string, patch: MindooDBAppUpdateDocumentInput): Promise<MindooDBAppDocument>;
     delete(docId: string): Promise<{
@@ -737,4 +885,4 @@ interface MindooDBAppBridge {
     connect(options?: MindooDBAppBridgeConnectOptions): Promise<MindooDBAppSession>;
 }
 
-export type { MindooDBAppDocumentListQuery as $, MindooDBAppBridgeThemeChangedMessage as A, MindooDBAppBridgeUiPreferencesChangedMessage as B, MindooDBAppBridgeViewportChangedMessage as C, MindooDBAppCapability as D, MindooDBAppConfiguredViewCategorizationStyle as E, MindooDBAppConfiguredViewColumn as F, MindooDBAppConfiguredViewColumnRole as G, MindooDBAppConfiguredViewExpressionMode as H, MindooDBAppConfiguredViewFieldExpression as I, MindooDBAppConfiguredViewFilterDefinition as J, MindooDBAppConfiguredViewFilterMode as K, MindooDBAppConfiguredViewFilterRule as L, MindooDBAppAttachmentPreviewMode as M, MindooDBAppConfiguredViewFormulaExpression as N, MindooDBAppConfiguredViewFormulaFilterDefinition as O, MindooDBAppConfiguredViewPreviewMode as P, MindooDBAppConfiguredViewRuleFilterDefinition as Q, MindooDBAppConfiguredViewRuleMatchMode as R, MindooDBAppConfiguredViewRuleOperator as S, MindooDBAppConfiguredViewValueExpression as T, MindooDBAppCreateDocumentInput as U, MindooDBAppCreateViewInput as V, MindooDBAppCreateViewNavigatorInput as W, MindooDBAppDatabaseInfo as X, MindooDBAppDocumentApi as Y, MindooDBAppDocumentHeadCursorResult as Z, MindooDBAppDocumentHistoryEntry as _, MindooDBAppBridge as a, MindooDBAppDocumentListResult as a0, MindooDBAppDocumentRevisionId as a1, MindooDBAppDocumentScanPreset as a2, MindooDBAppDocumentSummary as a3, MindooDBAppHistoricalDocument as a4, MindooDBAppHistoryQuery as a5, MindooDBAppHostTheme as a6, MindooDBAppJsonListDeletePatch as a7, MindooDBAppJsonListInsertPatch as a8, MindooDBAppJsonPatch as a9, MindooDBAppShowMenuResult as aA, MindooDBAppTextEdit as aB, MindooDBAppTextPatch as aC, MindooDBAppThemeMode as aD, MindooDBAppUiPreferences as aE, MindooDBAppUpdateDocumentInput as aF, MindooDBAppViewCursorDocumentListResult as aG, MindooDBAppViewCursorResult as aH, MindooDBAppViewEntry as aI, MindooDBAppViewEntryKind as aJ, MindooDBAppViewNavigator as aK, MindooDBAppViewNavigatorExpansionState as aL, MindooDBAppViewNavigatorOpenOptions as aM, MindooDBAppViewNavigatorPageOptions as aN, MindooDBAppViewNavigatorPageResult as aO, MindooDBAppViewNavigatorRangeQuery as aP, MindooDBAppViewNavigatorSelectionState as aQ, MindooDBAppViewport as aR, MindooDBAppWritableAttachmentStream as aS, MindooDBAppJsonSetPatch as aa, MindooDBAppJsonUnsetPatch as ab, MindooDBAppLaunchContext as ac, MindooDBAppMenuAnchor as ad, MindooDBAppMenuApi as ae, MindooDBAppMenuCommandItem as af, MindooDBAppMenuDismissReason as ag, MindooDBAppMenuDismissedResult as ah, MindooDBAppMenuItem as ai, MindooDBAppMenuKind as aj, MindooDBAppMenuPlacement as ak, MindooDBAppMenuPointAnchor as al, MindooDBAppMenuRect as am, MindooDBAppMenuRectAnchor as an, MindooDBAppMenuSelectionResult as ao, MindooDBAppMenuSeparatorItem as ap, MindooDBAppReadableAttachmentStream as aq, MindooDBAppResolvedViewDefinition as ar, MindooDBAppResolvedViewSource as as, MindooDBAppRuntime as at, MindooDBAppScanAttachmentOptions as au, MindooDBAppScanAttachmentResult as av, MindooDBAppScopedDocId as aw, MindooDBAppScopedDocumentSummary as ax, MindooDBAppSession as ay, MindooDBAppShowMenuInput as az, MindooDBAppDatabase as b, MindooDBAppDocument as c, MindooDBAppAttachmentApi as d, MindooDBAppAttachmentChunk as e, MindooDBAppAttachmentInfo as f, MindooDBAppAttachmentPreviewOptions as g, MindooDBAppAttachmentPreviewSession as h, MindooDBAppBridgeConnectMessage as i, MindooDBAppBridgeConnectOptions as j, MindooDBAppBridgeConnectedMessage as k, MindooDBAppBridgeErrorPayload as l, MindooDBAppBridgeHandshakeErrorMessage as m, MindooDBAppBridgePortMessage as n, MindooDBAppBridgeRpcError as o, MindooDBAppBridgeRpcMessage as p, MindooDBAppBridgeRpcRequest as q, MindooDBAppBridgeRpcSuccess as r, MindooDBAppBridgeStreamAbortRequest as s, MindooDBAppBridgeStreamAck as t, MindooDBAppBridgeStreamCloseRequest as u, MindooDBAppBridgeStreamError as v, MindooDBAppBridgeStreamMessage as w, MindooDBAppBridgeStreamOpenResult as x, MindooDBAppBridgeStreamReadRequest as y, MindooDBAppBridgeStreamWriteRequest as z };
+export type { MindooDBAppCreateDocumentInput as $, MindooDBAppBridgeStreamAck as A, MindooDBAppBridgeStreamCloseRequest as B, MindooDBAppBridgeStreamError as C, MindooDBAppBridgeStreamMessage as D, MindooDBAppBridgeStreamOpenResult as E, MindooDBAppBridgeStreamReadRequest as F, MindooDBAppBridgeStreamWriteRequest as G, MindooDBAppBridgeThemeChangedMessage as H, MindooDBAppBridgeUiPreferencesChangedMessage as I, MindooDBAppBridgeViewportChangedMessage as J, MindooDBAppCapability as K, MindooDBAppConfiguredViewCategorizationStyle as L, MindooDBAppAttachmentPreviewMode as M, MindooDBAppConfiguredViewColumn as N, MindooDBAppConfiguredViewColumnRole as O, MindooDBAppConfiguredViewExpressionMode as P, MindooDBAppConfiguredViewFieldExpression as Q, MindooDBAppConfiguredViewFilterDefinition as R, MindooDBAppConfiguredViewFilterMode as S, MindooDBAppConfiguredViewFilterRule as T, MindooDBAppConfiguredViewFormulaExpression as U, MindooDBAppConfiguredViewFormulaFilterDefinition as V, MindooDBAppConfiguredViewPreviewMode as W, MindooDBAppConfiguredViewRuleFilterDefinition as X, MindooDBAppConfiguredViewRuleMatchMode as Y, MindooDBAppConfiguredViewRuleOperator as Z, MindooDBAppConfiguredViewValueExpression as _, MindooDBAppBridge as a, MindooDBAppViewCursorDocumentListResult as a$, MindooDBAppCreateViewInput as a0, MindooDBAppCreateViewNavigatorInput as a1, MindooDBAppDatabaseInfo as a2, MindooDBAppDocumentApi as a3, MindooDBAppDocumentHeadCursorResult as a4, MindooDBAppDocumentHistoryEntry as a5, MindooDBAppDocumentListQuery as a6, MindooDBAppDocumentListResult as a7, MindooDBAppDocumentRevisionId as a8, MindooDBAppDocumentScanPreset as a9, MindooDBAppReadableAttachmentStream as aA, MindooDBAppResolvedViewDefinition as aB, MindooDBAppResolvedViewSource as aC, MindooDBAppRichTextBlockSpan as aD, MindooDBAppRichTextGetOptions as aE, MindooDBAppRichTextImmutableString as aF, MindooDBAppRichTextMarkRange as aG, MindooDBAppRichTextMaterializeValue as aH, MindooDBAppRichTextPatch as aI, MindooDBAppRichTextScalar as aJ, MindooDBAppRichTextSpliceStep as aK, MindooDBAppRichTextStep as aL, MindooDBAppRichTextStepPatch as aM, MindooDBAppRichTextTextSpan as aN, MindooDBAppRuntime as aO, MindooDBAppScanAttachmentOptions as aP, MindooDBAppScanAttachmentResult as aQ, MindooDBAppScopedDocId as aR, MindooDBAppScopedDocumentSummary as aS, MindooDBAppSession as aT, MindooDBAppShowMenuInput as aU, MindooDBAppShowMenuResult as aV, MindooDBAppTextEdit as aW, MindooDBAppTextPatch as aX, MindooDBAppThemeMode as aY, MindooDBAppUiPreferences as aZ, MindooDBAppUpdateDocumentInput as a_, MindooDBAppDocumentSummary as aa, MindooDBAppHistoricalDocument as ab, MindooDBAppHistoryQuery as ac, MindooDBAppHostTheme as ad, MindooDBAppJsonListDeletePatch as ae, MindooDBAppJsonListInsertPatch as af, MindooDBAppJsonPatch as ag, MindooDBAppJsonSetPatch as ah, MindooDBAppJsonTextMarkPatch as ai, MindooDBAppJsonTextSplicePatch as aj, MindooDBAppJsonTextUnmarkPatch as ak, MindooDBAppJsonUnsetPatch as al, MindooDBAppLaunchContext as am, MindooDBAppMenuAnchor as an, MindooDBAppMenuApi as ao, MindooDBAppMenuCommandItem as ap, MindooDBAppMenuDismissReason as aq, MindooDBAppMenuDismissedResult as ar, MindooDBAppMenuItem as as, MindooDBAppMenuKind as at, MindooDBAppMenuPlacement as au, MindooDBAppMenuPointAnchor as av, MindooDBAppMenuRect as aw, MindooDBAppMenuRectAnchor as ax, MindooDBAppMenuSelectionResult as ay, MindooDBAppMenuSeparatorItem as az, MindooDBAppDatabase as b, MindooDBAppViewCursorResult as b0, MindooDBAppViewEntry as b1, MindooDBAppViewEntryKind as b2, MindooDBAppViewNavigator as b3, MindooDBAppViewNavigatorExpansionState as b4, MindooDBAppViewNavigatorOpenOptions as b5, MindooDBAppViewNavigatorPageOptions as b6, MindooDBAppViewNavigatorPageResult as b7, MindooDBAppViewNavigatorRangeQuery as b8, MindooDBAppViewNavigatorSelectionState as b9, MindooDBAppViewport as ba, MindooDBAppWritableAttachmentStream as bb, MindooDBAppDocument as c, MindooDBAppRichTextSpan as d, MindooDBAppRichTextSnapshot as e, MindooDBAppAttachmentApi as f, MindooDBAppAttachmentChunk as g, MindooDBAppAttachmentInfo as h, MindooDBAppAttachmentPreviewOptions as i, MindooDBAppAttachmentPreviewSession as j, MindooDBAppAutomergeChangesPatch as k, MindooDBAppAutomergeChangesSince as l, MindooDBAppAutomergeGetOptions as m, MindooDBAppAutomergePatchResult as n, MindooDBAppAutomergeSnapshot as o, MindooDBAppBridgeConnectMessage as p, MindooDBAppBridgeConnectOptions as q, MindooDBAppBridgeConnectedMessage as r, MindooDBAppBridgeErrorPayload as s, MindooDBAppBridgeHandshakeErrorMessage as t, MindooDBAppBridgePortMessage as u, MindooDBAppBridgeRpcError as v, MindooDBAppBridgeRpcMessage as w, MindooDBAppBridgeRpcRequest as x, MindooDBAppBridgeRpcSuccess as y, MindooDBAppBridgeStreamAbortRequest as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mindoodb-app-sdk",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "engines": {
     "node": ">=22.13.0"
   },
@@ -39,6 +39,7 @@
     "mindoodb-view-language": "0.0.13"
   },
   "devDependencies": {
+    "@automerge/automerge": "^3.2.1",
     "@types/node": "25.5.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.2",