@react-typed-forms/schemas 1.0.0-dev.3 → 1.0.0-dev.5

package/.rush/temp/package-deps_build.json

@@ -1,12 +1,12 @@
 {
   "files": {
     "packages/schemas/.rush/temp/shrinkwrap-deps.json": "5ce6417fae765db5c61e400f851ecafe0ce756f0",
-    "packages/schemas/package.json": "38baed2ed08306a8db8dbeb4649adb4f294fe615",
-    "packages/schemas/src/controlRender.tsx": "340cfc1f2fedb77b3e456c2cf8bf50f40b808c36",
-    "packages/schemas/src/hooks.ts": "982c0ee0c7749fc3c58f01ac8c44b8174f898861",
-    "packages/schemas/src/index.ts": "b15fbb6de132cd912cf8141d5c4d2329e947546e",
+    "packages/schemas/package.json": "5202ff608c6285e7e95527d5d9fe442452e8a227",
+    "packages/schemas/src/controlRender.tsx": "3a1df1f3ade46594dbc15bca1228dc0d57e55da0",
+    "packages/schemas/src/hooks.ts": "4eb4946f7b1c685e0b51cd011b4d39a1fdd6aa2e",
+    "packages/schemas/src/index.ts": "67f656f1d7f717bce7e933b9f4d7dc5dc50274dc",
     "packages/schemas/src/schemaBuilder.ts": "bfe74d3fb1cc2a4d5226051a58e025e107c32b11",
-    "packages/schemas/src/types.ts": "2ff2a346d753da0eca2fe4acbe1b709f72034e5c",
+    "packages/schemas/src/types.ts": "69013139f9905b1c995c88b0cd58bba71ccc85d6",
     "packages/schemas/tsconfig.json": "52e4f044fa580f4e0ad5830f3cfca574e2788372"
   },
   "arguments": "rimraf ./lib/ && tsc "

package/lib/controlRender.d.ts

@@ -1,4 +1,4 @@
-import { ActionControlDefinition, AnyControlDefinition, CompoundField, ControlDefinition, DataControlDefinition, DisplayControlDefinition, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
+import { ActionControlDefinition, CompoundField, ControlDefinition, DataControlDefinition, DisplayControlDefinition, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
 import React, { Key, ReactElement } from "react";
 import { Control } from "@react-typed-forms/core";
 export interface FormEditHooks {
@@ -13,7 +13,7 @@ export interface DataControlProperties {
     readonly: boolean;
     defaultValue: any;
     required: boolean;
-    options: FieldOption[] | undefined;
+    options: FieldOption[] | undefined | null;
     customRender?: (props: DataRendererProps) => ReactElement;
 }
 export interface GroupControlProperties {
@@ -87,10 +87,9 @@ 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 fieldDisplayName(sf: SchemaField): string;
-export declare function controlTitle(title: string | undefined, field: SchemaField): string;
-export declare function renderControl(definition: AnyControlDefinition, formState: FormEditState, hooks: FormEditHooks, key: Key, wrapChild?: (key: Key, db: ReactElement) => ReactElement): ReactElement;
+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 | undefined;
+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/controlRender.js

@@ -23,10 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isGroupControl = exports.isDataControl = exports.fieldForControl = exports.controlForField = exports.renderControl = exports.controlTitle = exports.fieldDisplayName = exports.findField = exports.findCompoundField = exports.findScalarField = exports.elementValueForField = exports.defaultValueForField = exports.defaultValueForFields = exports.applyDefaultForField = exports.applyDefaultValues = exports.isCompoundField = exports.isScalarField = exports.useFormRendererComponents = exports.FormRendererComponentsContext = void 0;
+exports.isGroupControl = exports.isDataControl = exports.fieldForControl = exports.controlForField = exports.renderControl = exports.controlTitle = exports.findField = exports.findCompoundField = exports.findScalarField = exports.elementValueForField = exports.defaultValueForField = exports.defaultValueForFields = exports.applyDefaultForField = exports.applyDefaultValues = exports.isCompoundField = exports.isScalarField = exports.useFormRendererComponents = exports.FormRendererComponentsContext = void 0;
 const types_1 = require("./types");
 const react_1 = __importStar(require("react"));
 const core_1 = require("@react-typed-forms/core");
+const index_1 = require("./index");
 exports.FormRendererComponentsContext = (0, react_1.createContext)(undefined);
 function useFormRendererComponents() {
     const c = (0, react_1.useContext)(exports.FormRendererComponentsContext);
@@ -109,36 +110,27 @@ function findField(fields, field) {
     return fields.find((x) => x.field === field);
 }
 exports.findField = findField;
-function fieldDisplayName(sf) {
-    return sf.displayName ? sf.displayName : sf.field;
-}
-exports.fieldDisplayName = fieldDisplayName;
 function controlTitle(title, field) {
-    return title ? title : fieldDisplayName(field);
+    return title ? title : (0, index_1.fieldDisplayName)(field);
 }
 exports.controlTitle = controlTitle;
 function renderControl(definition, formState, hooks, key, wrapChild) {
     const { fields } = formState;
-    switch (definition.type) {
-        case types_1.ControlDefinitionType.Data:
-            const def = definition;
+    return (0, types_1.visitControlDefinition)(definition, {
+        data: (def) => {
             const fieldData = findScalarField(fields, def.field);
             if (!fieldData)
                 return react_1.default.createElement("h1", null,
                     "No schema field for: ",
                     def.field);
             return (react_1.default.createElement(DataRenderer, { key: key, wrapElem: wrapElem, formState: formState, hooks: hooks, controlDef: def, fieldData: fieldData }));
-        case types_1.ControlDefinitionType.Group:
-            return (react_1.default.createElement(GroupRenderer, { key: key, hooks: hooks, groupDef: definition, formState: formState, wrapElem: wrapElem }));
-        case types_1.ControlDefinitionType.Display:
-            return (react_1.default.createElement(DisplayRenderer, { key: key, hooks: hooks, formState: formState, wrapElem: wrapElem, displayDef: definition }));
-        case types_1.ControlDefinitionType.Action:
-            return (react_1.default.createElement(ActionRenderer, { key: key, hooks: hooks, formState: formState, wrapElem: wrapElem, actionDef: definition }));
-        default:
-            return react_1.default.createElement("h1", null,
-                "Unknown control: ",
-                definition.type);
-    }
+        },
+        group: (d) => (react_1.default.createElement(GroupRenderer, { key: key, hooks: hooks, groupDef: d, formState: formState, wrapElem: wrapElem })),
+        action: (d) => (react_1.default.createElement(ActionRenderer, { key: key, hooks: hooks, formState: formState, wrapElem: wrapElem, actionDef: d })),
+        display: (d) => (react_1.default.createElement(DisplayRenderer, { key: key, hooks: hooks, formState: formState, wrapElem: wrapElem, displayDef: d })),
+    }, () => react_1.default.createElement("h1", null,
+        "Unknown control: ",
+        definition.type));
     function wrapElem(e) {
         var _a;
         return (_a = wrapChild === null || wrapChild === void 0 ? void 0 : wrapChild(key, e)) !== null && _a !== void 0 ? _a : e;

package/lib/hooks.d.ts

@@ -5,6 +5,6 @@ export type ExpressionHook = (expr: EntityExpression, formState: FormEditState)
 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;
+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,4 +1,7 @@
+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;

package/lib/index.js

@@ -14,7 +14,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.fieldDisplayName = exports.fieldHasTag = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./schemaBuilder"), exports);
 __exportStar(require("./controlRender"), exports);
 __exportStar(require("./hooks"), exports);
+function fieldHasTag(field, tag) {
+    var _a;
+    return Boolean((_a = field.tags) === null || _a === void 0 ? void 0 : _a.includes(tag));
+}
+exports.fieldHasTag = fieldHasTag;
+function fieldDisplayName(field) {
+    var _a;
+    return (_a = field.displayName) !== null && _a !== void 0 ? _a : field.field;
+}
+exports.fieldDisplayName = fieldDisplayName;

package/lib/schemaBuilder.d.ts

@@ -18,17 +18,17 @@ export declare function buildSchema<T>(def: {
 }): SchemaField[];
 export declare function stringField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
     field?: string | undefined;
-    displayName: string;
-    tags?: string[] | undefined;
-    system?: boolean | undefined;
-    collection?: boolean | undefined;
-    onlyForTypes?: string[] | undefined;
-    required?: boolean | undefined;
+    displayName: string | null;
+    tags?: string[] | null | undefined;
+    system?: boolean | null | undefined;
+    collection?: boolean | null | undefined;
+    onlyForTypes?: string[] | null | undefined;
+    required?: boolean | null | undefined;
     defaultValue?: any;
-    isTypeField?: boolean | undefined;
-    searchable?: boolean | undefined;
-    options?: FieldOption[] | undefined;
-    restrictions?: import("./types").SchemaRestrictions | undefined;
+    isTypeField?: boolean | null | undefined;
+    searchable?: boolean | null | undefined;
+    options?: FieldOption[] | null | undefined;
+    restrictions?: import("./types").SchemaRestrictions | null | undefined;
     type: FieldType.String;
 };
 export declare function stringOptionsField(displayName: string, ...options: FieldOption[]): (name: string) => SchemaField & {
@@ -43,32 +43,32 @@ export declare function makeCompoundField<S extends Partial<CompoundField>>(opti
 } & S;
 export declare function intField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
     field?: string | undefined;
-    displayName: string;
-    tags?: string[] | undefined;
-    system?: boolean | undefined;
-    collection?: boolean | undefined;
-    onlyForTypes?: string[] | undefined;
-    required?: boolean | undefined;
+    displayName: string | null;
+    tags?: string[] | null | undefined;
+    system?: boolean | null | undefined;
+    collection?: boolean | null | undefined;
+    onlyForTypes?: string[] | null | undefined;
+    required?: boolean | null | undefined;
     defaultValue?: any;
-    isTypeField?: boolean | undefined;
-    searchable?: boolean | undefined;
-    options?: FieldOption[] | undefined;
-    restrictions?: import("./types").SchemaRestrictions | undefined;
+    isTypeField?: boolean | null | undefined;
+    searchable?: boolean | null | undefined;
+    options?: FieldOption[] | null | undefined;
+    restrictions?: import("./types").SchemaRestrictions | null | undefined;
     type: FieldType.Int;
 };
 export declare function boolField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
     field?: string | undefined;
-    displayName: string;
-    tags?: string[] | undefined;
-    system?: boolean | undefined;
-    collection?: boolean | undefined;
-    onlyForTypes?: string[] | undefined;
-    required?: boolean | undefined;
+    displayName: string | null;
+    tags?: string[] | null | undefined;
+    system?: boolean | null | undefined;
+    collection?: boolean | null | undefined;
+    onlyForTypes?: string[] | null | undefined;
+    required?: boolean | null | undefined;
     defaultValue?: any;
-    isTypeField?: boolean | undefined;
-    searchable?: boolean | undefined;
-    options?: FieldOption[] | undefined;
-    restrictions?: import("./types").SchemaRestrictions | undefined;
+    isTypeField?: boolean | null | undefined;
+    searchable?: boolean | null | undefined;
+    options?: FieldOption[] | null | undefined;
+    restrictions?: import("./types").SchemaRestrictions | null | undefined;
     type: FieldType.Bool;
 };
 export declare function compoundField<Other extends Partial<Omit<CompoundField, "type" | "schemaType">>>(displayName: string, fields: SchemaField[], other: Other): (name: string) => CompoundField & {

package/lib/types.d.ts

@@ -1,20 +1,20 @@
 export interface SchemaField {
     type: string;
     field: string;
-    displayName?: string;
-    tags?: string[];
-    system?: boolean;
-    collection?: boolean;
-    onlyForTypes?: string[];
-    required?: boolean;
+    displayName?: string | null;
+    tags?: string[] | null;
+    system?: boolean | null;
+    collection?: boolean | null;
+    onlyForTypes?: string[] | null;
+    required?: boolean | null;
     defaultValue?: any;
-    isTypeField?: boolean;
-    searchable?: boolean;
-    options?: FieldOption[];
+    isTypeField?: boolean | null;
+    searchable?: boolean | null;
+    options?: FieldOption[] | null;
     /**
      * @deprecated Use options directly
      */
-    restrictions?: SchemaRestrictions | undefined;
+    restrictions?: SchemaRestrictions | undefined | null;
 }
 export declare enum FieldType {
     String = "String",
@@ -34,7 +34,7 @@ export interface EntityRefField extends SchemaField {
     parentField: string;
 }
 export interface SchemaRestrictions {
-    options: FieldOption[] | undefined;
+    options?: FieldOption[] | null;
 }
 export interface FieldOption {
     name: string;
@@ -48,9 +48,9 @@ export interface CompoundField extends SchemaField {
 export type AnyControlDefinition = DataControlDefinition | GroupedControlsDefinition | ActionControlDefinition | DisplayControlDefinition;
 export interface ControlDefinition {
     type: string;
-    title?: string;
-    dynamic?: DynamicProperty[];
-    adornments?: ControlAdornment[];
+    title?: string | null;
+    dynamic?: DynamicProperty[] | null;
+    adornments?: ControlAdornment[] | null;
 }
 export declare enum ControlDefinitionType {
     Data = "Data",
@@ -101,10 +101,10 @@ export interface AccordionAdornment extends ControlAdornment {
 export interface DataControlDefinition extends ControlDefinition {
     type: ControlDefinitionType.Data;
     field: string;
-    required?: boolean;
-    renderOptions?: RenderOptions;
+    required?: boolean | null;
+    renderOptions?: RenderOptions | null;
     defaultValue?: any;
-    readonly?: boolean;
+    readonly?: boolean | null;
 }
 export interface RenderOptions {
     type: string;
@@ -128,14 +128,14 @@ export interface HtmlEditorRenderOptions extends RenderOptions {
     allowImages: boolean;
 }
 export interface DateTimeRenderOptions extends RenderOptions {
-    format?: string;
+    format?: string | null;
 }
 export interface IconListRenderOptions extends RenderOptions {
     iconMappings: IconMapping[];
 }
 export interface IconMapping {
     value: string;
-    materialIcon: string | undefined;
+    materialIcon?: string | null;
 }
 export interface CheckListRenderOptions extends RenderOptions {
 }
@@ -156,13 +156,13 @@ export interface IconSelectionRenderOptions extends RenderOptions {
 }
 export interface GroupedControlsDefinition extends ControlDefinition {
     type: ControlDefinitionType.Group;
-    children: AnyControlDefinition[];
-    compoundField?: string;
+    children: ControlDefinition[];
+    compoundField?: string | null;
     groupOptions: GroupRenderOptions;
 }
 export interface GroupRenderOptions {
     type: GroupRenderType;
-    hideTitle?: boolean;
+    hideTitle?: boolean | null;
 }
 export declare enum GroupRenderType {
     Standard = "Standard",
@@ -175,7 +175,7 @@ export interface GroupElementRenderer extends GroupRenderOptions {
     value: any;
 }
 export interface GridRenderer extends GroupRenderOptions {
-    columns: number | undefined;
+    columns?: number | null;
 }
 export interface DisplayControlDefinition extends ControlDefinition {
     type: ControlDefinitionType.Display;
@@ -198,3 +198,14 @@ export interface ActionControlDefinition extends ControlDefinition {
     type: ControlDefinitionType.Action;
     actionId: string;
 }
+export declare function isDataControlDefinition(x: ControlDefinition): x is DataControlDefinition;
+export declare function isGroupControlsDefinition(x: ControlDefinition): x is GroupedControlsDefinition;
+export declare function isDisplayControlsDefinition(x: ControlDefinition): x is DisplayControlDefinition;
+export declare function isActionControlsDefinition(x: ControlDefinition): x is ActionControlDefinition;
+export interface ControlVisitor<A> {
+    data(d: DataControlDefinition): A;
+    group(d: GroupedControlsDefinition): A;
+    display(d: DisplayControlDefinition): A;
+    action(d: ActionControlDefinition): A;
+}
+export declare function visitControlDefinition<A>(x: ControlDefinition, visitor: ControlVisitor<A>, defaultValue: (c: ControlDefinition) => A): A;

package/lib/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DisplayDataType = exports.GroupRenderType = exports.SyncTextType = exports.DataRenderType = exports.ControlAdornmentType = exports.ExpressionType = exports.DynamicPropertyType = exports.ControlDefinitionType = exports.FieldType = void 0;
+exports.visitControlDefinition = exports.isActionControlsDefinition = exports.isDisplayControlsDefinition = exports.isGroupControlsDefinition = exports.isDataControlDefinition = exports.DisplayDataType = exports.GroupRenderType = exports.SyncTextType = exports.DataRenderType = exports.ControlAdornmentType = exports.ExpressionType = exports.DynamicPropertyType = exports.ControlDefinitionType = exports.FieldType = void 0;
 var FieldType;
 (function (FieldType) {
     FieldType["String"] = "String";
@@ -66,3 +66,34 @@ var DisplayDataType;
     DisplayDataType["Text"] = "Text";
     DisplayDataType["Html"] = "Html";
 })(DisplayDataType = exports.DisplayDataType || (exports.DisplayDataType = {}));
+function isDataControlDefinition(x) {
+    return x.type === ControlDefinitionType.Data;
+}
+exports.isDataControlDefinition = isDataControlDefinition;
+function isGroupControlsDefinition(x) {
+    return x.type === ControlDefinitionType.Group;
+}
+exports.isGroupControlsDefinition = isGroupControlsDefinition;
+function isDisplayControlsDefinition(x) {
+    return x.type === ControlDefinitionType.Display;
+}
+exports.isDisplayControlsDefinition = isDisplayControlsDefinition;
+function isActionControlsDefinition(x) {
+    return x.type === ControlDefinitionType.Action;
+}
+exports.isActionControlsDefinition = isActionControlsDefinition;
+function visitControlDefinition(x, visitor, defaultValue) {
+    switch (x.type) {
+        case ControlDefinitionType.Action:
+            return visitor.action(x);
+        case ControlDefinitionType.Data:
+            return visitor.data(x);
+        case ControlDefinitionType.Display:
+            return visitor.display(x);
+        case ControlDefinitionType.Group:
+            return visitor.group(x);
+        default:
+            return defaultValue(x);
+    }
+}
+exports.visitControlDefinition = visitControlDefinition;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@react-typed-forms/schemas",
-	"version": "1.0.0-dev.3",
+	"version": "1.0.0-dev.5",
 	"description": "",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
@@ -24,7 +24,7 @@
 		"material-ui"
 	],
 	"dependencies": {
-		"@react-typed-forms/core": "3.0.0-dev.101"
+		"@react-typed-forms/core": "3.0.0-dev.102"
 	},
 	"devDependencies": {
 		"@types/react": "^18.0.22",

package/schemas.build.log

@@ -1,2 +0,0 @@
-Invoking: rimraf ./lib/ && tsc 
-

package/src/controlRender.tsx

@@ -10,9 +10,11 @@ import {
   FieldType,
   GroupedControlsDefinition,
   SchemaField,
+  visitControlDefinition,
 } from "./types";
 import React, { createContext, Key, ReactElement, useContext } from "react";
-import { Control, newControl, useControlEffect } from "@react-typed-forms/core";
+import { Control, newControl } from "@react-typed-forms/core";
+import { fieldDisplayName } from "./index";
 
 export interface FormEditHooks {
   useDataProperties(
@@ -41,7 +43,7 @@ export interface DataControlProperties {
   readonly: boolean;
   defaultValue: any;
   required: boolean;
-  options: FieldOption[] | undefined;
+  options: FieldOption[] | undefined | null;
   customRender?: (props: DataRendererProps) => ReactElement;
 }
 
@@ -233,71 +235,68 @@ export function findField(
 ): SchemaField | undefined {
   return fields.find((x) => x.field === field);
 }
-
-export function fieldDisplayName(sf: SchemaField): string {
-  return sf.displayName ? sf.displayName : sf.field;
-}
-
-export function controlTitle(title: string | undefined, field: SchemaField) {
+export function controlTitle(
+  title: string | undefined | null,
+  field: SchemaField
+) {
   return title ? title : fieldDisplayName(field);
 }
 
-export function renderControl(
-  definition: AnyControlDefinition,
+export function renderControl<S extends ControlDefinition>(
+  definition: S,
   formState: FormEditState,
   hooks: FormEditHooks,
   key: Key,
   wrapChild?: (key: Key, db: ReactElement) => ReactElement
 ): ReactElement {
   const { fields } = formState;
-  switch (definition.type) {
-    case ControlDefinitionType.Data:
-      const def = definition as DataControlDefinition;
-      const fieldData = findScalarField(fields, def.field);
-      if (!fieldData) return <h1>No schema field for: {def.field}</h1>;
-      return (
-        <DataRenderer
-          key={key}
-          wrapElem={wrapElem}
-          formState={formState}
-          hooks={hooks}
-          controlDef={def}
-          fieldData={fieldData}
-        />
-      );
-    case ControlDefinitionType.Group:
-      return (
+  return visitControlDefinition(
+    definition,
+    {
+      data: (def) => {
+        const fieldData = findScalarField(fields, def.field);
+        if (!fieldData) return <h1>No schema field for: {def.field}</h1>;
+        return (
+          <DataRenderer
+            key={key}
+            wrapElem={wrapElem}
+            formState={formState}
+            hooks={hooks}
+            controlDef={def}
+            fieldData={fieldData}
+          />
+        );
+      },
+      group: (d: GroupedControlsDefinition) => (
         <GroupRenderer
           key={key}
           hooks={hooks}
-          groupDef={definition as GroupedControlsDefinition}
+          groupDef={d}
           formState={formState}
           wrapElem={wrapElem}
         />
-      );
-    case ControlDefinitionType.Display:
-      return (
-        <DisplayRenderer
+      ),
+      action: (d: ActionControlDefinition) => (
+        <ActionRenderer
           key={key}
           hooks={hooks}
           formState={formState}
           wrapElem={wrapElem}
-          displayDef={definition as DisplayControlDefinition}
+          actionDef={d}
         />
-      );
-    case ControlDefinitionType.Action:
-      return (
-        <ActionRenderer
+      ),
+      display: (d: DisplayControlDefinition) => (
+        <DisplayRenderer
           key={key}
           hooks={hooks}
           formState={formState}
           wrapElem={wrapElem}
-          actionDef={definition as ActionControlDefinition}
+          displayDef={d}
         />
-      );
-    default:
-      return <h1>Unknown control: {(definition as any).type}</h1>;
-  }
+      ),
+    },
+    () => <h1>Unknown control: {(definition as any).type}</h1>
+  );
 
   function wrapElem(e: ReactElement): ReactElement {
     return wrapChild?.(key, e) ?? e;

package/src/hooks.ts

@@ -102,7 +102,7 @@ export function getDefaultScalarControlProperties(
 
 export function getOptionsForScalarField(
   field: SchemaField
-): FieldOption[] | undefined {
+): FieldOption[] | undefined | null {
   const opts = field.options ?? field.restrictions?.options;
   if (opts?.length ?? 0 > 0) {
     return opts;

package/src/index.ts

@@ -1,4 +1,14 @@
+import { SchemaField } from "./types";
+
 export * from "./types";
 export * from "./schemaBuilder";
 export * from "./controlRender";
 export * from "./hooks";
+
+export function fieldHasTag(field: SchemaField, tag: string) {
+  return Boolean(field.tags?.includes(tag));
+}
+
+export function fieldDisplayName(field: SchemaField) {
+  return field.displayName ?? field.field;
+}

package/src/types.ts

@@ -1,20 +1,22 @@
+import { DataControlProperties } from "./controlRender";
+
 export interface SchemaField {
   type: string;
   field: string;
-  displayName?: string;
-  tags?: string[];
-  system?: boolean;
-  collection?: boolean;
-  onlyForTypes?: string[];
-  required?: boolean;
+  displayName?: string | null;
+  tags?: string[] | null;
+  system?: boolean | null;
+  collection?: boolean | null;
+  onlyForTypes?: string[] | null;
+  required?: boolean | null;
   defaultValue?: any;
-  isTypeField?: boolean;
-  searchable?: boolean;
-  options?: FieldOption[];
+  isTypeField?: boolean | null;
+  searchable?: boolean | null;
+  options?: FieldOption[] | null;
   /**
    * @deprecated Use options directly
    */
-  restrictions?: SchemaRestrictions | undefined;
+  restrictions?: SchemaRestrictions | undefined | null;
 }
 
 export enum FieldType {
@@ -37,7 +39,7 @@ export interface EntityRefField extends SchemaField {
 }
 
 export interface SchemaRestrictions {
-  options: FieldOption[] | undefined;
+  options?: FieldOption[] | null;
 }
 
 export interface FieldOption {
@@ -59,9 +61,9 @@ export type AnyControlDefinition =
 
 export interface ControlDefinition {
   type: string;
-  title?: string;
-  dynamic?: DynamicProperty[];
-  adornments?: ControlAdornment[];
+  title?: string | null;
+  dynamic?: DynamicProperty[] | null;
+  adornments?: ControlAdornment[] | null;
 }
 
 export enum ControlDefinitionType {
@@ -125,10 +127,10 @@ export interface AccordionAdornment extends ControlAdornment {
 export interface DataControlDefinition extends ControlDefinition {
   type: ControlDefinitionType.Data;
   field: string;
-  required?: boolean;
-  renderOptions?: RenderOptions;
+  required?: boolean | null;
+  renderOptions?: RenderOptions | null;
   defaultValue?: any;
-  readonly?: boolean;
+  readonly?: boolean | null;
 }
 
 export interface RenderOptions {
@@ -156,7 +158,7 @@ export interface HtmlEditorRenderOptions extends RenderOptions {
 }
 
 export interface DateTimeRenderOptions extends RenderOptions {
-  format?: string;
+  format?: string | null;
 }
 
 export interface IconListRenderOptions extends RenderOptions {
@@ -165,7 +167,7 @@ export interface IconListRenderOptions extends RenderOptions {
 
 export interface IconMapping {
   value: string;
-  materialIcon: string | undefined;
+  materialIcon?: string | null;
 }
 
 export interface CheckListRenderOptions extends RenderOptions {}
@@ -190,14 +192,14 @@ export interface IconSelectionRenderOptions extends RenderOptions {}
 
 export interface GroupedControlsDefinition extends ControlDefinition {
   type: ControlDefinitionType.Group;
-  children: AnyControlDefinition[];
-  compoundField?: string;
+  children: ControlDefinition[];
+  compoundField?: string | null;
   groupOptions: GroupRenderOptions;
 }
 
 export interface GroupRenderOptions {
   type: GroupRenderType;
-  hideTitle?: boolean;
+  hideTitle?: boolean | null;
 }
 
 export enum GroupRenderType {
@@ -213,7 +215,7 @@ export interface GroupElementRenderer extends GroupRenderOptions {
 }
 
 export interface GridRenderer extends GroupRenderOptions {
-  columns: number | undefined;
+  columns?: number | null;
 }
 
 export interface DisplayControlDefinition extends ControlDefinition {
@@ -242,3 +244,53 @@ export interface ActionControlDefinition extends ControlDefinition {
   type: ControlDefinitionType.Action;
   actionId: string;
 }
+
+export function isDataControlDefinition(
+  x: ControlDefinition
+): x is DataControlDefinition {
+  return x.type === ControlDefinitionType.Data;
+}
+
+export function isGroupControlsDefinition(
+  x: ControlDefinition
+): x is GroupedControlsDefinition {
+  return x.type === ControlDefinitionType.Group;
+}
+
+export function isDisplayControlsDefinition(
+  x: ControlDefinition
+): x is DisplayControlDefinition {
+  return x.type === ControlDefinitionType.Display;
+}
+
+export function isActionControlsDefinition(
+  x: ControlDefinition
+): x is ActionControlDefinition {
+  return x.type === ControlDefinitionType.Action;
+}
+
+export interface ControlVisitor<A> {
+  data(d: DataControlDefinition): A;
+  group(d: GroupedControlsDefinition): A;
+  display(d: DisplayControlDefinition): A;
+  action(d: ActionControlDefinition): A;
+}
+
+export function visitControlDefinition<A>(
+  x: ControlDefinition,
+  visitor: ControlVisitor<A>,
+  defaultValue: (c: ControlDefinition) => A
+): A {
+  switch (x.type) {
+    case ControlDefinitionType.Action:
+      return visitor.action(x as ActionControlDefinition);
+    case ControlDefinitionType.Data:
+      return visitor.data(x as DataControlDefinition);
+    case ControlDefinitionType.Display:
+      return visitor.display(x as DisplayControlDefinition);
+    case ControlDefinitionType.Group:
+      return visitor.group(x as GroupedControlsDefinition);
+    default:
+      return defaultValue(x);
+  }
+}