xynginc 1.0.82 → 1.0.85

package/README.md

@@ -4,13 +4,19 @@ This project uses code developed by NEHONIX (www.nehonix.com) under the NEHONIX
 
 XyPriss Nginx Controller - Simplifie la gestion de Nginx et SSL.
 
-[![npm version](https://badge.fury.io/js/%40xypriss%2Fxynginc.svg)](https://www.npmjs.com/package/xynginc)
+[![xfpm version](https://badge.fury.io/js/%40xypriss%2Fxynginc.svg)](https://www.npmjs.com/package/xynginc)
 [![License: NOSL](https://img.shields.io/badge/License-NOSL-blue.svg)](https://dll.nehonix.com/licenses/NOSL)
 
 ## Overview
 
 XyNginC (XyPriss Nginx Controller) automates Nginx reverse proxy configuration, SSL certificate management, and provides optimized, production-ready configs for security, performance, and best practices. It eliminates manual Nginx editing, simplifying XyPriss deployment to just a few lines of TypeScript. Check out the [demo project on GitHub](https://github.com/iDevo-ll/XYNC-Demo).
 
+> [!IMPORTANT]
+> XyNginC is a plugin **exclusively designed for XyPriss projects**. It is not intended for use outside the XyPriss ecosystem, in development environments, or on non-Linux systems. For the best integration experience, **XFPM** (XyPriss Fast Package Manager) is required — see [Installation](#installation).
+
+> [!CAUTION]
+> XyNginC only runs on **Linux production servers** (VPS or Dedicated). Supported architectures: **x64**, **arm64**, and **ia32**. Windows and macOS are not supported.
+
 ## Key Features
 
 - **Automated Reverse Proxy**: Maps domains to local ports seamlessly.
@@ -26,7 +32,28 @@ XyNginC (XyPriss Nginx Controller) automates Nginx reverse proxy configuration,
 For detailed installation instructions, please refer to the [Installation Guide](docs/INSTALLATION.md).
 For building from source (custom architectures), see the [Build Guide](docs/BUILD_FROM_SOURCE.md).
 
-XyNginC is designed for production environments running on Linux. We strongly recommend using Ubuntu on a Virtual Private Server (VPS) for the best security and stability.
+XyNginC is exclusively designed for **XyPriss projects running in production on Linux**. We strongly recommend using Ubuntu on a Virtual Private Server (VPS) for the best security and stability.
+
+### Prerequisites
+
+Before installing XyNginC, you need **XFPM** — the official package manager for the XyPriss ecosystem.
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/Nehonix-Team/XFPM/master/scripts/install.sh | sudo bash
+```
+
+```bash
+xfpm --version
+```
+
+### Install XyNginC
+
+```bash
+xfpm install xynginc
+```
+
+> [!NOTE]
+> The installation requires `sudo` privileges to place the binary in `/usr/local/bin` and configure system permissions.
 
 ## Quick Start
 
@@ -92,7 +119,7 @@ XNCP({
 Manage domains programmatically at runtime:
 
 ```typescript
-app.start(undefined, async () => {
+app.start(async () => {
   // Add a new domain
   await app.xynginc.addDomain(
     "new.example.com",
@@ -181,7 +208,7 @@ await server.xynginc.status(): Promise<string>
 
 ## CLI Usage
 
-The `xynginc` command-line interface allows for direct management without the Node.js application context.
+The `xynginc` command-line interface allows for direct management without the XyPriss application context.
 
 ```bash
 # Check prerequisites
@@ -230,9 +257,9 @@ sudo xynginc status
 
 The system operates through a three-tier architecture:
 
-1.  **XyPriss Application**: The Node.js application running the server.
-2.  **XyNginC Plugin**: A TypeScript wrapper that interfaces with the application and executes the underlying Go binary.
-3.  **XyNginC Go Binary**: A high-performance Go-based CLI tool that performs system-level operations (Nginx configuration, Certbot execution). It dynamically fetches the latest config templates from GitHub (`Nehonix-Team/xynginc`) to guarantee up-to-date and optimized Nginx setups.
+1. **XyPriss Application**: The XyPriss application running the server.
+2. **XyNginC Plugin**: A TypeScript wrapper that interfaces with the application and executes the underlying Go binary.
+3. **XyNginC Go Binary**: A high-performance Go-based CLI tool that performs system-level operations (Nginx configuration, Certbot execution). It dynamically fetches the latest config templates from GitHub (`Nehonix-Team/xynginc`) to guarantee up-to-date and optimized Nginx setups.
 
 ## Security Considerations
 
@@ -243,7 +270,8 @@ XyNginC requires elevated privileges to perform the following actions:
 - Executing `certbot` for SSL certificate generation
 - Reloading the Nginx service
 
-**Security Note**: XyNginC requires elevated privileges to manage Nginx and Firewall rules.
+> [!WARNING]
+> XyNginC requires elevated privileges to manage Nginx and firewall rules. Always review the commands being executed and restrict sudo access to only what is necessary.
 
 - **Sudoers**: We recommend configuring `sudoers` to allow specific commands for the user.
 - **Sudo Password**: If your application runs in the background (e.g. using PM2), you can use the `sudoPassword` option or the `SUDO_PASSWORD` environment variable.
@@ -257,8 +285,8 @@ XyNginC requires elevated privileges to perform the following actions:
 If the binary fails to download automatically:
 
 ```bash
-# Manually trigger postinstall
-npm run postinstall
+# Manually trigger with XFPM
+xfpm run postinstall
 
 # Or specify the path manually in options
 XNCP({
@@ -280,21 +308,25 @@ sudo node server.js
 
 If SSL generation fails:
 
-1.  Verify DNS propagation: `dig api.example.com`
-2.  Ensure firewall allows traffic on ports 80 and 443:
-    ```bash
-    sudo ufw allow 80
-    sudo ufw allow 443
-    ```
+1. Verify DNS propagation: `dig api.example.com`
+2. Ensure firewall allows traffic on ports 80 and 443:
+
+```bash
+sudo ufw allow 80
+sudo ufw allow 443
+```
+
+> [!NOTE]
+> Certbot requires ports 80 and 443 to be publicly accessible for domain validation. Make sure your cloud provider's security groups also allow this traffic, not just UFW.
 
 ## Contributing
 
 Contributions are welcome. Please follow the standard pull request process.
 
-1.  Clone the repository
-2.  Install dependencies
-3.  Build the Go CLI and TypeScript package (`xfpm run build:all`)
-4.  Run tests
+1. Clone the repository
+2. Install dependencies
+3. Build the Go CLI and TypeScript package (`xfpm run build:all`)
+4. Run tests
 
 ## License
 

package/dist/index.d.ts

@@ -1,4 +1,7 @@
+import { Plugin } from "xypriss";
 import { XyNginCConfig, XyNginCDomainConfig, XyNginCPluginOptions } from "./types";
+export type PlC = Parameters<typeof Plugin.create>[0];
+export type PluginServer = Parameters<NonNullable<PlC["onServerStart"]>>[0];
 /**
  * XyNginC Plugin for XyPriss.
  * Automates Nginx and SSL management for your server.

package/dist/index.js

@@ -4,8 +4,8 @@
  * Licensed under NEHONIX Open Source License (NOSL) v1.0
  */
 import { Plugin } from "xypriss";
-import { Logger } from "./logger";
-import { validateConfig } from "./validateConfig";
+import { Logger } from "./mods/logger";
+import { validateConfig } from "./mods/validateConfig";
 import { startXNCPlugin } from "./startPlugin";
 /**
  * XyNginC Plugin for XyPriss.
@@ -16,11 +16,11 @@ import { startXNCPlugin } from "./startPlugin";
  */
 export default function XNCP(options) {
     const { domains, autoReload = true, autoFixFirewall = false, binaryPath, autoDownload = true, version = "latest", installRequirements = true, sudoPassword, } = options;
-    const meta = Plugin.manifest(__sys__);
+    const pkg = Plugin.manifest(__sys__);
     return Plugin.create({
-        name: meta.name,
-        version: meta.version,
-        description: meta.description,
+        name: pkg.name,
+        version: pkg.version,
+        description: pkg.description,
         onRegister: async (_server) => {
             Logger.info("[XyNginC] Registering plugin...");
             validateConfig({ domains, autoReload, autoFixFirewall });

package/dist/{downloadBinary.js → mods/downloadBinary.js}

@@ -1,9 +1,9 @@
 import { Logger } from "./logger";
 import * as https from "https";
-import * as fs from "fs";
-import * as path from "path";
-import * as os from "os";
 import { BINARY_NAME, BINARY_DIR, GITHUB_REPO } from "./constant";
+import { __strl__ } from "strulink";
+const fs = __sys__.fs;
+const path = __sys__.path;
 /**
  * Downloads the xynginc binary from GitHub releases.
  *
@@ -11,8 +11,8 @@ import { BINARY_NAME, BINARY_DIR, GITHUB_REPO } from "./constant";
  * @returns The path to the downloaded binary.
  */
 export async function downloadBinary(version) {
-    const platform = os.platform();
-    const arch = os.arch();
+    const platform = __sys__.os.platform();
+    const arch = __sys__.os.arch();
     if (platform !== "linux") {
         throw new Error(`[XyNginC] Unsupported platform: ${platform}. Only Linux is supported.`);
     }
@@ -20,11 +20,9 @@ export async function downloadBinary(version) {
     const downloadUrl = version === "latest"
         ? `https://github.com/${GITHUB_REPO}/releases/latest/download/${binaryName}`
         : `https://github.com/${GITHUB_REPO}/releases/download/${version}/${binaryName}`;
-    Logger.info(`[XyNginC] Downloading from: ${downloadUrl}`);
+    Logger.info(`[XyNginC] Downloading from: ${__strl__.createUrl(downloadUrl).hostname}`);
     // Create bin directory
-    if (!fs.existsSync(BINARY_DIR)) {
-        fs.mkdirSync(BINARY_DIR, { recursive: true });
-    }
+    fs.writeIfNotExistsSync(BINARY_DIR, { recursive: true });
     const localPath = path.join(BINARY_DIR, BINARY_NAME);
     return new Promise((resolve, reject) => {
         function download(url) {
@@ -44,15 +42,14 @@ export async function downloadBinary(version) {
                 const file = fs.createWriteStream(localPath);
                 response.pipe(file);
                 file.on("finish", () => {
-                    file.close();
-                    fs.chmodSync(localPath, 0o755); // Make executable
+                    file.close(); //
+                    fs.chmod(localPath, "755"); // Make executable (octal version: 0o755)
                     Logger.success("[XyNginC] ✓ Binary downloaded successfully");
                     resolve(localPath);
                 });
             })
                 .on("error", (err) => {
-                if (fs.existsSync(localPath))
-                    fs.unlinkSync(localPath);
+                fs.rmIfExists(localPath);
                 reject(err);
             });
         }

package/dist/{ensureBinary.js → mods/ensureBinary.js}

@@ -1,9 +1,9 @@
-import fs from "fs";
-import path from "path";
 import { Logger } from "./logger";
 import { execAsync } from "./execAsync";
 import { BINARY_DIR, BINARY_NAME } from "./constant";
 import { downloadBinary } from "./downloadBinary";
+const fs = __sys__.fs;
+const path = __sys__.path;
 /**
  * Ensures the xynginc binary exists.
  * It checks the custom path, the system PATH, and the local bin directory.
@@ -16,14 +16,14 @@ import { downloadBinary } from "./downloadBinary";
  */
 export async function ensureBinary(customPath, autoDownload, version) {
     // 1. Try custom path
-    if (customPath && fs.existsSync(customPath)) {
+    if (customPath && fs.exists(customPath)) {
         return customPath;
     }
     // 2. Try PATH
     try {
         const { stdout } = await execAsync("which xynginc");
         const globalPath = stdout.trim();
-        if (globalPath && fs.existsSync(globalPath)) {
+        if (globalPath && fs.exists(globalPath)) {
             return globalPath;
         }
     }
@@ -32,7 +32,7 @@ export async function ensureBinary(customPath, autoDownload, version) {
     }
     // 3. Try local bin directory
     const localPath = path.join(BINARY_DIR, BINARY_NAME);
-    if (fs.existsSync(localPath)) {
+    if (fs.exists(localPath)) {
         return localPath;
     }
     // 4. Auto-download if enabled

package/dist/{requirements.d.ts → mods/requirements.d.ts}

@@ -1,4 +1,4 @@
-import { XyNginCDomainConfig } from "./types";
+import { XyNginCDomainConfig } from "../types";
 /**
  * Installs system requirements using the binary in interactive mode.
  *

package/dist/{validateConfig.d.ts → mods/validateConfig.d.ts}

@@ -1,4 +1,4 @@
-import { XyNginCConfig } from "./types";
+import { XyNginCConfig } from "../types";
 /**
  * Validates the plugin configuration.
  *

package/dist/mods/validateConfig.js

@@ -0,0 +1,53 @@
+import { __strl__ } from "strulink";
+import { Interface } from "reliant-type";
+/**
+ * Validates the plugin configuration.
+ *
+ * @param config - The configuration to validate.
+ * @throws Error if the configuration is invalid.
+ */
+export function validateConfig(config) {
+    const d = config.domains;
+    if (!d || d.length === 0) {
+        throw new Error("[XyNginC] Configuration error: 'domains' array cannot be empty");
+    }
+    for (const d2 of d) {
+        if (!d2.domain || typeof d2.domain !== "string") {
+            throw new Error("[XyNginC] Configuration error: 'domain' must be a non-empty string");
+        }
+        const vd = __strl__.checkUrl(d2.domain, { requireProtocol: false });
+        if (!vd.isValid) {
+            const EDOMAIN = vd?.validationDetails?.domain;
+            if (EDOMAIN) {
+                console.error("[XYNGINC::STRULINK:EDOMAIN]: ", EDOMAIN);
+                throw new Error("[XYNGINC::STRULINK:EDOMAIN]" + vd?.cause);
+            }
+            throw new Error(vd?.cause);
+        }
+        if (!d2.port ||
+            typeof d2.port !== "number" ||
+            d2.port < 1 ||
+            d2.port > 65535) {
+            throw new Error(`[XyNginC] Configuration error: 'port' must be between 1-65535 for ${d2.domain}`);
+        }
+        if (d2.ssl && !d2.email) {
+            throw new Error(`[XyNginC] Configuration error: 'email' is required when SSL is enabled for ${d2.domain}`);
+        }
+        const emailInterface = Interface({
+            email: "email",
+        });
+        const vmail = emailInterface.safeParse({ email: d2.email || "" });
+        if (!vmail.success) {
+            console.error(vmail.errors.join("\n"));
+            throw new Error(`[XyNginC] Configuration error: 'email' is invalid for ${d2.domain}`);
+        }
+        // Set default host to localhost if not provided
+        if (!d2.host) {
+            d2.host = "localhost";
+        }
+        // Set default maxBodySize if not provided
+        if (!d2.maxBodySize) {
+            d2.maxBodySize = "20M";
+        }
+    }
+}

package/dist/startPlugin.d.ts

@@ -1,5 +1,6 @@
+import { PluginServer } from ".";
 import { XyNginCDomainConfig } from "./types";
-export declare function startXNCPlugin(server: any, options: {
+export declare function startXNCPlugin(server: PluginServer, options: {
     binaryPath?: string;
     autoDownload: boolean;
     version: string;

package/dist/startPlugin.js

@@ -1,9 +1,9 @@
-import { ensureBinary } from "./ensureBinary";
-import { Logger } from "./logger";
-import { addDomain, applyConfig, checkRequirements, getStatus, installRequirementsHandler, listDomains, reloadNginx, removeDomain, testNginx, } from "./requirements";
+import { ensureBinary } from "./mods/ensureBinary";
+import { Logger } from "./mods/logger";
+import { addDomain, applyConfig, checkRequirements, getStatus, installRequirementsHandler, listDomains, reloadNginx, removeDomain, testNginx, } from "./mods/requirements";
 const getSudo = (sudoPassword) => {
     // Attempt multiple ways to get the password, including XyPriss internal env if somehow exposed
-    const envPwd = process.env.SUDO_PASSWORD;
+    const envPwd = __sys__.__env__.get("SUDO_PASSWORD");
     // || (global as any).__sys__?.$env?.("SUDO_PASSWORD");
     const pwd = sudoPassword || envPwd;
     if (pwd) {
@@ -23,10 +23,19 @@ const getSudo = (sudoPassword) => {
 export async function startXNCPlugin(server, options) {
     const { binaryPath, autoDownload, version, domains, autoReload, autoFixFirewall, installRequirements, sudoPassword, } = options;
     Logger.info("[XyNginC] Initializing Nginx Controller...");
+    if (!sudoPassword) {
+        Logger.warn("[XyNginC] To ensure optimal performance and prevent potential issues, it is recommended to provide your system sudo password.");
+        Logger.info("[XyNginC] Security notice: The password is used solely for privileged communication with your operating system. It is never stored, logged, or transmitted externally.");
+    }
     try {
         // 1. Ensure binary exists
         const binary = await ensureBinary(binaryPath, autoDownload, version);
         Logger.success(`[XyNginC] ✓ Binary located: ${binary}`);
+        __sys__.vars.update({
+            xynginc: {
+                binary,
+            },
+        });
         // 2. Check system requirements
         Logger.info("[XyNginC] Checking system requirements...");
         // Check if requirements are satisfied

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "xynginc",
-  "version": "1.0.82",
-  "description": "XyPriss Nginx Controller - Automatic Nginx & SSL management for XyPriss servers",
+  "version": "1.0.85",
+  "description": "XyPriss Nginx Controller - Automatic Nginx \u0026 SSL management for XyPriss servers",
   "author": "Seth Eleazar - iDevo",
   "license": "NOSL",
   "main": "dist/index.js",
@@ -10,13 +10,14 @@
     "dist",
     "scripts",
     "README.md",
-    "xypriss.plugin.xsig"
+    "xypriss.plugin.xsig",
+    "xypriss.config.jsonc"
   ],
   "bin": {
     "xynginc": "./bin/xynginc"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": "\u003e=18.0.0"
   },
   "repository": {
     "type": "git",
@@ -32,17 +33,19 @@
     "plugin"
   ],
   "scripts": {
-    "build": "tsc && xfpm run build:multi",
-    "build:all": "xfpm run build:go && xfpm run build",
-    "build:go": "cd core-go && go build -o xynginc && cp xynginc ../bin/",
+    "build": "tsc \u0026\u0026 xfpm run build:multi",
+    "build:all": "xfpm run build:go \u0026\u0026 xfpm run build",
+    "build:go": "cd core-go \u0026\u0026 go build -o xynginc \u0026\u0026 cp xynginc ../bin/",
     "build:multi": "bash scripts/build.sh",
     "dev": "tsc --watch",
     "install:manual": "sudo bash scripts/install.sh",
     "postinstall": "node scripts/postinstall.js",
-    "prepublishOnly": "xfpm run build && xfpm sign ./ --min-version 1.0.81 --fix"
+    "prepublishOnly": "xfpm run build \u0026\u0026 xfpm sign ./ --min-version 1.0.81 --fix"
   },
   "dependencies": {
-    "xypriss": "^9.9.4",
+    "reliant-type": "^2.1.5",
+    "strulink": "^1.2.0",
+    "xypriss": "^9.9.5",
     "xypriss-security": "^2.1.16"
   },
   "devDependencies": {
@@ -55,4 +58,4 @@
       "XHS.HOOK.LIFECYCLE.SERVER_READY"
     ]
   }
-}
+}

package/xypriss.config.jsonc

@@ -0,0 +1,7 @@
+{
+  "$internal": {
+    "xynginc": {
+      "type": "plugin",
+    },
+  },
+}

package/xypriss.plugin.xsig

@@ -1,11 +1,11 @@
 --- XYPRISS SIGNATURE (G3) ---
-Manifest: xynginc@1.0.82
+Manifest: xynginc@1.0.85
 Min-Engine: 1.0.81
-Fingerprint: sha256:5b4a4e3f77d74918ee049a1f75d696795494b509fc4747bd336f759595d70ae6
+Fingerprint: sha256:bb6ea669ad840648968355d3deb2ad767b4e3867029bd28935337d44dae87002
 Identity: ed25519:a58b17a3e46302dd3ae5538bc9b8b991c57f4c5fe2e7d8ac41803de818d947f4
 Privileges: XHS.HOOK.HTTP.REQUEST,XHS.HOOK.LIFECYCLE.SERVER_READY
-Expires: 2027-04-28T08:28:51Z
+Expires: 2027-04-28T13:46:27Z
 Revision: sha256:none
 --- BEGIN CRYPTOGRAPHIC PROOF ---
-base64:+YptK2eQ2i9XI3jxC0oHQ/jjUphmWGu9oPH0Gw2BW4dl3GmwEXNMXj42EDQBjrZREGpy0D7FWtnu4Q+ApR19CA==
+base64:LxbunS3M7aPEOokSUj69R9Ht2nSWB8TLzAiVWAwB4tD3BhGgkTAUZW47ULmzibDaTDeclleLSMHiFa3bpvXXDA==
 --- END XYPRISS SIGNATURE ---

package/dist/validateConfig.js

@@ -1,33 +0,0 @@
-/**
- * Validates the plugin configuration.
- *
- * @param config - The configuration to validate.
- * @throws Error if the configuration is invalid.
- */
-export function validateConfig(config) {
-    if (!config.domains || config.domains.length === 0) {
-        throw new Error("[XyNginC] Configuration error: 'domains' array cannot be empty");
-    }
-    for (const domain of config.domains) {
-        if (!domain.domain || typeof domain.domain !== "string") {
-            throw new Error("[XyNginC] Configuration error: 'domain' must be a non-empty string");
-        }
-        if (!domain.port ||
-            typeof domain.port !== "number" ||
-            domain.port < 1 ||
-            domain.port > 65535) {
-            throw new Error(`[XyNginC] Configuration error: 'port' must be between 1-65535 for ${domain.domain}`);
-        }
-        if (domain.ssl && !domain.email) {
-            throw new Error(`[XyNginC] Configuration error: 'email' is required when SSL is enabled for ${domain.domain}`);
-        }
-        // Set default host to localhost if not provided
-        if (!domain.host) {
-            domain.host = "localhost";
-        }
-        // Set default maxBodySize if not provided
-        if (!domain.maxBodySize) {
-            domain.maxBodySize = "20M";
-        }
-    }
-}