xypriss-swagger 1.0.33 → 1.0.37

package/README.md

@@ -15,7 +15,7 @@ The **[XyPriss Swagger Plugin](https://github.com/Nehonix-Team/XyPriss/blob/mast
 Install the plugin via XFPM:
 
 ```bash
-xfpm add xypriss-swagger
+xfpm add xypriss-swagger --verify
 ```
 
 ## Usage
@@ -28,16 +28,18 @@ In your main XyPriss application, import and register the `SwaggerPlugin`:
 import { SwaggerPlugin } from "xypriss-swagger";
 import { XyPrissServer } from "xypriss";
 
-const server = new XyPrissServer();
-
-server.use(
-    SwaggerPlugin({
-        port: 7070, // Port for the documentation server
-        path: "/docs", // Path to access the Swagger UI
-        title: "My API", // Documentation title
-        version: "1.0.0", // API Version
-    }),
-);
+const server = createServer({
+    plugins: {
+        register: [
+            SwaggerPlugin({
+                port: 7070, // Port for the documentation server
+                path: "/docs", // Path to access the Swagger UI
+                title: "My API", // Documentation title
+                version: "1.0.0", // API Version
+            }),
+        ],
+    },
+});
 
 server.start();
 ```
@@ -59,6 +61,10 @@ Ensure the plugin is authorized in your `xypriss.config.jsonc`:
             },
             "permissions": {
                 "allowedHooks": [
+                    "PLG.HTTP.ON_REQUEST",
+                    "PLG.SECURITY.ACCESS_SENSITIVE_DATA",
+                    "PLG.LIFECYCLE.REGISTER",
+                    "PLG.LIFECYCLE.SERVER_START",
                     "PLG.OPS.AUXILIARY_SERVER",
                     "PLG.SECURITY.ACCESS_CONFIGS",
                 ],
@@ -128,13 +134,27 @@ server.get(
 
 ## Security & Permissions
 
-In order to properly analyze your project's codebase and generate accurate Swagger documentation, this plugin requires the `CWD://` (Current Working Directory) context permission.
+In order to properly function and integrate safely into your Zero-Trust XyPriss environment, this plugin requires the following privileges to be strictly allowed in your `xypriss.config.jsonc`:
+
+### Filesystem Context (`CWD://`)
+
+**Why?** The plugin needs to resolve the active execution directory to dynamically scan your route files, interpret comments, and compile the OpenAPI JSON structure correctly.
+**Is it safe?** Absolutely. The plugin performs exclusive read-only operations targeting your router files, safely ignoring sensitive `.env` or credentials.
+
+### Lifecycle & Auxiliary Hooks
+
+The Swagger plugin operates as an independent subsystem connected to the main server loop:
+
+- `PLG.LIFECYCLE.REGISTER`: Required to negotiate initialization with the core engine.
+- `PLG.LIFECYCLE.SERVER_START`: Allows the plugin to participate safely in the startup sequence.
+- `PLG.OPS.AUXILIARY_SERVER`: **Crucial.** Permits the deployment of the isolated documentation HTTP server without exposing your main server loop.
+
+### Security Access Hooks
 
-**Why is `CWD://` required?**
-The plugin needs to resolve the active execution directory to dynamically scan your route files, interpret comments, and compile the OpenAPI JSON structure correctly.
+- `PLG.HTTP.ON_REQUEST`: Used strictly on the isolated auxiliary server to mount the documentation UI and manage static assets.
+- `PLG.SECURITY.ACCESS_SENSITIVE_DATA` & `PLG.SECURITY.ACCESS_CONFIGS`: Required for the plugin to introspect the router architecture and extract the internal metadata needed for documentation auto-generation.
 
-**Is it safe?**
-Absolutely. While `CWD://` grants broad access to the project root, the XyPriss Swagger plugin is an official, strictly audited core module. It **exclusively** performs safe, read-only operations targeting your router files. It explicitly ignores sensitive system files (e.g., `.env`, credentials) and does not leak or alter your business logic. Your environment remains completely secure.
+By explicitly providing these permissions, you maintain complete Zero-Trust authority over what the plugin is allowed to do, preventing silent system overrides or unwanted network binding.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "xypriss-swagger",
-    "version": "1.0.33",
+    "version": "1.0.37",
     "description": "Auto-documentation plugin for XyPriss Router V2",
     "type": "module",
     "main": "dist/cjs/index.js",
@@ -45,4 +45,4 @@
         "typescript": "^5.0.0"
     },
     "peerDependencies": {}
-}
+}

package/xypriss.plugin.xsig

@@ -1,10 +1,10 @@
 --- XYPRISS SIGNATURE (G3) ---
-Manifest: xypriss-swagger@1.0.33
-Min-Engine: 1.0.31
-Fingerprint: sha256:a9c9214d55f1334ccf63cb0fd0b65ca49befb705cb9511809fd07b9f948d116b
+Manifest: xypriss-swagger@1.0.37
+Min-Engine: 1.0.35
+Fingerprint: sha256:53f24df6e325461b5f45bdf2c1ad7dab95e6c904979af8ffc396507a543ded56
 Identity: ed25519:a58b17a3e46302dd3ae5538bc9b8b991c57f4c5fe2e7d8ac41803de818d947f4
-Expires: 2027-04-21T21:41:21Z
+Expires: 2027-04-22T20:54:37Z
 Revision: sha256:none
 --- BEGIN CRYPTOGRAPHIC PROOF ---
-base64:RldJ40DNFGSMMC9msaWQjxNjRBGz6jA9+h+EcStzRFGYCsZXgpt2gNGPxchLKKVBs4A/k/1kkMJC+9BHXAfgBw==
+base64:d2rumcZZmiZpCpc1TQbA1RmMnDgppcYNSv+LHuZ+SZXF0NHXotKdQeroTQaCEnqxjvRJEXyPjZsJNgt4RW8AAw==
 --- END XYPRISS SIGNATURE ---