@silverbulletmd/silverbullet 2.8.1 → 2.10.0

package/plug-api/types/index.ts

@@ -36,11 +36,62 @@ export type DocumentMeta = ObjectValue<
     extension: string;
   } & Record<string, any>
 >;
-export type SyscallMeta = {
+export type SyscallMeta = LuaFunctionDocumentation & {
   name: string;
   requiredPermissions: string[];
   argCount: number;
 };
+
+export type LuaFunctionParameterDocumentation = {
+  name: string;
+  type?: string;
+  description?: string;
+  optional?: boolean;
+};
+
+export type LuaFunctionReturnDocumentation = {
+  type?: string;
+  description?: string;
+};
+
+export type LuaFunctionExampleDocumentation = {
+  code: string;
+  description?: string;
+  language?: string;
+};
+
+/** Structured documentation shared by Lua functions, built-ins and syscalls. */
+export type LuaFunctionDocumentation = {
+  description?: string;
+  parameters?: LuaFunctionParameterDocumentation[];
+  returns?: LuaFunctionReturnDocumentation[];
+  /** Full signatures, used for overloaded or otherwise non-standard functions. */
+  signatures?: string[];
+  examples?: LuaFunctionExampleDocumentation[];
+  deprecated?: string | boolean;
+  /** Page or page anchor containing the full documentation. */
+  see?: string;
+};
+
+export type LuaFunctionInfo = LuaFunctionDocumentation & {
+  name?: string;
+  kind: "lua" | "builtin" | "syscall";
+  source?: Record<string, unknown>;
+};
+
+export type LuaPropertyInspection = {
+  key: string;
+  type: string;
+  functionInfo?: LuaFunctionInfo;
+  definition?: string;
+};
+
+export type LuaValueInspection = {
+  type: string;
+  functionInfo?: LuaFunctionInfo;
+  definition?: string;
+  properties: LuaPropertyInspection[];
+};
 /**
  * An ObjectValue that can be indexed by the `index` plug, needs to have a minimum of
  * of two fields:

package/plug-api/types/manifest.ts

@@ -1,5 +1,6 @@
 import type { Manifest as PlugosManifest } from "../../client/plugos/types.ts";
 import type { NamespaceOperation } from "./namespace.ts";
+import type { LuaFunctionDocumentation } from "./index.ts";
 
 export type CodeWidgetT = {
   codeWidget?: string;
@@ -12,10 +13,23 @@ export type CodeWidgetT = {
  * Quit, About, etc.) instead of a command-dispatching item.
  */
 export type PredefinedMenuKind =
-  | "quit" | "about" | "services" | "hide" | "hideOthers" | "showAll"
-  | "closeWindow" | "minimize" | "maximize" | "fullscreen"
+  | "quit"
+  | "about"
+  | "services"
+  | "hide"
+  | "hideOthers"
+  | "showAll"
+  | "closeWindow"
+  | "minimize"
+  | "maximize"
+  | "fullscreen"
   | "separator"
-  | "undo" | "redo" | "cut" | "copy" | "paste" | "selectAll";
+  | "undo"
+  | "redo"
+  | "cut"
+  | "copy"
+  | "paste"
+  | "selectAll";
 
 /**
  * A single native-menu placement for a command or submenu.
@@ -130,7 +144,11 @@ export type SlashCommandHookT = {
 };
 
 export type SyscallHookT = {
-  syscall?: string;
+  syscall?:
+    | string
+    | ({
+        name: string;
+      } & LuaFunctionDocumentation);
 };
 
 export type DocumentEditorT = {

package/plug-api/ui/cx.ts

@@ -0,0 +1,4 @@
+/** Join class-name parts, dropping falsy values. */
+export function cx(...parts: Array<string | false | null | undefined>): string {
+  return parts.filter(Boolean).join(" ");
+}

package/plug-api/ui/index.ts

@@ -0,0 +1,22 @@
+export { Button } from "./button.tsx";
+export type { ButtonProps, ButtonVariant } from "./button.tsx";
+export { Input } from "./input.tsx";
+export type { InputProps } from "./input.tsx";
+export { Select } from "./select.tsx";
+export type { SelectProps } from "./select.tsx";
+export { Checkbox } from "./checkbox.tsx";
+export type { CheckboxProps } from "./checkbox.tsx";
+export { Tabs } from "./tabs.tsx";
+export type { TabItem, TabsProps } from "./tabs.tsx";
+export { Alert } from "./alert.tsx";
+export type { AlertProps, AlertVariant } from "./alert.tsx";
+export { Badge } from "./badge.tsx";
+export type { BadgeProps } from "./badge.tsx";
+export { Progress } from "./progress.tsx";
+export type { ProgressProps } from "./progress.tsx";
+export { UrlPrefixInput } from "./url_prefix_input.tsx";
+export type { UrlPrefixInputProps } from "./url_prefix_input.tsx";
+export { normalizePrefix, prefixFromName, slugify } from "./slugify.ts";
+export { cx } from "./cx.ts";
+export { panelStyles } from "./panel_styles.ts";
+export type { PanelStylesOptions } from "./panel_styles.ts";

package/plug-api/ui/panel_styles.ts

@@ -0,0 +1,33 @@
+import { getUiOption } from "../syscalls/editor.ts";
+
+export type PanelStylesOptions = {
+  /** Include the shared component stylesheet link (default true). */
+  components?: boolean;
+  /** Include the user's space-style CSS (default true). */
+  spaceStyles?: boolean;
+};
+
+/**
+ * Build an HTML preamble that styles a plug panel/widget iframe like the rest
+ * of SilverBullet: the shared component stylesheet plus the user's space-style
+ * CSS. Prepend the result to the HTML you pass to `editor.showPanel`.
+ *
+ * Order: components first (base), then space styles (so user theming wins),
+ * leaving any plug-specific CSS you append afterwards highest-precedence.
+ */
+export async function panelStyles({
+  components = true,
+  spaceStyles = true,
+}: PanelStylesOptions = {}): Promise<string> {
+  let out = "";
+  if (components) {
+    out += `<link rel="stylesheet" href=".client/components.css">`;
+  }
+  if (spaceStyles) {
+    const custom = await getUiOption("customStyles");
+    if (typeof custom === "string" && custom) {
+      out += custom;
+    }
+  }
+  return out;
+}

package/plug-api/ui/slugify.ts

@@ -0,0 +1,44 @@
+/**
+ * Lower-cased, filesystem- and URL-safe version of a space name, used to
+ * derive its default folder and URL prefix.
+ *
+ * Mirrors the server's `slug::slugify`, so a prefix typed into the Space
+ * Manager, the first-run wizard, or the desktop app's space form all reach the
+ * server in the same shape.
+ */
+export function slugify(name: string): string {
+  return name
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+}
+
+/**
+ * The default URL prefix for a space called `name`, as an absolute path.
+ *
+ * The leading slash is part of the value, not decoration: a binding prefix is
+ * a path, the server stores and validates it that way, and showing it in the
+ * field is what makes the assembled URL in `UrlPrefixInput` read correctly. An
+ * empty name yields `""` rather than a bare `"/"`, which would bind the space
+ * to the server root.
+ */
+export function prefixFromName(name: string): string {
+  const slug = slugify(name);
+  return slug ? `/${slug}` : "";
+}
+
+/**
+ * Force a user-typed prefix into the shape the server accepts: exactly one
+ * leading slash, and a slugified body.
+ *
+ * Callers that hand a prefix straight to an API need this because a value
+ * already starting with `/` is taken as-is by the desktop app's
+ * `provision_space` command — it only slugifies input that lacks the slash, so
+ * `/My Space!` would otherwise be sent through verbatim. Returns `""` for an
+ * empty or slash-only input, the server's spelling of a root binding.
+ */
+export function normalizePrefix(raw: string): string {
+  const slug = slugify(raw.replace(/^\/+/, ""));
+  return slug ? `/${slug}` : "";
+}

package/plugs/builtin_plugs.ts

@@ -7,6 +7,7 @@ export const builtinPlugNames = [
   "emoji",
   "image-viewer",
   "configuration-manager",
+  "object-graph",
 ];
 
 export const builtinPlugPaths = builtinPlugNames.map(

package/client/plugos/syscalls/lua.ts

@@ -1,58 +0,0 @@
-import type { SysCallMapping } from "../system.ts";
-import { evalExpression } from "../../space_lua/eval.ts";
-import { parse, parseExpressionString } from "../../space_lua/parse.ts";
-import {
-  LuaStackFrame,
-  luaToString,
-  luaValueToJS,
-} from "../../space_lua/runtime.ts";
-import { buildThreadLocalEnv } from "../../space_lua_api.ts";
-import { isSendable } from "../util.ts";
-import type { LuaBlock, LuaExpression } from "../../space_lua/ast.ts";
-import type { ClientSystem } from "../../client_system.ts";
-
-export function luaSyscalls(clientSystem: ClientSystem): SysCallMapping {
-  return {
-    "lua.parse": (_ctx, code: string): LuaBlock => {
-      return parse(code);
-    },
-    "lua.parseExpression": (_ctx, expression: string): LuaExpression => {
-      return parseExpressionString(expression);
-    },
-    /**
-     * Evaluates a Lua expression and returns the result as a JavaScript value
-     * @param _ctx
-     * @param expression
-     * @returns
-     */
-    "lua.evalExpression": async (_ctx, expression: string) => {
-      try {
-        const ast = parseExpressionString(expression);
-        const env = await buildThreadLocalEnv(
-          clientSystem.system,
-          clientSystem.spaceLuaEnv.env,
-        );
-        const sf = new LuaStackFrame(env, null);
-        const luaResult = await evalExpression(
-          ast,
-          clientSystem.spaceLuaEnv.env,
-          sf,
-        );
-        const jsResult = luaValueToJS(luaResult, sf);
-        if (isSendable(jsResult)) {
-          return jsResult;
-        } else {
-          // This may evaluate to e.g. a function, which is not sendable, in this case we'll console.warn and return a stringified version of the result
-          console.warn(
-            "Lua eval result is not sendable, returning stringified version",
-            jsResult,
-          );
-          return luaToString(luaResult);
-        }
-      } catch (e: any) {
-        console.error("Lua eval error: ", e.message, e.sf?.astCtx);
-        throw e;
-      }
-    },
-  };
-}