@metamask/snaps-sdk 1.3.2 → 2.0.0

package/dist/types/ui/components/input.d.ts

@@ -0,0 +1,69 @@
+import type { Infer } from 'superstruct';
+import { NodeType } from '../nodes';
+/**
+ * This replicates the available input types from the metamask extension.
+ * https://github.com/MetaMask/metamask-extension/develop/ui/components/component-library/input/input.constants.js
+ */
+export declare enum InputType {
+    Text = "text",
+    Number = "number",
+    Password = "password"
+}
+export declare const InputStruct: import("superstruct").Struct<{
+    type: NodeType.Input;
+    name: string;
+    value?: string | undefined;
+    label?: string | undefined;
+    inputType?: "number" | "text" | "password" | undefined;
+    placeholder?: string | undefined;
+}, {
+    type: import("superstruct").Struct<NodeType.Input, NodeType.Input>;
+    value: import("superstruct").Struct<string | undefined, null>;
+    name: import("superstruct").Struct<string, null>;
+    inputType: import("superstruct").Struct<"number" | "text" | "password" | undefined, null>;
+    placeholder: import("superstruct").Struct<string | undefined, null>;
+    label: import("superstruct").Struct<string | undefined, null>;
+}>;
+/**
+ * An input node, that renders an input.
+ *
+ * @property type - The type of the node, must be the string 'input'.
+ * @property name - The name for the input.
+ * @property value - The value of the input.
+ * @property inputType - An optional type, either `text`, `password` or `number`.
+ * @property placeholder - An optional input placeholder.
+ * @property label - An optional input label.
+ */
+export declare type Input = Infer<typeof InputStruct>;
+/**
+ * Create a {@link Input} node.
+ *
+ * @param args - The node arguments. This can either be a name and an optional variant, value and placeholder or an object
+ * with the properties: `inputType`, `value`, `variant`, `placeholder` and `name`.
+ * @param args.name - The name for the input.
+ * @param args.value - The value of the input.
+ * @param args.inputType - An optional type, either `text`, `password` or `number`.
+ * @param args.placeholder - An optional input placeholder.
+ * @param args.label - An optional input label.
+ * @returns The input node as an object.
+ * @example
+ * const node = input('myInput');
+ * const node = input('myInput', InputType.Text, 'my placeholder', 'myValue', 'myLabel');
+ * const node = input({ name: 'myInput' });
+ * const node = input({name: 'myInput', value: 'myValue', inputType: InputType.Password, placeholder: 'placeholder'})
+ */
+export declare const input: (...args: (string | undefined)[] | [Omit<{
+    type: NodeType.Input;
+    name: string;
+    value?: string | undefined;
+    label?: string | undefined;
+    inputType?: "number" | "text" | "password" | undefined;
+    placeholder?: string | undefined;
+}, "type">]) => {
+    type: NodeType.Input;
+    name: string;
+    value?: string | undefined;
+    label?: string | undefined;
+    inputType?: "number" | "text" | "password" | undefined;
+    placeholder?: string | undefined;
+};

package/dist/types/ui/components/panel.d.ts

@@ -41,6 +41,36 @@ export declare const ParentStruct: Struct<{
         type: NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: NodeType.Form;
+        name: string;
+        children: ({
+            type: NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     })[];
 }, {
     children: Struct<({
@@ -79,6 +109,36 @@ export declare const ParentStruct: Struct<{
         type: NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: NodeType.Form;
+        name: string;
+        children: ({
+            type: NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     })[], Struct<{
         value: string;
         type: NodeType.Copyable;
@@ -115,6 +175,36 @@ export declare const ParentStruct: Struct<{
         type: NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: NodeType.Form;
+        name: string;
+        children: ({
+            type: NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     }, null>>;
     type: Struct<string, null>;
 }>;
@@ -199,6 +289,36 @@ export declare const panel: (...args: [Omit<Panel, "type">] | ({
     type: NodeType.Row;
     label: string;
     variant?: "default" | "warning" | "critical" | undefined;
+} | {
+    type: NodeType.Input;
+    name: string;
+    value?: string | undefined;
+    label?: string | undefined;
+    inputType?: "number" | "text" | "password" | undefined;
+    placeholder?: string | undefined;
+} | {
+    value: string;
+    type: NodeType.Button;
+    name?: string | undefined;
+    variant?: "primary" | "secondary" | undefined;
+    buttonType?: "button" | "submit" | undefined;
+} | {
+    type: NodeType.Form;
+    name: string;
+    children: ({
+        type: NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    })[];
 })[][]) => Panel;
 export declare const ComponentStruct: Struct<{
     value: string;
@@ -236,6 +356,36 @@ export declare const ComponentStruct: Struct<{
     type: NodeType.Row;
     label: string;
     variant?: "default" | "warning" | "critical" | undefined;
+} | {
+    type: NodeType.Input;
+    name: string;
+    value?: string | undefined;
+    label?: string | undefined;
+    inputType?: "number" | "text" | "password" | undefined;
+    placeholder?: string | undefined;
+} | {
+    value: string;
+    type: NodeType.Button;
+    name?: string | undefined;
+    variant?: "primary" | "secondary" | undefined;
+    buttonType?: "button" | "submit" | undefined;
+} | {
+    type: NodeType.Form;
+    name: string;
+    children: ({
+        type: NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    })[];
 }, null>;
 /**
  * All supported component types.

package/dist/types/ui/nodes.d.ts

@@ -13,7 +13,10 @@ export declare enum NodeType {
     Text = "text",
     Image = "image",
     Row = "row",
-    Address = "address"
+    Address = "address",
+    Button = "button",
+    Input = "input",
+    Form = "form"
 }
 /**
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-sdk",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -38,12 +38,12 @@
     "@metamask/key-tree": "^9.0.0",
     "@metamask/providers": "^14.0.2",
     "@metamask/rpc-errors": "^6.1.0",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/utils": "^8.3.0",
     "is-svg": "^4.4.0",
     "superstruct": "^1.0.3"
   },
   "devDependencies": {
-    "@lavamoat/allow-scripts": "^2.5.1",
+    "@lavamoat/allow-scripts": "^3.0.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",