mahabhuta 0.7.9 → 0.8.2

package/TODO.md

@@ -4,4 +4,6 @@
 
 **Implement a command-line tool**:  It would take a module name to load that will contain Mahafuncs, then take input file and output file names.
 
-**Do something more significant with Mahafunc bundles**: 
+**Convert guide to have documents/layouts/partials/etc directories?**
+
+**Convert guide to have a `package.json` and ability to use TypeDoc to build API documentation subsite**

package/dist/CustomElement.d.ts

@@ -0,0 +1,23 @@
+import { Mahafunc } from "./Mahafunc";
+/**
+ * Implements an HTML-ish element that is replaced with
+ * some other HTML.  For example, <embed-video> might take
+ * an href= and other attributes to describe a video from
+ * a known service, the process function discerns the HTML code
+ * to use for the player, rendering that into the output.
+ */
+export declare class CustomElement extends Mahafunc {
+    /**
+     * The name of the element that is implemented by
+     * this function.
+     */
+    get elementName(): string;
+    /**
+     * The selector for a _CustomElement_ implementation
+     * is simply the name of the element.
+     */
+    get selector(): string;
+    process($element: any, metadata: any, setDirty: Function, done?: Function): Promise<void>;
+    processAll($: any, metadata: any, setDirty: Function): Promise<void>;
+}
+//# sourceMappingURL=CustomElement.d.ts.map

package/dist/CustomElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomElement.d.ts","sourceRoot":"","sources":["../lib/CustomElement.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;;;;GAMG;AACF,qBAAa,aAAc,SAAQ,QAAQ;IAExC;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAA6B;IAE7C,OAAO,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ;IAI/D,UAAU,CAAC,CAAC,KAAA,EAAE,QAAQ,KAAA,EAAE,QAAQ,EAAE,QAAQ;CAsBnD"}

package/dist/CustomElement.js

@@ -0,0 +1,74 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomElement = void 0;
+const Mahafunc_1 = require("./Mahafunc");
+const util = __importStar(require("util"));
+const index_1 = require("./index");
+/**
+ * Implements an HTML-ish element that is replaced with
+ * some other HTML.  For example, <embed-video> might take
+ * an href= and other attributes to describe a video from
+ * a known service, the process function discerns the HTML code
+ * to use for the player, rendering that into the output.
+ */
+class CustomElement extends Mahafunc_1.Mahafunc {
+    /**
+     * The name of the element that is implemented by
+     * this function.
+     */
+    get elementName() {
+        throw new Error("The 'elementName' getter must be overridden");
+    }
+    /**
+     * The selector for a _CustomElement_ implementation
+     * is simply the name of the element.
+     */
+    get selector() { return this.elementName; }
+    async process($element, metadata, setDirty, done) {
+        throw new Error("The 'process' function must be overridden");
+    }
+    async processAll($, metadata, setDirty) {
+        try {
+            let elements = this.findElements($);
+            if (elements.length <= 0)
+                return;
+            // Performance testing
+            const _start = new Date();
+            for (let element of elements) {
+                let replaceWith = await this.process($(element), metadata, setDirty);
+                // console.log(`CustomElement ${this.elementName} process returned ${replaceWith}`);
+                $(element).replaceWith(replaceWith);
+            }
+            /* if (this.elementName === "site-verification") {
+                console.log(`CustomElement ${this.elementName} `, $.html());
+            } */
+            // Performance testing
+            (0, index_1.logPerformance)(_start, `CustomElement ${this.array.name} ${this.elementName}`);
+        }
+        catch (e) {
+            console.error(`CustomElement ${this.elementName} Errored with ${util.inspect(e)}`);
+            throw e;
+        }
+    }
+}
+exports.CustomElement = CustomElement;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ3VzdG9tRWxlbWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL2xpYi9DdXN0b21FbGVtZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFDQSx5Q0FBc0M7QUFDdEMsMkNBQTZCO0FBQzdCLG1DQUF3RDtBQUV4RDs7Ozs7O0dBTUc7QUFDRixNQUFhLGFBQWMsU0FBUSxtQkFBUTtJQUV4Qzs7O09BR0c7SUFDSCxJQUFJLFdBQVc7UUFDWCxNQUFNLElBQUksS0FBSyxDQUFDLDZDQUE2QyxDQUFDLENBQUM7SUFDbkUsQ0FBQztJQUVEOzs7T0FHRztJQUNILElBQUksUUFBUSxLQUFhLE9BQU8sSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7SUFFbkQsS0FBSyxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsUUFBUSxFQUFFLFFBQWtCLEVBQUUsSUFBZTtRQUNqRSxNQUFNLElBQUksS0FBSyxDQUFDLDJDQUEyQyxDQUFDLENBQUM7SUFDakUsQ0FBQztJQUVELEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxRQUFrQjtRQUM1QyxJQUFJO1lBQ0EsSUFBSSxRQUFRLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNwQyxJQUFJLFFBQVEsQ0FBQyxNQUFNLElBQUksQ0FBQztnQkFBRSxPQUFPO1lBQ2pDLHNCQUFzQjtZQUN0QixNQUFNLE1BQU0sR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO1lBRTFCLEtBQUssSUFBSSxPQUFPLElBQUksUUFBUSxFQUFFO2dCQUMxQixJQUFJLFdBQVcsR0FBRyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxFQUFFLFFBQVEsRUFBRSxRQUFRLENBQUMsQ0FBQztnQkFDckUsb0ZBQW9GO2dCQUNwRixDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsV0FBVyxDQUFDLFdBQVcsQ0FBQyxDQUFDO2FBQ3ZDO1lBQ0Q7O2dCQUVJO1lBQ0osc0JBQXNCO1lBQ3RCLElBQUEsc0JBQWMsRUFBQyxNQUFNLEVBQUUsaUJBQWlCLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxJQUFJLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQyxDQUFDO1NBQ2xGO1FBQUMsT0FBTyxDQUFDLEVBQUU7WUFDUixPQUFPLENBQUMsS0FBSyxDQUFDLGlCQUFpQixJQUFJLENBQUMsV0FBVyxpQkFBaUIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDbkYsTUFBTSxDQUFDLENBQUM7U0FDWDtJQUNMLENBQUM7Q0FDSjtBQTFDQSxzQ0EwQ0EiLCJzb3VyY2VzQ29udGVudCI6WyJcbmltcG9ydCB7IE1haGFmdW5jIH0gZnJvbSBcIi4vTWFoYWZ1bmNcIjtcbmltcG9ydCAqIGFzIHV0aWwgZnJvbSAndXRpbCc7XG5pbXBvcnQgeyBsb2dQcm9jZXNzaW5nLCBsb2dQZXJmb3JtYW5jZSB9IGZyb20gJy4vaW5kZXgnO1xuXG4vKipcbiAqIEltcGxlbWVudHMgYW4gSFRNTC1pc2ggZWxlbWVudCB0aGF0IGlzIHJlcGxhY2VkIHdpdGhcbiAqIHNvbWUgb3RoZXIgSFRNTC4gIEZvciBleGFtcGxlLCA8ZW1iZWQtdmlkZW8+IG1pZ2h0IHRha2VcbiAqIGFuIGhyZWY9IGFuZCBvdGhlciBhdHRyaWJ1dGVzIHRvIGRlc2NyaWJlIGEgdmlkZW8gZnJvbVxuICogYSBrbm93biBzZXJ2aWNlLCB0aGUgcHJvY2VzcyBmdW5jdGlvbiBkaXNjZXJucyB0aGUgSFRNTCBjb2RlXG4gKiB0byB1c2UgZm9yIHRoZSBwbGF5ZXIsIHJlbmRlcmluZyB0aGF0IGludG8gdGhlIG91dHB1dC5cbiAqL1xuIGV4cG9ydCBjbGFzcyBDdXN0b21FbGVtZW50IGV4dGVuZHMgTWFoYWZ1bmMge1xuXG4gICAgLyoqXG4gICAgICogVGhlIG5hbWUgb2YgdGhlIGVsZW1lbnQgdGhhdCBpcyBpbXBsZW1lbnRlZCBieVxuICAgICAqIHRoaXMgZnVuY3Rpb24uXG4gICAgICovXG4gICAgZ2V0IGVsZW1lbnROYW1lKCk6IHN0cmluZyB7XG4gICAgICAgIHRocm93IG5ldyBFcnJvcihcIlRoZSAnZWxlbWVudE5hbWUnIGdldHRlciBtdXN0IGJlIG92ZXJyaWRkZW5cIik7XG4gICAgfVxuXG4gICAgLyoqXG4gICAgICogVGhlIHNlbGVjdG9yIGZvciBhIF9DdXN0b21FbGVtZW50XyBpbXBsZW1lbnRhdGlvblxuICAgICAqIGlzIHNpbXBseSB0aGUgbmFtZSBvZiB0aGUgZWxlbWVudC5cbiAgICAgKi9cbiAgICBnZXQgc2VsZWN0b3IoKTogc3RyaW5nIHsgcmV0dXJuIHRoaXMuZWxlbWVudE5hbWU7IH1cblxuICAgIGFzeW5jIHByb2Nlc3MoJGVsZW1lbnQsIG1ldGFkYXRhLCBzZXREaXJ0eTogRnVuY3Rpb24sIGRvbmU/OiBGdW5jdGlvbikge1xuICAgICAgICB0aHJvdyBuZXcgRXJyb3IoXCJUaGUgJ3Byb2Nlc3MnIGZ1bmN0aW9uIG11c3QgYmUgb3ZlcnJpZGRlblwiKTtcbiAgICB9XG5cbiAgICBhc3luYyBwcm9jZXNzQWxsKCQsIG1ldGFkYXRhLCBzZXREaXJ0eTogRnVuY3Rpb24pIHtcbiAgICAgICAgdHJ5IHtcbiAgICAgICAgICAgIGxldCBlbGVtZW50cyA9IHRoaXMuZmluZEVsZW1lbnRzKCQpO1xuICAgICAgICAgICAgaWYgKGVsZW1lbnRzLmxlbmd0aCA8PSAwKSByZXR1cm47XG4gICAgICAgICAgICAvLyBQZXJmb3JtYW5jZSB0ZXN0aW5nXG4gICAgICAgICAgICBjb25zdCBfc3RhcnQgPSBuZXcgRGF0ZSgpO1xuXG4gICAgICAgICAgICBmb3IgKGxldCBlbGVtZW50IG9mIGVsZW1lbnRzKSB7XG4gICAgICAgICAgICAgICAgbGV0IHJlcGxhY2VXaXRoID0gYXdhaXQgdGhpcy5wcm9jZXNzKCQoZWxlbWVudCksIG1ldGFkYXRhLCBzZXREaXJ0eSk7XG4gICAgICAgICAgICAgICAgLy8gY29uc29sZS5sb2coYEN1c3RvbUVsZW1lbnQgJHt0aGlzLmVsZW1lbnROYW1lfSBwcm9jZXNzIHJldHVybmVkICR7cmVwbGFjZVdpdGh9YCk7XG4gICAgICAgICAgICAgICAgJChlbGVtZW50KS5yZXBsYWNlV2l0aChyZXBsYWNlV2l0aCk7XG4gICAgICAgICAgICB9XG4gICAgICAgICAgICAvKiBpZiAodGhpcy5lbGVtZW50TmFtZSA9PT0gXCJzaXRlLXZlcmlmaWNhdGlvblwiKSB7XG4gICAgICAgICAgICAgICAgY29uc29sZS5sb2coYEN1c3RvbUVsZW1lbnQgJHt0aGlzLmVsZW1lbnROYW1lfSBgLCAkLmh0bWwoKSk7XG4gICAgICAgICAgICB9ICovXG4gICAgICAgICAgICAvLyBQZXJmb3JtYW5jZSB0ZXN0aW5nXG4gICAgICAgICAgICBsb2dQZXJmb3JtYW5jZShfc3RhcnQsIGBDdXN0b21FbGVtZW50ICR7dGhpcy5hcnJheS5uYW1lfSAke3RoaXMuZWxlbWVudE5hbWV9YCk7XG4gICAgICAgIH0gY2F0Y2ggKGUpIHtcbiAgICAgICAgICAgIGNvbnNvbGUuZXJyb3IoYEN1c3RvbUVsZW1lbnQgJHt0aGlzLmVsZW1lbnROYW1lfSBFcnJvcmVkIHdpdGggJHt1dGlsLmluc3BlY3QoZSl9YCk7XG4gICAgICAgICAgICB0aHJvdyBlO1xuICAgICAgICB9XG4gICAgfVxufVxuIl19

package/dist/ElementTweaker.d.ts

@@ -0,0 +1,5 @@
+import { Mahafunc } from "./Mahafunc";
+export declare class ElementTweaker extends Mahafunc {
+    process($element: any, metadata: any, setDirty: Function, done?: Function): Promise<void>;
+}
+//# sourceMappingURL=ElementTweaker.d.ts.map

package/dist/ElementTweaker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementTweaker.d.ts","sourceRoot":"","sources":["../lib/ElementTweaker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,qBAAa,cAAe,SAAQ,QAAQ;IAClC,OAAO,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ;CAGxE"}

package/dist/ElementTweaker.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ElementTweaker = void 0;
+const Mahafunc_1 = require("./Mahafunc");
+class ElementTweaker extends Mahafunc_1.Mahafunc {
+    async process($element, metadata, setDirty, done) {
+        throw new Error("The 'process' function must be overridden");
+    }
+}
+exports.ElementTweaker = ElementTweaker;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRWxlbWVudFR3ZWFrZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9saWIvRWxlbWVudFR3ZWFrZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EseUNBQXFDO0FBRXJDLE1BQWEsY0FBZSxTQUFRLG1CQUFRO0lBQ3hDLEtBQUssQ0FBQyxPQUFPLENBQUMsUUFBUSxFQUFFLFFBQVEsRUFBRSxRQUFrQixFQUFFLElBQWU7UUFDakUsTUFBTSxJQUFJLEtBQUssQ0FBQywyQ0FBMkMsQ0FBQyxDQUFBO0lBQ2hFLENBQUM7Q0FDSjtBQUpELHdDQUlDIiwic291cmNlc0NvbnRlbnQiOlsiXG5pbXBvcnQgeyBNYWhhZnVuYyB9IGZyb20gXCIuL01haGFmdW5jXCJcblxuZXhwb3J0IGNsYXNzIEVsZW1lbnRUd2Vha2VyIGV4dGVuZHMgTWFoYWZ1bmMge1xuICAgIGFzeW5jIHByb2Nlc3MoJGVsZW1lbnQsIG1ldGFkYXRhLCBzZXREaXJ0eTogRnVuY3Rpb24sIGRvbmU/OiBGdW5jdGlvbikge1xuICAgICAgICB0aHJvdyBuZXcgRXJyb3IoXCJUaGUgJ3Byb2Nlc3MnIGZ1bmN0aW9uIG11c3QgYmUgb3ZlcnJpZGRlblwiKVxuICAgIH1cbn1cbiJdfQ==

package/dist/Mahafunc.d.ts

@@ -0,0 +1,61 @@
+import { MahafuncArray } from "./MahafuncArray";
+/**
+ * A superclass for implementing processor functions
+ * for use with Mahabhuta.  This class is not meant to
+ * be instantiated directly, but to be extended.  Instead
+ * it is meant for applications to instantiate subclasses
+ * of this class.
+ */
+export declare class Mahafunc {
+    /**
+     * Store the {@link MahafuncArray} containing
+     * this function.
+     */
+    set array(array: MahafuncArray);
+    /**
+     * Retrieve the {@link MahafuncArray} containing
+     * this function.
+     */
+    get array(): MahafuncArray;
+    /**
+     * Retrieve the options/configuration object
+     * stored in the array containing this function.
+     */
+    get options(): any;
+    /**
+     * Retrieve the jQuery-like _selector_ associated with
+     * a Mahafunc.  When the containing {@link MahafuncArray}
+     * determines whether to execute this function, it uses
+     * the selector to determine if it matches any elements.
+     *
+     * @returns the selector to use
+     */
+    get selector(): string;
+    /**
+     * Look for any elements matching the _selector_.
+     *
+     * @param $ The parsed HTML
+     * @returns An array of elements matching the selector.  If none match, the array will have zero elements.
+     */
+    findElements($: any): any[];
+    /**
+     * Run the function against an element.
+     *
+     * @param $element The element to process
+     * @param metadata The metadata object passed from the application
+     * @param setDirty The function to call if an element inserts code requiring further processing
+     * @param done Callback function if needed
+     */
+    process($element: any, metadata: any, setDirty: Function, done?: Function): Promise<void>;
+    /**
+     * Call {@link process} for every matching element.
+     * The {@link findElements} function is meant to be
+     * used to determine the matching elements.
+     *
+     * @param $ The parsed version of the HTML
+     * @param metadata The metadata object passed from the application
+     * @param setDirty The function to call if an element inserts code requiring further processing
+     */
+    processAll($: any, metadata: any, setDirty: Function): Promise<void>;
+}
+//# sourceMappingURL=Mahafunc.d.ts.map

package/dist/Mahafunc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mahafunc.d.ts","sourceRoot":"","sources":["../lib/Mahafunc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD;;;;;;GAMG;AACH,qBAAa,QAAQ;IAEjB;;;OAGG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,aAAa,EAAoC;IAElE;;;OAGG;IACH,IAAI,KAAK,IANQ,aAAa,CAMe;IAE7C;;;OAGG;IACH,IAAI,OAAO,QAA4C;IAEvD;;;;;;;OAOG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;;OAKG;IACH,YAAY,CAAC,CAAC,KAAA;IAMd;;;;;;;OAOG;IACG,OAAO,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ;IAIrE;;;;;;;;OAQG;IACG,UAAU,CAAC,CAAC,KAAA,EAAE,QAAQ,KAAA,EAAE,QAAQ,EAAE,QAAQ;CAGnD"}

package/dist/Mahafunc.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Mahafunc = void 0;
+const _mahafunc_array = Symbol('array');
+/**
+ * A superclass for implementing processor functions
+ * for use with Mahabhuta.  This class is not meant to
+ * be instantiated directly, but to be extended.  Instead
+ * it is meant for applications to instantiate subclasses
+ * of this class.
+ */
+class Mahafunc {
+    /**
+     * Store the {@link MahafuncArray} containing
+     * this function.
+     */
+    set array(array) { this[_mahafunc_array] = array; }
+    /**
+     * Retrieve the {@link MahafuncArray} containing
+     * this function.
+     */
+    get array() { return this[_mahafunc_array]; }
+    /**
+     * Retrieve the options/configuration object
+     * stored in the array containing this function.
+     */
+    get options() { return this[_mahafunc_array].options; }
+    /**
+     * Retrieve the jQuery-like _selector_ associated with
+     * a Mahafunc.  When the containing {@link MahafuncArray}
+     * determines whether to execute this function, it uses
+     * the selector to determine if it matches any elements.
+     *
+     * @returns the selector to use
+     */
+    get selector() {
+        throw new Error("The 'selector' getter must be overridden");
+    }
+    /**
+     * Look for any elements matching the _selector_.
+     *
+     * @param $ The parsed HTML
+     * @returns An array of elements matching the selector.  If none match, the array will have zero elements.
+     */
+    findElements($) {
+        var ret = [];
+        $(this.selector).each(function (i, elem) { ret.push(elem); });
+        return ret;
+    }
+    /**
+     * Run the function against an element.
+     *
+     * @param $element The element to process
+     * @param metadata The metadata object passed from the application
+     * @param setDirty The function to call if an element inserts code requiring further processing
+     * @param done Callback function if needed
+     */
+    async process($element, metadata, setDirty, done) {
+        throw new Error("The 'process' function must be overridden");
+    }
+    /**
+     * Call {@link process} for every matching element.
+     * The {@link findElements} function is meant to be
+     * used to determine the matching elements.
+     *
+     * @param $ The parsed version of the HTML
+     * @param metadata The metadata object passed from the application
+     * @param setDirty The function to call if an element inserts code requiring further processing
+     */
+    async processAll($, metadata, setDirty) {
+        throw new Error("The 'processAll' function must be overridden");
+    }
+}
+exports.Mahafunc = Mahafunc;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTWFoYWZ1bmMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9saWIvTWFoYWZ1bmMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBR0EsTUFBTSxlQUFlLEdBQUcsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBRXhDOzs7Ozs7R0FNRztBQUNILE1BQWEsUUFBUTtJQUVqQjs7O09BR0c7SUFDSCxJQUFJLEtBQUssQ0FBQyxLQUFvQixJQUFJLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxLQUFLLENBQUMsQ0FBQyxDQUFDO0lBRWxFOzs7T0FHRztJQUNILElBQUksS0FBSyxLQUFLLE9BQU8sSUFBSSxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUU3Qzs7O09BR0c7SUFDSCxJQUFJLE9BQU8sS0FBSyxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBRXZEOzs7Ozs7O09BT0c7SUFDSCxJQUFJLFFBQVE7UUFDUixNQUFNLElBQUksS0FBSyxDQUFDLDBDQUEwQyxDQUFDLENBQUM7SUFDaEUsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsWUFBWSxDQUFDLENBQUM7UUFDVixJQUFJLEdBQUcsR0FBRyxFQUFFLENBQUM7UUFDYixDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFTLENBQUMsRUFBRSxJQUFJLElBQUksR0FBRyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQzdELE9BQU8sR0FBRyxDQUFDO0lBQ2YsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRSxRQUFRLEVBQUUsUUFBa0IsRUFBRSxJQUFlO1FBQ2pFLE1BQU0sSUFBSSxLQUFLLENBQUMsMkNBQTJDLENBQUMsQ0FBQztJQUNqRSxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxLQUFLLENBQUMsVUFBVSxDQUFDLENBQUMsRUFBRSxRQUFRLEVBQUUsUUFBa0I7UUFDNUMsTUFBTSxJQUFJLEtBQUssQ0FBQyw4Q0FBOEMsQ0FBQyxDQUFDO0lBQ3BFLENBQUM7Q0FDSjtBQXBFRCw0QkFvRUMiLCJzb3VyY2VzQ29udGVudCI6WyJcbmltcG9ydCB7IE1haGFmdW5jQXJyYXkgfSBmcm9tIFwiLi9NYWhhZnVuY0FycmF5XCI7XG5cbmNvbnN0IF9tYWhhZnVuY19hcnJheSA9IFN5bWJvbCgnYXJyYXknKTtcblxuLyoqXG4gKiBBIHN1cGVyY2xhc3MgZm9yIGltcGxlbWVudGluZyBwcm9jZXNzb3IgZnVuY3Rpb25zXG4gKiBmb3IgdXNlIHdpdGggTWFoYWJodXRhLiAgVGhpcyBjbGFzcyBpcyBub3QgbWVhbnQgdG9cbiAqIGJlIGluc3RhbnRpYXRlZCBkaXJlY3RseSwgYnV0IHRvIGJlIGV4dGVuZGVkLiAgSW5zdGVhZFxuICogaXQgaXMgbWVhbnQgZm9yIGFwcGxpY2F0aW9ucyB0byBpbnN0YW50aWF0ZSBzdWJjbGFzc2VzXG4gKiBvZiB0aGlzIGNsYXNzLlxuICovXG5leHBvcnQgY2xhc3MgTWFoYWZ1bmMge1xuXG4gICAgLyoqXG4gICAgICogU3RvcmUgdGhlIHtAbGluayBNYWhhZnVuY0FycmF5fSBjb250YWluaW5nXG4gICAgICogdGhpcyBmdW5jdGlvbi5cbiAgICAgKi9cbiAgICBzZXQgYXJyYXkoYXJyYXk6IE1haGFmdW5jQXJyYXkpIHsgdGhpc1tfbWFoYWZ1bmNfYXJyYXldID0gYXJyYXk7IH1cblxuICAgIC8qKlxuICAgICAqIFJldHJpZXZlIHRoZSB7QGxpbmsgTWFoYWZ1bmNBcnJheX0gY29udGFpbmluZ1xuICAgICAqIHRoaXMgZnVuY3Rpb24uXG4gICAgICovXG4gICAgZ2V0IGFycmF5KCkgeyByZXR1cm4gdGhpc1tfbWFoYWZ1bmNfYXJyYXldOyB9XG5cbiAgICAvKipcbiAgICAgKiBSZXRyaWV2ZSB0aGUgb3B0aW9ucy9jb25maWd1cmF0aW9uIG9iamVjdFxuICAgICAqIHN0b3JlZCBpbiB0aGUgYXJyYXkgY29udGFpbmluZyB0aGlzIGZ1bmN0aW9uLlxuICAgICAqL1xuICAgIGdldCBvcHRpb25zKCkgeyByZXR1cm4gdGhpc1tfbWFoYWZ1bmNfYXJyYXldLm9wdGlvbnM7IH1cblxuICAgIC8qKlxuICAgICAqIFJldHJpZXZlIHRoZSBqUXVlcnktbGlrZSBfc2VsZWN0b3JfIGFzc29jaWF0ZWQgd2l0aFxuICAgICAqIGEgTWFoYWZ1bmMuICBXaGVuIHRoZSBjb250YWluaW5nIHtAbGluayBNYWhhZnVuY0FycmF5fVxuICAgICAqIGRldGVybWluZXMgd2hldGhlciB0byBleGVjdXRlIHRoaXMgZnVuY3Rpb24sIGl0IHVzZXNcbiAgICAgKiB0aGUgc2VsZWN0b3IgdG8gZGV0ZXJtaW5lIGlmIGl0IG1hdGNoZXMgYW55IGVsZW1lbnRzLlxuICAgICAqIFxuICAgICAqIEByZXR1cm5zIHRoZSBzZWxlY3RvciB0byB1c2VcbiAgICAgKi9cbiAgICBnZXQgc2VsZWN0b3IoKTogc3RyaW5nIHtcbiAgICAgICAgdGhyb3cgbmV3IEVycm9yKFwiVGhlICdzZWxlY3RvcicgZ2V0dGVyIG11c3QgYmUgb3ZlcnJpZGRlblwiKTtcbiAgICB9XG5cbiAgICAvKipcbiAgICAgKiBMb29rIGZvciBhbnkgZWxlbWVudHMgbWF0Y2hpbmcgdGhlIF9zZWxlY3Rvcl8uXG4gICAgICogXG4gICAgICogQHBhcmFtICQgVGhlIHBhcnNlZCBIVE1MXG4gICAgICogQHJldHVybnMgQW4gYXJyYXkgb2YgZWxlbWVudHMgbWF0Y2hpbmcgdGhlIHNlbGVjdG9yLiAgSWYgbm9uZSBtYXRjaCwgdGhlIGFycmF5IHdpbGwgaGF2ZSB6ZXJvIGVsZW1lbnRzLlxuICAgICAqL1xuICAgIGZpbmRFbGVtZW50cygkKSB7XG4gICAgICAgIHZhciByZXQgPSBbXTtcbiAgICAgICAgJCh0aGlzLnNlbGVjdG9yKS5lYWNoKGZ1bmN0aW9uKGksIGVsZW0pIHsgcmV0LnB1c2goZWxlbSk7IH0pO1xuICAgICAgICByZXR1cm4gcmV0O1xuICAgIH1cblxuICAgIC8qKlxuICAgICAqIFJ1biB0aGUgZnVuY3Rpb24gYWdhaW5zdCBhbiBlbGVtZW50LlxuICAgICAqIFxuICAgICAqIEBwYXJhbSAkZWxlbWVudCBUaGUgZWxlbWVudCB0byBwcm9jZXNzXG4gICAgICogQHBhcmFtIG1ldGFkYXRhIFRoZSBtZXRhZGF0YSBvYmplY3QgcGFzc2VkIGZyb20gdGhlIGFwcGxpY2F0aW9uXG4gICAgICogQHBhcmFtIHNldERpcnR5IFRoZSBmdW5jdGlvbiB0byBjYWxsIGlmIGFuIGVsZW1lbnQgaW5zZXJ0cyBjb2RlIHJlcXVpcmluZyBmdXJ0aGVyIHByb2Nlc3NpbmdcbiAgICAgKiBAcGFyYW0gZG9uZSBDYWxsYmFjayBmdW5jdGlvbiBpZiBuZWVkZWRcbiAgICAgKi9cbiAgICBhc3luYyBwcm9jZXNzKCRlbGVtZW50LCBtZXRhZGF0YSwgc2V0RGlydHk6IEZ1bmN0aW9uLCBkb25lPzogRnVuY3Rpb24pIHtcbiAgICAgICAgdGhyb3cgbmV3IEVycm9yKFwiVGhlICdwcm9jZXNzJyBmdW5jdGlvbiBtdXN0IGJlIG92ZXJyaWRkZW5cIik7XG4gICAgfVxuXG4gICAgLyoqXG4gICAgICogQ2FsbCB7QGxpbmsgcHJvY2Vzc30gZm9yIGV2ZXJ5IG1hdGNoaW5nIGVsZW1lbnQuXG4gICAgICogVGhlIHtAbGluayBmaW5kRWxlbWVudHN9IGZ1bmN0aW9uIGlzIG1lYW50IHRvIGJlXG4gICAgICogdXNlZCB0byBkZXRlcm1pbmUgdGhlIG1hdGNoaW5nIGVsZW1lbnRzLlxuICAgICAqIFxuICAgICAqIEBwYXJhbSAkIFRoZSBwYXJzZWQgdmVyc2lvbiBvZiB0aGUgSFRNTFxuICAgICAqIEBwYXJhbSBtZXRhZGF0YSBUaGUgbWV0YWRhdGEgb2JqZWN0IHBhc3NlZCBmcm9tIHRoZSBhcHBsaWNhdGlvblxuICAgICAqIEBwYXJhbSBzZXREaXJ0eSBUaGUgZnVuY3Rpb24gdG8gY2FsbCBpZiBhbiBlbGVtZW50IGluc2VydHMgY29kZSByZXF1aXJpbmcgZnVydGhlciBwcm9jZXNzaW5nXG4gICAgICovXG4gICAgYXN5bmMgcHJvY2Vzc0FsbCgkLCBtZXRhZGF0YSwgc2V0RGlydHk6IEZ1bmN0aW9uKSB7XG4gICAgICAgIHRocm93IG5ldyBFcnJvcihcIlRoZSAncHJvY2Vzc0FsbCcgZnVuY3Rpb24gbXVzdCBiZSBvdmVycmlkZGVuXCIpO1xuICAgIH1cbn1cbiJdfQ==

package/dist/MahafuncArray.d.ts

@@ -0,0 +1,89 @@
+import { Mahafunc } from './Mahafunc';
+export declare type MahafuncType = Mahafunc | MahafuncArray | Function | [];
+/**
+ * Holds a series of functions ({@link Mahafunc}) that
+ * will execute in the order they were added.
+ */
+export declare class MahafuncArray {
+    constructor(name: string, config: Object);
+    /**
+     * Retrieve the configuration object supplied
+     * to the array.
+     */
+    get options(): any;
+    /**
+     * Retrieve the name for the array.  This name is
+     * purely for informational purposes.
+     */
+    get name(): any;
+    /**
+     * Retrieve the array of functions.
+     */
+    get functions(): any;
+    /**
+     * Retrieve the array of _final_ functions.  These are
+     * executed after the main array is fully finished.
+     */
+    get final_functions(): any;
+    /**
+     * Return the number of elements in the function array.
+     */
+    get length(): number;
+    /**
+     * Return the number of elements in
+     * the final function array.
+     */
+    get length_final(): number;
+    /**
+     * Add a function to the array.
+     *
+     * For historical purposes we support several types
+     * of function.  It's preferable to use {@link Mahafunc}
+     * objects, or other {@link MahafuncArray}'s.  But we
+     * also allow bare functions.
+     *
+     * @param func A single item of type {@link MahafuncType}
+     * @returns To support chaining, the array is returned
+     */
+    addMahafunc(func: MahafuncType): MahafuncArray;
+    /**
+     * Replace any existing function array with a
+     * new array of either {@link Mahafunc} or
+     * {@link MahafuncArray} objects
+     *
+     * @param functions
+     * @returns To support chaining, the array is returned
+     */
+    setMahafuncArray(functions: Array<Mahafunc | MahafuncArray>): MahafuncArray;
+    /**
+     * Replace any existing final function array with a
+     * new array of either {@link Mahafunc} or
+     * {@link MahafuncArray} objects
+     *
+     * @param functions
+     * @returns To support chaining, the array is returned
+     */
+    setFinalMahafuncArray(final_functions: Array<Mahafunc>): MahafuncArray;
+    /**
+     * Add a function to the array.
+     *
+     * For historical purposes we support several types
+     * of function.  It's preferable to use {@link Mahafunc}
+     * objects, or other {@link MahafuncArray}'s.  But we
+     * also allow bare functions.
+     *
+     * @param func A single item of type {@link MahafuncType}
+     * @returns To support chaining, the array is returned
+     */
+    addFinalMahafunc(func: MahafuncType): MahafuncArray;
+    /**
+     * Execute the functions in the array.
+     *
+     * @param $ The parsed form of the HTML ready to use with Cheerio functions
+     * @param metadata A metadata object supplied by the application, and passed through to functions.
+     * @param dirty A function provided by {@link processAsync} that notifies whether a function has inserted something in the HTML which requires further processing.
+     * @returns
+     */
+    process($: any, metadata: any, dirty: Function): Promise<any[]>;
+}
+//# sourceMappingURL=MahafuncArray.d.ts.map

package/dist/MahafuncArray.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MahafuncArray.d.ts","sourceRoot":"","sources":["../lib/MahafuncArray.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMtC,oBAAY,YAAY,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,GAAG,EAAE,CAAC;AAOpE;;;GAGG;AACH,qBAAa,aAAa;gBAEV,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAQxC;;;OAGG;IACH,IAAI,OAAO,QAAuC;IAElD;;;OAGG;IACH,IAAI,IAAI,QAAoC;IAE5C;;OAEG;IACH,IAAI,SAAS,QAAyC;IAEtD;;;OAGG;IACH,IAAI,eAAe,QAA+C;IAElE;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAA8C;IAElE;;;OAGG;IACH,IAAI,YAAY,IAAI,MAAM,CAAoD;IAE9E;;;;;;;;;;OAUG;IACH,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,aAAa;IAe9C;;;;;;;OAOG;IACH,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,GAAG,aAAa,CAAC,GAAG,aAAa;IAc3E;;;;;;;OAOG;IACH,qBAAqB,CAAC,eAAe,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,aAAa;IActE;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,IAAI,EAAE,YAAY,GAAG,aAAa;IAenD;;;;;;;OAOG;IACG,OAAO,CAAC,CAAC,KAAA,EAAE,QAAQ,KAAA,EAAE,KAAK,EAAE,QAAQ;CAsF7C"}