@object-ui/core 0.3.0 → 0.5.0

package/src/registry/PluginSystem.ts

@@ -0,0 +1,161 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type { Registry } from './Registry.js';
+import type { PluginScope, PluginScopeConfig } from '@object-ui/types';
+import { PluginScopeImpl } from './PluginScopeImpl.js';
+
+export interface PluginDefinition {
+  name: string;
+  version: string;
+  dependencies?: string[];  // Dependencies on other plugins
+  peerDependencies?: string[];  // Peer dependencies
+  register: (registry: Registry | PluginScope) => void;  // Support both legacy and scoped registration
+  onLoad?: () => void | Promise<void>;  // Lifecycle hook: called after registration
+  onUnload?: () => void | Promise<void>;  // Lifecycle hook: called before unload
+  scopeConfig?: PluginScopeConfig;  // Optional scope configuration
+}
+
+export class PluginSystem {
+  private plugins = new Map<string, PluginDefinition>();
+  private loaded = new Set<string>();
+  private scopes = new Map<string, PluginScopeImpl>();
+
+  /**
+   * Load a plugin into the system with optional scope isolation
+   * @param plugin The plugin definition to load
+   * @param registry The component registry to use for registration
+   * @param useScope Whether to use scoped loading (default: true for better isolation)
+   * @throws Error if dependencies are missing
+   */
+  async loadPlugin(plugin: PluginDefinition, registry: Registry, useScope: boolean = true): Promise<void> {
+    // Check if already loaded
+    if (this.loaded.has(plugin.name)) {
+      console.warn(`Plugin "${plugin.name}" is already loaded. Skipping.`);
+      return;
+    }
+
+    // Check dependencies
+    for (const dep of plugin.dependencies || []) {
+      if (!this.loaded.has(dep)) {
+        throw new Error(`Missing dependency: ${dep} required by ${plugin.name}`);
+      }
+    }
+
+    try {
+      if (useScope) {
+        // Create scoped environment for plugin
+        const scope = new PluginScopeImpl(
+          plugin.name,
+          plugin.version,
+          registry,
+          plugin.scopeConfig
+        );
+        
+        // Store scope for cleanup
+        this.scopes.set(plugin.name, scope);
+        
+        // Execute registration with scope
+        plugin.register(scope);
+      } else {
+        // Legacy mode: direct registry access
+        plugin.register(registry);
+      }
+
+      // Store plugin definition
+      this.plugins.set(plugin.name, plugin);
+
+      // Execute lifecycle hook
+      await plugin.onLoad?.();
+
+      // Mark as loaded
+      this.loaded.add(plugin.name);
+    } catch (error) {
+      // Clean up on failure
+      this.plugins.delete(plugin.name);
+      this.scopes.delete(plugin.name);
+      throw error;
+    }
+  }
+
+  /**
+   * Unload a plugin from the system
+   * @param name The name of the plugin to unload
+   * @throws Error if other plugins depend on this plugin
+   */
+  async unloadPlugin(name: string): Promise<void> {
+    const plugin = this.plugins.get(name);
+    if (!plugin) {
+      throw new Error(`Plugin "${name}" is not loaded`);
+    }
+
+    // Check if any loaded plugins depend on this one
+    for (const [pluginName, pluginDef] of this.plugins.entries()) {
+      if (this.loaded.has(pluginName) && pluginDef.dependencies?.includes(name)) {
+        throw new Error(`Cannot unload plugin "${name}" - plugin "${pluginName}" depends on it`);
+      }
+    }
+
+    // Execute lifecycle hook
+    await plugin.onUnload?.();
+
+    // Clean up scope if exists
+    const scope = this.scopes.get(name);
+    if (scope) {
+      scope.cleanup();
+      this.scopes.delete(name);
+    }
+
+    // Remove from loaded set
+    this.loaded.delete(name);
+    this.plugins.delete(name);
+  }
+
+  /**
+   * Get the scope for a loaded plugin
+   * @param name The name of the plugin
+   * @returns The plugin scope or undefined
+   */
+  getScope(name: string): PluginScope | undefined {
+    return this.scopes.get(name);
+  }
+
+  /**
+   * Check if a plugin is loaded
+   * @param name The name of the plugin
+   * @returns true if the plugin is loaded
+   */
+  isLoaded(name: string): boolean {
+    return this.loaded.has(name);
+  }
+
+  /**
+   * Get a loaded plugin definition
+   * @param name The name of the plugin
+   * @returns The plugin definition or undefined
+   */
+  getPlugin(name: string): PluginDefinition | undefined {
+    return this.plugins.get(name);
+  }
+
+  /**
+   * Get all loaded plugin names
+   * @returns Array of loaded plugin names
+   */
+  getLoadedPlugins(): string[] {
+    return Array.from(this.loaded);
+  }
+
+  /**
+   * Get all plugin definitions
+   * @returns Array of all plugin definitions
+   */
+  getAllPlugins(): PluginDefinition[] {
+    return Array.from(this.plugins.values());
+  }
+}

package/src/registry/Registry.ts

@@ -1,4 +1,12 @@
-import type { SchemaNode } from '../types';
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type { SchemaNode } from '../types/index.js';
 
 export type ComponentRenderer<T = any> = T;
 
@@ -18,6 +26,7 @@ export type ComponentMeta = {
   label?: string; // Display name in designer
   icon?: string; // Icon name or svg string
   category?: string; // Grouping category
+  namespace?: string; // Component namespace (e.g., 'ui', 'plugin-grid', 'field')
   inputs?: ComponentInput[];
   defaultProps?: Record<string, any>; // Default props when dropped
   defaultChildren?: SchemaNode[]; // Default children when dropped
@@ -42,36 +51,152 @@ export type ComponentConfig<T = any> = ComponentMeta & {
 export class Registry<T = any> {
   private components = new Map<string, ComponentConfig<T>>();
 
+  /**
+   * Register a component with optional namespace support.
+   * If namespace is provided in meta, the component will be registered as "namespace:type".
+   * 
+   * @param type - Component type identifier
+   * @param component - Component renderer
+   * @param meta - Component metadata (including optional namespace)
+   * 
+   * @example
+   * // Register with namespace
+   * registry.register('button', ButtonComponent, { namespace: 'ui' });
+   * // Accessible as 'ui:button' or 'button' (fallback)
+   * 
+   * @example
+   * // Register without namespace (backward compatible)
+   * registry.register('button', ButtonComponent);
+   * // Accessible as 'button'
+   */
   register(type: string, component: ComponentRenderer<T>, meta?: ComponentMeta) {
-    if (this.components.has(type)) {
-      console.warn(`Component type "${type}" is already registered. Overwriting.`);
+    const fullType = meta?.namespace ? `${meta.namespace}:${type}` : type;
+    
+    // Warn if registering without namespace (deprecated pattern)
+    if (!meta?.namespace) {
+      console.warn(
+        `Registering component "${type}" without a namespace is deprecated. ` +
+        `Please provide a namespace in the meta parameter.`
+      );
+    }
+    
+    if (this.components.has(fullType)) {
+      // console.warn(`Component type "${fullType}" is already registered. Overwriting.`);
     }
-    this.components.set(type, {
-      type,
+    
+    this.components.set(fullType, {
+      type: fullType,
       component,
       ...meta
     });
+    
+    // Also register without namespace for backward compatibility
+    // This allows "button" to work even when registered as "ui:button"
+    // Note: If multiple namespaced components share the same short name,
+    // the last registration wins for non-namespaced lookups
+    if (meta?.namespace) {
+      this.components.set(type, {
+        type: fullType, // Keep reference to namespaced type
+        component,
+        ...meta
+      });
+    }
   }
 
-  get(type: string): ComponentRenderer<T> | undefined {
+  /**
+   * Get a component by type. Supports both namespaced and non-namespaced lookups.
+   * 
+   * @param type - Component type (e.g., 'button' or 'ui:button')
+   * @param namespace - Optional namespace for lookup priority
+   * @returns Component renderer or undefined
+   * 
+   * @example
+   * // Direct lookup
+   * registry.get('ui:button') // Gets ui:button
+   * 
+   * @example
+   * // Fallback lookup
+   * registry.get('button') // Gets first registered button
+   * 
+   * @example
+   * // Namespaced lookup with priority
+   * registry.get('button', 'ui') // Tries 'ui:button' first, then 'button'
+   */
+  get(type: string, namespace?: string): ComponentRenderer<T> | undefined {
+    // If namespace is explicitly provided, ONLY look in that namespace (no fallback)
+    if (namespace) {
+      const namespacedType = `${namespace}:${type}`;
+      return this.components.get(namespacedType)?.component;
+    }
+    
+    // When no namespace provided, use backward compatibility lookup
     return this.components.get(type)?.component;
   }
 
-  getConfig(type: string): ComponentConfig<T> | undefined {
+  /**
+   * Get component configuration by type with namespace support.
+   * 
+   * @param type - Component type (e.g., 'button' or 'ui:button')
+   * @param namespace - Optional namespace for lookup priority
+   * @returns Component configuration or undefined
+   */
+  getConfig(type: string, namespace?: string): ComponentConfig<T> | undefined {
+    // If namespace is explicitly provided, ONLY look in that namespace (no fallback)
+    if (namespace) {
+      const namespacedType = `${namespace}:${type}`;
+      return this.components.get(namespacedType);
+    }
+    
+    // When no namespace provided, use backward compatibility lookup
     return this.components.get(type);
   }
 
-  has(type: string): boolean {
+  /**
+   * Check if a component type is registered.
+   * 
+   * @param type - Component type (e.g., 'button' or 'ui:button')
+   * @param namespace - Optional namespace for lookup
+   * @returns True if component is registered
+   */
+  has(type: string, namespace?: string): boolean {
+    // If namespace is explicitly provided, ONLY look in that namespace (no fallback)
+    if (namespace) {
+      const namespacedType = `${namespace}:${type}`;
+      return this.components.has(namespacedType);
+    }
+    // When no namespace provided, use backward compatibility lookup
     return this.components.has(type);
   }
   
+  /**
+   * Get all registered component types.
+   * 
+   * @returns Array of all component type identifiers
+   */
   getAllTypes(): string[] {
     return Array.from(this.components.keys());
   }
 
+  /**
+   * Get all registered component configurations.
+   * 
+   * @returns Array of all component configurations
+   */
   getAllConfigs(): ComponentConfig<T>[] {
     return Array.from(this.components.values());
   }
+  
+  /**
+   * Get all components in a specific namespace.
+   * 
+   * @param namespace - Namespace to filter by
+   * @returns Array of component configurations in the namespace
+   */
+  getNamespaceComponents(namespace: string): ComponentConfig<T>[] {
+    return Array.from(this.components.values()).filter(
+      config => config.namespace === namespace
+    );
+  }
 }
 
 export const ComponentRegistry = new Registry<any>();

package/src/registry/__tests__/PluginSystem.test.ts

@@ -0,0 +1,226 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { PluginSystem, type PluginDefinition } from '../PluginSystem';
+import { Registry } from '../Registry';
+
+describe('PluginSystem', () => {
+  let pluginSystem: PluginSystem;
+  let registry: Registry;
+
+  beforeEach(() => {
+    pluginSystem = new PluginSystem();
+    registry = new Registry();
+  });
+
+  it('should load a simple plugin', async () => {
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: (reg) => {
+        reg.register('test', () => 'test');
+      }
+    };
+
+    // Use legacy mode (useScope: false) to test direct registry access
+    await pluginSystem.loadPlugin(plugin, registry, false);
+    
+    expect(pluginSystem.isLoaded('test-plugin')).toBe(true);
+    expect(pluginSystem.getLoadedPlugins()).toContain('test-plugin');
+    expect(registry.has('test')).toBe(true);
+  });
+
+  it('should execute onLoad lifecycle hook', async () => {
+    const onLoad = vi.fn();
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: () => {},
+      onLoad
+    };
+
+    await pluginSystem.loadPlugin(plugin, registry);
+    
+    expect(onLoad).toHaveBeenCalledTimes(1);
+  });
+
+  it('should execute async onLoad lifecycle hook', async () => {
+    const onLoad = vi.fn().mockResolvedValue(undefined);
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: () => {},
+      onLoad
+    };
+
+    await pluginSystem.loadPlugin(plugin, registry);
+    
+    expect(onLoad).toHaveBeenCalledTimes(1);
+  });
+
+  it('should not load plugin twice', async () => {
+    const onLoad = vi.fn();
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: () => {},
+      onLoad
+    };
+
+    await pluginSystem.loadPlugin(plugin, registry);
+    await pluginSystem.loadPlugin(plugin, registry);
+    
+    expect(onLoad).toHaveBeenCalledTimes(1);
+  });
+
+  it('should check dependencies before loading', async () => {
+    const plugin: PluginDefinition = {
+      name: 'dependent-plugin',
+      version: '1.0.0',
+      dependencies: ['base-plugin'],
+      register: () => {}
+    };
+
+    await expect(pluginSystem.loadPlugin(plugin, registry)).rejects.toThrow(
+      'Missing dependency: base-plugin required by dependent-plugin'
+    );
+  });
+
+  it('should load plugins with dependencies in correct order', async () => {
+    const basePlugin: PluginDefinition = {
+      name: 'base-plugin',
+      version: '1.0.0',
+      register: () => {}
+    };
+
+    const dependentPlugin: PluginDefinition = {
+      name: 'dependent-plugin',
+      version: '1.0.0',
+      dependencies: ['base-plugin'],
+      register: () => {}
+    };
+
+    await pluginSystem.loadPlugin(basePlugin, registry);
+    await pluginSystem.loadPlugin(dependentPlugin, registry);
+    
+    expect(pluginSystem.isLoaded('base-plugin')).toBe(true);
+    expect(pluginSystem.isLoaded('dependent-plugin')).toBe(true);
+  });
+
+  it('should unload a plugin', async () => {
+    const onUnload = vi.fn();
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: () => {},
+      onUnload
+    };
+
+    await pluginSystem.loadPlugin(plugin, registry);
+    expect(pluginSystem.isLoaded('test-plugin')).toBe(true);
+    
+    await pluginSystem.unloadPlugin('test-plugin');
+    
+    expect(pluginSystem.isLoaded('test-plugin')).toBe(false);
+    expect(onUnload).toHaveBeenCalledTimes(1);
+  });
+
+  it('should prevent unloading plugin with dependents', async () => {
+    const basePlugin: PluginDefinition = {
+      name: 'base-plugin',
+      version: '1.0.0',
+      register: () => {}
+    };
+
+    const dependentPlugin: PluginDefinition = {
+      name: 'dependent-plugin',
+      version: '1.0.0',
+      dependencies: ['base-plugin'],
+      register: () => {}
+    };
+
+    await pluginSystem.loadPlugin(basePlugin, registry);
+    await pluginSystem.loadPlugin(dependentPlugin, registry);
+    
+    await expect(pluginSystem.unloadPlugin('base-plugin')).rejects.toThrow(
+      'Cannot unload plugin "base-plugin" - plugin "dependent-plugin" depends on it'
+    );
+  });
+
+  it('should throw error when unloading non-existent plugin', async () => {
+    await expect(pluginSystem.unloadPlugin('non-existent')).rejects.toThrow(
+      'Plugin "non-existent" is not loaded'
+    );
+  });
+
+  it('should get plugin definition', async () => {
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: () => {}
+    };
+
+    await pluginSystem.loadPlugin(plugin, registry);
+    
+    const retrieved = pluginSystem.getPlugin('test-plugin');
+    expect(retrieved).toBe(plugin);
+  });
+
+  it('should get all plugins', async () => {
+    const plugin1: PluginDefinition = {
+      name: 'plugin-1',
+      version: '1.0.0',
+      register: () => {}
+    };
+
+    const plugin2: PluginDefinition = {
+      name: 'plugin-2',
+      version: '1.0.0',
+      register: () => {}
+    };
+
+    await pluginSystem.loadPlugin(plugin1, registry);
+    await pluginSystem.loadPlugin(plugin2, registry);
+    
+    const allPlugins = pluginSystem.getAllPlugins();
+    expect(allPlugins).toHaveLength(2);
+    expect(allPlugins).toContain(plugin1);
+    expect(allPlugins).toContain(plugin2);
+  });
+
+  it('should call register function with registry', async () => {
+    const registerFn = vi.fn();
+    const plugin: PluginDefinition = {
+      name: 'test-plugin',
+      version: '1.0.0',
+      register: registerFn
+    };
+
+    // Use legacy mode (useScope: false) to verify the raw Registry is passed
+    await pluginSystem.loadPlugin(plugin, registry, false);
+    
+    expect(registerFn).toHaveBeenCalledWith(registry);
+    expect(registerFn).toHaveBeenCalledTimes(1);
+  });
+
+  it('should cleanup on registration failure', async () => {
+    const plugin: PluginDefinition = {
+      name: 'failing-plugin',
+      version: '1.0.0',
+      register: () => {
+        throw new Error('Registration failed');
+      }
+    };
+
+    await expect(pluginSystem.loadPlugin(plugin, registry)).rejects.toThrow('Registration failed');
+    
+    expect(pluginSystem.isLoaded('failing-plugin')).toBe(false);
+    expect(pluginSystem.getPlugin('failing-plugin')).toBeUndefined();
+  });
+});