implement #477

Author: mProjectsCode

packages/core/src/api/API.ts

@@ -590,7 +590,7 @@ export abstract class API<Plugin extends IPlugin> {
 	}
 
 	/**
-	 * Checks if a string is any declaration and if yes returns the widget type.
+	 * Checks if a string is any declaration. If yes, it returns the widget type, otherwise undefined.
 	 *
 	 * @param str the declaration string
 	 */
@@ -635,7 +635,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 *
 	 * @param storageType the storage type (also named metadata source sometimes)
 	 * @param storagePath the storage path (usually the file path)
-	 * @param property the property path a.b.c = ['a', 'b', 'c']
+	 * @param property the property access path as an array. E.g. for the path `cache.a.b.c`, the array would be `['a', 'b', 'c']`.
 	 * @param listenToChildren whether to listen to children, only relevant for arrays and objects
 	 */
 	public createBindTarget(

packages/core/src/config/ButtonConfig.ts

@@ -123,6 +123,7 @@ export interface InsertIntoNoteButtonAction {
 export interface InlineJSButtonAction {
 	type: ButtonActionType.INLINE_JS;
 	code: string;
+	args?: Record<string, unknown>;
 }
 
 export type ButtonAction =

packages/core/src/config/validators/ButtonConfigValidators.ts

@@ -178,6 +178,7 @@ export const V_InlineJSButtonAction = schemaForType<InlineJSButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.INLINE_JS),
 		code: actionFieldString('inlineJS', 'code', 'code string to run'),
+		args: z.record(z.unknown()).optional(),
 	}),
 );
 

packages/core/src/fields/button/actions/InlineJSButtonActionConfig.ts

@@ -31,6 +31,7 @@ export class InlineJSButtonActionConfig extends AbstractButtonActionConfig<Inlin
 
 		const configOverrides: Record<string, unknown> = {
 			buttonConfig: structuredClone(config),
+			args: structuredClone(action.args),
 			buttonContext: structuredClone(context),
 			click: structuredClone(click),
 		};
@@ -42,6 +43,7 @@ export class InlineJSButtonActionConfig extends AbstractButtonActionConfig<Inlin
 		return {
 			type: ButtonActionType.INLINE_JS,
 			code: 'console.log("Hello world")',
+			args: {},
 		};
 	}