@eik/node-client 2.0.0-next.3 → 2.0.0-next.5

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [2.0.0-next.5](https://github.com/eik-lib/node-client/compare/v2.0.0-next.4...v2.0.0-next.5) (2022-09-23)
+
+
+### Features
+
+* add .mapping(dep) shorthand method to resolve mapped bare imports directly ([a557cfd](https://github.com/eik-lib/node-client/commit/a557cfdc56f4553f721d1a67a7670eafc284b565))
+
+# [2.0.0-next.4](https://github.com/eik-lib/node-client/compare/v2.0.0-next.3...v2.0.0-next.4) (2022-08-22)
+
+
+### Features
+
+* Remove support for CJS. ESM only ([#106](https://github.com/eik-lib/node-client/issues/106)) ([d74f8c8](https://github.com/eik-lib/node-client/commit/d74f8c8266b67119d8d110524533a0bd7ce19e7d))
+
+
+### BREAKING CHANGES
+
+* This PR removes the support for CJS in this module. This module is now ESM only.
+
+* feat: Remove CJS support. ESM only.
+* Support for CJS is now removed in this module. It is ESM only.
+
+* ci: use 0.0.0.0 instead of localhost
+
+* fix: remove console.log() statement
+
+Co-authored-by: Trygve Lie <trygve.lie@finn.no>
+
 # [2.0.0-next.3](https://github.com/eik-lib/node-client/compare/v2.0.0-next.2...v2.0.0-next.3) (2022-08-18)
 
 

package/README.md

@@ -187,6 +187,37 @@ If `integrity` of the file is not available, the value for `integrity` will be `
 
 Returns the import maps defined in Eik config from the Eik server. For the maps to be returned they need to be loaded from the Eik server. This is done by setting the `loadMaps` option on the constructor to `true`.
 
+### .mapping(identifier)
+
+Returns the last mapping entry for a given bare import `identifier`.
+`identifier` is a `string` key from an import map and the returned `string` is a the matching value from the same import map entry.
+
+#### arguments
+
+| option     | default | type     | required | details             |
+| ---------- | ------- | -------- | -------- | ------------------- |
+| identifier |         | `string` | `true`   | Bare import map key |
+
+**Example:**
+
+If an import map being used looks like:
+
+```json
+{
+    "imports": {
+        "react": "https://myserver.com/react/18.0.0/react.min.js"
+    }
+}
+```
+
+When the mapping method is called:
+
+```js
+const absoluteURL = client.mapping('react');
+```
+
+`absoluteURL` will be `https://myserver.com/react/18.0.0/react.min.js`
+
 ## License
 
 Copyright (c) 2021 FINN.no

package/package.json

@@ -1,26 +1,19 @@
 {
   "name": "@eik/node-client",
-  "version": "2.0.0-next.3",
+  "version": "2.0.0-next.5",
   "description": "A node.js client for interacting with a Eik server.",
   "type": "module",
-  "main": "./dist/index.cjs",
-  "exports": {
-    "import": "./src/index.js",
-    "require": "./dist/index.cjs"
-  },
+  "main": "./src/index.js",
   "files": [
     "CHANGELOG.md",
     "package.json",
     "LICENSE",
-    "dist",
     "src"
   ],
   "scripts": {
     "test": "tap --no-coverage",
     "lint:fix": "eslint --fix .",
-    "lint": "eslint .",
-    "prepare": "npm run -s build",
-    "build": "rollup -c"
+    "lint": "eslint ."
   },
   "repository": {
     "type": "git",
@@ -50,7 +43,6 @@
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.2.1",
     "prettier": "2.7.1",
-    "rollup": "2.77.2",
     "semantic-release": "19.0.3",
     "tap": "16.3.0",
     "@babel/eslint-parser": "7.18.9"

package/src/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-restricted-syntax */
 import { request } from 'undici';
 import { join } from 'path';
 import loader from '@eik/common-config-loader';
@@ -6,16 +7,15 @@ import Asset from './asset.js';
 const trimSlash = (value = '') => {
     if (value.endsWith('/')) return value.substring(0, value.length - 1);
     return value;
-}
+};
 
 const fetchImportMaps = async (urls = []) => {
-    try{
+    try {
         const maps = urls.map(async (map) => {
-            const {
-                statusCode,
-                body
-            } = await request(map, { maxRedirections: 2 });
-            
+            const { statusCode, body } = await request(map, {
+                maxRedirections: 2,
+            });
+
             if (statusCode === 404) {
                 throw new Error('Import map could not be found on server');
             } else if (statusCode >= 400 && statusCode < 500) {
@@ -31,7 +31,7 @@ const fetchImportMaps = async (urls = []) => {
             `Unable to load import map file from server: ${err.message}`,
         );
     }
-}
+};
 
 export default class NodeClient {
     #development;
@@ -83,7 +83,8 @@ export default class NodeClient {
     }
 
     get pathname() {
-        if (this.#config.type && this.#config.name && this.#config.version) return join('/', this.type, this.name, this.version);
+        if (this.#config.type && this.#config.name && this.#config.version)
+            return join('/', this.type, this.name, this.version);
         throw new Error('Eik config was not loaded before calling .pathname');
     }
 
@@ -101,6 +102,16 @@ export default class NodeClient {
 
     maps() {
         if (this.#config.version && this.#loadMaps) return this.#maps;
-        throw new Error('Eik config was not loaded or "loadMaps" is "false" when calling .maps()');
+        throw new Error(
+            'Eik config was not loaded or "loadMaps" is "false" when calling .maps()',
+        );
+    }
+
+    mapping(dependency) {
+        let mapping = null;
+        for (const map of this.maps()) {
+            if (map?.imports[dependency]) mapping = map.imports[dependency];
+        }
+        return mapping;
     }
 }

package/dist/index.cjs

@@ -1,122 +0,0 @@
-'use strict';
-
-var undici = require('undici');
-var path = require('path');
-var loader = require('@eik/common-config-loader');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var loader__default = /*#__PURE__*/_interopDefaultLegacy(loader);
-
-class Asset {
-    constructor({
-        value = '',
-    } = {}) {
-        this.integrity = undefined;
-        this.value = value;
-    }
-}
-
-const trimSlash = (value = '') => {
-    if (value.endsWith('/')) return value.substring(0, value.length - 1);
-    return value;
-};
-
-const fetchImportMaps = async (urls = []) => {
-    try{
-        const maps = urls.map(async (map) => {
-            const {
-                statusCode,
-                body
-            } = await undici.request(map, { maxRedirections: 2 });
-            
-            if (statusCode === 404) {
-                throw new Error('Import map could not be found on server');
-            } else if (statusCode >= 400 && statusCode < 500) {
-                throw new Error('Server rejected client request');
-            } else if (statusCode >= 500) {
-                throw new Error('Server error');
-            }
-            return body.json();
-        });
-        return await Promise.all(maps);
-    } catch (err) {
-        throw new Error(
-            `Unable to load import map file from server: ${err.message}`,
-        );
-    }
-};
-
-class NodeClient {
-    #development;
-    #loadMaps;
-    #config;
-    #path;
-    #base;
-    #maps;
-    constructor({
-        development = false,
-        loadMaps = false,
-        base = '',
-        path = process.cwd(),
-    } = {}) {
-        this.#development = development;
-        this.#loadMaps = loadMaps;
-        this.#config = {};
-        this.#path = path;
-        this.#base = trimSlash(base);
-        this.#maps = [];
-    }
-
-    async load() {
-        this.#config = await loader__default["default"].getDefaults(this.#path);
-        if (this.#loadMaps) {
-            this.#maps = await fetchImportMaps(this.#config.map);
-        }
-    }
-
-    get name() {
-        if (this.#config.name) return this.#config.name;
-        throw new Error('Eik config was not loaded before calling .name');
-    }
-
-    get version() {
-        if (this.#config.version) return this.#config.version;
-        throw new Error('Eik config was not loaded before calling .version');
-    }
-
-    get type() {
-        if (this.#config.type && this.#config.type === 'package') return 'pkg';
-        if (this.#config.type) return this.#config.type;
-        throw new Error('Eik config was not loaded before calling .type');
-    }
-
-    get server() {
-        if (this.#config.server) return this.#config.server;
-        throw new Error('Eik config was not loaded before calling .server');
-    }
-
-    get pathname() {
-        if (this.#config.type && this.#config.name && this.#config.version) return path.join('/', this.type, this.name, this.version);
-        throw new Error('Eik config was not loaded before calling .pathname');
-    }
-
-    base() {
-        if (this.#development) return this.#base;
-        return `${this.server}${this.pathname}`;
-    }
-
-    file(file = '') {
-        const base = this.base();
-        return new Asset({
-            value: `${base}${file}`,
-        });
-    }
-
-    maps() {
-        if (this.#config.version && this.#loadMaps) return this.#maps;
-        throw new Error('Eik config was not loaded or "loadMaps" is "false" when calling .maps()');
-    }
-}
-
-module.exports = NodeClient;