@scalar/fastify-api-reference 0.5.0 → 0.6.1

package/README.md

@@ -20,7 +20,7 @@ If you have a OpenAPI/Swagger file already, you can pass an URL to the plugin:
 ```ts
 // Render an API reference for a given OpenAPI/Swagger spec URL
 fastify.register(require('@scalar/fastify-api-reference'), {
-  prefix: '/reference',
+  routePrefix: '/reference',
   apiReference: {
     title: 'Our API Reference',
     specUrl: '/swagger.json',
@@ -32,7 +32,7 @@ With the [@fastify/swagger](https://github.com/fastify/fastify-swagger) you can
 
 ```ts
 await fastify.register(require('@scalar/fastify-api-reference'), {
-  prefix: '/reference',
+  routePrefix: '/reference',
   apiReference: {
     spec: () => fastify.swagger(),
   },
@@ -43,7 +43,7 @@ Or, if you just have a static OpenAPI spec, you can directly pass it, too:
 
 ```ts
 await fastify.register(require('@scalar/fastify-api-reference'), {
-  prefix: '/reference',
+  routePrefix: '/reference',
   apiReference: {
     spec: { … },
   },

package/dist/fastifyApiReference.d.ts

@@ -1,12 +1,17 @@
-import { type FastifyPluginAsync } from 'fastify';
-export type ApiReferencePlugin = {
-    apiReference: ApiReferenceOptions;
-};
+import type { FastifyPluginAsync } from 'fastify';
 export type ApiReferenceOptions = {
-    title?: string;
-    specUrl?: string;
-    spec?: Record<string, any> | (() => Record<string, any>);
+    /**
+     * Prefix for the registered route
+     *
+     * @default '/'
+     */
+    routePrefix: string;
+    apiReference: {
+        specUrl?: string;
+        spec?: Record<string, any> | (() => Record<string, any>);
+        title?: string;
+    };
 };
-declare const fastifyApiReferencePlugin: FastifyPluginAsync<ApiReferencePlugin>;
-export default fastifyApiReferencePlugin;
+declare const _default: FastifyPluginAsync<ApiReferenceOptions>;
+export default _default;
 //# sourceMappingURL=fastifyApiReference.d.ts.map

package/dist/fastifyApiReference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,kBAAkB,EAExB,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,mBAAmB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;CACzD,CAAA;AA8BD,QAAA,MAAM,yBAAyB,EAAE,kBAAkB,CACjD,kBAAkB,CAuBnB,CAAA;AAED,eAAe,yBAAyB,CAAA"}
+{"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;;AA4CD,wBAAsC"}

package/dist/fastifyApiReference.js

@@ -0,0 +1,24 @@
+import ejs from 'ejs';
+import fp from 'fastify-plugin';
+import fs from 'fs';
+import path from 'path';
+const fastifyApiReference = async (fastify, options) => {
+    if (!options.apiReference?.spec && !options.apiReference?.specUrl) {
+        console.warn('[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options.');
+        return;
+    }
+    fastify.get(options.routePrefix ?? '/', async (_, reply) => {
+        reply.header('Content-Type', 'text/html; charset=utf-8');
+        const html = await ejs.renderFile(path.resolve(`${__dirname}/templates/index.ejs`), {
+            options,
+        });
+        reply.send(html);
+    });
+    console.log((options.routePrefix ?? '/') + '/fastify-api-reference.js');
+    fastify.get((options.routePrefix ?? '/') + '/fastify-api-reference.js', async (_, reply) => {
+        reply.header('Content-Type', 'application/javascript; charset=utf-8');
+        const content = fs.readFileSync(path.resolve(`${__dirname}/../dist/templates/fastify-api-reference.js`), 'utf8');
+        reply.send(content);
+    });
+};
+export default fp(fastifyApiReference);

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { default } from './fastifyApiReference';
+export { default } from './fastifyApiReference.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,36 +1 @@
-const d = (e) => {
-  const t = e.specUrl ? `<div data-spec-url="${e.specUrl}" />` : typeof e.spec == "object" ? `<div data-spec='${JSON.stringify(e.spec)}' />` : e.spec ? `<div data-spec='${JSON.stringify(e.spec())}' />` : "";
-  return `
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>${e.title || "API Reference"}</title>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1" />
-  </head>
-  <body>
-    <!-- Add your own OpenAPI/Swagger spec file URL here: -->
-    ${t}
-    <script src="https://cdn.scalar.com/api-reference.standalone.js"><\/script>
-  </body>
-</html>
-`;
-}, l = async (e, t) => {
-  if (!t.apiReference.spec && !t.apiReference.specUrl) {
-    console.warn(
-      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options."
-    );
-    return;
-  }
-  e.addHook("onSend", (r, a, c, s) => {
-    a.header("Content-Type", "text/html; charset=utf-8"), s();
-  }), e.get("/", async (r, a) => {
-    const c = d(t == null ? void 0 : t.apiReference);
-    a.send(c);
-  });
-};
-export {
-  l as default
-};
+export { default } from './fastifyApiReference.js';