@bsb/base 9.0.0

package/lib/interfaces/schema-types.js

@@ -0,0 +1,581 @@
+"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.bsb = void 0;
+exports.optional = optional;
+exports.nullable = nullable;
+exports.bsbToJsonSchema = bsbToJsonSchema;
+exports.bsbToZod = bsbToZod;
+const zod_1 = require("zod");
+// ============================================================================
+// Builder API - Fluent Interface for Creating BSB Types
+// ============================================================================
+/**
+ * BSB type builder providing a fluent API for creating cross-language type definitions.
+ *
+ * @example
+ * ```typescript
+ * import { bsb, optional } from '@bsb/base';
+ *
+ * const UserSchema = bsb.object({
+ *   id: bsb.uuid('User unique identifier'),
+ *   name: bsb.string({ min: 1, max: 100, description: 'User full name' }),
+ *   email: bsb.string({ description: 'User email address' }),
+ *   age: optional(bsb.int32({ min: 0, max: 150, description: 'User age' })),
+ * });
+ * ```
+ */
+exports.bsb = {
+    /**
+     * Create a string type with optional constraints.
+     */
+    string(options) {
+        return {
+            _bsb: 'string',
+            minLength: options?.min,
+            maxLength: options?.max,
+            pattern: options?.pattern,
+            description: options?.description,
+        };
+    },
+    /**
+     * Create a UUID string type (RFC 4122).
+     *
+     * Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: string
+     * - C#: Guid
+     * - Go: uuid.UUID
+     * - Java: UUID
+     */
+    uuid(description) {
+        return {
+            _bsb: 'string',
+            format: 'uuid',
+            description,
+        };
+    },
+    /**
+     * Create an ISO 8601 datetime string type.
+     *
+     * Format: 2024-01-01T12:00:00Z
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: Date | string
+     * - C#: DateTime
+     * - Go: time.Time
+     * - Java: Instant
+     */
+    datetime(description) {
+        return {
+            _bsb: 'string',
+            format: 'datetime',
+            description,
+        };
+    },
+    /**
+     * Create an email address string type.
+     */
+    email(description) {
+        return {
+            _bsb: 'string',
+            format: 'email',
+            description,
+        };
+    },
+    /**
+     * Create a URI string type.
+     */
+    uri(description) {
+        return {
+            _bsb: 'string',
+            format: 'uri',
+            description,
+        };
+    },
+    /**
+     * Create a URL string type.
+     */
+    url(description) {
+        return {
+            _bsb: 'string',
+            format: 'url',
+            description,
+        };
+    },
+    /**
+     * Create a 32-bit signed integer type.
+     *
+     * Range: -2,147,483,648 to 2,147,483,647
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: number
+     * - C#: int
+     * - Go: int32
+     * - Java: int
+     */
+    int32(options) {
+        return {
+            _bsb: 'number',
+            numberType: 'int32',
+            min: options?.min ?? -2147483648,
+            max: options?.max ?? 2147483647,
+            description: options?.description,
+        };
+    },
+    /**
+     * Create a 64-bit signed integer type.
+     *
+     * Range: -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807
+     *
+     * Note: JavaScript can only safely represent integers up to 2^53.
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: number
+     * - C#: long
+     * - Go: int64
+     * - Java: long
+     */
+    int64(options) {
+        return {
+            _bsb: 'number',
+            numberType: 'int64',
+            min: options?.min,
+            max: options?.max,
+            description: options?.description,
+        };
+    },
+    /**
+     * Create a 32-bit floating point number type.
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: number
+     * - C#: float
+     * - Go: float32
+     * - Java: float
+     */
+    float(options) {
+        return {
+            _bsb: 'number',
+            numberType: 'float',
+            min: options?.min,
+            max: options?.max,
+            description: options?.description,
+        };
+    },
+    /**
+     * Create a 64-bit floating point number type.
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: number
+     * - C#: double
+     * - Go: float64
+     * - Java: double
+     */
+    double(options) {
+        return {
+            _bsb: 'number',
+            numberType: 'double',
+            min: options?.min,
+            max: options?.max,
+            description: options?.description,
+        };
+    },
+    /**
+     * Create a boolean type.
+     *
+     * Language mappings:
+     * - JavaScript/TypeScript: boolean
+     * - C#: bool
+     * - Go: bool
+     * - Java: boolean
+     */
+    boolean(description) {
+        return {
+            _bsb: 'boolean',
+            description,
+        };
+    },
+    /**
+     * Create a bytes type for binary data.
+     * Maps to:
+     * - JavaScript/TypeScript: Uint8Array or Buffer
+     * - C#: byte[]
+     * - Go: []byte
+     * - Java: byte[]
+     * - Python: bytes
+     */
+    bytes(description) {
+        return {
+            _bsb: 'bytes',
+            description,
+        };
+    },
+    /**
+     * Create an array type with element type and optional size constraints.
+     *
+     * @example
+     * ```typescript
+     * const TagsSchema = bsb.array(
+     *   bsb.string({ max: 50 }),
+     *   { min: 1, max: 10, description: 'List of tags' }
+     * );
+     * ```
+     */
+    array(items, options) {
+        return {
+            _bsb: 'array',
+            items,
+            minItems: options?.min,
+            maxItems: options?.max,
+            description: options?.description,
+        };
+    },
+    /**
+     * Create an object type with named properties.
+     *
+     * Required fields are automatically determined based on the optional flag.
+     *
+     * @example
+     * ```typescript
+     * const UserSchema = bsb.object({
+     *   id: bsb.uuid('User ID'),
+     *   name: bsb.string({ min: 1, max: 100, description: 'Full name' }),
+     *   email: optional(bsb.email('Email address')),
+     * }, 'User object');
+     * ```
+     */
+    object(properties, description) {
+        // Compute required fields (non-optional)
+        const required = Object.keys(properties).filter((key) => properties[key].optional !== true);
+        return {
+            _bsb: 'object',
+            properties,
+            required,
+            description,
+        };
+    },
+    /**
+     * Create an enum type with fixed string values.
+     *
+     * @example
+     * ```typescript
+     * const StatusSchema = bsb.enum(
+     *   ['pending', 'in-progress', 'completed', 'failed'],
+     *   'Task status'
+     * );
+     * ```
+     */
+    enum(values, description) {
+        return {
+            _bsb: 'enum',
+            values: [...values],
+            description,
+        };
+    },
+    /**
+     * Create a union type representing one of multiple possible types.
+     *
+     * @example
+     * ```typescript
+     * const IdSchema = bsb.union([
+     *   bsb.uuid('UUID identifier'),
+     *   bsb.int32({ description: 'Numeric identifier' }),
+     * ], 'Flexible identifier');
+     * ```
+     */
+    union(types, description) {
+        return {
+            _bsb: 'union',
+            types,
+            description,
+        };
+    },
+    /**
+     * Create a generic number type (defaults to double for floating point).
+     * This is a convenience wrapper for double().
+     */
+    number(options) {
+        return this.double(options);
+    },
+    /**
+     * Create a void type for functions that don't return a value.
+     */
+    void() {
+        return this.union([], 'void');
+    },
+    /**
+     * Create an unknown type for dynamic/any data.
+     */
+    unknown(description) {
+        return this.union([], description || 'unknown');
+    },
+    /**
+     * Create a record/map type with string keys and a value type.
+     */
+    record(keyType, valueType, description) {
+        // Records are represented as objects with dynamic properties
+        // For now, we'll use a union as a placeholder
+        return this.union([valueType], description || 'record');
+    },
+};
+// ============================================================================
+// Type Modifiers
+// ============================================================================
+/**
+ * Mark a type as optional.
+ * Optional fields are not required in object schemas.
+ *
+ * @example
+ * ```typescript
+ * const UserSchema = bsb.object({
+ *   name: bsb.string(),           // Required
+ *   bio: optional(bsb.string()),  // Optional
+ * });
+ * ```
+ */
+function optional(type) {
+    return { ...type, optional: true };
+}
+/**
+ * Mark a type as nullable.
+ * Nullable fields can have null values in addition to their defined type.
+ *
+ * @example
+ * ```typescript
+ * const UserSchema = bsb.object({
+ *   lastLogin: nullable(bsb.datetime('Last login time')),
+ * });
+ * ```
+ */
+function nullable(type) {
+    return { ...type, nullable: true };
+}
+// ============================================================================
+// JSON Schema Conversion
+// ============================================================================
+/**
+ * Convert BSB type to JSON Schema format.
+ * Used for schema export and client code generation.
+ */
+function bsbToJsonSchema(type) {
+    const base = {};
+    if (type.description)
+        base.description = type.description;
+    switch (type._bsb) {
+        case 'string': {
+            const schema = { ...base, type: 'string' };
+            if (type.format)
+                schema.format = type.format;
+            if (type.minLength !== undefined)
+                schema.minLength = type.minLength;
+            if (type.maxLength !== undefined)
+                schema.maxLength = type.maxLength;
+            if (type.pattern)
+                schema.pattern = type.pattern;
+            return schema;
+        }
+        case 'number': {
+            const isInteger = type.numberType === 'int32' || type.numberType === 'int64';
+            const schema = {
+                ...base,
+                type: isInteger ? 'integer' : 'number',
+                format: type.numberType,
+            };
+            if (type.min !== undefined)
+                schema.minimum = type.min;
+            if (type.max !== undefined)
+                schema.maximum = type.max;
+            return schema;
+        }
+        case 'boolean':
+            return { ...base, type: 'boolean' };
+        case 'bytes':
+            return {
+                ...base,
+                type: 'string',
+                contentEncoding: 'base64',
+            };
+        case 'array': {
+            const schema = {
+                ...base,
+                type: 'array',
+                items: bsbToJsonSchema(type.items),
+            };
+            if (type.minItems !== undefined)
+                schema.minItems = type.minItems;
+            if (type.maxItems !== undefined)
+                schema.maxItems = type.maxItems;
+            return schema;
+        }
+        case 'object': {
+            const properties = {};
+            for (const [key, value] of Object.entries(type.properties)) {
+                properties[key] = bsbToJsonSchema(value);
+            }
+            return {
+                ...base,
+                type: 'object',
+                properties,
+                required: type.required,
+            };
+        }
+        case 'enum':
+            return {
+                ...base,
+                type: 'string',
+                enum: type.values,
+            };
+        case 'union':
+            return {
+                ...base,
+                oneOf: type.types.map(bsbToJsonSchema),
+            };
+        default:
+            throw new Error(`Unknown BSB type: ${type._bsb}`);
+    }
+}
+// ============================================================================
+// Runtime Validation (Zod Conversion)
+// ============================================================================
+/**
+ * Convert BSB type to Zod schema for runtime validation.
+ * This is only used in Node.js plugins for runtime validation.
+ * Other languages will have their own validation implementations.
+ */
+function bsbToZod(type) {
+    switch (type._bsb) {
+        case 'string': {
+            let schema = zod_1.z.string();
+            if (type.format === 'uuid')
+                schema = schema.uuid();
+            if (type.format === 'datetime')
+                schema = schema.datetime();
+            if (type.format === 'email')
+                schema = schema.email();
+            if (type.format === 'uri' || type.format === 'url')
+                schema = schema.url();
+            if (type.minLength !== undefined)
+                schema = schema.min(type.minLength);
+            if (type.maxLength !== undefined)
+                schema = schema.max(type.maxLength);
+            if (type.pattern)
+                schema = schema.regex(new RegExp(type.pattern));
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'number': {
+            let schema = zod_1.z.number();
+            if (type.numberType === 'int32' || type.numberType === 'int64') {
+                schema = schema.int();
+            }
+            if (type.min !== undefined)
+                schema = schema.min(type.min);
+            if (type.max !== undefined)
+                schema = schema.max(type.max);
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'boolean': {
+            let schema = zod_1.z.boolean();
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'bytes': {
+            let schema = zod_1.z.instanceof(Uint8Array);
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'array': {
+            let schema = zod_1.z.array(bsbToZod(type.items));
+            if (type.minItems !== undefined)
+                schema = schema.min(type.minItems);
+            if (type.maxItems !== undefined)
+                schema = schema.max(type.maxItems);
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'object': {
+            const shape = {};
+            for (const [key, value] of Object.entries(type.properties)) {
+                shape[key] = bsbToZod(value);
+            }
+            let schema = zod_1.z.object(shape);
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'enum': {
+            let schema = zod_1.z.enum(type.values);
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        case 'union': {
+            // Empty union = unknown/any type (used by bsb.unknown() and bsb.void())
+            if (type.types.length === 0) {
+                let schema = zod_1.z.unknown();
+                if (type.optional)
+                    return schema.optional();
+                if (type.nullable)
+                    return schema.nullable();
+                return schema;
+            }
+            const schemas = type.types.map(bsbToZod);
+            let schema = zod_1.z.union(schemas);
+            if (type.optional)
+                return schema.optional();
+            if (type.nullable)
+                return schema.nullable();
+            return schema;
+        }
+        default:
+            throw new Error(`Unknown BSB type: ${type._bsb}`);
+    }
+}
+//# sourceMappingURL=schema-types.js.map

package/lib/interfaces/schema-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-types.js","sourceRoot":"","sources":["../../src/interfaces/schema-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAigBH,4BAEC;AAaD,4BAEC;AA0DD,0CA4EC;AAWD,4BAuFC;AAxvBD,6BAAwB;AA0GxB,+EAA+E;AAC/E,wDAAwD;AACxD,+EAA+E;AAE/E;;;;;;;;;;;;;;GAcG;AACU,QAAA,GAAG,GAAG;IACjB;;OAEG;IACH,MAAM,CAAC,OAKN;QACC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,OAAO,EAAE,GAAG;YACvB,SAAS,EAAE,OAAO,EAAE,GAAG;YACvB,OAAO,EAAE,OAAO,EAAE,OAAO;YACzB,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,WAAoB;QACvB,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,MAAM;YACd,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAoB;QAC3B,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,UAAU;YAClB,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAoB;QACxB,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,WAAoB;QACtB,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,KAAK;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,WAAoB;QACtB,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,KAAK;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAIL;QACC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,OAAO;YACnB,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,UAAU;YAChC,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,UAAU;YAC/B,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAIL;QACC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,OAAO;YACnB,GAAG,EAAE,OAAO,EAAE,GAAG;YACjB,GAAG,EAAE,OAAO,EAAE,GAAG;YACjB,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAIL;QACC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,OAAO;YACnB,GAAG,EAAE,OAAO,EAAE,GAAG;YACjB,GAAG,EAAE,OAAO,EAAE,GAAG;YACjB,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAIN;QACC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,QAAQ;YACpB,GAAG,EAAE,OAAO,EAAE,GAAG;YACjB,GAAG,EAAE,OAAO,EAAE,GAAG;YACjB,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,WAAoB;QAC1B,OAAO;YACL,IAAI,EAAE,SAAS;YACf,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAoB;QACxB,OAAO;YACL,IAAI,EAAE,OAAO;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CACH,KAAc,EACd,OAIC;QAED,OAAO;YACL,IAAI,EAAE,OAAO;YACb,KAAK;YACL,QAAQ,EAAE,OAAO,EAAE,GAAG;YACtB,QAAQ,EAAE,OAAO,EAAE,GAAG;YACtB,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,UAAa,EACb,WAAoB;QASpB,yCAAyC;QACzC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,UAAiB,CAAC,CAAC,MAAM,CACpD,CAAC,GAAG,EAAE,EAAE,CAAE,UAAkB,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,IAAI,CACpD,CAAC;QAEF,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU;YACV,QAAQ;YACR,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAyB,EACzB,WAAoB;QAEpB,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC;YACnB,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CACH,KAAgB,EAChB,WAAoB;QAEpB,OAAO;YACL,IAAI,EAAE,OAAO;YACb,KAAK;YACL,WAAW;SACZ,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAIN;QACC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,WAAoB;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,IAAI,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAU,EACV,SAAY,EACZ,WAAoB;QAEpB,6DAA6D;QAC7D,8CAA8C;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,IAAI,QAAQ,CAAC,CAAC;IAC1D,CAAC;CACF,CAAC;AAEF,+EAA+E;AAC/E,iBAAiB;AACjB,+EAA+E;AAE/E;;;;;;;;;;;GAWG;AACH,SAAgB,QAAQ,CAAoB,IAAO;IACjD,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,EAA4B,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,QAAQ,CAAoB,IAAO;IACjD,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AACrC,CAAC;AAkDD,+EAA+E;AAC/E,yBAAyB;AACzB,+EAA+E;AAE/E;;;GAGG;AACH,SAAgB,eAAe,CAAC,IAAa;IAC3C,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,IAAI,IAAI,CAAC,WAAW;QAAE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IAE1D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,MAAM,GAAQ,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC7C,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;gBAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YACpE,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;gBAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YACpE,IAAI,IAAI,CAAC,OAAO;gBAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,CAAC;YAC7E,MAAM,MAAM,GAAQ;gBAClB,GAAG,IAAI;gBACP,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ;gBACtC,MAAM,EAAE,IAAI,CAAC,UAAU;aACxB,CAAC;YACF,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS;gBAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;YACtD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS;gBAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;YACtD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,SAAS;YACZ,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAEtC,KAAK,OAAO;YACV,OAAO;gBACL,GAAG,IAAI;gBACP,IAAI,EAAE,QAAQ;gBACd,eAAe,EAAE,QAAQ;aAC1B,CAAC;QAEJ,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,MAAM,GAAQ;gBAClB,GAAG,IAAI;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;aACnC,CAAC;YACF,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YACjE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YACjE,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,UAAU,GAAQ,EAAE,CAAC;YAC3B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3D,UAAU,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC;YACD,OAAO;gBACL,GAAG,IAAI;gBACP,IAAI,EAAE,QAAQ;gBACd,UAAU;gBACV,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC;QACJ,CAAC;QAED,KAAK,MAAM;YACT,OAAO;gBACL,GAAG,IAAI;gBACP,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAAI,CAAC,MAAM;aAClB,CAAC;QAEJ,KAAK,OAAO;YACV,OAAO;gBACL,GAAG,IAAI;gBACP,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC;aACvC,CAAC;QAEJ;YACE,MAAM,IAAI,KAAK,CAAC,qBAAsB,IAAY,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,sCAAsC;AACtC,+EAA+E;AAE/E;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,IAAa;IACpC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM;gBAAE,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU;gBAAE,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3D,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO;gBAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;YACrD,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;YAC1E,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACtE,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACtE,IAAI,IAAI,CAAC,OAAO;gBAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YAClE,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE,CAAC;gBAC/D,MAAM,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;YACxB,CAAC;YACD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1D,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1D,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,MAAM,GAAG,OAAC,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,IAAI,MAAM,GAAG,OAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,IAAI,MAAM,GAAG,OAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpE,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,KAAK,GAAQ,EAAE,CAAC;YACtB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3D,KAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,MAAM,GAAG,OAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7B,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,MAAM,GAAG,OAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAa,CAAC,CAAC;YACxC,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,wEAAwE;YACxE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,IAAI,MAAM,GAAiB,OAAC,CAAC,OAAO,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,QAAQ;oBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5C,IAAI,IAAI,CAAC,QAAQ;oBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5C,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACzC,IAAI,MAAM,GAAG,OAAC,CAAC,KAAK,CAAC,OAAc,CAAC,CAAC;YACrC,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED;YACE,MAAM,IAAI,KAAK,CAAC,qBAAsB,IAAY,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC"}

package/lib/interfaces/service.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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";
+/**
+ * Base interface for service events
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/ServiceEventsBase.html | API: ServiceEventsBase}
+ */
+export interface ServiceEventsBase {
+    [key: string]: (...args: any[]) => Promise<any> | any;
+}
+/**
+ * Base interface for callable service events
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/ServiceEventsCallableBase.html | API: ServiceEventsCallableBase}
+ */
+export interface ServiceEventsCallableBase {
+    [key: string]: (trace: DTrace, ...args: any[]) => Promise<any> | any;
+}
+/**
+ * Default service events interface
+ * @see {@link https://bsbcode.dev/languages/nodejs/types/interfaces/ServiceEventsDefault.html | API: ServiceEventsDefault}
+ */
+export interface ServiceEventsDefault {
+    [key: string]: () => never;
+}

package/lib/interfaces/service.js

@@ -0,0 +1,29 @@
+"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 });
+//# sourceMappingURL=service.js.map

package/lib/interfaces/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/interfaces/service.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG"}