@bsb/base 9.0.0 → 9.0.1

package/lib/plugins/service-default3/index.js

@@ -0,0 +1,88 @@
+"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.EventSchemas = exports.Config = void 0;
+const zod_1 = require("zod");
+const base_1 = require("../../base");
+const schema_events_1 = require("../../interfaces/schema-events");
+exports.Config = (0, base_1.createConfigSchema)({
+    name: 'service-default3',
+    description: 'Default service plugin 3 for testing',
+    version: '1.0.0',
+    image: '../docs/public/assets/images/bsb-logo.png',
+    tags: ['default', 'example', 'test'],
+    initAfterPlugins: ['service-default2'],
+}, zod_1.z.object({}));
+exports.EventSchemas = (0, schema_events_1.createEventSchemas)({
+    onReturnableEvents: {
+        onReverseReturnable: (0, schema_events_1.createReturnableEvent)(base_1.bsb.object({
+            text: base_1.bsb.string({ description: 'Text to reverse' })
+        }, 'Reverse input parameters'), base_1.bsb.string({ description: 'Reversed text' }), 'Reverse a string')
+    },
+    emitReturnableEvents: {
+        calculate: (0, schema_events_1.createReturnableEvent)(base_1.bsb.object({
+            a: base_1.bsb.number({ description: 'First number' }),
+            b: base_1.bsb.number({ description: 'Second number' })
+        }, 'Calculate input parameters'), base_1.bsb.number({ description: 'Calculation result' }), 'Calculate with two numbers')
+    }
+});
+class Plugin extends base_1.BSBService {
+    static Config = exports.Config;
+    static EventSchemas = exports.EventSchemas;
+    // PLUGIN_CLIENT auto-generated from Config.metadata
+    initBeforePlugins;
+    runBeforePlugins;
+    runAfterPlugins;
+    initAfterPlugins = ["service-default2"];
+    constructor(config) {
+        super(config);
+    }
+    async init(obs) {
+        obs.log.info("Initializing service-default3");
+        await this.events.onReturnableEvent("onReverseReturnable", obs, async (obs, input) => {
+            obs.log.warn("onReverseReturnable ({text})", { text: input.text });
+            return input.text.split("").reverse().join("");
+        });
+    }
+    async run(obs) {
+        obs.log.info("Running service-default3");
+        // NEW API: Use events to calculate with object parameter
+        const result = await this.events.emitEventAndReturn("calculate", obs, {
+            a: 18,
+            b: 19
+        }, 5 // timeout
+        );
+        obs.log.info("Calculation result: {result}", { result });
+        obs.log.debug("Debug {a}", { a: "IT IS AN DEBUG!" });
+        obs.log.info("Info {a}", { a: "IT IS AN INFO!" });
+        obs.log.warn("Warning {a}", { a: "IT IS AN WARNING!" });
+        obs.log.error("Error {a}", { a: "IT IS AN ERROR!" });
+    }
+}
+exports.Plugin = Plugin;
+//# sourceMappingURL=index.js.map

package/lib/plugins/service-default3/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/plugins/service-default3/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,6BAAwB;AACxB,qCAAwF;AAExF,kEAA2F;AAE9E,QAAA,MAAM,GAAG,IAAA,yBAAkB,EACtC;IACE,IAAI,EAAE,kBAAkB;IACxB,WAAW,EAAE,sCAAsC;IACnD,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,2CAA2C;IAClD,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC;IACpC,gBAAgB,EAAE,CAAC,kBAAkB,CAAC;CACvC,EACD,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CACb,CAAC;AAEW,QAAA,YAAY,GAAG,IAAA,kCAAkB,EAAC;IAC7C,kBAAkB,EAAE;QAClB,mBAAmB,EAAE,IAAA,qCAAqB,EACxC,UAAG,CAAC,MAAM,CAAC;YACT,IAAI,EAAE,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;SACrD,EAAE,0BAA0B,CAAC,EAC9B,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,EAC5C,kBAAkB,CACnB;KACF;IACD,oBAAoB,EAAE;QACpB,SAAS,EAAE,IAAA,qCAAqB,EAC9B,UAAG,CAAC,MAAM,CAAC;YACT,CAAC,EAAE,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;YAC9C,CAAC,EAAE,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;SAChD,EAAE,4BAA4B,CAAC,EAChC,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC,EACjD,4BAA4B,CAC7B;KACF;CACF,CAAC,CAAC;AAEH,MAAa,MAAO,SAAQ,iBAA4D;IACtF,MAAM,CAAC,MAAM,GAAG,cAAM,CAAC;IACvB,MAAM,CAAC,YAAY,GAAG,oBAAY,CAAC;IACnC,oDAAoD;IAE7C,iBAAiB,CAAwB;IACzC,gBAAgB,CAAwB;IACxC,eAAe,CAAwB;IACvC,gBAAgB,GAAa,CAAC,kBAAkB,CAAC,CAAC;IAIzD,YAAY,MAA+E;QACzF,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,GAAe;QAC/B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAE,+BAA+B,CAAC,CAAC;QAE/C,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CACjC,qBAAqB,EACrB,GAAG,EACH,KAAK,EAAE,GAAe,EAAE,KAAK,EAAE,EAAE;YAC/B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAE,8BAA8B,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACpE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAe;QAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAE,0BAA0B,CAAC,CAAC;QAE1C,yDAAyD;QACzD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CACjD,WAAW,EACX,GAAG,EACH;YACE,CAAC,EAAE,EAAE;YACL,CAAC,EAAE,EAAE;SACN,EACD,CAAC,CAAC,UAAU;SACb,CAAC;QAEF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAE,8BAA8B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1D,GAAG,CAAC,GAAG,CAAC,KAAK,CAAE,WAAW,EAAE,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACtD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAE,UAAU,EAAE,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACnD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAE,aAAa,EAAE,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC;QACzD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAE,WAAW,EAAE,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACxD,CAAC;;AAhDH,wBAiDC"}

package/lib/plugins/service-default4/index.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 { Observable } from "../../index";
+import { BSBService, BSBServiceConstructor } from "../../base";
+import { z } from "zod";
+export declare const Config: import("../../index").BSBPluginConfigClass<z.ZodNull>;
+export declare const EventSchemas: {
+    readonly emitReturnableEvents: {
+        readonly onReverseReturnable: {
+            input: {
+                _bsb: "object";
+                properties: {
+                    readonly text: import("../../index").BSBStringType;
+                };
+                required: string[];
+                description?: string;
+                optional?: boolean;
+                nullable?: boolean;
+            };
+            output: import("../../index").BSBStringType;
+            description?: string;
+            defaultTimeout?: number;
+            readonly __brand: "returnable";
+        };
+    };
+};
+export declare class Plugin extends BSBService<InstanceType<typeof Config>, typeof EventSchemas> {
+    static Config: import("../../index").BSBPluginConfigClass<z.ZodNull>;
+    static EventSchemas: {
+        readonly emitReturnableEvents: {
+            readonly onReverseReturnable: {
+                input: {
+                    _bsb: "object";
+                    properties: {
+                        readonly text: import("../../index").BSBStringType;
+                    };
+                    required: string[];
+                    description?: string;
+                    optional?: boolean;
+                    nullable?: boolean;
+                };
+                output: import("../../index").BSBStringType;
+                description?: string;
+                defaultTimeout?: number;
+                readonly __brand: "returnable";
+            };
+        };
+    };
+    initBeforePlugins?: string[] | undefined;
+    runBeforePlugins?: string[] | undefined;
+    runAfterPlugins?: string[] | undefined;
+    initAfterPlugins: string[];
+    dispose?(): void;
+    init?(): void | Promise<void>;
+    constructor(config: BSBServiceConstructor<InstanceType<typeof Config>, typeof EventSchemas>);
+    run(obs: Observable): Promise<void>;
+}

package/lib/{tests.js → plugins/service-default4/index.js}

@@ -25,20 +25,39 @@
  * 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/>.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./tests/sb/plugins/events"), exports);
-//# sourceMappingURL=tests.js.map
+exports.Plugin = exports.EventSchemas = exports.Config = void 0;
+const base_1 = require("../../base");
+const schema_events_1 = require("../../interfaces/schema-events");
+const zod_1 = require("zod");
+exports.Config = (0, base_1.createConfigSchema)({
+    name: 'service-default4',
+    description: 'Default service plugin 4 for testing',
+    version: '1.0.0',
+    image: '../docs/public/assets/images/bsb-logo.png',
+    tags: ['default', 'example', 'test'],
+}, zod_1.z.null());
+exports.EventSchemas = (0, schema_events_1.createEventSchemas)({
+    emitReturnableEvents: {
+        onReverseReturnable: (0, schema_events_1.createReturnableEvent)(base_1.bsb.object({
+            text: base_1.bsb.string({ description: 'Text to reverse' })
+        }, 'Reverse input parameters'), base_1.bsb.string({ description: 'Reversed text' }), 'Reverse text string')
+    }
+});
+class Plugin extends base_1.BSBService {
+    static Config = exports.Config;
+    static EventSchemas = exports.EventSchemas;
+    // PLUGIN_CLIENT auto-generated from Config.metadata
+    initBeforePlugins;
+    runBeforePlugins;
+    runAfterPlugins;
+    initAfterPlugins = [];
+    constructor(config) {
+        super(config);
+    }
+    async run(obs) {
+        obs.log.info("Running service-default4");
+    }
+}
+exports.Plugin = Plugin;
+//# sourceMappingURL=index.js.map

package/lib/plugins/service-default4/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/plugins/service-default4/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAGH,qCAAwF;AACxF,kEAA2F;AAC3F,6BAAwB;AAEX,QAAA,MAAM,GAAG,IAAA,yBAAkB,EACtC;IACE,IAAI,EAAE,kBAAkB;IACxB,WAAW,EAAE,sCAAsC;IACnD,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,2CAA2C;IAClD,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC;CACrC,EACD,OAAC,CAAC,IAAI,EAAE,CACT,CAAC;AAEW,QAAA,YAAY,GAAG,IAAA,kCAAkB,EAAC;IAC7C,oBAAoB,EAAE;QACpB,mBAAmB,EAAE,IAAA,qCAAqB,EACxC,UAAG,CAAC,MAAM,CAAC;YACT,IAAI,EAAE,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;SACrD,EAAE,0BAA0B,CAAC,EAC9B,UAAG,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,EAC5C,qBAAqB,CACtB;KACF;CACF,CAAC,CAAC;AAEH,MAAa,MAAO,SAAQ,iBAA4D;IACtF,MAAM,CAAC,MAAM,GAAG,cAAM,CAAC;IACvB,MAAM,CAAC,YAAY,GAAG,oBAAY,CAAC;IACnC,oDAAoD;IAE7C,iBAAiB,CAAwB;IACzC,gBAAgB,CAAwB;IACxC,eAAe,CAAwB;IAC9B,gBAAgB,GAAa,EAAE,CAAC;IAKhD,YAAY,MAA+E;QACzF,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEe,KAAK,CAAC,GAAG,CAAC,GAAe;QACvC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IAC3C,CAAC;;AAnBH,wBAoBC"}

package/lib/schemas/config-default.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "config-default",
   "name": "config-default",
-  "version": "9.0.0",
+  "version": "9.0.1",
   "description": "Default configuration plugin for profile and plugin resolution",
   "category": "config",
   "tags": [

package/lib/schemas/events-default.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "events-default",
   "name": "events-default",
-  "version": "9.0.0",
+  "version": "9.0.1",
   "description": "Default in-process events plugin for BSB event routing",
   "category": "events",
   "tags": [

package/lib/schemas/observable-default.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "observable-default",
   "name": "observable-default",
-  "version": "9.0.0",
+  "version": "9.0.1",
   "description": "Default console observable plugin for logging output",
   "category": "observable",
   "tags": [

package/lib/schemas/service-benchmarkify.json

@@ -0,0 +1,229 @@
+{
+  "pluginName": "service-benchmarkify",
+  "version": "1.0.0",
+  "events": {
+    "benchmark.started": {
+      "type": "fire-and-forget",
+      "category": "emitEvents",
+      "description": "Benchmark test started",
+      "inputSchema": {
+        "description": "Benchmark start parameters",
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "Benchmark name",
+            "type": "string"
+          },
+          "timestamp": {
+            "description": "Start timestamp",
+            "type": "string",
+            "format": "datetime"
+          }
+        },
+        "required": [
+          "name",
+          "timestamp"
+        ]
+      },
+      "outputSchema": null
+    },
+    "benchmark.trigger": {
+      "type": "fire-and-forget",
+      "category": "onEvents",
+      "description": "Trigger benchmark execution",
+      "inputSchema": {
+        "description": "Benchmark trigger parameters",
+        "type": "object",
+        "properties": {
+          "testName": {
+            "description": "Name of test to run",
+            "type": "string"
+          }
+        },
+        "required": []
+      },
+      "outputSchema": null
+    },
+    "performance.test": {
+      "type": "returnable",
+      "category": "emitReturnableEvents",
+      "description": "Request performance test execution",
+      "inputSchema": {
+        "description": "Performance test parameters",
+        "type": "object",
+        "properties": {
+          "iterations": {
+            "description": "Number of iterations to run",
+            "type": "number",
+            "format": "double"
+          },
+          "warmup": {
+            "description": "Whether to run warmup iterations",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "iterations",
+          "warmup"
+        ]
+      },
+      "outputSchema": {
+        "description": "Performance test results",
+        "type": "object",
+        "properties": {
+          "duration": {
+            "description": "Test duration in milliseconds",
+            "type": "number",
+            "format": "double"
+          },
+          "opsPerSecond": {
+            "description": "Operations per second",
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "required": [
+          "duration",
+          "opsPerSecond"
+        ]
+      }
+    },
+    "add": {
+      "type": "returnable",
+      "category": "onReturnableEvents",
+      "description": "Add two numbers",
+      "inputSchema": {
+        "description": "Add input parameters",
+        "type": "object",
+        "properties": {
+          "a": {
+            "description": "First number",
+            "type": "number",
+            "format": "double"
+          },
+          "b": {
+            "description": "Second number",
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "required": [
+          "a",
+          "b"
+        ]
+      },
+      "outputSchema": {
+        "description": "Sum of numbers",
+        "type": "number",
+        "format": "double"
+      }
+    },
+    "void": {
+      "type": "returnable",
+      "category": "onReturnableEvents",
+      "description": "Void event for benchmarking",
+      "inputSchema": {
+        "description": "Empty parameters",
+        "type": "object",
+        "properties": {},
+        "required": []
+      },
+      "outputSchema": {
+        "description": "void",
+        "oneOf": []
+      }
+    },
+    "benchmark.results": {
+      "type": "broadcast",
+      "category": "emitBroadcast",
+      "description": "Broadcast benchmark results to all interested parties",
+      "inputSchema": {
+        "description": "Benchmark results parameters",
+        "type": "object",
+        "properties": {
+          "testName": {
+            "description": "Test name",
+            "type": "string"
+          },
+          "results": {
+            "description": "Array of benchmark results",
+            "type": "array",
+            "items": {
+              "description": "Benchmark result entry",
+              "type": "object",
+              "properties": {
+                "operation": {
+                  "description": "Operation name",
+                  "type": "string"
+                },
+                "opsPerSecond": {
+                  "description": "Operations per second",
+                  "type": "number",
+                  "format": "double"
+                },
+                "duration": {
+                  "description": "Duration in milliseconds",
+                  "type": "number",
+                  "format": "double"
+                }
+              },
+              "required": [
+                "operation",
+                "opsPerSecond",
+                "duration"
+              ]
+            }
+          },
+          "timestamp": {
+            "description": "Results timestamp",
+            "type": "string",
+            "format": "datetime"
+          }
+        },
+        "required": [
+          "testName",
+          "results",
+          "timestamp"
+        ]
+      },
+      "outputSchema": null
+    },
+    "system.load": {
+      "type": "broadcast",
+      "category": "onBroadcast",
+      "description": "Listen for system load updates",
+      "inputSchema": {
+        "description": "System load parameters",
+        "type": "object",
+        "properties": {
+          "cpuUsage": {
+            "description": "CPU usage percentage",
+            "type": "number",
+            "format": "double"
+          },
+          "memoryUsage": {
+            "description": "Memory usage percentage",
+            "type": "number",
+            "format": "double"
+          },
+          "timestamp": {
+            "description": "Load measurement timestamp",
+            "type": "string",
+            "format": "datetime"
+          }
+        },
+        "required": [
+          "cpuUsage",
+          "memoryUsage",
+          "timestamp"
+        ]
+      },
+      "outputSchema": null
+    }
+  },
+  "pluginType": "service",
+  "configSchema": {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "null"
+  }
+}