cyber-elx 1.0.0

package/ELX_PAGES.md

@@ -0,0 +1,186 @@
+# ELX Custom Pages API Documentation
+
+## Overview
+
+These endpoints allow you to retrieve and update custom ELX (E-Learning Experience) pages. The pages are Liquid templates that can be customized for different sections of the e-learning platform.
+
+---
+
+## Authentication
+
+All endpoints require authentication. You must include the `_token` header in your requests.
+
+**Required Header:**
+
+| Header | Description |
+|--------|-------------|
+| `_token` | Your authentication token |
+
+**Unauthorized Response (403):**
+
+```json
+{
+  "success": false,
+  "message": "Unauthorized"
+}
+```
+
+> **Note:** Only users with `admin` role can access these endpoints.
+
+---
+
+## Endpoints
+
+### 1. Get ELX Pages
+
+Retrieves all custom ELX pages.
+
+**URL:** `GET https://domain_name.com/api/plugin_api/el-x/get_elx_pages`
+
+**Response:**
+
+```json
+{
+  "success": true,
+  "pages": [
+    {
+      "type": "template", // "template" or "section"
+      "key": "home_page",
+      "content": "<!-- Liquid template content -->",
+      "created_at": 123456798,
+      "updated_at": 123456798
+    },
+    {
+      "type": "template", // "template" or "section"
+      "key": "courses_page",
+      "content": "<!-- Liquid template content -->",
+      "created_at": 123456798,
+      "updated_at": 123456798
+    }
+  ]
+}
+```
+
+**Default Page Keys (Templates):**
+
+| Key | Description |
+|-----|-------------|
+| `home_page` | Home page template |
+| `courses_page` | Courses listing page template |
+| `course_page` | Single course page template |
+| `about_page` | About page template |
+| `category_page` | Category page template |
+| `blogs_page` | Blogs listing page template |
+| `blog_page` | Single blog page template |
+| `contact_page` | Contact page template |
+
+- The API may return sections or more pages, so if detected just created them locally, and when updating, update the sections and pages.
+
+---
+
+### 2. Update ELX Pages
+
+Updates one or more custom ELX pages.
+
+**URL:** `POST https://domain_name.com/api/plugin_api/el-x/update_elx_pages`
+
+**Request Body:**
+
+```json
+{
+  "pages": [
+    {
+      "type": "template", // "template" or "section"
+      "key": "home_page",
+      "content": "<!-- Your custom Liquid template -->"
+    },
+    {
+      "type": "template", // "template" or "section"
+      "key": "courses_page",
+      "content": "<!-- Your custom Liquid template -->"
+    }
+  ]
+}
+```
+
+**Allowed Page Keys:**
+
+- `home_page`
+- `courses_page`
+- `course_page`
+- `about_page`
+- `category_page`
+- `blogs_page`
+- `blog_page`
+- `contact_page`
+
+**Response (Success):**
+
+```json
+{
+  "success": true,
+  "message": "Pages updated successfully",
+  "updatedpages": [
+    {
+      "type": "template", // "template" or "section"
+      "key": "home_page",
+      "content": "<!-- Your custom Liquid template -->",
+      "created_at": 123456798,
+      "updated_at": 123456798
+    },
+    ...
+  ]
+}
+```
+
+**Response (No valid pages):**
+
+```json
+{
+  "success": true,
+  "message": "No pages to update, Allowed pages are 0",
+  "updatedpages": []
+}
+```
+
+---
+
+### 3. Get ELX Default Pages (As an example for the user)
+
+Retrieves all default ELX pages.
+
+**URL:** `GET https://domain_name.com/api/plugin_api/el-x/get_defaults_for_elx_pages`
+
+**Response:**
+
+```json
+{
+  "success": true,
+  "pages": [
+    {
+      "type": "template", // "template" or "section"
+      "key": "home_page",
+      "content": "<!-- Liquid template content -->",
+      "created_at": 123456798,
+      "updated_at": 123456798
+    },
+    {
+      "type": "template", // "template" or "section"
+      "key": "courses_page",
+      "content": "<!-- Liquid template content -->",
+      "created_at": 123456798,
+      "updated_at": 123456798
+    }
+  ]
+}
+```
+
+- The API will return all defaults (Defaults may change in the future at any given time)
+
+---
+
+## Behavior Notes
+
+1. **Empty Content:** Pages with empty or whitespace-only content will be skipped during update.
+
+2. **Validation:** Only pages with keys matching the allowed list will be processed. Invalid keys are silently ignored.

package/README.md

@@ -0,0 +1,92 @@
+# cyber-elx
+
+CLI tool to upload/download ELX custom pages (Liquid templates).
+
+## Installation
+
+```bash
+npm install -g .
+# or
+npm link
+```
+
+## Usage
+
+### Initialize a new project
+
+```bash
+cd /path/to/your/project
+cyber-elx init
+```
+
+This will:
+1. Prompt for your website URL and authentication token
+2. Create `cyber-elx.jsonc` config file
+3. Download all pages from the server
+
+### Download pages
+
+```bash
+cyber-elx download
+```
+
+Downloads pages from the server. If local files have been modified, you'll be prompted before overwriting.
+
+Options:
+- `-f, --force` - Force download without confirmation prompts
+
+### Upload pages
+
+```bash
+cyber-elx upload
+```
+
+Uploads local pages to the server. If server pages have been modified since last download, you'll be prompted before overwriting.
+
+Options:
+- `-f, --force` - Force upload without confirmation prompts
+
+## Folder Structure
+
+```
+your-project/
+├── cyber-elx.jsonc     # Config file (url + token)
+├── .cache              # Timestamps cache (auto-generated)
+├── layouts/            # Custom layouts (*.liquid)
+├── sections/           # Custom sections (*.liquid)
+├── templates/          # Custom templates (*.liquid)
+└── defaults/           # Read-only default templates
+    ├── sections/
+    └── templates/
+```
+
+## Config File
+
+The `cyber-elx.jsonc` file contains your website URL and authentication token:
+
+```jsonc
+{
+  // ELX Custom Pages Configuration
+  "url": "https://my-website.net",
+  "token": "your-auth-token"
+}
+```
+
+## Default Templates
+
+The `defaults/` folder contains read-only copies of the default templates. Use these as reference when creating your custom pages. If a custom page is empty, the default will be used automatically by the server.
+
+## Available Page Keys
+
+### Templates
+- `home_page` - Home page
+- `courses_page` - Courses listing
+- `course_page` - Single course
+- `about_page` - About page
+- `category_page` - Category page
+- `blogs_page` - Blogs listing
+- `blog_page` - Single blog
+- `contact_page` - Contact page
+
+### Sections
+Additional sections may be available depending on your server configuration.

package/bin/cyber-elx.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../src/index.js');

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "cyber-elx",
+  "version": "1.0.0",
+  "description": "CLI tool to upload/download ELX custom pages",
+  "main": "src/index.js",
+  "bin": {
+    "cyber-elx": "./bin/cyber-elx.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "elx",
+    "cli",
+    "liquid",
+    "templates"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "inquirer": "^8.2.6",
+    "jsonc-parser": "^3.2.0"
+  }
+}

package/src/api.js

@@ -0,0 +1,35 @@
+const axios = require('axios');
+
+function createApiClient(config) {
+  const client = axios.create({
+    baseURL: config.url,
+    headers: {
+      '_token': config.token,
+      'Content-Type': 'application/json'
+    }
+  });
+
+  return {
+    async getPages() {
+      const response = await client.get('/api/plugin_api/el-x/get_elx_pages');
+      return response.data;
+    },
+
+    async updatePages(pages) {
+      try {
+        const response = await client.post('/api/plugin_api/el-x/update_elx_pages', { pages });
+        return response.data;
+      } catch (error) {
+        console.error(error);
+        throw error;
+      }
+    },
+
+    async getDefaultPages() {
+      const response = await client.get('/api/plugin_api/el-x/get_defaults_for_elx_pages');
+      return response.data;
+    }
+  };
+}
+
+module.exports = { createApiClient };

package/src/cache.js

@@ -0,0 +1,53 @@
+const fs = require('fs');
+const path = require('path');
+
+const CACHE_FILE = '.cache';
+
+function getCachePath(cwd = process.cwd()) {
+  return path.join(cwd, CACHE_FILE);
+}
+
+function readCache(cwd = process.cwd()) {
+  const cachePath = getCachePath(cwd);
+  if (!fs.existsSync(cachePath)) {
+    return { pages: {} };
+  }
+  try {
+    const content = fs.readFileSync(cachePath, 'utf-8');
+    return JSON.parse(content);
+  } catch (e) {
+    return { pages: {} };
+  }
+}
+
+function writeCache(cache, cwd = process.cwd()) {
+  const cachePath = getCachePath(cwd);
+  fs.writeFileSync(cachePath, JSON.stringify(cache, null, 2), 'utf-8');
+}
+
+function getPageCacheKey(type, key) {
+  return `${type}:${key}`;
+}
+
+function getPageTimestamp(cache, type, key) {
+  const cacheKey = getPageCacheKey(type, key);
+  return cache.pages[cacheKey]?.updated_at || null;
+}
+
+function setPageTimestamp(cache, type, key, updated_at) {
+  const cacheKey = getPageCacheKey(type, key);
+  if (!cache.pages) {
+    cache.pages = {};
+  }
+  cache.pages[cacheKey] = { updated_at };
+}
+
+module.exports = {
+  CACHE_FILE,
+  getCachePath,
+  readCache,
+  writeCache,
+  getPageCacheKey,
+  getPageTimestamp,
+  setPageTimestamp
+};

package/src/config.js

@@ -0,0 +1,57 @@
+const fs = require('fs');
+const path = require('path');
+const jsonc = require('jsonc-parser');
+
+const CONFIG_FILE = 'cyber-elx.jsonc';
+
+function getConfigPath(cwd = process.cwd()) {
+  return path.join(cwd, CONFIG_FILE);
+}
+
+function configExists(cwd = process.cwd()) {
+  return fs.existsSync(getConfigPath(cwd));
+}
+
+function readConfig(cwd = process.cwd()) {
+  const configPath = getConfigPath(cwd);
+  if (!fs.existsSync(configPath)) {
+    return null;
+  }
+  const content = fs.readFileSync(configPath, 'utf-8');
+  return jsonc.parse(content);
+}
+
+function writeConfig(config, cwd = process.cwd()) {
+  const configPath = getConfigPath(cwd);
+  const content = `{
+  // ELX Custom Pages Configuration
+  // URL of your website (without trailing slash)
+  "url": "${config.url}",
+  // Authentication token (get from admin panel)
+  "token": "${config.token}"
+}
+`;
+  fs.writeFileSync(configPath, content, 'utf-8');
+}
+
+function validateConfig(config) {
+  if (!config) {
+    return { valid: false, error: 'Config file not found. Run "cyber-elx init" first.' };
+  }
+  if (!config.url) {
+    return { valid: false, error: 'Missing "url" in config file.' };
+  }
+  if (!config.token) {
+    return { valid: false, error: 'Missing "token" in config file.' };
+  }
+  return { valid: true };
+}
+
+module.exports = {
+  CONFIG_FILE,
+  getConfigPath,
+  configExists,
+  readConfig,
+  writeConfig,
+  validateConfig
+};

package/src/files.js

@@ -0,0 +1,114 @@
+const fs = require('fs');
+const path = require('path');
+
+const DEFAULT_TEMPLATE_KEYS = [
+  'home_page',
+  'courses_page',
+  'course_page',
+  'about_page',
+  'category_page',
+  'blogs_page',
+  'blog_page',
+  'contact_page'
+];
+
+function ensureDirectories(cwd = process.cwd()) {
+  const dirs = [
+    path.join(cwd, 'sections'),
+    path.join(cwd, 'templates'),
+    path.join(cwd, 'layouts'),
+    path.join(cwd, 'defaults', 'sections'),
+    path.join(cwd, 'defaults', 'templates'),
+    path.join(cwd, 'defaults', 'layouts')
+  ];
+  for (const dir of dirs) {
+    if (!fs.existsSync(dir)) {
+      fs.mkdirSync(dir, { recursive: true });
+    }
+  }
+}
+
+function getFolder(type) {
+  if (type === 'template') return 'templates';
+  if (type === 'section') return 'sections';
+  if (type === 'layout') return 'layouts';
+  return type + 's';
+}
+
+function getFilePath(type, key, cwd = process.cwd(), isDefault = false) {
+  const folder = getFolder(type);
+  if (isDefault) {
+    return path.join(cwd, 'defaults', folder, `${key}.liquid`);
+  }
+  return path.join(cwd, folder, `${key}.liquid`);
+}
+
+function readPageFile(type, key, cwd = process.cwd()) {
+  const filePath = getFilePath(type, key, cwd);
+  if (!fs.existsSync(filePath)) {
+    return null;
+  }
+  return fs.readFileSync(filePath, 'utf-8');
+}
+
+function writePageFile(type, key, content, cwd = process.cwd(), isDefault = false) {
+  const filePath = getFilePath(type, key, cwd, isDefault);
+  const dir = path.dirname(filePath);
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+  fs.writeFileSync(filePath, content, 'utf-8');
+}
+
+function fileExists(type, key, cwd = process.cwd()) {
+  const filePath = getFilePath(type, key, cwd);
+  return fs.existsSync(filePath);
+}
+
+function getLocalPages(cwd = process.cwd()) {
+  const pages = [];
+  
+  const templatesDir = path.join(cwd, 'templates');
+  const sectionsDir = path.join(cwd, 'sections');
+  const layoutsDir = path.join(cwd, 'layouts');
+  
+  if (fs.existsSync(templatesDir)) {
+    const files = fs.readdirSync(templatesDir).filter(f => f.endsWith('.liquid'));
+    for (const file of files) {
+      const key = file.replace('.liquid', '');
+      const content = fs.readFileSync(path.join(templatesDir, file), 'utf-8');
+      pages.push({ type: 'template', key, content });
+    }
+  }
+  
+  if (fs.existsSync(sectionsDir)) {
+    const files = fs.readdirSync(sectionsDir).filter(f => f.endsWith('.liquid'));
+    for (const file of files) {
+      const key = file.replace('.liquid', '');
+      const content = fs.readFileSync(path.join(sectionsDir, file), 'utf-8');
+      pages.push({ type: 'section', key, content });
+    }
+  }
+  
+  if (fs.existsSync(layoutsDir)) {
+    const files = fs.readdirSync(layoutsDir).filter(f => f.endsWith('.liquid'));
+    for (const file of files) {
+      const key = file.replace('.liquid', '');
+      const content = fs.readFileSync(path.join(layoutsDir, file), 'utf-8');
+      pages.push({ type: 'layout', key, content });
+    }
+  }
+  
+  return pages;
+}
+
+module.exports = {
+  DEFAULT_TEMPLATE_KEYS,
+  ensureDirectories,
+  getFolder,
+  getFilePath,
+  readPageFile,
+  writePageFile,
+  fileExists,
+  getLocalPages
+};