entropic-bond 1.50.4 → 1.51.0

package/lib/persistent/entropic-component.d.ts

@@ -1,6 +1,7 @@
-import { Callback, Unsubscriber } from '../observable/observable';
-import { ClassArrayPropNames, ClassProps, Elements } from '../types/utility-types';
 import { Persistent } from './persistent';
+import { ClassArrayPropNames, ClassProps, Elements } from '../types/utility-types';
+import { Callback, Unsubscriber } from '../observable/observable';
+
 export type PropChangeEvent<T> = Partial<ClassProps<T>>;
 export type PropChangeCallback<T> = Callback<PropChangeEvent<T>>;
 type ArrayPropsElem<T> = Elements<T[ClassArrayPropNames<T>]>;

package/lib/persistent/persistent.d.ts

@@ -1,4 +1,5 @@
 import { ClassPropNames, SomeClassProps, UnderscoredProp } from '../types/utility-types';
+
 export type PersistentConstructor = new () => Persistent;
 /**
  * The corresponding type of the plain object of a persistent class.
@@ -168,6 +169,7 @@ export declare class Persistent {
     static searchableArrayNameFor(propName: string): string;
     private fromDeepObject;
     private toDeepObj;
+    static collectionPath(ownerInstance: Persistent, prop: PersistentProperty): string;
     private toReferenceObj;
     private buildRefObject;
     private pushDocument;
@@ -181,7 +183,7 @@ export declare class Persistent {
 }
 type CollectionPathCallback = (value: Persistent, prop: PersistentProperty) => string;
 type ValidatorFunction<T extends Persistent, P extends ClassPropNames<T>> = (value: T[P], property: PersistentProperty, persistentInstance: T) => boolean;
-interface PersistentProperty {
+export interface PersistentProperty {
     name: string;
     isReference?: boolean;
     isPureReference?: boolean;

package/lib/server-auth/server-auth-mock.d.ts

@@ -1,6 +1,7 @@
-import { UserCredentials } from '../auth/user-auth-types';
-import { Collection } from '../types/utility-types';
 import { ServerAuthService, CustomCredentials } from './server-auth';
+import { Collection } from '../types/utility-types';
+import { UserCredentials } from '../auth/user-auth-types';
+
 export declare class ServerAuthMock extends ServerAuthService {
     constructor(userCredentials: Collection<UserCredentials<{}>>);
     getUser<T extends CustomCredentials>(userId: string): Promise<UserCredentials<T> | undefined>;

package/lib/server-auth/server-auth.d.ts

@@ -1,4 +1,5 @@
 import { UserCredentials } from '../auth/user-auth-types';
+
 export interface CustomCredentials {
     [key: string]: unknown;
 }

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

@@ -1,5 +1,6 @@
-import { Persistent, PersistentObject, Collections } from '../persistent/persistent';
 import { ClassPropNames } from '../types/utility-types';
+import { Persistent, PersistentObject, Collections, PersistentProperty } from '../persistent/persistent';
+
 export type DocumentObject = PersistentObject<Persistent>;
 /**
  * The query operators
@@ -52,6 +53,12 @@ export type QueryObject<T> = {
         propertyName: ClassPropNames<T> | string;
     };
 };
+export type DocumentListenerUninstaller = () => void;
+interface DocumentChange {
+    before: DocumentObject | undefined;
+    after: DocumentObject;
+}
+export type DocumentChangeListerner = (change: DocumentChange) => void;
 /**
  * The data source interface.
  * It defines the methods that must be implemented by a data source
@@ -60,6 +67,16 @@ export type QueryObject<T> = {
  * 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[];
+    /**
+     * 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
+     */
+    protected documentChangeListerner(prop: PersistentProperty, listener: DocumentChangeListerner): DocumentListenerUninstaller | undefined;
     /**
      * Retrieves a document by id
      * Implement the required logic to retrieve a document by id from your concrete
@@ -134,4 +151,8 @@ export declare abstract class DataSource {
     static toPropertyPathOperations<T extends Persistent>(operations: QueryOperation<T>[]): QueryOperation<T>[];
     static isArrayOperator(operator: QueryOperator): boolean;
     private static toPropertyPathValue;
+    private onDocumentChange;
+    private static getSystemRegisteredReferencesWithStoredProps;
+    private onUpdate;
 }
+export {};

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

@@ -1,5 +1,6 @@
-import { Collections, Persistent, PersistentObject } from '../persistent/persistent';
-import { DataSource, DocumentObject, QueryObject } from "./data-source";
+import { DataSource, DocumentChangeListerner, DocumentListenerUninstaller, DocumentObject, QueryObject } from './data-source';
+import { Collections, Persistent, PersistentObject, PersistentProperty } from '../persistent/persistent';
+
 export interface JsonRawData {
     [collection: string]: {
         [documentId: string]: PersistentObject<Persistent>;
@@ -17,7 +18,7 @@ export interface ErrorOnOperation {
  * It is useful for testing purposes.
  * The data in the JSON object is not persisted.
  */
-export declare class JsonDataSource implements DataSource {
+export declare class JsonDataSource extends DataSource {
     /**
      * @param jsonRawData the JSON object to be used as data store
      */
@@ -51,6 +52,8 @@ export declare class JsonDataSource implements DataSource {
     wait(): Promise<any[]>;
     private incCursor;
     simulateError(error: string | ErrorOnOperation | undefined): this;
+    protected documentChangeListerner(prop: PersistentProperty, listener: DocumentChangeListerner): DocumentListenerUninstaller | undefined;
+    private notifyChange;
     private decCursor;
     private queryProcessor;
     private retrieveQueryDocs;
@@ -65,4 +68,5 @@ export declare class JsonDataSource implements DataSource {
     private _simulateDelay;
     private _pendingPromises;
     private _simulateError;
+    private _listener;
 }

package/lib/store/mocks/test-user.d.ts

@@ -1,4 +1,5 @@
 import { Persistent } from '../../persistent/persistent';
+
 interface Name {
     firstName: string;
     lastName: string;
@@ -46,4 +47,9 @@ export declare class DerivedUser extends TestUser {
     get salary(): number | undefined;
     private _salary;
 }
+export declare class UsesUserAsPersistentProp extends Persistent {
+    set user(value: TestUser | undefined);
+    get user(): TestUser | undefined;
+    private _user;
+}
 export {};

package/lib/store/model.d.ts

@@ -1,6 +1,7 @@
-import { Persistent } from '../persistent/persistent';
-import { ClassPropNames, PropPath, PropPathType } from '../types/utility-types';
 import { DataSource, QueryOperator, QueryObject, QueryOrder } from './data-source';
+import { ClassPropNames, PropPath, PropPathType } from '../types/utility-types';
+import { Persistent } from '../persistent/persistent';
+
 /**
  * Provides abstraction to the database access. You should gain access to a Model
  * object through the Store.getModel method instead of its constructor.

package/lib/store/store.d.ts

@@ -1,6 +1,7 @@
-import { Persistent } from '../persistent/persistent';
-import { DataSource } from './data-source';
 import { Model } from './model';
+import { DataSource } from './data-source';
+import { Persistent } from '../persistent/persistent';
+
 /**
  * The store is the main entry point for the data access layer.
  * It provides methods to retrieve models for collections and subcollections.

package/lib/types/utility-types.d.ts

@@ -38,8 +38,8 @@ export type Require<T, K extends keyof T> = T & {
 export type Primitive = string | number | bigint | boolean | undefined | symbol;
 type Decr = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
 type Concat<T, U> = `${string & T}${string & U}`;
-export type PropPath<T extends {}, AllowedTypes = any, MaxDepth extends number = 3, Prefix = ''> = MaxDepth extends number ? {
+export type PropPath<T extends {}, AllowedTypes = any, MaxDepth extends number = 9, Prefix = ''> = MaxDepth extends number ? {
     [P in keyof T]: T[P] extends Function ? never : T[P] extends AllowedTypes ? T[P] extends Primitive | ArrayLike<any> ? Concat<Prefix, P> : Concat<Prefix, P> | PropPath<T[P] & {}, AllowedTypes, Decr[MaxDepth], `${Concat<Prefix, P>}.`> : never;
-}[keyof T] & string : never;
+}[keyof T] : never;
 export type PropPathType<T, Path, MaxDepth extends number = 2> = MaxDepth extends number ? Path extends keyof T ? T[Path] : Path extends `${infer PropName}.${infer SubPropName}` ? PropName extends keyof T ? PropPathType<T[PropName], SubPropName, Decr[MaxDepth]> : never : never : never;
 export {};

package/lib/utils/utils.d.ts

@@ -1,4 +1,5 @@
 import { PropPath, PropPathType } from '../types/utility-types';
+
 /**
  * A map of key-value pairs
  * @param varName the name of the variable
@@ -57,4 +58,4 @@ export declare function snakeCase(str: string | undefined | null, snakeChar?: st
  * const result = getDeepValue( obj, path )
  * // result = 1
  */
-export declare function getDeepValue<T extends {}, P extends PropPath<T>>(obj: T, path: P): PropPathType<T, P>;
+export declare function getDeepValue<T extends {}, P extends PropPath<T> & string>(obj: T, path: P): PropPathType<T, P>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "entropic-bond",
   "type": "module",
-  "version": "1.50.4",
+  "version": "1.51.0",
   "description": "Tidy up your messy components",
   "main": "./lib/entropic-bond.umd.cjs",
   "module": "./lib/entropic-bond.js",
@@ -33,7 +33,7 @@
   },
   "scripts": {
     "test": "vitest",
-    "build": "tsc -p tsconfig-build.json && vite build",
+    "build": "vite build",
     "prepare": "npm run build"
   },
   "repository": {
@@ -56,16 +56,16 @@
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@type-challenges/utils": "^0.1.1",
-    "@types/node": "^20.11.16",
+    "@types/node": "^20.12.7",
     "@types/uuid": "^9.0.8",
     "git-branch-is": "^4.0.0",
-    "husky": "^9.0.10",
-    "semantic-release": "^23.0.0",
-    "typedoc": "^0.25.7",
+    "husky": "^9.0.11",
+    "semantic-release": "^23.0.8",
+    "typedoc": "^0.25.13",
     "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "^5.3.3",
-    "vite-plugin-dts": "^3.7.2",
-    "vitest": "^1.2.2"
+    "typescript": "^5.4.5",
+    "vite-plugin-dts": "^3.8.2",
+    "vitest": "^1.5.0"
   },
   "dependencies": {
     "uuid": "^9.0.1"

package/lib/auth/auth-mock.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/cloud-functions/cloud-functions-mock.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/cloud-storage/cloud-storage.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/observable/observable.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/persistent/entropic-component.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/persistent/persistent.spec.d.ts

@@ -1,67 +0,0 @@
-import { Persistent } from './persistent';
-interface InnerObject {
-    nonPersistedReferences: PersistentClass[];
-}
-declare class PersistentClass extends Persistent {
-    protected beforeSerialize(): void;
-    protected afterDeserialize(): void;
-    set persistentProp(val: number | undefined);
-    get persistentProp(): number | undefined;
-    set personPureRef(value: Person | undefined);
-    get personPureRef(): Person | undefined;
-    set persistentArray(value: PersistentClass[] | undefined);
-    get persistentArray(): PersistentClass[] | undefined;
-    _persistentProp: number | undefined;
-    _persistentArray: PersistentClass[] | undefined;
-    _personPureRef: Person | undefined;
-    _nonPersistentProp: number | undefined;
-}
-declare class NotRegistered extends Persistent {
-}
-declare class Person extends Persistent {
-    protected beforeSerialize(): void;
-    protected afterDeserialize(): void;
-    set name(value: string | undefined);
-    get name(): string | undefined;
-    set salary(value: number | undefined);
-    get salary(): number | undefined;
-    set doNotPersist(value: number | undefined);
-    get doNotPersist(): number | undefined;
-    set anObjectProperty(value: PersistentClass);
-    get anObjectProperty(): PersistentClass;
-    set skills(value: string[] | undefined);
-    get skills(): string[] | undefined;
-    set arrayOfPersistent(value: PersistentClass[] | undefined);
-    get arrayOfPersistent(): PersistentClass[] | undefined;
-    set document(value: PersistentClass | undefined);
-    get document(): PersistentClass | undefined;
-    set arrayOfRefs(value: PersistentClass[]);
-    get arrayOfRefs(): PersistentClass[];
-    set persistentObject(value: InnerObject | undefined);
-    get persistentObject(): InnerObject | undefined;
-    private _name?;
-    private _salary?;
-    private _skills;
-    private _anObjectProperty;
-    private _arrayOfPersistent;
-    _notRegistered: NotRegistered | undefined;
-    _arrayOfArray: number[][] | undefined;
-    _arrayOfPersistentArray: PersistentClass[][] | undefined;
-    _plainObject: {
-        [key: string]: unknown;
-    } | undefined;
-    _document: PersistentClass | undefined;
-    _docAtArbitraryCollection: PersistentClass | undefined;
-    _docAtArbitraryCollectionRefFunc: PersistentClass | undefined;
-    private _arrayOfRefs;
-    private _persistentObject;
-    _referenceWithStoredValues: PersistentClass | undefined;
-    private _doNotPersist;
-}
-export declare class WithAnnotations extends PersistentClass {
-}
-export declare class WithAnnotations2 extends PersistentClass {
-}
-export declare class WithAnnotations3 extends PersistentClass {
-}
-export {};

package/lib/server-auth/server-auth-mock.spec.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

package/lib/store/model.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/store/store.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/utility-types.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/utils/utils.spec.d.ts

@@ -1 +0,0 @@
-export {};