lux-framework/src/packages/application/index.js

Build scalable, Node.js-powered REST APIs with almost no code.

// @flow
import { createDefaultConfig } from '../config';
import merge from '../../utils/merge';
import type Logger from '../logger';
import type Router from '../router';
import type Server from '../server';
import type Controller from '../controller';
import type Serializer from '../serializer';
import type Database, { Model } from '../database';
import type { FreezeableMap } from '../freezeable';

import initialize from './initialize';
import type { Application$opts } from './interfaces';

/**
 * @class Application
 * @public
 */
class Application {
  /**
   * The path of `Application` instance.
   *
   * @property path
   * @type {String}
   * @public
   */
  path: string;

  /**
   * The port that an `Application` instance is listening for incomming HTTP
   * requests.
   *
   * @property port
   * @type {Number}
   * @public
   */
  port: number;

  /**
   * A reference to the `Database` instance.
   *
   * @property store
   * @type {Database}
   * @private
   */
  store: Database;

  /**
   * A reference to the `Logger` instance.
   *
   * @property logger
   * @type {Logger}
   * @private
   */
  logger: Logger;

  /**
   * A reference to the `Router` instance.
   *
   * @property router
   * @type {Router}
   * @private
   */
  router: Router;

  /**
   * A reference to the `Server` instance.
   *
   * @property server
   * @type {Server}
   * @private
   */
  server: Server;

  /**
   * A map containing each `Model` class.
   *
   * @property models
   * @type {Map}
   * @private
   */
  models: FreezeableMap<string, Class<Model>>;

  /**
   * A map containing each `Controller` instance.
   *
   * @property controllers
   * @type {Map}
   * @private
   */
  controllers: FreezeableMap<string, Controller>;

  /**
   * A map containing each `Serializer` instance.
   *
   * @property serializers
   * @type {Map}
   * @private
   */
  serializers: FreezeableMap<string, Serializer<*>>;

  /**
   * @method constructor
   * @param {Object} config
   * @return {Promise}
   * @public
   */
  constructor(opts: Application$opts): Promise<Application> {
    return initialize(this, merge(createDefaultConfig(), opts));
  }
}

export default Application;
export type { Application$opts, Application$factoryOpts } from './interfaces';