From 3dd6719806a41ef98f4e926d89676f85627474d8 Mon Sep 17 00:00:00 2001 From: erik Date: Sat, 6 Jul 2024 22:16:18 +0400 Subject: [PATCH] init --- .github/workflows/publish.yml | 21 + .gitignore | 2 + LICENSE | 674 ++++++++++++++++++++++++++++++ README.md | 151 +++++++ package-lock.json | 137 +++++++ package.json | 25 ++ src/braveSearch.ts | 236 +++++++++++ src/types.ts | 743 ++++++++++++++++++++++++++++++++++ tsconfig.json | 13 + 9 files changed, 2002 insertions(+) create mode 100644 .github/workflows/publish.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 src/braveSearch.ts create mode 100644 src/types.ts create mode 100644 tsconfig.json diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..c767b7d --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,21 @@ +name: Publish to npm + +on: + release: + types: [created] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: '14' + registry-url: 'https://registry.npmjs.org' + - run: npm ci + - run: npm run build + - run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f06235c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +dist diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d41642c --- /dev/null +++ b/README.md @@ -0,0 +1,151 @@ +# Brave Search API Library + +A TypeScript library for interacting with the Brave Search API, providing easy +access to web search, local POI search, and automatic summarization features. + +## Installation + +Install the package using npm: + +```shell +npm install brave-search +``` + +## Getting Started + +1. Obtain a Brave Search API key from + [Brave Search API Dashboard](https://api.search.brave.com/app/keys). + +2. Install the package: + ```bash + npm install brave-search + ``` + +3. Import and initialize the `BraveSearch` class: + ```typescript + import { BraveSearch } from "brave-search"; + + const BRAVE_API_KEY = "your-api-key-here"; + const braveSearch = new BraveSearch(BRAVE_API_KEY); + ``` + +## Usage + +### Web Search + +Perform a web search: + +```typescript +const webSearchResults = await braveSearch.webSearch("TypeScript tutorial", { + count: 5, + safesearch: "off", + search_lang: "en", + country: "US", + text_decorations: false, +}); +console.log(webSearchResults); +``` + +### Summarized Search + +Get a summarized answer for a query (requires "Data for AI pro" plan): + +```typescript +const { summary, webSearchResponse } = await braveSearch.getSummarizedAnswer( + "What is TypeScript?", + { + count: 5, + safesearch: "off", + search_lang: "en", + country: "US", + text_decorations: false, + freshness: "pw", + spellcheck: false, + extra_snippets: true, + summary: true, + }, +); +console.log(summary); +console.log(webSearchResponse); +``` + +### Local POI Search + +Search for local points of interest: + +```typescript +const poiResults = await braveSearch.localPoiSearch("poi_id1", "poi_id2"); +console.log(poiResults); +``` + +### Local Descriptions Search + +Get descriptions for local points of interest: + +```typescript +const descriptionResults = await braveSearch.localDescriptionsSearch( + "poi_id1", + "poi_id2", +); +console.log(descriptionResults); +``` + +### Search Options + +The library supports various search options as defined in the Brave Search API +documentation. Here are some of the available options: + +```typescript +interface BraveSearchOptions { + country?: string; + search_lang?: string; + ui_lang?: string; + safesearch?: "off" | "moderate" | "strict"; + freshness?: "pd" | "pw" | "pm" | "py" | string; + text_decorations?: boolean; + spellcheck?: boolean; + goggles_id?: string; + units?: "metric" | "imperial"; + extra_snippets?: boolean; + count?: number; + result_filter?: ResultFilterType; + summary?: boolean; +} +``` + +For a complete list of options and their descriptions, please refer to the +[Brave Search API Documentation](https://api.search.brave.com/app/documentation/web-search/). + +## Important Notes + +- The `summary` option and `getSummarizedAnswer` method are only available with + the Brave "Data for AI pro" plan. +- For detailed information about API usage, rate limits, and pricing, please + visit the [Brave Search API Terms](https://brave.com/search/api/). + +## API Reference + +For detailed API reference, please refer to the +[Brave Search API Documentation](https://api.search.brave.com/app/documentation/web-search/). + +## Features + +- Web search +- Automatic summarization with polling +- Local POI search +- Local descriptions search +- Error handling for API requests + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +This project is licensed under the GNU General Public License v3.0 - see the +[LICENSE](LICENSE) file for details. + +## Disclaimer + +This library is not officially associated with Brave Software. It is a +third-party implementation of the Brave Search API. diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..2238f5c --- /dev/null +++ b/package-lock.json @@ -0,0 +1,137 @@ +{ + "name": "brave-search", + "version": "0.5.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "brave-search", + "version": "0.5.0", + "license": "GPL-3.0-or-later", + "dependencies": { + "axios": "^1.7.2" + }, + "devDependencies": { + "@types/node": "^20.14.10", + "typescript": "^5.5.3" + } + }, + "node_modules/@types/node": { + "version": "20.14.10", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.10.tgz", + "integrity": "sha512-MdiXf+nDuMvY0gJKxyfZ7/6UFsETO7mGKF54MVD/ekJS6HdFtpZFBgrh6Pseu64XTb2MLyFPlbW6hj8HYRQNOQ==", + "dev": true, + "dependencies": { + "undici-types": "~5.26.4" + } + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" + }, + "node_modules/axios": { + "version": "1.7.2", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.2.tgz", + "integrity": "sha512-2A8QhOMrbomlDuiLeK9XibIBzuHeRcqqNOHp0Cyp5EoJ1IFDh+XZH3A6BkXtv0K4gFGCI0Y4BM7B1wOEi0Rmgw==", + "dependencies": { + "follow-redirects": "^1.15.6", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/follow-redirects": { + "version": "1.15.6", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz", + "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/form-data": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", + "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==" + }, + "node_modules/typescript": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.3.tgz", + "integrity": "sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "5.26.5", + "dev": true, + "license": "MIT" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..32b06c1 --- /dev/null +++ b/package.json @@ -0,0 +1,25 @@ +{ + "name": "brave-search", + "version": "0.5.0", + "description": "A TypeScript library for interacting with the Brave Search API, including web search, local POI search, and automatic summarization features.", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "main": "dist/braveSearch.js", + "types": "dist/braveSearch.d.ts", + "files": [ + "dist", + "LICENSE", + "README.md" + ], + "author": "erik.balfe@protonmail.com", + "license": "GPL-3.0-or-later", + "devDependencies": { + "@types/node": "^20.14.10", + "typescript": "^5.5.3" + }, + "dependencies": { + "axios": "^1.7.2" + } +} \ No newline at end of file diff --git a/src/braveSearch.ts b/src/braveSearch.ts new file mode 100644 index 0000000..27a5aa3 --- /dev/null +++ b/src/braveSearch.ts @@ -0,0 +1,236 @@ +// Copyright (C) 2023 Erik Balfe +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import axios from "axios"; + +import { + BraveSearchOptions, + LocalDescriptionsOptions, + LocalDescriptionsSearchApiResponse, + LocalPoiOptions, + LocalPoiSearchApiResponse, + SummarizerOptions, + SummarizerSearchApiResponse, + WebSearchApiResponse, +} from "./types"; + +class BraveSearchError extends Error { + constructor(message: string) { + super(message); + this.name = "BraveSearchError"; + } +} + +class BraveSearch { + private apiKey: string; + private baseUrl = "https://api.search.brave.com/res/v1"; + private maxPollAttempts = 5; + private pollInterval = 500; + + constructor( + apiKey: string, + options?: { maxPollAttempts?: number; pollInterval?: number }, + ) { + this.apiKey = apiKey; + if (options) { + this.maxPollAttempts = options.maxPollAttempts ?? this.maxPollAttempts; + this.pollInterval = options.pollInterval ?? this.pollInterval; + } + } + + async webSearch( + query: string, + options: BraveSearchOptions = {}, + ): Promise { + const params = new URLSearchParams({ + q: query, + ...this.formatOptions(options), + }); + + try { + const response = await axios.get( + `${this.baseUrl}/web/search?${params.toString()}`, + { + headers: this.getHeaders(), + }, + ); + return response.data; + } catch (error) { + throw this.handleApiError(error); + } + } + + async getSummarizedAnswer( + query: string, + options: BraveSearchOptions = {}, + summarizerOptions: SummarizerOptions = {}, + ): Promise< + { + summary?: SummarizerSearchApiResponse; + webSearchResponse: WebSearchApiResponse; + } + > { + try { + const webSearchResponse = await this.webSearch(query, options); + const summarizerKey = webSearchResponse.summarizer?.key; + + if (summarizerKey) { + const summary = await this.pollForSummary( + summarizerKey, + summarizerOptions, + ); + return { summary, webSearchResponse }; + } + + return { webSearchResponse }; + } catch (error) { + throw this.handleApiError(error); + } + } + + async localPoiSearch( + ids: string[], + options: LocalPoiOptions = {}, + ): Promise { + const params = new URLSearchParams({ + ids: ids.join(","), + ...this.formatOptions(options), + }); + + try { + const response = await axios.get( + `${this.baseUrl}/local/pois?${params.toString()}`, + { + headers: this.getHeaders(), + }, + ); + return response.data; + } catch (error) { + throw this.handleApiError(error); + } + } + + async localDescriptionsSearch( + ids: string[], + options: LocalDescriptionsOptions = {}, + ): Promise { + const params = new URLSearchParams({ + ids: ids.join(","), + ...this.formatOptions(options), + }); + + try { + const response = await axios.get( + `${this.baseUrl}/local/descriptions?${params.toString()}`, + { + headers: this.getHeaders(), + }, + ); + return response.data; + } catch (error) { + throw this.handleApiError(error); + } + } + + private async pollForSummary( + key: string, + options: SummarizerOptions, + ): Promise { + for (let attempt = 0; attempt < this.maxPollAttempts; attempt++) { + const summaryResponse = await this.summarizerSearch(key, options); + + console.warn("summary", summaryResponse); + if (summaryResponse.status === "complete" && summaryResponse.summary) { + return summaryResponse; + } else if (summaryResponse.status === "failed") { + throw new BraveSearchError("Summary generation failed"); + } + + await new Promise((resolve) => setTimeout(resolve, this.pollInterval)); + } + + throw new BraveSearchError( + "Summary not available after maximum polling attempts", + ); + } + + private async summarizerSearch( + key: string, + options: SummarizerOptions, + ): Promise { + const params = new URLSearchParams({ + key, + ...this.formatOptions(options), + }); + + try { + const response = await axios.get( + `${this.baseUrl}/summarizer/search?${params.toString()}`, + { + headers: this.getHeaders(), + }, + ); + return response.data; + } catch (error) { + throw this.handleApiError(error); + } + } + + private getHeaders() { + return { + "Accept": "application/json", + "Accept-Encoding": "gzip", + "X-Subscription-Token": this.apiKey, + }; + } + + private formatOptions(options: Record): Record { + return Object.entries(options).reduce((acc, [key, value]) => { + if (value !== undefined) { + acc[key] = value.toString(); + } + return acc; + }, {} as Record); + } + + private handleApiError(error: any): BraveSearchError { + if (axios.isAxiosError(error)) { + const status = error.response?.status; + const message = error.response?.data?.message || error.message; + + if (status === 429) { + return new BraveSearchError(`Rate limit exceeded: ${message}`); + } else if (status === 401) { + return new BraveSearchError(`Authentication error: ${message}`); + } else { + return new BraveSearchError(`API error (${status}): ${message}`); + } + } + return new BraveSearchError(`Unexpected error: ${error.message}`); + } +} + +export { + BraveSearch, + BraveSearchError, + type BraveSearchOptions, + type LocalDescriptionsOptions, + type LocalDescriptionsSearchApiResponse, + type LocalPoiOptions, + type LocalPoiSearchApiResponse, + type SummarizerOptions, + type SummarizerSearchApiResponse, + type WebSearchApiResponse, +}; diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..04d496a --- /dev/null +++ b/src/types.ts @@ -0,0 +1,743 @@ +// Options types +export type ResultFilterValue = + | "discussions" + | "faq" + | "infobox" + | "news" + | "query" + | "summarizer" + | "videos" + | "web"; + +export type ResultFilterType = ResultFilterValue | string; + +export interface BraveSearchOptions { + country?: string; + search_lang?: string; + ui_lang?: string; + safesearch?: "off" | "moderate" | "strict"; + freshness?: "pd" | "pw" | "pm" | "py" | string; + text_decorations?: boolean; + spellcheck?: boolean; + goggles_id?: string; + units?: "metric" | "imperial"; + extra_snippets?: boolean; + count?: number; + result_filter?: ResultFilterType; + summary?: boolean; +} + +export interface SummarizerOptions { + entity_info?: boolean; +} + +export interface LocalPoiOptions { + // Add any specific options for Local POI search if needed +} + +export interface LocalDescriptionsOptions { + // Add any specific options for Local Descriptions search if needed +} + +// Response types + +export interface WebSearchApiResponse { + type: "search"; + discussions?: Discussions; + faq?: FAQ; + infobox?: GraphInfobox; + locations?: Locations; + mixed?: MixedResponse; + news?: News; + query: Query; + videos?: Videos; + web?: Search; + summarizer?: Summarizer; +} + +export interface SummarizerSearchApiResponse { + type: "summarizer"; + status: "failed" | "complete"; + title?: string; + summary?: SummaryMessage[]; + enrichments?: SummaryEnrichments; + followups?: string[]; + entities_infos?: { [key: string]: SummaryEntityInfo }; +} + +export interface LocalPoiSearchApiResponse { + type: "local_pois"; + results: LocationResult[]; +} + +export interface LocalDescriptionsSearchApiResponse { + type: "local_descriptions"; + results: LocationDescription[]; +} + +// Common types + +export interface MetaUrl { + scheme: string; + netloc: string; + hostname: string; + favicon: string; + path: string; +} + +export interface Thumbnail { + src: string; + alt?: string; + height?: number; + width?: number; + bg_color?: string; + original?: string; + logo?: boolean; + duplicated?: boolean; + theme?: string; +} + +export interface Rating { + ratingValue: number; + bestRating: number; + reviewCount: number; + profile?: Profile; + is_tripadvisor?: boolean; +} + +export interface Profile { + name: string; + long_name?: string; + url: string; + img: string; +} + +export interface Unit { + value: number; + units: string; +} + +// Specific types for each part of the response + +export interface Discussions { + type: "search"; + results: DiscussionResult[]; + mutated_by_goggles: boolean; +} + +export interface DiscussionResult extends Omit { + type: "discussion"; + data: ForumData; +} + +export interface ForumData { + forum_name: string; + num_answers: number; + score: string; + title: string; + question: string; + top_comment: string; +} + +export interface FAQ { + type: "faq"; + results: QA[]; +} + +export interface QA { + question: string; + answer: string; + title: string; + url: string; + meta_url: MetaUrl; +} + +export interface GraphInfobox { + type: "graph"; + results: GenericInfobox | QAInfobox | InfoboxPlace | InfoboxWithLocation; +} + +export interface AbstractGraphInfobox extends Result { + type: "infobox"; + position: number; + label?: string; + category?: string; + long_desc?: string; + thumbnail?: Thumbnail; + attributes?: string[][]; + profiles?: Profile[] | DataProvider[]; + website_url?: string; + ratings?: Rating[]; + providers?: DataProvider[]; + distance?: Unit; + images?: Thumbnail[]; + movie?: MovieData; +} + +export interface GenericInfobox extends AbstractGraphInfobox { + subtype: "generic"; + found_in_urls: string[]; +} + +export interface QAInfobox extends AbstractGraphInfobox { + subtype: "code"; + data: QAPage; + meta_url: MetaUrl; +} + +export interface InfoboxWithLocation extends AbstractGraphInfobox { + subtype: "location"; + is_location: boolean; + coordinates: [number, number]; + zoom_level: number; + location: LocationResult; +} + +export interface InfoboxPlace extends AbstractGraphInfobox { + subtype: "place"; + location: LocationResult; +} + +export interface Locations { + type: "locations"; + results: LocationResult[]; +} + +export interface MixedResponse { + type: "mixed"; + main: ResultReference[]; + top: ResultReference[]; + side: ResultReference[]; +} + +export interface ResultReference { + type: string; + index: number; + all: boolean; +} + +export interface News { + type: "news"; + results: NewsResult[]; + mutated_by_goggles: boolean; +} + +export interface Query { + original: string; + show_strict_warning: boolean; + altered: string; + safesearch: boolean; + is_navigational: boolean; + is_geolocal: boolean; + local_decision: string; + local_locations_idx: number; + is_trending: boolean; + is_news_breaking: boolean; + ask_for_location: boolean; + language: Language; + spellcheck_off: boolean; + country: string; + bad_results: boolean; + should_fallback: boolean; + lat?: string; + long?: string; + postal_code?: string; + city?: string; + state?: string; + header_country: string; + more_results_available: boolean; + custom_location_label?: string; + reddit_cluster?: string; + summary_key?: string; +} + +export interface Videos { + type: "videos"; + results: VideoResult[]; + mutated_by_goggles: boolean; +} + +export interface Search { + type: "search"; + results: SearchResult[]; + family_friendly: boolean; +} + +export interface Summarizer { + type: "summarizer"; + key: string; +} + +// Result types + +export interface Result { + title: string; + url: string; + is_source_local?: boolean; + is_source_both?: boolean; + description: string; + page_age?: string; + page_fetched?: string; + profile?: Profile; + language?: string; + family_friendly: boolean; +} + +export interface SearchResult extends Result { + type: "search_result"; + subtype: "generic"; + deep_results?: DeepResult; + schemas?: any[][]; + meta_url: MetaUrl; + thumbnail?: Thumbnail; + age?: string; + language?: string; + location?: LocationResult; + video?: VideoData; + movie?: MovieData; + faq?: FAQ; + qa?: QAPage; + book?: Book; + rating?: Rating; + article?: Article; + product?: ProductReview; + product_cluster?: ProductReview[]; + cluster_type?: string; + cluster?: Result[]; + creative_work?: CreativeWork; + music_recording?: MusicRecording; + review?: Review; + software?: Software; + recipe?: Recipe; + organization?: Organization; + content_type?: string; + extra_snippets?: string[]; +} + +export interface NewsResult extends Result { + meta_url: MetaUrl; + source: string; + breaking: boolean; + thumbnail?: Thumbnail; + age: string; + extra_snippets?: string[]; +} + +export interface VideoResult extends Result { + type: "video_result"; + video: VideoData; + meta_url: MetaUrl; + thumbnail: Thumbnail; + age: string; +} + +export interface LocationResult extends Result { + type: "location_result"; + id: string; + provider_url: string; + coordinates: [number, number]; + zoom_level: number; + thumbnail?: Thumbnail; + postal_address: PostalAddress; + opening_hours?: OpeningHours; + contact?: Contact; + price_range?: string; + rating?: Rating; + distance?: Unit; + profiles?: DataProvider[]; + reviews?: Reviews; + pictures?: PictureResults; + action?: Action; + serves_cuisine?: string[]; + categories?: string[]; + icon_category?: string; + results?: LocationWebResult; + timezone?: string; + timezone_offset?: string; +} + +export interface LocationDescription { + type: "local_description"; + id: string; + description: string; +} + +// Additional types + +export interface Language { + main: string; +} + +export interface DeepResult { + news?: NewsResult[]; + buttons?: ButtonResult[]; + social?: KnowledgeGraphProfile[]; + videos?: VideoResult[]; + images?: Image[]; +} + +export interface ButtonResult { + type: "button_result"; + title: string; + url: string; +} + +export interface KnowledgeGraphProfile { + title: string; + description: string; + url: string; + thumbnail: string; +} + +export interface Image { + thumbnail: Thumbnail; + url: string; + properties: ImageProperties; +} + +export interface ImageProperties { + url: string; + resized: string; + height: number; + width: number; + format: string; + content_size: string; +} + +export interface VideoData { + duration: string; + views: string; + creator: string; + publisher: string; + thumbnail: Thumbnail; +} + +export interface MovieData { + name: string; + description: string; + url: string; + thumbnail: Thumbnail; + release: string; + directors: Person[]; + actors: Person[]; + rating: Rating; + duration: string; + genre: string[]; + query: string; +} + +export interface QAPage { + question: string; + answer: Answer; +} + +export interface Answer { + text: string; + author: string; + upvoteCount: number; + downvoteCount: number; +} + +export interface Book { + title: string; + author: Person[]; + date: string; + price: Price; + pages: number; + publisher: Person; + rating: Rating; +} + +export interface Price { + price: string; + price_currency: string; +} + +export interface Article { + author: Person[]; + date: string; + publisher: Organization; + thumbnail: Thumbnail; + isAccessibleForFree: boolean; +} + +export interface ProductReview { + name: string; + price: string; + thumbnail: Thumbnail; + description: string; + offers: Offer[]; + rating: Rating; +} + +export interface Offer { + url: string; + priceCurrency: string; + price: string; +} + +export interface CreativeWork { + name: string; + thumbnail: Thumbnail; + rating: Rating; +} + +export interface MusicRecording { + name: string; + thumbnail: Thumbnail; + rating: Rating; +} + +export interface Review { + type: "review"; + name: string; + thumbnail: Thumbnail; + description: string; + rating: Rating; +} + +export interface Software { + name: string; + author: string; + version: string; + codeRepository: string; + homepage: string; + datePublisher: string; + is_npm: boolean; + is_pypi: boolean; + stars: number; + forks: number; + ProgrammingLanguage: string; +} + +export interface Recipe { + title: string; + description: string; + thumbnail: Thumbnail; + url: string; + domain: string; + favicon: string; + time: string; + prep_time: string; + cook_time: string; + ingredients: string; + instructions: HowTo[]; + servings: number; + calories: number; + rating: Rating; + recipeCategory: string; + recipeCuisine: string; + video: VideoData; +} + +export interface HowTo { + text: string; + name: string; + url: string; + image: string[]; +} + +export interface Organization { + type: "organization"; + name: string; + url: string; + thumbnail: Thumbnail; + contact_points: ContactPoint[]; +} + +export interface ContactPoint { + type: "contact_point"; + telephone: string; + email: string; +} + +export interface Person { + type: "person"; + name: string; + url: string; + thumbnail: Thumbnail; +} + +export interface PostalAddress { + type: "PostalAddress"; + country: string; + postalCode: string; + streetAddress: string; + addressRegion: string; + addressLocality: string; + displayAddress: string; +} + +export interface OpeningHours { + current_day: DayOpeningHours[]; + days: DayOpeningHours[][]; +} + +export interface DayOpeningHours { + abbr_name: string; + full_name: string; + opens: string; + closes: string; +} + +export interface Contact { + email?: string; + telephone?: string; +} + +export interface DataProvider { + type: "external"; + name: string; + url: string; + long_name?: string; + img?: string; +} + +export interface Reviews { + results: TripAdvisorReview[]; + viewMoreUrl: string; + reviews_in_foreign_language: boolean; +} + +export interface TripAdvisorReview { + title: string; + description: string; + date: string; + rating: Rating; + author: Person; + review_url: string; + language: string; +} + +export interface PictureResults { + viewMoreUrl: string; + results: Thumbnail[]; +} + +export interface Action { + type: string; + url: string; +} + +export interface LocationWebResult extends Result { + meta_url: MetaUrl; +} + +export interface SummaryMessage { + type: "token" | "enum_item" | "enum_start" | "enum_end"; + data: SummaryEntity | string; +} + +export interface SummaryEntity { + uuid: string; + name: string; + url: string; + text: string; + images: SummaryImage[]; + highlight: TextLocation[]; +} + +export interface SummaryImage extends Image { + text: string; +} + +export interface SummaryEnrichments { + raw: string; + images: SummaryImage[]; + qa: SummaryAnswer[]; + entities: SummaryEntity[]; + context: SummaryContext[]; +} + +export interface SummaryAnswer { + answer: string; + score: number; + highlight: TextLocation; +} + +export interface SummaryContext { + title: string; + url: string; + meta_url: MetaUrl; +} + +export interface SummaryEntityInfo { + provider: string; + description: string; +} + +export interface TextLocation { + start: number; + end: number; +} + +// Additional types that might be useful + +export interface Language { + main: string; + // Add any other properties related to language if needed +} + +export interface DeepResult { + news?: NewsResult[]; + buttons?: ButtonResult[]; + social?: KnowledgeGraphProfile[]; + videos?: VideoResult[]; + images?: Image[]; +} + +export interface ButtonResult { + type: "button_result"; + title: string; + url: string; +} + +export interface KnowledgeGraphProfile { + title: string; + description: string; + url: string; + thumbnail: string; +} + +export interface Image { + thumbnail: Thumbnail; + url: string; + properties: ImageProperties; +} + +export interface ImageProperties { + url: string; + resized: string; + height: number; + width: number; + format: string; + content_size: string; +} + +// Utility types + +export type Optional = Omit & Partial>; + +export type Nullable = { [K in keyof T]: T[K] | null }; + +// You can add more utility types as needed + +// Enums + +export enum SafeSearchLevel { + Off = "off", + Moderate = "moderate", + Strict = "strict", +} + +export enum FreshnessOption { + PastDay = "pd", + PastWeek = "pw", + PastMonth = "pm", + PastYear = "py", +} + +export enum UnitSystem { + Metric = "metric", + Imperial = "imperial", +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..0f5906c --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,13 @@ +{ + "compilerOptions": { + "target": "es2018", + "module": "commonjs", + "declaration": true, + "outDir": "./dist", + "strict": true, + "esModuleInterop": true + }, + "include": ["src"], + "exclude": ["node_modules", "**/__tests__/*"] +} +