@explorins/pers-signer 1.0.16 → 1.0.17

package/dist/browser.d.ts

@@ -479,6 +479,207 @@ interface TransactionSigningParams {
     returnUrl?: string;
 }
 
+/**
+ * PERS Blockchain Signer SDK
+ *
+ * A lightweight blockchain transaction signing SDK with WebAuthn authentication.
+ * Provides 5 focused methods for complete transaction lifecycle management:
+ *
+ * 1. loginUser(jwtToken) - Authenticate user with 5-minute caching
+ * 2. signTransaction(signingData, jwtToken) - Sign transactions with auto-login
+ * 3. submitTransaction(signedTx, jwtToken) - Submit signed transactions to blockchain
+ * 4. signPersTransaction(jwtToken) - Legacy one-liner for backward compatibility
+ * 5. signAndSubmitPersTransaction(jwtToken) - Complete sign + submit flow
+ *
+ * @example
+ * ```typescript
+ * import { createPersSignerSDK } from '@explorins/pers-signer';
+ *
+ * const sdk = createPersSignerSDK({
+ *   webAuthnProvider: myWebAuthnProvider,
+ *   ethersProviderUrl: 'https://ethereum-rpc.com'
+ * });
+ *
+ * // Quick sign and submit
+ * const result = await sdk.signAndSubmitPersTransaction(jwtToken);
+ * if (result.success) {
+ *   console.log('Transaction submitted:', result.transactionHash);
+ * }
+ * ```
+ */
+
+/**
+ * Configuration interface for the PERS Signer SDK
+ *
+ * @interface PersSignerConfig
+ * @property {string} [tenantId] - Optional tenant identifier for multi-tenant applications
+ * @property {string} [ethersProviderUrl] - Custom Ethereum RPC provider URL
+ * @property {WebAuthnProvider} webAuthnProvider - WebAuthn provider for secure authentication
+ * @property {string} [apiUrl] - Custom API base URL (defaults to production)
+ * @property {string} [relyingPartyName] - WebAuthn relying party name for authentication
+ */
+interface ExtendedPersSignerConfig {
+    ethersProviderUrl?: string;
+    webAuthnProvider: WebAuthnProvider;
+    apiUrl?: string;
+    relyingPartyName?: string;
+}
+interface PersSignerConfig extends Omit<ExtendedPersSignerConfig, 'webAuthnProvider'> {
+}
+/**
+ * PERS Blockchain Signer SDK Class
+ *
+ * Main SDK class providing blockchain transaction signing capabilities with WebAuthn authentication.
+ * Implements a clean 5-method API for complete transaction lifecycle management.
+ *
+ * Features:
+ * - WebAuthn-based secure authentication
+ * - 5-minute user session caching
+ * - Automatic transaction data fetching
+ * - Blockchain transaction signing and submission
+ * - Multi-tenant support
+ *
+ * @class PersSignerSDK
+ */
+declare class PersSignerSDK {
+    private config;
+    private authenticationService;
+    private transactionSigningService;
+    /**
+     * Initialize the PERS Signer SDK
+     *
+     * @param {ExtendedPersSignerConfig} config - SDK configuration object
+     * @throws {Error} If required configuration is missing
+     */
+    constructor(config: ExtendedPersSignerConfig);
+    /**
+     * Authenticate user and cache session for 5 minutes
+     *
+     * Validates JWT token, authenticates with both signer and PERS backends,
+     * and caches the authenticated user session to avoid repeated authentication.
+     *
+     * @param {string} jwtToken - JWT token containing user identifier and tenant info
+     * @returns {Promise<AuthenticatedUser>} Authenticated user with access tokens
+     * @throws {Error} If JWT is invalid, expired, or authentication fails
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const user = await sdk.loginUser(jwtToken);
+     *   console.log('Authenticated:', user.identifier);
+     * } catch (error) {
+     *   console.error('Authentication failed:', error.message);
+     * }
+     * ```
+     */
+    loginUser(jwtToken: string): Promise<AuthenticatedUser>;
+    /**
+     * Sign a PERS transaction (legacy compatibility method)
+     *
+     * Automatically handles user authentication, transaction data fetching,
+     * and transaction signing in a single call. This is the legacy method
+     * maintained for backward compatibility.
+     *
+     * @param {string} jwtToken - JWT token containing transaction ID and user info
+     * @returns {Promise<TransactionSigningResult>} Signing result with signature and metadata
+     * @throws {Error} If authentication fails, transaction ID missing, or signing fails
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const result = await sdk.signPersTransaction(jwtToken);
+     *   if (result.success) {
+     *     console.log('Transaction signed:', result.signature);
+     *   }
+     * } catch (error) {
+     *   console.error('Signing failed:', error.message);
+     * }
+     * ```
+     */
+    signPersTransaction(jwtToken: string): Promise<TransactionSigningResult>;
+    /**
+     * Sign a transaction with provided signing data
+     *
+     * Low-level method to sign transactions when you already have the signing data.
+     * Automatically handles user authentication and applies the blockchain signature.
+     *
+     * @param {CounterfactualWalletTransactionResponse | LegacyTransaction} signingData - Transaction data to sign
+     * @param {string} jwtToken - JWT token containing transaction ID and user info
+     * @returns {Promise<TransactionSigningResult>} Signing result with signature and metadata
+     * @throws {Error} If authentication fails, transaction ID missing, or signing fails
+     *
+     * @example
+     * ```typescript
+     * const signingData = await getTransactionData(transactionId);
+     * const result = await sdk.signTransaction(signingData, jwtToken);
+     * console.log('Signed transaction:', result.signature);
+     * ```
+     */
+    signTransaction(signingData: CounterfactualWalletTransactionResponse$1 | LegacyTransaction, jwtToken: string): Promise<TransactionSigningResult>;
+    /**
+     * Complete transaction flow: sign and submit in one call
+     *
+     * Convenience method that combines signing and submission into a single operation.
+     * This is the recommended method for most use cases as it handles the complete
+     * transaction lifecycle automatically.
+     *
+     * @param {string} jwtToken - JWT token containing transaction ID and user info
+     * @returns {Promise<SubmissionResult>} Submission result with transaction hash and status
+     * @throws {Error} If authentication, signing, or submission fails
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const result = await sdk.signAndSubmitPersTransaction(jwtToken);
+     *   if (result.success) {
+     *     console.log('Transaction completed:', result.transactionHash);
+     *     if (result.shouldRedirect) {
+     *       window.location.href = result.redirectUrl;
+     *     }
+     *   }
+     * } catch (error) {
+     *   console.error('Transaction failed:', error.message);
+     * }
+     * ```
+     */
+    signAndSubmitPersTransaction(jwtToken: string): Promise<SubmissionResult>;
+    /**
+     * Submit a signed transaction to the blockchain
+     *
+     * Takes a signed transaction result and submits it to the blockchain network.
+     * Returns detailed submission results including transaction hash and any
+     * redirect information for UI flows.
+     *
+     * @param {TransactionSigningResult} signingResult - Result from a successful transaction signing
+     * @param {string} jwtToken - JWT token containing tenant and user info
+     * @returns {Promise<SubmissionResult>} Submission result with transaction hash and status
+     * @throws {Error} If signing result is invalid, JWT is missing tenantId, or submission fails
+     *
+     * @example
+     * ```typescript
+     * const signedTx = await sdk.signPersTransaction(jwtToken);
+     * const result = await sdk.submitTransaction(signedTx, jwtToken);
+     * console.log('Transaction submitted:', result.transactionHash);
+     * ```
+     */
+    submitTransaction(signingResult: TransactionSigningResult, jwtToken: string): Promise<SubmissionResult>;
+    /**
+     * Clear user authentication cache
+     *
+     * Removes all cached user sessions, forcing fresh authentication
+     * on the next method call. Useful for logout scenarios or when
+     * switching between different user contexts.
+     *
+     * @example
+     * ```typescript
+     * // Clear cache on user logout
+     * sdk.clearCache();
+     * console.log('User cache cleared');
+     * ```
+     */
+    clearCache(): void;
+}
+
 /**
  * Service for orchestrating transaction signing operations
  * Handles the complete flow from transaction preparation to submission
@@ -486,7 +687,7 @@ interface TransactionSigningParams {
  */
 declare class TransactionSigningService {
     private webAuthnProvider;
-    constructor(config: PersSignerConfig);
+    constructor(config: ExtendedPersSignerConfig);
     /**
      * Prepare transaction for signing - fetch and validate
      */
@@ -749,206 +950,6 @@ declare function setHttpClient(client: HttpClient): void;
  */
 declare function getHttpClient(): HttpClient;
 
-/**
- * PERS Blockchain Signer SDK
- *
- * A lightweight blockchain transaction signing SDK with WebAuthn authentication.
- * Provides 5 focused methods for complete transaction lifecycle management:
- *
- * 1. loginUser(jwtToken) - Authenticate user with 5-minute caching
- * 2. signTransaction(signingData, jwtToken) - Sign transactions with auto-login
- * 3. submitTransaction(signedTx, jwtToken) - Submit signed transactions to blockchain
- * 4. signPersTransaction(jwtToken) - Legacy one-liner for backward compatibility
- * 5. signAndSubmitPersTransaction(jwtToken) - Complete sign + submit flow
- *
- * @example
- * ```typescript
- * import { createPersSignerSDK } from '@explorins/pers-signer';
- *
- * const sdk = createPersSignerSDK({
- *   webAuthnProvider: myWebAuthnProvider,
- *   ethersProviderUrl: 'https://ethereum-rpc.com'
- * });
- *
- * // Quick sign and submit
- * const result = await sdk.signAndSubmitPersTransaction(jwtToken);
- * if (result.success) {
- *   console.log('Transaction submitted:', result.transactionHash);
- * }
- * ```
- */
-
-/**
- * Configuration interface for the PERS Signer SDK
- *
- * @interface PersSignerConfig
- * @property {string} [tenantId] - Optional tenant identifier for multi-tenant applications
- * @property {string} [ethersProviderUrl] - Custom Ethereum RPC provider URL
- * @property {WebAuthnProvider} webAuthnProvider - WebAuthn provider for secure authentication
- * @property {string} [apiUrl] - Custom API base URL (defaults to production)
- * @property {string} [relyingPartyName] - WebAuthn relying party name for authentication
- */
-interface PersSignerConfig {
-    tenantId?: string;
-    ethersProviderUrl?: string;
-    webAuthnProvider: WebAuthnProvider;
-    apiUrl?: string;
-    relyingPartyName?: string;
-}
-/**
- * PERS Blockchain Signer SDK Class
- *
- * Main SDK class providing blockchain transaction signing capabilities with WebAuthn authentication.
- * Implements a clean 5-method API for complete transaction lifecycle management.
- *
- * Features:
- * - WebAuthn-based secure authentication
- * - 5-minute user session caching
- * - Automatic transaction data fetching
- * - Blockchain transaction signing and submission
- * - Multi-tenant support
- *
- * @class PersSignerSDK
- */
-declare class PersSignerSDK {
-    private config;
-    private authenticationService;
-    private transactionSigningService;
-    /**
-     * Initialize the PERS Signer SDK
-     *
-     * @param {PersSignerConfig} config - SDK configuration object
-     * @throws {Error} If required configuration is missing
-     */
-    constructor(config: PersSignerConfig);
-    /**
-     * Authenticate user and cache session for 5 minutes
-     *
-     * Validates JWT token, authenticates with both signer and PERS backends,
-     * and caches the authenticated user session to avoid repeated authentication.
-     *
-     * @param {string} jwtToken - JWT token containing user identifier and tenant info
-     * @returns {Promise<AuthenticatedUser>} Authenticated user with access tokens
-     * @throws {Error} If JWT is invalid, expired, or authentication fails
-     *
-     * @example
-     * ```typescript
-     * try {
-     *   const user = await sdk.loginUser(jwtToken);
-     *   console.log('Authenticated:', user.identifier);
-     * } catch (error) {
-     *   console.error('Authentication failed:', error.message);
-     * }
-     * ```
-     */
-    loginUser(jwtToken: string): Promise<AuthenticatedUser>;
-    /**
-     * Sign a PERS transaction (legacy compatibility method)
-     *
-     * Automatically handles user authentication, transaction data fetching,
-     * and transaction signing in a single call. This is the legacy method
-     * maintained for backward compatibility.
-     *
-     * @param {string} jwtToken - JWT token containing transaction ID and user info
-     * @returns {Promise<TransactionSigningResult>} Signing result with signature and metadata
-     * @throws {Error} If authentication fails, transaction ID missing, or signing fails
-     *
-     * @example
-     * ```typescript
-     * try {
-     *   const result = await sdk.signPersTransaction(jwtToken);
-     *   if (result.success) {
-     *     console.log('Transaction signed:', result.signature);
-     *   }
-     * } catch (error) {
-     *   console.error('Signing failed:', error.message);
-     * }
-     * ```
-     */
-    signPersTransaction(jwtToken: string): Promise<TransactionSigningResult>;
-    /**
-     * Sign a transaction with provided signing data
-     *
-     * Low-level method to sign transactions when you already have the signing data.
-     * Automatically handles user authentication and applies the blockchain signature.
-     *
-     * @param {CounterfactualWalletTransactionResponse | LegacyTransaction} signingData - Transaction data to sign
-     * @param {string} jwtToken - JWT token containing transaction ID and user info
-     * @returns {Promise<TransactionSigningResult>} Signing result with signature and metadata
-     * @throws {Error} If authentication fails, transaction ID missing, or signing fails
-     *
-     * @example
-     * ```typescript
-     * const signingData = await getTransactionData(transactionId);
-     * const result = await sdk.signTransaction(signingData, jwtToken);
-     * console.log('Signed transaction:', result.signature);
-     * ```
-     */
-    signTransaction(signingData: CounterfactualWalletTransactionResponse$1 | LegacyTransaction, jwtToken: string): Promise<TransactionSigningResult>;
-    /**
-     * Complete transaction flow: sign and submit in one call
-     *
-     * Convenience method that combines signing and submission into a single operation.
-     * This is the recommended method for most use cases as it handles the complete
-     * transaction lifecycle automatically.
-     *
-     * @param {string} jwtToken - JWT token containing transaction ID and user info
-     * @returns {Promise<SubmissionResult>} Submission result with transaction hash and status
-     * @throws {Error} If authentication, signing, or submission fails
-     *
-     * @example
-     * ```typescript
-     * try {
-     *   const result = await sdk.signAndSubmitPersTransaction(jwtToken);
-     *   if (result.success) {
-     *     console.log('Transaction completed:', result.transactionHash);
-     *     if (result.shouldRedirect) {
-     *       window.location.href = result.redirectUrl;
-     *     }
-     *   }
-     * } catch (error) {
-     *   console.error('Transaction failed:', error.message);
-     * }
-     * ```
-     */
-    signAndSubmitPersTransaction(jwtToken: string): Promise<SubmissionResult>;
-    /**
-     * Submit a signed transaction to the blockchain
-     *
-     * Takes a signed transaction result and submits it to the blockchain network.
-     * Returns detailed submission results including transaction hash and any
-     * redirect information for UI flows.
-     *
-     * @param {TransactionSigningResult} signingResult - Result from a successful transaction signing
-     * @param {string} jwtToken - JWT token containing tenant and user info
-     * @returns {Promise<SubmissionResult>} Submission result with transaction hash and status
-     * @throws {Error} If signing result is invalid, JWT is missing tenantId, or submission fails
-     *
-     * @example
-     * ```typescript
-     * const signedTx = await sdk.signPersTransaction(jwtToken);
-     * const result = await sdk.submitTransaction(signedTx, jwtToken);
-     * console.log('Transaction submitted:', result.transactionHash);
-     * ```
-     */
-    submitTransaction(signingResult: TransactionSigningResult, jwtToken: string): Promise<SubmissionResult>;
-    /**
-     * Clear user authentication cache
-     *
-     * Removes all cached user sessions, forcing fresh authentication
-     * on the next method call. Useful for logout scenarios or when
-     * switching between different user contexts.
-     *
-     * @example
-     * ```typescript
-     * // Clear cache on user logout
-     * sdk.clearCache();
-     * console.log('User cache cleared');
-     * ```
-     */
-    clearCache(): void;
-}
-
 /**
  * Wallet list response from WalletService
  */
@@ -988,7 +989,7 @@ declare class AuthenticationService {
     private signerToken;
     private config;
     private webAuthnProvider;
-    constructor(config: PersSignerConfig);
+    constructor(config: ExtendedPersSignerConfig);
     /**
      * Login with PERS token to get signer JWT
      * @param persToken - PERS JWT from PERS authentication
@@ -1054,7 +1055,7 @@ declare function getBrowserWebAuthnProvider(): Promise<WebAuthnProvider>;
  * Create a new PersSignerSDK instance with browser WebAuthn provider
  * @param config - SDK configuration (ethersProviderUrl is required)
  */
-declare function createPersSignerSDK(config: Omit<PersSignerConfig, 'webAuthnProvider'>): Promise<PersSignerSDK>;
+declare function createPersSignerSDK(config: PersSignerConfig): Promise<PersSignerSDK>;
 
 export { AuthenticationService, FetchHttpClient, KeyWallet, PersService, PersSignerSDK, ReactNativeConfigProvider, SIGNABLE_STATUSES, SigningService, StaticConfigProvider, TransactionErrorHandler, TransactionSigningErrorCode, TransactionSigningService, TransactionSubmissionHandler, TransactionValidator, WalletService, WebAuthnCoordinator, WebConfigProvider, createPersSignerSDK, getBrowserWebAuthnProvider, getConfigProvider, getHttpClient, getServiceConfig, getBrowserWebAuthnProvider as getWebAuthnProvider, setConfigProvider, setHttpClient };
 export type { AuthResponse, AuthenticatedUser, CombinedTransactionStatus, ConfigProvider, HashSigningRequest, HttpClient, HttpRequestOptions, HttpResponse, PersSignerConfig, PlatformConfig, RegistrationChallenge, RegistrationResult, RelyingPartyConfig, ServiceConfig, ServiceError, SignResponse, SigningAuthTokens, SigningChallenge, SigningRequest, SubmissionResult, TransactionSigningError, TransactionSigningParams, TransactionSigningResult, TransactionStatusInfo, TypedDataSigningRequest, UserCredentials, WalletItem, WalletListResponse, WebAuthnConfig, WebAuthnProvider };

package/dist/browser.esm.js

@@ -1737,7 +1737,7 @@ class PersSignerSDK {
     /**
      * Initialize the PERS Signer SDK
      *
-     * @param {PersSignerConfig} config - SDK configuration object
+     * @param {ExtendedPersSignerConfig} config - SDK configuration object
      * @throws {Error} If required configuration is missing
      */
     constructor(config) {
@@ -1782,7 +1782,7 @@ class PersSignerSDK {
             throw new Error('Invalid or expired JWT token');
         }
         const identifier = payload.identifierEmail || payload.email || payload.userId;
-        const tenantId = payload.tenantId || this.config.tenantId || '';
+        const tenantId = payload.tenantId || '';
         if (!identifier) {
             throw new Error('JWT token missing user identifier (identifierEmail, email, or userId)');
         }