simple-playwright-framework 0.0.17 → 0.0.18

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { initAuthSession } from "./utils/auth-session/initAuthSession";
+export { initApiAuthSession } from "./utils/auth-session/initApiAuthSession";
 export { test, expect } from "./fixtures/index";
 export { scenarioLoader } from "./loaders/scenario.loader";
 export { loadConfig } from "./loaders/envConfig.loader";
@@ -7,4 +8,4 @@ export { envConfigFixture } from "./fixtures/envConfig.fixture";
 export { dataFixture } from "./fixtures/data.fixture";
 export { fileFixture } from "./fixtures/file.fixture";
 export { testrailFixture } from "./fixtures/testrail.fixture";
-export type { AuthProvider, AuthStorageConfig } from "./types/auth";
+export type { AuthProvider, ApiAuthProvider, AuthStorageConfig } from "./types/auth";

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testrailFixture = exports.fileFixture = exports.dataFixture = exports.envConfigFixture = exports.FileUtils = exports.loadConfig = exports.scenarioLoader = exports.expect = exports.test = exports.initAuthSession = void 0;
+exports.testrailFixture = exports.fileFixture = exports.dataFixture = exports.envConfigFixture = exports.FileUtils = exports.loadConfig = exports.scenarioLoader = exports.expect = exports.test = exports.initApiAuthSession = exports.initAuthSession = void 0;
 var initAuthSession_1 = require("./utils/auth-session/initAuthSession");
 Object.defineProperty(exports, "initAuthSession", { enumerable: true, get: function () { return initAuthSession_1.initAuthSession; } });
+var initApiAuthSession_1 = require("./utils/auth-session/initApiAuthSession");
+Object.defineProperty(exports, "initApiAuthSession", { enumerable: true, get: function () { return initApiAuthSession_1.initApiAuthSession; } });
 var index_1 = require("./fixtures/index");
 Object.defineProperty(exports, "test", { enumerable: true, get: function () { return index_1.test; } });
 Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return index_1.expect; } });

package/dist/types/auth.d.ts

@@ -2,6 +2,9 @@ import { Page } from "@playwright/test";
 export interface AuthProvider {
     login(page: Page): Promise<void>;
 }
+export interface ApiAuthProvider {
+    getToken(request: any): Promise<string>;
+}
 export interface AuthStorageConfig {
     enabled: boolean;
     validityMinutes: number;

package/dist/utils/auth-session/initApiAuthSession.d.ts

@@ -0,0 +1,20 @@
+import { ApiAuthProvider, AuthStorageConfig } from "../../types/auth";
+/**
+ * Manages API token authentication with optional token caching.
+ *
+ * Flow:
+ *   1. If storage disabled → call getToken() directly, no caching
+ *   2. If valid cached token exists → return it, skip login call
+ *   3. If no valid token → call getToken(), save to file, return token
+ *
+ * Storage format: { token: "...", savedAt: 1234567890 }
+ *
+ * @returns JWT token string ready to use in Authorization header
+ */
+export declare function initApiAuthSession(request: any, authStorage: AuthStorageConfig | undefined, creds: {
+    username: string;
+    password: string;
+}, providerRegistry: Record<string, new (creds: {
+    username: string;
+    password: string;
+}) => ApiAuthProvider>): Promise<string>;

package/dist/utils/auth-session/initApiAuthSession.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initApiAuthSession = initApiAuthSession;
+const fs_1 = __importDefault(require("fs"));
+const storagePath_1 = require("./storagePath");
+const validateStore_1 = require("./validateStore");
+const resolveProvider_1 = require("./resolveProvider");
+/**
+ * Manages API token authentication with optional token caching.
+ *
+ * Flow:
+ *   1. If storage disabled → call getToken() directly, no caching
+ *   2. If valid cached token exists → return it, skip login call
+ *   3. If no valid token → call getToken(), save to file, return token
+ *
+ * Storage format: { token: "...", savedAt: 1234567890 }
+ *
+ * @returns JWT token string ready to use in Authorization header
+ */
+async function initApiAuthSession(request, authStorage, creds, providerRegistry) {
+    const ProviderClass = (0, resolveProvider_1.resolveProvider)(authStorage?.provider ?? "default", providerRegistry);
+    const authProvider = new ProviderClass(creds);
+    // ── Storage disabled → get token directly ────────────────────
+    if (!authStorage?.enabled) {
+        console.log("[Framework] API auth storage disabled — performing direct login");
+        return authProvider.getToken(request);
+    }
+    const { validityMinutes, provider } = authStorage;
+    const envName = process.env.TEST_ENV || "default";
+    const storagePath = (0, storagePath_1.getStoragePath)(provider, envName, creds.username);
+    // ── Valid cached token exists → return it ────────────────────
+    if ((0, validateStore_1.isAuthStoreValid)(storagePath, validityMinutes)) {
+        const saved = JSON.parse(fs_1.default.readFileSync(storagePath, "utf-8"));
+        console.log(`[Framework] ✅ Using cached API token for: ${creds.username}`);
+        return saved.token;
+    }
+    // ── No valid token → fresh login + save ──────────────────────
+    console.log("[Framework] Performing fresh API login...");
+    const token = await authProvider.getToken(request);
+    fs_1.default.writeFileSync(storagePath, JSON.stringify({
+        token,
+        savedAt: Date.now(),
+    }, null, 2));
+    console.log(`[Framework] New API token cached: ${storagePath}`);
+    return token;
+}

package/dist/utils/auth-session/initAuthSession.d.ts

@@ -1,5 +1,15 @@
 import { Page } from "@playwright/test";
 import { AuthProvider, AuthStorageConfig } from "../../types/auth";
+/**
+ * Manages UI authentication with optional session storage.
+ *
+ * Flow:
+ *   1. If storage disabled → login directly, no caching
+ *   2. If valid stored session exists → restore it, skip login
+ *   3. If no valid session → perform fresh login, save session
+ *
+ * Supports both localStorage token apps (Nexus) and cookie-based apps.
+ */
 export declare function initAuthSession(page: Page, authStorage: AuthStorageConfig | undefined, creds: {
     username: string;
     password: string;

package/dist/utils/auth-session/initAuthSession.js

@@ -1,41 +1,62 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initAuthSession = initAuthSession;
+const fs_1 = __importDefault(require("fs"));
 const storagePath_1 = require("./storagePath");
 const validateStore_1 = require("./validateStore");
+const resolveProvider_1 = require("./resolveProvider");
+const restoreSession_1 = require("./restoreSession");
+/**
+ * Manages UI authentication with optional session storage.
+ *
+ * Flow:
+ *   1. If storage disabled → login directly, no caching
+ *   2. If valid stored session exists → restore it, skip login
+ *   3. If no valid session → perform fresh login, save session
+ *
+ * Supports both localStorage token apps (Nexus) and cookie-based apps.
+ */
 async function initAuthSession(page, authStorage, creds, providerRegistry) {
+    const ProviderClass = (0, resolveProvider_1.resolveProvider)(authStorage?.provider ?? "default", providerRegistry);
+    const authProvider = new ProviderClass(creds);
+    // ── Storage disabled → login directly ────────────────────────
     if (!authStorage?.enabled) {
-        console.log("[Framework] Auth storage disabled");
-        const ProviderClass = providerRegistry[authStorage?.provider ?? "OrangeHRMLogin"];
-        const authProvider = new ProviderClass(creds);
+        console.log("[Framework] Auth storage disabled — performing direct login");
         await authProvider.login(page);
         return;
     }
     const { validityMinutes, provider } = authStorage;
     const envName = process.env.TEST_ENV || "default";
     const storagePath = (0, storagePath_1.getStoragePath)(provider, envName, creds.username);
-    const ProviderClass = providerRegistry[provider];
-    if (!ProviderClass)
-        throw new Error(`[Framework] Unknown provider: ${provider}`);
-    const authProvider = new ProviderClass(creds);
-    let needsLogin = true;
+    // ── Valid session exists → restore it ────────────────────────
     if ((0, validateStore_1.isAuthStoreValid)(storagePath, validityMinutes)) {
-        console.log(`[Framework] Found valid auth store: ${storagePath}`);
-        const state = JSON.parse(require("fs").readFileSync(storagePath, "utf-8"));
-        await page.context().addCookies(state.cookies);
-        await page.reload();
-        if (!page.url().includes("/auth/login")) {
-            console.log(`[Framework] Reusing valid auth store`);
-            needsLogin = false;
-        }
-        else {
-            console.log("[Framework] Auth store rejected, will re-login...");
-        }
+        console.log(`[Framework] Restoring valid auth store: ${storagePath}`);
+        await (0, restoreSession_1.restoreSession)(page, storagePath);
+        console.log(`[Framework] ✅ Session restored from storage`);
+        return;
     }
-    if (needsLogin) {
-        console.log("[Framework] Performing fresh login...");
-        await authProvider.login(page);
+    // ── No valid session → fresh login + save ────────────────────
+    console.log("[Framework] Performing fresh login...");
+    await authProvider.login(page);
+    // Save token + user from localStorage if present (token-based apps)
+    const saved = await page.evaluate(() => ({
+        token: localStorage.getItem("token"),
+        user: localStorage.getItem("user"),
+    }));
+    if (saved.token) {
+        // Token-based app — save token + user
+        fs_1.default.writeFileSync(storagePath, JSON.stringify({
+            token: saved.token,
+            user: saved.user ? JSON.parse(saved.user) : null,
+            savedAt: Date.now(),
+        }, null, 2));
+    }
+    else {
+        // Cookie-based app — save full Playwright storageState
         await page.context().storageState({ path: storagePath });
-        console.log(`[Framework] New auth store created: ${storagePath}`);
     }
+    console.log(`[Framework] New auth store created: ${storagePath}`);
 }

package/dist/utils/auth-session/resolveProvider.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Looks up a provider class from the registry by name.
+ * Throws a clear error if the provider is not registered.
+ *
+ * Used by both initAuthSession (UI) and initApiAuthSession (API).
+ */
+export declare function resolveProvider<T>(providerName: string, providerRegistry: Record<string, new (creds: {
+    username: string;
+    password: string;
+}) => T>): new (creds: {
+    username: string;
+    password: string;
+}) => T;

package/dist/utils/auth-session/resolveProvider.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveProvider = resolveProvider;
+/**
+ * Looks up a provider class from the registry by name.
+ * Throws a clear error if the provider is not registered.
+ *
+ * Used by both initAuthSession (UI) and initApiAuthSession (API).
+ */
+function resolveProvider(providerName, providerRegistry) {
+    const ProviderClass = providerRegistry[providerName];
+    if (!ProviderClass) {
+        throw new Error(`[Framework] Unknown auth provider: "${providerName}"\n` +
+            `  Registered providers: ${Object.keys(providerRegistry).join(", ")}`);
+    }
+    return ProviderClass;
+}

package/dist/utils/auth-session/restoreSession.d.ts

@@ -0,0 +1,14 @@
+import { Page } from "@playwright/test";
+/**
+ * Restores a saved auth session into the browser page.
+ *
+ * Supports two formats:
+ *
+ * 1. localStorage token format: { token, user }
+ *    Injects token and user into localStorage via addInitScript
+ *    so they are available before the page loads.
+ *
+ * 2. Playwright storageState (cookies/origins):
+ *    Restores cookies via addCookies — for cookie-based apps.
+ */
+export declare function restoreSession(page: Page, storagePath: string): Promise<void>;

package/dist/utils/auth-session/restoreSession.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.restoreSession = restoreSession;
+const fs_1 = __importDefault(require("fs"));
+/**
+ * Restores a saved auth session into the browser page.
+ *
+ * Supports two formats:
+ *
+ * 1. localStorage token format: { token, user }
+ *    Injects token and user into localStorage via addInitScript
+ *    so they are available before the page loads.
+ *
+ * 2. Playwright storageState (cookies/origins):
+ *    Restores cookies via addCookies — for cookie-based apps.
+ */
+async function restoreSession(page, storagePath) {
+    const raw = fs_1.default.readFileSync(storagePath, "utf-8").trim();
+    const state = JSON.parse(raw);
+    // ── localStorage token format (Nexus and token-based apps) ───
+    if (state.token) {
+        await page.addInitScript((saved) => {
+            localStorage.setItem("token", saved.token);
+            if (saved.user)
+                localStorage.setItem("user", JSON.stringify(saved.user));
+        }, { token: state.token, user: state.user ?? null });
+        return;
+    }
+    // ── Playwright cookie-based storageState ─────────────────────
+    if (state.cookies?.length > 0) {
+        await page.context().addCookies(state.cookies);
+    }
+}

package/dist/utils/auth-session/storagePath.d.ts

@@ -1 +1,7 @@
+/**
+ * Builds the file path for storing auth state.
+ * Creates the storage directory if it doesn't exist.
+ *
+ * Format: storage/{provider}-{env}-{username}-auth.json
+ */
 export declare function getStoragePath(provider: string, envName: string, username: string): string;

package/dist/utils/auth-session/storagePath.js

@@ -6,6 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStoragePath = getStoragePath;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+/**
+ * Builds the file path for storing auth state.
+ * Creates the storage directory if it doesn't exist.
+ *
+ * Format: storage/{provider}-{env}-{username}-auth.json
+ */
 function getStoragePath(provider, envName, username) {
     const storageDir = path_1.default.resolve("storage");
     if (!fs_1.default.existsSync(storageDir))

package/dist/utils/auth-session/validateStore.d.ts

@@ -1 +1,14 @@
+/**
+ * Checks if a stored auth file is valid and not expired.
+ *
+ * Supports two storage formats:
+ *
+ * 1. UI / cookie-based (Playwright storageState):
+ *    { cookies: [...], origins: [...] }
+ *    Valid if cookies or origins are non-empty and file age < validityMinutes
+ *
+ * 2. API / token-based:
+ *    { token: "...", savedAt: 1234567890 }
+ *    Valid if token exists and (now - savedAt) < validityMinutes
+ */
 export declare function isAuthStoreValid(storagePath: string, validityMinutes: number): boolean;

package/dist/utils/auth-session/validateStore.js

@@ -5,6 +5,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAuthStoreValid = isAuthStoreValid;
 const fs_1 = __importDefault(require("fs"));
+/**
+ * Checks if a stored auth file is valid and not expired.
+ *
+ * Supports two storage formats:
+ *
+ * 1. UI / cookie-based (Playwright storageState):
+ *    { cookies: [...], origins: [...] }
+ *    Valid if cookies or origins are non-empty and file age < validityMinutes
+ *
+ * 2. API / token-based:
+ *    { token: "...", savedAt: 1234567890 }
+ *    Valid if token exists and (now - savedAt) < validityMinutes
+ */
 function isAuthStoreValid(storagePath, validityMinutes) {
     if (!fs_1.default.existsSync(storagePath))
         return false;
@@ -13,9 +26,19 @@ function isAuthStoreValid(storagePath, validityMinutes) {
         return false;
     try {
         const state = JSON.parse(raw);
-        const stats = fs_1.default.statSync(storagePath);
-        const ageMinutes = (Date.now() - stats.mtimeMs) / 60000;
-        return (state.cookies?.length > 0 || state.origins?.length > 0) && ageMinutes < validityMinutes;
+        // ── API token format ──────────────────────────────────────
+        if (state.token && state.savedAt) {
+            const ageMinutes = (Date.now() - state.savedAt) / 60000;
+            return ageMinutes < validityMinutes;
+        }
+        // ── UI / Playwright storageState format ───────────────────
+        if (state.cookies !== undefined || state.origins !== undefined) {
+            const hasContent = (state.cookies?.length > 0) || (state.origins?.length > 0);
+            const stats = fs_1.default.statSync(storagePath);
+            const ageMinutes = (Date.now() - stats.mtimeMs) / 60000;
+            return hasContent && ageMinutes < validityMinutes;
+        }
+        return false;
     }
     catch {
         return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-playwright-framework",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "A modular Playwright framework with fixtures, loaders, and demo scaffolding.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",