bun_plugins 1.2.5 → 1.2.6

package/README.md

@@ -163,7 +163,7 @@ Plugins can share APIs with each other safely:
 // Plugin A: Exposes an API
 export class ProviderPlugin implements IPlugin {
   name = "db-provider";
-  getApi() {
+  getSharedApi() {
     return {
       query: (q: string) => `Result for ${q}`,
     };
@@ -174,7 +174,7 @@ export class ProviderPlugin implements IPlugin {
 export class ConsumerPlugin implements IPlugin {
   name = "app-logic";
   async onLoad(context: PluginContext) {
-    const db = await context.getPlugin("db-provider");
+    const db = context.getPlugin("db-provider");
     const result = db.query("SELECT *");
   }
 }
@@ -182,130 +182,6 @@ export class ConsumerPlugin implements IPlugin {
 
 ---
 
-## 🎯 Type Safety & Autocompletion
-
-The plugin system provides **full type safety and autocompletion** for inter-plugin communication using declaration merging.
-
-### 📚 Complete Guide
-
-For detailed documentation on the type system, see [`docs/types-guide.md`](docs/types-guide.md).
-
-### 🚀 Quick Start
-
-#### Step 1: Create a types file
-
-Create a `.d.ts` file in your project (e.g., `plugins/types.d.ts`):
-
-```typescript
-import type { BasePluginApi } from "bun_plugins/src/types/plugin-registry-base";
-
-// Define the API interface for your plugin
-export interface MathPluginApi extends BasePluginApi {
-  add(a: number, b: number): number;
-  multiply(a: number, b: number): number;
-}
-
-// Extend the PluginFactory with your plugin
-declare module "bun_plugins" {
-  export interface PluginFactory {
-    "math-plugin": {
-      name: "math-plugin";
-      version: "1.0.0";
-      class: any;
-      api: MathPluginApi;
-    };
-  }
-}
-```
-
-#### Step 2: Register the API in your plugin
-
-```typescript
-import { Plugin, PluginContext } from "bun_plugins";
-
-export class MathPlugin extends Plugin {
-  name = "math-plugin";
-  version = "1.0.0";
-
-  override onLoad(context: PluginContext) {
-    // Register the API for other plugins to use
-    context.registerApi({
-      add: this.add.bind(this),
-      multiply: this.multiply.bind(this)
-    });
-  }
-
-  add(a: number, b: number): number {
-    return a + b;
-  }
-  
-  multiply(a: number, b: number): number {
-    return a * b;
-  }
-}
-```
-
-#### Step 3: Use with full autocompletion
-
-```typescript
-import { definePlugin } from "bun_plugins";
-
-export default definePlugin({
-  name: "my-app",
-  version: "1.0.0",
-
-  async onLoad(context) {
-    // ✅ Full autocompletion and type safety!
-    const mathPlugin = await context.getPlugin('math-plugin');
-    
-    if (mathPlugin) {
-      const result = mathPlugin.add(1, 2); // ✅ Autocompletion works
-      context.log.info(`Result: ${result}`);
-      
-      // TypeScript will show errors for non-existent methods
-      // mathPlugin.nonExistentMethod(); // ❌ Error!
-    }
-  }
-});
-```
-
-### ✨ Benefits
-
-- 🎯 **Full Autocompletion**: Your IDE shows all available methods
-- 🔒 **Type Safety**: TypeScript catches errors at compile time
-- 📖 **Self-Documenting**: Interfaces serve as API documentation
-- 🔄 **Refactor-Friendly**: Safe method renaming and refactoring
-- 🌐 **Works with External Plugins**: Extend types for npm packages too
-
-### 📖 Examples
-
-- [`plugins/types.d.ts`](plugins/types.d.ts) - Complete example for this project
-- [`plugins/TypedExamplePlugin.ts`](plugins/TypedExamplePlugin.ts) - Plugin using typed access
-- [`examples/types-extension-example.d.ts`](examples/types-extension-example.d.ts) - Standalone example
-
-### 🔧 TypeScript Configuration
-
-Ensure your `tsconfig.json` includes the types file:
-
-```json
-{
-  "include": [
-    "src/**/*",
-    "plugins/**/*",
-    "**/*.d.ts"
-  ]
-}
-```
-
-### 💡 Tips
-
-1. **Match names exactly**: The plugin name in `PluginFactory` must match `plugin.name`
-2. **Register APIs**: Always use `context.registerApi()` to expose your plugin's API
-3. **Extend BasePluginApi**: Your API interfaces should extend `BasePluginApi` for consistency
-4. **External plugins**: You can extend types for third-party plugins the same way
-
----
-
-##  License
+## 📜 License
 
 MIT © [memelser](https://github.com/nglmercer)

package/dist/{src/PluginManager.d.ts → PluginManager.d.ts}

@@ -1,11 +1,10 @@
 import { EventEmitter } from "node:events";
-import { type IPlugin, type AppEvents, type BunWorkerOptions as WorkerOptions, type OnResolveArgs, type OnLoadArgs, type IPluginManager } from "./types";
+import { type IPlugin, type AppEvents, type BunWorkerOptions as WorkerOptions, type OnResolveArgs, type OnLoadArgs } from "./types";
 import { HooksManager } from "./managers/HooksManager";
-export declare class PluginManager extends EventEmitter implements IPluginManager {
+export declare class PluginManager extends EventEmitter {
     private plugins;
     private availablePlugins;
-    private configs;
-    private pluginApis;
+    private pluginFiles;
     private resources;
     private dependencyManager;
     hooksManager: HooksManager;
@@ -14,6 +13,8 @@ export declare class PluginManager extends EventEmitter implements IPluginManage
     private pluginLoadTimeout;
     private workerFactory;
     private workerRunnerPath;
+    private hotReloadWatcher;
+    private hotReloadTimer;
     constructor(storageRoot?: string, options?: {
         pluginLoadTimeout?: number;
         workerFactory?: (url: string | URL, options?: WorkerOptions) => Worker;
@@ -24,20 +25,11 @@ export declare class PluginManager extends EventEmitter implements IPluginManage
     registerIsolated(pluginPath: string, pluginName: string): Promise<void>;
     unregister(pluginName: string): Promise<void>;
     getPlugin(name: string): IPlugin | undefined;
-    getApi<T = any>(name: string): T | undefined;
-    getPluginConfig(name: string): Record<string, any>;
     listPlugins(): string[];
-    registerApi(pluginName: string, api: any): void;
-    getPluginApi(pluginName: string): any | undefined;
-    private unregisterApi;
     emit<K extends keyof AppEvents>(eventName: K, payload: AppEvents[K]): boolean;
     emit(eventName: string | symbol, ...args: any[]): boolean;
-    on<K extends keyof AppEvents>(eventName: K & string, listener: (payload: AppEvents[K]) => void): this;
+    on<K extends keyof AppEvents>(eventName: K, listener: (payload: AppEvents[K]) => void): this;
     on(eventName: string | symbol, listener: (...args: any[]) => void): this;
-    once<K extends keyof AppEvents>(eventName: K & string, listener: (payload: AppEvents[K]) => void): this;
-    once(eventName: string | symbol, listener: (...args: any[]) => void): this;
-    off<K extends keyof AppEvents>(eventName: K & string, listener: (payload: AppEvents[K]) => void): this;
-    off(eventName: string | symbol, listener: (...args: any[]) => void): this;
     loadPluginsFromDirectory(directoryPath?: string): Promise<void>;
     disablePlugin(name: string): Promise<void>;
     enablePlugin(name: string): Promise<void>;
@@ -51,12 +43,11 @@ export declare class PluginManager extends EventEmitter implements IPluginManage
         contents?: string;
         loader?: string;
     } | null>;
-    use(plugin: IPlugin): Promise<void>;
-    plugin(plugin: IPlugin): Promise<void>;
-    remove(pluginName: string): Promise<void>;
     toBunPlugin(): Bun.BunPlugin;
-    private hotReloadTimer;
     enableHotReload(pluginDir: string): void;
+    private scanAndTrackPlugins;
+    private handleFileChange;
+    disableHotReload(): void;
     getMetrics(): {
         totalPlugins: number;
         activePlugins: string[];
@@ -67,12 +58,10 @@ export declare class PluginManager extends EventEmitter implements IPluginManage
             pluginCount: number;
         };
         hooks: {
-            onStart: number;
             onResolve: number;
             onLoad: number;
         };
     };
     getPluginStatus(): Record<string, any>;
-    private ensureDependenciesInstalled;
 }
 //# sourceMappingURL=PluginManager.d.ts.map

package/dist/PluginManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginManager.d.ts","sourceRoot":"","sources":["../src/PluginManager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAI3C,OAAO,EACH,KAAK,OAAO,EAEZ,KAAK,SAAS,EACd,KAAK,gBAAgB,IAAI,aAAa,EACtC,KAAK,aAAa,EAClB,KAAK,UAAU,EAKlB,MAAM,SAAS,CAAC;AAMjB,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAKvD,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,OAAO,CAAmC;IAClD,OAAO,CAAC,gBAAgB,CAAmC;IAC3D,OAAO,CAAC,WAAW,CAAkC;IAGrD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,iBAAiB,CAAoB;IACtC,YAAY,EAAE,YAAY,CAAC;IAElC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAW;IAC9B,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,aAAa,CAAyD;IAC9E,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,gBAAgB,CAAyC;IACjE,OAAO,CAAC,cAAc,CAA+B;gBACzC,WAAW,GAAE,MAAuC,EAAE,OAAO,CAAC,EAAE;QAC1E,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;QACvE,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAC1B;IAwBD,gBAAgB,UAhCa,MAAM,GAAG,GAAG,YAAY,aAAa,KAAK,MAAM;IAoCvE,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAkFxC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6MvE,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBnD,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI5C,WAAW,IAAI,MAAM,EAAE;IAId,IAAI,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO;IAC7E,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAKzD,EAAE,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IAC5F,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI;IAK3E,wBAAwB,CAAC,aAAa,GAAE,MAAuC,GAAG,OAAO,CAAC,IAAI,CAAC;IA4F/F,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBzC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAcjC,iBAAiB;IA2BzB,YAAY,CAAC,IAAI,EAAE,aAAa;;;;IAIhC,SAAS,CAAC,IAAI,EAAE,UAAU;;;;IAIhC,WAAW;IAIX,eAAe,CAAC,SAAS,EAAE,MAAM;YAyBnB,mBAAmB;YA2BnB,gBAAgB;IA0F9B,gBAAgB,IAAI,IAAI;IAQxB,UAAU;;;;;;;;;;;;;;IAYV,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAgBvC"}