1 import {Component, OnInit, Input, ViewChild,
2 Output, EventEmitter, TemplateRef} from '@angular/core';
3 import {NgForm} from '@angular/forms';
4 import {IdlService, IdlObject} from '@eg/core/idl.service';
5 import {Observable} from 'rxjs';
6 import {map} from 'rxjs/operators';
7 import {AuthService} from '@eg/core/auth.service';
8 import {PcrudService} from '@eg/core/pcrud.service';
9 import {DialogComponent} from '@eg/share/dialog/dialog.component';
10 import {ToastService} from '@eg/share/toast/toast.service';
11 import {StringComponent} from '@eg/share/string/string.component';
12 import {NgbModal, NgbModalOptions} from '@ng-bootstrap/ng-bootstrap';
13 import {ComboboxEntry} from '@eg/share/combobox/combobox.component';
14 import {FormatService} from '@eg/core/format.service';
15 import {TranslateComponent} from '@eg/share/translate/translate.component';
16 import {FmRecordEditorActionComponent} from './fm-editor-action.component';
17 import {ConfirmDialogComponent} from '@eg/share/dialog/confirm.component';
19 interface CustomFieldTemplate {
20 template: TemplateRef<any>;
22 // Allow the caller to pass in a free-form context blob to
23 // be addedto the caller's custom template context, along
24 // with our stock context.
25 context?: {[fields: string]: any};
28 export interface CustomFieldContext {
29 // Current create/edit/view record
32 // IDL field definition blob
35 // additional context values passed via CustomFieldTemplate
36 [fields: string]: any;
39 // Collection of extra options that may be applied to fields
40 // for controling non-default behaviour.
41 export interface FmFieldOptions {
43 // Render the field as a combobox using these values, regardless
44 // of the field's datatype.
45 customValues?: ComboboxEntry[];
47 // Provide / override the "selector" value for the linked class.
48 // This is the field the combobox will search for typeahead. If no
49 // field is defined, the "selector" field is used. If no "selector"
50 // field exists, the combobox will pre-load all linked values so
51 // the user can click to navigate.
52 linkedSearchField?: string;
54 // When true for combobox fields, pre-fetch the combobox data
55 // so the user can click or type to find values.
56 preloadLinkedValues?: boolean;
58 // Directly override the required state of the field.
59 // This only has an affect if the value is true.
62 // If this function is defined, the function will be called
63 // at render time to see if the field should be marked are required.
64 // This supersedes all other isRequired specifiers.
65 isRequiredOverride?: (field: string, record: IdlObject) => boolean;
67 // Directly apply the readonly status of the field.
68 // This only has an affect if the value is true.
71 // If this function is defined, the function will be called
72 // at render time to see if the field should be marked readonly.
73 // This supersedes all other isReadonly specifiers.
74 isReadonlyOverride?: (field: string, record: IdlObject) => boolean;
76 // Render the field using this custom template instead of chosing
77 // from the default set of form inputs.
78 customTemplate?: CustomFieldTemplate;
82 selector: 'eg-fm-record-editor',
83 templateUrl: './fm-editor.component.html',
84 /* align checkboxes when not using class="form-check" */
85 styles: ['input[type="checkbox"] {margin-left: 0px;}']
87 export class FmRecordEditorComponent
88 extends DialogComponent implements OnInit {
90 // IDL class hint (e.g. "aou")
91 @Input() idlClass: string;
93 // Show datetime fields in this particular timezone
94 timezone: string = this.format.wsOrgTimezone;
96 // Permissions extracted from the permacrud defs in the IDL
97 // for the current IDL class
98 modePerms: {[mode: string]: string};
100 // Collection of FmFieldOptions for specifying non-default
101 // behaviour for each field (by field name).
102 @Input() fieldOptions: {[fieldName: string]: FmFieldOptions} = {};
104 // This is used to set default values when making a new record
105 @Input() defaultNewRecord: IdlObject;
107 // list of fields that should not be displayed
108 @Input() hiddenFieldsList: string[] = [];
109 @Input() hiddenFields: string; // comma-separated string version
111 // list of fields that should always be read-only
112 @Input() readonlyFieldsList: string[] = [];
113 @Input() readonlyFields: string; // comma-separated string version
115 // list of required fields; this supplements what the IDL considers
117 @Input() requiredFieldsList: string[] = [];
118 @Input() requiredFields: string; // comma-separated string version
120 // list of timestamp fields that should display with a timepicker
121 @Input() datetimeFieldsList: string[] = [];
122 @Input() datetimeFields: string; // comma-separated string version
124 // list of org_unit fields where a default value may be applied by
125 // the org-select if no value is present.
126 @Input() orgDefaultAllowedList: string[] = [];
127 @Input() orgDefaultAllowed: string; // comma-separated string version
129 // IDL record display label. Defaults to the IDL label.
130 @Input() recordLabel: string;
132 // When true at the component level, pre-fetch the combobox data
133 // for all combobox fields. See also FmFieldOptions.
134 @Input() preloadLinkedValues: boolean;
136 // Display within a modal dialog window or inline in the page.
137 @Input() displayMode: 'dialog' | 'inline' = 'dialog';
139 // Hide the top 'Record Editor: ...' banner. Primarily useful
140 // for displayMode === 'inline'
141 @Input() hideBanner: boolean;
143 // do not close dialog on error saving record
144 @Input() remainOpenOnError: false;
146 // Emit the modified object when the save action completes.
147 @Output() recordSaved = new EventEmitter<IdlObject>();
149 // Emit the modified object when the save action completes.
150 @Output() recordDeleted = new EventEmitter<IdlObject>();
152 // Emit the original object when the save action is canceled.
153 @Output() recordCanceled = new EventEmitter<IdlObject>();
155 // Emit an error message when the save action fails.
156 @Output() recordError = new EventEmitter<string>();
158 @ViewChild('translator', { static: true }) private translator: TranslateComponent;
159 @ViewChild('successStr', { static: true }) successStr: StringComponent;
160 @ViewChild('failStr', { static: true }) failStr: StringComponent;
161 @ViewChild('confirmDel', { static: true }) confirmDel: ConfirmDialogComponent;
162 @ViewChild('fmEditForm', { static: false}) fmEditForm: NgForm;
164 // IDL info for the the selected IDL class
167 // Can we edit the primary key?
168 pkeyIsEditable = false;
170 // List of IDL field definitions. This is a subset of the full
171 // list of fields on the IDL, since some are hidden, virtual, etc.
174 // DOM id prefix to prevent id collisions.
177 // mode: 'create' for creating a new record,
178 // 'update' for editing an existing record
179 // 'view' for viewing an existing record without editing
180 @Input() mode: 'create' | 'update' | 'view' = 'create';
182 // custom function for munging the record before it gets saved;
183 // will get passed mode and the record itself
184 @Input() preSave: Function;
186 // recordId and record getters and setters.
187 // Note that setting the this.recordId to NULL does not clear the
188 // current value of this.record and vice versa. Only viable data
189 // is actionable. This allows the caller to use both @Input()'s
190 // without each clobbering the other.
192 // Record ID to view/update.
193 _recordId: any = null;
194 @Input() set recordId(id: any) {
196 if (id !== this._recordId) {
198 this._record = null; // force re-fetch
199 this.handleRecordChange();
202 this._recordId = null;
206 get recordId(): any {
207 return this._recordId;
210 // IDL record we are editing
211 _record: IdlObject = null;
212 @Input() set record(r: IdlObject) {
214 if (!this.idl.pkeyMatches(this.record, r)) {
216 this._recordId = null; // avoid mismatch
217 this.handleRecordChange();
224 get record(): IdlObject {
228 actions: FmRecordEditorActionComponent[] = [];
232 // Comma-separated list of field names defining the order in which
233 // fields should be rendered in the form. Any fields not represented
234 // will be rendered alphabetically by label after the named fields.
235 @Input() fieldOrder: string;
237 // When true, show a delete button and support delete operations.
238 @Input() showDelete: boolean;
241 private modal: NgbModal, // required for passing to parent
242 private idl: IdlService,
243 private auth: AuthService,
244 private toast: ToastService,
245 private format: FormatService,
246 private pcrud: PcrudService) {
250 // Avoid fetching data on init since that may lead to unnecessary
254 // In case the caller sets the value to null / undef.
255 if (!this.fieldOptions) { this.fieldOptions = {}; }
257 this.listifyInputs();
258 this.idlDef = this.idl.classes[this.idlClass];
259 this.recordLabel = this.idlDef.label;
261 // Add some randomness to the generated DOM IDs to ensure against clobbering
262 this.idPrefix = 'fm-editor-' + Math.floor(Math.random() * 100000);
264 if (this.isDialog()) {
265 this.onOpen$.subscribe(() => this.initRecord());
269 this.initDone = true;
272 // If the record ID changes after ngOnInit has been called
273 // and we're using displayMode=inline, force the data to
274 // resync in real time
275 handleRecordChange() {
276 if (this.initDone && !this.isDialog()) {
281 open(args?: NgbModalOptions): Observable<any> {
285 // ensure we don't hang on to our copy of the record
286 // if the user dismisses the dialog
287 args.beforeDismiss = () => {
288 this.record = undefined;
291 return super.open(args);
294 isDialog(): boolean {
295 return this.displayMode === 'dialog';
299 return this.fmEditForm ? this.fmEditForm.dirty : false;
302 // DEPRECATED: This is a duplicate of this.record = abc;
303 setRecord(record: IdlObject) {
304 console.warn('fm-editor:setRecord() is deprecated. ' +
305 'Use editor.record = abc or [record]="abc" instead');
306 this.record = record; // this calls the setter
309 // Translate comma-separated string versions of various inputs
311 private listifyInputs() {
312 if (this.hiddenFields) {
313 this.hiddenFieldsList = this.hiddenFields.split(/,/);
315 if (this.readonlyFields) {
316 this.readonlyFieldsList = this.readonlyFields.split(/,/);
318 if (this.requiredFields) {
319 this.requiredFieldsList = this.requiredFields.split(/,/);
321 if (this.datetimeFields) {
322 this.datetimeFieldsList = this.datetimeFields.split(/,/);
324 if (this.orgDefaultAllowed) {
325 this.orgDefaultAllowedList = this.orgDefaultAllowed.split(/,/);
329 private initRecord(): Promise<any> {
331 const pc = this.idlDef.permacrud || {};
333 view: pc.retrieve ? pc.retrieve.perms : [],
334 create: pc.create ? pc.create.perms : [],
335 update: pc.update ? pc.update.perms : [],
338 this.pkeyIsEditable = !('pkey_sequence' in this.idlDef);
340 if (this.mode === 'update' || this.mode === 'view') {
343 if (this.record && this.recordId === null) {
344 promise = Promise.resolve(this.record);
345 } else if (this.recordId) {
347 this.pcrud.retrieve(this.idlClass, this.recordId).toPromise();
349 // Not enough data yet to fetch anything
350 return Promise.resolve();
353 return promise.then(rec => {
356 return Promise.reject(`No '${this.idlClass}'
357 record found with id ${this.recordId}`);
360 // Set this._record (not this.record) to avoid loop in initRecord()
362 this.convertDatatypesToJs();
363 return this.getFieldList();
369 // Create a new record from the stub record provided by the
370 // caller or a new from-scratch record
372 // NOTE: Set this._record (not this.record) to avoid
373 // loop in initRecord()
374 if (this.defaultNewRecord) {
375 // Clone to avoid polluting the stub record
376 this._record = this.idl.clone(this.defaultNewRecord);
378 this._record = this.idl.create(this.idlClass);
381 this._recordId = null; // avoid future confusion
383 return this.getFieldList();
386 // Modifies the FM record in place, replacing IDL-compatible values
387 // with native JS values.
388 private convertDatatypesToJs() {
389 this.idlDef.fields.forEach(field => {
390 if (field.datatype === 'bool') {
391 if (this.record[field.name]() === 't') {
392 this.record[field.name](true);
393 } else if (this.record[field.name]() === 'f') {
394 this.record[field.name](false);
400 // Modifies the provided FM record in place, replacing JS values
401 // with IDL-compatible values.
402 convertDatatypesToIdl(rec: IdlObject) {
403 const fields = this.idlDef.fields.filter(f => !f.virtual);
405 fields.forEach(field => {
406 if (field.datatype === 'bool') {
407 if (rec[field.name]() === true) {
408 rec[field.name]('t');
409 // } else if (rec[field.name]() === false) {
410 } else { // TODO: some bools can be NULL
411 rec[field.name]('f');
413 } else if (field.datatype === 'org_unit') {
414 const org = rec[field.name]();
415 if (org && typeof org === 'object') {
416 rec[field.name](org.id());
422 private flattenLinkedValues(field: any, list: IdlObject[]): ComboboxEntry[] {
423 const class_ = field.class;
424 const fieldOptions = this.fieldOptions[field.name] || {};
425 const idField = this.idl.classes[class_].pkey;
427 const selector = fieldOptions.linkedSearchField
428 || this.idl.getClassSelector(class_) || idField;
430 return list.map(item => {
431 return {id: item[idField](), label: item[selector]()};
435 private getFieldList(): Promise<any> {
437 const fields = this.idlDef.fields.filter(f =>
438 !f.virtual && !this.hiddenFieldsList.includes(f.name));
440 // Wait for all network calls to complete
442 fields.map(field => this.constructOneField(field))
446 if (!this.fieldOrder) {
447 this.fields = fields.sort((a, b) => a.label < b.label ? -1 : 1);
452 const ordered = this.fieldOrder.split(/,/);
454 ordered.forEach(name => {
455 const f1 = fields.filter(f2 => f2.name === name)[0];
456 if (f1) { newList.push(f1); }
459 // Sort remaining fields by label
460 const remainder = fields.filter(f => !ordered.includes(f.name));
461 remainder.sort((a, b) => a.label < b.label ? -1 : 1);
462 newList = newList.concat(remainder);
464 this.fields = newList;
468 private constructOneField(field: any): Promise<any> {
471 const fieldOptions = this.fieldOptions[field.name] || {};
473 if (this.mode === 'view') {
474 field.readOnly = true;
475 } else if (fieldOptions.isReadonlyOverride) {
477 !fieldOptions.isReadonlyOverride(field.name, this.record);
479 field.readOnly = fieldOptions.isReadonly === true
480 || this.readonlyFieldsList.includes(field.name);
483 if (fieldOptions.isRequiredOverride) {
484 field.isRequired = () => {
485 return fieldOptions.isRequiredOverride(field.name, this.record);
488 field.isRequired = () => {
489 return field.required
490 || fieldOptions.isRequired
491 || this.requiredFieldsList.includes(field.name);
495 if (fieldOptions.customValues) {
497 field.linkedValues = fieldOptions.customValues;
499 } else if (field.datatype === 'link' && field.readOnly) {
501 // no need to fetch all possible values for read-only fields
502 const idToFetch = this.record[field.name]();
506 // If the linked class defines a selector field, fetch the
507 // linked data so we can display the data within the selector
508 // field. Otherwise, avoid the network lookup and let the
509 // bare value (usually an ID) be displayed.
510 const selector = fieldOptions.linkedSearchField ||
511 this.idl.getClassSelector(field.class);
513 if (selector && selector !== field.name) {
514 promise = this.pcrud.retrieve(field.class, idToFetch)
515 .toPromise().then(list => {
517 this.flattenLinkedValues(field, Array(list));
520 // No selector, display the raw id/key value.
521 field.linkedValues = [{id: idToFetch, name: idToFetch}];
525 } else if (field.datatype === 'link') {
527 promise = this.wireUpCombobox(field);
529 } else if (field.datatype === 'timestamp') {
530 field.datetime = this.datetimeFieldsList.includes(field.name);
531 } else if (field.datatype === 'org_unit') {
532 field.orgDefaultAllowed =
533 this.orgDefaultAllowedList.includes(field.name);
536 if (fieldOptions.customTemplate) {
537 field.template = fieldOptions.customTemplate.template;
538 field.context = fieldOptions.customTemplate.context;
541 return promise || Promise.resolve();
544 wireUpCombobox(field: any): Promise<any> {
546 const fieldOptions = this.fieldOptions[field.name] || {};
548 // globally preloading unless a field-specific value is set.
549 if (this.preloadLinkedValues) {
550 if (!('preloadLinkedValues' in fieldOptions)) {
551 fieldOptions.preloadLinkedValues = true;
555 const selector = fieldOptions.linkedSearchField ||
556 this.idl.getClassSelector(field.class);
558 if (!selector && !fieldOptions.preloadLinkedValues) {
559 // User probably expects an async data source, but we can't
560 // provide one without a selector. Warn the user.
561 console.warn(`Class ${field.class} has no selector.
562 Pre-fetching all rows for combobox`);
565 if (fieldOptions.preloadLinkedValues || !selector) {
566 return this.pcrud.retrieveAll(field.class, {}, {atomic : true})
567 .toPromise().then(list => {
569 this.flattenLinkedValues(field, list);
573 // If we have a selector, wire up for async data retrieval
574 field.linkedValuesSource =
575 (term: string): Observable<ComboboxEntry> => {
578 const orderBy = {order_by: {}};
579 const idField = this.idl.classes[field.class].pkey || 'id';
581 search[selector] = {'ilike': `%${term}%`};
582 orderBy.order_by[field.class] = selector;
584 return this.pcrud.search(field.class, search, orderBy)
585 .pipe(map(idlThing =>
586 // Map each object into a ComboboxEntry upon arrival
587 this.flattenLinkedValues(field, [idlThing])[0]
591 // Using an async data source, but a value is already set
592 // on the field. Fetch the linked object and add it to the
593 // combobox entry list so it will be avilable for display
594 // at dialog load time.
595 const linkVal = this.record[field.name]();
596 if (linkVal !== null && linkVal !== undefined) {
597 return this.pcrud.retrieve(field.class, linkVal).toPromise()
600 this.flattenLinkedValues(field, Array(idlThing));
604 // No linked value applied, nothing to pre-fetch.
605 return Promise.resolve();
608 // Returns a context object to be inserted into a custom
610 customTemplateFieldContext(fieldDef: any): CustomFieldContext {
611 return Object.assign(
612 { record : this.record,
613 field: fieldDef // from this.fields
614 }, fieldDef.context || {}
619 const recToSave = this.idl.clone(this.record);
621 this.preSave(this.mode, recToSave);
623 this.convertDatatypesToIdl(recToSave);
624 this.pcrud[this.mode]([recToSave]).toPromise().then(
626 this.recordSaved.emit(result);
627 if (this.fmEditForm) {
628 this.fmEditForm.form.markAsPristine();
630 this.successStr.current().then(msg => this.toast.success(msg));
631 if (this.isDialog()) { this.record = undefined; this.close(result); }
634 this.recordError.emit(error);
635 this.failStr.current().then(msg => this.toast.warning(msg));
636 if (this.isDialog() && !this.remainOpenOnError) { this.error(error); }
642 this.confirmDel.open().subscribe(confirmed => {
643 if (!confirmed) { return; }
644 const recToRemove = this.idl.clone(this.record);
645 this.pcrud.remove(recToRemove).toPromise().then(
647 this.recordDeleted.emit(result);
648 this.successStr.current().then(msg => this.toast.success(msg));
649 if (this.isDialog()) { this.close(result); }
652 this.recordError.emit(error);
653 this.failStr.current().then(msg => this.toast.warning(msg));
654 if (this.isDialog() && !this.remainOpenOnError) { this.error(error); }
661 this.recordCanceled.emit(this.record);
662 this.record = undefined;
667 this.record = undefined;
671 // Returns a string describing the type of input to display
672 // for a given field. This helps cut down on the if/else
673 // nesti-ness in the template. Each field will match
675 inputType(field: any): string {
677 if (field.template) {
681 if ( field.datatype === 'timestamp' && field.datetime ) {
682 return 'timestamp-timepicker';
685 // Some widgets handle readOnly for us.
686 if ( field.datatype === 'timestamp'
687 || field.datatype === 'org_unit'
688 || field.datatype === 'bool') {
689 return field.datatype;
692 if (field.readOnly) {
693 if (field.datatype === 'money') {
694 return 'readonly-money';
697 if (field.datatype === 'link' && field.class === 'au') {
698 return 'readonly-au';
701 if (field.datatype === 'link' || field.linkedValues) {
702 return 'readonly-list';
708 if (field.datatype === 'id' && !this.pkeyIsEditable) {
712 if ( field.datatype === 'int'
713 || field.datatype === 'float'
714 || field.datatype === 'money') {
715 return field.datatype;
718 if (field.datatype === 'link' || field.linkedValues) {
722 // datatype == text / interval / editable-pkey
726 openTranslator(field: string) {
727 this.translator.fieldName = field;
728 this.translator.idlObject = this.record;
730 this.translator.open().subscribe(
733 this.record[field](newValue);