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

package/tests/vitest/qb/records/upsert.test.ts

@@ -1,6 +1,10 @@
 // tests/vitest/qb/records/upsert.test.ts
 import { describe, test, expect, beforeEach, afterEach } from "vitest";
 import { quickbase } from "@/quickbaseClient.ts";
+import {
+  Upsert200Response,
+  Upsert207Response,
+} from "/home/drew/Projects/quickbase-js/src/generated/models";
 
 const TABLE_ID = "buwai2zws";
 const MARKER_FIELD_ID = 6; // Text field for marking test records
@@ -39,7 +43,7 @@ describe("QuickbaseClient - Upsert Integration", () => {
   test(
     "creates a new record successfully",
     async () => {
-      const response = await qb.upsert({
+      const response: Upsert200Response | Upsert207Response = await qb.upsert({
         body: {
           to: TABLE_ID,
           data: [{ [MARKER_FIELD_ID]: { value: "test-marker-upsert" } }],
@@ -47,12 +51,38 @@ describe("QuickbaseClient - Upsert Integration", () => {
         },
       });
 
+      // Check metadata with null safety
+      expect(
+        response.metadata,
+        "Expected metadata to be defined"
+      ).toBeDefined();
+      if (!response.metadata) {
+        throw new Error("Expected metadata to be present in upsert response");
+      }
+
+      expect(
+        response.metadata.createdRecordIds,
+        "Expected createdRecordIds to be defined"
+      ).toBeDefined();
+      if (!response.metadata.createdRecordIds) {
+        throw new Error(
+          "Expected createdRecordIds to be present in upsert response"
+        );
+      }
       expect(response.metadata.createdRecordIds.length).toBe(1);
+
+      // Check data with null safety
+      expect(response.data, "Expected data to be defined").toBeDefined();
+      if (!response.data || response.data.length === 0) {
+        throw new Error("Expected at least one record in data");
+      }
       expect(response.data).toHaveLength(1);
-      expect(response.data[0][MARKER_FIELD_ID].value).toBe(
+      expect(response.data[0][MARKER_FIELD_ID]?.value).toBe(
         "test-marker-upsert"
       );
-      expect(response.data[0][3].value).toBeDefined(); // Record ID assigned by QuickBase
+      expect(response.data[0][3]?.value).toBeDefined(); // Record ID assigned by QuickBase
+
+      // Check totalNumberOfRecordsProcessed
       expect(response.metadata.totalNumberOfRecordsProcessed).toBe(1);
     },
     { timeout: 10000 }

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

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

@@ -0,0 +1,282 @@
+// 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),
+      })
+    );
+  });
+});

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

@@ -0,0 +1,125 @@
+// tests/vitest/unit/apps/createApp.test.ts
+import { describe, it, expect, beforeEach } from "vitest";
+import {
+  createClient,
+  mockFetch,
+  QB_REALM,
+  QB_USER_TOKEN,
+} from "@tests/setup.ts";
+import { CreateAppRequest, CreateApp200Response } from "@/generated/models";
+
+describe("QuickbaseClient Unit - createApp", () => {
+  let client: ReturnType<typeof createClient>;
+
+  beforeEach(() => {
+    mockFetch.mockClear();
+  });
+
+  it("initializes without errors", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(client).toBeDefined();
+  });
+
+  it("has createApp method", () => {
+    client = createClient(mockFetch, { debug: true });
+    expect(typeof client.createApp).toBe("function");
+  });
+
+  it("calls createApp successfully with user token", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: CreateAppRequest = {
+      name: "New App",
+      description: "A new app for testing",
+      assignToken: true,
+    };
+
+    const mockResponse: CreateApp200Response = {
+      id: "new-app-id",
+      name: "New App",
+      description: "A new app for testing",
+      created: new Date("2025-03-11T10:00:00Z"),
+      updated: new Date("2025-03-11T10:00:00Z"),
+      dateFormat: "MM-DD-YYYY",
+      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
+      hasEveryoneOnTheInternet: false,
+      variables: [],
+      dataClassification: "None",
+      memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
+      securityProperties: {
+        allowClone: false,
+        allowExport: true,
+        enableAppTokens: true,
+        hideFromPublic: false,
+        mustBeRealmApproved: false,
+        useIPFilter: false,
+      },
+    };
+
+    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.createApp({ body: request });
+
+    expect(result).toEqual(mockResponse);
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps`,
+      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: expect.stringContaining('"name":"New App"'),
+        credentials: "omit", // Added to match actual behavior
+      })
+    );
+    // Additional check to ensure body contains all properties regardless of order
+    const callArgs = mockFetch.mock.calls[0];
+    const body = JSON.parse(callArgs[1].body as string);
+    expect(body).toEqual(request);
+  });
+
+  it("handles 400 error for invalid request", async () => {
+    client = createClient(mockFetch, { debug: true });
+
+    const request: CreateAppRequest = {
+      name: "", // Invalid: name is required
+    };
+
+    mockFetch.mockImplementationOnce(() =>
+      Promise.resolve({
+        ok: false,
+        status: 400,
+        json: () => Promise.resolve({ message: "Name is required" }),
+      })
+    );
+
+    await expect(client.createApp({ body: request })).rejects.toThrow(
+      "API Error: Name is required (Status: 400)"
+    );
+
+    expect(mockFetch).toHaveBeenCalledWith(
+      `https://api.quickbase.com/v1/apps`,
+      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", // Added to match actual behavior
+      })
+    );
+  });
+});