entropic-bond 1.51.0 → 1.51.2

package/lib/store/data-source.d.ts

@@ -59,6 +59,10 @@ interface DocumentChange {
     after: DocumentObject;
 }
 export type DocumentChangeListerner = (change: DocumentChange) => void;
+export interface DocumentChangeListernerHandler {
+    uninstall: DocumentListenerUninstaller;
+    nativeHandler: unknown;
+}
 /**
  * The data source interface.
  * It defines the methods that must be implemented by a data source
@@ -67,16 +71,17 @@ export type DocumentChangeListerner = (change: DocumentChange) => void;
  * A data source is used by the store to retrieve and save data.
  */
 export declare abstract class DataSource {
-    installReferencePersistentPropsUpdaters(onUpdate?: (doc: Persistent) => void, throwOnNonImplementedListener?: boolean): DocumentListenerUninstaller[];
+    installReferencePersistentPropsUpdaters(onUpdate?: (doc: Persistent) => void, throwOnNonImplementedListener?: boolean): DocumentChangeListernerHandler[];
     /**
      * Installs a document change listener
      * Implement the required logic to install a listener that will be called
      * when a document is changed in your concrete the data source
-     * @param documentPath the path of the document to be listened
-     * @param listener the callback to be called when the document is changed
-     * @returns a function that uninstalls the listener
+     * @param prop the property that has a reference to a persistent object
+     * @param listener the listener to be called when a document is changed
+     * @returns a function that uninstalls the listener. If the returned value is undefined
+     * the method documentChangeListerner has not been implemented in the concrete data source
      */
-    protected documentChangeListerner(prop: PersistentProperty, listener: DocumentChangeListerner): DocumentListenerUninstaller | undefined;
+    protected subscribeToDocumentChangeListerner(prop: PersistentProperty, listener: DocumentChangeListerner): DocumentChangeListernerHandler | undefined;
     /**
      * Retrieves a document by id
      * Implement the required logic to retrieve a document by id from your concrete

package/lib/store/json-data-source.d.ts

@@ -1,4 +1,4 @@
-import { DataSource, DocumentChangeListerner, DocumentListenerUninstaller, DocumentObject, QueryObject } from './data-source';
+import { DataSource, DocumentChangeListerner, DocumentChangeListernerHandler, DocumentObject, QueryObject } from './data-source';
 import { Collections, Persistent, PersistentObject, PersistentProperty } from '../persistent/persistent';
 
 export interface JsonRawData {
@@ -52,7 +52,7 @@ export declare class JsonDataSource extends DataSource {
     wait(): Promise<any[]>;
     private incCursor;
     simulateError(error: string | ErrorOnOperation | undefined): this;
-    protected documentChangeListerner(prop: PersistentProperty, listener: DocumentChangeListerner): DocumentListenerUninstaller | undefined;
+    protected subscribeToDocumentChangeListerner(prop: PersistentProperty, listener: DocumentChangeListerner): DocumentChangeListernerHandler | undefined;
     private notifyChange;
     private decCursor;
     private queryProcessor;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "entropic-bond",
   "type": "module",
-  "version": "1.51.0",
+  "version": "1.51.2",
   "description": "Tidy up your messy components",
   "main": "./lib/entropic-bond.umd.cjs",
   "module": "./lib/entropic-bond.js",
@@ -64,7 +64,7 @@
     "typedoc": "^0.25.13",
     "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.4.5",
-    "vite-plugin-dts": "^3.8.2",
+    "vite-plugin-dts": "^3.8.3",
     "vitest": "^1.5.0"
   },
   "dependencies": {