@platformatic/runtime 1.13.1 → 1.13.3

package/index.d.ts

@@ -1,6 +1,7 @@
 import { InjectOptions, LightMyRequestResponse } from 'fastify'
 import { FastifyError } from '@fastify/error'
-
+import { BaseLogger } from 'pino'
+import { RuntimeGenerator } from './lib/generator/runtime-generator'
 export type pltRuntimeBuildServer = {
   address: string
   port: number
@@ -11,6 +12,12 @@ export type pltRuntimeBuildServer = {
 
 declare module '@platformatic/runtime' {
   export function buildServer(opts: object): Promise<pltRuntimeBuildServer>
+  export function start(args: object): Promise<object>
+  export function startCommand(args: object): Promise<void>
+  export function loadConfig(minimistConfig: object, args: object, store: object, overrides: object, replaceEnv: boolean): void
+  export function compile(argv: string[], logger: BaseLogger): void
+  export function platformaticRuntime(): Promise<void>
+  export const Generator: RuntimeGenerator.RuntimeGenerator
 }
 
 /**

package/lib/errors.js

@@ -2,7 +2,7 @@
 
 const createError = require('@fastify/error')
 
-const ERROR_PREFIX = 'PLT_SQL_RUNTIME'
+const ERROR_PREFIX = 'PLT_RUNTIME'
 
 module.exports = {
   RuntimeExitedError: createError(`${ERROR_PREFIX}_RUNTIME_EXIT`, 'The runtime exited before the operation completed'),
@@ -22,5 +22,4 @@ module.exports = {
   InspectorHostError: createError(`${ERROR_PREFIX}_INSPECTOR_HOST`, 'Inspector host cannot be empty'),
   CannotMapSpecifierToAbsolutePathError: createError(`${ERROR_PREFIX}_CANNOT_MAP_SPECIFIER_TO_ABSOLUTE_PATH`, 'Cannot map "%s" to an absolute path'),
   NodeInspectorFlagsNotSupportedError: createError(`${ERROR_PREFIX}_NODE_INSPECTOR_FLAGS_NOT_SUPPORTED`, 'The Node.js inspector flags are not supported. Please use \'platformatic start --inspect\' instead.')
-
 }

package/lib/generator/README.md

@@ -0,0 +1,32 @@
+# Platformatic Runtime API
+
+This is a generated [Platformatic Runtime](https://docs.platformatic.dev/docs/reference/runtime/introduction) 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
+```
+
+## Adding a Service
+
+Adding a new service to this project is as simple as running `create-platformatic` again, like so:
+
+```
+npx create-platformatic
+```

package/lib/generator/errors.js

@@ -6,5 +6,5 @@ const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
 
 module.exports = {
   NoServiceNamedError: createError(`${ERROR_PREFIX}_NO_SERVICE_FOUND`, 'No service named \'%s\' has been added to this runtime.'),
-  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been deinfed.')
+  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.')
 }

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

@@ -1,10 +1,8 @@
-'use strict'
-
-import { BaseGenerator, BaseGeneratorOptions } from "@platformatic/generators"
+import { BaseGenerator } from "@platformatic/generators"
 import { FileGenerator } from "@platformatic/generators/lib/file-generator"
 
 type Service = {
-  config: FileGenerator | BaseGenerator
+  config: FileGenerator.FileGenerator | BaseGenerator.BaseGenerator
 }
 type GeneratorMetadata = {
   targetDirectory: string
@@ -15,26 +13,25 @@ type KeyValue = {
   [key: string]: string
 }
 
-type RuntimeGeneratorOptions =  BaseGeneratorOptions & {
+type RuntimeGeneratorOptions =  BaseGenerator.BaseGeneratorOptions & {
   logLevel: string
 }
 
-class RuntimeGenerator extends BaseGenerator {
-  services: Service[]
-  entryPoint: Service
-  constructor(opts?: RuntimeGeneratorOptions)
-
-  async addService(service: Service, name: string): Promise<void>
-
-  setEntryPoint(entryPoint: string): void
-
-  setServicesDirectory(): void
-
-  setServicesConfig(configToOverride: object): void
-
-  getRuntimeEnv(): KeyValue
-  async writeServicesFiles(): Promise<GeneratorMetadata>
+export namespace RuntimeGenerator {
+  export class RuntimeGenerator extends BaseGenerator.BaseGenerator {
+    services: Service[]
+    entryPoint: Service
+    constructor(opts?: RuntimeGeneratorOptions)
+  
+    addService(service: Service, name: string): Promise<void>
+  
+    setEntryPoint(entryPoint: string): void
+  
+    setServicesDirectory(): void
+  
+    setServicesConfig(configToOverride: object): void
+  
+    getRuntimeEnv(): KeyValue
+    writeServicesFiles(): Promise<GeneratorMetadata>
+  }
 }
-
-export default RuntimeGenerator
-export { RuntimeGenerator }

package/lib/generator/runtime-generator.js

@@ -1,12 +1,18 @@
-'use strict'
 const { BaseGenerator } = require('@platformatic/generators')
 const { NoEntryPointError, NoServiceNamedError } = require('./errors')
 const generateName = require('boring-name-generator')
 const { join } = require('node:path')
 const { envObjectToString } = require('@platformatic/generators/lib/utils')
+const { readFile } = require('node:fs/promises')
+const { ConfigManager } = require('@platformatic/config')
+const { platformaticRuntime } = require('../config')
+
 class RuntimeGenerator extends BaseGenerator {
   constructor (opts) {
-    super(opts)
+    super({
+      ...opts,
+      module: '@platformatic/runtime'
+    })
     this.services = []
     this.entryPoint = null
   }
@@ -42,7 +48,7 @@ class RuntimeGenerator extends BaseGenerator {
   }
 
   async generatePackageJson () {
-    return {
+    const template = {
       scripts: {
         start: 'platformatic start',
         test: 'node --test test/*/*.test.js'
@@ -57,6 +63,13 @@ class RuntimeGenerator extends BaseGenerator {
         node: '^18.8.0 || >=20.6.0'
       }
     }
+    if (this.config.typescript) {
+      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', '..', 'package.json'), 'utf-8')).devDependencies.typescript
+      template.scripts.clean = 'rm -fr ./dist'
+      template.scripts.build = 'platformatic compile'
+      template.devDependencies.typescript = typescriptVersion
+    }
+    return template
   }
 
   async _beforePrepare () {
@@ -70,6 +83,40 @@ class RuntimeGenerator extends BaseGenerator {
     }
   }
 
+  async populateFromExistingConfig () {
+    if (this._hasCheckedForExistingConfig) {
+      return
+    }
+    this._hasCheckedForExistingConfig = true
+    const existingConfigFile = await ConfigManager.findConfigFile(this.targetDirectory, 'runtime')
+    if (existingConfigFile) {
+      const configManager = new ConfigManager({
+        ...platformaticRuntime.configManagerConfig,
+        source: join(this.targetDirectory, existingConfigFile)
+      })
+      await configManager.parse()
+      this.existingConfig = configManager.current
+      this.config.env = configManager.env
+      this.config.port = configManager.env.PORT
+      this.entryPoint = configManager.current.services.find((svc) => svc.entrypoint)
+    }
+  }
+
+  async prepare () {
+    await this.populateFromExistingConfig()
+    if (this.existingConfig) {
+      this.setServicesDirectory()
+      this.setServicesConfigValues()
+      await this._afterPrepare()
+      return {
+        env: this.config.env,
+        targetDirectory: this.targetDirectory
+      }
+    } else {
+      return await super.prepare()
+    }
+  }
+
   setServicesConfigValues () {
     this.services.forEach(({ service }) => {
       if (!service.config) {
@@ -119,6 +166,16 @@ class RuntimeGenerator extends BaseGenerator {
       contents: envObjectToString(this.config.env)
     })
 
+    this.addFile({
+      path: '',
+      file: '.env.sample',
+      contents: envObjectToString(this.config.env)
+    })
+
+    if (!this.existingConfig) {
+      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md')) })
+    }
+
     return {
       targetDirectory: this.targetDirectory,
       env: servicesEnv
@@ -132,6 +189,31 @@ class RuntimeGenerator extends BaseGenerator {
     }
   }
 
+  async prepareQuestions () {
+    await this.populateFromExistingConfig()
+
+    // typescript
+    this.questions.push({
+      type: 'list',
+      name: 'typescript',
+      message: 'Do you want to use TypeScript?',
+      default: false,
+      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+    })
+
+    if (this.existingConfig) {
+      return
+    }
+
+    // port
+    this.questions.push({
+      type: 'input',
+      name: 'port',
+      default: 3042,
+      message: 'What port do you want to use?'
+    })
+  }
+
   setServicesDirectory () {
     this.services.forEach(({ service }) => {
       if (!service.config) {
@@ -155,6 +237,11 @@ class RuntimeGenerator extends BaseGenerator {
   async prepareServiceFiles () {
     let servicesEnv = {}
     for (const svc of this.services) {
+      // Propagate TypeScript
+      svc.service.setConfig({
+        ...svc.service.config,
+        typescript: this.config.typescript
+      })
       const svcEnv = await svc.service.prepare()
       servicesEnv = {
         ...servicesEnv,
@@ -177,6 +264,12 @@ class RuntimeGenerator extends BaseGenerator {
       PORT: this.config.port
     }
   }
+
+  async postInstallActions () {
+    for (const { service } of this.services) {
+      await service.postInstallActions()
+    }
+  }
 }
 
 module.exports = RuntimeGenerator

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.13.1",
+  "version": "1.13.3",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -28,8 +28,8 @@
     "standard": "^17.1.0",
     "tsd": "^0.29.0",
     "typescript": "^5.2.2",
-    "@platformatic/sql-graphql": "1.13.1",
-    "@platformatic/sql-mapper": "1.13.1"
+    "@platformatic/sql-graphql": "1.13.3",
+    "@platformatic/sql-mapper": "1.13.3"
   },
   "dependencies": {
     "@fastify/error": "^3.4.0",
@@ -49,13 +49,13 @@
     "pino": "^8.16.0",
     "pino-pretty": "^10.2.3",
     "undici": "^5.26.3",
-    "@platformatic/composer": "1.13.1",
-    "@platformatic/generators": "1.13.1",
-    "@platformatic/db": "1.13.1",
-    "@platformatic/service": "1.13.1",
-    "@platformatic/config": "1.13.1",
-    "@platformatic/telemetry": "1.13.1",
-    "@platformatic/utils": "1.13.1"
+    "@platformatic/config": "1.13.3",
+    "@platformatic/db": "1.13.3",
+    "@platformatic/composer": "1.13.3",
+    "@platformatic/service": "1.13.3",
+    "@platformatic/telemetry": "1.13.3",
+    "@platformatic/utils": "1.13.3",
+    "@platformatic/generators": "1.13.3"
   },
   "standard": {
     "ignore": [