@react-typed-forms/schemas 5.0.3 → 6.0.0

package/lib/controlBuilder.d.ts

@@ -1,4 +1,4 @@
-import { ControlDefinition, DataControlDefinition, DisplayControlDefinition, DynamicProperty, EntityExpression, FieldValueExpression, GroupedControlsDefinition, JsonataExpression, SchemaField } from "./types";
+import { ControlDefinition, DataControlDefinition, DataMatchExpression, DisplayControlDefinition, DynamicProperty, EntityExpression, GroupedControlsDefinition, JsonataExpression, SchemaField } from "./types";
 import { ActionRendererProps } from "./controlRender";
 export declare function dataControl(field: string, title?: string | null, options?: Partial<DataControlDefinition>): DataControlDefinition;
 export declare function textDisplayControl(text: string, options?: Partial<DisplayControlDefinition>): DisplayControlDefinition;
@@ -7,7 +7,7 @@ export declare function dynamicDefaultValue(expr: EntityExpression): DynamicProp
 export declare function dynamicReadonly(expr: EntityExpression): DynamicProperty;
 export declare function dynamicVisibility(expr: EntityExpression): DynamicProperty;
 export declare function dynamicDisabled(expr: EntityExpression): DynamicProperty;
-export declare function fieldEqExpr(field: string, value: any): FieldValueExpression;
+export declare function fieldEqExpr(field: string, value: any): DataMatchExpression;
 export declare function jsonataExpr(expression: string): JsonataExpression;
 export declare function groupedControl(children: ControlDefinition[], title?: string, options?: Partial<GroupedControlsDefinition>): GroupedControlsDefinition;
 export declare function compoundControl(field: string, title: string | undefined, children: ControlDefinition[], options?: Partial<DataControlDefinition>): DataControlDefinition;

package/lib/controlRender.d.ts

@@ -1,21 +1,18 @@
-import { FC, Key, ReactNode } from "react";
+import React, { FC, Key, ReactNode } from "react";
 import { Control } from "@react-typed-forms/core";
-import { AdornmentPlacement, ControlAdornment, ControlDefinition, DataControlDefinition, DisplayData, FieldOption, GroupRenderOptions, RenderOptions, SchemaField } from "./types";
-import { ControlGroupContext } from "./util";
+import { AdornmentPlacement, ControlAdornment, ControlDefinition, DataControlDefinition, DisplayData, FieldOption, GroupRenderOptions, RenderOptions, SchemaField, SchemaInterface } from "./types";
+import { ControlDataContext } from "./util";
 import { UseEvalExpressionHook } from "./hooks";
 export interface FormRenderer {
     renderData: (props: DataRendererProps, asArray: (() => ReactNode) | undefined) => (layout: ControlLayoutProps) => ControlLayoutProps;
-    renderGroup: (props: GroupRendererProps) => ReactNode;
+    renderGroup: (props: GroupRendererProps) => (layout: ControlLayoutProps) => ControlLayoutProps;
     renderDisplay: (props: DisplayRendererProps) => ReactNode;
     renderAction: (props: ActionRendererProps) => ReactNode;
     renderArray: (props: ArrayRendererProps) => ReactNode;
     renderAdornment: (props: AdornmentProps) => AdornmentRenderer;
     renderLabel: (props: LabelRendererProps, labelStart: ReactNode, labelEnd: ReactNode) => ReactNode;
-    renderLayout: (props: ControlLayoutProps) => ReactNode;
-    renderVisibility: (control: Control<Visibility | undefined>, children: () => ReactNode) => ReactNode;
-}
-export interface DisplayRendererProps {
-    data: DisplayData;
+    renderLayout: (props: ControlLayoutProps) => RenderedControl;
+    renderVisibility: (props: VisibilityRendererProps) => ReactNode;
 }
 export interface AdornmentProps {
     adornment: ControlAdornment;
@@ -35,6 +32,8 @@ export interface ArrayRendererProps {
     renderChild: (childIndex: number) => ReactNode;
     childKey: (childIndex: number) => Key;
     arrayControl?: Control<any[] | undefined | null>;
+    className?: string;
+    style?: React.CSSProperties;
 }
 export interface Visibility {
     visible: boolean;
@@ -48,6 +47,17 @@ export interface RenderedLayout {
     label?: ReactNode;
     children?: ReactNode;
     errorControl?: Control<any>;
+    className?: string;
+    style?: React.CSSProperties;
+}
+export interface RenderedControl {
+    children: ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+    divRef?: (cb: HTMLElement | null) => void;
+}
+export interface VisibilityRendererProps extends RenderedControl {
+    visibility: Control<Visibility | undefined>;
 }
 export interface ControlLayoutProps {
     label?: LabelRendererProps;
@@ -55,6 +65,8 @@ export interface ControlLayoutProps {
     adornments?: AdornmentRenderer[];
     children?: ReactNode;
     processLayout?: (props: ControlLayoutProps) => ControlLayoutProps;
+    className?: string | null;
+    style?: React.CSSProperties;
 }
 export declare enum LabelType {
     Control = 0,
@@ -67,10 +79,18 @@ export interface LabelRendererProps {
     required?: boolean | null;
     forId?: string;
 }
+export interface DisplayRendererProps {
+    data: DisplayData;
+    display?: Control<string | undefined>;
+    className?: string;
+    style?: React.CSSProperties;
+}
 export interface GroupRendererProps {
     renderOptions: GroupRenderOptions;
     childCount: number;
     renderChild: (child: number) => ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
 }
 export interface DataRendererProps {
     renderOptions: RenderOptions;
@@ -81,11 +101,16 @@ export interface DataRendererProps {
     required: boolean;
     options: FieldOption[] | undefined | null;
     hidden: boolean;
+    className?: string;
+    style?: React.CSSProperties;
+    dataContext: ControlDataContext;
 }
 export interface ActionRendererProps {
     actionId: string;
     actionText: string;
     onClick: () => void;
+    className?: string;
+    style?: React.CSSProperties;
 }
 export interface ControlRenderProps {
     control: Control<any>;
@@ -95,21 +120,43 @@ export interface FormContextOptions {
     hidden?: boolean | null;
     disabled?: boolean | null;
 }
-export type CreateDataProps = (definition: DataControlDefinition, field: SchemaField, groupContext: ControlGroupContext, control: Control<any>, options: FormContextOptions) => DataRendererProps;
+export interface DataControlProps {
+    definition: DataControlDefinition;
+    field: SchemaField;
+    dataContext: ControlDataContext;
+    control: Control<any>;
+    options: FormContextOptions;
+    style: React.CSSProperties | undefined;
+}
+export type CreateDataProps = (controlProps: DataControlProps) => DataRendererProps;
 export interface ControlRenderOptions extends FormContextOptions {
     useDataHook?: (c: ControlDefinition) => CreateDataProps;
     useEvalExpressionHook?: UseEvalExpressionHook;
     clearHidden?: boolean;
+    schemaInterface?: SchemaInterface;
 }
 export declare function useControlRenderer(definition: ControlDefinition, fields: SchemaField[], renderer: FormRenderer, options?: ControlRenderOptions): FC<ControlRenderProps>;
 export declare function lookupSchemaField(c: ControlDefinition, fields: SchemaField[]): SchemaField | undefined;
-export declare function getControlData(schemaField: SchemaField | undefined, parentContext: ControlGroupContext): [Control<any> | undefined, ControlGroupContext];
-export declare const defaultDataProps: CreateDataProps;
+export declare function getControlData(schemaField: SchemaField | undefined, parentContext: ControlDataContext): [Control<any> | undefined, ControlDataContext];
+export declare function defaultDataProps({ definition, field, dataContext, control, options, style, }: DataControlProps): DataRendererProps;
 export type ChildRenderer = (k: Key, childIndex: number, props: ControlRenderProps) => ReactNode;
-export declare function renderControlLayout(c: ControlDefinition, renderer: FormRenderer, childCount: number, childRenderer: ChildRenderer, dataProps: CreateDataProps, dataOptions: FormContextOptions, groupContext: ControlGroupContext, childControl?: Control<any>, schemaField?: SchemaField): ControlLayoutProps;
-export declare function appendMarkup(k: keyof Omit<RenderedLayout, "errorControl">, markup: ReactNode): (layout: RenderedLayout) => void;
-export declare function wrapMarkup(k: keyof Omit<RenderedLayout, "errorControl">, wrap: (ex: ReactNode) => ReactNode): (layout: RenderedLayout) => void;
-export declare function layoutKeyForPlacement(pos: AdornmentPlacement): keyof Omit<RenderedLayout, "errorControl">;
+export interface RenderControlProps {
+    definition: ControlDefinition;
+    renderer: FormRenderer;
+    childCount: number;
+    renderChild: ChildRenderer;
+    createDataProps: CreateDataProps;
+    formOptions: FormContextOptions;
+    dataContext: ControlDataContext;
+    control?: Control<any>;
+    schemaField?: SchemaField;
+    displayControl?: Control<string | undefined>;
+    style?: React.CSSProperties;
+}
+export declare function renderControlLayout({ definition: c, renderer, childCount, renderChild: childRenderer, control: childControl, schemaField, dataContext, formOptions: dataOptions, createDataProps: dataProps, displayControl, style, }: RenderControlProps): ControlLayoutProps;
+export declare function appendMarkup(k: keyof Omit<RenderedLayout, "errorControl" | "style" | "className">, markup: ReactNode): (layout: RenderedLayout) => void;
+export declare function wrapMarkup(k: keyof Omit<RenderedLayout, "errorControl" | "style" | "className">, wrap: (ex: ReactNode) => ReactNode): (layout: RenderedLayout) => void;
+export declare function layoutKeyForPlacement(pos: AdornmentPlacement): keyof Omit<RenderedLayout, "errorControl" | "style" | "className">;
 export declare function appendMarkupAt(pos: AdornmentPlacement, markup: ReactNode): (layout: RenderedLayout) => void;
 export declare function wrapMarkupAt(pos: AdornmentPlacement, wrap: (ex: ReactNode) => ReactNode): (layout: RenderedLayout) => void;
 export declare function renderLayoutParts(props: ControlLayoutProps, renderer: FormRenderer): RenderedLayout;

package/lib/hooks.d.ts

@@ -1,15 +1,19 @@
-import { ControlDefinition, DynamicPropertyType, EntityExpression, SchemaField } from "./types";
+/// <reference types="react" />
+import { ControlDefinition, DynamicPropertyType, EntityExpression, SchemaField, SchemaInterface } from "./types";
 import { Control } from "@react-typed-forms/core";
-import { ControlGroupContext } from "./util";
+import { ControlDataContext } from "./util";
 export type UseEvalExpressionHook = (expr: EntityExpression | undefined) => EvalExpressionHook | undefined;
 export declare function useEvalVisibilityHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition, schemaField?: SchemaField): EvalExpressionHook<boolean>;
 export declare function useEvalReadonlyHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition): EvalExpressionHook<boolean>;
+export declare function useEvalStyleHook(useEvalExpressionHook: UseEvalExpressionHook, property: DynamicPropertyType, definition: ControlDefinition): EvalExpressionHook<React.CSSProperties>;
 export declare function useEvalDisabledHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition): EvalExpressionHook<boolean>;
+export declare function useEvalDisplayHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition): (groupContext: ControlDataContext) => Control<string | undefined> | undefined;
 export declare function useEvalDefaultValueHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition, schemaField?: SchemaField): EvalExpressionHook;
-export type EvalExpressionHook<A = any> = (groupContext: ControlGroupContext) => Control<A | undefined>;
-export declare function defaultEvalHooks(expr: EntityExpression, context: ControlGroupContext): Control<any>;
+export type EvalExpressionHook<A = any> = (groupContext: ControlDataContext) => Control<A | undefined>;
+export declare function defaultEvalHooks(expr: EntityExpression, context: ControlDataContext): Control<any>;
 export declare const defaultUseEvalExpressionHook: (expr: EntityExpression | undefined) => EvalExpressionHook | undefined;
-export declare function makeEvalExpressionHook(f: (expr: EntityExpression, context: ControlGroupContext) => Control<any>): (expr: EntityExpression | undefined) => EvalExpressionHook | undefined;
+export declare function makeEvalExpressionHook(f: (expr: EntityExpression, context: ControlDataContext) => Control<any>): (expr: EntityExpression | undefined) => EvalExpressionHook | undefined;
 export declare function useEvalDynamicHook(definition: ControlDefinition, type: DynamicPropertyType, useEvalExpressionHook: (expr: EntityExpression | undefined) => EvalExpressionHook | undefined): EvalExpressionHook | undefined;
-export declare function matchesType(context: ControlGroupContext, types?: string[] | null): boolean | undefined;
+export declare function matchesType(context: ControlDataContext, types?: string[] | null): boolean | undefined;
+export declare function hideDisplayOnly(context: ControlDataContext, field: SchemaField, definition: ControlDefinition, schemaInterface: SchemaInterface): boolean | undefined;
 export declare function useJsonataExpression(jExpr: string, data: Control<any>): Control<any>;

package/lib/index.d.ts

@@ -7,3 +7,4 @@ export * from "./renderers";
 export * from "./tailwind";
 export * from "./validators";
 export * from "./hooks";
+export * from "./schemaInterface";