mirror of
https://github.com/frappe/books.git
synced 2024-12-24 03:45:35 +00:00
a09fa62f5f
- remove getSingle - remove SalesInvoiceSettings cause unused
175 lines
4.1 KiB
TypeScript
175 lines
4.1 KiB
TypeScript
import { Doc } from 'fyo/model/doc';
|
|
import { DocMap, ModelMap, SinglesMap } from 'fyo/model/types';
|
|
import { coreModels } from 'fyo/models';
|
|
import { NotFoundError, ValueError } from 'fyo/utils/errors';
|
|
import Observable from 'fyo/utils/observable';
|
|
import { Schema } from 'schemas/types';
|
|
import { getRandomString } from 'utils';
|
|
import { Fyo } from '..';
|
|
import { DocValueMap } from './types';
|
|
|
|
export class DocHandler {
|
|
fyo: Fyo;
|
|
models: ModelMap = {};
|
|
singles: SinglesMap = {};
|
|
docs: Observable<DocMap | undefined> = new Observable();
|
|
observer: Observable<never> = new Observable();
|
|
|
|
constructor(fyo: Fyo) {
|
|
this.fyo = fyo;
|
|
}
|
|
|
|
init() {
|
|
this.models = {};
|
|
this.singles = {};
|
|
this.docs = new Observable();
|
|
this.observer = new Observable();
|
|
}
|
|
|
|
purgeCache() {
|
|
this.init();
|
|
}
|
|
|
|
registerModels(models: ModelMap, regionalModels: ModelMap = {}) {
|
|
for (const schemaName in this.fyo.db.schemaMap) {
|
|
if (coreModels[schemaName] !== undefined) {
|
|
this.models[schemaName] = coreModels[schemaName];
|
|
} else if (regionalModels[schemaName] !== undefined) {
|
|
this.models[schemaName] = regionalModels[schemaName];
|
|
} else if (models[schemaName] !== undefined) {
|
|
this.models[schemaName] = models[schemaName];
|
|
} else {
|
|
this.models[schemaName] = Doc;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Doc Operations
|
|
*/
|
|
|
|
async getDoc(
|
|
schemaName: string,
|
|
name?: string,
|
|
options = { skipDocumentCache: false }
|
|
) {
|
|
if (name === undefined) {
|
|
name = schemaName;
|
|
}
|
|
|
|
if (name === schemaName && !this.fyo.schemaMap[schemaName]?.isSingle) {
|
|
throw new ValueError(`${schemaName} is not a Single Schema`);
|
|
}
|
|
|
|
let doc: Doc | undefined;
|
|
if (!options?.skipDocumentCache) {
|
|
doc = this.#getFromCache(schemaName, name);
|
|
}
|
|
|
|
if (doc) {
|
|
return doc;
|
|
}
|
|
|
|
doc = this.getNewDoc(schemaName, { name });
|
|
await doc.load();
|
|
this.#addToCache(doc);
|
|
|
|
return doc;
|
|
}
|
|
|
|
getNewDoc(
|
|
schemaName: string,
|
|
data: DocValueMap = {},
|
|
cacheDoc: boolean = true,
|
|
schema?: Schema,
|
|
Model?: typeof Doc
|
|
): Doc {
|
|
if (!this.models[schemaName] && Model) {
|
|
this.models[schemaName] = Model;
|
|
}
|
|
|
|
Model ??= this.models[schemaName];
|
|
schema ??= this.fyo.schemaMap[schemaName];
|
|
|
|
if (schema === undefined) {
|
|
throw new NotFoundError(`Schema not found for ${schemaName}`);
|
|
}
|
|
|
|
const doc = new Model!(schema, data, this.fyo);
|
|
doc.name ??= getRandomString();
|
|
if (cacheDoc) {
|
|
this.#addToCache(doc);
|
|
}
|
|
|
|
return doc;
|
|
}
|
|
|
|
/**
|
|
* Cache operations
|
|
*/
|
|
|
|
#addToCache(doc: Doc) {
|
|
if (!doc.name) {
|
|
return;
|
|
}
|
|
|
|
const name = doc.name;
|
|
const schemaName = doc.schemaName;
|
|
|
|
if (!this.docs[schemaName]) {
|
|
this.docs.set(schemaName, {});
|
|
this.#setCacheUpdationListeners(schemaName);
|
|
}
|
|
|
|
this.docs.get(schemaName)![name] = doc;
|
|
|
|
// singles available as first level objects too
|
|
if (schemaName === doc.name) {
|
|
this.singles[name] = doc;
|
|
}
|
|
|
|
// propagate change to `docs`
|
|
doc.on('change', (params: unknown) => {
|
|
this.docs!.trigger('change', params);
|
|
});
|
|
|
|
doc.on('afterSync', () => {
|
|
if (doc.name === name) {
|
|
return;
|
|
}
|
|
|
|
this.#removeFromCache(doc.schemaName, name);
|
|
this.#addToCache(doc);
|
|
});
|
|
}
|
|
|
|
#setCacheUpdationListeners(schemaName: string) {
|
|
this.fyo.db.observer.on(`delete:${schemaName}`, (name: string) => {
|
|
this.#removeFromCache(schemaName, name);
|
|
});
|
|
|
|
this.fyo.db.observer.on(
|
|
`rename:${schemaName}`,
|
|
(names: { oldName: string; newName: string }) => {
|
|
const doc = this.#getFromCache(schemaName, names.oldName);
|
|
if (doc === undefined) {
|
|
return;
|
|
}
|
|
|
|
this.#removeFromCache(schemaName, names.oldName);
|
|
this.#addToCache(doc);
|
|
}
|
|
);
|
|
}
|
|
|
|
#removeFromCache(schemaName: string, name: string) {
|
|
const docMap = this.docs.get(schemaName);
|
|
delete docMap?.[name];
|
|
}
|
|
|
|
#getFromCache(schemaName: string, name: string): Doc | undefined {
|
|
const docMap = this.docs.get(schemaName);
|
|
return docMap?.[name];
|
|
}
|
|
}
|