extwee 2.0.6 → 2.2.0

package/src/HTMLWriter.js

@@ -1,231 +0,0 @@
-/**
- * @external Story
- * @see Story.js
- * @external StoryFormat
- * @see StoryFormat.js
- */
-
-import fs from 'fs';
-import Story from './Story.js';
-import StoryFormat from './StoryFormat.js';
-import { v4 as uuidv4 } from 'uuid';
-
-/**
- * @class HTMLWriter
- * @module HTMLWriter
- */
-export default class HTMLWriter {
-  /**
-   * Write story to file using story format and adding any CSS and JS
-   *
-   * @public
-   * @static
-   * @function writeFile
-   * @param {string} file - File to write
-   * @param {Story} story - Story object to write
-   * @param {StoryFormat} storyFormat - StoryFormat to write
-   */
-  static write (file, 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 = '';
-    let storyData = '';
-
-    // Look for StoryTitle
-    const storyTitle = story.getPassageByName('StoryTitle');
-
-    // Does the passage exist?
-    if (storyTitle != null) {
-      // Always overwrite any existing name with StoryTitle (per spec)
-      story.name = storyTitle.text;
-
-      // Use story.name for name.
-      storyData += `<tw-storydata name="${story.name}"`;
-    } else {
-      throw new Error("'name' is required attribute. (Add StoryTitle to story.)");
-    }
-
-    // Does start exist?
-    if (story.start !== '') {
-      // Try to get starting passage
-      const startingPassage = story.getPassageByName(story.start);
-      // Does it exist currently?
-      if (startingPassage !== null) {
-        // Add the starting passage
-        storyData += ` startnode="${startingPassage.pid}"`;
-      } else {
-        // Throw error if no starting passage exists
-        throw new Error('Starting passage not found');
-      }
-    } else {
-      // Throw error if no starting passage exists
-      throw new Error('No starting passage found!');
-    }
-
-    // Defaults to 'extwee' if missing.
-    storyData += ` creator="${story.creator}"`;
-
-    // Default to extwee version.
-    storyData += ` creator-version="${story.creatorVersion}"`;
-
-    // Check if IFID exists.
-    if (story.IFID !== '') {
-      // Write the existing IFID
-      storyData += ` ifid="${story.IFID}"`;
-    } else {
-      // Generate a new IFID
-      // Twine 2 uses v4 (random) UUIDs, using only capital letters
-      storyData += ` ifid="${uuidv4().toUpperCase()}"`;
-    }
-
-    // Write existing or default value.
-    storyData += ` zoom="${story.zoom}"`;
-
-    // Write existing or default value.
-    storyData += ` format="${storyFormat.name}"`;
-
-    // Write existing or default value.
-    storyData += ` format-version="${storyFormat.version}"`;
-
-    // Add the default.
-    storyData += ' options hidden>\n';
-
-    // Start the STYLE.
-    storyData += '\t<style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css">';
-
-    // Get stylesheet passages
-    const stylesheetPassages = story.getPassagesByTag('stylesheet');
-
-    // Concatenate passages
-    stylesheetPassages.forEach((passage) => {
-      // Add text of passages
-      storyData += passage.text;
-      // Remove from story
-      story.removePassageByName(passage.name);
-    });
-
-    // Close the STYLE
-    storyData += '</style>\n';
-
-    // Start the SCRIPT
-    storyData += '\t<script role="script" id="twine-user-script" type="text/twine-javascript">';
-
-    // Get stylesheet passages
-    const scriptPassages = story.getPassagesByTag('script');
-
-    // Concatenate passages
-    scriptPassages.forEach((passage) => {
-      // Add text of passages
-      storyData += passage.text;
-      // Remove from story
-      story.removePassageByName(passage.name);
-    });
-
-    // Close SCRIPT
-    storyData += '</script>\n';
-
-    // Build the passages
-    story.forEach((passage) => {
-      // Start the passage element
-      storyData += '\t<tw-passagedata';
-
-      /**
-       * pid: (string) Required.
-       *   The Passage ID (PID).
-       */
-      storyData += ` pid="${passage.pid}"`;
-
-      /**
-       * name: (string) Required.
-       *   The name of the passage.
-       */
-      storyData += ` name="${passage.name}"`;
-
-      /**
-       * tags: (string) Optional.
-       *   Any tags for the passage separated by spaces.
-       */
-      if (passage.tags.length > 1) {
-        storyData += ` tags="${passage.tags.join(' ')}" `;
-      } else if (passage.tags.length === 1) {
-        storyData += ` tags="${passage.tags[0]}" `;
-      }
-
-      /**
-       * position: (string) Optional.
-       *   Comma-separated X and Y position of the upper-left of the passage
-       *   when viewed within the Twine 2 editor.
-       */
-      if (Object.prototype.hasOwnProperty.call(passage.metadata, 'position')) {
-        storyData += ` position="${passage.metadata.position}" `;
-      }
-
-      /**
-       * size: (string) Optional.
-       *   Comma-separated width and height of the passage
-       *   when viewed within the Twine 2 editor.
-       */
-      if (Object.prototype.hasOwnProperty.call(passage.metadata, 'size')) {
-        storyData += `size="${passage.metadata.size}" `;
-      }
-
-      storyData += `>${HTMLWriter.escape(passage.text)}</tw-passagedata>\n`;
-    });
-
-    storyData += '</tw-storydata>';
-
-    // 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;
-
-    try {
-      // Try to write.
-      fs.writeFileSync(file, outputContents);
-    } catch (event) {
-      // Throw error
-      throw new Error('Error: Cannot write HTML file!');
-    }
-  }
-
-  /**
-   * Escape HTML characters
-   *
-   * @public
-   * @static
-   * @function escape
-   * @param {string} text - Text to escape
-   * @returns {string} Escaped text
-   */
-  static escape (text) {
-    // Throw error if text is not a string
-    if (Object.prototype.toString.call(text) !== '[object String]') {
-      throw new Error('Text argument is not a String');
-    }
-
-    const rules = [
-      ['&', '&amp;'],
-      ['<', '&lt;'],
-      ['>', '&gt;'],
-      ['"', '&quot;'],
-      ["'", '&#x27;'],
-      ['`', '&#x60;']
-    ];
-
-    rules.forEach(([rule, template]) => {
-      text = text.replaceAll(rule, template);
-    });
-
-    return text;
-  }
-}

package/src/StoryFormatParser.js

@@ -1,142 +0,0 @@
-import StoryFormat from './StoryFormat.js';
-import semver from 'semver';
-/**
- * @class StoryFormatParser
- * @module StoryFormatParser
- */
-export default class StoryFormatParser {
-  /**
-   * Parse a Story Format file
-   *
-   * @public
-   * @static
-   * @memberof StoryFormatParser
-   * @function parse
-   * @param {string} contents - Content
-   * @returns {StoryFormat} StoryFormat object
-   */
-  static parse (contents) {
-    // Harlowe has malformed JSON, so we have to test for it
-    const harlowePosition = contents.indexOf('harlowe');
-
-    if (harlowePosition !== -1) {
-      // The 'setup' property is malformed
-      const setupPosition = contents.lastIndexOf(',"setup": function');
-      contents = contents.slice(0, setupPosition) + '}';
-    }
-
-    // Find the start of story format or -1, if not found
-    const openingCurlyBracketPosition = contents.indexOf('{');
-    // Find the end of story format or -1, if not found
-    const closingCurlyBracketPosition = contents.lastIndexOf('}');
-
-    // Look for JSON among the story format
-    // If either is -1, this is not valid JSON
-    if (openingCurlyBracketPosition === -1 || closingCurlyBracketPosition === -1) {
-      // Either start or end curly brackets were now found!
-      throw new Error('Unable to find Twine2 JSON chunk!');
-    } else {
-      // Slice out the JSON based on curly brackets
-      contents = contents.slice(openingCurlyBracketPosition, closingCurlyBracketPosition + 1);
-    }
-
-    // Create an object literal
-    let jsonContent = {};
-
-    try {
-      jsonContent = JSON.parse(contents);
-    } catch (event) {
-      throw new Error('Unable to parse Twine2 JSON chunk!');
-    }
-
-    /**
-     * The following keys are found in most or all story formats:
-     * - name: (string) Optional. Name of the story format.
-     *      (Omitting the name will lead to an Untitled Story Format.)
-     * - version: (string) Required, and semantic version-style formatting
-     *      (x.y.z, e.g., 1.2.1) of the version is also required.
-     * - author: (string) Optional.
-     * - description: (string) Optional.
-     * - image: (string) Optional. The filename of an image (ideally SVG)
-     *      served from the same directory as the format.js file.
-     * - url: (string) Optional. The URL of the directory containing the format.js file.
-     * - license: (string) Optional.
-     * - proofing: (boolean) Optional (defaults to false). True if the story format
-     *      is a "proofing" format. The distinction is relevant only in the Twine 2 UI.
-     * - source: (string) Required. Full HTML output of the story format.
-     * (See: https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-storyformats-spec.md)
-     */
-
-    // Name is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'name')) {
-      // Use the default name
-      jsonContent.name = 'Untitled Story Format';
-    }
-
-    // Author is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'author')) {
-      // Use the default author
-      jsonContent.author = '';
-    }
-
-    // Description is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'description')) {
-      // Use the default description
-      jsonContent.description = '';
-    }
-
-    // Image is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'image')) {
-      // Use the default image
-      jsonContent.image = '';
-    }
-
-    // URL is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'url')) {
-      // Use the default url
-      jsonContent.url = '';
-    }
-
-    // License is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'license')) {
-      // Use the default license
-      jsonContent.license = '';
-    }
-
-    // Proofing is optional, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'proofing')) {
-      // Use the default proofing
-      jsonContent.proofing = false;
-    }
-
-    // Version is required, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'version')) {
-      // Throw error
-      throw new Error('Processed story format does not have required version property!');
-    }
-
-    // Test if version is semantic-style, which is required
-    if (semver.valid(jsonContent.version) === null) {
-      throw new Error('Processed story format\'s version is not a valid semantic value!');
-    }
-
-    // Source is required, so we have to test for it
-    if (!Object.prototype.hasOwnProperty.call(jsonContent, 'source')) {
-      // Throw error
-      throw new Error('Processed story format does not have required source property!');
-    }
-
-    // Pass all values to the constructor and return the result
-    return new StoryFormat(
-      jsonContent.name,
-      jsonContent.version,
-      jsonContent.description,
-      jsonContent.author,
-      jsonContent.image,
-      jsonContent.url,
-      jsonContent.license,
-      jsonContent.proofing,
-      jsonContent.source
-    );
-  }
-}

package/src/TweeParser.js

@@ -1,161 +0,0 @@
-import Passage from './Passage.js';
-import Story from './Story.js';
-/**
- * @class TweeParser
- * @module TweeParser
- */
-export default class TweeParser {
-  /**
-   * Parse Twee
-   *
-   * @public
-   * @static
-   * @function parse
-   * @param {string} fileContents - File contents to parse
-   * @returns {Story} story
-   */
-  static 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;
-  }
-}

package/src/TweeWriter.js

@@ -1,121 +0,0 @@
-/**
- * @external Story
- * @see Story.js
- * @external Passage
- * @see Passage.js
- */
-
-import fs from 'fs';
-import Story from './Story.js';
-import { v4 as uuidv4 } from 'uuid';
-
-/**
- * @class TweeWriter
- * @module TweeWriter
- */
-export default class TweeWriter {
-  /**
-   * Write to a file using a Story object
-   *
-   * @static
-   * @param {Story} story - Story format to write
-   * @param {string} file - File to write to
-   * @returns {void}
-   */
-  static write (story, file) {
-    if (!(story instanceof Story)) {
-      throw new Error('Not a Story object!');
-    }
-
-    // Write the StoryData first.
-    let outputContents = ':: StoryData\n';
-
-    // Create default object.
-    const metadata = {};
-
-    // Is there an IFID?
-    if (story.IFID === '') {
-      // Generate a new IFID for this work.
-      // Twine 2 uses v4 (random) UUIDs, using only capital letters.
-      metadata.ifid = uuidv4().toUpperCase();
-    } else {
-      // Use existing (non-default) value.
-      metadata.ifid = story.IFID;
-    }
-
-    // Is there a format?
-    if (story.format !== '') {
-      // Using existing format
-      metadata.format = story.format;
-    }
-
-    // Is there a formatVersion?
-    if (story.formatVersion !== '') {
-      // Using existing format version
-      metadata['format-version'] = story.formatVersion;
-    }
-
-    // Is there a zoom?
-    if (story.zoom !== 0) {
-      // Using existing zoom.
-      metadata.zoom = story.zoom;
-    }
-
-    // Is there a start?
-    if (story.start !== '') {
-      // Using existing start
-      metadata.start = story.start;
-    }
-
-    // Get number of colors.
-    const numberOfColors = Object.keys(story.tagColors).length;
-    // Are there any colors?
-    if (numberOfColors > 0) {
-      // Add a tag-colors property
-      metadata['tag-colors'] = story.tagColors;
-    }
-
-    // Write out the story metadata.
-    outputContents += `${JSON.stringify(metadata, undefined, 2)}`;
-
-    // Add two newlines.
-    outputContents += '\n\n';
-
-    // Look for StoryTitle
-    const storyTitlePassage = story.getPassageByName('StoryTitle');
-
-    // Does it exist?
-    if (storyTitlePassage !== null) {
-      // Append StoryTitle content
-      outputContents += storyTitlePassage.toString();
-    }
-
-    // For each passage, append it to the output.
-    story.forEach((passage) => {
-      // For each passage, append it to the output.
-      outputContents += passage.toString();
-    });
-
-    // Look for 'script' passages
-    const scriptPassages = story.getPassagesByTag('script');
-    // For each 'script', add it back
-    scriptPassages.forEach(passage => {
-      outputContents += passage.toString();
-    });
-
-    // Look for 'stylesheet' passages
-    const stylesheetPassages = story.getPassagesByTag('stylesheet');
-    // For each 'stylesheet', add it back
-    stylesheetPassages.forEach(passage => {
-      outputContents += passage.toString();
-    });
-
-    try {
-      // Try to write
-      fs.writeFileSync(file, outputContents);
-    } catch (event) {
-      // Throw error
-      throw new Error('Error: Cannot write Twee file!');
-    }
-  }
-}