@vunexa/lixa 0.1.6-alpha.1 → 0.1.6-alpha.10

package/README.md

@@ -17,8 +17,7 @@ A flexible, provider-agnostic OAuth 2.0 and OpenID Connect (OIDC) client library
 - **Multi-SSO Account Linking**: Seamlessly merge accounts sharing the same verified email address under a single unified user session.
 - **Post-Login Resource Connection API**: Connect third-party API providers (GitHub Repositories, Google Drive, Slack) post-authentication and manage resource tokens on the user session.
 - **Multi-provider OAuth/OIDC support** with unified API.
-- **Built-in providers** for Google, GitHub, and more via `@vunexa/lixa-providers`.
-- **Custom provider support** with extensible provider interface.
+- **Pre-built Database Storage Adapters**: Official Prisma and Drizzle ORM adapters via `@vunexa/lixa-adapters` with support for PostgreSQL, MySQL, and SQLite.
 - **Unified session management** via `SessionHandler` (generation + storage).
 - **Unified state management** via `StateHandler` (PKCE + CSRF protection).
 - **Automatic PKCE** (Proof Key for Code Exchange) for all OAuth flows.
@@ -28,36 +27,7 @@ A flexible, provider-agnostic OAuth 2.0 and OpenID Connect (OIDC) client library
 
 ## Architecture Overview
 
-```mermaid
-graph TD
-    User([User Client / Browser])
-    
-    subgraph Lixa ["Lixa Core Engine"]
-        AuthNGuard["Primary AuthN Guard<br/>(Minimal Identity Scopes Only)"]
-        SessionMgr["Session Handler & Unified Session"]
-        AccountLinker["Account Linker<br/>(AUTO_LINK_BY_VERIFIED_EMAIL)"]
-        ResourceConn["Resource Connection API<br/>(Post-Login AuthZ)"]
-    end
-
-    subgraph IdentityProviders ["Identity Providers (AuthN)"]
-        GoogleAuth["Google / OIDC"]
-        GitHubAuth["GitHub OAuth"]
-    end
-
-    subgraph ResourceProviders ["Resource APIs (AuthZ)"]
-        GitHubAPI["GitHub API (repos, orgs)"]
-        GoogleDriveAPI["Google Drive API"]
-    end
-
-    User -->|"1. Primary Login / Link Account"| AuthNGuard
-    AuthNGuard -->|"Request Identity"| IdentityProviders
-    IdentityProviders -->|"Tokens + UserInfo"| AccountLinker
-    AccountLinker -->|"Unified Session (session.accounts)"| SessionMgr
-    
-    User -->|"2. Connect Resource API (Post-Login)"| ResourceConn
-    ResourceConn -->|"Request Permissions (repo, drive)"| ResourceProviders
-    ResourceProviders -->|"Resource Access Tokens"| SessionMgr
-```
+![Architecture Overview](https://cdn.jsdelivr.net/npm/@vunexa/lixa/docs/images/architecture.svg)
 
 ---
 
@@ -216,15 +186,16 @@ app.get("/connect/github/callback", async (req, res) => {
   res.redirect("/dashboard");
 });
 
-// 3. Query Connected Resource Access Token
+// 3. Query Connected Resource Access Token (Auto-Refreshes Expired Tokens)
 app.get("/api/github/repos", async (req, res) => {
+  // Queries by active session OR user ID, auto-refreshing expired access tokens
   const resource = await lixa.getConnectedResource(req.cookies.session_id, "github");
 
   if (!resource) {
     return res.status(403).json({ error: "GitHub resource not connected" });
   }
 
-  // Call GitHub API with resource access token
+  // Call GitHub API with active resource access token
   const response = await fetch("https://api.github.com/user/repos", {
     headers: { Authorization: `Bearer ${resource.accessToken}` },
   });
@@ -233,7 +204,10 @@ app.get("/api/github/repos", async (req, res) => {
   res.json(repos);
 });
 
-// 4. Disconnect Resource Provider
+// 4. Query Resource Directly by User ID (e.g. inside background cron jobs or webhooks)
+const githubResource = await lixa.getUserResource(userId, "github");
+
+// 5. Disconnect Resource Provider
 app.delete("/connect/github", async (req, res) => {
   await lixa.disconnectResource(req.cookies.session_id, "github");
   res.json({ success: true });
@@ -249,26 +223,26 @@ export interface Session<TRaw = OAuthTokenResponse> {
   /** Unique session ID generated by Lixa */
   id?: string;
 
-  /** Primary access token or session token */
-  token: string;
-
   /** Unified user ID across linked accounts */
   userId?: string;
 
   /** Primary user email */
   email?: string;
 
-  /** Current active auth provider */
-  provider?: string;
-
-  /** Linked SSO provider accounts (AuthN) */
+  /** Linked SSO provider accounts (AuthN) - Single Source of Truth */
   accounts?: Record<string, LinkedAccount>;
 
-  /** Connected third-party resource provider tokens (AuthZ) */
+  /** Connected third-party resource provider tokens (AuthZ) - Single Source of Truth */
   resources?: Record<string, ConnectedResource>;
 
-  /** Full raw token response from provider */
-  raw: TRaw;
+  /** Optional primary access token or session token */
+  token?: string;
+
+  /** Optional current active auth provider */
+  provider?: string;
+
+  /** Optional raw token response from provider */
+  raw?: TRaw;
 }
 ```
 
@@ -371,10 +345,8 @@ export const lixa = new Lixa({
 ```json
 {
   "id": "e4a91f82c3b4a07f",
-  "token": "ya29.a0ARW5m7...",
   "userId": "1049281048",
   "email": "alex.developer@example.com",
-  "provider": "google",
   "accounts": {
     "google": {
       "provider": "google",
@@ -390,19 +362,6 @@ export const lixa = new Lixa({
       "accessToken": "gho_8f7b2a9e1c3...",
       "linkedAt": 1771657250000
     }
-  },
-  "resources": {
-    "github": {
-      "provider": "github",
-      "accessToken": "gho_resource_repo_9a8b7c...",
-      "scopes": ["repo", "read:org"],
-      "connectedAt": 1771657300000
-    }
-  },
-  "raw": {
-    "access_token": "ya29.a0ARW5m7...",
-    "token_type": "Bearer",
-    "expires_in": 3599
   }
 }
 ```
@@ -513,10 +472,8 @@ export const lixa = new Lixa({
   "ttl": 1771743600,
   "sessionData": {
     "id": "e4a91f82c3b4a07f",
-    "token": "ya29.a0ARW5m7...",
     "userId": "1049281048",
     "email": "alex.developer@example.com",
-    "provider": "google",
     "accounts": {
       "google": {
         "provider": "google",
@@ -532,22 +489,280 @@ export const lixa = new Lixa({
         "accessToken": "gho_8f7b2a9e1c3...",
         "linkedAt": 1771657250000
       }
-    },
-    "resources": {
-      "github": {
-        "provider": "github",
-        "accessToken": "gho_resource_repo_9a8b7c...",
-        "scopes": ["repo", "read:org"],
-        "connectedAt": 1771657300000
+    }
+  }
+}
+```
+
+---
+
+## Custom Resource Storage Implementation (`ResourceStorage`)
+
+While `SessionStorage` manages short-lived user authentication sessions (indexed by `sessionId`), **`ResourceStorage`** manages long-lived third-party API tokens (**AuthZ**) bound directly to a **User ID** (or Email). This ensures that third-party credentials (such as GitHub Repositories or Google Drive) persist across session expirations and logouts.
+
+### `ResourceStorage` Interface
+
+```typescript
+export interface ResourceStorage {
+  saveResource(userId: string, provider: string, resource: ConnectedResource): Promise<void>;
+  getResource(userId: string, provider: string): Promise<ConnectedResource | null>;
+  getUserResources(userId: string): Promise<Record<string, ConnectedResource>>;
+  deleteResource(userId: string, provider: string): Promise<void>;
+}
+```
+
+### 1. SQLite Resource Storage (`better-sqlite3`)
+
+#### Table Schema (SQL DDL)
+
+```sql
+CREATE TABLE IF NOT EXISTS user_resources (
+  user_id TEXT NOT NULL,
+  provider TEXT NOT NULL,
+  data TEXT NOT NULL,
+  updated_at INTEGER NOT NULL,
+  PRIMARY KEY (user_id, provider)
+);
+```
+
+#### TypeScript Implementation
+
+```typescript
+import Database from "better-sqlite3";
+import { Lixa, type ResourceStorage, type ConnectedResource } from "@vunexa/lixa";
+
+export class SqliteResourceStorage implements ResourceStorage {
+  private db = new Database("lixa_resources.db");
+
+  constructor() {
+    this.db.exec(`
+      CREATE TABLE IF NOT EXISTS user_resources (
+        user_id TEXT NOT NULL,
+        provider TEXT NOT NULL,
+        data TEXT NOT NULL,
+        updated_at INTEGER NOT NULL,
+        PRIMARY KEY (user_id, provider)
+      );
+    `);
+  }
+
+  async saveResource(userId: string, provider: string, resource: ConnectedResource): Promise<void> {
+    const stmt = this.db.prepare(`
+      INSERT INTO user_resources (user_id, provider, data, updated_at)
+      VALUES (?, ?, ?, ?)
+      ON CONFLICT(user_id, provider) DO UPDATE SET
+        data = excluded.data,
+        updated_at = excluded.updated_at
+    `);
+    stmt.run(userId, provider.toLowerCase(), JSON.stringify(resource), Date.now());
+  }
+
+  async getResource(userId: string, provider: string): Promise<ConnectedResource | null> {
+    const stmt = this.db.prepare(`SELECT data FROM user_resources WHERE user_id = ? AND provider = ?`);
+    const row = stmt.get(userId, provider.toLowerCase()) as { data: string } | undefined;
+    return row ? (JSON.parse(row.data) as ConnectedResource) : null;
+  }
+
+  async getUserResources(userId: string): Promise<Record<string, ConnectedResource>> {
+    const stmt = this.db.prepare(`SELECT provider, data FROM user_resources WHERE user_id = ?`);
+    const rows = stmt.all(userId) as Array<{ provider: string; data: string }>;
+    const result: Record<string, ConnectedResource> = {};
+    for (const r of rows) {
+      result[r.provider] = JSON.parse(r.data);
+    }
+    return result;
+  }
+
+  async deleteResource(userId: string, provider: string): Promise<void> {
+    const stmt = this.db.prepare(`DELETE FROM user_resources WHERE user_id = ? AND provider = ?`);
+    stmt.run(userId, provider.toLowerCase());
+  }
+}
+
+// Pass to Lixa instance via resourceHandler
+export const lixa = new Lixa({
+  resourceHandler: {
+    resourceStorage: new SqliteResourceStorage(),
+  },
+  providers: { /* ... */ },
+});
+```
+
+#### Saved JSON Records Example in SQLite (`user_resources` Table)
+
+**Row 1 (GitHub Repositories)**:
+```json
+{
+  "user_id": "1049281048",
+  "provider": "github",
+  "data": {
+    "accessToken": "gho_resource_repo_9a8b7c...",
+    "refreshToken": "ghr_refresh_token_123...",
+    "scopes": ["repo", "read:org"],
+    "expiresAt": 1771743600000,
+    "connectedAt": 1771657300000
+  }
+}
+```
+
+**Row 2 (Google Drive)**:
+```json
+{
+  "user_id": "1049281048",
+  "provider": "google",
+  "data": {
+    "accessToken": "ya29.drive_resource_token_456...",
+    "refreshToken": "1//09abc_google_refresh_token...",
+    "scopes": ["https://www.googleapis.com/auth/drive.readonly"],
+    "expiresAt": 1771660800000,
+    "connectedAt": 1771657400000
+  }
+}
+```
+
+---
+
+### 2. AWS DynamoDB Resource Storage (`@aws-sdk/lib-dynamodb`)
+
+For serverless AWS deployments storing user API credentials in DynamoDB:
+
+#### Table Configuration
+
+- **Table Name**: `LixaUserResources`
+- **Partition Key (PK)**: `userId` (String)
+- **Sort Key (SK)**: `provider` (String)
+
+#### TypeScript Implementation
+
+```typescript
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient, PutCommand, GetCommand, DeleteCommand, QueryCommand } from "@aws-sdk/lib-dynamodb";
+import { Lixa, type ResourceStorage, type ConnectedResource } from "@vunexa/lixa";
+
+export class DynamoDbResourceStorage implements ResourceStorage {
+  private docClient: DynamoDBDocumentClient;
+  private tableName = "LixaUserResources";
+
+  constructor() {
+    const client = new DynamoDBClient({ region: process.env.AWS_REGION || "us-east-1" });
+    this.docClient = DynamoDBDocumentClient.from(client);
+  }
+
+  async saveResource(userId: string, provider: string, resource: ConnectedResource): Promise<void> {
+    await this.docClient.send(
+      new PutCommand({
+        TableName: this.tableName,
+        Item: {
+          userId,
+          provider: provider.toLowerCase(),
+          resourceData: resource,
+          updatedAt: Date.now(),
+        },
+      })
+    );
+  }
+
+  async getResource(userId: string, provider: string): Promise<ConnectedResource | null> {
+    const res = await this.docClient.send(
+      new GetCommand({
+        TableName: this.tableName,
+        Key: {
+          userId,
+          provider: provider.toLowerCase(),
+        },
+      })
+    );
+
+    return res.Item ? (res.Item.resourceData as ConnectedResource) : null;
+  }
+
+  async getUserResources(userId: string): Promise<Record<string, ConnectedResource>> {
+    const res = await this.docClient.send(
+      new QueryCommand({
+        TableName: this.tableName,
+        KeyConditionExpression: "userId = :userId",
+        ExpressionAttributeValues: { ":userId": userId },
+      })
+    );
+
+    const result: Record<string, ConnectedResource> = {};
+    if (res.Items) {
+      for (const item of res.Items) {
+        result[item.provider] = item.resourceData as ConnectedResource;
       }
-    },
-    "raw": {
-      "access_token": "ya29.a0ARW5m7...",
-      "token_type": "Bearer",
-      "expires_in": 3599
     }
+    return result;
+  }
+
+  async deleteResource(userId: string, provider: string): Promise<void> {
+    await this.docClient.send(
+      new DeleteCommand({
+        TableName: this.tableName,
+        Key: {
+          userId,
+          provider: provider.toLowerCase(),
+        },
+      })
+    );
   }
 }
+
+// Pass to Lixa instance via resourceHandler
+export const lixa = new Lixa({
+  resourceHandler: {
+    resourceStorage: new DynamoDbResourceStorage(),
+  },
+  providers: { /* ... */ },
+});
+```
+
+#### Saved DynamoDB Resource Items Example (`LixaUserResources` Table)
+
+```json
+[
+  {
+    "userId": "1049281048",
+    "provider": "github",
+    "updatedAt": 1771657300000,
+    "resourceData": {
+      "accessToken": "gho_resource_repo_9a8b7c...",
+      "refreshToken": "ghr_refresh_token_123...",
+      "scopes": ["repo", "read:org"],
+      "expiresAt": 1771743600000,
+      "connectedAt": 1771657300000
+    }
+  },
+  {
+    "userId": "1049281048",
+    "provider": "google",
+    "updatedAt": 1771657400000,
+    "resourceData": {
+      "accessToken": "ya29.drive_resource_token_456...",
+      "refreshToken": "1//09abc_google_refresh_token...",
+      "scopes": ["https://www.googleapis.com/auth/drive.readonly"],
+      "expiresAt": 1771660800000,
+      "connectedAt": 1771657400000
+    }
+  }
+]
+```
+
+---
+
+### 3. Querying Connected Resources Directly by User ID
+
+`ResourceStorage` enables background workers, cron jobs, and webhooks to access third-party API credentials by `userId` without an active HTTP session:
+
+```typescript
+// Background worker querying user's GitHub Repos token
+const githubResource = await lixa.getUserResource(user.id, "github");
+
+if (githubResource) {
+  // Lixa auto-refreshes expired access tokens transparently!
+  const response = await fetch("https://api.github.com/user/repos", {
+    headers: { Authorization: `Bearer ${githubResource.accessToken}` },
+  });
+}
 ```
 
 ---