xypriss-swagger 1.0.22 → 1.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.ts ADDED
@@ -0,0 +1,14 @@
1
+ import * as crypto from "node:crypto";
2
+ const privateKeyHex =
3
+ "302e020100300506032b6570042204209e313d8086c485206e5f74673a77df2105929b6134e8acdd36445a0b931747fd";
4
+ const privateKey = crypto.createPrivateKey({
5
+ key: Buffer.from(privateKeyHex, "hex"),
6
+ format: "der",
7
+ type: "pkcs8",
8
+ });
9
+ const data =
10
+ "xypriss-swagger:1.0.22:/home/idevo/Documents/projects/XyPriss/mods/swagger";
11
+ const signature = crypto
12
+ .sign(undefined, Buffer.from(data), privateKey)
13
+ .toString("hex");
14
+ console.log(signature);
package/README.md CHANGED
@@ -8,9 +8,17 @@ Auto-documentation execution plugin for XyPriss Router V2.
8
8
  - Securely sandboxed within the XyPriss ecosystem.
9
9
  - Caller-aware dependency injection with strict route filtering.
10
10
 
11
+ ## Security Identity & Verification
12
+
13
+ > [!IMPORTANT]
14
+ > This plugin is secured with the XyPriss G3 Zero-Trust protocol. You MUST manually verify this Public Key during installation.
15
+
16
+ **Developer ID (Public Key):**
17
+ `ed25519:a58b17a3e46302dd3ae5538bc9b8b991c57f4c5fe2e7d8ac41803de818d947f4`
18
+
11
19
  ## Usage
12
20
 
13
- This module is designed to be loaded natively by the XyPriss plugin manager. Ensure that it is authorized in your `xypriss.config.json` inside the `$internal` block.
21
+ This module is designed to be loaded natively by the XyPriss plugin manager. Ensure that it is authorized in your `xypriss.config.jsonc` inside the `$internal` block, including the cryptographic signature.
14
22
 
15
23
  ```json
16
24
  {
@@ -18,19 +26,21 @@ This module is designed to be loaded natively by the XyPriss plugin manager. Ens
18
26
  "xypriss-swagger": {
19
27
  "type": "plugin",
20
28
  "__meta__": {
21
- "path": "ROOT://",
29
+ "path": "ROOT://"
22
30
  },
23
31
  "__xfs__": {
24
- "path": "CWD://",
32
+ "path": "CWD://"
25
33
  },
26
34
  "permissions": {
27
- "allowedHooks": ["PLG.OPS.AUXILIARY_SERVER", "PLG.SECURITY.ACCESS_CONFIGS"],
28
- "policy": "allow",
29
- },
30
- },
31
- },
35
+ "allowedHooks": [
36
+ "PLG.OPS.AUXILIARY_SERVER",
37
+ "PLG.SECURITY.ACCESS_CONFIGS"
38
+ ],
39
+ "policy": "allow"
40
+ }
41
+ }
42
+ }
32
43
  }
33
-
34
44
  ```
35
45
 
36
46
  > [!NOTE]
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../../../../src/index.ts"],"sourcesContent":["import { logger, Logger } from \"./configs/Logger\";\nimport { meta, toPascalCase } from \"./configs/meta\";\nimport { SwaggerServer } from \"./server\";\nimport { SwaggerConfig } from \"./types\";\nimport { Plugin } from \"xypriss\";\n\nconst pluginName = toPascalCase(meta.name);\nexport function SwaggerPlugin(config: SwaggerConfig) {\n return Plugin.create(\n {\n name: meta.name,\n version: meta.version,\n description: meta.description,\n onRegister(_error) {\n const log = Logger.for(\"Bootstrap\");\n log.info(\"Starting swagger plugin...\");\n if (_error) {\n log.error(pluginName + \" plugin failed to start:\", _error);\n }\n },\n onServerStart(server) {\n logger.success(pluginName + \" plugin has started\");\n\n server.app.get(\"/swagger\", (_req: any, res: any) => {\n res.redirect(`http://localhost:${config.port}`);\n });\n },\n onAuxiliaryServerDeploy(ops, server) {\n SwaggerServer(config, ops, server);\n },\n }, \n __sys__.__root__,\n );\n}\n\n\n\n"],"names":["pluginName","toPascalCase","meta","name","config","Plugin","create","version","description","onRegister","_error","log","Logger","for","info","error","onServerStart","server","logger","success","app","get","_req","res","redirect","port","onAuxiliaryServerDeploy","ops","SwaggerServer","__sys__","__root__"],"mappings":"+HAMA,MAAMA,EAAaC,EAAAA,aAAaC,EAAAA,KAAKC,4BAC/B,SAAwBC,GAC1B,OAAOC,EAAAA,OAAOC,OACV,CACIH,KAAMD,EAAAA,KAAKC,KACXI,QAASL,EAAAA,KAAKK,QACdC,YAAaN,EAAAA,KAAKM,YAClB,UAAAC,CAAWC,GACP,MAAMC,EAAMC,EAAAA,OAAOC,IAAI,aACvBF,EAAIG,KAAK,8BACLJ,GACAC,EAAII,MAAMf,EAAa,2BAA4BU,EAE3D,EACA,aAAAM,CAAcC,GACVC,SAAOC,QAAQnB,EAAa,uBAE5BiB,EAAOG,IAAIC,IAAI,WAAY,CAACC,EAAWC,KACnCA,EAAIC,SAAS,oBAAoBpB,EAAOqB,SAEhD,EACA,uBAAAC,CAAwBC,EAAKV,GACzBW,EAAAA,cAAcxB,EAAQuB,EAC1B,GAEJE,QAAQC,SAEhB"}
1
+ {"version":3,"file":"index.js","sources":["../../../../src/index.ts"],"sourcesContent":["import { logger, Logger } from \"./configs/Logger\";\nimport { meta, toPascalCase } from \"./configs/meta\";\nimport { SwaggerServer } from \"./server\";\nimport { SwaggerConfig } from \"./types\";\nimport { Plugin } from \"xypriss\";\n\nconst pluginName = toPascalCase(meta.name);\nexport function SwaggerPlugin(config: SwaggerConfig) {\n return Plugin.create(\n {\n name: meta.name,\n version: meta.version,\n description: meta.description,\n onRegister(_error) {\n const log = Logger.for(\"Bootstrap\");\n log.info(\"Starting swagger plugin...\");\n if (_error) {\n log.error(pluginName + \" plugin failed to start:\", _error);\n }\n },\n onServerStart(server) {\n logger.success(pluginName + \" plugin has started\");\n\n server.app.get(\"/swagger\", (_req: any, res: any) => {\n res.redirect(`http://localhost:${config.port}`);\n });\n },\n onAuxiliaryServerDeploy(ops, server) {\n SwaggerServer(config, ops, server);\n },\n }, \n __sys__.__root__,\n );\n}"],"names":["pluginName","toPascalCase","meta","name","config","Plugin","create","version","description","onRegister","_error","log","Logger","for","info","error","onServerStart","server","logger","success","app","get","_req","res","redirect","port","onAuxiliaryServerDeploy","ops","SwaggerServer","__sys__","__root__"],"mappings":"+HAMA,MAAMA,EAAaC,EAAAA,aAAaC,EAAAA,KAAKC,4BAC/B,SAAwBC,GAC1B,OAAOC,EAAAA,OAAOC,OACV,CACIH,KAAMD,EAAAA,KAAKC,KACXI,QAASL,EAAAA,KAAKK,QACdC,YAAaN,EAAAA,KAAKM,YAClB,UAAAC,CAAWC,GACP,MAAMC,EAAMC,EAAAA,OAAOC,IAAI,aACvBF,EAAIG,KAAK,8BACLJ,GACAC,EAAII,MAAMf,EAAa,2BAA4BU,EAE3D,EACA,aAAAM,CAAcC,GACVC,SAAOC,QAAQnB,EAAa,uBAE5BiB,EAAOG,IAAIC,IAAI,WAAY,CAACC,EAAWC,KACnCA,EAAIC,SAAS,oBAAoBpB,EAAOqB,SAEhD,EACA,uBAAAC,CAAwBC,EAAKV,GACzBW,EAAAA,cAAcxB,EAAQuB,EAC1B,GAEJE,QAAQC,SAEhB"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../../../../src/index.ts"],"sourcesContent":["import { logger, Logger } from \"./configs/Logger\";\nimport { meta, toPascalCase } from \"./configs/meta\";\nimport { SwaggerServer } from \"./server\";\nimport { SwaggerConfig } from \"./types\";\nimport { Plugin } from \"xypriss\";\n\nconst pluginName = toPascalCase(meta.name);\nexport function SwaggerPlugin(config: SwaggerConfig) {\n return Plugin.create(\n {\n name: meta.name,\n version: meta.version,\n description: meta.description,\n onRegister(_error) {\n const log = Logger.for(\"Bootstrap\");\n log.info(\"Starting swagger plugin...\");\n if (_error) {\n log.error(pluginName + \" plugin failed to start:\", _error);\n }\n },\n onServerStart(server) {\n logger.success(pluginName + \" plugin has started\");\n\n server.app.get(\"/swagger\", (_req: any, res: any) => {\n res.redirect(`http://localhost:${config.port}`);\n });\n },\n onAuxiliaryServerDeploy(ops, server) {\n SwaggerServer(config, ops, server);\n },\n }, \n __sys__.__root__,\n );\n}\n\n\n\n"],"names":["pluginName","toPascalCase","meta","name","SwaggerPlugin","config","Plugin","create","version","description","onRegister","_error","log","Logger","for","info","error","onServerStart","server","logger","success","app","get","_req","res","redirect","port","onAuxiliaryServerDeploy","ops","SwaggerServer","__sys__","__root__"],"mappings":"iMAMA,MAAMA,EAAaC,EAAaC,EAAKC,MAC/B,SAAUC,EAAcC,GAC1B,OAAOC,EAAOC,OACV,CACIJ,KAAMD,EAAKC,KACXK,QAASN,EAAKM,QACdC,YAAaP,EAAKO,YAClB,UAAAC,CAAWC,GACP,MAAMC,EAAMC,EAAOC,IAAI,aACvBF,EAAIG,KAAK,8BACLJ,GACAC,EAAII,MAAMhB,EAAa,2BAA4BW,EAE3D,EACA,aAAAM,CAAcC,GACVC,EAAOC,QAAQpB,EAAa,uBAE5BkB,EAAOG,IAAIC,IAAI,WAAY,CAACC,EAAWC,KACnCA,EAAIC,SAAS,oBAAoBpB,EAAOqB,SAEhD,EACA,uBAAAC,CAAwBC,EAAKV,GACzBW,EAAcxB,EAAQuB,EAC1B,GAEJE,QAAQC,SAEhB"}
1
+ {"version":3,"file":"index.js","sources":["../../../../src/index.ts"],"sourcesContent":["import { logger, Logger } from \"./configs/Logger\";\nimport { meta, toPascalCase } from \"./configs/meta\";\nimport { SwaggerServer } from \"./server\";\nimport { SwaggerConfig } from \"./types\";\nimport { Plugin } from \"xypriss\";\n\nconst pluginName = toPascalCase(meta.name);\nexport function SwaggerPlugin(config: SwaggerConfig) {\n return Plugin.create(\n {\n name: meta.name,\n version: meta.version,\n description: meta.description,\n onRegister(_error) {\n const log = Logger.for(\"Bootstrap\");\n log.info(\"Starting swagger plugin...\");\n if (_error) {\n log.error(pluginName + \" plugin failed to start:\", _error);\n }\n },\n onServerStart(server) {\n logger.success(pluginName + \" plugin has started\");\n\n server.app.get(\"/swagger\", (_req: any, res: any) => {\n res.redirect(`http://localhost:${config.port}`);\n });\n },\n onAuxiliaryServerDeploy(ops, server) {\n SwaggerServer(config, ops, server);\n },\n }, \n __sys__.__root__,\n );\n}"],"names":["pluginName","toPascalCase","meta","name","SwaggerPlugin","config","Plugin","create","version","description","onRegister","_error","log","Logger","for","info","error","onServerStart","server","logger","success","app","get","_req","res","redirect","port","onAuxiliaryServerDeploy","ops","SwaggerServer","__sys__","__root__"],"mappings":"iMAMA,MAAMA,EAAaC,EAAaC,EAAKC,MAC/B,SAAUC,EAAcC,GAC1B,OAAOC,EAAOC,OACV,CACIJ,KAAMD,EAAKC,KACXK,QAASN,EAAKM,QACdC,YAAaP,EAAKO,YAClB,UAAAC,CAAWC,GACP,MAAMC,EAAMC,EAAOC,IAAI,aACvBF,EAAIG,KAAK,8BACLJ,GACAC,EAAII,MAAMhB,EAAa,2BAA4BW,EAE3D,EACA,aAAAM,CAAcC,GACVC,EAAOC,QAAQpB,EAAa,uBAE5BkB,EAAOG,IAAIC,IAAI,WAAY,CAACC,EAAWC,KACnCA,EAAIC,SAAS,oBAAoBpB,EAAOqB,SAEhD,EACA,uBAAAC,CAAwBC,EAAKV,GACzBW,EAAcxB,EAAQuB,EAC1B,GAEJE,QAAQC,SAEhB"}
package/package.json CHANGED
@@ -1,40 +1,40 @@
1
1
  {
2
- "name": "xypriss-swagger",
3
- "version": "1.0.22",
4
- "description": "Auto-documentation plugin for XyPriss Router V2",
5
- "type": "module",
6
- "main": "dist/cjs/index.js",
7
- "module": "dist/esm/index.js",
8
- "types": "dist/index.d.ts",
9
- "exports": {
10
- ".": {
11
- "import": "./dist/esm/index.js",
12
- "require": "./dist/cjs/index.js",
13
- "types": "./dist/index.d.ts"
14
- }
15
- },
16
- "scripts": {
17
- "build": "rm -rf dist \u0026\u0026 NODE_OPTIONS='--max-old-space-size=4096' npx rollup -c rollup.config.js",
18
- "dev": "rollup -c -w",
19
- "prepublishOnly": "npm run build"
20
- },
21
- "dependencies": {
22
- "nehoid": "^2.1.4",
23
- "xypriss-security": "^2.1.13",
24
- "xypriss": "^9.6.90"
25
- },
26
- "devDependencies": {
27
- "@rollup/plugin-commonjs": "^29.0.2",
28
- "@rollup/plugin-json": "^6.1.0",
29
- "@rollup/plugin-node-resolve": "^16.0.3",
30
- "@rollup/plugin-terser": "^1.0.0",
31
- "@rollup/plugin-typescript": "^12.3.0",
32
- "glob": "^13.0.6",
33
- "rollup": "^4.60.1",
34
- "rollup-plugin-dts": "^6.4.1",
35
- "tslib": "^2.8.1",
36
- "typescript": "^5.0.0"
37
- },
38
- "peerDependencies": {
39
- }
40
- }
2
+ "name": "xypriss-swagger",
3
+ "version": "1.0.27",
4
+ "description": "Auto-documentation plugin for XyPriss Router V2",
5
+ "type": "module",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/esm/index.js",
8
+ "types": "dist/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "import": "./dist/esm/index.js",
12
+ "require": "./dist/cjs/index.js",
13
+ "types": "./dist/index.d.ts"
14
+ }
15
+ },
16
+ "scripts": {
17
+ "build": "rm -rf dist && NODE_OPTIONS='--max-old-space-size=4096' npx rollup -c rollup.config.js",
18
+ "dev": "rollup -c -w",
19
+ "prepublishOnly": "npm run build"
20
+ },
21
+ "dependencies": {
22
+ "nehoid": "^2.1.4",
23
+ "xypriss-security": "^2.1.13",
24
+ "xypriss": "^9.7.1"
25
+ },
26
+ "devDependencies": {
27
+ "@rollup/plugin-commonjs": "^29.0.2",
28
+ "@rollup/plugin-json": "^6.1.0",
29
+ "@rollup/plugin-node-resolve": "^16.0.3",
30
+ "@rollup/plugin-terser": "^1.0.0",
31
+ "@rollup/plugin-typescript": "^12.3.0",
32
+ "glob": "^13.0.6",
33
+ "rollup": "^4.60.1",
34
+ "rollup-plugin-dts": "^6.4.1",
35
+ "tslib": "^2.8.1",
36
+ "typescript": "^5.0.0"
37
+ },
38
+ "peerDependencies": {}
39
+ }
40
+
package/src/index.ts CHANGED
@@ -31,7 +31,4 @@ export function SwaggerPlugin(config: SwaggerConfig) {
31
31
  },
32
32
  __sys__.__root__,
33
33
  );
34
- }
35
-
36
-
37
-
34
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "author_key": "ed25519:a58b17a3e46302dd3ae5538bc9b8b991c57f4c5fe2e7d8ac41803de818d947f4",
3
+ "content_hash": "sha256:3ac1da2c14698f61d6dbc53a02fad706687a209cb1f3d33c54a9f3f93e4e1a41",
4
+ "expires_at": "2027-04-21T08:14:34Z",
5
+ "min_version": "1.0.22",
6
+ "name": "xypriss-swagger",
7
+ "prev_sig_hash": "sha256:none",
8
+ "signature": "base64:osCFae9BgpM5zkEXKoC2u8Mr69UEezVqeA/F0mOIG3wEwU4vXNonkkZpGfBvHXiZtmIjQDtys4b0KooQtWEMAQ==",
9
+ "version": "1.0.26"
10
+ }