@eik/cli 3.0.0-next.1 → 3.0.2

package/formatters/version.js

@@ -1,14 +1,7 @@
-/* eslint-disable no-restricted-properties */
-/* eslint-disable prefer-template */
-/* eslint-disable one-var */
-/* eslint-disable no-underscore-dangle */
-
-'use strict';
-
-const { join } = require('path');
-const chalk = require('chalk');
-const formatDistance = require('date-fns/formatDistance');
-const File = require('./file');
+import { join } from 'path';
+import chalk from 'chalk';
+import { formatDistance } from 'date-fns/formatDistance';
+import File from './file.js';
 
 class Version {
     constructor({
@@ -65,4 +58,4 @@ class Version {
     }
 }
 
-module.exports = Version;
+export default Version;

package/index.js

@@ -1,14 +1,31 @@
 #!/usr/bin/env node
+import chalk from 'chalk';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import boxen from 'boxen';
+import { join } from 'path';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+import { commands } from './commands/index.js';
 
-'use strict';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
-const chalk = require('chalk');
-const yargs = require('yargs');
-const boxen = require('boxen');
-const { join } = require('path');
-const { readFileSync } = require('fs');
+const { version } = JSON.parse(
+    readFileSync(join(__dirname, './package.json'), { encoding: 'utf-8' }),
+);
+
+// short circuit and provide a -v and --version flag
+if (
+    process.argv.includes('-v') ||
+    // last position only to avoid conflict with publish command
+    process.argv[process.argv.length - 1].includes('--version')
+) {
+    console.log(version);
+    process.exit(0);
+}
 
-const { version } = JSON.parse(readFileSync(join(__dirname, './package.json')));
 const greeting = chalk.white.bold(`Eik CLI (v${version})`);
 
 const boxenOptions = {
@@ -18,26 +35,50 @@ const boxenOptions = {
     borderColor: 'green',
     backgroundColor: '#555555',
 };
+// @ts-expect-error
 const msgBox = boxen(greeting, boxenOptions);
 
-// eslint-disable-next-line no-console
 console.log(msgBox);
 
-// eslint-disable-next-line no-unused-expressions
-yargs
+yargs(hideBin(process.argv))
+    .options({
+        config: {
+            alias: 'c',
+            describe:
+                'Provide an exact path to an eik.json or package.json file to use as config. Default is eik.json in the current working directory.',
+        },
+        cwd: {
+            describe: 'Alter the current working directory.',
+            default: process.cwd(),
+        },
+        debug: {
+            describe: 'Logs additional messages',
+            default: false,
+            type: 'boolean',
+        },
+    })
+    // @ts-expect-error
     .example('eik init')
+    // @ts-expect-error
     .example('eik login --server https://assets.myserver.com --key ######')
+    // @ts-expect-error
     .example('eik publish')
+    // @ts-expect-error
     .example('eik meta my-app --server https://assets.myserver.com')
     .example(
+        // @ts-expect-error
         'eik npm-alias lit-html 1.0.0 1 --server https://assets.myserver.com --token ######',
     )
     .example(
+        // @ts-expect-error
         'eik map my-map 1.0.0 ./import-map.json --server https://assets.myserver.com --token ######',
     )
+    // @ts-expect-error
     .example('eik map-alias my-map 1.0.0 1')
-    .commandDir('commands')
+    // @ts-expect-error
+    .command(commands)
     .demandCommand()
     .wrap(150)
     .version(false)
-    .help().argv;
+    .help()
+    .parse();

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@eik/cli",
-  "version": "3.0.0-next.1",
-  "description": "Cli tool for publishing assets",
+  "version": "3.0.2",
+  "description": "CLI tool for publishing assets to an Eik server",
   "main": "./classes/index.js",
+  "types": "./types/classes/index.d.ts",
+  "type": "module",
   "bin": {
     "eik": "index.js"
   },
@@ -14,69 +16,64 @@
     "commands",
     "classes",
     "utils",
-    "formatters"
+    "formatters",
+    "types"
   ],
   "scripts": {
-    "test": "HTTP_PORT=0 LOG_LEVEL=fatal tap --no-coverage-report --no-cov --timeout 0 --test-regex=.test.js --test-ignore=node_modules",
-    "test:integration": "HTTP_PORT=0 LOG_LEVEL=fatal tap --no-coverage-report --no-cov --timeout 0 test/integration/**/*.test.js",
-    "test:unit": "HTTP_PORT=0 LOG_LEVEL=fatal tap --no-coverage-report --no-cov --timeout 0 test/*.test.js",
-    "test:tasks": "HTTP_PORT=0 LOG_LEVEL=fatal tap --no-coverage-report --no-cov --timeout 0 test/tasks/*.test.js",
-    "test:ci": "npm run test:unit  -- --jobs=1 && npm run test:tasks -- --jobs=1 && npm run test:integration -- --jobs=1",
-    "lint:check": "eslint .",
+    "clean": "rimraf .tap node_modules types",
+    "test": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/**/*.test.mjs",
+    "test:integration": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/integration/**/*.test.mjs",
+    "test:unit": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/*.test.mjs",
+    "test:tasks": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/tasks/*.test.mjs",
+    "test:ci:integration": "npm run test:integration -- --jobs=1",
+    "test:ci:unit": "npm run test:unit -- --jobs=1",
+    "test:ci:tasks": "npm run test:tasks -- --jobs=1",
+    "test:ci": "run-s test:ci:*",
+    "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "format:check": "prettier -c .",
     "format:fix": "prettier -w .",
-    "fix": "npm run lint:fix && npm run format:fix"
+    "fix": "run-s lint:fix format:fix",
+    "types": "run-s types:module types:test",
+    "types:module": "tsc",
+    "types:test": "tsc --project tsconfig.test.json"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@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",
+    "@eik/common": "4.1.0",
+    "abslog": "2.4.4",
+    "boxen": "8.0.0",
     "bytes": "3.1.2",
-    "chalk": "4.1.2",
-    "copy": "0.3.2",
-    "date-fns": "2.28.0",
+    "chalk": "5.3.0",
+    "date-fns": "3.6.0",
     "form-data": "4.0.0",
-    "glob": "7.2.0",
-    "gzip-size": "6.0.0",
-    "make-dir": "3.1.0",
-    "node-fetch": "2.6.7",
-    "ora": "5.4.1",
-    "pkg-dir": "6.0.1",
-    "read-pkg-up": "9.0.0",
-    "rimraf": "3.0.2",
-    "semver": "7.3.5",
-    "ssri": "8.0.1",
-    "tar": "6.1.11",
-    "temp-dir": "2.0.0",
-    "yargs": "17.3.1",
-    "yargs-parser": "21.0.0"
+    "gzip-size": "7.0.0",
+    "make-dir": "5.0.0",
+    "ora": "8.0.1",
+    "rimraf": "6.0.1",
+    "semver": "7.6.3",
+    "ssri": "10.0.6",
+    "tar": "7.4.3",
+    "yargs": "17.7.2",
+    "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@eik/core": "1.2.28",
-    "@eik/service": "1.2.98",
-    "@semantic-release/changelog": "6.0.1",
-    "@semantic-release/git": "10.0.1",
-    "eslint": "8.8.0",
-    "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-prettier": "4.0.0",
-    "fastify": "3.27.0",
-    "fastify-cors": "6.0.2",
-    "fs-extra": "10.0.0",
-    "prettier": "2.5.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.2",
-    "tap": "15.1.6"
+    "@eik/eslint-config": "1.0.2",
+    "@eik/semantic-release-config": "1.0.0",
+    "@eik/service": "2.3.0",
+    "@eik/sink-memory": "1.1.1",
+    "@eik/typescript-config": "1.0.0",
+    "cross-env": "7.0.3",
+    "eslint": "9.8.0",
+    "fastify": "4.28.1",
+    "fs-extra": "11.2.0",
+    "npm-run-all": "4.1.5",
+    "prettier": "3.3.3",
+    "semantic-release": "24.0.0",
+    "semantic-release-slack-bot": "4.0.2",
+    "tap": "21.0.0",
+    "typescript": "5.5.4"
   }
 }

package/readme.md

@@ -1,9 +1,21 @@
-# Eik CLI
+# @eik/cli
 
-## Installation
+The Eik CLI helps you publish to an [Eik server](https://eik.dev/docs/introduction/) and manage import maps and aliases.
+
+## Installing
+
+Run this command to install the Eik CLI globally.
 
 ```sh
-npm install -g @eik/cli
+npm install --global @eik/cli
 ```
 
-See Eik [documentation site](https://eik.dev/) for usage instructions.
+This makes the `eik` command available in your shell.
+
+```sh
+eik --version
+```
+
+## Usage
+
+See [the CLI reference documentation](https://eik.dev/docs/reference/at-eik-cli) to learn about the available commands.

package/types/classes/alias.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @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
+ */
+/**
+ * @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
+ */
+export default class Alias {
+    /**
+     * @param {AliasOptions} options
+     */
+    constructor({ logger, server, token, type, name, version, alias }: AliasOptions);
+    log: abslog.ValidLogger;
+    server: string;
+    token: string;
+    type: any;
+    name: string;
+    alias: string;
+    version: string;
+    /**
+     * @returns {Promise<AliasResult>}
+     */
+    run(): Promise<AliasResult>;
+}
+export type AliasOptions = {
+    logger?: import("abslog").AbstractLoggerOptions;
+    server: string;
+    type?: "package" | "npm" | "map";
+    name: string;
+    version: string;
+    alias: string;
+    token: string;
+};
+export type AliasResult = {
+    server: string;
+    type: string;
+    name: string;
+    alias: string;
+    version: string;
+    update: boolean;
+    files: string[];
+    org: string;
+    integrity: string;
+};
+import abslog from 'abslog';

package/types/classes/index.d.ts

@@ -0,0 +1,37 @@
+declare namespace _default {
+    /**
+     * @param {import('./alias.js').AliasOptions} opts
+     */
+    function alias(opts: import("./alias.js").AliasOptions): Promise<import("./alias.js").AliasResult>;
+    /**
+     * @param {import('./integrity.js').IntegrityOptions} opts
+     */
+    function integrity(opts: import("./integrity.js").IntegrityOptions): Promise<any>;
+    /**
+     * Log in using a key to get a Bearer token for use with other commands.
+     *
+     * @param {import('./login.js').LoginOptions} opts
+     */
+    function login(opts: import("./login.js").LoginOptions): Promise<string | false>;
+    /**
+     * @param {import('./publish/map.js').PublishMapOptions} opts
+     */
+    function map(opts: import("./publish/map.js").PublishMapOptions): Promise<import("./publish/map.js").PublishMapResult>;
+    /**
+     * @param {import('./meta.js').MetaOptions} opts
+     */
+    function meta(opts: import("./meta.js").MetaOptions): Promise<unknown>;
+    /**
+     * @param {import('./ping.js').PingOptions} opts
+     */
+    function ping(opts: import("./ping.js").PingOptions): Promise<boolean>;
+    /**
+     * @param {import('./publish/package/index.js').PublishOptions} opts
+     */
+    function publish(opts: import("./publish/package/index.js").PublishOptions): Promise<import("./publish/package/index.js").PublishResult>;
+    /**
+     * @param {import('./version.js').VersionOptions} opts
+     */
+    function version(opts: import("./version.js").VersionOptions): Promise<string>;
+}
+export default _default;

package/types/classes/integrity.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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, version, server, type, debug, cwd, }: IntegrityOptions);
+    log: abslog.ValidLogger;
+    server: string;
+    name: string;
+    version: string;
+    debug: boolean;
+    cwd: string;
+    type: "map" | "package" | "npm";
+    run(): Promise<any>;
+}
+export type IntegrityOptions = {
+    logger?: import("abslog").AbstractLoggerOptions;
+    server: string;
+    type?: "package" | "npm" | "map";
+    name: string;
+    version: string;
+    cwd?: string;
+    debug?: boolean;
+};
+import abslog from 'abslog';

package/types/classes/login.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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 }: LoginOptions);
+    log: abslog.ValidLogger;
+    server: string;
+    key: string;
+    /**
+     * @returns {Promise<string | false>} Bearer token, or false if login fails
+     */
+    run(): Promise<string | false>;
+}
+export type LoginOptions = {
+    logger?: import("abslog").AbstractLoggerOptions;
+    server: string;
+    key: string;
+};
+import abslog from 'abslog';

package/types/classes/meta.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 }: MetaOptions);
+    log: abslog.ValidLogger;
+    server: string;
+    name: string;
+    version: string;
+    /**
+     * @returns {Promise<unknown | false>}
+     */
+    run(): Promise<unknown | false>;
+}
+export type MetaOptions = {
+    logger?: import("abslog").AbstractLoggerOptions;
+    server: string;
+    name: string;
+    version: string;
+};
+import abslog from 'abslog';

package/types/classes/ping.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @typedef {object} PingOptions
+ * @property {string} [server]
+ * @property {import('abslog').AbstractLoggerOptions} [logger]
+ */
+export default class Ping {
+    /**
+     * @param {PingOptions} options
+     */
+    constructor({ logger, server }?: PingOptions);
+    log: abslog.ValidLogger;
+    server: string;
+    /**
+     * Run the ping command
+     * @returns {Promise<boolean>}
+     */
+    run(): Promise<boolean>;
+}
+export type PingOptions = {
+    server?: string;
+    logger?: import("abslog").AbstractLoggerOptions;
+};
+import abslog from 'abslog';

package/types/classes/publish/map.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @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
+ */
+/**
+ * @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, server, token, file, name, version, }: PublishMapOptions);
+    log: abslog.ValidLogger;
+    cwd: string;
+    server: string;
+    token: string;
+    name: string;
+    version: string;
+    file: string;
+    /**
+     * @returns {Promise<PublishMapResult>}
+     */
+    run(): Promise<PublishMapResult>;
+    absoluteFile: string;
+}
+export type PublishMapOptions = {
+    logger?: import("abslog").AbstractLoggerOptions;
+    server: string;
+    cwd?: string;
+    token: string;
+    file: string;
+    name: string;
+    version: string;
+};
+export type PublishMapResult = {
+    server: string;
+    name: string;
+    version: string;
+    type: string;
+};
+import abslog from 'abslog';

package/types/classes/publish/package/index.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @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"} [type="package"]
+ * @property {string} name
+ * @property {string} [version="1.0.0"]
+ * @property {string[]} [map]
+ * @property {string} [out="./.eik"]
+ * @property {Record<string, string>} files
+ */
+/**
+ * @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, token, dryRun, server, type, name, version, map, out, files, }: PublishOptions);
+    log: abslog.ValidLogger;
+    cwd: string;
+    dryRun: boolean;
+    config: EikConfig;
+    path: string;
+    validateInput: ValidateInput;
+    createTempDirectory: CreateTempDirectory;
+    createZipFile: CreateZipFile;
+    checkBundleSizes: CheckBundleSizes;
+    runDryRun: DryRun;
+    checkIfAlreadyPublished: CheckIfAlreadyPublished;
+    uploadFiles: UploadFiles;
+    saveMetafile: SaveMetafile;
+    cleanup: Cleanup;
+    /**
+     * @returns {Promise<PublishResult>}
+     */
+    run(): Promise<PublishResult>;
+}
+export type PublishOptions = {
+    logger?: import("abslog").AbstractLoggerOptions;
+    cwd?: string;
+    token: string;
+    dryRun?: boolean;
+    server: string;
+    type?: "package" | "map" | "npm";
+    name: string;
+    version?: string;
+    map?: string[];
+    out?: string;
+    files: Record<string, string>;
+};
+export type PublishResult = {
+    type: string;
+    server: string;
+    name: string;
+    level: unknown;
+    dryRun: boolean;
+    integrity: string;
+    created: unknown;
+    author: unknown;
+    org: string;
+    version: string;
+    response: unknown;
+    files: Array<{
+        pathname: string;
+        type: string;
+    }>;
+};
+import abslog from 'abslog';
+import { EikConfig } from '@eik/common';
+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';

package/types/classes/publish/package/tasks/check-bundle-sizes.d.ts

@@ -0,0 +1,4 @@
+export default class CheckBundleSizes extends Task {
+    process(): Promise<void>;
+}
+import Task from './task.js';

package/types/classes/publish/package/tasks/check-if-already-published.d.ts

@@ -0,0 +1,4 @@
+export default class CheckIfAlreadyPublished extends Task {
+    process(): Promise<string>;
+}
+import Task from './task.js';

package/types/classes/publish/package/tasks/cleanup.d.ts

@@ -0,0 +1,4 @@
+export default class Cleanup extends Task {
+    process(): Promise<void>;
+}
+import Task from './task.js';

package/types/classes/publish/package/tasks/create-temp-directory.d.ts

@@ -0,0 +1,4 @@
+export default class CreateTempDir extends Task {
+    process(): Promise<void>;
+}
+import Task from './task.js';

package/types/classes/publish/package/tasks/create-zip-file.d.ts

@@ -0,0 +1,4 @@
+export default class CreateZipFile extends Task {
+    process(): Promise<string>;
+}
+import Task from './task.js';