extwee 2.3.1 → 2.3.3

package/test/Config/loadStoryFormat.test.js

@@ -1,13 +1,29 @@
-import { loadStoryFormat } from "../../src/CLI/ProcessConfig/loadStoryFormat.js";
-import { isDirectory } from "../../src/CLI/isDirectory.js";
-import { isFile } from "../../src/CLI/isFile.js";
-import { readDirectories } from "../../src/CLI/ProcessConfig/readDirectories.js";
-import { readFileSync } from "node:fs";
+import {jest} from '@jest/globals';
 
-jest.mock("../../src/CLI/isDirectory.js");
-jest.mock("../../src/CLI/isFile.js");
-jest.mock("../../src/CLI/ProcessConfig/readDirectories.js");
-jest.mock("node:fs");
+// Mock all dependencies before importing anything that uses them
+const mockIsDirectory = jest.fn();
+const mockIsFile = jest.fn();
+const mockReadDirectories = jest.fn();
+const mockReadFileSync = jest.fn();
+
+jest.unstable_mockModule("../../src/CLI/isDirectory.js", () => ({
+    isDirectory: mockIsDirectory
+}));
+
+jest.unstable_mockModule("../../src/CLI/isFile.js", () => ({
+    isFile: mockIsFile
+}));
+
+jest.unstable_mockModule("../../src/CLI/ProcessConfig/readDirectories.js", () => ({
+    readDirectories: mockReadDirectories
+}));
+
+jest.unstable_mockModule("node:fs", () => ({
+    readFileSync: mockReadFileSync
+}));
+
+// Now import the modules that depend on the mocked modules
+const { loadStoryFormat } = await import("../../src/CLI/ProcessConfig/loadStoryFormat.js");
 
 describe("loadStoryFormat", () => {
     afterEach(() => {
@@ -15,7 +31,7 @@ describe("loadStoryFormat", () => {
     });
 
     it("should throw an error if the story-formats directory does not exist", () => {
-        isDirectory.mockReturnValueOnce(false);
+        mockIsDirectory.mockReturnValueOnce(false);
 
         expect(() => loadStoryFormat("Harlowe", "3.2.0")).toThrow(
             "Error: story-formats directory does not exist. Consider running 'npx sfa-get' to download the latest story formats."
@@ -23,7 +39,7 @@ describe("loadStoryFormat", () => {
     });
 
     it("should throw an error if the named story format directory does not exist", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(false);
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(false);
 
         expect(() => loadStoryFormat("Harlowe", "3.2.0")).toThrow(
             "Error: story format Harlowe does not exist in the story-formats directory."
@@ -31,7 +47,7 @@ describe("loadStoryFormat", () => {
     });
 
     it("should throw an error if the version directory does not exist", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true).mockReturnValueOnce(false);
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true).mockReturnValueOnce(false);
 
         expect(() => loadStoryFormat("Harlowe", "3.2.0")).toThrow(
             "Error: story format Harlowe version 3.2.0 does not exist in the story-formats directory."
@@ -39,8 +55,8 @@ describe("loadStoryFormat", () => {
     });
 
     it("should throw an error if the format.js file does not exist in the version directory", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true).mockReturnValueOnce(true);
-        isFile.mockReturnValueOnce(false);
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true).mockReturnValueOnce(true);
+        mockIsFile.mockReturnValueOnce(false);
 
         expect(() => loadStoryFormat("Harlowe", "3.2.0")).toThrow(
             "Error: story format Harlowe version 3.2.0 does not have a format.js file."
@@ -48,29 +64,29 @@ describe("loadStoryFormat", () => {
     });
 
     it("should return the contents of the format.js file if all checks pass", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true).mockReturnValueOnce(true);
-        isFile.mockReturnValueOnce(true);
-        readFileSync.mockReturnValueOnce("format.js content");
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true).mockReturnValueOnce(true);
+        mockIsFile.mockReturnValueOnce(true);
+        mockReadFileSync.mockReturnValueOnce("format.js content");
 
         const result = loadStoryFormat("Harlowe", "3.2.0");
         expect(result).toBe("format.js content");
     });
 
     it("should handle 'latest' version and return the contents of the format.js file", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
-        isFile.mockReturnValueOnce(false).mockReturnValueOnce(true);
-        readDirectories.mockReturnValueOnce(["3.2.0", "3.1.0"]);
-        readFileSync.mockReturnValueOnce("latest format.js content");
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
+        mockIsFile.mockReturnValueOnce(false).mockReturnValueOnce(true);
+        mockReadDirectories.mockReturnValueOnce(["3.2.0", "3.1.0"]);
+        mockReadFileSync.mockReturnValueOnce("latest format.js content");
 
         const result = loadStoryFormat("Harlowe", "latest");
         expect(result).toBe("latest format.js content");
-        expect(readDirectories).toHaveBeenCalledWith("story-formats/Harlowe");
+        expect(mockReadDirectories).toHaveBeenCalledWith("story-formats/Harlowe");
     });
 
     it("should throw an error if 'latest' version has no format.js file", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
-        isFile.mockReturnValueOnce(false).mockReturnValueOnce(false);
-        readDirectories.mockReturnValueOnce(["3.2.0", "3.1.0"]);
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
+        mockIsFile.mockReturnValueOnce(false).mockReturnValueOnce(false);
+        mockReadDirectories.mockReturnValueOnce(["3.2.0", "3.1.0"]);
 
         expect(() => loadStoryFormat("Harlowe", "latest")).toThrow(
             "Error: story format Harlowe version latest does not have a format.js file."
@@ -78,20 +94,20 @@ describe("loadStoryFormat", () => {
     });
 
     it("should read format.js file from the story format directory if it exists", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
-        isFile.mockReturnValueOnce(true);
-        readDirectories.mockReturnValueOnce([]);
-        readFileSync.mockReturnValueOnce("latest format.js content");
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
+        mockIsFile.mockReturnValueOnce(true);
+        mockReadDirectories.mockReturnValueOnce([]);
+        mockReadFileSync.mockReturnValueOnce("latest format.js content");
 
         const result = loadStoryFormat("Harlowe", "latest");
         expect(result).toBe("latest format.js content");
-        expect(readFileSync).toHaveBeenCalledWith("story-formats/Harlowe/format.js", "utf-8");
+        expect(mockReadFileSync).toHaveBeenCalledWith("story-formats/Harlowe/format.js", "utf-8");
     });
 
     it("should throw an error if the story format version is not 'latest' and version directories do not exist", () => {
-        isDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
-        isFile.mockReturnValueOnce(false);
-        readDirectories.mockReturnValueOnce([]);
+        mockIsDirectory.mockReturnValueOnce(true).mockReturnValueOnce(true);
+        mockIsFile.mockReturnValueOnce(false);
+        mockReadDirectories.mockReturnValueOnce([]);
 
         expect(() => loadStoryFormat("Harlowe", "latest")).toThrow(
             `Error: story format Harlowe does not have any version directories.`

package/test/Config/readDirectories.test.js

@@ -1,9 +1,19 @@
-import { readDirectories } from '../../src/CLI/ProcessConfig/readDirectories.js';
-import { readdirSync } from 'node:fs';
-import { isDirectory } from '../../src/CLI/isDirectory.js';
+import {jest} from '@jest/globals';
 
-jest.mock('node:fs');
-jest.mock('../../src/CLI/isDirectory.js');
+// Mock the fs module and isDirectory before importing anything that uses them
+const mockReaddirSync = jest.fn();
+const mockIsDirectory = jest.fn();
+
+jest.unstable_mockModule('node:fs', () => ({
+    readdirSync: mockReaddirSync
+}));
+
+jest.unstable_mockModule('../../src/CLI/isDirectory.js', () => ({
+    isDirectory: mockIsDirectory
+}));
+
+// Now import the modules that depend on the mocked modules
+const { readDirectories } = await import('../../src/CLI/ProcessConfig/readDirectories.js');
 
 describe('readDirectories', () => {
     afterEach(() => {
@@ -12,7 +22,7 @@ describe('readDirectories', () => {
 
     it('should return an empty array and log an error if the directory does not exist', () => {
         const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-        isDirectory.mockReturnValue(false);
+        mockIsDirectory.mockReturnValue(false);
 
         const result = readDirectories('/nonexistent');
 
@@ -23,8 +33,8 @@ describe('readDirectories', () => {
 
     it('should return an empty array and log an error if readdirSync throws an error', () => {
         const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-        isDirectory.mockReturnValue(true);
-        readdirSync.mockImplementation(() => {
+        mockIsDirectory.mockReturnValue(true);
+        mockReaddirSync.mockImplementation(() => {
             throw new Error('Permission denied');
         });
 
@@ -36,8 +46,8 @@ describe('readDirectories', () => {
     });
 
     it('should return an empty array if the directory is empty', () => {
-        isDirectory.mockReturnValue(true);
-        readdirSync.mockReturnValue([]);
+        mockIsDirectory.mockReturnValue(true);
+        mockReaddirSync.mockReturnValue([]);
 
         const result = readDirectories('/empty');
 
@@ -45,10 +55,10 @@ describe('readDirectories', () => {
     });
 
     it('should return an array of directories', () => {
-        isDirectory.mockReturnValue(true);
-        readdirSync.mockReturnValue(['dir1', 'file1', 'dir2']);
+        mockIsDirectory.mockReturnValue(true);
+        mockReaddirSync.mockReturnValue(['dir1', 'file1', 'dir2']);
 
-        isDirectory.mockImplementation((path) => {
+        mockIsDirectory.mockImplementation((path) => {
             return path === '/test/dir1' || path === '/test/dir2';
         });
 
@@ -58,8 +68,8 @@ describe('readDirectories', () => {
     });
     
     it('should return an empty array if the result is not an array', () => {
-        isDirectory.mockReturnValue(true);
-        readdirSync.mockReturnValue('not an array');
+        mockIsDirectory.mockReturnValue(true);
+        mockReaddirSync.mockReturnValue('not an array');
 
         const result = readDirectories('/test');
 

package/test/Objects/Story.test.js

@@ -1,3 +1,4 @@
+import {jest} from '@jest/globals';
 import { Story, creatorName, creatorVersion } from '../../src/Story.js';
 import Passage from '../../src/Passage.js';
 import { parse as parseTwee } from '../../src/Twee/parse.js';

package/test/StoryFormat/StoryFormat.Parse.test.js

@@ -1,3 +1,4 @@
+import {jest} from '@jest/globals';
 import { parse as parseStoryFormat } from '../../src/StoryFormat/parse.js';
 
 describe('StoryFormat', () => {

package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Parse.test.js

@@ -1,3 +1,4 @@
+import {jest} from '@jest/globals';
 import { parse as parseTwine2ArchiveHTML } from '../../src/Twine2ArchiveHTML/parse.js';
 import { readFileSync } from 'node:fs';
 

package/test/Twine2HTML/Twine2HTML.Parse.test.js

@@ -1,3 +1,4 @@
+import {jest} from '@jest/globals';
 import { readFileSync } from 'node:fs';
 import { parse as parseTwine2HTML } from '../../src/Twine2HTML/parse.js';
 

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

@@ -2,41 +2,48 @@
  * @jest-environment jsdom
  */
 
-import '../../web-index.js';
+// Load the core web module to set up window.Extwee
+import '../../src/Web/web-index.js';
 
 describe('Extwee', () => {
-    it('should have all the expected properties', () => {
+    it('should have all the expected immediate properties', () => {
+        // Core functionality that's immediately available
         expect(window.Extwee).toHaveProperty('parseTwee');
         expect(window.Extwee).toHaveProperty('parseJSON');
-        expect(window.Extwee).toHaveProperty('parseTWS');
         expect(window.Extwee).toHaveProperty('parseStoryFormat');
-        expect(window.Extwee).toHaveProperty('parseTwine1HTML');
         expect(window.Extwee).toHaveProperty('parseTwine2HTML');
-        expect(window.Extwee).toHaveProperty('parseTwine2ArchiveHTML');
-        expect(window.Extwee).toHaveProperty('compileTwine1HTML');
         expect(window.Extwee).toHaveProperty('compileTwine2HTML');
-        expect(window.Extwee).toHaveProperty('compileTwine2ArchiveHTML');
         expect(window.Extwee).toHaveProperty('generateIFID');
         expect(window.Extwee).toHaveProperty('Story');
         expect(window.Extwee).toHaveProperty('Passage');
         expect(window.Extwee).toHaveProperty('StoryFormat');
+        
+        // Additional parsers available in unified build
+        expect(window.Extwee).toHaveProperty('parseTwine1HTML');
+        expect(window.Extwee).toHaveProperty('parseTwine2ArchiveHTML');
+        expect(window.Extwee).toHaveProperty('parseTWS');
+        expect(window.Extwee).toHaveProperty('compileTwine1HTML');
+        expect(window.Extwee).toHaveProperty('compileTwine2ArchiveHTML');
     });
 
-    it('should have the expected types', () => {
+    it('should have the expected types for immediate functions', () => {
+        // Core functionality
         expect(typeof window.Extwee.parseTwee).toBe('function');
         expect(typeof window.Extwee.parseJSON).toBe('function');
-        expect(typeof window.Extwee.parseTWS).toBe('function');
         expect(typeof window.Extwee.parseStoryFormat).toBe('function');
-        expect(typeof window.Extwee.parseTwine1HTML).toBe('function');
         expect(typeof window.Extwee.parseTwine2HTML).toBe('function');
-        expect(typeof window.Extwee.parseTwine2ArchiveHTML).toBe('function');
-        expect(typeof window.Extwee.compileTwine1HTML).toBe('function');
         expect(typeof window.Extwee.compileTwine2HTML).toBe('function');
-        expect(typeof window.Extwee.compileTwine2ArchiveHTML).toBe('function');
         expect(typeof window.Extwee.generateIFID).toBe('function');
         expect(typeof window.Extwee.Story).toBe('function');
         expect(typeof window.Extwee.Passage).toBe('function');
         expect(typeof window.Extwee.StoryFormat).toBe('function');
+        
+        // Additional parsers
+        expect(typeof window.Extwee.parseTwine1HTML).toBe('function');
+        expect(typeof window.Extwee.parseTwine2ArchiveHTML).toBe('function');
+        expect(typeof window.Extwee.parseTWS).toBe('function');
+        expect(typeof window.Extwee.compileTwine1HTML).toBe('function');
+        expect(typeof window.Extwee.compileTwine2ArchiveHTML).toBe('function');
     });
 
     it('should have the expected properties in StoryFormat', () => {

package/types/src/Story.d.ts

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

package/types/src/Twine1HTML/parse-web.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Web-optimized Twine 1 HTML parser with reduced dependencies
+ * Parses Twine 1 HTML into a Story object using lightweight DOM parsing
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md Twine 1 HTML Documentation}
+ * @function parse
+ * @param {string} content - Twine 1 HTML content to parse.
+ * @returns {Story} Story object
+ */
+export function parse(content: string): Story;
+import { Story } from '../Story.js';

package/types/src/Twine2ArchiveHTML/parse-web.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Web-optimized Twine 2 Archive HTML parser with reduced dependencies
+ * Parse Twine 2 Archive HTML and returns an array of story objects using browser DOM APIs.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-archive-spec.md Twine 2 Archive Specification}
+ * @function parse
+ * @param {string} content - Content to parse for Twine 2 HTML elements.
+ * @throws {TypeError} - Content is not a string!
+ * @returns {Array} Array of stories found in content.
+ * @example
+ * const content = '<tw-storydata name="Untitled" startnode="1" creator="Twine" creator-version="2.3.9" ifid="A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6" zoom="1" format="Harlowe" format-version="3.1.0" options="" 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="Untitled Passage" tags="" position="0,0" size="100,100"></tw-passagedata></tw-storydata>';
+ * console.log(parse(content));
+ * // => [
+ * //     Story {
+ * //      name: 'Untitled',
+ * //      startnode: '1',
+ * //      creator: 'Twine',
+ * //      creatorVersion: '2.3.9',
+ * //      ifid: 'A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6',
+ * //      zoom: '1',
+ * //      format: 'Harlowe',
+ * //      formatVersion: '3.1.0',
+ * //      options: '',
+ * //      hidden: '',
+ * //      passages: [
+ * //        Passage {
+ * //          pid: '1',
+ * //          name: 'Untitled Passage',
+ * //          tags: '',
+ * //          position: '0,0',
+ * //          size: '100,100',
+ * //          text: ''
+ * //        }
+ * //      ]
+ * //    }
+ * //   ]
+ */
+export function parse(content: string): any[];

package/types/src/Twine2HTML/parse-web.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Web-optimized Twine 2 HTML parser with reduced dependencies
+ * Parse Twine 2 HTML into Story object using lightweight DOM parsing
+ *
+ * See: Twine 2 HTML Output Specification
+ * (https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md)
+ *
+ * Produces warnings for:
+ * - Missing name attribute on `<tw-storydata>` element.
+ * - Missing IFID attribute on `<tw-storydata>` element.
+ * - Malformed IFID attribute on `<tw-storydata>` element.
+ * @function parse
+ * @param {string} content - Twine 2 HTML content to parse.
+ * @returns {Story} Story object based on Twine 2 HTML content.
+ * @throws {TypeError} Content is not a string.
+ * @throws {Error} Not Twine 2 HTML content!
+ * @throws {Error} Cannot parse passage data without name!
+ * @throws {Error} Passages are required to have PID!
+ */
+export function parse(content: string): Story;
+import { Story } from '../Story.js';

package/types/src/Web/html-entities-lite.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Encode HTML entities
+ * @param {string} str - String to encode
+ * @returns {string} Encoded string
+ */
+export function encode(str: string): string;
+/**
+ * Decode HTML entities
+ * @param {string} str - String to decode
+ * @returns {string} Decoded string
+ */
+export function decode(str: string): string;

package/types/src/Web/semver-lite.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Lightweight semantic version validation for web builds
+ * This replaces the full semver package to reduce bundle size
+ */
+/**
+ * Validates if a string is a valid semantic version
+ * @param {string} version - Version string to validate
+ * @returns {string|null} Returns the version if valid, null if invalid
+ */
+export function valid(version: string): string | null;

package/types/src/Web/uuid-lite.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Lightweight UUID v4 generator for web builds
+ * This replaces the full uuid package to reduce bundle size
+ * @returns {string} A randomly generated UUID v4 string
+ */
+export function v4(): string;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,2 @@
+export { parseTWS as parse };
+import { parse as parseTWS } from '../TWS/parse.js';

package/webpack.config.js

@@ -3,10 +3,30 @@ import path from 'node:path';
 export default {
   mode: 'production',
   entry: {
-    'extwee.web.min': './web-index.js'
+    // Core bundle with most common functionality
+    'extwee.core': './src/Web/web-core.js',
+    // Individual parser modules
+    'extwee.twine1html': './src/Web/web-twine1html.js',
+    'extwee.twine2archive': './src/Web/web-twine2archive.js',
+    'extwee.tws': './src/Web/web-tws.js'
   },
   output: {
     path: path.resolve('./', 'build'),
-    filename: '[name].js',
+    filename: '[name].min.js',
+    library: {
+      type: 'umd',
+      name: 'Extwee' // Use a single library name for all modules
+    },
+    globalObject: 'this'
   },
+  optimization: {
+    usedExports: true,
+    sideEffects: false,
+    splitChunks: false // Don't split chunks for individual modules
+  },
+  performance: {
+    maxAssetSize: 250000, // 244 KiB
+    maxEntrypointSize: 250000,
+    hints: 'warning'
+  }
 };