quickbase-js 0.1.0-beta.9 → 1.0.0

package/tests/vitest/unit/rateLimit.test.ts

@@ -1,191 +0,0 @@
-// tests/vitest/unit/rateLimit.test.ts
-import { describe, it, expect, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_APP_ID,
-  QB_REALM,
-  QB_USER_TOKEN,
-} from "@tests/setup.ts";
-import { RateLimitError } from "@/RateLimitError";
-import { GetApp200Response } from "@/generated/models";
-
-describe("QuickbaseClient Unit - Rate Limit Handling", () => {
-  let client: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-  });
-
-  it("succeeds after retrying on 429 Too Many Requests", async () => {
-    client = createClient(mockFetch, {
-      realm: QB_REALM,
-      userToken: QB_USER_TOKEN,
-      debug: true,
-      maxRetries: 2,
-      retryDelay: 100,
-      throttle: { rate: 10, burst: 10 },
-    });
-
-    const appId = QB_APP_ID;
-
-    const mockResponse: GetApp200Response = {
-      id: appId,
-      name: "TestApp",
-      created: "2025-01-01T00:00:00Z",
-      updated: "2025-01-02T00:00:00Z",
-      description: "Test app",
-      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,
-      },
-    };
-
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: false,
-        status: 429,
-        headers: new Headers({ "Retry-After": "1" }),
-        json: () => Promise.resolve({ message: "Too Many Requests" }),
-      })
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve(mockResponse),
-      });
-
-    const result = await client.getApp({ appId });
-
-    expect(result).toEqual({
-      ...mockResponse,
-      created: new Date("2025-01-01T00:00:00Z"),
-      updated: new Date("2025-01-02T00:00:00Z"),
-    });
-    expect(mockFetch).toHaveBeenCalledTimes(2);
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      1,
-      `https://api.quickbase.com/v1/apps/${appId}`,
-      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",
-        }),
-        credentials: "omit",
-      })
-    );
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      2,
-      `https://api.quickbase.com/v1/apps/${appId}`,
-      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",
-        }),
-        credentials: "omit",
-      })
-    );
-  });
-
-  it("throws RateLimitError after max retries on 429", async () => {
-    client = createClient(mockFetch, {
-      realm: QB_REALM,
-      userToken: QB_USER_TOKEN,
-      debug: true,
-      maxRetries: 1,
-      retryDelay: 100,
-      throttle: { rate: 10, burst: 10 },
-    });
-
-    const appId = QB_APP_ID;
-
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: false,
-        status: 429,
-        headers: new Headers({ "Retry-After": "1" }),
-        json: () => Promise.resolve({ message: "Too Many Requests" }),
-      })
-      .mockResolvedValueOnce({
-        ok: false,
-        status: 429,
-        headers: new Headers({ "Retry-After": "1" }),
-        json: () => Promise.resolve({ message: "Too Many Requests" }),
-      });
-
-    await expect(client.getApp({ appId })).rejects.toMatchObject({
-      name: "RateLimitError",
-      message: "API Error: Too Many Requests (Status: 429)",
-      status: 429,
-      retryAfter: 1,
-    });
-
-    expect(mockFetch).toHaveBeenCalledTimes(2);
-  });
-
-  it("respects throttle limits without exceeding rate", async () => {
-    client = createClient(mockFetch, {
-      realm: QB_REALM,
-      userToken: QB_USER_TOKEN,
-      debug: true,
-      throttle: { rate: 5, burst: 5 },
-      maxRetries: 0, // Prevent retries for this test
-    });
-
-    const appId = QB_APP_ID;
-
-    const mockResponse: GetApp200Response = {
-      id: appId,
-      name: "TestApp",
-      created: "2025-01-01T00:00:00Z",
-      updated: "2025-01-02T00:00:00Z",
-      description: "Test app",
-      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,
-      },
-    };
-
-    mockFetch.mockResolvedValue({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve(mockResponse),
-    });
-
-    const startTime = Date.now();
-    await Promise.all([
-      client.getApp({ appId }),
-      client.getApp({ appId }),
-      client.getApp({ appId }),
-      client.getApp({ appId }),
-      client.getApp({ appId }),
-      client.getApp({ appId }), // 6th call should be throttled
-    ]);
-    const endTime = Date.now();
-    const durationMs = endTime - startTime;
-
-    console.log(`[Test Debug] mockFetch calls: ${mockFetch.mock.calls.length}`);
-    expect(mockFetch).toHaveBeenCalledTimes(6);
-    expect(durationMs).toBeGreaterThanOrEqual(200); // 1/5 sec for 6th call
-    expect(durationMs).toBeLessThan(1000);
-  });
-});

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: RunQueryRequest = {
-      from: QB_TABLE_ID_1,
-      select: [3],
-      where: "{999.EX.'Invalid'}",
-    };
-
-    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,234 +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: expect.any(String), // Allow any string, check content below
-        credentials: "omit",
-      })
-    );
-    const callArgs = mockFetch.mock.calls[0];
-    const receivedBody = JSON.parse(callArgs[1].body as string);
-    expect(receivedBody).toEqual({
-      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: expect.any(String),
-        credentials: "omit",
-      })
-    );
-    const callArgs = mockFetch.mock.calls[0];
-    const receivedBody = JSON.parse(callArgs[1].body as string);
-    expect(receivedBody).toEqual({
-      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: expect.any(String),
-        credentials: "omit",
-      })
-    );
-    const callArgs = mockFetch.mock.calls[1];
-    const receivedBody = JSON.parse(callArgs[1].body as string);
-    expect(receivedBody).toEqual({
-      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: expect.any(String),
-        credentials: "omit",
-      })
-    );
-    const callArgs = mockFetch.mock.calls[0];
-    const receivedBody = JSON.parse(callArgs[1].body as string);
-    expect(receivedBody).toEqual({
-      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");
-    }
-  });
-});