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

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

@@ -0,0 +1,147 @@
+// tests/vitest/unit/fields/getFieldUsage.test.ts
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+} from "@tests/setup.ts";
+import { FieldUsage } from "@/generated/models";
+
+describe("QuickbaseClient Unit - getFieldUsage", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    client = createClient(mockFetch, { realm: QB_REALM, debug: true });
+  });
+
+  it("initializes without errors and has getFieldUsage method", () => {
+    expect(client).toBeDefined();
+    expect(typeof client.getFieldUsage).toBe("function");
+  });
+
+  it("calls getFieldUsage successfully with user token", async () => {
+    const mockResponse: FieldUsage = {
+      field: {
+        id: 6,
+        name: "name",
+        type: "text", // Match QuickBase's lowercase response
+      },
+      usage: {
+        actions: { count: 0 },
+        appHomePages: { count: 0 },
+        dashboards: { count: 2 },
+        defaultReports: { count: 1 },
+        exactForms: { count: 0 },
+        fields: { count: 0 },
+        forms: { count: 1 },
+        notifications: { count: 0 },
+        personalReports: { count: 0 },
+        pipelines: { count: 1 },
+        relationships: { count: 0 },
+        reminders: { count: 0 },
+        reports: { count: 2 },
+        roles: { count: 2 },
+        tableImports: { count: 2 },
+        tableRules: { count: 1 },
+        webhooks: { count: 0 },
+      },
+    };
+
+    // Mock the response as an array to match the updated API behavior
+    mockFetch.mockResolvedValueOnce(
+      new Response(JSON.stringify([mockResponse]), {
+        status: 200,
+        statusText: "OK",
+        headers: { "Content-Type": "application/json" },
+      })
+    );
+
+    const result = await client.getFieldUsage({
+      fieldId: 6,
+      tableId: QB_TABLE_ID_1,
+    });
+
+    // Expect an array and unwrap the first item
+    expect(result).toBeInstanceOf(Array);
+    expect(result).toHaveLength(1);
+    const fieldUsage = result[0];
+
+    expect(fieldUsage).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/usage/6?tableId=${QB_TABLE_ID_1}`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+    expect(fieldUsage.field.id).toBe(6);
+    expect(fieldUsage.field.name).toBe("name");
+    expect(fieldUsage.usage.dashboards.count).toBe(2);
+  });
+
+  it("handles 404 error for non-existent field", async () => {
+    mockFetch.mockResolvedValueOnce(
+      new Response(JSON.stringify({ message: "Field not found" }), {
+        status: 404,
+        statusText: "Not Found",
+        headers: { "Content-Type": "application/json" },
+      })
+    );
+
+    await expect(
+      client.getFieldUsage({
+        fieldId: 999,
+        tableId: QB_TABLE_ID_1,
+      })
+    ).rejects.toThrow("API Error: Field not found (Status: 404)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/usage/999?tableId=${QB_TABLE_ID_1}`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+
+  it("handles 401 error and does not retry with user token", async () => {
+    mockFetch.mockResolvedValueOnce(
+      new Response(JSON.stringify({ message: "Unauthorized" }), {
+        status: 401,
+        statusText: "Unauthorized",
+        headers: { "Content-Type": "application/json" },
+      })
+    );
+
+    await expect(
+      client.getFieldUsage({
+        fieldId: 6,
+        tableId: QB_TABLE_ID_1,
+      })
+    ).rejects.toThrow("API Error: Unauthorized (Status: 401)");
+
+    expect(mockFetch).toHaveBeenCalledTimes(1); // No retry with user token
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/usage/6?tableId=${QB_TABLE_ID_1}`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+});

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

@@ -0,0 +1,160 @@
+// tests/vitest/unit/fields/getFieldsUsage.test.ts
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_REALM,
+  QB_TABLE_ID_1,
+  QB_USER_TOKEN,
+} from "@tests/setup.ts";
+import { FieldUsage } from "@/generated/models";
+
+describe("QuickbaseClient Unit - getFieldsUsage", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    client = createClient(mockFetch, { debug: true });
+  });
+
+  it("initializes without errors and has getFieldsUsage method", () => {
+    expect(client).toBeDefined();
+    expect(typeof client.getFieldsUsage).toBe("function");
+  });
+
+  it("calls getFieldsUsage successfully with user token", async () => {
+    const mockResponse: FieldUsage[] = [
+      {
+        field: {
+          id: 6,
+          name: "name",
+          type: "Text",
+        },
+        usage: {
+          actions: { count: 0 },
+          appHomePages: { count: 0 },
+          dashboards: { count: 2 },
+          defaultReports: { count: 1 },
+          exactForms: { count: 0 },
+          fields: { count: 0 },
+          forms: { count: 1 },
+          notifications: { count: 0 },
+          personalReports: { count: 0 },
+          pipelines: { count: 1 },
+          relationships: { count: 0 },
+          reminders: { count: 0 },
+          reports: { count: 2 },
+          roles: { count: 2 },
+          tableImports: { count: 3 },
+          tableRules: { count: 1 },
+          webhooks: { count: 0 },
+        },
+      },
+    ];
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getFieldsUsage({
+      tableId: QB_TABLE_ID_1,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/usage?tableId=${QB_TABLE_ID_1}`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+
+  it("calls getFieldsUsage with skip and top parameters", async () => {
+    const mockResponse: FieldUsage[] = [
+      {
+        field: {
+          id: 7,
+          name: "priority",
+          type: "Text",
+        },
+        usage: {
+          actions: { count: 1 },
+          appHomePages: { count: 0 },
+          dashboards: { count: 0 },
+          defaultReports: { count: 0 },
+          exactForms: { count: 0 },
+          fields: { count: 1 },
+          forms: { count: 0 },
+          notifications: { count: 0 },
+          personalReports: { count: 0 },
+          pipelines: { count: 0 },
+          relationships: { count: 0 },
+          reminders: { count: 0 },
+          reports: { count: 1 },
+          roles: { count: 1 },
+          tableImports: { count: 0 },
+          tableRules: { count: 0 },
+          webhooks: { count: 0 },
+        },
+      },
+    ];
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getFieldsUsage({
+      tableId: QB_TABLE_ID_1,
+      skip: 1,
+      top: 1,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/usage?tableId=${QB_TABLE_ID_1}&skip=1&top=1`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+
+  it("handles 404 error for non-existent table", async () => {
+    const nonExistentTableId = "nonexistent_dbid";
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 404,
+      json: () => Promise.resolve({ message: "Table not found" }),
+    });
+
+    await expect(
+      client.getFieldsUsage({ tableId: nonExistentTableId })
+    ).rejects.toThrow("API Error: Table not found (Status: 404)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/usage?tableId=${nonExistentTableId}`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+});

package/tests/vitest/unit/index.ts

@@ -1,4 +1,33 @@
-// tests/unit/index.ts
+// tests/vitest/unit/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";
+
+// Auth
+export * from "./auth/fetchTempToken401.test.ts";
+export * from "./auth/getTempToken.test.ts";
+export * from "./auth/retryOn401.test.ts";
+export * from "./auth/two401s.test.ts";
+
+// Fields
 export * from "./fields/getFields.test.ts";
+export * from "./fields/getField.test.ts";
+export * from "./fields/createField.test.ts";
+export * from "./fields/deleteFields.test.ts";
+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/unit/tables/getRelationships.test.ts

@@ -0,0 +1,259 @@
+// tests/vitest/unit/relationships/getRelationships.test.ts
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+  QB_TABLE_ID_2,
+} from "@tests/setup.ts";
+import { GetRelationships200Response } from "/home/drew/Projects/quickbase-js/src/generated/models";
+
+describe("QuickbaseClient Unit - getRelationships", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    client = createClient(mockFetch, { debug: true }); // Consistent with output
+  });
+
+  it("initializes without errors", () => {
+    expect(client).toBeDefined();
+  });
+
+  it("has getRelationships method", () => {
+    expect(typeof client.getRelationships).toBe("function");
+  });
+
+  it("sends correct GET request and handles successful response", async () => {
+    const mockResponse: GetRelationships200Response = {
+      metadata: {
+        numRelationships: 1,
+        skip: 0,
+        totalRelationships: 1,
+      },
+      relationships: [
+        {
+          id: 6,
+          parentTableId: QB_TABLE_ID_1, // Parent table
+          childTableId: QB_TABLE_ID_2, // Child table
+          foreignKeyField: {
+            id: 6,
+            label: "Related record",
+            type: "numeric",
+          },
+          isCrossApp: false,
+          lookupFields: [
+            {
+              id: 3,
+              label: "Name",
+              type: "text",
+            },
+          ],
+          summaryFields: [
+            {
+              id: 8,
+              label: "my summary field",
+              type: "numeric",
+            },
+          ],
+        },
+      ],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getRelationships({
+      tableId: QB_TABLE_ID_2,
+      skip: 0,
+    });
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+
+    expect(result).toEqual(mockResponse);
+    expect(result.metadata.numRelationships).toBe(1);
+    expect(result.relationships).toHaveLength(1);
+    expect(result.relationships[0].id).toBe(6);
+    expect(result.relationships[0].foreignKeyField.label).toBe(
+      "Related record"
+    );
+  });
+
+  it("handles request without skip parameter", async () => {
+    const mockResponse: GetRelationships200Response = {
+      metadata: {
+        numRelationships: 1,
+        skip: 0,
+        totalRelationships: 1,
+      },
+      relationships: [
+        {
+          id: 6,
+          parentTableId: QB_TABLE_ID_1,
+          childTableId: QB_TABLE_ID_2,
+          foreignKeyField: {
+            id: 6,
+            label: "Related record",
+            type: "numeric",
+          },
+          isCrossApp: false,
+          lookupFields: [],
+          summaryFields: [],
+        },
+      ],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getRelationships({
+      tableId: QB_TABLE_ID_2, // Corrected from QB_TABLE_ID_1
+    });
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+
+    expect(result).toEqual(mockResponse);
+  });
+
+  it("handles API error response", async () => {
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 404,
+      json: () => Promise.resolve({ message: "Table not found" }),
+    });
+
+    await expect(
+      client.getRelationships({
+        tableId: QB_TABLE_ID_2, // Corrected from QB_TABLE_ID_1
+        skip: 0,
+      })
+    ).rejects.toThrow("API Error: Table not found (Status: 404)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+
+  it("retries with temp token after 401", async () => {
+    const mockResponse: GetRelationships200Response = {
+      metadata: {
+        numRelationships: 1,
+        skip: 0,
+        totalRelationships: 1,
+      },
+      relationships: [
+        {
+          id: 6,
+          parentTableId: QB_TABLE_ID_1,
+          childTableId: QB_TABLE_ID_2,
+          foreignKeyField: {
+            id: 6,
+            label: "Related record",
+            type: "numeric",
+          },
+          isCrossApp: false,
+        },
+      ],
+    };
+
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () =>
+          Promise.resolve({ temporaryAuthorization: "initial_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: false,
+        status: 401,
+        json: () => Promise.resolve({ message: "Unauthorized" }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({ temporaryAuthorization: "new_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+
+    const tempClient = createClient(mockFetch, {
+      useTempTokens: true,
+      debug: true,
+    });
+    const result = await tempClient.getRelationships({
+      tableId: QB_TABLE_ID_2,
+      skip: 0,
+    });
+
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_2}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      2,
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN initial_token",
+        }),
+      })
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      3,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_2}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      4,
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN new_token",
+        }),
+      })
+    );
+
+    expect(result).toEqual(mockResponse);
+  });
+});