diff --git a/.gitignore b/.gitignore index 0f3b873..558abdc 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,7 @@ src/config.ts ./src/config.ts /src/config.ts -images/** +images/*/** !images/README.md package-lock.json diff --git a/LICENSE b/LICENSE index ecaaae3..e72bfdd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2022 NekoNya - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + 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 +. \ No newline at end of file diff --git a/README.md b/README.md index 8161713..dd748bb 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ ## 📝・Description -NekoNya Storage is NekoNya's Cloud storage system (I don't know if I can really call this a cloud..).It is a simple server that stores, runs a web server so you can access them and has an API. -Warning: This is a private server. Any use of this server for something else without our permission is prohibited. +NekoNya-Storage is a Node.JS TypeScript webserver serving NekoNya's files and running the API behind the scenes. -## 📚・How to use +If you wish to deploy your own instance of NekoNya-Storage for any reasons, you can do so by following the instructions below. But please, do not forget to give credit to the original authors of this project. + +## 📚・How to deploy ### 📦・Install @@ -19,15 +20,24 @@ $ npm install ### 📝・Configuration -Change the file `config.example.ts` to `config.ts` and change the values to your liking. -> Note: The configuration file is documented. +Change the file `src/config.example.ts` to `config.ts` and change the values to your liking. The configuration file is commented so you can easily understand what each value does. + +Don't forget to add images in the categories inside of the `images` folder. ### 🚀・Run +Production: + ```bash $ npm start ``` +Development: + +```bash +$ npm run dev +``` + ## 📜・License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details \ No newline at end of file +This project is licensed under the GNU GPL 3.0 License - see the [LICENSE](LICENSE) file for details \ No newline at end of file diff --git a/package.json b/package.json index 6706d09..fa2f8a7 100644 --- a/package.json +++ b/package.json @@ -1,28 +1,27 @@ { "name": "nekonya-storage", - "version": "1.0.5", - "description": "The storage server of NekoNya.", - "main": "lib/index.js", + "version": "2.0.5", + "description": "The static storage server and API of NekoNya.", + "main": "src/index.ts", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "start": "npx tsc && node lib/index.js" + "start": "cross-env NODE_ENV=production npx tsx src/index", + "dev": "cross-env NODE_ENV=development npx tsx src/index" }, "keywords": [], "author": "TheDogHusky", - "license": "ISC", + "license": "GPL-3.0-or-later", "dependencies": { "@classycrafter/super-logger": "^2.0.00", - "chalk": "^4.1.2", "cors": "^2.8.5", - "ejs": "^3.1.8", + "cross-env": "^7.0.3", "express": "^4.18.2", - "jose": "^4.13.1", - "node-fetch": "^2.6.9" + "express-validator": "^7.1.0", + "tsx": "^4.16.2" }, "devDependencies": { - "typescript": "^4.9.5", "@types/cors": "^2.8.13", "@types/express": "^4.17.17", - "@types/node-fetch": "^2.6.2" + "typescript": "^4.9.5" } } diff --git a/src/api/index.ts b/src/api/index.ts index 2dc3512..0ae946a 100644 --- a/src/api/index.ts +++ b/src/api/index.ts @@ -1,5 +1,4 @@ import fs from 'fs'; -import path from 'path'; import {Router} from 'express'; import {Logger} from "@classycrafter/super-logger"; @@ -15,8 +14,8 @@ export default (logger: Logger) => { }); fs.readdirSync(__dirname).forEach(dir => { - if(dir === 'index.ts' || dir === "index.js") return; - const route = require('./' + dir).default; + if(dir === 'index.ts') return; + const route = require('./' + dir).default(logger); router.use(`/${dir}/`, route); logger.info(`Loaded API version ${dir}`, "API"); }); diff --git a/src/api/v1/8ball.ts b/src/api/v1/8ball.ts new file mode 100644 index 0000000..c9af4ab --- /dev/null +++ b/src/api/v1/8ball.ts @@ -0,0 +1,66 @@ +import { Router } from 'express'; +const router = Router(); + +const eightballAnswers = [ + "It is certain", + "It is decidedly so", + "Without a doubt", + "Yes, definitely", + "You may rely on it", + + "As I see it, yes", + "Most likely", + "Outlook good", + "Yes", + "Signs point to yes", + + "Reply hazy try again", + "Ask again later", + "Better not tell you now", + "Cannot predict now", + "Concentrate and ask again", + + "Don't count on it", + "My reply is no", + "My sources say no", + "Outlook not so good", + "Very doubtful" +]; + +const cuteEightballAnswers = [ + "Yes!!", + "Of Cwurse!", + "Yes, definitelwy nya!", + "Without any doubts nya!", + "My tail says yess!", + + "Mhh.. I think so!", + "Most likely!", + "Outwook good!", + "Yesh!", + "Signs point to yes!", + + "I don't know nya..", + "Ask again later, nya!", + "Better not twell you now!", + "Cannot predict now..", + "Concentrate and ask again! :3", + + "Don't count on it! >:c", + ">-< My reply is nyo!", + "My sources say nyo!", + "Outlook nyot so good! :c", + "Very doubtfwul!" +]; + +router.get('/', (req, res) => { + const cute = req.query.cute || false; + const answers = cute ? cuteEightballAnswers : eightballAnswers; + const answer = answers[Math.floor(Math.random() * answers.length)]; + + res.status(200).json({ + answer: answer + }); +}); + +export default router; \ No newline at end of file diff --git a/src/api/v1/endpoints.ts b/src/api/v1/endpoints.ts new file mode 100644 index 0000000..1bbad25 --- /dev/null +++ b/src/api/v1/endpoints.ts @@ -0,0 +1,67 @@ +import { Router } from 'express'; +const router = Router(); + +router.get("/", (req, res) => { + res.status(200).json([ + { + "name": "random", + "description": "Get random images", + "path": "/random", + "methods": ["GET"], + "parameters": [ + { + "name": "type", + "description": "Type of image", + "required": true, + "type": "string", + "values": ["neko", "kitsune", "pat", "kisse", "hug", "lewd", "slap"] + } + ], + "queries": [], + "body": [] + }, + { + "name": "8ball", + "description": "Get a random 8ball response", + "path": "/8ball", + "methods": ["GET"], + "parameters": [], + "queries": [ + { + "name": "cute", + "description": "If you want the response to be cute", + "required": false, + "type": "boolean" + } + ], + "body": [] + }, + { + "name": "owoify", + "description": "Owoify text (make it cute)", + "path": "/owoify", + "methods": ["GET", "POST"], + "parameters": [], + "queries": [ + { + "name": "text", + "description": "Text to owoify", + "required": true, + "type": "string" + } + ], + "body": [ + { + "name": "text", + "description": "Text to owoify", + "required": true, + "type": "string", + "max_length": 2000, + "min_length": 1 + } + ] + } + ]); +}); + +export default router; \ No newline at end of file diff --git a/src/api/v1/index.ts b/src/api/v1/index.ts index 9d32703..8008689 100644 --- a/src/api/v1/index.ts +++ b/src/api/v1/index.ts @@ -1,41 +1,26 @@ import fs from 'fs'; import path from 'path'; import {Router} from 'express'; -import {isValidToken} from "../../structures/functions"; +import {Logger} from "@classycrafter/super-logger"; -// Load every file here in this directory except this file, then load the returned route inside a router object which is then exported const router = Router(); router.get('/', (req, res) => { res.status(200).json({ status: 200, message: 'OK', - version: 'v1' + version: 'v1', + endpoints: '/endpoints' }); }); -router.use(async (req, res, next) => { - if(req.path === '/token') return next(); +export default (logger: Logger) => { + const files = fs.readdirSync(__dirname).filter(file => file !== path.basename(__filename)); + for (const file of files) { + const route = require('./' + file).default; + const fileName = file.replace('.ts', ''); + router.use(`/${fileName}`, route); + logger.info(`Loaded route /api/v1/${fileName}`, "API"); + } - await isValidToken(req).then((result) => { - if (result.status !== 200) { - return res.status(result.status).json({ - status: result.status, - error: result.error, - message: result.message - }); - } - - next(); - }).catch((err: Error) => { - next(err); - }); -}); - -const files = fs.readdirSync(__dirname).filter(file => file !== path.basename(__filename) && file.endsWith('.js')); -for (const file of files) { - const route = require('./' + file).default; - const fileName = file.replace('.js', ''); - router.use(`/${fileName}`, route); -} - -export default router; \ No newline at end of file + return router; +}; \ No newline at end of file diff --git a/src/api/v1/list.ts b/src/api/v1/list.ts deleted file mode 100644 index e5e4ee9..0000000 --- a/src/api/v1/list.ts +++ /dev/null @@ -1,43 +0,0 @@ -import { Router } from 'express'; -const router = Router(); -import fs from 'fs'; -import {ImageInfo} from '../../utils/interfaces'; - -router.get('/:type', (req, res) => { - const type = req.params.type; - - const types = ['all', 'nekos', 'kitsunes', 'pats', 'kisses', 'hugs', 'lewds', 'slaps']; - if(!types.includes(type)) return res.status(400).json({ - status: 400, - error: 'Bad Request', - message: 'Invalid type' - }); - - let files: (ImageInfo | string)[] = []; - - if(type === 'all') { - for (const type of types) { - if(type === 'all') continue; - const dirFiles = fs.readdirSync(`./images/${type}`) - const toPush: ImageInfo = { - type: type, - count: dirFiles.length, - files: dirFiles - }; - files.push(toPush); - } - } - else files = fs.readdirSync(`./images/${type}`); - - return res.status(200).json({ - status: 200, - message: 'OK', - data: { - type: type, - count: files.length, - files: files - } - }); -}); - -export default router; \ No newline at end of file diff --git a/src/api/v1/owoify.ts b/src/api/v1/owoify.ts new file mode 100644 index 0000000..661916b --- /dev/null +++ b/src/api/v1/owoify.ts @@ -0,0 +1,63 @@ +import { Router } from 'express'; +const router = Router(); +import { owoifyGetValidator, owoifyPostValidator } from "../../utils"; +import { Request, Response } from 'express'; +import { matchedData, validationResult } from "express-validator"; + +router.get('/', owoifyGetValidator, (req: Request, res: Response) => { + const results = validationResult(req); + if(!results.isEmpty()) return res.status(400).json({ + message: 'Validation failed', + errors: results.array() + }); + + const text: string | undefined = matchedData(req).text as string | undefined; + if(!text) return res.status(400).json({ + error: { + status: 400, + message: 'Missing text' + } + }); + + const owoified = text.replace(/(?:r|l)/g, "w") + .replace(/(?:R|L)/g, "W") + .replace(/n([aeiou])/g, 'ny$1') + .replace(/N([aeiou])/g, 'Ny$1') + .replace(/N([AEIOU])/g, 'Ny$1') + .replace(/ove/g, "uv") + .replace(/!+/g, " " + "owo"); + + res.status(200).json({ + "result": owoified + }); +}); + +router.post('/', owoifyPostValidator, (req: Request, res: Response) => { + const results = validationResult(req); + if(!results.isEmpty()) return res.status(400).json({ + message: 'Validation failed', + errors: results.array() + }); + + const text: string | undefined = matchedData(req).text as string | undefined; + if(!text) return res.status(400).json({ + error: { + status: 400, + message: 'Missing text' + } + }); + + const owoified = text.replace(/(?:r|l)/g, "w") + .replace(/(?:R|L)/g, "W") + .replace(/n([aeiou])/g, 'ny$1') + .replace(/N([aeiou])/g, 'Ny$1') + .replace(/N([AEIOU])/g, 'Ny$1') + .replace(/ove/g, "uv") + .replace(/!+/g, " " + "owo"); + + res.status(200).json({ + "result": owoified + }); +}); + +export default router; \ No newline at end of file diff --git a/src/api/v1/random.ts b/src/api/v1/random.ts new file mode 100644 index 0000000..caf624d --- /dev/null +++ b/src/api/v1/random.ts @@ -0,0 +1,37 @@ +import { Router } from 'express'; +const router = Router(); +import fs from 'fs'; +import { getBaseURL } from "../../utils"; + +router.get("/", (req, res) => { + res.redirect("/api/v1/random/neko"); +}); + +router.get('/:type', (req, res) => { + const type = req.params.type; + + const types = ['all', 'neko', 'kitsune', 'pat', 'kisse', 'hug', 'lewd', 'slap']; + if(!types.includes(type)) return res.status(400).json({ + status: 400, + error: 'Bad Request', + message: 'Invalid type' + }); + + let files: string[] = []; + + if(type === 'all') { + for (const type of types) { + if(type === 'all') continue; + const dirFiles = fs.readdirSync(`./images/${type}s`) + files.push(...dirFiles); + } + } + else files = fs.readdirSync(`./images/${type}s`); + + const image = files[Math.floor(Math.random() * files.length)]; + return res.status(200).json({ + "url": getBaseURL(req) + "/images/" + type + "s/" + image + }); +}); + +export default router; \ No newline at end of file diff --git a/src/api/v1/status.ts b/src/api/v1/status.ts deleted file mode 100644 index 4ab6a45..0000000 --- a/src/api/v1/status.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { Router } from 'express'; -const router = Router(); - -router.get('/', (req, res) => { - res.status(200).json({ - status: 200, - message: 'OK' - }); -}); - -export default router; \ No newline at end of file diff --git a/src/api/v1/token.ts b/src/api/v1/token.ts deleted file mode 100644 index ea98879..0000000 --- a/src/api/v1/token.ts +++ /dev/null @@ -1,35 +0,0 @@ -import { Router } from 'express'; -const router = Router(); -import * as jose from 'jose'; -import * as config from '../../config'; - -router.post('/', async (req, res) => { - const body = req.body; - if(!body.username || !body.password) return res.status(400).json({ - status: 400, - error: 'Bad Request', - message: 'No username or password provided' - }); - - if(body.username === config.username && body.password === config.secretPass) { - const secret = new TextEncoder().encode(config.jwtSecret); - const token = await new jose.SignJWT({ - "secretPass": config.secretPass, - }).setProtectedHeader({ - alg: 'HS256', - typ: 'JWT' - }).sign(secret); - return res.status(200).json({ - status: '200', - token: token - }); - } - - return res.status(401).json({ - status: 401, - error: 'Unauthorized', - message: 'Invalid username or password' - }); -}); - -export default router; \ No newline at end of file diff --git a/src/config.example.ts b/src/config.example.ts index bbbf793..2656157 100644 --- a/src/config.example.ts +++ b/src/config.example.ts @@ -1,7 +1,3 @@ export const name = ''; // name of the app export const host = 'localhost'; // host of the app -export const secretPass = ''; // secret for the api account (used for the token) -export const jwtSecret = ''; // secret for the jwt token -export const username = 'admin'; // username of the api account (used for the token) -export const port = 3000; // port of the app -export const secure = false; // true if you want to use https \ No newline at end of file +export const port = 3000; // port of the app \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 3d4c769..6c17ebe 100644 --- a/src/index.ts +++ b/src/index.ts @@ -11,4 +11,6 @@ if(!fs.existsSync('./logs')) { } const app = new App(config.port); + +app.logger.info(`App starting in ${process.env.NODE_ENV} mode`, "App"); app.listen(); \ No newline at end of file diff --git a/src/routes/index.ts b/src/routes/index.ts deleted file mode 100644 index 68ab6e2..0000000 --- a/src/routes/index.ts +++ /dev/null @@ -1,17 +0,0 @@ -import Route from '../structures/route'; -import {Logger} from "@classycrafter/super-logger"; - -export default class IndexRoute extends Route { - - constructor(logger: Logger) { - super(logger, { - path: '/' - }); - }; - - public initializeRoutes() { - this.router.get('/', (req, res) => { - res.render('index', { title: 'Home' }); - }); - }; -} \ No newline at end of file diff --git a/src/structures/app.ts b/src/structures/app.ts index 0ccba6b..fa1d069 100644 --- a/src/structures/app.ts +++ b/src/structures/app.ts @@ -1,10 +1,7 @@ -import express, {NextFunction, Response, Request} from 'express'; +import express, {NextFunction} from 'express'; import * as sl from '@classycrafter/super-logger'; import * as config from '../config'; -import fs from 'fs'; -import * as utils from './functions'; -import Route from './route'; -import path from 'path'; +import * as utils from '../utils'; import Api from '../api/index'; import cors from 'cors'; @@ -28,7 +25,6 @@ export default class App { }); this.initializeMiddlewares(); - this.initializeRoutes(this.loadRoutes()); this.initializeErrorHandling(); }; @@ -36,24 +32,17 @@ export default class App { this.app.use(cors()); this.app.use(express.json()); this.app.use(express.urlencoded({ extended: true })); - this.app.set('view engine', 'ejs'); - this.app.use('/static', express.static('static')); + this.app.use(express.static('static')); this.app.use('/images', express.static('images')); this.app.set('host', config.host); this.app.use((req, res, next) => { next(); const ms = utils.getMs(process.hrtime()); - if(!utils.isGoodStatus(res.statusCode)) return this.logger.warn(`${req.method} @${req.url} - ${res.statusCode} (${utils.timingColor(ms)})`, "App"); - this.logger.info(`${req.method} @${req.url} - ${res.statusCode} (${utils.timingColor(ms)})`, "App"); + if(!utils.isGoodStatus(res.statusCode)) return this.logger.warn(`${req.method} @${req.originalUrl} - ${res.statusCode} (${utils.timingColor(ms)})`, "App"); + this.logger.info(`${req.method} @${req.originalUrl} - ${res.statusCode} (${utils.timingColor(ms)})`, "App"); }); const api = Api(this.logger); - this.app.use('/api', api); - }; - - private initializeRoutes(routes: Route[]) { - routes.forEach((route) => { - this.app.use(route.path, route.router); - }); + this.app.use(api); }; public listen() { @@ -62,23 +51,6 @@ export default class App { }); }; - private loadRoutes(): Route[] { - const routes: Route[] = []; - const routeFiles = fs.readdirSync(path.join(__dirname, '..', 'routes')).filter(file => file.endsWith('.ts') || file.endsWith('.js')); - for (const file of routeFiles) { - const { default: route } = require(`../routes/${file}`); - if(!utils.isConstructor(route, Route)) { - this.logger.error(`Controller ${file} is not a valid controller!`, "App"); - continue; - } - const cRoute = new route(this.logger); - routes.push(cRoute); - this.logger.info(`Loaded route ${cRoute.path}`, "App"); - } - - return routes; - }; - private initializeErrorHandling() { this.app.use((req, res, next) => { const error = new Error('Not found'); @@ -86,15 +58,18 @@ export default class App { next(error); }); - this.app.get('*', (req, res) => { - res.status(404).render('404', { title: 'Not Found', err: new Error('Not Found'), status: 404 }); - }); - this.app.use((error: any, req: express.Request, res: express.Response, next: NextFunction) => { + if (res.headersSent) { + return next(error); + } + if (res.statusCode === 200) res.status(500); if (res.statusCode !== 404) this.logger.error(error.stack, "App"); - res.status(res.statusCode || 500); - if(!error.message) error.message = "Internal Server Error"; - res.render('error', { title: 'Oops! Error!', err: error, status: res.statusCode }); + res.json({ + error: { + message: error.message, + status: res.statusCode + } + }); }); } } \ No newline at end of file diff --git a/src/structures/functions.ts b/src/structures/functions.ts deleted file mode 100644 index 85ca527..0000000 --- a/src/structures/functions.ts +++ /dev/null @@ -1,81 +0,0 @@ -import chalk from 'chalk'; -import fetch from 'node-fetch'; -import * as config from '../config'; -import { Request } from 'express'; -import * as jose from "jose"; -import { IsValidTokenRes } from '../utils/types'; - -export const isGoodStatus = (code: number): boolean => { - return code >= 200 && code < 400; -} - -export const getMs = (start: [number, number]): string => { - const NS_PER_SEC = 1e9; // convert to nanoseconds - const NS_TO_MS = 1e6; // convert to milliseconds - const diff = process.hrtime(start); - return ((diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS).toLocaleString(); -}; - -export const timingColor = (ms: number | string): string => { - let msnum: number; - if(typeof ms === "string") msnum = parseInt(ms); - else msnum = ms; - - if(msnum < 100) return chalk.green(ms + "ms"); - else if(msnum < 500) return chalk.yellow(ms + "ms"); - else return chalk.red(ms + "ms"); -}; - -const isConstructorProxyHandler = { - construct() { - return Object.prototype; - } -}; - -export function isConstructor(func: any, _class: any): boolean { - try { - new new Proxy(func, isConstructorProxyHandler)(); - if (!_class) return true; - return func.prototype instanceof _class; - } catch (err) { - return false; - } -} - -export async function isValidToken(req: Request): Promise { - if (Object.keys(req.body).length > 0) return { - status: 400, - error: 'Bad Request', - message: 'Too many arguments' - }; - - const token = req.headers.authorization?.replace('Bearer ', ''); - if (!token || typeof token !== "string") return { - status: 400, - error: 'Bad Request', - message: 'No token provided' - }; - const secret = new TextEncoder().encode(config.jwtSecret); - const payload = jose.decodeJwt(token); - if (!payload || !payload["secretPass"]) return { - status: 400, - error: 'Bad Request', - message: 'Token is invalid' - }; - const condition1 = !((await jose.jwtVerify(token, secret).catch((err: Error) => { - return err; - })) instanceof Error); - const condition2 = !payload["secretPass"] || payload["secretPass"] === config.secretPass; - const verified = condition1 && condition2; - if (!verified) return { - status: 401, - error: 'Unauthorized', - message: 'Token is invalid or has expired' - }; - - return { - status: 200, - message: 'Token is valid' - }; -} - diff --git a/src/structures/route.ts b/src/structures/route.ts deleted file mode 100644 index af3b7da..0000000 --- a/src/structures/route.ts +++ /dev/null @@ -1,22 +0,0 @@ -import express from 'express'; -import {Logger} from "@classycrafter/super-logger"; -import {IInfos} from "../utils/types"; - -export default abstract class Route { - - public router: express.Router; - public path: string; - - protected constructor(logger: Logger, infos: IInfos) { - this.router = express.Router(); - this.path = infos.path; - - this.loadRoutes(); - }; - - abstract initializeRoutes(): void; - - public loadRoutes() { - this.initializeRoutes(); - } -} \ No newline at end of file diff --git a/src/utils/index.ts b/src/utils/index.ts new file mode 100644 index 0000000..dab8dbc --- /dev/null +++ b/src/utils/index.ts @@ -0,0 +1,30 @@ +import chalk from 'chalk'; +import { Request } from 'express'; +import * as config from '../config'; + +export const isGoodStatus = (code: number): boolean => { + return code >= 200 && code < 400; +} + +export const getMs = (start: [number, number]): string => { + const NS_PER_SEC = 1e9; // convert to nanoseconds + const NS_TO_MS = 1e6; // convert to milliseconds + const diff = process.hrtime(start); + return ((diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS).toLocaleString(); +}; + +export const timingColor = (ms: number | string): string => { + let msnum: number; + if(typeof ms === "string") msnum = parseInt(ms); + else msnum = ms; + + if(msnum < 100) return chalk.green(ms + "ms"); + else if(msnum < 500) return chalk.yellow(ms + "ms"); + else return chalk.red(ms + "ms"); +}; + +export const getBaseURL = (req: Request): string => { + return req.protocol + '://' + req.hostname + (process.env.NODE_ENV === 'production' ? '' : (':' + config.port)); +}; + +export * from "./validators"; \ No newline at end of file diff --git a/src/utils/interfaces.ts b/src/utils/interfaces.ts deleted file mode 100644 index dec979c..0000000 --- a/src/utils/interfaces.ts +++ /dev/null @@ -1,9 +0,0 @@ -export interface Payload { - secretPass: string; -} - -export interface ImageInfo { - type: string; - count: number; - files: string[]; -} \ No newline at end of file diff --git a/src/utils/types.ts b/src/utils/types.ts deleted file mode 100644 index 1dc3241..0000000 --- a/src/utils/types.ts +++ /dev/null @@ -1,9 +0,0 @@ -export type IInfos = { - path: string; -} - -export type IsValidTokenRes = { - status: number; - error?: string; - message: string; -} \ No newline at end of file diff --git a/src/utils/validators.ts b/src/utils/validators.ts new file mode 100644 index 0000000..907f8d5 --- /dev/null +++ b/src/utils/validators.ts @@ -0,0 +1,9 @@ +import * as validator from "express-validator"; + +export const owoifyGetValidator = [ + validator.query('text', "text query is required").isString().withMessage('text query must be a string').trim().isLength({ min: 1, max: 2000 }).withMessage("text query must be between 1 and 2000 chars").escape() +]; + +export const owoifyPostValidator = [ + validator.body('text', "text body is required").isString().withMessage('text body must be a string').trim().isLength({ min: 1, max: 2000 }).withMessage("text body must be between 1 and 2000 chars").escape() +]; \ No newline at end of file diff --git a/static/favicon.ico b/static/favicon.ico new file mode 100644 index 0000000..66772fa Binary files /dev/null and b/static/favicon.ico differ diff --git a/static/index.html b/static/index.html new file mode 100644 index 0000000..858e6e0 --- /dev/null +++ b/static/index.html @@ -0,0 +1,26 @@ + + + + + + + + NekoNya-Storage + + + + + +
+

NekoNya-Storage: NekoNya's Storage and API webserver.

+
+ NekoNya! + GitHub +
+
+
+

v2.0.5

+
+ + \ No newline at end of file diff --git a/static/main.css b/static/main.css index c2a244e..67fd6e1 100644 --- a/static/main.css +++ b/static/main.css @@ -1,15 +1,57 @@ +:root { + --primary: #eb7763; + --primary-dark: #e8553c; + --secondary: #7ed957; + --secondary-dark: #57b43a; + --tertiary: #adadad; + --tertiary-dark: #8c8c8c; + --success: #7ed957; + --success-dark: #57b43a; + --danger: #f65246; + --danger-dark: #d32f2f; + --warning: #ff9800; + --warning-dark: #f57c00; + --info: #2196f3; + --info-dark: #1a74cc; + --dark: #212121; + --dark-light: #333; + --light: #fafafa; + --gray: #adadad; +} + * { box-sizing: border-box; } +h1 { + transition: all 0.3s ease; + cursor: default; +} + +h1 * { + transition: all 0.3s ease; +} + +h1:hover .neko { + color: var(--primary-dark); +} + +h1:hover .nya { + color: var(--secondary-dark); +} + body { font-family: 'Open Sans', sans-serif; font-size: 16px; line-height: 1.5; - color: #333; - background-color: #d2d2d2; + color: var(--dark); + background-color: var(--gray); margin: 0; padding: 0; + height: 100vh; + display: flex; + flex-direction: column; + gap: 0; } .container { @@ -19,15 +61,15 @@ body { justify-content: center; align-items: center; width: 100%; - height: 100vh; - background-color: #969696; + text-align: center; + height: 100%; } .btn { - --btn-color: #333; - --btn-bg-color: #fff; - --btn-hover-color: #fff; - --btn-hover-bg-color: #333; + --btn-color: var(--dark); + --btn-bg-color: var(--light); + --btn-hover-color: var(--light); + --btn-hover-bg-color: var(--dark)3; display: inline-block; padding: 10px 20px; @@ -53,9 +95,90 @@ body { transform: scale(0.95); } +.btn-primary { + --btn-color: var(--dark); + --btn-bg-color: var(--primary); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--primary-dark); +} + +.btn-secondary { + --btn-color: var(--dark); + --btn-bg-color: var(--secondary); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--secondary-dark); +} + +.btn-tertiary { + --btn-color: var(--dark); + --btn-bg-color: var(--tertiary); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--tertiary-dark); +} + +.btn-success { + --btn-color: var(--dark); + --btn-bg-color: var(--success); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--success-dark); +} + +.btn-danger { + --btn-color: var(--dark); + --btn-bg-color: var(--danger); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--danger-dark); +} + +.btn-warning { + --btn-color: var(--dark); + --btn-bg-color: var(--warning); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--warning-dark); +} + +.btn-info { + --btn-color: var(--dark); + --btn-bg-color: var(--info); + --btn-hover-color: var(--dark); + --btn-hover-bg-color: var(--info-dark); +} + .nekonya-btn { --btn-color: #7ed957; --btn-bg-color: #eb7763; --btn-hover-color: #7ed957; --btn-hover-bg-color: #e8553c; +} + +.btn-group { + display: flex; + justify-content: center; + align-items: center; + gap: 10px; +} + +.neko { + color: var(--primary); +} + +.nya { + color: var(--secondary); +} + +.storage { + color: var(--dark-light); +} + +footer { + margin-top: auto; + padding: 15px; + color: var(--dark-light); + text-align: left; + width: 100%; + font-family: "Source Code Pro", monospace; +} + +footer p { + margin: 0; } \ No newline at end of file diff --git a/static/manifest.webmanifest b/static/manifest.webmanifest new file mode 100644 index 0000000..427903b --- /dev/null +++ b/static/manifest.webmanifest @@ -0,0 +1,18 @@ +{ + "name": "NekoNya-Storage", + "short_name": "nekonya-storage", + "start_url": "/", + "display": "browser", + "background_color": "#bbbbbb", + "theme_color": "#9bdbff", + "description": "API and static file server for NekoNya.", + "lang": "en", + "orientation": "portrait", + "icons": [ + { + "src": "/static/assets/favicon.png", + "sizes": "512x512 192x192 64x64 32x32 24x24 16x16", + "type": "image/png" + } + ] +} \ No newline at end of file diff --git a/static/robots.txt b/static/robots.txt new file mode 100644 index 0000000..51a17f0 --- /dev/null +++ b/static/robots.txt @@ -0,0 +1,4 @@ +User-agent: * +Allow: / +Disallow: /api/* +Disallow: /api/ \ No newline at end of file diff --git a/views/404.ejs b/views/404.ejs deleted file mode 100644 index 5b4aa89..0000000 --- a/views/404.ejs +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - <%= status %> - <%= title %> - - -
-

Oops! An error occurred!

-

The requested content or resource could not be found. (<%= status %>)

- Return home -
- - \ No newline at end of file diff --git a/views/error.ejs b/views/error.ejs deleted file mode 100644 index 39a7d81..0000000 --- a/views/error.ejs +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - <%= status %> - <%= title %> - - -
-

Oops! An error occurred!

-

<%= err.message %> (<%= status %>)

- Return home -
- - \ No newline at end of file diff --git a/views/index.ejs b/views/index.ejs deleted file mode 100644 index 3d45e1e..0000000 --- a/views/index.ejs +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - <%= title %> - - -
-

Private NekoNya Storage Server.

- NekoNya! -
- - \ No newline at end of file