@eik/common 4.1.1 → 5.0.0

package/lib/schemas/validate.js

@@ -1,16 +1,16 @@
-import { readFileSync } from 'node:fs';
-import { join, dirname } from 'node:path';
-import formats from 'ajv-formats';
-import semver from 'semver';
-import npmPkg from 'validate-npm-package-name';
-import Ajv from 'ajv';
-import { fileURLToPath } from 'node:url';
+import { readFileSync } from "node:fs";
+import { join, dirname } from "node:path";
+import formats from "ajv-formats";
+import semver from "semver";
+import npmPkg from "validate-npm-package-name";
+import Ajv from "ajv";
+import { fileURLToPath } from "node:url";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 const eikJSONSchema = JSON.parse(
-    readFileSync(join(__dirname, './eikjson.schema.json'), 'utf8'),
+	readFileSync(join(__dirname, "./eikjson.schema.json"), "utf8"),
 );
 
 /**
@@ -32,17 +32,17 @@ const eikJSONSchema = JSON.parse(
  * @returns {SchemaValidator<T>}
  */
 const createValidator = (schema, ajvOptions) => {
-    // @ts-ignore
-    const ajv = new Ajv(ajvOptions);
-    // @ts-ignore
-    formats(ajv); // Needed to support "uri"
-    const validate = ajv.compile(schema);
-
-    return (data) => {
-        const cloned = JSON.parse(JSON.stringify(data));
-        const valid = validate(cloned);
-        return { value: cloned, error: !valid && validate.errors };
-    };
+	// @ts-ignore
+	const ajv = new Ajv(ajvOptions);
+	// @ts-ignore
+	formats(ajv); // Needed to support "uri"
+	const validate = ajv.compile(schema);
+
+	return (data) => {
+		const cloned = JSON.parse(JSON.stringify(data));
+		const valid = validate(cloned);
+		return { value: cloned, error: !valid && validate.errors };
+	};
 };
 
 /**
@@ -50,8 +50,8 @@ const createValidator = (schema, ajvOptions) => {
  * @type {SchemaValidator<import('../../eikjson.js').EikjsonSchema>}
  */
 const eikJSON = createValidator(eikJSONSchema, {
-    removeAdditional: true,
-    useDefaults: true,
+	removeAdditional: true,
+	useDefaults: true,
 });
 
 /**
@@ -59,26 +59,26 @@ const eikJSON = createValidator(eikJSONSchema, {
  * @returns {SchemaValidator<string>}
  */
 const createNameValidator = (jsonSchemaValidator) => (value) => {
-    const result = jsonSchemaValidator(value);
-    if (!result.error) {
-        const pkvalid = npmPkg(value);
-        /** @type {ErrorObject[]} */
-        const errors = [];
-        if (!pkvalid.validForNewPackages) {
-            errors.push({
-                keyword: 'validForNewPackages',
-                instancePath: '.name',
-                dataPath: '.name', // this was here before, but maybe replaced by instancePath?
-                schemaPath: '',
-                params: [],
-                message: 'should be valid package name',
-            });
-        }
-        if (errors.length) {
-            result.error = errors;
-        }
-    }
-    return result;
+	const result = jsonSchemaValidator(value);
+	if (!result.error) {
+		const pkvalid = npmPkg(value);
+		/** @type {ErrorObject[]} */
+		const errors = [];
+		if (!pkvalid.validForNewPackages) {
+			errors.push({
+				keyword: "validForNewPackages",
+				instancePath: ".name",
+				dataPath: ".name", // this was here before, but maybe replaced by instancePath?
+				schemaPath: "",
+				params: [],
+				message: "should be valid package name",
+			});
+		}
+		if (errors.length) {
+			result.error = errors;
+		}
+	}
+	return result;
 };
 
 /**
@@ -86,26 +86,26 @@ const createNameValidator = (jsonSchemaValidator) => (value) => {
  * @returns {SchemaValidator<string>}
  */
 const createVersionValidator = (jsonSchemaValidator) => (value) => {
-    const result = jsonSchemaValidator(value);
-    if (!result.error) {
-        const version = semver.valid(value);
-        /** @type {ErrorObject[]} */
-        const errors = [];
-        if (!version) {
-            errors.push({
-                keyword: 'invalidSemverRange',
-                instancePath: '.version',
-                dataPath: '.version',
-                schemaPath: '',
-                params: [],
-                message: 'should be valid semver range for version',
-            });
-        }
-        if (errors.length) {
-            result.error = errors;
-        }
-    }
-    return result;
+	const result = jsonSchemaValidator(value);
+	if (!result.error) {
+		const version = semver.valid(value);
+		/** @type {ErrorObject[]} */
+		const errors = [];
+		if (!version) {
+			errors.push({
+				keyword: "invalidSemverRange",
+				instancePath: ".version",
+				dataPath: ".version",
+				schemaPath: "",
+				params: [],
+				message: "should be valid semver range for version",
+			});
+		}
+		if (errors.length) {
+			result.error = errors;
+		}
+	}
+	return result;
 };
 
 /**
@@ -113,7 +113,7 @@ const createVersionValidator = (jsonSchemaValidator) => (value) => {
  * @type {SchemaValidator<string>}
  */
 const name = createNameValidator(
-    createValidator(eikJSONSchema.properties.name),
+	createValidator(eikJSONSchema.properties.name),
 );
 
 /**
@@ -121,7 +121,7 @@ const name = createNameValidator(
  * @type {SchemaValidator<string>}
  */
 const version = createVersionValidator(
-    createValidator(eikJSONSchema.properties.version),
+	createValidator(eikJSONSchema.properties.version),
 );
 
 /**
@@ -146,7 +146,7 @@ const files = createValidator(eikJSONSchema.properties.files);
  * Checks [import-map](https://eik.dev/docs/reference/eik-json#import-map)
  * @type {SchemaValidator<string | string[]>}
  */
-const importMap = createValidator(eikJSONSchema.properties['import-map']);
+const importMap = createValidator(eikJSONSchema.properties["import-map"]);
 
 /**
  * Checks [out](https://eik.dev/docs/reference/eik-json#out)

package/lib/schemas/validation-error.js

@@ -1,16 +1,16 @@
 // @ts-check
 
 class ValidationError extends Error {
-    /**
-     * @param {string} message
-     * @param {Error} err
-     */
-    constructor(message, err) {
-        let m = message;
-        if (err && err.message) m += `: ${err.message}`;
-        super(m);
-        this.name = this.constructor.name;
-        Error.captureStackTrace(this, this.constructor);
-    }
+	/**
+	 * @param {string} message
+	 * @param {Error} err
+	 */
+	constructor(message, err) {
+		let m = message;
+		if (err && err.message) m += `: ${err.message}`;
+		super(m);
+		this.name = this.constructor.name;
+		Error.captureStackTrace(this, this.constructor);
+	}
 }
 export default ValidationError;

package/lib/stream.js

@@ -4,10 +4,10 @@
  * @returns {boolean}
  */
 export const isStream = (stream) =>
-    stream !== null &&
-    typeof stream === 'object' &&
-    // @ts-expect-error
-    typeof stream.pipe === 'function';
+	stream !== null &&
+	typeof stream === "object" &&
+	// @ts-expect-error
+	typeof stream.pipe === "function";
 
 /**
  * Checks if the value is a {@link ReadableStream}
@@ -15,10 +15,10 @@ export const isStream = (stream) =>
  * @returns {boolean}
  */
 export const isReadableStream = (stream) =>
-    isStream(stream) &&
-    // @ts-expect-error
-    stream.readable !== false &&
-    // @ts-expect-error
-    typeof stream._read === 'function' &&
-    // @ts-expect-error
-    typeof stream._readableState === 'object';
+	isStream(stream) &&
+	// @ts-expect-error
+	stream.readable !== false &&
+	// @ts-expect-error
+	typeof stream._read === "function" &&
+	// @ts-expect-error
+	typeof stream._readableState === "object";

package/lib/validators/index.js

@@ -1,5 +1,5 @@
-import semver from 'semver';
-import npmPkg from 'validate-npm-package-name';
+import semver from "semver";
+import npmPkg from "validate-npm-package-name";
 
 const urlIsh = /^https?:\/\/[a-zA-Z0-9-_./]+(:[0-9]+)?/;
 
@@ -10,10 +10,10 @@ const urlIsh = /^https?:\/\/[a-zA-Z0-9-_./]+(:[0-9]+)?/;
  * @throws {Error} if the parameter does not match a URL pattern
  */
 export const origin = (value) => {
-    if (urlIsh.test(value)) {
-        return value.toLowerCase();
-    }
-    throw new Error('Parameter "origin" is not valid');
+	if (urlIsh.test(value)) {
+		return value.toLowerCase();
+	}
+	throw new Error('Parameter "origin" is not valid');
 };
 
 /**
@@ -23,10 +23,10 @@ export const origin = (value) => {
  * @throws {Error} if the value is not a valid organisation name
  */
 export const org = (value) => {
-    if (/^[a-zA-Z0-9_-]+$/.test(value)) {
-        return value.toLowerCase();
-    }
-    throw new Error(`Parameter "org" is not valid - Value: ${value}`);
+	if (/^[a-zA-Z0-9_-]+$/.test(value)) {
+		return value.toLowerCase();
+	}
+	throw new Error(`Parameter "org" is not valid - Value: ${value}`);
 };
 
 /**
@@ -36,11 +36,11 @@ export const org = (value) => {
  * @throws {Error} if the value is not a valid package name
  */
 export const name = (value) => {
-    const result = npmPkg(value);
-    if (result.validForNewPackages || result.validForOldPackages) {
-        return value.toLowerCase();
-    }
-    throw new Error(`Parameter "name" is not valid - Value: ${value}`);
+	const result = npmPkg(value);
+	if (result.validForNewPackages || result.validForOldPackages) {
+		return value.toLowerCase();
+	}
+	throw new Error(`Parameter "name" is not valid - Value: ${value}`);
 };
 
 /**
@@ -50,11 +50,11 @@ export const name = (value) => {
  * @throws {Error} if the value is not a valid semver version
  */
 export const version = (value) => {
-    const result = semver.valid(value);
-    if (result) {
-        return result;
-    }
-    throw new Error(`Parameter "version" is not valid - Value: ${value}`);
+	const result = semver.valid(value);
+	if (result) {
+		return result;
+	}
+	throw new Error(`Parameter "version" is not valid - Value: ${value}`);
 };
 
 /**
@@ -64,10 +64,10 @@ export const version = (value) => {
  * @throws {Error} if the value is not a valid alias value
  */
 export const alias = (value) => {
-    if (/^[0-9]+$/.test(value)) {
-        return value;
-    }
-    throw new Error(`Parameter "alias" is not valid - Value: ${value}`);
+	if (/^[0-9]+$/.test(value)) {
+		return value;
+	}
+	throw new Error(`Parameter "alias" is not valid - Value: ${value}`);
 };
 
 /**
@@ -77,15 +77,15 @@ export const alias = (value) => {
  * @throws {Error} if the value is not a valid Eik package type
  */
 export const type = (value) => {
-    if (
-        value === 'pkg' ||
-        value === 'map' ||
-        value === 'npm' ||
-        value === 'img'
-    ) {
-        return value;
-    }
-    throw new Error(`Parameter "type" is not valid - Value: ${value}`);
+	if (
+		value === "pkg" ||
+		value === "map" ||
+		value === "npm" ||
+		value === "img"
+	) {
+		return value;
+	}
+	throw new Error(`Parameter "type" is not valid - Value: ${value}`);
 };
 
 /**
@@ -104,8 +104,8 @@ export const extra = (value) => value;
  * @throws {Error} if the value is not a valid semver type
  */
 export const semverType = (value) => {
-    if (value === 'major' || value === 'minor' || value === 'patch') {
-        return value;
-    }
-    throw new Error(`Parameter "semverType" is not valid - Value: ${value}`);
+	if (value === "major" || value === "minor" || value === "patch") {
+		return value;
+	}
+	throw new Error(`Parameter "semverType" is not valid - Value: ${value}`);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/common",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -41,30 +41,31 @@
     "is-glob": "4.0.3",
     "mime-types": "2.1.35",
     "semver": "7.6.3",
-    "validate-npm-package-name": "5.0.1"
+    "validate-npm-package-name": "6.0.0"
   },
   "devDependencies": {
-    "@babel/plugin-syntax-import-assertions": "7.24.7",
-    "@eik/eslint-config": "1.0.2",
+    "@babel/plugin-syntax-import-assertions": "7.26.0",
+    "@eik/eslint-config": "1.0.5",
+    "@eik/prettier-config": "1.0.1",
     "@eik/semantic-release-config": "1.0.0",
     "@eik/typescript-config": "1.0.0",
-    "@hapi/hapi": "21.3.10",
+    "@hapi/hapi": "21.3.12",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@types/glob": "8.1.0",
     "@types/is-glob": "4.0.4",
     "@types/semver": "7.5.8",
     "@types/validate-npm-package-name": "4.0.2",
-    "eslint": "9.8.0",
-    "express": "4.19.2",
-    "fastify": "4.28.1",
-    "json-schema-to-typescript": "15.0.0",
-    "npm-run-all": "4.1.5",
+    "eslint": "9.14.0",
+    "express": "4.21.1",
+    "fastify": "5.1.0",
+    "json-schema-to-typescript": "15.0.3",
+    "npm-run-all2": "7.0.1",
     "prettier": "3.3.3",
     "rimraf": "6.0.1",
-    "semantic-release": "24.0.0",
+    "semantic-release": "24.2.0",
     "stoppable": "1.1.0",
-    "tap": "21.0.0",
-    "typescript": "5.5.4"
+    "tap": "21.0.1",
+    "typescript": "5.6.3"
   }
 }

package/types/classes/eik-config.d.ts

@@ -57,7 +57,7 @@ export default class EikConfig {
     [_tokens]: Map<string, string>;
 }
 export type EikjsonSchema = import("../../eikjson.js").EikjsonSchema;
-import FileMapping from './file-mapping.js';
+import FileMapping from "./file-mapping.js";
 declare const _config: unique symbol;
 declare const _tokens: unique symbol;
 export {};

package/types/classes/file-mapping.d.ts

@@ -17,5 +17,5 @@ declare class FileMapping {
      */
     destination: RemoteFileLocation;
 }
-import LocalFileLocation from './local-file-location.js';
-import RemoteFileLocation from './remote-file-location.js';
+import LocalFileLocation from "./local-file-location.js";
+import RemoteFileLocation from "./remote-file-location.js";

package/types/classes/invalid-config-error.d.ts

@@ -1,3 +1,3 @@
 export default class InvalidConfigError extends CustomError {
 }
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";

package/types/classes/missing-config-error.d.ts

@@ -1,3 +1,3 @@
 export default class MissingConfigError extends CustomError {
 }
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";

package/types/classes/multiple-config-sources-error.d.ts

@@ -1,4 +1,4 @@
 export default class MultipleConfigSourcesError extends CustomError {
     constructor();
 }
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";

package/types/classes/no-files-matched-error.d.ts

@@ -1,3 +1,3 @@
 export default class NoFilesMatchedError extends CustomError {
 }
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";

package/types/classes/resolved-files.d.ts

@@ -16,5 +16,5 @@ declare class ResolvedFiles {
     [Symbol.iterator](): Generator<LocalFileLocation, void, unknown>;
     [originalFiles]: string[];
 }
-import LocalFileLocation from './local-file-location.js';
+import LocalFileLocation from "./local-file-location.js";
 declare const originalFiles: unique symbol;

package/types/classes/single-dest-multiple-source-error.d.ts

@@ -1,3 +1,3 @@
 export default class SingleDestMultipleSourcesError extends CustomError {
 }
-import CustomError from './custom-error.js';
+import CustomError from "./custom-error.js";

package/types/helpers/config-store.d.ts

@@ -25,4 +25,4 @@ declare namespace _default {
     function persistToDisk(config: typeof import("../classes/eik-config.js")): void;
 }
 export default _default;
-import EikConfig from '../classes/eik-config.js';
+import EikConfig from "../classes/eik-config.js";

package/types/helpers/index.d.ts

@@ -11,13 +11,13 @@ declare namespace _default {
     export { resolveFiles };
 }
 export default _default;
-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 { addTrailingSlash } from './path-slashes.js';
-import { removeTrailingSlash } from './path-slashes.js';
-import { addLeadingSlash } from './path-slashes.js';
-import { removeLeadingSlash } from './path-slashes.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 { addTrailingSlash } from "./path-slashes.js";
+import { removeTrailingSlash } from "./path-slashes.js";
+import { addLeadingSlash } from "./path-slashes.js";
+import { removeLeadingSlash } from "./path-slashes.js";
+import resolveFiles from "./resolve-files.js";

package/types/helpers/resolve-files.d.ts

@@ -10,4 +10,4 @@ export default resolveFiles;
 declare function resolveFiles(files: {
     [k: string]: string;
 }, cwd: string): Promise<ResolvedFiles[]>;
-import ResolvedFiles from '../classes/resolved-files.js';
+import ResolvedFiles from "../classes/resolved-files.js";

package/types/index.d.ts

@@ -7,10 +7,10 @@ declare namespace _default {
     export { helpers };
 }
 export default _default;
-import * as validators from './validators/index.js';
-import ReadFile from './classes/read-file.js';
-import EikConfig from './classes/eik-config.js';
-import schemas from './schemas/index.js';
-import * as stream from './stream.js';
-import helpers from './helpers/index.js';
+import * as validators from "./validators/index.js";
+import ReadFile from "./classes/read-file.js";
+import EikConfig from "./classes/eik-config.js";
+import schemas from "./schemas/index.js";
+import * as stream from "./stream.js";
+import helpers from "./helpers/index.js";
 export { validators, ReadFile, EikConfig, schemas, stream, helpers };

package/types/schemas/index.d.ts

@@ -6,6 +6,6 @@ declare namespace _default {
 }
 export default _default;
 declare const schema: any;
-import * as validate from './validate.js';
-import assert from './assert.js';
-import ValidationError from './validation-error.js';
+import * as validate from "./validate.js";
+import assert from "./assert.js";
+import ValidationError from "./validation-error.js";