quickbase-js 0.1.0-beta.8 → 1.0.0

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

@@ -1,305 +0,0 @@
-// tests/vitest/unit/tables/updateRelationship.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 {
-  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}`, // Changed to singular
-      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}`, // Changed to singular
-      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}`, // Changed to singular
-      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}`, // Changed to singular
-      expect.objectContaining({
-        headers: expect.objectContaining({
-          Authorization: "QB-TEMP-TOKEN new_token",
-        }),
-      })
-    );
-    expect(consoleSpy).toHaveBeenCalledWith(
-      "Authorization error for updateRelationship (temp token), refreshing token:",
-      expect.any(String)
-    );
-    expect(consoleSpy).toHaveBeenCalledWith(
-      "Retrying updateRelationship with temp token"
-    );
-    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}`, // Changed to singular
-      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/tables/updateTable.test.ts

@@ -1,80 +0,0 @@
-// 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/tokenLifespan.test.ts

@@ -1,138 +0,0 @@
-import { describe, it, expect, beforeEach, 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>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-  });
-
-  it("reuses token within lifespan and fetches new token after expiration", async () => {
-    // Set a short lifespan of 500ms for testing
-    client = createClient(mockFetch, {
-      realm: QB_REALM,
-      useTempTokens: true,
-      tokenLifespan: 500, // 0.5 seconds
-      debug: true,
-    });
-
-    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"),
-      updated: new Date("2020-01-01T00:00:00Z"),
-      dateFormat: "MM-DD-YYYY",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      hasEveryoneOnTheInternet: false,
-      ancestorId: null,
-      variables: [],
-      securityProperties: {},
-      memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
-      dataClassification: "None",
-    };
-
-    // First call: Fetch a new token
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve({ temporaryAuthorization: "token1" }),
-      })
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve(mockResponse),
-      });
-
-    await client.updateApp({ appId: QB_APP_ID, body: request });
-    expect(mockFetch).toHaveBeenCalledTimes(2); // Token fetch + API call
-
-    // Second call within lifespan: Should reuse token1
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve(mockResponse),
-    });
-    await client.updateApp({ appId: QB_APP_ID, body: request });
-    expect(mockFetch).toHaveBeenCalledTimes(3); // Only API call, no new token fetch
-
-    // Wait for token to expire (500ms + buffer)
-    await new Promise((resolve) => setTimeout(resolve, 600));
-
-    // Third call after expiration: Should fetch a new token
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve({ temporaryAuthorization: "token2" }),
-      })
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve(mockResponse),
-      });
-    await client.updateApp({ appId: QB_APP_ID, body: request });
-    expect(mockFetch).toHaveBeenCalledTimes(5); // New token fetch + API call
-  });
-
-  it("uses default lifespan when not specified", async () => {
-    // No tokenLifespan provided, should use default (4:50 = 290,000ms)
-    client = createClient(mockFetch, {
-      realm: QB_REALM,
-      useTempTokens: true,
-      debug: true,
-    });
-
-    const request: UpdateAppRequest = {
-      name: "Default Lifespan Test",
-    };
-    const mockResponse: UpdateApp200Response = {
-      id: QB_APP_ID,
-      name: "Default Lifespan Test",
-      description: "",
-      created: new Date("2020-01-01T00:00:00Z"),
-      updated: new Date("2020-01-01T00:00:00Z"),
-      dateFormat: "MM-DD-YYYY",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      hasEveryoneOnTheInternet: false,
-      ancestorId: null,
-      variables: [],
-      securityProperties: {},
-      memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
-      dataClassification: "None",
-    };
-
-    // First call: Fetch a new token
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () =>
-          Promise.resolve({ temporaryAuthorization: "default_token" }),
-      })
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve(mockResponse),
-      });
-
-    await client.updateApp({ appId: QB_APP_ID, body: request });
-    expect(mockFetch).toHaveBeenCalledTimes(2); // Token fetch + API call
-
-    // Second call within default lifespan (e.g., after 1 second, well below 4:50)
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () => Promise.resolve(mockResponse),
-    });
-    await new Promise((resolve) => setTimeout(resolve, 1000)); // Wait 1 second
-    await client.updateApp({ appId: QB_APP_ID, body: request });
-    expect(mockFetch).toHaveBeenCalledTimes(3); // No new token fetch, still within 4:50
-  });
-});

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

@@ -1,8 +0,0 @@
-// 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

@@ -1,104 +0,0 @@
-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.
-