@scalar/fastify-api-reference 0.3.2 → 0.4.1

package/README.md

@@ -1,5 +1,10 @@
 # Scalar Fastify API Reference Plugin
 
+![Version](https://img.shields.io/npm/v/%40scalar/fastify-api-reference)
+![Downloads](https://img.shields.io/npm/dm/%40scalar/fastify-api-reference)
+![License](https://img.shields.io/npm/l/%40scalar%2Ffastify-api-reference)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/mw6FQRPh)
+
 This plugin provides an easy way to render a beautiful API reference based on a OpenAPI/Swagger file with Fastify.
 
 ## Installation

package/dist/fastifyApiReference.d.ts

@@ -4,9 +4,9 @@ type ApiReferenceOptions = {
     specUrl?: string;
     spec?: Record<string, any>;
 };
-export type FastifyApiReferenceOptions = {
+export type FastifyApiReferenceOptions = FastifyPluginCallback<Partial<RegisterOptions> & {
     apiReference: ApiReferenceOptions;
-} & RegisterOptions;
-declare const fastifyApiReference: FastifyPluginCallback<FastifyApiReferenceOptions>;
+}>;
+declare const fastifyApiReference: FastifyApiReferenceOptions;
 export default fastifyApiReference;
 //# 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,EAAE,KAAK,qBAAqB,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAA;AAE1E,KAAK,mBAAmB,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,YAAY,EAAE,mBAAmB,CAAA;CAClC,GAAG,eAAe,CAAA;AA0BnB,QAAA,MAAM,mBAAmB,EAAE,qBAAqB,CAAC,0BAA0B,CAwB1E,CAAA;AAED,eAAe,mBAAmB,CAAA"}
+{"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAA;AAE1E,KAAK,mBAAmB,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,qBAAqB,CAC5D,OAAO,CAAC,eAAe,CAAC,GAAG;IACzB,YAAY,EAAE,mBAAmB,CAAA;CAClC,CACF,CAAA;AA0BD,QAAA,MAAM,mBAAmB,EAAE,0BAwB1B,CAAA;AAED,eAAe,mBAAmB,CAAA"}

package/package.json

@@ -1,7 +1,24 @@
 {
   "name": "@scalar/fastify-api-reference",
-  "version": "0.3.2",
-  "author": "Scalar",
+  "description": "a fastify plugin to render an API reference from an automatically generated OpenAPI spec",
+  "keywords": [
+    "fastify",
+    "openapi",
+    "swagger",
+    "api",
+    "documentation"
+  ],
+  "version": "0.4.1",
+  "author": "Scalar (https://github.com/scalar)",
+  "homepage": "https://github.com/scalar/scalar",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/fastify-api-reference"
+  },
+  "bugs": {
+    "url": "https://github.com/scalar/scalar/issues/new"
+  },
   "license": "MIT",
   "engines": {
     "node": ">=18"

package/src/fastifyApiReference.test.ts

@@ -1,7 +1,7 @@
 import Fastify from 'fastify'
 import { describe, expect, it } from 'vitest'
 
-import fastifyApiReference from './fastifyApiReference'
+import fastifyApiReference from './index'
 
 describe('fastifyApiReference', () => {
   it('returns 200 OK', () =>

package/src/fastifyApiReference.ts

@@ -6,9 +6,11 @@ type ApiReferenceOptions = {
   spec?: Record<string, any>
 }
 
-export type FastifyApiReferenceOptions = {
-  apiReference: ApiReferenceOptions
-} & RegisterOptions
+export type FastifyApiReferenceOptions = FastifyPluginCallback<
+  Partial<RegisterOptions> & {
+    apiReference: ApiReferenceOptions
+  }
+>
 
 const getHtmlMarkup = (options: ApiReferenceOptions) => {
   const htmlTag = options.specUrl
@@ -34,7 +36,7 @@ const getHtmlMarkup = (options: ApiReferenceOptions) => {
 `
 }
 
-const fastifyApiReference: FastifyPluginCallback<FastifyApiReferenceOptions> = (
+const fastifyApiReference: FastifyApiReferenceOptions = (
   fastify,
   options,
   done,