mcp-quickbase 2.1.0 → 2.3.0

package/dist/tools/relationships/update_relationship.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateRelationshipTool = void 0;
+const base_1 = require("../base");
+const logger_1 = require("../../utils/logger");
+const logger = (0, logger_1.createLogger)("UpdateRelationshipTool");
+/**
+ * Tool for updating an existing table-to-table relationship in Quickbase.
+ *
+ * ADDITIVE ONLY - adds lookup fields and/or summary fields to existing relationships.
+ * Does not delete existing fields from the relationship.
+ */
+class UpdateRelationshipTool extends base_1.BaseTool {
+    /**
+     * Constructor
+     * @param client Quickbase client
+     */
+    constructor(client) {
+        super(client);
+        this.name = "update_relationship";
+        this.description = "Adds lookup fields and/or summary fields to an existing relationship. This operation " +
+            "is ADDITIVE ONLY - it will not delete existing lookup or summary fields. Use this to " +
+            "enhance relationships with additional calculated fields. To remove fields from a " +
+            "relationship, you must delete them individually using the field deletion tools.";
+        /**
+         * Parameter schema for update_relationship with conditional validation
+         */
+        this.paramSchema = {
+            type: "object",
+            properties: {
+                table_id: {
+                    type: "string",
+                    description: "The ID of the child Quickbase table (DBID) containing the relationship",
+                },
+                relationship_id: {
+                    type: "number",
+                    description: "The ID of the relationship to update (same as the foreign key field ID)",
+                },
+                lookup_field_ids: {
+                    type: "array",
+                    items: {
+                        type: "number",
+                    },
+                    description: "Optional array of parent field IDs to add as lookup fields in the child table",
+                },
+                summary_field_id: {
+                    type: "number",
+                    description: "Optional child field ID to summarize in the parent table",
+                },
+                summary_label: {
+                    type: "string",
+                    description: "Optional label for the summary field created in the parent table",
+                },
+                summary_accumulation_type: {
+                    type: "string",
+                    enum: ["SUM", "COUNT", "AVG", "MAX", "MIN"],
+                    description: "Accumulation type for the summary field. Required when summary_field_id is provided. " +
+                        "Valid values: SUM, COUNT, AVG, MAX, MIN",
+                },
+                summary_where: {
+                    type: "string",
+                    description: "Optional Quickbase query filter for the summary field (e.g., \"{6.EX.'Active'}\")",
+                },
+            },
+            required: ["table_id", "relationship_id"],
+            // Conditional validation: summary_accumulation_type is required when summary_field_id is provided
+            if: {
+                properties: { summary_field_id: { type: "number" } },
+                required: ["summary_field_id"],
+            },
+            then: {
+                required: ["summary_accumulation_type"],
+            },
+        };
+    }
+    /**
+     * Run the update_relationship tool
+     * @param params Tool parameters
+     * @returns Updated relationship details
+     */
+    async run(params) {
+        const { table_id, relationship_id, lookup_field_ids, summary_field_id, summary_label, summary_accumulation_type, summary_where, } = params;
+        logger.info("Updating relationship", {
+            childTableId: table_id,
+            relationshipId: relationship_id,
+            hasLookupFields: !!lookup_field_ids?.length,
+            hasSummaryField: !!summary_field_id,
+        });
+        // Validate conditional requirement: summary_accumulation_type required when summary_field_id is provided
+        if (summary_field_id !== undefined && !summary_accumulation_type) {
+            const errorMessage = "summary_accumulation_type is required when summary_field_id is provided. " +
+                "Valid values: SUM, COUNT, AVG, MAX, MIN";
+            logger.error("Validation failed", { error: errorMessage });
+            throw new Error(errorMessage);
+        }
+        // Build the request body according to Quickbase API format
+        const body = {};
+        // Add lookup fields if provided
+        if (lookup_field_ids && lookup_field_ids.length > 0) {
+            body.lookupFieldIds = lookup_field_ids;
+        }
+        // Add summary field configuration if provided
+        if (summary_field_id !== undefined && summary_accumulation_type) {
+            const summaryField = {
+                summaryFid: summary_field_id,
+                accumulationType: summary_accumulation_type,
+            };
+            if (summary_label) {
+                summaryField.label = summary_label;
+            }
+            if (summary_where) {
+                summaryField.where = summary_where;
+            }
+            body.summaryFields = [summaryField];
+        }
+        // Update the relationship
+        const response = await this.client.request({
+            method: "POST",
+            path: `/tables/${table_id}/relationship/${relationship_id}`,
+            body,
+        });
+        if (!response.success || !response.data) {
+            logger.error("Failed to update relationship", {
+                error: response.error,
+                childTableId: table_id,
+                relationshipId: relationship_id,
+            });
+            throw new Error(response.error?.message || "Failed to update relationship");
+        }
+        // Parse and transform the API response
+        const data = response.data;
+        const foreignKeyField = data.foreignKeyField;
+        const lookupFields = data.lookupFields;
+        const summaryFields = data.summaryFields;
+        const result = {
+            id: data.id,
+            parentTableId: data.parentTableId,
+            childTableId: data.childTableId,
+            foreignKeyField: foreignKeyField
+                ? {
+                    id: foreignKeyField.id,
+                    label: foreignKeyField.label,
+                    type: foreignKeyField.type,
+                }
+                : { id: 0, label: "", type: "" },
+            lookupFields: (lookupFields || []).map((field) => ({
+                id: field.id,
+                label: field.label,
+                type: field.type,
+            })),
+            summaryFields: (summaryFields || []).map((field) => ({
+                id: field.id,
+                label: field.label,
+                type: field.type,
+            })),
+        };
+        logger.info("Successfully updated relationship", {
+            relationshipId: result.id,
+            childTableId: result.childTableId,
+            parentTableId: result.parentTableId,
+            totalLookupFields: result.lookupFields.length,
+            totalSummaryFields: result.summaryFields.length,
+        });
+        return result;
+    }
+}
+exports.UpdateRelationshipTool = UpdateRelationshipTool;
+//# sourceMappingURL=update_relationship.js.map

package/dist/tools/relationships/update_relationship.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update_relationship.js","sourceRoot":"","sources":["../../../src/tools/relationships/update_relationship.ts"],"names":[],"mappings":";;;AAAA,kCAAmC;AAEnC,+CAAkD;AAIlD,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,wBAAwB,CAAC,CAAC;AA6EtD;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,eAG3C;IAiEC;;;OAGG;IACH,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAC;QArET,SAAI,GAAG,qBAAqB,CAAC;QAC7B,gBAAW,GAChB,uFAAuF;YACvF,uFAAuF;YACvF,mFAAmF;YACnF,iFAAiF,CAAC;QAEpF;;WAEG;QACI,gBAAW,GAAG;YACnB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,wEAAwE;iBAC3E;gBACD,eAAe,EAAE;oBACf,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,yEAAyE;iBAC5E;gBACD,gBAAgB,EAAE;oBAChB,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;oBACD,WAAW,EACT,+EAA+E;iBAClF;gBACD,gBAAgB,EAAE;oBAChB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,0DAA0D;iBACxE;gBACD,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,kEAAkE;iBACrE;gBACD,yBAAyB,EAAE;oBACzB,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;oBAC3C,WAAW,EACT,uFAAuF;wBACvF,yCAAyC;iBAC5C;gBACD,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,mFAAmF;iBACtF;aACF;YACD,QAAQ,EAAE,CAAC,UAAU,EAAE,iBAAiB,CAAC;YACzC,kGAAkG;YAClG,EAAE,EAAE;gBACF,UAAU,EAAE,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;gBACpD,QAAQ,EAAE,CAAC,kBAAkB,CAAC;aAC/B;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,CAAC,2BAA2B,CAAC;aACxC;SACF,CAAC;IAQF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,GAAG,CACjB,MAAgC;QAEhC,MAAM,EACJ,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,yBAAyB,EACzB,aAAa,GACd,GAAG,MAAM,CAAC;QAEX,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE;YACnC,YAAY,EAAE,QAAQ;YACtB,cAAc,EAAE,eAAe;YAC/B,eAAe,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM;YAC3C,eAAe,EAAE,CAAC,CAAC,gBAAgB;SACpC,CAAC,CAAC;QAEH,yGAAyG;QACzG,IAAI,gBAAgB,KAAK,SAAS,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACjE,MAAM,YAAY,GAChB,2EAA2E;gBAC3E,yCAAyC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QAED,2DAA2D;QAC3D,MAAM,IAAI,GAA4B,EAAE,CAAC;QAEzC,gCAAgC;QAChC,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC;QACzC,CAAC;QAED,8CAA8C;QAC9C,IAAI,gBAAgB,KAAK,SAAS,IAAI,yBAAyB,EAAE,CAAC;YAChE,MAAM,YAAY,GAA4B;gBAC5C,UAAU,EAAE,gBAAgB;gBAC5B,gBAAgB,EAAE,yBAAyB;aAC5C,CAAC;YAEF,IAAI,aAAa,EAAE,CAAC;gBAClB,YAAY,CAAC,KAAK,GAAG,aAAa,CAAC;YACrC,CAAC;YAED,IAAI,aAAa,EAAE,CAAC;gBAClB,YAAY,CAAC,KAAK,GAAG,aAAa,CAAC;YACrC,CAAC;YAED,IAAI,CAAC,aAAa,GAAG,CAAC,YAAY,CAAC,CAAC;QACtC,CAAC;QAED,0BAA0B;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0B;YAClE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW,QAAQ,iBAAiB,eAAe,EAAE;YAC3D,IAAI;SACL,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;gBAC5C,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,YAAY,EAAE,QAAQ;gBACtB,cAAc,EAAE,eAAe;aAChC,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CACb,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,+BAA+B,CAC3D,CAAC;QACJ,CAAC;QAED,uCAAuC;QACvC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAE3B,MAAM,eAAe,GAAG,IAAI,CAAC,eAEhB,CAAC;QACd,MAAM,YAAY,GAAG,IAAI,CAAC,YAEb,CAAC;QACd,MAAM,aAAa,GAAG,IAAI,CAAC,aAEd,CAAC;QAEd,MAAM,MAAM,GAA6B;YACvC,EAAE,EAAE,IAAI,CAAC,EAAY;YACrB,aAAa,EAAE,IAAI,CAAC,aAAuB;YAC3C,YAAY,EAAE,IAAI,CAAC,YAAsB;YACzC,eAAe,EAAE,eAAe;gBAC9B,CAAC,CAAC;oBACE,EAAE,EAAE,eAAe,CAAC,EAAY;oBAChC,KAAK,EAAE,eAAe,CAAC,KAAe;oBACtC,IAAI,EAAE,eAAe,CAAC,IAAc;iBACrC;gBACH,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAClC,YAAY,EAAE,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,GAAG,CACpC,CAAC,KAA8B,EAAE,EAAE,CAAC,CAAC;gBACnC,EAAE,EAAE,KAAK,CAAC,EAAY;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAe;gBAC5B,IAAI,EAAE,KAAK,CAAC,IAAc;aAC3B,CAAC,CACH;YACD,aAAa,EAAE,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,GAAG,CACtC,CAAC,KAA8B,EAAE,EAAE,CAAC,CAAC;gBACnC,EAAE,EAAE,KAAK,CAAC,EAAY;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAe;gBAC5B,IAAI,EAAE,KAAK,CAAC,IAAc;aAC3B,CAAC,CACH;SACF,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE;YAC/C,cAAc,EAAE,MAAM,CAAC,EAAE;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,iBAAiB,EAAE,MAAM,CAAC,YAAY,CAAC,MAAM;YAC7C,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,MAAM;SAChD,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA5MD,wDA4MC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-quickbase",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "Work with Quickbase via Model Context Protocol",
   "main": "dist/mcp-stdio-server.js",
   "types": "dist/mcp-stdio-server.d.ts",