@eik/common 4.0.0-next.4 → 4.0.0-next.7

package/packages/validators/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@eik/common-validators",
+  "version": "1.0.0",
+  "description": "Shared validators for all Eik packages",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "tap --no-check-coverage",
+    "test:snapshots:update": "tap --snapshot",
+    "lint:fix": "eslint --fix .",
+    "lint": "eslint .",
+    "style:check": "prettier -c .",
+    "style:format": "prettier -w .",
+    "typecheck": "tsc"
+  },
+  "license": "ISC",
+  "dependencies": {
+    "semver": "7.3.7",
+    "tap": "15.2.3",
+    "validate-npm-package-name": "4.0.0"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "7.16.5",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@types/node": "18.0.6",
+    "eslint": "7.32.0",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "prettier": "2.5.1",
+    "typescript": "4.7.4"
+  }
+}

package/packages/validators/src/index.js

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

package/packages/validators/test/index.js

@@ -0,0 +1,238 @@
+const tap = require('tap');
+const validators = require('../src/index.js');
+
+//
+// .origin()
+//
+
+tap.test('.origin() - valid values - should return value', (t) => {
+    t.equal(validators.origin('http://origin.com'), 'http://origin.com');
+    t.equal(
+        validators.origin('http://origin.com/one/two'),
+        'http://origin.com/one/two',
+    );
+    t.equal(validators.origin('http://s'), 'http://s');
+    t.equal(validators.origin('https://s'), 'https://s');
+    t.equal(
+        validators.origin('http://localhost:4001'),
+        'http://localhost:4001',
+    );
+    t.equal(
+        validators.origin('http://127.0.0.1:4001'),
+        'http://127.0.0.1:4001',
+    );
+    t.end();
+});
+
+tap.test('.origin() - invalid values - should throw', (t) => {
+    t.throws(() => {
+        validators.origin('!name');
+    }, new Error('Parameter "origin" is not valid'));
+    t.end();
+});
+
+tap.test(
+    '.origin() - upper case valid value - should convert to lower case value',
+    (t) => {
+        t.equal(validators.origin('http://some-origin'), 'http://some-origin');
+        t.equal(validators.origin('http://SOME_origin'), 'http://some_origin');
+        t.end();
+    },
+);
+
+//
+// .org()
+//
+
+tap.test('.org() - valid values - should return value', (t) => {
+    t.equal(validators.org('someorg'), 'someorg');
+    t.equal(validators.org('some-org'), 'some-org');
+    t.equal(validators.org('some_org'), 'some_org');
+    t.equal(validators.org('123'), '123');
+    t.end();
+});
+
+tap.test('.org() - invalid values - should throw', (t) => {
+    t.throws(() => {
+        validators.org('!name');
+    }, new Error('Parameter "org" is not valid'));
+    t.end();
+});
+
+tap.test(
+    '.org() - upper case valid value - should convert to lower case value',
+    (t) => {
+        t.equal(validators.org('SOMEorg'), 'someorg');
+        t.equal(validators.org('some-ORG'), 'some-org');
+        t.equal(validators.org('SOME_ORG'), 'some_org');
+        t.equal(validators.org('123'), '123');
+        t.end();
+    },
+);
+
+//
+// .name()
+//
+
+tap.test('.name() - valid values - should return value', (t) => {
+    t.equal(validators.name('some-package'), 'some-package');
+    t.equal(validators.name('example.com'), 'example.com');
+    t.equal(validators.name('under_score'), 'under_score');
+    t.equal(validators.name('123numeric'), '123numeric');
+    t.equal(validators.name('@npm/thingy'), '@npm/thingy');
+    t.equal(validators.name('@jane/foo.js'), '@jane/foo.js');
+    t.end();
+});
+
+tap.test('.name() - invalid values - should throw', (t) => {
+    t.throws(() => {
+        validators.name(' leading-space:and:weirdchars');
+    }, new Error('Parameter "name" is not valid'));
+    t.end();
+});
+
+//
+// .version()
+//
+
+tap.test('.version() - valid values - should return value', (t) => {
+    t.equal(validators.version('2.3.4'), '2.3.4');
+    t.equal(validators.version('1.2.4-beta.0'), '1.2.4-beta.0');
+    t.end();
+});
+
+tap.test('.version() - invalid values - should throw', (t) => {
+    t.throws(() => {
+        validators.version(' 1.and:weirdchars~5');
+    }, new Error('Parameter "version" is not valid'));
+    t.end();
+});
+
+tap.test('.version() - caret range - should throw', (t) => {
+    t.throws(() => {
+        validators.version('^1.2.4');
+    }, new Error('Parameter "version" is not valid'));
+    t.end();
+});
+
+tap.test('.version() - tilde range - should throw', (t) => {
+    t.throws(() => {
+        validators.version('~1.2.4');
+    }, new Error('Parameter "version" is not valid'));
+    t.end();
+});
+
+tap.test('.version() - X-range - should throw', (t) => {
+    t.throws(() => {
+        validators.version('1.x');
+    }, new Error('Parameter "version" is not valid'));
+    t.end();
+});
+
+tap.test('.version() - * - should throw', (t) => {
+    t.throws(() => {
+        validators.version('*');
+    }, new Error('Parameter "version" is not valid'));
+    t.end();
+});
+
+tap.test('.version() - latest - should throw', (t) => {
+    t.throws(() => {
+        validators.version('latest');
+    }, new Error('Parameter "version" is not valid'));
+    t.end();
+});
+
+//
+// .alias()
+//
+
+tap.test('.alias() - valid values - should return value', (t) => {
+    t.equal(validators.alias('8'), '8');
+    t.equal(validators.alias('10'), '10');
+    t.equal(validators.alias('10893475983749384'), '10893475983749384');
+    t.end();
+});
+
+tap.test('.name() - invalid value - semver patch - should throw', (t) => {
+    t.throws(() => {
+        validators.alias('1.2.4');
+    }, new Error('Parameter "alias" is not valid'));
+    t.end();
+});
+
+tap.test('.name() - invalid value - semver minor - should throw', (t) => {
+    t.throws(() => {
+        validators.alias('1.2');
+    }, new Error('Parameter "alias" is not valid'));
+    t.end();
+});
+
+tap.test('.name() - invalid value - semver latest - should throw', (t) => {
+    t.throws(() => {
+        validators.alias('latest');
+    }, new Error('Parameter "alias" is not valid'));
+    t.end();
+});
+
+//
+// .type()
+//
+
+tap.test('.type() - valid values - should return value', (t) => {
+    t.equal(validators.type('pkg'), 'pkg');
+    t.equal(validators.type('map'), 'map');
+    t.equal(validators.type('npm'), 'npm');
+    t.end();
+});
+
+tap.test('.type() - invalid value - should throw', (t) => {
+    t.throws(() => {
+        validators.type('foo');
+    }, new Error('Parameter "type" is not valid'));
+    t.end();
+});
+
+tap.test('.type() - invalid value - upper case - should throw', (t) => {
+    t.throws(() => {
+        validators.type('PKG');
+    }, new Error('Parameter "type" is not valid'));
+    t.end();
+});
+
+//
+// .extra()
+//
+
+tap.test('.extra() - valid values - should return value', (t) => {
+    t.equal(validators.extra('/foo/bar/index.js'), '/foo/bar/index.js');
+    t.equal(validators.extra('/foo/a9-8_3/index.js'), '/foo/a9-8_3/index.js');
+    t.equal(validators.extra('/foo/bar'), '/foo/bar');
+    t.equal(validators.extra('index.js'), 'index.js');
+    t.end();
+});
+
+//
+// .semverType()
+//
+
+tap.test('.semverType() - valid values - should return value', (t) => {
+    t.equal(validators.semverType('major'), 'major');
+    t.equal(validators.semverType('minor'), 'minor');
+    t.equal(validators.semverType('patch'), 'patch');
+    t.end();
+});
+
+tap.test('.semverType() - invalid value - should throw', (t) => {
+    t.throws(() => {
+        validators.semverType('foo');
+    }, new Error('Parameter "semverType" is not valid'));
+    t.end();
+});
+
+tap.test('.semverType() - invalid value - upper case - should throw', (t) => {
+    t.throws(() => {
+        validators.semverType('MAJOR');
+    }, new Error('Parameter "semverType" is not valid'));
+    t.end();
+});

package/release.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/changelog',
+    [
+      '@semantic-release/npm',
+      {
+        tarballDir: 'release',
+      },
+    ],
+    [
+      '@semantic-release/github',
+      {
+        assets: 'release/*.tgz',
+      },
+    ],
+    '@semantic-release/git',
+  ],
+  preset: 'angular',
+  branches: [
+    { name: 'master' },
+    { name: 'alpha', prerelease: true },
+    { name: 'beta', prerelease: true },
+    { name: 'next', prerelease: true },
+  ],
+};

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>eik-lib/renovate-presets:sub-level-module"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+    "compilerOptions": {
+        "lib": [
+            "es2020",
+            "dom"
+        ],
+        "module": "es2020",
+        "target": "es2020",
+        "resolveJsonModule": true,
+        "checkJs": true,
+        "allowJs": true,
+        "moduleResolution": "node",
+        "noEmit": false,
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "outDir": "types"
+    },
+    "include": [
+        "lib",
+        "packages/validators/index.js",
+        "packages/helpers/src/type-slug.js",
+        "packages/helpers/src/config-store.js",
+        "packages/schemas/src/validation-error.js",
+        "packages/schemas/src/validate.js",
+        "packages/schemas/index.js",
+        "packages/schemas/src/assert.js",
+        "packages/shared/src/stream.js",
+        "packages/config-loader/src/custom-error.js"
+    ]
+}

package/lib/helpers/index.js

@@ -1,25 +0,0 @@
-const localAssets = require('./local-assets');
-const getDefaults = require('./get-defaults');
-const configStore = require('./config-store');
-const typeSlug = require('./type-slug');
-const typeTitle = require('./type-title');
-const resolveFiles = require('./resolve-files');
-const {
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-} = require('./path-slashes');
-
-module.exports = {
-    localAssets,
-    getDefaults,
-    configStore,
-    typeSlug,
-    typeTitle,
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-    resolveFiles,
-};

package/lib/index.js

@@ -1,17 +0,0 @@
-'use strict';
-
-const validators = require('./validators');
-const ReadFile = require('./classes/read-file');
-const EikConfig = require('./classes/eik-config');
-const schemas = require('./schemas');
-const stream = require('./stream');
-const helpers = require('./helpers');
-
-module.exports = {
-    validators,
-    ReadFile,
-    EikConfig,
-    schemas,
-    stream,
-    helpers,
-};

package/lib/schemas/index.js

@@ -1,8 +0,0 @@
-// @ts-check
-
-const schema = require('./eikjson.schema.json');
-const validate = require('./validate');
-const assert = require('./assert');
-const ValidationError = require('./validation-error');
-
-module.exports = { schema, validate, assert, ValidationError };

package/lib/stream.js

@@ -1,14 +0,0 @@
-'use strict';
-
-const isStream = (stream) =>
-    stream !== null &&
-    typeof stream === 'object' &&
-    typeof stream.pipe === 'function';
-module.exports.isStream = isStream;
-
-const isReadableStream = (stream) =>
-    isStream(stream) &&
-    stream.readable !== false &&
-    typeof stream._read === 'function' &&
-    typeof stream._readableState === 'object';
-module.exports.isReadableStream = isReadableStream;

package/lib/validators/index.js

@@ -1,66 +0,0 @@
-'use strict';
-
-const semver = require('semver');
-const npmPkg = require('validate-npm-package-name');
-
-const origin = (value) => {
-    if (new RegExp('^https?://[a-zA-Z0-9-_./]+(:[0-9]+)?').test(value)) {
-        return value.toLowerCase();
-    }
-    throw new Error('Parameter "origin" is not valid');
-};
-module.exports.origin = origin;
-
-const org = (value) => {
-    if (/^[a-zA-Z0-9_-]+$/.test(value)) {
-        return value.toLowerCase();
-    }
-    throw new Error(`Parameter "org" is not valid - Value: ${value}`);
-};
-module.exports.org = org;
-
-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}`);
-};
-module.exports.name = name;
-
-const version = (value) => {
-    const result = semver.valid(value);
-    if (result) {
-        return result;
-    }
-    throw new Error(`Parameter "version" is not valid - Value: ${value}`);
-};
-module.exports.version = version;
-
-const alias = (value) => {
-    if (/^[0-9]+$/.test(value)) {
-        return value;
-    }
-    throw new Error(`Parameter "alias" is not valid - Value: ${value}`);
-};
-module.exports.alias = alias;
-
-const type = (value) => {
-    if (value === 'pkg' || value === 'map' || value === 'npm') {
-        return value;
-    }
-    throw new Error(`Parameter "type" is not valid - Value: ${value}`);
-};
-module.exports.type = type;
-
-// TODO; https://github.com/asset-pipe/core/issues/12
-const extra = (value) => value;
-module.exports.extra = extra;
-
-const semverType = (value) => {
-    if (value === 'major' || value === 'minor' || value === 'patch') {
-        return value;
-    }
-    throw new Error(`Parameter "semverType" is not valid - Value: ${value}`);
-};
-module.exports.semverType = semverType;

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

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

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

@@ -1,57 +0,0 @@
-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<import("./file-mapping")[]>;
-}
-declare namespace EikConfig {
-    export { EikjsonSchema };
-}
-type EikjsonSchema = import("../../eikjson").EikjsonSchema;

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

@@ -1,19 +0,0 @@
-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: import("./local-file-location"), destination: import("./remote-file-location"));
-    /**
-     * @type {LocalFileLocation} source
-     */
-    source: import("./local-file-location");
-    /**
-     * @type {RemoteFileLocation} destination
-     */
-    destination: import("./remote-file-location");
-}

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

@@ -1,13 +0,0 @@
-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);
-}

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

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

@@ -1,13 +0,0 @@
-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);
-}