/ok-to-test tags="@tag.Sanity" Corresponding CE files for EE PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced enhanced control features by adding an optional action identifier, providing greater context for interactions. - Added a new document selection control type, expanding available form control options in the editor. - **Refactor** - Improved control rendering performance by refining the update logic to better handle state changes such as disabled status. <!-- end of auto-generated comment: release notes by coderabbit.ai --> <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/13183325897> > Commit: c645c5ceea407e2849a566bed65cff675eec881d > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13183325897&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Sanity` > Spec: > <hr>Thu, 06 Feb 2025 17:39:42 UTC <!-- end of auto-generated comment: Cypress test results -->
128 lines
3.7 KiB
TypeScript
128 lines
3.7 KiB
TypeScript
import { Component } from "react";
|
|
import type { ControlType } from "constants/PropertyControlConstants";
|
|
import type { InputType } from "components/constants";
|
|
import type { ConditonalObject } from "reducers/evaluationReducers/formEvaluationReducer";
|
|
import type { DropdownOption } from "@appsmith/ads-old";
|
|
import type { ViewTypes } from "./utils";
|
|
import type { FeatureFlag } from "ee/entities/FeatureFlag";
|
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
abstract class BaseControl<P extends ControlProps, S = {}> extends Component<
|
|
P,
|
|
S
|
|
> {
|
|
abstract getControlType(): ControlType;
|
|
}
|
|
|
|
export type ComparisonOperations =
|
|
| "EQUALS"
|
|
| "NOT_EQUALS"
|
|
| "LESSER"
|
|
| "GREATER"
|
|
| "IN"
|
|
| "NOT_IN"
|
|
| "FEATURE_FLAG"
|
|
| "VIEW_MODE"
|
|
| "DEFINED_AND_NOT_EQUALS";
|
|
|
|
export enum ComparisonOperationsEnum {
|
|
VIEW_MODE = "VIEW_MODE",
|
|
}
|
|
|
|
export type HiddenType = boolean | Condition | ConditionObject;
|
|
|
|
export interface ConditionObject {
|
|
conditionType: string;
|
|
conditions: Conditions;
|
|
}
|
|
|
|
export interface Condition {
|
|
path: string;
|
|
comparison: ComparisonOperations;
|
|
// TODO: Fix this the next time the file is edited
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
value: any;
|
|
flagValue: FeatureFlag;
|
|
}
|
|
|
|
export type Conditions = Array<Condition> | ConditionObject;
|
|
export interface ControlBuilder<T extends ControlProps> {
|
|
buildPropertyControl(controlProps: T): JSX.Element;
|
|
}
|
|
|
|
export interface ControlProps extends ControlData, ControlFunctions {
|
|
key?: string;
|
|
extraData?: ControlData[];
|
|
formName: string;
|
|
nestedFormControl?: boolean;
|
|
}
|
|
|
|
export interface ControlData {
|
|
id: string;
|
|
label: string;
|
|
alternateViewTypes?: ViewTypes[];
|
|
tooltipText?: string | Record<string, string>;
|
|
configProperty: string;
|
|
controlType: ControlType;
|
|
// TODO: Fix this the next time the file is edited
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
propertyValue?: any;
|
|
isValid: boolean;
|
|
validationMessage?: string;
|
|
validationRegex?: string;
|
|
dataType?: InputType;
|
|
initialValue?:
|
|
| string
|
|
| boolean
|
|
| number
|
|
| Record<string, string>
|
|
| Array<string>;
|
|
info?: string; //helper text
|
|
isRequired?: boolean;
|
|
conditionals?: ConditonalObject; // Object that contains the conditionals config
|
|
hidden?: HiddenType;
|
|
placeholderText?: string | Record<string, string>;
|
|
// TODO: Fix this the next time the file is edited
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
schema?: any;
|
|
errorText?: string;
|
|
showError?: boolean;
|
|
encrypted?: boolean;
|
|
title?: string; // used as label for control component
|
|
subtitle?: string;
|
|
showLineNumbers?: boolean;
|
|
url?: string;
|
|
urlText?: string;
|
|
logicalTypes?: string[];
|
|
comparisonTypes?: string[];
|
|
nestedLevels?: number;
|
|
// TODO: Fix this the next time the file is edited
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
customStyles?: any;
|
|
// TODO: Fix this the next time the file is edited
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
sectionStyles?: any;
|
|
propertyName?: string;
|
|
identifier?: string;
|
|
sectionName?: string;
|
|
disabled?: boolean;
|
|
staticDependencyPathList?: string[];
|
|
validator?: (value: string) => { isValid: boolean; message: string };
|
|
isSecretExistsPath?: string;
|
|
addMoreButtonLabel?: string;
|
|
datasourceId?: string;
|
|
workspaceId?: string;
|
|
actionId?: string;
|
|
}
|
|
export type FormConfigType = Omit<ControlData, "configProperty"> & {
|
|
configProperty?: string;
|
|
children?: FormConfigType[];
|
|
options?: DropdownOption[];
|
|
fetchOptionsConditionally?: boolean;
|
|
};
|
|
|
|
export interface ControlFunctions {
|
|
onPropertyChange?: (propertyName: string, propertyValue: string) => void;
|
|
}
|
|
|
|
export default BaseControl;
|