@objectstack/plugin-msw 0.8.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @objectstack/plugin-msw
 
+## 0.8.2
+
+### Patch Changes
+
+- 555e6a7: Refactor: Deprecated View Storage protocol in favor of Metadata Views.
+
+  - **BREAKING**: Removed `view-storage.zod.ts` and `ViewStorage` related types from `@objectstack/spec`.
+  - **BREAKING**: Removed `createView`, `updateView`, `deleteView`, `listViews` from `ObjectStackProtocol` interface.
+  - **BREAKING**: Removed in-memory View Storage implementation from `@objectstack/objectql`.
+  - **UPDATE**: `@objectstack/plugin-msw` now dynamically loads `@objectstack/objectql` to avoid hard dependencies.
+
+- Updated dependencies [555e6a7]
+  - @objectstack/spec@0.8.2
+  - @objectstack/objectql@0.8.2
+  - @objectstack/runtime@0.8.2
+  - @objectstack/types@0.8.2
+
 ## 0.8.1
 
 ### Patch Changes

package/dist/msw-plugin.js

@@ -1,6 +1,5 @@
 import { http, HttpResponse, passthrough } from 'msw';
 import { setupWorker } from 'msw/browser';
-import { ObjectStackProtocolImplementation } from '@objectstack/objectql';
 /**
  * ObjectStack Server Mock - Provides mock database functionality
  */
@@ -145,7 +144,7 @@ ObjectStackServer.logger = null;
 export class MSWPlugin {
     constructor(options = {}) {
         this.name = 'com.objectstack.plugin.msw';
-        this.version = '1.0.0';
+        this.version = '0.9.0';
         this.handlers = [];
         this.options = {
             enableBrowser: true,
@@ -172,13 +171,40 @@ export class MSWPlugin {
     async start(ctx) {
         ctx.logger.debug('Starting MSW plugin');
         try {
-            const dataEngine = ctx.getService('objectql');
-            this.protocol = new ObjectStackProtocolImplementation(dataEngine);
-            ctx.logger.debug('Protocol implementation created');
+            // 1. Try to get existing protocol service
+            try {
+                this.protocol = ctx.getService('protocol');
+                ctx.logger.debug('Protocol service found from context');
+            }
+            catch (e) {
+                // Ignore, will try to create default implementation
+            }
+            // 2. If not found, try to instantiate default implementation dynamically
+            if (!this.protocol) {
+                try {
+                    const dataEngine = ctx.getService('objectql');
+                    // Dynamically import ObjectStackProtocolImplementation to avoid hard dependency
+                    const { ObjectStackProtocolImplementation } = await import('@objectstack/objectql');
+                    this.protocol = new ObjectStackProtocolImplementation(dataEngine);
+                    ctx.logger.debug('Protocol implementation created dynamically');
+                }
+                catch (e) {
+                    if (e.code === 'ERR_MODULE_NOT_FOUND') {
+                        ctx.logger.warn('Module @objectstack/objectql not found. Protocol not initialized.');
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            if (!this.protocol) {
+                // Without a protocol, MSW can't serve data APIs
+                ctx.logger.warn('No ObjectStackProtocol service available. MSW will only serve static/custom handlers if configured.');
+            }
         }
         catch (e) {
             ctx.logger.error('Failed to initialize protocol', e);
-            throw new Error('[MSWPlugin] Failed to initialize protocol (missing objectql service?)');
+            throw new Error('[MSWPlugin] Failed to initialize protocol');
         }
         this.setupHandlers(ctx);
         await this.startWorker(ctx);
@@ -194,7 +220,11 @@ export class MSWPlugin {
      */
     setupHandlers(ctx) {
         if (!this.protocol) {
-            throw new Error('[MSWPlugin] Protocol not initialized');
+            ctx.logger.warn('[MSWPlugin] Protocol not initialized. Skipping default API handlers.');
+            this.handlers = [
+                ...(this.options.customHandlers || [])
+            ];
+            return;
         }
         const protocol = this.protocol;
         // Initialize ObjectStackServer with structured logger
@@ -402,109 +432,6 @@ export class MSWPlugin {
                     return HttpResponse.json({ error: message }, { status: 404 });
                 }
             }),
-            // View Storage Operations
-            http.post(`${baseUrl}/ui/views`, async ({ request }) => {
-                try {
-                    const body = await request.json();
-                    const result = await protocol.createView(body);
-                    if (result.success) {
-                        return HttpResponse.json(result, { status: 201 });
-                    }
-                    else {
-                        return HttpResponse.json(result, { status: 400 });
-                    }
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-            http.get(`${baseUrl}/ui/views/:id`, async ({ params }) => {
-                try {
-                    const result = await protocol.getView({ id: params.id });
-                    if (result.success) {
-                        return HttpResponse.json(result);
-                    }
-                    else {
-                        return HttpResponse.json(result, { status: 404 });
-                    }
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-            http.get(`${baseUrl}/ui/views`, async ({ request }) => {
-                try {
-                    const url = new URL(request.url);
-                    const queryRequest = {};
-                    if (url.searchParams.get('object'))
-                        queryRequest.object = url.searchParams.get('object');
-                    if (url.searchParams.get('type'))
-                        queryRequest.type = url.searchParams.get('type');
-                    if (url.searchParams.get('visibility'))
-                        queryRequest.visibility = url.searchParams.get('visibility');
-                    if (url.searchParams.get('createdBy'))
-                        queryRequest.createdBy = url.searchParams.get('createdBy');
-                    if (url.searchParams.get('isDefault'))
-                        queryRequest.isDefault = url.searchParams.get('isDefault') === 'true';
-                    // Parse numeric parameters with validation
-                    const limitParam = url.searchParams.get('limit');
-                    const offsetParam = url.searchParams.get('offset');
-                    if (limitParam) {
-                        const limit = parseInt(limitParam, 10);
-                        if (!isNaN(limit) && limit > 0)
-                            queryRequest.limit = limit;
-                    }
-                    if (offsetParam) {
-                        const offset = parseInt(offsetParam, 10);
-                        if (!isNaN(offset) && offset >= 0)
-                            queryRequest.offset = offset;
-                    }
-                    const result = await protocol.listViews(queryRequest);
-                    return HttpResponse.json(result);
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-            http.patch(`${baseUrl}/ui/views/:id`, async ({ params, request }) => {
-                try {
-                    const body = await request.json();
-                    // Merge body with id parameter, ensuring body is an object
-                    const updateData = (typeof body === 'object' && body !== null)
-                        ? { ...body, id: params.id }
-                        : { id: params.id };
-                    const result = await protocol.updateView(updateData);
-                    if (result.success) {
-                        return HttpResponse.json(result);
-                    }
-                    else {
-                        const statusCode = result.error?.code === 'resource_not_found' ? 404 : 400;
-                        return HttpResponse.json(result, { status: statusCode });
-                    }
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-            http.delete(`${baseUrl}/ui/views/:id`, async ({ params }) => {
-                try {
-                    const result = await protocol.deleteView({ id: params.id });
-                    if (result.success) {
-                        return HttpResponse.json(result);
-                    }
-                    else {
-                        return HttpResponse.json(result, { status: 404 });
-                    }
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
             // Add custom handlers
             ...(this.options.customHandlers || [])
         ];

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "@objectstack/plugin-msw",
-  "version": "0.8.1",
+  "version": "0.9.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.8.1",
-    "@objectstack/types": "0.8.1",
-    "@objectstack/objectql": "0.8.1"
+    "@objectstack/spec": "0.9.0",
+    "@objectstack/types": "0.9.0",
+    "@objectstack/objectql": "0.9.0"
   },
   "devDependencies": {
     "@types/node": "^25.1.0",
     "typescript": "^5.0.0",
-    "@objectstack/runtime": "0.8.1"
+    "vitest": "^4.0.18",
+    "@objectstack/runtime": "0.9.0"
   },
   "peerDependencies": {
-    "@objectstack/runtime": "^0.8.1"
+    "@objectstack/runtime": "^0.9.0"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "vitest run"
   }
 }

package/src/msw-plugin.test.ts

@@ -0,0 +1,41 @@
+import { describe, it, expect, vi } from 'vitest';
+import { MSWPlugin, ObjectStackServer } from './msw-plugin';
+
+describe('MSWPlugin', () => {
+    it('should initialize correctly', () => {
+        const plugin = new MSWPlugin({ enableBrowser: false });
+        expect(plugin.name).toBe('com.objectstack.plugin.msw');
+        expect(plugin.version).toBe('0.9.0');
+    });
+
+    it('should handle protocol dynamic loading gracefully', async () => {
+        // Mock context 
+        const context: any = {
+            logger: { info: vi.fn(), debug: vi.fn(), warn: vi.fn() },
+            getService: vi.fn().mockReturnValue(null), // No protocol service initially
+            registerService: vi.fn()
+        };
+
+        const plugin = new MSWPlugin();
+        await plugin.init(context);
+        // It should try to load ObjectStackProtocolImplementation dynamically
+        // Since we are in test environment, the dynamic import might fail or succeed depending on build
+        // But we expect it not to crash
+    });
+});
+
+describe('ObjectStackServer', () => {
+    it('should throw if used before init', async () => {
+        await expect(ObjectStackServer.findData('test')).rejects.toThrow('ObjectStackServer not initialized');
+    });
+
+    it('should delegate to protocol after init', async () => {
+        const protocolMock: any = {
+            findData: vi.fn().mockResolvedValue({ records: [] })
+        };
+        ObjectStackServer.init(protocolMock);
+        
+        await ObjectStackServer.findData('test');
+        expect(protocolMock.findData).toHaveBeenCalled();
+    });
+});

package/src/msw-plugin.ts

@@ -6,7 +6,7 @@ import {
     ObjectKernel,
     IDataEngine
 } from '@objectstack/runtime';
-import { ObjectStackProtocolImplementation } from '@objectstack/objectql';
+// import { ObjectStackProtocolImplementation } from '@objectstack/objectql';
 import { ObjectStackProtocol } from '@objectstack/spec/api';
 // import { IDataEngine } from '@objectstack/core';
 
@@ -185,7 +185,7 @@ export class ObjectStackServer {
  */
 export class MSWPlugin implements Plugin {
     name = 'com.objectstack.plugin.msw';
-    version = '1.0.0';
+    version = '0.9.0';
     
     private options: MSWPluginOptions;
     private worker: any;
@@ -221,12 +221,39 @@ export class MSWPlugin implements Plugin {
         ctx.logger.debug('Starting MSW plugin');
         
         try {
-            const dataEngine = ctx.getService<IDataEngine>('objectql');
-            this.protocol = new ObjectStackProtocolImplementation(dataEngine);
-            ctx.logger.debug('Protocol implementation created');
+            // 1. Try to get existing protocol service
+            try {
+                this.protocol = ctx.getService<ObjectStackProtocol>('protocol');
+                ctx.logger.debug('Protocol service found from context');
+            } catch (e) {
+                // Ignore, will try to create default implementation
+            }
+
+            // 2. If not found, try to instantiate default implementation dynamically
+            if (!this.protocol) {
+                try {
+                    const dataEngine = ctx.getService<IDataEngine>('objectql');
+                    // Dynamically import ObjectStackProtocolImplementation to avoid hard dependency
+                    const { ObjectStackProtocolImplementation } = await import('@objectstack/objectql');
+                    this.protocol = new ObjectStackProtocolImplementation(dataEngine);
+                    ctx.logger.debug('Protocol implementation created dynamically');
+                } catch (e: any) {
+                    if (e.code === 'ERR_MODULE_NOT_FOUND') {
+                         ctx.logger.warn('Module @objectstack/objectql not found. Protocol not initialized.');
+                    } else {
+                         throw e;
+                    }
+                }
+            }
+        
+            if (!this.protocol) {
+                // Without a protocol, MSW can't serve data APIs
+                ctx.logger.warn('No ObjectStackProtocol service available. MSW will only serve static/custom handlers if configured.');
+            }
+
         } catch (e) {
             ctx.logger.error('Failed to initialize protocol', e as Error);
-            throw new Error('[MSWPlugin] Failed to initialize protocol (missing objectql service?)');
+            throw new Error('[MSWPlugin] Failed to initialize protocol');
         }
         
         this.setupHandlers(ctx);
@@ -245,7 +272,11 @@ export class MSWPlugin implements Plugin {
      */
     private setupHandlers(ctx: PluginContext) {
         if (!this.protocol) {
-            throw new Error('[MSWPlugin] Protocol not initialized');
+            ctx.logger.warn('[MSWPlugin] Protocol not initialized. Skipping default API handlers.');
+            this.handlers = [
+                ...(this.options.customHandlers || [])
+            ];
+            return;
         }
 
         const protocol = this.protocol;
@@ -488,101 +519,6 @@ export class MSWPlugin implements Plugin {
                 }
             }),
 
-            // View Storage Operations
-            http.post(`${baseUrl}/ui/views`, async ({ request }) => {
-                try {
-                    const body = await request.json();
-                    const result = await protocol.createView(body as any);
-                    if (result.success) {
-                        return HttpResponse.json(result, { status: 201 });
-                    } else {
-                        return HttpResponse.json(result, { status: 400 });
-                    }
-                } catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-
-            http.get(`${baseUrl}/ui/views/:id`, async ({ params }) => {
-                try {
-                    const result = await protocol.getView({ id: params.id as string });
-                    if (result.success) {
-                        return HttpResponse.json(result);
-                    } else {
-                        return HttpResponse.json(result, { status: 404 });
-                    }
-                } catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-
-            http.get(`${baseUrl}/ui/views`, async ({ request }) => {
-                try {
-                    const url = new URL(request.url);
-                    const queryRequest: any = {};
-                    if (url.searchParams.get('object')) queryRequest.object = url.searchParams.get('object');
-                    if (url.searchParams.get('type')) queryRequest.type = url.searchParams.get('type');
-                    if (url.searchParams.get('visibility')) queryRequest.visibility = url.searchParams.get('visibility');
-                    if (url.searchParams.get('createdBy')) queryRequest.createdBy = url.searchParams.get('createdBy');
-                    if (url.searchParams.get('isDefault')) queryRequest.isDefault = url.searchParams.get('isDefault') === 'true';
-                    
-                    // Parse numeric parameters with validation
-                    const limitParam = url.searchParams.get('limit');
-                    const offsetParam = url.searchParams.get('offset');
-                    if (limitParam) {
-                        const limit = parseInt(limitParam, 10);
-                        if (!isNaN(limit) && limit > 0) queryRequest.limit = limit;
-                    }
-                    if (offsetParam) {
-                        const offset = parseInt(offsetParam, 10);
-                        if (!isNaN(offset) && offset >= 0) queryRequest.offset = offset;
-                    }
-                    
-                    const result = await protocol.listViews(queryRequest);
-                    return HttpResponse.json(result);
-                } catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-
-            http.patch(`${baseUrl}/ui/views/:id`, async ({ params, request }) => {
-                try {
-                    const body = await request.json() as any;
-                    // Merge body with id parameter, ensuring body is an object
-                    const updateData = (typeof body === 'object' && body !== null) 
-                        ? { ...body, id: params.id as string } 
-                        : { id: params.id as string };
-                    
-                    const result = await protocol.updateView(updateData as any);
-                    if (result.success) {
-                        return HttpResponse.json(result);
-                    } else {
-                        const statusCode = result.error?.code === 'resource_not_found' ? 404 : 400;
-                        return HttpResponse.json(result, { status: statusCode });
-                    }
-                } catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-
-            http.delete(`${baseUrl}/ui/views/:id`, async ({ params }) => {
-                try {
-                    const result = await protocol.deleteView({ id: params.id as string });
-                    if (result.success) {
-                        return HttpResponse.json(result);
-                    } else {
-                        return HttpResponse.json(result, { status: 404 });
-                    }
-                } catch (error) {
-                    const message = error instanceof Error ? error.message : 'Unknown error';
-                    return HttpResponse.json({ success: false, error: { code: 'internal_error', message } }, { status: 500 });
-                }
-            }),
-
             // Add custom handlers
             ...(this.options.customHandlers || [])
         ];

package/tsconfig.json

@@ -10,5 +10,6 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }