super-siren/dist/lib/SirenAction.js

Siren client based built on top of superagent

'use strict';

Object.defineProperty(exports, "__esModule", {
	value: true
});

var _getPrototypeOf = require('babel-runtime/core-js/object/get-prototype-of');

var _getPrototypeOf2 = _interopRequireDefault(_getPrototypeOf);

var _classCallCheck2 = require('babel-runtime/helpers/classCallCheck');

var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);

var _createClass2 = require('babel-runtime/helpers/createClass');

var _createClass3 = _interopRequireDefault(_createClass2);

var _possibleConstructorReturn2 = require('babel-runtime/helpers/possibleConstructorReturn');

var _possibleConstructorReturn3 = _interopRequireDefault(_possibleConstructorReturn2);

var _inherits2 = require('babel-runtime/helpers/inherits');

var _inherits3 = _interopRequireDefault(_inherits2);

var _lodash = require('lodash');

var _lodash2 = _interopRequireDefault(_lodash);

var _immutable = require('immutable');

var _immutable2 = _interopRequireDefault(_immutable);

var _ActionField = require('./ActionField');

var _ActionField2 = _interopRequireDefault(_ActionField);

var _Client = require('./Client');

var _Client2 = _interopRequireDefault(_Client);

var _SirenHelpers = require('./SirenHelpers');

var _SirenHelpers2 = _interopRequireDefault(_SirenHelpers);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/**
 * Representation of a Siren action, which allows a state within a Siren Hypermedia API
 * to transition to a new state.
 *
 * @param {String} options.name:   null                                [description]
 * @param {String} options.title:  null                                [description]
 * @param {String} options.method: 'GET'                               [description]
 * @param {String} options.href:   null                                [description]
 * @param {String} options.type:   'application/x-www-form-urlencoded' [description]
 * @param {Immutable.Map} options.fields: new Immutable.Map()          [description]
 */

var SirenAction = function (_Immutable$Record) {
	(0, _inherits3.default)(SirenAction, _Immutable$Record);

	function SirenAction() {
		(0, _classCallCheck3.default)(this, SirenAction);
		return (0, _possibleConstructorReturn3.default)(this, (0, _getPrototypeOf2.default)(SirenAction).apply(this, arguments));
	}

	(0, _createClass3.default)(SirenAction, [{
		key: 'perform',

		/**
   * Performs the action specified by this Action.
   *
   * @param  {Object=} data                          Query params sent as part of this action
   * @return {superagent-promise} Superagent Promise HTTP request to perform this action
   */
		value: function perform(data) {
			data = data || {};

			var req = _Client2.default.action(this.method, this.href);

			if (this.type && this.type !== 'multipart/form-data') {
				//superagent needs to set it's own type for multipart/form-data content
				req.type(this.type);
			}

			var payload = {};

			this.fields.forEach(function (f) {
				if (f.value !== undefined) payload[f.name] = f.value;
			});
			_immutable2.default.fromJS(data).forEach(function (value, key) {
				return payload[key] = value;
			});

			if (this.method.toLowerCase() === 'get') {
				req.query(payload);
			} else {
				if (this.type === 'multipart/form-data') {
					var formData = new FormData();

					for (var key in payload) {
						formData.append(key, payload[key]);
					}

					req.send(formData);
				} else {
					req.send(payload);
				}
			}

			return req;
		}

		/**
   * Creates a SirenAction instance based on the provided
   * JSON object structure.
   *
   * @param  {Object} json      Object which matches the Siren JSON structure.
   * @param  {String} [baseUrl] optional url to use as the base URL for all parsed URLs
   * @return {SirenAction}      Result of parsing the provided JSON object.
   */

	}], [{
		key: 'fromJson',
		value: function fromJson(json, baseUrl) {
			if (!json.name) {
				throw new Error('"name" is requires on an action');
			}

			return empty.withMutations(function (map) {
				map.set('name', json.name || map.name);
				map.set('title', json.title || map.title);
				map.set('method', json.method || map.method);
				map.set('href', _SirenHelpers2.default.processUrl(json.href || map.href, baseUrl));
				map.set('classes', new _immutable2.default.Set(json.class || []));
				map.set('type', json.type || map.type);
				map.set('fields', new _immutable2.default.Map(_lodash2.default.map(json.fields || [], function (f) {
					return _ActionField2.default.fromJson(f);
				}).map(function (af) {
					return [af.name, af];
				})));
			});
		}

		/**
   * Default state for a SirenAction.  This has the defaults set and nothing
   * else.
   *
   * @return {SirenAction} Siren Action which is created as a result of parsing
   *                             the provided JSON.
   */

	}, {
		key: 'empty',
		get: function get() {
			return empty;
		}
	}]);
	return SirenAction;
}(_immutable2.default.Record({
	name: null,
	title: null,
	method: 'GET',
	href: null,
	classes: new _immutable2.default.Set(),
	type: 'application/x-www-form-urlencoded',
	fields: new _immutable2.default.Map()
}));

var empty = new SirenAction();

exports.default = SirenAction;
//# sourceMappingURL=SirenAction.js.map