Core

// Return Application Server Configuration Object (Calling Blackrock As A Dependency):
const initObject = { config: amendedConfigData}
require('is-blackrock').init(initObject)
  .then(function(core) {
    const log = req.core.module('logger').log;
    const config = core.cfg();
    log('debug', 'My App > Message - ' + config.core.banner, {}, 'MY_APP_SENDING_CONFIG_BANNER');
    // Output: 'Blackrock Application Server (Default)' (In Console)
  });

// Updates the live configuration of the application server:
require('is-blackrock').init()
  .then(function(core) {
    const result = core.cfg.update({'test': 'value'});
    if(result) console.log('Updated');
    else console.log('Update Failed');
  });

// Return Application Server Configuration Object (Calling Blackrock As A Dependency):
require('is-blackrock').init()
  .then(function(core) {
    const log = core.module('logger).log;
    const appBasePath = core.fetchBasePath('apps');
    log('debug', 'My App > App Base Path Is ' + appBasePath, {}, 'MY_APP_BASE_PATH');
    // Output: 'App Base Path Is /home/alice/my-local-swarm/apps' (In Console)
  });

// Return Application Server Configuration Object (From App Controller. In - Say, a Stand-Alone Setup):
const ctrl = function() {};
ctrl.get = function(req, res) {
  const log = req.core.module('logger).log;
  const appBasePath = req.core.fetchBasePath('apps');
  log('debug', 'My App > App Base Path Is ' + appBasePath, {}, 'MY_APP_BASE_PATH');
  // Output: 'App Base Path Is /opt/blackrock/apps' (In Console, Stand-Alone Application Server Mode)
}

const config = core.cfg();
const coreProxyInstance = core.getCoreProxy(config['app-engine'].allow);

// Initialise the Application Server (Not Available to App Controllers):
require('is-blackrock').init()
  .then(function(core) {
    console.log(core.status);
    // Output: 'Active' (if server has finished initialising)
  });

// module() - Return the Module Singleton:
const logger = core.module('logger');
logger.log('debug', 'This is a test message');
// Output: 'This is a test message' will appear in the logs (incl. console if enabled)

// module.count() - Return a Count of Loaded Modules:
const moduleCount = core.module.count('modules');
log('debug', 'My App > How many modules are loaded? It's - ' + moduleCount, {}, 'MY_APP_COUNT_DEM_MODS');
// Output: 10 (or however many modules have been loaded)

// module.load() - Loads a module:
core.module.load('module', 'logger', function(err, loggerModule){
    loggerModule.log('debug', 'My App > Hello!', {}, 'LOADED_MOD');
    // Output: "My App > Hello!"
});

// module.isLoaded() - Waits until module is loaded and then fulfills a Promise:
 core.module.isLoaded('cli').then(function IsLoadedPromiseThen(cliMod) {
   cliMod.register([
     {'cmd': 'drop-acid', 'params': 'mindset=happy', 'info': 'Takes you on a wild trip', 'fn': function (params) {
       core.emit('OH_SHIT_HE_DID_IT', {'command': 'start-trip', 'params': params});
     }},
   ]);
 }).catch(function IsLoadedPromiseFail(err) {
   log('error',
       'My App > He Failed. He's now in the psych ward',
       err, 'DROP_ACID_FAIL');
 });

// module.closeAll() - Scope is that it's being executed from within Core Module Internals
core.module.closeAll();
// Output in Logs: '20201201 00:00:00 (shutdown) All Modules Have Been Terminated'

// Return Application Server's Parsed Package.json file (calling a dependency):
require('is-blackrock').init()
  .then(function(core) {
    const log = core.module('logger).log
    const pkg = core.pkg();
    log('debug', 'My App > What's in the package? It's a - ' + pkg.name, {}, 'MY_APP_THE_PACKAGE');
    // Output: "Blackrock Application Server"
  });

// Return Application Server's Parsed Package.json file (From App Controller)
const ctrl = function() {};
ctrl.get = function(req, res) {
  const log = req,core.module('logger).log
  const pkg = req.core.pkg();
  log('debug', 'My App > What's in the package? It's a - ' + pkg.name, {}, 'MY_APP_THEIR_PACKAGE');
  // Output: "Blackrock Application Server". But take note - you must enable this within the server
  // config (config['app-engine].allow.pkg = true).
}

// Check if server is ready (Only required when calling Blackrock as a dependency):
require('is-blackrock').init()
  .then(function(core) {
    core.ready().then(function(newCore) {
      const log = newCore.module('logger).log
      log('debug', 'My App > Let's get ready to rumble!!!', {}, 'MY_APP_RUMBLING_ALL_OVER_THE_SHOP');
      // Output: "My App > Let's get ready to rumble!!!" (In Console)
    });
  });

// Shutdown the server:
require('is-blackrock').init()
  .then(function(core) {
    core.shutdown();
    // Note: The server will begin shutting down now...
  });

// Voiding (Calling Blackrock As A Dependency):
require('is-blackrock').init()
  .then(function(core) {
    core.void();
    // Output: Does Nothing. I mean... What did you expect?
  });

// Voiding (From App Controller):
const ctrl = function() {};
ctrl.get = function(req, res) {
  req.core.void();
  // Output: Yep. Still does nothing,
}