@rohal12/spindle 0.52.4 → 0.52.6

package/dist/pkg/macro-registry.json

@@ -3,6 +3,13 @@
     "name": "set",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "code",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -11,6 +18,13 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "expression",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -18,6 +32,22 @@
     "block": false,
     "subMacros": [],
     "merged": true,
+    "parameters": [
+      {
+        "name": "target",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "=",
+        "type": "separator"
+      },
+      {
+        "name": "expression",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -26,6 +56,22 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "current",
+        "type": "expression",
+        "required": true
+      },
+      {
+        "name": "max",
+        "type": "expression",
+        "required": true
+      },
+      {
+        "name": "label",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -42,6 +88,22 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "variables",
+        "type": "names",
+        "required": true
+      },
+      {
+        "name": "of",
+        "type": "separator"
+      },
+      {
+        "name": "list",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -55,6 +117,13 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "delay",
+        "type": "delay",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -62,6 +131,13 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "label",
+        "type": "text",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -69,6 +145,17 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "text",
+        "type": "string",
+        "required": true
+      },
+      {
+        "name": "passage",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -79,6 +166,13 @@
       "default"
     ],
     "merged": true,
+    "parameters": [
+      {
+        "name": "expression",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -101,6 +195,13 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "delay",
+        "type": "delay",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -162,6 +263,17 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "label",
+        "type": "text",
+        "required": true
+      },
+      {
+        "name": "noclose",
+        "type": "flag"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -182,6 +294,17 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "inline",
+        "type": "flag"
+      },
+      {
+        "name": "passage",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -195,12 +318,26 @@
     "block": false,
     "subMacros": [],
     "merged": true,
+    "parameters": [
+      {
+        "name": "passage",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
     "name": "unset",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -208,6 +345,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "placeholder",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -215,6 +363,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "placeholder",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -222,6 +381,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "placeholder",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -229,6 +399,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "label",
+        "type": "text"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -236,6 +417,22 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "value",
+        "type": "text",
+        "required": true
+      },
+      {
+        "name": "label",
+        "type": "text"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -245,6 +442,13 @@
       "option"
     ],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -252,6 +456,13 @@
     "block": true,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -271,12 +482,56 @@
     "name": "watch",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "condition",
+        "type": "string",
+        "required": true
+      },
+      {
+        "name": "options",
+        "type": "options",
+        "parameters": [
+          {
+            "name": "goto",
+            "type": "string"
+          },
+          {
+            "name": "dialog",
+            "type": "string"
+          },
+          {
+            "name": "run",
+            "type": "string"
+          },
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "priority",
+            "type": "number"
+          },
+          {
+            "name": "once",
+            "type": "flag"
+          }
+        ]
+      }
+    ],
     "source": "builtin"
   },
   {
     "name": "unwatch",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "name",
+        "type": "text",
+        "required": true
+      }
+    ],
     "source": "builtin"
   }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rohal12/spindle",
-  "version": "0.52.4",
+  "version": "0.52.6",
   "type": "module",
   "description": "A Preact-based story format for Twine 2.",
   "license": "Unlicense",

package/src/class-registry.ts

@@ -1,5 +1,11 @@
 // Class registry for preserving class instances across clone/save/load cycles.
 
+import { setOwn } from './structural';
+import { hasOwn } from './utils/namespace';
+
+// Copying and comparing story values live with the structural diff
+export { deepClone, deepEqual, type DeepCloneOptions } from './structural';
+
 type Constructor = new (...args: any[]) => any;
 
 const registry = new Map<string, Constructor>();
@@ -33,188 +39,6 @@ export function clearRegistry(): void {
   ctorToName.clear();
 }
 
-// --- Deep Clone ---
-
-function isPlainObject(value: unknown): value is Record<string, unknown> {
-  if (typeof value !== 'object' || value === null) return false;
-  const proto = Object.getPrototypeOf(value);
-  return proto === Object.prototype || proto === null;
-}
-
-/**
- * Set an own enumerable property. A "__proto__" key is defined as an own
- * property (as JSON.parse does) instead of replacing the prototype.
- */
-function setOwn(target: object, key: string, value: unknown): void {
-  if (key === '__proto__') {
-    Object.defineProperty(target, key, {
-      value,
-      enumerable: true,
-      writable: true,
-      configurable: true,
-    });
-  } else {
-    (target as Record<string, unknown>)[key] = value;
-  }
-}
-
-export interface DeepCloneOptions {
-  /**
-   * Return instances of unregistered classes (DOM nodes, promises, other
-   * library objects) by reference instead of copying their own keys into a
-   * plain object, which would lose their prototype and identity.
-   */
-  keepUnregistered?: boolean;
-}
-
-export function deepClone<T>(value: T, options: DeepCloneOptions = {}): T {
-  const seen = new Map<object, object>();
-
-  function clone(val: unknown): unknown {
-    if (val === null || typeof val !== 'object') return val;
-
-    const obj = val as object;
-    if (seen.has(obj)) return seen.get(obj);
-
-    if (val instanceof Date) return new Date(val.getTime()) as unknown;
-    if (val instanceof RegExp)
-      return new RegExp(val.source, val.flags) as unknown;
-
-    if (Array.isArray(val)) {
-      const arr: unknown[] = [];
-      seen.set(obj, arr);
-      for (let i = 0; i < val.length; i++) {
-        arr[i] = clone(val[i]);
-      }
-      return arr;
-    }
-
-    if (val instanceof Map) {
-      const copy = new Map();
-      seen.set(obj, copy);
-      for (const [k, v] of val) {
-        copy.set(clone(k), clone(v));
-      }
-      return copy;
-    }
-
-    if (val instanceof Set) {
-      const copy = new Set();
-      seen.set(obj, copy);
-      for (const v of val) {
-        copy.add(clone(v));
-      }
-      return copy;
-    }
-
-    // Registered class instance
-    const name = registeredClassName(obj);
-    if (name !== undefined) {
-      const copy = Object.create(Object.getPrototypeOf(obj)) as Record<
-        string,
-        unknown
-      >;
-      seen.set(obj, copy);
-      for (const key of Object.keys(obj)) {
-        setOwn(copy, key, clone((obj as Record<string, unknown>)[key]));
-      }
-      return copy;
-    }
-
-    // Plain object (or unregistered class — treat as plain). A plain object
-    // keeps its prototype, which may be null.
-    const plain = isPlainObject(val);
-    if (!plain && options.keepUnregistered) return val;
-    const copy = (
-      plain ? Object.create(Object.getPrototypeOf(obj) as object | null) : {}
-    ) as Record<string, unknown>;
-    seen.set(obj, copy);
-    for (const key of Object.keys(obj)) {
-      setOwn(copy, key, clone((obj as Record<string, unknown>)[key]));
-    }
-    return copy;
-  }
-
-  return clone(value) as T;
-}
-
-// --- Deep Equal ---
-
-/**
- * Structural equality over the value types deepClone() supports: primitives,
- * arrays, plain objects, class instances, Date, RegExp, Map and Set (nested
- * at any depth). Map and Set entries are compared in insertion order. Arrays
- * are compared by length and index, so a hole equals an undefined element
- * (deepClone() and save/load turn holes into undefined elements).
- */
-export function deepEqual(a: unknown, b: unknown): boolean {
-  return equal(a, b, new Map());
-}
-
-/**
- * `assumed` holds the pairs already being compared: meeting one again (a
- * cycle) assumes it equal. Every object may pair with several others, since
- * cycles of different lengths can still unfold to the same value.
- */
-function equal(
-  a: unknown,
-  b: unknown,
-  assumed: Map<object, Set<object>>,
-): boolean {
-  if (Object.is(a, b)) return true;
-  if (
-    a === null ||
-    b === null ||
-    typeof a !== 'object' ||
-    typeof b !== 'object'
-  ) {
-    return false;
-  }
-  if (Object.getPrototypeOf(a) !== Object.getPrototypeOf(b)) return false;
-  const pairs = assumed.get(a);
-  if (pairs?.has(b)) return true;
-  if (pairs) pairs.add(b);
-  else assumed.set(a, new Set([b]));
-
-  if (a instanceof Date) return Object.is(a.getTime(), (b as Date).getTime());
-  if (a instanceof RegExp) return String(a) === String(b);
-  if (a instanceof Map || a instanceof Set) {
-    const bc = b as Map<unknown, unknown> | Set<unknown>;
-    if (a.size !== bc.size) return false;
-    const ai = a.entries();
-    const bi = bc.entries();
-    for (
-      let x = ai.next(), y = bi.next();
-      !x.done;
-      x = ai.next(), y = bi.next()
-    ) {
-      if (!equal(x.value, y.value, assumed)) return false;
-    }
-    return true;
-  }
-
-  if (Array.isArray(a)) {
-    const bc = b as unknown[];
-    if (a.length !== bc.length) return false;
-    for (let i = 0; i < a.length; i++) {
-      if (!equal(a[i], bc[i], assumed)) return false;
-    }
-    return true;
-  }
-
-  const ao = a as Record<string, unknown>;
-  const bo = b as Record<string, unknown>;
-  const keys = Object.keys(ao);
-  if (keys.length !== Object.keys(bo).length) return false;
-  for (const key of keys) {
-    if (!hasOwn(bo, key) || !equal(ao[key], bo[key], assumed)) return false;
-  }
-  return true;
-}
-
-const hasOwn = (obj: object, key: string): boolean =>
-  Object.prototype.hasOwnProperty.call(obj, key);
-
 // --- Serialize ---
 
 const CLASS_TAG = '__spindle_class__';

package/src/components/macros/Button.tsx

@@ -1,15 +1,13 @@
 import { defineMacro } from '../../define-macro';
-import { readWholeQuoted } from './arg-utils';
 import { useDetachedBody } from './detached-body';
 
 defineMacro({
   name: 'button',
   block: true,
   interpolate: true,
+  parameters: [{ name: 'label', type: 'text', required: true }],
   render({ rawArgs, children = [] }, ctx) {
-    const text =
-      readWholeQuoted(rawArgs.trim()) ?? rawArgs.replace(/^["']|["']$/g, '');
-    const label = ctx.resolve?.(text) ?? rawArgs;
+    const label = ctx.resolve?.(ctx.args.label ?? '') ?? rawArgs;
     const runBody = useDetachedBody();
 
     // Run the body outside the passage tree: all macro side effects ({set},

package/src/components/macros/Checkbox.tsx

@@ -1,21 +1,14 @@
 import { defineMacro } from '../../define-macro';
-import { readWholeQuoted, stripLooseQuotes } from './arg-utils';
-
-export function parseCheckboxLabel(rawArgs: string): string {
-  // `s`: a quoted label may span lines. Its trailing whitespace is trimmed
-  // here, not by the regex: `(.+?)\s*$` tries every position of a run of
-  // spaces in the label, taking time quadratic in its length.
-  const match = rawArgs.match(/^\s*["']?\$?[\w.]+["']?\s+(.+)$/s);
-  if (!match) return '';
-  const rest = match[1]!.trimEnd() || match[1]!;
-  return readWholeQuoted(rest) ?? stripLooseQuotes(rest);
-}
 
 defineMacro({
   name: 'checkbox',
   storeVar: true,
-  render({ rawArgs }, ctx) {
-    const label = parseCheckboxLabel(rawArgs);
+  parameters: [
+    { name: 'variable', type: 'variable', required: true },
+    { name: 'label', type: 'text' },
+  ],
+  render(_props, ctx) {
+    const label = ctx.args.label ?? '';
 
     ctx.useAction({
       type: 'checkbox',