@worldcoin/minikit-js 1.0.1 → 1.1.0

package/build/index.cjs

@@ -477,6 +477,17 @@ var _MiniKit = class _MiniKit {
     }
     this.listeners[event](payload);
   }
+  static async awaitCommand(event, command, executor) {
+    return new Promise((resolve) => {
+      let commandPayload = null;
+      const handleAndUnsubscribe = (payload) => {
+        this.unsubscribe(event);
+        resolve({ commandPayload, finalPayload: payload });
+      };
+      this.subscribe(event, handleAndUnsubscribe);
+      commandPayload = executor();
+    });
+  }
   static commandsValid(input) {
     return Object.entries(this.commandVersion).every(
       ([commandName, version]) => {
@@ -711,6 +722,102 @@ _MiniKit.commands = {
     return payload;
   }
 };
+/**
+ * This object contains async versions of all the commands.
+ * Instead of using event listeners, you can just `await` these.
+ *
+ * They return a standardized object
+ *
+ * commandPayload - object returned by the command function
+ *
+ * finalPayload - object returned by the event listener, or in other words, WorldApp response
+ */
+_MiniKit.commandsAsync = {
+  verify: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-verify-action" /* MiniAppVerifyAction */,
+          "verify" /* Verify */,
+          () => _MiniKit.commands.verify(payload)
+        );
+        resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  pay: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-payment" /* MiniAppPayment */,
+          "pay" /* Pay */,
+          () => _MiniKit.commands.pay(payload)
+        );
+        resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  walletAuth: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-wallet-auth" /* MiniAppWalletAuth */,
+          "wallet-auth" /* WalletAuth */,
+          () => _MiniKit.commands.walletAuth(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  sendTransaction: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-send-transaction" /* MiniAppSendTransaction */,
+          "send-transaction" /* SendTransaction */,
+          () => _MiniKit.commands.sendTransaction(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  signMessage: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-sign-message" /* MiniAppSignMessage */,
+          "sign-message" /* SignMessage */,
+          () => _MiniKit.commands.signMessage(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  signTypedData: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-sign-typed-data" /* MiniAppSignTypedData */,
+          "sign-typed-data" /* SignTypedData */,
+          () => _MiniKit.commands.signTypedData(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+};
 var MiniKit = _MiniKit;
 
 // index.ts

package/build/index.d.cts

@@ -142,6 +142,10 @@ type WebViewBasePayload = {
     version: number;
     payload: Record<string, any>;
 };
+type AsyncHandlerReturn<CommandPayload, FinalPayload> = Promise<{
+    commandPayload: CommandPayload;
+    finalPayload: FinalPayload;
+}>;
 type VerifyCommandInput = {
     action: IDKitConfig["action"];
     signal?: IDKitConfig["signal"];
@@ -195,6 +199,15 @@ type SignTypedDataInput = {
     domain?: TypedDataDomain;
 };
 type SignTypedDataPayload = SignTypedDataInput;
+type CommandReturnPayloadMap = {
+    [Command.Verify]: VerifyCommandPayload;
+    [Command.Pay]: PayCommandPayload;
+    [Command.WalletAuth]: WalletAuthPayload;
+    [Command.SendTransaction]: SendTransactionPayload;
+    [Command.SignMessage]: SignMessagePayload;
+    [Command.SignTypedData]: SignTypedDataPayload;
+};
+type CommandReturnPayload<T extends Command> = T extends keyof CommandReturnPayloadMap ? CommandReturnPayloadMap[T] : never;
 
 declare enum ResponseEvent {
     MiniAppVerifyAction = "miniapp-verify-action",
@@ -328,6 +341,7 @@ declare class MiniKit {
     static subscribe<E extends ResponseEvent>(event: E, handler: EventHandler<E>): void;
     static unsubscribe(event: ResponseEvent): void;
     static trigger(event: ResponseEvent, payload: EventPayload): void;
+    private static awaitCommand;
     private static commandsValid;
     static install(appId?: string): MiniKitInstallReturnType;
     static isInstalled(debug?: boolean): boolean;
@@ -339,6 +353,24 @@ declare class MiniKit {
         signMessage: (payload: SignMessageInput) => SignMessagePayload | null;
         signTypedData: (payload: SignTypedDataInput) => SignTypedDataPayload | null;
     };
+    /**
+     * This object contains async versions of all the commands.
+     * Instead of using event listeners, you can just `await` these.
+     *
+     * They return a standardized object
+     *
+     * commandPayload - object returned by the command function
+     *
+     * finalPayload - object returned by the event listener, or in other words, WorldApp response
+     */
+    static commandsAsync: {
+        verify: (payload: VerifyCommandInput) => AsyncHandlerReturn<VerifyCommandPayload | null, MiniAppVerifyActionPayload>;
+        pay: (payload: PayCommandInput) => AsyncHandlerReturn<PayCommandPayload | null, MiniAppPaymentPayload>;
+        walletAuth: (payload: WalletAuthInput) => AsyncHandlerReturn<WalletAuthPayload | null, MiniAppWalletAuthPayload>;
+        sendTransaction: (payload: SendTransactionInput) => AsyncHandlerReturn<SendTransactionPayload | null, MiniAppSendTransactionPayload>;
+        signMessage: (payload: SignMessageInput) => AsyncHandlerReturn<SignMessagePayload | null, MiniAppSignMessagePayload>;
+        signTypedData: (payload: SignTypedDataInput) => AsyncHandlerReturn<SignTypedDataPayload | null, MiniAppSignTypedDataPayload>;
+    };
 }
 
 declare const tokenToDecimals: (amount: number, token: Tokens) => number;
@@ -359,4 +391,4 @@ declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonc
     siweMessageData: SiweMessage;
 }>;
 
-export { Command, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, 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, ResponseEvent, SAFE_CONTRACT_ABI, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, 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, parseSiweMessage, tokenToDecimals, verifySiweMessage };
+export { type AsyncHandlerReturn, Command, type CommandReturnPayload, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, 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, ResponseEvent, SAFE_CONTRACT_ABI, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, 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, parseSiweMessage, tokenToDecimals, verifySiweMessage };

package/build/index.d.ts

@@ -142,6 +142,10 @@ type WebViewBasePayload = {
     version: number;
     payload: Record<string, any>;
 };
+type AsyncHandlerReturn<CommandPayload, FinalPayload> = Promise<{
+    commandPayload: CommandPayload;
+    finalPayload: FinalPayload;
+}>;
 type VerifyCommandInput = {
     action: IDKitConfig["action"];
     signal?: IDKitConfig["signal"];
@@ -195,6 +199,15 @@ type SignTypedDataInput = {
     domain?: TypedDataDomain;
 };
 type SignTypedDataPayload = SignTypedDataInput;
+type CommandReturnPayloadMap = {
+    [Command.Verify]: VerifyCommandPayload;
+    [Command.Pay]: PayCommandPayload;
+    [Command.WalletAuth]: WalletAuthPayload;
+    [Command.SendTransaction]: SendTransactionPayload;
+    [Command.SignMessage]: SignMessagePayload;
+    [Command.SignTypedData]: SignTypedDataPayload;
+};
+type CommandReturnPayload<T extends Command> = T extends keyof CommandReturnPayloadMap ? CommandReturnPayloadMap[T] : never;
 
 declare enum ResponseEvent {
     MiniAppVerifyAction = "miniapp-verify-action",
@@ -328,6 +341,7 @@ declare class MiniKit {
     static subscribe<E extends ResponseEvent>(event: E, handler: EventHandler<E>): void;
     static unsubscribe(event: ResponseEvent): void;
     static trigger(event: ResponseEvent, payload: EventPayload): void;
+    private static awaitCommand;
     private static commandsValid;
     static install(appId?: string): MiniKitInstallReturnType;
     static isInstalled(debug?: boolean): boolean;
@@ -339,6 +353,24 @@ declare class MiniKit {
         signMessage: (payload: SignMessageInput) => SignMessagePayload | null;
         signTypedData: (payload: SignTypedDataInput) => SignTypedDataPayload | null;
     };
+    /**
+     * This object contains async versions of all the commands.
+     * Instead of using event listeners, you can just `await` these.
+     *
+     * They return a standardized object
+     *
+     * commandPayload - object returned by the command function
+     *
+     * finalPayload - object returned by the event listener, or in other words, WorldApp response
+     */
+    static commandsAsync: {
+        verify: (payload: VerifyCommandInput) => AsyncHandlerReturn<VerifyCommandPayload | null, MiniAppVerifyActionPayload>;
+        pay: (payload: PayCommandInput) => AsyncHandlerReturn<PayCommandPayload | null, MiniAppPaymentPayload>;
+        walletAuth: (payload: WalletAuthInput) => AsyncHandlerReturn<WalletAuthPayload | null, MiniAppWalletAuthPayload>;
+        sendTransaction: (payload: SendTransactionInput) => AsyncHandlerReturn<SendTransactionPayload | null, MiniAppSendTransactionPayload>;
+        signMessage: (payload: SignMessageInput) => AsyncHandlerReturn<SignMessagePayload | null, MiniAppSignMessagePayload>;
+        signTypedData: (payload: SignTypedDataInput) => AsyncHandlerReturn<SignTypedDataPayload | null, MiniAppSignTypedDataPayload>;
+    };
 }
 
 declare const tokenToDecimals: (amount: number, token: Tokens) => number;
@@ -359,4 +391,4 @@ declare const verifySiweMessage: (payload: MiniAppWalletAuthSuccessPayload, nonc
     siweMessageData: SiweMessage;
 }>;
 
-export { Command, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, 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, ResponseEvent, SAFE_CONTRACT_ABI, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, 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, parseSiweMessage, tokenToDecimals, verifySiweMessage };
+export { type AsyncHandlerReturn, Command, type CommandReturnPayload, type EventHandler, type EventPayload, type MiniAppPaymentErrorPayload, type MiniAppPaymentPayload, type MiniAppPaymentSuccessPayload, type MiniAppSendTransactionErrorPayload, type MiniAppSendTransactionPayload, type MiniAppSendTransactionSuccessPayload, 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, ResponseEvent, SAFE_CONTRACT_ABI, SendTransactionErrorCodes, SendTransactionErrorMessage, type SendTransactionInput, type SendTransactionPayload, 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, parseSiweMessage, tokenToDecimals, verifySiweMessage };

package/build/index.js

@@ -430,6 +430,17 @@ var _MiniKit = class _MiniKit {
     }
     this.listeners[event](payload);
   }
+  static async awaitCommand(event, command, executor) {
+    return new Promise((resolve) => {
+      let commandPayload = null;
+      const handleAndUnsubscribe = (payload) => {
+        this.unsubscribe(event);
+        resolve({ commandPayload, finalPayload: payload });
+      };
+      this.subscribe(event, handleAndUnsubscribe);
+      commandPayload = executor();
+    });
+  }
   static commandsValid(input) {
     return Object.entries(this.commandVersion).every(
       ([commandName, version]) => {
@@ -664,6 +675,102 @@ _MiniKit.commands = {
     return payload;
   }
 };
+/**
+ * This object contains async versions of all the commands.
+ * Instead of using event listeners, you can just `await` these.
+ *
+ * They return a standardized object
+ *
+ * commandPayload - object returned by the command function
+ *
+ * finalPayload - object returned by the event listener, or in other words, WorldApp response
+ */
+_MiniKit.commandsAsync = {
+  verify: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-verify-action" /* MiniAppVerifyAction */,
+          "verify" /* Verify */,
+          () => _MiniKit.commands.verify(payload)
+        );
+        resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  pay: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-payment" /* MiniAppPayment */,
+          "pay" /* Pay */,
+          () => _MiniKit.commands.pay(payload)
+        );
+        resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  walletAuth: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-wallet-auth" /* MiniAppWalletAuth */,
+          "wallet-auth" /* WalletAuth */,
+          () => _MiniKit.commands.walletAuth(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  sendTransaction: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-send-transaction" /* MiniAppSendTransaction */,
+          "send-transaction" /* SendTransaction */,
+          () => _MiniKit.commands.sendTransaction(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  signMessage: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-sign-message" /* MiniAppSignMessage */,
+          "sign-message" /* SignMessage */,
+          () => _MiniKit.commands.signMessage(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  },
+  signTypedData: async (payload) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response = await _MiniKit.awaitCommand(
+          "miniapp-sign-typed-data" /* MiniAppSignTypedData */,
+          "sign-typed-data" /* SignTypedData */,
+          () => _MiniKit.commands.signTypedData(payload)
+        );
+        return resolve(response);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+};
 var MiniKit = _MiniKit;
 
 // index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@worldcoin/minikit-js",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "homepage": "https://docs.worldcoin.org/mini-apps",
   "description": "Minikit-js is our SDK for building mini-apps.",
   "license": "MIT",