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
|
/**
* Docs
*/
import * as fs from 'fs';
import * as path from 'path';
import ms = require('ms');
import * as Router from 'koa-router';
import * as send from 'koa-send';
import { Context } from 'cafy';
import * as glob from 'glob';
import * as yaml from 'js-yaml';
import ObjectContext from 'cafy/built/types/object';
import config from '../../config';
import I18n from '../../misc/i18n';
import { fa } from '../../misc/fa';
import { licenseHtml } from '../../build/license';
const constants = require('../../const.json');
const docs = `${__dirname}/../../client/docs/`;
async function genVars(lang: string): Promise<{ [key: string]: any }> {
const vars = {} as { [key: string]: any };
vars['lang'] = lang;
const endpoints = glob.sync('./built/server/api/endpoints/**/*.js');
vars['endpoints'] = endpoints.map(ep => require('../../../' + ep)).filter(x => x.meta).map(x => x.meta.name);
const entities = glob.sync('./src/client/docs/api/entities/**/*.yaml');
vars['entities'] = entities.map(x => {
const _x = yaml.safeLoad(fs.readFileSync(x, 'utf-8')) as any;
return _x.name;
});
const docs = glob.sync('./src/client/docs/**/*.*.pug');
vars['docs'] = {};
docs.forEach(x => {
const [, name, lang] = x.match(/docs\/(.+?)\.(.+?)\.pug$/);
if (vars['docs'][name] == null) {
vars['docs'][name] = {
name,
title: {}
};
}
vars['docs'][name]['title'][lang] = fs.readFileSync(x, 'utf-8').match(/^h1 (.+?)\r?\n/)[1];
});
vars['kebab'] = (string: string) => string.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/\s+/g, '-').toLowerCase();
vars['config'] = config;
vars['copyright'] = constants.copyright;
vars['facss'] = fa.dom.css();
vars['license'] = licenseHtml;
const i18n = new I18n(lang);
vars['i18n'] = (key: string) => i18n.get(null, key);
return vars;
}
// WIP type
const parseParamDefinition = (key: string, param: Context) => {
return Object.assign({
name: key,
type: param.getType()
}, param.data);
};
const parsePropDefinition = (key: string, prop: any) => {
const id = prop.type.match(/^id\((.+?)\)|^id/);
const entity = prop.type.match(/^entity\((.+?)\)/);
const isObject = /^object/.test(prop.type);
const isDate = /^date/.test(prop.type);
const isArray = /\[\]$/.test(prop.type);
if (id) {
prop.kind = 'id';
prop.type = 'string';
prop.entity = id[1];
if (isArray) {
prop.type += '[]';
}
}
if (entity) {
prop.kind = 'entity';
prop.type = 'object';
prop.entity = entity[1];
if (isArray) {
prop.type += '[]';
}
}
if (isObject) {
prop.kind = 'object';
if (prop.props) {
prop.hasDef = true;
}
}
if (isDate) {
prop.kind = 'date';
prop.type = 'string';
if (isArray) {
prop.type += '[]';
}
}
if (prop.optional) {
prop.type += '?';
}
prop.name = key;
return prop;
};
const sortParams = (params: Array<{name: string}>) => {
return params;
};
// WIP type
const extractParamDefRef = (params: Context[]) => {
let defs: any[] = [];
params.forEach(param => {
if (param.data && param.data.ref) {
const props = (param as ObjectContext<any>).props;
defs.push({
name: param.data.ref,
params: sortParams(Object.keys(props).map(k => parseParamDefinition(k, props[k])))
});
const childDefs = extractParamDefRef(Object.keys(props).map(k => props[k]));
defs = defs.concat(childDefs);
}
});
return sortParams(defs);
};
const extractPropDefRef = (props: any[]) => {
let defs: any[] = [];
Object.entries(props).forEach(([k, v]) => {
if (v.props) {
defs.push({
name: k,
props: sortParams(Object.entries(v.props).map(([k, v]) => parsePropDefinition(k, v)))
});
const childDefs = extractPropDefRef(v.props);
defs = defs.concat(childDefs);
}
});
return sortParams(defs);
};
const router = new Router();
router.get('/assets/*', async ctx => {
await send(ctx, ctx.params[0], {
root: docs + '/assets/',
maxage: ms('7 days'),
immutable: true
});
});
router.get('/*/api/endpoints/*', async ctx => {
const lang = ctx.params[0];
const ep = require('../../../built/server/api/endpoints/' + ctx.params[1]).meta;
const vars = {
title: ep.name,
endpoint: ep.name,
url: {
host: config.api_url,
path: ep.name
},
desc: ep.desc,
// @ts-ignore
params: sortParams(Object.entries(ep.params).map(([k, v]) => parseParamDefinition(k, v))),
paramDefs: extractParamDefRef(Object.entries(ep.params).map(([k, v]) => v)),
res: ep.res.props ? sortParams(Object.entries(ep.res.props).map(([k, v]) => parsePropDefinition(k, v))) : null,
resDefs: null//extractPropDefRef(Object.entries(ep.res.props).map(([k, v]) => parsePropDefinition(k, v)))
};
await ctx.render('../../../../src/client/docs/api/endpoints/view', Object.assign(await genVars(lang), vars));
});
router.get('/*/api/entities/*', async ctx => {
const lang = ctx.params[0];
const entity = ctx.params[1];
const x = yaml.safeLoad(fs.readFileSync(path.resolve('./src/client/docs/api/entities/' + entity + '.yaml'), 'utf-8')) as any;
await ctx.render('../../../../src/client/docs/api/entities/view', Object.assign(await genVars(lang), {
name: x.name,
desc: x.desc,
props: sortParams(Object.entries(x.props).map(([k, v]) => parsePropDefinition(k, v))),
propDefs: extractPropDefRef(x.props)
}));
});
router.get('/*/*', async ctx => {
const lang = ctx.params[0];
const doc = ctx.params[1];
await ctx.render('../../../../src/client/docs/' + doc + '.' + lang, await genVars(lang));
});
export default router;
|
