extwee 2.2.5 → 2.3.0

package/types/src/Passage.d.ts

@@ -1,6 +1,40 @@
 /**
- * A passage is the smallest unit of a Twine story.
- */
+  * Passage class.
+  * @class
+  * @classdesc Represents a passage in a Twine story.
+  * @property {string} name - Name of the passage.
+  * @property {Array} tags - Tags for the passage.
+  * @property {object} metadata - Metadata for the passage.
+  * @property {string} text - Text content of the passage.
+  * @method {string} toTwee - Return a Twee representation.
+  * @method {string} toJSON - Return JSON representation.
+  * @method {string} toTwine2HTML - Return Twine 2 HTML representation.
+  * @method {string} toTwine1HTML - Return Twine 1 HTML representation.
+  * @example
+  * const p = new Passage('Start', 'This is the start of the story.');
+  * console.log(p.toTwee());
+  * // :: Start
+  * // This is the start of the story.
+  * //
+  * console.log(p.toJSON());
+  * // {"name":"Start","tags":[],"metadata":{},"text":"This is the start of the story."}
+  * console.log(p.toTwine2HTML());
+  * // <tw-passagedata pid="1" name="Start" tags="" >This is the start of the story.</tw-passagedata>
+  * console.log(p.toTwine1HTML());
+  * // <div tiddler="Start" tags="" modifier="extwee" twine-position="10,10">This is the start of the story.</div>
+  * @example
+  * const p = new Passage('Start', 'This is the start of the story.', ['start', 'beginning'], {position: '10,10', size: '100,100'});
+  * console.log(p.toTwee());
+  * // :: Start [start beginning] {"position":"10,10","size":"100,100"}
+  * // This is the start of the story.
+  * //
+  * console.log(p.toJSON());
+  * // {"name":"Start","tags":["start","beginning"],"metadata":{"position":"10,10","size":"100,100"},"text":"This is the start of the story."}
+  * console.log(p.toTwine2HTML());
+  * // <tw-passagedata pid="1" name="Start" tags="start beginning" position="10,10" size="100,100">This is the start of the story.</tw-passagedata>
+  * console.log(p.toTwine1HTML());
+  * // <div tiddler="Start" tags="start beginning" modifier="extwee" twine-position="10,10">This is the start of the story.</div>
+  */
 export default class Passage {
     /**
      * Create a passage.
@@ -12,6 +46,7 @@ export default class Passage {
     constructor(name?: string, text?: string, tags?: any[], metadata?: object);
     /**
      * @param {string} s - Name to replace
+     * @throws {Error} Name must be a String!
      */
     set name(s: string);
     /**
@@ -21,6 +56,7 @@ export default class Passage {
     get name(): string;
     /**
      * @param {Array} t - Replacement array
+     * @throws {Error} Tags must be an array!
      */
     set tags(t: any[]);
     /**
@@ -30,15 +66,17 @@ export default class Passage {
     get tags(): any[];
     /**
      * @param {object} m - Replacement object
+     * @throws {Error} Metadata must be an object literal!
      */
-    set metadata(m: any);
+    set metadata(m: object);
     /**
      * Metadata
      * @returns {object} Metadata
      */
-    get metadata(): any;
+    get metadata(): object;
     /**
      * @param {string} t - Replacement text
+     * @throws {Error} Text should be a String!
      */
     set text(t: string);
     /**
@@ -48,23 +86,30 @@ export default class Passage {
     get text(): string;
     /**
      * Return a Twee representation.
+     *
+     * See: https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md
+     *
+     * @method toTwee
      * @returns {string} String form of passage.
      */
     toTwee(): string;
     /**
      * Return JSON representation.
+     * @method toJSON
      * @returns {string} JSON string.
      */
     toJSON(): string;
     /**
      * Return Twine 2 HTML representation.
      * (Default Passage ID is 1.)
+     * @method toTwine2HTML
      * @param {number} pid - Passage ID (PID) to record in HTML.
      * @returns {string} Twine 2 HTML string.
      */
     toTwine2HTML(pid?: number): string;
     /**
      * Return Twine 1 HTML representation.
+     * @method toTwine1HTML
      * @returns {string} Twine 1 HTML string.
      */
     toTwine1HTML(): string;

package/types/src/Story.d.ts

@@ -1,4 +1,40 @@
-export default class Story {
+/**
+ * Story class.
+ * @class
+ * @classdesc Represents a Twine story.
+ * @property {string} name - Name of the story.
+ * @property {string} IFID - Interactive Fiction ID (IFID) of Story.
+ * @property {string} start - Name of start passage.
+ * @property {string} format - Story format of Story.
+ * @property {string} formatVersion - Story format version of Story.
+ * @property {number} zoom - Zoom level.
+ * @property {Array} passages - Array of Passage objects. @see {@link Passage}
+ * @property {string} creator - Program used to create Story.
+ * @property {string} creatorVersion - Version used to create Story.
+ * @property {object} metadata - Metadata of Story.
+ * @property {object} tagColors - Tag Colors
+ * @property {string} storyJavaScript - Story JavaScript
+ * @property {string} storyStylesheet - Story Stylesheet
+ * @method {number} addPassage - Add a passage to the story and returns the new length of the passages array.
+ * @method {number} removePassageByName - Remove a passage from the story by name and returns the new length of the passages array.
+ * @method {Array} getPassagesByTag - Find passages by tag.
+ * @method {Array} getPassageByName - Find passage by name.
+ * @method {number} size - Size (number of passages).
+ * @method {string} toJSON - Export Story as JSON representation.
+ * @method {string} toTwee - Return Twee representation.
+ * @method {string} toTwine2HTML - Return Twine 2 HTML representation.
+ * @method {string} toTwine1HTML - Return Twine 1 HTML representation.
+ * @example
+ * const story = new Story('My Story');
+ * story.IFID = '12345678-1234-5678-1234-567812345678';
+ * story.start = 'Start';
+ * story.format = 'SugarCube';
+ * story.formatVersion = '2.31.0';
+ * story.zoom = 1;
+ * story.creator = 'extwee';
+ * story.creatorVersion = '2.2.1';
+ */
+export class Story {
     /**
      * Creates a story.
      * @param {string} name - Name of the story.
@@ -16,18 +52,18 @@ export default class Story {
     /**
      * @param {object} a - Replacement tag colors
      */
-    set tagColors(a: any);
+    set tagColors(a: object);
     /**
      * Tag Colors object (each property is a tag and its color)
      * @returns {object} tag colors array
      */
-    get tagColors(): any;
+    get tagColors(): object;
     /**
-     * @param {string} i - Replacement IFID
+     * @param {string} i - Replacement IFID.
      */
     set IFID(i: string);
     /**
-     * Interactive Fiction ID (IFID) of Story
+     * Interactive Fiction ID (IFID) of Story.
      * @returns {string} IFID
      */
     get IFID(): string;
@@ -52,12 +88,12 @@ export default class Story {
     /**
      * @param {object} o - Replacement metadata
      */
-    set metadata(o: any);
+    set metadata(o: object);
     /**
      * Metadata of Story.
      * @returns {object} metadata of story
      */
-    get metadata(): any;
+    get metadata(): object;
     /**
      * @param {string} f - Replacement format
      */
@@ -94,41 +130,77 @@ export default class Story {
      * @returns {number} Zoom level
      */
     get zoom(): number;
+    /**
+     * Set passages in Story.
+     * @param {Array} p - Replacement passages
+     * @property {Array} passages - Passages
+     * @throws {Error} Passages must be an Array!
+     * @throws {Error} Passages must be an Array of Passage objects!
+     */
+    set passages(p: any[]);
+    /**
+     * Passages in Story.
+     * @returns {Array} Passages
+     * @property {Array} passages - Passages
+    */
+    get passages(): any[];
+    /**
+     * @param {string} s - Replacement story stylesheet
+     */
+    set storyStylesheet(s: string);
+    /**
+     * Story stylesheet data can be set as a passage, property value, or both.
+     * @returns {string} storyStylesheet
+     */
+    get storyStylesheet(): string;
+    /**
+     * Set story JavaScript.
+     * @param {string} s - Replacement story JavaScript
+     */
+    set storyJavaScript(s: string);
+    /**
+     * Get story JavaScript.
+     * @returns {string} storyJavaScript
+     */
+    get storyJavaScript(): string;
     /**
      * Add a passage to the story.
-     * `StoryData` will override story metadata and `StoryTitle` will override story name.
+     * Passing `StoryData` will override story metadata and `StoryTitle` will override story name.
+     * @method addPassage
      * @param {Passage} p - Passage to add to Story.
+     * @returns {number} Return new length of passages array.
      */
-    addPassage(p: Passage): void;
+    addPassage(p: Passage): number;
     /**
      * Remove a passage from the story by name.
-     * @param {string} name - Passage name to remove
+     * @method removePassageByName
+     * @param {string} name - Passage name to remove.
+     * @returns {number} Return new length of passages array.
      */
-    removePassageByName(name: string): void;
+    removePassageByName(name: string): number;
     /**
      * Find passages by tag.
+     * @method getPassagesByTag
      * @param {string} t - Passage name to search for
      * @returns {Array} Return array of passages
      */
     getPassagesByTag(t: string): any[];
     /**
      * Find passage by name.
+     * @method getPassageByName
      * @param {string} name - Passage name to search for
      * @returns {Passage | null} Return passage or null
      */
     getPassageByName(name: string): Passage | null;
     /**
      * Size (number of passages).
+     * @method size
      * @returns {number} Return number of passages
      */
     size(): number;
-    /**
-     * forEach-style iterator of passages in Story.
-     * @param {Function} callback - Callback function
-     */
-    forEachPassage(callback: Function): void;
     /**
      * Export Story as JSON representation.
+     * @method toJSON
      * @returns {string} JSON string.
      */
     toJSON(): string;
@@ -137,6 +209,8 @@ export default class Story {
      *
      * See: Twee 3 Specification
      * (https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md)
+     *
+     * @method toTwee
      * @returns {string} Twee String
      */
     toTwee(): string;
@@ -145,6 +219,22 @@ export default class Story {
      *
      * See: Twine 2 HTML Output
      * (https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md)
+     *
+     *  The only required attributes are `name` and `ifid` of the `<tw-storydata>` element. All others are optional.
+     *
+     * The `<tw-storydata>` element may have any number of optional attributes, which are:
+     * - `startnode`: (integer) Optional. The PID of the starting passage.
+     * - `creator`: (string) Optional. The name of the program that created the story.
+     * - `creator-version`: (string) Optional. The version of the program that created the story.
+     * - `zoom`: (decimal) Optional. The zoom level of the story.
+     * - `format`: (string) Optional. The format of the story.
+     * - `format-version`: (string) Optional. The version of the format of the story.
+     *
+     * Because story stylesheet data can be represented as a passage, property value, or both, all approaches are encoded.
+     *
+     * Because story JavaScript can be represented as a passage, property value, or both, all approaches are encoded.
+     *
+     * @method toTwine2HTML
      * @returns {string} Twine 2 HTML string
      */
     toTwine2HTML(): string;
@@ -153,9 +243,13 @@ export default class Story {
      *
      * See: Twine 1 HTML Output
      * (https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md)
+     *
+     * @method toTwine1HTML
      * @returns {string} Twine 1 HTML string.
      */
     toTwine1HTML(): string;
     #private;
 }
+export const creatorName: "extwee";
+export const creatorVersion: "2.3.0";
 import Passage from './Passage.js';

package/types/src/StoryFormat/compile.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Compiles a {@link StoryFormat} object into a JSONP string for writing to a `format.js` file.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-storyformats-spec.md Twine 2 Story Formats Specification}
+ * @param {StoryFormat} storyFormat Story format object to compile.
+ * @returns {string} JSONP string.
+ */
+export function compile(storyFormat: StoryFormat): string;
+import StoryFormat from '../StoryFormat.js';

package/types/src/StoryFormat/parse.d.ts

@@ -1,7 +1,50 @@
 /**
- * Parse a Story Format file.
- * @param {string} contents - Content
- * @returns {StoryFormat} StoryFormat object
+ * Parses story format content into a {@link StoryFormat} object.
+ *
+ * Story formats are generally JSONP files containing a JSON object with the following properties:
+ * - name: (string) Optional. (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.
+ * - url: (string) Optional.
+ * - license: (string) Optional.
+ * - proofing: (boolean) Optional (defaults to false).
+ * - source: (string) Required.
+ *
+ * If existing properties do not match their expected type, a warning will be produced and incoming value will be ignored.
+ *
+ * This function does "soft parsing." It will not throw an error if a specific property is missing or malformed.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-storyformats-spec.md Twine 2 Story Formats Specification}
+ * @function parse
+ * @param {string} contents - JSONP content.
+ * @throws {Error} - Unable to find Twine 2 JSON chunk!
+ * @throws {Error} - Unable to parse Twine 2 JSON chunk!
+ * @returns {StoryFormat} StoryFormat object.
+ * @example
+ * const contents = `{
+ * "name": "My Story Format",
+ * "version": "1.0.0",
+ * "author": "Twine",
+ * "description": "A story format.",
+ * "image": "icon.svg",
+ * "url": "https://example.com",
+ * "license": "MIT",
+ * "proofing": false,
+ * "source": "<html></html>"
+ * }`;
+ * const storyFormat = parse(contents);
+ * console.log(storyFormat);
+ * // => StoryFormat {
+ * //      name: 'My Story Format',
+ * //      version: '1.0.0',
+ * //      description: 'A story format.',
+ * //      image: 'icon.svg',
+ * //      url: 'https://example.com',
+ * //      license: 'MIT',
+ * //      proofing: false,
+ * //      source: '<html></html>'
+ * //    }
  */
 export function parse(contents: string): StoryFormat;
 import StoryFormat from '../StoryFormat.js';

package/types/src/StoryFormat.d.ts

@@ -1,97 +1,128 @@
+/**
+ * StoryFormat representing a Twine 2 story format.
+ *
+ * This class has type checking on all of its properties.
+ * If a property is set to a value of the wrong type, a TypeError will be thrown.
+ *
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-storyformats-spec.md Twine 2 Story Formats Specification}
+ *
+ * @class
+ * @classdesc A class representing a Twine 2 story format.
+ * @property {string} name - The name of the story format.
+ * @property {string} version - The semantic version of the story format.
+ * @property {string} description - The description of the story format.
+ * @property {string} author - The author of the story format.
+ * @property {string} image - The image of the story format.
+ * @property {string} url - The URL of the story format.
+ * @property {string} license - The license of the story format.
+ * @property {boolean} proofing - The proofing of the story format.
+ * @property {string} source - The source of the story format.
+ * @example
+ * const sf = new StoryFormat();
+ * sf.name = 'New';
+ * sf.version = '1.0.0';
+ * sf.description = 'New';
+ * sf.author = 'New';
+ * sf.image = 'New';
+ * sf.url = 'New';
+ * sf.license = 'New';
+ * sf.proofing = true;
+ * sf.source = 'New';
+ */
 export default class StoryFormat {
-    /**
-     * 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?: string, version?: string, description?: string, author?: string, image?: string, url?: string, license?: string, proofing?: boolean, source?: string);
     /**
-     * @param {string} n - Replacement name
+     * @param {string} n - Replacement name.
      */
     set name(n: string);
     /**
      * Name
-     * @returns {string} Name
+     * @returns {string} Name.
      */
     get name(): string;
     /**
-     * @param {string} n - Replacement version
+     * @param {string} n - Replacement version.
      */
     set version(n: string);
     /**
-     * Version
-     * @returns {string} Version
+     * Version.
+     * @returns {string} Version.
      */
     get version(): string;
     /**
-     * @param {string} d - Replacement description
+     * @param {string} d - Replacement description.
      */
     set description(d: string);
     /**
-     * Description
-     * @returns {string} Description
+     * Description.
+     * @returns {string} Description.
      */
     get description(): string;
     /**
-     * @param {string} a - Replacement author
+     * @param {string} a - Replacement author.
      */
     set author(a: string);
     /**
-     * Author
-     * @returns {string} Author
+     * Author.
+     * @returns {string} Author.
      */
     get author(): string;
     /**
-     * @param {string} i - Replacement image
+     * @param {string} i - Replacement image.
      */
     set image(i: string);
     /**
-     * Image
-     * @returns {string} Image
+     * Image.
+     * @returns {string} Image.
      */
     get image(): string;
     /**
-     * @param {string} u - Replacement URL
+     * @param {string} u - Replacement URL.
      */
     set url(u: string);
     /**
-     * URL
-     * @returns {string} URL
+     * URL.
+     * @returns {string} URL.
      */
     get url(): string;
     /**
-     * @param {string} l - Replacement license
+     * @param {string} l - Replacement license.
      */
     set license(l: string);
     /**
-     * License
-     * @returns {string} License
+     * License.
+     * @returns {string} License.
      */
     get license(): string;
     /**
-     * @param {boolean} p - Replacement proofing
+     * @param {boolean} p - Replacement proofing.
      */
     set proofing(p: boolean);
     /**
-     * Proofing
-     * @returns {boolean} Proofing
+     * Proofing.
+     * @returns {boolean} Proofing.
      */
     get proofing(): boolean;
     /**
-     * @param {string} s - Replacement source
+     * @param {string} s - Replacement source.
      */
     set source(s: string);
     /**
-     * Source
-     * @returns {string} Source
+     * Source.
+     * @returns {string} Source.
      */
     get source(): string;
+    /**
+     * Produces a string representation of the story format object.
+     * @method toString
+     * @returns {string} - A string representation of the story format.
+     */
+    toString(): string;
+    /**
+     * Produces a JSON representation of the story format object.
+     * @method toJSON
+     * @returns {object} - A JSON representation of the story format.
+     */
+    toJSON(): object;
     #private;
 }

package/types/src/TWS/parse.d.ts

@@ -1,10 +1,10 @@
 /**
  * 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]
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md Twine 1 HTML Documentation}
+ * @function parse
  * @param {Buffer} binaryFileContents - File contents to parse as Buffer.
  * @returns {Story} Story object.
  */
 export function parse(binaryFileContents: Buffer): Story;
-import Story from '../Story.js';
+import { Story } from '../Story.js';

package/types/src/Twee/parse.d.ts

@@ -1,10 +1,9 @@
 /**
  * Parses Twee 3 text into a Story object.
- *
- * See: Twee 3 Specification
- * (https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md)
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md Twee 3 Specification}
+ * @function parse
  * @param {string} fileContents - File contents to parse
  * @returns {Story} story
  */
 export function parse(fileContents: string): Story;
-import Story from '../Story.js';
+import { Story } from '../Story.js';

package/types/src/Twine1HTML/compile.d.ts

@@ -1,5 +1,7 @@
 /**
  * Write a combination of Story object, `engine.js` (from Twine 1), `header.html`, and optional `code.js`.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md Twine 1 HTML Documentation}
+ * @function compile
  * @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.
@@ -14,4 +16,4 @@ export function compile(story: Story, engine?: string, header?: string, name?: s
     jquery: string;
     modernizr: string;
 }): string;
-import Story from '../Story.js';
+import { Story } from '../Story.js';

package/types/src/Twine1HTML/parse.d.ts

@@ -1,10 +1,9 @@
 /**
  * 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)
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md Twine 1 HTML Documentation}
+ * @function parse
  * @param {string} content - Twine 1 HTML content to parse.
  * @returns {Story} Story object
  */
 export function parse(content: string): Story;
-import Story from '../Story.js';
+import { Story } from '../Story.js';

package/types/src/Twine2ArchiveHTML/compile.d.ts

@@ -1,6 +1,14 @@
 /**
  * Write array of Story objects into Twine 2 Archive HTML.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-archive-spec.md Twine 2 Archive Specification}
+ * @function compile
  * @param {Array} stories - Array of Story objects.
  * @returns {string} Twine 2 Archive HTML.
+ * @example
+ * const story1 = new Story();
+ * const story2 = new Story();
+ * const stories = [story1, story2];
+ * console.log(compile(stories));
+ * // => '<tw-storydata name="Untitled" startnode="1" creator="Twine" creator-version="2.3.9" ifid="A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6" zoom="1" format="Harlowe" format-version="3.1.0" options="" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css"></style><script role="script" id="twine-user-script" type="text/twine-javascript"></script><tw-passagedata pid="1" name="Untitled Passage" tags="" position="0,0" size="100,100"></tw-passagedata></tw-storydata>\n\n<tw-storydata name="Untitled" startnode="1" creator="Twine" creator-version="2.3.9" ifid="A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6" zoom="1" format="Harlowe" format-version="3.1.0" options="" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css"></style><script role="script" id="twine-user-script" type="text/twine-javascript"></script><tw-passagedata pid="1" name="Untitled Passage" tags="" position="0,0" size="100,100"></tw-passagedata></tw-storydata>\n\n'
  */
 export function compile(stories: any[]): string;

package/types/src/Twine2ArchiveHTML/parse.d.ts

@@ -1,6 +1,36 @@
 /**
- * Parse HTML for one or more Twine 2 HTML elements and return array of story objects.
+ * Parse Twine 2 Archive HTML and returns an array of story objects.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-archive-spec.md Twine 2 Archive Specification}
+ * @function parse
  * @param {string} content - Content to parse for Twine 2 HTML elements.
+ * @throws {TypeError} - Content is not a string!
  * @returns {Array} Array of stories found in content.
+ * @example
+ * const content = '<tw-storydata name="Untitled" startnode="1" creator="Twine" creator-version="2.3.9" ifid="A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6" zoom="1" format="Harlowe" format-version="3.1.0" options="" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css"></style><script role="script" id="twine-user-script" type="text/twine-javascript"></script><tw-passagedata pid="1" name="Untitled Passage" tags="" position="0,0" size="100,100"></tw-passagedata></tw-storydata>';
+ * console.log(parse(content));
+ * // => [
+ * //     Story {
+ * //      name: 'Untitled',
+ * //      startnode: '1',
+ * //      creator: 'Twine',
+ * //      creatorVersion: '2.3.9',
+ * //      ifid: 'A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6',
+ * //      zoom: '1',
+ * //      format: 'Harlowe',
+ * //      formatVersion: '3.1.0',
+ * //      options: '',
+ * //      hidden: '',
+ * //      passages: [
+ * //        Passage {
+ * //          pid: '1',
+ * //          name: 'Untitled Passage',
+ * //          tags: '',
+ * //          position: '0,0',
+ * //          size: '100,100',
+ * //          text: ''
+ * //        }
+ * //      ]
+ * //    }
+ * //   ]
  */
 export function parse(content: string): any[];