1
0
mirror of https://github.com/spacebarchat/server.git synced 2024-11-10 04:32:35 +01:00
server/scripts/schema.js

95 lines
2.0 KiB
JavaScript
Raw Normal View History

2021-09-18 01:49:36 +02:00
// https://mermade.github.io/openapi-gui/#
// https://editor.swagger.io/
const path = require("path");
const fs = require("fs");
const TJS = require("typescript-json-schema");
const schemaPath = path.join(__dirname, "..", "assets", "schemas.json");
2021-09-18 01:49:36 +02:00
const settings = {
2021-09-18 01:49:36 +02:00
required: true,
ignoreErrors: true,
excludePrivate: true,
defaultNumberType: "integer",
noExtraProps: true,
2022-09-26 14:29:30 +02:00
defaultProps: false,
2021-09-18 01:49:36 +02:00
};
const compilerOptions = {
2022-09-26 14:29:30 +02:00
strictNullChecks: true,
2021-09-18 01:49:36 +02:00
};
const Excluded = [
"DefaultSchema",
"Schema",
"EntitySchema",
2021-09-18 01:49:36 +02:00
"ServerResponse",
"Http2ServerResponse",
"global.Express.Response",
"Response",
"e.Response",
"request.Response",
"supertest.Response",
// TODO: Figure out how to exclude schemas from node_modules?
"SomeJSONSchema",
"UncheckedPartialSchema",
"PartialSchema",
"UncheckedPropertiesSchema",
"PropertiesSchema",
"AsyncSchema",
"AnySchema",
2021-09-18 01:49:36 +02:00
];
function modify(obj) {
for (var k in obj) {
if (typeof obj[k] === "object" && obj[k] !== null) {
modify(obj[k]);
}
}
}
2021-09-18 01:49:36 +02:00
function main() {
2022-09-26 14:29:30 +02:00
const program = TJS.programFromConfig("tsconfig.json");
2021-09-18 01:49:36 +02:00
const generator = TJS.buildGenerator(program, settings);
if (!generator || !program) return;
2022-09-26 14:29:30 +02:00
let schemas = generator
.getUserSymbols()
.filter(
(x) =>
(x.endsWith("Schema") || x.endsWith("Response")) &&
!Excluded.includes(x),
);
2021-09-18 01:49:36 +02:00
console.log(schemas);
var definitions = {};
2021-09-18 01:49:36 +02:00
for (const name of schemas) {
const part = TJS.generateSchema(program, name, settings, [], generator);
2021-09-18 01:49:36 +02:00
if (!part) continue;
definitions = { ...definitions, [name]: { ...part } };
}
modify(definitions);
2021-10-02 15:12:47 +02:00
fs.writeFileSync(schemaPath, JSON.stringify(definitions, null, 4));
2021-09-18 01:49:36 +02:00
}
main();
function walk(dir) {
var results = [];
2021-09-18 01:49:36 +02:00
var list = fs.readdirSync(dir);
list.forEach(function (file) {
file = dir + "/" + file;
var stat = fs.statSync(file);
if (stat && stat.isDirectory()) {
/* Recurse into a subdirectory */
results = results.concat(walk(file));
} else {
if (!file.endsWith(".ts")) return;
results.push(file);
}
});
return results;
}