@bsb/base 9.0.0

package/lib/interfaces/tools.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @hidden
+ */
+export interface MergeObjectsKey {
+    refPropName: string;
+    refPropKey: string;
+}
+/**
+ * @hidden
+ */
+export interface SimpleStatu<T = any> {
+    status: boolean;
+    value?: T;
+}
+/**
+ * @hidden
+ */
+export type DynamicallyReferencedType = Record<string, Function>;
+/**
+ * @hidden
+ */
+export type DynamicallyReferencedMethodBase = DynamicallyReferencedType;
+/**
+ * @hidden
+ */
+export type DynamicallyReferencedMethodType<T> = T & DynamicallyReferencedMethodBase;
+/**
+ * @hidden
+ */
+export type ParamsFromString<T extends string> = T extends `${infer Pre}{${infer Param}}${infer Post}` ? // A param exists in the string, so return it as a union type that
+Param | ParamsFromString<`${Pre}${Post}`> : never;
+/**
+ * @hidden
+ */
+export type DynamicallyReferencedMethod<Interface extends DynamicallyReferencedType, Method extends string, ArgsReference extends boolean = true> = ArgsReference extends true ? Interface[Method] extends (...a: infer Arguments) => infer Return ? [
+    method: Method,
+    ...a: Arguments
+] : [
+    method: Method,
+    noMatchingMethod: never
+] : Interface[Method] extends (...a: infer Arguments) => infer Return ? Return : never;
+/**
+ * @hidden
+ */
+export declare enum CleanStringStrength {
+    soft = "soft",
+    hard = "hard",
+    exhard = "exhard",
+    url = "url",
+    ip = "ip",
+    email = "email",
+    custom = "custom"
+}
+/**
+ * @hidden
+ */
+export declare function generateAppIdHash(appId: string): string;
+/**
+ * @hidden
+ */
+export declare function generateTimeBasedId(byteLength: number, appId: string): string;
+/**
+ * @hidden
+ */
+export declare const DEBUG_MODE: boolean;

package/lib/interfaces/tools.js

@@ -0,0 +1,50 @@
+"use strict";
+// THIS FILE IS SUBJECT TO COPYRIGHT FROM THE SOURCE - https://github.com/BetterCorp/Node-Tools.git 
+// @bettercorp/tools
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEBUG_MODE = exports.CleanStringStrength = void 0;
+exports.generateAppIdHash = generateAppIdHash;
+exports.generateTimeBasedId = generateTimeBasedId;
+const node_crypto_1 = require("node:crypto");
+/**
+ * @hidden
+ */
+var CleanStringStrength;
+(function (CleanStringStrength) {
+    CleanStringStrength["soft"] = "soft";
+    CleanStringStrength["hard"] = "hard";
+    CleanStringStrength["exhard"] = "exhard";
+    CleanStringStrength["url"] = "url";
+    CleanStringStrength["ip"] = "ip";
+    CleanStringStrength["email"] = "email";
+    CleanStringStrength["custom"] = "custom";
+})(CleanStringStrength || (exports.CleanStringStrength = CleanStringStrength = {}));
+/**
+ * @hidden
+ */
+function generateAppIdHash(appId) {
+    const hash = (0, node_crypto_1.createHash)('sha256').update(appId).digest('hex');
+    return hash.slice(0, 2); // Take the first 2 characters of the hash
+}
+/**
+ * @hidden
+ */
+function generateTimeBasedId(byteLength, appId) {
+    // Get current timestamp in milliseconds
+    const timestamp = BigInt(Date.now());
+    // Convert timestamp to hexadecimal and pad to 10 characters (40 bits)
+    const timeHex = timestamp.toString(16).padStart(10, '0');
+    // Generate 2-character hash from appId
+    const appIdHash = generateAppIdHash(appId);
+    // Calculate how many bytes we need to fill with random data
+    const randomBytesLength = byteLength - 6; // 5 bytes for timestamp, 1 byte for appId hash
+    // Generate random bytes
+    const randomHex = (0, node_crypto_1.randomBytes)(randomBytesLength).toString('hex');
+    // Combine timestamp, appId hash, and random data
+    return timeHex + appIdHash + randomHex;
+}
+/**
+ * @hidden
+ */
+exports.DEBUG_MODE = process.env.NODE_ENV !== "production";
+//# sourceMappingURL=tools.js.map

package/lib/interfaces/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/interfaces/tools.ts"],"names":[],"mappings":";AAAA,oGAAoG;AACpG,oBAAoB;;;AAoFpB,8CAGC;AAKD,kDAaC;AAvGD,6CAAoD;AAkEpD;;GAEG;AACH,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,oCAAa,CAAA;IACb,wCAAiB,CAAA;IACjB,kCAAW,CAAA;IACX,gCAAS,CAAA;IACT,sCAAe,CAAA;IACf,wCAAiB,CAAA;AACnB,CAAC,EARW,mBAAmB,mCAAnB,mBAAmB,QAQ9B;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,MAAM,IAAI,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,0CAA0C;AACrE,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CAAC,UAAkB,EAAE,KAAa;IACnE,wCAAwC;IACxC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,sEAAsE;IACtE,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACzD,uCAAuC;IACvC,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC3C,4DAA4D;IAC5D,MAAM,iBAAiB,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,+CAA+C;IACzF,wBAAwB;IACxB,MAAM,SAAS,GAAG,IAAA,yBAAW,EAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjE,iDAAiD;IACjD,OAAO,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AACzC,CAAC;AAED;;GAEG;AACU,QAAA,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC"}

package/lib/plugins/config-default/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { EventsConfig, ObservableConfig, PluginDefinition, PluginType, Observable } from "../../index";
+import { BSBConfig, BSBConfigConstructor } from "../../base/BSBConfig";
+import { z } from "zod";
+export declare const Config: import("../../index").BSBPluginConfigClass<z.ZodObject<{
+    BSB_PROFILE: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    BSB_CONFIG_FILE: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>>;
+export declare class Plugin extends BSBConfig<InstanceType<typeof Config>> {
+    static Config: import("../../index").BSBPluginConfigClass<z.ZodObject<{
+        BSB_PROFILE: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        BSB_CONFIG_FILE: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+    getServicePluginDefinition(obs: Observable, pluginName: string): Promise<{
+        name: string;
+        enabled: boolean;
+    }>;
+    getObservablePlugins(): Promise<Record<string, ObservableConfig>>;
+    getEventsPlugins(): Promise<Record<string, EventsConfig>>;
+    getServicePlugins(): Promise<Record<string, PluginDefinition>>;
+    getPluginConfig(obs: Observable, pluginType: PluginType, plugin: string): Promise<object | null>;
+    dispose(): void;
+    private _appConfig;
+    private _secConfigFilePath;
+    private _deploymentProfile;
+    constructor(config: BSBConfigConstructor<InstanceType<typeof Config>>);
+    init(obs: Observable): void;
+    getPlugins(): Promise<{
+        npmPackage: string | undefined | null;
+        plugin: string;
+        name: string;
+        enabled: boolean;
+    }[]>;
+}

package/lib/plugins/config-default/index.js

@@ -0,0 +1,197 @@
+"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.Plugin = exports.Config = void 0;
+const path = require("node:path");
+const fs = require("node:fs");
+const yaml_1 = require("yaml");
+const index_1 = require("../../index");
+const BSBConfig_1 = require("../../base/BSBConfig");
+const PluginConfig_1 = require("../../base/PluginConfig");
+const zod_1 = require("zod");
+const ConfigSchema = zod_1.z.object({
+    BSB_PROFILE: zod_1.z.string().optional().default("default"),
+    BSB_CONFIG_FILE: zod_1.z.string().optional().default("./sec-config.yaml"),
+});
+exports.Config = (0, PluginConfig_1.createConfigSchema)({
+    name: "config-default",
+    description: "Default configuration plugin for profile and plugin resolution",
+    version: "1.0.0",
+    image: "../docs/public/assets/images/bsb-logo.png",
+    tags: ["core", "config", "default"],
+    documentation: ["./docs/core-plugins/config-default.md"],
+}, ConfigSchema);
+class Plugin extends BSBConfig_1.BSBConfig {
+    static Config = exports.Config;
+    async getServicePluginDefinition(obs, pluginName) {
+        const keydPlugins = Object.keys(this._appConfig[this._deploymentProfile].services ?? {});
+        const keydWithMap = keydPlugins.map((x) => {
+            return {
+                mappedName: x,
+                ...this._appConfig[this._deploymentProfile].services[x],
+            };
+        });
+        let plugin = keydWithMap.find((x) => {
+            return x.plugin === pluginName && x.enabled === true;
+        });
+        if (plugin !== undefined) {
+            return {
+                name: plugin.mappedName,
+                enabled: plugin.enabled,
+            };
+        }
+        plugin = keydWithMap.find((x) => {
+            return x.plugin === pluginName;
+        });
+        if (plugin !== undefined) {
+            return {
+                name: plugin.mappedName,
+                enabled: plugin.enabled,
+            };
+        }
+        throw new index_1.BSBError(obs.trace, "Cannot find the plugin {plugin} in the config", {
+            plugin: pluginName,
+        });
+    }
+    async getObservablePlugins() {
+        const plugins = Object.keys(this._appConfig[this._deploymentProfile].observable ?? {})
+            .filter((x) => {
+            return (this._appConfig[this._deploymentProfile].observable[x].enabled === true);
+        });
+        return plugins.reduce((acc, x) => {
+            acc[x] = {
+                version: this._appConfig[this._deploymentProfile].observable[x].version,
+                plugin: this._appConfig[this._deploymentProfile].observable[x].plugin,
+                package: this._appConfig[this._deploymentProfile].observable[x].package,
+                enabled: this._appConfig[this._deploymentProfile].observable[x].enabled,
+                filter: this._appConfig[this._deploymentProfile].observable[x].filter,
+            };
+            return acc;
+        }, {});
+    }
+    async getEventsPlugins() {
+        const plugins = Object.keys(this._appConfig[this._deploymentProfile].events ?? {})
+            .filter((x) => {
+            return (this._appConfig[this._deploymentProfile].events[x].enabled === true);
+        });
+        return plugins.reduce((acc, x) => {
+            acc[x] = {
+                //name: this._appConfig[this._deploymentProfile].events[x].name,
+                version: this._appConfig[this._deploymentProfile].events[x].version,
+                plugin: this._appConfig[this._deploymentProfile].events[x].plugin,
+                package: this._appConfig[this._deploymentProfile].events[x].package,
+                enabled: this._appConfig[this._deploymentProfile].events[x].enabled,
+                filter: this._appConfig[this._deploymentProfile].events[x].filter,
+            };
+            return acc;
+        }, {});
+    }
+    async getServicePlugins() {
+        const plugins = Object.keys(this._appConfig[this._deploymentProfile].services ?? {})
+            .filter((x) => {
+            return (this._appConfig[this._deploymentProfile].services[x].enabled === true);
+        });
+        return plugins.reduce((acc, x) => {
+            acc[x] = {
+                //name: this._appConfig[this._deploymentProfile].services[x].name,
+                version: this._appConfig[this._deploymentProfile].services[x].version,
+                plugin: this._appConfig[this._deploymentProfile].services[x].plugin,
+                package: this._appConfig[this._deploymentProfile].services[x].package,
+                enabled: this._appConfig[this._deploymentProfile].services[x].enabled,
+            };
+            return acc;
+        }, {});
+    }
+    async getPluginConfig(obs, pluginType, plugin) {
+        if (pluginType === index_1.PluginTypes.config) {
+            return null;
+        }
+        let configKey = "services";
+        if (pluginType === index_1.PluginTypes.events) {
+            configKey = "events";
+        }
+        if (pluginType === index_1.PluginTypes.observable) {
+            configKey = "observable";
+        }
+        return (this._appConfig[this._deploymentProfile][configKey][plugin].config ?? null);
+    }
+    dispose() {
+        this._appConfig = undefined;
+    }
+    _appConfig;
+    _secConfigFilePath;
+    _deploymentProfile = "default";
+    constructor(config) {
+        super(config);
+        this._secConfigFilePath = path.join(this.cwd, this.config.BSB_CONFIG_FILE);
+    }
+    init(obs) {
+        this._deploymentProfile = this.config.BSB_PROFILE;
+        this._secConfigFilePath = this.config.BSB_CONFIG_FILE;
+        this._appConfig = {
+            default: {
+                observable: {},
+                events: {},
+                services: {},
+            },
+        };
+        if (fs.existsSync(this._secConfigFilePath)) {
+            this._appConfig =
+                (0, yaml_1.parse)(fs.readFileSync(this._secConfigFilePath, "utf8")
+                    .toString()) ??
+                    this._appConfig;
+        }
+        else {
+            throw new index_1.BSBError(obs.trace, "Cannot find config file at {filepath}", {
+                filepath: this._secConfigFilePath,
+            });
+        }
+        if (index_1.Tools.isNullOrUndefined(this._appConfig[this._deploymentProfile])) {
+            throw new index_1.BSBError(obs.trace, "unknown deployment profile ({deploymentProfile}), please create it first.", {
+                deploymentProfile: this._deploymentProfile,
+            });
+        }
+        obs.log.debug("Config ready, using profile: {profile}", {
+            profile: this._deploymentProfile,
+        });
+    }
+    async getPlugins() {
+        return Object.keys(this._appConfig[this._deploymentProfile].services)
+            .map((x) => {
+            return {
+                npmPackage: this._appConfig[this._deploymentProfile].services[x].package,
+                plugin: this._appConfig[this._deploymentProfile].services[x].plugin,
+                name: x,
+                enabled: this._appConfig[this._deploymentProfile].services[x].enabled ===
+                    true,
+            };
+        });
+    }
+}
+exports.Plugin = Plugin;
+//# sourceMappingURL=index.js.map

package/lib/plugins/config-default/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/plugins/config-default/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,kCAAkC;AAClC,8BAA8B;AAC9B,+BAA6B;AAC7B,uCAQqB;AACrB,oDAAuE;AACvE,0DAA6D;AAC7D,6BAAwB;AAGxB,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC;IACrD,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC;CACpE,CAAC,CAAC;AAEU,QAAA,MAAM,GAAG,IAAA,iCAAkB,EACtC;IACE,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE,gEAAgE;IAC7E,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,2CAA2C;IAClD,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;IACnC,aAAa,EAAE,CAAC,uCAAuC,CAAC;CACzD,EACD,YAAY,CACb,CAAC;AAEF,MAAa,MACX,SAAQ,qBAAsC;IAC9C,MAAM,CAAC,MAAM,GAAG,cAAM,CAAC;IACvB,KAAK,CAAC,0BAA0B,CAC9B,GAAe,EACf,UAAkB;QAElB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAC7B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,IAAI,EAAE,CACxD,CAAC;QACF,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACxC,OAAO;gBACL,UAAU,EAAE,CAAC;gBACb,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;aACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAI,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YAClC,OAAO,CAAC,CAAC,MAAM,KAAK,UAAU,IAAI,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO;gBACL,IAAI,EAAE,MAAM,CAAC,UAAU;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB,CAAC;QACJ,CAAC;QACD,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YAC9B,OAAO,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO;gBACL,IAAI,EAAE,MAAM,CAAC,UAAU;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,gBAAQ,CAChB,GAAG,CAAC,KAAK,EACT,+CAA+C,EAC/C;YACE,MAAM,EAAE,UAAU;SACnB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,IAAI,EAAE,CAC1D;aACE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CACxE,CAAC;QACJ,CAAC,CAAC,CAAC;QACL,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YAC/B,GAAG,CAAC,CAAC,CAAC,GAAG;gBACP,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO;gBACvE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM;gBACrE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO;gBACvE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO;gBACvE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM;aACtE,CAAC;YACF,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAsC,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,IAAI,EAAE,CACtD;aACE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CACpE,CAAC;QACJ,CAAC,CAAC,CAAC;QACL,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YAC/B,GAAG,CAAC,CAAC,CAAC,GAAG;gBACP,gEAAgE;gBAChE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;gBACnE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;gBACjE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;gBACnE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;gBACnE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;aAClE,CAAC;YACF,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAkC,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,IAAI,EAAE,CACxD;aACE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CACtE,CAAC;QACJ,CAAC,CAAC,CAAC;QACL,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YAC/B,GAAG,CAAC,CAAC,CAAC,GAAG;gBACP,kEAAkE;gBAClE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO;gBACrE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM;gBACnE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO;gBACrE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO;aACtE,CAAC;YACF,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAsC,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAe,EACf,UAAsB,EACtB,MAAc;QAEd,IAAI,UAAU,KAAK,mBAAW,CAAC,MAAM,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,SAAS,GAAyC,UAAU,CAAC;QACjE,IAAI,UAAU,KAAK,mBAAW,CAAC,MAAM,EAAE,CAAC;YACtC,SAAS,GAAG,QAAQ,CAAC;QACvB,CAAC;QACD,IAAI,UAAU,KAAK,mBAAW,CAAC,UAAU,EAAE,CAAC;YAC1C,SAAS,GAAG,YAAY,CAAC;QAC3B,CAAC;QACD,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,IAAI,IAAI,CAC3E,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,CAAC,UAAU,GAAG,SAAU,CAAC;IAC/B,CAAC;IAEO,UAAU,CAAoB;IAC9B,kBAAkB,CAAS;IAC3B,kBAAkB,GAAW,SAAS,CAAC;IAE/C,YAAY,MAAyD;QACnE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,GAAe;QAClB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAClD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QACtD,IAAI,CAAC,UAAU,GAAG;YAChB,OAAO,EAAE;gBACP,UAAU,EAAE,EAAE;gBACd,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE,EAAE;aACb;SACF,CAAC;QACF,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC,UAAU;gBACb,IAAA,YAAK,EAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC;qBACnD,QAAQ,EAAE,CAAC;oBACd,IAAI,CAAC,UAAU,CAAC;QACpB,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,gBAAQ,CAChB,GAAG,CAAC,KAAK,EACT,uCAAuC,EACvC;gBACE,QAAQ,EAAE,IAAI,CAAC,kBAAkB;aAClC,CACF,CAAC;QACJ,CAAC;QACD,IAAI,aAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,gBAAQ,CAChB,GAAG,CAAC,KAAK,EACT,2EAA2E,EAC3E;gBACE,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;aAC3C,CACF,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,KAAK,CACX,wCAAwC,EAAE;YAC1C,OAAO,EAAE,IAAI,CAAC,kBAAkB;SACjC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QAQd,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC;aAClE,GAAG,CACF,CAAC,CAAC,EAAE,EAAE;YACJ,OAAO;gBACL,UAAU,EACR,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO;gBAC9D,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM;gBACnE,IAAI,EAAE,CAAC;gBACP,OAAO,EACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO;oBAC5D,IAAI;aACP,CAAC;QACJ,CAAC,CACF,CAAC;IACN,CAAC;;AA3MH,wBA4MC"}

package/lib/plugins/config-default/interfaces.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 { ObservableConfig, EventsConfig, PluginDefinition as ServiceConfig } from "../../index";
+export interface DeploymentProfile {
+    /**
+     * @name NPM Package name
+     * @description The NPM package that holds the plugin
+     * @example @bettercorp/service-base-plugin-web-server
+     * @example @bettercorp/service-base-plugin-graphql
+     */
+    package: string;
+    /**
+     * @name NPM Package version
+     * @description The NPM package version that holds the plugin
+     * @example 1.0.0
+     * @example 1.0.1
+     */
+    /**
+     * @name Plugin name
+     * @description The name of the plugin
+     * @example service-fastify
+     * @example service-graphql
+     * @example logging-graylog
+     */
+    plugin: string;
+    /**
+     * @name Plugin enabled
+     * @description If the plugin is enabled or not
+     * @example true
+     * @example false
+     */
+    enabled: boolean;
+}
+/**
+ * @name Plugin name
+ * @description The name of the plugin
+ * @example service-fastify
+ */
+export type PluginName = string;
+/**
+ * @name Deployment profile name
+ * @description The name of the deployment profile
+ * @example default
+ * @example server1
+ * @example frontend
+ * @example backend
+ */
+export type DeploymentProfileName = string;
+export interface DeploymentProfiles<T> extends Record<string, T> {
+    /**
+     * @name Default deployment profile
+     * @description The default deployment profile
+     */
+    default: T;
+}
+export interface ExtendedConfig {
+    config: any | undefined;
+}
+export interface ConfigProfile {
+    observable: Record<PluginName, ObservableConfig & ExtendedConfig>;
+    events: Record<PluginName, EventsConfig & ExtendedConfig>;
+    services: Record<PluginName, ServiceConfig & ExtendedConfig>;
+}
+export interface DefaultProfile {
+    default: ConfigProfile;
+}
+export interface ConfigDefinition extends Record<string, ConfigProfile>, DefaultProfile {
+}

package/lib/plugins/config-default/interfaces.js

@@ -0,0 +1,36 @@
+"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 });
+// export interface PluginConfig<INCLCONF extends boolean> {
+//   package?: string | null;
+//   plugin: string;
+//   name: string;
+//   enabled: boolean;
+//   config: INCLCONF extends true ? any : never;
+// }
+//# sourceMappingURL=interfaces.js.map

package/lib/plugins/config-default/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/plugins/config-default/interfaces.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;AA+EH,4DAA4D;AAC5D,6BAA6B;AAC7B,oBAAoB;AACpB,kBAAkB;AAClB,sBAAsB;AACtB,iDAAiD;AACjD,IAAI"}

package/lib/plugins/events-default/events/broadcast.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { EventEmitter } from "node:events";
+import { Observable, IPluginLogging } from "../../../index";
+export declare class broadcast extends EventEmitter {
+    constructor(_log: IPluginLogging);
+    dispose(): void;
+    onBroadcast(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, args: Array<any>): Promise<void>;
+    }): Promise<void>;
+    emitBroadcast(obs: Observable, pluginName: string, event: string, args: Array<any>): Promise<void>;
+}

package/lib/plugins/events-default/events/broadcast.js

@@ -0,0 +1,85 @@
+"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.broadcast = void 0;
+const node_events_1 = require("node:events");
+class broadcast extends node_events_1.EventEmitter {
+    constructor(_log) {
+        super();
+    }
+    dispose() {
+        this.removeAllListeners();
+    }
+    async onBroadcast(obs, pluginName, event, listener) {
+        obs.log.debug("onBroadcast: listening to {pluginName}-{event}", {
+            pluginName,
+            event,
+        });
+        this.on(`${pluginName}-${event}`, async (eobs, args) => {
+            // Create child observable for receiving the broadcast
+            const receiveObs = eobs.startSpan("onBroadcast:receive", {
+                pluginName,
+                event,
+            });
+            try {
+                await listener(receiveObs, args);
+            }
+            catch (error) {
+                const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+                receiveObs.error(errorObj);
+                throw error;
+            }
+            finally {
+                receiveObs.end();
+            }
+        });
+    }
+    async emitBroadcast(obs, pluginName, event, args) {
+        // Create child observable for sending the broadcast
+        const sendObs = obs.startSpan("emitBroadcast:send", {
+            pluginName,
+            event,
+        });
+        try {
+            sendObs.log.debug("emitBroadcast: emitting {pluginName}-{event}", {
+                pluginName, event,
+            });
+            this.emit(`${pluginName}-${event}`, sendObs, args);
+        }
+        catch (error) {
+            const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+            sendObs.error(errorObj);
+            throw error;
+        }
+        finally {
+            sendObs.end();
+        }
+    }
+}
+exports.broadcast = broadcast;
+//# sourceMappingURL=broadcast.js.map

package/lib/plugins/events-default/events/broadcast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcast.js","sourceRoot":"","sources":["../../../../src/plugins/events-default/events/broadcast.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,6CAA2C;AAG3C,MAAa,SAAU,SAAQ,0BAAY;IACzC,YAAY,IAAoB;QAC9B,KAAK,EAAE,CAAC;IACV,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,WAAW,CACtB,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,QAAgE;QAEhE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,gDAAgD,EAAE;YAC9D,UAAU;YACV,KAAK;SACN,CAAC,CAAC;QACH,IAAI,CAAC,EAAE,CAAC,GAAI,UAAW,IAAK,KAAM,EAAE,EAAE,KAAK,EAAE,IAAgB,EAAE,IAAW,EAAE,EAAE;YAC5E,sDAAsD;YACtD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,EAAE;gBACvD,UAAU;gBACV,KAAK;aACN,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACnC,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC7F,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC3B,MAAM,KAAK,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,UAAU,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,IAAgB;QAEhB,oDAAoD;QACpD,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,oBAAoB,EAAE;YAClD,UAAU;YACV,KAAK;SACN,CAAC,CAAC;QAEH,IAAI,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,8CAA8C,EAAE;gBAChE,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,GAAI,UAAW,IAAK,KAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACxB,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,CAAC;IACH,CAAC;CACF;AA/DD,8BA+DC"}