generated from didikmulyadi/node-package-creator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathweb.ts
195 lines (174 loc) · 5.64 KB
/
web.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
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
import { UISwitcherHTML } from '@/components/ui-switcher'
type ApiDocPlatformType = 'stoplight' | 'swagger' | 'redoc'
type ApiDocPlatformConfig = {
title: string
metaDescription: string
/**
* Only supported for Stoplight
*/
layout: string
/**
* Has UI Switcher
*/
}
class ApiDocPlatform {
#openApiPath: string
#config: ApiDocPlatformConfig
#defaultType: ApiDocPlatformType
#additionalHTML = `
${UISwitcherHTML}
`
constructor(
openApiPath: string,
defaultType: ApiDocPlatformType,
config: ApiDocPlatformConfig
) {
this.#openApiPath = openApiPath
this.#config = config
this.#defaultType = defaultType
}
#getRedocHTML = () => {
return `
<!DOCTYPE html>
<html>
<head>
<title>${this.#config.title}</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="${
this.#config.metaDescription
}" />
<link
href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
rel="stylesheet"
/>
<style>
body {
margin: 0;
padding: 0;
}
</style>
</head>
<body>
<!--
Redoc element with link to your OpenAPI definition
-->
<redoc spec-url="${this.#openApiPath}/openapi"></redoc>
${this.#additionalHTML}
<!--
Link to Redoc JavaScript on CDN for rendering standalone element
-->
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>
`
}
#getSwaggerHTML = () => {
return `
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="${this.#config.metaDescription}" />
<title>${this.#config.title}</title>
<link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
</head>
<body>
<div id="swagger-ui"></div>
${this.#additionalHTML}
<script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
<script src="https://unpkg.com/[email protected]/swagger-ui-standalone-preset.js" crossorigin></script>
<script>
window.onload = () => {
window.ui = SwaggerUIBundle({
url: '${this.#openApiPath}/openapi',
dom_id: '#swagger-ui',
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
layout: "StandaloneLayout",
});
};
</script>
</body>
</html>
`
}
#getStopLightHTML = () => {
return `
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="${this.#config.metaDescription}" />
<title>${this.#config.title}</title>
<!-- Embed elements Elements via Web Component -->
<script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css" />
<style type="text/css">
.sl-elements-api {
min-height: 100vh;
}
.sl-elements-api .sl-overflow-y-auto.sl-bg-canvas > div:first-child {
max-width: 1800px !important;
}
.sl-elements-api div[data-testid="two-column-right"] {
max-width: 1000px !important;
}
@media (max-width: 1024px) {
.sl-elements-api div[data-testid="two-column-right"] {
width: 100% !important;
margin-left: 0 !important;
}
.sl-elements-api div[data-testid="two-column-left"] {
width: 100% !important;
}
.sl-elements-api .sl-overflow-y-auto.sl-bg-canvas > div:first-child > .HttpOperation > div:nth-child(2) {
display: block !important;
}
}
</style>
</head>
<body>
<elements-api
apiDescriptionUrl="${this.#openApiPath}/openapi"
router="hash"
layout="${this.#config.layout}"
/>
${this.#additionalHTML}
</body>
</html>
`
}
/**
* A function to determine the UI based on the type
* @returns a function to generate the type
*/
#getUIBasedOnType = (type: ApiDocPlatformType) => {
if (type === 'redoc') {
return this.#getRedocHTML()
}
if (type === 'stoplight') {
return this.#getStopLightHTML()
}
if (type === 'swagger') {
return this.#getSwaggerHTML()
}
throw new Error(`UI type "${type}" is not supported yet.`)
}
/**
* A function to determine the UI based on the type
* @returns a function to generate the type
*/
determineUI = (type: ApiDocPlatformType) => {
if (type) {
return this.#getUIBasedOnType(type)
}
return this.#getUIBasedOnType(this.#defaultType)
}
}
export type { ApiDocPlatformType, ApiDocPlatformConfig }
export { ApiDocPlatform }