quickbase-js 1.1.0-beta.5 → 1.1.0

package/tests/vitest/qb/tables/createTable.test.ts

@@ -1,55 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - createTable > creates a new table in QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = "buwai2zpe";
-
-    const tableName = `TestTable_${Date.now()}`;
-    const createBody = {
-      name: tableName,
-      description: "Test table creation",
-      singleRecordName: "TestRecord",
-      pluralRecordName: "TestRecords",
-    };
-
-    console.log("Config used:", config);
-    console.log("Creating table with:", createBody);
-    const response = await client.createTable({ appId, body: createBody });
-
-    expect(response).toBeDefined();
-    expect(response.id).toBeDefined();
-    expect(response.name).toBe(tableName);
-    expect(response.description).toBe(createBody.description);
-    expect(response.singleRecordName).toBe(createBody.singleRecordName);
-    expect(response.pluralRecordName).toBe(createBody.pluralRecordName);
-    expect(response.alias).toMatch(/^_DBID_/);
-    expect(response.created).toBeInstanceOf(Date);
-    expect(response.updated).toBeInstanceOf(Date);
-    expect(response.nextRecordId).toBeGreaterThanOrEqual(1);
-    expect(response.nextFieldId).toBeGreaterThanOrEqual(1);
-    expect(response.defaultSortFieldId).toBeGreaterThanOrEqual(0);
-    expect(response.keyFieldId).toBeGreaterThanOrEqual(1);
-    expect(response.sizeLimit).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
-    expect(response.spaceUsed).toMatch(/^\d+\s(KB|MB)$/); // e.g., "0 KB"
-    expect(response.spaceRemaining).toMatch(/^\d+\sMB$/); // e.g., "500 MB"
-
-    console.log("Real API response:", response);
-
-    // Cleanup: Delete the table to avoid clutter
-    const deleteResponse = await client.deleteTable({
-      tableId: response.id,
-      appId,
-    });
-    expect(deleteResponse.deletedTableId).toBe(response.id);
-    console.log("Cleanup - Deleted table:", deleteResponse);
-  }
-);

package/tests/vitest/qb/tables/deleteTable.test.ts

@@ -1,50 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - deleteTable > deletes a table in QuickBase",
-  { timeout: 20000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = "buwai2zpe";
-
-    // Step 1: Create a temporary table to delete
-    const tableName = `DeleteTest_${Date.now()}`;
-    const createBody = {
-      name: tableName,
-      description: "Temporary table for delete test",
-      singleRecordName: "DeleteTest",
-      pluralRecordName: "DeleteTests",
-    };
-    console.log("Creating temporary table with:", createBody);
-    const createResponse = await client.createTable({
-      appId,
-      body: createBody,
-    });
-    expect(createResponse.id).toBeDefined();
-    expect(createResponse.name).toBe(tableName);
-    console.log("Created table:", createResponse);
-    const tableId = createResponse.id;
-
-    // Step 2: Delete the table
-    console.log("Deleting table:", { tableId, appId });
-    const deleteResponse = await client.deleteTable({ tableId, appId });
-    expect(deleteResponse).toBeDefined();
-    expect(deleteResponse.deletedTableId).toBe(tableId);
-    console.log("Delete API response:", deleteResponse);
-
-    // Step 3: Verify the table is gone
-    try {
-      await client.getTable({ tableId, appId });
-      throw new Error("Table should not exist after deletion");
-    } catch (error) {
-      expect(error.message).toMatch(/404|not found/i); // Expect a 404 error
-      console.log("Verified table deletion:", error.message);
-    }
-  }
-);

package/tests/vitest/qb/tables/getAppTables.test.ts

@@ -1,46 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getAppTables > fetches real table data from QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const tablesAppId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const result = await client.getAppTables({ appId: tablesAppId });
-    console.log("Real API response:", result);
-
-    expect(result).toBeDefined();
-    expect(result).toBeInstanceOf(Array);
-    expect(result.length).toBeGreaterThan(0);
-    expect(result).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          id: "buwai2zr4",
-          alias: "_DBID_ROOT",
-          name: expect.any(String), // Allow dynamic name due to updateTable
-          description: expect.any(String), // Allow dynamic description
-          created: expect.any(Date),
-          updated: expect.any(Date), // Allow varying timestamps
-          nextRecordId: expect.any(Number),
-          nextFieldId: expect.any(Number),
-          defaultSortFieldId: expect.any(Number),
-          defaultSortOrder: "DESC",
-          keyFieldId: expect.any(Number),
-          singleRecordName: "Root",
-          pluralRecordName: "Roots",
-          sizeLimit: "500 MB",
-          spaceUsed: expect.any(String),
-          spaceRemaining: "500 MB",
-        }),
-      ])
-    );
-  }
-);

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

@@ -1,80 +0,0 @@
-// tests/vitest/qb/tables/getRelationships.test.ts
-import { describe, test, expect } from "vitest";
-import { quickbase } from "/home/drew/Projects/quickbase-js/src/quickbaseClient.ts";
-import { QB_TABLE_ID_1 } from "/home/drew/Projects/quickbase-js/tests/setup.ts";
-import { GetRelationships200Response } from "/home/drew/Projects/quickbase-js/src/generated/models";
-
-describe("QuickbaseClient Integration - getRelationships", () => {
-  const qb = quickbase({
-    realm: process.env.QB_REALM || "builderprogram-dbradford6815",
-    userToken: process.env.QB_USER_TOKEN || "",
-    debug: true,
-  });
-
-  test("fetches real relationships from QuickBase", async () => {
-    // Ensure environment variables are set
-    if (!process.env.QB_REALM)
-      throw new Error("QB_REALM is not defined in .env");
-    if (!process.env.QB_USER_TOKEN)
-      throw new Error("QB_USER_TOKEN is not defined in .env");
-
-    console.log("Config used:", {
-      realm: process.env.QB_REALM,
-      userToken: process.env.QB_USER_TOKEN,
-      tableId: QB_TABLE_ID_1,
-    });
-
-    const response: GetRelationships200Response = await qb.getRelationships({
-      tableId: QB_TABLE_ID_1, // Query relationships for QB_TABLE_ID_1 (e.g., "buwai2zws")
-      skip: 0,
-    });
-
-    console.log("Real API response:", JSON.stringify(response, null, 2));
-
-    // Basic structure validation
-    expect(response).toBeDefined();
-    expect(response.metadata).toBeDefined();
-    expect(response.metadata).toHaveProperty(
-      "numRelationships",
-      expect.any(Number)
-    );
-    expect(response.metadata).toHaveProperty("skip", 0);
-    expect(response.metadata).toHaveProperty(
-      "totalRelationships",
-      expect.any(Number)
-    );
-    expect(response.relationships).toBeDefined();
-    expect(Array.isArray(response.relationships)).toBe(true);
-
-    // If relationships exist, validate the first one
-    if (response.relationships.length > 0) {
-      const relationship = response.relationships[0];
-      expect(relationship).toHaveProperty("id", expect.any(Number));
-      expect(relationship).toHaveProperty("parentTableId", expect.any(String));
-      expect(relationship).toHaveProperty("childTableId", QB_TABLE_ID_1);
-      expect(relationship).toHaveProperty("foreignKeyField");
-      expect(relationship.foreignKeyField).toHaveProperty(
-        "id",
-        expect.any(Number)
-      );
-      expect(relationship.foreignKeyField).toHaveProperty(
-        "label",
-        expect.any(String)
-      );
-      expect(relationship.foreignKeyField).toHaveProperty(
-        "type",
-        expect.any(String)
-      );
-      expect(relationship).toHaveProperty("isCrossApp", expect.any(Boolean));
-      expect(relationship).toHaveProperty("lookupFields", expect.any(Array));
-
-      // summaryFields is optional; only validate if present
-      if (
-        "summaryFields" in relationship &&
-        relationship.summaryFields !== undefined
-      ) {
-        expect(Array.isArray(relationship.summaryFields)).toBe(true);
-      }
-    }
-  }, 10000); // Timeout as second argument
-});

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

@@ -1,26 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getTable > fetches real table data from QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const tableId = "buwai2zr4";
-    const appId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const response = await client.getTable({ tableId, appId });
-    expect(response).toBeDefined();
-    expect(response.id).toBe(tableId);
-    expect(response.name).toBe("Root"); // Expect original name
-    expect(response.alias).toBe("_DBID_ROOT");
-    expect(response.created).toBeInstanceOf(Date);
-    console.log("Real API response:", response);
-  }
-);

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

@@ -1,48 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - updateTable > updates real table data in QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = "buwai2zpe";
-    const tableId = "buwai2zr4";
-    const updatedBody = {
-      name: "Root Updated " + Date.now(),
-      description: "Integration test update",
-    };
-    const originalBody = {
-      name: "Root",
-      description: "",
-    };
-
-    console.log("Config used:", config);
-    // Update the table
-    const response = await client.updateTable({
-      tableId,
-      appId,
-      body: updatedBody,
-    });
-    expect(response).toBeDefined();
-    expect(response.id).toBe(tableId);
-    expect(response.name).toBe(updatedBody.name);
-    expect(response.description).toBe(updatedBody.description);
-    console.log("Real API response:", response);
-
-    // Cleanup: Revert the table to original state
-    const cleanupResponse = await client.updateTable({
-      tableId,
-      appId,
-      body: originalBody,
-    });
-    expect(cleanupResponse.name).toBe(originalBody.name);
-    expect(cleanupResponse.description).toBe(originalBody.description);
-    console.log("Cleanup API response:", cleanupResponse);
-  }
-);

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

@@ -1,282 +0,0 @@
-// tests/vitest/unit/apps/copyApp.test.ts
-import { describe, it, expect, beforeEach } from "vitest";
-import {
-  createClient,
-  mockFetch,
-  QB_APP_ID,
-  QB_REALM,
-  QB_USER_TOKEN,
-} from "@tests/setup.ts";
-import { CopyAppRequest, CopyApp200Response } from "@/generated/models";
-
-describe("QuickbaseClient Unit - copyApp", () => {
-  let client: ReturnType<typeof createClient>;
-
-  beforeEach(() => {
-    mockFetch.mockClear();
-  });
-
-  it("initializes without errors", () => {
-    client = createClient(mockFetch, { debug: true });
-    expect(client).toBeDefined();
-  });
-
-  it("has copyApp method", () => {
-    client = createClient(mockFetch, { debug: true });
-    expect(typeof client.copyApp).toBe("function");
-  });
-
-  it("calls copyApp successfully with user token", async () => {
-    client = createClient(mockFetch, { debug: true });
-
-    const request: CopyAppRequest = {
-      name: "Copied App",
-      description: "A copy of the original app",
-      properties: {
-        keepData: false,
-        excludeFiles: true,
-        usersAndRoles: false,
-        assignUserToken: true,
-      },
-    };
-
-    const mockResponse: CopyApp200Response = {
-      id: "bpqe82s1",
-      name: "Copied App",
-      description: "A copy of the original app",
-      created: new Date("2025-03-11T10:00:00Z"), // Changed to Date object
-      updated: new Date("2025-03-11T10:00:00Z"), // Changed to Date object
-      dateFormat: "MM-DD-YYYY",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      hasEveryoneOnTheInternet: false,
-      ancestorId: QB_APP_ID,
-      dataClassification: "None",
-      variables: [],
-    };
-
-    mockFetch.mockResolvedValueOnce({
-      ok: true,
-      status: 200,
-      json: () =>
-        Promise.resolve({
-          ...mockResponse,
-          created: "2025-03-11T10:00:00Z", // API returns string
-          updated: "2025-03-11T10:00:00Z", // API returns string
-        }),
-    });
-
-    const result = await client.copyApp({ appId: QB_APP_ID, body: request });
-
-    expect(result).toEqual(mockResponse);
-    expect(mockFetch).toHaveBeenCalledWith(
-      `https://api.quickbase.com/v1/apps/${QB_APP_ID}/copy`,
-      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("calls copyApp successfully with temp token", async () => {
-    client = createClient(mockFetch, { useTempTokens: true, debug: true });
-
-    const request: CopyAppRequest = {
-      name: "Copied App with Temp Token",
-      description: "A copy using temp token",
-      properties: {
-        keepData: true,
-        excludeFiles: false,
-        usersAndRoles: true,
-        assignUserToken: false,
-      },
-    };
-
-    const mockResponse: CopyApp200Response = {
-      id: "bpqe82s2",
-      name: "Copied App with Temp Token",
-      description: "A copy using temp token",
-      created: new Date("2025-03-11T11:00:00Z"), // Changed to Date object
-      updated: new Date("2025-03-11T11:00:00Z"), // Changed to Date object
-      dateFormat: "MM-DD-YYYY",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      hasEveryoneOnTheInternet: true,
-      ancestorId: QB_APP_ID,
-      dataClassification: "None",
-      variables: [],
-    };
-
-    mockFetch
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () => Promise.resolve({ temporaryAuthorization: "temp_token" }),
-      })
-      .mockResolvedValueOnce({
-        ok: true,
-        status: 200,
-        json: () =>
-          Promise.resolve({
-            ...mockResponse,
-            created: "2025-03-11T11:00:00Z", // API returns string
-            updated: "2025-03-11T11:00:00Z", // API returns string
-          }),
-      });
-
-    const result = await client.copyApp({ 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}/copy`,
-      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: CopyAppRequest = {
-      name: "Retry Copied App",
-      description: "Retry after 401",
-      properties: {
-        keepData: false,
-        excludeFiles: true,
-        usersAndRoles: false,
-        assignUserToken: true,
-      },
-    };
-
-    const mockResponse: CopyApp200Response = {
-      id: "bpqe82s3",
-      name: "Retry Copied App",
-      description: "Retry after 401",
-      created: new Date("2025-03-11T12:00:00Z"), // Changed to Date object
-      updated: new Date("2025-03-11T12:00:00Z"), // Changed to Date object
-      dateFormat: "MM-DD-YYYY",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      hasEveryoneOnTheInternet: false,
-      ancestorId: QB_APP_ID,
-      dataClassification: "None",
-      variables: [],
-    };
-
-    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,
-            created: "2025-03-11T12:00:00Z", // API returns string
-            updated: "2025-03-11T12:00:00Z", // API returns string
-          }),
-      });
-
-    const result = await client.copyApp({ 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}/copy`,
-      expect.objectContaining({
-        headers: expect.objectContaining({
-          Authorization: "QB-TEMP-TOKEN initial_token",
-        }),
-      })
-    );
-    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}/copy`,
-      expect.objectContaining({
-        headers: expect.objectContaining({
-          Authorization: "QB-TEMP-TOKEN new_token",
-        }),
-      })
-    );
-  });
-
-  it("handles 400 error for invalid request", async () => {
-    client = createClient(mockFetch, { debug: true });
-
-    const request: CopyAppRequest = {
-      name: "", // Invalid: name is required
-      description: "Invalid request",
-    };
-
-    mockFetch.mockResolvedValueOnce({
-      ok: false,
-      status: 400,
-      json: () => Promise.resolve({ message: "Name is required" }),
-    });
-
-    await expect(
-      client.copyApp({ 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}/copy`,
-      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),
-      })
-    );
-  });
-});