fix(templater): bind api calls and await trigger-on-create

Author: chhoumann

src/engine/CaptureChoiceEngine.ts

@@ -26,7 +26,7 @@ import {
 	openFile,
 	overwriteTemplaterOnce,
 	templaterParseTemplate,
-	waitForFileToStopChanging,
+	waitForTemplaterTriggerOnCreateToComplete,
 } from "../utilityObsidian";
 import { isCancellationError, reportError } from "../utils/errorUtils";
 import { QuickAddChoiceEngine } from "./QuickAddChoiceEngine";
@@ -467,7 +467,7 @@ export class CaptureChoiceEngine extends QuickAddChoiceEngine {
 		) {
 			await overwriteTemplaterOnce(this.app, file);
 		} else if (isTemplaterTriggerOnCreateEnabled(this.app)) {
-			await waitForFileToStopChanging(this.app, file);
+			await waitForTemplaterTriggerOnCreateToComplete(this.app, file);
 		}
 
 		// Read the file fresh from disk to avoid any potential cached content

src/utilityObsidian.templater-binding.test.ts

@@ -0,0 +1,58 @@
+import { describe, expect, it } from "vitest";
+import { App, TFile } from "obsidian";
+import { jumpToNextTemplaterCursorIfPossible, templaterParseTemplate } from "./utilityObsidian";
+
+describe("templaterParseTemplate", () => {
+	it("calls parse_template with the correct `this` context", async () => {
+		const app = new App();
+		const file = new TFile();
+		file.path = "QA.md";
+		file.extension = "md";
+
+		const templater = {
+			functions_generator: { ok: true },
+			parse_template: async function (
+				this: any,
+				_opts: unknown,
+				content: string,
+			): Promise<string> {
+				expect(this?.functions_generator?.ok).toBe(true);
+				return `rendered:${content}`;
+			},
+		};
+
+		(app as any).plugins.plugins["templater-obsidian"] = { templater };
+
+		const result = await templaterParseTemplate(app as any, "hello", file as any);
+		expect(result).toBe("rendered:hello");
+	});
+});
+
+describe("jumpToNextTemplaterCursorIfPossible", () => {
+	it("calls jump_to_next_cursor_location with the correct `this` context", async () => {
+		const app = new App();
+		const file = new TFile();
+		file.path = "QA.md";
+		file.extension = "md";
+
+		(app as any).workspace.getActiveFile = () => file;
+
+		const editorHandler = {
+			plugin: { ok: true },
+			jump_to_next_cursor_location: async function (
+				this: any,
+				_targetFile: unknown,
+				_autoJump: unknown,
+			): Promise<void> {
+				expect(this?.plugin?.ok).toBe(true);
+			},
+		};
+
+		(app as any).plugins.plugins["templater-obsidian"] = {
+			settings: { auto_jump_to_cursor: true },
+			editor_handler: editorHandler,
+		};
+
+		await jumpToNextTemplaterCursorIfPossible(app as any, file as any);
+	});
+});

src/utilityObsidian.ts

@@ -37,6 +37,7 @@ export type TemplaterPluginLike = {
 		functions_generator?: { teardown?: () => Promise<void> };
 	};
 	editor_handler?: {
+		plugin?: unknown;
 		jump_to_next_cursor_location?: (
 			file?: TFile | null,
 			auto_jump?: boolean,
@@ -90,6 +91,41 @@ export function isTemplaterTriggerOnCreateEnabled(app: App): boolean {
 	return !!getTemplaterPlugin(app)?.settings?.trigger_on_file_creation;
 }
 
+export async function waitForTemplaterTriggerOnCreateToComplete(
+	app: App,
+	file: TFile,
+	opts: { timeoutMs?: number; appearTimeoutMs?: number } = {},
+): Promise<void> {
+	if (file.extension !== "md") return;
+	if (!isTemplaterTriggerOnCreateEnabled(app)) return;
+
+	const plugin = getTemplaterPlugin(app);
+	const pendingFiles = plugin?.templater?.files_with_pending_templates;
+	if (!(pendingFiles instanceof Set)) {
+		await waitForFileToStopChanging(app, file, {
+			timeoutMs: opts.timeoutMs ?? 5000,
+			gracePeriodMs: opts.appearTimeoutMs ?? 2500,
+			quietPeriodMs: 200,
+		});
+		return;
+	}
+
+	const { timeoutMs = 5000, appearTimeoutMs = 2500 } = opts;
+	const start = Date.now();
+
+	while (Date.now() - start < appearTimeoutMs) {
+		if (pendingFiles.has(file.path)) break;
+		await new Promise((r) => setTimeout(r, 50));
+	}
+
+	while (Date.now() - start < timeoutMs) {
+		if (!pendingFiles.has(file.path)) break;
+		await new Promise((r) => setTimeout(r, 50));
+	}
+
+	await waitForFileSettle(app, file, 800);
+}
+
 type TemplaterFileCreationSuppressionState = {
 	count: number;
 	hadPathInitially: boolean;
@@ -302,8 +338,9 @@ export async function overwriteTemplaterOnce(
 	if (file.extension !== "md") return;
 
 	const plugin = getTemplaterPlugin(app);
-	const overwrite = plugin?.templater?.overwrite_file_commands;
-	if (!plugin || typeof overwrite !== "function") return;
+	const templater = plugin?.templater;
+	const overwrite = templater?.overwrite_file_commands;
+	if (!plugin || !templater || typeof overwrite !== "function") return;
 
 	const { skipIfNoTags = true, postWait = true } = opts;
 
@@ -327,7 +364,8 @@ export async function overwriteTemplaterOnce(
 		}
 
 		try {
-			await overwrite(file);
+			// Preserve Templater's internal `this` context.
+			await overwrite.call(templater, file);
 			if (postWait) {
 				await waitForFileSettle(app, file, 800);
 			}
@@ -356,10 +394,14 @@ export async function templaterParseTemplate(
 	if (targetFile.extension !== "md") return templateContent;
 
 	const plugin = getTemplaterPlugin(app);
-	const parseTemplate = plugin?.templater?.parse_template;
-	if (!plugin || typeof parseTemplate !== "function") return templateContent;
-
-	return await parseTemplate(
+	const templater = plugin?.templater;
+	const parseTemplate = templater?.parse_template;
+	if (!plugin || !templater || typeof parseTemplate !== "function")
+		return templateContent;
+
+	// Preserve Templater's internal `this` context.
+	return await parseTemplate.call(
+		templater,
 		// `run_mode: 4` maps to Templater's internal `RunMode.DynamicProcessor`.
 		{ target_file: targetFile, run_mode: 4 },
 		templateContent,
@@ -375,20 +417,22 @@ export async function jumpToNextTemplaterCursorIfPossible(
 
 	const plugin = getTemplaterPlugin(app);
 	const autoJumpEnabled = !!plugin?.settings?.auto_jump_to_cursor;
-	const jump = plugin?.editor_handler?.jump_to_next_cursor_location;
+	const editorHandler = plugin?.editor_handler;
+	const jump = editorHandler?.jump_to_next_cursor_location;
 
 	if (!autoJumpEnabled) return;
 
 	if (typeof jump === "function") {
 		try {
-			await jump(file, true);
+			// Preserve Templater's internal `this` context.
+			await jump.call(editorHandler, file, true);
 			return;
 		} catch (err) {
 			log.logWarning(
 				`jumpToNextTemplaterCursorIfPossible: API failed – ${(err as Error).message}`,
 			);
-			}
 		}
+	}
 
 	try {
 		(