@naturalcycles/nodejs-lib 15.3.0 → 15.5.0

package/src/validation/ajv/getAjv.ts

@@ -1,3 +1,4 @@
+import { _lazyValue } from '@naturalcycles/js-lib'
 import type { Options } from 'ajv'
 import { Ajv } from 'ajv'
 import ajvFormats from 'ajv-formats'
@@ -13,12 +14,22 @@ const AJV_OPTIONS: Options = {
   coerceTypes: false, // while `false` - it won't mutate your input
 }
 
+/**
+ * Return cached instance of Ajv with default (recommended) options.
+ *
+ * This function should be used as much as possible,
+ * to benefit from cached Ajv instance.
+ */
+export const getAjv = _lazyValue(createAjv)
+
 /**
  * Create Ajv with modified defaults.
  *
+ * !!! Please note that this function is EXPENSIVE computationally !!!
+ *
  * https://ajv.js.org/options.html
  */
-export function getAjv(opt?: Options): Ajv {
+export function createAjv(opt?: Options): Ajv {
   const ajv = new Ajv({
     ...AJV_OPTIONS,
     ...opt,

package/src/validation/ajv/index.ts

@@ -1,6 +1,5 @@
 import Ajv from 'ajv'
 
-export * from './ajv.util.js'
 export * from './ajvSchema.js'
 export * from './ajvValidationError.js'
 export * from './getAjv.js'

package/src/validation/joi/joi.validation.error.ts

@@ -1,5 +1,5 @@
 import type { ErrorData } from '@naturalcycles/js-lib/error'
-import { AppError } from '@naturalcycles/js-lib/error'
+import { AppError } from '@naturalcycles/js-lib/error/error.util.js'
 import type { ValidationErrorItem } from 'joi'
 
 /**

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

@@ -7,7 +7,7 @@
  */
 
 import { _hb, _isObject } from '@naturalcycles/js-lib'
-import { _truncateMiddle } from '@naturalcycles/js-lib/string'
+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'
@@ -70,6 +70,8 @@ export function validate<T>(
  * Returns JoiValidationResult with converted value and error (if any).
  * Does not throw.
  *
+ * Joi does NOT mutate the input.
+ *
  * If `schema` is undefined - returns value as is.
  */
 export function getValidationResult<T>(

package/src/validation/joi/string.extensions.ts

@@ -1,4 +1,4 @@
-import { localTime } from '@naturalcycles/js-lib/datetime'
+import { localTime } from '@naturalcycles/js-lib/datetime/localTime.js'
 import type { IsoDate } from '@naturalcycles/js-lib/types'
 import type Joi from 'joi'
 import type { Extension, StringSchema as JoiStringSchema } from 'joi'

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

@@ -1,21 +0,0 @@
-import type { JsonSchema } from '@naturalcycles/js-lib/json-schema';
-import type { GlobOptions } from 'tinyglobby';
-import type { AjvSchemaCfg } from './ajvSchema.js';
-import { AjvSchema } from './ajvSchema.js';
-/**
- * Does fs.readFileSync + JSON.parse for ALL files matching the passed `glob` pattern.
- * E.g `someDir/**\/*.schema.json`
- *
- * Returns them as an array of JsonSchema.
- *
- * @experimental
- */
-export declare function readJsonSchemas(patterns: string | string[], opt?: Omit<GlobOptions, 'patterns'>): JsonSchema[];
-/**
- * Reads json schemas from given dir (glob pattern).
- * Creates new AjvSchema for each of them (ajv validates them upon creation).
- * Passes `schemas` option to ajv, so, schemas may $ref each other and it'll be fine.
- *
- * @experimental
- */
-export declare function readAjvSchemas(patterns: string | string[], cfg?: AjvSchemaCfg): AjvSchema[];

package/dist/validation/ajv/ajv.util.js

@@ -1,28 +0,0 @@
-import { globSync } from 'tinyglobby';
-import { fs2 } from '../../fs/fs2.js';
-import { AjvSchema } from './ajvSchema.js';
-/**
- * Does fs.readFileSync + JSON.parse for ALL files matching the passed `glob` pattern.
- * E.g `someDir/**\/*.schema.json`
- *
- * Returns them as an array of JsonSchema.
- *
- * @experimental
- */
-export function readJsonSchemas(patterns, opt) {
-    return globSync(patterns, opt).map(fileName => fs2.readJson(fileName));
-}
-/**
- * Reads json schemas from given dir (glob pattern).
- * Creates new AjvSchema for each of them (ajv validates them upon creation).
- * Passes `schemas` option to ajv, so, schemas may $ref each other and it'll be fine.
- *
- * @experimental
- */
-export function readAjvSchemas(patterns, cfg) {
-    const schemas = readJsonSchemas(patterns);
-    return schemas.map(schema => AjvSchema.create(schema, {
-        schemas,
-        ...cfg,
-    }));
-}

package/src/validation/ajv/ajv.util.ts

@@ -1,38 +0,0 @@
-import type { JsonSchema } from '@naturalcycles/js-lib/json-schema'
-import type { GlobOptions } from 'tinyglobby'
-import { globSync } from 'tinyglobby'
-import { fs2 } from '../../fs/fs2.js'
-import type { AjvSchemaCfg } from './ajvSchema.js'
-import { AjvSchema } from './ajvSchema.js'
-
-/**
- * Does fs.readFileSync + JSON.parse for ALL files matching the passed `glob` pattern.
- * E.g `someDir/**\/*.schema.json`
- *
- * Returns them as an array of JsonSchema.
- *
- * @experimental
- */
-export function readJsonSchemas(
-  patterns: string | string[],
-  opt?: Omit<GlobOptions, 'patterns'>,
-): JsonSchema[] {
-  return globSync(patterns, opt).map(fileName => fs2.readJson(fileName))
-}
-
-/**
- * Reads json schemas from given dir (glob pattern).
- * Creates new AjvSchema for each of them (ajv validates them upon creation).
- * Passes `schemas` option to ajv, so, schemas may $ref each other and it'll be fine.
- *
- * @experimental
- */
-export function readAjvSchemas(patterns: string | string[], cfg?: AjvSchemaCfg): AjvSchema[] {
-  const schemas = readJsonSchemas(patterns)
-  return schemas.map(schema =>
-    AjvSchema.create(schema, {
-      schemas,
-      ...cfg,
-    }),
-  )
-}