hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-07 01:54:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/main' into w2p-90978_Improve-initial-page-load_PR

Browse Source
This commit is contained in:
Yura Bondarenko
2022-05-13 09:32:34 +02:00
parent f0d98c9b6f 5c8ef44070
commit 21579d1525
156 changed files with 2469 additions and 548 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
config/config.example.yml
View File

@@ -164,10 +164,12 @@ browseBy:
# The absolute lowest year to display in the dropdown (only used when no lowest date can be found for all items)
defaultLowerLimit: 1900
# Item Page Config
# Item Config
item:
edit:
undoTimeout: 10000 # 10 seconds
# Show the item access status label in items lists
showAccessStatuses: false
# Collection Page Config
collection:

18
package.json
View File

@@ -68,8 +68,8 @@
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "^4.9.1",
"@ng-bootstrap/ng-bootstrap": "^11.0.0",
"@ng-dynamic-forms/core": "^14.0.1",
"@ng-dynamic-forms/ui-ng-bootstrap": "^14.0.1",
"@ng-dynamic-forms/core": "^15.0.0",
"@ng-dynamic-forms/ui-ng-bootstrap": "^15.0.0",
"@ngrx/effects": "^13.0.2",
"@ngrx/router-store": "^13.0.2",
"@ngrx/store": "^13.0.2",
@@ -77,7 +77,7 @@
"@ngx-translate/core": "^13.0.0",
"@nicky-lenaers/ngx-scroll-to": "^9.0.0",
"angular-idle-preload": "3.0.0",
"angulartics2": "^10.0.0",
"angulartics2": "^12.0.0",
"bootstrap": "4.3.1",
"caniuse-lite": "^1.0.30001165",
"cerialize": "0.1.18",
@@ -119,7 +119,7 @@
"prop-types": "^15.7.2",
"react-copy-to-clipboard": "^5.0.1",
"reflect-metadata": "^0.1.13",
"rxjs": "^6.6.3",
"rxjs": "^7.5.5",
"sortablejs": "1.13.0",
"tslib": "^2.0.0",
"url-parse": "^1.5.6",
@@ -161,7 +161,7 @@
"css-minimizer-webpack-plugin": "^3.4.1",
"cssnano": "^5.0.6",
"cypress": "9.5.1",
"cypress-axe": "^0.13.0",
"cypress-axe": "^0.14.0",
"debug-loader": "^0.0.1",
"deep-freeze": "0.0.1",
"dotenv": "^8.2.0",
@@ -174,7 +174,7 @@
"fork-ts-checker-webpack-plugin": "^6.0.3",
"html-loader": "^1.3.2",
"jasmine-core": "^3.8.0",
"jasmine-marbles": "0.6.0",
"jasmine-marbles": "0.9.2",
"jasmine-spec-reporter": "~5.0.0",
"karma": "^6.3.14",
"karma-chrome-launcher": "~3.1.0",
@@ -182,7 +182,7 @@
"karma-jasmine": "~4.0.0",
"karma-jasmine-html-reporter": "^1.5.0",
"karma-mocha-reporter": "2.2.5",
"ngx-mask": "^12.0.0",
"ngx-mask": "^13.1.7",
"nodemon": "^2.0.15",
"postcss": "^8.1",
"postcss-apply": "0.12.0",
@@ -196,7 +196,7 @@
"react": "^16.14.0",
"react-dom": "^16.14.0",
"rimraf": "^3.0.2",
"rxjs-spy": "^7.5.3",
"rxjs-spy": "^8.0.2",
"sass": "~1.32.6",
"sass-loader": "^12.6.0",
"sass-resources-loader": "^2.1.1",
@@ -210,4 +210,4 @@
"webpack-cli": "^4.2.0",
"webpack-dev-server": "^4.5.0"
}
}
}

21
src/app/admin/admin-import-metadata-page/metadata-import-page.component.html
View File

@@ -1,6 +1,17 @@
<div class="container">
<h2 id="header">{{'admin.metadata-import.page.header' | translate}}</h2>
<p>{{'admin.metadata-import.page.help' | translate}}</p>
<div class="form-group">
<div class="form-check">
<input class="form-check-input" type="checkbox" id="validateOnly" [(ngModel)]="validateOnly">
<label class="form-check-label" for="validateOnly">
{{'admin.metadata-import.page.validateOnly' | translate}}
</label>
</div>
<small id="validateOnlyHelpBlock" class="form-text text-muted">
{{'admin.metadata-import.page.validateOnly.hint' | translate}}
</small>
</div>
<ds-file-dropzone-no-uploader
(onFileAdded)="setFile($event)"
@@ -8,8 +19,10 @@
[dropMessageLabelReplacement]="'admin.metadata-import.page.dropMsgReplace'">
</ds-file-dropzone-no-uploader>
<button class="btn btn-secondary" id="backButton"
(click)="this.onReturn();">{{'admin.metadata-import.page.button.return' | translate}}</button>
<button class="btn btn-primary" id="proceedButton"
(click)="this.importMetadata();">{{'admin.metadata-import.page.button.proceed' | translate}}</button>
<div class="space-children-mr">
<button class="btn btn-secondary" id="backButton"
(click)="this.onReturn();">{{'admin.metadata-import.page.button.return' | translate}}</button>
<button class="btn btn-primary" id="proceedButton"
(click)="this.importMetadata();">{{'admin.metadata-import.page.button.proceed' | translate}}</button>
</div>
</div>

25
src/app/admin/admin-import-metadata-page/metadata-import-page.component.spec.ts
View File

@@ -87,8 +87,9 @@ describe('MetadataImportPageComponent', () => {
comp.setFile(fileMock);
});
describe('if proceed button is pressed', () => {
describe('if proceed button is pressed without validate only', () => {
beforeEach(fakeAsync(() => {
comp.validateOnly = false;
const proceed = fixture.debugElement.query(By.css('#proceedButton')).nativeElement;
proceed.click();
fixture.detectChanges();
@@ -107,6 +108,28 @@ describe('MetadataImportPageComponent', () => {
});
});
describe('if proceed button is pressed with validate only', () => {
beforeEach(fakeAsync(() => {
comp.validateOnly = true;
const proceed = fixture.debugElement.query(By.css('#proceedButton')).nativeElement;
proceed.click();
fixture.detectChanges();
}));
it('metadata-import script is invoked with -f fileName and the mockFile and -v validate-only', () => {
const parameterValues: ProcessParameter[] = [
Object.assign(new ProcessParameter(), { name: '-f', value: 'filename.txt' }),
Object.assign(new ProcessParameter(), { name: '-v', value: true }),
];
expect(scriptService.invoke).toHaveBeenCalledWith(METADATA_IMPORT_SCRIPT_NAME, parameterValues, [fileMock]);
});
it('success notification is shown', () => {
expect(notificationService.success).toHaveBeenCalled();
});
it('redirected to process page', () => {
expect(router.navigateByUrl).toHaveBeenCalledWith('/processes/45');
});
});
describe('if proceed is pressed; but script invoke fails', () => {
beforeEach(fakeAsync(() => {
jasmine.getEnv().allowRespy(true);

8
src/app/admin/admin-import-metadata-page/metadata-import-page.component.ts
View File

@@ -30,6 +30,11 @@ export class MetadataImportPageComponent {
*/
fileObject: File;
/**
* The validate only flag
*/
validateOnly = true;
public constructor(private location: Location,
protected translate: TranslateService,
protected notificationsService: NotificationsService,
@@ -62,6 +67,9 @@ export class MetadataImportPageComponent {
const parameterValues: ProcessParameter[] = [
Object.assign(new ProcessParameter(), { name: '-f', value: this.fileObject.name }),
];
if (this.validateOnly) {
parameterValues.push(Object.assign(new ProcessParameter(), { name: '-v', value: true }));
}
this.scriptDataService.invoke(METADATA_IMPORT_SCRIPT_NAME, parameterValues, [this.fileObject]).pipe(
getFirstCompletedRemoteData(),

9
src/app/admin/admin-search-page/admin-search-results/admin-search-result-grid-element/item-search-result/item-admin-search-result-grid-element.component.spec.ts
View File

@@ -18,6 +18,8 @@ import { ItemAdminSearchResultGridElementComponent } from './item-admin-search-r
import { createSuccessfulRemoteDataObject$ } from '../../../../../shared/remote-data.utils';
import { getMockThemeService } from '../../../../../shared/mocks/theme-service.mock';
import { ThemeService } from '../../../../../shared/theme-support/theme.service';
import { AccessStatusDataService } from 'src/app/core/data/access-status-data.service';
import { AccessStatusObject } from 'src/app/shared/object-list/access-status-badge/access-status.model';
describe('ItemAdminSearchResultGridElementComponent', () => {
let component: ItemAdminSearchResultGridElementComponent;
@@ -31,6 +33,12 @@ describe('ItemAdminSearchResultGridElementComponent', () => {
}
};
const mockAccessStatusDataService = {
findAccessStatusFor(item: Item): Observable<RemoteData<AccessStatusObject>> {
return createSuccessfulRemoteDataObject$(new AccessStatusObject());
}
};
const mockThemeService = getMockThemeService();
function init() {
@@ -55,6 +63,7 @@ describe('ItemAdminSearchResultGridElementComponent', () => {
{ provide: TruncatableService, useValue: mockTruncatableService },
{ provide: BitstreamDataService, useValue: mockBitstreamDataService },
{ provide: ThemeService, useValue: mockThemeService },
{ provide: AccessStatusDataService, useValue: mockAccessStatusDataService },
],
schemas: [NO_ERRORS_SCHEMA]
})

6
src/app/app-routing-paths.ts
View File

@@ -70,6 +70,12 @@ export function getWorkflowItemModuleRoute() {
return `/${WORKFLOW_ITEM_MODULE_PATH}`;
}
export const WORKSPACE_ITEM_MODULE_PATH = 'workspaceitems';
export function getWorkspaceItemModuleRoute() {
return `/${WORKSPACE_ITEM_MODULE_PATH}`;
}
export function getDSORoute(dso: DSpaceObject): string {
if (hasValue(dso)) {
switch ((dso as any).type) {

2
src/app/app.component.spec.ts
View File

@@ -4,7 +4,7 @@ import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { CommonModule, DOCUMENT } from '@angular/common';
import { ActivatedRoute, Router } from '@angular/router';
import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
import { Angulartics2GoogleAnalytics } from 'angulartics2';
// Load the implementations that should be tested
import { AppComponent } from './app.component';

2
src/app/app.component.ts
View File

@@ -23,7 +23,7 @@ import { BehaviorSubject, Observable, of } from 'rxjs';
import { select, Store } from '@ngrx/store';
import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
import { TranslateService } from '@ngx-translate/core';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
import { Angulartics2GoogleAnalytics } from 'angulartics2';
import { MetadataService } from './core/metadata/metadata.service';
import { HostWindowResizeAction } from './shared/host-window.actions';

14
src/app/bitstream-page/bitstream-page-routing.module.ts
View File

@@ -10,6 +10,9 @@ import { ResourcePolicyResolver } from '../shared/resource-policies/resolvers/re
import { ResourcePolicyEditComponent } from '../shared/resource-policies/edit/resource-policy-edit.component';
import { BitstreamAuthorizationsComponent } from './bitstream-authorizations/bitstream-authorizations.component';
import { LegacyBitstreamUrlResolver } from './legacy-bitstream-url.resolver';
import { BitstreamBreadcrumbResolver } from '../core/breadcrumbs/bitstream-breadcrumb.resolver';
import { BitstreamBreadcrumbsService } from '../core/breadcrumbs/bitstream-breadcrumbs.service';
import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver';
const EDIT_BITSTREAM_PATH = ':id/edit';
const EDIT_BITSTREAM_AUTHORIZATIONS_PATH = ':id/authorizations';
@@ -48,7 +51,8 @@ const EDIT_BITSTREAM_AUTHORIZATIONS_PATH = ':id/authorizations';
path: EDIT_BITSTREAM_PATH,
component: EditBitstreamPageComponent,
resolve: {
bitstream: BitstreamPageResolver
bitstream: BitstreamPageResolver,
breadcrumb: BitstreamBreadcrumbResolver,
},
canActivate: [AuthenticatedGuard]
},
@@ -67,15 +71,17 @@ const EDIT_BITSTREAM_AUTHORIZATIONS_PATH = ':id/authorizations';
{
path: 'edit',
resolve: {
breadcrumb: I18nBreadcrumbResolver,
resourcePolicy: ResourcePolicyResolver
},
component: ResourcePolicyEditComponent,
data: { title: 'resource-policies.edit.page.title', showBreadcrumbs: true }
data: { breadcrumbKey: 'item.edit', title: 'resource-policies.edit.page.title', showBreadcrumbs: true }
},
{
path: '',
resolve: {
bitstream: BitstreamPageResolver
bitstream: BitstreamPageResolver,
breadcrumb: BitstreamBreadcrumbResolver,
},
component: BitstreamAuthorizationsComponent,
data: { title: 'bitstream.edit.authorizations.title', showBreadcrumbs: true }
@@ -86,6 +92,8 @@ const EDIT_BITSTREAM_AUTHORIZATIONS_PATH = ':id/authorizations';
],
providers: [
BitstreamPageResolver,
BitstreamBreadcrumbResolver,
BitstreamBreadcrumbsService
]
})
export class BitstreamPageRoutingModule {

14
src/app/bitstream-page/bitstream-page.resolver.ts
View File

@@ -7,6 +7,15 @@ import { BitstreamDataService } from '../core/data/bitstream-data.service';
import { followLink, FollowLinkConfig } from '../shared/utils/follow-link-config.model';
import { getFirstCompletedRemoteData } from '../core/shared/operators';
/**
* The self links defined in this list are expected to be requested somewhere in the near future
* Requesting them as embeds will limit the number of requests
*/
export const BITSTREAM_PAGE_LINKS_TO_FOLLOW: FollowLinkConfig<Bitstream>[] = [
followLink('bundle', {}, followLink('item')),
followLink('format')
];
/**
* This class represents a resolver that requests a specific bitstream before the route is activated
*/
@@ -34,9 +43,6 @@ export class BitstreamPageResolver implements Resolve<RemoteData<Bitstream>> {
* Requesting them as embeds will limit the number of requests
*/
get followLinks(): FollowLinkConfig<Bitstream>[] {
return [
followLink('bundle', {}, followLink('item')),
followLink('format')
];
return BITSTREAM_PAGE_LINKS_TO_FOLLOW;
}
}

8
src/app/browse-by/browse-by-metadata-page/browse-by-metadata-page.component.html
View File

@@ -24,7 +24,13 @@
<section class="comcol-page-browse-section">
<div class="browse-by-metadata w-100">
<ds-browse-by *ngIf="startsWithOptions" class="col-xs-12 w-100"
title="{{'browse.title' | translate:{collection: (parent$ | async)?.payload?.name || '', field: 'browse.metadata.' + browseId | translate, value: (value)? '&quot;' + value + '&quot;': ''} }}"
title="{{'browse.title' | translate:
{
collection: (parent$ | async)?.payload?.name || '',
field: 'browse.metadata.' + browseId | translate,
startsWith: (startsWith)? ('browse.startsWith' | translate: { startsWith: '&quot;' + startsWith + '&quot;' }) : '',
value: (value)? '&quot;' + value + '&quot;': ''
} }}"
parentname="{{(parent$ | async)?.payload?.name || ''}}"
[objects$]="(items$ !== undefined)? items$ : browseEntries$"
[paginationConfig]="(currentPagination$ |async)"

2
src/app/browse-by/browse-by-routing.module.ts
View File

@@ -17,7 +17,7 @@ import { ThemedBrowseBySwitcherComponent } from './browse-by-switcher/themed-bro
component: ThemedBrowseBySwitcherComponent,
canActivate: [BrowseByGuard],
resolve: { breadcrumb: BrowseByI18nBreadcrumbResolver },
data: { title: 'browse.title', breadcrumbKey: 'browse.metadata' }
data: { title: 'browse.title.page', breadcrumbKey: 'browse.metadata' }
}
]
}])

1
src/app/browse-by/browse-by-title-page/browse-by-title-page.component.ts
View File

@@ -45,6 +45,7 @@ export class BrowseByTitlePageComponent extends BrowseByMetadataPageComponent {
return [Object.assign({}, routeParams, queryParams),currentPage,currentSort];
})
).subscribe(([params, currentPage, currentSort]: [Params, PaginationComponentOptions, SortOptions]) => {
this.startsWith = +params.startsWith || params.startsWith;
this.browseId = params.id || this.defaultBrowseId;
this.updatePageWithItems(browseParamsToOptions(params, currentPage, currentSort, this.browseId), undefined, undefined);
this.updateParent(params.scope);

7
src/app/collection-page/collection-page.component.html
View File

@@ -1,8 +1,8 @@
<div class="container">
<div class="collection-page"
*ngVar="(collectionRD$ | async) as collectionRD">
<div *ngIf="collectionRD?.hasSucceeded" @fadeInOut>
<div *ngIf="collectionRD?.payload as collection">
<div *ngIf="collectionRD?.hasSucceeded" @fadeInOut>
<div *ngIf="collectionRD?.payload as collection">
<ds-view-tracker [object]="collection"></ds-view-tracker>
<div class="d-flex flex-row border-bottom mb-4 pb-4">
<header class="comcol-header mr-auto">
@@ -13,8 +13,7 @@
<!-- Collection logo -->
<ds-comcol-page-logo *ngIf="logoRD$"
[logo]="(logoRD$ | async)?.payload"
[alternateText]="'Collection Logo'"
[alternateText]="'Collection Logo'">
[alternateText]="'Collection Logo'">
</ds-comcol-page-logo>
<!-- Handle -->

2
src/app/collection-page/themed-collection-page.component.ts
View File

@@ -6,7 +6,7 @@ import { CollectionPageComponent } from './collection-page.component';
* Themed wrapper for CollectionPageComponent
*/
@Component({
selector: 'ds-themed-community-page',
selector: 'ds-themed-collection-page',
styleUrls: [],
templateUrl: '../shared/theme-support/themed.component.html',
})

31
src/app/core/breadcrumbs/bitstream-breadcrumb.resolver.ts Normal file
View File

@@ -0,0 +1,31 @@
import { Injectable } from '@angular/core';
import { FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
import { Bitstream } from '../shared/bitstream.model';
import { BitstreamDataService } from '../data/bitstream-data.service';
import { BITSTREAM_PAGE_LINKS_TO_FOLLOW } from '../../bitstream-page/bitstream-page.resolver';
import { DSOBreadcrumbResolver } from './dso-breadcrumb.resolver';
import { BitstreamBreadcrumbsService } from './bitstream-breadcrumbs.service';
/**
* The class that resolves the BreadcrumbConfig object for an Item
*/
@Injectable({
providedIn: 'root'
})
export class BitstreamBreadcrumbResolver extends DSOBreadcrumbResolver<Bitstream> {
constructor(
protected breadcrumbService: BitstreamBreadcrumbsService, protected dataService: BitstreamDataService) {
super(breadcrumbService, dataService);
}
/**
* Method that returns the follow links to already resolve
* The self links defined in this list are expected to be requested somewhere in the near future
* Requesting them as embeds will limit the number of requests
*/
get followLinks(): FollowLinkConfig<Bitstream>[] {
return BITSTREAM_PAGE_LINKS_TO_FOLLOW;
}
}

85
src/app/core/breadcrumbs/bitstream-breadcrumbs.service.ts Normal file
View File

@@ -0,0 +1,85 @@
import { Injectable } from '@angular/core';
import { Observable, of as observableOf } from 'rxjs';
import { map, switchMap } from 'rxjs/operators';
import { Breadcrumb } from '../../breadcrumbs/breadcrumb/breadcrumb.model';
import { DSONameService } from './dso-name.service';
import { ChildHALResource } from '../shared/child-hal-resource.model';
import { LinkService } from '../cache/builders/link.service';
import { DSpaceObject } from '../shared/dspace-object.model';
import { RemoteData } from '../data/remote-data';
import { hasValue, isNotEmpty } from '../../shared/empty.util';
import { getDSORoute } from '../../app-routing-paths';
import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
import { BitstreamDataService } from '../data/bitstream-data.service';
import { getFirstCompletedRemoteData, getRemoteDataPayload } from '../shared/operators';
import { Bitstream } from '../shared/bitstream.model';
import { Bundle } from '../shared/bundle.model';
import { Item } from '../shared/item.model';
import { BITSTREAM_PAGE_LINKS_TO_FOLLOW } from '../../bitstream-page/bitstream-page.resolver';
/**
* Service to calculate DSpaceObject breadcrumbs for a single part of the route
*/
@Injectable({
providedIn: 'root'
})
export class BitstreamBreadcrumbsService extends DSOBreadcrumbsService {
constructor(
protected bitstreamService: BitstreamDataService,
protected linkService: LinkService,
protected dsoNameService: DSONameService
) {
super(linkService, dsoNameService);
}
/**
* Method to recursively calculate the breadcrumbs
* This method returns the name and url of the key and all its parent DSOs recursively, top down
* @param key The key (a DSpaceObject) used to resolve the breadcrumb
* @param url The url to use as a link for this breadcrumb
*/
getBreadcrumbs(key: ChildHALResource & DSpaceObject, url: string): Observable<Breadcrumb[]> {
const label = this.dsoNameService.getName(key);
const crumb = new Breadcrumb(label, url);
return this.getOwningItem(key.uuid).pipe(
switchMap((parentRD: RemoteData<ChildHALResource & DSpaceObject>) => {
if (isNotEmpty(parentRD) && hasValue(parentRD.payload)) {
const parent = parentRD.payload;
return super.getBreadcrumbs(parent, getDSORoute(parent));
}
return observableOf([]);
}),
map((breadcrumbs: Breadcrumb[]) => [...breadcrumbs, crumb])
);
}
getOwningItem(uuid: string): Observable<RemoteData<Item>> {
return this.bitstreamService.findById(uuid, true, true, ...BITSTREAM_PAGE_LINKS_TO_FOLLOW).pipe(
getFirstCompletedRemoteData(),
getRemoteDataPayload(),
switchMap((bitstream: Bitstream) => {
if (hasValue(bitstream)) {
return bitstream.bundle.pipe(
getFirstCompletedRemoteData(),
getRemoteDataPayload(),
switchMap((bundle: Bundle) => {
if (hasValue(bundle)) {
return bundle.item.pipe(
getFirstCompletedRemoteData(),
);
} else {
return observableOf(undefined);
}
})
);
} else {
return observableOf(undefined);
}
})
);
}
}

4
src/app/core/breadcrumbs/dso-breadcrumbs.service.ts
View File

@@ -20,8 +20,8 @@ import { getDSORoute } from '../../app-routing-paths';
})
export class DSOBreadcrumbsService implements BreadcrumbsProviderService<ChildHALResource & DSpaceObject> {
constructor(
private linkService: LinkService,
private dsoNameService: DSONameService
protected linkService: LinkService,
protected dsoNameService: DSONameService
) {
}

8
src/app/core/core.module.ts
View File

@@ -136,6 +136,7 @@ import { SiteAdministratorGuard } from './data/feature-authorization/feature-aut
import { Registration } from './shared/registration.model';
import { MetadataSchemaDataService } from './data/metadata-schema-data.service';
import { MetadataFieldDataService } from './data/metadata-field-data.service';
import { DsDynamicTypeBindRelationService } from '../shared/form/builder/ds-dynamic-form-ui/ds-dynamic-type-bind-relation.service';
import { TokenResponseParsingService } from './auth/token-response-parsing.service';
import { SubmissionCcLicenseDataService } from './submission/submission-cc-license-data.service';
import { SubmissionCcLicence } from './submission/models/submission-cc-license.model';
@@ -162,6 +163,8 @@ import { SequenceService } from './shared/sequence.service';
import { CoreState } from './core-state.model';
import { GroupDataService } from './eperson/group-data.service';
import { SubmissionAccessesModel } from './config/models/config-submission-accesses.model';
import { AccessStatusObject } from '../shared/object-list/access-status-badge/access-status.model';
import { AccessStatusDataService } from './data/access-status-data.service';
/**
* When not in production, endpoint responses can be mocked for testing purposes
@@ -218,6 +221,7 @@ const PROVIDERS = [
MyDSpaceResponseParsingService,
ServerResponseService,
BrowseService,
AccessStatusDataService,
SubmissionCcLicenseDataService,
SubmissionCcLicenseUrlDataService,
SubmissionFormsConfigService,
@@ -248,6 +252,7 @@ const PROVIDERS = [
ClaimedTaskDataService,
PoolTaskDataService,
BitstreamDataService,
DsDynamicTypeBindRelationService,
EntityTypeService,
ContentSourceResponseParsingService,
ItemTemplateDataService,
@@ -344,7 +349,8 @@ export const models =
UsageReport,
Root,
SearchConfig,
SubmissionAccessesModel
SubmissionAccessesModel,
AccessStatusObject
];
@NgModule({

81
src/app/core/data/access-status-data.service.spec.ts Normal file
View File

@@ -0,0 +1,81 @@
import { RequestService } from './request.service';
import { getMockRequestService } from '../../shared/mocks/request.service.mock';
import { HALEndpointServiceStub } from '../../shared/testing/hal-endpoint-service.stub';
import { NotificationsServiceStub } from '../../shared/testing/notifications-service.stub';
import { fakeAsync, tick } from '@angular/core/testing';
import { GetRequest } from './request.models';
import { ObjectCacheService } from '../cache/object-cache.service';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
import { createSuccessfulRemoteDataObject$ } from '../../shared/remote-data.utils';
import { Observable } from 'rxjs';
import { RemoteData } from './remote-data';
import { hasNoValue } from '../../shared/empty.util';
import { AccessStatusDataService } from './access-status-data.service';
import { Item } from '../shared/item.model';
const url = 'fake-url';
describe('AccessStatusDataService', () => {
let service: AccessStatusDataService;
let requestService: RequestService;
let notificationsService: any;
let rdbService: RemoteDataBuildService;
let objectCache: ObjectCacheService;
let halService: any;
const itemId = '8b3c613a-5a4b-438b-9686-be1d5b4a1c5a';
const mockItem: Item = Object.assign(new Item(), {
id: itemId,
name: 'test-item',
_links: {
accessStatus: {
href: `https://rest.api/items/${itemId}/accessStatus`
},
self: {
href: `https://rest.api/items/${itemId}`
}
}
});
describe('when the requests are successful', () => {
beforeEach(() => {
createService();
});
describe('when calling findAccessStatusFor', () => {
let contentSource$;
beforeEach(() => {
contentSource$ = service.findAccessStatusFor(mockItem);
});
it('should send a new GetRequest', fakeAsync(() => {
contentSource$.subscribe();
tick();
expect(requestService.send).toHaveBeenCalledWith(jasmine.any(GetRequest), true);
}));
});
});
/**
* Create an AccessStatusDataService used for testing
* @param reponse$ Supply a RemoteData to be returned by the REST API (optional)
*/
function createService(reponse$?: Observable<RemoteData<any>>) {
requestService = getMockRequestService();
let buildResponse$ = reponse$;
if (hasNoValue(reponse$)) {
buildResponse$ = createSuccessfulRemoteDataObject$({});
}
rdbService = jasmine.createSpyObj('rdbService', {
buildFromRequestUUID: buildResponse$,
buildSingle: buildResponse$
});
objectCache = jasmine.createSpyObj('objectCache', {
remove: jasmine.createSpy('remove')
});
halService = new HALEndpointServiceStub(url);
notificationsService = new NotificationsServiceStub();
service = new AccessStatusDataService(null, halService, null, notificationsService, objectCache, rdbService, requestService, null);
}
});

45
src/app/core/data/access-status-data.service.ts Normal file
View File

@@ -0,0 +1,45 @@
import { HttpClient } from '@angular/common/http';
import { Injectable } from '@angular/core';
import { Store } from '@ngrx/store';
import { NotificationsService } from '../../shared/notifications/notifications.service';
import { dataService } from '../cache/builders/build-decorators';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
import { ObjectCacheService } from '../cache/object-cache.service';
import { HALEndpointService } from '../shared/hal-endpoint.service';
import { DataService } from './data.service';
import { RequestService } from './request.service';
import { DefaultChangeAnalyzer } from './default-change-analyzer.service';
import { CoreState } from '../core-state.model';
import { AccessStatusObject } from 'src/app/shared/object-list/access-status-badge/access-status.model';
import { ACCESS_STATUS } from 'src/app/shared/object-list/access-status-badge/access-status.resource-type';
import { Observable } from 'rxjs';
import { RemoteData } from './remote-data';
import { Item } from '../shared/item.model';
@Injectable()
@dataService(ACCESS_STATUS)
export class AccessStatusDataService extends DataService<AccessStatusObject> {
protected linkPath = 'accessStatus';
constructor(
protected comparator: DefaultChangeAnalyzer<AccessStatusObject>,
protected halService: HALEndpointService,
protected http: HttpClient,
protected notificationsService: NotificationsService,
protected objectCache: ObjectCacheService,
protected rdbService: RemoteDataBuildService,
protected requestService: RequestService,
protected store: Store<CoreState>,
) {
super();
}
/**
* Returns {@link RemoteData} of {@link AccessStatusObject} that is the access status of the given item
* @param item Item we want the access status of
*/
findAccessStatusFor(item: Item): Observable<RemoteData<AccessStatusObject>> {
return this.findByHref(item._links.accessStatus.href);
}
}

9
src/app/core/data/item-data.service.spec.ts
View File

@@ -10,12 +10,13 @@ import { ObjectCacheService } from '../cache/object-cache.service';
import { RestResponse } from '../cache/response.models';
import { ExternalSourceEntry } from '../shared/external-source-entry.model';
import { ItemDataService } from './item-data.service';
import { DeleteRequest, PostRequest } from './request.models';
import { DeleteRequest, GetRequest, PostRequest } from './request.models';
import { RequestService } from './request.service';
import { getMockRemoteDataBuildService } from '../../shared/mocks/remote-data-build.service.mock';
import { CoreState } from '../core-state.model';
import { RequestEntry } from './request-entry.model';
import { FindListOptions } from './find-list-options.model';
import { HALEndpointServiceStub } from 'src/app/shared/testing/hal-endpoint-service.stub';
describe('ItemDataService', () => {
let scheduler: TestScheduler;
@@ -36,13 +37,11 @@ describe('ItemDataService', () => {
}) as RequestService;
const rdbService = getMockRemoteDataBuildService();
const itemEndpoint = 'https://rest.api/core/items';
const itemEndpoint = 'https://rest.api/core';
const store = {} as Store<CoreState>;
const objectCache = {} as ObjectCacheService;
const halEndpointService = jasmine.createSpyObj('halService', {
getEndpoint: observableOf(itemEndpoint)
});
const halEndpointService: any = new HALEndpointServiceStub(itemEndpoint);
const bundleService = jasmine.createSpyObj('bundleService', {
findByHref: {}
});

2
src/app/core/data/version-history-data.service.spec.ts
View File

@@ -151,7 +151,7 @@ describe('VersionHistoryDataService', () => {
describe('when getVersionsEndpoint is called', () => {
it('should return the correct value', () => {
service.getVersionsEndpoint(versionHistoryId).subscribe((res) => {
expect(res).toBe(url + '/versions');
expect(res).toBe(url + '/versionhistories/version-history-id/versions');
});
});
});

16
src/app/core/metadata/metadata.service.spec.ts
View File

@@ -163,6 +163,22 @@ describe('MetadataService', () => {
});
}));
it('route titles should overwrite dso titles', fakeAsync(() => {
(translateService.get as jasmine.Spy).and.returnValues(of('DSpace :: '), of('Translated Route Title'));
(metadataService as any).processRouteChange({
data: {
value: {
dso: createSuccessfulRemoteDataObject(ItemMock),
title: 'route.title.key',
}
}
});
tick();
expect(title.setTitle).toHaveBeenCalledTimes(2);
expect((title.setTitle as jasmine.Spy).calls.argsFor(0)).toEqual(['Test PowerPoint Document']);
expect((title.setTitle as jasmine.Spy).calls.argsFor(1)).toEqual(['DSpace :: Translated Route Title']);
}));
it('other navigation should add title and description', fakeAsync(() => {
(translateService.get as jasmine.Spy).and.returnValues(of('DSpace :: '), of('Dummy Title'), of('This is a dummy item component for testing!'));
(metadataService as any).processRouteChange({

10
src/app/core/metadata/metadata.service.ts
View File

@@ -109,6 +109,11 @@ export class MetadataService {
private processRouteChange(routeInfo: any): void {
this.clearMetaTags();
if (hasValue(routeInfo.data.value.dso) && hasValue(routeInfo.data.value.dso.payload)) {
this.currentObject.next(routeInfo.data.value.dso.payload);
this.setDSOMetaTags();
}
if (routeInfo.data.value.title) {
const titlePrefix = this.translate.get('repository.title.prefix');
const title = this.translate.get(routeInfo.data.value.title, routeInfo.data.value);
@@ -122,11 +127,6 @@ export class MetadataService {
this.addMetaTag('description', translatedDescription);
});
}
if (hasValue(routeInfo.data.value.dso) && hasValue(routeInfo.data.value.dso.payload)) {
this.currentObject.next(routeInfo.data.value.dso.payload);
this.setDSOMetaTags();
}
}
private getCurrentRoute(route: ActivatedRoute): ActivatedRoute {

2
src/app/core/pagination/pagination.service.ts
View File

@@ -7,8 +7,8 @@ import { filter, map, take } from 'rxjs/operators';
import { SortDirection, SortOptions } from '../cache/models/sort-options.model';
import { hasValue, isEmpty, isNotEmpty } from '../../shared/empty.util';
import { difference } from '../../shared/object.util';
import { isNumeric } from 'rxjs/internal-compatibility';
import { FindListOptions } from '../data/find-list-options.model';
import { isNumeric } from '../../shared/numeric.util';
@Injectable({
providedIn: 'root',

8
src/app/core/shared/bitstream.model.ts
View File

@@ -7,13 +7,13 @@ import { BITSTREAM_FORMAT } from './bitstream-format.resource-type';
import { BITSTREAM } from './bitstream.resource-type';
import { DSpaceObject } from './dspace-object.model';
import { HALLink } from './hal-link.model';
import { HALResource } from './hal-resource.model';
import {BUNDLE} from './bundle.resource-type';
import {Bundle} from './bundle.model';
import { ChildHALResource } from './child-hal-resource.model';
@typedObject
@inheritSerialization(DSpaceObject)
export class Bitstream extends DSpaceObject implements HALResource {
export class Bitstream extends DSpaceObject implements ChildHALResource {
static type = BITSTREAM;
/**
@@ -66,4 +66,8 @@ export class Bitstream extends DSpaceObject implements HALResource {
*/
@link(BUNDLE)
bundle?: Observable<RemoteData<Bundle>>;
getParentLinkKey(): keyof this['_links'] {
return 'format';
}
}

6
src/app/core/shared/hal-endpoint.service.spec.ts
View File

@@ -3,7 +3,7 @@ import { getMockRequestService } from '../../shared/mocks/request.service.mock';
import { RequestService } from '../data/request.service';
import { HALEndpointService } from './hal-endpoint.service';
import { EndpointMapRequest } from '../data/request.models';
import { combineLatest as observableCombineLatest, of as observableOf } from 'rxjs';
import { combineLatest as observableCombineLatest, Observable, of as observableOf } from 'rxjs';
import { environment } from '../../../environments/environment';
import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
import { createSuccessfulRemoteDataObject$ } from '../../shared/remote-data.utils';
@@ -162,9 +162,9 @@ describe('HALEndpointService', () => {
return observableOf(endpointMaps[param]);
});
observableCombineLatest([
observableCombineLatest<string[]>([
(service as any).getEndpointAt(start, 'one'),
(service as any).getEndpointAt(start, 'one', 'two')
(service as any).getEndpointAt(start, 'one', 'two'),
]).subscribe(([endpoint1, endpoint2]) => {
expect(endpoint1).toEqual(one);
expect(endpoint2).toEqual(two);

10
src/app/core/shared/item.model.ts
View File

@@ -21,6 +21,8 @@ import { Version } from './version.model';
import { VERSION } from './version.resource-type';
import { BITSTREAM } from './bitstream.resource-type';
import { Bitstream } from './bitstream.model';
import { ACCESS_STATUS } from 'src/app/shared/object-list/access-status-badge/access-status.resource-type';
import { AccessStatusObject } from 'src/app/shared/object-list/access-status-badge/access-status.model';
/**
* Class representing a DSpace Item
@@ -72,6 +74,7 @@ export class Item extends DSpaceObject implements ChildHALResource {
templateItemOf: HALLink;
version: HALLink;
thumbnail: HALLink;
accessStatus: HALLink;
self: HALLink;
};
@@ -110,6 +113,13 @@ export class Item extends DSpaceObject implements ChildHALResource {
@link(BITSTREAM, false, 'thumbnail')
thumbnail?: Observable<RemoteData<Bitstream>>;
/**
* The access status for this Item
* Will be undefined unless the access status {@link HALLink} has been resolved.
*/
@link(ACCESS_STATUS)
accessStatus?: Observable<RemoteData<AccessStatusObject>>;
/**
* Method that returns as which type of object this object should be rendered
*/

15
src/app/core/shared/operators.ts
View File

@@ -1,5 +1,5 @@
import { combineLatest as observableCombineLatest, Observable } from 'rxjs';
import { debounceTime, filter, find, map, switchMap, take, takeWhile } from 'rxjs/operators';
import { combineLatest as observableCombineLatest, Observable, interval } from 'rxjs';
import { filter, find, map, switchMap, take, takeWhile, debounce, debounceTime } from 'rxjs/operators';
import { hasNoValue, hasValue, hasValueOperator, isNotEmpty } from '../../shared/empty.util';
import { SearchResult } from '../../shared/search/models/search-result.model';
import { PaginatedList } from '../data/paginated-list.model';
@@ -9,6 +9,17 @@ import { MetadataSchema } from '../metadata/metadata-schema.model';
import { BrowseDefinition } from './browse-definition.model';
import { DSpaceObject } from './dspace-object.model';
import { InjectionToken } from '@angular/core';
import { MonoTypeOperatorFunction, SchedulerLike } from 'rxjs/internal/types';
/**
* Use this method instead of the RxJs debounceTime if you're waiting for debouncing in tests;
* debounceTime doesn't work with fakeAsync/tick anymore as of Angular 13.2.6 & RxJs 7.5.5
* Workaround suggested in https://github.com/angular/angular/issues/44351#issuecomment-1107454054
* todo: remove once the above issue is fixed
*/
export const debounceTimeWorkaround = <T>(dueTime: number, scheduler?: SchedulerLike): MonoTypeOperatorFunction<T> => {
return debounce(() => interval(dueTime, scheduler));
};
export const DEBOUNCE_TIME_OPERATOR = new InjectionToken<<T>(dueTime: number) => (source: Observable<T>) => Observable<T>>('debounceTime', {
providedIn: 'root',

43
src/app/core/submission/resolver/submission-object.resolver.ts Normal file
View File

@@ -0,0 +1,43 @@
import { DSpaceObject } from './../../shared/dspace-object.model';
import { followLink } from './../../../shared/utils/follow-link-config.model';
import { ChildHALResource } from './../../shared/child-hal-resource.model';
import { Injectable } from '@angular/core';
import { ActivatedRouteSnapshot, Resolve, RouterStateSnapshot } from '@angular/router';
import { Observable } from 'rxjs';
import { Store } from '@ngrx/store';
import { switchMap } from 'rxjs/operators';
import { DataService } from '../../data/data.service';
import { RemoteData } from '../../data/remote-data';
import { getFirstCompletedRemoteData } from '../../shared/operators';
/**
* This class represents a resolver that requests a specific item before the route is activated
*/
@Injectable()
export class SubmissionObjectResolver<T> implements Resolve<RemoteData<T>> {
constructor(
protected dataService: DataService<any>,
protected store: Store<any>
) {
}
/**
* Method for resolving an item based on the parameters in the current route
* @param {ActivatedRouteSnapshot} route The current ActivatedRouteSnapshot
* @param {RouterStateSnapshot} state The current RouterStateSnapshot
* @returns Observable<<RemoteData<Item>> Emits the found item based on the parameters in the current route,
* or an error if something went wrong
*/
resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<RemoteData<T>> {
const itemRD$ = this.dataService.findById(route.params.id,
true,
false,
followLink('item'),
).pipe(
getFirstCompletedRemoteData(),
switchMap((wfiRD: RemoteData<any>) => wfiRD.payload.item as Observable<RemoteData<T>>),
getFirstCompletedRemoteData()
);
return itemRD$;
}
}

28
src/app/item-page/full/full-item-page.component.html
View File

@@ -12,26 +12,28 @@
[tooltipMsg]="'item.page.edit'"></ds-dso-page-edit-button>
</div>
</div>
<div class="simple-view-link my-3" *ngIf="!fromWfi">
<div class="simple-view-link my-3" *ngIf="!fromSubmissionObject">
<a class="btn btn-outline-primary" [routerLink]="[(itemPageRoute$ | async)]">
{{"item.page.link.simple" | translate}}
</a>
</div>
<table class="table table-responsive table-striped">
<tbody>
<ng-container *ngFor="let mdEntry of (metadata$ | async) | keyvalue">
<tr *ngFor="let mdValue of mdEntry.value">
<td>{{mdEntry.key}}</td>
<td>{{mdValue.value}}</td>
<td>{{mdValue.language}}</td>
</tr>
</ng-container>
</tbody>
</table>
<div class="table-responsive">
<table class="table table-striped">
<tbody>
<ng-container *ngFor="let mdEntry of (metadata$ | async) | keyvalue">
<tr *ngFor="let mdValue of mdEntry.value">
<td>{{mdEntry.key}}</td>
<td>{{mdValue.value}}</td>
<td>{{mdValue.language}}</td>
</tr>
</ng-container>
</tbody>
</table>
</div>
<ds-item-page-full-file-section [item]="item"></ds-item-page-full-file-section>
<ds-item-page-collections [item]="item"></ds-item-page-collections>
<ds-item-versions class="mt-2" [item]="item"></ds-item-versions>
<div class="button-row bottom" *ngIf="fromWfi">
<div class="button-row bottom" *ngIf="fromSubmissionObject">
<div class="text-right">
<button class="btn btn-outline-secondary mr-1" (click)="back()"><i
class="fas fa-arrow-left"></i> {{'item.page.return' | translate}}</button>

4
src/app/item-page/full/full-item-page.component.spec.ts
View File

@@ -112,7 +112,7 @@ describe('FullItemPageComponent', () => {
});
it('should show simple view button when not originated from workflow item', () => {
expect(comp.fromWfi).toBe(false);
expect(comp.fromSubmissionObject).toBe(false);
const simpleViewBtn = fixture.debugElement.query(By.css('.simple-view-link'));
expect(simpleViewBtn).toBeTruthy();
});
@@ -122,7 +122,7 @@ describe('FullItemPageComponent', () => {
comp.ngOnInit();
fixture.detectChanges();
fixture.whenStable().then(() => {
expect(comp.fromWfi).toBe(true);
expect(comp.fromSubmissionObject).toBe(true);
const simpleViewBtn = fixture.debugElement.query(By.css('.simple-view-link'));
expect(simpleViewBtn).toBeFalsy();
});

8
src/app/item-page/full/full-item-page.component.ts
View File

@@ -2,7 +2,7 @@ import { filter, map } from 'rxjs/operators';
import { ChangeDetectionStrategy, Component, OnDestroy, OnInit } from '@angular/core';
import { ActivatedRoute, Data, Router } from '@angular/router';
import { Observable , BehaviorSubject } from 'rxjs';
import { BehaviorSubject, Observable } from 'rxjs';
import { ItemPageComponent } from '../simple/item-page.component';
import { MetadataMap } from '../../core/shared/metadata.models';
@@ -37,9 +37,9 @@ export class FullItemPageComponent extends ItemPageComponent implements OnInit,
metadata$: Observable<MetadataMap>;
/**
* True when the itemRD has been originated from its workflowitem, false otherwise.
* True when the itemRD has been originated from its workspaceite/workflowitem, false otherwise.
*/
fromWfi = false;
fromSubmissionObject = false;
subs = [];
@@ -61,7 +61,7 @@ export class FullItemPageComponent extends ItemPageComponent implements OnInit,
map((item: Item) => item.metadata),);
this.subs.push(this.route.data.subscribe((data: Data) => {
this.fromWfi = hasValue(data.wfi);
this.fromSubmissionObject = hasValue(data.wfi) || hasValue(data.wsi);
})
);
}

3
src/app/profile-page/profile-page-security-form/profile-page-security-form.component.ts
View File

@@ -5,8 +5,9 @@ import { FormGroup } from '@angular/forms';
import { hasValue, isEmpty } from '../../shared/empty.util';
import { EPersonDataService } from '../../core/eperson/eperson-data.service';
import { NotificationsService } from '../../shared/notifications/notifications.service';
import { debounceTime, map } from 'rxjs/operators';
import { map } from 'rxjs/operators';
import { Subscription } from 'rxjs';
import { debounceTimeWorkaround as debounceTime } from '../../core/shared/operators';
@Component({
selector: 'ds-profile-page-security-form',

2
src/app/root/root.component.spec.ts
View File

@@ -9,7 +9,7 @@ import { TranslateLoaderMock } from '../shared/mocks/translate-loader.mock';
import { NativeWindowRef, NativeWindowService } from '../core/services/window.service';
import { MetadataService } from '../core/metadata/metadata.service';
import { MetadataServiceMock } from '../shared/mocks/metadata-service.mock';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
import { Angulartics2GoogleAnalytics } from 'angulartics2';
import { AngularticsProviderMock } from '../shared/mocks/angulartics-provider.service.mock';
import { Angulartics2DSpace } from '../statistics/angulartics/dspace-provider';
import { AuthService } from '../core/auth/auth.service';

2
src/app/root/root.component.ts
View File

@@ -5,7 +5,7 @@ import { Router } from '@angular/router';
import { combineLatest as combineLatestObservable, Observable, of } from 'rxjs';
import { Store } from '@ngrx/store';
import { TranslateService } from '@ngx-translate/core';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
import { Angulartics2GoogleAnalytics } from 'angulartics2';
import { MetadataService } from '../core/metadata/metadata.service';
import { HostWindowState } from '../shared/search/host-window.reducer';

12
src/app/shared/browse-by/browse-by.component.html
View File

@@ -2,6 +2,9 @@
<h3 [ngClass]="{'sr-only': parentname }">{{title | translate}}</h3>
<ng-container *ngComponentOutlet="getStartsWithComponent(); injector: objectInjector;"></ng-container>
<div *ngIf="objects?.hasSucceeded && !objects?.isLoading && objects?.payload?.page.length > 0" @fadeIn>
<div *ngIf="shouldDisplayResetButton$ |async" class="mb-2 reset">
<button class="btn btn-secondary" (click)="back()"><i class="fas fa-arrow-left"></i> {{'browse.back.all-results' | translate}}</button>
</div>
<ds-viewable-collection
[config]="paginationConfig"
[sortConfig]="sortConfig"
@@ -13,8 +16,13 @@
</div>
<ds-loading *ngIf="!objects || objects?.isLoading" message="{{'loading.browse-by' | translate}}"></ds-loading>
<ds-error *ngIf="objects?.hasFailed" message="{{'error.browse-by' | translate}}"></ds-error>
<div *ngIf="!objects?.isLoading && objects?.payload?.page.length === 0" class="alert alert-info w-100" role="alert">
{{'browse.empty' | translate}}
<div *ngIf="!objects?.isLoading && objects?.payload?.page.length === 0">
<div *ngIf="shouldDisplayResetButton$ |async" class="d-inline-block mb-4 reset">
<button class="btn btn-secondary" (click)="back()"><i class="fas fa-arrow-left"></i> {{'browse.back.all-results' | translate}}</button>
</div>
<div class="alert alert-info w-100" role="alert">
{{'browse.empty' | translate}}
</div>
</div>
</ng-container>

36
src/app/shared/browse-by/browse-by.component.spec.ts
View File

@@ -18,9 +18,13 @@ import { createSuccessfulRemoteDataObject$ } from '../remote-data.utils';
import { PaginationService } from '../../core/pagination/pagination.service';
import { PaginationServiceStub } from '../testing/pagination-service.stub';
import { FindListOptions } from '../../core/data/find-list-options.model';
import { ListableObjectComponentLoaderComponent } from '../object-collection/shared/listable-object/listable-object-component-loader.component';
import {
ListableObjectComponentLoaderComponent
} from '../object-collection/shared/listable-object/listable-object-component-loader.component';
import { ViewMode } from '../../core/shared/view-mode.model';
import { BrowseEntryListElementComponent } from '../object-list/browse-entry-list-element/browse-entry-list-element.component';
import {
BrowseEntryListElementComponent
} from '../object-list/browse-entry-list-element/browse-entry-list-element.component';
import {
DEFAULT_CONTEXT,
listableObjectComponent,
@@ -31,6 +35,8 @@ import { ThemeService } from '../theme-support/theme.service';
import { SelectableListService } from '../object-list/selectable-list/selectable-list.service';
import { HostWindowServiceStub } from '../testing/host-window-service.stub';
import { HostWindowService } from '../host-window.service';
import { RouteService } from '../../core/services/route.service';
import { routeServiceStub } from '../testing/route-service.stub';
import SpyObj = jasmine.SpyObj;
@listableObjectComponent(BrowseEntry, ViewMode.ListElement, DEFAULT_CONTEXT, 'custom')
@@ -100,6 +106,7 @@ describe('BrowseByComponent', () => {
{ provide: PaginationService, useValue: paginationService },
{ provide: MockThemedBrowseEntryListElementComponent },
{ provide: ThemeService, useValue: themeService },
{provide: RouteService, useValue: routeServiceStub},
{ provide: SelectableListService, useValue: {} },
{ provide: HostWindowService, useValue: new HostWindowServiceStub(800) },
],
@@ -110,6 +117,8 @@ describe('BrowseByComponent', () => {
beforeEach(() => {
fixture = TestBed.createComponent(BrowseByComponent);
comp = fixture.componentInstance;
comp.paginationConfig = paginationConfig;
fixture.detectChanges();
});
it('should display a loading message when objects is empty', () => {
@@ -193,4 +202,27 @@ describe('BrowseByComponent', () => {
});
});
describe('reset filters button', () => {
it('should not be present when no startsWith or value is present ', () => {
const button = fixture.debugElement.query(By.css('reset'));
expect(button).toBeNull();
});
it('should be present when a startsWith or value is present ', () => {
comp.shouldDisplayResetButton$ = observableOf(true);
fixture.detectChanges();
const button = fixture.debugElement.query(By.css('reset'));
expect(button).toBeDefined();
});
});
describe('back', () => {
it('should navigate back to the main browse page', () => {
comp.back();
expect(paginationService.updateRoute).toHaveBeenCalledWith('test-pagination', {page: 1}, {
value: null,
startsWith: null
});
});
});
});

23
src/app/shared/browse-by/browse-by.component.ts
View File

@@ -4,11 +4,14 @@ import { PaginatedList } from '../../core/data/paginated-list.model';
import { PaginationComponentOptions } from '../pagination/pagination-component-options.model';
import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
import { fadeIn, fadeInOut } from '../animations/fade';
import { Observable } from 'rxjs';
import { combineLatest as observableCombineLatest, Observable } from 'rxjs';
import { ListableObject } from '../object-collection/shared/listable-object.model';
import { getStartsWithComponent, StartsWithType } from '../starts-with/starts-with-decorator';
import { PaginationService } from '../../core/pagination/pagination.service';
import { ViewMode } from '../../core/shared/view-mode.model';
import { RouteService } from '../../core/services/route.service';
import { map } from 'rxjs/operators';
import { hasValue } from '../empty.util';
@Component({
selector: 'ds-browse-by',
@@ -67,7 +70,7 @@ export class BrowseByComponent implements OnInit {
/**
* Whether or not the pagination should be rendered as simple previous and next buttons instead of the normal pagination
*/
@Input() showPaginator = false;
@Input() showPaginator = true;
/**
* It is used to hide or show gear
@@ -104,8 +107,14 @@ export class BrowseByComponent implements OnInit {
*/
public sortDirections = SortDirection;
/**
* Observable that tracks if the back button should be displayed based on the path parameters
*/
shouldDisplayResetButton$: Observable<boolean>;
public constructor(private injector: Injector,
protected paginationService: PaginationService,
private routeService: RouteService,
) {
}
@@ -155,6 +164,16 @@ export class BrowseByComponent implements OnInit {
],
parent: this.injector
});
const startsWith$ = this.routeService.getQueryParameterValue('startsWith');
const value$ = this.routeService.getQueryParameterValue('value');
this.shouldDisplayResetButton$ = observableCombineLatest([startsWith$, value$]).pipe(
map(([startsWith, value]) => hasValue(startsWith) || hasValue(value))
);
}
back() {
this.paginationService.updateRoute(this.paginationConfig.id, {page: 1}, {value: null, startsWith: null});
}
}

2
src/app/shared/dso-selector/dso-selector/dso-selector.component.ts
View File

@@ -143,7 +143,7 @@ export class DSOSelectorComponent implements OnInit, OnDestroy {
this.typesString = this.types.map((type: string) => type.toString().toLowerCase()).join(', ');
// Create an observable searching for the current DSO (return empty list if there's no current DSO)
let currentDSOResult$;
let currentDSOResult$: Observable<PaginatedList<SearchResult<DSpaceObject>>>;
if (isNotEmpty(this.currentDSOId)) {
currentDSOResult$ = this.search(this.getCurrentDSOQuery(), 1).pipe(getFirstSucceededRemoteDataPayload());
} else {

39
src/app/shared/empty.util.spec.ts
View File

@@ -9,7 +9,7 @@ import {
isNotEmptyOperator,
isNotNull,
isNotUndefined,
isNull,
isNull, isObjectEmpty,
isUndefined
} from './empty.util';
@@ -444,6 +444,43 @@ describe('Empty Utils', () => {
});
});
describe('isObjectEmpty', () => {
/*
isObjectEmpty(); // true
isObjectEmpty(null); // true
isObjectEmpty(undefined); // true
isObjectEmpty(''); // true
isObjectEmpty([]); // true
isObjectEmpty({}); // true
isObjectEmpty({name: null}); // true
isObjectEmpty({ name: 'Adam Hawkins', surname : null}); // false
*/
it('should be empty if no parameter passed', () => {
expect(isObjectEmpty()).toBeTrue();
});
it('should be empty if null parameter passed', () => {
expect(isObjectEmpty(null)).toBeTrue();
});
it('should be empty if undefined parameter passed', () => {
expect(isObjectEmpty(undefined)).toBeTrue();
});
it('should be empty if empty string passed', () => {
expect(isObjectEmpty('')).toBeTrue();
});
it('should be empty if empty array passed', () => {
expect(isObjectEmpty([])).toBeTrue();
});
it('should be empty if empty object passed', () => {
expect(isObjectEmpty({})).toBeTrue();
});
it('should be empty if single key with null value passed', () => {
expect(isObjectEmpty({ name: null })).toBeTrue();
});
it('should NOT be empty if object with at least one non-null value passed', () => {
expect(isObjectEmpty({ name: 'Adam Hawkins', surname : null })).toBeFalse();
});
});
describe('ensureArrayHasValue', () => {
it('should let all arrays pass unchanged, and turn everything else in to empty arrays', () => {
const sourceData = {

26
src/app/shared/empty.util.ts
View File

@@ -177,3 +177,29 @@ export const isNotEmptyOperator = () =>
export const ensureArrayHasValue = () =>
<T>(source: Observable<T[]>): Observable<T[]> =>
source.pipe(map((arr: T[]): T[] => Array.isArray(arr) ? arr : []));
/**
* Verifies that a object keys are all empty or not.
* isObjectEmpty(); // true
* isObjectEmpty(null); // true
* isObjectEmpty(undefined); // true
* isObjectEmpty(''); // true
* isObjectEmpty([]); // true
* isObjectEmpty({}); // true
* isObjectEmpty({name: null}); // true
* isObjectEmpty({ name: 'Adam Hawkins', surname : null}); // false
*/
export function isObjectEmpty(obj?: any): boolean {
if (typeof(obj) !== 'object') {
return true;
}
for (const key in obj) {
if (obj.hasOwnProperty(key) && isNotEmpty(obj[key])) {
return false;
}
}
return true;
}

3
src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.html
View File

@@ -1,4 +1,5 @@
<div [class.form-group]="(model.type !== 'GROUP' && asBootstrapFormGroup) || getClass('element', 'container').includes('form-group')"
[class.d-none]="model.hidden"
[formGroup]="group"
[ngClass]="[getClass('element', 'container'), getClass('grid', 'container')]">
<label *ngIf="!isCheckbox && hasLabel"
@@ -6,7 +7,7 @@
[for]="id"
[innerHTML]="(model.required && model.label) ? (model.label | translate) + ' *' : (model.label | translate)"
[ngClass]="[getClass('element', 'label'), getClass('grid', 'label')]"></label>
<ng-container *ngTemplateOutlet="startTemplate?.templateRef; context: model"></ng-container>
<ng-container *ngTemplateOutlet="startTemplate?.templateRef; context: { $implicit: model };"></ng-container>
<!-- Should be *ngIf instead of class d-none, but that breaks the #componentViewContainer reference-->
<div [ngClass]="{'form-row': model.hasLanguages || isRelationship,
'd-none': value?.isVirtual && (model.hasSelectableMetadata || context?.index > 0)}">

21
src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.spec.ts
View File

@@ -25,7 +25,7 @@ import {
DynamicSliderModel,
DynamicSwitchModel,
DynamicTextAreaModel,
DynamicTimePickerModel
DynamicTimePickerModel, MATCH_VISIBLE, OR_OPERATOR
} from '@ng-dynamic-forms/core';
import {
DynamicNGBootstrapCalendarComponent,
@@ -65,6 +65,7 @@ import { DsDynamicFormArrayComponent } from './models/array-group/dynamic-form-a
import { DsDynamicFormGroupComponent } from './models/form-group/dynamic-form-group.component';
import { DsDynamicRelationGroupComponent } from './models/relation-group/dynamic-relation-group.components';
import { DsDatePickerInlineComponent } from './models/date-picker-inline/dynamic-date-picker-inline.component';
import { DsDynamicTypeBindRelationService } from './ds-dynamic-type-bind-relation.service';
import { RelationshipService } from '../../../../core/data/relationship.service';
import { SelectableListService } from '../../../object-list/selectable-list/selectable-list.service';
import { ItemDataService } from '../../../../core/data/item-data.service';
@@ -79,6 +80,14 @@ import { SubmissionService } from '../../../../submission/submission.service';
import { FormBuilderService } from '../form-builder.service';
import { NgxMaskModule } from 'ngx-mask';
function getMockDsDynamicTypeBindRelationService(): DsDynamicTypeBindRelationService {
return jasmine.createSpyObj('DsDynamicTypeBindRelationService', {
getRelatedFormModel: jasmine.createSpy('getRelatedFormModel'),
matchesCondition: jasmine.createSpy('matchesCondition'),
subscribeRelations: jasmine.createSpy('subscribeRelations')
});
}
describe('DsDynamicFormControlContainerComponent test suite', () => {
const vocabularyOptions: VocabularyOptions = {
@@ -111,7 +120,12 @@ describe('DsDynamicFormControlContainerComponent test suite', () => {
metadataFields: [],
repeatable: false,
submissionId: '1234',
hasSelectableMetadata: false
hasSelectableMetadata: false,
typeBindRelations: [{
match: MATCH_VISIBLE,
operator: OR_OPERATOR,
when: [{id: 'dc.type', value: 'Book'}]
}]
}),
new DynamicScrollableDropdownModel({
id: 'scrollableDropdown',
@@ -200,6 +214,7 @@ describe('DsDynamicFormControlContainerComponent test suite', () => {
providers: [
DsDynamicFormControlContainerComponent,
DynamicFormService,
{ provide: DsDynamicTypeBindRelationService, useValue: getMockDsDynamicTypeBindRelationService() },
{ provide: RelationshipService, useValue: {} },
{ provide: SelectableListService, useValue: {} },
{ provide: ItemDataService, useValue: {} },
@@ -231,7 +246,7 @@ describe('DsDynamicFormControlContainerComponent test suite', () => {
});
}));
beforeEach(inject([DynamicFormService], (service: DynamicFormService) => {
beforeEach(inject([DynamicFormService, FormBuilderService], (service: DynamicFormService, formBuilderService: FormBuilderService) => {
formGroup = service.createFormGroup(formModel);

25
src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form-control-container.component.ts
View File

@@ -81,6 +81,7 @@ import { DYNAMIC_FORM_CONTROL_TYPE_CUSTOM_SWITCH } from './models/custom-switch/
import { CustomSwitchComponent } from './models/custom-switch/custom-switch.component';
import { find, map, startWith, switchMap, take } from 'rxjs/operators';
import { combineLatest as observableCombineLatest, Observable, Subscription } from 'rxjs';
import { DsDynamicTypeBindRelationService } from './ds-dynamic-type-bind-relation.service';
import { SearchResult } from '../../../search/models/search-result.model';
import { DSpaceObject } from '../../../../core/shared/dspace-object.model';
import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap';
@@ -194,8 +195,10 @@ export class DsDynamicFormControlContainerComponent extends DynamicFormControlCo
@ContentChildren(DynamicTemplateDirective) contentTemplateList: QueryList<DynamicTemplateDirective>;
// eslint-disable-next-line @angular-eslint/no-input-rename
@Input('templates') inputTemplateList: QueryList<DynamicTemplateDirective>;
@Input() hasMetadataModel: any;
@Input() formId: string;
@Input() formGroup: FormGroup;
@Input() formModel: DynamicFormControlModel[];
@Input() asBootstrapFormGroup = false;
@Input() bindId = true;
@Input() context: any | null = null;
@@ -237,6 +240,7 @@ export class DsDynamicFormControlContainerComponent extends DynamicFormControlCo
protected dynamicFormComponentService: DynamicFormComponentService,
protected layoutService: DynamicFormLayoutService,
protected validationService: DynamicFormValidationService,
protected typeBindRelationService: DsDynamicTypeBindRelationService,
protected translateService: TranslateService,
protected relationService: DynamicFormRelationService,
private modalService: NgbModal,
@@ -343,6 +347,9 @@ export class DsDynamicFormControlContainerComponent extends DynamicFormControlCo
if (this.model && this.model.placeholder) {
this.model.placeholder = this.translateService.instant(this.model.placeholder);
}
if (this.model.typeBindRelations && this.model.typeBindRelations.length > 0) {
this.subscriptions.push(...this.typeBindRelationService.subscribeRelations(this.model, this.control));
}
}
}
@@ -357,6 +364,22 @@ export class DsDynamicFormControlContainerComponent extends DynamicFormControlCo
this.showErrorMessagesPreviousStage = this.showErrorMessages;
}
protected createFormControlComponent(): void {
super.createFormControlComponent();
if (this.componentType !== null) {
let index;
if (this.context && this.context instanceof DynamicFormArrayGroupModel) {
index = this.context.index;
}
const instance = this.dynamicFormComponentService.getFormControlRef(this.model, index);
if (instance) {
(instance as any).formModel = this.formModel;
(instance as any).formGroup = this.formGroup;
}
}
}
/**
* Since Form Control Components created dynamically have 'OnPush' change detection strategy,
* changes are not propagated. So use this method to force an update

1
src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-form.component.html
View File

@@ -3,6 +3,7 @@
[group]="formGroup"
[hasErrorMessaging]="model.hasErrorMessages"
[hidden]="model.hidden"
[class.d-none]="model.hidden"
[layout]="formLayout"
[model]="model"
[templates]="templates"

143
src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-type-bind-relation.service.spec.ts Normal file
View File

@@ -0,0 +1,143 @@
import {inject, TestBed} from '@angular/core/testing';
import {
DynamicFormControlRelation,
DynamicFormRelationService,
MATCH_VISIBLE,
OR_OPERATOR,
HIDDEN_MATCHER,
HIDDEN_MATCHER_PROVIDER, REQUIRED_MATCHER_PROVIDER, DISABLED_MATCHER_PROVIDER,
} from '@ng-dynamic-forms/core';
import {
mockInputWithTypeBindModel, MockRelationModel, mockDcTypeInputModel
} from '../../../mocks/form-models.mock';
import {DsDynamicTypeBindRelationService} from './ds-dynamic-type-bind-relation.service';
import {FormFieldMetadataValueObject} from '../models/form-field-metadata-value.model';
import {FormControl, ReactiveFormsModule} from '@angular/forms';
import {FormBuilderService} from '../form-builder.service';
import {getMockFormBuilderService} from '../../../mocks/form-builder-service.mock';
import {Injector} from '@angular/core';
describe('DSDynamicTypeBindRelationService test suite', () => {
let service: DsDynamicTypeBindRelationService;
let dynamicFormRelationService: DynamicFormRelationService;
let injector: Injector;
beforeEach(() => {
TestBed.configureTestingModule({
imports: [ReactiveFormsModule],
providers: [
{ provide: FormBuilderService, useValue: getMockFormBuilderService() },
{ provide: DsDynamicTypeBindRelationService, useClass: DsDynamicTypeBindRelationService },
{ provide: DynamicFormRelationService },
DISABLED_MATCHER_PROVIDER, HIDDEN_MATCHER_PROVIDER, REQUIRED_MATCHER_PROVIDER
]
}).compileComponents().then();
});
beforeEach(inject([DsDynamicTypeBindRelationService, DynamicFormRelationService],
(relationService: DsDynamicTypeBindRelationService,
formRelationService: DynamicFormRelationService,
) => {
service = relationService;
dynamicFormRelationService = formRelationService;
}));
describe('Test getTypeBindValue method', () => {
it('Should get type bind "boundType" from the given metadata object value', () => {
const mockMetadataValueObject: FormFieldMetadataValueObject = new FormFieldMetadataValueObject(
'boundType', null, null, 'Bound Type'
);
const bindType = service.getTypeBindValue(mockMetadataValueObject);
expect(bindType).toBe('boundType');
});
it('Should get type authority key "bound-auth-key" from the given metadata object value', () => {
const mockMetadataValueObject: FormFieldMetadataValueObject = new FormFieldMetadataValueObject(
'boundType', null, 'bound-auth-key', 'Bound Type'
);
const bindType = service.getTypeBindValue(mockMetadataValueObject);
expect(bindType).toBe('bound-auth-key');
});
it('Should get passed string returned directly as string passed instead of metadata', () => {
const bindType = service.getTypeBindValue('rawString');
expect(bindType).toBe('rawString');
});
it('Should get "undefined" returned directly as no object given', () => {
const bindType = service.getTypeBindValue(undefined);
expect(bindType).toBeUndefined();
});
});
describe('Test getRelatedFormModel method', () => {
it('Should get 0 related form models for simple type bind mock data', () => {
const testModel = MockRelationModel;
const relatedModels = service.getRelatedFormModel(testModel);
expect(relatedModels).toHaveSize(0);
});
it('Should get 1 related form models for mock relation model data', () => {
const testModel = mockInputWithTypeBindModel;
testModel.typeBindRelations = getTypeBindRelations(['boundType']);
const relatedModels = service.getRelatedFormModel(testModel);
expect(relatedModels).toHaveSize(1);
});
});
describe('Test matchesCondition method', () => {
it('Should receive one subscription to dc.type type binding"', () => {
const testModel = mockInputWithTypeBindModel;
testModel.typeBindRelations = getTypeBindRelations(['boundType']);
const dcTypeControl = new FormControl();
dcTypeControl.setValue('boundType');
let subscriptions = service.subscribeRelations(testModel, dcTypeControl);
expect(subscriptions).toHaveSize(1);
});
it('Expect hasMatch to be true (ie. this should be hidden)', () => {
const testModel = mockInputWithTypeBindModel;
testModel.typeBindRelations = getTypeBindRelations(['boundType']);
const dcTypeControl = new FormControl();
dcTypeControl.setValue('boundType');
testModel.typeBindRelations[0].when[0].value = 'anotherType';
const relation = dynamicFormRelationService.findRelationByMatcher((testModel as any).typeBindRelations, HIDDEN_MATCHER);
const matcher = HIDDEN_MATCHER;
if (relation !== undefined) {
const hasMatch = service.matchesCondition(relation, matcher);
matcher.onChange(hasMatch, testModel, dcTypeControl, injector);
expect(hasMatch).toBeTruthy();
}
});
it('Expect hasMatch to be false (ie. this should NOT be hidden)', () => {
const testModel = mockInputWithTypeBindModel;
testModel.typeBindRelations = getTypeBindRelations(['boundType']);
const dcTypeControl = new FormControl();
dcTypeControl.setValue('boundType');
testModel.typeBindRelations[0].when[0].value = 'boundType';
const relation = dynamicFormRelationService.findRelationByMatcher((testModel as any).typeBindRelations, HIDDEN_MATCHER);
const matcher = HIDDEN_MATCHER;
if (relation !== undefined) {
const hasMatch = service.matchesCondition(relation, matcher);
matcher.onChange(hasMatch, testModel, dcTypeControl, injector);
expect(hasMatch).toBeFalsy();
}
});
});
});
function getTypeBindRelations(configuredTypeBindValues: string[]): DynamicFormControlRelation[] {
const bindValues = [];
configuredTypeBindValues.forEach((value) => {
bindValues.push({
id: 'dc.type',
value: value
});
});
return [{
match: MATCH_VISIBLE,
operator: OR_OPERATOR,
when: bindValues
}];
}

230
src/app/shared/form/builder/ds-dynamic-form-ui/ds-dynamic-type-bind-relation.service.ts Normal file
View File

@@ -0,0 +1,230 @@
import { Inject, Injectable, Injector, Optional } from '@angular/core';
import { FormControl } from '@angular/forms';
import { Subscription } from 'rxjs';
import { startWith } from 'rxjs/operators';
import {
AND_OPERATOR,
DYNAMIC_MATCHERS,
DynamicFormControlCondition,
DynamicFormControlMatcher,
DynamicFormControlModel,
DynamicFormControlRelation,
DynamicFormRelationService, MATCH_VISIBLE,
OR_OPERATOR
} from '@ng-dynamic-forms/core';
import {hasNoValue, hasValue} from '../../../empty.util';
import { FormBuilderService } from '../form-builder.service';
import { FormFieldMetadataValueObject } from '../models/form-field-metadata-value.model';
import { DYNAMIC_FORM_CONTROL_TYPE_RELATION_GROUP } from './ds-dynamic-form-constants';
/**
* Service to manage type binding for submission input fields
* Any form component with the typeBindRelations DynamicFormControlRelation property can be controlled this way
*/
@Injectable()
export class DsDynamicTypeBindRelationService {
constructor(@Optional() @Inject(DYNAMIC_MATCHERS) private dynamicMatchers: DynamicFormControlMatcher[],
protected dynamicFormRelationService: DynamicFormRelationService,
protected formBuilderService: FormBuilderService,
protected injector: Injector) {
}
/**
* Return the string value of the type bind model
* @param bindModelValue
* @private
*/
public getTypeBindValue(bindModelValue: string | FormFieldMetadataValueObject): string {
let value;
if (hasNoValue(bindModelValue) || typeof bindModelValue === 'string') {
value = bindModelValue;
} else if (bindModelValue instanceof FormFieldMetadataValueObject
&& bindModelValue.hasAuthority()) {
value = bindModelValue.authority;
} else {
value = bindModelValue.value;
}
return value;
}
/**
* Get models for this bind type
* @param model
*/
public getRelatedFormModel(model: DynamicFormControlModel): DynamicFormControlModel[] {
const models: DynamicFormControlModel[] = [];
(model as any).typeBindRelations.forEach((relGroup) => relGroup.when.forEach((rel) => {
if (model.id === rel.id) {
throw new Error(`FormControl ${model.id} cannot depend on itself`);
}
const bindModel: DynamicFormControlModel = this.formBuilderService.getTypeBindModel();
if (model && !models.some((modelElement) => modelElement === bindModel)) {
models.push(bindModel);
}
}));
return models;
}
/**
* Return false if the type bind relation (eg. {MATCH_VISIBLE, OR, ['book', 'book part']}) matches the value in
* matcher.match or true if the opposite match. Since this is called with regard to actively *hiding* a form
* component, the negation of the comparison is returned.
* @param relation type bind relation (eg. {MATCH_VISIBLE, OR, ['book', 'book part']})
* @param matcher contains 'match' value and an onChange() event listener
*/
public matchesCondition(relation: DynamicFormControlRelation, matcher: DynamicFormControlMatcher): boolean {
// Default to OR for operator (OR is explicitly set in field-parser.ts anyway)
const operator = relation.operator || OR_OPERATOR;
return relation.when.reduce((hasAlreadyMatched: boolean, condition: DynamicFormControlCondition, index: number) => {
// Get the DynamicFormControlModel (typeBindModel) from the form builder service, set in the form builder
// in the form model at init time in formBuilderService.modelFromConfiguration (called by other form components
// like relation group component and submission section form component).
// This model (DynamicRelationGroupModel) contains eg. mandatory field, formConfiguration, relationFields,
// submission scope, form/section type and other high level properties
const bindModel: any = this.formBuilderService.getTypeBindModel();
let values: string[];
let bindModelValue = bindModel.value;
// If the form type is RELATION, set bindModelValue to the mandatory field for this model, otherwise leave
// as plain value
if (bindModel.type === DYNAMIC_FORM_CONTROL_TYPE_RELATION_GROUP) {
bindModelValue = bindModel.value.map((entry) => entry[bindModel.mandatoryField]);
}
// Support multiple bind models
if (Array.isArray(bindModelValue)) {
values = [...bindModelValue.map((entry) => this.getTypeBindValue(entry))];
} else {
values = [this.getTypeBindValue(bindModelValue)];
}
// If bind model evaluates to 'true' (is not undefined, is not null, is not false etc,
// AND the relation match (type bind) is equal to the matcher match (item publication type), then the return
// value is initialised as false.
let returnValue = (!(bindModel && relation.match === matcher.match));
// Iterate the type bind values parsed and mapped from our form/relation group model
for (const value of values) {
if (bindModel && relation.match === matcher.match) {
// If we're not at the first array element, and we're using the AND operator, and we have not
// yet matched anything, return false.
if (index > 0 && operator === AND_OPERATOR && !hasAlreadyMatched) {
return false;
}
// If we're not at the first array element, and we're using the OR operator (almost always the case)
// and we've already matched then there is no need to continue, just return true.
if (index > 0 && operator === OR_OPERATOR && hasAlreadyMatched) {
return true;
}
// Do the actual match. Does condition.value (the item publication type) match the field model
// type bind currently being inspected?
returnValue = condition.value === value;
// If return value is already true, break.
if (returnValue) {
break;
}
}
// Test opposingMatch (eg. if match is VISIBLE, opposingMatch will be HIDDEN)
if (bindModel && relation.match === matcher.opposingMatch) {
// If we're not at the first element, using AND, and already matched, just return true here
if (index > 0 && operator === AND_OPERATOR && hasAlreadyMatched) {
return true;
}
// If we're not at the first element, using OR, and we have NOT already matched, return false
if (index > 0 && operator === OR_OPERATOR && !hasAlreadyMatched) {
return false;
}
// Negated comparison for return value since this is expected to be in the context of a HIDDEN_MATCHER
returnValue = !(condition.value === value);
// Break if already false
if (!returnValue) {
break;
}
}
}
return returnValue;
}, false);
}
/**
* Return an array of subscriptions to a calling component
* @param model
* @param control
*/
subscribeRelations(model: DynamicFormControlModel, control: FormControl): Subscription[] {
const relatedModels = this.getRelatedFormModel(model);
const subscriptions: Subscription[] = [];
Object.values(relatedModels).forEach((relatedModel: any) => {
if (hasValue(relatedModel)) {
const initValue = (hasNoValue(relatedModel.value) || typeof relatedModel.value === 'string') ? relatedModel.value :
(Array.isArray(relatedModel.value) ? relatedModel.value : relatedModel.value.value);
const valueChanges = relatedModel.valueChanges.pipe(
startWith(initValue)
);
// Build up the subscriptions to watch for changes;
subscriptions.push(valueChanges.subscribe(() => {
// Iterate each matcher
if (hasValue(this.dynamicMatchers)) {
this.dynamicMatchers.forEach((matcher) => {
// Find the relation
const relation = this.dynamicFormRelationService.findRelationByMatcher((model as any).typeBindRelations, matcher);
// If the relation is defined, get matchesCondition result and pass it to the onChange event listener
if (relation !== undefined) {
const hasMatch = this.matchesCondition(relation, matcher);
matcher.onChange(hasMatch, model, control, this.injector);
}
});
}
}));
}
});
return subscriptions;
}
/**
* Helper function to construct a typeBindRelations array
* @param configuredTypeBindValues
*/
public getTypeBindRelations(configuredTypeBindValues: string[]): DynamicFormControlRelation[] {
const bindValues = [];
configuredTypeBindValues.forEach((value) => {
bindValues.push({
id: 'dc.type',
value: value
});
});
return [{
match: MATCH_VISIBLE,
operator: OR_OPERATOR,
when: bindValues
}];
}
}

9
src/app/shared/form/builder/ds-dynamic-form-ui/models/array-group/dynamic-form-array.component.html
View File

@@ -1,6 +1,7 @@
<ng-container [formGroup]="group">
<div [id]="id"
[formArrayName]="model.id"
[class.d-none]="model.hidden"
[ngClass]="getClass('element', 'control')">
<!-- Draggable Container -->
@@ -13,7 +14,8 @@
cdkDrag
cdkDragHandle
[cdkDragDisabled]="dragDisabled"
[cdkDragPreviewClass]="'ds-submission-reorder-dragging'">
[cdkDragPreviewClass]="'ds-submission-reorder-dragging'"
[class.grey-background]="model.isInlineGroupArray">
<!-- Item content -->
<div class="drag-handle" [class.drag-disable]="dragDisabled" tabindex="0">
<i class="drag-icon fas fa-grip-vertical fa-fw" [class.drag-disable]="dragDisabled" ></i>
@@ -22,9 +24,11 @@
<ds-dynamic-form-control-container *ngFor="let _model of groupModel.group"
[bindId]="false"
[formGroup]="group"
[formModel]="formModel"
[context]="groupModel"
[group]="control.get([idx])"
[hidden]="_model.hidden"
[class.d-none]="_model.hidden"
[layout]="formLayout"
[model]="_model"
[templates]="templates"
@@ -37,9 +41,6 @@
<ng-container *ngTemplateOutlet="endTemplate?.templateRef; context: groupModel"></ng-container>
</div>
</div>
</div>
</ng-container>

3
src/app/shared/form/builder/ds-dynamic-form-ui/models/array-group/dynamic-form-array.component.ts
View File

@@ -6,6 +6,7 @@ import {
DynamicFormControlCustomEvent,
DynamicFormControlEvent,
DynamicFormControlLayout,
DynamicFormControlModel,
DynamicFormLayout,
DynamicFormLayoutService,
DynamicFormValidationService,
@@ -22,6 +23,8 @@ import { DynamicRowArrayModel } from '../ds-dynamic-row-array-model';
})
export class DsDynamicFormArrayComponent extends DynamicFormArrayComponent {
@Input() bindId = true;
@Input() formModel: DynamicFormControlModel[];
@Input() formLayout: DynamicFormLayout;
@Input() group: FormGroup;
@Input() layout: DynamicFormControlLayout;

26
src/app/shared/form/builder/ds-dynamic-form-ui/models/date-picker/date-picker.model.ts
View File

@@ -2,20 +2,29 @@ import {
DynamicDateControlModel,
DynamicDatePickerModelConfig,
DynamicFormControlLayout,
DynamicFormControlModel,
DynamicFormControlRelation,
serializable
} from '@ng-dynamic-forms/core';
import {BehaviorSubject, Subject} from 'rxjs';
import {isEmpty, isNotUndefined} from '../../../../../empty.util';
import {MetadataValue} from '../../../../../../core/shared/metadata.models';
export const DYNAMIC_FORM_CONTROL_TYPE_DSDATEPICKER = 'DATE';
export interface DynamicDsDateControlModelConfig extends DynamicDatePickerModelConfig {
legend?: string;
typeBindRelations?: DynamicFormControlRelation[];
}
/**
* Dynamic Date Picker Model class
*/
export class DynamicDsDatePickerModel extends DynamicDateControlModel {
@serializable() hiddenUpdates: Subject<boolean>;
@serializable() typeBindRelations: DynamicFormControlRelation[];
@serializable() readonly type: string = DYNAMIC_FORM_CONTROL_TYPE_DSDATEPICKER;
@serializable() metadataValue: MetadataValue;
malformedDate: boolean;
legend: string;
hasLanguages = false;
@@ -25,6 +34,23 @@ export class DynamicDsDatePickerModel extends DynamicDateControlModel {
super(config, layout);
this.malformedDate = false;
this.legend = config.legend;
this.metadataValue = (config as any).metadataValue;
this.typeBindRelations = config.typeBindRelations ? config.typeBindRelations : [];
this.hiddenUpdates = new BehaviorSubject<boolean>(this.hidden);
// This was a subscription, then an async setTimeout, but it seems unnecessary
const parentModel = this.getRootParent(this);
if (parentModel && isNotUndefined(parentModel.hidden)) {
parentModel.hidden = this.hidden;
}
}
private getRootParent(model: any): DynamicFormControlModel {
if (isEmpty(model) || isEmpty(model.parent)) {
return model;
} else {
return this.getRootParent(model.parent);
}
}
}

16
src/app/shared/form/builder/ds-dynamic-form-ui/models/ds-dynamic-input.model.ts
View File

@@ -1,14 +1,15 @@
import {
DynamicFormControlLayout,
DynamicFormControlRelation,
DynamicInputModel,
DynamicInputModelConfig,
serializable
} from '@ng-dynamic-forms/core';
import { Subject } from 'rxjs';
import {Subject} from 'rxjs';
import { LanguageCode } from '../../models/form-field-language-value.model';
import { VocabularyOptions } from '../../../../../core/submission/vocabularies/models/vocabulary-options.model';
import { hasValue } from '../../../../empty.util';
import {hasValue} from '../../../../empty.util';
import { FormFieldMetadataValueObject } from '../../models/form-field-metadata-value.model';
import { RelationshipOptions } from '../../models/relationship-options.model';
@@ -18,12 +19,14 @@ export interface DsDynamicInputModelConfig extends DynamicInputModelConfig {
language?: string;
place?: number;
value?: any;
typeBindRelations?: DynamicFormControlRelation[];
relationship?: RelationshipOptions;
repeatable: boolean;
metadataFields: string[];
submissionId: string;
hasSelectableMetadata: boolean;
metadataValue?: FormFieldMetadataValueObject;
isModelOfInnerForm?: boolean;
}
@@ -33,12 +36,17 @@ export class DsDynamicInputModel extends DynamicInputModel {
@serializable() private _languageCodes: LanguageCode[];
@serializable() private _language: string;
@serializable() languageUpdates: Subject<string>;
@serializable() place: number;
@serializable() typeBindRelations: DynamicFormControlRelation[];
@serializable() typeBindHidden = false;
@serializable() relationship?: RelationshipOptions;
@serializable() repeatable?: boolean;
@serializable() metadataFields: string[];
@serializable() submissionId: string;
@serializable() hasSelectableMetadata: boolean;
@serializable() metadataValue: FormFieldMetadataValueObject;
@serializable() isModelOfInnerForm: boolean;
constructor(config: DsDynamicInputModelConfig, layout?: DynamicFormControlLayout) {
super(config, layout);
@@ -51,6 +59,8 @@ export class DsDynamicInputModel extends DynamicInputModel {
this.submissionId = config.submissionId;
this.hasSelectableMetadata = config.hasSelectableMetadata;
this.metadataValue = config.metadataValue;
this.place = config.place;
this.isModelOfInnerForm = (hasValue(config.isModelOfInnerForm) ? config.isModelOfInnerForm : false);
this.language = config.language;
if (!this.language) {
@@ -71,6 +81,8 @@ export class DsDynamicInputModel extends DynamicInputModel {
this.language = lang;
});
this.typeBindRelations = config.typeBindRelations ? config.typeBindRelations : [];
this.vocabularyOptions = config.vocabularyOptions;
}

28
src/app/shared/form/builder/ds-dynamic-form-ui/models/ds-dynamic-row-array-model.ts
View File

@@ -1,5 +1,12 @@
import { DynamicFormArrayModel, DynamicFormArrayModelConfig, DynamicFormControlLayout, serializable } from '@ng-dynamic-forms/core';
import {
DynamicFormArrayModel,
DynamicFormArrayModelConfig,
DynamicFormControlLayout,
DynamicFormControlRelation,
serializable
} from '@ng-dynamic-forms/core';
import { RelationshipOptions } from '../../models/relationship-options.model';
import { hasValue } from '../../../../empty.util';
export interface DynamicRowArrayModelConfig extends DynamicFormArrayModelConfig {
notRepeatable: boolean;
@@ -10,6 +17,9 @@ export interface DynamicRowArrayModelConfig extends DynamicFormArrayModelConfig
metadataFields: string[];
hasSelectableMetadata: boolean;
isDraggable: boolean;
showButtons: boolean;
typeBindRelations?: DynamicFormControlRelation[];
isInlineGroupArray?: boolean;
}
export class DynamicRowArrayModel extends DynamicFormArrayModel {
@@ -21,17 +31,29 @@ export class DynamicRowArrayModel extends DynamicFormArrayModel {
@serializable() metadataFields: string[];
@serializable() hasSelectableMetadata: boolean;
@serializable() isDraggable: boolean;
@serializable() showButtons = true;
@serializable() typeBindRelations: DynamicFormControlRelation[];
isRowArray = true;
isInlineGroupArray = false;
constructor(config: DynamicRowArrayModelConfig, layout?: DynamicFormControlLayout) {
super(config, layout);
this.notRepeatable = config.notRepeatable;
this.required = config.required;
if (hasValue(config.notRepeatable)) {
this.notRepeatable = config.notRepeatable;
}
if (hasValue(config.required)) {
this.required = config.required;
}
if (hasValue(config.showButtons)) {
this.showButtons = config.showButtons;
}
this.submissionId = config.submissionId;
this.relationshipConfig = config.relationshipConfig;
this.metadataKey = config.metadataKey;
this.metadataFields = config.metadataFields;
this.hasSelectableMetadata = config.hasSelectableMetadata;
this.isDraggable = config.isDraggable;
this.typeBindRelations = config.typeBindRelations ? config.typeBindRelations : [];
this.isInlineGroupArray = config.isInlineGroupArray ? config.isInlineGroupArray : false;
}
}

13
src/app/shared/form/builder/ds-dynamic-form-ui/models/form-group/dynamic-form-group.component.html
View File

@@ -1,11 +1,17 @@
<div style="width: 100%">
<ng-container [formGroup]="group">
<div role="group" [formGroupName]="model.id" [id]="id" [ngClass]="getClass('element','control')">
<ds-dynamic-form-control-container *ngFor="let _model of model.group"
<div role="group" [formGroupName]="model.id"
[id]="id"
[class.d-none]="model.hidden"
[ngClass]="getClass('element','control')">
<ds-dynamic-form-control-container *ngFor="let _model of model.group"
[formGroup]="group"
[formModel]="formModel"
[group]="control"
[hasErrorMessaging]="model.hasErrorMessages"
[hidden]="_model.hidden"
[class.d-none]="_model.hidden"
[layout]="formLayout"
[model]="_model"
[templates]="templates"
@@ -16,3 +22,4 @@
(ngbEvent)="onCustomEvent($event, null, true)"></ds-dynamic-form-control-container>
</div>
</ng-container>
</div>

5
src/app/shared/form/builder/ds-dynamic-form-ui/models/form-group/dynamic-form-group.component.ts
View File

@@ -5,7 +5,9 @@ import {
DynamicFormControlCustomEvent,
DynamicFormControlEvent,
DynamicFormControlLayout,
DynamicFormGroupModel, DynamicFormLayout,
DynamicFormControlModel,
DynamicFormGroupModel,
DynamicFormLayout,
DynamicFormLayoutService,
DynamicFormValidationService,
DynamicTemplateDirective
@@ -18,6 +20,7 @@ import {
})
export class DsDynamicFormGroupComponent extends DynamicFormControlComponent {
@Input() formModel: DynamicFormControlModel[];
@Input() formLayout: DynamicFormLayout;
@Input() group: FormGroup;
@Input() layout: DynamicFormControlLayout;

20
src/app/shared/form/builder/ds-dynamic-form-ui/models/list/dynamic-list.component.html
View File

@@ -45,17 +45,19 @@
<div *ngFor="let columnItems of items" class="col-sm ml-3">
<div *ngFor="let item of columnItems" class="custom-control custom-radio">
<input type="radio" class="custom-control-input"
[checked]="item.value"
[id]="item.id"
[name]="model.id"
[required]="model.required"
[value]="item.index"
(blur)="onBlur($event)"
(focus)="onFocus($event)"/>
<label class="custom-control-label"
[class.disabled]="model.disabled"
[ngClass]="model.layout.element?.control">
<input type="radio" class="custom-control-input"
[checked]="item.value"
[id]="item.id"
[name]="model.id"
[required]="model.required"
[value]="item.index"
(blur)="onBlur($event)"
(focus)="onFocus($event)"/>
[ngClass]="model.layout.element?.control"
[for]="item.id">
<span [ngClass]="model.layout.element?.label" [innerHTML]="item.label"></span>
</label>
</div>

1
src/app/shared/form/builder/ds-dynamic-form-ui/relation-lookup-modal/search-tab/dynamic-lookup-relation-search-tab.component.html
View File

@@ -7,6 +7,7 @@
[searchFormPlaceholder]="'submission.sections.describe.relationship-lookup.search-tab.search-form.placeholder'"
[selectable]="true"
[selectionConfig]="{ repeatable: repeatable, listId: listId }"
[showScopeSelector]="false"
[showViewModes]="false"
(resultFound)="onResultFound($event)"
(deselectObject)="deselectObject.emit($event)"

40
src/app/shared/form/builder/form-builder.service.spec.ts
View File

@@ -26,7 +26,7 @@ import {
DynamicSliderModel,
DynamicSwitchModel,
DynamicTextAreaModel,
DynamicTimePickerModel
DynamicTimePickerModel,
} from '@ng-dynamic-forms/core';
import { DynamicTagModel } from './ds-dynamic-form-ui/models/tag/dynamic-tag.model';
import { DynamicListCheckboxGroupModel } from './ds-dynamic-form-ui/models/list/dynamic-list-checkbox-group.model';
@@ -48,12 +48,18 @@ import { DynamicConcatModel } from './ds-dynamic-form-ui/models/ds-dynamic-conca
import { DynamicLookupNameModel } from './ds-dynamic-form-ui/models/lookup/dynamic-lookup-name.model';
import { DynamicRowArrayModel } from './ds-dynamic-form-ui/models/ds-dynamic-row-array-model';
import { FormRowModel } from '../../../core/config/models/config-submission-form.model';
import {ConfigurationDataService} from '../../../core/data/configuration-data.service';
import {createSuccessfulRemoteDataObject$} from '../../remote-data.utils';
import {ConfigurationProperty} from '../../../core/shared/configuration-property.model';
describe('FormBuilderService test suite', () => {
let testModel: DynamicFormControlModel[];
let testFormConfiguration: SubmissionFormsModel;
let service: FormBuilderService;
let configSpy: ConfigurationDataService;
const typeFieldProp = 'submit.type-bind.field';
const typeFieldTestValue = 'dc.type';
const submissionId = '1234';
@@ -65,15 +71,24 @@ describe('FormBuilderService test suite', () => {
return new Promise<boolean>((resolve) => setTimeout(() => resolve(true), 0));
}
beforeEach(() => {
const createConfigSuccessSpy = (...values: string[]) => jasmine.createSpyObj('configurationDataService', {
findByPropertyName: createSuccessfulRemoteDataObject$({
... new ConfigurationProperty(),
name: typeFieldProp,
values: values,
}),
});
beforeEach(() => {
configSpy = createConfigSuccessSpy(typeFieldTestValue);
TestBed.configureTestingModule({
imports: [ReactiveFormsModule],
providers: [
{ provide: FormBuilderService, useClass: FormBuilderService },
{ provide: DynamicFormValidationService, useValue: {} },
{ provide: NG_VALIDATORS, useValue: testValidator, multi: true },
{ provide: NG_ASYNC_VALIDATORS, useValue: testAsyncValidator, multi: true }
{ provide: NG_ASYNC_VALIDATORS, useValue: testAsyncValidator, multi: true },
{ provide: ConfigurationDataService, useValue: configSpy }
]
});
@@ -197,7 +212,7 @@ describe('FormBuilderService test suite', () => {
repeatable: false,
metadataFields: [],
submissionId: '1234',
hasSelectableMetadata: false
hasSelectableMetadata: false,
}),
new DynamicScrollableDropdownModel({
@@ -233,6 +248,7 @@ describe('FormBuilderService test suite', () => {
hints: 'Enter the name of the author.',
input: { type: 'onebox' },
label: 'Authors',
typeBind: [],
languageCodes: [],
mandatory: 'true',
mandatoryMessage: 'Required field!',
@@ -304,7 +320,9 @@ describe('FormBuilderService test suite', () => {
required: false,
metadataKey: 'dc.contributor.author',
metadataFields: ['dc.contributor.author'],
hasSelectableMetadata: true
hasSelectableMetadata: true,
showButtons: true,
typeBindRelations: [{ match: 'VISIBLE', operator: 'OR', when: [{id: 'dc.type', value: 'Book' }]}]
},
),
];
@@ -424,7 +442,9 @@ describe('FormBuilderService test suite', () => {
} as any;
});
beforeEach(inject([FormBuilderService], (formService: FormBuilderService) => service = formService));
beforeEach(inject([FormBuilderService], (formService: FormBuilderService) => {
service = formService;
}));
it('should find a dynamic form control model by id', () => {
@@ -875,4 +895,12 @@ describe('FormBuilderService test suite', () => {
expect(formArray.length === 0).toBe(true);
});
it(`should request the ${typeFieldProp} property and set value "dc_type"`, () => {
const typeValue = service.getTypeField();
expect(configSpy.findByPropertyName).toHaveBeenCalledTimes(1);
expect(configSpy.findByPropertyName).toHaveBeenCalledWith(typeFieldProp);
expect(typeValue).toEqual('dc_type');
});
});

149
src/app/shared/form/builder/form-builder.service.ts
View File

@@ -1,5 +1,5 @@
import { Injectable } from '@angular/core';
import { AbstractControl, FormGroup } from '@angular/forms';
import {Injectable, Optional} from '@angular/core';
import { AbstractControl, FormControl, FormGroup } from '@angular/forms';
import {
DYNAMIC_FORM_CONTROL_TYPE_ARRAY,
@@ -7,6 +7,7 @@ import {
DYNAMIC_FORM_CONTROL_TYPE_GROUP,
DYNAMIC_FORM_CONTROL_TYPE_INPUT,
DYNAMIC_FORM_CONTROL_TYPE_RADIO_GROUP,
DynamicFormArrayGroupModel,
DynamicFormArrayModel,
DynamicFormComponentService,
DynamicFormControlEvent,
@@ -19,7 +20,15 @@ import {
} from '@ng-dynamic-forms/core';
import { isObject, isString, mergeWith } from 'lodash';
import { hasValue, isEmpty, isNotEmpty, isNotNull, isNotUndefined, isNull } from '../../empty.util';
import {
hasNoValue,
hasValue,
isEmpty,
isNotEmpty,
isNotNull,
isNotUndefined,
isNull
} from '../../empty.util';
import { DynamicQualdropModel } from './ds-dynamic-form-ui/models/ds-dynamic-qualdrop.model';
import { SubmissionFormsModel } from '../../../core/config/models/config-submission-forms.model';
import { DYNAMIC_FORM_CONTROL_TYPE_TAG } from './ds-dynamic-form-ui/models/tag/dynamic-tag.model';
@@ -32,16 +41,61 @@ import { dateToString, isNgbDateStruct } from '../../date.util';
import { DYNAMIC_FORM_CONTROL_TYPE_RELATION_GROUP } from './ds-dynamic-form-ui/ds-dynamic-form-constants';
import { CONCAT_GROUP_SUFFIX, DynamicConcatModel } from './ds-dynamic-form-ui/models/ds-dynamic-concat.model';
import { VIRTUAL_METADATA_PREFIX } from '../../../core/shared/metadata.models';
import { ConfigurationDataService } from '../../../core/data/configuration-data.service';
import { getFirstCompletedRemoteData } from '../../../core/shared/operators';
@Injectable()
export class FormBuilderService extends DynamicFormService {
private typeBindModel: DynamicFormControlModel;
/**
* This map contains the active forms model
*/
private formModels: Map<string, DynamicFormControlModel[]>;
/**
* This map contains the active forms control groups
*/
private formGroups: Map<string, FormGroup>;
/**
* This is the field to use for type binding
*/
private typeField: string;
constructor(
componentService: DynamicFormComponentService,
validationService: DynamicFormValidationService,
protected rowParser: RowParser
protected rowParser: RowParser,
@Optional() protected configService: ConfigurationDataService,
) {
super(componentService, validationService);
this.formModels = new Map();
this.formGroups = new Map();
// If optional config service was passed, perform an initial set of type field (default dc_type) for type binds
if (hasValue(this.configService)) {
this.setTypeBindFieldFromConfig();
}
}
createDynamicFormControlEvent(control: FormControl, group: FormGroup, model: DynamicFormControlModel, type: string): DynamicFormControlEvent {
const $event = {
value: (model as any).value,
autoSave: false
};
const context: DynamicFormArrayGroupModel = (model?.parent instanceof DynamicFormArrayGroupModel) ? model?.parent : null;
return {$event, context, control: control, group: group, model: model, type};
}
getTypeBindModel() {
return this.typeBindModel;
}
setTypeBindModel(model: DynamicFormControlModel) {
this.typeBindModel = model;
}
findById(id: string, groupModel: DynamicFormControlModel[], arrayIndex = null): DynamicFormControlModel | null {
@@ -223,13 +277,15 @@ export class FormBuilderService extends DynamicFormService {
return result;
}
modelFromConfiguration(submissionId: string, json: string | SubmissionFormsModel, scopeUUID: string, sectionData: any = {}, submissionScope?: string, readOnly = false): DynamicFormControlModel[] | never {
let rows: DynamicFormControlModel[] = [];
const rawData = typeof json === 'string' ? JSON.parse(json, parseReviver) : json;
modelFromConfiguration(submissionId: string, json: string | SubmissionFormsModel, scopeUUID: string, sectionData: any = {},
submissionScope?: string, readOnly = false, typeBindModel = null,
isInnerForm = false): DynamicFormControlModel[] | never {
let rows: DynamicFormControlModel[] = [];
const rawData = typeof json === 'string' ? JSON.parse(json, parseReviver) : json;
if (rawData.rows && !isEmpty(rawData.rows)) {
rawData.rows.forEach((currentRow) => {
const rowParsed = this.rowParser.parse(submissionId, currentRow, scopeUUID, sectionData, submissionScope, readOnly);
const rowParsed = this.rowParser.parse(submissionId, currentRow, scopeUUID, sectionData, submissionScope,
readOnly, this.getTypeField());
if (isNotNull(rowParsed)) {
if (Array.isArray(rowParsed)) {
rows = rows.concat(rowParsed);
@@ -240,6 +296,13 @@ export class FormBuilderService extends DynamicFormService {
});
}
if (hasNoValue(typeBindModel)) {
typeBindModel = this.findById(this.typeField, rows);
}
if (hasValue(typeBindModel)) {
this.setTypeBindModel(typeBindModel);
}
return rows;
}
@@ -309,6 +372,10 @@ export class FormBuilderService extends DynamicFormService {
return isNotEmpty(fieldModel) ? formGroup.get(this.getPath(fieldModel)) : null;
}
getFormControlByModel(formGroup: FormGroup, fieldModel: DynamicFormControlModel): AbstractControl {
return isNotEmpty(fieldModel) ? formGroup.get(this.getPath(fieldModel)) : null;
}
/**
* Note (discovered while debugging) this is not the ID as used in the form,
* but the first part of the path needed in a patch operation:
@@ -328,6 +395,35 @@ export class FormBuilderService extends DynamicFormService {
return (tempModel.id !== tempModel.name) ? tempModel.name : tempModel.id;
}
/**
* If present, remove form model from formModels map
* @param id id of model
*/
removeFormModel(id: string): void {
if (this.formModels.has(id)) {
this.formModels.delete(id);
}
}
/**
* Add new form model to formModels map
* @param id id of model
* @param formGroup FormGroup
*/
addFormGroups(id: string, formGroup: FormGroup): void {
this.formGroups.set(id, formGroup);
}
/**
* If present, remove form model from formModels map
* @param id id of model
*/
removeFormGroup(id: string): void {
if (this.formGroups.has(id)) {
this.formGroups.delete(id);
}
}
/**
* Calculate the metadata list related to the event.
* @param event
@@ -400,4 +496,39 @@ export class FormBuilderService extends DynamicFormService {
return Object.keys(result);
}
/**
* Get the type bind field from config
*/
setTypeBindFieldFromConfig(): void {
this.configService.findByPropertyName('submit.type-bind.field').pipe(
getFirstCompletedRemoteData(),
).subscribe((remoteData: any) => {
// make sure we got a success response from the backend
if (!remoteData.hasSucceeded) {
this.typeField = 'dc_type';
return;
}
// Read type bind value from response and set if non-empty
const typeFieldConfig = remoteData.payload.values[0];
if (isEmpty(typeFieldConfig)) {
this.typeField = 'dc_type';
} else {
this.typeField = typeFieldConfig.replace(/\./g, '_');
}
});
}
/**
* Get type field. If the type isn't already set, and a ConfigurationDataService is provided, set (with subscribe)
* from back end. Otherwise, get/set a default "dc_type" value
*/
getTypeField(): string {
if (hasValue(this.configService) && hasNoValue(this.typeField)) {
this.setTypeBindFieldFromConfig();
} else if (hasNoValue(this.typeField)) {
this.typeField = 'dc_type';
}
return this.typeField;
}
}

6
src/app/shared/form/builder/models/form-field.model.ts
View File

@@ -113,6 +113,12 @@ export class FormFieldModel {
@autoserialize
style: string;
/**
* Containing types to bind for this field
*/
@autoserialize
typeBind: string[];
/**
* Containing the value for this metadata field
*/

2
src/app/shared/form/builder/parsers/concat-field-parser.ts
View File

@@ -1,4 +1,4 @@
import { Inject } from '@angular/core';
import {Inject} from '@angular/core';
import { FormFieldModel } from '../models/form-field.model';
import { FormFieldMetadataValueObject } from '../models/form-field-metadata-value.model';
import {

3
src/app/shared/form/builder/parsers/date-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('DateFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: null,
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

6
src/app/shared/form/builder/parsers/date-field-parser.ts
View File

@@ -1,7 +1,7 @@
import { FieldParser } from './field-parser';
import {
DynamicDsDateControlModelConfig,
DynamicDsDatePickerModel
DynamicDsDatePickerModel,
DynamicDsDateControlModelConfig
} from '../ds-dynamic-form-ui/models/date-picker/date-picker.model';
import { isNotEmpty } from '../../../empty.util';
import { DS_DATE_PICKER_SEPARATOR } from '../ds-dynamic-form-ui/models/date-picker/date-picker.component';
@@ -13,7 +13,7 @@ export class DateFieldParser extends FieldParser {
let malformedDate = false;
const inputDateModelConfig: DynamicDsDateControlModelConfig = this.initModel(null, false, true);
inputDateModelConfig.legend = this.configData.label;
inputDateModelConfig.disabled = inputDateModelConfig.readOnly;
inputDateModelConfig.toggleIcon = 'fas fa-calendar';
this.setValues(inputDateModelConfig as any, fieldValue);
// Init Data and validity check

3
src/app/shared/form/builder/parsers/disabled-field-parser.spec.ts
View File

@@ -11,7 +11,8 @@ describe('DisabledFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: null,
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/dropdown-field-parser.spec.ts
View File

@@ -11,7 +11,8 @@ describe('DropdownFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

4
src/app/shared/form/builder/parsers/dropdown-field-parser.ts
View File

@@ -1,4 +1,4 @@
import { Inject } from '@angular/core';
import {Inject} from '@angular/core';
import { FormFieldModel } from '../models/form-field.model';
import {
CONFIG_DATA,
@@ -22,7 +22,7 @@ export class DropdownFieldParser extends FieldParser {
@Inject(SUBMISSION_ID) submissionId: string,
@Inject(CONFIG_DATA) configData: FormFieldModel,
@Inject(INIT_FORM_VALUES) initFormValues,
@Inject(PARSER_OPTIONS) parserOptions: ParserOptions
@Inject(PARSER_OPTIONS) parserOptions: ParserOptions,
) {
super(submissionId, configData, initFormValues, parserOptions);
}

50
src/app/shared/form/builder/parsers/field-parser.ts
View File

@@ -1,7 +1,7 @@
import { Inject, InjectionToken } from '@angular/core';
import {Inject, InjectionToken} from '@angular/core';
import { uniqueId } from 'lodash';
import { DynamicFormControlLayout } from '@ng-dynamic-forms/core';
import {DynamicFormControlLayout, DynamicFormControlRelation, MATCH_VISIBLE, OR_OPERATOR} from '@ng-dynamic-forms/core';
import { hasValue, isNotEmpty, isNotNull, isNotUndefined } from '../../../empty.util';
import { FormFieldModel } from '../models/form-field.model';
@@ -26,6 +26,11 @@ export const PARSER_OPTIONS: InjectionToken<ParserOptions> = new InjectionToken<
export abstract class FieldParser {
protected fieldId: string;
/**
* This is the field to use for type binding
* @protected
*/
protected typeField: string;
constructor(
@Inject(SUBMISSION_ID) protected submissionId: string,
@@ -67,6 +72,8 @@ export abstract class FieldParser {
metadataFields: this.getAllFieldIds(),
hasSelectableMetadata: isNotEmpty(this.configData.selectableMetadata),
isDraggable,
typeBindRelations: isNotEmpty(this.configData.typeBind) ? this.getTypeBindRelations(this.configData.typeBind,
this.parserOptions.typeField) : null,
groupFactory: () => {
let model;
if ((arrayCounter === 0)) {
@@ -275,7 +282,7 @@ export abstract class FieldParser {
// Set label
this.setLabel(controlModel, label);
if (hint) {
controlModel.hint = this.configData.hints;
controlModel.hint = this.configData.hints || '&nbsp;';
}
controlModel.placeholder = this.configData.label;
@@ -292,9 +299,46 @@ export abstract class FieldParser {
(controlModel as DsDynamicInputModel).languageCodes = this.configData.languageCodes;
}
// If typeBind is configured
if (isNotEmpty(this.configData.typeBind)) {
(controlModel as DsDynamicInputModel).typeBindRelations = this.getTypeBindRelations(this.configData.typeBind,
this.parserOptions.typeField);
}
return controlModel;
}
/**
* 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)
* @private
* @return DynamicFormControlRelation[] array with one relation in it, for type bind matching to show a field
*/
private 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
return [{
match: MATCH_VISIBLE,
operator: OR_OPERATOR,
when: bindValues
}];
}
protected hasRegex() {
return hasValue(this.configData.input.regex);
}

3
src/app/shared/form/builder/parsers/list-field-parser.spec.ts
View File

@@ -13,7 +13,8 @@ describe('ListFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/lookup-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('LookupFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/lookup-name-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('LookupNameFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/name-field-parser.spec.ts
View File

@@ -14,7 +14,8 @@ describe('NameFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/onebox-field-parser.spec.ts
View File

@@ -15,7 +15,8 @@ describe('OneboxFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

1
src/app/shared/form/builder/parsers/parser-options.ts
View File

@@ -2,4 +2,5 @@ export interface ParserOptions {
readOnly: boolean;
submissionScope: string;
collectionUUID: string;
typeField: string;
}

3
src/app/shared/form/builder/parsers/relation-group-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('RelationGroupFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: 'WORKSPACE'
collectionUUID: 'WORKSPACE',
typeField: 'dc_type'
};
beforeEach(() => {

23
src/app/shared/form/builder/parsers/row-parser.spec.ts
View File

@@ -22,6 +22,7 @@ describe('RowParser test suite', () => {
const initFormValues = {};
const submissionScope = 'WORKSPACE';
const readOnly = false;
const typeField = 'dc_type';
beforeEach(() => {
row1 = {
@@ -338,7 +339,7 @@ describe('RowParser test suite', () => {
it('should return a DynamicRowGroupModel object', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row1, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row1, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel instanceof DynamicRowGroupModel).toBe(true);
});
@@ -346,7 +347,7 @@ describe('RowParser test suite', () => {
it('should return a row with three fields', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row1, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row1, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect((rowModel as DynamicRowGroupModel).group.length).toBe(3);
});
@@ -354,7 +355,7 @@ describe('RowParser test suite', () => {
it('should return a DynamicRowArrayModel object', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row2, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row2, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel instanceof DynamicRowArrayModel).toBe(true);
});
@@ -362,7 +363,7 @@ describe('RowParser test suite', () => {
it('should return a row that contains only scoped fields', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row3, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row3, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect((rowModel as DynamicRowGroupModel).group.length).toBe(1);
});
@@ -370,7 +371,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a dropdown combo field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row4, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row4, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});
@@ -378,7 +379,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a lookup-name field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row5, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row5, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});
@@ -386,7 +387,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a list field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row6, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row6, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});
@@ -394,7 +395,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a date field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row7, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row7, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});
@@ -402,7 +403,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a tag field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row8, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row8, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});
@@ -410,7 +411,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a textarea field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row9, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row9, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});
@@ -418,7 +419,7 @@ describe('RowParser test suite', () => {
it('should be able to parse a group field', () => {
const parser = new RowParser(undefined);
const rowModel = parser.parse(submissionId, row10, scopeUUID, initFormValues, submissionScope, readOnly);
const rowModel = parser.parse(submissionId, row10, scopeUUID, initFormValues, submissionScope, readOnly, typeField);
expect(rowModel).toBeDefined();
});

6
src/app/shared/form/builder/parsers/row-parser.ts
View File

@@ -31,7 +31,8 @@ export class RowParser {
scopeUUID,
initFormValues: any,
submissionScope,
readOnly: boolean): DynamicRowGroupModel {
readOnly: boolean,
typeField: string): DynamicRowGroupModel {
let fieldModel: any = null;
let parsedResult = null;
const config: DynamicFormGroupModelConfig = {
@@ -47,7 +48,8 @@ export class RowParser {
const parserOptions: ParserOptions = {
readOnly: readOnly,
submissionScope: submissionScope,
collectionUUID: scopeUUID
collectionUUID: scopeUUID,
typeField: typeField
};
// Iterate over row's fields

3
src/app/shared/form/builder/parsers/series-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('SeriesFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/tag-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('TagFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: 'testScopeUUID',
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

3
src/app/shared/form/builder/parsers/textarea-field-parser.spec.ts
View File

@@ -12,7 +12,8 @@ describe('TextareaFieldParser test suite', () => {
const parserOptions: ParserOptions = {
readOnly: false,
submissionScope: null,
collectionUUID: null
collectionUUID: null,
typeField: 'dc_type'
};
beforeEach(() => {

4
src/app/shared/item/item-versions/item-versions.component.spec.ts
View File

@@ -100,7 +100,9 @@ describe('ItemVersionsComponent', () => {
isAuthenticated: observableOf(true),
setRedirectUrl: {}
});
const authorizationServiceSpy = jasmine.createSpyObj('authorizationService', ['isAuthorized']);
const authorizationServiceSpy = jasmine.createSpyObj('authorizationService', {
isAuthorized: observableOf(true)
});
const workspaceItemDataServiceSpy = jasmine.createSpyObj('workspaceItemDataService', {
findByItem: EMPTY,
});

14
src/app/shared/mocks/find-id-config-data.service.mock.ts Normal file
View File

@@ -0,0 +1,14 @@
import { createSuccessfulRemoteDataObject$ } from '../remote-data.utils';
import { ConfigurationProperty } from '../../core/shared/configuration-property.model';
export function getMockFindByIdDataService(propertyKey: string, ...values: string[]) {
return jasmine.createSpyObj('findByIdDataService', {
findByPropertyName: createSuccessfulRemoteDataObject$({
... new ConfigurationProperty(),
name: propertyKey,
values: values,
})
});
}

24
src/app/shared/mocks/form-builder-service.mock.ts
View File

@@ -1,7 +1,9 @@
import { FormBuilderService } from '../form/builder/form-builder.service';
import { FormControl, FormGroup } from '@angular/forms';
import {DsDynamicInputModel} from '../form/builder/ds-dynamic-form-ui/models/ds-dynamic-input.model';
export function getMockFormBuilderService(): FormBuilderService {
return jasmine.createSpyObj('FormBuilderService', {
modelFromConfiguration: [],
createFormGroup: new FormGroup({}),
@@ -17,8 +19,26 @@ export function getMockFormBuilderService(): FormBuilderService {
isQualdropGroup: false,
isModelInCustomGroup: true,
isRelationGroup: true,
hasArrayGroupValue: true
hasArrayGroupValue: true,
getTypeBindModel: new DsDynamicInputModel({
name: 'dc.type',
id: 'dc_type',
readOnly: false,
disabled: false,
repeatable: false,
value: {
value: 'boundType',
display: 'Bound Type',
authority: 'bound-auth-key'
},
submissionId: '1234',
metadataFields: ['dc.type'],
hasSelectableMetadata: false,
typeBindRelations: [
{match: 'VISIBLE', operator: 'OR', when: [{id: 'dc.type', value: 'boundType'}]}
]
}
)
});
}

57
src/app/shared/mocks/form-models.mock.ts
View File

@@ -89,7 +89,8 @@ const rowArrayQualdropConfig = {
submissionId: '1234',
metadataKey: 'dc.some.key',
metadataFields: ['dc.some.key'],
hasSelectableMetadata: false
hasSelectableMetadata: false,
showButtons: true
} as DynamicRowArrayModelConfig;
export const MockRowArrayQualdropModel: DynamicRowArrayModel = new DynamicRowArrayModel(rowArrayQualdropConfig);
@@ -305,3 +306,57 @@ export const mockFileFormEditRowGroupModel = new DynamicRowGroupModel({
id: 'mockRowGroupModel',
group: [mockFileFormEditInputModel]
});
// Mock configuration and model for an input with type binding
export const inputWithTypeBindConfig = {
name: 'testWithTypeBind',
id: 'testWithTypeBind',
readOnly: false,
disabled: false,
repeatable: false,
value: {
value: 'testWithTypeBind',
display: 'testWithTypeBind',
authority: 'bound-auth-key'
},
submissionId: '1234',
metadataFields: [],
hasSelectableMetadata: false,
getTypeBindModel: new DsDynamicInputModel({
name: 'testWithTypeBind',
id: 'testWithTypeBind',
readOnly: false,
disabled: false,
repeatable: false,
value: {
value: 'testWithTypeBind',
display: 'testWithTypeBind',
authority: 'bound-auth-key'
},
submissionId: '1234',
metadataFields: [],
hasSelectableMetadata: false,
typeBindRelations: [
{match: 'VISIBLE', operator: 'OR', when: [{'id': 'dc.type', 'value': 'boundType'}]}
]
}
)
};
export const mockInputWithTypeBindModel = new DsDynamicInputModel(inputWithAuthorityValueConfig);
export const dcTypeInputConfig = {
name: 'dc.type',
id: 'dc_type',
readOnly: false,
disabled: false,
repeatable: false,
submissionId: '1234',
metadataFields: [],
hasSelectableMetadata: false,
value: {
value: 'boundType'
}
};
export const mockDcTypeInputModel = new DsDynamicInputModel(dcTypeInputConfig);

22
src/app/shared/mydspace-actions/claimed-task/claimed-task-actions.component.html
View File

@@ -1,22 +1,16 @@
<ng-container *ngVar="(actionRD$ | async)?.payload as workflowAction">
<div class="mt-1 mb-3 space-children-mr">
<ds-claimed-task-actions-loader *ngFor="let option of workflowAction?.options"
[option]="option"
[object]="object"
(processCompleted)="this.processCompleted.emit($event)">
<ds-claimed-task-actions-loader *ngFor="let option of workflowAction?.options" [option]="option" [object]="object"
(processCompleted)="this.processCompleted.emit($event)">
</ds-claimed-task-actions-loader>
<ng-container *ngIf="hasViewAction(workflowAction)">
<button class="btn btn-primary workflow-view"
ngbTooltip="{{'submission.workflow.generic.view-help' | translate}}"
[routerLink]="[getWorkflowItemViewRoute((workflowitem$ | async))]">
<i class="fa fa-info-circle"></i> {{"submission.workflow.generic.view" | translate}}
</button>
</ng-container>
<button class="btn btn-primary workflow-view" ngbTooltip="{{'submission.workflow.generic.view-help' | translate}}"
[routerLink]="[getWorkflowItemViewRoute((workflowitem$ | async))]">
<i class="fa fa-info-circle"></i> {{"submission.workflow.generic.view" | translate}}
</button>
<ds-claimed-task-actions-loader [option]="returnToPoolOption"
[object]="object"
(processCompleted)="this.processCompleted.emit($event)">
<ds-claimed-task-actions-loader [option]="returnToPoolOption" [object]="object"
(processCompleted)="this.processCompleted.emit($event)">
</ds-claimed-task-actions-loader>
</div>
</ng-container>

31
src/app/shared/mydspace-actions/claimed-task/claimed-task-actions.component.spec.ts
View File

@@ -161,25 +161,22 @@ describe('ClaimedTaskActionsComponent', () => {
});
}));
describe('when edit options is not available', () => {
it('should display a view button', waitForAsync(() => {
component.object = null;
component.initObjects(mockObject);
fixture.detectChanges();
it('should display a view button', waitForAsync(() => {
component.object = null;
component.initObjects(mockObject);
fixture.detectChanges();
fixture.whenStable().then(() => {
const debugElement = fixture.debugElement.query(By.css('.workflow-view'));
expect(debugElement).toBeTruthy();
expect(debugElement.nativeElement.innerText.trim()).toBe('submission.workflow.generic.view');
});
fixture.whenStable().then(() => {
const debugElement = fixture.debugElement.query(By.css('.workflow-view'));
expect(debugElement).toBeTruthy();
expect(debugElement.nativeElement.innerText.trim()).toBe('submission.workflow.generic.view');
});
}));
it('getWorkflowItemViewRoute should return the combined uri to show a workspaceitem', waitForAsync(() => {
const href = component.getWorkflowItemViewRoute(workflowitem);
expect(href).toEqual('/workflowitems/333/view');
}));
});
}));
it('getWorkflowItemViewRoute should return the combined uri to show a workspaceitem', waitForAsync(() => {
const href = component.getWorkflowItemViewRoute(workflowitem);
expect(href).toEqual('/workflowitems/333/view');
}));
});

8
src/app/shared/mydspace-actions/claimed-task/claimed-task-actions.component.ts
View File

@@ -102,14 +102,6 @@ export class ClaimedTaskActionsComponent extends MyDSpaceActionsComponent<Claime
this.actionRD$ = object.action;
}
/**
* Check if claimed task actions should display a view item button.
* @param workflowAction
*/
hasViewAction(workflowAction: WorkflowAction) {
return !workflowAction?.options.includes('submit_edit_metadata');
}
/**
* Get the workflowitem view route.
*/

19
src/app/shared/mydspace-actions/pool-task/pool-task-actions.component.html
View File

@@ -1,8 +1,13 @@
<button type="button"
class="btn btn-info mt-1 mb-3"
ngbTooltip="{{'submission.workflow.tasks.pool.claim_help' | translate}}"
[disabled]="(processing$ | async)"
(click)="claim()">
<span *ngIf="(processing$ | async)"><i class='fas fa-circle-notch fa-spin'></i> {{'submission.workflow.tasks.generic.processing' | translate}}</span>
<span *ngIf="!(processing$ | async)"><i class="fas fa-hand-paper"></i> {{'submission.workflow.tasks.pool.claim' | translate}}</span>
<button type="button" class="btn btn-info mt-1 mb-3"
ngbTooltip="{{'submission.workflow.tasks.pool.claim_help' | translate}}" [disabled]="(processing$ | async)"
(click)="claim()">
<span *ngIf="(processing$ | async)"><i class='fas fa-circle-notch fa-spin'></i>
{{'submission.workflow.tasks.generic.processing' | translate}}</span>
<span *ngIf="!(processing$ | async)"><i class="fas fa-hand-paper"></i> {{'submission.workflow.tasks.pool.claim' |
translate}}</span>
</button>
<button class="btn btn-primary workflow-view ml-1 mt-1 mb-3" data-test="view-btn"
ngbTooltip="{{'submission.workflow.generic.view-help' | translate}}"
[routerLink]="[getWorkflowItemViewRoute((workflowitem$ | async))]">
<i class="fa fa-info-circle"></i> {{"submission.workflow.generic.view" | translate}}
</button>

8
src/app/shared/mydspace-actions/pool-task/pool-task-actions.component.spec.ts
View File

@@ -1,5 +1,5 @@
import { ChangeDetectionStrategy, Injector, NO_ERRORS_SCHEMA } from '@angular/core';
import { waitForAsync, ComponentFixture, TestBed } from '@angular/core/testing';
import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
import { Router } from '@angular/router';
import { By } from '@angular/platform-browser';
@@ -133,6 +133,12 @@ describe('PoolTaskActionsComponent', () => {
expect(btn).toBeDefined();
});
it('should display view button', () => {
const btn = fixture.debugElement.query(By.css('button [data-test="view-btn"]'));
expect(btn).toBeDefined();
});
it('should call claim task with href of getPoolTaskEndpointById', ((done) => {
const poolTaskHref = 'poolTaskHref';

28
src/app/shared/mydspace-actions/pool-task/pool-task-actions.component.ts
View File

@@ -2,7 +2,7 @@ import { Component, Injector, Input, OnDestroy } from '@angular/core';
import { Router } from '@angular/router';
import { Observable } from 'rxjs';
import {filter, map, switchMap, take} from 'rxjs/operators';
import { filter, map, switchMap, take } from 'rxjs/operators';
import { TranslateService } from '@ngx-translate/core';
import { WorkflowItem } from '../../../core/submission/models/workflowitem.model';
@@ -19,6 +19,7 @@ import { Item } from '../../../core/shared/item.model';
import { DSpaceObject } from '../../../core/shared/dspace-object.model';
import { MyDSpaceReloadableActionsComponent } from '../mydspace-reloadable-actions';
import { ProcessTaskResponse } from '../../../core/tasks/models/process-task-response';
import { getWorkflowItemViewRoute } from '../../../workflowitems-edit-page/workflowitems-edit-page-routing-paths';
/**
* This component represents mydspace actions related to PoolTask object.
@@ -58,12 +59,12 @@ export class PoolTaskActionsComponent extends MyDSpaceReloadableActionsComponent
* @param {RequestService} requestService
*/
constructor(protected injector: Injector,
protected router: Router,
protected notificationsService: NotificationsService,
protected claimedTaskService: ClaimedTaskDataService,
protected translate: TranslateService,
protected searchService: SearchService,
protected requestService: RequestService) {
protected router: Router,
protected notificationsService: NotificationsService,
protected claimedTaskService: ClaimedTaskDataService,
protected translate: TranslateService,
protected searchService: SearchService,
protected requestService: RequestService) {
super(PoolTask.type, injector, router, notificationsService, translate, searchService, requestService);
}
@@ -91,7 +92,7 @@ export class PoolTaskActionsComponent extends MyDSpaceReloadableActionsComponent
return this.objectDataService.getPoolTaskEndpointById(this.object.id)
.pipe(switchMap((poolTaskHref) => {
return this.claimedTaskService.claimTask(this.object.id, poolTaskHref);
}));
}));
}
reloadObjectExecution(): Observable<RemoteData<DSpaceObject> | DSpaceObject> {
@@ -107,12 +108,19 @@ export class PoolTaskActionsComponent extends MyDSpaceReloadableActionsComponent
switchMap((workflowItem: WorkflowItem) => workflowItem.item.pipe(getFirstSucceededRemoteDataPayload())
))
.subscribe((item: Item) => {
this.itemUuid = item.uuid;
});
this.itemUuid = item.uuid;
});
}
ngOnDestroy() {
this.subs.forEach((sub) => sub.unsubscribe());
}
/**
* Get the workflowitem view route.
*/
getWorkflowItemViewRoute(workflowitem: WorkflowItem): string {
return getWorkflowItemViewRoute(workflowitem?.id);
}
}

5
src/app/shared/mydspace-actions/workflowitem/workflowitem-actions.component.html
View File

@@ -0,0 +1,5 @@
<button class="btn btn-primary workflow-view mt-1 mb-3" data-test="view-btn"
ngbTooltip="{{'submission.workspace.generic.view-help' | translate}}"
[routerLink]="[getWorkflowItemViewRoute(object)]">
<i class="fa fa-info-circle"></i> {{"submission.workspace.generic.view" | translate}}
</button>

7
src/app/shared/mydspace-actions/workflowitem/workflowitem-actions.component.spec.ts
View File

@@ -18,6 +18,7 @@ import { getMockRequestService } from '../../mocks/request.service.mock';
import { RequestService } from '../../../core/data/request.service';
import { getMockSearchService } from '../../mocks/search-service.mock';
import { SearchService } from '../../../core/shared/search/search.service';
import { By } from '@angular/platform-browser';
let component: WorkflowitemActionsComponent;
let fixture: ComponentFixture<WorkflowitemActionsComponent>;
@@ -105,4 +106,10 @@ describe('WorkflowitemActionsComponent', () => {
expect(component.object).toEqual(mockObject);
});
it('should display view button', () => {
const btn = fixture.debugElement.query(By.css('button [data-test="view-btn"]'));
expect(btn).toBeDefined();
});
});

8
src/app/shared/mydspace-actions/workflowitem/workflowitem-actions.component.ts
View File

@@ -9,6 +9,7 @@ import { WorkflowItemDataService } from '../../../core/submission/workflowitem-d
import { NotificationsService } from '../../notifications/notifications.service';
import { RequestService } from '../../../core/data/request.service';
import { SearchService } from '../../../core/shared/search/search.service';
import { getWorkflowItemViewRoute } from '../../../workflowitems-edit-page/workflowitems-edit-page-routing-paths';
/**
* This component represents actions related to WorkflowItem object.
@@ -44,6 +45,13 @@ export class WorkflowitemActionsComponent extends MyDSpaceActionsComponent<Workf
super(WorkflowItem.type, injector, router, notificationsService, translate, searchService, requestService);
}
/**
* Get the workflowitem view route.
*/
getWorkflowItemViewRoute(workflowitem: WorkflowItem): string {
return getWorkflowItemViewRoute(workflowitem?.id);
}
/**
* Init the target object
*

36
src/app/shared/mydspace-actions/workspaceitem/workspaceitem-actions.component.html
View File

@@ -1,22 +1,28 @@
<div class="space-children-mr">
<a class="btn btn-primary mt-1 mb-3"
id="{{'edit_' + object.id}}"
ngbTooltip="{{'submission.workflow.generic.edit-help' | translate}}"
[routerLink]="['/workspaceitems/' + object.id + '/edit']"
role="button">
<button class="btn btn-primary workflow-view mt-1 mb-3" data-test="view-btn"
ngbTooltip="{{'submission.workspace.generic.view-help' | translate}}"
[routerLink]="[getWorkspaceItemViewRoute(object)]">
<i class="fa fa-info-circle"></i> {{"submission.workspace.generic.view" | translate}}
</button>
<a class="btn btn-primary mt-1 mb-3" id="{{'edit_' + object.id}}"
ngbTooltip="{{'submission.workflow.generic.edit-help' | translate}}"
[routerLink]="['/workspaceitems/' + object.id + '/edit']" role="button">
<i class="fa fa-edit"></i> {{'submission.workflow.generic.edit' | translate}}
</a>
<button type="button"
id="{{'delete_' + object.id}}"
class="btn btn-danger mt-1 mb-3"
ngbTooltip="{{'submission.workflow.generic.delete-help' | translate}}"
(click)="$event.preventDefault();confirmDiscard(content)">
<span *ngIf="(processingDelete$ | async)"><i class='fas fa-circle-notch fa-spin'></i> {{'submission.workflow.tasks.generic.processing' | translate}}</span>
<span *ngIf="!(processingDelete$ | async)"><i class="fa fa-trash"></i> {{'submission.workflow.generic.delete' | translate}}</span>
<button type="button" id="{{'delete_' + object.id}}" class="btn btn-danger mt-1 mb-3"
ngbTooltip="{{'submission.workflow.generic.delete-help' | translate}}"
(click)="$event.preventDefault();confirmDiscard(content)">
<span *ngIf="(processingDelete$ | async)"><i class='fas fa-circle-notch fa-spin'></i>
{{'submission.workflow.tasks.generic.processing' | translate}}</span>
<span *ngIf="!(processingDelete$ | async)"><i class="fa fa-trash"></i> {{'submission.workflow.generic.delete' |
translate}}</span>
</button>
</div>
<ng-template #content let-c="close" let-d="dismiss">
<div class="modal-header">
<h4 class="modal-title text-danger">{{'submission.general.discard.confirm.title' | translate}}</h4>
@@ -28,7 +34,9 @@
<p>{{'submission.general.discard.confirm.info' | translate}}</p>
</div>
<div class="modal-footer">
<button type="button" id="delete_cancel" class="btn btn-secondary" (click)="c('cancel')">{{'submission.general.discard.confirm.cancel' | translate}}</button>
<button type="button" id="delete_confirm"class="btn btn-danger" (click)="c('ok')">{{'submission.general.discard.confirm.submit' | translate}}</button>
<button type="button" id="delete_cancel" class="btn btn-secondary"
(click)="c('cancel')">{{'submission.general.discard.confirm.cancel' | translate}}</button>
<button type="button" id="delete_confirm" class="btn btn-danger"
(click)="c('ok')">{{'submission.general.discard.confirm.submit' | translate}}</button>
</div>
</ng-template>

6
src/app/shared/mydspace-actions/workspaceitem/workspaceitem-actions.component.spec.ts
View File

@@ -132,6 +132,12 @@ describe('WorkspaceitemActionsComponent', () => {
expect(btn).toBeDefined();
});
it('should display view button', () => {
const btn = fixture.debugElement.query(By.css('button [data-test="view-btn"]'));
expect(btn).toBeDefined();
});
describe('on discard confirmation', () => {
beforeEach((done) => {
mockDataService.delete.and.returnValue(observableOf(true));

20
src/app/shared/mydspace-actions/workspaceitem/workspaceitem-actions.component.ts
View File

@@ -14,6 +14,7 @@ import { SearchService } from '../../../core/shared/search/search.service';
import { getFirstCompletedRemoteData } from '../../../core/shared/operators';
import { RemoteData } from '../../../core/data/remote-data';
import { NoContent } from '../../../core/shared/NoContent.model';
import { getWorkspaceItemViewRoute } from '../../../workspaceitems-edit-page/workspaceitems-edit-page-routing-paths';
/**
* This component represents actions related to WorkspaceItem object.
@@ -48,12 +49,12 @@ export class WorkspaceitemActionsComponent extends MyDSpaceActionsComponent<Work
* @param {RequestService} requestService
*/
constructor(protected injector: Injector,
protected router: Router,
protected modalService: NgbModal,
protected notificationsService: NotificationsService,
protected translate: TranslateService,
protected searchService: SearchService,
protected requestService: RequestService) {
protected router: Router,
protected modalService: NgbModal,
protected notificationsService: NotificationsService,
protected translate: TranslateService,
protected searchService: SearchService,
protected requestService: RequestService) {
super(WorkspaceItem.type, injector, router, notificationsService, translate, searchService, requestService);
}
@@ -85,4 +86,11 @@ export class WorkspaceitemActionsComponent extends MyDSpaceActionsComponent<Work
this.object = object;
}
/**
* Get the workflowitem view route.
*/
getWorkspaceItemViewRoute(workspaceItem: WorkspaceItem): string {
return getWorkspaceItemViewRoute(workspaceItem?.id);
}
}

53
src/app/shared/numeric.util.spec.ts Normal file
View File

@@ -0,0 +1,53 @@
import { isNumeric } from './numeric.util';
describe('Numeric Utils', () => {
describe('isNumeric', () => {
it('should return true for Number values', () => {
expect(isNumeric(0)).toBeTrue();
expect(isNumeric(123456)).toBeTrue();
expect(isNumeric(-123456)).toBeTrue();
expect(isNumeric(0.1234)).toBeTrue();
expect(isNumeric(-0.1234)).toBeTrue();
expect(isNumeric(1234e56)).toBeTrue();
expect(isNumeric(-1234e-56)).toBeTrue();
expect(isNumeric(0x123456)).toBeTrue();
expect(isNumeric(-0x123456)).toBeTrue();
});
it('should return true for numeric String values', () => {
expect(isNumeric('0')).toBeTrue();
expect(isNumeric('123456')).toBeTrue();
expect(isNumeric('-123456')).toBeTrue();
expect(isNumeric('0.1234')).toBeTrue();
expect(isNumeric('-0.1234')).toBeTrue();
expect(isNumeric('1234e56')).toBeTrue();
expect(isNumeric('-1234e-56')).toBeTrue();
expect(isNumeric('0x123456')).toBeTrue();
// expect(isNumeric('-0x123456')).toBeTrue(); // not recognized as numeric, known issue
});
it('should return false for non-numeric String values', () => {
expect(isNumeric('just a regular string')).toBeFalse();
expect(isNumeric('')).toBeFalse();
expect(isNumeric(' ')).toBeFalse();
expect(isNumeric('\n')).toBeFalse();
expect(isNumeric('\t')).toBeFalse();
expect(isNumeric('null')).toBeFalse();
expect(isNumeric('undefined')).toBeFalse();
});
it('should return false for any other kind of value', () => {
expect(isNumeric([1,2,3])).toBeFalse();
expect(isNumeric({ a:1, b:2, c:3 })).toBeFalse();
expect(isNumeric(() => { /* empty */ })).toBeFalse();
expect(isNumeric(null)).toBeFalse();
expect(isNumeric(undefined)).toBeFalse();
expect(isNumeric(true)).toBeFalse();
expect(isNumeric(false)).toBeFalse();
expect(isNumeric(NaN)).toBeFalse();
expect(isNumeric(Infinity)).toBeFalse();
expect(isNumeric(-Infinity)).toBeFalse();
});
});
});

16
src/app/shared/numeric.util.ts Normal file
View File

@@ -0,0 +1,16 @@
/**
* Whether a value is a Number or numeric string.
*
* Taken from RxJs 6.x (licensed under Apache 2.0)
* This function was removed from RxJs 7.x onwards.
*
* @param val: any value
* @returns whether this value is numeric
*/
export function isNumeric(val: any): val is number | string {
// parseFloat NaNs numeric-cast false positives (null|true|false|"")
// ...but misinterprets leading-number strings, particularly hex literals ("0x...")
// subtraction forces infinities to NaN
// adding 1 corrects loss of precision from parseFloat (#15100)
return !Array.isArray(val) && (val - parseFloat(val) + 1) >= 0;
}

8
src/app/shared/object-detail/my-dspace-result-detail-element/item-search-result/item-search-result-detail-element.component.ts
View File

@@ -3,9 +3,12 @@ import { Component } from '@angular/core';
import { ViewMode } from '../../../../core/shared/view-mode.model';
import { Item } from '../../../../core/shared/item.model';
import { SearchResultDetailElementComponent } from '../search-result-detail-element.component';
import { MyDspaceItemStatusType } from '../../../object-collection/shared/mydspace-item-status/my-dspace-item-status-type';
import {
MyDspaceItemStatusType
} from '../../../object-collection/shared/mydspace-item-status/my-dspace-item-status-type';
import { listableObjectComponent } from '../../../object-collection/shared/listable-object/listable-object.decorator';
import { ItemSearchResult } from '../../../object-collection/shared/item-search-result.model';
import { Context } from '../../../../core/shared/context.model';
/**
* This component renders item object for the search result in the detail view.
@@ -16,7 +19,8 @@ import { ItemSearchResult } from '../../../object-collection/shared/item-search-
templateUrl: './item-search-result-detail-element.component.html'
})
@listableObjectComponent(Item, ViewMode.DetailedListElement)
@listableObjectComponent(ItemSearchResult, ViewMode.DetailedListElement, Context.Workspace)
@listableObjectComponent(ItemSearchResult, ViewMode.DetailedListElement, Context.Workflow)
export class ItemSearchResultDetailElementComponent extends SearchResultDetailElementComponent<ItemSearchResult, Item> {
/**

Some files were not shown because too many files have changed in this diff Show More