@semic/plugin-email-code v2.2.3

@plugin/auth-email-code

A Vendure plugin allow users log in using email and verification code

Use Case

A lot of times we want visitors (aka customers) to complete their purchase order as quick as possilble. However, they usually hesitate to create a credential to a random online shop at checkout step. So we provide a way to quickly authenticate those visitors by their email and a verification code that is sent to their email.

What it does

1. Expose a GraphQL Query "requestOneTimeCode".
2. Add an authentication strategy to GraphQL mutation "authenticate".

How to use

1. Install

yarn add @semic/plugin-auth-email-code

or

npm i --save @semic/plugin-auth-email-code

2. Add the plugin to vendure-config.ts file

import { SemicAuthEmailCodePlugin } from "@semic/plugin-auth-email-code";
...
export const config: VendureConfig  = {
 ...
 plugins: [
   ...
   SemicAuthEmailCodePlugin.init(options) //see Options
 ]
}

3. Options for SemicAuthEmailCodePlugin.init

• attempts: number

  Plugin will invalidate the verification code after user's attempts.
  default: 5

• ttl: number

  Time to live
  How long the verification code is valid for.
  default: 600 (seconds)

• length: number

  How many digits/alphabets the verification code should be.
  default: 6

• includeAlphabet: boolean

  Should allow alphabet characters.
  default: false (aka digits only)

• isDev: boolean

  If true, the verification will return along with the response of query. requestOneTimeCode.
  It's for debug and testing.
  default: false

• checkCrossStrategies: boolean

  Strictly enforce unique email among all strategies

  For example:

  • One day, user "John" sign in using Google authentication with "john@gmail.com".
  • Another day, user "John" sign in using One-time passcode authenication (this plugin) with the same email.
  • This plugin will throw an error if the flag is enabled.

  default: false.
  Note: This only works if Google authentication plugin using email as an identifier

Future Updates

• Prevent cross authenticate (Ex: users use same email for GoogleAuth and SimpleAuth)