@eik/common 2.0.3 → 3.0.1

package/package.json

@@ -1,17 +1,26 @@
 {
   "name": "@eik/common",
-  "version": "2.0.3",
+  "version": "3.0.1",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
+  "types": "types/index.d.ts",
   "files": [
     "CHANGELOG.md",
     "package.json",
-    "lib"
+    "lib",
+    "types",
+    "eikjson.d.ts"
   ],
   "scripts": {
-    "test": "tap",
+    "test": "tap  --no-check-coverage",
     "lint:fix": "eslint --fix .",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "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",
+    "style:check": "prettier -c .",
+    "style:format": "prettier -w .",
+    "typecheck": "tsc",
+    "prepublish": "npm run typecheck"
   },
   "repository": {
     "type": "git",
@@ -25,30 +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": {
-    "@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.19.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.11.0",
-    "prettier": "2.2.1",
-    "semantic-release": "17.3.7",
+    "eslint-config-prettier": "8.4.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-prettier": "4.0.0",
+    "express": "4.18.1",
+    "fastify": "3.29.0",
+    "json-schema-to-typescript": "10.1.5",
+    "prettier": "2.5.1",
+    "semantic-release": "18.0.1",
     "stoppable": "1.1.0",
-    "tap": "14.11.0"
+    "tap": "15.1.6",
+    "typescript": "4.6.4"
   }
 }

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

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

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

@@ -0,0 +1,58 @@
+export = EikConfig;
+declare 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(arg: string);
+    /** @type {EikjsonSchema["version"]} */
+    get version(): string;
+    /** @type {EikjsonSchema["type"]} */
+    get type(): "map" | "npm" | "package";
+    /** @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[]>;
+}
+declare namespace EikConfig {
+    export { EikjsonSchema };
+}
+type EikjsonSchema = import("../../eikjson").EikjsonSchema;
+import FileMapping = require("./file-mapping");

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

@@ -0,0 +1,21 @@
+export = 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 = require("./local-file-location");
+import RemoteFileLocation = require("./remote-file-location");

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

@@ -0,0 +1,4 @@
+export = InvalidConfigError;
+declare class InvalidConfigError extends CustomError {
+}
+import CustomError = require("./custom-error");

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

@@ -0,0 +1,36 @@
+export = 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,4 @@
+export = MissingConfigError;
+declare class MissingConfigError extends CustomError {
+}
+import CustomError = require("./custom-error");

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

@@ -0,0 +1,5 @@
+export = MultipleConfigSourcesError;
+declare class MultipleConfigSourcesError extends CustomError {
+    constructor();
+}
+import CustomError = require("./custom-error");

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

@@ -0,0 +1,4 @@
+export = NoFilesMatchedError;
+declare class NoFilesMatchedError extends CustomError {
+}
+import CustomError = require("./custom-error");

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

@@ -0,0 +1,15 @@
+export = ReadFile;
+declare 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;
+    };
+};

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

@@ -0,0 +1,21 @@
+export = 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 = 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 = require("./local-file-location");
+declare const originalFiles: unique symbol;

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

@@ -0,0 +1,4 @@
+export = SingleDestMultipleSourcesError;
+declare class SingleDestMultipleSourcesError extends CustomError {
+}
+import CustomError = require("./custom-error");

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

@@ -0,0 +1,31 @@
+import EikConfig = require("../classes/eik-config");
+/**
+ * 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}
+ */
+export function findInDirectory(configRootDir: 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}
+ */
+export function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): EikConfig;
+/**
+ * Persist config changes to disk as <cwd>/eik.json
+ *
+ * @param {import('../classes/eik-config')} config
+ */
+export function persistToDisk(config: EikConfig): void;
+/**
+ * Persist config changes to disk as <cwd>/eik.json
+ *
+ * @param {import('../classes/eik-config')} config
+ */
+export function persistToDisk(config: EikConfig): void;

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

@@ -0,0 +1,2 @@
+declare function _exports(cwd: string): import("../classes/eik-config");
+export = _exports;

package/types/helpers/index.d.ts

@@ -0,0 +1,11 @@
+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/local-assets.d.ts

@@ -0,0 +1,8 @@
+export = 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>;

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

@@ -0,0 +1,32 @@
+/**
+ * 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;

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

@@ -0,0 +1,13 @@
+export = resolveFiles;
+/**
+ * Uses an Eik JSON "files" definition to resolve files on disk into a data structure
+ *
+ * @param {{[k: string]: string;}} files
+ * @param {string} cwd
+ *
+ * @returns {Promise<ResolvedFiles[]>}
+ */
+declare function resolveFiles(files: {
+    [k: string]: string;
+}, cwd: string): Promise<ResolvedFiles[]>;
+import ResolvedFiles = require("../classes/resolved-files");

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

@@ -0,0 +1,2 @@
+declare function _exports(type: any): any;
+export = _exports;

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

@@ -0,0 +1,2 @@
+declare function _exports(type: any): "PACKAGE" | "NPM" | "MAP";
+export = _exports;

package/types/index.d.ts

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,71 @@
+export const 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[];
+};
+import validate = require("./validate");
+import assert = require("./assert");
+import ValidationError = require("./validation-error");
+export { validate, assert, ValidationError };

package/types/schemas/validate.d.ts

@@ -0,0 +1,26 @@
+export function eikJSON(data: any): {
+    value: any;
+    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};
+export function name(value: any): any;
+export function version(value: any): any;
+export function type(data: any): {
+    value: any;
+    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};
+export function server(data: any): {
+    value: any;
+    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};
+export function files(data: any): {
+    value: any;
+    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};
+export function importMap(data: any): {
+    value: any;
+    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};
+export function out(data: any): {
+    value: any;
+    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};

package/types/schemas/validation-error.d.ts

@@ -0,0 +1,8 @@
+export = ValidationError;
+declare class ValidationError extends Error {
+    /**
+     * @param {string} message
+     * @param {Error} err
+     */
+    constructor(message: string, err: Error);
+}

package/types/stream.d.ts

@@ -0,0 +1,2 @@
+export function isStream(stream: any): boolean;
+export function isReadableStream(stream: any): boolean;

package/types/validators/index.d.ts

@@ -0,0 +1,8 @@
+export function origin(value: any): any;
+export function org(value: any): any;
+export function name(value: any): any;
+export function version(value: any): any;
+export function alias(value: any): any;
+export function type(value: any): any;
+export function extra(value: any): any;
+export function semverType(value: any): any;

package/lib/helpers/package-url.js

@@ -1,20 +0,0 @@
-const { join } = require('path');
-const configStore = require('./config-store');
-
-async function packageURL(key, { configRootDir = process.cwd() } = {}) {
-    const eik = configStore.findInDirectory(configRootDir);
-    const mappingList = (await eik.pathsAndFiles()).filter(
-        ([, , originalDest]) => originalDest === key,
-    );
-
-    if (mappingList.length === 0) throw new Error('No files specified');
-
-    const result = mappingList.map(
-        ([destPath]) =>
-            new URL(join(`pkg`, eik.name, eik.version, destPath), eik.server),
-    );
-
-    if (result.length === 1) return result[0];
-    return result;
-}
-module.exports = packageURL;