w3pk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Shared types used across the SDK
+ */
+interface UserInfo {
+    id: string;
+    username: string;
+    ethereumAddress: string;
+}
+interface WalletInfo {
+    address: string;
+    mnemonic: string;
+}
+
+/**
+ * Custom error classes for better error handling
+ */
+declare class Web3PasskeyError extends Error {
+    code: string;
+    originalError?: unknown | undefined;
+    constructor(message: string, code: string, originalError?: unknown | undefined);
+}
+declare class AuthenticationError extends Web3PasskeyError {
+    constructor(message: string, originalError?: unknown);
+}
+declare class RegistrationError extends Web3PasskeyError {
+    constructor(message: string, originalError?: unknown);
+}
+declare class WalletError extends Web3PasskeyError {
+    constructor(message: string, originalError?: unknown);
+}
+declare class CryptoError extends Web3PasskeyError {
+    constructor(message: string, originalError?: unknown);
+}
+declare class StorageError extends Web3PasskeyError {
+    constructor(message: string, originalError?: unknown);
+}
+declare class ApiError extends Web3PasskeyError {
+    statusCode?: number | undefined;
+    constructor(message: string, statusCode?: number | undefined, originalError?: unknown);
+}
+
+/**
+ * SDK Configuration
+ */
+
+interface Web3PasskeyConfig {
+    /**
+     * Base URL of the WebAuthn API
+     * @example 'https://webauthn.w3hc.org'
+     */
+    apiBaseUrl: string;
+    /**
+     * Timeout for API requests in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Enable debug logging
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Custom error handler
+     */
+    onError?: (error: Web3PasskeyError) => void;
+    /**
+     * Auth state change callback
+     */
+    onAuthStateChanged?: (isAuthenticated: boolean, user?: UserInfo) => void;
+}
+
+/**
+ * Authentication-related types
+ */
+
+interface AuthResult {
+    verified: boolean;
+    user?: {
+        id: string;
+        username: string;
+        ethereumAddress: string;
+    };
+}
+
+/**
+ * Main Web3Passkey SDK class
+ */
+
+declare class Web3Passkey {
+    private config;
+    private apiClient;
+    private walletStorage;
+    private walletSigner;
+    private currentUser;
+    private isAuthenticatedState;
+    private isBrowser;
+    constructor(config: Web3PasskeyConfig);
+    private loadAuthState;
+    private saveAuthState;
+    private clearAuthState;
+    private notifyAuthStateChange;
+    /**
+     * Generate a new BIP39 wallet
+     * @returns Wallet info with mnemonic (user MUST backup)
+     */
+    generateWallet(): Promise<WalletInfo>;
+    /**
+     * Check if wallet exists for current user
+     */
+    hasWallet(): Promise<boolean>;
+    /**
+     * Register a new user with WebAuthn
+     * @param username Username for the account
+     * @param ethereumAddress Ethereum address from generated wallet
+     * @param mnemonic BIP39 mnemonic to encrypt and store
+     * @param credentialId WebAuthn credential ID (from registration response)
+     * @param challenge Challenge used in registration
+     */
+    register(options: {
+        username: string;
+        ethereumAddress: string;
+        mnemonic: string;
+        credentialId: string;
+        challenge: string;
+    }): Promise<void>;
+    /**
+     * Authenticate with Ethereum address
+     */
+    authenticate(ethereumAddress: string): Promise<AuthResult>;
+    /**
+     * Authenticate without username (usernameless flow)
+     */
+    authenticateUsernameless(): Promise<AuthResult>;
+    /**
+     * Logout current user
+     */
+    logout(): void;
+    /**
+     * Sign a message with encrypted wallet
+     * Requires fresh WebAuthn authentication
+     * @param message Message to sign
+     * @param credentialId WebAuthn credential ID (from fresh auth)
+     * @param challenge Challenge from fresh auth
+     */
+    signMessage(message: string, credentialId: string, challenge: string): Promise<string>;
+    /**
+     * Check if user is authenticated
+     */
+    get isAuthenticated(): boolean;
+    /**
+     * Get current user info
+     */
+    get user(): UserInfo | null;
+    /**
+     * Get SDK version
+     */
+    get version(): string;
+    /**
+     * Check if running in browser environment
+     */
+    get isBrowserEnvironment(): boolean;
+}
+
+/**
+ * w3pk - Web3 Passkey SDK
+ * WebAuthn SDK for passwordless authentication and encrypted wallet management
+ */
+
+declare function createWeb3Passkey(config: Web3PasskeyConfig): Web3Passkey;
+
+export { ApiError, type AuthResult, AuthenticationError, CryptoError, RegistrationError, StorageError, type UserInfo, WalletError, type WalletInfo, Web3Passkey, type Web3PasskeyConfig, Web3PasskeyError, createWeb3Passkey, createWeb3Passkey as default };