extwee 2.2.4 → 2.2.6

package/types/Config/reader.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Read a JSON file and return its contents.
+ * @param {string} path Path to the JSON file.
+ * @returns {object} Parsed JSON object.
+ * @throws {Error} If the file does not exist.
+ * @throws {Error} If the file is not a valid JSON file.
+ * @example
+ * const contents = reader('test/Config/files/valid.json');
+ * console.log(contents); // {"story-format": 'Harlowe', "story-title": "My Story"}
+ */
+export function reader(path: string): object;

package/types/Passage.d.ts

@@ -68,12 +68,12 @@ export default class Passage {
      * @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!

package/types/Story.d.ts

@@ -50,12 +50,12 @@ export 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.
      */
@@ -86,12 +86,12 @@ export 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
      */
@@ -226,5 +226,5 @@ export class Story {
     #private;
 }
 export const creatorName: "extwee";
-export const creatorVersion: "2.2.4";
+export const creatorVersion: "2.2.6";
 import Passage from './Passage.js';

package/types/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/StoryFormat.d.ts

@@ -30,6 +30,7 @@
  * sf.source = 'New';
  */
 export default class StoryFormat {
+    constructor(name?: string, version?: string, description?: string, author?: string, image?: string, url?: string, license?: string, proofing?: boolean, source?: string);
     /**
      * @param {string} n - Replacement name.
      */
@@ -117,5 +118,11 @@ export default class StoryFormat {
      * @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;
 }