fix #242

Author: mProjectsCode

packages/core/src/api/InternalAPI.ts

@@ -95,11 +95,17 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 	 *
 	 * @param filePath
 	 * @param callingFilePath
+	 * @param configOverrides
 	 * @param container
 	 *
 	 * @returns Cleanup callback.
 	 */
-	abstract jsEngineRunFile(filePath: string, callingFilePath: string, container?: HTMLElement): Promise<() => void>;
+	abstract jsEngineRunFile(
+		filePath: string,
+		callingFilePath: string,
+		configOverrides: Record<string, unknown>,
+		container?: HTMLElement,
+	): Promise<() => void>;
 
 	/**
 	 * Run code using js engine.

packages/core/src/config/ButtonConfig.ts

@@ -23,6 +23,7 @@ export interface CommandButtonAction {
 export interface JSButtonAction {
 	type: ButtonActionType.JS;
 	file: string;
+	args?: Record<string, unknown>;
 }
 
 export interface OpenButtonAction {

packages/core/src/config/ButtonConfigValidators.ts

@@ -25,6 +25,7 @@ export const V_JSButtonAction = schemaForType<JSButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.JS),
 		file: z.string(),
+		args: z.record(z.unknown()).optional(),
 	}),
 );
 

packages/core/src/fields/button/ButtonActionRunner.ts

@@ -39,16 +39,16 @@ export class ButtonActionRunner {
 	 * Run the action(s) defined in the button config.
 	 * Will show a notice if an error occurs.
 	 *
-	 * @param buttonConfig
+	 * @param config
 	 * @param filePath
 	 */
-	async runButtonAction(buttonConfig: ButtonConfig, filePath: string): Promise<void> {
+	async runButtonAction(config: ButtonConfig, filePath: string): Promise<void> {
 		try {
-			if (buttonConfig.action) {
-				await this.plugin.api.buttonActionRunner.runAction(buttonConfig.action, filePath);
-			} else if (buttonConfig.actions) {
-				for (const action of buttonConfig.actions) {
-					await this.plugin.api.buttonActionRunner.runAction(action, filePath);
+			if (config.action) {
+				await this.plugin.api.buttonActionRunner.runAction(config, config.action, filePath);
+			} else if (config.actions) {
+				for (const action of config.actions) {
+					await this.plugin.api.buttonActionRunner.runAction(config, action, filePath);
 				}
 			} else {
 				console.warn('meta-bind | ButtonMDRC >> no action defined');
@@ -101,15 +101,16 @@ export class ButtonActionRunner {
 	 * Run a specific button action.
 	 * Will throw.
 	 *
+	 * @param config
 	 * @param action
 	 * @param filePath
 	 */
-	async runAction(action: ButtonAction, filePath: string): Promise<void> {
+	async runAction(config: ButtonConfig, action: ButtonAction, filePath: string): Promise<void> {
 		if (action.type === ButtonActionType.COMMAND) {
 			await this.runCommandAction(action);
 			return;
 		} else if (action.type === ButtonActionType.JS) {
-			await this.runJSAction(action, filePath);
+			await this.runJSAction(config, action, filePath);
 			return;
 		} else if (action.type === ButtonActionType.OPEN) {
 			await this.runOpenAction(action, filePath);
@@ -135,8 +136,12 @@ export class ButtonActionRunner {
 		this.plugin.internal.executeCommandById(action.command);
 	}
 
-	async runJSAction(action: JSButtonAction, filePath: string): Promise<void> {
-		const unloadCallback = await this.plugin.internal.jsEngineRunFile(action.file, filePath);
+	async runJSAction(config: ButtonConfig, action: JSButtonAction, filePath: string): Promise<void> {
+		const configOverrides: Record<string, unknown> = {
+			buttonConfig: config,
+			args: action.args,
+		};
+		const unloadCallback = await this.plugin.internal.jsEngineRunFile(action.file, filePath, configOverrides);
 		unloadCallback();
 	}
 

packages/obsidian/src/ObsidianInternalAPI.ts

@@ -70,6 +70,7 @@ export class ObsidianInternalAPI extends InternalAPI<MetaBindPlugin> {
 	public async jsEngineRunFile(
 		filePath: string,
 		callingFilePath: string,
+		contextOverrides: Record<string, unknown>,
 		container?: HTMLElement,
 	): Promise<() => void> {
 		const jsEngineAPI = getJsEnginePluginAPI(this.plugin);
@@ -89,6 +90,7 @@ export class ObsidianInternalAPI extends InternalAPI<MetaBindPlugin> {
 				file: callingFile,
 				line: 0,
 			},
+			contextOverrides: contextOverrides,
 		});
 
 		return () => component.unload();

packages/publish/src/PublishInternalAPI.ts

@@ -28,7 +28,12 @@ export class PublishInternalAPI extends InternalAPI<MetaBindPublishPlugin> {
 		return false;
 	}
 
-	public jsEngineRunFile(_filePath: string, _callingFilePath: string, _container?: HTMLElement): Promise<() => void> {
+	public jsEngineRunFile(
+		_filePath: string,
+		_callingFilePath: string,
+		_configOverrides: Record<string, unknown>,
+		_container?: HTMLElement,
+	): Promise<() => void> {
 		return Promise.reject(new Error('not implemented'));
 	}
 

tests/__mocks__/TestInternalAPI.ts

@@ -28,7 +28,12 @@ export class TestInternalAPI extends InternalAPI<TestPlugin> {
 		return false;
 	}
 
-	public jsEngineRunFile(_filePath: string, _callingFilePath: string, _container?: HTMLElement): Promise<() => void> {
+	public jsEngineRunFile(
+		_filePath: string,
+		_callingFilePath: string,
+		_contextOverrides: Record<string, unknown>,
+		_container?: HTMLElement,
+	): Promise<() => void> {
 		return Promise.resolve(() => {});
 	}