@rohal12/spindle 0.59.6 → 0.59.7

package/dist/pkg/headless.js

@@ -12575,10 +12575,18 @@ var defineData = (target, key, value) => {
 	});
 };
 /**
+* A reducer extracts string keys, so devalue never sees the symbol keys of
+* the original object: refuse them here, as it does for a plain object.
+*/
+function refuseSymbolKeys(value) {
+	if (Object.getOwnPropertySymbols(value).length > 0) throw new TypeError("spindle: Cannot save an object with symbol keys");
+}
+/**
 * Own enumerable keys of `value`, as a plain object; for an error also its
 * message, cause and (AggregateError) errors, which are not enumerable.
 */
 function ownData(value) {
+	refuseSymbolKeys(value);
 	const data = {};
 	if (value instanceof Error) {
 		for (const key of ERROR_HIDDEN_KEYS$1) if (hasOwn(value, key)) defineData(data, key, value[key]);
@@ -12605,6 +12613,7 @@ function reducers() {
 		if (!isObject(v) || Object.getPrototypeOf(v) !== Object.prototype) return false;
 		const keys = Object.keys(v);
 		if (!keys.some(isEscapedOneCharKey)) return false;
+		refuseSymbolKeys(v);
 		if (keys.includes("__proto__")) throw new TypeError("spindle: Cannot save a property named \"__proto__\"");
 		return keys.flatMap((k) => [k, v[k]]);
 	};
@@ -13496,6 +13505,13 @@ function strictPairs(ab = /* @__PURE__ */ new Map(), ba = /* @__PURE__ */ new Ma
 	return pairs;
 }
 /**
+* Whether `a` and `b` are equal as deepEqual() has it and also share
+* references at the same places (a save of one loads as the other).
+*/
+function deepEqualStrict(a, b) {
+	return equal(a, b, strictPairs());
+}
+/**
 * `curr` with each part that equals (see deepEqualStrict) the part of
 * `prev` at the same place replaced by `prev`'s: the history moments of a
 * save then share what did not change between them, which a save stores
@@ -13765,13 +13781,14 @@ function underChange(path, keys) {
 }
 /**
 * The segment standing for the entry `index` of a Map or Set in a path, or
-* for the `cause` or `errors` of an Error ('c', 'e').
+* for the `cause` or `errors` of an Error ('c', 'e'), or for the buffer a
+* typed array or DataView views ('b').
 */
 var entryKey = (kind, index) => `\0${kind}${index}`;
 var isEntryKey = (segment) => segment.startsWith("\0");
 /**
-* What a Map, Set or Error holds in place of properties (keys and values,
-* members, `cause` and `errors`), each with the segment standing for it in
+* What a Map, Set, Error or view holds in place of properties (keys and
+* values, members, `cause` and `errors`, the buffer), each with the segment standing for it in
 * a path (see entryKey); undefined for any other value.
 */
 function entryChildren(value) {
@@ -13787,7 +13804,8 @@ function entryChildren(value) {
 		for (const member of value) children.push([entryKey("s", index++), member]);
 	} else if (value instanceof Error) {
 		for (const key of ["cause", "errors"]) if (hasOwn(value, key)) children.push([entryKey(key === "cause" ? "c" : "e", 0), value[key]]);
-	} else return;
+	} else if (ArrayBuffer.isView(value)) children.push([entryKey("b", 0), value.buffer]);
+	else return;
 	return children;
 }
 /**
@@ -14245,7 +14263,9 @@ function storedRecord(meta, payload) {
 	};
 }
 var createSave = queued(createSaveNow);
-async function createSaveNow(ifid, playthroughId, payload, custom = {}) {
+async function createSaveNow(ifid, playthroughPromise, payload, custom = {}) {
+	const playthroughId = await playthroughPromise;
+	if (!playthroughId) throw new Error("No playthrough");
 	const now = (/* @__PURE__ */ new Date()).toISOString();
 	const record = storedRecord({
 		id: randomUUID(),
@@ -14261,6 +14281,10 @@ async function createSaveNow(ifid, playthroughId, payload, custom = {}) {
 	return record;
 }
 /**
+* A playthrough passed as a promise (see resolvePlaythroughId) is awaited
+* inside the operation, so the call takes its place in the order of
+* operations when it is made.
+*
 * Replace the payload of an existing save, keeping its ID and `createdAt`.
 * Pass the current `playthroughId` when the new payload comes from the
 * running game: the save then holds that playthrough's state, so it is
@@ -14276,7 +14300,8 @@ async function createSaveNow(ifid, playthroughId, payload, custom = {}) {
 * before, so slot keys and metadata not passed again are kept.
 */
 var overwriteSave = queued(overwriteSaveNow);
-async function overwriteSaveNow(saveId, payload, custom, playthroughId) {
+async function overwriteSaveNow(saveId, payload, custom, playthroughPromise) {
+	const playthroughId = await playthroughPromise;
 	const backend = await getBackend();
 	const existing = await backend.getSave(saveId);
 	if (!existing) return void 0;
@@ -14983,9 +15008,18 @@ function relink(draft, work, changes) {
 function cloneNamespaces(from) {
 	const seen = /* @__PURE__ */ new Map();
 	return {
-		variables: deepClone(from.variables, { seen }),
-		temporary: deepClone(from.temporary, { seen }),
-		transient: deepClone(from.transient, { seen })
+		variables: deepClone(from.variables, {
+			keepUnregistered: true,
+			seen
+		}),
+		temporary: deepClone(from.temporary, {
+			keepUnregistered: true,
+			seen
+		}),
+		transient: deepClone(from.transient, {
+			keepUnregistered: true,
+			seen
+		})
 	};
 }
 /** The three variable namespaces of `state`, as an object to walk. */
@@ -16734,10 +16768,10 @@ function App() {
 		/* @__PURE__ */ jsx(TriggerDialogHost, {}),
 		/* @__PURE__ */ jsx(RuntimeErrors, {})
 	] });
-	return nobr ? /* @__PURE__ */ jsx(NobrContext.Provider, {
-		value: true,
+	return /* @__PURE__ */ jsx(NobrContext.Provider, {
+		value: nobr,
 		children: content
-	}) : content;
+	});
 }
 //#endregion
 //#region src/parser.ts
@@ -18779,7 +18813,7 @@ function computeAndApply(expr, name, isTemp, isLocal, getLocals, rawArgs, prevRe
 		logMacroError(`computed ${rawArgs}`, err, location);
 		return;
 	}
-	if (!deepEqual(prevRef.current, newValue)) {
+	if (!deepEqualStrict(prevRef.current, newValue)) {
 		prevRef.current = newValue;
 		if (isLocal) try {
 			localsUpdate(name, newValue);
@@ -19715,9 +19749,7 @@ function SaveManagerContent() {
 		const playthrough = resolvePlaythroughId();
 		try {
 			await saveWithHooks(void 0, void 0, beginSave, async (payload) => {
-				const ptId = await playthrough;
-				if (!ptId) throw new Error("No playthrough");
-				return createSave(ifid, ptId, payload);
+				return createSave(ifid, playthrough, payload);
 			});
 			showStatus("Save created");
 			await refresh();
@@ -19729,7 +19761,7 @@ function SaveManagerContent() {
 		const playthrough = resolvePlaythroughId();
 		try {
 			await saveWithHooks(void 0, void 0, beginSave, async (payload) => {
-				if (!await overwriteSave(saveId, payload, void 0, await playthrough || void 0)) throw new Error("Save not found");
+				if (!await overwriteSave(saveId, payload, void 0, playthrough)) throw new Error("Save not found");
 			});
 			showStatus("Save overwritten");
 			await refresh();
@@ -20566,13 +20598,13 @@ defineMacro({
 		useEffect(() => {
 			const store = useStoryStore.getState();
 			const { history, historyIndex, transitionConfig } = store;
-			const next = store.consumeNextTransition();
 			const prevLen = prevHistoryLenRef.current;
 			prevHistoryLenRef.current = history.length;
 			const isFirstLoad = !displayedPassage;
 			const isRestart = history.length === 1 && historyIndex === 0 && prevLen > 1;
 			const isLoad = history.length > 1 && historyIndex === history.length - 1 && prevLen > 1 && Math.abs(history.length - prevLen) > 1;
 			if (navigationId === displayed.id) return;
+			const next = store.consumeNextTransition();
 			cancelTransition();
 			const targetPassage = storyData?.passages.get(currentPassage);
 			if (!targetPassage) {
@@ -20753,6 +20785,15 @@ function stopWithErrors(errors) {
 	throw new Error(`spindle: ${errors.length} validation error(s):\n${errors.join("\n")}`);
 }
 /**
+* The undeclared variables the passages refer to, with the macros known now:
+* the input macros that bind a variable (registered by author JS or
+* StoryInit) and the roles of their parameters decide what is a reference.
+*/
+function variableErrors(storyData, schema) {
+	const storeVarMacros = getMacroRegistry().filter((m) => m.storeVar).map((m) => m.name);
+	return validatePassages(storyData.passages, schema, storeVarMacros);
+}
+/**
 * The markup errors (malformed markup, unknown macros, syntax errors in
 * code) of the passages for which `only` holds, with the macros and widgets
 * known now.
@@ -20801,9 +20842,8 @@ function boot() {
 		throw new Error(`spindle: ${msg}`);
 	}
 	const schema = parseStoryVariables(storyVarsPassage.content);
-	const storeVarMacros = getMacroRegistry().filter((m) => m.storeVar).map((m) => m.name);
 	for (const name of blockWidgetNames(storyData.passages.values())) registerBlockMacro(name);
-	const errors = validatePassages(storyData.passages, schema, storeVarMacros);
+	const errors = variableErrors(storyData, schema);
 	errors.push(...markupErrors(storyData, (p) => p.name === "StoryInit"));
 	let transientDefaults = {};
 	const storyTransientsPassage = storyData.passages.get("StoryTransients");
@@ -20818,7 +20858,7 @@ function boot() {
 	useStoryStore.getState().init(storyData, defaults, transientDefaults);
 	enterRuntimePhase();
 	initializeStory(loadSession(storyData.ifid));
-	const markup = markupErrors(storyData, (p) => p.name !== "StoryInit");
+	const markup = [...variableErrors(storyData, schema), ...markupErrors(storyData, (p) => p.name !== "StoryInit")];
 	if (markup.length > 0) stopWithErrors(markup);
 	for (const [, passage] of storyData.passages) if (passage.tags.includes("widget")) {
 		const widgetAST = parseMarkup(passage.content);

package/package.json

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

package/src/class-registry.ts

@@ -110,11 +110,22 @@ const defineData = (target: object, key: string, value: unknown): void => {
   });
 };
 
+/**
+ * A reducer extracts string keys, so devalue never sees the symbol keys of
+ * the original object: refuse them here, as it does for a plain object.
+ */
+function refuseSymbolKeys(value: object): void {
+  if (Object.getOwnPropertySymbols(value).length > 0) {
+    throw new TypeError('spindle: Cannot save an object with symbol keys');
+  }
+}
+
 /**
  * Own enumerable keys of `value`, as a plain object; for an error also its
  * message, cause and (AggregateError) errors, which are not enumerable.
  */
 function ownData(value: object): Record<string, unknown> {
+  refuseSymbolKeys(value);
   const data: Record<string, unknown> = {};
   if (value instanceof Error) {
     for (const key of ERROR_HIDDEN_KEYS) {
@@ -163,6 +174,7 @@ function reducers(): Record<string, (value: unknown) => unknown> {
       }
       const keys = Object.keys(v);
       if (!keys.some(isEscapedOneCharKey)) return false;
+      refuseSymbolKeys(v);
       if (keys.includes('__proto__')) {
         throw new TypeError(
           'spindle: Cannot save a property named "__proto__"',

package/src/components/App.tsx

@@ -41,9 +41,7 @@ export function App() {
     </>
   );
 
-  return nobr ? (
-    <NobrContext.Provider value={true}>{content}</NobrContext.Provider>
-  ) : (
-    content
-  );
+  // One provider whatever `nobr` is: a changing tree shape would remount the
+  // passage and run its mount-only macros again
+  return <NobrContext.Provider value={nobr}>{content}</NobrContext.Provider>;
 }

package/src/components/macros/Computed.tsx

@@ -1,7 +1,7 @@
 import { useStoryStore } from '../../store';
 import { evaluate } from '../../expression';
 import { readState } from '../../execute-mutation';
-import { deepEqual } from '../../structural';
+import { deepEqualStrict } from '../../structural';
 import { defineMacro } from '../../define-macro';
 import { MacroError, logMacroError } from './MacroError';
 import { currentSourceLocation } from '../../utils/source-location';
@@ -67,7 +67,8 @@ function computeAndApply(
     return;
   }
 
-  if (!deepEqual(prevRef.current, newValue)) {
+  // Strict: a change of only the aliases inside the result is a change
+  if (!deepEqualStrict(prevRef.current, newValue)) {
     prevRef.current = newValue;
     if (isLocal) {
       try {

package/src/components/macros/PassageDisplay.tsx

@@ -131,9 +131,6 @@ defineMacro({
       const store = useStoryStore.getState();
       const { history, historyIndex, transitionConfig } = store;
 
-      // Always consume the next transition (one-shot), regardless of what we do
-      const next = store.consumeNextTransition();
-
       // Determine if this is a first load, restart, or save-load
       const prevLen = prevHistoryLenRef.current;
       prevHistoryLenRef.current = history.length;
@@ -152,6 +149,10 @@ defineMacro({
         return;
       }
 
+      // One-shot, used up by the first navigation, whatever we do with it
+      // (not by the initial render, which no navigation caused)
+      const next = store.consumeNextTransition();
+
       // Cancel any in-progress transition
       cancelTransition();
 

package/src/components/macros/SaveManager.tsx

@@ -127,9 +127,8 @@ export function SaveManagerContent() {
     const playthrough = resolvePlaythroughId();
     try {
       await saveWithHooks(undefined, undefined, beginSave, async (payload) => {
-        const ptId = await playthrough;
-        if (!ptId) throw new Error('No playthrough');
-        return createSave(ifid, ptId, payload);
+        // Queued now, in call order with other storage operations
+        return createSave(ifid, playthrough, payload);
       });
       showStatus('Save created');
       await refresh();
@@ -143,8 +142,7 @@ export function SaveManagerContent() {
     try {
       await saveWithHooks(undefined, undefined, beginSave, async (payload) => {
         // Only the current playthrough's saves offer "Save Here"
-        const ptId = (await playthrough) || undefined;
-        if (!(await overwriteSave(saveId, payload, undefined, ptId))) {
+        if (!(await overwriteSave(saveId, payload, undefined, playthrough))) {
           throw new Error('Save not found');
         }
       });

package/src/execute-mutation.ts

@@ -381,9 +381,9 @@ function relink(
 function cloneNamespaces(from: VariableNamespaces): VariableNamespaces {
   const seen = new Map<object, object>();
   return {
-    variables: deepClone(from.variables, { seen }),
-    temporary: deepClone(from.temporary, { seen }),
-    transient: deepClone(from.transient, { seen }),
+    variables: deepClone(from.variables, { keepUnregistered: true, seen }),
+    temporary: deepClone(from.temporary, { keepUnregistered: true, seen }),
+    transient: deepClone(from.transient, { keepUnregistered: true, seen }),
   };
 }
 

package/src/index.tsx

@@ -62,6 +62,21 @@ function stopWithErrors(errors: string[]): never {
   );
 }
 
+/**
+ * The undeclared variables the passages refer to, with the macros known now:
+ * the input macros that bind a variable (registered by author JS or
+ * StoryInit) and the roles of their parameters decide what is a reference.
+ */
+function variableErrors(
+  storyData: StoryData,
+  schema: Parameters<typeof validatePassages>[1],
+): string[] {
+  const storeVarMacros = getMacroRegistry()
+    .filter((m) => m.storeVar)
+    .map((m) => m.name);
+  return validatePassages(storyData.passages, schema, storeVarMacros);
+}
+
 /**
  * The markup errors (malformed markup, unknown macros, syntax errors in
  * code) of the passages for which `only` holds, with the macros and widgets
@@ -134,10 +149,6 @@ export function boot() {
   }
 
   const schema = parseStoryVariables(storyVarsPassage.content);
-  // Include input macros registered by author JS, which ran above.
-  const storeVarMacros = getMacroRegistry()
-    .filter((m) => m.storeVar)
-    .map((m) => m.name);
   // Pass 1: Register the block widgets as block macros BEFORE any passage
   // is parsed (validation and StoryInit included), so that passages
   // invoking block widgets and widget bodies using other block widgets
@@ -146,7 +157,7 @@ export function boot() {
     registerBlockMacro(name);
   }
 
-  const errors = validatePassages(storyData.passages, schema, storeVarMacros);
+  const errors = variableErrors(storyData, schema);
   // StoryInit's markup must be valid before it runs; the other passages are
   // validated once it has run, as it may define macros (see below).
   errors.push(...markupErrors(storyData, (p) => p.name === 'StoryInit'));
@@ -186,8 +197,12 @@ export function boot() {
   // storyinit after all state is settled (defaults + StoryInit + session)
   initializeStory(loadSession(storyData.ifid));
 
-  // Every other passage's markup, now that StoryInit may have defined macros
-  const markup = markupErrors(storyData, (p) => p.name !== 'StoryInit');
+  // Every other passage's markup, now that StoryInit may have defined macros;
+  // so are the variable references, which macros' parameters decide
+  const markup = [
+    ...variableErrors(storyData, schema),
+    ...markupErrors(storyData, (p) => p.name !== 'StoryInit'),
+  ];
   if (markup.length > 0) stopWithErrors(markup);
 
   // Pass 2: Full parse and register widgets from passages tagged "widget"

package/src/saves/save-manager.ts

@@ -291,10 +291,12 @@ export const createSave = queued(createSaveNow);
 
 async function createSaveNow(
   ifid: string,
-  playthroughId: string,
+  playthroughPromise: string | PromiseLike<string>,
   payload: SavePayload,
   custom: Record<string, unknown> = {},
 ): Promise<SaveRecord> {
+  const playthroughId = await playthroughPromise;
+  if (!playthroughId) throw new Error('No playthrough');
   const now = new Date().toISOString();
   const meta: SaveMeta = {
     id: randomUUID(),
@@ -313,6 +315,10 @@ async function createSaveNow(
 }
 
 /**
+ * A playthrough passed as a promise (see resolvePlaythroughId) is awaited
+ * inside the operation, so the call takes its place in the order of
+ * operations when it is made.
+ *
  * Replace the payload of an existing save, keeping its ID and `createdAt`.
  * Pass the current `playthroughId` when the new payload comes from the
  * running game: the save then holds that playthrough's state, so it is
@@ -333,8 +339,9 @@ async function overwriteSaveNow(
   saveId: string,
   payload: SavePayload,
   custom?: Record<string, unknown>,
-  playthroughId?: string,
+  playthroughPromise?: string | PromiseLike<string>,
 ): Promise<SaveRecord | undefined> {
+  const playthroughId = await playthroughPromise;
   const backend = await getBackend();
   const existing = await backend.getSave(saveId);
   if (!existing) return undefined;

package/src/structural.ts

@@ -674,17 +674,20 @@ export function underChange(
 
 /**
  * The segment standing for the entry `index` of a Map or Set in a path, or
- * for the `cause` or `errors` of an Error ('c', 'e').
+ * for the `cause` or `errors` of an Error ('c', 'e'), or for the buffer a
+ * typed array or DataView views ('b').
  */
-const entryKey = (kind: 'k' | 'v' | 's' | 'c' | 'e', index: number): string =>
-  `\0${kind}${index}`;
+const entryKey = (
+  kind: 'k' | 'v' | 's' | 'c' | 'e' | 'b',
+  index: number,
+): string => `\0${kind}${index}`;
 
 export const isEntryKey = (segment: string): boolean =>
   segment.startsWith('\0');
 
 /**
- * What a Map, Set or Error holds in place of properties (keys and values,
- * members, `cause` and `errors`), each with the segment standing for it in
+ * What a Map, Set, Error or view holds in place of properties (keys and
+ * values, members, `cause` and `errors`, the buffer), each with the segment standing for it in
  * a path (see entryKey); undefined for any other value.
  */
 function entryChildren(value: object): [string, unknown][] | undefined {
@@ -707,6 +710,9 @@ function entryChildren(value: object): [string, unknown][] | undefined {
         ]);
       }
     }
+  } else if (ArrayBuffer.isView(value)) {
+    // Views of one buffer share it, which an alias of the buffer changes
+    children.push([entryKey('b', 0), value.buffer]);
   } else {
     return undefined;
   }