json-api-mocker 2.3.0 → 2.3.1

package/CONFIG.md

@@ -302,3 +302,41 @@ You can configure file upload endpoints in your `data.json`:
     }
   }
 ```
+
+### WebSocket Configuration
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| enabled | boolean | Yes | Enable/disable WebSocket support |
+| path | string | Yes | WebSocket endpoint path |
+| events | object | No | Event configurations |
+
+#### Event Configuration
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| mock.enabled | boolean | Yes | Enable/disable mock data for this event |
+| mock.interval | number | No | Interval (ms) for automatic data sending |
+| mock.template | object | Yes | Mock.js template for response data |
+
+Example:
+```json
+{
+  "websocket": {
+    "enabled": true,
+    "path": "/ws",
+    "events": {
+      "event-name": {
+        "mock": {
+          "enabled": true,
+          "interval": 5000,
+          "template": {
+            "field1": "@value",
+            "field2|1-100": 1
+          }
+        }
+      }
+    }
+  }
+}
+```

package/README.ch.md

@@ -17,6 +17,7 @@
 - 🛠 可自定义响应结构
 - 🎭 集成 Mock.js 实现强大的数据模拟
 - 📤 支持文件上传
+- 🔌 支持 WebSocket 实时通信
 - 💡 TypeScript 支持
 
 ## 📦 安装
@@ -296,6 +297,89 @@ curl http://localhost:8080/api/users?page=2&pageSize=10
 }
 ```
 
+### WebSocket 支持
+
+你可以在 `data.json` 中配置 WebSocket 接口：
+
+```json
+{
+  "websocket": {
+    "enabled": true,
+    "path": "/ws",
+    "events": {
+      "realtime-data": {
+        "mock": {
+          "enabled": true,
+          "interval": 5000,  // 每5秒发送一次数据
+          "template": {
+            "timestamp": "@datetime",
+            "value|1-100": 1,
+            "status|1": ["normal", "warning", "error"]
+          }
+        }
+      },
+      "user-status": {
+        "mock": {
+          "enabled": true,
+          "template": {
+            "userId|+1": 1,
+            "status|1": ["online", "offline", "away"],
+            "lastActive": "@datetime"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+#### 客户端使用示例：
+
+```javascript
+// 连接 WebSocket 服务器
+const ws = new WebSocket('ws://localhost:8080/ws');
+
+// 处理连接打开
+ws.onopen = () => {
+  console.log('已连接到 WebSocket 服务器');
+  
+  // 请求实时数据
+  ws.send(JSON.stringify({
+    event: 'realtime-data'
+  }));
+};
+
+// 处理接收到的消息
+ws.onmessage = (event) => {
+  const data = JSON.parse(event.data);
+  console.log('收到数据:', data);
+  // {
+  //   event: 'realtime-data',
+  //   data: {
+  //     timestamp: '2024-01-01 12:00:00',
+  //     value: 75,
+  //     status: 'normal'
+  //   }
+  // }
+};
+
+// 处理错误
+ws.onerror = (error) => {
+  console.error('WebSocket 错误:', error);
+};
+
+// 处理连接关闭
+ws.onclose = () => {
+  console.log('与 WebSocket 服务器断开连接');
+};
+```
+
+#### 特性：
+- 基于事件的通信
+- 支持指定间隔自动发送数据
+- 支持 Mock.js 模板生成动态数据
+- 支持多个事件处理器
+
 ## 🤝 贡献指南
 
 1. Fork 本仓库

package/README.md

@@ -17,6 +17,7 @@ A lightweight and flexible mock server that uses JSON configuration to quickly c
 - 🛠 Customizable response schemas
 - 🎭 Integration with Mock.js for powerful data mocking
 - 📤 File upload support
+- 🔌 Real-time communication with WebSocket
 - 💡 TypeScript support
 
 ## 📦 Installation
@@ -296,6 +297,89 @@ Add schema validation for POST/PUT requests:
 }
 ```
 
+### WebSocket Support
+
+You can configure WebSocket endpoints in your `data.json`:
+
+```json
+{
+  "websocket": {
+    "enabled": true,
+    "path": "/ws",
+    "events": {
+      "realtime-data": {
+        "mock": {
+          "enabled": true,
+          "interval": 5000,  // Send data every 5 seconds
+          "template": {
+            "timestamp": "@datetime",
+            "value|1-100": 1,
+            "status|1": ["normal", "warning", "error"]
+          }
+        }
+      },
+      "user-status": {
+        "mock": {
+          "enabled": true,
+          "template": {
+            "userId|+1": 1,
+            "status|1": ["online", "offline", "away"],
+            "lastActive": "@datetime"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+#### Client Usage Example:
+
+```javascript
+// Connect to WebSocket server
+const ws = new WebSocket('ws://localhost:8080/ws');
+
+// Handle connection open
+ws.onopen = () => {
+  console.log('Connected to WebSocket server');
+  
+  // Request real-time data
+  ws.send(JSON.stringify({
+    event: 'realtime-data'
+  }));
+};
+
+// Handle incoming messages
+ws.onmessage = (event) => {
+  const data = JSON.parse(event.data);
+  console.log('Received:', data);
+  // {
+  //   event: 'realtime-data',
+  //   data: {
+  //     timestamp: '2024-01-01 12:00:00',
+  //     value: 75,
+  //     status: 'normal'
+  //   }
+  // }
+};
+
+// Handle errors
+ws.onerror = (error) => {
+  console.error('WebSocket error:', error);
+};
+
+// Handle connection close
+ws.onclose = () => {
+  console.log('Disconnected from WebSocket server');
+};
+```
+
+#### Features:
+- Event-based communication
+- Automatic data sending at specified intervals
+- Mock.js template support for dynamic data
+- Multiple event handlers
+
 ## 🤝 Contributing
 
 1. Fork the repository

package/dist/cli.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -1,6 +1,6 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-const configPath = process.argv[2] || 'data.json';
-(0, index_1.startServer)(configPath);
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const configPath = process.argv[2] || 'data.json';
+(0, index_1.startServer)(configPath);

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export declare function startServer(configPath?: string): void;
-export { MockServer } from './server';
-export * from './types';
+export declare function startServer(configPath?: string): void;
+export { MockServer } from './server';
+export * from './types';

package/dist/index.js

@@ -1,43 +1,43 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MockServer = exports.startServer = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const server_1 = require("./server");
-function startServer(configPath = 'data.json') {
-    const fullPath = path_1.default.resolve(process.cwd(), configPath);
-    try {
-        const configContent = fs_1.default.readFileSync(fullPath, 'utf-8');
-        const config = JSON.parse(configContent);
-        const server = new server_1.MockServer(config, configPath);
-        server.start();
-    }
-    catch (error) {
-        console.error('Failed to start server:', error);
-        process.exit(1);
-    }
-}
-exports.startServer = startServer;
-if (require.main === module) {
-    startServer();
-}
-var server_2 = require("./server");
-Object.defineProperty(exports, "MockServer", { enumerable: true, get: function () { return server_2.MockServer; } });
-__exportStar(require("./types"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockServer = void 0;
+exports.startServer = startServer;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const server_1 = require("./server");
+function startServer(configPath = 'data.json') {
+    const fullPath = path_1.default.resolve(process.cwd(), configPath);
+    try {
+        const configContent = fs_1.default.readFileSync(fullPath, 'utf-8');
+        const config = JSON.parse(configContent);
+        const server = new server_1.MockServer(config, configPath);
+        server.start();
+    }
+    catch (error) {
+        console.error('Failed to start server:', error);
+        process.exit(1);
+    }
+}
+if (require.main === module) {
+    startServer();
+}
+var server_2 = require("./server");
+Object.defineProperty(exports, "MockServer", { enumerable: true, get: function () { return server_2.MockServer; } });
+__exportStar(require("./types"), exports);

package/dist/server.d.ts

@@ -1,18 +1,22 @@
-import { Express } from 'express';
-import { Config } from './types';
-export declare class MockServer {
-    private app;
-    private config;
-    private configPath;
-    constructor(config: Config, configPath?: string);
-    getApp(): Express;
-    private setupMiddleware;
-    private logRequest;
-    private generateMockData;
-    private handleRequest;
-    private setupRoutes;
-    private createRoute;
-    private findRouteConfig;
-    private generateMockResponse;
-    start(): void;
-}
+import { Express } from 'express';
+import { Config } from './types';
+export declare class MockServer {
+    private app;
+    private server;
+    private wss;
+    private config;
+    private configPath;
+    constructor(config: Config, configPath?: string);
+    getApp(): Express;
+    private setupMiddleware;
+    private logRequest;
+    private generateMockData;
+    private handleRequest;
+    private setupRoutes;
+    private createRoute;
+    private findRouteConfig;
+    private generateMockResponse;
+    private setupWebSocket;
+    start(): void;
+    close(): void;
+}

package/dist/server.js

@@ -1,138 +1,205 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MockServer = void 0;
-const mockjs_1 = __importDefault(require("mockjs"));
-const express_1 = __importDefault(require("express"));
-const cors_1 = __importDefault(require("cors"));
-class MockServer {
-    constructor(config, configPath = 'data.json') {
-        this.app = (0, express_1.default)();
-        this.logRequest = (req, res, next) => {
-            const startTime = Date.now();
-            const requestId = Math.random().toString(36).substring(7);
-            console.log(`[${new Date().toISOString()}] Request ${requestId}:`);
-            console.log(`  Method: ${req.method}`);
-            console.log(`  URL: ${req.url}`);
-            console.log(`  Query Params: ${JSON.stringify(req.query)}`);
-            console.log(`  Body: ${JSON.stringify(req.body)}`);
-            res.on('finish', () => {
-                const duration = Date.now() - startTime;
-                console.log(`[${new Date().toISOString()}] Response ${requestId}:`);
-                console.log(`  Status: ${res.statusCode}`);
-                console.log(`  Duration: ${duration}ms`);
-                console.log('----------------------------------------');
-            });
-            next();
-        };
-        this.config = config;
-        this.configPath = configPath;
-        this.setupMiddleware();
-        this.setupRoutes();
-    }
-    getApp() {
-        return this.app;
-    }
-    setupMiddleware() {
-        this.app.use((0, cors_1.default)());
-        this.app.use(express_1.default.json());
-        this.app.use('/uploads', express_1.default.static('uploads'));
-        this.app.use(this.logRequest);
-    }
-    generateMockData(config) {
-        try {
-            if (config.mock?.enabled && config.mock.template) {
-                const { total, template } = config.mock;
-                return mockjs_1.default.mock({
-                    [`data|${total}`]: [template]
-                }).data;
-            }
-            return config.response;
-        }
-        catch (error) {
-            console.error('Error generating mock data:', error);
-            return config.response;
-        }
-    }
-    handleRequest(config) {
-        return (req, res) => {
-            try {
-                let responseData = this.generateMockData(config);
-                if (config.pagination?.enabled && Array.isArray(responseData)) {
-                    const page = parseInt(req.query.page) || 1;
-                    const pageSize = parseInt(req.query.pageSize) || config.pagination.pageSize;
-                    const startIndex = (page - 1) * pageSize;
-                    const endIndex = startIndex + pageSize;
-                    const paginatedData = responseData.slice(startIndex, endIndex);
-                    res.header('X-Total-Count', responseData.length.toString());
-                    responseData = paginatedData;
-                }
-                res.json(responseData);
-            }
-            catch (error) {
-                console.error('Error handling request:', error);
-                res.status(500).json({ error: 'Internal server error' });
-            }
-        };
-    }
-    setupRoutes() {
-        this.config.routes.forEach((route) => {
-            Object.entries(route.methods).forEach(([method, methodConfig]) => {
-                this.createRoute(route.path, method, methodConfig);
-            });
-        });
-    }
-    createRoute(path, method, config) {
-        const fullPath = `${this.config.server.baseProxy}${path}`;
-        console.log(`创建路由: ${method.toUpperCase()} ${fullPath}`);
-        switch (method.toLowerCase()) {
-            case 'get':
-                this.app.get(fullPath, this.handleRequest(config));
-                break;
-            case 'post':
-                if (path === '/upload/avatar') {
-                    // 对于文件上传路由，使用特殊处理
-                    this.app.post(fullPath, (req, res) => {
-                        const mockResponse = this.generateMockData(config);
-                        res.json(mockResponse);
-                    });
-                }
-                else {
-                    this.app.post(fullPath, this.handleRequest(config));
-                }
-                break;
-            case 'put':
-                this.app.put(`${fullPath}/:id`, this.handleRequest(config));
-                break;
-            case 'delete':
-                this.app.delete(`${fullPath}/:id`, this.handleRequest(config));
-                break;
-        }
-    }
-    findRouteConfig(path, method) {
-        const route = this.config.routes.find(r => r.path === path);
-        return route?.methods[method] || null;
-    }
-    generateMockResponse(config) {
-        if (config.mock?.enabled && config.mock.template) {
-            return mockjs_1.default.mock(config.mock.template);
-        }
-        return config.response;
-    }
-    start() {
-        this.app.listen(this.config.server.port, () => {
-            console.log(`Mock 服务器已启动:`);
-            console.log(`- 地址: http://localhost:${this.config.server.port}`);
-            console.log(`- 基础路径: ${this.config.server.baseProxy}`);
-            console.log('可用的接口:');
-            this.config.routes.forEach(route => {
-                Object.keys(route.methods).forEach(method => {
-                    console.log(`  ${method.toUpperCase()} http://localhost:${this.config.server.port}${this.config.server.baseProxy}${route.path}`);
-                });
-            });
-        });
-    }
-}
-exports.MockServer = MockServer;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockServer = void 0;
+const mockjs_1 = __importDefault(require("mockjs"));
+const express_1 = __importDefault(require("express"));
+const cors_1 = __importDefault(require("cors"));
+const ws_1 = require("ws");
+const http_1 = __importDefault(require("http"));
+class MockServer {
+    constructor(config, configPath = 'data.json') {
+        this.app = (0, express_1.default)();
+        this.wss = null;
+        this.logRequest = (req, res, next) => {
+            const startTime = Date.now();
+            const requestId = Math.random().toString(36).substring(7);
+            console.log(`[${new Date().toISOString()}] Request ${requestId}:`);
+            console.log(`  Method: ${req.method}`);
+            console.log(`  URL: ${req.url}`);
+            console.log(`  Query Params: ${JSON.stringify(req.query)}`);
+            console.log(`  Body: ${JSON.stringify(req.body)}`);
+            res.on('finish', () => {
+                const duration = Date.now() - startTime;
+                console.log(`[${new Date().toISOString()}] Response ${requestId}:`);
+                console.log(`  Status: ${res.statusCode}`);
+                console.log(`  Duration: ${duration}ms`);
+                console.log('----------------------------------------');
+            });
+            next();
+        };
+        this.config = config;
+        this.configPath = configPath;
+        this.server = http_1.default.createServer(this.app);
+        this.setupMiddleware();
+        this.setupRoutes();
+        if (config.websocket?.enabled) {
+            this.setupWebSocket();
+        }
+    }
+    getApp() {
+        return this.app;
+    }
+    setupMiddleware() {
+        this.app.use((0, cors_1.default)());
+        this.app.use(express_1.default.json());
+        this.app.use('/uploads', express_1.default.static('uploads'));
+        this.app.use(this.logRequest);
+    }
+    generateMockData(config) {
+        try {
+            if (config.mock?.enabled && config.mock.template) {
+                const { total, template } = config.mock;
+                return mockjs_1.default.mock({
+                    [`data|${total}`]: [template]
+                }).data;
+            }
+            return config.response;
+        }
+        catch (error) {
+            console.error('Error generating mock data:', error);
+            return config.response;
+        }
+    }
+    handleRequest(config) {
+        return (req, res) => {
+            try {
+                let responseData = this.generateMockData(config);
+                if (config.pagination?.enabled && Array.isArray(responseData)) {
+                    const page = parseInt(req.query.page) || 1;
+                    const pageSize = parseInt(req.query.pageSize) || config.pagination.pageSize;
+                    const startIndex = (page - 1) * pageSize;
+                    const endIndex = startIndex + pageSize;
+                    const paginatedData = responseData.slice(startIndex, endIndex);
+                    res.header('X-Total-Count', responseData.length.toString());
+                    responseData = paginatedData;
+                }
+                res.json(responseData);
+            }
+            catch (error) {
+                console.error('Error handling request:', error);
+                res.status(500).json({ error: 'Internal server error' });
+            }
+        };
+    }
+    setupRoutes() {
+        this.config.routes.forEach((route) => {
+            Object.entries(route.methods).forEach(([method, methodConfig]) => {
+                this.createRoute(route.path, method, methodConfig);
+            });
+        });
+    }
+    createRoute(path, method, config) {
+        const fullPath = `${this.config.server.baseProxy}${path}`;
+        console.log(`创建路由: ${method.toUpperCase()} ${fullPath}`);
+        switch (method.toLowerCase()) {
+            case 'get':
+                this.app.get(fullPath, this.handleRequest(config));
+                break;
+            case 'post':
+                if (path === '/upload/avatar') {
+                    // 对于文件上传路由，使用特殊处理
+                    this.app.post(fullPath, (req, res) => {
+                        const mockResponse = this.generateMockData(config);
+                        res.json(mockResponse);
+                    });
+                }
+                else {
+                    this.app.post(fullPath, this.handleRequest(config));
+                }
+                break;
+            case 'put':
+                this.app.put(`${fullPath}/:id`, this.handleRequest(config));
+                break;
+            case 'delete':
+                this.app.delete(`${fullPath}/:id`, this.handleRequest(config));
+                break;
+        }
+    }
+    findRouteConfig(path, method) {
+        const route = this.config.routes.find(r => r.path === path);
+        return route?.methods[method] || null;
+    }
+    generateMockResponse(config) {
+        if (config.mock?.enabled && config.mock.template) {
+            return mockjs_1.default.mock(config.mock.template);
+        }
+        return config.response;
+    }
+    setupWebSocket() {
+        if (!this.config.websocket)
+            return;
+        this.wss = new ws_1.Server({
+            server: this.server,
+            path: this.config.websocket.path
+        });
+        this.wss.on('connection', (ws) => {
+            console.log('WebSocket client connected');
+            // 处理客户端消息
+            ws.on('message', (message) => {
+                try {
+                    const data = JSON.parse(message.toString());
+                    const eventConfig = this.config.websocket?.events?.[data.event];
+                    if (eventConfig?.mock.enabled) {
+                        const response = mockjs_1.default.mock(eventConfig.mock.template);
+                        ws.send(JSON.stringify({
+                            event: data.event,
+                            data: response
+                        }));
+                    }
+                }
+                catch (error) {
+                    console.error('Error handling WebSocket message:', error);
+                }
+            });
+            // 设置自动发送数据的定时器
+            if (this.config.websocket && this.config.websocket.events) {
+                Object.entries(this.config.websocket.events).forEach(([event, config]) => {
+                    if (config.mock.interval) {
+                        setInterval(() => {
+                            const response = mockjs_1.default.mock(config.mock.template);
+                            ws.send(JSON.stringify({
+                                event,
+                                data: response
+                            }));
+                        }, config.mock.interval);
+                    }
+                });
+            }
+            ws.on('close', () => {
+                // 移除日志，避免测试完成后的日志输出
+                // console.log('WebSocket client disconnected');
+            });
+        });
+    }
+    start() {
+        this.server.listen(this.config.server.port, () => {
+            console.log(`Mock 服务器已启动:`);
+            console.log(`- HTTP 地址: http://localhost:${this.config.server.port}`);
+            if (this.config.websocket?.enabled) {
+                console.log(`- WebSocket 地址: ws://localhost:${this.config.server.port}${this.config.websocket.path}`);
+            }
+            console.log(`- 基础路径: ${this.config.server.baseProxy}`);
+            console.log('可用的接口:');
+            this.config.routes.forEach(route => {
+                Object.keys(route.methods).forEach(method => {
+                    console.log(`  ${method.toUpperCase()} http://localhost:${this.config.server.port}${this.config.server.baseProxy}${route.path}`);
+                });
+            });
+        });
+    }
+    close() {
+        // 关闭所有 WebSocket 连接
+        if (this.wss) {
+            this.wss.clients.forEach(client => {
+                client.close();
+            });
+            this.wss.close();
+        }
+        // 关闭 HTTP 服务器
+        this.server.close();
+    }
+}
+exports.MockServer = MockServer;

package/dist/types.d.ts

@@ -1,31 +1,45 @@
-export interface ServerConfig {
-    port: number;
-    baseProxy: string;
-}
-export interface PaginationConfig {
-    enabled: boolean;
-    pageSize: number;
-    totalCount: number;
-}
-export interface MockConfig {
-    enabled: boolean;
-    total?: number;
-    template: Record<string, any>;
-}
-export interface MethodConfig {
-    type?: 'array' | 'object';
-    response?: any;
-    mock?: MockConfig;
-    pagination?: PaginationConfig;
-    requestSchema?: Record<string, string>;
-}
-export interface RouteConfig {
-    path: string;
-    methods: {
-        [key: string]: MethodConfig;
-    };
-}
-export interface Config {
-    server: ServerConfig;
-    routes: RouteConfig[];
-}
+export interface ServerConfig {
+    port: number;
+    baseProxy: string;
+}
+export interface PaginationConfig {
+    enabled: boolean;
+    pageSize: number;
+    totalCount: number;
+}
+export interface MockConfig {
+    enabled: boolean;
+    total?: number;
+    template: Record<string, any>;
+}
+export interface MethodConfig {
+    type?: 'array' | 'object';
+    response?: any;
+    mock?: MockConfig;
+    pagination?: PaginationConfig;
+    requestSchema?: Record<string, string>;
+}
+export interface RouteConfig {
+    path: string;
+    methods: {
+        [key: string]: MethodConfig;
+    };
+}
+export interface WebSocketConfig {
+    enabled: boolean;
+    path: string;
+    events?: {
+        [key: string]: {
+            mock: {
+                enabled: boolean;
+                template: Record<string, any>;
+                interval?: number;
+            };
+        };
+    };
+}
+export interface Config {
+    server: ServerConfig;
+    routes: RouteConfig[];
+    websocket?: WebSocketConfig;
+}

package/dist/types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-api-mocker",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "A mock server based on JSON configuration",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -47,7 +47,8 @@
     "cors": "^2.8.5",
     "express": "^4.17.1",
     "mockjs": "^1.1.0",
-    "multer": "^1.4.5-lts.1"
+    "multer": "^1.4.5-lts.1",
+    "ws": "^8.18.0"
   },
   "devDependencies": {
     "@types/cors": "^2.8.13",
@@ -57,6 +58,7 @@
     "@types/multer": "^1.4.12",
     "@types/node": "^16.18.0",
     "@types/supertest": "^6.0.2",
+    "@types/ws": "^8.5.13",
     "jest": "^27.5.1",
     "nodemon": "^2.0.22",
     "supertest": "^7.0.0",