@reldens/cms 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Damian A. Pastorini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,125 @@
+[![Reldens - GitHub - Release](https://www.dwdeveloper.com/media/reldens/reldens-mmorpg-platform.png)](https://github.com/damian-pastorini/reldens)
+
+# Reldens - CMS
+
+## About
+
+Reldens CMS is a straightforward content management system designed for easy setup and extensibility.
+It provides both an administration panel for content management and a frontend for content delivery.
+
+## Features
+
+- Simple installation process
+- Administration panel for content management
+- Support for multiple database drivers (Prisma, Objection.js)
+- Template-based content rendering
+- SEO-friendly routes and meta data
+- Modular architecture
+
+## Installation
+
+### Option 1: NPX Installation (Recommended)
+
+The easiest way to install Reldens CMS is using NPX:
+
+```bash
+npx @reldens/cms [directory]
+```
+
+This will start the installer in your browser, allowing you to configure your CMS installation.
+
+### Option 2: Manual Installation
+
+1. Install the package:
+
+```bash
+npm install @reldens/cms
+```
+
+2. Create a basic implementation:
+
+```javascript
+const { Manager } = require('@reldens/cms');
+
+const manager = new Manager({
+    projectRoot: './your-project-root',
+    authenticationMethod: 'db-users' // or 'callback'
+});
+
+manager.start().catch(console.error);
+```
+
+## Authentication Methods
+
+Reldens CMS supports two authentication methods:
+
+1. **db-users**: Uses the built-in users table for authentication
+2. **callback**: Use a custom authentication function
+
+Example with custom authentication:
+
+```javascript
+const manager = new Manager({
+    authenticationMethod: 'callback',
+    authenticationCallback: async (email, password, roleId) => {
+        // Your custom authentication logic
+        // Must return a user object or false
+    }
+});
+```
+
+## Extending with Custom Entities
+
+You can extend the CMS with your own entities:
+
+```javascript
+const manager = new Manager({
+    entities: {
+        products: {
+            config: {
+                listProperties: ['id', 'name', 'price', 'status'],
+                showProperties: ['id', 'name', 'price', 'description', 'status', 'created_at'],
+                filterProperties: ['name', 'status'],
+                editProperties: ['name', 'price', 'description', 'status'],
+                properties: {
+                    id: { isId: true },
+                    name: { isRequired: true },
+                    price: { type: 'number', isRequired: true },
+                    description: { type: 'textarea' },
+                    status: { type: 'boolean' },
+                    created_at: { type: 'datetime' }
+                },
+                titleProperty: 'name',
+                navigationPosition: 100
+            }
+        }
+    }
+});
+```
+
+## Templates
+
+Reldens CMS uses templates for rendering content. Templates are stored in the `templates` directory and use Mustache for rendering.
+
+Default templates include:
+- `layout.html`: The main layout template
+- `page.html`: Default page template
+- `404.html`: Not found page
+
+You can create custom templates for different content types or override the default ones.
+
+---
+
+Need something specific?
+
+[Request a feature here: https://www.reldens.com/features-request](https://www.reldens.com/features-request)
+
+## Documentation
+
+[https://www.reldens.com/documentation/cms](https://www.reldens.com/documentation/cms)
+
+---
+
+### [Reldens](https://github.com/damian-pastorini/reldens/ "Reldens")
+
+##### [By DwDeveloper](https://www.dwdeveloper.com/ "DwDeveloper")

package/bin/reldens-cms.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+/**
+ *
+ * Reldens - CMS - CLI Installer
+ *
+ */
+
+const { Manager } = require('../index');
+
+let args = process.argv.slice(2);
+let projectRoot = args[0] || './';
+
+let manager = new Manager({
+    projectRoot
+});
+
+manager.start().catch((error) => {
+    console.error('Failed to start CMS:', error);
+    process.exit(1);
+});

package/index.js

@@ -0,0 +1,15 @@
+/**
+ *
+ * Reldens - CMS - Index
+ *
+ */
+
+const { Manager } = require('./lib/manager');
+const { Installer } = require('./lib/installer');
+const { Storefront } = require('./lib/storefront');
+
+module.exports = {
+    Manager,
+    Installer,
+    Storefront
+};

package/install/css/installer.css

@@ -0,0 +1,117 @@
+/* Installer styles */
+body {
+    font-family: 'Open Sans', sans-serif;
+    line-height: 1.6;
+    color: #333;
+    margin: 0;
+    padding: 0;
+    background-color: #f7f8fa;
+}
+
+.wrapper {
+    max-width: 1000px;
+    margin: 0 auto;
+    padding: 20px;
+}
+
+.header {
+    text-align: center;
+    margin-bottom: 30px;
+}
+
+.title {
+    color: #1a2b49;
+}
+
+.content {
+    background-color: #fff;
+    padding: 30px;
+    border-radius: 8px;
+    box-shadow: 0 2px 10px rgba(0,0,0,0.1);
+}
+
+.form-title {
+    border-bottom: 1px solid #eee;
+    padding-bottom: 10px;
+    margin-top: 30px;
+}
+
+.input-box {
+    margin-bottom: 15px;
+}
+
+label {
+    display: block;
+    margin-bottom: 5px;
+    font-weight: bold;
+}
+
+input[type="text"],
+input[type="password"],
+select {
+    width: 100%;
+    padding: 10px;
+    border: 1px solid #ddd;
+    border-radius: 4px;
+    box-sizing: border-box;
+}
+
+input[type="checkbox"] {
+    margin-right: 10px;
+}
+
+.submit-container {
+    margin-top: 30px;
+    text-align: center;
+}
+
+input[type="submit"] {
+    background-color: #3498db;
+    color: white;
+    padding: 12px 24px;
+    border: none;
+    border-radius: 4px;
+    cursor: pointer;
+    font-size: 16px;
+    font-weight: 600;
+}
+
+input[type="submit"]:hover {
+    background-color: #2980b9;
+}
+
+.error {
+    color: #e74c3c;
+    font-weight: bold;
+    display: none;
+}
+
+.hidden {
+    display: none;
+}
+
+.installation-successful {
+    display: block;
+    text-align: center;
+    font-size: 18px;
+    color: #2ecc71;
+    margin: 20px 0;
+    padding: 15px;
+    background-color: #f1f9f1;
+    border-radius: 4px;
+    text-decoration: none;
+}
+
+.install-loading {
+    width: 24px;
+    height: 24px;
+    margin-right: 10px;
+    vertical-align: middle;
+}
+
+.footer {
+    text-align: center;
+    margin-top: 30px;
+    color: #666;
+    font-size: 14px;
+}

package/install/index.html

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Reldens CMS - Installation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+    <link rel="stylesheet" href="/install-assets/css/installer.css">
+    <script src="/install-assets/js/installer.js"></script>
+</head>
+<body>
+<div class="wrapper">
+    <div class="header">
+        <h1 class="title">
+            <strong>Reldens CMS</strong> - Installation
+        </h1>
+    </div>
+    <div class="content">
+        <div class="forms-container">
+            <div class="row">
+                <form name="install-form" id="install-form" class="install-form" action="/install" method="post">
+                    <h3 class="form-title">- Server Configuration -</h3>
+                    <div class="input-box app-host">
+                        <label for="app-host">Host</label>
+                        <input type="text" name="app-host" id="app-host" value="{{app-host}}" class="required" required/>
+                    </div>
+                    <div class="input-box app-port">
+                        <label for="app-port">Port</label>
+                        <input type="text" name="app-port" id="app-port" value="{{app-port}}" class="required" required/>
+                    </div>
+                    <div class="input-box app-admin-path">
+                        <label for="app-admin-path">Admin Panel Path</label>
+                        <input type="text" name="app-admin-path" id="app-admin-path" value="{{app-admin-path}}"/>
+                    </div>
+                    <div class="input-box app-error">
+                        <p class="error installation-process-failed">There was an error during the installation process.</p>
+                    </div>
+                    <h3 class="form-title">- Database Configuration -</h3>
+                    <div class="db-basic-config-notice">
+                        <span>
+                            Default configuration:
+                            <ul>
+                                <li>Client: mysql2 - Port: 3306</li>
+                                <li>Database Driver: prisma</li>
+                            </ul>
+                        </span>
+                    </div>
+                    <div class="input-box db-storage-driver">
+                        <label for="db-storage-driver">Storage Driver</label>
+                        <select name="db-storage-driver" id="db-storage-driver" class="required" required>
+                            <option value="prisma" selected>Prisma</option>
+                            <option value="objection-js">Objection JS</option>
+                        </select>
+                    </div>
+                    <div class="input-box db-client">
+                        <label for="db-client">Client</label>
+                        <input type="text" name="db-client" id="db-client" value="{{db-client}}" class="required" required/>
+                    </div>
+                    <div class="input-box db-host">
+                        <label for="db-host">Host</label>
+                        <input type="text" name="db-host" id="db-host" value="{{db-host}}" class="required" required/>
+                    </div>
+                    <div class="input-box db-port">
+                        <label for="db-port">Port</label>
+                        <input type="text" name="db-port" id="db-port" value="{{db-port}}" class="required" required/>
+                    </div>
+                    <div class="input-box db-name">
+                        <label for="db-name">Database Name</label>
+                        <input type="text" name="db-name" id="db-name" value="{{db-name}}" class="required" required/>
+                    </div>
+                    <div class="input-box db-username">
+                        <label for="db-username">Username</label>
+                        <input type="text" name="db-username" id="db-username" value="{{db-username}}" class="required" required/>
+                    </div>
+                    <div class="input-box db-password">
+                        <label for="db-password">Password</label>
+                        <input type="password" name="db-password" id="db-password" value="{{db-password}}" class="required" required autocomplete="off"/>
+                    </div>
+                    <div class="input-box db-error">
+                        <p class="error connection-failed">Connection failed, please check the database configuration.</p>
+                        <p class="error invalid-driver">Invalid storage driver.</p>
+                        <p class="error raw-query-not-found">Method "rawQuery" not found in the specified storage driver.</p>
+                        <p class="error sql-file-not-found">SQL installation file not found.</p>
+                        <p class="error db-installation-process-failed">There was an error during the installation process.</p>
+                    </div>
+                    <div class="input-box submit-container">
+                        <img class="install-loading hidden" src="/install-assets/img/loading.gif"/>
+                        <input id="install-submit-button" type="submit" value="Install"/>
+                    </div>
+                    <div class="input-box response-error"></div>
+                </form>
+            </div>
+        </div>
+    </div>
+    <div class="footer">
+        <div class="copyright">
+            &copy; 2025 Reldens CMS
+        </div>
+    </div>
+</div>
+</body>
+</html>

package/install/js/installer.js

@@ -0,0 +1,32 @@
+
+document.addEventListener('DOMContentLoaded', function() {
+    let urlParams = new URL(window.location.href).searchParams;
+    if ('1' === urlParams.get('success')) {
+        document.querySelector('.forms-container').style.display = 'none';
+        let newLink = document.createElement('a');
+        newLink.href = '/';
+        newLink.innerHTML = 'Installation successful, click here to open your CMS!';
+        newLink.classList.add('installation-successful');
+        document.querySelector('.content').append(newLink);
+    }
+
+    let errorCode = (urlParams.get('error') || '').toString();
+    if ('' !== errorCode) {
+        let errorElement = document.querySelector('.' + errorCode);
+        if (errorElement) {
+            errorElement.style.display = 'block';
+        }
+    }
+
+    document.getElementById('install-form').addEventListener('submit', () => {
+        let loadingImage = document.querySelector('.install-loading');
+        if (loadingImage) {
+            loadingImage.classList.remove('hidden');
+        }
+        let installButton = document.getElementById('install-submit-button');
+        if (installButton) {
+            installButton.classList.add('disabled');
+            installButton.disabled = true;
+        }
+    });
+});

package/lib/admin-dist-helper.js

@@ -0,0 +1,56 @@
+/**
+ *
+ * Reldens - AdminDistHelper
+ *
+ */
+
+const { FileHandler } = require('@reldens/server-utils');
+const { Logger, sc } = require('@reldens/utils');
+
+class AdminDistHelper
+{
+
+    static async removeBucketAndDistFiles(distPath, bucket, filesName)
+    {
+        if('string' !== typeof filesName){
+            if(!sc.isArray(filesName)){
+                Logger.error('Undefined files.', distPath, bucket, filesName);
+            }
+            return false;
+        }
+        let files = filesName.split(',');
+        if(0 === files.length){
+            return false;
+        }
+        for(let file of files){
+            FileHandler.remove([bucket, file]);
+            FileHandler.remove([distPath, file]);
+        }
+        return true;
+    }
+
+    static async copyBucketFilesToDist(bucket, filesName, distPath)
+    {
+        if('string' !== typeof filesName){
+            if(!sc.isArray(filesName)){
+                Logger.error('Undefined files.', distPath, bucket, filesName);
+            }
+            return false;
+        }
+        let files = filesName.split(',');
+        if(0 === files.length){
+            return false;
+        }
+        for(let file of files){
+            let result = FileHandler.copyFile([bucket, file], [distPath, file]);
+            if(!result){
+                Logger.error('File copy error.', FileHandler.error);
+                return false;
+            }
+        }
+        return true;
+    }
+
+}
+
+module.exports.AdminDistHelper = AdminDistHelper;

package/lib/admin-entities-generator.js

@@ -0,0 +1,32 @@
+/**
+ *
+ * Reldens - AdminEntitiesGenerator
+ *
+ */
+
+const { Logger } = require('@reldens/utils');
+
+class AdminEntitiesGenerator
+{
+
+    generate(loadedEntities, generatedDrivers)
+    {
+        let rawEntitiesKeys = Object.keys(loadedEntities);
+        let driverEntitiesKeys = Object.keys(generatedDrivers);
+        if(rawEntitiesKeys.length !== driverEntitiesKeys.length){
+            Logger.error('Raw entities and driver entities mismatch.', rawEntitiesKeys, driverEntitiesKeys);
+            return {};
+        }
+        let generatedEntities = {};
+        for(let i of rawEntitiesKeys){
+            generatedEntities[i] = {
+                rawEntity: generatedDrivers[i],
+                config: loadedEntities[i].config
+            }
+        }
+        return generatedEntities;
+    }
+
+}
+
+module.exports.AdminEntitiesGenerator = AdminEntitiesGenerator;

package/lib/admin-manager-validator.js

@@ -0,0 +1,37 @@
+/**
+ *
+ * Reldens - AdminManagerValidator
+ *
+ */
+const { ValidatorInterface, Logger } = require('@reldens/utils');
+
+class AdminManagerValidator extends ValidatorInterface
+{
+
+    validate(adminManager)
+    {
+        let requiredProperties = [
+            'events',
+            'dataServer',
+            'app',
+            'applicationFramework',
+            'renderCallback',
+            'bodyParser',
+            'session',
+            'entities',
+            'adminFilesContents',
+            'mimeTypes',
+            'allowedExtensions'
+        ];
+        for(let propName of requiredProperties){
+            if(!adminManager[propName]){
+                Logger.error('Missing required property in AdminManager:', propName);
+                return false;
+            }
+        }
+        return true
+    }
+
+}
+
+module.exports.AdminManagerValidator = AdminManagerValidator;