Enhancement: support assigning custom field values in workflows (#9272)

2025-07-28 18:24:38 -05:00 · 2025-03-05 12:30:19 -08:00
parent 89e5c08a1f
commit edc7181843
20 changed files with 605 additions and 175 deletions
--- a/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html
+++ b/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html
@@ -189,6 +189,7 @@
            <pngx-input-select i18n-title title="Assign correspondent" [items]="correspondents" [allowNull]="true" formControlName="assign_correspondent"></pngx-input-select>
            <pngx-input-select i18n-title title="Assign storage path" [items]="storagePaths" [allowNull]="true" formControlName="assign_storage_path"></pngx-input-select>
            <pngx-input-select i18n-title title="Assign custom fields" multiple="true" [items]="customFields" [allowNull]="true" formControlName="assign_custom_fields"></pngx-input-select>
+            <pngx-input-custom-fields-values formControlName="assign_custom_fields_values" [selectedFields]="formGroup.get('assign_custom_fields').value" (removeSelectedField)="removeSelectedCustomField($event, formGroup)"></pngx-input-custom-fields-values>
          </div>
          <div class="col">
            <pngx-input-select i18n-title title="Assign owner" [items]="users" bindLabel="username" formControlName="assign_owner" [allowNull]="true"></pngx-input-select>
--- a/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.spec.ts
+++ b/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.spec.ts
@@ -2,7 +2,12 @@ import { CdkDragDrop } from '@angular/cdk/drag-drop'
 import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 import { provideHttpClientTesting } from '@angular/common/http/testing'
 import { ComponentFixture, TestBed } from '@angular/core/testing'
-import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import {
+  FormControl,
+  FormGroup,
+  FormsModule,
+  ReactiveFormsModule,
+} from '@angular/forms'
 import { NgbActiveModal, NgbModule } from '@ng-bootstrap/ng-bootstrap'
 import { NgSelectModule } from '@ng-select/ng-select'
 import { of } from 'rxjs'
@@ -369,4 +374,19 @@ describe('WorkflowEditDialogComponent', () => {
    expect(component.objectForm.get('actions').value[0].email).toBeNull()
    expect(component.objectForm.get('actions').value[0].webhook).toBeNull()
  })
+
+  it('should remove selected custom field from the form group', () => {
+    const formGroup = new FormGroup({
+      assign_custom_fields: new FormControl([1, 2, 3]),
+    })
+
+    component.removeSelectedCustomField(2, formGroup)
+    expect(formGroup.get('assign_custom_fields').value).toEqual([1, 3])
+
+    component.removeSelectedCustomField(1, formGroup)
+    expect(formGroup.get('assign_custom_fields').value).toEqual([3])
+
+    component.removeSelectedCustomField(3, formGroup)
+    expect(formGroup.get('assign_custom_fields').value).toEqual([])
+  })
 })
--- a/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.ts
+++ b/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.ts
@@ -47,6 +47,7 @@ import { WorkflowService } from 'src/app/services/rest/workflow.service'
 import { SettingsService } from 'src/app/services/settings.service'
 import { ConfirmButtonComponent } from '../../confirm-button/confirm-button.component'
 import { CheckComponent } from '../../input/check/check.component'
+import { CustomFieldsValuesComponent } from '../../input/custom-fields-values/custom-fields-values.component'
 import { EntriesComponent } from '../../input/entries/entries.component'
 import { NumberComponent } from '../../input/number/number.component'
 import { PermissionsGroupComponent } from '../../input/permissions/permissions-group/permissions-group.component'
@@ -151,6 +152,7 @@ const TRIGGER_MATCHING_ALGORITHMS = MATCHING_ALGORITHMS.filter(
    SelectComponent,
    TextAreaComponent,
    TagsComponent,
+    CustomFieldsValuesComponent,
    PermissionsGroupComponent,
    PermissionsUserComponent,
    ConfirmButtonComponent,
@@ -439,6 +441,9 @@ export class WorkflowEditDialogComponent
        assign_change_users: new FormControl(action.assign_change_users),
        assign_change_groups: new FormControl(action.assign_change_groups),
        assign_custom_fields: new FormControl(action.assign_custom_fields),
+        assign_custom_fields_values: new FormControl(
+          action.assign_custom_fields_values
+        ),
        remove_tags: new FormControl(action.remove_tags),
        remove_all_tags: new FormControl(action.remove_all_tags),
        remove_document_types: new FormControl(action.remove_document_types),
@@ -565,6 +570,7 @@ export class WorkflowEditDialogComponent
      assign_change_users: [],
      assign_change_groups: [],
      assign_custom_fields: [],
+      assign_custom_fields_values: {},
      remove_tags: [],
      remove_all_tags: false,
      remove_document_types: [],
@@ -643,4 +649,12 @@ export class WorkflowEditDialogComponent
      })
    super.save()
  }
+
+  public removeSelectedCustomField(fieldId: number, group: FormGroup) {
+    group
+      .get('assign_custom_fields')
+      .setValue(
+        group.get('assign_custom_fields').value.filter((id) => id !== fieldId)
+      )
+  }
 }
--- a/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.html
+++ b/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.html
@@ -0,0 +1,77 @@
+<div class="list-group mt-3 selected-fields">
+  @for (fieldId of selectedFields; track fieldId) {
+    <div class="list-group-item
+      d-flex
+      justify-content-between
+      align-items-center">
+      @switch (getCustomField(fieldId)?.data_type) {
+        @case (CustomFieldDataType.String) {
+          <pngx-input-text [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"></pngx-input-text>
+        }
+        @case (CustomFieldDataType.Date) {
+          <pngx-input-date [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"></pngx-input-date>
+        }
+        @case (CustomFieldDataType.Integer) {
+          <pngx-input-number [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"
+          [showAdd]="false"></pngx-input-number>
+        }
+        @case (CustomFieldDataType.Float) {
+          <pngx-input-number [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"
+          [showAdd]="false"
+          [step]=".1"></pngx-input-number>
+        }
+        @case (CustomFieldDataType.Monetary) {
+          <pngx-input-monetary [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [defaultCurrency]="getCustomField(fieldId)?.extra_data?.default_currency"
+          class="flex-grow-1"
+          [horizontal]="true"></pngx-input-monetary>
+        }
+        @case (CustomFieldDataType.Boolean) {
+          <pngx-input-check [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"></pngx-input-check>
+        }
+        @case (CustomFieldDataType.Url) {
+          <pngx-input-url [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"></pngx-input-url>
+        }
+        @case (CustomFieldDataType.DocumentLink) {
+          <pngx-input-document-link [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [horizontal]="true"></pngx-input-document-link>
+        }
+        @case (CustomFieldDataType.Select) {
+          <pngx-input-select [(ngModel)]="value[fieldId]" (ngModelChange)="onChange(value)"
+          [title]="getCustomField(fieldId)?.name"
+          class="flex-grow-1"
+          [items]="getCustomField(fieldId)?.extra_data.select_options"
+          class="flex-grow-1"
+          bindLabel="label"
+          [allowNull]="true"
+          [horizontal]="true"></pngx-input-select>
+        }
+      }
+      <button type="button" class="btn btn-link text-danger" (click)="removeSelectedField.next(fieldId)">
+        <i-bs name="trash"></i-bs>
+      </button>
+    </div>
+  }
+</div>
--- a/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.scss
+++ b/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.scss
@@ -0,0 +1,3 @@
+:host ::ng-deep .list-group-item .mb-3 {
+  margin-bottom: 0 !important;
+}
--- a/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.spec.ts
+++ b/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.spec.ts
@@ -0,0 +1,69 @@
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
+import { ComponentFixture, TestBed } from '@angular/core/testing'
+import {
+  FormsModule,
+  NG_VALUE_ACCESSOR,
+  ReactiveFormsModule,
+} from '@angular/forms'
+import { of } from 'rxjs'
+import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field'
+import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
+import { CustomFieldsValuesComponent } from './custom-fields-values.component'
+
+describe('CustomFieldsValuesComponent', () => {
+  let component: CustomFieldsValuesComponent
+  let fixture: ComponentFixture<CustomFieldsValuesComponent>
+  let customFieldsService: CustomFieldsService
+
+  beforeEach(async () => {
+    TestBed.configureTestingModule({
+      imports: [FormsModule, ReactiveFormsModule, CustomFieldsValuesComponent],
+      providers: [
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
+    }).compileComponents()
+
+    fixture = TestBed.createComponent(CustomFieldsValuesComponent)
+    fixture.debugElement.injector.get(NG_VALUE_ACCESSOR)
+    component = fixture.componentInstance
+    customFieldsService = TestBed.inject(CustomFieldsService)
+    jest.spyOn(customFieldsService, 'listAll').mockReturnValue(
+      of({
+        all: [1],
+        count: 1,
+        results: [
+          {
+            id: 1,
+            name: 'Field 1',
+            data_type: CustomFieldDataType.String,
+          } as CustomField,
+        ],
+      })
+    )
+    fixture.detectChanges()
+  })
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(CustomFieldsValuesComponent)
+    component = fixture.componentInstance
+    fixture.detectChanges()
+  })
+
+  it('should set selectedFields and map values correctly', () => {
+    component.value = { 1: 'value1' }
+    component.selectedFields = [1, 2]
+    expect(component.selectedFields).toEqual([1, 2])
+    expect(component.value).toEqual({ 1: 'value1', 2: null })
+  })
+
+  it('should return the correct custom field by id', () => {
+    const field = component.getCustomField(1)
+    expect(field).toEqual({
+      id: 1,
+      name: 'Field 1',
+      data_type: CustomFieldDataType.String,
+    } as CustomField)
+  })
+})
--- a/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.ts
+++ b/src-ui/src/app/components/common/input/custom-fields-values/custom-fields-values.component.ts
@@ -0,0 +1,90 @@
+import {
+  Component,
+  EventEmitter,
+  forwardRef,
+  Input,
+  Output,
+} from '@angular/core'
+import {
+  FormsModule,
+  NG_VALUE_ACCESSOR,
+  ReactiveFormsModule,
+} from '@angular/forms'
+import { RouterModule } from '@angular/router'
+import { NgSelectModule } from '@ng-select/ng-select'
+import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
+import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field'
+import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
+import { AbstractInputComponent } from '../abstract-input'
+import { CheckComponent } from '../check/check.component'
+import { DateComponent } from '../date/date.component'
+import { DocumentLinkComponent } from '../document-link/document-link.component'
+import { MonetaryComponent } from '../monetary/monetary.component'
+import { NumberComponent } from '../number/number.component'
+import { SelectComponent } from '../select/select.component'
+import { TextComponent } from '../text/text.component'
+import { UrlComponent } from '../url/url.component'
+
+@Component({
+  providers: [
+    {
+      provide: NG_VALUE_ACCESSOR,
+      useExisting: forwardRef(() => CustomFieldsValuesComponent),
+      multi: true,
+    },
+  ],
+  selector: 'pngx-input-custom-fields-values',
+  templateUrl: './custom-fields-values.component.html',
+  styleUrl: './custom-fields-values.component.scss',
+  imports: [
+    TextComponent,
+    DateComponent,
+    NumberComponent,
+    DocumentLinkComponent,
+    UrlComponent,
+    SelectComponent,
+    MonetaryComponent,
+    CheckComponent,
+    NgSelectModule,
+    FormsModule,
+    ReactiveFormsModule,
+    RouterModule,
+    NgxBootstrapIconsModule,
+  ],
+})
+export class CustomFieldsValuesComponent extends AbstractInputComponent<Object> {
+  public CustomFieldDataType = CustomFieldDataType
+
+  constructor(customFieldsService: CustomFieldsService) {
+    super()
+    customFieldsService.listAll().subscribe((items) => {
+      this.fields = items.results
+    })
+  }
+
+  private fields: CustomField[]
+
+  private _selectedFields: number[]
+
+  @Input()
+  set selectedFields(newFields: number[]) {
+    this._selectedFields = newFields
+    // map the selected fields to an object with field_id as key and value as value
+    this.value = newFields.reduce((acc, fieldId) => {
+      acc[fieldId] = this.value?.[fieldId] || null
+      return acc
+    }, {})
+    this.onChange(this.value)
+  }
+
+  get selectedFields(): number[] {
+    return this._selectedFields
+  }
+
+  @Output()
+  public removeSelectedField: EventEmitter<number> = new EventEmitter<number>()
+
+  public getCustomField(id: number): CustomField {
+    return this.fields.find((field) => field.id === id)
+  }
+}
--- a/src-ui/src/app/data/workflow-action.ts
+++ b/src-ui/src/app/data/workflow-action.ts
@@ -58,6 +58,8 @@ export interface WorkflowAction extends ObjectWithId {

  assign_custom_fields?: number[] // [CustomField.id]

+  assign_custom_fields_values?: object
+
  remove_tags?: number[] // Tag.id

  remove_all_tags?: boolean