@platformatic/service 1.51.8 → 2.0.0-alpha.2

package/config.d.ts

@@ -214,22 +214,6 @@ export interface PlatformaticService {
     fullRequest?: boolean;
     validateResponse?: boolean;
   }[];
-  versions?: {
-    /**
-     * The path to the directory containing the versions mappers
-     */
-    dir: string;
-    configs: {
-      version: string;
-      openapi?: {
-        prefix?: string;
-        path?: string;
-      };
-      plugins?: {
-        [k: string]: unknown;
-      };
-    }[];
-  };
 }
 export interface OpenTelemetry {
   /**

package/help/help.txt

@@ -6,5 +6,3 @@ Available commands:
 * `start` - start the server.
 * `schema config` - generate the schema configuration file.
 * `compile` - compile the typescript files.
-* `versions bump` - bump a new version of the API.
-* `versions update` - update the latest version of the API.

package/index.d.ts

@@ -46,10 +46,6 @@ export interface Stackable<ConfigType> {
   transformConfig?: (config: any) => Promise<any>
 }
 
-interface SchemaExport {
-  schema: JSONSchemaType<PlatformaticServiceConfig>
-}
-
 interface TSCompilerOptions {
   clean: boolean
 }
@@ -57,7 +53,7 @@ interface TSCompiler {
   compile: (cwd: string, config: object, originalLogger: FastifyBaseLogger, options: TSCompilerOptions) => Promise<boolean>
 }
 
-export const schema: SchemaExport
+export const schema: JSONSchemaType<PlatformaticServiceConfig>
 
 export declare const platformaticService: Stackable<PlatformaticServiceConfig>
 

package/index.js

@@ -4,7 +4,6 @@ const { isKeyEnabled } = require('@platformatic/utils')
 const { readFile } = require('fs/promises')
 const { join } = require('path')
 
-const compiler = require('./lib/compile')
 const setupCors = require('./lib/plugins/cors')
 const setupOpenAPI = require('./lib/plugins/openapi.js')
 const setupGraphQL = require('./lib/plugins/graphql.js')
@@ -13,10 +12,10 @@ const setupMetrics = require('./lib/plugins/metrics')
 const setupTsCompiler = require('./lib/plugins/typescript')
 const setupHealthCheck = require('./lib/plugins/health-check')
 const loadPlugins = require('./lib/plugins/plugins')
-const loadVersions = require('./lib/plugins/versions')
 const upgrade = require('./lib/upgrade')
 const { telemetry } = require('@platformatic/telemetry')
 
+const { buildCompileCmd, extractTypeScriptCompileOptionsFromConfig } = require('./lib/compile')
 const { schema } = require('./lib/schema')
 const { addLoggerToTheConfig } = require('./lib/utils')
 const { start, buildServer } = require('./lib/start')
@@ -61,8 +60,7 @@ async function platformaticService (app, opts) {
 
   if (isKeyEnabled('openapi', serviceConfig)) {
     const openapi = serviceConfig.openapi
-    const versions = config.versions
-    app.register(setupOpenAPI, { openapi, versions })
+    app.register(setupOpenAPI, { openapi })
   }
 
   if (isKeyEnabled('graphql', serviceConfig)) {
@@ -85,13 +83,6 @@ async function platformaticService (app, opts) {
     app.register(loadPlugins)
   }
 
-  await app.register(async (app) => {
-    if (config.versions) {
-      // TODO: Add typescript mappers support
-      await app.register(loadVersions)
-    }
-  })
-
   if (isKeyEnabled('cors', config.server)) {
     app.register(setupCors, config.server.cors)
   }
@@ -102,7 +93,6 @@ async function platformaticService (app, opts) {
 }
 
 platformaticService[Symbol.for('skip-override')] = true
-platformaticService.schema = schema
 platformaticService.configType = 'service'
 platformaticService.configManagerConfig = {
   version,
@@ -148,11 +138,13 @@ platformaticService.configManagerConfig = {
 function _buildServer (options, app) {
   return buildServer(options, app || platformaticService)
 }
-
+module.exports = platformaticService
+module.exports.schema = schema
 module.exports.buildServer = _buildServer
-module.exports.schema = require('./lib/schema')
+module.exports.schemas = require('./lib/schema')
 module.exports.platformaticService = platformaticService
 module.exports.addLoggerToTheConfig = addLoggerToTheConfig
-module.exports.tsCompiler = compiler
 module.exports.start = start
 module.exports.Generator = ServiceGenerator
+module.exports.buildCompileCmd = buildCompileCmd
+module.exports.extractTypeScriptCompileOptionsFromConfig = extractTypeScriptCompileOptionsFromConfig

package/index.test-d.ts

@@ -36,7 +36,7 @@ function buildStackable (): Stackable<PlatformaticServiceConfig> {
     await platformaticService(app, opts)
   }
 
-  myApp.schema = platformaticService.configManagerConfig.schema
+  myApp.schema = platformaticService.schema
   myApp.configType = 'myApp'
   myApp.configManagerConfig = {
     version: platformaticService.configManagerConfig.version,
@@ -81,7 +81,7 @@ function buildStackable2 (): Stackable<PlatformaticServiceConfig> {
     await platformaticService(app, opts)
   }
 
-  myApp.schema = platformaticService.configManagerConfig.schema
+  myApp.schema = platformaticService.schema
   myApp.configType = 'myApp'
   myApp.configManagerConfig = {
     ...platformaticService.configManagerConfig,

package/lib/compile.js

@@ -1,107 +1,16 @@
 'use strict'
 
-const { resolve, join, dirname } = require('path')
+const { compile } = require('@platformatic/ts-compiler')
+const { loadConfig } = require('@platformatic/config')
 const pino = require('pino')
 const pretty = require('pino-pretty')
-const { loadConfig } = require('@platformatic/config')
-const { isFileAccessible } = require('./utils.js')
-const { readFile, rm } = require('fs/promises')
-
-async function getTSCExecutablePath (cwd) {
-  const typescriptPath = require.resolve('typescript')
-  const typescriptPathCWD = require.resolve('typescript', { paths: [process.cwd()] })
-
-  const tscLocalPath = join(typescriptPath, '..', '..', 'bin', 'tsc')
-  const tscGlobalPath = join(typescriptPathCWD, '..', '..', 'bin', 'tsc')
-
-  const [tscLocalExists, tscGlobalExists] = await Promise.all([
-    isFileAccessible(tscLocalPath),
-    isFileAccessible(tscGlobalPath)
-  ])
-
-  /* c8 ignore next 7 */
-  if (tscLocalExists) {
-    return tscLocalPath
-  }
-
-  if (tscGlobalExists) {
-    return tscGlobalPath
-  }
-}
-
-async function setup (cwd, config, logger) {
-  if (!logger) {
-    logger = pino(
-      pretty({
-        translateTime: 'SYS:HH:MM:ss',
-        ignore: 'hostname,pid'
-      })
-    )
-
-    if (config?.server.logger) {
-      logger.level = config.server.logger.level
-    }
-  }
-
-  const { execa } = await import('execa')
-
-  const tscExecutablePath = await getTSCExecutablePath(cwd)
-  /* c8 ignore next 4 */
-  if (tscExecutablePath === undefined) {
-    const msg = 'The tsc executable was not found.'
-    logger.warn(msg)
-  }
-
-  const tsConfigPath = config?.plugins?.typescript?.tsConfig || resolve(cwd, 'tsconfig.json')
-  const tsConfigExists = await isFileAccessible(tsConfigPath)
-
-  if (!tsConfigExists) {
-    const msg = 'No typescript configuration file was found, skipping compilation.'
-    logger.info(msg)
-  }
-
-  return { execa, logger, tscExecutablePath, tsConfigPath, tsConfigExists }
-}
-
-async function compile (cwd, config, originalLogger, options) {
-  const { execa, logger, tscExecutablePath, tsConfigPath, tsConfigExists } = await setup(cwd, config, originalLogger)
-  /* c8 ignore next 3 */
-  if (!tscExecutablePath || !tsConfigExists) {
-    return false
-  }
-
-  try {
-    const tsFlags = config?.plugins?.typescript?.flags || ['--project', tsConfigPath, '--rootDir', '.']
-    const env = {
-      ...process.env
-    }
-    delete env.NODE_V8_COVERAGE
-    // somehow c8 does not pick up these lines even if there is a specific test
-    /* c8 ignore start */
-    if (options && options.clean) {
-      // delete outdir directory
-      const tsConfigContents = JSON.parse(await readFile(tsConfigPath, 'utf8'))
-      const outDir = tsConfigContents.compilerOptions.outDir
-      if (outDir) {
-        const outDirFullPath = join(dirname(tsConfigPath), outDir)
-        originalLogger.info(`Removing build directory ${outDirFullPath}`)
-        await rm(outDirFullPath, { recursive: true })
-      }
-    }
-    /* c8 ignore stop */
-    await execa(tscExecutablePath, tsFlags, { cwd, env })
-    logger.info('Typescript compilation completed successfully.')
-    return true
-  } catch (error) {
-    logger.error(error.message)
-    return false
-  }
-}
+const { dirname } = require('path')
 
 function buildCompileCmd (app) {
   return async function compileCmd (_args) {
     let fullPath = null
     let config = null
+
     try {
       const { configManager } = await loadConfig({}, _args, app, {
         watch: false
@@ -114,9 +23,7 @@ function buildCompileCmd (app) {
       console.error(err)
       process.exit(1)
     }
-    const compileOptions = {
-      clean: _args.includes('--clean')
-    }
+
     const logger = pino(
       pretty({
         translateTime: 'SYS:HH:MM:ss',
@@ -124,11 +31,26 @@ function buildCompileCmd (app) {
       })
     )
 
-    if (!await compile(fullPath, config, logger, compileOptions)) {
+    const compileOptions = {
+      ...extractTypeScriptCompileOptionsFromConfig(config),
+      cwd: fullPath,
+      logger,
+      clean: _args.includes('--clean')
+    }
+
+    if (!await compile(compileOptions)) {
       process.exit(1)
     }
   }
 }
 
-module.exports.compile = compile
 module.exports.buildCompileCmd = buildCompileCmd
+
+function extractTypeScriptCompileOptionsFromConfig (config) {
+  return {
+    tsConfig: config.plugins?.typescript?.tsConfig,
+    flags: config.plugins?.typescript?.flags
+  }
+}
+
+module.exports.extractTypeScriptCompileOptionsFromConfig = extractTypeScriptCompileOptionsFromConfig

package/lib/plugins/openapi.js

@@ -10,7 +10,7 @@ const fp = require('fastify-plugin')
 // despite being covered by test/routes.test.js
 /* c8 ignore next 33 */
 async function setupOpenAPI (app, opts) {
-  const { openapi, versions } = opts
+  const { openapi } = opts
   const openapiConfig = deepmerge({
     exposeRoute: true,
     info: {
@@ -31,17 +31,6 @@ async function setupOpenAPI (app, opts) {
         /* istanbul ignore next */
         return json.$id || `def-${i}`
       }
-    },
-    transform: ({ schema, url }) => {
-      // Hide versioned endpoints
-      for (const version of versions?.configs ?? []) {
-        if (url.startsWith(version.openapi.prefix)) {
-          if (!schema) schema = {}
-          schema.hide = true
-          break
-        }
-      }
-      return { schema, url }
     }
   }
 

package/lib/plugins/typescript.js

@@ -1,16 +1,20 @@
 'use strict'
 
 const fp = require('fastify-plugin')
-const compiler = require('../compile')
+const compiler = require('@platformatic/ts-compiler')
+const { extractTypeScriptCompileOptionsFromConfig } = require('../compile')
 
 async function setupTsCompiler (app) {
-  // TODO: move params to opts
-
   const configManager = app.platformatic.configManager
   const config = configManager.current
   const workingDir = configManager.dirname
 
-  await compiler.compile(workingDir, config, app.log, { clean: false })
+  await compiler.compile({
+    ...extractTypeScriptCompileOptionsFromConfig(config),
+    cwd: workingDir,
+    clean: false,
+    logger: app.log
+  })
 }
 
 module.exports = fp(setupTsCompiler)

package/lib/root-endpoint/index.js

@@ -5,27 +5,10 @@ const fastifyStatic = require('@fastify/static')
 const userAgentParser = require('my-ua-parser')
 
 module.exports = async (app, opts) => {
-  const versions = opts.versions || {}
-
   app.register(fastifyStatic, {
     root: path.join(__dirname, 'public')
   })
 
-  app.route({
-    method: 'GET',
-    path: '/_platformatic_versions',
-    schema: { hide: true },
-    handler: () => {
-      const openapiUrls = []
-      for (const versionConfig of versions?.configs ?? []) {
-        const name = versionConfig.version
-        const prefix = versionConfig.openapi.prefix
-        openapiUrls.push({ name, prefix })
-      }
-      return openapiUrls
-    }
-  })
-
   // root endpoint
   app.route({
     method: 'GET',

package/lib/root-endpoint/public/index.html

@@ -197,6 +197,7 @@
         <div class="button-container">
           <a href="https://docs.platformatic.dev" target="_blank" class="button-link">Documentation</a>
           <div class="open-documentation-version buttons-list-container">&nbsp;</div>
+          <a id="openapi-link" target="_blank" class="button-link">OpenAPI Documentation</a>
           <a id="graphql-link" target="_blank" class="button-link">GraphiQL</a>
         </div>
       </div>
@@ -205,6 +206,9 @@
     <script>
       const currentPath = window.location.pathname
     
+      const openApiLink = document.getElementById('openapi-link')
+      openApiLink.href = currentPath + 'documentation'
+
       const graphqlLink = document.getElementById('graphql-link')
       graphqlLink.href = currentPath + 'graphiql'
 
@@ -225,27 +229,6 @@
           document.getElementById('logo').src = 'images/platformatic-logo-dark.svg'
         }
       }
-
-      function join (...paths) {
-        return paths.join('/').replace(/\/+/g, '/')
-      }
-
-      fetch('/_platformatic_versions')
-        .then(response => response.json())
-        .then(versions => {
-          const sharedOpenapiHref = join(currentPath, 'documentation')
-          const openapiButtons = [
-            `<a href="${sharedOpenapiHref}"target="_blank" class="button-link">OpenAPI Documentation</a>`
-          ]
-
-          for (const version of versions) {
-            const href = join(currentPath, version.prefix, 'documentation')
-            openapiButtons.push(`<a href="${href}" target="_blank" class="button-link">OpenAPI Documentation ${version.name}</a>`)
-          }
-
-          const buttonList = document.getElementsByClassName('open-documentation-version')[0]
-          buttonList.innerHTML = openapiButtons.join('')
-        })
     </script>
   </body>
 </html>