extwee 2.3.11 → 2.3.12

package/test/Objects/Passage.test.js

@@ -1,274 +0,0 @@
-import Passage from '../../src/Passage.js';
-import { parse as HTMLParser } from 'node-html-parser';
-
-describe('Passage', () => {
-  describe('constructor()', () => {
-    it('Set default values', () => {
-      const p = new Passage();
-      expect(p.name).toBe('');
-      expect(p.tags).toHaveLength(0);
-      expect(p.text).toBe('');
-      expect(typeof p.metadata).toBe('object');
-    });
-  });
-
-  describe('name', () => {
-    it('Set name', () => {
-      const p = new Passage();
-      p.name = 'New';
-      expect(p.name).toBe('New');
-    });
-
-    it('Throw error if name is not String', () => {
-      const p = new Passage();
-      expect(() => {
-        p.name = 1;
-      }).toThrow();
-    });
-  });
-
-  describe('tags', () => {
-    it('Set tags', () => {
-      const p = new Passage();
-      p.tags = ['tag'];
-      expect(p.tags).toHaveLength(1);
-    });
-
-    it('Throw error if tags is not Array', () => {
-      const p = new Passage();
-      expect(() => {
-        p.tags = 1;
-      }).toThrow();
-    });
-  });
-
-  describe('metadata', () => {
-    it('Set metadata', () => {
-      const p = new Passage();
-      p.metadata = { position: '100,100' };
-      expect(p.metadata).toEqual({ position: '100,100' });
-    });
-
-    it('Throw error if metadata is not an Object', () => {
-      const p = new Passage();
-      expect(() => {
-        p.metadata = 1;
-      }).toThrow();
-    });
-  });
-
-  describe('text', () => {
-    it('Set text', () => {
-      const p = new Passage();
-      p.text = 'New';
-      expect(p.text).toBe('New');
-    });
-
-    it('Throw error if text is not a String', () => {
-      const p = new Passage();
-      expect(() => {
-        p.text = 1;
-      }).toThrow();
-    });
-  });
-
-  describe('toTwee()', () => {
-    it('Create name string', () => {
-      const p = new Passage('Name', 'Test');
-      expect(p.toTwee()).toBe(':: Name\nTest\n\n');
-    });
-    it('Create tags string', () => {
-      const p = new Passage('Name', 'Test', ['tags', 'another']);
-      expect(p.toTwee()).toBe(':: Name [tags another]\nTest\n\n');
-    });
-    it('Create metadata string', () => {
-      const p = new Passage('Name', 'Test', ['tags', 'another'], { position: '100,100' });
-      expect(p.toTwee()).toBe(':: Name [tags another] {"position":"100,100"}\nTest\n\n');
-    });
-  });
-
-  describe('toJSON()', function () {
-    it('Should hold default values', function () {
-      const p = new Passage();
-      const r = JSON.parse(p.toJSON());
-      expect(r.name).toBe('');
-      expect(r.text).toBe('');
-      expect(r.tags.length).toBe(0);
-      expect(Object.keys(r.metadata).length).toBe(0);
-    });
-  });
-
-  describe('toTwine2HTML()', function () {
-    let p = null;
-    let result = null;
-
-    beforeEach(() => {
-      p = new Passage('Test', 'Word', ['tag1'], { some: 'thing' });
-      result = p.toTwine2HTML();
-    });
-
-    it('Should contain default PID', function () {
-      expect(result.includes('pid="1"')).toBe(true);
-    });
-
-    it('Should include name', function () {
-      expect(result.includes('name="Test"')).toBe(true);
-    });
-
-    it('Should include single tag', function () {
-      expect(result.includes('tags="tag1"')).toBe(true);
-    });
-
-    it('Should include multiple tags', function () {
-      p.tags = ['tag1', 'tag2'];
-      result = p.toTwine2HTML();
-      expect(result.includes('tags="tag1 tag2"')).toBe(true);
-    });
-
-    it('Should include position, if it exists', function () {
-      p.metadata = { position: '102,99' };
-      result = p.toTwine2HTML();
-      expect(result.includes('position="102,99"')).toBe(true);
-    });
-
-    it('Should include size, if it exists', function () {
-      p.metadata = { size: '100,100' };
-      result = p.toTwine2HTML();
-      expect(result.includes('size="100,100"')).toBe(true);
-    });
-  });
-
-  describe('toTwine1HTML()', function () {
-    let p = null;
-    let result = null;
-
-    beforeEach(() => {
-      p = new Passage('Test', 'Word', ['tag1'], { position: '12, 12' });
-      result = p.toTwine1HTML();
-    });
-
-    it('Should include tiddler', function () {
-      expect(result.includes('tiddler="Test"')).toBe(true);
-    });
-
-    it('Should include single tag', function () {
-      expect(result.includes('tags="tag1"')).toBe(true);
-    });
-
-    it('Should include multiple tags', function () {
-      p.tags = ['tag1', 'tag2'];
-      result = p.toTwine1HTML();
-      expect(result.includes('tags="tag1 tag2"')).toBe(true);
-    });
-
-    it('Should include position, if it exists', function () {
-      p.metadata = { position: '102,99' };
-      result = p.toTwine1HTML();
-      expect(result.includes('position="102,99"')).toBe(true);
-    });
-
-    it('Should use default position', function () {
-      p.metadata = {};
-      result = p.toTwine1HTML();
-      expect(result.includes('position="10,10"')).toBe(true);
-    });
-  });
-
-  describe('Escaping', function () {
-    it('Should HTML-encode passage text content with double quotes', function () {
-      const p = new Passage('Test', 'Word "word"');
-      // Passage text MUST be HTML-encoded for valid HTML output
-      expect(p.toTwine2HTML().includes('"word"')).toBe(true);
-      expect(p.toTwine2HTML().includes('>Word "word"<')).toBe(false);
-    });
-
-    it('Should HTML-encode passage text content with ampersands', function () {
-      const p = new Passage('Test', 'Word & word');
-      // Passage text MUST be HTML-encoded
-      expect(p.toTwine2HTML().includes('&amp;')).toBe(true);
-      expect(p.toTwine2HTML().includes('>Word & word<')).toBe(false);
-    });
-
-    it('Should HTML-encode passage text content with less than', function () {
-      const p = new Passage('Test', 'Word < word');
-      // Passage text MUST be HTML-encoded
-      expect(p.toTwine2HTML().includes('&lt;')).toBe(true);
-      expect(p.toTwine2HTML().includes('>Word < word<')).toBe(false);
-    });
-
-    it('Should HTML-encode passage text content with greater than', function () {
-      const p = new Passage('Test', 'Word > word');
-      // Passage text MUST be HTML-encoded
-      expect(p.toTwine2HTML().includes('&gt;')).toBe(true);
-      expect(p.toTwine2HTML().includes('>Word > word<')).toBe(false);
-    });
-
-    it('Should HTML-encode passage text content with special characters', function () {
-      const p = new Passage('Test', 'Word &<>"\' word');
-      // Passage text MUST be HTML-encoded
-      expect(p.toTwine2HTML().includes('&amp;')).toBe(true);
-      expect(p.toTwine2HTML().includes('&lt;')).toBe(true);
-      expect(p.toTwine2HTML().includes('&gt;')).toBe(true);
-      expect(p.toTwine2HTML().includes('&quot;')).toBe(true);
-      // Single quotes can be encoded as either &apos; or &#39;
-      const html = p.toTwine2HTML();
-      expect(html.includes('&apos;') || html.includes('&#39;')).toBe(true);
-      expect(html.includes('>Word &<>"\' word<')).toBe(false);
-    });
-
-    it('Should escape meta-characters safely in name attribute', function () {
-      const p = new Passage('"Test"');
-      // Attributes SHOULD be HTML-encoded
-      expect(p.toTwine2HTML().includes('name="&quot;Test&quot;"')).toBe(true);
-      expect(p.toTwine1HTML().includes('tiddler="&quot;Test&quot;"')).toBe(true);
-    });
-
-    it('Should HTML-encode passage text including JavaScript/HTML code', function () {
-      const p = new Passage('Test', '<%\n$.getScript("https://example.com/script.js");\n%>');
-      const html = p.toTwine2HTML();
-      // JavaScript code in passages MUST be HTML-encoded in the HTML file
-      // The story format will retrieve it via .innerHTML which decodes entities automatically
-      expect(html.includes('&lt;%')).toBe(true);
-      expect(html.includes('%&gt;')).toBe(true);
-      expect(html.includes('&quot;https://example.com/script.js&quot;')).toBe(true);
-      // Raw characters should NOT appear in the HTML
-      expect(html.includes('$.getScript("https://example.com/script.js");')).toBe(false);
-    });
-
-    it('Should escape meta-characters safely in tags attribute', function () {
-      const p = new Passage('Test', 'Word', ['&tag', '"bad"']);
-      // Attributes SHOULD be HTML-encoded
-      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');
-    });
-
-    it('Should escape double-colon at start of text when exporting to Twee', function () {
-      const p = new Passage('test', ':: nefarious');
-      expect(p.toTwee()).toBe(':: test\n\\:: nefarious\n\n');
-    });
-  });
-});

package/test/Objects/SnowmanCompatibility.test.js

@@ -1,111 +0,0 @@
-import Passage from '../../src/Passage.js';
-import { Story } from '../../src/Story.js';
-
-describe('Snowman Compatibility Tests', function () {
-  describe('JavaScript Code in Passages', function () {
-    it('Should not HTML-encode JavaScript with quotes', function () {
-      const p = new Passage('External', '<%\n$.getScript("https://code.jquery.com/jquery-3.6.0.min.js");\n%>');
-      const html = p.toTwine2HTML();
-      
-      // Should NOT have HTML entities
-      expect(html.includes('&quot;')).toBe(true);
-      expect(html.includes('&lt;')).toBe(true);
-      expect(html.includes('&gt;')).toBe(true);
-    });
-
-    it('Should preserve complex JavaScript code', function () {
-      const code = `<%
-var data = {"key": "value", "test": true};
-if (data.test) {
-  console.log("This is a test");
-}
-%>`;
-      const p = new Passage('Test', code);
-      const html = p.toTwine2HTML();
-      
-      expect(html.includes('&quot;')).toBe(true);
-      expect(html.includes('&lt;')).toBe(true);
-      expect(html.includes('&gt;')).toBe(true);
-    });
-  });
-
-  describe('HTML Content in Passages', function () {
-    it('Should not HTML-encode HTML tags', function () {
-      const p = new Passage('HUD', '<h1>This is the HUD!</h1>\n<p>Status: <strong>Active</strong></p>');
-      const html = p.toTwine2HTML();
-      
-      // Should NOT have HTML entities
-      expect(html.includes('&lt;h1&gt;')).toBe(true);
-      expect(html.includes('&lt;strong&gt;')).toBe(true);
-    });
-
-    it('Should preserve nested HTML structures', function () {
-      const htmlContent = `<div class="container">
-  <h2>Title</h2>
-  <ul>
-    <li>Item 1</li>
-    <li>Item 2</li>
-  </ul>
-</div>`;
-      const p = new Passage('Container', htmlContent);
-      const html = p.toTwine2HTML();
-      
-      expect(html.includes('&lt;')).toBe(true);
-      expect(html.includes('&gt;')).toBe(true);
-    });
-  });
-
-  describe('Round-trip Compatibility', function () {
-    it('Should round-trip JavaScript code correctly', function () {
-      const code = '$.getScript("test.js");';
-      const p1 = new Passage('Test', code);
-      const html = p1.toTwine2HTML();
-      
-      // Verify that the quotation marks is encoded.
-      expect(html.includes('&quot')).toBe(true);
-    });
-
-    it('Should generate valid Story HTML with unencoded content', function () {
-      const story = new Story();
-      story.name = 'Test Story';
-      story.IFID = 'TEST-IFID-1234';
-      
-      const p1 = new Passage('Start', '<%\nconsole.log("test");\n%>');
-      const p2 = new Passage('HUD', '<h1>Header</h1>');
-      
-      story.passages = [p1, p2];
-      
-      const html = story.toTwine2HTML();
-      
-      // Verify both passages have encoded content.
-      expect(html.includes('&quot;')).toBe(true);
-      expect(html.includes('&lt;h1&gt;')).toBe(true);
-    });
-  });
-
-  describe('Edge Cases', function () {
-    it('Should handle CDATA-like content', function () {
-      const content = '<![CDATA[Some data]]>';
-      const p = new Passage('Test', content);
-      const html = p.toTwine2HTML();
-      
-      expect(html.includes('&lt;![CDATA[Some data]]&gt;')).toBe(true);
-    });
-
-    it('Should handle mixed quotes', function () {
-      const content = `var str = "She said 'hello' to me";`;
-      const p = new Passage('Test', content);
-      const html = p.toTwine2HTML();
-      
-      expect(html.includes('&quot;')).toBe(true);
-    });
-
-    it('Should handle template literals', function () {
-      const content = 'const msg = `Hello ${name}`;';
-      const p = new Passage('Test', content);
-      const html = p.toTwine2HTML();
-      
-      expect(html.includes(content)).toBe(true);
-    });
-  });
-});