@eik/common 4.1.0 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [5.0.0](https://github.com/eik-lib/common/compare/v4.1.1...v5.0.0) (2024-11-13)
+
+
+### Bug Fixes
+
+* update validate-npm-package-name ([0dac235](https://github.com/eik-lib/common/commit/0dac23582de09bb739a730a8ca9bee7370146bcc))
+
+
+### BREAKING CHANGES
+
+* Requires Node >=20.5.0
+
+## [4.1.1](https://github.com/eik-lib/common/compare/v4.1.0...v4.1.1) (2024-08-16)
+
+
+### Bug Fixes
+
+* windows support ([#303](https://github.com/eik-lib/common/issues/303)) ([4e6a307](https://github.com/eik-lib/common/commit/4e6a3078861a0a03b7275bfb5b2875adda1f2c2e))
+
 # [4.1.0](https://github.com/eik-lib/common/compare/v4.0.9...v4.1.0) (2024-08-14)
 
 

package/lib/classes/custom-error.js

@@ -1,10 +1,10 @@
 export default class CustomError extends Error {
-    /**
-     * @param {string} message
-     */
-    constructor(message) {
-        super(message);
-        this.name = this.constructor.name;
-        Error.captureStackTrace(this, this.constructor);
-    }
+	/**
+	 * @param {string} message
+	 */
+	constructor(message) {
+		super(message);
+		this.name = this.constructor.name;
+		Error.captureStackTrace(this, this.constructor);
+	}
 }

package/lib/classes/eik-config.js

@@ -1,19 +1,19 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-import assert from 'node:assert';
-import { extname, join, isAbsolute } from 'node:path';
-import NoFilesMatchedError from './no-files-matched-error.js';
-import SingleDestMultipleSourcesError from './single-dest-multiple-source-error.js';
-import FileMapping from './file-mapping.js';
-import RemoteFileLocation from './remote-file-location.js';
-import schemas from '../schemas/index.js';
-import { removeTrailingSlash } from '../helpers/path-slashes.js';
-import typeSlug from '../helpers/type-slug.js';
-import resolveFiles from '../helpers/resolve-files.js';
-
-const _config = Symbol('config');
-const _tokens = Symbol('tokens');
+import assert from "node:assert";
+import { extname, join, isAbsolute } from "node:path";
+import NoFilesMatchedError from "./no-files-matched-error.js";
+import SingleDestMultipleSourcesError from "./single-dest-multiple-source-error.js";
+import FileMapping from "./file-mapping.js";
+import RemoteFileLocation from "./remote-file-location.js";
+import schemas from "../schemas/index.js";
+import { removeTrailingSlash, ensurePosix } from "../helpers/path-slashes.js";
+import typeSlug from "../helpers/type-slug.js";
+import resolveFiles from "../helpers/resolve-files.js";
+
+const _config = Symbol("config");
+const _tokens = Symbol("tokens");
 
 /**
  * Normalizes Eik JSON "files" definition to object form if in string form
@@ -23,149 +23,145 @@ const _tokens = Symbol('tokens');
  * @returns {{[k: string]: string;}}
  */
 const normalizeFilesDefinition = (files) =>
-    typeof files === 'string' ? { '/': files } : files;
+	typeof files === "string" ? { "/": files } : files;
 
 /**
  * @typedef {import ("../../eikjson.js").EikjsonSchema} EikjsonSchema
  */
 
 export default class EikConfig {
-    /**
-     * @param {EikjsonSchema?} configHash
-     * @param {[string, string][]?} tokens
-     * @param {string?} configRootDir
-     */
-    constructor(configHash, tokens = null, configRootDir = process.cwd()) {
-        /** @type EikjsonSchema */
-        this[_config] = JSON.parse(JSON.stringify(configHash)) || {};
-        this[_tokens] = new Map(tokens);
-
-        assert(
-            // @ts-ignore
-            isAbsolute(configRootDir),
-            `"configRootDir" must be an absolute path: "${configRootDir}" given`,
-        );
-        // @ts-ignore
-        this.cwd = removeTrailingSlash(configRootDir);
-        /** @type {string[]} */
-        // @ts-ignore
-        this.map = [].concat(this[_config]['import-map'] || []);
-    }
-
-    /** @type {EikjsonSchema["name"]} */
-    get name() {
-        return this[_config].name;
-    }
-
-    /** @type {EikjsonSchema["version"]} */
-    get version() {
-        return this[_config].version;
-    }
-
-    set version(newVersion) {
-        schemas.assert.version(newVersion);
-        this[_config].version = newVersion;
-    }
-
-    /** @type {EikjsonSchema["type"]} */
-    get type() {
-        // @ts-ignore
-        return this[_config].type || schemas.schema.properties.type.default;
-    }
-
-    /** @type {string} */
-    get server() {
-        const configuredServer = this[_config].server;
-        if (configuredServer) {
-            return configuredServer;
-        }
-        return this[_tokens].keys().next().value;
-    }
-
-    /** @type {[string, string][]} */
-    get token() {
-        // @ts-ignore
-        return this[_tokens].get(this.server);
-    }
-
-    /** @type {EikjsonSchema["files"]} */
-    get files() {
-        return this[_config].files;
-    }
-
-    /**
-     * Normalized relative directory path with any leading ./ or
-     * trailing / characters stripped. Defaults to .eik
-     *
-     * @returns {string} out path string
-     */
-    get out() {
-        const defaulted = this[_config].out || '.eik';
-        const out = defaulted.startsWith('./')
-            ? defaulted.substr(2)
-            : defaulted;
-        return removeTrailingSlash(out);
-    }
-
-    /**
-     * Serializes internal values to an object
-     *
-     * @returns {EikjsonSchema} object consistent with EikjsonSchema
-     */
-    toJSON() {
-        return { ...this[_config] };
-    }
-
-    /**
-     * Validates config values against the eik JSON schema
-     *
-     * @return {void}
-     */
-    validate() {
-        schemas.assert.eikJSON(this[_config]);
-    }
-
-    /**
-     * Resolves file locations on disk based on values defined in files property
-     * of config object.
-     *
-     * @returns {Promise<FileMapping[]>}
-     */
-    async mappings() {
-        const normalizedFiles = normalizeFilesDefinition(this.files);
-        const resolvedFiles = await resolveFiles(normalizedFiles, this.cwd);
-
-        return resolvedFiles.flatMap((files) => {
-            // @ts-ignore
-            const { destination, source } = files;
-            // @ts-ignore
-            const filesArray = Array.from(files);
-            if (filesArray.length === 0) {
-                throw new NoFilesMatchedError(source);
-            }
-
-            if (extname(destination) !== '' && filesArray.length > 1) {
-                throw new SingleDestMultipleSourcesError(destination);
-            }
-
-            return filesArray.map((localFile) => {
-                const shouldMapFilename = extname(destination);
-                const relativePathname = shouldMapFilename
-                    ? destination
-                    : join(destination, localFile.relative);
-                const packagePathname = join(
-                    // @ts-ignore
-                    typeSlug(this.type),
-                    this.name,
-                    this.version,
-                );
-                const remoteDestination = new RemoteFileLocation(
-                    relativePathname,
-                    packagePathname,
-                    this.server,
-                );
-                return new FileMapping(localFile, remoteDestination);
-            });
-        });
-    }
+	/**
+	 * @param {EikjsonSchema?} configHash
+	 * @param {[string, string][]?} tokens
+	 * @param {string?} configRootDir
+	 */
+	constructor(configHash, tokens = null, configRootDir = process.cwd()) {
+		/** @type EikjsonSchema */
+		this[_config] = JSON.parse(JSON.stringify(configHash)) || {};
+		this[_tokens] = new Map(tokens);
+
+		assert(
+			// @ts-ignore
+			isAbsolute(configRootDir),
+			`"configRootDir" must be an absolute path: "${configRootDir}" given`,
+		);
+		// @ts-ignore
+		this.cwd = removeTrailingSlash(configRootDir);
+		/** @type {string[]} */
+		// @ts-ignore
+		this.map = [].concat(this[_config]["import-map"] || []);
+	}
+
+	/** @type {EikjsonSchema["name"]} */
+	get name() {
+		return this[_config].name;
+	}
+
+	/** @type {EikjsonSchema["version"]} */
+	get version() {
+		return this[_config].version;
+	}
+
+	set version(newVersion) {
+		schemas.assert.version(newVersion);
+		this[_config].version = newVersion;
+	}
+
+	/** @type {EikjsonSchema["type"]} */
+	get type() {
+		// @ts-ignore
+		return this[_config].type || schemas.schema.properties.type.default;
+	}
+
+	/** @type {string} */
+	get server() {
+		const configuredServer = this[_config].server;
+		if (configuredServer) {
+			return configuredServer;
+		}
+		return this[_tokens].keys().next().value;
+	}
+
+	/** @type {[string, string][]} */
+	get token() {
+		// @ts-ignore
+		return this[_tokens].get(this.server);
+	}
+
+	/** @type {EikjsonSchema["files"]} */
+	get files() {
+		return this[_config].files;
+	}
+
+	/**
+	 * Normalized relative directory path with any leading ./ or
+	 * trailing / characters stripped. Defaults to .eik
+	 *
+	 * @returns {string} out path string
+	 */
+	get out() {
+		const defaulted = this[_config].out || ".eik";
+		const out = defaulted.startsWith("./") ? defaulted.substr(2) : defaulted;
+		return removeTrailingSlash(out);
+	}
+
+	/**
+	 * Serializes internal values to an object
+	 *
+	 * @returns {EikjsonSchema} object consistent with EikjsonSchema
+	 */
+	toJSON() {
+		return { ...this[_config] };
+	}
+
+	/**
+	 * Validates config values against the eik JSON schema
+	 *
+	 * @return {void}
+	 */
+	validate() {
+		schemas.assert.eikJSON(this[_config]);
+	}
+
+	/**
+	 * Resolves file locations on disk based on values defined in files property
+	 * of config object.
+	 *
+	 * @returns {Promise<FileMapping[]>}
+	 */
+	async mappings() {
+		const normalizedFiles = normalizeFilesDefinition(this.files);
+		const resolvedFiles = await resolveFiles(normalizedFiles, this.cwd);
+
+		return resolvedFiles.flatMap((files) => {
+			// @ts-ignore
+			const { destination, source } = files;
+			// @ts-ignore
+			const filesArray = Array.from(files);
+			if (filesArray.length === 0) {
+				throw new NoFilesMatchedError(source);
+			}
+
+			if (extname(destination) !== "" && filesArray.length > 1) {
+				throw new SingleDestMultipleSourcesError(destination);
+			}
+
+			return filesArray.map((localFile) => {
+				const shouldMapFilename = extname(destination);
+				const relativePathname = shouldMapFilename
+					? destination
+					: ensurePosix(join(destination, localFile.relative));
+				const packagePathname = ensurePosix(
+					join(typeSlug(this.type), this.name, this.version),
+				);
+
+				const remoteDestination = new RemoteFileLocation(
+					relativePathname,
+					packagePathname,
+					this.server,
+				);
+				return new FileMapping(localFile, remoteDestination);
+			});
+		});
+	}
 }

package/lib/classes/file-mapping.js

@@ -1,38 +1,38 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-import assert from 'node:assert';
-import LocalFileLocation from './local-file-location.js';
-import RemoteFileLocation from './remote-file-location.js';
+import assert from "node:assert";
+import LocalFileLocation from "./local-file-location.js";
+import RemoteFileLocation from "./remote-file-location.js";
 
 /**
  * Class containing a local file system source location and remote server destination location for a file.
  */
 class FileMapping {
-    /**
-     * @param {LocalFileLocation} source
-     * @param {RemoteFileLocation} destination
-     */
-    constructor(source, destination) {
-        assert(
-            source instanceof LocalFileLocation,
-            '"source" must be an instance of LocalFileLocation',
-        );
-        assert(
-            destination instanceof RemoteFileLocation,
-            '"destination" must be an instance of RemoteFileLocation',
-        );
+	/**
+	 * @param {LocalFileLocation} source
+	 * @param {RemoteFileLocation} destination
+	 */
+	constructor(source, destination) {
+		assert(
+			source instanceof LocalFileLocation,
+			'"source" must be an instance of LocalFileLocation',
+		);
+		assert(
+			destination instanceof RemoteFileLocation,
+			'"destination" must be an instance of RemoteFileLocation',
+		);
 
-        /**
-         * @type {LocalFileLocation} source
-         */
-        this.source = source;
+		/**
+		 * @type {LocalFileLocation} source
+		 */
+		this.source = source;
 
-        /**
-         * @type {RemoteFileLocation} destination
-         */
-        this.destination = destination;
-    }
+		/**
+		 * @type {RemoteFileLocation} destination
+		 */
+		this.destination = destination;
+	}
 }
 
 export default FileMapping;

package/lib/classes/invalid-config-error.js

@@ -1,10 +1,10 @@
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";
 
 export default class InvalidConfigError extends CustomError {
-    /**
-     * @param {string} msg
-     */
-    constructor(msg) {
-        super(`Eik config object was invalid: '${msg}'`);
-    }
+	/**
+	 * @param {string} msg
+	 */
+	constructor(msg) {
+		super(`Eik config object was invalid: '${msg}'`);
+	}
 }

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

@@ -1,60 +1,57 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-import assert from 'node:assert';
-import { join, extname, isAbsolute } from 'node:path';
+import assert from "node:assert";
+import { join, extname, isAbsolute } from "node:path";
 // @ts-ignore
-import mime from 'mime-types';
+import mime from "mime-types";
+import { ensurePosix } from "../helpers/path-slashes.js";
 
 /**
  * Class containing information about a local file
  */
 class LocalFileLocation {
-    /**
-     * @param {string} path path to file on disk relative to basePath
-     * @param {string} basePath basePath to the file's location on disk
-     */
-    constructor(path, basePath) {
-        assert(typeof path === 'string', '"path" must be of type "string"');
-        assert(
-            typeof basePath === 'string',
-            '"basePath" must be of type "string"',
-        );
-        assert(!isAbsolute(path), '"path" must be a relative path');
-
-        /**
-         * @type {string} path to file on disk relative to this.basePath
-         */
-        this.relative = path;
-
-        /**
-         * @type {string} absolute path to root files location on disk
-         */
-        this.basePath = basePath;
-
-        /**
-         * @type {string} absolute path to file on disk,
-         * this is a concatentation of this.basePath and this.relative
-         */
-        this.absolute = join(basePath, path);
-
-        /**
-         * @type {string} file extension with "." character included. (eg. ".json")
-         */
-        this.extension = extname(path);
-
-        /**
-         * @type {string} full content-type header value for file
-         */
-        this.contentType =
-            mime.contentType(this.extension) || 'application/octet-stream';
-
-        /**
-         * @type {string} mime type of file
-         */
-        this.mimeType =
-            mime.lookup(this.extension) || 'application/octet-stream';
-    }
+	/**
+	 * @param {string} path path to file on disk relative to basePath
+	 * @param {string} basePath basePath to the file's location on disk
+	 */
+	constructor(path, basePath) {
+		assert(typeof path === "string", '"path" must be of type "string"');
+		assert(typeof basePath === "string", '"basePath" must be of type "string"');
+		assert(!isAbsolute(path), `"path" must be a relative path, got ${path}`);
+
+		/**
+		 * @type {string} path to file on disk relative to this.basePath
+		 */
+		this.relative = path;
+
+		/**
+		 * @type {string} absolute path to root files location on disk
+		 */
+		this.basePath = basePath;
+
+		/**
+		 * @type {string} absolute path to file on disk,
+		 * this is a concatentation of this.basePath and this.relative
+		 */
+		this.absolute = ensurePosix(join(basePath, path));
+
+		/**
+		 * @type {string} file extension with "." character included. (eg. ".json")
+		 */
+		this.extension = extname(path);
+
+		/**
+		 * @type {string} full content-type header value for file
+		 */
+		this.contentType =
+			mime.contentType(this.extension) || "application/octet-stream";
+
+		/**
+		 * @type {string} mime type of file
+		 */
+		this.mimeType = mime.lookup(this.extension) || "application/octet-stream";
+	}
 }
 
 export default LocalFileLocation;

package/lib/classes/missing-config-error.js

@@ -1,10 +1,10 @@
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";
 
 export default class MissingConfigError extends CustomError {
-    /**
-     * @param {string} dir
-     */
-    constructor(dir) {
-        super(`No package.json or eik.json file found in: '${dir}'`);
-    }
+	/**
+	 * @param {string} dir
+	 */
+	constructor(dir) {
+		super(`No package.json or eik.json file found in: '${dir}'`);
+	}
 }

package/lib/classes/multiple-config-sources-error.js

@@ -1,9 +1,9 @@
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";
 
 export default class MultipleConfigSourcesError extends CustomError {
-    constructor() {
-        super(
-            `Eik configuration was defined in both in package.json and eik.json. You must specify one or the other.`,
-        );
-    }
+	constructor() {
+		super(
+			`Eik configuration was defined in both in package.json and eik.json. You must specify one or the other.`,
+		);
+	}
 }

package/lib/classes/no-files-matched-error.js

@@ -1,11 +1,11 @@
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";
 
 export default class NoFilesMatchedError extends CustomError {
-    /**
-     * @param {string} file
-     */
-    constructor(file) {
-        const message = `No files found for path: '${file}'`;
-        super(message);
-    }
+	/**
+	 * @param {string} file
+	 */
+	constructor(file) {
+		const message = `No files found for path: '${file}'`;
+		super(message);
+	}
 }