npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

bottlejs-express

v0.1.7

Published

Provides functions to help with the integration of Express routes/middlewares and bottlejs services

Downloads

521

Readme

bottlejs-express

Provides functions to help with the integration of Express routes/middlewares and bottlejs services.

Useful if you want to integrate the powers of Inversion of Control/Dependency Injection and Express.

Inspired in part by awilix-express.

Table of Contents

Installation

$ npm install bottlejs-express

Usage

Wrapping routes

Using a class constructor (recommended)

Pass a class constructor (must be new-able) to makeRouteInvoker along with the services you wish to have "injected" to the class constructor.

This way prevents the container from being polluted with the Route "service".

const {makeRouteInvoker} = require('bottlejs-express');

module.exports = ({bottle, expressApp}) => {
    const routeInvoker = makeRouteInvoker(bottle, PostsRouter, 'dbService', 'otherService');

    expressApp.get('/posts/:postId', routeInvoker('getById'));
    expressApp.post('/posts', routeInvoker('create'));
};

class PostsRouter {
    // Note: using TypeScript, you can do
    //  constructor(private dbService, private otherService) {}
    constructor(dbService, otherService) {
        this.dbService = dbService;
        this.otherService = otherService;
    }

    async getById(req, res, next) {
        const {postId} = req.params;
        
        try {
            await post = await this.dbService.query('SELECT ... WHERE ID ...');
            
            res.status(200).send({
                data: post,
            });
        } catch (ex) {
            res.status(500).send(`An error occured: ${ex.toString()}`);
        }
    }
}
Using a service registered on a Bottle
const {makeRouteInvoker} = require('bottlejs-express');

module.exports = ({bottle, expressApp}) => {
    bottle.factory('PostsRouter', PostsRouter);
    const routeInvoker = makeRouteInvoker(bottle, 'PostsRouter');

    expressApp.get('/posts/:postId', routeInvoker('getById'));
    expressApp.post('/posts', routeInvoker('create'));
};

function PostsRouter({dbService}) {
    const service = {
        getById,
    };

    ////

    async function getById(req, res, next) {
        const {postId} = req.params;
        
        try {
            await post = await dbService.query('SELECT ... WHERE ID ...');
            
            res.status(200).send({
                data: post,
            });
        } catch (ex) {
            res.status(500).send(`An error occured: ${ex.toString()}`);
        }
    }

    ////

    return service;
}

Wrapping middlewares

const {makeMiddlewareInvoker} = require('bottlejs-express');


module.exports = function ({expressApp, bottle}) {
    expressApp.use(makeMiddlewareInvoker(bottle, AuthorizationMiddlewareFactory));
};

function AuthorizationMiddlewareFactory({authService}) {
    return async function AuthorizationMiddleware (req, res, next) {
        try {
            const token = req.header('X-Api-Token');

            if (!authService.verify(token)) {
                return next();
            }

            req.auth.user = await authService.getUsername(token);

            next();
        } catch (ex) {
            console.error('Failed to authenticate request: ', ex);
            next();
        }
    }
}

Wrapping error middlewares

const {makeErrorMiddlewareInvoker} = require('bottlejs-express');


module.exports = function ({expressApp, bottle}) {
    expressApp.use(makeErrorMiddlewareInvoker(bottle, ErrorHandlerMiddlewareFactory));
};

function ErrorHandlerMiddlewareFactory({loggingService}) {
    return async function ErrorHandlerMiddleware (err, req, res, next) {
        loggingService.logError(err);
        
        res.status(500).send('An error occured: ' + err.toString());
    }
}

Strict mode convenience module

A convenience import is available to enable strict mode on bottlejs:

import 'bottlejs-express/strict';
require('bottlejs-express/strict');

License

(The MIT License)

Copyright (c) 2018 elunic <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.