d2-ui
Version:
268 lines (227 loc) • 10.2 kB
JavaScript
;
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; }; })();
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) arr2[i] = arr[i]; return arr2; } else { return Array.from(arr); } }
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError('Cannot call a class as a function'); } }
var _libCheck = require('../lib/check');
var _libUtils = require('../lib/utils');
var _Model = require('./Model');
var _Model2 = _interopRequireDefault(_Model);
var _ModelDefinition = require('./ModelDefinition');
var _ModelDefinition2 = _interopRequireDefault(_ModelDefinition);
var _pagerPager = require('../pager/Pager');
var _pagerPager2 = _interopRequireDefault(_pagerPager);
function _throwIfContainsOtherThanModelObjects(values) {
if (values && values[Symbol.iterator]) {
var toCheck = [].concat(_toConsumableArray(values));
toCheck.forEach(function (value) {
if (!(value instanceof _Model2['default'])) {
(0, _libUtils.throwError)('Values of a ModelCollection must be instances of Model');
}
});
}
}
function _throwIfContainsModelWithoutUid(values) {
if (values && values[Symbol.iterator]) {
var toCheck = [].concat(_toConsumableArray(values));
toCheck.forEach(function (value) {
if (!(0, _libCheck.isValidUid)(value.id)) {
(0, _libUtils.throwError)('Can not add a Model without id to a ModelCollection');
}
});
}
}
/**
* @class ModelCollection
*
* @description
* Collection of `Model` objects that can be interacted upon. Can contain a pager object to easily navigate
* pages within the system.
*/
var ModelCollection = (function () {
/**
* @constructor
*
* @param {ModelDefinition} modelDefinition The `ModelDefinition` that this collection is for. This defines the type of models that
* are allowed to be added to the collection.
* @param {Model[]} values Initial values that should be added to the collection.
* @param {Object} pagerData Object with pager data. This object contains data that will be put into the `Pager` instance.
*
* @description
*
* Creates a new `ModelCollection` object based on the passed `modelDefinition`. Additionally values can be added by passing
* `Model` objects in the `values` parameter. The collection also exposes a pager object which can be used to navigate through
* the pages in the collection. For more information see the `Pager` class.
*/
function ModelCollection(modelDefinition, values, pagerData) {
var _this = this;
_classCallCheck(this, ModelCollection);
(0, _libCheck.checkType)(modelDefinition, _ModelDefinition2['default']);
/**
* @property {ModelDefinition} modelDefinition The `ModelDefinition` that this collection is for. This defines the type of models that
* are allowed to be added to the collection.
*/
this.modelDefinition = modelDefinition;
/**
* @property {Pager} pager Pager object that is created from the pagerData that was passed when the collection was constructed. If no pager data was present
* the pager will have default values.
*/
this.pager = new _pagerPager2['default'](pagerData, modelDefinition);
// We can not extend the Map object right away in v8 contexts.
this.valuesContainerMap = new Map();
this[Symbol.iterator] = this.valuesContainerMap[Symbol.iterator].bind(this.valuesContainerMap);
_throwIfContainsOtherThanModelObjects(values);
_throwIfContainsModelWithoutUid(values);
// Add the values separately as not all Iterators return the same values
if ((0, _libCheck.isArray)(values)) {
values.forEach(function (value) {
return _this.valuesContainerMap.set(value.id, value);
});
}
}
/**
* @property {Number} size The number of Model objects that are in the collection.
*
* @description
* Contains the number of Model objects that are in this collection. If the collection is a collection with a pager. This
* does not take into account all the items in the database. Therefore when a pager is present on the collection
* the size will return the items on that page. To get the total number of items consult the pager.
*/
_createClass(ModelCollection, [{
key: 'add',
/**
* @method add
*
* @param {Model} value Model instance to add to the collection.
* @returns {ModelCollection} Returns itself for chaining purposes.
*
* @throws {Error} When the passed value is not an instance of `Model`
* @throws {Error} Throws error when the passed value does not have a valid id.
*
* @description
* Adds a Model instance to the collection. The model is checked if it is a correct instance of `Model` and if it has
* a valid id. A valid id is a uid string of 11 alphanumeric characters.
*/
value: function add(value) {
_throwIfContainsOtherThanModelObjects([value]);
_throwIfContainsModelWithoutUid([value]);
this.set(value.id, value);
return this;
}
/**
* @method toArray
*
* @returns {Array} Returns the values of the collection as an array.
*
* @description
* If working with the Map type object is inconvenient this method can be used to return the values
* of the collection as an Array object.
*/
}, {
key: 'toArray',
value: function toArray() {
var resultArray = [];
this.forEach(function (model) {
resultArray.push(model);
});
return resultArray;
}
}, {
key: 'clear',
/**
* @method clear
*
* @returns {this} Returns itself for chaining purposes;
*
* @description
* Clear the collection and remove all it's values.
*/
// TODO: Reset the pager?
value: function clear() {
return this.valuesContainerMap.clear.apply(this.valuesContainerMap);
}
}, {
key: 'delete',
value: function _delete() {
for (var _len = arguments.length, args = Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
return this.valuesContainerMap['delete'].apply(this.valuesContainerMap, args);
}
}, {
key: 'entries',
value: function entries() {
return this.valuesContainerMap.entries.apply(this.valuesContainerMap);
}
// FIXME: This calls the forEach function with the values Map and not with the ModelCollection as the third argument
}, {
key: 'forEach',
value: function forEach() {
for (var _len2 = arguments.length, args = Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
args[_key2] = arguments[_key2];
}
return this.valuesContainerMap.forEach.apply(this.valuesContainerMap, args);
}
}, {
key: 'get',
value: function get() {
for (var _len3 = arguments.length, args = Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
args[_key3] = arguments[_key3];
}
return this.valuesContainerMap.get.apply(this.valuesContainerMap, args);
}
}, {
key: 'has',
value: function has() {
for (var _len4 = arguments.length, args = Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
args[_key4] = arguments[_key4];
}
return this.valuesContainerMap.has.apply(this.valuesContainerMap, args);
}
}, {
key: 'keys',
value: function keys() {
return this.valuesContainerMap.keys.apply(this.valuesContainerMap);
}
}, {
key: 'set',
value: function set() {
for (var _len5 = arguments.length, args = Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
args[_key5] = arguments[_key5];
}
return this.valuesContainerMap.set.apply(this.valuesContainerMap, args);
}
}, {
key: 'values',
value: function values() {
return this.valuesContainerMap.values.apply(this.valuesContainerMap);
}
}, {
key: 'size',
get: function get() {
return this.valuesContainerMap.size;
}
}], [{
key: 'create',
value: function create(modelDefinition, values, pagerData) {
return new ModelCollection(modelDefinition, values, pagerData);
}
}, {
key: 'throwIfContainsOtherThanModelObjects',
value: function throwIfContainsOtherThanModelObjects(value) {
return _throwIfContainsOtherThanModelObjects(value);
}
}, {
key: 'throwIfContainsModelWithoutUid',
value: function throwIfContainsModelWithoutUid(value) {
return _throwIfContainsModelWithoutUid(value);
}
}]);
return ModelCollection;
})();
exports['default'] = ModelCollection;
module.exports = exports['default'];
//# sourceMappingURL=ModelCollection.js.map