mindoodb-app-sdk 0.0.16 → 0.0.17

package/dist/index.js

@@ -142,6 +142,7 @@ var PortRpcClient = class {
     this.port.addEventListener("message", this.handleMessage);
     this.port.start();
   }
+  port;
   pending = /* @__PURE__ */ new Map();
   listeners = /* @__PURE__ */ new Set();
   requestCounter = 0;
@@ -232,7 +233,10 @@ var PortRpcClient = class {
 var PROTOCOL2 = "mindoodb-app-bridge";
 var DEFAULT_CONNECT_TIMEOUT_MS = 1e4;
 function toTransferableArrayBuffer(chunk) {
-  return chunk.buffer.slice(chunk.byteOffset, chunk.byteOffset + chunk.byteLength);
+  return chunk.buffer.slice(
+    chunk.byteOffset,
+    chunk.byteOffset + chunk.byteLength
+  );
 }
 function isStreamChunkFor(streamId, message) {
   return message.kind === "stream-chunk" && message.streamId === streamId;
@@ -262,7 +266,9 @@ function resolveLaunchId(options) {
     return options.launchId;
   }
   if (typeof window === "undefined") {
-    throw new Error("A launchId must be provided when connecting outside the browser.");
+    throw new Error(
+      "A launchId must be provided when connecting outside the browser."
+    );
   }
   const search = new URLSearchParams(window.location.search);
   const launchId = search.get("mindoodbAppLaunchId");
@@ -271,9 +277,17 @@ function resolveLaunchId(options) {
   }
   return launchId;
 }
+function shouldUseWindowedHostTab() {
+  if (typeof window === "undefined") {
+    return false;
+  }
+  return window.parent === window && Boolean(window.opener);
+}
 function resolveTargetWindow() {
   if (typeof window === "undefined") {
-    throw new Error("The MindooDB app bridge is only available in the browser.");
+    throw new Error(
+      "The MindooDB app bridge is only available in the browser."
+    );
   }
   if (window.parent && window.parent !== window) {
     return window.parent;
@@ -294,7 +308,10 @@ function waitForConnectedPort(options, launchId) {
       if (timeoutId !== null) {
         window.clearTimeout(timeoutId);
       }
-      channel.port1.removeEventListener("message", handleMessage);
+      channel.port1.removeEventListener(
+        "message",
+        handleMessage
+      );
     };
     const handleMessage = (event) => {
       const payload = event.data;
@@ -316,7 +333,11 @@ function waitForConnectedPort(options, launchId) {
     timeoutId = window.setTimeout(() => {
       cleanup();
       channel.port1.close();
-      reject(new Error(`Timed out while connecting to the MindooDB Haven bridge for launch ${launchId}.`));
+      reject(
+        new Error(
+          `Timed out while connecting to the MindooDB Haven bridge for launch ${launchId}.`
+        )
+      );
     }, timeoutMs);
     channel.port1.addEventListener("message", handleMessage);
     channel.port1.start();
@@ -334,6 +355,9 @@ var MindooDBAppViewNavigatorImpl = class {
     this.navigatorId = navigatorId;
     this.viewCursor = viewCursor;
   }
+  rpc;
+  navigatorId;
+  viewCursor;
   /** Shorthand: call an RPC method with the navigator ID automatically injected. */
   async call(method, params = {}) {
     return await this.rpc.call(method, {
@@ -348,7 +372,9 @@ var MindooDBAppViewNavigatorImpl = class {
     return this.viewCursor;
   }
   async refresh() {
-    const result = await this.call("viewNavigators.refresh");
+    const result = await this.call(
+      "viewNavigators.refresh"
+    );
     this.viewCursor = result.viewCursor;
     return this.viewCursor;
   }
@@ -392,10 +418,14 @@ var MindooDBAppViewNavigatorImpl = class {
     return await this.call("viewNavigators.category.findByParts", { parts });
   }
   async entriesForward(options) {
-    return await this.call("viewNavigators.entries.forward", { options: options ?? {} });
+    return await this.call("viewNavigators.entries.forward", {
+      options: options ?? {}
+    });
   }
   async entriesBackward(options) {
-    return await this.call("viewNavigators.entries.backward", { options: options ?? {} });
+    return await this.call("viewNavigators.entries.backward", {
+      options: options ?? {}
+    });
   }
   async gotoNextSelected() {
     return await this.call("viewNavigators.goto.nextSelected");
@@ -420,7 +450,10 @@ var MindooDBAppViewNavigatorImpl = class {
     await this.call("viewNavigators.selection.deselectAll");
   }
   async isSelected(origin, docId) {
-    return await this.call("viewNavigators.selection.isSelected", { origin, docId });
+    return await this.call("viewNavigators.selection.isSelected", {
+      origin,
+      docId
+    });
   }
   async getSelectionState() {
     return await this.call("viewNavigators.selection.get");
@@ -453,13 +486,22 @@ var MindooDBAppViewNavigatorImpl = class {
     await this.call("viewNavigators.expansion.set", { state });
   }
   async childEntries(entryKey, descending) {
-    return await this.call("viewNavigators.children.entries", { entryKey, descending });
+    return await this.call("viewNavigators.children.entries", {
+      entryKey,
+      descending
+    });
   }
   async childCategories(entryKey, descending) {
-    return await this.call("viewNavigators.children.categories", { entryKey, descending });
+    return await this.call("viewNavigators.children.categories", {
+      entryKey,
+      descending
+    });
   }
   async childDocuments(entryKey, descending) {
-    return await this.call("viewNavigators.children.documents", { entryKey, descending });
+    return await this.call("viewNavigators.children.documents", {
+      entryKey,
+      descending
+    });
   }
   async childCategoriesByKey(entryKey, key, exact, descending) {
     return await this.call("viewNavigators.children.categoriesByKey", {
@@ -478,16 +520,28 @@ var MindooDBAppViewNavigatorImpl = class {
     });
   }
   async childCategoriesBetween(entryKey, range) {
-    return await this.call("viewNavigators.children.categoriesBetween", { entryKey, range });
+    return await this.call("viewNavigators.children.categoriesBetween", {
+      entryKey,
+      range
+    });
   }
   async childDocumentsBetween(entryKey, range) {
-    return await this.call("viewNavigators.children.documentsBetween", { entryKey, range });
+    return await this.call("viewNavigators.children.documentsBetween", {
+      entryKey,
+      range
+    });
   }
   async getSortedDocIds(descending) {
-    return await this.call("viewNavigators.sortedDocIds.get", { descending });
+    return await this.call(
+      "viewNavigators.sortedDocIds.get",
+      { descending }
+    );
   }
   async getSortedDocIdsScoped(entryKey, descending) {
-    return await this.call("viewNavigators.sortedDocIds.scoped", { entryKey, descending });
+    return await this.call(
+      "viewNavigators.sortedDocIds.scoped",
+      { entryKey, descending }
+    );
   }
   async dispose() {
     await this.call("viewNavigators.dispose");
@@ -504,7 +558,9 @@ var MindooDBAppReadableAttachmentStreamImpl = class {
         if (!pending) {
           return;
         }
-        pending.resolve(message.done ? null : new Uint8Array(message.chunk ?? new ArrayBuffer(0)));
+        pending.resolve(
+          message.done ? null : new Uint8Array(message.chunk ?? new ArrayBuffer(0))
+        );
         if (message.done) {
           this.closed = true;
           this.unsubscribe();
@@ -520,6 +576,8 @@ var MindooDBAppReadableAttachmentStreamImpl = class {
       }
     });
   }
+  rpc;
+  streamId;
   unsubscribe;
   closed = false;
   pendingRead = null;
@@ -529,7 +587,9 @@ var MindooDBAppReadableAttachmentStreamImpl = class {
       return null;
     }
     if (this.pendingRead) {
-      throw new Error("A read() call is already in progress for this attachment stream.");
+      throw new Error(
+        "A read() call is already in progress for this attachment stream."
+      );
     }
     return await new Promise((resolve, reject) => {
       this.pendingRead = { resolve, reject };
@@ -576,6 +636,8 @@ var MindooDBAppWritableAttachmentStreamImpl = class {
       }
     });
   }
+  rpc;
+  streamId;
   unsubscribe;
   closed = false;
   inflight = null;
@@ -601,12 +663,15 @@ var MindooDBAppWritableAttachmentStreamImpl = class {
     return await this.enqueue(async () => {
       const buffer = toTransferableArrayBuffer(chunk);
       await this.waitForAck(() => {
-        this.rpc.postMessage({
-          protocol: PROTOCOL2,
-          kind: "stream-write",
-          streamId: this.streamId,
-          chunk: buffer
-        }, [buffer]);
+        this.rpc.postMessage(
+          {
+            protocol: PROTOCOL2,
+            kind: "stream-write",
+            streamId: this.streamId,
+            chunk: buffer
+          },
+          [buffer]
+        );
       });
     });
   }
@@ -706,23 +771,71 @@ var MindooDBAppDatabaseImpl = class {
         attachmentName
       }),
       openReadStream: async (docId, attachmentName, options) => {
-        const result = await this.rpc.call("attachments.openReadStream", {
-          databaseId: this.databaseId,
-          docId,
-          attachmentName,
-          timestamp: options?.timestamp,
-          revisionId: options?.revisionId
-        });
-        return new MindooDBAppReadableAttachmentStreamImpl(this.rpc, result.streamId);
+        const result = await this.rpc.call(
+          "attachments.openReadStream",
+          {
+            databaseId: this.databaseId,
+            docId,
+            attachmentName,
+            timestamp: options?.timestamp,
+            revisionId: options?.revisionId
+          }
+        );
+        return new MindooDBAppReadableAttachmentStreamImpl(
+          this.rpc,
+          result.streamId
+        );
       },
       openWriteStream: async (docId, attachmentName, contentType) => {
-        const result = await this.rpc.call("attachments.openWriteStream", {
-          databaseId: this.databaseId,
-          docId,
-          attachmentName,
-          contentType
-        });
-        return new MindooDBAppWritableAttachmentStreamImpl(this.rpc, result.streamId);
+        const result = await this.rpc.call(
+          "attachments.openWriteStream",
+          {
+            databaseId: this.databaseId,
+            docId,
+            attachmentName,
+            contentType
+          }
+        );
+        return new MindooDBAppWritableAttachmentStreamImpl(
+          this.rpc,
+          result.streamId
+        );
+      },
+      scan: async (docId, options) => {
+        const scannerTab = shouldUseWindowedHostTab() ? window.open("", "_blank") : null;
+        if (scannerTab) {
+          try {
+            scannerTab.document.title = "Opening document scanner...";
+            const preparedSession = await this.rpc.call("attachments.prepareScanSession", {
+              databaseId: this.databaseId,
+              docId,
+              defaultFileName: options?.defaultFileName,
+              preset: options?.preset,
+              mimeType: options?.mimeType
+            });
+            scannerTab.location.href = preparedSession.scanUrl;
+            return await this.rpc.call(
+              "attachments.awaitScanSession",
+              {
+                databaseId: this.databaseId,
+                sessionId: preparedSession.sessionId
+              }
+            );
+          } catch (error) {
+            scannerTab.close();
+            throw error;
+          }
+        }
+        return await this.rpc.call(
+          "attachments.scanAndWrite",
+          {
+            databaseId: this.databaseId,
+            docId,
+            defaultFileName: options?.defaultFileName,
+            preset: options?.preset,
+            mimeType: options?.mimeType
+          }
+        );
       },
       preparePreviewSession: async (docId, attachmentName, options) => await this.rpc.call("attachments.preparePreviewSession", {
         databaseId: this.databaseId,
@@ -731,15 +844,37 @@ var MindooDBAppDatabaseImpl = class {
         timestamp: options?.timestamp,
         revisionId: options?.revisionId
       }),
-      openPreview: async (docId, attachmentName, options) => await this.rpc.call("attachments.openPreview", {
-        databaseId: this.databaseId,
-        docId,
-        attachmentName,
-        timestamp: options?.timestamp,
-        revisionId: options?.revisionId
-      })
+      openPreview: async (docId, attachmentName, options) => {
+        const previewTab = shouldUseWindowedHostTab() ? window.open("", "_blank") : null;
+        if (previewTab) {
+          try {
+            previewTab.document.title = "Opening attachment preview...";
+            const previewSession = await this.rpc.call("attachments.preparePreviewSession", {
+              databaseId: this.databaseId,
+              docId,
+              attachmentName,
+              timestamp: options?.timestamp,
+              revisionId: options?.revisionId
+            });
+            previewTab.location.href = previewSession.previewUrl;
+            return { ok: true };
+          } catch (error) {
+            previewTab.close();
+            throw error;
+          }
+        }
+        return await this.rpc.call("attachments.openPreview", {
+          databaseId: this.databaseId,
+          docId,
+          attachmentName,
+          timestamp: options?.timestamp,
+          revisionId: options?.revisionId
+        });
+      }
     };
   }
+  rpc;
+  databaseId;
   documents;
   attachments;
   /** Returns database metadata for the currently opened binding. */
@@ -759,6 +894,7 @@ var MindooDBAppSessionImpl = class {
       }
     };
   }
+  rpc;
   menus;
   /** Returns the launch context provided by the Haven host. */
   async getLaunchContext() {
@@ -774,7 +910,9 @@ var MindooDBAppSessionImpl = class {
     return new MindooDBAppDatabaseImpl(this.rpc, databaseId);
   }
   async listDocumentsSinceViewCursor(cursor) {
-    return await this.rpc.call("session.listDocumentsSinceViewCursor", { cursor });
+    return await this.rpc.call("session.listDocumentsSinceViewCursor", {
+      cursor
+    });
   }
   /**
    * Create a navigator from an ad-hoc view definition and one or more database bindings.
@@ -785,7 +923,11 @@ var MindooDBAppSessionImpl = class {
    */
   async createViewNavigator(input) {
     const result = await this.rpc.call("session.createViewNavigator", input);
-    return new MindooDBAppViewNavigatorImpl(this.rpc, result.navigatorId, result.viewCursor);
+    return new MindooDBAppViewNavigatorImpl(
+      this.rpc,
+      result.navigatorId,
+      result.viewCursor
+    );
   }
   /**
    * Open a navigator for a preconfigured view that the host already knows about.
@@ -795,7 +937,11 @@ var MindooDBAppSessionImpl = class {
    */
   async openViewNavigator(viewId, options) {
     const result = await this.rpc.call("session.openViewNavigator", { viewId, options: options ?? {} });
-    return new MindooDBAppViewNavigatorImpl(this.rpc, result.navigatorId, result.viewCursor);
+    return new MindooDBAppViewNavigatorImpl(
+      this.rpc,
+      result.navigatorId,
+      result.viewCursor
+    );
   }
   /** Subscribe to host-pushed theme changes (dark/light mode, color tokens). */
   onThemeChange(listener) {
@@ -848,6 +994,7 @@ var MindooDBTextBuffer = class {
     this.valueInternal = readTextAtPath(options.document.data, options.path);
     this.heads = options.document.heads ? [...options.document.heads] : [];
   }
+  options;
   valueInternal;
   heads;
   pendingEdits = [];

package/dist/testing/index.d.ts

@@ -1,4 +1,4 @@
-import { a6 as MindooDBAppLaunchContext, X as MindooDBAppDatabaseInfo, Y as MindooDBAppDocumentApi, W as MindooDBAppCreateViewNavigatorInput, aC as MindooDBAppViewNavigator, aE as MindooDBAppViewNavigatorOpenOptions, d as MindooDBAppAttachmentApi, a as MindooDBAppBridge, aq as MindooDBAppSession, q as MindooDBAppBridgeRpcRequest, a5 as MindooDBAppHostTheme, aJ as MindooDBAppViewport, aw as MindooDBAppUiPreferences, n as MindooDBAppBridgePortMessage } from '../types-D0vtIHBf.js';
+import { ac as MindooDBAppLaunchContext, X as MindooDBAppDatabaseInfo, Y as MindooDBAppDocumentApi, W as MindooDBAppCreateViewNavigatorInput, aK as MindooDBAppViewNavigator, aM as MindooDBAppViewNavigatorOpenOptions, d as MindooDBAppAttachmentApi, a as MindooDBAppBridge, ay as MindooDBAppSession, q as MindooDBAppBridgeRpcRequest, a6 as MindooDBAppHostTheme, aR as MindooDBAppViewport, aE as MindooDBAppUiPreferences, n as MindooDBAppBridgePortMessage } from '../types-Dw6YRApH.js';
 import 'mindoodb-view-language';
 
 type MaybePromise<T> = T | Promise<T>;