smartdata/ts/smartdata.classes.doc.ts

152 lines
3.6 KiB
TypeScript
Raw Permalink Normal View History

import * as plugins from './smartdata.plugins';
2016-09-13 20:53:21 +00:00
import { Objectmap } from 'lik';
2017-02-25 10:37:05 +00:00
import { SmartdataDb } from './smartdata.classes.db';
2018-07-09 22:02:04 +00:00
import { SmartdataCollection } from './smartdata.classes.collection';
2016-09-13 20:53:21 +00:00
export type TDocCreation = 'db' | 'new' | 'mixed';
2016-09-13 20:53:21 +00:00
2016-11-17 23:42:25 +00:00
/**
2016-11-17 23:59:57 +00:00
* saveable - saveable decorator to be used on class properties
2016-11-17 23:42:25 +00:00
*/
2016-11-18 12:56:15 +00:00
export function svDb() {
2018-07-09 22:02:04 +00:00
return (target: SmartDataDbDoc<any>, key: string) => {
console.log(`called svDb() on ${key}`);
if (!target.saveableProperties) {
target.saveableProperties = [];
}
target.saveableProperties.push(key);
};
2016-11-17 23:42:25 +00:00
}
/**
* unique index - decorator to mark a unique index
*/
export function unI() {
return (target: SmartDataDbDoc<any>, key: string) => {
console.log('called unI');
// mark the index as unique
if (!target.uniqueIndexes) {
target.uniqueIndexes = [];
}
target.uniqueIndexes.push(key);
// and also save it
if (!target.saveableProperties) {
target.saveableProperties = [];
}
target.saveableProperties.push(key);
};
2019-01-07 01:41:38 +00:00
}
2018-07-09 22:02:04 +00:00
export class SmartDataDbDoc<T> {
2017-02-25 10:37:05 +00:00
/**
* the collection object an Doc belongs to
*/
collection: SmartdataCollection<T>;
2016-11-17 23:42:25 +00:00
2017-02-25 10:37:05 +00:00
/**
* how the Doc in memory was created, may prove useful later.
*/
creationStatus: TDocCreation = 'new';
2016-11-17 23:42:25 +00:00
/**
* unique indexes
*/
uniqueIndexes: string[];
2017-02-25 10:37:05 +00:00
/**
* an array of saveable properties of a doc
*/
saveableProperties: string[];
2016-11-17 23:42:25 +00:00
2017-06-18 17:52:54 +00:00
/**
* name
*/
name: string;
2017-06-18 17:52:54 +00:00
/**
* primary id in the database
*/
dbDocUniqueId: string;
2017-02-25 10:37:05 +00:00
/**
* class constructor
*/
constructor() {
this.name = this.constructor['name'];
2018-07-09 22:02:04 +00:00
this.collection = this.constructor['smartdataCollection'];
}
static async getInstances<T>(filterArg): Promise<T[]> {
let self: any = this; // fool typesystem
2018-07-09 22:02:04 +00:00
let referenceMongoDBCollection: SmartdataCollection<T> = self.smartdataCollection;
const foundDocs = await referenceMongoDBCollection.find(filterArg);
const returnArray = [];
for (let item of foundDocs) {
let newInstance = new this();
for (let key in item) {
if (key !== 'id') {
newInstance[key] = item[key];
}
}
returnArray.push(newInstance);
}
return returnArray;
}
static async getInstance<T>(filterArg): Promise<T> {
let result = await this.getInstances<T>(filterArg);
if (result && result.length > 0) {
return result[0];
}
2017-02-25 10:37:05 +00:00
}
2016-11-17 23:42:25 +00:00
2017-02-25 10:37:05 +00:00
/**
* saves this instance but not any connected items
* may lead to data inconsistencies, but is faster
*/
async save() {
let self: any = this;
switch (this.creationStatus) {
case 'db':
await this.collection.update(self);
break;
case 'new':
let writeResult = await this.collection.insert(self);
this.creationStatus = 'db';
break;
default:
console.error('neither new nor in db?');
2017-02-25 10:37:05 +00:00
}
}
2017-02-25 10:37:05 +00:00
/**
* also store any referenced objects to DB
* better for data consistency
*/
2018-07-09 22:02:04 +00:00
saveDeep(savedMapArg: Objectmap<SmartDataDbDoc<any>> = null) {
2017-02-25 10:37:05 +00:00
if (!savedMapArg) {
2018-07-09 22:02:04 +00:00
savedMapArg = new Objectmap<SmartDataDbDoc<any>>();
2017-02-25 10:37:05 +00:00
}
savedMapArg.add(this);
this.save();
2017-02-25 10:37:05 +00:00
for (let propertyKey in this) {
let property: any = this[propertyKey];
2018-07-09 22:02:04 +00:00
if (property instanceof SmartDataDbDoc && !savedMapArg.checkForObject(property)) {
property.saveDeep(savedMapArg);
2017-02-25 10:37:05 +00:00
}
2016-09-13 20:53:21 +00:00
}
2017-02-25 10:37:05 +00:00
}
async createSavableObject() {
let saveableObject: any = {}; // is not exposed to outside, so any is ok here
for (let propertyNameString of this.saveableProperties) {
saveableObject[propertyNameString] = this[propertyNameString];
}
return saveableObject;
}
2016-09-13 20:53:21 +00:00
}