@metamask/snaps-utils 4.0.0 → 5.0.0

package/dist/types/manifest/validation.d.ts

@@ -66,9 +66,9 @@ export declare const PermissionsStruct: Struct<{
         jobs: {
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
             };
             expression: string;
         }[];
@@ -95,9 +95,9 @@ export declare const PermissionsStruct: Struct<{
         jobs: {
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
             };
             expression: string;
         }[];
@@ -105,31 +105,31 @@ export declare const PermissionsStruct: Struct<{
         jobs: Struct<{
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
             };
             expression: string;
         }[], Struct<{
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
             };
             expression: string;
         }, {
             expression: Struct<string, null>;
             request: Struct<{
                 method: string;
-                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
             }, {
-                params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
+                jsonrpc: Struct<"2.0" | undefined, "2.0">;
+                id: Struct<string | number | null | undefined, null>;
                 method: Struct<string, null>;
-                id: Struct<string | number | null | undefined, unknown>;
-                jsonrpc: Struct<"2.0" | undefined, unknown>;
+                params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
             }>;
         }>>;
     }>;
@@ -239,9 +239,9 @@ export declare const SnapManifestStruct: Struct<{
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 };
                 expression: string;
             }[];
@@ -340,9 +340,9 @@ export declare const SnapManifestStruct: Struct<{
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 };
                 expression: string;
             }[];
@@ -369,9 +369,9 @@ export declare const SnapManifestStruct: Struct<{
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 };
                 expression: string;
             }[];
@@ -379,31 +379,31 @@ export declare const SnapManifestStruct: Struct<{
             jobs: Struct<{
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 };
                 expression: string;
             }[], Struct<{
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 };
                 expression: string;
             }, {
                 expression: Struct<string, null>;
                 request: Struct<{
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 }, {
-                    params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
+                    jsonrpc: Struct<"2.0" | undefined, "2.0">;
+                    id: Struct<string | number | null | undefined, null>;
                     method: Struct<string, null>;
-                    id: Struct<string | number | null | undefined, unknown>;
-                    jsonrpc: Struct<"2.0" | undefined, unknown>;
+                    params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
                 }>;
             }>>;
         }>;

package/dist/types/structs.d.ts

@@ -1,6 +1,6 @@
-import type { Failure, Infer } from 'superstruct';
+import type { Failure } from 'superstruct';
 import { Struct, StructError } from 'superstruct';
-import type { AnyStruct, InferStructTuple } from 'superstruct/dist/utils';
+import type { AnyStruct } from 'superstruct/dist/utils';
 /**
  * Infer a struct type, only if it matches the specified type. This is useful
  * for defining types and structs that are related to each other in separate
@@ -24,44 +24,6 @@ import type { AnyStruct, InferStructTuple } from 'superstruct/dist/utils';
  * ```
  */
 export declare type InferMatching<StructType extends Struct<any, any>, Type> = StructType['TYPE'] extends Type ? Type : never;
-/**
- * A wrapper of `superstruct`'s `literal` struct that also defines the name of
- * the struct as the literal value.
- *
- * This is useful for improving the error messages returned by `superstruct`.
- * For example, instead of returning an error like:
- *
- * ```
- * Expected the value to satisfy a union of `literal | literal`, but received: \"baz\"
- * ```
- *
- * This struct will return an error like:
- *
- * ```
- * Expected the value to satisfy a union of `"foo" | "bar"`, but received: \"baz\"
- * ```
- *
- * @param value - The literal value.
- * @returns The `superstruct` struct, which validates that the value is equal
- * to the literal value.
- */
-export declare function literal<Type extends string | number | boolean>(value: Type): Struct<Type, null>;
-/**
- * A wrapper of `superstruct`'s `union` struct that also defines the schema as
- * the union of the schemas of the structs.
- *
- * This is useful for improving the error messages returned by `superstruct`.
- *
- * @param structs - The structs to union.
- * @param structs."0" - The first struct.
- * @param structs."1" - The remaining structs.
- * @returns The `superstruct` struct, which validates that the value satisfies
- * one of the structs.
- */
-export declare function union<Head extends AnyStruct, Tail extends AnyStruct[]>([head, ...tail]: [head: Head, ...tail: Tail]): Struct<Infer<Head> | InferStructTuple<Tail>[number], [
-    head: Head,
-    ...tail: Tail
-]>;
 /**
  * A wrapper of `superstruct`'s `string` struct that coerces a value to a string
  * and resolves it relative to the current working directory. This is useful

package/dist/types/ui.d.ts

@@ -1,6 +1,6 @@
 import type { Component } from '@metamask/snaps-sdk';
 /**
- * Search for links in a sting and check them against the phishing list.
+ * Searches for markdown links in a string and checks them against the phishing list.
  *
  * @param text - The text to verify.
  * @param isOnPhishingList - The function that checks the link against the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-utils",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -69,11 +69,11 @@
     "@babel/types": "^7.23.0",
     "@metamask/base-controller": "^3.2.0",
     "@metamask/key-tree": "^9.0.0",
-    "@metamask/permission-controller": "^5.0.0",
+    "@metamask/permission-controller": "^5.0.1",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-registry": "^2.1.0",
-    "@metamask/snaps-sdk": "^1.0.0",
-    "@metamask/utils": "^8.1.0",
+    "@metamask/snaps-sdk": "^1.2.0",
+    "@metamask/utils": "^8.2.1",
     "@noble/hashes": "^1.3.1",
     "@scure/base": "^1.1.1",
     "chalk": "^4.1.2",

package/dist/cjs/enum.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "enumValue", {
-    enumerable: true,
-    get: function() {
-        return enumValue;
-    }
-});
-const _structs = require("./structs");
-function enumValue(constant) {
-    return (0, _structs.literal)(constant);
-}
-
-//# sourceMappingURL=enum.js.map

package/dist/cjs/enum.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/enum.ts"],"sourcesContent":["import type { EnumToUnion } from '@metamask/snaps-sdk';\nimport type { Struct } from 'superstruct';\n\nimport { literal } from './structs';\n\n/**\n * Superstruct struct for validating an enum value. This allows using both the\n * enum string values and the enum itself as values.\n *\n * @param constant - The enum to validate against.\n * @returns The superstruct struct.\n */\nexport function enumValue<Type extends string>(\n  constant: Type,\n): Struct<EnumToUnion<Type>, null> {\n  return literal(constant as EnumToUnion<Type>);\n}\n"],"names":["enumValue","constant","literal"],"mappings":";;;;+BAYgBA;;;eAAAA;;;yBATQ;AASjB,SAASA,UACdC,QAAc;IAEd,OAAOC,IAAAA,gBAAO,EAACD;AACjB"}

package/dist/esm/enum.js

@@ -1,12 +0,0 @@
-import { literal } from './structs';
-/**
- * Superstruct struct for validating an enum value. This allows using both the
- * enum string values and the enum itself as values.
- *
- * @param constant - The enum to validate against.
- * @returns The superstruct struct.
- */ export function enumValue(constant) {
-    return literal(constant);
-}
-
-//# sourceMappingURL=enum.js.map

package/dist/esm/enum.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/enum.ts"],"sourcesContent":["import type { EnumToUnion } from '@metamask/snaps-sdk';\nimport type { Struct } from 'superstruct';\n\nimport { literal } from './structs';\n\n/**\n * Superstruct struct for validating an enum value. This allows using both the\n * enum string values and the enum itself as values.\n *\n * @param constant - The enum to validate against.\n * @returns The superstruct struct.\n */\nexport function enumValue<Type extends string>(\n  constant: Type,\n): Struct<EnumToUnion<Type>, null> {\n  return literal(constant as EnumToUnion<Type>);\n}\n"],"names":["literal","enumValue","constant"],"mappings":"AAGA,SAASA,OAAO,QAAQ,YAAY;AAEpC;;;;;;CAMC,GACD,OAAO,SAASC,UACdC,QAAc;IAEd,OAAOF,QAAQE;AACjB"}

package/dist/types/enum.d.ts

@@ -1,10 +0,0 @@
-import type { EnumToUnion } from '@metamask/snaps-sdk';
-import type { Struct } from 'superstruct';
-/**
- * Superstruct struct for validating an enum value. This allows using both the
- * enum string values and the enum itself as values.
- *
- * @param constant - The enum to validate against.
- * @returns The superstruct struct.
- */
-export declare function enumValue<Type extends string>(constant: Type): Struct<EnumToUnion<Type>, null>;