@react-typed-forms/schemas 1.0.0-dev.2 → 1.0.0-dev.20

package/lib/controlRender.d.ts

@@ -1,30 +1,40 @@
-import { ActionControlDefinition, AnyControlDefinition, CompoundField, ControlDefinition, DataControlDefinition, DisplayControlDefinition, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
-import React, { Key, ReactElement } from "react";
+import { ActionControlDefinition, AdornmentPlacement, CompoundField, ControlAdornment, ControlDefinition, DataControlDefinition, DisplayControlDefinition, EntityExpression, FieldOption, GroupedControlsDefinition, RenderOptions, SchemaField, SchemaValidator } from "./types";
+import React, { Key, ReactElement, ReactNode } from "react";
 import { Control } from "@react-typed-forms/core";
+export interface SchemaHooks {
+    useExpression(expr: EntityExpression, formState: FormEditState): Control<any | undefined>;
+    useValidators(formState: FormEditState, isVisible: boolean, control: Control<any>, required: boolean, validations?: SchemaValidator[] | null): void;
+}
 export interface FormEditHooks {
-    useDataProperties(formState: FormEditState, definition: DataControlDefinition, field: SchemaField): DataControlProperties;
-    useGroupProperties(formState: FormEditState, definition: GroupedControlsDefinition, currentHooks: FormEditHooks): GroupControlProperties;
-    useDisplayProperties(formState: FormEditState, definition: DisplayControlDefinition): DisplayControlProperties;
-    useActionProperties(formState: FormEditState, definition: ActionControlDefinition): ActionControlProperties;
+    useDataProperties(formState: FormEditState, definition: DataControlDefinition, field: SchemaField, renderers: FormRenderer): DataRendererProps;
+    useGroupProperties(formState: FormEditState, definition: GroupedControlsDefinition, currentHooks: FormEditHooks, renderers: FormRenderer): GroupRendererProps;
+    useDisplayProperties(formState: FormEditState, definition: DisplayControlDefinition): DisplayRendererProps;
+    useActionProperties(formState: FormEditState, definition: ActionControlDefinition): ActionRendererProps;
+    schemaHooks: SchemaHooks;
 }
-export interface DataControlProperties {
+export interface DataRendererProps {
+    definition: DataControlDefinition;
+    renderOptions: RenderOptions;
+    visible: Visibility;
+    control: Control<any>;
+    field: SchemaField;
+    array?: ArrayRendererProps;
     readonly: boolean;
-    visible: boolean;
-    options: FieldOption[] | undefined;
     defaultValue: any;
     required: boolean;
-    customRender?: (props: DataRendererProps, control: Control<any>) => ReactElement;
+    options: FieldOption[] | undefined | null;
+    customRender?: (props: DataRendererProps) => ReactElement;
+    formState: FormEditState;
 }
-export interface GroupControlProperties {
-    visible: boolean;
+export interface GroupRendererProps {
+    definition: Omit<GroupedControlsDefinition, "children">;
+    visible: Visibility;
+    field?: CompoundField;
+    array?: ArrayRendererProps;
+    hideTitle: boolean;
     hooks: FormEditHooks;
-}
-export interface DisplayControlProperties {
-    visible: boolean;
-}
-export interface ActionControlProperties {
-    visible: boolean;
-    onClick: () => void;
+    childCount: number;
+    renderChild: (child: number) => ReactElement;
 }
 export interface ControlData {
     [field: string]: any;
@@ -33,63 +43,70 @@ export interface FormEditState {
     fields: SchemaField[];
     data: Control<ControlData>;
     readonly?: boolean;
+    invisible?: boolean;
+}
+export interface ArrayRendererProps {
+    definition: DataControlDefinition | GroupedControlsDefinition;
+    control: Control<any[]>;
+    field: SchemaField;
+    addAction?: ActionRendererProps;
+    removeAction?: (childCount: number) => ActionRendererProps;
+    childCount: number;
+    renderChild: (childCount: number) => ReactElement;
+    childKey: (childCount: number) => Key;
+}
+export interface AdornmentProps {
+    key: Key;
+    definition: ControlAdornment;
 }
-export interface FormRendererComponents {
-    renderData: (props: DataRendererProps, control: Control<any>, element: boolean, renderers: FormRendererComponents) => ReactElement;
-    renderCompound: (props: CompoundGroupRendererProps, control: Control<any>, renderers: FormRendererComponents) => ReactElement;
+export interface AdornmentRenderer {
+    wrap?: (children: ReactElement) => ReactElement;
+    child?: [AdornmentPlacement, ReactNode];
+}
+export interface FormRenderer {
+    renderData: (props: DataRendererProps) => ReactElement;
     renderGroup: (props: GroupRendererProps) => ReactElement;
     renderDisplay: (props: DisplayRendererProps) => ReactElement;
     renderAction: (props: ActionRendererProps) => ReactElement;
+    renderArray: (props: ArrayRendererProps) => ReactElement;
+    renderLabel: (props: LabelRendererProps, elem: ReactElement) => ReactElement;
+    renderVisibility: (visible: Visibility, elem: ReactElement) => ReactElement;
+    renderAdornment: (props: AdornmentProps) => AdornmentRenderer;
+}
+export declare function FormRendererProvider({ value, children, }: {
+    value: FormRenderer;
+    children: ReactNode;
+}): React.JSX.Element;
+export declare function useFormRendererComponents(): FormRenderer;
+export interface Visibility {
+    value: boolean;
+    canChange: boolean;
+}
+export interface LabelRendererProps {
+    visible: Visibility;
+    title?: ReactNode;
+    forId?: string;
+    required: boolean;
+    control?: Control<any>;
+    group?: boolean;
+    renderAdornment: (placement: AdornmentPlacement) => ReactElement;
 }
-export declare const FormRendererComponentsContext: React.Context<FormRendererComponents | undefined>;
-export declare function useFormRendererComponents(): FormRendererComponents;
 export interface DisplayRendererProps {
     definition: DisplayControlDefinition;
-    properties: DisplayControlProperties;
+    visible: Visibility;
 }
 export interface ActionRendererProps {
     definition: ActionControlDefinition;
-    properties: ActionControlProperties;
-}
-export interface DataRendererProps {
-    definition: DataControlDefinition;
-    properties: DataControlProperties;
-    field: SchemaField;
-    formEditState?: FormEditState;
-}
-export interface GroupRendererProps {
-    definition: Omit<GroupedControlsDefinition, "children">;
-    properties: GroupControlProperties;
-    childCount: number;
-    renderChild: (child: number, wrapChild: (key: Key, childElem: ReactElement) => ReactElement) => ReactElement;
-}
-export interface CompoundGroupRendererProps {
-    definition: GroupedControlsDefinition;
-    field: CompoundField;
-    properties: GroupControlProperties;
-    renderChild: (key: Key, control: ControlDefinition, data: Control<{
-        [field: string]: any;
-    }>, wrapChild: (key: Key, childElem: ReactElement) => ReactElement) => ReactElement;
+    visible: Visibility;
+    onClick: () => void;
 }
-export declare function isScalarField(sf: SchemaField): sf is SchemaField;
-export declare function isCompoundField(sf: SchemaField): sf is CompoundField;
 export type AnySchemaFields = SchemaField | (Omit<CompoundField, "children"> & {
     children: AnySchemaFields[];
 });
-export declare function applyDefaultValues(v: {
-    [k: string]: any;
-} | undefined, fields: SchemaField[]): any;
-export declare function applyDefaultForField(v: any, field: SchemaField, parent: SchemaField[], notElement?: boolean): any;
-export declare function defaultValueForFields(fields: SchemaField[]): any;
-export declare function defaultValueForField(sf: SchemaField): any;
-export declare function elementValueForField(sf: SchemaField): any;
-export declare function findScalarField(fields: SchemaField[], field: string): SchemaField | undefined;
-export declare function findCompoundField(fields: SchemaField[], field: string): CompoundField | undefined;
-export declare function findField(fields: SchemaField[], field: string): SchemaField | undefined;
-export declare function fieldDisplayName(sf: SchemaField): string;
-export declare function controlTitle(title: string | undefined, field: SchemaField): string;
-export declare function renderControl(definition: AnyControlDefinition, formState: FormEditState, hooks: FormEditHooks, key: Key, wrapChild?: (key: Key, db: ReactElement) => ReactElement): ReactElement;
+export declare function controlTitle(title: string | undefined | null, field: SchemaField): string;
+export declare function renderControl<S extends ControlDefinition>(definition: S, formState: FormEditState, hooks: FormEditHooks, key: Key): ReactElement;
 export declare function controlForField(field: string, formState: FormEditState): Control<any>;
-export declare function fieldForControl(c: ControlDefinition): string | undefined;
-export declare function isDataControl(c: ControlDefinition): c is DataControlDefinition;
-export declare function isGroupControl(c: ControlDefinition): c is GroupedControlsDefinition;
+export declare function fieldForControl(c: ControlDefinition): string | null | undefined;
+export declare const AlwaysVisible: Visibility;
+export declare function createAction(label: string, onClick: () => void, actionId?: string): ActionRendererProps;
+export declare function visitControlData<S extends ControlDefinition, A>(definition: S, { fields, data }: FormEditState, cb: (definition: DataControlDefinition, control: Control<any>) => A | undefined): A | undefined;

package/lib/hooks.d.ts

@@ -1,9 +1,11 @@
-import { DataControlDefinition, EntityExpression, FieldOption, ControlDefinition, SchemaField } from "./types";
-import { DataControlProperties, FormEditHooks, FormEditState } from "./controlRender";
-export type ExpressionHook = (expr: EntityExpression, formState: FormEditState) => any;
-export declare function useDefaultValue(definition: DataControlDefinition, field: SchemaField, formState: FormEditState, useExpression: ExpressionHook): any;
-export declare function useIsControlVisible(definition: ControlDefinition, formState: FormEditState, useExpression: ExpressionHook): boolean;
-export declare function getDefaultScalarControlProperties(control: DataControlDefinition, field: SchemaField, visible: boolean, defaultValue: any, readonly?: boolean): DataControlProperties;
-export declare function getOptionsForScalarField(field: SchemaField): FieldOption[] | undefined;
-export declare const defaultExpressionHook: ExpressionHook;
-export declare function createFormEditHooks(useExpression: ExpressionHook): FormEditHooks;
+import { ControlDefinition, DataControlDefinition, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
+import { DataRendererProps, FormEditHooks, FormEditState, SchemaHooks, Visibility } from "./controlRender";
+import { Control } from "@react-typed-forms/core";
+export declare function useDefaultValue(definition: DataControlDefinition, field: SchemaField, formState: FormEditState, hooks: SchemaHooks): any;
+export declare function useIsControlVisible(definition: ControlDefinition, formState: FormEditState, hooks: SchemaHooks): Visibility;
+export declare function getDefaultScalarControlProperties(definition: DataControlDefinition, field: SchemaField, visible: Visibility, defaultValue: any, control: Control<any>, formState: FormEditState): DataRendererProps;
+export declare function getOptionsForScalarField(field: SchemaField): FieldOption[] | undefined | null;
+export declare function createDefaultSchemaHooks(): SchemaHooks;
+export declare const defaultFormEditHooks: FormEditHooks;
+export declare function createFormEditHooks(schemaHooks: SchemaHooks): FormEditHooks;
+export declare function useControlsWithDefaults(definition: GroupedControlsDefinition, sf: SchemaField[]): GroupedControlsDefinition;

package/lib/index.d.ts

@@ -2,3 +2,6 @@ export * from "./types";
 export * from "./schemaBuilder";
 export * from "./controlRender";
 export * from "./hooks";
+export * from "./util";
+export * from "./renderers";
+export * from "./tailwind";