@metamask/snaps-sdk 5.0.0 → 6.0.0

package/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.0.0]
+### Added
+- **BREAKING:** Add `FileInput` component ([#2469](https://github.com/MetaMask/snaps/pull/2469), [#2504](https://github.com/MetaMask/snaps/pull/2504))
+  - `FormSubmitEvent` may now contain values of type `File`.
+- **BREAKING:** Add `Checkbox` component ([#2501](https://github.com/MetaMask/snaps/pull/2501))
+  - `FormSubmitEvent` and `InputChangeEvent` may now contain values of type `boolean`.
+- Add `alignment` prop to `Text` ([#2489](https://github.com/MetaMask/snaps/pull/2489))
+- Add `Tooltip` component ([#2490](https://github.com/MetaMask/snaps/pull/2490))
+- Support additional components inside forms ([#2497](https://github.com/MetaMask/snaps/pull/2497))
+- Support conditional children in most JSX components ([#2506](https://github.com/MetaMask/snaps/pull/2506))
+
 ## [5.0.0]
 ### Added
 - Allow row tooltips ([#2483](https://github.com/MetaMask/snaps/pull/2483))
@@ -170,7 +181,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release of this package.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@5.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@6.0.0...HEAD
+[6.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@5.0.0...@metamask/snaps-sdk@6.0.0
 [5.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@4.4.2...@metamask/snaps-sdk@5.0.0
 [4.4.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@4.4.1...@metamask/snaps-sdk@4.4.2
 [4.4.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@4.4.0...@metamask/snaps-sdk@4.4.1

package/dist/index.js

@@ -51,6 +51,8 @@ __export(src_exports, {
   DialogType: () => DialogType,
   DisconnectedError: () => DisconnectedError,
   DividerStruct: () => DividerStruct,
+  FileStruct: () => FileStruct,
+  FileUploadEventStruct: () => FileUploadEventStruct,
   FormComponentStruct: () => FormComponentStruct,
   FormStateStruct: () => FormStateStruct,
   FormStruct: () => FormStruct,
@@ -84,6 +86,7 @@ __export(src_exports, {
   SeverityLevel: () => SeverityLevel,
   SnapError: () => SnapError,
   SpinnerStruct: () => SpinnerStruct,
+  StateStruct: () => StateStruct,
   TextStruct: () => TextStruct,
   TransactionRejected: () => TransactionRejected,
   UnauthorizedError: () => UnauthorizedError,
@@ -721,6 +724,7 @@ var UserInputEventType = /* @__PURE__ */ ((UserInputEventType2) => {
   UserInputEventType2["ButtonClickEvent"] = "ButtonClickEvent";
   UserInputEventType2["FormSubmitEvent"] = "FormSubmitEvent";
   UserInputEventType2["InputChangeEvent"] = "InputChangeEvent";
+  UserInputEventType2["FileUploadEvent"] = "FileUploadEvent";
   return UserInputEventType2;
 })(UserInputEventType || {});
 var GenericEventStruct = (0, import_superstruct17.object)({
@@ -734,11 +738,17 @@ var ButtonClickEventStruct = (0, import_superstruct17.assign)(
     name: (0, import_superstruct17.optional)((0, import_superstruct17.string)())
   })
 );
+var FileStruct = (0, import_superstruct17.object)({
+  name: (0, import_superstruct17.string)(),
+  size: (0, import_superstruct17.number)(),
+  contentType: (0, import_superstruct17.string)(),
+  contents: (0, import_superstruct17.string)()
+});
 var FormSubmitEventStruct = (0, import_superstruct17.assign)(
   GenericEventStruct,
   (0, import_superstruct17.object)({
     type: (0, import_superstruct17.literal)("FormSubmitEvent" /* FormSubmitEvent */),
-    value: (0, import_superstruct17.record)((0, import_superstruct17.string)(), (0, import_superstruct17.nullable)((0, import_superstruct17.string)())),
+    value: (0, import_superstruct17.record)((0, import_superstruct17.string)(), (0, import_superstruct17.nullable)((0, import_superstruct17.union)([(0, import_superstruct17.string)(), FileStruct, (0, import_superstruct17.boolean)()]))),
     name: (0, import_superstruct17.string)()
   })
 );
@@ -747,13 +757,22 @@ var InputChangeEventStruct = (0, import_superstruct17.assign)(
   (0, import_superstruct17.object)({
     type: (0, import_superstruct17.literal)("InputChangeEvent" /* InputChangeEvent */),
     name: (0, import_superstruct17.string)(),
-    value: (0, import_superstruct17.string)()
+    value: (0, import_superstruct17.union)([(0, import_superstruct17.string)(), (0, import_superstruct17.boolean)()])
+  })
+);
+var FileUploadEventStruct = (0, import_superstruct17.assign)(
+  GenericEventStruct,
+  (0, import_superstruct17.object)({
+    type: (0, import_superstruct17.literal)("FileUploadEvent" /* FileUploadEvent */),
+    name: (0, import_superstruct17.string)(),
+    file: (0, import_superstruct17.nullable)(FileStruct)
   })
 );
 var UserInputEventStruct = (0, import_superstruct17.union)([
   ButtonClickEventStruct,
   FormSubmitEventStruct,
-  InputChangeEventStruct
+  InputChangeEventStruct,
+  FileUploadEventStruct
 ]);
 
 // src/types/methods/dialog.ts
@@ -795,9 +814,9 @@ var import_superstruct19 = require("superstruct");
 var import_utils6 = require("@metamask/utils");
 var import_superstruct18 = require("superstruct");
 var KeyStruct = nullUnion([(0, import_superstruct18.string)(), (0, import_superstruct18.number)()]);
-var StringElementStruct = maybeArray(
+var StringElementStruct = children([
   (0, import_superstruct18.string)()
-);
+]);
 var ElementStruct = (0, import_superstruct18.object)({
   type: (0, import_superstruct18.string)(),
   props: (0, import_superstruct18.record)((0, import_superstruct18.string)(), import_utils6.JsonStruct),
@@ -810,8 +829,8 @@ function nestable(struct) {
   ]);
   return nestableStruct;
 }
-function maybeArray(struct) {
-  return nestable(struct);
+function children(structs) {
+  return nestable((0, import_superstruct18.nullable)(nullUnion([...structs, (0, import_superstruct18.boolean)()])));
 }
 function element(name, props = {}) {
   return (0, import_superstruct18.object)({
@@ -827,6 +846,12 @@ var ButtonStruct2 = element("Button", {
   variant: (0, import_superstruct18.optional)(nullUnion([literal("primary"), literal("destructive")])),
   disabled: (0, import_superstruct18.optional)((0, import_superstruct18.boolean)())
 });
+var CheckboxStruct = element("Checkbox", {
+  name: (0, import_superstruct18.string)(),
+  checked: (0, import_superstruct18.optional)((0, import_superstruct18.boolean)()),
+  label: (0, import_superstruct18.optional)((0, import_superstruct18.string)()),
+  variant: (0, import_superstruct18.optional)(nullUnion([literal("default"), literal("toggle")]))
+});
 var InputStruct2 = element("Input", {
   name: (0, import_superstruct18.string)(),
   type: (0, import_superstruct18.optional)(
@@ -842,42 +867,47 @@ var OptionStruct = element("Option", {
 var DropdownStruct = element("Dropdown", {
   name: (0, import_superstruct18.string)(),
   value: (0, import_superstruct18.optional)((0, import_superstruct18.string)()),
-  children: maybeArray(OptionStruct)
+  children: children([OptionStruct])
 });
+var FileInputStruct = element(
+  "FileInput",
+  {
+    name: (0, import_superstruct18.string)(),
+    accept: nullUnion([(0, import_superstruct18.optional)((0, import_superstruct18.array)((0, import_superstruct18.string)()))]),
+    compact: (0, import_superstruct18.optional)((0, import_superstruct18.boolean)())
+  }
+);
 var FieldStruct = element("Field", {
   label: (0, import_superstruct18.optional)((0, import_superstruct18.string)()),
   error: (0, import_superstruct18.optional)((0, import_superstruct18.string)()),
   children: nullUnion([
     (0, import_superstruct18.tuple)([InputStruct2, ButtonStruct2]),
+    DropdownStruct,
+    FileInputStruct,
     InputStruct2,
-    DropdownStruct
+    CheckboxStruct
   ])
 });
 var FormStruct2 = element("Form", {
-  children: maybeArray(nullUnion([FieldStruct, ButtonStruct2])),
+  children: children(
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    [FieldStruct, (0, import_superstruct18.lazy)(() => BoxChildStruct)]
+  ),
   name: (0, import_superstruct18.string)()
 });
 var BoldStruct = element("Bold", {
-  children: maybeArray(
-    (0, import_superstruct18.nullable)(
-      nullUnion([
-        (0, import_superstruct18.string)(),
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        (0, import_superstruct18.lazy)(() => ItalicStruct)
-      ])
-    )
-  )
+  children: children([
+    (0, import_superstruct18.string)(),
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    (0, import_superstruct18.lazy)(() => ItalicStruct)
+  ])
 });
 var ItalicStruct = element("Italic", {
-  children: maybeArray(
-    (0, import_superstruct18.nullable)(
-      nullUnion([
-        (0, import_superstruct18.string)(),
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        (0, import_superstruct18.lazy)(() => BoldStruct)
-      ])
-    )
-  )
+  children: children([
+    (0, import_superstruct18.string)(),
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    (0, import_superstruct18.lazy)(() => BoldStruct)
+  ])
 });
 var FormattingStruct = nullUnion([
   BoldStruct,
@@ -887,9 +917,9 @@ var AddressStruct2 = element("Address", {
   address: import_utils6.HexChecksumAddressStruct
 });
 var BoxStruct = element("Box", {
-  children: maybeArray(
+  children: children(
     // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    (0, import_superstruct18.nullable)((0, import_superstruct18.lazy)(() => BoxChildStruct))
+    [(0, import_superstruct18.lazy)(() => BoxChildStruct)]
   ),
   direction: (0, import_superstruct18.optional)(nullUnion([literal("horizontal"), literal("vertical")])),
   alignment: (0, import_superstruct18.optional)(
@@ -920,13 +950,33 @@ var ImageStruct2 = element("Image", {
 });
 var LinkStruct = element("Link", {
   href: (0, import_superstruct18.string)(),
-  children: maybeArray((0, import_superstruct18.nullable)(nullUnion([FormattingStruct, (0, import_superstruct18.string)()])))
+  children: children([FormattingStruct, (0, import_superstruct18.string)()])
 });
 var TextStruct2 = element("Text", {
-  children: maybeArray(
-    (0, import_superstruct18.nullable)(nullUnion([(0, import_superstruct18.string)(), BoldStruct, ItalicStruct, LinkStruct]))
+  children: children([(0, import_superstruct18.string)(), BoldStruct, ItalicStruct, LinkStruct]),
+  alignment: (0, import_superstruct18.optional)(
+    nullUnion([literal("start"), literal("center"), literal("end")])
   )
 });
+var TooltipChildStruct = nullUnion([
+  TextStruct2,
+  BoldStruct,
+  ItalicStruct,
+  LinkStruct,
+  ImageStruct2,
+  (0, import_superstruct18.boolean)()
+]);
+var TooltipContentStruct = nullUnion([
+  TextStruct2,
+  BoldStruct,
+  ItalicStruct,
+  LinkStruct,
+  (0, import_superstruct18.string)()
+]);
+var TooltipStruct = element("Tooltip", {
+  children: (0, import_superstruct18.nullable)(TooltipChildStruct),
+  content: TooltipContentStruct
+});
 var RowStruct2 = element("Row", {
   label: (0, import_superstruct18.string)(),
   children: nullUnion([AddressStruct2, ImageStruct2, TextStruct2, ValueStruct]),
@@ -937,27 +987,31 @@ var RowStruct2 = element("Row", {
 });
 var SpinnerStruct2 = element("Spinner");
 var BoxChildStruct = nullUnion([
-  ButtonStruct2,
-  InputStruct2,
-  FormStruct2,
-  BoldStruct,
-  ItalicStruct,
   AddressStruct2,
+  BoldStruct,
   BoxStruct,
+  ButtonStruct2,
   CopyableStruct2,
   DividerStruct2,
+  DropdownStruct,
+  FileInputStruct,
+  FormStruct2,
   HeadingStruct2,
+  InputStruct2,
   ImageStruct2,
+  ItalicStruct,
   LinkStruct,
   RowStruct2,
   SpinnerStruct2,
   TextStruct2,
-  DropdownStruct
+  TooltipStruct,
+  CheckboxStruct
 ]);
 var RootJSXElementStruct = BoxChildStruct;
 var JSXElementStruct = nullUnion([
   ButtonStruct2,
   InputStruct2,
+  FileInputStruct,
   FieldStruct,
   FormStruct2,
   BoldStruct,
@@ -974,14 +1028,17 @@ var JSXElementStruct = nullUnion([
   TextStruct2,
   DropdownStruct,
   OptionStruct,
-  ValueStruct
+  ValueStruct,
+  TooltipStruct,
+  CheckboxStruct
 ]);
 
 // src/types/interface.ts
-var FormStateStruct = (0, import_superstruct19.record)((0, import_superstruct19.string)(), (0, import_superstruct19.nullable)((0, import_superstruct19.string)()));
+var StateStruct = (0, import_superstruct19.union)([FileStruct, (0, import_superstruct19.string)(), (0, import_superstruct19.boolean)()]);
+var FormStateStruct = (0, import_superstruct19.record)((0, import_superstruct19.string)(), (0, import_superstruct19.nullable)(StateStruct));
 var InterfaceStateStruct = (0, import_superstruct19.record)(
   (0, import_superstruct19.string)(),
-  (0, import_superstruct19.union)([FormStateStruct, (0, import_superstruct19.nullable)((0, import_superstruct19.string)())])
+  (0, import_superstruct19.union)([FormStateStruct, (0, import_superstruct19.nullable)(StateStruct)])
 );
 var ComponentOrElementStruct = (0, import_superstruct19.union)([
   ComponentStruct,