@metamask/snaps-sdk 5.0.0 → 6.1.0

package/dist/index.mjs

@@ -187,9 +187,11 @@ function getErrorData(error) {
 import {
   Struct,
   define,
+  is,
   literal as superstructLiteral,
   union as superstructUnion
-} from "superstruct";
+} from "@metamask/superstruct";
+import { hasProperty as hasProperty2, isPlainObject } from "@metamask/utils";
 function literal(value) {
   return define(
     JSON.stringify(value),
@@ -209,6 +211,41 @@ function union([
 function enumValue(constant) {
   return literal(constant);
 }
+function typedUnion(structs) {
+  return new Struct({
+    type: "union",
+    schema: null,
+    *entries(value, context) {
+      if (!isPlainObject(value) || !hasProperty2(value, "type")) {
+        return;
+      }
+      const { type } = value;
+      const struct = structs.find(({ schema }) => is(type, schema.type));
+      if (!struct) {
+        return;
+      }
+      for (const entry of struct.entries(value, context)) {
+        yield entry;
+      }
+    },
+    validator(value, context) {
+      const types = structs.map(({ schema }) => schema.type.type);
+      if (!isPlainObject(value) || !hasProperty2(value, "type") || typeof value.type !== "string") {
+        return `Expected type to be one of: ${types.join(
+          ", "
+        )}, but received: undefined`;
+      }
+      const { type } = value;
+      const struct = structs.find(({ schema }) => is(type, schema.type));
+      if (struct) {
+        return struct.validator(value, context);
+      }
+      return `Expected type to be one of: ${types.join(
+        ", "
+      )}, but received: "${type}"`;
+    }
+  });
+}
 
 // src/internals/jsx.ts
 function nullUnion(structs) {
@@ -216,7 +253,7 @@ function nullUnion(structs) {
 }
 
 // src/internals/svg.ts
-import { refine, string } from "superstruct";
+import { refine, string } from "@metamask/superstruct";
 function svg() {
   return refine(string(), "SVG", (value) => {
     if (!value.includes("<svg")) {
@@ -266,14 +303,14 @@ var UserRejectedRequestError = createSnapError(
 import { assert, bytesToBase64 } from "@metamask/utils";
 
 // src/ui/components/address.ts
+import { assign as assign2, literal as literal2, object as object2 } from "@metamask/superstruct";
 import { HexChecksumAddressStruct } from "@metamask/utils";
-import { assign as assign2, literal as literal2, object as object2 } from "superstruct";
 
 // src/ui/builder.ts
-import { assertStruct, isPlainObject } from "@metamask/utils";
+import { assertStruct, isPlainObject as isPlainObject2 } from "@metamask/utils";
 function createBuilder(type, struct, keys = []) {
   return (...args) => {
-    if (args.length === 1 && isPlainObject(args[0])) {
+    if (args.length === 1 && isPlainObject2(args[0])) {
       const node2 = { ...args[0], type };
       assertStruct(node2, struct, `Invalid ${type} component`);
       return node2;
@@ -296,7 +333,7 @@ function createBuilder(type, struct, keys = []) {
 }
 
 // src/ui/nodes.ts
-import { assign, object, string as string2, unknown } from "superstruct";
+import { assign, object, string as string2, unknown } from "@metamask/superstruct";
 var NodeType = /* @__PURE__ */ ((NodeType2) => {
   NodeType2["Copyable"] = "copyable";
   NodeType2["Divider"] = "divider";
@@ -342,7 +379,7 @@ import {
   object as object3,
   optional,
   string as string3
-} from "superstruct";
+} from "@metamask/superstruct";
 var CopyableStruct = assign3(
   LiteralStruct,
   object3({
@@ -357,7 +394,7 @@ var copyable = createBuilder("copyable" /* Copyable */, CopyableStruct, [
 ]);
 
 // src/ui/components/divider.ts
-import { assign as assign4, literal as literal4, object as object4 } from "superstruct";
+import { assign as assign4, literal as literal4, object as object4 } from "@metamask/superstruct";
 var DividerStruct = assign4(
   NodeStruct,
   object4({
@@ -367,7 +404,7 @@ var DividerStruct = assign4(
 var divider = createBuilder("divider" /* Divider */, DividerStruct);
 
 // src/ui/components/heading.ts
-import { assign as assign5, literal as literal5, object as object5, string as string4 } from "superstruct";
+import { assign as assign5, literal as literal5, object as object5, string as string4 } from "@metamask/superstruct";
 var HeadingStruct = assign5(
   LiteralStruct,
   object5({
@@ -380,7 +417,7 @@ var heading = createBuilder("heading" /* Heading */, HeadingStruct, [
 ]);
 
 // src/ui/components/image.ts
-import { assign as assign6, literal as literal6, object as object6 } from "superstruct";
+import { assign as assign6, literal as literal6, object as object6 } from "@metamask/superstruct";
 var ImageStruct = assign6(
   NodeStruct,
   object6({
@@ -391,10 +428,17 @@ var ImageStruct = assign6(
 var image = createBuilder("image" /* Image */, ImageStruct, ["value"]);
 
 // src/ui/components/panel.ts
-import { array as array2, assign as assign13, lazy, literal as literal13, object as object13, union as union6 } from "superstruct";
+import { array as array2, assign as assign13, lazy, literal as literal13, object as object13 } from "@metamask/superstruct";
 
 // src/ui/components/button.ts
-import { assign as assign7, literal as literal7, object as object7, optional as optional2, string as string5, union as union2 } from "superstruct";
+import {
+  assign as assign7,
+  literal as literal7,
+  object as object7,
+  optional as optional2,
+  string as string5,
+  union as union2
+} from "@metamask/superstruct";
 var ButtonVariant = /* @__PURE__ */ ((ButtonVariant2) => {
   ButtonVariant2["Primary"] = "primary";
   ButtonVariant2["Secondary"] = "secondary";
@@ -430,10 +474,24 @@ var button = createBuilder("button" /* Button */, ButtonStruct, [
 ]);
 
 // src/ui/components/form.ts
-import { array, assign as assign9, literal as literal9, object as object9, string as string7, union as union4 } from "superstruct";
+import {
+  array,
+  assign as assign9,
+  literal as literal9,
+  object as object9,
+  string as string7,
+  union as union4
+} from "@metamask/superstruct";
 
 // src/ui/components/input.ts
-import { assign as assign8, literal as literal8, object as object8, optional as optional3, string as string6, union as union3 } from "superstruct";
+import {
+  assign as assign8,
+  literal as literal8,
+  object as object8,
+  optional as optional3,
+  string as string6,
+  union as union3
+} from "@metamask/superstruct";
 var InputType = /* @__PURE__ */ ((InputType2) => {
   InputType2["Text"] = "text";
   InputType2["Number"] = "number";
@@ -482,7 +540,14 @@ var form = createBuilder("form" /* Form */, FormStruct, [
 ]);
 
 // src/ui/components/row.ts
-import { assign as assign11, literal as literal11, object as object11, string as string9, optional as optional5, union as union5 } from "superstruct";
+import {
+  assign as assign11,
+  literal as literal11,
+  object as object11,
+  string as string9,
+  optional as optional5,
+  union as union5
+} from "@metamask/superstruct";
 
 // src/ui/components/text.ts
 import {
@@ -492,7 +557,7 @@ import {
   object as object10,
   optional as optional4,
   string as string8
-} from "superstruct";
+} from "@metamask/superstruct";
 var TextStruct = assign10(
   LiteralStruct,
   object10({
@@ -536,7 +601,7 @@ var row = createBuilder("row" /* Row */, RowStruct, [
 ]);
 
 // src/ui/components/spinner.ts
-import { assign as assign12, literal as literal12, object as object12 } from "superstruct";
+import { assign as assign12, literal as literal12, object as object12 } from "@metamask/superstruct";
 var SpinnerStruct = assign12(
   NodeStruct,
   object12({
@@ -561,7 +626,7 @@ var PanelStruct = assign13(
   })
 );
 var panel = createBuilder("panel" /* Panel */, PanelStruct, ["children"]);
-var ComponentStruct = union6([
+var ComponentStruct = typedUnion([
   CopyableStruct,
   DividerStruct,
   HeadingStruct,
@@ -577,10 +642,10 @@ var ComponentStruct = union6([
 ]);
 
 // src/ui/component.ts
+import { is as is2 } from "@metamask/superstruct";
 import { assertStruct as assertStruct2 } from "@metamask/utils";
-import { is } from "superstruct";
 function isComponent(value) {
-  return is(value, ComponentStruct);
+  return is2(value, ComponentStruct);
 }
 function assertIsComponent(value) {
   assertStruct2(value, ComponentStruct, "Invalid component");
@@ -636,6 +701,7 @@ var SeverityLevel = /* @__PURE__ */ ((SeverityLevel2) => {
 
 // src/types/handlers/user-input.ts
 import {
+  number,
   assign as assign14,
   literal as literal14,
   nullable,
@@ -643,12 +709,14 @@ import {
   optional as optional6,
   record,
   string as string10,
-  union as union7
-} from "superstruct";
+  union as union6,
+  boolean as boolean3
+} from "@metamask/superstruct";
 var UserInputEventType = /* @__PURE__ */ ((UserInputEventType2) => {
   UserInputEventType2["ButtonClickEvent"] = "ButtonClickEvent";
   UserInputEventType2["FormSubmitEvent"] = "FormSubmitEvent";
   UserInputEventType2["InputChangeEvent"] = "InputChangeEvent";
+  UserInputEventType2["FileUploadEvent"] = "FileUploadEvent";
   return UserInputEventType2;
 })(UserInputEventType || {});
 var GenericEventStruct = object14({
@@ -662,11 +730,17 @@ var ButtonClickEventStruct = assign14(
     name: optional6(string10())
   })
 );
+var FileStruct = object14({
+  name: string10(),
+  size: number(),
+  contentType: string10(),
+  contents: string10()
+});
 var FormSubmitEventStruct = assign14(
   GenericEventStruct,
   object14({
     type: literal14("FormSubmitEvent" /* FormSubmitEvent */),
-    value: record(string10(), nullable(string10())),
+    value: record(string10(), nullable(union6([string10(), FileStruct, boolean3()]))),
     name: string10()
   })
 );
@@ -675,13 +749,22 @@ var InputChangeEventStruct = assign14(
   object14({
     type: literal14("InputChangeEvent" /* InputChangeEvent */),
     name: string10(),
-    value: string10()
+    value: union6([string10(), boolean3()])
+  })
+);
+var FileUploadEventStruct = assign14(
+  GenericEventStruct,
+  object14({
+    type: literal14("FileUploadEvent" /* FileUploadEvent */),
+    name: string10(),
+    file: nullable(FileStruct)
   })
 );
-var UserInputEventStruct = union7([
+var UserInputEventStruct = union6([
   ButtonClickEventStruct,
   FormSubmitEventStruct,
-  InputChangeEventStruct
+  InputChangeEventStruct,
+  FileUploadEventStruct
 ]);
 
 // src/types/methods/dialog.ts
@@ -716,33 +799,39 @@ var NotificationType = /* @__PURE__ */ ((NotificationType2) => {
 })(NotificationType || {});
 
 // src/types/interface.ts
+import {
+  boolean as boolean5,
+  nullable as nullable3,
+  record as record3,
+  string as string12,
+  union as union7
+} from "@metamask/superstruct";
 import { JsonStruct as JsonStruct2 } from "@metamask/utils";
-import { nullable as nullable3, record as record3, string as string12, union as union8 } from "superstruct";
 
 // src/jsx/validation.ts
 import {
-  hasProperty as hasProperty2,
-  HexChecksumAddressStruct as HexChecksumAddressStruct2,
-  isPlainObject as isPlainObject2,
-  JsonStruct
-} from "@metamask/utils";
-import {
-  is as is2,
-  boolean as boolean3,
+  is as is3,
+  boolean as boolean4,
   optional as optional7,
   array as array3,
   lazy as lazy2,
   nullable as nullable2,
-  number,
+  number as number2,
   object as object15,
   record as record2,
   string as string11,
   tuple
-} from "superstruct";
-var KeyStruct = nullUnion([string11(), number()]);
-var StringElementStruct = maybeArray(
+} from "@metamask/superstruct";
+import {
+  hasProperty as hasProperty3,
+  HexChecksumAddressStruct as HexChecksumAddressStruct2,
+  isPlainObject as isPlainObject3,
+  JsonStruct
+} from "@metamask/utils";
+var KeyStruct = nullUnion([string11(), number2()]);
+var StringElementStruct = children([
   string11()
-);
+]);
 var ElementStruct = object15({
   type: string11(),
   props: record2(string11(), JsonStruct),
@@ -755,8 +844,8 @@ function nestable(struct) {
   ]);
   return nestableStruct;
 }
-function maybeArray(struct) {
-  return nestable(struct);
+function children(structs) {
+  return nestable(nullable2(nullUnion([...structs, boolean4()])));
 }
 function element(name, props = {}) {
   return object15({
@@ -770,7 +859,13 @@ var ButtonStruct2 = element("Button", {
   name: optional7(string11()),
   type: optional7(nullUnion([literal("button"), literal("submit")])),
   variant: optional7(nullUnion([literal("primary"), literal("destructive")])),
-  disabled: optional7(boolean3())
+  disabled: optional7(boolean4())
+});
+var CheckboxStruct = element("Checkbox", {
+  name: string11(),
+  checked: optional7(boolean4()),
+  label: optional7(string11()),
+  variant: optional7(nullUnion([literal("default"), literal("toggle")]))
 });
 var InputStruct2 = element("Input", {
   name: string11(),
@@ -787,42 +882,57 @@ var OptionStruct = element("Option", {
 var DropdownStruct = element("Dropdown", {
   name: string11(),
   value: optional7(string11()),
-  children: maybeArray(OptionStruct)
+  children: children([OptionStruct])
 });
+var FileInputStruct = element(
+  "FileInput",
+  {
+    name: string11(),
+    accept: nullUnion([optional7(array3(string11()))]),
+    compact: optional7(boolean4())
+  }
+);
+var BUTTON_INPUT = [InputStruct2, ButtonStruct2];
+var FIELD_CHILDREN_ARRAY = [
+  InputStruct2,
+  DropdownStruct,
+  FileInputStruct,
+  CheckboxStruct
+];
+var FieldChildUnionStruct = nullUnion([
+  ...FIELD_CHILDREN_ARRAY,
+  ...BUTTON_INPUT
+]);
+var FieldChildStruct = nullUnion([
+  tuple(BUTTON_INPUT),
+  ...FIELD_CHILDREN_ARRAY
+]);
 var FieldStruct = element("Field", {
   label: optional7(string11()),
   error: optional7(string11()),
-  children: nullUnion([
-    tuple([InputStruct2, ButtonStruct2]),
-    InputStruct2,
-    DropdownStruct
-  ])
+  children: FieldChildStruct
 });
+var FormChildStruct = children(
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
+  [FieldStruct, lazy2(() => BoxChildStruct)]
+);
 var FormStruct2 = element("Form", {
-  children: maybeArray(nullUnion([FieldStruct, ButtonStruct2])),
+  children: FormChildStruct,
   name: string11()
 });
 var BoldStruct = element("Bold", {
-  children: maybeArray(
-    nullable2(
-      nullUnion([
-        string11(),
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        lazy2(() => ItalicStruct)
-      ])
-    )
-  )
+  children: children([
+    string11(),
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    lazy2(() => ItalicStruct)
+  ])
 });
 var ItalicStruct = element("Italic", {
-  children: maybeArray(
-    nullable2(
-      nullUnion([
-        string11(),
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        lazy2(() => BoldStruct)
-      ])
-    )
-  )
+  children: children([
+    string11(),
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    lazy2(() => BoldStruct)
+  ])
 });
 var FormattingStruct = nullUnion([
   BoldStruct,
@@ -831,11 +941,12 @@ var FormattingStruct = nullUnion([
 var AddressStruct2 = element("Address", {
   address: HexChecksumAddressStruct2
 });
+var BoxChildrenStruct = children(
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
+  [lazy2(() => BoxChildStruct)]
+);
 var BoxStruct = element("Box", {
-  children: maybeArray(
-    // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    nullable2(lazy2(() => BoxChildStruct))
-  ),
+  children: BoxChildrenStruct,
   direction: optional7(nullUnion([literal("horizontal"), literal("vertical")])),
   alignment: optional7(
     nullUnion([
@@ -847,15 +958,39 @@ var BoxStruct = element("Box", {
     ])
   )
 });
+var FooterChildStruct = nullUnion([
+  tuple([ButtonStruct2, ButtonStruct2]),
+  ButtonStruct2
+]);
+var FooterStruct = element("Footer", {
+  children: FooterChildStruct
+});
+var ContainerChildStruct = nullUnion([
+  tuple([BoxStruct, FooterStruct]),
+  BoxStruct
+]);
+var ContainerStruct = element(
+  "Container",
+  {
+    children: ContainerChildStruct
+  }
+);
 var CopyableStruct2 = element("Copyable", {
   value: string11(),
-  sensitive: optional7(boolean3())
+  sensitive: optional7(boolean4())
 });
 var DividerStruct2 = element("Divider");
 var ValueStruct = element("Value", {
   value: string11(),
   extra: string11()
 });
+var CardStruct = element("Card", {
+  image: optional7(string11()),
+  title: string11(),
+  description: optional7(string11()),
+  value: string11(),
+  extra: optional7(string11())
+});
 var HeadingStruct2 = element("Heading", {
   children: StringElementStruct
 });
@@ -865,13 +1000,33 @@ var ImageStruct2 = element("Image", {
 });
 var LinkStruct = element("Link", {
   href: string11(),
-  children: maybeArray(nullable2(nullUnion([FormattingStruct, string11()])))
+  children: children([FormattingStruct, string11()])
 });
 var TextStruct2 = element("Text", {
-  children: maybeArray(
-    nullable2(nullUnion([string11(), BoldStruct, ItalicStruct, LinkStruct]))
+  children: children([string11(), BoldStruct, ItalicStruct, LinkStruct]),
+  alignment: optional7(
+    nullUnion([literal("start"), literal("center"), literal("end")])
   )
 });
+var TooltipChildStruct = nullUnion([
+  TextStruct2,
+  BoldStruct,
+  ItalicStruct,
+  LinkStruct,
+  ImageStruct2,
+  boolean4()
+]);
+var TooltipContentStruct = nullUnion([
+  TextStruct2,
+  BoldStruct,
+  ItalicStruct,
+  LinkStruct,
+  string11()
+]);
+var TooltipStruct = element("Tooltip", {
+  children: nullable2(TooltipChildStruct),
+  content: TooltipContentStruct
+});
 var RowStruct2 = element("Row", {
   label: string11(),
   children: nullUnion([AddressStruct2, ImageStruct2, TextStruct2, ValueStruct]),
@@ -881,28 +1036,36 @@ var RowStruct2 = element("Row", {
   tooltip: optional7(string11())
 });
 var SpinnerStruct2 = element("Spinner");
-var BoxChildStruct = nullUnion([
-  ButtonStruct2,
-  InputStruct2,
-  FormStruct2,
-  BoldStruct,
-  ItalicStruct,
+var BoxChildStruct = typedUnion([
   AddressStruct2,
+  BoldStruct,
   BoxStruct,
+  ButtonStruct2,
   CopyableStruct2,
   DividerStruct2,
+  DropdownStruct,
+  FileInputStruct,
+  FormStruct2,
   HeadingStruct2,
+  InputStruct2,
   ImageStruct2,
+  ItalicStruct,
   LinkStruct,
   RowStruct2,
   SpinnerStruct2,
   TextStruct2,
-  DropdownStruct
+  TooltipStruct,
+  CheckboxStruct,
+  CardStruct
+]);
+var RootJSXElementStruct = nullUnion([
+  BoxChildStruct,
+  ContainerStruct
 ]);
-var RootJSXElementStruct = BoxChildStruct;
-var JSXElementStruct = nullUnion([
+var JSXElementStruct = typedUnion([
   ButtonStruct2,
   InputStruct2,
+  FileInputStruct,
   FieldStruct,
   FormStruct2,
   BoldStruct,
@@ -919,16 +1082,22 @@ var JSXElementStruct = nullUnion([
   TextStruct2,
   DropdownStruct,
   OptionStruct,
-  ValueStruct
+  ValueStruct,
+  TooltipStruct,
+  CheckboxStruct,
+  FooterStruct,
+  ContainerStruct,
+  CardStruct
 ]);
 
 // src/types/interface.ts
-var FormStateStruct = record3(string12(), nullable3(string12()));
+var StateStruct = union7([FileStruct, string12(), boolean5()]);
+var FormStateStruct = record3(string12(), nullable3(StateStruct));
 var InterfaceStateStruct = record3(
   string12(),
-  union8([FormStateStruct, nullable3(string12())])
+  union7([FormStateStruct, nullable3(StateStruct)])
 );
-var ComponentOrElementStruct = union8([
+var ComponentOrElementStruct = union7([
   ComponentStruct,
   RootJSXElementStruct
 ]);
@@ -947,6 +1116,8 @@ export {
   DialogType,
   DisconnectedError,
   DividerStruct,
+  FileStruct,
+  FileUploadEventStruct,
   FormComponentStruct,
   FormStateStruct,
   FormStruct,
@@ -980,6 +1151,7 @@ export {
   SeverityLevel,
   SnapError,
   SpinnerStruct,
+  StateStruct,
   TextStruct,
   TransactionRejected,
   UnauthorizedError,