@scalar/fastify-api-reference 0.6.37 → 0.6.39

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @scalar/fastify-api-reference
 
+## 0.6.39
+
+### Patch Changes
+
+- Updated dependencies [d5fccba9]
+  - @scalar/api-reference@0.8.3
+
+## 0.6.38
+
+### Patch Changes
+
+- 4685f391: feat: use new universal configuration object
+- 4685f391: feat: introducing the new universal configuration object
+- Updated dependencies [3b042270]
+- Updated dependencies [4685f391]
+- Updated dependencies [8ac1ad69]
+- Updated dependencies [28191084]
+- Updated dependencies [e01134d4]
+  - @scalar/api-reference@0.8.2
+
 ## 0.6.37
 
 ### Patch Changes

package/README.md

@@ -23,7 +23,9 @@ fastify.register(require('@scalar/fastify-api-reference'), {
   routePrefix: '/reference',
   apiReference: {
     title: 'Our API Reference',
-    specUrl: '/swagger.json',
+    spec: {
+      url: '/swagger.json',
+    },
   },
 })
 ```
@@ -34,7 +36,9 @@ With the [@fastify/swagger](https://github.com/fastify/fastify-swagger) you can
 await fastify.register(require('@scalar/fastify-api-reference'), {
   routePrefix: '/reference',
   apiReference: {
-    spec: () => fastify.swagger(),
+    spec: {
+      content: () => fastify.swagger(),
+    },
   },
 })
 ```
@@ -53,7 +57,11 @@ Or, if you just have a static OpenAPI spec, you can directly pass it, too:
 await fastify.register(require('@scalar/fastify-api-reference'), {
   routePrefix: '/reference',
   apiReference: {
-    spec: { … },
+    spec: {
+      content: { … }
+    },
   },
 })
 ```
+
+The fastify plugin takes our universal configuration object, [read more about configuration](https://github.com/scalar/scalar/tree/main/packages/api-reference#props) in the core package README.

package/dist/fastifyApiReference.d.ts

@@ -1,3 +1,4 @@
+import { type ReferenceConfiguration } from '@scalar/api-reference';
 import type { FastifyPluginAsync } from 'fastify';
 export type ApiReferenceOptions = {
     /**
@@ -6,10 +7,8 @@ export type ApiReferenceOptions = {
      * @default '/'
      */
     routePrefix: string;
-    apiReference?: {
-        specUrl?: string;
-        spec?: Record<string, any> | (() => Record<string, any>);
-        title?: string;
+    apiReference?: ReferenceConfiguration & {
+        pageTitle?: string;
     };
 };
 declare const _default: FastifyPluginAsync<ApiReferenceOptions>;

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,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;;AAkFD,wBAAsC"}
+{"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAEnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAKjD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,sBAAsB,GAAG;QACtC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF,CAAA;;AAkFD,wBAAsC"}

package/dist/index.cjs

@@ -7,11 +7,11 @@ const schemaToHideRoute = {
   hide: true
 };
 const fastifyApiReference = async (fastify, options) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const hasSwaggerPlugin = fastify.hasPlugin("@fastify/swagger");
-  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl) && !hasSwaggerPlugin) {
+  if (!((_b = (_a = options.apiReference) == null ? void 0 : _a.spec) == null ? void 0 : _b.content) && !((_d = (_c = options.apiReference) == null ? void 0 : _c.spec) == null ? void 0 : _d.url) && !hasSwaggerPlugin) {
     console.warn(
-      "[@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."
+      "[@scalar/fastify-api-reference] You didn’t provide a spec.content or spec.url and @fastify/swagger could not be find either. Please provide one of these options."
     );
     return;
   }
@@ -22,16 +22,16 @@ const fastifyApiReference = async (fastify, options) => {
     // @ts-ignore
     schema: schemaToHideRoute,
     async handler(_, reply) {
-      var _a2, _b2;
+      var _a2, _b2, _c2, _d2;
       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) {
+      if (!((_b2 = (_a2 = options.apiReference) == null ? void 0 : _a2.spec) == null ? void 0 : _b2.content) && !((_d2 = (_c2 = options.apiReference) == null ? void 0 : _c2.spec) == null ? void 0 : _d2.url) && hasSwaggerPlugin) {
         mergedOptions = {
           ...options,
           apiReference: {
             ...options.apiReference,
             // @ts-ignore
-            spec: () => fastify.swagger()
+            spec: { content: () => fastify.swagger() }
           }
         };
       }

package/dist/index.js

@@ -15,11 +15,11 @@ const schemaToHideRoute = {
   hide: true
 };
 const fastifyApiReference = async (fastify, options) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const hasSwaggerPlugin = fastify.hasPlugin("@fastify/swagger");
-  if (!((_a = options.apiReference) == null ? void 0 : _a.spec) && !((_b = options.apiReference) == null ? void 0 : _b.specUrl) && !hasSwaggerPlugin) {
+  if (!((_b = (_a = options.apiReference) == null ? void 0 : _a.spec) == null ? void 0 : _b.content) && !((_d = (_c = options.apiReference) == null ? void 0 : _c.spec) == null ? void 0 : _d.url) && !hasSwaggerPlugin) {
     console.warn(
-      "[@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."
+      "[@scalar/fastify-api-reference] You didn’t provide a spec.content or spec.url and @fastify/swagger could not be find either. Please provide one of these options."
     );
     return;
   }
@@ -30,16 +30,16 @@ const fastifyApiReference = async (fastify, options) => {
     // @ts-ignore
     schema: schemaToHideRoute,
     async handler(_, reply) {
-      var _a2, _b2;
+      var _a2, _b2, _c2, _d2;
       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) {
+      if (!((_b2 = (_a2 = options.apiReference) == null ? void 0 : _a2.spec) == null ? void 0 : _b2.content) && !((_d2 = (_c2 = options.apiReference) == null ? void 0 : _c2.spec) == null ? void 0 : _d2.url) && hasSwaggerPlugin) {
         mergedOptions = {
           ...options,
           apiReference: {
             ...options.apiReference,
             // @ts-ignore
-            spec: () => fastify.swagger()
+            spec: { content: () => fastify.swagger() }
           }
         };
       }