@nymphjs/nymph 1.0.0-beta.130 → 1.0.0-beta.132

package/src/Entity.ts

@@ -357,114 +357,122 @@ export default class Entity<
 
     this.$data = new Proxy(this.$dataStore, this.$dataHandler);
 
-    return new Proxy(this, {
-      has: (entity: Entity, name: string) => {
-        if (
-          typeof name !== 'string' ||
-          name in entity ||
-          name.substring(0, 1) === '$'
-        ) {
-          return name in entity;
-        }
+    return this.$proxy();
+  }
 
-        this.$check();
-        return name in entity.$data;
-      },
+  private $existingProxy?: this & T;
+  protected $proxy() {
+    if (this.$existingProxy == null) {
+      this.$existingProxy = new Proxy(this, {
+        has: (entity: this, name: string) => {
+          if (
+            typeof name !== 'string' ||
+            name in entity ||
+            name.substring(0, 1) === '$'
+          ) {
+            return name in entity;
+          }
 
-      get: (entity: Entity, name: string) => {
-        if (
-          typeof name !== 'string' ||
-          name in entity ||
-          name.substring(0, 1) === '$'
-        ) {
-          if (name === 'tags' || name === 'cdate' || name === 'mdate') {
-            this.$check();
+          this.$check();
+          return name in entity.$data;
+        },
+
+        get: (entity: this, name: string) => {
+          if (
+            typeof name !== 'string' ||
+            name in entity ||
+            name.substring(0, 1) === '$'
+          ) {
+            if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+              this.$check();
+            }
+            return (entity as any)[name];
           }
-          return (entity as any)[name];
-        }
 
-        this.$check();
-        if (name in entity.$data) {
-          return entity.$data[name];
-        }
-        return undefined;
-      },
+          this.$check();
+          if (name in entity.$data) {
+            return entity.$data[name];
+          }
+          return undefined;
+        },
 
-      set: (entity: Entity, name: string, value: any) => {
-        if (
-          typeof name !== 'string' ||
-          name in entity ||
-          name.substring(0, 1) === '$'
-        ) {
-          if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+        set: (entity: this, name: string, value: any) => {
+          if (
+            typeof name !== 'string' ||
+            name in entity ||
+            name.substring(0, 1) === '$'
+          ) {
+            if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+              this.$check();
+            }
+            (entity as any)[name] = value;
+          } else {
             this.$check();
+            (entity.$data as any)[name] = value;
           }
-          (entity as any)[name] = value;
-        } else {
-          this.$check();
-          (entity.$data as any)[name] = value;
-        }
-        return true;
-      },
+          return true;
+        },
 
-      deleteProperty: (entity: Entity, name: string) => {
-        if (name in entity) {
-          return delete (entity as any)[name];
-        } else if (name in entity.$data) {
-          this.$check();
-          return delete entity.$data[name];
-        }
-        return true;
-      },
+        deleteProperty: (entity: this, name: string) => {
+          if (name in entity) {
+            return delete (entity as any)[name];
+          } else if (name in entity.$data) {
+            this.$check();
+            return delete entity.$data[name];
+          }
+          return true;
+        },
 
-      getPrototypeOf: (entity: Entity) => {
-        return entity.constructor.prototype;
-      },
+        getPrototypeOf: (entity: this) => {
+          return entity.constructor.prototype;
+        },
 
-      defineProperty: (
-        entity: Entity,
-        name: string,
-        descriptor: PropertyDescriptor,
-      ) => {
-        if (
-          typeof name !== 'string' ||
-          name in entity ||
-          name.substring(0, 1) === '$'
-        ) {
-          if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+        defineProperty: (
+          entity: this,
+          name: string,
+          descriptor: PropertyDescriptor,
+        ) => {
+          if (
+            typeof name !== 'string' ||
+            name in entity ||
+            name.substring(0, 1) === '$'
+          ) {
+            if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+              this.$check();
+            }
+            Object.defineProperty(entity, name, descriptor);
+          } else {
             this.$check();
+            Object.defineProperty(entity.$data, name, descriptor);
           }
-          Object.defineProperty(entity, name, descriptor);
-        } else {
-          this.$check();
-          Object.defineProperty(entity.$data, name, descriptor);
-        }
-        return true;
-      },
+          return true;
+        },
 
-      getOwnPropertyDescriptor: (entity: Entity, name: string) => {
-        if (
-          typeof name !== 'string' ||
-          name in entity ||
-          name.substring(0, 1) === '$'
-        ) {
-          if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+        getOwnPropertyDescriptor: (entity: this, name: string) => {
+          if (
+            typeof name !== 'string' ||
+            name in entity ||
+            name.substring(0, 1) === '$'
+          ) {
+            if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+              this.$check();
+            }
+            return Object.getOwnPropertyDescriptor(entity, name);
+          } else {
             this.$check();
+            return Object.getOwnPropertyDescriptor(entity.$data, name);
           }
-          return Object.getOwnPropertyDescriptor(entity, name);
-        } else {
-          this.$check();
-          return Object.getOwnPropertyDescriptor(entity.$data, name);
-        }
-      },
+        },
 
-      ownKeys: (entity: Entity) => {
-        this.$check();
-        return Object.getOwnPropertyNames(entity).concat(
-          Object.getOwnPropertyNames(entity.$data),
-        );
-      },
-    }) as Entity<T>;
+        ownKeys: (entity: this) => {
+          this.$check();
+          return Object.getOwnPropertyNames(entity).concat(
+            Object.getOwnPropertyNames(entity.$data),
+          );
+        },
+      }) as this & T;
+    }
+    return this.$existingProxy;
   }
 
   /**
@@ -1117,7 +1125,7 @@ export default class Entity<
    * Check if this is a sleeping reference and throw an error if so.
    */
   protected $check() {
-    if (this.$isASleepingReference || this.$sleepingReference != null) {
+    if (this.$asleep()) {
       throw new EntityIsSleepingReferenceError(
         'This entity is in a sleeping reference state. You must use .$wake() to wake it.',
       );
@@ -1135,9 +1143,9 @@ export default class Entity<
    * Wake from a sleeping reference.
    */
   public $wake() {
-    if (!this.$isASleepingReference || this.$sleepingReference == null) {
+    if (!this.$asleep()) {
       this.$wakePromise = null;
-      return Promise.resolve(this);
+      return Promise.resolve(this.$proxy());
     }
     if (this.$sleepingReference?.[1] == null) {
       throw new InvalidStateError(
@@ -1150,10 +1158,7 @@ export default class Entity<
       );
       this.$wakePromise = this.$nymph
         .getEntity(
-          {
-            class: EntityClass,
-            skipAc: this.$skipAc,
-          },
+          { class: EntityClass, skipAc: this.$skipAc },
           { type: '&', guid: this.$sleepingReference[1] },
         )
         .then((entity) => {
@@ -1172,7 +1177,7 @@ export default class Entity<
           this.mdate = entity.mdate;
           this.$putData(entity.$getData(false), entity.$getSData(), 'server');
 
-          return this;
+          return this.$proxy();
         })
         .finally(() => {
           this.$wakePromise = null;
@@ -1192,7 +1197,7 @@ export default class Entity<
           newLevel = level - 1;
         }
         if (newLevel !== undefined && newLevel < 0) {
-          resolve(this);
+          resolve(this.$proxy());
           return;
         }
         const promises: Promise<any>[] = [];
@@ -1226,11 +1231,11 @@ export default class Entity<
         walkData(this.$data);
         if (promises.length) {
           Promise.all(promises).then(
-            () => resolve(this),
+            () => resolve(this.$proxy()),
             (errObj) => reject(errObj),
           );
         } else {
-          resolve(this);
+          resolve(this.$proxy());
         }
       };
 
@@ -1251,7 +1256,6 @@ export default class Entity<
     const refresh = await this.$nymph.getEntity(
       {
         class: this.constructor as EntityConstructor,
-        skipCache: true,
         skipAc: this.$skipAc,
       },
       { type: '&', guid: this.guid },
@@ -1285,7 +1289,7 @@ export default class Entity<
       return this.$sleepingReference;
     }
     if (existingOnly && this.guid == null) {
-      return this;
+      return this.$proxy();
     }
     return [
       'nymph_entity_reference',

package/src/Entity.types.ts

@@ -99,7 +99,7 @@ export interface DataObjectInterface {
    */
   $is(object: any): boolean;
   /**
-   * Refresh the object from storage. (Bypasses Nymph's cache.)
+   * Refresh the object from storage.
    *
    * @returns False if the data has not been saved, true on success. An error is
    *          thrown on failure.
@@ -164,8 +164,7 @@ export interface EntityInterface extends DataObjectInterface {
   /**
    * Replace any referenced entities in the data with sleeping references.
    *
-   * Calling this function ensures that the next time a referenced entity is
-   * accessed, it will be retrieved from the DB (unless it is in Nymph's cache).
+   * After calling this function, referenced entities must be awoken again.
    */
   $clearCache(): void;
   /**
@@ -297,9 +296,8 @@ export interface EntityInterface extends DataObjectInterface {
    * `sdata` is used by Nymph to avoid unserializing data that hasn't been
    * requested yet.
    *
-   * If `source` is set to "server", the data is coming from the DB or the
-   * cache. If not, assume the data is coming from the client and can't be
-   * trusted.
+   * If `source` is set to "server", the data is coming from the DB. If not,
+   * assume the data is coming from the client and can't be trusted.
    *
    * @param data The data object.
    * @param sdata The serialized data object.

package/src/Nymph.ts

@@ -716,8 +716,6 @@ export default class Nymph {
    * - return - What to return. "entity", "object", "guid", or "count". Defaults
    *   to "entity".
    * - source - Will be 'client' if the query came from a REST call.
-   * - skipCache - If true, Nymph will skip the cache and retrieve the entity
-   *   from the DB.
    * - skipAc - If true, Tilmeld will not filter returned entities according to
    *   access controls. (If Tilmeld is installed.) (This is *always* set to
    *   false by the REST server.)

package/src/Nymph.types.ts

@@ -226,10 +226,6 @@ export type Options<T extends EntityConstructor = EntityConstructor> = {
    * server. (Mainly used in Tilmeld for access control.)
    */
   source?: string;
-  /**
-   * If true, Nymph will skip the cache and retrieve the entity from the DB.
-   */
-  skipCache?: boolean;
   /**
    * The level(s) of access control requested.
    *
@@ -488,4 +484,8 @@ export interface TilmeldInterface {
     name: string,
     type?: TilmeldAccessLevels,
   ): Promise<boolean>;
+  checkPermissions(
+    entity: EntityInterface,
+    type?: TilmeldAccessLevels,
+  ): boolean;
 }

package/src/conf/defaults.ts

@@ -24,9 +24,6 @@ function getDebuggers(source: string) {
 }
 
 export default {
-  cache: false,
-  cacheThreshold: 4,
-  cacheLimit: 50,
   emptyListError: false,
   updateMDate: true,
   debugInfo: (source, message) => {

package/src/conf/index.ts

@@ -2,20 +2,6 @@
  * Nymph Config
  */
 export interface Config {
-  /**
-   * Cache recently retrieved entities to speed up database queries. Uses more
-   * memory.
-   */
-  cache: boolean;
-  /**
-   * Cache entities after they're accessed this many times.
-   */
-  cacheThreshold: number;
-  /**
-   * The number of recently retrieved entities to cache. If you're running out
-   * of memory, try lowering this value. 0 means unlimited.
-   */
-  cacheLimit: number;
   /**
    * When querying for multiple entities with NymphREST, if the list is empty,
    * return a 404 error.