@reldens/cms 0.16.0 → 0.18.0

package/lib/template-engine.js

@@ -5,6 +5,7 @@
  */
 
 const { Logger, sc } = require('@reldens/utils');
+const { JsonFieldsParser } = require('./json-fields-parser');
 
 class TemplateEngine
 {
@@ -15,6 +16,9 @@ class TemplateEngine
         this.dataServer = sc.get(props, 'dataServer', false);
         this.getPartials = sc.get(props, 'getPartials', false);
         this.currentDomain = '';
+        this.jsonFieldsParser = new JsonFieldsParser({
+            entitiesConfig: sc.get(props, 'entitiesConfig', {})
+        });
     }
 
     setCurrentDomain(domain)
@@ -70,12 +74,12 @@ class TemplateEngine
 
     getSingleFieldCollectionRegex()
     {
-        return /<collection\s+name=(['"])([^'"]+)\1(?:\s+filters=(['"])([^'"]*)\3)?\s+field=(['"])([^'"]+)\5(?:\s+data=(['"])([^'"]*)\7)?\s*\/>/g;
+        return /<collection\s+([^>]+)\/>/g;
     }
 
     getLoopCollectionStartRegex()
     {
-        return /<collection\s+name=(['"])([^'"]+)\1(?:\s+filters=(['"])([^'"]*)\3)?(?:\s+data=(['"])([^'"]*)\5)?\s*>/g;
+        return /<collection\s+([^>]+)>/g;
     }
 
     getLoopCollectionEndRegex()
@@ -83,6 +87,13 @@ class TemplateEngine
         return new RegExp('<\\/collection>');
     }
 
+    extractAttributeValue(tagContent, attributeName)
+    {
+        let regex = new RegExp(attributeName + '=([\'"])([^\'"]*)\\1');
+        let match = tagContent.match(regex);
+        return match ? match[2] : '';
+    }
+
     async processEntityFunctions(template)
     {
         let processedTemplate = template;
@@ -108,14 +119,19 @@ class TemplateEngine
     {
         let processedTemplate = template;
         for(let match of template.matchAll(this.getSingleFieldCollectionRegex())){
-            let tableName = match[2];
-            let filtersJson = sc.get(match, '4', '{}');
-            let fieldName = match[6];
-            let queryOptionsJson = sc.get(match, '8', '{}');
+            let tagContent = match[1];
+            if(!tagContent.includes('field=')){
+                continue;
+            }
+            let tableName = this.extractAttributeValue(tagContent, 'name');
+            let filtersJson = this.extractAttributeValue(tagContent, 'filters');
+            let queryOptionsJson = this.extractAttributeValue(tagContent, 'data');
+            let relationsString = this.extractAttributeValue(tagContent, 'relations');
+            let fieldName = this.extractAttributeValue(tagContent, 'field');
             processedTemplate = processedTemplate.replace(
                 match[0],
                 this.extractFieldValues(
-                    await this.fetchCollectionForTemplate(tableName, filtersJson, queryOptionsJson),
+                    await this.fetchCollectionForTemplate(tableName, filtersJson, queryOptionsJson, relationsString),
                     fieldName
                 )
             );
@@ -129,12 +145,21 @@ class TemplateEngine
         let matches = [...template.matchAll(this.getLoopCollectionStartRegex())];
         for(let i = matches.length - 1; i >= 0; i--){
             let startMatch = matches[i];
+            let tagContent = startMatch[1];
+            if(tagContent.includes('field=')){
+                continue;
+            }
+            let tableName = this.extractAttributeValue(tagContent, 'name');
+            let filtersJson = this.extractAttributeValue(tagContent, 'filters');
+            let queryOptionsJson = this.extractAttributeValue(tagContent, 'data');
+            let relationsString = this.extractAttributeValue(tagContent, 'relations');
             let loopResult = await this.processLoopCollection(
                 processedTemplate,
                 startMatch,
-                startMatch[2],
-                sc.get(startMatch, '4', '{}'),
-                sc.get(startMatch, '6', '{}')
+                tableName,
+                filtersJson,
+                relationsString,
+                queryOptionsJson
             );
             if(loopResult){
                 processedTemplate = loopResult;
@@ -152,7 +177,7 @@ class TemplateEngine
             let partialContent = this.loadPartialTemplate(tag.name);
             if(!partialContent){
                 Logger.warning('Partial template not found: ' + tag.name);
-                processedTemplate = processedTemplate.substring(0, tag.start) + '' + processedTemplate.substring(tag.end);
+                processedTemplate = processedTemplate.substring(0, tag.start)+''+processedTemplate.substring(tag.end);
                 continue;
             }
             let wrapperTemplate = '{{#vars}}{{> ' + tag.name + '}}{{/vars}}';
@@ -168,18 +193,18 @@ class TemplateEngine
     findAllPartialTags(template)
     {
         let partialTags = [];
-        let searchPos = 0;
-        let partialTagName = '<partial';
-        for(let tagStart = template.indexOf(partialTagName, searchPos); -1 !== tagStart; tagStart = template.indexOf(partialTagName, searchPos)){
+        let pos = 0;
+        let partial = '<partial';
+        for(let tagStart = template.indexOf(partial, pos); -1 !== tagStart; tagStart=template.indexOf(partial, pos)){
             let tagEnd = this.findPartialTagEnd(template, tagStart);
             if(-1 === tagEnd){
-                searchPos = tagStart + partialTagName.length;
+                pos = tagStart + partial.length;
                 continue;
             }
             let fullTag = template.substring(tagStart, tagEnd);
             let nameMatch = fullTag.match(/name=["']([^"']+)["']/);
             if(!nameMatch){
-                searchPos = tagStart + partialTagName.length;
+                pos = tagStart + partial.length;
                 continue;
             }
             let partialName = nameMatch[1];
@@ -191,7 +216,7 @@ class TemplateEngine
                 attributes: attributes,
                 fullTag: fullTag
             });
-            searchPos = tagEnd;
+            pos = tagEnd;
         }
         return partialTags;
     }
@@ -294,7 +319,7 @@ class TemplateEngine
         return false;
     }
 
-    async processLoopCollection(template, startMatch, tableName, filtersJson, queryOptionsJson)
+    async processLoopCollection(template, startMatch, tableName, filtersJson, relationsString, queryOptionsJson)
     {
         let startPos = startMatch.index;
         let startEnd = startPos + startMatch[0].length;
@@ -305,7 +330,12 @@ class TemplateEngine
         }
         let endPos = startEnd + endMatch.index;
         let loopContent = template.substring(startEnd, endPos);
-        let collectionData = await this.fetchCollectionForTemplate(tableName, filtersJson, queryOptionsJson);
+        let collectionData = await this.fetchCollectionForTemplate(
+            tableName,
+            filtersJson,
+            queryOptionsJson,
+            relationsString
+        );
         let renderedContent = await this.renderCollectionLoop(loopContent, collectionData);
         return template.substring(0, startPos) + renderedContent + template.substring(endPos + endMatch[0].length);
     }
@@ -328,12 +358,13 @@ class TemplateEngine
             let partialContent = this.loadPartialTemplate(tag.name);
             if(!partialContent){
                 Logger.warning('Partial template not found: ' + tag.name);
-                processedContent = processedContent.substring(0, tag.start) + '' + processedContent.substring(tag.end);
+                processedContent = processedContent.substring(0, tag.start)+''+processedContent.substring(tag.end);
                 continue;
             }
             if(sc.hasOwn(tag.attributes, 'row')){
-                let renderedPartial = this.renderEngine.render(partialContent, {row: rowData}, this.getPartials(this.currentDomain));
-                processedContent = processedContent.substring(0, tag.start) + renderedPartial + processedContent.substring(tag.end);
+                processedContent = processedContent.substring(0, tag.start)
+                    +this.renderEngine.render(partialContent, {row: rowData}, this.getPartials(this.currentDomain))
+                    +processedContent.substring(tag.end);
                 continue;
             }
             let wrapperTemplate = '{{#vars}}{{> ' + tag.name + '}}{{/vars}}';
@@ -362,7 +393,14 @@ class TemplateEngine
             Logger.warning('Entity not found in dataServer: '+tableName);
             return false;
         }
-        return await entity.loadOneBy(identifierField, identifier);
+        let result = await entity.loadOneBy(identifierField, identifier);
+        if(!result){
+            return false;
+        }
+        return this.jsonFieldsParser.parseJsonFields(
+            result,
+            this.jsonFieldsParser.getJsonFieldsForEntity(tableName)
+        );
     }
 
     convertJsObjectToJson(jsObjectString)
@@ -373,7 +411,15 @@ class TemplateEngine
         return jsObjectString.replace(/([{,]\s*)([a-zA-Z_$][a-zA-Z0-9_$]*)\s*:/g, '$1"$2":');
     }
 
-    async fetchCollectionForTemplate(tableName, filtersJson, queryOptionsJson)
+    parseRelationsString(relationsString)
+    {
+        if(!relationsString || '' === relationsString.trim()){
+            return [];
+        }
+        return relationsString.split(',').map(relation => relation.trim()).filter(relation => '' !== relation);
+    }
+
+    async fetchCollectionForTemplate(tableName, filtersJson, queryOptionsJson, relationsString)
     {
         let entity = this.dataServer.getEntity(tableName);
         if(!entity){
@@ -399,9 +445,15 @@ class TemplateEngine
             }
         }
         this.applyQueryOptions(entity, queryOptions);
-        let result = filters ? await entity.load(filters) : await entity.loadAll();
+        let relations = this.parseRelationsString(relationsString);
+        let result = 0 < relations.length
+            ? await entity.loadWithRelations(filters || {}, relations)
+            : filters ? await entity.load(filters) : await entity.loadAll();
         this.restoreEntityState(entity, originalState);
-        return result;
+        return this.jsonFieldsParser.parseJsonFields(
+            result,
+            this.jsonFieldsParser.getJsonFieldsForEntity(tableName)
+        );
     }
 
     preserveEntityState(entity)
@@ -440,4 +492,4 @@ class TemplateEngine
 
 }
 
-module.exports.TemplateEngine = TemplateEngine;
+module.exports.TemplateEngine = TemplateEngine;

package/lib/templates-list.js

@@ -18,6 +18,7 @@ module.exports.TemplatesList = {
     sideBarItem: 'sidebar-item.html',
     paginationLink: 'pagination-link.html',
     defaultCopyRight: 'default-copyright.html',
+    cacheCleanButton: 'cache-clean-button.html',
     fields: {
         view: {
             text: 'text.html',

package/migrations/default-homepage.sql

@@ -1,9 +1,11 @@
-
 -- Default homepage:
 
--- Create a default homepage route if not exists
+-- Create a default route first
+REPLACE INTO `routes` (`id`, `path`, `router`, `cache_ttl_seconds`, `enabled`, `created_at`) VALUES (1, '/home', 'cmsPages', 3600, 1, NOW());
+
+-- Create a default homepage with route_id reference
 REPLACE INTO `cms_pages` (
-    `id`, `title`, `content`, `template`, `meta_title`, `meta_description`,
+    `id`, `title`, `content`, `template`, `route_id`, `meta_title`, `meta_description`,
     `canonical_url`, `meta_robots`, `meta_og_title`, `meta_og_description`,
     `meta_og_image`, `meta_twitter_card_type`, `status`, `locale`, `publish_date`, `expire_date`, `created_at`
 ) VALUES (
@@ -11,6 +13,7 @@ REPLACE INTO `cms_pages` (
     'Home',
     '<h1>Welcome to Reldens CMS</h1><p>This is your homepage. Edit this content in the admin panel.</p>',
     NULL,
+    1,
     'Home - Reldens CMS',
     'Welcome to Reldens CMS',
     NULL,
@@ -25,6 +28,3 @@ REPLACE INTO `cms_pages` (
     NULL,
     NOW()
 );
-
--- Create a default route to the homepage
-REPLACE INTO `routes` (`id`, `path`, `router`, `cms_page_id`, `cache_ttl_seconds`, `enabled`, `created_at`) VALUES (1, '/home', 'cmsPages', 1, 3600, 1, NOW());

package/migrations/install.sql

@@ -5,7 +5,6 @@ CREATE TABLE IF NOT EXISTS `routes` (
     `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,
     `path` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
     `router` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
-    `cms_page_id` INT UNSIGNED NOT NULL,
     `cache_ttl_seconds` INT UNSIGNED NULL DEFAULT 3600,
     `enabled` TINYINT UNSIGNED NOT NULL DEFAULT '1',
     `domain` VARCHAR(255) NULL DEFAULT NULL COLLATE 'utf8mb4_unicode_ci',
@@ -32,11 +31,11 @@ CREATE TABLE IF NOT EXISTS `cms_pages` (
     `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,
     `title` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
     `content` LONGTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL,
-    `markdown` LONGTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL,
     `json_data` JSON NULL,
     `template` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL,
     `layout` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL DEFAULT 'default',
     `category_id` INT UNSIGNED NULL DEFAULT NULL,
+    `route_id` INT UNSIGNED NULL DEFAULT NULL,
     `enabled` TINYINT UNSIGNED NOT NULL DEFAULT '1',
     `meta_title` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
     `meta_description` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL,
@@ -55,7 +54,9 @@ CREATE TABLE IF NOT EXISTS `cms_pages` (
     `updated_at` TIMESTAMP NOT NULL DEFAULT (NOW()) ON UPDATE CURRENT_TIMESTAMP,
     PRIMARY KEY (`id`) USING BTREE,
     INDEX `FK_cms_pages_cms_categories` (`category_id`) USING BTREE,
-    CONSTRAINT `FK_cms_pages_cms_categories` FOREIGN KEY (`category_id`) REFERENCES `cms_categories` (`id`) ON UPDATE CASCADE ON DELETE NO ACTION
+    INDEX `FK_cms_pages_routes` (`route_id`) USING BTREE,
+    CONSTRAINT `FK_cms_pages_cms_categories` FOREIGN KEY (`category_id`) REFERENCES `cms_categories` (`id`) ON UPDATE CASCADE ON DELETE NO ACTION,
+    CONSTRAINT `FK_cms_pages_routes` FOREIGN KEY (`route_id`) REFERENCES `routes` (`id`) ON UPDATE CASCADE ON DELETE SET NULL
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS `cms_blocks` (

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/cms",
     "scope": "@reldens",
-    "version": "0.16.0",
+    "version": "0.18.0",
     "description": "Reldens - CMS",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -34,7 +34,7 @@
     },
     "dependencies": {
         "@reldens/server-utils": "^0.19.0",
-        "@reldens/storage": "^0.56.0",
+        "@reldens/storage": "^0.59.0",
         "@reldens/utils": "^0.50.0",
         "dotenv": "^16.5.0",
         "mustache": "^4.2.0"