Skip to content

fix: enrich type definition of buildCompilerFromPool method #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

fix: enrich type definition of buildCompilerFromPool method #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
500b173
chore: enrich type definition of buildCompilerFromPool method
gianmarco27 Oct 11, 2025
da6e422
fix: convert function declaration to simple types for non-exported lo…
gianmarco27 Oct 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import _ajv, { AnySchema, Options as AjvOptions, ValidateFunction } from 'ajv'
import _ajv, { AnySchema, Options as AjvOptions, ValidateFunction, Plugin } from 'ajv'
import AjvJTD, { JTDOptions } from 'ajv/dist/jtd'
import type { Options, ErrorObject } from 'ajv'
import { AnyValidateFunction } from 'ajv/dist/core'
Expand All @@ -9,10 +9,15 @@ type AjvSerializerGenerator = typeof AjvCompiler
type AjvJTDCompile = AjvJTD['compileSerializer']
type AjvCompile = (schema: AnySchema, _meta?: boolean) => AnyValidateFunction

declare function buildCompilerFromPool (externalSchemas: { [key: string]: AnySchema | AnySchema[] }, options?: { mode: 'JTD'; customOptions?: JTDOptions; onCreate?: (ajvInstance: Ajv) => void }): AjvCompile
declare function buildCompilerFromPool (externalSchemas: { [key: string]: AnySchema | AnySchema[] }, options?: { mode?: never; customOptions?: AjvOptions; onCreate?: (ajvInstance: Ajv) => void }): AjvCompile
type SharedCompilerOptions = {
onCreate?: (ajvInstance: Ajv) => void;
plugins?: Plugin<unknown>[];
}

type BuildAjvJtdCompilerFromPool = (externalSchemas: { [key: string]: AnySchema | AnySchema[] }, options?: SharedCompilerOptions & { mode: 'JTD'; customOptions?: JTDOptions }) => AjvCompile
type BuildAjvCompilerFromPool = (externalSchemas: { [key: string]: AnySchema | AnySchema[] }, options?: SharedCompilerOptions & { mode?: never; customOptions?: AjvOptions }) => AjvCompile

declare function buildSerializerFromPool (externalSchemas: any, serializerOpts?: { mode?: never; } & JTDOptions): AjvJTDCompile
type BuildJtdSerializerFromPool = (externalSchemas: any, serializerOpts?: { mode?: never; } & JTDOptions) => AjvJTDCompile

declare function AjvCompiler (opts: { jtdSerializer: true }): AjvCompiler.BuildSerializerFromPool
declare function AjvCompiler (opts?: { jtdSerializer?: false }): AjvCompiler.BuildCompilerFromPool
Expand All @@ -23,9 +28,9 @@ declare namespace AjvCompiler {
export type { Options, ErrorObject }
export { Ajv }

export type BuildSerializerFromPool = typeof buildSerializerFromPool
export type BuildSerializerFromPool = BuildJtdSerializerFromPool

export type BuildCompilerFromPool = typeof buildCompilerFromPool
export type BuildCompilerFromPool = BuildAjvCompilerFromPool & BuildAjvJtdCompilerFromPool

export const AjvReference: Symbol

Expand Down
19 changes: 19 additions & 0 deletions types/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,3 +224,22 @@ expectType<Symbol>(AjvReference)
expectAssignable<ValidatorCompiler>(compiler)
expectType<AnyValidateFunction<any>>(compiler(endpointSchema))
}

// Plugins
{
const factory = AjvCompiler()
const compiler = factory({}, {
plugins: [
(ajv) => {
expectType<import('ajv').default>(ajv)
return ajv
},
(ajv, options) => {
expectType<import('ajv').default>(ajv)
expectType<unknown>(options)
return ajv
}
]
})
expectAssignable<ValidatorCompiler>(compiler)
}