2
0
mirror of https://github.com/frappe/books.git synced 2024-12-22 19:09:01 +00:00
books/reports/Report.ts
18alantom c6ca4f4e4c fix: Reports Date filter field issue
- update Report Issue template
2023-03-02 15:50:03 +05:30

104 lines
2.5 KiB
TypeScript

import { Fyo } from 'fyo';
import { Converter } from 'fyo/core/converter';
import { DocValue } from 'fyo/core/types';
import { Action } from 'fyo/model/types';
import Observable from 'fyo/utils/observable';
import { Field, RawValue } from 'schemas/types';
import { getIsNullOrUndef } from 'utils';
import { ColumnField, ReportData } from './types';
export abstract class Report extends Observable<RawValue> {
static title: string;
static reportName: string;
static isInventory: boolean = false;
fyo: Fyo;
columns: ColumnField[] = [];
filters: Field[] = [];
reportData: ReportData;
usePagination: boolean = false;
shouldRefresh: boolean = false;
abstract loading: boolean;
constructor(fyo: Fyo) {
super();
this.fyo = fyo;
this.reportData = [];
}
get title() {
// @ts-ignore
return this.constructor.title;
}
get reportName() {
// @ts-ignore
return this.constructor.reportName;
}
async initialize() {
/**
* Not in constructor cause possibly async.
*/
await this.setDefaultFilters();
this.filters = await this.getFilters();
this.columns = await this.getColumns();
await this.setReportData();
}
get filterMap() {
const filterMap: Record<string, RawValue> = {};
for (const { fieldname } of this.filters) {
const value = this.get(fieldname);
if (getIsNullOrUndef(value)) {
continue;
}
filterMap[fieldname] = value;
}
return filterMap;
}
async set(key: string, value: DocValue, callPostSet: boolean = true) {
const field = this.filters.find((f) => f.fieldname === key);
if (field === undefined) {
return;
}
value = Converter.toRawValue(value, field, this.fyo);
const prevValue = this[key];
if (prevValue === value) {
return;
}
if (getIsNullOrUndef(value)) {
delete this[key];
} else {
this[key] = value;
}
if (callPostSet) {
await this.updateData(key);
}
}
async updateData(key?: string, force?: boolean) {
await this.setDefaultFilters();
this.filters = await this.getFilters();
this.columns = await this.getColumns();
await this.setReportData(key, force);
}
/**
* Should first check if filter value is set
* and update only if it is not set.
*/
async setDefaultFilters() {}
abstract getActions(): Action[];
abstract getFilters(): Field[] | Promise<Field[]>;
abstract getColumns(): ColumnField[] | Promise<ColumnField[]>;
abstract setReportData(filter?: string, force?: boolean): Promise<void>;
}