@eik/node-client 2.0.27 → 2.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.1.1](https://github.com/eik-lib/node-client/compare/v2.1.0...v2.1.1) (2026-06-08)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @eik/common to v5.1.31 ([#280](https://github.com/eik-lib/node-client/issues/280)) ([5a58f9e](https://github.com/eik-lib/node-client/commit/5a58f9e88bc8d37c8951f617269ad040b3dd6ffa))
+
+# [2.1.0](https://github.com/eik-lib/node-client/compare/v2.0.27...v2.1.0) (2026-06-03)
+
+
+### Features
+
+* Remove CommonJS build ([#279](https://github.com/eik-lib/node-client/issues/279)) ([8d0d75b](https://github.com/eik-lib/node-client/commit/8d0d75b5fd5bd9f9aa49769582f56acbe5d890b6))
+
 ## [2.0.27](https://github.com/eik-lib/node-client/compare/v2.0.26...v2.0.27) (2026-05-29)
 
 

package/package.json

@@ -1,33 +1,28 @@
 {
   "name": "@eik/node-client",
-  "version": "2.0.27",
+  "version": "2.1.1",
   "description": "Utilities for working with assets and import maps on an Eik server",
   "type": "module",
-  "main": "./dist/index.cjs",
   "types": "./types/index.d.ts",
   "exports": {
     "types": "./types/index.d.ts",
-    "import": "./src/index.js",
-    "require": "./dist/index.cjs"
+    "import": "./src/index.js"
   },
   "files": [
     "CHANGELOG.md",
     "package.json",
     "LICENSE",
-    "dist",
     "src",
     "types"
   ],
   "scripts": {
-    "build": "rollup -c",
-    "clean": "node --input-type=module --eval \"import{rmSync}from'node:fs';['.tap','dist','node_modules','types'].forEach(p=>rmSync(p,{recursive:true,force:true}))\"",
+    "clean": "node --input-type=module --eval \"import{rmSync}from'node:fs';['.tap','node_modules','types'].forEach(p=>rmSync(p,{recursive:true,force:true}))\"",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "node --test 'test/*.test.js'",
     "types": "run-s types:module types:test",
     "types:module": "tsc",
-    "types:test": "tsc --project tsconfig.test.json",
-    "prepare": "npm run -s build"
+    "types:test": "tsc --project tsconfig.test.json"
   },
   "repository": {
     "type": "git",
@@ -43,7 +38,7 @@
   },
   "homepage": "https://github.com/eik-lib/node-client#readme",
   "dependencies": {
-    "@eik/common": "5.1.29",
+    "@eik/common": "5.1.31",
     "abslog": "2.4.4"
   },
   "devDependencies": {
@@ -52,10 +47,9 @@
     "@eik/semantic-release-config": "1.0.17",
     "@eik/typescript-config": "1.0.2",
     "@types/node": "25.9.1",
-    "eslint": "10.4.0",
+    "eslint": "10.4.1",
     "npm-run-all2": "9.0.1",
     "prettier": "3.8.3",
-    "rollup": "4.60.4",
     "semantic-release": "25.0.3",
     "typescript": "6.0.3"
   }

package/dist/index.cjs

@@ -1,359 +0,0 @@
-'use strict';
-
-var common = require('@eik/common');
-var node_path = require('node:path');
-
-/**
- * @typedef {object} AssetOptions
- * @property {string} [value=""]
- */
-
-/**
- * Holds attributes for use when linking to assets hosted on Eik.
- *
- * @example
- * ```
- * // JS and <script>
- * const script = eik.file("/app.js");
- * const html = `<script
- *   src="${script.value}"
- *   ${script.integrity ? `integrity="${script.integrity}"` : ""}
- *   type="module"></script>`;
- * ```
- * @example
- * ```
- * // CSS and <link>
- * const styles = eik.file("/styles.css");
- * const html = `<link
- *   href="${styles.value}"
- *   ${styles.integrity ? `integrity="${styles.integrity}"` : ""}
- *   rel="stylesheet" />`;
- * ```
- */
-class Asset {
-	/**
-	 * Value for use in [subresource integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity#examples).
-	 * Not calculated if `development` is `true`.
-	 *
-	 * @type {string | undefined}
-	 */
-	integrity = undefined;
-
-	/**
-	 * URL to the file for use in `<script>` or `<link>`.
-	 * @type {string}
-	 */
-	value;
-
-	/**
-	 * @param {AssetOptions} options
-	 */
-	constructor({ value = "" } = {}) {
-		this.integrity = undefined;
-		this.value = value;
-	}
-}
-
-const trimSlash = (value = "") => {
-	if (value.endsWith("/")) return value.substring(0, value.length - 1);
-	return value;
-};
-
-/**
- * @typedef {object} Options
- * @property {string} [base=null]
- * @property {boolean} [development=false]
- * @property {boolean} [loadMaps=false]
- * @property {string} [path=process.cwd()]
- */
-
-/**
- * @typedef {object} ImportMap
- * @property {Record<string, string>} imports
- */
-
-/**
- * An Eik utility for servers running on Node. With it you can:
- *  - generate different URLs to assets on an Eik server depending on environment (development vs production).
- *  - get the import maps you have configured in `eik.json` from the Eik server, should you want to use them in the HTML response.
- *
- * @example
- * ```js
- * // Create an instance, then load information from `eik.json` and the Eik server
- * import Eik from "@eik/node-client";
- *
- * const eik = new Eik();
- * await eik.load();
- * ```
- * @example
- * ```js
- * // Serve a local version of a file from `./public`
- * // in development and from Eik in production
- * import path from "node:path";
- * import Eik from "@eik/node-client";
- * import fastifyStatic from "@fastify/static";
- * import fastify from "fastify";
- *
- * const app = fastify();
- * app.register(fastifyStatic, {
- *    root: path.join(process.cwd(), "public"),
- *    prefix: "/public/",
- * });
- *
- * const eik = new Eik({
- *    development: process.env.NODE_ENV === "development",
- *    base: "/public",
- * });
- *
- * // load information from `eik.json` and the Eik server
- * await eik.load();
- *
- * // when development is true script.value will be /public/script.js.
- * // when development is false script.value will be
- * // https://{server}/pkg/{name}/{version}/script.js
- * // where {server}, {name} and {version} are read from eik.json
- * const script = eik.file("/script.js");
- *
- * app.get("/", (req, reply) => {
- *    reply.type("text/html; charset=utf-8");
- *    reply.send(`<html><body>
- *      <script
- *        src="${script.value}"
- *        ${script.integrity ? `integrity="${script.integrity}"` : ""}
- *        type="module"></script>
- *    </body></html>`);
- * });
- *
- * app.listen({
- *    port: 3000,
- * });
- *
- * console.log("Listening on http://localhost:3000");
- * ```
- */
-class Eik {
-	#development;
-	#loadMaps;
-	/** @type {import('@eik/common').EikConfig | null} */
-	#config = null;
-	#path;
-	#base;
-	/** @type {ImportMap[]} */
-	#maps = [];
-
-	/**
-	 * @param {Options} options
-	 */
-	constructor({
-		development = false,
-		loadMaps = false,
-		base = "",
-		path = process.cwd(),
-	} = {}) {
-		this.#development = development;
-		this.#loadMaps = loadMaps;
-		this.#path = path;
-		this.#base = trimSlash(base);
-	}
-
-	/**
-	 * Reads the Eik config from disk into the object instance, used for building {@link file} links in production.
-	 *
-	 * If {@link Options.loadMaps} is `true` the import maps
-	 * defined in the Eik config will be fetched from the Eik server for
-	 * use in {@link maps}.
-	 */
-	async load() {
-		this.#config = common.helpers.getDefaults(this.#path);
-		if (this.#loadMaps && this.#config) {
-			this.#maps = await common.helpers.fetchImportMaps(this.#config.map);
-		}
-	}
-
-	/**
-	 * The `"name"` field from the Eik config
-	 * @throws if read before calling {@link load}
-	 */
-	get name() {
-		if (this.#config && this.#config.name) return this.#config.name;
-		throw new Error("Eik config was not loaded before calling .name");
-	}
-
-	/**
-	 * The `"version"` field from the Eik config
-	 * @throws if read before calling {@link load}
-	 */
-	get version() {
-		if (this.#config && this.#config.version) return this.#config.version;
-		throw new Error("Eik config was not loaded before calling .version");
-	}
-
-	/**
-	 * The `"type"` field from the Eik config mapped to its URL equivalent (eg. "package" is "pkg").
-	 * @throws if read before calling {@link load}
-	 */
-	get type() {
-		if (this.#config && this.#config.type && this.#config.type === "package")
-			return "pkg";
-		if (this.#config && this.#config.type) return this.#config.type;
-		throw new Error("Eik config was not loaded before calling .type");
-	}
-
-	/**
-	 * The `"server"` field from the Eik config
-	 * @throws if read before calling {@link load}
-	 */
-	get server() {
-		if (this.#config && this.#config.server) return this.#config.server;
-		throw new Error("Eik config was not loaded before calling .server");
-	}
-
-	/**
-	 * The pathname to the base on Eik (ex. /pkg/my-app/1.0.0/)
-	 * @throws if read before calling {@link load}
-	 */
-	get pathname() {
-		if (
-			this.#config &&
-			this.#config.type &&
-			this.#config.name &&
-			this.#config.version
-		)
-			return node_path.join(
-				"/",
-				common.helpers.typeSlug(this.type),
-				this.name,
-				this.version,
-			).replace(/\\/g, "/");
-		throw new Error("Eik config was not loaded before calling .pathname");
-	}
-
-	/**
-	 * Similar to {@link file}, this method returns a path to the base on Eik
-	 * (ex. https://eik.store.com/pkg/my-app/1.0.0), or {@link Options.base}
-	 * if {@link Options.development} is true.
-	 *
-	 * You can use this instead of `file` if you have a directory full of files
-	 * and you don't need {@link Asset.integrity}.
-	 *
-	 * @returns {string} The base path for assets published on Eik
-	 * @throws when {@link Options.development} is false if called before calling {@link load}
-	 */
-	base() {
-		if (this.#development) return this.#base;
-		return `${this.server}${this.pathname}`;
-	}
-
-	/**
-	 * Get a link to a file that is published on Eik when running in production.
-	 * When {@link Options.development} is `true` the pathname is prefixed
-	 * with the {@link Options.base} option instead of pointing to Eik.
-	 *
-	 * @param {string} pathname pathname to the file relative to the base on Eik (ex: /path/to/script.js for a prod URL https://eik.store.com/pkg/my-app/1.0.0/path/to/script.js)
-	 * @returns {import('./asset.js').Asset}
-	 * @throws when {@link Options.development} is false if called before calling {@link load}
-	 *
-	 * @example
-	 * ```js
-	 * // in production
-	 * const eik = new Eik({
-	 *   development: false,
-	 * });
-	 * await eik.load();
-	 *
-	 * const file = eik.file("/path/to/script.js");
-	 * // {
-	 * //   value: https://eik.store.com/pkg/my-app/1.0.0/path/to/script.js
-	 * //   integrity: sha512-zHQjnD-etc.
-	 * // }
-	 * // where the server URL, app name and version are read from eik.json
-	 * // {
-	 * //   "name": "my-app",
-	 * //   "version": "1.0.0",
-	 * //   "server": "https://eik.store.com",
-	 * // }
-	 * ```
-	 * @example
-	 * ```js
-	 * // in development
-	 * const eik = new Eik({
-	 *   development: true,
-	 *   base: "/public",
-	 * });
-	 * await eik.load();
-	 *
-	 * const file = eik.file("/path/to/script.js");
-	 * // {
-	 * //   value: /public/path/to/script.js
-	 * //   integrity: undefined
-	 * // }
-	 * ```
-	 */
-	file(pathname = "") {
-		const base = this.base();
-		return new Asset({
-			value: `${base}${pathname}`,
-		});
-	}
-
-	/**
-	 * When {@link Options.loadMaps} is `true` and you call {@link load}, the client
-	 * fetches the configured import maps from the Eik server.
-	 *
-	 * This method returns the import maps that were fetched during `load`.
-	 *
-	 * @returns {ImportMap[]}
-	 * @throws if {@link Options.loadMaps} is not `true` or called before calling {@link load}
-	 *
-	 * @example
-	 * ```js
-	 * const client = new Eik({
-	 *   loadMaps: true,
-	 * });
-	 * await client.load();
-	 *
-	 * const maps = client.maps();
-	 * ```
-	 */
-	maps() {
-		if (this.#config && this.#config.version && this.#loadMaps)
-			return this.#maps;
-		throw new Error(
-			'Eik config was not loaded or "loadMaps" is "false" when calling .maps()',
-		);
-	}
-
-	/**
-	 * Function that generates and returns an import map script tag for use in an document head.
-	 *
-	 * Only a single import map is allowed per HTML document.
-	 * A key (ex. `react`) can only be defined once.
-	 * If multiple import maps defined in `eik.json` use the same key, the last key wins.
-	 *
-	 * @example
-	 * ```
-	 * const importMap = eik.toHTML();
-	 *
-	 * <head>
-	 *   ...
-	 *   ${importMap}
-	 *   ...
-	 * </head>
-	 * ```
-	 *
-	 * @returns {string}
-	 */
-	toHTML() {
-		const allImportMapKeyValuePairs = this.maps().flatMap((map) =>
-			Object.entries(map.imports),
-		);
-		const mergedAndDedupedImportMapObject = Object.fromEntries(
-			new Map(allImportMapKeyValuePairs).entries(),
-		);
-		return `<script type="importmap">${JSON.stringify({
-			imports: mergedAndDedupedImportMapObject,
-		})}</script>`;
-	}
-}
-
-module.exports = Eik;