123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- Author Tobias Koppers @sokra
- */
- "use strict";
- /**
- * @typedef {Object} GroupOptions
- * @property {boolean=} groupChildren
- * @property {boolean=} force
- * @property {number=} targetGroupCount
- */
- /**
- * @template T
- * @template R
- * @typedef {Object} GroupConfig
- * @property {function(T): string[]} getKeys
- * @property {function(string, (R | T)[], T[]): R} createGroup
- * @property {function(string, T[]): GroupOptions=} getOptions
- */
- /**
- * @template T
- * @template R
- * @typedef {Object} ItemWithGroups
- * @property {T} item
- * @property {Set<Group<T, R>>} groups
- */
- /**
- * @template T
- * @template R
- * @typedef {{ config: GroupConfig<T, R>, name: string, alreadyGrouped: boolean, items: Set<ItemWithGroups<T, R>> | undefined }} Group
- */
- /**
- * @template T
- * @template R
- * @param {T[]} items the list of items
- * @param {GroupConfig<T, R>[]} groupConfigs configuration
- * @returns {(R | T)[]} grouped items
- */
- const smartGrouping = (items, groupConfigs) => {
- /** @type {Set<ItemWithGroups<T, R>>} */
- const itemsWithGroups = new Set();
- /** @type {Map<string, Group<T, R>>} */
- const allGroups = new Map();
- for (const item of items) {
- /** @type {Set<Group<T, R>>} */
- const groups = new Set();
- for (let i = 0; i < groupConfigs.length; i++) {
- const groupConfig = groupConfigs[i];
- const keys = groupConfig.getKeys(item);
- if (keys) {
- for (const name of keys) {
- const key = `${i}:${name}`;
- let group = allGroups.get(key);
- if (group === undefined) {
- allGroups.set(
- key,
- (group = {
- config: groupConfig,
- name,
- alreadyGrouped: false,
- items: undefined
- })
- );
- }
- groups.add(group);
- }
- }
- }
- itemsWithGroups.add({
- item,
- groups
- });
- }
- /**
- * @param {Set<ItemWithGroups<T, R>>} itemsWithGroups input items with groups
- * @returns {(T | R)[]} groups items
- */
- const runGrouping = itemsWithGroups => {
- const totalSize = itemsWithGroups.size;
- for (const entry of itemsWithGroups) {
- for (const group of entry.groups) {
- if (group.alreadyGrouped) continue;
- const items = group.items;
- if (items === undefined) {
- group.items = new Set([entry]);
- } else {
- items.add(entry);
- }
- }
- }
- /** @type {Map<Group<T, R>, { items: Set<ItemWithGroups<T, R>>, options: GroupOptions | false | undefined, used: boolean }>} */
- const groupMap = new Map();
- for (const group of allGroups.values()) {
- if (group.items) {
- const items = group.items;
- group.items = undefined;
- groupMap.set(group, {
- items,
- options: undefined,
- used: false
- });
- }
- }
- /** @type {(T | R)[]} */
- const results = [];
- for (;;) {
- /** @type {Group<T, R>} */
- let bestGroup = undefined;
- let bestGroupSize = -1;
- let bestGroupItems = undefined;
- let bestGroupOptions = undefined;
- for (const [group, state] of groupMap) {
- const { items, used } = state;
- let options = state.options;
- if (options === undefined) {
- const groupConfig = group.config;
- state.options = options =
- (groupConfig.getOptions &&
- groupConfig.getOptions(
- group.name,
- Array.from(items, ({ item }) => item)
- )) ||
- false;
- }
- const force = options && options.force;
- if (!force) {
- if (bestGroupOptions && bestGroupOptions.force) continue;
- if (used) continue;
- if (items.size <= 1 || totalSize - items.size <= 1) {
- continue;
- }
- }
- const targetGroupCount = (options && options.targetGroupCount) || 4;
- let sizeValue = force
- ? items.size
- : Math.min(
- items.size,
- (totalSize * 2) / targetGroupCount +
- itemsWithGroups.size -
- items.size
- );
- if (
- sizeValue > bestGroupSize ||
- (force && (!bestGroupOptions || !bestGroupOptions.force))
- ) {
- bestGroup = group;
- bestGroupSize = sizeValue;
- bestGroupItems = items;
- bestGroupOptions = options;
- }
- }
- if (bestGroup === undefined) {
- break;
- }
- const items = new Set(bestGroupItems);
- const options = bestGroupOptions;
- const groupChildren = !options || options.groupChildren !== false;
- for (const item of items) {
- itemsWithGroups.delete(item);
- // Remove all groups that items have from the map to not select them again
- for (const group of item.groups) {
- const state = groupMap.get(group);
- if (state !== undefined) {
- state.items.delete(item);
- if (state.items.size === 0) {
- groupMap.delete(group);
- } else {
- state.options = undefined;
- if (groupChildren) {
- state.used = true;
- }
- }
- }
- }
- }
- groupMap.delete(bestGroup);
- const key = bestGroup.name;
- const groupConfig = bestGroup.config;
- const allItems = Array.from(items, ({ item }) => item);
- bestGroup.alreadyGrouped = true;
- const children = groupChildren ? runGrouping(items) : allItems;
- bestGroup.alreadyGrouped = false;
- results.push(groupConfig.createGroup(key, children, allItems));
- }
- for (const { item } of itemsWithGroups) {
- results.push(item);
- }
- return results;
- };
- return runGrouping(itemsWithGroups);
- };
- module.exports = smartGrouping;
|