diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f36a7b7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + 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) {{ year }} {{ organization }} + + 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 +. diff --git a/README.md b/README.md index 703b84d..2434085 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -# holoflows-kit-temp +# @holoflows/kit · ![GitHub license](https://img.shields.io/badge/license-AGPL-blue.svg) [![npm version](https://img.shields.io/npm/v/holoflows/kit.svg)](https://www.npmjs.com/package/@holoflows/kit) + +Toolkit for modern web browser extension developing. + +## Documentation + +[English documentation](./doc/en/index.md) + +[简体中文文档](./doc/zh-CN/index.md) + +## License + +@holoflows/kit is published as [AGPL](./LICENSE). diff --git a/doc/en/DOM.md b/doc/en/DOM.md new file mode 100644 index 0000000..730a24e --- /dev/null +++ b/doc/en/DOM.md @@ -0,0 +1,534 @@ +# @holoflows/kit/DOM/ + +Help developer to track changes in the content script + +Looking for [Documentation](#doc)? + +## Example + +
+ Let's look an example. + + +Here we have a train ticket that generated by React. +It will automatically refresh, just like today's PWAs. + +You want to add price in USD after every ticket. + +```typescript +import { LiveSelector, MutationObserverWatcher } from '@holoflows/kit/DOM' + +const price = new LiveSelector() + // Select all .ticket-row + .querySelector('.ticket-row') + // Remove all that doesn't have Euro symbol + .filter(x => x.innerText.match('€')) + // map element to its inner .price + .map(x => x.querySelector('.price')) + +function EuroToUSD(x: number) { + return x * 1.13 +} + +new MutationObserverWatcher(price, document.querySelector('#main')).useNodeForeach(node => { + const addPrice = () => (node.after.innerText = '$' + EuroToUSD(parseInt(node.current.innerText))) + addPrice() + return { + onNodeMutation: addPrice, + } +}) +``` + +Done! Everytime that a new ticket appears, price in US will be added after it. +But wait, it goes to far, I'm confused! + +Okay, that's a just regular usage, shows how @holoflows/kit can help you. + +After you read the intros, and back, you will understand these. + +
+ +## LiveSelector + +
+Everything starts at `LiveSelector`... + + +LiveSelector is a convenient tool, to help you "compute" the same selector at any time. It looks like Array. + + +```ts +const ls = new LiveSelector() +ls.querySelectorAll('a') // Select all `a` +ls.filter(x => x.href.startsWith('https://')) // Remove all link that not starts with https:// +ls.map(x => x.href) // map HTMLAnchorElement[] to string[] + +ls.evaluateOnce() // return all links on the page currently +setTimeout(() => { + ls.evaluateOnce() // yeah it will match all links every time so you always get the latest data! +}) +``` + +About the full documentation, see: [LiveSelector](#doc-LiveSelector)。 + +Then what is `MutationObserverWatcher`?? + +
+ +## Watcher + +
+Watcher can automatically execute `LiveSelector.evaluateOnce()`, then notify you when something has changed. + +In short words, it can watch the change of something. + +There are several kinds of Watcher: + +- MutationObserverWatcher (Using [MutationObserver](https://mdn.io/MutationObserver)) +- IntervalWatcher (Using [setInterval](https://mdn.io/setInterval)) +- EventWatcher (Call it manually) +- ValueRef (Call it manually) + +All Watcher's usage is the same: + +- To let it watch, call `startWatch()` +- To stop it, call `stopWatch()` + +In general, Watchers watch for changes of DOM. If you want to watch anything else, that's okay, Watcher provides some events like `onAdd` `onRemove`, See [Watcher](#doc-watchers)。 + +### `useNodeForeach` + +Here is how we watch dom changing. If you have used React hooks, this is just like React hooks. + +A complete `useNodeForeach` call is like this: + +```ts +.useNodeForeach((node, key, realNode) => { + // Code here, will be called **everytime** when a new element E comes into the list. Here are parameters: + node // A DomProxy (Yeah it's magic!) + node.before // A that always point to the before of E + node.after // A that always point to the after of E + node.current // Magic, it always points to E, even E has changed, it "reference" will be "update" (Not actually, see documentation of DomProxy) + + key // Have you use React, Vue or Angular? When rendering lists, they will ask for you to provide a key to identify what is not changed. + + realNode // Sometimes the magic of node.current will break. Or you really want to access the real dom. Then use it. Notice: it will not update automatically! + + return { + onRemove(old) { + // When E is gone... + // What you need to do? + // Like React.useEffect(() => { return `function here` }) + }, + onNodeMutation() { + // When key is not changed, E is not changed too. + // But here is change in the E + // Like a new element is inserted into node.current + }, + onTargetChanged(oldNode, newNode) { + // If key is not changed, but E is changed. + // Notice: node.current always points to the new node, so you may not need to handle this + }, + } +}) +``` + +> Tips: If you only care about the first element in the `LiveSelector`, here is a shortcut! `Watcher#firstVirtualNode` is a `DomProxy` and it will always points to the first element in the list！ + +[Documentation of Watcher](#doc-watchers) + +
+Tutorial is over. + +# Documentation + +## class LiveSelector + +All methods except `evaluateOnce()` can be chained. + +```ts +const ls = new LiveSelector() +``` + +> Typescript: `LiveSelector` have a generic `` to tell you the current type. + +### `.querySelector(selector)` + +Same as [document.querySelector](https://mdn.io/document.querySelector), add element to the list when evaluating. + +```typescript +ls.querySelector('div#root').querySelector('.nav') +``` + +**Warn: Example above is union of `div#root` and `.nav`, is NOT `div#root .nav`** + +> Typescript: Generic is the same as `document.querySelector` + +> Typescript: For complex CSS selector, you need to specify it manually. Or you will get type `Element`. `.querySelector('div > div')` + +### `.querySelectorAll(selector)` + +Same as [document.querySelectorAll](https://mdn.io/document.querySelectorAll), add elements to the list when evaluating. + +```typescript +ls.querySelectorAll('div').querySelectorAll('h1') +``` + +**Warn: Example above is union of `div` and `h1`, is NOT `div h1`** + +> Typescript: Generic is the same as `document.querySelectorAll` + +> Typescript: For complex CSS selector, you need to specify it manually. Or you will get type `Element`. `.querySelectorAll('div > div')` + +### `.filter(callbackfn)` + +Like [Array#filter](https://mdn.io/Array.filter). Remove items you don't want. + +```ts +ls.filter(x => x.innerText.match('hello')) +``` + +### `.map(callbackfn)` + +Like [Array#map](https://mdn.io/Array.map). Map an item to another. + +```ts +ls.map(x => x.parentElement) +``` + +**Tips: You can map to anything you want!** + +### `.concat(newLS: LiveSelector)` + +Like [Array#concat](https://mdn.io/Array.concat). Concat the result of another `LiveSelector.evaluateOnce()` into the current list. + +```ts +ls.concat(new LiveSelector().querySelector('#root')) +``` + +### `.reverse()` + +Like [Array#reverse](https://mdn.io/Array.reverse). Reverse the list. + +```ts +ls.reverse() +``` + +### `.slice(start?, end?)` + +Like [Array#slice](https://mdn.io/Array.slice). Cut the list. + +```ts +ls.slice(2, 4) +``` + +### `.sort(compareFn)` + +Like [Array#sort](https://mdn.io/Array.sort). Sort the list. + +```ts +ls.sort((a, b) => a.innerText.length - b.innerText.length) +``` + +### `.flat()` + +Like [Array#flat](https://mdn.io/Array.flat). Flatten the list. + +**Notice: Not recursively flating the list** + +```ts +ls.flat() +``` + +### `.nth(n: number)` + +Remove anything except nth element. + +```ts +ls.nth(-1) +``` + +### `.replace(f: (list: T[]) => NextT[])` + +If you think methods above is not enought, you can replace the list directly when evaluating. + +```ts +ls.replace(x => lodash.dropRight(x, 2)) +``` + +### `.evaluateOnce()` + +Evaluate. This should be the last method to be called. + +```ts +ls.evaluateOnce() +``` + +## Watchers + +Every `Watcher` extends from abstract class [Watcher](#abstract-class-Watcher-public)。 + +### abstract class Watcher (public) + +Extends [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) + +#### `constructor (liveSelector)` + +Create a new `Watcher`。 + +- liveSelector: `LiveSelector`, LiveSelector to watch + +> Typescript: Generic `T` equals to generic of the `LiveSelector` passed in. + +#### abstract `.startWatch(?): this` + +Start watching. + +#### abstract `.stopWatch()` + +Stop watching. + +#### `.addListener(event, fn)` + +See [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). +Only these events are available. + +- onChange - When list updated, changed part +- onChangeFull - When list updated, full list +- onRemove - When list updated, removed part +- onAdd - When list updated, added part + +#### `.firstVirtualNode` + +**Notice: T must be sub type of HTMLElement, or it will be type `never`.** + +A [DomProxy](#doc-domproxy), always points to the first result of `LiveSelector`. + +#### `.assignKeys(assigner, comparer?)` + +- assigner: assign a key for each element. Key can be anything. + Defaults to `x => x` + +```ts +assigner: (node: T, index: number, arr: T[]) => Q +// node: node that needs a key +// index: current index +// arr: whole array +``` + +- comparer: If your key can't be compared by `===`, provide a comparer. + Defaults to `(a, b) => a === b` + +```ts +comparer: (a: Q, b: Q) => boolean +// a: returned by assigner +// b: returned by assigner +``` + +#### `.useNodeForEach(fn)` + +**Notice: T must be sub type of HTMLElement, or it will be type `never`.** + +Everytime that a new item is added to the list, it will be called. + +##### fn and it's return value + +```ts +(fn: (node: DomProxy, key: Q, realNode: HTMLElement) => ...) +// node: a DomProxy +// key: returned from assigner +// realNode: real node after DomProxy +``` + +- undefined: nothing will happen +- A function: `(oldNode: T) => void`, when `key` is gone, it will be called +- An object: `{ onRemove?: (old: T) => void; onTargetChanged?: (oldNode: T, newNode: T) => void; onNodeMutation?: (node: T) => void }` +- - `onRemove(oldNode: T) => void`, when key is gone, it will be called +- - `onTargetChanged(oldNode: T, newNode: T) => void`, when `key` is still exist but `realNode` has changed, it will be called. +- - `onNodeMutation: (node: T) => void`, when `key` and `realCurrent` is not changed, but there are some mutations inside the `realCurrent`, it will be called. + +#### `.getVirtualNodeByKey(key)` + +**Notice: T must be sub type of HTMLElement, or it will be type `never`.** + +- key: Q. Find [DomProxy](#doc-domproxy) by `key` + +### MutationObserverWatcher + +#### `constructor (liveSelector, consistentWatchRoot = document.body)` + +Create a new `MutationObserverWatcher`。 + +It will listen on `consistentWatchRoot`. If any changes happened, it will do a check. + +> At most 1 query every requestAnimateFrame. Don't worry + +- liveSelector: `LiveSelector`, LiveSelector to watch +- consistentWatchRoot: `Element | Document`, it should be consistent (if it is deleted, watcher will not work.). Defaults to `document.body`, if you think `MutationObserverWatcher` cause some performance problem, use this. + +#### `startWatch(options?: MutationObserverInit)` + +Start watching. + +- options: `MutationObserverInit`, you can remove some options by yourself. See: [MutationObserver](https://mdn.io/MutationObserver) + +### IntervalWatcher + +Check when time passed. + +#### `.startWatch(interval)` + +Start watching. + +- options: `numebr`, check it at `options`ms + +### EventWatcher + +Check when you want. + +#### `.startWatch()` + +Start watching. + +#### `.eventListener()` + +Event listener. +Usage: + +```ts +ele.addEventListener('click', watcher.eventListener) +``` + +### ValueRef + +ValueRef is not using `LiveSelector`. It listen to `.value =`. e.g.: + +```ts +const ref = new ValueRef(0) +ref.value // 0 +ref.addEventListener('onChangeFull', () => console.log('onChange')) +ref.value = 1 +// Log: onChange +ref.value // 1 +``` + +#### `constructor(value: T)` + +- value: Initial value + +#### `.value` + +Current value. If you assign it, then it will emit event. + +### abstract class Watcher (protected) + +Here are `protected` fields and methods in the `Watcher` class. If you are not extending it, you don't need it. + +#### protected readonly `.nodeWatcher: MutationWatcherHelper` + +Used to invoke `onNodeMutation` + +`MutationWatcherHelper` is an un-exported internal class. Don't use it. + +#### protected `.watching: boolean` + +Is it watching now? + +If false, `.watcherCallback()` will do nothing. + +#### protected `.lastKeyList: unknown[]` + +Key list of last time. + +#### protected `.lastNodeList: T[]` + +Element list of last time. + +#### protected `.lastCallbackMap: Map>` + +All living return functions(like `onRemove` `onNodeMutation`) + +#### protected `.lastVirtualNodesMap: Map` + +All living DomProxy + +#### protected `.findNodeFromListByKey(list: T[], keys: unknown: []): (key: unknown) => T | null` + +A high order function. Find key in the list. + +```ts +.findNodeFromListByKey(this.lastNodeList, this.lastKeyList)(key) +``` + +#### protected `.watcherCallback()` + +Core of watcher. If you want to do a check, call it. + +It does: + +- Call `LiveSelector.evaluateOnce()` +- Call `assignKeys` to get `key`s + +- For deleted nodes, call `onRemove` +- For new nodes, call `useNodeForeachFn()` +- For changed nodes, call `onTargetChanged()` +- Set `lastCallbackMap` `lastVirtualNodesMap` `lastKeyList` `lastNodeList` +- Emit `onChangeFull` `onChange` `onRemove` `onAdd` +- Bind `.firstVirtualNode.realCurrent` to new value. + +#### protected `.mapNodeToKey(node: T, index: number: arr: T[]): unknown` + +map node to key (can be overwrited by `assignKeys`) + +#### protected `.keyComparer(a: unknown, b: unknown): boolean` + +check if `a` and `b` are equal (can be overwrited by `assignKeys`) + +#### protected `.useNodeForeachFn(...): ...` + +See [.useNodeForeach](#doc-watcher-usenodeforeach-fn) + +## DomProxy + +DomProxy provide an interface that be stable even dom is changed. + +Return this object + +### `.before` + +A span element, always at before of [realCurrent](#doc-domproxy-realCurrent) + +### `.current` + +A fake HTML, all operations on it will be forwarded to [realCurrent](#doc-domproxy-realCurrent). After `realCurrent` changes, some of effects will be move to the new target. + +### `.after` + +A span element, alwyas at after of [realCurrent](#doc-domproxy-realCurrent) + +### `.realCurrent` + +The real current. If you change it, [after](#doc-domproxy-after), [current](#doc-domproxy-current), [before](#doc-domproxy-before) will be affected too. + +### `.destroy()` + +Destroy the DomProxy. + +### DOMProxy behavior + +**Notice, only changes happened on current will be forwarded.** + +- forward: forward to the current`realCurrent` +- undo: If `realCurrent` changed, effect will be undoed. +- move: If `realCurrent` changed, effect will be moved. + +| Attributes | forward | undo | move | +| ---------------- | ------- | ---- | ---- | +| style | Yes | No | Yes | +| addEventListener | Yes | Yes | Yes | +| appendChild | Yes | Yes | Yes | +| ...default | Yes | No | No | + +This means, if you change `current.style.opacity`, then change `realCurrent`, new `realCurrent` will set `current.style.opacity` automatically. + +**We will add more behavior later. If you need something, issues or pull requests wellcome!** diff --git a/doc/en/Extension.md b/doc/en/Extension.md new file mode 100644 index 0000000..a0fea96 --- /dev/null +++ b/doc/en/Extension.md @@ -0,0 +1,58 @@ +# @holoflows/kit/Extension/ + +Some tools that useful in extension developing + +# class MessageCenter + +A class that can help you to send messages in different context. + +> Typescript: Messages are typed! + +```ts +interface AllEvents { + event1: { x: number; y: number } +} +const mc = new MessageCenter() +mc.on // Can only listen to keyof AllEvents +mc.send // Can only send event of keyof AllEvents and data need to be type AllEvents[key] +``` + +## `constructor(key?: string)` + +- key?: Whatever, but need to be same in all instances. + +## `.on(event, handler)` + +Listen to event + +## `.on(event, data)` + +Send event + +## `.writeToConsole` + +Log to console when receive/send event + +# AsyncCall + +A simple RPC. [Documentation in the code](../../src/Extension/Async-Call.ts) + +# Contexts + +Identify the current running context + +## type `Contexts` + +- background: background page +- content: content script +- unknown: unknown + +## `GetContext():`Contexts + +Get current context + +## `OnlyRunInContext`(context: Contexts | Contexts[], name: string) + +Check if the current context is the wanted context, if not, throws. + +- `name` is the name while you throw diff --git a/doc/en/index.md b/doc/en/index.md new file mode 100644 index 0000000..a122b95 --- /dev/null +++ b/doc/en/index.md @@ -0,0 +1,26 @@ +# @holoflows/kit + +A toolkit for browser extension developing. + +## Components + +@holoflows/kit 由以下部分组成 + +- [DOM](./DOM.md) - Help developer to track changes in the content script +- [Extension](./Extension.md) - Some tools that useful in extension developing + +## Installation + +Use `yarn` or `npm`. Or use UMD. + +> https://unpkg.com/@holoflows/kit@latest/dist/out.js + +使用模块加载器时，使用 `@holoflows/kit` 导入；使用 umd 时，使用 `window.HoloflowsKit`。 + +### ECMAScript version + +Since this package depends on [Proxy](https://mdn.io/Proxy), it is useless to support ES5. + +`@holoflows/kit` export as umd(/dist/out.js) and ESModule(/es/).UMD compiles to ES6，ESModule compiles to ES2018. + +Full Typescript support. diff --git a/doc/zh-CN/DOM.md b/doc/zh-CN/DOM.md new file mode 100644 index 0000000..a4e8425 --- /dev/null +++ b/doc/zh-CN/DOM.md @@ -0,0 +1,530 @@ +# @holoflows/kit/DOM/ + +提供了一组方便追踪被注入页面中内容变化的工具。 + +只是来查阅文档的？跳过教程，直接跳转到 [文档](#doc) 吧 + +## 例子 + +
+ + 我们先来看一个例子： + + +假设被注入页面是由 React 生成的机票价格页面，它会动态刷新。你想在每张机票的价格后面加上它的美元价格。 + +```typescript +import { LiveSelector, MutationObserverWatcher } from '@holoflows/kit/DOM' + +const price = new LiveSelector() + // 选择所有的 .ticket-row + .querySelector('.ticket-row') + // 排除那些没有欧元符号的行 + .filter(x => x.innerText.match('€')) + // 把每个元素映射成它里面的 .price + .map(x => x.querySelector('.price')) + +function EuroToUSD(x: number) { + return x * 1.13 +} + +new MutationObserverWatcher(price, document.querySelector('#main')).useNodeForeach(node => { + const addPrice = () => (node.after.innerText = '$' + EuroToUSD(parseInt(node.current.innerText))) + addPrice() + return { + onNodeMutation: addPrice, + } +}) +``` + +大功告成，每当有新机票出现，就会自动在后面加上一个美元价格！不过慢点，我还没搞懂！ + +上面是一个常规的用法，展示了 @holoflows/kit 的简洁与强大之处。 + +看完了下面的文档再来回头看看上面这段例子，你就能明白了！ + +
+ +## LiveSelector + +
+一切都要从 LiveSelector 开始…… + + +LiveSelector 是一个方便的工具，可以帮你多次计算同一个 "Selector" 的值，而且它很像数组，可以直接执行一些方便的操作。 + + +```ts +const ls = new LiveSelector() +ls.querySelectorAll('a') // 选择所有的 a +ls.filter(x => x.href.startsWith('https://')) // 去掉所有不以 https:// 开头的链接 +ls.map(x => x.href) // 把 HTMLAnchorElement[] 映射成 string[] + +ls.evaluateOnce() // 返回当前页面上所有的链接列表 +setTimeout(() => { + ls.evaluateOnce() // 可以多次调用！每次都会返回页面上最新的符合 LiveSelector 的结果！ +}) +``` + +关于 LiveSelector 的完整用法，参见 [LiveSelector 的文档](#doc-LiveSelector)。 + +那么 `MutationObserverWatcher` 又是什么？ + +
+ +## Watcher + +
+Watcher 可以根据某些特定的条件自动执行 `LiveSelector` 的 `evaluateOnce()`，然后通过比较两次列表的变化通知你 LiveSelector 发生了哪些更改。 + +简而言之，就是可以监听指定内容的变化。 + +Watcher 有以下几种： + +- MutationObserverWatcher (使用 [MutationObserver](https://mdn.io/MutationObserver)) +- IntervalWatcher (使用 [setInterval](https://mdn.io/setInterval)) +- EventWatcher (手动触发) +- ValueRef (手动触发) + +所有 Watcher 的使用方法都是一样的： + +- 要让 Watcher 开始监听网页变化，你都需要调用 `startWatch()` +- 要停止 Watcher，需要 `stopWatch()` + +一般情况下，Watcher 关注的都是 DOM 的变化，如果你希望关注其他内容的变化，Watcher 提供了 `onAdd` `onRemove` 等的事件，具体请参阅[Watcher 的文档](#doc-watchers)。 + +### `useNodeForeach` + +这是我们来关注 DOM 变化的主要办法。如果你了解 React hooks 的话，这个和那个很像。 + +简单的说，一个完整的 `useNodeForeach` 调用是这样的 + +```ts +.useNodeForeach((node, key, realNode) => { + // 这里的代码会在 **每次** 有一个新的 元素 E 进入列表的时候调用。以下是传入的参数： + node // 是一种叫 DomProxy 的对象 + node.before // 是一个 始终指向 E 的前面 + node.after // 是一个 始终指向 E 的后面 + node.current // 是魔法，它始终指向 E，就算 E 换了，它的引用也会自动"更新"（事实并非如此，请参见 DomProxy 的文档） + + key // 用过 React, Vue 或者 Angular 吗？在渲染列表的时候它们都会要求你提供 key 以保证复用。这就和那个差不多。 + + realNode // 有时候 node.current 的魔法会失灵，或者奇奇怪怪的故障，或者总之你就是想访问真实的 DOM 元素，那就用它吧。不过它不会自动更新！ + + return { + onRemove(old) { + // 如果 E 从文档里消失了…… + // 你需要做的善后工作…… + // 类似于 React.useEffect(() => { return 这里返回的函数 }) + }, + onNodeMutation() { + // 如果 key 没变，E 也没变 + // 只是 E 内部发生了变化的话，这里会被通知到 + // 比如 node.current 里面新插入了一个元素 + }, + onTargetChanged(oldNode, newNode) { + // 如果 key 没变，但是 key 指向的 E 变了的话 + // oldNode 是变化前指向的元素，newNode 是变化后指向的新元素 + // 注意，node.current 始终指向 newNode，所以很多事情你不必手动处理 + }, + } +}) +``` + +> Tips: 如果你始终只关心 `LiveSelector` 选中的第一个元素的话，这里有个捷径！`Watcher#firstVirtualNode` 是一个始终指向第一个元素的 `DomProxy`！ + +[Watcher 的文档](#doc-watchers) + +
+ +教程到这里就结束了，你可以回头看看最开始的例子。 + +# 文档 + +## class LiveSelector + +LiveSelector 上的方法，除了 `evaluateOnce()` 都可以链式调用。 + +```ts +const ls = new LiveSelector() +``` + +> Typescript: `LiveSelector` 每一次都有一个类型参数 `` 告诉你计算到这一步时它的类型。 + +### `.querySelector(selector)` + +同 [document.querySelector](https://mdn.io/document.querySelector)，计算时，将选中的元素加入列表。 + +```typescript +ls.querySelector('div#root').querySelector('.nav') +``` + +**注意：以上的例子等于 `div#root` 和 `.nav` 的并集，并不是 `div#root .nav` 的意思！** + +> Typescript: 这个函数的泛型与 `document.querySelector` 相同 + +> Typescript: 对于复杂的 CSS 选择器，无法推断它的类型，你需要手动指定。`.querySelector('div > div')` + +### `.querySelectorAll(selector)` + +同 [document.querySelectorAll](https://mdn.io/document.querySelectorAll)，计算时，将选中的元素加入列表。 + +```typescript +ls.querySelectorAll('div').querySelectorAll('h1') +``` + +**注意：以上的例子等于 `div` 和 `h1` 的并集，并不是 `div h1` 的意思！** + +> Typescript: 这个函数的泛型与 `document.querySelectorAll` 相同 + +> Typescript: 对于复杂的 CSS 选择器，无法推断它的类型，你需要手动指定。`.querySelectorAll('div > div')` + +### `.filter(callbackfn)` + +与 [Array#filter](https://mdn.io/Array.filter) 类似。计算时，过滤掉列表中不符合的内容。 + +```ts +ls.filter(x => x.innerText.match('hello')) +``` + +### `.map(callbackfn)` + +与 [Array#map](https://mdn.io/Array.map) 类似。计算时，将列表中的每个元素映射为另一个元素。 + +```ts +ls.map(x => x.parentElement) +``` + +**提示：map 不只限于 map 到 Dom 元素，你可以 map 到任何东西** + +### `.concat(newLS: LiveSelector)` + +与 [Array#concat](https://mdn.io/Array.concat) 类似。计算时，将一个新的 `LiveSelector` 的计算结果合并进当前的计算结果。 + +```ts +ls.concat(new LiveSelector().querySelector('#root')) +``` + +### `.reverse()` + +与 [Array#reverse](https://mdn.io/Array.reverse) 类似。计算时，将列表反转。 + +```ts +ls.reverse() +``` + +### `.slice(start?, end?)` + +与 [Array#slice](https://mdn.io/Array.slice) 类似。计算时，截取列表的一部分。 + +```ts +ls.slice(2, 4) +``` + +### `.sort(compareFn)` + +与 [Array#sort](https://mdn.io/Array.sort) 类似。计算时，对列表排序。 + +```ts +ls.sort((a, b) => a.innerText.length - b.innerText.length) +``` + +### `.flat()` + +与 [Array#flat](https://mdn.io/Array.flat) 类似。计算时，将列表变平。 + +**注意：这不是递归的操作！** + +```ts +ls.flat() +``` + +### `.nth(n: number)` + +计算时，只保留第 N 个元素。 + +```ts +ls.nth(-1) +``` + +### `.replace(f: (list: T[]) => NextT[])` + +如果认为上面这些类 Array 的方法还不足以满足你的要求，你可以直接在计算时替换列表。 + +```ts +ls.replace(x => lodash.dropRight(x, 2)) +``` + +### `.evaluateOnce()` + +执行一次计算。这应该是最后一个被调用的方法。每一次调用，它都会重新根据你之前所执行的 `querySelector` 等方法查询一次。 + +```ts +ls.evaluateOnce() +``` + +## Watchers + +所有 Watcher 都继承自抽象类 [Watcher](#abstract-class-Watcher-public)。 + +### abstract class Watcher (public) + +继承自 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) + +#### `constructor (liveSelector)` + +创建一个新的 `Watcher`。 + +- liveSelector: `LiveSelector`, 要监听的 LiveSelector + +> Typescript: 泛型 `T` 等于 LiveSelector 的泛型 + +#### abstract `.startWatch(?): this` + +开始监听。参数请参见实现的说明。 + +#### abstract `.stopWatch()` + +停止监听。 + +#### `.addListener(event, fn)` + +见 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)。 +仅提供以下事件： + +- onChange - 每次列表更新时，发生变化的部分 +- onChangeFull - 每次列表更新时，新的完整的列表 +- onRemove - 每次列表更新时，被删除的部分 +- onAdd - 每次列表更新时，被添加的部分 + +#### `.firstVirtualNode` + +**注意：如果 T 不是 HTMLElement 的子类型，那么该对象不可用。** + +一个 [DomProxy](#doc-domproxy)，始终指向 LiveSelector 的第一个元素 + +#### `.assignKeys(assigner, comparer?)` + +- assigner: 为每个元素分配一个 key，key 可以是任何内容。 + 默认为 `x => x` + +```ts +assigner: (node: T, index: number, arr: T[]) => Q +// node: 需要被分配 key 的元素 +// index: 当前位置 +// arr: 整个数组 +``` + +- comparer: 如果你的 key 不能用 `===` 来直接比较的话，用这个参数自定义一个比较方式。默认为 `(a, b) => a === b` + +```ts +comparer: (a: Q, b: Q) => boolean +// a: 一种 assigner 返回的对象 +// b: 另一种 assigner 返回的对象 +``` + +#### `.useNodeForEach(fn)` + +**注意：如果 T 不是 HTMLElement 的子类型，那么该函数不可用。** + +列表里每添加一个新项目，会调用一次 fn。 + +##### fn 与它的返回值： + +```ts +(fn: (node: DomProxy, key: Q, realNode: HTMLElement) => ...) +// node: 一个 DomProxy +// key: assigner 返回的 key +// realNode: node 所对应的真实 node +``` + +- undefined: 什么也不会发生 +- 一个函数: `(oldNode: T) => void`，当 `key` 在某一次迭代中从列表中消失了，该函数会被调用 +- 一个对象: `{ onRemove?: (old: T) => void; onTargetChanged?: (oldNode: T, newNode: T) => void; onNodeMutation?: (node: T) => void }` +- - `onRemove(oldNode: T) => void` 当 `key` 在某一次迭代中从列表中消失了，该函数会被调用 +- - `onTargetChanged(oldNode: T, newNode: T) => void` 当 `key` 在两次迭代中依然存在，但它对应的元素不同时会调用 +- - `onNodeMutation: (node: T) => void` 当 `key` 和元素都没有变化，而是元素内部发生了变化时会调用。 + +#### `.getVirtualNodeByKey(key)` + +**注意：如果 T 不是 HTMLElement 的子类型，那么该函数不可用。** + +- key: Q. 根据 key 寻找 key 对应的 [DomProxy](#doc-domproxy) + +### MutationObserverWatcher + +#### `constructor (liveSelector, consistentWatchRoot = document.body)` + +创建一个新的 `MutationObserverWatcher`。 + +它会在 `consistentWatchRoot` 上发生任何变化时计算变化。 + +> 每 requestAnimateFrame 最多查询一次，不会导致页面卡顿。 + +- liveSelector: `LiveSelector`, 要监听的 LiveSelector +- consistentWatchRoot: `Element | Document`, 保证稳定（不会被删除从而导致监听失效）的元素，默认为 `document.body`，如果你怀疑 `MutationObserverWatcher` 导致了性能问题，请提供这个参数缩小监听范围。 + +#### `startWatch(options?: MutationObserverInit)` + +开始监听。 + +- options: `MutationObserverInit`，你可以自行排除掉对某些修改事件的监听。（见： [MutationObserver](https://mdn.io/MutationObserver) ） + +### IntervalWatcher + +通过时间流逝触发检查。 + +#### `.startWatch(interval)` + +开始监听。 + +- options: `numebr`，每隔多少毫秒检查一次。 + +### EventWatcher + +手动触发检查。 + +#### `.startWatch()` + +开始监听。 + +#### `.eventListener()` + +事件监听器。 +用法： + +```ts +ele.addEventListener('click', watcher.eventListener) +``` + +### ValueRef + +ValueRef 与 `LiveSelector` 无关，它监听 `.value =`。例如： + +```ts +const ref = new ValueRef(0) +ref.value // 0 +ref.addEventListener('onChangeFull', () => console.log('onChange')) +ref.value = 1 +// Log: onChange +ref.value // 1 +``` + +#### `constructor(value: T)` + +- value: 初始值。 + +#### `.value` + +当前值。写入的话会触发事件。 + +### abstract class Watcher (protected) + +这里 Watcher 的 protected 属性与方法。如果你不是在自己继承 `Watcher`，那么你用不到这里提到的属性和方法。 + +#### protected readonly `.nodeWatcher: MutationWatcherHelper` + +用于触发 onNodeMutation 的 Watcher。 + +`MutationWatcherHelper` 是内部类，没有导出。你不应该使用它。 + +#### protected `.watching: boolean` + +当前是否正在监听。如果为 `false`，那么 `.watcherCallback()` 不会有反应。 + +#### protected `.lastKeyList: unknown[]` + +上一次检查的 Key 列表。 + +#### protected `.lastNodeList: T[]` + +上一次检查的元素列表。 + +#### protected `.lastCallbackMap: Map>` + +所有还未销毁的 `useNodeForeach()` 所返回的函数（`onRemove` `onNodeMutation` 等） + +#### protected `.lastVirtualNodesMap: Map` + +所有还未销毁的 DomProxy + +#### protected `.findNodeFromListByKey(list: T[], keys: unknown: []): (key: unknown) => T | null` + +一个高阶函数。通过 key 在 list 中寻找元素。（因为元素可能是复杂的对象，不能直接比较。） + +```ts +.findNodeFromListByKey(this.lastNodeList, this.lastKeyList)(key) +``` + +#### protected `.watcherCallback()` + +检查逻辑。当你需要触发检查时，调用它。 + +它做了以下这些事情： + +- 调用 `LiveSelector` 的 `EvaluateOnce` +- 通过 `assignKeys` 为每个元素设置 `key` + +- 寻找被删除的元素并调用 `onRemove` +- 寻找新增的元素并调用 `useNodeForeachFn()` +- 寻找 `key` 相同但变化了的元素并调用 `onTargetChanged()` +- 重新设置 `lastCallbackMap` `lastVirtualNodesMap` `lastKeyList` `lastNodeList` +- 发出 `onChangeFull` `onChange` `onRemove` `onAdd` 事件 +- 为 `.firstVirtualNode` 绑定新的 Node + +#### protected `.mapNodeToKey(node: T, index: number: arr: T[]): unknown` + +返回 node 对应的 key（可被 `assignKeys` 覆盖） + +#### protected `.keyComparer(a: unknown, b: unknown): boolean` + +返回 `a` 和 `b` 是否相等 (可被 `assignKeys` 覆盖) + +#### protected `.useNodeForeachFn(...): ...` + +见 [.useNodeForeach](#doc-watcher-usenodeforeach-fn) + +## DomProxy + +DomProxy 提供抽象的 Dom，其引用不随 Dom 变化而变化。 + +调用后返回以下对象 + +### `.before` + +一个 span 元素，始终位于 [realCurrent](#doc-domproxy-realCurrent) 前面 + +### `.current` + +一个伪装的 HTML 元素，对其的操作会转发到 [realCurrent](#doc-domproxy-realCurrent)，realCurrent 改变后，曾经的部分操作会被转发。 + +### `.after` + +一个 span 元素，始终位于 [realCurrent](#doc-domproxy-realCurrent) 后面 + +### `.realCurrent` + +真实的 current。修改的话会触发 [after](#doc-domproxy-after), [current](#doc-domproxy-current), [before](#doc-domproxy-before) 的修改。 + +### `.destroy()` + +调用后该 DomProxy 不再可用。 + +### DOMProxy 当前的转发策略 + +**注意：只有通过 current 进行的修改才会被转发** + +- forward: 转发到当前的 `realCurrent` +- undo: `realCurrent` 修改时被撤销 +- move: `realCurrent` 修改时移动到新的 `realCurrent` 上 + +| 属性 | forward | undo | move | +| ---------------- | ------- | ---- | ---- | +| style | Yes | No | Yes | +| addEventListener | Yes | Yes | Yes | +| appendChild | Yes | Yes | Yes | +| ...默认 | Yes | No | No | + +这意味着，你修改 `current.style.opacity`，在 `realCurrent` 被修改后，新的 `realCurrent` 也会自动修改 `current.style.opacity` + +**将来会添加更多转发策略，如有需要，欢迎到 issue 提出，或自己实现！** diff --git a/doc/zh-CN/Extension.md b/doc/zh-CN/Extension.md new file mode 100644 index 0000000..87af3d5 --- /dev/null +++ b/doc/zh-CN/Extension.md @@ -0,0 +1,60 @@ +# @holoflows/kit/Extension/ + +一些扩展开发会使用到的实用工具 + +# class MessageCenter + +一个在 Chrome 扩展不同上下文间传递消息的类。 + +> Typescript: 消息是有类型的！ + +```ts +interface AllEvents { + event1: { x: number; y: number } +} +const mc = new MessageCenter() +mc.on // 只接受监听 keyof AllEvents +mc.send // 只允许发送 keyof AllEvents, 且 data 需要是 AllEvents[key] +``` + +## `constructor(key?: string)` + +- key?: 可随意指定，但需要在各个实例之间保持一致。 + +## `.on(event, handler)` + +接受事件。 + +## `.on(event, data)` + +发送事件。 + +## `.writeToConsole` + +发送、接受事件时打印到控制台。 + +# AsyncCall + +一个简易 RPC。 + +[文档见此](../../src/Extension/Async-Call.ts) + +# Contexts + +辨别当前运行的上下文 + +## type `Contexts` + +- background: 背景页 +- content: 内容脚本 +- unknown: 未知 + +## `GetContext():`Contexts + +获取当前上下文 + +## `OnlyRunInContext`(context: Contexts | Contexts[], name: string) + +只允许本段代码在某个上下文中运行，否则报错。 + +- name 是报错时提供的名字。 diff --git a/doc/zh-CN/index.md b/doc/zh-CN/index.md new file mode 100644 index 0000000..ef4d41f --- /dev/null +++ b/doc/zh-CN/index.md @@ -0,0 +1,26 @@ +# @holoflows/kit + +一个浏览器扩展开发的工具包 + +## 组成 + +@holoflows/kit 由以下部分组成 + +- [DOM](./DOM.md) - 帮助扩展开发者追踪被注入网页中的内容变化 +- [Extension](./Extension.md) - 一些扩展开发会使用到的实用工具 + +## 安装 + +使用 `yarn` 或 `npm` 安装，或直接使用 umd + +> https://unpkg.com/@holoflows/kit@latest/dist/out.js + +使用模块加载器时，使用 `@holoflows/kit` 导入；使用 umd 时，使用 `window.HoloflowsKit`。 + +### ECMAScript 版本 + +因为本库重度依赖 [Proxy](https://mdn.io/Proxy)，所以支持 ES5 没有意义。 + +`@holoflows/kit` 以 umd 格式 (/dist/out.js) 和 ESModule 格式 (/es/) 导出，umd 格式编译到 ES6，ESModule 格式编译到 ES2018。 + +开箱提供了完整的 Typescript 支持。 diff --git a/package.json b/package.json index ac0079b..64926dc 100644 --- a/package.json +++ b/package.json @@ -31,5 +31,6 @@ "rollup-plugin-replace": "^2.1.0", "rollup-plugin-typescript2": "^0.19.2", "typescript": "3.3.3" - } + }, + "license": "AGPL-3.0-or-later" } diff --git a/rollup.config.js b/rollup.config.js index 25ac0e6..55b86bf 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -19,7 +19,7 @@ const config = { replace({ 'process.env.NODE_ENV': JSON.stringify('production'), }), - typescript({ tsconfigOverride: { compilerOptions: { target: 'es5' } } }), + typescript({ tsconfigOverride: { compilerOptions: { target: 'es6' } } }), commonjs({ extensions: ['.js', '.ts', '.tsx'], exclude: ['node_modules/lodash-es/'], diff --git a/src/DOM/Watcher.ts b/src/DOM/Watcher.ts index 1f59e6c..54d5754 100644 --- a/src/DOM/Watcher.ts +++ b/src/DOM/Watcher.ts @@ -44,13 +44,10 @@ interface MultipleNodeWatcher { * * *Param comparer*: compare between two keys, defaults to `===` */ - assignKeys: RequireNode< - T, - ( - assigner: (node: T, index: number, arr: T[]) => Q, - comparer?: (a: Q, b: Q) => boolean, - ) => Watcher - > + assignKeys: ( + assigner: (node: T, index: number, arr: T[]) => Q, + comparer?: (a: Q, b: Q) => boolean, + ) => Watcher useNodeForeach: RequireNode< T, (fn: (virtualNode: DomProxy, key: unknown, realNode: T) => useWatchCallback) => Watcher diff --git a/src/DOM/Watchers/ValueRef.ts b/src/DOM/Watchers/ValueRef.ts index 0e9411f..d932945 100644 --- a/src/DOM/Watchers/ValueRef.ts +++ b/src/DOM/Watchers/ValueRef.ts @@ -11,6 +11,7 @@ export class ValueRef extends Watcher { } constructor(private _value: T) { super(new LiveSelector().replace(() => [this._value])) + this.startWatch() } startWatch() { this.watching = true diff --git a/src/Extension/MessageCenter.ts b/src/Extension/MessageCenter.ts index d76e229..478df41 100644 --- a/src/Extension/MessageCenter.ts +++ b/src/Extension/MessageCenter.ts @@ -64,15 +64,15 @@ export class MessageCenter { // this.send('require_extension_id', undefined) // } } - public on(key: Key, handler: (data: ITypedMessages[Key]) => void): any { + public on(event: Key, handler: (data: ITypedMessages[Key]) => void): void { this.listeners.push({ handler: data => handler(data), - key, + key: event, }) } /** Send message to local or other instance of extension */ - public send(key: Key, data: ITypedMessages[Key]): any { + public send(key: Key, data: ITypedMessages[Key]): void { if (this.writeToConsole) { console.log( `%cSend%c %c${key.toString()}`,