@silverbulletmd/silverbullet 2.9.0 → 2.11.0

package/client/space_lua/stdlib/os.ts

@@ -147,7 +147,6 @@ function buildSpecMap(d: Date, utc: boolean): Record<string, () => string> {
   const dow = () => wd(d, utc);
 
   return {
-    // Date
     Y: () => yr(d, utc).toString(),
     y: () => pad2(yr(d, utc) % 100),
     C: () => pad2(Math.floor(yr(d, utc) / 100)),
@@ -156,14 +155,12 @@ function buildSpecMap(d: Date, utc: boolean): Record<string, () => string> {
     e: () => da(d, utc).toString().padStart(2, " "),
     j: () => pad3(dayOfYear(d, utc)),
 
-    // Time
     H: () => pad2(h()),
     I: () => pad2(h12()),
     M: () => pad2(mi(d, utc)),
     S: () => pad2(sc(d, utc)),
     p: () => (h() >= 12 ? "PM" : "AM"),
 
-    // Weekday
     A: () =>
       d.toLocaleString("en-US", {
         weekday: "long",
@@ -177,7 +174,6 @@ function buildSpecMap(d: Date, utc: boolean): Record<string, () => string> {
     w: () => dow().toString(),
     u: () => (dow() === 0 ? 7 : dow()).toString(),
 
-    // Month name
     b: () =>
       d.toLocaleString("en-US", {
         month: "short",
@@ -194,14 +190,12 @@ function buildSpecMap(d: Date, utc: boolean): Record<string, () => string> {
         ...(utc ? { timeZone: "UTC" } : {}),
       }),
 
-    // Week number
     U: () => pad2(weekNumber(d, utc, 0, false)),
     W: () => pad2(weekNumber(d, utc, 1, false)),
     V: () => pad2(weekNumber(d, utc, 1, true)),
     G: () => isoWeekYear(d, utc).toString(),
     g: () => pad2(isoWeekYear(d, utc) % 100),
 
-    // Composite specifiers
     c: () =>
       d.toLocaleString("en-US", {
         ...(utc ? { timeZone: "UTC" } : {}),
@@ -225,14 +219,11 @@ function buildSpecMap(d: Date, utc: boolean): Record<string, () => string> {
         h() >= 12 ? "PM" : "AM"
       }`,
 
-    // Epoch
     s: () => Math.floor(d.getTime() / 1000).toString(),
 
-    // Whitespace
     n: () => "\n",
     t: () => "\t",
 
-    // Timezone
     Z: () => {
       if (utc) return "UTC";
       const match = d.toTimeString().match(/\((.*)\)/);
@@ -246,7 +237,6 @@ function buildSpecMap(d: Date, utc: boolean): Record<string, () => string> {
       return `${sign}${pad2(Math.floor(abs / 60))}${pad2(abs % 60)}`;
     },
 
-    // Literal
     "%": () => "%",
   };
 }
@@ -282,38 +272,71 @@ function luaFormatTime(fmt: string, d: Date, utc: boolean): string {
 }
 
 export const osApi = new LuaTable({
-  time: new LuaBuiltinFunction((_sf, tbl?: LuaTable) => {
-    if (tbl) {
-      if (!tbl.has("year")) {
-        throw new Error("time(): year is required");
+  time: new LuaBuiltinFunction({
+    callback: (_sf, tbl?: LuaTable) => {
+      if (tbl) {
+        if (!tbl.has("year")) {
+          throw new Error("time(): year is required");
+        }
+
+        if (!tbl.has("month")) {
+          throw new Error("time(): month is required");
+        }
+
+        if (!tbl.has("day")) {
+          throw new Error("time(): day is required");
+        }
+
+        const year = tbl.get("year");
+        const month = tbl.get("month");
+        const day = tbl.get("day");
+        const hour = tbl.get("hour") ?? 12;
+        const min = tbl.get("min") ?? 0;
+        const sec = tbl.get("sec") ?? 0;
+        const date = new Date(year, month - 1, day, hour, min, sec);
+
+        return Math.floor(date.getTime() / 1000);
       }
 
-      if (!tbl.has("month")) {
-        throw new Error("time(): month is required");
-      }
-
-      if (!tbl.has("day")) {
-        throw new Error("time(): day is required");
-      }
-
-      const year = tbl.get("year");
-      const month = tbl.get("month");
-      const day = tbl.get("day");
-      const hour = tbl.get("hour") ?? 12;
-      const min = tbl.get("min") ?? 0;
-      const sec = tbl.get("sec") ?? 0;
-      const date = new Date(year, month - 1, day, hour, min, sec);
-
-      return Math.floor(date.getTime() / 1000);
-    }
-
-    return Math.floor(Date.now() / 1000);
+      return Math.floor(Date.now() / 1000);
+    },
+    description:
+      "Returns the current Unix timestamp or one built from a local date table.",
+    signatures: ["os.time(): integer", "os.time(dateTable): integer"],
+    parameters: [
+      {
+        name: "dateTable",
+        type: "table",
+        description:
+          "Local date fields `year`, `month`, `day`, and optional `hour`, `min`, and `sec`.",
+        optional: true,
+      },
+    ],
+    returns: [
+      { type: "integer", description: "Seconds since the Unix epoch." },
+    ],
+    examples: [
+      {
+        code: "local timestamp = os.time({year = 2020, month = 1, day = 1})",
+      },
+    ],
   }),
 
   // Returns the difference, from time `t1` to time `t2` in seconds
   // In POSIX and some other systems, this value is exactly $t2-t1$.
-  difftime: new LuaBuiltinFunction((_sf, t2: number, t1: number): number => {
-    return t2 - t1;
+  difftime: new LuaBuiltinFunction({
+    callback: (_sf, t2: number, t1: number): number => {
+      return t2 - t1;
+    },
+    description:
+      "Returns the difference in seconds from timestamp `t1` to `t2`.",
+    parameters: [
+      { name: "t2", type: "number" },
+      { name: "t1", type: "number" },
+    ],
+    returns: [
+      { type: "number", description: "The value `t2 - t1` in seconds." },
+    ],
   }),
 
   // Returns a string or a table containing date and time, formatted
@@ -336,29 +359,63 @@ export const osApi = new LuaTable({
   // Otherwise, format specifiers follow ISO C `strftime`.
   //
   // If format is absent, it defaults to `%c`.
-  date: new LuaBuiltinFunction((_sf, format?: string, timestamp?: number) => {
-    let fmt = format ?? "%c";
-    let utc = false;
-
-    if (fmt.startsWith("!")) {
-      utc = true;
-      fmt = fmt.slice(1);
-    }
+  date: new LuaBuiltinFunction({
+    callback: (_sf, format?: string, timestamp?: number) => {
+      let fmt = format ?? "%c";
+      let utc = false;
+
+      if (fmt.startsWith("!")) {
+        utc = true;
+        fmt = fmt.slice(1);
+      }
 
-    const d =
-      timestamp !== undefined && timestamp !== null
-        ? new Date(timestamp * 1000)
-        : new Date();
+      const d =
+        timestamp !== undefined && timestamp !== null
+          ? new Date(timestamp * 1000)
+          : new Date();
 
-    if (fmt === "*t") {
-      return dateTable(d, utc);
-    }
+      if (fmt === "*t") {
+        return dateTable(d, utc);
+      }
 
-    return luaFormatTime(fmt, d, utc);
+      return luaFormatTime(fmt, d, utc);
+    },
+    description:
+      "Formats a timestamp as a date string or date table, optionally in UTC.",
+    parameters: [
+      {
+        name: "format",
+        type: "string",
+        description:
+          "`strftime`-style format, `*t` for a table, and optional leading `!` for UTC.",
+        optional: true,
+      },
+      {
+        name: "timestamp",
+        type: "number",
+        description: "Unix timestamp; defaults to the current time.",
+        optional: true,
+      },
+    ],
+    returns: [
+      { type: "string|table", description: "Formatted date or date fields." },
+    ],
+    examples: [
+      { code: 'print(os.date("%Y-%m-%d"))\nlocal utc = os.date("!*t")' },
+    ],
   }),
 
   // Returns an approximation of CPU time used by the program in seconds.
-  clock: new LuaBuiltinFunction((_sf): number => {
-    return performance.now() / 1000.0;
+  clock: new LuaBuiltinFunction({
+    callback: (_sf): number => {
+      return performance.now() / 1000.0;
+    },
+    description: "Returns a high-resolution elapsed time value in seconds.",
+    returns: [
+      {
+        type: "number",
+        description: "Browser performance timer in seconds.",
+      },
+    ],
   }),
 });

package/client/space_lua/stdlib/pattern.ts

@@ -1,5 +1,3 @@
-// Lua Optimized Pattern Matching Engine Implementation
-
 const CH_ESC = 37; // '%'
 const CH_OPEN = 40; // '('
 const CH_CLOSE = 41; // ')'
@@ -40,21 +38,21 @@ interface Capture {
 }
 
 export interface MatchState {
-  src: string; // original source string (for substring extraction)
-  s: Uint8Array; // source bytes
+  src: string;
+  s: Uint16Array;
   slen: number;
-  p: Uint8Array; // pattern bytes
+  p: Uint16Array;
   plen: number;
   level: number;
   capture: Capture[]; // pre-allocated, length `MAX_CAPTURES`
   matchdepth: number;
 }
 
-function toBytes(s: string): Uint8Array {
+function toCodeUnits(s: string): Uint16Array {
   const len = s.length;
-  const arr = new Uint8Array(len);
+  const arr = new Uint16Array(len);
   for (let i = 0; i < len; i++) {
-    arr[i] = s.charCodeAt(i) & 0xff;
+    arr[i] = s.charCodeAt(i);
   }
   return arr;
 }
@@ -108,7 +106,7 @@ function matchClass(c: number, cl: number): boolean {
   return cl >= 97 && cl <= 122 ? res : !res;
 }
 
-function classEnd(p: Uint8Array, plen: number, pi: number): number {
+function classEnd(p: Uint16Array, plen: number, pi: number): number {
   const ch = p[pi];
   pi++;
   if (ch === CH_ESC) {
@@ -138,7 +136,7 @@ function classEnd(p: Uint8Array, plen: number, pi: number): number {
 
 function matchBracketClass(
   c: number,
-  p: Uint8Array,
+  p: Uint16Array,
   pi: number,
   ec: number,
 ): boolean {
@@ -404,8 +402,8 @@ function match(ms: MatchState, si: number, pi: number): number {
 }
 
 function createMatchState(s: string, p: string): MatchState {
-  const sb = toBytes(s);
-  const pb = toBytes(p);
+  const sb = toCodeUnits(s);
+  const pb = toCodeUnits(p);
   const capture: Capture[] = new Array(MAX_CAPTURES);
   for (let i = 0; i < MAX_CAPTURES; i++) {
     capture[i] = { init: 0, len: 0 };
@@ -434,8 +432,6 @@ function noSpecials(p: string): boolean {
   return true;
 }
 
-// Public API
-
 export type CaptureResult = { s: string } | { position: number };
 
 interface RawCapture {
@@ -615,7 +611,6 @@ function expandReplacementString(
         throw new Error("invalid use of '%' in replacement string");
       }
     } else {
-      // Collect consecutive literal characters
       let j = i + 1;
       while (j < repl.length && repl.charCodeAt(j) !== CH_ESC) j++;
       parts.push(repl.substring(i, j));