{"_id":"@ditchoom/mqtt-4-models","_rev":"1-73ed33a6e18b6427eb3595a9d5ac7dbd","name":"@ditchoom/mqtt-4-models","dist-tags":{"latest":"1.0.32"},"versions":{"1.0.31":{"name":"@ditchoom/mqtt-4-models","version":"1.0.31","main":"mqtt-4-models.js","gitHead":"f6ab74ac0100fba93e4f057a9b3996d543adf065","description":"[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linke","_id":"@ditchoom/mqtt-4-models@1.0.31","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-YfRANz/JWaKxbMmGEleoW3WMUKZ8hlJRcGFkLHuDQgh9peyuEBW1WLx4hePCkoeXdAyda1MbsBf4JmV/s6rHSA==","shasum":"4eca2e716e41646744e6210af1ac4c3e8fc72f71","tarball":"https://registry.npmjs.org/@ditchoom/mqtt-4-models/-/mqtt-4-models-1.0.31.tgz","fileCount":6,"unpackedSize":417424,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDUi2eydd2s2wyCya9s2y9FA1dzCYievMpXYp6T25F7EwIgL4g+EBit4whcXE7MGlgrnI8C+ljBW9Hn/OVweSIoe8o="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjAWsjACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoEIQ//b8vBSG+sLKRpZld/yeQtHCtF2eNALOjuNEB28QjTJNU5VNme\r\nCYIzRPkc3PGKMqXVWBLbTmHLNxBPn9CWVhChhimePIqRlFIko9+nYsfmFPeQ\r\nuwSHqB7Dhb2KXvfXhhnPe6vA3aaA6KF5cnV64uSYKXzvHGFvOjWcW62BjyYn\r\nKpgHnchgui5Hu1uQrszKldPhxmdQlfsDj904+XRg95rYPT3eLpyN7OJB8a5F\r\n1yVV37JJ0Y96ZFF1wZpyUC0HEIw2cvwMI5K9JVvDyTtJw31TXZL5v/hAA2R9\r\n6EEeJC9zxvWx9Biwe/dVt+Z1u8pd1esrGfBNs416kUWo5F+hoDAdRmPTQEWe\r\nqxLGh1fDMfczHbZeup8FxcreEBp+4/1k0wb5WCvLUUYfmWZAyW0AnAMsrHsT\r\nLtXI40AVWjVhyg+2/D5v8KzT17NKnhbCkZ3x1yWZTq5kcjjm7nWGWVVlhfwW\r\n4h+r8uGulSox+P4LdyWlfePcvHmdvRLcgqgceV+6Q24vYemPZlg/ldSowtjo\r\nTlgF77pudd6Wa4SvHMgsUN7aE5MJU6X6WAyW6fOqGg7F1LTHg++B1vWTfvkG\r\nITdBHF53lTOdcPArIEtOvVMGuUEs8S7NR+OSY5rXPIGDSHC/WTNQR1pRWIfl\r\n808DrFyyicWap2LQsmGYAx+X+59vHcqih+U=\r\n=0OjT\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"thebehera","email":"rbehera@gmail.com"},"directories":{},"maintainers":[{"name":"thebehera","email":"rbehera@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mqtt-4-models_1.0.31_1661037347358_0.18283784112482904"},"_hasShrinkwrap":false},"1.0.32":{"name":"@ditchoom/mqtt-4-models","version":"1.0.32","main":"mqtt-4-models.js","gitHead":"127f7fa1cb5ab49b7f6f79de8a688bea65fdc3fb","description":"[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linke","_id":"@ditchoom/mqtt-4-models@1.0.32","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-+E1tiXD0VzTwB37WOA1/0neLG0OEplYGHpKUf+Edfn8LNg09qsu/Xca39HQIfiYWcDuvuKJnofeeHtdc+jKz+Q==","shasum":"c6429a0453f5f723dbb05a6e645beb593fcfd701","tarball":"https://registry.npmjs.org/@ditchoom/mqtt-4-models/-/mqtt-4-models-1.0.32.tgz","fileCount":6,"unpackedSize":421083,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIApFqTnYb4K5xvjB7++dNp3kJaPYpZ9jdnMKVFDHdl9QAiEAqJ1fVyViq6TW4fOKkTTNCr1TcP7r+DGRNClQa8Sfr5E="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjdBfoACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrJSw//Y9YiAgw9oUF2ym/RtDttsRUiGKrB7zNd9eYdD67+3/pqFOfQ\r\noPpzdzR3L3nZy8HZuRHShFS0SgF8WD0Ph1Dvn77JcsGwe+Tb0cerUniL7/PD\r\nj1mNtCdOkPPCaqePaAzOKQgXksXADtNURsdswApK/xwgU1OrcJpQtAymhe40\r\nY0s9YN6gaFElBsJ3LaXxa2pPskkQ4imwzAvcVQUvBN1gvMYiPj22snWI3pZ3\r\nxZz3laq+CrObbnlwC51wMVueepWHgpKlRSTDv5O5ris6+ZegLEzFZD3qTD/J\r\n1/AhpocalVU0lHdz+GyDL/M9lrNvRKc8XdgDOhosmYIA8c1FaK1nPycV19Iy\r\n3Vvxom/a0tv23LuccIo3B2N9x/GWQQ+kKxSDt5WSwtTf57jLIQJu1auiMWSO\r\n4vGRYFwmyWR6oBdYSka/MboLjwTIVUnFhDRmmR+wI/XVJxaglCRJ3tTIiYo7\r\niieJXOPRBcgOuUL784Sm4v26gOC0jWwsX24QkBbr6yYD38a/viOtQJm6QNWz\r\ncF/tGvuVGJ5j7gmTcWu4Q393m0NVuJjLAzNzWKcD/wCuKhIGeRnqFH0AI2TP\r\n5n3086CmxODCsUn6vHopMLgsdW+KHJoF74IyJIhP5zyShb0x5d2iaA+Kq6Qf\r\n8kanPAV/DYhIMiQ83VewwKFPhvCqumqbjIs=\r\n=GaZa\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"thebehera","email":"rbehera@gmail.com"},"directories":{},"maintainers":[{"name":"thebehera","email":"rbehera@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mqtt-4-models_1.0.32_1668552679793_0.16401989755785618"},"_hasShrinkwrap":false}},"time":{"created":"2022-08-20T23:15:47.305Z","1.0.31":"2022-08-20T23:15:47.547Z","modified":"2022-11-15T22:51:20.196Z","1.0.32":"2022-11-15T22:51:20.084Z"},"maintainers":[{"name":"thebehera","email":"rbehera@gmail.com"}],"description":"[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linke","readme":"[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\n<!-- PROJECT LOGO -->\n<!--suppress ALL -->\n\n<br />\n<p align=\"center\">\n<h3 align=\"center\">MQTT 4 Models</h3>\n\n<p align=\"center\">\nA kotlin multiplatform library which defines all the MQTT 4 models defined in the MQTT spec.\n<br />\n<!-- <a href=\"https://github.com/DitchOoM/mqtt-4-models\"><strong>Explore the docs »</strong></a> -->\n<br />\n<br />\n<a href=\"https://github.com/DitchOoM/mqtt-4-models/issues\">Report Bug</a>\n·\n<a href=\"https://github.com/DitchOoM/mqtt-4-models/issues\">Request Feature</a>\n</p>\n\n\n<details open=\"open\">\n  <summary>Table of Contents</summary>\n  <ol>\n    <li>\n      <a href=\"#about-the-project\">About The Project</a>\n      <ul>\n        <li><a href=\"#runtime-dependencies\">Runtime Dependencies</a></li>\n      </ul>\n      <ul>\n        <li><a href=\"#supported-platforms\">Supported Platforms</a></li>\n      </ul>\n    </li>\n    <li><a href=\"#installation\">Installation</a></li>\n    <li>\n      <a href=\"#usage\">Usage</a>\n      <ul>\n        <li><a href=\"#Serializing-and-deserializing-a-packet-from-a-buffer\">Serializing and deserializing a packet from a buffer</a></li>\n      </ul>\n    </li>\n    <li>\n      <a href=\"#building-locally\">Building Locally</a>\n    </li>\n    <li><a href=\"#getting-started\">Getting Started</a></li>\n    <li><a href=\"#roadmap\">Roadmap</a></li>\n    <li><a href=\"#contributing\">Contributing</a></li>\n    <li><a href=\"#license\">License</a></li>\n  </ol>\n</details>\n\n## About The Project\n\n### Runtime Dependencies\n\n* [Buffer](https://github.com/DitchOoM/buffer)\n* [MQTT Base Models](https://github.com/DitchOoM/mqtt-base-models)\n\n### [Supported Platforms](https://kotlinlang.org/docs/reference/mpp-supported-platforms.html)\n\n| Platform | 🛠Builds🛠 + 🔬Tests🔬 |         Deployed Artifact          | Non Kotlin Sample |  \n| :---: | :---: |:----------------------------------:|:-----------------:|\n| `JVM` 1.8 |🚀| [maven central][maven-central] 🔮  |        WIP        |\n| `Node.js` |🚀|           [npm][npm] 🔮            |        WIP         |\n| `Browser` (Chrome) |🚀|           [npm][npm] 🔮            |        WIP         |\n| `Android` |🚀| [maven central][maven-central]  🔮 |        WIP         |\n| `iOS` |🚀|    WIP [cocoapods][cocoapods] 🔮      |        WIP         |\n| `WatchOS` |🚀|    WIP [cocoapods][cocoapods] 🔮      |        WIP         |\n| `TvOS` |🚀|    WIP [cocoapods][cocoapods] 🔮      |        WIP         |\n| `MacOS` |🚀|    WIP [cocoapods][cocoapods] 🔮      |        WIP         |\n| `Linux X64` |🚀|    WIP [apt][apt]/[yum][yum] 🔮    |        WIP         |\n| `Windows X64` |🚀|  WIP [chocolatey][chocolately] 🔮  |        WIP         |\n\n## Installation\n\n### Gradle\n\n- [Add `implementation(\"com.ditchoom:mqtt-4-models:$version\")` to your `build.gradle` dependencies](https://search.maven.org/artifact/com.ditchoom/mqtt-4-models)\n\n### NPM\n\n- [execute `npm i @ditchoom/mqtt-4-models`](https://www.npmjs.com/package/@ditchoom/mqtt-4-models)\n\n## Usage\n\n## Serializing and deserializing a packet from a buffer\n\n```kotlin\nval connectionRequest = ConnectionRequest(clientId = \"test\", userName = \"yolo\")\nval buffer = PlatformBuffer.allocate(connectionRequest.packetSize())\nconnectionRequest.serialize(buffer)\nbuffer.resetForRead()\n\nval connectionRequestFromBuffer = ControlPacketV4Factory.from(buffer)\n// or can be done without having to specify version number directly\nval connectionRequestFromBuffer = connectionRequest.controlPacketFactory.from(buffer)\nassertEquals(connectionRequest, connectionRequestFromBuffer)\n```\n\n## Building Locally\n\n- `git clone git@github.com:DitchOoM/mqtt-4-models.git`\n- Open cloned directory with [Intellij IDEA](https://www.jetbrains.com/idea/download).\n    - Be sure\n      to [open with gradle](https://www.jetbrains.com/help/idea/gradle.html#gradle_import_project_start)\n\n## Roadmap\n\nSee the [open issues](https://github.com/DitchOoM/mqtt-4-models/issues) for a list of proposed\nfeatures (and known issues).\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire,\nand create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nDistributed under the Apache 2.0 License. See `LICENSE` for more information.\n\n[contributors-shield]: https://img.shields.io/github/contributors/DitchOoM/mqtt-4-models.svg?style=for-the-badge\n\n[contributors-url]: https://github.com/DitchOoM/mqtt-4-models/graphs/contributors\n\n[forks-shield]: https://img.shields.io/github/forks/DitchOoM/mqtt-4-models.svg?style=for-the-badge\n\n[forks-url]: https://github.com/DitchOoM/mqtt-4-models/network/members\n\n[stars-shield]: https://img.shields.io/github/stars/DitchOoM/mqtt-4-models.svg?style=for-the-badge\n\n[stars-url]: https://github.com/DitchOoM/mqtt-4-models/stargazers\n\n[issues-shield]: https://img.shields.io/github/issues/DitchOoM/mqtt-4-models.svg?style=for-the-badge\n\n[issues-url]: https://github.com/DitchOoM/mqtt-4-models/issues\n\n[license-shield]: https://img.shields.io/github/license/DitchOoM/mqtt-4-models.svg?style=for-the-badge\n\n[license-url]: https://github.com/DitchOoM/mqtt-4-models/blob/master/LICENSE.md\n\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n\n[linkedin-url]: https://www.linkedin.com/in/thebehera\n\n[maven-central]: https://search.maven.org/search?q=com.ditchoom\n\n[npm]: https://www.npmjs.com/search?q=ditchoom-mqtt-4-models\n\n[cocoapods]: https://cocoapods.org/pods/DitchOoM-mqtt-4-models\n\n[apt]: https://packages.ubuntu.com/search?keywords=ditchoom&searchon=names&suite=groovy&section=all\n\n[yum]: https://pkgs.org/search/?q=DitchOoM-mqtt-4-models\n\n[chocolately]: https://chocolatey.org/packages?q=DitchOoM-mqtt-4-models\n","readmeFilename":"README.md"}