super-siren/dist/lib/ActionField.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 _immutable = require('immutable');

var _immutable2 = _interopRequireDefault(_immutable);

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

/**
 * Describes a field on an Action and how this field
 * should be sent to Siren API as part of that Action.
 *
 * @param {String} options.name:  ''     [description]
 * @param {String} options.title: null   [description]
 * @param {String} options.type:  'text' [description]
 * @param {Object} options.value: null   Default value to be sent on the field
 */

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

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

	(0, _createClass3.default)(ActionField, null, [{
		key: 'fromJson',

		/**
   * Parses a JSON representation of a field.
   *
   * @param {Object} json The Object representation of the ActionField.
   * @return {ActionField} parsed structure which represents a field on an action.
   */
		value: function fromJson(json) {
			if (!json.name) {
				throw new Error('name is required on an action field');
			}

			return empty.withMutations(function (map) {
				map.set('name', json.name || map.name);
				map.set('title', json.title || map.title);
				map.set('type', json.type || map.type);
				map.set('value', json.value !== undefined ? json.value : map.value);
			});
		}

		/**
   * Default empty state for a field.
   *
   * @return {ActionField} Default state
   */

	}, {
		key: 'empty',
		get: function get() {
			return empty;
		}
	}]);
	return ActionField;
}(_immutable2.default.Record({
	name: '',
	title: null,
	type: 'text',
	value: null
}));

var empty = new ActionField();

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