@naturalcycles/nodejs-lib 15.7.0 → 15.8.0

package/dist/validation/ajv/ajvSchema.d.ts

@@ -1,3 +1,4 @@
+import { type ValidationFunctionResult } from '@naturalcycles/js-lib';
 import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib/json-schema';
 import type { Ajv } from 'ajv';
 import { AjvValidationError } from './ajvValidationError.js';
@@ -62,7 +63,7 @@ export declare class AjvSchema<T = unknown> {
      *
      * Returned object is always the same object (`===`) that was passed, so it is returned just for convenience.
      */
-    validate(obj: T, opt?: AjvValidationOptions): T;
-    isValid(obj: T): boolean;
-    getValidationError(obj: T, opt?: AjvValidationOptions): AjvValidationError | undefined;
+    validate(input: T, opt?: AjvValidationOptions): T;
+    isValid(input: T): boolean;
+    getValidationResult(input: T, opt?: AjvValidationOptions): ValidationFunctionResult<T, AjvValidationError>;
 }

package/dist/validation/ajv/ajvSchema.js

@@ -73,32 +73,33 @@ export class AjvSchema {
      *
      * Returned object is always the same object (`===`) that was passed, so it is returned just for convenience.
      */
-    validate(obj, opt = {}) {
-        const err = this.getValidationError(obj, opt);
-        if (err)
-            throw err;
-        return obj;
+    validate(input, opt = {}) {
+        const [error, output] = this.getValidationResult(input, opt);
+        if (error)
+            throw error;
+        return output;
     }
-    isValid(obj) {
-        return this.getValidateFunction()(obj);
+    isValid(input) {
+        return this.getValidateFunction()(input);
     }
-    getValidationError(obj, opt = {}) {
-        if (this.isValid(obj))
-            return;
+    getValidationResult(input, opt = {}) {
+        if (this.isValid(input))
+            return [null, input];
         const errors = this.getValidateFunction().errors;
-        const { objectId = _isObject(obj) ? obj['id'] : undefined, objectName = this.cfg.objectName, } = opt;
+        const { objectId = _isObject(input) ? input['id'] : undefined, objectName = this.cfg.objectName, } = opt;
         const name = [objectName || 'Object', objectId].filter(Boolean).join('.');
         let message = this.cfg.ajv.errorsText(errors, {
             dataVar: name,
             separator,
         });
-        const inputStringified = _inspect(obj, { maxLen: 4000 });
+        const inputStringified = _inspect(input, { maxLen: 4000 });
         message = [message, 'Input: ' + inputStringified].join(separator);
-        return new AjvValidationError(message, _filterNullishValues({
+        const err = new AjvValidationError(message, _filterNullishValues({
             errors,
             objectName,
             objectId,
         }));
+        return [err, input];
     }
 }
 const separator = '\n';

package/dist/validation/joi/joi.validation.util.d.ts

@@ -1,9 +1,6 @@
+import { type ValidationFunctionResult } from '@naturalcycles/js-lib';
 import type { AnySchema, ValidationOptions } from 'joi';
 import { JoiValidationError } from './joi.validation.error.js';
-export interface JoiValidationResult<T = any> {
-    value: T;
-    error?: JoiValidationError;
-}
 /**
  * Validates with Joi.
  * Throws JoiValidationError if invalid.
@@ -21,7 +18,7 @@ export declare function validate<T>(input: any, schema?: AnySchema<T>, objectNam
  *
  * If `schema` is undefined - returns value as is.
  */
-export declare function getValidationResult<T>(input: any, schema?: AnySchema<T>, objectName?: string, options?: ValidationOptions): JoiValidationResult<T>;
+export declare function getValidationResult<T>(input: T, schema?: AnySchema<T>, objectName?: string, options?: ValidationOptions): ValidationFunctionResult<T, JoiValidationError>;
 /**
  * Convenience function that returns true if !error.
  */

package/dist/validation/joi/joi.validation.util.js

@@ -39,10 +39,9 @@ const defaultOptions = {
  * If `schema` is undefined - returns value as is.
  */
 export function validate(input, schema, objectName, opt = {}) {
-    const { value: returnValue, error } = getValidationResult(input, schema, objectName, opt);
-    if (error) {
+    const [error, returnValue] = getValidationResult(input, schema, objectName, opt);
+    if (error)
         throw error;
-    }
     return returnValue;
 }
 /**
@@ -56,18 +55,13 @@ export function validate(input, schema, objectName, opt = {}) {
  */
 export function getValidationResult(input, schema, objectName, options = {}) {
     if (!schema)
-        return { value: input };
+        return [null, input];
     const { value, error } = schema.validate(input, {
         ...defaultOptions,
         ...options,
     });
-    const vr = {
-        value,
-    };
-    if (error) {
-        vr.error = createError(input, error, objectName);
-    }
-    return vr;
+    const err = error ? createError(input, error, objectName) : null;
+    return [err, value];
 }
 /**
  * Convenience function that returns true if !error.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.7.0",
+  "version": "15.8.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@types/js-yaml": "^4",
@@ -23,7 +23,7 @@
   },
   "devDependencies": {
     "@types/through2-concurrent": "^2",
-    "@naturalcycles/dev-lib": "18.4.2"
+    "@naturalcycles/dev-lib": "19.14.0"
   },
   "exports": {
     ".": "./dist/index.js",

package/src/validation/ajv/ajvSchema.ts

@@ -1,4 +1,4 @@
-import { _isObject, _lazyValue } from '@naturalcycles/js-lib'
+import { _isObject, _lazyValue, type ValidationFunctionResult } from '@naturalcycles/js-lib'
 import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib/json-schema'
 import { JsonSchemaAnyBuilder } from '@naturalcycles/js-lib/json-schema'
 import { _filterNullishValues } from '@naturalcycles/js-lib/object'
@@ -124,23 +124,26 @@ export class AjvSchema<T = unknown> {
    *
    * Returned object is always the same object (`===`) that was passed, so it is returned just for convenience.
    */
-  validate(obj: T, opt: AjvValidationOptions = {}): T {
-    const err = this.getValidationError(obj, opt)
-    if (err) throw err
-    return obj
+  validate(input: T, opt: AjvValidationOptions = {}): T {
+    const [error, output] = this.getValidationResult(input, opt)
+    if (error) throw error
+    return output
   }
 
-  isValid(obj: T): boolean {
-    return this.getValidateFunction()(obj)
+  isValid(input: T): boolean {
+    return this.getValidateFunction()(input)
   }
 
-  getValidationError(obj: T, opt: AjvValidationOptions = {}): AjvValidationError | undefined {
-    if (this.isValid(obj)) return
+  getValidationResult(
+    input: T,
+    opt: AjvValidationOptions = {},
+  ): ValidationFunctionResult<T, AjvValidationError> {
+    if (this.isValid(input)) return [null, input]
 
     const errors = this.getValidateFunction().errors!
 
     const {
-      objectId = _isObject(obj) ? (obj['id' as keyof T] as any) : undefined,
+      objectId = _isObject(input) ? (input['id' as keyof T] as any) : undefined,
       objectName = this.cfg.objectName,
     } = opt
     const name = [objectName || 'Object', objectId].filter(Boolean).join('.')
@@ -150,10 +153,10 @@ export class AjvSchema<T = unknown> {
       separator,
     })
 
-    const inputStringified = _inspect(obj, { maxLen: 4000 })
+    const inputStringified = _inspect(input, { maxLen: 4000 })
     message = [message, 'Input: ' + inputStringified].join(separator)
 
-    return new AjvValidationError(
+    const err = new AjvValidationError(
       message,
       _filterNullishValues({
         errors,
@@ -161,6 +164,7 @@ export class AjvSchema<T = unknown> {
         objectId,
       }),
     )
+    return [err, input]
   }
 }
 

package/src/validation/joi/joi.validation.util.ts

@@ -6,18 +6,12 @@
  * "Converts" mean e.g trims all strings from leading/trailing spaces.
  */
 
-import { _hb, _isObject } from '@naturalcycles/js-lib'
+import { _hb, _isObject, type ValidationFunctionResult } from '@naturalcycles/js-lib'
 import { _truncateMiddle } from '@naturalcycles/js-lib/string/string.util.js'
 import type { AnySchema, ValidationError, ValidationOptions } from 'joi'
 import type { JoiValidationErrorData } from './joi.validation.error.js'
 import { JoiValidationError } from './joi.validation.error.js'
 
-// todo: consider replacing with Tuple of [error, value]
-export interface JoiValidationResult<T = any> {
-  value: T
-  error?: JoiValidationError
-}
-
 // Strip colors in production (for e.g Sentry reporting)
 // const stripColors = process.env.NODE_ENV === 'production' || !!process.env.GAE_INSTANCE
 // Currently colors do more bad than good, so let's strip them always for now
@@ -56,12 +50,8 @@ export function validate<T>(
   objectName?: string,
   opt: ValidationOptions = {},
 ): T {
-  const { value: returnValue, error } = getValidationResult(input, schema, objectName, opt)
-
-  if (error) {
-    throw error
-  }
-
+  const [error, returnValue] = getValidationResult(input, schema, objectName, opt)
+  if (error) throw error
   return returnValue
 }
 
@@ -75,27 +65,20 @@ export function validate<T>(
  * If `schema` is undefined - returns value as is.
  */
 export function getValidationResult<T>(
-  input: any,
+  input: T,
   schema?: AnySchema<T>,
   objectName?: string,
   options: ValidationOptions = {},
-): JoiValidationResult<T> {
-  if (!schema) return { value: input }
+): ValidationFunctionResult<T, JoiValidationError> {
+  if (!schema) return [null, input]
 
   const { value, error } = schema.validate(input, {
     ...defaultOptions,
     ...options,
   })
 
-  const vr: JoiValidationResult<T> = {
-    value,
-  }
-
-  if (error) {
-    vr.error = createError(input, error, objectName)
-  }
-
-  return vr
+  const err = error ? createError(input, error, objectName) : null
+  return [err, value]
 }
 
 /**

package/dist/stream/transform/worker/workerClassProxy.js

@@ -1,89 +0,0 @@
-const started = Date.now()
-import { workerData, parentPort } from 'node:worker_threads'
-import { inspect } from 'node:util'
-const { workerFile, workerIndex, logEvery = 1000, metric = 'worker' } = workerData || {}
-
-if (!workerFile) {
-  throw new Error('workerData.workerFile is required!')
-}
-
-// console.log(`worker#${workerIndex} created`)
-
-try {
-  // require('esbuild-register') // alternative
-  // require('ts-node/register/transpile-only')
-  // require('tsx/cjs/api').register() // https://tsx.is/dev-api/register-cjs
-  const { register } = await import('tsx/esm/api')
-  register() // https://tsx.is/dev-api/register-esm
-  // require('tsconfig-paths/register')
-} catch {} // require if exists
-
-const { WorkerClass } = await import(workerFile)
-const worker = new WorkerClass(workerData)
-
-console.log(`${metric}#${workerIndex} loaded in ${Date.now() - started} ms`)
-
-let errors = 0
-let processed = 0
-
-parentPort.on('message', async msg => {
-  if (msg === null) {
-    // console.log(`EXIT (null) received by ${index}, exiting`)
-    parentPort.close()
-
-    logStats(true)
-
-    return
-  }
-
-  // console.log(`message received by worker ${index}: `, msg)
-
-  try {
-    const out = await worker.process(msg.payload, msg.index)
-
-    parentPort.postMessage({
-      index: msg.index,
-      payload: out,
-    })
-
-    processed++
-
-    if (processed % logEvery === 0) logStats()
-  } catch (err) {
-    parentPort.postMessage({
-      index: msg.index,
-      error: err,
-    })
-
-    errors++
-    console.log(`${metric}#${workerIndex} errors: ${errors}`)
-  }
-})
-
-const inspectOpt = {
-  colors: true,
-  breakLength: 120,
-}
-
-function logStats(final) {
-  const { rss, heapUsed, heapTotal, external } = process.memoryUsage()
-
-  console.log(
-    inspect(
-      {
-        [`${metric}${workerIndex}`]: processed,
-        errors,
-        heapUsed: mb(heapUsed),
-        heapTotal: mb(heapTotal),
-        rss: mb(rss),
-        external: mb(external),
-        ...(final ? { final: true } : {}),
-      },
-      inspectOpt,
-    ),
-  )
-}
-
-function mb(b) {
-  return Math.round(b / (1024 * 1024))
-}