npm - @eik/node-client - Versions diffs - 1.1.64 → 1.2.1 - Mend

@eik/node-client 1.1.64 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,17 @@
+## [1.2.1](https://github.com/eik-lib/node-client/compare/v1.2.0...v1.2.1) (2024-10-16)
+### Bug Fixes
+* slugify image type ([#207](https://github.com/eik-lib/node-client/issues/207)) ([c0ed5e7](https://github.com/eik-lib/node-client/commit/c0ed5e787119657fa83647256a5f6179ccd24389))
+# [1.2.0](https://github.com/eik-lib/node-client/compare/v1.1.64...v1.2.0) (2024-10-15)
+### Features
+* add toHTML function ([4576ddd](https://github.com/eik-lib/node-client/commit/4576dddc88afb5722b80574438b03dc41956af72))
 ## [1.1.64](https://github.com/eik-lib/node-client/compare/v1.1.63...v1.1.64) (2024-08-30)

package/README.md CHANGED Viewed

@@ -200,13 +200,6 @@ const client = new Eik({
 await client.load();
 const maps = client.maps();
-const combined = maps.reduce((map, acc) => ({ ...acc, ...map }), {});
-const html = `
-<script type="importmap">
-${JSON.stringify(combined, null, 2)}
-</script>
-`;
 ```
 #### returns
@@ -257,6 +250,33 @@ await client.load();
 client.base(); // http://localhost:8080/assets
 ```
+### .toHTML()
+Constructs an HTML import map script tag for use in the document head when doing import mapping.
+```js
+const client = new Eik({
+	loadMaps: true,
+	...
+});
+await client.load();
+const html = `
+	<html>
+	<head>
+		...
+		${client.toHTML()}
+		...
+	</head>
+	<body>
+		...
+	</body>
+	</html>
+`;
+```
+Due to browsers being restricted to a single import map, all import maps registered in eik.json or package.json will be merged down into a single import map with last in winning in case of duplicate keys.
 ## License
 Copyright (c) 2021 FINN.no

package/dist/index.cjs CHANGED Viewed

@@ -238,7 +238,12 @@ class Eik {
 	 */
 	get pathname() {
 		if (this.#config.type && this.#config.name && this.#config.version)
-			return path.join("/", this.type, this.name, this.version).replace(/\\/g, "/");
+			return path.join(
+				"/",
+				common.helpers.typeSlug(this.type),
+				this.name,
+				this.version,
+			).replace(/\\/g, "/");
 		throw new Error("Eik config was not loaded before calling .pathname");
 	}
@@ -321,23 +326,12 @@ class Eik {
 	 *
 	 * @example
 	 * ```js
-	 * // generate a <script type="importmap">
-	 * // for import mapping in the browser
 	 * const client = new Eik({
 	 *   loadMaps: true,
 	 * });
 	 * await client.load();
 	 *
 	 * const maps = client.maps();
-	 * const combined = maps
-	 *   .map((map) => map.imports)
-	 *   .reduce((map, acc) => ({ ...acc, ...map }), {});
-	 *
-	 * const html = `
-	 * <script type="importmap">
-	 * ${JSON.stringify(combined, null, 2)}
-	 * </script>
-	 * `;
 	 * ```
 	 */
 	maps() {
@@ -346,6 +340,38 @@ class Eik {
 			'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;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@eik/node-client",
-  "version": "1.1.64",
+  "version": "1.2.1",
   "description": "Utilities for working with assets and import maps on an Eik server",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -52,13 +52,13 @@
     "@eik/prettier-config": "1.0.1",
     "@eik/semantic-release-config": "1.0.0",
     "@eik/typescript-config": "1.0.0",
-    "eslint": "9.8.0",
-    "npm-run-all": "4.1.5",
+    "eslint": "9.11.1",
+    "npm-run-all2": "5.0.2",
     "prettier": "3.3.3",
     "rimraf": "6.0.1",
-    "rollup": "4.20.0",
+    "rollup": "4.22.5",
     "semantic-release": "24.0.0",
-    "tap": "21.0.0",
+    "tap": "21.0.1",
     "typescript": "5.5.4"
   }
 }

package/src/index.js CHANGED Viewed

@@ -186,7 +186,12 @@ export default class Eik {
 	 */
 	get pathname() {
 		if (this.#config.type && this.#config.name && this.#config.version)
-			return join("/", this.type, this.name, this.version).replace(/\\/g, "/");
+			return join(
+				"/",
+				helpers.typeSlug(this.type),
+				this.name,
+				this.version,
+			).replace(/\\/g, "/");
 		throw new Error("Eik config was not loaded before calling .pathname");
 	}
@@ -269,23 +274,12 @@ export default class Eik {
 	 *
 	 * @example
 	 * ```js
-	 * // generate a <script type="importmap">
-	 * // for import mapping in the browser
 	 * const client = new Eik({
 	 *   loadMaps: true,
 	 * });
 	 * await client.load();
 	 *
 	 * const maps = client.maps();
-	 * const combined = maps
-	 *   .map((map) => map.imports)
-	 *   .reduce((map, acc) => ({ ...acc, ...map }), {});
-	 *
-	 * const html = `
-	 * <script type="importmap">
-	 * ${JSON.stringify(combined, null, 2)}
-	 * </script>
-	 * `;
 	 * ```
 	 */
 	maps() {
@@ -294,4 +288,36 @@ export default class Eik {
 			'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>`;
+	}
 }

package/types/index.d.ts CHANGED Viewed

@@ -175,26 +175,36 @@ export default class Eik {
      *
      * @example
      * ```js
-     * // generate a <script type="importmap">
-     * // for import mapping in the browser
      * const client = new Eik({
      *   loadMaps: true,
      * });
      * await client.load();
      *
      * const maps = client.maps();
-     * const combined = maps
-     *   .map((map) => map.imports)
-     *   .reduce((map, acc) => ({ ...acc, ...map }), {});
-     *
-     * const html = `
-     * <script type="importmap">
-     * ${JSON.stringify(combined, null, 2)}
-     * </script>
-     * `;
      * ```
      */
     maps(): ImportMap[];
+    /**
+     * 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(): string;
     #private;
 }
 export type Options = {