fix: add composite pk support

Author: SerVitasik

custom/RelatedLogsLink.vue

@@ -19,6 +19,7 @@
 import { computed } from 'vue';
 import { useRoute } from 'vue-router';
 import { IconClockSolid } from '@iconify-prerendered/vue-flowbite';
+import { encodeRecordId } from '@/utils/recordId';
 import { useRouter } from 'vue-router';
 
 const router = useRouter();
@@ -50,10 +51,21 @@ const to = computed(() => {
     if (!resourceColumns) return null;
 
     const pkName = props.meta?.pkName 
+    const pkNames = props.meta?.pkNames?.length ? props.meta.pkNames : [pkName];
   
     const isShowPage = route.name === 'resource-show' || route.name === 'resource-edit';
 
-    let recordId = props.record?.[pkName];
+    // for composite primary key record id is glued from all key columns, so build it the same way as backend does
+    const pkResource = props.resource?.columns?.some((c: any) => c.primaryKey)
+      ? props.resource
+      : { columns: pkNames.map((name: string) => ({ name, primaryKey: true })) };
+
+    let recordId: any = undefined;
+    try {
+      recordId = props.record ? encodeRecordId(pkResource as any, props.record) : undefined;
+    } catch (e) {
+      // record has no values of all key columns, fall back to record id from route below
+    }
     
     if (!recordId && isShowPage) {
         recordId = route.params.primaryKey || route.params.id;

index.ts

@@ -7,7 +7,7 @@ import type {
 import dayjs from 'dayjs'
 import utc from 'dayjs/plugin/utc.js';
 
-import { AdminForthPlugin, AllowedActionsEnum, AdminForthSortDirections, AdminForthDataTypes, HttpExtra, ActionCheckSource, Filters, afLogger,  } from "adminforth";
+import { AdminForthPlugin, AllowedActionsEnum, AdminForthSortDirections, AdminForthDataTypes, HttpExtra, ActionCheckSource, Filters, afLogger, encodeRecordId, isCompositePrimaryKey, primaryKeyColumnNames,  } from "adminforth";
 import { PluginOptions } from "./types.js";
 
 dayjs.extend(utc);
@@ -95,8 +95,8 @@ export default class AuditLogPlugin extends AdminForthPlugin {
       return { ok: true };
     }
 
-    const recordIdFieldName = resource.columns.find((c) => c.primaryKey === true)?.name;
-    const recordId = data?.[recordIdFieldName] || oldRecord?.[recordIdFieldName];
+    // record id is built from all primary key columns, so resources with composite primary key are supported
+    const recordId = encodeRecordId(resource, { ...(oldRecord || {}), ...(data || {}) });
     const connector = this.adminforth.connectors[resource.dataSource];
 
     const newRecord = action == AllowedActionsEnum.delete ? {} : (await connector.getRecordByPrimaryKey(resource, recordId)) || {};
@@ -266,6 +266,8 @@ export default class AuditLogPlugin extends AdminForthPlugin {
               auditLogResourceId: this.auditLogResource,
               resourceColumns: this.options.resourceColumns,
               pkName: resource.columns.find((c) => c.primaryKey)?.name || 'id',
+              // all primary key columns, so component can build record id of composite primary key resource
+              pkNames: primaryKeyColumnNames(resource),
               title: 'Edit History'
             }
           }
@@ -331,6 +333,8 @@ export default class AuditLogPlugin extends AdminForthPlugin {
             auditLogResourceId: this.auditLogResource,
             resourceColumns: this.options.resourceColumns,
             pkName: resource.columns.find((c) => c.primaryKey)?.name || 'id',
+            // all primary key columns, so component can build record id of composite primary key resource
+            pkNames: primaryKeyColumnNames(resource),
             title: 'Edit History'
           }
         });
@@ -353,6 +357,12 @@ export default class AuditLogPlugin extends AdminForthPlugin {
     const recordIdColumn = resourceConfig.columns.find((c) => c.name === this.options.resourceColumns.resourceRecordIdColumnName);
     if (!recordIdColumn.foreignResource) {
       for (const resource of existingResources) {
+        // core does not support foreignResource pointing to resource with composite primary key yet,
+        // so such resources are still logged, but their record id is not clickable
+        const targetResource = this.adminforth.config.resources.find((r) => r.resourceId === resource.value);
+        if (targetResource && isCompositePrimaryKey(targetResource)) {
+          continue;
+        }
         if(!recordIdColumn.foreignResource?.polymorphicResources) {
           recordIdColumn.foreignResource = {
             polymorphicResources: [],

package.json

@@ -34,7 +34,7 @@
     "build": "tsc && rsync -av --exclude 'node_modules' custom dist/"
   },
   "peerDependencies": {
-    "adminforth": "^3.7.1"
+    "adminforth": "^3.20.0"
   },
   "release": {
     "plugins": [
@@ -63,7 +63,7 @@
   },
   "devDependencies": {
     "@types/node": "^22.10.7",
-    "adminforth": "^3.7.1",
+    "adminforth": "^3.20.0",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3"