-
-
Notifications
You must be signed in to change notification settings - Fork 139
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #392 - Conditional Options Logic
- Loading branch information
Showing
7 changed files
with
350 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
84 changes: 84 additions & 0 deletions
84
...p/core/src/lib/fields/field-logic/actionable-field-logic/actionable-field-logic.action.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /** | ||
| * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd. | ||
| * Copyright (C) 2023 SalesAgility Ltd. | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify it under | ||
| * the terms of the GNU Affero General Public License version 3 as published by the | ||
| * Free Software Foundation with the addition of the following permission added | ||
| * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK | ||
| * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE | ||
| * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more | ||
| * details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| * In accordance with Section 7(b) of the GNU Affero General Public License | ||
| * version 3, these Appropriate Legal Notices must retain the display of the | ||
| * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably | ||
| * feasible for technical reasons, the Appropriate Legal Notices must display | ||
| * the words "Supercharged by SuiteCRM". | ||
| */ | ||
|
|
||
| import {isArray, isString} from 'lodash-es'; | ||
| import { | ||
| Action, | ||
| ALL_VIEW_MODES, | ||
| Field, | ||
| Record, | ||
| } from 'common'; | ||
| import { FieldLogicActionData, FieldLogicActionHandler } from '../field-logic.action'; | ||
| import {ActiveLogicChecker} from '../../../services/logic/active-logic-checker.service'; | ||
|
|
||
| export type FieldValueTypes = string | string[] | object; | ||
|
|
||
| export abstract class ActionableFieldLogicActionHandler extends FieldLogicActionHandler { | ||
| modes = ALL_VIEW_MODES; | ||
|
|
||
| protected constructor( | ||
| protected activeLogicChecker: ActiveLogicChecker | ||
| ) { | ||
| super(); | ||
| } | ||
|
|
||
| run(data: FieldLogicActionData, action: Action): void { | ||
| const record = data.record; | ||
| const field = data.field; | ||
| if (!record || !field) { | ||
| return; | ||
| } | ||
| const params = action.params ?? {}; | ||
|
|
||
| const logicIsActive = this.activeLogicChecker.run(record, action); | ||
|
|
||
| this.executeLogic(logicIsActive, params, field, record); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| shouldDisplay(data: FieldLogicActionData): boolean { | ||
| return true; | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| executeLogic(logicIsActive: boolean, params: { [p: string]: any }, field: Field, record: Record): void { | ||
| } | ||
|
|
||
| protected updateValue(value: FieldValueTypes, field: Field, record: Record): void { | ||
| if (isString(value)) { | ||
| field.value = value; | ||
| } else if (isArray(value)) { | ||
| field.valueList = value; | ||
| } else { | ||
| field.valueObject = value; | ||
| } | ||
|
|
||
| field.formControl.setValue(value); | ||
|
|
||
| // re-validate the parent form-control after value update | ||
| record.formGroup.updateValueAndValidity({onlySelf: true, emitEvent: true}); | ||
| } | ||
| } |
74 changes: 74 additions & 0 deletions
74
core/app/core/src/lib/fields/field-logic/conditional-options/conditional-options.action.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /** | ||
| * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd. | ||
| * Copyright (C) 2023 SalesAgility Ltd. | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify it under | ||
| * the terms of the GNU Affero General Public License version 3 as published by the | ||
| * Free Software Foundation with the addition of the following permission added | ||
| * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK | ||
| * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE | ||
| * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more | ||
| * details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| * In accordance with Section 7(b) of the GNU Affero General Public License | ||
| * version 3, these Appropriate Legal Notices must retain the display of the | ||
| * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably | ||
| * feasible for technical reasons, the Appropriate Legal Notices must display | ||
| * the words "Supercharged by SuiteCRM". | ||
| */ | ||
|
|
||
| import {Injectable} from '@angular/core'; | ||
| import {Action, Field, Option, Record, ViewMode} from 'common'; | ||
| import {ActionableFieldLogicActionHandler} from '../actionable-field-logic/actionable-field-logic.action'; | ||
| import {ActiveLogicChecker} from '../../../services/logic/active-logic-checker.service'; | ||
|
|
||
| interface ConditionalOptionsParams { | ||
| conditionalOptions?: (Option & Action)[]; | ||
| } | ||
|
|
||
| @Injectable({ | ||
| providedIn: 'root' | ||
| }) | ||
| export class ConditionalOptionsAction extends ActionableFieldLogicActionHandler { | ||
|
|
||
| key = 'conditional-options'; | ||
| modes = ['detail', 'edit', 'create'] as ViewMode[]; | ||
|
|
||
| constructor( | ||
| protected activeLogicChecker: ActiveLogicChecker | ||
| ) { | ||
| super(activeLogicChecker); | ||
| } | ||
|
|
||
| executeLogic(logicIsActive: boolean, params: ConditionalOptionsParams, field: Field, record: Record): void { | ||
| if (!logicIsActive) { | ||
| return; | ||
| } | ||
| const conditionalOptions = params.conditionalOptions ?? []; | ||
| const currentFieldOptions: { [key: string]: Option } = {}; | ||
|
|
||
| conditionalOptions.forEach((conditionalOption) => { | ||
| const isActive = this.activeLogicChecker.run(record, conditionalOption); | ||
|
|
||
| if (!isActive) { | ||
| return; | ||
| } | ||
|
|
||
| currentFieldOptions[conditionalOption.value] = { | ||
| value: conditionalOption.value ?? '', | ||
| label: conditionalOption.label ?? '', | ||
| labelKey: conditionalOption.labelKey ?? '' | ||
| }; | ||
| }); | ||
|
|
||
| field.metadata.conditionalOptions = currentFieldOptions; | ||
| field.options = [...(field.options ?? [])]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.