@bsb/base 9.0.0

package/lib/interfaces/events.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { DTrace } from './metrics';
+import { DynamicallyReferencedMethodBase } from "./tools";
+export type DynamicallyReferencedMethodOnIEvents<Interface extends DynamicallyReferencedMethodBase, Method extends keyof Interface, hasReturnable extends boolean = false> = Interface[Method] extends (...a: infer Arguments) => infer Return ? [
+    event: Method,
+    trace: DTrace,
+    listener: {
+        (trace: DTrace, ...a: Arguments): hasReturnable extends true ? Return : void | Promise<void>;
+    }
+] : [event: Method, noMatchingEvent: never];
+export type DynamicallyReferencedMethodEmitIEvents<Interface extends DynamicallyReferencedMethodBase, Method extends keyof Interface> = Interface[Method] extends (...a: infer Arguments) => infer Return ? [event: Method, trace: DTrace, ...a: Arguments] : [event: Method, noMatchingEvent: never];
+export type DynamicallyReferencedMethodEmitEARIEvents<Interface extends DynamicallyReferencedMethodBase, Method extends keyof Interface, ArgsReference extends boolean = true> = ArgsReference extends true ? Interface[Method] extends (...a: infer Arguments) => infer Return ? [
+    event: Method,
+    trace: DTrace,
+    timeoutSeconds?: number,
+    ...a: Arguments
+] : [
+    event: Method,
+    noMatchingEvent: never
+] : Interface[Method] extends (...a: infer Arguments) => infer Return ? Return extends Promise<unknown> ? Return : Promise<Return> : Promise<never>;
+/**
+ * @hidden
+ */
+export declare const EventsEventTypesBase: {
+    readonly onBroadcast: "onBroadcast";
+    readonly emitBroadcast: "emitBroadcast";
+    readonly onEvent: "onEvent";
+    readonly emitEvent: "emitEvent";
+    readonly onReturnableEvent: "onReturnableEvent";
+    readonly emitEventAndReturn: "emitEventAndReturn";
+    readonly emitEventAndReturnTimed: "emitEventAndReturnTimed";
+    readonly receiveStream: "receiveStream";
+    readonly sendStream: "sendStream";
+};
+/**
+ * @hidden
+ */
+export type EventsEventBaseTypes = (typeof EventsEventTypesBase)[keyof typeof EventsEventTypesBase];
+/**
+ * @hidden
+ */
+export type EventsEventTypes = "onEventSpecific" | "emitEventSpecific" | "onReturnableEventSpecific" | "emitEventAndReturnSpecific" | "emitEventAndReturnTimedSpecific" | EventsEventBaseTypes;

package/lib/interfaces/events.js

@@ -0,0 +1,44 @@
+"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.EventsEventTypesBase = void 0;
+/**
+ * @hidden
+ */
+exports.EventsEventTypesBase = {
+    onBroadcast: "onBroadcast",
+    emitBroadcast: "emitBroadcast",
+    onEvent: "onEvent",
+    emitEvent: "emitEvent",
+    onReturnableEvent: "onReturnableEvent",
+    emitEventAndReturn: "emitEventAndReturn",
+    emitEventAndReturnTimed: "emitEventAndReturnTimed",
+    receiveStream: "receiveStream",
+    sendStream: "sendStream",
+};
+//# sourceMappingURL=events.js.map

package/lib/interfaces/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/interfaces/events.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AA+CH;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,eAAe;IAC9B,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,iBAAiB,EAAE,mBAAmB;IACtC,kBAAkB,EAAE,oBAAoB;IACxC,uBAAuB,EAAE,yBAAyB;IAClD,aAAa,EAAE,eAAe;IAC9B,UAAU,EAAE,YAAY;CAChB,CAAC"}

package/lib/interfaces/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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/>.
+ */
+export * from "./events";
+export * from "./logging";
+export * from "./plugins";
+export * from "./service";
+export * from "./metrics";
+export * from "./result";
+export * from "./options";
+export * from "./schema-events";
+export * from "./schema-types";
+export * from "./observable";
+export * from "./observable-types";
+export { CleanStringStrength, DynamicallyReferencedMethodBase, DynamicallyReferencedMethodType, DynamicallyReferencedMethod, DynamicallyReferencedType, MergeObjectsKey, ParamsFromString, SimpleStatu, generateAppIdHash, generateTimeBasedId } from "./tools";

package/lib/interfaces/index.js

@@ -0,0 +1,59 @@
+"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/>.
+ */
+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 });
+exports.generateTimeBasedId = exports.generateAppIdHash = exports.CleanStringStrength = void 0;
+__exportStar(require("./events"), exports);
+__exportStar(require("./logging"), exports);
+__exportStar(require("./plugins"), exports);
+__exportStar(require("./service"), exports);
+__exportStar(require("./metrics"), exports);
+__exportStar(require("./result"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./schema-events"), exports);
+__exportStar(require("./schema-types"), exports);
+__exportStar(require("./observable"), exports);
+__exportStar(require("./observable-types"), exports);
+var tools_1 = require("./tools");
+Object.defineProperty(exports, "CleanStringStrength", { enumerable: true, get: function () { return tools_1.CleanStringStrength; } });
+Object.defineProperty(exports, "generateAppIdHash", { enumerable: true, get: function () { return tools_1.generateAppIdHash; } });
+Object.defineProperty(exports, "generateTimeBasedId", { enumerable: true, get: function () { return tools_1.generateTimeBasedId; } });
+//# sourceMappingURL=index.js.map

package/lib/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;;;;;;;;;;;;;;;AAEH,2CAAyB;AACzB,4CAA0B;AAC1B,4CAA0B;AAC1B,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,4CAA0B;AAC1B,kDAAgC;AAChC,iDAA+B;AAC/B,+CAA6B;AAC7B,qDAAmC;AACnC,iCAWiB;AAVf,4GAAA,mBAAmB,OAAA;AAQnB,0GAAA,iBAAiB,OAAA;AACjB,4GAAA,mBAAmB,OAAA"}

package/lib/interfaces/logging.d.ts

@@ -0,0 +1,106 @@
+/**
+ * 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 { BSBError } from "../base";
+import { ParamsFromString } from "./tools";
+import { DTrace } from "./metrics";
+/**
+ * The debug mode of the app
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/modules.html#module-interfaces_logging | API: interfaces/logging}
+ * @example "production" - production mode with no debug
+ * @example "production-debug" - production mode with debug
+ * @example "development" - development mode with debug
+ */
+export type DEBUG_MODE = "production" | "production-debug" | "development";
+export type SafeLogData = string | number | boolean | Array<string | number | boolean> | Object;
+export type UnsafeLogData = {
+    value: string | number | boolean | Array<string | number | boolean> | Object;
+    safeValue: SafeLogData;
+};
+export type LogMeta<T extends string> = Record<ParamsFromString<T>, UnsafeLogData | SafeLogData>;
+/**
+ * If you are going to make an object or something, use LogMeta instead.
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/modules.html#module-interfaces_logging | API: interfaces/logging}
+ */
+export type SmartLogMeta<T extends string> = ParamsFromString<T> extends never ? [undefined?] : [meta: Record<ParamsFromString<T>, UnsafeLogData | SafeLogData>];
+/**
+ * @group Logging
+ * @category Plugin Development Tools
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/IPluginLogging.html | API: IPluginLogging}
+ */
+export interface IPluginLogging {
+    /**
+     * Log an informational message with meta data.
+     * @param trace - The trace object.
+     * @param message - The message to log.
+     * @param meta - The meta data to log.
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/IPluginLogging.html#info | API: IPluginLogging#info}
+     */
+    info<T extends string>(trace: DTrace, message: T, ...meta: SmartLogMeta<T>): void;
+    /**
+     * Log a warning message with meta data.
+     * @param trace - The trace object.
+     * @param message - The message to log.
+     * @param meta - The meta data to log.
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/IPluginLogging.html#warn | API: IPluginLogging#warn}
+     */
+    warn<T extends string>(trace: DTrace, message: T, ...meta: SmartLogMeta<T>): void;
+    /**
+     * Log a debug message with meta data.
+     * @param trace - The trace object.
+     * @param message - The message to log.
+     * @param meta - The meta data to log.
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/IPluginLogging.html#debug | API: IPluginLogging#debug}
+     */
+    debug<T extends string>(trace: DTrace, message: T, ...meta: SmartLogMeta<T>): void;
+    /**
+     * Log an error message with meta data.
+     * @param trace - The trace object.
+     * @param message - The message to log.
+     * @param meta - The meta data to log.
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/IPluginLogging.html#error | API: IPluginLogging#error}
+     */
+    error<T extends string>(trace: DTrace, message: T, ...meta: SmartLogMeta<T>): void;
+    /**
+     * Log an error message with meta data.
+     * @param error - The error to log.
+     * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/IPluginLogging.html#error | API: IPluginLogging#error}
+     */
+    error<T extends string>(error: BSBError<T>): void;
+}
+/**
+ * @hidden
+ */
+export declare const LoggingEventTypesBase: {
+    readonly debug: "debug";
+    readonly info: "info";
+    readonly warn: "warn";
+    readonly error: "error";
+};
+/**
+ * @hidden
+ */
+export type LoggingEventTypes = (typeof LoggingEventTypesBase)[keyof typeof LoggingEventTypesBase];

package/lib/interfaces/logging.js

@@ -0,0 +1,39 @@
+"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.LoggingEventTypesBase = void 0;
+/**
+ * @hidden
+ */
+exports.LoggingEventTypesBase = {
+    debug: "debug",
+    info: "info",
+    warn: "warn",
+    error: "error",
+};
+//# sourceMappingURL=logging.js.map

package/lib/interfaces/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../src/interfaces/logging.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AA6FH;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAC"}