Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@anephenix/objection-relations

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@anephenix/objection-relations

A relations helper for Objection.js. This provides a convenient way to define relations in the `relationMappings` function on an Objection.js model.

  • 0.0.2
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

objection-relations

A relations helper for Objection.js. This provides a convenient way to define relations in the relationMappings function on an Objection.js model.

For example, say you have a table called "Users" with this relation mapping:

class User extends Model {
  static get tableName() {
    return 'users';
  }

  static get relationMappings() {
    return {
      addresses: {
        relation: Model.HasManyRelation,
        modelClass: Address,
        join: {
          from: 'users.id',
          to: 'addresses.user_id',
        },
      },
    };
  }
}

You can use the objection-relations helper module to write the instead:

import { ObjectionRelation } from '@anephenix/objection-relations';

class User extends Model {
  static get tableName() {
    return 'users';
  }

  static get relationMappings() {
    const or = new ObjectionRelation({
      subject: this.name,
      modelPath: __dirname,
    });
    return {
      addresses: or.hasMany('Address'),
    };
  }
}

The helper function will do the following:

  • Setup the relation type from Objection.js (hasOne, hasMany, hasMnayThrough, belongsTo)
  • Define the join table based on the properties of the subject and object models, if they follow a particular pattern (tables for models are named in plural format, and foreign keys use a singular format). e.g.
Modeltable nameforeign key
Userusersuser_id

Dependencies

  • Node.js

Install

npm i @anephenix/objection-relations

Usage

You can setup different kinds of database table relationships like this:

Belongs to

or.belongsTo('Role');

Is equivalent to writing:

{
    relation: Model.BelongsToOneRelation,
    modelClass: 'Role',
    join: {
        from: 'users.role_id',
        to: 'roles.id'
    }
}

Has one

or.hasOne('Setting');

Is equivalent to writing:

{
    relation: Model.HasOneRelation,
    modelClass: 'Setting',
    join: {
        from: 'users.id',
        to: 'settings.user_id'
    }
}

Has many

or.hasMany('Address');

Is equivalent to writing:

{
    relation: Model.HasManyRelation,
    modelClass: Address,
    join: {
        from: 'users.id',
        to: 'addresses.user_id'
    }
}

Has many through

For relationships defined through a join table, you can write this:

or.hasManyThrough('Company', 'Employment');

This is equivalent to:

{
    relation: Model.ManyToManyRelation,
    modelClass: Company,
    join: {
        from: 'users.id',
        through: {
            from: 'employments.user_id',
            to: 'employments.company_id'
        },
        to: 'companies.id'
    }
}

Advanced usage

There might be cases where the name of the database tables and foreign keys are following a different pattern from plural database tables and singular foreign keys. In such cases you can define them in the options, like this:

SubjectTable

Say a User model has many addresses, but the database table is called 'account_users', you can write this code:

or.hasMany('Address', { subjectTable: 'account_users' });

Which is equivalent to writing:

{
    relation: Model.HasManyRelation,
    modelClass: Address,
    join: {
        from: 'account_users.id',
        to: 'addresses.user_id'
    }
}

ObjectTable

The same applies for the object table. Say for example the Address model has the database table 'shipping_addresses', you could write this:

or.hasMany('Address', { objectTable: 'shipping_addresses' });

Which is equivalent to writing:

{
    relation: Model.HasManyRelation,
    modelClass: Address,
    join: {
        from: 'users.id',
        to: 'shipping_addresses.user_id'
    }
}

SubjectForeignKey

If you find that the foreign key is not a singular form of the related model, then you can pass a foreign key for the subject like this:

or.hasMany('Address', { subjectForeignKey: 'account_user_id' });

Which is equivalent to writing:

{
    relation: Model.HasManyRelation,
    modelClass: Address,
    join: {
        from: 'users.id',
        to: 'addresses.account_user_id'
    }
}

ObjectForeignKey

You can pass a custom foreign key for the object (Like a Post model) like this:

or.belongsTo('User', { objectForeignKey: 'author_id' });

Is equivalent to writing:

{
    relation: Model.BelongsToOneRelation,
    modelClass: User,
    join: {
        from: 'posts.author_id',
        to: 'users.id'
    }
}

Tests

npm t

Licence and credits

©2022 Anephenix OÜ. Objection-relations is licenced under the MIT Licence.

FAQs

Package last updated on 19 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc