@bsb/base 9.0.0

package/lib/serviceBase/serviceBase.js

@@ -0,0 +1,420 @@
+"use strict";
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceBase = exports.BOOT_STAT_KEYS = void 0;
+const base_1 = require("../base");
+const factory_1 = require("../base/factory");
+const interfaces_1 = require("../interfaces");
+/**
+ * @hidden
+ */
+exports.BOOT_STAT_KEYS = {
+    BSB: "BSB",
+    SELF: "SELF",
+    CONFIG: "CONFIG",
+    OBSERVABLE: "OBSERVABLE",
+    EVENTS: "EVENTS",
+    SERVICES: "SERVICES",
+    INIT: "INIT",
+    RUN: "RUN",
+};
+const TIMEKEEPLOG = "[TIMER] {timerName} took ({nsTime}ns) ({msTime}ms)";
+/**
+ * @hidden
+ */
+function internalTrace(span) {
+    return (0, interfaces_1.createFakeDTrace)("serviceBase/ServiceBase", span);
+}
+/**
+ * Main entry point for the BSB framework.
+ *
+ * This class is responsible for initializing and running the BSB framework.
+ * You can override the default behaviour of the framework by passing in your own classes for the plugins, logging, metrics, events and services.
+ * The passed in classes are not the plugins themselves, but rather the classes that handle the plugin creation, setup and running.
+ *
+ * @group Main
+ * @category Core
+ */
+class ServiceBase {
+    /**
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/classes/ServiceBase.html | API: ServiceBase}
+     */
+    mode = "development";
+    /**
+     * Create a ServiceBase instance with simple configuration
+     *
+     * @param simple - Simple configuration options
+     * @returns New ServiceBase instance
+     *
+     * @group Main
+     * @category Factory
+     * @example
+     * ```typescript
+     * const app = ServiceBase.create({
+     *   cwd: './my-app',
+     *   plugins: ['logging-default', 'events-default']
+     * });
+     * ```
+     */
+    static create(simple) {
+        const options = (0, factory_1.fromSimpleOptions)(simple);
+        return new ServiceBase(options);
+    }
+    /**
+     * Create a ServiceBase instance from a preset
+     *
+     * @param preset - Preset configuration type
+     * @param overrides - Additional options to override preset defaults
+     * @returns New ServiceBase instance
+     *
+     * @group Main
+     * @category Factory
+     * @example
+     * ```typescript
+     * const app = ServiceBase.fromPreset(BSBPreset.DEVELOPMENT, {
+     *   cwd: './my-app'
+     * });
+     * ```
+     */
+    static fromPreset(preset, overrides) {
+        const options = (0, factory_1.fromPreset)(preset, overrides);
+        return new ServiceBase(options);
+    }
+    /**
+     * Create a minimal ServiceBase instance for quick prototyping
+     *
+     * @param cwd - Working directory (defaults to process.cwd())
+     * @returns New ServiceBase instance with minimal configuration
+     *
+     * @group Main
+     * @category Factory
+     * @example
+     * ```typescript
+     * const app = ServiceBase.minimal('./my-app');
+     * await app.init();
+     * await app.run();
+     * ```
+     */
+    static minimal(cwd) {
+        return ServiceBase.fromPreset(interfaces_1.BSBPreset.MINIMAL, { cwd });
+    }
+    /**
+     * Create a development ServiceBase instance with debug logging
+     *
+     * @param cwd - Working directory (defaults to process.cwd())
+     * @returns New ServiceBase instance configured for development
+     *
+     * @group Main
+     * @category Factory
+     */
+    static development(cwd) {
+        return ServiceBase.fromPreset(interfaces_1.BSBPreset.DEVELOPMENT, { cwd });
+    }
+    /**
+     * Create a production ServiceBase instance with optimized settings
+     *
+     * @param cwd - Working directory (defaults to process.cwd())
+     * @returns New ServiceBase instance configured for production
+     *
+     * @group Main
+     * @category Factory
+     */
+    static production(cwd) {
+        return ServiceBase.fromPreset(interfaces_1.BSBPreset.PRODUCTION, { cwd });
+    }
+    _CORE_PLUGIN_NAME = "core";
+    _appId;
+    observable;
+    plugins;
+    config;
+    events;
+    observableBackend;
+    services;
+    cwd;
+    coreMetrics;
+    heartBeatMetric;
+    bsbBootTimeMetric;
+    _keeps = {
+        BSB: process.hrtime(),
+    };
+    _heartbeat;
+    _startKeep(stepName) {
+        if (this._keeps === undefined) {
+            throw new base_1.BSBError(internalTrace("TIMEKEEPER"), "Internal error with timekeeper!");
+        }
+        if (this.observableBackend !== undefined) {
+            this.observableBackend.debug(internalTrace("TIMEKEEPER"), "Starting timer for {log}", { log: stepName });
+        }
+        this._keeps[stepName] = process.hrtime();
+    }
+    _outputKeep(stepName) {
+        if (this._keeps === undefined) {
+            throw new base_1.BSBError(internalTrace("TIMEKEEPER"), "Internal error with timekeeper!");
+        }
+        if (typeof this._keeps[stepName] === "number") {
+            throw new base_1.BSBError(internalTrace("TIMEKEEPER"), "Internal error with timekeeper!");
+        }
+        const diff = process.hrtime((this._keeps[stepName] || undefined));
+        this._keeps[stepName] = (diff[0] * base_1.NS_PER_SEC + diff[1]) * base_1.MS_PER_NS;
+        const logMeta = {
+            nsTime: diff[0] * base_1.NS_PER_SEC + diff[1],
+            msTime: this._keeps[stepName],
+            timerName: stepName,
+        };
+        this.observableBackend.info(internalTrace("TIMEKEEPER"), TIMEKEEPLOG, logMeta);
+    }
+    /**
+     * Creates a new ServiceBase instance to orchestrate the BSB framework.
+     *
+     * The ServiceBase is the main entry point for running BSB applications. It initializes
+     * and coordinates all subsystems including configuration, logging, metrics, events,
+     * and service plugins.
+     *
+     * @param options - Configuration options for the ServiceBase instance
+     * @param options.debug - Enable debug mode with verbose logging (default: true)
+     * @param options.live - Enable production/live mode optimizations (default: false)
+     * @param options.cwd - Working directory for the application (default: process.cwd())
+     * @param options.config - Custom configuration controller class
+     * @param options.plugins - Custom plugin loader class
+     * @param options.logging - Custom logging controller class
+     * @param options.metrics - Custom metrics controller class
+     * @param options.events - Custom events controller class
+     * @param options.services - Custom services controller class
+     *
+     * @example
+     * ```typescript
+     * // Basic usage with defaults
+     * const app = new ServiceBase();
+     * await app.init();
+     * await app.run();
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Production configuration
+     * const app = new ServiceBase({
+     *   debug: false,
+     *   live: true,
+     *   cwd: '/app'
+     * });
+     * await app.init();
+     * await app.run();
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Development configuration
+     * const app = new ServiceBase({
+     *   debug: true,
+     *   live: false,
+     *   cwd: process.cwd()
+     * });
+     * await app.init();
+     * await app.run();
+     * ```
+     *
+     * @see {@link ServiceBase.create} for factory method with simple options
+     * @see {@link ServiceBase.fromPreset} for preset-based configuration
+     * @see {@link ServiceBase.init} for initialization
+     * @see {@link ServiceBase.run} for starting the application
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/classes/ServiceBase.html | API: ServiceBase}
+     */
+    _region;
+    constructor(options = {}) {
+        const resolvedOptions = (0, factory_1.resolveBSBOptions)(options);
+        // Set instance properties from resolved options
+        this.cwd = resolvedOptions.cwd;
+        this.mode = resolvedOptions.mode;
+        this._appId = resolvedOptions.appId;
+        this._region = resolvedOptions.region;
+        this._startKeep(exports.BOOT_STAT_KEYS.SELF);
+        // Initialize subsystems with resolved dependencies
+        this.plugins = new resolvedOptions.plugins(this.cwd, this.mode === "development");
+        this.observable = new resolvedOptions.observable(this._appId, this.mode, this.cwd, this.plugins);
+        // Initialize unified observable backend BEFORE config and events
+        this.observableBackend = new base_1.ObservableBackend(this.mode, this._appId, this._CORE_PLUGIN_NAME, this.observable);
+        // Create Observable factory for subsystems
+        const createObservableFromTrace = (trace, pluginName, attributes) => {
+            const resource = base_1.ResourceContextBuilder.build({
+                appId: this._appId,
+                mode: this.mode,
+                pluginName: pluginName,
+                cwd: this.cwd,
+                packageCwd: this.cwd,
+                pluginCwd: this.cwd,
+                pluginVersion: "1.0.0"
+            }, this._region);
+            return new base_1.PluginObservable(trace, resource, this.observableBackend, attributes || {});
+        };
+        this.events = new resolvedOptions.events(this._appId, this.mode, this.cwd, this.plugins, this.observable, createObservableFromTrace);
+        this.config = new resolvedOptions.config(this._appId, this.mode, this.cwd, this.observable, this.plugins, createObservableFromTrace);
+        this.observableBackend.info(internalTrace("CONSTRUCTOR"), "Starting BSB [{mode}]", {
+            mode: this.mode,
+        });
+        this.services = new resolvedOptions.services(this._appId, this.mode, this.cwd, this.plugins, this.observable, this._region);
+        process.stdin.resume(); //so the program will not close instantly
+        const self = this;
+        //do something when app is closing
+        process.on("exit", () => self.dispose(0, "app exit"));
+        //catches ctrl+c event
+        process.on("SIGINT", () => self.dispose(0, "manual exit"));
+        // catches "kill pid" (for example: nodemon restart)
+        process.on("SIGUSR1", () => self.dispose(1, "sig kill user 1"));
+        process.on("SIGUSR2", () => self.dispose(2, "sig kill user 2"));
+        //catches uncaught exceptions
+        process.on("uncaughtException", (error) => {
+            self.observableBackend.error(internalTrace("UNCAUGHT_EXCEPTION"), "Uncaught exception: {error}\n Stack: {stack}", { error: error.message, stack: error.stack ?? 'no stack trace' });
+            self.dispose(3, "uncaught exception", error);
+        });
+        this._outputKeep(exports.BOOT_STAT_KEYS.SELF);
+    }
+    /**
+     * Initialize all subsystems and plugins
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/classes/ServiceBase.html#init | API: ServiceBase.init}
+     */
+    async init() {
+        this._startKeep(exports.BOOT_STAT_KEYS.INIT);
+        this._startKeep(exports.BOOT_STAT_KEYS.CONFIG);
+        await this.config.init();
+        this._outputKeep(exports.BOOT_STAT_KEYS.CONFIG);
+        this._startKeep(exports.BOOT_STAT_KEYS.OBSERVABLE);
+        await this.observable.init(internalTrace("OBSERVABLE_INIT"), this.config);
+        this._outputKeep(exports.BOOT_STAT_KEYS.OBSERVABLE);
+        this._startKeep(exports.BOOT_STAT_KEYS.EVENTS);
+        await this.events.init(this.config, this.observable);
+        this._outputKeep(exports.BOOT_STAT_KEYS.EVENTS);
+        // SERVICES ORDERING
+        this._startKeep(exports.BOOT_STAT_KEYS.SERVICES);
+        await this.services.setup(this.config, this.observable, this.events);
+        await this.services.init();
+        this._outputKeep(exports.BOOT_STAT_KEYS.SERVICES);
+        this.coreMetrics = this.observableBackend;
+        this.heartBeatMetric = this.coreMetrics.createCounter("heartbeat", "Heartbeat", "Heartbeat", [this._appId]);
+        this.bsbBootTimeMetric = this.coreMetrics.createGauge("bsbBootTime", "BSB Boot Time", "BSB Boot Time", [this._appId]);
+        this._outputKeep(exports.BOOT_STAT_KEYS.INIT);
+    }
+    /**
+     * Run the application after initialization
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/classes/ServiceBase.html#run | API: ServiceBase.run}
+     */
+    async run() {
+        this._startKeep(exports.BOOT_STAT_KEYS.RUN);
+        await this.observable.run(internalTrace("OBSERVABLE_RUN"));
+        await this.events.run();
+        await this.services.run();
+        this.observableBackend.info(internalTrace("RUN"), "Disposing config for memory cleanup and safety");
+        this.config.dispose();
+        this._outputKeep(exports.BOOT_STAT_KEYS.RUN);
+        this._heartbeat = setInterval(() => this.heartBeat(), 60 * 60 * 1000);
+        this.heartBeat();
+        this._outputKeep(exports.BOOT_STAT_KEYS.BSB);
+        this.bsbBootTimeMetric.set(this._keeps[exports.BOOT_STAT_KEYS.BSB]);
+        this._keeps = undefined;
+    }
+    heartBeat() {
+        this.observableBackend.debug(internalTrace("HEARTBEAT"), "Heartbeat");
+        this.heartBeatMetric.increment();
+    }
+    _disposing = false;
+    /**
+     * Dispose all subsystems and exit process with code
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/classes/ServiceBase.html#dispose | API: ServiceBase.dispose}
+     */
+    async dispose(eCode = 0, reason, extraData) {
+        if (this._disposing) {
+            return;
+        }
+        this._disposing = true;
+        const trace = this.observableBackend.createTrace("dispose", { reason });
+        const span = this.observableBackend.createSpan(trace.trace, "dispose", { reason });
+        try {
+            this.observableBackend.info(span.trace, "Disposing BSB: {reason}", { reason });
+            if (extraData !== undefined) {
+                this.observableBackend.error(span.trace, "Extra data: {data} {trace}", { data: extraData, trace: extraData.stack });
+                console.error(extraData);
+            }
+            if (this._heartbeat !== undefined) {
+                clearInterval(this._heartbeat);
+            }
+            if (this.services !== undefined) {
+                this.observableBackend.debug(span.trace, "Disposing services");
+                this.services.dispose();
+            }
+            if (this.events !== undefined) {
+                this.observableBackend.debug(span.trace, "Disposing events");
+                this.events.dispose();
+            }
+            if (this.observable !== undefined) {
+                this.observableBackend.debug(span.trace, "Disposing observable");
+                this.observable.dispose();
+            }
+            if (this.config !== undefined) {
+                this.observableBackend.debug(span.trace, "Disposing config");
+                this.config.dispose();
+            }
+            this._keeps = undefined;
+        }
+        catch (error) {
+            span.error(error instanceof Error ? error : new Error(String(error)));
+            throw error;
+        }
+        finally {
+            span.end();
+            trace.end();
+            console.log(`APP EXIT CODE ${eCode} REASON ${reason}`);
+            process.exit(eCode);
+        }
+    }
+    /**
+     * Add a service plugin programmatically
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/classes/ServiceBase.html#addService | API: ServiceBase.addService}
+     */
+    async addService(name, plugin, config) {
+        if (this._keeps[exports.BOOT_STAT_KEYS.SERVICES] !== undefined) {
+            throw new base_1.BSBError(internalTrace("ADD_SERVICE"), "Cannot add service plugin as service already called");
+        }
+        return await this.services.addPlugin(this.config, this.observable, this.events, {
+            name,
+            plugin: name,
+            package: null,
+            version: "0.0.0",
+        }, {
+            serviceConfig: config,
+            plugin: plugin,
+            packageCwd: this.cwd,
+            pluginCwd: this.cwd,
+            pluginPath: "",
+            version: "0.0.0",
+            ref: name,
+            name,
+        }, config);
+    }
+}
+exports.ServiceBase = ServiceBase;
+exports.default = ServiceBase;
+//# sourceMappingURL=serviceBase.js.map

package/lib/serviceBase/serviceBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceBase.js","sourceRoot":"","sources":["../../src/serviceBase/serviceBase.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,kCAIiB;AACjB,6CAAmF;AACnF,8CAA4K;AAO5K;;GAEG;AACU,QAAA,cAAc,GAAG;IAC5B,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;CACF,CAAC;AAMX,MAAM,WAAW,GAAG,oDAAoD,CAAC;AAEzE;;GAEG;AACH,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAA,6BAAgB,EAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,WAAW;IACtB;;OAEG;IACc,IAAI,GAAe,aAAa,CAAC;IAElD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,MAAyB;QACrC,MAAM,OAAO,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CAAC,MAAiB,EAAE,SAA+B;QAClE,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC9C,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,CAAC,GAAY;QACzB,OAAO,WAAW,CAAC,UAAU,CAAC,sBAAS,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAC,GAAY;QAC7B,OAAO,WAAW,CAAC,UAAU,CAAC,sBAAS,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,GAAY;QAC5B,OAAO,WAAW,CAAC,UAAU,CAAC,sBAAS,CAAC,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEgB,iBAAiB,GAAG,MAAM,CAAC;IAC3B,MAAM,CAAC;IACP,UAAU,CAAe;IACzB,OAAO,CAAY;IACnB,MAAM,CAAW;IACjB,MAAM,CAAW;IACjB,iBAAiB,CAAoB;IACrC,QAAQ,CAAc;IACtB,GAAG,CAAU;IAEtB,WAAW,CAAqB;IAChC,eAAe,CAAW;IAC1B,iBAAiB,CAAS;IAE1B,MAAM,GAAqD;QACjE,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE;KACf,CAAC;IACD,UAAU,CAAkC;IAE5C,UAAU,CAAC,QAAsB;QACvC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,eAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,iCAAiC,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,0BAA0B,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC3G,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAC3C,CAAC;IAEO,WAAW,CAAC,QAAsB;QACxC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,eAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,iCAAiC,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,eAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,iCAAiC,CAAC,CAAC;QACrF,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAS,CACH,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CACtB,IAAI,CAAC,CAAC,CAAC,GAAG,iBAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAC/B,GAAG,gBAAS,CAAC;QACd,MAAM,OAAO,GAAgC;YAC3C,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,iBAAU,GAAG,IAAI,CAAC,CAAC,CAAC;YACtC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC7B,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACc,OAAO,CAAU;IAElC,YAAY,UAAsB,EAAE;QAClC,MAAM,eAAe,GAAG,IAAA,2BAAiB,EAAC,OAAO,CAAC,CAAC;QAEnD,gDAAgD;QAChD,IAAI,CAAC,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC;QAEtC,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,IAAI,CAAC,CAAC;QAErC,mDAAmD;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;QAClF,IAAI,CAAC,UAAU,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjG,iEAAiE;QACjE,IAAI,CAAC,iBAAiB,GAAG,IAAI,wBAAiB,CAC5C,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,UAAU,CAChB,CAAC;QAEF,2CAA2C;QAC3C,MAAM,yBAAyB,GAAG,CAChC,KAAa,EACb,UAAkB,EAClB,UAAsD,EAC1C,EAAE;YACd,MAAM,QAAQ,GAAG,6BAAsB,CAAC,KAAK,CAAC;gBAC5C,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,UAAU;gBACtB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,UAAU,EAAE,IAAI,CAAC,GAAG;gBACpB,SAAS,EAAE,IAAI,CAAC,GAAG;gBACnB,aAAa,EAAE,OAAO;aACvB,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAEjB,OAAO,IAAI,uBAAgB,CACzB,KAAK,EACL,QAAQ,EACR,IAAI,CAAC,iBAAiB,EACtB,UAAU,IAAI,EAAE,CACjB,CAAC;QACJ,CAAC,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CACtC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,UAAU,EACf,yBAAyB,CAC1B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CACtC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,OAAO,EACZ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,uBAAuB,EAAE;YACjF,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,QAAQ,CAC1C,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,OAAO,CACb,CAAC;QAEF,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,yCAAyC;QAEjE,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,kCAAkC;QAClC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;QAEtD,sBAAsB;QACtB,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;QAE3D,oDAAoD;QACpD,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC;QAEhE,6BAA6B;QAC7B,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,KAAY,EAAE,EAAE;YAC/C,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAC9D,8CAA8C,EAC9C,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,gBAAgB,EAAE,CACjE,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,IAAI,CAAC,CAAC;QAErC,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;QACxC,oBAAoB;QACpB,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,QAAQ,CAAC,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAEtH,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG;QACd,IAAI,CAAC,UAAU,CAAC,sBAAc,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,gDAAgD,CAAC,CAAC;QACpG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,GAAG,CAAC,CAAC;QAErC,IAAI,CAAC,UAAU,GAAG,WAAW,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,EACtB,EAAE,GAAG,EAAE,GAAG,IAAI,CACf,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,IAAI,CAAC,WAAW,CAAC,sBAAc,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAO,CAAC,sBAAc,CAAC,GAAG,CAAW,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;IACnC,CAAC;IAEO,UAAU,GAAY,KAAK,CAAC;IAEpC;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,QAAgB,CAAC,EAAE,MAAc,EAAE,SAAe;QAC9D,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACxE,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC;YACH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,yBAAyB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YAC/E,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,4BAA4B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;gBACpH,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YAC1B,CAAC;YAED,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAClC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;gBAC/D,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC1B,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC9B,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;gBAC7D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACxB,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;gBACjE,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC5B,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC9B,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;gBAC7D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACxB,CAAC;YAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACtE,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,KAAK,CAAC,GAAG,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,iBAAkB,KAAM,WAAY,MAAO,EAAE,CAAC,CAAC;YAC3D,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CACrB,IAAY,EACZ,MAAmC,EACnC,MAAoB;QAEpB,IAAI,IAAI,CAAC,MAAO,CAAC,sBAAc,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,eAAQ,CAAC,aAAa,CAAC,aAAa,CAAC,EAC7C,qDAAqD,CACtD,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAClC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,EACX;YACE,IAAI;YACJ,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,OAAO;SACjB,EACD;YACE,aAAa,EAAE,MAAM;YACrB,MAAM,EAAE,MAAuD;YAC/D,UAAU,EAAE,IAAI,CAAC,GAAG;YACpB,SAAS,EAAE,IAAI,CAAC,GAAG;YACnB,UAAU,EAAE,EAAE;YACd,OAAO,EAAE,OAAO;YAChB,GAAG,EAAE,IAAI;YACT,IAAI;SACL,EACD,MAAM,CACP,CAAC;IACJ,CAAC;CACF;AAjcD,kCAicC;AAED,kBAAe,WAAW,CAAC"}

package/lib/serviceBase/services.d.ts

@@ -0,0 +1,63 @@
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { DEBUG_MODE, IPluginDefinition, LoadedPlugin } from "../interfaces";
+import { SBConfig } from "./config";
+import { SBEvents } from "./events";
+import { SBObservable } from "./observable";
+import { SBPlugins } from "./plugins";
+/**
+ * BSB Services Controller
+ *
+ * This class is responsible for managing the services in the BSB framework.
+ * If you have a specific way of managing services, you can extend this class and then use your own class when creating the ServiceBase instance.
+ *
+ * @group Services
+ * @category Core
+ */
+export declare class SBServices {
+    private _activeServices;
+    private readonly mode;
+    private readonly appId;
+    private readonly cwd;
+    private sbPlugins;
+    private readonly observableBackend;
+    private readonly region?;
+    constructor(appId: string, mode: DEBUG_MODE, cwd: string, sbPlugins: SBPlugins, sbObservable: SBObservable, region?: string);
+    dispose(): void;
+    private remapDeps;
+    setup(sbConfig: SBConfig, sbObservable: SBObservable, sbEvents: SBEvents): Promise<void>;
+    private setupPluginClient;
+    private mapServicePlugins;
+    addPlugin(sbConfig: SBConfig, sbObservable: SBObservable, sbEvents: SBEvents, plugin: IPluginDefinition, reference: LoadedPlugin<"service">, config: any): Promise<import("../base").BSBServiceRef>;
+    private addService;
+    private sortByInitDependencies;
+    sortAndRunOrInitPlugins(type: "init" | "run"): Promise<void>;
+    private getTextReportedDeps;
+    private gatherListOfPlugins;
+    init(): Promise<void>;
+    run(): Promise<void>;
+}