@eik/common 2.0.3 → 3.0.1

package/lib/classes/resolved-files.js

@@ -0,0 +1,56 @@
+/**
+ * @type {(value: unknown, message?: string) => asserts value}
+ */
+const assert = require('assert');
+const LocalFileLocation = require('./local-file-location');
+const {
+    removeLeadingSlash,
+    removeTrailingSlash,
+} = require('../helpers/path-slashes');
+
+const originalFiles = Symbol('files');
+
+class ResolvedFiles {
+    /**
+     * @param {string[]} files
+     * @param {{definition: [string, string], basePath: string, pattern: string}} meta
+     */
+    constructor(files, meta) {
+        assert(Array.isArray(files), '"files" must be an array');
+        assert(meta, '"meta" must be defined');
+        assert(
+            typeof meta.basePath,
+            '"meta.basePath" must be a non empty string',
+        );
+        assert(
+            typeof meta.pattern,
+            '"meta.pattern" must be a non empty string',
+        );
+        assert(
+            Array.isArray(meta.definition),
+            '"meta.definition" must be an array',
+        );
+        assert(
+            meta.definition.length === 2,
+            '"meta.definition" must be an array of length 2',
+        );
+
+        const [destination, source] = meta.definition;
+        this[originalFiles] = files;
+        this.destination = destination;
+        this.source = source;
+        this.basePath = meta.basePath;
+        this.pattern = meta.pattern;
+    }
+
+    *[Symbol.iterator]() {
+        for (const file of this[originalFiles]) {
+            const relative = removeTrailingSlash(
+                removeLeadingSlash(file.replace(this.basePath, '')),
+            );
+            yield new LocalFileLocation(relative, this.basePath);
+        }
+    }
+}
+
+module.exports = ResolvedFiles;

package/lib/classes/single-dest-multiple-source-error.js

@@ -1,6 +1,9 @@
 const CustomError = require('./custom-error');
 
 module.exports = class SingleDestMultipleSourcesError extends CustomError {
+    /**
+     * @param {string} destFilePath
+     */
     constructor(destFilePath) {
         super(
             `Cannot specify a single file destination for multiple source files. See '${destFilePath}'`,

package/lib/helpers/config-store.js

@@ -7,10 +7,17 @@ const MissingConfigError = require('../classes/missing-config-error');
 const MultipleConfigSourcesError = require('../classes/multiple-config-sources-error');
 const InvalidConfigError = require('../classes/invalid-config-error');
 
+/**
+ * Read a file at a given path and parse it
+ *
+ * @param {string} path
+ *
+ * @returns {object}
+ */
 function readJSONFromDisk(path) {
     let fileData;
     try {
-        fileData = readFileSync(path);
+        fileData = readFileSync(path, { encoding: 'utf8' });
     } catch (e) {
         return null;
     }
@@ -53,16 +60,26 @@ module.exports = {
         const config = new EikConfig(assets, eikrc.tokens, configRootDir);
         try {
             config.validate();
-        } catch(err) {
-            throw new InvalidConfigError(`config.findInDirectory operation failed: ${err.message}`);
+        } catch (err) {
+            throw new InvalidConfigError(
+                `config.findInDirectory operation failed: ${err.message}`,
+            );
         }
         return config;
     },
+
+    /**
+     * Persist config changes to disk as <cwd>/eik.json
+     *
+     * @param {import('../classes/eik-config')} config
+     */
     persistToDisk(config) {
         try {
             config.validate();
-        } catch(err) {
-            throw new InvalidConfigError(`config.persistToDisk operation failed: ${err.message}`);
+        } catch (err) {
+            throw new InvalidConfigError(
+                `config.persistToDisk operation failed: ${err.message}`,
+            );
         }
         const dest = join(config.cwd, 'eik.json');
         writeFileSync(dest, JSON.stringify(config, null, 2));

package/lib/helpers/get-defaults.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 'use strict';
 
 const configStore = require('./config-store');
@@ -8,14 +10,14 @@ const EikConfig = require('../classes/eik-config');
  *
  * @param {string} cwd The current working directory
  *
- * @returns {{server:string,token:string,js:string|object,css:string|object,version:string,map:Array,name:string,out:string,cwd:string}}
+ * @returns {import("../classes/eik-config")} EikConfig
  */
 module.exports = function getDefaults(cwd) {
     try {
         return configStore.findInDirectory(cwd);
     } catch (e) {
         if (e.constructor.name === 'MissingConfigError') {
-            return new EikConfig({}, [], cwd);
+            return new EikConfig(null, [], cwd);
         }
         throw e;
     }

package/lib/helpers/index.js

@@ -1,6 +1,25 @@
 const localAssets = require('./local-assets');
-const packageURL = require('./package-url');
 const getDefaults = require('./get-defaults');
 const configStore = require('./config-store');
+const typeSlug = require('./type-slug');
+const typeTitle = require('./type-title');
+const resolveFiles = require('./resolve-files');
+const {
+    addTrailingSlash,
+    removeTrailingSlash,
+    addLeadingSlash,
+    removeLeadingSlash,
+} = require('./path-slashes');
 
-module.exports = { localAssets, packageURL, getDefaults, configStore };
+module.exports = {
+    localAssets,
+    getDefaults,
+    configStore,
+    typeSlug,
+    typeTitle,
+    addTrailingSlash,
+    removeTrailingSlash,
+    addLeadingSlash,
+    removeLeadingSlash,
+    resolveFiles,
+};

package/lib/helpers/local-assets.js

@@ -1,64 +1,60 @@
 /* eslint-disable no-await-in-loop */
 
+/**
+ * @type {(value: unknown, message?: string) => asserts value}
+ */
 const assert = require('assert');
-const { join, extname, basename } = require('path');
 const fs = require('fs');
-const configStore = require("./config-store")
+const configStore = require('./config-store');
 
 /**
  * Sets up asset routes for local development. Mounted paths match those on Eik server and values are read from projects eik.json file.
- * 
+ *
  * @param {object} app - express js or fastify app instance
  * @param {string} rootEikDirectory - (optional) path to folder where eik configuration file can be found
  */
-async function localAssets(
-    app,
-    rootEikDirectory = process.cwd(),
-) {
-    assert(app.decorateReply || app.name === 'app', 'App must be an Express or Fastify app instance');
-    assert(typeof rootEikDirectory === 'string' && rootEikDirectory, 'Path to folder for eik config must be provided and must be of type string');
+async function localAssets(app, rootEikDirectory = process.cwd()) {
+    assert(
+        app.decorateReply || app.name === 'app' || app.route,
+        'App must be an Express, Fastify or Hapi app instance',
+    );
+    assert(
+        typeof rootEikDirectory === 'string' && rootEikDirectory,
+        'Path to folder for eik config must be provided and must be of type string',
+    );
     // ensure eik.json only loaded 1x
     const eik = configStore.findInDirectory(rootEikDirectory);
 
-    (await eik.pathsAndFiles()).forEach(([pathname, filePath]) => {
-        const ext = extname(filePath);
-        const pathnameHasExt = !!extname(pathname);
-        const value = pathnameHasExt
-            ? join(`/pkg/${eik.name}/${eik.version}`, pathname)
-            : join(
-                    `/pkg/${eik.name}/${eik.version}`,
-                    pathname,
-                    basename(filePath),
-                );
-        const fileOnDisk = join(eik.cwd, filePath);
-        let contentType;
-        switch (ext) {
-            case '.js':
-                contentType = 'application/javascript';
-                break;
-            case '.map':
-            case '.json':
-                contentType = 'application/json';
-                break;
-            case '.css':
-                contentType = 'text/css';
-                break;
-            default:
-                contentType = 'application/octet-stream';
+    (await eik.mappings()).forEach((mapping) => {
+        const { pathname } = mapping.destination.url;
+        const { contentType, absolute: path } = mapping.source;
+        if (app.get) {
+            app.get(pathname, (req, res) => {
+                if (res.set) {
+                    // express
+                    res.set('Access-Control-Allow-Origin', '*');
+                    res.set('content-type', contentType);
+                    fs.createReadStream(path).pipe(res);
+                } else if (res.type) {
+                    // fastify
+                    res.header('Access-Control-Allow-Origin', '*');
+                    res.type(contentType);
+                    res.send(fs.createReadStream(path));
+                }
+            });
+        } else {
+            // hapi
+            app.route({
+                method: 'GET',
+                path: pathname,
+                handler(req, h) {
+                    return h
+                        .response(fs.createReadStream(path))
+                        .header('Access-Control-Allow-Origin', '*')
+                        .type(contentType);
+                },
+            });
         }
-        app.get(value, (req, res) => {
-            if (res.set) {
-                // express
-                res.set('Access-Control-Allow-Origin', '*');
-                res.set('content-type', contentType);
-                fs.createReadStream(fileOnDisk).pipe(res);
-            } else if (res.type) {
-                // fastify
-                res.header('Access-Control-Allow-Origin', '*');
-                res.type(contentType);
-                res.send(fs.createReadStream(fileOnDisk));
-            }
-        });
-    })
+    });
 }
 module.exports = localAssets;

package/lib/helpers/path-slashes.js

@@ -0,0 +1,43 @@
+/**
+ * Add a trailing slash to a path if necessary
+ *
+ * @param {string} val
+ *
+ * @returns {string}
+ */
+const addTrailingSlash = (val) => (val.endsWith('/') ? val : `${val}/`);
+
+/**
+ * Remove a trailing slash from a path if necessary
+ *
+ * @param {string} val
+ *
+ * @returns {string}
+ */
+const removeTrailingSlash = (val) =>
+    val.endsWith('/') ? val.substr(0, val.length - 1) : val;
+
+/**
+ * Add a leading slash to a path if necessary
+ *
+ * @param {string} val
+ *
+ * @returns {string}
+ */
+const addLeadingSlash = (val) => (val.startsWith('/') ? val : `/${val}`);
+
+/**
+ * Remove a leading slash from a path if necessary
+ *
+ * @param {string} val
+ *
+ * @returns {string}
+ */
+const removeLeadingSlash = (val) => (val.startsWith('/') ? val.substr(1) : val);
+
+module.exports = {
+    addTrailingSlash,
+    removeTrailingSlash,
+    addLeadingSlash,
+    removeLeadingSlash,
+};

package/lib/helpers/resolve-files.js

@@ -0,0 +1,81 @@
+/* eslint-disable no-continue */
+
+const { promisify } = require('util');
+const { extname, join, isAbsolute, basename, sep, normalize } = require('path');
+const isGlob = require('is-glob');
+const glob = promisify(require('glob'));
+const {
+    removeTrailingSlash,
+    addLeadingSlash,
+    removeLeadingSlash,
+} = require('./path-slashes');
+const ResolvedFiles = require('../classes/resolved-files');
+
+/**
+ * Create a new path from a path string preceeding a glob or the whole path if no glob is found
+ *
+ * @param {string} path
+ * @returns {string} modified path
+ */
+const pathUntilGlob = (path) => {
+    const segments = (path || '').split(sep);
+    const segmentsToKeep = [];
+    for (const segment of segments) {
+        if (segment === '.') continue;
+        if (segment === '') continue;
+        if (isGlob(segment)) break;
+        segmentsToKeep.push(segment);
+    }
+    return addLeadingSlash(normalize(segmentsToKeep.join(sep)));
+};
+
+/**
+ * Uses an Eik JSON "files" definition to resolve files on disk into a data structure
+ *
+ * @param {{[k: string]: string;}} files
+ * @param {string} cwd
+ *
+ * @returns {Promise<ResolvedFiles[]>}
+ */
+const resolveFiles = async (files, cwd) =>
+    Promise.all(
+        Object.entries(files).map(async (definition) => {
+            const [, source] = definition;
+            // normalise to absolute path
+            let pattern = isAbsolute(source) ? source : join(cwd, source);
+
+            // append glob if folder
+            if (extname(pattern) === '' && isGlob(pattern) === false) {
+                pattern = join(pattern, '/**/*');
+            }
+
+            // trim off any glob
+            let basePath = pathUntilGlob(pattern);
+
+            // fix basePath if file
+            if (extname(pattern) !== '') {
+                basePath = removeTrailingSlash(
+                    basePath.replace(basename(pattern), ''),
+                );
+            }
+
+            // process glob pattern into a list of existing files
+            const resolvedFiles = await glob(pattern, {
+                cwd: basePath,
+                nodir: true,
+            });
+
+            // trim off the basePath to create a relative pathed pattern
+            pattern = removeTrailingSlash(
+                removeLeadingSlash(pattern.replace(basePath, '')),
+            );
+
+            return new ResolvedFiles(resolvedFiles, {
+                definition,
+                basePath,
+                pattern,
+            });
+        }),
+    );
+
+module.exports = resolveFiles;

package/lib/helpers/type-slug.js

@@ -0,0 +1,6 @@
+// @ts-check
+
+module.exports = (type) => {
+    if (type === 'package') return 'pkg';
+    return type;
+};

package/lib/helpers/type-title.js

@@ -0,0 +1,7 @@
+// @ts-check
+
+module.exports = (type) => {
+    if (type === 'package') return 'PACKAGE';
+    if (type === 'npm') return 'NPM';
+    return 'MAP';
+};

package/lib/schemas/assert.js

@@ -1,4 +1,4 @@
-'use strict';
+// @ts-check
 
 const {
     eikJSON,
@@ -12,19 +12,21 @@ const {
 } = require('./validate');
 const ValidationError = require('./validation-error');
 
-const assert = (validate, message) => value => {
-        const valid = validate(value);
-        if (valid.error) {
-            const errorMessage = valid.error.map(err => {
+const assert = (validate, message) => (value) => {
+    const valid = validate(value);
+    if (valid.error) {
+        const errorMessage = valid.error
+            .map((err) => {
                 let msg = err.message;
                 if (err.params && err.params.allowedValues) {
                     msg += ` ("${err.params.allowedValues.join('", ')}")`;
                 }
                 return msg;
-            }).join(',');
-            throw new ValidationError(`${message}: ${errorMessage}`);
-        }
-    };
+            })
+            .join(',');
+        throw new ValidationError(`${message}: ${errorMessage}`, valid.error);
+    }
+};
 
 module.exports = {
     eikJSON: assert(eikJSON, 'Invalid eik.json schema'),

package/lib/schemas/eikjson.schema.json

@@ -27,11 +27,16 @@
     },
     "files": {
       "description": "File mapping definition for the package. Keys represent files or paths to be created on the Eik Server. Values represent paths to local files to be published.",
-      "type": "object",
-      "minProperties": 1,
-      "additionalProperties": {
-        "type": "string"
-      }
+      "oneOf": [
+        {
+          "type": "object",
+          "minProperties": 1,
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        { "type": "string", "minLength": 1 }
+      ]
     },
     "import-map": {
       "description": "Import map files given by URL(s) to be used during package bundling. Specified as a URL or array of URLs. URLs are locations of import map files that follow the W3C import map spec.",

package/lib/schemas/index.js

@@ -1,4 +1,4 @@
-'use strict';
+// @ts-check
 
 const schema = require('./eikjson.schema.json');
 const validate = require('./validate');

package/lib/schemas/validate.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const formats = require('ajv-formats');
 const semver = require('semver');
 const npmPkg = require('validate-npm-package-name');
@@ -9,6 +7,7 @@ const eikJSONSchema = require('./eikjson.schema.json');
 
 const createValidator = (schema, ajvOptions) => {
     const ajv = new Ajv(ajvOptions);
+    // @ts-ignore
     formats(ajv); // Needed to support "uri"
     const validate = ajv.compile({
         $schema: 'http://json-schema.org/schema#',

package/lib/schemas/validation-error.js

@@ -1,6 +1,10 @@
-'use strict';
+// @ts-check
 
 class ValidationError extends Error {
+    /**
+     * @param {string} message
+     * @param {Error} err
+     */
     constructor(message, err) {
         let m = message;
         if (err && err.message) m += `: ${err.message}`;
@@ -9,4 +13,4 @@ class ValidationError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-module.exports = ValidationError;
+module.exports = ValidationError;

package/lib/stream.js

@@ -1,7 +1,14 @@
 'use strict';
 
-const isStream = (stream) => stream !== null && typeof stream === 'object' && typeof stream.pipe === 'function';
+const isStream = (stream) =>
+    stream !== null &&
+    typeof stream === 'object' &&
+    typeof stream.pipe === 'function';
 module.exports.isStream = isStream;
 
-const isReadableStream = (stream) => isStream(stream) && stream.readable !== false && typeof stream._read === 'function' && typeof stream._readableState === 'object';
+const isReadableStream = (stream) =>
+    isStream(stream) &&
+    stream.readable !== false &&
+    typeof stream._read === 'function' &&
+    typeof stream._readableState === 'object';
 module.exports.isReadableStream = isReadableStream;

package/lib/validators/index.js

@@ -3,7 +3,7 @@
 const semver = require('semver');
 const npmPkg = require('validate-npm-package-name');
 
-const origin = value => {
+const origin = (value) => {
     if (new RegExp('^https?://[a-zA-Z0-9-_./]+(:[0-9]+)?').test(value)) {
         return value.toLowerCase();
     }
@@ -11,7 +11,7 @@ const origin = value => {
 };
 module.exports.origin = origin;
 
-const org = value => {
+const org = (value) => {
     if (/^[a-zA-Z0-9_-]+$/.test(value)) {
         return value.toLowerCase();
     }
@@ -19,7 +19,7 @@ const org = value => {
 };
 module.exports.org = org;
 
-const name = value => {
+const name = (value) => {
     const result = npmPkg(value);
     if (result.validForNewPackages || result.validForOldPackages) {
         return value.toLowerCase();
@@ -28,7 +28,7 @@ const name = value => {
 };
 module.exports.name = name;
 
-const version = value => {
+const version = (value) => {
     const result = semver.valid(value);
     if (result) {
         return result;
@@ -37,7 +37,7 @@ const version = value => {
 };
 module.exports.version = version;
 
-const alias = value => {
+const alias = (value) => {
     if (/^[0-9]+$/.test(value)) {
         return value;
     }
@@ -45,7 +45,7 @@ const alias = value => {
 };
 module.exports.alias = alias;
 
-const type = value => {
+const type = (value) => {
     if (value === 'pkg' || value === 'map' || value === 'npm') {
         return value;
     }
@@ -54,10 +54,10 @@ const type = value => {
 module.exports.type = type;
 
 // TODO; https://github.com/asset-pipe/core/issues/12
-const extra = value => value;
+const extra = (value) => value;
 module.exports.extra = extra;
 
-const semverType = value => {
+const semverType = (value) => {
     if (value === 'major' || value === 'minor' || value === 'patch') {
         return value;
     }