@platformatic/service 2.0.0-alpha.2 → 2.0.0-alpha.20

package/config.d.ts

@@ -31,7 +31,13 @@ export interface PlatformaticService {
     logger?:
       | boolean
       | {
-          level?: string;
+          level: (
+            | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
+            | {
+                [k: string]: unknown;
+              }
+          ) &
+            string;
           transport?:
             | {
                 target?: string;
@@ -61,6 +67,9 @@ export interface PlatformaticService {
           };
           [k: string]: unknown;
         };
+    loggerInstance?: {
+      [k: string]: unknown;
+    };
     serializerOpts?: {
       schema?: {
         [k: string]: unknown;
@@ -151,7 +160,6 @@ export interface PlatformaticService {
         defaultMetrics?: {
           enabled: boolean;
         };
-        prefix?: string;
         auth?: {
           username: string;
           password: string;
@@ -173,6 +181,7 @@ export interface PlatformaticService {
     | boolean
     | string;
   $schema?: string;
+  module?: string;
   service?: {
     openapi?:
       | {

package/eslint.config.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const neostandard = require('neostandard')
+
+module.exports = neostandard({
+  ts: true,
+  ignores: [
+    ...neostandard.resolveIgnoresFromGitignore(),
+    'test/tmp/**/*',
+    'test/fixtures/*/dist/**/*',
+    '**/dist/*',
+    'fixtures/**/*',
+  ],
+})

package/index.d.ts

@@ -1,15 +1,14 @@
-/* eslint-disable @typescript-eslint/triple-slash-reference */
 /// <reference types="mercurius" />
 /// <reference types="@fastify/swagger" />
 import { FastifyInstance, FastifyBaseLogger } from 'fastify'
 import ConfigManager from '@platformatic/config'
-import type { IConfigManagerOptions } from '@platformatic/config'
+import type { ConfigManagerConfig } from '@platformatic/config'
+import type { Stackable as _Stackable, StackableInterface } 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> {
@@ -28,19 +27,11 @@ declare module 'fastify' {
   }
 }
 
-export interface ConfigManagerConfig<T> extends Omit<IConfigManagerOptions, 'source' | 'watch' | 'schema' | 'configVersion'> {
-  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
-  Generator?: new () => BaseGenerator.BaseGenerator
+type DefaultGenerator = new () => BaseGenerator.BaseGenerator
 
+export interface Stackable<ConfigType, Generator = DefaultGenerator> extends _Stackable<ConfigType> {
+  app: (app: FastifyInstance, opts: object) => Promise<void>
+  Generator?: Generator
   version?: string
   upgrade?: (config: any, version: string) => Promise<any>
   transformConfig?: (config: any) => Promise<any>
@@ -54,9 +45,21 @@ interface TSCompiler {
 }
 
 export const schema: JSONSchemaType<PlatformaticServiceConfig>
+export const configManagerConfig: ConfigManagerConfig<PlatformaticServiceConfig>
 
 export declare const platformaticService: Stackable<PlatformaticServiceConfig>
 
-export default platformaticService
+export declare const app: (app: FastifyInstance, opts: object) => Promise<void>
 
 export const tsCompiler: TSCompiler
+
+type defaultExport = Stackable<PlatformaticServiceConfig> & {
+  buildServer: (opts: object, app?: object, ConfigManagerConstructor?: object) => Promise<FastifyInstance>,
+  start: <ConfigType>(app: Stackable<ConfigType>, args: string[]) => Promise<void>,
+  tsCompiler: TSCompiler,
+  schema: JSONSchemaType<PlatformaticServiceConfig>,
+}
+
+export function buildStackable (opts: { config: string }, app?: object): Promise<StackableInterface>
+
+export default defaultExport

package/index.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { isKeyEnabled } = require('@platformatic/utils')
+const { loadConfig, ConfigManager } = require('@platformatic/config')
 const { readFile } = require('fs/promises')
 const { join } = require('path')
 
@@ -20,6 +21,7 @@ const { schema } = require('./lib/schema')
 const { addLoggerToTheConfig } = require('./lib/utils')
 const { start, buildServer } = require('./lib/start')
 const ServiceGenerator = require('./lib/generator/service-generator.js')
+const { ServiceStackable } = require('./lib/stackable')
 
 const { version } = require('./package.json')
 
@@ -39,7 +41,7 @@ async function platformaticService (app, opts) {
   }
 
   // This must be done before loading the plugins, so they can inspect if the
-  // openTelemetry decoretor exists and then configure accordingly.
+  // openTelemetry decorator exists and then configure accordingly.
   if (isKeyEnabled('telemetry', config)) {
     await app.register(telemetry, config.telemetry)
   }
@@ -78,9 +80,9 @@ async function platformaticService (app, opts) {
     }
 
     if (registerTsCompiler) {
-      app.register(setupTsCompiler)
+      app.register(setupTsCompiler, { context: opts.context })
     }
-    app.register(loadPlugins)
+    app.register(loadPlugins, { context: opts.context })
   }
 
   if (isKeyEnabled('cors', config.server)) {
@@ -93,8 +95,8 @@ async function platformaticService (app, opts) {
 }
 
 platformaticService[Symbol.for('skip-override')] = true
-platformaticService.configType = 'service'
-platformaticService.configManagerConfig = {
+
+module.exports.configManagerConfig = {
   version,
   schema,
   allowToWatch: ['.env'],
@@ -135,16 +137,62 @@ platformaticService.configManagerConfig = {
   upgrade
 }
 
+platformaticService.configType = 'service'
+platformaticService.schema = schema
+platformaticService.configManagerConfig = module.exports.configManagerConfig
+
 function _buildServer (options, app) {
-  return buildServer(options, app || platformaticService)
+  return buildServer(options, app || module.exports)
+}
+
+async function buildStackable (options, app = platformaticService, Stackable = ServiceStackable) {
+  let configManager = options.configManager
+
+  if (configManager === undefined) {
+    if (typeof options.config === 'string') {
+      ;({ configManager } = await loadConfig(
+        {},
+        ['-c', options.config],
+        app,
+        {
+          onMissingEnv: options.onMissingEnv,
+          context: options.context
+        },
+        true
+      ))
+    } else {
+      configManager = new ConfigManager({
+        ...app.configManagerConfig,
+        source: options.config,
+        dirname: options.context?.directory
+      })
+      await configManager.parseAndValidate()
+    }
+  }
+
+  const stackable = new Stackable({
+    init: () => buildServer({
+      configManager,
+      ...configManager.current,
+    }, app, options.context),
+    stackable: app,
+    configManager,
+    context: options.context
+  })
+
+  return stackable
 }
-module.exports = platformaticService
+
+module.exports.configType = 'service'
+module.exports.app = platformaticService
 module.exports.schema = schema
 module.exports.buildServer = _buildServer
+module.exports.buildStackable = buildStackable
 module.exports.schemas = require('./lib/schema')
 module.exports.platformaticService = platformaticService
 module.exports.addLoggerToTheConfig = addLoggerToTheConfig
 module.exports.start = start
 module.exports.Generator = ServiceGenerator
+module.exports.ServiceStackable = ServiceStackable
 module.exports.buildCompileCmd = buildCompileCmd
 module.exports.extractTypeScriptCompileOptionsFromConfig = extractTypeScriptCompileOptionsFromConfig

package/index.test-d.ts

@@ -12,7 +12,7 @@ import {
   platformaticService,
   Stackable,
   Generator,
-  PlatformaticServiceConfig
+  PlatformaticServiceConfig,
 } from '.'
 
 declare module 'fastify' {
@@ -32,21 +32,23 @@ 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)
-  }
+  const myApp: Stackable<PlatformaticServiceConfig> = {
+    async app (app: FastifyInstance, opts: object): Promise<void> {
+      await platformaticService.app(app, opts)
+    },
 
-  myApp.schema = platformaticService.schema
-  myApp.configType = 'myApp'
-  myApp.configManagerConfig = {
-    version: platformaticService.configManagerConfig.version,
-    ...platformaticService.configManagerConfig,
-    async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
-      this.current.plugins = {
-        paths: [{
-          path: 'my-plugin'
-        }]
-      }
+    schema: platformaticService.schema,
+    configType: 'myApp',
+    configManagerConfig: {
+      version: platformaticService.configManagerConfig.version,
+      ...platformaticService.configManagerConfig,
+      async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
+        this.current.plugins = {
+          paths: [{
+            path: 'my-plugin',
+          }],
+        }
+      },
     },
     async upgrade (config: PlatformaticServiceConfig, version: string) {
       const upgrade = platformaticService.configManagerConfig.upgrade
@@ -54,7 +56,7 @@ function buildStackable (): Stackable<PlatformaticServiceConfig> {
         return upgrade.call(this, config, version)
       }
       return config
-    }
+    },
   }
 
   // configVersion is not part of ConfigManagerConfig
@@ -77,21 +79,22 @@ expectType<MyGenerator>(myGenerator)
 expectType<BaseGenerator.BaseGeneratorConfig>(myGenerator.config)
 
 function buildStackable2 (): Stackable<PlatformaticServiceConfig> {
-  async function myApp (app: FastifyInstance, opts: object): Promise<void> {
-    await platformaticService(app, opts)
-  }
-
-  myApp.schema = platformaticService.schema
-  myApp.configType = 'myApp'
-  myApp.configManagerConfig = {
-    ...platformaticService.configManagerConfig,
-    async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
-      this.current.plugins = {
-        paths: [{
-          path: 'my-plugin'
-        }]
-      }
-    }
+  const myApp: Stackable<PlatformaticServiceConfig> = {
+    async app (app: FastifyInstance, opts: object): Promise<void> {
+      await platformaticService.app(app, opts)
+    },
+    schema: platformaticService.schema,
+    configType: 'myApp',
+    configManagerConfig: {
+      ...platformaticService.configManagerConfig,
+      async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
+        this.current.plugins = {
+          paths: [{
+            path: 'my-plugin',
+          }],
+        }
+      },
+    },
   }
 
   await start(myApp, ['--help'])

package/lib/compile.js

@@ -13,7 +13,7 @@ function buildCompileCmd (app) {
 
     try {
       const { configManager } = await loadConfig({}, _args, app, {
-        watch: false
+        watch: false,
       })
       await configManager.parseAndValidate()
       config = configManager.current
@@ -27,7 +27,7 @@ function buildCompileCmd (app) {
     const logger = pino(
       pretty({
         translateTime: 'SYS:HH:MM:ss',
-        ignore: 'hostname,pid'
+        ignore: 'hostname,pid',
       })
     )
 
@@ -35,7 +35,7 @@ function buildCompileCmd (app) {
       ...extractTypeScriptCompileOptionsFromConfig(config),
       cwd: fullPath,
       logger,
-      clean: _args.includes('--clean')
+      clean: _args.includes('--clean'),
     }
 
     if (!await compile(compileOptions)) {
@@ -49,7 +49,7 @@ module.exports.buildCompileCmd = buildCompileCmd
 function extractTypeScriptCompileOptionsFromConfig (config) {
   return {
     tsConfig: config.plugins?.typescript?.tsConfig,
-    flags: config.plugins?.typescript?.flags
+    flags: config.plugins?.typescript?.flags,
   }
 }
 

package/lib/create.mjs

@@ -16,14 +16,14 @@ function printAppSummary (args, logger) {
     { config: 'Language', value: args.typescript ? 'Typescript' : 'Javascript' },
     { config: 'Init Git Repository', value: args.git },
     { config: 'Install Dependencies', value: args.install },
-    { config: 'Sample Plugin and Tests', value: args.plugin }
+    { config: 'Sample Plugin and Tests', value: args.plugin },
   ]
 
   const p = new Table({
     columns: [
       { name: 'config', alignment: 'right' },
-      { name: 'value', alignment: 'left' }
-    ]
+      { name: 'value', alignment: 'left' },
+    ],
   })
 
   p.addRows(table)
@@ -34,7 +34,7 @@ async function createService (_args) {
     translateTime: 'SYS:HH:MM:ss',
     ignore: 'hostname,pid',
     minimumLevel: 'debug',
-    sync: true
+    sync: true,
   })
 
   const logger = pino(stream)
@@ -49,8 +49,8 @@ async function createService (_args) {
       plugin: true,
       typescript: false,
       git: false,
-      install: true
-    }
+      install: true,
+    },
 
   })
 
@@ -64,7 +64,7 @@ async function createService (_args) {
     tests: args.plugin,
     typescript: args.typescript,
     initGitRepository: args.git,
-    targetDirectory: args.dir
+    targetDirectory: args.dir,
   })
 
   try {

package/lib/gen-schema.js

@@ -11,5 +11,5 @@ async function generateJsonSchemaConfig () {
 
 module.exports = {
   generateJsonSchemaConfig,
-  filenameConfigJsonSchema
+  filenameConfigJsonSchema,
 }

package/lib/gen-types.mjs

@@ -4,7 +4,7 @@ import { writeFile } from 'fs/promises'
 import pino from 'pino'
 import pretty from 'pino-pretty'
 import { loadConfig } from '@platformatic/config'
-import { platformaticService } from '../index.js'
+import platformaticService from '../index.js'
 import { checkForDependencies } from '@platformatic/utils'
 
 const GLOBAL_TYPES_TEMPLATE = `
@@ -25,7 +25,7 @@ async function execute ({ logger, configManager }) {
 async function generateTypes (_args) {
   const logger = pino(pretty({
     translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid'
+    ignore: 'hostname,pid',
   }))
   const { configManager, args } = await loadConfig({}, _args, platformaticService)
   await configManager.parseAndValidate()

package/lib/generator/service-generator.js

@@ -8,7 +8,7 @@ class ServiceGenerator extends BaseGenerator {
   constructor (opts = {}) {
     super({
       ...opts,
-      module: '@platformatic/service'
+      module: '@platformatic/service',
     })
   }
 
@@ -26,16 +26,16 @@ class ServiceGenerator extends BaseGenerator {
         this.addEnvVars({
           PLT_SERVER_HOSTNAME: this.config.hostname,
           PLT_SERVER_LOGGER_LEVEL: 'info',
-          PORT: 3042
+          PORT: 3042,
         }, { overwrite: false })
       }
 
       this.addEnvVars({
-        PLT_TYPESCRIPT: this.config.typescript
+        PLT_TYPESCRIPT: this.config.typescript,
       }, { overwrite: false, default: true })
 
       this.config.dependencies = {
-        '@platformatic/service': `^${this.platformaticVersion}`
+        '@platformatic/service': `^${this.platformaticVersion}`,
       }
     }
   }
@@ -50,22 +50,22 @@ class ServiceGenerator extends BaseGenerator {
         label: 'What is the hostname?',
         default: '0.0.0.0',
         type: 'string',
-        configValue: 'hostname'
+        configValue: 'hostname',
       },
       {
         var: 'PLT_SERVER_LOGGER_LEVEL',
         label: 'What is the logger level?',
         default: 'info',
         type: 'string',
-        configValue: ''
+        configValue: '',
       },
       {
         label: 'Which port do you want to use?',
         var: 'PORT',
         default: 3042,
         type: 'number',
-        configValue: 'port'
-      }
+        configValue: 'port',
+      },
     ]
   }
 
@@ -83,7 +83,7 @@ declare module 'fastify' {
 }
 `
       this.addFile({ path: '', file: 'global.d.ts', contents: GLOBAL_TYPES_TEMPLATE })
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md')) })
+      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
     }
   }
 
@@ -91,19 +91,19 @@ declare module 'fastify' {
     const { isRuntimeContext } = this.config
     const version = this.platformaticVersion
     const config = {
-      $schema: `https://platformatic.dev/schemas/v${version}/service`,
+      $schema: `https://schemas.platformatic.dev/@platformatic/service/${version}.json`,
       service: {
-        openapi: true
+        openapi: true,
       },
-      watch: true
+      watch: true,
     }
     if (this.config.plugin) {
       config.plugins = {
         paths: [
           { path: './plugins', encapsulate: false },
-          './routes'
+          './routes',
         ],
-        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`
+        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`,
       }
     }
 
@@ -112,8 +112,8 @@ declare module 'fastify' {
         hostname: '{PLT_SERVER_HOSTNAME}',
         port: '{PORT}',
         logger: {
-          level: '{PLT_SERVER_LOGGER_LEVEL}'
-        }
+          level: '{PLT_SERVER_LOGGER_LEVEL}',
+        },
       }
     }