@nymphjs/tilmeld 1.0.0-beta.121 → 1.0.0-beta.122

package/src/testArtifacts.ts

@@ -1,11 +1,13 @@
 import {
   Entity,
   Nymph,
+  HttpError,
   TilmeldAccessLevels,
   TilmeldAccessRequest,
 } from '@nymphjs/nymph';
 
 import Tilmeld from './Tilmeld.js';
+import { requireAbility, requireAuthentication } from './decorators/index.js';
 import { AccessControlError } from './errors/index.js';
 import type { AccessControlData } from './Tilmeld.types.js';
 import type UserClass from './User.js';
@@ -28,6 +30,26 @@ export class TestModel extends Entity<TestModelData> {
    */
   private $skipAcWhenDeleting = false;
 
+  @requireAuthentication
+  public $testRequireAuthenticationDecorator() {
+    return true;
+  }
+
+  @requireAuthentication
+  public async $testRequireAuthenticationDecoratorAsync() {
+    return true;
+  }
+
+  @requireAbility('test-ability')
+  public $testRequireAbilityDecorator() {
+    return true;
+  }
+
+  @requireAbility('test-ability')
+  public async $testRequireAbilityDecoratorAsync() {
+    return true;
+  }
+
   /*
    * This should *never* be accessible on the client.
    */
@@ -86,7 +108,7 @@ export function TilmeldTest(
       );
       expect(Array.isArray(all)).toEqual(true);
       for (const cur of all) {
-        expect(await cur.$deleteSkipAC()).toEqual(true);
+        await cur.$deleteSkipAC();
       }
 
       all = await nymph.getEntities({ class: TestModel });
@@ -95,7 +117,7 @@ export function TilmeldTest(
       all = await nymph.getEntities({ class: User });
       expect(Array.isArray(all)).toEqual(true);
       for (const cur of all) {
-        expect(await cur.$deleteSkipAC()).toEqual(true);
+        await cur.$deleteSkipAC();
       }
 
       all = await nymph.getEntities({ class: User });
@@ -104,7 +126,7 @@ export function TilmeldTest(
       all = await nymph.getEntities({ class: Group });
       expect(Array.isArray(all)).toEqual(true);
       for (const cur of all) {
-        expect(await cur.$deleteSkipAC()).toEqual(true);
+        await cur.$deleteSkipAC();
       }
 
       all = await nymph.getEntities({ class: Group });
@@ -219,7 +241,7 @@ export function TilmeldTest(
 
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -241,6 +263,103 @@ export function TilmeldTest(
       expect(testEntityBob?.acFull).toEqual([]);
     });
 
+    it('require authentication decorator', async () => {
+      const { bob } = await makeUsers();
+
+      await tilmeld.fillSession(bob);
+
+      const bobsEntity = await TestModel.factory();
+      bobsEntity.name = "Bob's Entity";
+      await bobsEntity.$save();
+
+      expect(bobsEntity.$testRequireAuthenticationDecorator()).toEqual(true);
+      expect(
+        await bobsEntity.$testRequireAuthenticationDecoratorAsync(),
+      ).toEqual(true);
+
+      tilmeld.clearSession();
+
+      try {
+        bobsEntity.$testRequireAuthenticationDecorator();
+
+        throw new Error('Should have thrown.');
+      } catch (e: any) {
+        expect(e).toBeInstanceOf(HttpError);
+        expect(e.status).toEqual(403);
+        expect(e.message).toEqual('Forbidden');
+      }
+
+      try {
+        await bobsEntity.$testRequireAuthenticationDecoratorAsync();
+
+        throw new Error('Should have thrown.');
+      } catch (e: any) {
+        expect(e).toBeInstanceOf(HttpError);
+        expect(e.status).toEqual(403);
+        expect(e.message).toEqual('Forbidden');
+      }
+    });
+
+    it('require ability decorator', async () => {
+      const { bob } = await makeUsers();
+
+      await tilmeld.fillSession(bob);
+
+      const bobsEntity = await TestModel.factory();
+      bobsEntity.name = "Bob's Entity";
+      await bobsEntity.$save();
+
+      try {
+        bobsEntity.$testRequireAbilityDecorator();
+
+        throw new Error('Should have thrown.');
+      } catch (e: any) {
+        expect(e).toBeInstanceOf(HttpError);
+        expect(e.status).toEqual(403);
+        expect(e.message).toEqual('Forbidden');
+      }
+
+      try {
+        await bobsEntity.$testRequireAbilityDecoratorAsync();
+
+        throw new Error('Should have thrown.');
+      } catch (e: any) {
+        expect(e).toBeInstanceOf(HttpError);
+        expect(e.status).toEqual(403);
+        expect(e.message).toEqual('Forbidden');
+      }
+
+      tilmeld.clearSession();
+
+      try {
+        bobsEntity.$testRequireAbilityDecorator();
+
+        throw new Error('Should have thrown.');
+      } catch (e: any) {
+        expect(e).toBeInstanceOf(HttpError);
+        expect(e.status).toEqual(403);
+        expect(e.message).toEqual('Forbidden');
+      }
+
+      try {
+        await bobsEntity.$testRequireAbilityDecoratorAsync();
+
+        throw new Error('Should have thrown.');
+      } catch (e: any) {
+        expect(e).toBeInstanceOf(HttpError);
+        expect(e.status).toEqual(403);
+        expect(e.message).toEqual('Forbidden');
+      }
+
+      bob.$grant('test-ability');
+      await tilmeld.fillSession(bob);
+
+      expect(bobsEntity.$testRequireAbilityDecorator()).toEqual(true);
+      expect(await bobsEntity.$testRequireAbilityDecoratorAsync()).toEqual(
+        true,
+      );
+    });
+
     it("alice can't access an entity owned by bob", async () => {
       const { bob, alice } = await makeUsers();
 
@@ -248,7 +367,7 @@ export function TilmeldTest(
 
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -280,7 +399,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acRead = [alice.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -328,7 +447,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acWrite = [alice.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -357,7 +476,7 @@ export function TilmeldTest(
       }
 
       testEntityAlice.name = "Haha! It's mine now!";
-      expect(await testEntityAlice.$save()).toEqual(true);
+      await testEntityAlice.$save();
 
       expect(await testEntityAlice.$refresh()).toEqual(true);
       expect(testEntityAlice.name).toEqual("Haha! It's mine now!");
@@ -371,7 +490,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acWrite = [alice.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -418,7 +537,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acFull = [alice.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -446,7 +565,7 @@ export function TilmeldTest(
         throw new Error();
       }
 
-      expect(await testEntityAlice.$delete()).toEqual(true);
+      await testEntityAlice.$delete();
       const verifyEntityAlice = await nymph.getEntity(
         { class: TestModel },
         { type: '&', guid: bobsEntity.guid || '' },
@@ -462,7 +581,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acRead = [abgroup.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -495,7 +614,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acRead = [abgroup.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -543,7 +662,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acWrite = [abgroup.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -572,7 +691,7 @@ export function TilmeldTest(
       }
 
       testEntityAlice.name = "Haha! It's mine now!";
-      expect(await testEntityAlice.$save()).toEqual(true);
+      await testEntityAlice.$save();
 
       expect(await testEntityAlice.$refresh()).toEqual(true);
       expect(testEntityAlice.name).toEqual("Haha! It's mine now!");
@@ -586,7 +705,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acWrite = [abgroup.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -633,7 +752,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acFull = [abgroup.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -661,7 +780,7 @@ export function TilmeldTest(
         throw new Error();
       }
 
-      expect(await testEntityAlice.$delete()).toEqual(true);
+      await testEntityAlice.$delete();
       const verifyEntityAlice = await nymph.getEntity(
         { class: TestModel },
         { type: '&', guid: bobsEntity.guid || '' },
@@ -677,7 +796,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = alice.group;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -710,7 +829,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = alice.group;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -759,7 +878,7 @@ export function TilmeldTest(
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = alice.group;
       bobsEntity.acGroup = TilmeldAccessLevels.WRITE_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -788,7 +907,7 @@ export function TilmeldTest(
       }
 
       testEntityAlice.name = "Haha! It's mine now!";
-      expect(await testEntityAlice.$save()).toEqual(true);
+      await testEntityAlice.$save();
 
       expect(await testEntityAlice.$refresh()).toEqual(true);
       expect(testEntityAlice.name).toEqual("Haha! It's mine now!");
@@ -803,7 +922,7 @@ export function TilmeldTest(
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = alice.group;
       bobsEntity.acGroup = TilmeldAccessLevels.WRITE_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -851,7 +970,7 @@ export function TilmeldTest(
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = alice.group;
       bobsEntity.acGroup = TilmeldAccessLevels.FULL_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -879,7 +998,7 @@ export function TilmeldTest(
         throw new Error();
       }
 
-      expect(await testEntityAlice.$delete()).toEqual(true);
+      await testEntityAlice.$delete();
       const verifyEntityAlice = await nymph.getEntity(
         { class: TestModel },
         { type: '&', guid: bobsEntity.guid || '' },
@@ -895,7 +1014,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.READ_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -928,7 +1047,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.READ_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -976,7 +1095,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.WRITE_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1005,7 +1124,7 @@ export function TilmeldTest(
       }
 
       testEntityAlice.name = "Haha! It's mine now!";
-      expect(await testEntityAlice.$save()).toEqual(true);
+      await testEntityAlice.$save();
 
       expect(await testEntityAlice.$refresh()).toEqual(true);
       expect(testEntityAlice.name).toEqual("Haha! It's mine now!");
@@ -1019,7 +1138,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.WRITE_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1066,7 +1185,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.FULL_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1094,7 +1213,7 @@ export function TilmeldTest(
         throw new Error();
       }
 
-      expect(await testEntityAlice.$delete()).toEqual(true);
+      await testEntityAlice.$delete();
       const verifyEntityAlice = await nymph.getEntity(
         { class: TestModel },
         { type: '&', guid: bobsEntity.guid || '' },
@@ -1110,7 +1229,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.FULL_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1137,7 +1256,7 @@ export function TilmeldTest(
         throw new Error();
       }
 
-      expect(await testEntityNobody.$delete()).toEqual(true);
+      await testEntityNobody.$delete();
       const verifyEntityNobody = await nymph.getEntity(
         { class: TestModel },
         { type: '&', guid: bobsEntity.guid || '' },
@@ -1152,7 +1271,7 @@ export function TilmeldTest(
         ...(await nymph.getEntities({ class: Group, skipAc: true })),
       ];
       for (let entity of allEntities) {
-        expect(await entity.$deleteSkipAC()).toEqual(true);
+        await entity.$deleteSkipAC();
       }
     });
 
@@ -1170,7 +1289,7 @@ export function TilmeldTest(
       ];
       bobsEntity.acWrite = [alice.guid ?? '', bob.guid ?? ''];
       bobsEntity.acFull = [bob.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1542,7 +1661,7 @@ export function TilmeldTest(
 
       const alicesEntity = await TestModel.factory();
       alicesEntity.name = "Alice's Entity";
-      expect(await alicesEntity.$save()).toEqual(true);
+      await alicesEntity.$save();
 
       expect(alicesEntity.guid).not.toBeNull();
       expect(alice.$is(alicesEntity.user)).toEqual(true);
@@ -1566,7 +1685,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = alice.group;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1615,7 +1734,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acOther = TilmeldAccessLevels.READ_ACCESS;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1661,7 +1780,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acRead = [alice.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1707,7 +1826,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acWrite = [alice.group?.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1756,7 +1875,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.group = abgroup;
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1805,7 +1924,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acFull = [abgroup.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1867,7 +1986,7 @@ export function TilmeldTest(
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
       bobsEntity.acFull = [alice.guid ?? ''];
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);
@@ -1885,7 +2004,7 @@ export function TilmeldTest(
 
       const alicesEntity = await TestModel.factory();
       alicesEntity.name = "Alice's Entity";
-      expect(await alicesEntity.$save()).toEqual(true);
+      await alicesEntity.$save();
 
       expect(alicesEntity.guid).not.toBeNull();
       expect(alice.$is(alicesEntity.user)).toEqual(true);
@@ -1941,7 +2060,7 @@ export function TilmeldTest(
 
       const bobsEntity = await TestModel.factory();
       bobsEntity.name = "Bob's Entity";
-      expect(await bobsEntity.$save()).toEqual(true);
+      await bobsEntity.$save();
 
       expect(bobsEntity.guid).not.toBeNull();
       expect(bob.$is(bobsEntity.user)).toEqual(true);