npm - @scalar/fastify-api-reference - Versions diffs - 0.2.0 → 0.3.0 - Mend

@scalar/fastify-api-reference 0.2.0 → 0.3.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 (5) hide show

package/dist/index.umd.cjs +17 -0
package/package.json +6 -6
package/src/fastifyApiReference.test.ts +148 -0
package/src/fastifyApiReference.ts +60 -0
package/src/index.ts +1 -0

package/dist/index.umd.cjs ADDED Viewed

@@ -0,0 +1,17 @@
+(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=t=>{const e=t.specUrl?`<div data-spec-url="${t.specUrl}" />`:`<div data-spec='${JSON.stringify(t.spec)}' />`;return`
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>${t.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: -->
+    ${e}
+    <script src="https://cdn.scalar.com/api-reference.standalone.js"><\/script>
+  </body>
+</html>
+`};return(t,e,a)=>{if(!e.apiReference.spec&&!e.apiReference.specUrl){console.warn("[@scalar/fastify-api-reference] You didn’t provide a spec or specUrl. Please provide one of these options."),a();return}t.get("/",(s,i)=>{const n=r(e==null?void 0:e.apiReference);i.headers({"Content-Type":"text/html; charset=utf-8"}),i.send(n)}),a()}});

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@scalar/fastify-api-reference",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Scalar",
   "license": "MIT",
   "engines": {
@@ -8,15 +8,15 @@
   },
   "type": "module",
   "files": [
+    "src",
     "dist"
   ],
-  "main": "./dist/index.js",
+  "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
   "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
-    }
+    "development": "./src/index.ts",
+    "require": "./dist/index.umd.cjs",
+    "import": "./dist/index.js"
   },
   "types": "dist/index.d.ts",
   "dependencies": {

package/src/fastifyApiReference.test.ts ADDED Viewed

@@ -0,0 +1,148 @@
+import Fastify from 'fastify'
+import { describe, expect, it } from 'vitest'
+import fastifyApiReference from './fastifyApiReference'
+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 ADDED Viewed

@@ -0,0 +1,60 @@
+import { type FastifyInstance, type RegisterOptions } from 'fastify'
+export type FastifyApiReferenceOptions = {
+  title?: string
+  specUrl?: string
+  spec?: Record<string, any>
+}
+const getHtmlMarkup = (options: FastifyApiReferenceOptions) => {
+  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>
+`
+}
+export default (
+  fastify: FastifyInstance,
+  options: RegisterOptions & {
+    apiReference: FastifyApiReferenceOptions
+  },
+  done: (err?: Error) => void,
+) => {
+  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()
+    return
+  }
+  fastify.get('/', (_, reply) => {
+    const html = getHtmlMarkup(options?.apiReference)
+    reply.headers({
+      'Content-Type': 'text/html; charset=utf-8',
+    })
+    reply.send(html)
+  })
+  done()
+}

package/src/index.ts ADDED Viewed

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