@platformatic/sql-mapper 3.63.0-alpha.3 → 3.64.0

package/index.d.ts

@@ -59,6 +59,11 @@ export interface DBEntityField {
    * An option that is true if field is a foreignKey key.
    */
   foreignKey?: boolean,
+  /**
+   * An option that is true if a foreign key field is stringified in mapper output
+   * because it references a primary key.
+   */
+  stringifyOutput?: boolean,
   /**
    * An option that is true if field is nullable.
    */

package/index.js

@@ -80,6 +80,29 @@ const defaultAutoTimestampFields = {
   updatedAt: 'updated_at'
 }
 
+function physicalEntityKey (schema, table) {
+  return `${schema ?? ''}\0${table}`
+}
+
+function markForeignKeysReferencingPrimaryKeys (entities) {
+  const entitiesByTable = new Map()
+
+  for (const entity of Object.values(entities)) {
+    entitiesByTable.set(physicalEntityKey(entity.schema, entity.table), entity)
+  }
+
+  for (const entity of Object.values(entities)) {
+    for (const relation of entity.relations) {
+      const foreignSchema = relation.foreign_table_schema ?? entity.schema
+      const foreignEntity = entitiesByTable.get(physicalEntityKey(foreignSchema, relation.foreign_table_name))
+
+      if (foreignEntity?.primaryKeys.has(relation.foreign_column_name)) {
+        entity.fields[relation.column_name].stringifyOutput = true
+      }
+    }
+  }
+}
+
 async function registerPostgreSQLExtensionTypes (db) {
   try {
     await db.registerTypeParser('vector', parseVector)
@@ -375,6 +398,8 @@ export async function connect ({
       }
     }
 
+    markForeignKeysReferencingPrimaryKeys(entities)
+
     const res = {
       db,
       sql,

package/lib/entity.js

@@ -104,8 +104,13 @@ function createMapper (
       let value = output[key]
       const newKey = fieldMapToRetrieve[key]
       // Do not convert Date objects: they are serialized according to the
-      // schema of the field, like non primary key columns
-      if (primaryKeys.has(key) && value !== null && value !== undefined && !(value instanceof Date)) {
+      // schema of the field, like other non-stringified columns
+      if (
+        (primaryKeys.has(key) || fields[key]?.stringifyOutput) &&
+        value !== null &&
+        value !== undefined &&
+        !(value instanceof Date)
+      ) {
         value = value.toString()
       }
       if (newKey && isVectorType(fields[key].sqlType)) {
@@ -599,6 +604,16 @@ export function buildEntity (
       schemaList?.length > 0 ? schemaList.includes(constraint.foreign_table_schema) : true
     /* istanbul ignore if */
     if (constraint.constraint_type === 'FOREIGN KEY' && isForeignKeySchemaInConfig) {
+      /* istanbul ignore next */
+      if (!constraint.foreign_table_name) {
+        // The referenced side of the foreign key could not be resolved by the introspection
+        // query. Ignore the relation rather than failing the whole boot.
+        log.warn(
+          { constraint },
+          `Could not resolve the table referenced by the foreign key "${constraint.constraint_name}" on "${constraint.table_name}.${constraint.column_name}". The relation will be ignored.`
+        )
+        continue
+      }
       field.foreignKey = true
       const foreignEntityName = singularize(
         camelcase(

package/lib/queries/pg.js

@@ -80,16 +80,34 @@ export async function listColumns (db, sql, table, schema) {
 
 export async function listConstraints (db, sql, table, schema) {
   const query = sql`
-    SELECT constraints.*, usage.*, usage2.table_name AS foreign_table_name, usage2.column_name AS foreign_column_name, usage2.table_schema AS foreign_table_schema
+    SELECT constraints.*, usage.*, foreign_table.relname AS foreign_table_name,
+      foreign_column.attname AS foreign_column_name, foreign_namespace.nspname AS foreign_table_schema
     FROM information_schema.table_constraints constraints
       JOIN information_schema.key_column_usage usage
-        ON constraints.constraint_name = usage.constraint_name
-        AND constraints.table_name = ${table}
-      JOIN information_schema.constraint_column_usage usage2
-        ON usage.constraint_name = usage2.constraint_name
-        AND ( usage.table_name = ${table}
-        AND usage.table_schema = ${schema} )
-    ORDER BY usage.constraint_name, usage.ordinal_position, usage2.table_name, usage2.column_name
+        ON constraints.constraint_catalog = usage.constraint_catalog
+        AND constraints.constraint_schema = usage.constraint_schema
+        AND constraints.constraint_name = usage.constraint_name
+        AND constraints.table_schema = usage.table_schema
+        AND constraints.table_name = usage.table_name
+      LEFT JOIN pg_catalog.pg_namespace local_namespace
+        ON local_namespace.nspname = constraints.table_schema
+      LEFT JOIN pg_catalog.pg_class local_table
+        ON local_table.relname = constraints.table_name
+        AND local_table.relnamespace = local_namespace.oid
+      LEFT JOIN pg_catalog.pg_constraint foreign_constraint
+        ON foreign_constraint.conrelid = local_table.oid
+        AND foreign_constraint.conname = constraints.constraint_name
+        AND foreign_constraint.contype = 'f'
+      LEFT JOIN pg_catalog.pg_class foreign_table
+        ON foreign_table.oid = foreign_constraint.confrelid
+      LEFT JOIN pg_catalog.pg_namespace foreign_namespace
+        ON foreign_namespace.oid = foreign_table.relnamespace
+      LEFT JOIN pg_catalog.pg_attribute foreign_column
+        ON foreign_column.attrelid = foreign_constraint.confrelid
+        AND foreign_column.attnum = foreign_constraint.confkey[usage.ordinal_position]
+    WHERE constraints.table_name = ${table}
+      AND constraints.table_schema = ${schema}
+    ORDER BY usage.constraint_name, usage.ordinal_position
   `
   const constraintsList = await db.query(query)
   return constraintsList

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "3.63.0-alpha.3",
+  "version": "3.64.0",
   "description": "A data mapper utility for SQL databases",
   "main": "index.js",
   "type": "module",
@@ -19,7 +19,7 @@
     "@opentelemetry/api": "^1.9.0",
     "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
-    "fastify": "^5.7.0",
+    "fastify": "^5.0.0",
     "neostandard": "^0.12.0",
     "tstyche": "^6.2.0",
     "typescript": "^5.9.3"
@@ -33,10 +33,10 @@
     "@matteo.collina/sqlite-pool": "^0.7.0",
     "async-cache-dedupe": "^2.1.0",
     "camelcase": "^6.3.0",
-    "fastify-plugin": "^5.0.0",
+    "fastify-plugin": "^6.0.0",
     "inflected": "^2.1.0",
-    "@platformatic/foundation": "3.63.0-alpha.3",
-    "@platformatic/telemetry": "3.63.0-alpha.3"
+    "@platformatic/foundation": "3.64.0",
+    "@platformatic/telemetry": "3.64.0"
   },
   "engines": {
     "node": ">=22.19.0"