@eik/cli 3.0.0-next.2 → 3.1.0

package/classes/publish/map.js

@@ -1,13 +1,33 @@
-'use strict';
+import assert from 'assert';
+import abslog from 'abslog';
+import { join, parse, isAbsolute } from 'path';
+import { existsSync } from 'fs';
+import { schemas } from '@eik/common';
+import { request } from '../../utils/http/index.js';
 
-const assert = require('assert');
-const abslog = require('abslog');
-const { join, parse, isAbsolute } = require('path');
-const { existsSync } = require('fs');
-const schemas = require('@eik/common-schemas');
-const { request } = require('../../utils/http');
+/**
+ * @typedef {object} PublishMapOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} server
+ * @property {string} [cwd]
+ * @property {string} token
+ * @property {string} file
+ * @property {string} name
+ * @property {string} version
+ */
 
-module.exports = class PublishMap {
+/**
+ * @typedef {object} PublishMapResult
+ * @property {string} server
+ * @property {string} name
+ * @property {string} version
+ * @property {string} type
+ */
+
+export default class PublishMap {
+    /**
+     * @param {PublishMapOptions} options
+     */
     constructor({
         logger,
         cwd = process.cwd(),
@@ -16,7 +36,7 @@ module.exports = class PublishMap {
         file,
         name,
         version,
-    } = {}) {
+    }) {
         this.log = abslog(logger);
         this.cwd = cwd;
         this.server = server;
@@ -26,6 +46,9 @@ module.exports = class PublishMap {
         this.file = file;
     }
 
+    /**
+     * @returns {Promise<PublishMapResult>}
+     */
     async run() {
         this.log.debug('Running import map publish command');
 
@@ -93,4 +116,4 @@ module.exports = class PublishMap {
             }
         }
     }
-};
+}

package/classes/publish/package/index.js

@@ -1,20 +1,52 @@
-'use strict';
+import abslog from 'abslog';
+import { join, isAbsolute } from 'path';
+import { EikConfig } from '@eik/common';
+import { typeSlug } from '../../../utils/index.js';
+import ValidateInput from './tasks/validate-input.js';
+import CreateTempDirectory from './tasks/create-temp-directory.js';
+import CreateZipFile from './tasks/create-zip-file.js';
+import CheckBundleSizes from './tasks/check-bundle-sizes.js';
+import DryRun from './tasks/dry-run.js';
+import CheckIfAlreadyPublished from './tasks/check-if-already-published.js';
+import UploadFiles from './tasks/upload-files.js';
+import SaveMetafile from './tasks/save-metafile.js';
+import Cleanup from './tasks/cleanup.js';
 
-const abslog = require('abslog');
-const { join, isAbsolute } = require('path');
-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');
-const CheckBundleSizes = require('./tasks/check-bundle-sizes');
-const DryRun = require('./tasks/dry-run');
-const CheckIfAlreadyPublished = require('./tasks/check-if-already-published');
-const UploadFiles = require('./tasks/upload-files');
-const SaveMetafile = require('./tasks/save-metafile');
-const Cleanup = require('./tasks/cleanup');
+/**
+ * @typedef {object} PublishOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} [cwd]
+ * @property {string} token
+ * @property {boolean} [dryRun=false]
+ * @property {string} server
+ * @property {"package" | "map" | "npm" | "image"} [type="package"]
+ * @property {string} name
+ * @property {string} [version="1.0.0"]
+ * @property {string[]} [map]
+ * @property {string} [out="./.eik"]
+ * @property {Record<string, string>} files
+ */
 
-module.exports = class Publish {
+/**
+ * @typedef {object} PublishResult
+ * @property {string} type
+ * @property {string} server
+ * @property {string} name
+ * @property {unknown} level
+ * @property {boolean} dryRun
+ * @property {string} integrity
+ * @property {unknown} created
+ * @property {unknown} author
+ * @property {string} org
+ * @property {string} version
+ * @property {unknown} response
+ * @property {Array<{ pathname: string; type: string; }>} files
+ */
+
+export default class Publish {
+    /**
+     * @param {PublishOptions} options
+     */
     constructor({
         logger,
         cwd = process.cwd(),
@@ -27,7 +59,7 @@ module.exports = class Publish {
         map = [],
         out = './.eik',
         files = {},
-    } = {}) {
+    }) {
         const config = new EikConfig(
             {
                 server,
@@ -84,6 +116,9 @@ module.exports = class Publish {
         });
     }
 
+    /**
+     * @returns {Promise<PublishResult>}
+     */
     async run() {
         this.log.debug(`Running package command against server`);
         this.log.debug(`  ==> package name: ${this.config.name}`);
@@ -102,6 +137,7 @@ module.exports = class Publish {
                 type: typeSlug(this.config.type),
                 server: this.config.server,
                 name: this.config.name,
+                // @ts-expect-error Not sure where this.level originated
                 level: this.level,
                 dryRun: this.dryRun,
                 integrity: '',
@@ -122,6 +158,7 @@ module.exports = class Publish {
             type: typeSlug(this.config.type),
             server: this.config.server,
             name: this.config.name,
+            // @ts-expect-error Not sure where this.level originated
             level: this.level,
             dryRun: this.dryRun,
             created: null,
@@ -131,4 +168,4 @@ module.exports = class Publish {
             ...response,
         };
     }
-};
+}

package/classes/publish/package/tasks/check-bundle-sizes.js

@@ -1,13 +1,9 @@
-/* eslint-disable no-await-in-loop */
+import bytes from 'bytes';
+import fs from 'fs';
+import { gzipSizeSync } from 'gzip-size';
+import Task from './task.js';
 
-'use strict';
-
-const bytes = require('bytes');
-const fs = require('fs');
-const gzipSize = require('gzip-size');
-const Task = require('./task');
-
-module.exports = class CheckBundleSizes extends Task {
+export default class CheckBundleSizes extends Task {
     async process() {
         this.log.debug('Checking bundle file sizes');
         try {
@@ -17,7 +13,7 @@ module.exports = class CheckBundleSizes extends Task {
                     `  ==> entrypoint size (${
                         mapping.source.destination
                     } => ${file}): ${bytes(
-                        gzipSize.sync(fs.readFileSync(file, 'utf8')),
+                        gzipSizeSync(fs.readFileSync(file, 'utf8')),
                     )}`,
                 );
             }
@@ -25,4 +21,4 @@ module.exports = class CheckBundleSizes extends Task {
             throw new Error(`Failed to check bundle sizes: ${err.message}`);
         }
     }
-};
+}

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

@@ -1,14 +1,10 @@
-/* eslint-disable no-param-reassign */
+import { join } from 'path';
+import { integrity, versions } from '../../../../utils/http/index.js';
+import hash from '../../../../utils/hash/index.js';
+import { typeSlug } from '../../../../utils/index.js';
+import Task from './task.js';
 
-'use strict';
-
-const { join } = require('path');
-const { typeSlug } = require('@eik/common-utils');
-const { integrity, versions } = require('../../../../utils/http');
-const hash = require('../../../../utils/hash');
-const Task = require('./task');
-
-module.exports = class CheckIfAlreadyPublished extends Task {
+export default class CheckIfAlreadyPublished extends Task {
     async process() {
         const { log, path } = this;
         const { server, name, version, files, type } = this.config;
@@ -69,6 +65,7 @@ module.exports = class CheckIfAlreadyPublished extends Task {
             );
         }
 
+        // @ts-expect-error
         const versionMap = new Map(pkgVersions);
         for (const v of versionMap.values()) {
             const same = hash.compare(v.integrity, localHash);
@@ -84,4 +81,4 @@ module.exports = class CheckIfAlreadyPublished extends Task {
 
         return localHash;
     }
-};
+}

package/classes/publish/package/tasks/cleanup.js

@@ -1,11 +1,9 @@
-'use strict';
+import { join } from 'path';
+import fs from 'fs';
+import { rimrafSync } from 'rimraf';
+import Task from './task.js';
 
-const { join } = require('path');
-const fs = require('fs');
-const rimraf = require('rimraf');
-const Task = require('./task');
-
-module.exports = class Cleanup extends Task {
+export default class Cleanup extends Task {
     async process() {
         const { log, path } = this;
         log.debug('Cleaning up');
@@ -13,7 +11,7 @@ module.exports = class Cleanup extends Task {
         if (fs.existsSync(path)) {
             fs.readdirSync(path)
                 .filter((file) => file !== 'integrity.json')
-                .forEach((file) => rimraf.sync(join(path, file)));
+                .forEach((file) => rimrafSync(join(path, file)));
         }
     }
-};
+}

package/classes/publish/package/tasks/create-temp-directory.js

@@ -1,9 +1,5 @@
-/* eslint-disable max-classes-per-file */
-
-'use strict';
-
-const mkdir = require('make-dir');
-const Task = require('./task');
+import { makeDirectorySync } from 'make-dir';
+import Task from './task.js';
 
 class IOError extends Error {
     constructor(message, err) {
@@ -13,7 +9,7 @@ class IOError extends Error {
     }
 }
 
-module.exports = class CreateTempDir extends Task {
+export default class CreateTempDir extends Task {
     async process() {
         const { log, path } = this;
 
@@ -21,9 +17,9 @@ module.exports = class CreateTempDir extends Task {
         log.debug(`  ==> ${path}`);
 
         try {
-            mkdir.sync(path);
+            makeDirectorySync(path);
         } catch (err) {
             throw new IOError('Unable to create temp dir', err);
         }
     }
-};
+}

package/classes/publish/package/tasks/create-zip-file.js

@@ -1,16 +1,11 @@
-/* eslint-disable no-plusplus */
-/* eslint-disable no-await-in-loop */
-
-'use strict';
-
-const fs = require('fs');
-const { join, resolve, basename, dirname } = require('path');
-const tar = require('tar');
-const Task = require('./task');
+import fs from 'fs';
+import { join, resolve, basename, dirname } from 'path';
+import * as tar from 'tar';
+import Task from './task.js';
 
 const { copyFileSync, writeFileSync } = fs;
 
-module.exports = class CreateZipFile extends Task {
+export default class CreateZipFile extends Task {
     async process() {
         const { log, path } = this;
         const { name, map, server, out, files } = this.config;
@@ -80,4 +75,4 @@ module.exports = class CreateZipFile extends Task {
             throw new Error(`Unable to create zip file: ${err.message}`);
         }
     }
-};
+}

package/classes/publish/package/tasks/dry-run.js

@@ -1,11 +1,7 @@
-/* eslint-disable no-param-reassign */
+import { join } from 'path';
+import Task from './task.js';
 
-'use strict';
-
-const { join } = require('path');
-const Task = require('./task');
-
-module.exports = class DryRun extends Task {
+export default class DryRun extends Task {
     async process(zipFile) {
         const { path } = this;
 
@@ -23,4 +19,4 @@ module.exports = class DryRun extends Task {
 
         return files;
     }
-};
+}

package/classes/publish/package/tasks/save-metafile.js

@@ -1,10 +1,8 @@
-'use strict';
+import { join } from 'path';
+import json from '../../../../utils/json/index.js';
+import Task from './task.js';
 
-const { join } = require('path');
-const json = require('../../../../utils/json');
-const Task = require('./task');
-
-module.exports = class SaveMetaFile extends Task {
+export default class SaveMetaFile extends Task {
     async process(response) {
         const { log, cwd } = this;
         const { out } = this.config;
@@ -19,4 +17,4 @@ module.exports = class SaveMetaFile extends Task {
             );
         }
     }
-};
+}

package/classes/publish/package/tasks/task.js

@@ -1,12 +1,10 @@
-'use strict';
+import abslog from 'abslog';
 
-const abslog = require('abslog');
-
-module.exports = class Task {
+export default class Task {
     constructor(options) {
         this.cwd = options.cwd;
         this.log = abslog(options.logger);
         this.path = options.path;
         this.config = options.config;
     }
-};
+}

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

@@ -1,13 +1,9 @@
-/* eslint-disable no-param-reassign */
+import { join } from 'path';
+import { request } from '../../../../utils/http/index.js';
+import { typeSlug } from '../../../../utils/index.js';
+import Task from './task.js';
 
-'use strict';
-
-const { join } = require('path');
-const { typeSlug } = require('@eik/common-utils');
-const { request } = require('../../../../utils/http');
-const Task = require('./task');
-
-module.exports = class UploadFiles extends Task {
+export default class UploadFiles extends Task {
     async process(zipFile) {
         const { log } = this;
         const { server, name, version, type, token } = this.config;
@@ -30,33 +26,36 @@ 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(
-                        'Client attempted to send an invalid URL parameter',
+                        `${err.statusCode}: Client attempted to send an invalid URL parameter`,
                     );
                 case 401:
-                    throw new Error('Client unauthorized with server');
+                    throw new Error(
+                        `${err.statusCode}: Client unauthorized with server`,
+                    );
                 case 404:
-                    throw new Error('Client could not find server route');
+                    throw new Error(
+                        `${err.statusCode}: Client could not find server route`,
+                    );
                 case 409:
                     throw new Error(
                         `Package with name "${name}" and version "${version}" already exists on server`,
                     );
                 case 415:
                     throw new Error(
-                        'Client attempted to send an unsupported file format to server',
+                        `${err.statusCode}: Client attempted to send an unsupported file format to server`,
                     );
                 case 502:
                     throw new Error(
-                        'Server was unable to write file to storage',
+                        `${err.statusCode}: Server was unable to write file to storage, ${err.message}`,
                     );
                 default:
                     throw new Error(
-                        `Upload to server failed, server responded with: ${err.message}`,
+                        `${err.statusCode}: Server failed, ${err.message}`,
                     );
             }
         }
     }
-};
+}

package/classes/publish/package/tasks/validate-input.js

@@ -1,9 +1,5 @@
-/* eslint-disable max-classes-per-file */
-
-'use strict';
-
-const { parse } = require('path');
-const Task = require('./task');
+import { parse } from 'path';
+import Task from './task.js';
 
 class ValidationError extends Error {
     constructor(message, err) {
@@ -15,7 +11,7 @@ class ValidationError extends Error {
     }
 }
 
-module.exports = class ValidateInput extends Task {
+export default class ValidateInput extends Task {
     process() {
         const { log } = this;
         const { cwd, dryRun } = this.config;
@@ -34,4 +30,4 @@ module.exports = class ValidateInput extends Task {
             throw new ValidationError('Parameter "dryRun" is not valid');
         }
     }
-};
+}

package/classes/version.js

@@ -1,21 +1,31 @@
-/* eslint-disable max-classes-per-file */
-
-'use strict';
-
-const { copyFileSync, writeFileSync } = require('fs');
-const { join, isAbsolute, parse } = require('path');
-const abslog = require('abslog');
-const semver = require('semver');
-const mkdir = require('make-dir');
-
-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');
-
-module.exports = class Version {
+import { copyFileSync, writeFileSync } from 'fs';
+import { join, isAbsolute, parse } from 'path';
+import abslog from 'abslog';
+import semver from 'semver';
+import { makeDirectorySync } from 'make-dir';
+import { schemas, EikConfig } from '@eik/common';
+import { integrity } from '../utils/http/index.js';
+import hash from '../utils/hash/index.js';
+import { typeSlug } from '../utils/index.js';
+
+/**
+ * @typedef {object} VersionOptions
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ * @property {string} server
+ * @property {"package" | "npm" | "map"} [type="package"]
+ * @property {string} name
+ * @property {string} version
+ * @property {import("semver").ReleaseType} [level="patch"]
+ * @property {string} cwd
+ * @property {string[]} [map]
+ * @property {string} [out="./.eik"]
+ * @property {string | Record<string, string>} files
+ */
+
+export default class Version {
+    /**
+     * @param {VersionOptions} options
+     */
     constructor({
         logger,
         server,
@@ -27,7 +37,7 @@ module.exports = class Version {
         map = [],
         out = './.eik',
         files,
-    } = {}) {
+    }) {
         const config = new EikConfig(
             {
                 server,
@@ -48,6 +58,10 @@ module.exports = class Version {
         this.level = level;
     }
 
+    /**
+     * Similar to `npm version`, but updates `eik.json`
+     * @returns {Promise<string | null>} The new version number, or null if the versioning failed
+     */
     async run() {
         const { name, server, type, version, cwd, out, files, map } =
             this.config;
@@ -62,6 +76,7 @@ module.exports = class Version {
 
         log.debug(`  ==> level: ${level}`);
         if (!['major', 'minor', 'patch'].includes(level)) {
+            // @ts-expect-error
             throw new schemas.ValidationError(
                 'Parameter "version" is not valid',
             );
@@ -69,11 +84,13 @@ module.exports = class Version {
 
         log.debug(`  ==> files: ${JSON.stringify(files)}`);
         if (!files) {
+            // @ts-expect-error
             throw new schemas.ValidationError('Parameter "files" is not valid');
         }
 
         log.debug(`  ==> map: ${JSON.stringify(map)}`);
         if (!Array.isArray(map)) {
+            // @ts-expect-error
             throw new schemas.ValidationError('Parameter "map" is not valid');
         }
 
@@ -106,7 +123,7 @@ module.exports = class Version {
 
         let localHash;
         try {
-            mkdir.sync(path);
+            makeDirectorySync(path);
             const eikPathDest = join(path, './eik.json');
             const eikJSON = {
                 name,
@@ -160,4 +177,4 @@ module.exports = class Version {
         log.debug(`  ==> ${newVersion}`);
         return newVersion;
     }
-};
+}