@bsb/base 9.0.0

package/lib/scripts/export-schemas.d.ts

@@ -0,0 +1,17 @@
+/**
+ * BSB Schema Export Script
+ *
+ * Discovers all BSB plugins and exports their event schemas to JSON format
+ * for cross-language client generation.
+ *
+ * Usage:
+ *   npm run export-schemas
+ *
+ * Output:
+ *   Writes schema JSON files to lib/schemas/{plugin-name}.json
+ */
+/**
+ * Main export function.
+ */
+declare function main(): Promise<void>;
+export { main as exportSchemas };

package/lib/scripts/export-schemas.js

@@ -0,0 +1,205 @@
+"use strict";
+/**
+ * BSB Schema Export Script
+ *
+ * Discovers all BSB plugins and exports their event schemas to JSON format
+ * for cross-language client generation.
+ *
+ * Usage:
+ *   npm run export-schemas
+ *
+ * Output:
+ *   Writes schema JSON files to lib/schemas/{plugin-name}.json
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportSchemas = main;
+const fs = require("fs");
+const path = require("path");
+const zod_1 = require("zod");
+const OBSERVABLE_METHODS = {
+    logging: ['debug', 'info', 'warn', 'error'],
+    metrics: ['createCounter', 'createGauge', 'createHistogram', 'incrementCounter', 'setGauge', 'observeHistogram'],
+    tracing: ['spanStart', 'spanEnd', 'spanError'],
+};
+const EVENTS_METHODS = [
+    'onBroadcast',
+    'emitBroadcast',
+    'onEvent',
+    'emitEvent',
+    'onReturnableEvent',
+    'emitEventAndReturn',
+    'receiveStream',
+    'sendStream',
+];
+const CONFIG_METHODS = [
+    'getObservablePlugins',
+    'getEventsPlugins',
+    'getServicePlugins',
+    'getServicePluginDefinition',
+    'getPluginConfig',
+];
+/**
+ * Discover all plugin modules in the lib directory.
+ * Looks for plugin entry points in:
+ * - lib/plugins/*\/index.js
+ */
+function discoverPlugins(libDir) {
+    const pluginPaths = [];
+    const pluginsDir = path.join(libDir, 'plugins');
+    if (!fs.existsSync(pluginsDir)) {
+        return pluginPaths;
+    }
+    const pluginDirs = fs.readdirSync(pluginsDir, { withFileTypes: true })
+        .filter(dirent => dirent.isDirectory())
+        .map(dirent => dirent.name);
+    for (const dir of pluginDirs) {
+        const indexPath = path.join(pluginsDir, dir, 'index.js');
+        if (fs.existsSync(indexPath)) {
+            pluginPaths.push(indexPath);
+        }
+    }
+    return pluginPaths;
+}
+function inferPluginType(pluginId, pluginClass) {
+    if (pluginId.startsWith('service-'))
+        return 'service';
+    if (pluginId.startsWith('observable-'))
+        return 'observable';
+    if (pluginId.startsWith('events-'))
+        return 'events';
+    if (pluginId.startsWith('config-'))
+        return 'config';
+    const baseName = pluginClass?.prototype?.constructor?.__proto__?.name || '';
+    if (baseName === 'BSBService')
+        return 'service';
+    if (baseName === 'BSBObservable')
+        return 'observable';
+    if (baseName === 'BSBEvents')
+        return 'events';
+    if (baseName === 'BSBConfig')
+        return 'config';
+    return 'unknown';
+}
+function hasMethod(proto, methodName) {
+    return typeof proto?.[methodName] === 'function';
+}
+function buildCapabilities(pluginType, proto) {
+    if (pluginType === 'observable') {
+        return {
+            logging: Object.fromEntries(OBSERVABLE_METHODS.logging.map((name) => [name, hasMethod(proto, name)])),
+            metrics: Object.fromEntries(OBSERVABLE_METHODS.metrics.map((name) => [name, hasMethod(proto, name)])),
+            tracing: Object.fromEntries(OBSERVABLE_METHODS.tracing.map((name) => [name, hasMethod(proto, name)])),
+        };
+    }
+    if (pluginType === 'events') {
+        return {
+            eventsApi: Object.fromEntries(EVENTS_METHODS.map((name) => [name, hasMethod(proto, name)])),
+        };
+    }
+    if (pluginType === 'config') {
+        return {
+            configApi: Object.fromEntries(CONFIG_METHODS.map((name) => [name, hasMethod(proto, name)])),
+        };
+    }
+    return undefined;
+}
+/**
+ * Main export function.
+ */
+async function main() {
+    const projectRoot = path.resolve(__dirname, '..', '..');
+    const libDir = path.join(projectRoot, 'lib');
+    const schemasDir = path.join(libDir, 'schemas');
+    // Ensure lib directory exists (must run after build)
+    if (!fs.existsSync(libDir)) {
+        // eslint-disable-next-line no-console
+        console.error('Error: lib directory not found. Run npm run build first.');
+        process.exit(1);
+    }
+    // Create schemas output directory
+    if (!fs.existsSync(schemasDir)) {
+        fs.mkdirSync(schemasDir, { recursive: true });
+    }
+    // Discover all plugins
+    const pluginPaths = discoverPlugins(libDir);
+    if (pluginPaths.length === 0) {
+        // eslint-disable-next-line no-console
+        console.log('No plugins found to export schemas from.');
+        return;
+    }
+    // eslint-disable-next-line no-console
+    console.log(`Found ${pluginPaths.length} plugin(s) to export schemas from...`);
+    let exportCount = 0;
+    let errorCount = 0;
+    // Process each plugin
+    for (const pluginPath of pluginPaths) {
+        try {
+            // Get plugin identifier from directory name
+            const pluginId = path.basename(path.dirname(pluginPath));
+            // Import the plugin module
+            const pluginModule = await Promise.resolve(`${pluginPath}`).then(s => require(s));
+            // Look for Plugin export
+            if (!pluginModule.Plugin) {
+                continue;
+            }
+            const Plugin = pluginModule.Plugin;
+            const pluginType = inferPluginType(pluginId, Plugin);
+            const pluginName = Plugin.Config?.metadata?.name || pluginId;
+            const pluginVersion = Plugin.Config?.metadata?.version || '1.0.0';
+            let schemas;
+            if (typeof Plugin.exportSchemas === 'function' && Plugin.Config && Plugin.EventSchemas) {
+                schemas = Plugin.exportSchemas();
+            }
+            else {
+                schemas = {
+                    pluginName,
+                    version: pluginVersion,
+                    events: {},
+                };
+            }
+            schemas.pluginType = pluginType;
+            const capabilities = buildCapabilities(pluginType, Plugin.prototype);
+            if (capabilities) {
+                schemas.capabilities = capabilities;
+            }
+            if (Plugin.Config) {
+                try {
+                    const configInstance = new Plugin.Config('', '', '', '');
+                    if (configInstance.validationSchema && typeof configInstance.validationSchema === 'object') {
+                        schemas.configSchema = (0, zod_1.toJSONSchema)(configInstance.validationSchema);
+                    }
+                }
+                catch {
+                    // Optional: if config schema extraction fails, keep going
+                }
+            }
+            // Write to file using plugin directory name (not display name)
+            const outputPath = path.join(schemasDir, `${pluginId}.json`);
+            fs.writeFileSync(outputPath, JSON.stringify(schemas, null, 2), 'utf-8');
+            // eslint-disable-next-line no-console
+            console.log(`  Exported schemas for ${pluginId} (v${schemas.version}, type=${pluginType})`);
+            exportCount++;
+        }
+        catch (error) {
+            errorCount++;
+            // eslint-disable-next-line no-console
+            console.error(`  Error exporting ${path.basename(path.dirname(pluginPath))}: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    // eslint-disable-next-line no-console
+    console.log(`\nSchema export complete: ${exportCount} exported, ${errorCount} errors`);
+    // eslint-disable-next-line no-console
+    console.log(`Schemas written to: ${schemasDir}`);
+    if (errorCount > 0) {
+        process.exit(1);
+    }
+}
+// Run if called directly
+if (require.main === module) {
+    main().catch(error => {
+        // eslint-disable-next-line no-console
+        console.error('Fatal error during schema export:', error);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=export-schemas.js.map

package/lib/scripts/export-schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-schemas.js","sourceRoot":"","sources":["../../src/scripts/export-schemas.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;AAuNc,6BAAa;AArN9B,yBAAyB;AACzB,6BAA6B;AAC7B,6BAAmC;AAInC,MAAM,kBAAkB,GAAG;IACzB,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;IAC3C,OAAO,EAAE,CAAC,eAAe,EAAE,aAAa,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,UAAU,EAAE,kBAAkB,CAAC;IAChH,OAAO,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,WAAW,CAAC;CACtC,CAAC;AAEX,MAAM,cAAc,GAAG;IACrB,aAAa;IACb,eAAe;IACf,SAAS;IACT,WAAW;IACX,mBAAmB;IACnB,oBAAoB;IACpB,eAAe;IACf,YAAY;CACJ,CAAC;AAEX,MAAM,cAAc,GAAG;IACrB,sBAAsB;IACtB,kBAAkB;IAClB,mBAAmB;IACnB,4BAA4B;IAC5B,iBAAiB;CACT,CAAC;AAEX;;;;GAIG;AACH,SAAS,eAAe,CAAC,MAAc;IACrC,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEhD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,UAAU,GAAG,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;SACnE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;SACtC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE9B,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QACzD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB,EAAE,WAAgB;IACzD,IAAI,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC;QAAE,OAAO,SAAS,CAAC;IACtD,IAAI,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC;QAAE,OAAO,YAAY,CAAC;IAC5D,IAAI,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;QAAE,OAAO,QAAQ,CAAC;IACpD,IAAI,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;QAAE,OAAO,QAAQ,CAAC;IAEpD,MAAM,QAAQ,GAAG,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC;IAC5E,IAAI,QAAQ,KAAK,YAAY;QAAE,OAAO,SAAS,CAAC;IAChD,IAAI,QAAQ,KAAK,eAAe;QAAE,OAAO,YAAY,CAAC;IACtD,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,QAAQ,CAAC;IAC9C,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,QAAQ,CAAC;IAC9C,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,SAAS,CAAC,KAAU,EAAE,UAAkB;IAC/C,OAAO,OAAO,KAAK,EAAE,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AACnD,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAsB,EAAE,KAAU;IAC3D,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;YACrG,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;YACrG,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;SACtG,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;SAC5F,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;SAC5F,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEhD,qDAAqD;IACrD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,kCAAkC;IAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,uBAAuB;IACvB,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAE5C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;QACxD,OAAO;IACT,CAAC;IAED,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,SAAS,WAAW,CAAC,MAAM,sCAAsC,CAAC,CAAC;IAE/E,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,sBAAsB;IACtB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,4CAA4C;YAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;YAEzD,2BAA2B;YAC3B,MAAM,YAAY,GAAG,yBAAa,UAAU,yBAAC,CAAC;YAE9C,yBAAyB;YACzB,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBACzB,SAAS;YACX,CAAC;YAED,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;YAEnC,MAAM,UAAU,GAAG,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,IAAI,QAAQ,CAAC;YAC7D,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,IAAI,OAAO,CAAC;YAElE,IAAI,OAA4B,CAAC;YACjC,IAAI,OAAO,MAAM,CAAC,aAAa,KAAK,UAAU,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;gBACvF,OAAO,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG;oBACR,UAAU;oBACV,OAAO,EAAE,aAAa;oBACtB,MAAM,EAAE,EAAE;iBACX,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;YAChC,MAAM,YAAY,GAAG,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;YACrE,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC;YACtC,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,IAAI,CAAC;oBACH,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;oBACzD,IAAI,cAAc,CAAC,gBAAgB,IAAI,OAAO,cAAc,CAAC,gBAAgB,KAAK,QAAQ,EAAE,CAAC;wBAC3F,OAAO,CAAC,YAAY,GAAG,IAAA,kBAAY,EAAC,cAAc,CAAC,gBAAuB,CAAC,CAAC;oBAC9E,CAAC;gBACH,CAAC;gBAAC,MAAM,CAAC;oBACP,0DAA0D;gBAC5D,CAAC;YACH,CAAC;YAED,+DAA+D;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC;YAC7D,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAExE,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,0BAA0B,QAAQ,MAAM,OAAO,CAAC,OAAO,UAAU,UAAU,GAAG,CAAC,CAAC;YAC5F,WAAW,EAAE,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,UAAU,EAAE,CAAC;YACb,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,qBAAqB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3I,CAAC;IACH,CAAC;IAED,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,6BAA6B,WAAW,cAAc,UAAU,SAAS,CAAC,CAAC;IACvF,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAC;IAEjD,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,yBAAyB;AACzB,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACnB,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/lib/scripts/extract-schemas-from-source.d.ts

@@ -0,0 +1,23 @@
+/**
+ * BSB Schema Extraction from TypeScript Source
+ *
+ * Extracts event schemas directly from plugin TypeScript source files
+ * without requiring compilation. This breaks the circular dependency:
+ *   build needs schemas → schemas need compiled JS → JS needs build
+ *
+ * Approach:
+ *   1. Read plugin index.ts, truncate at `export class Plugin`
+ *   2. Rewrite imports to avoid pulling in runtime deps (BSBService, etc.)
+ *   3. Keep local relative imports (./types, ./utils) — they may define schemas
+ *   4. Append footer that calls exportEventSchemas() and outputs JSON
+ *   5. Execute temp file with ts-node, capture JSON output
+ *   6. Write schema JSON to src/.bsb/schemas/
+ *
+ * The temp file is placed in the plugin's own directory so that relative
+ * imports (./types, ./storage, etc.) resolve correctly.
+ */
+/**
+ * Main extraction function.
+ */
+declare function main(): Promise<void>;
+export { main as extractSchemasFromSource };