@eik/cli 2.0.22 → 3.0.0-next.1

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [3.0.0-next.1](https://github.com/eik-lib/cli/compare/v2.0.22...v3.0.0-next.1) (2022-08-17)
+
+
+* feat(publish)!: include map publishing in "publish" command ([7968274](https://github.com/eik-lib/cli/commit/796827442b28bb9852af63137275535fae737c21))
+
+
+### BREAKING CHANGES
+
+* the map command has been removed in favour of a single publish command
+
 ## [2.0.22](https://github.com/eik-lib/cli/compare/v2.0.21...v2.0.22) (2022-01-28)
 
 

package/classes/alias.js

@@ -3,9 +3,12 @@
 const assert = require('assert');
 const abslog = require('abslog');
 const { join } = require('path');
-const { schemas, validators } = require('@eik/common');
+
+const validators = require('@eik/common-validators');
+const schemas = require('@eik/common-schemas');
+
+const { typeSlug } = require('@eik/common-utils');
 const { request } = require('../utils/http');
-const { typeSlug } = require('../utils');
 
 module.exports = class Alias {
     constructor({ logger, server, token, type, name, version, alias } = {}) {

package/classes/integrity.js

@@ -5,9 +5,11 @@
 
 const abslog = require('abslog');
 const { join } = require('path');
-const { schemas, ValidationError } = require('@eik/common');
+
+const schemas = require('@eik/common-schemas');
+
+const { typeSlug } = require('@eik/common-utils');
 const fetch = require('node-fetch');
-const { typeSlug } = require('../utils');
 
 module.exports = class Integrity {
     constructor({
@@ -46,12 +48,16 @@ module.exports = class Integrity {
 
             this.log.debug(`  ==> debug: ${this.debug}`);
             if (typeof this.debug !== 'boolean') {
-                throw new ValidationError(`Parameter "debug" is not valid`);
+                throw new schemas.ValidationError(
+                    `Parameter "debug" is not valid`,
+                );
             }
 
             this.log.debug(`  ==> cwd: ${this.cwd}`);
             if (typeof this.cwd !== 'string') {
-                throw new ValidationError(`Parameter "cwd" is not valid`);
+                throw new schemas.ValidationError(
+                    `Parameter "cwd" is not valid`,
+                );
             }
         } catch (err) {
             throw new Error(

package/classes/login.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const abslog = require('abslog');
-const { schemas, ValidationError } = require('@eik/common');
+const schemas = require('@eik/common-schemas');
 const { request } = require('../utils/http');
 
 module.exports = class Login {
@@ -17,7 +17,7 @@ module.exports = class Login {
         try {
             schemas.assert.server(this.server);
             if (!this.key || typeof !this.key === 'string') {
-                throw new ValidationError('"key" must be a string');
+                throw new schemas.ValidationError('"key" must be a string');
             }
         } catch (err) {
             this.log.error(err.message);

package/classes/meta.js

@@ -5,7 +5,7 @@
 
 const abslog = require('abslog');
 const { join } = require('path');
-const { schemas } = require('@eik/common');
+const schemas = require('@eik/common-schemas');
 const fetch = require('node-fetch');
 
 const types = ['pkg', 'map', 'npm'];

package/classes/ping.js

@@ -2,7 +2,7 @@
 
 const fetch = require('node-fetch');
 const abslog = require('abslog');
-const { schemas } = require('@eik/common');
+const schemas = require('@eik/common-schemas');
 
 module.exports = class Ping {
     constructor({ logger, server } = {}) {

package/classes/publish/map.js

@@ -4,7 +4,7 @@ const assert = require('assert');
 const abslog = require('abslog');
 const { join, parse, isAbsolute } = require('path');
 const { existsSync } = require('fs');
-const { schemas } = require('@eik/common');
+const schemas = require('@eik/common-schemas');
 const { request } = require('../../utils/http');
 
 module.exports = class PublishMap {

package/classes/publish/package/index.js

@@ -2,8 +2,8 @@
 
 const abslog = require('abslog');
 const { join, isAbsolute } = require('path');
-const { EikConfig } = require('@eik/common');
-const { typeSlug } = require('../../../utils');
+const { EikConfig } = require('@eik/common-config-loader');
+const { typeSlug } = require('@eik/common-utils');
 const ValidateInput = require('./tasks/validate-input');
 const CreateTempDirectory = require('./tasks/create-temp-directory');
 const CreateZipFile = require('./tasks/create-zip-file');

package/classes/publish/package/tasks/check-if-already-published.js

@@ -3,9 +3,9 @@
 'use strict';
 
 const { join } = require('path');
+const { typeSlug } = require('@eik/common-utils');
 const { integrity, versions } = require('../../../../utils/http');
 const hash = require('../../../../utils/hash');
-const { typeSlug } = require('../../../../utils');
 const Task = require('./task');
 
 module.exports = class CheckIfAlreadyPublished extends Task {

package/classes/publish/package/tasks/upload-files.js

@@ -3,8 +3,8 @@
 'use strict';
 
 const { join } = require('path');
+const { typeSlug } = require('@eik/common-utils');
 const { request } = require('../../../../utils/http');
-const { typeSlug } = require('../../../../utils');
 const Task = require('./task');
 
 module.exports = class UploadFiles extends Task {
@@ -30,6 +30,7 @@ module.exports = class UploadFiles extends Task {
             return message;
         } catch (err) {
             log.error('Unable to upload zip file to server');
+
             switch (err.statusCode) {
                 case 400:
                     throw new Error(
@@ -52,7 +53,9 @@ module.exports = class UploadFiles extends Task {
                         'Server was unable to write file to storage',
                     );
                 default:
-                    throw new Error('Server failed');
+                    throw new Error(
+                        `Upload to server failed, server responded with: ${err.message}`,
+                    );
             }
         }
     }

package/classes/version.js

@@ -7,10 +7,13 @@ const { join, isAbsolute, parse } = require('path');
 const abslog = require('abslog');
 const semver = require('semver');
 const mkdir = require('make-dir');
-const { schemas, EikConfig } = require('@eik/common');
+
+const { EikConfig } = require('@eik/common-config-loader');
+const schemas = require('@eik/common-schemas');
+
+const { typeSlug } = require('@eik/common-utils');
 const { integrity } = require('../utils/http');
 const hash = require('../utils/hash');
-const { typeSlug } = require('../utils');
 
 module.exports = class Version {
     constructor({

package/commands/integrity.js

@@ -6,11 +6,9 @@
 
 const { join } = require('path');
 const ora = require('ora');
-const {
-    helpers: { configStore },
-} = require('@eik/common');
+const { configStore, getDefaults } = require('@eik/common-config-loader');
 const Integrity = require('../classes/integrity');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 const json = require('../utils/json');
 
 exports.command = 'integrity [name] [version]';

package/commands/login.js

@@ -1,10 +1,11 @@
 'use strict';
 
 const homedir = require('os').homedir();
+const { getDefaults } = require('@eik/common-config-loader');
 const readline = require('readline');
 const ora = require('ora');
 const Login = require('../classes/login');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 const json = require('../utils/json');
 
 exports.command = 'login';

package/commands/map-alias.js

@@ -1,8 +1,9 @@
 'use strict';
 
 const ora = require('ora');
+const { getDefaults } = require('@eik/common-config-loader');
 const Alias = require('../classes/alias');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 const { Alias: AliasFormatter } = require('../formatters');
 
 exports.command = 'map-alias <name> <version> <alias>';

package/commands/meta.js

@@ -5,9 +5,10 @@
 'use strict';
 
 const ora = require('ora');
+const { getDefaults } = require('@eik/common-config-loader');
 const Meta = require('../classes/meta');
 const { Artifact } = require('../formatters');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 
 exports.command = 'meta <name>';
 

package/commands/npm-alias.js

@@ -1,8 +1,9 @@
 'use strict';
 
 const ora = require('ora');
+const { getDefaults } = require('@eik/common-config-loader');
 const Alias = require('../classes/alias');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 const { Alias: AliasFormatter } = require('../formatters');
 
 exports.command = 'npm-alias <name> <version> <alias>';

package/commands/package-alias.js

@@ -2,8 +2,9 @@
 
 const ora = require('ora');
 const semver = require('semver');
+const { getDefaults } = require('@eik/common-config-loader');
 const Alias = require('../classes/alias');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 const { Alias: AliasFormatter } = require('../formatters');
 
 exports.command = 'package-alias [name] [version] [alias]';

package/commands/ping.js

@@ -1,8 +1,9 @@
 'use strict';
 
 const ora = require('ora');
+const { getDefaults } = require('@eik/common-config-loader');
 const Ping = require('../classes/ping');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 
 exports.command = 'ping [server]';
 

package/commands/publish.js

@@ -4,24 +4,20 @@ const { join } = require('path');
 const fetch = require('node-fetch');
 const ora = require('ora');
 const chalk = require('chalk');
-const {
-    helpers: { configStore },
-} = require('@eik/common');
+const { configStore, getDefaults } = require('@eik/common-config-loader');
+const { typeSlug, typeTitle } = require('@eik/common-utils');
+
 const PublishPackage = require('../classes/publish/package/index');
-const {
-    logger,
-    getDefaults,
-    getCWD,
-    typeSlug,
-    typeTitle,
-} = require('../utils');
+const { logger, getCWD } = require('../utils');
+
 const { Artifact } = require('../formatters');
+const PublishMap = require('../classes/publish/map');
 
 exports.command = 'publish';
 
 exports.aliases = ['pkg', 'package', 'pub'];
 
-exports.describe = `Publish an app package to an Eik server. Reads configuration from eik.json or package.json files. See https://eik.dev for more details.`;
+exports.describe = `Publish files to an Eik server. Reads configuration from eik.json or package.json files. See https://eik.dev for more details.`;
 
 exports.builder = (yargs) => {
     const cwd = getCWD();
@@ -52,6 +48,18 @@ exports.builder = (yargs) => {
             type: 'string',
             alias: 't',
         },
+        type: {
+            describe:
+                'Optional flag to define the type of asset you wish to publish. This can be "package", "map" or "npm". Default reads from eik configuration "type" field.',
+            default: '',
+            type: 'string',
+        },
+        file: {
+            describe:
+                'Path to import map file on local disk relative to the current working directory. Default reads the "files" in the eik config.',
+            type: 'string',
+            normalize: true,
+        },
     });
 
     yargs.default('token', defaults.token, defaults.token ? '######' : '');
@@ -65,87 +73,113 @@ exports.builder = (yargs) => {
 
 exports.handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
-    const { debug, dryRun, cwd, token } = argv;
+    const { debug, dryRun, cwd, token, type: typeFromArgs } = argv;
     const config = configStore.findInDirectory(cwd);
     const { name, server, version, type, map, out, files } = config;
 
-    if (type === 'map') {
-        spinner.warn(
-            '"type" is set to "map", which is not supported by the publish command. Please use the "eik map" command instead',
-        );
-        process.stdout.write('\n');
-        process.exit(0);
-    }
+    const typeOverride = typeFromArgs || type;
 
     try {
-        const options = {
-            logger: logger(spinner, debug),
-            cwd,
-            token,
-            dryRun,
-            debug,
-            name,
-            server,
-            version,
-            type,
-            map,
-            out,
-            files,
-        };
-
-        const publish = await new PublishPackage(options).run();
-
-        if (!publish) {
-            spinner.warn(
-                'Version in eik.json has not changed since last publish, publishing is not necessary',
-            );
-            process.stdout.write('\n');
-            process.exit(0);
-        }
+        if (['package', 'npm'].includes(typeOverride)) {
+            const options = {
+                logger: logger(spinner, debug),
+                cwd,
+                token,
+                dryRun,
+                debug,
+                name,
+                server,
+                version,
+                type,
+                map,
+                out,
+                files,
+            };
+
+            const publish = await new PublishPackage(options).run();
+
+            if (!publish) {
+                spinner.warn(
+                    'Version in eik.json has not changed since last publish, publishing is not necessary',
+                );
+                process.stdout.write('\n');
+                process.exit(0);
+            }
+
+            const { files: fls } = publish;
+
+            if (!dryRun) {
+                let url = new URL(join(typeSlug(type), name), server);
+                let res = await fetch(url);
+                const pkgMeta = await res.json();
+
+                url = new URL(join(typeSlug(type), name, version), server);
+                res = await fetch(url);
+                const pkgVersionMeta = await res.json();
+
+                const artifact = new Artifact(pkgMeta);
+                artifact.versions = [pkgVersionMeta];
 
-        const { files: fls } = publish;
+                spinner.text = '';
+                spinner.stopAndPersist();
 
-        if (!dryRun) {
-            let url = new URL(join(typeSlug(type), name), server);
+                artifact.format(server);
+                process.stdout.write('\n');
+            } else {
+                spinner.text = '';
+                spinner.stopAndPersist();
+
+                process.stdout.write(
+                    `:: ${chalk.bgYellow.white.bold(
+                        typeTitle(type),
+                    )} > ${chalk.green(name)} | ${chalk.bold('dry run')}`,
+                );
+                process.stdout.write('\n\n');
+                process.stdout.write('   files (local temporary):\n');
+                for (const file of fls) {
+                    process.stdout.write(
+                        `   - ${chalk.bold('type')}: ${file.type}\n`,
+                    );
+                    process.stdout.write(
+                        `     ${chalk.bold('path')}: ${file.pathname}\n\n`,
+                    );
+                }
+                process.stdout.write(
+                    `   ${chalk.bold(
+                        'No files were published to remote server',
+                    )}\n\n`,
+                );
+            }
+        } else if (typeOverride === 'map') {
+            const log = logger(spinner, debug);
+
+            await new PublishMap({
+                logger: log,
+                name,
+                version,
+                server,
+                file: files,
+                ...argv,
+            }).run();
+
+            let url = new URL(join('map', name), server);
             let res = await fetch(url);
             const pkgMeta = await res.json();
 
-            url = new URL(join(typeSlug(type), name, version), server);
+            url = new URL(join('map', name, version), server);
             res = await fetch(url);
-            const pkgVersionMeta = await res.json();
 
-            const artifact = new Artifact(pkgMeta);
-            artifact.versions = [pkgVersionMeta];
+            log.info(`Published import map "${name}" at version "${version}"`);
 
             spinner.text = '';
             spinner.stopAndPersist();
 
+            const artifact = new Artifact(pkgMeta);
+            const versions = new Map(pkgMeta.versions);
+            artifact.versions = Array.from(versions.values());
             artifact.format(server);
-            process.stdout.write('\n');
-        } else {
-            spinner.text = '';
-            spinner.stopAndPersist();
 
-            process.stdout.write(
-                `:: ${chalk.bgYellow.white.bold(
-                    typeTitle(type),
-                )} > ${chalk.green(name)} | ${chalk.bold('dry run')}`,
-            );
-            process.stdout.write('\n\n');
-            process.stdout.write('   files (local temporary):\n');
-            for (const file of fls) {
-                process.stdout.write(
-                    `   - ${chalk.bold('type')}: ${file.type}\n`,
-                );
-                process.stdout.write(
-                    `     ${chalk.bold('path')}: ${file.pathname}\n\n`,
-                );
-            }
-            process.stdout.write(
-                `   ${chalk.bold(
-                    'No files were published to remote server',
-                )}\n\n`,
-            );
+            process.stdout.write('\n');
         }
     } catch (err) {
         spinner.warn(err.message);

package/commands/version.js

@@ -3,11 +3,9 @@
 const { execSync } = require('child_process');
 const { join } = require('path');
 const ora = require('ora');
-const {
-    helpers: { configStore },
-} = require('@eik/common');
+const { configStore, getDefaults } = require('@eik/common-config-loader');
 const VersionPackage = require('../classes/version');
-const { logger, getDefaults, getCWD } = require('../utils');
+const { logger, getCWD } = require('../utils');
 const json = require('../utils/json');
 
 exports.command = 'version [level]';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/cli",
-  "version": "2.0.22",
+  "version": "3.0.0-next.1",
   "description": "Cli tool for publishing assets",
   "main": "./classes/index.js",
   "bin": {
@@ -32,7 +32,10 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@eik/common": "^3.0.0",
+    "@eik/common-config-loader": "^4.0.0-next.8",
+    "@eik/common-schemas": "^4.0.0-next.8",
+    "@eik/common-utils": "^4.0.0-next.8",
+    "@eik/common-validators": "^4.0.0-next.8",
     "abslog": "2.4.0",
     "boxen": "5.1.2",
     "bytes": "3.1.2",
@@ -60,7 +63,7 @@
     "@eik/service": "1.2.98",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/git": "10.0.1",
-    "eslint": "8.7.0",
+    "eslint": "8.8.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.25.4",
@@ -69,11 +72,11 @@
     "fastify-cors": "6.0.2",
     "fs-extra": "10.0.0",
     "prettier": "2.5.1",
-    "puppeteer": "13.1.1",
+    "puppeteer": "13.1.2",
     "react": "17.0.2",
     "react-dom": "17.0.2",
     "semantic-release": "19.0.2",
-    "semantic-release-slack-bot": "3.5.0",
+    "semantic-release-slack-bot": "3.5.2",
     "tap": "15.1.6"
   }
 }

package/utils/index.js

@@ -1,11 +1,6 @@
 'use strict';
 
-const {
-    helpers: { getDefaults, files },
-} = require('@eik/common');
 const logger = require('./logger');
 const getCWD = require('./get-cwd');
-const typeSlug = require('./type-slug');
-const typeTitle = require('./type-title');
 
-module.exports = { logger, getDefaults, getCWD, files, typeSlug, typeTitle };
+module.exports = { logger, getCWD };

package/commands/map.js

@@ -1,104 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const fetch = require('node-fetch');
-const ora = require('ora');
-const PublishMap = require('../classes/publish/map');
-const { logger, getDefaults, getCWD } = require('../utils');
-const { Artifact } = require('../formatters');
-
-exports.command = 'map <name> <version> <file>';
-
-exports.aliases = ['m'];
-
-exports.describe = `Upload an import map file to the server under a given name and version.
-    A name/version combination must be unique and a version must be semver compliant.
-    Subsquent published versions must increase. Eg. 1.0.0 1.0.1, 1.1.0, 2.0.0 etc.`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
-
-    yargs
-        .positional('name', {
-            describe: 'Import map name.',
-            type: 'string',
-        })
-        .positional('version', {
-            describe: 'Import map version.',
-            type: 'string',
-        })
-        .positional('file', {
-            describe:
-                'Path to import map file on local disk relative to the current working directory.',
-            type: 'string',
-            normalize: true,
-        });
-
-    yargs.options({
-        server: {
-            alias: 's',
-            describe: 'Specify location of asset server.',
-            default: defaults.server,
-        },
-        cwd: {
-            alias: 'c',
-            describe: 'Alter current working directory.',
-            default: defaults.cwd,
-        },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
-        token: {
-            describe:
-                'Provide a jwt token to be used to authenticate with the Eik server.',
-            default: '',
-            alias: 't',
-        },
-    });
-
-    yargs.default('token', defaults.token, defaults.token ? '######' : '');
-
-    yargs.example(`eik map my-map 1.0.0 ./import-map.json`);
-    yargs.example(`eik map my-map 2.1.0 ./import-map.json --debug`);
-    yargs.example(
-        `eik map my-map 2.1.1 ./import-map.json --server https://assets.myeikserver.com`,
-    );
-};
-
-exports.handler = async (argv) => {
-    const spinner = ora({ stream: process.stdout }).start('working...');
-    const { debug, server, name, version } = argv;
-
-    try {
-        const log = logger(spinner, debug);
-
-        await new PublishMap({ logger: log, ...argv }).run();
-
-        let url = new URL(join('map', name), server);
-        let res = await fetch(url);
-        const pkgMeta = await res.json();
-
-        url = new URL(join('map', name, version), server);
-        res = await fetch(url);
-
-        log.info(`Published import map "${name}" at version "${version}"`);
-
-        spinner.text = '';
-        spinner.stopAndPersist();
-
-        const artifact = new Artifact(pkgMeta);
-        const versions = new Map(pkgMeta.versions);
-        artifact.versions = Array.from(versions.values());
-        artifact.format(server);
-
-        process.stdout.write('\n');
-    } catch (err) {
-        spinner.warn(err.message);
-        spinner.text = '';
-        spinner.stopAndPersist();
-        process.exit(1);
-    }
-};