npm - extwee - Versions diffs - 2.2.1 → 2.2.2 - Mend

extwee 2.2.1 → 2.2.2

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.

Files changed (49) hide show

package/.github/codeql-analysis.yml +51 -0
package/README.md +9 -3
package/docs/objects/story.md +1 -2
package/index.js +2 -0
package/package.json +17 -17
package/src/IFID/generate.js +20 -0
package/src/JSON/parse.js +43 -0
package/src/Passage.js +52 -3
package/src/Story.js +266 -107
package/src/StoryFormat/parse.js +190 -80
package/src/StoryFormat.js +78 -88
package/src/TWS/parse.js +2 -2
package/src/Twee/parse.js +2 -3
package/src/Twine1HTML/compile.js +2 -0
package/src/Twine1HTML/parse.js +2 -3
package/src/Twine2ArchiveHTML/compile.js +8 -0
package/src/Twine2ArchiveHTML/parse.js +33 -3
package/src/Twine2HTML/compile.js +31 -6
package/src/Twine2HTML/parse.js +49 -54
package/test/IFID/IFID.Generate.test.js +10 -0
package/test/JSON/JSON.Parse.test.js +4 -4
package/test/Story.test.js +256 -46
package/test/StoryFormat/StoryFormat.Parse.test.js +442 -55
package/test/StoryFormat.test.js +9 -2
package/test/TWS/Parse.test.js +1 -1
package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Parse.test.js +20 -4
package/test/Twine2HTML/Twine2HTML.Compile.test.js +35 -120
package/test/Twine2HTML/Twine2HTML.Parse.test.js +57 -38
package/test/Twine2HTML/Twine2HTMLCompiler/format.js +9 -0
package/test/Twine2HTML/Twine2HTMLParser/missingZoom.html +1 -1
package/web-index.js +2 -0
package/test/StoryFormat/StoryFormatParser/example.js +0 -3
package/test/StoryFormat/StoryFormatParser/example2.js +0 -3
package/test/StoryFormat/StoryFormatParser/format.js +0 -1
package/test/StoryFormat/StoryFormatParser/format_doublename.js +0 -1
package/test/StoryFormat/StoryFormatParser/harlowe.js +0 -3
package/test/StoryFormat/StoryFormatParser/missingAuthor.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingDescription.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingImage.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingLicense.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingName.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingProofing.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingSource.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingURL.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingVersion.js +0 -1
package/test/StoryFormat/StoryFormatParser/versionWrong.js +0 -1
package/test/Twine2HTML/Twine2HTMLParser/missingName.html +0 -33
package/test/Twine2HTML/Twine2HTMLParser/missingPID.html +0 -15
package/test/Twine2HTML/Twine2HTMLParser/missingPassageName.html +0 -15

package/test/StoryFormat/StoryFormat.Parse.test.js CHANGED Viewed

@@ -1,91 +1,478 @@
 import { parse as parseStoryFormat } from '../../src/StoryFormat/parse.js';
-import { readFileSync } from 'node:fs';
 describe('StoryFormat', () => {
   describe('parse()', () => {
+    describe('Removing setup', () => {
+      it('Should remove setup', () => {
+        const fr = 'window.storyFormat({"author":"A","description":"B","image":"C","name":"harlowe","proofing":false,"license":"MIT","source":"<html></html>","url":"example.com","version":"1.0.0","setup": function(){}});';
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.name).toBe('harlowe');
+        expect(sfp.version).toBe('1.0.0');
+        expect(sfp.author).toBe('A');
+        expect(sfp.description).toBe('B');
+        expect(sfp.image).toBe('C');
+        expect(sfp.url).toBe('example.com');
+        expect(sfp.license).toBe('MIT');
+        expect(sfp.proofing).toBe(false);
+      });
+    });
+    describe('name', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse a name', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.name).toBe('My Story Format');
+      });
+      it('Should detect missing name and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.name;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.name).toBe('Untitled Story Format');
+      });
+    });
+    describe('author', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse an author', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.author).toBe('Twine');
+      });
+      it('Should detect missing author and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.author;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.author).toBe('');
+      });
+    });
+    describe('description', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse a description', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.description).toBe('A story format.');
+      });
+      it('Should detect missing description and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.description;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.description).toBe('');
+      });
+    });
+    describe('image', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse an image', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.image).toBe('icon.svg');
+      });
+      it('Should detect missing image and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.image;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.image).toBe('');
+      });
+    });
+    describe('url', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse a url', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.url).toBe('https://example.com');
+      });
+      it('Should detect missing url and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.url;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.url).toBe('');
+      });
+    });
+    describe('version', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse a version', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.version).toBe('1.0.0');
+      });
+    });
+    describe('license', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": false,
+        "source": "<html></html>"
+        }`;
+      it('Should parse a license', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.license).toBe('MIT');
+      });
+      it('Should detect missing license and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.license;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.license).toBe('');
+      });
+    });
+    describe('proofing', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      it('Should parse proofing', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.proofing).toBe(true);
+      });
+      it('Should detect missing proofing and set default', () => {
+        const copy = JSON.parse(fr);
+        delete copy.proofing;
+        const sfp = parseStoryFormat(JSON.stringify(copy));
+        expect(sfp.proofing).toBe(false);
+      });
+    });
+    describe('source', function () {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      it('Should parse a source', () => {
+        const sfp = parseStoryFormat(fr);
+        expect(sfp.source).toBe('<html></html>');
+      });
+    });
+  });
+  describe('Errors', function () {
     it('Should throw error if JSON missing', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/example.js', 'utf-8');
+      const fr = '[]';
       expect(() => { parseStoryFormat(fr); }).toThrow();
     });
-    it('Should throw error if JSON malformed', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/example2.js', 'utf-8');
+    it('Should throw error if JSON is malformed', () => {
+      const fr = '{"state"}';
       expect(() => { parseStoryFormat(fr); }).toThrow();
     });
+  });
+  describe('Warnings', () => {
+    beforeEach(() => {
+      // Mock console.warn.
+      jest.spyOn(console, 'warn').mockImplementation();
+    });
+    afterEach(() => {
+      // Restore all mocks.
+      jest.restoreAllMocks();
+    });
-    it('Should correctly parse a StoryFormat name', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.name).toBe('Snowman');
+    it('Should produce warning if name is not a string', () => {
+      const fr = `{
+        "name": null,
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s name is not a string. It will be ignored.');
     });
-    it('Should correctly parse Harlowe story format', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/harlowe.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.name).toBe('Harlowe');
+    it('Should produce warning if author is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": null,
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s author is not a string. It will be ignored.');
     });
-    it('Should detect missing name and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingName.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.name).toBe('Untitled Story Format');
+    it('Should produce warning if description is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": null,
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s description is not a string. It will be ignored.');
     });
-    it('Should detect missing author and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingAuthor.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.author).toBe('');
+    it('Should produce warning if image is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": null,
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s image is not a string. It will be ignored.');
     });
-    it('Should detect missing description and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingDescription.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.description).toBe('');
+    it('Should produce warning if url is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": null,
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s url is not a string. It will be ignored.');
     });
-    it('Should detect missing image and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingImage.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.image).toBe('');
+    it('Should produce warning if license is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": null,
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s license is not a string. It will be ignored.');
     });
-    it('Should detect missing url and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingURL.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.url).toBe('');
+    it('Should produce warning if proofing is not a boolean', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": null,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s proofing is not a boolean. It will be ignored.');
     });
-    it('Should detect missing license and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingLicense.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.license).toBe('');
+    it('Should produce warning if source is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": null
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s source is not a string! It will be ignored.');
     });
-    it('Should detect proofing license and set default', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingProofing.js', 'utf-8');
-      const sfp = parseStoryFormat(fr);
-      expect(sfp.proofing).toBe(false);
+    it('Should produce warning if source is missing', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "1.0.0",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format does not have source property!');
     });
-    it('Should throw error if version does not exist', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingVersion.js', 'utf-8');
-      expect(() => {
-        parseStoryFormat(fr);
-      }).toThrow();
+    it('Should produce warning if version is not a string', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": null,
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s version is not a string! It will be ignored.');
     });
-    it('Should throw error if version is not semantic style', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/versionWrong.js', 'utf-8');
-      expect(() => {
-        parseStoryFormat(fr);
-      }).toThrow();
+    it('Should produce warning if version is not semantic', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "version": "fake version",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format\'s version is not semantic! It will be ignored.');
     });
-    it('Should throw error if source is not found', () => {
-      const fr = readFileSync('test/StoryFormat/StoryFormatParser/missingSource.js', 'utf-8');
-      expect(() => {
-        parseStoryFormat(fr);
-      }).toThrow();
+    it('Should produce warning if version is missing', () => {
+      const fr = `{
+        "name": "My Story Format",
+        "author": "Twine",
+        "description": "A story format.",
+        "image": "icon.svg",
+        "url": "https://example.com",
+        "license": "MIT",
+        "proofing": true,
+        "source": "<html></html>"
+        }`;
+      // Parse the story format.
+      parseStoryFormat(fr);
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: Processed story format does not have version property!');
     });
   });
 });

package/test/StoryFormat.test.js CHANGED Viewed

@@ -1,8 +1,8 @@
 import StoryFormat from '../src/StoryFormat.js';
 describe('StoryFormat', () => {
-  describe('constructor()', () => {
-    it('Should create default values', () => {
+  describe('Default values', () => {
+    it('Should have default values', () => {
       const sf = new StoryFormat();
       expect(sf.name).toBe('Untitled Story Format');
       expect(sf.version).toBe('');
@@ -149,4 +149,11 @@ describe('StoryFormat', () => {
       }).toThrow();
     });
   });
+  describe('toString', () => {
+    it('Should return string representation', () => {
+      const sf = new StoryFormat();
+      expect(sf.toString()).toBe(JSON.stringify(sf, null, "\t"));
+    });
+  });
 });

package/test/TWS/Parse.test.js CHANGED Viewed

@@ -71,7 +71,7 @@ describe('TWSParser', () => {
         const contents = fs.readFileSync('test/TWS/TWSParser/noscale.tws', 'binary');
         const b = Buffer.from(contents, 'binary');
         const r = parseTWS(b);
-        expect(r.zoom).toBe(0);
+        expect(r.zoom).toBe(1);
       });
     });
   });

package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Parse.test.js CHANGED Viewed

@@ -3,10 +3,6 @@ import { readFileSync } from 'node:fs';
 describe('Twine2ArchiveHTML', function () {
   describe('parse()', function () {
-    it('Should throw error when given no Twine 2 HTML elements', function () {
-      expect(() => { parseTwine2ArchiveHTML(''); }).toThrow();
-    });
     it('Should throw error when content is not string', function () {
       expect(() => { parseTwine2ArchiveHTML(2); }).toThrow();
     });
@@ -22,4 +18,24 @@ describe('Twine2ArchiveHTML', function () {
       expect(stories.length).toBe(2);
     });
   });
+  describe('Warnings', function () {
+    beforeEach(() => {
+      // Mock console.warn.
+      jest.spyOn(console, 'warn').mockImplementation();
+    });
+    afterEach(() => {
+      // Restore all mocks.
+      jest.restoreAllMocks();
+    });
+    it('Should produce warning when no Twine 2 HTML content is found', function () {
+      // Parse Twine 2 Story.
+      parseTwine2ArchiveHTML('');
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: No Twine 2 HTML content found!');
+    });
+  });
 });