@react-typed-forms/schemas 1.0.0-dev.2 → 1.0.0-dev.21

package/lib/types.d.ts

@@ -1,20 +1,17 @@
 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[];
-    /**
-     * @deprecated Use options directly
-     */
-    restrictions?: SchemaRestrictions | undefined;
+    isTypeField?: boolean | null;
+    searchable?: boolean | null;
+    options?: FieldOption[] | null;
+    validators?: SchemaValidator[] | null;
 }
 export declare enum FieldType {
     String = "String",
@@ -26,16 +23,14 @@ export declare enum FieldType {
     EntityRef = "EntityRef",
     Compound = "Compound",
     AutoId = "AutoId",
-    Image = "Image"
+    Image = "Image",
+    Any = "Any"
 }
 export interface EntityRefField extends SchemaField {
     type: FieldType.EntityRef;
     entityRefType: string;
     parentField: string;
 }
-export interface SchemaRestrictions {
-    options: FieldOption[] | undefined;
-}
 export interface FieldOption {
     name: string;
     value: any;
@@ -48,9 +43,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",
@@ -59,7 +54,7 @@ export declare enum ControlDefinitionType {
     Action = "Action"
 }
 export interface DynamicProperty {
-    type: DynamicPropertyType;
+    type: string;
     expr: EntityExpression;
 }
 export declare enum DynamicPropertyType {
@@ -67,7 +62,7 @@ export declare enum DynamicPropertyType {
     DefaultValue = "DefaultValue"
 }
 export interface EntityExpression {
-    type: ExpressionType;
+    type: string;
 }
 export declare enum ExpressionType {
     Jsonata = "Jsonata",
@@ -75,36 +70,54 @@ export declare enum ExpressionType {
     UserMatch = "UserMatch"
 }
 export interface JsonataExpression extends EntityExpression {
+    type: ExpressionType.Jsonata;
     expression: string;
 }
 export interface FieldValueExpression extends EntityExpression {
+    type: ExpressionType.FieldValue;
     field: string;
     value: any;
 }
 export interface UserMatchExpression extends EntityExpression {
+    type: ExpressionType.UserMatch;
     userMatch: string;
 }
 export interface ControlAdornment {
-    type: ControlAdornmentType;
+    type: string;
+}
+export declare enum AdornmentPlacement {
+    ControlStart = "ControlStart",
+    ControlEnd = "ControlEnd",
+    LabelStart = "LabelStart",
+    LabelEnd = "LabelEnd"
 }
 export declare enum ControlAdornmentType {
     Tooltip = "Tooltip",
-    Accordion = "Accordion"
+    Accordion = "Accordion",
+    HelpText = "HelpText"
 }
 export interface TooltipAdornment extends ControlAdornment {
+    type: ControlAdornmentType.Tooltip;
     tooltip: string;
 }
 export interface AccordionAdornment extends ControlAdornment {
+    type: ControlAdornmentType.Accordion;
     title: string;
     defaultExpanded: boolean;
 }
+export interface HelpTextAdornment extends ControlAdornment {
+    type: ControlAdornmentType.HelpText;
+    helpText: string;
+    placement: AdornmentPlacement;
+}
 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;
+    validators?: SchemaValidator[] | null;
 }
 export interface RenderOptions {
     type: string;
@@ -118,28 +131,37 @@ export declare enum DataRenderType {
     UserSelection = "UserSelection",
     Synchronised = "Synchronised",
     IconSelector = "IconSelector",
-    DateTime = "DateTime"
+    DateTime = "DateTime",
+    Checkbox = "Checkbox",
+    Dropdown = "Dropdown"
 }
 export interface RadioButtonRenderOptions extends RenderOptions {
+    type: DataRenderType.Radio;
 }
 export interface StandardRenderer extends RenderOptions {
+    type: DataRenderType.Standard;
 }
 export interface HtmlEditorRenderOptions extends RenderOptions {
+    type: DataRenderType.HtmlEditor;
     allowImages: boolean;
 }
 export interface DateTimeRenderOptions extends RenderOptions {
-    format?: string;
+    type: DataRenderType.DateTime;
+    format?: string | null;
 }
 export interface IconListRenderOptions extends RenderOptions {
+    type: DataRenderType.IconList;
     iconMappings: IconMapping[];
 }
 export interface IconMapping {
     value: string;
-    materialIcon: string | undefined;
+    materialIcon?: string | null;
 }
 export interface CheckListRenderOptions extends RenderOptions {
+    type: DataRenderType.CheckList;
 }
 export interface SynchronisedRenderOptions extends RenderOptions {
+    type: DataRenderType.Synchronised;
     fieldToSync: string;
     syncType: SyncTextType;
 }
@@ -149,20 +171,22 @@ export declare enum SyncTextType {
     Pascal = "Pascal"
 }
 export interface UserSelectionRenderOptions extends RenderOptions {
+    type: DataRenderType.UserSelection;
     noGroups: boolean;
     noUsers: boolean;
 }
 export interface IconSelectionRenderOptions extends RenderOptions {
+    type: DataRenderType.IconSelector;
 }
 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;
+    type: string;
+    hideTitle?: boolean | null;
 }
 export declare enum GroupRenderType {
     Standard = "Standard",
@@ -170,31 +194,72 @@ export declare enum GroupRenderType {
     GroupElement = "GroupElement"
 }
 export interface StandardGroupRenderer extends GroupRenderOptions {
+    type: GroupRenderType.Standard;
 }
 export interface GroupElementRenderer extends GroupRenderOptions {
+    type: GroupRenderType.GroupElement;
     value: any;
 }
 export interface GridRenderer extends GroupRenderOptions {
-    columns: number | undefined;
+    type: GroupRenderType.Grid;
+    columns?: number | null;
 }
 export interface DisplayControlDefinition extends ControlDefinition {
     type: ControlDefinitionType.Display;
     displayData: DisplayData;
 }
 export interface DisplayData {
-    type: DisplayDataType;
+    type: string;
 }
 export declare enum DisplayDataType {
     Text = "Text",
     Html = "Html"
 }
 export interface TextDisplay extends DisplayData {
+    type: DisplayDataType.Text;
     text: string;
 }
 export interface HtmlDisplay extends DisplayData {
+    type: DisplayDataType.Html;
     html: string;
 }
 export interface ActionControlDefinition extends ControlDefinition {
     type: ControlDefinitionType.Action;
     actionId: string;
 }
+export declare enum ValidatorType {
+    Jsonata = "Jsonata",
+    Date = "Date"
+}
+export interface SchemaValidator {
+    type: string;
+}
+export interface JsonataValidator extends SchemaValidator {
+    type: ValidatorType.Jsonata;
+    expression: string;
+}
+export declare enum DateComparison {
+    NotBefore = "NotBefore",
+    NotAfter = "NotAfter"
+}
+export interface DateValidator extends SchemaValidator {
+    type: ValidatorType.Date;
+    comparison: DateComparison;
+    fixedDate?: string | null;
+    daysFromCurrent?: number | null;
+}
+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;
+export declare function dataControl(field: string, options?: Partial<DataControlDefinition>): DataControlDefinition;
+export declare function fieldValueExpr(field: string, value: any): FieldValueExpression;
+export declare function visibility(expr: EntityExpression): DynamicProperty;
+export declare function isGridRenderer(options: GroupRenderOptions): options is GridRenderer;

package/lib/util.d.ts

@@ -0,0 +1,22 @@
+import { CompoundField, ControlDefinition, DataControlDefinition, FieldOption, GroupedControlsDefinition, SchemaField } from "./types";
+export declare function applyDefaultValues(v: {
+    [k: string]: any;
+} | undefined, fields: SchemaField[]): any;
+export declare function applyDefaultForField(v: any, field: SchemaField, parent: SchemaField[], notElement?: boolean): any;
+export declare function defaultValueForFields(fields: SchemaField[]): any;
+export declare function defaultValueForField(sf: SchemaField): any;
+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: {
+    options: FieldOption[] | undefined | null;
+}): boolean;
+export declare function defaultControlForField(sf: SchemaField): DataControlDefinition | GroupedControlsDefinition;
+export declare function addMissingControls(fields: SchemaField[], controls: ControlDefinition[]): ControlDefinition[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@react-typed-forms/schemas",
-	"version": "1.0.0-dev.2",
+	"version": "1.0.0-dev.21",
 	"description": "",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
@@ -24,19 +24,26 @@
 		"material-ui"
 	],
 	"dependencies": {
-		"@react-typed-forms/core": "3.0.0-dev.101"
+		"@react-typed-forms/core": "^3.0.0-dev.116",
+		"clsx": "^1 || ^2",
+		"jsonata": "^2.0.3",
+		"react": "^18.2.0"
 	},
 	"devDependencies": {
-		"@types/react": "^18.0.22",
+		"@react-typed-forms/transform": "^0.1.0",
+		"@types/react": "^18.2.28",
+		"microbundle": "^0.15.1",
 		"nswag": "^13.18.2",
-		"react": "^18.2.0",
-		"react-dom": "^18.2.0",
-		"rimraf": "^3.0.2"
+		"prettier": "^3.0.3",
+		"rimraf": "^3.0.2",
+		"typescript": "^5.2.2",
+		"markdown-magic": "^2.6.1"
 	},
 	"gitHead": "698e16cd3ab31b7dd0528fc76536f4d3205ce8c6",
 	"scripts": {
-		"build": "rimraf ./lib/ && tsc",
-		"watch": "tsc -w",
+		"build": "rimraf ./lib/ && microbundle -f cjs --no-compress --jsx React.createElement --jsxFragment React.Fragment",
+		"watch": "microbundle -w -f cjs --no-compress --jsx React.createElement --jsxFragment React.Fragment",
+		"update-readme": "md-magic --path README.md",
 		"gencode": "nswag swagger2tsclient /input:http://localhost:5216/swagger/v1/swagger.json /runtime:Net60 /output:src/types.ts /GenerateClientClasses:false /MarkOptionalProperties:false /Template:Fetch /TypeStyle:Interface /DateTimeType:string"
 	}
 }