@platformatic/generators 1.13.0 → 1.13.1

package/lib/base-generator.d.ts

@@ -1,6 +1,6 @@
 import { BaseLogger } from 'pino'
 import { FileGenerator } from './file-generator'
-
+import { PackageConfiguration } from './utils'
 export namespace BaseGenerator {
   export type BaseGeneratorOptions = FileGenerator.FileGeneratorOptions & {
     type?: 'service' | 'db' | 'composer'
@@ -24,6 +24,11 @@ export namespace BaseGenerator {
   type Dependency = {
     [key: string]: string
   }
+
+  type PackageDefinition = {
+    name: string,
+    options: PackageConfiguration
+  }
   type BaseGeneratorConfig = Record<string, any> & {
     port?: number
     hostname?: string
@@ -37,7 +42,7 @@ export namespace BaseGenerator {
     env?: KeyValue,
     isRuntimeContext?: boolean,
     serviceName?: string,
-    envPrefix?: string 
+    envPrefix?: string
   }
   
   type WhereClause = {
@@ -71,6 +76,7 @@ export namespace BaseGenerator {
     config: BaseGeneratorConfig
     questions: Array<object>
   
+    packages: PackageConfiguration[]
     constructor(opts?: BaseGeneratorOptions)
   
     setConfig(config?: BaseGeneratorConfig): void
@@ -82,6 +88,8 @@ export namespace BaseGenerator {
     getFastifyVersion(): Promise<string>
     getPlatformaticVersion(): Promise<string>
   
+    addPackage(pkg: PackageDefinition): void
+
     prepare(): Promise<GeneratorMetadata>
     run(): Promise<GeneratorMetadata>
     addQuestion(question: any, where?: WhereClause): Promise<void>

package/lib/base-generator.js

@@ -29,6 +29,7 @@ class BaseGenerator extends FileGenerator {
     this.inquirer = null
     this.targetDirectory = opts.targetDirectory || null
     this.config = this.getDefaultConfig()
+    this.packages = []
   }
 
   getDefaultConfig () {
@@ -415,6 +416,10 @@ class BaseGenerator extends FileGenerator {
     return metadata
   }
 
+  addPackage (pkg) {
+    this.packages.push(pkg)
+  }
+
   // implement in the subclass
   async _beforePrepare () {}
   async _afterPrepare () {}

package/lib/errors.js

@@ -7,5 +7,6 @@ const ERROR_PREFIX = 'PLT_GEN'
 module.exports = {
   NoQuestionsError: createError(`${ERROR_PREFIX}_NO_QUESTIONS_ERROR`, 'No questions added.'),
   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.')
+  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\'.')
 }

package/lib/utils.d.ts

@@ -2,6 +2,12 @@ type Env = {
   [key: string]: string
 }
 
+export type PackageConfiguration = {
+  type: 'number' | 'string' | 'boolean'
+  path: string
+  value: number | string | boolean
+}
+
 export namespace GeneratorUtils {
   export function safeMkdir(dir: string): Promise<void>
   export function stripVersion(version: string): string
@@ -9,4 +15,5 @@ export namespace GeneratorUtils {
   export function addPrefixToEnv(env: Env, prefix: string): Env
   export function envObjectToString(env: Env): string
   export function extractEnvVariablesFromText(text: string): string[]
+  export function getPackageConfigurationObject(config: PackageConfiguration[]): object
 }

package/lib/utils.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { mkdir } = require('node:fs/promises')
+const { WrongTypeError } = require('./errors')
 
 async function safeMkdir (dir) {
   try {
@@ -58,10 +59,41 @@ function extractEnvVariablesFromText (text) {
   }
   return []
 }
-
+function getPackageConfigurationObject (config) {
+  const output = {}
+  let current = output
+  for (const param of config) {
+    const props = param.path.split('.')
+    props.forEach((prop, idx) => {
+      if (idx === props.length - 1) {
+        switch (param.type) {
+          case 'string' :
+            current[prop] = param.value.toString()
+            break
+          case 'number':
+            current[prop] = parseInt(param.value)
+            break
+          case 'boolean':
+            current[prop] = (param.value === 'true')
+            break
+          default:
+            throw new WrongTypeError(param.type)
+        }
+        current = output
+      } else {
+        if (!current[prop]) {
+          current[prop] = {}
+        }
+        current = current[prop]
+      }
+    })
+  }
+  return output
+}
 module.exports = {
   addPrefixToEnv,
   convertServiceNameToPrefix,
+  getPackageConfigurationObject,
   envObjectToString,
   extractEnvVariablesFromText,
   safeMkdir,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],

package/test/base-generator.test.js

@@ -361,6 +361,25 @@ test('should throw if there is a missing env variable', async () => {
   }
 })
 
+test('should add package', async () => {
+  const bg = new BaseGenerator()
+
+  const packageDefinition = {
+    name: '@my/package',
+    options: [
+      {
+        path: 'foobar',
+        type: 'string',
+        value: 'foobar'
+      }
+    ]
+  }
+  bg.addPackage(packageDefinition)
+
+  assert.equal(bg.packages.length, 1)
+  assert.deepEqual(bg.packages[0], packageDefinition)
+})
+
 describe('runtime context', () => {
   test('should set config.envPrefix correctly', async (t) => {
     const bg = new BaseGenerator()

package/test/utils.test.js

@@ -2,8 +2,7 @@
 
 const { test, describe } = require('node:test')
 const assert = require('node:assert')
-const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, envObjectToString } = require('../lib/utils')
-const { extractEnvVariablesFromText } = require('../lib/utils')
+const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, envObjectToString, extractEnvVariablesFromText, getPackageConfigurationObject } = require('../lib/utils')
 
 describe('utils', () => {
   describe('stripVersion', async () => {
@@ -86,4 +85,67 @@ describe('utils', () => {
       assert.deepEqual(env, [])
     })
   })
+
+  describe('getPackageConfigurationObject', async () => {
+    const input = [
+      {
+        path: 'prefix',
+        value: '/foo',
+        type: 'string'
+      },
+      {
+        path: 'foo.fooOption1',
+        value: 'value1',
+        type: 'string'
+      },
+      {
+        path: 'foo.fooOption2',
+        value: 'value2',
+        type: 'string'
+      },
+      {
+        path: 'foobar',
+        value: '123',
+        type: 'number'
+      },
+      {
+        path: 'boolean.truthy',
+        value: 'true',
+        type: 'boolean'
+      },
+      {
+        path: 'boolean.falsey',
+        value: 'false',
+        type: 'boolean'
+      }
+    ]
+    const config = getPackageConfigurationObject(input)
+    assert.deepEqual(config, {
+      prefix: '/foo',
+      foo: {
+        fooOption1: 'value1',
+        fooOption2: 'value2'
+      },
+      foobar: 123,
+      boolean: {
+        truthy: true,
+        falsey: false
+      }
+    })
+
+    // should throw
+    try {
+      getPackageConfigurationObject([
+        {
+          path: 'wrong',
+          type: 'object',
+          value: {}
+        }
+      ])
+      assert.fail()
+    } catch (err) {
+      assert.equal(err.code, 'PLT_GEN_WRONG_TYPE')
+      assert.equal(err.message, 'Invalid value type. Accepted values are \'string\', \'number\' and \'boolean\', found \'object\'.')
+    }
+  })
 })