quickbase-js 1.1.0-beta.6 → 1.2.0

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

@@ -1,232 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
-
-describe("QuickbaseClient Integration - getFields", () => {
-  const client = createClient();
-
-  it(
-    "fetches real field data from QuickBase",
-    async () => {
-      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 result = await client.getFields({
-        tableId: QB_TABLE_ID_1,
-        includeFieldPerms: true,
-      });
-      console.log("Real API response:", result);
-      expect(result).toEqual(
-        expect.arrayContaining([
-          expect.objectContaining({
-            id: 1,
-            label: "Date Created",
-            fieldType: "timestamp",
-            noWrap: true,
-            bold: false,
-            required: false,
-            appearsByDefault: false,
-            findEnabled: false,
-            unique: false,
-            doesDataCopy: false,
-            fieldHelp: "",
-            audited: false,
-            properties: expect.objectContaining({
-              primaryKey: false,
-              foreignKey: false,
-              sortAsGiven: true,
-              carryChoices: true,
-              allowNewChoices: false,
-              formula: "",
-              defaultValue: "",
-            }),
-            permissions: expect.arrayContaining([
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Viewer",
-                roleId: 10,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Participant",
-                roleId: 11,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Administrator",
-                roleId: 12,
-              }),
-            ]),
-          }),
-          expect.objectContaining({
-            id: 2,
-            label: "Date Modified",
-            fieldType: "timestamp",
-            noWrap: true,
-            bold: false,
-            required: false,
-            appearsByDefault: false,
-            findEnabled: false,
-            unique: false,
-            doesDataCopy: false,
-            fieldHelp: "",
-            audited: false,
-            properties: expect.objectContaining({
-              primaryKey: false,
-              foreignKey: false,
-              sortAsGiven: true,
-              carryChoices: true,
-              allowNewChoices: false,
-              formula: "",
-              defaultValue: "",
-            }),
-            permissions: expect.arrayContaining([
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Viewer",
-                roleId: 10,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Participant",
-                roleId: 11,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Administrator",
-                roleId: 12,
-              }),
-            ]),
-          }),
-          expect.objectContaining({
-            id: 3,
-            label: "Record ID#",
-            fieldType: "recordid",
-            noWrap: true,
-            bold: false,
-            required: false,
-            appearsByDefault: false,
-            findEnabled: false,
-            unique: true,
-            doesDataCopy: false,
-            fieldHelp: "",
-            audited: false,
-            properties: expect.objectContaining({
-              primaryKey: true,
-              foreignKey: false,
-              sortAsGiven: true,
-              carryChoices: true,
-              allowNewChoices: false,
-              formula: "",
-              defaultValue: "",
-            }),
-            permissions: expect.arrayContaining([
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Viewer",
-                roleId: 10,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Participant",
-                roleId: 11,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Administrator",
-                roleId: 12,
-              }),
-            ]),
-          }),
-          expect.objectContaining({
-            id: 4,
-            label: "Record Owner",
-            fieldType: "user",
-            noWrap: true,
-            bold: false,
-            required: false,
-            appearsByDefault: false,
-            findEnabled: true,
-            unique: false,
-            doesDataCopy: false,
-            fieldHelp: "",
-            audited: false,
-            properties: expect.objectContaining({
-              primaryKey: false,
-              foreignKey: false,
-              sortAsGiven: true,
-              carryChoices: true,
-              allowNewChoices: true,
-              formula: "",
-              defaultValue: "",
-            }),
-            permissions: expect.arrayContaining([
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Viewer",
-                roleId: 10,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Participant",
-                roleId: 11,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Administrator",
-                roleId: 12,
-              }),
-            ]),
-          }),
-          expect.objectContaining({
-            id: 5,
-            label: "Last Modified By",
-            fieldType: "user",
-            noWrap: true,
-            bold: false,
-            required: false,
-            appearsByDefault: false,
-            findEnabled: true,
-            unique: false,
-            doesDataCopy: false,
-            fieldHelp: "",
-            audited: false,
-            properties: expect.objectContaining({
-              primaryKey: false,
-              foreignKey: false,
-              sortAsGiven: true,
-              carryChoices: true,
-              allowNewChoices: true,
-              formula: "",
-              defaultValue: "",
-            }),
-            permissions: expect.arrayContaining([
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Viewer",
-                roleId: 10,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Participant",
-                roleId: 11,
-              }),
-              expect.objectContaining({
-                permissionType: "Modify",
-                role: "Administrator",
-                roleId: 12,
-              }),
-            ]),
-          }),
-        ])
-      );
-    },
-    { timeout: 10000 }
-  );
-});

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

@@ -1,77 +0,0 @@
-// 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 - getFieldsUsage", () => {
-  const client = createClient();
-
-  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).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
-
-  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`);
-
-    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("Starting retrieval with skip=1 and top=1");
-    const response = await client.getFieldsUsage({
-      tableId: QB_TABLE_ID_1,
-      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(
-      `Retrieved ${response.length} field usage entries with skip=1 and top=1`
-    );
-  }, 15000); // 15-second timeout
-
-  it("fails with invalid table ID", async () => {
-    const invalidTableId = "invalid_dbid";
-    console.log(`Starting retrieval with invalid table ID ${invalidTableId}`);
-    await expect(
-      client.getFieldsUsage({
-        tableId: invalidTableId,
-      })
-    ).rejects.toMatchObject({
-      message: expect.stringContaining(
-        "API Error: Access denied (Status: 401)"
-      ),
-    });
-    console.log(`Confirmed 401 for invalid table ID ${invalidTableId}`);
-  }, 15000); // 15-second timeout
-});

package/tests/vitest/qb/index.ts

@@ -1,28 +0,0 @@
-// tests/vitest/qb/index.ts
-
-// Apps
-export * from "./apps/copyApp.test.ts";
-export * from "./apps/createApp.test.ts";
-export * from "./apps/deleteApp.test.ts";
-export * from "./apps/getApp.test.ts";
-
-// Fields
-export * from "./fields/createField.test.ts";
-export * from "./fields/deleteFields.test.ts";
-export * from "./fields/getFields.test.ts";
-export * from "./fields/getField.test.ts"; // Added new getField test
-export * from "./fields/getFieldsUsage.test.ts";
-export * from "./fields/getFieldUsage.test.ts";
-
-// Records
-export * from "./records/deleteRecords.test.ts";
-export * from "./records/runQuery.test.ts";
-export * from "./records/upsert.test.ts";
-
-// Tables
-export * from "./tables/createTable.test.ts";
-export * from "./tables/deleteTable.test.ts";
-export * from "./tables/getAppTables.test.ts";
-export * from "./tables/getRelationships.test.ts";
-export * from "./tables/getTable.test.ts";
-export * from "./tables/updateTable.test.ts";

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