Skip to content
Hapi plugin for @podium/layout
Branch: master
Clone or download
trygve-lie Merge pull request #5 from podium-lib/greenkeeper/@podium/layout-3.0.3
chore(package): update @podium/layout to version 3.0.3
Latest commit ca82c4a Mar 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
lib
test
.eslintignore
.eslintrc
.gitignore
.npmrc
.prettierrc
.travis.yml
LICENSE
README.md
package.json

README.md

@podium/hapi-layout

Hapi plugin for @podium/layout.

Dependencies Build Status Greenkeeper badge Known Vulnerabilities

Module for building @podium/layout servers with hapi. For writing layouts, please see the Podium documentation.

Installation

$ npm install @podium/hapi-layout

Requirements

This module require Hapi v17 or newer.

Simple usage

Build a simple layout server including a single podlet:

const HapiLayout = require('@podium/hapi-layout');
const Layout = require('@podium/layout');
const Hapi = require('hapi');

const app = Hapi.Server({
    host: 'localhost',
    port: 7000,
});

const layout = new Layout({
    pathname: '/',
    name: 'layout',

});

const podlet = layout.client.register({
    name: 'myPodlet',
    uri: 'http://localhost:7100/manifest.json'
});

app.register({
    plugin: new HapiLayout(),
    options: layout,
});

app.route({
    method: 'GET',
    path: '/',
    handler: (request, h) => {
        const ctx = request.app.podium.context;
        return Promise.all([podlet.fetch(ctx)]).then((result) => {
            return `<html><body>${result[0]}</body></html>`
        });
    },
});

app.start();

Register plugin

The plugin is registered by passing an instance of this plugin to the hapi server .register() method together with an instance of the @podium/layout class.

app.register({
    plugin: new HapiLayout(),
    options: new Layout(),
});

Request params

On each request @podium/layout will run a set of operations, such as the @podium/context parsers, on the request. When doing so @podium/layout will write parameters to request.app.podium which is accessible inside a request handelers.

app.route({
    method: 'GET',
    path: '/',
    handler: (request, h) => {
        return request.app.podium.context;
    },
});

Its possible to pass request bound parameters to @podium/context parsers by setting an object at request.app.params.

Example: To pass a value to the @podium/context locale parser it should be set on request.app.params.locale by a extension executed previously of this extension.

License

Copyright (c) 2019 FINN.no

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.

You can’t perform that action at this time.