@data-fair/lib-node 2.3.1 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-node",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "Small nodejs related utility functions for the data-fair stack.",
   "main": "index.js",
   "files": [
@@ -15,10 +15,9 @@
   },
   "dependencies": {
     "@data-fair/lib-common-types": "^1.5.0",
+    "@data-fair/lib-validation": "^1.0.0",
     "@data-fair/lib-utils": "^1.1.0",
     "agentkeepalive": "^4.5.0",
-    "ajv-formats": "^3.0.1",
-    "ajv-i18n": "^4.2.0",
     "axios": "^1.7.7",
     "cacheable-lookup": "^7.0.0",
     "semver": "^7.6.3"

package/upgrade-scripts.js

@@ -1,6 +1,6 @@
 import semver from 'semver'
 import path from 'path'
-import { readdirSync, readFileSync } from 'fs'
+import { readdirSync, readFileSync, statSync } from 'fs'
 import Debug from 'debug'
 const debug = Debug('upgrade')
 // chose the proper scripts to execute, then run them
@@ -34,19 +34,19 @@ async function runScripts (db, basePath, isFresh) {
   debug('list scripts from ' + scriptsRoot)
   let scripts = await listScripts(scriptsRoot)
   if (previousPersion) {
-    debug(`Current service version from database : ${previousPersion}`)
+    debug(`current service version from database : ${previousPersion}`)
   } else {
-    debug('No service version found in database, this is the first time the upgrade system is run')
+    debug('no service version found in database, this is the first time the upgrade system is run')
     scripts = scripts.filter(scriptDef => scriptDef.version === 'init')
     if (isFresh) {
       if (await isFresh()) {
-        debug('isFresh function returned true, this is fresh install, do not run any script')
+        debug('isFresh function returned true, this is a fresh install, do not run any script')
       } else {
-        debug('isFresh function returned false, this is not fresh install, run all init scripts')
+        debug('isFresh function returned false, this is not a fresh install, run all init scripts')
         previousPersion = '0.0.0'
       }
     } else {
-      debug('No isFresh function, it could be a fresh install, do not run any script')
+      debug('no isFresh function, it could be a fresh install, do not run any script')
     }
   }
   if (previousPersion) {
@@ -54,7 +54,7 @@ async function runScripts (db, basePath, isFresh) {
       if (semver.gte(scriptDef.version, previousPersion)) {
         for (const scriptName of scriptDef.names) {
           const script = (await import(path.join(scriptsRoot, scriptDef.version, scriptName))).default
-          debug('Apply script %s/%s : %s', scriptDef.version, scriptName, script.description)
+          debug('apply script %s/%s : %s', scriptDef.version, scriptName, script.description)
           await script.exec(db, Debug(`upgrade:${scriptDef.version}:${scriptName}`))
         }
       }
@@ -63,12 +63,14 @@ async function runScripts (db, basePath, isFresh) {
   const coercedVersion = semver.coerce(pjson.version)
   if (!coercedVersion) { throw new Error(`Invalid version number in package.json ${pjson.version}`) }
   const newService = { id: pjson.name, version: coercedVersion.version }
-  debug(`Upgrade scripts are over, save current version number ${newService.version}`)
+  debug(`upgrade scripts are over, save current version number ${newService.version}`)
   await services.updateOne({ id: pjson.name }, { $set: newService }, { upsert: true })
 }
 // Walk the scripts directories
 async function listScripts (scriptsRoot) {
-  const dirs = readdirSync(scriptsRoot).sort()
+  const dirs = readdirSync(scriptsRoot)
+    .filter(dir => statSync(path.join(scriptsRoot, dir)).isDirectory())
+    .sort()
   return dirs.map(dir => {
     return {
       version: dir,

package/validation.d.ts

@@ -1,8 +1 @@
-import type { ErrorObject, ValidateFunction } from 'ajv';
-export declare const errorsText: (errors: ErrorObject[] | null | undefined, varName?: string) => string;
-export type AssertValidOptions = {
-    lang?: string;
-    name?: string;
-    internal?: boolean;
-};
-export declare function assertValid<T>(validate: ValidateFunction, data: any, options?: AssertValidOptions): asserts data is T;
+export * from '@data-fair/lib-validation';

package/validation.js

@@ -1,37 +1 @@
-import ajvFrModule from 'ajv-i18n/localize/fr/index.js'
-import ajvEnModule from 'ajv-i18n/localize/en/index.js'
-import { httpError } from '@data-fair/lib-utils/http-errors.js'
-const ajvFr = ajvFrModule
-const ajvEn = ajvEnModule
-const localize = {
-  fr: ajvFr,
-  en: ajvEn
-}
-// cf https://github.com/ajv-validator/ajv/blob/b3e0cb17d0e095b5c883042b2306571be5ec86b7/lib/core.ts#L650
-export const errorsText = (errors, varName = 'data') => {
-  if (!errors || errors.length === 0) { return 'No errors' }
-  return errors
-    .map((e) => {
-      let msg = `${varName}${e.instancePath} ${e.message}`.trim()
-      const paramKeys = Object.keys(e.params || {}).filter(key => {
-        if (key === 'error') { return false }
-        if (e.keyword === 'type' && key === 'type') { return false }
-        return true
-      })
-      const params = paramKeys
-        .map(key => paramKeys.length > 1 ? `${key}=${e.params[key]}` : e.params[key])
-        .join(', ')
-      if (params) { msg += ` (${params})` }
-      return msg
-    })
-    .reduce((text, msg) => text + ', ' + msg)
-}
-export function assertValid (validate, data, options = {}) {
-  const lang = options.lang ?? 'fr'
-  const name = options.name ?? 'data'
-  if (!validate(data)) {
-    (localize[lang] || localize.fr)(validate.errors)
-    const message = errorsText(validate.errors, name)
-    if (options.internal) { throw new Error(message) } else { throw httpError(400, message) }
-  }
-}
+export * from '@data-fair/lib-validation'