extwee 2.2.2 → 2.2.3

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';