Ember Custom Actions is a package for defining custom API actions, dedicated for Ember 2.8 (and higher) applications.

Getting started

Installation

ember install ember-custom-actions

Documentation

Model actions

To define custom action like: posts/1/publish you can use modelAction(path, options) method with arguments:

• path - the url of the action (in our case it's publish)
• options - optional parameter which will overwrite the configuration options

import Model from 'ember-data/model';
import { modelAction } from 'ember-custom-actions';

export default Model.extend({
  publish: modelAction('publish', { pushToStore: false }),
});

Usage

let user = this.get('currentUser');
let postToPublish = this.get('store').findRecord('post', 1);
let payload = { publisher: user };

postToPublish.publish(payload).then((status) => {
  alert(`Post has been: ${status}`)
});

Resource actions

To a define custom action like: posts/favorites you can use resourceAction(path, options) method with arguments:

• path - the url of the action (in our case it's favorites)
• options - optional parameter which will overwrite the configuration options

import Model from 'ember-data/model';
import { resourceAction } from 'ember-custom-actions';

export default Model.extend({
  favorites: resourceAction('favorites', { type: 'GET' }),
});

Usage

let user = this.get('currentUser');
let emptyPost = this.get('store').createRecord('post');
let payload = { user };

emptyPost.favorites(payload).then((favoritesPosts) => {
  console.log(favoritesPosts);
}).finally(()=>{
  emptyPost.deleteRecord();
});

Configuration

You can define your custom options in your config/environment.js file

module.exports = function(environment) {
  var ENV = {
    'emberCustomActions': {
      type: 'PUT',
      ajaxOptions: {},
      pushToStore: false,
      normalizeOperation: ''
    },
  };

  return ENV;
}

type

Default type of the request (GET, PUT, POST, DELETE, etc..)

urlType

Base of the URL which is generated for the action. If not defined, urlType is equal to the type option

ajaxOptions

Your own ajax options (e.g. headers)

pushToStore

If you want to push the received data to the store, set this option to true and change your application JSONAPISerializer to:

// app/serializers/application.js

import { JSONAPISerializer } from 'ember-custom-actions';
export default JSONAPISerializer.extend();

normalizeOperation

You can define how your outgoing data should be serialized

Exemplary data:

{
  firstParam: 'My Name',
  colors: { rubyRed: 1, blueFish: 3 }
}

After using a dasherize transformer our request data will turn into:

{
  first-param: 'My Name',
  colors: { ruby-red: 1, blue-fish: 3 }
}

It's great for API with request data format restrictions

Available transformers:

• camelize
• capitalize
• classify
• dasherize
• decamelize
• underscore

Development

Installation

• git clone https://github.com/Exelord/ember-custom-actions.git
• cd ember-custom-actions
• npm install
• bower install

Running

• ember serve
• Visit your app at http://localhost:4200.

Running Tests

• npm test (Runs ember try:each to test your addon against multiple Ember versions)
• ember test
• ember test --server

Building

• ember build

For more information on using ember-cli, visit https://ember-cli.com/.

Thanks

Big thanks to Mike North and his Project for the initial concept.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/exelord/ember-custom-actions. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

This version of the package is available as open source under the terms of the MIT License.