some internal changes

mProjectsCode · mProjectsCode · commit a222b008a7c6 · 2024-04-08T23:58:01.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Obsidian Meta Bind Changelog
 
+# 1.0.4
+
+Changes
+
+-   Slightly improved the syncing algorithm and reduced the amount of unnecessary updates
+
+Bug Fixes
+
+-   Fixed some issues with the `replaceSelf` button action not replacing the correct lines when the button was moved by some change in the part of the note above the button
+-   Fixed some unusable API functions for creating meta bind tables, as the required arguments weren't possible to create just using the API
+
 # 1.0.3
 
 Bug Fixes
diff --git a/packages/core/src/IPlugin.ts b/packages/core/src/IPlugin.ts
@@ -2,11 +2,13 @@ import { type MetaBindPluginSettings } from 'packages/core/src/Settings';
 import { type API } from 'packages/core/src/api/API';
 import { type InternalAPI } from 'packages/core/src/api/InternalAPI';
 import { type MetadataManager } from 'packages/core/src/metadata/MetadataManager';
+import { type MountableManager } from 'packages/core/src/MountableManager';
 
 export interface IPlugin {
 	readonly api: API<IPlugin>;
 	readonly internal: InternalAPI<IPlugin>;
 	readonly metadataManager: MetadataManager;
+	readonly mountableManager: MountableManager;
 
 	settings: MetaBindPluginSettings;
 }
diff --git a/packages/core/src/MountableManager.ts b/packages/core/src/MountableManager.ts
@@ -0,0 +1,35 @@
+import { type FieldMountable } from 'packages/core/src/fields/FieldMountable';
+
+export class MountableManager {
+	activeMountables: Map<string, FieldMountable>;
+
+	constructor() {
+		this.activeMountables = new Map<string, FieldMountable>();
+	}
+
+	unloadFile(filePath: string): void {
+		for (const mountable of this.activeMountables.values()) {
+			if (mountable.getFilePath() === filePath) {
+				console.debug(`meta-bind | MountableManager >> unregistered Mountable ${mountable.getUuid()}`);
+				mountable.unmount();
+			}
+		}
+	}
+
+	unload(): void {
+		for (const mountable of this.activeMountables.values()) {
+			console.debug(`meta-bind | MountableManager >> unregistered Mountable ${mountable.getUuid()}`);
+			mountable.unmount();
+		}
+	}
+
+	registerMountable(mountable: FieldMountable): void {
+		console.debug(`meta-bind | MountableManager >> registered Mountable ${mountable.getUuid()}`);
+		this.activeMountables.set(mountable.getUuid(), mountable);
+	}
+
+	unregisterMountable(mountable: FieldMountable): void {
+		console.debug(`meta-bind | MountableManager >> unregistered Mountable ${mountable.getUuid()}`);
+		this.activeMountables.delete(mountable.getUuid());
+	}
+}
diff --git a/packages/core/src/api/Validators.ts b/packages/core/src/api/Validators.ts
@@ -43,6 +43,7 @@ import {
 	type UnvalidatedFieldArgument,
 } from 'packages/core/src/parsers/nomParsers/FieldArgumentNomParsers';
 import { FieldMountable } from 'packages/core/src/fields/FieldMountable';
+import { Mountable } from 'packages/core/src/utils/Mountable';
 
 export const V_FilePath = schemaForType<string>()(z.string());
 
@@ -61,6 +62,7 @@ export const V_Signal = schemaForType<Signal<unknown>>()(z.instanceof(Signal));
 export const V_VoidFunction = schemaForType<() => void>()(z.function().args().returns(z.void()));
 
 export const V_FieldMountable = schemaForType<FieldMountable>()(z.instanceof(FieldMountable));
+export const V_Mountable = schemaForType<Mountable>()(z.instanceof(Mountable));
 
 export const V_NotePosition = schemaForType<NotePosition>()(z.instanceof(NotePosition));
 
diff --git a/packages/core/src/fields/FieldMountable.ts b/packages/core/src/fields/FieldMountable.ts
@@ -21,4 +21,12 @@ export abstract class FieldMountable extends Mountable {
 	getFilePath(): string {
 		return this.filePath;
 	}
+
+	protected onMount(_targetEl: HTMLElement): void {
+		this.plugin.mountableManager.registerMountable(this);
+	}
+
+	protected onUnmount(_targetEl: HTMLElement): void {
+		this.plugin.mountableManager.unregisterMountable(this);
+	}
 }
diff --git a/packages/core/src/fields/button/ButtonGroupMountable.ts b/packages/core/src/fields/button/ButtonGroupMountable.ts
@@ -36,6 +36,7 @@ export class ButtonGroupMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ButtonGroupMountable >> mount', this.declaration);
+		super.onMount(targetEl);
 
 		DomHelpers.removeAllClasses(targetEl);
 
@@ -63,6 +64,7 @@ export class ButtonGroupMountable extends FieldMountable {
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ButtonGroupMountable >> destroy', this.declaration);
+		super.onUnmount(targetEl);
 
 		this.buttonField?.unmount();
 
diff --git a/packages/core/src/fields/button/ButtonMountable.ts b/packages/core/src/fields/button/ButtonMountable.ts
@@ -33,6 +33,7 @@ export class ButtonMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ButtonMountable >> mount', this.declaration.declarationString);
+		super.onMount(targetEl);
 
 		DomHelpers.removeAllClasses(targetEl);
 
@@ -61,6 +62,7 @@ export class ButtonMountable extends FieldMountable {
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ButtonMountable >> destroy', this.declaration.declarationString);
+		super.onUnmount(targetEl);
 
 		this.buttonField?.unmount();
 
diff --git a/packages/core/src/fields/embed/EmbedMountable.ts b/packages/core/src/fields/embed/EmbedMountable.ts
@@ -92,12 +92,14 @@ export class EmbedMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | EmbedMountable >> mount', this.content);
+		super.onMount(targetEl);
 
 		void this.renderContent(targetEl);
 	}
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | EmbedMountable >> unmount', this.content);
+		super.onUnmount(targetEl);
 
 		this.markdownUnloadCallback?.();
 
diff --git a/packages/core/src/fields/excluded/ExcludedMountable.ts b/packages/core/src/fields/excluded/ExcludedMountable.ts
@@ -9,6 +9,7 @@ export class ExcludedMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ExcludedMountable >> mount');
+		super.onMount(targetEl);
 
 		DomHelpers.empty(targetEl);
 
@@ -20,6 +21,7 @@ export class ExcludedMountable extends FieldMountable {
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ExcludedMountable >> unmount');
+		super.onUnmount(targetEl);
 
 		DomHelpers.empty(targetEl);
 
diff --git a/packages/core/src/fields/inputFields/InputFieldMountable.ts b/packages/core/src/fields/inputFields/InputFieldMountable.ts
@@ -132,6 +132,7 @@ export class InputFieldMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | InputFieldMountable >> mount', this.declaration);
+		super.onMount(targetEl);
 
 		DomHelpers.empty(targetEl);
 		DomHelpers.addClass(targetEl, 'mb-input');
@@ -168,6 +169,7 @@ export class InputFieldMountable extends FieldMountable {
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | InputFieldMountable >> unmount', this.declaration);
+		super.onUnmount(targetEl);
 
 		this.inputField?.destroy();
 
diff --git a/packages/core/src/fields/metaBindTable/TableMountable.ts b/packages/core/src/fields/metaBindTable/TableMountable.ts
@@ -180,6 +180,8 @@ export class TableMountable extends FieldMountable {
 	}
 
 	protected onMount(targetEl: HTMLElement): void {
+		super.onMount(targetEl);
+
 		this.tableComponent = new MetaBindTableComponent({
 			target: targetEl,
 			props: {
@@ -199,6 +201,8 @@ export class TableMountable extends FieldMountable {
 	}
 
 	protected onUnmount(targetEl: HTMLElement): void {
+		super.onUnmount(targetEl);
+
 		this.unregisterSelfFromMetadataManager();
 		this.tableComponent?.$destroy();
 
diff --git a/packages/core/src/fields/viewFields/JsViewFieldMountable.ts b/packages/core/src/fields/viewFields/JsViewFieldMountable.ts
@@ -108,6 +108,7 @@ export class JsViewFieldMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | JsViewFieldMountable >> mount', this.declaration);
+		super.onMount(targetEl);
 
 		DomHelpers.addClass(targetEl, 'mb-view');
 		DomHelpers.empty(targetEl);
@@ -148,6 +149,7 @@ export class JsViewFieldMountable extends FieldMountable {
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | JsViewFieldMountable >> unmount', this.declaration);
+		super.onUnmount(targetEl);
 
 		this.unregisterSelfFromMetadataManager();
 
diff --git a/packages/core/src/fields/viewFields/ViewFieldMountable.ts b/packages/core/src/fields/viewFields/ViewFieldMountable.ts
@@ -90,6 +90,7 @@ export class ViewFieldMountable extends FieldMountable {
 
 	protected onMount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ViewFieldMountable >> mount', this.declaration);
+		super.onMount(targetEl);
 
 		DomHelpers.empty(targetEl);
 		DomHelpers.addClass(targetEl, 'mb-view');
@@ -129,6 +130,7 @@ export class ViewFieldMountable extends FieldMountable {
 
 	protected onUnmount(targetEl: HTMLElement): void {
 		console.debug('meta-bind | ViewFieldMountable >> unmount', this.declaration);
+		super.onUnmount(targetEl);
 
 		this.viewField?.unmount();
 
diff --git a/packages/obsidian/src/FieldMDRC.ts b/packages/obsidian/src/FieldMDRC.ts
diff --git a/packages/obsidian/src/MDRCManager.ts b/packages/obsidian/src/MDRCManager.ts
diff --git a/packages/obsidian/src/MountableMDRC.ts b/packages/obsidian/src/MountableMDRC.ts
@@ -0,0 +1,34 @@
+import type MetaBindPlugin from 'packages/obsidian/src/main.ts';
+import { MarkdownRenderChild } from 'obsidian';
+import { type Mountable } from 'packages/core/src/utils/Mountable';
+
+export class MountableMDRC extends MarkdownRenderChild {
+	readonly plugin: MetaBindPlugin;
+	readonly mountable: Mountable;
+
+	constructor(plugin: MetaBindPlugin, mountable: Mountable, containerEl: HTMLElement) {
+		super(containerEl);
+
+		this.plugin = plugin;
+		this.mountable = mountable;
+
+		this.mountable.registerUnmountCb(() => {
+			this.unload();
+		});
+	}
+
+	onload(): void {
+		this.mountable.mount(this.containerEl);
+
+		super.onload();
+	}
+
+	onunload(): void {
+		// prevent double unmounting in some cases
+		if (this.mountable.isMounted()) {
+			this.mountable.unmount();
+		}
+
+		super.onunload();
+	}
+}
diff --git a/packages/obsidian/src/ObsidianAPI.ts b/packages/obsidian/src/ObsidianAPI.ts
@@ -6,14 +6,14 @@ import { getUUID } from 'packages/core/src/utils/Utils';
 import { validate } from 'packages/core/src/utils/ZodUtils';
 import { ErrorLevel, MetaBindInternalError } from 'packages/core/src/utils/errors/MetaBindErrors';
 import { MarkdownRenderChildWidget } from 'packages/obsidian/src/cm6/Cm6_Widgets';
-import { FieldMDRC } from 'packages/obsidian/src/FieldMDRC';
-import { type FieldMountable } from 'packages/core/src/fields/FieldMountable';
+import { MountableMDRC } from 'packages/obsidian/src/MountableMDRC';
 import { type FieldType, isFieldTypeAllowedInline } from 'packages/core/src/config/FieldConfigs';
 import { z } from 'zod';
-import { V_BindTargetDeclaration, V_FieldMountable, V_HTMLElement } from 'packages/core/src/api/Validators';
+import { V_BindTargetDeclaration, V_HTMLElement, V_Mountable } from 'packages/core/src/api/Validators';
 import { Signal } from 'packages/core/src/utils/Signal';
 import { getJsEnginePluginAPI } from 'packages/obsidian/src/ObsUtils';
 import { type ReactiveComponent } from 'jsEngine/api/reactive/ReactiveComponent';
+import { type Mountable } from 'packages/core/src/utils/Mountable';
 
 export interface ComponentLike {
 	addChild(child: Component): void;
@@ -32,10 +32,10 @@ export class ObsidianAPI extends API<MetaBindPlugin> {
 		super(plugin);
 	}
 
-	public wrapInMDRC(field: FieldMountable, containerEl: HTMLElement, component: ComponentLike): FieldMDRC {
+	public wrapInMDRC(field: Mountable, containerEl: HTMLElement, component: ComponentLike): MountableMDRC {
 		validate(
 			z.object({
-				field: V_FieldMountable,
+				field: V_Mountable,
 				containerEl: V_HTMLElement,
 				component: V_ComponentLike,
 			}),
@@ -46,7 +46,7 @@ export class ObsidianAPI extends API<MetaBindPlugin> {
 			},
 		);
 
-		const mdrc = new FieldMDRC(this.plugin, field, containerEl);
+		const mdrc = new MountableMDRC(this.plugin, field, containerEl);
 		component.addChild(mdrc);
 
 		return mdrc;
diff --git a/packages/obsidian/src/cm6/Cm6_Widgets.ts b/packages/obsidian/src/cm6/Cm6_Widgets.ts
@@ -1,7 +1,7 @@
 import { type EditorView, WidgetType } from '@codemirror/view';
 import { type Component } from 'obsidian';
 import type MetaBindPlugin from 'packages/obsidian/src/main';
-import { type FieldMDRC } from 'packages/obsidian/src/FieldMDRC';
+import { type MountableMDRC } from 'packages/obsidian/src/MountableMDRC';
 import { type InlineFieldType } from 'packages/core/src/config/FieldConfigs';
 
 export class MarkdownRenderChildWidget extends WidgetType {
@@ -10,7 +10,7 @@ export class MarkdownRenderChildWidget extends WidgetType {
 	filePath: string;
 	parentComponent: Component;
 	plugin: MetaBindPlugin;
-	renderChild?: FieldMDRC;
+	renderChild?: MountableMDRC;
 
 	constructor(
 		type: InlineFieldType,
diff --git a/packages/obsidian/src/main.ts b/packages/obsidian/src/main.ts
diff --git a/packages/obsidian/src/modals/TextPromptModal.ts b/packages/obsidian/src/modals/TextPromptModal.ts
diff --git a/packages/publish/src/PublishAPI.ts b/packages/publish/src/PublishAPI.ts
diff --git a/packages/publish/src/PublishFieldMDRC.ts b/packages/publish/src/PublishFieldMDRC.ts
diff --git a/packages/publish/src/main.ts b/packages/publish/src/main.ts
diff --git a/tests/__mocks__/TestPlugin.ts b/tests/__mocks__/TestPlugin.ts

Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,12 @@ export abstract class FieldMountable extends Mountable {`
`21`	`21`	`getFilePath(): string {`
`22`	`22`	`return this.filePath;`
`23`	`23`	`}`
	`24`	`+`
	`25`	`+ protected onMount(_targetEl: HTMLElement): void {`
	`26`	`+ this.plugin.mountableManager.registerMountable(this);`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ protected onUnmount(_targetEl: HTMLElement): void {`
	`30`	`+ this.plugin.mountableManager.unregisterMountable(this);`
	`31`	`+ }`
`24`	`32`	`}`