@scalar/fastify-api-reference 0.6.8 → 0.6.12

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @scalar/fastify-api-reference
 
+## 0.6.12
+
+### Patch Changes
+
+- a5eed542: feat: detect @fastify/swagger and load fastify.swagger() automatically
+  - @scalar/api-reference@0.6.12
+
+## 0.6.11
+
+### Patch Changes
+
+- Updated dependencies [b76f4d1e]
+  - @scalar/api-reference@0.6.11
+
+## 0.6.10
+
+### Patch Changes
+
+- Updated dependencies [07b99141]
+  - @scalar/api-reference@0.6.10
+
+## 0.6.9
+
+### Patch Changes
+
+- 386b2941: fix: remove body margin from the fastify template
+- Updated dependencies [4985562c]
+  - @scalar/api-reference@0.6.9
+
 ## 0.6.8
 
 ### Patch Changes

package/README.md

@@ -39,6 +39,14 @@ await fastify.register(require('@scalar/fastify-api-reference'), {
 })
 ```
 
+Actually, we’re picking it up automatically, so this would be enough:
+
+```ts
+await fastify.register(require('@scalar/fastify-api-reference'), {
+  routePrefix: '/reference',
+})
+```
+
 Or, if you just have a static OpenAPI spec, you can directly pass it, too:
 
 ```ts

package/dist/fastifyApiReference.d.ts

@@ -6,7 +6,7 @@ export type ApiReferenceOptions = {
      * @default '/'
      */
     routePrefix: string;
-    apiReference: {
+    apiReference?: {
         specUrl?: string;
         spec?: Record<string, any> | (() => Record<string, any>);
         title?: string;

package/dist/fastifyApiReference.d.ts.map

@@ -1 +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"}
+{"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,CAAC,EAAE;QACb,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;;AAiED,wBAAsC"}

package/dist/index.cjs

@@ -5,18 +5,31 @@ const fs = require("node:fs");
 const path = require("node:path");
 const fastifyApiReference = async (fastify, options) => {
   var _a, _b;
-  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl)) {
+  const hasSwaggerPlugin = fastify.hasPlugin("@fastify/swagger");
+  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl) && !hasSwaggerPlugin) {
     console.warn(
-      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options."
+      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl and @fastify/swagger could not be find either. Please provide one of these options."
     );
     return;
   }
   fastify.get(options.routePrefix ?? "/", async (_, reply) => {
+    var _a2, _b2;
     reply.header("Content-Type", "text/html; charset=utf-8");
+    let mergedOptions = options;
+    if (!((_a2 = options.apiReference) == null ? void 0 : _a2.spec) && !((_b2 = options.apiReference) == null ? void 0 : _b2.specUrl) && hasSwaggerPlugin) {
+      mergedOptions = {
+        ...options,
+        apiReference: {
+          ...options.apiReference,
+          // @ts-ignore
+          spec: () => fastify.swagger()
+        }
+      };
+    }
     const html = await ejs.renderFile(
       path.resolve(`${__dirname}/../dist/templates/index.ejs`),
       {
-        options
+        options: mergedOptions
       }
     );
     reply.send(html);

package/dist/index.js

@@ -13,18 +13,31 @@ import fs from "node:fs";
 import path from "node:path";
 const fastifyApiReference = async (fastify, options) => {
   var _a, _b;
-  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl)) {
+  const hasSwaggerPlugin = fastify.hasPlugin("@fastify/swagger");
+  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl) && !hasSwaggerPlugin) {
     console.warn(
-      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options."
+      "[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl and @fastify/swagger could not be find either. Please provide one of these options."
     );
     return;
   }
   fastify.get(options.routePrefix ?? "/", async (_, reply) => {
+    var _a2, _b2;
     reply.header("Content-Type", "text/html; charset=utf-8");
+    let mergedOptions = options;
+    if (!((_a2 = options.apiReference) == null ? void 0 : _a2.spec) && !((_b2 = options.apiReference) == null ? void 0 : _b2.specUrl) && hasSwaggerPlugin) {
+      mergedOptions = {
+        ...options,
+        apiReference: {
+          ...options.apiReference,
+          // @ts-ignore
+          spec: () => fastify.swagger()
+        }
+      };
+    }
     const html = await ejs.renderFile(
       path.resolve(`${__dirname}/../dist/templates/index.ejs`),
       {
-        options
+        options: mergedOptions
       }
     );
     reply.send(html);