diff --git a/apis/websocket/.env.example b/apis/websocket/.env.example new file mode 100755 index 0000000..9e40ca4 --- /dev/null +++ b/apis/websocket/.env.example @@ -0,0 +1,5 @@ +# Safety measures, do not remove +IS_USING_DOT_ENV=1 + +# Your Wit.ai token +WIT_AI_TOKEN="YOUR_TOKEN_HERE" diff --git a/apis/websocket/LICENSE b/apis/websocket/LICENSE new file mode 100755 index 0000000..f288702 --- /dev/null +++ b/apis/websocket/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/apis/websocket/README.md b/apis/websocket/README.md new file mode 100755 index 0000000..b13d97a --- /dev/null +++ b/apis/websocket/README.md @@ -0,0 +1,57 @@ +

+ + + + +
+ + +     + + + + + +     + + +     + + +     + + +     + + + + + +     + + + +
+
+ Continuing the legacy of Vanced +

+ +# 🚙 ReVanced Bot WebSocket API + +![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) + +The WebSocket API for ReVanced bots utilizing BSON for packet transmission with a heartbeating system to monitor the statuses of clients. + +## 📚 Documentation + +Documentation are provided [here](./docs/README.md). + +## 📄 License + +**ReVanced Bot WebSocket API** adopts the [GNU General Public License 3.0](./LICENSE), tl;dr: You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions. \ No newline at end of file diff --git a/apis/websocket/config.json b/apis/websocket/config.json new file mode 100755 index 0000000..06dcc28 --- /dev/null +++ b/apis/websocket/config.json @@ -0,0 +1,9 @@ +{ + "$schema": "./config.schema.json", + + "address": "127.0.0.1", + "port": 3000, + "ocrConcurrentQueues": 1, + "clientHeartbeatInterval": 5000, + "debugLogsInProduction": false +} diff --git a/apis/websocket/config.schema.json b/apis/websocket/config.schema.json new file mode 100755 index 0000000..adc77ed --- /dev/null +++ b/apis/websocket/config.schema.json @@ -0,0 +1,31 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "address": { + "description": "Address to listen on", + "type": "string", + "default": "127.0.0.1" + }, + "port": { + "description": "Port to listen on", + "type": "integer", + "default": 80 + }, + "ocrConcurrentQueues": { + "description": "Number of concurrent queues for OCR", + "type": "integer", + "default": 1 + }, + "clientHeartbeatInterval": { + "description": "Time in milliseconds to wait for a client to send a heartbeat packet, if no packet is received, the server will wait for `clientHeartbeatExtraTime` milliseconds before disconnecting the client", + "type": "integer", + "default": 60000 + }, + "debugLogsInProduction": { + "description": "Whether to print debug logs in production", + "type": "boolean", + "default": false + } + } +} diff --git a/apis/websocket/docs/0_development_environment.md b/apis/websocket/docs/0_development_environment.md new file mode 100644 index 0000000..9e523f1 --- /dev/null +++ b/apis/websocket/docs/0_development_environment.md @@ -0,0 +1,39 @@ +# 🏗️ Setting up the development environment + +> [!IMPORTANT] +> **This project uses [Bun](https://bun.sh) to run and bundle the code.** +> Compatibility with other runtimes (Node.js, Deno, ...) are not guaranteed and most package scripts won't work. + +To start developing, you'll need to set up the development environment first. + +1. Install [Bun](https://bun.sh) + +2. Clone the mono-repository + + ```sh + git clone https://github.com/ReVanced/revanced-helper.git && + cd revanced-helper + ``` + +3. Install dependencies + + ```sh + bun install + ``` + +4. Build packages/libraries + + ```sh + bun build:deps + ``` + +5. Change your directory to this project's root + ```sh + cd apis/websocket + ``` + +## ⏭️ What's next + +The next page will tell you about server configurations. + +Continue: [⚙️ Configuration](./1_configuration.md) diff --git a/apis/websocket/docs/1_configuration.md b/apis/websocket/docs/1_configuration.md new file mode 100644 index 0000000..dd134be --- /dev/null +++ b/apis/websocket/docs/1_configuration.md @@ -0,0 +1,39 @@ +# ⚙️ Configuration + +This is the default configuration: + +```json +{ + "address": "127.0.0.1", + "port": 3000, + "ocrConcurrentQueues": 1, + "clientHeartbeatInterval": 60000, + "debugLogsInProduction": false +} +``` + +--- + +### `config.address` & `config.port` + +The address and port for the server to listen on. + +### `config.ocrConcurrentQueues` + +Amount of concurrent queues that can be run at a time. + +> Setting this too high may cause performance issues. + +### `config.clientHeartbeatInterval` + +Heartbeat interval for clients. See [**💓 Heartbeating**](./packets.md#💓-heartbeating). + +### `config.debugLogsInProduction` + +Whether to print debug logs at all in production mode (when `NODE_ENV` is `production`). + +## ⏭️ What's next + +The next page will tell you how to run and bundle the server. + +Continue: [🏃🏻‍♂️ Running the server](./2_running.md) diff --git a/apis/websocket/docs/2_running.md b/apis/websocket/docs/2_running.md new file mode 100644 index 0000000..6734a27 --- /dev/null +++ b/apis/websocket/docs/2_running.md @@ -0,0 +1,42 @@ +# 🏃🏻‍♂️ Running the server + +There are many methods to run the server. Choose one that suits best for the situation. + +> [!IMPORTANT] +> Make sure you've followed the [**🏗️ Setting up the environment**](./0_development_environment.md) steps. + +## 👷🏻 Development mode (recommended) + +There will be no compilation step, and Bun will automatically watch changes and restart the server for you. + +You can quickly start the server by running: + +```sh +bun dev +``` + +## 🌐 Production mode + +Production mode runs no different from the development server, it simply has less debugging information printed to console by default. However, more production-specific features may come. + +To start the server in production mode, you'll have to: + +1. Set the `NODE_ENV` environment variable to `production` + + > It is very possible to set the value in the `.env` file and let Bun load it, **but it is recommended to set the variable before Bun even starts**. + +2. Start the server + ```sh + bun dev + ``` + +## 📦 Building + +If you're looking to build and host the server somewhere else, you can run: + +```sh +bun bundle +``` + +The files will be placed in the `dist` directory. **Configurations and `.env` files will NOT be copied automatically.** + diff --git a/apis/websocket/docs/3_packets.md b/apis/websocket/docs/3_packets.md new file mode 100644 index 0000000..fe2ea75 --- /dev/null +++ b/apis/websocket/docs/3_packets.md @@ -0,0 +1,33 @@ +# 📨 Packets + +Packets are BSON messages sent to the server. They're structured like the following when decoded: + +```json +{ + "op": 12345, + "d": { + "some_field": "some data" + } +} +``` + +### `packet.op` + +Operation codes are numbers that communicate an action. + +### `packet.d` + +Data fields include additional information for the server to process. They are **either an object with specific fields or just `null`**. + +#### 📦 Schemas and constants + +Schemas for packets and their respective data[^1], and the list of possible operation codes[^2] can be found in the `@revanced/bot-shared` package, with typings as well. + +[^1]: [`@revanced/bot-shared/src/schemas/Packet.ts`](../../packages/shared/src/schemas/Packet.ts) +[^2]: [`@revanced/bot-shared/src/constants/Operation`](../../packages/shared/src/constants/Operation.ts) + +## 💓 Heartbeating + +Heartbeating is a process where the client regularly send each other signals to confirm that they are still connected and functioning. If the server doesn't receive a heartbeat from the client within a specified timeframe, it assume the client has disconnected and closes the socket. + +You can configure the interval in the configuration file. See [**📝 Configuration > `config.clientHeartbeatInterval`**](./1_configuration.md#configclientheartbeatinterval). diff --git a/apis/websocket/docs/README.md b/apis/websocket/docs/README.md new file mode 100755 index 0000000..1ce65ca --- /dev/null +++ b/apis/websocket/docs/README.md @@ -0,0 +1,16 @@ +# 🚙 ReVanced Bot WebSocket API + +This documentation explains how the server works, how to start developing, and how to configure the server. + +# 📖 Table of contents + +0. [🏗️ Setting up the development environment](./0_development_environment.md) +1. [⚙️ Configuration](./1_configuration.md) +2. [🏃🏻‍♂️ Running the server](./2_running.md) +3. [📨 Packets](./3_packets.md) + +## ⏭️ Start here + +The next page will tell you how to set up the development environment. + +Continue: [🏗️ Setting up the development environment](./0_development_environment.md) diff --git a/apis/websocket/package.json b/apis/websocket/package.json new file mode 100755 index 0000000..c4eeb04 --- /dev/null +++ b/apis/websocket/package.json @@ -0,0 +1,49 @@ +{ + "name": "@revanced/bot-websocket-api", + "type": "module", + "private": true, + "version": "0.1.0", + "description": "⚙️ Gateway for bots assisting ReVanced", + "main": "dist/index.js", + "scripts": { + "bundle": "bun build src/index.ts --outdir=dist --target=node --minify --sourcemap=external", + "dev": "bun run src/index.ts --watch", + "build": "bun bundle", + "watch": "bun dev" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/revanced/revanced-helper.git", + "directory": "apis/websocket" + }, + "keywords": [ + "revanced", + "bot", + "server", + "gateway" + ], + "author": "Palm (https://github.com/PalmDevs)", + "contributors": [ + "Palm (https://github.com/PalmDevs)", + "ReVanced (https://github.com/revanced)" + ], + "license": "GPL-3.0-or-later", + "bugs": { + "url": "https://github.com/revanced/revanced-helper/issues" + }, + "homepage": "https://github.com/revanced/revanced-helper#readme", + "dependencies": { + "@fastify/websocket": "^8.2.0", + "@revanced/bot-shared": "workspace:*", + "@sapphire/async-queue": "^1.5.0", + "fastify": "^4.24.3", + "node-wit": "^6.6.0", + "tesseract.js": "^5.0.3" + }, + "devDependencies": { + "@types/node-wit": "^6.0.3", + "@types/ws": "^8.5.10", + "chalk": "^5.3.0", + "typed-emitter": "^2.1.0" + } +} diff --git a/apis/websocket/src/classes/Client.ts b/apis/websocket/src/classes/Client.ts new file mode 100755 index 0000000..5c96086 --- /dev/null +++ b/apis/websocket/src/classes/Client.ts @@ -0,0 +1,218 @@ +import { + ClientOperation, + DisconnectReason, + Packet, + ServerOperation, + deserializePacket, + isClientPacket, + serializePacket, + uncapitalize, +} from '@revanced/bot-shared' +import { EventEmitter } from 'node:events' + +import type TypedEmitter from 'typed-emitter' +import type { RawData, WebSocket } from 'ws' + +export default class Client { + id: string + disconnected: DisconnectReason | false = false + ready: boolean = false + + lastHeartbeat: number = null! + heartbeatInterval: number + + #hbTimeout: NodeJS.Timeout = null! + #emitter = new EventEmitter() as TypedEmitter + #socket: WebSocket + + constructor(options: ClientOptions) { + this.#socket = options.socket + this.heartbeatInterval = options.heartbeatInterval ?? 60000 + this.id = options.id + + this.#socket.on('error', () => this.forceDisconnect()) + this.#socket.on('close', () => this.forceDisconnect()) + this.#socket.on('unexpected-response', () => this.forceDisconnect()) + + this.send({ + op: ServerOperation.Hello, + d: { + heartbeatInterval: this.heartbeatInterval, + }, + }) + .then(() => { + this.#listen() + this.#listenHeartbeat() + this.ready = true + this.#emitter.emit('ready') + }) + .catch(() => { + if (this.disconnected === false) + this.disconnect(DisconnectReason.ServerError) + else this.forceDisconnect(DisconnectReason.ServerError) + }) + } + + on( + name: TOpName, + handler: ClientEventHandlers[typeof name] + ) { + this.#emitter.on(name, handler) + } + + once( + name: TOpName, + handler: ClientEventHandlers[typeof name] + ) { + this.#emitter.once(name, handler) + } + + off( + name: TOpName, + handler: ClientEventHandlers[typeof name] + ) { + this.#emitter.off(name, handler) + } + + send(packet: Packet) { + return new Promise((resolve, reject) => { + try { + this.#throwIfDisconnected( + 'Cannot send packet to client that has already disconnected' + ) + + this.#socket.send(serializePacket(packet), err => + err ? reject(err) : resolve() + ) + } catch (e) { + reject(e) + } + }) + } + + async disconnect(reason: DisconnectReason = DisconnectReason.Generic) { + this.#throwIfDisconnected( + 'Cannot disconnect client that has already disconnected' + ) + + try { + await this.send({ op: ServerOperation.Disconnect, d: { reason } }) + } catch (err) { + throw new Error( + `Cannot send disconnect reason to client ${this.id}: ${err}` + ) + } finally { + this.forceDisconnect(reason) + } + } + + forceDisconnect(reason: DisconnectReason = DisconnectReason.Generic) { + if (this.disconnected !== false) return + + if (this.#hbTimeout) clearTimeout(this.#hbTimeout) + this.#socket.terminate() + + this.ready = false + this.disconnected = reason + + this.#emitter.emit('disconnect', reason) + } + + #throwIfDisconnected(errorMessage: string) { + if (this.disconnected !== false) throw new Error(errorMessage) + + if (this.#socket.readyState !== this.#socket.OPEN) { + this.forceDisconnect(DisconnectReason.Generic) + throw new Error(errorMessage) + } + } + + #listen() { + this.#socket.on('message', data => { + try { + const rawPacket = deserializePacket(this._toBuffer(data)) + if (!isClientPacket(rawPacket)) throw null + + const packet: ClientPacketObject = { + ...rawPacket, + client: this, + } + + this.#emitter.emit('packet', packet) + this.#emitter.emit( + uncapitalize(ClientOperation[packet.op] as ClientEventName), + // @ts-expect-error + packet + ) + } catch (e) { + // TODO: add error fields to sent packet so we can log what went wrong + this.disconnect(DisconnectReason.InvalidPacket) + } + }) + } + + #listenHeartbeat() { + this.lastHeartbeat = Date.now() + this.#startHeartbeatTimeout() + + this.on('heartbeat', () => { + this.lastHeartbeat = Date.now() + this.#hbTimeout.refresh() + + this.send({ + op: ServerOperation.HeartbeatAck, + d: { + nextHeartbeat: this.lastHeartbeat + this.heartbeatInterval, + }, + }).catch(() => {}) + }) + } + + #startHeartbeatTimeout() { + this.#hbTimeout = setTimeout(() => { + if (Date.now() - this.lastHeartbeat > 0) { + // TODO: put into config + // 5000 is extra time to account for latency + const interval = setTimeout( + () => this.disconnect(DisconnectReason.TimedOut), + 5000 + ) + + this.once('heartbeat', () => clearTimeout(interval)) + // This should never happen but it did in my testing so I'm adding this just in case + this.once('disconnect', () => clearTimeout(interval)) + // Technically we don't have to do this, but JUST IN CASE! + } else this.#hbTimeout.refresh() + }, this.heartbeatInterval) + } + + protected _toBuffer(data: RawData) { + if (data instanceof Buffer) return data + else if (data instanceof ArrayBuffer) return Buffer.from(data) + else return Buffer.concat(data) + } +} + +export interface ClientOptions { + id: string + socket: WebSocket + heartbeatInterval?: number +} + +export type ClientPacketObject = Packet & { + client: Client +} + +export type ClientEventName = keyof typeof ClientOperation + +export type ClientEventHandlers = { + [K in Uncapitalize]: ( + packet: ClientPacketObject<(typeof ClientOperation)[Capitalize]> + ) => Promise | void +} & { + ready: () => Promise | void + packet: ( + packet: ClientPacketObject + ) => Promise | void + disconnect: (reason: DisconnectReason) => Promise | void +} diff --git a/apis/websocket/src/events/index.ts b/apis/websocket/src/events/index.ts new file mode 100755 index 0000000..9724ec5 --- /dev/null +++ b/apis/websocket/src/events/index.ts @@ -0,0 +1,17 @@ +import type { ClientOperation } from '@revanced/bot-shared' +import type { Wit } from 'node-wit' +import { ClientPacketObject } from '../classes/Client.js' +import type { Config } from '../utils/getConfig.js' +import type { Logger } from '../utils/logger.js' +import type { Worker as TesseractWorker } from 'tesseract.js' + +export { default as parseTextEventHandler } from './parseText.js' +export { default as parseImageEventHandler } from './parseImage.js' + +export type EventHandler = (packet: ClientPacketObject, context: EventContext) => void | Promise +export type EventContext = { + witClient: Wit + tesseractWorker: TesseractWorker + logger: Logger + config: Config +} \ No newline at end of file diff --git a/apis/websocket/src/events/parseImage.ts b/apis/websocket/src/events/parseImage.ts new file mode 100755 index 0000000..53f8451 --- /dev/null +++ b/apis/websocket/src/events/parseImage.ts @@ -0,0 +1,63 @@ +import { ClientOperation, ServerOperation } from '@revanced/bot-shared' +import { AsyncQueue } from '@sapphire/async-queue' + +import type { EventHandler } from './index.js' + +const queue = new AsyncQueue() + +const parseImageEventHandler: EventHandler = async ( + packet, + { tesseractWorker, logger, config } +) => { + const { + client, + d: { image_url: imageUrl, id }, + } = packet + + logger.debug( + `Client ${client.id} requested to parse image from URL:`, + imageUrl + ) + logger.debug( + `Queue currently has ${queue.remaining}/${config.ocrConcurrentQueues} items in it` + ) + + if (queue.remaining < config.ocrConcurrentQueues) queue.shift() + await queue.wait() + + try { + logger.debug(`Recognizing image from URL for client ${client.id}`) + + const { data, jobId } = await tesseractWorker.recognize(imageUrl) + + logger.debug( + `Recognized image from URL for client ${client.id} (job ${jobId}):`, + data.text + ) + await client.send({ + op: ServerOperation.ParsedImage, + d: { + id, + text: data.text, + }, + }) + } catch { + logger.error( + `Failed to parse image from URL for client ${client.id}:`, + imageUrl + ) + await client.send({ + op: ServerOperation.ParseImageFailed, + d: { + id, + }, + }) + } finally { + queue.shift() + logger.debug( + `Finished processing image from URL for client ${client.id}, queue has ${queue.remaining}/${config.ocrConcurrentQueues} remaining items in it` + ) + } +} + +export default parseImageEventHandler diff --git a/apis/websocket/src/events/parseText.ts b/apis/websocket/src/events/parseText.ts new file mode 100755 index 0000000..bfd7bb9 --- /dev/null +++ b/apis/websocket/src/events/parseText.ts @@ -0,0 +1,42 @@ +import { ClientOperation, ServerOperation } from '@revanced/bot-shared' + +import { inspect as inspectObject } from 'node:util' + +import type { EventHandler } from './index.js' + +const parseTextEventHandler: EventHandler = async ( + packet, + { witClient, logger } +) => { + const { + client, + d: { text, id }, + } = packet + + logger.debug(`Client ${client.id} requested to parse text:`, text) + + try { + const { intents } = await witClient.message(text, {}) + const intentsWithoutIds = intents.map(({ id, ...rest }) => rest) + + await client.send({ + op: ServerOperation.ParsedText, + d: { + id, + labels: intentsWithoutIds, + }, + }) + } catch (e) { + await client.send({ + op: ServerOperation.ParseTextFailed, + d: { + id, + }, + }) + + if (e instanceof Error) logger.error(e.stack ?? e.message) + else logger.error(inspectObject(e)) + } +} + +export default parseTextEventHandler diff --git a/apis/websocket/src/index.ts b/apis/websocket/src/index.ts new file mode 100755 index 0000000..fab0d4e --- /dev/null +++ b/apis/websocket/src/index.ts @@ -0,0 +1,150 @@ +import { fastify } from 'fastify' +import fastifyWebsocket from '@fastify/websocket' + +import { createWorker as createTesseractWorker } from 'tesseract.js' +import witPkg from 'node-wit' +const { Wit } = witPkg + +import { inspect as inspectObject } from 'node:util' + +import Client from './classes/Client.js' + +import { + EventContext, + parseImageEventHandler, + parseTextEventHandler, +} from './events/index.js' + +import { getConfig, checkEnv, logger } from './utils/index.js' +import { WebSocket } from 'ws' +import { DisconnectReason, HumanizedDisconnectReason } from '@revanced/bot-shared' + +// Load environment variables and config + +(async () => { + +const environment = checkEnv(logger) +const config = getConfig() + +if (!config.debugLogsInProduction && environment === 'production') logger.debug = () => {} + +// Workers and API clients + +const tesseractWorker = await createTesseractWorker('eng') +const witClient = new Wit({ + accessToken: process.env['WIT_AI_TOKEN']!, +}) + +process.on('beforeExit', () => tesseractWorker.terminate()) + +// Server logic + +const clients = new Set() +const clientSocketMap = new WeakMap() +const eventContext: EventContext = { + tesseractWorker, + logger, + witClient, + config, +} + +const server = fastify() + .register(fastifyWebsocket, { + options: { + // 16 KiB max payload + // A Discord message can not be longer than 4000 characters + // OCR should not be longer than 16000 characters + maxPayload: 16 * 1024, + }, + }) + .register(async instance => { + instance.get('/', { websocket: true }, async (connection, request) => { + try { + const client = new Client({ + socket: connection.socket, + id: request.hostname, + heartbeatInterval: config.clientHeartbeatInterval, + }) + + clientSocketMap.set(connection.socket, client) + clients.add(client) + + logger.debug(`Client ${client.id}'s instance has been added`) + logger.info( + `New client connected (now ${clients.size} clients) with ID:`, + client.id + ) + + client.on('disconnect', reason => { + clients.delete(client) + logger.info( + `Client ${client.id} disconnected because client ${HumanizedDisconnectReason[reason]}` + ) + }) + + client.on('parseText', async packet => + parseTextEventHandler(packet, eventContext) + ) + + client.on('parseImage', async packet => + parseImageEventHandler(packet, eventContext) + ) + + if (environment === 'development' && !config.debugLogsInProduction) { + logger.debug('Running development mode or debug logs in production is enabled, attaching debug events...') + client.on('packet', ({ client: _, ...rawPacket }) => + logger.debug( + `Packet received from client ${client.id}:`, + inspectObject(rawPacket) + ) + ) + + client.on('heartbeat', () => + logger.debug('Heartbeat received from client', client.id) + ) + } + } catch (e) { + if (e instanceof Error) logger.error(e.stack ?? e.message) + else logger.error(inspectObject(e)) + + const client = clientSocketMap.get(connection.socket) + + if (!client) { + logger.error( + 'Missing client instance when encountering an error. If the instance still exists in memory, it will NOT be removed!' + ) + return connection.socket.terminate() + } + + if (client.disconnected === false) + client.disconnect(DisconnectReason.ServerError) + else client.forceDisconnect() + + clients.delete(client) + + logger.debug( + `Client ${client.id} disconnected because of an internal error` + ) + } + }) + }) + +// Start the server + +logger.debug('Starting with these configurations:', inspectObject(config)) + +await server.listen({ + host: config.address ?? '0.0.0.0', + port: config.port ?? 80, +}) + +const addressInfo = server.server.address() +if (!addressInfo || typeof addressInfo !== 'object') + logger.debug('Server started, but cannot determine address information') +else + logger.info( + 'Server started at:', + `${addressInfo.address}:${addressInfo.port}` + ) + +})() diff --git a/apis/websocket/src/types.d.ts b/apis/websocket/src/types.d.ts new file mode 100755 index 0000000..27a69ed --- /dev/null +++ b/apis/websocket/src/types.d.ts @@ -0,0 +1,9 @@ +declare global { + namespace NodeJS { + interface ProcessEnv { + WIT_AI_TOKEN?: string + } + } +} + +declare type NodeEnvironment = 'development' | 'production' diff --git a/apis/websocket/src/utils/checkEnv.ts b/apis/websocket/src/utils/checkEnv.ts new file mode 100755 index 0000000..6bbe68b --- /dev/null +++ b/apis/websocket/src/utils/checkEnv.ts @@ -0,0 +1,28 @@ +import type { Logger } from './logger.js' + +export default function checkEnv(logger: Logger) { + if (!process.env['NODE_ENV']) logger.warn('NODE_ENV not set, defaulting to `development`') + const environment = (process.env['NODE_ENV'] ?? + 'development') as NodeEnvironment + + if (!['development', 'production'].includes(environment)) { + logger.error( + 'NODE_ENV is neither `development` nor `production`, unable to determine environment' + ) + logger.info('Set NODE_ENV to blank to use `development` mode') + process.exit(1) + } + + logger.info(`Running in ${environment} mode...`) + + if (environment === 'production' && process.env['IS_USING_DOT_ENV']) { + logger.warn('You seem to be using .env files, this is generally not a good idea in production...') + } + + if (!process.env['WIT_AI_TOKEN']) { + logger.error('WIT_AI_TOKEN is not defined in the environment variables') + process.exit(1) + } + + return environment +} diff --git a/apis/websocket/src/utils/getConfig.ts b/apis/websocket/src/utils/getConfig.ts new file mode 100755 index 0000000..2b39b31 --- /dev/null +++ b/apis/websocket/src/utils/getConfig.ts @@ -0,0 +1,37 @@ +import { existsSync } from 'node:fs' +import { resolve as resolvePath } from 'node:path' +import { pathToFileURL } from 'node:url' + +const configPath = resolvePath( + process.cwd(), + 'config.json' +) + +const userConfig: Partial = existsSync(configPath) + ? (await import(pathToFileURL(configPath).href, { + assert: { + type: 'json', + }, + })).default + : {} + +type BaseTypeOf = T extends (infer U)[] + ? U[] + : T extends (...args: any[]) => infer U + ? (...args: any[]) => U + : T extends object + ? { [K in keyof T]: T[K] } + : T + +export type Config = Omit, '$schema'> & {} +export const defaultConfig: Config = { + address: '127.0.0.1', + port: 80, + ocrConcurrentQueues: 1, + clientHeartbeatInterval: 60000, + debugLogsInProduction: false, +} + +export default function getConfig() { + return Object.assign(defaultConfig, userConfig) satisfies Config +} diff --git a/apis/websocket/src/utils/index.ts b/apis/websocket/src/utils/index.ts new file mode 100755 index 0000000..9fe7e87 --- /dev/null +++ b/apis/websocket/src/utils/index.ts @@ -0,0 +1,3 @@ +export { default as getConfig } from './getConfig.js' +export { default as checkEnv } from './checkEnv.js' +export { default as logger } from './logger.js' \ No newline at end of file diff --git a/apis/websocket/src/utils/logger.ts b/apis/websocket/src/utils/logger.ts new file mode 100755 index 0000000..2a71a75 --- /dev/null +++ b/apis/websocket/src/utils/logger.ts @@ -0,0 +1,16 @@ +import { Chalk } from 'chalk' + +const chalk = new Chalk() +const logger = { + debug: (...args) => console.debug(chalk.gray('DEBUG:', ...args)), + info: (...args) => console.info(chalk.bgBlue.whiteBright(' INFO '), ...args), + warn: (...args) => console.warn(chalk.bgYellow.blackBright.bold(' WARN '), chalk.yellowBright(...args)), + error: (...args) => console.error(chalk.bgRed.whiteBright.bold(' ERROR '), chalk.redBright(...args)), + log: console.log, +} satisfies Logger + +export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'log' +export type LogFunction = (...x: any[]) => void +export type Logger = Record + +export default logger \ No newline at end of file diff --git a/apis/websocket/tsconfig.json b/apis/websocket/tsconfig.json new file mode 100755 index 0000000..f69c640 --- /dev/null +++ b/apis/websocket/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.apis.json", + "compilerOptions": { + "baseUrl": ".", + "outDir": "dist", + "module": "ESNext", + "composite": false, + }, + "exclude": ["node_modules", "dist"], + "include": ["./*.json", "src/**/*.ts"] +} \ No newline at end of file