partial #206

Author: mProjectsCode

exampleVault/Replace Buttons.md

@@ -0,0 +1,104 @@
+### Two buttons that replace the same text
+
+some
+text
+wow
+
+```meta-bind-button
+label: Replace in Note
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "replaceInNote"
+  fromLine: 3
+  toLine: 5
+  replacement: "some\ntext\nwow"
+```
+
+```meta-bind-button
+label: Replace Other in Note
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "replaceInNote"
+  fromLine: 3
+  toLine: 5
+  replacement: "other\ntext\ntada"
+```
+
+### Inserting text into the file
+
+Insert below this line:
+
+```meta-bind-button
+label: Insert Text
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "insertIntoNote"
+  line: 38
+  value: "i am inserted"
+```
+
+```meta-bind-button
+label: Remove inserted lines
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "regexpReplaceInNote"
+  regexp: "Insert below this line:\n(i am inserted\n)+"
+  replacement: "Insert below this line:\n"
+```
+
+### A button replacing itself
+
+```meta-bind-button
+label: Replace Self
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "replaceSelf"
+  replacement: "i am no longer a button\n\nnice"
+```
+
+### A button reconstructing the button above with regexp replacement
+
+```meta-bind-button
+label: Recreate Button with Regexp
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "regexpReplaceInNote"
+  regexp: "i am no longer a button\\s+nice\n"
+  replacement: |
+    ```meta-bind-button
+    label: Replace Self
+    hidden: false
+    class: ""
+    tooltip: ""
+    id: ""
+    style: default
+    action:
+      type: "replaceSelf"
+      replacement: "i am no longer a button\n\nnice"
+    ```
+```
+

packages/core/src/api/API.ts

@@ -74,9 +74,15 @@ export interface InlineButtonOptions {
 
 export interface ButtonOptions {
 	declaration: ButtonConfig | string;
+	position: NotePosition | undefined;
 	isPreview: boolean;
 }
 
+export interface NotePosition {
+	lineStart: number;
+	lineEnd: number;
+}
+
 export interface EmbedOptions {
 	depth: number;
 	content: string;
@@ -344,7 +350,7 @@ export abstract class API<Plugin extends IPlugin> {
 			declaration = this.buttonParser.validateSimpleButtonConfig(options.declaration);
 		}
 
-		return new ButtonBase(this.plugin, uuid, filePath, declaration, options.isPreview);
+		return new ButtonBase(this.plugin, uuid, filePath, declaration, options.position, options.isPreview);
 	}
 
 	public createEmbedBase(filePath: string, options: EmbedOptions): EmbedBase {

packages/core/src/api/InternalAPI.ts

@@ -221,6 +221,8 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 	 */
 	abstract readFilePath(filePath: string): Promise<string>;
 
+	abstract writeFilePath(filePath: string, content: string): Promise<void>;
+
 	abstract createFile(folderPath: string, fileName: string, extension: string, open?: boolean): Promise<string>;
 
 	abstract createContextMenu(items: ContextMenuItemDefinition[]): IContextMenu;

packages/core/src/config/ButtonConfig.ts

@@ -14,6 +14,10 @@ export enum ButtonActionType {
 	TEMPLATER_CREATE_NOTE = 'templaterCreateNote',
 	UPDATE_METADATA = 'updateMetadata',
 	CREATE_NOTE = 'createNote',
+	REPLACE_IN_NOTE = 'replaceInNote',
+	REGEXP_REPLACE_IN_NOTE = 'regexpReplaceInNote',
+	REPLACE_SELF = 'replaceSelf',
+	INSERT_INTO_NOTE = 'insertIntoNote',
 }
 
 export interface CommandButtonAction {
@@ -65,6 +69,30 @@ export interface CreateNoteButtonAction {
 	openNote?: boolean;
 }
 
+export interface ReplaceInNoteButtonAction {
+	type: ButtonActionType.REPLACE_IN_NOTE;
+	fromLine: number;
+	toLine: number;
+	replacement: string;
+}
+
+export interface ReplaceSelfButtonAction {
+	type: ButtonActionType.REPLACE_SELF;
+	replacement: string;
+}
+
+export interface RegexpReplaceInNoteButtonAction {
+	type: ButtonActionType.REGEXP_REPLACE_IN_NOTE;
+	regexp: string;
+	replacement: string;
+}
+
+export interface InsertIntoNoteButtonAction {
+	type: ButtonActionType.INSERT_INTO_NOTE;
+	line: number;
+	value: string;
+}
+
 export type ButtonAction =
 	| CommandButtonAction
 	| JSButtonAction
@@ -73,7 +101,11 @@ export type ButtonAction =
 	| SleepButtonAction
 	| TemplaterCreateNoteButtonAction
 	| UpdateMetadataButtonAction
-	| CreateNoteButtonAction;
+	| CreateNoteButtonAction
+	| ReplaceInNoteButtonAction
+	| ReplaceSelfButtonAction
+	| RegexpReplaceInNoteButtonAction
+	| InsertIntoNoteButtonAction;
 
 export interface ButtonConfig {
 	label: string;

packages/core/src/config/ButtonConfigValidators.ts

@@ -7,10 +7,14 @@ import {
 	type CreateNoteButtonAction,
 	type InputButtonAction,
 	type JSButtonAction,
+	type ReplaceInNoteButtonAction,
 	type OpenButtonAction,
 	type SleepButtonAction,
 	type TemplaterCreateNoteButtonAction,
 	type UpdateMetadataButtonAction,
+	type ReplaceSelfButtonAction,
+	type RegexpReplaceInNoteButtonAction,
+	type InsertIntoNoteButtonAction,
 } from 'packages/core/src/config/ButtonConfig';
 import { oneOf, schemaForType } from 'packages/core/src/utils/ZodUtils';
 import { z } from 'zod';
@@ -79,6 +83,38 @@ export const V_CreateNoteButtonAction = schemaForType<CreateNoteButtonAction>()(
 	}),
 );
 
+export const V_ReplaceInNoteButtonAction = schemaForType<ReplaceInNoteButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.REPLACE_IN_NOTE),
+		fromLine: z.number(),
+		toLine: z.number(),
+		replacement: z.string(),
+	}),
+);
+
+export const V_ReplaceSelfButtonAction = schemaForType<ReplaceSelfButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.REPLACE_SELF),
+		replacement: z.string(),
+	}),
+);
+
+export const V_RegexpReplaceInNoteButtonAction = schemaForType<RegexpReplaceInNoteButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.REGEXP_REPLACE_IN_NOTE),
+		regexp: z.string(),
+		replacement: z.string(),
+	}),
+);
+
+export const V_InsertIntoNoteButtonAction = schemaForType<InsertIntoNoteButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.INSERT_INTO_NOTE),
+		line: z.number(),
+		value: z.string(),
+	}),
+);
+
 export const V_ButtonAction = schemaForType<ButtonAction>()(
 	z.union([
 		V_CommandButtonAction,
@@ -89,6 +125,10 @@ export const V_ButtonAction = schemaForType<ButtonAction>()(
 		V_TemplaterCreateNoteButtonAction,
 		V_UpdateMetadataButtonAction,
 		V_CreateNoteButtonAction,
+		V_ReplaceInNoteButtonAction,
+		V_ReplaceSelfButtonAction,
+		V_RegexpReplaceInNoteButtonAction,
+		V_InsertIntoNoteButtonAction,
 	]),
 );