@prauga/flexdoc-backend 2.9.5 → 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 +39 -10
- package/dist/framework-adapters.js.map +1 -1
- package/dist/framework-adapters.test.js +40 -0
- package/dist/framework-adapters.test.js.map +1 -1
- package/dist/hono-adapter.d.ts +4 -0
- package/dist/hono-adapter.js +38 -7
- package/dist/hono-adapter.js.map +1 -1
- package/dist/hono-adapter.test.js +42 -7
- 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/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 +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 +45 -10
- package/dist/setup.js.map +1 -1
- package/dist/setup.test.js +20 -0
- package/dist/setup.test.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/dist/setup.test.js
CHANGED
|
@@ -42,6 +42,11 @@ describe('setupFlexDoc', () => {
|
|
|
42
42
|
expect(handlers.has('/docs/__flexdoc/execute')).toBe(false);
|
|
43
43
|
expect(handlers.has('/docs/__flexdoc/cookies')).toBe(false);
|
|
44
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
|
+
});
|
|
45
50
|
it('does not register or advertise host execution unless explicitly enabled', async () => {
|
|
46
51
|
(0, setup_1.setupFlexDoc)(mockApp, '/docs', { spec: { openapi: '3.0.0' } });
|
|
47
52
|
expect(handlers.has('/docs/__flexdoc/execute')).toBe(false);
|
|
@@ -74,6 +79,21 @@ describe('setupFlexDoc', () => {
|
|
|
74
79
|
expect(mockRes.setHeader).toHaveBeenCalledWith('Content-Type', 'text/html; charset=utf-8');
|
|
75
80
|
expect(mockRes.send).toHaveBeenCalledWith('<html>Mocked HTML</html>');
|
|
76
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
|
+
});
|
|
77
97
|
it('returns a gateway error when specUrl cannot be loaded', async () => {
|
|
78
98
|
(0, setup_1.setupFlexDoc)(mockApp, '/docs', {
|
|
79
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;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,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,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"}
|
|
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
|
@@ -12,6 +12,7 @@ interface RenderOptions extends FlexDocOptions {
|
|
|
12
12
|
rendererBasePath?: string;
|
|
13
13
|
rendererVersion?: string;
|
|
14
14
|
hostExecutionPublic?: import('./interfaces').FlexDocHostExecutionPublicOptions;
|
|
15
|
+
runtimeIntelligencePublic?: import('./interfaces').FlexDocRuntimeIntelligencePublicOptions;
|
|
15
16
|
}
|
|
16
17
|
export declare function generateFlexDocHTML(spec: OpenAPISpec | null, options?: RenderOptions): string;
|
|
17
18
|
export {};
|
package/dist/template.js
CHANGED
|
@@ -8,7 +8,7 @@ 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, tryIt: serverTryIt, hostExecutionPublic, ...rendererOptions } = options;
|
|
11
|
+
const { title, description, version, customCss = '', customJs = '', favicon = '', specUrl, rendererBasePath = './__flexdoc', rendererVersion, auth: _serverOnlyAuth, runtimeIntelligence: _serverRuntimeIntelligence, tryIt: serverTryIt, hostExecutionPublic, runtimeIntelligencePublic, ...rendererOptions } = options;
|
|
12
12
|
const assetVersion = rendererVersion ? `?v=${encodeURIComponent(rendererVersion)}` : '';
|
|
13
13
|
const documentTitle = title || spec?.info?.title || 'API Documentation';
|
|
14
14
|
const publicTryIt = serverTryIt || hostExecutionPublic ? {
|
|
@@ -24,6 +24,7 @@ function generateFlexDocHTML(spec, options = {}) {
|
|
|
24
24
|
contractVersion: '1',
|
|
25
25
|
...rendererOptions,
|
|
26
26
|
...(publicTryIt ? { tryIt: publicTryIt } : {}),
|
|
27
|
+
...(runtimeIntelligencePublic ? { runtimeIntelligence: runtimeIntelligencePublic } : {}),
|
|
27
28
|
...(title ? { title } : {}),
|
|
28
29
|
...(description ? { description } : {}),
|
|
29
30
|
...(version ? { version } : {}),
|
|
@@ -38,6 +39,7 @@ function generateFlexDocHTML(spec, options = {}) {
|
|
|
38
39
|
${favicon ? `<link rel="icon" href="${escapeHtml(favicon)}" />` : ''}
|
|
39
40
|
<link rel="stylesheet" href="${escapeHtml(rendererBasePath)}/renderer.css${assetVersion}" />
|
|
40
41
|
${customCss ? `<style>${customCss}</style>` : ''}
|
|
42
|
+
<style>html,body,#flexdoc-root{height:100%;margin:0}body{overflow:hidden}</style>
|
|
41
43
|
</head>
|
|
42
44
|
<body>
|
|
43
45
|
<div id="flexdoc-root"></div>
|
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":";;AAwBA,kDAoFC;AA7FD,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,mBAAmB,EAAE,0BAA0B,EAC/C,KAAK,EAAE,WAAW,EAClB,mBAAmB,EACnB,yBAAyB,EACzB,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,yBAAyB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxF,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;;;;;;gCAMlB,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"}
|