extwee 2.2.1 → 2.2.2

package/.github/codeql-analysis.yml

@@ -0,0 +1,51 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ develop ]
+    paths-ignore:
+      - 'test/**'
+  pull_request:
+    branches: [ develop ]
+    paths-ignore:
+      - 'test/**'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        upload: false # disable the upload here - we will upload in a different action
+        output: sarif-results
+
+    - name: filter-sarif
+      uses: advanced-security/filter-sarif@v1
+      with:
+        # filter out all test files unless they contain a sql-injection vulnerability
+        patterns:
+          -test/**/*
+          +test/**/*:js/sql-injection
+        input: sarif-results/${{ matrix.language }}.sarif
+        output: sarif-results/${{ matrix.language }}.sarif
+
+    - name: Upload SARIF
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: sarif-results/${{ matrix.language }}.sarif

package/README.md

@@ -27,11 +27,11 @@
 
 ## Story Compilation
 
-The process of *story compilation* converts human-readable content, what is generally called a *story*, into a playable format such as HyperText Markup Language (HTML) able to be read by another application such as a web browser. The result is then presented as links or other visual, interactive elements to a player or reader, depending on the work created.
+The process of *story compilation* converts human-readable content, what is generally called a *story*, into a playable format such as HyperText Markup Language (HTML). The result is then presented as links or other visual, interactive elements for another party to interact with to see its content.
 
-The term *compilation* is used because different parts of code are put together in a specific arrangement to enable later play. As part of Twine-compatible HTML, this means combining story format JavaScript code with story HTML data.
+The term *compilation* is used because different parts of code are put together in a specific arrangement to enable later play. As part of Twine-compatible HTML, this means combining JavaScript code (generally a "story format") with story HTML data.
 
-Extwee is **not** an authoring tool. It cannot be used to create story content. This data must be created using other tools or processes. Extwee can then *compile* the story with story format code to produce something playable.
+Extwee is **not** an authoring tool. It cannot be used to create story content. This data must be created using other tools or processes. Extwee can then *compile* the content with story format code to produce something playable.
 
 Playable formats are the following and require external story formats[^1] to enable play:
 
@@ -113,6 +113,12 @@ Compiles story, story formats, or other data into an archive or playable format.
 
 **Note:** In order to create playable Twine 1 HTML, an `engine.js` file must be supplied.
 
+### Support Functionality
+
+Multiple Twine formats support using [an IFID](https://ifdb.org/help-ifid) to identify one work from another.
+
+As part of its API, the Extwee method `generateIFID()` can be used to create a new IFID for a `Story` object or as part of other processes.
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Documentation

package/docs/objects/story.md

@@ -12,7 +12,7 @@ Depending on the incoming format or creation method, many possible properties ca
 - format ( string ) Name of the story format for Twine 2 HTML.
 - formatVersion ( string ) Semantic version of the named story format for Twine 2 HTML or Twee 3.
 - zoom ( float ) Zoom level for Twine 2 HTML or Twee 3.
-- passages ( array(Passage) ) **[Read-only]** Collection of internal passages.
+- passages ( array(Passage) ) Collection of internal passages.
 - creator ( string ) Name of story creation tool. (Defaults to "Extwee").
 - creatorVersion ( string ) Semantic version of named creation tool.
 - metadata ( object ) Key-value pairs of metadata values.
@@ -41,7 +41,6 @@ As collections of passages, each **Story** has multiple methods for accessing an
 - `getPassagesByTags(string)`: Returns an array of any passages containing a particular tag value.
 - `getPassageByName(string)`: Returns either `null`` or the named passage.
 - `size()`: Returns the number of passages in the collection.
-- `forEachPassage(callback)`: Allows for iterating over the passage collection.
 
 ## Passage Creation Example
 

package/index.js

@@ -8,6 +8,7 @@ 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 { generate as generateIFID } from './src/IFID/generate.js';
 import { Story } from './src/Story.js';
 import Passage from './src/Passage.js';
 import StoryFormat from './src/StoryFormat.js';
@@ -23,6 +24,7 @@ export {
     compileTwine1HTML,
     compileTwine2HTML,
     compileTwine2ArchiveHTML,
+    generateIFID,
     Story,
     Passage,
     StoryFormat

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extwee",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "A story compiler tool using Twine-compatible formats",
   "author": "Dan Cox",
   "main": "index.js",
@@ -8,7 +8,7 @@
     "extwee": "src/extwee.js"
   },
   "scripts": {
-    "test": "jest --silent --runInBand --coverage --colors",
+    "test": "jest --runInBand --coverage --colors",
     "lint": "eslint ./src/**/*.js --fix",
     "lint:test": "eslint ./test/**/*.test.js --fix",
     "build:web": "webpack",
@@ -23,42 +23,42 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "commander": "^11.1.0",
-    "html-entities": "^2.4.0",
+    "commander": "^12.0.0",
+    "html-entities": "^2.5.2",
     "node-html-parser": "^6.1.12",
     "pickleparser": "^0.2.1",
-    "semver": "^7.5.4",
+    "semver": "^7.6.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.7",
-    "@babel/eslint-parser": "^7.23.3",
+    "@babel/core": "^7.24.0",
+    "@babel/eslint-parser": "^7.23.10",
     "@babel/eslint-plugin": "^7.23.5",
-    "@babel/preset-env": "^7.23.8",
+    "@babel/preset-env": "^7.24.0",
+    "@types/uuid": "^9.0.7",
     "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",
+    "core-js": "^3.36.0",
+    "esbuild": "^0.20.1",
+    "eslint": "^8.57.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-jest": "^27.9.0",
+    "eslint-plugin-jsdoc": "^48.2.0",
     "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",
+    "typescript": "^5.4.2",
+    "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/videlais/extwee"
+    "url": "git+https://github.com/videlais/extwee.git"
   },
   "bugs": {
     "url": "https://github.com/videlais/extwee/issues"

package/src/IFID/generate.js

@@ -0,0 +1,20 @@
+import { v4 } from 'uuid';
+
+/**
+ * Generates an Interactive Fiction Identification (IFID) based the Treaty of Babel.
+ *
+ * For Twine works, the IFID is a UUID (v4) in uppercase.
+ * @see Treaty of Babel ({@link https://babel.ifarchive.org/babel_rev11.html#the-ifid-for-an-html-story-file})
+ * @function generate
+ * @description Generates a new IFID.
+ * @returns {string} IFID
+ * @example
+ * const ifid = generate();
+ * console.log(ifid);
+ * // => 'A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6'
+ */
+function generate () {
+  return v4().toUpperCase();
+}
+
+export { generate };

package/src/JSON/parse.js

@@ -3,9 +3,52 @@ import Passage from '../Passage.js';
 
 /**
  * Parse JSON representation into Story.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-jsonoutput-doc.md Twine 2 JSON Specification}
  * @function parse
  * @param {string} jsonString - JSON string to convert to Story.
+ * @throws {Error} - Invalid JSON!
  * @returns {Story} Story object.
+ * @example
+ * const jsonString = `{
+ *  "name": "My Story",
+ *  "start": "First Passage",
+ *  "ifid": "A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6",
+ *  "format": "SugarCube",
+ *  "formatVersion": "2.31.0",
+ *  "creator": "Twine",
+ *  "creatorVersion": "2.3.9",
+ *  "zoom": 1,
+ *  "passages": [
+ *   {
+ *    "name": "First Passage",
+ *    "tags": "",
+ *    "metadata": "",
+ *    "text": "This is the first passage."
+ *   },
+ *  ]
+ * }`;
+ * const story = parse(jsonString);
+ * console.log(story);
+ * // => Story {
+ * //      name: 'My Story',
+ * //      start: 'First Passage',
+ * //      IFID: 'A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6',
+ * //      format: 'SugarCube',
+ * //      formatVersion: '2.31.0',
+ * //      creator: 'Twine',
+ * //      creatorVersion: '2.3.9',
+ * //      zoom: 1,
+ * //      tagColors: {},
+ * //      metadata: {},
+ * //      passages: [
+ * //        Passage {
+ * //          name: 'First Passage',
+ * //          tags: '',
+ * //          metadata: '',
+ * //          text: 'This is the first passage.'
+ * //        }
+ * //      ]
+ * //    }
  */
 function parse (jsonString) {
   // Create future object.

package/src/Passage.js

@@ -1,30 +1,68 @@
 import { encode } from 'html-entities';
 
 /**
- * A passage is the smallest unit of a Twine story.
- */
+  * Passage class.
+  * @class
+  * @classdesc Represents a passage in a Twine story.
+  * @property {string} name - Name of the passage.
+  * @property {Array} tags - Tags for the passage.
+  * @property {object} metadata - Metadata for the passage.
+  * @property {string} text - Text content of the passage.
+  * @method {string} toTwee - Return a Twee representation.
+  * @method {string} toJSON - Return JSON representation.
+  * @method {string} toTwine2HTML - Return Twine 2 HTML representation.
+  * @method {string} toTwine1HTML - Return Twine 1 HTML representation.
+  * @example
+  * const p = new Passage('Start', 'This is the start of the story.');
+  * console.log(p.toTwee());
+  * // :: Start
+  * // This is the start of the story.
+  * //
+  * console.log(p.toJSON());
+  * // {"name":"Start","tags":[],"metadata":{},"text":"This is the start of the story."}
+  * console.log(p.toTwine2HTML());
+  * // <tw-passagedata pid="1" name="Start" tags="" >This is the start of the story.</tw-passagedata>
+  * console.log(p.toTwine1HTML());
+  * // <div tiddler="Start" tags="" modifier="extwee" twine-position="10,10">This is the start of the story.</div>
+  * @example
+  * const p = new Passage('Start', 'This is the start of the story.', ['start', 'beginning'], {position: '10,10', size: '100,100'});
+  * console.log(p.toTwee());
+  * // :: Start [start beginning] {"position":"10,10","size":"100,100"}
+  * // This is the start of the story.
+  * //
+  * console.log(p.toJSON());
+  * // {"name":"Start","tags":["start","beginning"],"metadata":{"position":"10,10","size":"100,100"},"text":"This is the start of the story."}
+  * console.log(p.toTwine2HTML());
+  * // <tw-passagedata pid="1" name="Start" tags="start beginning" position="10,10" size="100,100">This is the start of the story.</tw-passagedata>
+  * console.log(p.toTwine1HTML());
+  * // <div tiddler="Start" tags="start beginning" modifier="extwee" twine-position="10,10">This is the start of the story.</div>
+  */ 
 export default class Passage {
   /**
    * Name of the Passage
    * @private
+   * @type {string}
    */
-  #_name = null;
+  #_name = '';
 
   /**
    * Internal array of tags
    * @private
+   * @type {Array}
    */
   #_tags = [];
 
   /**
    * Internal metadata of passage
    * @private
+   * @type {object}
    */
   #_metadata = {};
 
   /**
    * Internal text of the passage
    * @private
+   * @type {string}
    */
   #_text = '';
 
@@ -57,6 +95,7 @@ export default class Passage {
 
   /**
    * @param {string} s - Name to replace
+   * @throws {Error} Name must be a String!
    */
   set name (s) {
     if (typeof s === 'string') {
@@ -74,6 +113,7 @@ export default class Passage {
 
   /**
    * @param {Array} t - Replacement array
+   * @throws {Error} Tags must be an array!
    */
   set tags (t) {
     // Test if tags is an array
@@ -93,6 +133,7 @@ export default class Passage {
 
   /**
    * @param {object} m - Replacement object
+   * @throws {Error} Metadata must be an object literal!
    */
   set metadata (m) {
     // Test if metadata was an object
@@ -111,6 +152,7 @@ export default class Passage {
 
   /**
    * @param {string} t - Replacement text
+   * @throws {Error} Text should be a String!
    */
   set text (t) {
     // Test if text is a String
@@ -123,6 +165,10 @@ export default class Passage {
 
   /**
    * Return a Twee representation.
+   * 
+   * See: https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md
+   * 
+   * @method toTwee
    * @returns {string} String form of passage.
    */
   toTwee () {
@@ -153,6 +199,7 @@ export default class Passage {
 
   /**
    * Return JSON representation.
+   * @method toJSON
    * @returns {string} JSON string.
    */
   toJSON () {
@@ -171,6 +218,7 @@ export default class Passage {
   /**
    * Return Twine 2 HTML representation.
    * (Default Passage ID is 1.)
+   * @method toTwine2HTML
    * @param {number} pid - Passage ID (PID) to record in HTML.
    * @returns {string} Twine 2 HTML string.
    */
@@ -223,6 +271,7 @@ export default class Passage {
 
   /**
    * Return Twine 1 HTML representation.
+   * @method toTwine1HTML
    * @returns {string} Twine 1 HTML string.
    */
   toTwine1HTML () {