Open-ILS/src/eg2/src/app/share/combobox/combobox.component.ts

   1 /**
   2  * <eg-combobox [allowFreeText]="true" [entries]="comboboxEntryList"/>
   3  *  <!-- see also <eg-combobox-entry> -->
   4  * </eg-combobox>
   5  */
   6 import {Component, OnInit, Input, Output, ViewChild,
   7     Directive, ViewChildren, QueryList, AfterViewInit,
   8     OnChanges, SimpleChanges,
   9     TemplateRef, EventEmitter, ElementRef, forwardRef} from '@angular/core';
  10 import {ControlValueAccessor, NG_VALUE_ACCESSOR} from '@angular/forms';
  11 import {Observable, of, Subject} from 'rxjs';
  12 import {map, tap, reduce, mergeMap, mapTo, debounceTime, distinctUntilChanged, merge, filter} from 'rxjs/operators';
  13 import {NgbTypeahead, NgbTypeaheadSelectItemEvent} from '@ng-bootstrap/ng-bootstrap';
  14 import {StoreService} from '@eg/core/store.service';
  15 import {IdlService, IdlObject} from '@eg/core/idl.service';
  16 import {PcrudService} from '@eg/core/pcrud.service';
  17 import {OrgService} from '@eg/core/org.service';
  18
  19 export interface ComboboxEntry {
  20   id: any;
  21   // If no label is provided, the 'id' value is used.
  22   label?: string;
  23   freetext?: boolean;
  24   userdata?: any; // opaque external value; ignored by this component.
  25   fm?: IdlObject;
  26 }
  27
  28 @Directive({
  29     selector: 'ng-template[egIdlClass]'
  30 })
  31 export class IdlClassTemplateDirective {
  32   @Input() egIdlClass: string;
  33   constructor(public template: TemplateRef<any>) {}
  34 }
  35
  36 @Component({
  37   selector: 'eg-combobox',
  38   templateUrl: './combobox.component.html',
  39   styles: [`
  40     .icons {margin-left:-18px}
  41     .material-icons {font-size: 16px;font-weight:bold}
  42   `],
  43   providers: [{
  44     provide: NG_VALUE_ACCESSOR,
  45     useExisting: forwardRef(() => ComboboxComponent),
  46     multi: true
  47   }]
  48 })
  49 export class ComboboxComponent implements ControlValueAccessor, OnInit, AfterViewInit, OnChanges {
  50
  51     selected: ComboboxEntry;
  52     click$: Subject<string>;
  53     entrylist: ComboboxEntry[];
  54
  55     @ViewChild('instance', { static: true }) instance: NgbTypeahead;
  56     @ViewChild('defaultDisplayTemplate', { static: true}) defaultDisplayTemplate: TemplateRef<any>;
  57     @ViewChildren(IdlClassTemplateDirective) idlClassTemplates: QueryList<IdlClassTemplateDirective>;
  58
  59     // Applies a name attribute to the input.
  60     // Useful in forms.
  61     @Input() name: string;
  62
  63     // Placeholder text for selector input
  64     @Input() placeholder = '';
  65
  66     @Input() persistKey: string; // TODO
  67
  68     @Input() allowFreeText = false;
  69
  70     @Input() inputSize: number = null;
  71
  72     // Add a 'required' attribute to the input
  73     isRequired: boolean;
  74     @Input() set required(r: boolean) {
  75         this.isRequired = r;
  76     }
  77
  78     // Disable the input
  79     isDisabled: boolean;
  80     @Input() set disabled(d: boolean) {
  81         this.isDisabled = d;
  82     }
  83
  84     // Entry ID of the default entry to select (optional)
  85     // onChange() is NOT fired when applying the default value,
  86     // unless startIdFiresOnChange is set to true.
  87     @Input() startId: any = null;
  88     @Input() idlClass: string;
  89     @Input() startIdFiresOnChange: boolean;
  90
  91     // Allow the selected entry ID to be passed via the template
  92     // This does NOT not emit onChange events.
  93     @Input() set selectedId(id: any) {
  94         if (id === undefined) { return; }
  95
  96         // clear on explicit null
  97         if (id === null) { this.selected = null; }
  98
  99         if (this.entrylist.length) {
 100             this.selected = this.entrylist.filter(e => e.id === id)[0];
 101         }
 102
 103         if (!this.selected) {
 104             // It's possible the selected ID lives in a set of entries
 105             // that are yet to be provided.
 106             this.startId = id;
 107             if (this.idlClass) {
 108                 this.pcrud.retrieve(this.idlClass, id)
 109                 .subscribe(rec => {
 110                     this.entrylist = [{
 111                         id: id,
 112                         label: this.getFmRecordLabel(rec),
 113                         fm: rec
 114                     }];
 115                     this.selected = this.entrylist.filter(e => e.id === id)[0];
 116                 });
 117             }
 118         }
 119     }
 120
 121     get selectedId(): any {
 122         return this.selected ? this.selected.id : null;
 123     }
 124
 125     @Input() idlField: string;
 126     @Input() idlIncludeLibraryInLabel: string;
 127     @Input() asyncDataSource: (term: string) => Observable<ComboboxEntry>;
 128
 129     // If true, an async data search is allowed to fetch all
 130     // values when given an empty term. This should be used only
 131     // if the maximum number of entries returned by the data source
 132     // is known to be no more than a couple hundred.
 133     @Input() asyncSupportsEmptyTermClick: boolean;
 134
 135     // Useful for efficiently preventing duplicate async entries
 136     asyncIds: {[idx: string]: boolean};
 137
 138     // True if a default selection has been made.
 139     defaultSelectionApplied: boolean;
 140
 141     @Input() set entries(el: ComboboxEntry[]) {
 142         if (el) {
 143
 144             if (this.entrylistMatches(el)) {
 145                 // Avoid reprocessing data we already have.
 146                 return;
 147             }
 148
 149             this.entrylist = el;
 150
 151             // new set of entries essentially means a new instance. reset.
 152             this.defaultSelectionApplied = false;
 153             this.applySelection();
 154
 155             // It's possible to provide an entrylist at load time, but
 156             // fetch all future data via async data source.  Track the
 157             // values we already have so async lookup won't add them again.
 158             // A new entry list wipes out any existing async values.
 159             this.asyncIds = {};
 160             el.forEach(entry => this.asyncIds['' + entry.id] = true);
 161         }
 162     }
 163
 164     // When provided use this as the display template for each entry.
 165     @Input() displayTemplate: TemplateRef<any>;
 166
 167     // Emitted when the value is changed via UI.
 168     // When the UI value is cleared, null is emitted.
 169     @Output() onChange: EventEmitter<ComboboxEntry>;
 170
 171     // Useful for massaging the match string prior to comparison
 172     // and display.  Default version trims leading/trailing spaces.
 173     formatDisplayString: (e: ComboboxEntry) => string;
 174
 175     idlDisplayTemplateMap: { [key: string]: TemplateRef<any> } = {};
 176     getFmRecordLabel: (fm: IdlObject) => string;
 177
 178     // Stub functions required by ControlValueAccessor
 179     propagateChange = (_: any) => {};
 180     propagateTouch = () => {};
 181
 182     constructor(
 183       private elm: ElementRef,
 184       private store: StoreService,
 185       private idl: IdlService,
 186       private pcrud: PcrudService,
 187       private org: OrgService,
 188     ) {
 189         this.entrylist = [];
 190         this.asyncIds = {};
 191         this.click$ = new Subject<string>();
 192         this.onChange = new EventEmitter<ComboboxEntry>();
 193         this.defaultSelectionApplied = false;
 194
 195         this.formatDisplayString = (result: ComboboxEntry) => {
 196             const display = result.label || result.id;
 197             return (display + '').trim();
 198         };
 199
 200         this.getFmRecordLabel = (fm: IdlObject) => {
 201             // FIXME: it would be cleaner if we could somehow use
 202             // the per-IDL-class ng-templates directly
 203             switch (this.idlClass) {
 204                 case 'acqf':
 205                     return fm.code() + ' (' + fm.year() + ')';
 206                     break;
 207                 case 'acpl':
 208                     return fm.name() + ' (' + this.getOrgShortname(fm.owning_lib()) + ')';
 209                     break;
 210                 default:
 211                     const field = this.idlField;
 212                     if (this.idlIncludeLibraryInLabel) {
 213                         return fm[field]() + ' (' + fm[this.idlIncludeLibraryInLabel]().shortname() + ')';
 214                     } else {
 215                         return fm[field]();
 216                     }
 217             }
 218         };
 219     }
 220
 221     ngOnInit() {
 222         if (this.idlClass) {
 223             const classDef = this.idl.classes[this.idlClass];
 224             const pkeyField = classDef.pkey;
 225
 226             if (!pkeyField) {
 227                 throw new Error(`IDL class ${this.idlClass} has no pkey field`);
 228             }
 229
 230             if (!this.idlField) {
 231                 this.idlField = this.idl.getClassSelector(this.idlClass);
 232             }
 233
 234             this.asyncDataSource = term => {
 235                 const field = this.idlField;
 236                 const args = {};
 237                 const extra_args = { order_by : {} };
 238                 args[field] = {'ilike': `%${term}%`}; // could -or search on label
 239                 extra_args['order_by'][this.idlClass] = field;
 240                 extra_args['limit'] = 100;
 241                 if (this.idlIncludeLibraryInLabel) {
 242                     extra_args['flesh'] = 1;
 243                     const flesh_fields: Object = {};
 244                     flesh_fields[this.idlClass] = [ this.idlIncludeLibraryInLabel ];
 245                     extra_args['flesh_fields'] = flesh_fields;
 246                     return this.pcrud.search(this.idlClass, args, extra_args).pipe(map(data => {
 247                         return {
 248                             id: data[pkeyField](),
 249                             label: this.getFmRecordLabel(data),
 250                             fm: data
 251                         };
 252                     }));
 253                 } else {
 254                     return this.pcrud.search(this.idlClass, args, extra_args).pipe(map(data => {
 255                         return {id: data[pkeyField](), label: this.getFmRecordLabel(data), fm: data};
 256                     }));
 257                 }
 258             };
 259         }
 260     }
 261
 262     ngAfterViewInit() {
 263         this.idlDisplayTemplateMap = this.idlClassTemplates.reduce((acc, cur) => {
 264             acc[cur.egIdlClass] = cur.template;
 265             return acc;
 266         }, {});
 267     }
 268
 269     ngOnChanges(changes: SimpleChanges) {
 270         let firstTime = true;
 271         Object.keys(changes).forEach(key => {
 272             if (!changes[key].firstChange) {
 273                 firstTime = false;
 274             }
 275         });
 276         if (!firstTime) {
 277             if ('selectedId' in changes) {
 278                 if (!changes.selectedId.currentValue) {
 279                     this.selected = null;
 280                 }
 281             }
 282             if ('idlClass' in changes) {
 283                 if (!('idlField' in changes)) {
 284                     // let ngOnInit reset it to the
 285                     // selector of the new IDL class
 286                     this.idlField = null;
 287                 }
 288                 this.asyncIds = {};
 289                 this.entrylist.length = 0;
 290                 this.selected = null;
 291                 this.ngOnInit();
 292             }
 293         }
 294     }
 295
 296     onClick($event) {
 297         this.click$.next($event.target.value);
 298     }
 299
 300     getResultTemplate(): TemplateRef<any> {
 301         if (this.displayTemplate) {
 302             return this.displayTemplate;
 303         }
 304         if (this.idlClass in this.idlDisplayTemplateMap) {
 305             return this.idlDisplayTemplateMap[this.idlClass];
 306         }
 307         return this.defaultDisplayTemplate;
 308     }
 309
 310     getOrgShortname(ou: any) {
 311         if (typeof ou === 'object') {
 312             return ou.shortname();
 313         } else {
 314             return this.org.get(ou).shortname();
 315         }
 316     }
 317
 318     openMe($event) {
 319         // Give the input a chance to focus then fire the click
 320         // handler to force open the typeahead
 321         this.elm.nativeElement.getElementsByTagName('input')[0].focus();
 322         setTimeout(() => this.click$.next(''));
 323     }
 324
 325     // Returns true if the 2 entries are equivalent.
 326     entriesMatch(e1: ComboboxEntry, e2: ComboboxEntry): boolean {
 327         return (
 328             e1 && e2 &&
 329             e1.id === e2.id &&
 330             e1.label === e2.label &&
 331             e1.freetext === e2.freetext
 332         );
 333     }
 334
 335     // Returns true if the 2 lists are equivalent.
 336     entrylistMatches(el: ComboboxEntry[]): boolean {
 337         if (el.length === 0 && this.entrylist.length === 0) {
 338             // Empty arrays are only equivalent if they are the same array,
 339             // since the caller may provide an array that starts empty, but
 340             // is later populated.
 341             return el === this.entrylist;
 342         }
 343         if (el.length !== this.entrylist.length) {
 344             return false;
 345         }
 346         for (let i = 0; i < el.length; i++) {
 347             const mine = this.entrylist[i];
 348             if (!mine || !this.entriesMatch(mine, el[i])) {
 349                 return false;
 350             }
 351         }
 352         return true;
 353     }
 354
 355     // Apply a default selection where needed
 356     applySelection() {
 357
 358         if (this.startId !== null &&
 359             this.entrylist && !this.defaultSelectionApplied) {
 360
 361             const entry =
 362                 this.entrylist.filter(e => e.id === this.startId)[0];
 363
 364             if (entry) {
 365                 this.selected = entry;
 366                 this.defaultSelectionApplied = true;
 367                 if (this.startIdFiresOnChange) {
 368                     this.selectorChanged(
 369                         {item: this.selected, preventDefault: () => true});
 370                 }
 371             }
 372         }
 373     }
 374
 375     // Called by combobox-entry.component
 376     addEntry(entry: ComboboxEntry) {
 377         this.entrylist.push(entry);
 378         this.applySelection();
 379     }
 380
 381     // Manually set the selected value by ID.
 382     // This does NOT fire the onChange handler.
 383     // DEPRECATED: use this.selectedId = abc or [selectedId]="abc" instead.
 384     applyEntryId(entryId: any) {
 385         this.selected = this.entrylist.filter(e => e.id === entryId)[0];
 386     }
 387
 388     addAsyncEntry(entry: ComboboxEntry) {
 389         // Avoid duplicate async entries
 390         if (!this.asyncIds['' + entry.id]) {
 391             this.asyncIds['' + entry.id] = true;
 392             this.addEntry(entry);
 393         }
 394     }
 395
 396     hasEntry(entryId: any): boolean {
 397         return this.entrylist.filter(e => e.id === entryId)[0] !== undefined;
 398     }
 399
 400     onBlur() {
 401         // When the selected value is a string it means we have either
 402         // no value (user cleared the input) or a free-text value.
 403
 404         if (typeof this.selected === 'string') {
 405
 406             if (this.allowFreeText && this.selected !== '') {
 407                 // Free text entered which does not match a known entry
 408                 // translate it into a dummy ComboboxEntry
 409                 this.selected = {
 410                     id: null,
 411                     label: this.selected,
 412                     freetext: true
 413                 };
 414
 415             } else {
 416
 417                 this.selected = null;
 418             }
 419
 420             // Manually fire the onchange since NgbTypeahead fails
 421             // to fire the onchange when the value is cleared.
 422             this.selectorChanged(
 423                 {item: this.selected, preventDefault: () => true});
 424         }
 425         this.propagateTouch();
 426     }
 427
 428     // Fired by the typeahead to inform us of a change.
 429     selectorChanged(selEvent: NgbTypeaheadSelectItemEvent) {
 430         this.onChange.emit(selEvent.item);
 431         this.propagateChange(selEvent.item);
 432     }
 433
 434     // Adds matching async entries to the entry list
 435     // and propagates the search term for pipelining.
 436     addAsyncEntries(term: string): Observable<string> {
 437
 438         if (!term || !this.asyncDataSource) {
 439             return of(term);
 440         }
 441
 442         let searchTerm: string;
 443         searchTerm = term;
 444         if (searchTerm === '_CLICK_') {
 445             if (this.asyncSupportsEmptyTermClick) {
 446                 searchTerm = '';
 447             } else {
 448                 return of();
 449             }
 450         }
 451
 452         return new Observable(observer => {
 453             this.asyncDataSource(searchTerm).subscribe(
 454                 (entry: ComboboxEntry) => this.addAsyncEntry(entry),
 455                 err => {},
 456                 ()  => {
 457                     observer.next(searchTerm);
 458                     observer.complete();
 459                 }
 460             );
 461         });
 462     }
 463
 464     filter = (text$: Observable<string>): Observable<ComboboxEntry[]> => {
 465         return text$.pipe(
 466             debounceTime(200),
 467             distinctUntilChanged(),
 468
 469             // Merge click actions in with the stream of text entry
 470             merge(
 471                 // Inject a specifier indicating the source of the
 472                 // action is a user click instead of a text entry.
 473                 // This tells the filter to show all values in sync mode.
 474                 this.click$.pipe(filter(() =>
 475                     !this.instance.isPopupOpen()
 476                 )).pipe(mapTo('_CLICK_'))
 477             ),
 478
 479             // mergeMap coalesces an observable into our stream.
 480             mergeMap(term => this.addAsyncEntries(term)),
 481             map((term: string) => {
 482
 483                 // Display no values when the input is empty and no
 484                 // click action occurred.
 485                 if (term === '') { return []; }
 486
 487                 // In sync-data mode, a click displays the full list.
 488                 if (term === '_CLICK_' && !this.asyncDataSource) {
 489                     return this.entrylist;
 490                 }
 491
 492                 // Filter entrylist whose labels substring-match the
 493                 // text entered.
 494                 return this.entrylist.filter(entry => {
 495                     const label = entry.label || entry.id;
 496                     return label.toLowerCase().indexOf(term.toLowerCase()) > -1;
 497                 });
 498             })
 499         );
 500     }
 501
 502     writeValue(value: ComboboxEntry) {
 503         if (value !== undefined && value !== null) {
 504             this.startId = value.id;
 505             this.applySelection();
 506         }
 507     }
 508
 509     registerOnChange(fn) {
 510         this.propagateChange = fn;
 511     }
 512
 513     registerOnTouched(fn) {
 514         this.propagateTouch = fn;
 515     }
 516
 517 }
 518
 519