@sprucelabs/schema/build/esm/types/template.types.d.ts

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

import { FieldDefinitions } from '../fields';
import { Schema, SchemaSupportedLanguages } from '../schemas.static.types';
export interface FieldTemplateDetails {
    /** The type literal of value (string, number) */
    valueType: string;
    /** The unique validation tags for the field (currently go only) */
    validation?: string[];
}
/** How are we being rendered in the template */
export declare enum TemplateRenderAs {
    /** We are rendering type literal */
    Type = "type",
    /** We are rendering as a value (only called if a value is set in the schema definition, like defaultValue) */
    Value = "value",
    /** We are rendering as the schema's field type (Schema) */
    SchemaType = "schemaType"
}
export type TemplateLanguage = SchemaSupportedLanguages;
/** The shape of options passed to AbstractField.generateTemplateDetails(options) */
export interface FieldTemplateDetailOptions<T extends FieldDefinitions> {
    /** The language we're generating to, only TS for now */
    language: TemplateLanguage;
    templateItems: SchemaTemplateItem[];
    /** The global namespace to access items */
    globalNamespace: string;
    /** The options for this field */
    definition: T;
    /** How we are being rendered */
    renderAs: TemplateRenderAs;
    /** How our field library is being imported (specified in the registerFieldType addon) */
    importAs: string;
}
/** The different names that a schema needs to generate all it's templates */
export interface SchemaTemplateNames {
    /** A name in the form of FullName */
    namePascal: string;
    /** A name in the form of fullName */
    nameCamel: string;
    /** A name in the form of Full name */
    nameReadable: string;
}
/** A schema about to be rendered into a template  (all schemas are in this shape before rendering) */
export interface SchemaTemplateItem extends SchemaTemplateNames {
    /** The namespace that owns this schema */
    namespace: string;
    /** The schema's id pull out of schema for easy access */
    id: string;
    /** The full schema's schema */
    schema: Schema;
    /** This schema was defined in another schema */
    isNested?: boolean;
    /** This schema is being imported from a node module */
    importFrom?: string;
    /** Where this schema is going to be written (so other schemas can import it) */
    destinationDir: string;
    /** Full import statements generated based on importsWhenLocal or importsWhenRemote */
    imports?: string[];
}
/** How a field is represented in the template */
export interface FieldTemplateItem extends SchemaTemplateNames {
    /** The name of the field class itself */
    className: string;
    /** There package where the field definition lives */
    package: string;
    /** How this field is being imported into schemas.types.ts */
    importAs: string;
    /** The key for the FieldType enum */
    pascalType: string;
    /** The value used for the FieldType enum */
    camelType: string;
    /** Is this field type introduced by the skill be worked on right meow */
    isLocal: boolean;
    /** Exactly what it says */
    description: string;
    /** A typescript type that maps a field definition to it's value type, so ITextFieldDefinitions becomes string */
    valueTypeMapper?: string;
}