@plyaz/types 1.27.10 → 1.27.11

package/dist/auth/types.d.ts

@@ -1050,3 +1050,118 @@ export interface PermissionCheckerConfig {
     /** Enable audit logging */
     enableAuditLog: boolean;
 }
+/**
+ * @fileoverview Session store interface for @plyaz/auth
+ * @module @plyaz/auth/session/session-store
+ *
+ * @description
+ * Defines the interface for session storage implementations.
+ * Provides abstraction over different storage backends (cookie, memory, Redis)
+ * enabling flexible session management strategies. All session stores must
+ * implement this interface for consistent behavior across the auth system.
+ *
+ * @example
+ * ```typescript
+ * import { SessionStore, CookieStore } from '@plyaz/auth';
+ *
+ * const store: SessionStore = new CookieStore();
+ * await store.set('session_123', sessionData, 3600);
+ * const session = await store.get('session_123');
+ * ```
+ */
+/**
+ * Session data interface for storage
+ * Contains session information and metadata
+ */
+export interface SessionData {
+    /** Session ID */
+    id: string;
+    /** User ID */
+    userId: string;
+    /** Session expiration timestamp */
+    expiresAt: Date;
+    /** Session creation timestamp */
+    createdAt: Date;
+    /** Last activity timestamp */
+    lastActivityAt: Date;
+    /** IP address */
+    ipAddress?: string;
+    /** User agent string */
+    userAgent?: string;
+    /** Additional session metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Session store interface
+ * Defines contract for session storage implementations
+ */
+export interface SessionStore {
+    /**
+     * Store session data
+     * @param sessionId - Unique session identifier
+     * @param data - Session data to store
+     * @param ttlSeconds - Time to live in seconds
+     * @returns Promise that resolves when session is stored
+     */
+    set(sessionId: string, data: SessionData, ttlSeconds: number): Promise<void>;
+    /**
+     * Retrieve session data
+     * @param sessionId - Session identifier
+     * @returns Promise that resolves to session data or null if not found
+     */
+    get(sessionId: string): Promise<SessionData | null>;
+    /**
+     * Delete session data
+     * @param sessionId - Session identifier
+     * @returns Promise that resolves when session is deleted
+     */
+    delete(sessionId: string): Promise<void>;
+    /**
+     * Delete all sessions for a user
+     * @param userId - User identifier
+     * @returns Promise that resolves to number of deleted sessions
+     */
+    deleteByUserId(userId: string): Promise<number>;
+    /**
+     * Update session activity timestamp
+     * @param sessionId - Session identifier
+     * @returns Promise that resolves when activity is updated
+     */
+    updateActivity(sessionId: string): Promise<void>;
+    /**
+     * Check if session exists
+     * @param sessionId - Session identifier
+     * @returns Promise that resolves to true if session exists
+     */
+    exists(sessionId: string): Promise<boolean>;
+    /**
+     * Get all active sessions for a user
+     * @param userId - User identifier
+     * @returns Promise that resolves to array of session data
+     */
+    getByUserId(userId: string): Promise<SessionData[]>;
+    /**
+     * Clean up expired sessions
+     * @returns Promise that resolves to number of cleaned sessions
+     */
+    cleanup(): Promise<number>;
+    /**
+     * Get session count for a user
+     * @param userId - User identifier
+     * @returns Promise that resolves to session count
+     */
+    getSessionCount(userId: string): Promise<number>;
+}
+/**
+ * Session store configuration interface
+ */
+export interface SessionStoreConfig {
+    /** Default TTL in seconds */
+    defaultTTL: number;
+    /** Maximum sessions per user */
+    maxSessionsPerUser: number;
+    /** Cleanup interval in seconds */
+    cleanupInterval: number;
+    /** Key prefix for storage */
+    keyPrefix: string;
+}