OSNOVA

bI?

Modular Node.js server based on express and mongoose.

Install

npm:

npm i osnova [--save] 

or yarn:

yarn add osnova

Usage

const OSNOVA = require('osnova');
const osnova = OSNOVA();

osnova.start((osnova) => {
  console.log(`Hello from OSNOVA v${osnova.getVersion()}`);
});

Modules

OSNOVA is modular by its nature. Modules are just functions, that will be called on start. Every module added to OSNOVA will be called with osnova as an argument.

The very basic module:

const myCounter = ({ initialCount } = { initialCount: 0 }) => osnova => {
  let count = initialCount;

  osnova.next({ 
    counter: {
      value() { return count; },
      increment() { count++; },
      decrement() { count--; }
    }
  })    
}

osnova.next({ export }) assigns export object to osnova. So myCounter will be available as osnova.counter for other modules. Important moment here - next() is not just making available some functionality from outside. It is also an indicator that module has done his business and OSNOVA should execute next one in the queue. Every module MUST CALL osnova.next() even if it is not exporting anything. By this mechanism modules will guaranteed to be executed in an order they were added and any next module gain access to exports of all previous modules:

const osnova = OSNOVA({
  modules: [ 
    myCounter({ initialCount: 100 }), 
    moduleWithoutOptions, 
    iCanCallPreviousModulesSafely
  ]
});

osnova.start takes the module as an argument. It will be added in queue as the last one. And then module queue will be executed. So module added by start can safely use any other module.

osnova.start((osnova) => {
  const counter = osnova.counter;
  counter.increment();
  console.log(`Hello from OSNOVA v${osnova.getVersion()}. Count = ${counter.value()}`);
});

Core modules

These modules are built-in and will be called by default in the next order:

Mongo

Exports mongo object:

mongo: {
  connection // current connection to MongoDB
}

Webserver

Exports express application as express and http-server as http.
Takes Options:

• compression { boolean } if on - express will use compression middleware as the first one. default: true
• midllewares { array | object } standard express middlewares list. default: {}

Session

Exports session object:

session: {
  store, 
  key,
  secret
}

Takes options:

• store: session store. default: provided by connect-mongo and express-session
• key: session key. default: osnova.opts.core.session.key
• secret: session secret string. default: osnova.opts.core.session.secret
• connection: connection to MongoDB. default: osnova.mongo.connection

---

Core modules can be configured in OSNOVA options object core.modules branch:

const osnova = OSNOVA({
  core: {
    modules: {
      webserver: {
        use: true,
        compression: false
      },
      mongo: {
        //undefined `use` treats as true
      },
      session: false // you can just set `false` to turn off core module      
    }
  }
})

OSNOVA Options

• listen { function } will be called with osnova.http as an argument when all modules are ready. if undefined of 'default' will be used built-in standard listen.

• DEBUG { object } enable debug-messages mode for specific parts of OSNOVA. default: everything is off.

Samples

Add routes

You can't do this:

const osnova = OSNOVA(opts);

const express = osnova.express; // app - undefined
express.get('/myroute', (req, res) => { res.send('hello') });

osnova.start();

The right way is to call routing from start callback or create a module:

const myRouting = osnova => {
  const express = osnova.express;
  express.get('/route1', (req, res) => { res.send('hello from route1') });
  express.get('/route2', (req, res) => { res.send('hello from route2') });
  osnova.next();
}

const osnova = OSNOVA({
  modules: [ myRouting ],
  listen: 'default'
});

osnova.start();