@kanian77/choux 0.1.2 → 0.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kanian77/choux",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A simple plugin framework for TypeScript.",
   "author": {
     "name": "Patrick Assoa Adou",
@@ -28,12 +28,14 @@
     "prepublishOnly": "bun run clean && bun run build"
   },
   "devDependencies": {
-    "@types/bun": "latest"
+    "@types/bun": "latest",
+    "typescript": "~5.7.2"
   },
   "peerDependencies": {
     "typescript": "^5"
   },
   "dependencies": {
-    "@kanian77/simple-di": "^0.1.2"
+    "@kanian77/simple-di": "^0.1.2",
+    "reflect-metadata": "^0.2.2"
   }
 }

package/src/example-plugin/module.d.ts

@@ -0,0 +1,20 @@
+import { Plugin } from '../core/Plugin';
+export default class ExamplePlugin extends Plugin {
+    readonly metadata: {
+        name: string;
+        version: string;
+        description: string;
+        dependencies: never[];
+    };
+    constructor();
+    onLoad(): Promise<void>;
+    onInit(): Promise<void>;
+    onDestroy(): Promise<void>;
+    protected registerCustomHooks(): void;
+    private handleExampleEvent;
+    private onApplicationStart;
+    private onBeforePluginLoad;
+    private registerAdditionalHooks;
+    private handleDynamicHook;
+}
+//# sourceMappingURL=module.d.ts.map

package/src/example-plugin/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["module.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAI/C,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,MAAM;IAC/C,QAAQ,CAAC,QAAQ;;;;;MAKf;;IAgBa,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAOvB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;cAItB,mBAAmB,IAAI,IAAI;YAQhC,kBAAkB;YAKlB,kBAAkB;YAKlB,kBAAkB;IAKhC,OAAO,CAAC,uBAAuB;YAOjB,iBAAiB;CAGhC"}

package/src/example-plugin/module.js

@@ -0,0 +1,90 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { ExampleService } from './services';
+import { EXAMPLE_SERVICE_TOKEN } from './tokens';
+import { Hook } from '../../src/decorators/hookDecorator';
+import { inject } from '@kanian77/simple-di';
+import { Plugin } from '../../src/core/Plugin';
+import { HOOK_REGISTRY_TOKEN } from '../../src/lib/types/tokens';
+export default class ExamplePlugin extends Plugin {
+    constructor() {
+        // Call parent Module constructor with plugin configuration
+        super({
+            providers: [
+                {
+                    provide: EXAMPLE_SERVICE_TOKEN,
+                    useClass: ExampleService,
+                },
+            ],
+            // Can also import other modules if needed
+            // imports: [SomeOtherModule],
+        });
+        this.metadata = {
+            name: 'example-plugin',
+            version: '1.0.0',
+            description: 'An example plugin',
+            dependencies: [], // other plugin names this depends on
+        };
+    }
+    async onLoad() {
+        console.log('ExamplePlugin loading...');
+    }
+    async onInit() {
+        console.log('ExamplePlugin initialized!');
+        // Additional manual hook registration if needed
+        this.registerAdditionalHooks();
+    }
+    async onDestroy() {
+        console.log('ExamplePlugin destroyed!');
+    }
+    registerCustomHooks() {
+        // Define custom hooks that this plugin provides
+        // Other plugins can listen to these hooks
+        console.log('Registering custom hooks for ExamplePlugin');
+    }
+    // These methods will be automatically registered as hook handlers
+    async handleExampleEvent(data) {
+        console.log('Handling example event via decorator:', data);
+    }
+    async onApplicationStart() {
+        console.log('ExamplePlugin responding to application start via decorator');
+    }
+    async onBeforePluginLoad(pluginPath) {
+        console.log('Another plugin is about to load:', pluginPath);
+    }
+    // Manual hook registration for dynamic scenarios
+    registerAdditionalHooks() {
+        const hookRegistry = inject(HOOK_REGISTRY_TOKEN);
+        // Register additional hooks manually if needed
+        hookRegistry.register('dynamic:custom-hook', this.handleDynamicHook.bind(this));
+    }
+    async handleDynamicHook(data) {
+        console.log('Handling dynamic hook:', data);
+    }
+}
+__decorate([
+    Hook('custom:example-event'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ExamplePlugin.prototype, "handleExampleEvent", null);
+__decorate([
+    Hook('core:application-start'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], ExamplePlugin.prototype, "onApplicationStart", null);
+__decorate([
+    Hook('core:before-plugin-load'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], ExamplePlugin.prototype, "onBeforePluginLoad", null);
+//# sourceMappingURL=module.js.map

package/src/example-plugin/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["module.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,MAAM;IAQ/C;QACE,2DAA2D;QAC3D,KAAK,CAAC;YACJ,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,qBAAqB;oBAC9B,QAAQ,EAAE,cAAc;iBACzB;aACF;YACD,0CAA0C;YAC1C,8BAA8B;SAC/B,CAAC,CAAC;QAlBI,aAAQ,GAAG;YAClB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,mBAAmB;YAChC,YAAY,EAAE,EAAE,EAAE,qCAAqC;SACxD,CAAC;IAcF,CAAC;IAEQ,KAAK,CAAC,MAAM;QACnB,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC1C,CAAC;IAEQ,KAAK,CAAC,MAAM;QACnB,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAE1C,gDAAgD;QAChD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEQ,KAAK,CAAC,SAAS;QACtB,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC1C,CAAC;IAEkB,mBAAmB;QACpC,gDAAgD;QAChD,0CAA0C;QAC1C,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;IAC5D,CAAC;IAED,kEAAkE;IAEpD,AAAN,KAAK,CAAC,kBAAkB,CAAC,IAAS;QACxC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAGa,AAAN,KAAK,CAAC,kBAAkB;QAC9B,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;IAC7E,CAAC;IAGa,AAAN,KAAK,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,UAAU,CAAC,CAAC;IAC9D,CAAC;IAED,iDAAiD;IACzC,uBAAuB;QAC7B,MAAM,YAAY,GAAG,MAAM,CAAgB,mBAAmB,CAAC,CAAC;QAEhE,+CAA+C;QAC/C,YAAY,CAAC,QAAQ,CAAC,qBAAqB,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAClF,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,IAAS;QACvC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;CACF;AAzBe;IADb,IAAI,CAAC,sBAAsB,CAAC;;;;uDAG5B;AAGa;IADb,IAAI,CAAC,wBAAwB,CAAC;;;;uDAG9B;AAGa;IADb,IAAI,CAAC,yBAAyB,CAAC;;;;uDAG/B"}

package/{plugins → src}/example-plugin/module.ts

@@ -1,11 +1,11 @@
 import { Module } from '@kanian77/simple-di';
 import { ExampleService } from './services';
 import { EXAMPLE_SERVICE_TOKEN } from './tokens';
-import { Hook } from '../../src/decorators/hookDecorator';
+import { Hook } from '../decorators/hookDecorator';
 import { inject } from '@kanian77/simple-di';
-import { Plugin } from '../../src/core/Plugin';
+import { Plugin } from '../core/Plugin';
 import type { IHookRegistry } from '../../src/lib/types';
-import { HOOK_REGISTRY_TOKEN } from '../../src/lib/types/tokens';
+import { HOOK_REGISTRY_TOKEN } from '../lib/types/tokens';
 
 export default class ExamplePlugin extends Plugin {
   readonly metadata = {

package/src/example-plugin/services.d.ts

@@ -0,0 +1,9 @@
+export interface IExampleService {
+    doSomething(): void;
+}
+export declare class ExampleService implements IExampleService {
+    private hookRegistry;
+    constructor();
+    doSomething(): void;
+}
+//# sourceMappingURL=services.d.ts.map

package/src/example-plugin/services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["services.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,eAAe;IAC9B,WAAW,IAAI,IAAI,CAAC;CACrB;AAED,qBACa,cAAe,YAAW,eAAe;IACpD,OAAO,CAAC,YAAY,CAAgB;;IAKpC,WAAW,IAAI,IAAI;CAKpB"}

package/src/example-plugin/services.js

@@ -0,0 +1,28 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Service, inject } from '@kanian77/simple-di';
+import { EXAMPLE_SERVICE_TOKEN } from './tokens';
+import { HOOK_REGISTRY_TOKEN } from '../../src/lib/types/tokens';
+let ExampleService = class ExampleService {
+    constructor() {
+        this.hookRegistry = inject(HOOK_REGISTRY_TOKEN);
+    }
+    doSomething() {
+        console.log('ExampleService doing something...');
+        // Can trigger custom hooks
+        this.hookRegistry.trigger('example:something-done', { data: 'example' });
+    }
+};
+ExampleService = __decorate([
+    Service({ token: EXAMPLE_SERVICE_TOKEN }),
+    __metadata("design:paramtypes", [])
+], ExampleService);
+export { ExampleService };
+//# sourceMappingURL=services.js.map

package/src/example-plugin/services.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.js","sourceRoot":"","sources":["services.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAU,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAQ1D,IAAM,cAAc,GAApB,MAAM,cAAc;IAEzB;QACE,IAAI,CAAC,YAAY,GAAG,MAAM,CAAgB,mBAAmB,CAAC,CAAC;IACjE,CAAC;IAED,WAAW;QACT,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;QACjD,2BAA2B;QAC3B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF,CAAA;AAXY,cAAc;IAD1B,OAAO,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,CAAC;;GAC7B,cAAc,CAW1B"}

package/{plugins → src}/example-plugin/services.ts

@@ -1,6 +1,6 @@
 import { Service, Inject, inject } from '@kanian77/simple-di';
 import { EXAMPLE_SERVICE_TOKEN } from './tokens';
-import { HOOK_REGISTRY_TOKEN } from '../../src/lib/types/tokens';
+import { HOOK_REGISTRY_TOKEN } from '../lib/types/tokens';
 import type { IHookRegistry } from '../../src/lib/types';
 
 export interface IExampleService {

package/src/example-plugin/tokens.d.ts

@@ -0,0 +1,2 @@
+export declare const EXAMPLE_SERVICE_TOKEN: unique symbol;
+//# sourceMappingURL=tokens.d.ts.map

package/src/example-plugin/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["tokens.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,eAA2B,CAAC"}

package/src/example-plugin/tokens.js

@@ -0,0 +1,2 @@
+export const EXAMPLE_SERVICE_TOKEN = Symbol('ExampleService');
+//# sourceMappingURL=tokens.js.map

package/src/example-plugin/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["tokens.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC"}

package/src/lib/test-related/plugins/plugin-a/module.ts

@@ -1,5 +1,5 @@
 import { inject } from '@kanian77/simple-di';
-import { ExampleService } from '../../../../../plugins/example-plugin/services';
+import { ExampleService } from '../../../../example-plugin/services';
 import { Plugin } from '../../../../core';
 import { Hook } from '../../../../decorators';
 import type { IHookRegistry } from '../../../types';

package/src/lib/test-related/plugins/plugin-b/module.ts

@@ -1,5 +1,5 @@
 import { inject } from '@kanian77/simple-di';
-import { ExampleService } from '../../../../../plugins/example-plugin/services';
+import { ExampleService } from '../../../../example-plugin/services';
 import { Plugin } from '../../../../core';
 import { Hook } from '../../../../decorators';
 import type { IHookRegistry } from '../../../types';

package/tsconfig.json

@@ -1,35 +1,22 @@
 {
   "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-    "declaration": true,
-    "declarationMap": true,
-    "emitDeclarationOnly": false,
     "outDir": "dist",
-    // Bundler mode
+    "rootDir": "src",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "target": "ESNext",
+    "module": "preserve",
     "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
 
-    // Best practices
+    "esModuleInterop": true,
     "strict": true,
     "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false,
-
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "emitDeclarationOnly": false,
+    "declaration": true,
+    "declarationMap": true, // Optional: creates sourcemap for .d.ts files
+    "sourceMap": true // Optional: creates sourcemaps for .js files
+  },
+  "include": ["src/**/*"]
 }