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

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

@@ -0,0 +1,391 @@
+// tests/vitest/unit/fields/createField.test.ts
+import { describe, it, expect, beforeEach, vi } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+} from "@tests/setup.ts";
+import { CreateFieldRequest, CreateField200Response } from "@/generated/models";
+
+describe("QuickbaseClient Unit - createField", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("initializes without errors and has createField method", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(client).toBeDefined();
+    expect(typeof client.createField).toBe("function");
+  });
+
+  it("creates a field successfully with user token", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: CreateFieldRequest = {
+      label: "TestField",
+      fieldType: "text",
+      fieldHelp: "A test field",
+      addToForms: true,
+      permissions: [
+        { role: "Viewer", permissionType: "View", roleId: 10 },
+        { role: "Administrator", permissionType: "Modify", roleId: 12 },
+      ],
+    };
+
+    const mockResponse: CreateField200Response = {
+      id: 100,
+      label: "TestField",
+      fieldType: "text",
+      mode: "",
+      noWrap: false,
+      bold: false,
+      required: false,
+      appearsByDefault: true,
+      findEnabled: true,
+      unique: false,
+      doesDataCopy: false,
+      fieldHelp: "A test field",
+      audited: false,
+      properties: {
+        primaryKey: false,
+        foreignKey: false,
+        numLines: 1,
+        maxLength: 0,
+        appendOnly: false,
+        allowHTML: false,
+        allowMentions: false,
+        sortAsGiven: false,
+        carryChoices: true,
+        allowNewChoices: false,
+        formula: "",
+        defaultValue: "",
+      },
+      permissions: [
+        { permissionType: "View", role: "Viewer", roleId: 10 },
+        { permissionType: "Modify", role: "Administrator", roleId: 12 },
+      ],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.createField({
+      tableId: QB_TABLE_ID_1,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
+      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",
+        }),
+        credentials: "omit",
+        body: expect.any(String), // Allow any string for body
+      })
+    );
+
+    // Additional check to ensure the body matches the request object, ignoring property order
+    const callArgs = mockFetch.mock.calls[0];
+    const receivedBody = JSON.parse(callArgs[1].body as string);
+    expect(receivedBody).toEqual(request);
+  });
+
+  it("creates a field successfully with temp token", async () => {
+    client = createClient(mockFetch, { useTempTokens: true, debug: true });
+
+    const request: CreateFieldRequest = {
+      label: "TempField",
+      fieldType: "numeric",
+      addToForms: false,
+    };
+
+    const mockResponse: CreateField200Response = {
+      id: 101,
+      label: "TempField",
+      fieldType: "numeric",
+      mode: "",
+      noWrap: false,
+      bold: false,
+      required: false,
+      appearsByDefault: true,
+      findEnabled: true,
+      unique: false,
+      doesDataCopy: false,
+      fieldHelp: "",
+      audited: false,
+      properties: {
+        primaryKey: false,
+        foreignKey: false,
+        numLines: 1,
+        maxLength: 0,
+        appendOnly: false,
+        allowHTML: false,
+        allowMentions: false,
+        sortAsGiven: false,
+        carryChoices: true,
+        allowNewChoices: false,
+        formula: "",
+        defaultValue: "",
+      },
+      permissions: [],
+    };
+
+    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.createField({
+      tableId: QB_TABLE_ID_1,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    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/fields?tableId=${QB_TABLE_ID_1}`,
+      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),
+      })
+    );
+  });
+
+  it("retries successfully after 401 with temp token", async () => {
+    client = createClient(mockFetch, { useTempTokens: true, debug: true });
+
+    const request: CreateFieldRequest = {
+      label: "RetryField",
+      fieldType: "checkbox",
+    };
+
+    const mockResponse: CreateField200Response = {
+      id: 102,
+      label: "RetryField",
+      fieldType: "checkbox",
+      mode: "",
+      noWrap: false,
+      bold: false,
+      required: false,
+      appearsByDefault: true,
+      findEnabled: true,
+      unique: false,
+      doesDataCopy: false,
+      fieldHelp: "",
+      audited: false,
+      properties: {
+        primaryKey: false,
+        foreignKey: false,
+        numLines: 1,
+        maxLength: 0,
+        appendOnly: false,
+        allowHTML: false,
+        allowMentions: false,
+        sortAsGiven: false,
+        carryChoices: true,
+        allowNewChoices: false,
+        formula: "",
+        defaultValue: "",
+      },
+      permissions: [],
+    };
+
+    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.createField({
+      tableId: QB_TABLE_ID_1,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    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({
+          Authorization: "QB-TEMP-TOKEN initial_token",
+        }),
+      })
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      3,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      4,
+      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN new_token",
+        }),
+      })
+    );
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "Authorization error for createField, refreshing token:",
+      expect.any(String)
+    );
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "Retrying createField with new token"
+    );
+    consoleSpy.mockRestore();
+  });
+
+  it("handles 400 error for invalid request", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: CreateFieldRequest = {
+      label: "", // Invalid: label is required
+      fieldType: "text",
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 400,
+      json: () => Promise.resolve({ message: "Label is required" }),
+    });
+
+    await expect(
+      client.createField({ tableId: QB_TABLE_ID_1, body: request })
+    ).rejects.toThrow("API Error: Label is required (Status: 400)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
+      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),
+      })
+    );
+  });
+
+  it("handles 401 with failed temp token retry", async () => {
+    client = createClient(mockFetch, { useTempTokens: true, debug: true });
+
+    const request: CreateFieldRequest = {
+      label: "FailField",
+      fieldType: "text",
+    };
+
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () =>
+          Promise.resolve({ temporaryAuthorization: "initial_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: false,
+        status: 401,
+        json: () => Promise.resolve({ message: "Unauthorized" }),
+      })
+      .mockResolvedValueOnce({
+        ok: false,
+        status: 401,
+        json: () =>
+          Promise.resolve({ message: "Unauthorized in fetchTempToken" }),
+      });
+
+    const consoleSpy = vi.spyOn(console, "log");
+    await expect(
+      client.createField({ tableId: QB_TABLE_ID_1, body: request })
+    ).rejects.toThrow(
+      "API Error: Unauthorized in fetchTempToken (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({
+          Authorization: "QB-TEMP-TOKEN initial_token",
+        }),
+      })
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      3,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
+      expect.any(Object)
+    );
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "Authorization error for createField, refreshing token:",
+      expect.any(String)
+    );
+    consoleSpy.mockRestore();
+  });
+});

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

@@ -0,0 +1,141 @@
+// tests/vitest/unit/fields/deleteFields.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 {
+  DeleteFieldsRequest,
+  DeleteFields200Response,
+} from "@/generated/models";
+
+describe("QuickbaseClient Unit - deleteFields", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("initializes without errors and has deleteFields method", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(client).toBeDefined();
+    expect(typeof client.deleteFields).toBe("function");
+  });
+
+  it("deletes fields successfully with user token", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: DeleteFieldsRequest = {
+      fieldIds: [6, 7, 8],
+    };
+
+    const mockResponse: DeleteFields200Response = {
+      deletedFieldIds: [6, 7, 8],
+      errors: [],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.deleteFields({
+      tableId: QB_TABLE_ID_1,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
+      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(request),
+        credentials: "omit",
+      })
+    );
+  });
+
+  it("handles partial success with errors", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: DeleteFieldsRequest = {
+      fieldIds: [6, 7, 8],
+    };
+
+    const mockResponse: DeleteFields200Response = {
+      deletedFieldIds: [6, 8],
+      errors: ["Error found with fid: 7"],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.deleteFields({
+      tableId: QB_TABLE_ID_1,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
+      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(request),
+        credentials: "omit",
+      })
+    );
+  });
+
+  it("handles 400 error for invalid request", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: DeleteFieldsRequest = {
+      fieldIds: [], // Invalid: empty fieldIds array
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 400,
+      json: () =>
+        Promise.resolve({
+          message: "Invalid input",
+          description: "Field IDs list cannot be empty.",
+        }),
+    });
+
+    await expect(
+      client.deleteFields({ tableId: QB_TABLE_ID_1, body: request })
+    ).rejects.toThrow("API Error: Invalid input (Status: 400)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields?tableId=${QB_TABLE_ID_1}`,
+      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(request),
+        credentials: "omit",
+      })
+    );
+  });
+});

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

@@ -0,0 +1,189 @@
+// tests/vitest/unit/fields/getField.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 { Field } from "@/generated/models";
+
+describe("QuickbaseClient Unit - getField", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    client = createClient(mockFetch, { debug: true });
+  });
+
+  it("initializes without errors and has getField method", () => {
+    expect(client).toBeDefined();
+    expect(typeof client.getField).toBe("function");
+  });
+
+  it("calls getField successfully with user token", async () => {
+    const mockResponse: Field = {
+      id: 123,
+      label: "Field1",
+      fieldType: "text",
+      mode: "",
+      noWrap: false,
+      bold: false,
+      required: false,
+      appearsByDefault: false,
+      findEnabled: false,
+      unique: false,
+      doesDataCopy: false,
+      fieldHelp: "field help",
+      audited: false,
+      properties: {
+        primaryKey: false,
+        foreignKey: false,
+        numLines: 1,
+        maxLength: 0,
+        appendOnly: false,
+        allowHTML: false,
+        allowMentions: false,
+        sortAsGiven: false,
+        carryChoices: true,
+        allowNewChoices: false,
+        formula: "",
+        defaultValue: "",
+      },
+      permissions: [
+        { permissionType: "View", role: "Viewer", roleId: 10 },
+        { permissionType: "None", role: "Participant", roleId: 11 },
+        { permissionType: "Modify", role: "Administrator", roleId: 12 },
+      ],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getField({
+      fieldId: 123,
+      tableId: QB_TABLE_ID_1,
+      includeFieldPerms: true,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/fields/123?tableId=${QB_TABLE_ID_1}&includeFieldPerms=true`,
+      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 getField successfully with temp token", async () => {
+    client = createClient(mockFetch, { useTempTokens: true, debug: true });
+
+    const mockResponse: Field = {
+      id: 123,
+      label: "Field1",
+      fieldType: "text",
+      mode: "",
+      noWrap: false,
+      bold: false,
+      required: false,
+      appearsByDefault: false,
+      findEnabled: false,
+      unique: false,
+      doesDataCopy: false,
+      fieldHelp: "field help",
+      audited: false,
+      properties: {
+        primaryKey: false,
+        foreignKey: false,
+        numLines: 1,
+        maxLength: 0,
+        appendOnly: false,
+        allowHTML: false,
+        allowMentions: false,
+        sortAsGiven: false,
+        carryChoices: true,
+        allowNewChoices: false,
+        formula: "",
+        defaultValue: "",
+      },
+      permissions: [],
+    };
+
+    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.getField({
+      fieldId: 123,
+      tableId: QB_TABLE_ID_1,
+    });
+
+    expect(result).toEqual(mockResponse);
+    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/fields/123?tableId=${QB_TABLE_ID_1}`,
+      expect.objectContaining({
+        method: "GET",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: "QB-TEMP-TOKEN temp_token",
+          "Content-Type": "application/json",
+        }),
+      })
+    );
+  });
+
+  it("handles 404 error for non-existent field", async () => {
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 404,
+      json: () => Promise.resolve({ message: "Field not found" }),
+    });
+
+    await expect(
+      client.getField({ 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/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",
+        }),
+      })
+    );
+  });
+});