@metamask/snaps-utils 0.24.0

package/dist/fs.js

@@ -0,0 +1,144 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDirPath = exports.validateFilePath = exports.validateOutfileName = exports.getOutfilePath = exports.readSnapJsonFile = exports.readJsonFile = exports.isFile = exports.isDirectory = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+/**
+ * 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.
+ */
+async function isDirectory(pathString, createDir) {
+    try {
+        const stats = await fs_1.promises.stat(pathString);
+        return stats.isDirectory();
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            if (!createDir) {
+                return false;
+            }
+            await fs_1.promises.mkdir(pathString, { recursive: true });
+            return true;
+        }
+        return false;
+    }
+}
+exports.isDirectory = isDirectory;
+/**
+ * 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.
+ */
+async function isFile(pathString) {
+    try {
+        const stats = await fs_1.promises.stat(pathString);
+        return stats.isFile();
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.isFile = isFile;
+/**
+ * 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.
+ */
+async function readJsonFile(pathString) {
+    if (!pathString.endsWith('.json')) {
+        throw new Error('The specified file must be a ".json" file.');
+    }
+    return JSON.parse(await fs_1.promises.readFile(pathString, 'utf8'));
+}
+exports.readJsonFile = readJsonFile;
+/**
+ * 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.
+ */
+async function readSnapJsonFile(pathString, snapJsonFileName) {
+    const path = path_1.default.join(pathString, snapJsonFileName);
+    try {
+        return await readJsonFile(path);
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            throw new Error(`Could not find '${path}'. Please ensure that the file exists.`);
+        }
+        throw error;
+    }
+}
+exports.readSnapJsonFile = readSnapJsonFile;
+/**
+ * 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.
+ */
+function getOutfilePath(outDir, outFileName) {
+    return path_1.default.join(outDir, outFileName || 'bundle.js');
+}
+exports.getOutfilePath = getOutfilePath;
+/**
+ * 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.
+ */
+function validateOutfileName(filename) {
+    if (!filename.endsWith('.js') ||
+        filename === '.js' ||
+        path_1.default.basename(filename) !== filename) {
+        throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);
+    }
+    return true;
+}
+exports.validateOutfileName = validateOutfileName;
+/**
+ * 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.
+ */
+async function validateFilePath(filePath) {
+    const exists = await isFile(filePath);
+    if (!exists) {
+        throw new Error(`Invalid params: '${filePath}' is not a file or does not exist.`);
+    }
+    return true;
+}
+exports.validateFilePath = validateFilePath;
+/**
+ * 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.
+ */
+async function validateDirPath(dirPath, createDir) {
+    const exists = await isDirectory(dirPath, createDir);
+    if (!exists) {
+        throw new Error(`Invalid params: '${dirPath}' is not a directory or could not be created.`);
+    }
+    return true;
+}
+exports.validateDirPath = validateDirPath;
+//# sourceMappingURL=fs.js.map

package/dist/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAI7B;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,KAAK,CAAC;aACd;YAED,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAnBD,kCAmBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAChC,UAAkB;IAElB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,CAAC;AARD,oCAQC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,gBAAgB,CACpC,UAAkB,EAClB,gBAAkC;IAElC,MAAM,IAAI,GAAG,cAAS,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IAE1D,IAAI;QACF,OAAO,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;KACjC;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,mBAAmB,IAAI,wCAAwC,CAChE,CAAC;SACH;QAED,MAAM,KAAK,CAAC;KACb;AACH,CAAC;AAjBD,4CAiBC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,WAAmB;IAChE,OAAO,cAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,QAAQ,KAAK,KAAK;QAClB,cAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EACzC;QACA,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,sBAAsB,CAAC,CAAC;KAC1E;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,oCAAoC,CACjE,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,SAAkB;IAElB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,+CAA+C,CAC3E,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,0CAWC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport { Json } from '@metamask/utils';\nimport { NpmSnapFileNames } from './types';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns Whether the given path is an existing directory.\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      await fs.mkdir(pathString, { recursive: true });\n      return true;\n    }\n\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param pathString - The path string to check.\n * @returns Whether the given path is an existing file.\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n\n/**\n * Reads a `.json` file, parses its contents, and returns them.\n *\n * @param pathString - The path to the JSON file.\n * @returns The parsed contents of the JSON file.\n */\nexport async function readJsonFile<Type = Json>(\n  pathString: string,\n): Promise<Type> {\n  if (!pathString.endsWith('.json')) {\n    throw new Error('The specified file must be a \".json\" file.');\n  }\n\n  return JSON.parse(await fs.readFile(pathString, 'utf8'));\n}\n\n/**\n * Utility function for reading `package.json` or the Snap manifest file.\n * These are assumed to be in the current working directory.\n *\n * @param pathString - The base path of the file to read.\n * @param snapJsonFileName - The name of the file to read.\n * @returns The parsed JSON file.\n */\nexport async function readSnapJsonFile(\n  pathString: string,\n  snapJsonFileName: NpmSnapFileNames,\n): Promise<Json> {\n  const path = pathUtils.join(pathString, snapJsonFileName);\n\n  try {\n    return await readJsonFile(path);\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      throw new Error(\n        `Could not find '${path}'. Please ensure that the file exists.`,\n      );\n    }\n\n    throw error;\n  }\n}\n\n/**\n * Gets the complete out file path from an output file name and parent\n * directory path.\n *\n * @param outDir - The path to the out file's parent directory.\n * @param outFileName - The out file's name.\n * @returns The complete path to the out file.\n */\nexport function getOutfilePath(outDir: string, outFileName: string): string {\n  return pathUtils.join(outDir, outFileName || 'bundle.js');\n}\n\n/**\n * Ensures that the outfile name is just a `.js` file name.\n * Throws on validation failure.\n *\n * @param filename - The file name to validate.\n * @returns `true` if validation succeeded.\n * @throws If the file name is invalid.\n */\nexport function validateOutfileName(filename: string): boolean {\n  if (\n    !filename.endsWith('.js') ||\n    filename === '.js' ||\n    pathUtils.basename(filename) !== filename\n  ) {\n    throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);\n  }\n  return true;\n}\n\n/**\n * Validates a file path. Throws on validation failure.\n *\n * @param filePath - The file path to validate.\n * @returns `true` if validation succeeded.\n * @throws If the path does not resolve to a file.\n */\nexport async function validateFilePath(filePath: string): Promise<boolean> {\n  const exists = await isFile(filePath);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${filePath}' is not a file or does not exist.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Validates a directory path. Throws on validation failure.\n *\n * @param dirPath - The directory path to validate.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns `true` if validation succeeded or the directory was created.\n * @throws If the directory does not exist or could not be created.\n */\nexport async function validateDirPath(\n  dirPath: string,\n  createDir: boolean,\n): Promise<boolean> {\n  const exists = await isDirectory(dirPath, createDir);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${dirPath}' is not a directory or could not be created.`,\n    );\n  }\n  return true;\n}\n"]}

package/dist/index.browser.d.ts

@@ -0,0 +1,13 @@
+export * from './caveats';
+export * from './deep-clone';
+export * from './default-endowments';
+export * from './flatMap';
+export * from './json-rpc';
+export * from './manifest/index.browser';
+export * from './namespace';
+export * from './notification';
+export * from './object';
+export * from './snaps';
+export * from './types';
+export * from './url';
+export * from './versions';

package/dist/index.browser.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./caveats"), exports);
+__exportStar(require("./deep-clone"), exports);
+__exportStar(require("./default-endowments"), exports);
+__exportStar(require("./flatMap"), exports);
+__exportStar(require("./json-rpc"), exports);
+__exportStar(require("./manifest/index.browser"), exports);
+__exportStar(require("./namespace"), exports);
+__exportStar(require("./notification"), exports);
+__exportStar(require("./object"), exports);
+__exportStar(require("./snaps"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./url"), exports);
+__exportStar(require("./versions"), exports);
+//# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,+CAA6B;AAC7B,uDAAqC;AACrC,4CAA0B;AAC1B,6CAA2B;AAC3B,2DAAyC;AACzC,8CAA4B;AAC5B,iDAA+B;AAC/B,2CAAyB;AACzB,0CAAwB;AACxB,0CAAwB;AACxB,wCAAsB;AACtB,6CAA2B","sourcesContent":["export * from './caveats';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './flatMap';\nexport * from './json-rpc';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './notification';\nexport * from './object';\nexport * from './snaps';\nexport * from './types';\nexport * from './url';\nexport * from './versions';\n"]}

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+export * from './caveats';
+export * from './cronjob';
+export * from './deep-clone';
+export * from './default-endowments';
+export * from './eval';
+export * from './flatMap';
+export * from './fs';
+export * from './json-rpc';
+export * from './manifest';
+export * from './mock';
+export * from './namespace';
+export * from './notification';
+export * from './npm';
+export * from './object';
+export * from './post-process';
+export * from './snaps';
+export * from './types';
+export * from './url';
+export * from './versions';

package/dist/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./caveats"), exports);
+__exportStar(require("./cronjob"), exports);
+__exportStar(require("./deep-clone"), exports);
+__exportStar(require("./default-endowments"), exports);
+__exportStar(require("./eval"), exports);
+__exportStar(require("./flatMap"), exports);
+__exportStar(require("./fs"), exports);
+__exportStar(require("./json-rpc"), exports);
+__exportStar(require("./manifest"), exports);
+__exportStar(require("./mock"), exports);
+__exportStar(require("./namespace"), exports);
+__exportStar(require("./notification"), exports);
+__exportStar(require("./npm"), exports);
+__exportStar(require("./object"), exports);
+__exportStar(require("./post-process"), exports);
+__exportStar(require("./snaps"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./url"), exports);
+__exportStar(require("./versions"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,4CAA0B;AAC1B,+CAA6B;AAC7B,uDAAqC;AACrC,yCAAuB;AACvB,4CAA0B;AAC1B,uCAAqB;AACrB,6CAA2B;AAC3B,6CAA2B;AAC3B,yCAAuB;AACvB,8CAA4B;AAC5B,iDAA+B;AAC/B,wCAAsB;AACtB,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB;AACxB,wCAAsB;AACtB,6CAA2B","sourcesContent":["export * from './caveats';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './eval';\nexport * from './flatMap';\nexport * from './fs';\nexport * from './json-rpc';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './notification';\nexport * from './npm';\nexport * from './object';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './types';\nexport * from './url';\nexport * from './versions';\n"]}

package/dist/json-rpc.d.ts

@@ -0,0 +1,10 @@
+import { Json, JsonRpcSuccess } from '@metamask/utils';
+/**
+ * Assert that the given value is a successful JSON-RPC response. If the value
+ * is not a success response, an error is thrown. If the value is an JSON-RPC
+ * error, the error message is included in the thrown error.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a JSON-RPC success response.
+ */
+export declare function assertIsJsonRpcSuccess(value: unknown): asserts value is JsonRpcSuccess<Json>;

package/dist/json-rpc.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsJsonRpcSuccess = void 0;
+const utils_1 = require("@metamask/utils");
+/**
+ * Assert that the given value is a successful JSON-RPC response. If the value
+ * is not a success response, an error is thrown. If the value is an JSON-RPC
+ * error, the error message is included in the thrown error.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a JSON-RPC success response.
+ */
+function assertIsJsonRpcSuccess(value) {
+    if (!(0, utils_1.isJsonRpcSuccess)(value)) {
+        if ((0, utils_1.isJsonRpcFailure)(value)) {
+            throw new Error(`JSON-RPC request failed: ${value.error.message}`);
+        }
+        throw new Error('Invalid JSON-RPC response.');
+    }
+}
+exports.assertIsJsonRpcSuccess = assertIsJsonRpcSuccess;
+//# sourceMappingURL=json-rpc.js.map

package/dist/json-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-rpc.js","sourceRoot":"","sources":["../src/json-rpc.ts"],"names":[],"mappings":";;;AAAA,2CAKyB;AAEzB;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc;IAEd,IAAI,CAAC,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAE;QAC5B,IAAI,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SACpE;QAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;AACH,CAAC;AAVD,wDAUC","sourcesContent":["import {\n  isJsonRpcFailure,\n  isJsonRpcSuccess,\n  Json,\n  JsonRpcSuccess,\n} from '@metamask/utils';\n\n/**\n * Assert that the given value is a successful JSON-RPC response. If the value\n * is not a success response, an error is thrown. If the value is an JSON-RPC\n * error, the error message is included in the thrown error.\n *\n * @param value - The value to check.\n * @throws If the value is not a JSON-RPC success response.\n */\nexport function assertIsJsonRpcSuccess(\n  value: unknown,\n): asserts value is JsonRpcSuccess<Json> {\n  if (!isJsonRpcSuccess(value)) {\n    if (isJsonRpcFailure(value)) {\n      throw new Error(`JSON-RPC request failed: ${value.error.message}`);\n    }\n\n    throw new Error('Invalid JSON-RPC response.');\n  }\n}\n"]}

package/dist/manifest/index.browser.d.ts

@@ -0,0 +1 @@
+export * from './validation';

package/dist/manifest/index.browser.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./validation"), exports);
+//# sourceMappingURL=index.browser.js.map

package/dist/manifest/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../../src/manifest/index.browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B","sourcesContent":["export * from './validation';\n"]}

package/dist/manifest/index.d.ts

@@ -0,0 +1,2 @@
+export * from './manifest';
+export * from './validation';

package/dist/manifest/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./manifest"), exports);
+__exportStar(require("./validation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/manifest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/manifest/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,+CAA6B","sourcesContent":["export * from './manifest';\nexport * from './validation';\n"]}

package/dist/manifest/manifest.d.ts

@@ -0,0 +1,75 @@
+import { Json } from '@metamask/utils';
+import { ProgrammaticallyFixableSnapError } from '../snaps';
+import { NpmSnapPackageJson, SnapFiles } from '../types';
+import { SnapManifest } from './validation';
+/**
+ * The result from the `checkManifest` function.
+ *
+ * @property manifest - The fixed manifest object.
+ * @property updated - Whether the manifest was updated.
+ * @property warnings - An array of warnings that were encountered during
+ * processing of the manifest files. These warnings are not logged to the
+ * console automatically, so depending on the environment the function is called
+ * in, a different method for logging can be used.
+ * @property errors - An array of errors that were encountered during
+ * processing of the manifest files. These errors are not logged to the
+ * console automatically, so depending on the environment the function is called
+ * in, a different method for logging can be used.
+ */
+export declare type CheckManifestResult = {
+    manifest: SnapManifest;
+    updated?: boolean;
+    warnings: string[];
+    errors: string[];
+};
+/**
+ * Validates a snap.manifest.json file. Attempts to fix the manifest and write
+ * the fixed version to disk if `writeManifest` is true. Throws if validation
+ * fails.
+ *
+ * @param basePath - The path to the folder with the manifest files.
+ * @param writeManifest - Whether to write the fixed manifest to disk.
+ * @param sourceCode - The source code of the Snap.
+ * @returns Whether the manifest was updated, and an array of warnings that
+ * were encountered during processing of the manifest files.
+ */
+export declare function checkManifest(basePath: string, writeManifest?: boolean, sourceCode?: string): Promise<CheckManifestResult>;
+/**
+ * Given the relevant Snap files (manifest, `package.json`, and bundle) and a
+ * Snap manifest validation error, fixes the fault in the manifest that caused
+ * the error.
+ *
+ * @param snapFiles - The contents of all Snap files.
+ * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.
+ * @returns A copy of the manifest file where the cause of the error is fixed.
+ */
+export declare function fixManifest(snapFiles: SnapFiles, error: ProgrammaticallyFixableSnapError): SnapManifest;
+/**
+ * Given an unvalidated Snap manifest, attempts to extract the location of the
+ * bundle source file location and read the file.
+ *
+ * @param basePath - The path to the folder with the manifest files.
+ * @param manifest - The unvalidated Snap manifest file contents.
+ * @returns The contents of the bundle file, if any.
+ */
+export declare function getSnapSourceCode(basePath: string, manifest: Json): Promise<string | undefined>;
+/**
+ * Sorts the given manifest in our preferred sort order and removes the
+ * `repository` field if it is falsy (it may be `null`).
+ *
+ * @param manifest - The manifest to sort and modify.
+ * @returns The disk-ready manifest.
+ */
+export declare function getWritableManifest(manifest: SnapManifest): SnapManifest;
+/**
+ * Validates the fields of an npm Snap manifest that has already passed JSON
+ * Schema validation.
+ *
+ * @param snapFiles - The relevant snap files to validate.
+ * @param snapFiles.manifest - The npm Snap manifest to validate.
+ * @param snapFiles.packageJson - The npm Snap's `package.json`.
+ * @param snapFiles.sourceCode - The Snap's source code.
+ * @returns A tuple containing the validated snap manifest, snap source code,
+ * and `package.json`.
+ */
+export declare function validateNpmSnapManifest({ manifest, packageJson, sourceCode, }: SnapFiles): [SnapManifest, string, NpmSnapPackageJson];