@platformatic/db 3.2.1 → 3.4.0

package/config.d.ts

@@ -658,6 +658,10 @@ export interface PlatformaticDatabaseConfig {
           labels?: {
             [k: string]: string;
           };
+          /**
+           * The label name to use for the application identifier in metrics (e.g., applicationId, serviceId)
+           */
+          applicationLabel?: string;
           readiness?:
             | boolean
             | {

package/index.js

@@ -1,60 +1,10 @@
 import { resolve, validationOptions } from '@platformatic/basic'
 import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platformatic/foundation'
-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 { transform } from './lib/config.js'
 import { schema } from './lib/schema.js'
 import { upgrade } from './lib/upgrade.js'
 
-export async function transform (config) {
-  config = await serviceTransform(config)
-
-  if (
-    config.db &&
-    config.db.connectionString.indexOf('sqlite') === 0 &&
-    config.db.connectionString !== 'sqlite://:memory:'
-  ) {
-    const originalSqlitePath = config.db.connectionString.replace('sqlite://', '')
-    const sqliteFullPath = resolvePath(config[kMetadata].root, originalSqlitePath)
-    config.db.connectionString = 'sqlite://' + sqliteFullPath
-  }
-
-  /* c8 ignore next 3 */
-  if (config.db.graphql?.schemaPath) {
-    config.db.graphql.schema = await readFile(config.db.graphql.schemaPath, 'utf8')
-  }
-
-  /* c8 ignore next 2 */
-  const arePostgresqlSchemaDefined =
-    config.db?.connectionString.indexOf('postgres') === 0 && config.db?.schema?.length > 0
-  const migrationsTableName = arePostgresqlSchemaDefined ? 'public.versions' : 'versions'
-
-  // relative-to-absolute migrations path
-  if (config.migrations) {
-    config.migrations.table = config.migrations.table || migrationsTableName
-  }
-
-  if (config.migrations && config.db) {
-    // TODO remove the ignores
-    /* c8 ignore next 4 */
-    config.db.ignore = config.db.ignore || {}
-    config.db.ignore = Object.assign(
-      {},
-      {
-        [config.migrations.table || migrationsTableName]: true
-      },
-      config.db.ignore
-    )
-  }
-
-  if (config.types?.autogenerate === 'true') {
-    config.types.autogenerate = true
-  }
-
-  return config
-}
-
 export async function loadConfiguration (configOrRoot, sourceOrConfig, context) {
   const { root, source } = await resolve(configOrRoot, sourceOrConfig, 'db')
 
@@ -79,6 +29,7 @@ export const skipTelemetryHooks = true
 export { platformaticDatabase } from './lib/application.js'
 export { DatabaseCapability } from './lib/capability.js'
 export * from './lib/commands/index.js'
+export { transform } from './lib/config.js'
 export * from './lib/errors.js'
 export * as errors from './lib/errors.js'
 export { Generator } from './lib/generator.js'

package/lib/commands/migrations-apply.js

@@ -1,5 +1,6 @@
 import { loadConfiguration } from '@platformatic/foundation'
 import { utimesSync } from 'node:fs'
+import { transform } from '../config.js'
 import { execute } from '../migrator.js'
 import { schema } from '../schema.js'
 import { updateSchemaLock } from '../utils.js'
@@ -7,7 +8,7 @@ import { generateTypes } from './types.js'
 
 export async function applyMigrations (logger, configFile, args, context) {
   const { parseArgs, logFatalError } = context
-  const config = await loadConfiguration(configFile, schema)
+  const config = await loadConfiguration(configFile, schema, { transform })
 
   const {
     values: { to, rollback }

package/lib/commands/migrations-create.js

@@ -1,12 +1,14 @@
-import { loadConfiguration } from '@platformatic/foundation'
+import { kMetadata, loadConfiguration } from '@platformatic/foundation'
 import { writeFile } from 'node:fs/promises'
 import { join, relative } from 'node:path'
+import { transform } from '../config.js'
 import * as errors from '../errors.js'
 import { Migrator } from '../migrator.js'
 import { schema } from '../schema.js'
 
 export async function createMigrations (logger, configFile, _, { colorette: { bold } }) {
-  const config = await loadConfiguration(configFile, schema)
+  const config = await loadConfiguration(configFile, schema, { transform })
+  const root = config[kMetadata].root
 
   let migrator = null
   try {
@@ -28,9 +30,7 @@ export async function createMigrations (logger, configFile, _, { colorette: { bo
 
     await Promise.all([writeFile(doFile, ''), writeFile(undoFile, '')])
 
-    logger.info(
-      `Created migration files ${bold(relative(process.cwd(), doFile))} and ${bold(relative(process.cwd(), undoFile))}.`
-    )
+    logger.info(`Created migration files ${bold(relative(root, doFile))} and ${bold(relative(root, undoFile))}.`)
   } catch (error) {
     logger.error(error.message)
   } finally {

package/lib/commands/print-schema.js

@@ -1,10 +1,11 @@
 import { abstractLogger, kMetadata, loadConfiguration } from '@platformatic/foundation'
 import { printSchema as printGraphqlSchema } from 'graphql'
 import { create } from '../../index.js'
+import { transform } from '../config.js'
 import { schema } from '../schema.js'
 
 export async function printSchema (logger, configFile, args, { colorette: { bold }, logFatalError }) {
-  const config = await loadConfiguration(configFile, schema)
+  const config = await loadConfiguration(configFile, schema, { transform })
 
   const type = args[0]
 

package/lib/commands/seed.js

@@ -1,14 +1,15 @@
-import { loadConfiguration, loadModule } from '@platformatic/foundation'
+import { kMetadata, loadConfiguration, loadModule } from '@platformatic/foundation'
 import { access } from 'fs/promises'
 import { createRequire } from 'node:module'
 import { resolve } from 'node:path'
+import { transform } from '../config.js'
 import { MissingSeedFileError } from '../errors.js'
 import { Migrator } from '../migrator.js'
 import { schema } from '../schema.js'
 import { setupDB } from '../utils.js'
 
 export async function seed (logger, configFile, args, { colorette: { bold }, logFatalError }) {
-  const config = await loadConfiguration(configFile, schema)
+  const config = await loadConfiguration(configFile, schema, { transform })
 
   if (config.migrations !== undefined) {
     const migrator = new Migrator(config.migrations, config.db, logger)
@@ -28,14 +29,15 @@ export async function seed (logger, configFile, args, { colorette: { bold }, log
     throw new MissingSeedFileError()
   }
 
-  const seedFile = resolve(process.cwd(), args[0])
+  const root = config[kMetadata].root
+  const seedFile = resolve(root, args[0])
   await access(seedFile)
 
   logger.info(`Seeding from ${bold(seedFile)}`)
 
-  const importedModule = await loadModule(createRequire(resolve(process.cwd(), 'noop.js')), seedFile)
+  const importedModule = await loadModule(createRequire(resolve(root, 'noop.js')), seedFile)
 
-  const seedFunction = typeof importedModule?.seed !== 'function' ? importedModule : importedModule
+  const seedFunction = typeof importedModule?.seed !== 'function' ? importedModule : importedModule.seed
 
   if (typeof seedFunction !== 'function') {
     logFatalError(logger, 'Cannot find seed function.')

package/lib/commands/types.js

@@ -1,9 +1,10 @@
 import { loadConfiguration } from '@platformatic/foundation'
+import { transform } from '../config.js'
 import { schema } from '../schema.js'
 import { execute } from '../types.js'
 
 export async function generateTypes (logger, configFile, _args) {
-  const config = await loadConfiguration(configFile, schema)
+  const config = await loadConfiguration(configFile, schema, { transform })
 
   const count = await execute({ logger, config })
 

package/lib/config.js

@@ -0,0 +1,52 @@
+import { kMetadata } from '@platformatic/foundation'
+import { transform as serviceTransform } from '@platformatic/service'
+import { readFile } from 'node:fs/promises'
+import { resolve as resolvePath } from 'node:path'
+
+export async function transform (config) {
+  config = await serviceTransform(config)
+
+  if (
+    config.db &&
+    config.db.connectionString.indexOf('sqlite') === 0 &&
+    config.db.connectionString !== 'sqlite://:memory:'
+  ) {
+    const originalSqlitePath = config.db.connectionString.replace('sqlite://', '')
+    const sqliteFullPath = resolvePath(config[kMetadata].root, originalSqlitePath)
+    config.db.connectionString = 'sqlite://' + sqliteFullPath
+  }
+
+  /* c8 ignore next 3 */
+  if (config.db.graphql?.schemaPath) {
+    config.db.graphql.schema = await readFile(config.db.graphql.schemaPath, 'utf8')
+  }
+
+  /* c8 ignore next 2 */
+  const arePostgresqlSchemaDefined =
+    config.db?.connectionString.indexOf('postgres') === 0 && config.db?.schema?.length > 0
+  const migrationsTableName = arePostgresqlSchemaDefined ? 'public.versions' : 'versions'
+
+  // relative-to-absolute migrations path
+  if (config.migrations) {
+    config.migrations.table = config.migrations.table || migrationsTableName
+  }
+
+  if (config.migrations && config.db) {
+    // TODO remove the ignores
+    /* c8 ignore next 4 */
+    config.db.ignore = config.db.ignore || {}
+    config.db.ignore = Object.assign(
+      {},
+      {
+        [config.migrations.table || migrationsTableName]: true
+      },
+      config.db.ignore
+    )
+  }
+
+  if (config.types?.autogenerate === 'true') {
+    config.types.autogenerate = true
+  }
+
+  return config
+}

package/lib/types.js

@@ -1,4 +1,4 @@
-import { createDirectory, isFileAccessible } from '@platformatic/foundation'
+import { createDirectory, isFileAccessible, kMetadata } from '@platformatic/foundation'
 import { mapOpenAPItoTypes, mapSQLEntityToJSONSchema } from '@platformatic/sql-json-schema-mapper'
 import camelcase from 'camelcase'
 import { readFile, readdir, unlink, writeFile } from 'node:fs/promises'
@@ -122,7 +122,8 @@ export async function execute ({ logger, config }) {
     return 0
   }
 
-  const typesFolderPath = resolve(process.cwd(), config.types?.dir ?? 'types')
+  const root = config[kMetadata].root
+  const typesFolderPath = resolve(root, config.types?.dir ?? 'types')
 
   // Prepare the types folder
   if (await isFileAccessible(typesFolderPath)) {
@@ -149,8 +150,8 @@ export async function execute ({ logger, config }) {
   }
 
   // Generate plt-env.d.ts
-  const environmentPath = join(process.cwd(), 'plt-env.d.ts')
-  const pltEnvironment = await generateEnvironmentTypes(relative(process.cwd(), typesFolderPath))
+  const environmentPath = join(root, 'plt-env.d.ts')
+  const pltEnvironment = await generateEnvironmentTypes(relative(root, typesFolderPath))
   if (await writeFileIfChanged(environmentPath, pltEnvironment)) {
     logger.info('Regenerated plt-env.d.ts.')
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/db",
-  "version": "3.2.1",
+  "version": "3.4.0",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -66,17 +66,17 @@
     "rfdc": "^1.3.1",
     "rimraf": "^4.4.1",
     "semgrator": "^0.3.0",
-    "@platformatic/basic": "3.2.1",
-    "@platformatic/db-authorization": "3.2.1",
-    "@platformatic/db-core": "3.2.1",
-    "@platformatic/foundation": "3.2.1",
-    "@platformatic/service": "3.2.1",
-    "@platformatic/sql-events": "3.2.1",
-    "@platformatic/sql-mapper": "3.2.1",
-    "@platformatic/sql-json-schema-mapper": "3.2.1",
-    "@platformatic/sql-openapi": "3.2.1",
-    "@platformatic/sql-graphql": "3.2.1",
-    "@platformatic/telemetry": "3.2.1"
+    "@platformatic/basic": "3.4.0",
+    "@platformatic/db-authorization": "3.4.0",
+    "@platformatic/db-core": "3.4.0",
+    "@platformatic/foundation": "3.4.0",
+    "@platformatic/service": "3.4.0",
+    "@platformatic/sql-graphql": "3.4.0",
+    "@platformatic/sql-json-schema-mapper": "3.4.0",
+    "@platformatic/sql-mapper": "3.4.0",
+    "@platformatic/sql-events": "3.4.0",
+    "@platformatic/sql-openapi": "3.4.0",
+    "@platformatic/telemetry": "3.4.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/db/3.2.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/db/3.4.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Database Config",
   "type": "object",
@@ -2228,6 +2228,11 @@
                     "type": "string"
                   }
                 },
+                "applicationLabel": {
+                  "type": "string",
+                  "default": "applicationId",
+                  "description": "The label name to use for the application identifier in metrics (e.g., applicationId, serviceId)"
+                },
                 "readiness": {
                   "anyOf": [
                     {