@react-typed-forms/schemas 15.2.0 → 16.0.0

package/lib/schemaField.d.ts

@@ -1,252 +0,0 @@
-import { SchemaValidator } from "./schemaValidator";
-import { Control, ControlSetup } from "@react-typed-forms/core";
-export type EqualityFunc = (a: any, b: any) => boolean;
-/**
- * Represents a schema field with various properties.
- */
-export interface SchemaField {
-    /** The type of the field. */
-    type: string;
-    /** The name of the field. */
-    field: string;
-    /** The display name of the field, optional. */
-    displayName?: string | null;
-    /** Tags associated with the field, optional. */
-    tags?: string[] | null;
-    /** Indicates if the field is a system field, optional. */
-    system?: boolean | null;
-    /** Indicates if the field is a collection, optional. */
-    collection?: boolean | null;
-    /** Specifies the types for which the field is applicable, optional. */
-    onlyForTypes?: string[] | null;
-    /** Indicates if the field is required, optional. */
-    required?: boolean | null;
-    /** Indicates if the field is not nullable, optional. */
-    notNullable?: boolean | null;
-    /** The default value of the field, optional. */
-    defaultValue?: any;
-    /** Indicates if the field is a type field, optional. */
-    isTypeField?: boolean | null;
-    /** Indicates if the field is searchable, optional. */
-    searchable?: boolean | null;
-    /** Options for the field, optional. */
-    options?: FieldOption[] | null;
-    /** Validators for the field, optional. */
-    validators?: SchemaValidator[] | null;
-}
-/**
- * Represents a map of schema fields.
- * The key is a string representing the schema name.
- * The value is an array of SchemaField objects.
- */
-export type SchemaMap = Record<string, SchemaField[]>;
-/**
- * Enum representing the various field types.
- */
-export declare enum FieldType {
-    String = "String",
-    Bool = "Bool",
-    Int = "Int",
-    Date = "Date",
-    DateTime = "DateTime",
-    Time = "Time",
-    Double = "Double",
-    EntityRef = "EntityRef",
-    Compound = "Compound",
-    AutoId = "AutoId",
-    Image = "Image",
-    Any = "Any"
-}
-/**
- * Represents a field that references an entity.
- */
-export interface EntityRefField extends SchemaField {
-    /** The type of the field, which is EntityRef. */
-    type: FieldType.EntityRef;
-    /** The type of the referenced entity. */
-    entityRefType: string;
-    /** The parent field of the entity reference. */
-    parentField: string;
-}
-/**
- * Represents an option for a field.
- */
-export interface FieldOption {
-    /** The name of the option. */
-    name: string;
-    /** The value of the option. */
-    value: any;
-    /** The description of the option, optional. */
-    description?: string | null;
-    /** The group of the option, optional. */
-    group?: string | null;
-    /** Indicates if the option is disabled, optional. */
-    disabled?: boolean | null;
-}
-/**
- * Represents a compound field that contains child fields.
- */
-export interface CompoundField extends SchemaField {
-    /** The type of the field, which is Compound. */
-    type: FieldType.Compound;
-    /** The child fields of the compound field. */
-    children: SchemaField[];
-    /** Indicates if the children are tree-structured, optional. */
-    treeChildren?: boolean;
-    /** The schema reference for the compound field, optional. */
-    schemaRef?: string;
-}
-/**
- * Enum representing the various validation message types.
- */
-export declare enum ValidationMessageType {
-    NotEmpty = "NotEmpty",
-    MinLength = "MinLength",
-    MaxLength = "MaxLength",
-    NotAfterDate = "NotAfterDate",
-    NotBeforeDate = "NotBeforeDate"
-}
-/**
- * Interface for schema-related operations.
- */
-export interface SchemaInterface {
-    /**
-     * Checks if the value of a field is empty.
-     * @param field The schema field.
-     * @param value The value to check.
-     * @returns True if the value is empty, false otherwise.
-     */
-    isEmptyValue(field: SchemaField, value: any): boolean;
-    /**
-     * Gets the text representation of a field's value.
-     * @param field The schema field.
-     * @param value The value to convert.
-     * @param element Indicates if the value is an element, optional.
-     * @returns The text representation of the value.
-     */
-    textValue(field: SchemaField, value: any, element?: boolean): string | undefined;
-    /**
-     * Gets the length of a control's value.
-     * @param field The schema field.
-     * @param control The control to check.
-     * @returns The length of the control's value.
-     */
-    controlLength(field: SchemaField, control: Control<any>): number;
-    /**
-     * Gets the length of a field's value.
-     * @param field The schema field.
-     * @param value The value to check.
-     * @returns The length of the value.
-     */
-    valueLength(field: SchemaField, value: any): number;
-    /**
-     * Gets the data options for a schema data node.
-     * @param node The schema data node.
-     * @returns The data options.
-     */
-    getDataOptions(node: SchemaDataNode): FieldOption[] | null | undefined;
-    /**
-     * Gets the node options for a schema node.
-     * @param node The schema node.
-     * @returns The node options.
-     */
-    getNodeOptions(node: SchemaNode): FieldOption[] | null | undefined;
-    /**
-     * Gets the options for a schema field.
-     * @param field The schema field.
-     * @returns The field options.
-     */
-    getOptions(field: SchemaField): FieldOption[] | undefined | null;
-    /**
-     * Gets the filter options for a schema data node and field.
-     * @param array The schema data node.
-     * @param field The schema node.
-     * @returns The filter options.
-     */
-    getFilterOptions(array: SchemaDataNode, field: SchemaNode): FieldOption[] | undefined | null;
-    /**
-     * Parses a string value to milliseconds.
-     * @param field The schema field.
-     * @param v The string value to parse.
-     * @returns The parsed value in milliseconds.
-     */
-    parseToMillis(field: SchemaField, v: string): number;
-    /**
-     * Gets the validation message text for a field.
-     * @param field The schema field.
-     * @param messageType The type of validation message.
-     * @param actual The actual value.
-     * @param expected The expected value.
-     * @returns The validation message text.
-     */
-    validationMessageText(field: SchemaField, messageType: ValidationMessageType, actual: any, expected: any): string;
-    /**
-     * Compares two values of a field.
-     * @param field The schema field.
-     * @param v1 The first value.
-     * @param v2 The second value.
-     * @returns The comparison result.
-     */
-    compareValue(field: SchemaField, v1: unknown, v2: unknown): number;
-    /**
-     * Gets the search text for a field's value.
-     * @param field The schema field.
-     * @param value The value to search.
-     * @returns The search text.
-     */
-    searchText(field: SchemaField, value: any): string;
-    makeEqualityFunc(field: SchemaNode, element?: boolean): EqualityFunc;
-    makeControlSetup(field: SchemaNode, element?: boolean): ControlSetup<any>;
-}
-export interface SchemaTreeLookup {
-    getSchema(schemaId: string): SchemaNode | undefined;
-}
-export interface SchemaNode extends SchemaTreeLookup {
-    id: string;
-    field: SchemaField;
-    getChildNode(field: string): SchemaNode | undefined;
-    getChildNodes(noRecurse?: boolean, withParent?: SchemaNode): SchemaNode[];
-    parent?: SchemaNode;
-}
-export interface SchemaDataNode {
-    id: string;
-    schema: SchemaNode;
-    elementIndex?: number;
-    control: Control<any>;
-    parent?: SchemaDataNode;
-    getChild(schemaNode: SchemaNode): SchemaDataNode;
-    getChildElement(index: number): SchemaDataNode;
-}
-export declare function findField(fields: SchemaField[], field: string): SchemaField | undefined;
-export declare function isScalarField(sf: SchemaField): sf is SchemaField;
-export declare function isCompoundField(sf: SchemaField): sf is CompoundField;
-export declare function createSchemaLookup<A extends Record<string, SchemaField[]>>(schemaMap: A): {
-    getSchema(schemaId: keyof A): SchemaNode;
-};
-export declare function makeSchemaDataNode(schema: SchemaNode, control: Control<unknown>, parent?: SchemaDataNode, elementIndex?: number): SchemaDataNode;
-export declare function schemaDataForFieldRef(fieldRef: string | undefined, schema: SchemaDataNode): SchemaDataNode;
-export declare function schemaForFieldRef(fieldRef: string | undefined, schema: SchemaNode): SchemaNode;
-export declare function traverseSchemaPath<A>(fieldPath: string[], schema: SchemaNode, acc: A, next: (acc: A, node: SchemaNode) => A): A;
-export declare function traverseData(fieldPath: string[], root: SchemaNode, data: {
-    [k: string]: any;
-}): unknown;
-export declare function schemaDataForFieldPath(fieldPath: string[], dataNode: SchemaDataNode): SchemaDataNode;
-export declare function schemaForFieldPath(fieldPath: string[], schema: SchemaNode): SchemaNode;
-export declare function rootSchemaNode(fields: SchemaField[], lookup?: SchemaTreeLookup): SchemaNode;
-export declare function getSchemaNodePath(node: SchemaNode): string[];
-export declare function isCompoundNode(node: SchemaNode): boolean;
-/**
- * Returns the relative path from a parent node to a child node.
- * @param parent
- * @param child
- */
-export declare function relativePath(parent: SchemaNode, child: SchemaNode): string;
-export declare enum SchemaTags {
-    NoControl = "_NoControl",
-    HtmlEditor = "_HtmlEditor",
-    ControlGroup = "_ControlGroup:",
-    ControlRef = "_ControlRef:",
-    IdField = "_IdField:"
-}
-export declare function getTagParam(field: SchemaField, tag: string): string | undefined;
-export declare function makeParamTag(tag: string, value: string): string;

package/lib/schemaValidator.d.ts

@@ -1,27 +0,0 @@
-export declare enum ValidatorType {
-    Jsonata = "Jsonata",
-    Date = "Date",
-    Length = "Length"
-}
-export interface SchemaValidator {
-    type: string;
-}
-export interface JsonataValidator extends SchemaValidator {
-    type: ValidatorType.Jsonata;
-    expression: string;
-}
-export interface LengthValidator extends SchemaValidator {
-    type: ValidatorType.Length;
-    min?: number | null;
-    max?: number | null;
-}
-export declare enum DateComparison {
-    NotBefore = "NotBefore",
-    NotAfter = "NotAfter"
-}
-export interface DateValidator extends SchemaValidator {
-    type: ValidatorType.Date;
-    comparison: DateComparison;
-    fixedDate?: string | null;
-    daysFromCurrent?: number | null;
-}

package/lib/validators.d.ts

@@ -1,19 +0,0 @@
-import { ControlDefinition, DataControlDefinition, ControlDataContext } from "./controlDefinition";
-import { Control } from "@react-typed-forms/core";
-import { DateValidator, JsonataValidator, LengthValidator, SchemaValidator } from "./schemaValidator";
-import { SchemaField } from "./schemaField";
-interface ValidationHookContext {
-    hiddenControl: Control<boolean | null | undefined>;
-    dataContext: ControlDataContext;
-    control: Control<any>;
-}
-export interface ValidationContext extends ValidationHookContext {
-    definition: DataControlDefinition;
-    field: SchemaField;
-    index: number;
-}
-export declare function useMakeValidationHook(definition: ControlDefinition, useValidatorFor?: (validator: SchemaValidator, ctx: ValidationContext) => void): (ctx: ValidationHookContext) => void;
-export declare function useJsonataValidator(validator: JsonataValidator, ctx: ValidationContext): void;
-export declare function useLengthValidator(lv: LengthValidator, ctx: ValidationContext): void;
-export declare function useDateValidator(dv: DateValidator, ctx: ValidationContext): void;
-export {};