Spaces:
Sleeping
Sleeping
File size: 5,478 Bytes
525d39f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | /**
* 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;
}
|