@prauga/flexdoc-backend 2.9.0 → 2.9.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/framework-adapters.d.ts +13 -0
- package/dist/framework-adapters.js +42 -9
- package/dist/framework-adapters.js.map +1 -1
- package/dist/framework-adapters.test.js +8 -0
- package/dist/framework-adapters.test.js.map +1 -1
- package/dist/hono-adapter.d.ts +3 -0
- package/dist/hono-adapter.js +65 -7
- package/dist/hono-adapter.js.map +1 -1
- package/dist/hono-adapter.test.js +20 -6
- package/dist/hono-adapter.test.js.map +1 -1
- package/dist/host-execution-route.d.ts +29 -0
- package/dist/host-execution-route.js +212 -0
- package/dist/host-execution-route.js.map +1 -0
- package/dist/host-execution-route.test.d.ts +1 -0
- package/dist/host-execution-route.test.js +290 -0
- package/dist/host-execution-route.test.js.map +1 -0
- package/dist/host-execution.d.ts +168 -0
- package/dist/host-execution.js +768 -0
- package/dist/host-execution.js.map +1 -0
- package/dist/index.d.ts +3 -1
- package/dist/index.js +9 -1
- package/dist/index.js.map +1 -1
- package/dist/interfaces.d.ts +31 -0
- package/dist/page-cache.d.ts +7 -0
- package/dist/page-cache.js +35 -0
- package/dist/page-cache.js.map +1 -0
- package/dist/page-cache.test.d.ts +1 -0
- package/dist/page-cache.test.js +43 -0
- package/dist/page-cache.test.js.map +1 -0
- package/dist/renderer/flexdoc.standalone.css +1 -1
- package/dist/renderer/flexdoc.standalone.js +69 -53
- package/dist/setup.js +46 -9
- package/dist/setup.js.map +1 -1
- package/dist/setup.test.js +30 -1
- package/dist/setup.test.js.map +1 -1
- package/dist/template.d.ts +1 -0
- package/dist/template.js +11 -1
- package/dist/template.js.map +1 -1
- package/dist/template.test.js +25 -0
- package/dist/template.test.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
package/dist/setup.js
CHANGED
|
@@ -39,6 +39,9 @@ const renderer_assets_1 = require("./renderer-assets");
|
|
|
39
39
|
const auth_1 = require("./auth");
|
|
40
40
|
const http = __importStar(require("http"));
|
|
41
41
|
const https = __importStar(require("https"));
|
|
42
|
+
const host_execution_1 = require("./host-execution");
|
|
43
|
+
const host_execution_route_1 = require("./host-execution-route");
|
|
44
|
+
const page_cache_1 = require("./page-cache");
|
|
42
45
|
function createAuthMiddleware(authOptions) {
|
|
43
46
|
return (req, res, next) => {
|
|
44
47
|
const decision = (0, auth_1.authorizeFlexDocRequest)(req.headers.authorization, authOptions);
|
|
@@ -104,6 +107,7 @@ function setupFlexDoc(app, path, options) {
|
|
|
104
107
|
const { spec, specUrl, options: flexDocOptions } = options;
|
|
105
108
|
const normalizedPath = path.startsWith('/') ? path : `/${path}`;
|
|
106
109
|
const rendererBasePath = `${normalizedPath}/__flexdoc`;
|
|
110
|
+
const hostExecutionState = (0, host_execution_1.createHostExecutionState)(flexDocOptions?.tryIt?.hostExecution);
|
|
107
111
|
if (flexDocOptions?.auth) {
|
|
108
112
|
app.use(normalizedPath, createAuthMiddleware(flexDocOptions.auth));
|
|
109
113
|
}
|
|
@@ -145,18 +149,51 @@ function setupFlexDoc(app, path, options) {
|
|
|
145
149
|
}
|
|
146
150
|
return remoteSpecPromise;
|
|
147
151
|
};
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
152
|
+
const getPage = (0, page_cache_1.createCachedFlexDocPage)(async () => {
|
|
153
|
+
const resolvedSpec = await getSpec();
|
|
154
|
+
const rendererAssets = (0, renderer_assets_1.getRendererAssets)();
|
|
155
|
+
return (0, template_1.generateFlexDocHTML)(resolvedSpec, {
|
|
156
|
+
...(flexDocOptions || {}),
|
|
157
|
+
rendererBasePath,
|
|
158
|
+
rendererVersion: rendererAssets.version,
|
|
159
|
+
hostExecutionPublic: (0, host_execution_1.publicHostExecutionOptions)(hostExecutionState, rendererBasePath),
|
|
160
|
+
});
|
|
161
|
+
});
|
|
162
|
+
const sendHostResult = (res, result) => {
|
|
163
|
+
res.statusCode = result.status;
|
|
164
|
+
for (const [name, value] of Object.entries(result.headers))
|
|
165
|
+
res.setHeader(name, value);
|
|
166
|
+
return typeof res.send === 'function' ? res.send(result.body) : res.end(result.body);
|
|
167
|
+
};
|
|
168
|
+
if (hostExecutionState.enabled) {
|
|
169
|
+
app.use(`${rendererBasePath}/execute`, async (req, res) => {
|
|
170
|
+
if (String(req.method || 'POST').toUpperCase() !== 'POST')
|
|
171
|
+
return sendHostResult(res, { status: 405, headers: { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' }, body: JSON.stringify({ error: 'Method not allowed.' }) });
|
|
172
|
+
const body = req.body !== undefined ? req.body : await (0, host_execution_route_1.readNodeRequestBody)(req);
|
|
173
|
+
const docsOrigin = (0, host_execution_route_1.hostExecutionRequestOrigin)({
|
|
174
|
+
headers: req.headers || {},
|
|
175
|
+
protocol: req.protocol || (req.socket?.encrypted ? 'https' : 'http'),
|
|
156
176
|
});
|
|
177
|
+
return sendHostResult(res, await (0, host_execution_route_1.runHostExecutionRoute)({ state: hostExecutionState, spec: await getSpec(), headers: req.headers || {}, body, docsOrigin }));
|
|
178
|
+
});
|
|
179
|
+
app.use(`${rendererBasePath}/cookies`, async (req, res) => {
|
|
180
|
+
const method = String(req.method || 'GET').toUpperCase();
|
|
181
|
+
if (method !== 'GET' && method !== 'DELETE')
|
|
182
|
+
return sendHostResult(res, { status: 405, headers: { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' }, body: JSON.stringify({ error: 'Method not allowed.' }) });
|
|
183
|
+
return sendHostResult(res, (0, host_execution_route_1.runHostCookiesRoute)({ state: hostExecutionState, headers: req.headers || {}, clear: method === 'DELETE' }));
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
app.use(normalizedPath, async (req, res) => {
|
|
187
|
+
try {
|
|
188
|
+
const page = await getPage();
|
|
157
189
|
res.setHeader('Content-Type', 'text/html; charset=utf-8');
|
|
158
190
|
res.setHeader('Cache-Control', 'no-cache');
|
|
159
|
-
res.
|
|
191
|
+
res.setHeader('ETag', page.etag);
|
|
192
|
+
if ((0, page_cache_1.matchesFlexDocEtag)(req.headers?.['if-none-match'], page.etag)) {
|
|
193
|
+
res.statusCode = 304;
|
|
194
|
+
return res.end();
|
|
195
|
+
}
|
|
196
|
+
res.send(page.body);
|
|
160
197
|
}
|
|
161
198
|
catch (error) {
|
|
162
199
|
res.statusCode = 502;
|
package/dist/setup.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuFA,oCA8GC;AApMD,yCAAiD;AACjD,uDAAsD;AACtD,iCAAqE;AACrE,2CAA6B;AAC7B,6CAA+B;AAC/B,qDAAwF;AACxF,iEAAqI;AACrI,6CAA2E;AAS3E,SAAS,oBAAoB,CAAC,WAA+B;IAC3D,OAAO,CAAC,GAAQ,EAAE,GAAQ,EAAE,IAAS,EAAE,EAAE;QACvC,MAAM,QAAQ,GAAG,IAAA,8BAAuB,EAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QACjF,IAAI,QAAQ,CAAC,UAAU;YAAE,OAAO,IAAI,EAAE,CAAC;QAEvC,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;QACrB,IAAI,QAAQ,CAAC,SAAS;YAAE,GAAG,CAAC,SAAS,CAAC,kBAAkB,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC9E,OAAO,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,IAAI,yBAAyB,CAAC,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,SAAiB,EAAE,kBAAkB,GAAG,CAAC;IAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,GAAQ,CAAC;QACb,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,IAAI,KAAK,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GACV,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7E,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,KAAK,CAAC,0CAA0C,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC5E,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE;YAC3C,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC;YAE3C,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC;gBACtD,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAClB,IAAI,kBAAkB,IAAI,CAAC,EAAE,CAAC;oBAC5B,MAAM,CAAC,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC,CAAC;oBACnE,OAAO;gBACT,CAAC;gBACD,SAAS,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,kBAAkB,GAAG,CAAC,CAAC,CAAC,IAAI,CACvE,OAAO,EACP,MAAM,CACP,CAAC;gBACF,OAAO;YACT,CAAC;YAED,IAAI,UAAU,GAAG,GAAG,IAAI,UAAU,IAAI,GAAG,EAAE,CAAC;gBAC1C,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,CAAC,IAAI,KAAK,CAAC,qCAAqC,UAAU,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;gBAClF,OAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACtB,IAAI,CAAC;oBACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC9D,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,CAAC,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC,CAAC;gBAClE,CAAC;YACH,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,CAAC,UAAU,CAAC,KAAM,EAAE,GAAG,EAAE;YAC9B,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,GAAe,EACf,IAAY,EACZ,OAA2C;IAE3C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAChE,MAAM,gBAAgB,GAAG,GAAG,cAAc,YAAY,CAAC;IACvD,MAAM,kBAAkB,GAAG,IAAA,yCAAwB,EAAC,cAAc,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAI1F,IAAI,cAAc,EAAE,IAAI,EAAE,CAAC;QACzB,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,cAAc,EAAE,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE;QACjE,IAAI,CAAC;YACH,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,uCAAuC,CAAC,CAAC;YACvE,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAAC;YACtE,GAAG,CAAC,IAAI,CAAC,IAAA,mCAAiB,GAAE,CAAC,UAAU,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,2BAA2B,CAAC,CAAC;YAC3D,GAAG,CAAC,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC;QACjF,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,eAAe,EAAE,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE;QAClE,IAAI,CAAC;YACH,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,yBAAyB,CAAC,CAAC;YACzD,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAAC;YACtE,GAAG,CAAC,IAAI,CAAC,IAAA,mCAAiB,GAAE,CAAC,GAAG,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,2BAA2B,CAAC,CAAC;YAC3D,GAAG,CAAC,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC;QACjF,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,iBAAiB,GAAwB,IAAI,CAAC;IAClD,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;QACzB,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAE1B,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,iBAAiB,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrD,iBAAiB,GAAG,IAAI,CAAC;gBACzB,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,iBAAiB,CAAC;IAC3B,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,oCAAuB,EAAC,KAAK,IAAI,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,OAAO,EAAE,CAAC;QACrC,MAAM,cAAc,GAAG,IAAA,mCAAiB,GAAE,CAAC;QAC3C,OAAO,IAAA,8BAAmB,EAAC,YAAY,EAAE;YACvC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC;YACzB,gBAAgB;YAChB,eAAe,EAAE,cAAc,CAAC,OAAO;YACvC,mBAAmB,EAAE,IAAA,2CAA0B,EAAC,kBAAkB,EAAE,gBAAgB,CAAC;SACtF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,MAAkG,EAAE,EAAE;QACtI,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;QAC/B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvF,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvF,CAAC,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,UAAU,EAAE,KAAK,EAAE,GAAQ,EAAE,GAAQ,EAAE,EAAE;YAClE,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM;gBAAE,OAAO,cAAc,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,iCAAiC,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5P,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAA,0CAAmB,EAAC,GAAG,CAAC,CAAC;YAChF,MAAM,UAAU,GAAG,IAAA,iDAA0B,EAAC;gBAC5C,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE;gBAC1B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;aACrE,CAAC,CAAC;YACH,OAAO,cAAc,CAAC,GAAG,EAAE,MAAM,IAAA,4CAAqB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,OAAO,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9J,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,UAAU,EAAE,KAAK,EAAE,GAAQ,EAAE,GAAQ,EAAE,EAAE;YAClE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YACzD,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,QAAQ;gBAAE,OAAO,cAAc,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,iCAAiC,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;YAC9O,OAAO,cAAc,CAAC,GAAG,EAAE,IAAA,0CAAmB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,EAAE,CAAC,CAAC,CAAC;QACzI,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,GAAQ,EAAE,GAAQ,EAAE,EAAE;QACnD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;YAC7B,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;YAC1D,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;YAC3C,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,IAAA,+BAAkB,EAAC,GAAG,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;gBACrB,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,2BAA2B,CAAC,CAAC;YAC3D,GAAG,CAAC,GAAG,CACL,yCACE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAC3C,EAAE,CACH,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/dist/setup.test.js
CHANGED
|
@@ -39,6 +39,19 @@ describe('setupFlexDoc', () => {
|
|
|
39
39
|
expect(handlers.has('/docs')).toBe(true);
|
|
40
40
|
expect(handlers.has('/docs/__flexdoc/renderer.js')).toBe(true);
|
|
41
41
|
expect(handlers.has('/docs/__flexdoc/renderer.css')).toBe(true);
|
|
42
|
+
expect(handlers.has('/docs/__flexdoc/execute')).toBe(false);
|
|
43
|
+
expect(handlers.has('/docs/__flexdoc/cookies')).toBe(false);
|
|
44
|
+
});
|
|
45
|
+
it('only registers path-scoped handlers and leaves unrelated application routes untouched', () => {
|
|
46
|
+
(0, setup_1.setupFlexDoc)(mockApp, '/docs', { spec: { openapi: '3.0.0' } });
|
|
47
|
+
expect([...handlers.keys()].every((path) => path.startsWith('/docs'))).toBe(true);
|
|
48
|
+
expect(mockApp.use).not.toHaveBeenCalledWith(expect.any(Function));
|
|
49
|
+
});
|
|
50
|
+
it('does not register or advertise host execution unless explicitly enabled', async () => {
|
|
51
|
+
(0, setup_1.setupFlexDoc)(mockApp, '/docs', { spec: { openapi: '3.0.0' } });
|
|
52
|
+
expect(handlers.has('/docs/__flexdoc/execute')).toBe(false);
|
|
53
|
+
await handlers.get('/docs')(mockReq, mockRes);
|
|
54
|
+
expect(template_1.generateFlexDocHTML).toHaveBeenCalledWith(expect.any(Object), expect.objectContaining({ hostExecutionPublic: undefined }));
|
|
42
55
|
});
|
|
43
56
|
it('normalizes path to include a leading slash', () => {
|
|
44
57
|
(0, setup_1.setupFlexDoc)(mockApp, 'docs', { spec: { openapi: '3.0.0' } });
|
|
@@ -56,15 +69,31 @@ describe('setupFlexDoc', () => {
|
|
|
56
69
|
openapi: '3.0.0',
|
|
57
70
|
info: { title: 'Test API', version: '1.0.0' },
|
|
58
71
|
};
|
|
59
|
-
(0, setup_1.setupFlexDoc)(mockApp, '/docs', { spec });
|
|
72
|
+
(0, setup_1.setupFlexDoc)(mockApp, '/docs', { spec, options: { tryIt: { hostExecution: true } } });
|
|
60
73
|
await handlers.get('/docs')(mockReq, mockRes);
|
|
61
74
|
expect(template_1.generateFlexDocHTML).toHaveBeenCalledWith(spec, expect.objectContaining({
|
|
62
75
|
rendererBasePath: '/docs/__flexdoc',
|
|
63
76
|
rendererVersion: 'test-renderer-version',
|
|
77
|
+
hostExecutionPublic: expect.objectContaining({ available: true, endpoint: '/docs/__flexdoc/execute' }),
|
|
64
78
|
}));
|
|
65
79
|
expect(mockRes.setHeader).toHaveBeenCalledWith('Content-Type', 'text/html; charset=utf-8');
|
|
66
80
|
expect(mockRes.send).toHaveBeenCalledWith('<html>Mocked HTML</html>');
|
|
67
81
|
});
|
|
82
|
+
it('serializes the docs page once and revalidates it with an ETag', async () => {
|
|
83
|
+
(0, setup_1.setupFlexDoc)(mockApp, '/docs', { spec: { openapi: '3.0.0' } });
|
|
84
|
+
const page = handlers.get('/docs');
|
|
85
|
+
await page(mockReq, mockRes);
|
|
86
|
+
const etagCall = mockRes.setHeader.mock.calls.find(([name]) => name === 'ETag');
|
|
87
|
+
expect(etagCall?.[1]).toMatch(/^"/);
|
|
88
|
+
mockReq.headers = { 'if-none-match': etagCall?.[1] };
|
|
89
|
+
mockRes.send.mockClear();
|
|
90
|
+
mockRes.end.mockClear();
|
|
91
|
+
await page(mockReq, mockRes);
|
|
92
|
+
expect(template_1.generateFlexDocHTML).toHaveBeenCalledTimes(1);
|
|
93
|
+
expect(mockRes.statusCode).toBe(304);
|
|
94
|
+
expect(mockRes.send).not.toHaveBeenCalled();
|
|
95
|
+
expect(mockRes.end).toHaveBeenCalled();
|
|
96
|
+
});
|
|
68
97
|
it('returns a gateway error when specUrl cannot be loaded', async () => {
|
|
69
98
|
(0, setup_1.setupFlexDoc)(mockApp, '/docs', {
|
|
70
99
|
specUrl: 'file:///tmp/openapi.json',
|
package/dist/setup.test.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"setup.test.js","sourceRoot":"","sources":["../src/setup.test.ts"],"names":[],"mappings":";;AACA,mCAAuC;AACvC,yCAAiD;AACjD,uDAAsD;AAEtD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7B,mBAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,0BAA0B,CAAC;CAC3E,CAAC,CAAC,CAAC;AAEJ,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC;QAC3C,UAAU,EAAE,yBAAyB;QACrC,GAAG,EAAE,+BAA+B;QACpC,OAAO,EAAE,uBAAuB;KACjC,CAAC;CACH,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,OAAY,CAAC;IACjB,IAAI,OAAY,CAAC;IACjB,IAAI,OAAY,CAAC;IACjB,IAAI,QAAmE,CAAC;IAExE,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAErB,OAAO,GAAG;YACR,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE;gBACrD,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACjC,CAAC,CAAC;SACH,CAAC;QAEF,OAAO,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC1B,OAAO,GAAG;YACR,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;YACpB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACd,UAAU,EAAE,GAAG;SAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"setup.test.js","sourceRoot":"","sources":["../src/setup.test.ts"],"names":[],"mappings":";;AACA,mCAAuC;AACvC,yCAAiD;AACjD,uDAAsD;AAEtD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7B,mBAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,0BAA0B,CAAC;CAC3E,CAAC,CAAC,CAAC;AAEJ,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC;QAC3C,UAAU,EAAE,yBAAyB;QACrC,GAAG,EAAE,+BAA+B;QACpC,OAAO,EAAE,uBAAuB;KACjC,CAAC;CACH,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,OAAY,CAAC;IACjB,IAAI,OAAY,CAAC;IACjB,IAAI,OAAY,CAAC;IACjB,IAAI,QAAmE,CAAC;IAExE,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAErB,OAAO,GAAG;YACR,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE;gBACrD,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACjC,CAAC,CAAC;SACH,CAAC;QAEF,OAAO,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC1B,OAAO,GAAG;YACR,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;YACpB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACd,UAAU,EAAE,GAAG;SAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,GAAG,EAAE;QAC/F,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/D,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClF,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACvF,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5D,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IACpI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAG,GAAG,EAAE;QACrD,IAAA,oBAAY,EAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/D,MAAM,QAAQ,CAAC,GAAG,CAAC,6BAA6B,CAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAErE,MAAM,CAAC,mCAAiB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAC5C,cAAc,EACd,uCAAuC,CACxC,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE;SAC9C,CAAC;QACF,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAEtF,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE/C,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAC9C,IAAI,EACJ,MAAM,CAAC,gBAAgB,CAAC;YACtB,gBAAgB,EAAE,iBAAiB;YACnC,eAAe,EAAE,uBAAuB;YACxC,mBAAmB,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,yBAAyB,EAAE,CAAC;SACvG,CAAC,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAC5C,cAAc,EACd,0BAA0B,CAC3B,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;QAEpC,MAAM,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAW,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;QAC1F,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpC,OAAO,CAAC,OAAO,GAAG,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE7B,MAAM,CAAC,8BAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE;YAC7B,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE/C,MAAM,CAAC,8BAAmB,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAC5C,cAAc,EACd,2BAA2B,CAC5B,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACtC,MAAM,CAAC,gBAAgB,CAAC,uCAAuC,CAAC,CACjE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,cAAc,GAAmB;YACrC,KAAK,EAAE,MAAM;SACd,CAAC;QAEF,IAAA,oBAAY,EAAC,OAAO,EAAE,OAAO,EAAE;YAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;YAC1B,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE/C,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAC9C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAClB,MAAM,CAAC,gBAAgB,CAAC;YACtB,GAAG,cAAc;YACjB,gBAAgB,EAAE,iBAAiB;YACnC,eAAe,EAAE,uBAAuB;SACzC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/template.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ interface RenderOptions extends FlexDocOptions {
|
|
|
11
11
|
specUrl?: string;
|
|
12
12
|
rendererBasePath?: string;
|
|
13
13
|
rendererVersion?: string;
|
|
14
|
+
hostExecutionPublic?: import('./interfaces').FlexDocHostExecutionPublicOptions;
|
|
14
15
|
}
|
|
15
16
|
export declare function generateFlexDocHTML(spec: OpenAPISpec | null, options?: RenderOptions): string;
|
|
16
17
|
export {};
|
package/dist/template.js
CHANGED
|
@@ -8,12 +8,22 @@ function serializeForScript(value) {
|
|
|
8
8
|
return JSON.stringify(value).replace(/</g, '\\u003c').replace(/>/g, '\\u003e').replace(/&/g, '\\u0026').replace(/\u2028/g, '\\u2028').replace(/\u2029/g, '\\u2029');
|
|
9
9
|
}
|
|
10
10
|
function generateFlexDocHTML(spec, options = {}) {
|
|
11
|
-
const { title, description, version, customCss = '', customJs = '', favicon = '', specUrl, rendererBasePath = './__flexdoc', rendererVersion, auth: _serverOnlyAuth, ...rendererOptions } = options;
|
|
11
|
+
const { title, description, version, customCss = '', customJs = '', favicon = '', specUrl, rendererBasePath = './__flexdoc', rendererVersion, auth: _serverOnlyAuth, tryIt: serverTryIt, hostExecutionPublic, ...rendererOptions } = options;
|
|
12
12
|
const assetVersion = rendererVersion ? `?v=${encodeURIComponent(rendererVersion)}` : '';
|
|
13
13
|
const documentTitle = title || spec?.info?.title || 'API Documentation';
|
|
14
|
+
const publicTryIt = serverTryIt || hostExecutionPublic ? {
|
|
15
|
+
...(serverTryIt ? {
|
|
16
|
+
...(serverTryIt.enabled !== undefined ? { enabled: serverTryIt.enabled } : {}),
|
|
17
|
+
...(serverTryIt.defaultServer !== undefined ? { defaultServer: serverTryIt.defaultServer } : {}),
|
|
18
|
+
...(serverTryIt.credentials !== undefined ? { credentials: serverTryIt.credentials } : {}),
|
|
19
|
+
...(serverTryIt.apiClientPersistenceKey !== undefined ? { apiClientPersistenceKey: serverTryIt.apiClientPersistenceKey } : {}),
|
|
20
|
+
} : {}),
|
|
21
|
+
...(hostExecutionPublic ? { hostExecution: hostExecutionPublic } : {}),
|
|
22
|
+
} : undefined;
|
|
14
23
|
const publicOptions = {
|
|
15
24
|
contractVersion: '1',
|
|
16
25
|
...rendererOptions,
|
|
26
|
+
...(publicTryIt ? { tryIt: publicTryIt } : {}),
|
|
17
27
|
...(title ? { title } : {}),
|
|
18
28
|
...(description ? { description } : {}),
|
|
19
29
|
...(version ? { version } : {}),
|
package/dist/template.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"template.js","sourceRoot":"","sources":["../src/template.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"template.js","sourceRoot":"","sources":["../src/template.ts"],"names":[],"mappings":";;AAuBA,kDAgFC;AAzFD,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAClI,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAc;IACxC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AACtK,CAAC;AAGD,SAAgB,mBAAmB,CAAC,IAAwB,EAAE,UAAyB,EAAE;IACvF,MAAM,EACJ,KAAK,EACL,WAAW,EACX,OAAO,EACP,SAAS,GAAG,EAAE,EACd,QAAQ,GAAG,EAAE,EACb,OAAO,GAAG,EAAE,EACZ,OAAO,EACP,gBAAgB,GAAG,aAAa,EAChC,eAAe,EACf,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,WAAW,EAClB,mBAAmB,EACnB,GAAG,eAAe,EACnB,GAAG,OAAO,CAAC;IACZ,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAExF,MAAM,aAAa,GAAG,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,KAAK,IAAI,mBAAmB,CAAC;IACxE,MAAM,WAAW,GAAG,WAAW,IAAI,mBAAmB,CAAC,CAAC,CAAC;QACvD,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;YAChB,GAAG,CAAC,WAAW,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9E,GAAG,CAAC,WAAW,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAChG,GAAG,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1F,GAAG,CAAC,WAAW,CAAC,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,WAAW,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/H,CAAC,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAC,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,aAAa,GAAG;QACpB,eAAe,EAAE,GAAG;QACpB,GAAG,eAAe;QAClB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChC,CAAC;IAEF,OAAO;;;;;;WAME,UAAU,CAAC,aAAa,CAAC;IAChC,OAAO,CAAC,CAAC,CAAC,0BAA0B,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;iCACrC,UAAU,CAAC,gBAAgB,CAAC,gBAAgB,YAAY;IACrF,SAAS,CAAC,CAAC,CAAC,UAAU,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE;;;;;gCAKlB,kBAAkB,CAAC,IAAI,CAAC;oCACpB,kBAAkB,CAAC,OAAO,IAAI,IAAI,CAAC;mCACpC,kBAAkB,CAAC,aAAa,CAAC;;iBAEnD,UAAU,CAAC,gBAAgB,CAAC,eAAe,YAAY;;;;;;;;;;;;;;;;;;;;;;IAsBpE,QAAQ,CAAC,CAAC,CAAC,WAAW,QAAQ,WAAW,CAAC,CAAC,CAAC,EAAE;;QAE1C,CAAC;AACT,CAAC"}
|
package/dist/template.test.js
CHANGED
|
@@ -37,6 +37,31 @@ describe('generateFlexDocHTML', () => {
|
|
|
37
37
|
expect(html).not.toContain('super-secret-do-not-ship');
|
|
38
38
|
expect(html).not.toContain('secretKey');
|
|
39
39
|
});
|
|
40
|
+
it('never exposes host execution certificate material and only serializes explicit public capabilities', () => {
|
|
41
|
+
const html = (0, template_1.generateFlexDocHTML)(null, {
|
|
42
|
+
tryIt: {
|
|
43
|
+
hostExecution: {
|
|
44
|
+
clientCertificates: [{ id: 'private-cert', name: 'Private cert', cert: 'PEM-CERT-SECRET', key: 'PEM-KEY-SECRET', passphrase: 'pass-secret' }],
|
|
45
|
+
allowedOrigins: ['https://api.example.test'],
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
hostExecutionPublic: {
|
|
49
|
+
available: true,
|
|
50
|
+
endpoint: '/docs/__flexdoc/execute',
|
|
51
|
+
cookiesEndpoint: '/docs/__flexdoc/cookies',
|
|
52
|
+
capabilities: ['cookies', 'clientCertificates'],
|
|
53
|
+
clientCertificates: [{ id: 'private-cert', name: 'Private cert' }],
|
|
54
|
+
},
|
|
55
|
+
});
|
|
56
|
+
expect(html).not.toContain('PEM-CERT-SECRET');
|
|
57
|
+
expect(html).not.toContain('PEM-KEY-SECRET');
|
|
58
|
+
expect(html).not.toContain('pass-secret');
|
|
59
|
+
expect(html).not.toContain('allowedOrigins');
|
|
60
|
+
expect(html).toContain('"available":true');
|
|
61
|
+
expect(html).toContain('"endpoint":"/docs/__flexdoc/execute"');
|
|
62
|
+
expect(html).toContain('"id":"private-cert"');
|
|
63
|
+
expect(html).toContain('"name":"Private cert"');
|
|
64
|
+
});
|
|
40
65
|
it('should handle null spec gracefully', () => {
|
|
41
66
|
const html = (0, template_1.generateFlexDocHTML)(null);
|
|
42
67
|
expect(html).toContain('<!DOCTYPE html>');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"template.test.js","sourceRoot":"","sources":["../src/template.test.ts"],"names":[],"mappings":";;AACA,yCAAiD;AAEjD,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QAC5F,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,OAAO,GAAG,kCAAkC,CAAC;QACnD,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,OAAO,GAAmB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QACxH,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACzC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE;YACrC,gBAAgB,EAAE,iBAAiB;YACnC,eAAe,EAAE,QAAQ;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAChE,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"template.test.js","sourceRoot":"","sources":["../src/template.test.ts"],"names":[],"mappings":";;AACA,yCAAiD;AAEjD,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QAC5F,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,OAAO,GAAG,kCAAkC,CAAC;QACnD,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,OAAO,GAAmB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QACxH,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACzC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE;YACrC,gBAAgB,EAAE,iBAAiB;YACnC,eAAe,EAAE,QAAQ;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAChE,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAGH,EAAE,CAAC,oGAAoG,EAAE,GAAG,EAAE;QAC5G,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE;YACrC,KAAK,EAAE;gBACL,aAAa,EAAE;oBACb,kBAAkB,EAAE,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;oBAC7I,cAAc,EAAE,CAAC,0BAA0B,CAAC;iBAC7C;aACF;YACD,mBAAmB,EAAE;gBACnB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,yBAAyB;gBACnC,eAAe,EAAE,yBAAyB;gBAC1C,YAAY,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC;gBAC/C,kBAAkB,EAAE,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;aACnE;SACF,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC9C,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAC/D,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAC9C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,IAAI,GAAG,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|