@platformatic/composer 2.72.0 → 3.0.0-alpha.1

package/lib/create.mjs

@@ -1,84 +0,0 @@
-'use strict'
-import minimist from 'minimist'
-import { Generator } from './generator/composer-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 Composer 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 },
-  ]
-
-  const p = new Table({
-    columns: [
-      { name: 'config', alignment: 'right' },
-      { name: 'value', alignment: 'left' },
-    ],
-  })
-
-  p.addRows(table)
-  p.printTable()
-}
-async function createComposer (_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', 'git'],
-    boolean: ['typescript', 'install'],
-    default: {
-      dir: join(process.cwd(), 'platformatic-composer'),
-      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 { createComposer }

package/lib/generator/README.md

@@ -1,30 +0,0 @@
-# Platformatic Composer API
-
-This is a generated [Platformatic Composer](https://docs.platformatic.dev/docs/composer/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
-
-1. Install dependencies:
-
-```bash
-npm install
-```
-
-## Usage
-
-Run the API with:
-
-```bash
-npm start
-```
-
-### Explore
-- ⚡ The Platformatic Composer server is running at http://localhost:3042/
-- 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/
-
-

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

@@ -1,11 +0,0 @@
-import { BaseGenerator } from "@platformatic/generators";
-import RuntimeGenerator from "../../../runtime/lib/generator/runtime-generator";
-
-export namespace ComposerGenerator {
-  export class ComposerGenerator extends BaseGenerator {
-    runtime: RuntimeGenerator
-
-    setRuntime(runtime: RuntimeGenerator): void
-  }
-  
-}

package/lib/generator/composer-generator.js

@@ -1,128 +0,0 @@
-'use strict'
-
-const { BaseGenerator } = require('@platformatic/generators')
-const { join } = require('node:path')
-const { readFile } = require('node:fs/promises')
-
-class ComposerGenerator extends BaseGenerator {
-  constructor (opts) {
-    super({
-      ...opts,
-      module: '@platformatic/composer',
-    })
-    this.runtime = null
-  }
-
-  getDefaultConfig () {
-    const defaultBaseConfig = super.getDefaultConfig()
-    return {
-      ...defaultBaseConfig,
-      plugin: false,
-      routes: false,
-      tests: false,
-    }
-  }
-
-  async _getConfigFileContents () {
-    const template = {
-      $schema: `https://schemas.platformatic.dev/@platformatic/composer/${this.platformaticVersion}.json`,
-      composer: {
-        services: [
-          {
-            id: 'example',
-            origin: `{${this.getEnvVarName('PLT_EXAMPLE_ORIGIN')}}`,
-            openapi: {
-              url: '/documentation/json',
-            },
-          },
-        ],
-        refreshTimeout: 1000,
-      },
-      watch: true,
-    }
-    if (this.runtime !== null) {
-      template.composer.services = this.runtime.services
-        .filter(serviceMeta => serviceMeta.service.module !== '@platformatic/composer')
-        .map((serviceMeta) => {
-          return {
-            id: serviceMeta.name,
-            openapi: {
-              url: '/documentation/json',
-              prefix: `/${serviceMeta.name}`,
-            },
-          }
-        })
-    }
-
-    if (this.config.plugin) {
-      template.plugins = {
-        paths: [
-          {
-            path: './plugins',
-            encapsulate: false,
-          },
-          './routes',
-        ],
-        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`,
-      }
-    }
-
-    if (!this.config.isRuntimeContext) {
-      template.server = {
-        hostname: '{PLT_SERVER_HOSTNAME}',
-        port: '{PORT}',
-        logger: {
-          level: '{PLT_SERVER_LOGGER_LEVEL}',
-        },
-      }
-    }
-
-    return template
-  }
-
-  async _beforePrepare () {
-    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, default: true })
-      }
-
-      this.addEnvVars({
-        PLT_TYPESCRIPT: this.config.typescript,
-        PLT_EXAMPLE_ORIGIN: 'http://127.0.0.1:3043',
-      }, { overwrite: false, default: true })
-
-      this.config.dependencies = {
-        '@platformatic/composer': `^${this.platformaticVersion}`,
-      }
-    }
-  }
-
-  async _afterPrepare () {
-    if (!this.config.isUpdating) {
-      const GLOBAL_TYPES_TEMPLATE = `
-import { FastifyInstance } from 'fastify'
-import { PlatformaticApp, PlatformaticComposerConfig } from '@platformatic/composer'
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    platformatic: PlatformaticApp<PlatformaticComposerConfig>
-  }
-}
-`
-      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') })
-    }
-  }
-
-  setRuntime (runtime) {
-    this.runtime = runtime
-  }
-}
-
-module.exports = ComposerGenerator
-module.exports.ComposerGenerator = ComposerGenerator
-module.exports.Generator = ComposerGenerator

package/lib/metrics.js

@@ -1,12 +0,0 @@
-export function initMetrics (prometheus) {
-  if (!prometheus?.registry || !prometheus?.client) return null
-  const { client, registry } = prometheus
-
-  return {
-    activeWsConnections: new client.Gauge({
-      name: 'active_ws_composer_connections',
-      help: 'Active Websocket composer connections in "@platformatic/composer"',
-      registers: [registry]
-    })
-  }
-}

package/lib/openapi-fetch-schemas.mjs

@@ -1,61 +0,0 @@
-import { writeFile } from 'node:fs/promises'
-
-import pino from 'pino'
-import pretty from 'pino-pretty'
-import { request } from 'undici'
-
-import { loadConfig } from '@platformatic/config'
-import { platformaticComposer } from '../index.js'
-import errors from '../lib/errors.js'
-import { prefixWithSlash } from './utils.js'
-
-async function fetchOpenApiSchema (service) {
-  const { origin, openapi } = service
-
-  const openApiUrl = origin + prefixWithSlash(openapi.url)
-  const { statusCode, body } = await request(openApiUrl)
-
-  if (statusCode !== 200 && statusCode !== 201) {
-    throw new errors.FailedToFetchOpenAPISchemaError(openApiUrl)
-  }
-  const schema = await body.json()
-
-  if (openapi.file !== undefined) {
-    await writeFile(openapi.file, JSON.stringify(schema, null, 2))
-  }
-
-  return schema
-}
-
-export default async function fetchOpenApiSchemas (_args) {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid',
-  }))
-
-  const { configManager } = await loadConfig({}, _args, platformaticComposer)
-  await configManager.parseAndValidate()
-  const config = configManager.current
-  const { services } = config.composer
-
-  const servicesWithValidOpenApi = services
-    .filter(({ openapi }) => openapi && openapi.url && openapi.file)
-
-  const fetchOpenApiRequests = servicesWithValidOpenApi
-    .map(service => fetchOpenApiSchema(service))
-
-  const fetchOpenApiResults = await Promise.allSettled(fetchOpenApiRequests)
-  fetchOpenApiResults.forEach((result, index) => {
-    const serviceId = servicesWithValidOpenApi[index].id
-    if (result.status === 'rejected') {
-      logger.error(`Failed to fetch OpenAPI schema for service with id ${serviceId}: ${result.reason}`)
-    } else {
-      logger.info(`Successfully fetched OpenAPI schema for service with id ${serviceId}`)
-    }
-  })
-}
-
-export {
-  fetchOpenApiSchema,
-  fetchOpenApiSchemas,
-}