@react-typed-forms/schemas 15.1.1 → 15.1.3

package/lib/renderers.d.ts

@@ -12,7 +12,6 @@ export interface DefaultRenderers {
     renderLayout: LayoutRendererRegistration;
     visibility: VisibilityRendererRegistration;
     extraRenderers: RendererRegistration[];
-    renderText: (props: ReactNode) => ReactNode;
     html: HtmlComponents;
 }
 export interface LayoutRendererRegistration {

package/lib/schemaDataNode.d.ts

@@ -0,0 +1,31 @@
+import { Control } from "@react-typed-forms/core";
+import { SchemaNode } from "./schemaNode";
+export declare abstract class SchemaDataTree {
+    abstract rootNode: SchemaDataNode;
+    abstract getChild(parent: SchemaDataNode, child: SchemaNode): SchemaDataNode;
+    abstract getChildElement(parent: SchemaDataNode, elementIndex: number): SchemaDataNode;
+}
+export declare class SchemaDataNode {
+    id: string;
+    schema: SchemaNode;
+    elementIndex: number | undefined;
+    control: Control<any>;
+    tree: SchemaDataTree;
+    parent?: SchemaDataNode | undefined;
+    constructor(id: string, schema: SchemaNode, elementIndex: number | undefined, control: Control<any>, tree: SchemaDataTree, parent?: SchemaDataNode | undefined);
+    getChild(childNode: SchemaNode): SchemaDataNode;
+    getChildElement(elementIndex: number): SchemaDataNode;
+}
+export declare class SchemaDataTreeImpl extends SchemaDataTree {
+    rootNode: SchemaDataNode;
+    constructor(rootSchema: SchemaNode, rootControl: Control<any>);
+    getChild(parent: SchemaDataNode, childNode: SchemaNode): SchemaDataNode;
+    getChildElement(parent: SchemaDataNode, elementIndex: number): SchemaDataNode;
+}
+/**
+ * @deprecated Use createSchemaDataNode instead.
+ */
+export declare const makeSchemaDataNode: typeof createSchemaDataNode;
+export declare function createSchemaDataNode(schema: SchemaNode, control: Control<unknown>): SchemaDataNode;
+export declare function schemaDataForFieldRef(fieldRef: string | undefined, schema: SchemaDataNode): SchemaDataNode;
+export declare function schemaDataForFieldPath(fieldPath: string[], dataNode: SchemaDataNode): SchemaDataNode;

package/lib/schemaField.d.ts

@@ -1,5 +1,4 @@
 import { SchemaValidator } from "./schemaValidator";
-import { Control, ControlSetup } from "@react-typed-forms/core";
 export type EqualityFunc = (a: any, b: any) => boolean;
 /**
  * Represents a schema field with various properties.
@@ -106,141 +105,10 @@ export declare enum ValidationMessageType {
     NotAfterDate = "NotAfterDate",
     NotBeforeDate = "NotBeforeDate"
 }
-/**
- * Interface for schema-related operations.
- */
-export interface SchemaInterface {
-    /**
-     * Checks if the value of a field is empty.
-     * @param field The schema field.
-     * @param value The value to check.
-     * @returns True if the value is empty, false otherwise.
-     */
-    isEmptyValue(field: SchemaField, value: any): boolean;
-    /**
-     * Gets the text representation of a field's value.
-     * @param field The schema field.
-     * @param value The value to convert.
-     * @param element Indicates if the value is an element, optional.
-     * @returns The text representation of the value.
-     */
-    textValue(field: SchemaField, value: any, element?: boolean): string | undefined;
-    /**
-     * Gets the length of a control's value.
-     * @param field The schema field.
-     * @param control The control to check.
-     * @returns The length of the control's value.
-     */
-    controlLength(field: SchemaField, control: Control<any>): number;
-    /**
-     * Gets the length of a field's value.
-     * @param field The schema field.
-     * @param value The value to check.
-     * @returns The length of the value.
-     */
-    valueLength(field: SchemaField, value: any): number;
-    /**
-     * Gets the data options for a schema data node.
-     * @param node The schema data node.
-     * @returns The data options.
-     */
-    getDataOptions(node: SchemaDataNode): FieldOption[] | null | undefined;
-    /**
-     * Gets the node options for a schema node.
-     * @param node The schema node.
-     * @returns The node options.
-     */
-    getNodeOptions(node: SchemaNode): FieldOption[] | null | undefined;
-    /**
-     * Gets the options for a schema field.
-     * @param field The schema field.
-     * @returns The field options.
-     */
-    getOptions(field: SchemaField): FieldOption[] | undefined | null;
-    /**
-     * Gets the filter options for a schema data node and field.
-     * @param array The schema data node.
-     * @param field The schema node.
-     * @returns The filter options.
-     */
-    getFilterOptions(array: SchemaDataNode, field: SchemaNode): FieldOption[] | undefined | null;
-    /**
-     * Parses a string value to milliseconds.
-     * @param field The schema field.
-     * @param v The string value to parse.
-     * @returns The parsed value in milliseconds.
-     */
-    parseToMillis(field: SchemaField, v: string): number;
-    /**
-     * Gets the validation message text for a field.
-     * @param field The schema field.
-     * @param messageType The type of validation message.
-     * @param actual The actual value.
-     * @param expected The expected value.
-     * @returns The validation message text.
-     */
-    validationMessageText(field: SchemaField, messageType: ValidationMessageType, actual: any, expected: any): string;
-    /**
-     * Compares two values of a field.
-     * @param field The schema field.
-     * @param v1 The first value.
-     * @param v2 The second value.
-     * @returns The comparison result.
-     */
-    compareValue(field: SchemaField, v1: unknown, v2: unknown): number;
-    /**
-     * Gets the search text for a field's value.
-     * @param field The schema field.
-     * @param value The value to search.
-     * @returns The search text.
-     */
-    searchText(field: SchemaField, value: any): string;
-    makeEqualityFunc(field: SchemaNode, element?: boolean): EqualityFunc;
-    makeControlSetup(field: SchemaNode, element?: boolean): ControlSetup<any>;
-}
-export interface SchemaTreeLookup {
-    getSchema(schemaId: string): SchemaNode | undefined;
-}
-export interface SchemaNode extends SchemaTreeLookup {
-    id: string;
-    field: SchemaField;
-    getChildNode(field: string): SchemaNode | undefined;
-    getChildNodes(noRecurse?: boolean, withParent?: SchemaNode): SchemaNode[];
-    parent?: SchemaNode;
-}
-export interface SchemaDataNode {
-    id: string;
-    schema: SchemaNode;
-    elementIndex?: number;
-    control: Control<any>;
-    parent?: SchemaDataNode;
-    getChild(schemaNode: SchemaNode): SchemaDataNode;
-    getChildElement(index: number): SchemaDataNode;
-}
 export declare function findField(fields: SchemaField[], field: string): SchemaField | undefined;
 export declare function isScalarField(sf: SchemaField): sf is SchemaField;
 export declare function isCompoundField(sf: SchemaField): sf is CompoundField;
-export declare function createSchemaLookup<A extends Record<string, SchemaField[]>>(schemaMap: A): {
-    getSchema(schemaId: keyof A): SchemaNode;
-};
-export declare function makeSchemaDataNode(schema: SchemaNode, control: Control<unknown>, parent?: SchemaDataNode, elementIndex?: number): SchemaDataNode;
-export declare function schemaDataForFieldRef(fieldRef: string | undefined, schema: SchemaDataNode): SchemaDataNode;
-export declare function schemaForFieldRef(fieldRef: string | undefined, schema: SchemaNode): SchemaNode;
-export declare function traverseSchemaPath<A>(fieldPath: string[], schema: SchemaNode, acc: A, next: (acc: A, node: SchemaNode) => A): A;
-export declare function traverseData(fieldPath: string[], root: SchemaNode, data: {
-    [k: string]: any;
-}): unknown;
-export declare function schemaDataForFieldPath(fieldPath: string[], dataNode: SchemaDataNode): SchemaDataNode;
-export declare function schemaForFieldPath(fieldPath: string[], schema: SchemaNode): SchemaNode;
-export declare function rootSchemaNode(fields: SchemaField[], lookup?: SchemaTreeLookup): SchemaNode;
-export declare function getSchemaNodePath(node: SchemaNode): string[];
-export declare function isCompoundNode(node: SchemaNode): boolean;
-/**
- * Returns the relative path from a parent node to a child node.
- * @param parent
- * @param child
- */
-export declare function relativePath(parent: SchemaNode, child: SchemaNode): string;
+export declare function missingField(field: string): SchemaField;
 export declare enum SchemaTags {
     NoControl = "_NoControl",
     HtmlEditor = "_HtmlEditor",

package/lib/schemaInterface.d.ts

@@ -0,0 +1,102 @@
+import { Control, ControlSetup } from "@react-typed-forms/core";
+import { EqualityFunc, FieldOption, SchemaField, ValidationMessageType } from "./schemaField";
+import { SchemaDataNode } from "./schemaDataNode";
+import { SchemaNode } from "./schemaNode";
+/**
+ * Interface for schema-related operations.
+ */
+export interface SchemaInterface {
+    /**
+     * Checks if the value of a field is empty.
+     * @param field The schema field.
+     * @param value The value to check.
+     * @returns True if the value is empty, false otherwise.
+     */
+    isEmptyValue(field: SchemaField, value: any): boolean;
+    /**
+     * Gets the text representation of a field's value.
+     * @param field The schema field.
+     * @param value The value to convert.
+     * @param element Indicates if the value is an element, optional.
+     * @param options The field options, optional.
+     * @returns The text representation of the value.
+     */
+    textValue(field: SchemaField, value: any, element?: boolean, options?: FieldOption[]): string | undefined;
+    /**
+     * Gets the text representation of a field's value for a data node.
+     * @param dataNode
+     */
+    textValueForData(dataNode: SchemaDataNode): string | undefined;
+    /**
+     * Gets the length of a control's value.
+     * @param field The schema field.
+     * @param control The control to check.
+     * @returns The length of the control's value.
+     */
+    controlLength(field: SchemaField, control: Control<any>): number;
+    /**
+     * Gets the length of a field's value.
+     * @param field The schema field.
+     * @param value The value to check.
+     * @returns The length of the value.
+     */
+    valueLength(field: SchemaField, value: any): number;
+    /**
+     * Gets the data options for a schema data node.
+     * @param node The schema data node.
+     * @returns The data options.
+     */
+    getDataOptions(node: SchemaDataNode): FieldOption[] | null | undefined;
+    /**
+     * Gets the node options for a schema node.
+     * @param node The schema node.
+     * @returns The node options.
+     */
+    getNodeOptions(node: SchemaNode): FieldOption[] | null | undefined;
+    /**
+     * Gets the options for a schema field.
+     * @param field The schema field.
+     * @returns The field options.
+     */
+    getOptions(field: SchemaField): FieldOption[] | undefined | null;
+    /**
+     * Gets the filter options for a schema data node and field.
+     * @param array The schema data node.
+     * @param field The schema node.
+     * @returns The filter options.
+     */
+    getFilterOptions(array: SchemaDataNode, field: SchemaNode): FieldOption[] | undefined | null;
+    /**
+     * Parses a string value to milliseconds.
+     * @param field The schema field.
+     * @param v The string value to parse.
+     * @returns The parsed value in milliseconds.
+     */
+    parseToMillis(field: SchemaField, v: string): number;
+    /**
+     * Gets the validation message text for a field.
+     * @param field The schema field.
+     * @param messageType The type of validation message.
+     * @param actual The actual value.
+     * @param expected The expected value.
+     * @returns The validation message text.
+     */
+    validationMessageText(field: SchemaField, messageType: ValidationMessageType, actual: any, expected: any): string;
+    /**
+     * Compares two values of a field.
+     * @param field The schema field.
+     * @param v1 The first value.
+     * @param v2 The second value.
+     * @returns The comparison result.
+     */
+    compareValue(field: SchemaField, v1: unknown, v2: unknown): number;
+    /**
+     * Gets the search text for a field's value.
+     * @param field The schema field.
+     * @param value The value to search.
+     * @returns The search text.
+     */
+    searchText(field: SchemaField, value: any): string;
+    makeEqualityFunc(field: SchemaNode, element?: boolean): EqualityFunc;
+    makeControlSetup(field: SchemaNode, element?: boolean): ControlSetup<any>;
+}

package/lib/schemaNode.d.ts

@@ -0,0 +1,54 @@
+import { SchemaField } from "./schemaField";
+export interface SchemaTreeLookup {
+    getSchema(schemaId: string): SchemaNode | undefined;
+    getSchemaTree(schemaId: string): SchemaTree | undefined;
+}
+export declare abstract class SchemaTree {
+    abstract rootNode: SchemaNode;
+    abstract getSchemaTree(schemaId: string): SchemaTree | undefined;
+    createChildNode(parent: SchemaNode, field: SchemaField): SchemaNode;
+    getSchema(schemaId: string): SchemaNode | undefined;
+}
+export declare function createSchemaTree(rootFields: SchemaField[], lookup?: SchemaTreeLookup): SchemaTree;
+export declare class SchemaNode {
+    id: string;
+    field: SchemaField;
+    tree: SchemaTree;
+    parent?: SchemaNode | undefined;
+    constructor(id: string, field: SchemaField, tree: SchemaTree, parent?: SchemaNode | undefined);
+    getSchema(schemaId: string): SchemaNode | undefined;
+    getUnresolvedFields(): SchemaField[];
+    getResolvedParent(): SchemaNode | undefined;
+    getResolvedFields(): SchemaField[];
+    getChildNodes(): SchemaNode[];
+    getChildField(field: string): SchemaField;
+    createChildNode(field: SchemaField): SchemaNode;
+    getChildNode(field: string): SchemaNode;
+}
+export declare function resolveSchemaNode(node: SchemaNode, fieldSegment: string): SchemaNode | undefined;
+export declare function createSchemaNode(field: SchemaField, lookup: SchemaTree, parent: SchemaNode | undefined): SchemaNode;
+export declare function createSchemaLookup<A extends Record<string, SchemaField[]>>(schemaMap: A): {
+    getSchema(schemaId: keyof A): SchemaNode;
+    getSchemaTree(schemaId: keyof A): SchemaTree;
+};
+export declare function schemaForFieldRef(fieldRef: string | undefined, schema: SchemaNode): SchemaNode;
+export declare function traverseSchemaPath<A>(fieldPath: string[], schema: SchemaNode, acc: A, next: (acc: A, node: SchemaNode) => A): A;
+export declare function traverseData(fieldPath: string[], root: SchemaNode, data: {
+    [k: string]: any;
+}): unknown;
+export declare function schemaForFieldPath(fieldPath: string[], schema: SchemaNode): SchemaNode;
+export declare function getSchemaNodePath(node: SchemaNode): string[];
+export declare function getSchemaNodePathString(node: SchemaNode): string;
+export declare function isCompoundNode(node: SchemaNode): boolean;
+/**
+ * Returns the relative path from a parent node to a child node.
+ * @param parent
+ * @param child
+ */
+export declare function relativePath(parent: SchemaNode, child: SchemaNode): string;
+/**
+ * Returns the relative path from a parent node to a child node.
+ * @param parentPath
+ * @param childPath
+ */
+export declare function relativeSegmentPath(parentPath: string[], childPath: string[]): string;

package/lib/util.d.ts

@@ -1,8 +1,11 @@
-import { ControlActionHandler, ControlDataVisitor, ControlDefinition, DataControlDefinition, DisplayOnlyRenderOptions, FormTree, GroupRenderOptions } from "./controlDefinition";
+import { ControlActionHandler, ControlDefinition, DataControlDefinition, DisplayOnlyRenderOptions, GroupRenderOptions } from "./controlDefinition";
 import { MutableRefObject } from "react";
-import { CompoundField, FieldOption, SchemaDataNode, SchemaField, SchemaNode } from "./schemaField";
+import { CompoundField, FieldOption, SchemaField } from "./schemaField";
 import { Control } from "@react-typed-forms/core";
 import { ActionRendererProps } from "./controlRender";
+import { ControlDataVisitor } from "./formNode";
+import { SchemaDataNode } from "./schemaDataNode";
+import { SchemaNode } from "./schemaNode";
 /**
  * Interface representing the classes for a control.
  */
@@ -10,6 +13,8 @@ export interface ControlClasses {
     styleClass?: string;
     layoutClass?: string;
     labelClass?: string;
+    textClass?: string;
+    labelTextClass?: string;
 }
 /**
  * Type representing a JSON path, which can be a string or a number.
@@ -117,13 +122,6 @@ export declare function addMissingControls(fields: SchemaField[], controls: Cont
  * @returns The control definitions with missing controls added.
  */
 export declare function addMissingControlsForSchema(schema: SchemaNode, controls: ControlDefinition[], warning?: (msg: string) => void): ControlDefinition[];
-/**
- * Adds missing controls to the provided form tree based on the schema fields.
- * @param schema - The root schema node to use for adding missing controls.
- * @param tree - The form tree to add missing controls to.
- * @param warning - An optional function to call with warning messages.
- */
-export declare function addMissingControlsToForm(schema: SchemaNode, tree: FormTree, warning?: (msg: string) => void): void;
 /**
  * Custom hook to use an updated reference.
  * @param a - The value to create a reference for.
@@ -151,13 +149,13 @@ export declare function getDisplayOnlyOptions(d: ControlDefinition): DisplayOnly
 /**
  * Cleans data for a schema based on the provided schema fields.
  * @param v - The data to clean.
- * @param fields - The schema fields to use for cleaning the data.
+ * @param schemaNode
  * @param removeIfDefault - Flag indicating if default values should be removed.
  * @returns The cleaned data.
  */
 export declare function cleanDataForSchema(v: {
     [k: string]: any;
-} | undefined, fields: SchemaField[], removeIfDefault?: boolean): any;
+} | undefined, schemaNode: SchemaNode, removeIfDefault?: boolean): any;
 /**
  * Returns all referenced classes for a control definition.
  * @param c - The control definition to get the referenced classes for.
@@ -224,6 +222,7 @@ export declare function findFieldPath(fields: SchemaField[], fieldPath: string |
  * @returns {A} - The merged object.
  */
 export declare function mergeObjects<A extends Record<string, any> | undefined>(o1: A, o2: A, doMerge?: (k: keyof NonNullable<A>, v1: unknown, v2: unknown) => unknown): A;
+export declare function deepMerge<A>(value: A, fallback: A): A;
 /**
  * Coerces a value to a string.
  * @param {unknown} v - The value to coerce.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-typed-forms/schemas",
-  "version": "15.1.1",
+  "version": "15.1.3",
   "description": "",
   "type": "module",
   "main": "lib/index.cjs",

package/src/controlBuilder.ts

@@ -32,7 +32,7 @@ import {
   LengthValidator,
   ValidatorType,
 } from "./schemaValidator";
-import { SchemaField, SchemaMap, SchemaNode } from "./schemaField";
+import { SchemaField, SchemaMap } from "./schemaField";
 import {
   DataExpression,
   DataMatchExpression,
@@ -40,6 +40,7 @@ import {
   ExpressionType,
   JsonataExpression,
 } from "./entityExpression";
+import { SchemaNode } from "./schemaNode";
 
 export function dataControl(
   field: string,
@@ -203,7 +204,12 @@ export function createAction(
   actionText?: string,
   options?: Partial<ActionRendererProps>,
 ): ActionRendererProps {
-  return { actionId, onClick, actionText: actionText ?? actionId, ...options };
+  return {
+    actionId,
+    onClick,
+    actionText: actionText ?? actionId,
+    ...options,
+  };
 }
 
 export const emptyGroupDefinition: GroupedControlsDefinition = {