import { BaseTool } from "../base";
import { QuickbaseClient } from "../../client/quickbase";
import { createLogger } from "../../utils/logger";
import { FieldProperties } from "./create_field";
const logger = createLogger("UpdateFieldTool");
/**
* Parameters for update_field tool
*/
export interface UpdateFieldParams {
/**
* The ID of the table containing the field
*/
table_id: string;
/**
* The ID of the field to update
*/
field_id: string;
/**
* New display label for the field
*/
name?: string;
/**
* Help text shown to users when editing the field (stored as fieldHelp)
*/
description?: string;
/**
* Additional options and properties to update
*/
options?: FieldProperties;
}
/**
* Response from updating a field
*/
export interface UpdateFieldResult {
/**
* The ID of the updated field
*/
fieldId: string;
/**
* The updated label/name of the field
*/
label?: string;
/**
* The updated type of the field
*/
fieldType?: string;
/**
* Help text for the field (shown to users when editing)
*/
fieldHelp?: string;
/**
* The ID of the table containing the field
*/
tableId: string;
/**
* Additional details about the updated field
*/
[key: string]: any;
}
/**
* Tool for updating an existing field in a Quickbase table
*/
export class UpdateFieldTool extends BaseTool<
UpdateFieldParams,
UpdateFieldResult
> {
public name = "update_field";
public description =
"Updates an existing field in a Quickbase table. " +
"Can modify the field label, help text, and properties. " +
"Note: Field type cannot be changed - delete and recreate the field instead.";
/**
* Parameter schema for update_field
*/
public paramSchema = {
type: "object",
properties: {
table_id: {
type: "string",
description: "The ID of the table (e.g., 'bqx7xkw3r')",
},
field_id: {
type: "string",
description: "The ID of the field to update (e.g., '6')",
},
name: {
type: "string",
description: "New display label for the field",
},
description: {
type: "string",
description:
"Help text shown to users when editing the field (stored as fieldHelp)",
},
options: {
type: "object",
description:
"Field properties to update: required, unique, appearsByDefault, " +
"findEnabled, maxLength, numLines, defaultValue, etc.",
},
},
required: ["table_id", "field_id"],
};
/**
* Constructor
* @param client Quickbase client
*/
constructor(client: QuickbaseClient) {
super(client);
}
/**
* Run the update_field tool
* @param params Tool parameters
* @returns Updated field details
*/
protected async run(params: UpdateFieldParams): Promise<UpdateFieldResult> {
const { table_id, field_id, name, description, options } = params;
logger.info("Updating field in Quickbase table", {
tableId: table_id,
fieldId: field_id,
});
// At least one update field is required
if (
!name &&
!description &&
(!options || Object.keys(options).length === 0)
) {
throw new Error(
"At least one update field (name, description, or options) is required",
);
}
// Prepare request body with only the fields that are provided
// Note: Quickbase API uses 'fieldHelp' at root level for help text (not 'description')
// Note: Field type cannot be changed via API - must delete and recreate
const body: Record<string, any> = {};
if (name !== undefined) {
body.label = name;
}
// Add fieldHelp if description provided (maps to root-level fieldHelp)
if (description !== undefined) {
body.fieldHelp = description;
}
// Add properties if provided
if (options && Object.keys(options).length > 0) {
body.properties = { ...options };
}
// Update the field
const response = await this.client.request({
method: "POST",
path: `/fields/${field_id}?tableId=${table_id}`,
body,
});
if (!response.success || !response.data) {
logger.error("Failed to update field", {
error: response.error,
tableId: table_id,
fieldId: field_id,
});
throw new Error(response.error?.message || "Failed to update field");
}
const field = response.data as Record<string, any>;
logger.info("Successfully updated field", {
fieldId: field.id,
tableId: table_id,
updates: Object.keys(body).join(", "),
});
return {
fieldId: field.id,
label: field.label,
fieldType: field.fieldType,
fieldHelp: field.fieldHelp,
tableId: table_id,
...field,
};
}
}
