@nymphjs/tilmeld 1.0.0-beta.9 → 1.0.0-beta.91

package/dist/conf/d.d.ts

@@ -1,55 +1,335 @@
-import { EmailOptions, EmailConfig } from 'email-templates';
-import type Tilmeld from '../Tilmeld';
-import Group, { GroupData } from '../Group';
-import User, { UserData } from '../User';
+import type { EmailOptions, EmailConfig } from 'email-templates';
+import type Tilmeld from '../Tilmeld.js';
+import type Group from '../Group.js';
+import type { GroupData } from '../Group.js';
+import type User from '../User.js';
+import type { UserData } from '../User.js';
+/**
+ * Tilmeld Config
+ */
 export interface Config {
+    /**
+     * The name of the app. Used in emails sent to users and as the TOTP issuer.
+     */
     appName: string;
+    /**
+     * The URL of the app. Used to define cookie domain, path, and security. Must
+     * be accessible to the Tilmeld client JS. (Note, cookies are not specific to
+     * individual ports, so tokens will be sent to any port running on this host.)
+     */
     appUrl: string;
+    /**
+     * The domain of the auth cookie.
+     */
     cookieDomain: string;
+    /**
+     * The path of the auth cookie.
+     */
     cookiePath: string;
+    /**
+     * The path (with leading slash and no trailing slash) where the setup utility
+     * is accessible. This is also used for email address verification.
+     *
+     * ***************************************************************************
+     * This portion of the app will **not** check for the XSRF token, so make sure
+     * your REST endpoint is **not** under this URL.
+     * ***************************************************************************
+     */
     setupPath: string;
+    /**
+     * Allow the creation of an admin user. When a user is created, if there are
+     * no other users in the system, they will be granted all abilities.
+     */
     createAdmin: boolean;
+    /**
+     * Instead of a "username", a user logs in and is referred to by their email
+     * address. Enabling this after many users have been created can be messy.
+     * Make sure they all have email addresses first.
+     *
+     * Email usernames cannot be enabled if domain support is.
+     */
     emailUsernames: boolean;
+    /**
+     * Enable domain support.
+     *
+     * If domain support is enabled, usernames can be either bare, meaning they
+     * belong to the root domain, or can include a domain part (username@domain),
+     * meaning they belong to that domain.
+     *
+     * It also enables domain admin abilities, meaning a domain admin has the
+     * ability to create and modify users on the domain
+     * ("tilmeld/domain/example.com/admin").
+     *
+     * Once a user is created, whether it has a domain part can't be changed.
+     * However, it can be moved to a different domain.
+     *
+     * Domain support cannot be enabled if email usernames is.
+     */
+    domainSupport: boolean;
+    /**
+     * Allow users to register.
+     */
     allowRegistration: boolean;
+    /**
+     * Allow users to change their username.
+     */
     allowUsernameChange: boolean;
+    /**
+     * Whether frontend can search users. (Probably not a good idea if privacy is
+     * a concern.)
+     */
     enableUserSearch: boolean;
+    /**
+     * Whether frontend can search groups. (Probably not a good idea if privacy is
+     * 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.)
+     */
     userFields: string[];
+    /**
+     * These fields will be available for the user to fill in when they register.
+     */
     regFields: string[];
+    /**
+     * Verify users' email addresses upon registration/email change before
+     * allowing them to log in/change it.
+     */
     verifyEmail: boolean;
+    /**
+     * After the user verifies their address, redirect them to this URL.
+     */
     verifyRedirect: string;
+    /**
+     * After the user verifies an address change, redirect them to this URL.
+     */
     verifyChangeRedirect: string;
+    /**
+     * After the user cancels an address change, redirect them to this URL.
+     */
     cancelChangeRedirect: string;
+    /**
+     * Unverified users will be able to log in, but will only have the "unverified
+     * users" secondary group(s) until they verify their email. If set to false,
+     * their account will instead be disabled until they verify.
+     */
     unverifiedAccess: boolean;
+    /**
+     * Don't let users change their email address more often than this. You can
+     * enter one value and one unit of time, such as "2 weeks". Leave blank to
+     * disable rate limiting.
+     *
+     * This also controls how long a user has to cancel an email address change
+     * from a link emailed to the old address.
+     */
     emailRateLimit: string;
+    /**
+     * Allow users to recover their username and/or password through their
+     * registered email.
+     */
     pwRecovery: boolean;
+    /**
+     * How long a recovery request is valid.
+     */
     pwRecoveryTimeLimit: string;
+    /**
+     * Method used to store passwords. Salt is more secure if the database is
+     * compromised. Plain: store the password in plaintext. Digest: store the
+     * password's digest (hash). Salt: store the password's digest using a
+     * complex, unique salt.
+     *
+     * Digests are SHA-256, so a salt probably isn't necessary, but who knows.
+     *
+     * Options are: "plain", "digest", "salt"
+     */
     pwMethod: 'plain' | 'digest' | 'salt';
+    /**
+     * Whether to create a new primary group for every user who registers. This
+     * can be useful for providing access to entities the user creates.
+     *
+     * In the case this is set, the default primary group, rather than being
+     * assigned to the user, is assigned as the parent of the generated group.
+     */
     generatePrimary: boolean;
+    /**
+     * The GUID of the group above the highest groups allowed to be assigned as
+     * primary groups. True means all groups, and false means no groups.
+     */
     highestPrimary: string | boolean;
+    /**
+     * The GUID of the group above the highest groups allowed to be assigned as
+     * secondary groups. True means all groups, and false means no groups.
+     */
     highestSecondary: string | boolean;
+    /**
+     * Only these characters can be used when creating usernames and groupnames.
+     * (Doesn't apply to emails as usernames.)
+     */
     validChars: string;
+    /**
+     * When a user enters an invalid name, this message will be displayed.
+     */
     validCharsNotice: string;
+    /**
+     * Usernames and groupnames must match this regular expression. (Doesn't apply
+     * to emails as usernames.) By default, this ensures that the name begins and
+     * ends with an alphanumeric. (To allow anything, use .* inside the slashes.)
+     */
     validRegex: RegExp;
+    /**
+     * When a user enters a name that doesn't match the regex, this message will
+     * be displayed.
+     */
     validRegexNotice: string;
+    /**
+     * Email addresses must match this regular expression. By default, this uses
+     * the regex from the W3C HTML email element validation:
+     *
+     * https://html.spec.whatwg.org/multipage/input.html#email-state-(type=email)
+     */
     validEmailRegex: RegExp;
+    /**
+     * When a user enters an email that doesn't match the regex, this message will
+     * be displayed.
+     */
     validEmailRegexNotice: string;
+    /**
+     * Domains must match this regular expression. By default, this uses a regex
+     * that should match most domains:
+     *
+     * https://stackoverflow.com/a/26987741
+     */
+    validDomainRegex: RegExp;
+    /**
+     * When a user enters a domain that doesn't match the regex, this message will
+     * be displayed.
+     */
+    validDomainRegexNotice: string;
+    /**
+     * The minimum length for usernames.
+     */
+    minUsernameLength: number;
+    /**
+     * The maximum length for usernames. `Infinity` for unlimited.
+     */
     maxUsernameLength: number;
+    /**
+     * The secret used to sign the JWT.
+     */
     jwtSecret: string;
+    /**
+     * How long from current time, in seconds, the JWT token expires.
+     */
     jwtExpire: number;
+    /**
+     * How long from current time, in seconds, the JWT token for a user switch
+     * expires.
+     */
+    jwtSwitchExpire: number;
+    /**
+     * How long, in seconds, before the JWT token expires to give the user a new
+     * one.
+     */
     jwtRenew: number;
-    jwtBuilder: (config: Config, user: User) => string;
+    /**
+     * Function to build the JWT for user sessions.
+     */
+    jwtBuilder: (config: Config, user: User & UserData, switchToken?: boolean) => string;
+    /**
+     * Function to verify that a JWT was signed with the secret key, validate its
+     * data, validate the XSRF token, and extract the GUID and dates.
+     *
+     * If no XSRF token is supplied, ignore it.
+     *
+     * Return false if the JWT is not valid, or an object with GUID, issued date,
+     * and expire date otherwise.
+     */
     jwtExtract: (config: Config, token: string, xsrfToken?: string) => {
         guid: string;
+        issued: Date;
         expire: Date;
     } | null;
+    /**
+     * The absolute path to the email template directory. Used by the default
+     * email sender.
+     */
     emailTemplateDir: string;
+    /**
+     * Configure an email object to prepare for sending.
+     *
+     * You can use this, for example, for DKIM signing.
+     *
+     * See: https://github.com/forwardemail/email-templates/blob/v8.0.9/README.md#Options
+     */
     configEmail: (tilmeld: Tilmeld, options: EmailOptions, user: User & UserData) => Promise<EmailConfig>;
+    /**
+     * Send an email to a user. Uses `email-templates` by default.
+     *
+     * Check out the `emails` directory to see the templates used.
+     *
+     * In addition to the specific `locals` for each template, there are
+     * additional locals added by the default email sender:
+     *
+     * - System Information
+     *  - siteName
+     *  - siteLink
+     * - Recipient Information
+     *  - toUsername
+     *  - toName
+     *  - toFirstName
+     *  - toLastName
+     *  - toEmail
+     *  - toPhone
+     * - Current User Information (Only available if a user is logged in.)
+     *  - username
+     *  - name
+     *  - firstName
+     *  - lastName
+     *  - email
+     */
     sendEmail: (tilmeld: Tilmeld, options: EmailOptions, user: User & UserData) => Promise<boolean>;
+    /**
+     * The address you'd like to receive a notification of registered users, if
+     * any.
+     */
     userRegisteredRecipient: string | null;
-    validatorGroup: (group: Group & GroupData) => void;
-    validatorUser: (user: User & UserData) => void;
+    /**
+     * The validator used to check groups before saving.
+     */
+    validatorGroup: (tilmeld: Tilmeld, group: Group & GroupData) => void;
+    /**
+     * The validator used to check users before saving.
+     */
+    validatorUser: (tilmeld: Tilmeld, user: User & UserData) => void;
 }

package/dist/conf/d.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=d.js.map

package/dist/conf/defaults.d.ts

@@ -1,3 +1,3 @@
-import { Config } from './d';
+import type { Config } from './d.js';
 declare const _default: Config;
 export default _default;