Update item compendium migration (#791)

* Retain specified item fields during migrations
* Update the rendering on item selection when comparison is present

Author: Azurelol

lang/en.json

@@ -1765,6 +1765,7 @@
 		"PressurePoint": "Pressure Point",
 		"Stagger": "Stagger",
 		"CompendiumBrowser": "Compendium Browser",
+		"CompendiumItem": "Compendium Item",
 		"CompendiumMigrateItem": "Migrate Item",
 		"CompendiumMigrateItemMessage": "Would you like to migrate the data in the item <strong>{name}</strong> to that of the compendium?",
 		"CompendiumMigrateActorItems": "Migrate Actor Items",

module/documents/items/item-data-model.mjs

@@ -19,6 +19,13 @@ export class FUItemDataModel extends foundry.abstract.TypeDataModel {
 		return [];
 	}
 
+	/**
+	 * @returns {String[]} The path to fields in this data model that should be retained during migrations.
+	 */
+	get retainedFieldPaths() {
+		return [];
+	}
+
 	static migrateData(source) {
 		source = super.migrateData(source);
 		if (source.source?.value) {

module/documents/items/skill/skill-data-model.mjs

@@ -243,6 +243,10 @@ export class SkillDataModel extends BaseSkillDataModel {
 		return [...this.commonPartials, ItemPartialTemplates.classField, ItemPartialTemplates.skillAttributes];
 	}
 
+	get retainedFieldPaths() {
+		return ['level.value'];
+	}
+
 	/**
 	 * Action definition, invoked by sheets when 'data-action' equals the method name and no action defined on the sheet matches that name.
 	 * @param {PointerEvent} event

module/helpers/foundry-utils.mjs

@@ -2,6 +2,7 @@ import { StringUtils } from './string-utils.mjs';
 import { systemTemplatePath } from './system-utils.mjs';
 import { TextEditor } from './text-editor.mjs';
 import { CompendiumIndex } from '../ui/compendium/compendium-index.mjs';
+import { ObjectUtils } from './object-utils.mjs';
 
 const { api, fields, handlebars } = foundry.applications;
 
@@ -405,6 +406,16 @@ export default class FoundryUtils {
 	 * @async
 	 */
 	static async migrateItem(sourceItem, targetItem) {
+		// Gather retained data model properties
+		const retainedFields = {};
+		for (const fieldPath of targetItem.system.retainedFieldPaths) {
+			const systemPath = `system.${fieldPath}`;
+			const fieldValue = ObjectUtils.getProperty(targetItem, systemPath);
+			if (fieldValue !== undefined) {
+				retainedFields[systemPath] = fieldValue;
+			}
+		}
+
 		// Properties
 		await targetItem.update(
 			{
@@ -416,6 +427,9 @@ export default class FoundryUtils {
 			{ diff: false },
 		);
 
+		// After the deep clone, apply them again.
+		await targetItem.update(retainedFields);
+
 		// Effects
 		const updates = [];
 		const creates = [];

module/helpers/object-utils.mjs

@@ -34,6 +34,15 @@ function getProperty(obj, path) {
 	return foundry.utils.getProperty(obj, path);
 }
 
+/**
+ * @param {Object} obj The object to set the property on
+ * @param {String} path The path to the property, in dot notation
+ * @param {*} value The value to set on the property.
+ */
+function setProperty(obj, path, value) {
+	return foundry.utils.setProperty(obj, path, value);
+}
+
 /**
  *
  * @param {Object} obj
@@ -56,6 +65,7 @@ function pick(record, keys) {
 export const ObjectUtils = Object.freeze({
 	mergeRecursive,
 	getProperty,
+	setProperty,
 	cleanObject,
 	pick,
 });

module/sheets/actor-sheet.mjs

@@ -165,14 +165,17 @@ export class FUActorSheet extends api.HandlebarsApplicationMixin(sheets.ActorShe
 			});
 
 			items = updates.map((upd) => upd.item);
+			const compendiumItems = updates.map((upd) => upd.compendiumItem);
 
+			// TODO: Custom table?
 			const title = 'FU.CompendiumMigrateActorItems';
 			/** @type ItemSelectionData **/
 			const data = {
 				title: title,
 				message,
 				style: 'list',
 				items: items,
+				compendiumItems: compendiumItems,
 				initial: items,
 				getDescription: async (item) => {
 					const text = item.system?.description ?? '';

module/ui/features/item-selection-dialog.mjs

@@ -5,6 +5,7 @@ import FoundryUtils from '../../helpers/foundry-utils.mjs';
  * @property {String} title
  * @property {String} message
  * @property {FUItem[]|FUActiveEffect[]} items
+ * @property {FUItem[]} compendiumItems If assigned, will be used to compare to the original items.
  * @property {Object[]} initial
  * @property {'grid'|'list'} style
  * @property {Number} max

templates/dialog/dialog-item-selection.hbs

@@ -42,6 +42,15 @@
 				</span>
 			</legend>
 			<table class="table-compact fu-scrollable" style="max-height: 400px;">
+				<thead>
+					<tr>
+						<th></th>
+						<th>{{localize 'FU.Item'}}</th>
+						{{#if compendiumItems}}
+							<th>{{localize 'FU.CompendiumItem'}}</th>
+						{{/if}}
+					</tr>
+				</thead>
 				{{#each items as |item|}}
 					<tr>
 						<td>
@@ -56,10 +65,16 @@
 						</td>
 						<td>
 							{{pfuItemAnchor item}}
-						</td>
-						<td>
 							<span data-tooltip="{{lookup ../descriptions @index}}">{{item.name}}</span>
 						</td>
+						{{#if @root.compendiumItems}}
+							<td>
+								{{#with (lookup ../compendiumItems @index) as |item|}}
+									{{pfuItemAnchor item}}
+									<span>{{item.name}}</span>
+								{{/with}}
+							</td>
+						{{/if}}
 					</tr>
 				{{/each}}
 			</table>