@reldens/cms 0.83.0 → 0.85.0

package/.claude/architecture-guide.md

@@ -379,6 +379,33 @@ Admin UI builder that:
 - Form field generation
 - Branding and styling
 
+### Delete Relations Warning
+
+**File:** `lib/admin-manager/delete-relations-warning.js`
+
+Builds the sentences appended to the delete confirmation dialog, so the admin states what actually happens to the
+records that reference the one being deleted. `ContentsBuilder` owns an instance as `this.relationsWarning` and
+calls `buildReverseRelationsMap()` once per admin contents build, then `fetchWarning(entityId, reverseRelations)`
+per entity.
+
+`buildReverseRelationsMap()` walks every resource and, for each `type: 'reference'` property, files the child
+entity label under the referenced entity, grouped by what the foreign key does on delete. The group comes from
+`fetchRelationGroup(property.onDelete)`, where `onDelete` is generated by `@reldens/storage` from the live
+`information_schema` delete rule:
+
+- `cascade` goes to `deleted`, rendered with `messages.confirmDeleteRelations`.
+- `setNull` and `setDefault` go to `unlinked`, rendered with `messages.confirmUnlinkRelations`.
+- Everything else, including `restrict`, `noAction` and a missing value, goes to `blocking`, rendered with
+  `messages.confirmBlockingRelations`.
+
+There is deliberately no default claim: `restrict` and `noAction` neither delete nor unlink, they make the delete
+fail, and a missing `onDelete` means the consumer's entities predate the generated attribute. Reporting either of
+those as "will be deleted" was the original bug this grouping replaced.
+
+Only the three sentences are produced here. The cms itself never deletes related rows: `RouterContents`
+`processDeleteEntities()` deletes the entity row alone and the database referential actions do the rest, which is
+exactly why the wording has to follow the foreign keys.
+
 ### Admin Filters Manager
 
 **File:** `lib/admin-manager/admin-filters-manager.js`

package/lib/admin-manager/contents-builder.js

@@ -4,6 +4,7 @@
  *
  */
 
+const { DeleteRelationsWarning } = require('./delete-relations-warning');
 const { sc } = require('@reldens/utils');
 
 class ContentsBuilder
@@ -29,6 +30,10 @@ class ContentsBuilder
         this.fetchUploadProperties = props.fetchUploadProperties;
         this.fetchTranslation = props.fetchTranslation;
         this.fetchEntityIdPropertyKey = props.fetchEntityIdPropertyKey;
+        this.relationsWarning = new DeleteRelationsWarning({
+            translations: props.translations,
+            resources: props.resources
+        });
         this.adminContents = {};
     }
 
@@ -116,7 +121,7 @@ class ContentsBuilder
     async buildEntitiesContents()
     {
         let entitiesContents = {};
-        let reverseRelations = this.buildReverseRelationsMap();
+        let reverseRelations = this.relationsWarning.buildReverseRelationsMap();
         for(let driverResource of this.resources()){
             let templateTitle = this.translations.labels[driverResource.id()];
             let entityName = (driverResource.id().replace(/_/g, '-'));
@@ -130,7 +135,7 @@ class ContentsBuilder
             let editProperties = Object.keys(driverResource.options.properties);
             editProperties.splice(editProperties.indexOf(idProperty), 1);
             let entityId = driverResource.id();
-            let deleteRelationsWarning = this.fetchDeleteRelationsWarning(entityId, reverseRelations);
+            let deleteRelationsWarning = this.relationsWarning.fetchWarning(entityId, reverseRelations);
             let filters = driverResource.options.filterProperties.map((property) => {
                 return {
                     propertyKey: property,
@@ -228,48 +233,6 @@ class ContentsBuilder
         return editFields;
     }
 
-    buildReverseRelationsMap()
-    {
-        let reverseRelations = {};
-        for(let resource of this.resources()){
-            let childLabel = sc.get(this.translations.labels, resource.id(), resource.id());
-            this.addResourceReverseRelations(reverseRelations, resource.options.properties, childLabel);
-        }
-        return reverseRelations;
-    }
-
-    addResourceReverseRelations(reverseRelations, properties, childLabel)
-    {
-        for(let propertyKey of Object.keys(properties)){
-            let property = properties[propertyKey];
-            if('reference' !== property.type){
-                continue;
-            }
-            if(!reverseRelations[property.reference]){
-                reverseRelations[property.reference] = {deleted: [], unlinked: []};
-            }
-            let relationGroup = true === property.unlinkOnDelete ? 'unlinked' : 'deleted';
-            if(-1 === reverseRelations[property.reference][relationGroup].indexOf(childLabel)){
-                reverseRelations[property.reference][relationGroup].push(childLabel);
-            }
-        }
-    }
-
-    fetchDeleteRelationsWarning(entityId, reverseRelations)
-    {
-        return this.buildRelationsSentence(entityId, reverseRelations, 'deleted', 'confirmDeleteRelations')
-            +this.buildRelationsSentence(entityId, reverseRelations, 'unlinked', 'confirmUnlinkRelations');
-    }
-
-    buildRelationsSentence(entityId, reverseRelations, relationGroup, messageKey)
-    {
-        let childLabels = sc.get(sc.get(reverseRelations, entityId, {}), relationGroup, []);
-        if(0 === childLabels.length){
-            return '';
-        }
-        return ' '+this.translations.messages[messageKey]+' '+[...childLabels].sort().join(', ')+'.';
-    }
-
     async render(content, params)
     {
         return await this.renderCallback(content, params);

package/lib/admin-manager/default-translations.js

@@ -19,7 +19,8 @@ module.exports.DefaultTranslations = {
         confirmClearCacheMessage: 'Are you sure you want to clear all cache? This action cannot be undone.',
         clearCacheWarning: 'This will clear all cached routes and may impact site performance temporarily.',
         confirmDeleteRelations: 'The following related records will also be deleted:',
-        confirmUnlinkRelations: 'The following related records will be kept but unlinked from it:'
+        confirmUnlinkRelations: 'The following related records will be kept but unlinked from it:',
+        confirmBlockingRelations: 'The following related records reference it and may block the delete:'
     },
     labels: {
         navigation: 'Reldens - CMS',

package/lib/admin-manager/delete-relations-warning.js

@@ -0,0 +1,79 @@
+/**
+ *
+ * Reldens - DeleteRelationsWarning
+ *
+ * Builds the delete confirmation warning for an entity by grouping every entity that references it, using the
+ * relation onDelete rule: "cascade" means the related records are deleted with it, "setNull" and "setDefault"
+ * mean they are kept and only unlinked, and anything else (restrict, no action, or an unknown rule) is reported
+ * as possibly blocking the delete instead of claiming an outcome that will not happen.
+ *
+ */
+
+const { sc } = require('@reldens/utils');
+
+class DeleteRelationsWarning
+{
+
+    constructor(props)
+    {
+        this.translations = props.translations;
+        this.resources = props.resources;
+    }
+
+    buildReverseRelationsMap()
+    {
+        let reverseRelations = {};
+        for(let resource of this.resources()){
+            let childLabel = sc.get(this.translations.labels, resource.id(), resource.id());
+            this.addResourceReverseRelations(reverseRelations, resource.options.properties, childLabel);
+        }
+        return reverseRelations;
+    }
+
+    addResourceReverseRelations(reverseRelations, properties, childLabel)
+    {
+        for(let propertyKey of Object.keys(properties)){
+            let property = properties[propertyKey];
+            if('reference' !== property.type){
+                continue;
+            }
+            if(!reverseRelations[property.reference]){
+                reverseRelations[property.reference] = {deleted: [], unlinked: [], blocking: []};
+            }
+            let relationGroup = this.fetchRelationGroup(property.onDelete);
+            if(-1 === reverseRelations[property.reference][relationGroup].indexOf(childLabel)){
+                reverseRelations[property.reference][relationGroup].push(childLabel);
+            }
+        }
+    }
+
+    fetchRelationGroup(onDelete)
+    {
+        if('cascade' === onDelete){
+            return 'deleted';
+        }
+        if('setNull' === onDelete || 'setDefault' === onDelete){
+            return 'unlinked';
+        }
+        return 'blocking';
+    }
+
+    fetchWarning(entityId, reverseRelations)
+    {
+        return this.buildRelationsSentence(entityId, reverseRelations, 'deleted', 'confirmDeleteRelations')
+            +this.buildRelationsSentence(entityId, reverseRelations, 'unlinked', 'confirmUnlinkRelations')
+            +this.buildRelationsSentence(entityId, reverseRelations, 'blocking', 'confirmBlockingRelations');
+    }
+
+    buildRelationsSentence(entityId, reverseRelations, relationGroup, messageKey)
+    {
+        let childLabels = sc.get(sc.get(reverseRelations, entityId, {}), relationGroup, []);
+        if(0 === childLabels.length){
+            return '';
+        }
+        return ' '+this.translations.messages[messageKey]+' '+[...childLabels].sort().join(', ')+'.';
+    }
+
+}
+
+module.exports.DeleteRelationsWarning = DeleteRelationsWarning;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/cms",
     "scope": "@reldens",
-    "version": "0.83.0",
+    "version": "0.85.0",
     "description": "Reldens - CMS",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -35,7 +35,7 @@
     },
     "dependencies": {
         "@reldens/server-utils": "^0.56.0",
-        "@reldens/storage": "^0.110.0",
+        "@reldens/storage": "^0.112.0",
         "@reldens/utils": "^0.57.0",
         "dotenv": "17.4.2",
         "mustache": "4.2.0"