@vunexa/lixa 0.1.0 → 0.1.2

package/docs/api/lixa.lixa.handlecallback.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [Lixa](./lixa.lixa.md) &gt; [handleCallback](./lixa.lixa.handlecallback.md)
+
+## Lixa.handleCallback() method
+
+Handles the OAuth callback and creates a user session.
+
+**Signature:**
+
+```typescript
+handleCallback({ provider, code, state, }: {
+        provider: string;
+        code: string;
+        state?: string;
+    }): Promise<Session>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+{ provider, code, state, }
+
+
+</td><td>
+
+{ provider: string; code: string; state?: string; }
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[Session](./lixa.session.md)<!-- -->&gt;
+
+A Promise that resolves to a Session object
+
+## Exceptions
+
+Error when code or state is missing/invalid, or provider is not configured
+
+## Example
+
+
+```typescript
+const session = await lixa.handleCallback({
+  provider: 'google',
+  code: req.query.code,
+  state: req.query.state
+});
+```
+

package/docs/api/lixa.lixa.isproviderregistered.md

@@ -0,0 +1,65 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [Lixa](./lixa.lixa.md) &gt; [isProviderRegistered](./lixa.lixa.isproviderregistered.md)
+
+## Lixa.isProviderRegistered() method
+
+Checks if a provider is registered and available for use.
+
+**Signature:**
+
+```typescript
+static isProviderRegistered(provider: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+provider
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The provider name to check (case-insensitive)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+
+True if the provider is registered, false otherwise
+
+## Example
+
+
+```typescript
+if (Lixa.isProviderRegistered('google')) {
+  console.log('Google provider is available');
+}
+```
+

package/docs/api/lixa.lixa.md

@@ -0,0 +1,164 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [Lixa](./lixa.lixa.md)
+
+## Lixa class
+
+A flexible, provider-agnostic OAuth 2.0 and OpenID Connect (OIDC) client library.
+
+**Signature:**
+
+```typescript
+declare class Lixa 
+```
+
+## Remarks
+
+Lixa simplifies multi-provider authentication flows and supports extensible session management.
+
+## Example
+
+
+```typescript
+const lixa = new Lixa({
+  providers: {
+    google: {
+      clientId: 'your-client-id',
+      clientSecret: 'your-client-secret',
+      redirectUri: 'https://yourapp.com/auth/google/callback',
+      scopes: ['openid', 'email', 'profile']
+    }
+  }
+});
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(config)](./lixa.lixa._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new Lixa instance with the provided configuration.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[generateRandomState()](./lixa.lixa.generaterandomstate.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Generates a cryptographically secure random state parameter for OAuth flows.
+
+
+</td></tr>
+<tr><td>
+
+[getAuthUrl(provider, state)](./lixa.lixa.getauthurl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Generates the authorization URL for the specified provider.
+
+
+</td></tr>
+<tr><td>
+
+[handleCallback({ provider, code, state, })](./lixa.lixa.handlecallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Handles the OAuth callback and creates a user session.
+
+
+</td></tr>
+<tr><td>
+
+[isProviderRegistered(provider)](./lixa.lixa.isproviderregistered.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Checks if a provider is registered and available for use.
+
+
+</td></tr>
+<tr><td>
+
+[registerProvider(providerMap)](./lixa.lixa.registerprovider.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Registers custom OAuth providers for use with Lixa.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/lixa.lixa.registerprovider.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [Lixa](./lixa.lixa.md) &gt; [registerProvider](./lixa.lixa.registerprovider.md)
+
+## Lixa.registerProvider() method
+
+Registers custom OAuth providers for use with Lixa.
+
+**Signature:**
+
+```typescript
+static registerProvider(providerMap: {
+        [key: string]: IProvider;
+    }): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+providerMap
+
+
+</td><td>
+
+{ \[key: string\]: [IProvider](./lixa.iprovider.md)<!-- -->; }
+
+
+</td><td>
+
+A map of provider names to IProvider implementations
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+
+## Example
+
+
+```typescript
+class CustomProvider implements IProvider {
+  authorizationEndpoint = 'https://custom.com/oauth/authorize';
+  tokenEndpoint = 'https://custom.com/oauth/token';
+  userInfoEndpoint = 'https://custom.com/api/user';
+}
+
+Lixa.registerProvider({ custom: new CustomProvider() });
+```
+

package/docs/api/lixa.lixaconfig.md

@@ -0,0 +1,96 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [LixaConfig](./lixa.lixaconfig.md)
+
+## LixaConfig interface
+
+Main configuration object for Lixa.
+
+**Signature:**
+
+```typescript
+export interface LixaConfig 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[providers](./lixa.lixaconfig.providers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;string, [ProviderConfig](./lixa.providerconfig.md)<!-- -->&gt;
+
+
+</td><td>
+
+Map of provider names to their configurations
+
+
+</td></tr>
+<tr><td>
+
+[sessionStrategy?](./lixa.lixaconfig.sessionstrategy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[SessionStrategy](./lixa.sessionstrategy.md)
+
+
+</td><td>
+
+_(Optional)_ Optional custom session creation strategy
+
+
+</td></tr>
+<tr><td>
+
+[stateDao?](./lixa.lixaconfig.statedao.md)
+
+
+</td><td>
+
+
+</td><td>
+
+StateDao
+
+
+</td><td>
+
+_(Optional)_ Optional custom state storage implementation
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/lixa.lixaconfig.providers.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [LixaConfig](./lixa.lixaconfig.md) &gt; [providers](./lixa.lixaconfig.providers.md)
+
+## LixaConfig.providers property
+
+Map of provider names to their configurations
+
+**Signature:**
+
+```typescript
+providers: Record<string, ProviderConfig>;
+```

package/docs/api/lixa.lixaconfig.sessionstrategy.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [LixaConfig](./lixa.lixaconfig.md) &gt; [sessionStrategy](./lixa.lixaconfig.sessionstrategy.md)
+
+## LixaConfig.sessionStrategy property
+
+Optional custom session creation strategy
+
+**Signature:**
+
+```typescript
+sessionStrategy?: SessionStrategy;
+```

package/docs/api/lixa.lixaconfig.statedao.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [LixaConfig](./lixa.lixaconfig.md) &gt; [stateDao](./lixa.lixaconfig.statedao.md)
+
+## LixaConfig.stateDao property
+
+Optional custom state storage implementation
+
+**Signature:**
+
+```typescript
+stateDao?: StateDao;
+```

package/docs/api/lixa.md

@@ -0,0 +1,108 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md)
+
+## lixa package
+
+A flexible, provider-agnostic OAuth 2.0 and OpenID Connect (OIDC) client library for backend applications.
+
+## Remarks
+
+This package simplifies multi-provider authentication flows (e.g., Google, GitHub), supports extensible session management, and enables custom provider registration.
+
+## Classes
+
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Lixa](./lixa.lixa.md)
+
+
+</td><td>
+
+A flexible, provider-agnostic OAuth 2.0 and OpenID Connect (OIDC) client library.
+
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[IProvider](./lixa.iprovider.md)
+
+
+</td><td>
+
+Interface for OAuth provider implementations.
+
+
+</td></tr>
+<tr><td>
+
+[LixaConfig](./lixa.lixaconfig.md)
+
+
+</td><td>
+
+Main configuration object for Lixa.
+
+
+</td></tr>
+<tr><td>
+
+[ProviderConfig](./lixa.providerconfig.md)
+
+
+</td><td>
+
+Configuration for an OAuth provider.
+
+
+</td></tr>
+<tr><td>
+
+[Session](./lixa.session.md)
+
+
+</td><td>
+
+Represents a user session after successful OAuth authentication.
+
+
+</td></tr>
+<tr><td>
+
+[SessionStrategy](./lixa.sessionstrategy.md)
+
+
+</td><td>
+
+Strategy interface for custom session creation.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/lixa.providerconfig.clientid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [ProviderConfig](./lixa.providerconfig.md) &gt; [clientId](./lixa.providerconfig.clientid.md)
+
+## ProviderConfig.clientId property
+
+The OAuth client ID provided by the provider
+
+**Signature:**
+
+```typescript
+clientId: string;
+```

package/docs/api/lixa.providerconfig.clientsecret.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [ProviderConfig](./lixa.providerconfig.md) &gt; [clientSecret](./lixa.providerconfig.clientsecret.md)
+
+## ProviderConfig.clientSecret property
+
+The OAuth client secret provided by the provider
+
+**Signature:**
+
+```typescript
+clientSecret: string;
+```

package/docs/api/lixa.providerconfig.extraconfig.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@vunexa/lixa](./lixa.md) &gt; [ProviderConfig](./lixa.providerconfig.md) &gt; [extraConfig](./lixa.providerconfig.extraconfig.md)
+
+## ProviderConfig.extraConfig property
+
+Additional provider-specific configuration parameters
+
+**Signature:**
+
+```typescript
+extraConfig?: Record<string, any>;
+```