chore: export formatParamUrl

index.d.ts

@@ -186,6 +186,8 @@ declare namespace fastifySwagger {
     preHandler?: preHandlerHookHandler,
   }>
 
+  export function formatParamUrl (paramUrl: string): string
+
   export const fastifySwagger: FastifySwagger
   export { fastifySwagger as default }
 }

index.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const fp = require('fastify-plugin')
+const { formatParamUrl } = require('./lib/util/format-param-url')
 
 function fastifySwagger (fastify, opts, next) {
   // by default the mode is dynamic, as plugin initially was developed
@@ -29,3 +30,5 @@ module.exports = fp(fastifySwagger, {
 })
 module.exports.fastifySwagger = fastifySwagger
 module.exports.default = fastifySwagger
+
+module.exports.formatParamUrl = formatParamUrl

lib/mode/dynamic.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const { addHook, resolveSwaggerFunction } = require('../util/common')
+const { addHook } = require('../util/add-hook')
+const { resolveSwaggerFunction } = require('../util/resolve-swagger-function')
 
 module.exports = function (fastify, opts, done) {
   opts = Object.assign({}, {

lib/spec/openapi/index.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const yaml = require('yaml')
-const { shouldRouteHide } = require('../../util/common')
+const { shouldRouteHide } = require('../../util/should-route-hide')
 const { prepareDefaultOptions, prepareOpenapiObject, prepareOpenapiMethod, prepareOpenapiSchemas, normalizeUrl, resolveServerUrls } = require('./utils')
 
 module.exports = function (opts, cache, routes, Ref, done) {

lib/spec/openapi/utils.js

@@ -1,6 +1,8 @@
 'use strict'
 
-const { readPackageJson, formatParamUrl, resolveLocalRef } = require('../../util/common')
+const { readPackageJson } = require('../../util/read-package-json')
+const { formatParamUrl } = require('../../util/format-param-url')
+const { resolveLocalRef } = require('../../util/resolve-local-ref')
 const { xResponseDescription, xConsume, xExamples } = require('../../constants')
 const { rawRequired } = require('../../symbols')
 

lib/spec/swagger/index.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const yaml = require('yaml')
-const { shouldRouteHide } = require('../../util/common')
+const { shouldRouteHide } = require('../../util/should-route-hide')
 const { prepareDefaultOptions, prepareSwaggerObject, prepareSwaggerMethod, normalizeUrl, prepareSwaggerDefinitions } = require('./utils')
 
 module.exports = function (opts, cache, routes, Ref, done) {

lib/spec/swagger/utils.js

@@ -1,6 +1,8 @@
 'use strict'
 
-const { readPackageJson, formatParamUrl, resolveLocalRef } = require('../../util/common')
+const { readPackageJson } = require('../../util/read-package-json')
+const { formatParamUrl } = require('../../util/format-param-url')
+const { resolveLocalRef } = require('../../util/resolve-local-ref')
 const { xResponseDescription, xConsume } = require('../../constants')
 
 function prepareDefaultOptions (opts) {

lib/util/add-hook.js

@@ -0,0 +1,77 @@
+'use strict'
+
+const Ref = require('json-schema-resolver')
+const cloner = require('rfdc')({ proto: true, circles: false })
+
+function addHook (fastify, pluginOptions) {
+  const routes = []
+  const sharedSchemasMap = new Map()
+
+  fastify.addHook('onRoute', (routeOptions) => {
+    const routeConfig = routeOptions.config || {}
+    const swaggerConfig = routeConfig.swagger || {}
+    if (routeOptions.method === 'HEAD' && pluginOptions.exposeHeadRoutes !== true && swaggerConfig.exposeHeadRoute !== true) {
+      return
+    }
+
+    if (
+      routeOptions.method === 'HEAD' &&
+            routeOptions.schema !== undefined &&
+            routeOptions.schema.operationId !== undefined
+    ) {
+      routes.push(
+        // If two routes with operationId are added to the swagger
+        // object, it is no longer valid.
+        // therefore we suffix the operationId with `-head`.
+        Object.assign({}, routeOptions, {
+          schema: Object.assign({}, routeOptions.schema, {
+            operationId: `${routeOptions.schema.operationId}-head`
+          })
+        })
+      )
+      return
+    }
+
+    routes.push(routeOptions)
+  })
+
+  fastify.addHook('onRegister', async (instance) => {
+    // we need to wait the ready event to get all the .getSchemas()
+    // otherwise it will be empty
+    // TODO: better handle for schemaId
+    // when schemaId is the same in difference instance
+    // the latter will lost
+    instance.addHook('onReady', (done) => {
+      const allSchemas = instance.getSchemas()
+      for (const schemaId of Object.keys(allSchemas)) {
+        sharedSchemasMap.set(schemaId, allSchemas[schemaId])
+      }
+      done()
+    })
+  })
+
+  fastify.addHook('onReady', (done) => {
+    const allSchemas = fastify.getSchemas()
+    for (const schemaId of Object.keys(allSchemas)) {
+      // it is the top-level, we do not expect to have duplicate id
+      sharedSchemasMap.set(schemaId, allSchemas[schemaId])
+    }
+    done()
+  })
+
+  return {
+    routes,
+    Ref () {
+      const externalSchemas = cloner(Array.from(sharedSchemasMap.values()))
+      return Ref(Object.assign(
+        { applicationUri: 'todo.com' },
+        pluginOptions.refResolver,
+        { clone: true, externalSchemas })
+      )
+    }
+  }
+}
+
+module.exports = {
+  addHook
+}