import * as plugins from './smartdata.plugins'; import { SmartdataDb } from './smartdata.classes.db'; import { SmartDataDbDoc } from './smartdata.classes.doc'; export interface IFindOptions { limit?: number; } /** * */ export interface IDocValidationFunc { (doc: T): boolean; } export type TDelayedDbCreation = () => SmartdataDb; /** * This is a decorator that will tell the decorated class what dbTable to use * @param dbArg */ export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) { return function (constructor) { if (dbArg instanceof SmartdataDb) { // tslint:disable-next-line: no-string-literal constructor['smartdataCollection'] = new SmartdataCollection(constructor, dbArg); } else { constructor['smartdataDelayedCollection'] = () => { return new SmartdataCollection(constructor, dbArg()); }; } }; } export class SmartdataCollection { /** * the collection that is used */ public mongoDbCollection: plugins.mongodb.Collection; public objectValidation: IDocValidationFunc = null; public collectionName: string; public smartdataDb: SmartdataDb; public uniqueIndexes: string[] = []; constructor(collectedClassArg: T & SmartDataDbDoc, smartDataDbArg: SmartdataDb) { // tell the collection where it belongs this.collectionName = collectedClassArg.name; this.smartdataDb = smartDataDbArg; // tell the db class about it (important since Db uses different systems under the hood) this.smartdataDb.addTable(this); } /** * makes sure a collection exists within MongoDb that maps to the SmartdataCollection */ public async init() { if (!this.mongoDbCollection) { // connect this instance to a MongoDB collection const availableMongoDbCollections = await this.smartdataDb.mongoDb.collections(); const wantedCollection = availableMongoDbCollections.find((collection) => { return collection.collectionName === this.collectionName; }); if (!wantedCollection) { await this.smartdataDb.mongoDb.createCollection(this.collectionName); } this.mongoDbCollection = await this.smartdataDb.mongoDb.collection(this.collectionName); // console.log(`Successfully initiated Collection ${this.collectionName}`); } } /** * mark unique index */ public markUniqueIndexes(keyArrayArg: string[] = []) { for (const key of keyArrayArg) { if (!this.uniqueIndexes.includes(key)) { this.mongoDbCollection.createIndex(key, { unique: true, }); // make sure we only call this once and not for every doc we create this.uniqueIndexes.push(key); } } } /** * adds a validation function that all newly inserted and updated objects have to pass */ public addDocValidation(funcArg: IDocValidationFunc) { this.objectValidation = funcArg; } /** * finds an object in the DbCollection */ public async find(filterObject: any): Promise { await this.init(); const result = await this.mongoDbCollection.find(filterObject).toArray(); return result; } /** * create an object in the database */ public async insert(dbDocArg: T & SmartDataDbDoc): Promise { await this.init(); await this.checkDoc(dbDocArg); this.markUniqueIndexes(dbDocArg.uniqueIndexes); const saveableObject = await dbDocArg.createSavableObject(); const result = await this.mongoDbCollection.insertOne(saveableObject); return result; } /** * inserts object into the DbCollection */ public async update(dbDocArg: T & SmartDataDbDoc): Promise { await this.init(); await this.checkDoc(dbDocArg); const identifiableObject = await dbDocArg.createIdentifiableObject(); const saveableObject = await dbDocArg.createSavableObject(); const updateableObject: any = {}; for (const key of Object.keys(saveableObject)) { if (identifiableObject[key]) { continue; } updateableObject[key] = saveableObject[key]; } this.mongoDbCollection.updateOne( identifiableObject, { $set: updateableObject }, { upsert: true } ); } public async delete(dbDocArg: T & SmartDataDbDoc): Promise { await this.init(); await this.checkDoc(dbDocArg); const identifiableObject = await dbDocArg.createIdentifiableObject(); await this.mongoDbCollection.deleteOne(identifiableObject, { w: 1, }); } /** * checks a Doc for constraints * if this.objectValidation is not set it passes. */ private checkDoc(docArg: T): Promise { const done = plugins.smartq.defer(); let validationResult = true; if (this.objectValidation) { validationResult = this.objectValidation(docArg); } if (validationResult) { done.resolve(); } else { done.reject('validation of object did not pass'); } return done.promise; } }