@objectstack/runtime 1.0.4 → 1.0.6

package/dist/route-manager.js

@@ -1,251 +0,0 @@
-/**
- * RouteManager
- *
- * Manages route registration and organization for HTTP servers.
- * Provides:
- * - Route registration with metadata
- * - Route lookup and querying
- * - Bulk route registration
- * - Route grouping by prefix
- *
- * @example
- * const manager = new RouteManager(server);
- *
- * // Register individual route
- * manager.register({
- *   method: 'GET',
- *   path: '/api/users/:id',
- *   handler: getUserHandler,
- *   metadata: {
- *     summary: 'Get user by ID',
- *     tags: ['users']
- *   }
- * });
- *
- * // Register route group
- * manager.group('/api/users', (group) => {
- *   group.get('/', listUsersHandler);
- *   group.post('/', createUserHandler);
- *   group.get('/:id', getUserHandler);
- * });
- */
-export class RouteManager {
-    constructor(server) {
-        this.server = server;
-        this.routes = new Map();
-    }
-    /**
-     * Register a route
-     * @param entry - Route entry with method, path, handler, and metadata
-     */
-    register(entry) {
-        // Validate handler type - string handlers not yet supported
-        if (typeof entry.handler === 'string') {
-            throw new Error(`String-based route handlers are not supported yet. ` +
-                `Received handler identifier "${entry.handler}". ` +
-                `Please provide a RouteHandler function instead.`);
-        }
-        const handler = entry.handler;
-        const routeEntry = {
-            method: entry.method,
-            path: entry.path,
-            handler,
-            metadata: entry.metadata,
-            security: entry.security,
-        };
-        const key = this.getRouteKey(entry.method, entry.path);
-        this.routes.set(key, routeEntry);
-        // Register with underlying server
-        this.registerWithServer(routeEntry);
-    }
-    /**
-     * Register multiple routes
-     * @param entries - Array of route entries
-     */
-    registerMany(entries) {
-        entries.forEach(entry => this.register(entry));
-    }
-    /**
-     * Unregister a route
-     * @param method - HTTP method
-     * @param path - Route path
-     */
-    unregister(method, path) {
-        const key = this.getRouteKey(method, path);
-        this.routes.delete(key);
-        // Note: Most server frameworks don't support unregistering routes at runtime
-        // This just removes it from our registry
-    }
-    /**
-     * Get route by method and path
-     * @param method - HTTP method
-     * @param path - Route path
-     */
-    get(method, path) {
-        const key = this.getRouteKey(method, path);
-        return this.routes.get(key);
-    }
-    /**
-     * Get all routes
-     */
-    getAll() {
-        return Array.from(this.routes.values());
-    }
-    /**
-     * Get routes by method
-     * @param method - HTTP method
-     */
-    getByMethod(method) {
-        return this.getAll().filter(route => route.method === method);
-    }
-    /**
-     * Get routes by path prefix
-     * @param prefix - Path prefix
-     */
-    getByPrefix(prefix) {
-        return this.getAll().filter(route => route.path.startsWith(prefix));
-    }
-    /**
-     * Get routes by tag
-     * @param tag - Tag name
-     */
-    getByTag(tag) {
-        return this.getAll().filter(route => route.metadata?.tags?.includes(tag));
-    }
-    /**
-     * Create a route group with common prefix
-     * @param prefix - Common path prefix
-     * @param configure - Function to configure routes in the group
-     */
-    group(prefix, configure) {
-        const builder = new RouteGroupBuilder(this, prefix);
-        configure(builder);
-    }
-    /**
-     * Get route count
-     */
-    count() {
-        return this.routes.size;
-    }
-    /**
-     * Clear all routes
-     */
-    clear() {
-        this.routes.clear();
-    }
-    /**
-     * Get route key for storage
-     */
-    getRouteKey(method, path) {
-        return `${method}:${path}`;
-    }
-    /**
-     * Register route with underlying server
-     */
-    registerWithServer(entry) {
-        const { method, path, handler } = entry;
-        switch (method) {
-            case 'GET':
-                this.server.get(path, handler);
-                break;
-            case 'POST':
-                this.server.post(path, handler);
-                break;
-            case 'PUT':
-                this.server.put(path, handler);
-                break;
-            case 'DELETE':
-                this.server.delete(path, handler);
-                break;
-            case 'PATCH':
-                this.server.patch(path, handler);
-                break;
-            default:
-                throw new Error(`Unsupported HTTP method: ${method}`);
-        }
-    }
-}
-/**
- * RouteGroupBuilder
- *
- * Builder for creating route groups with common prefix
- */
-export class RouteGroupBuilder {
-    constructor(manager, prefix) {
-        this.manager = manager;
-        this.prefix = prefix;
-    }
-    /**
-     * Register GET route in group
-     */
-    get(path, handler, metadata) {
-        this.manager.register({
-            method: 'GET',
-            path: this.resolvePath(path),
-            handler,
-            metadata,
-        });
-        return this;
-    }
-    /**
-     * Register POST route in group
-     */
-    post(path, handler, metadata) {
-        this.manager.register({
-            method: 'POST',
-            path: this.resolvePath(path),
-            handler,
-            metadata,
-        });
-        return this;
-    }
-    /**
-     * Register PUT route in group
-     */
-    put(path, handler, metadata) {
-        this.manager.register({
-            method: 'PUT',
-            path: this.resolvePath(path),
-            handler,
-            metadata,
-        });
-        return this;
-    }
-    /**
-     * Register PATCH route in group
-     */
-    patch(path, handler, metadata) {
-        this.manager.register({
-            method: 'PATCH',
-            path: this.resolvePath(path),
-            handler,
-            metadata,
-        });
-        return this;
-    }
-    /**
-     * Register DELETE route in group
-     */
-    delete(path, handler, metadata) {
-        this.manager.register({
-            method: 'DELETE',
-            path: this.resolvePath(path),
-            handler,
-            metadata,
-        });
-        return this;
-    }
-    /**
-     * Resolve full path with prefix
-     */
-    resolvePath(path) {
-        // Normalize slashes
-        const normalizedPrefix = this.prefix.endsWith('/')
-            ? this.prefix.slice(0, -1)
-            : this.prefix;
-        const normalizedPath = path.startsWith('/')
-            ? path
-            : '/' + path;
-        return normalizedPrefix + normalizedPath;
-    }
-}

package/dist/runtime.d.ts

@@ -1,45 +0,0 @@
-import { ObjectKernel, Plugin, IHttpServer, ObjectKernelConfig } from '@objectstack/core';
-import { ApiRegistryConfig } from './api-registry-plugin.js';
-export interface RuntimeConfig {
-    /**
-     * Optional existing server instance (e.g. Hono, Express app)
-     * If provided, Runtime will use it as the 'http.server' service.
-     * If not provided, Runtime expects a server plugin (like HonoServerPlugin) to be registered manually.
-     */
-    server?: IHttpServer;
-    /**
-     * API Registry Configuration
-     */
-    api?: ApiRegistryConfig;
-    /**
-     * Kernel Configuration
-     */
-    kernel?: ObjectKernelConfig;
-}
-/**
- * ObjectStack Runtime
- *
- * High-level entry point for bootstrapping an ObjectStack application.
- * Wraps ObjectKernel and provides standard orchestration for:
- * - HTTP Server binding
- * - API Registry (REST Routes)
- * - Plugin Management
- */
-export declare class Runtime {
-    readonly kernel: ObjectKernel;
-    constructor(config?: RuntimeConfig);
-    /**
-     * Register a plugin
-     */
-    use(plugin: Plugin): this;
-    /**
-     * Start the runtime
-     * 1. Initializes all plugins (init phase)
-     * 2. Starts all plugins (start phase)
-     */
-    start(): Promise<this>;
-    /**
-     * Get the kernel instance
-     */
-    getKernel(): ObjectKernel;
-}

package/dist/runtime.js

@@ -1,50 +0,0 @@
-import { ObjectKernel } from '@objectstack/core';
-import { createApiRegistryPlugin } from './api-registry-plugin.js';
-/**
- * ObjectStack Runtime
- *
- * High-level entry point for bootstrapping an ObjectStack application.
- * Wraps ObjectKernel and provides standard orchestration for:
- * - HTTP Server binding
- * - API Registry (REST Routes)
- * - Plugin Management
- */
-export class Runtime {
-    constructor(config = {}) {
-        this.kernel = new ObjectKernel(config.kernel);
-        // If external server provided, register it immediately
-        if (config.server) {
-            // If the provided server is not already an HttpServer wrapper, wrap it?
-            // Since IHttpServer is the interface, we assume it complies.
-            // But HttpServer class in runtime is an adapter.
-            // If user passes raw Hono, it won't work unless they wrapped it.
-            // We'll assume they pass a compliant IHttpServer.
-            this.kernel.registerService('http.server', config.server);
-        }
-        // Register API Registry by default
-        // This plugin is passive (wait for services) so it's safe to add early.
-        this.kernel.use(createApiRegistryPlugin(config.api));
-    }
-    /**
-     * Register a plugin
-     */
-    use(plugin) {
-        this.kernel.use(plugin);
-        return this;
-    }
-    /**
-     * Start the runtime
-     * 1. Initializes all plugins (init phase)
-     * 2. Starts all plugins (start phase)
-     */
-    async start() {
-        await this.kernel.bootstrap();
-        return this;
-    }
-    /**
-     * Get the kernel instance
-     */
-    getKernel() {
-        return this.kernel;
-    }
-}

package/dist/runtime.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/runtime.test.js

@@ -1,57 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { Runtime } from './runtime';
-// Mock ObjectKernel to isolate Runtime logic
-vi.mock('@objectstack/core', async () => {
-    const actual = await vi.importActual('@objectstack/core');
-    return {
-        ...actual,
-        ObjectKernel: class {
-            constructor() {
-                this.use = vi.fn();
-                this.registerService = vi.fn();
-                this.bootstrap = vi.fn().mockResolvedValue(undefined);
-                this.getServices = vi.fn().mockReturnValue(new Map());
-            }
-        }
-    };
-});
-describe('Runtime', () => {
-    it('should initialize successfully', () => {
-        const runtime = new Runtime();
-        expect(runtime).toBeDefined();
-        // Should create a kernel
-        expect(runtime.getKernel()).toBeDefined();
-    });
-    it('should register api registry plugin by default', () => {
-        const runtime = new Runtime();
-        const kernel = runtime.getKernel();
-        // Check if use was called (at least once for api registry)
-        expect(kernel.use).toHaveBeenCalled();
-    });
-    it('should register external http server if provided', () => {
-        const mockServer = {
-            listen: vi.fn(),
-            close: vi.fn(),
-            get: vi.fn(),
-            post: vi.fn(),
-            put: vi.fn(),
-            delete: vi.fn(),
-            patch: vi.fn(),
-            use: vi.fn(),
-        };
-        const runtime = new Runtime({ server: mockServer });
-        const kernel = runtime.getKernel();
-        expect(kernel.registerService).toHaveBeenCalledWith('http.server', mockServer);
-    });
-    it('should delegate use() to kernel', () => {
-        const runtime = new Runtime();
-        const mockPlugin = { name: 'test', init: vi.fn() };
-        runtime.use(mockPlugin);
-        expect(runtime.getKernel().use).toHaveBeenCalledWith(mockPlugin);
-    });
-    it('should delegate start() to kernel.bootstrap()', async () => {
-        const runtime = new Runtime();
-        await runtime.start();
-        expect(runtime.getKernel().bootstrap).toHaveBeenCalled();
-    });
-});