PromucFlow_constructor/app/client/src/components/formControls/BaseControl.tsx
Valera Melnikov b7ec5dacd8
chore: rename old ADS package (#35517)
## Description
Rename package `design-system-old` to `@appsmith/ads-old`.

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!CAUTION]
> 🔴 🔴 🔴 Some tests have failed.
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10286195096>
> Commit: c0d478694b12f35b88687b6dae6f252967fba540
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10286195096&attempt=1&selectiontype=test&testsstatus=failed&specsstatus=fail"
target="_blank">Cypress dashboard</a>.
> Tags: @tag.All
> Spec: 
> The following are new failures, please fix them before merging the PR:
<ol>
>
<li>cypress/e2e/Regression/ClientSide/BugTests/DatasourceSchema_spec.ts</ol>
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/identified-flaky-tests-65890b3c81d7400d08fa9ee3?branch=master"
target="_blank">List of identified flaky tests</a>.
> <hr>Wed, 07 Aug 2024 15:26:02 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No
2024-08-08 15:55:00 +03:00

124 lines
3.5 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;
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;
}
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;