extwee 2.2.0 → 2.2.1

package/docs/_sidebar.md

@@ -17,3 +17,4 @@
 - Examples
   - [Dynamically Generating Passages](/examples/dynamicPassages.md)
   - [Converting Twine 2 JSON into Twee 3](/examples/jsonToTwee.md)
+  - [Converting Twine 1 TWS into Twee 3](/examples/twsToTwee.md)

package/docs/examples/dynamicPassages.md

@@ -16,7 +16,7 @@ import { writeFileSync } from 'node:fs';
 const example = new Story( 'Example' );
 
 // Generate 20 passages and add them to the story.
-for(let i = 0; i < 20; i++;) {
+for(let i = 0; i < 20; i++) {
     example.addPassage( new Passage( `Passage ${i}`, 'Some Text') );
 }
 

package/docs/examples/twsToTwee.md

@@ -1,6 +1,6 @@
 # TWS To Twee
 
-Converting from TWS to Twee 3 is similar to many other conversion processes:
+Converting from TWS to Twee 3 is similar to many other conversion processes with one small difference. TWS conversion needs to be begin from the [**Buffer** data type in JavaScript](https://nodejs.org/api/buffer.html).
 
 1. Read the binary file.
 2. Convert the binary files into a Buffer.

package/index.js

@@ -8,7 +8,7 @@ import { parse as parseTWS } from './src/TWS/parse.js';
 import { compile as compileTwine1HTML } from './src/Twine1HTML/compile.js';
 import { compile as compileTwine2HTML } from './src/Twine2HTML/compile.js';
 import { compile as compileTwine2ArchiveHTML } from './src/Twine2ArchiveHTML/compile.js';
-import Story from './src/Story.js';
+import { Story } from './src/Story.js';
 import Passage from './src/Passage.js';
 import StoryFormat from './src/StoryFormat.js';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extwee",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "A story compiler tool using Twine-compatible formats",
   "author": "Dan Cox",
   "main": "index.js",
@@ -24,33 +24,35 @@
   "license": "MIT",
   "dependencies": {
     "commander": "^11.1.0",
-    "node-html-parser": "^6.1.11",
+    "html-entities": "^2.4.0",
+    "node-html-parser": "^6.1.12",
     "pickleparser": "^0.2.1",
-    "semver": "^7.3.7",
+    "semver": "^7.5.4",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.6",
+    "@babel/core": "^7.23.7",
     "@babel/eslint-parser": "^7.23.3",
     "@babel/eslint-plugin": "^7.23.5",
-    "@babel/preset-env": "^7.23.6",
+    "@babel/preset-env": "^7.23.8",
     "babel-loader": "^9.1.3",
     "clean-jsdoc-theme": "^4.2.17",
-    "core-js": "^3.34.0",
+    "core-js": "^3.35.0",
     "docsify-cli": "^4.4.4",
-    "esbuild": "0.19.10",
+    "esbuild": "0.19.11",
     "eslint": "^8.56.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jest": "^27.6.0",
-    "eslint-plugin-jsdoc": "^46.9.1",
-    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-jest": "^27.6.1",
+    "eslint-plugin-jsdoc": "^48.0.2",
+    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.7.0",
     "pkg": "^5.8.1",
     "regenerator-runtime": "^0.14.1",
-    "shelljs": "^0.8.4",
+    "shelljs": "^0.8.5",
+    "typescript": "^5.3.3",
     "webpack": "^5.89.0",
     "webpack-cli": "^5.1.4"
   },
@@ -61,5 +63,6 @@
   "bugs": {
     "url": "https://github.com/videlais/extwee/issues"
   },
-  "type": "module"
+  "type": "module",
+  "types": "./types/index.d.ts"
 }

package/src/JSON/parse.js

@@ -1,4 +1,4 @@
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 import Passage from '../Passage.js';
 
 /**

package/src/Passage.js

@@ -1,3 +1,5 @@
+import { encode } from 'html-entities';
+
 /**
  * A passage is the smallest unit of a Twine story.
  */
@@ -76,6 +78,7 @@ export default class Passage {
   set tags (t) {
     // Test if tags is an array
     if (Array.isArray(t)) {
+      // Set the tags.
       this.#_tags = t;
     } else {
       throw new Error('Tags must be an array!');
@@ -185,13 +188,13 @@ export default class Passage {
      * name: (string) Required.
      *   The name of the passage.
      */
-    passageData += ` name="${this.name}"`;
+    passageData += ` name="${ encode( this.name ) }"`;
 
     /**
      * tags: (string) Optional.
      *   Any tags for the passage separated by spaces.
      */
-    passageData += ` tags="${this.#_tags.join(' ')}" `;
+    passageData += ` tags="${ encode( this.#_tags.join(' ') ) }" `;
 
     /**
      * position: (string) Optional.
@@ -211,30 +214,8 @@ export default class Passage {
       passageData += `size="${this.#_metadata.size}" `;
     }
 
-    /**
-     * Escape passage Twine 2 passage text.
-     * @param {string} text - Text to escape.
-     * @returns {string} Escaped text.
-     */
-    const escape = function (text) {
-      const rules = [
-        ['&', '&'],
-        ['<', '&lt;'],
-        ['>', '&gt;'],
-        ['"', '&quot;'],
-        ["'", '&#x27;'],
-        ['`', '&#x60;']
-      ];
-
-      rules.forEach(([rule, template]) => {
-        text = text.replaceAll(rule, template);
-      });
-
-      return text;
-    };
-
     // Add the text and close the element.
-    passageData += `>${escape(this.text)}</tw-passagedata>\n`;
+    passageData += `>${ encode( this.text ) }</tw-passagedata>\n`;
 
     // Return the Twine 2 HTML element.
     return passageData;
@@ -258,13 +239,13 @@ export default class Passage {
      * tiddler: (string) Required.
      *   The name of the passage.
      */
-    passageData += ` tiddler="${this.name}"`;
+    passageData += ` tiddler="${ encode( this.name ) }"`;
 
     /**
      * tags: (string) Required.
      *   Any tags for the passage separated by spaces.
      */
-    passageData += ` tags="${this.#_tags.join(' ')}" `;
+    passageData += ` tags="${ encode( this.#_tags.join(' ') ) }" `;
 
     /**
      * modifier: (string) Optional.
@@ -290,7 +271,7 @@ export default class Passage {
      * text: (string) Required.
      * Text content of the passage.
      */
-    passageData += `>${this.#_text}</div>`;
+    passageData += `>${ encode( this.#_text ) }</div>`;
 
     // Return the HTML representation.
     return passageData;

package/src/Story.js

@@ -1,10 +1,11 @@
 import Passage from './Passage.js';
 import { v4 as uuidv4 } from 'uuid';
+import { encode } from 'html-entities';
 
 const creatorName = 'extwee';
-const version = '2.2.0';
+const creatorVersion = '2.2.1';
 
-export default class Story {
+class Story {
   /**
    * Internal name of story
    * @private
@@ -78,7 +79,7 @@ export default class Story {
     this.name = name;
     // Store the creator.
     this.#_creator = creatorName;
-    this.#_creatorVersion = version;
+    this.#_creatorVersion = creatorVersion;
     // Set metadata to an object.
     this.#_metadata = {};
   }
@@ -516,7 +517,7 @@ export default class Story {
    */
   toTwine2HTML () {
     // Prepare HTML content.
-    let storyData = `<tw-storydata name="${this.name}"`;
+    let storyData = `<tw-storydata name="${ encode( this.name ) }"`;
     // Passage Identification (PID) counter.
     // (Twine 2 starts with 1, so we mirror that.)
     let PIDcounter = 1;
@@ -552,7 +553,7 @@ export default class Story {
     storyData += ` startnode="${startPID}"`;
 
     // Defaults to 'extwee' if missing.
-    storyData += ` creator="${this.creator}"`;
+    storyData += ` creator="${ encode( this.creator ) }"`;
 
     // Default to extwee version.
     storyData += ` creator-version="${this.creatorVersion}"`;
@@ -571,7 +572,7 @@ export default class Story {
     storyData += ` zoom="${this.zoom}"`;
 
     // Write existing or default value.
-    storyData += ` format="${this.#_format}"`;
+    storyData += ` format="${ encode(this.#_format) }"`;
 
     // Write existing or default value.
     storyData += ` format-version="${this.#_formatVersion}"`;
@@ -648,3 +649,5 @@ export default class Story {
     return outputContents;
   }
 }
+
+export { Story, creatorName, creatorVersion };

package/src/TWS/parse.js

@@ -1,4 +1,4 @@
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 import Passage from '../Passage.js';
 import { Parser } from 'pickleparser';
 

package/src/Twee/parse.js

@@ -1,5 +1,5 @@
 import Passage from '../Passage.js';
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 
 /**
  * Parses Twee 3 text into a Story object.

package/src/Twine1HTML/compile.js

@@ -1,4 +1,4 @@
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 
 /**
  * Write a combination of Story object, `engine.js` (from Twine 1), `header.html`, and optional `code.js`.

package/src/Twine1HTML/parse.js

@@ -1,6 +1,6 @@
 import { parse as HtmlParser } from 'node-html-parser';
 import Passage from '../Passage.js';
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 
 /**
  * Parses Twine 1 HTML into a Story object.

package/src/Twine2ArchiveHTML/compile.js

@@ -1,4 +1,4 @@
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 
 /**
  * Write array of Story objects into Twine 2 Archive HTML.

package/src/Twine2HTML/compile.js

@@ -1,4 +1,4 @@
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 import StoryFormat from '../StoryFormat.js';
 
 /**

package/src/Twine2HTML/parse.js

@@ -1,6 +1,7 @@
 import { parse as HtmlParser } from 'node-html-parser';
-import Story from '../Story.js';
+import { Story } from '../Story.js';
 import Passage from '../Passage.js';
+import { decode } from 'html-entities';
 
 /**
  * Parse Twine 2 HTML into Story object.
@@ -244,9 +245,9 @@ function parse (content) {
       // Add a new Passage into an array
       story.addPassage(
         new Passage(
-          name,
-          text,
-          tags,
+          decode(name),
+          decode(text),
+          tags.map(tag => decode(tag)),
           metadata
         )
       );

package/test/JSON/JSON.Parse.test.js

@@ -1,4 +1,4 @@
-import Story from '../../src/Story.js';
+import { Story, creatorVersion, creatorName } from '../../src/Story.js';
 import Passage from '../../src/Passage.js';
 import { parse as parseJSON } from '../../src/JSON/parse.js';
 
@@ -22,8 +22,8 @@ describe('JSON', () => {
       expect(s.start).toBe('');
       expect(s.formatVersion).toBe('');
       expect(s.format).toBe('');
-      expect(s.creator).toBe('extwee');
-      expect(s.creatorVersion).toBe('2.2.0');
+      expect(s.creator).toBe(creatorName);
+      expect(s.creatorVersion).toBe(creatorVersion);
       expect(s.zoom).toBe(0);
       expect(Object.keys(s.metadata).length).toBe(0);
     });
@@ -59,7 +59,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -75,7 +75,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -91,7 +91,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -107,7 +107,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -123,7 +123,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -139,7 +139,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -155,7 +155,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -171,8 +171,8 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
-        expect(r.creatorVersion).toBe('2.2.0');
+        expect(r.creator).toBe(creatorName);
+        expect(r.creatorVersion).toBe(creatorVersion);
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
       });
@@ -187,7 +187,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(0);
         expect(r.size()).toBe(1);
@@ -203,7 +203,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(0);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -219,7 +219,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(0);
@@ -235,7 +235,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(0);
@@ -251,7 +251,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -268,7 +268,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -286,7 +286,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);
@@ -304,7 +304,7 @@ describe('JSON', () => {
         expect(r.formatVersion).toBe('1.0');
         expect(Object.keys(r.metadata).length).toBe(1);
         expect(r.format).toBe('Snowman');
-        expect(r.creator).toBe('extwee');
+        expect(r.creator).toBe(creatorName);
         expect(r.creatorVersion).toBe('2.2.0');
         expect(r.zoom).toBe(1);
         expect(r.size()).toBe(1);

package/test/Passage.test.js

@@ -1,4 +1,5 @@
 import Passage from '../src/Passage.js';
+import { parse as HTMLParser } from 'node-html-parser';
 
 describe('Passage', () => {
   describe('constructor()', () => {
@@ -172,4 +173,72 @@ describe('Passage', () => {
       expect(result.includes('position="10,10"')).toBe(true);
     });
   });
+
+  describe('Escaping', function () {
+    it('Should escape double quotes', function () {
+      const p = new Passage('Test', 'Word "word"');
+      expect(p.toTwine2HTML().includes('Word "word"')).toBe(true);
+    });
+
+    it('Should escape ampersands', function () {
+      const p = new Passage('Test', 'Word & word');
+      expect(p.toTwine2HTML().includes('Word & word')).toBe(true);
+    });
+
+    it('Should escape less than', function () {
+      const p = new Passage('Test', 'Word < word');
+      expect(p.toTwine2HTML().includes('Word &lt; word')).toBe(true);
+    });
+
+    it('Should escape greater than', function () {
+      const p = new Passage('Test', 'Word > word');
+      expect(p.toTwine2HTML().includes('Word &gt; word')).toBe(true);
+    });
+
+    it('Should escape all', function () {
+      const p = new Passage('Test', 'Word &<>"\' word');
+      expect(p.toTwine2HTML().includes('>Word &amp;&lt;&gt;&quot;&apos; word<')).toBe(true);
+    });
+
+    it('Should escape meta-characters safely in name', function () {
+      const p = new Passage('"Test"');
+      expect(p.toTwine2HTML().includes('name="&quot;Test&quot;"')).toBe(true);
+      expect(p.toTwine1HTML().includes('tiddler="&quot;Test&quot;"')).toBe(true);
+    });
+
+    it('Should escape meta-characters safely in text', function () {
+      const p = new Passage('Test', '"Word"');
+      expect(p.toTwine2HTML().includes('&quot;Word&quot;')).toBe(true);
+    });
+
+    it('Should escape meta-characters safely in tags', function () {
+      const p = new Passage('Test', 'Word', ['&tag', '"bad"']);
+      expect(p.toTwine2HTML().includes('tags="&amp;tag &quot;bad&quot;"')).toBe(true);
+      expect(p.toTwine1HTML().includes('tags="&amp;tag &quot;bad&quot;"')).toBe(true);
+    });
+
+    it('Should escape meta-characters safely in Twee header', function () {
+      const p = new Passage('Where do tags begin? [well',  '', ['hmm']);
+      expect(p.toTwee().includes('Where do tags begin? \[well [hmm]')).toBe(true);
+    });
+
+    it('Should produce valid HTML attributes', function () {
+      // Generate passage.
+      const p = new Passage('"Test"', '"Word"', ['&tag', '"bad"'], { position: '100,100' });
+      // Parse HTML.
+      const d = new HTMLParser(p.toTwine2HTML());
+      // Test attributes.
+      expect(d.querySelector('tw-passagedata').getAttribute('name')).toBe('"Test"');
+      expect(d.querySelector('tw-passagedata').getAttribute('tags')).toBe('&tag "bad"');
+      expect(d.querySelector('tw-passagedata').getAttribute('position')).toBe('100,100');
+      // Use Twine 2 result.
+      const s = `<tw-passagedata pid="1" name="&quot;Test&quot;" tags="&amp;tag &quot;bad&quot;" position="100,100" size="100,100"></tw-passagedata>`;
+      // Parse HTML.
+      const t = new HTMLParser(s);
+      // Test Twine 2 attributes.
+      expect(t.querySelector('tw-passagedata').getAttribute('name')).toBe('"Test"');
+      expect(t.querySelector('tw-passagedata').getAttribute('tags')).toBe('&tag "bad"');
+      expect(t.querySelector('tw-passagedata').getAttribute('position')).toBe('100,100');
+    });
+  });
 });

package/test/Story.test.js

@@ -1,7 +1,8 @@
-import Story from '../src/Story.js';
+import { Story, creatorName, creatorVersion } from '../src/Story.js';
 import Passage from '../src/Passage';
 import { parse as parseTwee } from '../src/Twee/parse.js';
 import { readFileSync } from 'node:fs';
+import { parse as HTMLParser } from 'node-html-parser';
 
 // Pull the name and version of this project from package.json.
 // These are used as the 'creator' and 'creator-version'.
@@ -405,8 +406,8 @@ describe('Story', () => {
       expect(result.start).toBe('');
       expect(result.formatVersion).toBe('');
       expect(result.format).toBe('');
-      expect(result.creator).toBe('extwee');
-      expect(result.creatorVersion).toBe('2.2.0');
+      expect(result.creator).toBe(creatorName);
+      expect(result.creatorVersion).toBe(creatorVersion);
       expect(result.zoom).toBe(0);
       expect(Object.keys(result.metadata).length).toBe(0);
     });
@@ -635,4 +636,42 @@ describe('Story', () => {
       expect(result.includes('<div tiddler="Start"')).toBe(true);
     });
   });
+
+  describe('Escaping', function () {
+    it('Should produce valid Twine 2 Story HTML', function () {
+      // Create a new Story.
+      const s = new Story('"Abuse" &test');
+      // Add a passage.
+      s.addPassage(new Passage('"Test"', 'Word'));
+      // Set start.
+      s.start = '"Test"';
+      // Parse HTML.
+      const root = HTMLParser(s.toTwine2HTML());
+      // Expect correct name attribute for tw-storydata.
+      expect(root.querySelector('tw-storydata').getAttribute('name')).toBe('"Abuse" &test');
+      // Expect correct name attribute for tw-passagedata.
+      expect(root.querySelector('tw-passagedata').getAttribute('name')).toBe('"Test"');
+      // Use Twine 2 result.
+      const s2 = `<tw-storydata name="&quot;Abuse&quot; &amp;test" startnode="1" creator="Twine" creator-version="2.8.1" format="Harlowe" format-version="3.3.8" ifid="452A9D80-C759-42C5-B001-5B861A2410C5" options="" tags="" zoom="1" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css"></style><script role="script" id="twine-user-script" type="text/twine-javascript"></script><tw-passagedata pid="1" name="&quot;Test&quot;" tags="&amp;tag &quot;bad&quot;" position="300,100" size="100,100"></tw-passagedata></tw-storydata>`;
+      // Parse HTML.
+      const root2 = HTMLParser(s2);
+      // Expect correct name attribute for tw-storydata.
+      expect(root2.querySelector('tw-storydata').getAttribute('name')).toBe('"Abuse" &test');
+      // Expect correct name attribute for tw-passagedata.
+      expect(root2.querySelector('tw-passagedata').getAttribute('name')).toBe('"Test"');
+    });
+
+    it('Should produce valid Twine 1 Story HTML', function () {
+      // Create a new Story.
+      const s = new Story('"Abuse" &test');
+      // Add a passage.
+      s.addPassage(new Passage('"Test"', 'Word'));
+      // Set start.
+      s.start = '"Test"';
+      // Parse HTML.
+      const root = HTMLParser(s.toTwine1HTML());
+      // Expect correct name attribute for div.
+      expect(root.querySelector('div').getAttribute('tiddler')).toBe('"Test"');
+    });
+  });
 });

package/test/Twine1HTML/Twine1HTML.Compile.test.js

@@ -1,5 +1,5 @@
 import { compile as compileTwine1HTML } from '../../src/Twine1HTML/compile.js';
-import Story from '../../src/Story.js';
+import { Story } from '../../src/Story.js';
 import { readFileSync } from 'fs';
 import Passage from '../../src/Passage.js';
 

package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Compile.test.js

@@ -1,5 +1,5 @@
 import { compile as compileTwine2ArchiveHTML } from '../../src/Twine2ArchiveHTML/compile.js';
-import Story from '../../src/Story.js';
+import { Story } from '../../src/Story.js';
 import Passage from '../../src/Passage.js';
 
 describe('Twine2ArchiveHTML', function () {

package/test/Twine2HTML/Twine2HTML.Compile.test.js

@@ -1,7 +1,7 @@
 import { parse as parseStoryFormat } from '../../src/StoryFormat/parse.js';
 import { parse as parseTwine2HTML } from '../../src/Twine2HTML/parse.js';
 import { compile as compileTwine2HTML } from '../../src/Twine2HTML/compile.js';
-import Story from '../../src/Story.js';
+import { Story } from '../../src/Story.js';
 import Passage from '../../src/Passage.js';
 import { readFileSync } from 'node:fs';