// toolkit/config.js

'use strict';
module.exports = {
  // showdoc服务器，仅验证过自建showdoc服务器
  showdoc: {
    apiKey: '************', // showdoc服务器提供的api_key
    apiToken: '****************', // showdoc服务器提供的api_token
    homePage: 'https://xxx.com', // showdoc站点地址
    itemID: 1, // 对应文档项目ID
  },
  // 需要生成模型的数据表
  tables: { // 需要给哪些表构建数据模型，为空对象表示生成所有表的模型
    mainDB: [ 'app', 'users' ],
  },
  // 数据库文档配置
  dbConfig: {
    kefuSystem: { // 数据库名字
      path: '数据库', // 数据库文档存放的路径
      groups: [ '用户', '销售', '其他' ], // 数据库分组，不在分组内的数据文档将不会加入索引
    },
  },
  // 接口文档配置
  apiConfig: {
    specialParamNames: [ 'guid' ], // 特殊参数，若在接口文件中配置了同名参数时会发出警告
    groups: [ '对外接口', '对内接口', '其他' ], // 接口分组，不在分组内的接口将不会加入索引
    indexDocPath: 'API说明', // 接口索引存放的路径
    indexFileName: '接口索引', // 接口索引文件名
    docPath: '接口信息', // 接口文件存放的路径
  },
};

// toolkit/build-apidocs.js

'use strict';

const config = require('./config');
const ApiDocBuilder = require('yingedu-sachikawa-doc');
const { app } = require('egg-mock/bootstrap');

describe('toolkit/build-apidocs.js', () => {
  it('build apidocs!', async () => {
    const builder = new ApiDocBuilder(app, config);
    await builder.buildDoc();
  });
});

// toolkit/build-models.js

'use strict';

const config = require('./config');
const { ModelBuilder } = require('yingedu-sachikawa-doc');
const { app } = require('egg-mock/bootstrap');

describe('toolkit/build-models.js', () => {
  it('build models!', async () => {
    const builder = new ModelBuilder(app, config);
    await builder.genDatabaseModels(process.argv.indexOf('--doc') >= 0);
  });
});

// toolkit/apidoc-builder.js

'use strict';

const _ = require('lodash');
const { ApiDocBuilder } = require('yingedu-sachikawa-doc');

class MyApiDocBuilder extends ApiDocBuilder {
  // 获取基本信息文本
  getBaseText(obj) {
    const { method, item } = obj;
    const { ip, cache, logger, rpcAuth, auth } = item;

    // 权限文本
    let authText = '无限制';
    if (rpcAuth) {
      authText = '限内部服务器访问\n' +
      '* 允许的访问来源：' + (_.isArray(rpcAuth) ? rpcAuth.join('，') : rpcAuth);
    }
    if (auth) {
      authText = '限登陆用户访问\n' +
      '* 需要的权限：' + (auth.check ? '特殊权限' : (auth.rule || '无'));
    }

    // 拼接完整简介文本
    return '## 基本信息\n\n' +
      '* 接口：【' + method + '】' + obj.path + '\n' +
      '* 访问权限：' + authText + '\n' +
      '* IP限制：' + ((ip || rpcAuth) ? '有限制' : '无限制') + '\n' +
      '* 接口缓存：' + (cache ? '启用' : '未启用') + '\n' +
      '* 操作日志：' + (logger ? '启用' : '未启用') + '\n\n';
  }
  // 获取特殊参数文本
  getSpParamText({ item }, paramComments) {
    const { params, rpcAuth, auth } = item;
    let text = '';

    if (!rpcAuth) {
      if (params && params.TTP) {
        paramComments.TTP = { desc: '调用接口的客户端，值只能是"pc"或"mobile"' };
      } else {
        text += '| TTP | string | 必填 | - | 调用接口的客户端，值只能是"pc"或"mobile" |\n';
      }
    } else {
      text += '| secretKey | string | 必填 | - | 后端密钥，用于鉴权和确定访问来源，请勿混用不同平台的密钥 |\n';
    }
    if (auth && !rpcAuth) {
      text += '| guid | string | 必填 | - | 用户有效guid，用于鉴权 |\n';
    }

    return text;
  }
}

module.exports = MyApiDocBuilder;

/**
 * 获取用户信息
 * @group 用户管理
 * @param name 用户名，若不传入则返回所有用户的信息
 * @returns 单个用户
 * {
 *   name: '张三',
 *   age: 24,
 *   job: '程序员',
 *   salary: 5000, // 该字段可能为空，表示薪水保密
 * }
 * @returns 所有用户
 * [{
 *   name: '张三',
 *   age: 24,
 *   job: '程序员',
 *   salary: 5000, // 该字段可能为空，表示薪水保密
 * }]
 */

'use strict';

module.exports = app => {
  return {
    params: {
      name: { type: 'string', optional: true },
    },
    async controller() {
      const { state, service, success, fail } = this;
      const { name } = state.params;
      let result;
      if (name) {
        result = await service.user.find(name);
        if (!result) {
          return fail('找不到用户', app.errCode.NO_DATA);
        }
      } else {
        result = await service.user.listAll();
      }
      success(result);
    },
  };
};