@metamask/snaps-sdk 6.0.0 → 6.1.1

package/CHANGELOG.md

@@ -6,6 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.1.1]
+### Changed
+- Bump `@metamask/providers` from `17.0.0` to `^17.1.2` ([#2598](https://github.com/metamask/snaps/pull/2598))
+
+## [6.1.0]
+### Added
+- Add non-restricted RPC method `snap_resolveInterface` ([#2509](https://github.com/metamask/snaps/pull/2509))
+   - This method allows a Snap to resolve a given user interface bound to a `snap_dialog` with a custom value.
+  - Add new types `ResolveInterfaceParams`, `ResolveInterfaceResult`.
+- Add `Card` component ([#2480](https://github.com/metamask/snaps/pull/2480))
+- Add `BoxChildStruct`, `FormChildStruct`, `FieldChildUnionStruct` ([#2409](https://github.com/metamask/snaps/pull/2409))
+- Add `Container` and `Footer` components ([#2517](https://github.com/metamask/snaps/pull/2517))
+
+### Changed
+- Update `RootJSXElement` to allow `Container` or `Box` at the root ([#2526](https://github.com/metamask/snaps/pull/2526))
+- Bump `@metamask/key-tree` from `^9.1.1` to `^9.1.2` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
+- Bump `@metamask/rpc-errors` from `^6.2.1` to `^6.3.1` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
+- Bump `@metamask/utils` from `^8.3.0` to `^9.1.0` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
+
+### Fixed
+- Replace `superstruct` with ESM-compatible `@metamask/superstruct` `^3.1.0` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
+  - This fixes the issue of this package being unusable by any TypeScript project that uses `Node16` or `NodeNext` as its `moduleResolution` option.
+- Set `@metamask/providers` from `^17.0.0` to `17.0.0` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
+  - `17.1.0` and `17.1.1` introduce regressions.
+
 ## [6.0.0]
 ### Added
 - **BREAKING:** Add `FileInput` component ([#2469](https://github.com/MetaMask/snaps/pull/2469), [#2504](https://github.com/MetaMask/snaps/pull/2504))
@@ -181,7 +206,9 @@ 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@6.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@6.1.1...HEAD
+[6.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@6.1.0...@metamask/snaps-sdk@6.1.1
+[6.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@6.0.0...@metamask/snaps-sdk@6.1.0
 [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

package/dist/index.js

@@ -95,7 +95,7 @@ __export(src_exports, {
   UserInputEventType: () => UserInputEventType,
   UserRejectedRequestError: () => UserRejectedRequestError,
   address: () => address,
-  assert: () => import_utils8.assert,
+  assert: () => import_utils9.assert,
   assertIsComponent: () => assertIsComponent,
   button: () => button,
   copyable: () => copyable,
@@ -287,7 +287,8 @@ function getErrorData(error) {
 }
 
 // src/internals/structs.ts
-var import_superstruct = require("superstruct");
+var import_superstruct = require("@metamask/superstruct");
+var import_utils2 = require("@metamask/utils");
 function literal(value) {
   return (0, import_superstruct.define)(
     JSON.stringify(value),
@@ -307,6 +308,41 @@ function union([
 function enumValue(constant) {
   return literal(constant);
 }
+function typedUnion(structs) {
+  return new import_superstruct.Struct({
+    type: "union",
+    schema: null,
+    *entries(value, context) {
+      if (!(0, import_utils2.isPlainObject)(value) || !(0, import_utils2.hasProperty)(value, "type")) {
+        return;
+      }
+      const { type } = value;
+      const struct = structs.find(({ schema }) => (0, import_superstruct.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 (!(0, import_utils2.isPlainObject)(value) || !(0, import_utils2.hasProperty)(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 }) => (0, import_superstruct.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) {
@@ -314,7 +350,7 @@ function nullUnion(structs) {
 }
 
 // src/internals/svg.ts
-var import_superstruct2 = require("superstruct");
+var import_superstruct2 = require("@metamask/superstruct");
 function svg() {
   return (0, import_superstruct2.refine)((0, import_superstruct2.string)(), "SVG", (value) => {
     if (!value.includes("<svg")) {
@@ -325,7 +361,7 @@ function svg() {
 }
 
 // src/index.ts
-var import_utils8 = require("@metamask/utils");
+var import_utils9 = require("@metamask/utils");
 
 // src/error-wrappers.ts
 var import_rpc_errors = require("@metamask/rpc-errors");
@@ -361,19 +397,19 @@ var UserRejectedRequestError = createSnapError(
 );
 
 // src/images.ts
-var import_utils5 = require("@metamask/utils");
+var import_utils6 = require("@metamask/utils");
 
 // src/ui/components/address.ts
-var import_utils3 = require("@metamask/utils");
-var import_superstruct4 = require("superstruct");
+var import_superstruct4 = require("@metamask/superstruct");
+var import_utils4 = require("@metamask/utils");
 
 // src/ui/builder.ts
-var import_utils2 = require("@metamask/utils");
+var import_utils3 = require("@metamask/utils");
 function createBuilder(type, struct, keys = []) {
   return (...args) => {
-    if (args.length === 1 && (0, import_utils2.isPlainObject)(args[0])) {
+    if (args.length === 1 && (0, import_utils3.isPlainObject)(args[0])) {
       const node2 = { ...args[0], type };
-      (0, import_utils2.assertStruct)(node2, struct, `Invalid ${type} component`);
+      (0, import_utils3.assertStruct)(node2, struct, `Invalid ${type} component`);
       return node2;
     }
     const node = keys.reduce(
@@ -388,13 +424,13 @@ function createBuilder(type, struct, keys = []) {
       },
       { type }
     );
-    (0, import_utils2.assertStruct)(node, struct, `Invalid ${type} component`);
+    (0, import_utils3.assertStruct)(node, struct, `Invalid ${type} component`);
     return node;
   };
 }
 
 // src/ui/nodes.ts
-var import_superstruct3 = require("superstruct");
+var import_superstruct3 = require("@metamask/superstruct");
 var NodeType = /* @__PURE__ */ ((NodeType2) => {
   NodeType2["Copyable"] = "copyable";
   NodeType2["Divider"] = "divider";
@@ -425,7 +461,7 @@ var AddressStruct = (0, import_superstruct4.assign)(
   LiteralStruct,
   (0, import_superstruct4.object)({
     type: (0, import_superstruct4.literal)("address" /* Address */),
-    value: import_utils3.HexChecksumAddressStruct
+    value: import_utils4.HexChecksumAddressStruct
   })
 );
 var address = createBuilder("address" /* Address */, AddressStruct, [
@@ -433,7 +469,7 @@ var address = createBuilder("address" /* Address */, AddressStruct, [
 ]);
 
 // src/ui/components/copyable.ts
-var import_superstruct5 = require("superstruct");
+var import_superstruct5 = require("@metamask/superstruct");
 var CopyableStruct = (0, import_superstruct5.assign)(
   LiteralStruct,
   (0, import_superstruct5.object)({
@@ -448,7 +484,7 @@ var copyable = createBuilder("copyable" /* Copyable */, CopyableStruct, [
 ]);
 
 // src/ui/components/divider.ts
-var import_superstruct6 = require("superstruct");
+var import_superstruct6 = require("@metamask/superstruct");
 var DividerStruct = (0, import_superstruct6.assign)(
   NodeStruct,
   (0, import_superstruct6.object)({
@@ -458,7 +494,7 @@ var DividerStruct = (0, import_superstruct6.assign)(
 var divider = createBuilder("divider" /* Divider */, DividerStruct);
 
 // src/ui/components/heading.ts
-var import_superstruct7 = require("superstruct");
+var import_superstruct7 = require("@metamask/superstruct");
 var HeadingStruct = (0, import_superstruct7.assign)(
   LiteralStruct,
   (0, import_superstruct7.object)({
@@ -471,7 +507,7 @@ var heading = createBuilder("heading" /* Heading */, HeadingStruct, [
 ]);
 
 // src/ui/components/image.ts
-var import_superstruct8 = require("superstruct");
+var import_superstruct8 = require("@metamask/superstruct");
 var ImageStruct = (0, import_superstruct8.assign)(
   NodeStruct,
   (0, import_superstruct8.object)({
@@ -482,10 +518,10 @@ var ImageStruct = (0, import_superstruct8.assign)(
 var image = createBuilder("image" /* Image */, ImageStruct, ["value"]);
 
 // src/ui/components/panel.ts
-var import_superstruct15 = require("superstruct");
+var import_superstruct15 = require("@metamask/superstruct");
 
 // src/ui/components/button.ts
-var import_superstruct9 = require("superstruct");
+var import_superstruct9 = require("@metamask/superstruct");
 var ButtonVariant = /* @__PURE__ */ ((ButtonVariant2) => {
   ButtonVariant2["Primary"] = "primary";
   ButtonVariant2["Secondary"] = "secondary";
@@ -521,10 +557,10 @@ var button = createBuilder("button" /* Button */, ButtonStruct, [
 ]);
 
 // src/ui/components/form.ts
-var import_superstruct11 = require("superstruct");
+var import_superstruct11 = require("@metamask/superstruct");
 
 // src/ui/components/input.ts
-var import_superstruct10 = require("superstruct");
+var import_superstruct10 = require("@metamask/superstruct");
 var InputType = /* @__PURE__ */ ((InputType2) => {
   InputType2["Text"] = "text";
   InputType2["Number"] = "number";
@@ -573,10 +609,10 @@ var form = createBuilder("form" /* Form */, FormStruct, [
 ]);
 
 // src/ui/components/row.ts
-var import_superstruct13 = require("superstruct");
+var import_superstruct13 = require("@metamask/superstruct");
 
 // src/ui/components/text.ts
-var import_superstruct12 = require("superstruct");
+var import_superstruct12 = require("@metamask/superstruct");
 var TextStruct = (0, import_superstruct12.assign)(
   LiteralStruct,
   (0, import_superstruct12.object)({
@@ -620,7 +656,7 @@ var row = createBuilder("row" /* Row */, RowStruct, [
 ]);
 
 // src/ui/components/spinner.ts
-var import_superstruct14 = require("superstruct");
+var import_superstruct14 = require("@metamask/superstruct");
 var SpinnerStruct = (0, import_superstruct14.assign)(
   NodeStruct,
   (0, import_superstruct14.object)({
@@ -645,7 +681,7 @@ var PanelStruct = (0, import_superstruct15.assign)(
   })
 );
 var panel = createBuilder("panel" /* Panel */, PanelStruct, ["children"]);
-var ComponentStruct = (0, import_superstruct15.union)([
+var ComponentStruct = typedUnion([
   CopyableStruct,
   DividerStruct,
   HeadingStruct,
@@ -661,13 +697,13 @@ var ComponentStruct = (0, import_superstruct15.union)([
 ]);
 
 // src/ui/component.ts
-var import_utils4 = require("@metamask/utils");
-var import_superstruct16 = require("superstruct");
+var import_superstruct16 = require("@metamask/superstruct");
+var import_utils5 = require("@metamask/utils");
 function isComponent(value) {
   return (0, import_superstruct16.is)(value, ComponentStruct);
 }
 function assertIsComponent(value) {
-  (0, import_utils4.assertStruct)(value, ComponentStruct, "Invalid component");
+  (0, import_utils5.assertStruct)(value, ComponentStruct, "Invalid component");
 }
 
 // src/images.ts
@@ -684,7 +720,7 @@ async function getRawImageData(url, options) {
       );
     }
     const blob = await response.blob();
-    (0, import_utils5.assert)(
+    (0, import_utils6.assert)(
       blob.type === "image/jpeg" || blob.type === "image/png",
       "Expected image data to be a JPEG or PNG image."
     );
@@ -694,14 +730,14 @@ async function getRawImageData(url, options) {
 async function getImageData(url, options) {
   const blob = await getRawImageData(url, options);
   const bytes = new Uint8Array(await blob.arrayBuffer());
-  return `data:${blob.type};base64,${(0, import_utils5.bytesToBase64)(bytes)}`;
+  return `data:${blob.type};base64,${(0, import_utils6.bytesToBase64)(bytes)}`;
 }
 async function getImageComponent(url, { width, height = width, request }) {
-  (0, import_utils5.assert)(
+  (0, import_utils6.assert)(
     typeof width === "number" && width > 0,
     "Expected width to be a number greater than 0."
   );
-  (0, import_utils5.assert)(
+  (0, import_utils6.assert)(
     typeof height === "number" && height > 0,
     "Expected height to be a number greater than 0."
   );
@@ -719,7 +755,7 @@ var SeverityLevel = /* @__PURE__ */ ((SeverityLevel2) => {
 })(SeverityLevel || {});
 
 // src/types/handlers/user-input.ts
-var import_superstruct17 = require("superstruct");
+var import_superstruct17 = require("@metamask/superstruct");
 var UserInputEventType = /* @__PURE__ */ ((UserInputEventType2) => {
   UserInputEventType2["ButtonClickEvent"] = "ButtonClickEvent";
   UserInputEventType2["FormSubmitEvent"] = "FormSubmitEvent";
@@ -807,19 +843,19 @@ var NotificationType = /* @__PURE__ */ ((NotificationType2) => {
 })(NotificationType || {});
 
 // src/types/interface.ts
-var import_utils7 = require("@metamask/utils");
-var import_superstruct19 = require("superstruct");
+var import_superstruct19 = require("@metamask/superstruct");
+var import_utils8 = require("@metamask/utils");
 
 // src/jsx/validation.ts
-var import_utils6 = require("@metamask/utils");
-var import_superstruct18 = require("superstruct");
+var import_superstruct18 = require("@metamask/superstruct");
+var import_utils7 = require("@metamask/utils");
 var KeyStruct = nullUnion([(0, import_superstruct18.string)(), (0, import_superstruct18.number)()]);
 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),
+  props: (0, import_superstruct18.record)((0, import_superstruct18.string)(), import_utils7.JsonStruct),
   key: (0, import_superstruct18.nullable)(KeyStruct)
 });
 function nestable(struct) {
@@ -877,22 +913,32 @@ var FileInputStruct = element(
     compact: (0, import_superstruct18.optional)((0, import_superstruct18.boolean)())
   }
 );
+var BUTTON_INPUT = [InputStruct2, ButtonStruct2];
+var FIELD_CHILDREN_ARRAY = [
+  InputStruct2,
+  DropdownStruct,
+  FileInputStruct,
+  CheckboxStruct
+];
+var FieldChildUnionStruct = nullUnion([
+  ...FIELD_CHILDREN_ARRAY,
+  ...BUTTON_INPUT
+]);
+var FieldChildStruct = nullUnion([
+  (0, import_superstruct18.tuple)(BUTTON_INPUT),
+  ...FIELD_CHILDREN_ARRAY
+]);
 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,
-    CheckboxStruct
-  ])
+  children: FieldChildStruct
 });
+var FormChildStruct = children(
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
+  [FieldStruct, (0, import_superstruct18.lazy)(() => BoxChildStruct)]
+);
 var FormStruct2 = element("Form", {
-  children: children(
-    // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    [FieldStruct, (0, import_superstruct18.lazy)(() => BoxChildStruct)]
-  ),
+  children: FormChildStruct,
   name: (0, import_superstruct18.string)()
 });
 var BoldStruct = element("Bold", {
@@ -914,13 +960,14 @@ var FormattingStruct = nullUnion([
   ItalicStruct
 ]);
 var AddressStruct2 = element("Address", {
-  address: import_utils6.HexChecksumAddressStruct
+  address: import_utils7.HexChecksumAddressStruct
 });
+var BoxChildrenStruct = children(
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
+  [(0, import_superstruct18.lazy)(() => BoxChildStruct)]
+);
 var BoxStruct = element("Box", {
-  children: children(
-    // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    [(0, import_superstruct18.lazy)(() => BoxChildStruct)]
-  ),
+  children: BoxChildrenStruct,
   direction: (0, import_superstruct18.optional)(nullUnion([literal("horizontal"), literal("vertical")])),
   alignment: (0, import_superstruct18.optional)(
     nullUnion([
@@ -932,6 +979,23 @@ var BoxStruct = element("Box", {
     ])
   )
 });
+var FooterChildStruct = nullUnion([
+  (0, import_superstruct18.tuple)([ButtonStruct2, ButtonStruct2]),
+  ButtonStruct2
+]);
+var FooterStruct = element("Footer", {
+  children: FooterChildStruct
+});
+var ContainerChildStruct = nullUnion([
+  (0, import_superstruct18.tuple)([BoxStruct, FooterStruct]),
+  BoxStruct
+]);
+var ContainerStruct = element(
+  "Container",
+  {
+    children: ContainerChildStruct
+  }
+);
 var CopyableStruct2 = element("Copyable", {
   value: (0, import_superstruct18.string)(),
   sensitive: (0, import_superstruct18.optional)((0, import_superstruct18.boolean)())
@@ -941,6 +1005,13 @@ var ValueStruct = element("Value", {
   value: (0, import_superstruct18.string)(),
   extra: (0, import_superstruct18.string)()
 });
+var CardStruct = element("Card", {
+  image: (0, import_superstruct18.optional)((0, import_superstruct18.string)()),
+  title: (0, import_superstruct18.string)(),
+  description: (0, import_superstruct18.optional)((0, import_superstruct18.string)()),
+  value: (0, import_superstruct18.string)(),
+  extra: (0, import_superstruct18.optional)((0, import_superstruct18.string)())
+});
 var HeadingStruct2 = element("Heading", {
   children: StringElementStruct
 });
@@ -986,7 +1057,7 @@ var RowStruct2 = element("Row", {
   tooltip: (0, import_superstruct18.optional)((0, import_superstruct18.string)())
 });
 var SpinnerStruct2 = element("Spinner");
-var BoxChildStruct = nullUnion([
+var BoxChildStruct = typedUnion([
   AddressStruct2,
   BoldStruct,
   BoxStruct,
@@ -1005,10 +1076,14 @@ var BoxChildStruct = nullUnion([
   SpinnerStruct2,
   TextStruct2,
   TooltipStruct,
-  CheckboxStruct
+  CheckboxStruct,
+  CardStruct
+]);
+var RootJSXElementStruct = nullUnion([
+  BoxChildStruct,
+  ContainerStruct
 ]);
-var RootJSXElementStruct = BoxChildStruct;
-var JSXElementStruct = nullUnion([
+var JSXElementStruct = typedUnion([
   ButtonStruct2,
   InputStruct2,
   FileInputStruct,
@@ -1030,7 +1105,10 @@ var JSXElementStruct = nullUnion([
   OptionStruct,
   ValueStruct,
   TooltipStruct,
-  CheckboxStruct
+  CheckboxStruct,
+  FooterStruct,
+  ContainerStruct,
+  CardStruct
 ]);
 
 // src/types/interface.ts
@@ -1044,5 +1122,5 @@ var ComponentOrElementStruct = (0, import_superstruct19.union)([
   ComponentStruct,
   RootJSXElementStruct
 ]);
-var InterfaceContextStruct = (0, import_superstruct19.record)((0, import_superstruct19.string)(), import_utils7.JsonStruct);
+var InterfaceContextStruct = (0, import_superstruct19.record)((0, import_superstruct19.string)(), import_utils8.JsonStruct);
 //# sourceMappingURL=index.js.map