@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/manifest/validation.d.mts

@@ -0,0 +1,254 @@
+import type { SupportedCurve } from "@metamask/key-tree";
+import type { EmptyObject, InitialPermissions } from "@metamask/snaps-sdk";
+import type { Describe, Infer, Struct } from "@metamask/superstruct";
+import { type InferMatching } from "../structs.mjs";
+export declare const FORBIDDEN_COIN_TYPES: number[];
+export declare const Bip32PathStruct: Struct<string[], Struct<string, null>>;
+export declare const bip32entropy: <Type extends {
+    path: string[];
+    curve: string;
+}, Schema>(struct: Struct<Type, Schema>) => Struct<Type, Schema>;
+export declare const CurveStruct: Describe<SupportedCurve>;
+export declare const Bip32EntropyStruct: Struct<{
+    curve: "ed25519" | "ed25519Bip32" | "secp256k1";
+    path: string[];
+}, {
+    path: Struct<string[], Struct<string, null>>;
+    curve: Describe<"ed25519" | "ed25519Bip32" | "secp256k1">;
+}>;
+export type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;
+export declare const SnapGetBip32EntropyPermissionsStruct: Struct<{
+    curve: "ed25519" | "ed25519Bip32" | "secp256k1";
+    path: string[];
+}[], Struct<{
+    curve: "ed25519" | "ed25519Bip32" | "secp256k1";
+    path: string[];
+}, {
+    path: Struct<string[], Struct<string, null>>;
+    curve: Describe<"ed25519" | "ed25519Bip32" | "secp256k1">;
+}>>;
+export declare const SemVerRangeStruct: Struct<string, null>;
+export declare const SnapIdsStruct: Struct<Record<string, {
+    version?: string | undefined;
+}>, null>;
+export type SnapIds = Infer<typeof SnapIdsStruct>;
+export declare const ChainIdsStruct: Struct<`${string}:${string}`[], Struct<`${string}:${string}`, null>>;
+export declare const LookupMatchersStruct: Struct<{
+    tlds: string[];
+} | {
+    schemes: string[];
+} | {
+    tlds: string[];
+    schemes: string[];
+}, null>;
+export declare const MINIMUM_REQUEST_TIMEOUT: number;
+export declare const MAXIMUM_REQUEST_TIMEOUT: number;
+export declare const MaxRequestTimeStruct: Struct<number, null>;
+export declare const HandlerCaveatsStruct: Struct<{
+    maxRequestTime?: number | undefined;
+}, {
+    maxRequestTime: Struct<number | undefined, null>;
+}>;
+export type HandlerCaveats = Infer<typeof HandlerCaveatsStruct>;
+export declare const EmptyObjectStruct: Struct<EmptyObject, null>;
+export declare const PermissionsStruct: Describe<InitialPermissions>;
+export type SnapPermissions = InferMatching<typeof PermissionsStruct, InitialPermissions>;
+export declare const SnapAuxilaryFilesStruct: Struct<string[], Struct<string, null>>;
+export declare const InitialConnectionsStruct: Struct<Record<string & URL, {}>, null>;
+export type InitialConnections = Infer<typeof InitialConnectionsStruct>;
+export declare const SnapManifestStruct: Struct<{
+    source: {
+        location: {
+            npm: {
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                filePath: string;
+                packageName: string;
+                iconPath?: string | undefined;
+            };
+        };
+        shasum: string;
+        files?: string[] | undefined;
+        locales?: string[] | undefined;
+    };
+    description: string;
+    version: import("@metamask/utils").SemVerVersion;
+    proposedName: string;
+    initialPermissions: Partial<{
+        'endowment:cronjob': {
+            jobs: import("@metamask/snaps-sdk").Cronjob[];
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:ethereum-provider': EmptyObject;
+        'endowment:keyring': {
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:lifecycle-hooks'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:name-lookup': {
+            chains?: `${string}:${string}`[] | undefined;
+            matchers?: import("@metamask/snaps-sdk").NameLookupMatchers | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:network-access': EmptyObject;
+        'endowment:page-home'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:rpc': {
+            dapps?: boolean | undefined;
+            snaps?: boolean | undefined;
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:signature-insight': {
+            allowSignatureOrigin?: boolean | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:transaction-insight': {
+            allowTransactionOrigin?: boolean | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:webassembly': EmptyObject;
+        snap_dialog: EmptyObject;
+        snap_getBip32Entropy: import("@metamask/snaps-sdk").Bip32Entropy[];
+        snap_getBip32PublicKey: import("@metamask/snaps-sdk").Bip32Entropy[];
+        snap_getBip44Entropy: import("@metamask/snaps-sdk").Bip44Entropy[];
+        snap_getEntropy: EmptyObject;
+        snap_getLocale: EmptyObject;
+        snap_manageAccounts: EmptyObject;
+        snap_manageState: EmptyObject;
+        snap_notify: EmptyObject;
+        wallet_snap: Record<string, import("@metamask/snaps-sdk").RequestedSnap>;
+    }>;
+    manifestVersion: "0.1";
+    repository?: {
+        type: string;
+        url: string;
+    } | undefined;
+    initialConnections?: Record<string & URL, {}> | undefined;
+    $schema?: string | undefined;
+}, {
+    version: Struct<import("@metamask/utils").SemVerVersion, null>;
+    description: Struct<string, null>;
+    proposedName: Struct<string, null>;
+    repository: Struct<{
+        type: string;
+        url: string;
+    } | undefined, {
+        type: Struct<string, null>;
+        url: Struct<string, null>;
+    }>;
+    source: Struct<{
+        location: {
+            npm: {
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                filePath: string;
+                packageName: string;
+                iconPath?: string | undefined;
+            };
+        };
+        shasum: string;
+        files?: string[] | undefined;
+        locales?: string[] | undefined;
+    }, {
+        shasum: Struct<string, null>;
+        location: Struct<{
+            npm: {
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                filePath: string;
+                packageName: string;
+                iconPath?: string | undefined;
+            };
+        }, {
+            npm: Struct<{
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                filePath: string;
+                packageName: string;
+                iconPath?: string | undefined;
+            }, {
+                filePath: Struct<string, null>;
+                iconPath: Struct<string | undefined, null>;
+                packageName: Struct<string, null>;
+                registry: Struct<"https://registry.npmjs.org" | "https://registry.npmjs.org/", null>;
+            }>;
+        }>;
+        files: Struct<string[] | undefined, Struct<string, null>>;
+        locales: Struct<string[] | undefined, Struct<string, null>>;
+    }>;
+    initialConnections: Struct<Record<string & URL, {}> | undefined, null>;
+    initialPermissions: Describe<Partial<{
+        'endowment:cronjob': {
+            jobs: import("@metamask/snaps-sdk").Cronjob[];
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:ethereum-provider': EmptyObject;
+        'endowment:keyring': {
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:lifecycle-hooks'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:name-lookup': {
+            chains?: `${string}:${string}`[] | undefined;
+            matchers?: import("@metamask/snaps-sdk").NameLookupMatchers | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:network-access': EmptyObject;
+        'endowment:page-home'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:rpc': {
+            dapps?: boolean | undefined;
+            snaps?: boolean | undefined;
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:signature-insight': {
+            allowSignatureOrigin?: boolean | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:transaction-insight': {
+            allowTransactionOrigin?: boolean | undefined;
+            maxRequestTime?: number | undefined;
+        };
+        'endowment:webassembly': EmptyObject;
+        snap_dialog: EmptyObject;
+        snap_getBip32Entropy: import("@metamask/snaps-sdk").Bip32Entropy[];
+        snap_getBip32PublicKey: import("@metamask/snaps-sdk").Bip32Entropy[];
+        snap_getBip44Entropy: import("@metamask/snaps-sdk").Bip44Entropy[];
+        snap_getEntropy: EmptyObject;
+        snap_getLocale: EmptyObject;
+        snap_manageAccounts: EmptyObject;
+        snap_manageState: EmptyObject;
+        snap_notify: EmptyObject;
+        wallet_snap: Record<string, import("@metamask/snaps-sdk").RequestedSnap>;
+    }>>;
+    manifestVersion: Struct<"0.1", "0.1">;
+    $schema: Struct<string | undefined, null>;
+}>;
+export type SnapManifest = Infer<typeof SnapManifestStruct>;
+/**
+ * Check if the given value is a valid {@link SnapManifest} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link SnapManifest} object.
+ */
+export declare function isSnapManifest(value: unknown): value is SnapManifest;
+/**
+ * Assert that the given value is a valid {@link SnapManifest} object.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid {@link SnapManifest} object.
+ */
+export declare function assertIsSnapManifest(value: unknown): asserts value is SnapManifest;
+/**
+ * Creates a {@link SnapManifest} object from JSON.
+ *
+ * @param value - The value to check.
+ * @throws If the value cannot be coerced to a {@link SnapManifest} object.
+ * @returns The created {@link SnapManifest} object.
+ */
+export declare function createSnapManifest(value: unknown): SnapManifest;
+//# sourceMappingURL=validation.d.mts.map

package/dist/manifest/validation.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.mts","sourceRoot":"","sources":["../../src/manifest/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,2BAA2B;AAEzD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,4BAA4B;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAkCrE,OAAO,EAAgB,KAAK,aAAa,EAAE,uBAAmB;AAU9D,eAAO,MAAM,oBAAoB,EAAE,MAAM,EAAS,CAAC;AAOnD,eAAO,MAAM,eAAe,wCAoC3B,CAAC;AAEF,eAAO,MAAM,YAAY;UACF,MAAM,EAAE;WAAS,MAAM;gEAc1C,CAAC;AAEL,eAAO,MAAM,WAAW,EAAE,QAAQ,CAAC,cAAc,CAI/C,CAAC;AAGH,eAAO,MAAM,kBAAkB;;;;;;EAK9B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE5D,eAAO,MAAM,oCAAoC;;;;;;;;;GAIhD,CAAC;AAEF,eAAO,MAAM,iBAAiB,sBAK5B,CAAC;AAEH,eAAO,MAAM,aAAa;;SAUzB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAElD,eAAO,MAAM,cAAc,sEAA0C,CAAC;AAEtE,eAAO,MAAM,oBAAoB;;;;;;;QAW/B,CAAC;AAEH,eAAO,MAAM,uBAAuB,QAAqC,CAAC;AAC1E,eAAO,MAAM,uBAAuB,QAAqC,CAAC;AAE1E,eAAO,MAAM,oBAAoB,sBAIhC,CAAC;AAGF,eAAO,MAAM,oBAAoB;;;;EAE/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEhE,eAAO,MAAM,iBAAiB,2BAG7B,CAAC;AAGF,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CA2DzD,CAAC;AAGH,MAAM,MAAM,eAAe,GAAG,aAAa,CACzC,OAAO,iBAAiB,EACxB,kBAAkB,CACnB,CAAC;AAEF,eAAO,MAAM,uBAAuB,wCAAkB,CAAC;AAEvD,eAAO,MAAM,wBAAwB,wCAGpC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8B7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE5D;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAEpE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,YAAY,CAM/B;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAG/D"}

package/dist/manifest/validation.mjs

@@ -1,64 +1,187 @@
-import {
-  Bip32EntropyStruct,
-  Bip32PathStruct,
-  ChainIdsStruct,
-  CurveStruct,
-  EmptyObjectStruct,
-  FORBIDDEN_COIN_TYPES,
-  HandlerCaveatsStruct,
-  InitialConnectionsStruct,
-  LookupMatchersStruct,
-  MAXIMUM_REQUEST_TIMEOUT,
-  MINIMUM_REQUEST_TIMEOUT,
-  MaxRequestTimeStruct,
-  PermissionsStruct,
-  SemVerRangeStruct,
-  SnapAuxilaryFilesStruct,
-  SnapGetBip32EntropyPermissionsStruct,
-  SnapIdsStruct,
-  SnapManifestStruct,
-  assertIsSnapManifest,
-  bip32entropy,
-  createSnapManifest,
-  isSnapManifest
-} from "../chunk-GXSTPU7D.mjs";
-import "../chunk-NSVVZNSD.mjs";
-import "../chunk-3N27GIUS.mjs";
-import "../chunk-IV3FSWZ7.mjs";
-import "../chunk-N2JAYIUP.mjs";
-import "../chunk-LHQP7CUJ.mjs";
-import "../chunk-ANYNWSCA.mjs";
-import "../chunk-AS5P6JRP.mjs";
-import "../chunk-P252LKUT.mjs";
-import "../chunk-7LG4D4XA.mjs";
-import "../chunk-XF2AZMWG.mjs";
-import "../chunk-3S4INAGA.mjs";
-import "../chunk-DE22V5AO.mjs";
-import "../chunk-Z2JQNSVL.mjs";
-import "../chunk-YJHQZFR4.mjs";
-import "../chunk-3RUWAMJT.mjs";
-export {
-  Bip32EntropyStruct,
-  Bip32PathStruct,
-  ChainIdsStruct,
-  CurveStruct,
-  EmptyObjectStruct,
-  FORBIDDEN_COIN_TYPES,
-  HandlerCaveatsStruct,
-  InitialConnectionsStruct,
-  LookupMatchersStruct,
-  MAXIMUM_REQUEST_TIMEOUT,
-  MINIMUM_REQUEST_TIMEOUT,
-  MaxRequestTimeStruct,
-  PermissionsStruct,
-  SemVerRangeStruct,
-  SnapAuxilaryFilesStruct,
-  SnapGetBip32EntropyPermissionsStruct,
-  SnapIdsStruct,
-  SnapManifestStruct,
-  assertIsSnapManifest,
-  bip32entropy,
-  createSnapManifest,
-  isSnapManifest
-};
+import { isValidBIP32PathSegment } from "@metamask/key-tree";
+import { array, boolean, create, enums, integer, is, literal, object, optional, refine, record, size, string, type, union, intersection } from "@metamask/superstruct";
+import { assertStruct, ChecksumStruct, VersionStruct, isValidSemVerRange, inMilliseconds, Duration } from "@metamask/utils";
+import { isEqual } from "../array.mjs";
+import { CronjobSpecificationArrayStruct } from "../cronjob.mjs";
+import { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from "../entropy.mjs";
+import { KeyringOriginsStruct, RpcOriginsStruct } from "../json-rpc.mjs";
+import { ChainIdStruct } from "../namespace.mjs";
+import { SnapIdStruct } from "../snaps.mjs";
+import { mergeStructs } from "../structs.mjs";
+import { NameStruct, NpmSnapFileNames, uri } from "../types.mjs";
+// BIP-43 purposes that cannot be used for entropy derivation. These are in the
+// string form, ending with `'`.
+const FORBIDDEN_PURPOSES = [
+    SIP_6_MAGIC_VALUE,
+    STATE_ENCRYPTION_MAGIC_VALUE,
+];
+export const FORBIDDEN_COIN_TYPES = [60];
+const FORBIDDEN_PATHS = FORBIDDEN_COIN_TYPES.map((coinType) => [
+    'm',
+    "44'",
+    `${coinType}'`,
+]);
+export const Bip32PathStruct = refine(array(string()), 'BIP-32 path', (path) => {
+    if (path.length === 0) {
+        return 'Path must be a non-empty BIP-32 derivation path array';
+    }
+    if (path[0] !== 'm') {
+        return 'Path must start with "m".';
+    }
+    if (path.length < 3) {
+        return 'Paths must have a length of at least three.';
+    }
+    if (path.slice(1).some((part) => !isValidBIP32PathSegment(part))) {
+        return 'Path must be a valid BIP-32 derivation path array.';
+    }
+    if (FORBIDDEN_PURPOSES.includes(path[1])) {
+        return `The purpose "${path[1]}" is not allowed for entropy derivation.`;
+    }
+    if (FORBIDDEN_PATHS.some((forbiddenPath) => isEqual(path.slice(0, forbiddenPath.length), forbiddenPath))) {
+        return `The path "${path.join('/')}" is not allowed for entropy derivation.`;
+    }
+    return true;
+});
+export const bip32entropy = (struct) => refine(struct, 'BIP-32 entropy', (value) => {
+    if (value.curve === 'ed25519' &&
+        value.path.slice(1).some((part) => !part.endsWith("'"))) {
+        return 'Ed25519 does not support unhardened paths.';
+    }
+    return true;
+});
+export const CurveStruct = enums([
+    'ed25519',
+    'secp256k1',
+    'ed25519Bip32',
+]);
+// Used outside @metamask/snap-utils
+export const Bip32EntropyStruct = bip32entropy(type({
+    path: Bip32PathStruct,
+    curve: CurveStruct,
+}));
+export const SnapGetBip32EntropyPermissionsStruct = size(array(Bip32EntropyStruct), 1, Infinity);
+export const SemVerRangeStruct = refine(string(), 'SemVer range', (value) => {
+    if (isValidSemVerRange(value)) {
+        return true;
+    }
+    return 'Expected a valid SemVer range.';
+});
+export const SnapIdsStruct = refine(record(SnapIdStruct, object({ version: optional(SemVerRangeStruct) })), 'SnapIds', (value) => {
+    if (Object.keys(value).length === 0) {
+        return false;
+    }
+    return true;
+});
+export const ChainIdsStruct = size(array(ChainIdStruct), 1, Infinity);
+export const LookupMatchersStruct = union([
+    object({
+        tlds: size(array(string()), 1, Infinity),
+    }),
+    object({
+        schemes: size(array(string()), 1, Infinity),
+    }),
+    object({
+        tlds: size(array(string()), 1, Infinity),
+        schemes: size(array(string()), 1, Infinity),
+    }),
+]);
+export const MINIMUM_REQUEST_TIMEOUT = inMilliseconds(5, Duration.Second);
+export const MAXIMUM_REQUEST_TIMEOUT = inMilliseconds(3, Duration.Minute);
+export const MaxRequestTimeStruct = size(integer(), MINIMUM_REQUEST_TIMEOUT, MAXIMUM_REQUEST_TIMEOUT);
+// Utility type to union with for all handler structs
+export const HandlerCaveatsStruct = object({
+    maxRequestTime: optional(MaxRequestTimeStruct),
+});
+export const EmptyObjectStruct = object({});
+/* eslint-disable @typescript-eslint/naming-convention */
+export const PermissionsStruct = type({
+    'endowment:cronjob': optional(mergeStructs(HandlerCaveatsStruct, object({ jobs: CronjobSpecificationArrayStruct }))),
+    'endowment:ethereum-provider': optional(EmptyObjectStruct),
+    'endowment:keyring': optional(mergeStructs(HandlerCaveatsStruct, KeyringOriginsStruct)),
+    'endowment:lifecycle-hooks': optional(HandlerCaveatsStruct),
+    'endowment:name-lookup': optional(mergeStructs(HandlerCaveatsStruct, object({
+        chains: optional(ChainIdsStruct),
+        matchers: optional(LookupMatchersStruct),
+    }))),
+    'endowment:network-access': optional(EmptyObjectStruct),
+    'endowment:page-home': optional(HandlerCaveatsStruct),
+    'endowment:rpc': optional(mergeStructs(HandlerCaveatsStruct, RpcOriginsStruct)),
+    'endowment:signature-insight': optional(mergeStructs(HandlerCaveatsStruct, object({
+        allowSignatureOrigin: optional(boolean()),
+    }))),
+    'endowment:transaction-insight': optional(mergeStructs(HandlerCaveatsStruct, object({
+        allowTransactionOrigin: optional(boolean()),
+    }))),
+    'endowment:webassembly': optional(EmptyObjectStruct),
+    snap_dialog: optional(EmptyObjectStruct),
+    snap_manageState: optional(EmptyObjectStruct),
+    snap_manageAccounts: optional(EmptyObjectStruct),
+    snap_notify: optional(EmptyObjectStruct),
+    snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),
+    snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),
+    snap_getBip44Entropy: optional(size(array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })), 1, Infinity)),
+    snap_getEntropy: optional(EmptyObjectStruct),
+    snap_getLocale: optional(EmptyObjectStruct),
+    wallet_snap: optional(SnapIdsStruct),
+});
+export const SnapAuxilaryFilesStruct = array(string());
+export const InitialConnectionsStruct = record(intersection([string(), uri()]), object({}));
+export const SnapManifestStruct = object({
+    version: VersionStruct,
+    description: size(string(), 1, 280),
+    proposedName: size(string(), 1, 214),
+    repository: optional(object({
+        type: size(string(), 1, Infinity),
+        url: size(string(), 1, Infinity),
+    })),
+    source: object({
+        shasum: ChecksumStruct,
+        location: object({
+            npm: object({
+                filePath: size(string(), 1, Infinity),
+                iconPath: optional(size(string(), 1, Infinity)),
+                packageName: NameStruct,
+                registry: union([
+                    literal('https://registry.npmjs.org'),
+                    literal('https://registry.npmjs.org/'),
+                ]),
+            }),
+        }),
+        files: optional(SnapAuxilaryFilesStruct),
+        locales: optional(SnapAuxilaryFilesStruct),
+    }),
+    initialConnections: optional(InitialConnectionsStruct),
+    initialPermissions: PermissionsStruct,
+    manifestVersion: literal('0.1'),
+    $schema: optional(string()), // enables JSON-Schema linting in VSC and other IDEs
+});
+/**
+ * Check if the given value is a valid {@link SnapManifest} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link SnapManifest} object.
+ */
+export function isSnapManifest(value) {
+    return is(value, SnapManifestStruct);
+}
+/**
+ * Assert that the given value is a valid {@link SnapManifest} object.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid {@link SnapManifest} object.
+ */
+export function assertIsSnapManifest(value) {
+    assertStruct(value, SnapManifestStruct, `"${NpmSnapFileNames.Manifest}" is invalid`);
+}
+/**
+ * Creates a {@link SnapManifest} object from JSON.
+ *
+ * @param value - The value to check.
+ * @throws If the value cannot be coerced to a {@link SnapManifest} object.
+ * @returns The created {@link SnapManifest} object.
+ */
+export function createSnapManifest(value) {
+    // TODO: Add a utility to prefix these errors similar to assertStruct
+    return create(value, SnapManifestStruct);
+}
 //# sourceMappingURL=validation.mjs.map

package/dist/manifest/validation.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"validation.mjs","sourceRoot":"","sources":["../../src/manifest/validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,2BAA2B;AAG7D,OAAO,EACL,KAAK,EACL,OAAO,EACP,MAAM,EACN,KAAK,EACL,OAAO,EACP,EAAE,EACF,OAAO,EACP,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,IAAI,EACJ,MAAM,EACN,IAAI,EACJ,KAAK,EACL,YAAY,EACb,8BAA8B;AAC/B,OAAO,EACL,YAAY,EACZ,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,QAAQ,EACT,wBAAwB;AAEzB,OAAO,EAAE,OAAO,EAAE,qBAAiB;AACnC,OAAO,EAAE,+BAA+B,EAAE,uBAAmB;AAC7D,OAAO,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,uBAAmB;AAC7E,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,wBAAoB;AACrE,OAAO,EAAE,aAAa,EAAE,yBAAqB;AAC7C,OAAO,EAAE,YAAY,EAAE,qBAAiB;AACxC,OAAO,EAAE,YAAY,EAAsB,uBAAmB;AAC9D,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,EAAE,qBAAiB;AAE7D,+EAA+E;AAC/E,gCAAgC;AAChC,MAAM,kBAAkB,GAAa;IACnC,iBAAiB;IACjB,4BAA4B;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAa,CAAC,EAAE,CAAC,CAAC;AACnD,MAAM,eAAe,GAAe,oBAAoB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;IACzE,GAAG;IACH,KAAK;IACL,GAAG,QAAQ,GAAG;CACf,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CACnC,KAAK,CAAC,MAAM,EAAE,CAAC,EACf,aAAa,EACb,CAAC,IAAc,EAAE,EAAE;IACjB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,uDAAuD,CAAC;IACjE,CAAC;IAED,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACpB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,6CAA6C,CAAC;IACvD,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACjE,OAAO,oDAAoD,CAAC;IAC9D,CAAC;IAED,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,OAAO,gBAAgB,IAAI,CAAC,CAAC,CAAC,0CAA0C,CAAC;IAC3E,CAAC;IAED,IACE,eAAe,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CACrC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,CAC5D,EACD,CAAC;QACD,OAAO,aAAa,IAAI,CAAC,IAAI,CAC3B,GAAG,CACJ,0CAA0C,CAAC;IAC9C,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAI1B,MAA4B,EAC5B,EAAE,CACF,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE;IACzC,IACE,KAAK,CAAC,KAAK,KAAK,SAAS;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvD,CAAC;QACD,OAAO,4CAA4C,CAAC;IACtD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,WAAW,GAA6B,KAAK,CAAC;IACzD,SAAS;IACT,WAAW;IACX,cAAc;CACf,CAAC,CAAC;AAEH,oCAAoC;AACpC,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAC5C,IAAI,CAAC;IACH,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,WAAW;CACnB,CAAC,CACH,CAAC;AAIF,MAAM,CAAC,MAAM,oCAAoC,GAAG,IAAI,CACtD,KAAK,CAAC,kBAAkB,CAAC,EACzB,CAAC,EACD,QAAQ,CACT,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE;IAC1E,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,gCAAgC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CACjC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,EACtE,SAAS,EACT,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAIF,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AAEtE,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CAAC;IACxC,MAAM,CAAC;QACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;KACzC,CAAC;IACF,MAAM,CAAC;QACL,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;KAC5C,CAAC;IACF,MAAM,CAAC;QACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;QACxC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;KAC5C,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1E,MAAM,CAAC,MAAM,uBAAuB,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;AAE1E,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CACtC,OAAO,EAAE,EACT,uBAAuB,EACvB,uBAAuB,CACxB,CAAC;AAEF,qDAAqD;AACrD,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;IACzC,cAAc,EAAE,QAAQ,CAAC,oBAAoB,CAAC;CAC/C,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAc,EAAE,CAGtD,CAAC;AAEF,yDAAyD;AACzD,MAAM,CAAC,MAAM,iBAAiB,GAAiC,IAAI,CAAC;IAClE,mBAAmB,EAAE,QAAQ,CAC3B,YAAY,CACV,oBAAoB,EACpB,MAAM,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC,CAClD,CACF;IACD,6BAA6B,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC1D,mBAAmB,EAAE,QAAQ,CAC3B,YAAY,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CACzD;IACD,2BAA2B,EAAE,QAAQ,CAAC,oBAAoB,CAAC;IAC3D,uBAAuB,EAAE,QAAQ,CAC/B,YAAY,CACV,oBAAoB,EACpB,MAAM,CAAC;QACL,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC;QAChC,QAAQ,EAAE,QAAQ,CAAC,oBAAoB,CAAC;KACzC,CAAC,CACH,CACF;IACD,0BAA0B,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IACvD,qBAAqB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;IACrD,eAAe,EAAE,QAAQ,CACvB,YAAY,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CACrD;IACD,6BAA6B,EAAE,QAAQ,CACrC,YAAY,CACV,oBAAoB,EACpB,MAAM,CAAC;QACL,oBAAoB,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;KAC1C,CAAC,CACH,CACF;IACD,+BAA+B,EAAE,QAAQ,CACvC,YAAY,CACV,oBAAoB,EACpB,MAAM,CAAC;QACL,sBAAsB,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;KAC5C,CAAC,CACH,CACF;IACD,uBAAuB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IACpD,WAAW,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IACxC,gBAAgB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC7C,mBAAmB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAChD,WAAW,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IACxC,oBAAoB,EAAE,QAAQ,CAAC,oCAAoC,CAAC;IACpE,sBAAsB,EAAE,QAAQ,CAAC,oCAAoC,CAAC;IACtE,oBAAoB,EAAE,QAAQ,CAC5B,IAAI,CACF,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5D,CAAC,EACD,QAAQ,CACT,CACF;IACD,eAAe,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC5C,cAAc,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC3C,WAAW,EAAE,QAAQ,CAAC,aAAa,CAAC;CACrC,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;AAEvD,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAC5C,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,EAC/B,MAAM,CAAC,EAAE,CAAC,CACX,CAAC;AAIF,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;IACvC,OAAO,EAAE,aAAa;IACtB,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC;IACnC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC;IACpC,UAAU,EAAE,QAAQ,CAClB,MAAM,CAAC;QACL,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;QACjC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;KACjC,CAAC,CACH;IACD,MAAM,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,cAAc;QACtB,QAAQ,EAAE,MAAM,CAAC;YACf,GAAG,EAAE,MAAM,CAAC;gBACV,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;gBACrC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC/C,WAAW,EAAE,UAAU;gBACvB,QAAQ,EAAE,KAAK,CAAC;oBACd,OAAO,CAAC,4BAA4B,CAAC;oBACrC,OAAO,CAAC,6BAA6B,CAAC;iBACvC,CAAC;aACH,CAAC;SACH,CAAC;QACF,KAAK,EAAE,QAAQ,CAAC,uBAAuB,CAAC;QACxC,OAAO,EAAE,QAAQ,CAAC,uBAAuB,CAAC;KAC3C,CAAC;IACF,kBAAkB,EAAE,QAAQ,CAAC,wBAAwB,CAAC;IACtD,kBAAkB,EAAE,iBAAiB;IACrC,eAAe,EAAE,OAAO,CAAC,KAAK,CAAC;IAC/B,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,oDAAoD;CAClF,CAAC,CAAC;AAIH;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAc;IAEd,YAAY,CACV,KAAK,EACL,kBAAkB,EAClB,IAAI,gBAAgB,CAAC,QAAQ,cAAc,CAC5C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,qEAAqE;IACrE,OAAO,MAAM,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["import type { SupportedCurve } from '@metamask/key-tree';\nimport { isValidBIP32PathSegment } from '@metamask/key-tree';\nimport type { EmptyObject, InitialPermissions } from '@metamask/snaps-sdk';\nimport type { Describe, Infer, Struct } from '@metamask/superstruct';\nimport {\n  array,\n  boolean,\n  create,\n  enums,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  refine,\n  record,\n  size,\n  string,\n  type,\n  union,\n  intersection,\n} from '@metamask/superstruct';\nimport {\n  assertStruct,\n  ChecksumStruct,\n  VersionStruct,\n  isValidSemVerRange,\n  inMilliseconds,\n  Duration,\n} from '@metamask/utils';\n\nimport { isEqual } from '../array';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';\nimport { KeyringOriginsStruct, RpcOriginsStruct } from '../json-rpc';\nimport { ChainIdStruct } from '../namespace';\nimport { SnapIdStruct } from '../snaps';\nimport { mergeStructs, type InferMatching } from '../structs';\nimport { NameStruct, NpmSnapFileNames, uri } from '../types';\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [\n  SIP_6_MAGIC_VALUE,\n  STATE_ENCRYPTION_MAGIC_VALUE,\n];\n\nexport const FORBIDDEN_COIN_TYPES: number[] = [60];\nconst FORBIDDEN_PATHS: string[][] = FORBIDDEN_COIN_TYPES.map((coinType) => [\n  'm',\n  \"44'\",\n  `${coinType}'`,\n]);\n\nexport const Bip32PathStruct = refine(\n  array(string()),\n  'BIP-32 path',\n  (path: string[]) => {\n    if (path.length === 0) {\n      return 'Path must be a non-empty BIP-32 derivation path array';\n    }\n\n    if (path[0] !== 'm') {\n      return 'Path must start with \"m\".';\n    }\n\n    if (path.length < 3) {\n      return 'Paths must have a length of at least three.';\n    }\n\n    if (path.slice(1).some((part) => !isValidBIP32PathSegment(part))) {\n      return 'Path must be a valid BIP-32 derivation path array.';\n    }\n\n    if (FORBIDDEN_PURPOSES.includes(path[1])) {\n      return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n    }\n\n    if (\n      FORBIDDEN_PATHS.some((forbiddenPath) =>\n        isEqual(path.slice(0, forbiddenPath.length), forbiddenPath),\n      )\n    ) {\n      return `The path \"${path.join(\n        '/',\n      )}\" is not allowed for entropy derivation.`;\n    }\n\n    return true;\n  },\n);\n\nexport const bip32entropy = <\n  Type extends { path: string[]; curve: string },\n  Schema,\n>(\n  struct: Struct<Type, Schema>,\n) =>\n  refine(struct, 'BIP-32 entropy', (value) => {\n    if (\n      value.curve === 'ed25519' &&\n      value.path.slice(1).some((part) => !part.endsWith(\"'\"))\n    ) {\n      return 'Ed25519 does not support unhardened paths.';\n    }\n\n    return true;\n  });\n\nexport const CurveStruct: Describe<SupportedCurve> = enums([\n  'ed25519',\n  'secp256k1',\n  'ed25519Bip32',\n]);\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n  type({\n    path: Bip32PathStruct,\n    curve: CurveStruct,\n  }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const SnapGetBip32EntropyPermissionsStruct = size(\n  array(Bip32EntropyStruct),\n  1,\n  Infinity,\n);\n\nexport const SemVerRangeStruct = refine(string(), 'SemVer range', (value) => {\n  if (isValidSemVerRange(value)) {\n    return true;\n  }\n  return 'Expected a valid SemVer range.';\n});\n\nexport const SnapIdsStruct = refine(\n  record(SnapIdStruct, object({ version: optional(SemVerRangeStruct) })),\n  'SnapIds',\n  (value) => {\n    if (Object.keys(value).length === 0) {\n      return false;\n    }\n\n    return true;\n  },\n);\n\nexport type SnapIds = Infer<typeof SnapIdsStruct>;\n\nexport const ChainIdsStruct = size(array(ChainIdStruct), 1, Infinity);\n\nexport const LookupMatchersStruct = union([\n  object({\n    tlds: size(array(string()), 1, Infinity),\n  }),\n  object({\n    schemes: size(array(string()), 1, Infinity),\n  }),\n  object({\n    tlds: size(array(string()), 1, Infinity),\n    schemes: size(array(string()), 1, Infinity),\n  }),\n]);\n\nexport const MINIMUM_REQUEST_TIMEOUT = inMilliseconds(5, Duration.Second);\nexport const MAXIMUM_REQUEST_TIMEOUT = inMilliseconds(3, Duration.Minute);\n\nexport const MaxRequestTimeStruct = size(\n  integer(),\n  MINIMUM_REQUEST_TIMEOUT,\n  MAXIMUM_REQUEST_TIMEOUT,\n);\n\n// Utility type to union with for all handler structs\nexport const HandlerCaveatsStruct = object({\n  maxRequestTime: optional(MaxRequestTimeStruct),\n});\n\nexport type HandlerCaveats = Infer<typeof HandlerCaveatsStruct>;\n\nexport const EmptyObjectStruct = object<EmptyObject>({}) as unknown as Struct<\n  EmptyObject,\n  null\n>;\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const PermissionsStruct: Describe<InitialPermissions> = type({\n  'endowment:cronjob': optional(\n    mergeStructs(\n      HandlerCaveatsStruct,\n      object({ jobs: CronjobSpecificationArrayStruct }),\n    ),\n  ),\n  'endowment:ethereum-provider': optional(EmptyObjectStruct),\n  'endowment:keyring': optional(\n    mergeStructs(HandlerCaveatsStruct, KeyringOriginsStruct),\n  ),\n  'endowment:lifecycle-hooks': optional(HandlerCaveatsStruct),\n  'endowment:name-lookup': optional(\n    mergeStructs(\n      HandlerCaveatsStruct,\n      object({\n        chains: optional(ChainIdsStruct),\n        matchers: optional(LookupMatchersStruct),\n      }),\n    ),\n  ),\n  'endowment:network-access': optional(EmptyObjectStruct),\n  'endowment:page-home': optional(HandlerCaveatsStruct),\n  'endowment:rpc': optional(\n    mergeStructs(HandlerCaveatsStruct, RpcOriginsStruct),\n  ),\n  'endowment:signature-insight': optional(\n    mergeStructs(\n      HandlerCaveatsStruct,\n      object({\n        allowSignatureOrigin: optional(boolean()),\n      }),\n    ),\n  ),\n  'endowment:transaction-insight': optional(\n    mergeStructs(\n      HandlerCaveatsStruct,\n      object({\n        allowTransactionOrigin: optional(boolean()),\n      }),\n    ),\n  ),\n  'endowment:webassembly': optional(EmptyObjectStruct),\n  snap_dialog: optional(EmptyObjectStruct),\n  snap_manageState: optional(EmptyObjectStruct),\n  snap_manageAccounts: optional(EmptyObjectStruct),\n  snap_notify: optional(EmptyObjectStruct),\n  snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip44Entropy: optional(\n    size(\n      array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n      1,\n      Infinity,\n    ),\n  ),\n  snap_getEntropy: optional(EmptyObjectStruct),\n  snap_getLocale: optional(EmptyObjectStruct),\n  wallet_snap: optional(SnapIdsStruct),\n});\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapPermissions = InferMatching<\n  typeof PermissionsStruct,\n  InitialPermissions\n>;\n\nexport const SnapAuxilaryFilesStruct = array(string());\n\nexport const InitialConnectionsStruct = record(\n  intersection([string(), uri()]),\n  object({}),\n);\n\nexport type InitialConnections = Infer<typeof InitialConnectionsStruct>;\n\nexport const SnapManifestStruct = object({\n  version: VersionStruct,\n  description: size(string(), 1, 280),\n  proposedName: size(string(), 1, 214),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n  source: object({\n    shasum: ChecksumStruct,\n    location: object({\n      npm: object({\n        filePath: size(string(), 1, Infinity),\n        iconPath: optional(size(string(), 1, Infinity)),\n        packageName: NameStruct,\n        registry: union([\n          literal('https://registry.npmjs.org'),\n          literal('https://registry.npmjs.org/'),\n        ]),\n      }),\n    }),\n    files: optional(SnapAuxilaryFilesStruct),\n    locales: optional(SnapAuxilaryFilesStruct),\n  }),\n  initialConnections: optional(InitialConnectionsStruct),\n  initialPermissions: PermissionsStruct,\n  manifestVersion: literal('0.1'),\n  $schema: optional(string()), // enables JSON-Schema linting in VSC and other IDEs\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n  return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n  value: unknown,\n): asserts value is SnapManifest {\n  assertStruct(\n    value,\n    SnapManifestStruct,\n    `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n  );\n}\n\n/**\n * Creates a {@link SnapManifest} object from JSON.\n *\n * @param value - The value to check.\n * @throws If the value cannot be coerced to a {@link SnapManifest} object.\n * @returns The created {@link SnapManifest} object.\n */\nexport function createSnapManifest(value: unknown): SnapManifest {\n  // TODO: Add a utility to prefix these errors similar to assertStruct\n  return create(value, SnapManifestStruct);\n}\n"]}

package/dist/manifest/validator-types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=validator-types.cjs.map

package/dist/manifest/validator-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator-types.cjs","sourceRoot":"","sources":["../../src/manifest/validator-types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Promisable } from '../promise';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport type { SnapManifest } from './validation';\n\n// Eslint uses patch based fixing, but it's too complex for our needs.\n// https://eslint.org/docs/latest/extend/custom-rules#applying-fixes\nexport type ValidatorFix = (files: {\n  manifest: SnapManifest;\n}) => Promisable<{ manifest: SnapManifest }>;\n\nexport type ValidatorSeverity = 'error' | 'warning';\n\nexport type ValidatorContext = {\n  report: (message: string, fix?: ValidatorFix) => void;\n};\n\nexport type ValidatorReport = {\n  severity: ValidatorSeverity;\n  message: string;\n  fix?: ValidatorFix;\n};\n\nexport type ValidatorMeta = {\n  severity: ValidatorSeverity;\n\n  /**\n   * 1. Run the validator on unverified files to ensure that the files are structurally sound.\n   *\n   * @param files - Files to be verified\n   * @param context - Validator context to report errors\n   */\n  structureCheck?: (\n    files: UnvalidatedSnapFiles,\n    context: ValidatorContext,\n  ) => void | Promise<void>;\n\n  /**\n   * 2. Run the validator after the files were checked to be structurally sound.\n   *\n   * @param files - Files to be verified\n   * @param context - Validator context to report errors\n   */\n  semanticCheck?: (\n    files: SnapFiles,\n    context: ValidatorContext,\n  ) => void | Promise<void>;\n};\n"]}

package/dist/manifest/validator-types.d.cts

@@ -0,0 +1,35 @@
+import type { Promisable } from "../promise.cjs";
+import type { SnapFiles, UnvalidatedSnapFiles } from "../types.cjs";
+import type { SnapManifest } from "./validation.cjs";
+export type ValidatorFix = (files: {
+    manifest: SnapManifest;
+}) => Promisable<{
+    manifest: SnapManifest;
+}>;
+export type ValidatorSeverity = 'error' | 'warning';
+export type ValidatorContext = {
+    report: (message: string, fix?: ValidatorFix) => void;
+};
+export type ValidatorReport = {
+    severity: ValidatorSeverity;
+    message: string;
+    fix?: ValidatorFix;
+};
+export type ValidatorMeta = {
+    severity: ValidatorSeverity;
+    /**
+     * 1. Run the validator on unverified files to ensure that the files are structurally sound.
+     *
+     * @param files - Files to be verified
+     * @param context - Validator context to report errors
+     */
+    structureCheck?: (files: UnvalidatedSnapFiles, context: ValidatorContext) => void | Promise<void>;
+    /**
+     * 2. Run the validator after the files were checked to be structurally sound.
+     *
+     * @param files - Files to be verified
+     * @param context - Validator context to report errors
+     */
+    semanticCheck?: (files: SnapFiles, context: ValidatorContext) => void | Promise<void>;
+};
+//# sourceMappingURL=validator-types.d.cts.map

package/dist/manifest/validator-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator-types.d.cts","sourceRoot":"","sources":["../../src/manifest/validator-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,uBAAmB;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,qBAAiB;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,yBAAqB;AAIjD,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE;IACjC,QAAQ,EAAE,YAAY,CAAC;CACxB,KAAK,UAAU,CAAC;IAAE,QAAQ,EAAE,YAAY,CAAA;CAAE,CAAC,CAAC;AAE7C,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CACf,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,gBAAgB,KACtB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CACd,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,gBAAgB,KACtB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B,CAAC"}

package/dist/manifest/validator-types.d.mts

@@ -0,0 +1,35 @@
+import type { Promisable } from "../promise.mjs";
+import type { SnapFiles, UnvalidatedSnapFiles } from "../types.mjs";
+import type { SnapManifest } from "./validation.mjs";
+export type ValidatorFix = (files: {
+    manifest: SnapManifest;
+}) => Promisable<{
+    manifest: SnapManifest;
+}>;
+export type ValidatorSeverity = 'error' | 'warning';
+export type ValidatorContext = {
+    report: (message: string, fix?: ValidatorFix) => void;
+};
+export type ValidatorReport = {
+    severity: ValidatorSeverity;
+    message: string;
+    fix?: ValidatorFix;
+};
+export type ValidatorMeta = {
+    severity: ValidatorSeverity;
+    /**
+     * 1. Run the validator on unverified files to ensure that the files are structurally sound.
+     *
+     * @param files - Files to be verified
+     * @param context - Validator context to report errors
+     */
+    structureCheck?: (files: UnvalidatedSnapFiles, context: ValidatorContext) => void | Promise<void>;
+    /**
+     * 2. Run the validator after the files were checked to be structurally sound.
+     *
+     * @param files - Files to be verified
+     * @param context - Validator context to report errors
+     */
+    semanticCheck?: (files: SnapFiles, context: ValidatorContext) => void | Promise<void>;
+};
+//# sourceMappingURL=validator-types.d.mts.map

package/dist/manifest/validator-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator-types.d.mts","sourceRoot":"","sources":["../../src/manifest/validator-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,uBAAmB;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,qBAAiB;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,yBAAqB;AAIjD,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE;IACjC,QAAQ,EAAE,YAAY,CAAC;CACxB,KAAK,UAAU,CAAC;IAAE,QAAQ,EAAE,YAAY,CAAA;CAAE,CAAC,CAAC;AAE7C,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CACf,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,gBAAgB,KACtB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CACd,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,gBAAgB,KACtB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B,CAAC"}

package/dist/manifest/validator-types.mjs

@@ -1 +1,2 @@
+export {};
 //# sourceMappingURL=validator-types.mjs.map

package/dist/manifest/validator-types.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"validator-types.mjs","sourceRoot":"","sources":["../../src/manifest/validator-types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Promisable } from '../promise';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport type { SnapManifest } from './validation';\n\n// Eslint uses patch based fixing, but it's too complex for our needs.\n// https://eslint.org/docs/latest/extend/custom-rules#applying-fixes\nexport type ValidatorFix = (files: {\n  manifest: SnapManifest;\n}) => Promisable<{ manifest: SnapManifest }>;\n\nexport type ValidatorSeverity = 'error' | 'warning';\n\nexport type ValidatorContext = {\n  report: (message: string, fix?: ValidatorFix) => void;\n};\n\nexport type ValidatorReport = {\n  severity: ValidatorSeverity;\n  message: string;\n  fix?: ValidatorFix;\n};\n\nexport type ValidatorMeta = {\n  severity: ValidatorSeverity;\n\n  /**\n   * 1. Run the validator on unverified files to ensure that the files are structurally sound.\n   *\n   * @param files - Files to be verified\n   * @param context - Validator context to report errors\n   */\n  structureCheck?: (\n    files: UnvalidatedSnapFiles,\n    context: ValidatorContext,\n  ) => void | Promise<void>;\n\n  /**\n   * 2. Run the validator after the files were checked to be structurally sound.\n   *\n   * @param files - Files to be verified\n   * @param context - Validator context to report errors\n   */\n  semanticCheck?: (\n    files: SnapFiles,\n    context: ValidatorContext,\n  ) => void | Promise<void>;\n};\n"]}