@silverbulletmd/silverbullet 2.4.1

package/plug-api/system_mock.ts

@@ -0,0 +1,89 @@
+import { Config } from "../client/config.ts";
+import { DataStore } from "../client/data/datastore.ts";
+import { MemoryKvPrimitives } from "../client/data/memory_kv_primitives.ts";
+import { DataStoreMQ } from "../client/data/mq.datastore.ts";
+import { ObjectIndex } from "../client/data/object_index.ts";
+import { EventHook } from "../client/plugos/hooks/event.ts";
+import {
+  dataStoreReadSyscalls,
+  dataStoreWriteSyscalls,
+} from "../client/plugos/syscalls/datastore.ts";
+import { eventSyscalls } from "../client/plugos/syscalls/event.ts";
+import { indexSyscalls } from "../client/plugos/syscalls/index.ts";
+import { jsonschemaSyscalls } from "../client/plugos/syscalls/jsonschema.ts";
+import { languageSyscalls } from "../client/plugos/syscalls/language.ts";
+import { luaSyscalls } from "../client/plugos/syscalls/lua.ts";
+import { markdownSyscalls } from "../client/plugos/syscalls/markdown.ts";
+import { mqSyscalls } from "../client/plugos/syscalls/mq.ts";
+import {
+  spaceReadSyscalls,
+  spaceWriteSyscalls,
+} from "../client/plugos/syscalls/space.ts";
+import { systemSyscalls } from "../client/plugos/syscalls/system.ts";
+import { System } from "../client/plugos/system.ts";
+import { Space } from "../client/space.ts";
+import { SpaceLuaEnvironment } from "../client/space_lua.ts";
+import { DataStoreSpacePrimitives } from "../client/spaces/datastore_space_primitives.ts";
+import { EventedSpacePrimitives } from "../client/spaces/evented_space_primitives.ts";
+
+export function createMockSystem() {
+  const system = new System<any>();
+  const eventHook = new EventHook();
+  system.addHook(eventHook);
+  const kv = new MemoryKvPrimitives();
+  const ds = new DataStore(kv);
+  const spacePrimitives = new EventedSpacePrimitives(
+    new DataStoreSpacePrimitives(kv),
+    eventHook,
+    ds,
+  );
+
+  const space = new Space(spacePrimitives, eventHook);
+  const mq = new DataStoreMQ(ds, eventHook);
+  const config = new Config();
+  const clientMock: any = {
+    space,
+    config,
+    eventedSpacePrimitives: spacePrimitives,
+  };
+
+  const objectIndex = new ObjectIndex(ds, config, eventHook, mq);
+
+  const clientSystemMock: any = {
+    system: system,
+    spaceLuaEnv: new SpaceLuaEnvironment(system, objectIndex),
+  };
+  clientMock.clientSystem = clientSystemMock;
+
+  system.registerSyscalls(
+    [],
+    eventSyscalls(eventHook, clientMock),
+    spaceReadSyscalls(clientMock),
+    spaceWriteSyscalls(clientMock),
+    markdownSyscalls(clientMock),
+    languageSyscalls(),
+    jsonschemaSyscalls(),
+    indexSyscalls(objectIndex, clientMock),
+    luaSyscalls(clientSystemMock),
+    mqSyscalls(mq),
+    dataStoreReadSyscalls(ds, clientSystemMock),
+    dataStoreWriteSyscalls(ds),
+    systemSyscalls(clientMock, false),
+  );
+
+  // @ts-ignore: global
+  globalThis.syscall = (name: string, ...args: any): Promise<any> => {
+    return system.localSyscall(name, args);
+  };
+
+  return {
+    system,
+    eventHook,
+    config,
+    kv,
+    spacePrimitives,
+    mq,
+    ds,
+    space,
+  };
+}

package/plug-api/types/client.ts

@@ -0,0 +1,116 @@
+import type { ParseTree } from "@silverbulletmd/silverbullet/lib/tree";
+import type { PageMeta } from "@silverbulletmd/silverbullet/type/index";
+
+export type FilterOption = {
+  name: string;
+  description?: string;
+  orderId?: number;
+  hint?: string;
+  hintInactive?: boolean;
+  classes?: string;
+  prefix?: string;
+} & Record<string, any>;
+
+export type Notification = {
+  id: number;
+  message: string;
+  type: "info" | "error";
+  date: Date;
+};
+
+export type PanelMode = number;
+
+export type CodeWidgetContent = {
+  html?: string;
+  script?: string;
+  width?: number;
+  height?: number;
+  url?: string;
+};
+
+// Document editors stuff
+export type DocumentEditorCallback = () => Promise<DocumentEditorContent>;
+export type DocumentEditorContent = {
+  html: string;
+};
+
+export type LintDiagnostic = {
+  from: number;
+  to: number;
+  severity: "error" | "warning" | "info" | "hint";
+  message: string;
+};
+
+export type UploadFile = {
+  name: string;
+  contentType: string;
+  content: Uint8Array;
+};
+
+export type AppEvent =
+  | "page:click"
+  | "slash:complete"
+  | "editor:complete"
+  | "editor:lint"
+  | "editor:init"
+  | "editor:pageLoaded" // args: pageName, previousPage, isSynced
+  | "editor:pageReloaded"
+  | "editor:pageSaving"
+  | "editor:pageSaved"
+  | "editor:pageCreating"
+  | "editor:pageModified"
+  | "editor:documentSaving"
+  | "editor:documentSaved"
+  | "editor:modeswitch"
+  | "editor:fold"
+  | "editor:unfold"
+  | "plugs:loaded"
+  | "cron:secondPassed"
+  | "hooks:renderTopWidgets"
+  | "hooks:renderBottomWidgets";
+
+export type ClickEvent = {
+  page: string;
+  pos: number;
+  metaKey: boolean;
+  ctrlKey: boolean;
+  altKey: boolean;
+};
+
+export type EnrichedClickEvent = ClickEvent & {
+  parentNodes: string[];
+};
+
+export type LintEvent = {
+  name: string;
+  pageMeta: PageMeta;
+  tree: ParseTree;
+  text: string;
+};
+
+export type CompleteEvent = {
+  pageName: string;
+  linePrefix: string;
+  pos: number;
+  parentNodes: string[];
+};
+
+export type SlashCompletionOption = {
+  label: string;
+  detail?: string;
+  invoke: string;
+  order?: number;
+} & Record<string, any>;
+
+export type SlashCompletions = {
+  // Ignore this one, only for compatibility with regular completions
+  from?: number;
+  // The actual completions
+  options: SlashCompletionOption[];
+};
+
+// Code widget stuff
+export type CodeWidgetCallback = (
+  bodyText: string,
+  pageName: string,
+) => Promise<CodeWidgetContent | null>;

package/plug-api/types/config.ts

@@ -0,0 +1,22 @@
+export type EmojiConfig = {
+  aliases: string[][];
+};
+export type QueryCollationConfig = {
+  enabled?: boolean;
+  locale?: string;
+  options?: object;
+};
+
+type vimMode = "normal" | "insert" | "visual";
+
+export type VimConfig = {
+  unmap?: (string | { key: string; mode?: vimMode })[];
+  map?: { map: string; to: string; mode?: vimMode }[];
+  noremap?: { map: string; to: string; mode?: vimMode }[];
+  commands?: { ex: string; command: string }[];
+};
+export type SmartQuotesConfig = {
+  enabled?: boolean;
+  double?: { left?: string; right?: string };
+  single?: { left?: string; right?: string };
+};

package/plug-api/types/datastore.ts

@@ -0,0 +1,28 @@
+// Message Queue related types
+export type MQMessage = {
+  id: string;
+  queue: string;
+  body: any;
+  retries?: number;
+};
+export type MQStats = {
+  queued: number;
+  processing: number;
+  dlq: number;
+};
+export type MQSubscribeOptions = {
+  batchSize?: number;
+  pollInterval?: number;
+};
+
+// KV types
+export type KvKey = string[];
+
+export type KV<T = any> = {
+  key: KvKey;
+  value: T;
+};
+
+export type KvQuery = {
+  prefix?: KvKey;
+};

package/plug-api/types/event.ts

@@ -0,0 +1,27 @@
+import type { ParseTree } from "@silverbulletmd/silverbullet/lib/tree";
+import type { EventSubscriptionDef } from "./manifest.ts";
+import type { PageMeta } from "@silverbulletmd/silverbullet/type/index";
+
+export type IndexTreeEvent = {
+  name: string;
+  tree: ParseTree;
+  meta: PageMeta;
+  text: string;
+};
+
+export type PageCreatingEvent = {
+  name: string;
+};
+
+export type PageCreatingContent = {
+  text: string;
+  perm: "ro" | "rw";
+};
+export type EventSubscription = EventSubscriptionDef & {
+  run: (...args: any[]) => Promise<any>;
+};
+
+export type ResolvedPlug = {
+  code: string;
+  name?: string; // This will only dictate the filename
+} | string;

package/plug-api/types/index.ts

@@ -0,0 +1,56 @@
+export type FileMeta = {
+  name: string;
+  created: number;
+  lastModified: number;
+  contentType: string;
+  size: number;
+  perm: "ro" | "rw";
+};
+/**
+ * Decorates a page when it matches certain criteria
+ */
+export type PageDecoration = {
+  prefix?: string;
+  cssClasses?: string[];
+  hide?: boolean;
+  renderWidgets?: boolean; // Defaults to true
+};
+export type PageMeta = ObjectValue<
+  {
+    name: string;
+    created: string; // indexing it as a string
+    lastModified: string; // indexing it as a string
+    perm: "ro" | "rw";
+    lastOpened?: number;
+    pageDecoration?: PageDecoration;
+  } & Record<string, any>
+>;
+export type DocumentMeta = ObjectValue<
+  {
+    name: string;
+    contentType: string;
+    created: string;
+    lastModified: string;
+    size: number;
+    perm: "ro" | "rw";
+    extension: string;
+  } & Record<string, any>
+>;
+export type SyscallMeta = {
+  name: string;
+  requiredPermissions: string[];
+  argCount: number;
+};
+/**
+ * An ObjectValue that can be indexed by the `index` plug, needs to have a minimum of
+ * of two fields:
+ * - ref: a unique reference (id) for the object, ideally a page reference
+ * - tags: a list of tags that the object belongs to
+ */
+export type ObjectValue<T = any> = {
+  ref: string;
+  tag: string; // main tag
+  range?: [number, number];
+  tags?: string[];
+  itags?: string[]; // implicit or inherited tags (inherited from the page for instance)
+} & T;

package/plug-api/types/manifest.ts

@@ -0,0 +1,98 @@
+import type { Manifest as PlugosManifest } from "../../client/plugos/types.ts";
+import type { NamespaceOperation } from "./namespace.ts";
+
+export type CodeWidgetT = {
+  codeWidget?: string;
+  renderMode?: "iframe";
+};
+
+export type CommandDef = {
+  name: string;
+
+  contexts?: string[];
+
+  // Default 0, higher is higher priority = higher in the list
+  priority?: number;
+
+  // Bind to keyboard shortcut
+  key?: string | string[];
+  mac?: string | string[];
+
+  hide?: boolean;
+  requireMode?: "rw" | "ro";
+  requireEditor?: "any" | "page" | "notpage" | string;
+};
+export type CommandHookT = {
+  command?: CommandDef;
+};
+
+export type EventHookT = {
+  events?: string[];
+};
+
+export type EventSubscriptionDef = {
+  name: string;
+};
+
+type MQSubscription = {
+  queue: string;
+  batchSize?: number;
+  pollInterval?: number;
+  autoAck?: boolean;
+};
+export type MQHookT = {
+  mqSubscriptions?: MQSubscription[];
+};
+
+export type PlugNamespaceDef = {
+  pattern: string;
+  operation: NamespaceOperation;
+};
+
+export type PlugNamespaceHookT = {
+  pageNamespace?: PlugNamespaceDef;
+};
+
+export type SlashCommandDef = {
+  name: string;
+  description?: string;
+  priority?: number;
+  // Parent AST nodes in which this slash command is available, defaults to everywhere
+  onlyContexts?: string[];
+  // Parent AST nodes in which this slash command is not available
+  exceptContexts?: string[];
+};
+export type SlashCommandHookT = {
+  slashCommand?: SlashCommandDef;
+};
+
+export type SyscallHookT = {
+  syscall?: string;
+};
+
+export type DocumentEditorT = {
+  editor?: string | string[];
+};
+
+/** Silverbullet hooks give plugs access to silverbullet core systems.
+ *
+ * Hooks are associated with typescript functions through a manifest file.
+ * On various triggers (user enters a slash command, an HTTP endpoint is hit, user clicks, etc) the typescript function is called.
+ *
+ * related: plugos/ui_types.ts#FunctionDef
+ */
+export type SilverBulletHooks =
+  & CommandHookT
+  & SlashCommandHookT
+  & MQHookT
+  & EventHookT
+  & CodeWidgetT
+  & PlugNamespaceHookT
+  & DocumentEditorT
+  & SyscallHookT;
+
+/** A plug manifest configures hooks, declares syntax extensions, and describes plug metadata.
+ *
+ * Typically the manifest file is in a plug's root directory, named `${plugName}.plug.yaml`.
+ */
+export type Manifest = PlugosManifest<SilverBulletHooks>;

package/plug-api/types/namespace.ts

@@ -0,0 +1,6 @@
+export type NamespaceOperation =
+  | "readFile"
+  | "writeFile"
+  | "listFiles"
+  | "getFileMeta"
+  | "deleteFile";

package/plugs/builtin_plugs.ts

@@ -0,0 +1,14 @@
+// TODO: Figure out how to keep this up-to-date automatically
+export const builtinPlugNames = [
+  "core",
+  "editor",
+  "index",
+  "sync",
+  "plug-manager",
+  "emoji",
+  "image-viewer",
+];
+
+export const builtinPlugPaths = builtinPlugNames.map((name) =>
+  `Library/Std/Plugs/${name}.plug.js`
+);