Feature/178 searchbar logic to items in character sheet (#209)

* REFACTOR: remove DhpApplicationMixin
REFACTOR: remove getEmbeddedDocument method from Item class
REFACTOR: remove prepareData method from Actor class
REFACTOR: remove _preUpdate method from Actor class

* REFACTOR: rename dhpItem to DHItem
REFACTOR: improvement Item#isInventoryItem getter
REFACTOR: simplify Item's createDialog static method.
REFACTOR: remove documentCreate template

* FEAT: add SearchFilter for character-sheet Inventory and DomainCards
FEAT: simplify the preparetion of inventory context

---------

Co-authored-by: Joaquin Pereyra <joaquinpereyra98@users.noreply.github.com>

daggerheart.mjs

@@ -62,7 +62,7 @@ Hooks.once('init', () => {
     CONFIG.Dice.rolls = [...CONFIG.Dice.rolls, ...[DHRoll, DualityRoll, D20Roll, DamageRoll]];
     CONFIG.MeasuredTemplate.objectClass = DhMeasuredTemplate;
 
-    CONFIG.Item.documentClass = documents.DhpItem;
+    CONFIG.Item.documentClass = documents.DHItem;
 
     //Registering the Item DataModel
     CONFIG.Item.dataModels = models.items.config;

module/applications/daggerheart-sheet.mjs

@@ -1,48 +0,0 @@
-export default function DhpApplicationMixin(Base) {
-    return class DhpSheet extends Base {
-        static applicationType = 'sheets';
-        static documentType = '';
-
-        static get defaultOptions() {
-            return Object.assign(super.defaultOptions, {
-                classes: ['daggerheart', 'sheet', this.documentType],
-                template: `systems/${SYSTEM.id}/templates/${this.applicationType}/${this.documentType}.hbs`,
-                height: 'auto',
-                submitOnChange: true,
-                submitOnClose: false,
-                width: 450
-            });
-        }
-
-        /** @override */
-        get title() {
-            const { documentName, type, name } = this.object;
-            // const typeLabel = game.i18n.localize(CONFIG[documentName].typeLabels[type]);
-            const typeLabel = documentName;
-            return `[${typeLabel}] ${name}`;
-        }
-
-        // async _renderOuter() {
-        //   const html = await super._renderOuter();
-        //   // const overlaySrc = "systems/amia/assets/ThePrimordial.png";
-        //   const overlay = `<div class="outer-render"></div>`
-        //   $(html).find('.window-header').prepend(overlay);
-        //   return html;
-        // }
-
-        activateListeners(html) {
-            super.activateListeners(html);
-            html.on('click', '[data-action]', this.#onClickAction.bind(this));
-        }
-
-        async #onClickAction(event) {
-            event.preventDefault();
-            const button = event.currentTarget;
-            const action = button.dataset.action;
-
-            return this._handleAction(action, event, button);
-        }
-
-        async _handleAction(action, event, button) {}
-    };
-}

module/applications/sheets/character.mjs

@@ -56,7 +56,6 @@ export default class CharacterSheet extends DaggerheartSheet(ActorSheetV2) {
             resizable: true
         },
         form: {
-            handler: this.updateForm,
             submitOnChange: true,
             closeOnSubmit: false
         },
@@ -218,6 +217,15 @@ export default class CharacterSheet extends DaggerheartSheet(ActorSheetV2) {
         this._createContextMenues();
     }
 
+    /** @inheritDoc */
+    async _onRender(context, options) {
+        await super._onRender(context, options);
+
+        this._createSearchFilter();
+    }
+
+    /* -------------------------------------------- */
+
     _createContextMenues() {
         const allOptions = {
             useItem: {
@@ -431,10 +439,104 @@ export default class CharacterSheet extends DaggerheartSheet(ActorSheetV2) {
         return context;
     }
 
-    static async updateForm(event, _, formData) {
-        await this.document.update(formData.object);
-        this.render();
+    /* -------------------------------------------- */
+    /*  Search Filter                               */
+    /* -------------------------------------------- */
+
+    /**
+     * The currently active search filter.
+     * @type {foundry.applications.ux.SearchFilter}
+     */
+    #search = {};
+
+    /**
+     * Track which item IDs are currently displayed due to a search filter.
+     * @type {{ inventory: Set<string>, loadout: Set<string> }}
+     */
+    #filteredItems = {
+        inventory: new Set(),
+        loadout: new Set()
+    };
+
+    /**
+     * Create and initialize search filter instances for the inventory and loadout sections.
+     *
+     * Sets up two {@link foundry.applications.ux.SearchFilter} instances:
+     * - One for the inventory, which filters items in the inventory grid.
+     * - One for the loadout, which filters items in the loadout/card grid.
+     * @private
+     */
+    _createSearchFilter() {
+        //Filters could be a application option if needed
+        const filters = [
+            {
+                key: 'inventory',
+                input: 'input[type="search"].search-inventory',
+                content: '[data-application-part="inventory"] .items-section',
+                callback: this._onSearchFilterInventory.bind(this)
+            },
+            {
+                key: 'loadout',
+                input: 'input[type="search"].search-loadout',
+                content: '[data-application-part="loadout"] .items-section',
+                callback: this._onSearchFilterCard.bind(this)
             }
+        ];
+
+        for (const { key, input, content, callback } of filters) {
+            const filter = new foundry.applications.ux.SearchFilter({
+                inputSelector: input,
+                contentSelector: content,
+                callback
+            });
+            filter.bind(this.element);
+            this.#search[key] = filter;
+        }
+    }
+
+    /**
+     * Handle invetory items search and filtering.
+     * @param {KeyboardEvent} event  The keyboard input event.
+     * @param {string} query         The input search string.
+     * @param {RegExp} rgx           The regular expression query that should be matched against.
+     * @param {HTMLElement} html     The container to filter items from.
+     * @protected
+     */
+    _onSearchFilterInventory(event, query, rgx, html) {
+        this.#filteredItems.inventory.clear();
+
+        for (const ul of html.querySelectorAll('.items-list')) {
+            for (const li of ul.querySelectorAll('.inventory-item')) {
+                const item = this.document.items.get(li.dataset.itemId);
+                const match = !query || foundry.applications.ux.SearchFilter.testQuery(rgx, item.name);
+                if (match) this.#filteredItems.inventory.add(item.id);
+                li.hidden = !match;
+            }
+        }
+    }
+
+    /**
+     * Handle card items search and filtering.
+     * @param {KeyboardEvent} event  The keyboard input event.
+     * @param {string} query         The input search string.
+     * @param {RegExp} rgx           The regular expression query that should be matched against.
+     * @param {HTMLElement} html     The container to filter items from.
+     * @protected
+     */
+    _onSearchFilterCard(event, query, rgx, html) {
+        this.#filteredItems.loadout.clear();
+
+        const elements = html.querySelectorAll('.items-list .inventory-item, .card-list .card-item');
+
+        for (const li of elements) {
+            const item = this.document.items.get(li.dataset.itemId);
+            const match = !query || foundry.applications.ux.SearchFilter.testQuery(rgx, item.name);
+            if (match) this.#filteredItems.loadout.add(item.id);
+            li.hidden = !match;
+        }
+    }
+
+    /* -------------------------------------------- */
 
     async mapFeatureType(data, configType) {
         return await Promise.all(

module/data/item/armor.mjs

@@ -9,7 +9,8 @@ export default class DHArmor extends BaseDataItem {
             label: 'TYPES.Item.armor',
             type: 'armor',
             hasDescription: true,
-            isQuantifiable: true
+            isQuantifiable: true,
+            isInventoryItem: true,
         });
     }
 

module/data/item/base.mjs

@@ -7,6 +7,7 @@ import { actionsTypes } from '../action/_module.mjs';
  * @property {string} type - The system type that this data model represents.
  * @property {boolean} hasDescription - Indicates whether items of this type have description field
  * @property {boolean} isQuantifiable - Indicates whether items of this type have quantity field
+ * @property {boolean} isInventoryItem- Indicates whether items of this type is a Inventory Item
  */
 
 const fields = foundry.data.fields;
@@ -18,7 +19,8 @@ export default class BaseDataItem extends foundry.abstract.TypeDataModel {
             label: 'Base Item',
             type: 'base',
             hasDescription: false,
-            isQuantifiable: false
+            isQuantifiable: false,
+            isInventoryItem: false,
         };
     }
 

module/data/item/consumable.mjs

@@ -8,7 +8,8 @@ export default class DHConsumable extends BaseDataItem {
             label: 'TYPES.Item.consumable',
             type: 'consumable',
             hasDescription: true,
-            isQuantifiable: true
+            isQuantifiable: true,
+            isInventoryItem: true,
         });
     }
 

module/data/item/miscellaneous.mjs

@@ -8,7 +8,8 @@ export default class DHMiscellaneous extends BaseDataItem {
             label: 'TYPES.Item.miscellaneous',
             type: 'miscellaneous',
             hasDescription: true,
-            isQuantifiable: true
+            isQuantifiable: true,
+            isInventoryItem: true,
         });
     }
 

module/data/item/weapon.mjs

@@ -12,10 +12,8 @@ export default class DHWeapon extends BaseDataItem {
             type: 'weapon',
             hasDescription: true,
             isQuantifiable: true,
-            embedded: {
-                feature: 'featureTest'
-            },
-            hasInitialAction: true
+            isInventoryItem: true,
+            hasInitialAction: true,
         });
     }
 

module/documents/_module.mjs

@@ -1,4 +1,4 @@
 export { default as DhpActor } from './actor.mjs';
-export { default as DhpItem } from './item.mjs';
+export { default as DHItem } from './item.mjs';
 export { default as DhpCombat } from './combat.mjs';
 export { default as DhActiveEffect } from './activeEffect.mjs';

module/documents/actor.mjs

@@ -17,14 +17,6 @@ export default class DhpActor extends Actor {
         this.updateSource({ prototypeToken });
     }
 
-    prepareData() {
-        super.prepareData();
-    }
-
-    async _preUpdate(changed, options, user) {
-        super._preUpdate(changed, options, user);
-    }
-
     async updateLevel(newLevel) {
         if (this.type !== 'character' || newLevel === this.system.levelData.level.changed) return;
 

module/documents/item.mjs

@@ -1,14 +1,8 @@
-export default class DhpItem extends Item {
-    /** @inheritdoc */
-    getEmbeddedDocument(embeddedName, id, { invalid = false, strict = false } = {}) {
-        const systemEmbeds = this.system.constructor.metadata.embedded ?? {};
-        if (embeddedName in systemEmbeds) {
-            const path = `system.${systemEmbeds[embeddedName]}`;
-            return foundry.utils.getProperty(this, path).get(id) ?? null;
-        }
-        return super.getEmbeddedDocument(embeddedName, id, { invalid, strict });
-    }
-
+/**
+ * Override and extend the basic Item implementation.
+ * @extends {foundry.documents.Item}
+ */
+export default class DHItem extends foundry.documents.Item {
     /** @inheritDoc */
     prepareEmbeddedDocuments() {
         super.prepareEmbeddedDocuments();
@@ -35,67 +29,51 @@ export default class DhpItem extends Item {
         return data;
     }
 
-    isInventoryItem() {
-        return ['weapon', 'armor', 'miscellaneous', 'consumable'].includes(this.type);
+    /**
+     * Determine if this item is classified as an inventory item based on its metadata.
+     * @returns {boolean} Returns `true` if the item is an inventory item.
+     */
+    get isInventoryItem() {
+        return this.system.constructor.metadata.isInventoryItem ?? false;
     }
 
-    static async createDialog(data = {}, { parent = null, pack = null, ...options } = {}) {
-        const documentName = this.metadata.name;
-        const types = game.documentTypes[documentName].filter(t => t !== CONST.BASE_DOCUMENT_TYPE);
-        let collection;
-        if (!parent) {
-            if (pack) collection = game.packs.get(pack);
-            else collection = game.collections.get(documentName);
-        }
-        const folders = collection?._formatFolderSelectOptions() ?? [];
-        const label = game.i18n.localize(this.metadata.label);
-        const title = game.i18n.format('DOCUMENT.Create', { type: label });
-        const typeObjects = types.reduce((obj, t) => {
-            const label = CONFIG[documentName]?.typeLabels?.[t] ?? t;
-            obj[t] = { value: t, label: game.i18n.has(label) ? game.i18n.localize(label) : t };
-            return obj;
-        }, {});
+    /** @inheritdoc */
+    static async createDialog(data = {}, createOptions = {}, options = {}) {
+        const { folders, types, template, context = {}, ...dialogOptions } = options;
 
-        // Render the document creation form
-        const html = await foundry.applications.handlebars.renderTemplate(
-            'systems/daggerheart/templates/sidebar/documentCreate.hbs',
-            {
-                folders,
-                name: data.name || game.i18n.format('DOCUMENT.New', { type: label }),
-                folder: data.folder,
-                hasFolders: folders.length >= 1,
-                type: data.type || CONFIG[documentName]?.defaultType || typeObjects.armor,
-                types: {
-                    Items: [typeObjects.armor, typeObjects.weapon, typeObjects.consumable, typeObjects.miscellaneous],
-                    Character: [
-                        typeObjects.class,
-                        typeObjects.subclass,
-                        typeObjects.ancestry,
-                        typeObjects.community,
-                        typeObjects.feature,
-                        typeObjects.domainCard
-                    ]
-                },
-                hasTypes: types.length > 1
+        if (types?.length === 0) {
+            throw new Error('The array of sub-types to restrict to must not be empty.');
+        }
+
+        const documentTypes = this.TYPES.filter(type => type !== 'base' && (!types || types.includes(type))).map(
+            type => {
+                const labelKey = CONFIG.Item?.typeLabels?.[type];
+                const label = labelKey && game.i18n.has(labelKey) ? game.i18n.localize(labelKey) : type;
+
+                const isInventoryItem = CONFIG.Item.dataModels[type]?.metadata?.isInventoryItem;
+                const group =
+                    isInventoryItem === true
+                        ? 'Inventory Items'
+                        : isInventoryItem === false
+                            ? 'Character Items'
+                            : 'Other';
+
+                return { value: type, label, group };
             }
         );
 
-        // Render the confirmation dialog window
-        return Dialog.prompt({
-            title: title,
-            content: html,
-            label: title,
-            callback: html => {
-                const form = html[0].querySelector('form');
-                const fd = new FormDataExtended(form);
-                foundry.utils.mergeObject(data, fd.object, { inplace: true });
-                if (!data.folder) delete data.folder;
-                if (types.length === 1) data.type = types[0];
-                if (!data.name?.trim()) data.name = this.defaultName();
-                return this.create(data, { parent, pack, renderSheet: true });
-            },
-            rejectClose: false,
-            options
+        if (!documentTypes.length) {
+            throw new Error('No document types were permitted to be created.');
+        }
+
+        const sortedTypes = documentTypes.sort((a, b) => a.label.localeCompare(b.label, game.i18n.lang));
+
+        return await super.createDialog(data, createOptions, {
+            folders,
+            types,
+            template,
+            context: { types: sortedTypes, ...context },
+            ...dialogOptions
         });
     }
 

styles/daggerheart.css

@@ -4080,6 +4080,10 @@ div.daggerheart.views.multiclass {
 .application.sheet.daggerheart.actor.dh-style.character .tab.inventory .search-section .search-bar input:placeholder {
   color: light-dark(#18162e50, #efe6d850);
 }
+.application.sheet.daggerheart.actor.dh-style.character .tab.inventory .search-section .search-bar input::-webkit-search-cancel-button {
+  -webkit-appearance: none;
+  display: none;
+}
 .application.sheet.daggerheart.actor.dh-style.character .tab.inventory .search-section .search-bar .icon {
   align-content: center;
   height: 32px;

styles/less/actors/character/inventory.less

@@ -30,6 +30,11 @@
                     &:placeholder {
                         color: light-dark(@dark-blue-50, @beige-50);
                     }
+
+                    &::-webkit-search-cancel-button {
+                        -webkit-appearance: none;
+                        display: none;
+                    }
                 }
 
                 .icon {

templates/sheets/actors/character/inventory.hbs

@@ -8,7 +8,7 @@
             <div class="icon">
                 <i class="fa-solid fa-magnifying-glass"></i>
             </div>
-            <input type="text" name="" id="" placeholder="Search...">
+            <input type="search" name="search" class="search-inventory" placeholder="Search...">
         </div>
         <a><i class="fa-solid fa-filter"></i></a>
     </div>

templates/sheets/actors/character/loadout.hbs

@@ -8,7 +8,7 @@
             <div class="icon">
                 <i class="fa-solid fa-magnifying-glass"></i>
             </div>
-            <input type="text" name="" id="" placeholder="Search...">
+            <input type="search" name="search" class="search-loadout" placeholder="Search...">
         </div>
         <a><i class="fa-solid fa-filter"></i></a>
         <button class="btn-toggle-view" data-action="toggleLoadoutView" data-value="{{this.abilities.loadout.listView}}">

templates/sheets/global/partials/domain-card-item.hbs

@@ -1,4 +1,4 @@
-<li class="card-item" data-item-id="{{item.id}}">
+<li class="card-item" data-item-id="{{item.id}}" data-item-id="{{item.id}}">
     <img src="{{item.img}}" data-action="useItem" class="card-img" />
     <div class="card-label">
         <div class="controls">

templates/sidebar/documentCreate.hbs

@@ -1,45 +0,0 @@
-<form id="document-create" autocomplete="off">
-    <div class="form-group">
-        <label>{{localize "Name"}}</label>
-        <div class="form-fields">
-            <input type="text" name="name" placeholder="{{name}}" autofocus>
-        </div>
-    </div>
-
-    {{#if hasTypes}}
-    <div class="form-group">
-        <label>{{localize "Type"}}</label>
-        <div class="form-fields">
-            <select name="type">
-                {{#select type}}
-                    {{#each types as |values key|}}
-                        <optgroup label="{{key}}">
-                            {{#each values}}
-                                <option value="{{this.value}}">{{this.label}}</option>
-                            {{/each}}
-                        </optgroup>
-                    {{/each}}
-                {{/select}}
-            </select>
-        </div>
-    </div>
-    {{/if}}
-
-    {{#if hasFolders}}
-    <div class="form-group">
-        <label>{{ localize "DOCUMENT.Folder" }}</label>
-        <div class="form-fields">
-            <select name="folder">
-                {{#select folder}}
-                    <option value=""></option>
-                    {{#each folders}}
-                    <option value="{{ this.id }}">{{ this.name }}</option>
-                    {{/each}}
-                {{/select}}
-            </select>
-        </div>
-    </div>
-    {{/if}}
-
-    {{{content}}}
-</form>