egg-joi-swagger/app/extend/application.js

joi + swagger + validate plugin for eggjs

'use strict';

const fs = require('fs');
const Joi = require('joi');
const path = require('path');
const assert = require('assert');
const { dejoi } = require('joi2json');
const { isPlainObject } = require('lodash');

const SCHEMA = Symbol('Application#schema');

module.exports = {
  get schema() {
    if (this[SCHEMA]) {
      return this[SCHEMA];
    }

    const baseDir = this.config.baseDir;
    const joiSwaggerConfig = this.config.joiSwagger;
    assert(baseDir, joiSwaggerConfig.routePath && joiSwaggerConfig.schemaPath);

    const schema = {
      components: {},
    };
    try {
      const defaultComponents = require('../schema/components');
      const schemaDir = path.join(baseDir, joiSwaggerConfig.schemaPath);
      try {
        let userComponents = require(schemaDir + '/components');
        userComponents = isPlainObject(userComponents) ? userComponents : userComponents(defaultComponents);
        // two level components mixed in
        Object.getOwnPropertyNames(userComponents).forEach(componentName => {
          defaultComponents[componentName] = { ...(defaultComponents[componentName] || {}), ...userComponents[componentName] };
        });
      } catch (err) {
        this.coreLogger.info('[egg-joi-swagger] dont have components');
      }
      schema.components = defaultComponents;

      // eslint-disable-next-line no-inner-declarations
      function readFiles(schemaDir, curSchema) {
        const dirFiles = fs.readdirSync(schemaDir);
        for (let i = 0; i < dirFiles.length; i++) {
          const stat = fs.statSync(schemaDir + '/' + dirFiles[i]);
          if (stat.isDirectory()) {
            curSchema[dirFiles[i]] = {};
            readFiles(schemaDir + '/' + dirFiles[i], curSchema[dirFiles[i]]);
          } else {
            const keyArr = dirFiles[i].split('.')[0].split('_');
            let key = keyArr[0];
            for (let i = 1; i < keyArr.length; i++) {
              key += (keyArr[i].substring(0, 1).toUpperCase() + keyArr[i].substring(1));
            }
            if (key === 'components') continue;
            curSchema[key] = require(schemaDir + '/' + dirFiles[i]);
            curSchema[key] = isPlainObject(curSchema[key]) ? isPlainObject(curSchema[key]) : curSchema[key](schema.components);
          }
        }
      }

      readFiles(schemaDir, schema);

      const { components } = schema;
      for (const paramType in components) {
        for (const key in components[paramType]) {
          if (components[paramType][key].isJoi) {
            components[paramType][key] = dejoi(components[paramType][key]);
          } else if (isPlainObject(components[paramType][key])) {
            components[paramType][key] = dejoi(Joi.object().keys(components[paramType][key]));
          }
        }
      }
    } catch (err) {
      this.coreLogger.error('[egg-joi-swagger] something wrong while read schemas, please check', err);
    }

    this[SCHEMA] = schema;
    return schema;
  },
};