quickbase-js 0.1.0-beta.7

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

@@ -0,0 +1,259 @@
+// tests/vitest/unit/relationships/getRelationships.test.ts
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_REALM,
+  QB_USER_TOKEN,
+  QB_TABLE_ID_1,
+  QB_TABLE_ID_2,
+} from "@tests/setup.ts";
+import { GetRelationships200Response } from "/home/drew/Projects/quickbase-js/src/generated/models";
+
+describe("QuickbaseClient Unit - getRelationships", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    client = createClient(mockFetch, { debug: true }); // Consistent with output
+  });
+
+  it("initializes without errors", () => {
+    expect(client).toBeDefined();
+  });
+
+  it("has getRelationships method", () => {
+    expect(typeof client.getRelationships).toBe("function");
+  });
+
+  it("sends correct GET request and handles successful response", async () => {
+    const mockResponse: GetRelationships200Response = {
+      metadata: {
+        numRelationships: 1,
+        skip: 0,
+        totalRelationships: 1,
+      },
+      relationships: [
+        {
+          id: 6,
+          parentTableId: QB_TABLE_ID_1, // Parent table
+          childTableId: QB_TABLE_ID_2, // Child table
+          foreignKeyField: {
+            id: 6,
+            label: "Related record",
+            type: "numeric",
+          },
+          isCrossApp: false,
+          lookupFields: [
+            {
+              id: 3,
+              label: "Name",
+              type: "text",
+            },
+          ],
+          summaryFields: [
+            {
+              id: 8,
+              label: "my summary field",
+              type: "numeric",
+            },
+          ],
+        },
+      ],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getRelationships({
+      tableId: QB_TABLE_ID_2,
+      skip: 0,
+    });
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      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",
+        }),
+      })
+    );
+
+    expect(result).toEqual(mockResponse);
+    expect(result.metadata.numRelationships).toBe(1);
+    expect(result.relationships).toHaveLength(1);
+    expect(result.relationships[0].id).toBe(6);
+    expect(result.relationships[0].foreignKeyField.label).toBe(
+      "Related record"
+    );
+  });
+
+  it("handles request without skip parameter", async () => {
+    const mockResponse: GetRelationships200Response = {
+      metadata: {
+        numRelationships: 1,
+        skip: 0,
+        totalRelationships: 1,
+      },
+      relationships: [
+        {
+          id: 6,
+          parentTableId: QB_TABLE_ID_1,
+          childTableId: QB_TABLE_ID_2,
+          foreignKeyField: {
+            id: 6,
+            label: "Related record",
+            type: "numeric",
+          },
+          isCrossApp: false,
+          lookupFields: [],
+          summaryFields: [],
+        },
+      ],
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await client.getRelationships({
+      tableId: QB_TABLE_ID_2, // Corrected from QB_TABLE_ID_1
+    });
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships`,
+      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",
+        }),
+      })
+    );
+
+    expect(result).toEqual(mockResponse);
+  });
+
+  it("handles API error response", async () => {
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 404,
+      json: () => Promise.resolve({ message: "Table not found" }),
+    });
+
+    await expect(
+      client.getRelationships({
+        tableId: QB_TABLE_ID_2, // Corrected from QB_TABLE_ID_1
+        skip: 0,
+      })
+    ).rejects.toThrow("API Error: Table not found (Status: 404)");
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      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("retries with temp token after 401", async () => {
+    const mockResponse: GetRelationships200Response = {
+      metadata: {
+        numRelationships: 1,
+        skip: 0,
+        totalRelationships: 1,
+      },
+      relationships: [
+        {
+          id: 6,
+          parentTableId: QB_TABLE_ID_1,
+          childTableId: QB_TABLE_ID_2,
+          foreignKeyField: {
+            id: 6,
+            label: "Related record",
+            type: "numeric",
+          },
+          isCrossApp: false,
+        },
+      ],
+    };
+
+    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 tempClient = createClient(mockFetch, {
+      useTempTokens: true,
+      debug: true,
+    });
+    const result = await tempClient.getRelationships({
+      tableId: QB_TABLE_ID_2,
+      skip: 0,
+    });
+
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      1,
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_2}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      2,
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      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_2}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenNthCalledWith(
+      4,
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_2}/relationships?skip=0`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN new_token",
+        }),
+      })
+    );
+
+    expect(result).toEqual(mockResponse);
+  });
+});

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

@@ -0,0 +1,233 @@
+// tests/vitest/unit/tables/getTable.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 - getTable", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("calls getTable successfully with user token", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const mockResponse = {
+      id: QB_TABLE_ID_1,
+      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",
+    };
+
+    mockFetch.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const response = await client.getTable({
+      tableId: QB_TABLE_ID_1,
+      appId: QB_APP_ID,
+    });
+    expect(response).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?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}`,
+        }),
+      })
+    );
+  });
+
+  it("calls getTable successfully with temp token", async () => {
+    client = createClient(mockFetch, { debug: true, useTempTokens: true });
+
+    const mockResponse = {
+      id: QB_TABLE_ID_1,
+      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",
+    };
+
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+
+    const response = await client.getTable({
+      tableId: QB_TABLE_ID_1,
+      appId: QB_APP_ID,
+    });
+    expect(response).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?appId=${QB_APP_ID}`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${QB_REALM}.quickbase.com`,
+          Authorization: "QB-TEMP-TOKEN temp_token",
+        }),
+      })
+    );
+  });
+
+  it("retries successfully after 401 with temp token", async () => {
+    client = createClient(mockFetch, { debug: true, useTempTokens: true });
+
+    const mockResponse = {
+      id: QB_TABLE_ID_1,
+      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",
+    };
+
+    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 response = await client.getTable({
+      tableId: QB_TABLE_ID_1,
+      appId: QB_APP_ID,
+    });
+    expect(response).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(4);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?appId=${QB_APP_ID}`,
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          Authorization: "QB-TEMP-TOKEN new_token",
+        }),
+      })
+    );
+  });
+
+  it("handles 401 with failed temp token retry", async () => {
+    client = createClient(mockFetch, { debug: true, useTempTokens: true });
+
+    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" }),
+      });
+
+    await expect(
+      client.getTable({ tableId: QB_TABLE_ID_1, appId: QB_APP_ID })
+    ).rejects.toThrow(
+      "API Error: Unauthorized in fetchTempToken (Status: 401)"
+    );
+    expect(mockFetch).toHaveBeenCalledTimes(3);
+  });
+
+  it("handles 404 Not Found", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    mockFetch.mockResolvedValueOnce({
+      ok: false,
+      status: 404,
+      json: () => Promise.resolve({ message: "Table not found" }),
+    });
+
+    await expect(
+      client.getTable({ tableId: QB_TABLE_ID_1, appId: QB_APP_ID })
+    ).rejects.toThrow("API Error: Table not found (Status: 404)");
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?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}`,
+        }),
+      })
+    );
+  });
+});

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

@@ -0,0 +1,80 @@
+// tests/vitest/unit/records/updateTable.test.ts
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_APP_ID,
+  QB_TABLE_ID_1,
+} from "@tests/setup.ts";
+
+describe("QuickbaseClient Unit - updateTable", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+    client = createClient(mockFetch, { debug: true });
+  });
+
+  it("calls updateTable successfully with temp token", async () => {
+    client = createClient(mockFetch, { debug: true, useTempTokens: true });
+
+    const mockBody = {
+      name: "Updated Root",
+      description: "Updated description",
+    };
+    const mockResponse = {
+      id: QB_TABLE_ID_1,
+      name: "Updated Root",
+      alias: "_DBID_ROOT",
+      description: "Updated description",
+      created: new Date("2025-02-13T18:22:33.000Z"),
+      updated: new Date("2025-03-10T12:00:00.000Z"),
+      nextRecordId: 1,
+      nextFieldId: 6,
+      defaultSortFieldId: 2,
+      defaultSortOrder: "DESC",
+      keyFieldId: 3,
+      singleRecordName: "Root",
+      pluralRecordName: "Roots",
+      sizeLimit: "500 MB",
+      spaceUsed: "0 KB",
+      spaceRemaining: "500 MB",
+    };
+
+    mockFetch
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
+      })
+      .mockResolvedValueOnce({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(mockResponse),
+      });
+
+    const response = await client.updateTable({
+      tableId: QB_TABLE_ID_1,
+      appId: QB_APP_ID,
+      body: mockBody,
+    });
+    expect(response).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledTimes(2);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/auth/temporary/${QB_TABLE_ID_1}`,
+      expect.any(Object)
+    );
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/tables/${QB_TABLE_ID_1}?appId=${QB_APP_ID}`,
+      expect.objectContaining({
+        method: "POST",
+        headers: expect.objectContaining({
+          "QB-Realm-Hostname": `${process.env.QB_REALM}.quickbase.com`,
+          Authorization: "QB-TEMP-TOKEN temp_token",
+          "Content-Type": "application/json",
+        }),
+        body: JSON.stringify(mockBody),
+      })
+    );
+  });
+});

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

@@ -0,0 +1,8 @@
+// tests/vitest/unit/umd.test.ts
+import { test, expect } from "vitest";
+const quickbaseUMD = require("../../dist/umd/quickbase.umd.js");
+const { quickbase: quickbaseESM } = await import("../../dist/esm/quickbase.js");
+test("UMD and ESM builds work in Node.js", () => {
+  expect(quickbaseUMD).toBeDefined();
+  expect(quickbaseESM).toBeDefined();
+});

package/text.txt

@@ -0,0 +1,104 @@
+What I’m Trying to Do
+My approach is to ensure AppsApi.ts is generated with getAppById so QuickbaseClient.ts can map it to client.getApp. Steps include:
+Fix fix-spec.ts:
+Add tags: ["Apps"] to /apps/* endpoints to group them into AppsApi.ts.
+
+Ensure all endpoints and models are correctly defined and typed.
+
+Debug regenerate-client.ts:
+Enhance logging to catch why AppsApi.ts isn’t generated.
+
+Test if getAppById appears in another file (e.g., DefaultApi.ts).
+
+Update QuickbaseClient.ts:
+Adjust imports to use the correct API class once generated.
+
+Test and Iterate:
+Run npm run fix-spec, npm run regenerate, and npm run test to verify AppsApi.ts exists and test.ts works.
+
+The latest fix-spec.ts with tags aims to force the generator to create AppsApi.ts, addressing the missing file issue.
+Relevant Project Files
+Here’s a list of files that would help understand and resolve this problem, along with their roles:
+src/code-generation/fix-spec.ts:
+Role: Modifies the original QuickBase spec (e.g., QuickBase_RESTful_*.json) to create quickbase-fixed.json with required endpoints (e.g., /apps/{appId}).
+
+Relevance: Defines the spec fed to the generator; errors here affect generation.
+
+src/code-generation/quickbase-fixed.json:
+Role: The processed OpenAPI spec used by regenerate-client.ts to generate code.
+
+Relevance: Confirms if /apps/{appId} is correctly structured with operationId: "getAppById".
+
+src/code-generation/regenerate-client.ts:
+Role: Runs OpenAPI Generator to produce src/generated/ files (APIs and models) and fixes .ts extensions with ts-morph.
+
+Relevance: Controls the generation process; logs reveal why AppsApi.ts is missing.
+
+src/generated/apis/AppsApi.ts (if exists):
+Role: Should contain getAppById method for /apps/{appId} GET.
+
+Relevance: Missing file is the core issue; its absence breaks QuickbaseClient.ts.
+
+src/generated/apis/DefaultApi.ts:
+Role: Default API class for untagged operations.
+
+Relevance: Might contain getAppById if tags are misconfigured.
+
+src/QuickbaseClient.ts:
+Role: Wraps generated API classes (e.g., AppsApi) in a Proxy for ergonomic calls (e.g., client.getApp).
+
+Relevance: Fails to import AppsApi.ts, causing the runtime error.
+
+src/test.ts:
+Role: Test script calling client.getApp({ appId }).
+
+Relevance: Final validation point; shows if the fix works.
+
+.env.development:
+Role: Stores QB_REALM, QB_USER_TOKEN, QB_APP_ID for API authentication.
+
+Relevance: Ensures the API call has valid credentials (not the current issue, but critical for success).
+
+src/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json (or similar):
+Role: Original QuickBase API spec before fix-spec.ts processing.
+
+Relevance: Shows how /apps/{appId} was originally defined, helping identify conflicts.
+
+package.json:
+Role: Defines scripts (fix-spec, regenerate, test) and dependencies (e.g., ts-node, openapi-generator-cli).
+
+Relevance: Confirms script commands and versions align with our process.
+
+
+
+
+What We Achieved
+Goal Met: You can now call client.getApp({ appId: "buwai2zpe" }) and get the app details { id: 'buwai2zpe', name: 'qb-copy' }.
+
+Fixes Applied:
+Added tags: ["Apps"] in fix-spec.ts to ensure AppsApi.ts is generated with getAppById.
+
+Updated QuickbaseClient.ts to:
+Use prototype methods via Object.getOwnPropertyNames.
+
+Bind methods to preserve context with .bind(api).
+
+Handle getAppById’s direct JSON return instead of a Response object.
+
+Result: The ergonomic API you wanted (client.getApp) works seamlessly with the generated AppsApi.ts.
+
+Why It Works Now
+fix-spec.ts:
+Correctly defined /apps/{appId} with operationId: "getAppById" and tags: ["Apps"], ensuring AppsApi.ts generation.
+
+regenerate-client.ts:
+Successfully ran OpenAPI Generator to produce AppsApi.ts with getAppById.
+
+QuickbaseClient.ts:
+buildMethodMap now captures getAppById and maps it to getApp.
+
+invokeMethod passes { appId: 'buwai2zpe' } as requestParameters and handles the JSON response directly.
+
+test.ts:
+Calls client.getApp and logs the result, proving the end-to-end flow.
+