@eik/common 4.0.0-next.2 → 4.0.0-next.5

package/CHANGELOG.md

@@ -1,3 +1,63 @@
+# [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)
+
+
+### 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))
+
+## [3.0.1](https://github.com/eik-lib/common/compare/v3.0.0...v3.0.1) (2022-05-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))
+
+# [3.0.0](https://github.com/eik-lib/common/compare/v2.0.3...v3.0.0) (2021-08-12)
+
+
+### Bug Fixes
+
+* ensure absolute file paths work as expected ([4f6ce5e](https://github.com/eik-lib/common/commit/4f6ce5e251dcbf0df0b51cc36f73b10585b96538))
+* include eik json schema file in package when publishing ([f0c3c45](https://github.com/eik-lib/common/commit/f0c3c45439a637e8a3cb3a475bca70f2a77c1901))
+* update require statements to avoid circular dependencies ([4359bec](https://github.com/eik-lib/common/commit/4359bec140539c6144be48f7b9ff774b9601d068))
+
+
+### Features
+
+* add extension, mime-type and content-type to file location ([a9b4fe1](https://github.com/eik-lib/common/commit/a9b4fe15cf39425070b9bd260183656933d94c5d))
+* Add hapi support for local assets ([7528c32](https://github.com/eik-lib/common/commit/7528c3277c537e7e0a4228c949988bc7e7a90074))
+* add mappings() method to eik config object ([f989ae0](https://github.com/eik-lib/common/commit/f989ae0e2de0aa5646fd33d0f5854bc7e74c8734)), closes [/github.com/eik-lib/issues/issues/2#issuecomment-779099732](https://github.com//github.com/eik-lib/issues/issues/2/issues/issuecomment-779099732)
+
+
+* refactor!: packageURL removed, localAssets fixed and updated ([90fd181](https://github.com/eik-lib/common/commit/90fd1818f69384d4edeb056dc2c8367e51b21d44))
+* refactor!: remove pathsAndFiles methods ([90d8a12](https://github.com/eik-lib/common/commit/90d8a12e4df8e3a37f295c6136e94bf4ade68cb4))
+* feat!: preserve directory structure when globbing in config ([dff2830](https://github.com/eik-lib/common/commit/dff28301f9bc6e37ef9db32455fa64f5a7a9e80a))
+
+
+### BREAKING CHANGES
+
+* packageURL was removed as it no longer makes sense given the changes to eik json files config
+
+localAssets has been refactored to use the new mappings method of eik config
+* Consumers of the Eik Config class will all need to be updated to use the newer .mappings() method instead.
+* directory structures are no longer flattened
+
+# [4.0.0-next.4](https://github.com/eik-lib/common/compare/v4.0.0-next.3...v4.0.0-next.4) (2021-02-23)
+
+
+### Bug Fixes
+
+* include eik json schema file in package when publishing ([f0c3c45](https://github.com/eik-lib/common/commit/f0c3c45439a637e8a3cb3a475bca70f2a77c1901))
+
+# [4.0.0-next.3](https://github.com/eik-lib/common/compare/v4.0.0-next.2...v4.0.0-next.3) (2021-02-23)
+
+
+### Bug Fixes
+
+* update require statements to avoid circular dependencies ([4359bec](https://github.com/eik-lib/common/commit/4359bec140539c6144be48f7b9ff774b9601d068))
+
 # [4.0.0-next.2](https://github.com/eik-lib/common/compare/v4.0.0-next.1...v4.0.0-next.2) (2021-02-23)
 
 

package/eikjson.d.ts

@@ -0,0 +1,41 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface EikjsonSchema {
+  /**
+   * The URL address of the Eik server where packages are published to.
+   */
+  server: string;
+  /**
+   * The name of the Eik package. Follows the same rules as for NPM package names. Must be parseable by validate-npm-package-name package, which is bundled with npm as a dependency.
+   */
+  name: string;
+  /**
+   * The version of the Eik package. Follows the same rules as for NPM package versions. Must be parseable by node-semver, which is bundled with npm as a dependency.
+   */
+  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.
+   */
+  type?: "package" | "npm" | "map";
+  /**
+   * 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.
+   */
+  files:
+    | {
+        [k: string]: string;
+      }
+    | string;
+  /**
+   * 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.
+   */
+  "import-map"?: string | string[];
+  /**
+   * Location of local Eik build directory (defaults to .eik). Used by Eik client.
+   */
+  out?: string;
+}

package/lib/classes/eik-config.js

@@ -10,7 +10,9 @@ const SingleDestMultipleSourcesError = require('./single-dest-multiple-source-er
 const FileMapping = require('./file-mapping');
 const RemoteFileLocation = require('./remote-file-location');
 const schemas = require('../schemas');
-const { typeSlug, removeTrailingSlash, resolveFiles } = require('../helpers');
+const { removeTrailingSlash } = require('../helpers/path-slashes');
+const typeSlug = require('../helpers/type-slug');
+const resolveFiles = require('../helpers/resolve-files');
 
 const _config = Symbol('config');
 const _tokens = Symbol('tokens');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/common",
-  "version": "4.0.0-next.2",
+  "version": "4.0.0-next.5",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -8,10 +8,11 @@
     "CHANGELOG.md",
     "package.json",
     "lib",
-    "types"
+    "types",
+    "eikjson.d.ts"
   ],
   "scripts": {
-    "test": "tap --test-regex=.test.js --test-ignore=node_modules",
+    "test": "tap  --no-check-coverage",
     "lint:fix": "eslint --fix .",
     "lint": "eslint .",
     "schema:types": "json2ts lib/schemas/eikjson.schema.json > eikjson.d.ts",
@@ -33,34 +34,31 @@
   },
   "homepage": "https://github.com/eik-lib/common#readme",
   "dependencies": {
-    "ajv": "^7.0.0",
-    "ajv-formats": "^1.5.1",
-    "glob": "^7.1.6",
+    "ajv": "^8.6.2",
+    "ajv-formats": "^2.1.0",
+    "glob": "^8.0.0",
     "is-glob": "^4.0.1",
     "mime-types": "^2.1.29",
     "node-fetch": "^2.6.1",
     "semver": "^7.0.0",
-    "validate-npm-package-name": "^3.0.0"
+    "validate-npm-package-name": "^4.0.0"
   },
   "devDependencies": {
-    "@hapi/hapi": "^20.1.0",
-    "@semantic-release/changelog": "5.0.1",
-    "@semantic-release/commit-analyzer": "8.0.1",
-    "@semantic-release/git": "9.0.0",
-    "@semantic-release/github": "7.2.0",
-    "@semantic-release/npm": "7.0.10",
-    "@semantic-release/release-notes-generator": "9.0.1",
-    "eslint": "7.20.0",
+    "@hapi/hapi": "20.2.2",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "eslint": "7.32.0",
     "eslint-config-airbnb-base": "14.2.1",
-    "eslint-config-prettier": "7.2.0",
-    "eslint-plugin-import": "2.22.1",
-    "eslint-plugin-prettier": "3.3.1",
-    "express": "4.17.1",
-    "fastify": "3.12.0",
-    "json-schema-to-typescript": "^10.1.3",
-    "prettier": "2.2.1",
-    "semantic-release": "17.3.9",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "express": "4.18.1",
+    "fastify": "3.29.0",
+    "json-schema-to-typescript": "10.1.5",
+    "prettier": "2.7.1",
+    "semantic-release": "18.0.1",
     "stoppable": "1.1.0",
-    "tap": "14.11.0"
+    "tap": "15.2.3",
+    "typescript": "4.7.4"
   }
 }

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

@@ -49,9 +49,10 @@ declare class EikConfig {
      *
      * @returns {Promise<FileMapping[]>}
      */
-    mappings(): Promise<import("./file-mapping")[]>;
+    mappings(): Promise<FileMapping[]>;
 }
 declare namespace EikConfig {
     export { EikjsonSchema };
 }
 type EikjsonSchema = import("../../eikjson").EikjsonSchema;
+import FileMapping = require("./file-mapping");

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

@@ -7,13 +7,15 @@ declare class FileMapping {
      * @param {LocalFileLocation} source
      * @param {RemoteFileLocation} destination
      */
-    constructor(source: import("./local-file-location"), destination: import("./remote-file-location"));
+    constructor(source: LocalFileLocation, destination: RemoteFileLocation);
     /**
      * @type {LocalFileLocation} source
      */
-    source: import("./local-file-location");
+    source: LocalFileLocation;
     /**
      * @type {RemoteFileLocation} destination
      */
-    destination: import("./remote-file-location");
+    destination: RemoteFileLocation;
 }
+import LocalFileLocation = require("./local-file-location");
+import RemoteFileLocation = require("./remote-file-location");

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

@@ -1,13 +1,4 @@
 export = InvalidConfigError;
-declare const InvalidConfigError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class InvalidConfigError extends InvalidConfigError_base {
-    /**
-     * @param {string} msg
-     */
-    constructor(msg: string);
+declare class InvalidConfigError extends CustomError {
 }
+import CustomError = require("./custom-error");

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

@@ -1,13 +1,4 @@
 export = MissingConfigError;
-declare const MissingConfigError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class MissingConfigError extends MissingConfigError_base {
-    /**
-     * @param {string} dir
-     */
-    constructor(dir: string);
+declare class MissingConfigError extends CustomError {
 }
+import CustomError = require("./custom-error");

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

@@ -1,9 +1,5 @@
 export = MultipleConfigSourcesError;
-declare const MultipleConfigSourcesError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class MultipleConfigSourcesError extends MultipleConfigSourcesError_base {
+declare class MultipleConfigSourcesError extends CustomError {
+    constructor();
 }
+import CustomError = require("./custom-error");

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

@@ -1,13 +1,4 @@
 export = NoFilesMatchedError;
-declare const NoFilesMatchedError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class NoFilesMatchedError extends NoFilesMatchedError_base {
-    /**
-     * @param {string} file
-     */
-    constructor(file: string);
+declare class NoFilesMatchedError extends CustomError {
 }
+import CustomError = require("./custom-error");

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

@@ -13,7 +13,8 @@ declare class ResolvedFiles {
     source: string;
     basePath: string;
     pattern: string;
-    [Symbol.iterator](): Generator<import("./local-file-location"), void, unknown>;
+    [Symbol.iterator](): Generator<LocalFileLocation, void, unknown>;
     [originalFiles]: string[];
 }
+import LocalFileLocation = require("./local-file-location");
 declare const originalFiles: unique symbol;

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

@@ -1,13 +1,4 @@
 export = SingleDestMultipleSourcesError;
-declare const SingleDestMultipleSourcesError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class SingleDestMultipleSourcesError extends SingleDestMultipleSourcesError_base {
-    /**
-     * @param {string} destFilePath
-     */
-    constructor(destFilePath: string);
+declare class SingleDestMultipleSourcesError extends CustomError {
 }
+import CustomError = require("./custom-error");

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

@@ -1,3 +1,4 @@
+import EikConfig = require("../classes/eik-config");
 /**
  * Tries to find the configuration for eik in the provided directory.
  *
@@ -6,7 +7,7 @@
  *
  * @returns {EikConfig}
  */
-export declare function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("../classes/eik-config");
+export function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): EikConfig;
 /**
  * Tries to find the configuration for eik in the provided directory.
  *
@@ -15,16 +16,16 @@ export declare function findInDirectory(configRootDir: string, loadJSONFromDisk?
  *
  * @returns {EikConfig}
  */
-export declare function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("../classes/eik-config");
+export function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): EikConfig;
 /**
  * Persist config changes to disk as <cwd>/eik.json
  *
  * @param {import('../classes/eik-config')} config
  */
-export declare function persistToDisk(config: import("../classes/eik-config")): void;
+export function persistToDisk(config: EikConfig): void;
 /**
  * Persist config changes to disk as <cwd>/eik.json
  *
  * @param {import('../classes/eik-config')} config
  */
-export declare function persistToDisk(config: import("../classes/eik-config")): void;
+export function persistToDisk(config: EikConfig): void;

package/types/helpers/index.d.ts

@@ -1,15 +1,11 @@
-export const localAssets: typeof import("./local-assets");
-export const getDefaults: (cwd: string) => import("../classes/eik-config");
-export const configStore: {
-    findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("../classes/eik-config");
-    persistToDisk(config: import("../classes/eik-config")): void;
-};
-export const typeSlug: (type: any) => any;
-export const typeTitle: (type: any) => "PACKAGE" | "NPM" | "MAP";
-export const addTrailingSlash: (val: string) => string;
-export const removeTrailingSlash: (val: string) => string;
-export const addLeadingSlash: (val: string) => string;
-export const removeLeadingSlash: (val: string) => string;
-export const resolveFiles: (files: {
-    [k: string]: string;
-}, cwd: string) => Promise<import("../classes/resolved-files")[]>;
+import localAssets = require("./local-assets");
+import getDefaults = require("./get-defaults");
+import configStore = require("./config-store");
+import typeSlug = require("./type-slug");
+import typeTitle = require("./type-title");
+import { addTrailingSlash } from "./path-slashes";
+import { removeTrailingSlash } from "./path-slashes";
+import { addLeadingSlash } from "./path-slashes";
+import { removeLeadingSlash } from "./path-slashes";
+import resolveFiles = require("./resolve-files");
+export { localAssets, getDefaults, configStore, typeSlug, typeTitle, addTrailingSlash, removeTrailingSlash, addLeadingSlash, removeLeadingSlash, resolveFiles };

package/types/helpers/resolve-files.d.ts

@@ -9,4 +9,5 @@ export = resolveFiles;
  */
 declare function resolveFiles(files: {
     [k: string]: string;
-}, cwd: string): Promise<import("../classes/resolved-files")[]>;
+}, cwd: string): Promise<ResolvedFiles[]>;
+import ResolvedFiles = require("../classes/resolved-files");

package/types/index.d.ts

@@ -1,115 +1,7 @@
-export const validators: typeof import("./validators");
-export const ReadFile: {
-    new ({ mimeType, etag }?: {
-        mimeType?: string;
-        etag?: string;
-    }): {
-        _mimeType: string;
-        _stream: any;
-        _etag: string;
-        readonly mimeType: string;
-        stream: any;
-        readonly etag: string;
-        readonly [Symbol.toStringTag]: string;
-    };
-};
-export const EikConfig: typeof import("./classes/eik-config");
-export const schemas: {
-    schema: {
-        $schema: string;
-        additionalProperties: boolean;
-        type: string;
-        properties: {
-            server: {
-                description: string;
-                type: string;
-                format: string;
-            };
-            name: {
-                description: string;
-                type: string;
-                maxLength: number;
-                minLength: number;
-            };
-            version: {
-                description: string;
-                type: string;
-                minLength: number;
-            };
-            type: {
-                description: string;
-                type: string;
-                enum: string[];
-                default: string;
-            };
-            files: {
-                description: string;
-                oneOf: ({
-                    type: string;
-                    minProperties: number;
-                    additionalProperties: {
-                        type: string;
-                    };
-                    minLength?: undefined;
-                } | {
-                    type: string;
-                    minLength: number;
-                    minProperties?: undefined;
-                    additionalProperties?: undefined;
-                })[];
-            };
-            "import-map": {
-                description: string;
-                oneOf: ({
-                    type: string;
-                    format: string;
-                    items?: undefined;
-                } | {
-                    type: string;
-                    items: {
-                        type: string;
-                        format: string;
-                    };
-                    format?: undefined;
-                })[];
-            };
-            out: {
-                description: string;
-                type: string;
-                format: string;
-                minLength: number;
-            };
-        };
-        required: string[];
-    };
-    validate: typeof import("./schemas/validate");
-    assert: {
-        eikJSON: (value: any) => void;
-        name: (value: any) => void;
-        type: (value: any) => void;
-        version: (value: any) => void;
-        server: (value: any) => void;
-        files: (value: any) => void;
-        importMap: (value: any) => void;
-        out: (value: any) => void;
-    };
-    ValidationError: typeof import("./schemas/validation-error");
-};
-export const stream: typeof import("./stream");
-export const helpers: {
-    localAssets: typeof import("./helpers/local-assets");
-    getDefaults: (cwd: string) => import("./classes/eik-config");
-    configStore: {
-        findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("./classes/eik-config");
-        persistToDisk(config: import("./classes/eik-config")): void;
-    };
-    typeSlug: (type: any) => any;
-    typeTitle: (type: any) => "PACKAGE" | "NPM" | "MAP";
-    addTrailingSlash: (val: string) => string;
-    removeTrailingSlash: (val: string) => string;
-    addLeadingSlash: (val: string) => string;
-    removeLeadingSlash: (val: string) => string;
-    resolveFiles: (files: {
-        [k: string]: string;
-    }, cwd: string) => Promise<import("./classes/resolved-files")[]>;
-};
+import validators = require("./validators");
+import ReadFile = require("./classes/read-file");
+import EikConfig = require("./classes/eik-config");
+import schemas = require("./schemas");
+import stream = require("./stream");
+import helpers = require("./helpers");
+export { validators, ReadFile, EikConfig, schemas, stream, helpers };

package/types/schemas/assert.d.ts

@@ -1,11 +1,8 @@
-declare const _exports: {
-    eikJSON: (value: any) => void;
-    name: (value: any) => void;
-    type: (value: any) => void;
-    version: (value: any) => void;
-    server: (value: any) => void;
-    files: (value: any) => void;
-    importMap: (value: any) => void;
-    out: (value: any) => void;
-};
-export = _exports;
+export function eikJSON(value: any): void;
+export function name(value: any): void;
+export function type(value: any): void;
+export function version(value: any): void;
+export function server(value: any): void;
+export function files(value: any): void;
+export function importMap(value: any): void;
+export function out(value: any): void;

package/types/schemas/index.d.ts

@@ -65,15 +65,7 @@ export const schema: {
     };
     required: string[];
 };
-export const validate: typeof import("./validate");
-export const assert: {
-    eikJSON: (value: any) => void;
-    name: (value: any) => void;
-    type: (value: any) => void;
-    version: (value: any) => void;
-    server: (value: any) => void;
-    files: (value: any) => void;
-    importMap: (value: any) => void;
-    out: (value: any) => void;
-};
-export const ValidationError: typeof import("./validation-error");
+import validate = require("./validate");
+import assert = require("./assert");
+import ValidationError = require("./validation-error");
+export { validate, assert, ValidationError };