@harperfast/harper 5.0.0-alpha.10

package/dist/components/EntryHandler.js

@@ -0,0 +1,148 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntryHandler = void 0;
+const harper_logger_js_1 = require("../utility/logging/harper_logger.js");
+const node_events_1 = require("node:events");
+const Component_js_1 = require("./Component.js");
+const chokidar_1 = __importDefault(require("chokidar"));
+const node_path_1 = require("node:path");
+const promises_1 = require("node:fs/promises");
+const deriveURLPath_js_1 = require("./deriveURLPath.js");
+const micromatch_1 = require("micromatch");
+class EntryHandler extends node_events_1.EventEmitter {
+    #component;
+    #watcher;
+    #logger;
+    #pendingFileReads;
+    #isInitialScanComplete;
+    ready;
+    constructor(name, directory, config, logger) {
+        super();
+        this.#component = new Component_js_1.Component(name, directory, castConfig(config));
+        this.#logger = logger || (0, harper_logger_js_1.loggerWithTag)(name);
+        this.#pendingFileReads = new Set();
+        this.#isInitialScanComplete = false;
+        this.ready = (0, node_events_1.once)(this, 'ready');
+        this.#watch();
+    }
+    get name() {
+        return this.#component.name;
+    }
+    get directory() {
+        return this.#component.directory;
+    }
+    #handleAll(...[event, path, stats]) {
+        if (path === '')
+            path = '/';
+        if (!(0, micromatch_1.isMatch)(path, this.#component.globOptions.source, { ignore: this.#component.globOptions.ignore }))
+            return;
+        const absolutePath = (0, node_path_1.join)(this.directory, path);
+        switch (event) {
+            case 'add':
+            case 'change': {
+                const urlPath = (0, deriveURLPath_js_1.deriveURLPath)(this.#component, path, 'file');
+                const fileReadPromise = (0, promises_1.readFile)(absolutePath)
+                    .then((contents) => {
+                    const entry = {
+                        eventType: event,
+                        entryType: 'file',
+                        contents,
+                        stats,
+                        absolutePath,
+                        urlPath,
+                    };
+                    this.emit('all', entry);
+                    this.emit(event, entry);
+                })
+                    .finally(() => {
+                    this.#pendingFileReads.delete(fileReadPromise);
+                    this.#checkIfAllComplete();
+                });
+                this.#pendingFileReads.add(fileReadPromise);
+                break;
+            }
+            case 'unlink': {
+                const urlPath = (0, deriveURLPath_js_1.deriveURLPath)(this.#component, path, 'file');
+                const entry = {
+                    eventType: event,
+                    entryType: 'file',
+                    stats,
+                    absolutePath,
+                    urlPath,
+                };
+                this.emit('all', entry);
+                this.emit(event, entry);
+                break;
+            }
+            case 'addDir':
+            case 'unlinkDir': {
+                const urlPath = (0, deriveURLPath_js_1.deriveURLPath)(this.#component, path, 'directory');
+                const entry = {
+                    eventType: event,
+                    entryType: 'directory',
+                    stats,
+                    absolutePath,
+                    urlPath,
+                };
+                this.emit('all', entry);
+                this.emit(event, entry);
+                break;
+            }
+        }
+    }
+    #handleError(error) {
+        this.emit('error', error);
+    }
+    #handleReady() {
+        this.#isInitialScanComplete = true;
+        if (this.#pendingFileReads.size > 0) {
+            this.#logger.debug?.(`Initial scan complete, still waiting for ${this.#pendingFileReads.size} pending file reads`);
+        }
+        this.#checkIfAllComplete();
+    }
+    #checkIfAllComplete() {
+        // Only emit 'ready' once the initial scan is complete AND all file reads are done
+        if (this.#isInitialScanComplete && this.#pendingFileReads.size === 0) {
+            this.emit('ready');
+        }
+    }
+    async #watch() {
+        await this.#watcher?.close();
+        this.#watcher = undefined;
+        const allowedBases = this.#component.patternBases.map((base) => (0, node_path_1.join)(this.#component.directory, base));
+        this.#watcher = chokidar_1.default
+            .watch(this.#component.commonPatternBase, {
+            cwd: this.#component.directory,
+            persistent: false,
+            ignored: (path) => {
+                const normalizedPath = path.replace(/\\/g, '/');
+                const normalizedBases = allowedBases.map((base) => base.replace(/\\/g, '/'));
+                return (normalizedPath !== this.#component.directory.replace(/\\/g, '/') &&
+                    normalizedBases.every((base) => !normalizedPath.startsWith(base)));
+            },
+        })
+            .on('all', this.#handleAll.bind(this))
+            .on('error', this.#handleError.bind(this))
+            .on('ready', this.#handleReady.bind(this));
+        return this.ready;
+    }
+    close() {
+        this.#watcher?.close();
+        this.#watcher = undefined;
+        this.emit('close');
+        this.removeAllListeners();
+        return this;
+    }
+    update(config) {
+        this.#component = new Component_js_1.Component(this.name, this.directory, castConfig(config));
+        return this.#watch();
+    }
+}
+exports.EntryHandler = EntryHandler;
+function castConfig(config) {
+    return typeof config === 'string' || Array.isArray(config) || !('files' in config) ? { files: config } : config;
+}
+//# sourceMappingURL=EntryHandler.js.map

package/dist/components/EntryHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntryHandler.js","sourceRoot":"","sources":["../../components/EntryHandler.ts"],"names":[],"mappings":";;;;;;AACA,0EAAoE;AAEpE,6CAAiD;AACjD,iDAAiE;AACjE,wDAAkE;AAClE,yCAAiC;AACjC,+CAA4C;AAE5C,yDAAmD;AACnD,2CAAqC;AA6DrC,MAAa,YAAa,SAAQ,0BAAkC;IACnE,UAAU,CAAY;IACtB,QAAQ,CAAa;IACrB,OAAO,CAAS;IAChB,iBAAiB,CAAqB;IACtC,sBAAsB,CAAU;IAChC,KAAK,CAAiB;IAEtB,YAAY,IAAY,EAAE,SAAiB,EAAE,MAA0C,EAAE,MAAe;QACvG,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,IAAA,gCAAa,EAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,EAAE,CAAC;QACnC,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAA,kBAAI,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,EAAE,CAAC;IACf,CAAC;IAED,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAA2B;QAC3D,IAAI,IAAI,KAAK,EAAE;YAAE,IAAI,GAAG,GAAG,CAAC;QAE5B,IAAI,CAAC,IAAA,oBAAO,EAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YAAE,OAAO;QAE/G,MAAM,YAAY,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAEhD,QAAQ,KAAK,EAAE,CAAC;YACf,KAAK,KAAK,CAAC;YACX,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACf,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC7D,MAAM,eAAe,GAAG,IAAA,mBAAQ,EAAC,YAAY,CAAC;qBAC5C,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBAClB,MAAM,KAAK,GAAmC;wBAC7C,SAAS,EAAE,KAAK;wBAChB,SAAS,EAAE,MAAe;wBAC1B,QAAQ;wBACR,KAAK;wBACL,YAAY;wBACZ,OAAO;qBACP,CAAC;oBACF,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBACxB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAY,CAAC,CAAC;gBAChC,CAAC,CAAC;qBACD,OAAO,CAAC,GAAG,EAAE;oBACb,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;oBAC/C,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC5B,CAAC,CAAC,CAAC;gBAEJ,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC5C,MAAM;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACf,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC7D,MAAM,KAAK,GAAoB;oBAC9B,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,MAAM;oBACjB,KAAK;oBACL,YAAY;oBACZ,OAAO;iBACP,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACxB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACxB,MAAM;YACP,CAAC;YACD,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW,CAAC,CAAC,CAAC;gBAClB,MAAM,OAAO,GAAG,IAAA,gCAAa,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;gBAClE,MAAM,KAAK,GAAwB;oBAClC,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,WAAoB;oBAC/B,KAAK;oBACL,YAAY;oBACZ,OAAO;iBACP,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACxB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAY,CAAC,CAAC;gBAC/B,MAAM;YACP,CAAC;QACF,CAAC;IACF,CAAC;IAED,YAAY,CAAC,KAAc;QAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,YAAY;QACX,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QACnC,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CACnB,4CAA4C,IAAI,CAAC,iBAAiB,CAAC,IAAI,qBAAqB,CAC5F,CAAC;QACH,CAAC;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC5B,CAAC;IAED,mBAAmB;QAClB,kFAAkF;QAClF,IAAI,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACtE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,CAAC;IACF,CAAC;IAED,KAAK,CAAC,MAAM;QACX,MAAM,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAE1B,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAEvG,IAAI,CAAC,QAAQ,GAAG,kBAAQ;aACtB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE;YACzC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS;YAC9B,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;gBACjB,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBAChD,MAAM,eAAe,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC7E,OAAO,CACN,cAAc,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;oBAChE,eAAe,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CACjE,CAAC;YACH,CAAC;SACD,CAAC;aACD,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACrC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACzC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,KAAK;QACJ,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAE1B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,CAAC,MAA0C;QAChD,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAE/E,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;CACD;AAvJD,oCAuJC;AAED,SAAS,UAAU,CAAC,MAA0C;IAC7D,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AACjH,CAAC"}

package/dist/components/OptionsWatcher.d.ts

@@ -0,0 +1,75 @@
+import { type Logger } from '../utility/logging/logger.ts';
+import { EventEmitter } from 'events';
+export interface Config {
+    [key: string]: ConfigValue;
+}
+export type ConfigValue = undefined | null | string | number | boolean | Array<ConfigValue> | Config;
+export type OptionsWatcherEventMap = {
+    ready: [config?: ConfigValue];
+    change: [key: string[], value: ConfigValue, config: ConfigValue];
+    remove: [];
+    error: [error: unknown];
+    close: [];
+};
+export declare class OptionsWatcherConfigFileError extends Error {
+    constructor(configFilePath: string, error: unknown);
+}
+export declare class UninitializedOptionsWatcherError extends Error {
+    constructor();
+}
+export declare class InvariantUninitializedOptionsWatcherError extends Error {
+    constructor();
+}
+export declare class InvalidValueTypeError extends Error {
+    constructor(keys: string[], value: unknown);
+}
+export declare class KeyDoesNotExistError extends Error {
+    constructor(keys: string[], key: string);
+}
+export declare class CannotSetPropertyError extends Error {
+    constructor(keys: string[]);
+}
+/**
+ * Watches a YAML configuration file for changes and provides methods to access the configuration.
+ *
+ * @emits ready - When the configuration file is initially loaded and values are available
+ * @emits change - When any value in the configuration changes (with key, new value, and full config)
+ * @emits remove - When the configuration file is removed or the extension is removed from the config
+ * @emits error - When an error occurs reading or parsing the file
+ * @emits close - When the watcher is closed
+ */
+export declare class OptionsWatcher extends EventEmitter<OptionsWatcherEventMap> {
+    #private;
+    ready: Promise<any[]>;
+    constructor(name: string, filePath: string, logger?: Logger);
+    /**
+     * Closes the underlying file watcher, emits the `close` event, and removes any listeners on the OptionsWatcher instance
+     */
+    close(): this;
+    /**
+     * Get a value from the configuration using an array of strings representing the key.
+     *
+     * For example, if the configuration is:
+     * ```yaml
+     * foo:
+     *  bar:
+     *   baz: 42
+     * ```
+     * Then `get(['foo','bar','baz'])` will return `42`.
+     *
+     * If the key does not exist, `undefined` will be returned.
+     * @param key an array of strings representing the key.
+     * @returns
+     */
+    get(key: string[]): ConfigValue | undefined;
+    /**
+     * Get the entire configuration object.
+     *
+     * @returns A deep clone of the entire configuration object.
+     */
+    getAll(): ConfigValue | undefined;
+    /**
+     * Get the entire root configuration object from the config file.
+     */
+    getRoot(): Config | undefined;
+}

package/dist/components/OptionsWatcher.js

@@ -0,0 +1,281 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsWatcher = exports.CannotSetPropertyError = exports.KeyDoesNotExistError = exports.InvalidValueTypeError = exports.InvariantUninitializedOptionsWatcherError = exports.UninitializedOptionsWatcherError = exports.OptionsWatcherConfigFileError = void 0;
+const harper_logger_js_1 = require("../utility/logging/harper_logger.js");
+const events_1 = require("events");
+const yaml_1 = __importDefault(require("yaml"));
+const chokidar_1 = __importDefault(require("chokidar"));
+const promises_1 = require("node:fs/promises");
+const util_1 = require("util");
+const DEFAULT_CONFIG_js_1 = require("./DEFAULT_CONFIG.js");
+const lodash_1 = require("lodash");
+// This is uniquely for errors coming from the chokidar watcher of the config file.
+class OptionsWatcherConfigFileError extends Error {
+    constructor(configFilePath, error) {
+        super(`Error watching config file ${configFilePath}: ${typeof error === 'object' && error !== null && 'message' in error ? error.message : error}`);
+        this.name = 'OptionsWatcherConfigFileError';
+    }
+}
+exports.OptionsWatcherConfigFileError = OptionsWatcherConfigFileError;
+class UninitializedOptionsWatcherError extends Error {
+    constructor() {
+        super('OptionsWatcher has not been initialized yet. Await `ready()` or the `ready` event of the respective OptionsWatcher instance.');
+        this.name = 'UninitializedOptionsWatcherError';
+    }
+}
+exports.UninitializedOptionsWatcherError = UninitializedOptionsWatcherError;
+class InvariantUninitializedOptionsWatcherError extends Error {
+    constructor() {
+        super('Invariant: OptionsWatcher has not been initialized yet. This should never happen.');
+        this.name = 'InvariantUninitializedOptionsWatcherError';
+    }
+}
+exports.InvariantUninitializedOptionsWatcherError = InvariantUninitializedOptionsWatcherError;
+class InvalidValueTypeError extends Error {
+    constructor(keys, value) {
+        super(`Invalid value type for key ${keys.join('.')}. Expected object, string, array, number, boolean, or undefined. Received ${typeof value}.`);
+        this.name = 'InvalidValueTypeError';
+    }
+}
+exports.InvalidValueTypeError = InvalidValueTypeError;
+class KeyDoesNotExistError extends Error {
+    constructor(keys, key) {
+        super(`Cannot set property ${keys.join('.')} as ${key} does not exist.`);
+        this.name = 'KeyDoesNotExistError';
+    }
+}
+exports.KeyDoesNotExistError = KeyDoesNotExistError;
+class CannotSetPropertyError extends Error {
+    constructor(keys) {
+        super(`Cannot set property ${keys.join('.')} as parent is not an object.`);
+        this.name = 'CannotSetPropertyError';
+    }
+}
+exports.CannotSetPropertyError = CannotSetPropertyError;
+/**
+ * Watches a YAML configuration file for changes and provides methods to access the configuration.
+ *
+ * @emits ready - When the configuration file is initially loaded and values are available
+ * @emits change - When any value in the configuration changes (with key, new value, and full config)
+ * @emits remove - When the configuration file is removed or the extension is removed from the config
+ * @emits error - When an error occurs reading or parsing the file
+ * @emits close - When the watcher is closed
+ */
+class OptionsWatcher extends events_1.EventEmitter {
+    #filePath;
+    #watcher;
+    #scopedConfig;
+    #rootConfig;
+    #name;
+    #logger;
+    ready;
+    constructor(name, filePath, logger) {
+        super();
+        this.#name = name;
+        this.#filePath = filePath;
+        this.#logger = logger || (0, harper_logger_js_1.loggerWithTag)(name);
+        this.ready = (0, events_1.once)(this, 'ready');
+        this.#watcher = chokidar_1.default
+            .watch(filePath, { persistent: false })
+            .on('add', this.#handleChange.bind(this))
+            .on('change', this.#handleChange.bind(this))
+            .on('error', this.#handleError.bind(this))
+            .on('unlink', this.#handleUnlink.bind(this))
+            .on('ready', this.#handleChange.bind(this));
+    }
+    #handleChange() {
+        (0, promises_1.readFile)(this.#filePath, 'utf-8')
+            .then((contents) => {
+            this.#rootConfig = yaml_1.default.parse(contents);
+            // If the extension is in the config file
+            if (this.#rootConfig && this.#name in this.#rootConfig) {
+                // If a config object does not exist
+                if (!this.#scopedConfig) {
+                    // set it
+                    this.#scopedConfig = this.#rootConfig[this.#name];
+                    // and emit a ready event
+                    this.emit('ready', this.#scopedConfig);
+                }
+                else {
+                    // Otherwise, merge the new config with the old config
+                    this.#merge(this.#rootConfig[this.#name], this.#scopedConfig);
+                }
+            }
+            else {
+                // Otherwise, if the extension is not in the config file
+                // This means the plugin was removed from the config file
+                if (this.#scopedConfig) {
+                    // and a config exists, remove it
+                    this.#scopedConfig = undefined;
+                    this.emit('remove');
+                }
+                // Otherwise do nothing - the user may add the config back in later
+            }
+        })
+            .catch((error) => {
+            // If the config file does not exist
+            if (error instanceof Error && 'code' in error && error.code === 'ENOENT') {
+                // And a config already exists, reset it to the default
+                if (this.#rootConfig) {
+                    this.#resetConfig();
+                    this.emit('remove');
+                }
+                else {
+                    // Otherwise, if no config exists, then just set to default and emit ready
+                    this.#resetConfig();
+                    this.emit('ready');
+                }
+                return;
+            }
+            this.emit('error', error);
+        });
+    }
+    #handleError(error) {
+        this.emit('error', new OptionsWatcherConfigFileError(this.#filePath, error));
+    }
+    #handleUnlink(path) {
+        this.#logger.warn?.(`Configuration file ${path} was deleted. Reverting to default configuration. Recreate it to restore the options watcher.`);
+        this.#resetConfig();
+        this.emit('remove');
+    }
+    #resetConfig() {
+        this.#rootConfig = DEFAULT_CONFIG_js_1.DEFAULT_CONFIG;
+        this.#scopedConfig = this.#rootConfig[this.#name];
+    }
+    /**
+     * This merge algorithm is best thought off as a diff and overwrite.
+     * The new config object will completely overwrite the old config object,
+     * but we need to recursively iterate over the new entries and emit the
+     * necessary change events.
+     *
+     * All events are considered to be a `change`.
+     */
+    #merge(newConfigValue, currentConfigValue, prevKeys = []) {
+        // First, ensure current and new config values are Config objects (not null, undefined, or a primitive)
+        if (!this.#isConfig(currentConfigValue) || !this.#isConfig(newConfigValue)) {
+            // If either is not a config, then just set as there is no need to diff/merge
+            this.#setValue(prevKeys, newConfigValue);
+            return;
+        }
+        // Check for any missing keys (new config has removed keys from current config)
+        for (const key of Object.keys(currentConfigValue)) {
+            if (!(key in newConfigValue)) {
+                this.#setValue(prevKeys.concat(key), undefined);
+            }
+        }
+        // Then, iterate of the keys in the new config and check for any changes to the current config
+        for (const [key, newValue] of Object.entries(newConfigValue)) {
+            const keys = prevKeys.concat(key);
+            const currentValue = this.#getValue(keys);
+            // If the new value is not the same type as the current value, then no equivalency check is necessary
+            // Just set the value and continue
+            if (typeof newValue !== typeof currentValue ||
+                // one exception to the above rule is if the `currentValue` is being changed from an array to an object or vice versa
+                // Check for this and shortcut as it can be treated as a type change
+                (Array.isArray(newValue) && !Array.isArray(currentValue)) ||
+                (!Array.isArray(newValue) && Array.isArray(currentValue))) {
+                this.#setValue(keys, newValue);
+                continue;
+            }
+            // If the new value is an object (non null nor an array), now merge it with the current value
+            if (!Array.isArray(newValue) && typeof newValue === 'object' && newValue !== null) {
+                if (this.#isConfig(currentValue)) {
+                    // Now we're sure currentValue is a Config
+                    this.#merge(newValue, currentValue, keys);
+                }
+                else {
+                    // If currentValue is not a Config, just set newValue
+                    this.#setValue(keys, newValue);
+                }
+                continue;
+            }
+            if (!(0, util_1.isDeepStrictEqual)(newValue, currentValue)) {
+                this.#setValue(keys, newValue);
+            }
+        }
+    }
+    #isConfig(value) {
+        return typeof value === 'object' && value !== null && value !== undefined && !Array.isArray(value);
+    }
+    #getValue(keys) {
+        let value = this.#scopedConfig;
+        for (const key of keys) {
+            if (value === null || value === undefined || typeof value !== 'object' || !(key in value))
+                return undefined;
+            value = value[key];
+        }
+        return (0, lodash_1.cloneDeep)(value);
+    }
+    #setValue(keys, value) {
+        // This method is only called by `merge`, which is only called by `changeHandler` if `this.#config` is defined.
+        // So this should never happen, but just in case, throw an error.
+        // If this ever does get triggered:
+        // - Did something else other than `merge` call this method?
+        // - Did the `merge` method get called differently?
+        // - Did the `merge` method become async and the `this.#config` get set to undefined sometime in between?
+        if (!this.#scopedConfig) {
+            throw new InvariantUninitializedOptionsWatcherError();
+        }
+        if (!['object', 'string', 'array', 'number', 'boolean', 'undefined'].includes(typeof value)) {
+            throw new InvalidValueTypeError(keys, value);
+        }
+        let obj = this.#scopedConfig;
+        for (const key of keys.slice(0, -1)) {
+            if (obj === null || obj === undefined || typeof obj !== 'object' || !(key in obj)) {
+                throw new KeyDoesNotExistError(keys, key);
+            }
+            obj = obj[key];
+        }
+        if (obj === null || obj === undefined || typeof obj !== 'object') {
+            throw new CannotSetPropertyError(keys);
+        }
+        obj[keys[keys.length - 1]] = value;
+        this.emit('change', keys, value, this.#scopedConfig);
+    }
+    /**
+     * Closes the underlying file watcher, emits the `close` event, and removes any listeners on the OptionsWatcher instance
+     */
+    close() {
+        this.#watcher.close();
+        this.emit('close');
+        this.removeAllListeners();
+        return this;
+    }
+    /**
+     * Get a value from the configuration using an array of strings representing the key.
+     *
+     * For example, if the configuration is:
+     * ```yaml
+     * foo:
+     *  bar:
+     *   baz: 42
+     * ```
+     * Then `get(['foo','bar','baz'])` will return `42`.
+     *
+     * If the key does not exist, `undefined` will be returned.
+     * @param key an array of strings representing the key.
+     * @returns
+     */
+    get(key) {
+        return this.#scopedConfig ? this.#getValue(key) : undefined;
+    }
+    /**
+     * Get the entire configuration object.
+     *
+     * @returns A deep clone of the entire configuration object.
+     */
+    getAll() {
+        return (0, lodash_1.cloneDeep)(this.#scopedConfig);
+    }
+    /**
+     * Get the entire root configuration object from the config file.
+     */
+    getRoot() {
+        return this.#rootConfig;
+    }
+}
+exports.OptionsWatcher = OptionsWatcher;
+//# sourceMappingURL=OptionsWatcher.js.map

package/dist/components/OptionsWatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionsWatcher.js","sourceRoot":"","sources":["../../components/OptionsWatcher.ts"],"names":[],"mappings":";;;;;;AACA,0EAAoE;AACpE,mCAA4C;AAC5C,gDAAwB;AACxB,wDAAoD;AACpD,+CAA4C;AAC5C,+BAAyC;AACzC,2DAAqD;AACrD,mCAAmC;AAgBnC,mFAAmF;AACnF,MAAa,6BAA8B,SAAQ,KAAK;IACvD,YAAY,cAAsB,EAAE,KAAc;QACjD,KAAK,CACJ,8BAA8B,cAAc,KAAK,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAC5I,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,+BAA+B,CAAC;IAC7C,CAAC;CACD;AAPD,sEAOC;AAED,MAAa,gCAAiC,SAAQ,KAAK;IAC1D;QACC,KAAK,CACJ,8HAA8H,CAC9H,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,kCAAkC,CAAC;IAChD,CAAC;CACD;AAPD,4EAOC;AAED,MAAa,yCAA0C,SAAQ,KAAK;IACnE;QACC,KAAK,CAAC,mFAAmF,CAAC,CAAC;QAC3F,IAAI,CAAC,IAAI,GAAG,2CAA2C,CAAC;IACzD,CAAC;CACD;AALD,8FAKC;AAED,MAAa,qBAAsB,SAAQ,KAAK;IAC/C,YAAY,IAAc,EAAE,KAAc;QACzC,KAAK,CACJ,8BAA8B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,6EAA6E,OAAO,KAAK,GAAG,CACxI,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACrC,CAAC;CACD;AAPD,sDAOC;AAED,MAAa,oBAAqB,SAAQ,KAAK;IAC9C,YAAY,IAAc,EAAE,GAAW;QACtC,KAAK,CAAC,uBAAuB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,kBAAkB,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACpC,CAAC;CACD;AALD,oDAKC;AAED,MAAa,sBAAuB,SAAQ,KAAK;IAChD,YAAY,IAAc;QACzB,KAAK,CAAC,uBAAuB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC3E,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACtC,CAAC;CACD;AALD,wDAKC;AAED;;;;;;;;GAQG;AACH,MAAa,cAAe,SAAQ,qBAAoC;IACvE,SAAS,CAAS;IAClB,QAAQ,CAAY;IACpB,aAAa,CAAe;IAC5B,WAAW,CAAU;IACrB,KAAK,CAAS;IACd,OAAO,CAAS;IAChB,KAAK,CAAiB;IAEtB,YAAY,IAAY,EAAE,QAAgB,EAAE,MAAe;QAC1D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,IAAA,gCAAa,EAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,IAAA,aAAI,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,kBAAQ;aACtB,KAAK,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;aACtC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACxC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC3C,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACzC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC3C,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,aAAa;QACZ,IAAA,mBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC;aAC/B,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,WAAW,GAAG,cAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACxC,yCAAyC;YACzC,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACxD,oCAAoC;gBACpC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;oBACzB,SAAS;oBACT,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAClD,yBAAyB;oBACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACP,sDAAsD;oBACtD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC/D,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,wDAAwD;gBACxD,yDAAyD;gBACzD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;oBACxB,iCAAiC;oBACjC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;oBAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrB,CAAC;gBACD,mEAAmE;YACpE,CAAC;QACF,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChB,oCAAoC;YACpC,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC1E,uDAAuD;gBACvD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACtB,IAAI,CAAC,YAAY,EAAE,CAAC;oBACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACP,0EAA0E;oBAC1E,IAAI,CAAC,YAAY,EAAE,CAAC;oBACpB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC;gBACD,OAAO;YACR,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CAAC,KAAc;QAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,6BAA6B,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,aAAa,CAAC,IAAY;QACzB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAClB,sBAAsB,IAAI,+FAA+F,CACzH,CAAC;QACF,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC;IAED,YAAY;QACX,IAAI,CAAC,WAAW,GAAG,kCAAc,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,cAA2B,EAAE,kBAA+B,EAAE,WAAqB,EAAE;QAC3F,uGAAuG;QACvG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5E,6EAA6E;YAC7E,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YACzC,OAAO;QACR,CAAC;QAED,+EAA+E;QAC/E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,CAAC,GAAG,IAAI,cAAc,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;YACjD,CAAC;QACF,CAAC;QAED,8FAA8F;QAC9F,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE1C,qGAAqG;YACrG,kCAAkC;YAClC,IACC,OAAO,QAAQ,KAAK,OAAO,YAAY;gBACvC,qHAAqH;gBACrH,oEAAoE;gBACpE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACzD,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EACxD,CAAC;gBACF,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC/B,SAAS;YACV,CAAC;YAED,6FAA6F;YAC7F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACnF,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;oBAClC,0CAA0C;oBAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACP,qDAAqD;oBACrD,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAChC,CAAC;gBACD,SAAS;YACV,CAAC;YAED,IAAI,CAAC,IAAA,wBAAiB,EAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAChC,CAAC;QACF,CAAC;IACF,CAAC;IAED,SAAS,CAAC,KAAkB;QAC3B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpG,CAAC;IAED,SAAS,CAAC,IAAc;QACvB,IAAI,KAAK,GAAgB,IAAI,CAAC,aAAa,CAAC;QAE5C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAC;YAE5G,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;QAED,OAAO,IAAA,kBAAS,EAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,SAAS,CAAC,IAAc,EAAE,KAAkB;QAC3C,+GAA+G;QAC/G,iEAAiE;QACjE,mCAAmC;QACnC,4DAA4D;QAC5D,mDAAmD;QACnD,yGAAyG;QACzG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACzB,MAAM,IAAI,yCAAyC,EAAE,CAAC;QACvD,CAAC;QAED,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YAC7F,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,GAAG,GAAgB,IAAI,CAAC,aAAa,CAAC;QAE1C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC;gBACnF,MAAM,IAAI,oBAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC3C,CAAC;YAED,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QAED,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAClE,MAAM,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QAEnC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,KAAK;QACJ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEnB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,GAAa;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,MAAM;QACL,OAAO,IAAA,kBAAS,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,OAAO;QACN,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;CA8BD;AA/QD,wCA+QC"}

package/dist/components/PluginModule.d.ts

@@ -0,0 +1,5 @@
+import { Scope } from './Scope';
+export interface PluginModule {
+    handleApplication: (scope: Scope) => void | Promise<void>;
+    defaultTimeout?: number;
+}

package/dist/components/PluginModule.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PluginModule.js.map

package/dist/components/PluginModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginModule.js","sourceRoot":"","sources":["../../components/PluginModule.ts"],"names":[],"mappings":""}

package/dist/components/Scope.d.ts

@@ -0,0 +1,49 @@
+import { type Logger } from '../utility/logging/logger.ts';
+import { EventEmitter } from 'node:events';
+import { type Server } from '../server/Server.ts';
+import { EntryHandler, type onEntryEventHandler } from './EntryHandler.ts';
+import { OptionsWatcher } from './OptionsWatcher.ts';
+import { type Resources } from '../resources/Resources.ts';
+import type { FileAndURLPathConfig } from './Component.ts';
+import { FilesOption } from './deriveGlobOptions.ts';
+import { ApplicationScope } from './ApplicationScope.ts';
+export declare class MissingDefaultFilesOptionError extends Error {
+    constructor();
+}
+/**
+ * This class is what is passed to the `handleApplication` function of an extension.
+ *
+ * It is imperative that the instance is "ready" before its passed to the `handleApplication` function
+ * so that the developer can immediately start using `scope.options`, etc.
+ *
+ */
+export declare class Scope extends EventEmitter {
+    #private;
+    applicationScope?: ApplicationScope;
+    options: OptionsWatcher;
+    resources?: Resources;
+    server?: Server;
+    ready: Promise<any[]>;
+    constructor(name: string, directory: string, configFilePath: string, applicationScope: ApplicationScope);
+    get logger(): Logger;
+    get name(): string;
+    get directory(): string;
+    get configFilePath(): string;
+    close(): this;
+    handleEntry(files: FilesOption | FileAndURLPathConfig, handler: onEntryEventHandler): EntryHandler;
+    handleEntry(handler: onEntryEventHandler): EntryHandler;
+    handleEntry(): EntryHandler;
+    requestRestart(): void;
+    /**
+     * Wait for all entry handlers' initial loads to complete.
+     * This includes waiting for any async operations in entry handler callbacks.
+     * Called by the component loader after handleApplication completes.
+     */
+    waitForInitialLoads(): Promise<void>;
+    /**
+     * Import a file into the scope's sandbox.
+     * @param filePath - The path of the file to import.
+     * @returns A promise that resolves with the imported module or value.
+     */
+    import(filePath: string): Promise<unknown>;
+}