@nymphjs/tilmeld 1.0.0-alpha.1 → 1.0.0-alpha.5

package/src/conf/d.ts

@@ -1,4 +1,6 @@
 import { EmailOptions } from 'email-templates';
+
+import type Tilmeld from '../Tilmeld';
 import Group, { GroupData } from '../Group';
 import User, { UserData } from '../User';
 
@@ -63,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.)
@@ -194,7 +225,7 @@ export interface Config {
   /**
    * Function to build the JWT for user sessions.
    */
-  jwtBuilder: (user: User) => string;
+  jwtBuilder: (config: Config, user: User) => string;
   /**
    * Function to verify that a JWT was signed with the secret key, vaildate its
    * data, validate the XSRF token, and extract the GUID.
@@ -205,6 +236,7 @@ export interface Config {
    * timestamp otherwise.
    */
   jwtExtract: (
+    config: Config,
     token: string,
     xsrfToken?: string
   ) => { guid: string; expire: Date } | null;
@@ -238,7 +270,11 @@ export interface Config {
    *  - lastName
    *  - email
    */
-  sendEmail: (config: EmailOptions, user: User & UserData) => Promise<boolean>;
+  sendEmail: (
+    tilmeld: Tilmeld,
+    options: EmailOptions,
+    user: User & UserData
+  ) => Promise<boolean>;
   /**
    * The address you'd like to receive a notification of registered users, if
    * any.

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,
@@ -49,32 +52,32 @@ export default {
   jwtSecret: '',
   jwtExpire: 60 * 60 * 24 * 7 * 8, // 8 weeks(ish)
   jwtRenew: 60 * 60 * 24 * 7 * 2, // 2 weeks(ish)
-  jwtBuilder: (user) => {
-    const secret = Tilmeld.config.jwtSecret;
+  jwtBuilder: (config, user) => {
+    const secret = config.jwtSecret;
     if (secret === '') {
       throw new Error('JWT secret is not configured.');
     }
 
     return jwt.sign(
       {
-        iss: Tilmeld.config.appUrl,
+        iss: config.appUrl,
         nbf: Date.now() / 1000,
         guid: user.guid,
         xsrfToken: 'TILMELDXSRF-' + nanoid(),
       },
       secret,
-      { expiresIn: Tilmeld.config.jwtExpire }
+      { expiresIn: config.jwtExpire }
     );
   },
-  jwtExtract: (token, xsrfToken?) => {
-    const secret = Tilmeld.config.jwtSecret;
+  jwtExtract: (config, token, xsrfToken?) => {
+    const secret = config.jwtSecret;
     if (secret === '') {
       throw new Error('JWT secret is not configured.');
     }
 
     try {
       const payload = jwt.verify(token, secret, {
-        issuer: Tilmeld.config.appUrl,
+        issuer: config.appUrl,
         clockTolerance: 10,
       });
 
@@ -104,12 +107,12 @@ export default {
     }
   },
   emailTemplateDir: path.join(__dirname, '..', '..', 'emails'),
-  sendEmail: async (options: EmailOptions, user: User & UserData) => {
-    const appUrl = new URL(Tilmeld.config.appUrl);
+  sendEmail: async (tilmeld, options, user) => {
+    const appUrl = new URL(tilmeld.config.appUrl);
     const email = new Email({
       message: {
         from: {
-          name: Tilmeld.config.appName,
+          name: tilmeld.config.appName,
           address: `noreply@${appUrl.hostname}`,
         },
       },
@@ -118,13 +121,13 @@ export default {
       const result = await email.send({
         ...options,
         template: path.join(
-          Tilmeld.config.emailTemplateDir,
+          tilmeld.config.emailTemplateDir,
           options.template ?? '.'
         ),
         locals: {
           // System
-          siteName: Tilmeld.config.appName,
-          siteLink: Tilmeld.config.appUrl,
+          siteName: tilmeld.config.appName,
+          siteLink: tilmeld.config.appUrl,
           // Recipient
           toUsername: user.username ?? '',
           toName: user.name ?? '',
@@ -133,13 +136,13 @@ export default {
           toEmail: user.email ?? '',
           toPhone: user.phone ?? '',
           // Current User with Tilmeld.
-          ...(User.current()
+          ...(tilmeld.User.current()
             ? {
-                username: User.current(true).username,
-                name: User.current(true).name,
-                firstName: User.current(true).nameFirst,
-                lastName: User.current(true).nameLast,
-                email: User.current(true).email,
+                username: tilmeld.User.current(true).username,
+                name: tilmeld.User.current(true).name,
+                firstName: tilmeld.User.current(true).nameFirst,
+                lastName: tilmeld.User.current(true).nameLast,
+                email: tilmeld.User.current(true).email,
               }
             : {}),
           ...options.locals,
@@ -151,32 +154,11 @@ export default {
     }
   },
   userRegisteredRecipient: null,
-  validatorGroup: (group: Group) => {
+  validatorGroup: (group) => {
     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(),
+        ...nymphJoiProps,
         groupname: Joi.string().trim(false).min(1).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
@@ -222,32 +204,11 @@ export default {
       'Invalid Group: '
     );
   },
-  validatorUser: (user: User) => {
+  validatorUser: (user) => {
     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(),
+        ...nymphJoiProps,
         username: Joi.string().trim(false).min(1).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()

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)
+    )
+  ),
+};