@bsb/base 9.0.0

package/lib/interfaces/plugins.js

@@ -0,0 +1,45 @@
+"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.PluginTypes = void 0;
+/**
+ * @hidden
+ */
+/**
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/modules.html#module-interfaces_plugins | API: interfaces/plugins}
+ */
+exports.PluginTypes = {
+    config: "config",
+    events: "events",
+    observable: "observable",
+    service: "service",
+};
+/**
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/modules.html#module-interfaces_plugins | API: interfaces/plugins}
+ */ 
+//# sourceMappingURL=plugins.js.map

package/lib/interfaces/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../../src/interfaces/plugins.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAcH;;GAEG;AACH;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;CACV,CAAC;AA2JX;;GAEG"}

package/lib/interfaces/result.d.ts

@@ -0,0 +1,129 @@
+/**
+ * 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/>.
+ */
+/**
+ * Result pattern for better error handling without exceptions
+ *
+ * @group Errors
+ * @category Core
+ */
+export type Result<T, E = Error> = {
+    success: true;
+    data: T;
+    error?: never;
+} | {
+    success: false;
+    data?: never;
+    error: E;
+};
+/**
+ * Creates a successful result
+ *
+ * @param data - The successful data
+ * @returns Success result
+ *
+ * @group Errors
+ * @category Utilities
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/functions/Ok.html | API: Ok}
+ */
+export declare function Ok<T>(data: T): Result<T, never>;
+/**
+ * Creates a failed result
+ *
+ * @param error - The error that occurred
+ * @returns Failed result
+ *
+ * @group Errors
+ * @category Utilities
+ */
+export declare function Err<E>(error: E): Result<never, E>;
+/**
+ * Maps a Result's success value to a new value
+ *
+ * @param result - The result to map
+ * @param fn - Function to transform the success value
+ * @returns New result with transformed value
+ *
+ * @group Errors
+ * @category Utilities
+ */
+export declare function mapResult<T, U, E>(result: Result<T, E>, fn: (value: T) => U): Result<U, E>;
+/**
+ * Maps a Result's error value to a new error
+ *
+ * @param result - The result to map
+ * @param fn - Function to transform the error value
+ * @returns New result with transformed error
+ *
+ * @group Errors
+ * @category Utilities
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/functions/mapError.html | API: mapError}
+ */
+export declare function mapError<T, E, F>(result: Result<T, E>, fn: (error: E) => F): Result<T, F>;
+/**
+ * Chains multiple operations that return Results
+ *
+ * @param result - The initial result
+ * @param fn - Function that takes success value and returns new Result
+ * @returns Chained result
+ *
+ * @group Errors
+ * @category Utilities
+ */
+export declare function flatMapResult<T, U, E>(result: Result<T, E>, fn: (value: T) => Result<U, E>): Result<U, E>;
+/**
+ * Unwraps a Result, throwing the error if it failed
+ *
+ * @param result - The result to unwrap
+ * @returns The success value
+ * @throws The error if result failed
+ *
+ * @group Errors
+ * @category Utilities
+ */
+export declare function unwrap<T, E>(result: Result<T, E>): T;
+/**
+ * Unwraps a Result, returning a default value if it failed
+ *
+ * @param result - The result to unwrap
+ * @param defaultValue - Value to return if result failed
+ * @returns The success value or default value
+ *
+ * @group Errors
+ * @category Utilities
+ */
+export declare function unwrapOr<T, E>(result: Result<T, E>, defaultValue: T): T;
+/**
+ * Converts a promise that might throw to a Result
+ *
+ * @param promise - Promise that might throw
+ * @returns Promise that resolves to a Result
+ *
+ * @group Errors
+ * @category Utilities
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/functions/fromPromise.html | API: fromPromise}
+ */
+export declare function fromPromise<T>(promise: Promise<T>): Promise<Result<T, Error>>;

package/lib/interfaces/result.js

@@ -0,0 +1,162 @@
+"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.Ok = Ok;
+exports.Err = Err;
+exports.mapResult = mapResult;
+exports.mapError = mapError;
+exports.flatMapResult = flatMapResult;
+exports.unwrap = unwrap;
+exports.unwrapOr = unwrapOr;
+exports.fromPromise = fromPromise;
+/**
+ * Creates a successful result
+ *
+ * @param data - The successful data
+ * @returns Success result
+ *
+ * @group Errors
+ * @category Utilities
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/functions/Ok.html | API: Ok}
+ */
+function Ok(data) {
+    return { success: true, data };
+}
+/**
+ * Creates a failed result
+ *
+ * @param error - The error that occurred
+ * @returns Failed result
+ *
+ * @group Errors
+ * @category Utilities
+ */
+function Err(error) {
+    return { success: false, error };
+}
+/**
+ * Maps a Result's success value to a new value
+ *
+ * @param result - The result to map
+ * @param fn - Function to transform the success value
+ * @returns New result with transformed value
+ *
+ * @group Errors
+ * @category Utilities
+ */
+function mapResult(result, fn) {
+    if (result.success) {
+        return Ok(fn(result.data));
+    }
+    return result;
+}
+/**
+ * Maps a Result's error value to a new error
+ *
+ * @param result - The result to map
+ * @param fn - Function to transform the error value
+ * @returns New result with transformed error
+ *
+ * @group Errors
+ * @category Utilities
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/functions/mapError.html | API: mapError}
+ */
+function mapError(result, fn) {
+    if (!result.success) {
+        return Err(fn(result.error));
+    }
+    return result;
+}
+/**
+ * Chains multiple operations that return Results
+ *
+ * @param result - The initial result
+ * @param fn - Function that takes success value and returns new Result
+ * @returns Chained result
+ *
+ * @group Errors
+ * @category Utilities
+ */
+function flatMapResult(result, fn) {
+    if (result.success) {
+        return fn(result.data);
+    }
+    return result;
+}
+/**
+ * Unwraps a Result, throwing the error if it failed
+ *
+ * @param result - The result to unwrap
+ * @returns The success value
+ * @throws The error if result failed
+ *
+ * @group Errors
+ * @category Utilities
+ */
+function unwrap(result) {
+    if (result.success) {
+        return result.data;
+    }
+    throw result.error;
+}
+/**
+ * Unwraps a Result, returning a default value if it failed
+ *
+ * @param result - The result to unwrap
+ * @param defaultValue - Value to return if result failed
+ * @returns The success value or default value
+ *
+ * @group Errors
+ * @category Utilities
+ */
+function unwrapOr(result, defaultValue) {
+    if (result.success) {
+        return result.data;
+    }
+    return defaultValue;
+}
+/**
+ * Converts a promise that might throw to a Result
+ *
+ * @param promise - Promise that might throw
+ * @returns Promise that resolves to a Result
+ *
+ * @group Errors
+ * @category Utilities
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/functions/fromPromise.html | API: fromPromise}
+ */
+async function fromPromise(promise) {
+    try {
+        const data = await promise;
+        return Ok(data);
+    }
+    catch (error) {
+        return Err(error instanceof Error ? error : new Error(String(error)));
+    }
+}
+//# sourceMappingURL=result.js.map

package/lib/interfaces/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../src/interfaces/result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;AAsBH,gBAEC;AAWD,kBAEC;AAYD,8BAQC;AAaD,4BAQC;AAYD,sCAQC;AAYD,wBAKC;AAYD,4BAKC;AAYD,kCAOC;AA3ID;;;;;;;;;GASG;AACH,SAAgB,EAAE,CAAI,IAAO;IAC3B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AACjC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,GAAG,CAAI,KAAQ;IAC7B,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,SAAS,CACvB,MAAoB,EACpB,EAAmB;IAEnB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,QAAQ,CACtB,MAAoB,EACpB,EAAmB;IAEnB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAC3B,MAAoB,EACpB,EAA8B;IAE9B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM,CAAO,MAAoB;IAC/C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,MAAM,CAAC,KAAK,CAAC;AACrB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAO,MAAoB,EAAE,YAAe;IAClE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAI,OAAmB;IACtD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC;QAC3B,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;AACH,CAAC"}