@leancodepl/login-manager 8.4.0 → 8.5.1

package/README.md

@@ -0,0 +1,214 @@
+# @leancodepl/login-manager
+
+OAuth2 authentication management with token storage and refresh capabilities.
+
+## Features
+
+- **OAuth2 authentication** - Standard-compliant implementation
+- **Multiple storage options** - Local, session, or memory storage
+- **Token refresh** - Automatic refresh handling
+- **Social login** - Facebook, Google and LinkedIn integrations
+
+## Installation
+
+```bash
+npm install @leancodepl/login-manager
+# or
+yarn add @leancodepl/login-manager
+```
+
+## API
+
+### `AsyncLoginManager`
+
+Manages OAuth2 authentication with asynchronous token storage.
+
+**Parameters:**
+
+- `storage: AsyncTokenStorage` - Token storage implementation
+- `endpoint: string` - OAuth2 server endpoint
+- `clientSecret: string | undefined` - Client secret for authentication
+- `clientId: string` - OAuth2 client identifier
+- `scopes: string` - Space-separated OAuth2 scopes
+- `additionalParams?: Record<string, string>` - Additional OAuth2 parameters
+
+### `SyncLoginManager`
+
+Manages OAuth2 authentication with synchronous token storage.
+
+**Parameters:**
+
+- `storage: SyncTokenStorage` - Token storage implementation
+- `endpoint: string` - OAuth2 server endpoint
+- `clientSecret: string | undefined` - Client secret for authentication
+- `clientId: string` - OAuth2 client identifier
+- `scopes: string` - Space-separated OAuth2 scopes
+- `additionalParams?: Record<string, string>` - Additional OAuth2 parameters
+
+### `LocalTokenStorage`
+
+Stores OAuth2 tokens in browser localStorage.
+
+**Parameters:**
+
+- `tokenKey?: string` - localStorage key for access token (default: "token")
+- `refreshKey?: string` - localStorage key for refresh token (default: "refresh_token")
+- `expiryKey?: string` - localStorage key for expiry date (default: "expiration_date")
+
+### `SessionTokenStorage`
+
+Stores OAuth2 tokens in browser sessionStorage.
+
+**Parameters:**
+
+- `tokenKey?: string` - sessionStorage key for access token (default: "token")
+- `refreshKey?: string` - sessionStorage key for refresh token (default: "refresh_token")
+- `expiryKey?: string` - sessionStorage key for expiry date (default: "expiration_date")
+
+### `MemoryTokenStorage`
+
+Stores OAuth2 tokens in memory.
+
+### `FacebookClient`
+
+Integrates Facebook Login SDK for web applications.
+
+**Parameters:**
+
+- `facebookAppId: string` - Facebook App ID
+- `facebookPermissions: string` - Comma-separated Facebook permissions
+
+### `CannotRefreshToken`
+
+Error thrown when token refresh fails.
+
+## Usage Examples
+
+### Basic Authentication
+
+```typescript
+import { SyncLoginManager, LocalTokenStorage } from "@leancodepl/login-manager"
+
+const tokenStorage = new LocalTokenStorage()
+const loginManager = new SyncLoginManager(
+    tokenStorage,
+    "https://api.example.com",
+    "client_secret",
+    "client_id",
+    "openid profile email",
+)
+
+const result = await loginManager.trySignIn("user@example.com", "password")
+if (result.type === "success") {
+    console.log("Signed in successfully")
+}
+```
+
+### Session-based Authentication
+
+```typescript
+import { AsyncLoginManager, SessionTokenStorage } from "@leancodepl/login-manager"
+
+const tokenStorage = new SessionTokenStorage()
+const loginManager = new AsyncLoginManager(
+    tokenStorage,
+    "https://api.example.com",
+    undefined, // No client secret for public clients
+    "public_client_id",
+    "openid profile",
+)
+
+await loginManager.load()
+const isSignedIn = await loginManager.isSigned()
+console.log("User signed in:", isSignedIn)
+```
+
+### Facebook Login Integration
+
+```typescript
+import { FacebookClient, SyncLoginManager, LocalTokenStorage } from "@leancodepl/login-manager"
+
+const facebookClient = new FacebookClient("your-facebook-app-id", "email,public_profile")
+const loginManager = new SyncLoginManager(
+    new LocalTokenStorage(),
+    "https://api.example.com",
+    "client_secret",
+    "client_id",
+    "openid profile",
+)
+
+facebookClient.setup()
+facebookClient.login(async accessToken => {
+    const result = await loginManager.trySignInWithFacebook(accessToken)
+    if (result.type === "success") {
+        console.log("Facebook login successful")
+    }
+})
+```
+
+### Token Management
+
+```typescript
+import { CannotRefreshToken, SyncLoginManager, LocalTokenStorage } from "@leancodepl/login-manager"
+
+const tokenStorage = new LocalTokenStorage()
+const loginManager = new SyncLoginManager(
+    tokenStorage,
+    "https://api.example.com",
+    "client_secret",
+    "client_id",
+    "openid profile",
+)
+
+try {
+    const token = await loginManager.getToken()
+    console.log("Access token:", token)
+} catch (error) {
+    if (error instanceof CannotRefreshToken) {
+        console.log("Token expired, user needs to sign in again")
+        await loginManager.signOut()
+    }
+}
+```
+
+### Authentication State Monitoring
+
+```typescript
+import { SyncLoginManager, LocalTokenStorage } from "@leancodepl/login-manager"
+
+const tokenStorage = new LocalTokenStorage()
+const loginManager = new SyncLoginManager(
+    tokenStorage,
+    "https://api.example.com",
+    "client_secret",
+    "client_id",
+    "openid profile",
+)
+
+loginManager.onChange(isSignedIn => {
+    if (isSignedIn) {
+        console.log("User is now signed in")
+    } else {
+        console.log("User signed out")
+    }
+})
+```
+
+### Multiple Authentication Providers
+
+```typescript
+import { SyncLoginManager, LocalTokenStorage } from "@leancodepl/login-manager"
+
+const tokenStorage = new LocalTokenStorage()
+const loginManager = new SyncLoginManager(
+    tokenStorage,
+    "https://api.example.com",
+    "client_secret",
+    "client_id",
+    "openid profile",
+)
+
+const googleResult = await loginManager.trySignInWithGoogle("google_access_token")
+const linkedinResult = await loginManager.trySignInWithLinkedIn("linkedin_access_token")
+const otpResult = await loginManager.trySignInWithOneTimeToken("one_time_token")
+```

package/index.cjs.js

@@ -194,14 +194,52 @@ class BaseLoginManager {
     }
 }
 
-class CannotRefreshToken extends Error {
+/**
+ * Error thrown when token refresh fails.
+ * 
+ * Indicates that the refresh token is invalid or expired, requiring user to sign in again.
+ * 
+ * @example
+ * ```typescript
+ * try {
+ *   const token = await loginManager.getToken();
+ * } catch (error) {
+ *   if (error instanceof CannotRefreshToken) {
+ *     console.log('User needs to sign in again');
+ *   }
+ * }
+ * ```
+ */ class CannotRefreshToken extends Error {
     constructor(m){
         super(m);
         Object.setPrototypeOf(this, CannotRefreshToken.prototype);
     }
 }
 
-class AsyncLoginManager extends BaseLoginManager {
+/**
+ * Manages OAuth2 authentication with asynchronous token storage.
+ * 
+ * Extends BaseLoginManager to work with async storage implementations like IndexedDB or remote storage.
+ * Handles token refresh, expiration, and authentication state management.
+ * 
+ * @param storage - Token storage implementation
+ * @param endpoint - OAuth2 server endpoint
+ * @param clientSecret - Client secret for authentication
+ * @param clientId - OAuth2 client identifier
+ * @param scopes - Space-separated OAuth2 scopes
+ * @param additionalParams - Additional OAuth2 parameters
+ * @example
+ * ```typescript
+ * const tokenStorage = new CustomAsyncStorage();
+ * const loginManager = new AsyncLoginManager(
+ *   tokenStorage,
+ *   'https://api.example.com',
+ *   'client_secret',
+ *   'client_id',
+ *   'openid profile'
+ * );
+ * ```
+ */ class AsyncLoginManager extends BaseLoginManager {
     async signOut() {
         await this.storage.resetToken();
         this.notify(false);
@@ -232,7 +270,23 @@ class AsyncLoginManager extends BaseLoginManager {
 }
 
 /// <reference types="facebook-js-sdk" />
-class FacebookClient {
+/**
+ * Integrates Facebook Login SDK for web applications.
+ * 
+ * Handles Facebook authentication flow and provides access tokens for OAuth2 sign-in.
+ * Automatically loads Facebook SDK and manages login state.
+ * 
+ * @param facebookAppId - Facebook App ID
+ * @param facebookPermissions - Comma-separated Facebook permissions
+ * @example
+ * ```typescript
+ * const facebookClient = new FacebookClient('your-app-id', 'email,public_profile');
+ * facebookClient.setup();
+ * facebookClient.login((accessToken) => {
+ *   return loginManager.trySignInWithFacebook(accessToken);
+ * });
+ * ```
+ */ class FacebookClient {
     get accessToken() {
         return this.token;
     }
@@ -299,7 +353,21 @@ class FacebookClient {
     }
 }
 
-class LocalTokenStorage {
+/**
+ * Stores OAuth2 tokens in browser localStorage.
+ * 
+ * Provides persistent token storage that survives browser sessions.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ * 
+ * @param tokenKey - localStorage key for access token (default: "token")
+ * @param refreshKey - localStorage key for refresh token (default: "refresh_token")
+ * @param expiryKey - localStorage key for expiry date (default: "expiration_date")
+ * @example
+ * ```typescript
+ * const storage = new LocalTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */ class LocalTokenStorage {
     getToken() {
         if (this.hasValue(this.tokenKey)) {
             return {
@@ -340,7 +408,18 @@ class LocalTokenStorage {
     }
 }
 
-class MemoryTokenStorage {
+/**
+ * Stores OAuth2 tokens in memory.
+ * 
+ * Provides temporary token storage that clears when the page is refreshed.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ * 
+ * @example
+ * ```typescript
+ * const storage = new MemoryTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */ class MemoryTokenStorage {
     getToken() {
         return this.token;
     }
@@ -361,7 +440,21 @@ class MemoryTokenStorage {
     }
 }
 
-class SessionTokenStorage {
+/**
+ * Stores OAuth2 tokens in browser sessionStorage.
+ * 
+ * Provides session-based token storage that clears when the browser tab is closed.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ * 
+ * @param tokenKey - sessionStorage key for access token (default: "token")
+ * @param refreshKey - sessionStorage key for refresh token (default: "refresh_token")
+ * @param expiryKey - sessionStorage key for expiry date (default: "expiration_date")
+ * @example
+ * ```typescript
+ * const storage = new SessionTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */ class SessionTokenStorage {
     getToken() {
         if (this.hasValue(this.tokenKey)) {
             return {
@@ -402,7 +495,30 @@ class SessionTokenStorage {
     }
 }
 
-class SyncLoginManager extends BaseLoginManager {
+/**
+ * Manages OAuth2 authentication with synchronous token storage.
+ * 
+ * Extends BaseLoginManager to work with sync storage implementations like localStorage or sessionStorage.
+ * Handles token refresh, expiration, and authentication state management.
+ * 
+ * @param storage - Token storage implementation
+ * @param endpoint - OAuth2 server endpoint
+ * @param clientSecret - Client secret for authentication
+ * @param clientId - OAuth2 client identifier
+ * @param scopes - Space-separated OAuth2 scopes
+ * @param additionalParams - Additional OAuth2 parameters
+ * @example
+ * ```typescript
+ * const tokenStorage = new LocalTokenStorage();
+ * const loginManager = new SyncLoginManager(
+ *   tokenStorage,
+ *   'https://api.example.com',
+ *   'client_secret',
+ *   'client_id',
+ *   'openid profile'
+ * );
+ * ```
+ */ class SyncLoginManager extends BaseLoginManager {
     signOut() {
         this.storage.resetToken();
         this.notify(false);

package/index.esm.js

@@ -192,14 +192,52 @@ class BaseLoginManager {
     }
 }
 
-class CannotRefreshToken extends Error {
+/**
+ * Error thrown when token refresh fails.
+ * 
+ * Indicates that the refresh token is invalid or expired, requiring user to sign in again.
+ * 
+ * @example
+ * ```typescript
+ * try {
+ *   const token = await loginManager.getToken();
+ * } catch (error) {
+ *   if (error instanceof CannotRefreshToken) {
+ *     console.log('User needs to sign in again');
+ *   }
+ * }
+ * ```
+ */ class CannotRefreshToken extends Error {
     constructor(m){
         super(m);
         Object.setPrototypeOf(this, CannotRefreshToken.prototype);
     }
 }
 
-class AsyncLoginManager extends BaseLoginManager {
+/**
+ * Manages OAuth2 authentication with asynchronous token storage.
+ * 
+ * Extends BaseLoginManager to work with async storage implementations like IndexedDB or remote storage.
+ * Handles token refresh, expiration, and authentication state management.
+ * 
+ * @param storage - Token storage implementation
+ * @param endpoint - OAuth2 server endpoint
+ * @param clientSecret - Client secret for authentication
+ * @param clientId - OAuth2 client identifier
+ * @param scopes - Space-separated OAuth2 scopes
+ * @param additionalParams - Additional OAuth2 parameters
+ * @example
+ * ```typescript
+ * const tokenStorage = new CustomAsyncStorage();
+ * const loginManager = new AsyncLoginManager(
+ *   tokenStorage,
+ *   'https://api.example.com',
+ *   'client_secret',
+ *   'client_id',
+ *   'openid profile'
+ * );
+ * ```
+ */ class AsyncLoginManager extends BaseLoginManager {
     async signOut() {
         await this.storage.resetToken();
         this.notify(false);
@@ -230,7 +268,23 @@ class AsyncLoginManager extends BaseLoginManager {
 }
 
 /// <reference types="facebook-js-sdk" />
-class FacebookClient {
+/**
+ * Integrates Facebook Login SDK for web applications.
+ * 
+ * Handles Facebook authentication flow and provides access tokens for OAuth2 sign-in.
+ * Automatically loads Facebook SDK and manages login state.
+ * 
+ * @param facebookAppId - Facebook App ID
+ * @param facebookPermissions - Comma-separated Facebook permissions
+ * @example
+ * ```typescript
+ * const facebookClient = new FacebookClient('your-app-id', 'email,public_profile');
+ * facebookClient.setup();
+ * facebookClient.login((accessToken) => {
+ *   return loginManager.trySignInWithFacebook(accessToken);
+ * });
+ * ```
+ */ class FacebookClient {
     get accessToken() {
         return this.token;
     }
@@ -297,7 +351,21 @@ class FacebookClient {
     }
 }
 
-class LocalTokenStorage {
+/**
+ * Stores OAuth2 tokens in browser localStorage.
+ * 
+ * Provides persistent token storage that survives browser sessions.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ * 
+ * @param tokenKey - localStorage key for access token (default: "token")
+ * @param refreshKey - localStorage key for refresh token (default: "refresh_token")
+ * @param expiryKey - localStorage key for expiry date (default: "expiration_date")
+ * @example
+ * ```typescript
+ * const storage = new LocalTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */ class LocalTokenStorage {
     getToken() {
         if (this.hasValue(this.tokenKey)) {
             return {
@@ -338,7 +406,18 @@ class LocalTokenStorage {
     }
 }
 
-class MemoryTokenStorage {
+/**
+ * Stores OAuth2 tokens in memory.
+ * 
+ * Provides temporary token storage that clears when the page is refreshed.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ * 
+ * @example
+ * ```typescript
+ * const storage = new MemoryTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */ class MemoryTokenStorage {
     getToken() {
         return this.token;
     }
@@ -359,7 +438,21 @@ class MemoryTokenStorage {
     }
 }
 
-class SessionTokenStorage {
+/**
+ * Stores OAuth2 tokens in browser sessionStorage.
+ * 
+ * Provides session-based token storage that clears when the browser tab is closed.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ * 
+ * @param tokenKey - sessionStorage key for access token (default: "token")
+ * @param refreshKey - sessionStorage key for refresh token (default: "refresh_token")
+ * @param expiryKey - sessionStorage key for expiry date (default: "expiration_date")
+ * @example
+ * ```typescript
+ * const storage = new SessionTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */ class SessionTokenStorage {
     getToken() {
         if (this.hasValue(this.tokenKey)) {
             return {
@@ -400,7 +493,30 @@ class SessionTokenStorage {
     }
 }
 
-class SyncLoginManager extends BaseLoginManager {
+/**
+ * Manages OAuth2 authentication with synchronous token storage.
+ * 
+ * Extends BaseLoginManager to work with sync storage implementations like localStorage or sessionStorage.
+ * Handles token refresh, expiration, and authentication state management.
+ * 
+ * @param storage - Token storage implementation
+ * @param endpoint - OAuth2 server endpoint
+ * @param clientSecret - Client secret for authentication
+ * @param clientId - OAuth2 client identifier
+ * @param scopes - Space-separated OAuth2 scopes
+ * @param additionalParams - Additional OAuth2 parameters
+ * @example
+ * ```typescript
+ * const tokenStorage = new LocalTokenStorage();
+ * const loginManager = new SyncLoginManager(
+ *   tokenStorage,
+ *   'https://api.example.com',
+ *   'client_secret',
+ *   'client_id',
+ *   'openid profile'
+ * );
+ * ```
+ */ class SyncLoginManager extends BaseLoginManager {
     signOut() {
         this.storage.resetToken();
         this.notify(false);

package/package.json

@@ -1,20 +1,52 @@
 {
   "name": "@leancodepl/login-manager",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
   "dependencies": {
     "buffer": ">=6.0.0"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leancodepl/js_corelibrary.git",
+    "directory": "packages/login-manager"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "OAuth2 and token-based authentication management utilities",
+  "keywords": [
+    "oauth2",
+    "authentication",
+    "tokens",
+    "login",
+    "auth",
+    "typescript",
+    "javascript",
+    "leancode"
+  ],
+  "author": {
+    "name": "LeanCode",
+    "url": "https://leancode.co"
+  },
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
+      "types": "./index.d.ts",
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     }
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/lib/asyncLoginManager.d.ts

@@ -1,5 +1,29 @@
 import { BaseLoginManager, LoginManager } from "./baseLoginManager";
 import { AsyncTokenStorage } from "./tokenStorage";
+/**
+ * Manages OAuth2 authentication with asynchronous token storage.
+ *
+ * Extends BaseLoginManager to work with async storage implementations like IndexedDB or remote storage.
+ * Handles token refresh, expiration, and authentication state management.
+ *
+ * @param storage - Token storage implementation
+ * @param endpoint - OAuth2 server endpoint
+ * @param clientSecret - Client secret for authentication
+ * @param clientId - OAuth2 client identifier
+ * @param scopes - Space-separated OAuth2 scopes
+ * @param additionalParams - Additional OAuth2 parameters
+ * @example
+ * ```typescript
+ * const tokenStorage = new CustomAsyncStorage();
+ * const loginManager = new AsyncLoginManager(
+ *   tokenStorage,
+ *   'https://api.example.com',
+ *   'client_secret',
+ *   'client_id',
+ *   'openid profile'
+ * );
+ * ```
+ */
 export declare class AsyncLoginManager extends BaseLoginManager<AsyncTokenStorage> implements LoginManager {
     signOut(): Promise<void>;
     isSigned(): Promise<boolean>;

package/src/lib/cannotRefreshToken.d.ts

@@ -1,3 +1,19 @@
+/**
+ * Error thrown when token refresh fails.
+ *
+ * Indicates that the refresh token is invalid or expired, requiring user to sign in again.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const token = await loginManager.getToken();
+ * } catch (error) {
+ *   if (error instanceof CannotRefreshToken) {
+ *     console.log('User needs to sign in again');
+ *   }
+ * }
+ * ```
+ */
 export declare class CannotRefreshToken extends Error {
     constructor(m: string);
 }

package/src/lib/facebookClient.d.ts

@@ -1,3 +1,20 @@
+/**
+ * Integrates Facebook Login SDK for web applications.
+ *
+ * Handles Facebook authentication flow and provides access tokens for OAuth2 sign-in.
+ * Automatically loads Facebook SDK and manages login state.
+ *
+ * @param facebookAppId - Facebook App ID
+ * @param facebookPermissions - Comma-separated Facebook permissions
+ * @example
+ * ```typescript
+ * const facebookClient = new FacebookClient('your-app-id', 'email,public_profile');
+ * facebookClient.setup();
+ * facebookClient.login((accessToken) => {
+ *   return loginManager.trySignInWithFacebook(accessToken);
+ * });
+ * ```
+ */
 export declare class FacebookClient {
     private facebookAppId;
     private facebookPermissions;

package/src/lib/localTokenStorage.d.ts

@@ -1,4 +1,19 @@
 import { SyncTokenStorage, Token } from "./tokenStorage";
+/**
+ * Stores OAuth2 tokens in browser localStorage.
+ *
+ * Provides persistent token storage that survives browser sessions.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ *
+ * @param tokenKey - localStorage key for access token (default: "token")
+ * @param refreshKey - localStorage key for refresh token (default: "refresh_token")
+ * @param expiryKey - localStorage key for expiry date (default: "expiration_date")
+ * @example
+ * ```typescript
+ * const storage = new LocalTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */
 export declare class LocalTokenStorage implements SyncTokenStorage {
     private tokenKey;
     private refreshKey;

package/src/lib/memoryTokenStorage.d.ts

@@ -1,4 +1,16 @@
 import { SyncTokenStorage, Token } from "./tokenStorage";
+/**
+ * Stores OAuth2 tokens in memory.
+ *
+ * Provides temporary token storage that clears when the page is refreshed.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ *
+ * @example
+ * ```typescript
+ * const storage = new MemoryTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */
 export declare class MemoryTokenStorage implements SyncTokenStorage {
     private token;
     getToken(): Token | null;

package/src/lib/sessionTokenStorage.d.ts

@@ -1,4 +1,19 @@
 import { SyncTokenStorage, Token } from "./tokenStorage";
+/**
+ * Stores OAuth2 tokens in browser sessionStorage.
+ *
+ * Provides session-based token storage that clears when the browser tab is closed.
+ * Implements SyncTokenStorage interface for synchronous operations.
+ *
+ * @param tokenKey - sessionStorage key for access token (default: "token")
+ * @param refreshKey - sessionStorage key for refresh token (default: "refresh_token")
+ * @param expiryKey - sessionStorage key for expiry date (default: "expiration_date")
+ * @example
+ * ```typescript
+ * const storage = new SessionTokenStorage();
+ * const loginManager = new SyncLoginManager(storage, endpoint, secret, clientId, scopes);
+ * ```
+ */
 export declare class SessionTokenStorage implements SyncTokenStorage {
     private tokenKey;
     private refreshKey;

package/src/lib/syncLoginManager.d.ts

@@ -1,5 +1,29 @@
 import { BaseLoginManager, LoginManager } from "./baseLoginManager";
 import { SyncTokenStorage } from "./tokenStorage";
+/**
+ * Manages OAuth2 authentication with synchronous token storage.
+ *
+ * Extends BaseLoginManager to work with sync storage implementations like localStorage or sessionStorage.
+ * Handles token refresh, expiration, and authentication state management.
+ *
+ * @param storage - Token storage implementation
+ * @param endpoint - OAuth2 server endpoint
+ * @param clientSecret - Client secret for authentication
+ * @param clientId - OAuth2 client identifier
+ * @param scopes - Space-separated OAuth2 scopes
+ * @param additionalParams - Additional OAuth2 parameters
+ * @example
+ * ```typescript
+ * const tokenStorage = new LocalTokenStorage();
+ * const loginManager = new SyncLoginManager(
+ *   tokenStorage,
+ *   'https://api.example.com',
+ *   'client_secret',
+ *   'client_id',
+ *   'openid profile'
+ * );
+ * ```
+ */
 export declare class SyncLoginManager extends BaseLoginManager<SyncTokenStorage> implements LoginManager {
     signOut(): void;
     isSigned(): boolean;

package/index.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";