@platformatic/generators 3.0.0-alpha.5 → 3.0.0-alpha.6

package/README.md

@@ -7,7 +7,7 @@ Generates a Platformatic app programmatically.
 The base class `BaseGenerator` is basically a file writer with some default behaviours.
 
 It should be instantiated with an `options` object having this properties
-- `type`: `"db" | "service" | "composer"`
+- `type`: `"db" | "service" | "gateway"`
 - `logger`: A pino-like logger object. If not provided a fake logger with no output will be used
 - `questions`: An array of custom questions object to provide to `inquirer`. Default to `[]`
 

package/eslint.config.js

@@ -1,3 +1,3 @@
-'use strict'
+import neostandard from 'neostandard'
 
-module.exports = require('neostandard')({ ts: true })
+export default neostandard({ ts: true })

package/index.js

@@ -1,11 +1,3 @@
-'use strict'
-
-const { BaseGenerator } = require('./lib/base-generator')
-const { ImportGenerator } = require('./lib/import-generator')
-const utils = require('./lib/utils')
-
-module.exports = {
-  BaseGenerator,
-  ImportGenerator,
-  ...utils
-}
+export { BaseGenerator } from './lib/base-generator.js'
+export { ImportGenerator } from './lib/import-generator.js'
+export * from './lib/utils.js'

package/lib/base-generator.d.ts

@@ -40,7 +40,7 @@ export namespace BaseGenerator {
     initGitRepository?: boolean
     env?: KeyValue,
     isRuntimeContext?: boolean,
-    serviceName?: string,
+    applicationName?: string,
     envPrefix?: string
   }
 

package/lib/base-generator.js

@@ -1,22 +1,21 @@
-'use strict'
-
-const { generateDashedName } = require('@platformatic/foundation')
-const { readFile } = require('node:fs/promises')
-const {
-  convertServiceNameToPrefix,
+import { generateDashedName } from '@platformatic/foundation'
+import { readFile } from 'node:fs/promises'
+import { join } from 'node:path'
+import { generateGitignore } from './create-gitignore.js'
+import { MissingEnvVariable, ModuleNeeded, PrepareError } from './errors.js'
+import { FileGenerator } from './file-generator.js'
+import {
+  convertApplicationNameToPrefix,
+  envStringToObject,
   extractEnvVariablesFromText,
+  flattenObject,
+  getApplicationTemplateFromSchemaUrl,
+  getLatestNpmVersion,
   getPackageConfigurationObject,
   PLT_ROOT,
-  getLatestNpmVersion,
   stripVersion
-} = require('./utils')
-const { join } = require('node:path')
-const { FileGenerator } = require('./file-generator')
-const { PrepareError, MissingEnvVariable, ModuleNeeded } = require('./errors')
-const { generateGitignore } = require('./create-gitignore')
-const { getServiceTemplateFromSchemaUrl } = require('./utils')
-const { flattenObject } = require('./utils')
-const { envStringToObject } = require('./utils')
+} from './utils.js'
+
 /* c8 ignore start */
 const fakeLogger = {
   info: () => {},
@@ -27,7 +26,7 @@ const fakeLogger = {
 }
 /* c8 ignore start */
 
-const DEFAULT_SERVICES_PATH = 'services'
+const DEFAULT_SERVICES_PATH = 'applications'
 
 class BaseGenerator extends FileGenerator {
   constructor (opts = {}) {
@@ -63,7 +62,7 @@ class BaseGenerator extends FileGenerator {
       dependencies: {},
       devDependencies: {},
       isRuntimeContext: false,
-      serviceName: '',
+      applicationName: '',
       envPrefix: '',
       env: {},
       defaultEnv: {},
@@ -150,12 +149,12 @@ class BaseGenerator extends FileGenerator {
     }
 
     if (this.config.isRuntimeContext) {
-      if (!this.config.serviceName) {
-        this.config.serviceName = generateDashedName()
+      if (!this.config.applicationName) {
+        this.config.applicationName = generateDashedName()
       }
       // set envPrefix
-      if (this.config.serviceName && !this.config.envPrefix) {
-        this.config.envPrefix = convertServiceNameToPrefix(this.config.serviceName)
+      if (this.config.applicationName && !this.config.envPrefix) {
+        this.config.envPrefix = convertApplicationNameToPrefix(this.config.applicationName)
       }
     }
     this.setEnvVars(this.config.env)
@@ -291,7 +290,10 @@ class BaseGenerator extends FileGenerator {
         contents.plugins = {}
       }
       contents.plugins.packages = this.packages.map(packageDefinition => {
-        const packageConfigOutput = getPackageConfigurationObject(packageDefinition.options, this.config.serviceName)
+        const packageConfigOutput = getPackageConfigurationObject(
+          packageDefinition.options,
+          this.config.applicationName
+        )
         if (Object.keys(packageConfigOutput.env).length > 0) {
           const envForPackages = {}
           Object.entries(packageConfigOutput.env).forEach(kv => {
@@ -323,7 +325,7 @@ class BaseGenerator extends FileGenerator {
     if (this.pkgData) {
       return this.pkgData
     }
-    const currentPackageJsonPath = join(__dirname, '..', 'package.json')
+    const currentPackageJsonPath = join(import.meta.dirname, '..', 'package.json')
     this.pkgData = JSON.parse(await readFile(currentPackageJsonPath, 'utf8'))
     return this.pkgData
   }
@@ -340,14 +342,13 @@ class BaseGenerator extends FileGenerator {
 
   async generatePackageJson () {
     const template = {
-      name: `${this.config.serviceName}`,
+      name: `${this.config.applicationName}`,
       scripts: {
         start: 'platformatic start',
-        test: 'borp'
+        test: 'node --test'
       },
       devDependencies: {
         fastify: `^${this.fastifyVersion}`,
-        borp: `${this.pkgData.devDependencies.borp}`,
         ...this.config.devDependencies
       },
       dependencies: {
@@ -359,7 +360,7 @@ class BaseGenerator extends FileGenerator {
     }
 
     if (this.config.typescript) {
-      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', 'package.json'), 'utf-8'))
+      const typescriptVersion = JSON.parse(await readFile(join(import.meta.dirname, '..', 'package.json'), 'utf-8'))
         .devDependencies.typescript
       template.devDependencies.typescript = typescriptVersion
     }
@@ -417,17 +418,17 @@ class BaseGenerator extends FileGenerator {
     this.packages.push(pkg)
   }
 
-  async loadFromDir (serviceName, runtimeRootPath) {
+  async loadFromDir (applicationName, runtimeRootPath) {
     const runtimePkgConfigFileData = JSON.parse(await readFile(join(runtimeRootPath, this.runtimeConfig), 'utf-8'))
-    const servicesPath = runtimePkgConfigFileData.autoload?.path ?? DEFAULT_SERVICES_PATH
-    const servicePkgJsonFileData = JSON.parse(
-      await readFile(join(runtimeRootPath, servicesPath, serviceName, 'platformatic.json'), 'utf-8')
+    const applicationsPath = runtimePkgConfigFileData.autoload?.path ?? DEFAULT_SERVICES_PATH
+    const applicationPkgJsonFileData = JSON.parse(
+      await readFile(join(runtimeRootPath, applicationsPath, applicationName, 'platformatic.json'), 'utf-8')
     )
     const runtimeEnv = envStringToObject(await readFile(join(runtimeRootPath, '.env'), 'utf-8'))
-    const serviceNamePrefix = convertServiceNameToPrefix(serviceName)
+    const applicationNamePrefix = convertApplicationNameToPrefix(applicationName)
     const plugins = []
-    if (servicePkgJsonFileData.plugins && servicePkgJsonFileData.plugins.packages) {
-      for (const pkg of servicePkgJsonFileData.plugins.packages) {
+    if (applicationPkgJsonFileData.plugins && applicationPkgJsonFileData.plugins.packages) {
+      for (const pkg of applicationPkgJsonFileData.plugins.packages) {
         const flattened = flattenObject(pkg)
         const output = {
           name: flattened.name,
@@ -438,9 +439,9 @@ class BaseGenerator extends FileGenerator {
             .filter(([key, value]) => key.indexOf('options.') === 0 && flattened[key].startsWith('{PLT_'))
             .forEach(([key, value]) => {
               const runtimeEnvVarKey = value.replace(/[{}]/g, '')
-              const serviceEnvVarKey = runtimeEnvVarKey.replace(`PLT_${serviceNamePrefix}_`, '')
+              const applicationEnvVarKey = runtimeEnvVarKey.replace(`PLT_${applicationNamePrefix}_`, '')
               const option = {
-                name: serviceEnvVarKey,
+                name: applicationEnvVarKey,
                 path: key.replace('options.', ''),
                 type: 'string',
                 value: runtimeEnv[runtimeEnvVarKey]
@@ -454,8 +455,8 @@ class BaseGenerator extends FileGenerator {
     }
 
     return {
-      name: serviceName,
-      template: getServiceTemplateFromSchemaUrl(servicePkgJsonFileData.$schema),
+      name: applicationName,
+      template: getApplicationTemplateFromSchemaUrl(applicationPkgJsonFileData.$schema),
       fields: [],
       plugins
     }
@@ -480,5 +481,6 @@ function serializeEnvVars (envVars) {
   return envVarsString
 }
 
-module.exports = BaseGenerator
-module.exports.BaseGenerator = BaseGenerator
+export default BaseGenerator
+const _BaseGenerator = BaseGenerator
+export { _BaseGenerator as BaseGenerator }

package/lib/create-gitignore.js

@@ -1,5 +1,3 @@
-'use strict'
-
 const gitignore = `\
 dist
 .DS_Store
@@ -29,14 +27,11 @@ tags
 # clinicjs
 .clinic/
 `
-function generateGitignore () {
+
+export function generateGitignore () {
   return {
     path: '',
     file: '.gitignore',
-    contents: gitignore,
+    contents: gitignore
   }
 }
-
-module.exports = {
-  generateGitignore,
-}

package/lib/errors.js

@@ -1,12 +1,17 @@
-'use strict'
+import createError from '@fastify/error'
 
-const createError = require('@fastify/error')
+export const ERROR_PREFIX = 'PLT_GEN'
 
-const ERROR_PREFIX = 'PLT_GEN'
-
-module.exports = {
-  ModuleNeeded: createError(`${ERROR_PREFIX}_PREPARE_ERROR`, 'The module which the package will be published to must be specified'),
-  PrepareError: createError(`${ERROR_PREFIX}_PREPARE_ERROR`, 'Error while generating the files: %s.'),
-  MissingEnvVariable: createError(`${ERROR_PREFIX}_MISSING_ENV_VAR`, 'Env variable %s is defined in config file %s, but not in config.env object.'),
-  WrongTypeError: createError(`${ERROR_PREFIX}_WRONG_TYPE`, 'Invalid value type. Accepted values are \'string\', \'number\' and \'boolean\', found \'%s\'.'),
-}
+export const ModuleNeeded = createError(
+  `${ERROR_PREFIX}_PREPARE_ERROR`,
+  'The module which the package will be published to must be specified'
+)
+export const PrepareError = createError(`${ERROR_PREFIX}_PREPARE_ERROR`, 'Error while generating the files: %s.')
+export const MissingEnvVariable = createError(
+  `${ERROR_PREFIX}_MISSING_ENV_VAR`,
+  'Env variable %s is defined in config file %s, but not in config.env object.'
+)
+export const WrongTypeError = createError(
+  `${ERROR_PREFIX}_WRONG_TYPE`,
+  "Invalid value type. Accepted values are 'string', 'number' and 'boolean', found '%s'."
+)

package/lib/file-generator.js

@@ -1,7 +1,6 @@
-'use strict'
-const { createDirectory } = require('@platformatic/foundation')
-const { dirname, join, isAbsolute } = require('node:path')
-const { writeFile, readFile } = require('node:fs/promises')
+import { createDirectory } from '@platformatic/foundation'
+import { readFile, writeFile } from 'node:fs/promises'
+import { dirname, isAbsolute, join } from 'node:path'
 
 /* c8 ignore start */
 const fakeLogger = {
@@ -13,7 +12,7 @@ const fakeLogger = {
 }
 /* c8 ignore start */
 
-class FileGenerator {
+export class FileGenerator {
   constructor (opts = {}) {
     this.files = []
     this.logger = opts.logger || fakeLogger
@@ -99,6 +98,3 @@ class FileGenerator {
     this.files = []
   }
 }
-
-module.exports = FileGenerator
-module.exports.FileGenerator = FileGenerator

package/lib/import-generator.js

@@ -1,20 +1,18 @@
-'use strict'
+import { findConfigurationFileRecursive, safeRemove } from '@platformatic/foundation'
+import { spawnSync } from 'node:child_process'
+import { readFile, readdir, stat } from 'node:fs/promises'
+import { dirname, join, relative, resolve } from 'node:path'
+import { BaseGenerator } from './base-generator.js'
 
-const { safeRemove, findConfigurationFileRecursive } = require('@platformatic/foundation')
-const { BaseGenerator } = require('./base-generator')
-const { spawnSync } = require('node:child_process')
-const { stat, readFile, readdir } = require('node:fs/promises')
-const { join, dirname, resolve, relative } = require('node:path')
-
-class ImportGenerator extends BaseGenerator {
+export class ImportGenerator extends BaseGenerator {
   constructor (options = {}) {
-    const { serviceName, module, version, parent: runtime, ...opts } = options
+    const { applicationName, module, version, parent: runtime, ...opts } = options
     super({ ...opts, module })
 
     this.runtime = runtime
     this.setConfig({
-      serviceName,
-      servicePathEnvName: `PLT_SERVICE_${serviceName.toUpperCase().replaceAll(/[^A-Z0-9_]/g, '_')}_PATH`,
+      applicationName,
+      applicationPathEnvName: `PLT_APPLICATION_${applicationName.toUpperCase().replaceAll(/[^A-Z0-9_]/g, '_')}_PATH`,
       module,
       version
     })
@@ -83,9 +81,9 @@ class ImportGenerator extends BaseGenerator {
   }
 
   async _afterWriteFiles (runtime) {
-    // No need for an empty folder in the services folder
+    // No need for an empty folder in the applications folder
     if (this.config.operation === 'import') {
-      await safeRemove(join(runtime.servicesBasePath, this.config.serviceName))
+      await safeRemove(join(runtime.applicationsBasePath, this.config.applicationName))
     }
   }
 
@@ -168,9 +166,9 @@ class ImportGenerator extends BaseGenerator {
     /* c8 ignore next - else */
     let env = envObject?.contents ?? ''
 
-    // Find which key is being used for the manual services
+    // Find which key is being used for the manual applications
     let key
-    for (const candidate of new Set([runtime.servicesFolder, 'web', 'services'])) {
+    for (const candidate of new Set([runtime.applicationsFolder, 'applications', 'services', 'web'])) {
       if (Array.isArray(config[candidate])) {
         key = candidate
         break
@@ -178,23 +176,23 @@ class ImportGenerator extends BaseGenerator {
     }
 
     /* c8 ignore next - else */
-    key ??= runtime.servicesFolder ?? 'services'
-    const services = config[key] ?? []
+    key ??= runtime.applicationsFolder ?? 'applications'
+    const applications = config[key] ?? []
 
-    if (!services.some(service => service.id === this.config.serviceName)) {
-      services.push({
-        id: this.config.serviceName,
-        path: `{${this.config.servicePathEnvName}}`,
+    if (!applications.some(application => application.id === this.config.applicationName)) {
+      applications.push({
+        id: this.config.applicationName,
+        path: `{${this.config.applicationPathEnvName}}`,
         url: this.config.gitUrl
       })
     }
 
-    config[key] = services
+    config[key] = applications
 
     if (env.length > 0) {
       env += '\n'
     }
-    env += `${this.config.servicePathEnvName}=${this.config.applicationPath}`
+    env += `${this.config.applicationPathEnvName}=${this.config.applicationPath}`
 
     runtime.updateRuntimeConfig(config)
     runtime.updateRuntimeEnv(env)
@@ -228,5 +226,3 @@ class ImportGenerator extends BaseGenerator {
     }
   }
 }
-
-module.exports = { ImportGenerator }

package/lib/utils.d.ts

@@ -10,12 +10,13 @@ export type PackageConfiguration = {
 
 export namespace GeneratorUtils {
   export function stripVersion (version: string): string
-  export function convertServiceNameToPrefix (serviceName: string): string
+  export function convertApplicationNameToPrefix (applicationName: string): string
+  export function addPrefixToServiceName (applicationName: string, prefix: string): string
   export function envObjectToString (env: Env): string
   export function envStringToObject (env: string): Env
   export function extractEnvVariablesFromText (text: string): string[]
   export function getPackageConfigurationObject (config: PackageConfiguration[]): object
   export function flattenObject (obj: object): object
-  export function getServiceTemplateFromSchemaUrl (schemaUrl: string): string
+  export function getApplicationTemplateFromSchemaUrl (schemaUrl: string): string
   export const PLT_ROOT: string
 }

package/lib/utils.js

@@ -1,19 +1,17 @@
-'use strict'
+import { EOL } from 'node:os'
+import { join } from 'node:path'
+import { setTimeout } from 'timers/promises'
+import { request } from 'undici'
+import { WrongTypeError } from './errors.js'
 
-const { WrongTypeError } = require('./errors')
-const { join } = require('node:path')
-const { request } = require('undici')
-const { setTimeout } = require('timers/promises')
-const PLT_ROOT = 'PLT_ROOT'
-const { EOL } = require('node:os')
-const { createDirectory } = require('@platformatic/foundation')
+export const PLT_ROOT = 'PLT_ROOT'
 
 /**
  * Strip all extra characters from a simple semver version string
  * @param {string} version
  * @returns string
  */
-function stripVersion (version) {
+export function stripVersion (version) {
   const match = version.match(/(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)/)
   if (match) {
     return match[0]
@@ -22,11 +20,11 @@ function stripVersion (version) {
   return version
 }
 
-function convertServiceNameToPrefix (serviceName) {
-  return serviceName.replace(/-/g, '_').toUpperCase()
+export function convertApplicationNameToPrefix (applicationName) {
+  return applicationName.replace(/-/g, '_').toUpperCase()
 }
 
-function addPrefixToString (input, prefix) {
+export function addPrefixToString (input, prefix) {
   if (!prefix) {
     return input
   }
@@ -40,7 +38,7 @@ function addPrefixToString (input, prefix) {
   }
 }
 
-function envObjectToString (env) {
+export function envObjectToString (env) {
   const output = []
   Object.entries(env).forEach(kv => {
     output.push(`${kv[0]}=${kv[1]}`)
@@ -48,7 +46,7 @@ function envObjectToString (env) {
   return output.join(EOL)
 }
 
-function envStringToObject (envString) {
+export function envStringToObject (envString) {
   const output = {}
   const split = envString.split(/\r?\n/)
   split
@@ -61,14 +59,16 @@ function envStringToObject (envString) {
     })
   return output
 }
-function extractEnvVariablesFromText (text) {
+
+export function extractEnvVariablesFromText (text) {
   const match = text.match(/\{[a-zA-Z0-9-_]*\}/g)
   if (match) {
     return match.map(found => found.replace('{', '').replace('}', '')).filter(found => found !== '')
   }
   return []
 }
-function getPackageConfigurationObject (config, serviceName = '') {
+
+export function getPackageConfigurationObject (config, applicationName = '') {
   const output = {
     config: {},
     env: {}
@@ -100,7 +100,7 @@ function getPackageConfigurationObject (config, serviceName = '') {
         if (!param.name) {
           current[prop] = value
         } else {
-          const key = addPrefixToString(param.name, convertServiceNameToPrefix(serviceName))
+          const key = addPrefixToString(param.name, convertApplicationNameToPrefix(applicationName))
           // If it's a path, we need to add it to the env only the relative part of the path
           if (isPath) {
             current[prop] = `${join(`{${PLT_ROOT}}`, `{${key}}`)}`
@@ -122,7 +122,7 @@ function getPackageConfigurationObject (config, serviceName = '') {
   return output
 }
 
-async function getLatestNpmVersion (pkg) {
+export async function getLatestNpmVersion (pkg) {
   const npmCall = request(`https://registry.npmjs.org/${pkg}`)
   const timeout = setTimeout(1000, null)
   const res = await Promise.race([npmCall, timeout])
@@ -136,6 +136,7 @@ async function getLatestNpmVersion (pkg) {
   }
   return null
 }
+
 /**
  * Flatten a deep-nested object to a single level depth one
  * i.e from
@@ -155,7 +156,7 @@ async function getLatestNpmVersion (pkg) {
  * @param {Object} ob
  * @returns Object
  */
-function flattenObject (ob) {
+export function flattenObject (ob) {
   const result = {}
   for (const i in ob) {
     if (typeof ob[i] === 'object' && !Array.isArray(ob[i])) {
@@ -170,7 +171,7 @@ function flattenObject (ob) {
   return result
 }
 
-function getServiceTemplateFromSchemaUrl (schemaUrl) {
+export function getApplicationTemplateFromSchemaUrl (schemaUrl) {
   const splitted = schemaUrl.split('/')
 
   /* c8 ignore next 3 - Legacy interface */
@@ -179,18 +180,3 @@ function getServiceTemplateFromSchemaUrl (schemaUrl) {
   }
   return `@platformatic/${splitted[splitted.length - 2]}`
 }
-
-module.exports = {
-  addPrefixToString,
-  convertServiceNameToPrefix,
-  getPackageConfigurationObject,
-  envObjectToString,
-  envStringToObject,
-  extractEnvVariablesFromText,
-  flattenObject,
-  getServiceTemplateFromSchemaUrl,
-  createDirectory,
-  stripVersion,
-  PLT_ROOT,
-  getLatestNpmVersion
-}

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@platformatic/generators",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.6",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
+  "type": "module",
+  "types": "index.d.ts",
   "keywords": [],
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "license": "Apache-2.0",
@@ -13,12 +15,12 @@
     "fastify": "^5.0.0",
     "pino": "^9.9.0",
     "undici": "^7.0.0",
-    "@platformatic/foundation": "3.0.0-alpha.5"
+    "@platformatic/foundation": "3.0.0-alpha.6"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
-    "borp": "^0.20.0",
     "c8": "^10.0.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "neostandard": "^0.12.0",
     "tsd": "^0.32.0",
@@ -29,6 +31,7 @@
   },
   "scripts": {
     "lint": "eslint",
-    "test": "pnpm run lint && borp --timeout=1200000 -C -X fixtures -X test --concurrency=1 && tsd"
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "posttest": "tsd"
   }
 }