extwee 2.3.3 → 2.3.5

package/test/Web/web-tws.test.js

@@ -0,0 +1,77 @@
+/**
+ * @jest-environment node
+ */
+
+/**
+ * Tests for web-tws.js module
+ * Tests module exports and functionality
+ */
+
+import { describe, expect, it } from '@jest/globals';
+
+// Import to test basic functionality
+import { parse } from '../../src/Web/web-tws.js';
+import Extwee from '../../src/Web/web-tws.js';
+
+describe('web-tws.js module tests', () => {
+
+  describe('ES6 module exports', () => {
+    it('should export parse function', () => {
+      expect(parse).toBeDefined();
+      expect(typeof parse).toBe('function');
+    });
+
+    it('should export default object with parseTWS', () => {
+      expect(Extwee.parseTWS).toBeDefined();
+      expect(Extwee.parse).toBeDefined();
+      expect(typeof Extwee.parseTWS).toBe('function');
+      expect(typeof Extwee.parse).toBe('function');
+    });
+  });
+
+  describe('Global object assignment', () => {
+    it('should assign functions to global object when available', () => {
+      // In Node.js environment, should assign to globalThis
+      expect(globalThis.Extwee).toBeDefined();
+      expect(globalThis.Extwee.parseTWS).toBeDefined();
+      expect(typeof globalThis.Extwee.parseTWS).toBe('function');
+    });
+
+    it('should preserve existing Extwee properties', () => {
+      // Should not overwrite the entire object, just add properties
+      if (globalThis.Extwee && globalThis.Extwee.version) {
+        expect(globalThis.Extwee.version).toBeDefined();
+      }
+      expect(globalThis.Extwee.parseTWS).toBeDefined();
+    });
+  });
+
+  describe('Functional integration tests', () => {
+    it('should have working parseTWS function', () => {
+      // Create a minimal valid TWS buffer (pickled data)
+      // This is a very basic test - TWS parsing is complex
+      const validBuffer = Buffer.from([
+        0x80, 0x02, // Python pickle protocol version 2
+        0x7d, 0x71, 0x00, // Empty dict
+        0x2e // STOP
+      ]);
+      
+      expect(() => {
+        const result = parse(validBuffer);
+        expect(result).toBeDefined();
+      }).not.toThrow();
+    });
+
+    it('should throw error for invalid input', () => {
+      expect(() => {
+        parse("not a buffer");
+      }).toThrow();
+    });
+
+    it('should have same functions in exports and global', () => {
+      // Test that parse is the same function
+      expect(parse).toBe(Extwee.parse);
+      expect(parse).toBe(Extwee.parseTWS);
+    });
+  });
+});

package/test/Web/window.Extwee.test.js

@@ -3,7 +3,12 @@
  */
 
 // Load the core web module to set up window.Extwee
-import '../../src/Web/web-index.js';
+import '../../src/Web/web-core.js';
+
+// Load additional modular parsers
+import '../../src/Web/web-twine1html.js';
+import '../../src/Web/web-twine2archive.js';
+import '../../src/Web/web-tws.js';
 
 describe('Extwee', () => {
     it('should have all the expected immediate properties', () => {
@@ -18,7 +23,7 @@ describe('Extwee', () => {
         expect(window.Extwee).toHaveProperty('Passage');
         expect(window.Extwee).toHaveProperty('StoryFormat');
         
-        // Additional parsers available in unified build
+        // Additional parsers loaded via modular imports
         expect(window.Extwee).toHaveProperty('parseTwine1HTML');
         expect(window.Extwee).toHaveProperty('parseTwine2ArchiveHTML');
         expect(window.Extwee).toHaveProperty('parseTWS');

package/types/src/Story.d.ts

@@ -251,5 +251,5 @@ export class Story {
     #private;
 }
 export const creatorName: "extwee";
-export const creatorVersion: "2.3.3";
+export const creatorVersion: "2.3.5";
 import Passage from './Passage.js';

package/types/src/Twee/parse.d.ts

@@ -6,4 +6,25 @@
  * @returns {Story} story
  */
 export function parse(fileContents: string): Story;
+/**
+ * Escapes Twee 3 metacharacters according to the specification.
+ * This is used when writing Twee files to ensure special characters are properly escaped.
+ * @function escapeTweeMetacharacters
+ * @param {string} text - Text to escape
+ * @returns {string} Escaped text
+ */
+export function escapeTweeMetacharacters(text: string): string;
+/**
+ * Unescapes Twee 3 metacharacters according to the specification.
+ *
+ * From the Twee 3 specification:
+ * - Encoding: To avoid ambiguity, non-escape backslashes must also be escaped via
+ * the same mechanism (i.e. `foo\bar` must become `foo\\bar`).
+ * - Decoding: To make decoding more robust, any escaped character within a chunk of
+ * encoded text must yield the character minus the backslash (i.e. `\q` must yield `q`).
+ * @function unescapeTweeMetacharacters
+ * @param {string} text - Text to unescape
+ * @returns {string} Unescaped text
+ */
+export function unescapeTweeMetacharacters(text: string): string;
 import { Story } from '../Story.js';

package/types/src/Web/web-core.d.ts

@@ -1 +1,23 @@
-export {};
+export default Extwee;
+import { parse as parseTwee } from '../Twee/parse.js';
+import { parse as parseJSON } from '../JSON/parse.js';
+import { parse as parseStoryFormat } from '../StoryFormat/parse.js';
+import { parse as parseTwine2HTML } from '../Twine2HTML/parse-web.js';
+import { compile as compileTwine2HTML } from '../Twine2HTML/compile.js';
+import { generate as generateIFID } from '../IFID/generate.js';
+import { Story } from '../Story.js';
+import Passage from '../Passage.js';
+import StoryFormat from '../StoryFormat.js';
+declare namespace Extwee {
+    export { parseTwee };
+    export { parseJSON };
+    export { parseStoryFormat };
+    export { parseTwine2HTML };
+    export { compileTwine2HTML };
+    export { generateIFID };
+    export { Story };
+    export { Passage };
+    export { StoryFormat };
+    export let version: string;
+}
+export { parseTwee, parseJSON, parseStoryFormat, parseTwine2HTML, compileTwine2HTML, generateIFID, Story, Passage, StoryFormat };

package/types/src/Web/web-twine1html.d.ts

@@ -1,3 +1,10 @@
+export default Extwee;
+declare namespace Extwee {
+    export { parseTwine1HTML };
+    export { compileTwine1HTML };
+    export { parseTwine1HTML as parse };
+    export { compileTwine1HTML as compile };
+}
 import { parse as parseTwine1HTML } from '../Twine1HTML/parse-web.js';
 import { compile as compileTwine1HTML } from '../Twine1HTML/compile.js';
 export { parseTwine1HTML as parse, compileTwine1HTML as compile };

package/types/src/Web/web-twine2archive.d.ts

@@ -1,3 +1,10 @@
+export default Extwee;
+declare namespace Extwee {
+    export { parseTwine2ArchiveHTML };
+    export { compileTwine2ArchiveHTML };
+    export { parseTwine2ArchiveHTML as parse };
+    export { compileTwine2ArchiveHTML as compile };
+}
 import { parse as parseTwine2ArchiveHTML } from '../Twine2ArchiveHTML/parse-web.js';
 import { compile as compileTwine2ArchiveHTML } from '../Twine2ArchiveHTML/compile.js';
 export { parseTwine2ArchiveHTML as parse, compileTwine2ArchiveHTML as compile };

package/types/src/Web/web-tws.d.ts

@@ -1,2 +1,7 @@
+export default Extwee;
 export { parseTWS as parse };
+declare namespace Extwee {
+    export { parseTWS };
+    export { parseTWS as parse };
+}
 import { parse as parseTWS } from '../TWS/parse.js';

package/webpack.config.js

@@ -15,7 +15,8 @@ export default {
     filename: '[name].min.js',
     library: {
       type: 'umd',
-      name: 'Extwee' // Use a single library name for all modules
+      name: 'Extwee', // Use a single library name for all modules
+      export: 'default'  // Export the default export directly
     },
     globalObject: 'this'
   },

package/src/Web/web-index.js

@@ -1,31 +0,0 @@
-import { parse as parseTwee } from '../Twee/parse.js';
-import { parse as parseJSON } from '../JSON/parse.js';
-import { parse as parseStoryFormat } from '../StoryFormat/parse.js';
-import { parse as parseTwine1HTML } from '../Twine1HTML/parse.js';
-import { parse as parseTwine2HTML } from '../Twine2HTML/parse.js';
-import { parse as parseTwine2ArchiveHTML } from '../Twine2ArchiveHTML/parse.js';
-import { parse as parseTWS } from '../TWS/parse.js';
-import { compile as compileTwine1HTML } from '../Twine1HTML/compile.js';
-import { compile as compileTwine2HTML } from '../Twine2HTML/compile.js';
-import { compile as compileTwine2ArchiveHTML } from '../Twine2ArchiveHTML/compile.js';
-import { generate as generateIFID } from '../IFID/generate.js';
-import { Story } from '../Story.js';
-import Passage from '../Passage.js';
-import StoryFormat from '../StoryFormat.js';
-
-window.Extwee = {
-    parseTwee,
-    parseJSON,
-    parseTWS,
-    parseStoryFormat,
-    parseTwine1HTML,
-    parseTwine2HTML,
-    parseTwine2ArchiveHTML,
-    compileTwine1HTML,
-    compileTwine2HTML,
-    compileTwine2ArchiveHTML,
-    generateIFID,
-    Story,
-    Passage,
-    StoryFormat
-};