@carboncollins/mobileconfig/lib/es5/models/webClipPayload.js

Create and sign iOS mobileconfig configuration files

'use strict';

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

var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

var _get = function get(object, property, receiver) { if (object === null) object = Function.prototype; var desc = Object.getOwnPropertyDescriptor(object, property); if (desc === undefined) { var parent = Object.getPrototypeOf(object); if (parent === null) { return undefined; } else { return get(parent, property, receiver); } } else if ("value" in desc) { return desc.value; } else { var getter = desc.get; if (getter === undefined) { return undefined; } return getter.call(receiver); } };

var _payload = require('./payload.js');

var _payload2 = _interopRequireDefault(_payload);

var _safe = require('../safe.js');

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

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }

function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }

var requiredValues = ['URL', 'Label'];

/**
 * @class WebClipPayload
 * @description Structured model data for the WebClip payload
 * @author CarbonCollins <toastyghost@carboncollins.uk>
 * @memberof module:@carboncollins/mobileconfig
 * @extends module:@carboncollins/mobileconfig.MobileConfigPayload
 */

var WebClipPayload = function (_MobileConfigPayload) {
  _inherits(WebClipPayload, _MobileConfigPayload);

  /**
   * @constructor
   * @description creates an instance of WebClipPayload
   * @param {Object|module:@carboncollins/mobileconfig.WebClipPayload} [options={}] An object of
   * options
   */
  function WebClipPayload() {
    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};

    _classCallCheck(this, WebClipPayload);

    /**
     * @member {String} [url=null]
     * @memberof module:@carboncollins/mobileconfig.WebClipPayload
     * @description The URL that the Web Clip should open when clicked. The URL must begin with
     * HTTP or HTTPS or it won't work.
     */
    var _this = _possibleConstructorReturn(this, (WebClipPayload.__proto__ || Object.getPrototypeOf(WebClipPayload)).call(this, Object.assign({}, options, { type: 'com.apple.webClip.managed' })));

    _this.url = options.url || null;

    /**
     * @member {String} [label=null]
     * @memberof module:@carboncollins/mobileconfig.WebClipPayload
     * @description The name of the Web Clip as displayed on the Home screen.
     */
    _this.label = options.label || null;

    /**
     * @member {Buffer} [icon=null]
     * @memberof module:@carboncollins/mobileconfig.WebClipPayload
     * @description A PNG icon to be shown on the Home screen. Should be 59 x 60 pixels in size.
     * If not specified, a white square will be shown.
     */
    _this.icon = options.icon || null;

    /**
     * @member {Boolean} [isRemovable=true]
     * @memberof module:@carboncollins/mobileconfig.WebClipPayload
     * @description If false, the web clip is unremovable. Defaults to true. Not available in
     * macOS.
     */
    _this.isRemovable = options.isRemovable || true;
    return _this;
  }

  /**
   * @description generates a plist safe js object with all the required information for generating
   * a mobileconfig profile
   * @readonly
   * @memberof module:@carboncollins/mobileconfig.WebClipPayload
   * @author CarbonCollins <toastyghost@carboncollins.uk>
   * @returns {Object} a plist object encoded into a js object
   */


  _createClass(WebClipPayload, [{
    key: 'plistSafeObject',
    get: function get() {
      var plistObj = {
        URL: (0, _safe.toSafeString)(this.url),
        Label: (0, _safe.toSafeString)(this.label),
        Icon: (0, _safe.toSafeData)(this.icon),
        IsRemovable: (0, _safe.toSafeBoolean)(this.isRemovable)
      };

      (0, _safe.deleteEmptyKeys)(plistObj);

      return (0, _safe.hasRequiredValues)(requiredValues, plistObj, 'com.apple.webClip.managed payload') ? Object.assign({}, _get(WebClipPayload.prototype.__proto__ || Object.getPrototypeOf(WebClipPayload.prototype), 'plistSafeObject', this), plistObj) : null;
    }
  }]);

  return WebClipPayload;
}(_payload2.default);

exports.default = WebClipPayload;