@eik/common 4.0.0-next.7 → 4.0.1

package/CHANGELOG.md

@@ -1,18 +1,123 @@
-# [4.0.0-next.7](https://github.com/eik-lib/common/compare/v4.0.0-next.6...v4.0.0-next.7) (2022-07-26)
+## [4.0.1](https://github.com/eik-lib/common/compare/v4.0.0...v4.0.1) (2024-08-06)
 
 
 ### Bug Fixes
 
-* run semantic release in each package ([84ace0c](https://github.com/eik-lib/common/commit/84ace0c3359b42bf20461318afc2ef67faaba11b))
+* use correct method name for loading config file from path ([9d01ca4](https://github.com/eik-lib/common/commit/9d01ca46574ee5a9f153835f8778640a9b20625b))
 
-# [4.0.0-next.6](https://github.com/eik-lib/common/compare/v4.0.0-next.5...v4.0.0-next.6) (2022-07-26)
+# [4.0.0](https://github.com/eik-lib/common/compare/v3.0.1...v4.0.0) (2024-08-06)
 
 
 ### Bug Fixes
 
-* lint ([edc595f](https://github.com/eik-lib/common/commit/edc595f6f4baf465e736bed8a4cb2e0eb8efe382))
+* update ajv-formats ([131dbf2](https://github.com/eik-lib/common/commit/131dbf25fcf8e2d128ac9e660076b538c441fa55))
+* update glob to 9.0.0 ([ee132ce](https://github.com/eik-lib/common/commit/ee132ceb256244df74839dc9495c57c1e2b36af2))
+* update glog to 11.0.0 ([ae24324](https://github.com/eik-lib/common/commit/ae2432458bd8c3ec95f7ca59d6d86ed87e1686d2))
+* update validate-npm-package-name ([00c57e7](https://github.com/eik-lib/common/commit/00c57e7a2c6f0c2666493ebb1a6eae446582037f))
 
-# [4.0.0-next.5](https://github.com/eik-lib/common/compare/v4.0.0-next.4...v4.0.0-next.5) (2022-07-26)
+
+### chore
+
+* convert codebase to ESM ([1a83a26](https://github.com/eik-lib/common/commit/1a83a261d2cc2ce2c921eaf50c843d0e8989d662))
+
+
+### Features
+
+* add load exact method ([709c8e3](https://github.com/eik-lib/common/commit/709c8e350d6f9a24c5d41981cca27b8183bf3268))
+
+
+### BREAKING CHANGES
+
+* Codebase is now ESM only, Common JS is no longer supported.
+
+# [4.0.0-next.5](https://github.com/eik-lib/common/compare/v4.0.0-next.4...v4.0.0-next.5) (2024-08-06)
+
+
+### Bug Fixes
+
+* **deps:** update dependency glob to v8 ([#225](https://github.com/eik-lib/common/issues/225)) ([fd01a56](https://github.com/eik-lib/common/commit/fd01a566b404164bdc847cc7a1803b124e131e41))
+* **deps:** update dependency validate-npm-package-name to v4 ([#222](https://github.com/eik-lib/common/issues/222)) ([c3721ab](https://github.com/eik-lib/common/commit/c3721abf058c93d4e500945c3c014c748c1f2acd))
+* update ajv-formats ([131dbf2](https://github.com/eik-lib/common/commit/131dbf25fcf8e2d128ac9e660076b538c441fa55))
+* update glob to 9.0.0 ([ee132ce](https://github.com/eik-lib/common/commit/ee132ceb256244df74839dc9495c57c1e2b36af2))
+* update glog to 11.0.0 ([ae24324](https://github.com/eik-lib/common/commit/ae2432458bd8c3ec95f7ca59d6d86ed87e1686d2))
+* update validate-npm-package-name ([00c57e7](https://github.com/eik-lib/common/commit/00c57e7a2c6f0c2666493ebb1a6eae446582037f))
+
+
+### chore
+
+* convert codebase to ESM ([1a83a26](https://github.com/eik-lib/common/commit/1a83a261d2cc2ce2c921eaf50c843d0e8989d662))
+
+
+### Features
+
+* add load exact method ([709c8e3](https://github.com/eik-lib/common/commit/709c8e350d6f9a24c5d41981cca27b8183bf3268))
+
+
+### BREAKING CHANGES
+
+* Codebase is now ESM only, Common JS is no longer supported.
+
+# [4.0.0-next.5](https://github.com/eik-lib/common/compare/v4.0.0-next.4...v4.0.0-next.5) (2024-08-04)
+
+
+### Bug Fixes
+
+* **deps:** update dependency glob to v8 ([#225](https://github.com/eik-lib/common/issues/225)) ([fd01a56](https://github.com/eik-lib/common/commit/fd01a566b404164bdc847cc7a1803b124e131e41))
+* **deps:** update dependency validate-npm-package-name to v4 ([#222](https://github.com/eik-lib/common/issues/222)) ([c3721ab](https://github.com/eik-lib/common/commit/c3721abf058c93d4e500945c3c014c748c1f2acd))
+* update ajv-formats ([131dbf2](https://github.com/eik-lib/common/commit/131dbf25fcf8e2d128ac9e660076b538c441fa55))
+* update glob to 9.0.0 ([ee132ce](https://github.com/eik-lib/common/commit/ee132ceb256244df74839dc9495c57c1e2b36af2))
+* update glog to 11.0.0 ([ae24324](https://github.com/eik-lib/common/commit/ae2432458bd8c3ec95f7ca59d6d86ed87e1686d2))
+* update validate-npm-package-name ([00c57e7](https://github.com/eik-lib/common/commit/00c57e7a2c6f0c2666493ebb1a6eae446582037f))
+
+
+### chore
+
+* convert codebase to ESM ([1a83a26](https://github.com/eik-lib/common/commit/1a83a261d2cc2ce2c921eaf50c843d0e8989d662))
+
+
+### BREAKING CHANGES
+
+* Codebase is now ESM only, Common JS is no longer supported.
+
+# [4.0.0-next.5](https://github.com/eik-lib/common/compare/v4.0.0-next.4...v4.0.0-next.5) (2024-08-01)
+
+
+### Bug Fixes
+
+* **deps:** update dependency glob to v8 ([#225](https://github.com/eik-lib/common/issues/225)) ([fd01a56](https://github.com/eik-lib/common/commit/fd01a566b404164bdc847cc7a1803b124e131e41))
+* **deps:** update dependency validate-npm-package-name to v4 ([#222](https://github.com/eik-lib/common/issues/222)) ([c3721ab](https://github.com/eik-lib/common/commit/c3721abf058c93d4e500945c3c014c748c1f2acd))
+* update ajv-formats ([131dbf2](https://github.com/eik-lib/common/commit/131dbf25fcf8e2d128ac9e660076b538c441fa55))
+* update validate-npm-package-name ([00c57e7](https://github.com/eik-lib/common/commit/00c57e7a2c6f0c2666493ebb1a6eae446582037f))
+
+
+### chore
+
+* convert codebase to ESM ([1a83a26](https://github.com/eik-lib/common/commit/1a83a261d2cc2ce2c921eaf50c843d0e8989d662))
+
+
+### BREAKING CHANGES
+
+* Codebase is now ESM only, Common JS is no longer supported.
+
+# [4.0.0-next.5](https://github.com/eik-lib/common/compare/v4.0.0-next.4...v4.0.0-next.5) (2024-07-31)
+
+
+### Bug Fixes
+
+* **deps:** update dependency glob to v8 ([#225](https://github.com/eik-lib/common/issues/225)) ([fd01a56](https://github.com/eik-lib/common/commit/fd01a566b404164bdc847cc7a1803b124e131e41))
+* **deps:** update dependency validate-npm-package-name to v4 ([#222](https://github.com/eik-lib/common/issues/222)) ([c3721ab](https://github.com/eik-lib/common/commit/c3721abf058c93d4e500945c3c014c748c1f2acd))
+
+
+### chore
+
+* convert codebase to ESM ([1a83a26](https://github.com/eik-lib/common/commit/1a83a261d2cc2ce2c921eaf50c843d0e8989d662))
+
+
+### BREAKING CHANGES
+
+* Codebase is now ESM only, Common JS is no longer supported.
+
+# [4.0.0-next.5](https://github.com/eik-lib/common/compare/v4.0.0-next.4...v4.0.0-next.5) (2024-07-31)
 
 
 ### Bug Fixes

package/README.md

@@ -1,7 +1,11 @@
-# Eik Commons
+# Eik Common
 
 This package contains common utilities and schemas
 
+## ESM ONLY
+
+From v4, this module is ESM only and cannot be used with Common JS.
+
 ## APIs
 
 ### schemas
@@ -11,7 +15,7 @@ This package contains common utilities and schemas
 Importing schemas
 
 ```js
-const { schemas, assert } = require('@eik/common');
+import { schemas, assert } from '@eik/common';
 ```
 
 Validating an `eik.json` file
@@ -127,8 +131,8 @@ assert.out('./.eik');
 A function to help development by mounting development routes to an Express.js or Fastify app based on values defined in `eik.json`
 
 ```js
-const express = require('express');
-const { helpers } = require('@eik/common');
+import express from 'express';
+import { helpers } from '@eik/common';
 const app = express();
 await helpers.localAssets(app);
 ```
@@ -179,7 +183,7 @@ Given the following `eik.json` file:
 and the following call to packageURL
 
 ```js
-const { helpers } = require('@eik/common');
+import { helpers } from '@eik/common';
 const url = await helpers.packageURL('esm.js');
 ```
 

package/eikjson.d.ts

@@ -1,4 +1,4 @@
-/* tslint:disable */
+/* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,

package/{packages/config-loader/src/errors → lib/classes}/custom-error.js

@@ -1,4 +1,4 @@
-class CustomError extends Error {
+export default class CustomError extends Error {
     /**
      * @param {string} message
      */
@@ -8,5 +8,3 @@ class CustomError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-
-module.exports = CustomError;

package/{packages/config-loader/src → lib/classes}/eik-config.js

@@ -1,20 +1,16 @@
-/* eslint-disable no-continue */
-
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-const assert = require('assert');
-const { extname, join, isAbsolute } = require('path');
-const { typeSlug, removeTrailingSlash } = require('@eik/common-utils');
-
-const schemas = require('@eik/common-schemas');
-
-const resolveFiles = require('./utils/resolve-files.js');
-
-const RemoteFileLocation = require('./classes/remote-file-location.js');
-const FileMapping = require('./classes/file-mapping.js');
-const SingleDestMultipleSourcesError = require('./errors/single-dest-multiple-source-error.js');
-const NoFilesMatchedError = require('./errors/no-files-matched-error.js');
+import assert from 'node:assert';
+import { extname, join, isAbsolute } from 'node:path';
+import NoFilesMatchedError from './no-files-matched-error.js';
+import SingleDestMultipleSourcesError from './single-dest-multiple-source-error.js';
+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 typeSlug from '../helpers/type-slug.js';
+import resolveFiles from '../helpers/resolve-files.js';
 
 const _config = Symbol('config');
 const _tokens = Symbol('tokens');
@@ -33,7 +29,7 @@ const normalizeFilesDefinition = (files) =>
  * @typedef {import ("../../eikjson").EikjsonSchema} EikjsonSchema
  */
 
-class EikConfig {
+export default class EikConfig {
     /**
      * @param {EikjsonSchema?} configHash
      * @param {[string, string][]?} tokens
@@ -45,11 +41,14 @@ class EikConfig {
         this[_tokens] = new Map(tokens);
 
         assert(
+            // @ts-ignore
             isAbsolute(configRootDir),
             `"configRootDir" must be an absolute path: "${configRootDir}" given`,
         );
+        // @ts-ignore
         this.cwd = removeTrailingSlash(configRootDir);
         /** @type {string[]} */
+        // @ts-ignore
         this.map = [].concat(this[_config]['import-map'] || []);
     }
 
@@ -70,6 +69,7 @@ class EikConfig {
 
     /** @type {EikjsonSchema["type"]} */
     get type() {
+        // @ts-ignore
         return this[_config].type || schemas.schema.properties.type.default;
     }
 
@@ -84,6 +84,7 @@ class EikConfig {
 
     /** @type {[string, string][]} */
     get token() {
+        // @ts-ignore
         return this[_tokens].get(this.server);
     }
 
@@ -135,7 +136,9 @@ class EikConfig {
         const resolvedFiles = await resolveFiles(normalizedFiles, this.cwd);
 
         return resolvedFiles.flatMap((files) => {
+            // @ts-ignore
             const { destination, source } = files;
+            // @ts-ignore
             const filesArray = Array.from(files);
             if (filesArray.length === 0) {
                 throw new NoFilesMatchedError(source);
@@ -151,6 +154,7 @@ class EikConfig {
                     ? destination
                     : join(destination, localFile.relative);
                 const packagePathname = join(
+                    // @ts-ignore
                     typeSlug(this.type),
                     this.name,
                     this.version,
@@ -165,5 +169,3 @@ class EikConfig {
         });
     }
 }
-
-module.exports = EikConfig;

package/{packages/config-loader/src → lib}/classes/file-mapping.js

@@ -1,11 +1,9 @@
-/* eslint-disable no-unused-vars */
-
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-const assert = require('assert');
-const LocalFileLocation = require('./local-file-location.js');
-const RemoteFileLocation = require('./remote-file-location.js');
+import assert from 'node:assert';
+import LocalFileLocation from './local-file-location.js';
+import RemoteFileLocation from './remote-file-location.js';
 
 /**
  * Class containing a local file system source location and remote server destination location for a file.
@@ -37,4 +35,4 @@ class FileMapping {
     }
 }
 
-module.exports = FileMapping;
+export default FileMapping;

package/{packages/config-loader/src/errors → lib/classes}/invalid-config-error.js

@@ -1,6 +1,6 @@
-const CustomError = require('./custom-error');
+import CustomError from './custom-error.js';
 
-class InvalidConfigError extends CustomError {
+export default class InvalidConfigError extends CustomError {
     /**
      * @param {string} msg
      */
@@ -8,5 +8,3 @@ class InvalidConfigError extends CustomError {
         super(`Eik config object was invalid: '${msg}'`);
     }
 }
-
-module.exports = InvalidConfigError;

package/{packages/config-loader/src → lib}/classes/local-file-location.js

@@ -1,9 +1,10 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-const assert = require('assert');
-const { join, extname, isAbsolute } = require('path');
-const mime = require('mime-types');
+import assert from 'node:assert';
+import { join, extname, isAbsolute } from 'node:path';
+// @ts-ignore
+import mime from 'mime-types';
 
 /**
  * Class containing information about a local file
@@ -56,4 +57,4 @@ class LocalFileLocation {
     }
 }
 
-module.exports = LocalFileLocation;
+export default LocalFileLocation;

package/{packages/config-loader/src/errors → lib/classes}/missing-config-error.js

@@ -1,6 +1,6 @@
-const CustomError = require('./custom-error');
+import CustomError from './custom-error.js';
 
-class MissingConfigError extends CustomError {
+export default class MissingConfigError extends CustomError {
     /**
      * @param {string} dir
      */
@@ -8,5 +8,3 @@ class MissingConfigError extends CustomError {
         super(`No package.json or eik.json file found in: '${dir}'`);
     }
 }
-
-module.exports = MissingConfigError;

package/{packages/config-loader/src/errors → lib/classes}/multiple-config-sources-error.js

@@ -1,11 +1,9 @@
-const CustomError = require('./custom-error');
+import CustomError from './custom-error.js';
 
-class MultipleConfigSourcesError extends CustomError {
+export default class MultipleConfigSourcesError extends CustomError {
     constructor() {
         super(
             `Eik configuration was defined in both in package.json and eik.json. You must specify one or the other.`,
         );
     }
 }
-
-module.exports = MultipleConfigSourcesError;

package/{packages/config-loader/src/errors → lib/classes}/no-files-matched-error.js

@@ -1,6 +1,6 @@
-const CustomError = require('./custom-error.js');
+import CustomError from './custom-error.js';
 
-class NoFilesMatchedError extends CustomError {
+export default class NoFilesMatchedError extends CustomError {
     /**
      * @param {string} file
      */
@@ -9,5 +9,3 @@ class NoFilesMatchedError extends CustomError {
         super(message);
     }
 }
-
-module.exports = NoFilesMatchedError;

package/{packages/config-loader/src → lib}/classes/read-file.js

@@ -1,8 +1,9 @@
-const { isReadableStream } = require('@eik/common-utils');
+import { isReadableStream } from '../stream.js';
 
 const ReadFile = class ReadFile {
     constructor({ mimeType = '', etag = '' } = {}) {
         this._mimeType = mimeType;
+        // @ts-ignore
         this._stream = undefined;
         this._etag = etag;
     }
@@ -17,6 +18,7 @@ const ReadFile = class ReadFile {
         this._stream = value;
     }
 
+    // @ts-ignore
     get stream() {
         return this._stream;
     }
@@ -29,5 +31,4 @@ const ReadFile = class ReadFile {
         return 'ReadFile';
     }
 };
-
-module.exports = ReadFile;
+export default ReadFile;

package/{packages/config-loader/src → lib}/classes/remote-file-location.js

@@ -1,8 +1,8 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-const assert = require('assert');
-const { join } = require('path');
+import assert from 'node:assert';
+import { join } from 'node:path';
 
 class RemoteFileLocation {
     /**
@@ -38,4 +38,4 @@ class RemoteFileLocation {
     }
 }
 
-module.exports = RemoteFileLocation;
+export default RemoteFileLocation;

package/{packages/config-loader/src → lib}/classes/resolved-files.js

@@ -1,13 +1,12 @@
 /**
  * @type {(value: unknown, message?: string) => asserts value}
  */
-const assert = require('assert');
-const {
+import assert from 'node:assert';
+import LocalFileLocation from './local-file-location.js';
+import {
     removeLeadingSlash,
     removeTrailingSlash,
-} = require('@eik/common-utils');
-
-const LocalFileLocation = require('./local-file-location');
+} from '../helpers/path-slashes.js';
 
 const originalFiles = Symbol('files');
 
@@ -54,4 +53,4 @@ class ResolvedFiles {
     }
 }
 
-module.exports = ResolvedFiles;
+export default ResolvedFiles;

package/{packages/config-loader/src/errors → lib/classes}/single-dest-multiple-source-error.js

@@ -1,6 +1,6 @@
-const CustomError = require('./custom-error');
+import CustomError from './custom-error.js';
 
-class SingleDestMultipleSourcesError extends CustomError {
+export default class SingleDestMultipleSourcesError extends CustomError {
     /**
      * @param {string} destFilePath
      */
@@ -10,5 +10,3 @@ class SingleDestMultipleSourcesError extends CustomError {
         );
     }
 }
-
-module.exports = SingleDestMultipleSourcesError;

package/{packages/config-loader/src → lib/helpers}/config-store.js

@@ -1,11 +1,12 @@
-const { readFileSync, writeFileSync } = require('fs');
-const { join } = require('path');
-const homedir = require('os').homedir();
+import { readFileSync, writeFileSync } from 'node:fs';
+import { join, dirname } from 'node:path';
+import os from 'node:os';
+import EikConfig from '../classes/eik-config.js';
+import MissingConfigError from '../classes/missing-config-error.js';
+import MultipleConfigSourcesError from '../classes/multiple-config-sources-error.js';
+import InvalidConfigError from '../classes/invalid-config-error.js';
 
-const EikConfig = require('./eik-config.js');
-const MissingConfigError = require('./errors/missing-config-error.js');
-const MultipleConfigSourcesError = require('./errors/multiple-config-sources-error.js');
-const InvalidConfigError = require('./errors/invalid-config-error.js');
+const homedir = os.homedir();
 
 /**
  * Read a file at a given path and parse it
@@ -19,12 +20,38 @@ function readJSONFromDisk(path) {
     try {
         fileData = readFileSync(path, { encoding: 'utf8' });
     } catch (e) {
+        // @ts-ignore
         return null;
     }
     return JSON.parse(fileData);
 }
 
-module.exports = {
+export default {
+    /**
+     * Load the configuration from an exact path and return an EikConfig object
+     *
+     * @param {string} configFilePathname
+     * @param {function} loadJSONFromDisk
+     *
+     * @returns {EikConfig}
+     */
+    loadFromPath(configFilePathname, loadJSONFromDisk = readJSONFromDisk) {
+        const eikJSON = loadJSONFromDisk(configFilePathname);
+        if (!eikJSON) {
+            throw new MissingConfigError(dirname(configFilePathname));
+        }
+        let assets = eikJSON;
+        // detect package.json
+        if (eikJSON.eik) {
+            assets = {
+                name: eikJSON.name,
+                version: eikJSON.version,
+                ...eikJSON.eik,
+            };
+        }
+        const eikrc = loadJSONFromDisk(join(homedir, '.eikrc')) || {};
+        return new EikConfig(assets, eikrc.tokens, dirname(configFilePathname));
+    },
     /**
      * Tries to find the configuration for eik in the provided directory.
      *
@@ -62,6 +89,7 @@ module.exports = {
             config.validate();
         } catch (err) {
             throw new InvalidConfigError(
+                // @ts-ignore
                 `config.findInDirectory operation failed: ${err.message}`,
             );
         }
@@ -75,12 +103,15 @@ module.exports = {
      */
     persistToDisk(config) {
         try {
+            // @ts-ignore
             config.validate();
         } catch (err) {
             throw new InvalidConfigError(
+                // @ts-ignore
                 `config.persistToDisk operation failed: ${err.message}`,
             );
         }
+        // @ts-ignore
         const dest = join(config.cwd, 'eik.json');
         writeFileSync(dest, JSON.stringify(config, null, 2));
     },

package/lib/helpers/get-defaults.js

@@ -0,0 +1,38 @@
+// @ts-check
+import fs from 'node:fs';
+import path from 'node:path';
+import configStore from './config-store.js';
+import EikConfig from '../classes/eik-config.js';
+/**
+ * Sets up and returns an object containing a set of default values for the app context.
+ * Default values are fetched from the app's eik.json or package.json file as well as from .eikrc, if present in the users home directory.
+ *
+ * @param {string} directoryOrFilepath The directory to search for eik.json or package.json or an exact path to an eik.json or package.json file
+ *
+ * @returns {import("../classes/eik-config")} EikConfig
+ */
+export default function getDefaults(directoryOrFilepath) {
+    try {
+        const stats = fs.statSync(directoryOrFilepath);
+        if (stats.isDirectory()) {
+            // @ts-expect-error
+            return configStore.findInDirectory(directoryOrFilepath);
+        } else {
+            // @ts-expect-error
+            return configStore.loadFromPath(directoryOrFilepath);
+        }
+    } catch (error) {
+        const e = /** @type {Error} */ (error);
+        if (e.constructor.name === 'MissingConfigError') {
+            // assume directory
+            let cwd = directoryOrFilepath;
+            // detect exact file and get its directory
+            if (path.extname(directoryOrFilepath)) {
+                cwd = path.dirname(directoryOrFilepath);
+            }
+            // @ts-expect-error
+            return new EikConfig(null, [], cwd);
+        }
+        throw e;
+    }
+}

package/lib/helpers/index.js

@@ -0,0 +1,25 @@
+import localAssets from './local-assets.js';
+import getDefaults from './get-defaults.js';
+import configStore from './config-store.js';
+import typeSlug from './type-slug.js';
+import typeTitle from './type-title.js';
+import resolveFiles from './resolve-files.js';
+import {
+    addTrailingSlash,
+    removeTrailingSlash,
+    addLeadingSlash,
+    removeLeadingSlash,
+} from './path-slashes.js';
+
+export default {
+    localAssets,
+    getDefaults,
+    configStore,
+    typeSlug,
+    typeTitle,
+    addTrailingSlash,
+    removeTrailingSlash,
+    addLeadingSlash,
+    removeLeadingSlash,
+    resolveFiles,
+};