1 import {Component, OnInit, Input, ViewChild,
2 Output, EventEmitter, TemplateRef} from '@angular/core';
3 import {IdlService, IdlObject} from '@eg/core/idl.service';
4 import {Observable} from 'rxjs';
5 import {map} from 'rxjs/operators';
6 import {AuthService} from '@eg/core/auth.service';
7 import {PcrudService} from '@eg/core/pcrud.service';
8 import {DialogComponent} from '@eg/share/dialog/dialog.component';
9 import {ToastService} from '@eg/share/toast/toast.service';
10 import {StringComponent} from '@eg/share/string/string.component';
11 import {NgbModal, NgbModalOptions} from '@ng-bootstrap/ng-bootstrap';
12 import {ComboboxEntry} from '@eg/share/combobox/combobox.component';
13 import {FormatService} from '@eg/core/format.service';
14 import {TranslateComponent} from '@eg/share/translate/translate.component';
15 import {FmRecordEditorActionComponent} from './fm-editor-action.component';
16 import {ConfirmDialogComponent} from '@eg/share/dialog/confirm.component';
18 interface CustomFieldTemplate {
19 template: TemplateRef<any>;
21 // Allow the caller to pass in a free-form context blob to
22 // be addedto the caller's custom template context, along
23 // with our stock context.
24 context?: {[fields: string]: any};
27 export interface CustomFieldContext {
28 // Current create/edit/view record
31 // IDL field definition blob
34 // additional context values passed via CustomFieldTemplate
35 [fields: string]: any;
38 // Collection of extra options that may be applied to fields
39 // for controling non-default behaviour.
40 export interface FmFieldOptions {
42 // Render the field as a combobox using these values, regardless
43 // of the field's datatype.
44 customValues?: ComboboxEntry[];
46 // Provide / override the "selector" value for the linked class.
47 // This is the field the combobox will search for typeahead. If no
48 // field is defined, the "selector" field is used. If no "selector"
49 // field exists, the combobox will pre-load all linked values so
50 // the user can click to navigate.
51 linkedSearchField?: string;
53 // When true for combobox fields, pre-fetch the combobox data
54 // so the user can click or type to find values.
55 preloadLinkedValues?: boolean;
57 // Directly override the required state of the field.
58 // This only has an affect if the value is true.
61 // If this function is defined, the function will be called
62 // at render time to see if the field should be marked are required.
63 // This supersedes all other isRequired specifiers.
64 isRequiredOverride?: (field: string, record: IdlObject) => boolean;
66 // Directly apply the readonly status of the field.
67 // This only has an affect if the value is true.
70 // If this function is defined, the function will be called
71 // at render time to see if the field should be marked readonly.
72 // This supersedes all other isReadonly specifiers.
73 isReadonlyOverride?: (field: string, record: IdlObject) => boolean;
75 // Render the field using this custom template instead of chosing
76 // from the default set of form inputs.
77 customTemplate?: CustomFieldTemplate;
81 selector: 'eg-fm-record-editor',
82 templateUrl: './fm-editor.component.html',
83 /* align checkboxes when not using class="form-check" */
84 styles: ['input[type="checkbox"] {margin-left: 0px;}']
86 export class FmRecordEditorComponent
87 extends DialogComponent implements OnInit {
89 // IDL class hint (e.g. "aou")
90 @Input() idlClass: string;
92 // Show datetime fields in this particular timezone
93 timezone: string = this.format.wsOrgTimezone;
95 // Permissions extracted from the permacrud defs in the IDL
96 // for the current IDL class
97 modePerms: {[mode: string]: string};
99 // Collection of FmFieldOptions for specifying non-default
100 // behaviour for each field (by field name).
101 @Input() fieldOptions: {[fieldName: string]: FmFieldOptions} = {};
103 // list of fields that should not be displayed
104 @Input() hiddenFieldsList: string[] = [];
105 @Input() hiddenFields: string; // comma-separated string version
107 // list of fields that should always be read-only
108 @Input() readonlyFieldsList: string[] = [];
109 @Input() readonlyFields: string; // comma-separated string version
111 // list of required fields; this supplements what the IDL considers
113 @Input() requiredFieldsList: string[] = [];
114 @Input() requiredFields: string; // comma-separated string version
116 // list of timestamp fields that should display with a timepicker
117 @Input() datetimeFieldsList: string[] = [];
118 @Input() datetimeFields: string; // comma-separated string version
120 // list of org_unit fields where a default value may be applied by
121 // the org-select if no value is present.
122 @Input() orgDefaultAllowedList: string[] = [];
123 @Input() orgDefaultAllowed: string; // comma-separated string version
125 // IDL record display label. Defaults to the IDL label.
126 @Input() recordLabel: string;
128 // When true at the component level, pre-fetch the combobox data
129 // for all combobox fields. See also FmFieldOptions.
130 @Input() preloadLinkedValues: boolean;
132 // Display within a modal dialog window or inline in the page.
133 @Input() displayMode: 'dialog' | 'inline' = 'dialog';
135 // Hide the top 'Record Editor: ...' banner. Primarily useful
136 // for displayMode === 'inline'
137 @Input() hideBanner: boolean;
139 // Emit the modified object when the save action completes.
140 @Output() recordSaved = new EventEmitter<IdlObject>();
142 // Emit the modified object when the save action completes.
143 @Output() recordDeleted = new EventEmitter<IdlObject>();
145 // Emit the original object when the save action is canceled.
146 @Output() recordCanceled = new EventEmitter<IdlObject>();
148 // Emit an error message when the save action fails.
149 @Output() recordError = new EventEmitter<string>();
151 @ViewChild('translator', { static: true }) private translator: TranslateComponent;
152 @ViewChild('successStr', { static: true }) successStr: StringComponent;
153 @ViewChild('failStr', { static: true }) failStr: StringComponent;
154 @ViewChild('confirmDel', { static: true }) confirmDel: ConfirmDialogComponent;
156 // IDL info for the the selected IDL class
159 // Can we edit the primary key?
160 pkeyIsEditable = false;
162 // List of IDL field definitions. This is a subset of the full
163 // list of fields on the IDL, since some are hidden, virtual, etc.
166 // DOM id prefix to prevent id collisions.
169 // mode: 'create' for creating a new record,
170 // 'update' for editing an existing record
171 // 'view' for viewing an existing record without editing
172 @Input() mode: 'create' | 'update' | 'view' = 'create';
174 // custom function for munging the record before it gets saved;
175 // will get passed mode and the record itself
176 @Input() preSave: Function;
178 // recordId and record getters and setters.
179 // Note that setting the this.recordId to NULL does not clear the
180 // current value of this.record and vice versa. Only viable data
181 // is actionable. This allows the caller to use both @Input()'s
182 // without each clobbering the other.
184 // Record ID to view/update.
185 _recordId: any = null;
186 @Input() set recordId(id: any) {
188 if (id !== this._recordId) {
190 this._record = null; // force re-fetch
191 this.handleRecordChange();
194 this._recordId = null;
198 get recordId(): any {
199 return this._recordId;
202 // IDL record we are editing
203 _record: IdlObject = null;
204 @Input() set record(r: IdlObject) {
206 if (!this.idl.pkeyMatches(this.record, r)) {
208 this._recordId = null; // avoid mismatch
209 this.handleRecordChange();
216 get record(): IdlObject {
220 actions: FmRecordEditorActionComponent[] = [];
224 // Comma-separated list of field names defining the order in which
225 // fields should be rendered in the form. Any fields not represented
226 // will be rendered alphabetically by label after the named fields.
227 @Input() fieldOrder: string;
229 // When true, show a delete button and support delete operations.
230 @Input() showDelete: boolean;
233 private modal: NgbModal, // required for passing to parent
234 private idl: IdlService,
235 private auth: AuthService,
236 private toast: ToastService,
237 private format: FormatService,
238 private pcrud: PcrudService) {
242 // Avoid fetching data on init since that may lead to unnecessary
246 // In case the caller sets the value to null / undef.
247 if (!this.fieldOptions) { this.fieldOptions = {}; }
249 this.listifyInputs();
250 this.idlDef = this.idl.classes[this.idlClass];
251 this.recordLabel = this.idlDef.label;
253 // Add some randomness to the generated DOM IDs to ensure against clobbering
254 this.idPrefix = 'fm-editor-' + Math.floor(Math.random() * 100000);
256 if (this.isDialog()) {
257 this.onOpen$.subscribe(() => this.initRecord());
261 this.initDone = true;
264 // If the record ID changes after ngOnInit has been called
265 // and we're using displayMode=inline, force the data to
266 // resync in real time
267 handleRecordChange() {
268 if (this.initDone && !this.isDialog()) {
273 open(args?: NgbModalOptions): Observable<any> {
277 // ensure we don't hang on to our copy of the record
278 // if the user dismisses the dialog
279 args.beforeDismiss = () => {
280 this.record = undefined;
283 return super.open(args);
286 isDialog(): boolean {
287 return this.displayMode === 'dialog';
290 // DEPRECATED: This is a duplicate of this.record = abc;
291 setRecord(record: IdlObject) {
292 console.warn('fm-editor:setRecord() is deprecated. ' +
293 'Use editor.record = abc or [record]="abc" instead');
294 this.record = record; // this calls the setter
297 // Translate comma-separated string versions of various inputs
299 private listifyInputs() {
300 if (this.hiddenFields) {
301 this.hiddenFieldsList = this.hiddenFields.split(/,/);
303 if (this.readonlyFields) {
304 this.readonlyFieldsList = this.readonlyFields.split(/,/);
306 if (this.requiredFields) {
307 this.requiredFieldsList = this.requiredFields.split(/,/);
309 if (this.datetimeFields) {
310 this.datetimeFieldsList = this.datetimeFields.split(/,/);
312 if (this.orgDefaultAllowed) {
313 this.orgDefaultAllowedList = this.orgDefaultAllowed.split(/,/);
317 private initRecord(): Promise<any> {
319 const pc = this.idlDef.permacrud || {};
321 view: pc.retrieve ? pc.retrieve.perms : [],
322 create: pc.create ? pc.create.perms : [],
323 update: pc.update ? pc.update.perms : [],
326 this.pkeyIsEditable = !('pkey_sequence' in this.idlDef);
328 if (this.mode === 'update' || this.mode === 'view') {
331 if (this.record && this.recordId === null) {
332 promise = Promise.resolve(this.record);
333 } else if (this.recordId) {
335 this.pcrud.retrieve(this.idlClass, this.recordId).toPromise();
337 // Not enough data yet to fetch anything
338 return Promise.resolve();
341 return promise.then(rec => {
344 return Promise.reject(`No '${this.idlClass}'
345 record found with id ${this.recordId}`);
348 // Set this._record (not this.record) to avoid loop in initRecord()
350 this.convertDatatypesToJs();
351 return this.getFieldList();
357 // Create a new record from the stub record provided by the
358 // caller or a new from-scratch record
359 // Set this._record (not this.record) to avoid loop in initRecord()
360 this._record = this.record || this.idl.create(this.idlClass);
361 this._recordId = null; // avoid future confusion
363 return this.getFieldList();
366 // Modifies the FM record in place, replacing IDL-compatible values
367 // with native JS values.
368 private convertDatatypesToJs() {
369 this.idlDef.fields.forEach(field => {
370 if (field.datatype === 'bool') {
371 if (this.record[field.name]() === 't') {
372 this.record[field.name](true);
373 } else if (this.record[field.name]() === 'f') {
374 this.record[field.name](false);
380 // Modifies the provided FM record in place, replacing JS values
381 // with IDL-compatible values.
382 convertDatatypesToIdl(rec: IdlObject) {
383 const fields = this.idlDef.fields.filter(f => !f.virtual);
385 fields.forEach(field => {
386 if (field.datatype === 'bool') {
387 if (rec[field.name]() === true) {
388 rec[field.name]('t');
389 // } else if (rec[field.name]() === false) {
390 } else { // TODO: some bools can be NULL
391 rec[field.name]('f');
393 } else if (field.datatype === 'org_unit') {
394 const org = rec[field.name]();
395 if (org && typeof org === 'object') {
396 rec[field.name](org.id());
402 // Returns the name of the field on a class (typically via a linked
403 // field) that acts as the selector value for display / search.
404 getClassSelector(class_: string): string {
406 const linkedClass = this.idl.classes[class_];
407 return linkedClass.pkey ?
408 linkedClass.field_map[linkedClass.pkey].selector : null;
413 private flattenLinkedValues(field: any, list: IdlObject[]): ComboboxEntry[] {
414 const class_ = field.class;
415 const fieldOptions = this.fieldOptions[field.name] || {};
416 const idField = this.idl.classes[class_].pkey;
418 const selector = fieldOptions.linkedSearchField
419 || this.getClassSelector(class_) || idField;
421 return list.map(item => {
422 return {id: item[idField](), label: item[selector]()};
426 private getFieldList(): Promise<any> {
428 const fields = this.idlDef.fields.filter(f =>
429 !f.virtual && !this.hiddenFieldsList.includes(f.name));
431 // Wait for all network calls to complete
433 fields.map(field => this.constructOneField(field))
437 if (!this.fieldOrder) {
438 this.fields = fields.sort((a, b) => a.label < b.label ? -1 : 1);
443 const ordered = this.fieldOrder.split(/,/);
445 ordered.forEach(name => {
446 const f1 = fields.filter(f2 => f2.name === name)[0];
447 if (f1) { newList.push(f1); }
450 // Sort remaining fields by label
451 const remainder = fields.filter(f => !ordered.includes(f.name));
452 remainder.sort((a, b) => a.label < b.label ? -1 : 1);
453 newList = newList.concat(remainder);
455 this.fields = newList;
459 private constructOneField(field: any): Promise<any> {
462 const fieldOptions = this.fieldOptions[field.name] || {};
464 if (this.mode === 'view') {
465 field.readOnly = true;
466 } else if (fieldOptions.isReadonlyOverride) {
468 !fieldOptions.isReadonlyOverride(field.name, this.record);
470 field.readOnly = fieldOptions.isReadonly === true
471 || this.readonlyFieldsList.includes(field.name);
474 if (fieldOptions.isRequiredOverride) {
475 field.isRequired = () => {
476 return fieldOptions.isRequiredOverride(field.name, this.record);
479 field.isRequired = () => {
480 return field.required
481 || fieldOptions.isRequired
482 || this.requiredFieldsList.includes(field.name);
486 if (fieldOptions.customValues) {
488 field.linkedValues = fieldOptions.customValues;
490 } else if (field.datatype === 'link' && field.readOnly) {
492 // no need to fetch all possible values for read-only fields
493 const idToFetch = this.record[field.name]();
497 // If the linked class defines a selector field, fetch the
498 // linked data so we can display the data within the selector
499 // field. Otherwise, avoid the network lookup and let the
500 // bare value (usually an ID) be displayed.
501 const selector = fieldOptions.linkedSearchField ||
502 this.getClassSelector(field.class);
504 if (selector && selector !== field.name) {
505 promise = this.pcrud.retrieve(field.class, idToFetch)
506 .toPromise().then(list => {
508 this.flattenLinkedValues(field, Array(list));
511 // No selector, display the raw id/key value.
512 field.linkedValues = [{id: idToFetch, name: idToFetch}];
516 } else if (field.datatype === 'link') {
518 promise = this.wireUpCombobox(field);
520 } else if (field.datatype === 'timestamp') {
521 field.datetime = this.datetimeFieldsList.includes(field.name);
522 } else if (field.datatype === 'org_unit') {
523 field.orgDefaultAllowed =
524 this.orgDefaultAllowedList.includes(field.name);
527 if (fieldOptions.customTemplate) {
528 field.template = fieldOptions.customTemplate.template;
529 field.context = fieldOptions.customTemplate.context;
532 return promise || Promise.resolve();
535 wireUpCombobox(field: any): Promise<any> {
537 const fieldOptions = this.fieldOptions[field.name] || {};
539 // globally preloading unless a field-specific value is set.
540 if (this.preloadLinkedValues) {
541 if (!('preloadLinkedValues' in fieldOptions)) {
542 fieldOptions.preloadLinkedValues = true;
546 const selector = fieldOptions.linkedSearchField ||
547 this.getClassSelector(field.class);
549 if (!selector && !fieldOptions.preloadLinkedValues) {
550 // User probably expects an async data source, but we can't
551 // provide one without a selector. Warn the user.
552 console.warn(`Class ${field.class} has no selector.
553 Pre-fetching all rows for combobox`);
556 if (fieldOptions.preloadLinkedValues || !selector) {
557 return this.pcrud.retrieveAll(field.class, {}, {atomic : true})
558 .toPromise().then(list => {
560 this.flattenLinkedValues(field, list);
564 // If we have a selector, wire up for async data retrieval
565 field.linkedValuesSource =
566 (term: string): Observable<ComboboxEntry> => {
569 const orderBy = {order_by: {}};
570 const idField = this.idl.classes[field.class].pkey || 'id';
572 search[selector] = {'ilike': `%${term}%`};
573 orderBy.order_by[field.class] = selector;
575 return this.pcrud.search(field.class, search, orderBy)
576 .pipe(map(idlThing =>
577 // Map each object into a ComboboxEntry upon arrival
578 this.flattenLinkedValues(field, [idlThing])[0]
582 // Using an async data source, but a value is already set
583 // on the field. Fetch the linked object and add it to the
584 // combobox entry list so it will be avilable for display
585 // at dialog load time.
586 const linkVal = this.record[field.name]();
587 if (linkVal !== null && linkVal !== undefined) {
588 return this.pcrud.retrieve(field.class, linkVal).toPromise()
591 this.flattenLinkedValues(field, Array(idlThing));
595 // No linked value applied, nothing to pre-fetch.
596 return Promise.resolve();
599 // Returns a context object to be inserted into a custom
601 customTemplateFieldContext(fieldDef: any): CustomFieldContext {
602 return Object.assign(
603 { record : this.record,
604 field: fieldDef // from this.fields
605 }, fieldDef.context || {}
610 const recToSave = this.idl.clone(this.record);
612 this.preSave(this.mode, recToSave);
614 this.convertDatatypesToIdl(recToSave);
615 this.pcrud[this.mode]([recToSave]).toPromise().then(
617 this.recordSaved.emit(result);
618 this.successStr.current().then(msg => this.toast.success(msg));
619 if (this.isDialog()) { this.record = undefined; this.close(result); }
622 this.recordError.emit(error);
623 this.failStr.current().then(msg => this.toast.warning(msg));
624 if (this.isDialog()) { this.error(error); }
630 this.confirmDel.open().subscribe(confirmed => {
631 if (!confirmed) { return; }
632 const recToRemove = this.idl.clone(this.record);
633 this.pcrud.remove(recToRemove).toPromise().then(
635 this.recordDeleted.emit(result);
636 this.successStr.current().then(msg => this.toast.success(msg));
637 if (this.isDialog()) { this.close(result); }
640 this.recordError.emit(error);
641 this.failStr.current().then(msg => this.toast.warning(msg));
642 if (this.isDialog()) { this.error(error); }
649 this.recordCanceled.emit(this.record);
650 this.record = undefined;
655 this.record = undefined;
659 // Returns a string describing the type of input to display
660 // for a given field. This helps cut down on the if/else
661 // nesti-ness in the template. Each field will match
663 inputType(field: any): string {
665 if (field.template) {
669 if ( field.datatype === 'timestamp' && field.datetime ) {
670 return 'timestamp-timepicker';
673 // Some widgets handle readOnly for us.
674 if ( field.datatype === 'timestamp'
675 || field.datatype === 'org_unit'
676 || field.datatype === 'bool') {
677 return field.datatype;
680 if (field.readOnly) {
681 if (field.datatype === 'money') {
682 return 'readonly-money';
685 if (field.datatype === 'link' && field.class === 'au') {
686 return 'readonly-au';
689 if (field.datatype === 'link' || field.linkedValues) {
690 return 'readonly-list';
696 if (field.datatype === 'id' && !this.pkeyIsEditable) {
700 if ( field.datatype === 'int'
701 || field.datatype === 'float'
702 || field.datatype === 'money') {
703 return field.datatype;
706 if (field.datatype === 'link' || field.linkedValues) {
710 // datatype == text / interval / editable-pkey
714 openTranslator(field: string) {
715 this.translator.fieldName = field;
716 this.translator.idlObject = this.record;
718 this.translator.open().subscribe(
721 this.record[field](newValue);