@nymphjs/nymph 1.0.0-beta.131 → 1.0.0-beta.133

package/src/Entity.ts

@@ -107,9 +107,7 @@ export type EntityObjectType<T extends EntityConstructor> =
  * will fill its data from the DB. You can call clearCache() to turn all the
  * entities back into sleeping references.
  */
-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.
    */
@@ -364,7 +362,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 ||
@@ -377,7 +375,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 ||
@@ -396,7 +394,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 ||
@@ -413,7 +411,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) {
@@ -423,12 +421,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,
         ) => {
@@ -448,7 +446,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 ||
@@ -464,7 +465,7 @@ export default class Entity<
           }
         },
 
-        ownKeys: (entity: this) => {
+        ownKeys: (entity: Record<string, any>) => {
           this.$check();
           return Object.getOwnPropertyNames(entity).concat(
             Object.getOwnPropertyNames(entity.$data),
@@ -487,7 +488,7 @@ export default class Entity<
       new (): E;
     },
     guid?: string,
-  ): Promise<E & EntityDataType<E>> {
+  ): Promise<E> {
     const entity = new this();
     if (guid != null) {
       const entity = await (
@@ -499,19 +500,17 @@ export default class Entity<
         { type: '&', guid },
       );
       if (entity != null) {
-        return entity as E & EntityDataType<E>;
+        return entity as E;
       }
     }
-    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;
   }
 
   /**
@@ -528,10 +527,10 @@ export default class Entity<
       new (): E;
     },
     reference: EntityReference,
-  ): E & EntityDataType<E> {
+  ): E {
     const entity = new this();
     entity.$referenceSleep(reference);
-    return entity as E & EntityDataType<E>;
+    return entity as E;
   }
 
   /**
@@ -601,7 +600,7 @@ export default class Entity<
   }
 
   public toJSON() {
-    if (this.$isASleepingReference) {
+    if (this.$isASleepingReference && this.$sleepingReference) {
       return this.$sleepingReference;
     }
     const obj: EntityJson = {
@@ -618,7 +617,7 @@ export default class Entity<
     ]) {
       if (this.$privateData.indexOf(key) === -1) {
         obj.data[key] = entityConstructorsToClassNames(
-          entitiesToReferences(this.$data[key], true),
+          entitiesToReferences((this.$data as EntityData)[key], true),
         );
       }
     }
@@ -769,9 +768,9 @@ export default class Entity<
     return {
       user: this.$getAcUid(),
       group: this.$getAcGid(),
-      acUser: this.$data.acUser ?? null,
-      acGroup: this.$data.acGroup ?? null,
-      acOther: this.$data.acOther ?? null,
+      acUser: (this.$data as EntityData).acUser ?? null,
+      acGroup: (this.$data as EntityData).acGroup ?? null,
+      acOther: (this.$data as EntityData).acOther ?? null,
       acRead: this.$getAcReadIds(),
       acWrite: this.$getAcWriteIds(),
       acFull: this.$getAcFullIds(),
@@ -788,7 +787,7 @@ export default class Entity<
         return userValue[1];
       }
     }
-    return (this.$data.user?.guid ?? null) as string | null;
+    return ((this.$data as EntityData).user?.guid ?? null) as string | null;
   }
   public $getAcGid() {
     if ('group' in this.$sdata) {
@@ -800,21 +799,24 @@ export default class Entity<
         return groupValue[1];
       }
     }
-    return (this.$data.group?.guid ?? null) as string | null;
+    return ((this.$data as EntityData).group?.guid ?? null) as string | null;
   }
   public $getAcReadIds() {
-    return (this.$data.acRead?.map((entity: EntityInterface | string) =>
-      typeof entity === 'string' ? entity : entity.guid,
+    return ((this.$data as EntityData).acRead?.map(
+      (entity: EntityInterface | string) =>
+        typeof entity === 'string' ? entity : entity.guid,
     ) ?? null) as (string | null)[] | null;
   }
   public $getAcWriteIds() {
-    return (this.$data.acWrite?.map((entity: EntityInterface | string) =>
-      typeof entity === 'string' ? entity : entity.guid,
+    return ((this.$data as EntityData).acWrite?.map(
+      (entity: EntityInterface | string) =>
+        typeof entity === 'string' ? entity : entity.guid,
     ) ?? null) as (string | null)[] | null;
   }
   public $getAcFullIds() {
-    return (this.$data.acFull?.map((entity: EntityInterface | string) =>
-      typeof entity === 'string' ? entity : entity.guid,
+    return ((this.$data as EntityData).acFull?.map(
+      (entity: EntityInterface | string) =>
+        typeof entity === 'string' ? entity : entity.guid,
     ) ?? null) as (string | null)[] | null;
   }
 
@@ -924,7 +926,7 @@ export default class Entity<
     const privateData: EntityData = {};
     for (const name of this.$privateData) {
       if (name in this.$data) {
-        privateData[name] = this.$data[name];
+        privateData[name] = (this.$data as EntityData)[name];
       }
       if (name in data) {
         delete data[name];
@@ -957,7 +959,7 @@ export default class Entity<
     }
     for (const name of protectedProps) {
       if (name in this.$data) {
-        protectedData[name] = this.$data[name];
+        protectedData[name] = (this.$data as EntityData)[name];
       }
       if (name in data) {
         delete data[name];
@@ -982,7 +984,7 @@ export default class Entity<
       ...data,
       ...protectedData,
       ...privateData,
-    });
+    } as T);
   }
 
   public $jsonAcceptPatch(patch: EntityPatch, allowConflict = false) {
@@ -1047,7 +1049,7 @@ export default class Entity<
       ) {
         continue;
       }
-      delete this.$data[name];
+      delete (this.$data as EntityData)[name];
     }
 
     for (const tag of patch.addTags) {
@@ -1073,11 +1075,7 @@ export default class Entity<
     }
   }
 
-  public $putData(
-    data: EntityData,
-    sdata?: SerializedEntityData,
-    _source?: 'server',
-  ) {
+  public $putData(data: T, sdata?: SerializedEntityData, _source?: 'server') {
     this.$check();
 
     for (const name in this.$dataStore) {
@@ -1158,10 +1156,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) => {
@@ -1178,7 +1173,11 @@ export default class Entity<
           this.tags = entity.tags;
           this.cdate = entity.cdate;
           this.mdate = entity.mdate;
-          this.$putData(entity.$getData(false), entity.$getSData(), 'server');
+          this.$putData(
+            entity.$getData(false) as T,
+            entity.$getSData(),
+            'server',
+          );
 
           return this.$proxy();
         })
@@ -1259,7 +1258,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 },
@@ -1270,7 +1268,7 @@ export default class Entity<
     this.tags = refresh.tags;
     this.cdate = refresh.cdate;
     this.mdate = refresh.mdate;
-    this.$putData(refresh.$getData(false), refresh.$getSData(), 'server');
+    this.$putData(refresh.$getData(false) as T, refresh.$getSData(), 'server');
     return true;
   }
 

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.
@@ -111,10 +111,6 @@ export interface DataObjectInterface {
    * An error is thrown on failure.
    */
   $save(): Promise<void>;
-  /**
-   * The object's data.
-   */
-  [k: string]: any;
 }
 
 /**
@@ -164,8 +160,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 +292,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.
@@ -333,6 +327,8 @@ export interface EntityInterface extends DataObjectInterface {
    * @param useSkipAc True or false, whether to use it.
    */
   $useSkipAc(useSkipAc: boolean): void;
+
+  toJSON(): EntityReference | EntityJson;
 }
 
 export type EntityConstructor<

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.