[Share] Batch update refreshable notes using update content from templates

[ramonmi]

Description

• After [Share] [Custom-Template] Run selected Better Notes template for current item #319 (comment)
• Batch update refreshable notes using update content from templates. The refreshable notes are filtered by refreshable-template tag.
• The update content from templates function currently requires notes to be opened in the editor and cannot refresh unopened notes. So this script calls the Zotero.BetterNotes.hooks.onOpenNote interface to open notes, and then close them after processing.
  • Given that it will take some time to continuously open and close numerous Note windows, this script shows a popup initially to alert the user.
• The delay time may depend on the performance of the computer, the users can modify it to a appropriate one.

Event

None

Operation

Script

Data

/**
 * Batch update refreshable notes using update content from templates
 * @usage Trigger with shortcuts
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/451
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/451
 * @ref https://github.com/windingwind/zotero-better-notes/issues/1257
 * @after https://github.com/windingwind/zotero-actions-tags/discussions/319#discussioncomment-11769467
*/

if (item) {
	return;
}

if (!Zotero.BetterNotes?.api.note?.insert) {
	return "[Action:Batch-Update] Better Notes for Zotero > 1.1.4-21 is not installed or disabled.";
}

const window = require("window");
const TipLabel = window.prompt(`${items.length} items selected! This will take some time to continuously open and close numerous Note windows. Continue? (y/n):`);
if (TipLabel && TipLabel === "y" || TipLabel === "Y" || TipLabel === "yes" || TipLabel === "YES" || TipLabel === "Yes") {

	// define updatecontentinNote function
	let countNum = 0;
	async function updatecontentinNote(noteID) {
		let win = await Zotero.BetterNotes.hooks.onOpenNote(noteID, "window");
		let getEditor = () => Zotero.BetterNotes.api.editor.getEditorInstance(noteID);
		let i = 0;
		while (i < 30 && !getEditor()) {
			await Zotero.Promise.delay(100);
			i++;
		}
		await Zotero.BetterNotes.hooks.onRefreshTemplatesInNote(getEditor());
		await Zotero.Promise.delay(2000);   // modify 2000 to a more appropriate time value according to the performance of your computer
		win.close();
		countNum += 1;
	}

	const refreshableTag = "refreshable-template";
	async function refreshNote(targetitem) {
		if (targetitem.isRegularItem() && !targetitem.isNote()) {
			const noteIDs = targetitem.getNotes();
			for (let noteid of noteIDs) {
				note = Zotero.Items.get(noteid);
				if (note.getTags().some(obj => obj.tag === refreshableTag)) {
					await updatecontentinNote(noteid);
				}
			}
		} else if (targetitem.isNote()) {
			const parentItem = Zotero.Items.getTopLevel([targetitem])[0];
			if (parentItem.isRegularItem()) {
				if (targetitem.getTags().find(obj => obj.tag === refreshableTag)) {
					await updatecontentinNote(targetitem.id);
				}
			}
		}
	}

	for (let item of items) {
		await refreshNote(item);
	}
	return `[Action:Batch-Update] Updated ${countNum} refreshable notes!`;

} else if (TipLabel && TipLabel === "n" || TipLabel === "N" || TipLabel === "No" || TipLabel === "NO") {
	window.alert("Execution cancelled, nothing to do!");
} else {
	window.alert("Invalid input, nothing to do!");
}

Anything else

Use in conjunction with this template #319 (comment) is recommended.