@platformatic/service 1.12.0 → 1.13.0

package/index.d.ts

@@ -6,6 +6,7 @@ import ConfigManager from '@platformatic/config'
 import type { IConfigManagerOptions } from '@platformatic/config'
 import { PlatformaticService } from './config'
 import type { JSONSchemaType } from 'ajv'
+import { ServiceGenerator } from './lib/generator/service-generator'
 export interface PlatformaticApp<T> {
   configManager: ConfigManager<T>
   config: T
@@ -51,3 +52,5 @@ export declare const platformaticService: Stackable<PlatformaticServiceConfig>
 export default platformaticService
 
 export const tsCompiler: TSCompiler
+
+export const Generator: ServiceGenerator.ServiceGenerator

package/index.js

@@ -18,10 +18,13 @@ const { telemetry } = require('@platformatic/telemetry')
 const { schema } = require('./lib/schema')
 const { addLoggerToTheConfig } = require('./lib/utils')
 const { start, buildServer } = require('./lib/start')
+const ServiceGenerator = require('./lib/generator/service-generator.js')
 
-async function platformaticService (app, opts, toLoad = []) {
+// TODO(mcollina): toLoad is deprecated, remove it in the next major version.
+async function platformaticService (app, opts, toLoad) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
+  const beforePlugins = opts.beforePlugins || toLoad || []
 
   if (isKeyEnabled('metrics', config)) {
     app.register(setupMetrics, config.metrics)
@@ -33,20 +36,20 @@ async function platformaticService (app, opts, toLoad = []) {
     await app.register(telemetry, config.telemetry)
   }
 
-  if (Array.isArray(toLoad)) {
-    for (const plugin of toLoad) {
-      await app.register(plugin)
+  if (Array.isArray(beforePlugins)) {
+    for (const plugin of beforePlugins) {
+      app.register(plugin)
     }
   }
 
   const serviceConfig = config.service || {}
 
   if (isKeyEnabled('openapi', serviceConfig)) {
-    await app.register(setupOpenAPI, serviceConfig.openapi)
+    app.register(setupOpenAPI, serviceConfig.openapi)
   }
 
   if (isKeyEnabled('graphql', serviceConfig)) {
-    await app.register(setupGraphQL, serviceConfig.graphql)
+    app.register(setupGraphQL, serviceConfig.graphql)
   }
 
   if (isKeyEnabled('clients', config)) {
@@ -55,7 +58,7 @@ async function platformaticService (app, opts, toLoad = []) {
 
   if (config.plugins) {
     let registerTsCompiler = false
-    const typescript = config.plugins.typescript
+    const typescript = config.plugins.paths && config.plugins.typescript
     /* c8 ignore next 6 */
     if (typescript === true) {
       registerTsCompiler = true
@@ -64,9 +67,9 @@ async function platformaticService (app, opts, toLoad = []) {
     }
 
     if (registerTsCompiler) {
-      await app.register(setupTsCompiler)
+      app.register(setupTsCompiler)
     }
-    await app.register(loadPlugins)
+    app.register(loadPlugins)
   }
 
   if (isKeyEnabled('cors', config.server)) {
@@ -76,10 +79,6 @@ async function platformaticService (app, opts, toLoad = []) {
   if (isKeyEnabled('healthCheck', config.server)) {
     app.register(setupHealthCheck, config.server.healthCheck)
   }
-
-  if (!app.hasRoute({ url: '/', method: 'GET' }) && !Array.isArray(toLoad)) {
-    await app.register(require('./lib/root-endpoint'))
-  }
 }
 
 platformaticService[Symbol.for('skip-override')] = true
@@ -135,3 +134,4 @@ module.exports.platformaticService = platformaticService
 module.exports.addLoggerToTheConfig = addLoggerToTheConfig
 module.exports.tsCompiler = compiler
 module.exports.start = start
+module.exports.Generator = ServiceGenerator

package/lib/compile.js

@@ -77,7 +77,7 @@ async function compile (cwd, config, originalLogger, options) {
     }
     delete env.NODE_V8_COVERAGE
     // somehow c8 does not pick up these lines even if there is a specific test
-    /* c8 ignore 10 */
+    /* c8 ignore start */
     if (options.clean) {
       // delete outdir directory
       const tsConfigContents = JSON.parse(await readFile(tsConfigPath, 'utf8'))
@@ -88,6 +88,7 @@ async function compile (cwd, config, originalLogger, options) {
         await rm(outDirFullPath, { recursive: true })
       }
     }
+    /* c8 ignore stop */
     await execa(tscExecutablePath, tsFlags, { cwd, env })
     logger.info('Typescript compilation completed successfully.')
     return true

package/lib/generator/service-generator.d.ts

@@ -0,0 +1,11 @@
+import { BaseGenerator } from '@platformatic/generators'
+
+interface KeyValue {
+  [key: string]: string
+}
+
+export namespace ServiceGenerator {
+  export class ServiceGenerator extends BaseGenerator.BaseGenerator {
+    constructor (opts?: BaseGenerator.BaseGeneratorOptions)
+  }
+}

package/lib/generator/service-generator.js

@@ -0,0 +1,106 @@
+'use strict'
+
+const { BaseGenerator } = require('@platformatic/generators')
+
+class ServiceGenerator extends BaseGenerator {
+  constructor (opts = {}) {
+    super(opts)
+    this.type = 'service'
+  }
+
+  async _beforePrepare () {
+    this.config.env = {
+      PLT_SERVER_HOSTNAME: this.config.hostname,
+      PLT_SERVER_LOGGER_LEVEL: 'info',
+      PORT: 3042,
+      ...this.config.env
+
+    }
+    this.config.dependencies = {
+      '@platformatic/service': `^${this.platformaticVersion}`
+    }
+  }
+
+  getConfigFieldsDefinitions () {
+    return [
+      {
+        var: 'PLT_SERVER_HOSTNAME',
+        label: 'What is the hostname?',
+        default: '0.0.0.0',
+        type: 'string',
+        configValue: 'hostname'
+      },
+      {
+        var: 'PLT_SERVER_LOGGER_LEVEL',
+        label: 'What is the logger level?',
+        default: 'info',
+        type: 'string',
+        configValue: ''
+      },
+      {
+        label: 'Which port do you want to use?',
+        var: 'PORT',
+        default: 3042,
+        tyoe: 'number',
+        configValue: 'port'
+      }
+    ]
+  }
+
+  async _afterPrepare () {
+    const GLOBAL_TYPES_TEMPLATE = `
+import { FastifyInstance } from 'fastify'
+import { PlatformaticApp, PlatformaticServiceConfig } from '@platformatic/service'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<PlatformaticServiceConfig>
+  }
+}
+`
+    this.addFile({ path: '', file: 'global.d.ts', contents: GLOBAL_TYPES_TEMPLATE })
+    if (this.config.isRuntimeContext) {
+      // remove env variables since they are all for the config.server property
+      this.config.env = {}
+    }
+  }
+
+  async _getConfigFileContents () {
+    const { typescript, isRuntimeContext } = this.config
+    const version = this.platformaticVersion
+    const config = {
+      $schema: `https://platformatic.dev/schemas/v${version}/service`,
+      service: {
+        openapi: true
+      },
+      watch: true
+    }
+    if (this.config.plugin) {
+      config.plugins = {
+        paths: [
+          { path: './plugins', encapsulate: false },
+          './routes'
+        ]
+      }
+
+      if (typescript === true) {
+        config.plugins.typescript = true
+      }
+    }
+
+    if (!isRuntimeContext) {
+      config.server = {
+        hostname: '{PLT_SERVER_HOSTNAME}',
+        port: '{PORT}',
+        logger: {
+          level: '{PLT_SERVER_LOGGER_LEVEL}'
+        }
+      }
+    }
+    return config
+  }
+}
+
+module.exports = ServiceGenerator
+module.exports.ServiceGenerator = ServiceGenerator
+module.exports.Generator = ServiceGenerator

package/lib/plugins/plugins.js

@@ -34,7 +34,7 @@ async function loadPlugins (app) {
     isOutDirAccessible = await isFileAccessible(outDir)
   }
 
-  if (isOutDirAccessible) {
+  if (config.plugins.paths && isOutDirAccessible) {
     config.plugins.paths = config.plugins.paths.map((plugin) => {
       /* c8 ignore next 3 */
       const tmp = typeof plugin === 'string'

package/lib/start.js

@@ -56,7 +56,10 @@ async function buildServer (options, app) {
 
     const root = fastify(fastifyOptions)
     root.decorate('platformatic', { configManager, config })
-    root.register(app)
+    await root.register(app)
+    if (!root.hasRoute({ url: '/', method: 'GET' })) {
+      await root.register(require('./root-endpoint'))
+    }
 
     root.decorate('url', {
       getter () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -69,11 +69,12 @@
     "pino-pretty": "^10.2.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.36",
-    "@platformatic/client": "1.12.0",
-    "@platformatic/config": "1.12.0",
-    "@platformatic/swagger-ui-theme": "1.12.0",
-    "@platformatic/telemetry": "1.12.0",
-    "@platformatic/utils": "1.12.0"
+    "@platformatic/client": "1.13.0",
+    "@platformatic/config": "1.13.0",
+    "@platformatic/swagger-ui-theme": "1.13.0",
+    "@platformatic/utils": "1.13.0",
+    "@platformatic/telemetry": "1.13.0",
+    "@platformatic/generators": "1.13.0"
   },
   "standard": {
     "ignore": [