quickbase-js 0.1.0-beta.7 → 0.1.0-beta.8

package/tests/vitest/unit/apps/getAppEvents.test.ts

@@ -0,0 +1,193 @@
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_APP_ID,
+  QB_REALM,
+  QB_USER_TOKEN,
+} from "@tests/setup.ts";
+import { GetAppEvents200Response } from "@/generated/models";
+
+describe("QuickbaseClient Unit - getAppEvents", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("initializes and has getAppEvents method", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(client).toBeDefined();
+    expect(typeof client.getAppEvents).toBe("function");
+  });
+
+  it("fetches app events successfully with user token", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      userToken: QB_USER_TOKEN,
+      debug: true,
+    });
+
+    const mockResponse: GetAppEvents200Response = [
+      {
+        type: "qb-action",
+        owner: {
+          email: "jsmith@quickbase.com",
+          id: "123456.ab1s",
+          name: "Juliet Smith",
+          userName: "jsmith",
+        },
+        isActive: true,
+        tableId: "bqwriv8bw",
+        name: "Quick Base Action",
+      },
+      {
+        type: "webhook",
+        owner: {
+          email: "tanderson@quickbase.com",
+          id: "654321.ab1s",
+          name: "Thomas A. Anderson",
+          userName: "tanderson",
+        },
+        isActive: false,
+        tableId: "bqwriv8bw",
+        name: "Webhook",
+      },
+      {
+        type: "email-notification",
+        owner: {
+          email: "jsmith@quickbase.com",
+          id: "123456.ab1s",
+          name: "Juliet Smith",
+          userName: "jsmith",
+        },
+        isActive: false,
+        tableId: "bqwriv8bw",
+        name: "Notification",
+      },
+      {
+        type: "subscription",
+        owner: {
+          email: "tanderson@quickbase.com",
+          id: "654321.ab1s",
+          name: "Thomas A. Anderson",
+          userName: "tanderson",
+        },
+        isActive: true,
+        tableId: "bqwriv8bw",
+        name: "Subscription",
+      },
+      {
+        type: "reminder",
+        owner: {
+          email: "jsmith@quickbase.com",
+          id: "123456.ab1s",
+          name: "Juliet Smith",
+          userName: "jsmith",
+        },
+        isActive: true,
+        tableId: "bqwriv8bw",
+        name: "Reminder",
+      },
+      {
+        type: "automation",
+        owner: {
+          email: "tanderson@quickbase.com",
+          id: "654321.ab1s",
+          name: "Thomas A. Anderson",
+          userName: "tanderson",
+        },
+        isActive: true,
+        tableId: "bqwriv8bw",
+        url: "https://realm.quickbase.com/ui/automation/qb/db/bqwria893/automations/70eecab9-634f-42d9-9037-9340a1a9e8ce",
+      },
+    ];
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getAppEvents({ appId: QB_APP_ID });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}/events`,
+      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("fetches app events successfully with temp token", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      useTempTokens: true,
+      debug: true,
+    });
+
+    const mockResponse: GetAppEvents200Response = [
+      {
+        type: "webhook",
+        owner: {
+          email: "tanderson@quickbase.com",
+          id: "654321.ab1s",
+          name: "Thomas A. Anderson",
+          userName: "tanderson",
+        },
+        isActive: false,
+        tableId: "bqwriv8bw",
+        name: "Webhook",
+      },
+    ];
+
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+
+    const result = await client.getAppEvents({ appId: QB_APP_ID });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_APP_ID}`,
+      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/apps/${QB_APP_ID}/events`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: "QB-TEMP-TOKEN temp_token",
+          "Content-Type": "application/json",
+        }),
+        credentials: "omit",
+      })
+    );
+  });
+});

package/tests/vitest/unit/apps/updateApp.test.ts

@@ -0,0 +1,381 @@
+import { describe, it, expect, beforeEach, vi } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_APP_ID,
+  QB_REALM,
+  QB_USER_TOKEN,
+} from "@tests/setup.ts";
+import { UpdateAppRequest, UpdateApp200Response } from "@/generated/models";
+
+describe("QuickbaseClient Unit - updateApp", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("initializes without errors and has updateApp method", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(client).toBeDefined();
+    expect(typeof client.updateApp).toBe("function");
+  });
+
+  it("updates app successfully with user token and dates as Date objects", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: UpdateAppRequest = {
+      name: "Updated Testing App",
+      description: "Updated description",
+      variables: [
+        { name: "Project End Date", value: "7-16-2025" },
+        { name: "Project Manager Email", value: "p.diaz@company.com" },
+      ],
+      securityProperties: {
+        allowClone: true,
+        allowExport: true,
+        enableAppTokens: true,
+        hideFromPublic: true,
+        mustBeRealmApproved: false,
+        useIPFilter: false,
+      },
+    };
+
+    const mockResponse: UpdateApp200Response = {
+      id: QB_APP_ID,
+      name: "Updated Testing App",
+      description: "Updated description",
+      created: new Date("2020-03-27T18:34:12Z"),
+      updated: new Date("2025-03-17T12:00:00Z"),
+      dateFormat: "MM-DD-YYYY",
+      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
+      hasEveryoneOnTheInternet: true,
+      ancestorId: "bqhskthaq",
+      variables: request.variables,
+      securityProperties: request.securityProperties,
+      memoryInfo: { estMemory: 1, estMemoryInclDependentApps: 2 },
+      dataClassification: "Confidential",
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.updateApp({ appId: QB_APP_ID, body: request });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}`,
+      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(request),
+        credentials: "omit",
+      })
+    );
+  });
+
+  it("updates app successfully with temp token and dates as strings", async () => {
+    client = createClient(mockFetch, {
+      useTempTokens: true,
+      debug: true,
+      convertDates: false,
+    });
+
+    const request: UpdateAppRequest = {
+      name: "Updated Temp App",
+      description: "Temp token update",
+      variables: [{ name: "Var1", value: "Value1" }],
+    };
+
+    const mockResponse = {
+      id: QB_APP_ID,
+      name: "Updated Temp App",
+      description: "Temp token update",
+      created: "2020-03-27T18:34:12Z",
+      updated: "2025-03-17T12:00:00Z",
+      dateFormat: "MM-DD-YYYY",
+      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
+      hasEveryoneOnTheInternet: false,
+      ancestorId: "bqhskthaq",
+      variables: request.variables,
+      securityProperties: {
+        allowClone: false,
+        allowExport: false,
+        enableAppTokens: false,
+        hideFromPublic: false,
+        mustBeRealmApproved: true,
+        useIPFilter: true,
+      },
+      memoryInfo: { estMemory: 1, estMemoryInclDependentApps: 2 },
+      dataClassification: "None",
+    };
+
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+
+    const result = await client.updateApp({ appId: QB_APP_ID, body: request });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_APP_ID}`,
+      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/apps/${QB_APP_ID}`,
+      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(request),
+        credentials: "omit",
+      })
+    );
+  });
+
+  it("retries successfully after 401 with temp token", async () => {
+    client = createClient(mockFetch, { useTempTokens: true, debug: true });
+
+    const request: UpdateAppRequest = {
+      name: "Retry Update App",
+      description: "Retry after 401",
+    };
+
+    const mockResponse: UpdateApp200Response = {
+      id: QB_APP_ID,
+      name: "Retry Update App",
+      description: "Retry after 401",
+      created: new Date("2020-03-27T18:34:12Z"),
+      updated: new Date("2025-03-17T12:00:00Z"),
+      dateFormat: "MM-DD-YYYY",
+      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
+      hasEveryoneOnTheInternet: false,
+      ancestorId: "bqhskthaq",
+      variables: [],
+      securityProperties: {
+        allowClone: false,
+        allowExport: false,
+        enableAppTokens: false,
+        hideFromPublic: false,
+        mustBeRealmApproved: true,
+        useIPFilter: true,
+      },
+      memoryInfo: { estMemory: 1, estMemoryInclDependentApps: 2 },
+      dataClassification: "Confidential",
+    };
+
+    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 consoleSpy = vi.spyOn(console, "log");
+    const result = await client.updateApp({ appId: QB_APP_ID, body: request });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_APP_ID}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      2,
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}`,
+      expect.objectContaining({
+        method: "POST",
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN initial_token",
+        }),
+        body: JSON.stringify(request),
+      })
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      3,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_APP_ID}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      4,
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}`,
+      expect.objectContaining({
+        method: "POST",
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN new_token",
+        }),
+        body: JSON.stringify(request),
+      })
+    );
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "Authorization error for updateApp (temp token), refreshing token:",
+      expect.any(String)
+    );
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "Retrying updateApp with temp token"
+    );
+    consoleSpy.mockRestore();
+  });
+
+  it("handles 400 error for invalid request", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: UpdateAppRequest = {
+      name: "", // Invalid: empty name
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 400,
+      json: () => Promise.resolve({ message: "Name is required" }),
+    });
+
+    await expect(
+      client.updateApp({ appId: QB_APP_ID, body: request })
+    ).rejects.toThrow("API Error: Name is required (Status: 400)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}`,
+      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(request),
+        credentials: "omit",
+      })
+    );
+  });
+
+  it("handles edge case with more than 10 variables", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const tooManyVariables = Array(11)
+      .fill(null)
+      .map((_, i) => ({ name: `Var${i}`, value: `Value${i}` }));
+    const request: UpdateAppRequest = {
+      name: "Test App",
+      variables: tooManyVariables,
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 400,
+      json: () =>
+        Promise.resolve({ message: "Maximum of 10 variables allowed" }),
+    });
+
+    await expect(
+      client.updateApp({ appId: QB_APP_ID, body: request })
+    ).rejects.toThrow(
+      "API Error: Maximum of 10 variables allowed (Status: 400)"
+    );
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}`,
+      expect.objectContaining({
+        method: "POST",
+        body: JSON.stringify(request),
+      })
+    );
+  });
+
+  it("handles empty variables and security properties", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: UpdateAppRequest = {
+      name: "Empty Test App",
+      variables: [],
+      securityProperties: {},
+    };
+
+    const mockResponse: UpdateApp200Response = {
+      id: QB_APP_ID,
+      name: "Empty Test App",
+      description: "",
+      created: new Date("2020-03-27T18:34:12Z"),
+      updated: new Date("2025-03-17T12:00:00Z"),
+      dateFormat: "MM-DD-YYYY",
+      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
+      hasEveryoneOnTheInternet: true,
+      ancestorId: "bqhskthaq",
+      variables: [],
+      securityProperties: {
+        allowClone: false,
+        allowExport: false,
+        enableAppTokens: false,
+        hideFromPublic: false,
+        mustBeRealmApproved: true,
+        useIPFilter: true,
+      },
+      memoryInfo: { estMemory: 1, estMemoryInclDependentApps: 2 },
+      dataClassification: "Confidential",
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.updateApp({ appId: QB_APP_ID, body: request });
+
+    expect(result).toEqual(mockResponse);
+    expect(result.variables).toEqual([]);
+    expect(result.securityProperties).toBeDefined();
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps/${QB_APP_ID}`,
+      expect.objectContaining({
+        method: "POST",
+        body: JSON.stringify(request),
+      })
+    );
+  });
+});

package/tests/vitest/unit/auth/fetchTempToken401.test.ts

@@ -1,4 +1,3 @@
-// tests/vitest/unit/auth/fetchTempToken401.test.ts
 import { describe, it, expect, beforeEach, vi } from "vitest";
 import {
   createClient,
@@ -16,6 +15,7 @@ describe("QuickbaseClient Unit - 401 with fetchTempToken 401", () => {
   });
 
   it("fails without infinite loop when fetchTempToken returns 401 after initial 401", async () => {
+    const mockToken = "initial_token";
     let callCount = 0;
 
     mockFetch.mockImplementation((url) => {
@@ -24,8 +24,7 @@ describe("QuickbaseClient Unit - 401 with fetchTempToken 401", () => {
         return Promise.resolve({
           ok: true,
           status: 200,
-          json: () =>
-            Promise.resolve({ temporaryAuthorization: "initial_token" }),
+          json: () => Promise.resolve({ temporaryAuthorization: mockToken }),
         });
       }
       if (url.includes("fields") && callCount === 2) {
@@ -39,8 +38,7 @@ describe("QuickbaseClient Unit - 401 with fetchTempToken 401", () => {
         return Promise.resolve({
           ok: false,
           status: 401,
-          json: () =>
-            Promise.resolve({ message: "Unauthorized in fetchTempToken" }),
+          json: () => Promise.resolve({ message: "Temp token fetch failed" }),
         });
       }
       return Promise.reject(new Error(`Unexpected fetch call: ${url}`));
@@ -49,34 +47,16 @@ describe("QuickbaseClient Unit - 401 with fetchTempToken 401", () => {
     const consoleSpy = vi.spyOn(console, "log");
 
     await expect(client.getFields({ tableId: QB_TABLE_ID_1 })).rejects.toThrow(
-      "API Error: Unauthorized in fetchTempToken (Status: 401)"
+      "API Error: Temp token fetch failed (Status: 401)"
     );
 
     expect(mockFetch).toHaveBeenCalledTimes(3);
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      1,
-      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
-      expect.any(Object)
-    );
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      2,
-      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
-      expect.objectContaining({
-        headers: expect.objectContaining({
-          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
-        }),
-      })
-    );
-    expect(mockFetch).toHaveBeenNthCalledWith(
-      3,
-      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
-      expect.any(Object)
-    );
 
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Authorization error for getFields, refreshing token:",
+      "Authorization error for getFields (temp token), refreshing token:",
       expect.any(String)
     );
+
     consoleSpy.mockRestore();
   });
 });

package/tests/vitest/unit/auth/{retryOn401.test.ts → retryTempToken401.test.ts}

@@ -1,4 +1,3 @@
-// tests/vitest/unit/auth/retryOn401.test.ts
 import { describe, it, expect, beforeEach, vi } from "vitest";
 import {
   createClient,
@@ -7,7 +6,7 @@ import {
   QB_TABLE_ID_1,
 } from "@tests/setup.ts";
 
-describe("QuickbaseClient Unit - 401 Retry Creates New Token", () => {
+describe("QuickbaseClient Unit - Temp Token Retry on 401", () => {
   let client: ReturnType<typeof createClient>;
 
   beforeEach(() => {
@@ -20,7 +19,6 @@ describe("QuickbaseClient Unit - 401 Retry Creates New Token", () => {
     const mockFields = [{ id: 1, label: "Field1" }];
     let callCount = 0;
 
-    // Mock fetch without console.log interference
     mockFetch.mockImplementation((url) => {
       callCount++;
       if (url.includes("auth/temporary") && callCount === 1) {
@@ -90,7 +88,6 @@ describe("QuickbaseClient Unit - 401 Retry Creates New Token", () => {
       })
     );
 
-    // Filter console logs to only those we care about
     const tokenLogs = consoleSpy.mock.calls.filter((call) =>
       call[0].includes("Fetched and cached new token")
     );
@@ -104,11 +101,11 @@ describe("QuickbaseClient Unit - 401 Retry Creates New Token", () => {
     ]);
 
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Authorization error for getFields, refreshing token:",
+      "Authorization error for getFields (temp token), refreshing token:",
       expect.any(String)
     );
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Retrying getFields with new token"
+      "Retrying getFields with temp token"
     );
 
     consoleSpy.mockRestore();