mirror of
https://github.com/DSpace/dspace-angular.git
synced 2025-10-18 23:43:01 +00:00
[TLC-1202] Move getTypeBindRelations to util function
(cherry picked from commit f16dda8255
)
This commit is contained in:

committed by
github-actions[bot]
![github-actions[bot]](/assets/img/avatar_default.png)
parent
a7b67e4357
commit
589765ce30
@@ -23,6 +23,7 @@ import {
|
|||||||
import { FormBuilderService } from '../form-builder.service';
|
import { FormBuilderService } from '../form-builder.service';
|
||||||
import { FormFieldMetadataValueObject } from '../models/form-field-metadata-value.model';
|
import { FormFieldMetadataValueObject } from '../models/form-field-metadata-value.model';
|
||||||
import { DsDynamicTypeBindRelationService } from './ds-dynamic-type-bind-relation.service';
|
import { DsDynamicTypeBindRelationService } from './ds-dynamic-type-bind-relation.service';
|
||||||
|
import { getTypeBindRelations } from './type-bind.utils';
|
||||||
|
|
||||||
describe('DSDynamicTypeBindRelationService test suite', () => {
|
describe('DSDynamicTypeBindRelationService test suite', () => {
|
||||||
let service: DsDynamicTypeBindRelationService;
|
let service: DsDynamicTypeBindRelationService;
|
||||||
@@ -82,7 +83,7 @@ describe('DSDynamicTypeBindRelationService test suite', () => {
|
|||||||
});
|
});
|
||||||
it('Should get 1 related form models for mock relation model data', () => {
|
it('Should get 1 related form models for mock relation model data', () => {
|
||||||
const testModel = mockInputWithTypeBindModel;
|
const testModel = mockInputWithTypeBindModel;
|
||||||
testModel.typeBindRelations = DsDynamicTypeBindRelationService.getTypeBindRelations(['boundType'], 'dc.type');
|
testModel.typeBindRelations = getTypeBindRelations(['boundType'], 'dc.type');
|
||||||
const relatedModels = service.getRelatedFormModel(testModel);
|
const relatedModels = service.getRelatedFormModel(testModel);
|
||||||
expect(relatedModels).toHaveSize(1);
|
expect(relatedModels).toHaveSize(1);
|
||||||
});
|
});
|
||||||
@@ -91,7 +92,7 @@ describe('DSDynamicTypeBindRelationService test suite', () => {
|
|||||||
describe('Test matchesCondition method', () => {
|
describe('Test matchesCondition method', () => {
|
||||||
it('Should receive one subscription to dc.type type binding"', () => {
|
it('Should receive one subscription to dc.type type binding"', () => {
|
||||||
const testModel = mockInputWithTypeBindModel;
|
const testModel = mockInputWithTypeBindModel;
|
||||||
testModel.typeBindRelations = DsDynamicTypeBindRelationService.getTypeBindRelations(['boundType'], 'dc.type');
|
testModel.typeBindRelations = getTypeBindRelations(['boundType'], 'dc.type');
|
||||||
const dcTypeControl = new UntypedFormControl();
|
const dcTypeControl = new UntypedFormControl();
|
||||||
dcTypeControl.setValue('boundType');
|
dcTypeControl.setValue('boundType');
|
||||||
let subscriptions = service.subscribeRelations(testModel, dcTypeControl);
|
let subscriptions = service.subscribeRelations(testModel, dcTypeControl);
|
||||||
@@ -100,7 +101,7 @@ describe('DSDynamicTypeBindRelationService test suite', () => {
|
|||||||
|
|
||||||
it('Expect hasMatch to be true (ie. this should be hidden)', () => {
|
it('Expect hasMatch to be true (ie. this should be hidden)', () => {
|
||||||
const testModel = mockInputWithTypeBindModel;
|
const testModel = mockInputWithTypeBindModel;
|
||||||
testModel.typeBindRelations = DsDynamicTypeBindRelationService.getTypeBindRelations(['boundType'], 'dc.type');
|
testModel.typeBindRelations = getTypeBindRelations(['boundType'], 'dc.type');
|
||||||
const dcTypeControl = new UntypedFormControl();
|
const dcTypeControl = new UntypedFormControl();
|
||||||
dcTypeControl.setValue('boundType');
|
dcTypeControl.setValue('boundType');
|
||||||
testModel.typeBindRelations[0].when[0].value = 'anotherType';
|
testModel.typeBindRelations[0].when[0].value = 'anotherType';
|
||||||
@@ -115,7 +116,7 @@ describe('DSDynamicTypeBindRelationService test suite', () => {
|
|||||||
|
|
||||||
it('Expect hasMatch to be false (ie. this should NOT be hidden)', () => {
|
it('Expect hasMatch to be false (ie. this should NOT be hidden)', () => {
|
||||||
const testModel = mockInputWithTypeBindModel;
|
const testModel = mockInputWithTypeBindModel;
|
||||||
testModel.typeBindRelations = DsDynamicTypeBindRelationService.getTypeBindRelations(['boundType'], 'dc.type');
|
testModel.typeBindRelations = getTypeBindRelations(['boundType'], 'dc.type');
|
||||||
const dcTypeControl = new UntypedFormControl();
|
const dcTypeControl = new UntypedFormControl();
|
||||||
dcTypeControl.setValue('boundType');
|
dcTypeControl.setValue('boundType');
|
||||||
testModel.typeBindRelations[0].when[0].value = 'boundType';
|
testModel.typeBindRelations[0].when[0].value = 'boundType';
|
||||||
|
@@ -13,8 +13,6 @@ import {
|
|||||||
DynamicFormControlModel,
|
DynamicFormControlModel,
|
||||||
DynamicFormControlRelation,
|
DynamicFormControlRelation,
|
||||||
DynamicFormRelationService,
|
DynamicFormRelationService,
|
||||||
MATCH_ENABLED,
|
|
||||||
MATCH_VISIBLE,
|
|
||||||
OR_OPERATOR,
|
OR_OPERATOR,
|
||||||
} from '@ng-dynamic-forms/core';
|
} from '@ng-dynamic-forms/core';
|
||||||
import { Subscription } from 'rxjs';
|
import { Subscription } from 'rxjs';
|
||||||
@@ -35,48 +33,6 @@ import { DYNAMIC_FORM_CONTROL_TYPE_RELATION_GROUP } from './ds-dynamic-form-cons
|
|||||||
@Injectable({ providedIn: 'root' })
|
@Injectable({ providedIn: 'root' })
|
||||||
export class DsDynamicTypeBindRelationService {
|
export class DsDynamicTypeBindRelationService {
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the type bind values from the REST data for a specific field
|
|
||||||
* The return value is any[] in the method signature but in reality it's
|
|
||||||
* returning the 'relation' that'll be used for a dynamic matcher when filtering
|
|
||||||
* fields in type bind, made up of a 'match' outcome (make this field visible), an 'operator'
|
|
||||||
* (OR) and a 'when' condition (the bindValues array).
|
|
||||||
* @param configuredTypeBindValues array of types from the submission definition (CONFIG_DATA)
|
|
||||||
* @param typeField
|
|
||||||
* @private
|
|
||||||
* @return DynamicFormControlRelation[] array with one relation in it, for type bind matching to show a field
|
|
||||||
*/
|
|
||||||
public static getTypeBindRelations(configuredTypeBindValues: string[], typeField: string): DynamicFormControlRelation[] {
|
|
||||||
const bindValues = [];
|
|
||||||
configuredTypeBindValues.forEach((value) => {
|
|
||||||
bindValues.push({
|
|
||||||
id: typeField,
|
|
||||||
value: value,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
// match: MATCH_VISIBLE means that if true, the field / component will be visible
|
|
||||||
// operator: OR means that all the values in the 'when' condition will be compared with OR, not AND
|
|
||||||
// when: the list of values to match against, in this case the list of strings from <type-bind>...</type-bind>
|
|
||||||
// Example: Field [x] will be VISIBLE if item type = book OR item type = book_part
|
|
||||||
//
|
|
||||||
// The opposing match value will be the dc.type for the workspace item
|
|
||||||
//
|
|
||||||
// MATCH_ENABLED is now also returned, so that hidden type-bound fields that are 'required'
|
|
||||||
// do not trigger false validation errors
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
match: MATCH_ENABLED,
|
|
||||||
operator: OR_OPERATOR,
|
|
||||||
when: bindValues,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
match: MATCH_VISIBLE,
|
|
||||||
operator: OR_OPERATOR,
|
|
||||||
when: bindValues,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
constructor(@Optional() @Inject(DYNAMIC_MATCHERS) private dynamicMatchers: DynamicFormControlMatcher[],
|
constructor(@Optional() @Inject(DYNAMIC_MATCHERS) private dynamicMatchers: DynamicFormControlMatcher[],
|
||||||
protected dynamicFormRelationService: DynamicFormRelationService,
|
protected dynamicFormRelationService: DynamicFormRelationService,
|
||||||
protected formBuilderService: FormBuilderService,
|
protected formBuilderService: FormBuilderService,
|
||||||
|
@@ -0,0 +1,48 @@
|
|||||||
|
import {
|
||||||
|
DynamicFormControlRelation,
|
||||||
|
MATCH_ENABLED,
|
||||||
|
MATCH_VISIBLE,
|
||||||
|
OR_OPERATOR,
|
||||||
|
} from '@ng-dynamic-forms/core';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the type bind values from the REST data for a specific field
|
||||||
|
* The return value is any[] in the method signature but in reality it's
|
||||||
|
* returning the 'relation' that'll be used for a dynamic matcher when filtering
|
||||||
|
* fields in type bind, made up of a 'match' outcome (make this field visible), an 'operator'
|
||||||
|
* (OR) and a 'when' condition (the bindValues array).
|
||||||
|
* @param configuredTypeBindValues array of types from the submission definition (CONFIG_DATA)
|
||||||
|
* @param typeField
|
||||||
|
* @private
|
||||||
|
* @return DynamicFormControlRelation[] array with one relation in it, for type bind matching to show a field
|
||||||
|
*/
|
||||||
|
export function getTypeBindRelations(configuredTypeBindValues: string[], typeField: string): DynamicFormControlRelation[] {
|
||||||
|
const bindValues = [];
|
||||||
|
configuredTypeBindValues.forEach((value) => {
|
||||||
|
bindValues.push({
|
||||||
|
id: typeField,
|
||||||
|
value: value,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
// match: MATCH_VISIBLE means that if true, the field / component will be visible
|
||||||
|
// operator: OR means that all the values in the 'when' condition will be compared with OR, not AND
|
||||||
|
// when: the list of values to match against, in this case the list of strings from <type-bind>...</type-bind>
|
||||||
|
// Example: Field [x] will be VISIBLE if item type = book OR item type = book_part
|
||||||
|
//
|
||||||
|
// The opposing match value will be the dc.type for the workspace item
|
||||||
|
//
|
||||||
|
// MATCH_ENABLED is now also returned, so that hidden type-bound fields that are 'required'
|
||||||
|
// do not trigger false validation errors
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
match: MATCH_ENABLED,
|
||||||
|
operator: OR_OPERATOR,
|
||||||
|
when: bindValues,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
match: MATCH_VISIBLE,
|
||||||
|
operator: OR_OPERATOR,
|
||||||
|
when: bindValues,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
@@ -15,7 +15,6 @@ import {
|
|||||||
isNotNull,
|
isNotNull,
|
||||||
isNotUndefined,
|
isNotUndefined,
|
||||||
} from '../../../empty.util';
|
} from '../../../empty.util';
|
||||||
import { DsDynamicTypeBindRelationService } from '../ds-dynamic-form-ui/ds-dynamic-type-bind-relation.service';
|
|
||||||
import {
|
import {
|
||||||
DsDynamicInputModel,
|
DsDynamicInputModel,
|
||||||
DsDynamicInputModelConfig,
|
DsDynamicInputModelConfig,
|
||||||
@@ -24,6 +23,7 @@ import {
|
|||||||
DynamicRowArrayModel,
|
DynamicRowArrayModel,
|
||||||
DynamicRowArrayModelConfig,
|
DynamicRowArrayModelConfig,
|
||||||
} from '../ds-dynamic-form-ui/models/ds-dynamic-row-array-model';
|
} from '../ds-dynamic-form-ui/models/ds-dynamic-row-array-model';
|
||||||
|
import { getTypeBindRelations } from '../ds-dynamic-form-ui/type-bind.utils';
|
||||||
import { FormFieldModel } from '../models/form-field.model';
|
import { FormFieldModel } from '../models/form-field.model';
|
||||||
import { FormFieldMetadataValueObject } from '../models/form-field-metadata-value.model';
|
import { FormFieldMetadataValueObject } from '../models/form-field-metadata-value.model';
|
||||||
import { RelationshipOptions } from '../models/relationship-options.model';
|
import { RelationshipOptions } from '../models/relationship-options.model';
|
||||||
@@ -94,7 +94,7 @@ export abstract class FieldParser {
|
|||||||
metadataFields: this.getAllFieldIds(),
|
metadataFields: this.getAllFieldIds(),
|
||||||
hasSelectableMetadata: isNotEmpty(this.configData.selectableMetadata),
|
hasSelectableMetadata: isNotEmpty(this.configData.selectableMetadata),
|
||||||
isDraggable,
|
isDraggable,
|
||||||
typeBindRelations: isNotEmpty(this.configData.typeBind) ? DsDynamicTypeBindRelationService.getTypeBindRelations(this.configData.typeBind,
|
typeBindRelations: isNotEmpty(this.configData.typeBind) ? getTypeBindRelations(this.configData.typeBind,
|
||||||
this.parserOptions.typeField) : null,
|
this.parserOptions.typeField) : null,
|
||||||
groupFactory: () => {
|
groupFactory: () => {
|
||||||
let model;
|
let model;
|
||||||
@@ -323,7 +323,7 @@ export abstract class FieldParser {
|
|||||||
|
|
||||||
// If typeBind is configured
|
// If typeBind is configured
|
||||||
if (isNotEmpty(this.configData.typeBind)) {
|
if (isNotEmpty(this.configData.typeBind)) {
|
||||||
(controlModel as DsDynamicInputModel).typeBindRelations = DsDynamicTypeBindRelationService.getTypeBindRelations(this.configData.typeBind,
|
(controlModel as DsDynamicInputModel).typeBindRelations = getTypeBindRelations(this.configData.typeBind,
|
||||||
this.parserOptions.typeField);
|
this.parserOptions.typeField);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user