@react-typed-forms/schemas 8.2.0 → 9.1.0

package/lib/controlBuilder.d.ts

@@ -1,4 +1,4 @@
-import { ControlDefinition, DataControlDefinition, DataMatchExpression, DisplayControlDefinition, DynamicProperty, EntityExpression, GroupedControlsDefinition, JsonataExpression, SchemaField } from "./types";
+import { ControlDefinition, DataControlDefinition, DataMatchExpression, DisplayControlDefinition, DynamicProperty, EntityExpression, GroupedControlsDefinition, JsonataExpression, SchemaField, SchemaMap } 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;
@@ -19,4 +19,12 @@ export interface CustomRenderOptions {
     name: string;
     fields: SchemaField[];
 }
-export declare function addCustomDataRenderOptions(controlFields: SchemaField[], customRenderOptions: CustomRenderOptions[]): SchemaField[];
+export type ControlDefinitionExtension = {
+    RenderOptions?: CustomRenderOptions | CustomRenderOptions[];
+    GroupRenderOptions?: CustomRenderOptions | CustomRenderOptions[];
+    ControlAdornment?: CustomRenderOptions | CustomRenderOptions[];
+    SchemaValidator?: CustomRenderOptions | CustomRenderOptions[];
+    DisplayData?: CustomRenderOptions | CustomRenderOptions[];
+};
+export declare function applyExtensionToSchema<A extends SchemaMap>(schemaMap: A, extension: ControlDefinitionExtension): A;
+export declare function applyExtensionsToSchema<A extends SchemaMap>(schemaMap: A, extensions: ControlDefinitionExtension[]): A;

package/lib/controlRender.d.ts

@@ -2,7 +2,7 @@ import React, { CSSProperties, FC, Key, ReactNode } from "react";
 import { Control } from "@react-typed-forms/core";
 import { AdornmentPlacement, ControlAdornment, ControlDefinition, DataControlDefinition, DisplayData, FieldOption, GroupRenderOptions, RenderOptions, SchemaField, SchemaInterface } from "./types";
 import { ControlDataContext } from "./util";
-import { UseEvalExpressionHook } from "./hooks";
+import { EvalExpressionHook, UseEvalExpressionHook } from "./hooks";
 export interface FormRenderer {
     renderData: (props: DataRendererProps) => (layout: ControlLayoutProps) => ControlLayoutProps;
     renderGroup: (props: GroupRendererProps) => (layout: ControlLayoutProps) => ControlLayoutProps;
@@ -83,17 +83,22 @@ export interface LabelRendererProps {
 export interface DisplayRendererProps {
     data: DisplayData;
     display?: Control<string | undefined>;
+    dataContext: ControlDataContext;
     className?: string;
     style?: React.CSSProperties;
 }
-export interface GroupRendererProps {
-    children: ControlDefinition[];
-    renderOptions: GroupRenderOptions;
+export interface ParentRendererProps {
+    childDefinitions: ControlDefinition[];
     renderChild: ChildRenderer;
     className?: string;
     style?: React.CSSProperties;
+    dataContext: ControlDataContext;
+    useChildVisibility: (child: number | number[]) => EvalExpressionHook<boolean>;
+}
+export interface GroupRendererProps extends ParentRendererProps {
+    renderOptions: GroupRenderOptions;
 }
-export interface DataRendererProps {
+export interface DataRendererProps extends ParentRendererProps {
     renderOptions: RenderOptions;
     field: SchemaField;
     id: string;
@@ -102,11 +107,6 @@ export interface DataRendererProps {
     required: boolean;
     options: FieldOption[] | undefined | null;
     hidden: boolean;
-    className?: string;
-    style?: React.CSSProperties;
-    dataContext: ControlDataContext;
-    children: ControlDefinition[];
-    renderChild: ChildRenderer;
     toArrayProps?: () => ArrayRendererProps;
 }
 export interface ActionRendererProps {
@@ -135,6 +135,7 @@ export interface DataControlProps {
     renderChild: ChildRenderer;
     allowedOptions?: Control<any[] | undefined>;
     elementRenderer?: (elemIndex: number) => ReactNode;
+    useChildVisibility: (child: number | number[]) => EvalExpressionHook<boolean>;
 }
 export type CreateDataProps = (controlProps: DataControlProps) => DataRendererProps;
 export type JsonPath = string | number;
@@ -175,8 +176,9 @@ export interface RenderControlProps {
     displayControl?: Control<string | undefined>;
     style?: React.CSSProperties;
     allowedOptions?: Control<any[] | undefined>;
+    useChildVisibility: (child: number | number[]) => EvalExpressionHook<boolean>;
 }
-export declare function renderControlLayout({ definition: c, renderer, renderChild: childRenderer, control: childControl, schemaField, dataContext, formOptions: dataOptions, createDataProps: dataProps, displayControl, style, labelText, allowedOptions, }: RenderControlProps): ControlLayoutProps;
+export declare function renderControlLayout({ definition: c, renderer, renderChild: childRenderer, control: childControl, schemaField, dataContext, formOptions: dataOptions, createDataProps: dataProps, displayControl, style, labelText, allowedOptions, useChildVisibility, }: 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">;

package/lib/hooks.d.ts

@@ -1,21 +1,21 @@
-/// <reference types="react" />
 import { ControlDefinition, DynamicPropertyType, EntityExpression, SchemaField, SchemaInterface } from "./types";
+import React from "react";
 import { Control } from "@react-typed-forms/core";
-import { ControlDataContext } from "./util";
+import { ControlDataContext, DynamicHookGenerator } from "./util";
 import { DataContext } from "./controlRender";
-export type UseEvalExpressionHook = (expr: EntityExpression | undefined) => EvalExpressionHook | undefined;
+export type EvalExpressionHook<A = any> = DynamicHookGenerator<Control<A | undefined>, ControlDataContext>;
+export type UseEvalExpressionHook = (expr: EntityExpression | undefined) => DynamicHookGenerator<Control<any> | undefined, ControlDataContext>;
 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 useEvalAllowedOptionsHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition): EvalExpressionHook<any[]>;
 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 useEvalDisplayHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition): DynamicHookGenerator<Control<string | undefined> | undefined, ControlDataContext>;
 export declare function useEvalDefaultValueHook(useEvalExpressionHook: UseEvalExpressionHook, definition: ControlDefinition, schemaField?: SchemaField): EvalExpressionHook;
-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: 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 const defaultUseEvalExpressionHook: UseEvalExpressionHook;
+export declare function makeEvalExpressionHook(f: (expr: EntityExpression, context: ControlDataContext) => Control<any>): UseEvalExpressionHook;
+export declare function useEvalDynamicHook(definition: ControlDefinition, type: DynamicPropertyType, useEvalExpressionHook: UseEvalExpressionHook): DynamicHookGenerator<Control<any> | undefined, ControlDataContext>;
 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, dataContext: DataContext, bindings?: () => Record<string, any>): Control<any>;