@technomoron/api-server-base 1.1.13 → 2.0.0-beta.10

package/dist/esm/auth-api/auth-module.d.ts

@@ -0,0 +1,105 @@
+import { type ApiRequest, type ApiRoute, type ApiServer } from '../api-server-base.js';
+import { BaseAuthModule, type AuthProviderModule } from './module.js';
+import type { AuthAdapter, AuthIdentifier } from './types.js';
+import type { OAuthCallbackParams, OAuthCallbackResult, OAuthStartParams, OAuthStartResult } from '../oauth/types.js';
+import type { TokenPair, Token } from '../token/types.js';
+interface CanImpersonateContext<UserEntity> {
+    apiReq: ApiRequest;
+    realUser: UserEntity;
+    realUserId: AuthIdentifier;
+    targetUser: UserEntity;
+    effectiveUserId: AuthIdentifier;
+}
+interface AuthModuleOptions<UserEntity> {
+    namespace?: string;
+    defaultDomain?: string;
+    canImpersonate?: (context: CanImpersonateContext<UserEntity>) => Promise<boolean> | boolean;
+}
+type TokenMetadata = Partial<Token> & {
+    sessionCookie?: boolean;
+};
+interface TokenIssueOptions extends TokenMetadata {
+    expires?: Date;
+    sessionCookie?: boolean;
+}
+interface NormalizedTokenMetadata extends TokenMetadata {
+    domain: string;
+    fingerprint: string;
+    label: string;
+    browser: string;
+    device: string;
+    ip: string;
+    os: string;
+}
+type TokenClaims = TokenMetadata & {
+    uid: string;
+    exp?: number;
+    iat?: number;
+};
+type AuthCapableServer<PublicUser> = ApiServer & {
+    initiateOAuth?: (params: OAuthStartParams) => Promise<OAuthStartResult>;
+    completeOAuth?: (params: OAuthCallbackParams) => Promise<OAuthCallbackResult<PublicUser>>;
+};
+export default class AuthModule<UserEntity, PublicUser> extends BaseAuthModule<UserEntity> implements AuthProviderModule<UserEntity> {
+    static defaultNamespace: string;
+    server: AuthCapableServer<PublicUser>;
+    private readonly defaultDomain?;
+    private readonly canImpersonateHook?;
+    constructor(options?: AuthModuleOptions<UserEntity>);
+    protected get storage(): AuthAdapter<UserEntity, PublicUser>;
+    protected canImpersonate(apiReq: ApiRequest, realUser: UserEntity, targetUser: UserEntity): Promise<boolean>;
+    protected ensureImpersonationAllowed(apiReq: ApiRequest, realUser: UserEntity, targetUser: UserEntity): Promise<void>;
+    protected buildTokenPayload(user: UserEntity, metadata?: TokenMetadata): TokenClaims;
+    protected buildTokenMetadata(metadata?: TokenMetadata): NormalizedTokenMetadata;
+    protected enrichTokenMetadata(apiReq: ApiRequest, metadata?: TokenMetadata): TokenMetadata;
+    private sessionRefreshTtlSeconds;
+    private normalizeRefreshTtlSeconds;
+    private resolveSessionPreferences;
+    private mergeSessionPreferences;
+    private sessionPrefsFromRecord;
+    private validateCredentialId;
+    private normalizeCredentialId;
+    private toIsoDate;
+    private cookieOptions;
+    private setJwtCookies;
+    issueTokens(apiReq: ApiRequest, user: UserEntity, metadata?: TokenIssueOptions): Promise<TokenPair>;
+    private assertAuthReady;
+    private parseLoginBody;
+    private parseImpersonationRequest;
+    private resolveImpersonationIdentifier;
+    private buildImpersonationMetadata;
+    private getUserOrThrow;
+    private getRealUserIdentifier;
+    private resolveActorContext;
+    private extractRefreshToken;
+    private normalizeScope;
+    private postLogin;
+    private postRefresh;
+    private postLogout;
+    private postWhoAmI;
+    private postPasskeyChallenge;
+    private postPasskeyVerify;
+    private getPasskeys;
+    private deletePasskey;
+    private postImpersonation;
+    private deleteImpersonation;
+    private getUserFromPasskey;
+    private postOAuthStart;
+    private postOAuthCallback;
+    private postOAuthAuthorize;
+    private postOAuthToken;
+    private handleAuthorizationCodeGrant;
+    private handleRefreshTokenGrant;
+    private clearOAuthCookies;
+    private buildTokenResponse;
+    private resolveScope;
+    private resolveClientAuthentication;
+    private assertRedirectUriAllowed;
+    private resolveUserForOAuth;
+    private hasPasskeyService;
+    private hasOAuthStore;
+    private storageImplements;
+    private storageImplementsAll;
+    defineRoutes(): ApiRoute[];
+}
+export {};