extwee 2.2.1 → 2.2.3

package/types/Story.d.ts

@@ -0,0 +1,230 @@
+/**
+ * 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
+ * @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.
+     */
+    constructor(name?: string);
+    /**
+     * @param {string} a - Replacement story name
+     */
+    set name(a: string);
+    /**
+     * Each story has a name
+     * @returns {string} Name
+     */
+    get name(): string;
+    /**
+     * @param {object} a - Replacement tag colors
+     */
+    set tagColors(a: any);
+    /**
+     * Tag Colors object (each property is a tag and its color)
+     * @returns {object} tag colors array
+     */
+    get tagColors(): any;
+    /**
+     * @param {string} i - Replacement IFID.
+     */
+    set IFID(i: string);
+    /**
+     * Interactive Fiction ID (IFID) of Story.
+     * @returns {string} IFID
+     */
+    get IFID(): string;
+    /**
+     * @param {string} s - Replacement start
+     */
+    set start(s: string);
+    /**
+     * Name of start passage.
+     * @returns {string} start
+     */
+    get start(): string;
+    /**
+     * @param {string} f - Replacement format version
+     */
+    set formatVersion(f: string);
+    /**
+     * Story format version of Story.
+     * @returns {string} story format version
+     */
+    get formatVersion(): string;
+    /**
+     * @param {object} o - Replacement metadata
+     */
+    set metadata(o: any);
+    /**
+     * Metadata of Story.
+     * @returns {object} metadata of story
+     */
+    get metadata(): any;
+    /**
+     * @param {string} f - Replacement format
+     */
+    set format(f: string);
+    /**
+     * Story format of Story.
+     * @returns {string} format
+     */
+    get format(): string;
+    /**
+     * @param {string} c - Creator Program of Story
+     */
+    set creator(c: string);
+    /**
+     * Program used to create Story.
+     * @returns {string} Creator Program
+     */
+    get creator(): string;
+    /**
+     * @param {string} c - Version of creator program
+     */
+    set creatorVersion(c: string);
+    /**
+     * Version used to create Story.
+     * @returns {string} Version
+     */
+    get creatorVersion(): string;
+    /**
+     * @param {number} n - Replacement zoom level
+     */
+    set zoom(n: number);
+    /**
+     * Zoom level.
+     * @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[];
+    /**
+     * Add a passage to the story.
+     * 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): number;
+    /**
+     * Remove a passage from the story by name.
+     * @method removePassageByName
+     * @param {string} name - Passage name to remove.
+     * @returns {number} Return new length of passages array.
+     */
+    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;
+    /**
+     * Export Story as JSON representation.
+     * @method toJSON
+     * @returns {string} JSON string.
+     */
+    toJSON(): string;
+    /**
+     * Return Twee representation.
+     *
+     * See: Twee 3 Specification
+     * (https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md)
+     *
+     * @method toTwee
+     * @returns {string} Twee String
+     */
+    toTwee(): string;
+    /**
+     * Return Twine 2 HTML.
+     *
+     * 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.
+     *
+     * @method toTwine2HTML
+     * @returns {string} Twine 2 HTML string
+     */
+    toTwine2HTML(): string;
+    /**
+     * Return Twine 1 HTML.
+     *
+     * 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.2.3";
+import Passage from './Passage.js';

package/types/StoryFormat/parse.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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/StoryFormat.d.ts

@@ -0,0 +1,121 @@
+/**
+ * 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 {
+    /**
+     * @param {string} n - Replacement name.
+     */
+    set name(n: string);
+    /**
+     * Name
+     * @returns {string} Name.
+     */
+    get name(): string;
+    /**
+     * @param {string} n - Replacement version.
+     */
+    set version(n: string);
+    /**
+     * Version.
+     * @returns {string} Version.
+     */
+    get version(): string;
+    /**
+     * @param {string} d - Replacement description.
+     */
+    set description(d: string);
+    /**
+     * Description.
+     * @returns {string} Description.
+     */
+    get description(): string;
+    /**
+     * @param {string} a - Replacement author.
+     */
+    set author(a: string);
+    /**
+     * Author.
+     * @returns {string} Author.
+     */
+    get author(): string;
+    /**
+     * @param {string} i - Replacement image.
+     */
+    set image(i: string);
+    /**
+     * Image.
+     * @returns {string} Image.
+     */
+    get image(): string;
+    /**
+     * @param {string} u - Replacement URL.
+     */
+    set url(u: string);
+    /**
+     * URL.
+     * @returns {string} URL.
+     */
+    get url(): string;
+    /**
+     * @param {string} l - Replacement license.
+     */
+    set license(l: string);
+    /**
+     * License.
+     * @returns {string} License.
+     */
+    get license(): string;
+    /**
+     * @param {boolean} p - Replacement proofing.
+     */
+    set proofing(p: boolean);
+    /**
+     * Proofing.
+     * @returns {boolean} Proofing.
+     */
+    get proofing(): boolean;
+    /**
+     * @param {string} s - Replacement source.
+     */
+    set source(s: string);
+    /**
+     * 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;
+    #private;
+}

package/types/TWS/parse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parse TWS file (as Buffer) into Story.
+ * Unless it throws an error, it will return a Story object.
+ * @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';

package/types/Twee/parse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parses Twee 3 text into a Story object.
+ * @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';

package/types/Twine1HTML/compile.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ * @param {string} name - Name of the story format (needed for `code.js` inclusion).
+ * @param {string} codeJS - `code.js` content with additional JavaScript.
+ * @param {object} config - Limited configuration object acting in place of `StorySettings`.
+ * @param {string} config.jquery - jQuery source.
+ * @param {string} config.modernizr - Modernizr source.
+ * @returns {string} Twine 1 HTML.
+ */
+export function compile(story: Story, engine?: string, header?: string, name?: string, codeJS?: string, config?: {
+    jquery: string;
+    modernizr: string;
+}): string;
+import { Story } from '../Story.js';

package/types/Twine1HTML/parse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parses Twine 1 HTML into a Story object.
+ * @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';

package/types/Twine2ArchiveHTML/compile.d.ts

@@ -0,0 +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/Twine2ArchiveHTML/parse.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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[];

package/types/Twine2HTML/compile.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Write a combination of Story + StoryFormat into Twine 2 HTML file.
+ * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md Twine 2 HTML Output Specification}
+ * @function compile
+ * @param {Story} story - Story object to write.
+ * @param {StoryFormat} storyFormat - StoryFormat to write.
+ * @returns {string} Twine 2 HTML based on StoryFormat and Story.
+ * @throws {Error} If story is not instance of Story.
+ * @throws {Error} If storyFormat is not instance of StoryFormat.
+ * @throws {Error} If storyFormat.source is empty string.
+ */
+export function compile(story: Story, storyFormat: StoryFormat): string;
+import { Story } from '../Story.js';
+import StoryFormat from '../StoryFormat.js';

package/types/Twine2HTML/parse.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Parse Twine 2 HTML into Story object.
+ *
+ * See: Twine 2 HTML Output Specification
+ * (https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md)
+ *
+ * Produces warnings for:
+ * - Missing name attribute on `<tw-storydata>` element.
+ * - Missing IFID attribute on `<tw-storydata>` element.
+ * - Malformed IFID attribute on `<tw-storydata>` element.
+ * @function parse
+ * @param {string} content - Twine 2 HTML content to parse.
+ * @returns {Story} Story object based on Twine 2 HTML content.
+ * @throws {TypeError} Content is not a string.
+ * @throws {Error} Not Twine 2 HTML content!
+ * @throws {Error} Cannot parse passage data without name!
+ * @throws {Error} Passages are required to have PID!
+ */
+export function parse(content: string): Story;
+import { Story } from '../Story.js';

package/web-index.js

@@ -8,6 +8,7 @@ import { parse as parseTWS } from './src/TWS/parse.js';
 import { compile as compileTwine1HTML } from './src/Twine1HTML/compile.js';
 import { compile as compileTwine2HTML } from './src/Twine2HTML/compile.js';
 import { compile as compileTwine2ArchiveHTML } from './src/Twine2ArchiveHTML/compile.js';
+import { generate as generateIFID } from './src/IFID/generate.js';
 import { Story } from './src/Story.js';
 import Passage from './src/Passage.js';
 import StoryFormat from './src/StoryFormat.js';
@@ -23,6 +24,7 @@ window.Extwee = {
     compileTwine1HTML,
     compileTwine2HTML,
     compileTwine2ArchiveHTML,
+    generateIFID,
     Story,
     Passage,
     StoryFormat

package/test/StoryFormat/StoryFormatParser/example.js

@@ -1,3 +0,0 @@
-[
-  error
-]

package/test/StoryFormat/StoryFormatParser/example2.js

@@ -1,3 +0,0 @@
-{
-  "malformed:
-}