@egain/ai-agent-sdk 0.1.0

package/dist/core/auth/PreAuthStrategy.d.ts

@@ -0,0 +1,101 @@
+import { AuthStrategy, AuthStrategyInitializeOptions } from './AuthStrategy.js';
+/**
+ * Callback type for token expiring notification
+ */
+export type TokenExpiringCallback = (expiresAt: number) => void;
+/**
+ * Configuration for pre-auth authentication strategy
+ */
+export interface PreAuthConfig {
+    /**
+     * Access token to use directly
+     */
+    accessToken: string;
+    /**
+     * Optional token refresh function
+     * If provided, will be called when token needs to be refreshed
+     */
+    refreshTokenFn?: () => Promise<string>;
+    /**
+     * Buffer time in milliseconds before token expiry to trigger the expiring event
+     * @default 180000 (3 minutes)
+     */
+    expiryBufferMs?: number;
+}
+/**
+ * Pre-auth authentication strategy
+ * Uses a pre-obtained access token without completing authentication flow
+ */
+export declare class PreAuthStrategy implements AuthStrategy {
+    private readonly config;
+    private currentToken;
+    private postAuthentication?;
+    private isAuthenticatedFlag;
+    private deploymentInfo?;
+    private expiryTimer?;
+    private tokenExpiringCallback?;
+    private expiryBufferMs;
+    constructor(config: PreAuthConfig);
+    /**
+     * Decode a JWT token and extract the payload
+     * Does not verify the signature - only extracts the claims
+     * @param token - The JWT token string
+     * @returns The decoded payload or null if decoding fails
+     */
+    private decodeJwt;
+    /**
+     * Get the expiration time from the token
+     * @param token - The JWT token string
+     * @returns Expiration timestamp in milliseconds, or null if not available
+     */
+    private getTokenExpiry;
+    /**
+     * Schedule the token expiring event
+     * Fires at (expiry - buffer) time
+     * @param token - The JWT token to schedule expiry for
+     */
+    private scheduleExpiryEvent;
+    /**
+     * Cancel the expiry timer
+     */
+    private cancelExpiryTimer;
+    /**
+     * Set the callback to be called when token is about to expire
+     * @param callback - Function to call when token is expiring
+     */
+    setTokenExpiringCallback(callback: TokenExpiringCallback): void;
+    /**
+     * Initialize the pre-auth authentication strategy
+     * Ensures the token is available and ready to use
+     */
+    initialize(options?: AuthStrategyInitializeOptions): Promise<void>;
+    /**
+     * Authenticate using pre-auth token
+     */
+    authenticate(): Promise<void>;
+    /**
+     * Check if the user is currently authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Get the access token
+     * If refresh function is provided and token is expired, attempts to refresh
+     */
+    getToken(): Promise<string>;
+    /**
+     * Update the access token
+     * Cancels existing expiry timer and schedules new one based on new token
+     * If authenticated, calls postAuthentication callback with the new token
+     * @param token - The new access token
+     */
+    updateToken(token: string): Promise<void>;
+    /**
+     * Refresh the token using the provided refresh function
+     */
+    refreshToken(): Promise<string>;
+    /**
+     * Cleanup resources
+     */
+    cleanup(): Promise<void>;
+}
+//# sourceMappingURL=PreAuthStrategy.d.ts.map

package/dist/core/auth/PreAuthStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreAuthStrategy.d.ts","sourceRoot":"","sources":["../../../src/core/auth/PreAuthStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAA8B,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAE5G;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;AAOhE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAWD;;;GAGG;AACH,qBAAa,eAAgB,YAAW,YAAY;IAStC,OAAO,CAAC,QAAQ,CAAC,MAAM;IARnC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,kBAAkB,CAAC,CAA6B;IACxD,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAM;IAC7B,OAAO,CAAC,WAAW,CAAC,CAAgC;IACpD,OAAO,CAAC,qBAAqB,CAAC,CAAwB;IACtD,OAAO,CAAC,cAAc,CAAS;gBAEF,MAAM,EAAE,aAAa;IAKlD;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAgCjB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAStB;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IA6B3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAOzB;;;OAGG;IACH,wBAAwB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI;IAQ/D;;;OAGG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCxE;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBnC;;OAEG;IACH,eAAe,IAAI,OAAO;IAI1B;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAW/C;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAQrC;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAG/B"}

package/dist/core/auth/PreAuthStrategy.js

@@ -0,0 +1,216 @@
+/**
+ * Buffer time before token expiry to trigger the expiring event (3 minutes in ms)
+ */
+const TOKEN_EXPIRY_BUFFER_MS = 3 * 60 * 1000;
+/**
+ * Pre-auth authentication strategy
+ * Uses a pre-obtained access token without completing authentication flow
+ */
+export class PreAuthStrategy {
+    constructor(config) {
+        this.config = config;
+        this.isAuthenticatedFlag = false;
+        this.currentToken = config.accessToken;
+        this.expiryBufferMs = config.expiryBufferMs ?? TOKEN_EXPIRY_BUFFER_MS;
+    }
+    /**
+     * Decode a JWT token and extract the payload
+     * Does not verify the signature - only extracts the claims
+     * @param token - The JWT token string
+     * @returns The decoded payload or null if decoding fails
+     */
+    decodeJwt(token) {
+        try {
+            // JWT format: header.payload.signature
+            const parts = token.split('.');
+            if (parts.length !== 3) {
+                return null;
+            }
+            // Decode the payload (second part)
+            const payload = parts[1];
+            // Handle URL-safe base64 encoding
+            const base64 = payload.replace(/-/g, '+').replace(/_/g, '/');
+            // Decode base64 - works in both browser and Node.js
+            let decoded;
+            if (typeof atob === 'function') {
+                // Browser environment
+                decoded = atob(base64);
+            }
+            else if (typeof Buffer !== 'undefined') {
+                // Node.js environment
+                decoded = Buffer.from(base64, 'base64').toString('utf-8');
+            }
+            else {
+                return null;
+            }
+            return JSON.parse(decoded);
+        }
+        catch {
+            // Token is not a valid JWT or decoding failed
+            return null;
+        }
+    }
+    /**
+     * Get the expiration time from the token
+     * @param token - The JWT token string
+     * @returns Expiration timestamp in milliseconds, or null if not available
+     */
+    getTokenExpiry(token) {
+        const payload = this.decodeJwt(token);
+        if (payload?.exp) {
+            // JWT exp is in seconds, convert to milliseconds
+            return payload.exp * 1000;
+        }
+        return null;
+    }
+    /**
+     * Schedule the token expiring event
+     * Fires at (expiry - buffer) time
+     * @param token - The JWT token to schedule expiry for
+     */
+    scheduleExpiryEvent(token) {
+        // Cancel any existing timer
+        this.cancelExpiryTimer();
+        const expiresAt = this.getTokenExpiry(token);
+        if (!expiresAt) {
+            // Token doesn't have expiry info, can't schedule
+            return;
+        }
+        const now = Date.now();
+        const timeUntilExpiry = expiresAt - now - this.expiryBufferMs;
+        if (timeUntilExpiry <= 0) {
+            // Token is already expired or within buffer, fire immediately
+            if (this.tokenExpiringCallback) {
+                this.tokenExpiringCallback(expiresAt);
+            }
+            return;
+        }
+        // Schedule the expiry event
+        this.expiryTimer = setTimeout(() => {
+            if (this.tokenExpiringCallback) {
+                this.tokenExpiringCallback(expiresAt);
+            }
+        }, timeUntilExpiry);
+    }
+    /**
+     * Cancel the expiry timer
+     */
+    cancelExpiryTimer() {
+        if (this.expiryTimer) {
+            clearTimeout(this.expiryTimer);
+            this.expiryTimer = undefined;
+        }
+    }
+    /**
+     * Set the callback to be called when token is about to expire
+     * @param callback - Function to call when token is expiring
+     */
+    setTokenExpiringCallback(callback) {
+        this.tokenExpiringCallback = callback;
+        // If already authenticated, schedule the expiry event with current token
+        if (this.isAuthenticatedFlag && this.currentToken) {
+            this.scheduleExpiryEvent(this.currentToken);
+        }
+    }
+    /**
+     * Initialize the pre-auth authentication strategy
+     * Ensures the token is available and ready to use
+     */
+    async initialize(options) {
+        console.debug('[PreAuthStrategy] initialize() called', {
+            hasPostAuthentication: !!options?.postAuthentication,
+            hasDeploymentInfo: !!options?.deploymentInfo
+        });
+        // Update postAuthentication callback even if already initialized
+        // This allows setting the callback after early initialization (e.g., for fetching agent details)
+        if (options?.postAuthentication) {
+            this.postAuthentication = options.postAuthentication;
+            console.debug('[PreAuthStrategy] postAuthentication callback SET');
+        }
+        if (options?.deploymentInfo) {
+            this.deploymentInfo = options.deploymentInfo;
+        }
+        // Ensure token is available and valid
+        // The token is set in constructor, but we verify it's still available here
+        if (!this.currentToken) {
+            throw new Error('PreAuthStrategy: Access token is required but not available');
+        }
+        // If we have a token and it's a JWT, we can validate its structure (but not signature)
+        // This ensures the token is properly formatted
+        const token = this.currentToken;
+        if (token.split('.').length === 3) {
+            // It's a JWT - validate basic structure
+            try {
+                this.decodeJwt(token);
+            }
+            catch (error) {
+                // Token structure is invalid, but we'll still allow it to proceed
+                // The actual validation happens when the token is used
+            }
+        }
+    }
+    /**
+     * Authenticate using pre-auth token
+     */
+    async authenticate() {
+        console.debug('[PreAuthStrategy] authenticate() called, postAuthentication callback:', this.postAuthentication ? 'SET' : 'NOT SET');
+        const token = await this.getToken();
+        this.isAuthenticatedFlag = true;
+        // Schedule expiry event for the current token
+        this.scheduleExpiryEvent(token);
+        // Call postAuthentication callback after authentication completes
+        if (this.postAuthentication) {
+            console.debug('[PreAuthStrategy] Calling postAuthentication callback');
+            await this.postAuthentication(token);
+            console.debug('[PreAuthStrategy] postAuthentication callback completed');
+        }
+        else {
+            console.warn('[PreAuthStrategy] postAuthentication callback is not set - isInitialized may not be set to true');
+        }
+    }
+    /**
+     * Check if the user is currently authenticated
+     */
+    isAuthenticated() {
+        return this.isAuthenticatedFlag;
+    }
+    /**
+     * Get the access token
+     * If refresh function is provided and token is expired, attempts to refresh
+     */
+    async getToken() {
+        return this.currentToken;
+    }
+    /**
+     * Update the access token
+     * Cancels existing expiry timer and schedules new one based on new token
+     * If authenticated, calls postAuthentication callback with the new token
+     * @param token - The new access token
+     */
+    async updateToken(token) {
+        this.currentToken = token;
+        // Reschedule expiry event with new token
+        this.scheduleExpiryEvent(token);
+        // If authenticated, call postAuthentication callback with new token
+        if (this.isAuthenticatedFlag && this.postAuthentication) {
+            await this.postAuthentication(token);
+        }
+    }
+    /**
+     * Refresh the token using the provided refresh function
+     */
+    async refreshToken() {
+        if (this.config.refreshTokenFn) {
+            const newToken = await this.config.refreshTokenFn();
+            await this.updateToken(newToken);
+        }
+        return this.currentToken;
+    }
+    /**
+     * Cleanup resources
+     */
+    async cleanup() {
+        this.cancelExpiryTimer();
+    }
+}
+//# sourceMappingURL=PreAuthStrategy.js.map

package/dist/core/auth/PreAuthStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreAuthStrategy.js","sourceRoot":"","sources":["../../../src/core/auth/PreAuthStrategy.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAiC7C;;;GAGG;AACH,MAAM,OAAO,eAAe;IAS1B,YAA6B,MAAqB;QAArB,WAAM,GAAN,MAAM,CAAe;QAN1C,wBAAmB,GAAY,KAAK,CAAC;QAO3C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,sBAAsB,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACK,SAAS,CAAC,KAAa;QAC7B,IAAI,CAAC;YACH,uCAAuC;YACvC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,mCAAmC;YACnC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACzB,kCAAkC;YAClC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAE7D,oDAAoD;YACpD,IAAI,OAAe,CAAC;YACpB,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC/B,sBAAsB;gBACtB,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;iBAAM,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;gBACzC,sBAAsB;gBACtB,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC;YACd,CAAC;YAED,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAe,CAAC;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,8CAA8C;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,KAAa;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,OAAO,EAAE,GAAG,EAAE,CAAC;YACjB,iDAAiD;YACjD,OAAO,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACK,mBAAmB,CAAC,KAAa;QACvC,4BAA4B;QAC5B,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,iDAAiD;YACjD,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,eAAe,GAAG,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC;QAE9D,IAAI,eAAe,IAAI,CAAC,EAAE,CAAC;YACzB,8DAA8D;YAC9D,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;YACxC,CAAC;YACD,OAAO;QACT,CAAC;QAED,4BAA4B;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;YACjC,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,EAAE,eAAe,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,wBAAwB,CAAC,QAA+B;QACtD,IAAI,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QACtC,yEAAyE;QACzE,IAAI,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAClD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,OAAuC;QACtD,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE;YACrD,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,kBAAkB;YACpD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,cAAc;SAC7C,CAAC,CAAC;QAEH,iEAAiE;QACjE,iGAAiG;QACjG,IAAI,OAAO,EAAE,kBAAkB,EAAE,CAAC;YAChC,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;YACrD,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,OAAO,EAAE,cAAc,EAAE,CAAC;YAC5B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC/C,CAAC;QAED,sCAAsC;QACtC,2EAA2E;QAC3E,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;QAED,uFAAuF;QACvF,+CAA+C;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;QAChC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,wCAAwC;YACxC,IAAI,CAAC;gBACH,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,kEAAkE;gBAClE,uDAAuD;YACzD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,OAAO,CAAC,KAAK,CAAC,uEAAuE,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACpI,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,8CAA8C;QAC9C,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAEhC,kEAAkE;QAClE,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;YACvE,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACrC,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC3E,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,iGAAiG,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,KAAa;QAC7B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,yCAAyC;QACzC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAEhC,oEAAoE;QACpE,IAAI,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxD,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;YACpD,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;CACF"}