@react-typed-forms/schemas 11.19.2 → 12.0.0

package/lib/schemaInterface.d.ts

@@ -6,6 +6,7 @@ export declare class DefaultSchemaInterface implements SchemaInterface {
     parseToMillis(field: SchemaField, v: string): number;
     validationMessageText(field: SchemaField, messageType: ValidationMessageType, actual: any, expected: any): string;
     getOptions({ options }: SchemaField): FieldOption[] | null | undefined;
+    getFilterOptions(field: SchemaField): FieldOption[] | undefined | null;
     isEmptyValue(f: SchemaField, value: any): boolean;
     textValue(field: SchemaField, value: any, element?: boolean | undefined): string | undefined;
     controlLength(f: SchemaField, control: Control<any>): number;

package/lib/treeNodes.d.ts

@@ -0,0 +1,45 @@
+import { Control } from "@react-typed-forms/core";
+import { ControlDefinition, SchemaField } from "./types";
+export interface FormNode {
+    definition: ControlDefinition;
+    getChildNodes(): FormNode[];
+    parent?: FormNode;
+}
+export interface FormTreeLookup<A = string> {
+    getForm(formId: A): FormTreeNode | undefined;
+}
+export interface FormTreeNode extends FormTreeLookup {
+    rootNode: FormNode;
+}
+export interface SchemaTreeLookup<A = string> {
+    getSchema(schemaId: A): SchemaNode | undefined;
+}
+export interface SchemaNode extends SchemaTreeLookup {
+    field: SchemaField;
+    getChildNode(field: string): SchemaNode | undefined;
+    getChildNodes(): SchemaNode[];
+    parent?: SchemaNode;
+}
+export interface SchemaDataNode {
+    schema: SchemaNode;
+    elementIndex?: number;
+    control?: Control<unknown>;
+    parent?: SchemaDataNode;
+    getChild(node: SchemaNode): SchemaDataNode;
+    getChildElement(index: number): SchemaDataNode;
+}
+export declare function createSchemaLookup<A extends Record<string, SchemaField[]>>(schemaMap: A): SchemaTreeLookup<keyof A>;
+export declare function createFormLookup<A extends Record<string, ControlDefinition[]>>(formMap: A): FormTreeLookup<keyof A>;
+export declare function makeSchemaDataNode(schema: SchemaNode, control?: Control<unknown>, parent?: SchemaDataNode, elementIndex?: number): SchemaDataNode;
+export declare function fieldPathForDefinition(c: ControlDefinition): string[] | undefined;
+export declare function schemaDataForFieldRef(fieldRef: string | undefined, schema: SchemaDataNode): SchemaDataNode;
+export declare function schemaForFieldRef(fieldRef: string | undefined, schema: SchemaNode): SchemaNode;
+export declare function schemaDataForFieldPath(fieldPath: string[], schema: SchemaDataNode): SchemaDataNode;
+export declare function schemaForFieldPath(fieldPath: string[], schema: SchemaNode): SchemaNode;
+export declare function traverseParents<A, B extends {
+    parent?: B | undefined;
+}>(current: B | undefined, get: (b: B) => A, until?: (b: B) => boolean): A[];
+export declare function getRootDataNode(dataNode: SchemaDataNode): SchemaDataNode;
+export declare function getJsonPath(dataNode: SchemaDataNode): (string | number)[];
+export declare function getSchemaFieldList(schema: SchemaNode): SchemaField[];
+export declare function rootSchemaNode(fields: SchemaField[], lookup?: SchemaTreeLookup): SchemaNode;

package/lib/types.d.ts

@@ -62,6 +62,7 @@ export interface SchemaInterface {
     controlLength(field: SchemaField, control: Control<any>): number;
     valueLength(field: SchemaField, value: any): number;
     getOptions(field: SchemaField): FieldOption[] | undefined | null;
+    getFilterOptions(field: SchemaField): FieldOption[] | undefined | null;
     parseToMillis(field: SchemaField, v: string): number;
     validationMessageText(field: SchemaField, messageType: ValidationMessageType, actual: any, expected: any): string;
 }
@@ -391,3 +392,8 @@ export declare function isDisplayOnlyRenderer(options: RenderOptions): options i
 export declare function isTextfieldRenderer(options: RenderOptions): options is TextfieldRenderOptions;
 export declare function isDataGroupRenderer(options: RenderOptions): options is DataGroupRenderOptions;
 export declare function isArrayRenderer(options: RenderOptions): options is ArrayRenderOptions;
+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 isDataControl(c: ControlDefinition): c is DataControlDefinition;
+export declare function isGroupControl(c: ControlDefinition): c is GroupedControlsDefinition;

package/lib/util.d.ts

@@ -1,6 +1,7 @@
-import { CompoundField, ControlDefinition, DataControlDefinition, DisplayOnlyRenderOptions, FieldOption, GroupedControlsDefinition, SchemaField, SchemaInterface } from "./types";
+import { CompoundField, ControlDefinition, DataControlDefinition, DisplayOnlyRenderOptions, FieldOption, SchemaField, SchemaInterface } from "./types";
 import { MutableRefObject } from "react";
 import { Control } from "@react-typed-forms/core";
+import { SchemaDataNode } from "./treeNodes";
 export type JsonPath = string | number;
 export interface DataContext {
     data: Control<any>;
@@ -9,6 +10,17 @@ export interface DataContext {
 export interface ControlDataContext extends DataContext {
     fields: SchemaField[];
     schemaInterface: SchemaInterface;
+    dataNode: SchemaDataNode | undefined;
+    parentNode: SchemaDataNode;
+}
+export declare class ControlDataContextImpl implements ControlDataContext {
+    schemaInterface: SchemaInterface;
+    dataNode: SchemaDataNode | undefined;
+    parentNode: SchemaDataNode;
+    constructor(schemaInterface: SchemaInterface, dataNode: SchemaDataNode | undefined, parentNode: SchemaDataNode);
+    get fields(): SchemaField[];
+    get data(): Control<unknown>;
+    get path(): (string | number)[];
 }
 export declare function applyDefaultValues(v: Record<string, any> | undefined, fields: SchemaField[], doneSet?: Set<Record<string, any>>): any;
 export declare function applyDefaultForField(v: any, field: SchemaField, parent: SchemaField[], notElement?: boolean, doneSet?: Set<Record<string, any>>): any;
@@ -17,11 +29,6 @@ export declare function defaultValueForField(sf: SchemaField, required?: boolean
 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 isScalarField(sf: SchemaField): sf is SchemaField;
-export declare function isCompoundField(sf: SchemaField): sf is CompoundField;
-export declare function isDataControl(c: ControlDefinition): c is DataControlDefinition;
-export declare function isGroupControl(c: ControlDefinition): c is GroupedControlsDefinition;
 export declare function fieldHasTag(field: SchemaField, tag: string): boolean;
 export declare function fieldDisplayName(field: SchemaField): string;
 export declare function hasOptions(o: {
@@ -41,7 +48,6 @@ export declare function useUpdatedRef<A>(a: A): MutableRefObject<A>;
 export declare function isControlReadonly(c: ControlDefinition): boolean;
 export declare function isControlDisabled(c: ControlDefinition): boolean;
 export declare function getDisplayOnlyOptions(d: ControlDefinition): DisplayOnlyRenderOptions | undefined;
-export declare function getTypeField(context: ControlDataContext, fieldPath: SchemaField[]): Control<string> | undefined;
 export declare function visitControlDataArray<A>(controls: ControlDefinition[] | undefined | null, context: ControlDataContext, cb: (definition: DataControlDefinition, field: SchemaField, control: Control<any>, element: boolean) => A | undefined): A | undefined;
 export declare function visitControlData<A>(definition: ControlDefinition, ctx: ControlDataContext, cb: (definition: DataControlDefinition, field: SchemaField, control: Control<any>, element: boolean) => A | undefined): A | undefined;
 export declare function lookupChildControl(data: DataContext, path: SchemaField[], element?: number): Control<any> | undefined;
@@ -68,7 +74,6 @@ export declare function useDynamicHooks<P, Hooks extends Record<string, DynamicH
     [K in keyof Hooks]: DynamicHookValue<Hooks[K]>;
 };
 export declare function toDepString(x: any): string;
-export declare function appendElementIndex(dataContext: ControlDataContext, elementIndex: number): ControlDataContext;
 export declare function applyLengthRestrictions<Min, Max>(length: number, min: number | null | undefined, max: number | null | undefined, minValue: Min, maxValue: Max): [Min | undefined, Max | undefined];
 export declare function findFieldPath(fields: SchemaField[], fieldPath: string | undefined): SchemaField[] | undefined;
 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;

package/lib/validators.d.ts

@@ -11,7 +11,7 @@ export interface ValidationContext extends ValidationHookContext {
     field: SchemaField;
     index: number;
 }
-export declare function useMakeValidationHook(definition: ControlDefinition, field: SchemaField | undefined, useValidatorFor?: (validator: SchemaValidator, ctx: ValidationContext) => void): (ctx: ValidationHookContext) => void;
+export declare function useMakeValidationHook(definition: ControlDefinition, useValidatorFor?: (validator: SchemaValidator, ctx: ValidationContext) => void): (ctx: ValidationHookContext) => void;
 export declare function useJsonataValidator(validator: JsonataValidator, ctx: ValidationContext): void;
 export declare function useLengthValidator(lv: LengthValidator, ctx: ValidationContext): void;
 export declare function useDateValidator(dv: DateValidator, ctx: ValidationContext): void;

package/package.json

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