@metamask/snaps-cli 0.18.0 → 0.19.1

package/dist/cmds/eval/mock.js

@@ -1,98 +0,0 @@
-"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 events_1 = __importDefault(require("events"));
-const crypto_1 = __importDefault(require("crypto"));
-const snap_controllers_1 = require("@metamask/snap-controllers");
-const NETWORK_APIS = ['fetch', 'WebSocket'];
-exports.ALL_APIS = [...snap_controllers_1.DEFAULT_ENDOWMENTS, ...NETWORK_APIS];
-/**
- * Get a mock snap provider, that always returns `true` for requests.
- *
- * @returns A mocked snap provider.
- */
-function getMockSnapProvider() {
-    const mockProvider = new events_1.default();
-    mockProvider.request = async () => true;
-    return mockProvider;
-}
-/**
- * Check if a value is a constructor.
- *
- * @param value - The value to check.
- * @returns `true` if the value is a constructor, or `false` otherwise.
- */
-const isConstructor = (value) => { var _a, _b; return Boolean(typeof ((_b = (_a = value === null || value === void 0 ? void 0 : value.prototype) === null || _a === void 0 ? void 0 : _a.constructor) === null || _b === void 0 ? void 0 : _b.name) === 'string'); };
-exports.isConstructor = isConstructor;
-/**
- * A function that always returns `true`.
- *
- * @returns `true`.
- */
-const mockFunction = () => true;
-class MockClass {
-}
-const handler = {
-    construct(Target, args) {
-        return new Proxy(new Target(...args), handler);
-    },
-    get(_target, _prop) {
-        return mockFunction;
-    },
-};
-/**
- * Generate a mock class for a given value. The value is wrapped in a Proxy, and
- * all methods are replaced with a mock function.
- *
- * @param value - The value to mock.
- * @returns A mock class.
- */
-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 = {
-    WebSocket: MockClass,
-    crypto: crypto_1.default,
-    SubtleCrypto: MockClass,
-};
-/**
- * Generate a mock endowment for a certain class or function on the `globalThis`
- * object.
- *
- * @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 globalValue = globalThis[key];
-    // Default exposed APIs don't need to be mocked
-    if (globalValue && snap_controllers_1.DEFAULT_ENDOWMENTS.includes(key)) {
-        return globalValue;
-    }
-    // Fall back to mockWindow for certain APIs not exposed in global in Node.JS
-    const globalOrMocked = globalValue !== null && globalValue !== void 0 ? globalValue : mockWindow[key];
-    const type = typeof globalOrMocked;
-    const isFunction = type === 'function';
-    if (isFunction && (0, exports.isConstructor)(globalOrMocked)) {
-        return generateMockClass(globalOrMocked);
-    }
-    else if (isFunction || !globalOrMocked) {
-        // Fall back to function mock for now
-        return mockFunction;
-    }
-    return globalOrMocked;
-};
-/**
- * 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) => (Object.assign(Object.assign({}, acc), { [cur]: generateMockEndowment(cur) })), { wallet: getMockSnapProvider() });
-};
-exports.generateMockEndowments = generateMockEndowments;
-//# sourceMappingURL=mock.js.map

package/dist/cmds/eval/mock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mock.js","sourceRoot":"","sources":["../../../src/cmds/eval/mock.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAkC;AAClC,oDAA4B;AAC5B,iEAAgE;AAEhE,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAE/B,QAAA,QAAQ,GAAa,CAAC,GAAG,qCAAkB,EAAE,GAAG,YAAY,CAAC,CAAC;AAM3E;;;;GAIG;AACH,SAAS,mBAAmB;IAC1B,MAAM,YAAY,GAAG,IAAI,gBAAY,EAA+B,CAAC;IACrE,YAAY,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;IACxC,OAAO,YAAgC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,eAC1C,OAAA,OAAO,CAAC,OAAO,CAAA,MAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,0CAAE,WAAW,0CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC,CAAA,EAAA,CAAC;AADtD,QAAA,aAAa,iBACyC;AAEnE;;;;GAIG;AACH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAChC,MAAM,SAAS;CAAG;AAElB,MAAM,OAAO,GAAG;IACd,SAAS,CAAC,MAAW,EAAE,IAAW;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,OAAY,EAAE,KAAU;QAC1B,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE;IACvC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,8IAA8I;AAC9I,MAAM,UAAU,GAAG;IACjB,SAAS,EAAE,SAAS;IACpB,MAAM,EAAN,gBAAM;IACN,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,WAAW,GAAI,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE7C,+CAA+C;IAC/C,IAAI,WAAW,IAAI,qCAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACnD,OAAO,WAAW,CAAC;KACpB;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAK,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE/D,MAAM,IAAI,GAAG,OAAO,cAAc,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,KAAK,UAAU,CAAC;IACvC,IAAI,UAAU,IAAI,IAAA,qBAAa,EAAC,cAAc,CAAC,EAAE;QAC/C,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC;KAC1C;SAAM,IAAI,UAAU,IAAI,CAAC,cAAc,EAAE;QACxC,qCAAqC;QACrC,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,OAAO,gBAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,IAAG,EAC7D,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,CAClC,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC","sourcesContent":["import EventEmitter from 'events';\nimport crypto from 'crypto';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snap-controllers';\n\nconst NETWORK_APIS = ['fetch', 'WebSocket'];\n\nexport const ALL_APIS: string[] = [...DEFAULT_ENDOWMENTS, ...NETWORK_APIS];\n\ntype MockSnapProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap provider, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapProvider(): MockSnapProvider {\n  const mockProvider = new EventEmitter() as Partial<MockSnapProvider>;\n  mockProvider.request = async () => true;\n  return mockProvider as MockSnapProvider;\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  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 have types for them and can use that to generate mocks if needed\nconst mockWindow = {\n  WebSocket: MockClass,\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 as any)[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    { wallet: getMockSnapProvider() },\n  );\n};\n"]}

package/dist/cmds/eval/workerEval.d.ts

@@ -1,8 +0,0 @@
-/**
- * Spawn a new worker thread 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 workerEval(bundlePath: string): Promise<null>;

package/dist/cmds/eval/workerEval.js

@@ -1,37 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.workerEval = void 0;
-const child_process_1 = require("child_process");
-const path_1 = __importDefault(require("path"));
-/**
- * Spawn a new worker thread 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.
- */
-function workerEval(bundlePath) {
-    return new Promise((resolve) => {
-        (0, child_process_1.fork)(getEvalWorkerPath(), [bundlePath]).on('exit', (exitCode) => {
-            if (exitCode === 0) {
-                resolve(null);
-            }
-            else {
-                throw new Error(`Worker exited abnormally! Code: ${exitCode}`);
-            }
-        });
-    });
-}
-exports.workerEval = workerEval;
-/**
- * Get the path to the eval worker file.
- *
- * @returns The path to the eval worker file.
- */
-function getEvalWorkerPath() {
-    return path_1.default.join(__dirname, 'eval-worker.js');
-}
-//# sourceMappingURL=workerEval.js.map

package/dist/cmds/eval/workerEval.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workerEval.js","sourceRoot":"","sources":["../../../src/cmds/eval/workerEval.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAqC;AACrC,gDAA6B;AAE7B;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,UAAkB;IAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAA,oBAAI,EAAC,iBAAiB,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAgB,EAAE,EAAE;YACtE,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;aAChE;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAVD,gCAUC;AAED;;;;GAIG;AACH,SAAS,iBAAiB;IACxB,OAAO,cAAS,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { fork } from 'child_process';\nimport pathUtils from 'path';\n\n/**\n * Spawn a new worker thread 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 function workerEval(bundlePath: string): Promise<null> {\n  return new Promise((resolve) => {\n    fork(getEvalWorkerPath(), [bundlePath]).on('exit', (exitCode: number) => {\n      if (exitCode === 0) {\n        resolve(null);\n      } else {\n        throw new Error(`Worker exited abnormally! Code: ${exitCode}`);\n      }\n    });\n  });\n}\n\n/**\n * Get the path to the eval worker file.\n *\n * @returns The path to the eval worker file.\n */\nfunction getEvalWorkerPath(): string {\n  return pathUtils.join(__dirname, 'eval-worker.js');\n}\n"]}

package/dist/utils/fs.d.ts

@@ -1,24 +0,0 @@
-import type { Json } from '@metamask/snap-controllers';
-/**
- * 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(pathString: string): Promise<Json>;

package/dist/utils/fs.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readJsonFile = exports.isFile = exports.isDirectory = void 0;
-const fs_1 = require("fs");
-const misc_1 = require("./misc");
-/**
- * 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;
-            }
-            try {
-                await fs_1.promises.mkdir(pathString);
-                return true;
-            }
-            catch (mkdirError) {
-                (0, misc_1.logError)(`Directory '${pathString}' could not be created.`, mkdirError);
-                throw mkdirError;
-            }
-        }
-        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;
-//# sourceMappingURL=fs.js.map

package/dist/utils/fs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../src/utils/fs.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AAEpC,iCAAkC;AAElC;;;;;;;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,IAAI;gBACF,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,UAAU,EAAE;gBACnB,IAAA,eAAQ,EAAC,cAAc,UAAU,yBAAyB,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,UAAU,CAAC;aAClB;SACF;QACD,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAvBD,kCAuBC;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,CAAC,UAAkB;IACnD,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;AAND,oCAMC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json } from '@metamask/snap-controllers';\nimport { logError } from './misc';\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      try {\n        await fs.mkdir(pathString);\n        return true;\n      } catch (mkdirError) {\n        logError(`Directory '${pathString}' could not be created.`, mkdirError);\n        throw mkdirError;\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(pathString: string): Promise<Json> {\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"]}

package/dist/utils/validate-fs.d.ts

@@ -1,35 +0,0 @@
-/**
- * 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>;

package/dist/utils/validate-fs.js

@@ -1,69 +0,0 @@
-"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 = void 0;
-const path_1 = __importDefault(require("path"));
-const fs_1 = require("./fs");
-/**
- * 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' ||
-        filename.indexOf('/') !== -1) {
-        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 (0, fs_1.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 (0, fs_1.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=validate-fs.js.map

package/dist/utils/validate-fs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate-fs.js","sourceRoot":"","sources":["../../src/utils/validate-fs.ts"],"names":[],"mappings":";;;;;;AAAA,gDAA6B;AAC7B,6BAA2C;AAE3C;;;;;;;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,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAC5B;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,IAAA,WAAM,EAAC,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,IAAA,gBAAW,EAAC,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 pathUtils from 'path';\nimport { isFile, isDirectory } from './fs';\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    filename.indexOf('/') !== -1\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"]}