@eik/core 1.3.53 → 1.3.55

package/lib/utils/healthcheck.js

@@ -1,111 +1,134 @@
-import { Writable, pipeline } from 'node:stream';
-import { URL } from 'node:url';
-import abslog from 'abslog';
-import slug from 'unique-slug';
-import fs from 'node:fs';
+import { Writable, pipeline } from "node:stream";
+import { URL } from "node:url";
+import abslog from "abslog";
+import slug from "unique-slug";
+import fs from "node:fs";
 
-const fileReader = (file = '../../README.md') => fs.createReadStream(new URL(file, import.meta.url));
+const fileReader = (file = "../../README.md") =>
+	fs.createReadStream(new URL(file, import.meta.url));
+
+/**
+ * @typedef {object} HealthCheckOptions
+ * @property {import("@eik/sink").default} [sink]
+ * @property {import("abslog").AbstractLoggerOptions} [logger]
+ */
 
 const HealthCheck = class HealthCheck {
-    constructor({ sink, logger } = {}) {
-        this._sink = sink;
-        this._name = `./system/tmp/health_${slug()}.txt`;
-        this._log = abslog(logger);
-    }
-
-    _write() {
-        return new Promise((resolve, reject) => {
-            this._sink.write(this._name, 'text/plain').then((destination) => {
-                const source = fileReader();
-                pipeline(source, destination, (error) => {
-                    if (error) return reject(error);
-                    return resolve();
-                });
-            }).catch((error) => {
-                reject(error);
-            });
-        });
-    }
-
-    _read() {
-        return new Promise((resolve, reject) => {
-            this._sink.read(this._name).then((source) => {
-                const buffer = [];
-                const destination = new Writable({
-                    objectMode: false,
-                    write(chunk, encoding, callback) {
-                        buffer.push(chunk);
-                        callback();
-                    },
-                });
-
-                pipeline(source.stream, destination, (error) => {
-                    if (error) return reject(error);
-                    return resolve();
-                });
-            }).catch((error) => {
-                reject(error);
-            });
-        });
-    }
-
-    _delete() {
-        return this._sink.delete(this._name);
-    }
-
-    _exist() {
-        return this._sink.exist(this._name);
-    }
-
-    async check() {
-        this._log.info(`Sink health check started - testing with file ${this._name}`);
-
-        try {
-            await this._write();
-        } catch (error) {
-            this._log.warn('Sink health check errored during write');
-            this._log.error(error);
-            throw error;
-        }
-
-        try {
-            await this._exist();
-        } catch (error) {
-            this._log.warn('Sink health check errored when checking content written by sink.write(). Content was probably not written to sink.');
-            this._log.error(error);
-            throw error;
-        }
-
-        try {
-            await this._read();
-        } catch (error) {
-            this._log.warn('Sink health check errored during read');
-            this._log.error(error);
-            throw error;
-        }
-
-        try {
-            await this._delete();
-        } catch (error) {
-            this._log.warn('Sink health check errored during deletion');
-            this._log.error(error);
-            throw error;
-        }
-
-        try {
-            await this._exist();
-            this._log.warn('Sink health check successfully read file after deletion. It should not. Content was probably not deleted by sink.delete().');
-            throw new Error('File exist in sink');
-        } catch (error) {
-            this._log.info('Sink health check ended successfully. Sink is healthy');
-        }
-
-        return true;
-    }
-
-    get [Symbol.toStringTag]() {
-        return 'HealthCheck';
-    }
-}
-
-export default HealthCheck;
+	/**
+	 * @param {HealthCheckOptions} options
+	 */
+	constructor({ sink, logger } = {}) {
+		this._sink = sink;
+		this._name = `./system/tmp/health_${slug()}.txt`;
+		this._log = abslog(logger);
+	}
+
+	_write() {
+		return new Promise((resolve, reject) => {
+			this._sink
+				.write(this._name, "text/plain")
+				.then((destination) => {
+					const source = fileReader();
+					pipeline(source, destination, (error) => {
+						if (error) return reject(error);
+						return resolve();
+					});
+				})
+				.catch((error) => {
+					reject(error);
+				});
+		});
+	}
+
+	_read() {
+		return new Promise((resolve, reject) => {
+			this._sink
+				.read(this._name)
+				.then((source) => {
+					const buffer = [];
+					const destination = new Writable({
+						objectMode: false,
+						write(chunk, encoding, callback) {
+							buffer.push(chunk);
+							callback();
+						},
+					});
+
+					pipeline(source.stream, destination, (error) => {
+						if (error) return reject(error);
+						return resolve();
+					});
+				})
+				.catch((error) => {
+					reject(error);
+				});
+		});
+	}
+
+	_delete() {
+		return this._sink.delete(this._name);
+	}
+
+	_exist() {
+		return this._sink.exist(this._name);
+	}
+
+	async check() {
+		this._log.info(
+			`Sink health check started - testing with file ${this._name}`,
+		);
+
+		try {
+			await this._write();
+		} catch (error) {
+			this._log.warn("Sink health check errored during write");
+			this._log.error(error);
+			throw error;
+		}
+
+		try {
+			await this._exist();
+		} catch (error) {
+			this._log.warn(
+				"Sink health check errored when checking content written by sink.write(). Content was probably not written to sink.",
+			);
+			this._log.error(error);
+			throw error;
+		}
+
+		try {
+			await this._read();
+		} catch (error) {
+			this._log.warn("Sink health check errored during read");
+			this._log.error(error);
+			throw error;
+		}
+
+		try {
+			await this._delete();
+		} catch (error) {
+			this._log.warn("Sink health check errored during deletion");
+			this._log.error(error);
+			throw error;
+		}
+
+		try {
+			await this._exist();
+			this._log.warn(
+				"Sink health check successfully read file after deletion. It should not. Content was probably not deleted by sink.delete().",
+			);
+			throw new Error("File exist in sink");
+			// eslint-disable-next-line no-unused-vars
+		} catch (error) {
+			this._log.info("Sink health check ended successfully. Sink is healthy");
+		}
+
+		return true;
+	}
+
+	get [Symbol.toStringTag]() {
+		return "HealthCheck";
+	}
+};
+
+export default HealthCheck;

package/lib/utils/path-builders-fs.js

@@ -1,47 +1,79 @@
-import path from 'node:path';
-import globals from './globals.js';
-
+import path from "node:path";
+import globals from "./globals.js";
 
 // Build file system path to a package file
 
-const createFilePathToPackage = ({ org = '', type = '', name = '', version = '' } = {}) => path.join(globals.ROOT, org, type, name, `${version}.package.json`)
-
+const createFilePathToPackage = ({
+	org = "",
+	type = "",
+	name = "",
+	version = "",
+} = {}) => path.join(globals.ROOT, org, type, name, `${version}.package.json`);
 
 // Build file system path to an asset in a package
 // pkgAsset
-const createFilePathToAsset = ({ org = '', type = '', name = '', version = '', asset = '' } = {}) => path.join(globals.ROOT, org, type, name, version, asset)
-
+const createFilePathToAsset = ({
+	org = "",
+	type = "",
+	name = "",
+	version = "",
+	asset = "",
+} = {}) => path.join(globals.ROOT, org, type, name, version, asset);
 
 // Build file system path to an import map
 
-const createFilePathToImportMap = ({ org = '', name = '', version = '' } = {}) => path.join(globals.ROOT, org, globals.BASE_IMPORT_MAPS, name, `${version}.import-map.json`)
-
+const createFilePathToImportMap = ({
+	org = "",
+	name = "",
+	version = "",
+} = {}) =>
+	path.join(
+		globals.ROOT,
+		org,
+		globals.BASE_IMPORT_MAPS,
+		name,
+		`${version}.import-map.json`,
+	);
 
 // Build file system path to an alias file
 
-const createFilePathToAlias = ({ org = '', type = '', name = '', alias = '' } = {}) => path.join(globals.ROOT, org, type, name, `${alias}.alias.json`)
-
+const createFilePathToAlias = ({
+	org = "",
+	type = "",
+	name = "",
+	alias = "",
+} = {}) => path.join(globals.ROOT, org, type, name, `${alias}.alias.json`);
 
 // Build file system path to an version file
 
-const createFilePathToVersion = ({ org = '', type = '', name = '' } = {}) => path.join(globals.ROOT, org, type, name, 'versions.json')
-
-const createFilePathToEikJson = ({ org = '', type = '', name = '', version } = {}) => path.join(globals.ROOT, org, type, name, version, 'eik.json')
-
-const createFilePathToAliasOrigin = ({org = '', type = '', name = '', version = '',} = {}) => {
-    if(type === 'map') {
-        return createFilePathToImportMap({org, name, version})
-    }
-    return createFilePathToPackage({org, type, name, version})
+const createFilePathToVersion = ({ org = "", type = "", name = "" } = {}) =>
+	path.join(globals.ROOT, org, type, name, "versions.json");
+
+const createFilePathToEikJson = ({
+	org = "",
+	type = "",
+	name = "",
+	version = "",
+} = {}) => path.join(globals.ROOT, org, type, name, version, "eik.json");
+
+const createFilePathToAliasOrigin = ({
+	org = "",
+	type = "",
+	name = "",
+	version = "",
+} = {}) => {
+	if (type === "map") {
+		return createFilePathToImportMap({ org, name, version });
+	}
+	return createFilePathToPackage({ org, type, name, version });
 };
 
-
 export {
-    createFilePathToPackage,
-    createFilePathToAsset,
-    createFilePathToImportMap,
-    createFilePathToAlias,
-    createFilePathToVersion,
-    createFilePathToAliasOrigin,
-    createFilePathToEikJson,
-}
+	createFilePathToPackage,
+	createFilePathToAsset,
+	createFilePathToImportMap,
+	createFilePathToAlias,
+	createFilePathToVersion,
+	createFilePathToAliasOrigin,
+	createFilePathToEikJson,
+};

package/lib/utils/path-builders-uri.js

@@ -1,35 +1,43 @@
-import path from 'node:path';
-import globals from './globals.js';
-
+import path from "node:path";
+import globals from "./globals.js";
 
 // Build URL pathname to a package log file
 
-const createURIPathToPkgLog = ({ type = '', name = '', version = '' } = {}) => path.join(globals.ROOT, type, name, version)
-
+const createURIPathToPkgLog = ({ type = "", name = "", version = "" } = {}) =>
+	path.join(globals.ROOT, type, name, version);
 
 // Build URL pathname to an asset in a package
 
-const createURIPathToAsset = ({ type = '', name = '', version = '', asset = '' } = {}) => path.join(globals.ROOT, type, name, version, asset)
-
+const createURIPathToAsset = ({
+	type = "",
+	name = "",
+	version = "",
+	asset = "",
+} = {}) => path.join(globals.ROOT, type, name, version, asset);
 
 // Build URL pathname to an import map
 
-const createURIPathToImportMap = ({ name = '', version = '' } = {}) => path.join(globals.ROOT, globals.BASE_IMPORT_MAPS, name, version)
-
+const createURIPathToImportMap = ({ name = "", version = "" } = {}) =>
+	path.join(globals.ROOT, globals.BASE_IMPORT_MAPS, name, version);
 
 // Build URL pathname to an alias source
 
-const createURIToAlias = ({ type = '', name = '', alias = '' } = {}) => path.join(globals.ROOT, type, name, `v${alias}`)
-
+const createURIToAlias = ({ type = "", name = "", alias = "" } = {}) =>
+	path.join(globals.ROOT, type, name, `v${alias}`);
 
 // Build URL pathname to an alias target destination
 
-const createURIToTargetOfAlias = ({ type = '', name = '', version = '', extra = '' } = {}) => path.join(globals.ROOT, type, name, version, extra)
+const createURIToTargetOfAlias = ({
+	type = "",
+	name = "",
+	version = "",
+	extra = "",
+} = {}) => path.join(globals.ROOT, type, name, version, extra);
 
 export {
-    createURIPathToPkgLog,
-    createURIPathToAsset,
-    createURIPathToImportMap,
-    createURIToAlias,
-    createURIToTargetOfAlias,
-}
+	createURIPathToPkgLog,
+	createURIPathToAsset,
+	createURIPathToImportMap,
+	createURIToAlias,
+	createURIToTargetOfAlias,
+};

package/lib/utils/utils.js

@@ -1,95 +1,92 @@
-import { Writable, Readable, pipeline } from 'node:stream';
+import { Writable, Readable, pipeline } from "node:stream";
 
-const readJSON = (sink, path) => 
-    // eslint-disable-next-line no-async-promise-executor
-     new Promise(async (resolve, reject) => {
-        try {
-            const buffer = [];
-            const from = await sink.read(path);
+const readJSON = (sink, path) =>
+	// eslint-disable-next-line no-async-promise-executor
+	new Promise(async (resolve, reject) => {
+		try {
+			const buffer = [];
+			const from = await sink.read(path);
 
-            const to = new Writable({
-                objectMode: false,
-                write(chunk, encoding, callback) {
-                    buffer.push(chunk);
-                    callback();
-                },
-            });
-
-            pipeline(from.stream, to, error => {
-                if (error) return reject(error);
-                const str = buffer.join('').toString();
-                try {
-                    const obj = JSON.parse(str);
-                    return resolve(obj);
-                } catch (err) {
-                    return reject(err);
-                }
-            });
-        } catch (error) {
-            reject(error);
-        }
-    })
-;
+			const to = new Writable({
+				objectMode: false,
+				write(chunk, encoding, callback) {
+					buffer.push(chunk);
+					callback();
+				},
+			});
 
+			pipeline(from.stream, to, (error) => {
+				if (error) return reject(error);
+				const str = buffer.join("").toString();
+				try {
+					const obj = JSON.parse(str);
+					return resolve(obj);
+				} catch (err) {
+					return reject(err);
+				}
+			});
+		} catch (error) {
+			reject(error);
+		}
+	});
 const readEikJson = (sink, path) => sink.exist(path);
 
-const writeJSON = (sink, path, obj, contentType) => 
-    // eslint-disable-next-line no-async-promise-executor
-     new Promise(async (resolve, reject) => {
-        try {
-            const buffer = Buffer.from(JSON.stringify(obj));
-
-            const from = new Readable({
-                objectMode: false,
-                read() {
-                    this.push(buffer);
-                    this.push(null);
-                },
-            });
+const writeJSON = (sink, path, obj, contentType) =>
+	// eslint-disable-next-line no-async-promise-executor
+	new Promise(async (resolve, reject) => {
+		try {
+			const buffer = Buffer.from(JSON.stringify(obj));
 
-            const to = await sink.write(path, contentType);
+			const from = new Readable({
+				objectMode: false,
+				read() {
+					this.push(buffer);
+					this.push(null);
+				},
+			});
 
-            pipeline(from, to, error => {
-                if (error) return reject(error);
-                return resolve(buffer);
-            });
-        } catch (error) {
-            reject(error);
-        }
-    })
-;
+			const to = await sink.write(path, contentType);
 
-const streamCollector = (from) => new Promise((resolve, reject) => {
-        const buffer = [];
-        const to = new Writable({
-            write(chunk, encoding, cb) {
-                buffer.push(chunk);
-                cb();
-            },
-        });
+			pipeline(from, to, (error) => {
+				if (error) return reject(error);
+				return resolve(buffer);
+			});
+		} catch (error) {
+			reject(error);
+		}
+	});
+const streamCollector = (from) =>
+	new Promise((resolve, reject) => {
+		const buffer = [];
+		const to = new Writable({
+			write(chunk, encoding, cb) {
+				buffer.push(chunk);
+				cb();
+			},
+		});
 
-        pipeline(from, to, error => {
-            if (error) return reject(error);
-            return resolve(buffer.join('').toString());
-        });
-    });
+		pipeline(from, to, (error) => {
+			if (error) return reject(error);
+			return resolve(buffer.join("").toString());
+		});
+	});
 
 const etagFromFsStat = (stat) => {
-    const mtime = stat.mtime.getTime().toString(16)
-    const size = stat.size.toString(16)
-    return `W/"${size}-${mtime}"`;
+	const mtime = stat.mtime.getTime().toString(16);
+	const size = stat.size.toString(16);
+	return `W/"${size}-${mtime}"`;
 };
 
 const decodeUriComponent = (value) => {
-    if (value === null || value === undefined) return value;
-    return decodeURIComponent(value);
-}
+	if (value === null || value === undefined) return value;
+	return decodeURIComponent(value);
+};
 
 export {
-    readJSON,
-    writeJSON,
-    streamCollector,
-    etagFromFsStat,
-    decodeUriComponent,
-    readEikJson
-}
+	readJSON,
+	writeJSON,
+	streamCollector,
+	etagFromFsStat,
+	decodeUriComponent,
+	readEikJson,
+};

package/package.json

@@ -1,25 +1,31 @@
 {
   "name": "@eik/core",
-  "version": "1.3.53",
+  "version": "1.3.55",
   "description": "Core server package",
   "main": "lib/main.js",
+  "types": "./types/main.d.ts",
   "type": "module",
   "files": [
     "CHANGELOG.md",
     "package.json",
-    "lib"
+    "lib",
+    "types"
   ],
   "scripts": {
-    "test": "tap --disable-coverage --allow-empty-coverage",
-    "test:snapshots:update": "tap --snapshot",
+    "clean": "rimraf node_modules .tap types",
+    "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "lint": "eslint ."
+    "test": "tap --disable-coverage --allow-empty-coverage",
+    "test:snapshots": "tap --snapshot",
+    "types": "run-s types:module types:test",
+    "types:module": "tsc",
+    "types:test": "tsc --project tsconfig.test.json"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@eik/common": "3.0.1",
+    "@eik/common": "4.0.6",
     "@eik/sink": "1.2.5",
     "@eik/sink-file-system": "1.0.1",
     "@eik/sink-memory": "1.1.1",
@@ -36,20 +42,19 @@
     "unique-slug": "4.0.0"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.24.6",
+    "@eik/eslint-config": "1.0.2",
+    "@eik/prettier-config": "1.0.1",
     "@eik/semantic-release-config": "1.0.0",
-    "@semantic-release/changelog": "6.0.3",
-    "@semantic-release/git": "10.0.1",
-    "eslint": "8.57.0",
-    "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-prettier": "5.1.3",
+    "@eik/typescript-config": "1.0.0",
+    "@types/readable-stream": "4.0.15",
+    "eslint": "9.8.0",
     "form-data": "4.0.0",
     "mkdirp": "3.0.1",
     "node-fetch": "3.3.2",
-    "prettier": "3.2.5",
-    "semantic-release": "23.1.1",
-    "tap": "18.8.0"
+    "npm-run-all": "4.1.5",
+    "prettier": "3.3.3",
+    "semantic-release": "24.0.0",
+    "tap": "18.8.0",
+    "typescript": "5.5.4"
   }
 }