quickbase-js 0.1.0-beta.8 → 1.0.0

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

@@ -1,174 +0,0 @@
-// 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";
-import { FieldUsage } from "@/generated/models";
-
-describe("QuickbaseClient Integration - getFieldUsage", () => {
-  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");
-
-      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");
-
-      // 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("fails with non-existent field ID", { timeout: 15000 }, async () => {
-    const nonExistentFieldId = 999999;
-
-    console.log("Attempting to fetch usage for non-existent field:", {
-      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)"
-      ),
-    });
-
-    console.log(
-      `Confirmed 404 for non-existent field ID ${nonExistentFieldId}`
-    );
-  });
-
-  it("fails with invalid table ID", { timeout: 15000 }, async () => {
-    const invalidTableId = "invalid_dbid";
-    const fieldId = 6;
-
-    console.log("Attempting to fetch usage with invalid table ID:", {
-      tableId: invalidTableId,
-      fieldId,
-    });
-    await expect(
-      client.getFieldUsage({
-        fieldId,
-        tableId: invalidTableId,
-      })
-    ).rejects.toMatchObject({
-      message: expect.stringContaining(
-        "API Error: Access denied (Status: 401)"
-      ),
-    });
-
-    console.log(`Confirmed 401 for invalid table ID ${invalidTableId}`);
-  });
-});

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/fields/updateField.test.ts

@@ -1,93 +0,0 @@
-// tests/vitest/qb/fields/updateField.test.ts
-import { describe, it, expect, beforeAll, afterAll } from "vitest";
-import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
-
-describe("QuickbaseClient Integration - updateField", () => {
-  const client = createClient();
-  let fieldIdToUpdate: number;
-
-  // Setup: Create a test field to update
-  beforeAll(async () => {
-    try {
-      const response = await client.createField({
-        tableId: QB_TABLE_ID_1,
-        body: {
-          label: "UpdateTestField",
-          fieldType: "text",
-          fieldHelp: "Test field for updating",
-        },
-      });
-      fieldIdToUpdate = response.id;
-      console.log(`Created field UpdateTestField with ID ${fieldIdToUpdate}`);
-    } catch (error) {
-      console.error("beforeAll failed:", error);
-      throw error; // Fail the suite if setup fails
-    }
-  });
-
-  // Teardown: Delete the test field
-  afterAll(async () => {
-    try {
-      if (fieldIdToUpdate) {
-        const response = await client.deleteFields({
-          tableId: QB_TABLE_ID_1,
-          body: { fieldIds: [fieldIdToUpdate] },
-        });
-        console.log(
-          `Deleted field ${fieldIdToUpdate}:`,
-          JSON.stringify(response, null, 2)
-        );
-      }
-    } catch (error) {
-      console.error("afterAll cleanup failed:", error);
-      // Don’t throw here to avoid masking test results
-    }
-  });
-
-  it(
-    "updates a field successfully with user token",
-    { timeout: 10000 },
-    async () => {
-      try {
-        const updatedLabel = "UpdatedTestField";
-        console.log("Sending updateField request at:", new Date());
-        const response = await client.updateField({
-          tableId: QB_TABLE_ID_1,
-          fieldId: fieldIdToUpdate,
-          body: {
-            label: updatedLabel,
-            fieldHelp: "Updated help text",
-          },
-        });
-        console.log("updateField response received at:", new Date());
-        console.log("Response:", JSON.stringify(response, null, 2));
-
-        // Verify the update was successful
-        expect(response).toBeDefined();
-        expect(response.id).toBe(fieldIdToUpdate);
-        expect(response.label).toBe(updatedLabel);
-        expect(response.fieldHelp).toBe("Updated help text");
-      } catch (error) {
-        console.error("updateField failed:", error);
-        throw error; // Re-throw to fail the test with details
-      }
-    }
-  );
-
-  it("fails with invalid field ID", { timeout: 10000 }, async () => {
-    try {
-      await expect(
-        client.updateField({
-          tableId: QB_TABLE_ID_1,
-          fieldId: 999999, // Invalid field ID
-          body: {
-            label: "InvalidUpdate",
-          },
-        })
-      ).rejects.toThrow("API Error: Item not found (Status: 404)"); // Updated to match actual error
-    } catch (error) {
-      console.error("updateField with invalid ID failed unexpectedly:", error);
-      throw error;
-    }
-  });
-});

package/tests/vitest/qb/index.ts

@@ -1,29 +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";
-export * from "./tables/updateRelationship.test.ts";