@eik/common 4.0.6 → 4.0.8

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [4.0.8](https://github.com/eik-lib/common/compare/v4.0.7...v4.0.8) (2024-08-12)
+
+
+### Bug Fixes
+
+* allow specifying $schema ([bfc6b0f](https://github.com/eik-lib/common/commit/bfc6b0f5c878f14a7e3d78c4555779247e96a766))
+* use the correct upstream schema link for ajv ([90ca025](https://github.com/eik-lib/common/commit/90ca025d67a9b8f2cf900ead23f1cfb1cddb0c2a)), closes [/ajv.js.org/guide/schema-language.html#draft-07-and-draft-06](https://github.com//ajv.js.org/guide/schema-language.html/issues/draft-07-and-draft-06)
+
+## [4.0.7](https://github.com/eik-lib/common/compare/v4.0.6...v4.0.7) (2024-08-09)
+
+
+### Bug Fixes
+
+* type issue with helpers.getDefaults ([9b29d63](https://github.com/eik-lib/common/commit/9b29d63ca9834a2a33222d03eade925f33cef91a))
+
 ## [4.0.6](https://github.com/eik-lib/common/compare/v4.0.5...v4.0.6) (2024-08-07)
 
 

package/eikjson.d.ts

@@ -6,6 +6,7 @@
  */
 
 export interface EikjsonSchema {
+  $schema?: string;
   /**
    * The URL address of the Eik server where packages are published to.
    */

package/lib/classes/eik-config.js

@@ -26,7 +26,7 @@ const normalizeFilesDefinition = (files) =>
     typeof files === 'string' ? { '/': files } : files;
 
 /**
- * @typedef {import ("../../eikjson").EikjsonSchema} EikjsonSchema
+ * @typedef {import ("../../eikjson.js").EikjsonSchema} EikjsonSchema
  */
 
 export default class EikConfig {

package/lib/helpers/config-store.js

@@ -19,6 +19,7 @@ function readJSONFromDisk(path) {
     let fileData;
     try {
         fileData = readFileSync(path, { encoding: 'utf8' });
+        // eslint-disable-next-line no-unused-vars
     } catch (e) {
         // @ts-ignore
         return null;
@@ -99,7 +100,7 @@ export default {
     /**
      * Persist config changes to disk as <cwd>/eik.json
      *
-     * @param {import('../classes/eik-config')} config
+     * @param {import('../classes/eik-config.js')} config
      */
     persistToDisk(config) {
         try {

package/lib/helpers/get-defaults.js

@@ -1,4 +1,3 @@
-// @ts-check
 import fs from 'node:fs';
 import path from 'node:path';
 import configStore from './config-store.js';
@@ -9,16 +8,14 @@ import EikConfig from '../classes/eik-config.js';
  *
  * @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
+ * @returns {import("../classes/eik-config.js").default} EikConfig
  */
 export default function getDefaults(directoryOrFilepath) {
     try {
         const stats = fs.statSync(directoryOrFilepath);
         if (stats.isDirectory()) {
-            // @ts-expect-error
             return configStore.findInDirectory(directoryOrFilepath);
         } else {
-            // @ts-expect-error
             return configStore.loadFromPath(directoryOrFilepath);
         }
     } catch (error) {
@@ -30,7 +27,6 @@ export default function getDefaults(directoryOrFilepath) {
             if (path.extname(directoryOrFilepath)) {
                 cwd = path.dirname(directoryOrFilepath);
             }
-            // @ts-expect-error
             return new EikConfig(null, [], cwd);
         }
         throw e;

package/lib/schemas/eikjson.schema.json

@@ -1,8 +1,12 @@
 {
-  "$schema": "http://json-schema.org/schema#",
+  "$schema": "http://json-schema.org/draft-07/schema#",
   "additionalProperties": false,
   "type": "object",
   "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
     "server": {
       "description": "The URL address of the Eik server where packages are published to.",
       "type": "string",

package/lib/schemas/validate.js

@@ -15,13 +15,11 @@ const eikJSONSchema = JSON.parse(
 
 // @ts-ignore
 const createValidator = (schema, ajvOptions) => {
+    // @ts-ignore
     const ajv = new Ajv(ajvOptions);
     // @ts-ignore
     formats(ajv); // Needed to support "uri"
-    const validate = ajv.compile({
-        $schema: 'http://json-schema.org/schema#',
-        ...schema,
-    });
+    const validate = ajv.compile(schema);
 
     // @ts-ignore
     return (data) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/common",
-  "version": "4.0.6",
+  "version": "4.0.8",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -13,12 +13,15 @@
     "eikjson.d.ts"
   ],
   "scripts": {
+    "clean": "rimraf .tap node_modules types",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "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",
     "test": "tap  --disable-coverage --allow-empty-coverage",
-    "types": "tsc"
+    "types": "run-s types:module types:test",
+    "types:module": "tsc",
+    "types:test": "tsc --project tsconfig.test.json"
   },
   "repository": {
     "type": "git",
@@ -41,9 +44,10 @@
     "validate-npm-package-name": "5.0.1"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.25.1",
     "@babel/plugin-syntax-import-assertions": "7.24.7",
-    "@eslint/js": "9.8.0",
+    "@eik/eslint-config": "1.0.2",
+    "@eik/semantic-release-config": "1.0.0",
+    "@eik/typescript-config": "1.0.0",
     "@hapi/hapi": "21.3.10",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -52,13 +56,12 @@
     "@types/semver": "7.5.8",
     "@types/validate-npm-package-name": "4.0.2",
     "eslint": "9.8.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.2.1",
     "express": "4.19.2",
     "fastify": "4.28.1",
-    "globals": "15.9.0",
     "json-schema-to-typescript": "15.0.0",
+    "npm-run-all": "4.1.5",
     "prettier": "3.3.3",
+    "rimraf": "6.0.1",
     "semantic-release": "24.0.0",
     "stoppable": "1.1.0",
     "tap": "21.0.0",

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

@@ -1,5 +1,5 @@
 /**
- * @typedef {import ("../../eikjson").EikjsonSchema} EikjsonSchema
+ * @typedef {import ("../../eikjson.js").EikjsonSchema} EikjsonSchema
  */
 export default class EikConfig {
     /**
@@ -17,7 +17,7 @@ export default class EikConfig {
     /** @type {EikjsonSchema["version"]} */
     get version(): string;
     /** @type {EikjsonSchema["type"]} */
-    get type(): "map" | "npm" | "package" | undefined;
+    get type(): "map" | "npm" | "package";
     /** @type {string} */
     get server(): string;
     /** @type {[string, string][]} */
@@ -56,7 +56,7 @@ export default class EikConfig {
     [_config]: EikjsonSchema;
     [_tokens]: Map<string, string>;
 }
-export type EikjsonSchema = import("../../eikjson").EikjsonSchema;
+export type EikjsonSchema = import("../../eikjson.js").EikjsonSchema;
 import FileMapping from './file-mapping.js';
 declare const _config: unique symbol;
 declare const _tokens: unique symbol;

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

@@ -1,8 +1,8 @@
 export default ReadFile;
 declare const ReadFile: {
     new ({ mimeType, etag }?: {
-        mimeType?: string | undefined;
-        etag?: string | undefined;
+        mimeType?: string;
+        etag?: string;
     }): {
         _mimeType: string;
         _stream: any;

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

@@ -16,11 +16,11 @@ declare namespace _default {
      *
      * @returns {EikConfig}
      */
-    function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function | undefined): EikConfig;
+    function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): EikConfig;
     /**
      * Persist config changes to disk as <cwd>/eik.json
      *
-     * @param {import('../classes/eik-config')} config
+     * @param {import('../classes/eik-config.js')} config
      */
     function persistToDisk(config: typeof import("../classes/eik-config.js")): void;
 }

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

@@ -4,6 +4,6 @@
  *
  * @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
+ * @returns {import("../classes/eik-config.js").default} EikConfig
  */
-export default function getDefaults(directoryOrFilepath: string): typeof import("../classes/eik-config.js");
+export default function getDefaults(directoryOrFilepath: string): import("../classes/eik-config.js").default;

package/types/schemas/validate.d.ts

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