aegis-framework 0.1.0

package/aegis/runtime/aegis-api.js

@@ -0,0 +1,519 @@
+/**
+ * Aegis JavaScript API
+ * 
+ * This file is injected into WebKit2GTK and provides the bridge
+ * between your frontend JavaScript and the Python backend.
+ * 
+ * @version 0.1.0
+ */
+
+(function () {
+    'use strict';
+
+    // ==================== Internal Bridge ====================
+
+    let callbackId = 0;
+    const pendingCallbacks = new Map();
+
+    /**
+     * Resolve a callback from Python
+     */
+    window.__aegisResolve = function (response) {
+        const callback = pendingCallbacks.get(response.callbackId);
+        if (callback) {
+            pendingCallbacks.delete(response.callbackId);
+            if (response.success) {
+                callback.resolve(response.data);
+            } else {
+                callback.reject(new Error(response.error));
+            }
+        }
+    };
+
+    /**
+     * Send a message to Python backend
+     */
+    function invoke(action, payload = {}) {
+        return new Promise((resolve, reject) => {
+            const id = ++callbackId;
+            pendingCallbacks.set(id, { resolve, reject });
+
+            const message = JSON.stringify({
+                action: action,
+                payload: payload,
+                callbackId: id
+            });
+
+            // Send to Python via WebKit message handler
+            if (window.webkit && window.webkit.messageHandlers && window.webkit.messageHandlers.aegis) {
+                window.webkit.messageHandlers.aegis.postMessage(message);
+            } else {
+                reject(new Error('Aegis bridge not available'));
+            }
+        });
+    }
+
+    /**
+     * Check if an API is allowed by preload
+     */
+    function isAllowed(api) {
+        const allowed = window.__aegisAllowedAPIs || ['*'];
+        if (allowed.includes('*')) return true;
+        if (allowed.includes(api)) return true;
+
+        // Check namespace (e.g., 'dialog' allows 'dialog.open')
+        const namespace = api.split('.')[0];
+        return allowed.includes(namespace);
+    }
+
+    /**
+     * Create a guarded API function
+     */
+    function guardedInvoke(action) {
+        return function (payload) {
+            if (!isAllowed(action)) {
+                return Promise.reject(new Error(`API '${action}' is not allowed by preload`));
+            }
+            return invoke(action, payload);
+        };
+    }
+
+    // ==================== Public Aegis API ====================
+
+    const Aegis = {
+        /**
+         * Read file or directory contents
+         * 
+         * @example
+         * // Read a file
+         * const result = await Aegis.read({ path: '/home/user', file: 'data.txt' });
+         * console.log(result.content);
+         * 
+         * // List directory
+         * const dir = await Aegis.read({ path: '/home/user/documents' });
+         * console.log(dir.entries);
+         */
+        read: guardedInvoke('read'),
+
+        /**
+         * Write content to a file
+         * 
+         * @example
+         * await Aegis.write({
+         *     path: '/home/user',
+         *     file: 'output.txt',
+         *     content: 'Hello, World!'
+         * });
+         * 
+         * // Append to file
+         * await Aegis.write({
+         *     path: '/home/user',
+         *     file: 'log.txt',
+         *     content: 'New line\n',
+         *     append: true
+         * });
+         */
+        write: guardedInvoke('write'),
+
+        /**
+         * Execute Python or shell commands
+         * 
+         * @example
+         * // Run shell command
+         * const result = await Aegis.run({ sh: 'ls -la' });
+         * console.log(result.output);
+         * 
+         * // Run Python code
+         * const pyResult = await Aegis.run({ py: '2 + 2' });
+         * console.log(pyResult.output); // "4"
+         */
+        run: guardedInvoke('run'),
+
+        /**
+         * Check if file/directory exists
+         * 
+         * @example
+         * const info = await Aegis.exists({ path: '/home/user/file.txt' });
+         * if (info.exists && info.isFile) {
+         *     console.log('File exists!');
+         * }
+         */
+        exists: guardedInvoke('exists'),
+
+        /**
+         * Create directory
+         * 
+         * @example
+         * await Aegis.mkdir({ path: '/home/user/new-folder', recursive: true });
+         */
+        mkdir: guardedInvoke('mkdir'),
+
+        /**
+         * Remove file or directory
+         * 
+         * @example
+         * await Aegis.remove({ path: '/home/user/old-file.txt' });
+         * 
+         * // Remove directory recursively
+         * await Aegis.remove({ path: '/home/user/old-folder', recursive: true });
+         */
+        remove: guardedInvoke('remove'),
+
+        /**
+         * Copy file or directory
+         * 
+         * @example
+         * await Aegis.copy({
+         *     src: '/home/user/file.txt',
+         *     dest: '/home/user/backup/file.txt'
+         * });
+         */
+        copy: guardedInvoke('copy'),
+
+        /**
+         * Move/rename file or directory
+         * 
+         * @example
+         * await Aegis.move({
+         *     src: '/home/user/old-name.txt',
+         *     dest: '/home/user/new-name.txt'
+         * });
+         */
+        move: guardedInvoke('move'),
+
+        /**
+         * Get/set environment variables
+         * 
+         * @example
+         * // Get single variable
+         * const home = await Aegis.env({ name: 'HOME' });
+         * 
+         * // Set variable
+         * await Aegis.env({ name: 'MY_VAR', value: 'hello' });
+         * 
+         * // Get all variables
+         * const allEnv = await Aegis.env({});
+         */
+        env: guardedInvoke('env'),
+
+        // ==================== Dialog API ====================
+
+        dialog: {
+            /**
+             * Open file dialog
+             * 
+             * @example
+             * const result = await Aegis.dialog.open({
+             *     title: 'Select Files',
+             *     multiple: true,
+             *     filters: [
+             *         { name: 'Images', extensions: ['png', 'jpg', 'gif'] },
+             *         { name: 'All Files', extensions: ['*'] }
+             *     ]
+             * });
+             * console.log(result.path);
+             */
+            open: guardedInvoke('dialog.open'),
+
+            /**
+             * Save file dialog
+             * 
+             * @example
+             * const result = await Aegis.dialog.save({
+             *     title: 'Save As',
+             *     defaultName: 'document.txt'
+             * });
+             * if (result.path) {
+             *     await Aegis.write({ path: result.path, content: 'Content' });
+             * }
+             */
+            save: guardedInvoke('dialog.save'),
+
+            /**
+             * Show message dialog
+             * 
+             * @example
+             * // Info dialog
+             * await Aegis.dialog.message({
+             *     type: 'info',
+             *     title: 'Success',
+             *     message: 'Operation completed!'
+             * });
+             * 
+             * // Confirmation dialog
+             * const confirm = await Aegis.dialog.message({
+             *     type: 'question',
+             *     title: 'Confirm',
+             *     message: 'Are you sure?',
+             *     buttons: 'yesno'
+             * });
+             * if (confirm.response) {
+             *     // User clicked Yes
+             * }
+             */
+            message: guardedInvoke('dialog.message')
+        },
+
+        // ==================== App Control API ====================
+
+        app: {
+            /**
+             * Quit the application
+             */
+            quit: guardedInvoke('app.quit'),
+
+            /**
+             * Minimize the window
+             */
+            minimize: guardedInvoke('app.minimize'),
+
+            /**
+             * Toggle maximize
+             */
+            maximize: guardedInvoke('app.maximize'),
+
+            /**
+             * Get system paths
+             * 
+             * @example
+             * const home = await Aegis.app.getPath({ name: 'home' });
+             * const downloads = await Aegis.app.getPath({ name: 'downloads' });
+             * 
+             * // Available: home, desktop, documents, downloads, music, pictures, videos, temp, app
+             */
+            getPath: guardedInvoke('app.getPath')
+        },
+
+        // ==================== Window Control API ====================
+
+        window: {
+            /**
+             * Make an element draggable for window movement
+             * Call this on mousedown of your titlebar element
+             * 
+             * @example
+             * // In your HTML: <div class="titlebar" id="titlebar">...</div>
+             * // In your JS:
+             * document.getElementById('titlebar').addEventListener('mousedown', (e) => {
+             *     if (e.target.closest('.titlebar-btn')) return; // Don't drag on buttons
+             *     Aegis.window.startDrag();
+             * });
+             */
+            startDrag: guardedInvoke('window.startDrag'),
+
+            /**
+             * Start window resize from edge
+             * 
+             * @param {string} edge - Edge to resize from: n, s, e, w, ne, nw, se, sw
+             * 
+             * @example
+             * // Create resize handles in your CSS/HTML, then:
+             * document.querySelector('.resize-se').addEventListener('mousedown', () => {
+             *     Aegis.window.resize({ edge: 'se' });
+             * });
+             */
+            resize: guardedInvoke('window.resize'),
+
+            /**
+             * Set window size
+             * 
+             * @example
+             * await Aegis.window.setSize({ width: 1024, height: 768 });
+             */
+            setSize: guardedInvoke('window.setSize'),
+
+            /**
+             * Get current window size
+             * 
+             * @example
+             * const { width, height } = await Aegis.window.getSize();
+             */
+            getSize: guardedInvoke('window.getSize'),
+
+            /**
+             * Set window position
+             * 
+             * @example
+             * await Aegis.window.setPosition({ x: 100, y: 100 });
+             */
+            setPosition: guardedInvoke('window.setPosition'),
+
+            /**
+             * Get current window position
+             * 
+             * @example
+             * const { x, y } = await Aegis.window.getPosition();
+             */
+            getPosition: guardedInvoke('window.getPosition'),
+
+            /**
+             * Helper: Setup moveBar on an element
+             * Makes the specified element a drag handle for the window
+             * 
+             * @param {string|Element} selector - CSS selector or element
+             * @param {Object} options - Options
+             * @param {string} options.exclude - Selector for elements that should NOT trigger drag
+             * 
+             * @example
+             * // Make titlebar draggable, but not buttons
+             * Aegis.window.moveBar('#titlebar', { exclude: '.titlebar-btn' });
+             */
+            moveBar: function (selector, options = {}) {
+                const element = typeof selector === 'string'
+                    ? document.querySelector(selector)
+                    : selector;
+
+                if (!element) {
+                    console.warn('[Aegis] moveBar: Element not found:', selector);
+                    return;
+                }
+
+                element.addEventListener('mousedown', (e) => {
+                    // Only left mouse button
+                    if (e.button !== 0) return;
+
+                    // Check if click is on excluded element
+                    if (options.exclude && e.target.closest(options.exclude)) {
+                        console.log('[Aegis] moveBar: excluded element clicked');
+                        return;
+                    }
+
+                    console.log('[Aegis] moveBar: starting drag at', e.screenX, e.screenY);
+
+                    // Start window drag with screen coordinates
+                    Aegis.window.startDrag({
+                        x: e.screenX,
+                        y: e.screenY,
+                        button: e.button + 1  // GTK uses 1-based buttons
+                    }).then(r => console.log('[Aegis] startDrag result:', r))
+                        .catch(err => console.error('[Aegis] startDrag error:', err));
+                });
+
+                console.log('[Aegis] moveBar attached to:', selector);
+            },
+
+            /**
+             * Helper: Setup resize handles on elements
+             * 
+             * @param {Object} handles - Map of selector to edge
+             * 
+             * @example
+             * Aegis.window.resizeHandles({
+             *     '.resize-n': 'n',
+             *     '.resize-s': 's',
+             *     '.resize-e': 'e',
+             *     '.resize-w': 'w',
+             *     '.resize-ne': 'ne',
+             *     '.resize-nw': 'nw',
+             *     '.resize-se': 'se',
+             *     '.resize-sw': 'sw'
+             * });
+             */
+            resizeHandles: function (handles) {
+                for (const [selector, edge] of Object.entries(handles)) {
+                    const element = document.querySelector(selector);
+                    if (element) {
+                        element.addEventListener('mousedown', (e) => {
+                            if (e.button !== 0) return;
+                            Aegis.window.resize({
+                                edge,
+                                x: e.screenX,
+                                y: e.screenY,
+                                button: e.button + 1
+                            });
+                        });
+                    }
+                }
+                console.log('[Aegis] Resize handles attached');
+            }
+        },
+
+        // ==================== Configuration API ====================
+
+        /**
+         * Expose specific APIs (used in preload.js)
+         * 
+         * @example
+         * Aegis.expose(['read', 'write', 'dialog']);
+         */
+        expose: function (apis) {
+            window.__aegisAllowedAPIs = apis;
+        },
+
+        /**
+         * Expose all APIs (use with caution!)
+         */
+        exposeAll: function () {
+            window.__aegisAllowedAPIs = ['*'];
+        },
+
+        /**
+         * Configure Aegis behavior
+         * 
+         * @example
+         * Aegis.config({
+         *     allowRemoteContent: false,
+         *     enableDevTools: true
+         * });
+         */
+        config: function (options) {
+            window.__aegisConfig = { ...window.__aegisConfig, ...options };
+        },
+
+        /**
+         * Register a custom handler (for custom Python actions)
+         * 
+         * @example
+         * // In preload.js:
+         * Aegis.handle('customAction', async (data) => {
+         *     return await Aegis.run({ py: `custom_function(${data.value})` });
+         * });
+         * 
+         * // In your app:
+         * const result = await Aegis.invoke('customAction', { value: 42 });
+         */
+        handle: function (name, handler) {
+            Aegis._customHandlers = Aegis._customHandlers || {};
+            Aegis._customHandlers[name] = handler;
+        },
+
+        /**
+         * Invoke a custom handler or built-in action
+         */
+        invoke: async function (action, payload) {
+            // Check for custom handler first
+            if (Aegis._customHandlers && Aegis._customHandlers[action]) {
+                return await Aegis._customHandlers[action](payload);
+            }
+            // Fall back to built-in
+            return invoke(action, payload);
+        },
+
+        // ==================== Utility Functions ====================
+
+        /**
+         * Version of Aegis
+         */
+        version: '0.1.0',
+
+        /**
+         * Check if running in Aegis environment
+         */
+        isAegis: function () {
+            return !!(window.webkit && window.webkit.messageHandlers && window.webkit.messageHandlers.aegis);
+        }
+    };
+
+    // ==================== Expose to Window ====================
+
+    // Make Aegis available globally
+    window.Aegis = Aegis;
+
+    // Also expose as module if applicable
+    if (typeof module !== 'undefined' && module.exports) {
+        module.exports = Aegis;
+    }
+
+    console.log('%c⚡ Aegis v' + Aegis.version + ' loaded', 'color: #00ff88; font-weight: bold;');
+
+})();

package/aegis-cli.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+"""
+Aegis CLI Entry Point
+
+Run with: python aegis-cli.py [command]
+Or make executable: chmod +x aegis-cli.py && ./aegis-cli.py [command]
+"""
+
+import sys
+import os
+
+# Add aegis to path
+sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
+
+from aegis.cli.cli import main
+
+if __name__ == '__main__':
+    main()

package/bin/aegis

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+/**
+ * Aegis CLI - npm wrapper
+ * 
+ * This wrapper calls the Python CLI directly, ensuring proper
+ * PYTHONPATH configuration for the installed package.
+ */
+
+const { spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+// Get the directory where aegis is installed
+const aegisDir = path.join(__dirname, '..');
+const cliPath = path.join(aegisDir, 'aegis-cli.py');
+
+// Check if Python is available
+function getPythonCommand() {
+    const pythons = ['python3', 'python'];
+    for (const cmd of pythons) {
+        try {
+            require('child_process').execSync(`${cmd} --version`, { stdio: 'ignore' });
+            return cmd;
+        } catch (e) {
+            continue;
+        }
+    }
+    return null;
+}
+
+// Check for system dependencies
+function checkDependencies() {
+    const python = getPythonCommand();
+    if (!python) {
+        console.error('\x1b[31m❌ Python 3 not found!\x1b[0m');
+        console.error('   Please install Python 3: sudo apt install python3');
+        process.exit(1);
+    }
+    
+    // Check for GTK/WebKit on Linux (only for dev/run commands)
+    const command = process.argv[2];
+    if (['dev', 'run'].includes(command)) {
+        try {
+            require('child_process').execSync(
+                `${python} -c "import gi; gi.require_version('WebKit2', '4.1')"`,
+                { stdio: 'ignore' }
+            );
+        } catch (e) {
+            console.error('\x1b[33m⚠️  WebKit2GTK not found!\x1b[0m');
+            console.error('   Install with: sudo apt install python3-gi gir1.2-webkit2-4.1');
+            console.error('');
+        }
+    }
+    
+    return python;
+}
+
+// Main execution
+const python = checkDependencies();
+
+// Set PYTHONPATH to include aegis modules
+const env = { ...process.env };
+env.PYTHONPATH = aegisDir + (env.PYTHONPATH ? `:${env.PYTHONPATH}` : '');
+
+// Forward arguments to Python CLI
+const args = [cliPath, ...process.argv.slice(2)];
+
+const child = spawn(python, args, {
+    stdio: 'inherit',
+    env: env,
+    cwd: process.cwd()
+});
+
+child.on('error', (err) => {
+    console.error(`\x1b[31m❌ Failed to start Aegis: ${err.message}\x1b[0m`);
+    process.exit(1);
+});
+
+child.on('close', (code) => {
+    process.exit(code || 0);
+});

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "aegis-framework",
+    "version": "0.1.0",
+    "description": "Lightweight AppImage framework using WebKit2GTK and Python - An alternative to Electron that creates ~200KB apps instead of 150MB!",
+    "keywords": [
+        "appimage",
+        "electron-alternative",
+        "webkit",
+        "webkit2gtk",
+        "gtk",
+        "python",
+        "linux",
+        "desktop",
+        "desktop-app",
+        "framework",
+        "lightweight"
+    ],
+    "author": "Diego",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Diegopam/aegis-framework"
+    },
+    "homepage": "https://github.com/Diegopam/aegis-framework#readme",
+    "bugs": {
+        "url": "https://github.com/Diegopam/aegis-framework/issues"
+    },
+    "bin": {
+        "aegis": "./bin/aegis"
+    },
+    "files": [
+        "bin/",
+        "aegis/",
+        "aegis-cli.py",
+        "README.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "test": "echo 'Check dependencies...' && python3 --version",
+        "postinstall": "echo '⚡ Aegis installed! Run: aegis init my-app'"
+    },
+    "os": [
+        "linux"
+    ],
+    "cpu": [
+        "x64"
+    ],
+    "engines": {
+        "node": ">=14"
+    }
+}