@reown/appkit-siwx 1.8.15-ea982070c1d274f5971447c430b6d77717082e78.0 → 1.8.15-viem-upgrade.0

package/dist/types/exports/index.d.ts

@@ -1 +0,0 @@
-export * from '../src/index.js';

package/dist/types/exports/react.d.ts

@@ -1,2 +0,0 @@
-import { type SIWXConfig } from '@reown/appkit-controllers';
-export declare function useAppKitSIWX<Config extends SIWXConfig = SIWXConfig>(): Config | undefined;

package/dist/types/exports/vue.d.ts

@@ -1,3 +0,0 @@
-import { type Ref } from 'vue';
-import { type SIWXConfig } from '@reown/appkit-controllers';
-export declare function useAppKitSIWX<Config extends SIWXConfig = SIWXConfig>(): Ref<Config | undefined>;

package/dist/types/src/configs/DefaultSIWX.d.ts

@@ -1,11 +0,0 @@
-import { SIWXConfig } from '../core/SIWXConfig.js';
-/**
- * This is the default configuration for SIWX.
- *
- * This configuration is split in three pieces `messenger`, `verifiers` and `storage`.
- * By default it uses InformalMessenger, EIP155Verifier, SolanaVerifier, BIP122Verifier, and LocalStorage.
- * You may override any of these defaults by passing your own configuration for the constructor.
- */
-export declare class DefaultSIWX extends SIWXConfig {
-    constructor(params?: Partial<SIWXConfig.ConstructorParams>);
-}

package/dist/types/src/configs/ReownAuthenticationSIWX.d.ts

@@ -1,2 +0,0 @@
-import { ReownAuthentication } from '@reown/appkit-controllers/features';
-export { ReownAuthentication as CloudAuthSIWX, ReownAuthentication };

package/dist/types/src/configs/index.d.ts

@@ -1,2 +0,0 @@
-export * from './DefaultSIWX.js';
-export * from './ReownAuthenticationSIWX.js';

package/dist/types/src/core/SIWXConfig.d.ts

@@ -1,104 +0,0 @@
-import type { CaipNetworkId } from '@reown/appkit-common';
-import type { SIWXConfig as SIWXConfigInterface, SIWXMessage, SIWXSession } from '@reown/appkit-controllers';
-import type { SIWXMessenger } from './SIWXMessenger.js';
-import type { SIWXSigner } from './SIWXSigner.js';
-import type { SIWXStorage } from './SIWXStorage.js';
-import type { SIWXVerifier } from './SIWXVerifier.js';
-/**
- * This is the base class for a SIWX config.
- * You may extend this class to create your own configuration replacing the default logic.
- */
-export declare abstract class SIWXConfig implements SIWXConfigInterface {
-    private messenger;
-    private verifiers;
-    private storage;
-    signer: SIWXSigner;
-    required: boolean;
-    constructor(params: SIWXConfig.ConstructorParams);
-    /**
-     * Uses the messenger to create a message.
-     *
-     * @param input SIWXMessage.Input
-     * @returns Promise<SIWXMessage>
-     */
-    createMessage(input: SIWXMessage.Input): Promise<SIWXMessage>;
-    /**
-     * Combine the verifiers to verify the session and storage to store it.
-     * It will throw an error if the session is not valid.
-     *
-     * @param session SIWXSession
-     * @returns Promise<void>
-     */
-    addSession(session: SIWXSession): Promise<void>;
-    /**
-     * Combine the verifiers to verify the sessions and storage to store all of them.
-     * It will throw an error if any of the sessions is not valid.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     * @returns Promise<SIWXSession[]>
-     */
-    setSessions(sessions: SIWXSession[]): Promise<void>;
-    /**
-     * Get the sessions from the storage and verify them.
-     * If the session is not valid, it will be removed from the storage.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     * @returns Promise<SIWXSession[]>
-     */
-    getSessions(chainId: CaipNetworkId, address: string): Promise<SIWXSession[]>;
-    /**
-     * Remove the session from the storage.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     * @returns Promise<void>
-     */
-    revokeSession(chainId: CaipNetworkId, address: string): Promise<void>;
-    /**
-     * This method should verify the session.
-     * It will first check if the verifier should verify the session and then call the verify method.
-     * It will return `true` if the session is valid for all verifications and there is at least one verification.
-     *
-     * @param session SIWXSession
-     * @returns Promise<boolean> - If `true` means the session is valid.
-     */
-    protected verifySession(session: SIWXSession): Promise<boolean>;
-    /**
-     * This method determines whether the wallet stays connected when the user denies the signature request.
-     *
-     * @returns {boolean}
-     */
-    getRequired(): boolean;
-    signMessage({ message }: {
-        message: string;
-        chainId: string;
-        accountAddress: string;
-    }): Promise<string>;
-}
-export declare namespace SIWXConfig {
-    type ConstructorParams = {
-        /**
-         * The messenger to create the messages.
-         */
-        messenger: SIWXMessenger;
-        /**
-         * The verifiers to verify the sessions.
-         */
-        verifiers: SIWXVerifier[];
-        /**
-         * The storage to store the sessions.
-         */
-        storage: SIWXStorage;
-        /**
-         * If false the wallet stays connected when user denies the signature request.
-         * @default true
-         */
-        required?: boolean;
-        /**
-         * The signer handler to sign the message. If not provided, a signature request will be made to the wallet.
-         */
-        signer?: SIWXSigner;
-    };
-}

package/dist/types/src/core/SIWXMessenger.d.ts

@@ -1,93 +0,0 @@
-import type { SIWXMessage } from '@reown/appkit-controllers';
-/**
- * This is the base class for a SIWX messenger.
- * It provides the basic structure for creating a SIWX message and util functions.
- */
-export declare abstract class SIWXMessenger {
-    domain: SIWXMessage['domain'];
-    uri: SIWXMessage['uri'];
-    statement?: SIWXMessage['statement'];
-    resources?: SIWXMessage['resources'];
-    /**
-     * The version of the SIWXMessage class
-     */
-    protected abstract readonly version: SIWXMessage['version'];
-    /**
-     * Expiration time in milliseconds
-     */
-    protected expiration?: number;
-    /**
-     * Getter function for message nonce value
-     */
-    protected getNonce: SIWXMessenger.ConstructorParams['getNonce'];
-    /**
-     * Getter function for message request ID
-     */
-    protected getRequestId?: SIWXMessenger.ConstructorParams['getRequestId'];
-    /**
-     * The method that generates the message string.
-     * This method must be implemented by the child class.
-     *
-     * @param params SIWXMessage.Data
-     * @returns string
-     */
-    protected abstract stringify(params: SIWXMessage.Data): string;
-    constructor(params: SIWXMessenger.ConstructorParams);
-    /**
-     * This is the default method to create a SIWXMessage object.
-     * It will call the `getNonce`, `getRequestId`, `getExpirationTime`, `getIssuedAt`, and `getNotBefore` methods.
-     * It appends the `stringify` method to the object as `toString`.
-     *
-     * @param input SIWXMessage.Input
-     * @returns
-     */
-    createMessage(input: SIWXMessage.Input): Promise<SIWXMessage>;
-    /**
-     * This method generates the expiration time based on the `notBefore` value and the `expiration` value.
-     * You may override this method to provide a custom expiration time.
-     *
-     * @param Pick<SIWXMessage.Input, 'notBefore'>
-     * @returns string | undefined - The expiration time in `stringifyDate` format or undefined if not available
-     */
-    protected getExpirationTime({ notBefore }: Pick<SIWXMessage.Input, 'notBefore'>): string | undefined;
-    /**
-     * This method generates the `notBefore` formatted value based on the `notBefore` input.
-     * You may override this method to provide a custom `notBefore` value.
-     *
-     * @param Pick<SIWXMessage.Input, 'notBefore'>
-     * @returns string | undefined - The `notBefore` value in `stringifyDate` format or undefined if not available
-     */
-    protected getNotBefore({ notBefore }: Pick<SIWXMessage.Input, 'notBefore'>): string | undefined;
-    /**
-     * This method generates the `issuedAt` formatted value based on the current date.
-     * You may override this method to provide a custom `issuedAt` value.
-     *
-     * @returns string - The `issuedAt` value in `stringifyDate` format
-     */
-    protected getIssuedAt(): string;
-    /**
-     * This method converts a date object to a formatted string.
-     * You may override this method to provide a custom date format.
-     *
-     * @param date Date
-     * @returns string - The date in ISO format
-     */
-    protected stringifyDate(date: Date): string;
-}
-export declare namespace SIWXMessenger {
-    interface ConstructorParams extends Omit<SIWXMessage.Metadata, 'nonce' | 'version'> {
-        /**
-         * Time in milliseconds
-         */
-        expiration?: number;
-        /**
-         * Getter function for message nonce value
-         */
-        getNonce: (params: SIWXMessage.Input) => Promise<SIWXMessage['nonce']>;
-        /**
-         * Getter function for message request ID
-         * If not provided, the request ID will be omitted
-         */
-        getRequestId?: () => Promise<SIWXMessage['requestId']>;
-    }
-}

package/dist/types/src/core/SIWXSigner.d.ts

@@ -1,3 +0,0 @@
-export declare abstract class SIWXSigner {
-    abstract signMessage(message: string): Promise<string>;
-}

package/dist/types/src/core/SIWXStorage.d.ts

@@ -1,40 +0,0 @@
-import type { CaipNetworkId } from '@reown/appkit-common';
-import type { SIWXSession } from '@reown/appkit-controllers';
-/**
- * This is the interface for a SIWX storage.
- */
-export interface SIWXStorage {
-    /**
-     * Adds a new session for the storage.
-     * This method should not verify the session, only store it.
-     *
-     * @param session SIWXSession
-     * @returns Promise<void>
-     */
-    add(session: SIWXSession): Promise<void>;
-    /**
-     * Deletes a session from the storage.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     * @returns Promise<void>
-     */
-    delete(chainId: CaipNetworkId, address: string): Promise<void>;
-    /**
-     * Gets a list of sessions for a given chainId and address.
-     * This method should not verify sessions, only return the sessions that are stored.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     * @returns Promise<SIWXSession[]>
-     */
-    get(chainId: CaipNetworkId, address: string): Promise<SIWXSession[]>;
-    /**
-     * Replaces the current sessions with the new list of sessions.
-     * This method should not verify sessions, only store them.
-     *
-     * @param sessions SIWXSession[]
-     * @returns Promise<void>
-     */
-    set(sessions: SIWXSession[]): Promise<void>;
-}

package/dist/types/src/core/SIWXVerifier.d.ts

@@ -1,27 +0,0 @@
-import type { ChainNamespace } from '@reown/appkit-common';
-import type { SIWXSession } from '@reown/appkit-controllers';
-/**
- * This is the base class for a SIWX verifier.
- */
-export declare abstract class SIWXVerifier {
-    /**
-     * The chain namespace that this verifier should verify.
-     */
-    abstract readonly chainNamespace: ChainNamespace;
-    /**
-     * This method should return true if the verifier should verify the session.
-     * By default it will check by the chain namespace, but you may override it for a specific requirement.
-     *
-     * @param session SIWXSession
-     * @returns boolean
-     */
-    shouldVerify(session: SIWXSession): boolean;
-    /**
-     * This method should verify the session.
-     * You must implement this method with the verification logic.
-     *
-     * @param session SIWXSession
-     * @returns Promise<boolean> - If `true` means the session is valid.
-     */
-    abstract verify(session: SIWXSession): Promise<boolean>;
-}

package/dist/types/src/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from './SIWXConfig.js';
-export * from './SIWXMessenger.js';
-export * from './SIWXStorage.js';
-export * from './SIWXVerifier.js';

package/dist/types/src/index.d.ts

@@ -1,6 +0,0 @@
-export * from './messengers/index.js';
-export * from './verifiers/index.js';
-export * from './storages/index.js';
-export * from './configs/index.js';
-export * from './core/index.js';
-export type { SIWXMessage, SIWXConfig, SIWXSession } from '@reown/appkit-controllers';

package/dist/types/src/messengers/InformalMessenger.d.ts

@@ -1,46 +0,0 @@
-import { type CaipNetworkId } from '@reown/appkit-common';
-import { type SIWXMessage } from '@reown/appkit-controllers';
-import { SIWXMessenger } from '../core/SIWXMessenger.js';
-/**
- * Follow Informal Message template from EIP-4361
- * @see https://eips.ethereum.org/EIPS/eip-4361#informal-message-template
- *
- * @example
- * ```
- * ${scheme}:// ${domain} wants you to sign in with your Ethereum account:
- * ${address}
- *
- * ${statement}
- *
- * URI: ${uri}
- * Version: ${version}
- * Chain ID: ${chain-id}
- * Nonce: ${nonce}
- * Issued At: ${issued-at}
- * Expiration Time: ${expiration-time}
- * Not Before: ${not-before}
- * Request ID: ${request-id}
- * Resources:
- * - ${resources[0]}
- * - ${resources[1]}
- * ...
- * - ${resources[n]}
- * ```
- */
-export declare class InformalMessenger extends SIWXMessenger {
-    protected readonly version = "1";
-    private readonly clearChainIdNamespace;
-    constructor({ clearChainIdNamespace, ...params }: InformalMessenger.ConstructorParams);
-    /**
-     * Get the blockchain name for a given chain ID
-     * @param chainId The chain ID to get the blockchain name for
-     * @returns The blockchain name
-     */
-    protected getNetworkName(chainId: CaipNetworkId): string | undefined;
-    protected stringify(params: SIWXMessage.Data): string;
-}
-export declare namespace InformalMessenger {
-    type ConstructorParams = SIWXMessenger.ConstructorParams & {
-        clearChainIdNamespace?: boolean;
-    };
-}

package/dist/types/src/messengers/index.d.ts

@@ -1 +0,0 @@
-export * from './InformalMessenger.js';

package/dist/types/src/signers/DefaultSigner.d.ts

@@ -1,4 +0,0 @@
-import type { SIWXSigner } from '../core/SIWXSigner.js';
-export default class DefaultSigner implements SIWXSigner {
-    signMessage(message: string): Promise<string>;
-}

package/dist/types/src/storages/LocalStorage.d.ts

@@ -1,25 +0,0 @@
-import type { CaipNetworkId } from '@reown/appkit-common';
-import type { SIWXSession } from '@reown/appkit-controllers';
-import type { SIWXStorage } from '../core/SIWXStorage.js';
-/**
- * This storage saves the sessions in the localStorage.
- */
-export declare class LocalStorage implements SIWXStorage {
-    private key;
-    constructor(params: LocalStorage.ConstructorParams);
-    add(session: SIWXSession): Promise<void>;
-    set(sessions: SIWXSession[]): Promise<void>;
-    get(chainId: CaipNetworkId, address: string): Promise<SIWXSession[]>;
-    delete(chainId: string, address: string): Promise<void>;
-    private getSessions;
-    private setSessions;
-}
-export declare namespace LocalStorage {
-    type ConstructorParams = {
-        /**
-         * The key to save the sessions in the localStorage.
-         */
-        key: string;
-    };
-    type Sessions = SIWXSession[];
-}

package/dist/types/src/storages/index.d.ts

@@ -1 +0,0 @@
-export * from './LocalStorage.js';

package/dist/types/src/verifiers/BIP122Verifier.d.ts

@@ -1,9 +0,0 @@
-import type { SIWXSession } from '@reown/appkit-controllers';
-import { SIWXVerifier } from '../core/SIWXVerifier.js';
-/**
- * Default verifier for BIP122 sessions.
- */
-export declare class BIP122Verifier extends SIWXVerifier {
-    readonly chainNamespace: "bip122";
-    verify(session: SIWXSession): Promise<boolean>;
-}

package/dist/types/src/verifiers/EIP155Verifier.d.ts

@@ -1,9 +0,0 @@
-import { type SIWXSession } from '@reown/appkit-controllers';
-import { SIWXVerifier } from '../core/SIWXVerifier.js';
-/**
- * Default verifier for EIP155 sessions.
- */
-export declare class EIP155Verifier extends SIWXVerifier {
-    readonly chainNamespace: "eip155";
-    verify(session: SIWXSession): Promise<boolean>;
-}

package/dist/types/src/verifiers/SolanaVerifier.d.ts

@@ -1,9 +0,0 @@
-import type { SIWXSession } from '@reown/appkit-controllers';
-import { SIWXVerifier } from '../core/SIWXVerifier.js';
-/**
- * Default verifier for Solana sessions.
- */
-export declare class SolanaVerifier extends SIWXVerifier {
-    readonly chainNamespace: "solana";
-    verify(session: SIWXSession): Promise<boolean>;
-}

package/dist/types/src/verifiers/index.d.ts

@@ -1,3 +0,0 @@
-export * from './EIP155Verifier.js';
-export * from './SolanaVerifier.js';
-export * from './BIP122Verifier.js';

package/dist/types/tests/configs/ReownAuthenticationSIWX.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/messengers/InformalMessenger.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/storages/LocalStorage.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/verifiers/BIP122Verifier.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/verifiers/EIP155Verifier.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/verifiers/SolanaVerifier.test.d.ts

@@ -1 +0,0 @@
-export {};