@react-typed-forms/schemas 1.0.0-dev.15 → 1.0.0-dev.16

package/lib/schemaBuilder.d.ts

@@ -1,87 +1,87 @@
-import { CompoundField, FieldOption, FieldType, SchemaField } from "./types";
-type AllowedSchema<T> = T extends string ? SchemaField & {
-    type: FieldType.String | FieldType.Date | FieldType.DateTime;
-} : T extends number ? SchemaField & {
-    type: FieldType.Int | FieldType.Double;
-} : T extends boolean ? SchemaField & {
-    type: FieldType.Bool;
-} : T extends Array<infer E> ? AllowedSchema<E> & {
-    collection: true;
-} : T extends {
-    [key: string]: any;
-} ? CompoundField & {
-    type: FieldType.Compound;
-} : SchemaField & {
-    type: FieldType.Any;
-};
-type AllowedField<T, K> = (name: string) => (SchemaField & {
-    type: K;
-}) | AllowedSchema<T>;
-export declare function buildSchema<T, Custom = "">(def: {
-    [K in keyof T]-?: AllowedField<T[K], Custom>;
-}): SchemaField[];
-export declare function stringField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
-    field?: string | 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 | 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 & {
-    type: FieldType.String;
-    displayName: string;
-    options: FieldOption[];
-};
-export declare function withScalarOptions<S extends SchemaField>(options: Partial<SchemaField>, v: (name: string) => S): (name: string) => S;
-export declare function makeScalarField<S extends Partial<SchemaField>>(options: S): (name: string) => SchemaField & S;
-export declare function makeCompoundField<S extends Partial<CompoundField>>(options: S): (name: string) => CompoundField & {
-    type: FieldType.Compound;
-} & S;
-export declare function intField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
-    field?: string | 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 | 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 | 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 | 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 & {
-    collection: Other["collection"];
-};
-export declare function defaultScalarField(field: string, displayName: string): Omit<SchemaField, "type"> & {
-    type: FieldType.String;
-};
-export declare function defaultCompoundField(field: string, displayName: string, collection: boolean): CompoundField & {
-    type: FieldType.Compound;
-};
-export {};
+import { CompoundField, FieldOption, FieldType, SchemaField } from "./types";
+type AllowedSchema<T> = T extends string ? SchemaField & {
+    type: FieldType.String | FieldType.Date | FieldType.DateTime;
+} : T extends number ? SchemaField & {
+    type: FieldType.Int | FieldType.Double;
+} : T extends boolean ? SchemaField & {
+    type: FieldType.Bool;
+} : T extends Array<infer E> ? AllowedSchema<E> & {
+    collection: true;
+} : T extends {
+    [key: string]: any;
+} ? CompoundField & {
+    type: FieldType.Compound;
+} : SchemaField & {
+    type: FieldType.Any;
+};
+type AllowedField<T, K> = (name: string) => (SchemaField & {
+    type: K;
+}) | AllowedSchema<T>;
+export declare function buildSchema<T, Custom = "">(def: {
+    [K in keyof T]-?: AllowedField<T[K], Custom>;
+}): SchemaField[];
+export declare function stringField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
+    field?: string | 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 | 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 & {
+    type: FieldType.String;
+    displayName: string;
+    options: FieldOption[];
+};
+export declare function withScalarOptions<S extends SchemaField>(options: Partial<SchemaField>, v: (name: string) => S): (name: string) => S;
+export declare function makeScalarField<S extends Partial<SchemaField>>(options: S): (name: string) => SchemaField & S;
+export declare function makeCompoundField<S extends Partial<CompoundField>>(options: S): (name: string) => CompoundField & {
+    type: FieldType.Compound;
+} & S;
+export declare function intField(displayName: string, options?: Partial<Omit<SchemaField, "type">>): (name: string) => SchemaField & {
+    field?: string | 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 | 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 | 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 | 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 & {
+    collection: Other["collection"];
+};
+export declare function defaultScalarField(field: string, displayName: string): Omit<SchemaField, "type"> & {
+    type: FieldType.String;
+};
+export declare function defaultCompoundField(field: string, displayName: string, collection: boolean): CompoundField & {
+    type: FieldType.Compound;
+};
+export {};

package/lib/types.d.ts

@@ -1,234 +1,234 @@
-export interface SchemaField {
-    type: string;
-    field: string;
-    displayName?: string | null;
-    tags?: string[] | null;
-    system?: boolean | null;
-    collection?: boolean | null;
-    onlyForTypes?: string[] | null;
-    required?: boolean | null;
-    defaultValue?: any;
-    isTypeField?: boolean | null;
-    searchable?: boolean | null;
-    options?: FieldOption[] | null;
-    /**
-     * @deprecated Use options directly
-     */
-    restrictions?: SchemaRestrictions | undefined | null;
-}
-export declare enum FieldType {
-    String = "String",
-    Bool = "Bool",
-    Int = "Int",
-    Date = "Date",
-    DateTime = "DateTime",
-    Double = "Double",
-    EntityRef = "EntityRef",
-    Compound = "Compound",
-    AutoId = "AutoId",
-    Image = "Image",
-    Any = "Any"
-}
-export interface EntityRefField extends SchemaField {
-    type: FieldType.EntityRef;
-    entityRefType: string;
-    parentField: string;
-}
-export interface SchemaRestrictions {
-    options?: FieldOption[] | null;
-}
-export interface FieldOption {
-    name: string;
-    value: any;
-}
-export interface CompoundField extends SchemaField {
-    type: FieldType.Compound;
-    children: SchemaField[];
-    treeChildren?: boolean;
-}
-export type AnyControlDefinition = DataControlDefinition | GroupedControlsDefinition | ActionControlDefinition | DisplayControlDefinition;
-export interface ControlDefinition {
-    type: string;
-    title?: string | null;
-    dynamic?: DynamicProperty[] | null;
-    adornments?: ControlAdornment[] | null;
-}
-export declare enum ControlDefinitionType {
-    Data = "Data",
-    Group = "Group",
-    Display = "Display",
-    Action = "Action"
-}
-export interface DynamicProperty {
-    type: string;
-    expr: EntityExpression;
-}
-export declare enum DynamicPropertyType {
-    Visible = "Visible",
-    DefaultValue = "DefaultValue"
-}
-export interface EntityExpression {
-    type: string;
-}
-export declare enum ExpressionType {
-    Jsonata = "Jsonata",
-    FieldValue = "FieldValue",
-    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: string;
-}
-export declare enum ControlAdornmentType {
-    Tooltip = "Tooltip",
-    Accordion = "Accordion"
-}
-export interface TooltipAdornment extends ControlAdornment {
-    type: ControlAdornmentType.Tooltip;
-    tooltip: string;
-}
-export interface AccordionAdornment extends ControlAdornment {
-    type: ControlAdornmentType.Accordion;
-    title: string;
-    defaultExpanded: boolean;
-}
-export interface DataControlDefinition extends ControlDefinition {
-    type: ControlDefinitionType.Data;
-    field: string;
-    required?: boolean | null;
-    renderOptions?: RenderOptions | null;
-    defaultValue?: any;
-    readonly?: boolean | null;
-}
-export interface RenderOptions {
-    type: string;
-}
-export declare enum DataRenderType {
-    Standard = "Standard",
-    Radio = "Radio",
-    HtmlEditor = "HtmlEditor",
-    IconList = "IconList",
-    CheckList = "CheckList",
-    UserSelection = "UserSelection",
-    Synchronised = "Synchronised",
-    IconSelector = "IconSelector",
-    DateTime = "DateTime"
-}
-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 {
-    type: DataRenderType.DateTime;
-    format?: string | null;
-}
-export interface IconListRenderOptions extends RenderOptions {
-    type: DataRenderType.IconList;
-    iconMappings: IconMapping[];
-}
-export interface IconMapping {
-    value: string;
-    materialIcon?: string | null;
-}
-export interface CheckListRenderOptions extends RenderOptions {
-    type: DataRenderType.CheckList;
-}
-export interface SynchronisedRenderOptions extends RenderOptions {
-    type: DataRenderType.Synchronised;
-    fieldToSync: string;
-    syncType: SyncTextType;
-}
-export declare enum SyncTextType {
-    Camel = "Camel",
-    Snake = "Snake",
-    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: ControlDefinition[];
-    compoundField?: string | null;
-    groupOptions: GroupRenderOptions;
-}
-export interface GroupRenderOptions {
-    type: string;
-    hideTitle?: boolean | null;
-}
-export declare enum GroupRenderType {
-    Standard = "Standard",
-    Grid = "Grid",
-    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 {
-    type: GroupRenderType.Grid;
-    columns?: number | null;
-}
-export interface DisplayControlDefinition extends ControlDefinition {
-    type: ControlDefinitionType.Display;
-    displayData: DisplayData;
-}
-export interface DisplayData {
-    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 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 interface SchemaField {
+    type: string;
+    field: string;
+    displayName?: string | null;
+    tags?: string[] | null;
+    system?: boolean | null;
+    collection?: boolean | null;
+    onlyForTypes?: string[] | null;
+    required?: boolean | null;
+    defaultValue?: any;
+    isTypeField?: boolean | null;
+    searchable?: boolean | null;
+    options?: FieldOption[] | null;
+    /**
+     * @deprecated Use options directly
+     */
+    restrictions?: SchemaRestrictions | undefined | null;
+}
+export declare enum FieldType {
+    String = "String",
+    Bool = "Bool",
+    Int = "Int",
+    Date = "Date",
+    DateTime = "DateTime",
+    Double = "Double",
+    EntityRef = "EntityRef",
+    Compound = "Compound",
+    AutoId = "AutoId",
+    Image = "Image",
+    Any = "Any"
+}
+export interface EntityRefField extends SchemaField {
+    type: FieldType.EntityRef;
+    entityRefType: string;
+    parentField: string;
+}
+export interface SchemaRestrictions {
+    options?: FieldOption[] | null;
+}
+export interface FieldOption {
+    name: string;
+    value: any;
+}
+export interface CompoundField extends SchemaField {
+    type: FieldType.Compound;
+    children: SchemaField[];
+    treeChildren?: boolean;
+}
+export type AnyControlDefinition = DataControlDefinition | GroupedControlsDefinition | ActionControlDefinition | DisplayControlDefinition;
+export interface ControlDefinition {
+    type: string;
+    title?: string | null;
+    dynamic?: DynamicProperty[] | null;
+    adornments?: ControlAdornment[] | null;
+}
+export declare enum ControlDefinitionType {
+    Data = "Data",
+    Group = "Group",
+    Display = "Display",
+    Action = "Action"
+}
+export interface DynamicProperty {
+    type: string;
+    expr: EntityExpression;
+}
+export declare enum DynamicPropertyType {
+    Visible = "Visible",
+    DefaultValue = "DefaultValue"
+}
+export interface EntityExpression {
+    type: string;
+}
+export declare enum ExpressionType {
+    Jsonata = "Jsonata",
+    FieldValue = "FieldValue",
+    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: string;
+}
+export declare enum ControlAdornmentType {
+    Tooltip = "Tooltip",
+    Accordion = "Accordion"
+}
+export interface TooltipAdornment extends ControlAdornment {
+    type: ControlAdornmentType.Tooltip;
+    tooltip: string;
+}
+export interface AccordionAdornment extends ControlAdornment {
+    type: ControlAdornmentType.Accordion;
+    title: string;
+    defaultExpanded: boolean;
+}
+export interface DataControlDefinition extends ControlDefinition {
+    type: ControlDefinitionType.Data;
+    field: string;
+    required?: boolean | null;
+    renderOptions?: RenderOptions | null;
+    defaultValue?: any;
+    readonly?: boolean | null;
+}
+export interface RenderOptions {
+    type: string;
+}
+export declare enum DataRenderType {
+    Standard = "Standard",
+    Radio = "Radio",
+    HtmlEditor = "HtmlEditor",
+    IconList = "IconList",
+    CheckList = "CheckList",
+    UserSelection = "UserSelection",
+    Synchronised = "Synchronised",
+    IconSelector = "IconSelector",
+    DateTime = "DateTime"
+}
+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 {
+    type: DataRenderType.DateTime;
+    format?: string | null;
+}
+export interface IconListRenderOptions extends RenderOptions {
+    type: DataRenderType.IconList;
+    iconMappings: IconMapping[];
+}
+export interface IconMapping {
+    value: string;
+    materialIcon?: string | null;
+}
+export interface CheckListRenderOptions extends RenderOptions {
+    type: DataRenderType.CheckList;
+}
+export interface SynchronisedRenderOptions extends RenderOptions {
+    type: DataRenderType.Synchronised;
+    fieldToSync: string;
+    syncType: SyncTextType;
+}
+export declare enum SyncTextType {
+    Camel = "Camel",
+    Snake = "Snake",
+    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: ControlDefinition[];
+    compoundField?: string | null;
+    groupOptions: GroupRenderOptions;
+}
+export interface GroupRenderOptions {
+    type: string;
+    hideTitle?: boolean | null;
+}
+export declare enum GroupRenderType {
+    Standard = "Standard",
+    Grid = "Grid",
+    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 {
+    type: GroupRenderType.Grid;
+    columns?: number | null;
+}
+export interface DisplayControlDefinition extends ControlDefinition {
+    type: ControlDefinitionType.Display;
+    displayData: DisplayData;
+}
+export interface DisplayData {
+    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 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;

package/lib/util.d.ts

@@ -0,0 +1,3 @@
+import { SchemaField } from "./types";
+export declare function fieldHasTag(field: SchemaField, tag: string): boolean;
+export declare function fieldDisplayName(field: SchemaField): string;