This repository has been archived on 2026-07-19. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
espocrm-base/client/src/multi-collection.js
T
Yuri Kuznetsov 6465277fb0 jsdoc, types
2023-06-20 23:03:31 +03:00

87 lines
2.6 KiB
JavaScript

/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
/** @module multi-collection */
import Collection from 'collection';
/**
* A collection that can contain entities of different entity types.
*/
class MultiCollection extends Collection {
/**
* A model seed map.
*
* @public
* @type {Object.<string, module:model>}
*/
seeds = null
/** @inheritDoc */
prepareAttributes(response, options) {
this.total = response.total;
if (!('list' in response)) {
throw new Error("No 'list' in response.");
}
/** @type {({_scope?: string} & Object.<string, *>)[]} */
const list = response.list;
return list.map(attributes => {
let entityType = attributes._scope;
if (!entityType) {
throw new Error("No '_scope' attribute.");
}
attributes = _.clone(attributes);
delete attributes['_scope'];
let model = this.seeds[entityType].clone();
model.set(attributes);
return model;
});
}
/** @inheritDoc */
clone() {
let collection = super.clone();
collection.seeds = this.seeds;
return collection;
}
}
// noinspection JSUnusedGlobalSymbols
export default MultiCollection;