@nymphjs/tilmeld 1.0.0-alpha.2 → 1.0.0-alpha.23

package/src/User.test.ts

@@ -1,5 +1,5 @@
 import { SQLite3Driver } from '@nymphjs/driver-sqlite3';
-import nymph from '@nymphjs/nymph';
+import { Nymph } from '@nymphjs/nymph';
 
 import Tilmeld from './Tilmeld';
 import defaults from './conf/defaults';
@@ -16,7 +16,7 @@ const tilmeld = new Tilmeld({
   cancelChangeRedirect: 'http://localhost:8080',
   jwtSecret: 'shhhhh',
 });
-nymph.init(
+const _nymph = new Nymph(
   {},
   new SQLite3Driver({
     filename: ':memory:',
@@ -40,6 +40,14 @@ describe('User', () => {
     return newUser;
   }
 
+  it('new user passes validation', async () => {
+    const validUser = await makeNewUser();
+
+    expect(() => {
+      defaults.validatorUser(validUser);
+    }).not.toThrow();
+  });
+
   it("doesn't allow unknown keys", async () => {
     const invalidUser = await makeNewUser();
 

package/src/User.ts

@@ -14,9 +14,9 @@ import sha256 from 'crypto-js/sha256';
 import md5 from 'crypto-js/md5';
 import { difference } from 'lodash';
 
+import type Tilmeld from './Tilmeld';
 import AbleObject from './AbleObject';
 import Group, { GroupData } from './Group';
-import Tilmeld from './Tilmeld';
 import {
   BadDataError,
   BadEmailError,
@@ -126,11 +126,20 @@ export type UserData = {
   passwordTemp?: string;
 };
 
+/**
+ * A user data model.
+ *
+ * Written by Hunter Perrin for SciActive.
+ *
+ * @author Hunter Perrin <hperrin@gmail.com>
+ * @copyright SciActive Inc
+ * @see http://nymph.io/
+ */
 export default class User extends AbleObject<UserData> {
   /**
    * The instance of Tilmeld to use for queries.
    */
-  public static tilmeld: Tilmeld;
+  static tilmeld: Tilmeld;
   static ETYPE = 'tilmeld_user';
   static class = 'User';
 
@@ -162,7 +171,7 @@ export default class User extends AbleObject<UserData> {
   ];
   private static DEFAULT_ALLOWLIST_DATA: string[] = [];
 
-  protected $clientEnabledMethods = User.DEFAULT_CLIENT_ENABLED_METHODS;
+  protected $clientEnabledMethods = [...User.DEFAULT_CLIENT_ENABLED_METHODS];
   public static clientEnabledStaticMethods = [
     'current',
     'loginUser',
@@ -170,9 +179,9 @@ export default class User extends AbleObject<UserData> {
     'recover',
     'getClientConfig',
   ];
-  protected $privateData = User.DEFAULT_PRIVATE_DATA;
-  public static searchRestrictedData = User.DEFAULT_PRIVATE_DATA;
-  protected $allowlistData? = User.DEFAULT_ALLOWLIST_DATA;
+  protected $privateData = [...User.DEFAULT_PRIVATE_DATA];
+  public static searchRestrictedData = [...User.DEFAULT_PRIVATE_DATA];
+  protected $allowlistData? = [...User.DEFAULT_ALLOWLIST_DATA];
   protected $allowlistTags?: string[] = [];
 
   /**
@@ -570,9 +579,9 @@ export default class User extends AbleObject<UserData> {
     const tilmeld = this.$nymph.tilmeld as Tilmeld;
     let user = givenUser ?? tilmeld.User.current();
 
-    this.$clientEnabledMethods = User.DEFAULT_CLIENT_ENABLED_METHODS;
-    this.$privateData = User.DEFAULT_PRIVATE_DATA;
-    this.$allowlistData = User.DEFAULT_ALLOWLIST_DATA;
+    this.$clientEnabledMethods = [...User.DEFAULT_CLIENT_ENABLED_METHODS];
+    this.$privateData = [...User.DEFAULT_PRIVATE_DATA];
+    this.$allowlistData = [...User.DEFAULT_ALLOWLIST_DATA];
 
     if (tilmeld.config.emailUsernames) {
       this.$privateData.push('username');
@@ -1158,7 +1167,9 @@ export default class User extends AbleObject<UserData> {
 
     // Start transaction.
     const transaction = 'tilmeld-register-' + nanoid();
+    const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
+    this.$nymph = tnymph;
 
     try {
       // Add primary group.
@@ -1182,6 +1193,7 @@ export default class User extends AbleObject<UserData> {
         }
         if (!(await generatedPrimaryGroup.$saveSkipAC())) {
           await tnymph.rollback(transaction);
+          this.$nymph = nymph;
           return {
             result: false,
             loggedin: false,
@@ -1282,6 +1294,7 @@ export default class User extends AbleObject<UserData> {
           generatedPrimaryGroup.user = this;
           if (!(await generatedPrimaryGroup.$saveSkipAC())) {
             await tnymph.rollback(transaction);
+            this.$nymph = nymph;
             return {
               result: false,
               loggedin: false,
@@ -1317,6 +1330,7 @@ export default class User extends AbleObject<UserData> {
           loggedin = true;
         }
         await tnymph.commit(transaction);
+        this.$nymph = nymph;
         return {
           result: true,
           loggedin,
@@ -1324,6 +1338,7 @@ export default class User extends AbleObject<UserData> {
         };
       } else {
         await tnymph.rollback(transaction);
+        this.$nymph = nymph;
         return {
           result: false,
           loggedin: false,
@@ -1332,6 +1347,7 @@ export default class User extends AbleObject<UserData> {
       }
     } catch (e: any) {
       await tnymph.rollback(transaction);
+      this.$nymph = nymph;
       throw e;
     }
   }
@@ -1532,7 +1548,9 @@ export default class User extends AbleObject<UserData> {
 
     // Start transaction.
     const transaction = 'tilmeld-save-' + nanoid();
+    const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
+    this.$nymph = tnymph;
 
     if (
       this.$data.group != null &&
@@ -1549,6 +1567,7 @@ export default class User extends AbleObject<UserData> {
         await this.$data.group.$saveSkipAC();
       } catch (e: any) {
         await tnymph.rollback(transaction);
+        this.$nymph = nymph;
         throw e;
       }
     }
@@ -1562,6 +1581,7 @@ export default class User extends AbleObject<UserData> {
       ret = await super.$save();
     } catch (e: any) {
       await tnymph.rollback(transaction);
+      this.$nymph = nymph;
       throw e;
     }
     if (ret) {
@@ -1572,6 +1592,7 @@ export default class User extends AbleObject<UserData> {
           this.guid = preGuid;
           this.cdate = preCdate;
           this.mdate = preMdate;
+          this.$nymph = nymph;
           throw new Error("Couldn't send verification email.");
         }
       }
@@ -1587,6 +1608,7 @@ export default class User extends AbleObject<UserData> {
     } else {
       await tnymph.rollback(transaction);
     }
+    this.$nymph = nymph;
     return ret;
   }
 

package/src/conf/d.ts

@@ -1,4 +1,5 @@
 import { EmailOptions } from 'email-templates';
+
 import type Tilmeld from '../Tilmeld';
 import Group, { GroupData } from '../Group';
 import User, { UserData } from '../User';
@@ -64,6 +65,35 @@ export interface Config {
    * a concern. Same risks as user search if generatePrimary is true.)
    */
   enableGroupSearch: boolean;
+  /**
+   * A list of UIDs that can be read from the client by anyone. (getUID)
+   *
+   * Note: If you'd like to limit the access to logged in users, give them an
+   *       ability like "uid/get/nameofuid".
+   */
+  clientReadableUIDs: string[];
+  /**
+   * A list of UIDs that can be created from the client by anyone. (newUID)
+   *
+   * Inclusion in this list implies inclusion in clientReadableUIDs.
+   *
+   * Note: If you'd like to limit the access to logged in users, give them an
+   *       ability like "uid/new/nameofuid".
+   */
+  clientEnabledUIDs: string[];
+  /**
+   * A list of UIDs that can be set from the client by anyone. (setUID,
+   * renameUID)
+   *
+   * Inclusion in this list implies inclusion in clientReadableUIDs and
+   * clientEnabledUIDs.
+   *
+   * Note: There is no way to run renameUID from the client.
+   *
+   * Note: If you'd like to limit the access to logged in users, give them an
+   *       ability like "uid/set/nameofuid".
+   */
+  clientSetabledUIDs: string[];
   /**
    * These will be the available fields for users. (Some fields, like username,
    * can't be excluded.)

package/src/conf/defaults.ts

@@ -1,12 +1,12 @@
+import { nymphJoiProps } from '@nymphjs/nymph';
 import path from 'path';
 import jwt from 'jsonwebtoken';
 import { nanoid } from 'nanoid';
-import Email, { EmailOptions } from 'email-templates';
+import Email from 'email-templates';
 import Joi from 'joi';
 
-import Tilmeld from '../Tilmeld';
 import { Config } from './d';
-import User, { UserData } from '../User';
+import User from '../User';
 import Group from '../Group';
 
 export default {
@@ -21,6 +21,9 @@ export default {
   allowUsernameChange: true,
   enableUserSearch: false,
   enableGroupSearch: false,
+  clientReadableUIDs: [],
+  clientEnabledUIDs: [],
+  clientSetabledUIDs: [],
   userFields: ['name', 'email', 'phone'],
   regFields: ['name', 'email'],
   verifyEmail: true,
@@ -155,29 +158,8 @@ export default {
     Joi.attempt(
       group.$getValidatable(),
       Joi.object().keys({
-        guid: Joi.alternatives()
-          .try(
-            Joi.any().only().allow(null),
-            Joi.string().trim(false).length(24).hex()
-          )
-          .required(),
-        cdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        mdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        tags: Joi.array()
-          .items(
-            Joi.string()
-              .pattern(/[\x01-\x1F\x7F]/, {
-                name: 'control characters',
-                invert: true,
-              })
-              .min(1)
-          )
-          .required(),
-        groupname: Joi.string().trim(false).min(1).required(),
+        ...nymphJoiProps,
+        groupname: Joi.string().trim(false).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
           .trim(false)
@@ -189,7 +171,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         avatar: Joi.string()
@@ -199,7 +180,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(1024),
         phone: Joi.string()
           .trim(false)
@@ -212,7 +192,6 @@ export default {
               name: 'control characters',
               invert: true,
             })
-            .min(1)
             .max(256)
         ),
         defaultPrimary: Joi.boolean(),
@@ -226,29 +205,8 @@ export default {
     Joi.attempt(
       user.$getValidatable(),
       Joi.object().keys({
-        guid: Joi.alternatives()
-          .try(
-            Joi.any().only().allow(null),
-            Joi.string().trim(false).length(24).hex()
-          )
-          .required(),
-        cdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        mdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        tags: Joi.array()
-          .items(
-            Joi.string()
-              .pattern(/[\x01-\x1F\x7F]/, {
-                name: 'control characters',
-                invert: true,
-              })
-              .min(1)
-          )
-          .required(),
-        username: Joi.string().trim(false).min(1).required(),
+        ...nymphJoiProps,
+        username: Joi.string().trim(false).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
           .trim(false)
@@ -260,7 +218,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         nameMiddle: Joi.string()
@@ -269,7 +226,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512),
         nameLast: Joi.string()
           .trim(false)
@@ -277,7 +233,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512),
         name: Joi.string()
           .trim(false)
@@ -285,7 +240,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         avatar: Joi.string()
@@ -295,7 +249,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(1024),
         phone: Joi.string()
           .trim(false)
@@ -308,7 +261,6 @@ export default {
               name: 'control characters',
               invert: true,
             })
-            .min(1)
             .max(256)
         ),
         inheritAbilities: Joi.boolean(),
@@ -348,8 +300,8 @@ export default {
           })
           .length(10),
         recoverSecretDate: Joi.number(),
-        salt: Joi.string().trim(false).min(1),
-        password: Joi.string().trim(false).min(1).required(),
+        salt: Joi.string().trim(false),
+        password: Joi.string().trim(false).required(),
       }),
       'Invalid User: '
     );

package/src/index.ts

@@ -11,10 +11,12 @@ export { Group };
 
 import Tilmeld from './Tilmeld';
 export { Tilmeld };
-export default Tilmeld;
 
 export * from './Tilmeld.types';
 
+import tilmeldJoiProps from './tilmeldJoiProps';
+export { tilmeldJoiProps };
+
 export * from './User';
 import User from './User';
 export { User };

package/src/tilmeldJoiProps.ts

@@ -0,0 +1,46 @@
+import { TilmeldAccessLevels } from '@nymphjs/nymph';
+import Joi from 'joi';
+
+import User from './User';
+import Group from './Group';
+
+export default {
+  user: Joi.object().instance(User),
+  group: Joi.object().instance(Group),
+  acUser: Joi.number().valid(
+    TilmeldAccessLevels.NO_ACCESS,
+    TilmeldAccessLevels.READ_ACCESS,
+    TilmeldAccessLevels.WRITE_ACCESS,
+    TilmeldAccessLevels.FULL_ACCESS
+  ),
+  acGroup: Joi.number().valid(
+    TilmeldAccessLevels.NO_ACCESS,
+    TilmeldAccessLevels.READ_ACCESS,
+    TilmeldAccessLevels.WRITE_ACCESS,
+    TilmeldAccessLevels.FULL_ACCESS
+  ),
+  acOther: Joi.number().valid(
+    TilmeldAccessLevels.NO_ACCESS,
+    TilmeldAccessLevels.READ_ACCESS,
+    TilmeldAccessLevels.WRITE_ACCESS,
+    TilmeldAccessLevels.FULL_ACCESS
+  ),
+  acRead: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.object().instance(User),
+      Joi.object().instance(Group)
+    )
+  ),
+  acWrite: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.object().instance(User),
+      Joi.object().instance(Group)
+    )
+  ),
+  acFull: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.object().instance(User),
+      Joi.object().instance(Group)
+    )
+  ),
+};