quickbase-js 1.1.0-beta.5 → 1.1.0

package/tests/vitest/unit/records/deleteRecords.test.ts

@@ -1,112 +0,0 @@
-// tests/vitest/unit/records/deleteRecords.test.ts
-import { describe, expect, test, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_REALM,
-  QB_USER_TOKEN,
-  QB_TABLE_ID_1,
-} from "@tests/setup.ts";
-
-describe("QuickbaseClient Unit - deleteRecords", () => {
-  let qb: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-    qb = createClient(mockFetch, { debug: true }); // Use debug: true for consistency with other tests
-  });
-
-  test("sends correct DELETE request and handles success", async () => {
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve({ numberDeleted: 1 }),
-    });
-
-    const result = await qb.deleteRecords({
-      body: {
-        from: QB_TABLE_ID_1,
-        where: "{3.EX.'5'}", // Simulate deleting Record ID 5
-      },
-    });
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "DELETE",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({ from: QB_TABLE_ID_1, where: "{3.EX.'5'}" }),
-      })
-    );
-    expect(result).toEqual({ numberDeleted: 1 });
-  });
-
-  test("handles no records deleted", async () => {
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve({ numberDeleted: 0 }),
-    });
-
-    const result = await qb.deleteRecords({
-      body: {
-        from: QB_TABLE_ID_1,
-        where: "{3.EX.'999999'}", // Non-existent Record ID
-      },
-    });
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "DELETE",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({
-          from: QB_TABLE_ID_1,
-          where: "{3.EX.'999999'}",
-        }),
-      })
-    );
-    expect(result).toEqual({ numberDeleted: 0 });
-  });
-
-  test("throws error on API failure", async () => {
-    mockFetch.mockResolvedValueOnce({
-      ok: false,
-      status: 400,
-      json: () => Promise.resolve({ message: "Invalid query" }),
-    });
-
-    await expect(() =>
-      qb.deleteRecords({
-        body: {
-          from: QB_TABLE_ID_1,
-          where: "{3.EX.'invalid'}",
-        },
-      })
-    ).rejects.toThrow("API Error: Invalid query (Status: 400)");
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "DELETE",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({
-          from: QB_TABLE_ID_1,
-          where: "{3.EX.'invalid'}",
-        }),
-      })
-    );
-  });
-});

package/tests/vitest/unit/records/runQuery.test.ts

@@ -1,102 +0,0 @@
-// tests/vitest/unit/records/runQuery.test.ts
-import { describe, test, expect, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_REALM,
-  QB_USER_TOKEN,
-  QB_TABLE_ID_1,
-} from "@tests/setup.ts";
-import { RunQueryRequest, RunQueryResponse } from "@/generated";
-
-describe("QuickbaseClient Unit - runQuery", () => {
-  let client: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-    client = createClient(mockFetch, { debug: true });
-  });
-
-  test("sends correct POST request and handles successful query response", async () => {
-    const queryRequest: RunQueryRequest = {
-      from: QB_TABLE_ID_1,
-      select: [3, 6, 7],
-      where: "{6.EX.'Task 1'}",
-      sortBy: [{ fieldId: 6, order: "ASC" }],
-      groupBy: [{ fieldId: 7, grouping: "equal-values" }],
-      options: { skip: 0, top: 100, compareWithAppLocalTime: false },
-    };
-
-    const mockResponse: RunQueryResponse = {
-      data: [
-        { "3": { value: 1 }, "6": { value: "Task 1" }, "7": { value: "High" } },
-      ],
-      fields: [
-        { id: 3, label: "Record ID#", type: "recordid" },
-        { id: 6, label: "Task Name", type: "text" },
-        { id: 7, label: "Priority", type: "text" },
-      ],
-      metadata: {
-        numFields: 3,
-        numRecords: 1,
-        skip: 0,
-        top: 100,
-        totalRecords: 1,
-      },
-    };
-
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve(mockResponse),
-    });
-
-    const result = await client.runQuery({ body: queryRequest });
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records/query",
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify(queryRequest),
-      })
-    );
-
-    expect(result).toEqual(mockResponse);
-  });
-
-  test("handles API error with invalid query", async () => {
-    const invalidQueryRequest = {
-      from: QB_TABLE_ID_1,
-      select: [3],
-      where: "{999.EX.'Invalid'}", // Invalid field ID
-    };
-
-    mockFetch.mockResolvedValueOnce({
-      ok: false,
-      status: 400,
-      json: () => Promise.resolve({ message: "Invalid query" }),
-    });
-
-    await expect(
-      client.runQuery({ body: invalidQueryRequest })
-    ).rejects.toThrow("API Error: Invalid query (Status: 400)");
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records/query",
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify(invalidQueryRequest),
-      })
-    );
-  });
-});

package/tests/vitest/unit/records/upsert.test.ts

@@ -1,218 +0,0 @@
-// tests/vitest/unit/records/upsert.test.ts
-import { describe, expect, test, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_REALM,
-  QB_USER_TOKEN,
-  QB_TABLE_ID_1,
-} from "@tests/setup.ts";
-import { vi } from "vitest";
-
-// Note: Type augmentation moved to src/types.d.ts
-describe("QuickbaseClient Unit - upsert", () => {
-  beforeEach(() => {
-    vi.resetModules(); // Reset module cache
-    mockFetch.mockClear();
-  });
-
-  test("sends correct POST request and handles successful upsert", async () => {
-    const qb = createClient(mockFetch, { debug: true });
-
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () =>
-        Promise.resolve({
-          data: [{ id: 1, "6": { value: "value1" } }],
-          metadata: {
-            createdRecordIds: [1],
-            updatedRecordIds: [],
-            unchangedRecordIds: [],
-            totalNumberOfRecordsProcessed: 1,
-          },
-        }),
-    });
-
-    console.log("[Test] Calling qb.upsert with:", {
-      body: { to: QB_TABLE_ID_1, data: [{ "6": { value: "value1" } }] },
-    });
-    const result = await qb.upsert({
-      body: { to: QB_TABLE_ID_1, data: [{ "6": { value: "value1" } }] },
-    });
-
-    console.log("[Test] mockFetch calls:", mockFetch.mock.calls);
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({
-          to: QB_TABLE_ID_1,
-          data: [{ "6": { value: "value1" } }],
-        }),
-      })
-    );
-
-    expect(result).toEqual({
-      data: [{ id: 1, "6": { value: "value1" } }],
-      metadata: {
-        createdRecordIds: [1],
-        updatedRecordIds: [],
-        unchangedRecordIds: [],
-        totalNumberOfRecordsProcessed: 1,
-      },
-    });
-  });
-
-  test("handles API error with invalid data", async () => {
-    const qb = createClient(mockFetch, { debug: true });
-
-    mockFetch.mockResolvedValueOnce({
-      ok: false,
-      status: 400,
-      json: () => Promise.resolve({ message: "Invalid data format" }),
-    });
-
-    await expect(
-      qb.upsert({
-        body: { to: QB_TABLE_ID_1, data: [{ "999": { value: "invalid" } }] },
-      })
-    ).rejects.toThrow("API Error: Invalid data format (Status: 400)");
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({
-          to: QB_TABLE_ID_1,
-          data: [{ "999": { value: "invalid" } }],
-        }),
-      })
-    );
-  });
-
-  test("handles upsert with temp token", async () => {
-    const qb = createClient(mockFetch, { useTempTokens: true, debug: true });
-
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve({ temporaryAuthorization: "temp-token" }),
-      })
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () =>
-          Promise.resolve({
-            data: [{ id: 2, "7": { value: "value2" } }],
-            metadata: {
-              createdRecordIds: [2],
-              updatedRecordIds: [],
-              unchangedRecordIds: [],
-              totalNumberOfRecordsProcessed: 1,
-            },
-          }),
-      });
-
-    const result = await qb.upsert({
-      body: { to: QB_TABLE_ID_1, data: [{ "7": { value: "value2" } }] },
-      dbid: QB_TABLE_ID_1, // Use QB_TABLE_ID_1 as dbid for temp token
-    } as any); // Temporary type assertion until types.d.ts is applied
-
-    expect(mockFetch).toHaveBeenCalledTimes(2);
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      1,
-      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
-      expect.objectContaining({
-        method: "GET",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          "Content-Type": "application/json",
-        }),
-        credentials: "include",
-      })
-    );
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      2,
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: "QB-TEMP-TOKEN temp-token",
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({
-          to: QB_TABLE_ID_1,
-          data: [{ "7": { value: "value2" } }],
-        }),
-      })
-    );
-
-    expect(result).toEqual({
-      data: [{ id: 2, "7": { value: "value2" } }],
-      metadata: {
-        createdRecordIds: [2],
-        updatedRecordIds: [],
-        unchangedRecordIds: [],
-        totalNumberOfRecordsProcessed: 1,
-      },
-    });
-  });
-
-  test("sends correct POST request with data fields", async () => {
-    const qb = createClient(mockFetch, { debug: true });
-
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () =>
-        Promise.resolve({
-          data: [{ id: 1, "6": { value: "value1" } }],
-          metadata: {
-            createdRecordIds: [1],
-            updatedRecordIds: [],
-            unchangedRecordIds: [],
-            totalNumberOfRecordsProcessed: 1,
-          },
-        }),
-    });
-
-    const result = await qb.upsert({
-      body: { to: QB_TABLE_ID_1, data: [{ "6": { value: "value1" } }] },
-    });
-
-    expect(mockFetch).toHaveBeenCalledWith(
-      "https://api.quickbase.com/v1/records",
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-          "Content-Type": "application/json",
-        }),
-        body: JSON.stringify({
-          to: QB_TABLE_ID_1,
-          data: [{ "6": { value: "value1" } }],
-        }),
-      })
-    );
-
-    if (result.data && result.data.length > 0) {
-      expect((result.data[0]["6"] as { value: any }).value).toBe("value1");
-    } else {
-      throw new Error("Expected data array to have at least one element");
-    }
-  });
-});

package/tests/vitest/unit/tables/createTable.test.ts

@@ -1,70 +0,0 @@
-// tests/vitest/unit/records/createTable.test.ts
-import { describe, it, expect, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_APP_ID,
-  QB_REALM,
-  QB_USER_TOKEN,
-} from "@tests/setup.ts";
-
-describe("QuickbaseClient Unit - createTable", () => {
-  let client: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-    client = createClient(mockFetch, { debug: true });
-  });
-
-  it("calls createTable successfully with user token", async () => {
-    const mockBody = {
-      name: "TestTable",
-      description: "Unit test table",
-      singleRecordName: "Test",
-      pluralRecordName: "Tests",
-    };
-    const mockResponse = {
-      id: "newly-created-table-id-1234567890", // Changed from "buya8h9iz"
-      name: "TestTable",
-      alias: "_DBID_TESTTABLE",
-      description: "Unit test table",
-      created: new Date("2025-03-10T21:00:00.000Z"),
-      updated: new Date("2025-03-10T21:00:00.000Z"),
-      nextRecordId: 1,
-      nextFieldId: 6,
-      defaultSortFieldId: 2,
-      defaultSortOrder: "DESC",
-      keyFieldId: 3,
-      singleRecordName: "Test",
-      pluralRecordName: "Tests",
-      sizeLimit: "500 MB",
-      spaceUsed: "0 KB",
-      spaceRemaining: "500 MB",
-    };
-
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve(mockResponse),
-    });
-
-    const response = await client.createTable({
-      appId: QB_APP_ID,
-      body: mockBody,
-    });
-    expect(response).toEqual(mockResponse);
-    expect(mockFetch).toHaveBeenCalledTimes(1);
-    expect(mockFetch).toHaveBeenCalledWith(
-      `https://api.quickbase.com/v1/tables?appId=${QB_APP_ID}`,
-      expect.objectContaining({
-        method: "POST",
-        headers: expect.objectContaining({
-          "Content-Type": "application/json",
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-        }),
-        body: JSON.stringify(mockBody),
-      })
-    );
-  });
-});

package/tests/vitest/unit/tables/deleteTable.test.ts

@@ -1,77 +0,0 @@
-// tests/vitest/unit/records/deleteTable.test.ts
-import { describe, it, expect, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_APP_ID,
-  QB_TABLE_ID_1,
-  QB_REALM,
-  QB_USER_TOKEN,
-} from "@tests/setup.ts";
-
-describe("QuickbaseClient Unit - deleteTable", () => {
-  let client: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-    client = createClient(mockFetch, { debug: true });
-  });
-
-  it("calls deleteTable successfully with user token", async () => {
-    const mockResponse = {
-      deletedTableId: QB_TABLE_ID_1,
-    };
-
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve(mockResponse),
-    });
-
-    const response = await client.deleteTable({
-      tableId: QB_TABLE_ID_1,
-      appId: QB_APP_ID,
-    });
-    expect(response).toEqual(mockResponse);
-    expect(mockFetch).toHaveBeenCalledTimes(1);
-    expect(mockFetch).toHaveBeenCalledWith(
-      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?appId=${QB_APP_ID}`,
-      expect.objectContaining({
-        method: "DELETE",
-        headers: expect.objectContaining({
-          "Content-Type": "application/json",
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-        }),
-      })
-    );
-  });
-
-  it("handles 404 error for non-existent table", async () => {
-    mockFetch.mockResolvedValueOnce({
-      ok: false,
-      status: 404,
-      json: () =>
-        Promise.resolve({
-          message: "Invalid DBID",
-          description: "Table not found in app.",
-        }),
-    });
-
-    await expect(
-      client.deleteTable({ tableId: QB_TABLE_ID_1, appId: QB_APP_ID })
-    ).rejects.toThrow("API Error: Invalid DBID (Status: 404)");
-    expect(mockFetch).toHaveBeenCalledTimes(1);
-    expect(mockFetch).toHaveBeenCalledWith(
-      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?appId=${QB_APP_ID}`,
-      expect.objectContaining({
-        method: "DELETE",
-        headers: expect.objectContaining({
-          "Content-Type": "application/json",
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-          Authorization: `QB-USER-TOKEN ${QB_USER_TOKEN}`,
-        }),
-      })
-    );
-  });
-});

package/tests/vitest/unit/tables/getAppTables.test.ts

@@ -1,85 +0,0 @@
-// tests/vitest/unit/tables/getAppTables.test.ts
-import { describe, it, expect, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_APP_ID,
-  QB_REALM,
-  QB_USER_TOKEN,
-} from "@tests/setup.ts";
-
-describe("QuickbaseClient Unit - getAppTables", () => {
-  let client: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-    client = createClient(mockFetch, { debug: true }); // Add debug: true for consistency
-  });
-
-  it("calls getAppTables successfully", async () => {
-    mockFetch.mockImplementation((url: string, options: any) => {
-      console.log("Mock fetch for getAppTables:", url, options);
-      return Promise.resolve({
-        ok: true,
-        status: 200,
-        json: () =>
-          Promise.resolve([
-            {
-              id: "buwai2zr4",
-              name: "Root",
-              alias: "_DBID_ROOT",
-              description: "",
-              created: new Date("2025-02-13T18:22:33.000Z"),
-              updated: new Date("2025-02-13T18:22:34.000Z"),
-              nextRecordId: 1,
-              nextFieldId: 6,
-              defaultSortFieldId: 2,
-              defaultSortOrder: "DESC",
-              keyFieldId: 3,
-              singleRecordName: "Root",
-              pluralRecordName: "Roots",
-              sizeLimit: "500 MB",
-              spaceUsed: "0 KB",
-              spaceRemaining: "500 MB",
-            },
-          ]),
-      } as Response);
-    });
-
-    const result = await client.getAppTables({ appId: QB_APP_ID });
-    console.log("getAppTables response:", result);
-    expect(result).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          id: "buwai2zr4",
-          name: "Root",
-          alias: "_DBID_ROOT",
-          description: "",
-          created: new Date("2025-02-13T18:22:33.000Z"),
-          updated: new Date("2025-02-13T18:22:34.000Z"),
-          nextRecordId: 1,
-          nextFieldId: 6,
-          defaultSortFieldId: 2,
-          defaultSortOrder: "DESC",
-          keyFieldId: 3,
-          singleRecordName: "Root",
-          pluralRecordName: "Roots",
-          sizeLimit: "500 MB",
-          spaceUsed: "0 KB",
-          spaceRemaining: "500 MB",
-        }),
-      ])
-    );
-    expect(mockFetch).toHaveBeenCalledWith(
-      `https://api.quickbase.com/v1/tables?appId=${QB_APP_ID}`,
-      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",
-        }),
-      })
-    );
-  });
-});