@eik/common 4.0.9 → 4.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.1.1](https://github.com/eik-lib/common/compare/v4.1.0...v4.1.1) (2024-08-16)
+
+
+### Bug Fixes
+
+* windows support ([#303](https://github.com/eik-lib/common/issues/303)) ([4e6a307](https://github.com/eik-lib/common/commit/4e6a3078861a0a03b7275bfb5b2875adda1f2c2e))
+
+# [4.1.0](https://github.com/eik-lib/common/compare/v4.0.9...v4.1.0) (2024-08-14)
+
+
+### Features
+
+* add support for Eik image type ([75a5830](https://github.com/eik-lib/common/commit/75a5830df7bf59f7ef627b8d143cda5c0bbbba1b))
+
 ## [4.0.9](https://github.com/eik-lib/common/compare/v4.0.8...v4.0.9) (2024-08-13)
 
 

package/eikjson.d.ts

@@ -20,9 +20,9 @@ export interface EikjsonSchema {
    */
   version: string;
   /**
-   * The type of the Eik package. Must be one of 'package', 'npm' or 'map'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm' and '/map', use 'npm' when publishing NPM packages. Use 'map' when publishing import maps.
+   * The type of the Eik package. Must be one of 'package', 'npm', 'map' or 'image'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm', '/map' and '/img', use 'npm' when publishing NPM packages. Use 'image' when publishing images. Use 'map' when publishing import maps.
    */
-  type?: "package" | "npm" | "map";
+  type?: "package" | "npm" | "map" | "image";
   /**
    * 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.
    */

package/lib/classes/eik-config.js

@@ -8,7 +8,7 @@ import SingleDestMultipleSourcesError from './single-dest-multiple-source-error.
 import FileMapping from './file-mapping.js';
 import RemoteFileLocation from './remote-file-location.js';
 import schemas from '../schemas/index.js';
-import { removeTrailingSlash } from '../helpers/path-slashes.js';
+import { removeTrailingSlash, ensurePosix } from '../helpers/path-slashes.js';
 import typeSlug from '../helpers/type-slug.js';
 import resolveFiles from '../helpers/resolve-files.js';
 
@@ -152,13 +152,11 @@ export default class EikConfig {
                 const shouldMapFilename = extname(destination);
                 const relativePathname = shouldMapFilename
                     ? destination
-                    : join(destination, localFile.relative);
-                const packagePathname = join(
-                    // @ts-ignore
-                    typeSlug(this.type),
-                    this.name,
-                    this.version,
+                    : ensurePosix(join(destination, localFile.relative));
+                const packagePathname = ensurePosix(
+                    join(typeSlug(this.type), this.name, this.version),
                 );
+
                 const remoteDestination = new RemoteFileLocation(
                     relativePathname,
                     packagePathname,

package/lib/classes/local-file-location.js

@@ -5,6 +5,7 @@ import assert from 'node:assert';
 import { join, extname, isAbsolute } from 'node:path';
 // @ts-ignore
 import mime from 'mime-types';
+import { ensurePosix } from '../helpers/path-slashes.js';
 
 /**
  * Class containing information about a local file
@@ -20,7 +21,10 @@ class LocalFileLocation {
             typeof basePath === 'string',
             '"basePath" must be of type "string"',
         );
-        assert(!isAbsolute(path), '"path" must be a relative path');
+        assert(
+            !isAbsolute(path),
+            `"path" must be a relative path, got ${path}`,
+        );
 
         /**
          * @type {string} path to file on disk relative to this.basePath
@@ -36,7 +40,7 @@ class LocalFileLocation {
          * @type {string} absolute path to file on disk,
          * this is a concatentation of this.basePath and this.relative
          */
-        this.absolute = join(basePath, path);
+        this.absolute = ensurePosix(join(basePath, path));
 
         /**
          * @type {string} file extension with "." character included. (eg. ".json")

package/lib/classes/resolved-files.js

@@ -46,7 +46,9 @@ class ResolvedFiles {
     *[Symbol.iterator]() {
         for (const file of this[originalFiles]) {
             const relative = removeTrailingSlash(
-                removeLeadingSlash(file.replace(this.basePath, '')),
+                removeLeadingSlash(
+                    file.replace(/\\/g, '/').replace(this.basePath, ''),
+                ),
             );
             yield new LocalFileLocation(relative, this.basePath);
         }

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,21 @@ 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 +40,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

@@ -5,6 +5,8 @@ import {
     removeTrailingSlash,
     addLeadingSlash,
     removeLeadingSlash,
+    ensureOsSep,
+    ensurePosix,
 } from './path-slashes.js';
 import ResolvedFiles from '../classes/resolved-files.js';
 
@@ -23,6 +25,7 @@ const pathUntilGlob = (path) => {
         if (isGlob(segment)) break;
         segmentsToKeep.push(segment);
     }
+
     return addLeadingSlash(normalize(segmentsToKeep.join(sep)));
 };
 
@@ -37,13 +40,24 @@ const pathUntilGlob = (path) => {
 const resolveFiles = async (files, cwd) =>
     Promise.all(
         Object.entries(files).map(async (definition) => {
-            const [, source] = 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(pattern) === false) {
-                pattern = join(pattern, '/**/*');
+            if (
+                extname(pattern) === '' &&
+                isGlob(ensurePosix(pattern)) === false
+            ) {
+                pattern = `${pattern}${sep}**${sep}*`;
             }
 
             // trim off any glob
@@ -56,6 +70,11 @@ const resolveFiles = async (files, cwd) =>
                 );
             }
 
+            // 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,

package/lib/helpers/type-slug.js

@@ -6,5 +6,6 @@
  */
 export default (type) => {
     if (type === 'package') return 'pkg';
+    if (type === 'image') return 'img';
     return type;
 };

package/lib/helpers/type-title.js

@@ -6,5 +6,6 @@
 export default (type) => {
     if (type === 'package') return 'PACKAGE';
     if (type === 'npm') return 'NPM';
+    if (type === 'image') return 'IMAGE';
     return 'MAP';
 };

package/lib/schemas/assert.js

@@ -32,7 +32,7 @@ const assert = (validate, message) => (value) => {
             .map((err) => {
                 let msg = err.message;
                 if (err.params && err.params.allowedValues) {
-                    msg += ` ("${err.params.allowedValues.join('", ')}")`;
+                    msg += ` ("${err.params.allowedValues.join('", "')}")`;
                 }
                 return msg;
             })

package/lib/schemas/eikjson.schema.json

@@ -24,9 +24,9 @@
       "minLength": 1
     },
     "type": {
-      "description": "The type of the Eik package. Must be one of 'package', 'npm' or 'map'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm' and '/map', use 'npm' when publishing NPM packages. Use 'map' when publishing import maps.",
+      "description": "The type of the Eik package. Must be one of 'package', 'npm', 'map' or 'image'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm', '/map' and '/img', use 'npm' when publishing NPM packages. Use 'image' when publishing images. Use 'map' when publishing import maps.",
       "type": "string",
-      "enum": ["package", "npm", "map"],
+      "enum": ["package", "npm", "map", "image"],
       "default": "package"
     },
     "files": {

package/lib/validators/index.js

@@ -77,7 +77,12 @@ export const alias = (value) => {
  * @throws {Error} if the value is not a valid Eik package type
  */
 export const type = (value) => {
-    if (value === 'pkg' || value === 'map' || value === 'npm') {
+    if (
+        value === 'pkg' ||
+        value === 'map' ||
+        value === 'npm' ||
+        value === 'img'
+    ) {
         return value;
     }
     throw new Error(`Parameter "type" is not valid - Value: ${value}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/common",
-  "version": "4.0.9",
+  "version": "4.1.1",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
   "types": "types/index.d.ts",

package/types/classes/eik-config.d.ts

@@ -17,7 +17,7 @@ export default class EikConfig {
     /** @type {EikjsonSchema["version"]} */
     get version(): string;
     /** @type {EikjsonSchema["type"]} */
-    get type(): "map" | "npm" | "package";
+    get type(): "map" | "npm" | "package" | "image";
     /** @type {string} */
     get server(): string;
     /** @type {[string, string][]} */

package/types/helpers/path-slashes.d.ts

@@ -1,32 +1,6 @@
-/**
- * Add a trailing slash to a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
 export function addTrailingSlash(val: string): string;
-/**
- * Remove a trailing slash from a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
 export function removeTrailingSlash(val: string): string;
-/**
- * Add a leading slash to a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
 export function addLeadingSlash(val: string): string;
-/**
- * Remove a leading slash from a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
 export function removeLeadingSlash(val: string): string;
+export function ensureOsSep(val: string): string;
+export function ensurePosix(val: string): string;

package/types/helpers/type-title.d.ts

@@ -1,2 +1,2 @@
-declare function _default(type: string): "PACKAGE" | "NPM" | "MAP";
+declare function _default(type: string): "PACKAGE" | "NPM" | "MAP" | "IMAGE";
 export default _default;