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

package/lib/renderers.d.ts

@@ -0,0 +1,153 @@
+import React, { CSSProperties, ReactElement, ReactNode } from "react";
+import { ActionRendererProps, AdornmentProps, AdornmentRenderer, ArrayRendererProps, DataRendererProps, DisplayRendererProps, FormRenderer, GroupRendererProps, LabelRendererProps, Visibility } from "./controlRender";
+import { FieldOption, GridRenderer } from "./types";
+import { Control } from "@react-typed-forms/core";
+export interface DefaultRenderers {
+    data: DataRendererRegistration;
+    label: LabelRendererRegistration;
+    action: ActionRendererRegistration;
+    array: ArrayRendererRegistration;
+    group: GroupRendererRegistration;
+    display: DisplayRendererRegistration;
+    visibility: VisibilityRendererRegistration;
+    adornment: AdornmentRendererRegistration;
+}
+export interface DataRendererRegistration {
+    type: "data";
+    schemaType?: string | string[];
+    renderType?: string | string[];
+    options?: boolean;
+    collection?: boolean;
+    match?: (props: DataRendererProps) => boolean;
+    render: (props: DataRendererProps, defaultLabel: (label?: Partial<LabelRendererProps>) => LabelRendererProps, renderers: FormRenderer) => ReactElement;
+}
+export interface LabelRendererRegistration {
+    type: "label";
+    render: (labelProps: LabelRendererProps, elem: ReactElement, renderers: FormRenderer) => ReactElement;
+}
+export interface ActionRendererRegistration {
+    type: "action";
+    render: (props: ActionRendererProps, renderers: FormRenderer) => ReactElement;
+}
+export interface ArrayRendererRegistration {
+    type: "array";
+    render: (props: ArrayRendererProps, renderers: FormRenderer) => ReactElement;
+}
+export interface GroupRendererRegistration {
+    type: "group";
+    render: (props: GroupRendererProps, defaultLabel: (label?: Partial<LabelRendererProps>) => LabelRendererProps, renderers: FormRenderer) => ReactElement;
+}
+export interface DisplayRendererRegistration {
+    type: "display";
+    render: (props: DisplayRendererProps, renderers: FormRenderer) => ReactElement;
+}
+export interface VisibilityRendererRegistration {
+    type: "visibility";
+    render: (visible: Visibility, elem: ReactElement) => ReactElement;
+}
+export interface AdornmentRendererRegistration {
+    type: "adornment";
+    adornmentType?: string | string[];
+    render: (props: AdornmentProps) => AdornmentRenderer;
+}
+export type AnyRendererRegistration = DataRendererRegistration | GroupRendererRegistration | DisplayRendererRegistration | ActionRendererRegistration | LabelRendererRegistration | ArrayRendererRegistration | AdornmentRendererRegistration | VisibilityRendererRegistration;
+export declare function createFormRenderer(customRenderers?: AnyRendererRegistration[], defaultRenderers?: DefaultRenderers): FormRenderer;
+interface DefaultLabelRendererOptions {
+    className?: string;
+    groupLabelClass?: string;
+    requiredElement?: ReactNode;
+    labelClass?: string;
+}
+interface DefaultActionRendererOptions {
+    className?: string;
+}
+export declare function createDefaultActionRenderer(options?: DefaultActionRendererOptions): ActionRendererRegistration;
+export declare function createDefaultLabelRenderer(options?: DefaultLabelRendererOptions): LabelRendererRegistration;
+export declare function DefaultLabelRenderer({ className, labelClass, title, forId, required, children, group, groupLabelClass, renderAdornment, requiredElement, }: LabelRendererProps & DefaultLabelRendererOptions & {
+    children: ReactElement;
+}): React.JSX.Element;
+interface DefaultArrayRendererOptions {
+    className?: string;
+    removableClass?: string;
+    childClass?: string;
+    removableChildClass?: string;
+    removeActionClass?: string;
+    addActionClass?: string;
+}
+export declare function createDefaultArrayRenderer(options?: DefaultArrayRendererOptions): ArrayRendererRegistration;
+interface StyleProps {
+    className?: string;
+    style?: CSSProperties;
+}
+interface DefaultGroupRendererOptions {
+    className?: string;
+    standardClassName?: string;
+    gridStyles?: (columns: GridRenderer) => StyleProps;
+    gridClassName?: string;
+    defaultGridColumns?: number;
+}
+export declare function createDefaultGroupRenderer(options?: DefaultGroupRendererOptions): GroupRendererRegistration;
+export interface DefaultDisplayRendererOptions {
+    textClassName?: string;
+    htmlClassName?: string;
+}
+export declare function createDefaultDisplayRenderer(options?: DefaultDisplayRendererOptions): DisplayRendererRegistration;
+export declare const DefaultBoolOptions: FieldOption[];
+interface DefaultDataRendererOptions {
+    inputClass?: string;
+    selectOptions?: SelectRendererOptions;
+    booleanOptions?: FieldOption[];
+    optionRenderer?: DataRendererRegistration;
+}
+export declare function createDefaultDataRenderer(options?: DefaultDataRendererOptions): DataRendererRegistration;
+export declare function ControlInput({ control, convert, ...props }: React.InputHTMLAttributes<HTMLInputElement> & {
+    control: Control<any>;
+    convert: InputConversion;
+}): React.JSX.Element;
+export interface DefaultVisibilityRendererOptions {
+}
+export interface DefaultAdornmentRendererOptions {
+}
+export declare function createDefaultAdornmentRenderer(options?: DefaultAdornmentRendererOptions): AdornmentRendererRegistration;
+export declare function createDefaultVisibilityRenderer(options?: DefaultVisibilityRendererOptions): VisibilityRendererRegistration;
+export interface DefaultRendererOptions {
+    data?: DefaultDataRendererOptions;
+    display?: DefaultDisplayRendererOptions;
+    action?: DefaultActionRendererOptions;
+    array?: DefaultArrayRendererOptions;
+    group?: DefaultGroupRendererOptions;
+    label?: DefaultLabelRendererOptions;
+    visibility?: DefaultVisibilityRendererOptions;
+    adornment?: DefaultAdornmentRendererOptions;
+}
+export declare function createDefaultRenderers(options?: DefaultRendererOptions): DefaultRenderers;
+export declare function createDataRenderer(render: DataRendererRegistration["render"], options?: Partial<DataRendererRegistration>): DataRendererRegistration;
+export declare function createDataRendererLabelled(render: (props: DataRendererProps, id: string, renderers: FormRenderer) => ReactElement, options?: Partial<DataRendererRegistration>): DataRendererRegistration;
+export declare function createLabelRenderer(options: Omit<LabelRendererRegistration, "type">): LabelRendererRegistration;
+export declare function createAdornmentRenderer(render: (props: AdornmentProps) => AdornmentRenderer, options?: Omit<AdornmentRendererRegistration, "type">): AdornmentRendererRegistration;
+export interface SelectRendererOptions {
+    className?: string;
+    emptyText?: string;
+    requiredText?: string;
+}
+export declare function createSelectRenderer(options?: SelectRendererOptions): DataRendererRegistration;
+type SelectConversion = (a: any) => string | number;
+interface SelectDataRendererProps {
+    id?: string;
+    className?: string;
+    options: {
+        name: string;
+        value: any;
+        disabled?: boolean;
+    }[];
+    emptyText?: string;
+    requiredText?: string;
+    required: boolean;
+    state: Control<any>;
+    convert: SelectConversion;
+}
+export declare function SelectDataRenderer({ state, options, className, convert, required, emptyText, requiredText, ...props }: SelectDataRendererProps): React.JSX.Element;
+export declare function createSelectConversion(ft: string): SelectConversion;
+type InputConversion = [string, (s: any) => any, (a: any) => string | number];
+export declare function createInputConversion(ft: string): InputConversion;
+export {};

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/tailwind.d.ts

@@ -0,0 +1,2 @@
+import { DefaultRendererOptions } from "./renderers";
+export declare const defaultTailwindTheme: DefaultRendererOptions;