Skip to content

[@kbn/config-schema] add discriminatedUnion schema type #246095

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
nickofthyme merged 10 commits into from
Jan 12, 2026
Merged

[@kbn/config-schema] add discriminatedUnion schema type #246095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6738172
feat: add `oneOfKind` schema type
nickofthyme Dec 12, 2025
d50e8e1
chore: cleanup types
nickofthyme Dec 12, 2025
9f0525d
improve `oneOf` types
nickofthyme Dec 12, 2025
4cb0f66
fix: `defaultValue` typings on `oneOfKind`
nickofthyme Dec 13, 2025
966a772
Merge branch 'main' into schema-one-of-kind
nickofthyme Jan 5, 2026
05ca1fa
Revert "improve `oneOf` types"
nickofthyme Jan 5, 2026
074e5f9
refactor: allow falback and add schema checks
nickofthyme Jan 6, 2026
9dffdaa
chore: update method naming, add alias for `union`
nickofthyme Jan 6, 2026
72db50e
Merge branch 'main' into schema-one-of-kind
nickofthyme Jan 12, 2026
b874ed9
chore: add `discriminator` to schema `meta`
nickofthyme Jan 12, 2026
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
238 changes: 238 additions & 0 deletions src/platform/packages/shared/kbn-config-schema/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ import type {
TypeOptions,
URIOptions,
UnionTypeOptions,
PropsWithDiscriminator,
ObjectResultUnionType,
} from './src/types';
import {
AnyType,
Expand All @@ -54,6 +56,7 @@ import {
StringType,
Type,
UnionType,
DiscriminatedUnionType,
URIType,
StreamType,
Lazy,
Expand Down Expand Up @@ -224,6 +227,239 @@ function oneOf<RTS extends Array<Type<any>>>(
return new UnionType(types, options);
}

function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>,
G extends PropsWithDiscriminator<Discriminator, Props>,
H extends PropsWithDiscriminator<Discriminator, Props>,
I extends PropsWithDiscriminator<Discriminator, Props>,
J extends PropsWithDiscriminator<Discriminator, Props>,
K extends PropsWithDiscriminator<Discriminator, Props>,
L extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [
ObjectType<A>,
ObjectType<B>,
ObjectType<C>,
ObjectType<D>,
ObjectType<E>,
ObjectType<F>,
ObjectType<G>,
ObjectType<H>,
ObjectType<I>,
ObjectType<J>,
ObjectType<K>,
ObjectType<L>
],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F | G | H | I | J | K | L>>
): Type<ObjectResultUnionType<A | B | C | D | E | F | G | H | I | J | K | L>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>,
G extends PropsWithDiscriminator<Discriminator, Props>,
H extends PropsWithDiscriminator<Discriminator, Props>,
I extends PropsWithDiscriminator<Discriminator, Props>,
J extends PropsWithDiscriminator<Discriminator, Props>,
K extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [
ObjectType<A>,
ObjectType<B>,
ObjectType<C>,
ObjectType<D>,
ObjectType<E>,
ObjectType<F>,
ObjectType<G>,
ObjectType<H>,
ObjectType<I>,
ObjectType<J>,
ObjectType<K>
],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F | G | H | I | J | K>>
): Type<ObjectResultUnionType<A | B | C | D | E | F | G | H | I | J | K>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>,
G extends PropsWithDiscriminator<Discriminator, Props>,
H extends PropsWithDiscriminator<Discriminator, Props>,
I extends PropsWithDiscriminator<Discriminator, Props>,
J extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [
ObjectType<A>,
ObjectType<B>,
ObjectType<C>,
ObjectType<D>,
ObjectType<E>,
ObjectType<F>,
ObjectType<G>,
ObjectType<H>,
ObjectType<I>,
ObjectType<J>
],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F | G | H | I | J>>
): Type<ObjectResultUnionType<A | B | C | D | E | F | G | H | I | J>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>,
G extends PropsWithDiscriminator<Discriminator, Props>,
H extends PropsWithDiscriminator<Discriminator, Props>,
I extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [
ObjectType<A>,
ObjectType<B>,
ObjectType<C>,
ObjectType<D>,
ObjectType<E>,
ObjectType<F>,
ObjectType<G>,
ObjectType<H>,
ObjectType<I>
],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F | G | H | I>>
): Type<ObjectResultUnionType<A | B | C | D | E | F | G | H | I>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>,
G extends PropsWithDiscriminator<Discriminator, Props>,
H extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [
ObjectType<A>,
ObjectType<B>,
ObjectType<C>,
ObjectType<D>,
ObjectType<E>,
ObjectType<F>,
ObjectType<G>,
ObjectType<H>
],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F | G | H>>
): Type<ObjectResultUnionType<A | B | C | D | E | F | G | H>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>,
G extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [
ObjectType<A>,
ObjectType<B>,
ObjectType<C>,
ObjectType<D>,
ObjectType<E>,
ObjectType<F>,
ObjectType<G>
],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F | G>>
): Type<ObjectResultUnionType<A | B | C | D | E | F | G>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>,
F extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [ObjectType<A>, ObjectType<B>, ObjectType<C>, ObjectType<D>, ObjectType<E>, ObjectType<F>],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E | F>>
): Type<ObjectResultUnionType<A | B | C | D | E | F>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>,
E extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [ObjectType<A>, ObjectType<B>, ObjectType<C>, ObjectType<D>, ObjectType<E>],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D | E>>
): Type<ObjectResultUnionType<A | B | C | D | E>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>,
D extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [ObjectType<A>, ObjectType<B>, ObjectType<C>, ObjectType<D>],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C | D>>
): Type<ObjectResultUnionType<A | B | C | D>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>,
C extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [ObjectType<A>, ObjectType<B>, ObjectType<C>],
options?: UnionTypeOptions<ObjectResultUnionType<A | B | C>>
): Type<ObjectResultUnionType<A | B | C>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>,
B extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [ObjectType<A>, ObjectType<B>],
options?: UnionTypeOptions<ObjectResultUnionType<A | B>>
): Type<ObjectResultUnionType<A | B>>;
function discriminatedUnion<
Discriminator extends string,
A extends PropsWithDiscriminator<Discriminator, Props>
>(
discriminator: Discriminator,
types: [ObjectType<A>],
options?: UnionTypeOptions<ObjectResultType<A>>
): Type<ObjectResultType<A>>;
function discriminatedUnion<Discriminator extends string, RTS extends Array<ObjectType<any>>>(
discriminator: Discriminator,
types: RTS,
options?: UnionTypeOptions<any>
): Type<ObjectResultType<any>> {
return new DiscriminatedUnionType(discriminator, types, options);
}

function allOf<
A extends Props,
B extends Props,
Expand Down Expand Up @@ -428,6 +664,8 @@ export const schema = {
number,
object,
oneOf,
union: oneOf,
discriminatedUnion,
recordOf,
stream,
siblingRef,
Expand Down
1 change: 1 addition & 0 deletions src/platform/packages/shared/kbn-config-schema/src/oas_meta_fields.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ export const META_FIELD_X_OAS_MAX_LENGTH = 'x-oas-max-length' as const;
export const META_FIELD_X_OAS_GET_ADDITIONAL_PROPERTIES =
'x-oas-get-additional-properties' as const;
export const META_FIELD_X_OAS_DEPRECATED = 'x-oas-deprecated' as const;
export const META_FIELD_X_OAS_DISCRIMINATOR = 'x-oas-discriminator' as const;
export const META_FIELD_X_OAS_ANY = 'x-oas-any-type' as const;
export const META_FIELD_X_OAS_DISCONTINUED = 'x-oas-discontinued' as const;
Loading