@platformatic/service 0.46.1 → 0.47.0

package/.c8rc

@@ -0,0 +1,6 @@
+{
+  "exclude": [
+    "fixtures/*",
+    "test/*"
+  ]
+}

package/config.d.ts

@@ -193,7 +193,6 @@ export interface Plugins {
         [k: string]: unknown;
       }
   )[];
-  stopTimeout?: number;
   typescript?:
     | {
         enabled?: boolean | string;

package/index.d.ts

@@ -3,7 +3,9 @@
 /// <reference types="@fastify/swagger" />
 import { FastifyInstance } from 'fastify'
 import ConfigManager from '@platformatic/config'
+import type { IConfigManagerOptions } from '@platformatic/config'
 import { PlatformaticService } from './config'
+import type { JSONSchemaType } from 'ajv'
 
 export interface PlatformaticApp<T> {
   configManager: ConfigManager<T>
@@ -19,3 +21,26 @@ declare module 'fastify' {
     restart: () => Promise<void>
   }
 }
+
+export interface ConfigManagerConfig<T> extends Omit<IConfigManagerOptions, 'source' | 'watch' | 'schema'> {
+  transformConfig: (this: ConfigManager<T>) => Promise<void>
+  schema: object
+}
+
+export interface Stackable<ConfigType> {
+  (app: FastifyInstance, opts: object): Promise<void>
+
+  configType: string
+  configManagerConfig: ConfigManagerConfig<ConfigType>
+  schema: object
+}
+
+interface SchemaExport {
+  schema: JSONSchemaType<PlatformaticServiceConfig>
+}
+
+export const schema: SchemaExport
+
+export declare const platformaticService: Stackable<PlatformaticServiceConfig>
+
+export default platformaticService

package/index.js

@@ -54,6 +54,7 @@ async function platformaticService (app, opts, toLoad = []) {
   if (config.plugins) {
     let registerTsCompiler = false
     const typescript = config.plugins.typescript
+    /* c8 ignore next 6 */
     if (typescript === true) {
       registerTsCompiler = true
     } else if (typeof typescript === 'object') {

package/index.test-d.ts

@@ -1,6 +1,6 @@
 import { expectType } from 'tsd'
 import { FastifyInstance } from 'fastify'
-import { buildServer, PlatformaticApp } from '.'
+import { buildServer, PlatformaticApp, platformaticService, Stackable, PlatformaticServiceConfig } from '.'
 import ConfigManager from '@platformatic/config'
 import { OpenAPI } from 'openapi-types'
 import type { MercuriusPlugin } from 'mercurius'
@@ -22,3 +22,26 @@ expectType<PlatformaticService>(server.platformatic.config)
 expectType<OpenAPI.Document>(server.swagger())
 expectType<MercuriusPlugin>(server.graphql)
 expectType<Promise<void>>(server.restart())
+
+function buildStackable (): Stackable<PlatformaticServiceConfig> {
+  async function myApp (app: FastifyInstance, opts: object): Promise<void> {
+    await platformaticService(app, opts)
+  }
+
+  myApp.schema = platformaticService.configManagerConfig.schema
+  myApp.configType = 'myApp'
+  myApp.configManagerConfig = {
+    ...platformaticService.configManagerConfig,
+    async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
+      this.current.plugins = {
+        paths: [{
+          path: 'my-plugin'
+        }]
+      }
+    }
+  }
+
+  return myApp
+}
+
+expectType<Stackable<PlatformaticServiceConfig>>(buildStackable())

package/lib/schema.js

@@ -429,9 +429,6 @@ const plugins = {
         }]
       }
     },
-    stopTimeout: {
-      type: 'integer'
-    },
     typescript: {
       anyOf: [{
         type: 'object',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.46.1",
+  "version": "0.47.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -48,6 +48,8 @@
     "@fastify/swagger-ui": "^1.9.0",
     "@fastify/under-pressure": "^8.2.0",
     "@mercuriusjs/federation": "^2.0.0",
+    "@types/ws": "^8.5.5",
+    "ajv": "^8.12.0",
     "close-with-grace": "^1.2.0",
     "commist": "^3.2.0",
     "desm": "^1.3.0",
@@ -56,7 +58,7 @@
     "execa": "^8.0.0",
     "fastify": "^4.18.0",
     "fastify-metrics": "^10.3.0",
-    "fastify-plugin": "^4.5.0",
+    "fastify-plugin": "^4.5.1",
     "graphql": "^16.6.0",
     "help-me": "^4.2.0",
     "mercurius": "^13.0.0",
@@ -65,11 +67,11 @@
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.35",
-    "@platformatic/client": "0.46.1",
-    "@platformatic/config": "0.46.1",
-    "@platformatic/swagger-ui-theme": "0.46.1",
-    "@platformatic/utils": "0.46.1",
-    "@platformatic/telemetry": "0.46.1"
+    "@platformatic/client": "0.47.0",
+    "@platformatic/config": "0.47.0",
+    "@platformatic/swagger-ui-theme": "0.47.0",
+    "@platformatic/telemetry": "0.47.0",
+    "@platformatic/utils": "0.47.0"
   },
   "standard": {
     "ignore": [

package/fixtures/hello/no-server-logger.json

@@ -1,13 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "info"
-    }
-  },
-  "plugins": {
-    "paths": ["./plugin.js"]
-  },
-  "metrics": false
-}

package/fixtures/hello/platformatic.service.json

@@ -1,18 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "info",
-      "name": "hello server"
-    }
-  },
-  "plugins": {
-    "paths": ["./plugin.js"]
-  },
-  "service": {
-    "openapi": true
-  },
-  "metrics": false,
-  "watch": false
-}

package/fixtures/hello/plugin.js

@@ -1,7 +0,0 @@
-'use default'
-
-module.exports = async function (app) {
-  app.get('/', async () => {
-    return { hello: 'world' }
-  })
-}

package/fixtures/hello/warn-log.service.json

@@ -1,18 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "warn",
-      "name": "hello server"
-    }
-  },
-  "plugins": {
-    "paths": ["./plugin.js"]
-  },
-  "service": {
-    "openapi": true
-  },
-  "metrics": false,
-  "watch": false
-}

package/fixtures/hello-client/hello/hello.cjs

@@ -1,21 +0,0 @@
-'use strict'
-
-const pltClient = require('@platformatic/client')
-const { join } = require('path')
-
-async function generateHelloClientPlugin (app, opts) {
-  app.register(pltClient, {
-    type: 'openapi',
-    name: 'hello',
-    path: join(__dirname, 'hello.openapi.json'),
-    url: opts.url
-  })
-}
-
-generateHelloClientPlugin[Symbol.for('plugin-meta')] = {
-  name: 'hello OpenAPI Client'
-}
-generateHelloClientPlugin[Symbol.for('skip-override')] = true
-
-module.exports = generateHelloClientPlugin
-module.exports.default = generateHelloClientPlugin

package/fixtures/hello-client/hello/hello.d.ts

@@ -1,34 +0,0 @@
-import { FastifyPluginAsync } from 'fastify'
-
-interface GetRequest {
-}
-
-interface GetResponse {
-}
-
-interface Hello {
-  get(req: GetRequest): Promise<GetResponse>;
-}
-
-type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    'hello': Hello;
-  }
-
-  interface FastifyRequest {
-    'hello': Hello;
-  }
-}
-
-declare namespace hello {
-  export interface HelloOptions {
-    url: string
-  }
-  export const hello: HelloPlugin;
-  export { hello as default };
-}
-
-declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
-export = hello;

package/fixtures/hello-client/hello/hello.openapi.json

@@ -1,22 +0,0 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "Platformatic",
-    "description": "This is a service built on top of Platformatic",
-    "version": "1.0.0"
-  },
-  "components": {
-    "schemas": {}
-  },
-  "paths": {
-    "/": {
-      "get": {
-        "responses": {
-          "200": {
-            "description": "Default Response"
-          }
-        }
-      }
-    }
-  }
-}

package/fixtures/hello-client/hello/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "hello",
-  "main": "./hello.cjs",
-  "types": "./hello.d.ts"
-}

package/fixtures/hello-client/platformatic.service.json

@@ -1,19 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "warn",
-      "name": "hello client"
-    }
-  },
-  "plugins": {
-    "paths": ["./plugin.js"]
-  },
-  "clients": [{
-    "path": "hello",
-    "url": "{PLT_CLIENT_URL}"
-  }],
-  "metrics": false,
-  "watch": false
-}

package/fixtures/hello-client/plugin.js

@@ -1,8 +0,0 @@
-'use default'
-
-/**  @type {import('fastify').FastifyPluginAsync<{ optionA: boolean, optionB: string }>} */
-module.exports = async function (app) {
-  app.get('/', async () => {
-    return app.hello.get()
-  })
-}

package/fixtures/hello-client-ts/hello/hello.cjs

@@ -1,21 +0,0 @@
-'use strict'
-
-const pltClient = require('@platformatic/client')
-const { join } = require('path')
-
-async function generateHelloClientPlugin (app, opts) {
-  app.register(pltClient, {
-    type: 'openapi',
-    name: 'hello',
-    path: join(__dirname, 'hello.openapi.json'),
-    url: opts.url
-  })
-}
-
-generateHelloClientPlugin[Symbol.for('plugin-meta')] = {
-  name: 'hello OpenAPI Client'
-}
-generateHelloClientPlugin[Symbol.for('skip-override')] = true
-
-module.exports = generateHelloClientPlugin
-module.exports.default = generateHelloClientPlugin

package/fixtures/hello-client-ts/hello/hello.d.ts

@@ -1,34 +0,0 @@
-import { FastifyPluginAsync } from 'fastify'
-
-interface GetRequest {
-}
-
-interface GetResponse {
-}
-
-interface Hello {
-  get(req: GetRequest): Promise<GetResponse>;
-}
-
-type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    'hello': Hello;
-  }
-
-  interface FastifyRequest {
-    'hello': Hello;
-  }
-}
-
-declare namespace hello {
-  export interface HelloOptions {
-    url: string
-  }
-  export const hello: HelloPlugin;
-  export { hello as default };
-}
-
-declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
-export = hello;

package/fixtures/hello-client-ts/hello/hello.openapi.json

@@ -1,22 +0,0 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "Platformatic",
-    "description": "This is a service built on top of Platformatic",
-    "version": "1.0.0"
-  },
-  "components": {
-    "schemas": {}
-  },
-  "paths": {
-    "/": {
-      "get": {
-        "responses": {
-          "200": {
-            "description": "Default Response"
-          }
-        }
-      }
-    }
-  }
-}

package/fixtures/hello-client-ts/hello/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "hello",
-  "main": "./hello.cjs",
-  "types": "./hello.d.ts"
-}

package/fixtures/hello-client-ts/platformatic.service.json

@@ -1,21 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "warn",
-      "name": "hello client ts"
-    },
-    "pluginTimeout": 30000
-  },
-  "plugins": {
-    "paths": ["./plugin.ts"],
-    "typescript": true
-  },
-  "clients": [{
-    "path": "hello",
-    "url": "{PLT_CLIENT_URL}"
-  }],
-  "metrics": false,
-  "watch": false
-}

package/fixtures/hello-client-ts/plugin.ts

@@ -1,8 +0,0 @@
-import { FastifyInstance } from 'fastify'
-/// <reference path="./hello" />
-
-export default async function (app: FastifyInstance) {
-  app.get('/', async () => {
-    return app.hello.get({})
-  })
-}

package/fixtures/hello-client-ts/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "esModuleInterop": true,
-    "target": "es2020",
-    "moduleResolution": "node",
-    "sourceMap": false,
-    "incremental": true,
-    "pretty": true,
-    "noEmitOnError": true,
-    "outDir": "dist"
-  },
-  "watchOptions": {
-    "watchFile": "fixedPollingInterval",
-    "watchDirectory": "fixedPollingInterval",
-    "fallbackPolling": "dynamicPriority",
-    "synchronousWatchDirectory": true,
-    "excludeDirectories": [
-      "**/node_modules",
-      "dist"
-    ]
-  }
-}

package/fixtures/hello-client-ts-without-deps/hello.d.ts

@@ -1,34 +0,0 @@
-import { FastifyPluginAsync } from 'fastify'
-
-interface GetRequest {
-}
-
-interface GetResponse {
-}
-
-interface Hello {
-  get(req: GetRequest): Promise<GetResponse>;
-}
-
-type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    'hello': Hello;
-  }
-
-  interface FastifyRequest {
-    'hello': Hello;
-  }
-}
-
-declare namespace hello {
-  export interface HelloOptions {
-    url: string
-  }
-  export const hello: HelloPlugin;
-  export { hello as default };
-}
-
-declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
-export = hello;

package/fixtures/hello-client-ts-without-deps/hello.openapi.json

@@ -1,22 +0,0 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "Platformatic",
-    "description": "This is a service built on top of Platformatic",
-    "version": "1.0.0"
-  },
-  "components": {
-    "schemas": {}
-  },
-  "paths": {
-    "/": {
-      "get": {
-        "responses": {
-          "200": {
-            "description": "Default Response"
-          }
-        }
-      }
-    }
-  }
-}

package/fixtures/hello-client-ts-without-deps/platformatic.service.json

@@ -1,23 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "warn",
-      "name": "hello client ts"
-    },
-    "pluginTimeout": 30000
-  },
-  "plugins": {
-    "paths": ["./plugin.ts"],
-    "typescript": true
-  },
-  "clients": [{
-    "schema": "./hello.openapi.json",
-    "name": "hello",
-    "type": "openapi",
-    "url": "{PLT_CLIENT_URL}"
-  }],
-  "metrics": false,
-  "watch": false
-}

package/fixtures/hello-client-ts-without-deps/plugin.ts

@@ -1,8 +0,0 @@
-import { FastifyInstance } from 'fastify'
-/// <reference path="./hello" />
-
-export default async function (app: FastifyInstance) {
-  app.get('/', async () => {
-    return app.hello.get({})
-  })
-}

package/fixtures/hello-client-ts-without-deps/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "esModuleInterop": true,
-    "target": "es6",
-    "moduleResolution": "node",
-    "sourceMap": true,
-    "pretty": true,
-    "noEmitOnError": true,
-    "outDir": "dist"
-  },
-  "watchOptions": {
-    "watchFile": "fixedPollingInterval",
-    "watchDirectory": "fixedPollingInterval",
-    "fallbackPolling": "dynamicPriority",
-    "synchronousWatchDirectory": true,
-    "excludeDirectories": [
-      "**/node_modules",
-      "dist"
-    ]
-  }
-}

package/fixtures/hello-client-without-deps/hello.d.ts

@@ -1,34 +0,0 @@
-import { FastifyPluginAsync } from 'fastify'
-
-interface GetRequest {
-}
-
-interface GetResponse {
-}
-
-interface Hello {
-  get(req: GetRequest): Promise<GetResponse>;
-}
-
-type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    'hello': Hello;
-  }
-
-  interface FastifyRequest {
-    'hello': Hello;
-  }
-}
-
-declare namespace hello {
-  export interface HelloOptions {
-    url: string
-  }
-  export const hello: HelloPlugin;
-  export { hello as default };
-}
-
-declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
-export = hello;

package/fixtures/hello-client-without-deps/hello.openapi.json

@@ -1,22 +0,0 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "Platformatic",
-    "description": "This is a service built on top of Platformatic",
-    "version": "1.0.0"
-  },
-  "components": {
-    "schemas": {}
-  },
-  "paths": {
-    "/": {
-      "get": {
-        "responses": {
-          "200": {
-            "description": "Default Response"
-          }
-        }
-      }
-    }
-  }
-}

package/fixtures/hello-client-without-deps/platformatic.service.json

@@ -1,21 +0,0 @@
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "warn",
-      "name": "hello client"
-    }
-  },
-  "plugins": {
-    "paths": ["./plugin.js"]
-  },
-  "clients": [{
-    "schema": "./hello.openapi.json",
-    "name": "hello",
-    "type": "openapi",
-    "url": "{PLT_CLIENT_URL}"
-  }],
-  "metrics": false,
-  "watch": false
-}