Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 13 additions & 3 deletions types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,19 @@ type SharedCompilerOptions = {
onCreate?: (ajvInstance: Ajv) => void;
plugins?: (Plugin<unknown> | [Plugin<unknown>, unknown])[];
}
type JdtCompilerOptions = SharedCompilerOptions & {
mode: 'JTD';
customOptions?: JTDOptions
}
type AjvCompilerOptions = SharedCompilerOptions & {
mode?: never;
customOptions?: AjvOptions
}

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
type BuildAjvOrJdtCompilerFromPool = (
externalSchemas: { [key: string]: AnySchema | AnySchema[] },
options?: JdtCompilerOptions | AjvCompilerOptions
) => AjvCompile

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

Expand All @@ -30,7 +40,7 @@ declare namespace AjvCompiler {

export type BuildSerializerFromPool = BuildJtdSerializerFromPool

export type BuildCompilerFromPool = BuildAjvCompilerFromPool & BuildAjvJtdCompilerFromPool
export type BuildCompilerFromPool = BuildAjvOrJdtCompilerFromPool

export const AjvReference: Symbol

Expand Down
75 changes: 60 additions & 15 deletions types/index.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { AnySchemaObject, ValidateFunction } from 'ajv'
import { AnyValidateFunction } from 'ajv/dist/core'
import { expectAssignable, expectType } from 'tsd'
import AjvCompiler, { AjvReference, ValidatorFactory, StandaloneValidator, RouteDefinition, ErrorObject, BuildCompilerFromPool, BuildSerializerFromPool, ValidatorCompiler } from '..'
import type Ajv from 'ajv'

{
const compiler = AjvCompiler({})
Expand Down Expand Up @@ -228,30 +229,74 @@ expectType<Symbol>(AjvReference)
// Plugins
{
const factory = AjvCompiler()
const compilerFactoryParams = {
customOptions: {},
plugins: [
(ajv: Ajv) => {
expectType<Ajv>(ajv)
return ajv
},
(ajv: Ajv, options: unknown) => {
expectType<Ajv>(ajv)
expectType<unknown>(options)
return ajv
}
]
}
expectAssignable<Parameters<BuildCompilerFromPool>>([{}, compilerFactoryParams])

const compiler = factory({}, {
customOptions: {},
plugins: [
(ajv) => {
expectType<import('ajv').default>(ajv)
expectType<Ajv>(ajv)
return ajv
},
(ajv, options) => {
expectType<import('ajv').default>(ajv)
expectType<Ajv>(ajv)
expectType<unknown>(options)
return ajv
},
[
(ajv) => {
expectType<import('ajv').default>(ajv)
return ajv
}, ['keyword1', 'keyword2']
],
[
(ajv) => {
expectType<import('ajv').default>(ajv)
return ajv
}, [{ key: 'value' }]
],
}
]
})
expectAssignable<ValidatorCompiler>(compiler)
}
// Compiler factory should allow both signatures (mode: JTD and mode omitted)
{
expectAssignable<Parameters<BuildCompilerFromPool>>([{}, {}])

const ajvPlugin = (ajv: Ajv): Ajv => {
expectType<Ajv>(ajv)
return ajv
}
expectAssignable<Parameters<BuildCompilerFromPool>>([{}, { plugins: [ajvPlugin] }])

expectAssignable<Parameters<BuildCompilerFromPool>>([{}, {
mode: 'JTD',
customOptions: {
removeAdditional: 'all'
},
plugins: [ajvPlugin]
}])

expectAssignable<Parameters<BuildCompilerFromPool>>([{}, {
mode: 'JTD',
customOptions: {
removeAdditional: 'all'
},
plugins: [[ajvPlugin, ['string1', 'string2']]]
}])

expectAssignable<Parameters<BuildCompilerFromPool>>([{}, {
plugins: [
ajvPlugin,
(ajv: Ajv, options: unknown): Ajv => {
expectType<Ajv>(ajv)
expectType<unknown>(options)
return ajv
},
[ajvPlugin, ['keyword1', 'keyword2']],
[ajvPlugin, [{ key: 'value' }]],
]
}])
}