CoreIO

CoreIO is a node.js backend model/list system. It keeps data between a web-based UI and the backend in sync. Web clients can connect with REST or Sockets and each model can be connected to a database like MongoDB or Redis as well. CoreIO is the backend part of XQCore. It works pretty well together.

Requirements

Node.js >= 8.0.0

Usage

REST API

CoreIO has a simple REST API setup. It starts a web-sever automatically in the background if it's required.

A REST API setup may looks like:

import CoreIO from 'coreio'

CoreIO.api('/api/hello', {
  get() {
    return 'Hello World'
  }
})

A call of api() starts a web server in the background if none was alweady started. It registers a GET route and returns Hello World if it gets called.

CoreIO knows models or lists. Lists are simply collections of models. Each model represents a dataset.

let CoreIO = require('coreio');

let myModel = new CoreIO.Model('mymodel', self => {
  self.schema = {
    title: { type: 'string', min: 3, max: 50, required: true },
    description: { type: 'string' },
    isPublic: { type: 'boolean', default: false }
  };
});

// store data in a model
myModel.set({
  title: 'Test item',
  description: 'Some test content...'
});

// get all data from a model
let data = myModel.get();

// get a specific dataset
let title = myModel.get('title');

There are a huche set of methods o deal with the model data. See our api docs for a full list.

Routes

Core.io uses express-server under the hood. All files from you routes folder will be loaded and called automaticly.

/routes/*.js files are interpreted as a express middleware and should contain only route configurations.

// routes/inde.js
module.exports = function(CoreIO) {
  app.get('/', (req, res) => {
    res.log('Hello world');
  });
};

// models/fruits.js
let CoreIO = require('coreio');
let FruitsModel = CoreIO.createModel('fruits', {
  service: CoreIO.MongoDBService,
  schema: {
    name: { type: 'string', min: 3, max: 25, required: true }
  }
});

let FruitsModel = require('../models/fruitsModel');
// let fruitsModel = new FruitsModel();

module.exports = function(app) {
  app.get('/fruits/:name', (req, res) => {
    FruitsModel.fetch(req.params.name).then(model => {
      let data = model.get();
      if (!data) {
        res.status(404);
        res.json({ msg: 'Not found' });
      }
    }).then(err => {
      res.status(500);
      res.send(err.message);
    });
  });
};

The short way

let FruitsModel = require('../models/fruitsModel');

CoreIO.api('/fruits/:name', {
  get(ctx) {
    const model = new FruitsModel();
    return model.fetch({
      name: ctx.params.name
    });
  }
});

The super short way

let FruitsModel = require('../models/fruitsModel');

CoreIO.api('/fruits/', {
  model: FruitsModel,
  allow: ['CREATE', 'READ', 'UPDATE', 'DELETE', 'LIST']
});

is an equivalent of

let FruitsModel = require('../models/fruitsModel');

CoreIO.api('/fruits/:id', {
  get(ctx) {
    const model = new FruitsModel();
    return model.fetch({
      name: ctx.params.name
    });
  },
  put(ctx) {
    const model = new FruitsModel();
    model.fetch({
      name: ctx.params.name
    });
    model.replace(ctx.body);
    return model.update();
  },
  patch(ctx) {
    const model = new FruitsModel();
    model.fetch({
      name: ctx.params.name
    });
    model.set(ctx.body);
    return model.update();
  },
  delete(ctx) {
    const model = new FruitsModel();
    return model.destroy({
      name: ctx.params.name
    });
  }
});

CoreIO.api('/fruits/', {
  get(ctx) {
    const model = new FruitsModel();
    const list = new XQCore.List(model.name, {
      model: FruitsModel
    });
    return list.fetch();
  },
  post(ctx) {
    const model = new FruitsModel();
    model.set(ctx.body);
    return model.save();
  }
});