blob: 3004e5e5be37e057198d7719d2b0250d12aa8f42 [file] [log] [blame]
/** numeric strings */
declare type NumberType = "float32" | "float64" | "int8" | "uint8" | "int16" | "uint16" | "int32" | "uint32";
/** string strings */
declare type StringType = "string" | "timestamp";
/** Generic JTD Schema without inference of the represented type */
export declare type SomeJTDSchemaType = (// ref
{
ref: string;
} | {
type: NumberType | StringType | "boolean";
} | {
enum: string[];
} | {
elements: SomeJTDSchemaType;
} | {
values: SomeJTDSchemaType;
} | {
properties: Record<string, SomeJTDSchemaType>;
optionalProperties?: Record<string, SomeJTDSchemaType>;
additionalProperties?: boolean;
} | {
properties?: Record<string, SomeJTDSchemaType>;
optionalProperties: Record<string, SomeJTDSchemaType>;
additionalProperties?: boolean;
} | {
discriminator: string;
mapping: Record<string, SomeJTDSchemaType>;
} | {}) & {
nullable?: boolean;
metadata?: Record<string, unknown>;
definitions?: Record<string, SomeJTDSchemaType>;
};
/** required keys of an object, not undefined */
declare type RequiredKeys<T> = {
[K in keyof T]-?: undefined extends T[K] ? never : K;
}[keyof T];
/** optional or undifined-able keys of an object */
declare type OptionalKeys<T> = {
[K in keyof T]-?: undefined extends T[K] ? K : never;
}[keyof T];
/** type is true if T is a union type */
declare type IsUnion_<T, U extends T = T> = false extends (T extends unknown ? ([U] extends [T] ? false : true) : never) ? false : true;
declare type IsUnion<T> = IsUnion_<T>;
/** type is true if T is identically E */
declare type TypeEquality<T, E> = [T] extends [E] ? ([E] extends [T] ? true : false) : false;
/** type is true if T or null is identically E or null*/
declare type NullTypeEquality<T, E> = TypeEquality<T | null, E | null>;
/** gets only the string literals of a type or null if a type isn't a string literal */
declare type EnumString<T> = [T] extends [never] ? null : T extends string ? string extends T ? null : T : null;
/** true if type is a union of string literals */
declare type IsEnum<T> = null extends EnumString<Exclude<T, null>> ? false : true;
/** true only if all types are array types (not tuples) */
declare type IsElements<T> = false extends IsUnion<T> ? [T] extends [readonly unknown[]] ? undefined extends T[0.5] ? false : true : false : false;
/** true if the the type is a values type */
declare type IsValues<T> = false extends IsUnion<Exclude<T, null>> ? TypeEquality<keyof Exclude<T, null>, string> : false;
/** true if type is a proeprties type and Union is false, or type is a discriminator type and Union is true */
declare type IsRecord<T, Union extends boolean> = Union extends IsUnion<Exclude<T, null>> ? null extends EnumString<keyof Exclude<T, null>> ? false : true : false;
/** actual schema */
export declare type JTDSchemaType<T, D extends Record<string, unknown> = Record<string, never>> = (// refs - where null wasn't specified, must match exactly
(null extends EnumString<keyof D> ? never : ({
[K in keyof D]: [T] extends [D[K]] ? {
ref: K;
} : never;
}[keyof D] & {
nullable?: false;
}) | (null extends T ? {
[K in keyof D]: [Exclude<T, null>] extends [Exclude<D[K], null>] ? {
ref: K;
} : never;
}[keyof D] & {
nullable: true;
} : never)) | (unknown extends T ? {
nullable?: boolean;
} : never) | ((true extends NullTypeEquality<T, number> ? {
type: NumberType;
} : true extends NullTypeEquality<T, boolean> ? {
type: "boolean";
} : true extends NullTypeEquality<T, string> ? {
type: StringType;
} : true extends NullTypeEquality<T, Date> ? {
type: "timestamp";
} : true extends IsEnum<T> ? {
enum: EnumString<Exclude<T, null>>[];
} : true extends IsElements<Exclude<T, null>> ? T extends readonly (infer E)[] ? {
elements: JTDSchemaType<E, D>;
} : never : true extends IsValues<T> ? T extends Record<string, infer V> ? {
values: JTDSchemaType<V, D>;
} : never : true extends IsRecord<T, false> ? ([RequiredKeys<Exclude<T, null>>] extends [never] ? {
properties?: Record<string, never>;
} : {
properties: {
[K in RequiredKeys<T>]: JTDSchemaType<T[K], D>;
};
}) & ([OptionalKeys<Exclude<T, null>>] extends [never] ? {
optionalProperties?: Record<string, never>;
} : {
optionalProperties: {
[K in OptionalKeys<T>]: JTDSchemaType<Exclude<T[K], undefined>, D>;
};
}) & {
additionalProperties?: boolean;
} : true extends IsRecord<T, true> ? {
[K in keyof Exclude<T, null>]-?: Exclude<T, null>[K] extends string ? {
discriminator: K;
mapping: {
[M in Exclude<T, null>[K]]: JTDSchemaType<Omit<T extends {
[C in K]: M;
} ? T : never, K>, D>;
};
} : never;
}[keyof Exclude<T, null>] : never) & (null extends T ? {
nullable: true;
} : {
nullable?: false;
}))) & {
metadata?: Record<string, unknown>;
definitions?: {
[K in keyof D]: JTDSchemaType<D[K], D>;
};
};
declare type JTDDataDef<S, D extends Record<string, unknown>> = // ref
(S extends {
ref: string;
} ? D extends {
[K in S["ref"]]: infer V;
} ? JTDDataDef<V, D> : never : S extends {
type: NumberType;
} ? number : S extends {
type: "boolean";
} ? boolean : S extends {
type: "string";
} ? string : S extends {
type: "timestamp";
} ? string | Date : S extends {
enum: readonly (infer E)[];
} ? string extends E ? never : [E] extends [string] ? E : never : S extends {
elements: infer E;
} ? JTDDataDef<E, D>[] : S extends {
properties: Record<string, unknown>;
optionalProperties?: Record<string, unknown>;
additionalProperties?: boolean;
} ? {
-readonly [K in keyof S["properties"]]-?: JTDDataDef<S["properties"][K], D>;
} & {
-readonly [K in keyof S["optionalProperties"]]+?: JTDDataDef<S["optionalProperties"][K], D>;
} & ([S["additionalProperties"]] extends [true] ? Record<string, unknown> : unknown) : S extends {
properties?: Record<string, unknown>;
optionalProperties: Record<string, unknown>;
additionalProperties?: boolean;
} ? {
-readonly [K in keyof S["properties"]]-?: JTDDataDef<S["properties"][K], D>;
} & {
-readonly [K in keyof S["optionalProperties"]]+?: JTDDataDef<S["optionalProperties"][K], D>;
} & ([S["additionalProperties"]] extends [true] ? Record<string, unknown> : unknown) : S extends {
values: infer V;
} ? Record<string, JTDDataDef<V, D>> : S extends {
discriminator: infer M;
mapping: Record<string, unknown>;
} ? [M] extends [string] ? {
[K in keyof S["mapping"]]: JTDDataDef<S["mapping"][K], D> & {
[KM in M]: K;
};
}[keyof S["mapping"]] : never : unknown) | (S extends {
nullable: true;
} ? null : never);
export declare type JTDDataType<S> = S extends {
definitions: Record<string, unknown>;
} ? JTDDataDef<S, S["definitions"]> : JTDDataDef<S, Record<string, never>>;
export {};