@platformatic/service 0.28.1 → 0.30.0

package/fixtures/hello-client-ts/tsconfig.json

@@ -2,9 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "esModuleInterop": true,
-    "target": "es6",
+    "target": "es2020",
     "moduleResolution": "node",
-    "sourceMap": true,
+    "sourceMap": false,
+    "incremental": true,
     "pretty": true,
     "noEmitOnError": true,
     "outDir": "dist"

package/fixtures/hello-client-ts-without-deps/hello.d.ts

@@ -0,0 +1,34 @@
+import { FastifyPluginAsync } from 'fastify'
+
+interface GetRequest {
+}
+
+interface GetResponse {
+}
+
+interface Hello {
+  get(req: GetRequest): Promise<GetResponse>;
+}
+
+type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    'hello': Hello;
+  }
+
+  interface FastifyRequest {
+    'hello': Hello;
+  }
+}
+
+declare namespace hello {
+  export interface HelloOptions {
+    url: string
+  }
+  export const hello: HelloPlugin;
+  export { hello as default };
+}
+
+declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
+export = hello;

package/fixtures/hello-client-ts-without-deps/hello.openapi.json

@@ -0,0 +1,22 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Platformatic",
+    "description": "This is a service built on top of Platformatic",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {}
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    }
+  }
+}

package/fixtures/hello-client-ts-without-deps/platformatic.service.json

@@ -0,0 +1,23 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "warn",
+      "name": "hello client ts"
+    },
+    "pluginTimeout": 30000
+  },
+  "plugins": {
+    "paths": ["./plugin.ts"],
+    "typescript": true
+  },
+  "clients": [{
+    "schema": "./hello.openapi.json",
+    "name": "hello",
+    "type": "openapi",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false,
+  "watch": false
+}

package/fixtures/hello-client-ts-without-deps/plugin.ts

@@ -0,0 +1,8 @@
+import { FastifyInstance } from 'fastify'
+/// <reference path="./hello" />
+
+export default async function (app: FastifyInstance) {
+  app.get('/', async () => {
+    return app.hello.get({})
+  })
+}

package/fixtures/hello-client-ts-without-deps/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "pretty": true,
+    "noEmitOnError": true,
+    "outDir": "dist"
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": [
+      "**/node_modules",
+      "dist"
+    ]
+  }
+}

package/fixtures/hello-client-without-deps/hello.d.ts

@@ -0,0 +1,34 @@
+import { FastifyPluginAsync } from 'fastify'
+
+interface GetRequest {
+}
+
+interface GetResponse {
+}
+
+interface Hello {
+  get(req: GetRequest): Promise<GetResponse>;
+}
+
+type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    'hello': Hello;
+  }
+
+  interface FastifyRequest {
+    'hello': Hello;
+  }
+}
+
+declare namespace hello {
+  export interface HelloOptions {
+    url: string
+  }
+  export const hello: HelloPlugin;
+  export { hello as default };
+}
+
+declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
+export = hello;

package/fixtures/hello-client-without-deps/hello.openapi.json

@@ -0,0 +1,22 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Platformatic",
+    "description": "This is a service built on top of Platformatic",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {}
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    }
+  }
+}

package/fixtures/hello-client-without-deps/platformatic.service.json

@@ -0,0 +1,21 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "warn",
+      "name": "hello client"
+    }
+  },
+  "plugins": {
+    "paths": ["./plugin.js"]
+  },
+  "clients": [{
+    "schema": "./hello.openapi.json",
+    "name": "hello",
+    "type": "openapi",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false,
+  "watch": false
+}

package/fixtures/hello-client-without-deps/plugin.js

@@ -0,0 +1,8 @@
+'use default'
+
+/**  @type {import('fastify').FastifyPluginAsync<{ optionA: boolean, optionB: string }>} */
+module.exports = async function (app) {
+  app.get('/', async () => {
+    return app.hello.get()
+  })
+}

package/help/compile.txt

@@ -1,9 +1,10 @@
 Compile typescript plugins.
+
 ``` bash
   $ platformatic service compile
 ```
 
-As a result of executing this command, the Platformatic DB will compile typescript
+As a result of executing this command, Platformatic Service will compile typescript
 plugins in the `outDir` directory. 
 
 If not specified, the configuration specified will be loaded from

package/index.js

@@ -46,7 +46,15 @@ async function platformaticService (app, opts, toLoad = []) {
   }
 
   if (config.plugins) {
-    if (config.plugins.typescript) {
+    let registerTsCompiler = false
+    const typescript = config.plugins.typescript
+    if (typescript === true) {
+      registerTsCompiler = true
+    } else if (typeof typescript === 'object') {
+      registerTsCompiler = typescript.enabled === true || typescript.enabled === undefined
+    }
+
+    if (registerTsCompiler) {
       await app.register(setupTsCompiler)
     }
     await app.register(loadPlugins)

package/lib/compile.js

@@ -48,29 +48,30 @@ async function setup (cwd, config, logger) {
   /* c8 ignore next 4 */
   if (tscExecutablePath === undefined) {
     const msg = 'The tsc executable was not found.'
-    logger.error(msg)
+    logger.warn(msg)
   }
 
-  const tsconfigPath = resolve(cwd, 'tsconfig.json')
-  const tsconfigExists = await isFileAccessible(tsconfigPath)
+  const tsConfigPath = config?.plugins?.typescript?.tsConfig || resolve(cwd, 'tsconfig.json')
+  const tsConfigExists = await isFileAccessible(tsConfigPath)
 
-  if (!tsconfigExists) {
-    const msg = 'The tsconfig.json file was not found.'
-    logger.error(msg)
+  if (!tsConfigExists) {
+    const msg = 'No typescript configuration file was found.'
+    logger.warn(msg)
   }
 
-  return { execa, logger, tscExecutablePath }
+  return { execa, logger, tscExecutablePath, tsConfigPath, tsConfigExists }
 }
 
 async function compile (cwd, config, originalLogger) {
-  const { execa, logger, tscExecutablePath } = await setup(cwd, config, originalLogger)
+  const { execa, logger, tscExecutablePath, tsConfigPath, tsConfigExists } = await setup(cwd, config, originalLogger)
   /* c8 ignore next 3 */
-  if (!tscExecutablePath) {
+  if (!tscExecutablePath || !tsConfigExists) {
     return false
   }
 
   try {
-    await execa(tscExecutablePath, ['--project', 'tsconfig.json', '--rootDir', '.'], { cwd })
+    const tsFlags = config?.plugins?.typescript?.flags || ['--project', tsConfigPath, '--rootDir', '.']
+    await execa(tscExecutablePath, tsFlags, { cwd })
     logger.info('Typescript compilation completed successfully.')
     return true
   } catch (error) {
@@ -82,11 +83,13 @@ async function compile (cwd, config, originalLogger) {
 function buildCompileCmd (app) {
   return async function compileCmd (_args) {
     let fullPath = null
+    let config = null
     try {
       const { configManager } = await loadConfig({}, _args, app, {
         watch: false
       })
       await configManager.parseAndValidate()
+      config = configManager.current
       fullPath = dirname(configManager.fullPath)
       /* c8 ignore next 4 */
     } catch (err) {
@@ -94,7 +97,7 @@ function buildCompileCmd (app) {
       process.exit(1)
     }
 
-    if (!await compile(fullPath)) {
+    if (!await compile(fullPath, config)) {
       process.exit(1)
     }
   }

package/lib/plugins/clients.js

@@ -1,11 +1,15 @@
 'use strict'
 
 const fp = require('fastify-plugin')
+const client = require('@platformatic/client')
 
 async function setupClients (app, opts) {
-  const clientsConfig = opts
-  for (const { path, url } of clientsConfig) {
-    app.register(require(path), { url })
+  for (const { path, url, serviceId, name, schema, type } of opts) {
+    if (path) {
+      app.register(require(path), { url, serviceId })
+    } else {
+      app.register(client, { url, serviceId, name, path: schema, type })
+    }
   }
 }
 

package/lib/plugins/plugins.js

@@ -12,18 +12,30 @@ async function loadPlugins (app) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
 
-  if (config.plugins.typescript) {
-    const workingDir = configManager.dirname
-    const tsConfigPath = join(workingDir, 'tsconfig.json')
+  let isOutDirAccessible = false
+  let outDir = null
 
-    const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
-    if (!isTsConfigAccessible) {
-      throw new Error('Cannot load typescript plugin, tsconfig.json not found')
-    }
+  const workingDir = configManager.dirname
+  const tsConfigPath = configManager.current.plugins.typescript?.tsConfig || join(workingDir, 'tsconfig.json')
 
+  // If the tsconfig.json file exists, then we need to adjust the plugin paths
+  // to point to the compiled JS files.
+  const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
+  if (isTsConfigAccessible) {
     const tsConfig = JSON.parse(await readFile(tsConfigPath, 'utf8'))
-    const outDir = resolve(workingDir, tsConfig.compilerOptions.outDir)
+    outDir = resolve(workingDir, tsConfig.compilerOptions.outDir)
+  }
+
+  /* c8 ignore next 3 */
+  if (configManager.current.plugins.typescript?.outDir) {
+    outDir = configManager.current.plugins.typescript.outDir
+  }
+
+  if (outDir) {
+    isOutDirAccessible = await isFileAccessible(outDir)
+  }
 
+  if (isOutDirAccessible) {
     config.plugins.paths = config.plugins.paths.map((plugin) => {
       /* c8 ignore next 3 */
       return typeof plugin === 'string'

package/lib/schema.js

@@ -390,7 +390,36 @@ const plugins = {
       type: 'integer'
     },
     typescript: {
-      type: 'boolean'
+      anyOf: [{
+        type: 'object',
+        properties: {
+          enabled: {
+            anyOf: [{
+              type: 'boolean'
+            }, {
+              type: 'string'
+            }]
+          },
+          tsConfig: {
+            type: 'string',
+            resolvePath: true
+          },
+          outDir: {
+            type: 'string',
+            resolvePath: true
+          },
+          flags: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          }
+        }
+      }, {
+        type: 'boolean'
+      }, {
+        type: 'string'
+      }]
     }
   },
   additionalProperties: false,
@@ -403,7 +432,12 @@ const metrics = {
     {
       type: 'object',
       properties: {
-        port: { type: 'integer' },
+        port: {
+          anyOf: [
+            { type: 'integer' },
+            { type: 'string' }
+          ]
+        },
         hostname: { type: 'string' },
         auth: {
           type: 'object',
@@ -515,16 +549,26 @@ const clients = {
       serviceId: {
         type: 'string'
       },
+      name: {
+        type: 'string'
+      },
+      type: {
+        type: 'string',
+        enum: ['openapi', 'graphql']
+      },
       path: {
         type: 'string',
         resolvePath: true
       },
+      schema: {
+        type: 'string',
+        resolvePath: true
+      },
       url: {
         type: 'string'
       }
     },
-    additionalProperties: false,
-    required: ['path', 'url']
+    additionalProperties: false
   }
 }
 
@@ -538,6 +582,8 @@ const platformaticServiceSchema = {
     watch: {
       anyOf: [watch, {
         type: 'boolean'
+      }, {
+        type: 'string'
       }]
     },
     $schema: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.28.1",
+  "version": "0.30.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -64,11 +64,11 @@
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.35",
-    "@platformatic/client": "0.28.1",
-    "@platformatic/config": "0.28.1",
-    "@platformatic/swagger-ui-theme": "0.28.1",
-    "@platformatic/types": "0.28.1",
-    "@platformatic/utils": "0.28.1"
+    "@platformatic/client": "0.30.0",
+    "@platformatic/config": "0.30.0",
+    "@platformatic/swagger-ui-theme": "0.30.0",
+    "@platformatic/types": "0.30.0",
+    "@platformatic/utils": "0.30.0"
   },
   "standard": {
     "ignore": [