@forestadmin/mcp-server 1.3.0 → 1.5.0

package/dist/utils/with-activity-log.d.ts

@@ -0,0 +1,31 @@
+import type { Logger } from '../server';
+import type { RequestHandlerExtra } from '@modelcontextprotocol/sdk/shared/protocol.js';
+import type { ServerNotification, ServerRequest } from '@modelcontextprotocol/sdk/types.js';
+import { ActivityLogAction } from './activity-logs-creator';
+interface ActivityLogContext {
+    collectionName?: string;
+    recordId?: string | number;
+    recordIds?: string[] | number[];
+    label?: string;
+}
+interface WithActivityLogOptions<T> {
+    forestServerUrl: string;
+    request: RequestHandlerExtra<ServerRequest, ServerNotification>;
+    action: ActivityLogAction;
+    context?: ActivityLogContext;
+    logger: Logger;
+    operation: () => Promise<T>;
+    /**
+     * Optional function to enhance error messages before logging and throwing.
+     * Receives the parsed error message and the original error.
+     * Should return the enhanced error message to use.
+     */
+    errorEnhancer?: (parsedMessage: string, originalError: unknown) => Promise<string>;
+}
+/**
+ * Wraps an operation with activity log lifecycle management.
+ * Creates a pending activity log, executes the operation, and marks it as succeeded or failed.
+ */
+export default function withActivityLog<T>(options: WithActivityLogOptions<T>): Promise<T>;
+export {};
+//# sourceMappingURL=with-activity-log.d.ts.map

package/dist/utils/with-activity-log.js

@@ -0,0 +1,83 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = withActivityLog;
+const activity_logs_creator_1 = __importStar(require("./activity-logs-creator"));
+const error_parser_1 = __importDefault(require("./error-parser"));
+/**
+ * Wraps an operation with activity log lifecycle management.
+ * Creates a pending activity log, executes the operation, and marks it as succeeded or failed.
+ */
+async function withActivityLog(options) {
+    const { forestServerUrl, request, action, context, logger, operation, errorEnhancer } = options;
+    // We want to create the activity log before executing the operation
+    // If activity log creation fails, we must prevent the execution of the operation
+    const activityLog = await (0, activity_logs_creator_1.default)(forestServerUrl, request, action, context);
+    try {
+        const result = await operation();
+        (0, activity_logs_creator_1.markActivityLogAsSucceeded)({
+            forestServerUrl,
+            request,
+            activityLog,
+            logger,
+        });
+        return result;
+    }
+    catch (error) {
+        const errorDetail = (0, error_parser_1.default)(error);
+        let errorMessage = errorDetail || (error instanceof Error ? error.message : String(error));
+        // Apply error enhancer if provided (e.g., to add helpful context about available fields)
+        if (errorEnhancer) {
+            try {
+                errorMessage = await errorEnhancer(errorMessage, error);
+            }
+            catch {
+                // If enhancement fails, use the original parsed message
+            }
+        }
+        (0, activity_logs_creator_1.markActivityLogAsFailed)({
+            forestServerUrl,
+            request,
+            activityLog,
+            errorMessage,
+            logger,
+        });
+        throw new Error(errorMessage);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2l0aC1hY3Rpdml0eS1sb2cuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbHMvd2l0aC1hY3Rpdml0eS1sb2cudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFxQ0Esa0NBeUNDO0FBMUVELGlGQUlpQztBQUNqQyxrRUFBNkM7QUF3QjdDOzs7R0FHRztBQUNZLEtBQUssVUFBVSxlQUFlLENBQUksT0FBa0M7SUFDakYsTUFBTSxFQUFFLGVBQWUsRUFBRSxPQUFPLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLGFBQWEsRUFBRSxHQUFHLE9BQU8sQ0FBQztJQUVoRyxvRUFBb0U7SUFDcEUsaUZBQWlGO0lBQ2pGLE1BQU0sV0FBVyxHQUFHLE1BQU0sSUFBQSwrQkFBd0IsRUFBQyxlQUFlLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztJQUU5RixJQUFJLENBQUM7UUFDSCxNQUFNLE1BQU0sR0FBRyxNQUFNLFNBQVMsRUFBRSxDQUFDO1FBRWpDLElBQUEsa0RBQTBCLEVBQUM7WUFDekIsZUFBZTtZQUNmLE9BQU87WUFDUCxXQUFXO1lBQ1gsTUFBTTtTQUNQLENBQUMsQ0FBQztRQUVILE9BQU8sTUFBTSxDQUFDO0lBQ2hCLENBQUM7SUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1FBQ2YsTUFBTSxXQUFXLEdBQUcsSUFBQSxzQkFBZSxFQUFDLEtBQUssQ0FBQyxDQUFDO1FBQzNDLElBQUksWUFBWSxHQUFHLFdBQVcsSUFBSSxDQUFDLEtBQUssWUFBWSxLQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO1FBRTNGLHlGQUF5RjtRQUN6RixJQUFJLGFBQWEsRUFBRSxDQUFDO1lBQ2xCLElBQUksQ0FBQztnQkFDSCxZQUFZLEdBQUcsTUFBTSxhQUFhLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQyxDQUFDO1lBQzFELENBQUM7WUFBQyxNQUFNLENBQUM7Z0JBQ1Asd0RBQXdEO1lBQzFELENBQUM7UUFDSCxDQUFDO1FBRUQsSUFBQSwrQ0FBdUIsRUFBQztZQUN0QixlQUFlO1lBQ2YsT0FBTztZQUNQLFdBQVc7WUFDWCxZQUFZO1lBQ1osTUFBTTtTQUNQLENBQUMsQ0FBQztRQUVILE1BQU0sSUFBSSxLQUFLLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDaEMsQ0FBQztBQUNILENBQUMifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forestadmin/mcp-server",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Model Context Protocol server for Forest Admin with OAuth authentication",
   "main": "dist/index.js",
   "bin": {
@@ -43,6 +43,7 @@
     "@types/express": "^5.0.0",
     "@types/node": "^18.11.18",
     "@types/supertest": "^6.0.2",
+    "superagent": "^10.2.3",
     "supertest": "^7.1.3",
     "typescript": "^5.0.0"
   }