@react-typed-forms/schemas 1.0.0-dev.15 → 1.0.0-dev.16

package/lib/controlRender.d.ts

@@ -1,100 +1,100 @@
-import { ActionControlDefinition, CompoundField, ControlDefinition, DataControlDefinition, DisplayControlDefinition, EntityExpression, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
-import React, { Key, ReactElement, ReactNode } from "react";
-import { Control } from "@react-typed-forms/core";
-export type ExpressionHook = (expr: EntityExpression, formState: FormEditState) => any;
-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;
-    useExpression: ExpressionHook;
-}
-export interface DataControlProperties {
-    control: Control<any>;
-    visible: boolean;
-    readonly: boolean;
-    defaultValue: any;
-    required: boolean;
-    options: FieldOption[] | undefined | null;
-    customRender?: (props: DataRendererProps) => ReactElement;
-}
-export interface GroupControlProperties {
-    visible: boolean;
-    hooks: FormEditHooks;
-}
-export interface DisplayControlProperties {
-    visible: boolean;
-}
-export interface ActionControlProperties {
-    visible: boolean;
-    onClick: () => void;
-}
-export interface ControlData {
-    [field: string]: any;
-}
-export interface FormEditState {
-    fields: SchemaField[];
-    data: Control<ControlData>;
-    readonly?: boolean;
-}
-export interface FormRendererComponents {
-    renderData: (props: DataRendererProps, control: Control<any>, element: boolean, renderers: FormRendererComponents) => ReactElement;
-    renderCompound: (props: CompoundGroupRendererProps, control: Control<any>, renderers: FormRendererComponents) => ReactElement;
-    renderGroup: (props: GroupRendererProps) => ReactElement;
-    renderDisplay: (props: DisplayRendererProps) => ReactElement;
-    renderAction: (props: ActionRendererProps) => ReactElement;
-}
-export declare function FormRendererProvider({ value, children, }: {
-    value: FormRendererComponents;
-    children: ReactNode;
-}): React.JSX.Element;
-export declare function useFormRendererComponents(): FormRendererComponents;
-export interface DisplayRendererProps {
-    definition: DisplayControlDefinition;
-    properties: DisplayControlProperties;
-}
-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;
-}
-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 controlTitle(title: string | undefined | null, field: SchemaField): string;
-export declare function renderControl<S extends ControlDefinition>(definition: S, formState: FormEditState, hooks: FormEditHooks, key: Key, wrapChild?: (key: Key, db: ReactElement) => ReactElement): ReactElement;
-export declare function controlForField(field: string, formState: FormEditState): Control<any>;
-export declare function fieldForControl(c: ControlDefinition): string | null | undefined;
-export declare function isDataControl(c: ControlDefinition): c is DataControlDefinition;
-export declare function isGroupControl(c: ControlDefinition): c is GroupedControlsDefinition;
+import { ActionControlDefinition, CompoundField, ControlDefinition, DataControlDefinition, DisplayControlDefinition, EntityExpression, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
+import React, { Key, ReactElement, ReactNode } from "react";
+import { Control } from "@react-typed-forms/core";
+export type ExpressionHook = (expr: EntityExpression, formState: FormEditState) => any;
+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;
+    useExpression: ExpressionHook;
+}
+export interface DataControlProperties {
+    control: Control<any>;
+    visible: boolean;
+    readonly: boolean;
+    defaultValue: any;
+    required: boolean;
+    options: FieldOption[] | undefined | null;
+    customRender?: (props: DataRendererProps) => ReactElement;
+}
+export interface GroupControlProperties {
+    visible: boolean;
+    hooks: FormEditHooks;
+}
+export interface DisplayControlProperties {
+    visible: boolean;
+}
+export interface ActionControlProperties {
+    visible: boolean;
+    onClick: () => void;
+}
+export interface ControlData {
+    [field: string]: any;
+}
+export interface FormEditState {
+    fields: SchemaField[];
+    data: Control<ControlData>;
+    readonly?: boolean;
+}
+export interface FormRendererComponents {
+    renderData: (props: DataRendererProps, control: Control<any>, element: boolean, renderers: FormRendererComponents) => ReactElement;
+    renderCompound: (props: CompoundGroupRendererProps, control: Control<any>, renderers: FormRendererComponents) => ReactElement;
+    renderGroup: (props: GroupRendererProps) => ReactElement;
+    renderDisplay: (props: DisplayRendererProps) => ReactElement;
+    renderAction: (props: ActionRendererProps) => ReactElement;
+}
+export declare function FormRendererProvider({ value, children, }: {
+    value: FormRendererComponents;
+    children: ReactNode;
+}): React.JSX.Element;
+export declare function useFormRendererComponents(): FormRendererComponents;
+export interface DisplayRendererProps {
+    definition: DisplayControlDefinition;
+    properties: DisplayControlProperties;
+}
+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;
+}
+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 controlTitle(title: string | undefined | null, field: SchemaField): string;
+export declare function renderControl<S extends ControlDefinition>(definition: S, formState: FormEditState, hooks: FormEditHooks, key: Key, wrapChild?: (key: Key, db: ReactElement) => ReactElement): ReactElement;
+export declare function controlForField(field: string, formState: FormEditState): Control<any>;
+export declare function fieldForControl(c: ControlDefinition): string | null | undefined;
+export declare function isDataControl(c: ControlDefinition): c is DataControlDefinition;
+export declare function isGroupControl(c: ControlDefinition): c is GroupedControlsDefinition;

package/lib/hooks.d.ts

@@ -1,9 +1,9 @@
-import { ControlDefinition, DataControlDefinition, FieldOption, SchemaField } from "./types";
-import { DataControlProperties, ExpressionHook, FormEditHooks, FormEditState } from "./controlRender";
-import { Control } from "@react-typed-forms/core";
-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(definition: DataControlDefinition, field: SchemaField, visible: boolean, defaultValue: any, control: Control<any>, readonly?: boolean): DataControlProperties;
-export declare function getOptionsForScalarField(field: SchemaField): FieldOption[] | undefined | null;
-export declare const defaultExpressionHook: ExpressionHook;
-export declare function createFormEditHooks(useExpression: ExpressionHook): FormEditHooks;
+import { ControlDefinition, DataControlDefinition, FieldOption, SchemaField } from "./types";
+import { DataControlProperties, ExpressionHook, FormEditHooks, FormEditState } from "./controlRender";
+import { Control } from "@react-typed-forms/core";
+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(definition: DataControlDefinition, field: SchemaField, visible: boolean, defaultValue: any, control: Control<any>, readonly?: boolean): DataControlProperties;
+export declare function getOptionsForScalarField(field: SchemaField): FieldOption[] | undefined | null;
+export declare const defaultExpressionHook: ExpressionHook;
+export declare function createFormEditHooks(useExpression: ExpressionHook): FormEditHooks;

package/lib/index.d.ts

@@ -1,7 +1,5 @@
-import { SchemaField } from "./types";
-export * from "./types";
-export * from "./schemaBuilder";
-export * from "./controlRender";
-export * from "./hooks";
-export declare function fieldHasTag(field: SchemaField, tag: string): boolean;
-export declare function fieldDisplayName(field: SchemaField): string;
+export * from "./types";
+export * from "./schemaBuilder";
+export * from "./controlRender";
+export * from "./hooks";
+export * from "./util";