diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..82e1987 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,22 @@ +name: Build and Deploy +on: [push] + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout 🛎️ + uses: actions/checkout@v2.3.1 + with: + fetch-depth: 0 + + - name: Install and Build 🔧 + run: | + npm install + npm run docs:build + + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@4.1.3 + with: + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index b730740..a45fefb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ canhazdata certs node_modules +coverage +lib +docs diff --git a/LICENSE b/LICENSE index 29ebfa5..9db9634 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,20 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 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 Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are 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. - - 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. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - 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 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 work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - 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 AGPL, see -. \ No newline at end of file +Copyright (c) 2012-2021 Mark Wylde + +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. diff --git a/README.md b/README.md index 8f47532..fe3d35a 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,15 @@ const changedDocument = await client.getOne('tests', { query: { id: document.id // client.on('DELETE:/tests/.*', ...) // client.on('(PUT|PATCH):/tests/uuid-uuid-uuid-uuid', ...) -client.on('POST:/tests/.*', (path, collectionId, resourceId, pattern) => { +client.on('POST:/tests/.*', (path, method, collectionId, resourceId, pattern) => { console.log(path) // === 'POST:/tests/uuid-uuid-uuid-uuid' + console.log(method) // === 'POST' console.log(collectionId) // === 'tests' console.log(resourceId) // === 'uuid-uuid-uuid-uuid' console.log(pattern) // === 'POST:/tests/.*' }) -console.log( { +console.log({ document, /* { a: 1 } */ changed, /* { changes: 1 } */ changedDocument, /* { b: 2 } */ @@ -207,4 +208,4 @@ await client.unlock(lockId); ## License -This project is licensed under the terms of the AGPL-3.0 license. +This project is licensed under the terms of the MIT license. diff --git a/constants.js b/constants.js deleted file mode 100644 index 8a11c99..0000000 --- a/constants.js +++ /dev/null @@ -1,38 +0,0 @@ -let commandIndex = 0; - -const constants = { - COMMAND: commandIndex++, - STATUS: commandIndex++, - DOCUMENT: commandIndex++, - DOCUMENTS: commandIndex++, - DATA: commandIndex++, - INFO: commandIndex++, - NOTIFY_ON: commandIndex++, - NOTIFY_OFF: commandIndex++, - LOCK: commandIndex++, - UNLOCK: commandIndex++, - COUNT: commandIndex++, - GET: commandIndex++, - POST: commandIndex++, - PUT: commandIndex++, - PATCH: commandIndex++, - DELETE: commandIndex++, - LOCK_ID: commandIndex++, - LOCK_STRATEGY: commandIndex++, - LOCK_STRATEGY_FAIL: commandIndex++, - LOCK_STRATEGY_WAIT: commandIndex++, - COLLECTION_ID: commandIndex++, - RESOURCE_ID: commandIndex++, - QUERY: commandIndex++, - FIELDS: commandIndex++, - LIMIT: commandIndex++, - ORDER: commandIndex++ -}; - -if (process.env.NODE_ENV === 'development') { - Object.keys(constants).forEach(key => { - constants[key] = key; - }); -} - -module.exports = constants; diff --git a/index.js b/index.js deleted file mode 100644 index 982912d..0000000 --- a/index.js +++ /dev/null @@ -1,487 +0,0 @@ -const { promisify } = require('util'); - -const https = require('https'); -const querystring = require('querystring'); -const finalStream = require('final-stream'); -const WebSocket = require('ws'); -const ReconnectingWebSocket = require('reconnecting-websocket'); - -const validateQueryOptions = require('./utils/validateQueryOptions'); - -const { - COLLECTION_ID, - DOCUMENT, - DOCUMENTS, - STATUS, - QUERY, - LIMIT, - DATA, - FIELDS, - ORDER -} = require('./constants'); - -function createWebSocketClass (options) { - return class extends WebSocket { - constructor (url, protocols) { - super(url, protocols, options); - } - }; -} - -function checkKeys (allowedKeys, object) { - return Object - .keys(object) - .filter(key => !allowedKeys.includes(key)); -} - -function client (rootUrl, clientOptions) { - let lastAcceptId = 0; - - const httpsAgent = clientOptions && clientOptions.tls && new https.Agent(clientOptions.tls); - - function count (collectionId, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['query'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (options.query) { - validateQueryOptions(options.query); - } - - const query = querystring.encode({ - ...options, - count: true, - query: options.query && JSON.stringify(options.query) - }); - - const url = `${rootUrl}/${collectionId}?${query}`; - https.request(url, { agent: httpsAgent }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data); - }).end(); - } - - function getAll (collectionId, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['query', 'fields', 'order', 'limit'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (!rws) { - if (options.query) { - validateQueryOptions(options.query); - } - - const query = querystring.encode({ - ...options, - query: options.query && JSON.stringify(options.query), - fields: options.fields && JSON.stringify(options.fields), - order: options.order && JSON.stringify(options.order) - }); - - const url = `${rootUrl}/${collectionId}?${query}`; - https.request(url, { agent: httpsAgent }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data); - }).end(); - } - - lastAcceptId = lastAcceptId + 1; - onOffAccepts.push([lastAcceptId, (error, result) => { - if (result[STATUS] !== 200) { - const error = Object.assign(new Error('canhazdb error'), { - data: result[DATA] - }); - callback(error); - return - } - callback(null, result[DOCUMENTS]); - }]); - rws.send(JSON.stringify([lastAcceptId, 'GET', { - [COLLECTION_ID]: collectionId, - [QUERY]: options.query, - [LIMIT]: options.limit, - [FIELDS]: options.fields, - [ORDER]: options.order - }])); - } - - function getOne (collectionId, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['query', 'fields', 'order'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (!rws) { - options.limit = 1; - - if (options.query) { - validateQueryOptions(options.query); - } - - const query = querystring.encode({ - ...options, - query: options.query && JSON.stringify(options.query), - fields: options.fields && JSON.stringify(options.fields), - order: options.order && JSON.stringify(options.order) - }); - - const url = `${rootUrl}/${collectionId}?${query}`; - https.request(url, { agent: httpsAgent }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data[0]); - }).end(); - } - - lastAcceptId = lastAcceptId + 1; - onOffAccepts.push([lastAcceptId, (error, result) => { - if (result[STATUS] !== 200) { - const error = Object.assign(new Error('canhazdb error'), { - data: result[DATA] - }); - callback(error); - return - } - callback(null, result[DOCUMENTS][0]); - }]); - rws.send(JSON.stringify([lastAcceptId, 'GET', { - [COLLECTION_ID]: collectionId, - [QUERY]: options.query, - [LIMIT]: 1, - [FIELDS]: options.fields, - [ORDER]: options.order - }])); - } - - function post (collectionId, document, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['lockId', 'lockStrategy'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (!rws) { - const url = `${rootUrl}/${collectionId}`; - https.request(url, { - agent: httpsAgent, - method: 'POST' - }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data); - }).end(JSON.stringify(document)); - - return; - } - - lastAcceptId = lastAcceptId + 1; - onOffAccepts.push([lastAcceptId, (error, result) => { - callback(error, result[DOCUMENT]); - }]); - rws.send(JSON.stringify([lastAcceptId, 'POST', { - [COLLECTION_ID]: collectionId, - [DOCUMENT]: document - }])); - } - - function put (collectionId, newDocument, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['query', 'lockId', 'lockStrategy'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (options.query) { - validateQueryOptions(options.query); - } - - const query = querystring.encode({ - ...options, - query: options.query && JSON.stringify(options.query) - }); - - const url = `${rootUrl}/${collectionId}?${query}`; - - https.request(url, { - agent: httpsAgent, - method: 'PUT' - }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data); - }).end(JSON.stringify(newDocument)); - } - - function patch (collectionId, newDocument, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['query', 'lockId', 'lockStrategy'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (options.query) { - validateQueryOptions(options.query); - } - - const query = querystring.encode({ - ...options, - query: options.query && JSON.stringify(options.query) - }); - - const url = `${rootUrl}/${collectionId}?${query}`; - - https.request(url, { - agent: httpsAgent, - method: 'PATCH' - }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data); - }).end(JSON.stringify(newDocument)); - } - - function del (collectionId, options, callback) { - if (!callback) { - callback = options; - options = {}; - } - - const unknownKeys = checkKeys(['query', 'lockId', 'lockStrategy'], options); - if (unknownKeys.length > 0) { - callback(Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(',')))); - return; - } - - if (options.query) { - validateQueryOptions(options.query); - } - - const query = querystring.encode({ - ...options, - query: options.query && JSON.stringify(options.query) - }); - - const url = `${rootUrl}/${collectionId}?${query}`; - https.request(url, { - agent: httpsAgent, - method: 'DELETE' - }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data); - }).end(); - } - - function lock (keys, callback) { - if (!Array.isArray(keys)) { - callback(Object.assign(new Error('canhazdb error: keys must be array but got ' + keys.toString()))); - return; - } - - const url = `${rootUrl}/_/locks`; - https.request(url, { - agent: httpsAgent, - method: 'POST' - }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, data.id); - }).end(JSON.stringify(keys)); - } - - function unlock (lockId, callback) { - const url = `${rootUrl}/_/locks/${lockId}`; - https.request(url, { - agent: httpsAgent, - method: 'DELETE' - }, async function (response) { - const data = await finalStream(response).then(JSON.parse); - - if (response.statusCode >= 400) { - callback(Object.assign(new Error('canhazdb error'), { data, statusCode: response.statusCode })); - return; - } - - callback(null, true); - }).end(); - } - - const handlers = []; - let wsUrl; - if (rootUrl.startsWith('https://')) { - wsUrl = rootUrl.replace('https://', 'wss://'); - } else { - wsUrl = rootUrl.replace('http://', 'ws://'); - } - - const wsOptions = { - WebSocket: createWebSocketClass({ - ...(clientOptions && clientOptions.tls) - }), - connectionTimeout: 1000, - maxRetries: 10 - }; - - const rws = clientOptions.disableNotify ? null : new ReconnectingWebSocket(wsUrl, [], wsOptions); - const onOffAccepts = []; - - async function on (path, handler) { - if (!rws) { - throw new Error('notify was disable for this client instance'); - } - - lastAcceptId = lastAcceptId + 1; - - const existingHandler = handlers.find(item => item[0] === path); - handlers.push([path, handler]); - - if (!existingHandler) { - const promise = new Promise(resolve => { - onOffAccepts.push([lastAcceptId, resolve]); - }); - rws.send(JSON.stringify([lastAcceptId, 'NOTIFY', path])); - return promise; - } - - return true; - } - - function off (path, handler) { - if (!rws) { - throw new Error('notify was disable for this client instance'); - } - - lastAcceptId = lastAcceptId + 1; - const promise = new Promise(resolve => { - onOffAccepts.push([lastAcceptId, resolve]); - }); - - rws.send(JSON.stringify([lastAcceptId, 'UNNOTIFY', path])); - const index = handlers.findIndex(item => item[0] === path && item[1] === handler); - - if (index === -1) { - return; - } - handlers.splice(index, 1); - - return promise; - } - - rws && rws.addEventListener('message', (event) => { - const rawData = JSON.parse(event.data); - const [type, data] = rawData; - if (type === 'A') { - const accepterIndex = onOffAccepts.findIndex(item => item[0] === data); - if (accepterIndex === -1) { - return - } - const accepter = onOffAccepts[accepterIndex]; - accepter && accepter[1] && accepter[1](null, rawData[2]); - onOffAccepts.splice(accepterIndex, 1); - return; - } - handlers.forEach(item => { - if (item[0] === data[3]) { - item[1](...data); - } - }); - }); - - function close () { - rws && rws.close(); - } - - return { - count: promisify(count), - getAll: promisify(getAll), - getOne: promisify(getOne), - put: promisify(put), - patch: promisify(patch), - post: promisify(post), - delete: promisify(del), - lock: promisify(lock), - unlock: promisify(unlock), - - on, - off, - - close - }; -} - -module.exports = client; diff --git a/package.json b/package.json index ff97858..551ee8a 100644 --- a/package.json +++ b/package.json @@ -2,32 +2,40 @@ "name": "canhazdb-client", "version": "1.1.3", "description": "Talk to a restful api using database like functions.", - "main": "index.js", + "main": "lib/index.js", + "type": "module", "directories": { "lib": "lib" }, "scripts": { - "test": "./makeCerts.sh && node test" + "prepare": "tsc", + "docs:build": "typedoc src", + "test": "./makeCerts.sh && c8 node test" }, "repository": { "type": "git", "url": "git+https://github.com/canhazdb/client.git" }, "keywords": [], - "author": "", - "license": "AGPL-3.0", + "author": { + "name": "Mark Wylde", + "email": "me@markwylde.com", + "url": "https://github.com/markwylde" + }, + "license": "MIT", "bugs": { "url": "https://github.com/canhazdb/client/issues" }, "homepage": "https://github.com/canhazdb/client#readme", "devDependencies": { - "basictap": "^1.1.13", - "canhazdb-driver-ejdb": "^1.1.3", - "canhazdb-server": "^7.0.2" + "@types/util.promisify": "^1.0.4", + "basictap": "^2.2.2", + "c8": "^7.9.0", + "typedoc": "^0.22.5", + "typescript": "^4.4.3" }, "dependencies": { - "final-stream": "^2.0.3", - "reconnecting-websocket": "^4.4.0", - "ws": "^7.4.6" + "mql-to-jql": "^1.4.0", + "tcpocket": "^7.5.2" } } diff --git a/src/constants.ts b/src/constants.ts new file mode 100644 index 0000000..6d8cafa --- /dev/null +++ b/src/constants.ts @@ -0,0 +1,58 @@ +export enum CommandCodes { + INTERNAL = 2, + SYSTEM = 3, + + COLLECTION_ID = 4, + RESOURCE_ID = 5, + + DATA = 6, + REPLICATED_NODES = 7, + + INFO = 8, + COUNT = 9, + GET = 10, + POST = 11, + PUT = 12, + PATCH = 13, + DELETE = 14, + + QUERY = 20, + FIELDS = 21, + LIMIT = 22, + ORDER = 23, + + NOTIFY = 30, + NOTIFY_ON = 31, + NOTIFY_OFF = 32, + NOTIFY_PATH = 33, + + LOCK = 40, + UNLOCK = 41, + LOCK_ID = 42, + LOCK_STRATEGY = 43, + LOCK_STRATEGY_FAIL = 44, + LOCK_STRATEGY_WAIT = 45, + LOCK_KEYS = 46, + LOCK_ORIGIN = 47, + + COMMAND = 50, + STATUS = 51, + + ERROR = 100, + + STATUS_OK = 120, + STATUS_BAD_REQUEST = 121, + STATUS_NOT_FOUND = 122, + STATUS_CREATED = 123, + STATUS_SERVER_ERROR = 124, + STATUS_SERVER_UNHEALTHY = 125, + STATUS_SERVER_CLOSED = 126, + STATUS_LOCKED = 127, + + CONFLICT_GET = 150, + CONFLICT_RAISE = 151, + CONFLICT_RESOLVE = 152, + CONFLICT_CLEANUP = 153, + + READY = 160 +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..aef8345 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,468 @@ +import tcpocket from 'tcpocket'; + +import validateQueryOptions from './utils/validateQueryOptions.js'; + +import { CommandCodes as c } from './constants.js'; + +import waitUntil from './utils/waitUntil.js'; + +function checkKeys (allowedKeys, object) { + return Object + .keys(object) + .filter(key => !allowedKeys.includes(key)); +} + +export interface CountOptions { + query?: Object, + limit?: Number, + order?: String +} +export function count (connection) { + return async (collectionId, options: CountOptions = {}) => { + const unknownKeys = checkKeys(['query', 'order', 'limit'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.COUNT, { + [c.COLLECTION_ID]: collectionId, + [c.QUERY]: options.query, + [c.LIMIT]: options.limit, + [c.ORDER]: options.order + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + getResponse: () => response + }); + } + + return response.json()[c.DATA]; + } +} + +export interface GetAllOptions { + query?: Object, + limit?: Number, + order?: String, + fields?: Array, +} +export function getAll (connection) { + return async (collectionId, options: GetAllOptions = {}) => { + const unknownKeys = checkKeys(['query', 'fields', 'order', 'limit'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.GET, { + [c.COLLECTION_ID]: collectionId, + [c.QUERY]: options.query, + [c.LIMIT]: options.limit, + [c.FIELDS]: options.fields, + [c.ORDER]: options.order + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: options, + getResponse: () => response + }); + } + + return response.json()[c.DATA]; + } +} + +export interface GetOneOptions { + query?: Object, + order?: String, + fields?: Array, +} +export function getOne (connection) { + return async (collectionId, options: GetOneOptions = {}) => { + const unknownKeys = checkKeys(['query', 'fields', 'order'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.GET, { + [c.COLLECTION_ID]: collectionId, + [c.QUERY]: options.query, + [c.LIMIT]: 1, + [c.FIELDS]: options.fields, + [c.ORDER]: options.order + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: options, + getResponse: () => response + }); + } + + return response.json()[c.DATA][0]; + } +} + +export interface PostOptions { + query?: Object, + limit?: Number, + order?: String, + lockId?: String, + lockStrategy?: String, + fields?: Array, +} +export function post (connection) { + return async (collectionId, document, options: PostOptions = {}) => { + const unknownKeys = checkKeys(['lockId', 'lockStrategy'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.POST, { + [c.COLLECTION_ID]: collectionId, + [c.DATA]: document, + [c.LOCK_ID]: options.lockId, + [c.LOCK_STRATEGY]: options.lockStrategy + }); + + if (response.command !== c.STATUS_CREATED) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: options, + getResponse: () => response + }); + } + + return response.json()[c.DATA]; + } +} + +export interface PutOptions { + query?: Object, + limit?: Number, + order?: String, + lockId?: String, + lockStrategy?: String +} +export function put (connection) { + return async (collectionId, document, options: PutOptions = {}) => { + const unknownKeys = checkKeys(['query', 'order', 'limit'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.PUT, { + [c.COLLECTION_ID]: collectionId, + [c.QUERY]: options.query, + [c.LIMIT]: options.limit, + [c.ORDER]: options.order, + [c.DATA]: document, + [c.LOCK_ID]: options.lockId, + [c.LOCK_STRATEGY]: options.lockStrategy + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: options, + getResponse: () => response + }); + } + + return { + changes: response.json()[c.DATA] + }; + } +} + +export interface PatchOptions { + query?: Object, + limit?: Number, + order?: String, + lockId?: String, + lockStrategy?: String +} +export function patch (connection) { + return async (collectionId, document, options: PatchOptions = {}) => { + const unknownKeys = checkKeys(['query', 'order', 'limit'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.PATCH, { + [c.COLLECTION_ID]: collectionId, + [c.QUERY]: options.query, + [c.LIMIT]: options.limit, + [c.ORDER]: options.order, + [c.DATA]: document, + [c.LOCK_ID]: options.lockId, + [c.LOCK_STRATEGY]: options.lockStrategy + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: options, + getResponse: () => response + }); + } + + return { + changes: response.json()[c.DATA] + }; + } +} + +export interface DeleteOptions { + query?: Object, + limit?: Number, + order?: String, + lockId?: String, + lockStrategy?: String +} +export function del (connection) { + return async (collectionId, options: DeleteOptions = {}) => { + const unknownKeys = checkKeys(['query', 'order', 'limit'], options); + if (unknownKeys.length > 0) { + throw Object.assign(new Error('canhazdb error: unknown keys ' + unknownKeys.join(','))); + } + + if (options.query) { + validateQueryOptions(options.query); + } + + const response = await connection.send(c.DELETE, { + [c.COLLECTION_ID]: collectionId, + [c.QUERY]: options.query, + [c.LIMIT]: options.limit, + [c.ORDER]: options.order, + [c.LOCK_ID]: options.lockId, + [c.LOCK_STRATEGY]: options.lockStrategy + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: options, + getResponse: () => response + }); + } + + return { + changes: response.json()[c.DATA] + }; + } +} + +export function lock (connection) { + return async (keys) =>{ + if (!Array.isArray(keys)) { + throw Object.assign(new Error('canhazdb error: keys must be array but got ' + keys.toString())); + } + + const response = await connection.send(c.LOCK, { + [c.LOCK_KEYS]: keys + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + getResponse: () => response + }); + } + + return response.json()[c.LOCK_ID]; + } +} + +export function unlock (connection) { + return async (lockId) =>{ + if (!lockId) { + throw Object.assign(new Error('canhazdb error: unlock must be passed the lockId')); + } + + const response = await connection.send(c.UNLOCK, { + [c.LOCK_ID]: lockId + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + getResponse: () => response + }); + } + + return response.json()[c.LOCK_ID]; + } +} + +export function on (connection, notifiers : Object) { + return async (notifyPath : string, handler : Function) => { + if (!notifiers[notifyPath]) { + notifiers[notifyPath] = []; + notifiers[notifyPath].regex = notifiers[notifyPath].regex || new RegExp(notifyPath); + } + + if (notifiers[notifyPath].length === 0) { + const response = await connection.send(c.NOTIFY_ON, { + [c.NOTIFY_PATH]: notifyPath + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: { notifyPath }, + getResponse: () => response + }); + } + } + + notifiers[notifyPath].push(handler); + } +} + +export function off (connection, notifiers : Object) { + return async (notifyPath : string, handler : Function) => { + notifiers[notifyPath] = notifiers[notifyPath] || []; + + notifiers[notifyPath] = notifiers[notifyPath] + .filter(savedHandler => savedHandler !== handler); + + if (notifiers[notifyPath].length === 0) { + const response = await connection.send(c.NOTIFY_OFF, { + [c.NOTIFY_PATH]: notifyPath + }); + + if (response.command !== c.STATUS_OK) { + const data = response.json() + throw Object.assign(new Error('canhazdb client: ' + data[c.ERROR]), { + statusCode: c[response.command], + request: { notifyPath }, + getResponse: () => response + }); + } + } + } +} + +export interface ClientOptions { + host: string, + port: number, + key?: string, + cert?: string, + ca?: string, + + connection?: any +} +/** + * Create a connection to a canhazdb server + * + * @name createClient + */ +export async function createClient (options: ClientOptions) { + const connection = options.connection || tcpocket.createClient(options); + + const notifiers = {}; + + let ready; + let closed = true; + + if (!options.connection) { + await connection.waitUntilConnected(); + } + + function close () { + closed = false; + connection.close(); + } + + connection.on('message', data => { + if (data.command === c.READY) { + ready = true; + closed = false; + return; + } + + if (data.command === c.NOTIFY) { + const notifyPath = data.json()[c.DATA]; + + const filteredNotifiersKeys = Object + .keys(notifiers) + .filter( + notifierKey => notifyPath.match(notifiers[notifierKey].regex) + ); + + filteredNotifiersKeys.forEach(notifierKey => { + notifiers[notifierKey] + .forEach(handler => { + const [method, ...rest] = notifyPath.split(':'); + const [, collectionId, documentId] = rest.join(':').split('/'); + handler(notifyPath, method, collectionId, documentId, notifierKey); + }); + }); + } + }); + + await waitUntil(() => { + return ready || closed + }); + + return { + connection, + + count: count(connection), + getAll: getAll(connection), + getOne: getOne(connection), + post: post(connection), + put: put(connection), + patch: patch(connection), + delete: del(connection), + lock: lock(connection), + unlock: unlock(connection), + on: on(connection, notifiers), + off: off(connection, notifiers), + + close + }; +} + +export default createClient; diff --git a/utils/validateQueryOptions.js b/src/utils/validateQueryOptions.ts similarity index 84% rename from utils/validateQueryOptions.js rename to src/utils/validateQueryOptions.ts index bdaae21..35787b4 100644 --- a/utils/validateQueryOptions.js +++ b/src/utils/validateQueryOptions.ts @@ -6,4 +6,4 @@ function validateQueryOptions (options) { }); } -module.exports = validateQueryOptions; +export default validateQueryOptions; diff --git a/src/utils/waitUntil.js b/src/utils/waitUntil.js new file mode 100644 index 0000000..2929c28 --- /dev/null +++ b/src/utils/waitUntil.js @@ -0,0 +1,28 @@ +function waitUntil (fn) { + let timer; + let storedResolve; + function attempt (resolve) { + const value = fn(); + + if (value) { + resolve(value); + return; + } + + timer = setTimeout(() => attempt(resolve), 1); + } + + const promise = new Promise((resolve, reject) => { + storedResolve = resolve; + attempt(resolve); + }); + + promise.cancel = () => { + storedResolve(); + clearTimeout(timer); + }; + + return promise; +} + +export default waitUntil; diff --git a/test/helpers/httpRequest.js b/test/helpers/httpRequest.js deleted file mode 100644 index e5dd85f..0000000 --- a/test/helpers/httpRequest.js +++ /dev/null @@ -1,11 +0,0 @@ -const fs = require('fs'); -const https = require('https'); - -const httpsAgent = new https.Agent({ - key: fs.readFileSync('./certs/localhost.privkey.pem'), - cert: fs.readFileSync('./certs/localhost.cert.pem'), - ca: [fs.readFileSync('./certs/ca.cert.pem')] -}); - -module.exports = require('axios') - .create({ httpsAgent, validateStatus: () => true }); diff --git a/test/index.js b/test/index.js index 07903c2..cfe632b 100644 --- a/test/index.js +++ b/test/index.js @@ -1,8 +1,8 @@ -const fs = require('fs'); +import fs from 'fs'; +import test from 'basictap'; +import createClient from '../lib/index.js'; -const test = require('basictap'); - -const createClient = require('../'); +import canhazdbServer from 'canhazdb-server'; const tls = { key: fs.readFileSync('./certs/localhost.privkey.pem'), @@ -11,53 +11,58 @@ const tls = { }; async function canhazdb (options) { - await fs.promises.rmdir('./canhazdata', { recursive: true }); - return require('canhazdb-server')(options); + await fs.promises.rm('./canhazdata', { recursive: true }) + .catch(_ => {}); + return canhazdbServer(options); } +const sleep = ms => new Promise(resolve => setTimeout(resolve, ms)); + test('unknown keys', async t => { - t.plan(7); + t.plan(8); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); - client.getOne('tests', { wrongKey: 1 }).catch(error => { + await client.getOne('tests', { wrongKey: 1 }).catch(error => { t.equal(error.message, 'canhazdb error: unknown keys wrongKey'); }); - client.getAll('tests', { wrongKey: 1 }).catch(error => { + await client.getAll('tests', { wrongKey: 1 }).catch(error => { t.equal(error.message, 'canhazdb error: unknown keys wrongKey'); }); - client.post('tests', { a: 1 }, { wrongKey: 1 }).catch(error => { + await client.post('tests', { a: 1 }, { wrongKey: 1 }).catch(error => { t.equal(error.message, 'canhazdb error: unknown keys wrongKey'); }); - client.put('tests', { a: 1 }, { wrongKey: 1 }).catch(error => { + await client.put('tests', { a: 1 }, { wrongKey: 1 }).catch(error => { t.equal(error.message, 'canhazdb error: unknown keys wrongKey'); }); - client.patch('tests', { a: 1 }, { wrongKey: 1 }).catch(error => { + await client.patch('tests', { a: 1 }, { wrongKey: 1 }).catch(error => { t.equal(error.message, 'canhazdb error: unknown keys wrongKey'); }); - client.delete('tests', { wrongKey: 1 }).catch(error => { + await client.delete('tests', { wrongKey: 1 }).catch(error => { t.equal(error.message, 'canhazdb error: unknown keys wrongKey'); }); - client.lock('not array').catch(error => { + await client.lock('not array').catch(error => { t.equal(error.message, 'canhazdb error: keys must be array but got not array'); }); await node.close(); await client.close(); + + t.pass(); }); test('lock and unlock', async t => { t.plan(5); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); const lock1 = client.lock(['tests']).then(async lockId => { t.pass('lock 1 ran'); @@ -87,21 +92,21 @@ test('count', async t => { t.plan(1); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); const result = await client.count('tests'); await node.close(); await client.close(); - t.deepEqual(result, { documentCount: 0 }); + t.deepEqual(result, 0); }); test('get', async t => { t.plan(1); - const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const node = await canhazdb({ host: 'localhost', port: 8060, tls, single: true }); + const client = await createClient(node.clientConfig); const result = await client.getAll('tests'); @@ -114,8 +119,8 @@ test('get', async t => { test('get with limit', async t => { t.plan(1); - const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const node = await canhazdb({ host: 'localhost', port: 8060, tls, single: true }); + const client = await createClient(node.clientConfig); await Promise.all([ await client.post('tests', { a: 1 }), @@ -131,11 +136,46 @@ test('get with limit', async t => { t.deepEqual(result.length, 2); }); +test('getOne', async t => { + t.plan(1); + + const node = await canhazdb({ host: 'localhost', port: 8060, tls, single: true }); + const client = await createClient(node.clientConfig); + + await Promise.all([ + await client.post('tests', { a: 1 }), + await client.post('tests', { a: 2 }), + await client.post('tests', { a: 3 }) + ]); + + const result = await client.getOne('tests'); + + await node.close(); + await client.close(); + + t.deepEqual(result.a, 3); +}); + +test('post and count', async t => { + t.plan(1); + + const node = await canhazdb({ host: 'localhost', tls, single: true }); + const client = await createClient(node.clientConfig); + + await client.post('tests', { a: 1 }); + const result = await client.count('tests'); + + await node.close(); + await client.close(); + + t.deepEqual(result, 1); +}); + test('post and get', async t => { t.plan(1); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); const result = await client.getAll('tests'); @@ -150,7 +190,7 @@ test('post and get specific fields', async t => { t.plan(1); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1, b: 2, c: 3 }); const result = await client.getAll('tests', { fields: ['b'] }); @@ -168,7 +208,7 @@ test('post, put and get', async t => { t.plan(5); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); const document = await client.post('tests', { a: 2 }); @@ -179,7 +219,7 @@ test('post, put and get', async t => { await client.close(); t.deepEqual(document.a, 2); - t.deepEqual(putted.changes, 1); + t.deepEqual(putted.changes.length, 1); t.ok(reget.id); t.ok(reget.b); t.deepEqual(reget.b, 3); @@ -189,7 +229,7 @@ test('post, patch and get', async t => { t.plan(6); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); const document = await client.post('tests', { a: 2 }); @@ -200,7 +240,7 @@ test('post, patch and get', async t => { await client.close(); t.deepEqual(document.a, 2); - t.deepEqual(patched.changes, 1); + t.deepEqual(patched.changes.length, 1); t.ok(reget.id); t.ok(reget.b); t.deepEqual(reget.a, 2); @@ -211,7 +251,7 @@ test('post, delete and get', async t => { t.plan(3); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); const document = await client.post('tests', { a: 1 }); const deletion = await client.delete('tests', { query: { id: document.id } }); @@ -221,14 +261,15 @@ test('post, delete and get', async t => { await client.close(); t.deepEqual(document.a, 1); - t.deepEqual(deletion.changes, 1); + t.deepEqual(deletion.changes.length, 1); t.notOk(reget); }); test('serialise undefined', async t => { - t.plan(5); + t.plan(6); - const client = await createClient('http://example.com', { disableNotify: true }); + const node = await canhazdb({ host: 'localhost', tls, single: true }); + const client = await createClient(node.clientConfig); try { await client.getAll('test', { query: { un: undefined } }); @@ -261,13 +302,16 @@ test('serialise undefined', async t => { } await client.close(); + await node.close(); + + t.pass('sockets closed'); }); test('invalid query - getAll', async t => { - t.plan(2); + t.plan(3); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); @@ -278,24 +322,24 @@ test('invalid query - getAll', async t => { } }); } catch (error) { - t.equal(error.message, 'canhazdb error'); - t.deepEqual(error.data, { - error: error.data.error, - type: 'GET', - collectionId: 'tests', - query: { $nin: ['1'] } + await node.close(); + await client.close(); + + t.equal(error.message, 'canhazdb client: key "$nin" has an invalid value of ["1"]. must be ["$eq","$ne","$gt","$gte","$lt","$lte","$exists","$null","$in","$nin"]'); + t.equal(error.statusCode, 'STATUS_BAD_REQUEST'); + t.deepEqual(error.request, { + query: { + $nin: ['1'] + } }); } - - await node.close(); - await client.close(); }); test('invalid query - getOne', async t => { - t.plan(2); + t.plan(3); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); @@ -306,25 +350,24 @@ test('invalid query - getOne', async t => { } }); } catch (error) { - t.equal(error.message, 'canhazdb error'); - t.deepEqual(error.data, { - error: error.data.error, - type: 'GET', - collectionId: 'tests', - query: { $nin: ['1'] }, - limit: 1 + await node.close(); + await client.close(); + + t.equal(error.message, 'canhazdb client: key "$nin" has an invalid value of ["1"]. must be ["$eq","$ne","$gt","$gte","$lt","$lte","$exists","$null","$in","$nin"]'); + t.equal(error.statusCode, 'STATUS_BAD_REQUEST'); + t.deepEqual(error.request, { + query: { + $nin: ['1'] + } }); } - - await node.close(); - await client.close(); }); test('invalid query - put', async t => { - t.plan(2); + t.plan(3); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); @@ -335,24 +378,24 @@ test('invalid query - put', async t => { } }); } catch (error) { - t.equal(error.message, 'canhazdb error'); - t.deepEqual(error.data, { - error: error.data.error, - type: 'PUT', - collectionId: 'tests', - query: { $nin: ['1'] } + await node.close(); + await client.close(); + + t.equal(error.message, 'canhazdb client: key "$nin" has an invalid value of ["1"]. must be ["$eq","$ne","$gt","$gte","$lt","$lte","$exists","$null","$in","$nin"]'); + t.equal(error.statusCode, 'STATUS_BAD_REQUEST'); + t.deepEqual(error.request, { + query: { + $nin: ['1'] + } }); } - - await node.close(); - await client.close(); }); test('invalid query - patch', async t => { - t.plan(2); + t.plan(3); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); @@ -363,24 +406,24 @@ test('invalid query - patch', async t => { } }); } catch (error) { - t.equal(error.message, 'canhazdb error'); - t.deepEqual(error.data, { - error: error.data.error, - type: 'PATCH', - collectionId: 'tests', - query: { $nin: ['1'] } + await node.close(); + await client.close(); + + t.equal(error.message, 'canhazdb client: key "$nin" has an invalid value of ["1"]. must be ["$eq","$ne","$gt","$gte","$lt","$lte","$exists","$null","$in","$nin"]'); + t.equal(error.statusCode, 'STATUS_BAD_REQUEST'); + t.deepEqual(error.request, { + query: { + $nin: ['1'] + } }); } - - await node.close(); - await client.close(); }); test('invalid query - delete', async t => { - t.plan(2); + t.plan(3); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); await client.post('tests', { a: 1 }); @@ -391,29 +434,29 @@ test('invalid query - delete', async t => { } }); } catch (error) { - t.equal(error.message, 'canhazdb error'); - t.deepEqual(error.data, { - error: error.data.error, - type: 'DELETE', - collectionId: 'tests', - query: { $nin: ['1'] } + await node.close(); + await client.close(); + + t.equal(error.message, 'canhazdb client: key "$nin" has an invalid value of ["1"]. must be ["$eq","$ne","$gt","$gte","$lt","$lte","$exists","$null","$in","$nin"]'); + t.equal(error.statusCode, 'STATUS_BAD_REQUEST'); + t.deepEqual(error.request, { + query: { + $nin: ['1'] + } }); } - - await node.close(); - await client.close(); }); test('post and notify', async t => { - t.plan(5); + t.plan(6); const node = await canhazdb({ host: 'localhost', port: 11505, queryPort: 11506, tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); let alreadyHandled = false; return new Promise((resolve) => { - async function handler (path, collectionId, resourceId, pattern) { + async function handler (path, method, collectionId, resourceId, pattern) { if (alreadyHandled) { t.fail('handler should only be called once'); } @@ -427,6 +470,7 @@ test('post and notify', async t => { }); t.equal(pattern, 'POST:/tests'); + t.equal(method, 'POST'); t.ok(path.startsWith('POST:/tests/'), 'path starts with /tests/'); t.equal(path.length, 48); t.equal(collectionId, 'tests'); @@ -442,14 +486,14 @@ test('post and notify', async t => { }); test('post and notify to multiple', async t => { - t.plan(6); + t.plan(7); const node = await canhazdb({ host: 'localhost', tls, single: true }); - const client = createClient(node.url, { tls }); + const client = await createClient(node.clientConfig); let alreadyHandled = false; - async function handler (path, collectionId, resourceId, pattern) { + async function handler (path, method, collectionId, resourceId, pattern) { if (alreadyHandled) { t.fail('handler should only be called once'); } @@ -461,6 +505,7 @@ test('post and notify to multiple', async t => { }); t.equal(pattern, 'POST:/tests'); + t.equal(method, 'POST'); t.ok(path.startsWith('POST:/tests/'), 'path starts with /tests/'); t.equal(path.length, 48); t.equal(collectionId, 'tests'); @@ -473,8 +518,9 @@ test('post and notify to multiple', async t => { async function gotCalled () { calls = calls + 1; if (calls === 2) { - await node.close(); + await sleep(100); await client.close(); + await node.close(); t.pass('got called twice'); } } diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..cd93bdb --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,26 @@ +{ + "compilerOptions": { + "target": "ES2015", + "module": "ES2020", + "declaration": true, + "strict": false, + "noImplicitAny": false, + "forceConsistentCasingInFileNames": true, + "outDir": "./lib", + "allowJs": true, + "skipLibCheck": true, + "esModuleInterop": true, + "allowSyntheticDefaultImports": true, + "moduleResolution": "node", + "resolveJsonModule": true, + "isolatedModules": true, + "sourceMap": true + }, + "include": [ + "./src" + ], + "typedocOptions": { + "entryPoints": ["src"], + "out": "docs" + } +}