@metamask/snaps-utils 0.24.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022 MetaMask
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @metamask/snaps-utils
+
+Shared utility functions used by the other packages.

package/dist/caveats.d.ts

@@ -0,0 +1,22 @@
+export declare enum SnapCaveatType {
+    /**
+     * Permitted derivation paths, used by `snap_getBip32Entropy`.
+     */
+    PermittedDerivationPaths = "permittedDerivationPaths",
+    /**
+     * Permitted coin types, used by `snap_getBip44Entropy`.
+     */
+    PermittedCoinTypes = "permittedCoinTypes",
+    /**
+     * Permission to use the Snap keyring API.
+     */
+    SnapKeyring = "snapKeyring",
+    /**
+     * Caveat specifying a snap cronjob.
+     */
+    SnapCronjob = "snapCronjob",
+    /**
+     * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.
+     */
+    TransactionOrigin = "transactionOrigin"
+}

package/dist/caveats.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapCaveatType = void 0;
+var SnapCaveatType;
+(function (SnapCaveatType) {
+    /**
+     * Permitted derivation paths, used by `snap_getBip32Entropy`.
+     */
+    SnapCaveatType["PermittedDerivationPaths"] = "permittedDerivationPaths";
+    /**
+     * Permitted coin types, used by `snap_getBip44Entropy`.
+     */
+    SnapCaveatType["PermittedCoinTypes"] = "permittedCoinTypes";
+    /**
+     * Permission to use the Snap keyring API.
+     */
+    SnapCaveatType["SnapKeyring"] = "snapKeyring";
+    /**
+     * Caveat specifying a snap cronjob.
+     */
+    SnapCaveatType["SnapCronjob"] = "snapCronjob";
+    /**
+     * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.
+     */
+    SnapCaveatType["TransactionOrigin"] = "transactionOrigin";
+})(SnapCaveatType = exports.SnapCaveatType || (exports.SnapCaveatType = {}));
+//# sourceMappingURL=caveats.js.map

package/dist/caveats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"caveats.js","sourceRoot":"","sources":["../src/caveats.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAyBX;AAzBD,WAAY,cAAc;IACxB;;OAEG;IACH,uEAAqD,CAAA;IAErD;;OAEG;IACH,2DAAyC,CAAA;IAEzC;;OAEG;IACH,6CAA2B,CAAA;IAE3B;;OAEG;IACH,6CAA2B,CAAA;IAE3B;;OAEG;IACH,yDAAuC,CAAA;AACzC,CAAC,EAzBW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAyBzB","sourcesContent":["export enum SnapCaveatType {\n  /**\n   * Permitted derivation paths, used by `snap_getBip32Entropy`.\n   */\n  PermittedDerivationPaths = 'permittedDerivationPaths',\n\n  /**\n   * Permitted coin types, used by `snap_getBip44Entropy`.\n   */\n  PermittedCoinTypes = 'permittedCoinTypes',\n\n  /**\n   * Permission to use the Snap keyring API.\n   */\n  SnapKeyring = 'snapKeyring',\n\n  /**\n   * Caveat specifying a snap cronjob.\n   */\n  SnapCronjob = 'snapCronjob',\n\n  /**\n   * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.\n   */\n  TransactionOrigin = 'transactionOrigin',\n}\n"]}

package/dist/cronjob.d.ts

@@ -0,0 +1,89 @@
+import { Infer } from 'superstruct';
+export declare const CronjobRpcRequestStruct: import("superstruct").Struct<{
+    method: string;
+    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+    id?: string | number | null | undefined;
+    jsonrpc?: "2.0" | undefined;
+}, {
+    params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+    method: import("superstruct").Struct<string, null>;
+    id: import("superstruct").Struct<string | number | null | undefined, unknown>;
+    jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
+}>;
+export declare type CronjobRpcRequest = Infer<typeof CronjobRpcRequestStruct>;
+export declare const CronExpressionStruct: import("superstruct").Struct<string, null>;
+export declare type CronExpression = Infer<typeof CronExpressionStruct>;
+/**
+ * Parses a cron expression.
+ *
+ * @param expression - Expression to parse.
+ * @returns A CronExpression class instance.
+ */
+export declare function parseCronExpression(expression: string | object): import("cron-parser").CronExpression<false>;
+export declare const CronjobSpecificationStruct: import("superstruct").Struct<{
+    expression: string;
+    request: {
+        method: string;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+    };
+}, {
+    expression: import("superstruct").Struct<string, null>;
+    request: import("superstruct").Struct<{
+        method: string;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+    }, {
+        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+        method: import("superstruct").Struct<string, null>;
+        id: import("superstruct").Struct<string | number | null | undefined, unknown>;
+        jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
+    }>;
+}>;
+export declare type CronjobSpecification = Infer<typeof CronjobSpecificationStruct>;
+/**
+ * Check if the given value is a {@link CronjobSpecification} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link CronjobSpecification} object.
+ */
+export declare function isCronjobSpecification(value: unknown): boolean;
+export declare const CronjobSpecificationArrayStruct: import("superstruct").Struct<{
+    expression: string;
+    request: {
+        method: string;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+    };
+}[], import("superstruct").Struct<{
+    expression: string;
+    request: {
+        method: string;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+    };
+}, {
+    expression: import("superstruct").Struct<string, null>;
+    request: import("superstruct").Struct<{
+        method: string;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+    }, {
+        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+        method: import("superstruct").Struct<string, null>;
+        id: import("superstruct").Struct<string | number | null | undefined, unknown>;
+        jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
+    }>;
+}>>;
+/**
+ * Check if the given value is an array of {@link CronjobSpecification} objects.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid array of {@link CronjobSpecification} objects.
+ */
+export declare function isCronjobSpecificationArray(value: unknown): boolean;

package/dist/cronjob.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCronjobSpecificationArray = exports.CronjobSpecificationArrayStruct = exports.isCronjobSpecification = exports.CronjobSpecificationStruct = exports.parseCronExpression = exports.CronExpressionStruct = exports.CronjobRpcRequestStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const cron_parser_1 = require("cron-parser");
+const superstruct_1 = require("superstruct");
+exports.CronjobRpcRequestStruct = (0, superstruct_1.assign)((0, superstruct_1.partial)((0, superstruct_1.pick)(utils_1.JsonRpcRequestStruct, ['id', 'jsonrpc'])), (0, superstruct_1.omit)(utils_1.JsonRpcRequestStruct, ['id', 'jsonrpc']));
+exports.CronExpressionStruct = (0, superstruct_1.refine)((0, superstruct_1.coerce)((0, superstruct_1.string)(), (0, superstruct_1.object)({
+    minute: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    hour: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    dayOfMonth: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    month: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    dayOfWeek: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+}), (value) => {
+    var _a, _b, _c, _d, _e;
+    return `${(_a = value.minute) !== null && _a !== void 0 ? _a : '*'} ${(_b = value.hour) !== null && _b !== void 0 ? _b : '*'} ${(_c = value.dayOfMonth) !== null && _c !== void 0 ? _c : '*'} ${(_d = value.month) !== null && _d !== void 0 ? _d : '*'} ${(_e = value.dayOfWeek) !== null && _e !== void 0 ? _e : '*'}`;
+}), 'CronExpression', (value) => {
+    try {
+        (0, cron_parser_1.parseExpression)(value);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+});
+/**
+ * Parses a cron expression.
+ *
+ * @param expression - Expression to parse.
+ * @returns A CronExpression class instance.
+ */
+function parseCronExpression(expression) {
+    const ensureStringExpression = (0, superstruct_1.create)(expression, exports.CronExpressionStruct);
+    return (0, cron_parser_1.parseExpression)(ensureStringExpression);
+}
+exports.parseCronExpression = parseCronExpression;
+exports.CronjobSpecificationStruct = (0, superstruct_1.object)({
+    expression: exports.CronExpressionStruct,
+    request: exports.CronjobRpcRequestStruct,
+});
+/**
+ * Check if the given value is a {@link CronjobSpecification} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link CronjobSpecification} object.
+ */
+function isCronjobSpecification(value) {
+    try {
+        (0, superstruct_1.create)(value, exports.CronjobSpecificationStruct);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+exports.isCronjobSpecification = isCronjobSpecification;
+exports.CronjobSpecificationArrayStruct = (0, superstruct_1.array)(exports.CronjobSpecificationStruct);
+/**
+ * Check if the given value is an array of {@link CronjobSpecification} objects.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid array of {@link CronjobSpecification} objects.
+ */
+function isCronjobSpecificationArray(value) {
+    try {
+        (0, superstruct_1.create)(value, exports.CronjobSpecificationArrayStruct);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+exports.isCronjobSpecificationArray = isCronjobSpecificationArray;
+//# sourceMappingURL=cronjob.js.map

package/dist/cronjob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cronjob.js","sourceRoot":"","sources":["../src/cronjob.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,6CAA8C;AAC9C,6CAaqB;AAER,QAAA,uBAAuB,GAAG,IAAA,oBAAM,EAC3C,IAAA,qBAAO,EAAC,IAAA,kBAAI,EAAC,4BAAoB,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EACtD,IAAA,kBAAI,EAAC,4BAAoB,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAC9C,CAAC;AAGW,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EACxC,IAAA,oBAAM,EACJ,IAAA,oBAAM,GAAE,EACR,IAAA,oBAAM,EAAC;IACL,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC1B,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACxB,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACzB,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC9B,CAAC,EACF,CAAC,KAAK,EAAE,EAAE;;IACR,OAAA,GAAG,MAAA,KAAK,CAAC,MAAM,mCAAI,GAAG,IAAI,MAAA,KAAK,CAAC,IAAI,mCAAI,GAAG,IAAI,MAAA,KAAK,CAAC,UAAU,mCAAI,GAAG,IACpE,MAAA,KAAK,CAAC,KAAK,mCAAI,GACjB,IAAI,MAAA,KAAK,CAAC,SAAS,mCAAI,GAAG,EAAE,CAAA;CAAA,CAC/B,EACD,gBAAgB,EAChB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI;QACF,IAAA,6BAAe,EAAC,KAAK,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;KACb;IAAC,WAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CACF,CAAC;AAIF;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,UAA2B;IAC7D,MAAM,sBAAsB,GAAG,IAAA,oBAAM,EAAC,UAAU,EAAE,4BAAoB,CAAC,CAAC;IACxE,OAAO,IAAA,6BAAe,EAAC,sBAAsB,CAAC,CAAC;AACjD,CAAC;AAHD,kDAGC;AAEY,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,UAAU,EAAE,4BAAoB;IAChC,OAAO,EAAE,+BAAuB;CACjC,CAAC,CAAC;AAGH;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,KAAc;IACnD,IAAI;QACF,IAAA,oBAAM,EAAC,KAAK,EAAE,kCAA0B,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;KACb;IAAC,WAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wDAOC;AAEY,QAAA,+BAA+B,GAAG,IAAA,mBAAK,EAClD,kCAA0B,CAC3B,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,KAAc;IACxD,IAAI;QACF,IAAA,oBAAM,EAAC,KAAK,EAAE,uCAA+B,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;KACb;IAAC,WAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,kEAOC","sourcesContent":["import { JsonRpcRequestStruct } from '@metamask/utils';\nimport { parseExpression } from 'cron-parser';\nimport {\n  array,\n  assign,\n  coerce,\n  create,\n  Infer,\n  object,\n  omit,\n  optional,\n  partial,\n  pick,\n  refine,\n  string,\n} from 'superstruct';\n\nexport const CronjobRpcRequestStruct = assign(\n  partial(pick(JsonRpcRequestStruct, ['id', 'jsonrpc'])),\n  omit(JsonRpcRequestStruct, ['id', 'jsonrpc']),\n);\nexport type CronjobRpcRequest = Infer<typeof CronjobRpcRequestStruct>;\n\nexport const CronExpressionStruct = refine(\n  coerce(\n    string(),\n    object({\n      minute: optional(string()),\n      hour: optional(string()),\n      dayOfMonth: optional(string()),\n      month: optional(string()),\n      dayOfWeek: optional(string()),\n    }),\n    (value) =>\n      `${value.minute ?? '*'} ${value.hour ?? '*'} ${value.dayOfMonth ?? '*'} ${\n        value.month ?? '*'\n      } ${value.dayOfWeek ?? '*'}`,\n  ),\n  'CronExpression',\n  (value) => {\n    try {\n      parseExpression(value);\n      return true;\n    } catch {\n      return false;\n    }\n  },\n);\n\nexport type CronExpression = Infer<typeof CronExpressionStruct>;\n\n/**\n * Parses a cron expression.\n *\n * @param expression - Expression to parse.\n * @returns A CronExpression class instance.\n */\nexport function parseCronExpression(expression: string | object) {\n  const ensureStringExpression = create(expression, CronExpressionStruct);\n  return parseExpression(ensureStringExpression);\n}\n\nexport const CronjobSpecificationStruct = object({\n  expression: CronExpressionStruct,\n  request: CronjobRpcRequestStruct,\n});\nexport type CronjobSpecification = Infer<typeof CronjobSpecificationStruct>;\n\n/**\n * Check if the given value is a {@link CronjobSpecification} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link CronjobSpecification} object.\n */\nexport function isCronjobSpecification(value: unknown): boolean {\n  try {\n    create(value, CronjobSpecificationStruct);\n    return true;\n  } catch {\n    return false;\n  }\n}\n\nexport const CronjobSpecificationArrayStruct = array(\n  CronjobSpecificationStruct,\n);\n\n/**\n * Check if the given value is an array of {@link CronjobSpecification} objects.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid array of {@link CronjobSpecification} objects.\n */\nexport function isCronjobSpecificationArray(value: unknown): boolean {\n  try {\n    create(value, CronjobSpecificationArrayStruct);\n    return true;\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/deep-clone.d.ts

@@ -0,0 +1 @@
+export declare const deepClone: <T>(input: T) => T;

package/dist/deep-clone.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepClone = void 0;
+const rfdc_1 = __importDefault(require("rfdc"));
+exports.deepClone = (0, rfdc_1.default)({ proto: false, circles: false });
+//# sourceMappingURL=deep-clone.js.map

package/dist/deep-clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deep-clone.js","sourceRoot":"","sources":["../src/deep-clone.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAEX,QAAA,SAAS,GAAG,IAAA,cAAI,EAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC","sourcesContent":["import rfdc from 'rfdc';\n\nexport const deepClone = rfdc({ proto: false, circles: false });\n"]}

package/dist/default-endowments.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Global JavaScript APIs exposed by default to all snaps.
+ */
+export declare const DEFAULT_ENDOWMENTS: readonly string[];

package/dist/default-endowments.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_ENDOWMENTS = void 0;
+/**
+ * Global JavaScript APIs exposed by default to all snaps.
+ */
+exports.DEFAULT_ENDOWMENTS = Object.freeze([
+    'atob',
+    'btoa',
+    'BigInt',
+    'console',
+    'crypto',
+    'Date',
+    'Math',
+    'setTimeout',
+    'clearTimeout',
+    'SubtleCrypto',
+    'TextDecoder',
+    'TextEncoder',
+    'URL',
+    'WebAssembly',
+    'setInterval',
+    'clearInterval',
+    'Int8Array',
+    'Uint8Array',
+    'Uint8ClampedArray',
+    'Int16Array',
+    'Uint16Array',
+    'Int32Array',
+    'Uint32Array',
+    'Float32Array',
+    'Float64Array',
+    'BigInt64Array',
+    'BigUint64Array',
+    'DataView',
+    'ArrayBuffer',
+    // Used by fetch, but also as API for some packages that don't do network connections
+    // https://github.com/MetaMask/snaps-monorepo/issues/662
+    // https://github.com/MetaMask/snaps-monorepo/discussions/678
+    'AbortController',
+    'AbortSignal',
+]);
+//# sourceMappingURL=default-endowments.js.map

package/dist/default-endowments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-endowments.js","sourceRoot":"","sources":["../src/default-endowments.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,kBAAkB,GAAsB,MAAM,CAAC,MAAM,CAAC;IACjE,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,MAAM;IACN,MAAM;IACN,YAAY;IACZ,cAAc;IACd,cAAc;IACd,aAAa;IACb,aAAa;IACb,KAAK;IACL,aAAa;IACb,aAAa;IACb,eAAe;IACf,WAAW;IACX,YAAY;IACZ,mBAAmB;IACnB,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,aAAa;IACb,cAAc;IACd,cAAc;IACd,eAAe;IACf,gBAAgB;IAChB,UAAU;IACV,aAAa;IACb,qFAAqF;IACrF,wDAAwD;IACxD,6DAA6D;IAC7D,iBAAiB;IACjB,aAAa;CACd,CAAC,CAAC","sourcesContent":["/**\n * Global JavaScript APIs exposed by default to all snaps.\n */\nexport const DEFAULT_ENDOWMENTS: readonly string[] = Object.freeze([\n  'atob',\n  'btoa',\n  'BigInt',\n  'console',\n  'crypto',\n  'Date',\n  'Math',\n  'setTimeout',\n  'clearTimeout',\n  'SubtleCrypto',\n  'TextDecoder',\n  'TextEncoder',\n  'URL',\n  'WebAssembly',\n  'setInterval',\n  'clearInterval',\n  'Int8Array',\n  'Uint8Array',\n  'Uint8ClampedArray',\n  'Int16Array',\n  'Uint16Array',\n  'Int32Array',\n  'Uint32Array',\n  'Float32Array',\n  'Float64Array',\n  'BigInt64Array',\n  'BigUint64Array',\n  'DataView',\n  'ArrayBuffer',\n  // Used by fetch, but also as API for some packages that don't do network connections\n  // https://github.com/MetaMask/snaps-monorepo/issues/662\n  // https://github.com/MetaMask/snaps-monorepo/discussions/678\n  'AbortController',\n  'AbortSignal',\n]);\n"]}

package/dist/eval-worker.d.ts

@@ -0,0 +1 @@
+import 'ses/lockdown';

package/dist/eval-worker.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line import/no-unassigned-import
+require("ses/lockdown");
+const fs_1 = require("fs");
+const mock_1 = require("./mock");
+const types_1 = require("./types");
+lockdown(Object.assign({ consoleTaming: 'unsafe', errorTaming: 'unsafe', mathTaming: 'unsafe', dateTaming: 'unsafe', overrideTaming: 'severe' }, (process.env.NODE_ENV === 'test'
+    ? {
+        domainTaming: 'unsafe',
+    }
+    : {})));
+/**
+ * Get mock endowments that don't do anything. This is useful for running the
+ * eval, for snaps that try to communicate with the extension on initialisation,
+ * for example.
+ *
+ * @returns The mock endowments.
+ */
+function getMockEndowments() {
+    const endowments = (0, mock_1.generateMockEndowments)();
+    return Object.assign(Object.assign({}, endowments), { window: endowments, self: endowments });
+}
+const snapFilePath = process.argv[2];
+const snapModule = { exports: {} };
+new Compartment(Object.assign(Object.assign({}, getMockEndowments()), { module: snapModule, exports: snapModule.exports })).evaluate((0, fs_1.readFileSync)(snapFilePath, 'utf8'));
+const invalidExports = Object.keys(snapModule.exports).filter((snapExport) => !types_1.SNAP_EXPORT_NAMES.includes(snapExport));
+if (invalidExports.length > 0) {
+    console.warn(`Invalid snap exports detected:\n${invalidExports.join('\n')}`);
+}
+setTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits
+//# sourceMappingURL=eval-worker.js.map

package/dist/eval-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eval-worker.js","sourceRoot":"","sources":["../src/eval-worker.ts"],"names":[],"mappings":";;AAAA,uDAAuD;AACvD,wBAAsB;AAEtB,2BAAkC;AAClC,iCAAgD;AAChD,mCAAyD;AAIzD,QAAQ,iBACN,aAAa,EAAE,QAAQ,EACvB,WAAW,EAAE,QAAQ,EACrB,UAAU,EAAE,QAAQ,EACpB,UAAU,EAAE,QAAQ,EACpB,cAAc,EAAE,QAAQ,IAIrB,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM;IACjC,CAAC,CAAC;QACE,YAAY,EAAE,QAAQ;KACvB;IACH,CAAC,CAAC,EAAE,CAAC,EACP,CAAC;AAEH;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,MAAM,UAAU,GAAG,IAAA,6BAAsB,GAAE,CAAC;IAC5C,uCACK,UAAU,KACb,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,UAAU,IAChB;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAErC,MAAM,UAAU,GAAsB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEtD,IAAI,WAAW,iCACV,iBAAiB,EAAE,KACtB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,UAAU,CAAC,OAAO,IAC3B,CAAC,QAAQ,CAAC,IAAA,iBAAY,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAEhD,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,CAC3D,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,yBAAiB,CAAC,QAAQ,CAAC,UAAyB,CAAC,CACvE,CAAC;AAEF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;IAC7B,OAAO,CAAC,IAAI,CAAC,mCAAmC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;CAC9E;AAED,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAA8B","sourcesContent":["// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\n\nimport { readFileSync } from 'fs';\nimport { generateMockEndowments } from './mock';\nimport { HandlerType, SNAP_EXPORT_NAMES } from './types';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n\n  // TODO: See if there's an easier way to do this. This file is ran in a\n  // separate process, so we can't mock SES with Jest.\n  ...(process.env.NODE_ENV === 'test'\n    ? {\n        domainTaming: 'unsafe',\n      }\n    : {}),\n});\n\n/**\n * Get mock endowments that don't do anything. This is useful for running the\n * eval, for snaps that try to communicate with the extension on initialisation,\n * for example.\n *\n * @returns The mock endowments.\n */\nfunction getMockEndowments() {\n  const endowments = generateMockEndowments();\n  return {\n    ...endowments,\n    window: endowments,\n    self: endowments,\n  };\n}\n\nconst snapFilePath = process.argv[2];\n\nconst snapModule: { exports?: any } = { exports: {} };\n\nnew Compartment({\n  ...getMockEndowments(),\n  module: snapModule,\n  exports: snapModule.exports,\n}).evaluate(readFileSync(snapFilePath, 'utf8'));\n\nconst invalidExports = Object.keys(snapModule.exports).filter(\n  (snapExport) => !SNAP_EXPORT_NAMES.includes(snapExport as HandlerType),\n);\n\nif (invalidExports.length > 0) {\n  console.warn(`Invalid snap exports detected:\\n${invalidExports.join('\\n')}`);\n}\n\nsetTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits\n"]}

package/dist/eval.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Spawn a new process to run the provided bundle in.
+ *
+ * @param bundlePath - The path to the bundle to run.
+ * @returns `null` if the worker ran successfully.
+ * @throws If the worker failed to run successfully.
+ */
+export declare function evalBundle(bundlePath: string): Promise<null>;

package/dist/eval.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evalBundle = void 0;
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+const fs_1 = require("./fs");
+const WORKER_PATH = (0, path_1.join)(__dirname, 'eval-worker.js');
+/**
+ * Spawn a new process to run the provided bundle in.
+ *
+ * @param bundlePath - The path to the bundle to run.
+ * @returns `null` if the worker ran successfully.
+ * @throws If the worker failed to run successfully.
+ */
+async function evalBundle(bundlePath) {
+    await (0, fs_1.validateFilePath)(bundlePath);
+    return new Promise((resolve, reject) => {
+        const worker = (0, child_process_1.fork)(WORKER_PATH, [bundlePath]);
+        worker.on('exit', (exitCode) => {
+            if (exitCode === 0) {
+                return resolve(null);
+            }
+            return reject(new Error(`Process exited with non-zero exit code: ${exitCode}`));
+        });
+    });
+}
+exports.evalBundle = evalBundle;
+//# sourceMappingURL=eval.js.map

package/dist/eval.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eval.js","sourceRoot":"","sources":["../src/eval.ts"],"names":[],"mappings":";;;AAAA,+BAA4B;AAC5B,iDAAqC;AACrC,6BAAwC;AAExC,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AAEtD;;;;;;GAMG;AACI,KAAK,UAAU,UAAU,CAAC,UAAkB;IACjD,MAAM,IAAA,qBAAgB,EAAC,UAAoB,CAAC,CAAC;IAE7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,IAAA,oBAAI,EAAC,WAAW,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QAE/C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAgB,EAAE,EAAE;YACrC,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;aACtB;YAED,OAAO,MAAM,CACX,IAAI,KAAK,CAAC,2CAA2C,QAAQ,EAAE,CAAC,CACjE,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAhBD,gCAgBC","sourcesContent":["import { join } from 'path';\nimport { fork } from 'child_process';\nimport { validateFilePath } from './fs';\n\nconst WORKER_PATH = join(__dirname, 'eval-worker.js');\n\n/**\n * Spawn a new process to run the provided bundle in.\n *\n * @param bundlePath - The path to the bundle to run.\n * @returns `null` if the worker ran successfully.\n * @throws If the worker failed to run successfully.\n */\nexport async function evalBundle(bundlePath: string): Promise<null> {\n  await validateFilePath(bundlePath as string);\n\n  return new Promise((resolve, reject) => {\n    const worker = fork(WORKER_PATH, [bundlePath]);\n\n    worker.on('exit', (exitCode: number) => {\n      if (exitCode === 0) {\n        return resolve(null);\n      }\n\n      return reject(\n        new Error(`Process exited with non-zero exit code: ${exitCode}`),\n      );\n    });\n  });\n}\n"]}

package/dist/flatMap.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Flattens an array of arrays of up to 1 level deep into a single array.
+ *
+ * This is a non-recursive implementation of `Array.prototype.flat`, which is
+ * only available in ES2019 and above.
+ *
+ * @param array - The array to flatten.
+ * @returns The flattened array.
+ */
+export declare const flatten: <Type>(array: (Type | Type[])[]) => Type[];
+/**
+ * Maps an array of values using the provided callback, then flattens the result
+ * into a single array, up to 1 level deep.
+ *
+ * This is a non-recursive implementation of `Array.prototype.flatMap`, which is
+ * only available in ES2019 and above.
+ *
+ * @param array - The array to map.
+ * @param callback - The callback to map each value with.
+ * @returns The mapped and flattened array.
+ */
+export declare const flatMap: <Type, Return>(array: Type[], callback: (value: Type) => Return | Return[]) => Return[];

package/dist/flatMap.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flatMap = exports.flatten = void 0;
+/**
+ * Flattens an array of arrays of up to 1 level deep into a single array.
+ *
+ * This is a non-recursive implementation of `Array.prototype.flat`, which is
+ * only available in ES2019 and above.
+ *
+ * @param array - The array to flatten.
+ * @returns The flattened array.
+ */
+const flatten = (array) => {
+    return array.reduce((acc, cur) => {
+        if (Array.isArray(cur)) {
+            return [...acc, ...cur];
+        }
+        acc.push(cur);
+        return acc;
+    }, []);
+};
+exports.flatten = flatten;
+/**
+ * Maps an array of values using the provided callback, then flattens the result
+ * into a single array, up to 1 level deep.
+ *
+ * This is a non-recursive implementation of `Array.prototype.flatMap`, which is
+ * only available in ES2019 and above.
+ *
+ * @param array - The array to map.
+ * @param callback - The callback to map each value with.
+ * @returns The mapped and flattened array.
+ */
+const flatMap = (array, callback) => {
+    return (0, exports.flatten)(array.map(callback));
+};
+exports.flatMap = flatMap;
+//# sourceMappingURL=flatMap.js.map

package/dist/flatMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flatMap.js","sourceRoot":"","sources":["../src/flatMap.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACI,MAAM,OAAO,GAAG,CAAO,KAAwB,EAAU,EAAE;IAChE,OAAO,KAAK,CAAC,MAAM,CAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC;SACzB;QACD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,CAAC;AARW,QAAA,OAAO,WAQlB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,OAAO,GAAG,CACrB,KAAa,EACb,QAA4C,EAClC,EAAE;IACZ,OAAO,IAAA,eAAO,EAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AALW,QAAA,OAAO,WAKlB","sourcesContent":["/**\n * Flattens an array of arrays of up to 1 level deep into a single array.\n *\n * This is a non-recursive implementation of `Array.prototype.flat`, which is\n * only available in ES2019 and above.\n *\n * @param array - The array to flatten.\n * @returns The flattened array.\n */\nexport const flatten = <Type>(array: (Type | Type[])[]): Type[] => {\n  return array.reduce<Type[]>((acc, cur) => {\n    if (Array.isArray(cur)) {\n      return [...acc, ...cur];\n    }\n    acc.push(cur);\n    return acc;\n  }, []);\n};\n\n/**\n * Maps an array of values using the provided callback, then flattens the result\n * into a single array, up to 1 level deep.\n *\n * This is a non-recursive implementation of `Array.prototype.flatMap`, which is\n * only available in ES2019 and above.\n *\n * @param array - The array to map.\n * @param callback - The callback to map each value with.\n * @returns The mapped and flattened array.\n */\nexport const flatMap = <Type, Return>(\n  array: Type[],\n  callback: (value: Type) => Return | Return[],\n): Return[] => {\n  return flatten(array.map(callback));\n};\n"]}

package/dist/fs.d.ts

@@ -0,0 +1,69 @@
+import { Json } from '@metamask/utils';
+import { NpmSnapFileNames } from './types';
+/**
+ * Checks whether the given path string resolves to an existing directory, and
+ * optionally creates the directory if it doesn't exist.
+ *
+ * @param pathString - The path string to check.
+ * @param createDir - Whether to create the directory if it doesn't exist.
+ * @returns Whether the given path is an existing directory.
+ */
+export declare function isDirectory(pathString: string, createDir: boolean): Promise<boolean>;
+/**
+ * Checks whether the given path string resolves to an existing file.
+ *
+ * @param pathString - The path string to check.
+ * @returns Whether the given path is an existing file.
+ */
+export declare function isFile(pathString: string): Promise<boolean>;
+/**
+ * Reads a `.json` file, parses its contents, and returns them.
+ *
+ * @param pathString - The path to the JSON file.
+ * @returns The parsed contents of the JSON file.
+ */
+export declare function readJsonFile<Type = Json>(pathString: string): Promise<Type>;
+/**
+ * Utility function for reading `package.json` or the Snap manifest file.
+ * These are assumed to be in the current working directory.
+ *
+ * @param pathString - The base path of the file to read.
+ * @param snapJsonFileName - The name of the file to read.
+ * @returns The parsed JSON file.
+ */
+export declare function readSnapJsonFile(pathString: string, snapJsonFileName: NpmSnapFileNames): Promise<Json>;
+/**
+ * Gets the complete out file path from an output file name and parent
+ * directory path.
+ *
+ * @param outDir - The path to the out file's parent directory.
+ * @param outFileName - The out file's name.
+ * @returns The complete path to the out file.
+ */
+export declare function getOutfilePath(outDir: string, outFileName: string): string;
+/**
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
+ *
+ * @param filename - The file name to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the file name is invalid.
+ */
+export declare function validateOutfileName(filename: string): boolean;
+/**
+ * Validates a file path. Throws on validation failure.
+ *
+ * @param filePath - The file path to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the path does not resolve to a file.
+ */
+export declare function validateFilePath(filePath: string): Promise<boolean>;
+/**
+ * Validates a directory path. Throws on validation failure.
+ *
+ * @param dirPath - The directory path to validate.
+ * @param createDir - Whether to create the directory if it doesn't exist.
+ * @returns `true` if validation succeeded or the directory was created.
+ * @throws If the directory does not exist or could not be created.
+ */
+export declare function validateDirPath(dirPath: string, createDir: boolean): Promise<boolean>;