@interfere/next 0.0.9 → 0.0.11

package/dist/session/session-manager.d.ts

@@ -0,0 +1,126 @@
+import type { Config } from "@interfere/schemas/config";
+import type { SurfaceId } from "@interfere/schemas/surface";
+import type { InterferePersistence } from "./persistence.js";
+/**
+ * Clock type for dependency injection and testability
+ */
+export type Clock = {
+    now(): number;
+    setTimeout(callback: () => void, delay: number): ReturnType<typeof setTimeout>;
+    clearTimeout(timeoutId: ReturnType<typeof setTimeout>): void;
+};
+/**
+ * Reasons why a session ID might change
+ */
+export declare const SessionChangeReason: {
+    readonly NO_SESSION_ID: "noSessionId";
+    readonly ACTIVITY_TIMEOUT: "activityTimeout";
+    readonly SESSION_PAST_MAXIMUM_LENGTH: "sessionPastMaximumLength";
+};
+/**
+ * Change reasons for session updates
+ */
+export type ChangeReasons = {
+    [SessionChangeReason.NO_SESSION_ID]?: boolean;
+    [SessionChangeReason.ACTIVITY_TIMEOUT]?: boolean;
+    [SessionChangeReason.SESSION_PAST_MAXIMUM_LENGTH]?: boolean;
+};
+/**
+ * Callback function called when session ID changes
+ * @param sessionId - The new session ID (null when session is reset)
+ * @param windowId - The window ID associated with this session
+ * @param changeReason - Reasons why the session changed
+ */
+export type SessionIdChangedCallback = (sessionId: string | null, windowId: string | null, changeReason?: ChangeReasons) => void;
+type SessionData = {
+    sessionId: string;
+    windowId: string | null;
+    sessionStartTimestamp: number;
+    lastActivityTimestamp: number;
+};
+/**
+ * Manages session and window IDs with automatic timeout and persistence
+ */
+export declare class SessionIdManager {
+    private readonly _sessionIdGenerator;
+    private readonly _windowIdGenerator;
+    private readonly _config;
+    private readonly _persistence;
+    private readonly _clock;
+    private _windowId;
+    private _sessionId;
+    private readonly _windowIdStorageKey;
+    private readonly _primaryWindowExistsStorageKey;
+    private _sessionStartTimestamp;
+    private _sessionActivityTimestamp;
+    private _sessionIdChangedHandlers;
+    private readonly _sessionTimeoutMs;
+    private _enforceIdleTimeout;
+    private _canUseSessionStorageCache;
+    private _lastStorageCheck;
+    private _beforeUnloadHandler;
+    private _pageHideHandler;
+    private _visibilityChangeHandler;
+    private _heartbeatInterval;
+    private heartbeatPaused;
+    private readonly _debugLogger?;
+    /**
+     * Creates a new SessionIdManager
+     * @param surface - The surface ID for storage key namespacing
+     * @param config - Configuration options
+     * @param persistence - Persistence layer for storing session data
+     * @param options - Optional generators and clock for testing
+     */
+    constructor(surface: SurfaceId, config: Partial<Config>, persistence: InterferePersistence, options?: {
+        sessionId?: () => string;
+        windowId?: () => string;
+        clock?: Clock;
+        debugLogger?: (message: string, error?: Error) => void;
+    });
+    get sessionTimeoutMs(): number;
+    /**
+     * Register a callback to be called when the session ID changes
+     * @param callback - Function to call when session changes
+     * @returns Unsubscribe function
+     */
+    onSessionId(callback: SessionIdChangedCallback): () => void;
+    private _debugLog;
+    private _canUseSessionStorage;
+    private _cleanupStaleWindowFlags;
+    private _startWindowHeartbeat;
+    private _setWindowId;
+    private _getWindowId;
+    private _setSessionId;
+    private _persistSessionWithOptimisticLocking;
+    private _getSessionId;
+    private _parseSessionIdInfo;
+    /**
+     * Reset the current session, forcing a new session to be created on next access
+     * @param reason - Optional reason for the reset
+     */
+    resetSessionId(reason?: ChangeReasons): void;
+    private _performWindowCleanup;
+    private _listenToReloadWindow;
+    private _sessionHasBeenIdleTooLong;
+    /**
+     * Check and get the current session and window IDs, updating them if necessary
+     * @param readOnly - If true, won't update activity timestamp or reset idle timer
+     * @param _timestamp - Optional timestamp override (primarily for testing)
+     * @returns Session data with optional change reason
+     */
+    checkAndGetSessionAndWindowId(readOnly?: boolean, _timestamp?: number | null): SessionData & {
+        changeReason?: ChangeReasons;
+    };
+    private _evaluateSessionChangeReasons;
+    private _updateSessionIfNeeded;
+    private _calculateActivityTimestamp;
+    private _finalizeSessionUpdate;
+    private _resetIdleTimer;
+    /**
+     * Clean up resources and event listeners
+     * Call this when the SessionIdManager is no longer needed
+     */
+    dispose(): void;
+}
+export {};
+//# sourceMappingURL=session-manager.d.ts.map

package/dist/session/session-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-manager.d.ts","sourceRoot":"","sources":["../../src/session/session-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAW5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,GAAG,IAAI,MAAM,CAAC;IACd,UAAU,CACR,QAAQ,EAAE,MAAM,IAAI,EACpB,KAAK,EAAE,MAAM,GACZ,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IACjC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;CAC9D,CAAC;AAWF;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;CAItB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,EAAE,OAAO,CAAC;IAC9C,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,EAAE,OAAO,CAAC;IACjD,CAAC,mBAAmB,CAAC,2BAA2B,CAAC,CAAC,EAAE,OAAO,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,YAAY,CAAC,EAAE,aAAa,KACzB,IAAI,CAAC;AAEV,KAAK,WAAW,GAAG;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAcF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAe;IACnD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAe;IAClD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuB;IACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,SAAS,CAA4B;IAC7C,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAC7C,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAS;IACxD,OAAO,CAAC,sBAAsB,CAAgB;IAC9C,OAAO,CAAC,yBAAyB,CAAgB;IACjD,OAAO,CAAC,yBAAyB,CAAkC;IACnE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,mBAAmB,CAA4C;IACvE,OAAO,CAAC,0BAA0B,CAAwB;IAC1D,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,oBAAoB,CAA6B;IACzD,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,wBAAwB,CAA6B;IAC7D,OAAO,CAAC,kBAAkB,CAA+C;IACzE,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAA2C;IAEzE;;;;;;OAMG;gBAED,OAAO,EAAE,SAAS,EAClB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EACvB,WAAW,EAAE,oBAAoB,EACjC,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,MAAM,CAAC;QACxB,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;KACxD;IA6EH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,wBAAwB,GAAG,MAAM,IAAI;IAqB3D,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,wBAAwB;IAwChC,OAAO,CAAC,qBAAqB;IAwC7B,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,aAAa;IAsBrB,OAAO,CAAC,oCAAoC;IAoD5C,OAAO,CAAC,aAAa;IAkBrB,OAAO,CAAC,mBAAmB;IA2D3B;;;OAGG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI;IAY5C,OAAO,CAAC,qBAAqB;IAkC7B,OAAO,CAAC,qBAAqB;IA+C7B,OAAO,CAAC,0BAA0B;IAgBlC;;;;;OAKG;IACH,6BAA6B,CAC3B,QAAQ,UAAQ,EAChB,UAAU,GAAE,MAAM,GAAG,IAAW,GAC/B,WAAW,GAAG;QACf,YAAY,CAAC,EAAE,aAAa,CAAC;KAC9B;IAyCD,OAAO,CAAC,6BAA6B;IAqBrC,OAAO,CAAC,sBAAsB;IA2C9B,OAAO,CAAC,2BAA2B;IAsCnC,OAAO,CAAC,sBAAsB;IAsF9B,OAAO,CAAC,eAAe;IA6CvB;;;OAGG;IACH,OAAO,IAAI,IAAI;CAmChB"}