@metamask/snaps-sdk 4.0.1 → 4.2.0

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

@@ -5,39 +5,7 @@ import { NodeType } from '../nodes';
  */
 export declare const ParentStruct: Struct<{
     type: string;
-    children: (Panel | {
-        type: NodeType.Input;
-        name: string;
-        value?: string | undefined;
-        error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
-        placeholder?: string | undefined;
-        label?: 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;
-            error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
-            placeholder?: string | undefined;
-            label?: string | undefined;
-        } | {
-            value: string;
-            type: NodeType.Button;
-            name?: string | undefined;
-            variant?: "primary" | "secondary" | undefined;
-            buttonType?: "button" | "submit" | undefined;
-        })[];
-    } | {
+    children: ({
         value: string;
         type: NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -49,7 +17,7 @@ export declare const ParentStruct: Struct<{
     } | {
         value: string;
         type: NodeType.Image;
-    } | {
+    } | Panel | {
         type: NodeType.Spinner;
     } | {
         value: string;
@@ -73,16 +41,14 @@ export declare const ParentStruct: Struct<{
         type: NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    })[];
-}, {
-    children: Struct<(Panel | {
+    } | {
         type: NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: NodeType.Button;
@@ -97,9 +63,9 @@ export declare const ParentStruct: Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: NodeType.Button;
@@ -107,7 +73,9 @@ export declare const ParentStruct: Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    })[];
+}, {
+    children: Struct<({
         value: string;
         type: NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -119,7 +87,7 @@ export declare const ParentStruct: Struct<{
     } | {
         value: string;
         type: NodeType.Image;
-    } | {
+    } | Panel | {
         type: NodeType.Spinner;
     } | {
         value: string;
@@ -143,14 +111,14 @@ export declare const ParentStruct: Struct<{
         type: NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    })[], Struct<Panel | {
+    } | {
         type: NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: NodeType.Button;
@@ -165,9 +133,9 @@ export declare const ParentStruct: Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: NodeType.Button;
@@ -175,7 +143,7 @@ export declare const ParentStruct: Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    })[], Struct<{
         value: string;
         type: NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -187,7 +155,7 @@ export declare const ParentStruct: Struct<{
     } | {
         value: string;
         type: NodeType.Image;
-    } | {
+    } | Panel | {
         type: NodeType.Spinner;
     } | {
         value: string;
@@ -211,6 +179,38 @@ export declare const ParentStruct: Struct<{
         type: NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        error?: string | undefined;
+        placeholder?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | 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;
+            error?: string | undefined;
+            placeholder?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+        } | {
+            value: string;
+            type: NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     }, null>>;
     type: Struct<string, null>;
 }>;
@@ -246,6 +246,8 @@ export declare type Panel = {
  * @param args.children - The child nodes of the panel. This can be any valid
  * {@link Component}.
  * @returns The panel 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 = panel({
  *  children: [
@@ -259,39 +261,7 @@ export declare type Panel = {
  *   text('This is a panel.'),
  * ]);
  */
-export declare const panel: (...args: [Omit<Panel, "type">] | (Panel | {
-    type: NodeType.Input;
-    name: string;
-    value?: string | undefined;
-    error?: string | undefined;
-    inputType?: "number" | "text" | "password" | undefined;
-    placeholder?: string | undefined;
-    label?: 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;
-        error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
-        placeholder?: string | undefined;
-        label?: string | undefined;
-    } | {
-        value: string;
-        type: NodeType.Button;
-        name?: string | undefined;
-        variant?: "primary" | "secondary" | undefined;
-        buttonType?: "button" | "submit" | undefined;
-    })[];
-} | {
+export declare const panel: (...args: [Omit<Panel, "type">] | ({
     value: string;
     type: NodeType.Copyable;
     sensitive?: boolean | undefined;
@@ -303,7 +273,7 @@ export declare const panel: (...args: [Omit<Panel, "type">] | (Panel | {
 } | {
     value: string;
     type: NodeType.Image;
-} | {
+} | Panel | {
     type: NodeType.Spinner;
 } | {
     value: string;
@@ -327,15 +297,14 @@ export declare const panel: (...args: [Omit<Panel, "type">] | (Panel | {
     type: NodeType.Row;
     label: string;
     variant?: "default" | "warning" | "critical" | undefined;
-})[][]) => Panel;
-export declare const ComponentStruct: Struct<Panel | {
+} | {
     type: NodeType.Input;
     name: string;
     value?: string | undefined;
     error?: string | undefined;
-    inputType?: "number" | "text" | "password" | undefined;
     placeholder?: string | undefined;
     label?: string | undefined;
+    inputType?: "number" | "text" | "password" | undefined;
 } | {
     value: string;
     type: NodeType.Button;
@@ -350,9 +319,9 @@ export declare const ComponentStruct: Struct<Panel | {
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: NodeType.Button;
@@ -360,7 +329,8 @@ export declare const ComponentStruct: Struct<Panel | {
         variant?: "primary" | "secondary" | undefined;
         buttonType?: "button" | "submit" | undefined;
     })[];
-} | {
+})[][]) => Panel;
+export declare const ComponentStruct: Struct<{
     value: string;
     type: NodeType.Copyable;
     sensitive?: boolean | undefined;
@@ -372,7 +342,7 @@ export declare const ComponentStruct: Struct<Panel | {
 } | {
     value: string;
     type: NodeType.Image;
-} | {
+} | Panel | {
     type: NodeType.Spinner;
 } | {
     value: string;
@@ -396,6 +366,38 @@ export declare const ComponentStruct: Struct<Panel | {
     type: NodeType.Row;
     label: string;
     variant?: "default" | "warning" | "critical" | undefined;
+} | {
+    type: NodeType.Input;
+    name: string;
+    value?: string | undefined;
+    error?: string | undefined;
+    placeholder?: string | undefined;
+    label?: string | undefined;
+    inputType?: "number" | "text" | "password" | 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;
+        error?: string | undefined;
+        placeholder?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | 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/components/row.d.ts

@@ -55,6 +55,8 @@ export declare type Row = Infer<typeof RowStruct>;
  * @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 });

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

@@ -14,6 +14,8 @@ export declare 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();
  */

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

@@ -29,6 +29,8 @@ export declare type Text = Infer<typeof TextStruct>;
  * @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!');

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

@@ -1,4 +1,3 @@
 export * from './components';
 export * from './component';
-export type { NodeWithChildren } from './nodes';
 export { NodeType } from './nodes';

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

@@ -1,5 +1,4 @@
 import type { Infer } from 'superstruct';
-import type { Form, Panel } from './components';
 /**
  * The supported node types. This is based on SIP-7.
  *
@@ -19,10 +18,6 @@ export declare enum NodeType {
     Input = "input",
     Form = "form"
 }
-/**
- * The nodes with a children.
- */
-export declare type NodeWithChildren = Panel | Form;
 /**
  * @internal
  */

package/jsx-dev-runtime.d.ts

@@ -0,0 +1 @@
+export * from './dist/types/jsx/jsx-dev-runtime';

package/jsx-dev-runtime.js

@@ -0,0 +1,5 @@
+/* eslint-disable */
+
+// Re-exported for compatibility with build tools that don't support the
+// `exports` field in package.json
+module.exports = require('./dist/jsx/jsx-dev-runtime');

package/jsx-runtime.d.ts

@@ -0,0 +1 @@
+export * from './dist/types/jsx/jsx-runtime';

package/jsx-runtime.js

@@ -0,0 +1,5 @@
+/* eslint-disable */
+
+// Re-exported for compatibility with build tools that don't support the
+// `exports` field in package.json
+module.exports = require('./dist/jsx/jsx-runtime');

package/jsx.d.ts

@@ -0,0 +1 @@
+export * from './dist/types/jsx';

package/jsx.js

@@ -0,0 +1,5 @@
+/* eslint-disable */
+
+// Re-exported for compatibility with build tools that don't support the
+// `exports` field in package.json
+module.exports = require('./dist/jsx/index');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-sdk",
-  "version": "4.0.1",
+  "version": "4.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -8,9 +8,24 @@
   "sideEffects": false,
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/types/index.d.ts"
+      "require": "./dist/index.js"
+    },
+    "./jsx": {
+      "types": "./dist/types/jsx/index.d.ts",
+      "import": "./dist/jsx/index.mjs",
+      "require": "./dist/jsx/index.js"
+    },
+    "./jsx-runtime": {
+      "types": "./dist/types/jsx/jsx-runtime.d.ts",
+      "import": "./dist/jsx/jsx-runtime.mjs",
+      "require": "./dist/jsx/jsx-runtime.js"
+    },
+    "./jsx-dev-runtime": {
+      "types": "./dist/types/jsx/jsx-dev-runtime.d.ts",
+      "import": "./dist/jsx/jsx-dev-runtime.mjs",
+      "require": "./dist/jsx/jsx-dev-runtime.js"
     },
     "./package.json": "./package.json"
   },
@@ -18,7 +33,13 @@
   "module": "./dist/index.mjs",
   "types": "./dist/types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "jsx.js",
+    "jsx-dev-runtime.js",
+    "jsx-runtime.js",
+    "jsx.d.ts",
+    "jsx-dev-runtime.d.ts",
+    "jsx-runtime.d.ts"
   ],
   "scripts": {
     "test": "jest && yarn posttest",
@@ -38,8 +59,8 @@
     "build:ci": "tsup --clean"
   },
   "dependencies": {
-    "@metamask/key-tree": "^9.0.0",
-    "@metamask/providers": "^16.0.0",
+    "@metamask/key-tree": "^9.1.0",
+    "@metamask/providers": "^16.1.0",
     "@metamask/rpc-errors": "^6.2.1",
     "@metamask/utils": "^8.3.0",
     "fast-xml-parser": "^4.3.4",