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

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-beta.41](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.40...v1.0.0-beta.41) (2023-07-12)
+
+### Features
+
+- remove synchronous database queries ([b579fb2](https://github.com/sciactive/nymphjs/commit/b579fb2eacd96cdd1b386a62c5c00cdbb2438f6e))
+- rewrite server side async api to match client side api ([9c537a8](https://github.com/sciactive/nymphjs/commit/9c537a8be49e9b989af0822a4c2236e8c2d20f87))
+
 # [1.0.0-beta.40](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.39...v1.0.0-beta.40) (2023-07-10)
 
 **Note:** Version bump only for package @nymphjs/nymph

package/README.md

@@ -76,19 +76,17 @@ export default class Todo extends Entity<TodoData> {
     return (await super.factory(guid)) as Todo & TodoData;
   }
 
-  static factorySync(guid?: string): Todo & TodoData {
-    return super.factorySync(guid) as Todo & TodoData;
+  static factorySync(): Todo & TodoData {
+    return super.factorySync() as Todo & TodoData;
   }
 
-  constructor(guid?: string) {
-    super(guid);
+  constructor() {
+    super();
 
-    if (this.guid == null) {
-      // Within the methods of an entity, you will use `this.$data` to access
-      // its data. Outside, you don't need the $data part.
-      this.$data.text = '';
-      this.$data.done = false;
-    }
+    // Within the methods of an entity, you will use `this.$data` to access
+    // its data. Outside, you don't need the $data part.
+    this.$data.text = '';
+    this.$data.done = false;
   }
 
   async $getOtherTodos() {

package/dist/Entity.d.ts

@@ -15,6 +15,7 @@ export default class Entity<T extends EntityData = EntityData> implements Entity
     protected $data: T;
     protected $isASleepingReference: boolean;
     protected $sleepingReference: EntityReference | null;
+    protected $wakePromise: Promise<Entity<T>> | null;
     protected $privateData: string[];
     static pubSubEnabled: boolean;
     static restEnabled: boolean;
@@ -27,9 +28,9 @@ export default class Entity<T extends EntityData = EntityData> implements Entity
     static clientEnabledStaticMethods: string[];
     private $skipAc;
     private $originalAcValues;
-    constructor(guid?: string);
+    constructor();
     static factory(guid?: string): Promise<EntityInterface | Entity<EntityData>>;
-    static factorySync(guid?: string): Entity<EntityData>;
+    static factorySync(): Entity<EntityData>;
     static factoryReference(reference: EntityReference): Entity<EntityData>;
     toJSON(): EntityReference | EntityJson | null;
     $addTag(...tags: string[]): void;
@@ -41,6 +42,21 @@ export default class Entity<T extends EntityData = EntityData> implements Entity
     $getData(includeSData?: boolean): any;
     $getSData(): SerializedEntityData;
     $getOriginalAcValues(): ACProperties;
+    $getCurrentAcValues(): {
+        user: string | null;
+        group: string | null;
+        acUser: any;
+        acGroup: any;
+        acOther: any;
+        acRead: string[] | null;
+        acWrite: string[] | null;
+        acFull: string[] | null;
+    };
+    $getAcUid(): string | null;
+    $getAcGid(): string | null;
+    $getAcReadIds(): string[] | null;
+    $getAcWriteIds(): string[] | null;
+    $getAcFullIds(): string[] | null;
     $getValidatable(): any;
     $getTags(): string[];
     $hasTag(...tags: string[]): boolean;
@@ -50,7 +66,10 @@ export default class Entity<T extends EntityData = EntityData> implements Entity
     $jsonAcceptPatch(patch: EntityPatch, allowConflict?: boolean): void;
     $putData(data: EntityData, sdata?: SerializedEntityData): void;
     protected $referenceSleep(reference: EntityReference): void;
-    protected $referenceWake(): boolean;
+    protected $check(): void;
+    $asleep(): boolean;
+    $wake(): Promise<Entity<T>>;
+    $wakeAll(level?: number): Promise<Entity<T>>;
     $refresh(): Promise<boolean | 0>;
     $removeTag(...tags: string[]): void;
     $save(): Promise<boolean>;

package/dist/Entity.js

@@ -4,13 +4,14 @@ const lodash_1 = require("lodash");
 const errors_1 = require("./errors");
 const utils_1 = require("./utils");
 class Entity {
-    constructor(guid) {
+    constructor() {
         this.guid = null;
         this.cdate = null;
         this.mdate = null;
         this.tags = [];
         this.$isASleepingReference = false;
         this.$sleepingReference = null;
+        this.$wakePromise = null;
         this.$privateData = [];
         this.$protectedData = [];
         this.$protectedTags = [];
@@ -20,11 +21,11 @@ class Entity {
         this.$nymph = this.constructor.nymph;
         this.$dataHandler = {
             has: (data, name) => {
-                this.$referenceWake();
+                this.$check();
                 return name in data || name in this.$sdata;
             },
             get: (data, name) => {
-                this.$referenceWake();
+                this.$check();
                 if (this.$sdata.hasOwnProperty(name)) {
                     data[name] = (0, utils_1.referencesToEntities)(JSON.parse(this.$sdata[name]), this.$nymph, this.$skipAc);
                     delete this.$sdata[name];
@@ -35,7 +36,7 @@ class Entity {
                 return undefined;
             },
             set: (data, name, value) => {
-                this.$referenceWake();
+                this.$check();
                 if (this.$sdata.hasOwnProperty(name)) {
                     delete this.$sdata[name];
                 }
@@ -43,7 +44,7 @@ class Entity {
                 return true;
             },
             deleteProperty: (data, name) => {
-                this.$referenceWake();
+                this.$check();
                 if (this.$sdata.hasOwnProperty(name)) {
                     return delete this.$sdata[name];
                 }
@@ -53,7 +54,7 @@ class Entity {
                 return true;
             },
             defineProperty: (data, name, descriptor) => {
-                this.$referenceWake();
+                this.$check();
                 if (this.$sdata.hasOwnProperty(name)) {
                     delete this.$sdata[name];
                 }
@@ -61,7 +62,7 @@ class Entity {
                 return true;
             },
             getOwnPropertyDescriptor: (data, name) => {
-                this.$referenceWake();
+                this.$check();
                 if (this.$sdata.hasOwnProperty(name)) {
                     data[name] = (0, utils_1.referencesToEntities)(JSON.parse(this.$sdata[name]), this.$nymph, this.$skipAc);
                     delete this.$sdata[name];
@@ -69,25 +70,13 @@ class Entity {
                 return Object.getOwnPropertyDescriptor(data, name);
             },
             ownKeys: (data) => {
-                this.$referenceWake();
+                this.$check();
                 return Object.getOwnPropertyNames(data).concat(Object.getOwnPropertyNames(this.$sdata));
             },
         };
         this.$dataStore = {};
         this.$sdata = {};
         this.$data = new Proxy(this.$dataStore, this.$dataHandler);
-        if (guid != null) {
-            const entity = this.$nymph.driver.getEntitySync({
-                class: this.$nymph.getEntityClass(this.constructor),
-            }, { type: '&', guid });
-            if (entity) {
-                this.guid = entity.guid;
-                this.tags = entity.tags;
-                this.cdate = entity.cdate;
-                this.mdate = entity.mdate;
-                this.$putData(entity.$getData(), entity.$getSData());
-            }
-        }
         return new Proxy(this, {
             has: (entity, name) => {
                 if (typeof name !== 'string' ||
@@ -95,7 +84,7 @@ class Entity {
                     name.substring(0, 1) === '$') {
                     return name in entity;
                 }
-                this.$referenceWake();
+                this.$check();
                 return name in entity.$data;
             },
             get: (entity, name) => {
@@ -103,11 +92,11 @@ class Entity {
                     name in entity ||
                     name.substring(0, 1) === '$') {
                     if (name === 'tags' || name === 'cdate' || name === 'mdate') {
-                        this.$referenceWake();
+                        this.$check();
                     }
                     return entity[name];
                 }
-                this.$referenceWake();
+                this.$check();
                 if (name in entity.$data) {
                     return entity.$data[name];
                 }
@@ -118,12 +107,12 @@ class Entity {
                     name in entity ||
                     name.substring(0, 1) === '$') {
                     if (name === 'tags' || name === 'cdate' || name === 'mdate') {
-                        this.$referenceWake();
+                        this.$check();
                     }
                     entity[name] = value;
                 }
                 else {
-                    this.$referenceWake();
+                    this.$check();
                     entity.$data[name] = value;
                 }
                 return true;
@@ -133,7 +122,7 @@ class Entity {
                     return delete entity[name];
                 }
                 else if (name in entity.$data) {
-                    this.$referenceWake();
+                    this.$check();
                     return delete entity.$data[name];
                 }
                 return true;
@@ -146,12 +135,12 @@ class Entity {
                     name in entity ||
                     name.substring(0, 1) === '$') {
                     if (name === 'tags' || name === 'cdate' || name === 'mdate') {
-                        this.$referenceWake();
+                        this.$check();
                     }
                     Object.defineProperty(entity, name, descriptor);
                 }
                 else {
-                    this.$referenceWake();
+                    this.$check();
                     Object.defineProperty(entity.$data, name, descriptor);
                 }
                 return true;
@@ -161,17 +150,17 @@ class Entity {
                     name in entity ||
                     name.substring(0, 1) === '$') {
                     if (name === 'tags' || name === 'cdate' || name === 'mdate') {
-                        this.$referenceWake();
+                        this.$check();
                     }
                     return Object.getOwnPropertyDescriptor(entity, name);
                 }
                 else {
-                    this.$referenceWake();
+                    this.$check();
                     return Object.getOwnPropertyDescriptor(entity.$data, name);
                 }
             },
             ownKeys: (entity) => {
-                this.$referenceWake();
+                this.$check();
                 return Object.getOwnPropertyNames(entity).concat(Object.getOwnPropertyNames(entity.$data));
             },
         });
@@ -188,8 +177,8 @@ class Entity {
         }
         return entity;
     }
-    static factorySync(guid) {
-        return new this(guid);
+    static factorySync() {
+        return new this();
     }
     static factoryReference(reference) {
         const entity = new this();
@@ -217,14 +206,14 @@ class Entity {
         return obj;
     }
     $addTag(...tags) {
-        this.$referenceWake();
+        this.$check();
         if (tags.length < 1) {
             return;
         }
         this.tags = (0, utils_1.uniqueStrings)([...this.tags, ...tags]);
     }
     $arraySearch(array, strict = false) {
-        this.$referenceWake();
+        this.$check();
         if (!Array.isArray(array)) {
             return -1;
         }
@@ -237,18 +226,18 @@ class Entity {
         return -1;
     }
     $clearCache() {
-        this.$referenceWake();
+        this.$check();
         this.$putData(this.$getData(), this.$getSData());
     }
     $getClientEnabledMethods() {
         return this.$clientEnabledMethods;
     }
     async $delete() {
-        this.$referenceWake();
+        this.$check();
         return await this.$nymph.deleteEntity(this);
     }
     $equals(object) {
-        this.$referenceWake();
+        this.$check();
         if (!(object instanceof Entity)) {
             return false;
         }
@@ -273,7 +262,7 @@ class Entity {
         return (0, lodash_1.isEqual)(obData, myData);
     }
     $getData(includeSData = false) {
-        this.$referenceWake();
+        this.$check();
         if (includeSData) {
             for (const key in this.$sdata) {
                 const _unused = this[key];
@@ -282,24 +271,43 @@ class Entity {
         return (0, utils_1.entitiesToReferences)({ ...this.$dataStore });
     }
     $getSData() {
-        this.$referenceWake();
+        this.$check();
         return this.$sdata;
     }
     $getOriginalAcValues() {
-        this.$referenceWake();
-        return (this.$originalAcValues ?? {
-            user: this.$data.user,
-            group: this.$data.group,
+        this.$check();
+        return this.$originalAcValues ?? this.$getCurrentAcValues();
+    }
+    $getCurrentAcValues() {
+        this.$check();
+        return {
+            user: this.$getAcUid(),
+            group: this.$getAcGid(),
             acUser: this.$data.acUser,
             acGroup: this.$data.acGroup,
             acOther: this.$data.acOther,
-            acRead: this.$data.acRead,
-            acWrite: this.$data.acWrite,
-            acFull: this.$data.acFull,
-        });
+            acRead: this.$getAcReadIds(),
+            acWrite: this.$getAcWriteIds(),
+            acFull: this.$getAcFullIds(),
+        };
+    }
+    $getAcUid() {
+        return this.$data.user?.guid;
+    }
+    $getAcGid() {
+        return this.$data.group?.guid;
+    }
+    $getAcReadIds() {
+        return this.$data.acRead?.map((entity) => entity.guid);
+    }
+    $getAcWriteIds() {
+        return this.$data.acWrite?.map((entity) => entity.guid);
+    }
+    $getAcFullIds() {
+        return this.$data.acFull?.map((entity) => entity.guid);
     }
     $getValidatable() {
-        this.$referenceWake();
+        this.$check();
         for (const key in this.$sdata) {
             const _unused = this[key];
         }
@@ -312,11 +320,11 @@ class Entity {
         };
     }
     $getTags() {
-        this.$referenceWake();
+        this.$check();
         return this.tags;
     }
     $hasTag(...tags) {
-        this.$referenceWake();
+        this.$check();
         if (!tags.length) {
             return false;
         }
@@ -337,7 +345,7 @@ class Entity {
         if (this.guid || object.guid) {
             return this.guid === object.guid;
         }
-        this.$referenceWake();
+        this.$check();
         if (typeof object.$getData !== 'function') {
             return false;
         }
@@ -353,7 +361,7 @@ class Entity {
         }
     }
     $jsonAcceptData(input, allowConflict = false) {
-        this.$referenceWake();
+        this.$check();
         if (this.guid != input.guid) {
             throw new errors_1.EntityConflictError('Tried to accept JSON input for the wrong entity.');
         }
@@ -392,7 +400,9 @@ class Entity {
             protectedProps.push('acFull');
             if ((this.constructor.class !== 'User' &&
                 this.constructor.class !== 'Group') ||
-                !this.$nymph.tilmeld.gatekeeper('tilmeld/admin')) {
+                !this.$nymph.tilmeld.currentUser ||
+                (!this.$nymph.tilmeld.currentUser.abilities?.includes('tilmeld/admin') &&
+                    !this.$nymph.tilmeld.currentUser.abilities?.includes('system/admin'))) {
                 protectedProps.push('user');
                 protectedProps.push('group');
             }
@@ -425,7 +435,7 @@ class Entity {
         });
     }
     $jsonAcceptPatch(patch, allowConflict = false) {
-        this.$referenceWake();
+        this.$check();
         if (this.guid != patch.guid) {
             throw new errors_1.EntityConflictError('Tried to accept JSON patch for the wrong entity.');
         }
@@ -445,7 +455,9 @@ class Entity {
             protectedProps.push('acFull');
             if ((this.constructor.class !== 'User' &&
                 this.constructor.class !== 'Group') ||
-                !this.$nymph.tilmeld.gatekeeper('tilmeld/admin')) {
+                !this.$nymph.tilmeld.currentUser ||
+                (!this.$nymph.tilmeld.currentUser.abilities?.includes('tilmeld/admin') &&
+                    !this.$nymph.tilmeld.currentUser.abilities?.includes('system/admin'))) {
                 protectedProps.push('user');
                 protectedProps.push('group');
             }
@@ -486,7 +498,7 @@ class Entity {
         }
     }
     $putData(data, sdata) {
-        this.$referenceWake();
+        this.$check();
         const mySdata = sdata ?? this.$getSData();
         for (const name in data) {
             delete mySdata[name];
@@ -499,7 +511,7 @@ class Entity {
         }
         this.$sdata = mySdata;
         if (this.$originalAcValues == null) {
-            this.$originalAcValues = this.$getOriginalAcValues();
+            this.$originalAcValues = this.$getCurrentAcValues();
         }
     }
     $referenceSleep(reference) {
@@ -519,29 +531,90 @@ class Entity {
         this.guid = reference[1];
         this.$sleepingReference = reference;
     }
-    $referenceWake() {
-        if (!this.$isASleepingReference || this.$sleepingReference == null) {
-            return true;
+    $check() {
+        if (this.$isASleepingReference || this.$sleepingReference != null) {
+            throw new errors_1.EntityIsSleepingReferenceError('This entity is in a sleeping reference state. You must use .$wake() to wake it.');
         }
-        const EntityClass = this.$nymph.getEntityClass(this.$sleepingReference[2]);
-        const entity = this.$nymph.driver.getEntitySync({
-            class: EntityClass,
-            skipAc: this.$skipAc,
-        }, { type: '&', guid: this.$sleepingReference[1] });
-        if (entity == null) {
-            return false;
+    }
+    $asleep() {
+        return this.$isASleepingReference || this.$sleepingReference != null;
+    }
+    $wake() {
+        if (!this.$isASleepingReference || this.$sleepingReference == null) {
+            this.$wakePromise = null;
+            return Promise.resolve(this);
+        }
+        if (this.$sleepingReference?.[1] == null) {
+            throw new errors_1.InvalidStateError('Tried to wake a sleeping reference with no GUID.');
+        }
+        if (!this.$wakePromise) {
+            const EntityClass = this.$nymph.getEntityClass(this.$sleepingReference[2]);
+            this.$wakePromise = this.$nymph
+                .getEntity({
+                class: EntityClass,
+                skipAc: this.$skipAc,
+            }, { type: '&', guid: this.$sleepingReference[1] })
+                .then((entity) => {
+                if (entity == null || entity.guid == null) {
+                    return Promise.reject(new errors_1.InvalidStateError('The sleeping reference could not be retrieved.'));
+                }
+                this.$isASleepingReference = false;
+                this.$sleepingReference = null;
+                this.guid = entity.guid;
+                this.tags = entity.tags;
+                this.cdate = entity.cdate;
+                this.mdate = entity.mdate;
+                this.$putData(entity.$getData(), entity.$getSData());
+                return this;
+            })
+                .finally(() => {
+                this.$wakePromise = null;
+            });
         }
-        this.$isASleepingReference = false;
-        this.$sleepingReference = null;
-        this.guid = entity.guid;
-        this.tags = entity.tags;
-        this.cdate = entity.cdate;
-        this.mdate = entity.mdate;
-        this.$putData(entity.$getData(), entity.$getSData());
-        return true;
+        return this.$wakePromise;
+    }
+    $wakeAll(level) {
+        return new Promise((resolve, reject) => {
+            const wakeProps = () => {
+                let newLevel;
+                if (level !== undefined) {
+                    newLevel = level - 1;
+                }
+                if (newLevel !== undefined && newLevel < 0) {
+                    resolve(this);
+                    return;
+                }
+                const promises = [];
+                for (let [key, value] of Object.entries(this.$data)) {
+                    if (value instanceof Entity && value.$isASleepingReference) {
+                        promises.push(value.$wakeAll(newLevel));
+                    }
+                    else if (Array.isArray(value)) {
+                        for (let i = 0; i < value.length; i++) {
+                            if (value[i] instanceof Entity &&
+                                value[i].$isASleepingReference) {
+                                promises.push(value[i].$wakeAll(newLevel));
+                            }
+                        }
+                    }
+                }
+                if (promises.length) {
+                    Promise.all(promises).then(() => resolve(this), (errObj) => reject(errObj));
+                }
+                else {
+                    resolve(this);
+                }
+            };
+            if (this.$isASleepingReference) {
+                this.$wake().then(wakeProps, (errObj) => reject(errObj));
+            }
+            else {
+                wakeProps();
+            }
+        });
     }
     async $refresh() {
-        this.$referenceWake();
+        await this.$wake();
         if (this.guid == null) {
             return false;
         }
@@ -560,11 +633,11 @@ class Entity {
         return true;
     }
     $removeTag(...tags) {
-        this.$referenceWake();
+        this.$check();
         this.tags = (0, lodash_1.difference)(this.tags, tags);
     }
     async $save() {
-        this.$referenceWake();
+        await this.$wake();
         return await this.$nymph.saveEntity(this);
     }
     $toReference() {