mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-24 19:33:02 +03:00

History

Rish 216aeb572e Added request source option for magic link url no issue refs https://github.com/TryGhost/Ghost/issues/12253 Currently, Ghost uses standard query params like action, success and stripe for all actions and redirects to a site for member events. This needed to be extended to allow for portal specific query params so it doesn't overlap with specific theme handling or custom notifications. The change here adds an extra option - `requestSrc` - which can be passed when using magic link API to send a link which is passed down to `getSigninURL`, and allows the `action` param to configured to `portal-action` when magic links are sent from Portal		2020-10-29 11:59:01 +05:30
..
lib	Moved JWTTokenProvider to lib and exported from index	2020-09-18 13:20:12 +01:00
test	Fixed MagicLink tests	2020-09-18 13:23:17 +01:00
.eslintrc.js	Created @tryghost/magic-link module (#50 )	2019-09-03 11:07:03 +08:00
index.js	Added request source option for magic link url	2020-10-29 11:59:01 +05:30
LICENSE	2020	2020-01-07 19:06:08 +00:00
package.json	Published new versions	2020-09-18 13:23:54 +01:00
README.md	Moved JWTTokenProvider to lib and exported from index	2020-09-18 13:20:12 +01:00
tsconfig.json	Created @tryghost/magic-link module (#50 )	2019-09-03 11:07:03 +08:00

README.md

Magic Link

Install

npm install @tryghost/magic-link --save

yarn add @tryghost/magic-link

Usage

const crypto = require('crypto');
const nodemailer = require('nodemailer');
const MagicLink = require('@tryghost/magic-link');

async function main() {
    const jwtSecret = crypto.randomBytes(16).toString('hex');

    // https://nodemailer.com/about/#example
    const testAccount = await nodemailer.createTestAccount();

    const transporter = nodemailer.createTransport({
        host: 'smtp.ethereal.email',
        port: 587,
        secure: false, // true for 465, false for other ports
        auth: {
            user: testAccount.user, // generated ethereal user
            pass: testAccount.pass // generated ethereal password
        }
    }, {
        from: '"Your App" <signin@example.com>',
        subject: 'Whatever'
    });

    const service = MagicLink({
        tokenProvider: new MagicLink.JWTTokenProvider(jwtSecret),
        transporter,
        getSigninURL(token) {
            return `http://example.com/signin?token=${token}`
        }
    });

    /**
     *  POST /signin
     */
    const {url, info} = await service.sendMagicLink({
        email: 'test@example.com',
        tokenData: {
            id: 'some-id'
        }
    });

    // https://nodemailer.com/about/#example
    // Preview only available when sending through an Ethereal account
    console.log('Preview URL: %s', nodemailer.getTestMessageUrl(info));
    // Preview URL: https://ethereal.email/message/WaQKMgKddxQDoou...

    /**
     *  GET /signin
     */
    const data = await service.getDataFromToken(token);
    // createSomeKindOfSession(user);
}

main();

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Run

yarn dev

Test

yarn lint run just eslint
yarn test run lint and tests