ns-auth-sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,214 @@
+import { NostrKeyInfo, NostrEvent as NostrEvent$1 } from 'nosskey-sdk';
+import { EventStore } from 'applesauce-core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as zustand from 'zustand';
+
+/**
+ * Authentication state interface
+ */
+interface AuthState {
+    isAuthenticated: boolean;
+    publicKey: string | null;
+    keyInfo: NostrKeyInfo | null;
+    loginError: string | null;
+    setAuthenticated: (keyInfo: NostrKeyInfo | null) => void;
+    setLoginError: (error: string | null) => void;
+    logout: () => void;
+}
+/**
+ * Auth service configuration
+ */
+interface AuthServiceConfig {
+    rpId?: string;
+    rpName?: string;
+    storageKey?: string;
+    cacheTimeoutMs?: number;
+}
+/**
+ * Relay service configuration
+ */
+interface RelayServiceConfig {
+    relayUrls?: string[];
+}
+
+/**
+ * Service wrapper around NosskeyManager
+ * Handles WebAuthn/Passkey integration with Nostr
+ */
+declare class AuthService {
+    private manager;
+    private config;
+    constructor(config?: AuthServiceConfig);
+    private getDefaultRpName;
+    /**
+     * Initialize the NosskeyManager instance
+     */
+    private getManager;
+    /**
+     * Create a new passkey
+     * Uses platform authenticator only (Touch ID, Face ID, Windows Hello)
+     */
+    createPasskey(username?: string): Promise<Uint8Array>;
+    /**
+     * Create a new Nostr key from a credential ID
+     */
+    createNostrKey(credentialId?: Uint8Array): Promise<NostrKeyInfo>;
+    /**
+     * Get the current public key
+     */
+    getPublicKey(): Promise<string>;
+    /**
+     * Sign a Nostr event
+     */
+    signEvent(event: NostrEvent$1): Promise<NostrEvent$1>;
+    /**
+     * Get current key info
+     */
+    getCurrentKeyInfo(): NostrKeyInfo | null;
+    /**
+     * Set current key info
+     */
+    setCurrentKeyInfo(keyInfo: NostrKeyInfo): void;
+    /**
+     * Check if key info exists
+     */
+    hasKeyInfo(): boolean;
+    /**
+     * Clear stored key info
+     */
+    clearStoredKeyInfo(): void;
+    /**
+     * Check if PRF is supported
+     */
+    isPrfSupported(): Promise<boolean>;
+}
+
+/**
+ * Nostr event types
+ */
+interface NostrEvent {
+    id?: string;
+    pubkey?: string;
+    created_at?: number;
+    kind: number;
+    tags?: string[][];
+    content: string;
+    sig?: string;
+}
+/**
+ * Profile metadata (Kind 0)
+ */
+interface ProfileMetadata {
+    name?: string;
+    display_name?: string;
+    about?: string;
+    picture?: string;
+    website?: string;
+    [key: string]: unknown;
+}
+/**
+ * Follow list entry (from Kind 3 tags)
+ */
+interface FollowEntry {
+    pubkey: string;
+    relay?: string;
+    petname?: string;
+}
+
+/**
+ * Service for communicating with Nostr relays using applesauce-core
+ */
+declare class RelayService {
+    private eventStore;
+    private relayUrls;
+    private defaultRelays;
+    constructor(config?: RelayServiceConfig);
+    /**
+     * Initialize with applesauce EventStore
+     */
+    initialize(eventStore: EventStore): void;
+    /**
+     * Set relay URLs
+     */
+    setRelays(urls: string[]): void;
+    /**
+     * Publish an event to relays
+     */
+    publishEvent(event: NostrEvent, timeoutMs?: number): Promise<boolean>;
+    /**
+     * Fetch a profile (Kind 0 event)
+     */
+    fetchProfile(pubkey: string): Promise<ProfileMetadata | null>;
+    /**
+     * Fetch role tag from profile event (Kind 0)
+     */
+    fetchProfileRoleTag(pubkey: string): Promise<string | null>;
+    /**
+     * Fetch a follow list (Kind 3 event)
+     */
+    fetchFollowList(pubkey: string): Promise<FollowEntry[]>;
+    /**
+     * Fetch multiple profiles in batch
+     */
+    fetchMultipleProfiles(pubkeys: string[]): Promise<Map<string, ProfileMetadata>>;
+    /**
+     * Query kind 0 events (profiles) by pubkey
+     * If pubkeys array is empty, fetches recent kind 0 events
+     */
+    queryProfiles(pubkeys?: string[], limit?: number): Promise<Map<string, ProfileMetadata>>;
+    /**
+     * Publish or update a kind 3 event (follow list/contacts)
+     */
+    publishFollowList(pubkey: string, followList: FollowEntry[], signEvent: (event: NostrEvent) => Promise<NostrEvent>): Promise<boolean>;
+}
+
+interface LoginButtonProps {
+    authService: AuthService;
+    setAuthenticated: AuthState['setAuthenticated'];
+    setLoginError: AuthState['setLoginError'];
+    onSuccess?: () => void;
+}
+declare function LoginButton({ authService, setAuthenticated, setLoginError, onSuccess, }: LoginButtonProps): react_jsx_runtime.JSX.Element;
+
+interface RegistrationFlowProps {
+    authService: AuthService;
+    setAuthenticated: AuthState['setAuthenticated'];
+    onSuccess?: () => void;
+}
+declare function RegistrationFlow({ authService, setAuthenticated, onSuccess, }: RegistrationFlowProps): react_jsx_runtime.JSX.Element;
+
+interface MembershipPageProps {
+    authService: AuthService;
+    relayService: RelayService;
+    publicKey: string | null;
+    onUnauthenticated?: () => void;
+}
+declare function MembershipPage({ authService, relayService, publicKey, onUnauthenticated, }: MembershipPageProps): react_jsx_runtime.JSX.Element;
+
+interface BarcodeScannerProps {
+    /** Called when a code is successfully read */
+    onDecode: (value: string) => void;
+    /** Optional flag to hide the scanner */
+    active?: boolean;
+}
+declare const BarcodeScanner: ({ onDecode, active }: BarcodeScannerProps) => react_jsx_runtime.JSX.Element | null;
+
+interface ProfilePageProps {
+    authService: AuthService;
+    relayService: RelayService;
+    publicKey: string | null;
+    onUnauthenticated?: () => void;
+    onSuccess?: () => void;
+    onRoleSuggestion?: (about: string) => Promise<string | null>;
+}
+declare function ProfilePage({ authService, relayService, publicKey, onUnauthenticated, onSuccess, onRoleSuggestion, }: ProfilePageProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Hook to initialize auth state on app load
+ */
+declare function useAuthInit(authService: AuthService, setAuthenticated: AuthState['setAuthenticated']): void;
+
+declare const createAuthStore: () => zustand.UseBoundStore<zustand.StoreApi<AuthState>>;
+declare const useAuthStore: zustand.UseBoundStore<zustand.StoreApi<AuthState>>;
+
+export { AuthService, type AuthServiceConfig, type AuthState, BarcodeScanner, type FollowEntry, LoginButton, MembershipPage, type NostrEvent, type ProfileMetadata, ProfilePage, RegistrationFlow, RelayService, type RelayServiceConfig, createAuthStore, useAuthInit, useAuthStore };

package/dist/index.d.ts

@@ -0,0 +1,214 @@
+import { NostrKeyInfo, NostrEvent as NostrEvent$1 } from 'nosskey-sdk';
+import { EventStore } from 'applesauce-core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as zustand from 'zustand';
+
+/**
+ * Authentication state interface
+ */
+interface AuthState {
+    isAuthenticated: boolean;
+    publicKey: string | null;
+    keyInfo: NostrKeyInfo | null;
+    loginError: string | null;
+    setAuthenticated: (keyInfo: NostrKeyInfo | null) => void;
+    setLoginError: (error: string | null) => void;
+    logout: () => void;
+}
+/**
+ * Auth service configuration
+ */
+interface AuthServiceConfig {
+    rpId?: string;
+    rpName?: string;
+    storageKey?: string;
+    cacheTimeoutMs?: number;
+}
+/**
+ * Relay service configuration
+ */
+interface RelayServiceConfig {
+    relayUrls?: string[];
+}
+
+/**
+ * Service wrapper around NosskeyManager
+ * Handles WebAuthn/Passkey integration with Nostr
+ */
+declare class AuthService {
+    private manager;
+    private config;
+    constructor(config?: AuthServiceConfig);
+    private getDefaultRpName;
+    /**
+     * Initialize the NosskeyManager instance
+     */
+    private getManager;
+    /**
+     * Create a new passkey
+     * Uses platform authenticator only (Touch ID, Face ID, Windows Hello)
+     */
+    createPasskey(username?: string): Promise<Uint8Array>;
+    /**
+     * Create a new Nostr key from a credential ID
+     */
+    createNostrKey(credentialId?: Uint8Array): Promise<NostrKeyInfo>;
+    /**
+     * Get the current public key
+     */
+    getPublicKey(): Promise<string>;
+    /**
+     * Sign a Nostr event
+     */
+    signEvent(event: NostrEvent$1): Promise<NostrEvent$1>;
+    /**
+     * Get current key info
+     */
+    getCurrentKeyInfo(): NostrKeyInfo | null;
+    /**
+     * Set current key info
+     */
+    setCurrentKeyInfo(keyInfo: NostrKeyInfo): void;
+    /**
+     * Check if key info exists
+     */
+    hasKeyInfo(): boolean;
+    /**
+     * Clear stored key info
+     */
+    clearStoredKeyInfo(): void;
+    /**
+     * Check if PRF is supported
+     */
+    isPrfSupported(): Promise<boolean>;
+}
+
+/**
+ * Nostr event types
+ */
+interface NostrEvent {
+    id?: string;
+    pubkey?: string;
+    created_at?: number;
+    kind: number;
+    tags?: string[][];
+    content: string;
+    sig?: string;
+}
+/**
+ * Profile metadata (Kind 0)
+ */
+interface ProfileMetadata {
+    name?: string;
+    display_name?: string;
+    about?: string;
+    picture?: string;
+    website?: string;
+    [key: string]: unknown;
+}
+/**
+ * Follow list entry (from Kind 3 tags)
+ */
+interface FollowEntry {
+    pubkey: string;
+    relay?: string;
+    petname?: string;
+}
+
+/**
+ * Service for communicating with Nostr relays using applesauce-core
+ */
+declare class RelayService {
+    private eventStore;
+    private relayUrls;
+    private defaultRelays;
+    constructor(config?: RelayServiceConfig);
+    /**
+     * Initialize with applesauce EventStore
+     */
+    initialize(eventStore: EventStore): void;
+    /**
+     * Set relay URLs
+     */
+    setRelays(urls: string[]): void;
+    /**
+     * Publish an event to relays
+     */
+    publishEvent(event: NostrEvent, timeoutMs?: number): Promise<boolean>;
+    /**
+     * Fetch a profile (Kind 0 event)
+     */
+    fetchProfile(pubkey: string): Promise<ProfileMetadata | null>;
+    /**
+     * Fetch role tag from profile event (Kind 0)
+     */
+    fetchProfileRoleTag(pubkey: string): Promise<string | null>;
+    /**
+     * Fetch a follow list (Kind 3 event)
+     */
+    fetchFollowList(pubkey: string): Promise<FollowEntry[]>;
+    /**
+     * Fetch multiple profiles in batch
+     */
+    fetchMultipleProfiles(pubkeys: string[]): Promise<Map<string, ProfileMetadata>>;
+    /**
+     * Query kind 0 events (profiles) by pubkey
+     * If pubkeys array is empty, fetches recent kind 0 events
+     */
+    queryProfiles(pubkeys?: string[], limit?: number): Promise<Map<string, ProfileMetadata>>;
+    /**
+     * Publish or update a kind 3 event (follow list/contacts)
+     */
+    publishFollowList(pubkey: string, followList: FollowEntry[], signEvent: (event: NostrEvent) => Promise<NostrEvent>): Promise<boolean>;
+}
+
+interface LoginButtonProps {
+    authService: AuthService;
+    setAuthenticated: AuthState['setAuthenticated'];
+    setLoginError: AuthState['setLoginError'];
+    onSuccess?: () => void;
+}
+declare function LoginButton({ authService, setAuthenticated, setLoginError, onSuccess, }: LoginButtonProps): react_jsx_runtime.JSX.Element;
+
+interface RegistrationFlowProps {
+    authService: AuthService;
+    setAuthenticated: AuthState['setAuthenticated'];
+    onSuccess?: () => void;
+}
+declare function RegistrationFlow({ authService, setAuthenticated, onSuccess, }: RegistrationFlowProps): react_jsx_runtime.JSX.Element;
+
+interface MembershipPageProps {
+    authService: AuthService;
+    relayService: RelayService;
+    publicKey: string | null;
+    onUnauthenticated?: () => void;
+}
+declare function MembershipPage({ authService, relayService, publicKey, onUnauthenticated, }: MembershipPageProps): react_jsx_runtime.JSX.Element;
+
+interface BarcodeScannerProps {
+    /** Called when a code is successfully read */
+    onDecode: (value: string) => void;
+    /** Optional flag to hide the scanner */
+    active?: boolean;
+}
+declare const BarcodeScanner: ({ onDecode, active }: BarcodeScannerProps) => react_jsx_runtime.JSX.Element | null;
+
+interface ProfilePageProps {
+    authService: AuthService;
+    relayService: RelayService;
+    publicKey: string | null;
+    onUnauthenticated?: () => void;
+    onSuccess?: () => void;
+    onRoleSuggestion?: (about: string) => Promise<string | null>;
+}
+declare function ProfilePage({ authService, relayService, publicKey, onUnauthenticated, onSuccess, onRoleSuggestion, }: ProfilePageProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Hook to initialize auth state on app load
+ */
+declare function useAuthInit(authService: AuthService, setAuthenticated: AuthState['setAuthenticated']): void;
+
+declare const createAuthStore: () => zustand.UseBoundStore<zustand.StoreApi<AuthState>>;
+declare const useAuthStore: zustand.UseBoundStore<zustand.StoreApi<AuthState>>;
+
+export { AuthService, type AuthServiceConfig, type AuthState, BarcodeScanner, type FollowEntry, LoginButton, MembershipPage, type NostrEvent, type ProfileMetadata, ProfilePage, RegistrationFlow, RelayService, type RelayServiceConfig, createAuthStore, useAuthInit, useAuthStore };