@objectstack/plugin-msw 1.0.1 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # @objectstack/plugin-msw
 
+## 1.0.4
+
+### Patch Changes
+
+- Updated dependencies [5d13533]
+  - @objectstack/objectql@1.0.4
+  - @objectstack/spec@1.0.4
+  - @objectstack/core@1.0.4
+  - @objectstack/types@1.0.4
+  - @objectstack/runtime@1.0.4
+
+## 1.0.3
+
+### Patch Changes
+
+- Updated dependencies [fb2eabd]
+- Updated dependencies [22a48f0]
+  - @objectstack/core@1.0.3
+  - @objectstack/runtime@1.0.3
+  - @objectstack/objectql@1.0.3
+  - @objectstack/spec@1.0.3
+  - @objectstack/types@1.0.3
+
+## 1.0.2
+
+### Patch Changes
+
+- a0a6c85: Infrastructure and development tooling improvements
+
+  - Add changeset configuration for automated version management
+  - Add comprehensive GitHub Actions workflows (CI, CodeQL, linting, releases)
+  - Add development configuration files (.cursorrules, .github/prompts)
+  - Add documentation files (ARCHITECTURE.md, CONTRIBUTING.md, workflows docs)
+  - Update test script configuration in package.json
+  - Add @objectstack/cli to devDependencies for better development experience
+
+- 109fc5b: Unified patch release to align all package versions.
+- Updated dependencies [a0a6c85]
+- Updated dependencies [109fc5b]
+  - @objectstack/spec@1.0.2
+  - @objectstack/core@1.0.2
+  - @objectstack/types@1.0.2
+  - @objectstack/objectql@1.0.2
+  - @objectstack/runtime@1.0.2
+
 ## 1.0.1
 
 ### Patch Changes

package/README.md

@@ -21,12 +21,17 @@ See [objectstack.config.ts](./objectstack.config.ts) for the complete capability
 
 ## Features
 
-- 🎯 **Automatic API Mocking**: Automatically generates MSW handlers for all ObjectStack API endpoints
-- 🔄 **Runtime Integration**: Seamlessly integrates with ObjectStack Runtime Protocol
-- 🧪 **Testing Ready**: Perfect for unit tests, integration tests, and development
-- 🌐 **Browser & Node Support**: Works in both browser and Node.js environments
-- 🎨 **Custom Handlers**: Easily add custom MSW handlers alongside standard ones
-- 📝 **TypeScript First**: Fully typed with TypeScript
+- 🎯 **Unified Dispatcher**: Uses `@objectstack/runtime`'s `HttpDispatcher` to ensure mocks behave exactly like the real server.
+- 🔄 **Full Protocol Support**: Mocks **all** Runtime endpoints:
+  - Auth (`/auth`)
+  - Metadata (`/metadata`)
+  - Data (`/data` - with filtering, batching, relations)
+  - Storage (`/storage`)
+  - Analytics (`/analytics`)
+  - Automation (`/automation`)
+- 🌐 **Universal Support**: Works in Browser (Service Worker) and Node.js (Interceptor).
+- 🎨 **Custom Handlers**: Easily inject custom MSW handlers that take precedence.
+- 📝 **TypeScript First**: Fully typed configuration.
 
 ## Installation
 
@@ -44,12 +49,21 @@ import { ObjectKernel } from '@objectstack/runtime';
 
 const kernel = new ObjectKernel();
 
+// The MSW Plugin will initialize the HttpDispatcher and intercept requests
 kernel.use(new MSWPlugin({
   enableBrowser: true,
   baseUrl: '/api/v1',
   logRequests: true
 }));
 
+await kernel.start();
+```
+
+### Architecture
+
+The plugin uses the `HttpDispatcher` from the Runtime to process requests intercepted by MSW. This means your mock server runs the **actual** ObjectStack business logic (permissions, validation, flow execution) in-memory, providing a high-fidelity simulation of the backend.
+}));
+
 await kernel.bootstrap();
 ```
 

package/dist/msw-plugin.d.ts

@@ -18,221 +18,9 @@ export interface MSWPluginOptions {
      */
     logRequests?: boolean;
 }
-/**
- * ObjectStack Server Mock - Provides mock database functionality
- */
-export declare class ObjectStackServer {
-    private static protocol;
-    private static logger;
-    static init(protocol: ObjectStackProtocol, logger?: any): void;
-    static findData(object: string, params?: any): Promise<{
-        status: number;
-        data: {
-            object: string;
-            records: Record<string, any>[];
-            total?: number | undefined;
-            hasMore?: boolean | undefined;
-        };
-    }>;
-    static getData(object: string, id: string): Promise<{
-        status: number;
-        data: {
-            object: string;
-            record: Record<string, any>;
-            id: string;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static createData(object: string, data: any): Promise<{
-        status: number;
-        data: {
-            object: string;
-            record: Record<string, any>;
-            id: string;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static updateData(object: string, id: string, data: any): Promise<{
-        status: number;
-        data: {
-            object: string;
-            record: Record<string, any>;
-            id: string;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static deleteData(object: string, id: string): Promise<{
-        status: number;
-        data: {
-            object: string;
-            id: string;
-            success: boolean;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static analyticsQuery(request: any): Promise<{
-        status: number;
-        data: {
-            data: {
-                fields: {
-                    type: string;
-                    name: string;
-                }[];
-                rows: Record<string, any>[];
-                sql?: string | undefined;
-            };
-            success: boolean;
-            error?: {
-                message: string;
-                code: string;
-                category?: string | undefined;
-                requestId?: string | undefined;
-                details?: any;
-            } | undefined;
-            meta?: {
-                timestamp: string;
-                duration?: number | undefined;
-                requestId?: string | undefined;
-                traceId?: string | undefined;
-            } | undefined;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static getAnalyticsMeta(request: any): Promise<{
-        status: number;
-        data: {
-            data: {
-                cubes: {
-                    dimensions: Record<string, {
-                        type: "string" | "number" | "boolean" | "time" | "geo";
-                        label: string;
-                        name: string;
-                        sql: string;
-                        description?: string | undefined;
-                        granularities?: ("second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")[] | undefined;
-                    }>;
-                    name: string;
-                    sql: string;
-                    measures: Record<string, {
-                        type: "string" | "number" | "boolean" | "count" | "sum" | "avg" | "min" | "max" | "count_distinct";
-                        label: string;
-                        name: string;
-                        sql: string;
-                        description?: string | undefined;
-                        format?: string | undefined;
-                        filters?: {
-                            sql: string;
-                        }[] | undefined;
-                    }>;
-                    public: boolean;
-                    joins?: Record<string, {
-                        name: string;
-                        sql: string;
-                        relationship: "one_to_one" | "one_to_many" | "many_to_one";
-                    }> | undefined;
-                    description?: string | undefined;
-                    title?: string | undefined;
-                    refreshKey?: {
-                        every?: string | undefined;
-                        sql?: string | undefined;
-                    } | undefined;
-                }[];
-            };
-            success: boolean;
-            error?: {
-                message: string;
-                code: string;
-                category?: string | undefined;
-                requestId?: string | undefined;
-                details?: any;
-            } | undefined;
-            meta?: {
-                timestamp: string;
-                duration?: number | undefined;
-                requestId?: string | undefined;
-                traceId?: string | undefined;
-            } | undefined;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static triggerAutomation(request: any): Promise<{
-        status: number;
-        data: {
-            success: boolean;
-            result?: any;
-            jobId?: string | undefined;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static getUser(id: string): Promise<{
-        status: number;
-        data: {
-            object: string;
-            record: Record<string, any>;
-            id: string;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static createUser(data: any): Promise<{
-        status: number;
-        data: {
-            object: string;
-            record: Record<string, any>;
-            id: string;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-    static saveMetaItem(type: string, name: string, item: any): Promise<{
-        status: number;
-        data: {
-            success: boolean;
-            message?: string | undefined;
-        };
-    } | {
-        status: number;
-        data: {
-            error: string;
-        };
-    }>;
-}
 /**
  * MSW Plugin for ObjectStack
+
  *
  * This plugin enables Mock Service Worker integration for testing and development.
  * It automatically mocks API endpoints using the ObjectStack runtime protocol.
@@ -256,6 +44,7 @@ export declare class MSWPlugin implements Plugin {
     private worker;
     private handlers;
     private protocol?;
+    private dispatcher?;
     constructor(options?: MSWPluginOptions);
     /**
      * Init phase
@@ -290,3 +79,52 @@ export declare class MSWPlugin implements Plugin {
      */
     getHandlers(): any[];
 }
+/**
+ * Static helper for interacting with ObjectStack protocol in MSW handlers
+ */
+export declare class ObjectStackServer {
+    private static protocol;
+    static init(protocol: ObjectStackProtocol): void;
+    private static getProtocol;
+    static findData(objectName: string, query?: any): Promise<{
+        data: {
+            object: string;
+            records: Record<string, any>[];
+            total?: number | undefined;
+            hasMore?: boolean | undefined;
+        };
+        status: number;
+    }>;
+    static getData(objectName: string, id: string): Promise<{
+        data: {
+            object: string;
+            record: Record<string, any>;
+            id: string;
+        };
+        status: number;
+    }>;
+    static createData(objectName: string, data: any): Promise<{
+        data: {
+            object: string;
+            record: Record<string, any>;
+            id: string;
+        };
+        status: number;
+    }>;
+    static updateData(objectName: string, id: string, data: any): Promise<{
+        data: {
+            object: string;
+            record: Record<string, any>;
+            id: string;
+        };
+        status: number;
+    }>;
+    static deleteData(objectName: string, id: string): Promise<{
+        data: {
+            object: string;
+            id: string;
+            success: boolean;
+        };
+        status: number;
+    }>;
+}