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

package/src/tokenCache.ts

@@ -1,39 +0,0 @@
-// src/tokenCache.ts
-interface CachedToken {
-  token: string;
-  expiresAt: number;
-}
-
-export class TokenCache {
-  private cache: Map<string, CachedToken>;
-  private readonly tempTokenLifespan: number;
-
-  constructor(tempTokenLifespan: number = 4 * 60 * 1000 + 50 * 1000) {
-    this.cache = new Map<string, CachedToken>();
-    this.tempTokenLifespan = tempTokenLifespan;
-  }
-
-  get(dbid: string): string | undefined {
-    const entry = this.cache.get(dbid);
-    const now = Date.now();
-    if (entry && entry.expiresAt > now) return entry.token;
-    if (entry) this.cache.delete(dbid); // Clean up expired temp tokens
-    return undefined;
-  }
-
-  set(dbid: string, token: string, lifespan?: number): void {
-    const now = Date.now();
-    this.cache.set(dbid, {
-      token,
-      expiresAt: now + (lifespan || this.tempTokenLifespan),
-    });
-  }
-
-  delete(dbid: string): void {
-    this.cache.delete(dbid);
-  }
-
-  clear(): void {
-    this.cache.clear();
-  }
-}

package/src/utils.ts

@@ -1,50 +0,0 @@
-// src/utils.ts
-
-export function simplifyName(methodName: string): string {
-  // Assuming this removes 'Raw' or similar suffixes as per your original logic
-  return methodName
-    .replace(/Raw$/, "")
-    .replace(/^./, (str) => str.toLowerCase());
-}
-
-export function getParamNames(func: Function): string[] {
-  // Your existing logic to extract parameter names from a function
-  const STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/gm;
-  const ARGUMENT_NAMES = /([^\s,]+)/g;
-  const fnStr = func.toString().replace(STRIP_COMMENTS, "");
-  const result = fnStr
-    .slice(fnStr.indexOf("(") + 1, fnStr.indexOf(")"))
-    .match(ARGUMENT_NAMES);
-  return result || [];
-}
-
-export function transformDates(obj: any, convertStringsToDates: boolean): any {
-  // Your existing logic to transform dates
-  if (!obj || typeof obj !== "object") return obj;
-  if (Array.isArray(obj))
-    return obj.map((item) => transformDates(item, convertStringsToDates));
-  const result: any = {};
-  for (const [key, value] of Object.entries(obj)) {
-    if (
-      typeof value === "string" &&
-      convertStringsToDates &&
-      /^\d{4}-\d{2}-\d{2}/.test(value)
-    ) {
-      result[key] = new Date(value);
-    } else if (value instanceof Date) {
-      result[key] = value;
-    } else if (typeof value === "object") {
-      result[key] = transformDates(value, convertStringsToDates);
-    } else {
-      result[key] = value;
-    }
-  }
-  return result;
-}
-
-export function extractHttpMethod(method: Function): string {
-  const source = method.toString();
-  // Match the `method: 'SOME_METHOD'` part of the `request` call
-  const match = source.match(/method:\s*['"](\w+)['"]/i);
-  return match ? match[1].toUpperCase() : "GET"; // Fallback to GET if no match
-}

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

@@ -1,159 +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
-): Promise<boolean> => {
-  console.log("Logging in to QuickBase");
-  let loginSuccess = false;
-  const maxLoginAttempts = 3;
-  let loginAttempt = 0;
-
-  while (!loginSuccess && loginAttempt < maxLoginAttempts) {
-    try {
-      loginAttempt++;
-      if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
-
-      console.log("Navigating to login page");
-      await page.goto(quickbaseUrl, { timeout: 30000 });
-      console.log("Waiting for loginid selector");
-      await page.waitForSelector("input[name='loginid']", { timeout: 30000 });
-      await page.fill("input[name='loginid']", username);
-      await page.fill("input[name='password']", password);
-      console.log("Clicking signin");
-      await page.click("#signin");
-      console.log("Waiting for navigation");
-      await page.waitForURL(`https://*.quickbase.com/**`, {
-        waitUntil: "networkidle",
-        timeout: 30000,
-      });
-
-      const loginError = await page.$(".login-error");
-      if (loginError) {
-        throw new Error("Login failed. Please check your credentials.");
-      }
-
-      console.log("Signed In to QuickBase.");
-      loginSuccess = true;
-    } catch (error) {
-      console.error(
-        `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
-      );
-      if (loginAttempt >= maxLoginAttempts) {
-        console.error("Max login attempts reached. Exiting.");
-        await page.context().browser()!.close();
-        return false;
-      }
-      await new Promise((resolve) => setTimeout(resolve, 5000));
-    }
-  }
-  return loginSuccess;
-};
-
-test.describe("QuickbaseClient Integration - Cache Switching with Temp Tokens", () => {
-  test("caches and switches tokens for different DBIDs with getApp → getFields → getApp sequence", async ({
-    page,
-  }) => {
-    console.log("Starting cacheSwitching test");
-    const realm = process.env.QB_REALM ?? "";
-    const appId = process.env.QB_APP_ID ?? "";
-    const tableId = process.env.QB_TABLE_ID_1 ?? "";
-    const username = process.env.QB_USERNAME ?? "";
-    const password = process.env.QB_PASSWORD ?? "";
-
-    if (!realm || !appId || !tableId || !username || !password) {
-      throw new Error(
-        "Required QuickBase environment variables are not defined"
-      );
-    }
-
-    const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
-    const loginSuccess = await loginToQuickbase(
-      page,
-      quickbaseUrl,
-      username,
-      password
-    );
-    if (!loginSuccess) {
-      throw new Error("Failed to log in to QuickBase after max attempts.");
-    }
-
-    await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
-      waitUntil: "networkidle",
-      timeout: 30000,
-    });
-    console.log("Post-login URL after app navigation:", page.url());
-
-    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;
-
-    const appResult1 = await client.getApp({ appId });
-    console.log("First getApp response:", appResult1);
-    expect(appResult1).toHaveProperty("id", appId);
-
-    const fieldsResult = await client.getFields({ tableId });
-    console.log("getFields response:", fieldsResult);
-    expect(fieldsResult.length).toBeGreaterThan(0);
-
-    const appResult2 = await client.getApp({ appId });
-    console.log("Second getApp response:", appResult2);
-    expect(appResult2).toHaveProperty("id", appId);
-  });
-});

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

@@ -1,219 +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
-): Promise<boolean> => {
-  console.log("Logging in to QuickBase");
-  let loginSuccess = false;
-  const maxLoginAttempts = 3;
-  let loginAttempt = 0;
-
-  while (!loginSuccess && loginAttempt < maxLoginAttempts) {
-    try {
-      loginAttempt++;
-      if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
-
-      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,
-      });
-
-      const loginError = await page.$(".login-error");
-      if (loginError) {
-        throw new Error("Login failed. Please check your credentials.");
-      }
-
-      console.log("Signed In to QuickBase.");
-      loginSuccess = true;
-    } catch (error) {
-      console.error(
-        `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
-      );
-      if (loginAttempt >= maxLoginAttempts) {
-        console.error("Max login attempts reached. Exiting.");
-        await page.context().browser()!.close();
-        return false;
-      }
-      await new Promise((resolve) => setTimeout(resolve, 5000));
-    }
-  }
-  return loginSuccess;
-};
-
-test.describe("QuickbaseClient Integration - Token Invalidation with Cached Token", () => {
-  test("retries with new token when cached token is unexpectedly invalidated", async ({
-    page,
-  }) => {
-    // Type-safe environment variables
-    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"
-      );
-    }
-
-    // Login to QuickBase
-    const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
-    const loginSuccess = await loginToQuickbase(
-      page,
-      quickbaseUrl,
-      username,
-      password
-    );
-    if (!loginSuccess) {
-      throw new Error("Failed to log in to QuickBase after max attempts.");
-    }
-
-    // Navigate to the app page to ensure session context
-    await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
-      waitUntil: "networkidle",
-      timeout: 60000,
-    });
-    console.log("Post-login URL after app navigation:", page.url());
-
-    // Track tokens and call counts
-    let callCount = 0;
-    let getAppCallCount = 0;
-    let initialToken: string | null = null;
-    let retryToken: string | null = null;
-    const fetchInits: { url: string; init: RequestInit }[] = [];
-
-    const client = quickbase({
-      realm,
-      useTempTokens: true,
-      debug: true,
-      fetchApi: async (input: RequestInfo | URL, init?: RequestInit) => {
-        const url = input.toString();
-        callCount++;
-        console.log(`fetchApi called for ${url}, callCount: ${callCount}`);
-
-        const effectiveInit = init || {};
-        fetchInits.push({ url, init: effectiveInit });
-
-        const response = await page.evaluate(
-          async ([fetchUrl, fetchInit]: [string, RequestInit]) => {
-            const res = await fetch(fetchUrl, fetchInit);
-            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]
-        );
-
-        // Simulate 401 for the first getApp call
-        if (url.includes(`/apps/${appId}`)) {
-          getAppCallCount++;
-          console.log(`getApp call count: ${getAppCallCount}`);
-          if (getAppCallCount === 1) {
-            console.log("Simulating 401 Unauthorized for first getApp call");
-            return new Response(JSON.stringify({ message: "Unauthorized" }), {
-              status: 401,
-              statusText: "Unauthorized",
-              headers: { "Content-Type": "application/json" },
-            });
-          }
-        }
-
-        const fetchResponse = new Response(response.body || null, {
-          status: response.status,
-          statusText: response.statusText,
-          headers: new Headers(response.headers),
-        });
-
-        // Override json() to parse the body correctly
-        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}`);
-          }
-        };
-
-        // Capture tokens for validation
-        if (url.includes("/auth/temporary/")) {
-          try {
-            const json = await fetchResponse.clone().json();
-            const token = json.temporaryAuthorization;
-            if (!initialToken) {
-              initialToken = token;
-              console.log(`Captured initial token: ${initialToken}`);
-            } else if (!retryToken) {
-              retryToken = token;
-              console.log(`Captured retry token: ${retryToken}`);
-            }
-          } catch (error) {
-            console.error("Failed to parse token response:", error);
-          }
-        }
-
-        console.log(`Raw response from ${url}:`, {
-          status: response.status,
-          statusText: response.statusText,
-          body: response.body,
-        });
-
-        return fetchResponse;
-      },
-    }) as QuickbaseClient;
-
-    // Pre-fetch token to simulate cached token
-    console.log("Pre-fetching initial token...");
-    const preFetchResult = await client.getTempTokenDBID({ dbid: appId });
-    console.log("Initial token pre-fetched and cached:", preFetchResult);
-
-    // Call getApp, expecting a 401 followed by a retry with a new token
-    const appPromise = client.getApp({ appId });
-    await page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
-      timeout: 30000,
-    });
-    const appResult = await appPromise;
-    console.log("App response after token invalidation and retry:", appResult);
-
-    // Validate the app response
-    expect(appResult).toHaveProperty("id", appId);
-    expect(appResult).toHaveProperty("name");
-
-    // Verify call counts and token behavior
-    console.log(
-      `Final callCount: ${callCount}, Final getAppCallCount: ${getAppCallCount}`
-    );
-    expect(callCount).toBe(4); // Pre-fetch, 401, token retry, getApp success
-    expect(getAppCallCount).toBe(2); // Initial 401, retry success
-
-    // Validate pre-fetch and retry tokens
-    console.log(`Initial token: ${initialToken}`);
-    console.log(`Retry token: ${retryToken}`);
-    expect(initialToken).toBeDefined();
-    expect(initialToken).toBe(preFetchResult.temporaryAuthorization); // Confirm pre-fetch token was used
-    expect(retryToken).toBeDefined();
-    expect(initialToken).not.toBe(retryToken); // Confirm retry used a new token
-  });
-});

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

@@ -1,162 +0,0 @@
-// tests/playwright/qb/auth/getAppWithTempToken.test.ts
-import { test, expect } from "@playwright/test";
-import { quickbase } from "../../../../src/quickbaseClient.ts"; // Keep .ts for now
-import dotenv from "dotenv";
-
-dotenv.config();
-
-const loginToQuickbase = async (
-  page: import("@playwright/test").Page,
-  quickbaseUrl: string,
-  username: string,
-  password: string
-): Promise<boolean> => {
-  let loginSuccess = false;
-  const maxLoginAttempts = 3;
-  let loginAttempt = 0;
-
-  while (!loginSuccess && loginAttempt < maxLoginAttempts) {
-    try {
-      loginAttempt++;
-      if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
-
-      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,
-      });
-
-      const loginError = await page.$(".login-error");
-      if (loginError) {
-        throw new Error("Login failed. Please check your credentials.");
-      }
-
-      console.log("Signed In to QuickBase.");
-      loginSuccess = true;
-    } catch (error) {
-      console.error(
-        `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
-      );
-      if (loginAttempt >= maxLoginAttempts) {
-        console.error("Max login attempts reached. Exiting.");
-        await page.context().browser()!.close();
-        return false;
-      }
-      await new Promise((resolve) => setTimeout(resolve, 5000));
-    }
-  }
-  return loginSuccess;
-};
-
-test.describe("QuickbaseClient Integration - getApp with Temporary Token", () => {
-  test("uses temporary token with correct credentials settings in browser", 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) throw new Error("QB_REALM is not defined in .env");
-    if (!appId) throw new Error("QB_APP_ID is not defined in .env");
-    if (!username) throw new Error("QB_USERNAME is not defined in .env");
-    if (!password) throw new Error("QB_PASSWORD is not defined in .env");
-
-    const fetchInits: { url: string; init: RequestInit }[] = [];
-
-    const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
-    const loginSuccess = await loginToQuickbase(
-      page,
-      quickbaseUrl,
-      username,
-      password
-    );
-    if (!loginSuccess) {
-      throw new Error("Failed to log in to QuickBase after max attempts.");
-    }
-
-    await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
-      waitUntil: "networkidle",
-      timeout: 60000,
-    });
-
-    const client = quickbase({
-      realm,
-      useTempTokens: true,
-      fetchApi: async (url: RequestInfo | URL, init?: RequestInit) => {
-        // Use optional init and provide default empty object if undefined
-        const effectiveInit = init || {};
-        fetchInits.push({ url: String(url), init: effectiveInit });
-        const response = await page.evaluate(
-          async (args: [string, RequestInit]) => {
-            const [fetchUrl, fetchInit] = args;
-            const res = await fetch(fetchUrl, fetchInit);
-            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,
-            };
-          },
-          [String(url), effectiveInit] as [string, RequestInit]
-        );
-
-        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;
-      },
-    });
-
-    const appPromise = client.getApp({ appId });
-    await page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
-      timeout: 30000,
-    });
-    const appResult = await appPromise;
-
-    expect(appResult).toHaveProperty("id", appId);
-    expect(appResult).toHaveProperty("name");
-
-    const tokenFetchInit = fetchInits.find((entry) =>
-      entry.url.includes(`/auth/temporary/${appId}`)
-    );
-    expect(
-      tokenFetchInit,
-      "No fetch init captured for token request"
-    ).toBeDefined();
-    expect(tokenFetchInit!.init.credentials).toBe("include");
-
-    const appFetchInit = fetchInits.find((entry) =>
-      entry.url.includes(`/apps/${appId}`)
-    );
-    expect(
-      appFetchInit,
-      "No fetch init captured for getApp request"
-    ).toBeDefined();
-    expect(appFetchInit!.init.credentials).toBe("omit");
-  });
-});