all files / dist/satellites/ documentation.js

32.77% Statements 39/119
28.95% Branches 11/38
56.25% Functions 9/16
23.53% Lines 24/102
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
'use strict';
 
Object.defineProperty(exports, "__esModule", {
  value: true
});
 
var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; Eif ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { Eif (protoProps) defineProperties(Constructor.prototype, protoProps); Iif (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 
var _fs = require('fs');
 
var _fs2 = _interopRequireDefault(_fs);
 
var _utils = require('../utils');
 
var _utils2 = _interopRequireDefault(_utils);
 
var _handlebars = require('handlebars');
 
var _handlebars2 = _interopRequireDefault(_handlebars);
 
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
function _classCallCheck(instance, Constructor) { Iif (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
var DocumentationGenerator = function () {
 
  /**
   * Constructor.
   *
   * @param api
   */
 
 
  /**
   * Docs folder path.
   *
   * @type {string}
   */
 
  function DocumentationGenerator(api) {
    _classCallCheck(this, DocumentationGenerator);
 
    this.api = null;
    this.docsFolder = '';
    this.staticFolder = '';
 
    var self = this;
 
    // save API reference object
    self.api = api;
 
    // unsure the public folder exists
    _utils2.default.createFolder(self.api.config.general.paths.public);
 
    // build docs folder path
    self.docsFolder = self.api.config.general.paths.public + '/docs';
 
    // build static folder path
    self.staticFolder = __dirname + '/../../staticFiles/docs';
  }
 
  /**
   * Get all actions who have toDocument different than false.
   *
   * @returns {{}}  Actions to generate documentation.
   * @private
   */
 
 
  /**
   * Static folder path.
   *
   * @type {string}
   */
 
 
  /**
   * API reference object.
   *
   * @type {null}
   */
 
 
  _createClass(DocumentationGenerator, [{
    key: '_getActionToGenerateDoc',
    value: function _getActionToGenerateDoc() {
      var self = this;
 
      // array to store the actions
      var actions = {};
 
      // iterate all actions
      for (var actionName in self.api.actions.actions) {
        var count = 0;
 
        actions[actionName] = {};
 
        // iterate all action versions
        for (var versionNumber in self.api.actions.actions[actionName]) {
          if (self.api.actions.actions[actionName][versionNumber].toDocument !== false) {
            count++;
            actions[actionName][versionNumber] = self.api.actions.actions[actionName][versionNumber];
          }
        }
 
        if (count === 0) {
          delete actions[actionName];
        }
      }
 
      return actions;
    }
 
    /**
     * Generate the documentation.
     */
 
  }, {
    key: 'generateDocumentation',
    value: function generateDocumentation() {
      var self = this;
 
      // remove docs directory
      _utils2.default.removeDirectory(self.docsFolder);
 
      // create the directory again
      _utils2.default.createFolder(self.docsFolder);
 
      // get actions to generate documentation
      var actions = self._getActionToGenerateDoc();
 
      // object with the template data
      var data = { actions: Object.keys(actions) };
 
      // get base template
      var source = _fs2.default.readFileSync(self.staticFolder + '/action.html').toString();
 
      // iterate all loaded actions
      for (var actionName in actions) {
        // set action name
        data.actionName = actionName;
 
        // initialize array
        data.actionVersions = [];
 
        // iterate all versions
        for (var versionNumber in actions[actionName]) {
          // get action object
          var action = self._prepareActionToPrint(actions[actionName][versionNumber]);
 
          // push the version number
          action.version = versionNumber;
 
          // push the new action to the actionVersions array
          data.actionVersions.push(action);
        }
 
        // build the template
        var template = _handlebars2.default.compile(source);
 
        // output the result to the temp folder
        _fs2.default.writeFileSync(self.docsFolder + '/action_' + actionName + '.html', template(data), 'utf8');
      }
 
      // build the index.html
      self._buildIndexFile();
 
      // copy resource files
      this._copyResourceFiles();
    }
 
    /**
     * Build the index.html file.
     *
     * @private
     */
 
  }, {
    key: '_buildIndexFile',
    value: function _buildIndexFile() {
      var self = this;
 
      // build data object
      var data = {
        actions: Object.keys(self._getActionToGenerateDoc()),
        project: {}
      };
      data.project.name = self.api.config.name;
      data.project.description = self.api.config.description;
      data.project.version = self.api.config.version;
 
      // get template source
      var source = _fs2.default.readFileSync(self.staticFolder + '/index.html').toString();
 
      // compile source
      var template = _handlebars2.default.compile(source);
 
      // save index.html file on final docs folder
      _fs2.default.writeFileSync(self.docsFolder + '/index.html', template(data), 'utf8');
    }
 
    /**
     * Prepare the action to be printed.
     *
     * @param action
     * @returns {{}}
     * @private
     */
 
  }, {
    key: '_prepareActionToPrint',
    value: function _prepareActionToPrint(action) {
      // create a new object with the data prepared to be printed
      var output = {};
 
      // action name
      output.name = action.name;
 
      // action description
      output.description = action.description;
 
      // action output example
      if (action.outputExample !== undefined) {
        output.outputExample = JSON.stringify(action.outputExample, null, 4);
      }
 
      // action inputs
      if (action.inputs !== undefined) {
        output.inputs = [];
 
        // iterate all inputs
        Object.keys(action.inputs).forEach(function (inputName) {
          var newInput = {};
          var input = action.inputs[inputName];
 
          newInput.name = inputName;
          newInput.description = input.description || 'N/A';
          newInput.default = input.default || 'N/A';
 
          newInput.validators = [];
 
          if (!(input.required === undefined || input.required === false)) {
            newInput.validators.push({ type: 'required', value: 'required' });
          }
 
          // validators
          if (typeof input.validator === 'function') {
            newInput.validators.push({ type: 'function', value: 'function' });
          } else if (input.validator instanceof RegExp) {
            newInput.validators.push({ type: 'regex', value: String(input.validator) });
          } else if (typeof input.validator === 'string') {
            // the validator string can have many validators separated by '|', we need to split them
            var validators = input.validator.split('|');
 
            for (var index in validators) {
              newInput.validators.push({ type: 'validator', value: validators[index] });
            }
          }
 
          // push the new input
          output.inputs.push(newInput);
        });
      }
 
      return output;
    }
 
    /**
     * Copy resource files to final docs folder.
     *
     * @private
     */
 
  }, {
    key: '_copyResourceFiles',
    value: function _copyResourceFiles() {
      var self = this;
      _utils2.default.copyFile(self.staticFolder + '/reset.css', self.docsFolder + '/reset.css');
      _utils2.default.copyFile(self.staticFolder + '/style.css', self.docsFolder + '/style.css');
      _utils2.default.copyFile(self.staticFolder + '/highlight.js', self.docsFolder + '/highlight.js');
    }
  }]);
 
  return DocumentationGenerator;
}();
 
/**
 * This satellite is responsible to generate the documentation
 * for all project actions.
 */
 
 
var _class = function () {
  function _class() {
    _classCallCheck(this, _class);
 
    this.loadPriority = 510;
  }
 
  /**
   * Satellite load priority.
   *
   * @type {number}
   */
 
 
  _createClass(_class, [{
    key: 'load',
 
 
    /**
     * Satellite loading function.
     *
     * @param api   API reference object.
     * @param next  Callback function.
     */
    value: function load(api, next) {
      // if the documentation generation was disabled finish now
      Eif (api.config.general.generateDocumentation !== true) {
        next();
        return;
      }
 
      // build the documentation
      new DocumentationGenerator(api).generateDocumentation();
 
      // finish the satellite loading
      next();
    }
  }]);
 
  return _class;
}();
 
exports.default = _class;
//# sourceMappingURL=documentation.js.map