generated from neoncitylights/typescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
generateHttpTypes.ts
154 lines (130 loc) · 5.51 KB
/
generateHttpTypes.ts
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
import fs from 'fs';
import type { Concept } from './conceptTypes';
import { makeDocBlock, makeFullDocBlock } from './docUtils';
import { getHttpMethodAsCamelCase, isForbiddenHttpRequestHeader } from './httpUtils';
import { asCamelCase, capitalize } from './stringUtils';
import { makeExcludeType, makeStringType, makeType, makeUnionType } from './typeUtils';
const READ_FILE_PATH = './build/concepts.json';
function generate(
writeFilePath: string,
conceptName: string,
endMessage: (concept: Concept) => string,
generateFn: (concept: Concept, writeStream: fs.WriteStream) => void,
) {
console.time(writeFilePath);
fs.readFile(READ_FILE_PATH, 'utf8', (err, data) => {
if(err) {
console.error(err);
return;
}
// setup file and timer
fs.truncateSync(writeFilePath, 0);
console.log(`${writeFilePath}: emptied`);
const writeStream: fs.WriteStream = fs.createWriteStream(writeFilePath, {flags:'a'});
writeStream.write(makeDocBlock([
'This file is generated by the `build/generateHttpTypes.ts` script.',
'To run it, run `npm run build`.',
'Do NOT edit this file directly.',
]) + '\n\n');
// iterate over data
const concepts: Concept[] = JSON.parse(data);
const specificConcept = concepts.find((val) => val['concept'] === conceptName) as Concept;
generateFn(specificConcept, writeStream);
// cleanup
writeStream.end();
console.timeEnd(writeFilePath);
console.log(`${writeFilePath}: ${endMessage(specificConcept)}\n`);
});
}
// Generate HTTP methods
generate(
'./src/httpMethods.ts',
'http-method',
(concepts) => `Exported ${concepts.values.length} HTTP methods`,
(concept, writeStream) => {
const httpMethodTypes: string[] = [];
// generate each individual HTTP method type
for(const conceptValue of concept.values) {
const httpMethodType = `HttpMethod${getHttpMethodAsCamelCase(conceptValue.value)}`;
httpMethodTypes.push(httpMethodType);
const httpMethodName = conceptValue.value;
const tsType = makeStringType(httpMethodType, httpMethodName);
const docBlock = makeFullDocBlock(conceptValue);
writeStream.write(`${docBlock}\n${tsType}\n\n`);
}
writeStream.write(makeUnionType('HttpMethod', httpMethodTypes) + '\n');
},
);
// Generate HTTP status codes
generate(
'./src/httpStatusCodes.ts',
'http-status-code',
(concepts) => `Exported ${concepts.values.length} HTTP status codes`,
(concept, writeStream) => {
const httpStatusCodeTypes: string[] = [];
// categories
const statusCodes100: string[] = [];
const statusCodes200: string[] = [];
const statusCodes300: string[] = [];
const statusCodes400: string[] = [];
const statusCodes500: string[] = [];
// generate each individual HTTP status code type
for(const conceptValue of concept.values) {
const httpStatusCodeType = `HttpStatusCode${asCamelCase(conceptValue.value)}`;
httpStatusCodeTypes.push(httpStatusCodeType);
const httpStatusCodeName = conceptValue.value;
const tsType = makeType(httpStatusCodeType, httpStatusCodeName, false);
const docBlock = makeFullDocBlock(conceptValue);
writeStream.write(`${docBlock}\n${tsType}\n\n`);
const statusCodeFirstDigit = httpStatusCodeName[0];
switch(statusCodeFirstDigit) {
case '1': statusCodes100.push(httpStatusCodeType); break;
case '2': statusCodes200.push(httpStatusCodeType); break;
case '3': statusCodes300.push(httpStatusCodeType); break;
case '4': statusCodes400.push(httpStatusCodeType); break;
case '5': statusCodes500.push(httpStatusCodeType); break;
}
}
// generate union type of all HTTP status codes
writeStream.write(makeUnionType('HttpInfoStatusCode', statusCodes100) + '\n\n');
writeStream.write(makeUnionType('HttpSuccessStatusCode', statusCodes200) + '\n\n');
writeStream.write(makeUnionType('HttpRedirectStatusCode', statusCodes300) + '\n\n');
writeStream.write(makeUnionType('HttpClientErrorStatusCode', statusCodes400) + '\n\n');
writeStream.write(makeUnionType('HttpServerErrorStatusCode', statusCodes500) + '\n\n');
writeStream.write(makeUnionType('HttpStatusCode', [
'HttpInfoStatusCode',
'HttpSuccessStatusCode',
'HttpRedirectStatusCode',
'HttpClientErrorStatusCode',
'HttpServerErrorStatusCode',
]) + '\n');
},
);
// Generate HTTP headers
generate(
'./src/httpHeaders.ts',
'http-header',
(concept) => `Exported ${concept.values.length} HTTP headers`,
(concept, writeStream) => {
const httpHeaderTypes: string[] = [];
const forbiddenHttpRequestHeaders: string[] = [];
// generate each individual HTTP header type
for(const conceptValue of concept.values) {
const httpHeaderType = `HttpHeader${asCamelCase(conceptValue.value)}`;
httpHeaderTypes.push(httpHeaderType);
const httpHeaderName = capitalize(conceptValue.value);
const tsType = makeStringType(httpHeaderType, httpHeaderName);
if(isForbiddenHttpRequestHeader(httpHeaderName)) {
forbiddenHttpRequestHeaders.push(httpHeaderType);
}
const docBlock = makeFullDocBlock(conceptValue);
writeStream.write(`${docBlock}\n${tsType}\n\n`);
}
// generate union type of all HTTP headers
writeStream.write(makeUnionType('HttpHeader', httpHeaderTypes) + '\n\n');
writeStream.write(makeUnionType('ForbiddenHttpRequestHeader', forbiddenHttpRequestHeaders) + '\n\n');
writeStream.write(makeUnionType('ForbiddenHttpResponseHeader', [ 'HttpHeaderSetCookie', 'HttpHeaderSetCookie2' ]) + '\n\n');
writeStream.write(makeExcludeType('HttpRequestHeader', 'HttpHeader', 'ForbiddenHttpRequestHeader') + '\n\n');
writeStream.write(makeExcludeType('HttpResponseHeader', 'HttpHeader', 'ForbiddenHttpResponseHeader') + '\n');
},
);