@prauga/flexdoc-backend 2.9.9 → 3.0.0
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/README.md +36 -179
- package/dist/flexdoc.module.js.map +1 -1
- package/dist/flexdoc.service.js.map +1 -1
- package/dist/framework-adapters.d.ts +2 -0
- package/dist/framework-adapters.js +21 -0
- package/dist/framework-adapters.js.map +1 -1
- package/dist/framework-adapters.test.js +32 -0
- package/dist/framework-adapters.test.js.map +1 -1
- package/dist/hono-adapter.d.ts +4 -0
- package/dist/hono-adapter.js +22 -0
- package/dist/hono-adapter.js.map +1 -1
- package/dist/hono-adapter.test.js +30 -6
- package/dist/hono-adapter.test.js.map +1 -1
- package/dist/host-execution-route.js.map +1 -1
- package/dist/host-execution.js +1 -1
- package/dist/host-execution.js.map +1 -1
- 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 +9 -0
- package/dist/renderer/flexdoc.standalone.css +1 -1
- package/dist/renderer/flexdoc.standalone.js +81 -72
- package/dist/runtime-intelligence-setup.test.d.ts +1 -0
- package/dist/runtime-intelligence-setup.test.js +51 -0
- package/dist/runtime-intelligence-setup.test.js.map +1 -0
- package/dist/runtime-intelligence.d.ts +58 -0
- package/dist/runtime-intelligence.js +226 -0
- package/dist/runtime-intelligence.js.map +1 -0
- package/dist/runtime-intelligence.test.d.ts +1 -0
- package/dist/runtime-intelligence.test.js +117 -0
- package/dist/runtime-intelligence.test.js.map +1 -0
- package/dist/setup.js +26 -0
- package/dist/setup.js.map +1 -1
- package/dist/template.d.ts +1 -0
- package/dist/template.js +3 -1
- package/dist/template.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,27 +1,9 @@
|
|
|
1
1
|
# FlexDoc Backend
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@prauga/flexdoc-backend)
|
|
4
|
-
[](https://www.gnu.org/licenses/agpl-3.0)
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
## Screenshots
|
|
9
|
-
|
|
10
|
-
### Light Mode
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
### Dark Mode
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
## Features
|
|
19
|
-
|
|
20
|
-
- **Modern UI**: Clean, responsive interface with dark mode support
|
|
21
|
-
- **Customizable**: Easily customize colors, typography, and layout
|
|
22
|
-
- **Interactive**: Test API endpoints directly from the documentation
|
|
23
|
-
- **Framework Agnostic**: Works with any JavaScript framework
|
|
24
|
-
- **OpenAPI Compatible**: Supports OpenAPI 3.0 specifications
|
|
6
|
+
Thin self-hosted integrations that mount the FlexDoc renderer, optional API-host execution routes, and runtime intelligence endpoints on Express, Fastify, NestJS, or Hono.
|
|
25
7
|
|
|
26
8
|
## Installation
|
|
27
9
|
|
|
@@ -31,197 +13,72 @@ npm install @prauga/flexdoc-backend
|
|
|
31
13
|
|
|
32
14
|
## Usage
|
|
33
15
|
|
|
34
|
-
###
|
|
16
|
+
### Express
|
|
35
17
|
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
// Create a new FlexDoc instance with your OpenAPI spec
|
|
41
|
-
const flexdoc = new FlexDoc({
|
|
42
|
-
spec: yourOpenAPISpec as OpenAPIObject,
|
|
43
|
-
title: 'My API Documentation',
|
|
44
|
-
description: 'Documentation for my awesome API',
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
// Generate HTML documentation
|
|
48
|
-
const html = flexdoc.generateHTML();
|
|
49
|
-
|
|
50
|
-
// Serve the documentation
|
|
51
|
-
app.get('/api/docs', (req, res) => {
|
|
52
|
-
res.send(html);
|
|
53
|
-
});
|
|
54
|
-
```
|
|
18
|
+
```javascript
|
|
19
|
+
const express = require('express');
|
|
20
|
+
const { setupExpressFlexDoc } = require('@prauga/flexdoc-backend');
|
|
21
|
+
const spec = require('./openapi.json');
|
|
55
22
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
FlexDoc is highly customizable through the `FlexDocOptions` interface:
|
|
59
|
-
|
|
60
|
-
```typescript
|
|
61
|
-
import { FlexDoc, FlexDocOptions } from '@prauga/flexdoc-backend';
|
|
62
|
-
|
|
63
|
-
const options: FlexDocOptions = {
|
|
64
|
-
// Required
|
|
65
|
-
spec: yourOpenAPISpec,
|
|
66
|
-
|
|
67
|
-
// Basic metadata
|
|
68
|
-
title: 'My API Documentation',
|
|
69
|
-
description: 'Documentation for my awesome API',
|
|
70
|
-
|
|
71
|
-
// Theme configuration
|
|
72
|
-
themeConfig: {
|
|
73
|
-
colors: {
|
|
74
|
-
primary: {
|
|
75
|
-
main: '#3b82f6',
|
|
76
|
-
light: '#eff6ff',
|
|
77
|
-
dark: '#2563eb',
|
|
78
|
-
},
|
|
79
|
-
// Additional color options...
|
|
80
|
-
},
|
|
81
|
-
typography: {
|
|
82
|
-
fontFamily: 'Inter, system-ui, sans-serif',
|
|
83
|
-
fontSize: '16px',
|
|
84
|
-
// Additional typography options...
|
|
85
|
-
},
|
|
86
|
-
},
|
|
23
|
+
const app = express();
|
|
87
24
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
url: '/terms',
|
|
95
|
-
icon: 'file-text', // Optional Lucide icon name
|
|
96
|
-
},
|
|
97
|
-
{
|
|
98
|
-
text: 'Privacy',
|
|
99
|
-
url: '/privacy',
|
|
100
|
-
},
|
|
101
|
-
],
|
|
25
|
+
setupExpressFlexDoc(app, '/docs', {
|
|
26
|
+
spec,
|
|
27
|
+
options: {
|
|
28
|
+
title: 'My API Documentation',
|
|
29
|
+
tryIt: { enabled: true },
|
|
30
|
+
runtimeIntelligence: true,
|
|
102
31
|
},
|
|
32
|
+
});
|
|
103
33
|
|
|
104
|
-
|
|
105
|
-
};
|
|
106
|
-
|
|
107
|
-
const flexdoc = new FlexDoc(options);
|
|
34
|
+
app.listen(3000);
|
|
108
35
|
```
|
|
109
36
|
|
|
110
|
-
###
|
|
111
|
-
|
|
112
|
-
#### NestJS
|
|
37
|
+
### NestJS
|
|
113
38
|
|
|
114
39
|
```typescript
|
|
115
40
|
import { NestFactory } from '@nestjs/core';
|
|
116
|
-
import {
|
|
117
|
-
import {
|
|
41
|
+
import { DocumentBuilder } from '@nestjs/swagger';
|
|
42
|
+
import { setupNestFlexDoc } from '@prauga/flexdoc-backend';
|
|
118
43
|
import { AppModule } from './app.module';
|
|
119
44
|
|
|
120
45
|
async function bootstrap() {
|
|
121
46
|
const app = await NestFactory.create(AppModule);
|
|
122
47
|
|
|
123
|
-
|
|
124
|
-
const config = new DocumentBuilder()
|
|
48
|
+
const openApiConfig = new DocumentBuilder()
|
|
125
49
|
.setTitle('My API')
|
|
126
|
-
.
|
|
127
|
-
.setVersion('1.0')
|
|
50
|
+
.setVersion('1.0.0')
|
|
128
51
|
.build();
|
|
129
|
-
const document = SwaggerModule.createDocument(app, config);
|
|
130
52
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
footer: {
|
|
137
|
-
copyright: '© 2025 My Company',
|
|
53
|
+
setupNestFlexDoc(app, '/docs', openApiConfig, {
|
|
54
|
+
options: {
|
|
55
|
+
title: 'My API Documentation',
|
|
56
|
+
tryIt: { enabled: true, hostExecution: true },
|
|
57
|
+
runtimeIntelligence: true,
|
|
138
58
|
},
|
|
139
59
|
});
|
|
140
60
|
|
|
141
|
-
// Serve FlexDoc at /api/docs
|
|
142
|
-
app.use('/api/docs', (req, res) => {
|
|
143
|
-
res.send(flexdoc.generateHTML());
|
|
144
|
-
});
|
|
145
|
-
|
|
146
61
|
await app.listen(3000);
|
|
147
62
|
}
|
|
148
63
|
bootstrap();
|
|
149
64
|
```
|
|
150
65
|
|
|
151
|
-
|
|
66
|
+
### Fastify and Hono
|
|
152
67
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
import swaggerJsdoc from 'swagger-jsdoc';
|
|
68
|
+
- `setupFastifyFlexDoc(app, path, options)` — static OpenAPI document
|
|
69
|
+
- `setupFastifySwaggerFlexDoc(app, path, options)` — document from `@fastify/swagger`
|
|
70
|
+
- `setupHonoFlexDoc(app, path, options)` — Hono without adding Hono as a dependency
|
|
157
71
|
|
|
158
|
-
|
|
72
|
+
Use `setupFlexDoc(app, path, options)` directly when you already have an Express-compatible `app.use` surface.
|
|
159
73
|
|
|
160
|
-
|
|
161
|
-
const options = {
|
|
162
|
-
definition: {
|
|
163
|
-
openapi: '3.0.0',
|
|
164
|
-
info: {
|
|
165
|
-
title: 'My API',
|
|
166
|
-
version: '1.0.0',
|
|
167
|
-
},
|
|
168
|
-
},
|
|
169
|
-
apis: ['./src/routes/*.js'],
|
|
170
|
-
};
|
|
171
|
-
const openapiSpec = swaggerJsdoc(options);
|
|
172
|
-
|
|
173
|
-
// Create FlexDoc instance
|
|
174
|
-
const flexdoc = new FlexDoc({
|
|
175
|
-
spec: openapiSpec,
|
|
176
|
-
title: 'My API Documentation',
|
|
177
|
-
});
|
|
178
|
-
|
|
179
|
-
// Serve FlexDoc
|
|
180
|
-
app.get('/api/docs', (req, res) => {
|
|
181
|
-
res.send(flexdoc.generateHTML());
|
|
182
|
-
});
|
|
183
|
-
|
|
184
|
-
app.listen(3000);
|
|
185
|
-
```
|
|
74
|
+
## Configuration
|
|
186
75
|
|
|
187
|
-
|
|
76
|
+
`FlexDocModuleOptions` requires a mount `path` and either an inline `spec` or a remote `specUrl`. Renderer behavior is configured through `options`, which mirrors the client `FlexDocRendererOptions` contract (theme, Try It, code samples, footer, optional docs-route auth, host execution, and runtime intelligence).
|
|
188
77
|
|
|
189
|
-
|
|
78
|
+
## NestJS module
|
|
190
79
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
#### Constructor
|
|
194
|
-
|
|
195
|
-
```typescript
|
|
196
|
-
constructor(options: FlexDocOptions)
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
#### Methods
|
|
200
|
-
|
|
201
|
-
- `generateHTML()`: Generates the HTML documentation
|
|
202
|
-
- `getOpenAPISpec()`: Returns the processed OpenAPI specification
|
|
203
|
-
|
|
204
|
-
### `FlexDocOptions` Interface
|
|
205
|
-
|
|
206
|
-
Configuration options for FlexDoc:
|
|
207
|
-
|
|
208
|
-
| Property | Type | Description |
|
|
209
|
-
| -------------- | ------------------------------- | -------------------------------- |
|
|
210
|
-
| `spec` | `OpenAPIObject` | The OpenAPI specification object |
|
|
211
|
-
| `title` | `string` | Documentation title |
|
|
212
|
-
| `description` | `string` | Documentation description |
|
|
213
|
-
| `themeConfig` | `ThemeConfig` | Theme configuration |
|
|
214
|
-
| `footer` | `FooterConfig` | Footer configuration |
|
|
215
|
-
| `favicon` | `string` | URL to favicon |
|
|
216
|
-
| `customCss` | `string` | Custom CSS to inject |
|
|
217
|
-
| `customJs` | `string` | Custom JavaScript to inject |
|
|
218
|
-
| `defaultTheme` | `'light' \| 'dark' \| 'system'` | Default theme mode |
|
|
219
|
-
|
|
220
|
-
## Contributing
|
|
221
|
-
|
|
222
|
-
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
80
|
+
`FlexDocModule.forRoot` / `forRootAsync` registers the same routes through Nest's HTTP adapter. `FlexDocService.generateHTML` is available for programmatic HTML generation.
|
|
223
81
|
|
|
224
82
|
## License
|
|
225
83
|
|
|
226
|
-
|
|
227
|
-
|
|
84
|
+
AGPL-3.0-or-later
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flexdoc.module.js","sourceRoot":"","sources":["../src/flexdoc.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAMwB;AACxB,uCAA+C;AAC/C,mCAAuC;AACvC,uDAAmD;
|
|
1
|
+
{"version":3,"file":"flexdoc.module.js","sourceRoot":"","sources":["../src/flexdoc.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAMwB;AACxB,uCAA+C;AAC/C,mCAAuC;AACvC,uDAAmD;AAK5C,IAAM,aAAa,qBAAnB,MAAM,aAAa;IACxB,YAC8C,OAA6B,EACxD,eAAiC;QADN,YAAO,GAAP,OAAO,CAAsB;QACxD,oBAAe,GAAf,eAAe,CAAkB;IACjD,CAAC;IAEJ,YAAY;QACV,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CACV,uEAAuE,CACxE,CAAC;YACF,OAAO;QACT,CAAC;QAGD,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;QACrD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CACV,oEAAoE,CACrE,CAAC;YACF,OAAO;QACT,CAAC;QAGD,MAAM,GAAG,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;QAGtC,IAAA,oBAAY,EAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACnC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAA6B;QAC1C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT,gCAAc;gBACd;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,QAAQ,EAAE,OAAO;iBAClB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAKnB;QACC,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT,gCAAc;gBACd;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC7B;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;CACF,CAAA;AAnEY,sCAAa;wBAAb,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;IAGN,WAAA,IAAA,eAAM,EAAC,iBAAiB,CAAC,CAAA;6CACS,sBAAe;GAHzC,aAAa,CAmEzB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flexdoc.service.js","sourceRoot":"","sources":["../src/flexdoc.service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA4C;AAE5C,yCAAiD;
|
|
1
|
+
{"version":3,"file":"flexdoc.service.js","sourceRoot":"","sources":["../src/flexdoc.service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA4C;AAE5C,yCAAiD;AAI1C,IAAM,cAAc,GAApB,MAAM,cAAc;IAEzB,YAAY,CAAC,IAAY,EAAE,UAA0B,EAAE;QACrD,OAAO,IAAA,8BAAmB,EAAC,IAA+B,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAGD,mBAAmB,CAAC,OAAe,EAAE,UAA0B,EAAE;QAC/D,OAAO,IAAA,8BAAmB,EAAC,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF,CAAA;AAVY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;GACA,cAAc,CAU1B"}
|
|
@@ -28,6 +28,8 @@ export interface FastifyLikeApplication {
|
|
|
28
28
|
hasContentTypeParser?: (contentType: string) => boolean;
|
|
29
29
|
ready?: () => Promise<unknown>;
|
|
30
30
|
swagger?: () => Record<string, unknown>;
|
|
31
|
+
printRoutes?: (options?: Record<string, unknown>) => string;
|
|
32
|
+
version?: string;
|
|
31
33
|
}
|
|
32
34
|
export interface NestLikeApplication {
|
|
33
35
|
getHttpAdapter(): {
|
|
@@ -45,6 +45,7 @@ const template_1 = require("./template");
|
|
|
45
45
|
const host_execution_1 = require("./host-execution");
|
|
46
46
|
const host_execution_route_1 = require("./host-execution-route");
|
|
47
47
|
const page_cache_1 = require("./page-cache");
|
|
48
|
+
const runtime_intelligence_1 = require("./runtime-intelligence");
|
|
48
49
|
function setupExpressFlexDoc(app, path, options) {
|
|
49
50
|
(0, setup_1.setupFlexDoc)(app, path, options);
|
|
50
51
|
}
|
|
@@ -108,6 +109,8 @@ function setupFastifyFlexDocInternal(app, path, options, specProvider) {
|
|
|
108
109
|
const auth = options.options?.auth;
|
|
109
110
|
const hostExecutionState = (0, host_execution_1.createHostExecutionState)(options.options?.tryIt?.hostExecution);
|
|
110
111
|
const hostRouteAvailable = hostExecutionState.enabled && typeof app.post === 'function';
|
|
112
|
+
const runtimeEnabled = (0, runtime_intelligence_1.runtimeIntelligenceEnabled)(options.options?.runtimeIntelligence);
|
|
113
|
+
const runtimeEndpoint = `${rendererBasePath}/runtime`;
|
|
111
114
|
let remoteSpecPromise = null;
|
|
112
115
|
let generatedSpecPromise = null;
|
|
113
116
|
const routeOptions = auth ? {
|
|
@@ -145,6 +148,7 @@ function setupFastifyFlexDocInternal(app, path, options, specProvider) {
|
|
|
145
148
|
rendererBasePath,
|
|
146
149
|
rendererVersion: assets.version,
|
|
147
150
|
hostExecutionPublic: hostRouteAvailable ? (0, host_execution_1.publicHostExecutionOptions)(hostExecutionState, rendererBasePath) : undefined,
|
|
151
|
+
runtimeIntelligencePublic: runtimeEnabled ? { available: true, endpoint: runtimeEndpoint, framework: 'fastify' } : undefined,
|
|
148
152
|
});
|
|
149
153
|
});
|
|
150
154
|
const sendHostResult = (reply, result) => {
|
|
@@ -153,6 +157,23 @@ function setupFastifyFlexDocInternal(app, path, options, specProvider) {
|
|
|
153
157
|
target = target.header(name, value);
|
|
154
158
|
return target.send(result.body);
|
|
155
159
|
};
|
|
160
|
+
if (runtimeEnabled) {
|
|
161
|
+
app.get(runtimeEndpoint, routeOptions, async (request, reply) => {
|
|
162
|
+
const serverOrigin = (0, host_execution_route_1.hostExecutionRequestOrigin)({
|
|
163
|
+
headers: request.headers,
|
|
164
|
+
protocol: request.protocol || (request.raw?.socket?.encrypted ? 'https' : 'http'),
|
|
165
|
+
});
|
|
166
|
+
const snapshot = (0, runtime_intelligence_1.buildRuntimeIntelligenceSnapshot)({
|
|
167
|
+
spec: await resolvedSpec(),
|
|
168
|
+
discovery: await (0, runtime_intelligence_1.discoverFastifyRoutes)(app, normalizedPath),
|
|
169
|
+
serverOrigin,
|
|
170
|
+
});
|
|
171
|
+
return reply
|
|
172
|
+
.type('application/json; charset=utf-8')
|
|
173
|
+
.header('Cache-Control', 'no-store')
|
|
174
|
+
.send(JSON.stringify(snapshot));
|
|
175
|
+
});
|
|
176
|
+
}
|
|
156
177
|
if (hostRouteAvailable) {
|
|
157
178
|
if (app.addContentTypeParser && !app.hasContentTypeParser?.('multipart/form-data')) {
|
|
158
179
|
app.addContentTypeParser('multipart/form-data', { parseAs: 'buffer' }, (_request, body, done) => done(null, body));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"framework-adapters.js","sourceRoot":"","sources":["../src/framework-adapters.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"framework-adapters.js","sourceRoot":"","sources":["../src/framework-adapters.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CA,kDAEC;AAkKD,kDAEC;AAGD,gEAYC;AAMD,4CAqBC;AA/PD,+CAAiC;AACjC,kDAAoC;AAEpC,uDAAsD;AACtD,mCAAuC;AACvC,yCAAiD;AACjD,qDAAwF;AACxF,iEAAgH;AAChH,6CAA2E;AAC3E,iEAA6H;AAsC7H,SAAgB,mBAAmB,CAAC,GAA2B,EAAE,IAAY,EAAE,OAA2C;IACxH,IAAA,oBAAY,EAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAgB,EAAE,MAAc;IACzD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACpG,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAAE,QAAQ,IAAI,GAAG,CAAC;IAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAAE,QAAQ,IAAI,GAAG,CAAC;IAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAAE,QAAQ,IAAI,GAAG,CAAC;IAC7C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC;QAAE,QAAQ,IAAI,GAAG,CAAC;IACpD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,SAAS,CAAC,OAAsC,EAAE,IAAsD;IAC/G,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,MAAM,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC;IAClC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAChD,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;QACnE,OAAO,QAAQ,KAAK,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,KAAyB,CAAC;IAC9B,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC;QAAE,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACnD,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,SAAS,IAAI,CAAC;YAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,IAAI,CAAC;QAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAAC,OAAO,IAAI,CAAC;IAAC,CAAC;IAAC,MAAM,CAAC;QAAC,OAAO,KAAK,CAAC;IAAC,CAAC;AACjF,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,GAAW;IACvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,KAAM,CAAC,EAAE,CAAC,CAAC;IAC/F,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1F,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED,SAAS,2BAA2B,CAClC,GAA2B,EAC3B,IAAY,EACZ,OAA2C,EAC3C,YAAuC;IAEvC,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,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;IACnC,MAAM,kBAAkB,GAAG,IAAA,yCAAwB,EAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAC3F,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC;IACxF,MAAM,cAAc,GAAG,IAAA,iDAA0B,EAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IACxF,MAAM,eAAe,GAAG,GAAG,gBAAgB,UAAU,CAAC;IACtD,IAAI,iBAAiB,GAAwB,IAAI,CAAC;IAClD,IAAI,oBAAoB,GAAwB,IAAI,CAAC;IAErD,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;QAC1B,UAAU,EAAE,KAAK,EAAE,OAA2B,EAAE,KAAuB,EAAE,EAAE;YACzE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;gBAC7E,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;KACF,CAAC,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;QAC9B,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,oBAAoB;gBAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBAChG,oBAAoB,GAAG,IAAI,CAAC;oBAC5B,MAAM,KAAK,CAAC;gBACd,CAAC,CAAC,CAAC;YACH,OAAO,oBAAoB,CAAC;QAC9B,CAAC;QACD,IAAI,OAAO,CAAC,IAAI;YAAE,OAAO,OAAO,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,CAAC,iBAAiB;YAAE,iBAAiB,GAAG,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC1F,iBAAiB,GAAG,IAAI,CAAC;gBACzB,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;QACH,OAAO,iBAAiB,CAAC;IAC3B,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,oCAAuB,EAAC,KAAK,IAAI,EAAE;QACjD,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC;QACnC,OAAO,IAAA,8BAAmB,EAAC,MAAM,YAAY,EAAE,EAAE;YAC/C,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;YAC1B,gBAAgB;YAChB,eAAe,EAAE,MAAM,CAAC,OAAO;YAC/B,mBAAmB,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAA,2CAA0B,EAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;YACtH,yBAAyB,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;SAC7H,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,CAAC,KAAuB,EAAE,MAAyE,EAAE,EAAE;QAC5H,IAAI,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAChG,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,IAAI,cAAc,EAAE,CAAC;QACnB,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC9D,MAAM,YAAY,GAAG,IAAA,iDAA0B,EAAC;gBAC9C,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;aAClF,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,IAAA,uDAAgC,EAAC;gBAChD,IAAI,EAAE,MAAM,YAAY,EAAE;gBAC1B,SAAS,EAAE,MAAM,IAAA,4CAAqB,EAAC,GAAG,EAAE,cAAc,CAAC;gBAC3D,YAAY;aACb,CAAC,CAAC;YACH,OAAO,KAAK;iBACT,IAAI,CAAC,iCAAiC,CAAC;iBACvC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;iBACnC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,kBAAkB,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,oBAAoB,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC;YACnF,GAAG,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACrH,CAAC;QACD,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,gBAAgB,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC/E,MAAM,UAAU,GAAG,IAAA,iDAA0B,EAAC;gBAC5C,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;aAClF,CAAC,CAAC;YACH,OAAO,cAAc,CAAC,KAAK,EAAE,MAAM,IAAA,4CAAqB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACjL,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAA,0CAAmB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACpL,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,gBAAgB,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAA,0CAAmB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACxM,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,cAAc,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;QACjF,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC;QACnC,OAAO,KAAK,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACpJ,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,eAAe,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;QAClF,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC;QACnC,OAAO,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/H,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QAC7D,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,GAAG,KAAK;iBACf,IAAI,CAAC,0BAA0B,CAAC;iBAChC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;iBACnC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,IAAA,+BAAkB,EAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpE,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAAC,yCAAyC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;QACrK,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAGD,SAAgB,mBAAmB,CAAC,GAA2B,EAAE,IAAY,EAAE,OAA2C;IACxH,2BAA2B,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAGD,SAAgB,0BAA0B,CACxC,GAA2B,EAC3B,IAAY,EACZ,UAAmE,EAAE;IAErE,2BAA2B,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;QACzD,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU;YAAE,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QACvD,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,sFAAsF,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,GAAG,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAMD,SAAgB,gBAAgB,CAC9B,GAAwB,EACxB,IAAY,EACZ,sBAA+C,EAC/C,UAAmE,EAAE;IAErE,IAAI,aAAkB,CAAC;IACvB,IAAI,CAAC;QACH,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,aAAa,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,IAAI,GAAG,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;IACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IACvC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;IACjC,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,OAAO,QAAQ,CAAC,GAAG,KAAK,UAAU,CAAC,EAAE,CAAC;QAChF,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC"}
|
|
@@ -40,6 +40,38 @@ describe('setupFastifyFlexDoc', () => {
|
|
|
40
40
|
expect(revalidated.state.code).toBe(304);
|
|
41
41
|
expect(template_1.generateFlexDocHTML).toHaveBeenCalledTimes(1);
|
|
42
42
|
});
|
|
43
|
+
it('exposes an authenticated Fastify runtime snapshot when opted in', async () => {
|
|
44
|
+
const routes = new Map();
|
|
45
|
+
const app = {
|
|
46
|
+
version: '5.12.1',
|
|
47
|
+
get: (path, options, handler) => routes.set(path, { options, handler }),
|
|
48
|
+
ready: jest.fn(async () => undefined),
|
|
49
|
+
printRoutes: jest.fn(() => [
|
|
50
|
+
'└── /',
|
|
51
|
+
' ├── pets (GET, HEAD)',
|
|
52
|
+
' ├── internal/reindex (POST)',
|
|
53
|
+
' └── docs (GET, HEAD)',
|
|
54
|
+
].join('\n')),
|
|
55
|
+
};
|
|
56
|
+
(0, framework_adapters_1.setupFastifyFlexDoc)(app, '/docs', {
|
|
57
|
+
spec: { openapi: '3.1.0', paths: { '/pets': { get: {} } } },
|
|
58
|
+
options: { runtimeIntelligence: true },
|
|
59
|
+
});
|
|
60
|
+
expect(routes.has('/docs/__flexdoc/runtime')).toBe(true);
|
|
61
|
+
const { state, reply } = replyState();
|
|
62
|
+
await routes.get('/docs/__flexdoc/runtime').handler({ headers: { host: 'api.example.test' }, protocol: 'https' }, reply);
|
|
63
|
+
const snapshot = JSON.parse(state.body);
|
|
64
|
+
expect(snapshot.framework).toBe('fastify');
|
|
65
|
+
expect(snapshot.frameworkVersion).toBe('5.12.1');
|
|
66
|
+
expect(snapshot.runtime.name).toBe('node');
|
|
67
|
+
expect(snapshot.serverOrigin).toBe('https://api.example.test');
|
|
68
|
+
expect(snapshot.summary).toEqual({ documented: 1, runtime: 2, matched: 1, runtimeOnly: 1, documentedOnly: 0 });
|
|
69
|
+
expect(snapshot.runtimeOnly).toEqual([{ method: 'POST', path: '/internal/reindex' }]);
|
|
70
|
+
expect(state.headers['Cache-Control']).toBe('no-store');
|
|
71
|
+
const docs = replyState();
|
|
72
|
+
await routes.get('/docs').handler({ headers: {} }, docs.reply);
|
|
73
|
+
expect(template_1.generateFlexDocHTML).toHaveBeenCalledWith(expect.any(Object), expect.objectContaining({ runtimeIntelligencePublic: { available: true, endpoint: '/docs/__flexdoc/runtime', framework: 'fastify' } }));
|
|
74
|
+
});
|
|
43
75
|
it('protects Fastify routes when docs auth is configured', async () => {
|
|
44
76
|
const routes = new Map();
|
|
45
77
|
const app = { get: (path, options, handler) => routes.set(path, { options, handler }) };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"framework-adapters.test.js","sourceRoot":"","sources":["../src/framework-adapters.test.ts"],"names":[],"mappings":";;AAAA,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpC,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAC;QACxB,UAAU,EAAE,aAAa;QACzB,GAAG,EAAE,cAAc;QACnB,OAAO,EAAE,uBAAuB;KACjC,CAAC;CACH,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7F,6DAAuF;AACvF,yCAAiD;AAEjD,SAAS,UAAU;IACjB,MAAM,KAAK,GAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACnC,MAAM,KAAK,GAAQ;QACjB,IAAI,CAAC,KAAa,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACxD,MAAM,CAAC,IAAY,EAAE,KAAa,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,KAAa,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,KAAU,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC;KACvD,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC1B,CAAC;AAED,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IAEvC,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAC1G,IAAA,wCAAmB,EAAC,GAAG,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEjH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,6BAA6B,EAAE,8BAA8B,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7G,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAC1D,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC7C,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAC9C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAClB,MAAM,CAAC,gBAAgB,CAAC,EAAE,eAAe,EAAE,uBAAuB,EAAE,CAAC,CACtE,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEzC,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC;QAC5B,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,CAAC,8BAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAErD,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;QACjC,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;QAC3G,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,8BAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAC1G,IAAA,wCAAmB,EAAC,GAAG,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC1D,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QACtC,MAAM,UAAU,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACzF,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,MAAM,GAAG,GAAG;YACV,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACzF,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,OAAO;SACR,CAAC;QAEF,IAAA,+CAA0B,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAEvC,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QAC/B,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAE1D,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"framework-adapters.test.js","sourceRoot":"","sources":["../src/framework-adapters.test.ts"],"names":[],"mappings":";;AAAA,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpC,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAC;QACxB,UAAU,EAAE,aAAa;QACzB,GAAG,EAAE,cAAc;QACnB,OAAO,EAAE,uBAAuB;KACjC,CAAC;CACH,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7F,6DAAuF;AACvF,yCAAiD;AAEjD,SAAS,UAAU;IACjB,MAAM,KAAK,GAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACnC,MAAM,KAAK,GAAQ;QACjB,IAAI,CAAC,KAAa,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACxD,MAAM,CAAC,IAAY,EAAE,KAAa,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,KAAa,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,KAAU,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC;KACvD,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC1B,CAAC;AAED,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IAEvC,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAC1G,IAAA,wCAAmB,EAAC,GAAG,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEjH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,6BAA6B,EAAE,8BAA8B,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7G,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAC1D,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC7C,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAC9C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAClB,MAAM,CAAC,gBAAgB,CAAC,EAAE,eAAe,EAAE,uBAAuB,EAAE,CAAC,CACtE,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEzC,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC;QAC5B,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,CAAC,8BAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAErD,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;QACjC,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;QAC3G,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,8BAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACzF,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC;YACrC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;gBACzB,OAAO;gBACP,0BAA0B;gBAC1B,iCAAiC;gBACjC,0BAA0B;aAC3B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACd,CAAC;QAEF,IAAA,wCAAmB,EAAC,GAAG,EAAE,OAAO,EAAE;YAChC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE;YAC3D,OAAO,EAAE,EAAE,mBAAmB,EAAE,IAAI,EAAE;SACvC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;QACzH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/G,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;QACtF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAExD,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;QAC1B,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/D,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAC9C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAClB,MAAM,CAAC,gBAAgB,CAAC,EAAE,yBAAyB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,yBAAyB,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,CAAC,CACvI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAC1G,IAAA,wCAAmB,EAAC,GAAG,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3G,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC1D,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QACtC,MAAM,UAAU,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACtC,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACzF,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,MAAM,GAAG,GAAG;YACV,GAAG,EAAE,CAAC,IAAY,EAAE,OAAY,EAAE,OAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACzF,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,OAAO;SACR,CAAC;QAEF,IAAA,+CAA0B,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAEvC,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,CAAC;QAC/B,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAE1D,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,8BAAmB,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/hono-adapter.d.ts
CHANGED
|
@@ -11,5 +11,9 @@ export interface HonoLikeApplication {
|
|
|
11
11
|
get(path: string, handler: (context: HonoLikeContext) => unknown | Promise<unknown>): unknown;
|
|
12
12
|
post?: (path: string, handler: (context: HonoLikeContext) => unknown | Promise<unknown>) => unknown;
|
|
13
13
|
delete?: (path: string, handler: (context: HonoLikeContext) => unknown | Promise<unknown>) => unknown;
|
|
14
|
+
routes?: Array<{
|
|
15
|
+
method: string;
|
|
16
|
+
path: string;
|
|
17
|
+
}>;
|
|
14
18
|
}
|
|
15
19
|
export declare function setupHonoFlexDoc(app: HonoLikeApplication, path: string, options: Omit<FlexDocModuleOptions, 'path'>): void;
|
package/dist/hono-adapter.js
CHANGED
|
@@ -7,6 +7,7 @@ const template_1 = require("./template");
|
|
|
7
7
|
const host_execution_1 = require("./host-execution");
|
|
8
8
|
const host_execution_route_1 = require("./host-execution-route");
|
|
9
9
|
const page_cache_1 = require("./page-cache");
|
|
10
|
+
const runtime_intelligence_1 = require("./runtime-intelligence");
|
|
10
11
|
function setupHonoFlexDoc(app, path, options) {
|
|
11
12
|
const normalizedPath = `/${path.trim().replace(/^\/+|\/+$/g, '')}` || '/docs';
|
|
12
13
|
const base = normalizedPath === '/' ? '/docs' : normalizedPath;
|
|
@@ -14,6 +15,8 @@ function setupHonoFlexDoc(app, path, options) {
|
|
|
14
15
|
const auth = options.options?.auth;
|
|
15
16
|
const hostExecutionState = (0, host_execution_1.createHostExecutionState)(options.options?.tryIt?.hostExecution);
|
|
16
17
|
const hostRouteAvailable = hostExecutionState.enabled && typeof app.post === 'function';
|
|
18
|
+
const runtimeEnabled = (0, runtime_intelligence_1.runtimeIntelligenceEnabled)(options.options?.runtimeIntelligence);
|
|
19
|
+
const runtimeEndpoint = `${rendererBasePath}/runtime`;
|
|
17
20
|
let remoteSpecPromise;
|
|
18
21
|
const resolvedSpec = async () => {
|
|
19
22
|
if (options.spec)
|
|
@@ -45,6 +48,7 @@ function setupHonoFlexDoc(app, path, options) {
|
|
|
45
48
|
rendererBasePath,
|
|
46
49
|
rendererVersion: assets.version,
|
|
47
50
|
hostExecutionPublic: hostRouteAvailable ? (0, host_execution_1.publicHostExecutionOptions)(hostExecutionState, rendererBasePath) : undefined,
|
|
51
|
+
runtimeIntelligencePublic: runtimeEnabled ? { available: true, endpoint: runtimeEndpoint, framework: 'hono' } : undefined,
|
|
48
52
|
});
|
|
49
53
|
});
|
|
50
54
|
const page = async (context) => {
|
|
@@ -70,6 +74,24 @@ function setupHonoFlexDoc(app, path, options) {
|
|
|
70
74
|
'x-flexdoc-execute': context.req.header('X-FlexDoc-Execute'),
|
|
71
75
|
});
|
|
72
76
|
const sendHostResult = (context, result) => context.body(result.body, result.status, result.headers);
|
|
77
|
+
if (runtimeEnabled) {
|
|
78
|
+
app.get(runtimeEndpoint, async (context) => {
|
|
79
|
+
const denied = denyUnauthorized(context);
|
|
80
|
+
if (denied !== undefined)
|
|
81
|
+
return denied;
|
|
82
|
+
const headers = honoHeaders(context);
|
|
83
|
+
const serverOrigin = (0, host_execution_route_1.hostExecutionRequestOrigin)({ headers, url: context.req.raw?.url });
|
|
84
|
+
const snapshot = (0, runtime_intelligence_1.buildRuntimeIntelligenceSnapshot)({
|
|
85
|
+
spec: await resolvedSpec(),
|
|
86
|
+
discovery: (0, runtime_intelligence_1.discoverHonoRoutes)(app, base),
|
|
87
|
+
serverOrigin,
|
|
88
|
+
});
|
|
89
|
+
return context.body(JSON.stringify(snapshot), 200, {
|
|
90
|
+
'Content-Type': 'application/json; charset=utf-8',
|
|
91
|
+
'Cache-Control': 'no-store',
|
|
92
|
+
});
|
|
93
|
+
});
|
|
94
|
+
}
|
|
73
95
|
if (hostRouteAvailable) {
|
|
74
96
|
app.post?.(`${rendererBasePath}/execute`, async (context) => {
|
|
75
97
|
const denied = denyUnauthorized(context);
|
package/dist/hono-adapter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hono-adapter.js","sourceRoot":"","sources":["../src/hono-adapter.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"hono-adapter.js","sourceRoot":"","sources":["../src/hono-adapter.ts"],"names":[],"mappings":";;AA2BA,4CAoIC;AA/JD,iCAAiD;AAEjD,uDAAsD;AACtD,yCAAiD;AACjD,qDAAwF;AACxF,iEAAgH;AAChH,6CAA2E;AAC3E,iEAA0H;AAoB1H,SAAgB,gBAAgB,CAC9B,GAAwB,EACxB,IAAY,EACZ,OAA2C;IAE3C,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,EAAE,IAAI,OAAO,CAAC;IAC9E,MAAM,IAAI,GAAG,cAAc,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC;IAC/D,MAAM,gBAAgB,GAAG,GAAG,IAAI,YAAY,CAAC;IAC7C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;IACnC,MAAM,kBAAkB,GAAG,IAAA,yCAAwB,EAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAC3F,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC;IACxF,MAAM,cAAc,GAAG,IAAA,iDAA0B,EAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IACxF,MAAM,eAAe,GAAG,GAAG,gBAAgB,UAAU,CAAC;IACtD,IAAI,iBAA+C,CAAC;IACpD,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;QAC9B,IAAI,OAAO,CAAC,IAAI;YAAE,OAAO,OAAO,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,CAAC,iBAAiB;YAAE,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,KAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,GAAG,iBAAiB,GAAG,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/T,OAAO,iBAAiB,CAAC;IAC3B,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CAAC,OAAwB,EAAuB,EAAE;QACzE,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,MAAM,QAAQ,GAAG,IAAA,8BAAuB,EAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC;QACpF,IAAI,QAAQ,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAE1C,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,yBAAyB,EAAE,GAAG,EAAE;YACtE,cAAc,EAAE,2BAA2B;YAC3C,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1E,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,oCAAuB,EAAC,GAAG,EAAE;QAC3C,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC;QACnC,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAA8C,CAAC;QACjF,OAAO,IAAA,8BAAmB,EAAC,IAAI,EAAE;YAC/B,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,gBAAgB;YAChB,eAAe,EAAE,MAAM,CAAC,OAAO;YAC/B,mBAAmB,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAA,2CAA0B,EAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;YACtH,yBAAyB,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SAC1H,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,KAAK,EAAE,OAAwB,EAAE,EAAE;QAC9C,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;QAExC,MAAM,UAAU,GAAG,MAAM,OAAO,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG;YACd,cAAc,EAAE,0BAA0B;YAC1C,eAAe,EAAE,UAAU;YAC3B,MAAM,EAAE,UAAU,CAAC,IAAI;SACxB,CAAC;QACF,IAAI,IAAA,+BAAkB,EAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7E,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,OAAwB,EAAE,EAAE,CAAC,CAAC;QACjD,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC;QACpD,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC;QAClD,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;QAClC,mBAAmB,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,mBAAmB,CAAC;KAC7D,CAAC,CAAC;IACH,MAAM,cAAc,GAAG,CAAC,OAAwB,EAAE,MAAyE,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAEzL,IAAI,cAAc,EAAE,CAAC;QACnB,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACzC,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;YACxC,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,YAAY,GAAG,IAAA,iDAA0B,EAAC,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;YACxF,MAAM,QAAQ,GAAG,IAAA,uDAAgC,EAAC;gBAChD,IAAI,EAAE,MAAM,YAAY,EAAE;gBAC1B,SAAS,EAAE,IAAA,yCAAkB,EAAC,GAAG,EAAE,IAAI,CAAC;gBACxC,YAAY;aACb,CAAC,CAAC;YACH,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE;gBACjD,cAAc,EAAE,iCAAiC;gBACjD,eAAe,EAAE,UAAU;aAC5B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,kBAAkB,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,gBAAgB,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC1D,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;gBAAE,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,mCAAmC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,iCAAiC,EAAE,CAAC,CAAC;YACtK,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YAC9D,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,UAAU,GAAG,IAAA,iDAA0B,EAAC,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YACrF,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,IAAA,4CAAqB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACpJ,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;YACxC,OAAO,cAAc,CAAC,OAAO,EAAE,IAAA,0CAAmB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,gBAAgB,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE;YACtD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;YACxC,OAAO,cAAc,CAAC,OAAO,EAAE,IAAA,0CAAmB,EAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACjI,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpB,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;QACrD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;QAExC,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC;QACnC,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE;YAC1C,cAAc,EAAE,uCAAuC;YACvD,eAAe,EAAE,qCAAqC;SACvD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,eAAe,EAAE,CAAC,OAAO,EAAE,EAAE;QACtD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;QAExC,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC;QACnC,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE;YACnC,cAAc,EAAE,yBAAyB;YACzC,eAAe,EAAE,qCAAqC;SACvD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -13,7 +13,7 @@ jest.mock('./renderer-assets', () => ({
|
|
|
13
13
|
version: 'hono-test-version',
|
|
14
14
|
}),
|
|
15
15
|
}));
|
|
16
|
-
function createContext(authorization, extraHeaders = {}) {
|
|
16
|
+
function createContext(authorization, extraHeaders = {}, rawUrl) {
|
|
17
17
|
return {
|
|
18
18
|
req: {
|
|
19
19
|
header: (name) => {
|
|
@@ -22,6 +22,7 @@ function createContext(authorization, extraHeaders = {}) {
|
|
|
22
22
|
return authorization;
|
|
23
23
|
return extraHeaders[normalized];
|
|
24
24
|
},
|
|
25
|
+
...(rawUrl ? { raw: new Request(rawUrl) } : {}),
|
|
25
26
|
},
|
|
26
27
|
body: (body, status = 200, headers = {}) => ({ body, status, headers }),
|
|
27
28
|
};
|
|
@@ -33,9 +34,10 @@ describe('setupHonoFlexDoc', () => {
|
|
|
33
34
|
jest.clearAllMocks();
|
|
34
35
|
handlers = new Map();
|
|
35
36
|
app = {
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
37
|
+
routes: [],
|
|
38
|
+
get: jest.fn((path, handler) => { app.routes.push({ method: 'GET', path }); handlers.set(path, handler); }),
|
|
39
|
+
post: jest.fn((path, handler) => { app.routes.push({ method: 'POST', path }); handlers.set(path, handler); }),
|
|
40
|
+
delete: jest.fn((path, handler) => { app.routes.push({ method: 'DELETE', path }); handlers.set(`DELETE ${path}`, handler); }),
|
|
39
41
|
};
|
|
40
42
|
});
|
|
41
43
|
it('registers docs, trailing slash, and immutable renderer routes', () => {
|
|
@@ -46,6 +48,7 @@ describe('setupHonoFlexDoc', () => {
|
|
|
46
48
|
expect(handlers.has('/docs/__flexdoc/renderer.css')).toBe(true);
|
|
47
49
|
expect(handlers.has('/docs/__flexdoc/execute')).toBe(false);
|
|
48
50
|
expect(handlers.has('/docs/__flexdoc/cookies')).toBe(false);
|
|
51
|
+
expect(handlers.has('/docs/__flexdoc/runtime')).toBe(false);
|
|
49
52
|
});
|
|
50
53
|
it('passes the shared renderer host options to the page', async () => {
|
|
51
54
|
(0, hono_adapter_1.setupHonoFlexDoc)(app, '/docs', {
|
|
@@ -68,17 +71,38 @@ describe('setupHonoFlexDoc', () => {
|
|
|
68
71
|
expect(revalidated.status).toBe(304);
|
|
69
72
|
expect(template_1.generateFlexDocHTML).toHaveBeenCalledTimes(1);
|
|
70
73
|
});
|
|
71
|
-
it('
|
|
74
|
+
it('exposes live Hono route presence and runtime metadata when opted in', async () => {
|
|
75
|
+
app.routes.push({ method: 'GET', path: '/pets' }, { method: 'POST', path: '/internal/reindex' });
|
|
76
|
+
(0, hono_adapter_1.setupHonoFlexDoc)(app, '/docs', {
|
|
77
|
+
spec: { openapi: '3.1.0', paths: { '/pets': { get: {} } } },
|
|
78
|
+
options: { runtimeIntelligence: true },
|
|
79
|
+
});
|
|
80
|
+
expect(handlers.has('/docs/__flexdoc/runtime')).toBe(true);
|
|
81
|
+
const result = await handlers.get('/docs/__flexdoc/runtime')(createContext(undefined, {}, 'https://api.example.test/docs/__flexdoc/runtime'));
|
|
82
|
+
const snapshot = JSON.parse(String(result.body));
|
|
83
|
+
expect(result.status).toBe(200);
|
|
84
|
+
expect(result.headers['Cache-Control']).toBe('no-store');
|
|
85
|
+
expect(snapshot.framework).toBe('hono');
|
|
86
|
+
expect(snapshot.runtime.name).toBe('node');
|
|
87
|
+
expect(snapshot.serverOrigin).toBe('https://api.example.test');
|
|
88
|
+
expect(snapshot.summary).toEqual({ documented: 1, runtime: 2, matched: 1, runtimeOnly: 1, documentedOnly: 0 });
|
|
89
|
+
expect(snapshot.runtimeOnly).toEqual([{ method: 'POST', path: '/internal/reindex' }]);
|
|
90
|
+
await handlers.get('/docs')(createContext());
|
|
91
|
+
expect(template_1.generateFlexDocHTML).toHaveBeenCalledWith(expect.any(Object), expect.objectContaining({ runtimeIntelligencePublic: { available: true, endpoint: '/docs/__flexdoc/runtime', framework: 'hono' } }));
|
|
92
|
+
});
|
|
93
|
+
it('protects docs, assets, and runtime intelligence with the same basic auth contract', async () => {
|
|
72
94
|
const secretKey = 'hono-secret';
|
|
73
95
|
(0, hono_adapter_1.setupHonoFlexDoc)(app, '/docs', {
|
|
74
96
|
spec: { openapi: '3.0.0' },
|
|
75
|
-
options: { auth: { type: 'basic', secretKey } },
|
|
97
|
+
options: { auth: { type: 'basic', secretKey }, runtimeIntelligence: true },
|
|
76
98
|
});
|
|
77
99
|
const deniedDocs = await handlers.get('/docs')(createContext());
|
|
78
100
|
const deniedAsset = await handlers.get('/docs/__flexdoc/renderer.js')(createContext());
|
|
101
|
+
const deniedRuntime = await handlers.get('/docs/__flexdoc/runtime')(createContext());
|
|
79
102
|
expect(deniedDocs.status).toBe(401);
|
|
80
103
|
expect(deniedDocs.headers['WWW-Authenticate']).toBe('Basic');
|
|
81
104
|
expect(deniedAsset.status).toBe(401);
|
|
105
|
+
expect(deniedRuntime.status).toBe(401);
|
|
82
106
|
const username = 'alice';
|
|
83
107
|
const password = (0, auth_1.generateFlexDocPassword)(username, secretKey);
|
|
84
108
|
const authorization = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
|