Ghost/ghost/session-service
Daniel Lockyer 1d6b8c1875 Stopped type declaration files from being generated
refs https://github.com/TryGhost/Team/issues/870

- currently, a handful of packages in this repo generate type
  declarations when building
- we're aiming to go more in the direction of better inline jsdoc, and
  we want to clean up all generated files and use of external types
- this commit removes the `typescript` dependency, removes the pretest
  commands that run the builds, and cleans up anywhere where we
  configure types
2021-07-14 11:51:14 +01:00
..
lib Added a CSRF bypass to enable OAuth 2021-05-14 17:38:33 +02:00
test Added a CSRF bypass to enable OAuth 2021-05-14 17:38:33 +02:00
types Added a CSRF bypass to enable OAuth 2021-05-14 17:38:33 +02:00
.eslintignore Added @tryghost/session-service module (#35) 2020-04-02 15:26:05 +02:00
.eslintrc.js Remove trailing commas from .eslintrc.js files 2020-08-04 14:48:07 +01:00
index.js Added @tryghost/session-service module (#35) 2020-04-02 15:26:05 +02:00
LICENSE 2021 2021-01-25 16:20:43 +00:00
package.json Stopped type declaration files from being generated 2021-07-14 11:51:14 +01:00
README.md Stopped type declaration files from being generated 2021-07-14 11:51:14 +01:00
tsconfig.json Stopped type declaration files from being generated 2021-07-14 11:51:14 +01:00

Session Service

Install

npm install @tryghost/session-service --save

or

yarn add @tryghost/session-service

Usage

const SessionService = require('@tryghost/session-service');

const sessionService = SessionService({
    async getSession(req, res) {
        return new Promise((resolve, reject) => {
            require('express-session')(config)(req, res, (err) => {
                if (err) {
                    reject(err);
                }
                resolve(req.session);
            })
        })
    },
    async findUserById({id}) {
        return UserModel.findUserById(id);
    },
    getOriginOfRequest(req) {
        return req.headers.origin;
    }
});

app.use(async (req, res, next) => {
    try {
        const user = await sessionService.getUserForSession(req, res);
        req.user = user;
        next();
    } catch (err) {
        next(err);
    }
});

app.post('/login', async (req, res) => {
    try {
        const user = await UserModel.verify(req.body);
        await sessionService.createSessionForUser(req, res, user);
        res.redirect('/home');
    } catch (err) {
        return next(err);
    }
});

app.post('/logout', async (req, res) => {
   try {
        await sessionService.destroyCurrentSession(req, res);
        res.redirect('/login');
    } catch (err) {
        return next(err);
    }
});

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

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

Test

  • yarn lint run just eslint
  • yarn test run lint and tests and type check

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.