@react-typed-forms/schemas 9.1.1 → 10.0.0

package/lib/renderers.d.ts

@@ -1,7 +1,6 @@
-import React, { CSSProperties, ReactElement, ReactNode } from "react";
-import { Control } from "@react-typed-forms/core";
-import { ActionRendererProps, AdornmentProps, AdornmentRenderer, ArrayRendererProps, ControlLayoutProps, DataRendererProps, DisplayRendererProps, FormRenderer, GroupRendererProps, LabelRendererProps, LabelType, RenderedControl, RenderedLayout, VisibilityRendererProps } from "./controlRender";
-import { ControlAdornment, FieldOption, GridRenderer, IconAdornment, SchemaField, SchemaInterface } from "./types";
+import { ReactElement, ReactNode } from "react";
+import { ActionRendererProps, AdornmentProps, AdornmentRenderer, ArrayRendererProps, ControlLayoutProps, DataRendererProps, DisplayRendererProps, FormRenderer, GroupRendererProps, LabelRendererProps, LabelType, RenderedControl, VisibilityRendererProps } from "./controlRender";
+import { ControlAdornment, IconAdornment } from "./types";
 export interface DefaultRenderers {
     data: DataRendererRegistration;
     label: LabelRendererRegistration;
@@ -61,86 +60,6 @@ export interface VisibilityRendererRegistration {
     render: (props: VisibilityRendererProps) => ReactNode;
 }
 export type RendererRegistration = DataRendererRegistration | GroupRendererRegistration | DisplayRendererRegistration | ActionRendererRegistration | LabelRendererRegistration | ArrayRendererRegistration | AdornmentRendererRegistration | LayoutRendererRegistration | VisibilityRendererRegistration;
-export declare function createFormRenderer(customRenderers?: RendererRegistration[], defaultRenderers?: DefaultRenderers): FormRenderer;
-interface DefaultLabelRendererOptions {
-    className?: string;
-    groupLabelClass?: string;
-    controlLabelClass?: string;
-    requiredElement?: ReactNode;
-}
-interface DefaultActionRendererOptions {
-    className?: string;
-}
-export declare function createDefaultActionRenderer(options?: DefaultActionRendererOptions): ActionRendererRegistration;
-export declare function createDefaultLabelRenderer(options?: DefaultLabelRendererOptions): LabelRendererRegistration;
-interface DefaultArrayRendererOptions {
-    className?: string;
-    removableClass?: string;
-    childClass?: string;
-    removableChildClass?: string;
-    removeActionClass?: string;
-    addActionClass?: string;
-}
-export declare function createDefaultArrayRenderer(options?: DefaultArrayRendererOptions): ArrayRendererRegistration;
-interface StyleProps {
-    className?: string;
-    style?: CSSProperties;
-}
-interface DefaultGroupRendererOptions {
-    className?: string;
-    standardClassName?: string;
-    gridStyles?: (columns: GridRenderer) => StyleProps;
-    gridClassName?: string;
-    defaultGridColumns?: number;
-    flexClassName?: string;
-    defaultFlexGap?: string;
-}
-export declare function createDefaultGroupRenderer(options?: DefaultGroupRendererOptions): GroupRendererRegistration;
-export interface DefaultDisplayRendererOptions {
-    textClassName?: string;
-    htmlClassName?: string;
-}
-export declare function createDefaultDisplayRenderer(options?: DefaultDisplayRendererOptions): DisplayRendererRegistration;
-export declare function DefaultDisplay({ data, display, className, style, ...options }: DefaultDisplayRendererOptions & DisplayRendererProps): React.JSX.Element;
-export declare const DefaultBoolOptions: FieldOption[];
-interface DefaultDataRendererOptions {
-    inputClass?: string;
-    displayOnlyClass?: string;
-    selectOptions?: SelectRendererOptions;
-    booleanOptions?: FieldOption[];
-    optionRenderer?: DataRendererRegistration;
-}
-export declare function createDefaultDataRenderer(options?: DefaultDataRendererOptions): DataRendererRegistration;
-export declare function DefaultDisplayOnly({ control, className, emptyText, schemaInterface, field, style, }: {
-    control: Control<any>;
-    field: SchemaField;
-    schemaInterface: SchemaInterface;
-    className?: string;
-    style?: React.CSSProperties;
-    emptyText?: string | null;
-}): React.JSX.Element;
-export declare function ControlInput({ control, convert, ...props }: React.InputHTMLAttributes<HTMLInputElement> & {
-    control: Control<any>;
-    convert: InputConversion;
-}): React.JSX.Element;
-export interface DefaultAdornmentRendererOptions {
-}
-export declare function createDefaultAdornmentRenderer(options?: DefaultAdornmentRendererOptions): AdornmentRendererRegistration;
-export interface DefaultLayoutRendererOptions {
-    className?: string;
-    errorClass?: string;
-}
-export interface DefaultRendererOptions {
-    data?: DefaultDataRendererOptions;
-    display?: DefaultDisplayRendererOptions;
-    action?: DefaultActionRendererOptions;
-    array?: DefaultArrayRendererOptions;
-    group?: DefaultGroupRendererOptions;
-    label?: DefaultLabelRendererOptions;
-    adornment?: DefaultAdornmentRendererOptions;
-    layout?: DefaultLayoutRendererOptions;
-}
-export declare function createDefaultRenderers(options?: DefaultRendererOptions): DefaultRenderers;
 export declare function isIconAdornment(a: ControlAdornment): a is IconAdornment;
 export declare function createLayoutRenderer(render: LayoutRendererRegistration["render"], options?: Partial<LayoutRendererRegistration>): LayoutRendererRegistration;
 export declare function createArrayRenderer(render: ArrayRendererRegistration["render"], options?: Partial<ArrayRendererRegistration>): ArrayRendererRegistration;
@@ -150,34 +69,3 @@ export declare function createDisplayRenderer(render: DisplayRendererRegistratio
 export declare function createLabelRenderer(render: LabelRendererRegistration["render"], options?: Omit<LabelRendererRegistration, "type">): LabelRendererRegistration;
 export declare function createVisibilityRenderer(render: VisibilityRendererRegistration["render"], options?: Partial<VisibilityRendererRegistration>): VisibilityRendererRegistration;
 export declare function createAdornmentRenderer(render: (props: AdornmentProps) => AdornmentRenderer, options?: Partial<AdornmentRendererRegistration>): AdornmentRendererRegistration;
-export interface SelectRendererOptions {
-    className?: string;
-    emptyText?: string;
-    requiredText?: string;
-}
-export declare function createSelectRenderer(options?: SelectRendererOptions): DataRendererRegistration;
-type SelectConversion = (a: any) => string | number;
-interface SelectDataRendererProps {
-    id?: string;
-    className?: string;
-    options: {
-        name: string;
-        value: any;
-        disabled?: boolean;
-    }[];
-    emptyText?: string;
-    requiredText?: string;
-    required: boolean;
-    state: Control<any>;
-    convert: SelectConversion;
-}
-export declare function SelectDataRenderer({ state, options, className, convert, required, emptyText, requiredText, ...props }: SelectDataRendererProps): React.JSX.Element;
-export declare function createSelectConversion(ft: string): SelectConversion;
-type InputConversion = [string, (s: any) => any, (a: any) => string | number];
-export declare function createInputConversion(ft: string): InputConversion;
-export declare function createDefaultVisibilityRenderer(): VisibilityRendererRegistration;
-export declare function DefaultVisibility({ visibility, children, className, style, divRef, }: VisibilityRendererProps): React.JSX.Element;
-export declare function DefaultLayout({ errorClass, layout: { controlEnd, controlStart, label, children, errorControl }, }: DefaultLayoutRendererOptions & {
-    layout: RenderedLayout;
-}): React.JSX.Element;
-export {};

package/lib/schemaInterface.d.ts

@@ -1,4 +1,9 @@
 import { SchemaField, SchemaInterface } from "./types";
+import { Control } from "@react-typed-forms/core";
+export declare class DefaultSchemaInterface implements SchemaInterface {
+    isEmptyValue(f: SchemaField, value: any): boolean;
+    textValue(field: SchemaField, value: any, element?: boolean | undefined): string | undefined;
+    controlLength(f: SchemaField, control: Control<any>): number;
+    valueLength(field: SchemaField, value: any): number;
+}
 export declare const defaultSchemaInterface: SchemaInterface;
-export declare function defaultIsEmpty(f: SchemaField, value: any): boolean;
-export declare function defaultTextValue(f: SchemaField, value: any): string | undefined;

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { Control } from "@react-typed-forms/core";
 export interface SchemaField {
     type: string;
     field: string;
@@ -36,6 +37,8 @@ export interface EntityRefField extends SchemaField {
 export interface FieldOption {
     name: string;
     value: any;
+    description?: string | null;
+    disabled?: boolean | null;
 }
 export interface CompoundField extends SchemaField {
     type: FieldType.Compound;
@@ -47,6 +50,8 @@ export type AnyControlDefinition = DataControlDefinition | GroupedControlsDefini
 export interface SchemaInterface {
     isEmptyValue(field: SchemaField, value: any): boolean;
     textValue(field: SchemaField, value: any, element?: boolean): string | undefined;
+    controlLength(field: SchemaField, control: Control<any>): number;
+    valueLength(field: SchemaField, value: any): number;
 }
 export interface ControlDefinition {
     type: string;
@@ -155,6 +160,7 @@ export interface RenderOptions {
 }
 export declare enum DataRenderType {
     Standard = "Standard",
+    Textfield = "Textfield",
     Radio = "Radio",
     HtmlEditor = "HtmlEditor",
     IconList = "IconList",
@@ -168,6 +174,10 @@ export declare enum DataRenderType {
     DisplayOnly = "DisplayOnly",
     Group = "Group"
 }
+export interface TextfieldRenderOptions extends RenderOptions {
+    type: DataRenderType.Textfield;
+    placeholder?: string | null;
+}
 export interface RadioButtonRenderOptions extends RenderOptions {
     type: DataRenderType.Radio;
 }
@@ -281,7 +291,8 @@ export interface ActionControlDefinition extends ControlDefinition {
 }
 export declare enum ValidatorType {
     Jsonata = "Jsonata",
-    Date = "Date"
+    Date = "Date",
+    Length = "Length"
 }
 export interface SchemaValidator {
     type: string;
@@ -290,6 +301,11 @@ 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"
@@ -314,4 +330,5 @@ export declare function visitControlDefinition<A>(x: ControlDefinition, visitor:
 export declare function isGridRenderer(options: GroupRenderOptions): options is GridRenderer;
 export declare function isFlexRenderer(options: GroupRenderOptions): options is FlexRenderer;
 export declare function isDisplayOnlyRenderer(options: RenderOptions): options is DisplayOnlyRenderOptions;
+export declare function isTextfieldRenderer(options: RenderOptions): options is TextfieldRenderOptions;
 export declare function isDataGroupRenderer(options: RenderOptions): options is DataGroupRenderOptions;

package/lib/util.d.ts

@@ -1,7 +1,11 @@
 import { CompoundField, ControlDefinition, DataControlDefinition, DisplayOnlyRenderOptions, FieldOption, GroupedControlsDefinition, SchemaField, SchemaInterface } from "./types";
 import { MutableRefObject } from "react";
 import { Control } from "@react-typed-forms/core";
-import { DataContext, JsonPath } from "./controlRender";
+export type JsonPath = string | number;
+export interface DataContext {
+    data: Control<any>;
+    path: JsonPath[];
+}
 export interface ControlDataContext extends DataContext {
     fields: SchemaField[];
     schemaInterface: SchemaInterface;
@@ -54,3 +58,5 @@ export declare function useDynamicHooks<P, Hooks extends Record<string, DynamicH
     [K in keyof Hooks]: DynamicHookValue<Hooks[K]>;
 };
 export declare function toDepString(x: any): string;
+export declare function appendElementIndex(dataContext: ControlDataContext, elementIndex: number): ControlDataContext;
+export declare function applyLengthRestrictions<Min, Max>(length: number, min: number | null | undefined, max: number | null | undefined, minValue: Min, maxValue: Max): [Min | undefined, Max | undefined];

package/lib/validators.d.ts

@@ -1,4 +1,4 @@
-import { ControlDefinition } from "./types";
+import { ControlDefinition, SchemaField, SchemaInterface } from "./types";
 import { Control } from "@react-typed-forms/core";
 import { ControlDataContext } from "./util";
-export declare function useValidationHook(definition: ControlDefinition): (control: Control<any>, hidden: boolean, groupContext: ControlDataContext) => void;
+export declare function useValidationHook(definition: ControlDefinition, field: SchemaField | undefined): (control: Control<any>, hidden: boolean, groupContext: ControlDataContext, schemaInterface: SchemaInterface) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-typed-forms/schemas",
-  "version": "9.1.1",
+  "version": "10.0.0",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",