extwee 2.0.6 → 2.2.1

package/index.js

@@ -1,31 +1,29 @@
-import FileReader from './src/FileReader.js';
-import TweeParser from './src/TweeParser.js';
-import TweeWriter from './src/TweeWriter.js';
-import StoryFormatParser from './src/StoryFormatParser.js';
-import HTMLParser from './src/HTMLParser.js';
-import HTMLWriter from './src/HTMLWriter.js';
-import Story from './src/Story.js';
-import Passage from './src/Passage.js';
-import StoryFormat from './src/StoryFormat.js';
-
-export { FileReader };
-export { TweeParser };
-export { StoryFormat };
-export { Passage };
-export { Story };
-export { StoryFormatParser };
-export { HTMLParser };
-export { HTMLWriter };
-
-// Export everything by default
-export default {
-    readFile: FileReader.read,
-    parseTwee: TweeParser.parse,
-    writeTwee: TweeWriter.write,
-    StoryFormat,
-    Passage,
-    Story,
-    parseStoryFormat: StoryFormatParser.parse,
-    parseHTML: HTMLParser.parse,
-    writeHTML: HTMLWriter.write
-};
+import { parse as parseTwee } from './src/Twee/parse.js';
+import { parse as parseJSON } from './src/JSON/parse.js';
+import { parse as parseStoryFormat } from './src/StoryFormat/parse.js';
+import { parse as parseTwine1HTML } from './src/Twine1HTML/parse.js';
+import { parse as parseTwine2HTML } from './src/Twine2HTML/parse.js';
+import { parse as parseTwine2ArchiveHTML } from './src/Twine2ArchiveHTML/parse.js';
+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 Passage from './src/Passage.js';
+import StoryFormat from './src/StoryFormat.js';
+
+export {
+    parseTwee,
+    parseJSON,
+    parseTWS,
+    parseStoryFormat,
+    parseTwine1HTML,
+    parseTwine2HTML,
+    parseTwine2ArchiveHTML,
+    compileTwine1HTML,
+    compileTwine2HTML,
+    compileTwine2ArchiveHTML,
+    Story,
+    Passage,
+    StoryFormat
+};

package/package.json

@@ -1,58 +1,68 @@
-{
-  "name": "extwee",
-  "version": "2.0.6",
-  "description": "A Twee 3 compiler written in JS.",
-  "author": "Dan Cox",
-  "main": "index.js",
-  "bin": {
-    "extwee": "bin/extwee.js"
-  },
-  "scripts": {
-    "test": "jest --silent --runInBand --coverage --colors",
-    "lint": "eslint ./src/**/*.js --fix",
-    "lint:test": "eslint ./test/*.test.js --fix",
-    "all": "npm run lint && npm run lint:test && npm run test"
-  },
-  "keywords": [
-    "twine",
-    "twee",
-    "parser",
-    "compiler"
-  ],
-  "license": "MIT",
-  "dependencies": {
-    "commander": "^9.3.0",
-    "node-html-parser": "^5.3.3",
-    "semver": "^7.3.7",
-    "uuid": "^8.3.2"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.18.5",
-    "@babel/eslint-parser": "^7.12.1",
-    "@babel/eslint-plugin": "^7.12.1",
-    "@babel/plugin-proposal-class-properties": "^7.12.1",
-    "@babel/plugin-transform-runtime": "^7.18.5",
-    "@babel/preset-env": "^7.18.2",
-    "babel-loader": "^8.2.2",
-    "core-js": "^3.22.8",
-    "eslint": "^8.17.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-jest": "^26.5.3",
-    "eslint-plugin-jsdoc": "^39.3.2",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "jest": "^28.1.1",
-    "regenerator-runtime": "^0.13.9",
-    "shelljs": "^0.8.4"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/videlais/extwee"
-  },
-  "bugs": {
-    "url": "https://github.com/videlais/extwee/issues"
-  },
-  "type": "module"
-}
+{
+  "name": "extwee",
+  "version": "2.2.1",
+  "description": "A story compiler tool using Twine-compatible formats",
+  "author": "Dan Cox",
+  "main": "index.js",
+  "bin": {
+    "extwee": "src/extwee.js"
+  },
+  "scripts": {
+    "test": "jest --silent --runInBand --coverage --colors",
+    "lint": "eslint ./src/**/*.js --fix",
+    "lint:test": "eslint ./test/**/*.test.js --fix",
+    "build:web": "webpack",
+    "build:bin": "esbuild ./src/extwee.js --bundle --platform=node --target=node12 --outfile=out.js && pkg -t node18-macos-x64 out.js --output ./build/extwee && rm out.js",
+    "all": "npm run lint && npm run lint:test && npm run test"
+  },
+  "keywords": [
+    "twine",
+    "twee",
+    "parser",
+    "compiler"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "html-entities": "^2.4.0",
+    "node-html-parser": "^6.1.12",
+    "pickleparser": "^0.2.1",
+    "semver": "^7.5.4",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.7",
+    "@babel/eslint-parser": "^7.23.3",
+    "@babel/eslint-plugin": "^7.23.5",
+    "@babel/preset-env": "^7.23.8",
+    "babel-loader": "^9.1.3",
+    "clean-jsdoc-theme": "^4.2.17",
+    "core-js": "^3.35.0",
+    "docsify-cli": "^4.4.4",
+    "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.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.5",
+    "typescript": "^5.3.3",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/videlais/extwee"
+  },
+  "bugs": {
+    "url": "https://github.com/videlais/extwee/issues"
+  },
+  "type": "module",
+  "types": "./types/index.d.ts"
+}

package/src/JSON/parse.js

@@ -0,0 +1,128 @@
+import { Story } from '../Story.js';
+import Passage from '../Passage.js';
+
+/**
+ * Parse JSON representation into Story.
+ * @function parse
+ * @param {string} jsonString - JSON string to convert to Story.
+ * @returns {Story} Story object.
+ */
+function parse (jsonString) {
+  // Create future object.
+  let result = {};
+
+  // Create Story.
+  const s = new Story();
+
+  // Try to parse the string.
+  try {
+    result = JSON.parse(jsonString);
+  } catch (error) {
+    throw new Error('Invalid JSON!');
+  }
+
+  // Name
+  if (Object.prototype.hasOwnProperty.call(result, 'name')) {
+    // Convert to String (if not String).
+    s.name = String(result.name);
+  }
+
+  // Start Passage
+  if (Object.prototype.hasOwnProperty.call(result, 'start')) {
+    // Convert to String (if not String).
+    s.start = String(result.start);
+  }
+
+  // IFID
+  if (Object.prototype.hasOwnProperty.call(result, 'ifid')) {
+    // Convert to String (if not String).
+    // Enforce the uppercase rule of Twine 2 and Twee 3.
+    s.IFID = String(result.ifid).toUpperCase();
+  }
+
+  // Format
+  if (Object.prototype.hasOwnProperty.call(result, 'format')) {
+    // Convert to String (if not String).
+    s.format = String(result.format);
+  }
+
+  // Format Version
+  if (Object.prototype.hasOwnProperty.call(result, 'formatVersion')) {
+    // Convert to String (if not String).
+    s.formatVersion = String(result.formatVersion);
+  }
+
+  // Creator
+  if (Object.prototype.hasOwnProperty.call(result, 'creator')) {
+    // Convert to String (if not String).
+    s.creator = String(result.creator);
+  }
+
+  // Creator Version
+  if (Object.prototype.hasOwnProperty.call(result, 'creatorVersion')) {
+    // Convert to String (if not String).
+    s.creatorVersion = String(result.creatorVersion);
+  }
+
+  // Zoom
+  if (Object.prototype.hasOwnProperty.call(result, 'zoom')) {
+    // Set Zoom.
+    s.zoom = result.zoom;
+  }
+
+  // Tag Colors
+  if (Object.prototype.hasOwnProperty.call(result, 'tagColors')) {
+    // Set tagColors.
+    s.tagColors = result.tagColors;
+  }
+
+  // Metadata
+  if (Object.prototype.hasOwnProperty.call(result, 'metadata')) {
+    // Set metadata.
+    s.metadata = result.metadata;
+  }
+
+  // Passages
+  if (Object.prototype.hasOwnProperty.call(result, 'passages')) {
+    // Is s an array?
+    if (Array.isArray(result.passages)) {
+      // For each passage, convert into Passage objects.
+      result.passages.forEach((p) => {
+        // Create default passage.
+        const newP = new Passage();
+
+        // Does s have a name?
+        if (Object.prototype.hasOwnProperty.call(p, 'name')) {
+          // Set name.
+          newP.name = p.name;
+        }
+
+        // Does s have tags?
+        if (Object.prototype.hasOwnProperty.call(p, 'tags')) {
+          // Set tags.
+          newP.tags = p.tags;
+        }
+
+        // Does s have metadata?
+        if (Object.prototype.hasOwnProperty.call(p, 'metadata')) {
+          // Set metadata.
+          newP.metadata = p.metadata;
+        }
+
+        // Does s have text?
+        if (Object.prototype.hasOwnProperty.call(p, 'text')) {
+          // Set text.
+          newP.text = p.text;
+        }
+
+        // Add the new passage.
+        s.addPassage(newP);
+      });
+    }
+  }
+
+  // Return Story.
+  return s;
+}
+
+export { parse };