@platformatic/db 3.0.0-alpha.5 → 3.0.0-alpha.8

package/config.d.ts

@@ -404,11 +404,11 @@ export interface PlatformaticDatabaseConfig {
   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;
     /**
@@ -480,6 +480,9 @@ export interface PlatformaticDatabaseConfig {
   runtime?: {
     preload?: string | string[];
     basePath?: string;
+    services?: {
+      [k: string]: unknown;
+    }[];
     workers?: number | string;
     logger?: {
       level: (
@@ -567,7 +570,7 @@ export interface PlatformaticDatabaseConfig {
     restartOnError?: boolean | number;
     gracefulShutdown?: {
       runtime: number | string;
-      service: number | string;
+      application: number | string;
     };
     health?: {
       enabled?: boolean | string;
@@ -686,11 +689,11 @@ export interface PlatformaticDatabaseConfig {
     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;
       /**
@@ -766,7 +769,7 @@ export interface PlatformaticDatabaseConfig {
       watchDisabled?: boolean;
       [k: string]: unknown;
     };
-    serviceTimeout?: number | string;
+    applicationTimeout?: number | string;
     messagingTimeout?: number | string;
     env?: {
       [k: string]: string;

package/index.d.ts

@@ -1,7 +1,7 @@
 import { DBAuthorizationPluginInterface } from '@platformatic/db-authorization'
 import { Configuration, ConfigurationOptions } from '@platformatic/foundation'
 import { BaseGenerator } from '@platformatic/generators'
-import { PlatformaticApplication, ServiceStackable } from '@platformatic/service'
+import { PlatformaticApplication, ServiceCapability } from '@platformatic/service'
 import { SQLEventsPluginInterface } from '@platformatic/sql-events'
 import { Entities, SQLMapperPluginInterface } from '@platformatic/sql-mapper'
 import { JSONSchemaType } from 'ajv'
@@ -16,7 +16,7 @@ export type PlatformaticDatabaseMixin<T extends Entities> = SQLMapperPluginInter
   SQLEventsPluginInterface &
   DBAuthorizationPluginInterface
 
-export type DatabaseStackable = ServiceStackable<PlatformaticDatabaseConfig>
+export type DatabaseCapability = ServiceCapability<PlatformaticDatabaseConfig>
 
 export type ServerInstance<T = {}> = FastifyInstance & {
   platformatic: PlatformaticApplication<PlatformaticDatabaseConfig> & PlatformaticDatabaseMixin<Entities> & T
@@ -38,11 +38,11 @@ export declare function create (
   root: string,
   source?: string | PlatformaticDatabaseConfig,
   context?: ConfigurationOptions
-): Promise<ServiceStackable>
+): Promise<ServiceCapability>
 
 export declare const skipTelemetryHooks: boolean
 
-export declare function platformaticDatabase (app: FastifyInstance, stackable: DatabaseStackable): Promise<void>
+export declare function platformaticDatabase (app: FastifyInstance, capability: DatabaseCapability): Promise<void>
 
 export declare class Generator extends BaseGenerator.BaseGenerator {}
 

package/index.js

@@ -3,8 +3,8 @@ import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platfor
 import { transform as serviceTransform } from '@platformatic/service'
 import { readFile } from 'node:fs/promises'
 import { resolve as resolvePath } from 'node:path'
+import { DatabaseCapability } from './lib/capability.js'
 import { schema } from './lib/schema.js'
-import { DatabaseStackable } from './lib/stackable.js'
 import { upgrade } from './lib/upgrade.js'
 
 export async function transform (config) {
@@ -71,15 +71,15 @@ export async function loadConfiguration (configOrRoot, sourceOrConfig, context)
 
 export async function create (configOrRoot, sourceOrConfig, context) {
   const config = await loadConfiguration(configOrRoot, sourceOrConfig, context)
-  return new DatabaseStackable(config[kMetadata].root, config, context)
+  return new DatabaseCapability(config[kMetadata].root, config, context)
 }
 
 export const skipTelemetryHooks = true
 
 export { platformaticDatabase } from './lib/application.js'
+export { DatabaseCapability } from './lib/capability.js'
 export * from './lib/commands/index.js'
 export * from './lib/errors.js'
 export * as errors from './lib/errors.js'
 export { Generator } from './lib/generator.js'
 export { packageJson, schema, schemaComponents, version } from './lib/schema.js'
-export { DatabaseStackable } from './lib/stackable.js'

package/lib/application.js

@@ -19,8 +19,8 @@ async function healthCheck (app) {
   }
 }
 
-export async function platformaticDatabase (app, stackable) {
-  const config = await stackable.getConfig(true)
+export async function platformaticDatabase (app, capability) {
+  const config = await capability.getConfig(true)
 
   let createSchemaLock = false
   await loadSchemaLock()
@@ -66,7 +66,7 @@ export async function platformaticDatabase (app, stackable) {
     }
 
     serverConfig.healthCheck.fn = healthCheck
-    await stackable.updateContext({ serverConfig })
+    await capability.updateContext({ serverConfig })
   }
 
   if (createSchemaLock) {
@@ -85,7 +85,7 @@ export async function platformaticDatabase (app, stackable) {
     await app.register(auth, config.authorization)
   }
 
-  await platformaticService(app, stackable)
+  await platformaticService(app, capability)
 
   if (Object.keys(app.platformatic.entities).length === 0) {
     app.log.warn(

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

@@ -1,8 +1,8 @@
-import { ServiceStackable } from '@platformatic/service'
+import { ServiceCapability } from '@platformatic/service'
 import { platformaticDatabase } from './application.js'
 import { packageJson } from './schema.js'
 
-export class DatabaseStackable extends ServiceStackable {
+export class DatabaseCapability extends ServiceCapability {
   constructor (root, config, context) {
     super(root, config, context)
     this.type = 'db'
@@ -20,16 +20,16 @@ export class DatabaseStackable extends ServiceStackable {
   }
 
   async getMeta () {
-    const serviceMeta = await super.getMeta()
+    const applicationMeta = await super.getMeta()
     const connectionString = this.config.db?.connectionString
 
     if (connectionString) {
       return {
-        ...serviceMeta,
+        ...applicationMeta,
         connectionStrings: [connectionString]
       }
     }
 
-    return serviceMeta
+    return applicationMeta
   }
 }

package/lib/errors.js

@@ -1,6 +1,6 @@
 import createError from '@fastify/error'
 
-const ERROR_PREFIX = 'PLT_DB'
+export const ERROR_PREFIX = 'PLT_DB'
 
 export const MigrateMissingMigrationsError = createError(
   `${ERROR_PREFIX}_MIGRATE_ERROR`,

package/lib/generator.js

@@ -195,7 +195,7 @@ export class Generator extends ServiceGenerator {
 
   async _getConfigFileContents () {
     const config = await super._getConfigFileContents()
-    delete config.service
+    delete config.application
     config.$schema = `https://schemas.platformatic.dev/@platformatic/db/${this.platformaticVersion}.json`
 
     config.db = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/db",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.8",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,8 +21,8 @@
     "@opentelemetry/api": "^1.9.0",
     "ajv": "^8.12.0",
     "bindings": "^1.5.0",
-    "borp": "^0.20.0",
     "c8": "^10.0.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "execa": "^9.0.0",
     "json-schema-to-typescript": "^15.0.0",
@@ -30,7 +30,7 @@
     "neostandard": "^0.12.0",
     "openapi-types": "^12.1.3",
     "split2": "^4.2.0",
-    "tsd": "^0.32.0",
+    "tsd": "^0.33.0",
     "typescript": "^5.5.4",
     "undici": "^7.0.0",
     "vscode-json-languageservice": "^5.3.9",
@@ -66,27 +66,27 @@
     "rfdc": "^1.3.1",
     "rimraf": "^4.4.1",
     "semgrator": "^0.3.0",
-    "@platformatic/basic": "3.0.0-alpha.5",
-    "@platformatic/db-authorization": "3.0.0-alpha.5",
-    "@platformatic/db-core": "3.0.0-alpha.5",
-    "@platformatic/generators": "3.0.0-alpha.5",
-    "@platformatic/service": "3.0.0-alpha.5",
-    "@platformatic/sql-events": "3.0.0-alpha.5",
-    "@platformatic/sql-graphql": "3.0.0-alpha.5",
-    "@platformatic/sql-json-schema-mapper": "3.0.0-alpha.5",
-    "@platformatic/sql-mapper": "3.0.0-alpha.5",
-    "@platformatic/telemetry": "3.0.0-alpha.5",
-    "@platformatic/foundation": "3.0.0-alpha.5",
-    "@platformatic/sql-openapi": "3.0.0-alpha.5"
+    "@platformatic/basic": "3.0.0-alpha.8",
+    "@platformatic/db-core": "3.0.0-alpha.8",
+    "@platformatic/generators": "3.0.0-alpha.8",
+    "@platformatic/db-authorization": "3.0.0-alpha.8",
+    "@platformatic/service": "3.0.0-alpha.8",
+    "@platformatic/sql-events": "3.0.0-alpha.8",
+    "@platformatic/sql-graphql": "3.0.0-alpha.8",
+    "@platformatic/foundation": "3.0.0-alpha.8",
+    "@platformatic/sql-json-schema-mapper": "3.0.0-alpha.8",
+    "@platformatic/sql-mapper": "3.0.0-alpha.8",
+    "@platformatic/sql-openapi": "3.0.0-alpha.8",
+    "@platformatic/telemetry": "3.0.0-alpha.8"
   },
   "engines": {
     "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "pnpm run lint && borp -T --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",
+    "build": "npm run gen-schema && npm run gen-types",
     "lint": "eslint"
   }
 }

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/db/3.0.0-alpha.5.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/db/3.0.0-alpha.8.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Database Config",
   "type": "object",
@@ -1187,13 +1187,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",
@@ -1300,7 +1300,7 @@
         }
       },
       "required": [
-        "serviceName"
+        "applicationName"
       ],
       "additionalProperties": false
     },
@@ -1325,6 +1325,242 @@
         "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
+              },
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "default": []
+              },
+              "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": [
             {
@@ -1639,7 +1875,7 @@
               ],
               "default": 10000
             },
-            "service": {
+            "application": {
               "anyOf": [
                 {
                   "type": "number",
@@ -1655,7 +1891,7 @@
           "default": {},
           "required": [
             "runtime",
-            "service"
+            "application"
           ],
           "additionalProperties": false
         },
@@ -2086,13 +2322,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",
@@ -2199,7 +2435,7 @@
             }
           },
           "required": [
-            "serviceName"
+            "applicationName"
           ],
           "additionalProperties": false
         },
@@ -2220,7 +2456,7 @@
             }
           }
         },
-        "serviceTimeout": {
+        "applicationTimeout": {
           "anyOf": [
             {
               "type": "number",