add templater support for new button actions

mProjectsCode · mProjectsCode · commit d201262de9ae · 2024-03-16T14:17:03.000+01:00
diff --git a/exampleVault/Buttons/Button Example.md b/exampleVault/Buttons/Button Example.md
diff --git a/exampleVault/Buttons/Replace Buttons.md b/exampleVault/Buttons/Replace Buttons.md
@@ -101,4 +101,3 @@ action:
       replacement: "i am no longer a button\n\nnice"
     ```
 ```
-
diff --git a/exampleVault/Buttons/Templater Buttons.md b/exampleVault/Buttons/Templater Buttons.md
@@ -0,0 +1,18 @@
+Templater Buttons
+Templater Buttons
+Templater Buttons
+
+
+```meta-bind-button
+label: Insert Text
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "insertIntoNote"
+  line: 1
+  value: "templates/templater/Templater Template.md"
+  templater: true
+```
diff --git a/packages/core/src/api/InternalAPI.ts b/packages/core/src/api/InternalAPI.ts
@@ -238,6 +238,15 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 
 	abstract createContextMenu(items: ContextMenuItemDefinition[]): IContextMenu;
 
+	abstract evaluateTemplaterTemplate(templateFilePath: string, targetFilePath: string): Promise<string>;
+
+	abstract createNoteWithTemplater(
+		templateFilePath: string,
+		folderPath?: string,
+		fileName?: string,
+		openNote?: boolean,
+	): Promise<string | undefined>;
+
 	openCommandSelectModal(selectCallback: (selected: Command) => void): void {
 		this.createSearchModal(new CommandSelectModal(this.plugin, selectCallback)).open();
 	}
diff --git a/packages/core/src/config/ButtonConfig.ts b/packages/core/src/config/ButtonConfig.ts
@@ -74,11 +74,13 @@ export interface ReplaceInNoteButtonAction {
 	fromLine: number;
 	toLine: number;
 	replacement: string;
+	templater?: boolean;
 }
 
 export interface ReplaceSelfButtonAction {
 	type: ButtonActionType.REPLACE_SELF;
 	replacement: string;
+	templater?: boolean;
 }
 
 export interface RegexpReplaceInNoteButtonAction {
@@ -91,6 +93,7 @@ export interface InsertIntoNoteButtonAction {
 	type: ButtonActionType.INSERT_INTO_NOTE;
 	line: number;
 	value: string;
+	templater?: boolean;
 }
 
 export type ButtonAction =
diff --git a/packages/core/src/config/ButtonConfigValidators.ts b/packages/core/src/config/ButtonConfigValidators.ts
@@ -89,13 +89,15 @@ export const V_ReplaceInNoteButtonAction = schemaForType<ReplaceInNoteButtonActi
 		fromLine: z.number(),
 		toLine: z.number(),
 		replacement: z.string(),
+		templater: z.boolean().optional(),
 	}),
 );
 
 export const V_ReplaceSelfButtonAction = schemaForType<ReplaceSelfButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.REPLACE_SELF),
 		replacement: z.string(),
+		templater: z.boolean().optional(),
 	}),
 );
 
@@ -112,6 +114,7 @@ export const V_InsertIntoNoteButtonAction = schemaForType<InsertIntoNoteButtonAc
 		type: z.literal(ButtonActionType.INSERT_INTO_NOTE),
 		line: z.number(),
 		value: z.string(),
+		templater: z.boolean().optional(),
 	}),
 );
 
diff --git a/packages/core/src/fields/button/ButtonActionRunner.ts b/packages/core/src/fields/button/ButtonActionRunner.ts
@@ -237,8 +237,8 @@ export class ButtonActionRunner {
 		await new Promise(resolve => setTimeout(resolve, action.ms));
 	}
 
-	async runTemplaterCreateNoteAction(_action: TemplaterCreateNoteButtonAction): Promise<void> {
-		throw new Error('Not supported');
+	async runTemplaterCreateNoteAction(action: TemplaterCreateNoteButtonAction): Promise<void> {
+		await this.plugin.internal.createNoteWithTemplater(action.templateFile, action.folderPath, action.fileName);
 	}
 
 	async runUpdateMetadataAction(action: UpdateMetadataButtonAction, filePath: string): Promise<void> {
@@ -259,13 +259,17 @@ export class ButtonActionRunner {
 	}
 
 	async runReplaceInNoteAction(action: ReplaceInNoteButtonAction, filePath: string): Promise<void> {
+		const replacement = action.templater
+			? await this.plugin.internal.evaluateTemplaterTemplate(action.replacement, filePath)
+			: action.replacement;
+
 		const content = await this.plugin.internal.readFilePath(filePath);
 
 		let splitContent = content.split('\n');
 
 		splitContent = [
 			...splitContent.slice(0, action.fromLine - 1),
-			action.replacement,
+			replacement,
 			...splitContent.slice(action.toLine),
 		];
 
@@ -286,13 +290,17 @@ export class ButtonActionRunner {
 			throw new Error('Position of the button in the note is unknown');
 		}
 
+		const replacement = action.templater
+			? await this.plugin.internal.evaluateTemplaterTemplate(action.replacement, filePath)
+			: action.replacement;
+
 		const content = await this.plugin.internal.readFilePath(filePath);
 
 		let splitContent = content.split('\n');
 
 		splitContent = [
 			...splitContent.slice(0, position.lineStart),
-			action.replacement,
+			replacement,
 			...splitContent.slice(position.lineEnd + 1),
 		];
 
@@ -316,11 +324,11 @@ export class ButtonActionRunner {
 
 		let splitContent = content.split('\n');
 
-		splitContent = [
-			...splitContent.slice(0, action.line - 1),
-			action.value,
-			...splitContent.slice(action.line - 1),
-		];
+		const replacement = action.templater
+			? await this.plugin.internal.evaluateTemplaterTemplate(action.value, filePath)
+			: action.value;
+
+		splitContent = [...splitContent.slice(0, action.line - 1), replacement, ...splitContent.slice(action.line - 1)];
 
 		await this.plugin.internal.writeFilePath(filePath, splitContent.join('\n'));
 	}
diff --git a/packages/obsidian/extraTypes/Templater.d.ts b/packages/obsidian/extraTypes/Templater.d.ts
@@ -0,0 +1,30 @@
+import { Plugin, TFile, TFolder } from 'obsidian';
+import { Templater_RunMode } from 'packages/obsidian/src/ObsUtils';
+
+export type TemplaterPlugin = Plugin & {
+	templater: Templater;
+};
+
+export interface Templater {
+	create_running_config(
+		template_file: TFile | undefined,
+		target_file: TFile,
+		run_mode: Templater_RunMode,
+	): Templater_RunningConfig;
+
+	read_and_parse_template(config: Templater_RunningConfig): Promise<string>;
+
+	create_new_note_from_template(
+		template: TFile | string,
+		folder?: TFolder,
+		filename?: string,
+		open_new_note?: boolean,
+	): Promise<TFile | undefined>;
+}
+
+export interface Templater_RunningConfig {
+	template_file: TFile | undefined;
+	target_file: TFile;
+	run_mode: Templater_RunMode;
+	active_file?: TFile | null;
+}
diff --git a/packages/obsidian/src/ObsUtils.ts b/packages/obsidian/src/ObsUtils.ts
@@ -1,6 +1,7 @@
 import { type API as JsEngineAPI } from 'jsEngine/api/API';
 import type MetaBindPlugin from 'packages/obsidian/src/main';
 import { type DataviewApi } from 'obsidian-dataview';
+import { type Templater, type TemplaterPlugin } from 'packages/obsidian/extraTypes/Templater';
 
 export function getDataViewPluginAPI(plugin: MetaBindPlugin): DataviewApi {
 	/* eslint-disable */
@@ -13,3 +14,18 @@ export function getJsEnginePluginAPI(plugin: MetaBindPlugin): JsEngineAPI {
 	const jsEnginePlugin = plugin.dependencyManager.checkDependency('js-engine');
 	return (jsEnginePlugin as any).api as JsEngineAPI;
 }
+
+export enum Templater_RunMode {
+	CreateNewFromTemplate,
+	AppendActiveFile,
+	OverwriteFile,
+	OverwriteActiveFile,
+	DynamicProcessor,
+	StartupTemplate,
+}
+
+export function getTemplaterPluginAPI(plugin: MetaBindPlugin): Templater {
+	/* eslint-disable */
+	const templaterPlugin = plugin.dependencyManager.checkDependency('templater-obsidian');
+	return (templaterPlugin as TemplaterPlugin).templater;
+}
diff --git a/packages/obsidian/src/ObsidianAPI.ts b/packages/obsidian/src/ObsidianAPI.ts
@@ -9,7 +9,6 @@ import { type UnvalidatedViewFieldDeclaration } from 'packages/core/src/parsers/
 import { getUUID } from 'packages/core/src/utils/Utils';
 import { validateArgs } from 'packages/core/src/utils/ZodUtils';
 import { ErrorLevel, MetaBindInternalError } from 'packages/core/src/utils/errors/MetaBindErrors';
-import { ObsidianButtonActionRunner } from 'packages/obsidian/src/ObsidianButtonActionRunner';
 import { MarkdownRenderChildWidget } from 'packages/obsidian/src/cm6/Cm6_Widgets';
 import { FieldMDRC } from 'packages/obsidian/src/FieldMDRC';
 import { type FieldBase } from 'packages/core/src/fields/FieldBase';
@@ -24,9 +23,7 @@ export interface ComponentLike {
  */
 export class ObsidianAPI extends API<MetaBindPlugin> {
 	constructor(plugin: MetaBindPlugin) {
-		super(plugin, {
-			buttonActionRunner: new ObsidianButtonActionRunner(plugin),
-		});
+		super(plugin);
 	}
 
 	public wrapInMDRC(field: FieldBase, containerEl: HTMLElement, component: ComponentLike): FieldMDRC {
diff --git a/packages/obsidian/src/ObsidianButtonActionRunner.ts b/packages/obsidian/src/ObsidianButtonActionRunner.ts
diff --git a/packages/obsidian/src/ObsidianInternalAPI.ts b/packages/obsidian/src/ObsidianInternalAPI.ts
@@ -18,7 +18,7 @@ import {
 } from 'packages/core/src/fields/inputFields/fields/Suggester/SuggesterHelper';
 import { type IJsRenderer } from 'packages/core/src/utils/IJsRenderer';
 import { type MBLiteral } from 'packages/core/src/utils/Literal';
-import { getJsEnginePluginAPI } from 'packages/obsidian/src/ObsUtils';
+import { getJsEnginePluginAPI, getTemplaterPluginAPI, Templater_RunMode } from 'packages/obsidian/src/ObsUtils';
 import { ObsidianJsRenderer } from 'packages/obsidian/src/ObsidianJsRenderer';
 import type MetaBindPlugin from 'packages/obsidian/src/main';
 import { type ModalContent } from 'packages/core/src/modals/ModalContent';
@@ -220,4 +220,58 @@ export class ObsidianInternalAPI extends InternalAPI<MetaBindPlugin> {
 
 		return newFile.path;
 	}
+
+	public async evaluateTemplaterTemplate(templateFilePath: string, targetFilePath: string): Promise<string> {
+		const templaterAPI = getTemplaterPluginAPI(this.plugin);
+
+		const templateFile = this.app.vault.getAbstractFileByPath(templateFilePath);
+		if (!templateFile || !(templateFile instanceof TFile)) {
+			throw new Error(`Template file not found: ${templateFilePath}`);
+		}
+
+		const targetFile = this.app.vault.getAbstractFileByPath(targetFilePath);
+		if (!targetFile || !(targetFile instanceof TFile)) {
+			throw new Error(`Target file not found: ${targetFilePath}`);
+		}
+
+		const runningConfig = templaterAPI.create_running_config(
+			templateFile,
+			targetFile,
+			Templater_RunMode.DynamicProcessor,
+		);
+
+		return await templaterAPI.read_and_parse_template(runningConfig);
+	}
+
+	public async createNoteWithTemplater(
+		templateFilePath: string,
+		folderPath?: string,
+		fileName?: string,
+		openNote?: boolean,
+	): Promise<string | undefined> {
+		const templaterAPI = getTemplaterPluginAPI(this.plugin);
+
+		const templateFile = this.app.vault.getAbstractFileByPath(templateFilePath);
+		if (!templateFile || !(templateFile instanceof TFile)) {
+			throw new Error(`Template file not found: ${templateFilePath}`);
+		}
+
+		let folder: TFolder | undefined;
+
+		if (folderPath !== undefined) {
+			const folderTFile = this.app.vault.getAbstractFileByPath(folderPath);
+			if (!folderTFile || !(folderTFile instanceof TFolder)) {
+				throw new Error(`Folder not found: ${folderPath}`);
+			}
+			folder = folderTFile;
+		}
+
+		const newFile = await templaterAPI.create_new_note_from_template(
+			templateFile,
+			folder,
+			fileName,
+			openNote ?? true,
+		);
+		return newFile?.path;
+	}
 }
diff --git a/packages/obsidian/src/main.ts b/packages/obsidian/src/main.ts
@@ -72,6 +72,11 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 				pluginId: 'js-engine',
 				minVersion: new Version(0, 1, 0),
 			},
+			{
+				name: 'Templater',
+				pluginId: 'templater-obsidian',
+				minVersion: new Version(2, 2, 3),
+			},
 		]);
 		if (this.dependencyManager.checkDependenciesOnStartup()) {
 			return;
diff --git a/packages/publish/src/PublishInternalAPI.ts b/packages/publish/src/PublishInternalAPI.ts
@@ -116,4 +116,17 @@ export class PublishInternalAPI extends InternalAPI<MetaBindPublishPlugin> {
 	public createContextMenu(_items: ContextMenuItemDefinition[]): IContextMenu {
 		throw new Error('not implemented');
 	}
+
+	public createNoteWithTemplater(
+		_templateFilePath: string,
+		_folderPath?: string,
+		_fileName?: string,
+		_openNote?: boolean,
+	): Promise<string | undefined> {
+		throw new Error('not implemented');
+	}
+
+	public evaluateTemplaterTemplate(_templateFilePath: string, _targetFilePath: string): Promise<string> {
+		throw new Error('not implemented');
+	}
 }
diff --git a/tests/__mocks__/TestInternalAPI.ts b/tests/__mocks__/TestInternalAPI.ts
diff --git a/tests/fields/Button.test.ts b/tests/fields/Button.test.ts

-Original file line number
+Diff line change
       replacement: "i am no longer a button\n\nnice"
     ```
 ```
+-
Original file line number	Diff line number	Diff line change
`@@ -74,11 +74,13 @@ export interface ReplaceInNoteButtonAction {`
`74`	`74`	`fromLine: number;`
`75`	`75`	`toLine: number;`
`76`	`76`	`replacement: string;`
	`77`	`+ templater?: boolean;`
`77`	`78`	`}`
`78`	`79`
`79`	`80`	`export interface ReplaceSelfButtonAction {`
`80`	`81`	`type: ButtonActionType.REPLACE_SELF;`
`81`	`82`	`replacement: string;`
	`83`	`+ templater?: boolean;`
`82`	`84`	`}`
`83`	`85`
`84`	`86`	`export interface RegexpReplaceInNoteButtonAction {`
`@@ -91,6 +93,7 @@ export interface InsertIntoNoteButtonAction {`
`91`	`93`	`type: ButtonActionType.INSERT_INTO_NOTE;`
`92`	`94`	`line: number;`
`93`	`95`	`value: string;`
	`96`	`+ templater?: boolean;`
`94`	`97`	`}`
`95`	`98`
`96`	`99`	`export type ButtonAction =`