Spaces:
Sleeping
Sleeping
Download src/core/plugins/plugin.interfaces.ts from jinksQspider/openWa: direct link, hf CLI and curl.
- Browser
- Download file 5.48 kB
-
https://huggingface.co/spaces/jinksQspider/openWa/resolve/main/src/core/plugins/plugin.interfaces.ts
- Command line
-
hf download hf://spaces/jinksQspider/openWa/src/core/plugins/plugin.interfaces.ts
-
curl -L -o plugin.interfaces.ts https://huggingface.co/spaces/jinksQspider/openWa/resolve/main/src/core/plugins/plugin.interfaces.ts
5.48 kB
| /** | |
| * Plugin System Interfaces | |
| * Defines the contract for OpenWA plugins | |
| */ | |
| import { HookManager, HookEvent, HookHandler } from '../hooks'; | |
| // ============================================================================ | |
| // Plugin Types | |
| // ============================================================================ | |
| export enum PluginType { | |
| ENGINE = 'engine', // WhatsApp engine (whatsapp-web.js, baileys, etc.) | |
| STORAGE = 'storage', // Storage backends (local, S3, GCS, etc.) | |
| QUEUE = 'queue', // Queue systems (Redis, RabbitMQ, etc.) | |
| AUTH = 'auth', // Authentication providers | |
| EXTENSION = 'extension', // General extensions (auto-reply, scheduler, etc.) | |
| } | |
| export enum PluginStatus { | |
| INSTALLED = 'installed', | |
| ENABLED = 'enabled', | |
| DISABLED = 'disabled', | |
| ERROR = 'error', | |
| } | |
| // ============================================================================ | |
| // Plugin Manifest | |
| // ============================================================================ | |
| export interface PluginManifest { | |
| id: string; // Unique identifier (e.g., 'whatsapp-web.js', 'auto-reply') | |
| name: string; // Display name | |
| version: string; // Semver | |
| type: PluginType; | |
| description?: string; | |
| author?: string; | |
| homepage?: string; | |
| repository?: string; | |
| license?: string; | |
| // Entry point | |
| main: string; // Relative path to main file | |
| // Dependencies | |
| dependencies?: Record<string, string>; | |
| peerDependencies?: Record<string, string>; | |
| // Configuration schema (optional, for UI generation) | |
| configSchema?: PluginConfigSchema; | |
| // Hooks this plugin listens to | |
| hooks?: HookEvent[]; | |
| // Features provided by this plugin | |
| provides?: string[]; | |
| // Required features from other plugins | |
| requires?: string[]; | |
| } | |
| export interface PluginConfigSchema { | |
| type: 'object'; | |
| properties: Record< | |
| string, | |
| { | |
| type: 'string' | 'number' | 'boolean' | 'array' | 'object'; | |
| title?: string; | |
| description?: string; | |
| default?: unknown; | |
| enum?: unknown[]; | |
| required?: boolean; | |
| secret?: boolean; // For sensitive values like API keys | |
| } | |
| >; | |
| } | |
| // ============================================================================ | |
| // Plugin Context (passed to plugin on initialization) | |
| // ============================================================================ | |
| export interface PluginContext { | |
| // Plugin info | |
| pluginId: string; | |
| manifest: PluginManifest; | |
| // Configuration | |
| config: Record<string, unknown>; | |
| // Hook system | |
| hookManager: HookManager; | |
| // Logger instance for this plugin | |
| logger: PluginLogger; | |
| // Storage for plugin data | |
| storage: PluginStorage; | |
| // Register a hook handler | |
| registerHook: (event: HookEvent, handler: HookHandler, priority?: number) => void; | |
| // Get service from DI container (limited access) | |
| getService: <T>(token: string) => T | undefined; | |
| } | |
| export interface PluginLogger { | |
| log: (message: string, meta?: Record<string, unknown>) => void; | |
| debug: (message: string, meta?: Record<string, unknown>) => void; | |
| warn: (message: string, meta?: Record<string, unknown>) => void; | |
| error: (message: string, error?: unknown, meta?: Record<string, unknown>) => void; | |
| } | |
| export interface PluginStorage { | |
| get: <T = unknown>(key: string) => Promise<T | null>; | |
| set: <T = unknown>(key: string, value: T) => Promise<void>; | |
| delete: (key: string) => Promise<void>; | |
| list: (prefix?: string) => Promise<string[]>; | |
| } | |
| // ============================================================================ | |
| // Plugin Interface (what plugins must implement) | |
| // ============================================================================ | |
| export interface IPlugin { | |
| // Lifecycle hooks | |
| onLoad?: (context: PluginContext) => Promise<void>; | |
| onEnable?: (context: PluginContext) => Promise<void>; | |
| onDisable?: (context: PluginContext) => Promise<void>; | |
| onUnload?: (context: PluginContext) => Promise<void>; | |
| // Configuration change handler | |
| onConfigChange?: (context: PluginContext, newConfig: Record<string, unknown>) => Promise<void>; | |
| // Health check (for dashboard monitoring) | |
| healthCheck?: () => Promise<{ healthy: boolean; message?: string }>; | |
| } | |
| // ============================================================================ | |
| // Engine Plugin Interface (extends IPlugin for engine-specific methods) | |
| // ============================================================================ | |
| export interface IEnginePlugin extends IPlugin { | |
| type: PluginType.ENGINE; | |
| // Engine factory method | |
| createEngine: (config: Record<string, unknown>) => unknown; | |
| // Get supported features | |
| getFeatures: () => string[]; | |
| } | |
| // ============================================================================ | |
| // Plugin Instance (runtime representation) | |
| // ============================================================================ | |
| export interface PluginInstance { | |
| manifest: PluginManifest; | |
| status: PluginStatus; | |
| config: Record<string, unknown>; | |
| instance: IPlugin | null; | |
| error?: string; | |
| loadedAt?: Date; | |
| enabledAt?: Date; | |
| } | |
| // ============================================================================ | |
| // Plugin Registry Entry (for storage) | |
| // ============================================================================ | |
| export interface PluginRegistryEntry { | |
| id: string; | |
| type: PluginType; | |
| name: string; | |
| version: string; | |
| status: PluginStatus; | |
| config: Record<string, unknown>; | |
| builtIn: boolean; // True for bundled plugins | |
| installedAt: Date; | |
| updatedAt: Date; | |
| } | |