@metamask/snaps-sdk 6.3.0 → 6.4.0

package/dist/types/{types/handlers/signature.d.ts → handlers/signature.d.cts}

@@ -1,6 +1,6 @@
-import type { EnumToUnion } from '../../internals';
-import type { Component } from '../../ui';
-import type { SeverityLevel } from './transaction';
+import type { EnumToUnion } from "../../internals/index.cjs";
+import type { Component } from "../../ui/index.cjs";
+import type { SeverityLevel } from "./transaction.cjs";
 /**
  * An eth_sign signature object.
  *
@@ -109,3 +109,4 @@ export type OnSignatureResponse = {
     id: string;
     severity?: EnumToUnion<SeverityLevel>;
 };
+//# sourceMappingURL=signature.d.cts.map

package/dist/types/handlers/signature.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.d.cts","sourceRoot":"","sources":["../../../src/types/handlers/signature.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,SAAS,EAAE,2BAAiB;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,0BAAsB;AAEnD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,UAAU,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IAC5B,eAAe,EAAE,mBAAmB,CAAC;CACtC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,eAAe,EAAE,sBAAsB,CAAC;CACzC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,eAAe,EAAE,sBAAsB,CAAC;CACzC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,iBAAiB,GACjB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE;IACtC,SAAS,EAAE,SAAS,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,KAAK,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;AAE1C;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACE,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,GACD;IACE,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,CAAC"}

package/dist/types/handlers/signature.d.mts

@@ -0,0 +1,112 @@
+import type { EnumToUnion } from "../../internals/index.mjs";
+import type { Component } from "../../ui/index.mjs";
+import type { SeverityLevel } from "./transaction.mjs";
+/**
+ * An eth_sign signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data (hex string) that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_sign
+ */
+export type EthSignature = {
+    from: string;
+    data: string;
+    signatureMethod: 'eth_sign';
+};
+/**
+ * A personal_sign signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data (hex string) that is being signed.
+ * @property signatureMethod - The signature method, which in this case is personal_sign
+ */
+export type PersonalSignature = {
+    from: string;
+    data: string;
+    signatureMethod: 'personal_sign';
+};
+/**
+ * An eth_signTypedData signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_signTypedData
+ */
+export type SignTypedDataSignature = {
+    from: string;
+    data: Record<string, any>[];
+    signatureMethod: 'eth_signTypedData';
+};
+/**
+ * An eth_signTypedData_v3 signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v3
+ */
+export type SignTypedDataV3Signature = {
+    from: string;
+    data: Record<string, any>;
+    signatureMethod: 'eth_signTypedData_v3';
+};
+/**
+ * An eth_signTypedData_v4 signature object.
+ *
+ * @property from - The address the signature is being sent from.
+ * @property data - The data that is being signed.
+ * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v4
+ */
+export type SignTypedDataV4Signature = {
+    from: string;
+    data: Record<string, any>;
+    signatureMethod: 'eth_signTypedData_v4';
+};
+/**
+ * A signature object. This can be one of the below signature methods.
+ *
+ * @see EthSignature
+ * @see PersonalSignature
+ * @see SignTypedDataSignature
+ * @see SignTypedDataV3Signature
+ * @see SignTypedDataV4Signature
+ */
+export type Signature = EthSignature | PersonalSignature | SignTypedDataSignature | SignTypedDataV3Signature | SignTypedDataV4Signature;
+/**
+ * The `onSignature` handler. This is called whenever a signature is
+ * submitted to the snap. It can return insights about the signature, which
+ * will be displayed to the user.
+ *
+ * Note that using this handler requires the `endowment:signature-insight`
+ * permission.
+ *
+ * @param args - The request arguments.
+ * @param args.signature - The signature object that contains the from address,
+ * data and signature method.
+ * @param args.signatureOrigin - The origin of the signature. This is the
+ * URL of the website that submitted the signature. This is only available if
+ * the Snap has enabled the `allowSignatureOrigin` option in the
+ * `endowment:signature-insight` permission.
+ * @returns An object containing insights about the signature. See
+ * {@link OnSignatureResponse}. Can also return `null` if no insights are
+ * available.
+ */
+export type OnSignatureHandler = (args: {
+    signature: Signature;
+    signatureOrigin?: string;
+}) => Promise<OnSignatureResponse | null>;
+/**
+ * The response from a Snap's `onSignature` handler.
+ *
+ * @property component - A custom UI component, that will be shown in MetaMask.
+ * @property id - A Snap interface ID.
+ * @property severity - The severity level of the content. Currently only one
+ * level is supported: `critical`.
+ */
+export type OnSignatureResponse = {
+    content: Component;
+    severity?: EnumToUnion<SeverityLevel>;
+} | {
+    id: string;
+    severity?: EnumToUnion<SeverityLevel>;
+};
+//# sourceMappingURL=signature.d.mts.map

package/dist/types/handlers/signature.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.d.mts","sourceRoot":"","sources":["../../../src/types/handlers/signature.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,SAAS,EAAE,2BAAiB;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,0BAAsB;AAEnD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,UAAU,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IAC5B,eAAe,EAAE,mBAAmB,CAAC;CACtC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,eAAe,EAAE,sBAAsB,CAAC;CACzC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,eAAe,EAAE,sBAAsB,CAAC;CACzC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,iBAAiB,GACjB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE;IACtC,SAAS,EAAE,SAAS,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,KAAK,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;AAE1C;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACE,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,GACD;IACE,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,CAAC"}

package/dist/types/handlers/signature.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=signature.mjs.map

package/dist/types/handlers/signature.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.mjs","sourceRoot":"","sources":["../../../src/types/handlers/signature.ts"],"names":[],"mappings":"","sourcesContent":["import type { EnumToUnion } from '../../internals';\nimport type { Component } from '../../ui';\nimport type { SeverityLevel } from './transaction';\n\n/**\n * An eth_sign signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data (hex string) that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_sign\n */\nexport type EthSignature = {\n  from: string;\n  data: string;\n  signatureMethod: 'eth_sign';\n};\n\n/**\n * A personal_sign signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data (hex string) that is being signed.\n * @property signatureMethod - The signature method, which in this case is personal_sign\n */\nexport type PersonalSignature = {\n  from: string;\n  data: string;\n  signatureMethod: 'personal_sign';\n};\n\n/**\n * An eth_signTypedData signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_signTypedData\n */\nexport type SignTypedDataSignature = {\n  from: string;\n  data: Record<string, any>[];\n  signatureMethod: 'eth_signTypedData';\n};\n\n/**\n * An eth_signTypedData_v3 signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v3\n */\nexport type SignTypedDataV3Signature = {\n  from: string;\n  data: Record<string, any>;\n  signatureMethod: 'eth_signTypedData_v3';\n};\n\n/**\n * An eth_signTypedData_v4 signature object.\n *\n * @property from - The address the signature is being sent from.\n * @property data - The data that is being signed.\n * @property signatureMethod - The signature method, which in this case is eth_signTypedData_v4\n */\nexport type SignTypedDataV4Signature = {\n  from: string;\n  data: Record<string, any>;\n  signatureMethod: 'eth_signTypedData_v4';\n};\n\n/**\n * A signature object. This can be one of the below signature methods.\n *\n * @see EthSignature\n * @see PersonalSignature\n * @see SignTypedDataSignature\n * @see SignTypedDataV3Signature\n * @see SignTypedDataV4Signature\n */\nexport type Signature =\n  | EthSignature\n  | PersonalSignature\n  | SignTypedDataSignature\n  | SignTypedDataV3Signature\n  | SignTypedDataV4Signature;\n\n/**\n * The `onSignature` handler. This is called whenever a signature is\n * submitted to the snap. It can return insights about the signature, which\n * will be displayed to the user.\n *\n * Note that using this handler requires the `endowment:signature-insight`\n * permission.\n *\n * @param args - The request arguments.\n * @param args.signature - The signature object that contains the from address,\n * data and signature method.\n * @param args.signatureOrigin - The origin of the signature. This is the\n * URL of the website that submitted the signature. This is only available if\n * the Snap has enabled the `allowSignatureOrigin` option in the\n * `endowment:signature-insight` permission.\n * @returns An object containing insights about the signature. See\n * {@link OnSignatureResponse}. Can also return `null` if no insights are\n * available.\n */\nexport type OnSignatureHandler = (args: {\n  signature: Signature;\n  signatureOrigin?: string;\n}) => Promise<OnSignatureResponse | null>;\n\n/**\n * The response from a Snap's `onSignature` handler.\n *\n * @property component - A custom UI component, that will be shown in MetaMask.\n * @property id - A Snap interface ID.\n * @property severity - The severity level of the content. Currently only one\n * level is supported: `critical`.\n */\nexport type OnSignatureResponse =\n  | {\n      content: Component;\n      severity?: EnumToUnion<SeverityLevel>;\n    }\n  | {\n      id: string;\n      severity?: EnumToUnion<SeverityLevel>;\n    };\n"]}

package/dist/types/handlers/transaction.cjs

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeverityLevel = void 0;
+/**
+ * The severity level of content being returned from a transaction insight.
+ * Currently only one level is supported:
+ *
+ * - `critical` - The transaction is critical and should not be submitted by the
+ * user.
+ */
+var SeverityLevel;
+(function (SeverityLevel) {
+    SeverityLevel["Critical"] = "critical";
+})(SeverityLevel || (exports.SeverityLevel = SeverityLevel = {}));
+//# sourceMappingURL=transaction.cjs.map

package/dist/types/handlers/transaction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.cjs","sourceRoot":"","sources":["../../../src/types/handlers/transaction.ts"],"names":[],"mappings":";;;AAIA;;;;;;GAMG;AACH,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,sCAAqB,CAAA;AACvB,CAAC,EAFW,aAAa,6BAAb,aAAa,QAExB","sourcesContent":["import type { ComponentOrElement } from '..';\nimport type { EnumToUnion } from '../../internals';\nimport type { ChainId } from '../caip';\n\n/**\n * The severity level of content being returned from a transaction insight.\n * Currently only one level is supported:\n *\n * - `critical` - The transaction is critical and should not be submitted by the\n * user.\n */\nexport enum SeverityLevel {\n  Critical = 'critical',\n}\n\n/**\n * An EIP-1559 (type 2) transaction object.\n *\n * @property from - The address the transaction is being sent from.\n * @property to - The address the transaction is being sent to.\n * @property nonce - The nonce of the transaction.\n * @property value - The value of the transaction.\n * @property data - The data of the transaction.\n * @property gas - The gas limit of the transaction.\n * @property maxFeePerGas - The maximum fee per gas of the transaction.\n * @property maxPriorityFeePerGas - The maximum priority fee per gas of the\n * transaction.\n * @property estimateSuggested - The suggested gas price for the transaction.\n * @property estimateUsed - The gas price used for the transaction.\n * @see https://eips.ethereum.org/EIPS/eip-1559\n */\nexport type EIP1559Transaction = {\n  from: string;\n  to: string;\n  nonce: string;\n  value: string;\n  data: string;\n  gas: string;\n  maxFeePerGas: string;\n  maxPriorityFeePerGas: string;\n  estimateSuggested: string;\n  estimateUsed: string;\n};\n\n/**\n * A legacy (type \"0\") transaction object.\n *\n * @property from - The address the transaction is being sent from.\n * @property to - The address the transaction is being sent to.\n * @property nonce - The nonce of the transaction.\n * @property value - The value of the transaction.\n * @property data - The data of the transaction.\n * @property gas - The gas limit of the transaction.\n * @property gasPrice - The gas price of the transaction.\n * @property estimateSuggested - The suggested gas price for the transaction.\n * @property estimateUsed - The gas price used for the transaction.\n */\nexport type LegacyTransaction = {\n  from: string;\n  to: string;\n  nonce: string;\n  value: string;\n  data: string;\n  gas: string;\n  gasPrice: string;\n  estimateSuggested: string;\n  estimateUsed: string;\n};\n\n/**\n * A transaction object. This can be either an EIP-1559 transaction or a legacy\n * transaction.\n *\n * @see EIP1559Transaction\n * @see LegacyTransaction\n */\nexport type Transaction = EIP1559Transaction | LegacyTransaction;\n\n/**\n * The `onTransaction` handler. This is called whenever a transaction is\n * submitted to the snap. It can return insights about the transaction, which\n * will be displayed to the user.\n *\n * Note that using this handler requires the `endowment:transaction-insights`\n * permission.\n *\n * @param args - The request arguments.\n * @param args.transaction - The transaction object, containing the address,\n * value, data, and other properties of the transaction.\n * @param args.chainId - The CAIP-2 {@link ChainId} of the network the\n * transaction is being submitted to.\n * @param args.transactionOrigin - The origin of the transaction. This is the\n * URL of the website that submitted the transaction. This is only available if\n * the Snap has enabled the `allowTransactionOrigin` option in the\n * `endowment:transaction-insight` permission.\n * @returns An object containing insights about the transaction. See\n * {@link OnTransactionResponse}. Can also return `null` if no insights are\n * available.\n */\nexport type OnTransactionHandler = (args: {\n  transaction: Transaction;\n  chainId: ChainId;\n  transactionOrigin?: string;\n}) => Promise<OnTransactionResponse | null>;\n\n/**\n * The response from a Snap's `onTransaction` handler.\n *\n * @property component - A custom UI component, that will be shown in MetaMask.\n * @property id - A Snap interface ID.\n * @property severity - The severity level of the content. Currently only one\n * level is supported: `critical`.\n */\nexport type OnTransactionResponse =\n  | {\n      content: ComponentOrElement;\n      severity?: EnumToUnion<SeverityLevel>;\n    }\n  | {\n      id: string;\n      severity?: EnumToUnion<SeverityLevel>;\n    };\n"]}

package/dist/types/{types/handlers/transaction.d.ts → handlers/transaction.d.cts}

@@ -1,6 +1,6 @@
-import type { ComponentOrElement } from '..';
-import type { EnumToUnion } from '../../internals';
-import type { ChainId } from '../caip';
+import type { ComponentOrElement } from "../index.cjs";
+import type { EnumToUnion } from "../../internals/index.cjs";
+import type { ChainId } from "../caip.cjs";
 /**
  * The severity level of content being returned from a transaction insight.
  * Currently only one level is supported:
@@ -112,3 +112,4 @@ export type OnTransactionResponse = {
     id: string;
     severity?: EnumToUnion<SeverityLevel>;
 };
+//# sourceMappingURL=transaction.d.cts.map

package/dist/types/handlers/transaction.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.cts","sourceRoot":"","sources":["../../../src/types/handlers/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAW;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,oBAAgB;AAEvC;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,QAAQ,aAAa;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE;IACxC,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAK,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAC7B;IACE,OAAO,EAAE,kBAAkB,CAAC;IAC5B,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,GACD;IACE,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,CAAC"}

package/dist/types/handlers/transaction.d.mts

@@ -0,0 +1,115 @@
+import type { ComponentOrElement } from "../index.mjs";
+import type { EnumToUnion } from "../../internals/index.mjs";
+import type { ChainId } from "../caip.mjs";
+/**
+ * The severity level of content being returned from a transaction insight.
+ * Currently only one level is supported:
+ *
+ * - `critical` - The transaction is critical and should not be submitted by the
+ * user.
+ */
+export declare enum SeverityLevel {
+    Critical = "critical"
+}
+/**
+ * An EIP-1559 (type 2) transaction object.
+ *
+ * @property from - The address the transaction is being sent from.
+ * @property to - The address the transaction is being sent to.
+ * @property nonce - The nonce of the transaction.
+ * @property value - The value of the transaction.
+ * @property data - The data of the transaction.
+ * @property gas - The gas limit of the transaction.
+ * @property maxFeePerGas - The maximum fee per gas of the transaction.
+ * @property maxPriorityFeePerGas - The maximum priority fee per gas of the
+ * transaction.
+ * @property estimateSuggested - The suggested gas price for the transaction.
+ * @property estimateUsed - The gas price used for the transaction.
+ * @see https://eips.ethereum.org/EIPS/eip-1559
+ */
+export type EIP1559Transaction = {
+    from: string;
+    to: string;
+    nonce: string;
+    value: string;
+    data: string;
+    gas: string;
+    maxFeePerGas: string;
+    maxPriorityFeePerGas: string;
+    estimateSuggested: string;
+    estimateUsed: string;
+};
+/**
+ * A legacy (type "0") transaction object.
+ *
+ * @property from - The address the transaction is being sent from.
+ * @property to - The address the transaction is being sent to.
+ * @property nonce - The nonce of the transaction.
+ * @property value - The value of the transaction.
+ * @property data - The data of the transaction.
+ * @property gas - The gas limit of the transaction.
+ * @property gasPrice - The gas price of the transaction.
+ * @property estimateSuggested - The suggested gas price for the transaction.
+ * @property estimateUsed - The gas price used for the transaction.
+ */
+export type LegacyTransaction = {
+    from: string;
+    to: string;
+    nonce: string;
+    value: string;
+    data: string;
+    gas: string;
+    gasPrice: string;
+    estimateSuggested: string;
+    estimateUsed: string;
+};
+/**
+ * A transaction object. This can be either an EIP-1559 transaction or a legacy
+ * transaction.
+ *
+ * @see EIP1559Transaction
+ * @see LegacyTransaction
+ */
+export type Transaction = EIP1559Transaction | LegacyTransaction;
+/**
+ * The `onTransaction` handler. This is called whenever a transaction is
+ * submitted to the snap. It can return insights about the transaction, which
+ * will be displayed to the user.
+ *
+ * Note that using this handler requires the `endowment:transaction-insights`
+ * permission.
+ *
+ * @param args - The request arguments.
+ * @param args.transaction - The transaction object, containing the address,
+ * value, data, and other properties of the transaction.
+ * @param args.chainId - The CAIP-2 {@link ChainId} of the network the
+ * transaction is being submitted to.
+ * @param args.transactionOrigin - The origin of the transaction. This is the
+ * URL of the website that submitted the transaction. This is only available if
+ * the Snap has enabled the `allowTransactionOrigin` option in the
+ * `endowment:transaction-insight` permission.
+ * @returns An object containing insights about the transaction. See
+ * {@link OnTransactionResponse}. Can also return `null` if no insights are
+ * available.
+ */
+export type OnTransactionHandler = (args: {
+    transaction: Transaction;
+    chainId: ChainId;
+    transactionOrigin?: string;
+}) => Promise<OnTransactionResponse | null>;
+/**
+ * The response from a Snap's `onTransaction` handler.
+ *
+ * @property component - A custom UI component, that will be shown in MetaMask.
+ * @property id - A Snap interface ID.
+ * @property severity - The severity level of the content. Currently only one
+ * level is supported: `critical`.
+ */
+export type OnTransactionResponse = {
+    content: ComponentOrElement;
+    severity?: EnumToUnion<SeverityLevel>;
+} | {
+    id: string;
+    severity?: EnumToUnion<SeverityLevel>;
+};
+//# sourceMappingURL=transaction.d.mts.map

package/dist/types/handlers/transaction.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.mts","sourceRoot":"","sources":["../../../src/types/handlers/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAW;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,oBAAgB;AAEvC;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,QAAQ,aAAa;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE;IACxC,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAK,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAC7B;IACE,OAAO,EAAE,kBAAkB,CAAC;IAC5B,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,GACD;IACE,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACvC,CAAC"}

package/dist/types/handlers/transaction.mjs

@@ -0,0 +1,12 @@
+/**
+ * The severity level of content being returned from a transaction insight.
+ * Currently only one level is supported:
+ *
+ * - `critical` - The transaction is critical and should not be submitted by the
+ * user.
+ */
+export var SeverityLevel;
+(function (SeverityLevel) {
+    SeverityLevel["Critical"] = "critical";
+})(SeverityLevel || (SeverityLevel = {}));
+//# sourceMappingURL=transaction.mjs.map

package/dist/types/handlers/transaction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.mjs","sourceRoot":"","sources":["../../../src/types/handlers/transaction.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,sCAAqB,CAAA;AACvB,CAAC,EAFW,aAAa,KAAb,aAAa,QAExB","sourcesContent":["import type { ComponentOrElement } from '..';\nimport type { EnumToUnion } from '../../internals';\nimport type { ChainId } from '../caip';\n\n/**\n * The severity level of content being returned from a transaction insight.\n * Currently only one level is supported:\n *\n * - `critical` - The transaction is critical and should not be submitted by the\n * user.\n */\nexport enum SeverityLevel {\n  Critical = 'critical',\n}\n\n/**\n * An EIP-1559 (type 2) transaction object.\n *\n * @property from - The address the transaction is being sent from.\n * @property to - The address the transaction is being sent to.\n * @property nonce - The nonce of the transaction.\n * @property value - The value of the transaction.\n * @property data - The data of the transaction.\n * @property gas - The gas limit of the transaction.\n * @property maxFeePerGas - The maximum fee per gas of the transaction.\n * @property maxPriorityFeePerGas - The maximum priority fee per gas of the\n * transaction.\n * @property estimateSuggested - The suggested gas price for the transaction.\n * @property estimateUsed - The gas price used for the transaction.\n * @see https://eips.ethereum.org/EIPS/eip-1559\n */\nexport type EIP1559Transaction = {\n  from: string;\n  to: string;\n  nonce: string;\n  value: string;\n  data: string;\n  gas: string;\n  maxFeePerGas: string;\n  maxPriorityFeePerGas: string;\n  estimateSuggested: string;\n  estimateUsed: string;\n};\n\n/**\n * A legacy (type \"0\") transaction object.\n *\n * @property from - The address the transaction is being sent from.\n * @property to - The address the transaction is being sent to.\n * @property nonce - The nonce of the transaction.\n * @property value - The value of the transaction.\n * @property data - The data of the transaction.\n * @property gas - The gas limit of the transaction.\n * @property gasPrice - The gas price of the transaction.\n * @property estimateSuggested - The suggested gas price for the transaction.\n * @property estimateUsed - The gas price used for the transaction.\n */\nexport type LegacyTransaction = {\n  from: string;\n  to: string;\n  nonce: string;\n  value: string;\n  data: string;\n  gas: string;\n  gasPrice: string;\n  estimateSuggested: string;\n  estimateUsed: string;\n};\n\n/**\n * A transaction object. This can be either an EIP-1559 transaction or a legacy\n * transaction.\n *\n * @see EIP1559Transaction\n * @see LegacyTransaction\n */\nexport type Transaction = EIP1559Transaction | LegacyTransaction;\n\n/**\n * The `onTransaction` handler. This is called whenever a transaction is\n * submitted to the snap. It can return insights about the transaction, which\n * will be displayed to the user.\n *\n * Note that using this handler requires the `endowment:transaction-insights`\n * permission.\n *\n * @param args - The request arguments.\n * @param args.transaction - The transaction object, containing the address,\n * value, data, and other properties of the transaction.\n * @param args.chainId - The CAIP-2 {@link ChainId} of the network the\n * transaction is being submitted to.\n * @param args.transactionOrigin - The origin of the transaction. This is the\n * URL of the website that submitted the transaction. This is only available if\n * the Snap has enabled the `allowTransactionOrigin` option in the\n * `endowment:transaction-insight` permission.\n * @returns An object containing insights about the transaction. See\n * {@link OnTransactionResponse}. Can also return `null` if no insights are\n * available.\n */\nexport type OnTransactionHandler = (args: {\n  transaction: Transaction;\n  chainId: ChainId;\n  transactionOrigin?: string;\n}) => Promise<OnTransactionResponse | null>;\n\n/**\n * The response from a Snap's `onTransaction` handler.\n *\n * @property component - A custom UI component, that will be shown in MetaMask.\n * @property id - A Snap interface ID.\n * @property severity - The severity level of the content. Currently only one\n * level is supported: `critical`.\n */\nexport type OnTransactionResponse =\n  | {\n      content: ComponentOrElement;\n      severity?: EnumToUnion<SeverityLevel>;\n    }\n  | {\n      id: string;\n      severity?: EnumToUnion<SeverityLevel>;\n    };\n"]}

package/dist/types/handlers/user-input.cjs

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserInputEventStruct = exports.FileUploadEventStruct = exports.InputChangeEventStruct = exports.FormSubmitEventStruct = exports.FileStruct = exports.ButtonClickEventStruct = exports.GenericEventStruct = exports.UserInputEventType = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+/**
+ * The type of user input event fired.
+ * Currently only three events are supported:
+ *
+ * - `ButtonClickEvent` - A button has been clicked in the UI.
+ * - `FormSubmitEvent` - A Form has been submitted in the UI.
+ * - `InputChangeEvent` - The value of an input field has changed in the UI.
+ * - `FileUploadEvent` - A file has been uploaded in the UI.
+ */
+var UserInputEventType;
+(function (UserInputEventType) {
+    UserInputEventType["ButtonClickEvent"] = "ButtonClickEvent";
+    UserInputEventType["FormSubmitEvent"] = "FormSubmitEvent";
+    UserInputEventType["InputChangeEvent"] = "InputChangeEvent";
+    UserInputEventType["FileUploadEvent"] = "FileUploadEvent";
+})(UserInputEventType || (exports.UserInputEventType = UserInputEventType = {}));
+exports.GenericEventStruct = (0, superstruct_1.object)({
+    type: (0, superstruct_1.string)(),
+    name: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+});
+exports.ButtonClickEventStruct = (0, superstruct_1.assign)(exports.GenericEventStruct, (0, superstruct_1.object)({
+    type: (0, superstruct_1.literal)(UserInputEventType.ButtonClickEvent),
+    name: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+}));
+exports.FileStruct = (0, superstruct_1.object)({
+    name: (0, superstruct_1.string)(),
+    size: (0, superstruct_1.number)(),
+    contentType: (0, superstruct_1.string)(),
+    contents: (0, superstruct_1.string)(),
+});
+exports.FormSubmitEventStruct = (0, superstruct_1.assign)(exports.GenericEventStruct, (0, superstruct_1.object)({
+    type: (0, superstruct_1.literal)(UserInputEventType.FormSubmitEvent),
+    value: (0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.nullable)((0, superstruct_1.union)([(0, superstruct_1.string)(), exports.FileStruct, (0, superstruct_1.boolean)()]))),
+    name: (0, superstruct_1.string)(),
+}));
+exports.InputChangeEventStruct = (0, superstruct_1.assign)(exports.GenericEventStruct, (0, superstruct_1.object)({
+    type: (0, superstruct_1.literal)(UserInputEventType.InputChangeEvent),
+    name: (0, superstruct_1.string)(),
+    value: (0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.boolean)()]),
+}));
+exports.FileUploadEventStruct = (0, superstruct_1.assign)(exports.GenericEventStruct, (0, superstruct_1.object)({
+    type: (0, superstruct_1.literal)(UserInputEventType.FileUploadEvent),
+    name: (0, superstruct_1.string)(),
+    file: (0, superstruct_1.nullable)(exports.FileStruct),
+}));
+exports.UserInputEventStruct = (0, superstruct_1.union)([
+    exports.ButtonClickEventStruct,
+    exports.FormSubmitEventStruct,
+    exports.InputChangeEventStruct,
+    exports.FileUploadEventStruct,
+]);
+//# sourceMappingURL=user-input.cjs.map

package/dist/types/handlers/user-input.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-input.cjs","sourceRoot":"","sources":["../../../src/types/handlers/user-input.ts"],"names":[],"mappings":";;;AACA,uDAW+B;AAI/B;;;;;;;;GAQG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,2DAAqC,CAAA;IACrC,yDAAmC,CAAA;IACnC,2DAAqC,CAAA;IACrC,yDAAmC,CAAA;AACrC,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAEY,QAAA,kBAAkB,GAAG,IAAA,oBAAM,EAAC;IACvC,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAC1C,0BAAkB,EAClB,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,IAAA,qBAAO,EAAC,kBAAkB,CAAC,gBAAgB,CAAC;IAClD,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CACH,CAAC;AAYW,QAAA,UAAU,GAAG,IAAA,oBAAM,EAAC;IAC/B,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,WAAW,EAAE,IAAA,oBAAM,GAAE;IACrB,QAAQ,EAAE,IAAA,oBAAM,GAAE;CACnB,CAAC,CAAC;AAaU,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EACzC,0BAAkB,EAClB,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,IAAA,qBAAO,EAAC,kBAAkB,CAAC,eAAe,CAAC;IACjD,KAAK,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,EAAE,IAAA,qBAAO,GAAE,CAAC,CAAC,CAAC,CAAC;IAC3E,IAAI,EAAE,IAAA,oBAAM,GAAE;CACf,CAAC,CACH,CAAC;AAiBW,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAC1C,0BAAkB,EAClB,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,IAAA,qBAAO,EAAC,kBAAkB,CAAC,gBAAgB,CAAC;IAClD,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,qBAAO,GAAE,CAAC,CAAC;CACpC,CAAC,CACH,CAAC;AAYW,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EACzC,0BAAkB,EAClB,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,IAAA,qBAAO,EAAC,kBAAkB,CAAC,eAAe,CAAC;IACjD,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,IAAI,EAAE,IAAA,sBAAQ,EAAC,kBAAU,CAAC;CAC3B,CAAC,CACH,CAAC;AAcW,QAAA,oBAAoB,GAAG,IAAA,mBAAK,EAAC;IACxC,8BAAsB;IACtB,6BAAqB;IACrB,8BAAsB;IACtB,6BAAqB;CACtB,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  number,\n  assign,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  union,\n  boolean,\n} from '@metamask/superstruct';\n\nimport type { InterfaceContext } from '../interface';\n\n/**\n * The type of user input event fired.\n * Currently only three events are supported:\n *\n * - `ButtonClickEvent` - A button has been clicked in the UI.\n * - `FormSubmitEvent` - A Form has been submitted in the UI.\n * - `InputChangeEvent` - The value of an input field has changed in the UI.\n * - `FileUploadEvent` - A file has been uploaded in the UI.\n */\nexport enum UserInputEventType {\n  ButtonClickEvent = 'ButtonClickEvent',\n  FormSubmitEvent = 'FormSubmitEvent',\n  InputChangeEvent = 'InputChangeEvent',\n  FileUploadEvent = 'FileUploadEvent',\n}\n\nexport const GenericEventStruct = object({\n  type: string(),\n  name: optional(string()),\n});\n\nexport const ButtonClickEventStruct = assign(\n  GenericEventStruct,\n  object({\n    type: literal(UserInputEventType.ButtonClickEvent),\n    name: optional(string()),\n  }),\n);\n\n/**\n * A button click event fired in the UI. This is passed to the params of the\n * `onUserInput` handler.\n *\n * @property type - The type of event fired. See {@link UserInputEventType} for\n * the different types. This is always `ButtonClickEvent`.\n * @property name - The optional component name that fired the event.\n */\nexport type ButtonClickEvent = Infer<typeof ButtonClickEventStruct>;\n\nexport const FileStruct = object({\n  name: string(),\n  size: number(),\n  contentType: string(),\n  contents: string(),\n});\n\n/**\n * A file object containing the file name, size, content type, and the base64\n * encoded contents of the file.\n *\n * @property name - The name of the file.\n * @property size - The size of the file in bytes.\n * @property contentType - The content type of the file.\n * @property contents - The base64 encoded contents of the file.\n */\nexport type File = Infer<typeof FileStruct>;\n\nexport const FormSubmitEventStruct = assign(\n  GenericEventStruct,\n  object({\n    type: literal(UserInputEventType.FormSubmitEvent),\n    value: record(string(), nullable(union([string(), FileStruct, boolean()]))),\n    name: string(),\n  }),\n);\n\n/**\n * A form submit event, which is fired when a submit button is clicked.\n *\n * @property type - The type of event fired. This is always `FormSubmitEvent`.\n * @property name - The name of the form that was submitted.\n * @property value - The form values submitted as an object. The keys are the\n * names of the form fields and the values are the values of the form fields. If\n * a form field is empty, the value is `null` or an empty string.\n * @property files - The files uploaded in the form. The keys are the names of\n * the file input fields and the values are the file objects containing the file\n * name, size, content type, and the base64 encoded contents of the file. See\n * {@link File}.\n */\nexport type FormSubmitEvent = Infer<typeof FormSubmitEventStruct>;\n\nexport const InputChangeEventStruct = assign(\n  GenericEventStruct,\n  object({\n    type: literal(UserInputEventType.InputChangeEvent),\n    name: string(),\n    value: union([string(), boolean()]),\n  }),\n);\n\n/**\n * An input change event, which is fired when the value of an input field\n * changes.\n *\n * @property type - The type of event fired. This is always `InputChangeEvent`.\n * @property name - The name of the input field that changed.\n * @property value - The new value of the input field.\n */\nexport type InputChangeEvent = Infer<typeof InputChangeEventStruct>;\n\nexport const FileUploadEventStruct = assign(\n  GenericEventStruct,\n  object({\n    type: literal(UserInputEventType.FileUploadEvent),\n    name: string(),\n    file: nullable(FileStruct),\n  }),\n);\n\n/**\n * A file upload event, which is fired when a file is uploaded.\n *\n * @property type - The type of event fired. This is always `FileUploadEvent`.\n * @property name - The name of the file input field that was used to upload the\n * file.\n * @property file - The file object containing the file name, size,\n * content type, and the base64 encoded contents of the file.\n * @see File\n */\nexport type FileUploadEvent = Infer<typeof FileUploadEventStruct>;\n\nexport const UserInputEventStruct = union([\n  ButtonClickEventStruct,\n  FormSubmitEventStruct,\n  InputChangeEventStruct,\n  FileUploadEventStruct,\n]);\n\n/**\n * A user input event fired in the UI. This is passed to the params of the `onUserInput` handler.\n *\n * @property type - The type of event fired. See {@link UserInputEventType} for the different types.\n * @property name - The component name that fired the event. It is optional for\n * an {@link UserInputEventType.ButtonClickEvent}.\n * @property value - The value associated with the event. Only available when an\n * {@link UserInputEventType.FormSubmitEvent} is fired. It contains the form values submitted.\n */\nexport type UserInputEvent =\n  | ButtonClickEvent\n  | FormSubmitEvent\n  | InputChangeEvent\n  | FileUploadEvent;\n\n/**\n * The `onUserInput` handler. This is called when an user input event is fired in the UI.\n *\n * @param args - The user input event.\n * @param args.id - The user interface id.\n * @param args.event - The {@link UserInputEvent} object, containing the data about the fired event.\n */\nexport type OnUserInputHandler = (args: {\n  id: string;\n  event: UserInputEvent;\n  context: InterfaceContext | null;\n}) => Promise<void>;\n"]}

package/dist/types/{types/handlers/user-input.d.ts → handlers/user-input.d.cts}

@@ -1,5 +1,5 @@
-import type { Infer } from '@metamask/superstruct';
-import type { InterfaceContext } from '../interface';
+import type { Infer } from "@metamask/superstruct";
+import type { InterfaceContext } from "../interface.cjs";
 /**
  * The type of user input event fired.
  * Currently only three events are supported:
@@ -60,14 +60,14 @@ export declare const FileStruct: import("@metamask/superstruct").Struct<{
  */
 export type File = Infer<typeof FileStruct>;
 export declare const FormSubmitEventStruct: import("@metamask/superstruct").Struct<{
+    type: UserInputEventType.FormSubmitEvent;
+    name: string;
     value: Record<string, string | boolean | {
         name: string;
         size: number;
         contentType: string;
         contents: string;
     } | null>;
-    type: UserInputEventType.FormSubmitEvent;
-    name: string;
 }, {
     type: import("@metamask/superstruct").Struct<UserInputEventType.FormSubmitEvent, UserInputEventType.FormSubmitEvent>;
     value: import("@metamask/superstruct").Struct<Record<string, string | boolean | {
@@ -93,9 +93,9 @@ export declare const FormSubmitEventStruct: import("@metamask/superstruct").Stru
  */
 export type FormSubmitEvent = Infer<typeof FormSubmitEventStruct>;
 export declare const InputChangeEventStruct: import("@metamask/superstruct").Struct<{
-    value: string | boolean;
     type: UserInputEventType.InputChangeEvent;
     name: string;
+    value: string | boolean;
 }, {
     type: import("@metamask/superstruct").Struct<UserInputEventType.InputChangeEvent, UserInputEventType.InputChangeEvent>;
     name: import("@metamask/superstruct").Struct<string, null>;
@@ -112,13 +112,13 @@ export declare const InputChangeEventStruct: import("@metamask/superstruct").Str
 export type InputChangeEvent = Infer<typeof InputChangeEventStruct>;
 export declare const FileUploadEventStruct: import("@metamask/superstruct").Struct<{
     type: UserInputEventType.FileUploadEvent;
-    name: string;
     file: {
         name: string;
         size: number;
         contentType: string;
         contents: string;
     } | null;
+    name: string;
 }, {
     type: import("@metamask/superstruct").Struct<UserInputEventType.FileUploadEvent, UserInputEventType.FileUploadEvent>;
     name: import("@metamask/superstruct").Struct<string, null>;
@@ -149,27 +149,27 @@ export declare const UserInputEventStruct: import("@metamask/superstruct").Struc
     type: UserInputEventType.ButtonClickEvent;
     name?: string | undefined;
 } | {
+    type: UserInputEventType.FormSubmitEvent;
+    name: string;
     value: Record<string, string | boolean | {
         name: string;
         size: number;
         contentType: string;
         contents: string;
     } | null>;
-    type: UserInputEventType.FormSubmitEvent;
-    name: string;
 } | {
-    value: string | boolean;
     type: UserInputEventType.InputChangeEvent;
     name: string;
+    value: string | boolean;
 } | {
     type: UserInputEventType.FileUploadEvent;
-    name: string;
     file: {
         name: string;
         size: number;
         contentType: string;
         contents: string;
     } | null;
+    name: string;
 }, null>;
 /**
  * A user input event fired in the UI. This is passed to the params of the `onUserInput` handler.
@@ -193,3 +193,4 @@ export type OnUserInputHandler = (args: {
     event: UserInputEvent;
     context: InterfaceContext | null;
 }) => Promise<void>;
+//# sourceMappingURL=user-input.d.cts.map

package/dist/types/handlers/user-input.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-input.d.cts","sourceRoot":"","sources":["../../../src/types/handlers/user-input.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAcnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAqB;AAErD;;;;;;;;GAQG;AACH,oBAAY,kBAAkB;IAC5B,gBAAgB,qBAAqB;IACrC,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;IACrC,eAAe,oBAAoB;CACpC;AAED,eAAO,MAAM,kBAAkB;;;;;;EAG7B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;EAMlC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE,eAAO,MAAM,UAAU;;;;;;;;;;EAKrB,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE5C,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;EAOjC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAElE,eAAO,MAAM,sBAAsB;;;;;;;;EAOlC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;EAOjC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAElE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;QAK/B,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GACtB,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,eAAe,CAAC;AAEpB;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,cAAc,CAAC;IACtB,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAClC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC"}