@gameap/debug 0.2.17 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gameap/debug",
-  "version": "0.2.17",
+  "version": "0.3.0",
   "type": "module",
   "description": "Debug harness for GameAP plugin development with mock API",
   "scripts": {
@@ -26,7 +26,7 @@
   ],
   "dependencies": {
     "@gameap/plugin-sdk": "^0.2.0",
-    "@gameap/frontend": "4.1.0-dev8",
+    "@gameap/frontend": "4.1.0-dev9",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "@tailwindcss/postcss": "^4.1.0",
     "@vitejs/plugin-vue": "^6.0.1",

package/src/main.ts

@@ -8,7 +8,20 @@
 // Import frontend styles (bundled in vendor directory)
 import '../vendor/frontend.css'
 
-import { startMockServiceWorker, setPluginContent, updateDebugState } from './mocks/browser'
+import {
+    startMockServiceWorker,
+    setPluginContent,
+    updateDebugState,
+    registerMockHandlers,
+    resetMockHandlers,
+    http,
+    HttpResponse,
+    delay
+} from './mocks/browser'
+import { mockServersList, type ServerListItem } from './mocks/servers'
+import { userMocks } from './mocks/users'
+import type { UserData } from '@gameap/plugin-sdk'
+import type { RequestHandler } from 'msw'
 
 // Declare window globals for plugin compatibility
 declare global {
@@ -23,6 +36,21 @@ declare global {
             updateDebugState: typeof updateDebugState
             setPluginContent: typeof setPluginContent
             loadPlugin: (js: string, css?: string) => void
+            registerMockHandlers: (handlers: RequestHandler[]) => void
+            resetMockHandlers: () => void
+            msw: {
+                http: typeof http
+                HttpResponse: typeof HttpResponse
+                delay: typeof delay
+            }
+            mockData: {
+                addServer: (server: Partial<ServerListItem>) => ServerListItem
+                updateServer: (id: number, updates: Partial<ServerListItem>) => void
+                removeServer: (id: number) => void
+                getServers: () => ServerListItem[]
+                addUser: (key: string, user: UserData) => void
+                getUsers: () => Record<string, UserData>
+            }
         }
     }
 }
@@ -108,7 +136,69 @@ async function init() {
         setPluginContent(js, css)
     }
 
-    // Start MSW
+    // Expose debug utilities globally BEFORE starting MSW
+    // so plugins can register handlers in onInit()
+    window.gameapDebug = {
+        updateDebugState,
+        setPluginContent,
+        loadPlugin: (newJs: string, newCss?: string) => {
+            setPluginContent(newJs, newCss || '')
+            console.log('[Debug] Plugin content updated, reload to apply')
+        },
+        registerMockHandlers,
+        resetMockHandlers,
+        msw: {
+            http,
+            HttpResponse,
+            delay,
+        },
+        mockData: {
+            addServer: (server: Partial<ServerListItem>) => {
+                const id = Math.max(...mockServersList.map(s => s.id), 0) + 1
+                const newServer: ServerListItem = {
+                    id,
+                    enabled: true,
+                    installed: 1,
+                    blocked: false,
+                    name: `Server ${id}`,
+                    game_id: 'minecraft',
+                    ds_id: 1,
+                    game_mod_id: 1,
+                    expires: null,
+                    server_ip: '127.0.0.1',
+                    server_port: 25565 + id,
+                    query_port: 25565 + id,
+                    rcon_port: 25575 + id,
+                    process_active: false,
+                    last_process_check: new Date().toISOString(),
+                    game: { code: 'minecraft', name: 'Minecraft', engine: 'Minecraft', engine_version: '1' },
+                    online: false,
+                    ...server,
+                }
+                mockServersList.push(newServer)
+                return newServer
+            },
+            updateServer: (id: number, updates: Partial<ServerListItem>) => {
+                const idx = mockServersList.findIndex(s => s.id === id)
+                if (idx !== -1) {
+                    Object.assign(mockServersList[idx], updates)
+                }
+            },
+            removeServer: (id: number) => {
+                const idx = mockServersList.findIndex(s => s.id === id)
+                if (idx !== -1) {
+                    mockServersList.splice(idx, 1)
+                }
+            },
+            getServers: () => [...mockServersList],
+            addUser: (key: string, user: UserData) => {
+                userMocks[key] = user
+            },
+            getUsers: () => ({ ...userMocks }),
+        },
+    }
+
+    // Start MSW (will apply any pre-registered handlers)
     console.log('[Debug] Starting Mock Service Worker...')
     await startMockServiceWorker()
     console.log('[Debug] MSW started successfully')
@@ -119,16 +209,6 @@ async function init() {
     // Load translations AFTER MSW starts (so MSW can intercept the request)
     await loadTranslations()
 
-    // Expose debug utilities globally
-    window.gameapDebug = {
-        updateDebugState,
-        setPluginContent,
-        loadPlugin: (newJs: string, newCss?: string) => {
-            setPluginContent(newJs, newCss || '')
-            console.log('[Debug] Plugin content updated, reload to apply')
-        },
-    }
-
     // Now load the real GameAP frontend
     console.log('[Debug] Loading GameAP frontend...')
 

package/src/mocks/README.md

@@ -66,3 +66,91 @@ await startMockServiceWorker()
 ```
 
 The debug panel (in main.ts) provides UI controls for switching user types, adjusting network delay, and changing locale.
+
+## Plugin Mock API
+
+Plugins can register custom mock handlers for their API endpoints. This is useful for:
+- Adding mock endpoints for plugin-specific APIs
+- Overriding default handler responses
+- Testing different API scenarios
+
+### Registering Mock Handlers
+
+In your plugin's `onInit()` hook:
+
+```typescript
+export const myPlugin = {
+    id: 'my-plugin',
+    name: 'My Plugin',
+    version: '1.0.0',
+
+    onInit() {
+        if (window.gameapDebug) {
+            const { http, HttpResponse, delay } = window.gameapDebug.msw
+
+            window.gameapDebug.registerMockHandlers([
+                http.get('/api/plugins/my-plugin/data', async () => {
+                    await delay(100)
+                    return HttpResponse.json({
+                        items: [{ id: 1, name: 'Item 1' }]
+                    })
+                }),
+            ])
+        }
+    },
+}
+```
+
+### MSW Utilities
+
+The `window.gameapDebug.msw` object exposes:
+
+| Utility | Description |
+|---------|-------------|
+| `http` | HTTP method handlers (`http.get()`, `http.post()`, etc.) |
+| `HttpResponse` | Response builder for mock responses |
+| `delay` | Async delay function for simulating network latency |
+
+### Mock Data Utilities
+
+Manipulate mock data programmatically via `window.gameapDebug.mockData`:
+
+```javascript
+// Add a custom server
+const newServer = mockData.addServer({
+    name: 'My Test Server',
+    game_id: 'minecraft',
+    process_active: true
+})
+
+// Update existing server
+mockData.updateServer(1, { name: 'Updated Name' })
+
+// Remove a server
+mockData.removeServer(3)
+
+// Get all servers
+const servers = mockData.getServers()
+
+// Add a custom user type
+mockData.addUser('moderator', {
+    id: 3,
+    login: 'mod',
+    name: 'Moderator',
+    roles: ['moderator'],
+    isAdmin: false,
+    isAuthenticated: true
+})
+```
+
+### Resetting Handlers
+
+To restore original handlers (remove all plugin handlers):
+
+```javascript
+window.gameapDebug.resetMockHandlers()
+```
+
+### Handler Priority
+
+Plugin handlers are prepended and checked **first** before default handlers, allowing overrides.

package/src/mocks/browser.ts

@@ -1,22 +1,57 @@
 import { setupWorker } from 'msw/browser'
+import { http, HttpResponse, delay, type RequestHandler } from 'msw'
 import { handlers, debugState, setPluginContent } from './handlers'
 
+// Store initial handlers for reset capability
+const initialHandlers = [...handlers]
+
+// Queue for handlers registered before MSW starts
+let pendingHandlers: RequestHandler[] = []
+let workerStarted = false
+
 export const worker = setupWorker(...handlers)
 
 // Export debug state and utilities for external control
 export { debugState, setPluginContent }
 
+// Export MSW utilities for plugin use
+export { http, HttpResponse, delay }
+
 // Helper to update debug state
 export function updateDebugState(updates: Partial<typeof debugState>) {
     Object.assign(debugState, updates)
 }
 
+// Register custom mock handlers (prepends to take priority)
+export function registerMockHandlers(customHandlers: RequestHandler[]) {
+    if (!workerStarted) {
+        pendingHandlers.push(...customHandlers)
+    } else {
+        worker.use(...customHandlers)
+    }
+}
+
+// Reset handlers to initial state (removes all plugin handlers)
+export function resetMockHandlers() {
+    worker.resetHandlers(...initialHandlers)
+}
+
 // Start the worker
 export async function startMockServiceWorker() {
-    return worker.start({
-        onUnhandledRequest: 'bypass', // Don't warn about unhandled requests
+    const result = await worker.start({
+        onUnhandledRequest: 'bypass',
         serviceWorker: {
             url: '/mockServiceWorker.js',
         },
     })
+
+    workerStarted = true
+
+    // Apply any handlers that were registered before start
+    if (pendingHandlers.length > 0) {
+        worker.use(...pendingHandlers)
+        pendingHandlers = []
+    }
+
+    return result
 }

package/src/mocks/translations-en.json

@@ -361,6 +361,16 @@
     "disable_success_msg": "Module disabled successfully",
     "remove_success_msg": "Module removed successfully"
   },
+  "plugins": {
+    "plugins": "Plugins",
+    "title_list": "Plugin List",
+    "installed": "Installed",
+    "name": "Plugin name",
+    "install": "Install",
+    "update": "Update",
+    "install_success_msg": "Plugin installed successfully",
+    "remove_success_msg": "Plugin removed successfully"
+  },
   "navbar": {
     "main": "Home",
     "logs": "Logs",

package/src/mocks/translations-ru.json

@@ -362,6 +362,16 @@
     "disable_success_msg": "Модуль успешно выключен",
     "remove_success_msg": "Модуль успешно удалён"
   },
+  "plugins": {
+    "plugins": "Плагины",
+    "title_list": "Список плагинов",
+    "installed": "Установленные",
+    "name": "Имя плагина",
+    "install": "Установить",
+    "update": "Обновить",
+    "install_success_msg": "Плагин успешно установлен",
+    "remove_success_msg": "Плагин успешно удалён"
+  },
   "navbar": {
     "main": "Главная",
     "logs": "Логи",