@platformatic/service 1.15.0 → 1.16.0

package/index.js

@@ -21,11 +21,11 @@ const { addLoggerToTheConfig } = require('./lib/utils')
 const { start, buildServer } = require('./lib/start')
 const ServiceGenerator = require('./lib/generator/service-generator.js')
 
-// TODO(mcollina): toLoad is deprecated, remove it in the next major version.
-async function platformaticService (app, opts, toLoad) {
+// TODO(mcollina): arugments[2] is deprecated, remove it in the next major version.
+async function platformaticService (app, opts) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
-  const beforePlugins = opts.beforePlugins || toLoad || []
+  const beforePlugins = opts.beforePlugins || arguments[2] || []
 
   if (isKeyEnabled('metrics', config)) {
     app.register(setupMetrics, config.metrics)

package/lib/plugins/openapi.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const Swagger = require('@fastify/swagger')
-const SwaggerUI = require('@fastify/swagger-ui')
+const ScalarApiReference = require('@scalar/fastify-api-reference')
 const deepmerge = require('@fastify/deepmerge')({ all: true })
 const fp = require('fastify-plugin')
 
@@ -54,12 +54,20 @@ async function setupOpenAPI (app, opts) {
 
   await app.register(Swagger, swaggerOptions)
 
-  const { default: theme } = await import('@platformatic/swagger-ui-theme')
-  app.register(SwaggerUI, {
-    ...theme,
+  const { default: scalarTheme } = await import('@platformatic/scalar-theme')
+  const routePrefix = openapi.swaggerPrefix || '/documentation'
+
+  /** Serve spec file in yaml and json */
+  app.get(`${routePrefix}/json`, { schema: { hide: true } }, async () => app.swagger())
+  app.get(`${routePrefix}/yaml`, { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+  app.register(ScalarApiReference, {
+    ...opts,
     ...openapi,
-    logLevel: 'warn',
-    prefix: openapi.swaggerPrefix || '/documentation'
+    routePrefix,
+    configuration: {
+      customCss: scalarTheme.theme
+    }
   })
 }
 

package/lib/plugins/versions.js

@@ -13,7 +13,7 @@ const {
 const wrapperPath = join(__dirname, 'sandbox-wrapper.js')
 
 const Swagger = require('@fastify/swagger')
-const SwaggerUI = require('@fastify/swagger-ui')
+const ScalarApiReference = require('@scalar/fastify-api-reference')
 
 async function loadVersions (app) {
   const configManager = app.platformatic.configManager
@@ -44,9 +44,12 @@ async function loadVersions (app) {
       }
     })
 
-    app.register(SwaggerUI, {
+    app.get('/documentation/json', { schema: { hide: true } }, async () => app.swagger())
+    app.get('/documentation/yaml', { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+    app.register(ScalarApiReference, {
       logLevel: 'warn',
-      prefix: '/documentation'
+      routePrefix: '/documentation'
     })
 
     if (latestVersionConfig.plugins) {
@@ -110,9 +113,12 @@ async function loadVersions (app) {
         }
       })
 
-      app.register(SwaggerUI, {
+      app.get('/documentation/json', { schema: { hide: true } }, async () => app.swagger())
+      app.get('/documentation/yaml', { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+      app.register(ScalarApiReference, {
         logLevel: 'warn',
-        prefix: '/documentation'
+        routePrefix: '/documentation'
       })
 
       const componentSchemas = prevOpenapiSchema.components?.schemas ?? {}

package/lib/root-endpoint/public/index.html

@@ -222,6 +222,9 @@
     <script>
       const currentPath = window.location.pathname
     
+      const openApiLink = document.getElementById('openapi-link')
+      openApiLink.href = currentPath + 'documentation'
+
       const graphqlLink = document.getElementById('graphql-link')
       graphqlLink.href = currentPath + 'graphiql'
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -48,42 +48,42 @@
     "@fastify/restartable": "^2.1.1",
     "@fastify/static": "^6.11.2",
     "@fastify/swagger": "^8.10.1",
-    "@fastify/swagger-ui": "^2.0.0",
     "@fastify/under-pressure": "^8.3.0",
     "@mercuriusjs/federation": "^2.0.0",
+    "@scalar/fastify-api-reference": "^1.10.1",
     "@types/ws": "^8.5.6",
     "ajv": "^8.12.0",
+    "cli-progress": "^3.12.0",
     "close-with-grace": "^1.2.0",
     "code-block-writer": "^12.0.0",
-    "commist": "^3.2.0",
     "colorette": "^2.0.20",
-    "cli-progress": "^3.12.0",
+    "commist": "^3.2.0",
     "desm": "^1.3.0",
     "env-schema": "^5.2.0",
     "es-main": "^1.3.0",
     "execa": "^8.0.1",
     "fastify": "^4.23.2",
-    "fastify-openapi-glue": "^4.3.3",
     "fastify-metrics": "^10.3.2",
+    "fastify-openapi-glue": "^4.3.3",
     "fastify-plugin": "^4.5.1",
     "graphql": "^16.8.1",
-    "help-me": "^4.2.0",
+    "help-me": "^5.0.0",
     "mercurius": "^13.1.0",
     "minimist": "^1.2.8",
     "openapi-schema-diff": "^0.0.1",
     "pino": "^8.15.3",
     "pino-pretty": "^10.2.0",
     "rfdc": "^1.3.0",
-    "undici": "^6.0.0",
     "ua-parser-js": "^1.0.36",
-    "@platformatic/client": "1.15.0",
-    "@platformatic/config": "1.15.0",
-    "@platformatic/authenticate": "1.15.0",
-    "@platformatic/generators": "1.15.0",
-    "@platformatic/swagger-ui-theme": "1.15.0",
-    "@platformatic/telemetry": "1.15.0",
-    "@platformatic/metaconfig": "1.15.0",
-    "@platformatic/utils": "1.15.0"
+    "undici": "^6.0.0",
+    "@platformatic/authenticate": "1.16.0",
+    "@platformatic/config": "1.16.0",
+    "@platformatic/generators": "1.16.0",
+    "@platformatic/scalar-theme": "1.16.0",
+    "@platformatic/telemetry": "1.16.0",
+    "@platformatic/utils": "1.16.0",
+    "@platformatic/client": "1.16.0",
+    "@platformatic/metaconfig": "1.16.0"
   },
   "standard": {
     "ignore": [
@@ -98,7 +98,7 @@
     ]
   },
   "scripts": {
-    "test": "pnpm run lint && c8 -x fixtures -x test node ./test/runner.js && tsd",
+    "test": "pnpm run lint && node ./test/runner.js && tsd",
     "nocov": "pnpm run lint && node ./test/runner.js && tsd",
     "build": "node lib/schema.js | json2ts > config.d.ts",
     "lint": "standard | snazzy && ts-standard | snazzy"