308a28d31a
refs https://github.com/TryGhost/Toolbox/issues/354 - these READMEs were migrated over from when each package was in a different repo - they also assume you're going to be publishing the packages because it mentions install instructions - only a few of them contain custom content - this commit deletes the majority of these files because they're now not useful - any that contained other instructions have been cut down |
||
---|---|---|
.. | ||
lib | ||
test | ||
.eslintrc.js | ||
index.js | ||
package.json | ||
README.md | ||
tsconfig.json |
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();