quickbase-js 1.1.0-beta.3 → 1.1.0-beta.4

package/src/log-gen.ts

@@ -13,13 +13,15 @@ const excludeDirs: string[] = ["node_modules", ".git", "specs"];
 // prettier-ignore
 const includeFolders: string[] = [
   // "src/code-generation",
+  // "src/code-generation/definitions",
+  // "src/code-generation/paths",
 ];
 
 // prettier-ignore
 const includeRecursiveFolders: string[] = [
-  // "tests",
+  "tests",
   "tests/vitest/unit",
-  // "tests/vitest/qb"
+  "tests/vitest/qb"
 ];
 
 // prettier-ignore
@@ -30,8 +32,8 @@ const includeFiles: string[] = [
   // "vitest.config.ts",
   // "src/utils.ts",
   // "src/tokenCache.ts",
-  "src/generated-unified/QuickbaseClient.ts",
-  "src/quickbaseClient.ts",
+  // "src/generated-unified/QuickbaseClient.ts",
+  // "src/quickbaseClient.ts",
 ];
 
 const projectGoals: string[] = [
@@ -75,8 +77,8 @@ const pipelineOverview: string[] = [
   "getTempTokenDBID() method is wrapped to enhance temporary token generation reuse interacting with a token cache.",
   "#",
   "npm run fix-spec: Generates quickbase-fixed.json from the latest QuickBase_RESTful*.json file.",
-  "npm run regenerate: Generates raw TypeScript-fetch files in src/generated/.",
-  "npm run generate-unified: Generates a unified QuickbaseClient.ts interface in src/generated-unified/.",
+  "npm run regenerate:openapi Generates raw TypeScript-fetch files in src/generated/.",
+  "npm run generate:unified: Generates a unified QuickbaseClient.ts interface in src/generated-unified/.",
 ];
 
 interface TreeNode {

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

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

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

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

@@ -0,0 +1,174 @@
+// 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/getFieldsUsage.test.ts

@@ -0,0 +1,77 @@
+// 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,4 +1,28 @@
-// Optional: Only add if you need to export tests
+// 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";