squiffy-runtime 6.0.1 → 7.0.0-beta.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets.d.ts +3 -0
- package/dist/assets.test.d.ts +1 -0
- package/dist/classes.test.d.ts +1 -0
- package/dist/confirmDialog.d.ts +8 -0
- package/dist/events.d.ts +16 -0
- package/dist/every.d.ts +12 -0
- package/dist/every.test.d.ts +1 -0
- package/dist/helpers.test.d.ts +1 -0
- package/dist/numbers.d.ts +3 -0
- package/dist/panels.d.ts +14 -0
- package/dist/panels.test.d.ts +1 -0
- package/dist/paths.d.ts +15 -0
- package/dist/paths.test.d.ts +1 -0
- package/dist/persistent.test.d.ts +1 -0
- package/dist/playerSettings.d.ts +17 -0
- package/dist/pluginManager.d.ts +2 -1
- package/dist/preview-host.d.ts +33 -0
- package/dist/preview-host.js +125 -0
- package/dist/preview-host.js.map +7 -0
- package/dist/preview-host.test.d.ts +1 -0
- package/dist/preview-html.d.ts +2 -0
- package/dist/preview-html.js +2 -0
- package/dist/preview-protocol.d.ts +69 -0
- package/dist/preview.d.ts +15 -0
- package/dist/preview.main.d.ts +1 -0
- package/dist/preview.test.d.ts +1 -0
- package/dist/saveSlots.d.ts +16 -0
- package/dist/saves.test.d.ts +1 -0
- package/dist/savesDialog.d.ts +43 -0
- package/dist/savesDialog.test.d.ts +1 -0
- package/dist/scripts.test.d.ts +1 -0
- package/dist/settings.test.d.ts +1 -0
- package/dist/settingsDialog.d.ts +17 -0
- package/dist/skill.test.d.ts +1 -0
- package/dist/sound.d.ts +35 -0
- package/dist/sound.test.d.ts +1 -0
- package/dist/squiffy.page.css +155 -0
- package/dist/squiffy.preview.html +1631 -0
- package/dist/squiffy.runtime.css +1123 -20
- package/dist/squiffy.runtime.d.ts +13 -1
- package/dist/squiffy.runtime.global.js +146 -76
- package/dist/squiffy.runtime.global.js.map +1 -1
- package/dist/squiffy.runtime.js +7105 -4681
- package/dist/squiffy.runtime.js.map +1 -1
- package/dist/state.d.ts +17 -0
- package/dist/storyLists.d.ts +4 -0
- package/dist/storyLists.test.d.ts +1 -0
- package/dist/style.test.d.ts +1 -0
- package/dist/textProcessor.d.ts +27 -0
- package/dist/transitions.test.d.ts +1 -0
- package/dist/types.d.ts +137 -1
- package/dist/types.plugins.d.ts +2 -0
- package/dist/uiLinks.test.d.ts +1 -0
- package/dist/utils.d.ts +2 -1
- package/dist/utils.test.d.ts +1 -0
- package/package.json +25 -11
- package/src/__snapshots__/squiffy.runtime.test.ts.snap +22 -22
- package/src/animation.test.ts +44 -0
- package/src/animation.ts +9 -5
- package/src/assets.test.ts +225 -0
- package/src/assets.ts +92 -0
- package/src/classes.test.ts +201 -0
- package/src/confirmDialog.ts +66 -0
- package/src/events.ts +20 -0
- package/src/every.test.ts +25 -0
- package/src/every.ts +94 -0
- package/src/helpers.test.ts +34 -0
- package/src/numbers.ts +21 -0
- package/src/panels.test.ts +225 -0
- package/src/panels.ts +187 -0
- package/src/paths.test.ts +66 -0
- package/src/paths.ts +155 -0
- package/src/persistent.test.ts +155 -0
- package/src/playerSettings.ts +128 -0
- package/src/pluginManager.ts +6 -1
- package/src/plugins/animate.ts +34 -9
- package/src/plugins/live.ts +18 -5
- package/src/plugins/plugins.test.ts +93 -6
- package/src/plugins/replaceLabel.ts +7 -3
- package/src/preview-host.test.ts +171 -0
- package/src/preview-host.ts +190 -0
- package/src/preview-protocol.ts +79 -0
- package/src/preview.main.ts +34 -0
- package/src/preview.test.ts +367 -0
- package/src/preview.ts +331 -0
- package/src/saveSlots.ts +159 -0
- package/src/saves.test.ts +199 -0
- package/src/savesDialog.test.ts +290 -0
- package/src/savesDialog.ts +499 -0
- package/src/scripts.test.ts +130 -0
- package/src/settings.test.ts +233 -0
- package/src/settingsDialog.ts +160 -0
- package/src/skill.test.ts +67 -0
- package/src/sound.test.ts +273 -0
- package/src/sound.ts +207 -0
- package/src/squiffy.page.css +155 -0
- package/src/squiffy.runtime.css +1123 -20
- package/src/squiffy.runtime.test.ts +2806 -44
- package/src/squiffy.runtime.ts +1130 -64
- package/src/state.ts +172 -11
- package/src/storyLists.test.ts +134 -0
- package/src/storyLists.ts +57 -0
- package/src/style.test.ts +89 -0
- package/src/textProcessor.ts +739 -58
- package/src/transitions.test.ts +343 -0
- package/src/types.plugins.ts +7 -0
- package/src/types.ts +226 -2
- package/src/uiLinks.test.ts +156 -0
- package/src/updater.ts +26 -8
- package/src/utils.test.ts +60 -0
- package/src/utils.ts +46 -14
- package/vite.config.ts +3 -4
- package/vite.preview.config.ts +83 -0
- package/dist/infixExpressions.d.ts +0 -2
- package/src/infixExpressions.test.ts +0 -187
- package/src/infixExpressions.ts +0 -323
- /package/dist/{infixExpressions.test.d.ts → animation.test.d.ts} +0 -0
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
import { expect, test, beforeEach, afterEach, beforeAll, vi } from "vitest";
|
|
2
|
+
import globalJsdom from "global-jsdom";
|
|
3
|
+
import { init } from "./squiffy.runtime.js";
|
|
4
|
+
import { compile as squiffyCompile } from "squiffy-compiler";
|
|
5
|
+
import { createSavesDialog, formatSaveTime } from "./savesDialog.js";
|
|
6
|
+
import { memorySaveSlots, type SaveSlots } from "./saveSlots.js";
|
|
7
|
+
import type { SquiffyApi } from "./types.js";
|
|
8
|
+
|
|
9
|
+
beforeAll(() => {
|
|
10
|
+
vi.stubGlobal("crypto", { randomUUID: () => "00000000-0000-0000-0000-000000000000" });
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
let cleanup: () => void;
|
|
14
|
+
|
|
15
|
+
beforeEach(() => {
|
|
16
|
+
cleanup = globalJsdom("<!DOCTYPE html><html><head><title>My Story</title></head><body><div id=\"squiffy\"></div></body></html>");
|
|
17
|
+
// jsdom has no showModal()
|
|
18
|
+
window.HTMLDialogElement.prototype.showModal = function () { this.setAttribute("open", ""); };
|
|
19
|
+
window.HTMLDialogElement.prototype.close = function () { this.removeAttribute("open"); };
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
afterEach(() => {
|
|
23
|
+
localStorage.clear();
|
|
24
|
+
cleanup();
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
const script = `[[a]]:
|
|
28
|
+
Welcome to the start. Go to [[b]].
|
|
29
|
+
|
|
30
|
+
[[b]]:
|
|
31
|
+
You are in b. Go to [[c]].
|
|
32
|
+
|
|
33
|
+
[[c]]:
|
|
34
|
+
You are in c.`;
|
|
35
|
+
|
|
36
|
+
const start = async () => {
|
|
37
|
+
const element = document.getElementById("squiffy")!;
|
|
38
|
+
const result = await squiffyCompile({ script, projectId: "story-1" });
|
|
39
|
+
if (!result.success) throw new Error("Compile failed");
|
|
40
|
+
const js = result.output.js.map(lines => new Function("squiffy", "get", "set", lines.join("\n")));
|
|
41
|
+
const api = await init({ element, story: { js: js as any, ...result.output.story }, persist: false });
|
|
42
|
+
await api.begin();
|
|
43
|
+
return { api, element };
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
const click = async (api: SquiffyApi, element: HTMLElement, text: string) => {
|
|
47
|
+
const link = [...element.querySelectorAll<HTMLElement>("a.squiffy-link")]
|
|
48
|
+
.filter(l => l.textContent === text && !l.classList.contains("disabled")).pop()!;
|
|
49
|
+
expect(await api.clickLink(link)).toBe(true);
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
// Lets the dialog's async handlers finish
|
|
53
|
+
const settle = () => new Promise(resolve => setTimeout(resolve, 0));
|
|
54
|
+
|
|
55
|
+
const setup = async (slots: SaveSlots = memorySaveSlots()) => {
|
|
56
|
+
const { api, element } = await start();
|
|
57
|
+
const dialog = createSavesDialog(api, { slots });
|
|
58
|
+
await dialog.open();
|
|
59
|
+
const el = dialog.element;
|
|
60
|
+
const q = <T extends HTMLElement = HTMLElement>(selector: string) => el.querySelector<T>(selector)!;
|
|
61
|
+
const rows = () => [...el.querySelectorAll<HTMLElement>(".squiffy-saves-row")].map(row => ({
|
|
62
|
+
title: row.querySelector(".squiffy-saves-title")?.textContent,
|
|
63
|
+
meta: row.querySelector(".squiffy-saves-meta")?.textContent ?? "",
|
|
64
|
+
}));
|
|
65
|
+
const save = async (name = "") => {
|
|
66
|
+
q<HTMLInputElement>("form input").value = name;
|
|
67
|
+
q<HTMLFormElement>("form").requestSubmit();
|
|
68
|
+
await settle();
|
|
69
|
+
};
|
|
70
|
+
const row = (index: number) => el.querySelectorAll<HTMLElement>(".squiffy-saves-row")[index];
|
|
71
|
+
const pick = async (index: number, action: string) => {
|
|
72
|
+
row(index).querySelector<HTMLElement>(`[data-action=${action}]`)!.click();
|
|
73
|
+
await settle();
|
|
74
|
+
};
|
|
75
|
+
const answer = async (yes: boolean) => {
|
|
76
|
+
el.querySelector<HTMLElement>(`.squiffy-saves-confirm [data-answer=${yes ? "yes" : "no"}]`)!.click();
|
|
77
|
+
await settle();
|
|
78
|
+
await settle();
|
|
79
|
+
};
|
|
80
|
+
return { api, element, dialog, el, q, rows, save, row, pick, answer, slots };
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
test("it opens with no saves, on the name box", async () => {
|
|
84
|
+
const { el, q } = await setup();
|
|
85
|
+
expect(el.open).toBe(true);
|
|
86
|
+
expect(q("h2").textContent).toBe("Saved games");
|
|
87
|
+
expect(q(".squiffy-saves-empty").textContent).toBe("No saved games yet.");
|
|
88
|
+
expect(document.activeElement).toBe(q("form input"));
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
test("saving adds a save, titled by its name or the text the player was reading, newest first", async () => {
|
|
92
|
+
const { api, element, rows, save } = await setup();
|
|
93
|
+
await save();
|
|
94
|
+
await click(api, element, "b");
|
|
95
|
+
await save(" Before c ");
|
|
96
|
+
expect(rows()).toEqual([
|
|
97
|
+
{ title: "Before c", meta: expect.stringMatching(/^Today, .* · You are in b\. Go to c\.$/) },
|
|
98
|
+
{ title: "Welcome to the start. Go to b.", meta: expect.stringMatching(/^Today, /) },
|
|
99
|
+
]);
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
test("loading a save asks first if there's progress since the last save, then closes", async () => {
|
|
103
|
+
const { api, element, el, save, pick, answer } = await setup();
|
|
104
|
+
await save();
|
|
105
|
+
await click(api, element, "b");
|
|
106
|
+
|
|
107
|
+
await pick(0, "load");
|
|
108
|
+
expect(el.querySelector(".squiffy-saves-confirm p")!.textContent)
|
|
109
|
+
.toBe("Load \"Welcome to the start. Go to b.\"? You'll lose anything you've done since you last saved.");
|
|
110
|
+
await answer(false);
|
|
111
|
+
expect(api.get("_section")).toBe("b");
|
|
112
|
+
expect(el.open).toBe(true);
|
|
113
|
+
|
|
114
|
+
await pick(0, "load");
|
|
115
|
+
await answer(true);
|
|
116
|
+
expect(api.get("_section")).toBe("a");
|
|
117
|
+
expect(el.open).toBe(false);
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
test("loading straight after saving doesn't ask", async () => {
|
|
121
|
+
const { api, element, el, save, pick } = await setup();
|
|
122
|
+
await click(api, element, "b");
|
|
123
|
+
await save();
|
|
124
|
+
await pick(0, "load");
|
|
125
|
+
await settle();
|
|
126
|
+
expect(el.querySelector(".squiffy-saves-confirm")).toBeNull();
|
|
127
|
+
expect(el.open).toBe(false);
|
|
128
|
+
expect(api.get("_section")).toBe("b");
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
test("a dialog made before the story begins still asks before losing a restored game", async () => {
|
|
132
|
+
const element = document.getElementById("squiffy")!;
|
|
133
|
+
const result = await squiffyCompile({ script, projectId: "story-1" });
|
|
134
|
+
if (!result.success) throw new Error("Compile failed");
|
|
135
|
+
const js = result.output.js.map(lines => new Function("squiffy", "get", "set", lines.join("\n")));
|
|
136
|
+
const story = { js: js as any, ...result.output.story };
|
|
137
|
+
const first = await init({ element, story, persist: true });
|
|
138
|
+
await first.begin();
|
|
139
|
+
await click(first, element, "b");
|
|
140
|
+
|
|
141
|
+
// A new page: the dialog is made first, as the published page does
|
|
142
|
+
element.innerHTML = "";
|
|
143
|
+
const api = await init({ element, story, persist: true });
|
|
144
|
+
const slots = memorySaveSlots();
|
|
145
|
+
await slots.add(api.getSave(), "Start");
|
|
146
|
+
const dialog = createSavesDialog(api, { slots });
|
|
147
|
+
await api.begin();
|
|
148
|
+
await dialog.open();
|
|
149
|
+
dialog.element.querySelector<HTMLElement>("[data-action=load]")!.click();
|
|
150
|
+
await settle();
|
|
151
|
+
expect(dialog.element.querySelector(".squiffy-saves-confirm")).not.toBeNull();
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
test("a save's menu opens and closes, and Escape closes it before the dialog", async () => {
|
|
155
|
+
const { el, save, row, pick } = await setup();
|
|
156
|
+
await save();
|
|
157
|
+
const button = row(0).querySelector<HTMLElement>("[data-action=options]")!;
|
|
158
|
+
expect(button.getAttribute("aria-label")).toBe("Options for Welcome to the start. Go to b.");
|
|
159
|
+
const menu = row(0).querySelector<HTMLElement>("[role=menu]")!;
|
|
160
|
+
expect(menu.hidden).toBe(true);
|
|
161
|
+
|
|
162
|
+
await pick(0, "options");
|
|
163
|
+
expect(menu.hidden).toBe(false);
|
|
164
|
+
expect(button.getAttribute("aria-expanded")).toBe("true");
|
|
165
|
+
expect(document.activeElement?.textContent).toBe("Overwrite");
|
|
166
|
+
menu.dispatchEvent(new window.KeyboardEvent("keydown", { key: "ArrowDown", bubbles: true }));
|
|
167
|
+
expect(document.activeElement?.textContent).toBe("Rename");
|
|
168
|
+
|
|
169
|
+
const cancel = new window.Event("cancel", { cancelable: true });
|
|
170
|
+
el.dispatchEvent(cancel);
|
|
171
|
+
expect(cancel.defaultPrevented).toBe(true);
|
|
172
|
+
expect(menu.hidden).toBe(true);
|
|
173
|
+
expect(document.activeElement).toBe(button);
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
test("overwrite replaces a save with the game as it is now, keeping its name", async () => {
|
|
177
|
+
const { api, element, rows, save, pick, answer } = await setup();
|
|
178
|
+
await save("Mine");
|
|
179
|
+
await click(api, element, "b");
|
|
180
|
+
await pick(0, "overwrite");
|
|
181
|
+
await answer(true);
|
|
182
|
+
expect(rows()).toEqual([{ title: "Mine", meta: expect.stringContaining("You are in b.") }]);
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
test("rename changes a save's name, and an empty name makes it unnamed again", async () => {
|
|
186
|
+
const { el, rows, save, row, pick } = await setup();
|
|
187
|
+
await save("Old");
|
|
188
|
+
await pick(0, "rename");
|
|
189
|
+
let input = row(0).querySelector<HTMLInputElement>("input")!;
|
|
190
|
+
expect(input.value).toBe("Old");
|
|
191
|
+
input.value = "New";
|
|
192
|
+
input.dispatchEvent(new window.KeyboardEvent("keydown", { key: "Enter" }));
|
|
193
|
+
await settle();
|
|
194
|
+
await settle();
|
|
195
|
+
expect(rows()[0].title).toBe("New");
|
|
196
|
+
|
|
197
|
+
await pick(0, "rename");
|
|
198
|
+
input = row(0).querySelector<HTMLInputElement>("input")!;
|
|
199
|
+
input.value = " ";
|
|
200
|
+
input.dispatchEvent(new window.KeyboardEvent("keydown", { key: "Enter" }));
|
|
201
|
+
await settle();
|
|
202
|
+
await settle();
|
|
203
|
+
expect(rows()[0].title).toBe("Welcome to the start. Go to b.");
|
|
204
|
+
expect(el.querySelector(".squiffy-saves-rename")).toBeNull();
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
test("delete asks first", async () => {
|
|
208
|
+
const { el, rows, save, pick, answer } = await setup();
|
|
209
|
+
await save("Mine");
|
|
210
|
+
await pick(0, "delete");
|
|
211
|
+
expect(el.querySelector(".squiffy-saves-confirm p")!.textContent).toBe("Delete \"Mine\"? This can't be undone.");
|
|
212
|
+
await answer(false);
|
|
213
|
+
expect(rows()).toHaveLength(1);
|
|
214
|
+
await pick(0, "delete");
|
|
215
|
+
await answer(true);
|
|
216
|
+
expect(rows()).toHaveLength(0);
|
|
217
|
+
});
|
|
218
|
+
|
|
219
|
+
test("Save to file downloads the game as a .squiffy-save named after the page", async () => {
|
|
220
|
+
const { api, q } = await setup();
|
|
221
|
+
const blobs: Blob[] = [];
|
|
222
|
+
URL.createObjectURL = (blob: Blob) => { blobs.push(blob); return "blob:x"; };
|
|
223
|
+
URL.revokeObjectURL = () => {};
|
|
224
|
+
let downloaded = "";
|
|
225
|
+
window.HTMLAnchorElement.prototype.click = function () { downloaded = this.download; };
|
|
226
|
+
q("[data-save-to-file]").click();
|
|
227
|
+
expect(downloaded).toBe("My Story.squiffy-save");
|
|
228
|
+
expect(JSON.parse(await blobs[0].text())).toEqual({ ...api.getSave(), savedAt: expect.any(String) });
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
test("Load from file loads a save, and says so when the file isn't one or is for another story", async () => {
|
|
232
|
+
const { api, element, el, q } = await setup();
|
|
233
|
+
await click(api, element, "b");
|
|
234
|
+
const save = api.getSave();
|
|
235
|
+
await click(api, element, "c");
|
|
236
|
+
|
|
237
|
+
const input = q<HTMLInputElement>("input[type=file]");
|
|
238
|
+
const choose = async (text: string) => {
|
|
239
|
+
Object.defineProperty(input, "files", { configurable: true, value: [new window.File([text], "game.squiffy-save")] });
|
|
240
|
+
input.dispatchEvent(new window.Event("change"));
|
|
241
|
+
await settle();
|
|
242
|
+
await settle();
|
|
243
|
+
};
|
|
244
|
+
|
|
245
|
+
await choose("not json");
|
|
246
|
+
expect(q(".squiffy-saves-error").hidden).toBe(false);
|
|
247
|
+
expect(q(".squiffy-saves-error").textContent).toBe("This file isn't a saved game.");
|
|
248
|
+
|
|
249
|
+
await choose(JSON.stringify({ ...save, storyId: "another" }));
|
|
250
|
+
// Progress since the last save, so it asks first
|
|
251
|
+
el.querySelector<HTMLElement>(".squiffy-saves-confirm [data-answer=yes]")!.click();
|
|
252
|
+
await settle();
|
|
253
|
+
await settle();
|
|
254
|
+
expect(q(".squiffy-saves-error").textContent).toBe("This saved game is for a different story.");
|
|
255
|
+
expect(api.get("_section")).toBe("c");
|
|
256
|
+
|
|
257
|
+
await choose(JSON.stringify(save));
|
|
258
|
+
el.querySelector<HTMLElement>(".squiffy-saves-confirm [data-answer=yes]")!.click();
|
|
259
|
+
await settle();
|
|
260
|
+
await settle();
|
|
261
|
+
expect(api.get("_section")).toBe("b");
|
|
262
|
+
expect(el.open).toBe(false);
|
|
263
|
+
});
|
|
264
|
+
|
|
265
|
+
test("a store that fails says the game couldn't be saved", async () => {
|
|
266
|
+
const slots = memorySaveSlots();
|
|
267
|
+
slots.add = () => Promise.reject(new Error("full"));
|
|
268
|
+
const { q, save, rows } = await setup(slots);
|
|
269
|
+
await save();
|
|
270
|
+
expect(q(".squiffy-saves-error").textContent).toBe("The game couldn't be saved. Try Save to file instead.");
|
|
271
|
+
expect(rows()).toHaveLength(0);
|
|
272
|
+
});
|
|
273
|
+
|
|
274
|
+
test("the text can be translated", async () => {
|
|
275
|
+
const { api } = await start();
|
|
276
|
+
const dialog = createSavesDialog(api, { slots: memorySaveSlots(), strings: { saves: "Parties sauvegardées", save: "Sauvegarder", unknown: "x" } });
|
|
277
|
+
await dialog.open();
|
|
278
|
+
expect(dialog.element.querySelector("h2")!.textContent).toBe("Parties sauvegardées");
|
|
279
|
+
expect(dialog.element.querySelector("form button")!.textContent).toBe("Sauvegarder");
|
|
280
|
+
expect(dialog.element.querySelector(".squiffy-saves-empty")!.textContent).toBe("No saved games yet.");
|
|
281
|
+
});
|
|
282
|
+
|
|
283
|
+
test("formatSaveTime", () => {
|
|
284
|
+
const now = new Date(2026, 10, 18, 20, 0);
|
|
285
|
+
expect(formatSaveTime(new Date(2026, 10, 18, 9, 5).toISOString(), undefined, now)).toMatch(/^Today, /);
|
|
286
|
+
expect(formatSaveTime(new Date(2026, 10, 17, 9, 5).toISOString(), undefined, now)).toMatch(/^Yesterday, /);
|
|
287
|
+
expect(formatSaveTime(new Date(2026, 10, 1, 9, 5).toISOString(), undefined, now)).toMatch(/^1 Nov|^Nov 1/);
|
|
288
|
+
expect(formatSaveTime(new Date(2025, 10, 1, 9, 5).toISOString(), undefined, now)).toContain("2025");
|
|
289
|
+
expect(formatSaveTime("nonsense")).toBe("");
|
|
290
|
+
});
|