mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-24 19:33:02 +03:00
07cb94d57e
- @tryghost/magic-link@0.4.2 - @tryghost/members-api@0.18.1 - @tryghost/members-ssr@0.7.5 |
||
---|---|---|
.. | ||
test | ||
.eslintrc.js | ||
index.js | ||
LICENSE | ||
package.json | ||
README.md | ||
tsconfig.json |
Magic Link
Install
npm install @tryghost/magic-link --save
or
yarn add @tryghost/magic-link
Usage
const util = require('util');
const crypto = require('crypto');
const nodemailer = require('nodemailer');
const MagicLink = require('@tryghost/magic-link');
async function main() {
const generateKeyPair = util.promisify(crypto.generateKeyPair);
const {publicKey, privateKey} = await generateKeyPair('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'pkcs1',
format: 'pem'
},
privateKeyEncoding: {
type: 'pkcs1',
format: 'pem'
}
});
// 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({
transporter,
publicKey,
privateKey,
getSigninURL(token) {
return `http://example.com/signin?token=${token}`
}
});
/**
* POST /signin
*/
const {token, info} = await service.sendMagicLink({
email: 'test@example.com',
user: {
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 user = await service.getUserFromToken(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 eslintyarn test
run lint and tests
Copyright & License
Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license.