@eik/common 4.0.0-next.3 → 4.0.0-next.6

package/.eslintignore

@@ -0,0 +1,2 @@
+coverage
+types

package/.eslintrc

@@ -0,0 +1,34 @@
+{
+    "parser": "@babel/eslint-parser",
+    "extends": [
+        "airbnb-base",
+        "prettier"
+    ],
+    "plugins": [
+        "prettier"
+    ],
+    "parserOptions": {
+        "ecmaVersion": 11,
+        "sourceType": "module",
+        "requireConfigFile": false
+    },
+    "rules": {
+        "import/prefer-default-export": "off",
+        "import/extensions": [
+            "error",
+            {
+                "js": "ignorePackages",
+                "json": "ignorePackages"
+            }
+        ],
+        "class-methods-use-this": [
+            0
+        ],
+        "no-underscore-dangle": [
+            0
+        ],
+        "no-restricted-syntax": [
+            0
+        ]
+    }
+}

package/.github/workflows/publish.yml

@@ -0,0 +1,69 @@
+name: Release and Publish
+
+on:
+  push:
+    branches:
+      - master
+      - alpha
+      - beta
+      - next
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: install dependencies
+        run: |
+          npm install --workspaces
+        env:
+          CI: true
+      - name: lint files
+        run: |
+          npm run lint --workspaces
+        env:
+          CI: true
+      - name: style check files
+        run: |
+          npm run style:check --workspaces
+        env:
+          CI: true
+      - name: typecheck files
+        run: |
+          npm run typecheck --workspaces
+        env:
+          CI: true
+      - name: check eik json schema is up to date
+        run: |
+          npm run schema:outdated --workspaces
+        env:
+          CI: true
+      - name: run tests
+        run: |
+          npm test --workspaces
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: npm install
+        run: |
+          npm install --workspaces
+      - name: npx semantic-release
+        run: |
+          npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Run Lint and Tests
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        node-version: [16.x, 18.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: install dependencies
+        run: |
+          npm install --workspaces
+        env:
+          CI: true
+      - name: lint files
+        run: |
+          npm run lint --workspaces
+        env:
+          CI: true
+      - name: style check files
+        run: |
+          npm run style:check --workspaces
+        env:
+          CI: true
+      - name: typecheck files
+        run: |
+          npm run typecheck --workspaces
+        env:
+          CI: true
+      - name: check eik json schema is up to date
+        run: |
+          npm run schema:outdated --workspace=packages/schemas
+        env:
+          CI: true
+      - name: run tests
+        run: |
+          npm test --workspaces

package/.prettierignore

@@ -0,0 +1,17 @@
+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/.prettierrc

@@ -0,0 +1,20 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "tabWidth": 4,
+  "overrides": [
+    {
+      "files": [
+        ".prettierrc",
+        "*.json",
+        "*.yml",
+        ".travis.yml",
+        ".eslintrc",
+        "release.config.js"
+      ],
+      "options": {
+        "tabWidth": 2
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -1,3 +1,63 @@
+# [4.0.0-next.6](https://github.com/eik-lib/common/compare/v4.0.0-next.5...v4.0.0-next.6) (2022-07-26)
+
+
+### Bug Fixes
+
+* lint ([edc595f](https://github.com/eik-lib/common/commit/edc595f6f4baf465e736bed8a4cb2e0eb8efe382))
+
+# [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)
 
 

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/fixtures/client-with-bare-imports.js

@@ -0,0 +1,16 @@
+/* eslint-disable import/no-unresolved */
+
+import scrollIntoView from 'scroll-into-view-if-needed';
+
+const main = () => {
+    // eslint-disable-next-line no-undef
+    const node = document.getElementById('hero');
+
+    scrollIntoView(node, {
+        scrollMode: 'if-needed',
+        block: 'nearest',
+        inline: 'nearest',
+    });
+};
+
+main();

package/fixtures/client.js

@@ -0,0 +1,6 @@
+const main = () => {
+    const thing = 'this is a test fixture';
+    return thing;
+};
+
+main();

package/fixtures/folder/client.js

@@ -0,0 +1,6 @@
+const main = () => {
+    const thing = 'this is a test fixture';
+    return thing;
+};
+
+main();

package/fixtures/icons/checkbox-sprite.svg

@@ -0,0 +1,46 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="104" height="26">
+  <defs>
+    <rect id="checkboxes-a" width="20" height="20" rx="4"/>
+    <path id="checkboxes-b" d="M4.42 7.6L3 9.03l4.45 4.47 7.05-7.07L13.08 5l-5.63 5.64z"/>
+    <rect id="checkboxes-d" width="20" height="20" x="3" y="3" rx="4"/>
+    <rect id="checkboxes-e" width="20" height="20" x="3" y="3" rx="4"/>
+    <path id="checkboxes-f" d="M4.42 7.6L3 9.03l4.45 4.47 7.05-7.07L13.08 5l-5.63 5.64z"/>
+    <rect id="checkboxes-h" width="20" height="20" x="3" y="3" rx="4"/>
+  </defs>
+  <g fill="none" fill-rule="evenodd">
+    <g transform="translate(81 3)">
+      <use fill="#FFF" xlink:href="#checkboxes-a"/>
+      <rect width="21" height="21" x="-.5" y="-.5" stroke="#DFE4E8" rx="4"/>
+      <g transform="translate(1 1)">
+        <path d="M0 0h18v18H0z"/>
+        <mask id="checkboxes-c" fill="#fff">
+          <use xlink:href="#checkboxes-b"/>
+        </mask>
+        <use fill="#767676" fill-rule="nonzero" xlink:href="#checkboxes-b"/>
+        <g fill="#DFE4E8" mask="url(#checkboxes-c)">
+          <rect width="18" height="18" rx="4"/>
+        </g>
+      </g>
+    </g>
+    <g transform="translate(52)">
+      <use fill="#FFF" xlink:href="#checkboxes-d"/>
+      <rect width="21" height="21" x="2.5" y="2.5" stroke="#DFE4E8" rx="4"/>
+    </g>
+    <g transform="translate(26)">
+      <use fill="#FFF" xlink:href="#checkboxes-e"/>
+      <rect width="21" height="21" x="2.5" y="2.5" stroke="#767676" rx="4"/>
+      <g transform="translate(4 4)">
+        <path d="M0 0h18v18H0z"/>
+        <mask id="checkboxes-g" fill="#fff">
+          <use xlink:href="#checkboxes-f"/>
+        </mask>
+        <use fill="#767676" fill-rule="nonzero" xlink:href="#checkboxes-f"/>
+        <g fill="#767676" mask="url(#checkboxes-g)">
+          <rect width="18" height="18" rx="4"/>
+        </g>
+      </g>
+    </g>
+    <use fill="#FFF" xlink:href="#checkboxes-h"/>
+    <rect width="21" height="21" x="2.5" y="2.5" stroke="#767676" rx="4"/>
+  </g>
+</svg>

package/package.json

@@ -1,66 +1,10 @@
 {
   "name": "@eik/common",
-  "version": "4.0.0-next.3",
-  "description": "Common utilities for Eik modules",
-  "main": "lib/index.js",
-  "types": "types/index.d.ts",
-  "files": [
-    "CHANGELOG.md",
-    "package.json",
-    "lib",
-    "types"
+  "workspaces": [
+    "packages/config-loader",
+    "packages/utils",
+    "packages/schemas",
+    "packages/validators"
   ],
-  "scripts": {
-    "test": "tap --test-regex=.test.js --test-ignore=node_modules",
-    "lint:fix": "eslint --fix .",
-    "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",
-    "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": "^7.0.0",
-    "ajv-formats": "^1.5.1",
-    "glob": "^7.1.6",
-    "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"
-  },
-  "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",
-    "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",
-    "stoppable": "1.1.0",
-    "tap": "14.11.0"
-  }
+  "version": "4.0.0-next.6"
 }

package/packages/config-loader/.prettierignore

@@ -0,0 +1,17 @@
+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/config-loader/index.js

@@ -0,0 +1,13 @@
+const ReadFile = require('./src/classes/read-file.js');
+const EikConfig = require('./src/eik-config.js');
+const getDefaults = require('./src/get-defaults.js');
+const configStore = require('./src/config-store.js');
+const localAssets = require('./src/local-assets');
+
+module.exports = {
+    ReadFile,
+    EikConfig,
+    getDefaults,
+    configStore,
+    localAssets,
+};

package/packages/config-loader/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@eik/common-config-loader",
+  "version": "1.0.0",
+  "description": "Shared config loader for Eik packages",
+  "main": "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": {
+    "@eik/common-schemas": "1.0.0",
+    "@eik/common-utils": "1.0.0",
+    "glob": "8.0.3",
+    "is-glob": "4.0.3",
+    "mime-types": "2.1.35",
+    "node-fetch": "2.6.6"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "7.16.5",
+    "@hapi/hapi": "20.2.2",
+    "@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",
+    "express": "4.18.1",
+    "fastify": "3.29.0",
+    "prettier": "2.5.1",
+    "stoppable": "1.1.0",
+    "tap": "15.2.3",
+    "typescript": "4.7.4"
+  }
+}

package/{lib → packages/config-loader/src}/classes/file-mapping.js

@@ -4,8 +4,8 @@
  * @type {(value: unknown, message?: string) => asserts value}
  */
 const assert = require('assert');
-const LocalFileLocation = require('./local-file-location');
-const RemoteFileLocation = require('./remote-file-location');
+const LocalFileLocation = require('./local-file-location.js');
+const RemoteFileLocation = require('./remote-file-location.js');
 
 /**
  * Class containing a local file system source location and remote server destination location for a file.

package/{lib → packages/config-loader/src}/classes/read-file.js

@@ -1,4 +1,4 @@
-const { isReadableStream } = require('../stream');
+const { isReadableStream } = require('@eik/common-utils');
 
 const ReadFile = class ReadFile {
     constructor({ mimeType = '', etag = '' } = {}) {
@@ -29,4 +29,5 @@ const ReadFile = class ReadFile {
         return 'ReadFile';
     }
 };
+
 module.exports = ReadFile;

package/{lib → packages/config-loader/src}/classes/resolved-files.js

@@ -2,11 +2,12 @@
  * @type {(value: unknown, message?: string) => asserts value}
  */
 const assert = require('assert');
-const LocalFileLocation = require('./local-file-location');
 const {
     removeLeadingSlash,
     removeTrailingSlash,
-} = require('../helpers/path-slashes');
+} = require('@eik/common-utils');
+
+const LocalFileLocation = require('./local-file-location');
 
 const originalFiles = Symbol('files');
 

package/{lib/helpers → packages/config-loader/src}/config-store.js

@@ -2,10 +2,10 @@ const { readFileSync, writeFileSync } = require('fs');
 const { join } = require('path');
 const homedir = require('os').homedir();
 
-const EikConfig = require('../classes/eik-config');
-const MissingConfigError = require('../classes/missing-config-error');
-const MultipleConfigSourcesError = require('../classes/multiple-config-sources-error');
-const InvalidConfigError = require('../classes/invalid-config-error');
+const EikConfig = require('./eik-config.js');
+const MissingConfigError = require('./errors/missing-config-error.js');
+const MultipleConfigSourcesError = require('./errors/multiple-config-sources-error.js');
+const InvalidConfigError = require('./errors/invalid-config-error.js');
 
 /**
  * Read a file at a given path and parse it

package/{lib/classes → packages/config-loader/src}/eik-config.js

@@ -5,14 +5,16 @@
  */
 const assert = require('assert');
 const { extname, join, isAbsolute } = require('path');
-const NoFilesMatchedError = require('./no-files-matched-error');
-const SingleDestMultipleSourcesError = require('./single-dest-multiple-source-error');
-const FileMapping = require('./file-mapping');
-const RemoteFileLocation = require('./remote-file-location');
-const schemas = require('../schemas');
-const { removeTrailingSlash } = require('../helpers/path-slashes');
-const typeSlug = require('../helpers/type-slug');
-const resolveFiles = require('../helpers/resolve-files');
+const { typeSlug, removeTrailingSlash } = require('@eik/common-utils');
+
+const schemas = require('@eik/common-schemas');
+
+const resolveFiles = require('./utils/resolve-files.js');
+
+const RemoteFileLocation = require('./classes/remote-file-location.js');
+const FileMapping = require('./classes/file-mapping.js');
+const SingleDestMultipleSourcesError = require('./errors/single-dest-multiple-source-error.js');
+const NoFilesMatchedError = require('./errors/no-files-matched-error.js');
 
 const _config = Symbol('config');
 const _tokens = Symbol('tokens');
@@ -31,7 +33,7 @@ const normalizeFilesDefinition = (files) =>
  * @typedef {import ("../../eikjson").EikjsonSchema} EikjsonSchema
  */
 
-module.exports = class EikConfig {
+class EikConfig {
     /**
      * @param {EikjsonSchema?} configHash
      * @param {[string, string][]?} tokens
@@ -162,4 +164,6 @@ module.exports = class EikConfig {
             });
         });
     }
-};
+}
+
+module.exports = EikConfig;

package/{lib/classes → packages/config-loader/src/errors}/custom-error.js

@@ -1,4 +1,4 @@
-module.exports = class CustomError extends Error {
+class CustomError extends Error {
     /**
      * @param {string} message
      */
@@ -7,4 +7,6 @@ module.exports = class CustomError extends Error {
         this.name = this.constructor.name;
         Error.captureStackTrace(this, this.constructor);
     }
-};
+}
+
+module.exports = CustomError;