@sprucelabs/schema/build/esm/fields/SchemaField.types.d.ts

Static and dynamic binding plus runtime validation and transformation to ensure your app is sound. 🤓

import { SchemaIdWithVersion, SchemaFieldValueUnion, Schema, StaticSchemaEntity, SchemaValues } from '../schemas.static.types';
import { IsArrayNoUnpack, IsArray } from '../types/utilities.types';
import { FieldDefinition } from './field.static.types';
export interface SchemaFieldOptions {
    /** The id of the schema you are relating to */
    schemaId?: SchemaIdWithVersion;
    /** The actual schema */
    schema?: Schema;
    /** If this needs to be a union of ids */
    schemaIds?: SchemaIdWithVersion[];
    /** Actual schemas if more that one, this will make a union */
    schemas?: Schema[];
    /** Set a callback to return schema definitions (Do not use if you plan on sharing your definitions) */
    schemasCallback?: () => Schema[];
    /** Dropped in after the type. Used to generate generics, like <T> */
    typeSuffix?: string;
}
export type SchemaFieldUnion<S extends Schema[], CreateEntityInstances extends boolean = false> = {
    [K in keyof S]: S[K] extends Schema ? CreateEntityInstances extends true ? StaticSchemaEntity<S[K]> : SchemaFieldValueUnion<SchemaValues<S[K]>, S[K]['id'], S[K]['version']> : any;
};
export type SchemaFieldValueTypeMapper<F extends SchemaFieldFieldDefinition, CreateEntityInstances extends boolean = false, ShouldIncludeNullAndUndefinedFields extends boolean = false> = F['options']['schemas'] extends Schema[] ? IsArrayNoUnpack<SchemaFieldUnion<F['options']['schemas'], CreateEntityInstances>[number], F['isArray']> : F['options']['schema'] extends Schema ? CreateEntityInstances extends true ? IsArray<StaticSchemaEntity<F['options']['schema']>, F['isArray']> : IsArray<SchemaValues<F['options']['schema'], false, true, ShouldIncludeNullAndUndefinedFields>, F['isArray']> : any;
export type SchemaFieldFieldDefinition = FieldDefinition<Record<string, any>, Record<string, any>, SchemaFieldValueUnion[], SchemaFieldValueUnion[]> & {
    /** * .Schema go team! */
    type: 'schema';
    options: SchemaFieldOptions;
};