mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-19 00:11:49 +03:00

History

Daniel Lockyer f229d1077d Fixed repository link in old packages - these are some of our first packages here and use `master` in their repository link - we've since switched the repo to use `main` but these links were not updated - this commit updates the links		2022-02-16 09:32:32 +01:00
..
lib	Ensured correct usage of @tryghost/errors everywhere	2022-02-15 12:30:36 +00:00
test	Removed trailing commas from .eslintrc.js	2021-07-14 12:04:46 +01:00
.eslintrc.js	Removed trailing commas from .eslintrc.js	2021-07-14 12:04:46 +01:00
index.js	Fixed require paths and top level js files	2021-07-15 18:15:49 +01:00
LICENSE	2022	2022-01-06 10:09:25 +00:00
package.json	Fixed repository link in old packages	2022-02-16 09:32:32 +01:00
README.md	2022	2022-01-06 10:09:25 +00: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