@seontechnologies/playwright-utils 3.10.0

package/dist/esm/auth-session/internal/auth-provider.d.ts

@@ -0,0 +1,92 @@
+/** Auth Provider Interface
+ * Defines the contract for authentication providers */
+import type { APIRequestContext } from '@playwright/test';
+import type { AuthOptions, AuthSessionOptions } from './types';
+/**
+ * Interface for auth provider implementations
+ *
+ * This allows for custom authentication logic to be plugged into the auth session system
+ * For example, you could implement an OAuth provider, a JWT provider, etc.
+ */
+export interface AuthProvider {
+    /**
+     * Get the current environment
+     * @param options Optional auth options that may override the provider's defaults
+     */
+    getEnvironment(options?: Partial<AuthOptions>): string;
+    /**
+     * Get the current user identifier
+     * @param options Optional auth options that may override the provider's defaults
+     */
+    getUserIdentifier(options?: Partial<AuthOptions>): string;
+    /**
+     * Extract the raw token from formatted token data
+     * This allows providers to access tokens from their specific formats
+     *
+     * @param tokenData The formatted token data
+     * @returns The raw token string or null if not extractable
+     */
+    extractToken(tokenData: Record<string, unknown>): string | null;
+    /**
+     * Extract cookies from formatted token data
+     * This allows providers to access cookies from their specific formats
+     *
+     * @param tokenData The formatted token data
+     * @returns Array of cookie objects ready for browser context
+     */
+    extractCookies(tokenData: Record<string, unknown>): Array<{
+        name: string;
+        value: string;
+        domain?: string;
+        path?: string;
+        expires?: number;
+        httpOnly?: boolean;
+        secure?: boolean;
+        sameSite?: 'Strict' | 'Lax' | 'None';
+    }>;
+    /**
+     * Check if a token is expired
+     * This allows providers to implement custom expiration logic
+     *
+     * @param rawToken The raw token string to check for expiration
+     * @returns True if the token is expired, false otherwise
+     */
+    isTokenExpired?(rawToken: string): boolean;
+    /**
+     * Manage authentication token lifecycle
+     * This handles checking storage, acquiring tokens when needed, and saving tokens
+     *
+     * @param request The Playwright API request context
+     * @param options Optional auth options that may override the provider's defaults
+     * @returns A storage state object compatible with Playwright's context APIs
+     */
+    manageAuthToken(request: APIRequestContext, options?: Partial<AuthOptions>): Promise<Record<string, unknown>>;
+    /**
+     * Clear the authentication token
+     * @param options Optional auth options that may override the provider's defaults
+     */
+    clearToken(options?: Partial<AuthOptions>): void;
+    /**
+     * Get the base URL for the current environment/configuration
+     * This allows providers to implement custom baseUrl resolution logic
+     *
+     * @param options Optional auth options that may override the provider's defaults
+     * @returns The base URL string or undefined if not available
+     */
+    getBaseUrl?(options?: Partial<AuthOptions>): string | undefined;
+}
+/**
+ * Set the auth provider to use for all auth session operations
+ * This is the recommended way to configure authentication
+ * Users MUST implement their own provider and set it here
+ *
+ * @param provider The auth provider to use
+ */
+export declare function setAuthProvider(provider: AuthProvider): void;
+/**
+ * Get the configured auth provider
+ * Returns the global provider if set, otherwise throws an error
+ */
+export declare function getAuthProvider(): AuthProvider;
+export declare function getGlobalAuthOptions(): AuthSessionOptions | null;
+//# sourceMappingURL=auth-provider.d.ts.map

package/dist/esm/auth-session/internal/auth-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-provider.d.ts","sourceRoot":"","sources":["../../../../src/auth-session/internal/auth-provider.ts"],"names":[],"mappings":"AAAA;uDACuD;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE9D;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAA;IAEtD;;;OAGG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAA;IAEzD;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;IAE/D;;;;;;OAMG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;QACxD,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;KACrC,CAAC,CAAA;IAEF;;;;;;OAMG;IACH,cAAc,CAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;IAE1C;;;;;;;OAOG;IACH,eAAe,CACb,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAC7B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAEnC;;;OAGG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;IAEhD;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,GAAG,SAAS,CAAA;CAChE;AAKD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI,CAE5D;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAQ9C;AAGD,wBAAgB,oBAAoB,IAAI,kBAAkB,GAAG,IAAI,CAQhE"}

package/dist/esm/auth-session/internal/auth-provider.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setAuthProvider = setAuthProvider;
+exports.getAuthProvider = getAuthProvider;
+exports.getGlobalAuthOptions = getGlobalAuthOptions;
+// Global provider instance that can be configured
+let globalAuthProvider = null;
+/**
+ * Set the auth provider to use for all auth session operations
+ * This is the recommended way to configure authentication
+ * Users MUST implement their own provider and set it here
+ *
+ * @param provider The auth provider to use
+ */
+function setAuthProvider(provider) {
+    globalAuthProvider = provider;
+}
+/**
+ * Get the configured auth provider
+ * Returns the global provider if set, otherwise throws an error
+ */
+function getAuthProvider() {
+    if (!globalAuthProvider) {
+        throw new Error('No auth provider configured. You must call setAuthProvider() with a custom provider implementation ' +
+            'before using any auth session functionality. See the documentation for examples.');
+    }
+    return globalAuthProvider;
+}
+// Import this dynamically to avoid circular dependency
+function getGlobalAuthOptions() {
+    try {
+        const { getGlobalAuthOptions } = require('./auth-configure');
+        return getGlobalAuthOptions();
+    }
+    catch {
+        // In case of circular dependency or missing module, return null
+        return null;
+    }
+}
+//# sourceMappingURL=auth-provider.js.map

package/dist/esm/auth-session/internal/auth-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-provider.js","sourceRoot":"","sources":["../../../../src/auth-session/internal/auth-provider.ts"],"names":[],"mappings":";;AAmGA,0CAEC;AAMD,0CAQC;AAGD,oDAQC;AArCD,kDAAkD;AAClD,IAAI,kBAAkB,GAAwB,IAAI,CAAA;AAElD;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,QAAsB;IACpD,kBAAkB,GAAG,QAAQ,CAAA;AAC/B,CAAC;AAED;;;GAGG;AACH,SAAgB,eAAe;IAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CACb,qGAAqG;YACnG,kFAAkF,CACrF,CAAA;IACH,CAAC;IACD,OAAO,kBAAkB,CAAA;AAC3B,CAAC;AAED,uDAAuD;AACvD,SAAgB,oBAAoB;IAClC,IAAI,CAAC;QACH,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;QAC5D,OAAO,oBAAoB,EAAE,CAAA;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,gEAAgE;QAChE,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC"}

package/dist/esm/auth-session/internal/auth-session.d.ts

@@ -0,0 +1,76 @@
+/** Authentication session manager for use with playwright
+ * @internal This file contains implementation details that should not be directly imported
+ * Use the public API exported from index.ts instead */
+import type { APIRequestContext } from '@playwright/test';
+import type { AuthSessionOptions, DefaultTokenDataFormatter } from './types';
+/**
+ * Default token formatter for the standard Playwright storage state format
+ * This creates a properly formatted storage state with the raw token value
+ */
+export declare const defaultTokenFormatter: DefaultTokenDataFormatter;
+export declare class AuthSessionManager {
+    private static instances;
+    private readonly storageDir;
+    private readonly storageFile;
+    private readonly options;
+    private hasToken;
+    private token;
+    private constructor();
+    /**
+     * Save token to storage and update cache
+     * @param token The token to save - can be either a string or an object
+     */
+    saveToken(token: string | Record<string, unknown>): Promise<void>;
+    static getInstance(options?: AuthSessionOptions): AuthSessionManager;
+    /** Load token from storage if it exists */
+    private loadTokenFromStorage;
+    /** Cache a token in memory using advanced cache manager */
+    private cacheToken;
+    /** Save token to storage with retry logic and exponential backoff */
+    private saveTokenToStorageWithRetry;
+    /** Save token to storage with file locking to prevent concurrent access issues */
+    private saveTokenToStorage;
+    /**
+     * Clear the token from storage
+     * @returns Boolean indicating whether a token was successfully cleared
+     */
+    clearToken(): boolean;
+    /**
+     * Get a new token using the AuthProvider
+     *
+     * @param request The Playwright API request context
+     * @returns A promise that resolves to the authentication token string
+     */
+    private getTokenFromProvider;
+    /**
+     * Check if a token is expired
+     * Uses the in-memory cache first, then falls back to storage
+     * Avoids unnecessary file I/O operations
+     */
+    private isTokenExpired;
+    /**
+     * Check token expiration using the advanced cache manager
+     */
+    private checkTokenCacheExpiration;
+    /**
+     * Check token expiration using the auth provider
+     */
+    private checkProviderTokenExpiration;
+    /**
+     * Check token expiration by reading from storage
+     */
+    private checkStorageTokenExpiration;
+    /**
+     * Refresh the token if it's expired
+     * @param request The Playwright API request context
+     * @returns A promise that resolves to the refreshed token
+     */
+    private refreshTokenIfNeeded;
+    /**
+     * Manage the complete authentication token lifecycle
+     * Handles checking existing tokens, fetching new ones if needed, and persistence
+     * Uses advanced caching for better performance
+     */
+    manageAuthToken(request: APIRequestContext): Promise<string>;
+}
+//# sourceMappingURL=auth-session.d.ts.map

package/dist/esm/auth-session/internal/auth-session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-session.d.ts","sourceRoot":"","sources":["../../../../src/auth-session/internal/auth-session.ts"],"names":[],"mappings":"AAAA;;uDAEuD;AAEvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAQzD,OAAO,KAAK,EACV,kBAAkB,EAElB,yBAAyB,EAE1B,MAAM,SAAS,CAAA;AAkJhB;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,yBAgDnC,CAAA;AAmBD,qBAAa,kBAAkB;IAE7B,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6C;IACrE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,KAAK,CAAsB;IAEnC,OAAO;IAwDP;;;OAGG;IACU,SAAS,CACpB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACtC,OAAO,CAAC,IAAI,CAAC;WAgBF,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,kBAAkB;IAkC3E,2CAA2C;IAC3C,OAAO,CAAC,oBAAoB;IAoE5B,2DAA2D;IAC3D,OAAO,CAAC,UAAU;IAmBlB,qEAAqE;YACvD,2BAA2B;IAUzC,kFAAkF;IAClF,OAAO,CAAC,kBAAkB;IAgE1B;;;OAGG;IACI,UAAU,IAAI,OAAO;IAoD5B;;;;;OAKG;YACW,oBAAoB;IAuClC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAoBtB;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAajC;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAsBpC;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAyCnC;;;;OAIG;YACW,oBAAoB;IAqBlC;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;CAoC1E"}