octonom/lib/collection.ts

Object Document Mapper for any database

import { IModelConstructor, Model } from './model';

export interface ICollectionOptions<T extends Model> {
  modelIdField?: keyof T;
}

export interface ICollectionInsertOptions {
  // default is true
  validate?: boolean;
}

export abstract class Collection<T extends Model> {
  public readonly modelIdField: string;

  constructor(
    public readonly model: IModelConstructor<T>,
    protected options: ICollectionOptions<T> = {},
  ) {
    this.modelIdField = options.modelIdField || 'id';

    // check id field in schema
    const idSchema = model.schemaMap[this.modelIdField];
    if (!idSchema) {
      throw new Error(`Id field ${this.modelIdField} not found in model schema.`);
    }
  }

  public abstract async findById(id: string): Promise<T>;

  // trivial implementation, should be implemented efficiently for specific database
  public async findByIds(ids: string[]): Promise<T[]> {
    return Promise.all(ids.map(id => this.findById(id)));
  }

  public toDb(model: T): object {
    return model.toObject({unpopulate: true});
  }

  public fromDb(doc: object): T {
    return new this.model(doc);
  }
}