add new metadata API method for js engine

Author: mProjectsCode

exampleVault/Advanced Examples/Using JS Engine for Complex things.md

@@ -1,8 +1,8 @@
 ---
 text: abcasdas
 locked: true
-from_year: a2323
-to_year: 23423dss
+from_year: a22
+to_year: "23"
 ---
 
 Locked: `INPUT[toggle:locked]`
@@ -104,4 +104,15 @@ const subscriptionTo = mb.subscribeToMetadata(
 );
 
 return reactive;
+```
+
+```js-engine
+// Grab metabind API and extract metadata fields
+const mb     = engine.getPlugin('obsidian-meta-bind-plugin').api;
+const mbFrom = mb.parseBindTarget('from_year', context.file.path);
+const mbTo   = mb.parseBindTarget('to_year', context.file.path);
+
+return mb.renderOnChanges([mbFrom, mbTo], component, (from, to) => {
+	return [from, to]
+})
 ```

packages/core/bun.lockb

@@ -1,8 +1,5 @@
 {
 	"name": "meta-bind-core",
 	"main": "src/index.ts",
-	"dependencies": {
-		"@lemons_dev/parsinom": "^0.0.12",
-		"zod": "^3.22.4"
-	}
+	"dependencies": {}
 }

packages/core/package.json

@@ -134,6 +134,16 @@ export class MetadataManager {
 		return subscription;
 	}
 
+	/**
+	 * Subscribes a computed value to the metadata manager.
+	 *
+	 * @param uuid
+	 * @param callbackSignal The signal that will hold the computed value.
+	 * @param bindTarget The bind target that the computed value will be written to.
+	 * @param dependencies The dependencies of the computed value.
+	 * @param computeFunction The function that computes the value from the dependencies.
+	 * @param onDelete Called when the metadata manager wants to delete the subscription.
+	 */
 	public subscribeComputed(
 		uuid: string,
 		callbackSignal: Signal<unknown>,

packages/core/src/metadata/MetadataManager.ts

@@ -5,8 +5,6 @@
 		"@codemirror/language": "6.9.2",
 		"@codemirror/state": "6.3.1",
 		"@codemirror/view": "6.22.0",
-		"obsidian": "latest",
-		"@lemons_dev/parsinom": "^0.0.12",
-		"zod": "^3.22.4"
+		"obsidian": "latest"
 	}
 }

packages/obsidian/bun.lockb

@@ -1,18 +1,23 @@
 import { type Component } from 'obsidian';
 import type MetaBindPlugin from 'packages/obsidian/src/main';
 import { V_API_createTable } from 'packages/obsidian/src/APIValidators';
-import { API } from 'packages/core/src/api/API.js';
+import { API, type LifecycleHook } from 'packages/core/src/api/API.js';
 import { MetaBindTable } from 'packages/core/src/fields/metaBindTable/MetaBindTable';
 import { type BindTargetDeclaration } from 'packages/core/src/parsers/bindTargetParser/BindTargetDeclaration';
 import { type UnvalidatedInputFieldDeclaration } from 'packages/core/src/parsers/inputFieldParser/InputFieldDeclaration';
 import { type UnvalidatedViewFieldDeclaration } from 'packages/core/src/parsers/viewFieldParser/ViewFieldDeclaration';
 import { getUUID } from 'packages/core/src/utils/Utils';
-import { validateArgs } from 'packages/core/src/utils/ZodUtils';
+import { validate, validateArgs } 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 FieldBase } from 'packages/core/src/fields/FieldBase';
 import { type FieldType, isFieldTypeAllowedInline } from 'packages/core/src/config/FieldConfigs';
+import { z } from 'zod';
+import { V_BindTargetDeclaration } 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';
 
 export interface ComponentLike {
 	addChild(child: Component): void;
@@ -85,4 +90,57 @@ export class ObsidianAPI extends API<MetaBindPlugin> {
 			cause: `Invalid inline mdrc type "${mdrcType}"`,
 		});
 	}
+
+	/**
+	 * Creates a JS Engine reactive component that will re-render when the given bind targets change.
+	 *
+	 * This requires JS Engine to be installed and enabled!
+	 *
+	 * @param bindTargets
+	 * @param lifecycleHook
+	 * @param callback
+	 */
+	public reactiveMetadata(
+		bindTargets: BindTargetDeclaration[],
+		lifecycleHook: LifecycleHook,
+		callback: (...values: unknown[]) => Promise<unknown>,
+	): ReactiveComponent {
+		validate(
+			z.object({
+				bindTargets: V_BindTargetDeclaration.array(),
+				lifecycleHook: this.plugin.internal.getLifecycleHookValidator(),
+				callback: z.function(),
+			}),
+			{
+				bindTargets: bindTargets,
+				lifecycleHook: lifecycleHook,
+				callback: callback,
+			},
+		);
+
+		const jsEngine = getJsEnginePluginAPI(this.plugin);
+
+		const uuid = getUUID();
+		const signal = new Signal<unknown>(undefined);
+
+		const dependencies = bindTargets.map(bindTarget => ({
+			bindTarget: bindTarget,
+			callbackSignal: new Signal<unknown>(undefined),
+		}));
+
+		const subscription = this.plugin.metadataManager.subscribeComputed(
+			uuid,
+			signal,
+			undefined,
+			dependencies,
+			(values: unknown[]) => reactive.refresh(...values),
+			() => {},
+		);
+
+		lifecycleHook.register(() => subscription.unsubscribe());
+
+		const reactive = jsEngine.reactive(callback, ...dependencies.map(x => x.callbackSignal.get()));
+
+		return reactive;
+	}
 }

packages/obsidian/package.json

@@ -1,8 +1,6 @@
 {
 	"name": "meta-bind-publish",
 	"dependencies": {
-		"obsidian": "latest",
-		"@lemons_dev/parsinom": "^0.0.12",
-		"zod": "^3.22.4"
+		"obsidian": "latest"
 	}
 }