@metamask/snaps-utils 1.0.2 → 2.0.0

package/dist/{mock.js → esm/mock.js}

@@ -1,32 +1,35 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateMockEndowments = exports.isConstructor = exports.ALL_APIS = void 0;
-const crypto_1 = __importDefault(require("crypto"));
-const events_1 = __importDefault(require("events"));
-const default_endowments_1 = require("./default-endowments");
-const NETWORK_APIS = ['fetch'];
-exports.ALL_APIS = [...default_endowments_1.DEFAULT_ENDOWMENTS, ...NETWORK_APIS];
+import crypto from 'crypto';
+import EventEmitter from 'events';
+import { DEFAULT_ENDOWMENTS } from './default-endowments';
+const NETWORK_APIS = [
+    'fetch',
+    'Request',
+    'Headers',
+    'Response'
+];
+export const ALL_APIS = [
+    ...DEFAULT_ENDOWMENTS,
+    ...NETWORK_APIS,
+    'WebAssembly'
+];
 /**
  * Get a mock snap API, that always returns `true` for requests.
  *
  * @returns A mocked snap provider.
- */
-function getMockSnapGlobal() {
+ */ function getMockSnapGlobal() {
     // eslint-disable-next-line @typescript-eslint/require-await
-    return { request: async () => true };
+    return {
+        request: async ()=>true
+    };
 }
 /**
  * Get a mock Ethereum provider, that always returns `true` for requests.
  *
  * @returns A mocked ethereum provider.
- */
-function getMockEthereumProvider() {
-    const mockProvider = new events_1.default();
+ */ function getMockEthereumProvider() {
+    const mockProvider = new EventEmitter();
     // eslint-disable-next-line @typescript-eslint/require-await
-    mockProvider.request = async () => true;
+    mockProvider.request = async ()=>true;
     return mockProvider;
 }
 /**
@@ -34,25 +37,22 @@ function getMockEthereumProvider() {
  *
  * @param value - The value to check.
  * @returns `true` if the value is a constructor, or `false` otherwise.
- */
-const isConstructor = (value) => Boolean(typeof value?.prototype?.constructor?.name === 'string');
-exports.isConstructor = isConstructor;
+ */ export const isConstructor = (value)=>Boolean(typeof value?.prototype?.constructor?.name === 'string');
 /**
  * A function that always returns `true`.
  *
  * @returns `true`.
- */
-const mockFunction = () => true;
+ */ const mockFunction = ()=>true;
 class MockClass {
 }
 const handler = {
     // eslint-disable-next-line @typescript-eslint/naming-convention
-    construct(Target, args) {
+    construct (Target, args) {
         return new Proxy(new Target(...args), handler);
     },
-    get(_target, _prop) {
+    get (_target, _prop) {
         return mockFunction;
-    },
+    }
 };
 /**
  * Generate a mock class for a given value. The value is wrapped in a Proxy, and
@@ -60,15 +60,14 @@ const handler = {
  *
  * @param value - The value to mock.
  * @returns A mock class.
- */
-const generateMockClass = (value) => {
+ */ const generateMockClass = (value)=>{
     return new Proxy(value, handler);
 };
 // Things not currently auto-mocked because of NodeJS, by adding them here we
 // have types for them and can use that to generate mocks if needed.
 const mockWindow = {
-    crypto: crypto_1.default,
-    SubtleCrypto: MockClass,
+    crypto,
+    SubtleCrypto: MockClass
 };
 /**
  * Generate a mock endowment for a certain class or function on the `globalThis`
@@ -77,21 +76,19 @@ const mockWindow = {
  * @param key - The key to generate the mock endowment for.
  * @returns A mocked class or function. If the key is part of the default
  * endowments, the original value is returned.
- */
-const generateMockEndowment = (key) => {
+ */ const generateMockEndowment = (key)=>{
     const globalValue = globalThis[key];
     // Default exposed APIs don't need to be mocked
-    if (globalValue && default_endowments_1.DEFAULT_ENDOWMENTS.includes(key)) {
+    if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {
         return globalValue;
     }
     // Fall back to mockWindow for certain APIs not exposed in global in Node.JS
     const globalOrMocked = globalValue ?? mockWindow[key];
     const type = typeof globalOrMocked;
     const isFunction = type === 'function';
-    if (isFunction && (0, exports.isConstructor)(globalOrMocked)) {
+    if (isFunction && isConstructor(globalOrMocked)) {
         return generateMockClass(globalOrMocked);
-    }
-    else if (isFunction || !globalOrMocked) {
+    } else if (isFunction || !globalOrMocked) {
         // Fall back to function mock for now
         return mockFunction;
     }
@@ -101,9 +98,14 @@ const generateMockEndowment = (key) => {
  * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
  *
  * @returns A map of endowments.
- */
-const generateMockEndowments = () => {
-    return exports.ALL_APIS.reduce((acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }), { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() });
+ */ export const generateMockEndowments = ()=>{
+    return ALL_APIS.reduce((acc, cur)=>({
+            ...acc,
+            [cur]: generateMockEndowment(cur)
+        }), {
+        snap: getMockSnapGlobal(),
+        ethereum: getMockEthereumProvider()
+    });
 };
-exports.generateMockEndowments = generateMockEndowments;
+
 //# sourceMappingURL=mock.js.map

package/dist/esm/mock.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/mock.ts"],"sourcesContent":["import crypto from 'crypto';\nimport EventEmitter from 'events';\n\nimport { DEFAULT_ENDOWMENTS } from './default-endowments';\n\nconst NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];\n\nexport const ALL_APIS: string[] = [\n  ...DEFAULT_ENDOWMENTS,\n  ...NETWORK_APIS,\n  'WebAssembly',\n];\n\ntype MockSnapGlobal = {\n  request: () => Promise<any>;\n};\n\ntype MockEthereumProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap API, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapGlobal(): MockSnapGlobal {\n  // eslint-disable-next-line @typescript-eslint/require-await\n  return { request: async () => true };\n}\n\n/**\n * Get a mock Ethereum provider, that always returns `true` for requests.\n *\n * @returns A mocked ethereum provider.\n */\nfunction getMockEthereumProvider(): MockEthereumProvider {\n  const mockProvider = new EventEmitter() as Partial<MockEthereumProvider>;\n  // eslint-disable-next-line @typescript-eslint/require-await\n  mockProvider.request = async () => true;\n  return mockProvider as MockEthereumProvider;\n}\n\n/**\n * Check if a value is a constructor.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a constructor, or `false` otherwise.\n */\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\n/**\n * A function that always returns `true`.\n *\n * @returns `true`.\n */\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\n/**\n * Generate a mock class for a given value. The value is wrapped in a Proxy, and\n * all methods are replaced with a mock function.\n *\n * @param value - The value to mock.\n * @returns A mock class.\n */\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we\n// have types for them and can use that to generate mocks if needed.\nconst mockWindow: Record<string, unknown> = {\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\n/**\n * Generate a mock endowment for a certain class or function on the `globalThis`\n * object.\n *\n * @param key - The key to generate the mock endowment for.\n * @returns A mocked class or function. If the key is part of the default\n * endowments, the original value is returned.\n */\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? mockWindow[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\n/**\n * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.\n *\n * @returns A map of endowments.\n */\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() },\n  );\n};\n"],"names":["crypto","EventEmitter","DEFAULT_ENDOWMENTS","NETWORK_APIS","ALL_APIS","getMockSnapGlobal","request","getMockEthereumProvider","mockProvider","isConstructor","value","Boolean","prototype","constructor","name","mockFunction","MockClass","handler","construct","Target","args","Proxy","get","_target","_prop","generateMockClass","mockWindow","SubtleCrypto","generateMockEndowment","key","globalValue","globalThis","includes","globalOrMocked","type","isFunction","generateMockEndowments","reduce","acc","cur","snap","ethereum"],"mappings":"AAAA,OAAOA,YAAY,SAAS;AAC5B,OAAOC,kBAAkB,SAAS;AAElC,SAASC,kBAAkB,QAAQ,uBAAuB;AAE1D,MAAMC,eAAe;IAAC;IAAS;IAAW;IAAW;CAAW;AAEhE,OAAO,MAAMC,WAAqB;OAC7BF;OACAC;IACH;CACD,CAAC;AAUF;;;;CAIC,GACD,SAASE;IACP,4DAA4D;IAC5D,OAAO;QAAEC,SAAS,UAAY;IAAK;AACrC;AAEA;;;;CAIC,GACD,SAASC;IACP,MAAMC,eAAe,IAAIP;IACzB,4DAA4D;IAC5DO,aAAaF,OAAO,GAAG,UAAY;IACnC,OAAOE;AACT;AAEA;;;;;CAKC,GACD,OAAO,MAAMC,gBAAgB,CAACC,QAC5BC,QAAQ,OAAOD,OAAOE,WAAWC,aAAaC,SAAS,UAAU;AAEnE;;;;CAIC,GACD,MAAMC,eAAe,IAAM;AAC3B,MAAMC;AAAW;AAEjB,MAAMC,UAAU;IACd,gEAAgE;IAChEC,WAAUC,MAAW,EAAEC,IAAW;QAChC,OAAO,IAAIC,MAAM,IAAIF,UAAUC,OAAOH;IACxC;IACAK,KAAIC,OAAY,EAAEC,KAAU;QAC1B,OAAOT;IACT;AACF;AAEA;;;;;;CAMC,GACD,MAAMU,oBAAoB,CAACf;IACzB,OAAO,IAAIW,MAAMX,OAAOO;AAC1B;AAEA,6EAA6E;AAC7E,oEAAoE;AACpE,MAAMS,aAAsC;IAC1C1B;IACA2B,cAAcX;AAChB;AAEA;;;;;;;CAOC,GACD,MAAMY,wBAAwB,CAACC;IAC7B,MAAMC,cAAc,AAACC,UAAkB,CAACF,IAAI;IAE5C,+CAA+C;IAC/C,IAAIC,eAAe5B,mBAAmB8B,QAAQ,CAACH,MAAM;QACnD,OAAOC;IACT;IAEA,4EAA4E;IAC5E,MAAMG,iBAAiBH,eAAeJ,UAAU,CAACG,IAAI;IAErD,MAAMK,OAAO,OAAOD;IACpB,MAAME,aAAaD,SAAS;IAC5B,IAAIC,cAAc1B,cAAcwB,iBAAiB;QAC/C,OAAOR,kBAAkBQ;IAC3B,OAAO,IAAIE,cAAc,CAACF,gBAAgB;QACxC,qCAAqC;QACrC,OAAOlB;IACT;IACA,OAAOkB;AACT;AAEA;;;;CAIC,GACD,OAAO,MAAMG,yBAAyB;IACpC,OAAOhC,SAASiC,MAAM,CACpB,CAACC,KAAKC,MAAS,CAAA;YAAE,GAAGD,GAAG;YAAE,CAACC,IAAI,EAAEX,sBAAsBW;QAAK,CAAA,GAC3D;QAAEC,MAAMnC;QAAqBoC,UAAUlC;IAA0B;AAErE,EAAE"}

package/dist/esm/namespace.js

@@ -0,0 +1,112 @@
+import { array, is, object, optional, pattern, size, string } from 'superstruct';
+export const CHAIN_ID_REGEX = RegExp("^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$", "u");
+export const ACCOUNT_ID_REGEX = RegExp("^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$", "u");
+export const ACCOUNT_ADDRESS_REGEX = RegExp("^(?<accountAddress>[a-zA-Z0-9]{1,64})$", "u");
+/**
+ * Parse a chain ID string to an object containing the namespace and reference.
+ * This validates the chain ID before parsing it.
+ *
+ * @param chainId - The chain ID to validate and parse.
+ * @returns The parsed chain ID.
+ */ export function parseChainId(chainId) {
+    const match = CHAIN_ID_REGEX.exec(chainId);
+    if (!match?.groups) {
+        throw new Error('Invalid chain ID.');
+    }
+    return {
+        namespace: match.groups.namespace,
+        reference: match.groups.reference
+    };
+}
+/**
+ * Parse an account ID to an object containing the chain, chain ID and address.
+ * This validates the account ID before parsing it.
+ *
+ * @param accountId - The account ID to validate and parse.
+ * @returns The parsed account ID.
+ */ export function parseAccountId(accountId) {
+    const match = ACCOUNT_ID_REGEX.exec(accountId);
+    if (!match?.groups) {
+        throw new Error('Invalid account ID.');
+    }
+    return {
+        address: match.groups.accountAddress,
+        chainId: match.groups.chainId,
+        chain: {
+            namespace: match.groups.namespace,
+            reference: match.groups.reference
+        }
+    };
+}
+/**
+ * A helper struct for a string with a minimum length of 1 and a maximum length
+ * of 40.
+ */ export const LimitedString = size(string(), 1, 40);
+/**
+ * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
+ */ export const ChainIdStruct = pattern(string(), CHAIN_ID_REGEX);
+export const AccountIdStruct = pattern(string(), ACCOUNT_ID_REGEX);
+export const AccountIdArrayStruct = array(AccountIdStruct);
+export const AccountAddressStruct = pattern(string(), ACCOUNT_ADDRESS_REGEX);
+/**
+ * A chain descriptor.
+ */ export const ChainStruct = object({
+    id: ChainIdStruct,
+    name: LimitedString
+});
+export const NamespaceStruct = object({
+    /**
+   * A list of supported chains in the namespace.
+   */ chains: array(ChainStruct),
+    /**
+   * A list of supported RPC methods on the namespace, that a DApp can call.
+   */ methods: optional(array(LimitedString)),
+    /**
+   * A list of supported RPC events on the namespace, that a DApp can listen to.
+   */ events: optional(array(LimitedString))
+});
+/**
+ * A CAIP-2 namespace, i.e., the first part of a chain ID.
+ */ export const NamespaceIdStruct = pattern(string(), /^[-a-z0-9]{3,8}$/u);
+/**
+ * Check if the given value is a CAIP-2 namespace ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-2 namespace ID.
+ */ export function isNamespaceId(value) {
+    return is(value, NamespaceIdStruct);
+}
+/**
+ * Check if the given value is a CAIP-2 chain ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-2 chain ID.
+ */ export function isChainId(value) {
+    return is(value, ChainIdStruct);
+}
+/**
+ * Check if the given value is a CAIP-10 account ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-10 account ID.
+ */ export function isAccountId(value) {
+    return is(value, AccountIdStruct);
+}
+/**
+ * Check if the given value is an array of CAIP-10 account IDs.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an array of CAIP-10 account IDs.
+ */ export function isAccountIdArray(value) {
+    return is(value, AccountIdArrayStruct);
+}
+/**
+ * Check if a value is a {@link Namespace}.
+ *
+ * @param value - The value to validate.
+ * @returns True if the value is a valid {@link Namespace}.
+ */ export function isNamespace(value) {
+    return is(value, NamespaceStruct);
+}
+
+//# sourceMappingURL=namespace.js.map

package/dist/esm/namespace.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/namespace.ts"],"sourcesContent":["import type { Infer } from 'superstruct';\nimport {\n  array,\n  is,\n  object,\n  optional,\n  pattern,\n  size,\n  string,\n} from 'superstruct';\n\nexport const CHAIN_ID_REGEX =\n  /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u;\n\nexport const ACCOUNT_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\nexport const ACCOUNT_ADDRESS_REGEX = /^(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\n/**\n * Parse a chain ID string to an object containing the namespace and reference.\n * This validates the chain ID before parsing it.\n *\n * @param chainId - The chain ID to validate and parse.\n * @returns The parsed chain ID.\n */\nexport function parseChainId(chainId: ChainId): {\n  namespace: NamespaceId;\n  reference: string;\n} {\n  const match = CHAIN_ID_REGEX.exec(chainId);\n  if (!match?.groups) {\n    throw new Error('Invalid chain ID.');\n  }\n\n  return {\n    namespace: match.groups.namespace,\n    reference: match.groups.reference,\n  };\n}\n\n/**\n * Parse an account ID to an object containing the chain, chain ID and address.\n * This validates the account ID before parsing it.\n *\n * @param accountId - The account ID to validate and parse.\n * @returns The parsed account ID.\n */\nexport function parseAccountId(accountId: AccountId): {\n  chain: { namespace: NamespaceId; reference: string };\n  chainId: ChainId;\n  address: string;\n} {\n  const match = ACCOUNT_ID_REGEX.exec(accountId);\n  if (!match?.groups) {\n    throw new Error('Invalid account ID.');\n  }\n\n  return {\n    address: match.groups.accountAddress,\n    chainId: match.groups.chainId as ChainId,\n    chain: {\n      namespace: match.groups.namespace,\n      reference: match.groups.reference,\n    },\n  };\n}\n\n/**\n * A helper struct for a string with a minimum length of 1 and a maximum length\n * of 40.\n */\nexport const LimitedString = size(string(), 1, 40);\n\n/**\n * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.\n */\nexport const ChainIdStruct = pattern(string(), CHAIN_ID_REGEX);\nexport type ChainId = `${string}:${string}`;\nexport type Caip2ChainId = Infer<typeof ChainIdStruct>;\n\nexport const AccountIdStruct = pattern(string(), ACCOUNT_ID_REGEX);\nexport type AccountId = `${ChainId}:${string}`;\n\nexport const AccountIdArrayStruct = array(AccountIdStruct);\nexport const AccountAddressStruct = pattern(string(), ACCOUNT_ADDRESS_REGEX);\nexport type AccountAddress = Infer<typeof AccountAddressStruct>;\n\n/**\n * A chain descriptor.\n */\nexport const ChainStruct = object({\n  id: ChainIdStruct,\n  name: LimitedString,\n});\nexport type Chain = Infer<typeof ChainStruct>;\n\nexport const NamespaceStruct = object({\n  /**\n   * A list of supported chains in the namespace.\n   */\n  chains: array(ChainStruct),\n\n  /**\n   * A list of supported RPC methods on the namespace, that a DApp can call.\n   */\n  methods: optional(array(LimitedString)),\n\n  /**\n   * A list of supported RPC events on the namespace, that a DApp can listen to.\n   */\n  events: optional(array(LimitedString)),\n});\nexport type Namespace = Infer<typeof NamespaceStruct>;\n\n/**\n * A CAIP-2 namespace, i.e., the first part of a chain ID.\n */\nexport const NamespaceIdStruct = pattern(string(), /^[-a-z0-9]{3,8}$/u);\nexport type NamespaceId = Infer<typeof NamespaceIdStruct>;\n\n/**\n * Check if the given value is a CAIP-2 namespace ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 namespace ID.\n */\nexport function isNamespaceId(value: unknown): value is NamespaceId {\n  return is(value, NamespaceIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-2 chain ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 chain ID.\n */\nexport function isChainId(value: unknown): value is ChainId {\n  return is(value, ChainIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-10 account ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-10 account ID.\n */\nexport function isAccountId(value: unknown): value is AccountId {\n  return is(value, AccountIdStruct);\n}\n\n/**\n * Check if the given value is an array of CAIP-10 account IDs.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of CAIP-10 account IDs.\n */\nexport function isAccountIdArray(value: unknown): value is AccountId[] {\n  return is(value, AccountIdArrayStruct);\n}\n\n/**\n * Check if a value is a {@link Namespace}.\n *\n * @param value - The value to validate.\n * @returns True if the value is a valid {@link Namespace}.\n */\nexport function isNamespace(value: unknown): value is Namespace {\n  return is(value, NamespaceStruct);\n}\n"],"names":["array","is","object","optional","pattern","size","string","CHAIN_ID_REGEX","ACCOUNT_ID_REGEX","ACCOUNT_ADDRESS_REGEX","parseChainId","chainId","match","exec","groups","Error","namespace","reference","parseAccountId","accountId","address","accountAddress","chain","LimitedString","ChainIdStruct","AccountIdStruct","AccountIdArrayStruct","AccountAddressStruct","ChainStruct","id","name","NamespaceStruct","chains","methods","events","NamespaceIdStruct","isNamespaceId","value","isChainId","isAccountId","isAccountIdArray","isNamespace"],"mappings":"AACA,SACEA,KAAK,EACLC,EAAE,EACFC,MAAM,EACNC,QAAQ,EACRC,OAAO,EACPC,IAAI,EACJC,MAAM,QACD,cAAc;AAErB,OAAO,MAAMC,iBACX,+EAAmE;AAErE,OAAO,MAAMC,mBACX,gIAAoH;AAEtH,OAAO,MAAMC,wBAAwB,sDAA0C;AAE/E;;;;;;CAMC,GACD,OAAO,SAASC,aAAaC,OAAgB;IAI3C,MAAMC,QAAQL,eAAeM,IAAI,CAACF;IAClC,IAAI,CAACC,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLC,WAAWJ,MAAME,MAAM,CAACE,SAAS;QACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;IACnC;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,eAAeC,SAAoB;IAKjD,MAAMP,QAAQJ,iBAAiBK,IAAI,CAACM;IACpC,IAAI,CAACP,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLK,SAASR,MAAME,MAAM,CAACO,cAAc;QACpCV,SAASC,MAAME,MAAM,CAACH,OAAO;QAC7BW,OAAO;YACLN,WAAWJ,MAAME,MAAM,CAACE,SAAS;YACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;QACnC;IACF;AACF;AAEA;;;CAGC,GACD,OAAO,MAAMM,gBAAgBlB,KAAKC,UAAU,GAAG,IAAI;AAEnD;;CAEC,GACD,OAAO,MAAMkB,gBAAgBpB,QAAQE,UAAUC,gBAAgB;AAI/D,OAAO,MAAMkB,kBAAkBrB,QAAQE,UAAUE,kBAAkB;AAGnE,OAAO,MAAMkB,uBAAuB1B,MAAMyB,iBAAiB;AAC3D,OAAO,MAAME,uBAAuBvB,QAAQE,UAAUG,uBAAuB;AAG7E;;CAEC,GACD,OAAO,MAAMmB,cAAc1B,OAAO;IAChC2B,IAAIL;IACJM,MAAMP;AACR,GAAG;AAGH,OAAO,MAAMQ,kBAAkB7B,OAAO;IACpC;;GAEC,GACD8B,QAAQhC,MAAM4B;IAEd;;GAEC,GACDK,SAAS9B,SAASH,MAAMuB;IAExB;;GAEC,GACDW,QAAQ/B,SAASH,MAAMuB;AACzB,GAAG;AAGH;;CAEC,GACD,OAAO,MAAMY,oBAAoB/B,QAAQE,UAAU,qBAAqB;AAGxE;;;;;CAKC,GACD,OAAO,SAAS8B,cAAcC,KAAc;IAC1C,OAAOpC,GAAGoC,OAAOF;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASG,UAAUD,KAAc;IACtC,OAAOpC,GAAGoC,OAAOb;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASe,YAAYF,KAAc;IACxC,OAAOpC,GAAGoC,OAAOZ;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASe,iBAAiBH,KAAc;IAC7C,OAAOpC,GAAGoC,OAAOX;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASe,YAAYJ,KAAc;IACxC,OAAOpC,GAAGoC,OAAON;AACnB"}

package/dist/esm/npm.js

@@ -0,0 +1,70 @@
+import { assertIsSnapIcon } from './icon';
+import { validateNpmSnapManifest } from './manifest/manifest';
+import { assertIsSnapManifest } from './manifest/validation';
+import { assertIsNpmSnapPackageJson, NpmSnapFileNames } from './types';
+export const EXPECTED_SNAP_FILES = [
+    'manifest',
+    'packageJson',
+    'sourceCode'
+];
+export const SnapFileNameFromKey = {
+    manifest: NpmSnapFileNames.Manifest,
+    packageJson: NpmSnapFileNames.PackageJson,
+    sourceCode: 'source code bundle'
+};
+// TODO: Refactor this to be more shared with other validation.
+/**
+ * Validates the files extracted from an npm Snap package tarball by ensuring
+ * that they're non-empty and that the Json files match their respective schemas
+ * and the Snaps publishing specification.
+ *
+ * @param snapFiles - The object containing the expected Snap file contents,
+ * if any.
+ * @param errorPrefix - The prefix of the error message.
+ * @returns A tuple of the Snap manifest object and the Snap source code.
+ */ export function validateNpmSnap(snapFiles, errorPrefix) {
+    EXPECTED_SNAP_FILES.forEach((key)=>{
+        if (!snapFiles[key]) {
+            throw new Error(`${errorPrefix ?? ''}Missing file "${SnapFileNameFromKey[key]}".`);
+        }
+    });
+    // Typecast: We are assured that the required files exist if we get here.
+    const { manifest, packageJson, sourceCode, svgIcon } = snapFiles;
+    try {
+        assertIsSnapManifest(manifest.result);
+    } catch (error) {
+        throw new Error(`${errorPrefix ?? ''}${error.message}`);
+    }
+    const validatedManifest = manifest;
+    const { iconPath } = validatedManifest.result.source.location.npm;
+    if (iconPath && !svgIcon) {
+        throw new Error(`Missing file "${iconPath}".`);
+    }
+    try {
+        assertIsNpmSnapPackageJson(packageJson.result);
+    } catch (error) {
+        throw new Error(`${errorPrefix ?? ''}${error.message}`);
+    }
+    const validatedPackageJson = packageJson;
+    validateNpmSnapManifest({
+        manifest: validatedManifest,
+        packageJson: validatedPackageJson,
+        sourceCode,
+        svgIcon
+    });
+    if (svgIcon) {
+        try {
+            assertIsSnapIcon(svgIcon);
+        } catch (error) {
+            throw new Error(`${errorPrefix ?? ''}${error.message}`);
+        }
+    }
+    return {
+        manifest: validatedManifest,
+        packageJson: validatedPackageJson,
+        sourceCode,
+        svgIcon
+    };
+}
+
+//# sourceMappingURL=npm.js.map

package/dist/esm/npm.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/npm.ts"],"sourcesContent":["import { assertIsSnapIcon } from './icon';\nimport { validateNpmSnapManifest } from './manifest/manifest';\nimport { assertIsSnapManifest } from './manifest/validation';\nimport type { SnapFiles, UnvalidatedSnapFiles } from './types';\nimport { assertIsNpmSnapPackageJson, NpmSnapFileNames } from './types';\n\nexport const EXPECTED_SNAP_FILES = [\n  'manifest',\n  'packageJson',\n  'sourceCode',\n] as const;\n\nexport const SnapFileNameFromKey = {\n  manifest: NpmSnapFileNames.Manifest,\n  packageJson: NpmSnapFileNames.PackageJson,\n  sourceCode: 'source code bundle',\n} as const;\n\n// TODO: Refactor this to be more shared with other validation.\n\n/**\n * Validates the files extracted from an npm Snap package tarball by ensuring\n * that they're non-empty and that the Json files match their respective schemas\n * and the Snaps publishing specification.\n *\n * @param snapFiles - The object containing the expected Snap file contents,\n * if any.\n * @param errorPrefix - The prefix of the error message.\n * @returns A tuple of the Snap manifest object and the Snap source code.\n */\nexport function validateNpmSnap(\n  snapFiles: UnvalidatedSnapFiles,\n  errorPrefix?: `${string}: `,\n): SnapFiles {\n  EXPECTED_SNAP_FILES.forEach((key) => {\n    if (!snapFiles[key]) {\n      throw new Error(\n        `${errorPrefix ?? ''}Missing file \"${SnapFileNameFromKey[key]}\".`,\n      );\n    }\n  });\n\n  // Typecast: We are assured that the required files exist if we get here.\n  const { manifest, packageJson, sourceCode, svgIcon } = snapFiles as SnapFiles;\n  try {\n    assertIsSnapManifest(manifest.result);\n  } catch (error) {\n    throw new Error(`${errorPrefix ?? ''}${error.message}`);\n  }\n  const validatedManifest = manifest;\n\n  const { iconPath } = validatedManifest.result.source.location.npm;\n  if (iconPath && !svgIcon) {\n    throw new Error(`Missing file \"${iconPath}\".`);\n  }\n\n  try {\n    assertIsNpmSnapPackageJson(packageJson.result);\n  } catch (error) {\n    throw new Error(`${errorPrefix ?? ''}${error.message}`);\n  }\n  const validatedPackageJson = packageJson;\n\n  validateNpmSnapManifest({\n    manifest: validatedManifest,\n    packageJson: validatedPackageJson,\n    sourceCode,\n    svgIcon,\n  });\n\n  if (svgIcon) {\n    try {\n      assertIsSnapIcon(svgIcon);\n    } catch (error) {\n      throw new Error(`${errorPrefix ?? ''}${error.message}`);\n    }\n  }\n\n  return {\n    manifest: validatedManifest,\n    packageJson: validatedPackageJson,\n    sourceCode,\n    svgIcon,\n  };\n}\n"],"names":["assertIsSnapIcon","validateNpmSnapManifest","assertIsSnapManifest","assertIsNpmSnapPackageJson","NpmSnapFileNames","EXPECTED_SNAP_FILES","SnapFileNameFromKey","manifest","Manifest","packageJson","PackageJson","sourceCode","validateNpmSnap","snapFiles","errorPrefix","forEach","key","Error","svgIcon","result","error","message","validatedManifest","iconPath","source","location","npm","validatedPackageJson"],"mappings":"AAAA,SAASA,gBAAgB,QAAQ,SAAS;AAC1C,SAASC,uBAAuB,QAAQ,sBAAsB;AAC9D,SAASC,oBAAoB,QAAQ,wBAAwB;AAE7D,SAASC,0BAA0B,EAAEC,gBAAgB,QAAQ,UAAU;AAEvE,OAAO,MAAMC,sBAAsB;IACjC;IACA;IACA;CACD,CAAU;AAEX,OAAO,MAAMC,sBAAsB;IACjCC,UAAUH,iBAAiBI,QAAQ;IACnCC,aAAaL,iBAAiBM,WAAW;IACzCC,YAAY;AACd,EAAW;AAEX,+DAA+D;AAE/D;;;;;;;;;CASC,GACD,OAAO,SAASC,gBACdC,SAA+B,EAC/BC,WAA2B;IAE3BT,oBAAoBU,OAAO,CAAC,CAACC;QAC3B,IAAI,CAACH,SAAS,CAACG,IAAI,EAAE;YACnB,MAAM,IAAIC,MACR,CAAC,EAAEH,eAAe,GAAG,cAAc,EAAER,mBAAmB,CAACU,IAAI,CAAC,EAAE,CAAC;QAErE;IACF;IAEA,yEAAyE;IACzE,MAAM,EAAET,QAAQ,EAAEE,WAAW,EAAEE,UAAU,EAAEO,OAAO,EAAE,GAAGL;IACvD,IAAI;QACFX,qBAAqBK,SAASY,MAAM;IACtC,EAAE,OAAOC,OAAO;QACd,MAAM,IAAIH,MAAM,CAAC,EAAEH,eAAe,GAAG,EAAEM,MAAMC,OAAO,CAAC,CAAC;IACxD;IACA,MAAMC,oBAAoBf;IAE1B,MAAM,EAAEgB,QAAQ,EAAE,GAAGD,kBAAkBH,MAAM,CAACK,MAAM,CAACC,QAAQ,CAACC,GAAG;IACjE,IAAIH,YAAY,CAACL,SAAS;QACxB,MAAM,IAAID,MAAM,CAAC,cAAc,EAAEM,SAAS,EAAE,CAAC;IAC/C;IAEA,IAAI;QACFpB,2BAA2BM,YAAYU,MAAM;IAC/C,EAAE,OAAOC,OAAO;QACd,MAAM,IAAIH,MAAM,CAAC,EAAEH,eAAe,GAAG,EAAEM,MAAMC,OAAO,CAAC,CAAC;IACxD;IACA,MAAMM,uBAAuBlB;IAE7BR,wBAAwB;QACtBM,UAAUe;QACVb,aAAakB;QACbhB;QACAO;IACF;IAEA,IAAIA,SAAS;QACX,IAAI;YACFlB,iBAAiBkB;QACnB,EAAE,OAAOE,OAAO;YACd,MAAM,IAAIH,MAAM,CAAC,EAAEH,eAAe,GAAG,EAAEM,MAAMC,OAAO,CAAC,CAAC;QACxD;IACF;IAEA,OAAO;QACLd,UAAUe;QACVb,aAAakB;QACbhB;QACAO;IACF;AACF"}

package/dist/esm/path.js

@@ -0,0 +1,17 @@
+import { assert } from '@metamask/utils';
+/**
+ * Normalizes relative paths by optionally removing `./` prefix.
+ *
+ * @param path - Path to make normalize.
+ * @returns The same path, with `./` prefix remove.
+ */ // TODO(ritave): Include NodeJS path polyfill and use path.normalize as well
+export function normalizeRelative(path) {
+    assert(!path.startsWith('/'));
+    assert(path.search(/:|\/\//u) === -1, `Path "${path}" potentially an URI instead of local relative`);
+    if (path.startsWith('./')) {
+        return path.slice(2);
+    }
+    return path;
+}
+
+//# sourceMappingURL=path.js.map

package/dist/esm/path.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/path.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\n\n/**\n * Normalizes relative paths by optionally removing `./` prefix.\n *\n * @param path - Path to make normalize.\n * @returns The same path, with `./` prefix remove.\n */\n// TODO(ritave): Include NodeJS path polyfill and use path.normalize as well\nexport function normalizeRelative(path: string): string {\n  assert(!path.startsWith('/'));\n  assert(\n    path.search(/:|\\/\\//u) === -1,\n    `Path \"${path}\" potentially an URI instead of local relative`,\n  );\n\n  if (path.startsWith('./')) {\n    return path.slice(2);\n  }\n  return path;\n}\n"],"names":["assert","normalizeRelative","path","startsWith","search","slice"],"mappings":"AAAA,SAASA,MAAM,QAAQ,kBAAkB;AAEzC;;;;;CAKC,GACD,4EAA4E;AAC5E,OAAO,SAASC,kBAAkBC,IAAY;IAC5CF,OAAO,CAACE,KAAKC,UAAU,CAAC;IACxBH,OACEE,KAAKE,MAAM,CAAC,eAAe,CAAC,GAC5B,CAAC,MAAM,EAAEF,KAAK,8CAA8C,CAAC;IAG/D,IAAIA,KAAKC,UAAU,CAAC,OAAO;QACzB,OAAOD,KAAKG,KAAK,CAAC;IACpB;IACA,OAAOH;AACT"}