extwee 2.0.6 → 2.2.0

package/src/Twee/parse.js

@@ -0,0 +1,157 @@
+import Passage from '../Passage.js';
+import Story from '../Story.js';
+
+/**
+ * Parses Twee 3 text into a Story object.
+ *
+ * See: Twee 3 Specification
+ * (https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md)
+ * @param {string} fileContents - File contents to parse
+ * @returns {Story} story
+ */
+function parse (fileContents) {
+  // Create Story.
+  const story = new Story();
+
+  // Throw error if fileContents is not a string
+  if (Object.prototype.toString.call(fileContents) !== '[object String]') {
+    throw new Error('Contents not a String');
+  }
+
+  let adjusted = '';
+
+  // Check if there are extra content in the files
+  // If so, cut it all out for the parser
+  if (fileContents[0] !== ':' && fileContents[1] !== ':') {
+    adjusted = fileContents.slice(fileContents.indexOf('::'), fileContents.length);
+  } else {
+    adjusted = fileContents;
+  }
+
+  // Split the file based on the passage sigil (::) proceeded by a newline
+  const parsingPassages = adjusted.split('\n::');
+
+  // Fix the first result
+  parsingPassages[0] = parsingPassages[0].slice(2, parsingPassages[0].length);
+
+  // Set the initial pid
+  let pid = 1;
+
+  // Iterate through the passages
+  parsingPassages.forEach((passage) => {
+    // Set default values
+    let tags = '';
+    let metadata = '';
+    let text = '';
+    let name = '';
+
+    // Header is everything to the first newline
+    let header = passage.slice(0, passage.indexOf('\n'));
+    // Text is everything else
+    // (Also eat the leading newline character.)
+    // (And trim any remaining whitespace.)
+    text = passage.substring(header.length + 1, passage.length).trim();
+
+    // Test for metadata
+    const openingCurlyBracketPosition = header.lastIndexOf('{');
+    const closingCurlyBracketPosition = header.lastIndexOf('}');
+
+    if (openingCurlyBracketPosition !== -1 && closingCurlyBracketPosition !== -1) {
+      // Save the text metadata
+      metadata = header.slice(openingCurlyBracketPosition, closingCurlyBracketPosition + 1);
+
+      // Remove the metadata from the header
+      header = header.substring(0, openingCurlyBracketPosition) + header.substring(closingCurlyBracketPosition + 1);
+    }
+
+    // There was passage metadata
+    if (metadata.length > 0) {
+      // Try to parse the metadata
+      try {
+        metadata = JSON.parse(metadata);
+      } catch (event) {
+      }
+    } else {
+      // There wasn't any metadata, so set default
+      metadata = {};
+    }
+
+    // Test for tags
+    const openingSquareBracketPosition = header.lastIndexOf('[');
+    const closingSquareBracketPosition = header.lastIndexOf(']');
+
+    if (openingSquareBracketPosition !== -1 && closingSquareBracketPosition !== -1) {
+      tags = header.slice(openingSquareBracketPosition, closingSquareBracketPosition + 1);
+
+      // Remove the tags from the header
+      header = header.substring(0, openingSquareBracketPosition) + header.substring(closingSquareBracketPosition + 1);
+    }
+
+    // Parse tags
+    if (tags.length > 0) {
+      // Eat the opening and closing square brackets
+      tags = tags.substring(1, tags.length - 1);
+
+      // Set empty default
+      let tagsArray = [];
+
+      // Test if tags is not single, empty string
+      if (!(tags === '')) {
+        tagsArray = tags.split(' ');
+      }
+
+      // There are multiple tags
+      if (tagsArray.length > 1) {
+        // Create future array
+        const futureTagArray = [];
+
+        // Move through entries
+        // Add a trimmed version into future array
+        tagsArray.forEach((tag) => { futureTagArray.push(tag.trim()); });
+
+        // Set the tags back to the future array
+        tags = futureTagArray;
+      } else if (tagsArray.length === 1) {
+        // There was only one tag
+        // Store it
+        const temp = tags;
+
+        // Switch tags over to an array
+        tags = [];
+        // Push the single entry
+        tags.push(temp);
+      } else {
+        // Make sure tags is set to empty array if no tags were found
+        tags = [];
+      }
+    } else {
+      // There were no tags, so set it to an empty array;
+      tags = [];
+    }
+
+    // Filter out any empty string tags
+    tags = tags.filter(tag => tag !== '');
+
+    // Trim any remaining whitespace
+    header = header.trim();
+
+    // Check if there is a name left
+    if (header.length > 0) {
+      name = header;
+    } else {
+      // No name left. Something went wrong. Blame user.
+      throw new Error('Malformed passage header!');
+    }
+
+    // addPassage() method does all the work.
+    story.addPassage(new Passage(name, text, tags, metadata, pid));
+
+    // Increase pid
+    pid++;
+  });
+
+  // Return Story.
+  return story;
+}
+
+export { parse };

package/src/Twine1HTML/compile.js

@@ -0,0 +1,58 @@
+import Story from '../Story.js';
+
+/**
+ * Write a combination of Story object, `engine.js` (from Twine 1), `header.html`, and optional `code.js`.
+ * @param {Story} story - Story object to write.
+ * @param {string} engine - Source of `engine.js` file from Twine 1.
+ * @param {string} header - `header.html` content for Twine 1 story format.
+ * @param {string} name - Name of the story format (needed for `code.js` inclusion).
+ * @param {string} codeJS - `code.js` content with additional JavaScript.
+ * @param {object} config - Limited configuration object acting in place of `StorySettings`.
+ * @param {string} config.jquery - jQuery source.
+ * @param {string} config.modernizr - Modernizr source.
+ * @returns {string} Twine 1 HTML.
+ */
+function compile (story, engine = '', header = '', name = '', codeJS = '', config = { jquery: '', modernizr: '' }) {
+  // We must have a Story object.
+  if (!(story instanceof Story)) {
+    throw new TypeError('Error: story must be a Story object!');
+  }
+
+  // Replace the "VERSION" with story.creator.
+  header = header.replaceAll(/"VERSION"/gm, story.creator);
+
+  // Replace the "TIME" with new Date().
+  header = header.replaceAll(/"TIME"/gm, new Date());
+
+  // Replace the ENGINE with `engine.js` code.
+  header = header.replaceAll(/"ENGINE"/gm, engine);
+
+  // Replace the NAME (e.g. "JONAH") with `engine.js` code.
+  header = header.replaceAll(`"${name.toUpperCase()}"`, codeJS);
+
+  // Replace "STORY_SIZE".
+  header = header.replaceAll(/"STORY_SIZE"/gm, `"${story.size()}"`);
+
+  // Replace "STORY" with Twine 1 HTML.
+  header = header.replaceAll(/"STORY"/gm, story.toTwine1HTML());
+
+  // Replace START_AT with ''.
+  header = header.replaceAll(/"START_AT"/gm, '\'\'');
+
+  // Does 'jquery' exist?
+  if (Object.prototype.hasOwnProperty.call(config, 'jquery')) {
+    // Replace JQUERY with jQuery.
+    header = header.replaceAll(/"JQUERY"/gm, config.jquery);
+  }
+
+  // Does 'modernizr' exist?
+  if (Object.prototype.hasOwnProperty.call(config, 'modernizr')) {
+    // Replace "MODERNIZR" with Modernizr.
+    header = header.replaceAll(/"MODERNIZR"/gm, config.modernizr);
+  }
+
+  // Return code.
+  return header;
+}
+
+export { compile };

package/src/Twine1HTML/parse.js

@@ -0,0 +1,134 @@
+import { parse as HtmlParser } from 'node-html-parser';
+import Passage from '../Passage.js';
+import Story from '../Story.js';
+
+/**
+ * Parses Twine 1 HTML into a Story object.
+ *
+ * See: Twine 1 HTML Output Documentation
+ * (https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md)
+ * @param {string} content - Twine 1 HTML content to parse.
+ * @returns {Story} Story object
+ */
+function parse (content) {
+  // Create a default Story.
+  const s = new Story();
+
+  // Send to node-html-parser.
+  // Enable getting the content of 'script', 'style', and 'pre' elements.
+  // Get back a DOM.
+  const dom = new HtmlParser(
+    content,
+    {
+      lowerCaseTagName: false,
+      script: true,
+      style: true,
+      pre: true
+    });
+
+  // Look for `<div id="storeArea">`.
+  let storyData = dom.querySelector('#storeArea');
+
+  // Does the `<div id="storeArea">` element exist?
+  if (storyData === null) {
+    // Look for `<div id="store-area">`.
+    storyData = dom.querySelector('#store-area');
+    // Check for null
+    if (storyData == null) {
+      // Can't find any story data.
+      throw new Error('Cannot find #storeArea or #store-area!');
+    }
+  }
+
+  // Pull out the `[tiddler]` elements.
+  const storyPassages = dom.querySelectorAll('[tiddler]');
+
+  // Move through the passages.
+  for (const passage in storyPassages) {
+    // Get the passage attributes.
+    const attr = storyPassages[passage].attributes;
+    // Get the passage text.
+    const text = storyPassages[passage].rawText;
+
+    /**
+     * twine-position: (string) Required.
+     *   Comma-separated X and Y coordinates of the passage within Twine 1.
+     */
+    // Set a default position.
+    let position = null;
+    // Does position exist?
+    if (Object.prototype.hasOwnProperty.call(attr, 'twine-position')) {
+      // Update position.
+      position = attr['twine-position'];
+    }
+
+    /**
+     * tiddler: (string) Required.
+     *   The name of the passage.
+     */
+    // Create a default value.
+    const name = attr.tiddler;
+    // Is this `StoryTitle`?
+    if (name === 'StoryTitle') {
+      // If StoryTitle exists, we accept the story name.
+      s.name = text;
+    }
+
+    /**
+     * tags: (string) Required.
+     *  Space-separated list of passages tags, if any.
+     */
+    // Create empty tag array.
+    let tags = [];
+    // Does the tags attribute exist?
+    if (Object.prototype.hasOwnProperty.call(attr, 'tags')) {
+      // Escape any tags
+      // (Attributes can, themselves, be empty strings.)
+      if (attr.tags.length > 0 && attr.tags !== '""') {
+        // Escape the tags.
+        tags = attr.tags;
+        // Split by spaces into an array.
+        tags = tags.split(' ');
+      }
+
+      // Remove any empty strings.
+      tags = tags.filter(tag => tag !== '');
+    }
+
+    // Create metadata for passage.
+    // We translate Twine 1 attribute into Twine 2 metadata.
+    const metadata = {};
+
+    // Does position exist?
+    if (position !== null) {
+      // Add the property to metadata
+      metadata.position = position;
+    }
+
+    /**
+     * modifier: (string) Optional.
+     *   Name of the tool that last edited the passage.
+     *   Generally, for versions of Twine 1, this value will be "twee".
+     *   Twee compilers may place their own name (e.g. "tweego" for Tweego).
+     */
+    if (Object.prototype.hasOwnProperty.call(attr, 'modifier')) {
+      // In Twine 2, `creator` maps to Twine 1's `modifier`.
+      s.creator = attr.modifier;
+    }
+
+    // Add the passage.
+    s.addPassage(
+      new Passage(
+        name,
+        text,
+        tags,
+        metadata
+      )
+    );
+  }
+
+  // Return story object.
+  return s;
+}
+
+export { parse };

package/src/Twine2ArchiveHTML/compile.js

@@ -0,0 +1,36 @@
+import Story from '../Story.js';
+
+/**
+ * Write array of Story objects into Twine 2 Archive HTML.
+ * @param {Array} stories - Array of Story objects.
+ * @returns {string} Twine 2 Archive HTML.
+ */
+function compile (stories) {
+  // Can only accept array.
+  if (!Array.isArray(stories)) {
+    throw new TypeError('Stories is not array!');
+  }
+
+  // Output
+  let outputContents = '';
+
+  // Go through each entry (which must be a Story).
+  for (const story of stories) {
+    // If this is not a story, throw a TypeError.
+    if (!(story instanceof Story)) {
+      // Throw TypeError.
+      throw new TypeError('Error: story must be a Story object!');
+    }
+
+    // Append content.
+    outputContents += story.toTwine2HTML();
+
+    // Append newlines.
+    outputContents += '\n\n';
+  }
+
+  // Return output
+  return outputContents;
+}
+
+export { compile };

package/src/Twine2ArchiveHTML/parse.js

@@ -0,0 +1,49 @@
+import { parse as HtmlParser } from 'node-html-parser';
+import { parse as parseTwine2HTML } from '../Twine2HTML/parse.js';
+
+/**
+ * Parse HTML for one or more Twine 2 HTML elements and return array of story objects.
+ * @param {string} content - Content to parse for Twine 2 HTML elements.
+ * @returns {Array} Array of stories found in content.
+ */
+function parse (content) {
+  // Can only parse string values.
+  if (typeof content !== 'string') {
+    throw new TypeError('Content is not a string!');
+  }
+
+  // Send to node-html-parser.
+  // Enable getting the content of 'script', 'style', and 'pre' elements.
+  // Get back a DOM.
+  const dom = new HtmlParser(
+    content,
+    {
+      lowerCaseTagName: false,
+      script: true,
+      style: true,
+      pre: true
+    });
+
+  // Array of possible story elements.
+  const outputArray = [];
+
+  // Pull out the `<tw-storydata>` element.
+  const storyDataElements = dom.getElementsByTagName('tw-storydata');
+
+  // Did we find any elements?
+  if (storyDataElements.length === 0) {
+    // If there is not a single `<tw-storydata>` element, this is not a Twine 2 story!
+    throw new Error('Not Twine 2 HTML content!');
+  }
+
+  // Iterate through all `<tw-storydata>` elements.
+  for (const storyElement of storyDataElements) {
+    // Convert element back into HTML text and parse.
+    outputArray.push(parseTwine2HTML(storyElement.outerHTML));
+  }
+
+  // Return array.
+  return outputArray;
+}
+
+export { parse };

package/src/Twine2HTML/compile.js

@@ -0,0 +1,35 @@
+import Story from '../Story.js';
+import StoryFormat from '../StoryFormat.js';
+
+/**
+ * Write a combination of Story + StoryFormat into Twine 2 HTML file.
+ * @param {Story} story - Story object to write.
+ * @param {StoryFormat} storyFormat - StoryFormat to write.
+ * @returns {string} Twine 2 HTML.
+ */
+function compile (story, storyFormat) {
+  if (!(story instanceof Story)) {
+    throw new Error('Error: story must be a Story object!');
+  }
+
+  if (!(storyFormat instanceof StoryFormat)) {
+    throw new Error('storyFormat must be a StoryFormat object!');
+  }
+
+  let outputContents = '';
+  const storyData = story.toTwine2HTML();
+
+  // Replace the story name in the source file.
+  storyFormat.source = storyFormat.source.replaceAll(/{{STORY_NAME}}/gm, story.name);
+
+  // Replace the story data.
+  storyFormat.source = storyFormat.source.replaceAll(/{{STORY_DATA}}/gm, storyData);
+
+  // Combine everything together.
+  outputContents += storyFormat.source;
+
+  // Return content.
+  return outputContents;
+}
+
+export { compile };