@eik/common 4.1.0 → 5.0.0

package/lib/helpers/local-assets.js

@@ -1,9 +1,9 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-import assert from 'node:assert';
-import fs from 'node:fs';
-import configStore from './config-store.js';
+import assert from "node:assert";
+import fs from "node:fs";
+import configStore from "./config-store.js";
 
 /**
  * Sets up asset routes for local development. Mounted paths match those on Eik server and values are read from projects eik.json file.
@@ -12,52 +12,52 @@ import configStore from './config-store.js';
  * @param {string} rootEikDirectory - (optional) path to folder where eik configuration file can be found
  */
 async function localAssets(app, rootEikDirectory = process.cwd()) {
-    assert(
-        // @ts-ignore
-        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);
+	assert(
+		// @ts-ignore
+		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.mappings()).forEach((mapping) => {
-        const { pathname } = mapping.destination.url;
-        const { contentType, absolute: path } = mapping.source;
-        // @ts-ignore
-        if (app.get) {
-            // @ts-ignore
-            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
-            // @ts-ignore
-            app.route({
-                method: 'GET',
-                path: pathname,
-                // @ts-ignore
-                handler(req, h) {
-                    return h
-                        .response(fs.createReadStream(path))
-                        .header('Access-Control-Allow-Origin', '*')
-                        .type(contentType);
-                },
-            });
-        }
-    });
+	(await eik.mappings()).forEach((mapping) => {
+		const { pathname } = mapping.destination.url;
+		const { contentType, absolute: path } = mapping.source;
+		// @ts-ignore
+		if (app.get) {
+			// @ts-ignore
+			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
+			// @ts-ignore
+			app.route({
+				method: "GET",
+				path: pathname,
+				// @ts-ignore
+				handler(req, h) {
+					return h
+						.response(fs.createReadStream(path))
+						.header("Access-Control-Allow-Origin", "*")
+						.type(contentType);
+				},
+			});
+		}
+	});
 }
 export default localAssets;

package/lib/helpers/path-slashes.js

@@ -1,3 +1,6 @@
+import { sep } from "path";
+import { platform } from "os";
+
 /**
  * Add a trailing slash to a path if necessary
  *
@@ -5,7 +8,7 @@
  *
  * @returns {string}
  */
-const addTrailingSlash = (val) => (val.endsWith('/') ? val : `${val}/`);
+export const addTrailingSlash = (val) => (val.endsWith("/") ? val : `${val}/`);
 
 /**
  * Remove a trailing slash from a path if necessary
@@ -14,17 +17,19 @@ const addTrailingSlash = (val) => (val.endsWith('/') ? val : `${val}/`);
  *
  * @returns {string}
  */
-const removeTrailingSlash = (val) =>
-    val.endsWith('/') ? val.substr(0, val.length - 1) : val;
+export const removeTrailingSlash = (val) =>
+	// this is also used to trim from config files, which may now always use the OS's sep value. Look for both.
+	val.endsWith("/") || val.endsWith("\\") ? val.substr(0, val.length - 1) : val;
 
 /**
- * Add a leading slash to a path if necessary
+ * Add a leading slash to a path if necessary, but not on Windows
  *
  * @param {string} val
  *
  * @returns {string}
  */
-const addLeadingSlash = (val) => (val.startsWith('/') ? val : `/${val}`);
+export const addLeadingSlash = (val) =>
+	val.startsWith("/") || platform() === "win32" ? val : `/${val}`;
 
 /**
  * Remove a leading slash from a path if necessary
@@ -33,11 +38,19 @@ const addLeadingSlash = (val) => (val.startsWith('/') ? val : `/${val}`);
  *
  * @returns {string}
  */
-const removeLeadingSlash = (val) => (val.startsWith('/') ? val.substr(1) : val);
+export const removeLeadingSlash = (val) =>
+	val.startsWith("/") || val.startsWith("\\") ? val.substr(1) : val;
+
+/**
+ * Replaces a path string's separators (/ or \) with the current OS's sep value from node:path.
+ * @param {string} val
+ * @returns {string}
+ */
+export const ensureOsSep = (val) => val.replace(/\/\\/g, sep);
 
-export {
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-};
+/**
+ * Replaces any backslash with a forward slash.
+ * @param {string} val
+ * @returns {string}
+ */
+export const ensurePosix = (val) => val.replace(/\\/g, "/");

package/lib/helpers/resolve-files.js

@@ -1,12 +1,14 @@
-import { extname, join, isAbsolute, basename, sep, normalize } from 'node:path';
-import isGlob from 'is-glob';
-import { glob } from 'glob';
+import { extname, join, isAbsolute, basename, sep, normalize } from "node:path";
+import isGlob from "is-glob";
+import { glob } from "glob";
 import {
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-} from './path-slashes.js';
-import ResolvedFiles from '../classes/resolved-files.js';
+	removeTrailingSlash,
+	addLeadingSlash,
+	removeLeadingSlash,
+	ensureOsSep,
+	ensurePosix,
+} from "./path-slashes.js";
+import ResolvedFiles from "../classes/resolved-files.js";
 
 /**
  * Create a new path from a path string preceeding a glob or the whole path if no glob is found
@@ -15,15 +17,16 @@ import ResolvedFiles from '../classes/resolved-files.js';
  * @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)));
+	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)));
 };
 
 /**
@@ -35,44 +38,55 @@ const pathUntilGlob = (path) => {
  * @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);
+	Promise.all(
+		Object.entries(files).map(async (definition) => {
+			let [, source] = definition;
+
+			// The config may not always match the OS's separator.
+			// Convert the input to OS-specific if necessary.
+			// We convert back to always using forward slashes for glob,
+			// but for calculating the paths relative to cwd we'd like
+			// these to be OS-specific for now.
+			source = ensureOsSep(source);
+
+			// normalise to absolute path
+			let pattern = isAbsolute(source) ? source : join(cwd, source);
+
+			// append glob if folder
+			if (extname(pattern) === "" && isGlob(ensurePosix(pattern)) === false) {
+				pattern = `${pattern}${sep}**${sep}*`;
+			}
 
-            // append glob if folder
-            if (extname(pattern) === '' && isGlob(pattern) === false) {
-                pattern = join(pattern, '/**/*');
-            }
+			// trim off any glob
+			let basePath = pathUntilGlob(pattern);
 
-            // trim off any glob
-            let basePath = pathUntilGlob(pattern);
+			// fix basePath if file
+			if (extname(pattern) !== "") {
+				basePath = removeTrailingSlash(basePath.replace(basename(pattern), ""));
+			}
 
-            // fix basePath if file
-            if (extname(pattern) !== '') {
-                basePath = removeTrailingSlash(
-                    basePath.replace(basename(pattern), ''),
-                );
-            }
+			// convert glob pattern to forward slash separators
+			// https://www.npmjs.com/package/glob#windows
+			basePath = ensurePosix(basePath);
+			pattern = ensurePosix(pattern);
 
-            // process glob pattern into a list of existing files
-            const resolvedFiles = await glob(pattern, {
-                cwd: basePath,
-                nodir: true,
-            });
+			// 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, '')),
-            );
+			// trim off the basePath to create a relative pathed pattern
+			pattern = removeTrailingSlash(
+				removeLeadingSlash(pattern.replace(basePath, "")),
+			);
 
-            return new ResolvedFiles(resolvedFiles, {
-                definition,
-                basePath,
-                pattern,
-            });
-        }),
-    );
+			return new ResolvedFiles(resolvedFiles, {
+				definition,
+				basePath,
+				pattern,
+			});
+		}),
+	);
 
 export default resolveFiles;

package/lib/helpers/type-slug.js

@@ -5,7 +5,7 @@
  * @returns {string} the Eik package type
  */
 export default (type) => {
-    if (type === 'package') return 'pkg';
-    if (type === 'image') return 'img';
-    return type;
+	if (type === "package") return "pkg";
+	if (type === "image") return "img";
+	return type;
 };

package/lib/helpers/type-title.js

@@ -4,8 +4,8 @@
  * @param {"PACKAGE" | "NPM" | "MAP"} type
  */
 export default (type) => {
-    if (type === 'package') return 'PACKAGE';
-    if (type === 'npm') return 'NPM';
-    if (type === 'image') return 'IMAGE';
-    return 'MAP';
+	if (type === "package") return "PACKAGE";
+	if (type === "npm") return "NPM";
+	if (type === "image") return "IMAGE";
+	return "MAP";
 };

package/lib/index.js

@@ -1,16 +1,16 @@
-import * as validators from './validators/index.js';
-import ReadFile from './classes/read-file.js';
-import EikConfig from './classes/eik-config.js';
-import schemas from './schemas/index.js';
-import * as stream from './stream.js';
-import helpers from './helpers/index.js';
+import * as validators from "./validators/index.js";
+import ReadFile from "./classes/read-file.js";
+import EikConfig from "./classes/eik-config.js";
+import schemas from "./schemas/index.js";
+import * as stream from "./stream.js";
+import helpers from "./helpers/index.js";
 
 export default {
-    validators,
-    ReadFile,
-    EikConfig,
-    schemas,
-    stream,
-    helpers,
+	validators,
+	ReadFile,
+	EikConfig,
+	schemas,
+	stream,
+	helpers,
 };
 export { validators, ReadFile, EikConfig, schemas, stream, helpers };

package/lib/schemas/assert.js

@@ -1,14 +1,14 @@
 import {
-    eikJSON,
-    name,
-    version,
-    type,
-    server,
-    files,
-    importMap,
-    out,
-} from './validate.js';
-import ValidationError from './validation-error.js';
+	eikJSON,
+	name,
+	version,
+	type,
+	server,
+	files,
+	importMap,
+	out,
+} from "./validate.js";
+import ValidationError from "./validation-error.js";
 
 /**
  * @template T
@@ -25,38 +25,38 @@ import ValidationError from './validation-error.js';
  * @returns {SchemaAssert<T>}
  */
 const assert = (validate, message) => (value) => {
-    const valid = validate(value);
-    if (valid.error) {
-        const errorMessage = valid.error
-            // @ts-ignore
-            .map((err) => {
-                let msg = err.message;
-                if (err.params && err.params.allowedValues) {
-                    msg += ` ("${err.params.allowedValues.join('", "')}")`;
-                }
-                return msg;
-            })
-            .join(',');
-        // @ts-expect-error Maybe some toString magic happens here?
-        throw new ValidationError(`${message}: ${errorMessage}`, valid.error);
-    }
+	const valid = validate(value);
+	if (valid.error) {
+		const errorMessage = valid.error
+			// @ts-ignore
+			.map((err) => {
+				let msg = err.message;
+				if (err.params && err.params.allowedValues) {
+					msg += ` ("${err.params.allowedValues.join('", "')}")`;
+				}
+				return msg;
+			})
+			.join(",");
+		// @ts-expect-error Maybe some toString magic happens here?
+		throw new ValidationError(`${message}: ${errorMessage}`, valid.error);
+	}
 };
 
 export default {
-    /** Asserts the given [eik.json](https://eik.dev/docs/reference/eik-json) includes required fields that are valid */
-    eikJSON: assert(eikJSON, 'Invalid eik.json schema'),
-    /** Asserts the given [name](https://eik.dev/docs/reference/eik-json#name) value is valid*/
-    name: assert(name, 'Parameter "name" is not valid'),
-    /** Asserts the given [type](https://eik.dev/docs/reference/eik-json#type) value is valid*/
-    type: assert(type, 'Parameter "type" is not valid'),
-    /** Asserts the given [version](https://eik.dev/docs/reference/eik-json#version) value is valid*/
-    version: assert(version, 'Parameter "version" is not valid'),
-    /** Asserts the given [server](https://eik.dev/docs/reference/eik-json#server) value is valid*/
-    server: assert(server, 'Parameter "server" is not valid'),
-    /** Asserts the given [files](https://eik.dev/docs/reference/eik-json#files) value is valid  */
-    files: assert(files, 'Parameter "files" is not valid'),
-    /** Asserts the given [import-map](https://eik.dev/docs/reference/eik-json#import-map) value is valid  */
-    importMap: assert(importMap, 'Parameter "import-map" is not valid'),
-    /** Asserts the given [out](https://eik.dev/docs/reference/eik-json#out) value is valid  */
-    out: assert(out, 'Parameter "out" is not valid'),
+	/** Asserts the given [eik.json](https://eik.dev/docs/reference/eik-json) includes required fields that are valid */
+	eikJSON: assert(eikJSON, "Invalid eik.json schema"),
+	/** Asserts the given [name](https://eik.dev/docs/reference/eik-json#name) value is valid*/
+	name: assert(name, 'Parameter "name" is not valid'),
+	/** Asserts the given [type](https://eik.dev/docs/reference/eik-json#type) value is valid*/
+	type: assert(type, 'Parameter "type" is not valid'),
+	/** Asserts the given [version](https://eik.dev/docs/reference/eik-json#version) value is valid*/
+	version: assert(version, 'Parameter "version" is not valid'),
+	/** Asserts the given [server](https://eik.dev/docs/reference/eik-json#server) value is valid*/
+	server: assert(server, 'Parameter "server" is not valid'),
+	/** Asserts the given [files](https://eik.dev/docs/reference/eik-json#files) value is valid  */
+	files: assert(files, 'Parameter "files" is not valid'),
+	/** Asserts the given [import-map](https://eik.dev/docs/reference/eik-json#import-map) value is valid  */
+	importMap: assert(importMap, 'Parameter "import-map" is not valid'),
+	/** Asserts the given [out](https://eik.dev/docs/reference/eik-json#out) value is valid  */
+	out: assert(out, 'Parameter "out" is not valid'),
 };

package/lib/schemas/index.js

@@ -1,15 +1,15 @@
-import { readFileSync } from 'node:fs';
-import { join, dirname } from 'node:path';
-import * as validate from './validate.js';
-import assert from './assert.js';
-import ValidationError from './validation-error.js';
-import { fileURLToPath } from 'node:url';
+import { readFileSync } from "node:fs";
+import { join, dirname } from "node:path";
+import * as validate from "./validate.js";
+import assert from "./assert.js";
+import ValidationError from "./validation-error.js";
+import { fileURLToPath } from "node:url";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 const schema = JSON.parse(
-    readFileSync(join(__dirname, './eikjson.schema.json'), 'utf8'),
+	readFileSync(join(__dirname, "./eikjson.schema.json"), "utf8"),
 );
 
 export default { schema, validate, assert, ValidationError };