-
Notifications
You must be signed in to change notification settings - Fork 1
/
build.js
387 lines (332 loc) · 11.4 KB
/
build.js
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
import yaml from 'js-yaml';
import fs from 'fs';
import { Case } from 'change-case-all';
import { JSONSchemaFaker } from "json-schema-faker";
import { expandSchemaRefs } from './src/schemaRefs.js';
import { DeepSet } from './src/deepSet.js';
import { schemaRelativeCompare } from './src/schemaRelativeCompare.js';
import * as random from 'fast-random'
const seed = 123;
const generator = random.default(seed);
// jsf options
JSONSchemaFaker.option({ maxItems: 2, useDefaultValue: true, useExamplesValue: true, requiredOnly: true, random: generator.nextFloat });
JSONSchemaFaker.format("string64", () =>
JSONSchemaFaker.random.randexp("[0-9a-zA-Z]{10-64}")
);
JSONSchemaFaker.format("string128", () =>
JSONSchemaFaker.random.randexp("[0-9a-zA-Z]{10-64}")
);
const REQUEST = Symbol('REQUEST');
const RESPONSE = Symbol('RESPONSE');
// Add new in the future
const schemas = [
[
"cardano-conway.json#/definitions/",
JSON.parse(fs.readFileSync('./CIPs/CIP-0116/cardano-conway.json').toString())
],
[
"cardano-babbage.json#/definitions/",
JSON.parse(fs.readFileSync('./CIPs/CIP-0116/cardano-babbage.json').toString())
],
[
"query-layer.json#/definitions/",
JSON.parse(fs.readFileSync('./query-layer.json').toString())
]
];
/*
---- Helpers ----
*/
const prettyJSON = (json) => JSON.stringify(json, null, 2)
const buildTitle = (endpoint, operation, type) => {
return endpoint + (
operation == 'latest' ? ' (latest)' :
operation == 'submit' ? ' submission' :
' by ' + operation
) + (
type === REQUEST ? ' (request)' :
type === RESPONSE ? ' (response)' :
''
);
};
const buildAnyOfSchema = (alternatives) => alternatives.length == 1 ? alternatives[0] : ({ anyOf: alternatives });
const makeAnyOfAlternatives = (type) => {
// We treat Address specially as conway simply removes one type of address from the spec
// We only apply this optimisation when the only schemas are babbage and conway (plus the query-layer schema)
// in order to not introduce any mistakes in the future. This will need to be updated once
// support for a new schema is added.
if (type === 'Address' && schemas.length == 3) {
return [{
$ref: "cardano-babbage.json#/definitions/Address"
}]
}
const alternatives = [];
const altSet = new DeepSet(schemaRelativeCompare);
schemas.forEach(([ref, schema]) => {
const digest = expandSchemaRefs(schema, type);
if (digest == null || altSet.has(digest)) return;
altSet.add(digest);
alternatives.push({
"$ref": ref + type
});
});
return alternatives;
};
const schemaForType = (type) => buildAnyOfSchema(makeAnyOfAlternatives(type))
const objectMap = (obj, fn) =>
Object.fromEntries(
Object.entries(obj).map(
([k, v], i) => [k, fn(v, k, i)]
)
)
// Input is the request/response type used in spec.yaml which contains refs to the cardano-cip-0116 schemas
// We expand and resolve all refs in the input schema, and then specialize it to remove any choice (anyOf/oneOf).
const specialiseBody = (expanded) => {
if (expanded.properties instanceof Object) {
for (let [k, v] of Object.entries(expanded.properties)) {
expanded.properties[k] = specialiseBody(v)
}
}
if (Array.isArray(expanded.anyOf)) {
const pick = specialiseBody(expanded.anyOf[0]);
delete expanded.anyOf;
delete pick.title;
return {...expanded, ...pick};
}
if (Array.isArray(expanded.oneOf)) {
const pick = specialiseBody(expanded.oneOf[0]);
delete expanded.oneOf;
delete expanded.discriminator;
delete pick.title;
return {...expanded, ...pick};
} else return expanded;
}
// expandSchemaRefs specialised to latest schema
const expandWithLatestSchema = (prop) => {
const conwayType = expandSchemaRefs(schemas[0][1], prop);
if (conwayType != null) return conwayType;
const queryLayerType = expandSchemaRefs(schemas[2][1], prop);
if (queryLayerType != null) return queryLayerType;
throw new Error(`Unable to expandWithLatestSchema for ${prop}`)
}
// Schema corresponding to null
const nullSchema = { type: null };
// resolve all refs in the input with `expandWithLatestSchema`
const expandBody = (body) => {
if (body === null) {
return nullSchema;
} else if (typeof body === 'string') {
return expandWithLatestSchema(body);
} else if (typeof body == 'object') {
for (const [propertyName, propertyType] of Object.entries(body)) {
if (typeof propertyType == 'string') {
body[propertyName] = expandBody(propertyType);
} else if (propertyType.type == 'array') {
propertyType.items = expandBody(propertyType.items);
}
}
return body
} else { throw new Error('Unimplemented') }
}
const buildOpenApiSchemaGetParameters = (body) => {
let res = [];
if (body === null) {
// pass
} else if (typeof body == 'string') {
// processing spec `request: Foo`
res = [
{
name: Case.snake(body),
'in': 'query',
required: true,
schema: schemaForType(body)
}
];
} else if (typeof body == 'object') {
for (const [bodyProperty, bodyType] of Object.entries(body)) {
// processing spec
// ```
// request:
// foo: Foo
// bar: Bar
// ```
if (typeof bodyType == 'string') {
res.push({
name: Case.snake(bodyProperty),
'in': 'query',
required: true,
schema: schemaForType(bodyType)
});
} else if (bodyType.type == 'array') {
// TODO: figure it out if ever needed
throw new Error('array in a GET parameter is not supported yet');
} else {
throw new Error('unknown requestType ' + body);
}
}
} else {
throw new Error('Unknown request layout in spec.yaml');
}
return res;
};
const buildObjectSchema = (endpoint, operation, body, type) => {
let schemaObj = {
title: buildTitle(endpoint, operation, type),
type: 'object',
properties: {}
};
if (body === null) {
return schemaObj;
} else if (typeof body == 'string') {
delete schemaObj.properties;
schemaObj = { ...schemaObj, ...schemaForType(body) };
} else for (const [propertyName, propertyType] of Object.entries(body)) {
if (typeof propertyType == 'string') {
schemaObj.properties[propertyName] = schemaForType(propertyType);
} else if (propertyType.type == 'array') {
schemaObj.properties[propertyName] = {
type: 'array',
items: schemaForType(propertyType.items)
};
} else {
throw new Error('unknown requestType ' + body);
}
}
return schemaObj;
};
// Function to convert parsed YAML to OpenAPI format
const convertToSchemas = (endpoints) => {
const definitions = {};
const paths = {};
Object.keys(endpoints).forEach(endpoint => {
Object.keys(endpoints[endpoint]).forEach(operation => {
const method = endpoints[endpoint][operation].method || 'get';
if (!['post', 'get'].includes(method)) {
throw new Error('unknown method ' + method);
}
const requestBody = endpoints[endpoint][operation].request;
const requestSchema = buildObjectSchema(endpoint, operation, requestBody, REQUEST);
definitions[endpoint + '/' + operation + ':request'] = requestSchema;
const responseBody = endpoints[endpoint][operation].response;
const responseSchema = buildObjectSchema(endpoint, operation, responseBody, RESPONSE);
definitions[endpoint + '/' + operation + ':response'] = responseSchema;
paths[`/${endpoint}/${operation}`] = {
[method]: {
summary: buildTitle(endpoint, operation, REQUEST),
responses: {
'404': {
description: 'Item not found'
},
'200': {
description: 'Successful response',
content: {
'application/json': {
schema: responseSchema,
},
},
},
},
},
};
if (method == 'get') {
const parameters = buildOpenApiSchemaGetParameters(requestBody);
paths[`/${endpoint}/${operation}`].get.parameters = parameters;
} else if (method == 'post') {
paths[`/${endpoint}/${operation}`].post.requestBody = {
content: {
'application/json': {
schema: requestSchema,
},
},
};
}
});
});
const schema = {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "cardano-query-layer.json",
"title": "Cardano Query Layer types",
definitions
};
const openApiSchema = {
openapi: '3.1.0',
info: {
title: 'Cardano Query Layer Specification',
version: '1.0.0',
},
paths,
components: {
schemas: Object.fromEntries(schemas.map(([id, json]) => {
return [
id.split('#')[0], // `cardano-babbage.json#/definitions` -> `cardano-babbage.json`
json
];
}))
}
};
return [schema, openApiSchema];
};
const titleCase = (str) => Case.title(str.split('_').join(' '))
const generateMD = (endpoints) => {
let res = '';
const baseNesting = '####'
const addMDLine = (line = '') => {
res += `\n${line}`;
}
const wrapCode = (code) => {
addMDLine(`\`\`\`\n${code}\n\`\`\``);
}
const wrapCollapsibleCode = (summary, str) => {
addMDLine('<details>');
addMDLine(`<summary>${summary}: </summary>`);
addMDLine();
wrapCode(str)
addMDLine('</details>');
}
for (const endpoint of Object.keys(endpoints)) {
addMDLine(`${baseNesting} ${titleCase(endpoint)}`);
addMDLine();
for (const operation of Object.keys(endpoints[endpoint])) {
const operationDetails = endpoints[endpoint][operation];
const expandedRequestSchema = expandBody(operationDetails.request)
const specialisedRequestSchema = specialiseBody(expandedRequestSchema);
const expandedResponseSchema = expandBody(operationDetails.response)
const specialisedResponseSchema = specialiseBody(expandedResponseSchema);
addMDLine(`${baseNesting}# ${titleCase(operation)}`);
addMDLine();
addMDLine(`${operationDetails.description}`);
addMDLine();
addMDLine(`[Link to OpenApi endpoint](${pagesBaseURL}/get_${endpoint}_${operation})`);
addMDLine();
if (specialisedRequestSchema != nullSchema) {
addMDLine(`${baseNesting}## Request`);
addMDLine();
addMDLine();
wrapCollapsibleCode('Show Example', `${prettyJSON(JSONSchemaFaker.generate(specialisedRequestSchema, schemas))}`);
addMDLine();
}
if (specialisedResponseSchema != nullSchema) {
addMDLine(`${baseNesting}## Response`);
addMDLine();
addMDLine();
wrapCollapsibleCode('Show Example', `${prettyJSON(JSONSchemaFaker.generate(specialisedResponseSchema, schemas))}`);
addMDLine();
}
}
}
return res;
}
const pagesBaseURL = 'https://mlabs-haskell.github.io/query-layer-impl/index.html#/default';
/*
---- Main ----
*/
// Input YAML
const yamlInput = fs.readFileSync('./spec.yaml').toString();
// Parse YAML to JSON
const parsedYaml = yaml.load(yamlInput);
const [jsonSpec, openApiSpec] = convertToSchemas(parsedYaml.endpoints);
const markdownSpec = generateMD(parsedYaml.endpoints);
// console.log(JSON.stringify(openApiSpec, null, 2));
fs.writeFileSync('./openapi.json', prettyJSON(openApiSpec));
fs.writeFileSync('./json-rpc.json', prettyJSON(jsonSpec));
fs.writeFileSync("./cip-spec.md", markdownSpec);
console.warn(`Regenerated: openapi.json, json-rpc.json, cip-spec.md`);