@platformatic/service 1.18.0 → 1.20.0

package/index.d.ts

@@ -4,9 +4,14 @@
 import { FastifyInstance, FastifyBaseLogger } from 'fastify'
 import ConfigManager from '@platformatic/config'
 import type { IConfigManagerOptions } from '@platformatic/config'
+import { BaseGenerator } from '@platformatic/generators'
 import { PlatformaticService } from './config'
 import type { JSONSchemaType } from 'ajv'
 import { ServiceGenerator } from './lib/generator/service-generator'
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+export import Generator = ServiceGenerator.ServiceGenerator
+
 export interface PlatformaticApp<T> {
   configManager: ConfigManager<T>
   config: T
@@ -14,7 +19,8 @@ export interface PlatformaticApp<T> {
 
 export type PlatformaticServiceConfig = PlatformaticService
 
-export function buildServer (opts: object, app?: object, ConfigManagerContructor?: object): Promise<FastifyInstance>
+export function buildServer (opts: object, app?: object, ConfigManagerConstructor?: object): Promise<FastifyInstance>
+export function start<ConfigType> (app: Stackable<ConfigType>, args: string[]): Promise<void>
 
 declare module 'fastify' {
   interface FastifyInstance {
@@ -33,6 +39,7 @@ export interface Stackable<ConfigType> {
   configType: string
   configManagerConfig: ConfigManagerConfig<ConfigType>
   schema: object
+  Generator?: new () => BaseGenerator.BaseGenerator
 }
 
 interface SchemaExport {
@@ -45,6 +52,7 @@ interface TSCompilerOptions {
 interface TSCompiler {
   compile: (cwd: string, config: object, originalLogger: FastifyBaseLogger, options: TSCompilerOptions) => Promise<boolean>
 }
+
 export const schema: SchemaExport
 
 export declare const platformaticService: Stackable<PlatformaticServiceConfig>
@@ -52,5 +60,3 @@ export declare const platformaticService: Stackable<PlatformaticServiceConfig>
 export default platformaticService
 
 export const tsCompiler: TSCompiler
-
-export const Generator: ServiceGenerator.ServiceGenerator

package/index.test-d.ts

@@ -1,10 +1,19 @@
 import { expectType } from 'tsd'
 import { FastifyInstance } from 'fastify'
-import { buildServer, PlatformaticApp, platformaticService, Stackable, PlatformaticServiceConfig } from '.'
 import ConfigManager from '@platformatic/config'
 import { OpenAPI } from 'openapi-types'
 import type { MercuriusPlugin } from 'mercurius'
 import { PlatformaticService } from './config'
+import { BaseGenerator } from '@platformatic/generators'
+import {
+  start,
+  buildServer,
+  PlatformaticApp,
+  platformaticService,
+  Stackable,
+  Generator,
+  PlatformaticServiceConfig
+} from '.'
 
 declare module 'fastify' {
   interface FastifyInstance {
@@ -12,8 +21,7 @@ declare module 'fastify' {
   }
 }
 
-const server = await buildServer({
-})
+const server = await buildServer({})
 
 expectType<FastifyInstance>(server)
 expectType<ConfigManager<PlatformaticService>>(server.platformatic.configManager)
@@ -41,7 +49,18 @@ function buildStackable (): Stackable<PlatformaticServiceConfig> {
     }
   }
 
+  await start(myApp, ['--help'])
+
   return myApp
 }
 
 expectType<Stackable<PlatformaticServiceConfig>>(buildStackable())
+
+const generator = new Generator()
+expectType<Generator>(generator)
+
+class MyGenerator extends Generator {}
+const myGenerator = new MyGenerator()
+
+expectType<MyGenerator>(myGenerator)
+expectType<BaseGenerator.BaseGeneratorConfig>(myGenerator.config)

package/lib/generator/service-generator.js

@@ -48,7 +48,7 @@ class ServiceGenerator extends BaseGenerator {
         label: 'Which port do you want to use?',
         var: 'PORT',
         default: 3042,
-        tyoe: 'number',
+        type: 'number',
         configValue: 'port'
       }
     ]

package/lib/plugins/openapi.js

@@ -58,8 +58,14 @@ async function setupOpenAPI (app, opts) {
   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.get(`${routePrefix}/json`, {
+    schema: { hide: true },
+    logLevel: 'warn'
+  }, async () => app.swagger())
+  app.get(`${routePrefix}/yaml`, {
+    schema: { hide: true },
+    logLevel: 'warn'
+  }, async () => app.swagger({ yaml: true }))
 
   app.register(ScalarApiReference, {
     ...opts,

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

@@ -222,9 +222,6 @@
     <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'
 
@@ -253,14 +250,14 @@
       fetch('/_platformatic_versions')
         .then(response => response.json())
         .then(versions => {
-          const sharedOpenapiHref = join(currentPath, 'documentation/static/index.html')
+          const sharedOpenapiHref = join(currentPath, 'documentation')
           const openapiButtons = [
             `<a href="${sharedOpenapiHref}"target="_blank" class="button-link">OpenAPI Documentation</a>`
           ]
 
           for (const version of versions) {
-            const href = join(currentPath, version.prefix, 'documentation/static/index.html')
-            openapiButtons.push(`<a href="${href}"target="_blank" class="button-link">OpenAPI Documentation ${version.name}</a>`)
+            const href = join(currentPath, version.prefix, 'documentation')
+            openapiButtons.push(`<a href="${href}" target="_blank" class="button-link">OpenAPI Documentation ${version.name}</a>`)
           }
 
           const buttonList = document.getElementsByClassName('open-documentation-version')[0]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,12 +17,12 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "@fastify/aws-lambda": "^3.3.0",
-    "@fastify/compress": "^6.5.0",
+    "@fastify/aws-lambda": "^4.0.0",
+    "@fastify/compress": "^7.0.0",
     "bindings": "^1.5.0",
-    "c8": "^9.0.0",
+    "borp": "^0.9.0",
     "glob": "^10.3.10",
-    "json-schema-to-typescript": "^13.1.1",
+    "json-schema-to-typescript": "^13.1.2",
     "openapi-types": "^12.1.3",
     "pino-abstract-transport": "^1.1.0",
     "self-cert": "^2.0.0",
@@ -31,61 +31,61 @@
     "standard": "^17.1.0",
     "strip-ansi": "^7.1.0",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.30.0",
-    "typescript": "^5.2.2",
+    "tsd": "^0.30.4",
+    "typescript": "^5.3.3",
     "undici": "^6.0.0",
-    "vscode-json-languageservice": "^5.3.6",
+    "vscode-json-languageservice": "^5.3.9",
     "why-is-node-running": "^2.2.2",
-    "yaml": "^2.3.2"
+    "yaml": "^2.3.4"
   },
   "dependencies": {
-    "@fastify/accepts": "^4.2.0",
-    "@fastify/autoload": "^5.7.1",
-    "@fastify/basic-auth": "^5.0.0",
-    "@fastify/cors": "^8.4.0",
+    "@fastify/accepts": "^4.3.0",
+    "@fastify/autoload": "^5.8.0",
+    "@fastify/basic-auth": "^5.1.1",
+    "@fastify/cors": "^9.0.0",
     "@fastify/deepmerge": "^1.3.0",
-    "@fastify/error": "^3.4.0",
-    "@fastify/restartable": "^2.1.1",
-    "@fastify/static": "^6.11.2",
-    "@fastify/swagger": "^8.10.1",
+    "@fastify/error": "^3.4.1",
+    "@fastify/restartable": "^2.2.0",
+    "@fastify/static": "^7.0.0",
+    "@fastify/swagger": "^8.14.0",
     "@fastify/under-pressure": "^8.3.0",
     "@mercuriusjs/federation": "^2.0.0",
-    "@scalar/fastify-api-reference": "^1.10.1",
-    "@types/ws": "^8.5.6",
+    "@scalar/fastify-api-reference": "^1.13.18",
+    "@types/ws": "^8.5.10",
     "ajv": "^8.12.0",
     "cli-progress": "^3.12.0",
     "close-with-grace": "^1.2.0",
     "code-block-writer": "^12.0.0",
     "colorette": "^2.0.20",
     "commist": "^3.2.0",
-    "console-table-printer": "^2.11.2",
-    "desm": "^1.3.0",
-    "env-schema": "^5.2.0",
+    "console-table-printer": "^2.12.0",
+    "desm": "^1.3.1",
+    "env-schema": "^5.2.1",
     "es-main": "^1.3.0",
     "execa": "^8.0.1",
-    "fastify": "^4.23.2",
-    "fastify-metrics": "^10.3.2",
-    "fastify-openapi-glue": "^4.3.3",
+    "fastify": "^4.26.0",
+    "fastify-metrics": "^10.6.0",
+    "fastify-openapi-glue": "^4.4.3",
     "fastify-plugin": "^4.5.1",
     "graphql": "^16.8.1",
     "help-me": "^5.0.0",
-    "mercurius": "^13.1.0",
+    "mercurius": "^13.3.3",
     "minimist": "^1.2.8",
     "openapi-schema-diff": "^0.0.1",
     "ora": "^6.3.1",
-    "pino": "^8.15.3",
-    "pino-pretty": "^10.2.0",
-    "rfdc": "^1.3.0",
-    "ua-parser-js": "^1.0.36",
-    "undici": "^6.0.0",
-    "@platformatic/authenticate": "1.18.0",
-    "@platformatic/client": "1.18.0",
-    "@platformatic/config": "1.18.0",
-    "@platformatic/metaconfig": "1.18.0",
-    "@platformatic/generators": "1.18.0",
-    "@platformatic/scalar-theme": "1.18.0",
-    "@platformatic/telemetry": "1.18.0",
-    "@platformatic/utils": "1.18.0"
+    "pino": "^8.17.2",
+    "pino-pretty": "^10.3.1",
+    "rfdc": "^1.3.1",
+    "ua-parser-js": "^1.0.37",
+    "undici": "^6.6.0",
+    "@platformatic/authenticate": "1.20.0",
+    "@platformatic/client": "1.20.0",
+    "@platformatic/config": "1.20.0",
+    "@platformatic/generators": "1.20.0",
+    "@platformatic/metaconfig": "1.20.0",
+    "@platformatic/scalar-theme": "1.20.0",
+    "@platformatic/utils": "1.20.0",
+    "@platformatic/telemetry": "1.20.0"
   },
   "standard": {
     "ignore": [
@@ -100,9 +100,10 @@
     ]
   },
   "scripts": {
-    "test": "pnpm run lint && node ./test/runner.js && tsd",
+    "test": "pnpm run test && pnpm run lint",
+    "unit": "borp --pattern 'test/**/*.test.{js,mjs}' --ignore 'fixtures/**/*' --concurrency=1 --timeout=120000 --no-typescript",
     "nocov": "pnpm run lint && node ./test/runner.js && tsd",
     "build": "node lib/schema.js | json2ts > config.d.ts",
-    "lint": "standard | snazzy && ts-standard | snazzy"
+    "lint": "standard | snazzy && ts-standard | snazzy && tsd"
   }
 }