@platformatic/service 2.74.3 → 3.0.0-alpha.2

package/lib/utils.js

@@ -1,90 +1,9 @@
-'use strict'
+import { access, readFile, stat } from 'node:fs/promises'
+import { resolve } from 'node:path'
 
-const { access, readFile, stat } = require('node:fs/promises')
-const { resolve, join, relative, dirname, basename } = require('node:path')
-const { isatty } = require('tty')
-const { setPinoFormatters, setPinoTimestamp } = require('@platformatic/utils')
+let _isDocker
 
-async function isFileAccessible (filename, directory) {
-  try {
-    const filePath = directory ? resolve(directory, filename) : filename
-    await access(filePath)
-    return true
-  } catch (err) {
-    return false
-  }
-}
-
-/* c8 ignore start */
-function addLoggerToTheConfig (config) {
-  if (config.server?.loggerInstance) {
-    return
-  }
-
-  // We might have a config with no server
-  if (!config.server) {
-    config.server = {}
-  }
-
-  let logger = config.server.logger
-  if (!logger) {
-    config.server.logger = { level: 'info' }
-    logger = config.server.logger
-  }
-
-  // If TTY use pino-pretty
-  if (isatty(1)) {
-    if (!logger.transport) {
-      logger.transport = {
-        target: 'pino-pretty',
-      }
-    }
-  }
-
-  if (config.server.logger?.formatters) {
-    setPinoFormatters(config.server.logger)
-  }
-  if (config.server.logger?.timestamp) {
-    setPinoTimestamp(config.server.logger)
-  }
-}
-/* c8 ignore stop */
-
-function getJSPluginPath (workingDir, tsPluginPath, compileDir) {
-  if (tsPluginPath.endsWith('js')) {
-    return tsPluginPath
-  }
-
-  if (tsPluginPath.indexOf(compileDir) === 0) {
-    // In this case, we passed through this function before and we have adjusted
-    // the path of the plugin to point to the dist/ folder. Then we restarted.
-    // Therefore, we can just return the path as is.
-    return tsPluginPath
-  }
-
-  const isTs = tsPluginPath.endsWith('ts')
-  let newBaseName
-
-  // TODO: investigate why c8 does not see those
-  /* c8 ignore next 5 */
-  if (isTs) {
-    newBaseName = basename(tsPluginPath, '.ts') + '.js'
-  } else {
-    newBaseName = basename(tsPluginPath)
-  }
-
-  const tsPluginRelativePath = relative(workingDir, tsPluginPath)
-  const jsPluginRelativePath = join(
-    dirname(tsPluginRelativePath),
-    newBaseName
-  )
-
-  return join(compileDir, jsPluginRelativePath)
-}
-
-let isDockerCached
-
-async function isDocker () {
+export async function isDocker () {
   async function hasDockerEnv () {
     try {
       await stat('/.dockerenv')
@@ -102,16 +21,34 @@ async function isDocker () {
     }
   }
 
-  if (isDockerCached === undefined) {
-    isDockerCached = await hasDockerEnv() || await hasDockerCGroup()
+  if (_isDocker === undefined) {
+    _isDocker = (await hasDockerEnv()) || (await hasDockerCGroup())
   }
 
-  return isDockerCached
+  return _isDocker
 }
 
-module.exports = {
-  isDocker,
-  isFileAccessible,
-  getJSPluginPath,
-  addLoggerToTheConfig,
+export async function isFileAccessible (filename, directory) {
+  try {
+    const filePath = directory ? resolve(directory, filename) : filename
+    await access(filePath)
+    return true
+  } catch (err) {
+    return false
+  }
+}
+
+export async function sanitizeHTTPSArgument (arg) {
+  if (typeof arg === 'string') {
+    return arg
+  } else if (!Array.isArray(arg)) {
+    return readFile(arg.path)
+  }
+
+  const sanitized = []
+  for (const item of arg) {
+    sanitized.push(typeof item === 'string' ? item : await readFile(item.path))
+  }
+
+  return sanitized
 }

package/lib/versions/0.16.0.js

@@ -1,9 +1,6 @@
-'use strict'
-
-module.exports = {
+export default {
   version: '0.16.0',
-  toVersion: '0.17.0',
-  up: function (config) {
+  up (config) {
     let kind = 'service'
     // This file will be reused in platformatic/db
     if (config.core) {
@@ -13,18 +10,18 @@ module.exports = {
     if (config.plugin) {
       if (Array.isArray(config.plugin)) {
         config.plugins = {
-          paths: config.plugin.map((p) => {
+          paths: config.plugin.map(p => {
             if (typeof p === 'string') {
               return p
             } else if (p.options) {
               return {
                 path: p.path,
-                options: p.options,
+                options: p.options
               }
             } else {
               return p.path
             }
-          }),
+          })
         }
 
         if (typeof config.plugin[0] === 'object') {
@@ -41,14 +38,16 @@ module.exports = {
       } else if (typeof config.plugin === 'object') {
         if (config.plugin.options) {
           config.plugins = {
-            paths: [{
-              path: config.plugin.path,
-              options: config.plugin.options,
-            }],
+            paths: [
+              {
+                path: config.plugin.path,
+                options: config.plugin.options
+              }
+            ]
           }
         } else {
           config.plugins = {
-            paths: [config.plugin.path],
+            paths: [config.plugin.path]
           }
         }
 
@@ -66,7 +65,7 @@ module.exports = {
         }
       } else {
         config.plugins = {
-          paths: [config.plugin],
+          paths: [config.plugin]
         }
       }
 
@@ -78,5 +77,5 @@ module.exports = {
     config.$schema = 'https://platformatic.dev/schemas/v0.17.0/' + kind
 
     return config
-  },
+  }
 }

package/lib/versions/{from-zero-twenty-eight-to-will-see.js → 0.28.0.js}

@@ -1,14 +1,11 @@
-'use strict'
-
-module.exports.migration = {
+export default {
   version: '0.28.0',
-  toVersion: '1.99.0',
-  up: function (config) {
+  up (config) {
     if (config.watch !== false) {
       config.watch = typeof config.watch === 'object' ? config.watch : true
     }
     delete config.plugins?.watch
 
     return config
-  },
+  }
 }

package/lib/versions/2.0.0.js

@@ -1,11 +1,8 @@
-'use strict'
+import { version } from '../schema.js'
 
-const { version } = require('../../package.json')
-
-module.exports.migration = {
+export default {
   version: '2.0.0',
-  toVersion: version,
-  up: function (config) {
+  up (config) {
     if (typeof config.allowCycles === 'boolean') {
       delete config.allowCycles
     }
@@ -13,5 +10,5 @@ module.exports.migration = {
     config.$schema = `https://schemas.platformatic.dev/@platformatic/service/${version}.json`
 
     return config
-  },
+  }
 }

package/lib/versions/3.0.0.js

@@ -0,0 +1,14 @@
+export default {
+  version: '2.99.0',
+  up (config) {
+    if (typeof config.plugins?.typescript !== 'undefined') {
+      delete config.plugins.typescript
+    }
+
+    if (typeof config.clients !== 'undefined') {
+      delete config.clients
+    }
+
+    return config
+  }
+}

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@platformatic/service",
-  "version": "2.74.3",
+  "version": "3.0.0-alpha.2",
   "description": "",
   "main": "index.js",
-  "bin": {
-    "plt-service": "./service.mjs"
-  },
+  "types": "index.d.ts",
+  "type": "module",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "repository": {
     "type": "git",
@@ -28,8 +27,6 @@
     "pino-abstract-transport": "^2.0.0",
     "self-cert": "^2.0.0",
     "split2": "^4.2.0",
-    "strip-ansi": "^7.1.0",
-    "tsd": "^0.32.0",
     "typescript": "^5.5.4",
     "undici": "7.11.0",
     "vscode-json-languageservice": "^5.3.9",
@@ -39,29 +36,25 @@
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
     "@fastify/autoload": "^6.0.0",
-    "@fastify/basic-auth": "^6.0.0",
     "@fastify/cors": "^10.0.0",
     "@fastify/deepmerge": "^2.0.0",
     "@fastify/error": "^4.0.0",
     "@fastify/static": "^8.0.0",
     "@fastify/swagger": "^9.0.0",
     "@fastify/under-pressure": "^9.0.0",
-    "@scalar/fastify-api-reference": "1.32.1",
+    "@scalar/fastify-api-reference": "1.33.0",
+    "@types/node": "^22.10.6",
     "@types/ws": "^8.5.10",
     "ajv": "^8.12.0",
     "cli-progress": "^3.12.0",
     "close-with-grace": "^2.0.0",
     "code-block-writer": "^13.0.1",
     "colorette": "^2.0.20",
-    "commist": "^3.2.0",
     "console-table-printer": "^2.12.0",
-    "desm": "^1.3.1",
     "env-schema": "^6.0.0",
-    "es-main": "^1.3.0",
     "execa": "^9.0.0",
     "fast-json-patch": "^3.1.1",
     "fastify": "^5.0.0",
-    "fastify-metrics": "^12.0.0",
     "fastify-plugin": "^5.0.0",
     "graphql": "^16.9.0",
     "help-me": "^5.0.0",
@@ -69,27 +62,27 @@
     "minimist": "^1.2.8",
     "my-ua-parser": "^2.0.2",
     "ora": "^6.3.1",
-    "pino": "^9.0.0",
+    "pino": "^9.9.0",
     "pino-pretty": "^13.0.0",
-    "prom-client": "^15.1.2",
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.0",
-    "@platformatic/client": "2.74.3",
-    "@platformatic/metrics": "2.74.3",
-    "@platformatic/generators": "2.74.3",
-    "@platformatic/scalar-theme": "2.74.3",
-    "@platformatic/config": "2.74.3",
-    "@platformatic/telemetry": "2.74.3",
-    "@platformatic/utils": "2.74.3",
-    "@platformatic/ts-compiler": "2.74.3"
+    "@platformatic/basic": "3.0.0-alpha.2",
+    "@platformatic/generators": "3.0.0-alpha.2",
+    "@platformatic/metrics": "3.0.0-alpha.2",
+    "@platformatic/scalar-theme": "3.0.0-alpha.2",
+    "@platformatic/telemetry": "3.0.0-alpha.2",
+    "@platformatic/foundation": "3.0.0-alpha.2"
+  },
+  "engines": {
+    "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "pnpm run lint && borp -T --concurrency=1 --timeout=1200000 && tsd",
-    "unit": "borp --pattern 'test/**/*.test.{js,mjs}' --ignore 'fixtures/**/*' --concurrency=1 --timeout=1200000 --no-typescript",
+    "test": "pnpm run lint && borp --concurrency=1 --timeout 1200000 --no-typescript",
+    "coverage": "pnpm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout 1200000 --no-typescript",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
     "build": "pnpm run gen-schema && pnpm run gen-types",
-    "lint": "eslint && tsd"
+    "lint": "eslint"
   }
 }

package/schema.json

@@ -1,7 +1,7 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/service/2.74.3.json",
-  "version": "2.74.3",
-  "title": "Platformatic Service",
+  "$id": "https://schemas.platformatic.dev/@platformatic/service/3.0.0-alpha.2.json",
+  "version": "3.0.0-alpha.2",
+  "title": "Platformatic Service Config",
   "type": "object",
   "properties": {
     "basePath": {
@@ -629,45 +629,6 @@
               }
             ]
           }
-        },
-        "typescript": {
-          "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,
@@ -684,77 +645,6 @@
         }
       ]
     },
-    "metrics": {
-      "anyOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "port": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "hostname": {
-              "type": "string"
-            },
-            "endpoint": {
-              "type": "string"
-            },
-            "server": {
-              "type": "string",
-              "enum": [
-                "own",
-                "parent",
-                "hide"
-              ]
-            },
-            "defaultMetrics": {
-              "type": "object",
-              "properties": {
-                "enabled": {
-                  "type": "boolean"
-                }
-              },
-              "required": [
-                "enabled"
-              ],
-              "additionalProperties": false
-            },
-            "auth": {
-              "type": "object",
-              "properties": {
-                "username": {
-                  "type": "string"
-                },
-                "password": {
-                  "type": "string"
-                }
-              },
-              "additionalProperties": false,
-              "required": [
-                "username",
-                "password"
-              ]
-            },
-            "labels": {
-              "type": "object",
-              "additionalProperties": {
-                "type": "string"
-              }
-            }
-          },
-          "additionalProperties": false
-        }
-      ]
-    },
     "telemetry": {
       "type": "object",
       "properties": {
@@ -935,6 +825,13 @@
     "module": {
       "type": "string"
     },
+    "application": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "required": [],
+      "default": {}
+    },
     "service": {
       "type": "object",
       "properties": {
@@ -1096,48 +993,6 @@
       },
       "additionalProperties": false
     },
-    "clients": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "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"
-          },
-          "fullResponse": {
-            "type": "boolean"
-          },
-          "fullRequest": {
-            "type": "boolean"
-          },
-          "validateResponse": {
-            "type": "boolean"
-          }
-        },
-        "additionalProperties": false
-      }
-    },
     "runtime": {
       "type": "object",
       "properties": {

package/tsconfig.json

@@ -1,12 +1,22 @@
 {
   "compilerOptions": {
-    "module": "CommonJS",
-    "moduleResolution": "node",
+    "module": "esnext",
     "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "target": "es2019",
-    "outDir": "build",
+    "lib": ["es2022"],
+    "target": "esnext",
     "sourceMap": true,
-    "strictNullChecks": true
+    "pretty": true,
+    "noEmitOnError": true,
+    "incremental": true,
+    "strict": true,
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": ["**/node_modules", "dist"]
   }
 }

package/.c8rc

@@ -1,6 +0,0 @@
-{
-  "exclude": [
-    "fixtures/*",
-    "test/*"
-  ]
-}

package/help/compile.txt

@@ -1,19 +0,0 @@
-Compile typescript plugins.
-
-``` bash
-  $ platformatic service compile
-```
-
-As a result of executing this command, Platformatic Service will compile typescript
-plugins in the `outDir` directory. 
-
-Using the  `--clean` flag, the outDir directory will be removed before the new compilation process starts.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/service/configuration)

package/help/create.txt

@@ -1,11 +0,0 @@
-Creates a new Platformatic Service application.
-
-Options are
-
-* `dir <string>` - the directory where to create the project (Default: `process.cwd() + 'platformatic-composer'`)
-* `port <string>` - the port where the application will listen (Default: `3042`)
-* `hostname <string>` - the hostname where the application will listen (Default: `0.0.0.0`)
-* `git <boolean>` - Init the git repository (Default: `true`)
-* `typescript <boolean>` - Use Typescript (Default: `false`)
-* `install <boolean>` - Run or not `npm install` after creating the files (Default: `true`)
-* `plugin <boolean>` - Creates a sample plugin and tests (Default: `true`)

package/help/help.txt

@@ -1,8 +0,0 @@
-Available commands:
-
-* `create` - creates a new Platformatic Service application.
-* `help` - show this help message.
-* `help <command>` - show more information about a command.
-* `start` - start the server.
-* `schema config` - generate the schema configuration file.
-* `compile` - compile the typescript files.

package/help/schema.txt

@@ -1,9 +0,0 @@
-Update the config schema file:
-
-* `schema config` - update the JSON schema config available on `platformatic.json`
-
-Your configuration on `platformatic.json` has a schema defined to improve the developer experience and avoid mistakes when updating the configuration of Platformatic Service.
-When you initialize a new Platformatic service (f.e. running `npm create platformatic@latest`), a new JSON `$schema` property is added in the `platformatic.json` config. This can allow your IDE to add suggestions (f.e. mandatory/missing fields, types, default values) by opening the config in `platformatic.service.json`.
-Running `platformatic service schema config` you can update your schema so that it matches well the latest changes available on your config.
-
-

package/help/start.txt

@@ -1,23 +0,0 @@
-Start the Platformatic Service with the following command:
-
-``` bash
- $ platformatic service start
- ```
-
-You will need a  configuration file. Here is an example to get you started,
-save the following as `platformatic.json`:
-
-``` json
-{
-  "server": {
-    "hostname": "127.0.0.1",
-    "port": 0,
-    "logger": {
-      "level": "info"
-    }
-  },
-  "plugin": {
-    "path": "./plugin.js"
-  }
-}
-```