hapi-context-credentials

Hapi.js plugin - Include request.auth.credentials in default view context

Install

npm install --save hapi-context-credentials

Background

For pretty much any website that has a login feature, parts of the page will be rendered conditionally based on the current user's state. Perhaps it will display their username in the header and show a logout button for logged-in users.

I usually build my sites out at first without any auth and then add auth at a later stage. If I'm using a common layout, I would later need to add something like the following to the handler of every route.

handler: function (request, reply) {
    ...
    reply.view('index', {
        credentials: request.auth.credentials
    })
}

And in my template I might have something like:

{{#if credentials.firstName}}
    <h1>Welcome back {{credentials.firstName}}!</h1>
{{else}}
    <h1>Welcome guest!</h1>
{{/if}}

This module saves the work by ensuring request.auth.credentials is included in every view context on your server, so you don't need to manually include it in your handlers.

Usage

Just register like any Hapi plugin:

...

server.register([{register: require('hapi-context-credentials')}], function (err) {
    
    if (err) {
        throw err;
    }
    
    server.start();
});

You can then output crendetials in your views.

Credit

The idea for this plugin came from https://github.com/hapijs/hapi/issues/2419. Credit to @ubaltaci for the preResponse handler idea.