entropic-bond 1.53.5 → 1.53.7

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

@@ -1,5 +1,6 @@
 import { Persistent, PersistentObject, Collections, PersistentProperty } from '../persistent/persistent';
 import { ClassPropNames } from '../types/utility-types';
+import { Unsubscriber } from '../observable/observable';
 export type DocumentObject = PersistentObject<Persistent>;
 /**
  * The query operators
@@ -53,14 +54,16 @@ export type QueryObject<T> = {
     };
 };
 export type DocumentListenerUninstaller = () => void;
-export interface DocumentChange {
-    before: Persistent | undefined;
-    after: Persistent;
+export type DocumentChangeType = 'create' | 'update' | 'delete';
+export interface DocumentChange<T extends Persistent | DocumentObject> {
+    before: T | undefined;
+    after: T | undefined;
     params: {
         [key: string]: any;
     };
+    type: DocumentChangeType;
 }
-export type DocumentChangeListerner = (change: DocumentChange) => void;
+export type DocumentChangeListerner<T extends Persistent | DocumentObject> = (change: DocumentChange<T>) => void;
 export interface DocumentChangeListernerHandler {
     uninstall: DocumentListenerUninstaller;
     nativeHandler: unknown;
@@ -70,7 +73,7 @@ type CachedPropsUpdateCallback = (doc: Persistent, prop: PersistentProperty) =>
 export interface CachedPropsUpdaterConfig {
     onUpdate?: CachedPropsUpdateCallback;
     noThrowOnNonImplementedListener?: boolean;
-    documentChangeListerner?: (prop: PersistentProperty, listener: DocumentChangeListerner) => DocumentChangeListernerHandler | undefined;
+    documentChangeListerner?: (prop: PersistentProperty, listener: DocumentChangeListerner<Persistent>) => DocumentChangeListernerHandler | undefined;
 }
 interface PropWithOwner {
     prop: PersistentProperty;
@@ -95,7 +98,7 @@ export declare abstract class DataSource {
      * @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 subscribeToDocumentChangeListerner(collectionPathToListen: string, listener: DocumentChangeListerner): DocumentChangeListernerHandler | undefined;
+    protected subscribeToDocumentChangeListerner(collectionPathToListen: string, listener: DocumentChangeListerner<DocumentObject>): DocumentChangeListernerHandler | undefined;
     /**
      * Retrieves a document by id
      * Implement the required logic to retrieve a document by id from your concrete
@@ -155,6 +158,8 @@ export declare abstract class DataSource {
      * @see QueryObject
      */
     abstract count(queryObject: QueryObject<DocumentObject>, collectionName: string): Promise<number>;
+    abstract onCollectionChange(query: QueryObject<DocumentObject>, collectionName: string, listener: DocumentChangeListerner<DocumentObject>): Unsubscriber;
+    abstract onDocumentChange(documentPath: string, documentId: string, listener: DocumentChangeListerner<DocumentObject>): Unsubscriber;
     /**
      * Utility method to convert a query object to a property path query object
      *
@@ -170,7 +175,7 @@ export declare abstract class DataSource {
     static toPropertyPathOperations<T extends Persistent>(operations: QueryOperation<T>[]): QueryOperation<T>[];
     static isArrayOperator(operator: QueryOperator): boolean;
     private static toPropertyPathValue;
-    static onDocumentChange(event: DocumentChange, propsToUpdate: PropWithOwner[]): Promise<Promise<[Promise<void>[]]>[] | undefined>;
+    static onDocumentChange(event: DocumentChange<DocumentObject>, propsToUpdate: PropWithOwner[]): Promise<Promise<[Promise<void>[]]>[] | undefined>;
     private static onUpdate;
 }
 export {};

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

@@ -1,3 +1,4 @@
+import { Unsubscriber } from '../observable/observable';
 import { Collections, Persistent, PersistentObject } from '../persistent/persistent';
 import { DataSource, DocumentChangeListerner, DocumentChangeListernerHandler, DocumentObject, QueryObject } from './data-source';
 export interface JsonRawData {
@@ -40,6 +41,8 @@ export declare class JsonDataSource extends DataSource {
     delete(id: string, collectionName: string): Promise<void>;
     next(limit?: number): Promise<DocumentObject[]>;
     count(queryObject: QueryObject<DocumentObject>, collectionName: string): Promise<number>;
+    onCollectionChange(query: QueryObject<DocumentObject>, collectionName: string, listener: DocumentChangeListerner<DocumentObject>): Unsubscriber;
+    onDocumentChange(collectionName: string, documentId: string, listener: DocumentChangeListerner<DocumentObject>): Unsubscriber;
     /**
      * @returns the raw data store data as a JSON object
      */
@@ -51,7 +54,7 @@ export declare class JsonDataSource extends DataSource {
     wait(): Promise<any[]>;
     private incCursor;
     simulateError(error: string | ErrorOnOperation | undefined): this;
-    protected subscribeToDocumentChangeListerner(collectionNameToListen: string, listener: DocumentChangeListerner): DocumentChangeListernerHandler | undefined;
+    protected subscribeToDocumentChangeListerner(collectionNameToListen: string, listener: DocumentChangeListerner<DocumentObject>): DocumentChangeListernerHandler | undefined;
     private notifyChange;
     private decCursor;
     private queryProcessor;
@@ -67,5 +70,7 @@ export declare class JsonDataSource extends DataSource {
     private _simulateDelay;
     private _pendingPromises;
     private _simulateError;
-    private _listener;
+    private _documentListeners;
+    private _collectionListeners;
+    private _serverCollectionListeners;
 }

package/lib/store/model.d.ts

@@ -1,6 +1,7 @@
+import { Unsubscriber } from '../observable/observable';
 import { Persistent } from '../persistent/persistent';
 import { ClassPropNames, PropPath, PropPathType } from '../types/utility-types';
-import { DataSource, QueryOperator, QueryObject, QueryOrder } from './data-source';
+import { DataSource, QueryOperator, QueryObject, QueryOrder, DocumentChangeListerner } from './data-source';
 /**
  * Provides abstraction to the database access. You should gain access to a Model
  * object through the Store.getModel method instead of its constructor.
@@ -60,6 +61,9 @@ export declare class Model<T extends Persistent> {
      * @returns a promise resolving to a collection of matched documents
      */
     next<U extends T>(limit?: number): Promise<U[]>;
+    onDocumentChange(collectionPathToListen: string, documentId: string, listener: DocumentChangeListerner<T>): Unsubscriber;
+    onCollectionChange(query: Query<T>, listener: DocumentChangeListerner<T>): Unsubscriber;
+    private toPersistentChangeObject;
     private mapToInstance;
     /**
      * Normalizes the query object to match the data source requirements.
@@ -233,6 +237,7 @@ export declare class Query<T extends Persistent> {
      * const count = await query.where( 'name', '==', 'John' ).count()
      */
     count(): Promise<number>;
+    getQueryObject(): QueryObject<T>;
     private queryObject;
     private model;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "entropic-bond",
   "type": "module",
-  "version": "1.53.5",
+  "version": "1.53.7",
   "description": "Tidy up your messy components",
   "main": "./lib/entropic-bond.umd.cjs",
   "module": "./lib/entropic-bond.js",