extwee 1.5.3 → 2.0.0

package/HTMLParser.js

@@ -1,206 +0,0 @@
-const { parse } = require('node-html-parser');
-const htmlparser = parse;
-const Story = require('./Story.js');
-const Passage = require('./Passage.js');
-/**
- * @class HTMLParser
- * @module HTMLParser
- */
-class HTMLParser {
-	/**
-     * @method HTMLParser
-     * @constructor
-     */
-    constructor (content) {
-
-        this.story = null;
-
-        this.parse(content);
-    }
-
-    parse(content) {
-
-        // Send to node-html-parser
-        // Enable getting the content of 'script', 'style', and 'pre' elements
-        // Get back a DOM
-        let dom = new htmlparser(
-                        content,
-                        {
-                                  lowerCaseTagName: false,
-                                  script: true,
-                                  style: true,
-                                  pre: true
-                        });
-
-        // Pull out the tw-storydata element
-        let storyData = dom.querySelector('tw-storydata');
-
-        if(storyData != null) {
-
-            this.story = new Story();
-            this.story.name = storyData.attributes["name"];
-            this.story.creator = storyData.attributes["creator"];
-            this.story.creatorVersion = storyData.attributes["creator-version"];
-
-            this.story.metadata = {};
-            this.story.metadata.ifid = storyData.attributes["ifid"];
-            this.story.metadata.format = storyData.attributes["format"];
-            this.story.metadata.formatVersion = storyData.attributes["format-version"];
-            this.story.metadata.zoom = storyData.attributes["zoom"];
-            this.story.metadata.start = storyData.attributes["startnode"];
-
-        } else {
-
-            throw new Error("Error: Not a Twine 2-style file!");
-
-        }
-
-        // Pull out the tw-passagedata elements
-        let storyPassages = dom.querySelectorAll("tw-passagedata");
-
-        // Create an empty array
-        this.story.passages = new Array();
-
-          // Set default pid
-        let pid = 1;
-
-        // Add StoryTitle
-        this.story.passages.push(
-            new Passage(
-                "StoryTitle",
-                [],
-                {},
-                this.story.name,
-                pid
-            )
-        );
-
-       // Increase PID by one before parsing any other passages
-       pid++;
-
-        // Move through the passages
-        for(let passage in storyPassages) {
-
-            // Get the passage attributes
-            let attr = storyPassages[passage].attributes;
-            // Get the passage text
-            let text = storyPassages[passage].rawText;
-
-            // Save position
-            let position = attr.position;
-
-            // Save size
-            let size = attr.size;
-
-            // Escape the name
-            let name = this._escapeMetacharacters(attr.name);
-
-            // Create empty tags
-            let tags = "";
-
-            // Escape any tags
-            // (Attributes can, themselves, be emtpy strings.)
-            if(attr.tags.length > 0 && attr.tags != '""') {
-
-                tags = this._escapeMetacharacters(attr.tags);
-
-            }
-
-            // Split by spaces
-            tags = tags.split(" ");
-
-            // Remove any empty strings
-            tags = tags.filter(tag => tag != "");
-
-            // Add a new Passage into an array
-            this.story.passages.push(
-                new Passage(
-                        name,
-                        tags,
-                        {
-                            "position": position,
-                            "size": size
-
-                        },
-                        text,
-                        pid
-                    )
-            );
-
-            pid++;
-
-        }
-
-        // Look for the style element
-        let styleElement = dom.querySelector('#twine-user-stylesheet');
-
-        // Check if there is any content.
-        // If not, we won't add empty passages
-        if(styleElement.rawText.length > 0) {
-
-            // Add UserStylesheet
-            this.story.passages.push(
-                new Passage(
-                    "UserStylesheet",
-                    ["stylesheet"],
-                    {},
-                    styleElement.rawText
-                )
-            );
-        }
-
-        // Look for the script element
-        let scriptElement = dom.querySelector('#twine-user-script');
-
-        // Check if there is any content.
-        // If not, we won't add empty passages
-        if(scriptElement.rawText.length > 0) {
-
-            // Add UserScript
-            this.story.passages.push(
-                new Passage(
-                    "UserScript",
-                    ["script"],
-                    {},
-                    scriptElement.rawText
-                )
-            );
-
-        }
-
-        // Now that all passages have been handled,
-        //  change the start name
-        this.story.metadata.start = this.story.getStartingPassage();
-
-        // Add StoryData
-        this.story.passages.push(
-            new Passage(
-                "StoryData",
-                [],
-                {},
-                JSON.stringify(this.story.metadata, null, 4)
-            )
-        );
-
-    }
-
-    _escapeMetacharacters(result) {
-
-        // Replace any single backslash with two of them
-        result = result.replace(/\\/g, "\\");
-        // Double-escape escaped {
-        result = result.replace(/\\\{/g, "\\\\{");
-        // Double-escape escaped }
-        result = result.replace(/\\\}/g, "\\\\}");
-        // Double-escape escaped [
-        result = result.replace(/\\\[/g, "\\\\[");
-        // Double-escape escaped ]
-        result = result.replace(/\\\]/g, "\\\\]");
-
-        return result;
-
-    }
-
-}
-
-module.exports = HTMLParser;

package/HTMLWriter.js

@@ -1,177 +0,0 @@
-const fs = require("fs");
-const Story = require('./Story.js');
-const StoryFormat = require('./StoryFormat.js');
-/**
- * @class HTMLWriter
- * @module HTMLWriter
- */
-class HTMLWriter {
-	/**
-     * @method HTMLWriter
-     * @constructor
-     */
-    constructor (file, story, storyFormat, css, js) {
-
-        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 cssContent = css || null;
-        let jsContent = js || null;
-
-        this.writeFile(file, story, storyFormat, cssContent, jsContent);
-    }
-
-    writeFile(file, story, storyFormat, cssContent, jsContent) {
-
-        let outputContents = "";
-
-        // Build <tw-storydata>
-        let storyData =
-            '<tw-storydata name="' + story.name + '" ' +
-            'startnode="' + story.getStartingPassage() + '" ' +
-            'creator="' + story.creator + '" ' +
-            'creator-version="' + story.creatorVersion + '" ' +
-            'ifid="' + story.metadata.ifid + '" ' +
-            'zoom="' + story.metadata.zoom + '" ' +
-            'format="' + storyFormat.name + '" ' +
-            'format-version="' + storyFormat.version + '" ' +
-            'options hidden>\n';
-
-        // Build the STYLE
-        storyData += '<style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css">';
-
-        // Get any passages tagged with 'stylesheet'
-        let stylePassages = story.getStylePassages();
-
-        // CSS passed through from DirectoryReader
-        if(cssContent != null) {
-          storyData += cssContent;
-        }
-
-        // Iterate through the collection and add to storyData
-        for(let content of stylePassages) {
-            storyData += content.text;
-        }
-
-        storyData += '</style>\n';
-
-        // Build the SCRIPT
-        storyData += '<script role="script" id="twine-user-script" type="text/twine-javascript">';
-
-        // Get any passages tagged with 'script'
-        let scriptPassages = story.getScriptPassages();
-
-        // JS passed through from DirectoryReader
-        if(jsContent != null) {
-          storyData += jsContent;
-        }
-
-        // Iterate through the collection and add to storyData
-        for(let content of scriptPassages) {
-            storyData += content.text;
-        }
-
-        storyData += '</script>\n';
-
-        // All the script data has been written.
-        // Delete all 'script'-tagged passages
-        story.deleteAllByTag("script");
-
-        // All the style data has been written.
-        // Delete all 'style'-tagged passages
-        story.deleteAllByTag("stylesheet");
-
-        // Build the passages
-        for(let passage of story.passages) {
-
-            storyData += '<tw-passagedata pid="' + passage.pid + '" name="' + passage.name + '"';
-
-            // Write out any tags
-            if(passage.tags.length > 1) {
-
-                storyData += ' tags="';
-
-                for(let t of passage.tags) {
-
-                    storyData += t + ', ';
-
-                }
-
-                storyData += '" ';
-
-            } else if(passage.tags.length == 1) {
-
-                storyData += ' tags="' + passage.tags[0] + '" ';
-
-            } else {
-
-                storyData += ' tags ';
-
-            }
-
-            // Write out position
-            if(passage.metadata.hasOwnProperty("position")) {
-
-                storyData += 'position="' +
-                    passage.metadata.position + '" ';
-
-            } else {
-
-                // Didn't have a position.
-                // Make one up.
-                storyData += 'position="100,100" ';
-
-            }
-
-            // Write out size
-            if(passage.metadata.hasOwnProperty("size") ) {
-
-                storyData += 'size="' +
-                    passage.metadata.size + '" ';
-
-            } else {
-
-                // Didn't have a size.
-                // Make one up.
-                storyData += 'size="100,100" ';
-
-            }
-
-            storyData += '>' + passage.text + '</tw-passagedata>\n';
-
-        }
-
-        storyData += '</tw-storydata>';
-
-        // Replace the story name in the source file
-        storyFormat.source = storyFormat.source.replace("{{STORY_NAME}}", story.name);
-
-        // Replace the story data
-        storyFormat.source = storyFormat.source.replace("{{STORY_DATA}}", storyData);
-
-        outputContents += storyFormat.source
-
-        try {
-
-          // Try to write
-          fs.writeFileSync(file, outputContents);
-
-        } catch(event) {
-
-          // Throw error
-          throw new Error("Error: Cannot write HTML file!");
-
-        }
-
-    }
-
-}
-
-module.exports = HTMLWriter;

package/Passage.js

@@ -1,20 +0,0 @@
-/**
- * @class Passage
- * @module Passage
- */
-class Passage {
-	/**
-     * @method Passage
-     * @constructor
-     */
-    constructor (name = "", tags = [], metadata = {}, text = "", pid = 1) {
-        this.name = name;
-        this.tags = tags;
-        this.metadata = metadata;
-        this.text = text;
-        this.pid = pid;
-    }
-
-}
-
-module.exports = Passage;

package/Story.js

@@ -1,148 +0,0 @@
-const pkg = require('./package.json');
-/**
- * @class Story
- * @module Story
- */
-class Story {
-	/**
-     * @method Story
-     * @constructor
-     */
-    constructor () {
-        this.name = "Unknown";
-        this.metadata = {
-            "ifid": "",
-            "format": "",
-            "formatVersion": "",
-            "zoom": "",
-            "start": ""
-        };
-
-        this.passages = [];
-
-        // Store the creator and version
-        this.creator = pkg.name;
-        this.creatorVersion = pkg.version;
-
-    }
-
-    /**
-     * @method getStylePassages()
-     */
-    getStylePassages() {
-
-        let stylePassages = [];
-
-        if(this.passages.length > 0) {
-
-          stylePassages = this.passages.filter(function(passage){
-
-              let results = passage.tags.filter(tag => tag == "stylesheet");
-
-              return (results.length > 0);
-
-          });
-
-        }
-
-        return stylePassages;
-
-    }
-
-    /**
-     * @method getScriptPassages()
-     */
-    getScriptPassages() {
-
-        let scriptPassages = [];
-
-        if(this.passages.length > 0) {
-
-          scriptPassages = this.passages.filter(function(passage) {
-
-              let results = passage.tags.filter(tag => tag == "script");
-
-              return (results.length > 0);
-
-          });
-
-        }
-
-        return scriptPassages;
-
-    }
-
-    /**
-     * @method deleteAllByTag()
-     */
-    deleteAllByTag(searchTag) {
-
-      if(this.passages.length > 0) {
-
-          this.passages = this.passages.filter(function(passage) {
-
-              return !passage.tags.includes(searchTag);
-
-          });
-
-      }
-
-    }
-
-    /**
-     * @method getStartingPassage()
-     * @return String
-     */
-    getStartingPassage() {
-
-        let pid = null;
-        let searchName = null;
-
-        if(this.metadata.hasOwnProperty("start")) {
-
-            // Check if the property is an empty string
-            // If so, ignore it.
-            if(this.metadata.start != "") {
-
-                searchName = this.metadata.start;
-
-            }
-
-        }
-
-        if(this.passages.length > 0) {
-
-          for(let passage in this.passages) {
-
-              if(this.passages[passage].name == searchName) {
-
-                  pid = this.passages[passage].pid;
-                  break;
-
-              }
-
-              if(this.passages[passage].name == "Start") {
-
-                  pid = this.passages[passage].pid;
-
-              }
-
-          }
-
-        }
-
-        if(pid == null) {
-
-            throw new Error("Starting passage not found!");
-
-        } else {
-
-          return pid;
-
-        }
-
-    }
-
-}
-
-module.exports = Story;

package/StoryFormat.js

@@ -1,41 +0,0 @@
-/**
- * @class StoryFormat
- * @module StoryFormat
- */
-class StoryFormat {
-	/**
-     * @method StoryFormat
-     * @constructor
-     */
-    constructor (object) {
-
-      // Borrowed from Underscore
-      // https://github.com/jashkenas/underscore/blob/master/underscore.js#L1319-L1323
-      let isObject = function(obj) {
-        var type = typeof obj;
-        return type === 'function' || type === 'object' && !!obj;
-      };
-
-      if(isObject(object) ) {
-
-        this.name = object.name || null;
-        this.version = object.version || null;
-        this.description = object.description || null;
-        this.author = object.author || null;
-        this.image = object.image || null;
-        this.url = object.url || null;
-        this.license = object.license || null;
-        this.proofing = object.proofing || null;
-        this.source = object.source || null;
-
-      } else {
-
-        throw new Error("Expected JSON object!");
-
-      }
-
-    }
-
-}
-
-module.exports = StoryFormat;

package/StoryFormatParser.js

@@ -1,65 +0,0 @@
-const StoryFormat = require('./StoryFormat.js');
-const FileReader = require('./FileReader.js');
-/**
- * @class StoryFormatParser
- * @module StoryFormatParser
- */
-class StoryFormatParser {
-	/**
-     * @method StoryFormatParser
-     * @constructor
-     */
-    constructor (file) {
-
-        this.storyformat = null;
-
-        this.parse(file);
-    }
-
-    parse(file) {
-
-        let contents = new FileReader(file).contents;
-
-        // Harlowe has malformed JSON, so we have to test for it
-        let harlowePosition = contents.indexOf('harlowe');
-
-        if(harlowePosition != -1) {
-            // The 'setup' property is malformed
-            let setupPosition = contents.lastIndexOf(',"setup": function');
-            contents = contents.slice(0, setupPosition) + '}';
-
-        }
-
-        let openingCurlyBracketPosition = contents.indexOf('{');
-        let closingCurlyBracketPosition = contents.lastIndexOf('}');
-
-        if(openingCurlyBracketPosition != -1 && closingCurlyBracketPosition != -1) {
-
-            // Slice out the JSON
-            contents = contents.slice(openingCurlyBracketPosition, closingCurlyBracketPosition+1);
-
-        } else {
-
-            throw new Error("Unable to find Twine2 JSON chunk!");
-
-        }
-
-        let jsonContent = "";
-
-        try {
-
-            jsonContent = JSON.parse(contents);
-
-        } catch (event) {
-
-             throw new Error("Unable to parse Twine2 JSON chunk!");
-
-        }
-
-        this.storyformat = new StoryFormat(jsonContent);
-
-    }
-
-}
-
-module.exports = StoryFormatParser;