@eik/common 5.1.2 → 5.1.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.1.4](https://github.com/eik-lib/common/compare/v5.1.3...v5.1.4) (2025-06-11)
+
+
+### Bug Fixes
+
+* refactor to use native JSON module for import ([#365](https://github.com/eik-lib/common/issues/365)) ([53fc469](https://github.com/eik-lib/common/commit/53fc46995d25a992345c5152e9ee4260acb3424a))
+
+## [5.1.3](https://github.com/eik-lib/common/compare/v5.1.2...v5.1.3) (2025-06-11)
+
+
+### Bug Fixes
+
+* internal refactoring to reduce file size when bundled ([#363](https://github.com/eik-lib/common/issues/363)) ([5e06159](https://github.com/eik-lib/common/commit/5e061594f92ccb9c2c137faa35410aa192782207))
+
 ## [5.1.2](https://github.com/eik-lib/common/compare/v5.1.1...v5.1.2) (2025-06-07)
 
 

package/lib/schemas/index.js

@@ -1,15 +1,6 @@
-import { readFileSync } from "node:fs";
-import { join, dirname } from "node:path";
+import schema from "./schema.js";
 import * as validate from "./validate.js";
 import assert from "./assert.js";
 import ValidationError from "./validation-error.js";
-import { fileURLToPath } from "node:url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-const schema = JSON.parse(
-	readFileSync(join(__dirname, "./eikjson.schema.json"), "utf8"),
-);
 
 export default { schema, validate, assert, ValidationError };

package/lib/schemas/schema.js

@@ -0,0 +1,3 @@
+import schema from "./eikjson.schema.json" with { type: "json" };
+
+export default schema;

package/lib/schemas/validate.js

@@ -1,17 +1,8 @@
-import { readFileSync } from "node:fs";
-import { join, dirname } from "node:path";
 import formats from "ajv-formats";
-import semver from "semver";
+import validSemver from "semver/functions/valid.js";
 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"),
-);
+import eikJSONSchema from "./schema.js";
 
 /**
  * @typedef {import('ajv').ErrorObject & { dataPath?: string }} ErrorObject
@@ -88,7 +79,7 @@ const createNameValidator = (jsonSchemaValidator) => (value) => {
 const createVersionValidator = (jsonSchemaValidator) => (value) => {
 	const result = jsonSchemaValidator(value);
 	if (!result.error) {
-		const version = semver.valid(value);
+		const version = validSemver(value);
 		/** @type {ErrorObject[]} */
 		const errors = [];
 		if (!version) {

package/lib/validators/alias.js

@@ -0,0 +1,12 @@
+/**
+ * Checks that a value is a valid alias value.
+ * @param {string} value
+ * @returns {string} the value in lowercase
+ * @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}`);
+};

package/lib/validators/extra.js

@@ -0,0 +1,8 @@
+/**
+ * No-op, returning its value.
+ * @param {string} value
+ * @returns {string} the value
+ * @todo https://github.com/asset-pipe/core/issues/12
+ * @todo Can we remove this?
+ */
+export const extra = (value) => value;

package/lib/validators/index.js

@@ -1,111 +1,8 @@
-import semver from "semver";
-import npmPkg from "validate-npm-package-name";
-
-const urlIsh = /^https?:\/\/[a-zA-Z0-9-_./]+(:[0-9]+)?/;
-
-/**
- * Check that a value looks like an HTTP origin.
- * @param {string} value
- * @returns {string} the value in lowercase
- * @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');
-};
-
-/**
- * Checks that a value is a valid organisation name.
- * @param {string} value
- * @returns {string} the value in lowercase
- * @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}`);
-};
-
-/**
- * Checks that a value is a valid package name.
- * @param {string} value
- * @returns {string} the value in lowercase
- * @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}`);
-};
-
-/**
- * Checks that a value is a valid semver version.
- * @param {string} value
- * @returns {string} the value in lowercase
- * @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}`);
-};
-
-/**
- * Checks that a value is a valid alias value.
- * @param {string} value
- * @returns {string} the value in lowercase
- * @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}`);
-};
-
-/**
- * Checks that a value is a valid Eik package type.
- * @param {string} value
- * @returns {string} the value in lowercase
- * @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}`);
-};
-
-/**
- * No-op, returning its value.
- * @param {string} value
- * @returns {string} the value
- * @todo https://github.com/asset-pipe/core/issues/12
- * @todo Can we remove this?
- */
-export const extra = (value) => value;
-
-/**
- * Checks that a value is a valid semver type (major, minor, patch).
- * @param {string} value
- * @returns {string} the 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}`);
-};
+export { alias } from "./alias.js";
+export { extra } from "./extra.js";
+export { name } from "./name.js";
+export { org } from "./org.js";
+export { origin } from "./origin.js";
+export { semverType } from "./semver-type.js";
+export { type } from "./type.js";
+export { version } from "./version.js";

package/lib/validators/name.js

@@ -0,0 +1,15 @@
+import npmPkg from "validate-npm-package-name";
+
+/**
+ * Checks that a value is a valid package name.
+ * @param {string} value
+ * @returns {string} the value in lowercase
+ * @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}`);
+};

package/lib/validators/org.js

@@ -0,0 +1,12 @@
+/**
+ * Checks that a value is a valid organisation name.
+ * @param {string} value
+ * @returns {string} the value in lowercase
+ * @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}`);
+};

package/lib/validators/origin.js

@@ -0,0 +1,14 @@
+const urlIsh = /^https?:\/\/[a-zA-Z0-9-_./]+(:[0-9]+)?/;
+
+/**
+ * Check that a value looks like an HTTP origin.
+ * @param {string} value
+ * @returns {string} the value in lowercase
+ * @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');
+};

package/lib/validators/semver-type.js

@@ -0,0 +1,12 @@
+/**
+ * Checks that a value is a valid semver type (major, minor, patch).
+ * @param {string} value
+ * @returns {string} the 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}`);
+};

package/lib/validators/type.js

@@ -0,0 +1,17 @@
+/**
+ * Checks that a value is a valid Eik package type.
+ * @param {string} value
+ * @returns {string} the value in lowercase
+ * @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}`);
+};

package/lib/validators/version.js

@@ -0,0 +1,15 @@
+import valid from "semver/functions/valid.js";
+
+/**
+ * Checks that a value is a valid semver version.
+ * @param {string} value
+ * @returns {string} the value in lowercase
+ * @throws {Error} if the value is not a valid semver version
+ */
+export const version = (value) => {
+	const result = valid(value);
+	if (result) {
+		return result;
+	}
+	throw new Error(`Parameter "version" is not valid - Value: ${value}`);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/common",
-  "version": "5.1.2",
+  "version": "5.1.4",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
   "types": "types/index.d.ts",

package/types/schemas/index.d.ts

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

package/types/schemas/schema.d.ts

@@ -0,0 +1,2 @@
+export default schema;
+import schema from "./eikjson.schema.json" with { type: "json" };

package/types/validators/alias.d.ts

@@ -0,0 +1 @@
+export function alias(value: string): string;

package/types/validators/extra.d.ts

@@ -0,0 +1 @@
+export function extra(value: string): string;

package/types/validators/index.d.ts

@@ -1,8 +1,8 @@
-export function origin(value: string): string;
-export function org(value: string): string;
-export function name(value: string): string;
-export function version(value: string): string;
-export function alias(value: string): string;
-export function type(value: string): string;
-export function extra(value: string): string;
-export function semverType(value: string): string;
+export { alias } from "./alias.js";
+export { extra } from "./extra.js";
+export { name } from "./name.js";
+export { org } from "./org.js";
+export { origin } from "./origin.js";
+export { semverType } from "./semver-type.js";
+export { type } from "./type.js";
+export { version } from "./version.js";

package/types/validators/name.d.ts

@@ -0,0 +1 @@
+export function name(value: string): string;

package/types/validators/org.d.ts

@@ -0,0 +1 @@
+export function org(value: string): string;

package/types/validators/origin.d.ts

@@ -0,0 +1 @@
+export function origin(value: string): string;

package/types/validators/semver-type.d.ts

@@ -0,0 +1 @@
+export function semverType(value: string): string;

package/types/validators/type.d.ts

@@ -0,0 +1 @@
+export function type(value: string): string;

package/types/validators/version.d.ts

@@ -0,0 +1 @@
+export function version(value: string): string;