@eik/common 4.0.0-next.7 → 4.0.0

package/{packages/utils/src → lib/helpers}/path-slashes.js

@@ -35,7 +35,7 @@ const addLeadingSlash = (val) => (val.startsWith('/') ? val : `/${val}`);
  */
 const removeLeadingSlash = (val) => (val.startsWith('/') ? val.substr(1) : val);
 
-module.exports = {
+export {
     addTrailingSlash,
     removeTrailingSlash,
     addLeadingSlash,

package/{packages/config-loader/src/utils → lib/helpers}/resolve-files.js

@@ -1,16 +1,12 @@
-/* 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 { ResolvedFiles } = require('../index.js');
-const {
+import { extname, join, isAbsolute, basename, sep, normalize } from 'node:path';
+import isGlob from 'is-glob';
+import { glob } from 'glob';
+import {
     removeTrailingSlash,
     addLeadingSlash,
     removeLeadingSlash,
-} = require('@eik/common-utils');
-const ResolvedFiles = require('../classes/resolved-files.js');
+} 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
@@ -79,4 +75,4 @@ const resolveFiles = async (files, cwd) =>
         }),
     );
 
-module.exports = resolveFiles;
+export default resolveFiles;

package/{packages/utils/src → lib/helpers}/type-slug.js

@@ -1,6 +1,9 @@
 // @ts-check
 
-module.exports = (type) => {
+/**
+ * @type {(type: string) => string}
+ */
+export default (type) => {
     if (type === 'package') return 'pkg';
     return type;
 };

package/{packages/utils/src → lib/helpers}/type-title.js

@@ -1,6 +1,9 @@
 // @ts-check
 
-module.exports = (type) => {
+/**
+ * @type {(type: string) => string}
+ */
+export default (type) => {
     if (type === 'package') return 'PACKAGE';
     if (type === 'npm') return 'NPM';
     return 'MAP';

package/lib/index.js

@@ -0,0 +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';
+
+export default {
+    validators,
+    ReadFile,
+    EikConfig,
+    schemas,
+    stream,
+    helpers,
+};
+export { validators, ReadFile, EikConfig, schemas, stream, helpers };

package/{packages/schemas/src → lib/schemas}/assert.js

@@ -1,6 +1,5 @@
 // @ts-check
-
-const {
+import {
     eikJSON,
     name,
     version,
@@ -9,14 +8,15 @@ const {
     files,
     importMap,
     out,
-} = require('./validate.js');
-
-const ValidationError = require('./validation-error.js');
+} from './validate.js';
+import ValidationError from './validation-error.js';
 
+// @ts-ignore
 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) {
@@ -29,7 +29,7 @@ const assert = (validate, message) => (value) => {
     }
 };
 
-module.exports = {
+export default {
     eikJSON: assert(eikJSON, 'Invalid eik.json schema'),
     name: assert(name, 'Parameter "name" is not valid'),
     type: assert(type, 'Parameter "type" is not valid'),

package/lib/schemas/index.js

@@ -0,0 +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';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const schema = JSON.parse(
+    readFileSync(join(__dirname, './eikjson.schema.json'), 'utf8'),
+);
+
+export default { schema, validate, assert, ValidationError };

package/{packages/schemas/src → lib/schemas}/validate.js

@@ -1,10 +1,19 @@
-const formats = require('ajv-formats');
-const semver = require('semver');
-const npmPkg = require('validate-npm-package-name');
-const Ajv = require('ajv').default;
+import { readFileSync } from 'node:fs';
+import { join, dirname } from 'node:path';
+import formats from 'ajv-formats';
+import semver from 'semver';
+import npmPkg from 'validate-npm-package-name';
+import Ajv from 'ajv';
+import { fileURLToPath } from 'node:url';
 
-const eikJSONSchema = require('./eikjson.schema.json');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
+const eikJSONSchema = JSON.parse(
+    readFileSync(join(__dirname, './eikjson.schema.json'), 'utf8'),
+);
+
+// @ts-ignore
 const createValidator = (schema, ajvOptions) => {
     const ajv = new Ajv(ajvOptions);
     // @ts-ignore
@@ -14,6 +23,7 @@ const createValidator = (schema, ajvOptions) => {
         ...schema,
     });
 
+    // @ts-ignore
     return (data) => {
         const cloned = JSON.parse(JSON.stringify(data));
         const valid = validate(cloned);
@@ -25,7 +35,7 @@ const eikJSON = createValidator(eikJSONSchema, {
     removeAdditional: true,
     useDefaults: true,
 });
-
+// @ts-ignore
 const createNameValidator = (jsonSchemaValidator) => (value) => {
     const result = jsonSchemaValidator(value);
     if (!result.error) {
@@ -46,7 +56,7 @@ const createNameValidator = (jsonSchemaValidator) => (value) => {
     }
     return result;
 };
-
+// @ts-ignore
 const createVersionValidator = (jsonSchemaValidator) => (value) => {
     const result = jsonSchemaValidator(value);
     if (!result.error) {
@@ -80,13 +90,4 @@ const files = createValidator(eikJSONSchema.properties.files);
 const importMap = createValidator(eikJSONSchema.properties['import-map']);
 const out = createValidator(eikJSONSchema.properties.out);
 
-module.exports = {
-    eikJSON,
-    name,
-    version,
-    type,
-    server,
-    files,
-    importMap,
-    out,
-};
+export { eikJSON, name, version, type, server, files, importMap, out };

package/{packages/schemas/src → lib/schemas}/validation-error.js

@@ -1,4 +1,5 @@
 // @ts-check
+
 class ValidationError extends Error {
     /**
      * @param {string} message
@@ -12,5 +13,4 @@ class ValidationError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-
-module.exports = ValidationError;
+export default ValidationError;

package/lib/stream.js

@@ -0,0 +1,12 @@
+// @ts-ignore
+export const isStream = (stream) =>
+    stream !== null &&
+    typeof stream === 'object' &&
+    typeof stream.pipe === 'function';
+
+// @ts-ignore
+export const isReadableStream = (stream) =>
+    isStream(stream) &&
+    stream.readable !== false &&
+    typeof stream._read === 'function' &&
+    typeof stream._readableState === 'object';

package/lib/validators/index.js

@@ -0,0 +1,65 @@
+import semver from 'semver';
+import npmPkg from 'validate-npm-package-name';
+
+const urlIsh = /^https?:\/\/[a-zA-Z0-9-_./]+(:[0-9]+)?/;
+// @ts-ignore
+export const origin = (value) => {
+    if (urlIsh.test(value)) {
+        return value.toLowerCase();
+    }
+    throw new Error('Parameter "origin" is not valid');
+};
+
+// @ts-ignore
+export const org = (value) => {
+    if (/^[a-zA-Z0-9_-]+$/.test(value)) {
+        return value.toLowerCase();
+    }
+    throw new Error(`Parameter "org" is not valid - Value: ${value}`);
+};
+
+// @ts-ignore
+export const name = (value) => {
+    const result = npmPkg(value);
+    if (result.validForNewPackages || result.validForOldPackages) {
+        return value.toLowerCase();
+    }
+    throw new Error(`Parameter "name" is not valid - Value: ${value}`);
+};
+
+// @ts-ignore
+export const version = (value) => {
+    const result = semver.valid(value);
+    if (result) {
+        return result;
+    }
+    throw new Error(`Parameter "version" is not valid - Value: ${value}`);
+};
+
+// @ts-ignore
+export const alias = (value) => {
+    if (/^[0-9]+$/.test(value)) {
+        return value;
+    }
+    throw new Error(`Parameter "alias" is not valid - Value: ${value}`);
+};
+
+// @ts-ignore
+export const type = (value) => {
+    if (value === 'pkg' || value === 'map' || value === 'npm') {
+        return value;
+    }
+    throw new Error(`Parameter "type" is not valid - Value: ${value}`);
+};
+
+// TODO; https://github.com/asset-pipe/core/issues/12
+// @ts-ignore
+export const extra = (value) => value;
+
+// @ts-ignore
+export const semverType = (value) => {
+    if (value === 'major' || value === 'minor' || value === 'patch') {
+        return value;
+    }
+    throw new Error(`Parameter "semverType" is not valid - Value: ${value}`);
+};

package/package.json

@@ -1,10 +1,67 @@
 {
   "name": "@eik/common",
-  "workspaces": [
-    "packages/config-loader",
-    "packages/utils",
-    "packages/schemas",
-    "packages/validators"
+  "version": "4.0.0",
+  "description": "Common utilities for Eik modules",
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
+  "type": "module",
+  "files": [
+    "CHANGELOG.md",
+    "package.json",
+    "lib",
+    "types",
+    "eikjson.d.ts"
   ],
-  "version": "4.0.0-next.7"
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "schema:types": "json2ts lib/schemas/eikjson.schema.json > eikjson.d.ts",
+    "schema:outdated": "npm run schema:types && git diff --exit-code HEAD:eikjson.d.ts eikjson.d.ts",
+    "test": "tap  --disable-coverage --allow-empty-coverage",
+    "types": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eik-lib/common.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/eik-lib/common/issues"
+  },
+  "homepage": "https://github.com/eik-lib/common#readme",
+  "dependencies": {
+    "ajv": "8.6.2",
+    "ajv-formats": "3.0.1",
+    "glob": "11.0.0",
+    "is-glob": "4.0.1",
+    "mime-types": "2.1.29",
+    "semver": "7.0.0",
+    "validate-npm-package-name": "5.0.1"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "7.25.1",
+    "@babel/plugin-syntax-import-assertions": "7.24.7",
+    "@eslint/js": "9.8.0",
+    "@hapi/hapi": "21.3.10",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@types/glob": "8.1.0",
+    "@types/is-glob": "4.0.4",
+    "@types/semver": "7.5.8",
+    "@types/validate-npm-package-name": "4.0.2",
+    "eslint": "9.8.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "express": "4.19.2",
+    "fastify": "4.28.1",
+    "globals": "15.9.0",
+    "json-schema-to-typescript": "15.0.0",
+    "prettier": "3.3.3",
+    "semantic-release": "24.0.0",
+    "stoppable": "1.1.0",
+    "tap": "21.0.0",
+    "typescript": "5.5.4"
+  }
 }

package/types/classes/custom-error.d.ts

@@ -0,0 +1,6 @@
+export default class CustomError extends Error {
+    /**
+     * @param {string} message
+     */
+    constructor(message: string);
+}

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

@@ -0,0 +1,63 @@
+/**
+ * @typedef {import ("../../eikjson").EikjsonSchema} EikjsonSchema
+ */
+export default class EikConfig {
+    /**
+     * @param {EikjsonSchema?} configHash
+     * @param {[string, string][]?} tokens
+     * @param {string?} configRootDir
+     */
+    constructor(configHash: EikjsonSchema | null, tokens?: [string, string][] | null, configRootDir?: string | null);
+    cwd: string;
+    /** @type {string[]} */
+    map: string[];
+    /** @type {EikjsonSchema["name"]} */
+    get name(): string;
+    set version(newVersion: string);
+    /** @type {EikjsonSchema["version"]} */
+    get version(): string;
+    /** @type {EikjsonSchema["type"]} */
+    get type(): "map" | "npm" | "package" | undefined;
+    /** @type {string} */
+    get server(): string;
+    /** @type {[string, string][]} */
+    get token(): [string, string][];
+    /** @type {EikjsonSchema["files"]} */
+    get files(): string | {
+        [k: string]: string;
+    };
+    /**
+     * Normalized relative directory path with any leading ./ or
+     * trailing / characters stripped. Defaults to .eik
+     *
+     * @returns {string} out path string
+     */
+    get out(): string;
+    /**
+     * Serializes internal values to an object
+     *
+     * @returns {EikjsonSchema} object consistent with EikjsonSchema
+     */
+    toJSON(): EikjsonSchema;
+    /**
+     * Validates config values against the eik JSON schema
+     *
+     * @return {void}
+     */
+    validate(): void;
+    /**
+     * Resolves file locations on disk based on values defined in files property
+     * of config object.
+     *
+     * @returns {Promise<FileMapping[]>}
+     */
+    mappings(): Promise<FileMapping[]>;
+    /** @type EikjsonSchema */
+    [_config]: EikjsonSchema;
+    [_tokens]: Map<string, string>;
+}
+export type EikjsonSchema = import("../../eikjson").EikjsonSchema;
+import FileMapping from './file-mapping.js';
+declare const _config: unique symbol;
+declare const _tokens: unique symbol;
+export {};

package/types/classes/file-mapping.d.ts

@@ -0,0 +1,21 @@
+export default FileMapping;
+/**
+ * Class containing a local file system source location and remote server destination location for a file.
+ */
+declare class FileMapping {
+    /**
+     * @param {LocalFileLocation} source
+     * @param {RemoteFileLocation} destination
+     */
+    constructor(source: LocalFileLocation, destination: RemoteFileLocation);
+    /**
+     * @type {LocalFileLocation} source
+     */
+    source: LocalFileLocation;
+    /**
+     * @type {RemoteFileLocation} destination
+     */
+    destination: RemoteFileLocation;
+}
+import LocalFileLocation from './local-file-location.js';
+import RemoteFileLocation from './remote-file-location.js';

package/types/classes/invalid-config-error.d.ts

@@ -0,0 +1,3 @@
+export default class InvalidConfigError extends CustomError {
+}
+import CustomError from './custom-error.js';

package/types/classes/local-file-location.d.ts

@@ -0,0 +1,36 @@
+export default LocalFileLocation;
+/**
+ * Class containing information about a local file
+ */
+declare class LocalFileLocation {
+    /**
+     * @param {string} path path to file on disk relative to basePath
+     * @param {string} basePath basePath to the file's location on disk
+     */
+    constructor(path: string, basePath: string);
+    /**
+     * @type {string} path to file on disk relative to this.basePath
+     */
+    relative: string;
+    /**
+     * @type {string} absolute path to root files location on disk
+     */
+    basePath: string;
+    /**
+     * @type {string} absolute path to file on disk,
+     * this is a concatentation of this.basePath and this.relative
+     */
+    absolute: string;
+    /**
+     * @type {string} file extension with "." character included. (eg. ".json")
+     */
+    extension: string;
+    /**
+     * @type {string} full content-type header value for file
+     */
+    contentType: string;
+    /**
+     * @type {string} mime type of file
+     */
+    mimeType: string;
+}

package/types/classes/missing-config-error.d.ts

@@ -0,0 +1,3 @@
+export default class MissingConfigError extends CustomError {
+}
+import CustomError from './custom-error.js';

package/types/classes/multiple-config-sources-error.d.ts

@@ -0,0 +1,4 @@
+export default class MultipleConfigSourcesError extends CustomError {
+    constructor();
+}
+import CustomError from './custom-error.js';

package/types/classes/no-files-matched-error.d.ts

@@ -0,0 +1,3 @@
+export default class NoFilesMatchedError extends CustomError {
+}
+import CustomError from './custom-error.js';

package/types/classes/read-file.d.ts

@@ -0,0 +1,15 @@
+export default ReadFile;
+declare const ReadFile: {
+    new ({ mimeType, etag }?: {
+        mimeType?: string | undefined;
+        etag?: string | undefined;
+    }): {
+        _mimeType: string;
+        _stream: any;
+        _etag: string;
+        readonly mimeType: string;
+        stream: any;
+        readonly etag: string;
+        readonly [Symbol.toStringTag]: string;
+    };
+};

package/types/classes/remote-file-location.d.ts

@@ -0,0 +1,21 @@
+export default RemoteFileLocation;
+declare class RemoteFileLocation {
+    /**
+     * @param {string} filePathname pathname for file relative to package root eg. /folder/client.js
+     * @param {string} packagePathname pathname for package root eg. /pkg/my-pack/1.0.0
+     * @param {string} origin server origin eg. https://server.com
+     */
+    constructor(filePathname: string, packagePathname: string, origin: string);
+    /**
+     * @type {string} pathname to package root
+     */
+    packagePathname: string;
+    /**
+     * @type {string} pathname to file relative to package root
+     */
+    filePathname: string;
+    /**
+     * @type {URL} WHATWG URL object containing the full remote URL for the file
+     */
+    url: URL;
+}

package/types/classes/resolved-files.d.ts

@@ -0,0 +1,20 @@
+export default ResolvedFiles;
+declare class ResolvedFiles {
+    /**
+     * @param {string[]} files
+     * @param {{definition: [string, string], basePath: string, pattern: string}} meta
+     */
+    constructor(files: string[], meta: {
+        definition: [string, string];
+        basePath: string;
+        pattern: string;
+    });
+    destination: string;
+    source: string;
+    basePath: string;
+    pattern: string;
+    [Symbol.iterator](): Generator<LocalFileLocation, void, unknown>;
+    [originalFiles]: string[];
+}
+import LocalFileLocation from './local-file-location.js';
+declare const originalFiles: unique symbol;

package/types/classes/single-dest-multiple-source-error.d.ts

@@ -0,0 +1,3 @@
+export default class SingleDestMultipleSourcesError extends CustomError {
+}
+import CustomError from './custom-error.js';

package/types/helpers/config-store.d.ts

@@ -0,0 +1,28 @@
+declare namespace _default {
+    /**
+     * Load the configuration from an exact path and return an EikConfig object
+     *
+     * @param {string} configFilePathname
+     * @param {function} loadJSONFromDisk
+     *
+     * @returns {EikConfig}
+     */
+    function loadFromPath(configFilePathname: string, loadJSONFromDisk?: Function): EikConfig;
+    /**
+     * Tries to find the configuration for eik in the provided directory.
+     *
+     * @param {string} configRootDir The base directory for the eik project.
+     * @param {function} [loadJSONFromDisk] The function to use to load the file from disk.
+     *
+     * @returns {EikConfig}
+     */
+    function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function | undefined): EikConfig;
+    /**
+     * Persist config changes to disk as <cwd>/eik.json
+     *
+     * @param {import('../classes/eik-config')} config
+     */
+    function persistToDisk(config: typeof import("../classes/eik-config.js")): void;
+}
+export default _default;
+import EikConfig from '../classes/eik-config.js';

package/types/helpers/get-defaults.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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: string): typeof import("../classes/eik-config.js");

package/types/helpers/index.d.ts

@@ -0,0 +1,23 @@
+declare namespace _default {
+    export { localAssets };
+    export { getDefaults };
+    export { configStore };
+    export { typeSlug };
+    export { typeTitle };
+    export { addTrailingSlash };
+    export { removeTrailingSlash };
+    export { addLeadingSlash };
+    export { removeLeadingSlash };
+    export { resolveFiles };
+}
+export default _default;
+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 { addTrailingSlash } from './path-slashes.js';
+import { removeTrailingSlash } from './path-slashes.js';
+import { addLeadingSlash } from './path-slashes.js';
+import { removeLeadingSlash } from './path-slashes.js';
+import resolveFiles from './resolve-files.js';

package/types/helpers/local-assets.d.ts

@@ -0,0 +1,8 @@
+export default localAssets;
+/**
+ * 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
+ */
+declare function localAssets(app: object, rootEikDirectory?: string): Promise<void>;