@absolutejs/auth 0.21.1 → 0.22.0

package/dist/src/authorize.d.ts

@@ -34,7 +34,7 @@ export declare const authorize: ({ clientProviders, authorizeRoute, onAuthorizeS
                     200: Response;
                     400: "Cookies are missing" | "Provider is required";
                     401: "Client provider not found";
-                    500: `${string} - ${string}` | `Unknown status: ${string}`;
+                    500: "Failed to create authorization URL";
                     422: {
                         type: "validation";
                         on: string;
@@ -63,7 +63,7 @@ export declare const authorize: ({ clientProviders, authorizeRoute, onAuthorizeS
                         200: Response;
                         400: "Cookies are missing" | "Provider is required";
                         401: "Client provider not found";
-                        500: `${string} - ${string}` | `Unknown status: ${string}`;
+                        500: "Failed to create authorization URL";
                         422: {
                             type: "validation";
                             on: string;

package/dist/src/callback.d.ts

@@ -35,7 +35,7 @@ export declare const callback: <UserType>({ clientProviders, callbackRoute, onCa
                 200: any;
                 400: "Cookies are missing" | "Invalid callback request" | "Invalid state mismatch" | "Code verifier not found and is required";
                 401: "Client provider not found";
-                500: `${string} - ${string}` | `Failed to validate authorization code: Unknown status: ${string}`;
+                500: "Failed to validate authorization code";
                 422: {
                     type: "validation";
                     on: string;

package/dist/src/constants.d.ts

@@ -7,3 +7,4 @@ export declare const MILLISECONDS_IN_A_DAY: number;
 export declare const MILLISECONDS_IN_AN_HOUR: number;
 export declare const COOKIE_MINUTES = 30;
 export declare const COOKIE_DURATION: number;
+export declare const DEFAULT_MAX_SESSIONS = 10000;

package/dist/src/index.d.ts

@@ -1,12 +1,13 @@
 import { Elysia } from 'elysia';
 import { AbsoluteAuthProps } from './types';
-export declare const absoluteAuth: <UserType>({ providersConfiguration, authorizeRoute, callbackRoute, profileRoute, signoutRoute, statusRoute, refreshRoute, revokeRoute, onAuthorizeSuccess, onAuthorizeError, onProfileSuccess, onProfileError, onCallbackSuccess, onCallbackError, onStatus, onRefreshSuccess, onRefreshError, onSignOut, onRevocationSuccess, onRevocationError }: AbsoluteAuthProps<UserType>) => Promise<Elysia<"", {
+export declare const absoluteAuth: <UserType>({ providersConfiguration, authorizeRoute, callbackRoute, profileRoute, signoutRoute, statusRoute, refreshRoute, revokeRoute, cleanupIntervalMs, maxSessions, sessionDurationMs, onAuthorizeSuccess, onAuthorizeError, onProfileSuccess, onProfileError, onCallbackSuccess, onCallbackError, onStatus, onRefreshSuccess, onRefreshError, onSignOut, onRevocationSuccess, onRevocationError, onSessionCleanup }: AbsoluteAuthProps<UserType>) => Promise<Elysia<"", {
     decorator: {};
     store: {
         session: import("./types").SessionRecord<UserType> & import("./types").SessionRecord<unknown>;
         unregisteredSession: import("./types").UnregisteredSessionRecord;
     };
     derive: {
+        readonly cleanupSessions: () => Promise<void>;
         readonly protectRoute: <AuthReturn, AuthFailReturn>(handleAuth: (user: UserType) => AuthReturn, handleAuthFail?: ((error: {
             readonly code: "Bad Request";
             readonly message: "Cookies are missing";
@@ -45,7 +46,7 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
                 200: Response;
                 400: "Cookies are missing";
                 401: "No auth provider found" | "No user session id found";
-                500: `Error: ${string} - ${string}` | `Unknown Error: ${string}`;
+                500: "Sign out operation failed";
                 422: {
                     type: "validation";
                     on: string;
@@ -70,7 +71,7 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
                 400: "Cookies are missing" | "Invalid provider";
                 401: "Client provider not found" | "No auth provider found" | "No user session found";
                 501: "Provider does not support revocation";
-                500: `Failed to revoke token: ${string}` | `Failed to revoke token: Unknown status: ${string}`;
+                500: "Failed to revoke token";
                 422: {
                     type: "validation";
                     on: string;
@@ -129,7 +130,7 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
                 400: "Cookies are missing" | "Invalid provider" | "No refresh token found";
                 401: "Client provider not found" | "No auth provider found" | "No user session found";
                 501: "Provider is not refreshable";
-                500: `Failed to refresh token: ${string}` | `Failed to refresh token: Unknown status: ${string}`;
+                500: "Failed to refresh token";
                 422: {
                     type: "validation";
                     on: string;
@@ -156,7 +157,7 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
                     200: Response;
                     400: "Cookies are missing" | "Provider is required";
                     401: "Client provider not found";
-                    500: `${string} - ${string}` | `Unknown status: ${string}`;
+                    500: "Failed to create authorization URL";
                     422: {
                         type: "validation";
                         on: string;
@@ -185,7 +186,7 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
                         200: Response;
                         400: "Cookies are missing" | "Provider is required";
                         401: "Client provider not found";
-                        500: `${string} - ${string}` | `Unknown status: ${string}`;
+                        500: "Failed to create authorization URL";
                         422: {
                             type: "validation";
                             on: string;
@@ -212,7 +213,7 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
                 200: any;
                 400: "Cookies are missing" | "Invalid callback request" | "Invalid state mismatch" | "Code verifier not found and is required";
                 401: "Client provider not found";
-                500: `${string} - ${string}` | `Failed to validate authorization code: Unknown status: ${string}`;
+                500: "Failed to validate authorization code";
                 422: {
                     type: "validation";
                     on: string;
@@ -262,9 +263,10 @@ export declare const absoluteAuth: <UserType>({ providersConfiguration, authoriz
 }>>;
 export * from './types';
 export * from './typebox';
-export { isValidUser } from './typeGuards';
+export { isUserSessionId, isValidUser } from './typeGuards';
 export { sessionStore } from './sessionStore';
-export { protectRoute } from './protectRoute';
+export { protectRoutePlugin } from './protectRoute';
+export { sessionCleanup } from './sessionCleanup';
 export * from './utils';
 export type { OAuth2TokenResponse, OAuth2Client, ProviderOption, PKCEProvider, OIDCProvider, RefreshableProvider, RevocableProvider, ScopeRequiredProvider, ProvidersMap, ProviderConfiguration, CredentialsFor } from 'citra';
 export { providers, providerOptions, refreshableProviderOptions, revocableProviderOptions, oidcProviderOptions, pkceProviderOptions, scopeRequiredProviderOptions, decodeJWT, extractPropFromIdentity, isValidProviderOption, isRefreshableOAuth2Client, isRefreshableProviderOption, isOIDCProviderOption, isPKCEProviderOption, isRevocableProviderOption, isRevocableOAuth2Client } from 'citra';

package/dist/src/protectRoute.d.ts

@@ -4,7 +4,7 @@ type AuthFailError = Exclude<Awaited<ReturnType<typeof getStatus>>['error'], nul
     readonly code: 'Unauthorized';
     readonly message: 'User is not authenticated';
 };
-export declare const protectRoute: <UserType>() => Elysia<"", {
+export declare const protectRoutePlugin: <UserType>() => Elysia<"", {
     decorator: {};
     store: {
         session: import("./types").SessionRecord<UserType>;

package/dist/src/refresh.d.ts

@@ -5,8 +5,9 @@ type RefreshProps = {
     refreshRoute?: RouteString;
     onRefreshSuccess: OnRefreshSuccess;
     onRefreshError: OnRefreshError;
+    sessionDurationMs?: number;
 };
-export declare const refresh: <UserType>({ clientProviders, refreshRoute, onRefreshSuccess, onRefreshError }: RefreshProps) => Elysia<"", {
+export declare const refresh: <UserType>({ clientProviders, refreshRoute, onRefreshSuccess, onRefreshError, sessionDurationMs }: RefreshProps) => Elysia<"", {
     decorator: {};
     store: {
         session: import("./types").SessionRecord<UserType>;
@@ -35,7 +36,7 @@ export declare const refresh: <UserType>({ clientProviders, refreshRoute, onRefr
                 400: "Cookies are missing" | "Invalid provider" | "No refresh token found";
                 401: "Client provider not found" | "No auth provider found" | "No user session found";
                 501: "Provider is not refreshable";
-                500: `Failed to refresh token: ${string}` | `Failed to refresh token: Unknown status: ${string}`;
+                500: "Failed to refresh token";
                 422: {
                     type: "validation";
                     on: string;

package/dist/src/revoke.d.ts

@@ -35,7 +35,7 @@ export declare const revoke: <UserType>({ clientProviders, revokeRoute, onRevoca
                 400: "Cookies are missing" | "Invalid provider";
                 401: "Client provider not found" | "No auth provider found" | "No user session found";
                 501: "Provider does not support revocation";
-                500: `Failed to revoke token: ${string}` | `Failed to revoke token: Unknown status: ${string}`;
+                500: "Failed to revoke token";
                 422: {
                     type: "validation";
                     on: string;

package/dist/src/sessionCleanup.d.ts

@@ -0,0 +1,38 @@
+import { Elysia } from 'elysia';
+import { OnSessionCleanup, SessionRecord, UnregisteredSessionRecord } from './types';
+type SessionCleanupProps<UserType> = {
+    cleanupIntervalMs?: number;
+    maxSessions?: number;
+    onSessionCleanup?: OnSessionCleanup<UserType>;
+};
+export declare const sessionCleanup: <UserType>({ cleanupIntervalMs, maxSessions, onSessionCleanup }: SessionCleanupProps<UserType>) => Elysia<"", {
+    decorator: {};
+    store: {
+        session: SessionRecord<UserType>;
+        unregisteredSession: UnregisteredSessionRecord;
+    };
+    derive: {
+        readonly cleanupSessions: () => Promise<void>;
+    };
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: import("elysia").MergeSchema<import("elysia").MergeSchema<{}, {}, "">, {}, "">;
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+}, {}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+}>;
+export {};

package/dist/src/signout.d.ts

@@ -32,7 +32,7 @@ export declare const signout: <UserType>({ signoutRoute, onSignOut }: SignOutPro
                 200: Response;
                 400: "Cookies are missing";
                 401: "No auth provider found" | "No user session id found";
-                500: `Error: ${string} - ${string}` | `Unknown Error: ${string}`;
+                500: "Sign out operation failed";
                 422: {
                     type: "validation";
                     on: string;

package/dist/src/typeGuards.d.ts

@@ -1,4 +1,5 @@
-import { StatusReturn } from './types';
+import { StatusReturn, UserSessionId } from './types';
 export declare const isValidUser: <UserType>(user: unknown) => user is UserType;
+export declare const isUserSessionId: (key: string) => key is UserSessionId;
 export declare const isNonEmptyString: (str: string | null | undefined) => str is string;
 export declare const isStatusResponse: (value: unknown) => value is StatusReturn;

package/dist/src/types.d.ts

@@ -12,19 +12,21 @@ export type OAuth2ConfigurationOptions = {
     });
 };
 export type UserSessionId = `${string}-${string}-${string}-${string}-${string}`;
-export type SessionRecord<UserType> = Record<UserSessionId, {
+export type SessionData<UserType> = {
     user: UserType;
     accessToken: string;
     refreshToken?: string;
     expiresAt: number;
-}>;
-export type UnregisteredSessionRecord = Record<UserSessionId, {
+};
+export type SessionRecord<UserType> = Record<UserSessionId, SessionData<UserType>>;
+export type UnregisteredSessionData = {
     userIdentity?: Record<string, unknown>;
     sessionInformation?: Record<string, unknown>;
     expiresAt: number;
     accessToken?: string;
     refreshToken?: string;
-}>;
+};
+export type UnregisteredSessionRecord = Record<UserSessionId, UnregisteredSessionData>;
 export type StatusReturn = ElysiaCustomStatusResponse<any, any, any>;
 export type OnNewUser<UserType> = (userIdentity: Record<string, unknown>) => UserType | StatusReturn | Response | Promise<UserType | StatusReturn | Response>;
 export type GetUser<UserType> = (userIdentity: Record<string, unknown>) => UserType | null | undefined | Promise<UserType | null | undefined>;
@@ -88,6 +90,10 @@ export type OnSignOut<UserType> = (({ authProvider, userSessionId, session }: {
     userSessionId: UserSessionId;
     session: SessionRecord<UserType>;
 }) => void | Promise<void>) | undefined;
+export type OnSessionCleanup<UserType> = (({ removedSessions, removedUnregisteredSessions }: {
+    removedSessions: Map<UserSessionId, SessionData<UserType>>;
+    removedUnregisteredSessions: Map<UserSessionId, UnregisteredSessionData>;
+}) => void | Promise<void>) | undefined;
 export type RouteString = `/${string}`;
 export type AuthorizeRoute = `${string}/:provider${'' | `/${string}`}`;
 export type AbsoluteAuthProps<UserType> = {
@@ -99,6 +105,10 @@ export type AbsoluteAuthProps<UserType> = {
     revokeRoute?: RouteString;
     signoutRoute?: RouteString;
     statusRoute?: RouteString;
+    cleanupIntervalMs?: number;
+    maxSessions?: number;
+    sessionDurationMs?: number;
+    unregisteredSessionDurationMs?: number;
     onAuthorizeSuccess?: OnAuthorizeSuccess;
     onAuthorizeError?: OnAuthorizeError;
     onCallbackSuccess?: OnCallbackSuccess<UserType>;
@@ -111,6 +121,7 @@ export type AbsoluteAuthProps<UserType> = {
     onRevocationError?: OnRevocationError;
     onProfileSuccess?: OnProfileSuccess;
     onProfileError?: OnProfileError;
+    onSessionCleanup?: OnSessionCleanup<UserType>;
 };
 export type ClientProviders = Record<string, {
     providerInstance: OAuth2Client<ProviderOption>;
@@ -126,4 +137,6 @@ export type InsantiateUserSessionProps<UserType> = {
     user_session_id: Cookie<UserSessionId | undefined>;
     onNewUser: OnNewUser<UserType>;
     getUser: GetUser<UserType>;
+    sessionDurationMs?: number;
+    unregisteredSessionDurationMs?: number;
 };

package/dist/src/utils.d.ts

@@ -1,6 +1,6 @@
 import { Cookie } from 'elysia';
-import { AbsoluteAuthProps, InsantiateUserSessionProps, OAuth2ConfigurationOptions, SessionRecord, UserSessionId } from './types';
-export declare const instantiateUserSession: <UserType>({ authProvider, session, user_session_id, unregisteredSession, tokenResponse, providerInstance, getUser, onNewUser }: InsantiateUserSessionProps<UserType>) => Promise<import("./types").StatusReturn | Response | undefined>;
+import { AbsoluteAuthProps, InsantiateUserSessionProps, OAuth2ConfigurationOptions, SessionRecord, UnregisteredSessionRecord, UserSessionId } from './types';
+export declare const instantiateUserSession: <UserType>({ authProvider, session, user_session_id, unregisteredSession, tokenResponse, providerInstance, getUser, onNewUser, sessionDurationMs, unregisteredSessionDurationMs }: InsantiateUserSessionProps<UserType>) => Promise<import("./types").StatusReturn | Response | undefined>;
 export declare const createAuthConfiguration: <UserType>(configuration: AbsoluteAuthProps<UserType>) => AbsoluteAuthProps<UserType>;
 export declare const createProvidersConfiguration: (providersConfiguration: OAuth2ConfigurationOptions) => OAuth2ConfigurationOptions;
 export declare const getStatus: <UserType>(session: SessionRecord<UserType>, user_session_id: Cookie<UserSessionId | undefined>) => Promise<{
@@ -22,5 +22,10 @@ type ValidateSessionProps<SessionType extends Record<string, unknown> & {
 export declare const validateSession: <SessionType extends Record<string, unknown> & {
     expiresAt: number;
 }>({ user_session_id, session }: ValidateSessionProps<SessionType>) => SessionType | undefined;
-export declare const getUserSessionId: (user_session_id: Cookie<`${string}-${string}-${string}-${string}-${string}` | undefined>) => `${string}-${string}-${string}-${string}-${string}`;
+type GetUserSessionIdProps<UserType> = {
+    user_session_id: Cookie<UserSessionId | undefined>;
+    session?: SessionRecord<UserType>;
+    unregisteredSession?: UnregisteredSessionRecord;
+};
+export declare const getUserSessionId: <UserType>({ user_session_id, session, unregisteredSession }: GetUserSessionIdProps<UserType>) => `${string}-${string}-${string}-${string}-${string}`;
 export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "0.21.1",
+	"version": "0.22.0",
 	"name": "@absolutejs/auth",
 	"description": "An authorization library for absolutejs",
 	"repository": {