quickbase-js 0.1.0-beta.10

package/tests/vitest/qb/records/deleteRecords.test.ts

@@ -0,0 +1,110 @@
+// tests/vitest/qb/records/deleteRecords.test.ts
+import { describe, test, expect, beforeEach, afterEach } from "vitest";
+import { quickbase } from "@/quickbaseClient.ts";
+import {
+  Upsert200Response,
+  Upsert207Response,
+} from "/home/drew/Projects/quickbase-js/src/generated/models";
+
+const TABLE_ID = "buwai2zws";
+const UNIQUE_FIELD_ID = 3; // Record ID field
+const MARKER_FIELD_ID = 6; // Text field for marking test records
+
+describe("QuickbaseClient - DeleteRecords Integration", () => {
+  const qb = quickbase({
+    realm: "builderprogram-dbradford6815",
+    userToken: process.env.QB_USER_TOKEN,
+    debug: true,
+  });
+
+  beforeEach(async () => {
+    try {
+      await qb.deleteRecords({
+        body: {
+          from: TABLE_ID,
+          where: `{${MARKER_FIELD_ID}.CT.'test-marker-delete'}`,
+        },
+      });
+    } catch (e) {
+      // Ignore if no records exist
+    }
+  });
+
+  afterEach(async () => {
+    try {
+      await qb.deleteRecords({
+        body: {
+          from: TABLE_ID,
+          where: `{${MARKER_FIELD_ID}.CT.'test-marker-delete'}`,
+        },
+      });
+    } catch (e) {}
+  });
+
+  test(
+    "deletes a newly upserted record",
+    async () => {
+      const upsertResponse: Upsert200Response | Upsert207Response =
+        await qb.upsert({
+          body: {
+            to: TABLE_ID,
+            data: [{ [MARKER_FIELD_ID]: { value: "test-marker-delete" } }],
+            fieldsToReturn: [UNIQUE_FIELD_ID], // Return record ID
+          },
+        });
+
+      // Check metadata and createdRecordIds
+      expect(
+        upsertResponse.metadata,
+        "Expected metadata to be defined"
+      ).toBeDefined();
+      expect(
+        upsertResponse.metadata?.createdRecordIds,
+        "Expected createdRecordIds to be defined"
+      ).toBeDefined();
+
+      const createdRecordIds = upsertResponse.metadata?.createdRecordIds;
+      if (!createdRecordIds || createdRecordIds.length === 0) {
+        throw new Error("Expected at least one created record ID");
+      }
+
+      const recordId = createdRecordIds[0];
+      expect(recordId, "Expected recordId to be defined").toBeDefined();
+
+      // Check data
+      expect(upsertResponse.data, "Expected data to be defined").toBeDefined();
+      if (!upsertResponse.data || upsertResponse.data.length === 0) {
+        throw new Error("Expected at least one data entry");
+      }
+
+      const recordData = upsertResponse.data[0];
+      expect(
+        recordData[UNIQUE_FIELD_ID]?.value,
+        "Expected record ID in data to match created record ID"
+      ).toBe(recordId);
+
+      const deleteResponse = await qb.deleteRecords({
+        body: { from: TABLE_ID, where: `{${UNIQUE_FIELD_ID}.EX.${recordId}}` },
+      });
+
+      expect(deleteResponse).toEqual({ numberDeleted: 1 });
+
+      const checkResponse = await qb.deleteRecords({
+        body: { from: TABLE_ID, where: `{${UNIQUE_FIELD_ID}.EX.${recordId}}` },
+      });
+      expect(checkResponse.numberDeleted).toBe(0);
+    },
+    { timeout: 10000 }
+  );
+
+  test(
+    "handles empty result when no records match",
+    async () => {
+      const response = await qb.deleteRecords({
+        body: { from: TABLE_ID, where: "{3.EX.'999999'}" },
+      });
+      expect(response).toEqual({ numberDeleted: 0 });
+    },
+    { timeout: 10000 }
+  );
+});

package/tests/vitest/qb/records/runQuery.test.ts

@@ -0,0 +1,146 @@
+// tests/vitest/qb/records/runQuery.test.ts
+import { describe, it, expect } from "vitest";
+import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
+import {
+  RunQueryRequest,
+  RunQueryResponse,
+  Upsert200Response,
+  Upsert207Response,
+} from "@/generated/models";
+
+// Define a type for field data with a value property (matches generated Record type)
+interface FieldData {
+  value: any; // Adjust type based on your needs (e.g., string | number)
+}
+
+describe("QuickbaseClient Integration - runQuery", () => {
+  let createdRecordId: number;
+
+  it(
+    "queries real records from QuickBase",
+    async () => {
+      const client = createClient();
+
+      // Upsert a test record to query later
+      const upsertResponse: Upsert200Response | Upsert207Response =
+        await client.upsert({
+          body: {
+            to: QB_TABLE_ID_1,
+            data: [
+              {
+                "6": { value: "Test Task " + Date.now() }, // Assuming field 6 is a text field
+              },
+            ],
+            fieldsToReturn: [3, 6], // Record ID# and the text field
+          },
+        });
+
+      // Check metadata and createdRecordIds with null safety
+      expect(
+        upsertResponse.metadata,
+        "Expected metadata to be defined"
+      ).toBeDefined();
+      expect(
+        upsertResponse.metadata?.createdRecordIds,
+        "Expected createdRecordIds to be defined"
+      ).toBeDefined();
+
+      const createdRecordIds = upsertResponse.metadata?.createdRecordIds;
+      if (!createdRecordIds || createdRecordIds.length === 0) {
+        throw new Error("Expected at least one created record ID from upsert");
+      }
+
+      createdRecordId = createdRecordIds[0];
+      expect(
+        createdRecordId,
+        "Expected createdRecordId to be defined"
+      ).toBeDefined();
+      console.log("Created test record with ID:", createdRecordId);
+
+      // Query the record
+      const queryRequest: RunQueryRequest = {
+        from: QB_TABLE_ID_1,
+        select: [3, 6], // Query Record ID# and the text field
+        where: `{3.EX.${createdRecordId}}`, // Filter by the created record
+        sortBy: [{ fieldId: 6, order: "ASC" }],
+        options: { skip: 0, top: 1 },
+      };
+
+      console.log("Config used:", {
+        realm: process.env.QB_REALM,
+        userToken: process.env.QB_USER_TOKEN,
+        tableId: QB_TABLE_ID_1,
+      });
+      console.log("Query request:", queryRequest);
+      const response: RunQueryResponse = await client.runQuery({
+        body: queryRequest,
+      });
+      console.log("Real API response:", response);
+
+      // Assertions with safety checks and type assertion
+      expect(
+        response.data,
+        "Expected response.data to be defined"
+      ).toBeDefined();
+      if (!response.data || response.data.length === 0) {
+        throw new Error(
+          "Expected response.data to contain at least one record"
+        );
+      }
+
+      expect(response.data).toHaveLength(1);
+      const record = response.data[0] as { [key: string]: FieldData };
+      expect(
+        record["3"]?.value,
+        "Expected field 3 to match createdRecordId"
+      ).toBe(createdRecordId);
+      expect(
+        record["6"]?.value,
+        "Expected field 6 to contain 'Test Task'"
+      ).toContain("Test Task");
+
+      expect(
+        response.fields,
+        "Expected response.fields to be defined"
+      ).toBeDefined();
+      if (!response.fields) {
+        throw new Error("Expected response.fields to contain field metadata");
+      }
+      expect(response.fields).toContainEqual({
+        id: 3,
+        label: expect.any(String),
+        type: expect.any(String),
+      });
+      expect(response.fields).toContainEqual({
+        id: 6,
+        label: expect.any(String),
+        type: expect.any(String),
+      });
+
+      expect(
+        response.metadata,
+        "Expected response.metadata to be defined"
+      ).toBeDefined();
+      if (!response.metadata) {
+        throw new Error("Expected response.metadata to be present");
+      }
+      expect(response.metadata).toMatchObject({
+        numFields: 2,
+        numRecords: 1,
+        skip: 0,
+        top: 1,
+        totalRecords: expect.any(Number),
+      });
+
+      // Cleanup: Delete the test record
+      await client.deleteRecords({
+        body: {
+          from: QB_TABLE_ID_1,
+          where: `{3.EX.${createdRecordId}}`, // Assuming field 3 is Record ID#
+        },
+      });
+      console.log("Cleaned up test record with ID:", createdRecordId);
+    },
+    { timeout: 10000 }
+  );
+});

package/tests/vitest/qb/records/upsert.test.ts

@@ -0,0 +1,102 @@
+// tests/vitest/qb/records/upsert.test.ts
+import { describe, test, expect, beforeEach, afterEach } from "vitest";
+import { quickbase } from "@/quickbaseClient.ts";
+import {
+  Upsert200Response,
+  Upsert207Response,
+} from "/home/drew/Projects/quickbase-js/src/generated/models";
+
+const TABLE_ID = "buwai2zws";
+const MARKER_FIELD_ID = 6; // Text field for marking test records
+
+describe("QuickbaseClient - Upsert Integration", () => {
+  const qb = quickbase({
+    realm: "builderprogram-dbradford6815",
+    userToken: process.env.QB_USER_TOKEN,
+    debug: true,
+  });
+
+  beforeEach(async () => {
+    try {
+      await qb.deleteRecords({
+        body: {
+          from: TABLE_ID,
+          where: `{${MARKER_FIELD_ID}.CT.'test-marker-upsert'}`,
+        },
+      });
+    } catch (e) {
+      // Ignore if no records exist
+    }
+  });
+
+  afterEach(async () => {
+    try {
+      await qb.deleteRecords({
+        body: {
+          from: TABLE_ID,
+          where: `{${MARKER_FIELD_ID}.CT.'test-marker-upsert'}`,
+        },
+      });
+    } catch (e) {}
+  });
+
+  test(
+    "creates a new record successfully",
+    async () => {
+      const response: Upsert200Response | Upsert207Response = await qb.upsert({
+        body: {
+          to: TABLE_ID,
+          data: [{ [MARKER_FIELD_ID]: { value: "test-marker-upsert" } }],
+          fieldsToReturn: [MARKER_FIELD_ID, 3], // Return marker and record ID
+        },
+      });
+
+      // Check metadata with null safety
+      expect(
+        response.metadata,
+        "Expected metadata to be defined"
+      ).toBeDefined();
+      if (!response.metadata) {
+        throw new Error("Expected metadata to be present in upsert response");
+      }
+
+      expect(
+        response.metadata.createdRecordIds,
+        "Expected createdRecordIds to be defined"
+      ).toBeDefined();
+      if (!response.metadata.createdRecordIds) {
+        throw new Error(
+          "Expected createdRecordIds to be present in upsert response"
+        );
+      }
+      expect(response.metadata.createdRecordIds.length).toBe(1);
+
+      // Check data with null safety
+      expect(response.data, "Expected data to be defined").toBeDefined();
+      if (!response.data || response.data.length === 0) {
+        throw new Error("Expected at least one record in data");
+      }
+      expect(response.data).toHaveLength(1);
+      expect(response.data[0][MARKER_FIELD_ID]?.value).toBe(
+        "test-marker-upsert"
+      );
+      expect(response.data[0][3]?.value).toBeDefined(); // Record ID assigned by QuickBase
+
+      // Check totalNumberOfRecordsProcessed
+      expect(response.metadata.totalNumberOfRecordsProcessed).toBe(1);
+    },
+    { timeout: 10000 }
+  );
+
+  test(
+    "handles empty data gracefully",
+    async () => {
+      await expect(
+        qb.upsert({
+          body: { to: TABLE_ID, data: [] },
+        })
+      ).rejects.toThrow("API Error: Bad Request (Status: 400)");
+    },
+    { timeout: 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/createTable.test.ts

@@ -0,0 +1,55 @@
+import { test, expect } from "vitest";
+import { quickbase } from "../../../../src/quickbaseClient";
+
+test(
+  "QuickbaseClient Integration - createTable > creates a new table in QuickBase",
+  { timeout: 10000 },
+  async () => {
+    const config = {
+      realm: process.env.QB_REALM || "",
+      userToken: process.env.QB_USER_TOKEN || "",
+      debug: true,
+    };
+    const client = quickbase(config);
+    const appId = "buwai2zpe";
+
+    const tableName = `TestTable_${Date.now()}`;
+    const createBody = {
+      name: tableName,
+      description: "Test table creation",
+      singleRecordName: "TestRecord",
+      pluralRecordName: "TestRecords",
+    };
+
+    console.log("Config used:", config);
+    console.log("Creating table with:", createBody);
+    const response = await client.createTable({ appId, body: createBody });
+
+    expect(response).toBeDefined();
+    expect(response.id).toBeDefined();
+    expect(response.name).toBe(tableName);
+    expect(response.description).toBe(createBody.description);
+    expect(response.singleRecordName).toBe(createBody.singleRecordName);
+    expect(response.pluralRecordName).toBe(createBody.pluralRecordName);
+    expect(response.alias).toMatch(/^_DBID_/);
+    expect(response.created).toBeInstanceOf(Date);
+    expect(response.updated).toBeInstanceOf(Date);
+    expect(response.nextRecordId).toBeGreaterThanOrEqual(1);
+    expect(response.nextFieldId).toBeGreaterThanOrEqual(1);
+    expect(response.defaultSortFieldId).toBeGreaterThanOrEqual(0);
+    expect(response.keyFieldId).toBeGreaterThanOrEqual(1);
+    expect(response.sizeLimit).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
+    expect(response.spaceUsed).toMatch(/^\d+\s(KB|MB)$/); // e.g., "0 KB"
+    expect(response.spaceRemaining).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
+
+    console.log("Real API response:", response);
+
+    // Cleanup: Delete the table to avoid clutter
+    const deleteResponse = await client.deleteTable({
+      tableId: response.id,
+      appId,
+    });
+    expect(deleteResponse.deletedTableId).toBe(response.id);
+    console.log("Cleanup - Deleted table:", deleteResponse);
+  }
+);

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}`
+      );
+    }
+  }
+);