@real1ty-obsidian-plugins/utils 2.26.0 → 2.27.0

package/dist/components/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./frontmatter-propagation-modal";
 export * from "./input-managers";
+export * from "./registered-events-component";
 export * from "./whats-new-modal";
 //# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC"}

package/dist/components/index.js

@@ -1,4 +1,5 @@
 export * from "./frontmatter-propagation-modal";
 export * from "./input-managers";
+export * from "./registered-events-component";
 export * from "./whats-new-modal";
 //# sourceMappingURL=index.js.map

package/dist/components/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC","sourcesContent":["export * from \"./frontmatter-propagation-modal\";\nexport * from \"./input-managers\";\nexport * from \"./whats-new-modal\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC","sourcesContent":["export * from \"./frontmatter-propagation-modal\";\nexport * from \"./input-managers\";\nexport * from \"./registered-events-component\";\nexport * from \"./whats-new-modal\";\n"]}

package/dist/components/registered-events-component.d.ts

@@ -0,0 +1,30 @@
+import type { EventRef } from "obsidian";
+/**
+ * Base class that provides event registration and automatic cleanup.
+ * Similar to ItemView's registerEvent/registerDomEvent pattern.
+ *
+ * Subclasses should call cleanupEvents() in their destroy/cleanup method.
+ */
+export declare abstract class RegisteredEventsComponent {
+    protected eventRefs: EventRef[];
+    protected eventCleanupFunctions: Array<() => void>;
+    /**
+     * Register an Obsidian event (workspace, vault, metadataCache, etc.)
+     * Event will be automatically cleaned up when destroy() is called
+     */
+    protected registerEvent<T extends keyof any>(emitter: {
+        on(event: T, callback: (...args: any[]) => void): void;
+        off(event: T, callback: (...args: any[]) => void): void;
+    }, event: T, callback: (...args: any[]) => void): void;
+    /**
+     * Register a DOM event (window, document, or element)
+     * Event will be automatically cleaned up when destroy() is called
+     */
+    protected registerDomEvent<K extends keyof WindowEventMap>(target: Window | Document | HTMLElement, event: K, callback: (evt: WindowEventMap[K]) => void): void;
+    /**
+     * Clean up all registered events.
+     * Should be called by subclass destroy() method.
+     */
+    protected cleanupEvents(): void;
+}
+//# sourceMappingURL=registered-events-component.d.ts.map

package/dist/components/registered-events-component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registered-events-component.d.ts","sourceRoot":"","sources":["../../src/components/registered-events-component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEzC;;;;;GAKG;AACH,8BAAsB,yBAAyB;IAC9C,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAM;IACrC,SAAS,CAAC,qBAAqB,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAM;IAExD;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,EAC1C,OAAO,EAAE;QACR,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;QACvD,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;KACxD,EACD,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAChC,IAAI;IAOP;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,CAAC,SAAS,MAAM,cAAc,EACxD,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,WAAW,EACvC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,GACxC,IAAI;IAOP;;;OAGG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI;CAM/B"}

package/dist/components/registered-events-component.js

@@ -0,0 +1,43 @@
+/**
+ * Base class that provides event registration and automatic cleanup.
+ * Similar to ItemView's registerEvent/registerDomEvent pattern.
+ *
+ * Subclasses should call cleanupEvents() in their destroy/cleanup method.
+ */
+export class RegisteredEventsComponent {
+    constructor() {
+        this.eventRefs = [];
+        this.eventCleanupFunctions = [];
+    }
+    /**
+     * Register an Obsidian event (workspace, vault, metadataCache, etc.)
+     * Event will be automatically cleaned up when destroy() is called
+     */
+    registerEvent(emitter, event, callback) {
+        emitter.on(event, callback);
+        this.eventCleanupFunctions.push(() => {
+            emitter.off(event, callback);
+        });
+    }
+    /**
+     * Register a DOM event (window, document, or element)
+     * Event will be automatically cleaned up when destroy() is called
+     */
+    registerDomEvent(target, event, callback) {
+        target.addEventListener(event, callback);
+        this.eventCleanupFunctions.push(() => {
+            target.removeEventListener(event, callback);
+        });
+    }
+    /**
+     * Clean up all registered events.
+     * Should be called by subclass destroy() method.
+     */
+    cleanupEvents() {
+        for (const cleanup of this.eventCleanupFunctions) {
+            cleanup();
+        }
+        this.eventCleanupFunctions = [];
+    }
+}
+//# sourceMappingURL=registered-events-component.js.map

package/dist/components/registered-events-component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registered-events-component.js","sourceRoot":"","sources":["../../src/components/registered-events-component.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,OAAgB,yBAAyB;IAA/C;QACW,cAAS,GAAe,EAAE,CAAC;QAC3B,0BAAqB,GAAsB,EAAE,CAAC;IA6CzD,CAAC;IA3CA;;;OAGG;IACO,aAAa,CACtB,OAGC,EACD,KAAQ,EACR,QAAkC;QAElC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC5B,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE;YACpC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,gBAAgB,CACzB,MAAuC,EACvC,KAAQ,EACR,QAA0C;QAE1C,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,QAAyB,CAAC,CAAC;QAC1D,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE;YACpC,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,QAAyB,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,aAAa;QACtB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAClD,OAAO,EAAE,CAAC;QACX,CAAC;QACD,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC;IACjC,CAAC;CACD","sourcesContent":["import type { EventRef } from \"obsidian\";\n\n/**\n * Base class that provides event registration and automatic cleanup.\n * Similar to ItemView's registerEvent/registerDomEvent pattern.\n *\n * Subclasses should call cleanupEvents() in their destroy/cleanup method.\n */\nexport abstract class RegisteredEventsComponent {\n\tprotected eventRefs: EventRef[] = [];\n\tprotected eventCleanupFunctions: Array<() => void> = [];\n\n\t/**\n\t * Register an Obsidian event (workspace, vault, metadataCache, etc.)\n\t * Event will be automatically cleaned up when destroy() is called\n\t */\n\tprotected registerEvent<T extends keyof any>(\n\t\temitter: {\n\t\t\ton(event: T, callback: (...args: any[]) => void): void;\n\t\t\toff(event: T, callback: (...args: any[]) => void): void;\n\t\t},\n\t\tevent: T,\n\t\tcallback: (...args: any[]) => void\n\t): void {\n\t\temitter.on(event, callback);\n\t\tthis.eventCleanupFunctions.push(() => {\n\t\t\temitter.off(event, callback);\n\t\t});\n\t}\n\n\t/**\n\t * Register a DOM event (window, document, or element)\n\t * Event will be automatically cleaned up when destroy() is called\n\t */\n\tprotected registerDomEvent<K extends keyof WindowEventMap>(\n\t\ttarget: Window | Document | HTMLElement,\n\t\tevent: K,\n\t\tcallback: (evt: WindowEventMap[K]) => void\n\t): void {\n\t\ttarget.addEventListener(event, callback as EventListener);\n\t\tthis.eventCleanupFunctions.push(() => {\n\t\t\ttarget.removeEventListener(event, callback as EventListener);\n\t\t});\n\t}\n\n\t/**\n\t * Clean up all registered events.\n\t * Should be called by subclass destroy() method.\n\t */\n\tprotected cleanupEvents(): void {\n\t\tfor (const cleanup of this.eventCleanupFunctions) {\n\t\t\tcleanup();\n\t\t}\n\t\tthis.eventCleanupFunctions = [];\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real1ty-obsidian-plugins/utils",
-  "version": "2.26.0",
+  "version": "2.27.0",
   "description": "Shared utilities for Obsidian plugins",
   "type": "module",
   "main": "./dist/index.js",

package/src/components/index.ts

@@ -1,3 +1,4 @@
 export * from "./frontmatter-propagation-modal";
 export * from "./input-managers";
+export * from "./registered-events-component";
 export * from "./whats-new-modal";

package/src/components/registered-events-component.ts

@@ -0,0 +1,56 @@
+import type { EventRef } from "obsidian";
+
+/**
+ * Base class that provides event registration and automatic cleanup.
+ * Similar to ItemView's registerEvent/registerDomEvent pattern.
+ *
+ * Subclasses should call cleanupEvents() in their destroy/cleanup method.
+ */
+export abstract class RegisteredEventsComponent {
+	protected eventRefs: EventRef[] = [];
+	protected eventCleanupFunctions: Array<() => void> = [];
+
+	/**
+	 * Register an Obsidian event (workspace, vault, metadataCache, etc.)
+	 * Event will be automatically cleaned up when destroy() is called
+	 */
+	protected registerEvent<T extends keyof any>(
+		emitter: {
+			on(event: T, callback: (...args: any[]) => void): void;
+			off(event: T, callback: (...args: any[]) => void): void;
+		},
+		event: T,
+		callback: (...args: any[]) => void
+	): void {
+		emitter.on(event, callback);
+		this.eventCleanupFunctions.push(() => {
+			emitter.off(event, callback);
+		});
+	}
+
+	/**
+	 * Register a DOM event (window, document, or element)
+	 * Event will be automatically cleaned up when destroy() is called
+	 */
+	protected registerDomEvent<K extends keyof WindowEventMap>(
+		target: Window | Document | HTMLElement,
+		event: K,
+		callback: (evt: WindowEventMap[K]) => void
+	): void {
+		target.addEventListener(event, callback as EventListener);
+		this.eventCleanupFunctions.push(() => {
+			target.removeEventListener(event, callback as EventListener);
+		});
+	}
+
+	/**
+	 * Clean up all registered events.
+	 * Should be called by subclass destroy() method.
+	 */
+	protected cleanupEvents(): void {
+		for (const cleanup of this.eventCleanupFunctions) {
+			cleanup();
+		}
+		this.eventCleanupFunctions = [];
+	}
+}