more button actions

Author: mProjectsCode

exampleVault/Button Example.md

@@ -18,7 +18,7 @@ style: default
 label: Run Custom JS
 action:
   type: js
-  jsFile: testJsFile.js
+  file: testJsFile.js
 ```
 
 And open internal and external links
@@ -76,6 +76,65 @@ actions:
   - type: command
     command: workspace:new-tab
   - type: js
-    jsFile: "testJsFile.js"
+    file: "testJsFile.js"
+
+```
+
+
+## Button Types
+
+```meta-bind-button
+label: Input
+hidden: false
+id: ""
+style: default
+actions:
+  - type: command
+    command: command-palette:open
+  - type: input
+    str: help
+
+```
+
+```meta-bind-button
+label: Templater
+hidden: false
+id: ""
+style: default
+actions:
+  - type: templaterCreateNote
+    templateFile: "templates/templater/Templater Template.md"
+    fileName: Button Templater Test
+
+```
+
+```meta-bind-button
+label: Sleep
+hidden: false
+id: ""
+style: default
+actions:
+  - type: command
+    command: command-palette:open
+  - type: sleep
+    ms: 1000
+  - type: input
+    str: help
+
+```
+
+
+```meta-bind-button
+label: Show PF2e Examples with Delay
+hidden: false
+id: ""
+style: default
+actions:
+  - type: command
+    command: switcher:open
+  - type: sleep
+    ms: 500
+  - type: input
+    str: PF2e
 
 ```

exampleVault/New Syntax Playground.md

@@ -0,0 +1 @@
+<% tp.file.title %>

exampleVault/templates/templater/Templater Template.md

@@ -26,9 +26,10 @@ import { ViewFieldFactory } from '../fields/viewFields/ViewFieldFactory';
 import { getUUID } from '../utils/Utils';
 import { parsePropPath } from '../utils/prop/PropParser';
 import { RenderChildType } from '../config/FieldConfigs';
-import { ButtonActionRunner } from '../fields/button/ButtonActionRunner';
+import { type ButtonActionRunner } from '../fields/button/ButtonActionRunner';
 import { ButtonManager } from '../fields/button/ButtonManager';
 import { type BindTargetDeclaration, BindTargetStorageType } from '../parsers/BindTargetDeclaration';
+import { ObsidianButtonActionRunner } from '../fields/button/ObsidianButtonActionRunner';
 
 export class API implements IAPI {
 	public plugin: MetaBindPlugin;
@@ -56,7 +57,7 @@ export class API implements IAPI {
 		this.inputFieldFactory = new InputFieldFactory(this.plugin);
 		this.viewFieldFactory = new ViewFieldFactory(this.plugin);
 
-		this.buttonActionRunner = new ButtonActionRunner(this.plugin);
+		this.buttonActionRunner = new ObsidianButtonActionRunner(this.plugin);
 		this.buttonManager = new ButtonManager();
 	}
 

src/api/API.ts

@@ -1,12 +1,5 @@
-import { type RefinementCtx, z } from 'zod';
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function schemaForType<T>(): <S extends z.ZodType<T, any, any>>(arg: S) => S {
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	return function <S extends z.ZodType<T, any, any>>(arg: S): S {
-		return arg;
-	};
-}
+import { z } from 'zod';
+import { oneOf, schemaForType } from '../utils/ZodHelpers';
 
 export enum ButtonStyleType {
 	DEFAULT = 'default',
@@ -19,6 +12,10 @@ export enum ButtonActionType {
 	COMMAND = 'command',
 	JS = 'js',
 	OPEN = 'open',
+	INPUT = 'input',
+	SLEEP = 'sleep',
+	TEMPLATER_CREATE_NOTE = 'templaterCreateNote',
+	QUICK_SWITCHER = 'quickSwitcher',
 }
 
 export interface CommandButtonAction {
@@ -35,13 +32,13 @@ export const CommandButtonActionValidator = schemaForType<CommandButtonAction>()
 
 export interface JSButtonAction {
 	type: ButtonActionType.JS;
-	jsFile: string;
+	file: string;
 }
 
 export const JSButtonActionValidator = schemaForType<JSButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.JS),
-		jsFile: z.string(),
+		file: z.string(),
 	}),
 );
 
@@ -57,10 +54,79 @@ export const OpenButtonActionValidator = schemaForType<OpenButtonAction>()(
 	}),
 );
 
-export type ButtonAction = CommandButtonAction | JSButtonAction | OpenButtonAction;
+export interface InputButtonAction {
+	type: ButtonActionType.INPUT;
+	str: string;
+}
+
+export const InputButtonActionValidator = schemaForType<InputButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.INPUT),
+		str: z.string(),
+	}),
+);
+
+export interface SleepButtonAction {
+	type: ButtonActionType.SLEEP;
+	ms: number;
+}
+
+export const SleepButtonActionValidator = schemaForType<SleepButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.SLEEP),
+		ms: z.number(),
+	}),
+);
+
+export interface TemplaterCreateNoteButtonAction {
+	type: ButtonActionType.TEMPLATER_CREATE_NOTE;
+	templateFile: string;
+	folderPath?: string;
+	fileName?: string;
+	openNote?: boolean;
+}
+
+export const TemplaterCreateNoteButtonActionValidator = schemaForType<TemplaterCreateNoteButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.TEMPLATER_CREATE_NOTE),
+		templateFile: z.string(),
+		folderPath: z.string().optional(),
+		fileName: z.string().optional(),
+		openNote: z.boolean().optional(),
+	}),
+);
+
+export interface QuickSwitcherButtonAction {
+	type: ButtonActionType.QUICK_SWITCHER;
+	filter: string;
+}
+
+export const QuickSwitcherButtonActionValidator = schemaForType<QuickSwitcherButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.QUICK_SWITCHER),
+		filter: z.string(),
+	}),
+);
+
+export type ButtonAction =
+	| CommandButtonAction
+	| JSButtonAction
+	| OpenButtonAction
+	| InputButtonAction
+	| SleepButtonAction
+	| TemplaterCreateNoteButtonAction
+	| QuickSwitcherButtonAction;
 
 export const ButtonActionValidator = schemaForType<ButtonAction>()(
-	z.union([CommandButtonActionValidator, JSButtonActionValidator, OpenButtonActionValidator]),
+	z.union([
+		CommandButtonActionValidator,
+		JSButtonActionValidator,
+		OpenButtonActionValidator,
+		InputButtonActionValidator,
+		SleepButtonActionValidator,
+		TemplaterCreateNoteButtonActionValidator,
+		QuickSwitcherButtonActionValidator,
+	]),
 );
 
 export interface ButtonConfig {
@@ -75,25 +141,6 @@ export interface ButtonConfig {
 type Tuple<T> = [T, ...T[]];
 export const ButtonStyleValidator = z.enum(Object.values(ButtonStyleType) as Tuple<ButtonStyleType>);
 
-function oneOf<
-	A,
-	K1 extends Extract<keyof A, string>,
-	K2 extends Extract<keyof A, string>,
-	R extends A &
-		((Required<Pick<A, K1>> & { [P in K2]: undefined }) | (Required<Pick<A, K2>> & { [P in K1]: undefined })),
->(key1: K1, key2: K2): (arg: A, ctx: RefinementCtx) => arg is R {
-	return (arg, ctx): arg is R => {
-		if ((arg[key1] === undefined) === (arg[key2] === undefined)) {
-			ctx.addIssue({
-				code: z.ZodIssueCode.custom,
-				message: `Either ${key1} or ${key2} must be filled, but not both`,
-			});
-			return false;
-		}
-		return true;
-	};
-}
-
 export const ButtonConfigValidator = schemaForType<ButtonConfig>()(
 	z
 		.object({

src/config/ButtonConfig.ts

@@ -1,13 +1,17 @@
-import { type IPlugin } from '../../IPlugin';
 import {
 	type ButtonAction,
 	ButtonActionType,
 	type CommandButtonAction,
+	type InputButtonAction,
 	type JSButtonAction,
 	type OpenButtonAction,
+	type QuickSwitcherButtonAction,
+	type SleepButtonAction,
+	type TemplaterCreateNoteButtonAction,
 } from '../../config/ButtonConfig';
 import { MDLinkParser } from '../../parsers/MarkdownLinkParser';
 import { DocsHelper } from '../../utils/DocsHelper';
+import { type IPlugin } from '../../IPlugin';
 
 export class ButtonActionRunner {
 	plugin: IPlugin;
@@ -23,6 +27,14 @@ export class ButtonActionRunner {
 			await this.runJSAction(action, filePath);
 		} else if (action.type === ButtonActionType.OPEN) {
 			await this.runOpenAction(action, filePath);
+		} else if (action.type === ButtonActionType.INPUT) {
+			await this.runInputAction(action);
+		} else if (action.type === ButtonActionType.SLEEP) {
+			await this.runSleepAction(action);
+		} else if (action.type === ButtonActionType.TEMPLATER_CREATE_NOTE) {
+			await this.runTemplaterCreateNoteAction(action);
+		} else if (action.type === ButtonActionType.QUICK_SWITCHER) {
+			await this.runQuickSwitcherAction(action);
 		}
 	}
 
@@ -31,7 +43,7 @@ export class ButtonActionRunner {
 	}
 
 	async runJSAction(action: JSButtonAction, filePath: string): Promise<void> {
-		const unloadCallback = await this.plugin.internal.jsEngineRunFile(action.jsFile, filePath);
+		const unloadCallback = await this.plugin.internal.jsEngineRunFile(action.file, filePath);
 		unloadCallback();
 	}
 
@@ -44,4 +56,24 @@ export class ButtonActionRunner {
 			DocsHelper.open(link.target);
 		}
 	}
+
+	async runInputAction(action: InputButtonAction): Promise<void> {
+		const el = document.activeElement;
+		if (el && el instanceof HTMLInputElement) {
+			el.setRangeText(action.str, el.selectionStart!, el.selectionEnd!, 'end');
+			el.trigger('input');
+		}
+	}
+
+	async runSleepAction(action: SleepButtonAction): Promise<void> {
+		await new Promise(resolve => setTimeout(resolve, action.ms));
+	}
+
+	async runTemplaterCreateNoteAction(_action: TemplaterCreateNoteButtonAction): Promise<void> {
+		throw new Error('Not supported');
+	}
+
+	async runQuickSwitcherAction(_action: QuickSwitcherButtonAction): Promise<void> {
+		// TODO
+	}
 }