quickbase-js 0.1.0-beta.12 → 0.1.0-beta.14

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

@@ -1,102 +0,0 @@
-// 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

@@ -1,55 +0,0 @@
-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

@@ -1,143 +0,0 @@
-// 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}`
-      );
-    }
-  }
-);

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

@@ -1,50 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - deleteTable > deletes a table in QuickBase",
-  { timeout: 20000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = "buwai2zpe";
-
-    // Step 1: Create a temporary table to delete
-    const tableName = `DeleteTest_${Date.now()}`;
-    const createBody = {
-      name: tableName,
-      description: "Temporary table for delete test",
-      singleRecordName: "DeleteTest",
-      pluralRecordName: "DeleteTests",
-    };
-    console.log("Creating temporary table with:", createBody);
-    const createResponse = await client.createTable({
-      appId,
-      body: createBody,
-    });
-    expect(createResponse.id).toBeDefined();
-    expect(createResponse.name).toBe(tableName);
-    console.log("Created table:", createResponse);
-    const tableId = createResponse.id;
-
-    // Step 2: Delete the table
-    console.log("Deleting table:", { tableId, appId });
-    const deleteResponse = await client.deleteTable({ tableId, appId });
-    expect(deleteResponse).toBeDefined();
-    expect(deleteResponse.deletedTableId).toBe(tableId);
-    console.log("Delete API response:", deleteResponse);
-
-    // Step 3: Verify the table is gone
-    try {
-      await client.getTable({ tableId, appId });
-      throw new Error("Table should not exist after deletion");
-    } catch (error) {
-      expect(error.message).toMatch(/404|not found/i); // Expect a 404 error
-      console.log("Verified table deletion:", error.message);
-    }
-  }
-);

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

@@ -1,46 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getAppTables > fetches real table data from QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const tablesAppId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const result = await client.getAppTables({ appId: tablesAppId });
-    console.log("Real API response:", result);
-
-    expect(result).toBeDefined();
-    expect(result).toBeInstanceOf(Array);
-    expect(result.length).toBeGreaterThan(0);
-    expect(result).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          id: "buwai2zr4",
-          alias: "_DBID_ROOT",
-          name: expect.any(String), // Allow dynamic name due to updateTable
-          description: expect.any(String), // Allow dynamic description
-          created: expect.any(Date),
-          updated: expect.any(Date), // Allow varying timestamps
-          nextRecordId: expect.any(Number),
-          nextFieldId: expect.any(Number),
-          defaultSortFieldId: expect.any(Number),
-          defaultSortOrder: "DESC",
-          keyFieldId: expect.any(Number),
-          singleRecordName: "Root",
-          pluralRecordName: "Roots",
-          sizeLimit: "500 MB",
-          spaceUsed: expect.any(String),
-          spaceRemaining: "500 MB",
-        }),
-      ])
-    );
-  }
-);

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

@@ -1,80 +0,0 @@
-// tests/vitest/qb/tables/getRelationships.test.ts
-import { describe, test, expect } from "vitest";
-import { quickbase } from "/home/drew/Projects/quickbase-js/src/quickbaseClient.ts";
-import { QB_TABLE_ID_1 } from "/home/drew/Projects/quickbase-js/tests/setup.ts";
-import { GetRelationships200Response } from "/home/drew/Projects/quickbase-js/src/generated/models";
-
-describe("QuickbaseClient Integration - getRelationships", () => {
-  const qb = quickbase({
-    realm: process.env.QB_REALM || "builderprogram-dbradford6815",
-    userToken: process.env.QB_USER_TOKEN || "",
-    debug: true,
-  });
-
-  test("fetches real relationships from QuickBase", async () => {
-    // Ensure environment variables are set
-    if (!process.env.QB_REALM)
-      throw new Error("QB_REALM is not defined in .env");
-    if (!process.env.QB_USER_TOKEN)
-      throw new Error("QB_USER_TOKEN is not defined in .env");
-
-    console.log("Config used:", {
-      realm: process.env.QB_REALM,
-      userToken: process.env.QB_USER_TOKEN,
-      tableId: QB_TABLE_ID_1,
-    });
-
-    const response: GetRelationships200Response = await qb.getRelationships({
-      tableId: QB_TABLE_ID_1, // Query relationships for QB_TABLE_ID_1 (e.g., "buwai2zws")
-      skip: 0,
-    });
-
-    console.log("Real API response:", JSON.stringify(response, null, 2));
-
-    // Basic structure validation
-    expect(response).toBeDefined();
-    expect(response.metadata).toBeDefined();
-    expect(response.metadata).toHaveProperty(
-      "numRelationships",
-      expect.any(Number)
-    );
-    expect(response.metadata).toHaveProperty("skip", 0);
-    expect(response.metadata).toHaveProperty(
-      "totalRelationships",
-      expect.any(Number)
-    );
-    expect(response.relationships).toBeDefined();
-    expect(Array.isArray(response.relationships)).toBe(true);
-
-    // If relationships exist, validate the first one
-    if (response.relationships.length > 0) {
-      const relationship = response.relationships[0];
-      expect(relationship).toHaveProperty("id", expect.any(Number));
-      expect(relationship).toHaveProperty("parentTableId", expect.any(String));
-      expect(relationship).toHaveProperty("childTableId", QB_TABLE_ID_1);
-      expect(relationship).toHaveProperty("foreignKeyField");
-      expect(relationship.foreignKeyField).toHaveProperty(
-        "id",
-        expect.any(Number)
-      );
-      expect(relationship.foreignKeyField).toHaveProperty(
-        "label",
-        expect.any(String)
-      );
-      expect(relationship.foreignKeyField).toHaveProperty(
-        "type",
-        expect.any(String)
-      );
-      expect(relationship).toHaveProperty("isCrossApp", expect.any(Boolean));
-      expect(relationship).toHaveProperty("lookupFields", expect.any(Array));
-
-      // summaryFields is optional; only validate if present
-      if (
-        "summaryFields" in relationship &&
-        relationship.summaryFields !== undefined
-      ) {
-        expect(Array.isArray(relationship.summaryFields)).toBe(true);
-      }
-    }
-  }, 10000); // Timeout as second argument
-});

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

@@ -1,26 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getTable > fetches real table data from QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const tableId = "buwai2zr4";
-    const appId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const response = await client.getTable({ tableId, appId });
-    expect(response).toBeDefined();
-    expect(response.id).toBe(tableId);
-    expect(response.name).toBe("Root"); // Expect original name
-    expect(response.alias).toBe("_DBID_ROOT");
-    expect(response.created).toBeInstanceOf(Date);
-    console.log("Real API response:", response);
-  }
-);