@forestadmin/mcp-server 0.1.0

package/dist/test-utils/mock-server.d.ts

@@ -0,0 +1,62 @@
+type MockRouteHandler<T> = T | ((url: string, options?: RequestInit) => T);
+/**
+ * Mock server class for mocking fetch requests to specific routes
+ * Also intercepts superagent requests used by forestadmin-client
+ */
+export default class MockServer {
+    private routes;
+    private mockFn;
+    private superagentMocked;
+    constructor();
+    /**
+     * Setup superagent mocking to intercept HTTP requests made by forestadmin-client
+     */
+    setupSuperagentMock(): void;
+    /**
+     * Restore original superagent methods
+     */
+    restoreSuperagent(): void;
+    private handleSuperagentRequest;
+    /**
+     * Register a route with a JSON payload or a function that returns a payload
+     */
+    route<T>(pattern: string | RegExp, response: MockRouteHandler<T>, options?: {
+        method?: string;
+        status?: number;
+    }): this;
+    /**
+     * Register a GET route
+     */
+    get<T>(pattern: string | RegExp, response: MockRouteHandler<T>, status?: number): this;
+    /**
+     * Register a POST route
+     */
+    post<T>(pattern: string | RegExp, response: MockRouteHandler<T>, status?: number): this;
+    /**
+     * Register a PUT route
+     */
+    put<T>(pattern: string | RegExp, response: MockRouteHandler<T>, status?: number): this;
+    /**
+     * Register a DELETE route
+     */
+    delete<T>(pattern: string | RegExp, response: MockRouteHandler<T>, status?: number): this;
+    /**
+     * Register a PATCH route
+     */
+    patch<T>(pattern: string | RegExp, response: MockRouteHandler<T>, status?: number): this;
+    /**
+     * Get the mock function to use as global.fetch
+     */
+    get fetch(): jest.Mock;
+    /**
+     * Clear mock call history
+     */
+    clear(): void;
+    /**
+     * Reset all routes
+     */
+    reset(): void;
+    private handleRequest;
+}
+export {};
+//# sourceMappingURL=mock-server.d.ts.map

package/dist/test-utils/mock-server.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Store original superagent methods for restoration
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let originalSuperagent = null;
+/**
+ * Mock server class for mocking fetch requests to specific routes
+ * Also intercepts superagent requests used by forestadmin-client
+ */
+class MockServer {
+    constructor() {
+        this.routes = [];
+        this.superagentMocked = false;
+        this.mockFn = jest.fn((url, options) => {
+            return this.handleRequest(url, options);
+        });
+    }
+    /**
+     * Setup superagent mocking to intercept HTTP requests made by forestadmin-client
+     */
+    setupSuperagentMock() {
+        if (this.superagentMocked)
+            return;
+        // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, global-require
+        const superagent = require('superagent');
+        if (!originalSuperagent) {
+            originalSuperagent = { ...superagent };
+        }
+        // Create mock request builder using arrow function to preserve 'this'
+        const createMockRequest = (method, reqUrl) => {
+            let headers = {};
+            let body = null;
+            const mockRequest = {
+                set: (key, value) => {
+                    if (typeof key === 'object') {
+                        headers = { ...headers, ...key };
+                    }
+                    else if (value !== undefined) {
+                        headers[key] = value;
+                    }
+                    return mockRequest;
+                },
+                timeout: () => mockRequest,
+                send: async (data) => {
+                    body = data;
+                    return this.handleSuperagentRequest(method, reqUrl, headers, body);
+                },
+            };
+            return mockRequest;
+        };
+        // Override superagent methods
+        superagent.get = (reqUrl) => createMockRequest('GET', reqUrl);
+        superagent.post = (reqUrl) => createMockRequest('POST', reqUrl);
+        superagent.put = (reqUrl) => createMockRequest('PUT', reqUrl);
+        superagent.delete = (reqUrl) => createMockRequest('DELETE', reqUrl);
+        this.superagentMocked = true;
+    }
+    /**
+     * Restore original superagent methods
+     */
+    restoreSuperagent() {
+        if (!this.superagentMocked || !originalSuperagent)
+            return;
+        // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, global-require
+        const superagent = require('superagent');
+        Object.assign(superagent, originalSuperagent);
+        this.superagentMocked = false;
+    }
+    async handleSuperagentRequest(method, reqUrl, headers, body) {
+        for (const route of this.routes) {
+            const patternMatch = typeof route.pattern === 'string'
+                ? reqUrl.includes(route.pattern)
+                : route.pattern.test(reqUrl);
+            const methodMatch = !route.method || route.method.toUpperCase() === method.toUpperCase();
+            if (patternMatch && methodMatch) {
+                const payload = typeof route.response === 'function'
+                    ? route.response(reqUrl, {
+                        method,
+                        headers: headers,
+                        body: body,
+                    })
+                    : route.response;
+                const status = route.status ?? 200;
+                return { body: payload, status };
+            }
+        }
+        // No match found - throw error like superagent would for 404
+        const error = new Error(`Not Found: ${method} ${reqUrl}`);
+        error.response = {
+            status: 404,
+            body: { errors: [{ detail: 'Not found' }] },
+        };
+        throw error;
+    }
+    /**
+     * Register a route with a JSON payload or a function that returns a payload
+     */
+    route(pattern, response, options = {}) {
+        this.routes.push({
+            pattern,
+            method: options.method,
+            response,
+            status: options.status ?? 200,
+        });
+        return this;
+    }
+    /**
+     * Register a GET route
+     */
+    get(pattern, response, status) {
+        return this.route(pattern, response, { method: 'GET', status });
+    }
+    /**
+     * Register a POST route
+     */
+    post(pattern, response, status) {
+        return this.route(pattern, response, { method: 'POST', status });
+    }
+    /**
+     * Register a PUT route
+     */
+    put(pattern, response, status) {
+        return this.route(pattern, response, { method: 'PUT', status });
+    }
+    /**
+     * Register a DELETE route
+     */
+    delete(pattern, response, status) {
+        return this.route(pattern, response, { method: 'DELETE', status });
+    }
+    /**
+     * Register a PATCH route
+     */
+    patch(pattern, response, status) {
+        return this.route(pattern, response, { method: 'PATCH', status });
+    }
+    /**
+     * Get the mock function to use as global.fetch
+     */
+    get fetch() {
+        return this.mockFn;
+    }
+    /**
+     * Clear mock call history
+     */
+    clear() {
+        this.mockFn.mockClear();
+    }
+    /**
+     * Reset all routes
+     */
+    reset() {
+        this.routes = [];
+        this.mockFn.mockClear();
+    }
+    handleRequest(url, options) {
+        const urlString = url.toString();
+        const method = options?.method || 'GET';
+        for (const route of this.routes) {
+            const patternMatch = typeof route.pattern === 'string'
+                ? urlString.includes(route.pattern)
+                : route.pattern.test(urlString);
+            const methodMatch = !route.method || route.method.toUpperCase() === method.toUpperCase();
+            if (patternMatch && methodMatch) {
+                const payload = typeof route.response === 'function'
+                    ? route.response(url, options)
+                    : route.response;
+                const status = route.status ?? 200;
+                return Promise.resolve({
+                    ok: status >= 200 && status < 300,
+                    status,
+                    statusText: status === 200 ? 'OK' : 'Error',
+                    json: () => Promise.resolve(payload),
+                });
+            }
+        }
+        // Default: return 404 for unknown endpoints
+        return Promise.resolve({
+            ok: false,
+            status: 404,
+            statusText: 'Not Found',
+            json: () => Promise.resolve({ error: 'Not found' }),
+        });
+    }
+}
+exports.default = MockServer;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9jay1zZXJ2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdGVzdC11dGlscy9tb2NrLXNlcnZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQVNBLG9EQUFvRDtBQUNwRCw4REFBOEQ7QUFDOUQsSUFBSSxrQkFBa0IsR0FBUSxJQUFJLENBQUM7QUFFbkM7OztHQUdHO0FBQ0gsTUFBcUIsVUFBVTtJQUs3QjtRQUpRLFdBQU0sR0FBeUIsRUFBRSxDQUFDO1FBRWxDLHFCQUFnQixHQUFHLEtBQUssQ0FBQztRQUcvQixJQUFJLENBQUMsTUFBTSxHQUFHLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxHQUFXLEVBQUUsT0FBcUIsRUFBRSxFQUFFO1lBQzNELE9BQU8sSUFBSSxDQUFDLGFBQWEsQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDMUMsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxtQkFBbUI7UUFDakIsSUFBSSxJQUFJLENBQUMsZ0JBQWdCO1lBQUUsT0FBTztRQUVsQyxxSEFBcUg7UUFDckgsTUFBTSxVQUFVLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBRXpDLElBQUksQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1lBQ3hCLGtCQUFrQixHQUFHLEVBQUUsR0FBRyxVQUFVLEVBQUUsQ0FBQztRQUN6QyxDQUFDO1FBRUQsc0VBQXNFO1FBQ3RFLE1BQU0saUJBQWlCLEdBQUcsQ0FBQyxNQUFjLEVBQUUsTUFBYyxFQUFFLEVBQUU7WUFDM0QsSUFBSSxPQUFPLEdBQTJCLEVBQUUsQ0FBQztZQUN6QyxJQUFJLElBQUksR0FBWSxJQUFJLENBQUM7WUFFekIsTUFBTSxXQUFXLEdBQUc7Z0JBQ2xCLEdBQUcsRUFBRSxDQUFDLEdBQW9DLEVBQUUsS0FBYyxFQUFFLEVBQUU7b0JBQzVELElBQUksT0FBTyxHQUFHLEtBQUssUUFBUSxFQUFFLENBQUM7d0JBQzVCLE9BQU8sR0FBRyxFQUFFLEdBQUcsT0FBTyxFQUFFLEdBQUcsR0FBRyxFQUFFLENBQUM7b0JBQ25DLENBQUM7eUJBQU0sSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7d0JBQy9CLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxLQUFLLENBQUM7b0JBQ3ZCLENBQUM7b0JBRUQsT0FBTyxXQUFXLENBQUM7Z0JBQ3JCLENBQUM7Z0JBQ0QsT0FBTyxFQUFFLEdBQUcsRUFBRSxDQUFDLFdBQVc7Z0JBQzFCLElBQUksRUFBRSxLQUFLLEVBQUUsSUFBYyxFQUFFLEVBQUU7b0JBQzdCLElBQUksR0FBRyxJQUFJLENBQUM7b0JBRVosT0FBTyxJQUFJLENBQUMsdUJBQXVCLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ3JFLENBQUM7YUFDRixDQUFDO1lBRUYsT0FBTyxXQUFXLENBQUM7UUFDckIsQ0FBQyxDQUFDO1FBRUYsOEJBQThCO1FBQzlCLFVBQVUsQ0FBQyxHQUFHLEdBQUcsQ0FBQyxNQUFjLEVBQUUsRUFBRSxDQUFDLGlCQUFpQixDQUFDLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztRQUN0RSxVQUFVLENBQUMsSUFBSSxHQUFHLENBQUMsTUFBYyxFQUFFLEVBQUUsQ0FBQyxpQkFBaUIsQ0FBQyxNQUFNLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDeEUsVUFBVSxDQUFDLEdBQUcsR0FBRyxDQUFDLE1BQWMsRUFBRSxFQUFFLENBQUMsaUJBQWlCLENBQUMsS0FBSyxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQ3RFLFVBQVUsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxNQUFjLEVBQUUsRUFBRSxDQUFDLGlCQUFpQixDQUFDLFFBQVEsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUU1RSxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsSUFBSSxDQUFDO0lBQy9CLENBQUM7SUFFRDs7T0FFRztJQUNILGlCQUFpQjtRQUNmLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLElBQUksQ0FBQyxrQkFBa0I7WUFBRSxPQUFPO1FBRTFELHFIQUFxSDtRQUNySCxNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7UUFFekMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxVQUFVLEVBQUUsa0JBQWtCLENBQUMsQ0FBQztRQUM5QyxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsS0FBSyxDQUFDO0lBQ2hDLENBQUM7SUFFTyxLQUFLLENBQUMsdUJBQXVCLENBQ25DLE1BQWMsRUFDZCxNQUFjLEVBQ2QsT0FBK0IsRUFDL0IsSUFBYTtRQUViLEtBQUssTUFBTSxLQUFLLElBQUksSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ2hDLE1BQU0sWUFBWSxHQUNoQixPQUFPLEtBQUssQ0FBQyxPQUFPLEtBQUssUUFBUTtnQkFDL0IsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQztnQkFDaEMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBRWpDLE1BQU0sV0FBVyxHQUFHLENBQUMsS0FBSyxDQUFDLE1BQU0sSUFBSSxLQUFLLENBQUMsTUFBTSxDQUFDLFdBQVcsRUFBRSxLQUFLLE1BQU0sQ0FBQyxXQUFXLEVBQUUsQ0FBQztZQUV6RixJQUFJLFlBQVksSUFBSSxXQUFXLEVBQUUsQ0FBQztnQkFDaEMsTUFBTSxPQUFPLEdBQ1gsT0FBTyxLQUFLLENBQUMsUUFBUSxLQUFLLFVBQVU7b0JBQ2xDLENBQUMsQ0FBRSxLQUFLLENBQUMsUUFBNEQsQ0FBQyxNQUFNLEVBQUU7d0JBQzFFLE1BQU07d0JBQ04sT0FBTyxFQUFFLE9BQWlDO3dCQUMxQyxJQUFJLEVBQUUsSUFBZ0I7cUJBQ3ZCLENBQUM7b0JBQ0osQ0FBQyxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUM7Z0JBRXJCLE1BQU0sTUFBTSxHQUFHLEtBQUssQ0FBQyxNQUFNLElBQUksR0FBRyxDQUFDO2dCQUVuQyxPQUFPLEVBQUUsSUFBSSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsQ0FBQztZQUNuQyxDQUFDO1FBQ0gsQ0FBQztRQUVELDZEQUE2RDtRQUM3RCxNQUFNLEtBQUssR0FBRyxJQUFJLEtBQUssQ0FBQyxjQUFjLE1BQU0sSUFBSSxNQUFNLEVBQUUsQ0FFdkQsQ0FBQztRQUNGLEtBQUssQ0FBQyxRQUFRLEdBQUc7WUFDZixNQUFNLEVBQUUsR0FBRztZQUNYLElBQUksRUFBRSxFQUFFLE1BQU0sRUFBRSxDQUFDLEVBQUUsTUFBTSxFQUFFLFdBQVcsRUFBRSxDQUFDLEVBQUU7U0FDNUMsQ0FBQztRQUNGLE1BQU0sS0FBSyxDQUFDO0lBQ2QsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSyxDQUNILE9BQXdCLEVBQ3hCLFFBQTZCLEVBQzdCLFVBQWdELEVBQUU7UUFFbEQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUM7WUFDZixPQUFPO1lBQ1AsTUFBTSxFQUFFLE9BQU8sQ0FBQyxNQUFNO1lBQ3RCLFFBQVE7WUFDUixNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU0sSUFBSSxHQUFHO1NBQzlCLENBQUMsQ0FBQztRQUVILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOztPQUVHO0lBQ0gsR0FBRyxDQUFJLE9BQXdCLEVBQUUsUUFBNkIsRUFBRSxNQUFlO1FBQzdFLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsUUFBUSxFQUFFLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsQ0FBQyxDQUFDO0lBQ2xFLENBQUM7SUFFRDs7T0FFRztJQUNILElBQUksQ0FBSSxPQUF3QixFQUFFLFFBQTZCLEVBQUUsTUFBZTtRQUM5RSxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxFQUFFLFFBQVEsRUFBRSxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBRUQ7O09BRUc7SUFDSCxHQUFHLENBQUksT0FBd0IsRUFBRSxRQUE2QixFQUFFLE1BQWU7UUFDN0UsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxRQUFRLEVBQUUsRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUM7SUFDbEUsQ0FBQztJQUVEOztPQUVHO0lBQ0gsTUFBTSxDQUFJLE9BQXdCLEVBQUUsUUFBNkIsRUFBRSxNQUFlO1FBQ2hGLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsUUFBUSxFQUFFLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxNQUFNLEVBQUUsQ0FBQyxDQUFDO0lBQ3JFLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUssQ0FBSSxPQUF3QixFQUFFLFFBQTZCLEVBQUUsTUFBZTtRQUMvRSxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxFQUFFLFFBQVEsRUFBRSxFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUUsTUFBTSxFQUFFLENBQUMsQ0FBQztJQUNwRSxDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLEtBQUs7UUFDUCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUM7SUFDckIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSztRQUNILElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxFQUFFLENBQUM7SUFDMUIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSztRQUNILElBQUksQ0FBQyxNQUFNLEdBQUcsRUFBRSxDQUFDO1FBQ2pCLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxFQUFFLENBQUM7SUFDMUIsQ0FBQztJQUVPLGFBQWEsQ0FBQyxHQUFXLEVBQUUsT0FBcUI7UUFDdEQsTUFBTSxTQUFTLEdBQUcsR0FBRyxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ2pDLE1BQU0sTUFBTSxHQUFHLE9BQU8sRUFBRSxNQUFNLElBQUksS0FBSyxDQUFDO1FBRXhDLEtBQUssTUFBTSxLQUFLLElBQUksSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ2hDLE1BQU0sWUFBWSxHQUNoQixPQUFPLEtBQUssQ0FBQyxPQUFPLEtBQUssUUFBUTtnQkFDL0IsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQztnQkFDbkMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1lBRXBDLE1BQU0sV0FBVyxHQUFHLENBQUMsS0FBSyxDQUFDLE1BQU0sSUFBSSxLQUFLLENBQUMsTUFBTSxDQUFDLFdBQVcsRUFBRSxLQUFLLE1BQU0sQ0FBQyxXQUFXLEVBQUUsQ0FBQztZQUV6RixJQUFJLFlBQVksSUFBSSxXQUFXLEVBQUUsQ0FBQztnQkFDaEMsTUFBTSxPQUFPLEdBQ1gsT0FBTyxLQUFLLENBQUMsUUFBUSxLQUFLLFVBQVU7b0JBQ2xDLENBQUMsQ0FBRSxLQUFLLENBQUMsUUFBNEQsQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDO29CQUNuRixDQUFDLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQztnQkFFckIsTUFBTSxNQUFNLEdBQUcsS0FBSyxDQUFDLE1BQU0sSUFBSSxHQUFHLENBQUM7Z0JBRW5DLE9BQU8sT0FBTyxDQUFDLE9BQU8sQ0FBQztvQkFDckIsRUFBRSxFQUFFLE1BQU0sSUFBSSxHQUFHLElBQUksTUFBTSxHQUFHLEdBQUc7b0JBQ2pDLE1BQU07b0JBQ04sVUFBVSxFQUFFLE1BQU0sS0FBSyxHQUFHLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsT0FBTztvQkFDM0MsSUFBSSxFQUFFLEdBQUcsRUFBRSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDO2lCQUN6QixDQUFDLENBQUM7WUFDakIsQ0FBQztRQUNILENBQUM7UUFFRCw0Q0FBNEM7UUFDNUMsT0FBTyxPQUFPLENBQUMsT0FBTyxDQUFDO1lBQ3JCLEVBQUUsRUFBRSxLQUFLO1lBQ1QsTUFBTSxFQUFFLEdBQUc7WUFDWCxVQUFVLEVBQUUsV0FBVztZQUN2QixJQUFJLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxFQUFFLEtBQUssRUFBRSxXQUFXLEVBQUUsQ0FBQztTQUN4QyxDQUFDLENBQUM7SUFDakIsQ0FBQztDQUNGO0FBak9ELDZCQWlPQyJ9

package/dist/tools/list.d.ts

@@ -0,0 +1,4 @@
+import type { Logger } from '../server';
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export default function declareListTool(mcpServer: McpServer, forestServerUrl: string, logger: Logger, collectionNames?: string[]): void;
+//# sourceMappingURL=list.d.ts.map

package/dist/tools/list.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = declareListTool;
+const zod_1 = require("zod");
+const filter_js_1 = __importDefault(require("../schemas/filter.js"));
+const activity_logs_creator_js_1 = __importDefault(require("../utils/activity-logs-creator.js"));
+const agent_caller_js_1 = __importDefault(require("../utils/agent-caller.js"));
+const error_parser_js_1 = __importDefault(require("../utils/error-parser.js"));
+const schema_fetcher_js_1 = require("../utils/schema-fetcher.js");
+const tool_with_logging_js_1 = __importDefault(require("../utils/tool-with-logging.js"));
+// Preprocess to handle LLM sending filters as JSON string instead of object
+const filtersWithPreprocess = zod_1.z.preprocess(val => {
+    if (typeof val !== 'string')
+        return val;
+    try {
+        return JSON.parse(val);
+    }
+    catch {
+        // Return original value to let Zod validation produce a proper error
+        return val;
+    }
+}, filter_js_1.default);
+const listArgumentSchema = zod_1.z.object({
+    collectionName: zod_1.z.string(),
+    search: zod_1.z.string().optional(),
+    filters: filtersWithPreprocess
+        .describe('Filters to apply on collection. To filter on a nested field, use "@@@" to separate relations, e.g. "relationName@@@fieldName". One level deep max.')
+        .optional(),
+    sort: zod_1.z
+        .object({
+        field: zod_1.z.string(),
+        ascending: zod_1.z.boolean(),
+    })
+        .optional(),
+    shouldSearchInRelation: zod_1.z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe('Whether to search also on related collections'),
+    fields: zod_1.z
+        .array(zod_1.z.string())
+        .describe('Fields to include in the list. Reduces the amount of data returned. For sub fields, use "@@@" to separate relations, e.g. "relationName@@@fieldName".')
+        .optional(),
+    pagination: zod_1.z
+        .object({
+        size: zod_1.z.number().default(15).optional(),
+        number: zod_1.z.number().default(1).optional(),
+    })
+        .optional(),
+});
+function createListArgumentShape(collectionNames) {
+    return {
+        ...listArgumentSchema.shape,
+        collectionName: collectionNames.length > 0 ? zod_1.z.enum(collectionNames) : zod_1.z.string(),
+    };
+}
+function declareListTool(mcpServer, forestServerUrl, logger, collectionNames = []) {
+    const listArgumentShape = createListArgumentShape(collectionNames);
+    (0, tool_with_logging_js_1.default)(mcpServer, 'list', {
+        title: 'List records from a collection',
+        description: 'Retrieve a list of records from the specified collection.',
+        inputSchema: listArgumentShape,
+    }, async (options, extra) => {
+        const { rpcClient } = await (0, agent_caller_js_1.default)(extra);
+        let actionType = 'index';
+        if (options.search) {
+            actionType = 'search';
+        }
+        else if (options.filters) {
+            actionType = 'filter';
+        }
+        await (0, activity_logs_creator_js_1.default)(forestServerUrl, extra, actionType, {
+            collectionName: options.collectionName,
+        });
+        try {
+            const result = await rpcClient
+                .collection(options.collectionName)
+                .list(options);
+            return { content: [{ type: 'text', text: JSON.stringify(result) }] };
+        }
+        catch (error) {
+            // Parse error text if it's a JSON string from the agent
+            const errorDetail = (0, error_parser_js_1.default)(error);
+            if (errorDetail?.includes('Invalid sort')) {
+                const fields = (0, schema_fetcher_js_1.getFieldsOfCollection)(await (0, schema_fetcher_js_1.fetchForestSchema)(forestServerUrl), options.collectionName);
+                throw new Error(`The sort field provided is invalid for this collection. Available fields for the collection ${options.collectionName} are: ${fields
+                    .filter(field => field.isSortable)
+                    .map(field => field.field)
+                    .join(', ')}.`);
+            }
+            throw errorDetail ? new Error(errorDetail) : error;
+        }
+    }, logger);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGlzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90b29scy9saXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBb0VBLGtDQTZEQztBQTdIRCw2QkFBd0I7QUFFeEIscUVBQWdEO0FBQ2hELGlHQUFrRTtBQUNsRSwrRUFBbUQ7QUFDbkQsK0VBQXVEO0FBQ3ZELGtFQUFzRjtBQUN0Rix5RkFBb0U7QUFFcEUsNEVBQTRFO0FBQzVFLE1BQU0scUJBQXFCLEdBQUcsT0FBQyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsRUFBRTtJQUMvQyxJQUFJLE9BQU8sR0FBRyxLQUFLLFFBQVE7UUFBRSxPQUFPLEdBQUcsQ0FBQztJQUV4QyxJQUFJLENBQUM7UUFDSCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDekIsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNQLHFFQUFxRTtRQUNyRSxPQUFPLEdBQUcsQ0FBQztJQUNiLENBQUM7QUFDSCxDQUFDLEVBQUUsbUJBQVksQ0FBQyxDQUFDO0FBRWpCLE1BQU0sa0JBQWtCLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUNsQyxjQUFjLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtJQUMxQixNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRTtJQUM3QixPQUFPLEVBQUUscUJBQXFCO1NBQzNCLFFBQVEsQ0FDUCxvSkFBb0osQ0FDcko7U0FDQSxRQUFRLEVBQUU7SUFDYixJQUFJLEVBQUUsT0FBQztTQUNKLE1BQU0sQ0FBQztRQUNOLEtBQUssRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2pCLFNBQVMsRUFBRSxPQUFDLENBQUMsT0FBTyxFQUFFO0tBQ3ZCLENBQUM7U0FDRCxRQUFRLEVBQUU7SUFDYixzQkFBc0IsRUFBRSxPQUFDO1NBQ3RCLE9BQU8sRUFBRTtTQUNULFFBQVEsRUFBRTtTQUNWLE9BQU8sQ0FBQyxLQUFLLENBQUM7U0FDZCxRQUFRLENBQUMsK0NBQStDLENBQUM7SUFDNUQsTUFBTSxFQUFFLE9BQUM7U0FDTixLQUFLLENBQUMsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDO1NBQ2pCLFFBQVEsQ0FDUCx1SkFBdUosQ0FDeEo7U0FDQSxRQUFRLEVBQUU7SUFDYixVQUFVLEVBQUUsT0FBQztTQUNWLE1BQU0sQ0FBQztRQUNOLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxDQUFDLFFBQVEsRUFBRTtRQUN2QyxNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQyxRQUFRLEVBQUU7S0FDekMsQ0FBQztTQUNELFFBQVEsRUFBRTtDQUNkLENBQUMsQ0FBQztBQUlILFNBQVMsdUJBQXVCLENBQUMsZUFBeUI7SUFDeEQsT0FBTztRQUNMLEdBQUcsa0JBQWtCLENBQUMsS0FBSztRQUMzQixjQUFjLEVBQ1osZUFBZSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLE9BQUMsQ0FBQyxJQUFJLENBQUMsZUFBd0MsQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFDLENBQUMsTUFBTSxFQUFFO0tBQzdGLENBQUM7QUFDSixDQUFDO0FBRUQsU0FBd0IsZUFBZSxDQUNyQyxTQUFvQixFQUNwQixlQUF1QixFQUN2QixNQUFjLEVBQ2Qsa0JBQTRCLEVBQUU7SUFFOUIsTUFBTSxpQkFBaUIsR0FBRyx1QkFBdUIsQ0FBQyxlQUFlLENBQUMsQ0FBQztJQUVuRSxJQUFBLDhCQUF1QixFQUNyQixTQUFTLEVBQ1QsTUFBTSxFQUNOO1FBQ0UsS0FBSyxFQUFFLGdDQUFnQztRQUN2QyxXQUFXLEVBQUUsMkRBQTJEO1FBQ3hFLFdBQVcsRUFBRSxpQkFBaUI7S0FDL0IsRUFDRCxLQUFLLEVBQUUsT0FBcUIsRUFBRSxLQUFLLEVBQUUsRUFBRTtRQUNyQyxNQUFNLEVBQUUsU0FBUyxFQUFFLEdBQUcsTUFBTSxJQUFBLHlCQUFXLEVBQUMsS0FBSyxDQUFDLENBQUM7UUFFL0MsSUFBSSxVQUFVLEdBQUcsT0FBTyxDQUFDO1FBRXpCLElBQUksT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ25CLFVBQVUsR0FBRyxRQUFRLENBQUM7UUFDeEIsQ0FBQzthQUFNLElBQUksT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO1lBQzNCLFVBQVUsR0FBRyxRQUFRLENBQUM7UUFDeEIsQ0FBQztRQUVELE1BQU0sSUFBQSxrQ0FBaUIsRUFBQyxlQUFlLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRTtZQUMxRCxjQUFjLEVBQUUsT0FBTyxDQUFDLGNBQWM7U0FDdkMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDO1lBQ0gsTUFBTSxNQUFNLEdBQUcsTUFBTSxTQUFTO2lCQUMzQixVQUFVLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQztpQkFDbEMsSUFBSSxDQUFDLE9BQXdCLENBQUMsQ0FBQztZQUVsQyxPQUFPLEVBQUUsT0FBTyxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDO1FBQ3ZFLENBQUM7UUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1lBQ2Ysd0RBQXdEO1lBQ3hELE1BQU0sV0FBVyxHQUFHLElBQUEseUJBQWUsRUFBQyxLQUFLLENBQUMsQ0FBQztZQUUzQyxJQUFJLFdBQVcsRUFBRSxRQUFRLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQztnQkFDMUMsTUFBTSxNQUFNLEdBQUcsSUFBQSx5Q0FBcUIsRUFDbEMsTUFBTSxJQUFBLHFDQUFpQixFQUFDLGVBQWUsQ0FBQyxFQUN4QyxPQUFPLENBQUMsY0FBYyxDQUN2QixDQUFDO2dCQUNGLE1BQU0sSUFBSSxLQUFLLENBQ2IsK0ZBQ0UsT0FBTyxDQUFDLGNBQ1YsU0FBUyxNQUFNO3FCQUNaLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUM7cUJBQ2pDLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUM7cUJBQ3pCLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUNqQixDQUFDO1lBQ0osQ0FBQztZQUVELE1BQU0sV0FBVyxDQUFDLENBQUMsQ0FBQyxJQUFJLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO1FBQ3JELENBQUM7SUFDSCxDQUFDLEVBQ0QsTUFBTSxDQUNQLENBQUM7QUFDSixDQUFDIn0=

package/dist/tools/list.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=list.test.d.ts.map