quickbase-js 1.1.0-beta.5 → 1.1.0

package/tests/vitest/qb/apps/deleteApp.test.ts

@@ -1,76 +0,0 @@
-// tests/vitest/qb/apps/deleteApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - deleteApp > deletes an app in QuickBase",
-  { timeout: 30000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-      useTempTokens: false,
-    };
-    const client = quickbase(config);
-
-    const appName = `TempApp_${Date.now()}`;
-    const createBody = {
-      name: appName,
-      description: "Temporary app for deleteApp test",
-      assignToken: true, // Match createApp.test.ts
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "",
-    });
-    console.log("Creating temporary app with:", createBody);
-    const createStartTime = Date.now();
-    let createResponse;
-    try {
-      createResponse = await client.createApp({ body: createBody });
-      const createDuration = Date.now() - createStartTime;
-      console.log(`createApp completed in ${createDuration}ms`);
-      console.log("Created app response:", createResponse);
-
-      expect(createResponse).toBeDefined();
-      expect(createResponse.id).toBeDefined();
-      expect(createResponse.name).toBe(appName);
-    } catch (error) {
-      const createDuration = Date.now() - createStartTime;
-      console.error(`createApp failed after ${createDuration}ms:`, error);
-      throw error;
-    }
-
-    const deleteBody = {
-      name: appName,
-    };
-    console.log("Deleting app with:", deleteBody);
-    const deleteStartTime = Date.now();
-    try {
-      const deleteResponse = await client.deleteApp({
-        appId: createResponse.id,
-        body: deleteBody,
-      });
-      const deleteDuration = Date.now() - deleteStartTime;
-      console.log(`deleteApp completed in ${deleteDuration}ms`);
-      console.log("Delete app response:", deleteResponse);
-
-      expect(deleteResponse).toBeDefined();
-      expect(deleteResponse.deletedAppId).toBe(createResponse.id);
-    } catch (error) {
-      const deleteDuration = Date.now() - deleteStartTime;
-      console.error(`deleteApp failed after ${deleteDuration}ms:`, error);
-      if (error instanceof Error && "response" in error) {
-        try {
-          const errorBody = await (error as any).response.json();
-          console.error("Full deleteApp error response:", errorBody);
-        } catch (e) {
-          console.error("Could not parse error response:", e);
-        }
-      }
-      throw error;
-    }
-  }
-);

package/tests/vitest/qb/apps/getApp.test.ts

@@ -1,40 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getApp > fetches real app 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 getAppId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const result = await client.getApp({ appId: getAppId });
-    console.log("Real API response:", result);
-
-    expect(result).toEqual({
-      id: getAppId,
-      name: "qb-copy",
-      created: expect.any(Date), // Matches Date object from client
-      updated: expect.any(Date), // Matches Date object from client
-      description: "",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      dateFormat: "MM-DD-YYYY",
-      hasEveryoneOnTheInternet: false,
-      memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
-      securityProperties: {
-        allowClone: false,
-        allowExport: true,
-        enableAppTokens: true,
-        hideFromPublic: false,
-        mustBeRealmApproved: false,
-        useIPFilter: false,
-      },
-    });
-  }
-);

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

@@ -1,78 +0,0 @@
-// tests/vitest/qb/fields/createField.test.ts (updated)
-import { describe, it, expect, afterAll } from "vitest";
-import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
-
-describe("QuickbaseClient Integration - createField", () => {
-  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 with user token", async () => {
-    const uniqueLabel = `TestField_${Date.now()}`;
-    const response = await client.createField({
-      tableId: QB_TABLE_ID_1,
-      body: {
-        label: uniqueLabel,
-        fieldType: "text",
-        fieldHelp: "Created via integration test",
-        addToForms: true,
-      },
-    });
-
-    expect(response.id).toBeDefined();
-    expect(response.label).toBe(uniqueLabel);
-    expect(response.fieldType).toBe("text");
-    expect(response.fieldHelp).toBe("Created via integration test");
-
-    createdFieldIds.push(response.id);
-    console.log(`Created field ${uniqueLabel} with ID ${response.id}`);
-  });
-
-  it("fails with invalid field type", async () => {
-    const uniqueLabel = `InvalidField_${Date.now()}`;
-    await expect(
-      client.createField({
-        tableId: QB_TABLE_ID_1,
-        body: {
-          label: uniqueLabel,
-          fieldType: "invalid_type" as "text", // Type assertion to bypass compile-time check
-          fieldHelp: "Should fail",
-        },
-      })
-    ).rejects.toThrow("API Error: Bad Request (Status: 400)");
-  });
-
-  it("fails with missing label", async () => {
-    await expect(
-      client.createField({
-        tableId: QB_TABLE_ID_1,
-        body: {
-          label: "",
-          fieldType: "text",
-        },
-      })
-    ).rejects.toThrow("API Error: Invalid input (Status: 400)");
-  });
-});

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

@@ -1,89 +0,0 @@
-// tests/vitest/qb/fields/deleteFields.test.ts
-import { describe, it, expect, beforeAll } from "vitest";
-import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
-
-describe("QuickbaseClient Integration - deleteFields", () => {
-  const client = createClient();
-
-  let fieldIdsToDelete: number[] = [];
-
-  beforeAll(async () => {
-    try {
-      // Create test fields to delete
-      const fieldLabels = ["DeleteTest1", "DeleteTest2"];
-      for (const label of fieldLabels) {
-        const response = await client.createField({
-          tableId: QB_TABLE_ID_1,
-          body: {
-            label,
-            fieldType: "text",
-            fieldHelp: "Test field for deletion",
-          },
-        });
-        fieldIdsToDelete.push(response.id);
-        console.log(`Created field ${label} with ID ${response.id}`);
-      }
-      if (fieldIdsToDelete.length !== 2) {
-        throw new Error("Failed to create all test fields");
-      }
-    } catch (error) {
-      console.error("beforeAll failed:", error);
-      throw error; // Fail the suite if setup fails
-    }
-  });
-
-  it("deletes fields successfully with user token", async () => {
-    try {
-      const response = await client.deleteFields({
-        tableId: QB_TABLE_ID_1,
-        body: {
-          fieldIds: fieldIdsToDelete,
-        },
-      });
-
-      console.log("deleteFields response:", JSON.stringify(response, null, 2));
-
-      expect(response).toBeDefined();
-      expect(response.deletedFieldIds).toEqual(
-        expect.arrayContaining(fieldIdsToDelete)
-      );
-      expect(response.errors ?? []).toHaveLength(0); // Handle undefined errors
-    } catch (error) {
-      console.error("deleteFields failed:", error);
-      throw error; // Re-throw to fail the test with details
-    }
-  });
-
-  it("handles partial success with errors", async () => {
-    const newField = await client.createField({
-      tableId: QB_TABLE_ID_1,
-      body: {
-        label: "DeleteTest3",
-        fieldType: "text",
-      },
-    });
-    console.log(`Created field DeleteTest3 with ID ${newField.id}`);
-
-    const invalidFieldId = 999999; // Assume this ID doesn’t exist
-    const fieldIds = [newField.id, invalidFieldId];
-
-    const response = await client.deleteFields({
-      tableId: QB_TABLE_ID_1,
-      body: { fieldIds },
-    });
-
-    expect(response.deletedFieldIds).toContain(newField.id);
-    expect(response.deletedFieldIds).not.toContain(invalidFieldId);
-    expect(response.errors).toHaveLength(1);
-    expect(response.errors[0]).toMatch(/Field: 999999 was not found/i);
-  });
-
-  it("fails with invalid request (empty fieldIds)", async () => {
-    await expect(
-      client.deleteFields({
-        tableId: QB_TABLE_ID_1,
-        body: { fieldIds: [] },
-      })
-    ).rejects.toThrow("API Error: Bad Request (Status: 400)");
-  });
-});

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

@@ -1,85 +0,0 @@
-// tests/vitest/qb/fields/getField.test.ts
-import { describe, it, expect } from "vitest";
-import { createClient, QB_TABLE_ID_1 } from "../../../setup.ts";
-
-describe("QuickbaseClient Integration - getField", () => {
-  const client = createClient();
-
-  it("retrieves an existing field with user token", async () => {
-    // Create a field to ensure we have a known field ID to retrieve
-    const uniqueLabel = `TestField_${Date.now()}`;
-    const createResponse = await client.createField({
-      tableId: QB_TABLE_ID_1,
-      body: {
-        label: uniqueLabel,
-        fieldType: "text",
-        fieldHelp: "Created for getField integration test",
-        addToForms: true,
-      },
-    });
-
-    expect(createResponse.id).toBeDefined();
-    const fieldId = createResponse.id;
-    console.log(`Created field ${uniqueLabel} with ID ${fieldId} for testing`);
-
-    // Test getField with the created field
-    const response = await client.getField({
-      fieldId: fieldId,
-      tableId: QB_TABLE_ID_1,
-      includeFieldPerms: true,
-    });
-
-    expect(response.id).toBe(fieldId);
-    expect(response.label).toBe(uniqueLabel);
-    expect(response.fieldType).toBe("text");
-    expect(response.fieldHelp).toBe("Created for getField integration test");
-    expect(response.permissions).toBeDefined();
-    expect(Array.isArray(response.permissions)).toBe(true);
-    console.log(`Retrieved field ${response.label} with ID ${response.id}`);
-
-    // Clean up the created field
-    try {
-      const deleteResponse = await client.deleteFields({
-        tableId: QB_TABLE_ID_1,
-        body: { fieldIds: [fieldId] },
-      });
-      console.log(
-        `Cleaned up field ${fieldId}: ${JSON.stringify(deleteResponse)}`
-      );
-    } catch (error) {
-      console.error(`Failed to clean up field ${fieldId}:`, error);
-    }
-  }, 10000); // Increase timeout to 10 seconds
-
-  it("fails with non-existent field ID", async () => {
-    const nonExistentFieldId = 999999; // Assuming this ID doesn’t exist
-    await expect(
-      client.getField({
-        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", async () => {
-    const invalidTableId = "invalid_dbid";
-    await expect(
-      client.getField({
-        fieldId: 1, // Arbitrary field ID
-        tableId: invalidTableId,
-      })
-    ).rejects.toMatchObject({
-      message: expect.stringContaining(
-        "API Error: Invalid request (Status: 400)"
-      ),
-    });
-    console.log(`Confirmed 400 for invalid table ID ${invalidTableId}`);
-  });
-});

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