@platformatic/service 3.4.1 → 3.5.0

package/tsconfig.json

@@ -1,12 +1,22 @@
 {
   "compilerOptions": {
-    "module": "CommonJS",
-    "moduleResolution": "node",
+    "module": "esnext",
     "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "target": "es2019",
-    "outDir": "build",
+    "lib": ["es2022"],
+    "target": "esnext",
     "sourceMap": true,
-    "strictNullChecks": true
+    "pretty": true,
+    "noEmitOnError": true,
+    "incremental": true,
+    "strict": true,
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": ["**/node_modules", "dist"]
   }
 }

package/.c8rc

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

package/help/compile.txt

@@ -1,19 +0,0 @@
-Compile typescript plugins.
-
-``` bash
-  $ platformatic service compile
-```
-
-As a result of executing this command, Platformatic Service will compile typescript
-plugins in the `outDir` directory. 
-
-Using the  `--clean` flag, the outDir directory will be removed before the new compilation process starts.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/service/configuration)

package/help/create.txt

@@ -1,11 +0,0 @@
-Creates a new Platformatic Service application.
-
-Options are
-
-* `dir <string>` - the directory where to create the project (Default: `process.cwd() + 'platformatic-composer'`)
-* `port <string>` - the port where the application will listen (Default: `3042`)
-* `hostname <string>` - the hostname where the application will listen (Default: `0.0.0.0`)
-* `git <boolean>` - Init the git repository (Default: `true`)
-* `typescript <boolean>` - Use Typescript (Default: `false`)
-* `install <boolean>` - Run or not `npm install` after creating the files (Default: `true`)
-* `plugin <boolean>` - Creates a sample plugin and tests (Default: `true`)

package/help/help.txt

@@ -1,8 +0,0 @@
-Available commands:
-
-* `create` - creates a new Platformatic Service application.
-* `help` - show this help message.
-* `help <command>` - show more information about a command.
-* `start` - start the server.
-* `schema config` - generate the schema configuration file.
-* `compile` - compile the typescript files.

package/help/schema.txt

@@ -1,9 +0,0 @@
-Update the config schema file:
-
-* `schema config` - update the JSON schema config available on `platformatic.json`
-
-Your configuration on `platformatic.json` has a schema defined to improve the developer experience and avoid mistakes when updating the configuration of Platformatic Service.
-When you initialize a new Platformatic service (f.e. running `npm create platformatic@latest`), a new JSON `$schema` property is added in the `platformatic.json` config. This can allow your IDE to add suggestions (f.e. mandatory/missing fields, types, default values) by opening the config in `platformatic.service.json`.
-Running `platformatic service schema config` you can update your schema so that it matches well the latest changes available on your config.
-
-

package/help/start.txt

@@ -1,23 +0,0 @@
-Start the Platformatic Service with the following command:
-
-``` bash
- $ platformatic service start
- ```
-
-You will need a  configuration file. Here is an example to get you started,
-save the following as `platformatic.json`:
-
-``` json
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "info"
-    }
-  },
-  "plugin": {
-    "path": "./plugin.js"
-  }
-}
-```

package/index.test-d.ts

@@ -1,107 +0,0 @@
-import { expectType, expectError } from 'tsd'
-import { FastifyInstance } from 'fastify'
-import ConfigManager, { StackableInterface } 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 {
-    platformatic: PlatformaticApp<PlatformaticService>
-  }
-}
-
-const server = await buildServer({})
-
-expectType<FastifyInstance>(server)
-expectType<ConfigManager<PlatformaticService>>(server.platformatic.configManager)
-expectType<PlatformaticService>(server.platformatic.configManager.current)
-expectType<PlatformaticService>(server.platformatic.config)
-expectType<OpenAPI.Document>(server.swagger())
-expectType<MercuriusPlugin>(server.graphql)
-expectType<Promise<void>>(server.restart())
-
-function buildStackable (): Stackable<PlatformaticServiceConfig> {
-  const myApp: Stackable<PlatformaticServiceConfig> = {
-    async app (app: FastifyInstance, opts: object): Promise<void> {
-      await platformaticService.app(app, opts)
-    },
-
-    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
-      if (typeof upgrade === 'function') {
-        return upgrade.call(this, config, version)
-      }
-      return config
-    },
-    buildStackable: () => Promise.resolve({} as StackableInterface),
-  }
-
-  // configVersion is not part of ConfigManagerConfig
-  expectError(myApp.configManagerConfig.configVersion)
-
-  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)
-
-function buildStackable2 (): Stackable<PlatformaticServiceConfig> {
-  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',
-          }],
-        }
-      },
-    },
-    buildStackable: () => Promise.resolve({} as StackableInterface),
-  }
-
-  await start(myApp, ['--help'])
-
-  return myApp
-}
-
-expectType<Stackable<PlatformaticServiceConfig>>(buildStackable2())

package/lib/create.mjs

@@ -1,85 +0,0 @@
-'use strict'
-import minimist from 'minimist'
-import { Generator } from '../lib/generator/service-generator.js'
-import { join } from 'node:path'
-import { getPkgManager } from '@platformatic/utils'
-import { execa } from 'execa'
-import ora from 'ora'
-import { Table } from 'console-table-printer'
-import pino from 'pino'
-import pinoPretty from 'pino-pretty'
-
-function printAppSummary (args, logger) {
-  logger.info('Creating a Platformatic Service app with this config: ')
-  const table = [
-    { config: 'Directory', value: args.dir },
-    { 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 },
-  ]
-
-  const p = new Table({
-    columns: [
-      { name: 'config', alignment: 'right' },
-      { name: 'value', alignment: 'left' },
-    ],
-  })
-
-  p.addRows(table)
-  p.printTable()
-}
-async function createService (_args) {
-  const stream = pinoPretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid',
-    minimumLevel: 'debug',
-    sync: true,
-  })
-
-  const logger = pino(stream)
-
-  const args = minimist(process.argv.slice(2), {
-    string: ['dir', 'port', 'hostname'],
-    boolean: ['typescript', 'install', 'plugin', 'git'],
-    default: {
-      dir: join(process.cwd(), 'platformatic-service'),
-      port: 3042,
-      hostname: '0.0.0.0',
-      plugin: true,
-      typescript: false,
-      git: false,
-      install: true,
-    },
-
-  })
-
-  printAppSummary(args, logger)
-
-  const gen = new Generator({})
-  gen.setConfig({
-    port: args.port,
-    hostname: args.hostname,
-    plugin: args.plugin,
-    tests: args.plugin,
-    typescript: args.typescript,
-    initGitRepository: args.git,
-    targetDirectory: args.dir,
-  })
-
-  try {
-    await gen.run()
-    if (args.install) {
-      const pkgManager = getPkgManager()
-      const spinner = ora('Installing dependencies...').start()
-      await execa(pkgManager, ['install'], { cwd: args.dir })
-      spinner.succeed()
-    }
-
-    logger.info('Done! 🎉')
-  } catch (err) {
-    logger.error(err.message)
-  }
-}
-
-export { createService }

package/lib/gen-schema.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const { writeFile } = require('fs/promises')
-const { schema: platformaticServiceSchema } = require('./schema.js')
-
-const filenameConfigJsonSchema = 'platformatic.service.schema.json'
-
-async function generateJsonSchemaConfig () {
-  await writeFile(filenameConfigJsonSchema, JSON.stringify(platformaticServiceSchema, null, 2))
-}
-
-module.exports = {
-  generateJsonSchemaConfig,
-  filenameConfigJsonSchema,
-}

package/lib/gen-types.mjs

@@ -1,38 +0,0 @@
-import { join, dirname } from 'path'
-import { createRequire } from 'module'
-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 { checkForDependencies } from '@platformatic/utils'
-
-const GLOBAL_TYPES_TEMPLATE = `
-import { FastifyInstance } from 'fastify'
-import { PlatformaticApp, PlatformaticServiceConfig } from '@platformatic/service'
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    platformatic: PlatformaticApp<PlatformaticServiceConfig>
-  }
-}
-`
-async function execute ({ logger, configManager }) {
-  const fileNameOrThen = join(dirname(configManager.fullPath), 'global.d.ts')
-  await writeFile(fileNameOrThen, GLOBAL_TYPES_TEMPLATE)
-}
-
-async function generateTypes (_args) {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid',
-  }))
-  const { configManager, args } = await loadConfig({}, _args, platformaticService)
-  await configManager.parseAndValidate()
-  const config = configManager.current
-
-  await execute({ logger, configManager })
-  await checkForDependencies(logger, args, createRequire(import.meta.url), config, ['@platformatic/service'])
-}
-
-export { execute, generateTypes }

package/lib/generator/README.md

@@ -1,31 +0,0 @@
-# Platformatic Service API
-
-This is a generated [Platformatic Service](https://docs.platformatic.dev/docs/service/overview) application.
-
-## Requirements
-
-Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).
-You'll need to have [Node.js](https://nodejs.org/) >= v18.8.0 or >= v20.6.0
-
-## Setup
-
-Install dependencies:
-
-```bash
-npm install
-```
-
-## Usage
-
-Run the API with:
-
-```bash
-npm start
-```
-
-### Explore
-- ⚡ The Platformatic DB server is running at http://localhost:3042/
-- 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/
-- 🔍 Try out the GraphiQL web UI at http://localhost:3042/graphiql
-
-

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

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

package/lib/generator/service-generator.js

@@ -1,126 +0,0 @@
-'use strict'
-
-const { BaseGenerator } = require('@platformatic/generators')
-const { readFile } = require('node:fs/promises')
-const { join } = require('node:path')
-
-class ServiceGenerator extends BaseGenerator {
-  constructor (opts = {}) {
-    super({
-      ...opts,
-      module: '@platformatic/service',
-    })
-  }
-
-  getDefaultConfig () {
-    const config = super.getDefaultConfig()
-    config.plugin = true
-    config.tests = true
-    return config
-  }
-
-  async _beforePrepare () {
-    // if we are NOT updating, create env and files, otherwise leave as it is
-    if (!this.config.isUpdating) {
-      if (!this.config.isRuntimeContext) {
-        this.addEnvVars({
-          PLT_SERVER_HOSTNAME: this.config.hostname,
-          PLT_SERVER_LOGGER_LEVEL: 'info',
-          PORT: 3042,
-        }, { overwrite: false })
-      }
-
-      this.addEnvVars({
-        PLT_TYPESCRIPT: this.config.typescript,
-      }, { overwrite: false, default: true })
-
-      this.config.dependencies = {
-        '@platformatic/service': `^${this.platformaticVersion}`,
-      }
-    }
-  }
-
-  getConfigFieldsDefinitions () {
-    if (this.config.isRuntimeContext) {
-      return []
-    }
-    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,
-        type: 'number',
-        configValue: 'port',
-      },
-    ]
-  }
-
-  async _afterPrepare () {
-    // if we are NOT updating, create env and files, otherwise leave as it is
-    if (!this.config.isUpdating) {
-      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 })
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
-    }
-  }
-
-  async _getConfigFileContents () {
-    const { isRuntimeContext } = this.config
-    const version = this.platformaticVersion
-    const config = {
-      $schema: `https://schemas.platformatic.dev/@platformatic/service/${version}.json`,
-      service: {
-        openapi: true,
-      },
-      watch: true,
-    }
-    if (this.config.plugin) {
-      config.plugins = {
-        paths: [
-          { path: './plugins', encapsulate: false },
-          './routes',
-        ],
-        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`,
-      }
-    }
-
-    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