@eik/cli 3.0.0-next.2 → 3.0.2

package/CHANGELOG.md

@@ -1,29 +1,165 @@
-# [3.0.0-next.2](https://github.com/eik-lib/cli/compare/v3.0.0-next.1...v3.0.0-next.2) (2022-08-17)
+## [3.0.2](https://github.com/eik-lib/cli/compare/v3.0.1...v3.0.2) (2024-08-14)
 
 
 ### Bug Fixes
 
-* incorrect version number displayed on alias when updating with a cache layer infront ([8c468d6](https://github.com/eik-lib/cli/commit/8c468d670f6f10f25ae4decdab7a6950a1093d6a))
+* include semantic release plugins from common package ([ac9e5a1](https://github.com/eik-lib/cli/commit/ac9e5a1ebd7dfda2ab77625f2c8c8c5dee5f8c31))
 
+# [3.0.0](https://github.com/eik-lib/cli/compare/v2.0.39...v3.0.0) (2024-08-12)
 
-### Features
 
-* **!:** new alias command for all types of packages ([e482880](https://github.com/eik-lib/cli/commit/e48288002e9e8942f71d8f8dd0583395152aff49))
+### Bug Fixes
 
+* include type definitions for programatic API ([96d6079](https://github.com/eik-lib/cli/commit/96d6079145198f5df3cd353952e9bac4d530031d))
+* add jsdoc for publish commands as well ([a2b51c8](https://github.com/eik-lib/cli/commit/a2b51c86fe10ab84aa21e07151007fdc723e36c4))
+* update boxen, chalk and ora ([73a200f](https://github.com/eik-lib/cli/commit/73a200f20a59edc69abc5fb3d8760fbf2630b0c1))
+* update date-fns ([0b32270](https://github.com/eik-lib/cli/commit/0b322700cd62e73052eef42016658931c27202c2))
+* update Eik common to v4.0.0 ([1078484](https://github.com/eik-lib/cli/commit/107848440a11eac4cc5b49a33fb172bffe43e1d9))
+* update gzip-size ([6075766](https://github.com/eik-lib/cli/commit/6075766b9a3c60f91b7d64374e9396b87fb9294c))
+* update make-dir ([8d9c939](https://github.com/eik-lib/cli/commit/8d9c939449e0adfd8bed33d517f8e219d6790a74))
+* update rimraf ([3e40b11](https://github.com/eik-lib/cli/commit/3e40b11b527c722f4ecf51872f0b09d82eef034b))
+* update ssri package ([944426a](https://github.com/eik-lib/cli/commit/944426add01481af20232410b3d86fc983b73da8))
+* update tar package ([41c8227](https://github.com/eik-lib/cli/commit/41c8227578b166682c00c6dd841bcb972f475433))
+* update to Eik common v4.0.1 ([fb69c35](https://github.com/eik-lib/cli/commit/fb69c35c085266571d2352a60ebe9c9783e21d46))
 
-### BREAKING CHANGES
 
-* **!:** New alias command that is to be used for creating package, npm and import map aliases. Old alias commands have been removed.
+### chore
 
-# [3.0.0-next.1](https://github.com/eik-lib/cli/compare/v2.0.22...v3.0.0-next.1) (2022-08-17)
+* convert codebase to ESM ([f3c4c74](https://github.com/eik-lib/cli/commit/f3c4c746cc3ac283d0f8e493682af34086831f51))
 
 
-* feat(publish)!: include map publishing in "publish" command ([7968274](https://github.com/eik-lib/cli/commit/796827442b28bb9852af63137275535fae737c21))
+### Features
 
+* add `eik alias` command as an eventual replacement for the 3 existing alias commands ([ff4a27c](https://github.com/eik-lib/cli/commit/ff4a27cc8e46f55321a6c814d23a111737eba29d))
+* add `eik --version` and `eik -v` to list eik cli version ([5ddd162](https://github.com/eik-lib/cli/commit/5ddd16245a3285d9ebd002aa35d96557d50c2bd5))
+* init reads name and version from `package.json` ([6effb76](https://github.com/eik-lib/cli/commit/6effb768a7c2ec5110d935201960d9d872abff48))
+* support specifying a config file using `--config` or `-c` cli flags ([a78b9de](https://github.com/eik-lib/cli/commit/a78b9de9f8f8e7e64bcdf24e649e0c27ea6eec1f))
 
 ### BREAKING CHANGES
 
-* the map command has been removed in favour of a single publish command
+* remove `eik v` alias ([80ac9b6](https://github.com/eik-lib/cli/commit/80ac9b62a2cc7d53fd4e5dbbbd983efc490214bd))
+* JavaScript API is now ESM only and no longer supports CJS
+
+
+## [2.0.39](https://github.com/eik-lib/cli/compare/v2.0.38...v2.0.39) (2024-07-29)
+
+
+### Bug Fixes
+
+* **deps:** update dependency semver to v7.6.3 ([7c6f254](https://github.com/eik-lib/cli/commit/7c6f254e6ff37529d250dcc8dcbedac719dd5cff))
+
+## [2.0.38](https://github.com/eik-lib/cli/compare/v2.0.37...v2.0.38) (2024-05-13)
+
+
+### Bug Fixes
+
+* include message from base error for unexpected status codes ([#549](https://github.com/eik-lib/cli/issues/549)) ([d5637df](https://github.com/eik-lib/cli/commit/d5637dff5acca4bc8f2cc91799c9c96555e9bf1b))
+
+## [2.0.37](https://github.com/eik-lib/cli/compare/v2.0.36...v2.0.37) (2024-05-06)
+
+
+### Bug Fixes
+
+* **deps:** update dependency abslog to v2.4.4 ([e05835c](https://github.com/eik-lib/cli/commit/e05835c9b934ff8bf91b2092083b9da2ef9d2994))
+
+## [2.0.36](https://github.com/eik-lib/cli/compare/v2.0.35...v2.0.36) (2024-04-29)
+
+
+### Bug Fixes
+
+* **deps:** update dependency abslog to v2.4.2 ([429a659](https://github.com/eik-lib/cli/commit/429a659ece9e50ddd766ac9bceb3fdf98e01060c))
+
+## [2.0.35](https://github.com/eik-lib/cli/compare/v2.0.34...v2.0.35) (2024-04-23)
+
+
+### Bug Fixes
+
+* update dependencies ([f269dfe](https://github.com/eik-lib/cli/commit/f269dfec6bf6321287b137c309e6f09430c7d3bb))
+
+## [2.0.34](https://github.com/eik-lib/cli/compare/v2.0.33...v2.0.34) (2024-04-11)
+
+
+### Bug Fixes
+
+* **deps:** update dependency tar to v6.2.1 [security] ([3fef73f](https://github.com/eik-lib/cli/commit/3fef73f7be1ea32339fc5a632e3840899d096b78))
+
+## [2.0.33](https://github.com/eik-lib/cli/compare/v2.0.32...v2.0.33) (2024-02-12)
+
+
+### Bug Fixes
+
+* **deps:** update dependency semver to v7.6.0 ([ca54c17](https://github.com/eik-lib/cli/commit/ca54c174f54e0a321090a7bf0c7256555f4fe2c4))
+
+## [2.0.32](https://github.com/eik-lib/cli/compare/v2.0.31...v2.0.32) (2024-02-05)
+
+
+### Bug Fixes
+
+* **deps:** update dependency yargs to v17.7.2 ([d283d0e](https://github.com/eik-lib/cli/commit/d283d0e0a28036f2c012a498ea8a62e40bd3a6a8))
+
+## [2.0.31](https://github.com/eik-lib/cli/compare/v2.0.30...v2.0.31) (2024-02-05)
+
+
+### Bug Fixes
+
+* **deps:** update dependency tar to v6.2.0 ([f1b98e4](https://github.com/eik-lib/cli/commit/f1b98e40035749b6d9a6e39906b99ed7e8e571d5))
+
+## [2.0.30](https://github.com/eik-lib/cli/compare/v2.0.29...v2.0.30) (2024-02-05)
+
+
+### Bug Fixes
+
+* **deps:** update dependency node-fetch to v2.7.0 ([cb4f52d](https://github.com/eik-lib/cli/commit/cb4f52dc003d507ba66447e77a15f621d43dcaf0))
+
+## [2.0.29](https://github.com/eik-lib/cli/compare/v2.0.28...v2.0.29) (2024-01-29)
+
+
+### Bug Fixes
+
+* **deps:** update dependency date-fns to v2.30.0 ([2411b57](https://github.com/eik-lib/cli/commit/2411b574dd776aef52f58e6d3fda91d684b68d9b))
+
+## [2.0.28](https://github.com/eik-lib/cli/compare/v2.0.27...v2.0.28) (2024-01-29)
+
+
+### Bug Fixes
+
+* **deps:** replace dependency read-pkg-up with read-package-up ([480c0cd](https://github.com/eik-lib/cli/commit/480c0cd06eab6293c6fd7cf3092b03096fb06d3f))
+
+## [2.0.27](https://github.com/eik-lib/cli/compare/v2.0.26...v2.0.27) (2024-01-22)
+
+
+### Bug Fixes
+
+* **deps:** update dependency semver to v7.5.4 ([71b807a](https://github.com/eik-lib/cli/commit/71b807aa80961aa6d3257963323c36938d611bfd))
+
+## [2.0.26](https://github.com/eik-lib/cli/compare/v2.0.25...v2.0.26) (2024-01-22)
+
+
+### Bug Fixes
+
+* **deps:** update dependency glob to v7.2.3 ([6e2df77](https://github.com/eik-lib/cli/commit/6e2df7700d72f10a5cc252a968ba70f5ee6fc131))
+
+## [2.0.25](https://github.com/eik-lib/cli/compare/v2.0.24...v2.0.25) (2024-01-20)
+
+
+### Bug Fixes
+
+* **deps:** update dependency yargs-parser to v21.1.1 ([1c9810a](https://github.com/eik-lib/cli/commit/1c9810a3f4fd614420826a40e1abe0d362e1067a))
+
+## [2.0.24](https://github.com/eik-lib/cli/compare/v2.0.23...v2.0.24) (2024-01-19)
+
+
+### Bug Fixes
+
+* **deps:** update dependency semver to v7.5.2 [security] ([cfbd1fa](https://github.com/eik-lib/cli/commit/cfbd1fa2d8b9996a41b7acdec6b9b3d274ff25bf))
+
+## [2.0.23](https://github.com/eik-lib/cli/compare/v2.0.22...v2.0.23) (2024-01-19)
+
+
+### Bug Fixes
+
+* log a more helpful 404 ([763ffda](https://github.com/eik-lib/cli/commit/763ffda93b5247acc7af328094ecd634d1b25b51))
+* print which server you're logging into ([6ec8333](https://github.com/eik-lib/cli/commit/6ec8333eb8bc6c9b535aeb55d1f2226e093286b5))
 
 ## [2.0.22](https://github.com/eik-lib/cli/compare/v2.0.21...v2.0.22) (2022-01-28)
 

package/classes/alias.js

@@ -1,17 +1,39 @@
-'use strict';
+import assert from 'assert';
+import abslog from 'abslog';
+import { join } from 'path';
+import { schemas, validators } from '@eik/common';
+import { request } from '../utils/http/index.js';
+import { typeSlug } from '../utils/index.js';
 
-const assert = require('assert');
-const abslog = require('abslog');
-const { join } = require('path');
+/**
+ * @typedef {object} AliasOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} server
+ * @property {"package" | "npm" | "map"} [type="package"]
+ * @property {string} name
+ * @property {string} version
+ * @property {string} alias
+ * @property {string} token
+ */
 
-const validators = require('@eik/common-validators');
-const schemas = require('@eik/common-schemas');
+/**
+ * @typedef {object} AliasResult
+ * @property {string} server
+ * @property {string} type
+ * @property {string} name
+ * @property {string} alias
+ * @property {string} version
+ * @property {boolean} update
+ * @property {string[]} files
+ * @property {string} org
+ * @property {string} integrity
+ */
 
-const { typeSlug } = require('@eik/common-utils');
-const { request } = require('../utils/http');
-
-module.exports = class Alias {
-    constructor({ logger, server, token, type, name, version, alias } = {}) {
+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;
@@ -21,6 +43,9 @@ module.exports = class Alias {
         this.version = version;
     }
 
+    /**
+     * @returns {Promise<AliasResult>}
+     */
     async run() {
         const data = {
             server: this.server,
@@ -46,22 +71,22 @@ module.exports = class Alias {
         );
 
         this.log.debug(
-            `Requesting creation of ${this.type} alias "v${this.alias}" for ${this.name} v${this.version}`,
+            `Requesting creation of ${this.type} alias "v${this.alias}" for ${this.name} v${this.version} on ${this.server}`,
         );
+
+        const pathname = join(this.type, this.name, `v${this.alias}`);
         try {
             const { message } = await request({
                 host: this.server,
                 method: 'PUT',
-                pathname: join(this.type, this.name, `v${this.alias}`),
+                pathname,
                 data: { version: this.version },
                 token: this.token,
             });
 
             data.org = message.org || '';
             data.integrity = message.integrity || '';
-            // We'll use message.version when the cache has been properly purged
-            // data.version = message.version || this.version;
-            data.version = this.version;
+            data.version = message.version || this.version;
             data.name = message.name || this.name;
             data.files = message.files || [];
 
@@ -70,20 +95,22 @@ module.exports = class Alias {
             let status = err.statusCode;
 
             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: join(this.type, this.name, `v${this.alias}`),
+                        pathname,
                         data: { version: this.version },
                         token: this.token,
                     });
 
                     data.org = msg.org || '';
                     data.integrity = msg.integrity || '';
-                    // We'll use msg.version when the cache has been properly purged
-                    // data.version = msg.version || this.version;
-                    data.version = this.version;
+                    data.version = msg.version || this.version;
                     data.name = msg.name || this.name;
                     data.files = msg.files || [];
                     data.update = true;
@@ -103,7 +130,7 @@ module.exports = class Alias {
                     throw new Error('Client unauthorized with server');
                 case 404:
                     throw new Error(
-                        'The server was unable to locate the required resource',
+                        `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(
@@ -122,4 +149,4 @@ module.exports = class Alias {
             }
         }
     }
-};
+}

package/classes/index.js

@@ -1,44 +1,68 @@
-'use strict';
-
-const Ping = require('./ping');
-const Alias = require('./alias');
-const Meta = require('./meta');
-const Login = require('./login');
-const PublishMap = require('./publish/map');
-const PublishPackage = require('./publish/package/index');
-const Integrity = require('./integrity');
-const Version = require('./version');
-
-module.exports = {
-    ping(opts) {
-        return new Ping(opts).run();
-    },
+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();
     },
 
-    meta(opts) {
-        return new Meta(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();
     },
 
-    integrity(opts) {
-        return new Integrity(opts).run();
+    /**
+     * @param {import('./publish/map.js').PublishMapOptions} opts
+     */
+    map(opts) {
+        return new PublishMap(opts).run();
     },
 
-    version(opts) {
-        return new Version(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('./publish/package/index.js').PublishOptions} opts
+     */
     publish(opts) {
         return new PublishPackage(opts).run();
     },
 
-    map(opts) {
-        return new PublishMap(opts).run();
+    /**
+     * @param {import('./version.js').VersionOptions} opts
+     */
+    version(opts) {
+        return new Version(opts).run();
     },
 };

package/classes/integrity.js

@@ -1,17 +1,26 @@
-/* eslint-disable no-await-in-loop */
-/* eslint-disable no-plusplus */
-
-'use strict';
-
-const abslog = require('abslog');
-const { join } = require('path');
-
-const schemas = require('@eik/common-schemas');
-
-const { typeSlug } = require('@eik/common-utils');
-const fetch = require('node-fetch');
-
-module.exports = class Integrity {
+import abslog from 'abslog';
+import { join } from 'path';
+import eik from '@eik/common';
+import { typeSlug } from '../utils/index.js';
+
+const { schemas } = eik;
+
+/**
+ * @typedef {object} IntegrityOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} server
+ * @property {"package" | "npm" | "map"} [type="package"]
+ * @property {string} name
+ * @property {string} version
+ * @property {string} [cwd]
+ * @property {boolean} [debug]
+ */
+
+export default class Integrity {
+    /**
+     *
+     * @param {IntegrityOptions} options
+     */
     constructor({
         logger,
         name,
@@ -20,7 +29,7 @@ module.exports = class Integrity {
         type,
         debug = false,
         cwd = process.cwd(),
-    } = {}) {
+    }) {
         this.log = abslog(logger);
         this.server = server;
         this.name = name;
@@ -48,6 +57,7 @@ module.exports = class Integrity {
 
             this.log.debug(`  ==> debug: ${this.debug}`);
             if (typeof this.debug !== 'boolean') {
+                // @ts-expect-error
                 throw new schemas.ValidationError(
                     `Parameter "debug" is not valid`,
                 );
@@ -55,6 +65,7 @@ module.exports = class Integrity {
 
             this.log.debug(`  ==> cwd: ${this.cwd}`);
             if (typeof this.cwd !== 'string') {
+                // @ts-expect-error
                 throw new schemas.ValidationError(
                     `Parameter "cwd" is not valid`,
                 );
@@ -99,4 +110,4 @@ module.exports = class Integrity {
             );
         }
     }
-};
+}

package/classes/login.js

@@ -1,22 +1,36 @@
-'use strict';
+import abslog from 'abslog';
+import eik from '@eik/common';
+import { request } from '../utils/http/index.js';
 
-const abslog = require('abslog');
-const schemas = require('@eik/common-schemas');
-const { request } = require('../utils/http');
+const { schemas } = eik;
 
-module.exports = class Login {
-    constructor({ logger, server, key } = {}) {
+/**
+ * @typedef {object} LoginOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} server
+ * @property {string} key
+ */
+
+export default class Login {
+    /**
+     * @param {LoginOptions} options
+     */
+    constructor({ logger, server, key }) {
         this.log = abslog(logger);
         this.server = server;
         this.key = key;
     }
 
+    /**
+     * @returns {Promise<string | false>} Bearer token, or false if login fails
+     */
     async run() {
         this.log.debug('Validating input');
 
         try {
             schemas.assert.server(this.server);
             if (!this.key || typeof !this.key === 'string') {
+                // @ts-expect-error
                 throw new schemas.ValidationError('"key" must be a string');
             }
         } catch (err) {
@@ -46,4 +60,4 @@ module.exports = class Login {
             }
         }
     }
-};
+}

package/classes/meta.js

@@ -1,23 +1,31 @@
-/* eslint-disable no-await-in-loop */
-/* eslint-disable no-plusplus */
-
-'use strict';
-
-const abslog = require('abslog');
-const { join } = require('path');
-const schemas = require('@eik/common-schemas');
-const fetch = require('node-fetch');
+import abslog from 'abslog';
+import { join } from 'path';
+import { schemas } from '@eik/common';
 
 const types = ['pkg', 'map', 'npm'];
 
-module.exports = class Meta {
-    constructor({ logger, server, name, version } = {}) {
+/**
+ * @typedef {object} MetaOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} server
+ * @property {string} name
+ * @property {string} version
+ */
+
+export default class Meta {
+    /**
+     * @param {MetaOptions} options
+     */
+    constructor({ logger, server, name, version }) {
         this.log = abslog(logger);
         this.server = server;
         this.name = name;
         this.version = version;
     }
 
+    /**
+     * @returns {Promise<unknown | false>}
+     */
     async run() {
         this.log.debug('Validating input');
 
@@ -90,4 +98,4 @@ module.exports = class Meta {
             return false;
         }
     }
-};
+}

package/classes/ping.js

@@ -1,15 +1,25 @@
-'use strict';
-
-const fetch = require('node-fetch');
-const abslog = require('abslog');
-const schemas = require('@eik/common-schemas');
-
-module.exports = class Ping {
+import abslog from 'abslog';
+import { schemas } from '@eik/common';
+
+/**
+ * @typedef {object} PingOptions
+ * @property {string} [server]
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ */
+
+export default class Ping {
+    /**
+     * @param {PingOptions} options
+     */
     constructor({ logger, server } = {}) {
         this.log = abslog(logger);
         this.server = server;
     }
 
+    /**
+     * Run the ping command
+     * @returns {Promise<boolean>}
+     */
     async run() {
         this.log.debug('Validating input');
 
@@ -22,10 +32,11 @@ module.exports = class Ping {
 
         this.log.debug('Requesting ping from server');
         try {
-            const result = await fetch(this.server);
+            const result = await fetch(/** @type {string}*/ (this.server));
 
             if (!result.ok) {
                 const err = new Error('Ping unsuccessful');
+                // @ts-expect-error
                 err.statusCode = result.status;
                 throw err;
             }
@@ -48,4 +59,4 @@ module.exports = class Ping {
             }
         }
     }
-};
+}