From aafe9e4f0efbd968c2c930c0ec949b6317b2b0dd Mon Sep 17 00:00:00 2001 From: Florian Imdahl Date: Sun, 21 Dec 2025 22:04:39 +0100 Subject: [PATCH 1/4] feat: Add UseResponse API --- README.md | 1 + packages/useresponse/LICENSE | 674 ++++++++++++++++ packages/useresponse/README.md | 38 + packages/useresponse/package.json | 35 + packages/useresponse/src/Endpoints.ts | 217 +++++ packages/useresponse/src/UseResponse.ts | 61 ++ packages/useresponse/src/api/AdditionalAPI.ts | 12 + packages/useresponse/src/api/AuthAPI.ts | 17 + packages/useresponse/src/api/CategoriesAPI.ts | 11 + packages/useresponse/src/api/ChangelogAPI.ts | 11 + packages/useresponse/src/api/ChatsAPI.ts | 11 + packages/useresponse/src/api/CommentsAPI.ts | 11 + .../useresponse/src/api/CustomFieldsAPI.ts | 11 + packages/useresponse/src/api/ModerationAPI.ts | 11 + packages/useresponse/src/api/ObjectsAPI.ts | 11 + packages/useresponse/src/api/ReportsAPI.ts | 11 + packages/useresponse/src/api/UserNotesAPI.ts | 11 + packages/useresponse/src/api/UsersAPI.ts | 11 + packages/useresponse/src/api/index.ts | 12 + packages/useresponse/src/index.ts | 2 + packages/useresponse/src/interfaces/API.ts | 29 + .../src/interfaces/ClientOptions.ts | 4 + .../src/interfaces/UseResponseInterfaces.ts | 763 ++++++++++++++++++ packages/useresponse/src/interfaces/index.ts | 3 + packages/useresponse/tsconfig.build.json | 4 + packages/useresponse/tsconfig.json | 8 + yarn.lock | 12 + 27 files changed, 2002 insertions(+) create mode 100644 packages/useresponse/LICENSE create mode 100644 packages/useresponse/README.md create mode 100644 packages/useresponse/package.json create mode 100644 packages/useresponse/src/Endpoints.ts create mode 100644 packages/useresponse/src/UseResponse.ts create mode 100644 packages/useresponse/src/api/AdditionalAPI.ts create mode 100644 packages/useresponse/src/api/AuthAPI.ts create mode 100644 packages/useresponse/src/api/CategoriesAPI.ts create mode 100644 packages/useresponse/src/api/ChangelogAPI.ts create mode 100644 packages/useresponse/src/api/ChatsAPI.ts create mode 100644 packages/useresponse/src/api/CommentsAPI.ts create mode 100644 packages/useresponse/src/api/CustomFieldsAPI.ts create mode 100644 packages/useresponse/src/api/ModerationAPI.ts create mode 100644 packages/useresponse/src/api/ObjectsAPI.ts create mode 100644 packages/useresponse/src/api/ReportsAPI.ts create mode 100644 packages/useresponse/src/api/UserNotesAPI.ts create mode 100644 packages/useresponse/src/api/UsersAPI.ts create mode 100644 packages/useresponse/src/api/index.ts create mode 100644 packages/useresponse/src/index.ts create mode 100644 packages/useresponse/src/interfaces/API.ts create mode 100644 packages/useresponse/src/interfaces/ClientOptions.ts create mode 100644 packages/useresponse/src/interfaces/UseResponseInterfaces.ts create mode 100644 packages/useresponse/src/interfaces/index.ts create mode 100644 packages/useresponse/tsconfig.build.json create mode 100644 packages/useresponse/tsconfig.json diff --git a/README.md b/README.md index ae932b2b0..5387d133e 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,5 @@ API clients for various services. - [`npms.io`](./packages/npms.io/) [![npm version](https://img.shields.io/npm/v/npms.io.svg)](https://www.npmjs.com/package/npms.io) [![documentation](https://img.shields.io/badge/Documentation-8A2BE2?logo=gitbook)](https://ffflorian.github.io/api-clients/packages/npms.io/) - [`statuspage.io`](./packages/statuspage.io/) [![npm version](https://img.shields.io/npm/v/statuspage.io.svg)](https://www.npmjs.com/package/statuspage.io) [![documentation](https://img.shields.io/badge/Documentation-8A2BE2?logo=gitbook)](https://ffflorian.github.io/api-clients/packages/statuspage.io/) - [`updown.io`](./packages/updown.io/) [![npm version](https://img.shields.io/npm/v/updown.io.svg)](https://www.npmjs.com/package/updown.io) [![documentation](https://img.shields.io/badge/Documentation-8A2BE2?logo=gitbook)](https://ffflorian.github.io/api-clients/packages/updown.io/) +- [`useresponse`](./packages/useresponse/) [![npm version](https://img.shields.io/npm/v/useresponse.svg)](https://www.npmjs.com/package/useresponse) [![documentation](https://img.shields.io/badge/Documentation-8A2BE2?logo=gitbook)](https://ffflorian.github.io/api-clients/packages/useresponse/) - [`xkcdjs`](./packages/xkcdjs/) [![npm version](https://img.shields.io/npm/v/@ffflorian/xkcdjs.svg)](https://www.npmjs.com/package/@ffflorian/xkcdjs) [![documentation](https://img.shields.io/badge/Documentation-8A2BE2?logo=gitbook)](https://ffflorian.github.io/api-clients/packages/xkcdjs/) diff --git a/packages/useresponse/LICENSE b/packages/useresponse/LICENSE new file mode 100644 index 000000000..f288702d2 --- /dev/null +++ b/packages/useresponse/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/packages/useresponse/README.md b/packages/useresponse/README.md new file mode 100644 index 000000000..33a9695fb --- /dev/null +++ b/packages/useresponse/README.md @@ -0,0 +1,38 @@ +# useresponse [![npm version](https://img.shields.io/npm/v/useresponse.svg)](https://www.npmjs.com/package/useresponse) + +A [useresponse](https://useresponse) API client. For a documentation on the API see [https://api.useresponse.com](https://api.useresponse.com). + +### Installation + +Run `yarn add useresponse` or `npm install useresponse`. + +## Usage + +A complete documentation is available at https://ffflorian.github.io/api-clients/packages/useresponse/. + +### Example + +```ts +import {UseResponse} from 'useresponse'; + +const useResponse = new UseResponse(); + +useResponse + .api.search.searchPackage('useresponse') + .then(data => { + ... + }); + +useResponse + .api.search.getSuggestions('useresponse') + .then(data => { + ... + }); +``` + +## Build + +``` +yarn +yarn dist +``` diff --git a/packages/useresponse/package.json b/packages/useresponse/package.json new file mode 100644 index 000000000..76894af42 --- /dev/null +++ b/packages/useresponse/package.json @@ -0,0 +1,35 @@ +{ + "author": "Florian Imdahl ", + "dependencies": { + "@ffflorian/api-client": "2.1.2" + }, + "description": "A useresponse API client", + "devDependencies": { + "@types/node": "~24", + "rimraf": "6.1.2", + "typedoc": "0.28.15", + "typescript": "5.9.3" + }, + "engines": { + "node": ">= 21" + }, + "files": [ + "dist" + ], + "keywords": [ + "api", + "useresponse" + ], + "license": "GPL-3.0", + "main": "dist/index.js", + "name": "useresponse", + "repository": "https://github.com/ffflorian/api-clients/tree/main/packages/useresponse", + "scripts": { + "build:ts": "tsc -p tsconfig.build.json", + "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/useresponse src/index.ts", + "clean": "rimraf dist", + "dist": "yarn clean && yarn build:ts", + "test": "exit 0" + }, + "version": "0.0.1" +} diff --git a/packages/useresponse/src/Endpoints.ts b/packages/useresponse/src/Endpoints.ts new file mode 100644 index 000000000..5993c4953 --- /dev/null +++ b/packages/useresponse/src/Endpoints.ts @@ -0,0 +1,217 @@ +export const Endpoint = { + Auth: { + login(): string { + return '/auth/login.json'; + }, + }, + + Categories: { + listOfCategories(): string { + return '/categories.json'; + }, + + categoryById(id: string): string { + return `/categories/${id}.json`; + }, + }, + + Changelog: { + objects(id: string): string { + return `/changelog/object/${id}.json`; + }, + + users(id: string): string { + return `/changelog/user/${id}.json`; + }, + }, + + Chats: { + chats(): string { + return '/chats.json'; + }, + + chat(id: string): string { + return `/chats/${id}.json`; + }, + + messages(chatId: string): string { + return `/chats/${chatId}/messages.json`; + }, + }, + + Moderation: { + approveComment(commentId: string): string { + return `/comment/${commentId}/approve.json`; + }, + + declineComment(commentId: string): string { + return `/comment/${commentId}/decline.json`; + }, + + approveTopic(topicId: string): string { + return `/topic/${topicId}/approve.json`; + }, + + declineTopic(topicId: string): string { + return `/topic/${topicId}/decline.json`; + }, + }, + + Comments: { + comments(): string { + return '/comments.json'; + }, + + editComment(commentId: string): string { + return `/comment/${commentId}/edit.json`; + }, + + objectComments(objectId: string): string { + return `/objects/${objectId}/comments.json`; + }, + + recoveryComment(commentId: string): string { + return `/comment/${commentId}/recovery.json`; + }, + + trashComment(commentId: string): string { + return `/comment/${commentId}/trash.json`; + }, + + toggleBestComment(commentId: string): string { + return `/comment/${commentId}/best/toggle.json`; + }, + + toggleVoteComment(commentId: string): string { + return `/comment/${commentId}/votes/toggle.json`; + }, + }, + + Additional: { + forums(): string { + return '/forums.json'; + }, + + statuses(): string { + return '/statuses.json'; + }, + }, + + Users: { + activity(userId: string): string { + return `/users/${userId}/activity.json`; + }, + + banUser(userId: string): string { + return `/users/${userId}/ban.json`; + }, + + changePassword(userId: string): string { + return `/users/${userId}/change-password.json`; + }, + + me(): string { + return '/me.json'; + }, + + searchUsers(): string { + return '/users/search.json'; + }, + + updateProfile(): string { + return '/profile/update.json'; + }, + + user(id: string): string { + return `/users/${id}.json`; + }, + + users(id?: string): string { + return '/users.json'; + }, + }, + + Objects: { + archive(id: string): string { + return `/objects/${id}/archive.json`; + }, + + attachFile(id: string): string { + return `/objects/${id}/attach-file.json`; + }, + + commentsToggle(id: string): string { + return `/objects/${id}/comments/toggle.json`; + }, + + object(id: string): string { + return `/objects/${id}.json`; + }, + + objects(): string { + return '/objects.json'; + }, + + search(): string { + return '/objects/search.json'; + }, + + subscribe(id: string): string { + return `/objects/${id}/subscribe.json`; + }, + + tickets(): string { + return '/tickets.json'; + }, + + trash(id: string): string { + return `/objects/${id}/trash.json`; + }, + + unsubscribe(id: string): string { + return `/objects/${id}/unsubscribe.json`; + }, + + toggleVote(id: string): string { + return `/objects/${id}/votes/toggle.json`; + }, + }, + + CustomFields: { + objectCustomFields(objectId: string): string { + return `/objects/${objectId}/custom-fields/list.json`; + }, + + userCustomFields(): string { + return '/users/custom-fields/list.json'; + }, + }, + + Reports: { + reportObjects(reportId: string): string { + return `/report/${reportId}/objects.json`; + }, + + reportsList(): string { + return '/reports/list.json'; + }, + }, + + UserNotes: { + add(userId: string): string { + return `/users/${userId}/notes/add.json`; + }, + + delete(noteId: string): string { + return `/users/notes/${noteId}/delete.json`; + }, + + edit(noteId: string): string { + return `/users/notes/${noteId}/edit.json`; + }, + + notes(userId: string): string { + return `/users/${userId}/notes.json`; + }, + }, +}; diff --git a/packages/useresponse/src/UseResponse.ts b/packages/useresponse/src/UseResponse.ts new file mode 100644 index 000000000..e788fbf60 --- /dev/null +++ b/packages/useresponse/src/UseResponse.ts @@ -0,0 +1,61 @@ +import {APIClient} from '@ffflorian/api-client'; + +import { + AuthAPI, + CategoriesAPI, + ChangelogAPI, + ChatsAPI, + ModerationAPI, + CommentsAPI, + AdditionalAPI, + UsersAPI, + ObjectsAPI, + CustomFieldsAPI, + ReportsAPI, + UserNotesAPI, +} from './api'; +import type {API, ClientOptions} from './interfaces'; + +export class UseResponse { + public readonly api: API; + private readonly apiClient: APIClient; + + constructor(options: ClientOptions) { + this.apiClient = new APIClient(options.apiUrl || 'https://api.useresponse.com/api/7.0'); + + this.api = { + additional: new AdditionalAPI(this.apiClient), + auth: new AuthAPI(this.apiClient), + categories: new CategoriesAPI(this.apiClient), + changelog: new ChangelogAPI(this.apiClient), + chats: new ChatsAPI(this.apiClient), + comments: new CommentsAPI(this.apiClient), + customFields: new CustomFieldsAPI(this.apiClient), + moderation: new ModerationAPI(this.apiClient), + objects: new ObjectsAPI(this.apiClient), + reports: new ReportsAPI(this.apiClient), + userNotes: new UserNotesAPI(this.apiClient), + users: new UsersAPI(this.apiClient), + }; + } + + /** + * Set a new API URL. + * @param newURL The new API url + */ + public setApiUrl(newURL: string): void { + this.apiClient.setBaseURL(newURL); + this.api.additional = new AdditionalAPI(this.apiClient); + this.api.auth = new AuthAPI(this.apiClient); + this.api.categories = new CategoriesAPI(this.apiClient); + this.api.changelog = new ChangelogAPI(this.apiClient); + this.api.chats = new ChatsAPI(this.apiClient); + this.api.comments = new CommentsAPI(this.apiClient); + this.api.customFields = new CustomFieldsAPI(this.apiClient); + this.api.moderation = new ModerationAPI(this.apiClient); + this.api.objects = new ObjectsAPI(this.apiClient); + this.api.reports = new ReportsAPI(this.apiClient); + this.api.userNotes = new UserNotesAPI(this.apiClient); + this.api.users = new UsersAPI(this.apiClient); + } +} diff --git a/packages/useresponse/src/api/AdditionalAPI.ts b/packages/useresponse/src/api/AdditionalAPI.ts new file mode 100644 index 000000000..6e43a1a53 --- /dev/null +++ b/packages/useresponse/src/api/AdditionalAPI.ts @@ -0,0 +1,12 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; +import {LoginData} from '../interfaces'; + +export class AdditionalAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/AuthAPI.ts b/packages/useresponse/src/api/AuthAPI.ts new file mode 100644 index 000000000..397c6ebad --- /dev/null +++ b/packages/useresponse/src/api/AuthAPI.ts @@ -0,0 +1,17 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; +import {LoginData} from '../interfaces'; + +export class AuthAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } + + login(loginData: LoginData) { + const endpoint = Endpoint.Auth.login(); + return this.apiClient.post<{token: string}>(endpoint); + } +} diff --git a/packages/useresponse/src/api/CategoriesAPI.ts b/packages/useresponse/src/api/CategoriesAPI.ts new file mode 100644 index 000000000..4a0b9a7e1 --- /dev/null +++ b/packages/useresponse/src/api/CategoriesAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class CategoriesAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/ChangelogAPI.ts b/packages/useresponse/src/api/ChangelogAPI.ts new file mode 100644 index 000000000..006b97231 --- /dev/null +++ b/packages/useresponse/src/api/ChangelogAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class ChangelogAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/ChatsAPI.ts b/packages/useresponse/src/api/ChatsAPI.ts new file mode 100644 index 000000000..71fde9356 --- /dev/null +++ b/packages/useresponse/src/api/ChatsAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class ChatsAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/CommentsAPI.ts b/packages/useresponse/src/api/CommentsAPI.ts new file mode 100644 index 000000000..971bb7508 --- /dev/null +++ b/packages/useresponse/src/api/CommentsAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class CommentsAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/CustomFieldsAPI.ts b/packages/useresponse/src/api/CustomFieldsAPI.ts new file mode 100644 index 000000000..7cebfbe25 --- /dev/null +++ b/packages/useresponse/src/api/CustomFieldsAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class CustomFieldsAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/ModerationAPI.ts b/packages/useresponse/src/api/ModerationAPI.ts new file mode 100644 index 000000000..f706d5268 --- /dev/null +++ b/packages/useresponse/src/api/ModerationAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class ModerationAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/ObjectsAPI.ts b/packages/useresponse/src/api/ObjectsAPI.ts new file mode 100644 index 000000000..b73fb1c08 --- /dev/null +++ b/packages/useresponse/src/api/ObjectsAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class ObjectsAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/ReportsAPI.ts b/packages/useresponse/src/api/ReportsAPI.ts new file mode 100644 index 000000000..b1e92f6ae --- /dev/null +++ b/packages/useresponse/src/api/ReportsAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class ReportsAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/UserNotesAPI.ts b/packages/useresponse/src/api/UserNotesAPI.ts new file mode 100644 index 000000000..0175597c8 --- /dev/null +++ b/packages/useresponse/src/api/UserNotesAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class UserNotesAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/UsersAPI.ts b/packages/useresponse/src/api/UsersAPI.ts new file mode 100644 index 000000000..02277e243 --- /dev/null +++ b/packages/useresponse/src/api/UsersAPI.ts @@ -0,0 +1,11 @@ +import type {APIClient} from '@ffflorian/api-client'; + +import {Endpoint} from '../Endpoints'; + +export class UsersAPI { + private readonly apiClient: APIClient; + + constructor(apiClient: APIClient) { + this.apiClient = apiClient; + } +} diff --git a/packages/useresponse/src/api/index.ts b/packages/useresponse/src/api/index.ts new file mode 100644 index 000000000..f090324a7 --- /dev/null +++ b/packages/useresponse/src/api/index.ts @@ -0,0 +1,12 @@ +export * from './AdditionalAPI'; +export * from './AuthAPI'; +export * from './CategoriesAPI'; +export * from './ChangelogAPI'; +export * from './ChatsAPI'; +export * from './CommentsAPI'; +export * from './CustomFieldsAPI'; +export * from './ModerationAPI'; +export * from './ObjectsAPI'; +export * from './ReportsAPI'; +export * from './UserNotesAPI'; +export * from './UsersAPI'; diff --git a/packages/useresponse/src/index.ts b/packages/useresponse/src/index.ts new file mode 100644 index 000000000..617c0fa68 --- /dev/null +++ b/packages/useresponse/src/index.ts @@ -0,0 +1,2 @@ +export * from './UseResponse'; +export * from './interfaces/'; diff --git a/packages/useresponse/src/interfaces/API.ts b/packages/useresponse/src/interfaces/API.ts new file mode 100644 index 000000000..974f6fd36 --- /dev/null +++ b/packages/useresponse/src/interfaces/API.ts @@ -0,0 +1,29 @@ +import { + AdditionalAPI, + AuthAPI, + CategoriesAPI, + ChangelogAPI, + ChatsAPI, + CommentsAPI, + CustomFieldsAPI, + ModerationAPI, + ObjectsAPI, + ReportsAPI, + UserNotesAPI, + UsersAPI, +} from '../api/'; + +export interface API { + additional: AdditionalAPI; + auth: AuthAPI; + categories: CategoriesAPI; + changelog: ChangelogAPI; + chats: ChatsAPI; + comments: CommentsAPI; + customFields: CustomFieldsAPI; + moderation: ModerationAPI; + objects: ObjectsAPI; + reports: ReportsAPI; + userNotes: UserNotesAPI; + users: UsersAPI; +} diff --git a/packages/useresponse/src/interfaces/ClientOptions.ts b/packages/useresponse/src/interfaces/ClientOptions.ts new file mode 100644 index 000000000..b89989e79 --- /dev/null +++ b/packages/useresponse/src/interfaces/ClientOptions.ts @@ -0,0 +1,4 @@ +export interface ClientOptions { + apiKey: string; + apiUrl?: string; +} diff --git a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts new file mode 100644 index 000000000..de685d828 --- /dev/null +++ b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts @@ -0,0 +1,763 @@ +interface AttachmentName { + ext?: string; + full?: string; + short?: string; +} + +export interface Attachment { + directUrl?: string; + icon?: string; + id?: number; + name?: AttachmentName; + url?: string; +} + +export interface BanUserParams { + /** + * @description Duration of the ban in days (ignored if permanent) + * @example 30 + */ + ban_duration_days?: number; + /** + * @description Reason for banning the user + * @example Fraudulent activity detected + */ + ban_reason?: string; + /** + * @description Whether to delete user's related objects (tickets, comments, etc.) + * @example true + */ + delete_related_objects?: boolean; + /** + * @description If true, the ban is permanent + * @example false + */ + permanent?: boolean; +} + +export interface BanUserResponse { + success?: User; +} + +export interface Category { + description?: unknown; + forum?: Forum; + id?: number; + image?: { + big?: string; + medium?: string; + small?: string; + }; + isPrivate?: boolean; + name?: string; + order?: number; + ownership?: unknown; + parent_id?: number; + slug?: string; + type?: unknown; +} + +export interface LoginData { + password: string; + username: string; +} + +export interface ChangePasswordParams { + /** + * @description New valid “email” value + * @example securestring12345 + */ + password: string; +} + +export interface ChangelogAction { + change_id?: string; + field?: string; + previous?: string; + value?: string; +} + +export interface Chat { + author?: User; + completedAt?: string; + completedAtPosix?: number; + createdAt?: string; + createdAtPosix?: number; + externalId?: number; + id?: number; + lastMessage?: Message; + responsible?: User; + score?: number; + seenByClient?: boolean; + source?: string; + title?: string; + token?: string; + updatedAt?: string; + updatedAtPosix?: number; +} + +export interface ChatMessagesPaginator { + success?: ChatMessagesPaginator; +} + +export interface ChatsPaginator { + currentPage?: number; + data?: Chat[]; + firstPage?: number; + lastPage?: number; + nextPage?: number; + objectsPerPage?: number; + totalObjects?: number; + totalPages?: number; +} + +export interface ChatsResponse { + success?: ChatsPaginator; +} + +export interface Comment { + attachments?: Attachment[]; + author?: User; + content?: string; + createdAgo?: string; + createdAt?: string; + createdAtPosix?: number; + id?: number; + is_best?: number; + objectId?: number; + ownership?: string; + replyToId?: number; + updatedAt?: string; + votes?: Vote; +} + +export interface CommentAddParams { + /** + * @description The content of a new object. + * Supports BBcode, but HTML tags are not allowed + * ##### Max content length: 12000 chars + * @example My first comment + */ + content: string; + /** + * @description If 1 specified, comment will be saved as private note. To add private note you should have agent’s or admin’s privileges + * ##### Valid values: 0, 1 + * @example 0 + */ + is_private?: number; + /** + * @description Valid object(ticket/topic) id + * @example 38 + */ + object_id?: number; + /** + * @description Valid comment id to make reply to comment + * @example 10 + */ + reply_to?: number; + /** + * @description API would accept “content” parameter in HTML format. Overrides “Accept HTML Content” global setting for one request + * ##### Valid values: 0, 1 + * @example 0 + */ + treat_as_html?: number; +} + +export interface CommentEditParams { + /** + * @description The content of a new object. + * Supports BBcode, but HTML tags are not allowed + * ##### Max content length: 12000 chars + * @example My first comment + */ + content?: string; + /** + * @description API would accept “content” parameter in HTML format. Overrides “Accept HTML Content” global setting for one request + * ##### Valid values: 0, 1 + * @example 0 + */ + treat_as_html?: number; +} + +export interface CommentModerateResponse { + success?: Comment; +} + +export interface CreateUserParams { + /** + * @description New valid “email” value + * @example test@test.com + */ + email: string; + /** + * @description Not empty string containing user’s name + * @example John Edwards + */ + full_name: string; + /** + * @description User’s password + * @example securestring12345 + */ + password?: string; + /** + * @description Specify the name for the custom field + * @example Support + */ + property_1?: string; + tags?: string; + /** + * @description Valid team numeric identifier + * @example 1 + */ + team_id?: number; +} + +export interface CustomField { + description?: unknown; + field_type?: string; + id?: number; + is_active?: number; + is_private?: number; + is_required?: number; + label?: string; + module?: string; + name?: string; + options?: Record; + type?: string; +} + +export interface CustomFieldValue { + id?: number; + label?: string; + name?: string; + textValue?: unknown[]; + value?: unknown[]; +} + +export interface DeclineParams { + /** + * @description In case a comment or topic is declined you can specify decline reason + * @example Too little information provided + */ + reason?: string; +} + +export interface EditUserParams { + /** + * @description New valid “email” value. + * @example test@test.com + */ + email?: string; + /** + * @description Not empty string containing user’s name. + * @example John Edwards + */ + full_name?: string; + /** + * @description User phone number. + * @example +447777444445 + */ + phone?: string; + /** + * @description Specify the name for the custom field + * @example Support + */ + property_1?: string; + tags?: string; + /** + * @description Valid team numeric identifier + * @example 1 + */ + team_id?: number; +} + +export interface Forum { + id?: string; + name?: string; +} + +export interface GetChatResponse { + success?: Chat; +} + +export interface LoginParams { + /** @example support@useresponse.com */ + email: string; + /** @example 123456 */ + password: string; +} + +export interface ManageUserNoteParams { + /** + * @description The content of a new comment. + * Supports BBcode, but HTML tags are not allowed + * ##### Max content length: 12000 chars + * @example My first note + */ + content: string; + /** + * @description Not empty string containing user’s name + * @example 2017-10-13 18:29:00 + */ + remind_at?: string; +} + +export interface Message { + author?: User; + content?: string; + createdAtPosix?: number; + fileName?: string; + id?: number; + isSystem?: boolean; + parentId?: number; + token?: string; + type?: string; +} + +interface Link { + object_id?: string; + title?: string; + type?: string; + url?: string; +} + +interface Team { + id?: number; + name?: string; +} + +interface Votes { + all?: number; + canVote?: boolean; + isVoted?: boolean; + negative?: number; + plural?: string; + positive?: number; +} + +export interface Object { + attachments?: Attachment[]; + author?: User; + bestComment?: Comment; + canBeCommented?: boolean; + category?: Category; + commentedAt?: string; + commentsNum?: number; + completedBy?: User; + completedOn?: string; + content?: string; + createdAt?: string; + createdAtPosix?: number; + custom_fields?: CustomFieldValue[]; + forum?: Forum; + id?: number; + isAbused?: boolean; + isFeatured?: boolean; + isPrivate?: boolean; + isSubscribed?: number; + language?: string; + latestActivityPosix?: number; + links?: Link[]; + ownership?: string; + parentObject?: unknown; + recipients?: string[]; + responsible?: User; + score?: number; + scoreComment?: string; + scoreReason?: string; + slaDatePosix?: number; + slug?: string; + source?: Source; + state?: State; + status?: Status; + tags?: string[]; + team?: Team; + title?: string; + type?: ObjectType; + url?: string; + views?: number; + votes?: Votes; +} + +interface NewAttachment { + /** + * @description Should be in base64 format + * @example iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAA.....== + */ + body?: string; + /** @example call.png */ + name?: string; +} + +export interface ObjectAddParams { + /** @description Array of attachments */ + attachments?: NewAttachment[]; + /** + * @description Valid category id to assign new object to + * Value 0 means no category + * @example 0 + */ + category_id?: number; + /** + * @description The content of a new object. + * Supports BBcode, but HTML tags are not allowed + * ##### Max content length: 12000 chars + * ##### Required for feedback, announcements + * @example Here is the sense of my problem + */ + content?: string; + /** + * @description Allows to use object expiration date + * Value never means that announcement has no expiration date + * ##### Valid only for announcements. Valid values: never, on_date + * @example never + */ + expire_select?: string; + /** + * @description Valid only for announcements and date should be in format dd.mm.yyyy + * ##### required when expire_select parameter value is set to on_date + * @example 15.06.2020 + */ + expires_at?: string; + /** + * @description Allows to set object author manually + * Requires appropriate privilege + * Valid user id or any email address + * @example support@useresponse.com + */ + force_author?: string; + /** + * @description Allows to define object privacy + * ##### Only for feedback and announcements + * ##### Valid values: 0, 1 + * @example 0 + */ + is_private?: number; + /** + * @description Valid object type + * @example ticket + * @enum {string} + */ + object_type: 'ticket' | 'idea' | 'problem' | 'question'; + /** + * @description Object belongs to a logical group + * @example helpdesk + * @enum {string} + */ + ownership: 'feedback' | 'helpdesk'; + /** + * @description Specify the name for the custom field + * @example Support + */ + property_1?: string; + /** + * @description Valid agent or administrator user id + * Value 0 means nobody + * @example 10 + */ + responsible_id?: number; + /** @description Array of tags */ + tags?: string[]; + /** + * @description Valid team numeric identifier + * @example 5 + */ + team_id?: number; + /** + * @description The title of a new object + * ##### Max title length: 100 chars + * @example My first helpdesk record + */ + title: string; +} + +export interface ObjectEditParams { + /** @description Array of attachments */ + attachments?: NewAttachment[]; + /** + * @description Valid category id to assign new object to + * Value 0 means no category + * @example 0 + */ + category_id?: number; + /** + * @description The content of a new object. + * Supports BBcode, but HTML tags are not allowed + * ##### Max content length: 12000 chars + * ##### Required for feedback, announcements + * @example Here is the sense of my problem + */ + content?: string; + /** + * @description Allows to use object expiration date + * Value never means that announcement has no expiration date + * ##### Valid only for announcements. Valid values: never, on_date + * @example never + */ + expire_select?: string; + /** + * @description Valid only for announcements and date should be in format dd.mm.yyyy + * ##### required when expire_select parameter value is set to on_date + * @example 15.06.2020 + */ + expires_at?: string; + /** + * @description Allows to set object author manually + * Requires appropriate privilege + * Valid user id or any email address + * @example support@useresponse.com + */ + force_author?: string; + /** + * @description Allows to define object privacy + * ##### Only for feedback and announcements + * ##### Valid values: 0, 1 + * @example 0 + */ + is_private?: number; + /** + * @description Valid object type + * @example ticket + */ + object_type?: string; + /** + * @description Specify the name for the custom field + * @example Support + */ + property_1?: string; + /** + * @description Valid agent or administrator user id + * Value 0 means nobody + * @example 10 + */ + responsible_id?: number; + /** + * @description Valid status id. Id can be taken from statuses.json + * @example 1 + */ + status_id?: number; + /** @description Array of tags */ + tags?: string[]; + /** + * @description Valid team numeric identifier + * @example 5 + */ + team_id?: number; + /** + * @description The title of a new object + * ##### Max title length: 100 chars + * @example My first helpdesk record + */ + title?: string; +} + +export interface ObjectType { + icon?: { + big?: string; + small?: string; + }; + order?: number; + slug?: string; + supports?: { + comments?: boolean; + negativeVote?: boolean; + votes?: boolean; + }; + title?: { + plural?: string; + single?: string; + }; +} + +export interface Paginator { + currentPage?: number; + data?: Object[]; + firstPage?: number; + lastPage?: number; + nextPage?: number; + objectsPerPage?: number; + totalObjects?: number; + totalPages?: number; +} + +export interface Report { + /** @default 4 */ + id: number; + /** @default Inbox */ + name: string; +} + +export interface ReportPaginator { + activeGroup?: string; + currentPage?: number; + data?: Object[]; + firstPage?: number; + groups?: ReportGroup[]; + lastPage?: number; + nextPage?: number; + objectsPerPage?: number; + totalObjects?: number; + totalPages?: number; +} + +export interface SearchResponse { + success?: Paginator; +} + +export interface Source { + identifier?: string; + name?: string; +} + +export interface State { + identifier?: number; + name?: string; +} + +export interface Status { + color?: { + background?: string; + text?: string; + }; + id?: number; + isClosed?: boolean; + isDefault?: boolean; + isSystem?: boolean; + order?: number; + ownership?: string; + slug?: string; + title?: string; + type?: string; +} + +export interface TopicModerateResponse { + success?: Object; +} + +export interface Avatar { + big?: string; + medium?: string; + small?: string; + tiny?: string; +} + +export interface User { + apiKey?: string; + avatar?: Avatar; + custom_fields?: CustomFieldValue[]; + gravatarEmail?: unknown; + id?: number; + isDefaultAvatar?: boolean; + lastVisitAt?: string; + name?: string; + profileUrl?: string; + registrationDate?: string; + role?: { + alias?: string; + id?: number; + }; + shortName?: string; + tags?: string; + team?: { + id?: number; + name?: string; + }; +} + +export interface UserNote { + author?: User; + content?: string; + createdAgo?: string; + createdAt?: string; + createdAtPosix?: number; + id?: number; + updatedAt?: string; +} + +export interface UsersActivityResponse { + currentPage?: number; + data?: Object[]; + firstPage?: number; + lastPage?: number; + nextPage?: number; + objectsPerPage?: number; + totalObjects?: number; + totalPages?: number; +} + +export interface UsersSearchResponse { + currentPage?: number; + data?: User[]; + firstPage?: number; + lastPage?: number; + nextPage?: number; + objectsPerPage?: number; + totalObjects?: number; + totalPages?: number; +} + +export interface Vote { + amount?: number; + canVote?: boolean; + isVoted?: boolean; + plural?: string; +} + +export interface CommentActionResponse { + success?: Comment; +} + +export interface CommentsListResponse { + success?: Comment[]; +} + +export interface CreateObjectResponse { + success?: Object; +} + +export interface EditObjectResponse { + success?: Object; +} + +export interface ErrorInvalidParamsResponse { + error?: { + /** @default 400 */ + code: number; + /** @default ownership or/and object_type parameters are missed */ + context: string; + /** @default Invalid request and/or request parameters */ + message: string; + }; +} + +export interface ErrorNotFoundResponse { + error?: { + /** @default 404 */ + code: number; + /** @default Resource is not found */ + message: string; + }; +} + +export interface ErrorUnauthorizedResponse { + error?: { + /** @default 401 */ + code: number; + /** @default Authentication is required */ + message: string; + }; +} + +export interface ReportGroup { + count?: number; + id?: string; + name?: string; +} + +export interface UserActionResponse { + success?: User; +} + +export interface UserNotesResponse { + success?: UserNote[]; +} diff --git a/packages/useresponse/src/interfaces/index.ts b/packages/useresponse/src/interfaces/index.ts new file mode 100644 index 000000000..8afb023fb --- /dev/null +++ b/packages/useresponse/src/interfaces/index.ts @@ -0,0 +1,3 @@ +export * from './API'; +export * from './ClientOptions'; +export * from './UseResponseInterfaces'; diff --git a/packages/useresponse/tsconfig.build.json b/packages/useresponse/tsconfig.build.json new file mode 100644 index 000000000..82a9bcf3f --- /dev/null +++ b/packages/useresponse/tsconfig.build.json @@ -0,0 +1,4 @@ +{ + "exclude": ["dist", "node_modules", "**/*.test.ts"], + "extends": "./tsconfig.json" +} diff --git a/packages/useresponse/tsconfig.json b/packages/useresponse/tsconfig.json new file mode 100644 index 000000000..21ac8ab2d --- /dev/null +++ b/packages/useresponse/tsconfig.json @@ -0,0 +1,8 @@ +{ + "compilerOptions": { + "outDir": "dist", + "rootDir": "src" + }, + "exclude": ["dist", "node_modules"], + "extends": "../../tsconfig.json" +} diff --git a/yarn.lock b/yarn.lock index 6424a3a8b..ddb0b609e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -11111,6 +11111,18 @@ __metadata: languageName: unknown linkType: soft +"useresponse@workspace:packages/useresponse": + version: 0.0.0-use.local + resolution: "useresponse@workspace:packages/useresponse" + dependencies: + "@ffflorian/api-client": "npm:2.1.2" + "@types/node": "npm:~24" + rimraf: "npm:6.1.2" + typedoc: "npm:0.28.15" + typescript: "npm:5.9.3" + languageName: unknown + linkType: soft + "util-deprecate@npm:^1.0.1, util-deprecate@npm:^1.0.2, util-deprecate@npm:~1.0.1": version: 1.0.2 resolution: "util-deprecate@npm:1.0.2" From 75157e9e1f652538ad3b9d9329bbd3fd97fa8ca7 Mon Sep 17 00:00:00 2001 From: Florian Imdahl Date: Tue, 23 Dec 2025 21:20:25 +0100 Subject: [PATCH 2/4] feat: Add Auth and Categories --- packages/absence.io/package.json | 2 +- packages/absence.io/src/AbsenceIO.ts | 4 +-- packages/bamboohr.com/package.json | 2 +- packages/c3nav/package.json | 2 +- packages/corona-warn-app/package.json | 2 +- packages/crates.io/package.json | 2 +- packages/icanhazdadjoke/package.json | 2 +- packages/imgflip.com/package.json | 2 +- packages/libraries.io/package.json | 2 +- packages/libraries.io/src/LibrariesIO.ts | 2 +- packages/npms.io/package.json | 2 +- packages/statuspage.io/package.json | 2 +- packages/updown.io/package.json | 2 +- packages/useresponse/package.json | 2 +- packages/useresponse/src/Endpoints.ts | 2 +- packages/useresponse/src/UseResponse.ts | 7 ++++ packages/useresponse/src/api/AuthAPI.ts | 7 ++-- packages/useresponse/src/api/CategoriesAPI.ts | 18 ++++++++++ .../src/interfaces/ClientOptions.ts | 2 +- .../src/interfaces/UseResponseInterfaces.ts | 8 ++--- packages/xkcdjs/package.json | 2 +- yarn.lock | 34 +++++++++---------- 22 files changed, 68 insertions(+), 42 deletions(-) diff --git a/packages/absence.io/package.json b/packages/absence.io/package.json index 33c65ba9d..cfa8fd522 100644 --- a/packages/absence.io/package.json +++ b/packages/absence.io/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2", + "@ffflorian/api-client": "2.2.0", "@hapi/hawk": "8.0.0" }, "description": "An absence.io API client", diff --git a/packages/absence.io/src/AbsenceIO.ts b/packages/absence.io/src/AbsenceIO.ts index 97962898c..b4613ad25 100644 --- a/packages/absence.io/src/AbsenceIO.ts +++ b/packages/absence.io/src/AbsenceIO.ts @@ -30,8 +30,8 @@ export class AbsenceIO { this.apiClient = new APIClient(baseURL); - this.apiClient.interceptors.request.push((url, config) => { - const hawkHeader = hawk.client.header(url.toString(), config.method, {credentials}); + this.apiClient.interceptors.request.push((config) => { + const hawkHeader = hawk.client.header(config.url.toString(), config.method, {credentials}); config.headers = {...config.headers, Authorization: hawkHeader.header}; return config; }); diff --git a/packages/bamboohr.com/package.json b/packages/bamboohr.com/package.json index 2dcf7f0de..c093a8d00 100644 --- a/packages/bamboohr.com/package.json +++ b/packages/bamboohr.com/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2", + "@ffflorian/api-client": "2.2.0", "@hapi/hawk": "8.0.0" }, "description": "An bamboohr.com API client", diff --git a/packages/c3nav/package.json b/packages/c3nav/package.json index f472bd947..99c314ec6 100644 --- a/packages/c3nav/package.json +++ b/packages/c3nav/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A c3nav API client", "devDependencies": { diff --git a/packages/corona-warn-app/package.json b/packages/corona-warn-app/package.json index ce6093e24..3d1276f75 100644 --- a/packages/corona-warn-app/package.json +++ b/packages/corona-warn-app/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A corona-warn-app API client", "devDependencies": { diff --git a/packages/crates.io/package.json b/packages/crates.io/package.json index f0cd7efeb..81f959a08 100644 --- a/packages/crates.io/package.json +++ b/packages/crates.io/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A crates.io API client", "devDependencies": { diff --git a/packages/icanhazdadjoke/package.json b/packages/icanhazdadjoke/package.json index a1bf33ac3..f703f83fd 100644 --- a/packages/icanhazdadjoke/package.json +++ b/packages/icanhazdadjoke/package.json @@ -2,7 +2,7 @@ "author": "Florian Imdahl ", "bin": "dist/cli.js", "dependencies": { - "@ffflorian/api-client": "2.1.2", + "@ffflorian/api-client": "2.2.0", "commander": "14.0.2" }, "description": "An icanhazdadjoke.com API client with a CLI.", diff --git a/packages/imgflip.com/package.json b/packages/imgflip.com/package.json index 739262c4d..e495ca0ac 100644 --- a/packages/imgflip.com/package.json +++ b/packages/imgflip.com/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2", + "@ffflorian/api-client": "2.2.0", "qs": "6.14.0" }, "description": "A imgflip.com API client", diff --git a/packages/libraries.io/package.json b/packages/libraries.io/package.json index d9f38e73d..c18136476 100644 --- a/packages/libraries.io/package.json +++ b/packages/libraries.io/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A libraries.io API client", "devDependencies": { diff --git a/packages/libraries.io/src/LibrariesIO.ts b/packages/libraries.io/src/LibrariesIO.ts index ddcfd1802..752d8d02f 100644 --- a/packages/libraries.io/src/LibrariesIO.ts +++ b/packages/libraries.io/src/LibrariesIO.ts @@ -22,7 +22,7 @@ export class LibrariesIO { this.apiClient = new APIClient(this.options.apiUrl); - this.apiClient.interceptors.request.push((_url, options) => { + this.apiClient.interceptors.request.push(options => { if (options.body) { const body = JSON.parse(options.body.toString()); body.api_key = this.options.apiKey; diff --git a/packages/npms.io/package.json b/packages/npms.io/package.json index bd7dd1e44..4987698f3 100644 --- a/packages/npms.io/package.json +++ b/packages/npms.io/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A npms.io API client", "devDependencies": { diff --git a/packages/statuspage.io/package.json b/packages/statuspage.io/package.json index 9a9c25984..ab79ef236 100644 --- a/packages/statuspage.io/package.json +++ b/packages/statuspage.io/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A statuspage.io API client", "devDependencies": { diff --git a/packages/updown.io/package.json b/packages/updown.io/package.json index 8e06e224d..dff485c24 100644 --- a/packages/updown.io/package.json +++ b/packages/updown.io/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "An updown.io API client", "devDependencies": { diff --git a/packages/useresponse/package.json b/packages/useresponse/package.json index 76894af42..2eb678617 100644 --- a/packages/useresponse/package.json +++ b/packages/useresponse/package.json @@ -1,7 +1,7 @@ { "author": "Florian Imdahl ", "dependencies": { - "@ffflorian/api-client": "2.1.2" + "@ffflorian/api-client": "2.2.0" }, "description": "A useresponse API client", "devDependencies": { diff --git a/packages/useresponse/src/Endpoints.ts b/packages/useresponse/src/Endpoints.ts index 5993c4953..093b7496c 100644 --- a/packages/useresponse/src/Endpoints.ts +++ b/packages/useresponse/src/Endpoints.ts @@ -126,7 +126,7 @@ export const Endpoint = { return `/users/${id}.json`; }, - users(id?: string): string { + users(): string { return '/users.json'; }, }, diff --git a/packages/useresponse/src/UseResponse.ts b/packages/useresponse/src/UseResponse.ts index e788fbf60..c5957d7f1 100644 --- a/packages/useresponse/src/UseResponse.ts +++ b/packages/useresponse/src/UseResponse.ts @@ -23,6 +23,13 @@ export class UseResponse { constructor(options: ClientOptions) { this.apiClient = new APIClient(options.apiUrl || 'https://api.useresponse.com/api/7.0'); + this.apiClient.interceptors.request.push(config => { + if (options.apiKey) { + config.url.searchParams.set('api_key', options.apiKey); + } + return config; + }); + this.api = { additional: new AdditionalAPI(this.apiClient), auth: new AuthAPI(this.apiClient), diff --git a/packages/useresponse/src/api/AuthAPI.ts b/packages/useresponse/src/api/AuthAPI.ts index 397c6ebad..2d5b15b50 100644 --- a/packages/useresponse/src/api/AuthAPI.ts +++ b/packages/useresponse/src/api/AuthAPI.ts @@ -1,7 +1,7 @@ import type {APIClient} from '@ffflorian/api-client'; import {Endpoint} from '../Endpoints'; -import {LoginData} from '../interfaces'; +import {LoginData, User} from '../interfaces'; export class AuthAPI { private readonly apiClient: APIClient; @@ -10,8 +10,9 @@ export class AuthAPI { this.apiClient = apiClient; } - login(loginData: LoginData) { + async login(loginData: LoginData): Promise { const endpoint = Endpoint.Auth.login(); - return this.apiClient.post<{token: string}>(endpoint); + const {data} = await this.apiClient.post(endpoint, loginData); + return data; } } diff --git a/packages/useresponse/src/api/CategoriesAPI.ts b/packages/useresponse/src/api/CategoriesAPI.ts index 4a0b9a7e1..23ed0d529 100644 --- a/packages/useresponse/src/api/CategoriesAPI.ts +++ b/packages/useresponse/src/api/CategoriesAPI.ts @@ -1,6 +1,12 @@ import type {APIClient} from '@ffflorian/api-client'; import {Endpoint} from '../Endpoints'; +import {Category} from '../interfaces'; + +interface GetListOptions { + ownership?: string; + type?: string; +} export class CategoriesAPI { private readonly apiClient: APIClient; @@ -8,4 +14,16 @@ export class CategoriesAPI { constructor(apiClient: APIClient) { this.apiClient = apiClient; } + + async getCategory(categoryId: string): Promise { + const endpoint = Endpoint.Categories.categoryById(categoryId); + const {data} = await this.apiClient.get(endpoint); + return data; + } + + async getList(options: GetListOptions): Promise { + const endpoint = Endpoint.Categories.listOfCategories(); + const {data} = await this.apiClient.get(endpoint, {params: options}); + return data; + } } diff --git a/packages/useresponse/src/interfaces/ClientOptions.ts b/packages/useresponse/src/interfaces/ClientOptions.ts index b89989e79..78f2e0f5b 100644 --- a/packages/useresponse/src/interfaces/ClientOptions.ts +++ b/packages/useresponse/src/interfaces/ClientOptions.ts @@ -1,4 +1,4 @@ export interface ClientOptions { - apiKey: string; + apiKey?: string; apiUrl?: string; } diff --git a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts index de685d828..8dad10fdd 100644 --- a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts +++ b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts @@ -40,7 +40,7 @@ export interface BanUserResponse { } export interface Category { - description?: unknown; + description?: null | string; forum?: Forum; id?: number; image?: { @@ -51,10 +51,10 @@ export interface Category { isPrivate?: boolean; name?: string; order?: number; - ownership?: unknown; + ownership?: null | string; parent_id?: number; slug?: string; - type?: unknown; + type?: null | unknown; } export interface LoginData { @@ -645,7 +645,7 @@ export interface User { apiKey?: string; avatar?: Avatar; custom_fields?: CustomFieldValue[]; - gravatarEmail?: unknown; + gravatarEmail?: string | null; id?: number; isDefaultAvatar?: boolean; lastVisitAt?: string; diff --git a/packages/xkcdjs/package.json b/packages/xkcdjs/package.json index 019a8412f..d2097490e 100644 --- a/packages/xkcdjs/package.json +++ b/packages/xkcdjs/package.json @@ -2,7 +2,7 @@ "author": "Florian Imdahl ", "bin": "dist/cli.js", "dependencies": { - "@ffflorian/api-client": "2.1.2", + "@ffflorian/api-client": "2.2.0", "commander": "14.0.2" }, "description": "An xkcd API client with a CLI.", diff --git a/yarn.lock b/yarn.lock index ddb0b609e..1056a6aa0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -654,10 +654,10 @@ __metadata: languageName: node linkType: hard -"@ffflorian/api-client@npm:2.1.2": - version: 2.1.2 - resolution: "@ffflorian/api-client@npm:2.1.2" - checksum: 10c0/16467e2aa3645d1ac2903a9b3b7d2a91cdc5cdda7da8a5401be03a3a473386dc5a0e36f7e27c28c5ed708e3951a5f64b93d843385381d74b7f1cf6ad633e988a +"@ffflorian/api-client@npm:2.2.0": + version: 2.2.0 + resolution: "@ffflorian/api-client@npm:2.2.0" + checksum: 10c0/70e868fb4ed211ce60bfc5eb2ab27a345cf9562b20d330d132732bfc16248d6040207aa3fa5b773ffe5d58d4a6d58abce0851b89b49c6d2b9ad2f27d99c8d9b1 languageName: node linkType: hard @@ -687,7 +687,7 @@ __metadata: version: 0.0.0-use.local resolution: "@ffflorian/icanhazdadjoke@workspace:packages/icanhazdadjoke" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" commander: "npm:14.0.2" rimraf: "npm:6.1.2" @@ -712,7 +712,7 @@ __metadata: version: 0.0.0-use.local resolution: "@ffflorian/xkcdjs@workspace:packages/xkcdjs" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" commander: "npm:14.0.2" http-status-codes: "npm:2.3.0" @@ -3120,7 +3120,7 @@ __metadata: version: 0.0.0-use.local resolution: "absence.io@workspace:packages/absence.io" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@hapi/hawk": "npm:8.0.0" "@types/hapi__hawk": "npm:8.0.7" "@types/node": "npm:~24" @@ -3515,7 +3515,7 @@ __metadata: version: 0.0.0-use.local resolution: "bamboohr.com@workspace:packages/bamboohr.com" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@hapi/hawk": "npm:8.0.0" "@types/hapi__hawk": "npm:8.0.7" "@types/node": "npm:~24" @@ -3619,7 +3619,7 @@ __metadata: version: 0.0.0-use.local resolution: "c3nav@workspace:packages/c3nav" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -4158,7 +4158,7 @@ __metadata: version: 0.0.0-use.local resolution: "corona-warn-app@workspace:packages/corona-warn-app" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -4187,7 +4187,7 @@ __metadata: version: 0.0.0-use.local resolution: "crates.io@workspace:packages/crates.io" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -6448,7 +6448,7 @@ __metadata: version: 0.0.0-use.local resolution: "imgflip.com@workspace:packages/imgflip.com" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" "@types/qs": "npm:6.14.0" qs: "npm:6.14.0" @@ -7491,7 +7491,7 @@ __metadata: version: 0.0.0-use.local resolution: "libraries.io@workspace:packages/libraries.io" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -8392,7 +8392,7 @@ __metadata: version: 0.0.0-use.local resolution: "npms.io@workspace:packages/npms.io" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -10263,7 +10263,7 @@ __metadata: version: 0.0.0-use.local resolution: "statuspage.io@workspace:packages/statuspage.io" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -11103,7 +11103,7 @@ __metadata: version: 0.0.0-use.local resolution: "updown.io@workspace:packages/updown.io" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" @@ -11115,7 +11115,7 @@ __metadata: version: 0.0.0-use.local resolution: "useresponse@workspace:packages/useresponse" dependencies: - "@ffflorian/api-client": "npm:2.1.2" + "@ffflorian/api-client": "npm:2.2.0" "@types/node": "npm:~24" rimraf: "npm:6.1.2" typedoc: "npm:0.28.15" From de8eaa5bc82045501189f4121aef2a70a48a6142 Mon Sep 17 00:00:00 2001 From: Florian Imdahl Date: Tue, 23 Dec 2025 21:25:44 +0100 Subject: [PATCH 3/4] feat: Add Changelog --- packages/useresponse/src/api/AdditionalAPI.ts | 2 +- packages/useresponse/src/api/AuthAPI.ts | 2 +- packages/useresponse/src/api/CategoriesAPI.ts | 2 +- packages/useresponse/src/api/ChangelogAPI.ts | 13 +++++++++++++ .../src/interfaces/UseResponseInterfaces.ts | 7 +++++++ 5 files changed, 23 insertions(+), 3 deletions(-) diff --git a/packages/useresponse/src/api/AdditionalAPI.ts b/packages/useresponse/src/api/AdditionalAPI.ts index 6e43a1a53..d3a977c7f 100644 --- a/packages/useresponse/src/api/AdditionalAPI.ts +++ b/packages/useresponse/src/api/AdditionalAPI.ts @@ -1,7 +1,7 @@ import type {APIClient} from '@ffflorian/api-client'; +import type {LoginData} from '../interfaces'; import {Endpoint} from '../Endpoints'; -import {LoginData} from '../interfaces'; export class AdditionalAPI { private readonly apiClient: APIClient; diff --git a/packages/useresponse/src/api/AuthAPI.ts b/packages/useresponse/src/api/AuthAPI.ts index 2d5b15b50..e937e8327 100644 --- a/packages/useresponse/src/api/AuthAPI.ts +++ b/packages/useresponse/src/api/AuthAPI.ts @@ -1,7 +1,7 @@ import type {APIClient} from '@ffflorian/api-client'; +import type {LoginData, User} from '../interfaces'; import {Endpoint} from '../Endpoints'; -import {LoginData, User} from '../interfaces'; export class AuthAPI { private readonly apiClient: APIClient; diff --git a/packages/useresponse/src/api/CategoriesAPI.ts b/packages/useresponse/src/api/CategoriesAPI.ts index 23ed0d529..55e6bdaf9 100644 --- a/packages/useresponse/src/api/CategoriesAPI.ts +++ b/packages/useresponse/src/api/CategoriesAPI.ts @@ -1,7 +1,7 @@ import type {APIClient} from '@ffflorian/api-client'; +import type {Category} from '../interfaces'; import {Endpoint} from '../Endpoints'; -import {Category} from '../interfaces'; interface GetListOptions { ownership?: string; diff --git a/packages/useresponse/src/api/ChangelogAPI.ts b/packages/useresponse/src/api/ChangelogAPI.ts index 006b97231..6c4ee7c5d 100644 --- a/packages/useresponse/src/api/ChangelogAPI.ts +++ b/packages/useresponse/src/api/ChangelogAPI.ts @@ -1,4 +1,5 @@ import type {APIClient} from '@ffflorian/api-client'; +import type { Changelog } from '../interfaces'; import {Endpoint} from '../Endpoints'; @@ -8,4 +9,16 @@ export class ChangelogAPI { constructor(apiClient: APIClient) { this.apiClient = apiClient; } + + async getObjectsChangelog(objectId: string): Promise { + const endpoint = Endpoint.Changelog.objects(objectId); + const {data} = await this.apiClient.get(endpoint); + return data; + } + + async getUsersChangelog(userId: string): Promise { + const endpoint = Endpoint.Changelog.users(userId); + const {data} = await this.apiClient.get(endpoint); + return data; + } } diff --git a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts index 8dad10fdd..707409750 100644 --- a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts +++ b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts @@ -70,6 +70,13 @@ export interface ChangePasswordParams { password: string; } +export interface Changelog { + actions?: ChangelogAction[]; + createdAtPosix?: number; + createdBy?: User; + source?: string; +} + export interface ChangelogAction { change_id?: string; field?: string; From bc88a600f2c311d12c7728bff78735bc76adb74e Mon Sep 17 00:00:00 2001 From: Florian Imdahl Date: Tue, 23 Dec 2025 21:33:09 +0100 Subject: [PATCH 4/4] feat: Add Chats --- packages/useresponse/src/api/ChatsAPI.ts | 24 +++++++++++++++++++ .../src/interfaces/UseResponseInterfaces.ts | 13 +++++++++- 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/packages/useresponse/src/api/ChatsAPI.ts b/packages/useresponse/src/api/ChatsAPI.ts index 71fde9356..6e200462a 100644 --- a/packages/useresponse/src/api/ChatsAPI.ts +++ b/packages/useresponse/src/api/ChatsAPI.ts @@ -1,6 +1,12 @@ import type {APIClient} from '@ffflorian/api-client'; import {Endpoint} from '../Endpoints'; +import {Chat, APIResult, ChatMessagesPaginator} from '../interfaces'; + +export interface GetAllChatOptions { + authorId?: string; + page?: number; +} export class ChatsAPI { private readonly apiClient: APIClient; @@ -8,4 +14,22 @@ export class ChatsAPI { constructor(apiClient: APIClient) { this.apiClient = apiClient; } + + async getAllChats(options?: GetAllChatOptions): Promise> { + const endpoint = Endpoint.Chats.chats(); + const {data} = await this.apiClient.get>(endpoint, {params: options}); + return data; + } + + async getChat(chatId: string): Promise> { + const endpoint = Endpoint.Chats.chat(chatId); + const {data} = await this.apiClient.get>(endpoint); + return data; + } + + async getMessages(chatId: string): Promise { + const endpoint = Endpoint.Chats.messages(chatId); + const {data} = await this.apiClient.get(endpoint); + return data; + } } diff --git a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts index 707409750..f0a87493d 100644 --- a/packages/useresponse/src/interfaces/UseResponseInterfaces.ts +++ b/packages/useresponse/src/interfaces/UseResponseInterfaces.ts @@ -1,3 +1,14 @@ +export interface APIResult { + currentPage?: number; + data: T; + firstPage: number; + lastPage: number; + nextPage: number; + objectsPerPage: number; + totalObjects: number; + totalPages: number; +} + interface AttachmentName { ext?: string; full?: string; @@ -104,7 +115,7 @@ export interface Chat { } export interface ChatMessagesPaginator { - success?: ChatMessagesPaginator; + success?: Message[]; } export interface ChatsPaginator {