@metamask/snaps-sdk 10.3.0 → 11.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-sdk",
-  "version": "10.3.0",
+  "version": "11.0.0",
   "description": "A library containing the core functionality for building MetaMask Snaps",
   "keywords": [
     "MetaMask",
@@ -74,6 +74,7 @@
   ],
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/snaps-sdk",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/snaps-sdk",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn changelog:validate && yarn lint:dependencies",
@@ -95,12 +96,12 @@
     "@metamask/providers": "^22.1.1",
     "@metamask/rpc-errors": "^7.0.3",
     "@metamask/superstruct": "^3.2.1",
-    "@metamask/utils": "^11.8.1",
+    "@metamask/utils": "^11.10.0",
     "luxon": "^3.5.0"
   },
   "devDependencies": {
-    "@lavamoat/allow-scripts": "^3.4.0",
-    "@metamask/auto-changelog": "^5.0.2",
+    "@lavamoat/allow-scripts": "^3.4.3",
+    "@metamask/auto-changelog": "^5.3.2",
     "@ts-bridge/cli": "^0.6.1",
     "@types/jest": "^27.5.1",
     "@types/luxon": "^3",
@@ -114,6 +115,8 @@
     "jest-silent-reporter": "^0.6.0",
     "prettier": "^3.3.3",
     "ts-jest": "^29.1.1",
+    "typedoc": "^0.28.16",
+    "typedoc-theme-fresh": "^0.2.3",
     "typescript": "~5.3.3"
   },
   "engines": {

package/dist/types/methods/get-currency-rate.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-currency-rate.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-currency-rate.ts"],"names":[],"mappings":"","sourcesContent":["export type Currency<Value extends string> =\n  | Lowercase<Value>\n  | Uppercase<Value>;\n\nexport type AvailableCurrency = Currency<'btc'>;\n\n/**\n * The currency rate object.\n *\n * @property currency - The native currency symbol used for the conversion (e.g 'usd').\n * @property conversionRate - The conversion rate from the cryptocurrency to the native currency.\n * @property conversionDate - The date of the conversion rate as a UNIX timestamp.\n * @property usdConversionRate - The conversion rate to USD.\n */\nexport type CurrencyRate = {\n  currency: string;\n  conversionRate: number;\n  conversionDate: number;\n  usdConversionRate?: number;\n};\n\n/**\n * The request parameters for the `snap_getCurrencyRate` method.\n *\n * @property currency - The currency symbol.\n */\nexport type GetCurrencyRateParams = {\n  currency: AvailableCurrency;\n};\n\n/**\n * The result returned by the `snap_getCurrencyRate` method, which is the {@link CurrencyRate} object.\n */\nexport type GetCurrencyRateResult = CurrencyRate | null;\n"]}

package/dist/types/methods/get-currency-rate.d.cts

@@ -1,29 +0,0 @@
-export type Currency<Value extends string> = Lowercase<Value> | Uppercase<Value>;
-export type AvailableCurrency = Currency<'btc'>;
-/**
- * The currency rate object.
- *
- * @property currency - The native currency symbol used for the conversion (e.g 'usd').
- * @property conversionRate - The conversion rate from the cryptocurrency to the native currency.
- * @property conversionDate - The date of the conversion rate as a UNIX timestamp.
- * @property usdConversionRate - The conversion rate to USD.
- */
-export type CurrencyRate = {
-    currency: string;
-    conversionRate: number;
-    conversionDate: number;
-    usdConversionRate?: number;
-};
-/**
- * The request parameters for the `snap_getCurrencyRate` method.
- *
- * @property currency - The currency symbol.
- */
-export type GetCurrencyRateParams = {
-    currency: AvailableCurrency;
-};
-/**
- * The result returned by the `snap_getCurrencyRate` method, which is the {@link CurrencyRate} object.
- */
-export type GetCurrencyRateResult = CurrencyRate | null;
-//# sourceMappingURL=get-currency-rate.d.cts.map

package/dist/types/methods/get-currency-rate.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-currency-rate.d.cts","sourceRoot":"","sources":["../../../src/types/methods/get-currency-rate.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,CAAC,KAAK,SAAS,MAAM,IACrC,SAAS,CAAC,KAAK,CAAC,GAChB,SAAS,CAAC,KAAK,CAAC,CAAC;AAErB,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,IAAI,CAAC"}

package/dist/types/methods/get-currency-rate.d.mts

@@ -1,29 +0,0 @@
-export type Currency<Value extends string> = Lowercase<Value> | Uppercase<Value>;
-export type AvailableCurrency = Currency<'btc'>;
-/**
- * The currency rate object.
- *
- * @property currency - The native currency symbol used for the conversion (e.g 'usd').
- * @property conversionRate - The conversion rate from the cryptocurrency to the native currency.
- * @property conversionDate - The date of the conversion rate as a UNIX timestamp.
- * @property usdConversionRate - The conversion rate to USD.
- */
-export type CurrencyRate = {
-    currency: string;
-    conversionRate: number;
-    conversionDate: number;
-    usdConversionRate?: number;
-};
-/**
- * The request parameters for the `snap_getCurrencyRate` method.
- *
- * @property currency - The currency symbol.
- */
-export type GetCurrencyRateParams = {
-    currency: AvailableCurrency;
-};
-/**
- * The result returned by the `snap_getCurrencyRate` method, which is the {@link CurrencyRate} object.
- */
-export type GetCurrencyRateResult = CurrencyRate | null;
-//# sourceMappingURL=get-currency-rate.d.mts.map

package/dist/types/methods/get-currency-rate.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-currency-rate.d.mts","sourceRoot":"","sources":["../../../src/types/methods/get-currency-rate.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,CAAC,KAAK,SAAS,MAAM,IACrC,SAAS,CAAC,KAAK,CAAC,GAChB,SAAS,CAAC,KAAK,CAAC,CAAC;AAErB,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,IAAI,CAAC"}

package/dist/types/methods/get-currency-rate.mjs

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

package/dist/types/methods/get-currency-rate.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-currency-rate.mjs","sourceRoot":"","sources":["../../../src/types/methods/get-currency-rate.ts"],"names":[],"mappings":"","sourcesContent":["export type Currency<Value extends string> =\n  | Lowercase<Value>\n  | Uppercase<Value>;\n\nexport type AvailableCurrency = Currency<'btc'>;\n\n/**\n * The currency rate object.\n *\n * @property currency - The native currency symbol used for the conversion (e.g 'usd').\n * @property conversionRate - The conversion rate from the cryptocurrency to the native currency.\n * @property conversionDate - The date of the conversion rate as a UNIX timestamp.\n * @property usdConversionRate - The conversion rate to USD.\n */\nexport type CurrencyRate = {\n  currency: string;\n  conversionRate: number;\n  conversionDate: number;\n  usdConversionRate?: number;\n};\n\n/**\n * The request parameters for the `snap_getCurrencyRate` method.\n *\n * @property currency - The currency symbol.\n */\nexport type GetCurrencyRateParams = {\n  currency: AvailableCurrency;\n};\n\n/**\n * The result returned by the `snap_getCurrencyRate` method, which is the {@link CurrencyRate} object.\n */\nexport type GetCurrencyRateResult = CurrencyRate | null;\n"]}

package/dist/types/methods/provider-request.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider-request.cjs","sourceRoot":"","sources":["../../../src/types/methods/provider-request.ts"],"names":[],"mappings":"","sourcesContent":["import type { CaipChainId, Json, JsonRpcParams } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_experimentalProviderRequest` method.\n *\n * NOTE: This implementation is experimental and may be removed or changed without warning.\n *\n * @property chainId - The CAIP-2 chain ID to make the request to.\n * @property request - The JSON-RPC request.\n */\nexport type ProviderRequestParams = {\n  chainId: CaipChainId;\n  request: { method: string; params: JsonRpcParams } | { method: string };\n};\n\n/**\n * The result returned by the `snap_experimentalProviderRequest` method, which will be a JSON serializable value.\n *\n * NOTE: This implementation is experimental and may be removed or changed without warning.\n */\nexport type ProviderRequestResult = Json;\n"]}

package/dist/types/methods/provider-request.d.cts

@@ -1,25 +0,0 @@
-import type { CaipChainId, Json, JsonRpcParams } from "@metamask/utils";
-/**
- * The request parameters for the `snap_experimentalProviderRequest` method.
- *
- * NOTE: This implementation is experimental and may be removed or changed without warning.
- *
- * @property chainId - The CAIP-2 chain ID to make the request to.
- * @property request - The JSON-RPC request.
- */
-export type ProviderRequestParams = {
-    chainId: CaipChainId;
-    request: {
-        method: string;
-        params: JsonRpcParams;
-    } | {
-        method: string;
-    };
-};
-/**
- * The result returned by the `snap_experimentalProviderRequest` method, which will be a JSON serializable value.
- *
- * NOTE: This implementation is experimental and may be removed or changed without warning.
- */
-export type ProviderRequestResult = Json;
-//# sourceMappingURL=provider-request.d.cts.map

package/dist/types/methods/provider-request.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider-request.d.cts","sourceRoot":"","sources":["../../../src/types/methods/provider-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAExE;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACzE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC"}

package/dist/types/methods/provider-request.d.mts

@@ -1,25 +0,0 @@
-import type { CaipChainId, Json, JsonRpcParams } from "@metamask/utils";
-/**
- * The request parameters for the `snap_experimentalProviderRequest` method.
- *
- * NOTE: This implementation is experimental and may be removed or changed without warning.
- *
- * @property chainId - The CAIP-2 chain ID to make the request to.
- * @property request - The JSON-RPC request.
- */
-export type ProviderRequestParams = {
-    chainId: CaipChainId;
-    request: {
-        method: string;
-        params: JsonRpcParams;
-    } | {
-        method: string;
-    };
-};
-/**
- * The result returned by the `snap_experimentalProviderRequest` method, which will be a JSON serializable value.
- *
- * NOTE: This implementation is experimental and may be removed or changed without warning.
- */
-export type ProviderRequestResult = Json;
-//# sourceMappingURL=provider-request.d.mts.map

package/dist/types/methods/provider-request.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider-request.d.mts","sourceRoot":"","sources":["../../../src/types/methods/provider-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAExE;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACzE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC"}

package/dist/types/methods/provider-request.mjs

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

package/dist/types/methods/provider-request.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider-request.mjs","sourceRoot":"","sources":["../../../src/types/methods/provider-request.ts"],"names":[],"mappings":"","sourcesContent":["import type { CaipChainId, Json, JsonRpcParams } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_experimentalProviderRequest` method.\n *\n * NOTE: This implementation is experimental and may be removed or changed without warning.\n *\n * @property chainId - The CAIP-2 chain ID to make the request to.\n * @property request - The JSON-RPC request.\n */\nexport type ProviderRequestParams = {\n  chainId: CaipChainId;\n  request: { method: string; params: JsonRpcParams } | { method: string };\n};\n\n/**\n * The result returned by the `snap_experimentalProviderRequest` method, which will be a JSON serializable value.\n *\n * NOTE: This implementation is experimental and may be removed or changed without warning.\n */\nexport type ProviderRequestResult = Json;\n"]}

package/dist/ui/builder.cjs

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBuilder = void 0;
-const utils_1 = require("@metamask/utils");
-/**
- * A function that returns a function to "build" a {@link Component}. It infers
- * the type of the component from the given struct, and performs validation on
- * the created component.
- *
- * The returned function can handle the node arguments in two ways:
- * 1. As a single object, with the keys corresponding to the node's properties,
- * excluding the `type` property.
- * 2. As an array of arguments, with the order corresponding to the given keys.
- *
- * @param type - The type of the component to build.
- * @param struct - The struct to use to validate the component.
- * @param keys - The keys of the component to use as arguments to the builder.
- * The order of the keys determines the order of the arguments.
- * @returns A function that builds a component of the given type.
- * @internal
- */
-function createBuilder(type, struct, keys = []) {
-    return (...args) => {
-        // Node passed as a single object.
-        if (args.length === 1 && (0, utils_1.isPlainObject)(args[0])) {
-            const node = { ...args[0], type };
-            // The user could be passing invalid values to the builder, so we need to
-            // validate them as per the component's struct.
-            (0, utils_1.assertStruct)(node, struct, `Invalid ${type} component`);
-            return node;
-        }
-        // Node passed as an array of arguments.
-        const node = keys.reduce((partialNode, key, index) => {
-            if (args[index] !== undefined) {
-                return {
-                    ...partialNode,
-                    [key]: args[index],
-                };
-            }
-            return partialNode;
-        }, { type });
-        // The user could be passing invalid values to the builder, so we need to
-        // validate them as per the component's struct.
-        (0, utils_1.assertStruct)(node, struct, `Invalid ${type} component`);
-        return node;
-    };
-}
-exports.createBuilder = createBuilder;
-//# sourceMappingURL=builder.cjs.map

package/dist/ui/builder.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"builder.cjs","sourceRoot":"","sources":["../../src/ui/builder.ts"],"names":[],"mappings":";;;AACA,2CAA8D;AA8B9D;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,aAAa,CAI3B,IAAc,EACd,MAAoB,EACpB,OAAa,EAAqB;IAElC,OAAO,CAAC,GAAG,IAA2D,EAAE,EAAE;QACxE,kCAAkC;QAClC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YAElC,yEAAyE;YACzE,+CAA+C;YAC/C,IAAA,oBAAY,EAAC,IAAI,EAAE,MAAM,EAAE,WAAW,IAAI,YAAY,CAAC,CAAC;YACxD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,wCAAwC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CACtB,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO;oBACL,GAAG,WAAW;oBACd,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;iBACnB,CAAC;YACJ,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC,EACD,EAAE,IAAI,EAAE,CACT,CAAC;QAEF,yEAAyE;QACzE,+CAA+C;QAC/C,IAAA,oBAAY,EAAC,IAAI,EAAE,MAAM,EAAE,WAAW,IAAI,YAAY,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAvCD,sCAuCC","sourcesContent":["import type { Struct } from '@metamask/superstruct';\nimport { assertStruct, isPlainObject } from '@metamask/utils';\n\nimport type { Component } from './components';\nimport type { NodeType } from './nodes';\n\n/**\n * A function that builds a {@link Component}. This infers the proper args type\n * from the given node.\n *\n * @internal\n */\ntype NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> =\n  Omit<Node, 'type'> extends Record<string, never>\n    ? (...args: []) => Node\n    : (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys>) => Node;\n\n/**\n * Map from an array of node keys to the corresponding array type.\n *\n * @example\n * type Node = { type: 'node'; a: string; b: number; c: boolean };\n * type Keys = ['a', 'b', 'c'];\n *\n * type NodeArray = NodeArrayType<Node, Keys>; // [string, number, boolean]\n * @internal\n */\ntype NodeArrayType<Node extends Component, Keys extends (keyof Node)[]> = {\n  [Key in keyof Keys]: Node[Keys[Key]];\n};\n\n/**\n * A function that returns a function to \"build\" a {@link Component}. It infers\n * the type of the component from the given struct, and performs validation on\n * the created component.\n *\n * The returned function can handle the node arguments in two ways:\n * 1. As a single object, with the keys corresponding to the node's properties,\n * excluding the `type` property.\n * 2. As an array of arguments, with the order corresponding to the given keys.\n *\n * @param type - The type of the component to build.\n * @param struct - The struct to use to validate the component.\n * @param keys - The keys of the component to use as arguments to the builder.\n * The order of the keys determines the order of the arguments.\n * @returns A function that builds a component of the given type.\n * @internal\n */\nexport function createBuilder<\n  Node extends Component,\n  Keys extends (keyof Node)[] = [],\n>(\n  type: NodeType,\n  struct: Struct<Node>,\n  keys: Keys = [] as unknown as Keys,\n): NodeBuilder<Node, Keys> {\n  return (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys> | []) => {\n    // Node passed as a single object.\n    if (args.length === 1 && isPlainObject(args[0])) {\n      const node = { ...args[0], type };\n\n      // The user could be passing invalid values to the builder, so we need to\n      // validate them as per the component's struct.\n      assertStruct(node, struct, `Invalid ${type} component`);\n      return node;\n    }\n\n    // Node passed as an array of arguments.\n    const node = keys.reduce<Partial<Component>>(\n      (partialNode, key, index) => {\n        if (args[index] !== undefined) {\n          return {\n            ...partialNode,\n            [key]: args[index],\n          };\n        }\n\n        return partialNode;\n      },\n      { type },\n    );\n\n    // The user could be passing invalid values to the builder, so we need to\n    // validate them as per the component's struct.\n    assertStruct(node, struct, `Invalid ${type} component`);\n    return node;\n  };\n}\n"]}

package/dist/ui/builder.d.cts

@@ -1,43 +0,0 @@
-import type { Struct } from "@metamask/superstruct";
-import type { Component } from "./components/index.cjs";
-import type { NodeType } from "./nodes.cjs";
-/**
- * A function that builds a {@link Component}. This infers the proper args type
- * from the given node.
- *
- * @internal
- */
-type NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> = Omit<Node, 'type'> extends Record<string, never> ? (...args: []) => Node : (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys>) => Node;
-/**
- * Map from an array of node keys to the corresponding array type.
- *
- * @example
- * type Node = { type: 'node'; a: string; b: number; c: boolean };
- * type Keys = ['a', 'b', 'c'];
- *
- * type NodeArray = NodeArrayType<Node, Keys>; // [string, number, boolean]
- * @internal
- */
-type NodeArrayType<Node extends Component, Keys extends (keyof Node)[]> = {
-    [Key in keyof Keys]: Node[Keys[Key]];
-};
-/**
- * A function that returns a function to "build" a {@link Component}. It infers
- * the type of the component from the given struct, and performs validation on
- * the created component.
- *
- * The returned function can handle the node arguments in two ways:
- * 1. As a single object, with the keys corresponding to the node's properties,
- * excluding the `type` property.
- * 2. As an array of arguments, with the order corresponding to the given keys.
- *
- * @param type - The type of the component to build.
- * @param struct - The struct to use to validate the component.
- * @param keys - The keys of the component to use as arguments to the builder.
- * The order of the keys determines the order of the arguments.
- * @returns A function that builds a component of the given type.
- * @internal
- */
-export declare function createBuilder<Node extends Component, Keys extends (keyof Node)[] = []>(type: NodeType, struct: Struct<Node>, keys?: Keys): NodeBuilder<Node, Keys>;
-export {};
-//# sourceMappingURL=builder.d.cts.map

package/dist/ui/builder.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"builder.d.cts","sourceRoot":"","sources":["../../src/ui/builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAGpD,OAAO,KAAK,EAAE,SAAS,EAAE,+BAAqB;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAgB;AAExC;;;;;GAKG;AACH,KAAK,WAAW,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,IAClE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC5C,CAAC,GAAG,IAAI,EAAE,EAAE,KAAK,IAAI,GACrB,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;AAE1E;;;;;;;;;GASG;AACH,KAAK,aAAa,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,IAAI;KACvE,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,SAAS,SAAS,EACtB,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,GAAG,EAAE,EAEhC,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EACpB,IAAI,GAAE,IAA4B,GACjC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAgCzB"}

package/dist/ui/builder.d.mts

@@ -1,43 +0,0 @@
-import type { Struct } from "@metamask/superstruct";
-import type { Component } from "./components/index.mjs";
-import type { NodeType } from "./nodes.mjs";
-/**
- * A function that builds a {@link Component}. This infers the proper args type
- * from the given node.
- *
- * @internal
- */
-type NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> = Omit<Node, 'type'> extends Record<string, never> ? (...args: []) => Node : (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys>) => Node;
-/**
- * Map from an array of node keys to the corresponding array type.
- *
- * @example
- * type Node = { type: 'node'; a: string; b: number; c: boolean };
- * type Keys = ['a', 'b', 'c'];
- *
- * type NodeArray = NodeArrayType<Node, Keys>; // [string, number, boolean]
- * @internal
- */
-type NodeArrayType<Node extends Component, Keys extends (keyof Node)[]> = {
-    [Key in keyof Keys]: Node[Keys[Key]];
-};
-/**
- * A function that returns a function to "build" a {@link Component}. It infers
- * the type of the component from the given struct, and performs validation on
- * the created component.
- *
- * The returned function can handle the node arguments in two ways:
- * 1. As a single object, with the keys corresponding to the node's properties,
- * excluding the `type` property.
- * 2. As an array of arguments, with the order corresponding to the given keys.
- *
- * @param type - The type of the component to build.
- * @param struct - The struct to use to validate the component.
- * @param keys - The keys of the component to use as arguments to the builder.
- * The order of the keys determines the order of the arguments.
- * @returns A function that builds a component of the given type.
- * @internal
- */
-export declare function createBuilder<Node extends Component, Keys extends (keyof Node)[] = []>(type: NodeType, struct: Struct<Node>, keys?: Keys): NodeBuilder<Node, Keys>;
-export {};
-//# sourceMappingURL=builder.d.mts.map

package/dist/ui/builder.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"builder.d.mts","sourceRoot":"","sources":["../../src/ui/builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAGpD,OAAO,KAAK,EAAE,SAAS,EAAE,+BAAqB;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAgB;AAExC;;;;;GAKG;AACH,KAAK,WAAW,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,IAClE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC5C,CAAC,GAAG,IAAI,EAAE,EAAE,KAAK,IAAI,GACrB,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;AAE1E;;;;;;;;;GASG;AACH,KAAK,aAAa,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,IAAI;KACvE,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,SAAS,SAAS,EACtB,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,GAAG,EAAE,EAEhC,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EACpB,IAAI,GAAE,IAA4B,GACjC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAgCzB"}

package/dist/ui/builder.mjs

@@ -1,45 +0,0 @@
-import { assertStruct, isPlainObject } from "@metamask/utils";
-/**
- * A function that returns a function to "build" a {@link Component}. It infers
- * the type of the component from the given struct, and performs validation on
- * the created component.
- *
- * The returned function can handle the node arguments in two ways:
- * 1. As a single object, with the keys corresponding to the node's properties,
- * excluding the `type` property.
- * 2. As an array of arguments, with the order corresponding to the given keys.
- *
- * @param type - The type of the component to build.
- * @param struct - The struct to use to validate the component.
- * @param keys - The keys of the component to use as arguments to the builder.
- * The order of the keys determines the order of the arguments.
- * @returns A function that builds a component of the given type.
- * @internal
- */
-export function createBuilder(type, struct, keys = []) {
-    return (...args) => {
-        // Node passed as a single object.
-        if (args.length === 1 && isPlainObject(args[0])) {
-            const node = { ...args[0], type };
-            // The user could be passing invalid values to the builder, so we need to
-            // validate them as per the component's struct.
-            assertStruct(node, struct, `Invalid ${type} component`);
-            return node;
-        }
-        // Node passed as an array of arguments.
-        const node = keys.reduce((partialNode, key, index) => {
-            if (args[index] !== undefined) {
-                return {
-                    ...partialNode,
-                    [key]: args[index],
-                };
-            }
-            return partialNode;
-        }, { type });
-        // The user could be passing invalid values to the builder, so we need to
-        // validate them as per the component's struct.
-        assertStruct(node, struct, `Invalid ${type} component`);
-        return node;
-    };
-}
-//# sourceMappingURL=builder.mjs.map

package/dist/ui/builder.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"builder.mjs","sourceRoot":"","sources":["../../src/ui/builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,wBAAwB;AA8B9D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,aAAa,CAI3B,IAAc,EACd,MAAoB,EACpB,OAAa,EAAqB;IAElC,OAAO,CAAC,GAAG,IAA2D,EAAE,EAAE;QACxE,kCAAkC;QAClC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;YAElC,yEAAyE;YACzE,+CAA+C;YAC/C,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,IAAI,YAAY,CAAC,CAAC;YACxD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,wCAAwC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CACtB,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO;oBACL,GAAG,WAAW;oBACd,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;iBACnB,CAAC;YACJ,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC,EACD,EAAE,IAAI,EAAE,CACT,CAAC;QAEF,yEAAyE;QACzE,+CAA+C;QAC/C,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,IAAI,YAAY,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { Struct } from '@metamask/superstruct';\nimport { assertStruct, isPlainObject } from '@metamask/utils';\n\nimport type { Component } from './components';\nimport type { NodeType } from './nodes';\n\n/**\n * A function that builds a {@link Component}. This infers the proper args type\n * from the given node.\n *\n * @internal\n */\ntype NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> =\n  Omit<Node, 'type'> extends Record<string, never>\n    ? (...args: []) => Node\n    : (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys>) => Node;\n\n/**\n * Map from an array of node keys to the corresponding array type.\n *\n * @example\n * type Node = { type: 'node'; a: string; b: number; c: boolean };\n * type Keys = ['a', 'b', 'c'];\n *\n * type NodeArray = NodeArrayType<Node, Keys>; // [string, number, boolean]\n * @internal\n */\ntype NodeArrayType<Node extends Component, Keys extends (keyof Node)[]> = {\n  [Key in keyof Keys]: Node[Keys[Key]];\n};\n\n/**\n * A function that returns a function to \"build\" a {@link Component}. It infers\n * the type of the component from the given struct, and performs validation on\n * the created component.\n *\n * The returned function can handle the node arguments in two ways:\n * 1. As a single object, with the keys corresponding to the node's properties,\n * excluding the `type` property.\n * 2. As an array of arguments, with the order corresponding to the given keys.\n *\n * @param type - The type of the component to build.\n * @param struct - The struct to use to validate the component.\n * @param keys - The keys of the component to use as arguments to the builder.\n * The order of the keys determines the order of the arguments.\n * @returns A function that builds a component of the given type.\n * @internal\n */\nexport function createBuilder<\n  Node extends Component,\n  Keys extends (keyof Node)[] = [],\n>(\n  type: NodeType,\n  struct: Struct<Node>,\n  keys: Keys = [] as unknown as Keys,\n): NodeBuilder<Node, Keys> {\n  return (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys> | []) => {\n    // Node passed as a single object.\n    if (args.length === 1 && isPlainObject(args[0])) {\n      const node = { ...args[0], type };\n\n      // The user could be passing invalid values to the builder, so we need to\n      // validate them as per the component's struct.\n      assertStruct(node, struct, `Invalid ${type} component`);\n      return node;\n    }\n\n    // Node passed as an array of arguments.\n    const node = keys.reduce<Partial<Component>>(\n      (partialNode, key, index) => {\n        if (args[index] !== undefined) {\n          return {\n            ...partialNode,\n            [key]: args[index],\n          };\n        }\n\n        return partialNode;\n      },\n      { type },\n    );\n\n    // The user could be passing invalid values to the builder, so we need to\n    // validate them as per the component's struct.\n    assertStruct(node, struct, `Invalid ${type} component`);\n    return node;\n  };\n}\n"]}

package/dist/ui/component.cjs

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertIsComponent = exports.isComponent = void 0;
-const superstruct_1 = require("@metamask/superstruct");
-const utils_1 = require("@metamask/utils");
-const components_1 = require("./components/index.cjs");
-/**
- * Check if the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @returns `true` if the value is a {@link Component}, `false` otherwise.
- */
-function isComponent(value) {
-    return (0, superstruct_1.is)(value, components_1.ComponentStruct);
-}
-exports.isComponent = isComponent;
-/**
- * Assert that the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @throws If the value is not a {@link Component}.
- */
-function assertIsComponent(value) {
-    (0, utils_1.assertStruct)(value, components_1.ComponentStruct, 'Invalid component');
-}
-exports.assertIsComponent = assertIsComponent;
-//# sourceMappingURL=component.cjs.map

package/dist/ui/component.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"component.cjs","sourceRoot":"","sources":["../../src/ui/component.ts"],"names":[],"mappings":";;;AAAA,uDAA2C;AAC3C,2CAA+C;AAE/C,uDAA+C;AAG/C;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,4BAAe,CAAC,CAAC;AACpC,CAAC;AAFD,kCAEC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,IAAA,oBAAY,EAAC,KAAK,EAAE,4BAAe,EAAE,mBAAmB,CAAC,CAAC;AAC5D,CAAC;AAFD,8CAEC","sourcesContent":["import { is } from '@metamask/superstruct';\nimport { assertStruct } from '@metamask/utils';\n\nimport { ComponentStruct } from './components';\nimport type { Component } from './components';\n\n/**\n * Check if the given value is a {@link Component}. This performs recursive\n * validation of the component's children (if any).\n *\n * @param value - The value to check.\n * @returns `true` if the value is a {@link Component}, `false` otherwise.\n */\nexport function isComponent(value: unknown): value is Component {\n  return is(value, ComponentStruct);\n}\n\n/**\n * Assert that the given value is a {@link Component}. This performs recursive\n * validation of the component's children (if any).\n *\n * @param value - The value to check.\n * @throws If the value is not a {@link Component}.\n */\nexport function assertIsComponent(value: unknown): asserts value is Component {\n  assertStruct(value, ComponentStruct, 'Invalid component');\n}\n"]}

package/dist/ui/component.d.cts

@@ -1,18 +0,0 @@
-import type { Component } from "./components/index.cjs";
-/**
- * Check if the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @returns `true` if the value is a {@link Component}, `false` otherwise.
- */
-export declare function isComponent(value: unknown): value is Component;
-/**
- * Assert that the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @throws If the value is not a {@link Component}.
- */
-export declare function assertIsComponent(value: unknown): asserts value is Component;
-//# sourceMappingURL=component.d.cts.map

package/dist/ui/component.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"component.d.cts","sourceRoot":"","sources":["../../src/ui/component.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,+BAAqB;AAE9C;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,SAAS,CAE5E"}

package/dist/ui/component.d.mts

@@ -1,18 +0,0 @@
-import type { Component } from "./components/index.mjs";
-/**
- * Check if the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @returns `true` if the value is a {@link Component}, `false` otherwise.
- */
-export declare function isComponent(value: unknown): value is Component;
-/**
- * Assert that the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @throws If the value is not a {@link Component}.
- */
-export declare function assertIsComponent(value: unknown): asserts value is Component;
-//# sourceMappingURL=component.d.mts.map

package/dist/ui/component.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"component.d.mts","sourceRoot":"","sources":["../../src/ui/component.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,+BAAqB;AAE9C;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,SAAS,CAE5E"}

package/dist/ui/component.mjs

@@ -1,24 +0,0 @@
-import { is } from "@metamask/superstruct";
-import { assertStruct } from "@metamask/utils";
-import { ComponentStruct } from "./components/index.mjs";
-/**
- * Check if the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @returns `true` if the value is a {@link Component}, `false` otherwise.
- */
-export function isComponent(value) {
-    return is(value, ComponentStruct);
-}
-/**
- * Assert that the given value is a {@link Component}. This performs recursive
- * validation of the component's children (if any).
- *
- * @param value - The value to check.
- * @throws If the value is not a {@link Component}.
- */
-export function assertIsComponent(value) {
-    assertStruct(value, ComponentStruct, 'Invalid component');
-}
-//# sourceMappingURL=component.mjs.map

package/dist/ui/component.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"component.mjs","sourceRoot":"","sources":["../../src/ui/component.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,8BAA8B;AAC3C,OAAO,EAAE,YAAY,EAAE,wBAAwB;AAE/C,OAAO,EAAE,eAAe,EAAE,+BAAqB;AAG/C;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;AAC5D,CAAC","sourcesContent":["import { is } from '@metamask/superstruct';\nimport { assertStruct } from '@metamask/utils';\n\nimport { ComponentStruct } from './components';\nimport type { Component } from './components';\n\n/**\n * Check if the given value is a {@link Component}. This performs recursive\n * validation of the component's children (if any).\n *\n * @param value - The value to check.\n * @returns `true` if the value is a {@link Component}, `false` otherwise.\n */\nexport function isComponent(value: unknown): value is Component {\n  return is(value, ComponentStruct);\n}\n\n/**\n * Assert that the given value is a {@link Component}. This performs recursive\n * validation of the component's children (if any).\n *\n * @param value - The value to check.\n * @throws If the value is not a {@link Component}.\n */\nexport function assertIsComponent(value: unknown): asserts value is Component {\n  assertStruct(value, ComponentStruct, 'Invalid component');\n}\n"]}