@silverbulletmd/silverbullet 2.10.0 → 2.12.0

package/plug-api/syscalls/editor.ts

@@ -1,61 +1,66 @@
-import { syscall } from "../syscall.ts";
 import type {
+  DocumentCapability,
+  DocumentCapabilityDescriptor,
   FilterOption,
   NotificationType,
   UploadFile,
 } from "../../plug-api/types/client.ts";
-import type { Path, Ref } from "../lib/ref.ts";
 import type { PageMeta } from "../../plug-api/types/index.ts";
+import type { Path, Ref } from "../lib/ref.ts";
+import { syscall } from "../syscall.ts";
+import type { PanelMode } from "../types/client.ts";
 
 /**
- * Exposes various editor utilities.
  * Important: These syscalls are only available in the client.
  * @module
  */
 
-/**
- * Returns the name of the page or document currently open in the editor.
- * @returns the current page name
- */
 export function getCurrentPage(): Promise<string> {
   return syscall("editor.getCurrentPage");
 }
 
-/**
- * Returns the meta data of the page or document currently open in the editor.
- * @returns the current page meta data
- */
 export function getCurrentPageMeta(): Promise<PageMeta | undefined> {
   return syscall("editor.getCurrentPageMeta");
 }
 
-/**
- * Returns the path of the page or document currently open in the editor.
- * @returns the current page path
- */
 export function getCurrentPath(): Promise<Path> {
   return syscall("editor.getCurrentPath");
 }
 
-/**
- * Returns the names of the pages that have been recently opened
- * @returns the names of the recently opened pages
- */
 export function getRecentlyOpenedPages(): Promise<PageMeta[]> {
   return syscall("editor.getRecentlyOpenedPages");
 }
 
 /**
- * Returns the name of the currently open editor.
- * @returns the name of the current editor
+ * Returns a map of page name to the epoch-millisecond time it was last opened
+ * on this client. Only pages that have ever been opened appear in it.
  */
-export function getCurrentEditor(): Promise<string> {
-  return syscall("editor.getCurrentEditor");
+export function getLastOpenedMap(): Promise<Record<string, number>> {
+  return syscall("editor.getLastOpenedMap");
 }
 
 /**
- * Returns the full text of the currently open page
+ * Returns the file extensions (without a leading dot) claimed by explicitly
+ * registered document editors.
  */
+export function getViewableExtensions(): Promise<string[]> {
+  return syscall("editor.getViewableExtensions");
+}
+
+/**
+ * Resolves the editor capability for a batch of documents without reading
+ * their bodies.
+ */
+export function getDocumentCapabilities(
+  documents: DocumentCapabilityDescriptor[],
+): Promise<DocumentCapability[]> {
+  return syscall("editor.getDocumentCapabilities", documents);
+}
+
+export function getCurrentEditor(): Promise<string> {
+  return syscall("editor.getCurrentEditor");
+}
+
 export function getText(): Promise<string> {
   return syscall("editor.getText");
 }
@@ -78,9 +83,6 @@ export function getCursor(): Promise<number> {
   return syscall("editor.getCursor");
 }
 
-/**
- * Returns the line number and column number of the cursor in the editor
- */
 export function getSelection(): Promise<{
   from: number;
   to: number;
@@ -89,38 +91,21 @@ export function getSelection(): Promise<{
   return syscall("editor.getSelection");
 }
 
-/**
- * Sets the position of the cursor in the editor
- * @param from the start position of the selection
- * @param to the end position of the selection
- */
 export function setSelection(from: number, to: number): Promise<void> {
   return syscall("editor.setSelection", from, to);
 }
 
 /**
- * Invoke a client command by name
  * Note: only available on the client
- * @param name name of the command
- * @param args arguments to pass to the command
  */
 export function invokeCommand(name: string, args?: string[]): Promise<any> {
   return syscall("editor.invokeCommand", name, args);
 }
 
-/**
- * Forces a save of the current page
- */
 export function save(): Promise<void> {
   return syscall("editor.save");
 }
 
-/**
- * Navigates to the specified page reference
- * @param pageRef the page reference to navigate to
- * @param replaceState whether to replace the current history state in the browser history
- * @param newWindow whether to open the page in a new window
- */
 export function navigate(
   ref: Ref | string,
   replaceState = false,
@@ -133,9 +118,6 @@ export function navigate(
  * Opens the specified page reference, restoring the previous cursor and scroll
  * position for that page when one is remembered from the current session. Like
  * navigate(), an explicit pointer in the ref (e.g. `#header`, `@123`) still wins.
- * @param ref the page reference to open
- * @param replaceState whether to replace the current history state in the browser history
- * @param newWindow whether to open the page in a new window
  */
 export function open(
   ref: Ref | string,
@@ -145,26 +127,33 @@ export function open(
   return syscall("editor.open", ref, replaceState, newWindow);
 }
 
-/**
- * Opens the page navigator
- * @param mode the mode to open the navigator in
- */
 export function openPageNavigator(
   mode: "page" | "meta" | "document" | "all" = "page",
 ): Promise<void> {
   return syscall("editor.openPageNavigator", mode);
 }
 
-/**
- * Opens the command palette
- */
 export function openCommandPalette(): Promise<void> {
   return syscall("editor.openCommandPalette");
 }
 
 /**
- * Force reloads the current page
+ * Opens a navigator view by name.
+ * @returns whether a view actually opened. `false` means there was none to
+ * open.
  */
+export function openNavigator(
+  name: string,
+  opts?: {
+    segment?: string;
+    phrase?: string;
+    dropdown?: unknown;
+    focus?: boolean;
+  },
+): Promise<boolean> {
+  return syscall("editor.openNavigator", name, opts);
+}
+
 export function reloadPage(): Promise<void> {
   return syscall("editor.reloadPage");
 }
@@ -174,16 +163,10 @@ export function forceLint(): Promise<void> {
   return syscall("editor.forceLint");
 }
 
-/**
- * Force reloads the browser UI
- */
 export function reloadUI(): Promise<void> {
   return syscall("editor.reloadUI");
 }
 
-/**
- * Rebuilds the editor state to ensure the dispatch updates the state.
- */
 export function rebuildEditorState(): Promise<void> {
   return syscall("editor.rebuildEditorState");
 }
@@ -195,11 +178,6 @@ export function reloadConfigAndCommands(): Promise<void> {
   return syscall("editor.reloadConfigAndCommands");
 }
 
-/**
- * Opens the specified URL in the browser
- * @param url the URL to open
- * @param existingWindow whether to open the URL in an existing window
- */
 export function openUrl(url: string, existingWindow = false): Promise<void> {
   return syscall("editor.openUrl", url, existingWindow);
 }
@@ -217,20 +195,14 @@ export function goHistory(delta: number): Promise<void> {
   return syscall("editor.goHistory", delta);
 }
 
-/**
- * Force the client to download the file in dataUrl with filename as file name
- * @param filename the name of the file to download
- * @param dataUrl the dataUrl of the file to download
- */
 export function downloadFile(filename: string, dataUrl: string): Promise<void> {
   return syscall("editor.downloadFile", filename, dataUrl);
 }
 
-/**
- * Triggers the browser's native file upload dialog/popup
- * @param accept the file types to accept
- * @param capture the capture mode for the file input
- */
+export function downloadSpaceFile(name: string): Promise<void> {
+  return syscall("editor.downloadSpaceFile", name);
+}
+
 export function uploadFile(
   accept?: string,
   capture?: string,
@@ -240,8 +212,6 @@ export function uploadFile(
 
 /**
  * Shows a flash notification to the user (top right corner)
- * @param message the message to show
- * @param type the type of notification to show
  */
 export function flashNotification(
   message: string,
@@ -252,10 +222,6 @@ export function flashNotification(
 
 /**
  * Exposes a filter box UI (similar to the page navigator and command palette)
- * @param label the label to show left of the input box
- * @param options the options to show and to filter on
- * @param helpText the help text to show below the input box
- * @param placeHolder the placeholder text to show in the input box
  */
 export function filterBox(
   label: string,
@@ -266,59 +232,48 @@ export function filterBox(
   return syscall("editor.filterBox", label, options, helpText, placeHolder);
 }
 
-/**
- * Shows a panel in the editor
- * @param id the location of the panel to show
- * @param mode the mode or "size" of the panel
- * @param html the html content of the panel
- * @param script the script content of the panel
- */
 export function showPanel(
   id: "lhs" | "rhs" | "bhs" | "modal",
-  mode: number,
+  mode: PanelMode,
   html: HTMLElement | HTMLElement[] | string,
   script = "",
 ): Promise<void> {
   return syscall("editor.showPanel", id, mode, html, script);
 }
 
-/**
- * Hides a panel in the editor
- * @param id the location of the panel to hide
- */
 export function hidePanel(id: "lhs" | "rhs" | "bhs" | "modal"): Promise<void> {
   return syscall("editor.hidePanel", id);
 }
 
-/**
- * Returns focus to the main editor.
- */
 export function focus(): Promise<void> {
   return syscall("editor.focus");
 }
 
+/**
+ * The slot of the panel whose iframe currently holds focus, or `undefined`
+ * if none does (focus is in the editor, or nowhere in particular).
+ */
+export function getFocusedPanelSlot(): Promise<
+  "lhs" | "rhs" | "bhs" | "modal" | undefined
+> {
+  return syscall("editor.getFocusedPanelSlot");
+}
+
 export function showProgress(
-  progressPercentage?: number,
-  progressType?: string,
+  progressType: "sync" | "index",
+  progressPercentage: number,
 ): Promise<void> {
-  return syscall("editor.showProgress", progressPercentage, progressType);
+  return syscall("editor.showProgress", progressType, progressPercentage);
+}
+
+export function hideProgress(progressType: "sync" | "index"): Promise<void> {
+  return syscall("editor.showProgress", progressType);
 }
 
-/**
- * Insert text at the specified position into the editor
- * @param text the text to insert
- * @param pos
- */
 export function insertAtPos(text: string, pos: number): Promise<void> {
   return syscall("editor.insertAtPos", text, pos);
 }
 
-/**
- * Replace the text in the specified range in the editor
- * @param from the start position of the range
- * @param to the end position of the range
- * @param text the text to replace with
- */
 export function replaceRange(
   from: number,
   to: number,
@@ -327,21 +282,10 @@ export function replaceRange(
   return syscall("editor.replaceRange", from, to, text);
 }
 
-/**
- * Move the cursor to the specified position in the editor
- * @param pos the position to move the cursor to
- * @param center whether to center the cursor in the editor after moving
- */
 export function moveCursor(pos: number, center = false): Promise<void> {
   return syscall("editor.moveCursor", pos, center);
 }
 
-/**
- * Move the cursor to the specified line and column in the editor
- * @param line the line number to move the cursor to
- * @param column the column number to move the cursor to
- * @param center whether to center the cursor in the editor after moving
- */
 export function moveCursorToLine(
   line: number,
   column = 1,
@@ -350,10 +294,6 @@ export function moveCursorToLine(
   return syscall("editor.moveCursorToLine", line, column, center);
 }
 
-/**
- * Insert text at the cursor position in the editor
- * @param text the text to insert
- */
 export function insertAtCursor(
   text: string,
   scrollIntoView = false,
@@ -374,12 +314,6 @@ export function dispatch(change: any): Promise<void> {
   return syscall("editor.dispatch", change);
 }
 
-/**
- * Prompt the user for text input
- * @param message the message to show in the prompt
- * @param defaultValue a default value pre-filled in the prompt
- * @returns
- */
 export function prompt(
   message: string,
   defaultValue = "",
@@ -388,11 +322,8 @@ export function prompt(
 }
 
 /**
- * Prompt the user for confirmation
- * @param message the message to show in the confirmation dialog
  * @param options optional settings; set `destructive: true` to style the
  *   confirm button as a destructive (danger) action
- * @returns
  */
 export function confirm(
   message: string,
@@ -401,128 +332,70 @@ export function confirm(
   return syscall("editor.confirm", message, options);
 }
 
-/**
- * Prompt the user for confirmation
- * @param message the message to show in the confirmation dialog
- * @returns
- */
 export function alert(message: string): Promise<boolean> {
   return syscall("editor.alert", message);
 }
 
-/**
- * Get the value of a UI option
- * @param key the key of the UI option to get
- * @returns
- */
 export function getUiOption(key: string): Promise<any> {
   return syscall("editor.getUiOption", key);
 }
 
-/**
- * Set the value of a UI option
- * @param key the key of the UI option to set
- * @param value the value to set the UI option to
- */
 export function setUiOption(key: string, value: any): Promise<void> {
   return syscall("editor.setUiOption", key, value);
 }
 
-/**
- * Perform a fold at the current cursor position
- */
 export function fold(): Promise<void> {
   return syscall("editor.fold");
 }
 
-/**
- * Perform an unfold at the current cursor position
- */
 export function unfold(): Promise<void> {
   return syscall("editor.unfold");
 }
 
-/**
- * Toggle the fold at the current cursor position
- */
 export function toggleFold(): Promise<void> {
   return syscall("editor.toggleFold");
 }
 
-/**
- * Fold all code blocks in the editor
- */
 export function foldAll(): Promise<void> {
   return syscall("editor.foldAll");
 }
 
-/**
- * Unfold all code blocks in the editor
- */
 export function unfoldAll(): Promise<void> {
   return syscall("editor.unfoldAll");
 }
 
-/**
- * Perform an undo operation of the last edit in the editor
- */
 export function undo(): Promise<void> {
   return syscall("editor.undo");
 }
 
-/**
- * Perform a redo operation of the last undo in the editor
- */
 export function redo(): Promise<void> {
   return syscall("editor.redo");
 }
 
-/**
- * Open the editor's native search panel
- */
 export function openSearchPanel(): Promise<void> {
   return syscall("editor.openSearchPanel");
 }
 
-/**
- * Copy the specified data to the clipboard
- * @param data the data to copy
- */
 export function copyToClipboard(data: string | Blob): Promise<void> {
   return syscall("editor.copyToClipboard", data);
 }
 
-/**
- * Delete the current line in the editor
- */
 export function deleteLine(): Promise<void> {
   return syscall("editor.deleteLine");
 }
 
-/**
- * Select the entire document
- */
 export function selectAll(): Promise<void> {
   return syscall("editor.selectAll");
 }
 
-/**
- * Increase indentation of the current line or selection
- */
 export function indentMore(): Promise<void> {
   return syscall("editor.indentMore");
 }
 
-/**
- * Decrease indentation of the current line or selection
- */
 export function indentLess(): Promise<void> {
   return syscall("editor.indentLess");
 }
 
-/**
- * Comment or uncomment the current line in the editor
- */
 export function toggleComment(): Promise<void> {
   return syscall("editor.toggleComment");
 }
@@ -535,7 +408,6 @@ export function moveLineDown(): Promise<void> {
   return syscall("editor.moveLineDown");
 }
 
-// Cursor motion syscalls (wrappers around @codemirror/commands functions)
 export function cursorCharLeft(): Promise<void> {
   return syscall("editor.cursorCharLeft");
 }
@@ -579,7 +451,6 @@ export function cursorPageDown(): Promise<void> {
   return syscall("editor.cursorPageDown");
 }
 
-// Selection-extending motions
 export function selectCharLeft(): Promise<void> {
   return syscall("editor.selectCharLeft");
 }
@@ -623,7 +494,6 @@ export function selectPageDown(): Promise<void> {
   return syscall("editor.selectPageDown");
 }
 
-// Delete
 export function deleteCharBackward(): Promise<void> {
   return syscall("editor.deleteCharBackward");
 }
@@ -651,7 +521,6 @@ export function insertNewline(): Promise<void> {
   return syscall("editor.insertNewline");
 }
 
-// Completion popup
 export function acceptCompletion(): Promise<boolean> {
   return syscall("editor.acceptCompletion");
 }
@@ -662,12 +531,6 @@ export function closeCompletion(): Promise<void> {
   return syscall("editor.closeCompletion");
 }
 
-// Vim-mode specific syscalls
-
-/**
- * Execute a Vim ex command
- * @param exCommand the ex command to execute
- */
 export function vimEx(exCommand: string): Promise<any> {
   return syscall("editor.vimEx", exCommand);
 }
@@ -679,20 +542,19 @@ export function configureVimMode(): Promise<any> {
   return syscall("editor.configureVimMode");
 }
 
-// Document editor specific syscalls
-
-/**
- * Send a message - or event if you will - to the currently used document editor
- * @param type the message type, which can be listend to
- * @param data data attached to the message
- */
 export function sendMessage(type: string, data?: any): Promise<void> {
   return syscall("editor.sendMessage", type, data);
 }
 
-/**
- * Check if the editor is running on a mobile device
- */
 export function isMobile(): Promise<boolean> {
   return syscall("editor.isMobile");
 }
+
+/**
+ * Whether the client is currently laid out for a narrow screen — the
+ * breakpoint below which sidebar panels render as full-width drawers over the
+ * editor. A layout question, unlike `isMobile`, which asks about the pointer.
+ */
+export function isNarrowScreen(): Promise<boolean> {
+  return syscall("editor.isNarrowScreen");
+}

package/plug-api/syscalls/icon.ts

@@ -0,0 +1,18 @@
+import { syscall } from "../syscall.ts";
+
+/**
+ * @returns the icon's SVG markup, or null if the name isn't a Feather icon
+ */
+export function feather(name: string): Promise<string | null> {
+  return syscall("icon.feather", name);
+}
+
+/**
+ * Renders a batch of Feather icons to SVG markup in one round trip.
+ * @returns map of icon name to SVG markup; unknown names are omitted
+ */
+export function resolveFeather(
+  names: string[],
+): Promise<Record<string, string>> {
+  return syscall("icon.resolveFeather", names);
+}

package/plug-api/syscalls/index.ts

@@ -1,8 +1,8 @@
+import { syscall } from "@silverbulletmd/silverbullet/syscall";
 import type {
   LuaCollectionQuery,
   LuaQueryCollection,
 } from "../../client/space_lua/query_collection.ts";
-import { syscall } from "@silverbulletmd/silverbullet/syscall";
 import type { ObjectValue } from "../../plug-api/types/index.ts";
 /**
  * Exposes the SilverBullet object indexing system
@@ -78,10 +78,10 @@ export function links(): Promise<LuaQueryCollection> {
 }
 
 /**
- * Returns all relation objects as a query collection.
+ * Returns all relation objects, optionally filtered by kind, as a query collection.
  */
-export function relations(): Promise<LuaQueryCollection> {
-  return syscall("index.relations");
+export function relations(kind?: string): Promise<LuaQueryCollection> {
+  return syscall("index.relations", kind);
 }
 
 /**
@@ -119,6 +119,16 @@ export function tables(tagName?: string): Promise<LuaQueryCollection> {
   return syscall("index.tables", tagName);
 }
 
+/**
+ * Whether a full indexing pass has ever completed for this space. False on a
+ * fresh client, and for as long as the first index takes on a large one --
+ * during which every object query answers with whatever has been indexed so
+ * far. Code that has to work in that window reads the space directly instead.
+ */
+export function isAvailable(): Promise<boolean> {
+  return syscall("index.isAvailable");
+}
+
 /**
  * Returns all aspiring (referenced but not yet created) pages as a query collection.
  */
@@ -174,6 +184,13 @@ export function reindexSpace(): Promise<void> {
   return syscall("index.reindexSpace");
 }
 
+/**
+ * Drops every indexed object belonging to a file.
+ */
+export function clearFileIndex(path: string): Promise<void> {
+  return syscall("index.clearFileIndex", path);
+}
+
 export function deleteObject(
   page: string,
   tag: string,
@@ -186,6 +203,7 @@ export type {
   AnchorHit,
   ResolveAnchorResult,
 } from "../../plugs/index/types.ts";
+
 import type { ResolveAnchorResult } from "../../plugs/index/types.ts";
 
 /**

package/plug-api/syscalls/search.ts

@@ -0,0 +1,11 @@
+import { syscall } from "../syscall.ts";
+
+export function rankObjects(
+  objects: any[],
+  phrase: string,
+  options?: {
+    fields?: Record<string, number | { weight: number; segments?: boolean }>;
+  },
+): Promise<any[]> {
+  return syscall("search.rank", objects, phrase, options);
+}