quickbase-js 0.1.0-beta.8 → 1.0.0

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

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

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

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