@eik/common 4.0.0-next.6 → 4.0.0

package/packages/schemas/.prettierignore

@@ -1,17 +0,0 @@
-node_modules/**/*
-.nyc_output/**/*
-package-lock.json
-node_modules/**/*
-.DS_Store
-tmp/**/*
-.idea
-.idea/**/*
-*.iml
-*.log
-coverage
-.vscode
-eikjson.d.ts
-CHANGELOG.md
-dist
-types
-renovate.json

package/packages/schemas/eikjson.d.ts

@@ -1,41 +0,0 @@
-/* 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/packages/schemas/index.js

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

package/packages/schemas/package.json

@@ -1,40 +0,0 @@
-{
-  "name": "@eik/common-schemas",
-  "version": "1.0.0",
-  "description": "Shared schema logic for Eik packages",
-  "main": "index.js",
-  "types": "eikjson.d.ts",
-  "scripts": {
-    "style:check": "prettier -c .",
-    "style:format": "prettier -w .",
-    "schema:types": "json2ts ./src/eikjson.schema.json > eikjson.d.ts",
-    "schema:outdated": "npm run schema:types && git diff --exit-code HEAD:eikjson.d.ts eikjson.d.ts",
-    "typecheck": "tsc",
-    "prepublish": "npm run typecheck",
-    "test": "tap --no-check-coverage",
-    "lint:fix": "eslint --fix .",
-    "lint": "eslint ."
-  },
-  "license": "ISC",
-  "dependencies": {
-    "ajv": "8.11.0",
-    "ajv-formats": "2.1.1",
-    "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",
-    "json-schema-to-typescript": "10.1.5",
-    "prettier": "2.5.1",
-    "typescript": "4.7.4"
-  }
-}

package/packages/schemas/test/assert.js

@@ -1,207 +0,0 @@
-const tap = require('tap');
-const assert = require('../src/assert.js');
-
-tap.test('assert basic eik JSON file', (t) => {
-    t.doesNotThrow(() => {
-        assert.eikJSON({
-            name: 'my-app-name',
-            version: '1.0.0',
-            server: 'http://localhost:4001',
-            files: {
-                'index.js': './assets/scripts.js',
-                'index.css': './assets/styles.css',
-            },
-        });
-    });
-    t.end();
-});
-
-tap.test('assert eik JSON file - mutation does not occur', (t) => {
-    const data = {
-        name: 'my-app-name',
-        version: '1.0.0',
-        server: 'http://localhost:4001',
-        files: {
-            'index.js': './assets/scripts.js',
-            'index.css': './assets/styles.css',
-        },
-    };
-
-    assert.eikJSON(data);
-
-    t.same(data, {
-        name: 'my-app-name',
-        version: '1.0.0',
-        server: 'http://localhost:4001',
-        files: {
-            'index.js': './assets/scripts.js',
-            'index.css': './assets/styles.css',
-        },
-    });
-    t.end();
-});
-
-tap.test('assert asset manifest - all props invalid', (t) => {
-    t.throws(() => {
-        assert.eikJSON({
-            name: '',
-        });
-    });
-    t.end();
-});
-
-tap.test('assert name: empty string', (t) => {
-    t.throws(() => {
-        assert.name('');
-    });
-    t.end();
-});
-
-tap.test('assert name: valid', (t) => {
-    t.doesNotThrow(() => {
-        assert.name('@finn-no/my-app');
-    });
-    t.end();
-});
-
-tap.test('assert name: invalid by assert-npm-package-name module', (t) => {
-    t.throws(() => {
-        assert.name('@finn-no/my-app~');
-    });
-    t.end();
-});
-
-tap.test('assert version: empty string', (t) => {
-    t.throws(() => {
-        assert.version('');
-    });
-    t.end();
-});
-
-tap.test('assert version: valid', (t) => {
-    t.doesNotThrow(() => {
-        assert.version('1.0.0');
-    });
-    t.end();
-});
-
-tap.test('assert type: invalid', (t) => {
-    t.plan(1);
-    try {
-        assert.type('foo');
-    } catch (err) {
-        t.equal(
-            err.message,
-            'Parameter "type" is not valid: must be equal to one of the allowed values ("package", npm", map")',
-        );
-    }
-    t.end();
-});
-
-tap.test('assert type: valid - package', (t) => {
-    t.doesNotThrow(() => {
-        assert.type('package');
-    });
-    t.end();
-});
-
-tap.test('assert type: valid - npm', (t) => {
-    t.doesNotThrow(() => {
-        assert.type('npm');
-    });
-    t.end();
-});
-
-tap.test('assert type: valid - map', (t) => {
-    t.doesNotThrow(() => {
-        assert.type('map');
-    });
-    t.end();
-});
-
-tap.test('assert version: invalid by node-semver module', (t) => {
-    t.throws(() => {
-        assert.version('1.0');
-    });
-    t.end();
-});
-
-tap.test('assert server: valid', (t) => {
-    t.doesNotThrow(() => {
-        assert.server('http://localhost:4000');
-    });
-    t.end();
-});
-
-tap.test('assert server: invalid', (t) => {
-    t.throws(() => {
-        assert.server('localhost');
-    });
-    t.end();
-});
-
-tap.test('assert files: valid', (t) => {
-    t.doesNotThrow(() => {
-        assert.files({ 'index.js': '/path/to/file.js' });
-    });
-    t.end();
-});
-
-tap.test('assert files: invalid', (t) => {
-    t.throws(() => {
-        assert.files({ asd: 1 });
-    });
-    t.end();
-});
-
-tap.test('assert files: invalid', (t) => {
-    t.throws(() => {
-        assert.files({});
-    });
-    t.end();
-});
-
-tap.test('assert importMap: valid string', (t) => {
-    t.doesNotThrow(() => {
-        assert.importMap('http://myimportmap/file.json');
-    });
-    t.end();
-});
-
-tap.test('assert importMap: valid array', (t) => {
-    t.doesNotThrow(() => {
-        assert.importMap([
-            'http://myimportmap/file1.json',
-            'http://myimportmap/file2.json',
-        ]);
-    });
-    t.end();
-});
-
-tap.test('assert importMap: invalid string', (t) => {
-    t.throws(() => {
-        assert.importMap('');
-    });
-    t.end();
-});
-
-tap.test('assert importMap: invalid array', (t) => {
-    t.throws(() => {
-        assert.importMap(['']);
-    });
-    t.end();
-});
-
-tap.test('assert out: valid', (t) => {
-    t.doesNotThrow(() => {
-        assert.out('./.eik');
-    });
-    t.end();
-});
-
-tap.test('assert out: invalid', (t) => {
-    t.throws(() => {
-        assert.out('');
-    });
-    t.end();
-});

package/packages/schemas/test/index.js

@@ -1,182 +0,0 @@
-const tap = require('tap');
-const { validate } = require('../index.js');
-
-tap.test('validate basic eik JSON file', (t) => {
-    const result = validate.eikJSON({
-        name: 'my-app-name',
-        version: '1.0.0',
-        server: 'http://localhost:4001',
-        files: {
-            'index.js': './assets/scripts.js',
-            'index.css': './assets/styles.css',
-        },
-    });
-    t.equal(result.value.type, 'package');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate asset manifest - all props invalid', (t) => {
-    const result = validate.eikJSON({
-        name: '',
-    });
-
-    t.same(result.value, { name: '', type: 'package' });
-    t.equal(result.error[0].message, `must have required property 'server'`);
-    t.end();
-});
-
-tap.test('validate name: empty string', (t) => {
-    const result = validate.name('');
-    t.equal(result.value, '');
-    t.equal(result.error.length, 1);
-    t.end();
-});
-
-tap.test('validate name: valid', (t) => {
-    const result = validate.name('@finn-no/my-app');
-    t.equal(result.value, '@finn-no/my-app');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate name: invalid by validate-npm-package-name module', (t) => {
-    const result = validate.name('@finn-no/my-app~');
-    t.equal(result.value, '@finn-no/my-app~');
-    t.equal(result.error.length, 1);
-    t.end();
-});
-
-tap.test('validate version: empty string', (t) => {
-    const result = validate.version('');
-    t.equal(result.value, '');
-    t.equal(result.error.length, 1);
-    t.end();
-});
-
-tap.test('validate version: valid', (t) => {
-    const result = validate.version('1.0.0');
-    t.equal(result.value, '1.0.0');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate type: empty string', (t) => {
-    const result = validate.type('');
-    t.equal(result.value, '');
-    t.equal(result.error.length, 1);
-    t.equal(
-        result.error[0].message,
-        'must be equal to one of the allowed values',
-    );
-    t.end();
-});
-
-tap.test('validate type: valid - package', (t) => {
-    const result = validate.type('package');
-    t.equal(result.value, 'package');
-    t.equal(result.error, false);
-    t.end();
-});
-tap.test('validate type: valid - npm', (t) => {
-    const result = validate.type('npm');
-    t.equal(result.value, 'npm');
-    t.equal(result.error, false);
-    t.end();
-});
-tap.test('validate type: valid - map', (t) => {
-    const result = validate.type('map');
-    t.equal(result.value, 'map');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate version: invalid by node-semver module', (t) => {
-    const result = validate.version('1.0');
-    t.equal(result.value, '1.0');
-    t.equal(result.error.length, 1);
-    t.end();
-});
-
-tap.test('validate server: valid', (t) => {
-    const result = validate.server('http://localhost:4000');
-    t.equal(result.value, 'http://localhost:4000');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate server: invalid', (t) => {
-    const result = validate.server('localhost');
-    t.equal(result.value, 'localhost');
-    t.equal(result.error.length, 1);
-    t.end();
-});
-
-tap.test('validate files: valid', (t) => {
-    const result = validate.files({ 'index.js': '/path/to/file.js' });
-    t.same(result.value, { 'index.js': '/path/to/file.js' });
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate files: invalid', (t) => {
-    const result = validate.files({ asd: 1 });
-    t.same(result.value, { asd: 1 });
-    t.equal(result.error.length, 3);
-    t.end();
-});
-
-tap.test('validate files: invalid', (t) => {
-    const result = validate.files({});
-    t.same(result.value, {});
-    t.equal(result.error.length, 3);
-    t.end();
-});
-
-tap.test('validate importMap: valid string', (t) => {
-    const result = validate.importMap('http://myimportmap/file.json');
-    t.same(result.value, 'http://myimportmap/file.json');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate importMap: valid array', (t) => {
-    const result = validate.importMap([
-        'http://myimportmap/file1.json',
-        'http://myimportmap/file2.json',
-    ]);
-    t.same(result.value, [
-        'http://myimportmap/file1.json',
-        'http://myimportmap/file2.json',
-    ]);
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate importMap: invalid string', (t) => {
-    const result = validate.importMap('');
-    t.same(result.value, '');
-    t.equal(result.error.length, 3);
-    t.end();
-});
-
-tap.test('validate importMap: invalid array', (t) => {
-    const result = validate.importMap(['']);
-    t.same(result.value, ['']);
-    t.equal(result.error.length, 3);
-    t.end();
-});
-
-tap.test('validate out: valid', (t) => {
-    const result = validate.out('./.eik');
-    t.same(result.value, './.eik');
-    t.equal(result.error, false);
-    t.end();
-});
-
-tap.test('validate out: invalid', (t) => {
-    const result = validate.out('');
-    t.same(result.value, '');
-    t.equal(result.error.length, 1);
-    t.end();
-});

package/packages/utils/.prettierignore

@@ -1,17 +0,0 @@
-node_modules/**/*
-.nyc_output/**/*
-package-lock.json
-node_modules/**/*
-.DS_Store
-tmp/**/*
-.idea
-.idea/**/*
-*.iml
-*.log
-coverage
-.vscode
-eikjson.d.ts
-CHANGELOG.md
-dist
-types
-renovate.json

package/packages/utils/index.js

@@ -1,20 +0,0 @@
-const typeSlug = require('./src/type-slug.js');
-const typeTitle = require('./src/type-title.js');
-const { isStream, isReadableStream } = require('./src/stream.js');
-const {
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-} = require('./src/path-slashes.js');
-
-module.exports = {
-    addTrailingSlash,
-    removeTrailingSlash,
-    addLeadingSlash,
-    removeLeadingSlash,
-    isStream,
-    isReadableStream,
-    typeSlug,
-    typeTitle,
-};

package/packages/utils/package.json

@@ -1,29 +0,0 @@
-{
-  "name": "@eik/common-utils",
-  "version": "1.0.0",
-  "description": "Shared utils shared between for Eik packages",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo No tests",
-    "lint:fix": "eslint --fix .",
-    "lint": "eslint .",
-    "style:check": "prettier -c .",
-    "style:format": "prettier -w .",
-    "typecheck": "tsc"
-  },
-  "license": "ISC",
-  "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",
-    "tap": "15.2.3",
-    "typescript": "4.7.4"
-  }
-}

package/packages/utils/src/stream.js

@@ -1,21 +0,0 @@
-function isStream(stream) {
-    return (
-        stream !== null &&
-        typeof stream === 'object' &&
-        typeof stream.pipe === 'function'
-    );
-}
-
-function isReadableStream(stream) {
-    return (
-        isStream(stream) &&
-        stream.readable !== false &&
-        typeof stream._read === 'function' &&
-        typeof stream._readableState === 'object'
-    );
-}
-
-module.exports = {
-    isStream,
-    isReadableStream,
-};

package/packages/utils/tests/eik.json

@@ -1,10 +0,0 @@
-{
-  "name": "my-app",
-  "version": "1.0.0",
-  "server": "https://assets.myeikserver.com",
-  "files": {
-    "esm.js": "./assets/esm.js",
-    "esm.css": "./assets/esm.css",
-    "/assets": "./assets/**/*.map"
-  }
-}

package/packages/validators/.prettierignore

@@ -1,17 +0,0 @@
-node_modules/**/*
-.nyc_output/**/*
-package-lock.json
-node_modules/**/*
-.DS_Store
-tmp/**/*
-.idea
-.idea/**/*
-*.iml
-*.log
-coverage
-.vscode
-eikjson.d.ts
-CHANGELOG.md
-dist
-types
-renovate.json

package/packages/validators/package.json

@@ -1,34 +0,0 @@
-{
-  "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"
-  }
-}