{"_id":"3x-ui","_rev":"61-dd78c1d50b0cd3418fb964291fa6a79e","name":"3x-ui","dist-tags":{"latest":"2.1.1"},"versions":{"1.3.5":{"name":"3x-ui","version":"1.3.5","author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.3.5","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"5df8f71fd9160887d4c1ef5655397d54fe772598","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.3.5.tgz","fileCount":16,"integrity":"sha512-0dNYEZHrKiyidEYOkErmsSvpiDp10NWvQmPFExzvABKhVq7Mwox3GK0uRYFJexcUyg3BW9vK6srdGmcxAJabAQ==","signatures":[{"sig":"MEYCIQC22ts9yc8KJerkTGyc/YxI+LV4fC8G4SlzRhsuBmqyEAIhAJrLP7TfmNDFtDphaSVuk7GxVXu3z7vLyHqx0mzeFfxf","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":40255},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"3505678981462e67b4f5ba21095f575cad9fc4da","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"10.4.0","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.\r This package is developed based on [MHSanaei Postman Collection](https://documenter.getpostman.com/view/16802678/2s9YkgD5jm#9ca","directories":{},"_nodeVersion":"20.10.0","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.3.5_1707223857540_0.5344680254907124","host":"s3://npm-registry-packages"}},"1.4.1":{"name":"3x-ui","version":"1.4.1","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.4.1","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"5cb0f6dad36f0906717d78ce1daad757426f5a55","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.4.1.tgz","fileCount":19,"integrity":"sha512-icwZ+1nS028lnTcwX98U2p/HMNrl2FPAC+B334h60PTsEqb4qCdFldZ3jfT11R3zViVr5eewgWMwFJmiGXtC/g==","signatures":[{"sig":"MEUCIHMrXCYq+nhShhFYhizIhBQZvL4XFvaxSdwAq9HQ8scaAiEAgboMe/A3i8TrZMvkNWYF+vCebnOZaCrjsvvFY5V/YLk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42216},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"01bb1b1ded8bef5688adf55dfff184ebe952e825","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"10.4.0","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.4.1_1709447021213_0.890801456228923","host":"s3://npm-registry-packages"}},"1.4.2":{"name":"3x-ui","version":"1.4.2","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.4.2","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"6bb8f77e880f1112aac852d315cc6affe66c322c","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.4.2.tgz","fileCount":11,"integrity":"sha512-+3wFeAgEm+fIiGfhnm+td5RSVSgxTRUV/UvhSGdXEP8EDkSj79UqKrYh2XM8CKUoqRFygfkeFBCjN0I9Ef6dDw==","signatures":[{"sig":"MEYCIQDtmOrrTUg1W04iXZt3NYi1aswDGSf2AsGB6/UkLJpLXQIhAMo4u8Z3If6fcCkm0eGXWGwVcffCMGHracqCx/OPcxHZ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":25998},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"55f458f0927480a70f38da3c4a7960990d2b924d","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.4.2_1709710930500_0.698521360803698","host":"s3://npm-registry-packages"}},"1.5.0":{"name":"3x-ui","version":"1.5.0","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.5.0","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"7e0794ceeb66ea7c12d28d1b3e836548ebe140cc","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.5.0.tgz","fileCount":20,"integrity":"sha512-ZKqEdqtXXuNNXCKyocEfiD3/LfY8MD0pwrT6dRXtZScGrAX8sz6qAOjWS2dJ2wdD969hhFPqe3KH78WeMKhh7A==","signatures":[{"sig":"MEQCIA9V96HcOChSD7rWZVMMglJXtz9RXJ9JsVHmke/eYADxAiAZZt1dAwLhyshBXjNaDoTHANFvaKH2BjHpJxKa4Tc/xg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28956},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"fb485d74d2839ebc473ff2a84be31e1c6cd1661b","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.5.0_1709791105389_0.929130211542015","host":"s3://npm-registry-packages"}},"1.6.0":{"name":"3x-ui","version":"1.6.0","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.6.0","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"a63e1b47771a856dc32f963db307d4ef7441b3fb","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.6.0.tgz","fileCount":20,"integrity":"sha512-jMvp9Vy3s89eKdWh3jwjNUYDIvKIUoSKj9lFE2/tpFxmIW9p/Xv4J9HsMBezgKVFCHuzA/dCg5Vn2x2xf6FybA==","signatures":[{"sig":"MEYCIQDbyfc57C7ITSgPZ9x+KUtbda3fW8Vg7ifOAuPkAlHc3gIhAPhuJ3/wpqkE2P9oobnBsizUwUCJjGjkTpNLLirC4RZz","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29267},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"9aecbe97edbe1af970c258f609f10ee0294940fc","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.6.0_1714225025390_0.1477384792670846","host":"s3://npm-registry-packages"}},"1.6.1":{"name":"3x-ui","version":"1.6.1","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.6.1","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"dc172927a636b9644e0365b188e1929ec0e2cfd9","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.6.1.tgz","fileCount":20,"integrity":"sha512-mg7mUubG3R6c06zBmd/BiTNIRozPRd2F7eVjOSwm/WvUmdUBDYzoUJlwSGxhrWVDx1g0Orn9ayWCGd0y/AWmMw==","signatures":[{"sig":"MEQCIFhxR8lFSkx4SkEwFqZlt+XIIyRCw9sHG3hpd7Dh4s5zAiBWrjDJytMBa2oAdSVabiUnx1dFlZTyw4kADfST1DAp5w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29350},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"1017950d4bd2dd0911ab2f583d799045283e73bf","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.6.1_1716218479491_0.7786267582192299","host":"s3://npm-registry-packages"}},"1.6.2":{"name":"3x-ui","version":"1.6.2","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.6.2","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"9afc0d39fb0f8bb91ec29248bfefdf22ae4f3ee7","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.6.2.tgz","fileCount":20,"integrity":"sha512-Yk8g5M1d+HazU1Zkgu1yL5j1ASskGOuPAvoP4MZBQFxxSpScfkBW5WMDXMCMKkv4kuvP+KEA2rMKX10Ijz/T7g==","signatures":[{"sig":"MEUCICxXdp5mMXeb9iXkWoNINDZmaQOrHuQtRiUGbASKqaHbAiEAuy5cOCEhMRsHIfhkh4ShTBJZmrvuxONasPebFWVSbVc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29632},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"857b90692e1aff4f18dfb36150db90640dde03c8","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.6.2_1716219306219_0.9959751557641918","host":"s3://npm-registry-packages"}},"1.7.0":{"name":"3x-ui","version":"1.7.0","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.7.0","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"fde0d63b31afd82df9d9d25a7a721b8dda9bc356","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.7.0.tgz","fileCount":20,"integrity":"sha512-cFfj3MEIm5oWHZdGj9GoR7auyKvuJHSc1NGcS5q3LtPkz+afHCxf/2VjhchnUsS98ugkx+r0zIAsvNhPbr5tzg==","signatures":[{"sig":"MEUCIQC8HihVSymZGS7WrUTayEkhkvw1pBg6he7uFjptH7LEfgIgYDDuqM9dXK/GXXbmqsIXt7xMmcO2Q2JvHsmhH/CmUGg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34636},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"9c70d37a9b7aa1510067cc33115585ce7b3aa12f","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","async-mutex":"^0.5.0","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.7.0_1727350158533_0.1692983393517724","host":"s3://npm-registry-packages"}},"1.7.1":{"name":"3x-ui","version":"1.7.1","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@1.7.1","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"23f739921e3769a131bd5404ad34455070287de3","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-1.7.1.tgz","fileCount":20,"integrity":"sha512-+/BtyrcM/PpEfDCcoR3YmgPKdvRn+pH42XD+cffKfBcsztWNgN/yAQQ9jE0bRaYpJ8/DNXkOMQl3GkBAbff1gw==","signatures":[{"sig":"MEUCIGTd/08peNbJRsBprcd2j3Lzqs7kQUp7k2T2x0bAO22zAiEA7+mM7eyiGp8XrLcOAcf3SUUwkfyb1yOHVsv7BvBYyyQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34997},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"73a1a9e68112343dc0a9315d3554569ae60cc716","scripts":{"build":"tsc -p tsconfig.json","format":"prettier --write .","prepublish":"npm run build"},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"8.19.4","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"16.20.2","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","async-mutex":"^0.5.0","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","eslint":"^8.55.0","prettier":"^3.1.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.10.4","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_1.7.1_1727350872320_0.3556497319813885","host":"s3://npm-registry-packages"}},"2.0.1":{"name":"3x-ui","version":"2.0.1","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@2.0.1","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"a06eda943d05731819563d40449b99aab72629f5","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-2.0.1.tgz","fileCount":25,"integrity":"sha512-vxWLoQLytrfck8bEcFmwgzKJJrT4YLpyf8IJVTsyqScr3xAn5hqWHj81U9zDDBCLLR1lnfVtpkQUUcOE2cQkGw==","signatures":[{"sig":"MEYCIQDPuC2XuYwwBiG3iF5a4GhpH3eNEeu8DeZt4KNKmufSVwIhAPEbjliTjvJM+VulTaFeSpnGVLPxNxVDzV59ZqSfFTvr","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":36660},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"59fca2e7f31599868a27fd3818cad5120afd5ea0","scripts":{"test":"vitest .","build":"tsc -p tsconfig.build.json && resolve-tspaths","format":"prettier --write ."},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"10.7.0","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"18.20.4","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","async-mutex":"^0.5.0","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","zod":"^3.23.8","eslint":"^8.55.0","vitest":"^2.1.2","prettier":"^3.1.0","xray-zod":"^1.0.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.16.11","resolve-tspaths":"^0.8.22","vite-tsconfig-paths":"^5.0.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_2.0.1_1728389929770_0.547622097133474","host":"s3://npm-registry-packages"}},"2.0.2":{"name":"3x-ui","version":"2.0.2","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@2.0.2","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"7461ad5bb1614b5533acdf701bacbb2119908061","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-2.0.2.tgz","fileCount":25,"integrity":"sha512-AFD4Xau1QBOMSnyTontDwBrD52q88O7CV39SppBqhHJHTlppM5kjMfeaqkXdQygPVTl/KbnCOPGLMvH5fo3Z6Q==","signatures":[{"sig":"MEQCIE3Wh1mZDkXY9E88sjmglybuprlvkyF/alTJuvTcO/veAiBg77yKGxrbN9kYxTMumFJJITzZZlNF6RHAziekew2OOg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37110},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"2bac5dd8507c522156f4e813192e670002f54a83","scripts":{"test":"vitest .","build":"tsc -p tsconfig.build.json && resolve-tspaths","format":"prettier --write ."},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"10.7.0","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"18.20.4","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","async-mutex":"^0.5.0","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","zod":"^3.23.8","eslint":"^8.55.0","vitest":"^2.1.2","prettier":"^3.1.0","xray-zod":"^1.0.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.16.11","@faker-js/faker":"^9.0.3","resolve-tspaths":"^0.8.22","vite-tsconfig-paths":"^5.0.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_2.0.2_1728548213541_0.4084985854845984","host":"s3://npm-registry-packages"}},"2.0.3":{"name":"3x-ui","version":"2.0.3","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@2.0.3","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"903c29b3d27e2c3d856054c2caa363af7543af3b","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-2.0.3.tgz","fileCount":27,"integrity":"sha512-QR0Giln/KjdsbZS3XUnd0DBulLc+YfdspAkbAXdc0W/yVsDAp1zXrf+0FJD2qPCJDZB/maGeeE+7Hq5xCRPoWA==","signatures":[{"sig":"MEQCIBEpf0ENS6Re0N+8cGbaY7Q1ttuFdxJYRIBictkcrsZfAiBG9chbUcC8lEZKYgCbIHSsChplzksCTw8eXoqM37g9VQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37481},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"6cbdc7bd48a091c879484f99bbbe93f22d3304ef","scripts":{"test":"vitest .","build":"tsc -p tsconfig.build.json && resolve-tspaths","format":"prettier --write ."},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"10.7.0","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"18.20.4","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","async-mutex":"^0.5.0","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","zod":"^3.23.8","eslint":"^8.55.0","vitest":"^2.1.2","prettier":"^3.1.0","xray-zod":"^1.0.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.16.11","@faker-js/faker":"^9.0.3","resolve-tspaths":"^0.8.22","vite-tsconfig-paths":"^5.0.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_2.0.3_1728553371740_0.8626684069962549","host":"s3://npm-registry-packages"}},"2.1.0":{"name":"3x-ui","version":"2.1.0","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"author":{"url":"https://github.com/mehdikhody","name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com"},"_id":"3x-ui@2.1.0","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"dist":{"shasum":"4717c14c8076f79d645c0aa269966717be1f37e4","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-2.1.0.tgz","fileCount":27,"integrity":"sha512-4BPuAVmJDAzuFMFDIFv4kgb7x0qXeegwewO+nyGj2/pud2TZOkMhTVgKpnTN2kEbH0vz59U186H6RDjAa3S+rA==","signatures":[{"sig":"MEUCICWyg+GSQ2TxtlltY6Gi8zcuigGtB0jknKMzSofDg1IQAiEA37WF22m8ww+zQrI+Ls3OH7mOPweN9yjOeejQVN/+SDY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37424},"main":"build/index.js","type":"module","types":"build/index.d.ts","gitHead":"7b342759a0977f707caed86ef06812af15b83ef6","scripts":{"test":"vitest .","build":"tsc -p tsconfig.build.json && resolve-tspaths","format":"prettier --write ."},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"repository":{"url":"git+https://github.com/mehdikhody/3x-ui-js.git","type":"git"},"_npmVersion":"10.7.0","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","directories":{},"_nodeVersion":"18.20.4","dependencies":{"qs":"^6.11.2","axios":"^1.6.4","winston":"^3.11.0","url-join":"^5.0.0","node-cache":"^5.1.2","async-mutex":"^0.5.0","proxy-agent":"^6.3.1"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.6.2","zod":"^3.23.8","eslint":"^8.55.0","vitest":"^2.1.2","prettier":"^3.1.0","xray-zod":"^1.0.0","@types/qs":"^6.9.11","typescript":"^5.3.3","@types/node":"^20.16.11","@faker-js/faker":"^9.0.3","resolve-tspaths":"^0.8.22","vite-tsconfig-paths":"^5.0.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","@typescript-eslint/parser":"^6.13.2","@typescript-eslint/eslint-plugin":"^6.13.2"},"_npmOperationalInternal":{"tmp":"tmp/3x-ui_2.1.0_1730601136491_0.3711805842888032","host":"s3://npm-registry-packages"}},"2.1.1":{"name":"3x-ui","description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","version":"2.1.1","type":"module","main":"build/index.js","types":"build/index.d.ts","author":{"name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com","url":"https://github.com/mehdikhody"},"scripts":{"build":"tsc -p tsconfig.build.json && resolve-tspaths","format":"prettier --write .","test":"vitest ."},"devDependencies":{"@faker-js/faker":"^9.0.3","@types/node":"^20.16.11","@types/qs":"^6.9.11","@typescript-eslint/eslint-plugin":"^6.13.2","@typescript-eslint/parser":"^6.13.2","eslint":"^8.55.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.0.1","prettier":"^3.1.0","resolve-tspaths":"^0.8.22","tsx":"^4.6.2","typescript":"^5.3.3","vite-tsconfig-paths":"^5.0.1","vitest":"^2.1.2","xray-zod":"^1.0.0","zod":"^3.23.8"},"dependencies":{"async-mutex":"^0.5.0","axios":"^1.6.4","node-cache":"^5.1.2","proxy-agent":"^6.3.1","qs":"^6.11.2","url-join":"^5.0.0","winston":"^3.11.0"},"keywords":["xray","x-ui","3x-ui","3x-ui-js"],"repository":{"type":"git","url":"git+https://github.com/mehdikhody/3x-ui-js.git"},"_id":"3x-ui@2.1.1","gitHead":"335b548aae19a2f8f0c2a1a17aff85e04adb4d1c","bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","_nodeVersion":"18.20.4","_npmVersion":"10.7.0","dist":{"integrity":"sha512-+zDQ+rC7bolshbbuMAOlNmUPB0E+jtbm7DH/7vaUmFtzkUvmVJcwF06dGpXbBTdX47feCyFsoF0O0pHf/T6SRg==","shasum":"c71923cc5f75dd50036b1bd89afa4e87b1da3b5d","tarball":"https://registry.npmjs.org/3x-ui/-/3x-ui-2.1.1.tgz","fileCount":27,"unpackedSize":37462,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVpYU0ZlMA6gLd2ObjpRGK0a53nLKgjvZOfAfHaZkPyAIhAJCD7B9ikKRJQcHabTVfIu14iORmWdPchJXrJA5VHBQp"}]},"_npmUser":{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"},"directories":{},"maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3x-ui_2.1.1_1730601512387_0.5699764710453015"},"_hasShrinkwrap":false}},"time":{"created":"2024-01-06T13:29:25.746Z","modified":"2024-11-03T02:38:32.780Z","1.0.0":"2024-01-06T13:29:25.919Z","1.0.1":"2024-01-06T14:19:17.007Z","1.0.2":"2024-01-06T14:27:17.246Z","1.0.3":"2024-01-18T07:55:45.489Z","1.0.4":"2024-01-27T04:54:01.841Z","1.0.5":"2024-01-27T04:59:44.502Z","1.1.0":"2024-01-27T05:16:03.064Z","1.2.0":"2024-01-28T16:29:48.376Z","1.2.1":"2024-01-29T05:04:42.216Z","1.2.2":"2024-01-29T05:07:03.533Z","1.2.3":"2024-01-29T05:09:26.460Z","1.2.4":"2024-01-29T05:10:34.974Z","1.2.5":"2024-01-29T05:14:20.172Z","1.2.6":"2024-01-29T05:22:08.715Z","1.2.7":"2024-01-29T05:23:08.577Z","1.2.8":"2024-01-29T05:26:04.674Z","1.2.9":"2024-01-29T05:33:22.571Z","1.2.10":"2024-01-29T05:37:36.703Z","1.2.11":"2024-01-29T05:47:09.551Z","1.3.1":"2024-02-02T20:39:20.617Z","1.3.3":"2024-02-02T21:02:09.132Z","1.3.4":"2024-02-06T12:46:57.741Z","1.3.5":"2024-02-06T12:50:57.714Z","1.4.0":"2024-02-10T19:13:29.943Z","1.4.1":"2024-03-03T06:23:41.359Z","1.4.2":"2024-03-06T07:42:10.632Z","1.5.0":"2024-03-07T05:58:25.552Z","1.6.0":"2024-04-27T13:37:05.568Z","1.6.1":"2024-05-20T15:21:19.624Z","1.6.2":"2024-05-20T15:35:06.439Z","1.7.0":"2024-09-26T11:29:18.755Z","1.7.1":"2024-09-26T11:41:12.508Z","2.0.0":"2024-10-08T12:11:20.239Z","2.0.1":"2024-10-08T12:18:49.997Z","2.0.2":"2024-10-10T08:16:53.796Z","2.0.3":"2024-10-10T09:42:51.990Z","2.1.0":"2024-11-03T02:32:16.718Z","2.1.1":"2024-11-03T02:38:32.598Z"},"bugs":{"url":"https://github.com/mehdikhody/3x-ui-js/issues"},"author":{"name":"Mehdi Khodayari","email":"khodayari.khoram@gmail.com","url":"https://github.com/mehdikhody"},"homepage":"https://github.com/mehdikhody/3x-ui-js#readme","keywords":["xray","x-ui","3x-ui","3x-ui-js"],"repository":{"type":"git","url":"git+https://github.com/mehdikhody/3x-ui-js.git"},"description":"This is an interface for 3x-ui panel. It will help developers to create, edit and delete inbounds and clients in a simple way.","maintainers":[{"name":"mehdikhody","email":"khodayari.khoram@gmail.com"}],"readme":"# 3x-ui Node.js SDK\n\nThe 3x-ui is a JavaScript library designed to facilitate communication with the [3x-ui panel](https://github.com/MHSanaei/3x-ui), which runs Xray Core for proxy services. This SDK empowers JavaScript developers to create bots and websites for both commercial and non-commercial uses, providing simplicity, abstraction around the API, caching for improved performance, and mutex for asynchronous safety.\n\nThis package is developed based on [MHSanaei Postman Collection](https://documenter.getpostman.com/view/16802678/2s9YkgD5jm#9cac8101-017e-4415-94e2-d30f4dcf49de) and you can check it out for more information.\n\n### Features\n\n-   ✅ **Simplicity**: Designed with simplicity in mind to streamline the process of interacting with the 3x-ui panel.\n-   ✅ **Abstraction**: Provides an abstraction layer around the 3x-ui API to simplify finding clients by email, uuid (vmess, vless) or password (trojan).\n-   ✅ **Proxy:** Utilizes an underlying proxy agent for communication with the panel if needed.\n-   ✅ **Caching:** Caches responses for improved performance.\n-   ✅ **Mutex:** Provides a mutex, a lock mechanism, to ensure asynchronous safety and prevent race conditions.\n-   ✅ **Debug Mode:** Enables debug mode for detailed logging.\n-   ✅ **TTL:** Allows you to set the cache time in seconds.\n\n## Installation\n\nTo install the 3x-ui SDK, use npm:\n\n```bash\nnpm install 3x-ui\n```\n\n## Usage\n\nFirst, import the SDK:\n\n```js\nimport { XuiApi } from \"3x-ui\";\n```\n\nInitialize the SDK with the URL of your 3x-ui panel:\n\n```js\nconst api = new XuiApi(\"http://username:password@localhost:2053\");\napi.debug = true; // Enables debug mode - defualt is false\napi.stdTTL = 60; // Cache time in seconds - default is 10s\n```\n\nThen, you can utilize the SDK functions:\n\n```js\nconst inbounds = await api.getInbounds();\nconst clientStat = await api.getClient(\"email or clientId\");\nconst clientOptions = await api.getClientOptions(\"email or clientId\");\nconst onlines = await api.getOnlineClients();\n```\n\n## Proxy\n\nThe SDK uses an underlying proxy agent to connect to the panel. You can specify the proxy settings using environment variables such as HTTP_PROXY and HTTPS_PROXY. Refer to the proxy-agent [documentation](https://www.npmjs.com/package/proxy-agent) for more information.\n\n```env\nHTTP_PROXY=\"http://proxy-server-over-tcp.com:3128\"\nHTTPS_PROXY=\"https://proxy-server-over-tls.com:3129\"\n```\n\n## API\n\n### Inbounds\n\n-   `getInbounds()`: Returns an array of all inbounds.\n-   `getInbound(id: number)`: Returns the inbound with the specified ID.\n-   `addInbound(options: InboundOptions)`: Adds a new inbound with the provided options.\n-   `updateInbound(id: number, options: Partial<InboundOptions>)`: Updates the inbound with the specified ID using the provided options.\n-   `resetInboundsStat()`: Resets statistics for all inbounds.\n-   `resetInboundStat(id: number)`: Resets statistics for the inbound with the specified ID.\n-   `deleteInbound(id: number)`: Deletes the inbound with the specified ID.\n\n### Clients\n\n-   `getClient(clientId: string)`: Returns a client with the given `email` or `clientId`.\n-   `getClientIps(clientId: string)`: Returns all client's IPs with the given `email` or `clientId`.\n-   `getClientOptions(clientId: string)`: Returns all client's options with the given `email` or `clientId`.\n-   `addClient(inboundId: number, options: ClientOptions)`: Adds a new client with the given options.\n-   `updateClient(clientId: string, options: Partial<ClientOptions>)`: Updates a client with the given `email` or `clientId`.\n-   `resetClientIps(clientId: string)`: Resets all client's IPs with the given `email` or `clientId`.\n-   `resetClientStat(clientId: string)`: Resets a client's stat with the given `email` or `clientId`.\n-   `deleteClient(clientId: string)`: Deletes a client with the given `email` or `clientId`.\n-   `deleteDepletedClients()`: Deletes all clients that have depleted their traffic.\n-   `deleteInboundDepletedClients(inboundId: number)`: Deletes all clients of an inbound that have depleted their traffic.\n-   `getOnlineClients()`: Returns all online clients.\n\n### Other Functions\n\n-   `sendBackup()`: send backup file via Telegram bot.\n\n## Example\n\nFor more examples, check out [the test directory on our GitHub repository](https://github.com/mehdikhody/3x-ui-js/tree/master/tests).\n","readmeFilename":"README.md"}