@eik/common 4.0.0-next.7 → 4.0.1

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

@@ -0,0 +1,9 @@
+/**
+ * Sets up and returns an object containing a set of default values for the app context.
+ * Default values are fetched from the app's eik.json or package.json file as well as from .eikrc, if present in the users home directory.
+ *
+ * @param {string} directoryOrFilepath The directory to search for eik.json or package.json or an exact path to an eik.json or package.json file
+ *
+ * @returns {import("../classes/eik-config")} EikConfig
+ */
+export default function getDefaults(directoryOrFilepath: string): typeof import("../classes/eik-config.js");

package/types/helpers/index.d.ts

@@ -0,0 +1,23 @@
+declare namespace _default {
+    export { localAssets };
+    export { getDefaults };
+    export { configStore };
+    export { typeSlug };
+    export { typeTitle };
+    export { addTrailingSlash };
+    export { removeTrailingSlash };
+    export { addLeadingSlash };
+    export { removeLeadingSlash };
+    export { resolveFiles };
+}
+export default _default;
+import localAssets from './local-assets.js';
+import getDefaults from './get-defaults.js';
+import configStore from './config-store.js';
+import typeSlug from './type-slug.js';
+import typeTitle from './type-title.js';
+import { addTrailingSlash } from './path-slashes.js';
+import { removeTrailingSlash } from './path-slashes.js';
+import { addLeadingSlash } from './path-slashes.js';
+import { removeLeadingSlash } from './path-slashes.js';
+import resolveFiles from './resolve-files.js';

package/types/helpers/local-assets.d.ts

@@ -0,0 +1,8 @@
+export default 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 default 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 from '../classes/resolved-files.js';

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

@@ -0,0 +1,2 @@
+declare const _default: (type: string) => string;
+export default _default;

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

@@ -0,0 +1,2 @@
+declare const _default: (type: string) => string;
+export default _default;

package/types/index.d.ts

@@ -0,0 +1,16 @@
+declare namespace _default {
+    export { validators };
+    export { ReadFile };
+    export { EikConfig };
+    export { schemas };
+    export { stream };
+    export { helpers };
+}
+export default _default;
+import * as validators from './validators/index.js';
+import ReadFile from './classes/read-file.js';
+import EikConfig from './classes/eik-config.js';
+import schemas from './schemas/index.js';
+import * as stream from './stream.js';
+import helpers from './helpers/index.js';
+export { validators, ReadFile, EikConfig, schemas, stream, helpers };

package/types/schemas/assert.d.ts

@@ -0,0 +1,11 @@
+declare namespace _default {
+    function eikJSON(value: any): void;
+    function name(value: any): void;
+    function type(value: any): void;
+    function version(value: any): void;
+    function server(value: any): void;
+    function files(value: any): void;
+    function importMap(value: any): void;
+    function out(value: any): void;
+}
+export default _default;

package/types/schemas/index.d.ts

@@ -0,0 +1,11 @@
+declare namespace _default {
+    export { schema };
+    export { validate };
+    export { assert };
+    export { ValidationError };
+}
+export default _default;
+declare const schema: any;
+import * as validate from './validate.js';
+import assert from './assert.js';
+import ValidationError from './validation-error.js';

package/types/schemas/validate.d.ts

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

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

@@ -0,0 +1,8 @@
+export default 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): string;
+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/.eslintignore

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

package/.eslintrc

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

@@ -1,69 +0,0 @@
-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 --workspaces
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

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

@@ -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/.prettierrc

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

package/fixtures/client-with-bare-imports.js

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

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

package/fixtures/folder/client.js

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

package/fixtures/icons/checkbox-sprite.svg

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

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

@@ -1,42 +0,0 @@
-{
-  "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/packages/config-loader/src/get-defaults.js

@@ -1,25 +0,0 @@
-// @ts-check
-
-const EikConfig = require('./eik-config.js');
-const configStore = require('./config-store.js');
-
-/**
- * Sets up and returns an object containing a set of default values for the app context.
- * Default values are fetched from the app's eik.json or package.json file as well as from .eikrc, if present in the users home directory.
- *
- * @param {string} cwd The current working directory
- *
- * @returns {import("./eik-config.js")} EikConfig
- */
-function getDefaults(cwd) {
-    try {
-        return configStore.findInDirectory(cwd);
-    } catch (e) {
-        if (e.constructor.name === 'MissingConfigError') {
-            return new EikConfig(null, [], cwd);
-        }
-        throw e;
-    }
-}
-
-module.exports = getDefaults;