@platformatic/db 3.38.0 → 3.39.0

package/config.d.ts

@@ -96,6 +96,10 @@ export interface PlatformaticDatabaseConfig {
           customLevels?: {
             [k: string]: unknown;
           };
+          openTelemetryExporter?: {
+            protocol: "grpc" | "http";
+            url: string;
+          };
           [k: string]: unknown;
         };
     loggerInstance?: {
@@ -548,6 +552,10 @@ export interface PlatformaticDatabaseConfig {
       customLevels?: {
         [k: string]: unknown;
       };
+      openTelemetryExporter?: {
+        protocol: "grpc" | "http";
+        url: string;
+      };
       [k: string]: unknown;
     };
     server?: {

package/lib/application.js

@@ -6,7 +6,7 @@ import { readFile, writeFile } from 'node:fs/promises'
 import { execute as applyMigrations } from './migrator.js'
 import { root } from './root.js'
 import { execute as generateTypes } from './types.js'
-import { locateSchemaLock, updateSchemaLock } from './utils.js'
+import { locateSchemaLock, updateSchemaLock, validateSchemaLockFormat } from './utils.js'
 
 async function healthCheck (app) {
   const { db, sql } = app.platformatic
@@ -27,6 +27,8 @@ export async function platformaticDatabase (app, capability) {
 
   async function loadSchemaLock () {
     if (config.db.schemalock) {
+      validateSchemaLockFormat(config.db.schemalock)
+
       // ignore errors, this is an optimization
       try {
         const path = locateSchemaLock(config)

package/lib/errors.js

@@ -16,3 +16,7 @@ export const MigrationsToApplyError = createError(
   `${ERROR_PREFIX}_MIGRATIONS_TO_APPLY_ERROR`,
   'You have migrations to apply.'
 )
+export const InvalidSchemaLockError = createError(
+  `${ERROR_PREFIX}_INVALID_SCHEMA_LOCK_ERROR`,
+  'Invalid schema lock format.'
+)

package/lib/utils.js

@@ -3,6 +3,7 @@ import { kMetadata } from '@platformatic/foundation'
 import fs from 'node:fs/promises'
 import { dirname, join } from 'node:path'
 import { fileURLToPath } from 'node:url'
+import { InvalidSchemaLockError } from './errors.js'
 
 export async function setupDB (log, config) {
   const { db, sql, entities, dbschema } = await connect({ ...config, log })
@@ -32,3 +33,15 @@ export async function updateSchemaLock (logger, config) {
     await conn.db.dispose()
   }
 }
+
+export function validateSchemaLockFormat (schemaLock) {
+  const isBoolean = typeof schemaLock === 'boolean'
+  const isObject = typeof schemaLock === 'object'
+
+  if (!isBoolean && !isObject) {
+    throw new InvalidSchemaLockError()
+  }
+  if (isObject && typeof schemaLock.path !== 'string') {
+    throw new InvalidSchemaLockError()
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/db",
-  "version": "3.38.0",
+  "version": "3.39.0",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -30,7 +30,7 @@
     "neostandard": "^0.12.0",
     "openapi-types": "^12.1.3",
     "split2": "^4.2.0",
-    "tsd": "^0.33.0",
+    "tstyche": "^6.2.0",
     "typescript": "^5.5.4",
     "undici": "^7.0.0",
     "vscode-json-languageservice": "^5.3.9",
@@ -66,17 +66,17 @@
     "rfdc": "^1.3.1",
     "rimraf": "^4.4.1",
     "semgrator": "^0.3.0",
-    "@platformatic/db-authorization": "3.38.0",
-    "@platformatic/basic": "3.38.0",
-    "@platformatic/db-core": "3.38.0",
-    "@platformatic/service": "3.38.0",
-    "@platformatic/sql-graphql": "3.38.0",
-    "@platformatic/foundation": "3.38.0",
-    "@platformatic/sql-json-schema-mapper": "3.38.0",
-    "@platformatic/sql-openapi": "3.38.0",
-    "@platformatic/sql-events": "3.38.0",
-    "@platformatic/telemetry": "3.38.0",
-    "@platformatic/sql-mapper": "3.38.0"
+    "@platformatic/db-authorization": "3.39.0",
+    "@platformatic/basic": "3.39.0",
+    "@platformatic/db-core": "3.39.0",
+    "@platformatic/sql-events": "3.39.0",
+    "@platformatic/foundation": "3.39.0",
+    "@platformatic/sql-graphql": "3.39.0",
+    "@platformatic/sql-json-schema-mapper": "3.39.0",
+    "@platformatic/service": "3.39.0",
+    "@platformatic/sql-openapi": "3.39.0",
+    "@platformatic/telemetry": "3.39.0",
+    "@platformatic/sql-mapper": "3.39.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/db/3.38.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/db/3.39.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Database Config",
   "type": "object",
@@ -238,6 +238,26 @@
                 "customLevels": {
                   "type": "object",
                   "additionalProperties": true
+                },
+                "openTelemetryExporter": {
+                  "type": "object",
+                  "properties": {
+                    "protocol": {
+                      "type": "string",
+                      "enum": [
+                        "grpc",
+                        "http"
+                      ]
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "protocol",
+                    "url"
+                  ],
+                  "additionalProperties": false
                 }
               },
               "default": {},
@@ -1870,6 +1890,26 @@
             "customLevels": {
               "type": "object",
               "additionalProperties": true
+            },
+            "openTelemetryExporter": {
+              "type": "object",
+              "properties": {
+                "protocol": {
+                  "type": "string",
+                  "enum": [
+                    "grpc",
+                    "http"
+                  ]
+                },
+                "url": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "protocol",
+                "url"
+              ],
+              "additionalProperties": false
             }
           },
           "default": {},