@eik/cli 3.1.67 → 3.1.69

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [3.1.69](https://github.com/eik-lib/cli/compare/v3.1.68...v3.1.69) (2026-08-24)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @eik/common to v5.2.1 ([#762](https://github.com/eik-lib/cli/issues/762)) ([90803dd](https://github.com/eik-lib/cli/commit/90803dda991db423a0730be4a99e5cdffbca0f38))
+
+## [3.1.68](https://github.com/eik-lib/cli/compare/v3.1.67...v3.1.68) (2026-08-14)
+
+
+### Bug Fixes
+
+* shorten the 413 error message ([e56b292](https://github.com/eik-lib/cli/commit/e56b29240d5b2c53f96bdf84a543f636f9e44816))
+* surface a clear error message when a package upload exceeds the server size limit ([515cc9b](https://github.com/eik-lib/cli/commit/515cc9bfd843d9cfa931ea03a9d244a7fc39a3e0))
+* type assert.rejects validation callback parameter as Error ([4873c48](https://github.com/eik-lib/cli/commit/4873c48885cdbeeba7a03d36809c16bae06fdd27))
+
 ## [3.1.67](https://github.com/eik-lib/cli/compare/v3.1.66...v3.1.67) (2026-08-03)
 
 

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

@@ -49,6 +49,11 @@ export default class UploadFiles extends Task {
 						`Package with name "${name}" and version "${version}" already exists on server`,
 						{ cause: err },
 					);
+				case 413:
+					throw new Error(
+						`${e.statusCode}: Package is too large to upload. Reduce the package size.`,
+						{ cause: err },
+					);
 				case 415:
 					throw new Error(
 						`${e.statusCode}: Client attempted to send an unsupported file format to server`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/cli",
-  "version": "3.1.67",
+  "version": "3.1.69",
   "description": "CLI tool for publishing assets to an Eik server",
   "main": "./classes/index.js",
   "types": "./types/classes/index.d.ts",
@@ -42,7 +42,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@eik/common": "5.1.34",
+    "@eik/common": "5.2.1",
     "abslog": "2.4.4",
     "bytes": "3.1.2",
     "date-fns": "4.4.0",
@@ -59,22 +59,22 @@
     }
   },
   "devDependencies": {
-    "@eik/eslint-config": "2.0.7",
+    "@eik/eslint-config": "2.0.15",
     "@eik/prettier-config": "1.0.2",
-    "@eik/semantic-release-config": "1.0.18",
-    "@eik/service": "5.1.65",
+    "@eik/semantic-release-config": "1.0.19",
+    "@eik/service": "5.1.69",
     "@eik/sink-memory": "2.0.37",
     "@eik/typescript-config": "1.0.2",
-    "@types/node": "25.9.5",
-    "@types/semver": "7.7.1",
+    "@types/node": "26.2.0",
+    "@types/semver": "7.8.0",
     "@types/yargs": "17.0.35",
     "cross-env": "10.1.0",
-    "eslint": "10.4.0",
-    "fastify": "5.8.5",
-    "npm-run-all2": "9.0.1",
-    "prettier": "3.8.3",
-    "semantic-release": "25.0.3",
+    "eslint": "10.8.1",
+    "fastify": "5.11.3",
+    "npm-run-all2": "9.0.3",
+    "prettier": "3.9.6",
+    "semantic-release": "25.0.9",
     "semantic-release-slack-bot": "4.0.2",
-    "typescript": "6.0.3"
+    "typescript": "7.0.2"
   }
 }

package/types/classes/alias.d.ts

@@ -1,3 +1,24 @@
+import abslog from "abslog";
+export type AliasOptions = {
+    logger?: import('abslog').AbstractLoggerOptions;
+    server: string;
+    type?: "package" | "npm" | "image" | "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;
+};
 /**
  * @typedef {object} AliasOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -21,10 +42,6 @@
  * @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;
@@ -32,29 +49,12 @@ export default class Alias {
     name: string;
     alias: string;
     version: string;
+    /**
+     * @param {AliasOptions} options
+     */
+    constructor({ logger, server, token, type, name, version, alias }: AliasOptions);
     /**
      * @returns {Promise<AliasResult>}
      */
     run(): Promise<AliasResult>;
 }
-export type AliasOptions = {
-    logger?: import("abslog").AbstractLoggerOptions;
-    server: string;
-    type?: "map" | "package" | "npm" | "image" | undefined;
-    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

@@ -1,37 +1,37 @@
-declare namespace _default {
+declare const _default: {
     /**
      * @param {import('./alias.js').AliasOptions} opts
      */
-    function alias(opts: import("./alias.js").AliasOptions): Promise<import("./alias.js").AliasResult>;
+    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>;
+    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>;
+    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>;
+    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>;
+    meta(opts: import('./meta.js').MetaOptions): Promise<unknown>;
     /**
      * @param {import('./ping.js').PingOptions} opts
      */
-    function ping(opts: import("./ping.js").PingOptions): Promise<boolean>;
+    ping(opts: import('./ping.js').PingOptions): Promise<boolean>;
     /**
      * @param {import('./publish/package/publish.js').PublishOptions} opts
      */
-    function publish(opts: import("./publish/package/publish.js").PublishOptions): Promise<import("./publish/package/publish.js").PublishResult>;
+    publish(opts: import('./publish/package/publish.js').PublishOptions): Promise<import("./publish/package/publish.js").PublishResult>;
     /**
      * @param {import('./version.js').VersionOptions} opts
      */
-    function version(opts: import("./version.js").VersionOptions): Promise<string | null>;
-}
+    version(opts: import('./version.js').VersionOptions): Promise<string | null>;
+};
 export default _default;

package/types/classes/integrity.d.ts

@@ -1,3 +1,13 @@
+import abslog from "abslog";
+export type IntegrityOptions = {
+    logger?: import('abslog').AbstractLoggerOptions;
+    server: string;
+    type?: "package" | "npm" | "map";
+    name: string;
+    version: string;
+    cwd?: string;
+    debug?: boolean;
+};
 /**
  * @typedef {object} IntegrityOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -9,27 +19,17 @@
  * @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" | undefined;
+    type: "map" | "npm" | "package" | undefined;
+    /**
+     *
+     * @param {IntegrityOptions} options
+     */
+    constructor({ logger, name, version, server, type, debug, cwd, }: IntegrityOptions);
     run(): Promise<any>;
 }
-export type IntegrityOptions = {
-    logger?: import("abslog").AbstractLoggerOptions;
-    server: string;
-    type?: "map" | "package" | "npm" | undefined;
-    name: string;
-    version: string;
-    cwd?: string | undefined;
-    debug?: boolean | undefined;
-};
-import abslog from "abslog";

package/types/classes/login.d.ts

@@ -1,3 +1,9 @@
+import abslog from "abslog";
+export type LoginOptions = {
+    logger?: import('abslog').AbstractLoggerOptions;
+    server: string;
+    key: string;
+};
 /**
  * @typedef {object} LoginOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -5,21 +11,15 @@
  * @property {string} key
  */
 export default class Login {
+    log: abslog.ValidLogger;
+    server: string;
+    key: string;
     /**
      * @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

@@ -1,3 +1,10 @@
+import abslog from "abslog";
+export type MetaOptions = {
+    logger?: import('abslog').AbstractLoggerOptions;
+    server: string;
+    name: string;
+    version?: string;
+};
 /**
  * @typedef {object} MetaOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -6,23 +13,16 @@
  * @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 | undefined;
+    /**
+     * @param {MetaOptions} options
+     */
+    constructor({ logger, server, name, version }: MetaOptions);
     /**
      * @returns {Promise<unknown | false>}
      */
     run(): Promise<unknown | false>;
 }
-export type MetaOptions = {
-    logger?: import("abslog").AbstractLoggerOptions;
-    server: string;
-    name: string;
-    version?: string | undefined;
-};
-import abslog from "abslog";

package/types/classes/ping.d.ts

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

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

@@ -1,3 +1,19 @@
+import abslog from "abslog";
+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;
+};
 /**
  * @typedef {object} PublishMapOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -16,10 +32,6 @@
  * @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;
@@ -27,25 +39,13 @@ export default class PublishMap {
     name: string;
     version: string;
     file: string;
+    absoluteFile: string | undefined;
+    /**
+     * @param {PublishMapOptions} options
+     */
+    constructor({ logger, cwd, server, token, file, name, version, }: PublishMapOptions);
     /**
      * @returns {Promise<PublishMapResult>}
      */
     run(): Promise<PublishMapResult>;
-    absoluteFile: string | undefined;
 }
-export type PublishMapOptions = {
-    logger?: import("abslog").AbstractLoggerOptions;
-    server: string;
-    cwd?: string | undefined;
-    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/publish.d.ts

@@ -1,3 +1,44 @@
+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";
+export type PublishOptions = {
+    logger?: import('abslog').AbstractLoggerOptions;
+    cwd?: string;
+    token: string;
+    dryRun?: boolean;
+    server: string;
+    type?: "package" | "map" | "npm" | "image";
+    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;
+    }>;
+};
 /**
  * @typedef {object} PublishOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -28,10 +69,6 @@
  * @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;
@@ -46,49 +83,12 @@ export default class Publish {
     uploadFiles: UploadFiles;
     saveMetafile: SaveMetafile;
     cleanup: Cleanup;
+    /**
+     * @param {PublishOptions} options
+     */
+    constructor({ logger, cwd, token, dryRun, server, type, name, version, map, out, files, }: PublishOptions);
     /**
      * @returns {Promise<PublishResult>}
      */
     run(): Promise<PublishResult>;
 }
-export type PublishOptions = {
-    logger?: import("abslog").AbstractLoggerOptions;
-    cwd?: string | undefined;
-    token: string;
-    dryRun?: boolean | undefined;
-    server: string;
-    type?: "map" | "package" | "npm" | "image" | undefined;
-    name: string;
-    version?: string | undefined;
-    map?: string[] | undefined;
-    out?: string | undefined;
-    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

@@ -1,4 +1,4 @@
+import Task from "./task.js";
 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

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

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

@@ -1,4 +1,4 @@
+import Task from "./task.js";
 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

@@ -1,4 +1,4 @@
+import Task from "./task.js";
 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

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

package/types/classes/publish/package/tasks/dry-run.d.ts

@@ -1,3 +1,4 @@
+import Task from "./task.js";
 export default class DryRun extends Task {
     /** @param {string} zipFile */
     process(zipFile: string): Promise<{
@@ -5,4 +6,3 @@ export default class DryRun extends Task {
         type: string;
     }[]>;
 }
-import Task from "./task.js";

package/types/classes/publish/package/tasks/save-metafile.d.ts

@@ -1,5 +1,5 @@
+import Task from "./task.js";
 export default class SaveMetaFile extends Task {
     /** @param {any} response */
     process(response: any): Promise<void>;
 }
-import Task from "./task.js";

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

@@ -1,9 +1,9 @@
+import abslog from "abslog";
 export default class Task {
-    /** @param {any} options */
-    constructor(options: any);
     cwd: any;
     log: abslog.ValidLogger;
     path: any;
     config: any;
+    /** @param {any} options */
+    constructor(options: any);
 }
-import abslog from "abslog";

package/types/classes/publish/package/tasks/upload-files.d.ts

@@ -1,5 +1,5 @@
+import Task from "./task.js";
 export default class UploadFiles extends Task {
     /** @param {string} zipFile */
     process(zipFile: string): Promise<any>;
 }
-import Task from "./task.js";

package/types/classes/publish/package/tasks/validate-input.d.ts

@@ -1,4 +1,4 @@
+import Task from "./task.js";
 export default class ValidateInput extends Task {
     process(): void;
 }
-import Task from "./task.js";

package/types/classes/version.d.ts

@@ -1,3 +1,17 @@
+import abslog from "abslog";
+export type VersionOptions = {
+    logger?: import('abslog').AbstractLoggerOptions;
+    server: string;
+    type?: "package" | "npm" | "map";
+    name: string;
+    version: string;
+    level?: import("semver").ReleaseType;
+    cwd: string;
+    map?: string[];
+    out?: string;
+    files: string | Record<string, string>;
+    configFile?: string;
+};
 /**
  * @typedef {object} VersionOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
@@ -13,32 +27,18 @@
  * @property {string} [configFile="eik.json"]
  */
 export default class Version {
-    /**
-     * @param {VersionOptions} options
-     */
-    constructor({ logger, server, type, name, version, level, cwd, map, out, files, configFile, }: VersionOptions);
     log: abslog.ValidLogger;
     config: any;
     configFile: string;
     path: any;
     level: import("semver").ReleaseType;
+    /**
+     * @param {VersionOptions} options
+     */
+    constructor({ logger, server, type, name, version, level, cwd, map, out, files, configFile, }: VersionOptions);
     /**
      * Similar to `npm version`, but updates `eik.json`
      * @returns {Promise<string | null>} The new version number, or null if the versioning failed
      */
     run(): Promise<string | null>;
 }
-export type VersionOptions = {
-    logger?: import("abslog").AbstractLoggerOptions;
-    server: string;
-    type?: "map" | "package" | "npm" | undefined;
-    name: string;
-    version: string;
-    level?: import("semver").ReleaseType | undefined;
-    cwd: string;
-    map?: string[] | undefined;
-    out?: string | undefined;
-    files: string | Record<string, string>;
-    configFile?: string | undefined;
-};
-import abslog from "abslog";

package/types/utils/hash/compare.d.ts

@@ -1,2 +1,12 @@
-declare function _default(hash1: string, hash2: string): boolean;
 export default _default;
+/**
+ * Compares 2 hash strings for comparison. Returns `true` if hashes are identical, false otherwise.
+ *
+ * @param {string} hash1 - first hash string to compare
+ * @param {string} hash2 - second hash string to compare
+ *
+ * @returns {boolean}
+ *
+ * @example hash.compare('a1b22c23d24e25f4g33a123b23c34', 'a1b22c23d24e25f4g33a123b23c34');
+ */
+declare function _default(hash1: string, hash2: string): boolean;

package/types/utils/hash/file.d.ts

@@ -1,2 +1,11 @@
-declare function _default(path: string): Promise<string>;
 export default _default;
+/**
+ * Reads a file from a given path and produces and returns an integrity hash from its contents
+ *
+ * @param {string} path - path to file to hash
+ *
+ * @returns {Promise<string>} - integrity hash
+ *
+ * @example hash.file('/path/to/file.js');
+ */
+declare function _default(path: string): Promise<string>;

package/types/utils/hash/files.d.ts

@@ -1,2 +1,11 @@
-declare function _default(files: string[]): Promise<string>;
 export default _default;
+/**
+ * Reads files from given paths and produces and returns an integrity hash from all files contents
+ *
+ * @param {string[]} files - an array of file paths
+ *
+ * @returns {Promise<string>} - integrity string
+ *
+ * @example hash.files(['/path/to/file1.js', '/path/to/file2.js']);
+ */
+declare function _default(files: string[]): Promise<string>;

package/types/utils/http/integrity.d.ts

@@ -1,2 +1,14 @@
-declare function _default(server: string, type: string, name: string, version: string): Promise<string | null>;
 export default _default;
+/**
+ * Fetches package integrity string by name and version from a given Eik asset server.
+ *
+ * @param {string} server - Eik asset server URL to perform lookup against
+ * @param {string} type - Package type (pkg, npm, map)
+ * @param {string} name - Package name to lookup
+ * @param {string} version - Semver major version to lock fetch to
+ *
+ * @returns {Promise<string|null>} - Package integrity string
+ *
+ * @throws Error
+ */
+declare function _default(server: string, type: string, name: string, version: string): Promise<string | null>;

package/types/utils/http/request.d.ts

@@ -1,12 +1,11 @@
-export default request;
 export type RequestOptions = {
-    method?: string | undefined;
+    method?: string;
     host: string;
     pathname: string;
     data?: unknown;
-    file?: string | undefined;
-    map?: string | undefined;
-    token?: string | undefined;
+    file?: string;
+    map?: string;
+    token?: string;
 };
 /**
  * @typedef {object} RequestOptions
@@ -31,3 +30,4 @@ declare function request(options: RequestOptions): Promise<{
     status: number;
     message: any;
 }>;
+export default request;

package/types/utils/http/versions.d.ts

@@ -1,5 +1,16 @@
+export default _default;
+/**
+ * Fetches package versions by name from a given Eik asset server.
+ *
+ * @param {string} server - Eik asset server URL to perform lookup against
+ * @param {string} type - Package type (pkg, npm, map)
+ * @param {string} name - Package name to lookup
+ *
+ * @returns {Promise<[number, {version: string, integrity: string}][]|null>}
+ *
+ * @throws Error
+ */
 declare function _default(server: string, type: string, name: string): Promise<[number, {
     version: string;
     integrity: string;
 }][] | null>;
-export default _default;

package/types/utils/json/write.d.ts

@@ -1,5 +1,22 @@
+export default _default;
+/**
+ * Utility function that can be used to write a JavaScript object to a file at a given location.
+ *
+ * @param {object} meta - JavaScript object to be written as JSON to a file
+ * @param {string|{cwd?:string,filename:string}} location - Path string or object describing location for where to write JSON to.
+ *                                   If location is a string it can be relative or absolute.
+ *                                   If location is an object, `pathname` must be given which can be relative or absolute. `cwd` can also be given to define the current working directory.
+ * @returns {Promise<undefined>}
+ *
+ * @example json.write({ key: 'value' }, '/path/to/file.json');
+ * @example json.write({ key: 'value' }, './relative/path/to/file.json');
+ * @example json.write({ key: 'value' }, { filename: '/path/to/file.json' });
+ * @example json.write({ key: 'value' }, { filename: './relative/path/to/file.json' });
+ * @example json.write({ key: 'value' }, { filename: './relative/path/to/file.json', cwd: '/path/to/cwd' });
+ *
+ * @throws Error
+ */
 declare function _default(meta: object | undefined, location: string | {
     cwd?: string;
     filename: string;
 }): Promise<undefined>;
-export default _default;

package/types/utils/url.d.ts

@@ -3,4 +3,4 @@
  * @param  {...string} parts
  * @returns {string}
  */
-export function joinUrlPathname(...parts: string[]): string;
+export declare function joinUrlPathname(...parts: string[]): string;