@metamask/snaps-sdk 6.2.1 → 6.4.0

package/dist/ui/components/row.d.mts

@@ -0,0 +1,107 @@
+import type { Infer } from "@metamask/superstruct";
+import { NodeType } from "../nodes.mjs";
+export declare enum RowVariant {
+    Default = "default",
+    Critical = "critical",
+    Warning = "warning"
+}
+export declare const RowStruct: import("@metamask/superstruct").Struct<{
+    type: NodeType.Row;
+    value: {
+        type: NodeType.Image;
+        value: string;
+    } | {
+        type: NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: NodeType.Address;
+        value: `0x${string}`;
+    };
+    label: string;
+    variant?: "default" | "warning" | "critical" | undefined;
+}, {
+    type: import("@metamask/superstruct").Struct<NodeType.Row, NodeType.Row>;
+    variant: import("@metamask/superstruct").Struct<"default" | "warning" | "critical" | undefined, null>;
+    label: import("@metamask/superstruct").Struct<string, null>;
+    value: import("@metamask/superstruct").Struct<{
+        type: NodeType.Image;
+        value: string;
+    } | {
+        type: NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: NodeType.Address;
+        value: `0x${string}`;
+    }, null>;
+}>;
+/**
+ * A row node, that renders a row with a label and a value.
+ *
+ * @property type - The type of the node. Must be the string `row`.
+ * @property label - The label for the row.
+ * @property value - A sub component to be rendered
+ * on one side of the row.
+ * @property variant - Optional variant for styling.
+ */
+export type Row = Infer<typeof RowStruct>;
+/**
+ * Create a {@link Row} node.
+ *
+ * @param args - The node arguments. This can either be a string, a component and an optional variant or an object
+ * with the properties: `label`, `value` and `variant`.
+ * @param args.label - The label for the row.
+ * @param args.value - Another component, is currently limited to `image`, `text` and `address`.
+ * @param args.variant - An optional variant, either `default`, `warning` or `critical`.
+ * @returns The row node as an object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = row({ label: 'Address', value: address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520') });
+ * const node = row({ label: 'Address', value: address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'), variant: RowVariant.Warning });
+ * const node = row('Address', address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'));
+ * const node = row('Address', address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'), RowVariant.Warning);
+ */
+export declare const row: (...args: [Omit<{
+    type: NodeType.Row;
+    value: {
+        type: NodeType.Image;
+        value: string;
+    } | {
+        type: NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: NodeType.Address;
+        value: `0x${string}`;
+    };
+    label: string;
+    variant?: "default" | "warning" | "critical" | undefined;
+}, "type">] | (string | {
+    type: NodeType.Image;
+    value: string;
+} | {
+    type: NodeType.Text;
+    value: string;
+    markdown?: boolean | undefined;
+} | {
+    type: NodeType.Address;
+    value: `0x${string}`;
+} | undefined)[]) => {
+    type: NodeType.Row;
+    value: {
+        type: NodeType.Image;
+        value: string;
+    } | {
+        type: NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: NodeType.Address;
+        value: `0x${string}`;
+    };
+    label: string;
+    variant?: "default" | "warning" | "critical" | undefined;
+};
+//# sourceMappingURL=row.d.mts.map

package/dist/ui/components/row.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"row.d.mts","sourceRoot":"","sources":["../../../src/ui/components/row.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAYnD,OAAO,EAAiB,QAAQ,EAAE,qBAAiB;AAKnD,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAKD,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcrB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAId,CAAC"}

package/dist/ui/components/row.mjs

@@ -0,0 +1,48 @@
+import { assign, literal, object, string, optional, union } from "@metamask/superstruct";
+import { enumValue } from "../../internals/index.mjs";
+import { createBuilder } from "../builder.mjs";
+import { LiteralStruct, NodeType } from "../nodes.mjs";
+import { AddressStruct } from "./address.mjs";
+import { ImageStruct } from "./image.mjs";
+import { TextStruct } from "./text.mjs";
+export var RowVariant;
+(function (RowVariant) {
+    RowVariant["Default"] = "default";
+    RowVariant["Critical"] = "critical";
+    RowVariant["Warning"] = "warning";
+})(RowVariant || (RowVariant = {}));
+// A subset of components made available to the row
+const RowComponentStruct = union([ImageStruct, TextStruct, AddressStruct]);
+export const RowStruct = assign(LiteralStruct, object({
+    type: literal(NodeType.Row),
+    variant: optional(union([
+        enumValue(RowVariant.Default),
+        enumValue(RowVariant.Critical),
+        enumValue(RowVariant.Warning),
+    ])),
+    label: string(),
+    value: RowComponentStruct,
+}));
+/**
+ * Create a {@link Row} node.
+ *
+ * @param args - The node arguments. This can either be a string, a component and an optional variant or an object
+ * with the properties: `label`, `value` and `variant`.
+ * @param args.label - The label for the row.
+ * @param args.value - Another component, is currently limited to `image`, `text` and `address`.
+ * @param args.variant - An optional variant, either `default`, `warning` or `critical`.
+ * @returns The row node as an object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = row({ label: 'Address', value: address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520') });
+ * const node = row({ label: 'Address', value: address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'), variant: RowVariant.Warning });
+ * const node = row('Address', address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'));
+ * const node = row('Address', address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'), RowVariant.Warning);
+ */
+export const row = createBuilder(NodeType.Row, RowStruct, [
+    'label',
+    'value',
+    'variant',
+]);
+//# sourceMappingURL=row.mjs.map

package/dist/ui/components/row.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"row.mjs","sourceRoot":"","sources":["../../../src/ui/components/row.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,EACN,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,KAAK,EACN,8BAA8B;AAE/B,OAAO,EAAE,SAAS,EAAE,kCAAwB;AAC5C,OAAO,EAAE,aAAa,EAAE,uBAAmB;AAC3C,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,qBAAiB;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAC1C,OAAO,EAAE,WAAW,EAAE,oBAAgB;AACtC,OAAO,EAAE,UAAU,EAAE,mBAAe;AAEpC,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;AACrB,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAED,mDAAmD;AACnD,MAAM,kBAAkB,GAAG,KAAK,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;AAE3E,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAC7B,aAAa,EACb,MAAM,CAAC;IACL,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC3B,OAAO,EAAE,QAAQ,CACf,KAAK,CAAC;QACJ,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;QAC7B,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC;QAC9B,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;KAC9B,CAAC,CACH;IACD,KAAK,EAAE,MAAM,EAAE;IACf,KAAK,EAAE,kBAAkB;CAC1B,CAAC,CACH,CAAC;AAaF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,EAAE;IACxD,OAAO;IACP,OAAO;IACP,SAAS;CACV,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  assign,\n  literal,\n  object,\n  string,\n  optional,\n  union,\n} from '@metamask/superstruct';\n\nimport { enumValue } from '../../internals';\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\nimport { AddressStruct } from './address';\nimport { ImageStruct } from './image';\nimport { TextStruct } from './text';\n\nexport enum RowVariant {\n  Default = 'default',\n  Critical = 'critical',\n  Warning = 'warning',\n}\n\n// A subset of components made available to the row\nconst RowComponentStruct = union([ImageStruct, TextStruct, AddressStruct]);\n\nexport const RowStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Row),\n    variant: optional(\n      union([\n        enumValue(RowVariant.Default),\n        enumValue(RowVariant.Critical),\n        enumValue(RowVariant.Warning),\n      ]),\n    ),\n    label: string(),\n    value: RowComponentStruct,\n  }),\n);\n\n/**\n * A row node, that renders a row with a label and a value.\n *\n * @property type - The type of the node. Must be the string `row`.\n * @property label - The label for the row.\n * @property value - A sub component to be rendered\n * on one side of the row.\n * @property variant - Optional variant for styling.\n */\nexport type Row = Infer<typeof RowStruct>;\n\n/**\n * Create a {@link Row} node.\n *\n * @param args - The node arguments. This can either be a string, a component and an optional variant or an object\n * with the properties: `label`, `value` and `variant`.\n * @param args.label - The label for the row.\n * @param args.value - Another component, is currently limited to `image`, `text` and `address`.\n * @param args.variant - An optional variant, either `default`, `warning` or `critical`.\n * @returns The row node as an object.\n * @deprecated Snaps component functions are deprecated, in favor of the new JSX\n * components. This function will be removed in a future release.\n * @example\n * const node = row({ label: 'Address', value: address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520') });\n * const node = row({ label: 'Address', value: address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'), variant: RowVariant.Warning });\n * const node = row('Address', address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'));\n * const node = row('Address', address('0x4bbeeb066ed09b7aed07bf39eee0460dfa261520'), RowVariant.Warning);\n */\nexport const row = createBuilder(NodeType.Row, RowStruct, [\n  'label',\n  'value',\n  'variant',\n]);\n"]}

package/dist/ui/components/spinner.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spinner = exports.SpinnerStruct = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const builder_1 = require("../builder.cjs");
+const nodes_1 = require("../nodes.cjs");
+exports.SpinnerStruct = (0, superstruct_1.assign)(nodes_1.NodeStruct, (0, superstruct_1.object)({
+    type: (0, superstruct_1.literal)(nodes_1.NodeType.Spinner),
+}));
+/**
+ * Create a {@link Spinner} node.
+ *
+ * @returns The spinner node as object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = spinner();
+ */
+exports.spinner = (0, builder_1.createBuilder)(nodes_1.NodeType.Spinner, exports.SpinnerStruct);
+//# sourceMappingURL=spinner.cjs.map

package/dist/ui/components/spinner.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.cjs","sourceRoot":"","sources":["../../../src/ui/components/spinner.ts"],"names":[],"mappings":";;;AACA,uDAAgE;AAEhE,4CAA2C;AAC3C,wCAAgD;AAEnC,QAAA,aAAa,GAAG,IAAA,oBAAM,EACjC,kBAAU,EACV,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,IAAA,qBAAO,EAAC,gBAAQ,CAAC,OAAO,CAAC;CAChC,CAAC,CACH,CAAC;AAQF;;;;;;;;GAQG;AACU,QAAA,OAAO,GAAG,IAAA,uBAAa,EAAC,gBAAQ,CAAC,OAAO,EAAE,qBAAa,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { assign, literal, object } from '@metamask/superstruct';\n\nimport { createBuilder } from '../builder';\nimport { NodeStruct, NodeType } from '../nodes';\n\nexport const SpinnerStruct = assign(\n  NodeStruct,\n  object({\n    type: literal(NodeType.Spinner),\n  }),\n);\n\n/**\n * A spinner node, that renders a spinner, either as a full-screen overlay, or\n * inline when nested inside a {@link Panel}.\n */\nexport type Spinner = Infer<typeof SpinnerStruct>;\n\n/**\n * Create a {@link Spinner} node.\n *\n * @returns The spinner node as object.\n * @deprecated Snaps component functions are deprecated, in favor of the new JSX\n * components. This function will be removed in a future release.\n * @example\n * const node = spinner();\n */\nexport const spinner = createBuilder(NodeType.Spinner, SpinnerStruct);\n"]}

package/dist/{types/ui/components/spinner.d.ts → ui/components/spinner.d.cts}

@@ -1,5 +1,5 @@
-import type { Infer } from '@metamask/superstruct';
-import { NodeType } from '../nodes';
+import type { Infer } from "@metamask/superstruct";
+import { NodeType } from "../nodes.cjs";
 export declare const SpinnerStruct: import("@metamask/superstruct").Struct<{
     type: NodeType.Spinner;
 }, {
@@ -22,3 +22,4 @@ export type Spinner = Infer<typeof SpinnerStruct>;
 export declare const spinner: () => {
     type: NodeType.Spinner;
 };
+//# sourceMappingURL=spinner.d.cts.map

package/dist/ui/components/spinner.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.d.cts","sourceRoot":"","sources":["../../../src/ui/components/spinner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,EAAc,QAAQ,EAAE,qBAAiB;AAEhD,eAAO,MAAM,aAAa;;;;EAKzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO;;CAAiD,CAAC"}

package/dist/ui/components/spinner.d.mts

@@ -0,0 +1,25 @@
+import type { Infer } from "@metamask/superstruct";
+import { NodeType } from "../nodes.mjs";
+export declare const SpinnerStruct: import("@metamask/superstruct").Struct<{
+    type: NodeType.Spinner;
+}, {
+    type: import("@metamask/superstruct").Struct<NodeType.Spinner, NodeType.Spinner>;
+}>;
+/**
+ * A spinner node, that renders a spinner, either as a full-screen overlay, or
+ * inline when nested inside a {@link Panel}.
+ */
+export type Spinner = Infer<typeof SpinnerStruct>;
+/**
+ * Create a {@link Spinner} node.
+ *
+ * @returns The spinner node as object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = spinner();
+ */
+export declare const spinner: () => {
+    type: NodeType.Spinner;
+};
+//# sourceMappingURL=spinner.d.mts.map

package/dist/ui/components/spinner.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.d.mts","sourceRoot":"","sources":["../../../src/ui/components/spinner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,EAAc,QAAQ,EAAE,qBAAiB;AAEhD,eAAO,MAAM,aAAa;;;;EAKzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO;;CAAiD,CAAC"}

package/dist/ui/components/spinner.mjs

@@ -0,0 +1,17 @@
+import { assign, literal, object } from "@metamask/superstruct";
+import { createBuilder } from "../builder.mjs";
+import { NodeStruct, NodeType } from "../nodes.mjs";
+export const SpinnerStruct = assign(NodeStruct, object({
+    type: literal(NodeType.Spinner),
+}));
+/**
+ * Create a {@link Spinner} node.
+ *
+ * @returns The spinner node as object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = spinner();
+ */
+export const spinner = createBuilder(NodeType.Spinner, SpinnerStruct);
+//# sourceMappingURL=spinner.mjs.map

package/dist/ui/components/spinner.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.mjs","sourceRoot":"","sources":["../../../src/ui/components/spinner.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAEhE,OAAO,EAAE,aAAa,EAAE,uBAAmB;AAC3C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,qBAAiB;AAEhD,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CACjC,UAAU,EACV,MAAM,CAAC;IACL,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;CAChC,CAAC,CACH,CAAC;AAQF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { assign, literal, object } from '@metamask/superstruct';\n\nimport { createBuilder } from '../builder';\nimport { NodeStruct, NodeType } from '../nodes';\n\nexport const SpinnerStruct = assign(\n  NodeStruct,\n  object({\n    type: literal(NodeType.Spinner),\n  }),\n);\n\n/**\n * A spinner node, that renders a spinner, either as a full-screen overlay, or\n * inline when nested inside a {@link Panel}.\n */\nexport type Spinner = Infer<typeof SpinnerStruct>;\n\n/**\n * Create a {@link Spinner} node.\n *\n * @returns The spinner node as object.\n * @deprecated Snaps component functions are deprecated, in favor of the new JSX\n * components. This function will be removed in a future release.\n * @example\n * const node = spinner();\n */\nexport const spinner = createBuilder(NodeType.Spinner, SpinnerStruct);\n"]}

package/dist/ui/components/text.cjs

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.text = exports.TextStruct = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const builder_1 = require("../builder.cjs");
+const nodes_1 = require("../nodes.cjs");
+exports.TextStruct = (0, superstruct_1.assign)(nodes_1.LiteralStruct, (0, superstruct_1.object)({
+    type: (0, superstruct_1.literal)(nodes_1.NodeType.Text),
+    value: (0, superstruct_1.string)(),
+    markdown: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+}));
+/**
+ * Create a {@link Text} node.
+ *
+ * @param args - The node arguments. This can be either a string
+ * and a boolean, or an object with a `value` property
+ * and an optional `markdown` property.
+ * @param args.value - The text content of the node.
+ * @param args.markdown - An optional flag to enable or disable markdown. This
+ * is enabled by default.
+ * @returns The text node as object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = text({ value: 'Hello, world!' });
+ * const node = text('Hello, world!');
+ * const node = text({ value: 'Hello, world!', markdown: false });
+ * const node = text('Hello, world!', false);
+ */
+exports.text = (0, builder_1.createBuilder)(nodes_1.NodeType.Text, exports.TextStruct, [
+    'value',
+    'markdown',
+]);
+//# sourceMappingURL=text.cjs.map

package/dist/ui/components/text.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.cjs","sourceRoot":"","sources":["../../../src/ui/components/text.ts"],"names":[],"mappings":";;;AACA,uDAO+B;AAE/B,4CAA2C;AAC3C,wCAAmD;AAEtC,QAAA,UAAU,GAAG,IAAA,oBAAM,EAC9B,qBAAa,EACb,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,IAAA,qBAAO,EAAC,gBAAQ,CAAC,IAAI,CAAC;IAC5B,KAAK,EAAE,IAAA,oBAAM,GAAE;IACf,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC9B,CAAC,CACH,CAAC;AAaF;;;;;;;;;;;;;;;;;GAiBG;AACU,QAAA,IAAI,GAAG,IAAA,uBAAa,EAAC,gBAAQ,CAAC,IAAI,EAAE,kBAAU,EAAE;IAC3D,OAAO;IACP,UAAU;CACX,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  assign,\n  boolean,\n  literal,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\n\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\n\nexport const TextStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Text),\n    value: string(),\n    markdown: optional(boolean()),\n  }),\n);\n\n/**\n * A text node, that renders the text as one or more paragraphs.\n *\n * @property type - The type of the node, must be the string 'text'.\n * @property value - The text content of the node, either as plain text, or as a\n * markdown string.\n * @property markdown - A flag to enable/disable markdown, if nothing is specified\n * markdown will be enabled.\n */\nexport type Text = Infer<typeof TextStruct>;\n\n/**\n * Create a {@link Text} node.\n *\n * @param args - The node arguments. This can be either a string\n * and a boolean, or an object with a `value` property\n * and an optional `markdown` property.\n * @param args.value - The text content of the node.\n * @param args.markdown - An optional flag to enable or disable markdown. This\n * is enabled by default.\n * @returns The text node as object.\n * @deprecated Snaps component functions are deprecated, in favor of the new JSX\n * components. This function will be removed in a future release.\n * @example\n * const node = text({ value: 'Hello, world!' });\n * const node = text('Hello, world!');\n * const node = text({ value: 'Hello, world!', markdown: false });\n * const node = text('Hello, world!', false);\n */\nexport const text = createBuilder(NodeType.Text, TextStruct, [\n  'value',\n  'markdown',\n]);\n"]}

package/dist/{types/ui/components/text.d.ts → ui/components/text.d.cts}

@@ -1,8 +1,8 @@
-import type { Infer } from '@metamask/superstruct';
-import { NodeType } from '../nodes';
+import type { Infer } from "@metamask/superstruct";
+import { NodeType } from "../nodes.cjs";
 export declare const TextStruct: import("@metamask/superstruct").Struct<{
-    value: string;
     type: NodeType.Text;
+    value: string;
     markdown?: boolean | undefined;
 }, {
     type: import("@metamask/superstruct").Struct<NodeType.Text, NodeType.Text>;
@@ -38,11 +38,12 @@ export type Text = Infer<typeof TextStruct>;
  * const node = text('Hello, world!', false);
  */
 export declare const text: (...args: (string | boolean | undefined)[] | [Omit<{
-    value: string;
     type: NodeType.Text;
+    value: string;
     markdown?: boolean | undefined;
 }, "type">]) => {
-    value: string;
     type: NodeType.Text;
+    value: string;
     markdown?: boolean | undefined;
 };
+//# sourceMappingURL=text.d.cts.map

package/dist/ui/components/text.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.cts","sourceRoot":"","sources":["../../../src/ui/components/text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD,OAAO,EAAiB,QAAQ,EAAE,qBAAiB;AAEnD,eAAO,MAAM,UAAU;;;;;;;;EAOtB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI;;;;;;;;CAGf,CAAC"}

package/dist/ui/components/text.d.mts

@@ -0,0 +1,49 @@
+import type { Infer } from "@metamask/superstruct";
+import { NodeType } from "../nodes.mjs";
+export declare const TextStruct: import("@metamask/superstruct").Struct<{
+    type: NodeType.Text;
+    value: string;
+    markdown?: boolean | undefined;
+}, {
+    type: import("@metamask/superstruct").Struct<NodeType.Text, NodeType.Text>;
+    value: import("@metamask/superstruct").Struct<string, null>;
+    markdown: import("@metamask/superstruct").Struct<boolean | undefined, null>;
+}>;
+/**
+ * A text node, that renders the text as one or more paragraphs.
+ *
+ * @property type - The type of the node, must be the string 'text'.
+ * @property value - The text content of the node, either as plain text, or as a
+ * markdown string.
+ * @property markdown - A flag to enable/disable markdown, if nothing is specified
+ * markdown will be enabled.
+ */
+export type Text = Infer<typeof TextStruct>;
+/**
+ * Create a {@link Text} node.
+ *
+ * @param args - The node arguments. This can be either a string
+ * and a boolean, or an object with a `value` property
+ * and an optional `markdown` property.
+ * @param args.value - The text content of the node.
+ * @param args.markdown - An optional flag to enable or disable markdown. This
+ * is enabled by default.
+ * @returns The text node as object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = text({ value: 'Hello, world!' });
+ * const node = text('Hello, world!');
+ * const node = text({ value: 'Hello, world!', markdown: false });
+ * const node = text('Hello, world!', false);
+ */
+export declare const text: (...args: (string | boolean | undefined)[] | [Omit<{
+    type: NodeType.Text;
+    value: string;
+    markdown?: boolean | undefined;
+}, "type">]) => {
+    type: NodeType.Text;
+    value: string;
+    markdown?: boolean | undefined;
+};
+//# sourceMappingURL=text.d.mts.map

package/dist/ui/components/text.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.mts","sourceRoot":"","sources":["../../../src/ui/components/text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD,OAAO,EAAiB,QAAQ,EAAE,qBAAiB;AAEnD,eAAO,MAAM,UAAU;;;;;;;;EAOtB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI;;;;;;;;CAGf,CAAC"}

package/dist/ui/components/text.mjs

@@ -0,0 +1,31 @@
+import { assign, boolean, literal, object, optional, string } from "@metamask/superstruct";
+import { createBuilder } from "../builder.mjs";
+import { LiteralStruct, NodeType } from "../nodes.mjs";
+export const TextStruct = assign(LiteralStruct, object({
+    type: literal(NodeType.Text),
+    value: string(),
+    markdown: optional(boolean()),
+}));
+/**
+ * Create a {@link Text} node.
+ *
+ * @param args - The node arguments. This can be either a string
+ * and a boolean, or an object with a `value` property
+ * and an optional `markdown` property.
+ * @param args.value - The text content of the node.
+ * @param args.markdown - An optional flag to enable or disable markdown. This
+ * is enabled by default.
+ * @returns The text node as object.
+ * @deprecated Snaps component functions are deprecated, in favor of the new JSX
+ * components. This function will be removed in a future release.
+ * @example
+ * const node = text({ value: 'Hello, world!' });
+ * const node = text('Hello, world!');
+ * const node = text({ value: 'Hello, world!', markdown: false });
+ * const node = text('Hello, world!', false);
+ */
+export const text = createBuilder(NodeType.Text, TextStruct, [
+    'value',
+    'markdown',
+]);
+//# sourceMappingURL=text.mjs.map

package/dist/ui/components/text.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.mjs","sourceRoot":"","sources":["../../../src/ui/components/text.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,EACN,OAAO,EACP,OAAO,EACP,MAAM,EACN,QAAQ,EACR,MAAM,EACP,8BAA8B;AAE/B,OAAO,EAAE,aAAa,EAAE,uBAAmB;AAC3C,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,qBAAiB;AAEnD,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAC9B,aAAa,EACb,MAAM,CAAC;IACL,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,KAAK,EAAE,MAAM,EAAE;IACf,QAAQ,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC9B,CAAC,CACH,CAAC;AAaF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE;IAC3D,OAAO;IACP,UAAU;CACX,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  assign,\n  boolean,\n  literal,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\n\nimport { createBuilder } from '../builder';\nimport { LiteralStruct, NodeType } from '../nodes';\n\nexport const TextStruct = assign(\n  LiteralStruct,\n  object({\n    type: literal(NodeType.Text),\n    value: string(),\n    markdown: optional(boolean()),\n  }),\n);\n\n/**\n * A text node, that renders the text as one or more paragraphs.\n *\n * @property type - The type of the node, must be the string 'text'.\n * @property value - The text content of the node, either as plain text, or as a\n * markdown string.\n * @property markdown - A flag to enable/disable markdown, if nothing is specified\n * markdown will be enabled.\n */\nexport type Text = Infer<typeof TextStruct>;\n\n/**\n * Create a {@link Text} node.\n *\n * @param args - The node arguments. This can be either a string\n * and a boolean, or an object with a `value` property\n * and an optional `markdown` property.\n * @param args.value - The text content of the node.\n * @param args.markdown - An optional flag to enable or disable markdown. This\n * is enabled by default.\n * @returns The text node as object.\n * @deprecated Snaps component functions are deprecated, in favor of the new JSX\n * components. This function will be removed in a future release.\n * @example\n * const node = text({ value: 'Hello, world!' });\n * const node = text('Hello, world!');\n * const node = text({ value: 'Hello, world!', markdown: false });\n * const node = text('Hello, world!', false);\n */\nexport const text = createBuilder(NodeType.Text, TextStruct, [\n  'value',\n  'markdown',\n]);\n"]}

package/dist/ui/index.cjs

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeType = void 0;
+__exportStar(require("./components/index.cjs"), exports);
+__exportStar(require("./component.cjs"), exports);
+var nodes_1 = require("./nodes.cjs");
+Object.defineProperty(exports, "NodeType", { enumerable: true, get: function () { return nodes_1.NodeType; } });
+//# sourceMappingURL=index.cjs.map

package/dist/ui/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yDAA6B;AAC7B,kDAA4B;AAC5B,qCAAmC;AAA1B,iGAAA,QAAQ,OAAA","sourcesContent":["export * from './components';\nexport * from './component';\nexport { NodeType } from './nodes';\n"]}

package/dist/ui/index.d.cts

@@ -0,0 +1,4 @@
+export * from "./components/index.cjs";
+export * from "./component.cjs";
+export { NodeType } from "./nodes.cjs";
+//# sourceMappingURL=index.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AAAA,uCAA6B;AAC7B,gCAA4B;AAC5B,OAAO,EAAE,QAAQ,EAAE,oBAAgB"}

package/dist/ui/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./components/index.mjs";
+export * from "./component.mjs";
+export { NodeType } from "./nodes.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AAAA,uCAA6B;AAC7B,gCAA4B;AAC5B,OAAO,EAAE,QAAQ,EAAE,oBAAgB"}

package/dist/ui/index.mjs

@@ -0,0 +1,4 @@
+export * from "./components/index.mjs";
+export * from "./component.mjs";
+export { NodeType } from "./nodes.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/ui/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AAAA,uCAA6B;AAC7B,gCAA4B;AAC5B,OAAO,EAAE,QAAQ,EAAE,oBAAgB","sourcesContent":["export * from './components';\nexport * from './component';\nexport { NodeType } from './nodes';\n"]}

package/dist/ui/nodes.cjs

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiteralStruct = exports.NodeStruct = exports.NodeType = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+/**
+ * The supported node types. This is based on SIP-7.
+ *
+ * @see https://metamask.github.io/SIPs/SIPS/sip-7
+ */
+var NodeType;
+(function (NodeType) {
+    NodeType["Copyable"] = "copyable";
+    NodeType["Divider"] = "divider";
+    NodeType["Heading"] = "heading";
+    NodeType["Panel"] = "panel";
+    NodeType["Spinner"] = "spinner";
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    NodeType["Text"] = "text";
+    NodeType["Image"] = "image";
+    NodeType["Row"] = "row";
+    NodeType["Address"] = "address";
+    NodeType["Button"] = "button";
+    NodeType["Input"] = "input";
+    NodeType["Form"] = "form";
+})(NodeType || (exports.NodeType = NodeType = {}));
+/**
+ * @internal
+ */
+exports.NodeStruct = (0, superstruct_1.object)({
+    type: (0, superstruct_1.string)(),
+});
+/**
+ * @internal
+ */
+exports.LiteralStruct = (0, superstruct_1.assign)(exports.NodeStruct, (0, superstruct_1.object)({
+    value: (0, superstruct_1.unknown)(),
+}));
+//# sourceMappingURL=nodes.cjs.map

package/dist/ui/nodes.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.cjs","sourceRoot":"","sources":["../../src/ui/nodes.ts"],"names":[],"mappings":";;;AACA,uDAAwE;AAExE;;;;GAIG;AACH,IAAY,QAcX;AAdD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,+BAAmB,CAAA;IACnB,+BAAmB,CAAA;IACnB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,wDAAwD;IACxD,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,uBAAW,CAAA;IACX,+BAAmB,CAAA;IACnB,6BAAiB,CAAA;IACjB,2BAAe,CAAA;IACf,yBAAa,CAAA;AACf,CAAC,EAdW,QAAQ,wBAAR,QAAQ,QAcnB;AAED;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,oBAAM,EAAC;IAC/B,IAAI,EAAE,IAAA,oBAAM,GAAE;CACf,CAAC,CAAC;AAWH;;GAEG;AACU,QAAA,aAAa,GAAG,IAAA,oBAAM,EACjC,kBAAU,EACV,IAAA,oBAAM,EAAC;IACL,KAAK,EAAE,IAAA,qBAAO,GAAE;CACjB,CAAC,CACH,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { assign, object, string, unknown } from '@metamask/superstruct';\n\n/**\n * The supported node types. This is based on SIP-7.\n *\n * @see https://metamask.github.io/SIPs/SIPS/sip-7\n */\nexport enum NodeType {\n  Copyable = 'copyable',\n  Divider = 'divider',\n  Heading = 'heading',\n  Panel = 'panel',\n  Spinner = 'spinner',\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Text = 'text',\n  Image = 'image',\n  Row = 'row',\n  Address = 'address',\n  Button = 'button',\n  Input = 'input',\n  Form = 'form',\n}\n\n/**\n * @internal\n */\nexport const NodeStruct = object({\n  type: string(),\n});\n\n/**\n * The base node type. All nodes extend this type.\n *\n * @property type - The type of the node. See {@link NodeType} for the supported\n * node types.\n * @internal\n */\nexport type Node = Infer<typeof NodeStruct>;\n\n/**\n * @internal\n */\nexport const LiteralStruct = assign(\n  NodeStruct,\n  object({\n    value: unknown(),\n  }),\n);\n\n/**\n * A node with a value. This is used for nodes that render a value, such as\n * {@link Text}.\n *\n * @property type - The type of the node.\n * @property value - The value of the node. The type of the value depends on the\n * node type.\n * @internal\n */\nexport type Literal = Infer<typeof LiteralStruct>;\n"]}

package/dist/{types/ui/nodes.d.ts → ui/nodes.d.cts}

@@ -1,4 +1,4 @@
-import type { Infer } from '@metamask/superstruct';
+import type { Infer } from "@metamask/superstruct";
 /**
  * The supported node types. This is based on SIP-7.
  *
@@ -38,8 +38,8 @@ export type Node = Infer<typeof NodeStruct>;
  * @internal
  */
 export declare const LiteralStruct: import("@metamask/superstruct").Struct<{
-    value: unknown;
     type: string;
+    value: unknown;
 }, {
     value: import("@metamask/superstruct").Struct<unknown, null>;
     type: import("@metamask/superstruct").Struct<string, null>;
@@ -54,3 +54,4 @@ export declare const LiteralStruct: import("@metamask/superstruct").Struct<{
  * @internal
  */
 export type Literal = Infer<typeof LiteralStruct>;
+//# sourceMappingURL=nodes.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.d.cts","sourceRoot":"","sources":["../../src/ui/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAGnD;;;;GAIG;AACH,oBAAY,QAAQ;IAClB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,OAAO,YAAY;IAEnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED;;GAEG;AACH,eAAO,MAAM,UAAU;;;;EAErB,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;EAKzB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/dist/ui/nodes.d.mts

@@ -0,0 +1,57 @@
+import type { Infer } from "@metamask/superstruct";
+/**
+ * The supported node types. This is based on SIP-7.
+ *
+ * @see https://metamask.github.io/SIPs/SIPS/sip-7
+ */
+export declare enum NodeType {
+    Copyable = "copyable",
+    Divider = "divider",
+    Heading = "heading",
+    Panel = "panel",
+    Spinner = "spinner",
+    Text = "text",
+    Image = "image",
+    Row = "row",
+    Address = "address",
+    Button = "button",
+    Input = "input",
+    Form = "form"
+}
+/**
+ * @internal
+ */
+export declare const NodeStruct: import("@metamask/superstruct").Struct<{
+    type: string;
+}, {
+    type: import("@metamask/superstruct").Struct<string, null>;
+}>;
+/**
+ * The base node type. All nodes extend this type.
+ *
+ * @property type - The type of the node. See {@link NodeType} for the supported
+ * node types.
+ * @internal
+ */
+export type Node = Infer<typeof NodeStruct>;
+/**
+ * @internal
+ */
+export declare const LiteralStruct: import("@metamask/superstruct").Struct<{
+    type: string;
+    value: unknown;
+}, {
+    value: import("@metamask/superstruct").Struct<unknown, null>;
+    type: import("@metamask/superstruct").Struct<string, null>;
+}>;
+/**
+ * A node with a value. This is used for nodes that render a value, such as
+ * {@link Text}.
+ *
+ * @property type - The type of the node.
+ * @property value - The value of the node. The type of the value depends on the
+ * node type.
+ * @internal
+ */
+export type Literal = Infer<typeof LiteralStruct>;
+//# sourceMappingURL=nodes.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.d.mts","sourceRoot":"","sources":["../../src/ui/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAGnD;;;;GAIG;AACH,oBAAY,QAAQ;IAClB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,OAAO,YAAY;IAEnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED;;GAEG;AACH,eAAO,MAAM,UAAU;;;;EAErB,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;EAKzB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}