@platformatic/service 1.51.8 → 2.0.0-alpha.2

package/schema.json

@@ -1,6 +1,6 @@
 {
-  "$id": "https://platformatic.dev/schemas/v1.51.8/service",
-  "version": "1.51.8",
+  "$id": "https://platformatic.dev/schemas/v2.0.0-alpha.2/service",
+  "version": "2.0.0-alpha.2",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {
@@ -953,196 +953,6 @@
         },
         "additionalProperties": false
       }
-    },
-    "versions": {
-      "type": "object",
-      "properties": {
-        "dir": {
-          "type": "string",
-          "description": "The path to the directory containing the versions mappers",
-          "resolvePath": true,
-          "default": "versions"
-        },
-        "configs": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "version": {
-                "type": "string"
-              },
-              "openapi": {
-                "type": "object",
-                "properties": {
-                  "prefix": {
-                    "type": "string"
-                  },
-                  "path": {
-                    "type": "string",
-                    "resolvePath": true
-                  }
-                },
-                "additionalProperties": false
-              },
-              "plugins": {
-                "type": "object",
-                "properties": {
-                  "packages": {
-                    "type": "array",
-                    "items": {
-                      "anyOf": [
-                        {
-                          "type": "string"
-                        },
-                        {
-                          "type": "object",
-                          "properties": {
-                            "name": {
-                              "type": "string"
-                            },
-                            "options": {
-                              "type": "object",
-                              "additionalProperties": true
-                            }
-                          },
-                          "required": [
-                            "name"
-                          ]
-                        }
-                      ]
-                    }
-                  },
-                  "paths": {
-                    "type": "array",
-                    "items": {
-                      "anyOf": [
-                        {
-                          "type": "string",
-                          "resolvePath": true
-                        },
-                        {
-                          "type": "object",
-                          "properties": {
-                            "path": {
-                              "type": "string",
-                              "resolvePath": true
-                            },
-                            "encapsulate": {
-                              "type": "boolean",
-                              "default": true
-                            },
-                            "maxDepth": {
-                              "type": "integer"
-                            },
-                            "autoHooks": {
-                              "type": "boolean"
-                            },
-                            "autoHooksPattern": {
-                              "type": "string"
-                            },
-                            "cascadeHooks": {
-                              "type": "boolean"
-                            },
-                            "overwriteHooks": {
-                              "type": "boolean"
-                            },
-                            "routeParams": {
-                              "type": "boolean"
-                            },
-                            "forceESM": {
-                              "type": "boolean"
-                            },
-                            "ignoreFilter": {
-                              "type": "string"
-                            },
-                            "matchFilter": {
-                              "type": "string"
-                            },
-                            "ignorePattern": {
-                              "type": "string"
-                            },
-                            "scriptPattern": {
-                              "type": "string"
-                            },
-                            "indexPattern": {
-                              "type": "string"
-                            },
-                            "options": {
-                              "type": "object",
-                              "additionalProperties": true
-                            }
-                          }
-                        }
-                      ]
-                    }
-                  },
-                  "typescript": {
-                    "anyOf": [
-                      {
-                        "type": "object",
-                        "properties": {
-                          "enabled": {
-                            "anyOf": [
-                              {
-                                "type": "boolean"
-                              },
-                              {
-                                "type": "string"
-                              }
-                            ]
-                          },
-                          "tsConfig": {
-                            "type": "string",
-                            "resolvePath": true
-                          },
-                          "outDir": {
-                            "type": "string",
-                            "resolvePath": true
-                          },
-                          "flags": {
-                            "type": "array",
-                            "items": {
-                              "type": "string"
-                            }
-                          }
-                        }
-                      },
-                      {
-                        "type": "boolean"
-                      },
-                      {
-                        "type": "string"
-                      }
-                    ]
-                  }
-                },
-                "additionalProperties": false,
-                "anyOf": [
-                  {
-                    "required": [
-                      "paths"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "packages"
-                    ]
-                  }
-                ]
-              }
-            },
-            "required": [
-              "version"
-            ],
-            "additionalProperties": false
-          }
-        }
-      },
-      "required": [
-        "dir",
-        "configs"
-      ],
-      "additionalProperties": false
     }
   },
   "additionalProperties": false,

package/service.mjs

@@ -7,12 +7,10 @@ import helpMe from 'help-me'
 import { readFile } from 'fs/promises'
 import { join } from 'desm'
 import { printAndExitLoadConfigError } from '@platformatic/config'
+import { buildCompileCmd } from './lib/compile.js'
 import { generateJsonSchemaConfig } from './lib/gen-schema.js'
-import { bumpVersion } from './lib/bump-version.js'
-import { updateVersion } from './lib/update-version.js'
 import { generateTypes } from './lib/gen-types.mjs'
 import { createService } from './lib/create.mjs'
-import { buildCompileCmd } from './lib/compile.js'
 
 import { start, platformaticService } from './index.js'
 
@@ -48,8 +46,6 @@ program.register('compile', buildCompileCmd(platformaticService))
 program.register('types', wrapCommand(generateTypes))
 program.register('schema config', wrapCommand(generateJsonSchemaConfig))
 program.register('schema', help.toStdout.bind(null, ['schema']))
-program.register('versions bump', wrapCommand(bumpVersion))
-program.register('versions update', wrapCommand(updateVersion))
 
 export async function runService (argv) {
   const args = parseArgs(argv, {
@@ -59,7 +55,7 @@ export async function runService (argv) {
   })
 
   /* c8 ignore next 4 */
-  if (args.version && !args._.includes('versions')) {
+  if (args.version) {
     console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version)
     process.exit(0)
   }

package/help/versions bump.txt

@@ -1,25 +0,0 @@
-Bump a new version of platformatic application API.
-
-``` bash
-  $ platformatic service versions bump
-```
-
-As a result, a new application API version will be created, and mappers for the previous version will be generated.
-
-Options:
-
-* `-c, --config <path>` - Path to the configuration file.
-* `-v, --version <string>` - The name of the version to bump. Default: if first version, then `v1`, else `vX`.
-* `-p, --prefix <string>` - The prefix to use for the new version. Default: if first version, then `/v1`, else `/vX`.
-* `--openai` - Use OpenAI to generate the version mappers plugins. Default: false.
-* `--user-api-key <string>` - Platformatic user API key. If not specified, the key will be loaded from the `~/.platformatic/config` file.
-
-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 DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
-

package/help/versions update.txt

@@ -1,23 +0,0 @@
-Update the latest version of platformatic application API.
-
-``` bash
-  $ platformatic service versions update
-```
-
-As a result, the latest application API version will be updated, and mappers for the previous version will be generated.
-
-Options:
-
-* `-c, --config <path>` - Path to the configuration file.
-* `--openai <boolean>` - Use OpenAI to generate the version mappers plugins. Default: false.
-* `--user-api-key <string>` - Platformatic user API key. If not specified, the key will be loaded from the `~/.platformatic/config` file.
-
-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 DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
-

package/lib/bump-version.js

@@ -1,178 +0,0 @@
-'use strict'
-
-const { join, relative } = require('node:path')
-const { mkdir, readFile, writeFile } = require('node:fs/promises')
-const pino = require('pino')
-const pretty = require('pino-pretty')
-const { loadConfig, getParser, getStringifier } = require('@platformatic/config')
-const { platformaticService } = require('../index.js')
-const { getOpenapiSchema } = require('./get-openapi-schema.js')
-const { createMappersPlugins } = require('./update-version.js')
-const { changeOpenapiSchemaPrefix } = require('./utils')
-const errors = require('./errors.js')
-
-async function execute ({
-  logger,
-  configManager,
-  version,
-  prefix,
-  userApiKey,
-  openai,
-  openaiProxyHost
-}) {
-  const config = configManager.current
-
-  const parse = getParser(configManager.fullPath)
-  const stringify = getStringifier(configManager.fullPath)
-  const rawConfig = parse(await readFile(configManager.fullPath, 'utf8'))
-
-  const versionsDirName = 'versions'
-  const versionsDirPath = config.versions?.dir ??
-    join(configManager.dirname, versionsDirName)
-
-  let versionsConfigs = config.versions
-  let rawVersionsConfigs = rawConfig.versions
-
-  if (!config.versions) {
-    versionsConfigs = { dir: versionsDirName, configs: [] }
-    rawVersionsConfigs = { dir: versionsDirName, configs: [] }
-  }
-
-  let biggestVersion = 0
-  for (const versionConfig of versionsConfigs.configs) {
-    if (versionConfig.version === version) {
-      throw new errors.VersionAlreadyExists(version)
-    }
-    const versionNumber = parseInt(versionConfig.version.slice(1))
-    if (!isNaN(versionNumber)) {
-      biggestVersion = Math.max(biggestVersion, versionNumber)
-    }
-  }
-  version = version ?? `v${biggestVersion + 1}`
-  prefix = prefix ?? `/${version}`
-  prefix = prefix.charAt(0) === '/' ? prefix : `/${prefix}`
-
-  const versionDir = join(versionsDirPath, version)
-  await mkdir(versionDir, { recursive: true })
-
-  const latestVersionConfig = versionsConfigs.configs.at(-1)
-  const rawLatestVersionConfig = rawVersionsConfigs.configs.at(-1)
-
-  const latestVersion = latestVersionConfig?.version ?? null
-  const latestVersionPrefix = latestVersionConfig?.openapi?.prefix ?? ''
-
-  logger.info('Loading the latest openapi schema.')
-  const latestOpenapiSchema = await getOpenapiSchema({
-    logger,
-    configManager,
-    version: latestVersion
-  })
-
-  const newOpenapiSchema = changeOpenapiSchemaPrefix(
-    latestOpenapiSchema,
-    latestVersionPrefix,
-    prefix
-  )
-  const newOpenapiSchemaPath = join(versionDir, 'openapi.json')
-
-  logger.info(`Writing "${version}" openapi schema file.`)
-  await writeFile(newOpenapiSchemaPath, JSON.stringify(newOpenapiSchema, null, 2))
-
-  const newVersionConfig = {
-    version,
-    openapi: {
-      path: relative(configManager.dirname, newOpenapiSchemaPath),
-      prefix
-    }
-  }
-
-  if (latestVersionConfig) {
-    newVersionConfig.plugins = rawLatestVersionConfig.plugins
-    delete latestVersionConfig.plugins
-    delete rawLatestVersionConfig.plugins
-  } else if (config.plugins) {
-    newVersionConfig.plugins = rawConfig.plugins
-    delete config.plugins
-    delete rawConfig.plugins
-  }
-
-  versionsConfigs.configs.push(newVersionConfig)
-  rawVersionsConfigs.configs.push(newVersionConfig)
-
-  config.versions = versionsConfigs
-  rawConfig.versions = rawVersionsConfigs
-
-  await Promise.all([configManager.update(), writeFile(configManager.fullPath, stringify(rawConfig))])
-
-  if (latestVersionConfig) {
-    logger.info(`Reading openapi schema for "${latestVersion}"`)
-    const prevOpenapiSchemaPath = latestVersionConfig.openapi.path
-    const prevOpenapiSchemaFile = await readFile(prevOpenapiSchemaPath, 'utf8')
-    const prevOpenapiSchema = JSON.parse(prevOpenapiSchemaFile)
-
-    await createMappersPlugins({
-      logger,
-      configManager,
-      prevVersion: latestVersion,
-      nextVersion: version,
-      prevOpenapiSchema,
-      nextOpenapiSchema: newOpenapiSchema,
-      userApiKey,
-      openai,
-      openaiProxyHost
-    })
-  }
-}
-
-async function bumpVersion (_args) {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid'
-  }))
-
-  try {
-    const { configManager, args } = await loadConfig({
-      string: ['version', 'prefix', 'openai-proxy-host', 'user-api-key'],
-      boolean: ['openai'],
-      alias: {
-        v: 'version',
-        p: 'prefix'
-      }
-    }, _args, platformaticService)
-    await configManager.parseAndValidate()
-
-    const version = args.version
-    const prefix = args.prefix
-
-    const openai = args.openai ?? false
-    const openaiProxyHost = args['openai-proxy-host'] ?? null
-
-    let userApiKey = args['user-api-key'] ?? null
-    /* c8 ignore next 10 */
-    if (!userApiKey && openai) {
-      logger.info('Reading platformatic user api key')
-      const { getUserApiKey } = await import('@platformatic/authenticate')
-      try {
-        userApiKey = await getUserApiKey()
-      } catch (err) {
-        logger.error('Failed to read user api key. Please run "plt login" command.')
-        return
-      }
-    }
-
-    await execute({
-      logger,
-      configManager,
-      version,
-      prefix,
-      userApiKey,
-      openai,
-      openaiProxyHost
-    })
-  } catch (err) {
-    logger.error(err.message)
-    process.exit(1)
-  }
-}
-
-module.exports = { bumpVersion, execute }

package/lib/errors.js

@@ -1,16 +0,0 @@
-'use strict'
-
-const createError = require('@fastify/error')
-
-const ERROR_PREFIX = 'PLT_SERVICE'
-
-module.exports = {
-  VersionNotSpecified: createError(
-    `${ERROR_PREFIX}_VERSION_NOT_SPECIFIED_ERROR`,
-    'Version not specified. Use --version option to specify a version.'
-  ),
-  VersionAlreadyExists: createError(
-    `${ERROR_PREFIX}_VERSION_EXISTS_ERROR`,
-    'Version %s already exists.'
-  )
-}

package/lib/get-openapi-schema.js

@@ -1,47 +0,0 @@
-'use strict'
-
-const { printAndExitLoadConfigError } = require('@platformatic/config')
-const { buildServer } = require('./start')
-const { platformaticService } = require('../index.js')
-
-async function getOpenapiSchema ({ logger, configManager, version }) {
-  const config = configManager.current
-
-  let app = null
-  try {
-    app = await buildServer({ ...config, configManager }, platformaticService)
-    await app.ready()
-  /* c8 ignore next 4 */
-  } catch (err) {
-    printAndExitLoadConfigError(err)
-    process.exit(1)
-  }
-
-  if (!version) {
-    return app.swagger()
-  }
-
-  if (!config.versions) {
-    throw new Error('No versions configured')
-  }
-
-  const versionsConfigs = config.versions.configs ?? []
-  const versionConfig = versionsConfigs.find(v => v.version === version)
-  const versionPrefix = versionConfig.openapi.prefix ?? ''
-
-  const openapiUrl = versionPrefix
-    ? versionPrefix + '/documentation/json'
-    : '/documentation/json'
-
-  const { statusCode, body } = await app.inject({ method: 'GET', url: openapiUrl })
-
-  /* c8 ignore next 3 */
-  if (statusCode !== 200) {
-    throw new Error(`Failed to get openapi schema for version ${version}`)
-  }
-
-  const openapiSchema = JSON.parse(body)
-  return openapiSchema
-}
-
-module.exports = { getOpenapiSchema }