@objectstack/plugin-msw 4.0.4 → 4.0.5

package/objectstack.config.ts

@@ -1,275 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { ObjectStackManifest } from '@objectstack/spec/system';
-
-/**
- * MSW (Mock Service Worker) Plugin Manifest
- * 
- * Browser-based mock server for testing and development.
- * Intercepts HTTP requests and provides mock responses using ObjectStack runtime.
- */
-const MSWPlugin: ObjectStackManifest = {
-  id: 'com.objectstack.plugin.msw',
-  name: 'Mock Service Worker Plugin',
-  version: '1.0.0',
-  type: 'plugin',
-  description: 'MSW (Mock Service Worker) integration for testing and development. Provides browser-based API mocking using ObjectStack runtime protocol.',
-  
-  configuration: {
-    title: 'MSW Plugin Configuration',
-    properties: {
-      enableBrowser: {
-        type: 'boolean',
-        default: true,
-        description: 'Enable MSW in browser environment',
-      },
-      baseUrl: {
-        type: 'string',
-        default: '/api/v1',
-        description: 'Base URL for API endpoints',
-      },
-      logRequests: {
-        type: 'boolean',
-        default: true,
-        description: 'Log all intercepted requests',
-      },
-    },
-  },
-
-  // Plugin Capability Declaration
-  capabilities: {
-    // Protocols This Plugin Implements
-    implements: [
-      {
-        protocol: {
-          id: 'com.objectstack.protocol.testing.mock.v1',
-          label: 'Mock Service Protocol v1',
-          version: { major: 1, minor: 0, patch: 0 },
-          description: 'HTTP request mocking for testing',
-        },
-        conformance: 'full',
-        features: [
-          {
-            name: 'browser_mocking',
-            enabled: true,
-            description: 'Browser-based request interception',
-          },
-          {
-            name: 'api_simulation',
-            enabled: true,
-            description: 'Full ObjectStack API simulation',
-          },
-          {
-            name: 'custom_handlers',
-            enabled: true,
-            description: 'Custom request handler registration',
-          },
-        ],
-        certified: false,
-      },
-      {
-        protocol: {
-          id: 'com.objectstack.protocol.api.rest.v1',
-          label: 'REST API Protocol v1',
-          version: { major: 1, minor: 0, patch: 0 },
-          description: 'RESTful API endpoint mocking',
-        },
-        conformance: 'full',
-        features: [
-          {
-            name: 'meta_endpoints',
-            enabled: true,
-            description: 'Metadata discovery endpoints',
-          },
-          {
-            name: 'data_endpoints',
-            enabled: true,
-            description: 'CRUD data operation endpoints',
-          },
-          {
-            name: 'ui_endpoints',
-            enabled: true,
-            description: 'UI view metadata endpoints',
-          },
-        ],
-        certified: false,
-      },
-    ],
-
-    // Interfaces This Plugin Provides
-    provides: [
-      {
-        id: 'com.objectstack.plugin.msw.interface.mock_server',
-        name: 'ObjectStackServer',
-        description: 'Mock server interface for testing',
-        version: { major: 1, minor: 0, patch: 0 },
-        stability: 'stable',
-        methods: [
-          {
-            name: 'init',
-            description: 'Initialize mock server with protocol implementation',
-            parameters: [
-              {
-                name: 'protocol',
-                type: 'IObjectStackProtocol',
-                required: true,
-                description: 'ObjectStack protocol implementation instance',
-              },
-              {
-                name: 'logger',
-                type: 'Logger',
-                required: false,
-                description: 'Optional logger instance',
-              },
-            ],
-            returnType: 'void',
-            async: false,
-          },
-          {
-            name: 'findData',
-            description: 'Mock data find operation',
-            parameters: [
-              {
-                name: 'object',
-                type: 'string',
-                required: true,
-                description: 'Object name',
-              },
-              {
-                name: 'params',
-                type: 'any',
-                required: false,
-                description: 'Query parameters',
-              },
-            ],
-            returnType: 'Promise<{ status: number; data: any }>',
-            async: true,
-          },
-          {
-            name: 'getData',
-            description: 'Mock data get operation',
-            parameters: [
-              {
-                name: 'object',
-                type: 'string',
-                required: true,
-                description: 'Object name',
-              },
-              {
-                name: 'id',
-                type: 'string',
-                required: true,
-                description: 'Record ID',
-              },
-            ],
-            returnType: 'Promise<{ status: number; data: any }>',
-            async: true,
-          },
-          {
-            name: 'createData',
-            description: 'Mock data create operation',
-            parameters: [
-              {
-                name: 'object',
-                type: 'string',
-                required: true,
-                description: 'Object name',
-              },
-              {
-                name: 'data',
-                type: 'any',
-                required: true,
-                description: 'Record data',
-              },
-            ],
-            returnType: 'Promise<{ status: number; data: any }>',
-            async: true,
-          },
-          {
-            name: 'updateData',
-            description: 'Mock data update operation',
-            parameters: [
-              {
-                name: 'object',
-                type: 'string',
-                required: true,
-                description: 'Object name',
-              },
-              {
-                name: 'id',
-                type: 'string',
-                required: true,
-                description: 'Record ID',
-              },
-              {
-                name: 'data',
-                type: 'any',
-                required: true,
-                description: 'Updated record data',
-              },
-            ],
-            returnType: 'Promise<{ status: number; data: any }>',
-            async: true,
-          },
-          {
-            name: 'deleteData',
-            description: 'Mock data delete operation',
-            parameters: [
-              {
-                name: 'object',
-                type: 'string',
-                required: true,
-                description: 'Object name',
-              },
-              {
-                name: 'id',
-                type: 'string',
-                required: true,
-                description: 'Record ID',
-              },
-            ],
-            returnType: 'Promise<{ status: number; data: any }>',
-            async: true,
-          },
-        ],
-      },
-    ],
-
-    // Dependencies on Other Plugins/Services
-    requires: [
-      {
-        pluginId: 'com.objectstack.engine.objectql',
-        version: '^0.6.0',
-        optional: false,
-        reason: 'ObjectQL data engine for mock responses',
-        requiredCapabilities: [
-          'com.objectstack.protocol.storage.v1',
-        ],
-      },
-    ],
-
-    // Extension Points This Plugin Defines
-    extensionPoints: [
-      {
-        id: 'com.objectstack.plugin.msw.extension.custom_handler',
-        name: 'Custom Request Handlers',
-        description: 'Register custom MSW request handlers',
-        type: 'action',
-        cardinality: 'multiple',
-        contract: {
-          input: 'MSWHandler',
-          description: 'MSW HTTP handler definition',
-        },
-      },
-    ],
-
-    // No extensions contributed to other plugins
-    extensions: [],
-  },
-
-  contributes: {
-    // No specific contributions (runtime plugin)
-  },
-};
-
-export default MSWPlugin;

package/src/index.ts

@@ -1,48 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-/**
- * @objectstack/plugin-msw
- * 
- * MSW (Mock Service Worker) Plugin for ObjectStack Runtime
- * 
- * This plugin enables seamless integration with Mock Service Worker for
- * testing and development environments. It automatically generates MSW
- * handlers for all ObjectStack API endpoints.
- * 
- * @example
- * ```typescript
- * import { MSWPlugin, ObjectStackServer } from '@objectstack/plugin-msw';
- * import { ObjectStackRuntime } from '@objectstack/runtime';
- * 
- * // Use with runtime
- * const runtime = new ObjectStackRuntime({
- *   plugins: [
- *     new MSWPlugin({
- *       enableBrowser: true,
- *       baseUrl: '/api/v1'
- *     })
- *   ]
- * });
- * 
- * // Or use standalone in browser
- * import { setupWorker, http } from 'msw/browser';
- * 
- * ObjectStackServer.init(protocol);
- * 
- * const handlers = [
- *   http.get('/api/user/:id', async ({ params }) => {
- *     const result = await ObjectStackServer.getData('user', params.id);
- *     return HttpResponse.json(result.data, { status: result.status });
- *   })
- * ];
- * 
- * const worker = setupWorker(...handlers);
- * await worker.start();
- * ```
- */
-
-export { MSWPlugin, ObjectStackServer } from './msw-plugin';
-export type { MSWPluginOptions } from './msw-plugin';
-
-// Re-export MSW types for convenience
-export type { HttpHandler, HttpResponse } from 'msw';

package/src/msw-plugin.test.ts

@@ -1,41 +0,0 @@
-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();
-    });
-});