@naturalcycles/nodejs-lib 15.90.2 → 15.92.0

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

@@ -1,20 +1,19 @@
 import type { ValidationFunction, ValidationFunctionResult } from '@naturalcycles/js-lib';
-import type { AnyObject } from '@naturalcycles/js-lib/types';
+import type { Set2 } from '@naturalcycles/js-lib/object';
+import type { AnyObject, BaseDBEntity, IANATimezone, Inclusiveness, IsoDate, IsoDateTime, IsoMonth, NumberEnum, StringEnum, StringMap, UnixTimestamp, UnixTimestampMillis } from '@naturalcycles/js-lib/types';
 import type { Ajv } from 'ajv';
 import { AjvValidationError } from './ajvValidationError.js';
-import { JsonSchemaTerminal } from './jsonSchemaBuilder.js';
-import type { JsonSchema } from './jsonSchemaBuilder.js';
 /**
  * On creation - compiles ajv validation function.
  * Provides convenient methods, error reporting, etc.
  */
-export declare class AjvSchema<IN = unknown, OUT = IN> {
-    schema: JsonSchema<IN, OUT>;
+export declare class AjvSchema<OUT> {
+    schema: JsonSchema<OUT>;
     private constructor();
     /**
      * Shortcut for AjvSchema.create(schema, { lazy: true })
      */
-    static createLazy<IN, OUT>(schema: SchemaHandledByAjv<IN, OUT>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<IN, OUT>;
+    static createLazy<OUT>(schema: SchemaHandledByAjv<OUT>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<OUT>;
     /**
      * Conveniently allows to pass either JsonSchema or JsonSchemaBuilder, or existing AjvSchema.
      * If it's already an AjvSchema - it'll just return it without any processing.
@@ -24,8 +23,8 @@ export declare class AjvSchema<IN = unknown, OUT = IN> {
      * Implementation note: JsonSchemaBuilder goes first in the union type, otherwise TypeScript fails to infer <T> type
      * correctly for some reason.
      */
-    static create<IN, OUT = IN>(schema: SchemaHandledByAjv<IN, OUT>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<IN, OUT>;
-    static isJsonSchemaBuilder<IN, OUT>(schema: unknown): schema is JsonSchemaTerminal<IN, OUT, any>;
+    static create<OUT>(schema: SchemaHandledByAjv<OUT>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<OUT>;
+    static isJsonSchemaBuilder<OUT>(schema: unknown): schema is JsonSchemaTerminal<OUT, any>;
     readonly cfg: AjvSchemaCfg;
     /**
      * It returns the original object just for convenience.
@@ -35,13 +34,13 @@ export declare class AjvSchema<IN = unknown, OUT = IN> {
      *
      * Returned object is always the same object (`===`) that was passed, so it is returned just for convenience.
      */
-    validate(input: IN, opt?: AjvValidationOptions<IN>): OUT;
-    isValid(input: IN, opt?: AjvValidationOptions<IN>): boolean;
-    getValidationResult(input: IN, opt?: AjvValidationOptions<IN>): ValidationFunctionResult<OUT, AjvValidationError>;
-    getValidationFunction(): ValidationFunction<IN, OUT, AjvValidationError>;
-    static isSchemaWithCachedAjvSchema<Base, IN, OUT>(schema: Base): schema is WithCachedAjvSchema<Base, IN, OUT>;
-    static cacheAjvSchema<Base extends AnyObject, IN, OUT>(schema: Base, ajvSchema: AjvSchema<IN, OUT>): WithCachedAjvSchema<Base, IN, OUT>;
-    static requireCachedAjvSchema<Base, IN, OUT>(schema: WithCachedAjvSchema<Base, IN, OUT>): AjvSchema<IN, OUT>;
+    validate(input: unknown, opt?: AjvValidationOptions): OUT;
+    isValid(input: unknown, opt?: AjvValidationOptions): boolean;
+    getValidationResult(input: unknown, opt?: AjvValidationOptions): ValidationFunctionResult<OUT, AjvValidationError>;
+    getValidationFunction(): ValidationFunction<OUT, AjvValidationError>;
+    static isSchemaWithCachedAjvSchema<Base, OUT>(schema: Base): schema is WithCachedAjvSchema<Base, OUT>;
+    static cacheAjvSchema<Base extends AnyObject, OUT>(schema: Base, ajvSchema: AjvSchema<OUT>): WithCachedAjvSchema<Base, OUT>;
+    static requireCachedAjvSchema<Base, OUT>(schema: WithCachedAjvSchema<Base, OUT>): AjvSchema<OUT>;
     private getAJVValidateFunction;
     private static requireValidJsonSchema;
     private applyImprovementsOnErrorMessages;
@@ -52,10 +51,10 @@ export declare class AjvSchema<IN = unknown, OUT = IN> {
     private getObjectPropertySchema;
 }
 export declare const HIDDEN_AJV_SCHEMA: unique symbol;
-export type WithCachedAjvSchema<Base, IN, OUT> = Base & {
-    [HIDDEN_AJV_SCHEMA]: AjvSchema<IN, OUT>;
+export type WithCachedAjvSchema<Base, OUT> = Base & {
+    [HIDDEN_AJV_SCHEMA]: AjvSchema<OUT>;
 };
-export interface AjvValidationOptions<IN> {
+export interface AjvValidationOptions {
     /**
      * Defaults to true,
      * because that's how AJV works by default,
@@ -83,7 +82,7 @@ export interface AjvValidationOptions<IN> {
      * can include it "how it was" in an error message. So, for that reason we'll use
      * `getOriginalInput()`, if it's provided.
      */
-    getOriginalInput?: () => IN;
+    getOriginalInput?: () => unknown;
 }
 export interface AjvSchemaCfg {
     /**
@@ -105,4 +104,629 @@ export interface AjvSchemaCfg {
      */
     lazy?: boolean;
 }
-export type SchemaHandledByAjv<IN, OUT = IN> = JsonSchemaTerminal<IN, OUT, any> | JsonSchema<IN, OUT> | AjvSchema<IN, OUT>;
+export type SchemaHandledByAjv<OUT> = JsonSchemaTerminal<OUT, any> | JsonSchema<OUT> | AjvSchema<OUT>;
+export declare const j: {
+    /**
+     * Matches literally any value - equivalent to TypeScript's `any` type.
+     * Use sparingly, as it bypasses type validation entirely.
+     */
+    any(): JsonSchemaAnyBuilder<any, false>;
+    string(): JsonSchemaStringBuilder<string, false>;
+    number(): JsonSchemaNumberBuilder<number, false>;
+    boolean(): JsonSchemaBooleanBuilder<boolean, false>;
+    object: typeof object & {
+        dbEntity: typeof objectDbEntity;
+        infer: typeof objectInfer;
+        any(): JsonSchemaObjectBuilder<AnyObject, false>;
+        stringMap<S extends JsonSchemaTerminal<any, any>>(schema: S): JsonSchemaObjectBuilder<StringMap<SchemaOut<S>>, false>;
+        /**
+         * @experimental Look around, maybe you find a rule that is better for your use-case.
+         *
+         * For Record<K, V> type of validations.
+         * ```ts
+         * const schema = j.object
+         *  .record(
+         *    j
+         *      .string()
+         *      .regex(/^\d{3,4}$/)
+         *      .branded<B>(),
+         *    j.number().nullable(),
+         *  )
+         *  .isOfType<Record<B, number | null>>()
+         * ```
+         *
+         * When the keys of the Record are values from an Enum, prefer `j.object.withEnumKeys`!
+         *
+         * Non-matching keys will be stripped from the object, i.e. they will not cause an error.
+         *
+         * Caveat: This rule first validates values of every properties of the object, and only then validates the keys.
+         * A consequence of that is that the validation will throw when there is an unexpected property with a value not matching the value schema.
+         */
+        record: typeof record;
+        /**
+         * For Record<ENUM, V> type of validations.
+         *
+         * When the keys of the Record are values from an Enum,
+         * this helper is more performant and behaves in a more conventional manner than `j.object.record` would.
+         *
+         *
+         */
+        withEnumKeys: typeof withEnumKeys;
+        withRegexKeys: typeof withRegexKeys;
+    };
+    array<OUT, Opt>(itemSchema: JsonSchemaAnyBuilder<OUT, Opt>): JsonSchemaArrayBuilder<OUT, Opt>;
+    tuple<const S extends JsonSchemaAnyBuilder<any, any>[]>(items: S): JsonSchemaTupleBuilder<S>;
+    set<OUT, Opt>(itemSchema: JsonSchemaAnyBuilder<OUT, Opt>): JsonSchemaSet2Builder<OUT, Opt>;
+    buffer(): JsonSchemaBufferBuilder;
+    enum<const T extends any>(input: T, opt?: JsonBuilderRuleOpt | undefined): JsonSchemaEnumBuilder<T extends readonly (infer U)[] ? U : T extends StringEnum ? T[keyof T] : T extends NumberEnum ? T[keyof T] : never, false>;
+    /**
+     * Use only with primitive values, otherwise this function will throw to avoid bugs.
+     * To validate objects, use `anyOfBy`.
+     *
+     * Our Ajv is configured to strip unexpected properties from objects,
+     * and since Ajv is mutating the input, this means that it cannot
+     * properly validate the same data over multiple schemas.
+     *
+     * Use `anyOf` when schemas may overlap (e.g., AccountId | PartnerId with same format).
+     * Use `oneOf` when schemas are mutually exclusive.
+     */
+    oneOf<B extends readonly JsonSchemaAnyBuilder<any, boolean>[], OUT = BuilderOutUnion<B>>(items: [...B]): JsonSchemaAnyBuilder<OUT, false>;
+    /**
+     * Use only with primitive values, otherwise this function will throw to avoid bugs.
+     * To validate objects, use `anyOfBy` or `anyOfThese`.
+     *
+     * Our Ajv is configured to strip unexpected properties from objects,
+     * and since Ajv is mutating the input, this means that it cannot
+     * properly validate the same data over multiple schemas.
+     *
+     * Use `anyOf` when schemas may overlap (e.g., AccountId | PartnerId with same format).
+     * Use `oneOf` when schemas are mutually exclusive.
+     */
+    anyOf<B extends readonly JsonSchemaAnyBuilder<any, boolean>[], OUT = BuilderOutUnion<B>>(items: [...B]): JsonSchemaAnyBuilder<OUT, false>;
+    /**
+     * Pick validation schema for an object based on the value of a specific property.
+     *
+     * ```
+     * const schemaMap = {
+     *   true: successSchema,
+     *   false: errorSchema
+     * }
+     *
+     * const schema = j.anyOfBy('success', schemaMap)
+     * ```
+     */
+    anyOfBy<D extends Record<PropertyKey, JsonSchemaTerminal<any, any>>, OUT = AnyOfByOut<D>>(propertyName: string, schemaDictionary: D): JsonSchemaAnyOfByBuilder<OUT>;
+    /**
+     * Custom version of `anyOf` which - in contrast to the original function - does not mutate the input.
+     * This comes with a performance penalty, so do not use it where performance matters.
+     *
+     * ```
+     * const schema = j.anyOfThese([successSchema, errorSchema])
+     * ```
+     */
+    anyOfThese<B extends readonly JsonSchemaAnyBuilder<any, boolean>[], OUT = BuilderOutUnion<B>>(items: [...B]): JsonSchemaAnyBuilder<OUT, false>;
+    and(): {
+        silentBob: () => never;
+    };
+    literal<const V extends string | number | boolean | null>(v: V): JsonSchemaEnumBuilder<V, false>;
+};
+export declare class JsonSchemaTerminal<OUT, Opt> {
+    protected [HIDDEN_AJV_SCHEMA]: AjvSchema<any> | undefined;
+    protected schema: JsonSchema;
+    constructor(schema: JsonSchema);
+    get ajvSchema(): AjvSchema<any>;
+    getSchema(): JsonSchema;
+    /**
+     * Produces a "clean schema object" without methods.
+     * Same as if it would be JSON.stringified.
+     */
+    build(): JsonSchema<OUT>;
+    clone(): this;
+    cloneAndUpdateSchema(schema: Partial<JsonSchema>): this;
+    validate(input: unknown, opt?: AjvValidationOptions): OUT;
+    isValid(input: unknown, opt?: AjvValidationOptions): boolean;
+    getValidationResult(input: unknown, opt?: AjvValidationOptions): ValidationFunctionResult<OUT, AjvValidationError>;
+    getValidationFunction(): ValidationFunction<OUT, AjvValidationError>;
+    /**
+     * Specify a function to be called after the normal validation is finished.
+     *
+     * This function will receive the validated, type-safe data, and you can use it
+     * to do further validations, e.g. conditional validations based on certain property values,
+     * or to do data modifications either by mutating the input or returning a new value.
+     *
+     * If you throw an error from this function, it will show up as an error in the validation.
+     */
+    postValidation<OUT2 = OUT>(fn: PostValidatonFn<OUT, OUT2>): JsonSchemaTerminal<OUT2, Opt>;
+    /**
+     * @experimental
+     */
+    out: OUT;
+    opt: Opt;
+}
+export declare class JsonSchemaAnyBuilder<OUT, Opt> extends JsonSchemaTerminal<OUT, Opt> {
+    protected setErrorMessage(ruleName: string, errorMessage: string | undefined): void;
+    /**
+     * A helper function that takes a type parameter and compares it with the type inferred from the schema.
+     *
+     * When the type inferred from the schema differs from the passed-in type,
+     * the schema becomes unusable, by turning its type into `never`.
+     *
+     * ```ts
+     * const schemaGood = j.string().isOfType<string>() // ✅
+     *
+     * const schemaBad = j.string().isOfType<number>() // ❌
+     * schemaBad.build() // TypeError: property "build" does not exist on type "never"
+     *
+     * const result = ajvValidateRequest.body(req, schemaBad) // result will have `unknown` type
+     * ```
+     */
+    isOfType<ExpectedType>(): ExactMatch<ExpectedType, OUT> extends true ? this : never;
+    $schema($schema: string): this;
+    $schemaDraft7(): this;
+    $id($id: string): this;
+    title(title: string): this;
+    description(description: string): this;
+    deprecated(deprecated?: boolean): this;
+    type(type: string): this;
+    default(v: any): this;
+    instanceof(of: string): this;
+    optional(): JsonSchemaAnyBuilder<OUT | undefined, true>;
+    nullable(): JsonSchemaAnyBuilder<OUT | null, Opt>;
+    /**
+     * @deprecated
+     * The usage of this function is discouraged as it defeats the purpose of having type-safe validation.
+     */
+    castAs<T>(): JsonSchemaAnyBuilder<T, Opt>;
+    /**
+     * Locks the given schema chain and no other modification can be done to it.
+     */
+    final(): JsonSchemaTerminal<OUT, Opt>;
+    /**
+     *
+     * @param validator A validator function that returns an error message or undefined.
+     *
+     * You may add multiple custom validators and they will be executed in the order you added them.
+     */
+    custom<OUT2 = OUT>(validator: CustomValidatorFn): JsonSchemaAnyBuilder<OUT2, Opt>;
+    /**
+     *
+     * @param converter A converter function that returns a new value.
+     *
+     * You may add multiple converters and they will be executed in the order you added them,
+     * each converter receiving the result from the previous one.
+     *
+     * This feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     */
+    convert<OUT2>(converter: CustomConverterFn<OUT2>): JsonSchemaAnyBuilder<OUT2, Opt>;
+}
+export declare class JsonSchemaStringBuilder<OUT extends string | undefined = string, Opt extends boolean = false> extends JsonSchemaAnyBuilder<OUT, Opt> {
+    constructor();
+    /**
+     * @param optionalValues List of values that should be considered/converted as `undefined`.
+     *
+     * This `optionalValues` feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     *
+     * Make sure this `optional()` call is at the end of your call chain.
+     *
+     * When `null` is included in optionalValues, the return type becomes `JsonSchemaTerminal`
+     * (no further chaining allowed) because the schema is wrapped in an anyOf structure.
+     */
+    optional<T extends readonly (string | null)[] | undefined = undefined>(optionalValues?: T): T extends readonly (infer U)[] ? null extends U ? JsonSchemaTerminal<OUT | undefined, true> : JsonSchemaStringBuilder<OUT | undefined, true> : JsonSchemaStringBuilder<OUT | undefined, true>;
+    regex(pattern: RegExp, opt?: JsonBuilderRuleOpt): this;
+    pattern(pattern: string, opt?: JsonBuilderRuleOpt): this;
+    minLength(minLength: number): this;
+    maxLength(maxLength: number): this;
+    length(exactLength: number): this;
+    length(minLength: number, maxLength: number): this;
+    email(opt?: Partial<JsonSchemaStringEmailOptions>): this;
+    trim(): this;
+    toLowerCase(): this;
+    toUpperCase(): this;
+    truncate(toLength: number): this;
+    branded<B extends string>(): JsonSchemaStringBuilder<B, Opt>;
+    /**
+     * Validates that the input is a fully-specified YYYY-MM-DD formatted valid IsoDate value.
+     *
+     * All previous expectations in the schema chain are dropped - including `.optional()` -
+     * because this call effectively starts a new schema chain.
+     */
+    isoDate(): JsonSchemaIsoDateBuilder;
+    isoDateTime(): JsonSchemaStringBuilder<IsoDateTime, Opt>;
+    isoMonth(): JsonSchemaIsoMonthBuilder;
+    /**
+     * Validates the string format to be JWT.
+     * Expects the JWT to be signed!
+     */
+    jwt(): this;
+    url(): this;
+    ipv4(): this;
+    ipv6(): this;
+    slug(): this;
+    semVer(): this;
+    languageTag(): this;
+    countryCode(): this;
+    currency(): this;
+    /**
+     * Validates that the input is a valid IANATimzone value.
+     *
+     * All previous expectations in the schema chain are dropped - including `.optional()` -
+     * because this call effectively starts a new schema chain as an `enum` validation.
+     */
+    ianaTimezone(): JsonSchemaEnumBuilder<IANATimezone, false>;
+    base64Url(): this;
+    uuid(): this;
+}
+export interface JsonSchemaStringEmailOptions {
+    checkTLD: boolean;
+}
+export declare class JsonSchemaIsoDateBuilder<Opt extends boolean = false> extends JsonSchemaAnyBuilder<IsoDate, Opt> {
+    constructor();
+    /**
+     * @param nullValue Pass `null` to have `null` values be considered/converted as `undefined`.
+     *
+     * This `null` feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     *
+     * When `null` is passed, the return type becomes `JsonSchemaTerminal`
+     * (no further chaining allowed) because the schema is wrapped in an anyOf structure.
+     */
+    optional<N extends null | undefined = undefined>(nullValue?: N): N extends null ? JsonSchemaTerminal<IsoDate | undefined, true> : JsonSchemaAnyBuilder<IsoDate | undefined, true>;
+    before(date: string): this;
+    sameOrBefore(date: string): this;
+    after(date: string): this;
+    sameOrAfter(date: string): this;
+    between(fromDate: string, toDate: string, incl: Inclusiveness): this;
+}
+export interface JsonSchemaIsoDateOptions {
+    before?: string;
+    sameOrBefore?: string;
+    after?: string;
+    sameOrAfter?: string;
+}
+export declare class JsonSchemaIsoMonthBuilder<Opt extends boolean = false> extends JsonSchemaAnyBuilder<IsoMonth, Opt> {
+    constructor();
+}
+export interface JsonSchemaIsoMonthOptions {
+}
+export declare class JsonSchemaNumberBuilder<OUT extends number | undefined = number, Opt extends boolean = false> extends JsonSchemaAnyBuilder<OUT, Opt> {
+    constructor();
+    /**
+     * @param optionalValues List of values that should be considered/converted as `undefined`.
+     *
+     * This `optionalValues` feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     *
+     * Make sure this `optional()` call is at the end of your call chain.
+     *
+     * When `null` is included in optionalValues, the return type becomes `JsonSchemaTerminal`
+     * (no further chaining allowed) because the schema is wrapped in an anyOf structure.
+     */
+    optional<T extends readonly (number | null)[] | undefined = undefined>(optionalValues?: T): T extends readonly (infer U)[] ? null extends U ? JsonSchemaTerminal<OUT | undefined, true> : JsonSchemaNumberBuilder<OUT | undefined, true> : JsonSchemaNumberBuilder<OUT | undefined, true>;
+    integer(): this;
+    branded<B extends number>(): JsonSchemaNumberBuilder<B, Opt>;
+    multipleOf(multipleOf: number): this;
+    min(minimum: number): this;
+    exclusiveMin(exclusiveMinimum: number): this;
+    max(maximum: number): this;
+    exclusiveMax(exclusiveMaximum: number): this;
+    lessThan(value: number): this;
+    lessThanOrEqual(value: number): this;
+    moreThan(value: number): this;
+    moreThanOrEqual(value: number): this;
+    equal(value: number): this;
+    range(minimum: number, maximum: number, incl: Inclusiveness): this;
+    int32(): this;
+    int64(): this;
+    float(): this;
+    double(): this;
+    unixTimestamp(): JsonSchemaNumberBuilder<UnixTimestamp, Opt>;
+    unixTimestamp2000(): JsonSchemaNumberBuilder<UnixTimestamp, Opt>;
+    unixTimestampMillis(): JsonSchemaNumberBuilder<UnixTimestampMillis, Opt>;
+    unixTimestamp2000Millis(): JsonSchemaNumberBuilder<UnixTimestampMillis, Opt>;
+    utcOffset(): this;
+    utcOffsetHour(): this;
+    /**
+     * Specify the precision of the floating point numbers by the number of digits after the ".".
+     * Excess digits will be cut-off when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     */
+    precision(numberOfDigits: number): this;
+}
+export declare class JsonSchemaBooleanBuilder<OUT extends boolean | undefined = boolean, Opt extends boolean = false> extends JsonSchemaAnyBuilder<OUT, Opt> {
+    constructor();
+    /**
+     * @param optionalValue One of the two possible boolean values that should be considered/converted as `undefined`.
+     *
+     * This `optionalValue` feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     */
+    optional(optionalValue?: boolean): JsonSchemaBooleanBuilder<OUT | undefined, true>;
+}
+export declare class JsonSchemaObjectBuilder<OUT extends AnyObject, Opt extends boolean = false> extends JsonSchemaAnyBuilder<OUT, Opt> {
+    constructor(props?: AnyObject, opt?: JsonSchemaObjectBuilderOpts);
+    addProperties(props: AnyObject): this;
+    /**
+     * @param nullValue Pass `null` to have `null` values be considered/converted as `undefined`.
+     *
+     * This `null` feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     *
+     * When `null` is passed, the return type becomes `JsonSchemaTerminal`
+     * (no further chaining allowed) because the schema is wrapped in an anyOf structure.
+     */
+    optional<N extends null | undefined = undefined>(nullValue?: N): N extends null ? JsonSchemaTerminal<OUT | undefined, true> : JsonSchemaAnyBuilder<OUT | undefined, true>;
+    /**
+     * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+     */
+    allowAdditionalProperties(): this;
+    extend<P extends Record<string, JsonSchemaAnyBuilder<any, any>>>(props: P): JsonSchemaObjectBuilder<Override<OUT, {
+        [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? never : K : never]: P[K] extends JsonSchemaAnyBuilder<infer OUT2, any> ? OUT2 : never;
+    } & {
+        [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: P[K] extends JsonSchemaAnyBuilder<infer OUT2, any> ? OUT2 : never;
+    }>, false>;
+    /**
+     * Concatenates another schema to the current schema.
+     *
+     * It expects you to use `isOfType<T>()` in the chain,
+     * otherwise the validation will throw. This is to ensure
+     * that the schemas you concatenated match the intended final type.
+     *
+     * ```ts
+     *  interface Foo { foo: string }
+     *  const fooSchema = j.object<Foo>({ foo: j.string() })
+     *
+     *  interface Bar { bar: number }
+     *  const barSchema = j.object<Bar>({ bar: j.number() })
+     *
+     *  interface Shu { foo: string, bar: number }
+     *  const shuSchema = fooSchema.concat(barSchema).isOfType<Shu>() // important
+     * ```
+     */
+    concat<OUT2 extends AnyObject>(other: JsonSchemaObjectBuilder<OUT2, any>): JsonSchemaObjectBuilder<OUT & OUT2, false>;
+    /**
+     * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
+     */
+    dbEntity(): JsonSchemaObjectBuilder<Override<OUT, {
+        id: string;
+        created: any;
+        updated: any;
+    } & {}>, false>;
+    minProperties(minProperties: number): this;
+    maxProperties(maxProperties: number): this;
+    exclusiveProperties(propNames: readonly (keyof OUT & string)[]): this;
+}
+interface JsonSchemaObjectBuilderOpts {
+    hasIsOfTypeCheck?: false;
+    patternProperties?: StringMap<JsonSchema<any>>;
+    keySchema?: JsonSchema;
+}
+export declare class JsonSchemaObjectInferringBuilder<PROPS extends Record<string, JsonSchemaAnyBuilder<any, any>>, Opt extends boolean = false> extends JsonSchemaAnyBuilder<Expand<{
+    [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? never : K : never]: PROPS[K] extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+} & {
+    [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: PROPS[K] extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+}>, Opt> {
+    constructor(props?: PROPS);
+    addProperties(props: PROPS): this;
+    /**
+     * @param nullValue Pass `null` to have `null` values be considered/converted as `undefined`.
+     *
+     * This `null` feature only works when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     *
+     * When `null` is passed, the return type becomes `JsonSchemaTerminal`
+     * (no further chaining allowed) because the schema is wrapped in an anyOf structure.
+     */
+    optional<N extends null | undefined = undefined>(nullValue?: N): N extends null ? JsonSchemaTerminal<Expand<{
+        [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? never : K : never]: PROPS[K] extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+    } & {
+        [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: PROPS[K] extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+    }> | undefined, true> : JsonSchemaAnyBuilder<Expand<{
+        [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? never : K : never]: PROPS[K] extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+    } & {
+        [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: PROPS[K] extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+    }> | undefined, true>;
+    /**
+     * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+     */
+    allowAdditionalProperties(): this;
+    extend<NEW_PROPS extends Record<string, JsonSchemaAnyBuilder<any, any>>>(props: NEW_PROPS): JsonSchemaObjectInferringBuilder<{
+        [K in keyof PROPS | keyof NEW_PROPS]: K extends keyof NEW_PROPS ? NEW_PROPS[K] : K extends keyof PROPS ? PROPS[K] : never;
+    }, Opt>;
+    /**
+     * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
+     */
+    dbEntity(): JsonSchemaObjectInferringBuilder<{ [K in "created" | "id" | "updated" | keyof PROPS]: K extends "created" | "id" | "updated" ? {
+        id: JsonSchemaStringBuilder<string, false>;
+        created: JsonSchemaNumberBuilder<UnixTimestamp, false>;
+        updated: JsonSchemaNumberBuilder<UnixTimestamp, false>;
+    }[K] : K extends keyof PROPS ? PROPS[K] : never; }, Opt>;
+}
+export declare class JsonSchemaArrayBuilder<OUT, Opt> extends JsonSchemaAnyBuilder<OUT[], Opt> {
+    constructor(itemsSchema: JsonSchemaAnyBuilder<OUT, Opt>);
+    minLength(minItems: number): this;
+    maxLength(maxItems: number): this;
+    length(exactLength: number): this;
+    length(minItems: number, maxItems: number): this;
+    exactLength(length: number): this;
+    unique(): this;
+}
+export declare class JsonSchemaSet2Builder<OUT, Opt> extends JsonSchemaAnyBuilder<Set2<OUT>, Opt> {
+    constructor(itemsSchema: JsonSchemaAnyBuilder<OUT, Opt>);
+    min(minItems: number): this;
+    max(maxItems: number): this;
+}
+export declare class JsonSchemaBufferBuilder extends JsonSchemaAnyBuilder<Buffer, false> {
+    constructor();
+}
+export declare class JsonSchemaEnumBuilder<OUT extends string | number | boolean | null, Opt extends boolean = false> extends JsonSchemaAnyBuilder<OUT, Opt> {
+    constructor(enumValues: readonly OUT[], baseType: EnumBaseType, opt?: JsonBuilderRuleOpt);
+    branded<B extends OUT>(): JsonSchemaEnumBuilder<B, Opt>;
+}
+export declare class JsonSchemaTupleBuilder<ITEMS extends JsonSchemaAnyBuilder<any, any>[]> extends JsonSchemaAnyBuilder<TupleOut<ITEMS>, false> {
+    constructor(items: ITEMS);
+}
+export declare class JsonSchemaAnyOfByBuilder<OUT> extends JsonSchemaAnyBuilder<OUT, false> {
+    constructor(propertyName: string, schemaDictionary: Record<PropertyKey, JsonSchemaTerminal<any, any>>);
+}
+export declare class JsonSchemaAnyOfTheseBuilder<OUT> extends JsonSchemaAnyBuilder<OUT, false> {
+    constructor(propertyName: string, schemaDictionary: Record<PropertyKey, JsonSchemaTerminal<any, any>>);
+}
+type EnumBaseType = 'string' | 'number' | 'other';
+export interface JsonSchema<OUT = unknown> {
+    readonly out?: OUT;
+    $schema?: string;
+    $id?: string;
+    title?: string;
+    description?: string;
+    deprecated?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    type?: string | string[];
+    items?: JsonSchema;
+    prefixItems?: JsonSchema[];
+    properties?: {
+        [K in keyof OUT]: JsonSchema<OUT[K]>;
+    };
+    patternProperties?: StringMap<JsonSchema<any>>;
+    required?: string[];
+    additionalProperties?: boolean;
+    minProperties?: number;
+    maxProperties?: number;
+    default?: OUT;
+    if?: JsonSchema;
+    then?: JsonSchema;
+    else?: JsonSchema;
+    anyOf?: JsonSchema[];
+    oneOf?: JsonSchema[];
+    /**
+     * This is a temporary "intermediate AST" field that is used inside the parser.
+     * In the final schema this field will NOT be present.
+     */
+    optionalField?: true;
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+    format?: string;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    multipleOf?: number;
+    minimum?: number;
+    exclusiveMinimum?: number;
+    maximum?: number;
+    exclusiveMaximum?: number;
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+    enum?: any;
+    hasIsOfTypeCheck?: boolean;
+    email?: JsonSchemaStringEmailOptions;
+    Set2?: JsonSchema;
+    Buffer?: true;
+    IsoDate?: JsonSchemaIsoDateOptions;
+    IsoDateTime?: true;
+    IsoMonth?: JsonSchemaIsoMonthOptions;
+    instanceof?: string | string[];
+    transform?: {
+        trim?: true;
+        toLowerCase?: true;
+        toUpperCase?: true;
+        truncate?: number;
+    };
+    errorMessages?: StringMap<string>;
+    optionalValues?: (string | number | boolean | null)[];
+    keySchema?: JsonSchema;
+    isUndefined?: true;
+    minProperties2?: number;
+    exclusiveProperties?: (readonly string[])[];
+    anyOfBy?: {
+        propertyName: string;
+        schemaDictionary: Record<string, JsonSchema>;
+    };
+    anyOfThese?: JsonSchema[];
+    precision?: number;
+    customValidations?: CustomValidatorFn[];
+    customConversions?: CustomConverterFn<any>[];
+    postValidation?: PostValidatonFn<any, OUT>;
+}
+declare function object(props: AnyObject): never;
+declare function object<OUT extends AnyObject>(props: {
+    [K in keyof Required<OUT>]-?: JsonSchemaTerminal<OUT[K], any>;
+}): JsonSchemaObjectBuilder<OUT, false>;
+declare function objectInfer<P extends Record<string, JsonSchemaAnyBuilder<any, any>>>(props: P): JsonSchemaObjectInferringBuilder<P, false>;
+declare function objectDbEntity(props: AnyObject): never;
+declare function objectDbEntity<OUT extends BaseDBEntity, EXTRA_KEYS extends Exclude<keyof OUT, keyof BaseDBEntity> = Exclude<keyof OUT, keyof BaseDBEntity>>(props: {
+    [K in EXTRA_KEYS]-?: BuilderFor<OUT[K]>;
+} & (ExactMatch<OUT['id'], BaseDBEntity['id']> extends true ? {
+    id?: BuilderFor<BaseDBEntity['id']>;
+} : {
+    id: BuilderFor<OUT['id']>;
+}) & (ExactMatch<OUT['created'], BaseDBEntity['created']> extends true ? {
+    created?: BuilderFor<BaseDBEntity['created']>;
+} : {
+    created: BuilderFor<OUT['created']>;
+}) & (ExactMatch<OUT['updated'], BaseDBEntity['updated']> extends true ? {
+    updated?: BuilderFor<BaseDBEntity['updated']>;
+} : {
+    updated: BuilderFor<OUT['updated']>;
+})): JsonSchemaObjectBuilder<OUT, false>;
+declare function record<KS extends JsonSchemaAnyBuilder<any, any>, VS extends JsonSchemaAnyBuilder<any, any>, Opt extends boolean = SchemaOpt<VS>>(keySchema: KS, valueSchema: VS): JsonSchemaObjectBuilder<Opt extends true ? Partial<Record<SchemaOut<KS>, SchemaOut<VS>>> : Record<SchemaOut<KS>, SchemaOut<VS>>, false>;
+declare function withRegexKeys<S extends JsonSchemaAnyBuilder<any, any>>(keyRegex: RegExp | string, schema: S): JsonSchemaObjectBuilder<StringMap<SchemaOut<S>>, false>;
+/**
+ * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
+ */
+declare function withEnumKeys<const T extends readonly (string | number)[] | StringEnum | NumberEnum, S extends JsonSchemaAnyBuilder<any, any>, K extends string | number = EnumKeyUnion<T>, Opt extends boolean = SchemaOpt<S>>(keys: T, schema: S): JsonSchemaObjectBuilder<Opt extends true ? {
+    [P in K]?: SchemaOut<S>;
+} : {
+    [P in K]: SchemaOut<S>;
+}, false>;
+type Expand<T> = {
+    [K in keyof T]: T[K];
+};
+type StripIndexSignatureDeep<T> = T extends readonly unknown[] ? T : T extends Record<string, any> ? {
+    [K in keyof T as string extends K ? never : number extends K ? never : symbol extends K ? never : K]: StripIndexSignatureDeep<T[K]>;
+} : T;
+type RelaxIndexSignature<T> = T extends readonly unknown[] ? T : T extends AnyObject ? {
+    [K in keyof T]: RelaxIndexSignature<T[K]>;
+} : T;
+type Override<T, U> = Omit<T, keyof U> & U;
+declare const allowExtraKeysSymbol: unique symbol;
+type HasAllowExtraKeys<T> = T extends {
+    readonly [allowExtraKeysSymbol]?: true;
+} ? true : false;
+type IsAny<T> = 0 extends 1 & T ? true : false;
+type IsAssignableRelaxed<A, B> = IsAny<RelaxIndexSignature<A>> extends true ? true : [RelaxIndexSignature<A>] extends [B] ? true : false;
+type ExactMatchBase<A, B> = (<T>() => T extends A ? 1 : 2) extends <T>() => (T extends B ? 1 : 2) ? (<T>() => T extends B ? 1 : 2) extends <T>() => (T extends A ? 1 : 2) ? true : false : false;
+type ExactMatch<A, B> = HasAllowExtraKeys<B> extends true ? IsAssignableRelaxed<B, A> : ExactMatchBase<Expand<A>, Expand<B>> extends true ? true : ExactMatchBase<Expand<StripIndexSignatureDeep<A>>, Expand<StripIndexSignatureDeep<B>>>;
+type BuilderOutUnion<B extends readonly JsonSchemaAnyBuilder<any, any>[]> = {
+    [K in keyof B]: B[K] extends JsonSchemaAnyBuilder<infer O, any> ? O : never;
+}[number];
+type AnyOfByOut<D extends Record<PropertyKey, JsonSchemaTerminal<any, any>>> = {
+    [K in keyof D]: D[K] extends JsonSchemaTerminal<infer O, any> ? O : never;
+}[keyof D];
+type BuilderFor<T> = JsonSchemaAnyBuilder<T, any>;
+interface JsonBuilderRuleOpt {
+    /**
+     * Text of error message to return when the validation fails for the given rule:
+     *
+     * `{ msg: "is not a valid Oompa-loompa" } => "Object.property is not a valid Oompa-loompa"`
+     */
+    msg?: string;
+    /**
+     * A friendly name for what we are validating, that will be used in error messages:
+     *
+     * `{ name: "Oompa-loompa" } => "Object.property is not a valid Oompa-loompa"`
+     */
+    name?: string;
+}
+type EnumKeyUnion<T> = T extends readonly (infer U)[] ? U : T extends StringEnum | NumberEnum ? T[keyof T] : never;
+type SchemaOut<S> = S extends JsonSchemaAnyBuilder<infer OUT, any> ? OUT : never;
+type SchemaOpt<S> = S extends JsonSchemaAnyBuilder<any, infer Opt> ? (Opt extends true ? true : false) : false;
+type TupleOut<T extends readonly JsonSchemaAnyBuilder<any, any>[]> = {
+    [K in keyof T]: T[K] extends JsonSchemaAnyBuilder<infer O, any> ? O : never;
+};
+export type PostValidatonFn<OUT, OUT2> = (v: OUT) => OUT2;
+export type CustomValidatorFn = (v: any) => string | undefined;
+export type CustomConverterFn<OUT> = (v: any) => OUT;
+export {};