extwee 1.6.0 → 2.0.2

package/src/StoryFormat.js

@@ -1,41 +1,300 @@
-/**
- * @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;
+/**
+ * @class StoryFormat
+ * @module StoryFormat
+ */
+export default class StoryFormat {
+  /**
+   * Internal name
+   *
+   * @private
+   */
+  #_name = '';
+
+  /**
+   * Internal version
+   *
+   * @private
+   */
+  #_version = '';
+
+  /**
+   * Internal description
+   *
+   * @private
+   */
+  #_description = '';
+
+  /**
+   * Internal author
+   *
+   * @private
+   */
+  #_author = '';
+
+  /**
+   * Internal image
+   *
+   * @private
+   */
+  #_image = '';
+
+  /**
+   * Internal URL
+   *
+   * @private
+   */
+  #_url = '';
+
+  /**
+   * Internal license
+   *
+   * @private
+   */
+  #_license = '';
+
+  /**
+   * Internal proofing
+   *
+   * @private
+   */
+  #_proofing = '';
+
+  /**
+   * Internal source
+   *
+   * @private
+   */
+  #_source = '';
+
+  /**
+   * @class
+   * @function StoryFormat
+   * @param {string} name - Name
+   * @param {string} version - Version
+   * @param {string} description - Description
+   * @param {string} author - Author
+   * @param {string} image - Image
+   * @param {string} url - URL
+   * @param {string} license - License
+   * @param {boolean} proofing - If proofing or not
+   * @param {string} source - Source
+   */
+  constructor (
+    name = '',
+    version = '',
+    description = '',
+    author = '',
+    image = '',
+    url = '',
+    license = '',
+    proofing = false,
+    source = ''
+  ) {
+    // Set name
+    this.name = name;
+
+    // Set version
+    this.version = version;
+
+    // Set description
+    this.description = description;
+
+    // Set author
+    this.author = author;
+
+    // Set image
+    this.image = image;
+
+    // Set URL
+    this.url = url;
+
+    // Set license
+    this.license = license;
+
+    // Set proofing
+    this.proofing = proofing;
+
+    // Set source
+    this.source = source;
+  }
+
+  /**
+   * Name
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} Name
+   */
+  get name () { return this.#_name; }
+
+  /**
+   * @param {string} n - Replacement name
+   */
+  set name (n) {
+    if (typeof n === 'string') {
+      this.#_name = n;
+    } else {
+      throw new Error('Name must be a string!');
+    }
+  }
+
+  /**
+   * Version
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} Version
+   */
+  get version () { return this.#_version; }
+
+  /**
+   * @param {string} n - Replacement version
+   */
+  set version (n) {
+    if (typeof n === 'string') {
+      this.#_version = n;
+    } else {
+      throw new Error('Version must be a string!');
+    }
+  }
+
+  /**
+   * Description
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} Description
+   */
+  get description () { return this.#_description; }
+
+  /**
+   * @param {string} d - Replacement description
+   */
+  set description (d) {
+    if (typeof d === 'string') {
+      this.#_description = d;
+    } else {
+      throw new Error('Description must be a string!');
+    }
+  }
+
+  /**
+   * Author
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} Author
+   */
+  get author () { return this.#_author; }
+
+  /**
+   * @param {string} a - Replacement author
+   */
+  set author (a) {
+    if (typeof a === 'string') {
+      this.#_author = a;
+    } else {
+      throw new Error('Author must be a string!');
+    }
+  }
+
+  /**
+   * Image
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} Image
+   */
+  get image () { return this.#_image; }
+
+  /**
+   * @param {string} i - Replacement image
+   */
+  set image (i) {
+    if (typeof i === 'string') {
+      this.#_image = i;
+    } else {
+      throw new Error('Image must be a string!');
+    }
+  }
+
+  /**
+   * URL
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} URL
+   */
+  get url () { return this.#_url; }
+
+  /**
+   * @param {string} u - Replacement URL
+   */
+  set url (u) {
+    if (typeof u === 'string') {
+      this.#_url = u;
+    } else {
+      throw new Error('URL must be a string!');
+    }
+  }
+
+  /**
+   * License
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} License
+   */
+  get license () { return this.#_license; }
+
+  /**
+   * @param {string} l - Replacement license
+   */
+  set license (l) {
+    if (typeof l === 'string') {
+      this.#_license = l;
+    } else {
+      throw new Error('License must be a string!');
+    }
+  }
+
+  /**
+   * Proofing
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {boolean} Proofing
+   */
+  get proofing () { return this.#_proofing; }
+
+  /**
+   * @param {boolean} p - Replacement proofing
+   */
+  set proofing (p) {
+    if (typeof p === 'boolean') {
+      this.#_proofing = p;
+    } else {
+      throw new Error('Proofing must be a Boolean!');
+    }
+  }
+
+  /**
+   * Source
+   *
+   * @public
+   * @memberof StoryFormat
+   * @returns {string} Source
+   */
+  get source () { return this.#_source; }
+
+  /**
+   * @param {string} s - Replacement source
+   */
+  set source (s) {
+    if (typeof s === 'string') {
+      this.#_source = s;
+    } else {
+      throw new Error('Source must be a String!');
+    }
+  }
+}

package/src/StoryFormatParser.js

@@ -1,65 +1,142 @@
-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;
+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
+    );
+  }
+}