@eik/common 4.1.1 → 5.0.0

package/lib/classes/read-file.js

@@ -1,34 +1,34 @@
-import { isReadableStream } from '../stream.js';
+import { isReadableStream } from "../stream.js";
 
 const ReadFile = class ReadFile {
-    constructor({ mimeType = '', etag = '' } = {}) {
-        this._mimeType = mimeType;
-        // @ts-ignore
-        this._stream = undefined;
-        this._etag = etag;
-    }
+	constructor({ mimeType = "", etag = "" } = {}) {
+		this._mimeType = mimeType;
+		// @ts-ignore
+		this._stream = undefined;
+		this._etag = etag;
+	}
 
-    get mimeType() {
-        return this._mimeType;
-    }
+	get mimeType() {
+		return this._mimeType;
+	}
 
-    set stream(value) {
-        if (!isReadableStream(value))
-            throw new Error('Value is not a Readable stream');
-        this._stream = value;
-    }
+	set stream(value) {
+		if (!isReadableStream(value))
+			throw new Error("Value is not a Readable stream");
+		this._stream = value;
+	}
 
-    // @ts-ignore
-    get stream() {
-        return this._stream;
-    }
+	// @ts-ignore
+	get stream() {
+		return this._stream;
+	}
 
-    get etag() {
-        return this._etag;
-    }
+	get etag() {
+		return this._etag;
+	}
 
-    get [Symbol.toStringTag]() {
-        return 'ReadFile';
-    }
+	get [Symbol.toStringTag]() {
+		return "ReadFile";
+	}
 };
 export default ReadFile;

package/lib/classes/remote-file-location.js

@@ -1,41 +1,41 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-import assert from 'node:assert';
-import { join } from 'node:path';
+import assert from "node:assert";
+import { join } from "node:path";
 
 class RemoteFileLocation {
-    /**
-     * @param {string} filePathname pathname for file relative to package root eg. /folder/client.js
-     * @param {string} packagePathname pathname for package root eg. /pkg/my-pack/1.0.0
-     * @param {string} origin server origin eg. https://server.com
-     */
-    constructor(filePathname, packagePathname, origin) {
-        assert(
-            typeof filePathname === 'string',
-            '"filePathname" must be of type "string"',
-        );
-        assert(
-            typeof packagePathname === 'string',
-            '"packagePathname" must be of type "string"',
-        );
-        assert(typeof origin === 'string', '"origin" must be of type "string"');
+	/**
+	 * @param {string} filePathname pathname for file relative to package root eg. /folder/client.js
+	 * @param {string} packagePathname pathname for package root eg. /pkg/my-pack/1.0.0
+	 * @param {string} origin server origin eg. https://server.com
+	 */
+	constructor(filePathname, packagePathname, origin) {
+		assert(
+			typeof filePathname === "string",
+			'"filePathname" must be of type "string"',
+		);
+		assert(
+			typeof packagePathname === "string",
+			'"packagePathname" must be of type "string"',
+		);
+		assert(typeof origin === "string", '"origin" must be of type "string"');
 
-        /**
-         * @type {string} pathname to package root
-         */
-        this.packagePathname = new URL(packagePathname, origin).pathname;
+		/**
+		 * @type {string} pathname to package root
+		 */
+		this.packagePathname = new URL(packagePathname, origin).pathname;
 
-        /**
-         * @type {string} pathname to file relative to package root
-         */
-        this.filePathname = new URL(filePathname, origin).pathname;
+		/**
+		 * @type {string} pathname to file relative to package root
+		 */
+		this.filePathname = new URL(filePathname, origin).pathname;
 
-        /**
-         * @type {URL} WHATWG URL object containing the full remote URL for the file
-         */
-        this.url = new URL(join(packagePathname, filePathname), origin);
-    }
+		/**
+		 * @type {URL} WHATWG URL object containing the full remote URL for the file
+		 */
+		this.url = new URL(join(packagePathname, filePathname), origin);
+	}
 }
 
 export default RemoteFileLocation;

package/lib/classes/resolved-files.js

@@ -1,58 +1,50 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-import assert from 'node:assert';
-import LocalFileLocation from './local-file-location.js';
+import assert from "node:assert";
+import LocalFileLocation from "./local-file-location.js";
 import {
-    removeLeadingSlash,
-    removeTrailingSlash,
-} from '../helpers/path-slashes.js';
+	removeLeadingSlash,
+	removeTrailingSlash,
+} from "../helpers/path-slashes.js";
 
-const originalFiles = Symbol('files');
+const originalFiles = Symbol("files");
 
 class ResolvedFiles {
-    /**
-     * @param {string[]} files
-     * @param {{definition: [string, string], basePath: string, pattern: string}} meta
-     */
-    constructor(files, meta) {
-        assert(Array.isArray(files), '"files" must be an array');
-        assert(meta, '"meta" must be defined');
-        assert(
-            typeof meta.basePath,
-            '"meta.basePath" must be a non empty string',
-        );
-        assert(
-            typeof meta.pattern,
-            '"meta.pattern" must be a non empty string',
-        );
-        assert(
-            Array.isArray(meta.definition),
-            '"meta.definition" must be an array',
-        );
-        assert(
-            meta.definition.length === 2,
-            '"meta.definition" must be an array of length 2',
-        );
+	/**
+	 * @param {string[]} files
+	 * @param {{definition: [string, string], basePath: string, pattern: string}} meta
+	 */
+	constructor(files, meta) {
+		assert(Array.isArray(files), '"files" must be an array');
+		assert(meta, '"meta" must be defined');
+		assert(typeof meta.basePath, '"meta.basePath" must be a non empty string');
+		assert(typeof meta.pattern, '"meta.pattern" must be a non empty string');
+		assert(
+			Array.isArray(meta.definition),
+			'"meta.definition" must be an array',
+		);
+		assert(
+			meta.definition.length === 2,
+			'"meta.definition" must be an array of length 2',
+		);
 
-        const [destination, source] = meta.definition;
-        this[originalFiles] = files;
-        this.destination = destination;
-        this.source = source;
-        this.basePath = meta.basePath;
-        this.pattern = meta.pattern;
-    }
+		const [destination, source] = meta.definition;
+		this[originalFiles] = files;
+		this.destination = destination;
+		this.source = source;
+		this.basePath = meta.basePath;
+		this.pattern = meta.pattern;
+	}
 
-    *[Symbol.iterator]() {
-        for (const file of this[originalFiles]) {
-            const relative = removeTrailingSlash(
-                removeLeadingSlash(
-                    file.replace(/\\/g, '/').replace(this.basePath, ''),
-                ),
-            );
-            yield new LocalFileLocation(relative, this.basePath);
-        }
-    }
+	*[Symbol.iterator]() {
+		for (const file of this[originalFiles]) {
+			const relative = removeTrailingSlash(
+				removeLeadingSlash(file.replace(/\\/g, "/").replace(this.basePath, "")),
+			);
+			yield new LocalFileLocation(relative, this.basePath);
+		}
+	}
 }
 
 export default ResolvedFiles;

package/lib/classes/single-dest-multiple-source-error.js

@@ -1,12 +1,12 @@
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";
 
 export default class SingleDestMultipleSourcesError extends CustomError {
-    /**
-     * @param {string} destFilePath
-     */
-    constructor(destFilePath) {
-        super(
-            `Cannot specify a single file destination for multiple source files. See '${destFilePath}'`,
-        );
-    }
+	/**
+	 * @param {string} destFilePath
+	 */
+	constructor(destFilePath) {
+		super(
+			`Cannot specify a single file destination for multiple source files. See '${destFilePath}'`,
+		);
+	}
 }

package/lib/helpers/config-store.js

@@ -1,10 +1,10 @@
-import { readFileSync, writeFileSync } from 'node:fs';
-import { join, dirname } from 'node:path';
-import os from 'node:os';
-import EikConfig from '../classes/eik-config.js';
-import MissingConfigError from '../classes/missing-config-error.js';
-import MultipleConfigSourcesError from '../classes/multiple-config-sources-error.js';
-import InvalidConfigError from '../classes/invalid-config-error.js';
+import { readFileSync, writeFileSync } from "node:fs";
+import { join, dirname } from "node:path";
+import os from "node:os";
+import EikConfig from "../classes/eik-config.js";
+import MissingConfigError from "../classes/missing-config-error.js";
+import MultipleConfigSourcesError from "../classes/multiple-config-sources-error.js";
+import InvalidConfigError from "../classes/invalid-config-error.js";
 
 const homedir = os.homedir();
 
@@ -16,104 +16,104 @@ const homedir = os.homedir();
  * @returns {object}
  */
 function readJSONFromDisk(path) {
-    let fileData;
-    try {
-        fileData = readFileSync(path, { encoding: 'utf8' });
-        // eslint-disable-next-line no-unused-vars
-    } catch (e) {
-        // @ts-ignore
-        return null;
-    }
-    return JSON.parse(fileData);
+	let fileData;
+	try {
+		fileData = readFileSync(path, { encoding: "utf8" });
+		// eslint-disable-next-line no-unused-vars
+	} catch (e) {
+		// @ts-ignore
+		return null;
+	}
+	return JSON.parse(fileData);
 }
 
 export default {
-    /**
-     * Load the configuration from an exact path and return an EikConfig object
-     *
-     * @param {string} configFilePathname
-     * @param {function} loadJSONFromDisk
-     *
-     * @returns {EikConfig}
-     */
-    loadFromPath(configFilePathname, loadJSONFromDisk = readJSONFromDisk) {
-        const eikJSON = loadJSONFromDisk(configFilePathname);
-        if (!eikJSON) {
-            throw new MissingConfigError(dirname(configFilePathname));
-        }
-        let assets = eikJSON;
-        // detect package.json
-        if (eikJSON.eik) {
-            assets = {
-                name: eikJSON.name,
-                version: eikJSON.version,
-                ...eikJSON.eik,
-            };
-        }
-        const eikrc = loadJSONFromDisk(join(homedir, '.eikrc')) || {};
-        return new EikConfig(assets, eikrc.tokens, dirname(configFilePathname));
-    },
-    /**
-     * Tries to find the configuration for eik in the provided directory.
-     *
-     * @param {string} configRootDir The base directory for the eik project.
-     * @param {function} [loadJSONFromDisk] The function to use to load the file from disk.
-     *
-     * @returns {EikConfig}
-     */
-    findInDirectory(configRootDir, loadJSONFromDisk = readJSONFromDisk) {
-        const pkgJSON = loadJSONFromDisk(join(configRootDir, 'package.json'));
-        const eikJSON = loadJSONFromDisk(join(configRootDir, 'eik.json'));
-        if (
-            pkgJSON != null &&
-            Object.prototype.hasOwnProperty.call(pkgJSON, 'eik') &&
-            eikJSON != null
-        ) {
-            throw new MultipleConfigSourcesError();
-        }
-        let assets;
-        if (pkgJSON) {
-            const { name, version, eik } = pkgJSON;
-            if (eik) {
-                assets = { name, version, ...pkgJSON.eik };
-            }
-        }
-        if (eikJSON) {
-            assets = { ...assets, ...eikJSON };
-        }
-        if (assets == null) {
-            throw new MissingConfigError(configRootDir);
-        }
-        const eikrc = loadJSONFromDisk(join(homedir, '.eikrc')) || {};
-        const config = new EikConfig(assets, eikrc.tokens, configRootDir);
-        try {
-            config.validate();
-        } catch (err) {
-            throw new InvalidConfigError(
-                // @ts-ignore
-                `config.findInDirectory operation failed: ${err.message}`,
-            );
-        }
-        return config;
-    },
+	/**
+	 * Load the configuration from an exact path and return an EikConfig object
+	 *
+	 * @param {string} configFilePathname
+	 * @param {function} loadJSONFromDisk
+	 *
+	 * @returns {EikConfig}
+	 */
+	loadFromPath(configFilePathname, loadJSONFromDisk = readJSONFromDisk) {
+		const eikJSON = loadJSONFromDisk(configFilePathname);
+		if (!eikJSON) {
+			throw new MissingConfigError(dirname(configFilePathname));
+		}
+		let assets = eikJSON;
+		// detect package.json
+		if (eikJSON.eik) {
+			assets = {
+				name: eikJSON.name,
+				version: eikJSON.version,
+				...eikJSON.eik,
+			};
+		}
+		const eikrc = loadJSONFromDisk(join(homedir, ".eikrc")) || {};
+		return new EikConfig(assets, eikrc.tokens, dirname(configFilePathname));
+	},
+	/**
+	 * Tries to find the configuration for eik in the provided directory.
+	 *
+	 * @param {string} configRootDir The base directory for the eik project.
+	 * @param {function} [loadJSONFromDisk] The function to use to load the file from disk.
+	 *
+	 * @returns {EikConfig}
+	 */
+	findInDirectory(configRootDir, loadJSONFromDisk = readJSONFromDisk) {
+		const pkgJSON = loadJSONFromDisk(join(configRootDir, "package.json"));
+		const eikJSON = loadJSONFromDisk(join(configRootDir, "eik.json"));
+		if (
+			pkgJSON != null &&
+			Object.prototype.hasOwnProperty.call(pkgJSON, "eik") &&
+			eikJSON != null
+		) {
+			throw new MultipleConfigSourcesError();
+		}
+		let assets;
+		if (pkgJSON) {
+			const { name, version, eik } = pkgJSON;
+			if (eik) {
+				assets = { name, version, ...pkgJSON.eik };
+			}
+		}
+		if (eikJSON) {
+			assets = { ...assets, ...eikJSON };
+		}
+		if (assets == null) {
+			throw new MissingConfigError(configRootDir);
+		}
+		const eikrc = loadJSONFromDisk(join(homedir, ".eikrc")) || {};
+		const config = new EikConfig(assets, eikrc.tokens, configRootDir);
+		try {
+			config.validate();
+		} catch (err) {
+			throw new InvalidConfigError(
+				// @ts-ignore
+				`config.findInDirectory operation failed: ${err.message}`,
+			);
+		}
+		return config;
+	},
 
-    /**
-     * Persist config changes to disk as <cwd>/eik.json
-     *
-     * @param {import('../classes/eik-config.js')} config
-     */
-    persistToDisk(config) {
-        try {
-            // @ts-ignore
-            config.validate();
-        } catch (err) {
-            throw new InvalidConfigError(
-                // @ts-ignore
-                `config.persistToDisk operation failed: ${err.message}`,
-            );
-        }
-        // @ts-ignore
-        const dest = join(config.cwd, 'eik.json');
-        writeFileSync(dest, JSON.stringify(config, null, 2));
-    },
+	/**
+	 * Persist config changes to disk as <cwd>/eik.json
+	 *
+	 * @param {import('../classes/eik-config.js')} config
+	 */
+	persistToDisk(config) {
+		try {
+			// @ts-ignore
+			config.validate();
+		} catch (err) {
+			throw new InvalidConfigError(
+				// @ts-ignore
+				`config.persistToDisk operation failed: ${err.message}`,
+			);
+		}
+		// @ts-ignore
+		const dest = join(config.cwd, "eik.json");
+		writeFileSync(dest, JSON.stringify(config, null, 2));
+	},
 };

package/lib/helpers/get-defaults.js

@@ -1,7 +1,7 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import configStore from './config-store.js';
-import EikConfig from '../classes/eik-config.js';
+import fs from "node:fs";
+import path from "node:path";
+import configStore from "./config-store.js";
+import EikConfig from "../classes/eik-config.js";
 /**
  * Sets up and returns an object containing a set of default values for the app context.
  * Default values are fetched from the app's eik.json or package.json file as well as from .eikrc, if present in the users home directory.
@@ -11,24 +11,24 @@ import EikConfig from '../classes/eik-config.js';
  * @returns {import("../classes/eik-config.js").default} EikConfig
  */
 export default function getDefaults(directoryOrFilepath) {
-    try {
-        const stats = fs.statSync(directoryOrFilepath);
-        if (stats.isDirectory()) {
-            return configStore.findInDirectory(directoryOrFilepath);
-        } else {
-            return configStore.loadFromPath(directoryOrFilepath);
-        }
-    } catch (error) {
-        const e = /** @type {Error} */ (error);
-        if (e.constructor.name === 'MissingConfigError') {
-            // assume directory
-            let cwd = directoryOrFilepath;
-            // detect exact file and get its directory
-            if (path.extname(directoryOrFilepath)) {
-                cwd = path.dirname(directoryOrFilepath);
-            }
-            return new EikConfig(null, [], cwd);
-        }
-        throw e;
-    }
+	try {
+		const stats = fs.statSync(directoryOrFilepath);
+		if (stats.isDirectory()) {
+			return configStore.findInDirectory(directoryOrFilepath);
+		} else {
+			return configStore.loadFromPath(directoryOrFilepath);
+		}
+	} catch (error) {
+		const e = /** @type {Error} */ (error);
+		if (e.constructor.name === "MissingConfigError") {
+			// assume directory
+			let cwd = directoryOrFilepath;
+			// detect exact file and get its directory
+			if (path.extname(directoryOrFilepath)) {
+				cwd = path.dirname(directoryOrFilepath);
+			}
+			return new EikConfig(null, [], cwd);
+		}
+		throw e;
+	}
 }

package/lib/helpers/index.js

@@ -1,25 +1,25 @@
-import localAssets from './local-assets.js';
-import getDefaults from './get-defaults.js';
-import configStore from './config-store.js';
-import typeSlug from './type-slug.js';
-import typeTitle from './type-title.js';
-import resolveFiles from './resolve-files.js';
+import localAssets from "./local-assets.js";
+import getDefaults from "./get-defaults.js";
+import configStore from "./config-store.js";
+import typeSlug from "./type-slug.js";
+import typeTitle from "./type-title.js";
+import resolveFiles from "./resolve-files.js";
 import {
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-} from './path-slashes.js';
+	addTrailingSlash,
+	removeTrailingSlash,
+	addLeadingSlash,
+	removeLeadingSlash,
+} from "./path-slashes.js";
 
 export default {
-    localAssets,
-    getDefaults,
-    configStore,
-    typeSlug,
-    typeTitle,
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-    resolveFiles,
+	localAssets,
+	getDefaults,
+	configStore,
+	typeSlug,
+	typeTitle,
+	addTrailingSlash,
+	removeTrailingSlash,
+	addLeadingSlash,
+	removeLeadingSlash,
+	resolveFiles,
 };