@nymphjs/nymph 1.0.0-beta.4 → 1.0.0-beta.40

package/src/Entity.ts

@@ -45,9 +45,9 @@ import {
  *
  * Some notes about $equals() and $is(), the replacements for "==":
  *
- * The == operator will likely not give you the result you want, since any yet
- * to be unserialized data causes == to return false when you probably want it
- * to return true.
+ * The == operator will likely not give you the result you want, since two
+ * instances of the same entity will fail that check, even though they represent
+ * the same data in the database.
  *
  * $equals() performs a more strict comparison of the entity to another. Use
  * $equals() instead of the == operator when you want to check both the entities
@@ -56,8 +56,7 @@ import {
  *
  * - They must be entities.
  * - They must have equal GUIDs, or both must have no GUID.
- * - They must be instances of the same class.
- * - Their data must be equal.
+ * - Their data and tags must be equal.
  *
  * $is() performs a less strict comparison of the entity to another. Use $is()
  * instead of the == operator when the entity's data may have been changed, but
@@ -66,7 +65,7 @@ import {
  *
  * - They must be entities.
  * - They must have equal GUIDs, or both must have no GUID.
- * - If they have no GUIDs, their data must be equal.
+ * - If they have no GUIDs, their data and tags must be equal.
  *
  * Some notes about saving entities in other entity's properties:
  *
@@ -146,6 +145,18 @@ export default class Entity<T extends EntityData = EntityData>
    * also listed in searchRestrictedData.
    */
   protected $privateData: string[] = [];
+  /**
+   * Whether this entity should publish changes to PubSub servers.
+   */
+  public static pubSubEnabled = true;
+  /**
+   * Whether this entity should be accessible on the frontend through the REST
+   * server.
+   *
+   * If this is false, any request from the client that attempts to use this
+   * entity will fail.
+   */
+  public static restEnabled = true;
   /**
    * Properties that will not be searchable from the frontend. If the frontend
    * includes any of these properties in any of their clauses, they will be
@@ -157,8 +168,20 @@ export default class Entity<T extends EntityData = EntityData>
    * be visible on the frontend, unlike $privateData, but any changes to them
    * that come from the frontend will be ignored.
    *
-   * In addition to what's listed here, the 'user' and 'group' properties will
-   * be filtered for non-admins when Tilmeld is being used.
+   * In addition to what's listed here, all of the access control properties
+   * will be included when Tilmeld is being used. These are:
+   *
+   * - acUser
+   * - acGroup
+   * - acOther
+   * - acRead
+   * - acWrite
+   * - acFull
+   * - user
+   * - group
+   *
+   * You should modify these through client enabled methods or the $save method
+   * instead, for safety.
    */
   protected $protectedData: string[] = [];
   /**
@@ -293,7 +316,11 @@ export default class Entity<T extends EntityData = EntityData>
 
     if (guid != null) {
       const entity = this.$nymph.driver.getEntitySync(
-        { class: this.constructor as EntityConstructor },
+        {
+          class: this.$nymph.getEntityClass(
+            this.constructor as EntityConstructor
+          ),
+        },
         { type: '&', guid }
       );
       if (entity) {
@@ -513,15 +540,17 @@ export default class Entity<T extends EntityData = EntityData>
         return false;
       }
     }
-    if (object.constructor !== this.constructor) {
-      return false;
-    }
     if (object.cdate !== this.cdate) {
       return false;
     }
     if (object.mdate !== this.mdate) {
       return false;
     }
+    const obTags = [...object.tags].sort();
+    const myTags = [...this.tags].sort();
+    if (!isEqual(obTags, myTags)) {
+      return false;
+    }
     const obData = object.$getData(true);
     const myData = this.$getData(true);
     return isEqual(obData, myData);
@@ -615,6 +644,11 @@ export default class Entity<T extends EntityData = EntityData>
     if (typeof object.$getData !== 'function') {
       return false;
     } else {
+      const obTags = [...object.tags].sort();
+      const myTags = [...this.tags].sort();
+      if (!isEqual(obTags, myTags)) {
+        return false;
+      }
       const obData = object.$getData(true);
       const myData = this.$getData(true);
       return isEqual(obData, myData);
@@ -665,12 +699,21 @@ export default class Entity<T extends EntityData = EntityData>
 
     const protectedData: EntityData = {};
     const protectedProps = [...this.$protectedData];
-    if (
-      this.$nymph.tilmeld &&
-      !this.$nymph.tilmeld.gatekeeper('tilmeld/admin')
-    ) {
-      protectedProps.push('user');
-      protectedProps.push('group');
+    if (this.$nymph.tilmeld) {
+      protectedProps.push('acUser');
+      protectedProps.push('acGroup');
+      protectedProps.push('acOther');
+      protectedProps.push('acRead');
+      protectedProps.push('acWrite');
+      protectedProps.push('acFull');
+      if (
+        ((this.constructor as typeof Entity).class !== 'User' &&
+          (this.constructor as typeof Entity).class !== 'Group') ||
+        !this.$nymph.tilmeld.gatekeeper('tilmeld/admin')
+      ) {
+        protectedProps.push('user');
+        protectedProps.push('group');
+      }
     }
     for (const name of protectedProps) {
       if (name in this.$data) {
@@ -719,11 +762,29 @@ export default class Entity<T extends EntityData = EntityData>
     }
     this.mdate = patch.mdate;
 
+    const protectedProps = [...this.$protectedData];
+    if (this.$nymph.tilmeld) {
+      protectedProps.push('acUser');
+      protectedProps.push('acGroup');
+      protectedProps.push('acOther');
+      protectedProps.push('acRead');
+      protectedProps.push('acWrite');
+      protectedProps.push('acFull');
+      if (
+        ((this.constructor as typeof Entity).class !== 'User' &&
+          (this.constructor as typeof Entity).class !== 'Group') ||
+        !this.$nymph.tilmeld.gatekeeper('tilmeld/admin')
+      ) {
+        protectedProps.push('user');
+        protectedProps.push('group');
+      }
+    }
+
     for (const name in patch.set) {
       if (
         (this.$allowlistData != null &&
           this.$allowlistData.indexOf(name) === -1) ||
-        this.$protectedData.indexOf(name) !== -1 ||
+        protectedProps.indexOf(name) !== -1 ||
         this.$privateData.indexOf(name) !== -1
       ) {
         continue;
@@ -739,7 +800,7 @@ export default class Entity<T extends EntityData = EntityData>
       if (
         (this.$allowlistData != null &&
           this.$allowlistData.indexOf(name) === -1) ||
-        this.$protectedData.indexOf(name) !== -1 ||
+        protectedProps.indexOf(name) !== -1 ||
         this.$privateData.indexOf(name) !== -1
       ) {
         continue;
@@ -860,7 +921,9 @@ export default class Entity<T extends EntityData = EntityData>
     }
     const refresh = await this.$nymph.getEntity(
       {
-        class: this.constructor as EntityConstructor,
+        class: this.$nymph.getEntityClass(
+          this.constructor as EntityConstructor
+        ),
         skipCache: true,
         skipAc: this.$skipAc,
       },

package/src/Entity.types.ts

@@ -271,7 +271,7 @@ export interface EntityInterface extends DataObjectInterface {
   $useSkipAc(useSkipAc: boolean): void;
 }
 
-export type EntityConstructor = (new (guid?: string) => EntityInterface) & {
+export type EntityConstructor = (new (...args: any[]) => EntityInterface) & {
   /**
    * The instance of Nymph to use for queries.
    */
@@ -288,6 +288,18 @@ export type EntityConstructor = (new (guid?: string) => EntityInterface) & {
    * requests.
    */
   class: string;
+  /**
+   * Whether this entity should publish changes to PubSub servers.
+   */
+  pubSubEnabled: boolean;
+  /**
+   * Whether this entity should be accessible on the frontend through the REST
+   * server.
+   *
+   * If this is false, any request from the client that attempts to use this
+   * entity will fail.
+   */
+  restEnabled: boolean;
   /**
    * Properties that will not be searchable from the frontend. If the frontend
    * includes any of these properties in any of their clauses, they will be