@naturalcycles/nodejs-lib 12.102.0 → 12.103.0

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import * as globby from 'globby';
 import type { GlobbyOptions } from 'globby';
 import { RequestError, TimeoutError } from 'got';
 import type { AfterResponseHook, BeforeErrorHook, BeforeRequestHook, Got } from 'got';
-import type { AnySchema, ValidationErrorItem, AlternativesSchema, ArraySchema, BinarySchema, BooleanSchema, DateSchema, FunctionSchema, NumberSchema, ObjectSchema, StringSchema } from 'joi';
+import type { AnySchema, ValidationErrorItem, AlternativesSchema, ArraySchema, BinarySchema, BooleanSchema, DateSchema, FunctionSchema, ObjectSchema } from 'joi';
 export * from './buffer/buffer.util';
 export * from './diff/tableDiff';
 export * from './got/getGot';
@@ -81,5 +81,5 @@ export * from './validation/joi/joi.validation.util';
 export * from './script';
 export * from './jwt/jwt.service';
 export * from './fs/fs.util';
-export type { GlobbyOptions, FastGlobOptions, ValidationErrorItem, Got, AfterResponseHook, BeforeErrorHook, BeforeRequestHook, AlternativesSchema, AnySchema, ArraySchema, BinarySchema, BooleanSchema, DateSchema, FunctionSchema, NumberSchema, ObjectSchema, StringSchema, };
+export type { GlobbyOptions, FastGlobOptions, ValidationErrorItem, Got, AfterResponseHook, BeforeErrorHook, BeforeRequestHook, AlternativesSchema, AnySchema, ArraySchema, BinarySchema, BooleanSchema, DateSchema, FunctionSchema, ObjectSchema, };
 export { globby, fastGlob, RequestError, TimeoutError, Ajv };

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

@@ -1,9 +1,9 @@
 import * as JoiLib from 'joi';
-import { ExtendedNumberSchema } from './number.extensions';
-import { ExtendedStringSchema } from './string.extensions';
+import { NumberSchema } from './number.extensions';
+import { StringSchema } from './string.extensions';
 export interface ExtendedJoi extends JoiLib.Root {
-    string: <TSchema = string>() => ExtendedStringSchema<TSchema>;
-    number: <TSchema = number>() => ExtendedNumberSchema<TSchema>;
+    string: <TSchema = string>() => StringSchema<TSchema>;
+    number: <TSchema = number>() => NumberSchema<TSchema>;
 }
 /**
  * This is the only right place to import Joi from

package/dist/validation/joi/joi.model.js

@@ -1,2 +1,6 @@
 "use strict";
+// export interface ObjectSchema<T = any> extends JoiObjectSchema<T> {
+//   // Open-ended index signature to allow for easier .concat(baseDBEntitySchema)
+//   [k: string]: any
+// }
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validation/joi/joi.shared.schemas.d.ts

@@ -1,40 +1,59 @@
 /// <reference types="node" />
-import { SavedDBEntity } from '@naturalcycles/js-lib';
+import { BaseDBEntity, NumberEnum, SavedDBEntity, StringEnum } from '@naturalcycles/js-lib';
 import { AlternativesSchema, AnySchema, ArraySchema, ObjectSchema } from 'joi';
-import { ExtendedStringSchema } from './string.extensions';
+import { NumberSchema } from './number.extensions';
+import { StringSchema } from './string.extensions';
 export declare const booleanSchema: import("joi").BooleanSchema<boolean>;
 export declare const booleanDefaultToFalseSchema: import("joi").BooleanSchema<boolean>;
-export declare const stringSchema: ExtendedStringSchema<string>;
-export declare const numberSchema: import("./number.extensions").ExtendedNumberSchema<number>;
-export declare const integerSchema: import("./number.extensions").ExtendedNumberSchema<number>;
-export declare const percentageSchema: import("./number.extensions").ExtendedNumberSchema<number>;
-export declare const dateStringSchema: ExtendedStringSchema<string>;
+export declare const stringSchema: StringSchema<string>;
+export declare const stringSchemaTyped: <T>() => StringSchema<T>;
+export declare const numberSchema: NumberSchema<number>;
+export declare const numberSchemaTyped: <T>() => NumberSchema<T>;
+export declare const integerSchema: NumberSchema<number>;
+export declare const percentageSchema: NumberSchema<number>;
+export declare const dateStringSchema: StringSchema<string>;
 export declare const binarySchema: import("joi").BinarySchema<Buffer>;
 export declare const dateObjectSchema: ObjectSchema<any>;
-export declare const urlSchema: (scheme?: string | string[]) => ExtendedStringSchema;
+/**
+ * Allows all values of a String Enum.
+ */
+export declare const stringEnumValuesSchema: <ENUM extends StringEnum>(en: ENUM) => StringSchema<ENUM[keyof ENUM]>;
+/**
+ * Allows all keys of a String Enum.
+ */
+export declare const stringEnumKeysSchema: <ENUM extends StringEnum>(en: ENUM) => StringSchema;
+/**
+ * Allows all values of a String Enum.
+ */
+export declare const numberEnumValuesSchema: <ENUM extends NumberEnum>(en: ENUM) => NumberSchema<ENUM[keyof ENUM]>;
+/**
+ * Allows all keys of a Number Enum.
+ */
+export declare const numberEnumKeysSchema: <ENUM extends NumberEnum>(en: ENUM) => StringSchema;
+export declare const urlSchema: (scheme?: string | string[]) => StringSchema;
 export declare function arraySchema<T>(items?: AnySchema<T>): ArraySchema<T[]>;
 export declare function objectSchema<T>(schema?: {
     [key in keyof Partial<T>]: AnySchema<T[key]>;
 }): ObjectSchema<T>;
 export declare function oneOfSchema<T = any>(...schemas: AnySchema[]): AlternativesSchema<T>;
 export declare const anySchema: AnySchema<any>;
-export declare const anyObjectSchema: ObjectSchema<any>;
+export declare const anyObjectSchema: ObjectSchema;
 export declare const BASE62_REGEX: RegExp;
 export declare const BASE64_REGEX: RegExp;
 export declare const BASE64URL_REGEX: RegExp;
-export declare const base62Schema: ExtendedStringSchema<string>;
-export declare const base64Schema: ExtendedStringSchema<string>;
-export declare const base64UrlSchema: ExtendedStringSchema<string>;
+export declare const base62Schema: StringSchema<string>;
+export declare const base64Schema: StringSchema<string>;
+export declare const base64UrlSchema: StringSchema<string>;
 export declare const JWT_REGEX: RegExp;
-export declare const jwtSchema: ExtendedStringSchema<string>;
+export declare const jwtSchema: StringSchema<string>;
 /**
  * [a-zA-Z0-9_]*
  * 6-64 length
  */
-export declare const idSchema: ExtendedStringSchema<string>;
-export declare const idBase62Schema: ExtendedStringSchema<string>;
-export declare const idBase64Schema: ExtendedStringSchema<string>;
-export declare const idBase64UrlSchema: ExtendedStringSchema<string>;
+export declare const idSchema: StringSchema<string>;
+export declare const idBase62Schema: StringSchema<string>;
+export declare const idBase64Schema: StringSchema<string>;
+export declare const idBase64UrlSchema: StringSchema<string>;
 /**
  * `_` should NOT be allowed to be able to use slug-ids as part of natural ids with `_` separator.
  */
@@ -42,35 +61,35 @@ export declare const SLUG_REGEX: RegExp;
 /**
  * "Slug" - a valid URL, filename, etc.
  */
-export declare const slugSchema: ExtendedStringSchema<string>;
+export declare const slugSchema: StringSchema<string>;
 /**
  * Between years 1970 and 2050
  */
-export declare const unixTimestampSchema: import("./number.extensions").ExtendedNumberSchema<number>;
+export declare const unixTimestampSchema: NumberSchema<number>;
 /**
  * Between years 2000 and 2050
  */
-export declare const unixTimestamp2000Schema: import("./number.extensions").ExtendedNumberSchema<number>;
+export declare const unixTimestamp2000Schema: NumberSchema<number>;
 /**
  * Between years 1970 and 2050
  */
-export declare const unixTimestampMillisSchema: import("./number.extensions").ExtendedNumberSchema<number>;
+export declare const unixTimestampMillisSchema: NumberSchema<number>;
 /**
  * Between years 2000 and 2050
  */
-export declare const unixTimestampMillis2000Schema: import("./number.extensions").ExtendedNumberSchema<number>;
-export declare const verSchema: import("./number.extensions").ExtendedNumberSchema<number>;
+export declare const unixTimestampMillis2000Schema: NumberSchema<number>;
+export declare const verSchema: NumberSchema<number>;
 /**
  * Be careful, by default emailSchema does TLD validation. To disable it - use `stringSchema.email({tld: false}).lowercase()`
  */
-export declare const emailSchema: ExtendedStringSchema<string>;
+export declare const emailSchema: StringSchema<string>;
 /**
  * Pattern is simplified for our use, it's not a canonical SemVer.
  */
 export declare const SEM_VER_REGEX: RegExp;
-export declare const semVerSchema: ExtendedStringSchema<string>;
-export declare const userAgentSchema: ExtendedStringSchema<string>;
-export declare const utcOffsetSchema: import("./number.extensions").ExtendedNumberSchema<number>;
-export declare const ipAddressSchema: ExtendedStringSchema<string>;
-export declare const baseDBEntitySchema: ObjectSchema<Partial<SavedDBEntity<string>>>;
+export declare const semVerSchema: StringSchema<string>;
+export declare const userAgentSchema: StringSchema<string>;
+export declare const utcOffsetSchema: NumberSchema<number>;
+export declare const ipAddressSchema: StringSchema<string>;
+export declare const baseDBEntitySchema: ObjectSchema<BaseDBEntity>;
 export declare const savedDBEntitySchema: ObjectSchema<SavedDBEntity<string>>;

package/dist/validation/joi/joi.shared.schemas.js

@@ -1,16 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.savedDBEntitySchema = exports.baseDBEntitySchema = exports.ipAddressSchema = exports.utcOffsetSchema = exports.userAgentSchema = exports.semVerSchema = exports.SEM_VER_REGEX = exports.emailSchema = exports.verSchema = exports.unixTimestampMillis2000Schema = exports.unixTimestampMillisSchema = exports.unixTimestamp2000Schema = exports.unixTimestampSchema = exports.slugSchema = exports.SLUG_REGEX = exports.idBase64UrlSchema = exports.idBase64Schema = exports.idBase62Schema = exports.idSchema = exports.jwtSchema = exports.JWT_REGEX = exports.base64UrlSchema = exports.base64Schema = exports.base62Schema = exports.BASE64URL_REGEX = exports.BASE64_REGEX = exports.BASE62_REGEX = exports.anyObjectSchema = exports.anySchema = exports.oneOfSchema = exports.objectSchema = exports.arraySchema = exports.urlSchema = exports.dateObjectSchema = exports.binarySchema = exports.dateStringSchema = exports.percentageSchema = exports.integerSchema = exports.numberSchema = exports.stringSchema = exports.booleanDefaultToFalseSchema = exports.booleanSchema = void 0;
+exports.savedDBEntitySchema = exports.baseDBEntitySchema = exports.ipAddressSchema = exports.utcOffsetSchema = exports.userAgentSchema = exports.semVerSchema = exports.SEM_VER_REGEX = exports.emailSchema = exports.verSchema = exports.unixTimestampMillis2000Schema = exports.unixTimestampMillisSchema = exports.unixTimestamp2000Schema = exports.unixTimestampSchema = exports.slugSchema = exports.SLUG_REGEX = exports.idBase64UrlSchema = exports.idBase64Schema = exports.idBase62Schema = exports.idSchema = exports.jwtSchema = exports.JWT_REGEX = exports.base64UrlSchema = exports.base64Schema = exports.base62Schema = exports.BASE64URL_REGEX = exports.BASE64_REGEX = exports.BASE62_REGEX = exports.anyObjectSchema = exports.anySchema = exports.oneOfSchema = exports.objectSchema = exports.arraySchema = exports.urlSchema = exports.numberEnumKeysSchema = exports.numberEnumValuesSchema = exports.stringEnumKeysSchema = exports.stringEnumValuesSchema = exports.dateObjectSchema = exports.binarySchema = exports.dateStringSchema = exports.percentageSchema = exports.integerSchema = exports.numberSchemaTyped = exports.numberSchema = exports.stringSchemaTyped = exports.stringSchema = exports.booleanDefaultToFalseSchema = exports.booleanSchema = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
 const joi_extensions_1 = require("./joi.extensions");
 exports.booleanSchema = joi_extensions_1.Joi.boolean();
 exports.booleanDefaultToFalseSchema = joi_extensions_1.Joi.boolean().default(false);
 exports.stringSchema = joi_extensions_1.Joi.string();
+const stringSchemaTyped = () => joi_extensions_1.Joi.string();
+exports.stringSchemaTyped = stringSchemaTyped;
 exports.numberSchema = joi_extensions_1.Joi.number();
+const numberSchemaTyped = () => joi_extensions_1.Joi.number();
+exports.numberSchemaTyped = numberSchemaTyped;
 exports.integerSchema = joi_extensions_1.Joi.number().integer();
 exports.percentageSchema = joi_extensions_1.Joi.number().integer().min(0).max(100);
 exports.dateStringSchema = exports.stringSchema.dateString();
 exports.binarySchema = joi_extensions_1.Joi.binary();
 exports.dateObjectSchema = joi_extensions_1.Joi.object().instance(Date);
+/**
+ * Allows all values of a String Enum.
+ */
+const stringEnumValuesSchema = (en) => joi_extensions_1.Joi.string().allow(...(0, js_lib_1._stringEnumValues)(en));
+exports.stringEnumValuesSchema = stringEnumValuesSchema;
+/**
+ * Allows all keys of a String Enum.
+ */
+const stringEnumKeysSchema = (en) => joi_extensions_1.Joi.string().allow(...(0, js_lib_1._stringEnumKeys)(en));
+exports.stringEnumKeysSchema = stringEnumKeysSchema;
+/**
+ * Allows all values of a String Enum.
+ */
+const numberEnumValuesSchema = (en) => joi_extensions_1.Joi.number().allow(...(0, js_lib_1._numberEnumValues)(en));
+exports.numberEnumValuesSchema = numberEnumValuesSchema;
+/**
+ * Allows all keys of a Number Enum.
+ */
+const numberEnumKeysSchema = (en) => joi_extensions_1.Joi.string().allow(...(0, js_lib_1._numberEnumKeys)(en));
+exports.numberEnumKeysSchema = numberEnumKeysSchema;
 const urlSchema = (scheme = 'https') => joi_extensions_1.Joi.string().uri({ scheme });
 exports.urlSchema = urlSchema;
 function arraySchema(items) {

package/dist/validation/joi/number.extensions.d.ts

@@ -1,6 +1,6 @@
 import * as Joi from 'joi';
-import { Extension, NumberSchema } from 'joi';
-export interface ExtendedNumberSchema<TSchema = number> extends NumberSchema<TSchema> {
+import { Extension, NumberSchema as JoiNumberSchema } from 'joi';
+export interface NumberSchema<TSchema = number> extends JoiNumberSchema<TSchema> {
     dividable: (q: number) => this;
 }
 export declare function numberExtensions(joi: typeof Joi): Extension;

package/dist/validation/joi/string.extensions.d.ts

@@ -1,6 +1,6 @@
-import { Extension, StringSchema } from 'joi';
+import { Extension, StringSchema as JoiStringSchema } from 'joi';
 import * as Joi from 'joi';
-export interface ExtendedStringSchema<TSchema = string> extends StringSchema<TSchema> {
+export interface StringSchema<TSchema = string> extends JoiStringSchema<TSchema> {
     dateString: (min?: string, max?: string) => this;
 }
 export interface JoiDateStringOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.102.0",
+  "version": "12.103.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/index.ts

@@ -14,9 +14,7 @@ import type {
   BooleanSchema,
   DateSchema,
   FunctionSchema,
-  NumberSchema,
   ObjectSchema,
-  StringSchema,
 } from 'joi'
 export * from './buffer/buffer.util'
 export * from './diff/tableDiff'
@@ -109,9 +107,10 @@ export type {
   BooleanSchema,
   DateSchema,
   FunctionSchema,
-  NumberSchema,
   ObjectSchema,
-  StringSchema,
+  // extended
+  // NumberSchema,
+  // StringSchema,
 }
 
 export { globby, fastGlob, RequestError, TimeoutError, Ajv }

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

@@ -1,13 +1,12 @@
-import { StringSchema } from 'joi'
 import * as JoiLib from 'joi'
-import { ExtendedNumberSchema, numberExtensions } from './number.extensions'
-import { ExtendedStringSchema, stringExtensions } from './string.extensions'
+import { NumberSchema, numberExtensions } from './number.extensions'
+import { StringSchema, stringExtensions } from './string.extensions'
 
 export interface ExtendedJoi extends JoiLib.Root {
   // eslint-disable-next-line id-blacklist
-  string: <TSchema = string>() => ExtendedStringSchema<TSchema>
+  string: <TSchema = string>() => StringSchema<TSchema>
   // eslint-disable-next-line id-blacklist
-  number: <TSchema = number>() => ExtendedNumberSchema<TSchema>
+  number: <TSchema = number>() => NumberSchema<TSchema>
 }
 
 /**

package/src/validation/joi/joi.model.ts

@@ -1,3 +1,8 @@
+// export interface ObjectSchema<T = any> extends JoiObjectSchema<T> {
+//   // Open-ended index signature to allow for easier .concat(baseDBEntitySchema)
+//   [k: string]: any
+// }
+
 /**
  * This type is useful to allow "joi schema merging".
  * Because by default Joi doesn't allow normal merging.

package/src/validation/joi/joi.shared.schemas.ts

@@ -1,19 +1,57 @@
-import { BaseDBEntity, SavedDBEntity } from '@naturalcycles/js-lib'
+import {
+  _numberEnumKeys,
+  _numberEnumValues,
+  _stringEnumKeys,
+  _stringEnumValues,
+  BaseDBEntity,
+  NumberEnum,
+  SavedDBEntity,
+  StringEnum,
+} from '@naturalcycles/js-lib'
 import { AlternativesSchema, AnySchema, ArraySchema, ObjectSchema } from 'joi'
 import { Joi } from './joi.extensions'
-import { ExtendedStringSchema } from './string.extensions'
+import { NumberSchema } from './number.extensions'
+import { StringSchema } from './string.extensions'
 
 export const booleanSchema = Joi.boolean()
 export const booleanDefaultToFalseSchema = Joi.boolean().default(false)
 export const stringSchema = Joi.string()
+export const stringSchemaTyped = <T>(): StringSchema<T> => Joi.string<T>()
 export const numberSchema = Joi.number()
+export const numberSchemaTyped = <T>(): NumberSchema<T> => Joi.number<T>()
 export const integerSchema = Joi.number().integer()
 export const percentageSchema = Joi.number().integer().min(0).max(100)
 export const dateStringSchema = stringSchema.dateString()
 export const binarySchema = Joi.binary()
 export const dateObjectSchema = Joi.object().instance(Date)
 
-export const urlSchema = (scheme: string | string[] = 'https'): ExtendedStringSchema =>
+/**
+ * Allows all values of a String Enum.
+ */
+export const stringEnumValuesSchema = <ENUM extends StringEnum>(
+  en: ENUM,
+): StringSchema<ENUM[keyof ENUM]> => Joi.string<ENUM[keyof ENUM]>().allow(..._stringEnumValues(en))
+
+/**
+ * Allows all keys of a String Enum.
+ */
+export const stringEnumKeysSchema = <ENUM extends StringEnum>(en: ENUM): StringSchema =>
+  Joi.string().allow(..._stringEnumKeys(en))
+
+/**
+ * Allows all values of a String Enum.
+ */
+export const numberEnumValuesSchema = <ENUM extends NumberEnum>(
+  en: ENUM,
+): NumberSchema<ENUM[keyof ENUM]> => Joi.number<ENUM[keyof ENUM]>().allow(..._numberEnumValues(en))
+
+/**
+ * Allows all keys of a Number Enum.
+ */
+export const numberEnumKeysSchema = <ENUM extends NumberEnum>(en: ENUM): StringSchema =>
+  Joi.string().allow(..._numberEnumKeys(en))
+
+export const urlSchema = (scheme: string | string[] = 'https'): StringSchema =>
   Joi.string().uri({ scheme })
 
 export function arraySchema<T>(items?: AnySchema<T>): ArraySchema<T[]> {
@@ -31,7 +69,7 @@ export function oneOfSchema<T = any>(...schemas: AnySchema[]): AlternativesSchem
 }
 
 export const anySchema = Joi.any()
-export const anyObjectSchema = Joi.object().options({ stripUnknown: false })
+export const anyObjectSchema: ObjectSchema = Joi.object().options({ stripUnknown: false })
 
 export const BASE62_REGEX = /^[a-zA-Z0-9]+$/
 export const BASE64_REGEX = /^[A-Za-z0-9+/]+={0,2}$/
@@ -116,7 +154,7 @@ export const utcOffsetSchema = numberSchema
 
 export const ipAddressSchema = stringSchema.ip()
 
-export const baseDBEntitySchema = objectSchema<BaseDBEntity>({
+export const baseDBEntitySchema: ObjectSchema<BaseDBEntity> = objectSchema<BaseDBEntity>({
   id: stringSchema.optional(),
   created: unixTimestamp2000Schema.optional(),
   updated: unixTimestamp2000Schema.optional(),

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

@@ -1,7 +1,7 @@
 import * as Joi from 'joi'
-import { Extension, NumberSchema } from 'joi'
+import { Extension, NumberSchema as JoiNumberSchema } from 'joi'
 
-export interface ExtendedNumberSchema<TSchema = number> extends NumberSchema<TSchema> {
+export interface NumberSchema<TSchema = number> extends JoiNumberSchema<TSchema> {
   dividable: (q: number) => this
 }
 

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

@@ -1,8 +1,8 @@
 import { LocalDate, localTime } from '@naturalcycles/js-lib'
-import { Extension, StringSchema } from 'joi'
+import { Extension, StringSchema as JoiStringSchema } from 'joi'
 import * as Joi from 'joi'
 
-export interface ExtendedStringSchema<TSchema = string> extends StringSchema<TSchema> {
+export interface StringSchema<TSchema = string> extends JoiStringSchema<TSchema> {
   dateString: (min?: string, max?: string) => this
 }