shogun-button-react 6.4.0 → 6.4.2

package/README.md

@@ -9,7 +9,9 @@ A comprehensive React component library for seamless integration of Shogun authe
 - 🚀 **Easy Integration** - Simple setup with minimal configuration
 - 🎨 **Customizable UI** - Modern, responsive design with dark mode support
 - 🔒 **Multi-Authentication** - Support for Password, MetaMask, WebAuthn, Nostr, and ZK-Proof
+- 🛡️ **WebAuthn Recovery** - Restore hardware credentials on new devices with saved seed phrases
 - 🔑 **Account Management** - Export/import Gun pairs for account backup and recovery
+- 🕵️ **ZK-Proof Trapdoor Handoff** - Display and copy the generated trapdoor during signup to keep anonymous identities portable
 - 📱 **Responsive Design** - Works seamlessly across all device sizes
 - 🌍 **TypeScript Support** - Full type safety and IntelliSense support
 - 🔌 **Plugin System** - Advanced Gun operations with custom hooks
@@ -170,6 +172,21 @@ const { core, options } = shogunConnector({
 });
 ```
 
+## 🔑 Recovery Flows
+
+### WebAuthn Multi-Device Restore
+
+- Users now see a **Restore with Recovery Code** option when choosing WebAuthn login.
+- Enter the username plus the stored seed phrase to recreate the credential on a new browser.
+- The button calls `webauthnPlugin.signUp(username, { seedPhrase, generateSeedPhrase: false })` behind the scenes, leveraging the core plugin’s `importFromSeed` flow.
+- After a successful restore the seed phrase is shown one more time so the user can double-check or re-copy it before the modal closes.
+
+### ZK-Proof Trapdoor Delivery
+
+- Upon successful `zkproof` signup, the modal switches to a confirmation screen that displays the generated trapdoor (also returned as `seedPhrase`).
+- A **Copy Trapdoor** helper copies the phrase to the clipboard, with inline feedback when the copy succeeds.
+- The user must acknowledge with **I Saved My Trapdoor** before returning to the main UI, reducing the risk of losing the anonymous identity.
+
 ## 🎯 API Reference
 
 ### ShogunButtonProvider

package/dist/components/ShogunButton.d.ts

@@ -23,6 +23,7 @@ type ShogunContextType = {
     remove: (path: string) => Promise<void>;
     completePendingSignup: () => void;
     hasPendingSignup: boolean;
+    setHasPendingSignup: (value: boolean) => void;
 };
 export declare const useShogun: () => ShogunContextType;
 type ShogunButtonProviderProps = {

package/dist/components/ShogunButton.js

@@ -27,6 +27,7 @@ const defaultShogunContext = {
     remove: async () => { },
     completePendingSignup: () => { },
     hasPendingSignup: false,
+    setHasPendingSignup: (_value) => { },
 };
 // Create context using React's createContext directly
 const ShogunContext = createContext(defaultShogunContext);
@@ -38,6 +39,7 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
     const [isLoggedIn, setIsLoggedIn] = useState(false);
     const [userPub, setUserPub] = useState(null);
     const [username, setUsername] = useState(null);
+    const [hasPendingSignup, setHasPendingSignup] = useState(false);
     // Effetto per gestire l'inizializzazione e pulizia
     useEffect(() => {
         var _a, _b;
@@ -220,7 +222,7 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
     };
     // Unified signup
     const signUp = async (method, ...args) => {
-        var _a, _b;
+        var _a, _b, _c;
         try {
             if (!core) {
                 throw new Error("SDK not initialized");
@@ -252,18 +254,39 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
                         throw error;
                     }
                     break;
-                case "webauthn":
-                    username = args[0];
+                case "webauthn": {
+                    username = typeof args[0] === "string" ? args[0].trim() : "";
+                    const webauthnOptions = args.length > 1 && typeof args[1] === "object" && args[1] !== null
+                        ? args[1]
+                        : {};
+                    if (!username) {
+                        throw new Error("Username is required for WebAuthn registration");
+                    }
                     if (isShogunCore(core)) {
                         const webauthn = core.getPlugin("webauthn");
                         if (!webauthn)
                             throw new Error("WebAuthn plugin not available");
-                        result = await webauthn.signUp(username, { generateSeedPhrase: true });
+                        const pluginOptions = {};
+                        if (webauthnOptions.seedPhrase) {
+                            pluginOptions.seedPhrase = webauthnOptions.seedPhrase.trim();
+                            pluginOptions.generateSeedPhrase =
+                                (_a = webauthnOptions.generateSeedPhrase) !== null && _a !== void 0 ? _a : false;
+                        }
+                        else if (typeof webauthnOptions.generateSeedPhrase === "boolean") {
+                            pluginOptions.generateSeedPhrase =
+                                webauthnOptions.generateSeedPhrase;
+                        }
+                        if (pluginOptions.generateSeedPhrase === undefined &&
+                            !pluginOptions.seedPhrase) {
+                            pluginOptions.generateSeedPhrase = true;
+                        }
+                        result = await webauthn.signUp(username, pluginOptions);
                     }
                     else {
                         throw new Error("WebAuthn requires ShogunCore");
                     }
                     break;
+                }
                 case "web3":
                     if (isShogunCore(core)) {
                         const web3 = core.getPlugin("web3");
@@ -320,7 +343,7 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
             if (result.success) {
                 let userPub = result.userPub || "";
                 if (!userPub && isShogunCore(core)) {
-                    userPub = ((_b = (_a = core.gun.user()) === null || _a === void 0 ? void 0 : _a.is) === null || _b === void 0 ? void 0 : _b.pub) || "";
+                    userPub = ((_c = (_b = core.gun.user()) === null || _b === void 0 ? void 0 : _b.is) === null || _c === void 0 ? void 0 : _c.pub) || "";
                 }
                 const displayName = result.alias || username || userPub.slice(0, 8) + "...";
                 setIsLoggedIn(true);
@@ -332,6 +355,8 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
                     seedPhrase: result.seedPhrase,
                     authMethod: authMethod,
                 };
+                const pendingBackup = Boolean(result.seedPhrase || result.trapdoor);
+                setHasPendingSignup(pendingBackup);
                 onSignupSuccess === null || onSignupSuccess === void 0 ? void 0 : onSignupSuccess(signupPayload);
             }
             else {
@@ -465,8 +490,9 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
     const gunPlugin = null;
     // Plugin hooks removed - GunAdvancedPlugin no longer available
     const pluginHooks = {};
-    const completePendingSignup = React.useCallback(() => { }, []);
-    const hasPendingSignup = false;
+    const completePendingSignup = React.useCallback(() => {
+        setHasPendingSignup(false);
+    }, [setHasPendingSignup]);
     // Create a properly typed context value
     const contextValue = React.useMemo(() => ({
         core,
@@ -486,6 +512,7 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
         gunPlugin,
         completePendingSignup,
         hasPendingSignup,
+        setHasPendingSignup,
         put: async (path, data) => {
             if (isShogunCore(core)) {
                 if (!core.gun)
@@ -545,6 +572,8 @@ export function ShogunButtonProvider({ children, core, options, onLoginSuccess,
         gunPlugin,
         pluginHooks,
         completePendingSignup,
+        hasPendingSignup,
+        setHasPendingSignup,
     ]);
     // Provide the context value to children
     return (React.createElement(ShogunContext.Provider, { value: contextValue }, children));
@@ -594,7 +623,7 @@ const ExportIcon = () => (React.createElement("svg", { xmlns: "http://www.w3.org
 // Component for Shogun login button
 export const ShogunButton = (() => {
     const Button = () => {
-        const { isLoggedIn, username, logout, login, signUp, core, options, exportGunPair, importGunPair, hasPlugin, } = useShogun();
+        const { isLoggedIn, username, logout, login, signUp, core, options, exportGunPair, importGunPair, hasPlugin, hasPendingSignup, setHasPendingSignup, } = useShogun();
         // Form states
         const [modalIsOpen, setModalIsOpen] = useState(false);
         const [formUsername, setFormUsername] = useState("");
@@ -616,7 +645,10 @@ export const ShogunButton = (() => {
         const [showCopySuccess, setShowCopySuccess] = useState(false);
         const [showImportSuccess, setShowImportSuccess] = useState(false);
         const [zkTrapdoor, setZkTrapdoor] = useState("");
+        const [zkSignupTrapdoor, setZkSignupTrapdoor] = useState("");
+        const [showZkTrapdoorCopySuccess, setShowZkTrapdoorCopySuccess] = useState(false);
         const [webauthnSeedPhrase, setWebauthnSeedPhrase] = useState("");
+        const [webauthnRecoverySeed, setWebauthnRecoverySeed] = useState("");
         const dropdownRef = useRef(null);
         // Handle click outside to close dropdown
         useEffect(() => {
@@ -633,6 +665,20 @@ export const ShogunButton = (() => {
                 };
             }
         }, [dropdownOpen]);
+        useEffect(() => {
+            if (hasPendingSignup) {
+                setModalIsOpen(true);
+                if (authView !== "webauthn-signup-result" &&
+                    authView !== "zkproof-signup-result") {
+                    if (webauthnSeedPhrase) {
+                        setAuthView("webauthn-signup-result");
+                    }
+                    else if (zkSignupTrapdoor) {
+                        setAuthView("zkproof-signup-result");
+                    }
+                }
+            }
+        }, [hasPendingSignup, authView, webauthnSeedPhrase, zkSignupTrapdoor]);
         // If already logged in, show only logout button
         if (isLoggedIn && username && !modalIsOpen) {
             return (React.createElement("div", { className: "shogun-logged-in-container" },
@@ -753,6 +799,41 @@ export const ShogunButton = (() => {
             }
             setAuthView("webauthn-username");
         };
+        const handleWebauthnImport = async () => {
+            setError("");
+            setLoading(true);
+            try {
+                const username = formUsername.trim();
+                const recoveryCode = webauthnRecoverySeed.trim();
+                if (!username) {
+                    throw new Error("Please enter your username");
+                }
+                if (!recoveryCode) {
+                    throw new Error("Please enter your recovery code");
+                }
+                if (!isShogunCore(core)) {
+                    throw new Error("WebAuthn recovery requires ShogunCore");
+                }
+                const result = await signUp("webauthn", username, {
+                    seedPhrase: recoveryCode,
+                    generateSeedPhrase: false,
+                });
+                if (!result || !result.success) {
+                    throw new Error((result === null || result === void 0 ? void 0 : result.error) || "Failed to restore account");
+                }
+                const seedToDisplay = result.seedPhrase || recoveryCode;
+                setWebauthnSeedPhrase(seedToDisplay);
+                setWebauthnRecoverySeed("");
+                setShowCopySuccess(false);
+                setAuthView("webauthn-signup-result");
+            }
+            catch (e) {
+                setError(e.message || "Failed to restore WebAuthn account");
+            }
+            finally {
+                setLoading(false);
+            }
+        };
         const handleZkProofAuth = () => {
             if (!hasPlugin("zkproof")) {
                 setError("ZK-Proof plugin not available");
@@ -791,8 +872,17 @@ export const ShogunButton = (() => {
                 if (!result || !result.success) {
                     throw new Error((result === null || result === void 0 ? void 0 : result.error) || "ZK-Proof signup failed");
                 }
-                setAuthView("options");
-                setModalIsOpen(false);
+                const trapdoorValue = result.seedPhrase || result.trapdoor || "";
+                if (trapdoorValue) {
+                    setZkSignupTrapdoor(trapdoorValue);
+                    setShowZkTrapdoorCopySuccess(false);
+                    setAuthView("zkproof-signup-result");
+                    setHasPendingSignup(true);
+                }
+                else {
+                    setAuthView("options");
+                    setModalIsOpen(false);
+                }
             }
             catch (e) {
                 setError(e.message || "ZK-Proof signup failed");
@@ -911,7 +1001,10 @@ export const ShogunButton = (() => {
             setShowImportSuccess(false);
             setRecoveredHint("");
             setZkTrapdoor("");
+            setZkSignupTrapdoor("");
+            setShowZkTrapdoorCopySuccess(false);
             setWebauthnSeedPhrase("");
+            setWebauthnRecoverySeed("");
         };
         const openModal = () => {
             resetForm();
@@ -921,11 +1014,13 @@ export const ShogunButton = (() => {
         const closeModal = () => {
             setError("");
             setModalIsOpen(false);
+            setHasPendingSignup(false);
         };
         const finalizeZkProofSignup = () => {
             setError("");
             resetForm();
             setModalIsOpen(false);
+            setHasPendingSignup(false);
         };
         const toggleMode = () => {
             resetForm();
@@ -1037,7 +1132,52 @@ export const ShogunButton = (() => {
                 React.createElement("input", { type: "text", id: "username", value: formUsername, onChange: (e) => setFormUsername(e.target.value), disabled: loading, required: true, placeholder: "Enter your username", autoFocus: true })),
             React.createElement("button", { type: "button", className: "shogun-submit-button", onClick: () => handleAuth("webauthn", formUsername), disabled: loading || !formUsername.trim() }, loading ? "Processing..." : `Continue with WebAuthn`),
             React.createElement("div", { className: "shogun-form-footer" },
-                React.createElement("button", { type: "button", className: "shogun-back-button", onClick: () => setAuthView("options"), disabled: loading }, "\u2190 Back to Options"))));
+                React.createElement("button", { type: "button", className: "shogun-back-button", onClick: () => setAuthView("options"), disabled: loading }, "\u2190 Back to Options"),
+                formMode === "login" && (React.createElement("button", { type: "button", className: "shogun-toggle-mode", onClick: () => setAuthView("webauthn-recovery"), disabled: loading }, "Restore with Recovery Code")))));
+        const renderWebauthnRecoveryForm = () => (React.createElement("div", { className: "shogun-auth-form" },
+            React.createElement("h3", null, "Restore WebAuthn Account"),
+            React.createElement("div", { style: {
+                    backgroundColor: "#fef3c7",
+                    padding: "12px",
+                    borderRadius: "8px",
+                    marginBottom: "16px",
+                    border: "1px solid #f59e0b",
+                } },
+                React.createElement("p", { style: {
+                        fontSize: "14px",
+                        color: "#92400e",
+                        margin: "0",
+                        fontWeight: "500",
+                    } }, "\u26A0\uFE0F Recovery Required"),
+                React.createElement("p", { style: {
+                        fontSize: "13px",
+                        color: "#a16207",
+                        margin: "4px 0 0 0",
+                    } }, "Enter the username and recovery code saved during signup to restore access on this device.")),
+            React.createElement("div", { className: "shogun-form-group" },
+                React.createElement("label", { htmlFor: "recoveryUsername" },
+                    React.createElement(UserIcon, null),
+                    React.createElement("span", null, "Username")),
+                React.createElement("input", { type: "text", id: "recoveryUsername", value: formUsername, onChange: (e) => setFormUsername(e.target.value), disabled: loading, placeholder: "Enter your username", autoFocus: true })),
+            React.createElement("div", { className: "shogun-form-group" },
+                React.createElement("label", { htmlFor: "recoverySeed" },
+                    React.createElement(KeyIcon, null),
+                    React.createElement("span", null, "Recovery Code")),
+                React.createElement("textarea", { id: "recoverySeed", value: webauthnRecoverySeed, onChange: (e) => setWebauthnRecoverySeed(e.target.value), disabled: loading, placeholder: "Enter your WebAuthn seed phrase...", rows: 4, style: {
+                        fontFamily: "monospace",
+                        fontSize: "12px",
+                        width: "100%",
+                        padding: "8px",
+                        border: "1px solid #f59e0b",
+                        borderRadius: "4px",
+                        backgroundColor: "#fffbeb",
+                    } })),
+            React.createElement("button", { type: "button", className: "shogun-submit-button", onClick: handleWebauthnImport, disabled: loading }, loading ? "Restoring..." : "Restore Account"),
+            React.createElement("div", { className: "shogun-form-footer" },
+                React.createElement("button", { type: "button", className: "shogun-back-button", onClick: () => {
+                        setError("");
+                        setAuthView("webauthn-username");
+                    }, disabled: loading }, "\u2190 Back to WebAuthn"))));
         const renderRecoveryForm = () => (React.createElement("div", { className: "shogun-auth-form" },
             React.createElement("div", { className: "shogun-form-group" },
                 React.createElement("label", { htmlFor: "username" },
@@ -1150,6 +1290,55 @@ export const ShogunButton = (() => {
             React.createElement("button", { type: "button", className: "shogun-submit-button", onClick: handleZkProofLogin, disabled: loading || !zkTrapdoor.trim() }, loading ? "Processing..." : "Login Anonymously"),
             React.createElement("div", { className: "shogun-form-footer" },
                 React.createElement("button", { className: "shogun-toggle-mode", onClick: () => setAuthView("options"), disabled: loading }, "Back to Login Options"))));
+        const renderZkProofSignupResult = () => (React.createElement("div", { className: "shogun-auth-form" },
+            React.createElement("h3", null, "ZK-Proof Account Created!"),
+            React.createElement("div", { style: {
+                    backgroundColor: "#fef3c7",
+                    padding: "12px",
+                    borderRadius: "8px",
+                    marginBottom: "16px",
+                    border: "1px solid #f59e0b",
+                } },
+                React.createElement("p", { style: {
+                        fontSize: "14px",
+                        color: "#92400e",
+                        margin: "0",
+                        fontWeight: "500",
+                    } }, "\u26A0\uFE0F Important: Save Your Trapdoor"),
+                React.createElement("p", { style: { fontSize: "13px", color: "#a16207", margin: "4px 0 0 0" } }, "This trapdoor lets you restore your anonymous identity on new devices. Store it securely and never share it.")),
+            React.createElement("div", { className: "shogun-form-group" },
+                React.createElement("label", null, "Your Trapdoor (Recovery Phrase):"),
+                React.createElement("textarea", { value: zkSignupTrapdoor, readOnly: true, rows: 4, style: {
+                        fontFamily: "monospace",
+                        fontSize: "12px",
+                        width: "100%",
+                        padding: "8px",
+                        border: "2px solid #f59e0b",
+                        borderRadius: "4px",
+                        backgroundColor: "#fffbeb",
+                    } }),
+                React.createElement("button", { type: "button", className: "shogun-submit-button", style: { marginTop: "8px" }, onClick: async () => {
+                        if (!zkSignupTrapdoor) {
+                            return;
+                        }
+                        try {
+                            if (navigator.clipboard) {
+                                await navigator.clipboard.writeText(zkSignupTrapdoor);
+                                setShowZkTrapdoorCopySuccess(true);
+                                setTimeout(() => setShowZkTrapdoorCopySuccess(false), 3000);
+                            }
+                        }
+                        catch (copyError) {
+                            console.warn("Failed to copy trapdoor:", copyError);
+                        }
+                    }, disabled: !zkSignupTrapdoor }, "Copy Trapdoor"),
+                showZkTrapdoorCopySuccess && (React.createElement("p", { style: {
+                        color: "#047857",
+                        fontSize: "12px",
+                        marginTop: "6px",
+                    } }, "Trapdoor copied to clipboard!"))),
+            React.createElement("div", { className: "shogun-form-footer" },
+                React.createElement("button", { type: "button", className: "shogun-submit-button", onClick: finalizeZkProofSignup }, "I Saved My Trapdoor"))));
         const renderWebauthnSignupResult = () => (React.createElement("div", { className: "shogun-auth-form" },
             React.createElement("h3", null, "WebAuthn Account Created!"),
             React.createElement("div", { style: {
@@ -1292,9 +1481,13 @@ export const ShogunButton = (() => {
                         authView === "import" && renderImportForm(),
                         authView === "webauthn-username" &&
                             renderWebAuthnUsernameForm(),
+                        authView === "webauthn-recovery" &&
+                            renderWebauthnRecoveryForm(),
                         authView === "webauthn-signup-result" &&
                             renderWebauthnSignupResult(),
-                        authView === "zkproof-login" && renderZkProofLoginForm()))))));
+                        authView === "zkproof-login" && renderZkProofLoginForm(),
+                        authView === "zkproof-signup-result" &&
+                            renderZkProofSignupResult()))))));
     };
     Button.displayName = "ShogunButton";
     return Object.assign(Button, {