quickbase-js 0.1.0-beta.8 → 0.1.0-beta.9

package/tests/vitest/qb/fields/getFieldUsage.test.ts

@@ -1,166 +1,72 @@
-// tests/vitest/qb/fields/getFieldUsage.test.ts
-import { describe, it, expect, afterAll } from "vitest";
-import {
-  createClient,
-  QB_REALM,
-  QB_USER_TOKEN,
-  QB_TABLE_ID_1,
-} from "../../../setup.ts";
+// tests/vitest/qb/fields/getFieldsUsage.test.ts
+
+import { describe, it, expect } from "vitest";
+import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
 import { FieldUsage } from "@/generated/models";
 
-describe("QuickbaseClient Integration - getFieldUsage", () => {
+describe("QuickbaseClient Integration - getFieldsUsage", () => {
   const client = createClient();
-  const createdFieldIds: number[] = [];
-
-  afterAll(async () => {
-    if (createdFieldIds.length > 0) {
-      try {
-        const response = await client.deleteFields({
-          tableId: QB_TABLE_ID_1,
-          body: { fieldIds: createdFieldIds },
-        });
-        console.log(
-          `Cleaned up fields: ${JSON.stringify(response.deletedFieldIds)}`,
-          response.errors && response.errors.length > 0
-            ? `Errors: ${response.errors}`
-            : ""
-        );
-      } catch (error) {
-        console.error("Cleanup failed:", error);
-        console.log(`Fields left in table: ${createdFieldIds}`);
-      }
-    } else {
-      console.log("No fields to clean up.");
-    }
-  });
-
-  it(
-    "creates a field, retrieves its usage statistics, and deletes it",
-    async () => {
-      // Step 1: Create a field
-      const uniqueLabel = `TestField_${Date.now()}`;
-      console.log("Creating field with label:", uniqueLabel);
-      const createResponse = await client.createField({
-        tableId: QB_TABLE_ID_1,
-        body: {
-          label: uniqueLabel,
-          fieldType: "text",
-          fieldHelp: "Created for getFieldUsage integration test",
-          addToForms: true,
-        },
-      });
-
-      expect(createResponse.id).toBeDefined();
-      const fieldId = createResponse.id;
-      createdFieldIds.push(fieldId);
-      console.log(`Created field ${uniqueLabel} with ID ${fieldId}`);
-
-      // Brief delay to ensure field is registered
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-
-      // Step 2: Get field usage with raw response logging
-      console.log("Fetching field usage for:", {
-        tableId: QB_TABLE_ID_1,
-        fieldId,
-      });
-      const rawResponse = await fetch(
-        `https://api.quickbase.com/v1/fields/usage/${fieldId}?tableId=${QB_TABLE_ID_1}`,
-        {
-          method: "GET",
-          headers: {
-            "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-            Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-            "Content-Type": "application/json",
-          },
-        }
-      );
-      const rawBody = await rawResponse.text();
-      console.log("Raw API response:", {
-        status: rawResponse.status,
-        statusText: rawResponse.statusText,
-        body: rawBody,
-      });
-
-      const responseArray: FieldUsage[] = await client.getFieldUsage({
-        fieldId,
-        tableId: QB_TABLE_ID_1,
-      });
-      console.log("Parsed API response (array):", responseArray);
 
-      // Validate response structure (unwrap the array)
-      expect(responseArray).toBeDefined();
-      expect(responseArray).toHaveLength(1); // Expect a single-item array
-      const response = responseArray[0];
-
-      expect(response).toBeDefined();
-      expect(response.field).toHaveProperty("id", fieldId);
-      expect(response.field).toHaveProperty("name", uniqueLabel);
-      expect(response.field).toHaveProperty("type", "text");
-      expect(typeof response.field.name).toBe("string");
-      expect(typeof response.field.type).toBe("string");
+  it("retrieves field usage statistics for a valid table", async () => {
+    console.log("Starting retrieval of full field usage list");
+    const response = await client.getFieldsUsage({
+      tableId: QB_TABLE_ID_1,
+    });
 
-      expect(response.usage).toBeDefined();
-      expect(typeof response.usage).toBe("object");
-      expect(response.usage).toHaveProperty("actions");
-      expect(response.usage.actions).toHaveProperty("count");
-      expect(typeof response.usage.actions.count).toBe("number");
-      expect(response.usage).toHaveProperty("appHomePages");
-      expect(response.usage).toHaveProperty("dashboards");
-      expect(response.usage).toHaveProperty("defaultReports");
-      expect(response.usage).toHaveProperty("exactForms");
-      expect(response.usage).toHaveProperty("fields");
-      expect(response.usage).toHaveProperty("forms");
-      expect(response.usage).toHaveProperty("notifications");
-      expect(response.usage).toHaveProperty("personalReports");
-      expect(response.usage).toHaveProperty("pipelines");
-      expect(response.usage).toHaveProperty("relationships");
-      expect(response.usage).toHaveProperty("reminders");
-      expect(response.usage).toHaveProperty("reports");
-      expect(response.usage).toHaveProperty("roles");
-      expect(response.usage).toHaveProperty("tableImports");
-      expect(response.usage).toHaveProperty("tableRules");
-      expect(response.usage).toHaveProperty("webhooks");
+    expect(response).toBeInstanceOf(Array);
+    expect(response.length).toBeGreaterThan(0); // Assumes the table has fields
+    response.forEach((usage: FieldUsage) => {
+      expect(usage.field).toHaveProperty("id");
+      expect(usage.field).toHaveProperty("name");
+      expect(usage.field).toHaveProperty("type");
+      expect(usage.usage).toHaveProperty("actions");
+      expect(usage.usage.actions).toHaveProperty("count");
+      expect(typeof usage.usage.actions.count).toBe("number");
+      expect(usage.usage).toHaveProperty("dashboards");
+      expect(usage.usage).toHaveProperty("forms");
+      expect(usage.usage).toHaveProperty("reports");
+    });
+    console.log(
+      `Retrieved ${response.length} field usage entries for table ${QB_TABLE_ID_1}`
+    );
+  }, 15000); // 15-second timeout
 
-      // Since it’s a new field, expect minimal usage
-      expect(response.usage.forms.count).toBeGreaterThanOrEqual(0); // May be 1 if addToForms worked
-    },
-    { timeout: 30000 } // 30-second timeout for create + get + delete
-  );
+  it("retrieves field usage with skip and top parameters", async () => {
+    console.log(
+      "Starting retrieval of full field usage list for skip/top test"
+    );
+    const fullResponse = await client.getFieldsUsage({
+      tableId: QB_TABLE_ID_1,
+    });
+    console.log(`Full list retrieved: ${fullResponse.length} fields`);
 
-  it("fails with non-existent field ID", { timeout: 15000 }, async () => {
-    const nonExistentFieldId = 999999;
+    const totalFields = fullResponse.length;
+    if (totalFields <= 1) {
+      console.log("Skipping skip/top test: table has too few fields");
+      return; // Skip if not enough fields to test pagination
+    }
 
-    console.log("Attempting to fetch usage for non-existent field:", {
+    console.log("Starting retrieval with skip=1 and top=1");
+    const response = await client.getFieldsUsage({
       tableId: QB_TABLE_ID_1,
-      fieldId: nonExistentFieldId,
-    });
-    await expect(
-      client.getFieldUsage({
-        fieldId: nonExistentFieldId,
-        tableId: QB_TABLE_ID_1,
-      })
-    ).rejects.toMatchObject({
-      message: expect.stringContaining(
-        "API Error: No such field (Status: 404)"
-      ),
+      skip: 1,
+      top: 1,
     });
 
+    expect(response).toBeInstanceOf(Array);
+    expect(response.length).toBe(1); // Should return exactly 1 field
+    expect(response[0].field.id).not.toBe(fullResponse[0].field.id); // Should skip the first field
     console.log(
-      `Confirmed 404 for non-existent field ID ${nonExistentFieldId}`
+      `Retrieved ${response.length} field usage entries with skip=1 and top=1`
     );
-  });
+  }, 15000); // 15-second timeout
 
-  it("fails with invalid table ID", { timeout: 15000 }, async () => {
+  it("fails with invalid table ID", async () => {
     const invalidTableId = "invalid_dbid";
-    const fieldId = 6;
-
-    console.log("Attempting to fetch usage with invalid table ID:", {
-      tableId: invalidTableId,
-      fieldId,
-    });
+    console.log(`Starting retrieval with invalid table ID ${invalidTableId}`);
+    const startTime = Date.now();
     await expect(
-      client.getFieldUsage({
-        fieldId,
+      client.getFieldsUsage({
         tableId: invalidTableId,
       })
     ).rejects.toMatchObject({
@@ -168,7 +74,9 @@ describe("QuickbaseClient Integration - getFieldUsage", () => {
         "API Error: Access denied (Status: 401)"
       ),
     });
-
-    console.log(`Confirmed 401 for invalid table ID ${invalidTableId}`);
-  });
+    const duration = Date.now() - startTime;
+    console.log(
+      `Confirmed 401 for invalid table ID ${invalidTableId} in ${duration}ms`
+    );
+  }, 30000); // Increased to 30-second timeout
 });

package/tests/vitest/qb/formulas/runFormula.test.ts

@@ -0,0 +1,96 @@
+// tests/vitest/qb/formulas/runFormula.test.ts
+
+import { describe, it, expect, beforeAll, afterAll } from "vitest";
+import {
+  createClient,
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+} from "@tests/setup.ts";
+import {
+  RunFormulaRequest,
+  RunFormula200Response,
+  Upsert200Response,
+} from "@/generated/models";
+
+describe("QuickbaseClient Integration - runFormula", () => {
+  let client: ReturnType<typeof createClient>;
+  let testRecordId: number;
+
+  beforeAll(async () => {
+    // Validate environment variables
+    if (!QB_REALM) throw new Error("QB_REALM is not defined in .env");
+    if (!QB_USER_TOKEN) throw new Error("QB_USER_TOKEN is not defined in .env");
+    if (!QB_TABLE_ID_1) throw new Error("QB_TABLE_ID_1 is not defined in .env");
+
+    // Initialize client with user token only
+    client = createClient(undefined, {
+      realm: QB_REALM,
+      userToken: QB_USER_TOKEN,
+      debug: true,
+    });
+
+    // Upsert a test record to ensure we have a valid rid
+    const upsertResponse: Upsert200Response = await client.upsert({
+      body: {
+        to: QB_TABLE_ID_1,
+        data: [
+          {
+            "6": { value: `Test Record ${Date.now()}` }, // Assuming field 6 is a text field (e.g., "Task Name")
+          },
+        ],
+        fieldsToReturn: [3], // Return Record ID# (field ID 3)
+      },
+    });
+
+    // Extract the created record ID
+    testRecordId = upsertResponse.data[0]["3"].value as number;
+    console.log(`Upserted test record with ID: ${testRecordId}`);
+  });
+
+  afterAll(async () => {
+    // Clean up the test record
+    if (testRecordId) {
+      await client.deleteRecords({
+        body: {
+          from: QB_TABLE_ID_1,
+          where: `{3.EX.${testRecordId}}`, // Delete by Record ID#
+        },
+      });
+      console.log(`Cleaned up test record with ID: ${testRecordId}`);
+    }
+  });
+
+  it("runs simple formula without rid and returns correct result", async () => {
+    const request: RunFormulaRequest = {
+      from: QB_TABLE_ID_1,
+      formula: "1 + 1", // Simple arithmetic to verify functionality
+    };
+
+    const response: RunFormula200Response = await client.runFormula({
+      body: request,
+    });
+
+    console.log("Real API response (no rid):", response);
+
+    expect(response).toHaveProperty("result");
+    expect(response.result).toBe("2"); // Expect "2" as a string
+  }, 10000);
+
+  it("runs formula with rid and field ID 3, returns correct numeric result", async () => {
+    const request: RunFormulaRequest = {
+      from: QB_TABLE_ID_1,
+      formula: "Sum([Record ID#], 20)", // Field ID 3 is "Record ID#"
+      rid: testRecordId, // Use the upserted record ID
+    };
+
+    const response: RunFormula200Response = await client.runFormula({
+      body: request,
+    });
+
+    console.log("Real API response (with rid):", response);
+
+    expect(response).toHaveProperty("result");
+    expect(response.result).toBe(String(testRecordId + 20)); // Dynamic result based on the record ID
+  }, 10000);
+});

package/tests/vitest/qb/tables/createRelationship.test.ts

@@ -0,0 +1,102 @@
+// tests/vitest/qb/tables/createRelationship.test.ts
+
+import { test, expect } from "vitest";
+import { quickbase } from "/home/drew/Projects/quickbase-js/src/quickbaseClient";
+import {
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+  QB_TABLE_ID_2,
+} from "/home/drew/Projects/quickbase-js/tests/setup.ts";
+
+test(
+  "QuickbaseClient Integration - createRelationship > creates a new relationship in QuickBase",
+  { timeout: 60000 }, // 60 seconds for create and delete
+  async () => {
+    // Validate environment variables
+    if (!QB_REALM) throw new Error("QB_REALM is not defined in .env");
+    if (!QB_USER_TOKEN) throw new Error("QB_USER_TOKEN is not defined in .env");
+    if (!QB_TABLE_ID_1) throw new Error("QB_TABLE_ID_1 is not defined in .env");
+    if (!QB_TABLE_ID_2) throw new Error("QB_TABLE_ID_2 is not defined in .env");
+
+    // Initialize client
+    const client = quickbase({
+      realm: QB_REALM,
+      userToken: QB_USER_TOKEN,
+      debug: true,
+    });
+
+    // Define the relationship creation request
+    const uniqueLabel = `TestRelationship_${Date.now()}`;
+    const requestBody = {
+      parentTableId: QB_TABLE_ID_1,
+      foreignKeyField: { label: uniqueLabel },
+      lookupFieldIds: [6], // Assuming field 6 exists in QB_TABLE_ID_1
+      summaryFields: [
+        {
+          summaryFid: 6, // Assuming field 6 in QB_TABLE_ID_2 is numeric
+          label: `Sum_${uniqueLabel}`,
+          accumulationType: "SUM",
+        },
+      ],
+    };
+
+    console.log("Config used:", {
+      realm: QB_REALM,
+      userToken: "[REDACTED]",
+      parentTableId: QB_TABLE_ID_1,
+      childTableId: QB_TABLE_ID_2,
+    });
+    console.log("Creating relationship with:", requestBody);
+
+    // Create the relationship
+    const response = await client.createRelationship({
+      tableId: QB_TABLE_ID_2,
+      body: requestBody,
+    });
+
+    console.log("Real API response:", JSON.stringify(response, null, 2));
+
+    // Assertions for creation
+    expect(response).toBeDefined();
+    expect(response.id).toBeDefined();
+    expect(response.parentTableId).toBe(QB_TABLE_ID_1);
+    expect(response.childTableId).toBe(QB_TABLE_ID_2);
+    expect(response.foreignKeyField).toBeDefined();
+    expect(response.foreignKeyField?.label).toBe(uniqueLabel);
+    expect(response.lookupFields).toHaveLength(1);
+    expect(response.lookupFields[0].id).toBeGreaterThan(0);
+    expect(response.summaryFields).toHaveLength(1);
+    expect(response.summaryFields[0].label).toBe(`Sum_${uniqueLabel}`);
+
+    // Cleanup: Delete the relationship
+    const relationshipId = response.id;
+    console.log("Deleting relationship with ID:", relationshipId);
+    const deleteResponse = await client.deleteRelationship({
+      tableId: QB_TABLE_ID_2,
+      relationshipId,
+    });
+
+    console.log(
+      "Delete relationship response:",
+      JSON.stringify(deleteResponse, null, 2)
+    );
+
+    // Verify deletion
+    expect(deleteResponse).toBeDefined();
+    expect(deleteResponse.relationshipId).toBe(relationshipId);
+
+    // Confirm relationship is gone
+    const relationships = await client.getRelationships({
+      tableId: QB_TABLE_ID_2,
+    });
+    console.log(
+      "Relationships after deletion:",
+      JSON.stringify(relationships, null, 2)
+    );
+    const deletedRelationship = relationships.relationships.find(
+      (r) => r.id === relationshipId
+    );
+    expect(deletedRelationship).toBeUndefined(); // Should no longer exist
+  }
+);

package/tests/vitest/qb/tables/deleteRelationship.test.ts

@@ -0,0 +1,143 @@
+// tests/vitest/qb/tables/deleteRelationship.test.ts
+
+import { test, expect } from "vitest";
+import { quickbase } from "/home/drew/Projects/quickbase-js/src/quickbaseClient";
+import {
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+  QB_TABLE_ID_2,
+} from "/home/drew/Projects/quickbase-js/tests/setup.ts";
+
+test(
+  "QuickbaseClient Integration - deleteRelationship > creates and deletes a relationship in QuickBase",
+  { timeout: 60000 }, // 60 seconds for two API calls
+  async () => {
+    // Validate environment variables
+    if (!QB_REALM) throw new Error("QB_REALM is not defined in .env");
+    if (!QB_USER_TOKEN) throw new Error("QB_USER_TOKEN is not defined in .env");
+    if (!QB_TABLE_ID_1) throw new Error("QB_TABLE_ID_1 is not defined in .env");
+    if (!QB_TABLE_ID_2) throw new Error("QB_TABLE_ID_2 is not defined in .env");
+
+    // Initialize client
+    const client = quickbase({
+      realm: QB_REALM,
+      userToken: QB_USER_TOKEN,
+      debug: true,
+    });
+
+    // Step 1: Create a relationship
+    const uniqueLabel = `TestRelationship_${Date.now()}`;
+    const createRequestBody = {
+      parentTableId: QB_TABLE_ID_1,
+      foreignKeyField: { label: uniqueLabel },
+      lookupFieldIds: [6], // Assuming field 6 exists in QB_TABLE_ID_1
+      summaryFields: [
+        {
+          summaryFid: 6, // Assuming field 6 in QB_TABLE_ID_2 is numeric
+          label: `Sum_${uniqueLabel}`,
+          accumulationType: "SUM",
+        },
+      ],
+    };
+
+    console.log("Config used:", {
+      realm: QB_REALM,
+      userToken: "[REDACTED]",
+      parentTableId: QB_TABLE_ID_1,
+      childTableId: QB_TABLE_ID_2,
+    });
+    console.log("Creating relationship with:", createRequestBody);
+
+    const createResponse = await client.createRelationship({
+      tableId: QB_TABLE_ID_2,
+      body: createRequestBody,
+    });
+
+    console.log(
+      "Created relationship response:",
+      JSON.stringify(createResponse, null, 2)
+    );
+
+    // Verify creation
+    expect(createResponse).toBeDefined();
+    expect(createResponse.id).toBeDefined();
+    expect(createResponse.parentTableId).toBe(QB_TABLE_ID_1);
+    expect(createResponse.childTableId).toBe(QB_TABLE_ID_2);
+    expect(createResponse.foreignKeyField).toBeDefined();
+    expect(createResponse.foreignKeyField?.label).toBe(uniqueLabel);
+
+    const relationshipId = createResponse.id;
+    const foreignKeyFieldId = createResponse.foreignKeyField?.id;
+
+    // Step 2: Delete the relationship
+    console.log("Deleting relationship with ID:", relationshipId);
+    const deleteResponse = await client.deleteRelationship({
+      tableId: QB_TABLE_ID_2,
+      relationshipId,
+    });
+
+    console.log(
+      "Delete relationship response:",
+      JSON.stringify(deleteResponse, null, 2)
+    );
+
+    // Verify deletion (adjusted to match actual response)
+    expect(deleteResponse).toBeDefined();
+    expect(deleteResponse.relationshipId).toBe(relationshipId); // Updated to use "relationshipId"
+
+    // Step 3: Confirm relationship is gone (or non-functional)
+    try {
+      const relationships = await client.getRelationships({
+        tableId: QB_TABLE_ID_2,
+      });
+      console.log(
+        "Relationships after deletion:",
+        JSON.stringify(relationships, null, 2)
+      );
+      // Check if the relationship is still listed (metadata might persist)
+      const deletedRelationship = relationships.relationships.find(
+        (r) => r.id === relationshipId
+      );
+      if (deletedRelationship) {
+        console.log("Relationship metadata persists:", deletedRelationship);
+        expect(deletedRelationship.foreignKeyField).toBeUndefined(); // Should lack fields
+      }
+    } catch (error) {
+      console.error("Error fetching relationships post-deletion:", error);
+      expect(error.message).toMatch(/404|not found/i); // Optional stricter check
+    }
+
+    // Cleanup remaining fields
+    const lookupFieldId = createResponse.lookupFields[0]?.id;
+    const summaryFieldId = createResponse.summaryFields[0]?.id;
+
+    if (foreignKeyFieldId) {
+      await client.deleteFields({
+        tableId: QB_TABLE_ID_2,
+        body: { fieldIds: [foreignKeyFieldId] },
+      });
+      console.log(
+        `Deleted foreign key field ${foreignKeyFieldId} from ${QB_TABLE_ID_2}`
+      );
+    }
+    if (lookupFieldId) {
+      await client.deleteFields({
+        tableId: QB_TABLE_ID_2,
+        body: { fieldIds: [lookupFieldId] },
+      });
+      console.log(
+        `Deleted lookup field ${lookupFieldId} from ${QB_TABLE_ID_2}`
+      );
+    }
+    if (summaryFieldId) {
+      await client.deleteFields({
+        tableId: QB_TABLE_ID_1,
+        body: { fieldIds: [summaryFieldId] },
+      });
+      console.log(
+        `Deleted summary field ${summaryFieldId} from ${QB_TABLE_ID_1}`
+      );
+    }
+  }
+);