@absolutejs/auth 0.56.3 → 0.56.5

package/dist/session/promote.d.ts

@@ -0,0 +1,23 @@
+import type { Cookie } from 'elysia';
+import type { SessionData, SessionRecord, UserSessionId } from '../types';
+import type { AuthSessionStore } from './types';
+type ClearSessionProps<UserType> = {
+    authSessionStore?: AuthSessionStore<UserType>;
+    cookie: Cookie<UserSessionId | undefined>;
+    inMemorySession: SessionRecord<UserType>;
+};
+export declare const clearSession: <UserType>({ authSessionStore, cookie, inMemorySession }: ClearSessionProps<UserType>) => Promise<void>;
+export declare const persistWhen: (shouldPersist: boolean, persist: () => Promise<void>) => Promise<void>;
+type PromoteToSessionProps<UserType> = {
+    anonymous?: boolean;
+    authSessionStore?: AuthSessionStore<UserType>;
+    cookie: Cookie<UserSessionId | undefined>;
+    cookieSecure?: boolean;
+    impersonator?: SessionData<UserType>['impersonator'];
+    inMemorySession: SessionRecord<UserType>;
+    samlLogout?: SessionData<UserType>['samlLogout'];
+    sessionDurationMs: number;
+    user: UserType;
+};
+export declare const promoteToSession: <UserType>({ anonymous, authSessionStore, cookie, cookieSecure, impersonator, inMemorySession, samlLogout, sessionDurationMs, user }: PromoteToSessionProps<UserType>) => Promise<`${string}-${string}-${string}-${string}-${string}`>;
+export {};

package/dist/session/redisStore.d.ts

@@ -0,0 +1,6 @@
+import type { RedisLike } from '../stores/redis';
+import type { AuthSessionStore } from './types';
+export type RedisSessionClient = RedisLike & {
+    keys: (pattern: string) => Promise<string[]>;
+};
+export declare const createRedisAuthSessionStore: <UserType>(redis: RedisSessionClient, keyPrefix?: string) => AuthSessionStore<UserType>;

package/dist/session/sessionsConfig.d.ts

@@ -0,0 +1,9 @@
+import type { RouteString } from '../types';
+import type { AuthSessionStore } from './types';
+export type SessionsConfig<UserType> = {
+    getUserId: (user: UserType) => string;
+    sessionsRoute?: RouteString;
+};
+export type SessionsRouteProps<UserType> = SessionsConfig<UserType> & {
+    authSessionStore?: AuthSessionStore<UserType>;
+};

package/dist/session/state.d.ts

@@ -0,0 +1,33 @@
+import { Elysia } from 'elysia';
+import type { SessionRecord, UnregisteredSessionRecord } from '../types';
+export declare const sessionStore: <UserType>() => Elysia<"", {
+    decorator: {};
+    store: {
+        session: SessionRecord<UserType>;
+        unregisteredSession: UnregisteredSessionRecord;
+    };
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}>;

package/dist/session/types.d.ts

@@ -0,0 +1,21 @@
+import type { SessionData, UnregisteredSessionData, UserSessionId } from '../types';
+export type AuthSessionStore<UserType> = {
+    getSession: (id: UserSessionId) => Promise<SessionData<UserType> | undefined>;
+    setSession: (id: UserSessionId, value: SessionData<UserType>) => Promise<void>;
+    removeSession: (id: UserSessionId) => Promise<void>;
+    getUnregisteredSession: (id: UserSessionId) => Promise<UnregisteredSessionData | undefined>;
+    setUnregisteredSession: (id: UserSessionId, value: UnregisteredSessionData) => Promise<void>;
+    removeUnregisteredSession: (id: UserSessionId) => Promise<void>;
+    listSessionIds?: () => Promise<UserSessionId[]>;
+    listUnregisteredSessionIds?: () => Promise<UserSessionId[]>;
+    /**
+     * Optional fast-path the periodic cleanup prefers over loading every session
+     * to check expiry: a backing store (e.g. SQL) deletes all rows past their
+     * expiry in one indexed statement and returns how many it removed. When a
+     * store provides this, cleanup skips the `listSessionIds` + per-id load
+     * storm entirely. (Per-user session caps stay a creation-time concern.)
+     */
+    deleteExpired?: () => Promise<number>;
+    deleteExpiredUnregistered?: () => Promise<number>;
+};
+export type AuthSessionSource<UserType> = Pick<AuthSessionStore<UserType>, 'getSession' | 'removeSession'>;

package/dist/session/userSessions.d.ts

@@ -0,0 +1,19 @@
+import type { SessionData, UserSessionId } from '../types';
+import type { AuthSessionStore } from './types';
+export type UserSession<UserType> = {
+    id: UserSessionId;
+    session: SessionData<UserType>;
+};
+type ListUserSessionsProps<UserType> = {
+    authSessionStore: AuthSessionStore<UserType>;
+    getUserId: (user: UserType) => string;
+    userId: string;
+};
+export declare const listUserSessions: <UserType>({ authSessionStore, getUserId, userId }: ListUserSessionsProps<UserType>) => Promise<UserSession<UserType>[]>;
+export declare const refreshUserSessions: <UserType>({ authSessionStore, getUserId, user, userId }: ListUserSessionsProps<UserType> & {
+    user: UserType;
+}) => Promise<number>;
+export declare const revokeUserSessions: <UserType>({ authSessionStore, exceptSessionId, getUserId, userId }: ListUserSessionsProps<UserType> & {
+    exceptSessionId?: UserSessionId;
+}) => Promise<number>;
+export {};

package/dist/sso/config.d.ts

@@ -0,0 +1,149 @@
+import type { OAuth2TokenResponse, OIDCIdTokenClaims } from 'citra';
+import type { OrganizationId } from '../tenancy';
+import type { RouteString, UserSessionId } from '../types';
+import type { OidcConnection, SamlConnection, SSOConnectionStore } from './types';
+export declare const DEFAULT_SSO_ROUTE = "/sso";
+export declare const DEFAULT_SSO_SESSION_TTL_MS: number;
+export type SamlProfile = {
+    attributes: Record<string, unknown>;
+    email?: string;
+    nameId: string;
+    sessionIndex?: string;
+};
+type SamlAuthorizeRequest = {
+    acsUrl: string;
+    connection: SamlConnection;
+    relayState?: string;
+};
+type SamlAssertionRequest = {
+    acsUrl: string;
+    connection: SamlConnection;
+    relayState?: string;
+    samlResponse: string;
+};
+type SamlMetadataRequest = {
+    acsUrl: string;
+    connection: SamlConnection;
+    sloUrl?: string;
+};
+type SamlLogoutRequest = {
+    connection: SamlConnection;
+    nameId: string;
+    relayState?: string;
+    sessionIndex?: string;
+    sloUrl: string;
+};
+type SamlLogoutResponseRequest = {
+    connection: SamlConnection;
+    relayState?: string;
+    samlResponse: string;
+    signature?: string;
+    signatureAlgorithm?: string;
+    signedQueryString?: string;
+    sloUrl: string;
+};
+type SamlIdpLogoutRequest = {
+    connection: SamlConnection;
+    relayState?: string;
+    samlRequest: string;
+    signature?: string;
+    signatureAlgorithm?: string;
+    signedQueryString?: string;
+    sloUrl: string;
+};
+type SamlLogoutResponseAck = {
+    connection: SamlConnection;
+    inResponseTo?: string;
+    nameId?: string;
+    relayState?: string;
+    sloUrl: string;
+};
+export type SamlLogoutInfo = {
+    nameId?: string;
+    relayState?: string;
+    requestId?: string;
+    sessionIndex?: string;
+};
+export type SamlAuthnRequestInfo = {
+    acsUrl?: string;
+    forceAuthn?: boolean;
+    id: string;
+    issuer: string;
+    relayState?: string;
+};
+export type SamlIdpResponseRequest = {
+    acsUrl: string;
+    attributes?: Record<string, unknown>;
+    audience: string;
+    idpEntityId: string;
+    inResponseTo?: string;
+    nameId: string;
+    nameIdFormat?: string;
+    relayState?: string;
+    sessionIndex: string;
+};
+export type SamlIdpAdapter = {
+    buildAutoPostForm: (input: {
+        acsUrl: string;
+        relayState?: string;
+        samlResponse: string;
+    }) => string;
+    createSamlResponse: (request: SamlIdpResponseRequest) => Promise<string> | string;
+    getIdpMetadata: (input: {
+        entityId: string;
+        ssoUrl: string;
+    }) => Promise<string> | string;
+    parseAuthnRequest: (input: {
+        binding: 'POST' | 'Redirect';
+        samlRequest: string;
+        serviceProvider?: import('./types').SamlServiceProvider;
+        signature?: string;
+        signatureAlgorithm?: string;
+        signedQueryString?: string;
+    }) => Promise<SamlAuthnRequestInfo> | SamlAuthnRequestInfo;
+};
+export type SamlAdapter = {
+    createAuthorizationUrl: (request: SamlAuthorizeRequest) => Promise<string> | string;
+    createLogoutRequestUrl?: (request: SamlLogoutRequest) => Promise<string> | string;
+    createLogoutResponseUrl?: (request: SamlLogoutResponseAck) => Promise<string> | string;
+    getServiceProviderMetadata: (request: SamlMetadataRequest) => Promise<string> | string;
+    validateAssertion: (request: SamlAssertionRequest) => Promise<SamlProfile>;
+    validateLogoutRequest?: (request: SamlIdpLogoutRequest) => Promise<SamlLogoutInfo> | SamlLogoutInfo;
+    validateLogoutResponse?: (request: SamlLogoutResponseRequest) => Promise<void> | void;
+};
+type SsoIdentityBase = {
+    email?: string;
+    organizationId: OrganizationId;
+    sub: string;
+};
+export type OidcSsoIdentity = SsoIdentityBase & {
+    claims: OIDCIdTokenClaims;
+    connection: OidcConnection;
+    protocol: 'oidc';
+    tokenResponse: OAuth2TokenResponse;
+};
+export type SamlSsoIdentity = SsoIdentityBase & {
+    attributes: Record<string, unknown>;
+    connection: SamlConnection;
+    protocol: 'saml';
+    sessionIndex?: string;
+};
+export type SsoIdentity = OidcSsoIdentity | SamlSsoIdentity;
+export type SSOConfig<UserType> = {
+    getOrganizationByEmailDomain?: (domain: string) => OrganizationId | undefined | Promise<OrganizationId | undefined>;
+    getSsoUser: (identity: SsoIdentity) => Promise<UserType> | UserType;
+    onSsoCallbackError?: (context: {
+        error: unknown;
+        organizationId: string;
+    }) => void | Promise<void>;
+    onSsoCallbackSuccess?: (context: {
+        identity: SsoIdentity;
+        user: UserType;
+        userSessionId: UserSessionId;
+    }) => void | Promise<void>;
+    samlAdapter?: SamlAdapter;
+    sessionDurationMs?: number;
+    ssoConnectionStore: SSOConnectionStore;
+    ssoRoute?: RouteString;
+};
+export {};

package/dist/sso/discoveryRoute.d.ts

@@ -0,0 +1,63 @@
+import { Elysia } from 'elysia';
+import type { OrganizationId } from '../tenancy';
+import type { RouteString } from '../types';
+import type { SSOConnectionStore } from './types';
+type SsoDiscoveryProps = {
+    getOrganizationByEmailDomain: (domain: string) => OrganizationId | undefined | Promise<OrganizationId | undefined>;
+    ssoConnectionStore: SSOConnectionStore;
+    ssoRoute?: RouteString;
+};
+export declare const ssoDiscoveryRoute: ({ getOrganizationByEmailDomain, ssoConnectionStore, ssoRoute }: SsoDiscoveryProps) => Elysia<"", {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {};
+            query: {
+                email?: string | undefined;
+            };
+            headers: unknown;
+            response: {
+                400: "An \"email\" query parameter is required" | "A valid email address is required";
+                404: "No SSO organization is configured for this email domain" | "No SSO connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}>;
+export {};

package/dist/sso/oidcRoutes.d.ts

@@ -0,0 +1,98 @@
+import { Elysia } from 'elysia';
+import type { AuthSessionStore } from '../session/types';
+import { type SSOConfig } from './config';
+type OidcRoutesProps<UserType> = SSOConfig<UserType> & {
+    authSessionStore?: AuthSessionStore<UserType>;
+    cookieSecure?: boolean;
+};
+export declare const oidcSsoRoutes: <UserType>({ authSessionStore, cookieSecure, getSsoUser, onSsoCallbackError, onSsoCallbackSuccess, sessionDurationMs, ssoConnectionStore, ssoRoute }: OidcRoutesProps<UserType>) => Elysia<"", {
+    decorator: {};
+    store: {
+        session: import("..").SessionRecord<UserType>;
+        unregisteredSession: import("..").UnregisteredSessionRecord;
+    };
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {
+                organizationId: string;
+            };
+            query: unknown;
+            headers: unknown;
+            response: {
+                404: "No OIDC connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {
+                organizationId: string;
+            };
+            query: {
+                code?: string | undefined;
+                state?: string | undefined;
+            };
+            headers: unknown;
+            response: {
+                400: "SSO session cookies are missing" | "Invalid SSO callback request" | "SSO organization mismatch" | "OIDC token response is missing an id_token";
+                404: "No OIDC connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+                500: "OIDC sign-in failed";
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+} & {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}>;
+export {};

package/dist/sso/samlRoutes.d.ts

@@ -0,0 +1,179 @@
+import { Elysia } from 'elysia';
+import type { AuthSessionStore } from '../session/types';
+import type { SessionRecord } from '../types';
+import { type SamlAdapter, type SSOConfig } from './config';
+type SamlRoutesProps<UserType> = SSOConfig<UserType> & {
+    authSessionStore?: AuthSessionStore<UserType>;
+    cookieSecure?: boolean;
+    samlAdapter: SamlAdapter;
+};
+export declare const samlSsoRoutes: <UserType>({ authSessionStore, cookieSecure, getSsoUser, onSsoCallbackError, onSsoCallbackSuccess, samlAdapter, sessionDurationMs, ssoConnectionStore, ssoRoute }: SamlRoutesProps<UserType>) => Elysia<"", {
+    decorator: {};
+    store: {
+        session: SessionRecord<UserType>;
+        unregisteredSession: import("..").UnregisteredSessionRecord;
+    };
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {
+                organizationId: string;
+            };
+            query: unknown;
+            headers: unknown;
+            response: {
+                404: "No SAML connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        post: {
+            body: {
+                RelayState?: string | undefined;
+                SAMLResponse: string;
+            };
+            params: {
+                organizationId: string;
+            };
+            query: unknown;
+            headers: unknown;
+            response: {
+                404: "No SAML connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+                500: "SAML sign-in failed";
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {
+                organizationId: string;
+            };
+            query: unknown;
+            headers: unknown;
+            response: {
+                404: "No SAML connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {
+                organizationId: string;
+            };
+            query: unknown;
+            headers: unknown;
+            response: {
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {
+                organizationId: string;
+            };
+            query: {
+                RelayState?: string | undefined;
+                SAMLResponse?: string | undefined;
+                SAMLRequest?: string | undefined;
+                SigAlg?: string | undefined;
+                Signature?: string | undefined;
+            };
+            headers: unknown;
+            response: {
+                400: "Missing SAMLRequest or SAMLResponse" | "Invalid SAML LogoutRequest";
+                501: "SAML Single Logout is not configured";
+                404: "No SAML connection is configured for this organization";
+                200: Response;
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+                500: "SAML logout failed";
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+} & {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}>;
+export {};

package/dist/sso/types.d.ts

@@ -0,0 +1,53 @@
+import type { OrganizationId } from '../tenancy';
+export type SSOConnectionType = 'oidc' | 'saml';
+export type OidcConnectionConfig = {
+    clientId: string;
+    clientSecret: string;
+    issuer: string;
+    redirectUri: string;
+    scopes: string[];
+};
+export type SamlConnectionConfig = {
+    idpEntityId: string;
+    idpSloUrl?: string;
+    idpSsoUrl: string;
+    idpX509Cert: string;
+};
+type SSOConnectionBase = {
+    connectionId: string;
+    createdAt: number;
+    enabled: boolean;
+    organizationId: OrganizationId;
+    updatedAt: number;
+};
+export type OidcConnection = SSOConnectionBase & {
+    config: OidcConnectionConfig;
+    type: 'oidc';
+};
+export type SamlConnection = SSOConnectionBase & {
+    config: SamlConnectionConfig;
+    type: 'saml';
+};
+export type SSOConnection = OidcConnection | SamlConnection;
+export type SamlServiceProvider = {
+    acsUrl: string;
+    createdAt: number;
+    entityId: string;
+    nameIdFormat?: string;
+    signingCert?: string;
+    updatedAt: number;
+};
+export type SamlServiceProviderStore = {
+    deleteServiceProvider: (entityId: string) => Promise<void>;
+    findServiceProvider: (entityId: string) => Promise<SamlServiceProvider | undefined>;
+    listServiceProviders: () => Promise<SamlServiceProvider[]>;
+    saveServiceProvider: (sp: SamlServiceProvider) => Promise<void>;
+};
+export type SSOConnectionStore = {
+    deleteConnection: (connectionId: string) => Promise<void>;
+    getConnection: (connectionId: string) => Promise<SSOConnection | undefined>;
+    getConnectionByOrganization: (organizationId: OrganizationId, type?: SSOConnectionType) => Promise<SSOConnection | undefined>;
+    listConnectionsByOrganization: (organizationId: OrganizationId) => Promise<SSOConnection[]>;
+    saveConnection: (connection: SSOConnection) => Promise<void>;
+};
+export {};

package/dist/stores/postgres.d.ts

@@ -0,0 +1,5 @@
+import type { PgAsyncDatabase } from 'drizzle-orm/pg-core';
+export type AnyPgDatabase = PgAsyncDatabase<any, any>;
+export declare const createNeonDatabase: (databaseUrl: string) => import("drizzle-orm/neon-http").NeonHttpDatabase<import("drizzle-orm").EmptyRelations> & {
+    $client: import("@neondatabase/serverless").NeonQueryFunction<false, false>;
+};

package/dist/stores/redis.d.ts

@@ -0,0 +1,5 @@
+export type RedisLike = {
+    del: (key: string) => Promise<unknown>;
+    get: (key: string) => Promise<string | null>;
+    set: (key: string, value: string, ttlMs: number) => Promise<unknown>;
+};

package/dist/telemetry/tracing.d.ts

@@ -0,0 +1,15 @@
+import type { Attributes, Span, TracerProvider } from '@opentelemetry/api';
+export type TracingConfig = {
+    /** Plug in your `@opentelemetry/sdk-trace-node` (or `-web` / `-bun`) TracerProvider
+     *  here. When omitted, every `withSpan` call short-circuits and the package never
+     *  loads `@opentelemetry/api`. */
+    tracerProvider: TracerProvider;
+    /** Service name attribute attached to every span. Defaults to `@absolutejs/auth`. */
+    serviceName?: string;
+};
+type SpanWork<Result> = (span: Span | undefined) => Promise<Result>;
+type WithSpanFn = <Result>(name: string, attributes: Attributes | undefined, work: SpanWork<Result>) => Promise<Result>;
+export declare const __resetTracingForTests: () => void;
+export declare const initTracing: (config: TracingConfig) => Promise<void>;
+export declare const withSpan: WithSpanFn;
+export {};