docpouch-client 1.0.1 → 1.0.4

package/dist/index.d.ts

@@ -179,6 +179,15 @@ export default class docPouchClient {
      * @returns {void}
      */
     debugSocketConnection(): void;
+    /**
+     * Sets the OIDC configuration to use for the callback and token exchange.
+     * Call this before {@link handleOidcCallback} if the client was freshly
+     * instantiated after a page reload (the config is otherwise only set
+     * internally by {@link loginWithOidc} before the redirect).
+     *
+     * @param {I_OidcConfig} config - OIDC provider configuration.
+     */
+    setOidcConfig(config: I_OidcConfig): void;
     /**
      * Initiates the OIDC authentication flow by redirecting to the authorization endpoint.
      *
@@ -330,6 +339,7 @@ export interface I_OidcConfig {
     issuer: string;
     clientId: string;
     redirectUri: string;
+    scope?: string;
     scopes?: string[];
     clientSecret?: string;
 }

package/dist/index.js

@@ -305,6 +305,17 @@ export default class docPouchClient {
         }
     }
     // OIDC Authentication Methods
+    /**
+     * Sets the OIDC configuration to use for the callback and token exchange.
+     * Call this before {@link handleOidcCallback} if the client was freshly
+     * instantiated after a page reload (the config is otherwise only set
+     * internally by {@link loginWithOidc} before the redirect).
+     *
+     * @param {I_OidcConfig} config - OIDC provider configuration.
+     */
+    setOidcConfig(config) {
+        this.oidcConfig = config;
+    }
     /**
      * Initiates the OIDC authentication flow by redirecting to the authorization endpoint.
      *
@@ -318,11 +329,19 @@ export default class docPouchClient {
         this.codeVerifier = this.generateCodeVerifier();
         this.oidcState = this.generateState();
         const codeChallenge = await this.generateCodeChallenge(this.codeVerifier);
+        if (typeof window !== 'undefined' && window.sessionStorage) {
+            sessionStorage.setItem('docpouch_oidc_state', this.oidcState);
+            sessionStorage.setItem('docpouch_oidc_code_verifier', this.codeVerifier);
+            sessionStorage.setItem('docpouch_oidc_issuer', config.issuer);
+            sessionStorage.setItem('docpouch_oidc_client_id', config.clientId);
+            sessionStorage.setItem('docpouch_oidc_redirect_uri', config.redirectUri);
+        }
+        const scope = config.scope || config.scopes?.join(' ') || 'openid profile';
         const params = new URLSearchParams({
             response_type: 'code',
             client_id: config.clientId,
             redirect_uri: config.redirectUri,
-            scope: config.scopes?.join(' ') || 'openid profile',
+            scope,
             state: this.oidcState,
             code_challenge: codeChallenge,
             code_challenge_method: 'S256'
@@ -343,6 +362,23 @@ export default class docPouchClient {
             throw new Error(`OAuth error: ${error}`);
         if (!code || !state)
             return false;
+        if (typeof window !== 'undefined' && window.sessionStorage) {
+            this.oidcState = sessionStorage.getItem('docpouch_oidc_state') || this.oidcState;
+            this.codeVerifier = sessionStorage.getItem('docpouch_oidc_code_verifier') || this.codeVerifier;
+            sessionStorage.removeItem('docpouch_oidc_state');
+            sessionStorage.removeItem('docpouch_oidc_code_verifier');
+            if (!this.oidcConfig) {
+                const issuer = sessionStorage.getItem('docpouch_oidc_issuer');
+                const clientId = sessionStorage.getItem('docpouch_oidc_client_id');
+                const redirectUri = sessionStorage.getItem('docpouch_oidc_redirect_uri');
+                if (issuer && clientId && redirectUri) {
+                    this.oidcConfig = { issuer, clientId, redirectUri };
+                    sessionStorage.removeItem('docpouch_oidc_issuer');
+                    sessionStorage.removeItem('docpouch_oidc_client_id');
+                    sessionStorage.removeItem('docpouch_oidc_redirect_uri');
+                }
+            }
+        }
         if (state !== this.oidcState)
             throw new Error('State mismatch');
         const discovery = await this.discoverOidc();
@@ -441,6 +477,7 @@ export default class docPouchClient {
      * @returns {Promise<void>}
      */
     async logout() {
+        const wasOidc = this.authMethod === 'oidc';
         this.authToken = null;
         this.clearOidcTokens();
         this.authMethod = 'none';
@@ -450,6 +487,10 @@ 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;
+        }
     }
     // OIDC Dynamic Client Registration Methods
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docpouch-client",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -23,16 +23,16 @@
   "description": "Client SDK for DocPouch API - supports JWT and OIDC authentication",
   "repository": {
     "type": "git",
-    "url": "https://github.com/BFH-JTF/docpouch-client"
+    "url": "git+https://github.com/BFH-JTF/docpouch-client.git"
   },
   "devDependencies": {
     "@types/express": "^5.0.6",
     "@types/jest": "^30.0.0",
-    "@types/node": "^25.7.0",
+    "@types/node": "^25.9.1",
     "express": "^5.2.1",
     "jest": "^30.4.2",
     "socket.io": "^4.8.3",
-    "ts-jest": "^29.4.9",
+    "ts-jest": "^29.4.10",
     "typescript": "^6.0.3"
   },
   "dependencies": {

package/chat-09e440bd-c52c-44b9-bba4-01cebc84bd7b.txt

@@ -1,223 +0,0 @@
-Chat 'ChatTitle(text="I am adding authent…" with OpenCode, isCustom=true)' (09e440bd-c52c-44b9-bba4-01cebc84bd7b)
-Context:
-
-Messages: 18
-=================================================================================================================
-
-==== RestoredMessage #1 ====
-User: 
-I am adding authentication using node-oidcProvider to my app in addition to the already present localStorage solution. To give clients the possibility to register, is it enough to create a call to `this.expressApp.post` and get the necessary information from the client including some kind of secret?
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-this.expressApp.get
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-validate
-
-
-kotlin.Unit
-
-==== RestoredMessage #2 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #3 ====
-User: 
-Yes, good idea
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-validate
-
-
-kotlin.Unit
-
-==== RestoredMessage #4 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #5 ====
-User: 
-1. I want a controlled registration. I changed initialAccessToken to `process.env.OIDC_REGISTRATION_TOKEN`.
-2. I don't even know what JWKS is, let alone have anything set up for it.
-Yes, please proceed
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-process.env.OIDC_REGISTRATION_TOKEN
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-validate
-
-
-kotlin.Unit
-
-==== RestoredMessage #6 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #7 ====
-User: 
-Let's go with a static JWKS for starters. Yes, I would like the clients to have their choice, whether they want to use the localStorage or the OIDC approach for authentication. For both, the clients are expected to build their own login masks.
-If the registration token is not just a random string, I need help, yes. 
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-process.env.OIDC_REGISTRATION_TOKEN
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-validate
-
-
-kotlin.Unit
-
-==== RestoredMessage #8 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #9 ====
-User: 
-I am unsure,now. If I give clients these options for auth, is it easier for them, than having to build their own login mask?
-1. The old approach using the token in localStorage.
-2. OIDC and they can use a login mask provided by docPouch.
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-process.env.OIDC_REGISTRATION_TOKEN
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-validate
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-JWT_SECRET=your-secure-jwt-secret-here
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-NODE_ENV
-
-
-kotlin.Unit
-
-==== RestoredMessage #10 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #11 ====
-User: 
-I want to offer both choices and build a server-side login page.
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-process.env.OIDC_REGISTRATION_TOKEN
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-validate
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-JWT_SECRET=your-secure-jwt-secret-here
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-NODE_ENV
-
-
-kotlin.Unit
-
-==== RestoredMessage #12 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #13 ====
-User: 
-Do I need to update the express routes, so that they are able to validate users using both approaches?
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-JWT_SECRET=your-secure-jwt-secret-here
-
-
-kotlin.Unit
-
-==== RestoredMessage #14 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== RestoredMessage #15 ====
-User: 
-I am importing interfaces from the docPouch client I have written. I assume I will have to update some of those, as well, when I update the docPouch client, correct?
-Attachments:
-Attachment Name: Console Selection
-Attachments Kind: Visible
-Attachments Source: Other / RestoredChatAttachment
-Attachments Text:
-JWT_SECRET=your-secure-jwt-secret-here
-
-
-kotlin.Unit
-
-==== RestoredMessage #16 ====
-Assistant: 
-
-
-kotlin.Unit
-
-==== UserMessageImpl #17 ====
-User: 
-Yes, I would like to go for Option A and the client should offer different methods for the different auth methods and thus explicitly choose. Please make a detailed plan for yourself, so when I load up my docpouch-client project and give you this instruction, you know exactly what to do.
-
-kotlin.Unit
-
-==== AgentMessage #18 ====
-Assistant: 
-
-
-Tool use list:
-
-
-kotlin.Unit
-

package/jest.config.cjs

@@ -1,18 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  transform: {
-    '^.+\\.tsx?$': ['ts-jest', {
-      useESM: true,
-    }],
-  },
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-  testMatch: ['**/__tests__/**/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)', 'tests/**/*.test.ts'],
-  collectCoverage: true,
-  coverageDirectory: 'coverage',
-  coverageReporters: ['text', 'lcov'],
-};