uorm

uORM TypeScript MongoDB ORM

This is a port of python uEngine MongoDB ORM library

Usage

Declare models:

import { StorableModel, StringField, DatetimeField } from 'uorm';

class User extends StorableModel {
  static __collection__ = 'user';

  @StringField({ required: true }) username: string;
  @StringField() first_name: string;
  @StringField() last_name: string;
  @DatetimeField({ defaultValue: Date }) created_at: Date;
  @StringField() description: string;

  get fullname() {
    return `${this.first_name} ${this.last_name}`;
  }
}

Initialize database connections

import { db, DatabaseConfig } from 'uorm';

const conf: DatabaseConfig = {
  meta: {
    uri: 'mongodb://localhost',
    dbname: 'mydb',
    options: { useUnifiedTopology: true },
  },
  shards: {},
};

async function main() {
  await db.init(conf);
}

Use models for CRUD operations:

let user = await User.findOne({username: 'johndoe'})
console.log(user);
user.first_name = 'Jim'
await user.save();

const cursor = User.find({first_name: 'John'})
for await (user in cursor) {
  console.log(user); // Cursor emits User instances
}

await User.destroyAll()

Async computed properties

Model's toObject(fields: string[]) method automatically picks up any getter you have in your model:

class MyModel extends StorableModel {
  @StringField() field1: string;
  @StringField() field2: string;
  @StringField() field3: string;

  get concat() {
    return field1 + field2 + field3;
  }
}

const model = new MyModel({ field1: 'a', field2: 'b', field3: 'c' });
console.log(
  model.toObject(['field1', 'field2', 'field3', 'concat', 'non-existent'])
);
/**
{
  field1: 'a',
  field2: 'b',
  field3: 'c',
  concat: 'abc'
}
*/

However you might want to use other models in computations, i.e. you need to wait for the DB or for your cache adapter like Memcached or Redis or whatever. In this case getter will let you down, it's syncronous.

For your convenience there's an async method async asyncObject(fields) which handles this (remember that you have to await it). To expose your async computed property, use AsyncComputed decorator:

import { AsyncComputed, StorableModel } from 'uorm';

class Token extends StorableModel {
  @StringField({ required: true }) token: string;
  @ObjectIdField({ required: true }) owner_id: ObjectID;

  @AsyncComputed()
  get owner() {
    const user = await User.findOne({ _id: this.owner_id });
    return await user.asyncObject();
  }
}

Notice that calling asyncObject without arguments (like in the example above) is quite a useless thing: by default fields list equals to everything declared with <Type>Field decorator, i.e. there's nothing async there by default, thus, syncronous toObject() would suffice.