docpouch-client 1.0.4 → 1.0.5

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { Socket } from "socket.io-client";
 /**
  * Client for interacting with docPouch API.
+ * Supports JWT and OIDC authentication with comprehensive logout capabilities.
+ * Provides event emitter functionality for logout events.
  */
 export default class docPouchClient {
     /**
@@ -49,6 +51,10 @@ export default class docPouchClient {
      * @type {boolean}
      */
     private connectionInProgress;
+    /**
+     * Event emitter for logout events
+     */
+    private events;
     /**
      * Creates an instance of docPouchClient.
      *
@@ -227,9 +233,40 @@ export default class docPouchClient {
     /**
      * Logs out the client, clearing all tokens and disconnecting WebSocket.
      *
+     * @param {LogoutOptions} [options] - Logout options for OIDC logout
      * @returns {Promise<void>}
      */
-    logout(): Promise<void>;
+    logout(options?: LogoutOptions): Promise<void>;
+    /**
+     * Explicitly logout from OIDC provider
+     * Redirects to /end_session endpoint
+     *
+     * @param {LogoutOptions} [options] - Logout options
+     * @returns {Promise<void>}
+     */
+    logoutOidc(options?: LogoutOptions): Promise<void>;
+    /**
+     * Logout from JWT (client-side only)
+     *
+     * @returns {Promise<void>}
+     */
+    logoutJwt(): Promise<void>;
+    /**
+     * Listen for logout events
+     */
+    onLogout(callback: () => void): void;
+    /**
+     * Listen for OIDC logout specifically
+     */
+    onOidcLogout(callback: () => void): void;
+    /**
+     * Listen for JWT logout specifically
+     */
+    onJwtLogout(callback: () => void): void;
+    /**
+     * Emit an event
+     */
+    private emit;
     /**
      * Registers a new OIDC client with the server (dynamic client registration).
      *
@@ -296,6 +333,19 @@ export default class docPouchClient {
     private generateCodeVerifier;
     private generateCodeChallenge;
     private generateState;
+    /**
+     * Check if user was just logged out (after redirect from /end_session)
+     * Checks URL for logout indicator or checks localStorage
+     *
+     * @returns {boolean} True if user was just logged out
+     */
+    wasJustLoggedOut(): boolean;
+    /**
+     * Get post_logout_redirect_uri after OIDC logout
+     *
+     * @returns {string | null} The post logout redirect URI or null if not set
+     */
+    getPostLogoutRedirectUri(): string | null;
 }
 export interface I_UserEntry extends I_UserCreation {
     _id: string;
@@ -335,6 +385,10 @@ export interface I_LoginResponse {
     userName: string;
     expiresIn?: number;
 }
+export interface LogoutOptions {
+    redirectUri?: string;
+    idTokenHint?: string;
+}
 export interface I_OidcConfig {
     issuer: string;
     clientId: string;
@@ -342,6 +396,7 @@ export interface I_OidcConfig {
     scope?: string;
     scopes?: string[];
     clientSecret?: string;
+    postLogoutRedirectUri?: string;
 }
 export interface I_OidcTokenResponse {
     accessToken: string;

package/dist/index.js

@@ -2,6 +2,8 @@ import { io } from "socket.io-client";
 import packetJson from '../package.json';
 /**
  * Client for interacting with docPouch API.
+ * Supports JWT and OIDC authentication with comprehensive logout capabilities.
+ * Provides event emitter functionality for logout events.
  */
 export default class docPouchClient {
     /**
@@ -40,6 +42,10 @@ export default class docPouchClient {
          * @type {boolean}
          */
         this.connectionInProgress = false;
+        /**
+         * Event emitter for logout events
+         */
+        this.events = {};
         this.baseUrl = host;
         const socketUrl = host.includes('://') ? host : `https://${host}`;
         const socketUrlWithPort = socketUrl.includes(':') && !socketUrl.endsWith(':')
@@ -411,11 +417,15 @@ export default class docPouchClient {
         return true;
     }
     restoreOidcSession() {
-        if (typeof window === 'undefined' || !window.localStorage)
-            return false;
         const stored = localStorage.getItem('docpouch_oidc_session');
-        if (!stored)
+        if (!stored) {
+            // If no session, check if user was just logged out
+            if (this.wasJustLoggedOut()) {
+                // User was logged out, emit oidc-logout event
+                this.emit('oidc-logout');
+            }
             return false;
+        }
         try {
             const session = JSON.parse(stored);
             if (!session.accessToken || Date.now() >= session.expiry) {
@@ -474,10 +484,32 @@ export default class docPouchClient {
     /**
      * Logs out the client, clearing all tokens and disconnecting WebSocket.
      *
+     * @param {LogoutOptions} [options] - Logout options for OIDC logout
      * @returns {Promise<void>}
      */
-    async logout() {
+    async logout(options) {
         const wasOidc = this.authMethod === 'oidc';
+        // For OIDC, redirect to /end_session endpoint
+        if (wasOidc && this.oidcConfig && typeof window !== 'undefined') {
+            const redirectUri = options?.redirectUri || this.oidcConfig.redirectUri || window.location.origin;
+            let url = `${this.oidcConfig.issuer}/end_session?post_logout_redirect_uri=${encodeURIComponent(redirectUri)}`;
+            // Add id_token_hint if available
+            const idToken = options?.idTokenHint || this.oidcIdToken;
+            if (idToken) {
+                url += `&id_token_hint=${idToken}`;
+            }
+            // Clear tokens before redirect
+            this.authToken = null;
+            this.clearOidcTokens();
+            this.authMethod = 'none';
+            if (this.socket.connected)
+                this.socket.disconnect();
+            // Redirect to OIDC logout endpoint
+            window.location.href = url;
+            return;
+        }
+        // For JWT or no auth, just clear local state
+        const wasJwt = this.authMethod === 'jwt';
         this.authToken = null;
         this.clearOidcTokens();
         this.authMethod = 'none';
@@ -487,9 +519,98 @@ export default class docPouchClient {
             (window.location.search.includes('code=') || window.location.search.includes('state='))) {
             window.history.replaceState({}, '', window.location.pathname);
         }
-        if (wasOidc && this.oidcConfig && typeof window !== 'undefined') {
-            const logoutUrl = `${this.oidcConfig.issuer}/session/end?post_logout_redirect_uri=${encodeURIComponent(this.oidcConfig.redirectUri)}`;
-            window.location.href = logoutUrl;
+        // Emit appropriate logout events
+        if (wasJwt) {
+            this.emit('jwt-logout');
+            this.emit('logout');
+        }
+        else if (!wasOidc) {
+            // No auth case
+            this.emit('logout');
+        }
+    }
+    /**
+     * Explicitly logout from OIDC provider
+     * Redirects to /end_session endpoint
+     *
+     * @param {LogoutOptions} [options] - Logout options
+     * @returns {Promise<void>}
+     */
+    async logoutOidc(options) {
+        if (this.authMethod !== 'oidc') {
+            throw new Error('Not logged in with OIDC');
+        }
+        if (!this.oidcConfig?.issuer) {
+            throw new Error('OIDC issuer not configured');
+        }
+        const { redirectUri = this.oidcConfig.redirectUri || window.location.origin, idTokenHint } = options || {};
+        let url = `${this.oidcConfig.issuer}/end_session?post_logout_redirect_uri=${encodeURIComponent(redirectUri)}`;
+        if (idTokenHint) {
+            url += `&id_token_hint=${idTokenHint}`;
+        }
+        else if (this.oidcIdToken) {
+            url += `&id_token_hint=${this.oidcIdToken}`;
+        }
+        // Clear tokens before redirect
+        this.authToken = null;
+        this.clearOidcTokens();
+        this.authMethod = 'none';
+        if (this.socket.connected)
+            this.socket.disconnect();
+        // Emit OIDC logout event
+        this.emit('oidc-logout');
+        this.emit('logout');
+        window.location.href = url;
+    }
+    /**
+     * Logout from JWT (client-side only)
+     *
+     * @returns {Promise<void>}
+     */
+    async logoutJwt() {
+        if (this.authMethod !== 'jwt') {
+            throw new Error('Not logged in with JWT');
+        }
+        this.authToken = null;
+        this.authMethod = 'none';
+        if (this.socket.connected)
+            this.socket.disconnect();
+        if (typeof window !== 'undefined' && window.location &&
+            (window.location.search.includes('code=') || window.location.search.includes('state='))) {
+            window.history.replaceState({}, '', window.location.pathname);
+        }
+        // Emit JWT logout event
+        if (this.events['jwt-logout']) {
+            this.events['jwt-logout']();
+        }
+        if (this.events['logout']) {
+            this.events['logout']();
+        }
+    }
+    /**
+     * Listen for logout events
+     */
+    onLogout(callback) {
+        this.events['logout'] = callback;
+    }
+    /**
+     * Listen for OIDC logout specifically
+     */
+    onOidcLogout(callback) {
+        this.events['oidc-logout'] = callback;
+    }
+    /**
+     * Listen for JWT logout specifically
+     */
+    onJwtLogout(callback) {
+        this.events['jwt-logout'] = callback;
+    }
+    /**
+     * Emit an event
+     */
+    emit(event) {
+        if (this.events[event]) {
+            this.events[event]();
         }
     }
     // OIDC Dynamic Client Registration Methods
@@ -747,4 +868,33 @@ export default class docPouchClient {
         crypto.getRandomValues(array);
         return Array.from(array, byte => byte.toString(16).padStart(2, '0')).join('');
     }
+    /**
+     * Check if user was just logged out (after redirect from /end_session)
+     * Checks URL for logout indicator or checks localStorage
+     *
+     * @returns {boolean} True if user was just logged out
+     */
+    wasJustLoggedOut() {
+        // Check URL query parameter
+        const urlParams = new URLSearchParams(window.location.search);
+        if (urlParams.get('logout') === 'true') {
+            return true;
+        }
+        // Check localStorage flag
+        const lastAuthMethod = localStorage.getItem('lastAuthMethod');
+        const currentAuthMethod = localStorage.getItem('authMethod');
+        // If last was OIDC/JWT but current is none, was logged out
+        if (lastAuthMethod && currentAuthMethod === null) {
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Get post_logout_redirect_uri after OIDC logout
+     *
+     * @returns {string | null} The post logout redirect URI or null if not set
+     */
+    getPostLogoutRedirectUri() {
+        return localStorage.getItem('postLogoutRedirectUri');
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docpouch-client",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {