epilogue-association-write

0.2.1 • Public • Published

Epilogue-association-write

This library contains a helper for Epilogue to add the capability to POST belongsTo and belongsToMany. In a single POST REST call, you can save an entity, and its relationship.

This library is experimental; I advice you to spend the time understanding its implementation if you want to use it.

I only use it in 1 projet.

Install

npm install --save epilogue-association-write

Usage

import epilogueAssociationWrite from 'epilogue-association-write'
import epilogue from 'epilogue'
import {sequelize, User, Group} from './my-sequelize-models'
import app from './my-express-app'

// we bootstrap epilogue as usual
epilogue.initialize({
      app: app,
      sequelize: sequelize
})

var userResource = epilogue.resource({
  model: User,
  endpoints: ['/users', '/users/:id'],
  association: true
})

var groupsResource = epilogue.resource({
  model: Group,
  endpoints: ['/groups', '/groups/:id'],
  association: true
})

User.belongsTo(Group)

// those are the two lines you add to support belongsTo writes.
userResource.create.write(epilogueAssociationWrite(userResource))
userResource.update.write(epilogueAssociationWrite(userResource))

You can then post:

POST /users
{
  firstName:'John',
  lastName: 'Doe',
  groups: [ {id: 1}, {id: 2}]
}

It will create a user John Doe, associated with the groups 1 and 2. The group field is handled as a cancel and replace.

You can also add complementary JOIN values directly in the call as well (in the case of a belongsToMany):

POST /users
{
  firstName:'John',
  lastName: 'Doe',
  groups: [ {id: 1, role: 'Admin'}, {id: 2, role: 'User'}]
}

Limitations

  • All relations must have a field called "id" that acts as a primary key (not null, unique).
  • The current version doesn't go deeper than 1 level depth.
  • No unit test it.

License

MIT. See associated LICENSE file.

Package Sidebar

Install

npm i epilogue-association-write

Weekly Downloads

3

Version

0.2.1

License

MIT

Last publish

Collaborators

  • baptistemanson