extwee 2.0.6 → 2.2.1

package/src/StoryFormat.js

@@ -1,300 +1,259 @@
-/**
- * @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!');
-    }
-  }
-}
+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 = '';
+
+  /**
+   * Create a story format.
+   * @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 = 'Untitled Story Format',
+    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
+   * @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
+   * @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
+   * @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
+   * @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
+   * @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
+   * @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
+   * @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
+   * @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
+   * @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/TWS/parse.js

@@ -0,0 +1,86 @@
+import { Story } from '../Story.js';
+import Passage from '../Passage.js';
+import { Parser } from 'pickleparser';
+
+/**
+ * Parse TWS file (as Buffer) into Story.
+ * Unless it throws an error, it will return a Story object.
+ *
+ * See: Twine 1 TWS Documentation [Approval Pending]
+ * @param {Buffer} binaryFileContents - File contents to parse as Buffer.
+ * @returns {Story} Story object.
+ */
+function parse (binaryFileContents) {
+  // Is this Buffer?
+  if (!Buffer.isBuffer(binaryFileContents)) {
+    // Throw an error. We cannot proceed.
+    throw new Error('Only parsing of Buffer is allowed!');
+  }
+
+  // Create a new PickleParser.
+  const parser = new Parser();
+
+  // Set default value.
+  let pythonObject = null;
+
+  // Does the Buffer contain pickle data?
+  try {
+    // Try to parse the pickle data, assuming it is pickle data.
+    pythonObject = parser.parse(binaryFileContents);
+  } catch (error) {
+    // This is a Buffer, but not pickle data.
+    throw new Error('Buffer does not contain Python pickle data!');
+  }
+
+  // Create Story object.
+  const result = new Story();
+
+  // Does 'storyPanel' exist?
+  // (While Twine 1 will always generate it, we must verify.)
+  if (Object.prototype.hasOwnProperty.call(pythonObject, 'storyPanel')) {
+    // Check and possibly override Zoom level.
+    if (Object.prototype.hasOwnProperty.call(pythonObject.storyPanel, 'scale')) {
+      // Save Zoom level from TWS.
+      result.zoom = pythonObject.storyPanel.scale;
+    }
+
+    // Parse storyPanel.widgets.
+    if (Object.prototype.hasOwnProperty.call(pythonObject.storyPanel, 'widgets')) {
+      // Parse `widgets` for passages.
+      for (const widget of pythonObject.storyPanel.widgets) {
+        // Create a passage.
+        const passage = new Passage();
+
+        // Get title.
+        passage.name = widget.passage.title;
+
+        // Get position.
+        // passage.attributes.position = `${widget.pos[0]},${widget.pos[1]}`;
+
+        // Get tags.
+        passage.tags = widget.passage.tags;
+
+        // Get source.
+        passage.text = widget.passage.text;
+
+        // Set startingPassage (if found).
+        if (passage.name === 'Start') {
+          result.start = passage.name;
+        }
+
+        // Set the story name (if found).
+        if (passage.name === 'StoryTitle') {
+          result.name = passage.text;
+        }
+
+        // Add the passage.
+        result.addPassage(passage);
+      }
+    }
+  }
+
+  // Return Story object.
+  return result;
+}
+
+export { parse };