@forestadmin/forestadmin-client/dist/schema/types.d.ts

This package contains the logic to use the ForestAdmin API inside an agent.

import type { PrimitiveTypes } from '@forestadmin/datasource-toolkit';
export type ForestSchema = {
    collections: ForestServerCollection[];
    meta: {
        liana: string;
        liana_version: string;
        liana_features: Record<string, string> | null;
        stack: {
            engine: string;
            engine_version: string;
        };
    };
};
export type ForestServerColumnType = PrimitiveTypes | [ForestServerColumnType] | {
    fields: Array<{
        field: string;
        type: ForestServerColumnType;
    }>;
};
export type ForestServerCollection = {
    name: string;
    icon: null;
    integration: null;
    isReadOnly: boolean;
    isSearchable: boolean;
    isVirtual: boolean;
    onlyForRelationships: boolean;
    paginationType: 'page';
    actions: Array<ForestServerAction>;
    fields: Array<ForestServerField>;
    segments: Array<ForestServerSegment>;
};
export type ForestServerAction = {
    id: string;
    name: string;
    type: 'single' | 'bulk' | 'global';
    baseUrl: string;
    endpoint: string;
    httpMethod: 'POST';
    redirect: unknown;
    download: boolean;
    fields: ForestServerActionField[];
    layout?: ForestServerActionFormLayoutElement[];
    description?: string;
    submitButtonLabel?: string;
    hooks: {
        load: boolean;
        change: Array<unknown>;
    };
};
export type ForestServerActionFieldWidgetEditBase<TType = string, TConfig = unknown> = {
    name: TType;
    parameters: TConfig;
};
export type WidgetEditConfiguration = {
    name: string;
    parameters: Record<string, unknown>;
};
type ForestServerActionFieldType = ForestServerColumnType | 'File' | ['File'];
export type ForestServerActionFieldCommon<TType extends ForestServerActionFieldType = ForestServerActionFieldType, TWidgetEdit extends WidgetEditConfiguration | null = null> = {
    type: TType;
    value: unknown;
    defaultValue: unknown;
    description: string | null;
    field: string;
    label: string;
    hook: string;
    isReadOnly: boolean;
    isRequired: boolean;
    enums: null | string[];
    widgetEdit: TWidgetEdit;
};
export type ForestServerActionFieldBase = ForestServerActionFieldCommon & {
    reference: string | null;
};
type ForestServerActionFieldLimitedValueOptions<TName extends string, TValue = string, TParameters = Record<string, never>> = {
    name: TName;
    parameters: {
        static: {
            options: Array<{
                label: string;
                value: TValue;
            } | TValue>;
        };
    } & TParameters;
};
export type ForestServerActionFieldDropdownOptions<TValue = string> = ForestServerActionFieldLimitedValueOptions<'dropdown', TValue, {
    placeholder?: string | null;
    isSearchable?: boolean;
    searchType?: 'dynamic';
}>;
export type ForestServerActionFieldRadioButtonOptions<TValue = string> = ForestServerActionFieldLimitedValueOptions<'radio button', TValue>;
export type ForestServerActionFieldCheckboxGroupOptions<TValue = string> = ForestServerActionFieldLimitedValueOptions<'checkboxes', TValue>;
export type ForestServerActionFieldCheckboxOptions = {
    name: 'boolean editor';
    parameters: Record<string, never>;
};
export type ForestServerActionFieldTextInputOptions = {
    name: 'text editor';
    parameters: {
        placeholder?: string | null;
    };
};
export type ForestServerActionFieldAddressAutocompleteOptions = {
    name: 'address editor';
    parameters: {
        placeholder?: string | null;
    };
};
export type ForestServerActionFieldDatePickerInputOptions = {
    name: 'date editor';
    parameters: {
        format?: string | null;
        placeholder?: string | null;
        minDate?: string;
        maxDate?: string;
    };
};
export type ForestServerActionFieldTextInputListOptions = {
    name: 'input array';
    parameters: {
        placeholder?: string | null;
        enableReorder?: boolean;
        allowDuplicate?: boolean;
        allowEmptyValue?: boolean;
    };
};
export type ForestServerActionFieldTextAreaOptions = {
    name: 'text area editor';
    parameters: {
        placeholder?: string | null;
        rows?: number;
    };
};
export type ForestServerActionFieldRichTextOptions = {
    name: 'rich text';
    parameters: {
        placeholder?: string | null;
    };
};
export type ForestServerActionFieldTimePickerOptions = {
    name: 'time editor';
    parameters: Record<string, never>;
};
export type ForestServerActionFieldNumberInputOptions = {
    name: 'number input';
    parameters: {
        placeholder?: string | null;
        min?: number;
        max?: number;
        step?: number;
    };
};
export type ForestServerActionFieldNumberInputListOptions = {
    name: 'input array';
    parameters: {
        placeholder?: string | null;
        enableReorder?: boolean;
        allowDuplicate?: boolean;
        min?: number;
        max?: number;
        step?: number;
    };
};
export type ForestServerActionFieldColorPickerOptions = {
    name: 'color editor';
    parameters: {
        placeholder?: string | null;
        enableOpacity?: boolean;
        quickPalette?: string[];
    };
};
export type ForestServerActionFieldCurrencyInputOptions = {
    name: 'price editor';
    parameters: {
        placeholder?: string | null;
        min?: number;
        max?: number;
        step?: number;
        currency: string;
        base: 'Unit' | 'Cents';
    };
};
export type ForestServerActionFieldUserDropdown = {
    name: 'assignee editor';
    parameters: {
        placeholder?: string | null;
    };
};
export type ForestServerActionFieldJsonEditorOptions = {
    name: 'json code editor';
    parameters: Record<string, never>;
};
export type ForestServerActionFieldFilePickerOptions = {
    name: 'file picker';
    parameters: {
        prefix: null;
        filesCountLimit: number | null;
        filesExtensions: string[] | null;
        filesSizeLimit: number | null;
    };
};
export type ForestServerActionFieldDropdown = ForestServerActionFieldCommon<'String' | 'Dateonly' | 'Date' | 'Time', ForestServerActionFieldDropdownOptions<string>> | ForestServerActionFieldCommon<['String'], ForestServerActionFieldDropdownOptions<string[]>> | ForestServerActionFieldCommon<'Number', ForestServerActionFieldDropdownOptions<number>>;
export type ForestServerActionFieldRadioGroup = ForestServerActionFieldCommon<'String' | 'Dateonly' | 'Date' | 'Time', ForestServerActionFieldRadioButtonOptions<string>> | ForestServerActionFieldCommon<'Number', ForestServerActionFieldRadioButtonOptions<number>>;
export type ForestServerActionFieldCheckboxGroup = ForestServerActionFieldCommon<['String'], ForestServerActionFieldCheckboxGroupOptions<string>> | ForestServerActionFieldCommon<['Number'], ForestServerActionFieldCheckboxGroupOptions<number>>;
type ForestServerActionFormElementSeparator = {
    component: 'separator';
};
type ForestServerActionFormElementHtmlBlock = {
    component: 'htmlBlock';
    content: string;
};
type ForestServerActionFormElementRow = {
    component: 'row';
    fields: ForestServerActionFormElementFieldReference[];
};
type ForestServerActionFormElementPage = {
    component: 'page';
    nextButtonLabel?: string;
    previousButtonLabel?: string;
    elements: ForestServerActionFormLayoutElement[];
};
export type ForestServerActionFormElementFieldReference = {
    component: 'input';
    fieldId: string;
};
export type ForestServerActionFormLayoutElement = ForestServerActionFormElementSeparator | ForestServerActionFormElementHtmlBlock | ForestServerActionFormElementRow | ForestServerActionFormElementFieldReference | ForestServerActionFormElementPage;
export type ForestServerActionField = ForestServerActionFieldDropdown | ForestServerActionFieldRadioGroup | ForestServerActionFieldCheckboxGroup | ForestServerActionFieldBase | ForestServerActionFieldCommon<'Boolean', ForestServerActionFieldCheckboxOptions> | ForestServerActionFieldCommon<'String', ForestServerActionFieldTextInputOptions> | ForestServerActionFieldCommon<'Date', ForestServerActionFieldDatePickerInputOptions> | ForestServerActionFieldCommon<['String'], ForestServerActionFieldTextInputListOptions> | ForestServerActionFieldCommon<'String', ForestServerActionFieldTextAreaOptions> | ForestServerActionFieldCommon<'String', ForestServerActionFieldUserDropdown> | ForestServerActionFieldCommon<'String', ForestServerActionFieldRichTextOptions> | ForestServerActionFieldCommon<'Time', ForestServerActionFieldTimePickerOptions> | ForestServerActionFieldCommon<'Number', ForestServerActionFieldNumberInputOptions> | ForestServerActionFieldCommon<'Number', ForestServerActionFieldCurrencyInputOptions> | ForestServerActionFieldCommon<['Number'], ForestServerActionFieldNumberInputListOptions> | ForestServerActionFieldCommon<'String', ForestServerActionFieldColorPickerOptions> | ForestServerActionFieldCommon<'File' | ['File'], ForestServerActionFieldFilePickerOptions> | ForestServerActionFieldCommon<'Json', ForestServerActionFieldJsonEditorOptions> | ForestServerActionFieldCommon<'String', ForestServerActionFieldAddressAutocompleteOptions>;
export type ForestServerField = Partial<{
    field: string;
    type: ForestServerColumnType;
    defaultValue: unknown;
    enums: null | string[];
    integration: null;
    isFilterable: boolean;
    isPrimaryKey: boolean;
    isReadOnly: boolean;
    isRequired: boolean;
    isSortable: boolean;
    isVirtual: boolean;
    reference: null | string;
    inverseOf: null | string;
    relationship: 'BelongsTo' | 'BelongsToMany' | 'HasMany' | 'HasOne';
    validations: Array<{
        message: string | null;
        type: ValidationType;
        value?: unknown;
    }>;
}>;
export type ForestServerSegment = {
    id: string;
    name: string;
};
export type ValidationType = 'contains' | 'is after' | 'is before' | 'is greater than' | 'is greater than or equal to' | 'is less than' | 'is less than or equal to' | 'is like' | 'is longer than' | 'is present' | 'is shorter than';
export {};
//# sourceMappingURL=types.d.ts.map