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

package/config.d.ts

@@ -114,6 +114,9 @@ export interface PlatformaticNextJsConfig {
   runtime?: {
     preload?: string | string[];
     basePath?: string;
+    services?: {
+      [k: string]: unknown;
+    }[];
     workers?: number | string;
     logger?: {
       level: (
@@ -201,7 +204,7 @@ export interface PlatformaticNextJsConfig {
     restartOnError?: boolean | number;
     gracefulShutdown?: {
       runtime: number | string;
-      service: number | string;
+      application: number | string;
     };
     health?: {
       enabled?: boolean | string;
@@ -320,11 +323,11 @@ export interface PlatformaticNextJsConfig {
     telemetry?: {
       enabled?: boolean | string;
       /**
-       * The name of the service. Defaults to the folder name if not specified.
+       * The name of the application. Defaults to the folder name if not specified.
        */
-      serviceName: string;
+      applicationName: string;
       /**
-       * The version of the service (optional)
+       * The version of the application (optional)
        */
       version?: string;
       /**
@@ -400,7 +403,7 @@ export interface PlatformaticNextJsConfig {
       watchDisabled?: boolean;
       [k: string]: unknown;
     };
-    serviceTimeout?: number | string;
+    applicationTimeout?: number | string;
     messagingTimeout?: number | string;
     env?: {
       [k: string]: string;

package/index.js

@@ -1,7 +1,7 @@
 import { transform as basicTransform, resolve, validationOptions } from '@platformatic/basic'
 import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platformatic/foundation'
+import { NextCapability } from './lib/capability.js'
 import { schema } from './lib/schema.js'
-import { NextStackable } from './lib/stackable.js'
 
 /* c8 ignore next 9 */
 export async function transform (config, schema, options) {
@@ -29,9 +29,9 @@ export async function loadConfiguration (configOrRoot, sourceOrConfig, context)
 
 export async function create (configOrRoot, sourceOrConfig, context) {
   const config = await loadConfiguration(configOrRoot, sourceOrConfig, context)
-  return new NextStackable(config[kMetadata].root, config, context)
+  return new NextCapability(config[kMetadata].root, config, context)
 }
 
 export * as cachingValkey from './lib/caching/valkey.js'
+export * from './lib/capability.js'
 export { packageJson, schema, schemaComponents, version } from './lib/schema.js'
-export * from './lib/stackable.js'

package/lib/caching/valkey.js

@@ -313,8 +313,8 @@ export class CacheHandler {
       pinoOptions.timestamp = buildPinoTimestamp(pinoOptions.timestamp)
     }
 
-    if (this.serviceId) {
-      pinoOptions.name = `cache:${this.serviceId}`
+    if (this.applicationId) {
+      pinoOptions.name = `cache:${this.applicationId}`
     }
 
     if (pinoOptions.base !== null && typeof globalThis.platformatic.workerId !== 'undefined') {
@@ -341,7 +341,7 @@ export class CacheHandler {
 
   #getPlatformaticMeta () {
     return {
-      serviceId: globalThis.platformatic.serviceId,
+      applicationId: globalThis.platformatic.applicationId,
       workerId: globalThis.platformatic.workerId
     }
   }

package/lib/{stackable.js → capability.js}

@@ -1,5 +1,5 @@
 import {
-  BaseStackable,
+  BaseCapability,
   ChildManager,
   cleanBasePath,
   createChildProcessListener,
@@ -19,7 +19,7 @@ import { version } from './schema.js'
 
 const supportedVersions = ['^14.0.0', '^15.0.0']
 
-export class NextStackable extends BaseStackable {
+export class NextCapability extends BaseCapability {
   #basePath
   #next
   #nextVersion
@@ -145,14 +145,14 @@ export class NextStackable extends BaseStackable {
   }
 
   getMeta () {
-    const composer = { prefix: this.basePath ?? this.#basePath, wantsAbsoluteUrls: true, needsRootTrailingSlash: false }
+    const gateway = { prefix: this.basePath ?? this.#basePath, wantsAbsoluteUrls: true, needsRootTrailingSlash: false }
 
     if (this.url) {
-      composer.tcp = true
-      composer.url = this.url
+      gateway.tcp = true
+      gateway.url = this.url
     }
 
-    return { composer }
+    return { gateway }
   }
 
   async #startDevelopment () {
@@ -241,7 +241,7 @@ export class NextStackable extends BaseStackable {
       loader: loaderUrl,
       context: {
         config: this.config,
-        serviceId: this.serviceId,
+        applicationId: this.applicationId,
         workerId: this.workerId,
         // Always use URL to avoid serialization problem in Windows
         root: pathToFileURL(this.root).toString(),

package/lib/create-context-patch.js

@@ -4,8 +4,8 @@ import { createRequire } from 'node:module'
 import { getGlobalDispatcher } from 'undici'
 
 // Next.js runs middlewares in it's own patched vm context. So the global dispatcher in
-// the middleware context is different from a service global dispatcher. This
-// method sets a service global dispatcher after next.js defines it's own version of
+// the middleware context is different from an application global dispatcher. This
+// method sets an application global dispatcher after next.js defines it's own version of
 // fetch function.
 export function patchVmCreateContext () {
   const _require = createRequire(process.cwd())

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@platformatic/next",
-  "version": "3.0.0-alpha.5",
-  "description": "Platformatic Next.js Stackable",
+  "version": "3.0.0-alpha.6",
+  "description": "Platformatic Next.js Capability",
   "main": "index.js",
   "type": "module",
   "repository": {
@@ -23,13 +23,13 @@
     "iovalkey": "^0.3.0",
     "msgpackr": "^1.11.2",
     "semver": "^7.6.3",
-    "@platformatic/basic": "3.0.0-alpha.5",
-    "@platformatic/foundation": "3.0.0-alpha.5"
+    "@platformatic/basic": "3.0.0-alpha.6",
+    "@platformatic/foundation": "3.0.0-alpha.6"
   },
   "devDependencies": {
     "@fastify/reply-from": "^12.0.0",
     "@types/node": "^22.5.0",
-    "borp": "^0.20.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "execa": "^9.5.1",
     "fastify": "^5.0.0",
@@ -38,15 +38,14 @@
     "next": "^15.0.0",
     "typescript": "^5.5.4",
     "ws": "^8.18.0",
-    "@platformatic/composer": "3.0.0-alpha.5",
-    "@platformatic/service": "3.0.0-alpha.5"
+    "@platformatic/gateway": "3.0.0-alpha.6",
+    "@platformatic/service": "3.0.0-alpha.6"
   },
   "engines": {
     "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "npm run lint && borp --concurrency=1 --timeout 1200000",
-    "coverage": "npm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout 1200000",
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
     "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",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/next/3.0.0-alpha.5.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/next/3.0.0-alpha.6.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Next.js Config",
   "type": "object",
@@ -386,6 +386,235 @@
         "basePath": {
           "type": "string"
         },
+        "services": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "anyOf": [
+              {
+                "required": [
+                  "id",
+                  "path"
+                ]
+              },
+              {
+                "required": [
+                  "id",
+                  "url"
+                ]
+              }
+            ],
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string",
+                "allowEmptyPaths": true,
+                "resolvePath": true
+              },
+              "config": {
+                "type": "string"
+              },
+              "url": {
+                "type": "string"
+              },
+              "gitBranch": {
+                "type": "string",
+                "default": "main"
+              },
+              "useHttp": {
+                "type": "boolean"
+              },
+              "workers": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "health": {
+                "type": "object",
+                "default": {},
+                "properties": {
+                  "enabled": {
+                    "anyOf": [
+                      {
+                        "type": "boolean"
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "interval": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "gracePeriod": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxUnhealthyChecks": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 1
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxELU": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxHeapUsed": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxHeapTotal": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxYoungGeneration": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  }
+                },
+                "additionalProperties": false
+              },
+              "arguments": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "env": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "envfile": {
+                "type": "string"
+              },
+              "sourceMaps": {
+                "type": "boolean",
+                "default": false
+              },
+              "packageManager": {
+                "type": "string",
+                "enum": [
+                  "npm",
+                  "pnpm",
+                  "yarn"
+                ]
+              },
+              "preload": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "resolvePath": true
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "resolvePath": true
+                    }
+                  }
+                ]
+              },
+              "nodeOptions": {
+                "type": "string"
+              },
+              "telemetry": {
+                "type": "object",
+                "properties": {
+                  "instrumentations": {
+                    "type": "array",
+                    "description": "An array of instrumentations loaded if telemetry is enabled",
+                    "items": {
+                      "oneOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "object",
+                          "properties": {
+                            "package": {
+                              "type": "string"
+                            },
+                            "exportName": {
+                              "type": "string"
+                            },
+                            "options": {
+                              "type": "object",
+                              "additionalProperties": true
+                            }
+                          },
+                          "required": [
+                            "package"
+                          ]
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
         "workers": {
           "anyOf": [
             {
@@ -700,7 +929,7 @@
               ],
               "default": 10000
             },
-            "service": {
+            "application": {
               "anyOf": [
                 {
                   "type": "number",
@@ -716,7 +945,7 @@
           "default": {},
           "required": [
             "runtime",
-            "service"
+            "application"
           ],
           "additionalProperties": false
         },
@@ -1147,13 +1376,13 @@
                 }
               ]
             },
-            "serviceName": {
+            "applicationName": {
               "type": "string",
-              "description": "The name of the service. Defaults to the folder name if not specified."
+              "description": "The name of the application. Defaults to the folder name if not specified."
             },
             "version": {
               "type": "string",
-              "description": "The version of the service (optional)"
+              "description": "The version of the application (optional)"
             },
             "skip": {
               "type": "array",
@@ -1260,7 +1489,7 @@
             }
           },
           "required": [
-            "serviceName"
+            "applicationName"
           ],
           "additionalProperties": false
         },
@@ -1281,7 +1510,7 @@
             }
           }
         },
-        "serviceTimeout": {
+        "applicationTimeout": {
           "anyOf": [
             {
               "type": "number",