@stacknet/keyutils 0.4.8 → 0.5.0

package/dist/components/index.d.cts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-import { KeyUtilsConfig, KeyUtilsCallbacks, KeyWidgetTab, PlatformDownload, NodeKeyInfo, MintResult, FilingResult } from '../types/index.cjs';
+import { KeyUtilsConfig, KeyUtilsCallbacks, KeyWidgetTab, PlatformDownload, NodeKeyInfo, MintResult, FilingResult, FilingTrackerState, StackPayoutCapabilities, PayoutMethod } from '../types/index.cjs';
 
 interface KeyUtilsContextValue {
     config: KeyUtilsConfig;
@@ -16,10 +16,14 @@ declare function KeyUtilsProvider({ config, callbacks, children, }: KeyUtilsProv
 
 interface BuyKeyWidgetProps extends KeyUtilsConfig, KeyUtilsCallbacks {
     defaultTab?: KeyWidgetTab;
+    /** When provided, the filing flow surfaces an "Open filing" button that fires this. */
+    onViewFiling?: (filingId: string) => void;
+    /** When provided, the filing flow surfaces a "Set up earnings account" CTA. */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function BuyKeyWidget({ apiBaseUrl, stackId, stackName, paymentMethods, merchantWallet, stripePublicKey, theme, maxQuantity, keyImage, keyImageClass, aispImage, termsUrl, onMintSuccess, onMintError, onPaymentStart, onPaymentComplete, onListingCreated, onTransferComplete, defaultTab, className, style, }: BuyKeyWidgetProps): react_jsx_runtime.JSX.Element;
+declare function BuyKeyWidget({ apiBaseUrl, stackId, stackName, paymentMethods, merchantWallet, stripePublicKey, theme, maxQuantity, keyImage, keyImageClass, aispImage, termsUrl, onMintSuccess, onMintError, onPaymentStart, onPaymentComplete, onListingCreated, onTransferComplete, onFilingComplete, onFilingError, defaultTab, onViewFiling, onConfigureEarnings, className, style, }: BuyKeyWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface BuyPanelProps {
     className?: string;
@@ -41,19 +45,42 @@ interface SellPanelProps {
 declare function SellPanel({ className, style }: SellPanelProps): react_jsx_runtime.JSX.Element;
 
 interface KeysPanelProps {
+    /**
+     * When provided, the filing success state in KeyDetailView shows an
+     * "Open filing" button that fires this callback so the host can navigate
+     * to /files/{filingId}.
+     */
+    onViewFiling?: (filingId: string) => void;
+    /**
+     * When provided, the filing flow surfaces a "Set up earnings account"
+     * affordance if the user hasn't connected a payout method yet — the host
+     * should route to Settings → Account.
+     */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function KeysPanel({ className, style }: KeysPanelProps): react_jsx_runtime.JSX.Element;
+declare function KeysPanel({ onViewFiling, onConfigureEarnings, className, style }: KeysPanelProps): react_jsx_runtime.JSX.Element;
 
 interface KeyDetailViewProps {
     nodeKey: NodeKeyInfo;
     onBack: () => void;
     onKeysChanged?: () => void;
+    /**
+     * When provided, the filing success state shows an "Open filing" button
+     * that fires this callback so the host can navigate to /files/{filingId}.
+     */
+    onViewFiling?: (filingId: string) => void;
+    /**
+     * When provided, the filing flow surfaces a "Set up earnings account"
+     * button if the user hasn't connected a payout method yet. The host
+     * should navigate to Settings → Account.
+     */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function KeyDetailView({ nodeKey, onBack, onKeysChanged, className, style }: KeyDetailViewProps): react_jsx_runtime.JSX.Element;
+declare function KeyDetailView({ nodeKey, onBack, onKeysChanged, onViewFiling, onConfigureEarnings, className, style }: KeyDetailViewProps): react_jsx_runtime.JSX.Element;
 
 interface BottomSheetProps {
     open: boolean;
@@ -115,22 +142,26 @@ declare function TransferPanel({ className, style }: TransferPanelProps): react_
 interface FilePaperworkViewProps {
     /** The key id to file paperwork against. */
     keyId: string;
-    /**
-     * Beneficiary payment address (e.g. user's stack-scoped payment_address).
-     * If omitted, the view shows a "configure your payment address" notice and
-     * disables the file action.
-     */
-    paymentAddress?: string | null;
-    /** Called after a successful filing. */
+    /** Called after a successful filing (after the inline tracker renders). */
     onComplete?: (result: FilingResult) => void;
-    /** Called when the user clicks the "configure payment address" affordance. */
-    onConfigurePayment?: () => void;
     /** Called when the user clicks the back affordance from the success state. */
     onBack?: () => void;
+    /**
+     * Called when the user wants to view the standalone /files/{filingId} page.
+     * When provided, the success state shows a "View filing" link that fires
+     * this callback (e.g. host can `router.push` to that route).
+     */
+    onViewFiling?: (filingId: string) => void;
+    /**
+     * Called when the user clicks the "set up earnings account" CTA shown
+     * when no payout method is configured. The host should navigate to
+     * Settings → Account so the user can connect a destination.
+     */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function FilePaperworkView({ keyId, paymentAddress, onComplete, onConfigurePayment, onBack, className, style, }: FilePaperworkViewProps): react_jsx_runtime.JSX.Element;
+declare function FilePaperworkView({ keyId, onComplete, onBack, onViewFiling, onConfigureEarnings, className, style, }: FilePaperworkViewProps): react_jsx_runtime.JSX.Element;
 
 interface FilePaperworkListProps {
     /** Called when the user picks an eligible key to file. */
@@ -140,6 +171,54 @@ interface FilePaperworkListProps {
 }
 declare function FilePaperworkList({ onSelect, className, style }: FilePaperworkListProps): react_jsx_runtime.JSX.Element;
 
+interface FilingDetailViewProps {
+    filingId: string;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function FilingDetailView({ filingId, className, style }: FilingDetailViewProps): react_jsx_runtime.JSX.Element;
+
+interface FilingTrackerProps {
+    states: FilingTrackerState[];
+    className?: string;
+}
+declare function FilingTracker({ states, className }: FilingTrackerProps): react_jsx_runtime.JSX.Element;
+
+interface PayoutMethodPickerProps {
+    caps: StackPayoutCapabilities;
+    value: PayoutMethod;
+    onChange: (method: PayoutMethod) => void;
+    className?: string;
+    disabled?: boolean;
+}
+declare function PayoutMethodPicker({ caps, value, onChange, className, disabled, }: PayoutMethodPickerProps): react_jsx_runtime.JSX.Element;
+
+interface TypingTextProps {
+    text: string;
+    /** ms per character; default 40. */
+    speedMs?: number;
+    /** when false, snap to full text, no cursor. */
+    playing: boolean;
+    className?: string;
+}
+/**
+ * Terminal-typing animation: prints characters one at a time with a blinking
+ * cursor trailing. When `playing` is false the cursor is hidden and we snap
+ * to the full text — used for `done` headlines.
+ *
+ * Lifted from stripe-resolution; intentionally simple (one setTimeout per
+ * char, no RAF).
+ */
+declare function TypingText({ text, speedMs, playing, className }: TypingTextProps): react_jsx_runtime.JSX.Element;
+
+interface PayoutAccountPanelProps {
+    /** Called after a successful connect/disconnect so the host can refresh derived UI. */
+    onChange?: () => void;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function PayoutAccountPanel({ onChange, className, style }: PayoutAccountPanelProps): react_jsx_runtime.JSX.Element;
+
 declare const ASCII_KEY_ART: string[];
 interface DefaultKeyArtProps {
     className?: string;
@@ -151,4 +230,4 @@ interface DefaultKeyArtProps {
 }
 declare function DefaultKeyArt({ className, style, color, ariaLabel, keyImage, keyImageClass, }: DefaultKeyArtProps): react_jsx_runtime.JSX.Element;
 
-export { ASCII_KEY_ART, BottomSheet, type BottomSheetProps, BuyKeyWidget, type BuyKeyWidgetProps, BuyPanel, type BuyPanelProps, DefaultKeyArt, type DefaultKeyArtProps, FilePaperworkList, type FilePaperworkListProps, FilePaperworkView, type FilePaperworkViewProps, KeyBalanceBar, type KeyBalanceBarProps, KeyCard, type KeyCardProps, KeyDetailView, type KeyDetailViewProps, KeyList, type KeyListProps, KeyUtilsProvider, type KeyUtilsProviderProps, KeysPanel, type KeysPanelProps, MintSuccess, type MintSuccessProps, SellPanel, type SellPanelProps, SolanaPayButton, type SolanaPayButtonProps, TransferPanel, type TransferPanelProps, UsePanel, type UsePanelProps, useKeyUtilsContext };
+export { ASCII_KEY_ART, BottomSheet, type BottomSheetProps, BuyKeyWidget, type BuyKeyWidgetProps, BuyPanel, type BuyPanelProps, DefaultKeyArt, type DefaultKeyArtProps, FilePaperworkList, type FilePaperworkListProps, FilePaperworkView, type FilePaperworkViewProps, FilingDetailView, type FilingDetailViewProps, FilingTracker, type FilingTrackerProps, KeyBalanceBar, type KeyBalanceBarProps, KeyCard, type KeyCardProps, KeyDetailView, type KeyDetailViewProps, KeyList, type KeyListProps, KeyUtilsProvider, type KeyUtilsProviderProps, KeysPanel, type KeysPanelProps, MintSuccess, type MintSuccessProps, PayoutAccountPanel, type PayoutAccountPanelProps, PayoutMethodPicker, type PayoutMethodPickerProps, SellPanel, type SellPanelProps, SolanaPayButton, type SolanaPayButtonProps, TransferPanel, type TransferPanelProps, TypingText, UsePanel, type UsePanelProps, useKeyUtilsContext };

package/dist/components/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-import { KeyUtilsConfig, KeyUtilsCallbacks, KeyWidgetTab, PlatformDownload, NodeKeyInfo, MintResult, FilingResult } from '../types/index.js';
+import { KeyUtilsConfig, KeyUtilsCallbacks, KeyWidgetTab, PlatformDownload, NodeKeyInfo, MintResult, FilingResult, FilingTrackerState, StackPayoutCapabilities, PayoutMethod } from '../types/index.js';
 
 interface KeyUtilsContextValue {
     config: KeyUtilsConfig;
@@ -16,10 +16,14 @@ declare function KeyUtilsProvider({ config, callbacks, children, }: KeyUtilsProv
 
 interface BuyKeyWidgetProps extends KeyUtilsConfig, KeyUtilsCallbacks {
     defaultTab?: KeyWidgetTab;
+    /** When provided, the filing flow surfaces an "Open filing" button that fires this. */
+    onViewFiling?: (filingId: string) => void;
+    /** When provided, the filing flow surfaces a "Set up earnings account" CTA. */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function BuyKeyWidget({ apiBaseUrl, stackId, stackName, paymentMethods, merchantWallet, stripePublicKey, theme, maxQuantity, keyImage, keyImageClass, aispImage, termsUrl, onMintSuccess, onMintError, onPaymentStart, onPaymentComplete, onListingCreated, onTransferComplete, defaultTab, className, style, }: BuyKeyWidgetProps): react_jsx_runtime.JSX.Element;
+declare function BuyKeyWidget({ apiBaseUrl, stackId, stackName, paymentMethods, merchantWallet, stripePublicKey, theme, maxQuantity, keyImage, keyImageClass, aispImage, termsUrl, onMintSuccess, onMintError, onPaymentStart, onPaymentComplete, onListingCreated, onTransferComplete, onFilingComplete, onFilingError, defaultTab, onViewFiling, onConfigureEarnings, className, style, }: BuyKeyWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface BuyPanelProps {
     className?: string;
@@ -41,19 +45,42 @@ interface SellPanelProps {
 declare function SellPanel({ className, style }: SellPanelProps): react_jsx_runtime.JSX.Element;
 
 interface KeysPanelProps {
+    /**
+     * When provided, the filing success state in KeyDetailView shows an
+     * "Open filing" button that fires this callback so the host can navigate
+     * to /files/{filingId}.
+     */
+    onViewFiling?: (filingId: string) => void;
+    /**
+     * When provided, the filing flow surfaces a "Set up earnings account"
+     * affordance if the user hasn't connected a payout method yet — the host
+     * should route to Settings → Account.
+     */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function KeysPanel({ className, style }: KeysPanelProps): react_jsx_runtime.JSX.Element;
+declare function KeysPanel({ onViewFiling, onConfigureEarnings, className, style }: KeysPanelProps): react_jsx_runtime.JSX.Element;
 
 interface KeyDetailViewProps {
     nodeKey: NodeKeyInfo;
     onBack: () => void;
     onKeysChanged?: () => void;
+    /**
+     * When provided, the filing success state shows an "Open filing" button
+     * that fires this callback so the host can navigate to /files/{filingId}.
+     */
+    onViewFiling?: (filingId: string) => void;
+    /**
+     * When provided, the filing flow surfaces a "Set up earnings account"
+     * button if the user hasn't connected a payout method yet. The host
+     * should navigate to Settings → Account.
+     */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function KeyDetailView({ nodeKey, onBack, onKeysChanged, className, style }: KeyDetailViewProps): react_jsx_runtime.JSX.Element;
+declare function KeyDetailView({ nodeKey, onBack, onKeysChanged, onViewFiling, onConfigureEarnings, className, style }: KeyDetailViewProps): react_jsx_runtime.JSX.Element;
 
 interface BottomSheetProps {
     open: boolean;
@@ -115,22 +142,26 @@ declare function TransferPanel({ className, style }: TransferPanelProps): react_
 interface FilePaperworkViewProps {
     /** The key id to file paperwork against. */
     keyId: string;
-    /**
-     * Beneficiary payment address (e.g. user's stack-scoped payment_address).
-     * If omitted, the view shows a "configure your payment address" notice and
-     * disables the file action.
-     */
-    paymentAddress?: string | null;
-    /** Called after a successful filing. */
+    /** Called after a successful filing (after the inline tracker renders). */
     onComplete?: (result: FilingResult) => void;
-    /** Called when the user clicks the "configure payment address" affordance. */
-    onConfigurePayment?: () => void;
     /** Called when the user clicks the back affordance from the success state. */
     onBack?: () => void;
+    /**
+     * Called when the user wants to view the standalone /files/{filingId} page.
+     * When provided, the success state shows a "View filing" link that fires
+     * this callback (e.g. host can `router.push` to that route).
+     */
+    onViewFiling?: (filingId: string) => void;
+    /**
+     * Called when the user clicks the "set up earnings account" CTA shown
+     * when no payout method is configured. The host should navigate to
+     * Settings → Account so the user can connect a destination.
+     */
+    onConfigureEarnings?: () => void;
     className?: string;
     style?: React.CSSProperties;
 }
-declare function FilePaperworkView({ keyId, paymentAddress, onComplete, onConfigurePayment, onBack, className, style, }: FilePaperworkViewProps): react_jsx_runtime.JSX.Element;
+declare function FilePaperworkView({ keyId, onComplete, onBack, onViewFiling, onConfigureEarnings, className, style, }: FilePaperworkViewProps): react_jsx_runtime.JSX.Element;
 
 interface FilePaperworkListProps {
     /** Called when the user picks an eligible key to file. */
@@ -140,6 +171,54 @@ interface FilePaperworkListProps {
 }
 declare function FilePaperworkList({ onSelect, className, style }: FilePaperworkListProps): react_jsx_runtime.JSX.Element;
 
+interface FilingDetailViewProps {
+    filingId: string;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function FilingDetailView({ filingId, className, style }: FilingDetailViewProps): react_jsx_runtime.JSX.Element;
+
+interface FilingTrackerProps {
+    states: FilingTrackerState[];
+    className?: string;
+}
+declare function FilingTracker({ states, className }: FilingTrackerProps): react_jsx_runtime.JSX.Element;
+
+interface PayoutMethodPickerProps {
+    caps: StackPayoutCapabilities;
+    value: PayoutMethod;
+    onChange: (method: PayoutMethod) => void;
+    className?: string;
+    disabled?: boolean;
+}
+declare function PayoutMethodPicker({ caps, value, onChange, className, disabled, }: PayoutMethodPickerProps): react_jsx_runtime.JSX.Element;
+
+interface TypingTextProps {
+    text: string;
+    /** ms per character; default 40. */
+    speedMs?: number;
+    /** when false, snap to full text, no cursor. */
+    playing: boolean;
+    className?: string;
+}
+/**
+ * Terminal-typing animation: prints characters one at a time with a blinking
+ * cursor trailing. When `playing` is false the cursor is hidden and we snap
+ * to the full text — used for `done` headlines.
+ *
+ * Lifted from stripe-resolution; intentionally simple (one setTimeout per
+ * char, no RAF).
+ */
+declare function TypingText({ text, speedMs, playing, className }: TypingTextProps): react_jsx_runtime.JSX.Element;
+
+interface PayoutAccountPanelProps {
+    /** Called after a successful connect/disconnect so the host can refresh derived UI. */
+    onChange?: () => void;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function PayoutAccountPanel({ onChange, className, style }: PayoutAccountPanelProps): react_jsx_runtime.JSX.Element;
+
 declare const ASCII_KEY_ART: string[];
 interface DefaultKeyArtProps {
     className?: string;
@@ -151,4 +230,4 @@ interface DefaultKeyArtProps {
 }
 declare function DefaultKeyArt({ className, style, color, ariaLabel, keyImage, keyImageClass, }: DefaultKeyArtProps): react_jsx_runtime.JSX.Element;
 
-export { ASCII_KEY_ART, BottomSheet, type BottomSheetProps, BuyKeyWidget, type BuyKeyWidgetProps, BuyPanel, type BuyPanelProps, DefaultKeyArt, type DefaultKeyArtProps, FilePaperworkList, type FilePaperworkListProps, FilePaperworkView, type FilePaperworkViewProps, KeyBalanceBar, type KeyBalanceBarProps, KeyCard, type KeyCardProps, KeyDetailView, type KeyDetailViewProps, KeyList, type KeyListProps, KeyUtilsProvider, type KeyUtilsProviderProps, KeysPanel, type KeysPanelProps, MintSuccess, type MintSuccessProps, SellPanel, type SellPanelProps, SolanaPayButton, type SolanaPayButtonProps, TransferPanel, type TransferPanelProps, UsePanel, type UsePanelProps, useKeyUtilsContext };
+export { ASCII_KEY_ART, BottomSheet, type BottomSheetProps, BuyKeyWidget, type BuyKeyWidgetProps, BuyPanel, type BuyPanelProps, DefaultKeyArt, type DefaultKeyArtProps, FilePaperworkList, type FilePaperworkListProps, FilePaperworkView, type FilePaperworkViewProps, FilingDetailView, type FilingDetailViewProps, FilingTracker, type FilingTrackerProps, KeyBalanceBar, type KeyBalanceBarProps, KeyCard, type KeyCardProps, KeyDetailView, type KeyDetailViewProps, KeyList, type KeyListProps, KeyUtilsProvider, type KeyUtilsProviderProps, KeysPanel, type KeysPanelProps, MintSuccess, type MintSuccessProps, PayoutAccountPanel, type PayoutAccountPanelProps, PayoutMethodPicker, type PayoutMethodPickerProps, SellPanel, type SellPanelProps, SolanaPayButton, type SolanaPayButtonProps, TransferPanel, type TransferPanelProps, TypingText, UsePanel, type UsePanelProps, useKeyUtilsContext };