@lightninglabs/lnc-web/dist/stores/authStrategy.d.ts

Lightning Node Connect npm module for web

import { UnlockMethod, UnlockOptions } from '../types/lightningNodeConnect';
/**
 * Interface for authentication strategies used by the auth stack.
 * Each strategy handles a specific authentication method (password, passkey, etc.)
 * and provides a consistent interface for credential storage and retrieval.
 */
export interface AuthStrategy {
    /** The authentication method this strategy handles */
    readonly method: UnlockMethod;
    /** Check if this strategy is supported in the current environment */
    get isSupported(): boolean;
    /** Check if this strategy is currently unlocked */
    get isUnlocked(): boolean;
    /** Check if this strategy has any stored credentials */
    get hasAnyCredentials(): boolean;
    /** Attempt to unlock this strategy with the provided options */
    unlock(options: UnlockOptions): Promise<boolean>;
    /** Get a credential value from this strategy's storage */
    getCredential(key: string): Promise<string | undefined>;
    /** Set a credential value in this strategy's storage */
    setCredential(key: string, value: string): Promise<void>;
    /** Clear the strategy's state */
    clear(): void;
    /** Strategy-specific methods that may be implemented */
    hasStoredAuthData?(): boolean;
    getCredentialId?(): string | undefined;
}
//# sourceMappingURL=authStrategy.d.ts.map