accownt.d.ts

export namespace Accownt {
  export interface Account {
    hasPassword: boolean;
    hasTOTP: boolean;
    email: Accownt.User['email'];
  }

  export interface JWT {
    userId: User['id'];
    email: User['email'];
  }

  export interface User {
    /** Unix timestamp (in milliseconds!) of when they joined */
    id: number;
    email: string;
    /** Password hash or missing if the user does not use a password */
    password?: string;
    /** Have they verified their email? */
    verified: boolean;
    /** Number of failed login attempts within past 15 minutes */
    failedLogins: number;
    /** Unix timestamp of their last failed login attempt */
    lastFailedLogin: number;
    /** Secret used for generating their TOTP for Authy, etc */
    totpSecret?: string;
  }

  export namespace Env {
    export interface Common {
      /**
       * Your application's name as you want it displayed to users
       */
      NAME: string;
      /**
       * Node environment.
       */
      NODE_ENV: 'development' | 'production';
      /**
       * Can users delete their accounts? Set to `true` if `APP_DELETE_URL` is
       *  set in server's `.env` file.
       */
      CAN_DELETE?: boolean;
      /**
       * Base path (for URL) of static files
       * @example "/static/"
       */
      STATIC_PATH: string;
      /**
       * Your application's home page
       */
      APP_HOME_URL: string;
      /**
       * URL for Accownt's web client (where your users will access it)
       * @example "https://example.com/accownt"
       */
      ACCOWNT_WEB_URL: string;
      /**
       * URL for Accownt's API (accownt-server)
       * @example "https://example.com/api/accownt"
       */
      ACCOWNT_API_URL: string;
    }

    export interface Server extends Accownt.Env.Common {
      /**
       * Port the API will be hosted on
       */
      PORT: number;
      /**
       * Options for the user database (uses node-persist). All that's needed is `dir`
       * https://www.npmjs.com/package/node-persist#async-initoptions-callback
       */
      STORAGE: any;
      /**
       * This is the shared HS256 key which will be used by Accownt to sign JSON Web
       *  Tokens which your app will then verify using the same key
       */
      JWT_KEY: string;
      /**
       * Merged into nodemailer's `transporter.sendMail()`
       * https://nodemailer.com/usage/#sending-mail
       */
      SMTP_MAIL: any;
      /**
       * For Jest tests. Keep this as such so the TypeScript compiler is happy
       */
      TEST_STORAGE: any;
      /**
       * Absolute path for accownt-web.
       * @example "/path/to/accownt/web"
       */
      WEB_DIRECTORY: string;
      /**
       * Used by `nodemailer.createTransport()`
       * https://nodemailer.com/smtp/
       */
      SMTP_TRANSPORT: any;
      /**
       * Your secret reCAPTCHA key. Leave empty if you don't want reCAPTCHA verification
       */
      RECAPTCHA_KEY?: string;
      /**
       * How long until expiry of the main JWT that is saved to a cookie and passed
       *  to your application. Eg: `60 | "2 days" | "10h" | "7d"`. A numeric value is
       *  interpreted as a seconds count. If you use a string be sure you provide the
       *  time units (days, hours, etc).
       */
      JWT_EXPIRES_IN: string;
      /**
       * The name of the cookie which the JWT will be saved to.
       */
      JWT_COOKIE_NAME: string;
      /**
       * A route in your application that allows users to delete their account.
       *  Users will be redirected to this URL after their Accownt account has
       *  been deleted. `%JWT%` is replaced with a JWT.
       * @example ""https://example.com/delete?jwt=%JWT%""
       */
      APP_DELETE_URL?: string;
      /**
       * How long until expiry of a temporary JWT. Used in passwordless login and
       *  verification emails.
       * @example "1h"
       */
      TEMP_JWT_EXPIRES_IN: string;
      /**
       * Path to a file containing the template for the text-only version of
       *  the email/account verification message sent out after registration.
       *  Instances of `%LINK%` will be replaced with the verification link.
       * @example "/path/to/templates/email-verification.txt" // Value
       * @example "Verify your account here: %LINK%" // File contents
       */
      EMAIL_VERIFICATION_TEXT_TEMPLATE?: string;
      /**
       * Path to a file containing the template for the HTML version of
       *  the email/account verification message sent out after registration.
       *  Instances of `%LINK%` will be replaced with the verification link.
       * @example "/path/to/templates/email-verification.html" // Value
       * @example '<a href="%LINK">Verify your account</a>' // File contents
       */
      EMAIL_VERIFICATION_HTML_TEMPLATE?: string;
      /**
       * Same as `EMAIL_VERIFICATION_TEXT_TEMPLATE` but for the passwordless
       *  login email.
       */
      PASSWORDLESS_LOGIN_TEXT_TEMPLATE?: string;
      /**
       * Same as `EMAIL_VERIFICATION_HTML_TEMPLATE` but for the passwordless
       *  login email.
       */
      PASSWORDLESS_LOGIN_HTML_TEMPLATE?: string;
    }

    export interface Web extends Accownt.Env.Common {
      /**
       * Port for the Webpack dev server. Only needed for Accownt developers
       */
      PORT: number;
      /**
       * Passed to Material-UI's `createMUITheme()`. Can be left an empty
       *  object. If you provide an array, the first element will be treated
       *  as a light theme and the second element as a dark theme. Make sure
       *  the `palette.type` property is set respectively.
       * https://material-ui.com/style/color/#color-tool
       * @example {}
       * @example [{"palette":{"type":"light"}},{"palette":{"type":"dark"}}]
       */
      THEME: any | any[];
      /**
       * URL to your app's favicon
       */
      FAVICON: string;
      /**
       * Used for `<meta name="description" content="..." />`
       */
      DESCRIPTION: string;
      /**
       * A route in your application that can accept authenticated users and
       *  optionally (if immediately after login) their JWT. `%JWT%` is
       *  replaced with the JWT if available, otherwise it's replaced with `0`.
       *  If your app uses the cookie Accownt sets you can ignore `%JWT%`.
       * @example "https://example.com/auth?jwt=%JWT%"
       * @example "https://example.com/members-only/%JWT%"
       */
      APP_AUTH_URL: string;
      /**
       * Your public reCAPTCHA v2 key to enable reCAPTCHA verification
       */
      RECAPTCHA_KEY?: string;
      /**
       * If you provide both light and dark themes, this is the key used for
       *  `localStorage.getItem()` to retrieve the current theme type
       *  (`"light"` or `"dark"`).
       * @example "theme"
       */
      THEME_TYPE_KEY?: string;
      /**
       * If you disable user registratin, this key shoule be true
       *
       */
      DISABLE_REGISTER?: boolean;
    }
  }
}