[Feature] Browser Compendium Handling (#1648)

* Initial version

* .

* Fixed so that CompendiumSetting saving refreshes the CompendiumBrowser for all users

* .

* Improved design

* Fixed max height

* Fixed local reload

* Added GM restriction

* Raised version

* Fixed tooltip

* Raised verison to 1.7.0

module/applications/dialogs/CompendiumBrowserSettings.mjs

@@ -0,0 +1,136 @@
+const { ApplicationV2, HandlebarsApplicationMixin } = foundry.applications.api;
+
+export default class CompendiumBrowserSettings extends HandlebarsApplicationMixin(ApplicationV2) {
+    constructor() {
+        super();
+
+        this.browserSettings = game.settings
+            .get(CONFIG.DH.id, CONFIG.DH.SETTINGS.gameSettings.CompendiumBrowserSettings)
+            .toObject();
+    }
+
+    static DEFAULT_OPTIONS = {
+        tag: 'div',
+        classes: ['daggerheart', 'dialog', 'dh-style', 'views', 'compendium-brower-settings'],
+        window: {
+            icon: 'fa-solid fa-book',
+            title: 'DAGGERHEART.APPLICATIONS.CompendiumBrowserSettings.title'
+        },
+        position: {
+            width: 500
+        },
+        actions: {
+            toggleSource: CompendiumBrowserSettings.#toggleSource,
+            finish: CompendiumBrowserSettings.#finish
+        }
+    };
+
+    /** @override */
+    static PARTS = {
+        packs: {
+            id: 'packs',
+            template: 'systems/daggerheart/templates/dialogs/compendiumBrowserSettingsDialog/packs.hbs'
+        },
+        footer: { template: 'systems/daggerheart/templates/dialogs/compendiumBrowserSettingsDialog/footer.hbs' }
+    };
+
+    static #browserPackTypes = ['Actor', 'Item'];
+
+    _attachPartListeners(partId, htmlElement, options) {
+        super._attachPartListeners(partId, htmlElement, options);
+
+        for (const element of htmlElement.querySelectorAll('.pack-checkbox'))
+            element.addEventListener('change', this.toggleTypedPack.bind(this));
+    }
+
+    /**@inheritdoc */
+    async _prepareContext(_options) {
+        const context = await super._prepareContext(_options);
+
+        const excludedSourceData = this.browserSettings.excludedSources;
+        const excludedPackData = this.browserSettings.excludedPacks;
+        context.typePackCollections = game.packs.reduce((acc, pack) => {
+            const { type, label, packageType, packageName, id } = pack.metadata;
+            if (packageType === 'world' || !CompendiumBrowserSettings.#browserPackTypes.includes(type)) return acc;
+
+            const sourceChecked =
+                !excludedSourceData[packageName] ||
+                !excludedSourceData[packageName].excludedDocumentTypes.includes(type);
+            const sourceLabel = game.modules.get(packageName)?.title ?? game.system.title;
+            if (!acc[type]) acc[type] = { label: game.i18n.localize(`DOCUMENT.${type}s`), sources: {} };
+            if (!acc[type].sources[packageName])
+                acc[type].sources[packageName] = { label: sourceLabel, checked: sourceChecked, packs: [] };
+
+            const checked = !excludedPackData[id] || !excludedPackData[id].excludedDocumentTypes.includes(type);
+
+            acc[type].sources[packageName].packs.push({
+                pack: id,
+                type,
+                label: id === game.system.id ? game.system.title : game.i18n.localize(label),
+                checked: checked
+            });
+
+            return acc;
+        }, {});
+
+        return context;
+    }
+
+    static #toggleSource(event, button) {
+        event.stopPropagation();
+
+        const { type, source } = button.dataset;
+        const currentlyExcluded = this.browserSettings.excludedSources[source]
+            ? this.browserSettings.excludedSources[source].excludedDocumentTypes.includes(type)
+            : false;
+
+        if (!this.browserSettings.excludedSources[source])
+            this.browserSettings.excludedSources[source] = { excludedDocumentTypes: [] };
+        this.browserSettings.excludedSources[source].excludedDocumentTypes = currentlyExcluded
+            ? this.browserSettings.excludedSources[source].excludedDocumentTypes.filter(x => x !== type)
+            : [...(this.browserSettings.excludedSources[source]?.excludedDocumentTypes ?? []), type];
+
+        const toggleIcon = button.querySelector('a > i');
+        toggleIcon.classList.toggle('fa-toggle-off');
+        toggleIcon.classList.toggle('fa-toggle-on');
+        button.closest('.source-container').querySelector('.checks-container').classList.toggle('collapsed');
+    }
+
+    toggleTypedPack(event) {
+        event.stopPropagation();
+
+        const { type, pack } = event.target.dataset;
+        const currentlyExcluded = this.browserSettings.excludedPacks[pack]
+            ? this.browserSettings.excludedPacks[pack].excludedDocumentTypes.includes(type)
+            : false;
+
+        if (!this.browserSettings.excludedPacks[pack])
+            this.browserSettings.excludedPacks[pack] = { excludedDocumentTypes: [] };
+        this.browserSettings.excludedPacks[pack].excludedDocumentTypes = currentlyExcluded
+            ? this.browserSettings.excludedPacks[pack].excludedDocumentTypes.filter(x => x !== type)
+            : [...(this.browserSettings.excludedPacks[pack]?.excludedDocumentTypes ?? []), type];
+
+        this.render();
+    }
+
+    static async #finish() {
+        const settings = game.settings.get(CONFIG.DH.id, CONFIG.DH.SETTINGS.gameSettings.CompendiumBrowserSettings);
+        await settings.updateSource(this.browserSettings);
+        await game.settings.set(
+            CONFIG.DH.id,
+            CONFIG.DH.SETTINGS.gameSettings.CompendiumBrowserSettings,
+            settings.toObject()
+        );
+
+        this.updated = true;
+        this.close();
+    }
+
+    static async configure() {
+        return new Promise(resolve => {
+            const app = new this();
+            app.addEventListener('close', () => resolve(app.updated), { once: true });
+            app.render({ force: true });
+        });
+    }
+}

module/applications/dialogs/_module.mjs

@@ -16,3 +16,4 @@ export { default as ActionSelectionDialog } from './actionSelectionDialog.mjs';
 export { default as GroupRollDialog } from './group-roll-dialog.mjs';
 export { default as TagTeamDialog } from './tagTeamDialog.mjs';
 export { default as RiskItAllDialog } from './riskItAllDialog.mjs';
+export { default as CompendiumBrowserSettingsDialog } from './CompendiumBrowserSettings.mjs';

module/applications/ui/itemBrowser.mjs

@@ -1,3 +1,5 @@
+import { RefreshType, socketEvent } from '../../systemRegistration/socket.mjs';
+
 const { HandlebarsApplicationMixin, ApplicationV2 } = foundry.applications.api;
 
 /**
@@ -17,6 +19,15 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
         this.config = CONFIG.DH.ITEMBROWSER.compendiumConfig;
         this.presets = {};
         this.compendiumBrowserTypeKey = 'compendiumBrowserDefault';
+
+        this.setupHooks = Hooks.on(socketEvent.Refresh, ({ refreshType }) => {
+            if (refreshType === RefreshType.CompendiumBrowser) {
+                if (this.rendered) {
+                    this.render();
+                    this.loadItems();
+                }
+            }
+        });
     }
 
     /** @inheritDoc */
@@ -35,7 +46,8 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
             selectFolder: this.selectFolder,
             expandContent: this.expandContent,
             resetFilters: this.resetFilters,
-            sortList: this.sortList
+            sortList: this.sortList,
+            openSettings: this.openSettings
         },
         position: {
             left: 100,
@@ -157,6 +169,8 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
         context.formatChoices = this.formatChoices;
         context.items = this.items;
         context.presets = this.presets;
+        context.isGM = game.user.isGM;
+
         return context;
     }
 
@@ -214,6 +228,10 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
     loadItems() {
         let loadTimeout = this.toggleLoader(true);
 
+        const browserSettings = game.settings.get(
+            CONFIG.DH.id,
+            CONFIG.DH.SETTINGS.gameSettings.CompendiumBrowserSettings
+        );
         const promises = [];
 
         game.packs.forEach(pack => {
@@ -227,7 +245,7 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
 
         Promise.all(promises).then(async result => {
             this.items = ItemBrowser.sortBy(
-                result.flatMap(r => r),
+                result.flatMap(r => r).filter(r => !browserSettings.isEntryExcluded.bind(browserSettings)(r)),
                 'name'
             );
 
@@ -512,6 +530,22 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
         itemListContainer.replaceChildren(...newOrder);
     }
 
+    static async openSettings() {
+        const settingsUpdated = await game.system.api.applications.dialogs.CompendiumBrowserSettingsDialog.configure();
+        if (settingsUpdated) {
+            if (this.rendered) {
+                this.render();
+                this.loadItems();
+            }
+            await game.socket.emit(`system.${CONFIG.DH.id}`, {
+                action: socketEvent.Refresh,
+                data: {
+                    refreshType: RefreshType.CompendiumBrowser
+                }
+            });
+        }
+    }
+
     _createDragProcess() {
         new foundry.applications.ux.DragDrop.implementation({
             dragSelector: '.item-container',
@@ -571,4 +605,9 @@ export class ItemBrowser extends HandlebarsApplicationMixin(ApplicationV2) {
             headerActions.append(button);
         }
     }
+
+    async close(options = {}) {
+        Hooks.off(socketEvent.Refresh, this.setupHooks);
+        await super.close(options);
+    }
 }

module/config/settingsConfig.mjs

@@ -30,6 +30,7 @@ export const gameSettings = {
     LastMigrationVersion: 'LastMigrationVersion',
     TagTeamRoll: 'TagTeamRoll',
     SpotlightRequestQueue: 'SpotlightRequestQueue',
+    CompendiumBrowserSettings: 'CompendiumBrowserSettings'
 };
 
 export const actionAutomationChoices = {

module/data/_module.mjs

@@ -3,6 +3,7 @@ export { default as DhCombatant } from './combatant.mjs';
 export { default as DhTagTeamRoll } from './tagTeamRoll.mjs';
 export { default as DhRollTable } from './rollTable.mjs';
 export { default as RegisteredTriggers } from './registeredTriggers.mjs';
+export { default as CompendiumBrowserSettings } from './compendiumBrowserSettings.mjs';
 
 export * as countdowns from './countdowns.mjs';
 export * as actions from './action/_module.mjs';

module/data/compendiumBrowserSettings.mjs

@@ -0,0 +1,35 @@
+export default class CompendiumBrowserSettings extends foundry.abstract.DataModel {
+    static defineSchema() {
+        const fields = foundry.data.fields;
+
+        return {
+            excludedSources: new fields.TypedObjectField(
+                new fields.SchemaField({
+                    excludedDocumentTypes: new fields.ArrayField(
+                        new fields.StringField({ required: true, choices: CONST.SYSTEM_SPECIFIC_COMPENDIUM_TYPES })
+                    )
+                })
+            ),
+            excludedPacks: new fields.TypedObjectField(
+                new fields.SchemaField({
+                    excludedDocumentTypes: new fields.ArrayField(
+                        new fields.StringField({ required: true, choices: CONST.SYSTEM_SPECIFIC_COMPENDIUM_TYPES })
+                    )
+                })
+            )
+        };
+    }
+
+    isEntryExcluded(item) {
+        const pack = game.packs.get(item.pack);
+        if (!pack) return false;
+
+        const excludedSourceData = this.excludedSources[pack.metadata.packageName];
+        if (excludedSourceData && excludedSourceData.excludedDocumentTypes.includes(pack.metadata.type)) return true;
+
+        const excludedPackData = this.excludedPacks[item.pack];
+        if (excludedPackData && excludedPackData.excludedDocumentTypes.includes(pack.metadata.type)) return true;
+
+        return false;
+    }
+}

module/systemRegistration/settings.mjs

@@ -7,7 +7,7 @@ import {
     DhHomebrewSettings,
     DhVariantRuleSettings
 } from '../applications/settings/_module.mjs';
-import { DhTagTeamRoll } from '../data/_module.mjs';
+import { CompendiumBrowserSettings, DhTagTeamRoll } from '../data/_module.mjs';
 
 export const registerDHSettings = () => {
     registerMenuSettings();
@@ -142,6 +142,12 @@ const registerNonConfigSettings = () => {
         config: false,
         type: DhTagTeamRoll
     });
+
+    game.settings.register(CONFIG.DH.id, CONFIG.DH.SETTINGS.gameSettings.CompendiumBrowserSettings, {
+        scope: 'client',
+        config: false,
+        type: CompendiumBrowserSettings
+    });
 };
 
 /**

module/systemRegistration/socket.mjs

@@ -38,7 +38,8 @@ export const RefreshType = {
     Countdown: 'DhCoundownRefresh',
     TagTeamRoll: 'DhTagTeamRollRefresh',
     EffectsDisplay: 'DhEffectsDisplayRefresh',
-    Scene: 'DhSceneRefresh'
+    Scene: 'DhSceneRefresh',
+    CompendiumBrowser: 'DhCompendiumBrowserRefresh'
 };
 
 export const registerSocketHooks = () => {