@carboncollins/mobileconfig/lib/es5/models/payload.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 _uuid = require('uuid');

var _uuid2 = _interopRequireDefault(_uuid);

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"); } }

var requiredValues = ['PayloadType', 'PayloadVersion', 'PayloadIdentifier', 'PayloadUUID', 'PayloadDisplayName'];

/**
 * @class MobileConfigPayload
 * @description Structured model data to be extended for each payload which can be added to a
 * profile
 * @author CarbonCollins <toastyghost@carboncollins.uk>
 * @memberof module:@carboncollins/mobileconfig
 */

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

    _classCallCheck(this, MobileConfigPayload);

    /**
     * @member {String} [type='']
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description The payload type. The payloads are described in the payload specific classes.
     */
    this.type = options.type || '';

    /**
     * @member {Number} [version=1]
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description The version number of the individual payload. A profile can consist of payload
     * with different version numbers. For example changes to the vpn software in iOS might
     * introduce a new payload version to support additional features, but mail payload versions
     * wont necessarily change in the same release.
     */
    this.version = options.version || 1;

    /**
     * @member {String} [identifier=com.example.myprofile.mypayload]
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description A reverse-DNS-style identifier for the specific payload. It is usually the
     * same identifier as the root-level PayloadIdentifier value with an additional component
     * appended.
     */
    this.identifier = options.identifier || 'com.example.myprofile.mypayload';

    /**
     * @member {String} [uuid=new UUIDv4()]
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description A globally unique identifier for the payload. The actual content is
     * unimportant, but it must be globally unique. If left blank a random UUID will be generated.
     * In macOS, you can use uuidgen to generate reasonable UUIDs.
     */
    this.uuid = options.uuid || _uuid2.default.v4();

    /**
     * @member {String} [displayName='']
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description A human-readable name for the profile payload. This name is displayed on the
     * Detail screen. It does not have to be unique.
     */
    this.displayName = options.displayName || '';

    /**
     * @member {String} [description=null]
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description A human-readable description of this payload. This description is shown on the
     * Detail screen.
     */
    this.description = options.description || null;

    /**
     * @member {String} [organisation=null]
     * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
     * @description A human-readable string containing the name of the organization that provided
     * the profile. The payload organization for a payload need not match the payload organization
     * in the enclosing profile.
     */
    this.organisation = options.organisation || null;
  }

  /**
   * @description generates a plist safe js object to be converted to plist xml
   * @readonly
   * @memberof module:@carboncollins/mobileconfig.MobileConfigPayload
   * @returns {Object} a plist object encoded into a js object
   */


  _createClass(MobileConfigPayload, [{
    key: 'plistSafeObject',
    get: function get() {
      var plistObj = {
        PayloadType: (0, _safe.toSafeString)(this.type),
        PayloadVersion: (0, _safe.toSafeInteger)(this.version),
        PayloadIdentifier: (0, _safe.toSafeString)(this.identifier),
        PayloadUUID: (0, _safe.toSafeString)(this.uuid),
        PayloadDisplayName: (0, _safe.toSafeString)(this.displayName),
        PayloadDescription: (0, _safe.toSafeString)(this.description),
        PayloadOrganisation: (0, _safe.toSafeString)(this.organisation)
      };

      (0, _safe.deleteEmptyKeys)(plistObj);

      return (0, _safe.hasRequiredValues)(requiredValues, plistObj, this.type + ' payload') ? plistObj : null;
    }
  }]);

  return MobileConfigPayload;
}();

exports.default = MobileConfigPayload;