@eik/cli 3.1.3 → 3.1.5

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.1.5](https://github.com/eik-lib/cli/compare/v3.1.4...v3.1.5) (2024-08-29)
+
+
+### Bug Fixes
+
+* handle relative and absolute paths to config, improve error messages, edit help for brevity ([06e9951](https://github.com/eik-lib/cli/commit/06e9951a6efe6b3f37600f6f0477417e708dcf08))
+
+## [3.1.4](https://github.com/eik-lib/cli/compare/v3.1.3...v3.1.4) (2024-08-26)
+
+
+### Bug Fixes
+
+* **deps:** update dependency ora to v8.1.0 ([7a784bc](https://github.com/eik-lib/cli/commit/7a784bc3f36713d932041a7b7c9a7dc56ffc0a63))
+
 ## [3.1.3](https://github.com/eik-lib/cli/compare/v3.1.2...v3.1.3) (2024-08-19)
 
 

package/classes/alias.js

@@ -1,15 +1,15 @@
-import assert from 'assert';
-import abslog from 'abslog';
-import { schemas, validators } from '@eik/common';
-import { request } from '../utils/http/index.js';
-import { typeSlug } from '../utils/index.js';
-import { joinUrlPathname } from '../utils/url.js';
+import assert from "assert";
+import abslog from "abslog";
+import { schemas, validators } from "@eik/common";
+import { request } from "../utils/http/index.js";
+import { typeSlug } from "../utils/index.js";
+import { joinUrlPathname } from "../utils/url.js";
 
 /**
  * @typedef {object} AliasOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
  * @property {string} server
- * @property {"package" | "npm" | "map"} [type="package"]
+ * @property {"package" | "npm" | "image" | "map"} [type="package"]
  * @property {string} name
  * @property {string} version
  * @property {string} alias
@@ -30,127 +30,117 @@ import { joinUrlPathname } from '../utils/url.js';
  */
 
 export default class Alias {
-    /**
-     * @param {AliasOptions} options
-     */
-    constructor({ logger, server, token, type, name, version, alias }) {
-        this.log = abslog(logger);
-        this.server = server;
-        this.token = token;
-        this.type = typeSlug(type);
-        this.name = name;
-        this.alias = alias;
-        this.version = version;
-    }
+	/**
+	 * @param {AliasOptions} options
+	 */
+	constructor({ logger, server, token, type, name, version, alias }) {
+		this.log = abslog(logger);
+		this.server = server;
+		this.token = token;
+		this.type = typeSlug(type);
+		this.name = name;
+		this.alias = alias;
+		this.version = version;
+	}
 
-    /**
-     * @returns {Promise<AliasResult>}
-     */
-    async run() {
-        const data = {
-            server: this.server,
-            type: this.type,
-            name: this.name,
-            alias: this.alias,
-            version: this.version,
-            update: false,
-            files: [],
-            org: '',
-            integrity: '',
-        };
+	/**
+	 * @returns {Promise<AliasResult>}
+	 */
+	async run() {
+		const data = {
+			server: this.server,
+			type: this.type,
+			name: this.name,
+			alias: this.alias,
+			version: this.version,
+			update: false,
+			files: [],
+			org: "",
+			integrity: "",
+		};
 
-        this.log.debug('Validating command input');
-        schemas.assert.server(this.server);
-        schemas.assert.name(this.name);
-        schemas.assert.version(this.version);
-        validators.type(this.type);
-        validators.alias(this.alias);
-        assert(
-            this.token && typeof this.token === 'string',
-            `Parameter "token" is not valid`,
-        );
+		this.log.debug("Validating command input");
+		schemas.assert.server(this.server);
+		schemas.assert.name(this.name);
+		schemas.assert.version(this.version);
+		validators.type(this.type);
+		validators.alias(this.alias);
+		assert(
+			this.token && typeof this.token === "string",
+			`Parameter "token" is not valid`,
+		);
 
-        this.log.debug(
-            `Requesting creation of ${this.type} alias "v${this.alias}" for ${this.name} v${this.version} on ${this.server}`,
-        );
+		this.log.debug(
+			`Requesting creation of ${this.type} alias "v${this.alias}" for ${this.name} v${this.version} on ${this.server}`,
+		);
 
-        const pathname = joinUrlPathname(
-            this.type,
-            this.name,
-            `v${this.alias}`,
-        );
-        try {
-            const { message } = await request({
-                host: this.server,
-                method: 'PUT',
-                pathname,
-                data: { version: this.version },
-                token: this.token,
-            });
+		const pathname = joinUrlPathname(this.type, this.name, `v${this.alias}`);
+		try {
+			const { message } = await request({
+				host: this.server,
+				method: "PUT",
+				pathname,
+				data: { version: this.version },
+				token: this.token,
+			});
 
-            data.org = message.org || '';
-            data.integrity = message.integrity || '';
-            data.version = message.version || this.version;
-            data.name = message.name || this.name;
-            data.files = message.files || [];
+			data.org = message.org || "";
+			data.integrity = message.integrity || "";
+			data.version = message.version || this.version;
+			data.name = message.name || this.name;
+			data.files = message.files || [];
 
-            return data;
-        } catch (err) {
-            let status = err.statusCode;
+			return data;
+		} catch (err) {
+			let status = err.statusCode;
 
-            if (status === 409) {
-                this.log.debug(
-                    'Alias already exists on server, performing update',
-                );
+			if (status === 409) {
+				this.log.debug("Alias already exists on server, performing update");
 
-                try {
-                    const { message: msg } = await request({
-                        host: this.server,
-                        method: 'POST',
-                        pathname,
-                        data: { version: this.version },
-                        token: this.token,
-                    });
+				try {
+					const { message: msg } = await request({
+						host: this.server,
+						method: "POST",
+						pathname,
+						data: { version: this.version },
+						token: this.token,
+					});
 
-                    data.org = msg.org || '';
-                    data.integrity = msg.integrity || '';
-                    data.version = msg.version || this.version;
-                    data.name = msg.name || this.name;
-                    data.files = msg.files || [];
-                    data.update = true;
+					data.org = msg.org || "";
+					data.integrity = msg.integrity || "";
+					data.version = msg.version || this.version;
+					data.name = msg.name || this.name;
+					data.files = msg.files || [];
+					data.update = true;
 
-                    return data;
-                } catch (error) {
-                    status = error.statusCode;
-                }
-            }
+					return data;
+				} catch (error) {
+					status = error.statusCode;
+				}
+			}
 
-            switch (status) {
-                case 400:
-                    throw new Error(
-                        'Client attempted to send an invalid URL parameter',
-                    );
-                case 401:
-                    throw new Error('Client unauthorized with server');
-                case 404:
-                    throw new Error(
-                        `The server was unable to locate ${pathname}. Ensure you have the correct package type (eik package-alias vs eik npm-alias), name and that the version exists on the server.`,
-                    );
-                case 409:
-                    throw new Error(
-                        `${this.type} with name "${this.name}" and version "${this.version}" already exists on server`,
-                    );
-                case 415:
-                    throw new Error(
-                        'Client attempted to send an unsupported file format to server',
-                    );
-                case 502:
-                    throw new Error(
-                        'Server was unable to write file to storage',
-                    );
-                default:
-                    throw new Error('Server failure');
-            }
-        }
-    }
+			switch (status) {
+				case 400:
+					throw new Error("Client attempted to send an invalid URL parameter");
+				case 401:
+					throw new Error("Client unauthorized with server");
+				case 404:
+					throw new Error(
+						`The server was unable to locate ${pathname}. Ensure you have the correct package type (eik package-alias vs eik npm-alias), name and that the version exists on the server.`,
+					);
+				case 409:
+					throw new Error(
+						`${this.type} with name "${this.name}" and version "${this.version}" already exists on server`,
+					);
+				case 415:
+					throw new Error(
+						"Client attempted to send an unsupported file format to server",
+					);
+				case 502:
+					throw new Error("Server was unable to write file to storage");
+				default:
+					throw new Error("Server failure");
+			}
+		}
+	}
 }

package/classes/index.js

@@ -1,68 +1,68 @@
-import Ping from './ping.js';
-import Alias from './alias.js';
-import Meta from './meta.js';
-import Login from './login.js';
-import PublishMap from './publish/map.js';
-import PublishPackage from './publish/package/index.js';
-import Integrity from './integrity.js';
-import Version from './version.js';
+import Ping from "./ping.js";
+import Alias from "./alias.js";
+import Meta from "./meta.js";
+import Login from "./login.js";
+import PublishMap from "./publish/map.js";
+import PublishPackage from "./publish/package/index.js";
+import Integrity from "./integrity.js";
+import Version from "./version.js";
 
 export default {
-    /**
-     * @param {import('./alias.js').AliasOptions} opts
-     */
-    alias(opts) {
-        return new Alias(opts).run();
-    },
+	/**
+	 * @param {import('./alias.js').AliasOptions} opts
+	 */
+	alias(opts) {
+		return new Alias(opts).run();
+	},
 
-    /**
-     * @param {import('./integrity.js').IntegrityOptions} opts
-     */
-    integrity(opts) {
-        return new Integrity(opts).run();
-    },
+	/**
+	 * @param {import('./integrity.js').IntegrityOptions} opts
+	 */
+	integrity(opts) {
+		return new Integrity(opts).run();
+	},
 
-    /**
-     * Log in using a key to get a Bearer token for use with other commands.
-     *
-     * @param {import('./login.js').LoginOptions} opts
-     */
-    login(opts) {
-        return new Login(opts).run();
-    },
+	/**
+	 * Log in using a key to get a Bearer token for use with other commands.
+	 *
+	 * @param {import('./login.js').LoginOptions} opts
+	 */
+	login(opts) {
+		return new Login(opts).run();
+	},
 
-    /**
-     * @param {import('./publish/map.js').PublishMapOptions} opts
-     */
-    map(opts) {
-        return new PublishMap(opts).run();
-    },
+	/**
+	 * @param {import('./publish/map.js').PublishMapOptions} opts
+	 */
+	map(opts) {
+		return new PublishMap(opts).run();
+	},
 
-    /**
-     * @param {import('./meta.js').MetaOptions} opts
-     */
-    meta(opts) {
-        return new Meta(opts).run();
-    },
+	/**
+	 * @param {import('./meta.js').MetaOptions} opts
+	 */
+	meta(opts) {
+		return new Meta(opts).run();
+	},
 
-    /**
-     * @param {import('./ping.js').PingOptions} opts
-     */
-    ping(opts) {
-        return new Ping(opts).run();
-    },
+	/**
+	 * @param {import('./ping.js').PingOptions} opts
+	 */
+	ping(opts) {
+		return new Ping(opts).run();
+	},
 
-    /**
-     * @param {import('./publish/package/index.js').PublishOptions} opts
-     */
-    publish(opts) {
-        return new PublishPackage(opts).run();
-    },
+	/**
+	 * @param {import('./publish/package/index.js').PublishOptions} opts
+	 */
+	publish(opts) {
+		return new PublishPackage(opts).run();
+	},
 
-    /**
-     * @param {import('./version.js').VersionOptions} opts
-     */
-    version(opts) {
-        return new Version(opts).run();
-    },
+	/**
+	 * @param {import('./version.js').VersionOptions} opts
+	 */
+	version(opts) {
+		return new Version(opts).run();
+	},
 };

package/classes/integrity.js

@@ -1,7 +1,7 @@
-import abslog from 'abslog';
-import eik from '@eik/common';
-import { typeSlug } from '../utils/index.js';
-import { joinUrlPathname } from '../utils/url.js';
+import abslog from "abslog";
+import eik from "@eik/common";
+import { typeSlug } from "../utils/index.js";
+import { joinUrlPathname } from "../utils/url.js";
 
 const { schemas } = eik;
 
@@ -17,97 +17,89 @@ const { schemas } = eik;
  */
 
 export default class Integrity {
-    /**
-     *
-     * @param {IntegrityOptions} options
-     */
-    constructor({
-        logger,
-        name,
-        version,
-        server,
-        type,
-        debug = false,
-        cwd = process.cwd(),
-    }) {
-        this.log = abslog(logger);
-        this.server = server;
-        this.name = name;
-        this.version = version;
-        this.debug = debug;
-        this.cwd = cwd;
-        this.type = type;
-    }
-
-    async run() {
-        this.log.debug('Validating input');
-
-        try {
-            this.log.debug(`  ==> server: ${this.server}`);
-            schemas.assert.server(this.server);
-
-            this.log.debug(`  ==> name: ${this.name}`);
-            schemas.assert.name(this.name);
-
-            this.log.debug(`  ==> version: ${this.version}`);
-            schemas.assert.version(this.version);
-
-            this.log.debug(`  ==> type: ${this.type}`);
-            schemas.assert.type(this.type || null);
-
-            this.log.debug(`  ==> debug: ${this.debug}`);
-            if (typeof this.debug !== 'boolean') {
-                // @ts-expect-error
-                throw new schemas.ValidationError(
-                    `Parameter "debug" is not valid`,
-                );
-            }
-
-            this.log.debug(`  ==> cwd: ${this.cwd}`);
-            if (typeof this.cwd !== 'string') {
-                // @ts-expect-error
-                throw new schemas.ValidationError(
-                    `Parameter "cwd" is not valid`,
-                );
-            }
-        } catch (err) {
-            throw new Error(
-                `Unable to validate input to command: ${err.message}`,
-            );
-        }
-
-        this.log.debug('Requesting meta information from asset server');
-        try {
-            const url = new URL(
-                joinUrlPathname(typeSlug(this.type), this.name, this.version),
-                this.server,
-            );
-            this.log.debug(`  ==> url: ${url}`);
-
-            const res = await fetch(url);
-
-            if (res.ok) {
-                this.log.debug(`  ==> ok: true`);
-                return await res.json();
-            }
-
-            this.log.debug(`  ==> ok: false`);
-
-            if (res.status === 400) {
-                throw new Error(
-                    'Client attempted to send an invalid URL parameter',
-                );
-            }
-
-            if (res.status === 401) {
-                throw new Error('Client unauthorized with server');
-            }
-
-            throw new Error('Server Error');
-        } catch (err) {
-            throw new Error(
-                `Unable to retrieve meta information for package: ${err.message}`,
-            );
-        }
-    }
+	/**
+	 *
+	 * @param {IntegrityOptions} options
+	 */
+	constructor({
+		logger,
+		name,
+		version,
+		server,
+		type,
+		debug = false,
+		cwd = process.cwd(),
+	}) {
+		this.log = abslog(logger);
+		this.server = server;
+		this.name = name;
+		this.version = version;
+		this.debug = debug;
+		this.cwd = cwd;
+		this.type = type;
+	}
+
+	async run() {
+		this.log.debug("Validating input");
+
+		try {
+			this.log.debug(`  ==> server: ${this.server}`);
+			schemas.assert.server(this.server);
+
+			this.log.debug(`  ==> name: ${this.name}`);
+			schemas.assert.name(this.name);
+
+			this.log.debug(`  ==> version: ${this.version}`);
+			schemas.assert.version(this.version);
+
+			this.log.debug(`  ==> type: ${this.type}`);
+			schemas.assert.type(this.type || null);
+
+			this.log.debug(`  ==> debug: ${this.debug}`);
+			if (typeof this.debug !== "boolean") {
+				// @ts-expect-error
+				throw new schemas.ValidationError(`Parameter "debug" is not valid`);
+			}
+
+			this.log.debug(`  ==> cwd: ${this.cwd}`);
+			if (typeof this.cwd !== "string") {
+				// @ts-expect-error
+				throw new schemas.ValidationError(`Parameter "cwd" is not valid`);
+			}
+		} catch (err) {
+			throw new Error(`Unable to validate input to command: ${err.message}`);
+		}
+
+		this.log.debug("Requesting meta information from asset server");
+		try {
+			const url = new URL(
+				joinUrlPathname(typeSlug(this.type), this.name, this.version),
+				this.server,
+			);
+			this.log.debug(`  ==> url: ${url}`);
+
+			const res = await fetch(url);
+
+			if (res.ok) {
+				this.log.debug(`  ==> ok: true`);
+				return await res.json();
+			}
+
+			this.log.debug(`  ==> ok: false`);
+
+			if (res.status === 400) {
+				throw new Error("Client attempted to send an invalid URL parameter");
+			}
+
+			if (res.status === 401) {
+				throw new Error("Client unauthorized with server");
+			}
+
+			throw new Error("Server Error");
+		} catch (err) {
+			throw new Error(
+				`Unable to retrieve meta information for package: ${err.message}`,
+			);
+		}
+	}
 }