squiffy-runtime 7.0.0-beta.4 → 7.0.0-beta.5
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/preview-html.js +1 -1
- package/dist/squiffy.preview.html +67 -60
- package/dist/squiffy.runtime.css +9 -2
- package/dist/squiffy.runtime.global.js +58 -58
- package/dist/squiffy.runtime.global.js.map +1 -1
- package/dist/squiffy.runtime.js +2659 -2593
- package/dist/squiffy.runtime.js.map +1 -1
- package/dist/state.d.ts +2 -0
- package/dist/textProcessor.d.ts +4 -0
- package/dist/types.d.ts +2 -0
- package/package.json +3 -3
- package/src/__snapshots__/squiffy.runtime.test.ts.snap +21 -21
- package/src/plugins/plugins.test.ts +42 -0
- package/src/plugins/replaceLabel.ts +6 -2
- package/src/preview.test.ts +3 -0
- package/src/squiffy.runtime.css +9 -2
- package/src/squiffy.runtime.test.ts +515 -0
- package/src/squiffy.runtime.ts +95 -7
- package/src/state.ts +16 -0
- package/src/textProcessor.ts +26 -0
- package/src/types.ts +3 -0
package/dist/state.d.ts
CHANGED
package/dist/textProcessor.d.ts
CHANGED
|
@@ -8,6 +8,10 @@ export declare class TextProcessor {
|
|
|
8
8
|
handlebars: typeof Handlebars;
|
|
9
9
|
constructor(story: () => Story, state: State, currentSection: () => Section);
|
|
10
10
|
evaluate(expression: string): unknown;
|
|
11
|
+
goto: {
|
|
12
|
+
section: string;
|
|
13
|
+
after: number;
|
|
14
|
+
} | null;
|
|
11
15
|
private expressionCache;
|
|
12
16
|
private evaluated;
|
|
13
17
|
process(text: string, inline: boolean): string;
|
package/dist/types.d.ts
CHANGED
|
@@ -31,6 +31,7 @@ export interface SquiffyApi {
|
|
|
31
31
|
clickLink: (link: HTMLElement) => Promise<boolean>;
|
|
32
32
|
update: (story: Story) => void;
|
|
33
33
|
goBack: () => void;
|
|
34
|
+
canGoBack: () => boolean;
|
|
34
35
|
on<E extends keyof SquiffyEventMap>(event: E, handler: SquiffyEventHandler<E>): () => void;
|
|
35
36
|
off<E extends keyof SquiffyEventMap>(event: E, handler: SquiffyEventHandler<E>): void;
|
|
36
37
|
once<E extends keyof SquiffyEventMap>(event: E, handler: SquiffyEventHandler<E>): () => void;
|
|
@@ -44,6 +45,7 @@ interface SquiffyJsFunctionApi {
|
|
|
44
45
|
story: {
|
|
45
46
|
go: (section: string) => void;
|
|
46
47
|
seen: (sectionOrPassage: string) => boolean;
|
|
48
|
+
visits: (sectionOrPassage: string) => number;
|
|
47
49
|
};
|
|
48
50
|
}
|
|
49
51
|
export interface Story {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "squiffy-runtime",
|
|
3
|
-
"version": "7.0.0-beta.
|
|
3
|
+
"version": "7.0.0-beta.5",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/textadventures/squiffy.git",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"esbuild": "^0.28.2",
|
|
50
50
|
"global-jsdom": "^31.0.0",
|
|
51
51
|
"jsdom": "^31.0.1",
|
|
52
|
-
"squiffy-compiler": "^7.0.0-beta.
|
|
52
|
+
"squiffy-compiler": "^7.0.0-beta.5",
|
|
53
53
|
"typescript": "^6.0.3",
|
|
54
54
|
"vite": "^8.3.8",
|
|
55
55
|
"vite-plugin-dts": "^5.1.2"
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
"handlebars": "^4.7.10",
|
|
60
60
|
"marked": "^18.2.0"
|
|
61
61
|
},
|
|
62
|
-
"gitHead": "
|
|
62
|
+
"gitHead": "9495ea44822999ad3e5c8fa305a88c5f5e43f1d8"
|
|
63
63
|
}
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
exports[`"Hello world" script should run 1`] = `
|
|
4
4
|
"
|
|
5
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Hello world</p></div></div></div></div>"
|
|
5
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Hello world</p></div></div></div></div>"
|
|
6
6
|
`;
|
|
7
7
|
|
|
8
8
|
exports[`Click a passage link 1`] = `
|
|
9
9
|
"
|
|
10
|
-
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
10
|
+
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
11
11
|
<p>This is <a href="http://textadventures.co.uk">a website link</a>.</p>
|
|
12
12
|
<p>This should be <a class="squiffy-link link-passage" data-passage="passage" role="link" tabindex="0">a link to a passage</a>. Here's <a class="squiffy-link link-passage" data-passage="passage2" role="link" tabindex="0">another one</a>.</p>
|
|
13
13
|
<p>You don't need to specify a name - for example, this <a class="squiffy-link link-passage" data-passage="link" role="link" tabindex="0">link</a> and this <a class="squiffy-link link-section" data-section="section" role="link" tabindex="0">section</a>.</p>
|
|
@@ -19,21 +19,21 @@ exports[`Click a passage link 1`] = `
|
|
|
19
19
|
|
|
20
20
|
exports[`Click a passage link 2`] = `
|
|
21
21
|
"
|
|
22
|
-
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
22
|
+
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
23
23
|
<p>This is <a href="http://textadventures.co.uk">a website link</a>.</p>
|
|
24
24
|
<p>This should be <a class="squiffy-link link-passage disabled" data-passage="passage" role="link" tabindex="-1">a link to a passage</a>. Here's <a class="squiffy-link link-passage" data-passage="passage2" role="link" tabindex="0">another one</a>.</p>
|
|
25
25
|
<p>You don't need to specify a name - for example, this <a class="squiffy-link link-passage" data-passage="link" role="link" tabindex="0">link</a> and this <a class="squiffy-link link-section" data-section="section" role="link" tabindex="0">section</a>.</p>
|
|
26
26
|
<p>And this goes to the <a class="squiffy-link link-section" data-section="section2" role="link" tabindex="0">next section</a>.</p>
|
|
27
27
|
<p>This line has links to <a class="squiffy-link link-section" data-section="section 3" role="link" tabindex="0">section 3</a> and <a class="squiffy-link link-section" data-section="section four" role="link" tabindex="0">section 4</a>.</p>
|
|
28
28
|
<p>This line has links to <a class="squiffy-link link-passage" data-passage="passage 3" role="link" tabindex="0">passage 3</a> and <a class="squiffy-link link-passage" data-passage="passage four" role="link" tabindex="0">passage 4</a>.</p>
|
|
29
|
-
<p>Oh look - <a class="squiffy-link link-passage" data-passage="it's a passage with an apostrophe" role="link" tabindex="0">it's a passage with an apostrophe</a>.</p></div></div><div class="squiffy-output-passage" data-passage="passage" data-undo="{"_turncount":0,"_seen_sections":["Introduction"]}"><div class="squiffy-output-block"><div data-source="[[Introduction]][passage]"><p>Here's some text for the passage.</p>
|
|
29
|
+
<p>Oh look - <a class="squiffy-link link-passage" data-passage="it's a passage with an apostrophe" role="link" tabindex="0">it's a passage with an apostrophe</a>.</p></div></div><div class="squiffy-output-passage" data-passage="passage" data-undo="{"turns":0,"_turncount":0,"_visits":{"Introduction":1},"_seen_sections":["Introduction"]}"><div class="squiffy-output-block"><div data-source="[[Introduction]][passage]"><p>Here's some text for the passage.</p>
|
|
30
30
|
<p>This passage has a picture in it. It's by <a href="https://unsplash.com/@lmablankers?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Lars Blankers</a> on <a href="https://unsplash.com/photos/brown-potato-lot-B0s3Xndk6tw?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Unsplash</a>.</p>
|
|
31
31
|
<p><img src="lars-blankers-B0s3Xndk6tw-unsplash.jpg" alt=""></p></div></div></div></div></div>"
|
|
32
32
|
`;
|
|
33
33
|
|
|
34
34
|
exports[`Click a passage link and go back 1`] = `
|
|
35
35
|
"
|
|
36
|
-
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
36
|
+
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
37
37
|
<p>This is <a href="http://textadventures.co.uk">a website link</a>.</p>
|
|
38
38
|
<p>This should be <a class="squiffy-link link-passage" data-passage="passage" role="link">a link to a passage</a>. Here's <a class="squiffy-link link-passage" data-passage="passage2" role="link" tabindex="0">another one</a>.</p>
|
|
39
39
|
<p>You don't need to specify a name - for example, this <a class="squiffy-link link-passage" data-passage="link" role="link" tabindex="0">link</a> and this <a class="squiffy-link link-section" data-section="section" role="link" tabindex="0">section</a>.</p>
|
|
@@ -45,7 +45,7 @@ exports[`Click a passage link and go back 1`] = `
|
|
|
45
45
|
|
|
46
46
|
exports[`Click a section link 1`] = `
|
|
47
47
|
"
|
|
48
|
-
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
48
|
+
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
49
49
|
<p>This is <a href="http://textadventures.co.uk">a website link</a>.</p>
|
|
50
50
|
<p>This should be <a class="squiffy-link link-passage" data-passage="passage" role="link" tabindex="0">a link to a passage</a>. Here's <a class="squiffy-link link-passage" data-passage="passage2" role="link" tabindex="0">another one</a>.</p>
|
|
51
51
|
<p>You don't need to specify a name - for example, this <a class="squiffy-link link-passage" data-passage="link" role="link" tabindex="0">link</a> and this <a class="squiffy-link link-section" data-section="section" role="link" tabindex="0">section</a>.</p>
|
|
@@ -57,19 +57,19 @@ exports[`Click a section link 1`] = `
|
|
|
57
57
|
|
|
58
58
|
exports[`Click a section link 2`] = `
|
|
59
59
|
"
|
|
60
|
-
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
60
|
+
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
61
61
|
<p>This is <a href="http://textadventures.co.uk">a website link</a>.</p>
|
|
62
62
|
<p>This should be <a class="squiffy-link link-passage" data-passage="passage" role="link" tabindex="0">a link to a passage</a>. Here's <a class="squiffy-link link-passage" data-passage="passage2" role="link" tabindex="0">another one</a>.</p>
|
|
63
63
|
<p>You don't need to specify a name - for example, this <a class="squiffy-link link-passage" data-passage="link" role="link" tabindex="0">link</a> and this <a class="squiffy-link link-section" data-section="section" role="link" tabindex="0">section</a>.</p>
|
|
64
64
|
<p>And this goes to the <a class="squiffy-link link-section" data-section="section2" role="link" tabindex="0">next section</a>.</p>
|
|
65
65
|
<p>This line has links to <a class="squiffy-link link-section" data-section="section 3" role="link" tabindex="0">section 3</a> and <a class="squiffy-link link-section" data-section="section four" role="link" tabindex="0">section 4</a>.</p>
|
|
66
66
|
<p>This line has links to <a class="squiffy-link link-passage" data-passage="passage 3" role="link" tabindex="0">passage 3</a> and <a class="squiffy-link link-passage" data-passage="passage four" role="link" tabindex="0">passage 4</a>.</p>
|
|
67
|
-
<p>Oh look - <a class="squiffy-link link-passage" data-passage="it's a passage with an apostrophe" role="link" tabindex="0">it's a passage with an apostrophe</a>.</p></div></div></div><div class="squiffy-output-section" data-section="section 3" data-undo="{"_section":"Introduction","_seen_sections":["Introduction"],"_turncount":0}"><div class="squiffy-output-block"><div data-source="[[section 3]]"><p>Another section is here, with passages <a class="squiffy-link link-passage" data-passage="a" role="link" tabindex="0">a</a> and <a class="squiffy-link link-passage" data-passage="b" role="link" tabindex="0">b</a>.</p></div></div></div></div>"
|
|
67
|
+
<p>Oh look - <a class="squiffy-link link-passage" data-passage="it's a passage with an apostrophe" role="link" tabindex="0">it's a passage with an apostrophe</a>.</p></div></div></div><div class="squiffy-output-section" data-section="section 3" data-undo="{"turns":0,"_section":"Introduction","_visits":{"Introduction":1},"_seen_sections":["Introduction"],"_turncount":0}"><div class="squiffy-output-block"><div data-source="[[section 3]]"><p>Another section is here, with passages <a class="squiffy-link link-passage" data-passage="a" role="link" tabindex="0">a</a> and <a class="squiffy-link link-passage" data-passage="b" role="link" tabindex="0">b</a>.</p></div></div></div></div>"
|
|
68
68
|
`;
|
|
69
69
|
|
|
70
70
|
exports[`Click a section link and go back 1`] = `
|
|
71
71
|
"
|
|
72
|
-
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
72
|
+
<div><div class="squiffy-output-section" data-section="Introduction" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[Introduction]]"><h1>Squiffy Test</h1>
|
|
73
73
|
<p>This is <a href="http://textadventures.co.uk">a website link</a>.</p>
|
|
74
74
|
<p>This should be <a class="squiffy-link link-passage" data-passage="passage" role="link" tabindex="0">a link to a passage</a>. Here's <a class="squiffy-link link-passage" data-passage="passage2" role="link" tabindex="0">another one</a>.</p>
|
|
75
75
|
<p>You don't need to specify a name - for example, this <a class="squiffy-link link-passage" data-passage="link" role="link" tabindex="0">link</a> and this <a class="squiffy-link link-section" data-section="section" role="link" tabindex="0">section</a>.</p>
|
|
@@ -81,60 +81,60 @@ exports[`Click a section link and go back 1`] = `
|
|
|
81
81
|
|
|
82
82
|
exports[`Delete passage 1`] = `
|
|
83
83
|
"
|
|
84
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div><div class="squiffy-output-passage" data-passage="a" data-undo="{"_turncount":0,"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a]"><p>New passage</p></div></div></div></div></div>"
|
|
84
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div><div class="squiffy-output-passage" data-passage="a" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a]"><p>New passage</p></div></div></div></div></div>"
|
|
85
85
|
`;
|
|
86
86
|
|
|
87
87
|
exports[`Delete passage 2`] = `
|
|
88
88
|
"
|
|
89
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div></div></div>"
|
|
89
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div></div></div>"
|
|
90
90
|
`;
|
|
91
91
|
|
|
92
92
|
exports[`Delete section 1`] = `
|
|
93
93
|
"
|
|
94
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-section" data-section="a" role="link" tabindex="0">a</a></p></div></div></div><div class="squiffy-output-section" data-section="a" data-undo="{"_section":"_default","_seen_sections":["_default"],"_turncount":0}"><div class="squiffy-output-block"><div data-source="[[a]]"><p>New section</p></div></div></div></div>"
|
|
94
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-section" data-section="a" role="link" tabindex="0">a</a></p></div></div></div><div class="squiffy-output-section" data-section="a" data-undo="{"turns":0,"_section":"_default","_visits":{"_default":1},"_seen_sections":["_default"],"_turncount":0}"><div class="squiffy-output-block"><div data-source="[[a]]"><p>New section</p></div></div></div></div>"
|
|
95
95
|
`;
|
|
96
96
|
|
|
97
97
|
exports[`Delete section 2`] = `
|
|
98
98
|
"
|
|
99
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-section" data-section="a" role="link" tabindex="0">a</a></p></div></div></div></div>"
|
|
99
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-section" data-section="a" role="link" tabindex="0">a</a></p></div></div></div></div>"
|
|
100
100
|
`;
|
|
101
101
|
|
|
102
102
|
exports[`Going back handling @clear and attribute changes 1`] = `
|
|
103
103
|
"
|
|
104
|
-
<div><div class="squiffy-clear-stack" style="display: none;"><div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Choose: <a class="squiffy-link link-passage" data-passage="a" role="link">a</a>, <a class="squiffy-link link-passage disabled" data-passage="b" role="link" tabindex="-1">b</a></p></div></div><div class="squiffy-output-passage" data-passage="b" data-undo="{"_turncount":0,"_seen_sections":["_default"],"test":null}"><div class="squiffy-output-block"><div data-source="[[_default]][b]"><p>You chose b. Now <a class="squiffy-link link-section" data-section="continue" role="link" tabindex="0">continue</a></p></div></div></div></div><div class="squiffy-output-section" data-section="continue" data-undo="{"_section":"_default","_seen_sections":["_default","b"],"test":456,"_turncount":1}"><div class="squiffy-output-block"><div data-source="[[continue]]"><p>Now choose: <a class="squiffy-link link-passage disabled" data-passage="c" role="link" tabindex="-1">c</a>, <a class="squiffy-link link-passage" data-passage="d" role="link" tabindex="0">d</a></p></div></div></div></div></div><div class="squiffy-output-section" data-section="continue" data-clear="true"><div class="squiffy-output-passage" data-passage="c" data-undo="{"_turncount":0,"_seen_sections":["_default","b","continue"],"test":789}"><div class="squiffy-output-block"><div data-source="[[continue]][c]"><p>You chose c. Now <a class="squiffy-link link-section" data-section="finish" role="link" tabindex="0">finish</a></p></div></div></div></div></div>"
|
|
104
|
+
<div><div class="squiffy-clear-stack" style="display: none;"><div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Choose: <a class="squiffy-link link-passage" data-passage="a" role="link">a</a>, <a class="squiffy-link link-passage disabled" data-passage="b" role="link" tabindex="-1">b</a></p></div></div><div class="squiffy-output-passage" data-passage="b" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"],"test":null}"><div class="squiffy-output-block"><div data-source="[[_default]][b]"><p>You chose b. Now <a class="squiffy-link link-section" data-section="continue" role="link" tabindex="0">continue</a></p></div></div></div></div><div class="squiffy-output-section" data-section="continue" data-undo="{"turns":1,"_section":"_default","_visits":{"_default":1,"b":1},"_seen_sections":["_default","b"],"test":456,"_turncount":1}"><div class="squiffy-output-block"><div data-source="[[continue]]"><p>Now choose: <a class="squiffy-link link-passage disabled" data-passage="c" role="link" tabindex="-1">c</a>, <a class="squiffy-link link-passage" data-passage="d" role="link" tabindex="0">d</a></p></div></div></div></div></div><div class="squiffy-output-section" data-section="continue" data-clear="true"><div class="squiffy-output-passage" data-passage="c" data-undo="{"turns":2,"_turncount":0,"_visits":{"_default":1,"b":1,"continue":1},"_seen_sections":["_default","b","continue"],"test":789}"><div class="squiffy-output-block"><div data-source="[[continue]][c]"><p>You chose c. Now <a class="squiffy-link link-section" data-section="finish" role="link" tabindex="0">finish</a></p></div></div></div></div></div>"
|
|
105
105
|
`;
|
|
106
106
|
|
|
107
107
|
exports[`Going back handling @clear and attribute changes 2`] = `
|
|
108
108
|
"
|
|
109
|
-
<div><div class="squiffy-clear-stack" style="display: none;"></div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Choose: <a class="squiffy-link link-passage" data-passage="a" role="link">a</a>, <a class="squiffy-link link-passage disabled" data-passage="b" role="link" tabindex="-1">b</a></p></div></div><div class="squiffy-output-passage" data-passage="b" data-undo="{"_turncount":0,"_seen_sections":["_default"],"test":null}"><div class="squiffy-output-block"><div data-source="[[_default]][b]"><p>You chose b. Now <a class="squiffy-link link-section" data-section="continue" role="link" tabindex="0">continue</a></p></div></div></div></div><div class="squiffy-output-section" data-section="continue" data-undo="{"_section":"_default","_seen_sections":["_default","b"],"test":456,"_turncount":1}"><div class="squiffy-output-block"><div data-source="[[continue]]"><p>Now choose: <a class="squiffy-link link-passage" data-passage="c" role="link">c</a>, <a class="squiffy-link link-passage" data-passage="d" role="link" tabindex="0">d</a></p></div></div></div></div>"
|
|
109
|
+
<div><div class="squiffy-clear-stack" style="display: none;"></div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Choose: <a class="squiffy-link link-passage" data-passage="a" role="link">a</a>, <a class="squiffy-link link-passage disabled" data-passage="b" role="link" tabindex="-1">b</a></p></div></div><div class="squiffy-output-passage" data-passage="b" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"],"test":null}"><div class="squiffy-output-block"><div data-source="[[_default]][b]"><p>You chose b. Now <a class="squiffy-link link-section" data-section="continue" role="link" tabindex="0">continue</a></p></div></div></div></div><div class="squiffy-output-section" data-section="continue" data-undo="{"turns":1,"_section":"_default","_visits":{"_default":1,"b":1},"_seen_sections":["_default","b"],"test":456,"_turncount":1}"><div class="squiffy-output-block"><div data-source="[[continue]]"><p>Now choose: <a class="squiffy-link link-passage" data-passage="c" role="link">c</a>, <a class="squiffy-link link-passage" data-passage="d" role="link" tabindex="0">d</a></p></div></div></div></div>"
|
|
110
110
|
`;
|
|
111
111
|
|
|
112
112
|
exports[`Update default section output 1`] = `
|
|
113
113
|
"
|
|
114
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Hello world</p></div></div></div></div>"
|
|
114
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Hello world</p></div></div></div></div>"
|
|
115
115
|
`;
|
|
116
116
|
|
|
117
117
|
exports[`Update default section output 2`] = `
|
|
118
118
|
"
|
|
119
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Updated content</p></div></div></div></div>"
|
|
119
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Updated content</p></div></div></div></div>"
|
|
120
120
|
`;
|
|
121
121
|
|
|
122
122
|
exports[`Update passage output - passage name "a" 1`] = `
|
|
123
123
|
"
|
|
124
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div><div class="squiffy-output-passage" data-passage="a" data-undo="{"_turncount":0,"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a]"><p>Passage a content</p></div></div></div></div></div>"
|
|
124
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div><div class="squiffy-output-passage" data-passage="a" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a]"><p>Passage a content</p></div></div></div></div></div>"
|
|
125
125
|
`;
|
|
126
126
|
|
|
127
127
|
exports[`Update passage output - passage name "a" 2`] = `
|
|
128
128
|
"
|
|
129
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div><div class="squiffy-output-passage" data-passage="a" data-undo="{"_turncount":0,"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a]"><p>Updated passage content</p></div></div></div></div></div>"
|
|
129
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a" role="link" tabindex="-1">a</a></p></div></div><div class="squiffy-output-passage" data-passage="a" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a]"><p>Updated passage content</p></div></div></div></div></div>"
|
|
130
130
|
`;
|
|
131
131
|
|
|
132
132
|
exports[`Update passage output - passage name "a'1" 1`] = `
|
|
133
133
|
"
|
|
134
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a'1" role="link" tabindex="-1">a'1</a></p></div></div><div class="squiffy-output-passage" data-passage="a'1" data-undo="{"_turncount":0,"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a'1]"><p>Passage a content</p></div></div></div></div></div>"
|
|
134
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a'1" role="link" tabindex="-1">a'1</a></p></div></div><div class="squiffy-output-passage" data-passage="a'1" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a'1]"><p>Passage a content</p></div></div></div></div></div>"
|
|
135
135
|
`;
|
|
136
136
|
|
|
137
137
|
exports[`Update passage output - passage name "a'1" 2`] = `
|
|
138
138
|
"
|
|
139
|
-
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a'1" role="link" tabindex="-1">a'1</a></p></div></div><div class="squiffy-output-passage" data-passage="a'1" data-undo="{"_turncount":0,"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a'1]"><p>Updated passage content</p></div></div></div></div></div>"
|
|
139
|
+
<div><div class="squiffy-output-section" data-section="_default" data-undo="{"_section":null,"_visits":null,"_seen_sections":null,"_turncount":null}"><div class="squiffy-output-block"><div data-source="[[_default]]"><p>Click this: <a class="squiffy-link link-passage disabled" data-passage="a'1" role="link" tabindex="-1">a'1</a></p></div></div><div class="squiffy-output-passage" data-passage="a'1" data-undo="{"turns":0,"_turncount":0,"_visits":{"_default":1},"_seen_sections":["_default"]}"><div class="squiffy-output-block"><div data-source="[[_default]][a'1]"><p>Updated passage content</p></div></div></div></div></div>"
|
|
140
140
|
`;
|
|
@@ -220,6 +220,48 @@ Your score is {{#label "score"}}0{{/label}}.
|
|
|
220
220
|
expect(labelSpans[0].classList.contains("fade-in")).toBe(false);
|
|
221
221
|
});
|
|
222
222
|
|
|
223
|
+
test("Replace plugin: replaces the latest label, in a section visited again after the screen is cleared", async () => {
|
|
224
|
+
const script = `
|
|
225
|
+
[[]]:
|
|
226
|
+
@clear
|
|
227
|
+
|
|
228
|
+
[[room]]:
|
|
229
|
+
The box is {{#label "box"}}closed{{/label}}. [Open it](open) or [[go out]](outside).
|
|
230
|
+
|
|
231
|
+
[open]:
|
|
232
|
+
{{#replace "box"}}open{{/replace}}
|
|
233
|
+
|
|
234
|
+
[[outside]]:
|
|
235
|
+
You're outside. [[Go back in]](room)
|
|
236
|
+
`;
|
|
237
|
+
|
|
238
|
+
const { squiffyApi, element } = await initScript(script);
|
|
239
|
+
await squiffyApi.clickLink(element.querySelector<HTMLElement>("a.squiffy-link[data-section='outside']")!);
|
|
240
|
+
await squiffyApi.clickLink(element.querySelector<HTMLElement>("a.squiffy-link[data-section='room']")!);
|
|
241
|
+
|
|
242
|
+
expect(element.querySelectorAll(".squiffy-label-box").length).toBe(2);
|
|
243
|
+
const links = element.querySelectorAll<HTMLElement>("a.squiffy-link[data-passage='open']");
|
|
244
|
+
await squiffyApi.clickLink(links[links.length - 1]);
|
|
245
|
+
const labels = element.querySelectorAll(".squiffy-label-box");
|
|
246
|
+
expect(labels[0].textContent).toBe("closed");
|
|
247
|
+
expect(labels[1].textContent).toBe("open");
|
|
248
|
+
});
|
|
249
|
+
|
|
250
|
+
test("Replace plugin: replace with only a label in it", async () => {
|
|
251
|
+
const script = `
|
|
252
|
+
The box is {{#label "box"}}closed{{/label}}. [Open it](open)
|
|
253
|
+
|
|
254
|
+
[open]:
|
|
255
|
+
{{#replace "box"}}{{#label "lid"}}open{{/label}}{{/replace}}
|
|
256
|
+
`;
|
|
257
|
+
|
|
258
|
+
const { squiffyApi, element } = await initScript(script);
|
|
259
|
+
await squiffyApi.clickLink(findPassageLink(element, "open")!);
|
|
260
|
+
|
|
261
|
+
expect(element.querySelector(".squiffy-label-box")?.innerHTML).toBe("<span class=\"squiffy-label-lid\">open</span>");
|
|
262
|
+
expect(element.querySelector(".squiffy-error")).toBeNull();
|
|
263
|
+
});
|
|
264
|
+
|
|
223
265
|
// ===== RotateSequencePlugin Tests =====
|
|
224
266
|
|
|
225
267
|
test("Sequence plugin: click through sequence", async () => {
|
|
@@ -11,8 +11,12 @@ export function ReplaceLabel() : SquiffyPlugin {
|
|
|
11
11
|
return new Handlebars.SafeString(`<span class="squiffy-label-${name}">${options.fn(this)}</span>`);
|
|
12
12
|
});
|
|
13
13
|
squiffy.registerHelper("replace", function(this: any, name: string, options) {
|
|
14
|
-
|
|
15
|
-
const
|
|
14
|
+
// A block that's only another helper, such as {{#label}}, gives that helper's SafeString
|
|
15
|
+
const result = String(options.fn(this));
|
|
16
|
+
// The latest label with the name: when a section is visited again, or the screen's been
|
|
17
|
+
// cleared, earlier ones can still be in the output (in the clear stack, hidden)
|
|
18
|
+
const labels = squiffy.outputElement.querySelectorAll<HTMLElement>(`.squiffy-label-${name}`);
|
|
19
|
+
const element = labels[labels.length - 1];
|
|
16
20
|
if (element) {
|
|
17
21
|
const isBlock = result.includes("\n\n");
|
|
18
22
|
const html = isBlock
|
package/src/preview.test.ts
CHANGED
|
@@ -71,6 +71,8 @@ describe("preview", () => {
|
|
|
71
71
|
expect(element.textContent).toContain("Welcome.");
|
|
72
72
|
expect(messages).toEqual([
|
|
73
73
|
{ type: "canGoBackChanged", canGoBack: false },
|
|
74
|
+
// The story-wide turn count (#377), which isn't internal, so it's reported
|
|
75
|
+
{ type: "attributeSet", name: "turns", value: 0 },
|
|
74
76
|
{ type: "attributeSet", name: "score", value: 1 },
|
|
75
77
|
{ type: "navigated", section: "start" },
|
|
76
78
|
{ type: "loaded" },
|
|
@@ -80,6 +82,7 @@ describe("preview", () => {
|
|
|
80
82
|
element.querySelector<HTMLElement>("a[data-passage='look']")!.click();
|
|
81
83
|
await vi.waitFor(() => expect(messages.some(m => m.type == "navigated")).toBe(true));
|
|
82
84
|
expect(messages).toEqual([
|
|
85
|
+
{ type: "attributeSet", name: "turns", value: 1 },
|
|
83
86
|
{ type: "attributeSet", name: "looked", value: true },
|
|
84
87
|
{ type: "canGoBackChanged", canGoBack: true },
|
|
85
88
|
{ type: "navigated", section: "start", passage: "look" },
|
package/src/squiffy.runtime.css
CHANGED
|
@@ -99,7 +99,7 @@ select.squiffy-invalid:focus
|
|
|
99
99
|
box-shadow: 0 0 0 0.2rem color-mix(in srgb, var(--squiffy-error) 50%, transparent);
|
|
100
100
|
}
|
|
101
101
|
|
|
102
|
-
/* Header button styles: the Restart
|
|
102
|
+
/* Header button styles: the Back and Restart buttons */
|
|
103
103
|
button.squiffy-header-button
|
|
104
104
|
{
|
|
105
105
|
color: var(--squiffy-muted);
|
|
@@ -114,12 +114,19 @@ button.squiffy-header-button
|
|
|
114
114
|
transition: color 0.2s ease-in-out, text-decoration-color 0.2s ease-in-out;
|
|
115
115
|
}
|
|
116
116
|
|
|
117
|
-
button.squiffy-header-button:hover
|
|
117
|
+
button.squiffy-header-button:hover:not(:disabled)
|
|
118
118
|
{
|
|
119
119
|
color: var(--squiffy-text);
|
|
120
120
|
text-decoration-color: currentColor;
|
|
121
121
|
}
|
|
122
122
|
|
|
123
|
+
/* The Back button, when there's nothing to go back to */
|
|
124
|
+
button.squiffy-header-button:disabled
|
|
125
|
+
{
|
|
126
|
+
cursor: default;
|
|
127
|
+
opacity: 0.5;
|
|
128
|
+
}
|
|
129
|
+
|
|
123
130
|
/* Output block spacing */
|
|
124
131
|
div.squiffy-output-block:not(:last-child),
|
|
125
132
|
div.squiffy-output-passage:not(:last-child),
|