quickbase-js 0.1.0-beta.13 → 0.1.0-beta.14

package/tests/playwright/qb/auth/tempTokenRenewal.test.ts

@@ -1,133 +0,0 @@
-import { test, expect } from "@playwright/test";
-import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient.ts";
-import dotenv from "dotenv";
-
-dotenv.config();
-
-const loginToQuickbase = async (
-  page: import("@playwright/test").Page,
-  quickbaseUrl: string,
-  username: string,
-  password: string,
-  appUrl: string
-): Promise<void> => {
-  console.log("Logging in to QuickBase");
-  await page.goto(quickbaseUrl, { timeout: 60000 });
-  await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
-  await page.fill("input[name='loginid']", username);
-  await page.fill("input[name='password']", password);
-  await page.click("#signin");
-  await page.waitForURL(`https://*.quickbase.com/**`, {
-    waitUntil: "networkidle",
-    timeout: 60000,
-  });
-  console.log("Signed In to QuickBase.");
-  await page.goto(appUrl, { waitUntil: "networkidle", timeout: 60000 });
-  console.log("Navigated to app URL:", page.url());
-};
-
-test.describe("QuickbaseClient Integration - Temp Token Renewal", () => {
-  test("renews temp token after 5 minutes with getApp → wait → getApp sequence", async ({
-    page,
-  }) => {
-    const realm = process.env.QB_REALM ?? "";
-    const appId = process.env.QB_APP_ID ?? "";
-    const username = process.env.QB_USERNAME ?? "";
-    const password = process.env.QB_PASSWORD ?? "";
-
-    if (!realm || !appId || !username || !password) {
-      throw new Error(
-        "Required QuickBase environment variables are not defined"
-      );
-    }
-
-    const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
-    const appUrl = `https://${realm}.quickbase.com/db/${appId}`;
-
-    await loginToQuickbase(page, quickbaseUrl, username, password, appUrl);
-
-    const client = quickbase({
-      realm,
-      useTempTokens: true,
-      debug: true,
-      fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
-        const url = input.toString();
-        console.log(`Fetching ${url} with init:`, init);
-        const effectiveInit = init || {};
-        const response = await page.evaluate(
-          async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
-            const res = await fetch(fetchUrl, fetchInit); // Rely on quickbaseClient.ts for credentials
-            const body = await res.text();
-            const headersObj: Record<string, string> = {};
-            res.headers.forEach((value, key) => {
-              headersObj[key] = value;
-            });
-            return {
-              ok: res.ok,
-              status: res.status,
-              statusText: res.statusText,
-              headers: headersObj,
-              body,
-            };
-          },
-          [url, effectiveInit] as [string, RequestInit]
-        );
-
-        console.log(`Raw response from ${url}:`, {
-          status: response.status,
-          statusText: response.statusText,
-          body: response.body,
-        });
-
-        const fetchResponse = new Response(response.body || null, {
-          status: response.status,
-          statusText: response.statusText,
-          headers: new Headers(response.headers),
-        });
-
-        fetchResponse.json = async () => {
-          if (!response.body) {
-            throw new Error("Empty response body from API");
-          }
-          try {
-            return JSON.parse(response.body);
-          } catch (e) {
-            throw new SyntaxError(`Invalid JSON response: ${response.body}`);
-          }
-        };
-
-        return fetchResponse;
-      },
-    }) as QuickbaseClient;
-
-    console.log("Checking session state before getApp...");
-    const cookies = await page.context().cookies();
-    const sessionCookie = cookies.find(
-      (c) => c.name === "TICKET" || c.name.startsWith("TICKET_")
-    );
-    console.log(
-      "Session cookie present:",
-      !!sessionCookie,
-      "Cookies:",
-      cookies
-    );
-    if (!sessionCookie) throw new Error("TICKET session cookie not found");
-
-    await page.waitForTimeout(5000); // Debug delay
-    console.log("Cookies after delay:", await page.context().cookies());
-
-    const appResult1 = await client.getApp({ appId });
-    console.log("First getApp response:", appResult1);
-    expect(appResult1).toHaveProperty("id", appId);
-
-    console.log("Waiting 5 minutes to test token expiration...");
-    await new Promise((resolve) => setTimeout(resolve, 5 * 60 * 1000));
-
-    await page.reload({ waitUntil: "load", timeout: 60000 });
-    console.log("Refreshed page after 5 minutes, URL:", page.url());
-
-    const appResult2 = await client.getApp({ appId });
-    console.log("Second getApp response:", appResult2);
-    expect(appResult2).toHaveProperty("id", appId);
-  });
-});

package/tests/setup.ts

@@ -1,53 +0,0 @@
-// @tests/setup.ts
-import { vi } from "vitest";
-import { quickbase } from "../src/quickbaseClient.ts";
-import type { QuickbaseConfig } from "../src/quickbaseClient.ts";
-import dotenv from "dotenv";
-
-// Load environment variables from .env file
-dotenv.config({ path: "./.env" }); // Assumes .env is at project root
-
-export const mockFetch = vi.fn();
-
-export const QB_REALM = process.env.QB_REALM || "test-realm";
-export const QB_USER_TOKEN =
-  process.env.QB_USER_TOKEN || "user-token-1234567890";
-export const QB_APP_ID = process.env.QB_APP_ID || "app-id-1234567890";
-export const QB_TABLE_ID_1 =
-  process.env.QB_TABLE_ID_1 || "table-id-1-1234567890";
-export const QB_TABLE_ID_2 =
-  process.env.QB_TABLE_ID_2 || "table-id-2-1234567890";
-
-// Mock env variables for consistency, using .env values if available
-vi.stubEnv("QB_REALM", QB_REALM);
-vi.stubEnv("QB_USER_TOKEN", QB_USER_TOKEN);
-vi.stubEnv("QB_APP_ID", QB_APP_ID);
-vi.stubEnv("QB_TABLE_ID_1", QB_TABLE_ID_1);
-vi.stubEnv("QB_TABLE_ID_2", QB_TABLE_ID_2);
-
-export const createClient = (
-  fetchApi?: any,
-  config: Partial<QuickbaseConfig> = {}
-) => {
-  // Use loaded env vars with fallbacks for safety
-  const realm = QB_REALM;
-  const userToken = QB_USER_TOKEN;
-
-  const client = quickbase({
-    realm,
-    userToken,
-    debug: true,
-    fetchApi,
-    throttle: { rate: 10, burst: 10 }, // Throttle at 10 req/s with 10 burst capacity
-    ...config, // Allow overrides if provided
-  });
-  console.log("[createClient] Config:", {
-    realm,
-    userToken,
-    debug: true,
-    throttle: { rate: 10, burst: 10 },
-    ...config,
-  });
-  console.log("[createClient] Returning:", client);
-  return client;
-};

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

@@ -1,76 +0,0 @@
-// tests/vitest/qb/apps/copyApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - copyApp > creates a new copied app in QuickBase",
-  { timeout: 30000 }, // Increased to 30 seconds
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = process.env.QB_APP_ID || ""; // The source app ID to copy from
-
-    const copyAppName = `CopiedApp_${Date.now()}`; // Unique name to avoid conflicts
-    const copyBody = {
-      name: copyAppName,
-      description: "Test copied app",
-      properties: {
-        keepData: false,
-        excludeFiles: true,
-        usersAndRoles: false,
-        assignUserToken: true,
-      },
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "", // Avoid logging sensitive token
-    });
-    console.log("Copying app with:", copyBody);
-    const startTime = Date.now();
-    let response;
-    try {
-      response = await client.copyApp({ appId, body: copyBody });
-      const duration = Date.now() - startTime;
-      console.log(`copyApp completed in ${duration}ms`);
-      console.log("Real API response:", response);
-
-      expect(response).toBeDefined();
-      expect(response.id).toBeDefined();
-      expect(response.name).toBe(copyAppName);
-      expect(response.description).toBe(copyBody.description);
-      expect(response.created).toBeInstanceOf(Date);
-      expect(response.updated).toBeInstanceOf(Date);
-      expect(response.dateFormat).toMatch(/^\w{2}-\w{2}-\w{4}$/); // e.g., "MM-DD-YYYY"
-      expect(typeof response.timeZone).toBe("string"); // Simplified check
-      expect(typeof response.hasEveryoneOnTheInternet).toBe("boolean");
-      expect(response.ancestorId).toBe(appId); // Should match the source app ID
-      expect(
-        response.dataClassification === undefined ||
-          typeof response.dataClassification === "string"
-      ).toBe(true); // Allow undefined or string
-      expect(
-        response.variables === undefined || Array.isArray(response.variables)
-      ).toBe(true); // Allow undefined or array
-    } catch (error) {
-      const duration = Date.now() - startTime;
-      console.error(`copyApp failed after ${duration}ms:`, error);
-      throw error; // Re-throw to fail the test
-    }
-
-    // Cleanup: Delete the copied app using deleteApp
-    const deleteStartTime = Date.now();
-    const deleteResponse = await client.deleteApp({
-      appId: response.id,
-      body: { name: copyAppName },
-    });
-    const deleteDuration = Date.now() - deleteStartTime;
-    console.log(`deleteApp completed in ${deleteDuration}ms`);
-    console.log("Cleanup - Deleted app:", deleteResponse);
-    expect(deleteResponse.deletedAppId).toBe(response.id);
-  }
-);

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

@@ -1,64 +0,0 @@
-// tests/vitest/qb/apps/createApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - createApp > creates a new app in QuickBase",
-  { timeout: 30000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-      useTempTokens: false,
-    };
-    const client = quickbase(config);
-
-    const appName = `TestApp_${Date.now()}`;
-    const createBody = {
-      name: appName,
-      description: "Test app creation",
-      assignToken: true,
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "",
-    });
-    console.log("Creating app with:", createBody);
-    const createStartTime = Date.now();
-    let response;
-    try {
-      response = await client.createApp({ body: createBody });
-      const createDuration = Date.now() - createStartTime;
-      console.log(`createApp completed in ${createDuration}ms`);
-      console.log("Real API response:", response);
-
-      expect(response).toBeDefined();
-      expect(response.id).toBeDefined();
-      expect(response.name).toBe(appName);
-      expect(response.description).toBe(createBody.description);
-      expect(response.created).toBeInstanceOf(Date);
-      expect(response.updated).toBeInstanceOf(Date);
-      expect(response.dateFormat).toMatch(/^\w{2}-\w{2}-\w{4}$/);
-      expect(typeof response.timeZone).toBe("string");
-      expect(typeof response.hasEveryoneOnTheInternet).toBe("boolean");
-      expect(
-        response.dataClassification === undefined ||
-          typeof response.dataClassification === "string"
-      ).toBe(true);
-      expect(
-        response.variables === undefined || Array.isArray(response.variables)
-      ).toBe(true);
-
-      // Cleanup: Delete the app after assertions
-      const deleteBody = { name: appName };
-      await client.deleteApp({ appId: response.id, body: deleteBody });
-      console.log("Cleanup: App deleted:", response.id);
-    } catch (error) {
-      const createDuration = Date.now() - createStartTime;
-      console.error(`createApp failed after ${createDuration}ms:`, error);
-      throw error;
-    }
-  }
-);

package/tests/vitest/qb/apps/deleteApp.test.ts

@@ -1,76 +0,0 @@
-// tests/vitest/qb/apps/deleteApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - deleteApp > deletes an app in QuickBase",
-  { timeout: 30000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-      useTempTokens: false,
-    };
-    const client = quickbase(config);
-
-    const appName = `TempApp_${Date.now()}`;
-    const createBody = {
-      name: appName,
-      description: "Temporary app for deleteApp test",
-      assignToken: true, // Match createApp.test.ts
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "",
-    });
-    console.log("Creating temporary app with:", createBody);
-    const createStartTime = Date.now();
-    let createResponse;
-    try {
-      createResponse = await client.createApp({ body: createBody });
-      const createDuration = Date.now() - createStartTime;
-      console.log(`createApp completed in ${createDuration}ms`);
-      console.log("Created app response:", createResponse);
-
-      expect(createResponse).toBeDefined();
-      expect(createResponse.id).toBeDefined();
-      expect(createResponse.name).toBe(appName);
-    } catch (error) {
-      const createDuration = Date.now() - createStartTime;
-      console.error(`createApp failed after ${createDuration}ms:`, error);
-      throw error;
-    }
-
-    const deleteBody = {
-      name: appName,
-    };
-    console.log("Deleting app with:", deleteBody);
-    const deleteStartTime = Date.now();
-    try {
-      const deleteResponse = await client.deleteApp({
-        appId: createResponse.id,
-        body: deleteBody,
-      });
-      const deleteDuration = Date.now() - deleteStartTime;
-      console.log(`deleteApp completed in ${deleteDuration}ms`);
-      console.log("Delete app response:", deleteResponse);
-
-      expect(deleteResponse).toBeDefined();
-      expect(deleteResponse.deletedAppId).toBe(createResponse.id);
-    } catch (error) {
-      const deleteDuration = Date.now() - deleteStartTime;
-      console.error(`deleteApp failed after ${deleteDuration}ms:`, error);
-      if (error instanceof Error && "response" in error) {
-        try {
-          const errorBody = await (error as any).response.json();
-          console.error("Full deleteApp error response:", errorBody);
-        } catch (e) {
-          console.error("Could not parse error response:", e);
-        }
-      }
-      throw error;
-    }
-  }
-);

package/tests/vitest/qb/apps/getApp.test.ts

@@ -1,44 +0,0 @@
-// tests/vitest/qb/apps/getApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getApp > fetches real app 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 getAppId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const result = await client.getApp({ appId: getAppId });
-    console.log("Real API response:", result);
-
-    expect(result).toEqual({
-      id: getAppId,
-      name: "qb-copy",
-      created: expect.any(Date),
-      updated: expect.any(Date),
-      description: "",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      dateFormat: "MM-DD-YYYY",
-      hasEveryoneOnTheInternet: false,
-      memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
-      securityProperties: {
-        allowClone: false,
-        allowExport: true,
-        enableAppTokens: true,
-        hideFromPublic: false,
-        mustBeRealmApproved: false,
-        useIPFilter: false,
-      },
-      ancestorId: undefined,
-      dataClassification: undefined,
-      variables: [{ name: "TestVar", value: "TestValue" }],
-    });
-  }
-);

package/tests/vitest/qb/apps/getAppEvents.test.ts

@@ -1,67 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getAppEvents > fetches real app events 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 appId = "buwai2zpe"; // Same app ID as getApp test
-
-    console.log("Config used:", config);
-    const result = await client.getAppEvents({ appId });
-    console.log("Real API response:", result);
-
-    // Validate the response is an array of events
-    expect(result).toBeInstanceOf(Array);
-
-    // Check that each event has the required properties
-    result.forEach((event) => {
-      expect(event).toHaveProperty("type");
-      expect([
-        "qb-action",
-        "webhook",
-        "email-notification",
-        "subscription",
-        "reminder",
-        "automation",
-      ]).toContain(event.type);
-
-      expect(event).toHaveProperty("owner");
-      expect(event.owner).toHaveProperty("email");
-      expect(typeof event.owner.email).toBe("string");
-      expect(event.owner).toHaveProperty("id");
-      expect(typeof event.owner.id).toBe("string");
-      expect(event.owner).toHaveProperty("name");
-      expect(typeof event.owner.name).toBe("string");
-      // userName is optional, so we don't enforce it
-
-      expect(event).toHaveProperty("isActive");
-      expect(typeof event.isActive).toBe("boolean");
-
-      expect(event).toHaveProperty("tableId");
-      expect(typeof event.tableId).toBe("string");
-
-      // Name is present for all types except automation
-      if (event.type !== "automation") {
-        expect(event).toHaveProperty("name");
-        expect(typeof event.name).toBe("string");
-      } else {
-        expect(event.name).toBeUndefined();
-      }
-
-      // URL is only present for automation
-      if (event.type === "automation") {
-        expect(event).toHaveProperty("url");
-        expect(typeof event.url).toBe("string");
-      } else {
-        expect(event.url).toBeUndefined();
-      }
-    });
-  }
-);

package/tests/vitest/qb/apps/updateApp.test.ts

@@ -1,58 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - updateApp > updates real app 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"; // Same app ID as before
-
-    // Original app data (to restore later if needed)
-    const originalApp = await client.getApp({ appId });
-    console.log("Original app data:", originalApp);
-
-    // Update request
-    const updateRequest = {
-      name: "qb-copy-updated",
-      description: "Updated via integration test",
-      variables: [{ name: "TestVar", value: "TestValue" }],
-    };
-
-    console.log("Config used:", config);
-    console.log("Update request:", updateRequest);
-    const result = await client.updateApp({ appId, body: updateRequest });
-    console.log("Real API response:", result);
-
-    // Validate the response
-    expect(result).toHaveProperty("id", appId);
-    expect(result).toHaveProperty("name", "qb-copy-updated");
-    expect(result).toHaveProperty(
-      "description",
-      "Updated via integration test"
-    );
-    expect(result).toHaveProperty("variables");
-    expect(result.variables).toContainEqual({
-      name: "TestVar",
-      value: "TestValue",
-    });
-    expect(result).toHaveProperty("created");
-    expect(result.created).toBeInstanceOf(Date);
-    expect(result).toHaveProperty("updated");
-    expect(result.updated).toBeInstanceOf(Date);
-
-    // Optional: Restore original name to avoid permanent changes
-    const restoreRequest = {
-      name: originalApp.name,
-      description: originalApp.description,
-      variables: originalApp.variables,
-    };
-    await client.updateApp({ appId, body: restoreRequest });
-    console.log("Restored app to:", originalApp.name);
-  }
-);

package/tests/vitest/qb/auth/mockQuickbaseServer.ts

@@ -1,60 +0,0 @@
-// tests/vitest/qb/auth/mockQuickbaseServer.ts
-import express from "express";
-
-export function startMockQuickbaseServer(port: number = 3000) {
-  const app = express();
-  app.use(express.json());
-  let failNextCall = false;
-
-  app.post("/v1/auth/oauth/token", (req, res) => {
-    const { subject_token } = req.body;
-    console.log("[Mock Server] Received SSO token request:", req.body);
-    if (!subject_token) {
-      return res.status(400).json({ message: "Missing SAML token" });
-    }
-    res.json({
-      access_token: "mock-temp-token",
-      token_type: "Bearer",
-    });
-  });
-
-  app.get("/v1/apps/:appId", (req, res) => {
-    const authHeader = req.headers.authorization;
-    console.log(
-      "[Mock Server] Received getApp request:",
-      req.params,
-      "Auth:",
-      authHeader
-    );
-    if (!authHeader || !authHeader.startsWith("QB-TEMP-TOKEN")) {
-      return res.status(401).json({ message: "Unauthorized" });
-    }
-    if (failNextCall) {
-      failNextCall = false;
-      return res.status(401).json({ message: "Token expired" });
-    }
-    res.json({
-      id: req.params.appId,
-      name: "Mock App",
-      created: "2025-03-19T12:00:00Z",
-      updated: "2025-03-19T12:00:00Z",
-    });
-  });
-
-  app.post("/mock/toggle-fail", (req, res) => {
-    failNextCall = true;
-    console.log("[Mock Server] Toggling next getApp call to fail with 401");
-    res.sendStatus(200);
-  });
-
-  const server = app.listen(port, () => {
-    console.log(`Mock QuickBase server running on port ${port}`);
-  });
-
-  return {
-    server,
-    close: () => server.close(),
-    toggleFail: () =>
-      fetch(`http://localhost:${port}/mock/toggle-fail`, { method: "POST" }),
-  };
-}