fix #576

Author: mProjectsCode

packages/core/src/api/API.ts

@@ -648,6 +648,12 @@ export abstract class API<Components extends MB_Comps> {
 	/**
 	 * Sets a property in meta binds metadata cache.
 	 *
+	 * @example
+	 * // Assumes you use the JS Engine plugin to run this.
+	 * const mb = engine.getPlugin("obsidian-meta-bind-plugin").api;
+	 * const bindTarget = mb.parseBindTarget("property", context.file.path);
+	 * mb.setMetadata(bindTarget, "some value");
+	 *
 	 * @param bindTarget
 	 * @param value
 	 */
@@ -668,6 +674,12 @@ export abstract class API<Components extends MB_Comps> {
 	 * Reads a property from meta binds metadata cache.
 	 * If the value is not present in the cache, it will check the underlying source. E.g. Obsidians metadata cache.
 	 *
+	 * @example
+	 * // Assumes you use the JS Engine plugin to run this.
+	 * const mb = engine.getPlugin("obsidian-meta-bind-plugin").api;
+	 * const bindTarget = mb.parseBindTarget("property", context.file.path);
+	 * const value = mb.getMetadata(bindTarget);
+	 *
 	 * @param bindTarget
 	 */
 	public getMetadata(bindTarget: BindTargetDeclaration): unknown {
@@ -686,6 +698,14 @@ export abstract class API<Components extends MB_Comps> {
 	/**
 	 * Updates a property in meta binds metadata cache.
 	 *
+	 * @example
+	 * // Assumes you use the JS Engine plugin to run this.
+	 * const mb = engine.getPlugin("obsidian-meta-bind-plugin").api;
+	 * const bindTarget = mb.parseBindTarget("property", context.file.path);
+	 * mb.updateMetadata(bindTarget, (value) => {
+	 *     return value + 1;
+	 * });
+	 *
 	 * @param bindTarget
 	 * @param updateFn a function that takes the current value and returns the new value
 	 */

packages/core/src/parsers/bindTargetParser/BindTargetParser.ts

@@ -41,10 +41,7 @@ export class BindTargetParser {
 		return {
 			storageType: toResultNode(declaration.storageType),
 			storagePath: toResultNode(declaration.storagePath),
-			storageProp: declaration.storageProp.path.map(x => ({
-				type: x.type,
-				prop: toResultNode(x.prop),
-			})),
+			storageProp: declaration.storageProp.path.map(x => x.toUnvalidatedPropAccess()),
 			listenToChildren: declaration.listenToChildren,
 		};
 	}

packages/core/src/parsers/inputFieldParser/InputFieldParser.ts

@@ -73,8 +73,6 @@ export class InputFieldParser implements ITemplateSupplier<UnvalidatedInputField
 	 * @param simpleDeclaration
 	 */
 	public fromSimpleDeclaration(simpleDeclaration: SimpleInputFieldDeclaration): UnvalidatedInputFieldDeclaration {
-		const errorCollection = new ErrorCollection('InputField');
-
 		return {
 			declarationString: undefined,
 			inputFieldType: toResultNode(simpleDeclaration.inputFieldType),
@@ -83,7 +81,7 @@ export class InputFieldParser implements ITemplateSupplier<UnvalidatedInputField
 				name: toResultNode(x.name),
 				value: x.value.map(y => toResultNode(y)),
 			})),
-			errorCollection: errorCollection,
+			errorCollection: new ErrorCollection('InputField'),
 		};
 	}
 

packages/core/src/utils/prop/PropAccess.ts

@@ -1,3 +1,5 @@
+import type { UnvalidatedPropAccess } from 'packages/core/src/parsers/bindTargetParser/BindTargetDeclaration';
+
 export enum PropAccessType {
 	OBJECT = 'object',
 	ARRAY = 'array',
@@ -87,4 +89,18 @@ export class PropAccess {
 			obj[this.index] = undefined;
 		}
 	}
+
+	toUnvalidatedPropAccess(): UnvalidatedPropAccess {
+		if (this.type === PropAccessType.OBJECT) {
+			return {
+				type: this.type,
+				prop: { value: this.prop },
+			};
+		} else {
+			return {
+				type: this.type,
+				prop: { value: this.index.toString() },
+			};
+		}
+	}
 }