fix #205

Author: mProjectsCode

exampleVault/Button Example.md

@@ -168,6 +168,21 @@ actions:
 
 ```
 
+```meta-bind-button
+label: Create new Note
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+actions:
+  - type: createNote
+    folderPath: templates
+    fileName: asdasd
+    openNote: false
+
+```
+
 ### Modifying Front-matter
 
 ```meta-bind-button

packages/core/src/api/InternalAPI.ts

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

packages/core/src/config/ButtonConfig.ts

@@ -13,6 +13,7 @@ export enum ButtonActionType {
 	SLEEP = 'sleep',
 	TEMPLATER_CREATE_NOTE = 'templaterCreateNote',
 	UPDATE_METADATA = 'updateMetadata',
+	CREATE_NOTE = 'createNote',
 }
 
 export interface CommandButtonAction {
@@ -57,14 +58,22 @@ export interface UpdateMetadataButtonAction {
 	value: string;
 }
 
+export interface CreateNoteButtonAction {
+	type: ButtonActionType.CREATE_NOTE;
+	folderPath?: string;
+	fileName: string;
+	openNote?: boolean;
+}
+
 export type ButtonAction =
 	| CommandButtonAction
 	| JSButtonAction
 	| OpenButtonAction
 	| InputButtonAction
 	| SleepButtonAction
 	| TemplaterCreateNoteButtonAction
-	| UpdateMetadataButtonAction;
+	| UpdateMetadataButtonAction
+	| CreateNoteButtonAction;
 
 export interface ButtonConfig {
 	label: string;

packages/core/src/config/ButtonConfigValidators.ts

@@ -4,6 +4,7 @@ import {
 	type ButtonConfig,
 	ButtonStyleType,
 	type CommandButtonAction,
+	type CreateNoteButtonAction,
 	type InputButtonAction,
 	type JSButtonAction,
 	type OpenButtonAction,
@@ -69,6 +70,15 @@ export const V_UpdateMetadataButtonAction = schemaForType<UpdateMetadataButtonAc
 	}),
 );
 
+export const V_CreateNoteButtonAction = schemaForType<CreateNoteButtonAction>()(
+	z.object({
+		type: z.literal(ButtonActionType.CREATE_NOTE),
+		folderPath: z.string().optional(),
+		fileName: z.string(),
+		openNote: z.boolean().optional(),
+	}),
+);
+
 export const V_ButtonAction = schemaForType<ButtonAction>()(
 	z.union([
 		V_CommandButtonAction,
@@ -78,6 +88,7 @@ export const V_ButtonAction = schemaForType<ButtonAction>()(
 		V_SleepButtonAction,
 		V_TemplaterCreateNoteButtonAction,
 		V_UpdateMetadataButtonAction,
+		V_CreateNoteButtonAction,
 	]),
 );
 

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

@@ -5,6 +5,7 @@ import {
 	type ButtonConfig,
 	ButtonStyleType,
 	type CommandButtonAction,
+	type CreateNoteButtonAction,
 	type InputButtonAction,
 	type JSButtonAction,
 	type OpenButtonAction,
@@ -14,7 +15,7 @@ import {
 } from 'packages/core/src/config/ButtonConfig';
 import { MDLinkParser } from 'packages/core/src/parsers/MarkdownLinkParser';
 import { Signal } from 'packages/core/src/utils/Signal';
-import { getUUID, openURL } from 'packages/core/src/utils/Utils';
+import { expectType, getUUID, openURL } from 'packages/core/src/utils/Utils';
 
 export class ButtonActionRunner {
 	plugin: IPlugin;
@@ -81,7 +82,7 @@ export class ButtonActionRunner {
 			return {
 				type: ButtonActionType.TEMPLATER_CREATE_NOTE,
 				templateFile: '',
-				folderPath: '',
+				folderPath: '/',
 				fileName: '',
 				openNote: true,
 			} satisfies TemplaterCreateNoteButtonAction;
@@ -92,8 +93,17 @@ export class ButtonActionRunner {
 				evaluate: false,
 				value: '',
 			} satisfies UpdateMetadataButtonAction;
+		} else if (type === ButtonActionType.CREATE_NOTE) {
+			return {
+				type: ButtonActionType.CREATE_NOTE,
+				folderPath: '/',
+				fileName: 'Untitled',
+				openNote: true,
+			} satisfies CreateNoteButtonAction;
 		}
 
+		expectType<never>(type);
+
 		throw new Error(`Unknown button action type: ${type}`);
 	}
 
@@ -127,8 +137,13 @@ export class ButtonActionRunner {
 		} else if (action.type === ButtonActionType.UPDATE_METADATA) {
 			await this.runUpdateMetadataAction(action, filePath);
 			return;
+		} else if (action.type === ButtonActionType.CREATE_NOTE) {
+			await this.runCreateNoteAction(action);
+			return;
 		}
 
+		expectType<never>(action);
+
 		throw new Error(`Unknown button action type`);
 	}
 
@@ -181,4 +196,8 @@ export class ButtonActionRunner {
 		});
 		subscription.unsubscribe();
 	}
+
+	async runCreateNoteAction(action: CreateNoteButtonAction): Promise<void> {
+		await this.plugin.internal.createFile(action.folderPath ?? '', action.fileName, 'md', action.openNote ?? false);
+	}
 }

packages/core/src/modals/modalContents/ButtonBuilderModalComponent.svelte

@@ -86,6 +86,17 @@
 		});
 	}
 
+	function createNoteActionChangeFolderPath(action: ButtonAction) {
+		if (action.type !== ButtonActionType.CREATE_NOTE) {
+			return;
+		}
+
+		plugin.internal.openFolderSelectModal((folder: string) => {
+			action.folderPath = folder;
+			buttonConfig.actions = buttonConfig.actions;
+		});
+	}
+
 	function getActionLabel(actionType: ButtonActionType): string {
 		if (actionType === ButtonActionType.COMMAND) {
 			return 'Run a Command';
@@ -101,6 +112,8 @@
 			return 'Create a New Note Using Templater';
 		} else if (actionType === ButtonActionType.UPDATE_METADATA) {
 			return 'Update Metadata';
+		} else if (actionType === ButtonActionType.CREATE_NOTE) {
+			return 'Create a New Note';
 		}
 
 		return 'CHANGE ME';
@@ -254,6 +267,27 @@ Add action of type
 			<Toggle bind:checked={action.evaluate}></Toggle>
 		</SettingComponent>
 	{/if}
+
+	{#if action.type === ButtonActionType.CREATE_NOTE}
+		<Button variant={ButtonStyleType.DESTRUCTIVE} on:click={() => removeAction(i)}>Remove Action</Button>
+
+		<SettingComponent
+			name="Folder: {action.folderPath || 'none'}"
+			description="The folder to create a new note in."
+		>
+			<Button variant={ButtonStyleType.PRIMARY} on:click={() => createNoteActionChangeFolderPath(action)}
+				>Change</Button
+			>
+		</SettingComponent>
+
+		<SettingComponent name="File Name: {action.fileName || 'default'}" description="The file name of the new note.">
+			<input type="text" bind:value={action.fileName} placeholder="some name" />
+		</SettingComponent>
+
+		<SettingComponent name="Open Note" description="Whether to open the new note after this action ran.">
+			<Toggle bind:checked={action.openNote}></Toggle>
+		</SettingComponent>
+	{/if}
 {/each}
 
 <h4>Preview</h4>

packages/core/src/utils/Utils.ts

@@ -250,3 +250,11 @@ export class DomHelpers {
 		el.innerHTML = '';
 	}
 }
+
+export function getFolderPathFromFilePath(filePath: string): string {
+	const pathSeparator = filePath.lastIndexOf('/');
+	if (pathSeparator === -1) {
+		return '';
+	}
+	return filePath.substring(0, pathSeparator);
+}

packages/obsidian/extraTypes/obsidian-ex.d.ts

@@ -70,6 +70,18 @@ declare module 'obsidian' {
 		disabled: boolean;
 		setWarning: (warning: boolean) => void;
 	}
+
+	interface Vault {
+		/**
+		 * @internal Get path for file that does not conflict with other existing files
+		 */
+		getAvailablePath(path: string, extension: string): string;
+
+		/**
+		 * Get an abstract file by path, insensitive to case
+		 */
+		getAbstractFileByPathInsensitive(path: string): TAbstractFile | null;
+	}
 }
 
 declare global {

packages/obsidian/src/ObsidianInternalAPI.ts

@@ -2,6 +2,7 @@ import {
 	type App,
 	Component,
 	MarkdownRenderer,
+	normalizePath,
 	Notice,
 	parseYaml,
 	setIcon,
@@ -199,4 +200,20 @@ export class ObsidianInternalAPI extends InternalAPI<MetaBindPlugin> {
 		menu.setItems(items);
 		return menu;
 	}
+
+	public async createFile(folderPath: string, fileName: string, extension: string, open?: boolean): Promise<string> {
+		const path = this.app.vault.getAvailablePath(normalizePath(folderPath + '/' + fileName), extension);
+		const newFile = await this.app.vault.create(path, '');
+
+		if (open) {
+			const activeLeaf = this.app.workspace.getLeaf(false);
+			if (activeLeaf) {
+				await activeLeaf.openFile(newFile, {
+					state: { mode: 'source' },
+				});
+			}
+		}
+
+		return newFile.path;
+	}
 }

packages/publish/src/PublishInternalAPI.ts

@@ -105,6 +105,10 @@ export class PublishInternalAPI extends InternalAPI<MetaBindPublishPlugin> {
 		return Promise.resolve('');
 	}
 
+	public createFile(_folderPath: string, _fileName: string, _extension: string, _open?: boolean): Promise<string> {
+		return Promise.resolve('');
+	}
+
 	public createContextMenu(_items: ContextMenuItemDefinition[]): IContextMenu {
 		throw new Error('not implemented');
 	}