@nymphjs/client 1.0.0-beta.132 → 1.0.0-beta.134

package/src/Entity.ts

@@ -24,9 +24,7 @@ export type EntityDataType<T> =
 export type EntityInstanceType<T extends EntityConstructor> =
   T extends new () => infer E ? E & EntityDataType<E> : never;
 
-export default class Entity<
-  T extends EntityData = EntityData,
-> implements EntityInterface {
+export default class Entity<T extends {} = {}> implements EntityInterface {
   /**
    * The instance of Nymph to use for queries.
    */
@@ -174,7 +172,7 @@ export default class Entity<
   protected $proxy() {
     if (this.$existingProxy == null) {
       this.$existingProxy = new Proxy(this, {
-        has: (entity: this, name: string) => {
+        has: (entity: Record<string, any>, name: string) => {
           if (
             typeof name !== 'string' ||
             name in entity ||
@@ -187,7 +185,7 @@ export default class Entity<
           return name in entity.$data;
         },
 
-        get: (entity: this, name: string) => {
+        get: (entity: Record<string, any>, name: string) => {
           if (
             typeof name !== 'string' ||
             name in entity ||
@@ -206,7 +204,7 @@ export default class Entity<
           return undefined;
         },
 
-        set: (entity: this, name: string, value: any) => {
+        set: (entity: Record<string, any>, name: string, value: any) => {
           if (
             typeof name !== 'string' ||
             name in entity ||
@@ -223,7 +221,7 @@ export default class Entity<
           return true;
         },
 
-        deleteProperty: (entity: this, name: string) => {
+        deleteProperty: (entity: Record<string, any>, name: string) => {
           if (name in entity) {
             return delete (entity as any)[name];
           } else if (name in entity.$data) {
@@ -233,12 +231,12 @@ export default class Entity<
           return true;
         },
 
-        getPrototypeOf: (entity: this) => {
+        getPrototypeOf: (entity: Record<string, any>) => {
           return entity.constructor.prototype;
         },
 
         defineProperty: (
-          entity: this,
+          entity: Record<string, any>,
           name: string,
           descriptor: PropertyDescriptor,
         ) => {
@@ -258,7 +256,10 @@ export default class Entity<
           return true;
         },
 
-        getOwnPropertyDescriptor: (entity: this, name: string) => {
+        getOwnPropertyDescriptor: (
+          entity: Record<string, any>,
+          name: string,
+        ) => {
           if (
             typeof name !== 'string' ||
             name in entity ||
@@ -274,7 +275,7 @@ export default class Entity<
           }
         },
 
-        ownKeys: (entity: this) => {
+        ownKeys: (entity: Record<string, any>) => {
           this.$check();
           return Object.getOwnPropertyNames(entity).concat(
             Object.getOwnPropertyNames(entity.$data),
@@ -297,7 +298,7 @@ export default class Entity<
       new (): E;
     },
     guid?: string,
-  ): Promise<E & EntityDataType<E>> {
+  ): Promise<E> {
     const cacheEntity = (
       guid
         ? (this as unknown as EntityConstructor).nymph.getEntityFromCache(
@@ -307,7 +308,7 @@ export default class Entity<
         : null
     ) as Entity | null;
     if (cacheEntity) {
-      return cacheEntity as E & EntityDataType<E>;
+      return cacheEntity as E;
     }
     const entity = new this();
     if (guid != null) {
@@ -320,16 +321,14 @@ export default class Entity<
       ];
       await entity.$wake();
     }
-    return entity as E & EntityDataType<E>;
+    return entity as E;
   }
 
   /**
    * Create a new entity instance.
    */
-  public static factorySync<E extends Entity>(this: {
-    new (): E;
-  }): E & EntityDataType<E> {
-    return new this() as E & EntityDataType<E>;
+  public static factorySync<E extends Entity>(this: { new (): E }): E {
+    return new this() as E;
   }
 
   /**
@@ -346,7 +345,7 @@ export default class Entity<
       new (): E;
     },
     reference: EntityReference,
-  ): E & EntityDataType<E> {
+  ): E {
     const cacheEntity = (
       reference[1]
         ? (this as unknown as EntityConstructor).nymph.getEntityFromCache(
@@ -360,7 +359,7 @@ export default class Entity<
     if (!cacheEntity) {
       entity.$referenceSleep(reference);
     }
-    return entity as E & EntityDataType<E>;
+    return entity as E;
   }
 
   /**
@@ -402,7 +401,9 @@ export default class Entity<
   }
 
   public toJSON() {
-    this.$check();
+    if (this.$isASleepingReference && this.$sleepingReference) {
+      return this.$sleepingReference;
+    }
     const obj: EntityJson = {
       class: entityConstructorsToClassNames(this.constructor),
       guid: this.guid,
@@ -419,9 +420,9 @@ export default class Entity<
     return obj;
   }
 
-  public $init(entityJson: EntityJson | null) {
+  public $init(entityJson: EntityJson | null, isFromSave: boolean) {
     if (entityJson == null) {
-      return this.$proxy();
+      return this;
     }
 
     this.$isASleepingReference = false;
@@ -430,29 +431,54 @@ export default class Entity<
     this.guid = entityJson.guid;
     this.cdate = entityJson.cdate;
     this.mdate = entityJson.mdate;
-    this.tags = entityJson.tags;
+    if (
+      // The instance is new.
+      !this.$originalTags.length ||
+      // The data is coming from a save.
+      isFromSave ||
+      // The tags haven't been modified.
+      JSON.stringify([...this.tags].sort()) ===
+        JSON.stringify([...this.$originalTags].sort())
+    ) {
+      this.tags = entityJson.tags;
+    }
     this.$originalTags = entityJson.tags.slice(0);
-    this.$dirty = {};
-    this.$dataStore = Object.entries(entityJson.data)
-      .map(([key, value]) => {
-        this.$dirty[key] = false;
-        return {
-          key,
-          value: classNamesToEntityConstructors(
+
+    if (!this.$nymph.weakCache || !this.$nymph.weakCacheKeepDirtyData) {
+      // Clear dirty data tracker.
+      for (let name in this.$dirty) {
+        delete this.$dirty[name];
+      }
+    }
+
+    for (let name in this.$dataStore) {
+      if (!this.$dirty[name]) {
+        if (name in entityJson.data) {
+          this.$dataStore[name] = classNamesToEntityConstructors(
             this.$nymph,
-            referencesToEntities(value, this.$nymph),
-          ),
-        };
-      })
-      .reduce(
-        (obj, { key, value }) => Object.assign(obj, { [key]: value }),
-        {},
-      ) as T;
-    this.$data = new Proxy(this.$dataStore, this.$dataHandler);
+            referencesToEntities(entityJson.data[name], this.$nymph),
+          );
+          this.$dirty[name] = false;
+        } else {
+          delete this.$dataStore[name];
+          delete this.$dirty[name];
+        }
+      }
+    }
+
+    for (let name in entityJson.data as T) {
+      if (!(name in this.$dataStore)) {
+        this.$dataStore[name] = classNamesToEntityConstructors(
+          this.$nymph,
+          referencesToEntities(entityJson.data[name], this.$nymph),
+        );
+        this.$dirty[name] = false;
+      }
+    }
 
     this.$nymph.setEntityToCache(this.constructor as EntityConstructor, this);
 
-    return this.$proxy();
+    return this;
   }
 
   public $addTag(...tags: string[]) {
@@ -507,10 +533,14 @@ export default class Entity<
       return false;
     }
     const obData = sortObj(object.toJSON());
-    obData.tags?.sort();
+    if ('tags' in obData) {
+      obData.tags?.sort();
+    }
     // obData.data = sortObj(obData.data);
     const myData = sortObj(this.toJSON());
-    myData.tags?.sort();
+    if ('tags' in myData) {
+      myData.tags?.sort();
+    }
     // myData.data = sortObj(myData.data);
     return isEqual(obData, myData);
   }
@@ -540,7 +570,7 @@ export default class Entity<
       if (dirty) {
         if (key in this.$data) {
           patch.set[key] = entityConstructorsToClassNames(
-            entitiesToReferences(this.$data[key]),
+            entitiesToReferences((this.$data as EntityData)[key]),
           );
         } else {
           patch.unset.push(key);
@@ -585,10 +615,14 @@ export default class Entity<
       return false;
     } else {
       const obData = sortObj(object.toJSON());
-      obData.tags?.sort();
+      if ('tags' in obData) {
+        obData.tags?.sort();
+      }
       // obData.data = sortObj(obData.data);
       const myData = sortObj(this.toJSON());
-      myData.tags?.sort();
+      if ('tags' in myData) {
+        myData.tags?.sort();
+      }
       // myData.data = sortObj(myData.data);
       return isEqual(obData, myData);
     }
@@ -629,7 +663,7 @@ export default class Entity<
   public $wake() {
     if (!this.$asleep()) {
       this.$wakePromise = null;
-      return Promise.resolve(this.$proxy());
+      return Promise.resolve(this);
     }
     if (this.$sleepingReference?.[1] == null) {
       throw new InvalidStateError(
@@ -647,7 +681,7 @@ export default class Entity<
             const errObj = { data, textStatus: 'No data returned.' };
             return Promise.reject(errObj);
           }
-          return this.$init(data);
+          return this.$init(data, false);
         })
         .finally(() => {
           this.$wakePromise = null;
@@ -667,7 +701,7 @@ export default class Entity<
           newLevel = level - 1;
         }
         if (newLevel !== undefined && newLevel < 0) {
-          resolve(this.$proxy());
+          resolve(this);
           return;
         }
         const promises: Promise<any>[] = [];
@@ -701,11 +735,11 @@ export default class Entity<
         walkData(this.$data);
         if (promises.length) {
           Promise.all(promises).then(
-            () => resolve(this.$proxy()),
+            () => resolve(this),
             (errObj) => reject(errObj),
           );
         } else {
-          resolve(this.$proxy());
+          resolve(this);
         }
       };
 
@@ -744,7 +778,7 @@ export default class Entity<
     if (data == null) {
       throw new Error("The entity's data could not be refreshed.");
     }
-    this.$init(data);
+    this.$init(data, false);
     return true;
   }
 
@@ -779,7 +813,7 @@ export default class Entity<
       stateless,
     );
     if (!stateless && data.entity) {
-      this.$init(data.entity);
+      this.$init(data.entity, false);
     }
     return data.return;
   }
@@ -790,7 +824,7 @@ export default class Entity<
     }
 
     if (this.guid == null) {
-      return this.$proxy();
+      return this;
     }
     return [
       'nymph_entity_reference',

package/src/Entity.types.ts

@@ -97,17 +97,13 @@ export interface DataObjectInterface {
    * @returns False if the data has not been saved, true on success. An error is
    *          thrown on failure.
    */
-  $refresh(): Promise<boolean | 0>;
+  $refresh(): Promise<boolean>;
   /**
    * Save the object to storage.
    *
    * An error is thrown on failure.
    */
   $save(): Promise<void>;
-  /**
-   * The object's data.
-   */
-  [k: string]: any;
 }
 
 /**
@@ -176,8 +172,9 @@ export interface EntityInterface extends DataObjectInterface {
    * Initialize this entity from a JSON representation.
    *
    * @param entityJson The entity JSON.
+   * @param isFromSave True if the entity is being initialized with data just saved to the server.
    */
-  $init(entityJson: EntityJson | null): EntityInterface;
+  $init(entityJson: EntityJson | null, isFromSave: boolean): EntityInterface;
   /**
    * Retrieve this entity's data from the server.
    *
@@ -223,6 +220,8 @@ export interface EntityInterface extends DataObjectInterface {
    * @returns A Nymph Entity Reference array as an unsaved entity.
    */
   $toReference(): EntityReference | EntityInterface;
+
+  toJSON(): EntityReference | EntityJson;
 }
 
 export type EntityConstructor<

package/src/EntityWeakCache.ts

@@ -1,6 +1,6 @@
 import { EntityConstructor, EntityInterface } from './Entity.types.js';
 
-export default class EntityWeakCache {
+export class EntityWeakCache {
   private references: WeakMap<
     EntityConstructor,
     { [k: string]: WeakRef<EntityInterface> }

package/src/HttpRequester.ts

@@ -32,7 +32,7 @@ export interface AbortableAsyncIterator<
   abortController: AbortController;
 }
 
-export default class HttpRequester {
+export class HttpRequester {
   private fetch: WindowOrWorkerGlobalScope['fetch'];
   private requestCallbacks: HttpRequesterRequestCallback[] = [];
   private responseCallbacks: HttpRequesterResponseCallback[] = [];

package/src/Nymph.ts

@@ -6,9 +6,10 @@ import type {
   ServerCallResponse,
   ServerCallStaticResponse,
 } from './Entity.types.js';
-import EntityWeakCache from './EntityWeakCache.js';
+import { EntityWeakCache } from './EntityWeakCache.js';
+import { QueryWeakCache } from './QueryWeakCache.js';
 import type { AbortableAsyncIterator } from './HttpRequester.js';
-import HttpRequester, { ClientError } from './HttpRequester.js';
+import { HttpRequester, ClientError } from './HttpRequester.js';
 import type {
   EventType,
   NymphOptions,
@@ -45,7 +46,8 @@ export default class Nymph {
   private requestCallbacks: RequestCallback[] = [];
   private responseCallbacks: ResponseCallback[] = [];
   private restUrl: string = '';
-  private weakCache = false;
+  public weakCache = false;
+  public weakCacheKeepDirtyData = false;
   /**
    * Headers that will be sent with every request.
    *
@@ -55,7 +57,11 @@ export default class Nymph {
   /**
    * The entity cache.
    */
-  public cache = new EntityWeakCache();
+  public entityCache = new EntityWeakCache();
+  /**
+   * The query cache.
+   */
+  public queryCache = new QueryWeakCache();
   /**
    * Return `null` or empty array instead of error when entity/ies not found.
    */
@@ -65,6 +71,7 @@ export default class Nymph {
     this.restUrl = NymphOptions.restUrl;
     // @ts-ignore TS doesn't know about WeakRef.
     this.weakCache = !!NymphOptions.weakCache && typeof WeakRef !== 'undefined';
+    this.weakCacheKeepDirtyData = !!NymphOptions.weakCacheKeepDirtyData;
     if (
       'returnNullOnNotFound' in NymphOptions &&
       NymphOptions.returnNullOnNotFound != null
@@ -156,12 +163,24 @@ export default class Nymph {
   }
 
   public async getUID(name: string) {
-    const data = await requester.GET({
-      url: this.restUrl,
-      headers: { ...this.headers },
-      dataType: 'text',
-      data: { action: 'uid', data: name },
-    });
+    const query = { action: 'uid', data: name };
+    let promise: Promise<any> | null = null;
+    const queryJSON = JSON.stringify(query);
+    if (this.weakCache) {
+      promise = this.queryCache.get(queryJSON);
+    }
+    if (promise == null) {
+      promise = requester.GET({
+        url: this.restUrl,
+        headers: { ...this.headers },
+        dataType: 'text',
+        data: query,
+      });
+      if (this.weakCache) {
+        this.queryCache.set(queryJSON, promise);
+      }
+    }
+    const data = await promise;
     return Number(data);
   }
 
@@ -259,11 +278,11 @@ export default class Nymph {
         response[i] &&
         response[i].guid != null &&
         (e.guid == null || e.guid === response[i].guid)
-          ? e.$init(response[i])
+          ? e.$init(response[i], method !== 'GET')
           : e,
       ) as T[];
     } else if (!Array.isArray(entity) && response.guid != null) {
-      return entity.$init(response) as T;
+      return entity.$init(response, method !== 'GET') as T;
     }
     throw new Error('Server error');
   }
@@ -320,7 +339,7 @@ export default class Nymph {
       if (options.return && options.return === 'guid') {
         return data as string;
       } else {
-        return this.initEntity(data as EntityJson<T>);
+        return this.initEntity(data as EntityJson<T>, false);
       }
     }
 
@@ -364,18 +383,31 @@ export default class Nymph {
     if (typeof selectors[0] === 'string') {
       selectors = [{ type: '&', guid: selectors[0] }];
     }
-    const data = await requester.GET({
-      url: this.restUrl,
-      headers: { ...this.headers },
-      dataType: 'json',
-      data: {
-        action: 'entity',
-        data: [
-          entityConstructorsToClassNames(options),
-          ...entityConstructorsToClassNames(entitiesToReferences(selectors)),
-        ],
-      },
-    });
+    const query = {
+      action: 'entity',
+      data: [
+        entityConstructorsToClassNames(options),
+        ...entityConstructorsToClassNames(entitiesToReferences(selectors)),
+      ],
+    };
+    let promise: Promise<any> | null = null;
+    const queryJSON = JSON.stringify(query);
+    if (this.weakCache) {
+      promise = this.queryCache.get(queryJSON);
+    }
+    if (promise == null) {
+      promise = requester.GET({
+        url: this.restUrl,
+        headers: { ...this.headers },
+        dataType: 'json',
+        data: query,
+      });
+      if (this.weakCache) {
+        this.queryCache.set(queryJSON, promise);
+      }
+    }
+
+    const data = await promise;
 
     if (options.return === 'count' || typeof data.guid !== 'undefined') {
       return data;
@@ -401,18 +433,30 @@ export default class Nymph {
   ): Promise<EntityInstanceType<T>[] | string[] | number> {
     let data = null;
     try {
-      data = await requester.GET({
-        url: this.restUrl,
-        headers: { ...this.headers },
-        dataType: 'json',
-        data: {
-          action: 'entities',
-          data: [
-            entityConstructorsToClassNames(options),
-            ...entityConstructorsToClassNames(entitiesToReferences(selectors)),
-          ],
-        },
-      });
+      const query = {
+        action: 'entities',
+        data: [
+          entityConstructorsToClassNames(options),
+          ...entityConstructorsToClassNames(entitiesToReferences(selectors)),
+        ],
+      };
+      let promise: Promise<any> | null = null;
+      const queryJSON = JSON.stringify(query);
+      if (this.weakCache) {
+        promise = this.queryCache.get(queryJSON);
+      }
+      if (promise == null) {
+        promise = requester.GET({
+          url: this.restUrl,
+          headers: { ...this.headers },
+          dataType: 'json',
+          data: query,
+        });
+        if (this.weakCache) {
+          this.queryCache.set(queryJSON, promise);
+        }
+      }
+      data = await promise;
     } catch (e: any) {
       if (
         this.returnNullOnNotFound &&
@@ -434,11 +478,12 @@ export default class Nymph {
     if (options.return && options.return === 'guid') {
       return data;
     }
-    return data.map((e: EntityJson<T>) => this.initEntity(e));
+    return data.map((e: EntityJson<T>) => this.initEntity(e, false));
   }
 
   public initEntity<T extends EntityConstructor = EntityConstructor>(
     entityJSON: EntityJson<T>,
+    isFromSave: boolean,
   ): EntityInstanceType<T> {
     const EntityClass = classNamesToEntityConstructors<T>(
       this,
@@ -452,7 +497,7 @@ export default class Nymph {
     let entity = EntityClass.factorySync();
     if (this.weakCache) {
       // Try to get it from cache.
-      const entityFromCache = this.cache.get(
+      const entityFromCache = this.entityCache.get(
         EntityClass,
         entityJSON.guid || '',
       );
@@ -460,7 +505,7 @@ export default class Nymph {
         entity = entityFromCache as EntityInstanceType<T>;
       }
     }
-    return entity.$init(entityJSON) as EntityInstanceType<T>;
+    return entity.$init(entityJSON, isFromSave) as EntityInstanceType<T>;
   }
 
   public getEntityFromCache<T extends EntityConstructor = EntityConstructor>(
@@ -470,7 +515,10 @@ export default class Nymph {
     if (!this.weakCache) {
       return null;
     }
-    return this.cache.get(EntityClass, guid) as EntityInstanceType<T> | null;
+    return this.entityCache.get(
+      EntityClass,
+      guid,
+    ) as EntityInstanceType<T> | null;
   }
 
   public setEntityToCache(
@@ -480,13 +528,15 @@ export default class Nymph {
     if (!this.weakCache) {
       return;
     }
-    return this.cache.set(EntityClass, entity);
+    return this.entityCache.set(EntityClass, entity);
   }
 
-  public initEntitiesFromData<T extends any>(item: T): T {
+  public initEntitiesFromData<T extends any>(item: T, isFromSave: boolean): T {
     if (Array.isArray(item)) {
       // Recurse into lower arrays.
-      return item.map((entry) => this.initEntitiesFromData(entry)) as T;
+      return item.map((entry) =>
+        this.initEntitiesFromData(entry, isFromSave),
+      ) as T;
     } else if (item instanceof Object && !(item instanceof Entity)) {
       if (
         item.hasOwnProperty('class') &&
@@ -500,11 +550,11 @@ export default class Nymph {
           (item as any as EntityJson).class,
         ) != null
       ) {
-        return this.initEntity(item as any as EntityJson) as T;
+        return this.initEntity(item as any as EntityJson, isFromSave) as T;
       } else {
         for (let [key, value] of Object.entries(item)) {
           // @ts-ignore: Key comes from the object. It's fine.
-          item[key] = this.initEntitiesFromData(value);
+          item[key] = this.initEntitiesFromData(value, isFromSave);
         }
       }
     }
@@ -563,7 +613,7 @@ export default class Nymph {
 
     return {
       ...data,
-      return: this.initEntitiesFromData(data.return),
+      return: this.initEntitiesFromData(data.return, false),
     };
   }
 
@@ -587,7 +637,7 @@ export default class Nymph {
       },
     });
 
-    return this.initEntitiesFromData(data);
+    return this.initEntitiesFromData(data, false);
   }
 
   public async serverCallStaticIterator(
@@ -619,7 +669,7 @@ export default class Nymph {
           if (response instanceof Error) {
             yield response;
           } else {
-            yield that.initEntitiesFromData(response);
+            yield that.initEntitiesFromData(response, false);
           }
         }
       },