@worldcoin/minikit-js 1.8.0 → 1.9.1

package/build/index.d.ts

@@ -129,6 +129,16 @@ declare const SendHapticFeedbackErrorMessage: {
     generic_error: string;
     user_rejected: string;
 };
+declare enum ShareFilesErrorCodes {
+    UserRejected = "user_rejected",
+    GenericError = "generic_error",
+    InvalidFileName = "invalid_file_name"
+}
+declare const ShareFilesErrorMessage: {
+    user_rejected: string;
+    generic_error: string;
+    invalid_file_name: string;
+};
 
 declare enum Tokens {
     USDCE = "USDCE",
@@ -196,7 +206,7 @@ type TokensPayload = {
 };
 type PayCommandInput = {
     reference: string;
-    to: string;
+    to: `0x${string}` | string;
     tokens: TokensPayload[];
     network?: Network;
     description: string;
@@ -261,6 +271,15 @@ type SendHapticFeedbackInput = {
     style: 'light' | 'medium' | 'heavy';
 };
 type SendHapticFeedbackPayload = SendHapticFeedbackInput;
+type ShareFile = {
+    url: string;
+    saved_file_name_with_extension: string;
+};
+type ShareFilesInput = {
+    files: ShareFile[];
+    mime_type: string;
+};
+type ShareFilesPayload = ShareFilesInput;
 type CommandReturnPayloadMap = {
     [Command.Verify]: VerifyCommandPayload;
     [Command.Pay]: PayCommandPayload;
@@ -285,7 +304,8 @@ declare enum ResponseEvent {
     MiniAppShareContacts = "miniapp-share-contacts",
     MiniAppRequestPermission = "miniapp-request-permission",
     MiniAppGetPermissions = "miniapp-get-permissions",
-    MiniAppSendHapticFeedback = "miniapp-send-haptic-feedback"
+    MiniAppSendHapticFeedback = "miniapp-send-haptic-feedback",
+    MiniAppShareFiles = "miniapp-share-files"
 }
 type MiniAppVerifyActionSuccessPayload = {
     status: 'success';
@@ -433,6 +453,18 @@ type MiniAppSendHapticFeedbackErrorPayload = {
     version: number;
 };
 type MiniAppSendHapticFeedbackPayload = MiniAppSendHapticFeedbackSuccessPayload | MiniAppSendHapticFeedbackErrorPayload;
+type MiniAppShareFilesSuccessPayload = {
+    status: 'success';
+    shared_files_count: number;
+    version: number;
+    timestamp: string;
+};
+type MiniAppShareFilesErrorPayload = {
+    status: 'error';
+    error_code: ShareFilesErrorCodes;
+    version: number;
+};
+type MiniAppShareFilesPayload = MiniAppShareFilesSuccessPayload | MiniAppShareFilesErrorPayload;
 type EventPayloadMap = {
     [ResponseEvent.MiniAppVerifyAction]: MiniAppVerifyActionPayload;
     [ResponseEvent.MiniAppPayment]: MiniAppPaymentPayload;
@@ -444,14 +476,27 @@ type EventPayloadMap = {
     [ResponseEvent.MiniAppRequestPermission]: MiniAppRequestPermissionPayload;
     [ResponseEvent.MiniAppGetPermissions]: MiniAppGetPermissionsPayload;
     [ResponseEvent.MiniAppSendHapticFeedback]: MiniAppSendHapticFeedbackPayload;
+    [ResponseEvent.MiniAppShareFiles]: MiniAppShareFilesPayload;
 };
 type EventPayload<T extends ResponseEvent = ResponseEvent> = T extends keyof EventPayloadMap ? EventPayloadMap[T] : never;
 type EventHandler<E extends ResponseEvent = ResponseEvent> = <T extends EventPayload<E>>(data: T) => void;
 
 type User = {
+    walletAddress?: string;
+    username?: string;
+    profilePictureUrl?: string;
+    permissions?: {
+        notifications: boolean;
+        contacts: boolean;
+    };
+    optedIntoOptionalAnalytics?: boolean;
+    worldAppVersion?: number;
+    deviceOS?: string;
+};
+type UserNameService = {
     walletAddress: string;
-    username: string | null;
-    profilePictureUrl: string | null;
+    username?: string;
+    profilePictureUrl?: string;
 };
 
 declare class MiniKit {
@@ -460,11 +505,8 @@ declare class MiniKit {
     private static isCommandAvailable;
     private static listeners;
     static appId: string | null;
-    /**
-     * @deprecated you should use MiniKit.user.walletAddress instead
-     */
-    static walletAddress: string | null;
-    static user: User | null;
+    static user: User;
+    private static isReady;
     private static sendInit;
     static subscribe<E extends ResponseEvent>(event: E, handler: EventHandler<E>): void;
     static unsubscribe(event: ResponseEvent): void;
@@ -473,7 +515,9 @@ declare class MiniKit {
     private static commandsValid;
     static install(appId?: string): MiniKitInstallReturnType;
     static isInstalled(debug?: boolean): boolean;
-    static getUserByAddress: (address: string) => Promise<User>;
+    static getUserByAddress: (address?: string) => Promise<UserNameService>;
+    static getUserByUsername: (username: string) => Promise<UserNameService>;
+    static getUserInfo: (address?: string) => Promise<UserNameService>;
     static commands: {
         verify: (payload: VerifyCommandInput) => VerifyCommandPayload | null;
         pay: (payload: PayCommandInput) => PayCommandPayload | null;
@@ -516,7 +560,7 @@ type SiweMessage = {
     address?: string;
     statement?: string;
     uri: string;
-    version: number;
+    version: string;
     chain_id: number;
     nonce: string;
     issued_at: string;
@@ -528,21 +572,6 @@ type SiweMessage = {
 declare const tokenToDecimals: (amount: number, token: Tokens) => number;
 
 declare const parseSiweMessage: (inputString: string) => SiweMessage;
-declare const SAFE_CONTRACT_ABI: {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-}[];
 declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonce: string, statement?: string, requestId?: string, userProvider?: Client) => Promise<{
     isValid: boolean;
     siweMessageData: SiweMessage;
@@ -550,4 +579,4 @@ declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonc
 
 declare const getIsUserVerified: (walletAddress: string, rpcUrl?: string) => Promise<boolean>;
 
-export { type AsyncHandlerReturn, Command, type CommandReturnPayload, type Contact, type EventHandler, type EventPayload, GetPermissionsErrorCodes, GetPermissionsErrorMessage, type GetPermissionsInput, type GetPermissionsPayload, type MiniAppGetPermissionsErrorPayload, type MiniAppGetPermissionsPayload, type MiniAppGetPermissionsSuccessPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppRequestPermissionErrorPayload, type MiniAppRequestPermissionPayload, type MiniAppRequestPermissionSuccessPayload, type MiniAppSendHapticFeedbackErrorPayload, type MiniAppSendHapticFeedbackPayload, type MiniAppSendHapticFeedbackSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, type MiniAppShareContactsErrorPayload, type MiniAppShareContactsPayload, type MiniAppShareContactsSuccessPayload, type MiniAppSignMessageErrorPayload, type MiniAppSignMessagePayload, type MiniAppSignMessageSuccessPayload, type MiniAppSignTypedDataErrorPayload, type MiniAppSignTypedDataPayload, type MiniAppSignTypedDataSuccessPayload, type MiniAppVerifyActionErrorPayload, type MiniAppVerifyActionPayload, type MiniAppVerifyActionSuccessPayload, type MiniAppWalletAuthErrorPayload, type MiniAppWalletAuthPayload, type MiniAppWalletAuthSuccessPayload, MiniKit, MiniKitInstallErrorCodes, MiniKitInstallErrorMessage, type MiniKitInstallReturnType, Network, type PayCommandInput, type PayCommandPayload, PaymentErrorCodes, PaymentErrorMessage, PaymentValidationErrors, Permission, type PermissionSettings, RequestPermissionErrorCodes, RequestPermissionErrorMessage, type RequestPermissionInput, type RequestPermissionPayload, ResponseEvent, SAFE_CONTRACT_ABI, SendHapticFeedbackErrorCodes, SendHapticFeedbackErrorMessage, type SendHapticFeedbackInput, type SendHapticFeedbackPayload, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, ShareContactsErrorCodes, ShareContactsErrorMessage, type ShareContactsInput, type ShareContactsPayload, SignMessageErrorCodes, SignMessageErrorMessage, type SignMessageInput, type SignMessagePayload, SignTypedDataErrorCodes, SignTypedDataErrorMessage, type SignTypedDataInput, type SignTypedDataPayload, type SiweMessage, TokenDecimals, Tokens, type TokensPayload, VerificationErrorMessage, type VerifyCommandInput, type VerifyCommandPayload, WalletAuthErrorCodes, WalletAuthErrorMessage, type WalletAuthInput, type WalletAuthPayload, type WebViewBasePayload, getIsUserVerified, parseSiweMessage, tokenToDecimals, verifySiweMessage };
+export { type AsyncHandlerReturn, Command, type CommandReturnPayload, type Contact, type EventHandler, type EventPayload, GetPermissionsErrorCodes, GetPermissionsErrorMessage, type GetPermissionsInput, type GetPermissionsPayload, type MiniAppGetPermissionsErrorPayload, type MiniAppGetPermissionsPayload, type MiniAppGetPermissionsSuccessPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppRequestPermissionErrorPayload, type MiniAppRequestPermissionPayload, type MiniAppRequestPermissionSuccessPayload, type MiniAppSendHapticFeedbackErrorPayload, type MiniAppSendHapticFeedbackPayload, type MiniAppSendHapticFeedbackSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, type MiniAppShareContactsErrorPayload, type MiniAppShareContactsPayload, type MiniAppShareContactsSuccessPayload, type MiniAppShareFilesErrorPayload, type MiniAppShareFilesPayload, type MiniAppShareFilesSuccessPayload, type MiniAppSignMessageErrorPayload, type MiniAppSignMessagePayload, type MiniAppSignMessageSuccessPayload, type MiniAppSignTypedDataErrorPayload, type MiniAppSignTypedDataPayload, type MiniAppSignTypedDataSuccessPayload, type MiniAppVerifyActionErrorPayload, type MiniAppVerifyActionPayload, type MiniAppVerifyActionSuccessPayload, type MiniAppWalletAuthErrorPayload, type MiniAppWalletAuthPayload, type MiniAppWalletAuthSuccessPayload, MiniKit, MiniKitInstallErrorCodes, MiniKitInstallErrorMessage, type MiniKitInstallReturnType, Network, type PayCommandInput, type PayCommandPayload, PaymentErrorCodes, PaymentErrorMessage, PaymentValidationErrors, Permission, type PermissionSettings, RequestPermissionErrorCodes, RequestPermissionErrorMessage, type RequestPermissionInput, type RequestPermissionPayload, ResponseEvent, SendHapticFeedbackErrorCodes, SendHapticFeedbackErrorMessage, type SendHapticFeedbackInput, type SendHapticFeedbackPayload, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, ShareContactsErrorCodes, ShareContactsErrorMessage, type ShareContactsInput, type ShareContactsPayload, ShareFilesErrorCodes, ShareFilesErrorMessage, type ShareFilesInput, type ShareFilesPayload, SignMessageErrorCodes, SignMessageErrorMessage, type SignMessageInput, type SignMessagePayload, SignTypedDataErrorCodes, SignTypedDataErrorMessage, type SignTypedDataInput, type SignTypedDataPayload, type SiweMessage, TokenDecimals, Tokens, type TokensPayload, type User, type UserNameService, VerificationErrorMessage, type VerifyCommandInput, type VerifyCommandPayload, WalletAuthErrorCodes, WalletAuthErrorMessage, type WalletAuthInput, type WalletAuthPayload, type WebViewBasePayload, getIsUserVerified, parseSiweMessage, tokenToDecimals, verifySiweMessage };