{"_id":"@motrix/nat-api","_rev":"4-3fbb406a875d67a3f035889fedbdab9e","name":"@motrix/nat-api","dist-tags":{"latest":"0.3.4"},"versions":{"0.3.1":{"version":"0.3.1","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.0","debug":"^4.1.1","default-gateway":"^6.0.1","request":"^2.88.2","unordered-array-remove":"^1.0.2","xml2js":"^0.4.23"},"devDependencies":{"standard":"^14.3.4"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"cdbe332bee20d6cb4abd38c150514ee4116d1e22","_id":"@motrix/nat-api@0.3.1","_nodeVersion":"12.16.3","_npmVersion":"6.14.5","dist":{"integrity":"sha512-mUsW8BlSK4bE5kjC5H4oQPjnXXuiRtE2V26tzW/AOroXl5CuhMEr9EDrr+wUFvDHlDwK4B0uSOBa8yILr6AfbQ==","shasum":"de18e7101cc6ed82e9e1e7b5720cb2b40f490246","tarball":"https://registry.npmjs.org/@motrix/nat-api/-/nat-api-0.3.1.tgz","fileCount":10,"unpackedSize":42524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJezyOkCRA9TVsSAnZWagAAWeAQAI2eOAsiW8E4/VEeCxPG\nnEi/rTqGLpLSxbwQtaQqXX3TnIHjJxpT7+d/+1IjFoAXy5klTv70nlIXXpGi\nMLzLCIWxNNENFNZjNbEslxsD5xSZIYv4bazHHmq0TxOUIKQdIpv0pENd2YHH\nq39naYM8GoaETDRVudJeZ+TMfABFQd8a5EeSHqhnYYQvIR4La8oAJ7m+o7/d\nBfPOqwxzdbQeQnGAS53y+4lfregjAn2kK1ohUh6RdAe/m6Ao+ouNHMwlENpe\nt761qzSeTbmIHlsVgj5o6LccBWPTCg3KW6y40YYYfOlnhuNz4Al+t4SQVZyr\nPPBxtA8PamVn/KUQVkuX8k4oingT7TK0VK3wkPbx1H8BkDCuf8vHAl/GGYl6\nWtJjcLCGNB/IjLd3ij4b7OGqUku9x/Cludbp4Wr+n3R9FUCrd+13n5Ii8pWG\nWNWpsFCpbj6/sq2iYHBxvlCQVWVyjVofeuylAbeeJs4GlYk2TwZ9mHhmLeS1\nbuDjAO0Yjl+wiZYsQ661FC40ovrS1iUohiAUknT840zEiqNhfvDLwtt3eu6N\n0yxBuRzt98bfecaH0BSaOpIuydbMePC6jGjzx/S/4qsefIwt6A8wFpwJc5FC\n7EdKbD70Mvc9IQuBrkuPmo5te4jnI16ul9LWgyPLoPCr7i/9WisiGxL3usGP\niAxT\r\n=XBEt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDE5vuZiTNpBwixTt5npkoRZSdr4vGBwyIKnsxLKWrNpAiAnPL0LkfgYStFUz0aeNEr+dDcwVa/msiTEZ1VQSXbqKg=="}]},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.1_1590633379543_0.3871772224134342"},"_hasShrinkwrap":false},"0.3.2":{"version":"0.3.2","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.0","debug":"^4.3.1","default-gateway":"^6.0.3","request":"^2.88.2","unordered-array-remove":"^1.0.2","xml2js":"^0.4.23"},"devDependencies":{"standard":"^16.0.0"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"6e5613834b46e460c7a37694bc9c2c8e71648051","_id":"@motrix/nat-api@0.3.2","_nodeVersion":"12.18.0","_npmVersion":"6.14.4","dist":{"integrity":"sha512-T3LSHnEUULbSU1o1zCZZ1ul8l8Jm98f0fz/0BeF7DhNvrV63YllLCD4vUR9hFZWu/+WTIVPnbH8dBK5Ckuveuw==","shasum":"a1164e25b1401279e2170666b0df3455812e7e1e","tarball":"https://registry.npmjs.org/@motrix/nat-api/-/nat-api-0.3.2.tgz","fileCount":11,"unpackedSize":42678,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyeedCRA9TVsSAnZWagAAWLkP/0tVaH2dPzgI3ADND+A6\nyFOKc7BChUks1KISNj0XO8WcwzP+9jQ0zxtS8iN/xiokVDcmlkDB9S9ECO1P\nZl/w33jOAihx4Rk1HD7FFrDJ8A4RH/MKsp1RN4pNTzgYc5Fyc9v/kRzWL0f2\nF63QITiFRwoCahRntbkTwmiVO35IL7EKjVA/M+qCEZd7TFOB280ZLyKFetzZ\nvJ6Y6a4OCEtLD6D9CicFNKfbyYpniXa0ZmKAYkvNdyjLXezOyAfSw3wdNhMU\n4/viTyockeyqzk48iSJFXNfReF2Kg5LKlv6BWkAkortpcX4PH69jc965cWkf\nH8pPQ9/ngrh6jqdazGNnRFGYIskX8mbZzc3dM/XZ6HO2KvVuvC3dKWDy0yNG\nSN/nCMzLbIHFgHoHlpPjrKMG9zkE31podoGQXRAbhvIityBHfh+SqzZA+Qh7\neXrsVkEnCchY2N60bh8IU8i3/lefY38mAZ2sUL4r0bfAsecJFTv05YyI3vzy\nC8j2IzSgPu7clN6bTa8rLNW3gFwJZgRENmk1rKX0OP48AY1pnSNSrCX182kx\nHTuh8lyZzaK9Nk4E3KofcHx5ZAp1VAwJmb238U97DSB3SADbSOcXTb3xC123\ncAp3EhbFt+GOsua+k6eVx3sl8L/V7EIPtK+llqs0yoJCvqWaZJmvVsJy+gz/\n5yI0\r\n=qedK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFVnfqgFNoMkwwdUZQa40aSzrYoMFgf0d+OZCAFLNwTRAiAv9FTst41WqdlLa2BgQhR616Gc5T9Hx8eyCwxI01SWig=="}]},"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.2_1623844765705_0.9773668890789582"},"_hasShrinkwrap":false},"0.3.3":{"version":"0.3.3","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.4","debug":"^4.3.4","default-gateway":"^6.0.3","node-fetch":"^2.6.9","unordered-array-remove":"^1.0.2","xml2js":"^0.4.23"},"devDependencies":{"standard":"^17.0.0"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"1b6547fca5ed1047701cb8827ec0fcbc1350c729","_id":"@motrix/nat-api@0.3.3","_nodeVersion":"18.15.0","_npmVersion":"9.5.0","dist":{"integrity":"sha512-84U4DbSr7sZ9k7/ywm0uBHfVLxNZdg+lQaLuFW/6sL8E163gJDx3HAYxEBtl0nCzRHay2qPhj/gtH03DezWNKg==","shasum":"31ac9ca24dd3d8c6e75734e18ae3595431f86c31","tarball":"https://registry.npmjs.org/@motrix/nat-api/-/nat-api-0.3.3.tgz","fileCount":11,"unpackedSize":43176,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGhjov7Js7SfCXET1BZi+dZF9QqAaQwjqXDOIZCVjwFBAiEAjKtxsyAD86h9D4+cM2nH/sOb6W1BQ74Cu3FJYp0CbKU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkJDiUACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpa8g/9Fek8ICQP8BtG5LXZqqex38WUTjWz0xaA4CI6iGdvnKl3rjOp\r\nAawaNfsvnWRuRmx2GvV6TCYQaEHDruyd5/7fUP8eN2hR/qkOW+2/8vz57aFm\r\n1kVC//Hxb7QAK0XUGI7lL1tdNa2NWGY76ZEBIoSgma+n1hPI6cGYRF2+Vmqv\r\nyFL3GbLHd0pOly78AhW1RxVRA7PvYulhFjyb4XL5SFFcc9cIVJ3++MR8ymgR\r\nAr/jPYT+vRs2LCcHYU1sO3GlMyu11tdjlH8LQcs0f3EOdj+dMQ9qf+/ussin\r\nG3kGyP/YdaI3nmNi4R4rg/Daiwdrt2yiZehLfAm8MxFtSFHSKIcxZ6ivguJ7\r\nIxJf5rLlBUN8yPxUpOCyWxwiQ6Ew6xgjuz6XnMivLAS2SEhF7K7EDkeaPeW+\r\nyWKgPK+6bz3oIzgzaomy4+v4c5OnXinTIXAB5T7vrZvccFDfXya1aTVIvPXp\r\n8A7Ov9oko+jTfYwzH4gZcKGz8JJUYwsdTCKgz4sLryRPiW1PJqJwHCSmFk8U\r\nAmwr4lXYK2hSSSzqGucPkBujckOWUyYYF5etGdN7Hl8zJcnxM11C7dR3q5kP\r\ngRu7AxVTGIw/j4kDnYjk06JSM8X8GUAan1fSUorr8paCCKcWph1Jze+VYubx\r\nosCS75Lg/ZY+yOU3TVnajlFtC1KFxMSOCbQ=\r\n=y29S\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.3_1680095380019_0.48799024447176653"},"_hasShrinkwrap":false},"0.3.4":{"version":"0.3.4","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.4","debug":"^4.3.4","default-gateway":"^6.0.3","node-fetch":"^2.6.9","unordered-array-remove":"^1.0.2","xml2js":"^0.5.0"},"devDependencies":{"standard":"^17.0.0"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"70a33f8790420189d0a90e695818bff8fa2ab0dd","_id":"@motrix/nat-api@0.3.4","_nodeVersion":"18.15.0","_npmVersion":"9.5.0","dist":{"integrity":"sha512-RIH5sSP329Xn8TjDcAHYHn82VTajhdu2Ee4PTLA+9jCAi5x0D219D1XYW7nCK22ptcLrC+qzBXlWG/j16iuoLQ==","shasum":"8c96bf64edf09f237caac6aaab39fbc823fdc4fa","tarball":"https://registry.npmjs.org/@motrix/nat-api/-/nat-api-0.3.4.tgz","fileCount":11,"unpackedSize":43175,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGKpg7+OU7OXIXAOFI0HWHUGEs9jL837nxeETOI4BsMZAiEAlOm9f0Mo/M80QYpdU1rQsO8l50DXiOZkBL4ke5x9s+k="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkN6GQACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrlOw/9G5snQu+7gbrqpcZ/ui4qcWxPRT74CsijbWUMTw+RH75QklFe\r\nlVhi1DqIIoaaGO/uF4uUdU8FJDlrrmZ6tqHwSHe/hw7Pejxalu3XLZHnIO9w\r\nL4VyrRnFZkfMMBVoQoiqlDmkHjiXuY6uiDOGjJaqPupQMQ/qG05gEGF3+1YP\r\nNalRULu5ovFdJVMlk47KZ3MYz8l1jdTrKCbT9/+P00CfT2eL+WuFrxdZDgSs\r\n+LmB98lXOi+6TUTz2+rDuzrFwY8PxzWnR2n836BTknVpm8vul+jbBbDJ0vNo\r\nR69SKV69sqGF5TmdCPcG4WerGUmR8yutyHFk4z8MGd70tN8DkY8YlhkKfzng\r\n3Fe/s4rqKP5d1TVEquLPuuoQMApwUONotL38+Mqrrp6IgT2jt8TfTr0LJuwa\r\n7/OxoDHTjz5jJiN2Pe+5dFRlp7VZufiFOsCSdS9bT8Wki1NGCc6FQo/v4dgr\r\ny8Fw54q7aeUdC+iq7WhfRPTP0Gs0GkwRzevYzP1fgfB9i5makci4x3lLf/kN\r\n5ZenOtnayqugqb1+2/PkoJK1YU2Vngq2p/YYsK5yu8Ygm/Yv8UYt+VtxGDMx\r\n9MCTJcsowpVVVe21LEzZgAqm5iuPVR9FXA9/iuLlqiW8DPVNhpQ79jHmyUtT\r\nKOjHDDLvKQBCXzKdUeAR5JbFo7XMDosuUJE=\r\n=OMo8\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.4_1681367440214_0.877450950054032"},"_hasShrinkwrap":false}},"time":{"created":"2020-05-28T02:36:19.300Z","0.3.1":"2020-05-28T02:36:19.647Z","modified":"2023-04-13T06:30:40.542Z","0.3.2":"2021-06-16T11:59:25.817Z","0.3.3":"2023-03-29T13:09:40.201Z","0.3.4":"2023-04-13T06:30:40.421Z"},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"description":"Port mapping with UPnP and NAT-PMP","homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"license":"MIT","readme":"# nat-api\n\n[![NPM Version][nat-api-ni]][nat-api-nu]\n[![Build Status][nat-api-bi]][nat-api-bu]\n[![Dependency Status][nat-api-di]][nat-api-du]\n[![Standard - Javascript Style Guide][standard-image]][standard-url]\n\nFast port mapping with **UPnP** and **NAT-PMP** in NodeJS.\n\n## Install\n\n**Required: NodeJS >= 10**\n\n```sh\nnpm install nat-api\n```\n\n## Usage\n\n```js\nconst NatAPI = require('nat-api')\n\nconst client = new NatAPI()\n\n// Map public port 1000 to private port 1000 with UDP and TCP\nclient.map(1000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Map public port 2000 to private port 3000 with UDP and TCP\nclient.map(2000, 3000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Map public port 4000 to private port 5000 with only UDP\nclient.map({ publicPort: 4000, privatePort: 5000, ttl: 1800, protocol: 'UDP' }, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Unmap port public and private port 1000 with UDP and TCP\nclient.unmap(1000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port unmapped!') \n})\n\n// Get external IP\nclient.externalIp(function(err, ip) {\n  if (err) return console.log('Error', err)\n  console.log('External IP:', ip)\n})\n\n// Destroy object\nclient.destroy()\n```\n\n## API\n\n### `client = new NatAPI([opts])`\n\nCreate a new `nat-api` instance.\n\nIf `opts` is specified, then the default options (shown below) will be overridden.\n\n```js\n{\n  ttl: 1200, // Time to live of each port mapping in seconds (default: 1200)\n  autoUpdate: true, // Refresh all the port mapping to keep them from expiring (default: true)\n  gateway: '192.168.1.1', // Default gateway (default: null)\n  enablePMP: false // Enable PMP (default: false)\n}\n```\n\nIf `gateway` is not set, then `nat-api` will get the default gateway based on the current network interface.\n\n### `client.map(port, [callback])`\n* `port`: Public and private ports\n* `callback`\n\nThis method will use `port` por mapping the public port to the same private port.\n\nIt uses the default TTL and creates a map for UDP and TCP.\n\n### `client.map(publicPort, privatePort, [callback])`\n* `publicPort`: Public port\n* `privatePort`: Private port\n* `callback`\n\nThis is another quick way of mapping `publciPort` to `privatePort` with any protocol (UDP and TCP).\n\n### `client.map(opts, [callback])`\n* `opts`:\n - `publicPort`: Public port\n - `privatePort`: Private port\n - `protocol`: Port protocol (`UDP`, `TCP` or `null` for both)\n - `ttl`: Overwrite the default TTL in seconds.\n - `description`: Description of the port mapping\n* `callback`\n\n### `client.unmap(port, [callback])`\n\nUnmap any port that has the public port or private port equal to `port`.\n\n### `client.unmap(publicPort, privatePort, [callback])`\n\nUnmap any port that has the public port or private port equal to `publicPort` and `privatePort`, respectively.\n\n### `client.unmap(opts, [callback])`\n\nUnmap any port that contains the parameters provided in `opts`.\n\n### `client.externalIp([callback])`\n* `callback(err, ip)`\n\nGet the external IP address.\n\n### `client.destroy([callback])`\n\nDestroy the client. Unmaps all the ports open with `nat-api` and cleans up large data structure resources.\n\n## Additional Information\n\n- http://miniupnp.free.fr/nat-pmp.html\n- http://wikipedia.org/wiki/NAT_Port_Mapping_Protocol\n- http://tools.ietf.org/html/draft-cheshire-nat-pmp-03\n\n\n## License\n\nMIT. Copyright (c) [Alex](https://github.com/alxhotel)\n\n[nat-api-ni]: https://img.shields.io/npm/v/nat-api.svg\n[nat-api-nu]: https://npmjs.org/package/nat-api\n[nat-api-bi]: https://img.shields.io/github/workflow/status/alxhotel/nat-api/ci/master\n[nat-api-bu]: https://github.com/alxhotel/nat-api/actions\n[nat-api-di]: https://img.shields.io/librariesio/release/npm/nat-api\n[nat-api-du]: https://libraries.io/npm/nat-api\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n","readmeFilename":"README.md"}