Ldn-inbox-server NPM

ldn-inbox-server

An experimental LDN inbox server for Event Notification messages.

Install

yarn add ldn-inbox-server

Example

Create required directories

mkdir config inbox public

Copy an example JSON Schema as config/notification_schema.json from this project.

Start the server:

npx ldn-inbox-server start-server --port 8000

Send a demonstration Event Notifications message:

curl -X POST -H 'Content-Type: application/ld+json' --data-binary '@examples/offer.jsonld' http://localhost:8000/inbox/

Start an inbox handler with a demo handler (that creates an Accept message in the ./outbox).

npx ldn-inbox-server handle @inbox -hn ./handler/demo_notification_handler.js

Send the notifications in the outbox:

npx ldn-inbox-server handle @outbox

Environment

LOG4JS : log4js logging level
LDN_SERVER_HOST : LDN inbox host
LDN_SERVER_PORT : LDN inbox port
LDN_SERVER_INBOX_URL : LDN inbox url (path)
LDN_SERVER_INBOX_PATH : LDN inbox path
LDN_SERVER_ERROR_PATH : LDN error path
LDN_SERVER_OUTBOX_PATH : LDN outbox path
LDN_SERVER_PUBLIC_PATH : public (HTML) path
LDN_SERVER_JSON_SCHEMA : notification JSON validation schema
LDN_SERVER_BASEURL : baseurl of the LDN inbox server
LDN_SERVER_INBOX_GLOB : glob of files to process in inbox directory
LDN_SERVER_HAS_PUBLIC_INBOX : if true, then public read access is allowed on inbox

Extend

Server extensions are possible by providing custom inbox and notification handlers. E.g.

npx ldn-inbox-server handle-inbox -hn handler/demo_notification_handler.js

Or, in JavaScript:

const { handle_inbox } = require('ldn-inbox-handler');

main();

async function main() {
    await handle_inbox('./inbox', {
        'notification_handler': 'handler/worker.js' 
    });
}

with worker.js :

async function handle({path,options}) {
    //...

    return { path, options, success: true };
}

module.exports = { handle };

Hints

A handler can be started on any directory. E.g. a workflow might be:

have an "inbox" handler to validate incoming LDN messages
valid LDN messages will be saved into the "accepted" box
invalid LDN messages will be saved into the "error" box
have an "accepted" handler to process valid LDN messages
processed LDN messages will end up in the "outbox" box
invalid processing will be saved into the "error" box

ldn-inbox-server v1.2.2