@scalar/fastify-api-reference 0.6.0 → 0.6.2

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.
Files changed (18) hide show
  1. package/dist/fastifyApiReference.d.ts.map +1 -1
  2. package/dist/fastifyApiReference.js +12 -30
  3. package/dist/templates/fastify-api-reference.js +102544 -0
  4. package/dist/templates/index.ejs +25 -0
  5. package/dist/templates/render.d.ts +2 -0
  6. package/dist/templates/render.d.ts.map +1 -0
  7. package/dist/templates/render.js +69 -0
  8. package/dist/vite-plugins/index.d.ts +3 -0
  9. package/dist/vite-plugins/index.d.ts.map +1 -0
  10. package/dist/vite-plugins/index.js +2 -0
  11. package/dist/vite-plugins/nodeExternals.d.ts +8 -0
  12. package/dist/vite-plugins/nodeExternals.d.ts.map +1 -0
  13. package/dist/vite-plugins/nodeExternals.js +14 -0
  14. package/dist/vite-plugins/nodeShims.d.ts +6 -0
  15. package/dist/vite-plugins/nodeShims.d.ts.map +1 -0
  16. package/dist/vite-plugins/nodeShims.js +32 -0
  17. package/package.json +19 -6
  18. package/dist/index.umd.cjs +0 -17
package/dist/fastifyApiReference.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAGjD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE;QACZ,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;QACxD,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF,CAAA;;AAoDD,wBAAsC"}
1
+ {"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAKjD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE;QACZ,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;QACxD,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF,CAAA;;AA0CD,wBAAsC"}
package/dist/fastifyApiReference.js CHANGED
@@ -1,41 +1,23 @@
1
+ import ejs from 'ejs';
1
2
  import fp from 'fastify-plugin';
2
- const getHtmlMarkup = (options) => {
3
- const htmlTag = options.apiReference?.specUrl
4
- ? `<div data-spec-url="${options.apiReference?.specUrl}" />`
5
- : typeof options.apiReference?.spec === 'object'
6
- ? `<div data-spec='${JSON.stringify(options.apiReference?.spec)}' />`
7
- : options.apiReference?.spec
8
- ? `<div data-spec='${JSON.stringify(options.apiReference?.spec())}' />`
9
- : '';
10
- return `
11
- <!DOCTYPE html>
12
- <html>
13
- <head>
14
- <title>${options.apiReference.title || 'API Reference'}</title>
15
- <meta charset="utf-8" />
16
- <meta
17
- name="viewport"
18
- content="width=device-width, initial-scale=1" />
19
- </head>
20
- <body>
21
- <!-- Add your own OpenAPI/Swagger spec file URL here: -->
22
- ${htmlTag}
23
- <script src="https://www.unpkg.com/@scalar/api-reference"></script>
24
- </body>
25
- </html>
26
- `;
27
- };
3
+ import fs from 'fs';
4
+ import path from 'path';
28
5
  const fastifyApiReference = async (fastify, options) => {
29
6
  if (!options.apiReference?.spec && !options.apiReference?.specUrl) {
30
7
  console.warn('[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options.');
31
8
  return;
32
9
  }
33
- fastify.addHook('onSend', (request, reply, payload, next) => {
10
+ fastify.get(options.routePrefix ?? '/', async (_, reply) => {
34
11
  reply.header('Content-Type', 'text/html; charset=utf-8');
35
- next();
12
+ const html = await ejs.renderFile(path.resolve(`${__dirname}/../dist/templates/index.ejs`), {
13
+ options,
14
+ });
15
+ reply.send(html);
36
16
  });
37
- fastify.get(options.routePrefix ?? '/', async (_, reply) => {
38
- reply.send(getHtmlMarkup(options));
17
+ fastify.get((options.routePrefix ?? '/') + '/fastify-api-reference.js', async (_, reply) => {
18
+ reply.header('Content-Type', 'application/javascript; charset=utf-8');
19
+ const content = fs.readFileSync(path.resolve(`${__dirname}/../dist/templates/fastify-api-reference.js`), 'utf8');
20
+ reply.send(content);
39
21
  });
40
22
  };
41
23
  export default fp(fastifyApiReference);