npm - @scalar/fastify-api-reference - Versions diffs - 0.4.1 → 0.5.0 - Mend

@scalar/fastify-api-reference 0.4.1 → 0.5.0

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 (10) hide show

package/README.md +14 -3
package/dist/fastifyApiReference.d.ts +8 -8
package/dist/fastifyApiReference.d.ts.map +1 -1
package/dist/index.js +15 -11
package/dist/index.umd.cjs +2 -2
package/package.json +30 -33
package/src/esm.test.ts +0 -27
package/src/fastifyApiReference.test.ts +0 -148
package/src/fastifyApiReference.ts +0 -65
package/src/index.ts +0 -1

package/README.md CHANGED Viewed

@@ -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: '/api-reference',
+  prefix: '/reference',
   apiReference: {
     title: 'Our API Reference',
     specUrl: '/swagger.json',
@@ -32,9 +32,20 @@ With the [@fastify/swagger](https://github.com/fastify/fastify-swagger) you can
 ```ts
 await fastify.register(require('@scalar/fastify-api-reference'), {
-  prefix: '/api-reference',
+  prefix: '/reference',
   apiReference: {
-    spec: fastify.swagger(),
+    spec: () => fastify.swagger(),
+  },
+})
+```
+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',
+  apiReference: {
+    spec: { … },
   },
 })
 ```

package/dist/fastifyApiReference.d.ts CHANGED Viewed

@@ -1,12 +1,12 @@
-import { type FastifyPluginCallback, type RegisterOptions } from 'fastify';
-type ApiReferenceOptions = {
+import { type FastifyPluginAsync } from 'fastify';
+export type ApiReferencePlugin = {
+    apiReference: ApiReferenceOptions;
+};
+export type ApiReferenceOptions = {
     title?: string;
     specUrl?: string;
-    spec?: Record<string, any>;
+    spec?: Record<string, any> | (() => Record<string, any>);
 };
-export type FastifyApiReferenceOptions = FastifyPluginCallback<Partial<RegisterOptions> & {
-    apiReference: ApiReferenceOptions;
-}>;
-declare const fastifyApiReference: FastifyApiReferenceOptions;
-export default fastifyApiReference;
+declare const fastifyApiReferencePlugin: FastifyPluginAsync<ApiReferencePlugin>;
+export default fastifyApiReferencePlugin;
 //# sourceMappingURL=fastifyApiReference.d.ts.map

package/dist/fastifyApiReference.d.ts.map CHANGED Viewed

	@@ -1 +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~~,~~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"}
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"}

package/dist/index.js CHANGED Viewed

@@ -1,5 +1,5 @@
-const s = (e) => {
-  const t = e.specUrl ? `<div data-spec-url="${e.specUrl}" />` : `<div data-spec='${JSON.stringify(e.spec)}' />`;
+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>
@@ -17,16 +17,20 @@ const s = (e) => {
   </body>
 </html>
 `;
-}, n = (e, t, r) => {
-  !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."
-  ), r()), e.addHook("onSend", (d, a, c, l) => {
-    a.header("Content-Type", "text/html; charset=utf-8"), l();
-  }), e.get("/", (d, a) => {
-    const c = s(t == null ? void 0 : t.apiReference);
+}, 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);
-  }), r();
+  });
 };
 export {
-  n as default
+  l as default
 };

package/dist/index.umd.cjs CHANGED Viewed

@@ -1,4 +1,4 @@
-(function(r,c){typeof exports=="object"&&typeof module<"u"?module.exports=c():typeof define=="function"&&define.amd?define(c):(r=typeof globalThis<"u"?globalThis:r||self,r["@scalar/fastify-api-reference"]=c())})(this,function(){"use strict";const r=e=>{const t=e.specUrl?`<div data-spec-url="${e.specUrl}" />`:`<div data-spec='${JSON.stringify(e.spec)}' />`;return`
+(function(c,r){typeof exports=="object"&&typeof module<"u"?module.exports=r():typeof define=="function"&&define.amd?define(r):(c=typeof globalThis<"u"?globalThis:c||self,c["@scalar/fastify-api-reference"]=r())})(this,function(){"use strict";const c=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>
@@ -14,4 +14,4 @@
     <script src="https://cdn.scalar.com/api-reference.standalone.js"><\/script>
   </body>
 </html>
-`};return(e,t,n)=>{!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."),n()),e.addHook("onSend",(s,a,i,d)=>{a.header("Content-Type","text/html; charset=utf-8"),d()}),e.get("/",(s,a)=>{const i=r(t==null?void 0:t.apiReference);a.send(i)}),n()}});
+`};return 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",(s,a,n,i)=>{a.header("Content-Type","text/html; charset=utf-8"),i()}),e.get("/",async(s,a)=>{const n=c(t==null?void 0:t.apiReference);a.send(n)})}});

package/package.json CHANGED Viewed

@@ -1,52 +1,49 @@
 {
   "name": "@scalar/fastify-api-reference",
   "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",
+  "version": "0.5.0",
   "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": "https://github.com/scalar/scalar/issues/new",
+  "dependencies": {
+    "fastify": "4.23.2"
   },
-  "bugs": {
-    "url": "https://github.com/scalar/scalar/issues/new"
+  "devDependencies": {
+    "@vitest/coverage-v8": "0.34.4",
+    "nodemon": "3.0.1",
+    "tsc-alias": "1.8.8",
+    "typescript": "5.2.2",
+    "vite": "4.4.9",
+    "vite-node": "0.34.4",
+    "vitest": "0.34.4"
   },
-  "license": "MIT",
   "engines": {
     "node": ">=18"
   },
-  "type": "module",
+  "exports": {
+    "require": "./dist/index.umd.cjs",
+    "import": "./dist/index.js"
+  },
   "files": [
-    "src",
     "dist"
   ],
+  "homepage": "https://github.com/scalar/scalar",
+  "keywords": [
+    "api",
+    "documentation",
+    "fastify",
+    "openapi",
+    "swagger"
+  ],
+  "license": "MIT",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
-  "exports": {
-    "development": "./src/index.ts",
-    "require": "./dist/index.umd.cjs",
-    "import": "./dist/index.js"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/fastify-api-reference"
   },
+  "type": "module",
   "types": "dist/index.d.ts",
-  "dependencies": {
-    "fastify": "^4.22.1"
-  },
-  "devDependencies": {
-    "nodemon": "^3.0.1",
-    "tsc-alias": "1.8.6",
-    "typescript": "^5.2.2",
-    "vite": "4.4.8",
-    "vite-node": "^0.34.3",
-    "vitest": "0.34.1"
-  },
   "scripts": {
     "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",
     "lint:check": "eslint .",

package/src/esm.test.ts DELETED Viewed

@@ -1,27 +0,0 @@
-import Fastify from 'fastify'
-import { describe, expect, it } from 'vitest'
-import fastifyApiReference from '../dist/index'
-describe('esm base support', () => {
-  it('returns 200 OK', () =>
-    new Promise((resolve) => {
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          specUrl: '/scalar.json',
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then((response) => {
-          expect(response.status).toBe(200)
-          resolve(null)
-        })
-      })
-    }))
-})

package/src/fastifyApiReference.test.ts DELETED Viewed

@@ -1,148 +0,0 @@
-import Fastify from 'fastify'
-import { describe, expect, it } from 'vitest'
-import fastifyApiReference from './index'
-describe('fastifyApiReference', () => {
-  it('returns 200 OK', () =>
-    new Promise((resolve) => {
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          specUrl: '/scalar.json',
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then((response) => {
-          expect(response.status).toBe(200)
-          resolve(null)
-        })
-      })
-    }))
-  it('has the spec URL', () =>
-    new Promise((resolve) => {
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          specUrl: '/scalar.json',
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then(async (response) => {
-          expect(await response.text()).toContain(
-            'data-spec-url="/scalar.json"',
-          )
-          resolve(null)
-        })
-      })
-    }))
-  it('has the spec', () =>
-    new Promise((resolve) => {
-      const spec = {
-        openapi: '3.1.0',
-        info: {
-          title: 'Example',
-        },
-        paths: {},
-      }
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          spec,
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then(async (response) => {
-          expect(await response.text()).toContain(
-            `data-spec='${JSON.stringify(spec)}'`,
-          )
-          resolve(null)
-        })
-      })
-    }))
-  it('has the default title', () =>
-    new Promise((resolve) => {
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          specUrl: '/scalar.json',
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then(async (response) => {
-          expect(await response.text()).toContain(
-            '<title>API Reference</title>',
-          )
-          resolve(null)
-        })
-      })
-    }))
-  it('has the custom title', () =>
-    new Promise((resolve) => {
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          title: 'Foobar',
-          specUrl: '/scalar.json',
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then(async (response) => {
-          expect(await response.text()).toContain('<title>Foobar</title>')
-          resolve(null)
-        })
-      })
-    }))
-  it('has the correct content type', () =>
-    new Promise((resolve) => {
-      const fastify = Fastify({
-        logger: false,
-      })
-      fastify.register(fastifyApiReference, {
-        prefix: '/api-reference',
-        apiReference: {
-          specUrl: '/scalar.json',
-        },
-      })
-      fastify.listen({ port: 0 }, function (err, address) {
-        fetch(`${address}/api-reference`).then(async (response) => {
-          expect(response.headers.has('content-type')).toBe(true)
-          expect(response.headers.get('content-type')).toContain('text/html')
-          resolve(null)
-        })
-      })
-    }))
-})

package/src/fastifyApiReference.ts DELETED Viewed

@@ -1,65 +0,0 @@
-import { type FastifyPluginCallback, type RegisterOptions } from 'fastify'
-type ApiReferenceOptions = {
-  title?: string
-  specUrl?: string
-  spec?: Record<string, any>
-}
-export type FastifyApiReferenceOptions = FastifyPluginCallback<
-  Partial<RegisterOptions> & {
-    apiReference: ApiReferenceOptions
-  }
->
-const getHtmlMarkup = (options: ApiReferenceOptions) => {
-  const htmlTag = options.specUrl
-    ? `<div data-spec-url="${options.specUrl}" />`
-    : `<div data-spec='${JSON.stringify(options.spec)}' />`
-  return `
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>${options.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: -->
-    ${htmlTag}
-    <script src="https://cdn.scalar.com/api-reference.standalone.js"></script>
-  </body>
-</html>
-`
-}
-const fastifyApiReference: FastifyApiReferenceOptions = (
-  fastify,
-  options,
-  done,
-) => {
-  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.',
-    )
-    done()
-  }
-  fastify.addHook('onSend', (request, reply, payload, next) => {
-    reply.header('Content-Type', 'text/html; charset=utf-8')
-    next()
-  })
-  fastify.get('/', (_, reply) => {
-    const html = getHtmlMarkup(options?.apiReference)
-    reply.send(html)
-  })
-  done()
-}
-export default fastifyApiReference

package/src/index.ts DELETED Viewed

	@@ -1 +0,0 @@
1	- export { default } from './fastifyApiReference'