search filter: implement advanced search on brief view

* Updates routes to add advanced search filter.
* Fixes number of parameters for component implement RecordSearchPage.
* Closes rero/rero-ils#1824.
* Uses ng-core version 1.8.x.
* Fixes tests.
* Adds a new karma package to display the test name in the console:
  `karma-spec-reporter`.

Co-Authored-by: Bertrand Zuchuat <[email protected]>

angular.json

@@ -64,7 +64,12 @@
         "serve": {
           "builder": "@angular-devkit/build-angular:dev-server",
           "options": {
-            "browserTarget": "admin:build"
+            "browserTarget": "admin:build",
+            "sourceMap": {
+              "scripts": true,
+              "styles": false,
+              "vendor": true
+            }
           },
           "configurations": {
             "production": {

package.json

@@ -79,7 +79,7 @@
     "@ngx-loading-bar/http-client": "^5.1.1",
     "@ngx-loading-bar/router": "^5.1.1",
     "@ngx-translate/core": "^13.0.0",
-    "@rero/ng-core": "~1.7.0",
+    "@rero/ng-core": "^1.8.0",
     "bootstrap": "^4.6.0",
     "crypto-js": "^3.3.0",
     "document-register-element": "^1.14.10",
@@ -118,6 +118,7 @@
     "karma-chrome-launcher": "~3.1.0",
     "karma-jasmine": "~4.0.0",
     "karma-jasmine-html-reporter": "^1.5.4",
+    "karma-spec-reporter": "0.0.32",
     "ng-packagr": "^10.1.2",
     "protractor": "~7.0.0",
     "ts-node": "~9.0.0",

projects/admin/karma.conf.js

@@ -9,7 +9,8 @@ module.exports = function (config) {
       require('karma-jasmine'),
       require('karma-chrome-launcher'),
       require('karma-jasmine-html-reporter'),
-      require('@angular-devkit/build-angular/plugins/karma')
+      require('@angular-devkit/build-angular/plugins/karma'),
+      require('karma-spec-reporter')
     ],
     client: {
       clearContext: false // leave Jasmine Spec Runner output visible in browser
@@ -19,7 +20,7 @@ module.exports = function (config) {
       reports: ['html', 'lcovonly', 'text-summary'],
       fixWebpackSourcePaths: true
     },
-    reporters: ['progress', 'kjhtml'],
+    reporters: ['progress', 'kjhtml', 'spec'],
     port: 9876,
     colors: true,
     logLevel: config.LOG_INFO,

projects/admin/src/app/menu/menu-dashboard/menu-dashboard.component.spec.ts

@@ -17,6 +17,7 @@
 
 import { HttpClientTestingModule } from '@angular/common/http/testing';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { RouterTestingModule } from '@angular/router/testing';
 import { TranslateModule } from '@ngx-translate/core';
 import { IdAttributePipe, SharedModule, testUserPatronWithSettings, UserApiService, UserService } from '@rero/shared';
 import { cloneDeep } from 'lodash-es';
@@ -37,6 +38,7 @@ describe('MenuDashboardComponent', () => {
       imports: [
         SharedModule,
         HttpClientTestingModule,
+        RouterTestingModule,
         TranslateModule.forRoot()
       ],
       providers: [

projects/admin/src/app/menu/menu-language/menu-language.component.spec.ts

@@ -17,6 +17,7 @@
 
 import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { RouterTestingModule } from '@angular/router/testing';
 import { TranslateModule, TranslateService } from '@ngx-translate/core';
 import { BsLocaleService } from 'ngx-bootstrap/datepicker';
 import { MenuLanguageComponent } from './menu-language.component';
@@ -31,7 +32,8 @@ describe('MenuLanguageComponent', () => {
     await TestBed.configureTestingModule({
       declarations: [ MenuLanguageComponent ],
       imports: [
-        TranslateModule.forRoot()
+        TranslateModule.forRoot(),
+        RouterTestingModule
       ],
       providers: [
         BsLocaleService

projects/admin/src/app/menu/menu-user-services/menu-user-services.component.spec.ts

@@ -18,6 +18,7 @@
 import { HttpClientTestingModule } from '@angular/common/http/testing';
 import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { RouterTestingModule } from '@angular/router/testing';
 import { TranslateModule } from '@ngx-translate/core';
 import { MenuUserServicesService } from '../service/menu-user-services.service';
 import { MenuUserServicesComponent } from './menu-user-services.component';
@@ -35,6 +36,7 @@ describe('MenuUserServicesComponent', () => {
       declarations: [ MenuUserServicesComponent ],
       imports: [
         HttpClientTestingModule,
+        RouterTestingModule,
         TranslateModule.forRoot()
       ],
       providers: [

projects/admin/src/app/menu/menu.component.ts

@@ -16,7 +16,9 @@
  */
 
 import { Component, OnInit } from '@angular/core';
+import { NavigationEnd, Router, UrlSegment } from '@angular/router';
 import { SearchBarConfigService, UserService } from '@rero/shared';
+import { filter } from 'rxjs/operators';
 
 @Component({
   selector: 'admin-menu',
@@ -37,31 +39,58 @@ export class MenuComponent implements OnInit {
   /** Autocomplte query params */
   autocompleteQueryParams: any = { page: '1', size: '10' };
 
+  /** Is document url */
+  private hideSearchElement = false;
+
+  /** Resources involved in hiding the search area */
+  private hideSearchResources = ['documents'];
+
   /**
    * Get Typehead option limit
    * @return number
    */
-  get typeaheadOptionsLimit() {
+  get typeaheadOptionsLimit(): number {
     return this._searchBarConfigService.typeaheadOptionsLimit;
   }
 
+  /**
+   * Get hide search
+   * @return boolean
+   */
+  get hideSearch(): boolean {
+    return this.hideSearchElement;
+  }
+
   /**
    * Constructor
    * @param _userService - UserService
    * @param _searchBarConfigService - SearchBarConfigService
+   * @param _router - Router
    */
   constructor(
     private _userService: UserService,
-    private _searchBarConfigService: SearchBarConfigService
-  ) {}
+    private _searchBarConfigService: SearchBarConfigService,
+    private _router: Router
+  ) { }
 
   /** Init */
   ngOnInit() {
+    this._hideSearch();
+    this._router.events
+      .pipe(filter(event => event instanceof NavigationEnd))
+      .subscribe(() => this._hideSearch());
     const currentUser = this._userService.user;
     this.autocompleteQueryParams.organisation = currentUser.currentOrganisation;
 
     this.recordTypes = this._searchBarConfigService.getConfig(
       true, this, undefined, this.maxLengthSuggestion
     );
   }
+
+  /** Search the resource to determine whether to hide the search  */
+  private _hideSearch(): void {
+    this.hideSearchElement =
+      this._router.parseUrl(this._router.url).root.children.primary?.segments
+      .some((segment: UrlSegment) => this.hideSearchResources.includes(segment.path));
+  }
 }

projects/admin/src/app/record/document-record-search/document-record-search.component.ts

@@ -17,7 +17,7 @@
 
 import { Component, OnInit } from '@angular/core';
 import { ActivatedRoute, Router } from '@angular/router';
-import { SearchResult, RecordSearchPageComponent, RecordSearchService, RecordService } from '@rero/ng-core';
+import { SearchResult, RecordSearchPageComponent, RecordSearchService, RecordService, RecordUiService } from '@rero/ng-core';
 
 @Component({
   selector: 'admin-document-record-search',
@@ -58,18 +58,20 @@ export class DocumentRecordSearchComponent extends RecordSearchPageComponent imp
 
   /**
    * Constructor
-   * @param _route - ActivatedRoute
+   * @param _activatedRoute - ActivatedRoute
    * @param _router - Router
    * @param _recordSearchService - RecordSearchService
+   * @param _recordUiService - RecordUiService
    * @param _recordService - RecordService
    */
   constructor(
-    protected _route: ActivatedRoute,
+    protected _activatedRoute: ActivatedRoute,
     protected _router: Router,
     protected _recordSearchService: RecordSearchService,
-    private _recordService: RecordService
+    protected _recordUiService: RecordUiService,
+    private _recordService: RecordService,
   ) {
-    super(_route, _router, _recordSearchService);
+    super(_activatedRoute, _router, _recordSearchService, _recordUiService);
   }
 
   /** Init */
@@ -94,7 +96,7 @@ export class DocumentRecordSearchComponent extends RecordSearchPageComponent imp
    */
   linkToGlobalDocuments(event: any) {
     event.preventDefault();
-    const queryParams = this._route.snapshot.queryParams;
+    const queryParams = this._activatedRoute.snapshot.queryParams;
     this._router.navigate(
       [this._baseUrl],
       { relativeTo: this._route, queryParams: {

projects/admin/src/app/routes/acquisition-orders-route.ts

@@ -52,11 +52,10 @@ export class AcquisitionOrdersRoute extends BaseRoute implements RouteInterface
             label: _('Orders'),
             component: AcquisitionOrderBriefViewComponent,
             detailComponent: AcquisitionOrderDetailViewComponent,
+            searchFilters: [
+              this.expertSearchFilter()
+            ],
             permissions: (record: any) => this._routeToolService.permissions(record, this.recordType),
-            // use simple query for UI search
-            preFilters: {
-              simple: 1
-            },
             preCreateRecord: (data: any) => {
               const user = this._routeToolService.userService.user;
               data.order_date = formatDate(

projects/admin/src/app/routes/base-route.ts

@@ -15,9 +15,10 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { UrlSegment } from '@angular/router';
-import { RouteToolService } from './route-tool.service';
+import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
 import { extractIdOnRef } from '@rero/ng-core';
 import { of } from 'rxjs';
+import { RouteToolService } from './route-tool.service';
 
 export class BaseRoute {
 
@@ -93,4 +94,41 @@ export class BaseRoute {
       : recordMetadata.pid;
     return of(`${baseUrl}/${pid}`);
   }
+
+  /**
+   * Expert search filter configuration
+   * @return Object - Search filter configuration
+   */
+  protected expertSearchFilter() {
+    return {
+      label: _('Expert search'),
+      filter: 'simple',
+      value: '0',
+      disabledValue: '1',
+      persistent: true,
+      // TODO: activate this part when the help is online
+      // and correct the links of the help
+      // url: {
+      //   external: true,
+      //   link: this._expertSearchLink(),
+      //   title: this._routeToolService.translateService.instant('Link to expert search help')
+      // }
+    };
+  }
+
+  /**
+   * Expert search link
+   * @return string, link of help page
+   */
+  private _expertSearchLink() {
+    const defaultPath = 'help/recherche';
+    const searchPaths = {
+      fr: 'help/recherche'
+      // TODO: Add other paths
+    };
+    const availableLanguages = Object.keys(searchPaths);
+    return (this._routeToolService.translateService.currentLang in availableLanguages)
+      ? searchPaths[this._routeToolService.translateService.currentLang]
+      : defaultPath;
+    }
  }

projects/admin/src/app/routes/budgets-route.ts

@@ -50,13 +50,12 @@ export class BudgetsRoute extends BaseRoute implements RouteInterface {
             label: _('Budgets'),
             component: BudgetsBriefViewComponent,
             detailComponent: BudgetDetailViewComponent,
+            searchFilters: [
+              this.expertSearchFilter()
+            ],
             canAdd: () => this._routeToolService.canSystemLibrarian(),
             canUpdate: (record: any) => this._routeToolService.canUpdate(record, this.recordType),
             canDelete: () => this._routeToolService.canNot(),
-            // use simple query for UI search
-            preFilters: {
-              simple: 1
-            },
             preCreateRecord: (data: any) => {
               const user = this._routeToolService.userService.user;
               data.organisation = {

projects/admin/src/app/routes/circulation-policies-route.ts

@@ -62,12 +62,11 @@ export class CirculationPoliciesRoute extends BaseRoute implements RouteInterfac
             },
             component: CircPoliciesBriefViewComponent,
             detailComponent: CircPolicyDetailViewComponent,
+            searchFilters: [
+              this.expertSearchFilter()
+            ],
             canAdd: () => this._routeToolService.canSystemLibrarian(),
             permissions: (record: any) => this._routeToolService.permissions(record, this.recordType),
-            // use simple query for UI search
-            preFilters: {
-              simple: 1
-            },
             preCreateRecord: (data: any) => {
               const user: User = this._routeToolService.userService.user;
               if (data.parent == null) {

projects/admin/src/app/routes/collections-route.ts

@@ -52,12 +52,11 @@ export class CollectionsRoute extends BaseRoute implements RouteInterface {
             label: 'Exhibition/course',
             component: CollectionBriefViewComponent,
             detailComponent: CollectionDetailViewComponent,
+            searchFilters: [
+              this.expertSearchFilter()
+            ],
             canAdd: () => this._routeToolService.can(),
             permissions: (record: any) => this._routeToolService.permissions(record, this.recordType),
-            // use simple query for UI search
-            preFilters: {
-              simple: 1
-            },
             aggregationsOrder: ['type', 'library', 'teacher', 'subject'],
             aggregationsExpand: ['type'],
             preprocessRecordEditor: (record: any) => {

projects/admin/src/app/routes/corporate-bodies-route.ts

@@ -48,13 +48,11 @@ export class CorporateBodiesRoute extends BaseRoute implements RouteInterface {
             label: 'corporate-bodies',
             component: ContributionBriefComponent,
             detailComponent: ContributionDetailViewComponent,
+            searchFilters: [
+              this.expertSearchFilter()
+            ],
             aggregationsOrder: ['sources'],
-            aggregationsExpand: ['sources'],
-            // use simple query for UI search
-            preFilters: {
-              type: 'bf:Organisation',
-              simple: 1
-            }
+            aggregationsExpand: ['sources']
           }
         ]
       }