95 lines
2.9 KiB
TypeScript
95 lines
2.9 KiB
TypeScript
import { getPropertyControlTypes } from "components/propertyControls";
|
|
import {
|
|
ValidationResponse,
|
|
ValidationTypes,
|
|
} from "constants/WidgetValidation";
|
|
import { EvaluationSubstitutionType } from "entities/DataTree/dataTreeFactory";
|
|
import { CodeEditorExpected } from "components/editorComponents/CodeEditor";
|
|
const ControlTypes = getPropertyControlTypes();
|
|
export type ControlType = typeof ControlTypes[keyof typeof ControlTypes];
|
|
|
|
export type PropertyPaneSectionConfig = {
|
|
sectionName: string;
|
|
id?: string;
|
|
children: PropertyPaneConfig[];
|
|
hidden?: (props: any, propertyPath: string) => boolean;
|
|
propertySectionPath?: string;
|
|
};
|
|
|
|
export type PanelConfig = {
|
|
editableTitle: boolean;
|
|
titlePropertyName: string;
|
|
panelIdPropertyName: string;
|
|
children: PropertyPaneConfig[];
|
|
updateHook: (
|
|
props: any,
|
|
propertyPath: string,
|
|
propertyValue: any,
|
|
) => Array<{ propertyPath: string; propertyValue: any }> | undefined;
|
|
};
|
|
|
|
export type PropertyPaneControlConfig = {
|
|
id?: string;
|
|
label: string;
|
|
propertyName: string;
|
|
helpText?: string;
|
|
isJSConvertible?: boolean;
|
|
customJSControl?: string;
|
|
controlType: ControlType;
|
|
validationMessage?: string;
|
|
dataTreePath?: string;
|
|
children?: PropertyPaneConfig[];
|
|
panelConfig?: PanelConfig;
|
|
updateHook?: (
|
|
props: any,
|
|
propertyName: string,
|
|
propertyValue: any,
|
|
) => Array<{ propertyPath: string; propertyValue: any }> | undefined;
|
|
hidden?: (props: any, propertyPath: string) => boolean;
|
|
isBindProperty: boolean;
|
|
isTriggerProperty: boolean;
|
|
validation?: ValidationConfig;
|
|
useValidationMessage?: boolean;
|
|
additionalAutoComplete?: (
|
|
props: any,
|
|
) => Record<string, Record<string, unknown>>;
|
|
evaluationSubstitutionType?: EvaluationSubstitutionType;
|
|
dependencies?: string[];
|
|
expected?: CodeEditorExpected;
|
|
};
|
|
|
|
type ValidationConfigParams = {
|
|
min?: number; // min allowed for a number
|
|
max?: number; // max allowed for a number
|
|
natural?: boolean; // is a positive integer
|
|
default?: unknown; // default for any type
|
|
unique?: boolean | string[]; // unique in an array (string if a particular path is unique)
|
|
required?: boolean; // required type
|
|
regex?: RegExp; // validator regex for text type
|
|
allowedKeys?: Array<{
|
|
// Allowed keys in an object type
|
|
name: string;
|
|
type: ValidationTypes;
|
|
params?: ValidationConfigParams;
|
|
}>;
|
|
allowedValues?: unknown[]; // Allowed values in a string and array type
|
|
children?: ValidationConfig; // Children configurations in an ARRAY or OBJECT_ARRAY type
|
|
fn?: (
|
|
value: unknown,
|
|
props: any,
|
|
_?: any,
|
|
moment?: any,
|
|
) => ValidationResponse; // Function in a FUNCTION type
|
|
fnString?: string; // AUTO GENERATED, SHOULD NOT BE SET BY WIDGET DEVELOPER
|
|
expected?: CodeEditorExpected; // FUNCTION type expected type and example
|
|
};
|
|
|
|
export type ValidationConfig = {
|
|
type: ValidationTypes;
|
|
params?: ValidationConfigParams;
|
|
};
|
|
|
|
export type PropertyPaneConfig =
|
|
| PropertyPaneSectionConfig
|
|
| PropertyPaneControlConfig;
|