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

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

@@ -0,0 +1,307 @@
+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 {
+  UpdateRelationshipRequest,
+  UpdateRelationship200Response,
+} from "@/generated/models";
+
+describe("QuickbaseClient Unit - updateRelationship", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("initializes without errors and has updateRelationship method", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(client).toBeDefined();
+    expect(typeof client.updateRelationship).toBe("function");
+  });
+
+  it("updates relationship successfully with user token", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const tableId = QB_TABLE_ID_1;
+    const relationshipId = 6;
+
+    const request: UpdateRelationshipRequest = {
+      lookupFieldIds: [4, 5, 6],
+      summaryFields: [
+        {
+          summaryFid: 3,
+          label: "my summary field",
+          accumulationType: "COUNT",
+          where: "{'3'.EX.'1'}",
+        },
+      ],
+    };
+
+    const mockResponse: UpdateRelationship200Response = {
+      id: relationshipId,
+      parentTableId: "bck7gp3q2",
+      childTableId: tableId,
+      foreignKeyField: {
+        id: relationshipId,
+        label: "Related record",
+        type: "numeric",
+      },
+      isCrossApp: false,
+      lookupFields: [
+        { id: 4, label: "Field 4", type: "text" },
+        { id: 5, label: "Field 5", type: "numeric" },
+        { id: 6, label: "Field 6", type: "date" },
+      ],
+      summaryFields: [{ id: 8, label: "my summary field", type: "numeric" }],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.updateRelationship({
+      tableId,
+      relationshipId,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${tableId}/relationship/${relationshipId}`,
+      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 relationship successfully with temp token", async () => {
+    client = createClient(mockFetch, { useTempTokens: true, debug: true });
+
+    const tableId = QB_TABLE_ID_1;
+    const relationshipId = 6;
+
+    const request: UpdateRelationshipRequest = {
+      lookupFieldIds: [7],
+      summaryFields: [
+        {
+          summaryFid: 0,
+          label: "Count of Records",
+          accumulationType: "COUNT",
+          where: "{'3'.GT.0}",
+        },
+      ],
+    };
+
+    const mockResponse: UpdateRelationship200Response = {
+      id: relationshipId,
+      parentTableId: "bck7gp3q2",
+      childTableId: tableId,
+      foreignKeyField: {
+        id: relationshipId,
+        label: "Related record",
+        type: "numeric",
+      },
+      isCrossApp: false,
+      lookupFields: [{ id: 7, label: "record - text field", type: "text" }],
+      summaryFields: [{ id: 9, label: "Count of Records", type: "numeric" }],
+    };
+
+    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.updateRelationship({
+      tableId,
+      relationshipId,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${tableId}`,
+      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/tables/${tableId}/relationship/${relationshipId}`,
+      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 tableId = QB_TABLE_ID_1;
+    const relationshipId = 6;
+
+    const request: UpdateRelationshipRequest = {
+      lookupFieldIds: [4],
+    };
+
+    const mockResponse: UpdateRelationship200Response = {
+      id: relationshipId,
+      parentTableId: "bck7gp3q2",
+      childTableId: tableId,
+      foreignKeyField: {
+        id: relationshipId,
+        label: "Related record",
+        type: "numeric",
+      },
+      isCrossApp: false,
+      lookupFields: [{ id: 4, label: "Field 4", type: "text" }],
+      summaryFields: [],
+    };
+
+    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.updateRelationship({
+      tableId,
+      relationshipId,
+      body: request,
+    });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${tableId}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      2,
+      `https://api.quickbase.com/v1/tables/${tableId}/relationship/${relationshipId}`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN initial_token",
+        }),
+      })
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      3,
+      `https://api.quickbase.com/v1/auth/temporary/${tableId}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      4,
+      `https://api.quickbase.com/v1/tables/${tableId}/relationship/${relationshipId}`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN new_token",
+        }),
+      })
+    );
+
+    // Updated log expectations
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "Authorization error for updateRelationship (temp token), refreshing token:"
+    );
+    expect(consoleSpy).toHaveBeenCalledWith(
+      expect.stringContaining(
+        "[updateRelationship] Retrying with token: new_tok"
+      )
+    );
+
+    consoleSpy.mockRestore();
+  });
+
+  it("handles 400 error for invalid request", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const tableId = QB_TABLE_ID_1;
+    const relationshipId = 6;
+
+    const request: UpdateRelationshipRequest = {
+      lookupFieldIds: [-1],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 400,
+      json: () => Promise.resolve({ message: "Invalid field ID" }),
+    });
+
+    await expect(
+      client.updateRelationship({
+        tableId,
+        relationshipId,
+        body: request,
+      })
+    ).rejects.toThrow("API Error: Invalid field ID (Status: 400)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${tableId}/relationship/${relationshipId}`,
+      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",
+      })
+    );
+  });
+});

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

@@ -0,0 +1,204 @@
+import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
+import { createClient, mockFetch, QB_APP_ID, QB_REALM } from "@tests/setup.ts";
+import { UpdateAppRequest, UpdateApp200Response } from "@/generated/models";
+
+describe("QuickbaseClient Unit - Token Lifespan", () => {
+  let client: ReturnType<typeof createClient>;
+  const request: UpdateAppRequest = { name: "Test App" };
+  const mockResponse: UpdateApp200Response = {
+    id: QB_APP_ID,
+    name: "Test App",
+    description: "",
+    created: new Date("2020-01-01T00:00:00Z"), // Match deserialized Date object
+    updated: new Date("2020-01-01T00:00:00Z"),
+    dateFormat: "MM-DD-YYYY",
+    timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
+    hasEveryoneOnTheInternet: false,
+    ancestorId: undefined,
+    variables: [],
+    securityProperties: {},
+    memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
+    dataClassification: "None",
+  };
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    vi.useFakeTimers();
+    console.log("[beforeEach] mockFetch cleared and fake timers enabled");
+  });
+
+  afterEach(() => {
+    vi.useRealTimers();
+  });
+
+  const setupMocks = (token: string) => {
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({ temporaryAuthorization: token }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+  };
+
+  it("reuses token within custom lifespan and refetches after expiration", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      useTempTokens: true,
+      tempTokenLifespan: 500,
+      debug: true,
+    });
+
+    setupMocks("token1");
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch.mock.calls[1][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN token1"
+    );
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(3);
+    expect(mockFetch.mock.calls[2][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN token1"
+    );
+
+    vi.advanceTimersByTime(500);
+    console.log("[Test 1] Token expired after 500ms");
+
+    setupMocks("token2");
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(5);
+    expect(mockFetch.mock.calls[4][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN token2"
+    );
+  });
+
+  it("reuses token within default lifespan of 4m50s", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      useTempTokens: true,
+      debug: true,
+    });
+
+    setupMocks("default_token");
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch.mock.calls[1][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN default_token"
+    );
+
+    vi.advanceTimersByTime(1000);
+    console.log(
+      "[Test 2] Advanced time by 1000ms, still within default lifespan"
+    );
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(3);
+    expect(mockFetch.mock.calls[2][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN default_token"
+    );
+  });
+
+  it("handles token fetch failure gracefully", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      useTempTokens: true,
+      tempTokenLifespan: 500,
+    });
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 500,
+      json: () => Promise.resolve({ message: "Network error" }),
+    });
+    await expect(
+      client.updateApp({ appId: QB_APP_ID, body: request })
+    ).rejects.toThrow("API Error: Network error (Status: 500)");
+    expect(mockFetch).toHaveBeenCalledTimes(1);
+  });
+
+  it("fetches new token every call with zero lifespan", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      useTempTokens: true,
+      tempTokenLifespan: 0,
+    });
+
+    setupMocks("token1");
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+
+    setupMocks("token2");
+    await client.updateApp({ appId: QB_APP_ID, body: request });
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    expect(mockFetch.mock.calls[3][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN token2"
+    );
+  });
+
+  it("reuses token across concurrent calls within lifespan", async () => {
+    client = createClient(mockFetch, {
+      realm: QB_REALM,
+      useTempTokens: true,
+      tempTokenLifespan: 500,
+      debug: true,
+    });
+
+    // Pre-fetch token to ensure it’s cached
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve({ temporaryAuthorization: "token1" }),
+    });
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+    await client.updateApp({ appId: QB_APP_ID, body: request }); // Cache token1
+    vi.advanceTimersByTime(1);
+
+    // Reset mocks and set up API responses
+    mockFetch.mockClear();
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+
+    const [call1, call2] = await Promise.all([
+      client.updateApp({ appId: QB_APP_ID, body: request }),
+      client.updateApp({ appId: QB_APP_ID, body: request }),
+    ]);
+
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch.mock.calls[0][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN token1"
+    );
+    expect(mockFetch.mock.calls[1][1].headers.Authorization).toBe(
+      "QB-TEMP-TOKEN token1"
+    );
+    expect(call1).toEqual(mockResponse);
+    expect(call2).toEqual(mockResponse);
+  });
+});

package/tools/log-gen.ts

@@ -18,32 +18,45 @@ const excludeDirs: string[] = [
 // prettier-ignore
 const includeFolders: string[] = [
   // "open-api",
-  // "open-api/definitions",
-  // "open-api/paths",
 ];
 
 // prettier-ignore
 const includeRecursiveFolders: string[] = [
-  "open-api"
+  // "open-api"
   // "tests",
   // "tests/vitest/unit",
-  // "tests/vitest/qb"
+  "tests/vitest/qb"
 ];
 
 // prettier-ignore
 const includeFiles: string[] = [
+  // "tests/setup.ts",
+  // "vitest.config.ts",
+
   // "package.json",
   // "tsconfig.json",
   // "tsconfig.build.json",
   // "rollup.config.js",
-  // "vitest.config.ts",
   // "build-common.js",
   // "build-umd.js",
   // "build-esm.js",
-  // "src/tokenCache.ts",
-  // "src/generated/runtime.ts",
+
   // "src/quickbaseClient.ts",
+  // "src/invokeMethod.ts",
   // "src/generated-unified/QuickbaseClient.ts",
+  // "src/authorizationStrategy.ts",
+  // "src/rateLimiter.ts",
+  // "src/RateLimitError.ts",
+  // "src/ThrottleBucket.ts",
+  // "src/tokenCache.ts",
+  // "src/utils.ts",
+
+  // "src/generated/runtime.ts",
+  // "src/generated/apis/AuthApi.ts",
+  // "src/generated/apis/FieldsApi.ts",
+  // "src/generated/apis/AppsApi.ts",
+
+  "test/vitest/unit/fields/createField.test.ts",
 ];
 
 const projectGoals: string[] = [