npm - extwee - Versions diffs - 2.2.1 → 2.2.3 - Mend

extwee 2.2.1 → 2.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

package/.eslintrc.json +7 -13
package/.github/codeql-analysis.yml +51 -0
package/README.md +9 -3
package/build/extwee +0 -0
package/build/extwee.web.min.js +1 -1
package/docs/objects/story.md +1 -2
package/index.js +2 -0
package/jest.config.json +5 -0
package/package.json +24 -21
package/src/IFID/generate.js +20 -0
package/src/JSON/parse.js +43 -0
package/src/Passage.js +52 -3
package/src/Story.js +266 -107
package/src/StoryFormat/parse.js +190 -80
package/src/StoryFormat.js +78 -88
package/src/TWS/parse.js +2 -2
package/src/Twee/parse.js +2 -3
package/src/Twine1HTML/compile.js +2 -0
package/src/Twine1HTML/parse.js +2 -3
package/src/Twine2ArchiveHTML/compile.js +8 -0
package/src/Twine2ArchiveHTML/parse.js +33 -3
package/src/Twine2HTML/compile.js +31 -6
package/src/Twine2HTML/parse.js +49 -54
package/test/IFID/IFID.Generate.test.js +10 -0
package/test/JSON/JSON.Parse.test.js +4 -4
package/test/{Passage.test.js → Objects/Passage.test.js} +4 -4
package/test/{Story.test.js → Objects/Story.test.js} +259 -50
package/test/{StoryFormat.test.js → Objects/StoryFormat.test.js} +10 -3
package/test/StoryFormat/StoryFormat.Parse.test.js +442 -55
package/test/TWS/Parse.test.js +1 -1
package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Parse.test.js +20 -4
package/test/Twine2HTML/Twine2HTML.Compile.test.js +35 -120
package/test/Twine2HTML/Twine2HTML.Parse.test.js +57 -38
package/test/Twine2HTML/Twine2HTMLCompiler/format.js +9 -0
package/test/Twine2HTML/Twine2HTMLParser/missingZoom.html +1 -1
package/types/IFID/generate.d.ts +14 -0
package/types/JSON/parse.d.ts +51 -0
package/types/Passage.d.ts +117 -0
package/types/Story.d.ts +230 -0
package/types/StoryFormat/parse.d.ts +50 -0
package/types/StoryFormat.d.ts +121 -0
package/types/TWS/parse.d.ts +10 -0
package/types/Twee/parse.d.ts +9 -0
package/types/Twine1HTML/compile.d.ts +19 -0
package/types/Twine1HTML/parse.d.ts +9 -0
package/types/Twine2ArchiveHTML/compile.d.ts +14 -0
package/types/Twine2ArchiveHTML/parse.d.ts +36 -0
package/types/Twine2HTML/compile.d.ts +14 -0
package/types/Twine2HTML/parse.d.ts +20 -0
package/web-index.js +2 -0
package/test/StoryFormat/StoryFormatParser/example.js +0 -3
package/test/StoryFormat/StoryFormatParser/example2.js +0 -3
package/test/StoryFormat/StoryFormatParser/format.js +0 -1
package/test/StoryFormat/StoryFormatParser/format_doublename.js +0 -1
package/test/StoryFormat/StoryFormatParser/harlowe.js +0 -3
package/test/StoryFormat/StoryFormatParser/missingAuthor.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingDescription.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingImage.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingLicense.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingName.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingProofing.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingSource.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingURL.js +0 -1
package/test/StoryFormat/StoryFormatParser/missingVersion.js +0 -1
package/test/StoryFormat/StoryFormatParser/versionWrong.js +0 -1
package/test/Twine2HTML/Twine2HTMLParser/missingName.html +0 -33
package/test/Twine2HTML/Twine2HTMLParser/missingPID.html +0 -15
package/test/Twine2HTML/Twine2HTMLParser/missingPassageName.html +0 -15

package/src/StoryFormat/parse.js CHANGED Viewed

@@ -2,30 +2,83 @@ import StoryFormat from '../StoryFormat.js';
 import { valid } from 'semver';
 /**
- * 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>'
+ * //    }
  */
 function parse (contents) {
-  // Harlowe has malformed JSON, so we have to test for it
-  const harlowePosition = contents.indexOf('harlowe');
+  // Create a StoryFormat object.
+  const sf = new StoryFormat();
-  if (harlowePosition !== -1) {
-    // The 'setup' property is malformed
+  /**
+   * Beginning with Harlowe 2.0.0 (2021), the `setup` property is added.
+   * It is not a valid JSON property and must be removed.
+   */
+  // Some versions of Harlowe can have a `setup` property, so we have to test for it.
+  const setupPosition = contents.indexOf('harlowe');
+  // If the `setup` property is found, we have to remove it.
+  if (setupPosition !== -1) {
+    // The 'setup' property is malformed.
     const setupPosition = contents.lastIndexOf(',"setup": function');
+    // Remove the 'setup' property.
     contents = contents.slice(0, setupPosition) + '}';
   }
-  // Find the start of story format or -1, if not found
+  // 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
+  // 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
+  // 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!');
+    throw new Error('Error: Unable to find Twine 2 JSON chunk!');
   } else {
     // Slice out the JSON based on curly brackets
     contents = contents.slice(openingCurlyBracketPosition, closingCurlyBracketPosition + 1);
@@ -34,101 +87,158 @@ function parse (contents) {
   // Create an object literal
   let jsonContent = {};
+  // Attempt to parse the JSON.
   try {
     jsonContent = JSON.parse(contents);
   } catch (event) {
-    throw new Error('Unable to parse Twine2 JSON chunk!');
+    throw new Error('Error: Unable to parse Twine 2 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';
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'name')) {
+    // Test if name is a string.
+    if (typeof jsonContent.name !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s name is not a string. It will be ignored.');
+    } else {
+      // Save the name.
+      sf.name = jsonContent.name;
+    }
   }
-  // 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 = '';
+  /**
+   * author: (string) Optional.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'author')) {
+    // Test if author is a string.
+    if (typeof jsonContent.author !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s author is not a string. It will be ignored.');
+    } else {
+      // Save the author.
+      sf.author = jsonContent.author;
+    }
   }
-  // Image is optional, so we have to test for it
-  if (!Object.prototype.hasOwnProperty.call(jsonContent, 'image')) {
-    // Use the default image
-    jsonContent.image = '';
+  /**
+   * description: (string) Optional.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'description')) {
+    // Test if description is a string.
+    if (typeof jsonContent.description !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s description is not a string. It will be ignored.');
+    } else {
+      // Save the description.
+      sf.description = jsonContent.description;
+    }
   }
-  // URL is optional, so we have to test for it
-  if (!Object.prototype.hasOwnProperty.call(jsonContent, 'url')) {
-    // Use the default url
-    jsonContent.url = '';
+  /**
+   * image: (string) Optional. The filename of an image (ideally SVG)
+   *      served from the same directory as the format.js file.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'image')) {
+    // Test if image is a string.
+    if (typeof jsonContent.image !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s image is not a string. It will be ignored.');
+    } else {
+      // Save the image.
+      sf.image = jsonContent.image;
+    }
   }
-  // License is optional, so we have to test for it
-  if (!Object.prototype.hasOwnProperty.call(jsonContent, 'license')) {
-    // Use the default license
-    jsonContent.license = '';
+  /**
+   * url: (string) Optional. The URL of the directory containing the `format.js` file.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'url')) {
+    // Test if url is a string.
+    if (typeof jsonContent.url !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s url is not a string. It will be ignored.');
+    } else {
+      // Save the url.
+      sf.url = jsonContent.url;
+    }
   }
-  // Proofing is optional, so we have to test for it
-  if (!Object.prototype.hasOwnProperty.call(jsonContent, 'proofing')) {
-    // Use the default proofing
-    jsonContent.proofing = false;
+  /**
+   * license: (string) Optional. The license under which the story format is released.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'license')) {
+    // Test if license is a string.
+    if (typeof jsonContent.license !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s license is not a string. It will be ignored.');
+    } else {
+      // Save the license.
+      sf.license = jsonContent.license;
+    }
   }
-  // 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!');
+  /**
+   * 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.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'proofing')) {
+    // Test if proofing is a boolean.
+    if (typeof jsonContent.proofing !== 'boolean') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s proofing is not a boolean. It will be ignored.');
+    } else {
+      // Save the proofing.
+      sf.proofing = jsonContent.proofing;
+    }
   }
-  // Test if version is semantic-style, which is required
-  if (valid(jsonContent.version) === null) {
-    throw new Error('Processed story format\'s version is not a valid semantic value!');
+  /**
+   * version: (string) Required, and semantic version-style formatting
+   *      (x.y.z, e.g., 1.2.1) of the version is also required.
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'version')) {
+    // Test if version is a string.
+    if (typeof jsonContent.version !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s version is not a string! It will be ignored.');
+    } else {
+      // Test if version is a valid semantic version.
+      if (valid(jsonContent.version)) {
+        // Save the version.
+        sf.version = jsonContent.version;
+      } else {
+        // Produce a warning.
+        console.warn('Warning: Processed story format\'s version is not semantic! It will be ignored.');
+      }
+    }
+  } else {
+    // Produce a warning.
+    console.warn('Warning: Processed story format does not have version property!');
   }
-  // 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!');
+  /**
+   * source: (string) Required. Full HTML output of the story format.
+   * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-storyformats-spec.md Twine 2 Story Formats Specification}
+   */
+  if (Object.prototype.hasOwnProperty.call(jsonContent, 'source')) {
+    // Test if source is a string.
+    if (typeof jsonContent.source !== 'string') {
+      // Produce a warning.
+      console.warn('Warning: Processed story format\'s source is not a string! It will be ignored.');
+    } else {
+      // Save the source.
+      sf.source = jsonContent.source;
+    }
+  } else {
+    // Warn if source is not found.
+    console.warn('Warning: Processed story format does not have 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
-  );
+  // Return the StoryFormat object.
+  return sf;
 }
 export { parse };

package/src/StoryFormat.js CHANGED Viewed

@@ -1,9 +1,41 @@
+/**
+ * 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 {
   /**
    * Internal name.
    * @private
    */
-  #_name = '';
+  #_name = 'Untitled Story Format';
   /**
    * Internal version.
@@ -45,7 +77,7 @@ export default class StoryFormat {
    * Internal proofing.
    * @private
    */
-  #_proofing = '';
+  #_proofing = false;
   /**
    * Internal source.
@@ -53,207 +85,165 @@ export default class StoryFormat {
    */
   #_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
+   * @returns {string} Name.
    */
   get name () { return this.#_name; }
   /**
-   * @param {string} n - Replacement 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!');
+      throw new TypeError('Name must be a string!');
     }
   }
   /**
-   * Version
-   * @returns {string} Version
+   * Version.
+   * @returns {string} Version.
    */
   get version () { return this.#_version; }
   /**
-   * @param {string} n - Replacement 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!');
+      throw new TypeError('Version must be a string!');
     }
   }
   /**
-   * Description
-   * @returns {string} Description
+   * Description.
+   * @returns {string} Description.
    */
   get description () { return this.#_description; }
   /**
-   * @param {string} d - Replacement 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!');
+      throw new TypeError('Description must be a string!');
     }
   }
   /**
-   * Author
-   * @returns {string} Author
+   * Author.
+   * @returns {string} Author.
    */
   get author () { return this.#_author; }
   /**
-   * @param {string} a - Replacement 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!');
+      throw new TypeError('Author must be a string!');
     }
   }
   /**
-   * Image
-   * @returns {string} Image
+   * Image.
+   * @returns {string} Image.
    */
   get image () { return this.#_image; }
   /**
-   * @param {string} i - Replacement 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!');
+      throw new TypeError('Image must be a string!');
     }
   }
   /**
-   * URL
-   * @returns {string} URL
+   * URL.
+   * @returns {string} URL.
    */
   get url () { return this.#_url; }
   /**
-   * @param {string} u - Replacement 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!');
+      throw new TypeError('URL must be a string!');
     }
   }
   /**
-   * License
-   * @returns {string} License
+   * License.
+   * @returns {string} License.
    */
   get license () { return this.#_license; }
   /**
-   * @param {string} l - Replacement 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!');
+      throw new TypeError('License must be a string!');
     }
   }
   /**
-   * Proofing
-   * @returns {boolean} Proofing
+   * Proofing.
+   * @returns {boolean} Proofing.
    */
   get proofing () { return this.#_proofing; }
   /**
-   * @param {boolean} p - Replacement 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!');
+      throw new TypeError('Proofing must be a Boolean!');
     }
   }
   /**
-   * Source
-   * @returns {string} Source
+   * Source.
+   * @returns {string} Source.
    */
   get source () { return this.#_source; }
   /**
-   * @param {string} s - Replacement 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!');
+      throw new TypeError('Source must be a String!');
     }
   }
+  /**
+   * Produces a string representation of the story format object.
+   * @method toString
+   * @returns {string} - A string representation of the story format.
+   */
+  toString() {
+    return JSON.stringify(this, null, "\t");
+  }
 }

package/src/TWS/parse.js CHANGED Viewed

@@ -5,8 +5,8 @@ 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]
+ * @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.
  */

package/src/Twee/parse.js CHANGED Viewed

@@ -3,9 +3,8 @@ import { Story } from '../Story.js';
 /**
  * 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
  */

package/src/Twine1HTML/compile.js CHANGED Viewed

@@ -2,6 +2,8 @@ import { Story } from '../Story.js';
 /**
  * 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.

package/src/Twine1HTML/parse.js CHANGED Viewed

@@ -4,9 +4,8 @@ import { Story } from '../Story.js';
 /**
  * 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
  */