@objectstack/plugin-msw 0.4.2 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @objectstack/plugin-msw
 
+## 0.6.0
+
+### Minor Changes
+
+- b2df5f7: Unified version bump to 0.5.0
+
+  - Standardized all package versions to 0.5.0 across the monorepo
+  - Fixed driver-memory package.json paths for proper module resolution
+  - Ensured all packages are in sync for the 0.5.0 release
+
+### Patch Changes
+
+- Updated dependencies [b2df5f7]
+  - @objectstack/spec@0.6.0
+  - @objectstack/runtime@0.6.0
+  - @objectstack/types@0.6.0
+
 ## 0.4.2
 
 ### Patch Changes

package/dist/msw-plugin.d.ts

@@ -1,4 +1,5 @@
-import { RuntimePlugin, RuntimeContext, ObjectStackRuntimeProtocol } from '@objectstack/runtime';
+import { Plugin, PluginContext } from '@objectstack/runtime';
+import { IObjectStackProtocol } from '@objectstack/spec/api';
 export interface MSWPluginOptions {
     /**
      * Enable MSW in the browser environment
@@ -23,13 +24,10 @@ export interface MSWPluginOptions {
 export declare class ObjectStackServer {
     private static protocol;
     private static logger;
-    static init(protocol: ObjectStackRuntimeProtocol, logger?: (message: string, ...meta: any[]) => void): void;
+    static init(protocol: IObjectStackProtocol, logger?: (message: string, ...meta: any[]) => void): void;
     static findData(object: string, params?: any): Promise<{
         status: number;
-        data: {
-            value: any;
-            count: any;
-        };
+        data: any;
     }>;
     static getData(object: string, id: string): Promise<{
         status: number;
@@ -66,25 +64,46 @@ export declare class ObjectStackServer {
  * ```typescript
  * import { MSWPlugin } from '@objectstack/plugin-msw';
  *
- * const runtime = new ObjectStackRuntime({
- *   plugins: [
- *     new MSWPlugin({
- *       enableBrowser: true,
- *       baseUrl: '/api/v1'
- *     })
- *   ]
- * });
+ * // With ObjectKernel
+ * const kernel = new ObjectKernel();
+ * kernel.use(new MSWPlugin({
+ *   enableBrowser: true,
+ *   baseUrl: '/api/v1'
+ * }));
  * ```
  */
-export declare class MSWPlugin implements RuntimePlugin {
+export declare class MSWPlugin implements Plugin {
     name: string;
+    version: string;
     private options;
     private worker;
     private handlers;
+    private protocol?;
     constructor(options?: MSWPluginOptions);
-    install(ctx: RuntimeContext): void;
-    onStart(ctx: RuntimeContext): Promise<void>;
-    onStop(): Promise<void>;
+    /**
+     * Init phase
+     */
+    init(ctx: PluginContext): Promise<void>;
+    /**
+     * Start phase
+     */
+    start(ctx: PluginContext): Promise<void>;
+    /**
+     * Destroy phase
+     */
+    destroy(): Promise<void>;
+    /**
+     * Setup MSW handlers
+     */
+    private setupHandlers;
+    /**
+     * Start the MSW worker
+     */
+    private startWorker;
+    /**
+     * Stop the MSW worker
+     */
+    private stopWorker;
     /**
      * Get the MSW worker instance for advanced use cases
      */

package/dist/msw-plugin.js

@@ -1,6 +1,6 @@
 import { http, HttpResponse } from 'msw';
 import { setupWorker } from 'msw/browser';
-import { ObjectStackRuntimeProtocol } from '@objectstack/runtime';
+import { ObjectStackProtocolImplementation } from '@objectstack/runtime';
 /**
  * ObjectStack Server Mock - Provides mock database functionality
  */
@@ -120,19 +120,18 @@ ObjectStackServer.logger = null;
  * ```typescript
  * import { MSWPlugin } from '@objectstack/plugin-msw';
  *
- * const runtime = new ObjectStackRuntime({
- *   plugins: [
- *     new MSWPlugin({
- *       enableBrowser: true,
- *       baseUrl: '/api/v1'
- *     })
- *   ]
- * });
+ * // With ObjectKernel
+ * const kernel = new ObjectKernel();
+ * kernel.use(new MSWPlugin({
+ *   enableBrowser: true,
+ *   baseUrl: '/api/v1'
+ * }));
  * ```
  */
 export class MSWPlugin {
     constructor(options = {}) {
-        this.name = 'msw';
+        this.name = 'com.objectstack.plugin.msw';
+        this.version = '1.0.0';
         this.handlers = [];
         this.options = {
             enableBrowser: true,
@@ -141,9 +140,42 @@ export class MSWPlugin {
             ...options
         };
     }
-    install(ctx) {
-        const { engine } = ctx;
-        const protocol = new ObjectStackRuntimeProtocol(engine);
+    /**
+     * Init phase
+     */
+    async init(ctx) {
+        // Protocol will be created in start phase
+        ctx.logger.log('[MSWPlugin] Initialized');
+    }
+    /**
+     * Start phase
+     */
+    async start(ctx) {
+        try {
+            const dataEngine = ctx.getService('objectql');
+            this.protocol = new ObjectStackProtocolImplementation(dataEngine);
+        }
+        catch (e) {
+            console.error('[MSWPlugin] Failed to initialize protocol', e);
+            throw new Error('[MSWPlugin] Failed to initialize protocol (missing objectql service?)');
+        }
+        this.setupHandlers();
+        await this.startWorker();
+    }
+    /**
+     * Destroy phase
+     */
+    async destroy() {
+        await this.stopWorker();
+    }
+    /**
+     * Setup MSW handlers
+     */
+    setupHandlers() {
+        if (!this.protocol) {
+            throw new Error('[MSWPlugin] Protocol not initialized');
+        }
+        const protocol = this.protocol;
         // Initialize ObjectStackServer
         ObjectStackServer.init(protocol, this.options.logRequests ? console.log : undefined);
         const baseUrl = this.options.baseUrl || '/api/v1';
@@ -245,7 +277,10 @@ export class MSWPlugin {
         ];
         console.log(`[MSWPlugin] Installed ${this.handlers.length} request handlers.`);
     }
-    async onStart(ctx) {
+    /**
+     * Start the MSW worker
+     */
+    async startWorker() {
         if (this.options.enableBrowser && typeof window !== 'undefined') {
             // Browser environment
             this.worker = setupWorker(...this.handlers);
@@ -258,7 +293,10 @@ export class MSWPlugin {
             console.log(`[MSWPlugin] Browser mode disabled or not in browser environment.`);
         }
     }
-    async onStop() {
+    /**
+     * Stop the MSW worker
+     */
+    async stopWorker() {
         if (this.worker) {
             this.worker.stop();
             console.log(`[MSWPlugin] Stopped MSW worker.`);

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@objectstack/plugin-msw",
-  "version": "0.4.2",
+  "version": "0.6.0",
   "description": "MSW (Mock Service Worker) Plugin for ObjectStack Runtime",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
     "msw": "^2.0.0",
-    "@objectstack/spec": "0.4.2",
-    "@objectstack/types": "0.4.2"
+    "@objectstack/spec": "0.6.0",
+    "@objectstack/types": "0.6.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
     "typescript": "^5.0.0",
-    "@objectstack/runtime": "0.4.2"
+    "@objectstack/runtime": "0.6.0"
   },
   "peerDependencies": {
-    "@objectstack/runtime": "^0.4.2"
+    "@objectstack/runtime": "^0.6.0"
   },
   "scripts": {
     "build": "tsc"

package/src/msw-plugin.ts

@@ -1,6 +1,14 @@
 import { http, HttpResponse } from 'msw';
 import { setupWorker } from 'msw/browser';
-import { RuntimePlugin, RuntimeContext, ObjectStackRuntimeProtocol } from '@objectstack/runtime';
+import { 
+    Plugin, 
+    PluginContext, 
+    ObjectKernel,
+    ObjectStackProtocolImplementation,
+    IDataEngine
+} from '@objectstack/runtime';
+import { IObjectStackProtocol } from '@objectstack/spec/api';
+// import { IDataEngine } from '@objectstack/core';
 
 export interface MSWPluginOptions {
     /**
@@ -28,10 +36,10 @@ export interface MSWPluginOptions {
  * ObjectStack Server Mock - Provides mock database functionality
  */
 export class ObjectStackServer {
-    private static protocol: ObjectStackRuntimeProtocol | null = null;
+    private static protocol: IObjectStackProtocol | null = null;
     private static logger: ((message: string, ...meta: any[]) => void) | null = null;
 
-    static init(protocol: ObjectStackRuntimeProtocol, logger?: (message: string, ...meta: any[]) => void) {
+    static init(protocol: IObjectStackProtocol, logger?: (message: string, ...meta: any[]) => void) {
         this.protocol = protocol;
         this.logger = logger || console.log;
     }
@@ -153,21 +161,22 @@ export class ObjectStackServer {
  * ```typescript
  * import { MSWPlugin } from '@objectstack/plugin-msw';
  * 
- * const runtime = new ObjectStackRuntime({
- *   plugins: [
- *     new MSWPlugin({
- *       enableBrowser: true,
- *       baseUrl: '/api/v1'
- *     })
- *   ]
- * });
+ * // With ObjectKernel
+ * const kernel = new ObjectKernel();
+ * kernel.use(new MSWPlugin({
+ *   enableBrowser: true,
+ *   baseUrl: '/api/v1'
+ * }));
  * ```
  */
-export class MSWPlugin implements RuntimePlugin {
-    name = 'msw';
+export class MSWPlugin implements Plugin {
+    name = 'com.objectstack.plugin.msw';
+    version = '1.0.0';
+    
     private options: MSWPluginOptions;
     private worker: any;
     private handlers: Array<any> = [];
+    private protocol?: IObjectStackProtocol;
 
     constructor(options: MSWPluginOptions = {}) {
         this.options = {
@@ -178,9 +187,46 @@ export class MSWPlugin implements RuntimePlugin {
         };
     }
 
-    install(ctx: RuntimeContext) {
-        const { engine } = ctx;
-        const protocol = new ObjectStackRuntimeProtocol(engine);
+    /**
+     * Init phase
+     */
+    async init(ctx: PluginContext) {
+        // Protocol will be created in start phase
+        ctx.logger.log('[MSWPlugin] Initialized');
+    }
+
+    /**
+     * Start phase
+     */
+    async start(ctx: PluginContext) {
+        try {
+            const dataEngine = ctx.getService<IDataEngine>('objectql');
+            this.protocol = new ObjectStackProtocolImplementation(dataEngine);
+        } catch (e) {
+            console.error('[MSWPlugin] Failed to initialize protocol', e);
+            throw new Error('[MSWPlugin] Failed to initialize protocol (missing objectql service?)');
+        }
+        
+        this.setupHandlers();
+        await this.startWorker();
+    }
+
+    /**
+     * Destroy phase
+     */
+    async destroy() {
+        await this.stopWorker();
+    }
+
+    /**
+     * Setup MSW handlers
+     */
+    private setupHandlers() {
+        if (!this.protocol) {
+            throw new Error('[MSWPlugin] Protocol not initialized');
+        }
+
+        const protocol = this.protocol;
         
         // Initialize ObjectStackServer
         ObjectStackServer.init(
@@ -312,7 +358,10 @@ export class MSWPlugin implements RuntimePlugin {
         console.log(`[MSWPlugin] Installed ${this.handlers.length} request handlers.`);
     }
 
-    async onStart(ctx: RuntimeContext) {
+    /**
+     * Start the MSW worker
+     */
+    private async startWorker() {
         if (this.options.enableBrowser && typeof window !== 'undefined') {
             // Browser environment
             this.worker = setupWorker(...this.handlers);
@@ -325,7 +374,10 @@ export class MSWPlugin implements RuntimePlugin {
         }
     }
 
-    async onStop() {
+    /**
+     * Stop the MSW worker
+     */
+    private async stopWorker() {
         if (this.worker) {
             this.worker.stop();
             console.log(`[MSWPlugin] Stopped MSW worker.`);