diff --git a/apps/frontend/package.json b/apps/frontend/package.json index 3e3dca893b..c650cdf352 100644 --- a/apps/frontend/package.json +++ b/apps/frontend/package.json @@ -43,6 +43,7 @@ "@modrinth/moderation": "workspace:*", "@modrinth/ui": "workspace:*", "@modrinth/utils": "workspace:*", + "@modrinth/api-client": "workspace:*", "@pinia/nuxt": "^0.5.1", "@types/three": "^0.172.0", "@vintl/vintl": "^4.4.1", diff --git a/apps/frontend/src/app.vue b/apps/frontend/src/app.vue index 08c6e15e8b..5c58f2f238 100644 --- a/apps/frontend/src/app.vue +++ b/apps/frontend/src/app.vue @@ -7,30 +7,21 @@ diff --git a/apps/frontend/src/error.vue b/apps/frontend/src/error.vue index 6cd52510d2..7f345509b1 100644 --- a/apps/frontend/src/error.vue +++ b/apps/frontend/src/error.vue @@ -59,9 +59,21 @@ import { IntlFormatted } from '@vintl/vintl/components' import Logo404 from '~/assets/images/404.svg' import ModrinthLoadingIndicator from './components/ui/modrinth-loading-indicator.ts' +import { createModrinthClient, provideModrinthClient } from './providers/api-client.ts' import { FrontendNotificationManager } from './providers/frontend-notifications.ts' +const auth = await useAuth() +const config = useRuntimeConfig() + provideNotificationManager(new FrontendNotificationManager()) + +const client = createModrinthClient(auth.value, { + apiBaseUrl: config.public.apiBaseUrl.replace('/v2/', '/'), + archonBaseUrl: config.public.pyroBaseUrl.replace('/v2/', '/'), + rateLimitKey: config.rateLimitKey, +}) +provideModrinthClient(client) + const { formatMessage } = useVIntl() const props = defineProps({ diff --git a/apps/frontend/src/pages/[type]/[id]/settings/environment.vue b/apps/frontend/src/pages/[type]/[id]/settings/environment.vue index ddba72c32c..01054a724a 100644 --- a/apps/frontend/src/pages/[type]/[id]/settings/environment.vue +++ b/apps/frontend/src/pages/[type]/[id]/settings/environment.vue @@ -9,14 +9,15 @@ import { UnsavedChangesPopup, useSavable, } from '@modrinth/ui' -import { injectApi } from '@modrinth/ui/src/providers/api.ts' import { defineMessages, useVIntl } from '@vintl/vintl' +import { injectModrinthClient } from '~/providers/api-client.ts' + const { formatMessage } = useVIntl() const { currentMember, projectV2, projectV3, refreshProject } = injectProjectPageContext() const { handleError } = injectNotificationManager() -const api = injectApi() +const client = injectModrinthClient() const saving = ref(false) @@ -49,8 +50,8 @@ const { saved, current, reset, save } = useSavable( ({ environment, side_types_migration_review_status }) => { saving.value = true side_types_migration_review_status = 'reviewed' - api.projects - .editV3(projectV2.value.id, { environment, side_types_migration_review_status }) + client.labrinth.projects_v3 + .edit(projectV2.value.id, { environment, side_types_migration_review_status }) .then(() => refreshProject().then(reset)) .catch(handleError) .finally(() => (saving.value = false)) diff --git a/apps/frontend/src/pages/[type]/[id]/settings/general.vue b/apps/frontend/src/pages/[type]/[id]/settings/general.vue index 0367d4a870..00abbe4706 100644 --- a/apps/frontend/src/pages/[type]/[id]/settings/general.vue +++ b/apps/frontend/src/pages/[type]/[id]/settings/general.vue @@ -7,14 +7,15 @@ import { UnsavedChangesPopup, useSavable, } from '@modrinth/ui' -import { injectApi } from '@modrinth/ui/src/providers/api.ts' import { defineMessages, type MessageDescriptor, useVIntl } from '@vintl/vintl' +import { injectModrinthClient } from '~/providers/api-client.ts' + const { formatMessage } = useVIntl() const { projectV2: project, refreshProject } = injectProjectPageContext() const { handleError } = injectNotificationManager() -const api = injectApi() +const client = injectModrinthClient() const saving = ref(false) @@ -34,7 +35,7 @@ const { saved, current, reset, save } = useSavable( if (data) { saving.value = true - api.projects + client.labrinth.projects_v2 .edit(project.value.id, { title, description: tagline, slug: url }) .then(() => refreshProject().then(reset)) .catch(handleError) diff --git a/apps/frontend/src/pages/servers/manage/[id].vue b/apps/frontend/src/pages/servers/manage/[id].vue index 5e750616c7..a6af4bf864 100644 --- a/apps/frontend/src/pages/servers/manage/[id].vue +++ b/apps/frontend/src/pages/servers/manage/[id].vue @@ -1044,7 +1044,7 @@ const nodeUnavailableDetails = computed(() => [ { label: 'Node', value: - server.moduleErrors?.general?.error.responseData?.hostname ?? + (server.moduleErrors?.general?.error.responseData as any)?.hostname ?? server.general?.datacenter ?? 'Unknown', type: 'inline' as const, diff --git a/apps/frontend/src/providers/api-client.ts b/apps/frontend/src/providers/api-client.ts new file mode 100644 index 0000000000..e552111b8f --- /dev/null +++ b/apps/frontend/src/providers/api-client.ts @@ -0,0 +1,42 @@ +import type { AbstractFeature, AuthConfig, NuxtClientConfig } from '@modrinth/api-client' +import { + AuthFeature, + CircuitBreakerFeature, + NuxtCircuitBreakerStorage, + NuxtModrinthClient, + VerboseLoggingFeature, +} from '@modrinth/api-client' +import { createContext } from '@modrinth/ui' + +export function createModrinthClient( + auth: { token: string | undefined }, + config: { apiBaseUrl: string; archonBaseUrl: string; rateLimitKey?: string }, +): NuxtModrinthClient { + const optionalFeatures = [ + import.meta.dev ? (new VerboseLoggingFeature() as AbstractFeature) : undefined, + ].filter(Boolean) as AbstractFeature[] + + const clientConfig: NuxtClientConfig = { + labrinthBaseUrl: config.apiBaseUrl, + archonBaseUrl: config.archonBaseUrl, + rateLimitKey: config.rateLimitKey, + features: [ + new AuthFeature({ + token: async () => auth.token!, + } as AuthConfig), + new CircuitBreakerFeature({ + storage: new NuxtCircuitBreakerStorage(), + maxFailures: 3, + resetTimeout: 30000, + }), + ...optionalFeatures, + ], + } + + return new NuxtModrinthClient(clientConfig) +} + +export const [injectModrinthClient, provideModrinthClient] = createContext( + 'root', + 'modrinthClient', +) diff --git a/packages/api-client/LICENSE b/packages/api-client/LICENSE new file mode 100644 index 0000000000..f288702d2f --- /dev/null +++ b/packages/api-client/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/api-client/README.md b/packages/api-client/README.md new file mode 100644 index 0000000000..e69f78a5ec --- /dev/null +++ b/packages/api-client/README.md @@ -0,0 +1,179 @@ +![Modrinth Monorepo Cover](/.github/assets/monorepo_cover.png) + +# @modrinth/api-client + +[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-c78aff?style=for-the-badge)](https://www.typescriptlang.org/) +[![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-c78aff?style=for-the-badge)](LICENSE) + +A flexible, type-safe API client for Modrinth's APIs (Labrinth, Kyros & Archon). Works across Node.js, browsers, Nuxt, and Tauri with a feature system for authentication, retries, circuit breaking and other custom processing of requests and responses. + +## Installation + +```bash +pnpm add @modrinth/api-client +# or +npm install @modrinth/api-client +# or +yarn add @modrinth/api-client +``` + +## Usage + +### Plain JavaScript/Node.js + +```typescript +import { GenericModrinthClient, AuthFeature, ProjectV2 } from '@modrinth/api-client' + +const client = new GenericModrinthClient({ + userAgent: 'my-app/1.0.0', + features: [new AuthFeature({ token: 'mrp_...' })], +}) + +// Explicitly make a request using client.request +const project: any = await client.request('/project/sodium', { api: 'labrinth', version: 2 }) + +// Example for archon (Modrinth Servers) +const servers = await client.request('/servers?limit=10', { api: 'archon', version: 0 }) + +// Or use the provided wrappers for better type support. +const project: ProjectV2 = await client.projects_v2.get('sodium') +``` + +### Nuxt + +```typescript +import { NuxtModrinthClient, AuthFeature, NuxtCircuitBreakerStorage } from '@modrinth/api-client' + +// Alternatively you can create a singleton of the client and provide it via DI. +export const useModrinthClient = () => { + const config = useRuntimeConfig() + + // example using the useAuth composable from our frontend, replace this with whatever you're using to store auth token + const auth = await useAuth() + + return new NuxtModrinthClient({ + userAgent: 'my-nuxt-app/1.0.0', // leave blank to use default user agent from fetch function + rateLimitKey: import.meta.server ? config.rateLimitKey : undefined, + features: [ + new AuthFeature({ + token: async () => auth.value.token, + }), + new CircuitBreakerFeature({ + storage: new NuxtCircuitBreakerStorage(), + }), + ], + }) +} + +const client = useModrinthClient() +const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 }) +``` + +### Tauri + +```typescript +import { TauriModrinthClient, AuthFeature } from '@modrinth/api-client' +import { getVersion } from '@tauri-apps/api/app' + +const version = await getVersion() +const client = new TauriModrinthClient({ + userAgent: `modrinth/theseus/${version} (support@modrinth.com)`, + features: [new AuthFeature({ token: 'mrp_...' })], +}) + +const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 }) +``` + +### Overriding Base URLs + +By default, the client uses the production base URLs: + +- `labrinthBaseUrl`: `https://api.modrinth.com/` (Labrinth API) +- `archonBaseUrl`: `https://archon.modrinth.com/` (Archon/Servers API) + +You can override these for staging environments or custom instances: + +```typescript +const client = new GenericModrinthClient({ + userAgent: 'my-app/1.0.0', + labrinthBaseUrl: 'https://staging-api.modrinth.com/', + archonBaseUrl: 'https://staging-archon.modrinth.com/', + features: [new AuthFeature({ token: 'mrp_...' })], +}) + +// Now requests will use the staging URLs +await client.request('/project/sodium', { api: 'labrinth', version: 2 }) +// -> https://staging-api.modrinth.com/v2/project/sodium +``` + +You can also use custom URLs directly in requests: + +```typescript +// One-off custom URL (useful for Kyros nodes or dynamic endpoints) +await client.request('/some-endpoint', { + api: 'https://eu-lim16.nodes.modrinth.com/', + version: 0, +}) +``` + +## Features + +### Authentication + +Supports both static and dynamic tokens: + +```typescript +// Static token +new AuthFeature({ token: 'mrp_...' }) + +// Dynamic token (e.g., from auth state) +const auth = await useAuth() +new AuthFeature({ + token: async () => auth.value.token, +}) +``` + +### Retry + +Automatically retries failed requests with configurable backoff: + +```typescript +new RetryFeature({ + maxAttempts: 3, + backoffStrategy: 'exponential', + initialDelay: 1000, + maxDelay: 15000, +}) +``` + +### Circuit Breaker + +Prevents cascade failures by opening circuits after repeated failures: + +```typescript +new CircuitBreakerFeature({ + maxFailures: 3, + resetTimeout: 30000, + failureStatusCodes: [500, 502, 503, 504], +}) +``` + +## Documentation + +This package is **self-documenting** through TypeScript types and JSDoc comments. Use your IDE's IntelliSense to explore available methods, classes, and configuration options. + +For Modrinth API endpoints and routes, refer to the [Modrinth API Documentation](https://docs.modrinth.com). + +## Contributing + +- Modules are available in the `modules//...` folders. + - When a module has different versions available, you should do it like so: `modules/labrinth/projects/v2.ts` etc. + - Types for a module's requests should be made available in `modules//module/types.ts` or `.../types/v2.ts`. + - You should expose these types in the `modules/types.ts` file. +- When creating a new module, add it to the `modules/index.ts`'s `MODULE_REGISTRY` for it to become available in the api client class. + +Dont forget to run `pnpm fix` before committing. + +## License + +Licensed under GPL-3.0 - see the [LICENSE](LICENSE) file for details. diff --git a/packages/api-client/eslint.config.mjs b/packages/api-client/eslint.config.mjs new file mode 100644 index 0000000000..3d6da7fb54 --- /dev/null +++ b/packages/api-client/eslint.config.mjs @@ -0,0 +1,2 @@ +import config from '@modrinth/tooling-config/eslint/nuxt.mjs' +export default config diff --git a/packages/api-client/package.json b/packages/api-client/package.json new file mode 100644 index 0000000000..ecf17087bc --- /dev/null +++ b/packages/api-client/package.json @@ -0,0 +1,24 @@ +{ + "name": "@modrinth/api-client", + "version": "0.1.0", + "description": "An API client for Modrinth's API for use in nuxt, tauri and plain node/browser environments.", + "main": "./src/index.ts", + "scripts": { + "lint": "eslint . && prettier --check .", + "fix": "eslint . --fix && prettier --write ." + }, + "dependencies": { + "ofetch": "^1.4.1" + }, + "devDependencies": { + "@modrinth/tooling-config": "workspace:*" + }, + "peerDependencies": { + "@tauri-apps/plugin-http": "^2.0.0" + }, + "peerDependenciesMeta": { + "@tauri-apps/plugin-http": { + "optional": true + } + } +} diff --git a/packages/api-client/src/core/abstract-client.ts b/packages/api-client/src/core/abstract-client.ts new file mode 100644 index 0000000000..12e3c34740 --- /dev/null +++ b/packages/api-client/src/core/abstract-client.ts @@ -0,0 +1,310 @@ +import type { InferredClientModules } from '../modules' +import { buildModuleStructure } from '../modules' +import type { ClientConfig } from '../types/client' +import type { RequestContext, RequestOptions } from '../types/request' +import type { AbstractFeature } from './abstract-feature' +import type { AbstractModule } from './abstract-module' +import { ModrinthApiError, ModrinthServerError } from './errors' + +/** + * Abstract base client for Modrinth APIs + */ +export abstract class AbstractModrinthClient { + protected config: ClientConfig + protected features: AbstractFeature[] + + /** + * Maps full module ID (e.g., 'labrinth_projects_v2') to instantiated module + */ + private _moduleInstances: Map = new Map() + + /** + * Maps API name (e.g., 'labrinth') to namespace object + */ + private _moduleNamespaces: Map> = new Map() + + // TODO: When adding kyros/archon add readonly fields for those too. + public readonly labrinth!: InferredClientModules['labrinth'] + + constructor(config: ClientConfig) { + this.config = { + timeout: 10000, + labrinthBaseUrl: 'https://api.modrinth.com', + archonBaseUrl: 'https://archon.modrinth.com', + ...config, + } + this.features = config.features ?? [] + this.initializeModules() + } + + /** + * This creates the nested API structure (e.g., client.labrinth.projects_v2) + * but doesn't instantiate modules until first access + * + * Module IDs in the registry are validated at runtime to ensure they match + * what the module declares via getModuleID(). + */ + private initializeModules(): void { + const structure = buildModuleStructure() + + for (const [api, modules] of Object.entries(structure)) { + const namespaceObj: Record = {} + + // Define lazy getters for each module + for (const [moduleName, ModuleConstructor] of Object.entries(modules)) { + const fullModuleId = `${api}_${moduleName}` + + Object.defineProperty(namespaceObj, moduleName, { + get: () => { + // Lazy instantiation + if (!this._moduleInstances.has(fullModuleId)) { + const instance = new ModuleConstructor(this) + + // Validate the module ID matches what we expect + const declaredId = instance.getModuleID() + if (declaredId !== fullModuleId) { + throw new Error( + `Module ID mismatch: registry expects "${fullModuleId}" but module declares "${declaredId}"`, + ) + } + + this._moduleInstances.set(fullModuleId, instance) + } + return this._moduleInstances.get(fullModuleId)! + }, + enumerable: true, + configurable: false, + }) + } + + // Assign namespace to client (e.g., this.labrinth = namespaceObj) + // defineProperty bypasses readonly restriction + Object.defineProperty(this, api, { + value: namespaceObj, + writable: false, + enumerable: true, + configurable: false, + }) + + this._moduleNamespaces.set(api, namespaceObj) + } + } + + /** + * Make a request to the API + * + * @param path - API path (e.g., '/project/sodium') + * @param options - Request options + * @returns Promise resolving to the response data + * @throws {ModrinthApiError} When the request fails or features throw errors + */ + async request(path: string, options: RequestOptions): Promise { + let baseUrl: string + if (options.api === 'labrinth') { + baseUrl = this.config.labrinthBaseUrl! + } else if (options.api === 'archon') { + baseUrl = this.config.archonBaseUrl! + } else { + baseUrl = options.api + } + + const url = this.buildUrl(path, baseUrl, options.version) + + // Merge options with defaults + const mergedOptions: RequestOptions = { + method: 'GET', + timeout: this.config.timeout, + ...options, + headers: { + ...this.buildDefaultHeaders(), + ...options.headers, + }, + } + + const context = this.buildContext(url, path, mergedOptions) + + try { + const result = await this.executeFeatureChain(context) + + await this.config.hooks?.onResponse?.(result, context) + + return result + } catch (error) { + const apiError = this.normalizeError(error, context) + await this.config.hooks?.onError?.(apiError, context) + + throw apiError + } + } + + /** + * Execute the feature chain and the actual request + * + * Features are executed in order, with each feature calling next() to continue. + * The last "feature" in the chain is the actual request execution. + */ + protected async executeFeatureChain(context: RequestContext): Promise { + // Filter to only features that should apply + const applicableFeatures = this.features.filter((feature) => feature.shouldApply(context)) + + // Build the feature chain + // We work backwards from the actual request, wrapping each feature around the previous + let index = applicableFeatures.length + + const next = async (): Promise => { + index-- + + if (index >= 0) { + // Execute the next feature in the chain + const feature = applicableFeatures[index] + return feature.execute(next, context) + } else { + // We've reached the end of the chain, execute the actual request + await this.config.hooks?.onRequest?.(context) + return this.executeRequest(context.url, context.options) + } + } + + return next() + } + + /** + * Build the full URL for a request + */ + protected buildUrl(path: string, baseUrl: string, version: number | 'internal'): string { + // Remove trailing slash from base URL + const base = baseUrl.replace(/\/$/, '') + + // Build version path + let versionPath = '' + if (version === 'internal') { + versionPath = '/_internal' + } else if (typeof version === 'number') { + versionPath = `/v${version}` + } + + const cleanPath = path.startsWith('/') ? path : `/${path}` + + return `${base}${versionPath}${cleanPath}` + } + + /** + * Build the request context + */ + protected buildContext(url: string, path: string, options: RequestOptions): RequestContext { + return { + url, + path, + options, + attempt: 1, + startTime: Date.now(), + } + } + + /** + * Build default headers for all requests + * + * Subclasses can override this to add platform-specific headers + * (e.g., Nuxt rate limit key) + */ + protected buildDefaultHeaders(): Record { + const headers: Record = { + 'Content-Type': 'application/json', + ...this.config.headers, + } + + if (this.config.userAgent) { + headers['User-Agent'] = this.config.userAgent + } + + return headers + } + + /** + * Execute the actual HTTP request + * + * This must be implemented by platform-specific clients. + * + * @param url - Full URL to request + * @param options - Request options + * @returns Promise resolving to the response data + * @throws {Error} Platform-specific errors that will be normalized by normalizeError() + */ + protected abstract executeRequest(url: string, options: RequestOptions): Promise + + /** + * Normalize an error into a ModrinthApiError + * + * Platform implementations should override this to handle platform-specific errors + * (e.g., FetchError from ofetch, Tauri HTTP errors) + */ + protected normalizeError(error: unknown, context?: RequestContext): ModrinthApiError { + if (error instanceof ModrinthApiError) { + return error + } + + return ModrinthApiError.fromUnknown(error, context?.path) + } + + /** + * Helper to create a normalized error from extracted status code and response data + */ + protected createNormalizedError( + error: Error, + statusCode: number | undefined, + responseData: unknown, + ): ModrinthApiError { + if (statusCode && responseData) { + return ModrinthServerError.fromResponse(statusCode, responseData) + } + + return new ModrinthApiError(error.message, { + statusCode, + originalError: error, + responseData, + }) + } + + /** + * Add a feature to this client + * + * Features are executed in the order they are added. + * + * @example + * ```typescript + * const client = new GenericModrinthClient() + * client.addFeature(new AuthFeature({ token: 'mrp_...' })) + * client.addFeature(new RetryFeature({ maxAttempts: 3 })) + * ``` + */ + addFeature(feature: AbstractFeature): this { + this.features.push(feature) + return this + } + + /** + * Remove a feature from this client + * + * @example + * ```typescript + * const retryFeature = new RetryFeature({ maxAttempts: 3 }) + * client.addFeature(retryFeature) + * // Later, remove it + * client.removeFeature(retryFeature) + * ``` + */ + removeFeature(feature: AbstractFeature): this { + const index = this.features.indexOf(feature) + if (index !== -1) { + this.features.splice(index, 1) + } + return this + } + + /** + * Get all features on this client + */ + getFeatures(): AbstractFeature[] { + return [...this.features] + } +} diff --git a/packages/api-client/src/core/abstract-feature.ts b/packages/api-client/src/core/abstract-feature.ts new file mode 100644 index 0000000000..c324d4a57e --- /dev/null +++ b/packages/api-client/src/core/abstract-feature.ts @@ -0,0 +1,91 @@ +import type { RequestContext } from '../types/request' + +/** + * Base configuration for features + */ +export interface FeatureConfig { + /** + * Optional name for this feature (for debugging) + */ + name?: string + + /** + * Whether this feature is enabled + * @default true + */ + enabled?: boolean +} + +/** + * Abstract base class for request features + * + * Features are composable middleware that can intercept and modify requests. + * They are executed in a chain, with each feature calling next() to continue the chain. + */ +export abstract class AbstractFeature { + protected config: FeatureConfig + + constructor(config?: FeatureConfig) { + this.config = { + enabled: true, + ...config, + } + } + + /** + * Execute the feature logic + * + * @param next - Function to call the next feature in the chain (or the actual request) + * @param context - Full request context + * @returns Promise resolving to the response data + * + * @example + * ```typescript + * async execute(next: () => Promise, context: RequestContext): Promise { + * // Do something before request + * console.log('Before request:', context.url) + * + * try { + * const result = await next() + * + * // Do something after successful request + * console.log('Request succeeded') + * + * return result + * } catch (error) { + * // Handle errors + * console.error('Request failed:', error) + * throw error + * } + * } + * ``` + */ + abstract execute(next: () => Promise, context: RequestContext): Promise + + /** + * Determine if this feature should apply to the given request + * + * By default, features apply if they are enabled. + * Override this to add custom logic (e.g., only apply to GET requests). + * + * @param context - Request context + * @returns true if the feature should execute, false to skip + */ + shouldApply(_context: RequestContext): boolean { + return this.config.enabled !== false + } + + /** + * Get the name of this feature (for debugging) + */ + get name(): string { + return this.config.name ?? this.constructor.name + } + + /** + * Check if this feature is enabled + */ + get enabled(): boolean { + return this.config.enabled !== false + } +} diff --git a/packages/api-client/src/core/abstract-module.ts b/packages/api-client/src/core/abstract-module.ts new file mode 100644 index 0000000000..f0a8fa8cab --- /dev/null +++ b/packages/api-client/src/core/abstract-module.ts @@ -0,0 +1,15 @@ +import type { AbstractModrinthClient } from './abstract-client' + +export abstract class AbstractModule { + protected client: AbstractModrinthClient + + public constructor(client: AbstractModrinthClient) { + this.client = client + } + + /** + * Get the module's name, used for error reporting & for module field generation. + * @returns Module name + */ + public abstract getModuleID(): string +} diff --git a/packages/api-client/src/core/errors.ts b/packages/api-client/src/core/errors.ts new file mode 100644 index 0000000000..6b958eb4d2 --- /dev/null +++ b/packages/api-client/src/core/errors.ts @@ -0,0 +1,142 @@ +import type { ApiErrorData, ModrinthErrorResponse } from '../types/errors' +import { isModrinthErrorResponse } from '../types/errors' + +/** + * Base error class for all Modrinth API errors + */ +export class ModrinthApiError extends Error { + /** + * HTTP status code (if available) + */ + readonly statusCode?: number + + /** + * Original error that was caught + */ + readonly originalError?: Error + + /** + * Response data from the API (if available) + */ + readonly responseData?: unknown + + /** + * Error context (e.g., module name, operation being performed) + */ + readonly context?: string + + constructor(message: string, data?: ApiErrorData) { + super(message) + this.name = 'ModrinthApiError' + + this.statusCode = data?.statusCode + this.originalError = data?.originalError + this.responseData = data?.responseData + this.context = data?.context + + // Maintains proper stack trace for where our error was thrown (only available on V8) + if (Error.captureStackTrace) { + Error.captureStackTrace(this, ModrinthApiError) + } + } + + /** + * Create a ModrinthApiError from an unknown error + */ + static fromUnknown(error: unknown, context?: string): ModrinthApiError { + if (error instanceof ModrinthApiError) { + return error + } + + if (error instanceof Error) { + return new ModrinthApiError(error.message, { + originalError: error, + context, + }) + } + + return new ModrinthApiError(String(error), { context }) + } +} + +/** + * Error class for Modrinth server errors (kyros/archon) + * Extends ModrinthApiError with V1 error response parsing + */ +export class ModrinthServerError extends ModrinthApiError { + /** + * V1 error information (if available) + */ + readonly v1Error?: ModrinthErrorResponse + + constructor(message: string, data?: ApiErrorData & { v1Error?: ModrinthErrorResponse }) { + // If we have a V1 error, format the message nicely + let errorMessage = message + if (data?.v1Error) { + errorMessage = `[${data.v1Error.error}] ${data.v1Error.description}` + if (data.v1Error.context) { + errorMessage = `${data.v1Error.context}: ${errorMessage}` + } + } + + super(errorMessage, data) + this.name = 'ModrinthServerError' + this.v1Error = data?.v1Error + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, ModrinthServerError) + } + } + + /** + * Create a ModrinthServerError from response data + */ + static fromResponse( + statusCode: number, + responseData: unknown, + context?: string, + ): ModrinthServerError { + const v1Error = isModrinthErrorResponse(responseData) ? responseData : undefined + + let message = `HTTP ${statusCode}` + if (v1Error) { + message = v1Error.description + } else if (typeof responseData === 'string') { + message = responseData + } + + return new ModrinthServerError(message, { + statusCode, + responseData, + context, + v1Error, + }) + } + + /** + * Create a ModrinthServerError from an unknown error + */ + static fromUnknown(error: unknown, context?: string): ModrinthServerError { + if (error instanceof ModrinthServerError) { + return error + } + + if (error instanceof ModrinthApiError) { + return new ModrinthServerError(error.message, { + statusCode: error.statusCode, + originalError: error.originalError, + responseData: error.responseData, + context: context ?? error.context, + }) + } + + if (error instanceof Error) { + return new ModrinthServerError(error.message, { + originalError: error, + context, + }) + } + + return new ModrinthServerError(String(error), { context }) + } +} diff --git a/packages/api-client/src/features/auth.ts b/packages/api-client/src/features/auth.ts new file mode 100644 index 0000000000..2b075cc6cc --- /dev/null +++ b/packages/api-client/src/features/auth.ts @@ -0,0 +1,89 @@ +import { AbstractFeature, type FeatureConfig } from '../core/abstract-feature' +import type { RequestContext } from '../types/request' + +/** + * Authentication feature configuration + */ +export interface AuthConfig extends FeatureConfig { + /** + * Authentication token + * - string: static token + * - function: async function that returns token (useful for dynamic tokens) + */ + token: string | (() => Promise) + + /** + * Token prefix (e.g., 'Bearer', 'Token') + * @default 'Bearer' + */ + tokenPrefix?: string + + /** + * Custom header name for the token + * @default 'Authorization' + */ + headerName?: string +} + +/** + * Authentication feature + * + * Automatically injects authentication tokens into request headers. + * Supports both static tokens and dynamic token providers. + * + * @example + * ```typescript + * // Static token + * const auth = new AuthFeature({ + * token: 'mrp_...' + * }) + * + * // Dynamic token (e.g., from auth state) + * const auth = new AuthFeature({ + * token: async () => await getAuthToken() + * }) + * ``` + */ +export class AuthFeature extends AbstractFeature { + protected declare config: AuthConfig + + async execute(next: () => Promise, context: RequestContext): Promise { + const token = await this.getToken() + + if (token) { + const headerName = this.config.headerName ?? 'Authorization' + const tokenPrefix = this.config.tokenPrefix ?? 'Bearer' + const headerValue = tokenPrefix ? `${tokenPrefix} ${token}` : token + + context.options.headers = { + ...context.options.headers, + [headerName]: headerValue, + } + } + + return next() + } + + shouldApply(context: RequestContext): boolean { + if (context.options.skipAuth) { + return false + } + + return super.shouldApply(context) + } + + /** + * Get the authentication token + * + * Handles both static tokens and async token providers + */ + private async getToken(): Promise { + const { token } = this.config + + if (typeof token === 'function') { + return await token() + } + + return token + } +} diff --git a/packages/api-client/src/features/circuit-breaker.ts b/packages/api-client/src/features/circuit-breaker.ts new file mode 100644 index 0000000000..2f850ff0ec --- /dev/null +++ b/packages/api-client/src/features/circuit-breaker.ts @@ -0,0 +1,269 @@ +import { AbstractFeature, type FeatureConfig } from '../core/abstract-feature' +import { ModrinthApiError } from '../core/errors' +import type { RequestContext } from '../types/request' + +/** + * Circuit breaker state + */ +export type CircuitBreakerState = { + /** + * Number of consecutive failures + */ + failures: number + + /** + * Timestamp of last failure + */ + lastFailure: number +} + +/** + * Circuit breaker storage interface + */ +export interface CircuitBreakerStorage { + /** + * Get circuit breaker state for a key + */ + get(key: string): CircuitBreakerState | undefined + + /** + * Set circuit breaker state for a key + */ + set(key: string, state: CircuitBreakerState): void + + /** + * Clear circuit breaker state for a key + */ + clear?(key: string): void +} + +/** + * Circuit breaker feature configuration + */ +export interface CircuitBreakerConfig extends FeatureConfig { + /** + * Maximum number of consecutive failures before opening circuit + * @default 3 + */ + maxFailures?: number + + /** + * Time in milliseconds before circuit resets after opening + * @default 30000 + */ + resetTimeout?: number + + /** + * HTTP status codes that count as failures + * @default [500, 502, 503, 504] + */ + failureStatusCodes?: number[] + + /** + * Storage implementation for circuit state + * If not provided, uses in-memory Map + */ + storage?: CircuitBreakerStorage + + /** + * Function to generate circuit key from request context + * By default, uses the base path (without query params) + */ + getCircuitKey?: (url: string, method: string) => string +} + +/** + * In-memory storage for circuit breaker state + */ +export class InMemoryCircuitBreakerStorage implements CircuitBreakerStorage { + private state = new Map() + + get(key: string): CircuitBreakerState | undefined { + return this.state.get(key) + } + + set(key: string, state: CircuitBreakerState): void { + this.state.set(key, state) + } + + clear(key: string): void { + this.state.delete(key) + } +} + +/** + * Circuit breaker feature + * + * Prevents requests to failing endpoints by "opening the circuit" after + * a threshold of consecutive failures. The circuit automatically resets + * after a timeout period. + * + * This implements the circuit breaker pattern to prevent cascading failures + * and give failing services time to recover. + * + * @example + * ```typescript + * const circuitBreaker = new CircuitBreakerFeature({ + * maxFailures: 3, + * resetTimeout: 30000, // 30 seconds + * failureStatusCodes: [500, 502, 503, 504] + * }) + * ``` + */ +export class CircuitBreakerFeature extends AbstractFeature { + protected declare config: Required + private storage: CircuitBreakerStorage + + constructor(config?: CircuitBreakerConfig) { + super(config) + + this.config = { + enabled: true, + name: 'circuit-breaker', + maxFailures: 3, + resetTimeout: 30000, + failureStatusCodes: [500, 502, 503, 504], + ...config, + } as Required + + // Use provided storage or default to in-memory + this.storage = config?.storage ?? new InMemoryCircuitBreakerStorage() + } + + async execute(next: () => Promise, context: RequestContext): Promise { + const circuitKey = this.getCircuitKey(context) + + if (this.isCircuitOpen(circuitKey)) { + throw new ModrinthApiError('Circuit breaker open - too many recent failures', { + statusCode: 503, + context: context.path, + }) + } + + try { + const result = await next() + + this.recordSuccess(circuitKey) + + return result + } catch (error) { + if (this.isFailureError(error)) { + this.recordFailure(circuitKey) + } + + throw error + } + } + + shouldApply(context: RequestContext): boolean { + if (context.options.circuitBreaker === false) { + return false + } + + return super.shouldApply(context) + } + + /** + * Get the circuit key for a request + * + * By default, uses the path and method to identify unique circuits + */ + private getCircuitKey(context: RequestContext): string { + if (this.config.getCircuitKey) { + return this.config.getCircuitKey(context.url, context.options.method ?? 'GET') + } + + // Default: use method + path (without query params) + const method = context.options.method ?? 'GET' + const pathWithoutQuery = context.path.split('?')[0] + + return `${method}_${pathWithoutQuery}` + } + + /** + * Check if the circuit is open for a given key + */ + private isCircuitOpen(key: string): boolean { + const state = this.storage.get(key) + + if (!state) { + return false + } + + const now = Date.now() + const timeSinceLastFailure = now - state.lastFailure + + if (timeSinceLastFailure > this.config.resetTimeout) { + this.storage.clear?.(key) + return false + } + + return state.failures >= this.config.maxFailures + } + + /** + * Record a successful request + */ + private recordSuccess(key: string): void { + this.storage.clear?.(key) + } + + /** + * Record a failed request + */ + private recordFailure(key: string): void { + const now = Date.now() + const state = this.storage.get(key) + + if (!state) { + // First failure + this.storage.set(key, { + failures: 1, + lastFailure: now, + }) + } else { + // Subsequent failure + this.storage.set(key, { + failures: state.failures + 1, + lastFailure: now, + }) + } + } + + /** + * Determine if an error should count as a circuit failure + */ + private isFailureError(error: unknown): boolean { + if (error instanceof ModrinthApiError && error.statusCode) { + return this.config.failureStatusCodes.includes(error.statusCode) + } + + return false + } + + /** + * Get current circuit state for debugging + * + * @example + * ```typescript + * const state = circuitBreaker.getCircuitState('GET_/v2/project/sodium') + * console.log(`Failures: ${state?.failures}, Last failure: ${state?.lastFailure}`) + * ``` + */ + getCircuitState(key: string): CircuitBreakerState | undefined { + return this.storage.get(key) + } + + /** + * Manually reset a circuit + * + * @example + * ```typescript + * // Reset circuit after manual intervention + * circuitBreaker.resetCircuit('GET_/v2/project/sodium') + * ``` + */ + resetCircuit(key: string): void { + this.storage.clear?.(key) + } +} diff --git a/packages/api-client/src/features/retry.ts b/packages/api-client/src/features/retry.ts new file mode 100644 index 0000000000..d9f11ed55c --- /dev/null +++ b/packages/api-client/src/features/retry.ts @@ -0,0 +1,220 @@ +import { AbstractFeature, type FeatureConfig } from '../core/abstract-feature' +import { ModrinthApiError } from '../core/errors' +import type { RequestContext } from '../types/request' + +/** + * Backoff strategy for retries + */ +export type BackoffStrategy = 'exponential' | 'linear' | 'constant' + +/** + * Retry feature configuration + */ +export interface RetryConfig extends FeatureConfig { + /** + * Maximum number of retry attempts + * @default 3 + */ + maxAttempts?: number + + /** + * Backoff strategy to use + * @default 'exponential' + */ + backoffStrategy?: BackoffStrategy + + /** + * Initial delay in milliseconds before first retry + * @default 1000 + */ + initialDelay?: number + + /** + * Maximum delay in milliseconds between retries + * @default 15000 + */ + maxDelay?: number + + /** + * HTTP status codes that should trigger a retry + * @default [408, 429, 500, 502, 503, 504] + */ + retryableStatusCodes?: number[] + + /** + * Whether to retry on network errors (connection refused, timeout, etc.) + * @default true + */ + retryOnNetworkError?: boolean + + /** + * Custom function to determine if an error should be retried + */ + shouldRetry?: (error: unknown, attempt: number) => boolean +} + +/** + * Retry feature + * + * Automatically retries failed requests with configurable backoff strategy. + * Only retries errors that are likely to succeed on retry (e.g., timeout, 5xx errors). + * + * @example + * ```typescript + * const retry = new RetryFeature({ + * maxAttempts: 3, + * backoffStrategy: 'exponential', + * initialDelay: 1000, + * maxDelay: 15000 + * }) + * ``` + */ +export class RetryFeature extends AbstractFeature { + protected declare config: Required + + constructor(config?: RetryConfig) { + super(config) + + this.config = { + enabled: true, + name: 'retry', + maxAttempts: 3, + backoffStrategy: 'exponential', + initialDelay: 1000, + maxDelay: 15000, + retryableStatusCodes: [408, 429, 500, 502, 503, 504], + retryOnNetworkError: true, + ...config, + } as Required + } + + async execute(next: () => Promise, context: RequestContext): Promise { + let lastError: Error | null = null + const maxAttempts = this.getMaxAttempts(context) + + for (let attempt = 1; attempt <= maxAttempts; attempt++) { + context.attempt = attempt + + try { + const result = await next() + return result + } catch (error) { + lastError = error as Error + + const shouldRetry = this.shouldRetryError(error, attempt, maxAttempts) + + if (!shouldRetry || attempt >= maxAttempts) { + throw error + } + + const delay = this.calculateDelay(attempt) + + console.warn( + `[${this.name}] Retrying request to ${context.path} (attempt ${attempt + 1}/${maxAttempts}) after ${delay}ms`, + ) + + await this.sleep(delay) + } + } + + // This shouldn't be reached, but TypeScript requires it + throw lastError ?? new Error('Max retry attempts reached') + } + + shouldApply(context: RequestContext): boolean { + if (context.options.retry === false) { + return false + } + + return super.shouldApply(context) + } + + /** + * Determine if an error should be retried + */ + private shouldRetryError(error: unknown, attempt: number, _maxAttempts: number): boolean { + if (this.config.shouldRetry) { + return this.config.shouldRetry(error, attempt) + } + + if (this.config.retryOnNetworkError && this.isNetworkError(error)) { + return true + } + + if (error instanceof ModrinthApiError && error.statusCode) { + return this.config.retryableStatusCodes.includes(error.statusCode) + } + + return false + } + + /** + * Check if an error is a network error + */ + private isNetworkError(error: unknown): boolean { + // Common network error indicators + const networkErrorPatterns = [ + /network/i, + /timeout/i, + /ECONNREFUSED/i, + /ENOTFOUND/i, + /ETIMEDOUT/i, + /ECONNRESET/i, + ] + + const errorMessage = error?.message ?? String(error) + return networkErrorPatterns.some((pattern) => pattern.test(errorMessage)) + } + + /** + * Get max attempts for this request + */ + private getMaxAttempts(context: RequestContext): number { + if (typeof context.options.retry === 'number') { + return context.options.retry + } + + return this.config.maxAttempts + } + + /** + * Calculate delay before next retry based on backoff strategy + */ + private calculateDelay(attempt: number): number { + const { backoffStrategy, initialDelay, maxDelay } = this.config + + let delay: number + + switch (backoffStrategy) { + case 'exponential': + // Exponential: delay = initialDelay * 2^(attempt-1) + delay = initialDelay * Math.pow(2, attempt - 1) + break + + case 'linear': + // Linear: delay = initialDelay * attempt + delay = initialDelay * attempt + break + + case 'constant': + // Constant: delay = initialDelay + delay = initialDelay + break + + default: + delay = initialDelay + } + + // Add jitter (random 0-1000ms) to prevent thundering herd + delay += Math.random() * 1000 + + return Math.min(delay, maxDelay) + } + + /** + * Sleep for a given duration + */ + private sleep(ms: number): Promise { + return new Promise((resolve) => setTimeout(resolve, ms)) + } +} diff --git a/packages/api-client/src/features/verbose-logging.ts b/packages/api-client/src/features/verbose-logging.ts new file mode 100644 index 0000000000..da88bcabee --- /dev/null +++ b/packages/api-client/src/features/verbose-logging.ts @@ -0,0 +1,30 @@ +import { AbstractFeature, type FeatureConfig } from '../core/abstract-feature' +import type { RequestContext } from '../types/request' + +export type VerboseLoggingConfig = FeatureConfig + +export class VerboseLoggingFeature extends AbstractFeature { + async execute(next: () => Promise, context: RequestContext): Promise { + const method = context.options.method ?? 'GET' + const api = context.options.api + const version = context.options.version + const prefix = `[${method}] [${api}_v${version}]` + + console.debug(`${prefix} ${context.url} SENT`) + + try { + const result = await next() + try { + const size = result ? JSON.stringify(result) : 0 + console.debug(`${prefix} ${context.url} RECEIVED ${size} bytes`) + } catch { + // ignore size calc fail + console.debug(`${prefix} ${context.url} RECEIVED`) + } + return result + } catch (error) { + console.debug(`${prefix} ${context.url} FAILED`) + throw error + } + } +} diff --git a/packages/api-client/src/index.ts b/packages/api-client/src/index.ts new file mode 100644 index 0000000000..106c7e4f92 --- /dev/null +++ b/packages/api-client/src/index.ts @@ -0,0 +1,21 @@ +export { AbstractModrinthClient } from './core/abstract-client' +export { AbstractFeature, type FeatureConfig } from './core/abstract-feature' +export { ModrinthApiError, ModrinthServerError } from './core/errors' +export { type AuthConfig, AuthFeature } from './features/auth' +export { + type CircuitBreakerConfig, + CircuitBreakerFeature, + type CircuitBreakerState, + type CircuitBreakerStorage, + InMemoryCircuitBreakerStorage, +} from './features/circuit-breaker' +export { type BackoffStrategy, type RetryConfig, RetryFeature } from './features/retry' +export { type VerboseLoggingConfig, VerboseLoggingFeature } from './features/verbose-logging' +export type { InferredClientModules } from './modules' +export * from './modules/types' +export { GenericModrinthClient } from './platform/generic' +export type { NuxtClientConfig } from './platform/nuxt' +export { NuxtCircuitBreakerStorage, NuxtModrinthClient } from './platform/nuxt' +export type { TauriClientConfig } from './platform/tauri' +export { TauriModrinthClient } from './platform/tauri' +export * from './types' diff --git a/packages/api-client/src/modules/archon/.gitkeep b/packages/api-client/src/modules/archon/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/api-client/src/modules/index.ts b/packages/api-client/src/modules/index.ts new file mode 100644 index 0000000000..ec2c81ec5e --- /dev/null +++ b/packages/api-client/src/modules/index.ts @@ -0,0 +1,106 @@ +import type { AbstractModrinthClient } from '../core/abstract-client' +import type { AbstractModule } from '../core/abstract-module' +import { LabrinthProjectsV2Module } from './labrinth/projects/v2' +import { LabrinthProjectsV3Module } from './labrinth/projects/v3' + +type ModuleConstructor = new (client: AbstractModrinthClient) => AbstractModule + +/** + * To add a new module: + * 1. Create your module class extending AbstractModule + * 2. Add one line here: `_: YourModuleClass` + * + * TypeScript will automatically infer the client's field structure from this registry. + * + * TODO: Better way? Probably not + */ +export const MODULE_REGISTRY = { + labrinth_projects_v2: LabrinthProjectsV2Module, + labrinth_projects_v3: LabrinthProjectsV3Module, +} as const satisfies Record + +export type ModuleID = keyof typeof MODULE_REGISTRY + +/** + * Parse a module ID into [api, moduleName] tuple + * + * @param id - Module ID in format `_` (e.g., 'labrinth_projects_v2') + * @returns Tuple of [api, moduleName] (e.g., ['labrinth', 'projects_v2']) + * @throws Error if module ID doesn't match expected format + */ +export function parseModuleID(id: string): [string, string] { + const parts = id.split('_') + if (parts.length < 2) { + throw new Error( + `Invalid module ID "${id}". Expected format: _ (e.g., "labrinth_projects_v2")`, + ) + } + const api = parts[0] + const moduleName = parts.slice(1).join('_') + return [api, moduleName] +} + +/** + * Build nested module structure from flat registry + * + * Transforms: + * ``` + * { labrinth_projects_v2: Constructor, labrinth_users_v2: Constructor } + * ``` + * Into: + * ``` + * { labrinth: { projects_v2: Constructor, users_v2: Constructor } } + * ``` + * + * @returns Nested structure organized by API namespace + */ +export function buildModuleStructure(): Record> { + const structure: Record> = {} + + for (const [id, constructor] of Object.entries(MODULE_REGISTRY)) { + const [api, moduleName] = parseModuleID(id) + + if (!structure[api]) { + structure[api] = {} + } + + structure[api][moduleName] = constructor + } + + return structure +} + +/** + * Extract API name from module ID + * @example ParseAPI<'labrinth_projects_v2'> = 'labrinth' + */ +type ParseAPI = T extends `${infer API}_${string}` ? API : never + +/** + * Extract module name for a given API + * @example ParseModule<'labrinth_projects_v2', 'labrinth'> = 'projects_v2' + */ +type ParseModule = T extends `${API}_${infer Module}` + ? Module + : never + +/** + * Group registry modules by API namespace + * + * Transforms flat registry into nested structure at the type level: + * ``` + * { labrinth_projects_v2: ModuleClass } → { labrinth: { projects_v2: ModuleInstance } } + * ``` + */ +type GroupByAPI> = { + [API in ParseAPI]: { + [Module in ParseModule]: InstanceType< + Registry[`${API}_${Module}`] + > + } +} + +/** + * Inferred client module structure + **/ +export type InferredClientModules = GroupByAPI diff --git a/packages/api-client/src/modules/kyros/.gitkeep b/packages/api-client/src/modules/kyros/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/api-client/src/modules/labrinth/index.ts b/packages/api-client/src/modules/labrinth/index.ts new file mode 100644 index 0000000000..b5961a1c3b --- /dev/null +++ b/packages/api-client/src/modules/labrinth/index.ts @@ -0,0 +1,2 @@ +export * from './projects/v2' +export * from './projects/v3' diff --git a/packages/api-client/src/modules/labrinth/projects/types/v2.ts b/packages/api-client/src/modules/labrinth/projects/types/v2.ts new file mode 100644 index 0000000000..92f0d7cd58 --- /dev/null +++ b/packages/api-client/src/modules/labrinth/projects/types/v2.ts @@ -0,0 +1,115 @@ +export type Environment = 'required' | 'optional' | 'unsupported' | 'unknown' + +export type ProjectStatus = + | 'approved' + | 'archived' + | 'rejected' + | 'draft' + | 'unlisted' + | 'processing' + | 'withheld' + | 'scheduled' + | 'private' + | 'unknown' + +export type MonetizationStatus = 'monetized' | 'demonetized' | 'force-demonetized' + +export type ProjectType = 'mod' | 'modpack' | 'resourcepack' | 'shader' | 'plugin' | 'datapack' + +export type GalleryImageV2 = { + url: string + featured: boolean + title?: string + description?: string + created: string + ordering: number +} + +export type DonationLinkV2 = { + id: string + platform: string + url: string +} + +export type ProjectV2 = { + id: string + slug: string + project_type: ProjectType + team: string + title: string + description: string + body: string + published: string + updated: string + approved?: string + queued?: string + status: ProjectStatus + requested_status?: ProjectStatus + moderator_message?: { + message: string + body?: string + } + license: { + id: string + name: string + url?: string + } + client_side: Environment + server_side: Environment + downloads: number + followers: number + categories: string[] + additional_categories: string[] + game_versions: string[] + loaders: string[] + versions: string[] + icon_url?: string + issues_url?: string + source_url?: string + wiki_url?: string + discord_url?: string + donation_urls?: DonationLinkV2[] + gallery?: GalleryImageV2[] + color?: number + thread_id: string + monetization_status: MonetizationStatus +} + +export type SearchResultHit = { + project_id: string + project_type: ProjectType + slug: string + author: string + title: string + description: string + categories: string[] + display_categories: string[] + versions: string[] + downloads: number + follows: number + icon_url: string + date_created: string + date_modified: string + latest_version?: string + license: string + client_side: Environment + server_side: Environment + gallery: string[] + color?: number +} + +export type SearchResult = { + hits: SearchResultHit[] + offset: number + limit: number + total_hits: number +} + +export type ProjectSearchParams = { + query?: string + facets?: string[][] + filters?: string + index?: 'relevance' | 'downloads' | 'follows' | 'newest' | 'updated' + offset?: number + limit?: number +} diff --git a/packages/api-client/src/modules/labrinth/projects/types/v3.ts b/packages/api-client/src/modules/labrinth/projects/types/v3.ts new file mode 100644 index 0000000000..3b23f86be7 --- /dev/null +++ b/packages/api-client/src/modules/labrinth/projects/types/v3.ts @@ -0,0 +1,54 @@ +import type { MonetizationStatus, ProjectStatus } from './v2' + +export type GalleryItemV3 = { + url: string + raw_url: string + featured: boolean + name?: string + description?: string + created: string + ordering: number +} + +export type LinkV3 = { + platform: string + donation: boolean + url: string +} + +export type ProjectV3 = { + id: string + slug?: string + project_types: string[] + games: string[] + team_id: string + organization?: string + name: string + summary: string + description: string + published: string + updated: string + approved?: string + queued?: string + status: ProjectStatus + requested_status?: ProjectStatus + license: { + id: string + name: string + url?: string + } + downloads: number + followers: number + categories: string[] + additional_categories: string[] + loaders: string[] + versions: string[] + icon_url?: string + link_urls: Record + gallery: GalleryItemV3[] + color?: number + thread_id: string + monetization_status: MonetizationStatus + side_types_migration_review_status: 'reviewed' | 'pending' + [key: string]: unknown +} diff --git a/packages/api-client/src/modules/labrinth/projects/v2.ts b/packages/api-client/src/modules/labrinth/projects/v2.ts new file mode 100644 index 0000000000..b14c80fff5 --- /dev/null +++ b/packages/api-client/src/modules/labrinth/projects/v2.ts @@ -0,0 +1,112 @@ +import { AbstractModule } from '../../../core/abstract-module' +import type { ProjectSearchParams, ProjectV2, SearchResult } from './types/v2' + +export class LabrinthProjectsV2Module extends AbstractModule { + public getModuleID(): string { + return 'labrinth_projects_v2' + } + + /** + * Get a project by ID or slug + * + * @param id - Project ID or slug (e.g., 'sodium' or 'AANobbMI') + * @returns Promise resolving to the project data + * + * @example + * ```typescript + * const project = await client.labrinth.projects_v2.get('sodium') + * console.log(project.title) // "Sodium" + * ``` + */ + public async get(id: string): Promise { + return this.client.request(`/project/${id}`, { + api: 'labrinth', + version: 2, + method: 'GET', + }) + } + + /** + * Get multiple projects by IDs + * + * @param ids - Array of project IDs or slugs + * @returns Promise resolving to array of projects + * + * @example + * ```typescript + * const projects = await client.labrinth.projects_v2.getMultiple(['sodium', 'lithium', 'phosphor']) + * ``` + */ + public async getMultiple(ids: string[]): Promise { + return this.client.request(`/projects`, { + api: 'labrinth', + version: 2, + method: 'GET', + params: { ids: JSON.stringify(ids) }, + }) + } + + /** + * Search projects + * + * @param params - Search parameters (query, facets, filters, etc.) + * @returns Promise resolving to search results + * + * @example + * ```typescript + * const results = await client.labrinth.projects_v2.search({ + * query: 'optimization', + * facets: [['categories:optimization'], ['project_type:mod']], + * limit: 20 + * }) + * ``` + */ + public async search(params: ProjectSearchParams): Promise { + return this.client.request(`/search`, { + api: 'labrinth', + version: 2, + method: 'GET', + params: params as Record, + }) + } + + /** + * Edit a project + * + * @param id - Project ID or slug + * @param data - Project update data + * + * @example + * ```typescript + * await client.labrinth.projects_v2.edit('sodium', { + * description: 'Updated description' + * }) + * ``` + */ + public async edit(id: string, data: Partial): Promise { + return this.client.request(`/project/${id}`, { + api: 'labrinth', + version: 2, + method: 'PATCH', + body: data, + }) + } + + /** + * Delete a project + * + * @param id - Project ID or slug + * + * @example + * ```typescript + * await client.labrinth.projects_v2.delete('my-project') + * ``` + */ + public async delete(id: string): Promise { + return this.client.request(`/project/${id}`, { + api: 'labrinth', + version: 2, + method: 'DELETE', + }) + } +} diff --git a/packages/api-client/src/modules/labrinth/projects/v3.ts b/packages/api-client/src/modules/labrinth/projects/v3.ts new file mode 100644 index 0000000000..0dd397d074 --- /dev/null +++ b/packages/api-client/src/modules/labrinth/projects/v3.ts @@ -0,0 +1,70 @@ +import { AbstractModule } from '../../../core/abstract-module' +import type { ProjectV3 } from './types/v3' + +export class LabrinthProjectsV3Module extends AbstractModule { + public getModuleID(): string { + return 'labrinth_projects_v3' + } + + /** + * Get a project by ID or slug (v3) + * + * @param id - Project ID or slug (e.g., 'sodium' or 'AANobbMI') + * @returns Promise resolving to the v3 project data + * + * @example + * ```typescript + * const project = await client.labrinth.projects_v3.get('sodium') + * console.log(project.project_types) // v3 field + * ``` + */ + public async get(id: string): Promise { + return this.client.request(`/project/${id}`, { + api: 'labrinth', + version: 3, + method: 'GET', + }) + } + + /** + * Get multiple projects by IDs (v3) + * + * @param ids - Array of project IDs or slugs + * @returns Promise resolving to array of v3 projects + * + * @example + * ```typescript + * const projects = await client.labrinth.projects_v3.getMultiple(['sodium', 'lithium']) + * ``` + */ + public async getMultiple(ids: string[]): Promise { + return this.client.request(`/projects`, { + api: 'labrinth', + version: 3, + method: 'GET', + params: { ids: JSON.stringify(ids) }, + }) + } + + /** + * Edit a project (v3) + * + * @param id - Project ID or slug + * @param data - Project update data (v3 fields) + * + * @example + * ```typescript + * await client.labrinth.projects_v3.edit('sodium', { + * environment: 'client_and_server' + * }) + * ``` + */ + public async edit(id: string, data: Partial): Promise { + return this.client.request(`/project/${id}`, { + api: 'labrinth', + version: 3, + method: 'PATCH', + body: data, + }) + } +} diff --git a/packages/api-client/src/modules/types.ts b/packages/api-client/src/modules/types.ts new file mode 100644 index 0000000000..6540671ed8 --- /dev/null +++ b/packages/api-client/src/modules/types.ts @@ -0,0 +1,2 @@ +export * from './labrinth/projects/types/v2' +export * from './labrinth/projects/types/v3' diff --git a/packages/api-client/src/platform/generic.ts b/packages/api-client/src/platform/generic.ts new file mode 100644 index 0000000000..6d4c3280b6 --- /dev/null +++ b/packages/api-client/src/platform/generic.ts @@ -0,0 +1,51 @@ +import { $fetch, FetchError } from 'ofetch' + +import { AbstractModrinthClient } from '../core/abstract-client' +import type { ModrinthApiError } from '../core/errors' +import type { RequestOptions } from '../types/request' + +/** + * Generic platform client using ofetch + * + * This client works in any JavaScript environment (Node.js, browser, workers). + * + * @example + * ```typescript + * const client = new GenericModrinthClient({ + * userAgent: 'my-app/1.0.0', + * features: [ + * new AuthFeature({ token: 'mrp_...' }), + * new RetryFeature({ maxAttempts: 3 }) + * ] + * }) + * + * const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 }) + * ``` + */ +export class GenericModrinthClient extends AbstractModrinthClient { + protected async executeRequest(url: string, options: RequestOptions): Promise { + try { + const response = await $fetch(url, { + method: options.method ?? 'GET', + headers: options.headers, + body: options.body as BodyInit, + params: options.params as Record, + timeout: options.timeout, + signal: options.signal, + }) + + return response + } catch (error) { + // ofetch throws FetchError for HTTP errors + throw this.normalizeError(error) + } + } + + protected normalizeError(error: unknown): ModrinthApiError { + if (error instanceof FetchError) { + return this.createNormalizedError(error, error.response?.status, error.data) + } + + return super.normalizeError(error) + } +} diff --git a/packages/api-client/src/platform/nuxt.ts b/packages/api-client/src/platform/nuxt.ts new file mode 100644 index 0000000000..b4daecc573 --- /dev/null +++ b/packages/api-client/src/platform/nuxt.ts @@ -0,0 +1,113 @@ +import { FetchError } from 'ofetch' + +import { AbstractModrinthClient } from '../core/abstract-client' +import type { ModrinthApiError } from '../core/errors' +import type { CircuitBreakerState, CircuitBreakerStorage } from '../features/circuit-breaker' +import type { ClientConfig } from '../types/client' +import type { RequestOptions } from '../types/request' + +/** + * Circuit breaker storage using Nuxt's useState + * + * This provides cross-request persistence in SSR while also working in client-side. + * State is shared between requests in the same Nuxt context. + */ +export class NuxtCircuitBreakerStorage implements CircuitBreakerStorage { + private getState(): Map { + // @ts-expect-error - useState is provided by Nuxt runtime + const state = useState>( + 'circuit-breaker-state', + () => new Map(), + ) + return state.value + } + + get(key: string): CircuitBreakerState | undefined { + return this.getState().get(key) + } + + set(key: string, state: CircuitBreakerState): void { + this.getState().set(key, state) + } + + clear(key: string): void { + this.getState().delete(key) + } +} + +/** + * Nuxt-specific configuration + */ +export interface NuxtClientConfig extends ClientConfig { + // TODO: do we want to provide this for tauri+base as well? its not used on app + /** + * Rate limit key for server-side requests + * This is injected as x-ratelimit-key header on server-side + */ + rateLimitKey?: string +} + +/** + * Nuxt platform client using Nuxt's $fetch + * + * This client is optimized for Nuxt applications and handles SSR/CSR automatically. + * + * @example + * ```typescript + * // In a Nuxt composable + * const config = useRuntimeConfig() + * const auth = await useAuth() + * + * const client = new NuxtModrinthClient({ + * userAgent: 'my-nuxt-app/1.0.0', + * rateLimitKey: import.meta.server ? config.rateLimitKey : undefined, + * features: [ + * new AuthFeature({ token: () => auth.value.token }) + * ] + * }) + * + * const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 }) + * ``` + */ +export class NuxtModrinthClient extends AbstractModrinthClient { + protected declare config: NuxtClientConfig + + protected async executeRequest(url: string, options: RequestOptions): Promise { + try { + // @ts-expect-error - $fetch is provided by Nuxt runtime + const response = await $fetch(url, { + method: options.method ?? 'GET', + headers: options.headers, + body: options.body, + params: options.params, + timeout: options.timeout, + signal: options.signal, + }) + + return response + } catch (error) { + throw this.normalizeError(error) + } + } + + protected normalizeError(error: unknown): ModrinthApiError { + if (error instanceof FetchError) { + return this.createNormalizedError(error, error.response?.status, error.data) + } + + return super.normalizeError(error) + } + + protected buildDefaultHeaders(): Record { + const headers: Record = { + ...super.buildDefaultHeaders(), + } + + // @ts-expect-error - import.meta is provided by Nuxt + if (import.meta.server && this.config.rateLimitKey) { + headers['x-ratelimit-key'] = this.config.rateLimitKey + } + + return headers + } +} diff --git a/packages/api-client/src/platform/tauri.ts b/packages/api-client/src/platform/tauri.ts new file mode 100644 index 0000000000..7eef86918b --- /dev/null +++ b/packages/api-client/src/platform/tauri.ts @@ -0,0 +1,102 @@ +import { AbstractModrinthClient } from '../core/abstract-client' +import type { ModrinthApiError } from '../core/errors' +import type { ClientConfig } from '../types/client' +import type { RequestOptions } from '../types/request' + +/** + * Tauri-specific configuration + * TODO: extend into interface if needed. + */ +export type TauriClientConfig = ClientConfig + +/** + * Extended error type with HTTP response metadata + */ +interface HttpError extends Error { + statusCode?: number + responseData?: unknown +} + +/** + * Tauri platform client using Tauri v2 HTTP plugin + + * @example + * ```typescript + * import { getVersion } from '@tauri-apps/api/app' + * + * const version = await getVersion() + * const client = new TauriModrinthClient({ + * userAgent: `modrinth/theseus/${version} (support@modrinth.com)`, + * features: [ + * new AuthFeature({ token: 'mrp_...' }) + * ] + * }) + * + * const project = await client.request('/project/sodium', { api: 'labrinth', version: 2 }) + * ``` + */ +export class TauriModrinthClient extends AbstractModrinthClient { + protected declare config: TauriClientConfig + + protected async executeRequest(url: string, options: RequestOptions): Promise { + try { + // Dynamically import Tauri HTTP plugin + // This allows the package to be used in non-Tauri environments + const { fetch: tauriFetch } = await import('@tauri-apps/plugin-http') + + let body: BodyInit | null | undefined = undefined + if (options.body) { + if (typeof options.body === 'object' && !(options.body instanceof FormData)) { + body = JSON.stringify(options.body) + } else { + body = options.body as BodyInit + } + } + + let fullUrl = url + if (options.params) { + const queryParams = new URLSearchParams(options.params as Record).toString() + fullUrl = `${url}?${queryParams}` + } + + const response = await tauriFetch(fullUrl, { + method: options.method ?? 'GET', + headers: options.headers, + body, + }) + + if (!response.ok) { + let responseData: unknown + try { + responseData = await response.json() + } catch { + responseData = undefined + } + + const error = new Error(`HTTP ${response.status}: ${response.statusText}`) as HttpError + + error.statusCode = response.status + error.responseData = responseData + + throw error + } + + const data = await response.json() + return data as T + } catch (error) { + throw this.normalizeError(error) + } + } + + protected normalizeError(error: unknown): ModrinthApiError { + if (error instanceof Error) { + const httpError = error as HttpError + const statusCode = httpError.statusCode + const responseData = httpError.responseData + + return this.createNormalizedError(error, statusCode, responseData) + } + + return super.normalizeError(error) + } +} diff --git a/packages/api-client/src/tests/.gitkeep b/packages/api-client/src/tests/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/api-client/src/types/client.ts b/packages/api-client/src/types/client.ts new file mode 100644 index 0000000000..8080c31185 --- /dev/null +++ b/packages/api-client/src/types/client.ts @@ -0,0 +1,68 @@ +import type { AbstractFeature } from '../core/abstract-feature' +import type { RequestContext } from './request' + +/** + * Request lifecycle hooks + */ +export type RequestHooks = { + /** + * Called before request is sent (after all features have processed) + */ + onRequest?: (context: RequestContext) => void | Promise + + /** + * Called after successful response (before features process response) + */ + onResponse?: (data: T, context: RequestContext) => void | Promise + + /** + * Called when request fails (after all features have processed error) + */ + onError?: (error: Error, context: RequestContext) => void | Promise +} + +/** + * Client configuration + */ +export interface ClientConfig { + /** + * User agent string for requests + * Should identify your application (e.g., 'my-app/1.0.0') + * If not provided, the platform's default user agent will be used + */ + userAgent?: string + + /** + * Base URL for Labrinth API (main Modrinth API) + * @default 'https://api.modrinth.com' + */ + labrinthBaseUrl?: string + + /** + * Base URL for Archon API (Modrinth Servers API) + * @default 'https://archon.modrinth.com' + */ + archonBaseUrl?: string + + /** + * Default request timeout in milliseconds + * @default 10000 + */ + timeout?: number + + /** + * Additional default headers to include in all requests + */ + headers?: Record + + /** + * Features to enable for this client + * Features are applied in the order they appear in this array + */ + features?: AbstractFeature[] + + /** + * Request lifecycle hooks + */ + hooks?: RequestHooks +} diff --git a/packages/api-client/src/types/errors.ts b/packages/api-client/src/types/errors.ts new file mode 100644 index 0000000000..6e33b6d9a2 --- /dev/null +++ b/packages/api-client/src/types/errors.ts @@ -0,0 +1,56 @@ +/** + * Data for API errors + */ +export type ApiErrorData = { + /** + * HTTP status code (if available) + */ + statusCode?: number + + /** + * Original error that was caught + */ + originalError?: Error + + /** + * Response data from the API (if available) + */ + responseData?: unknown + + /** + * Error context (e.g., module name, operation being performed) + */ + context?: string +} + +/** + * Modrinth V1 error response format + * Used by kyros + archon APIs + */ +export type ModrinthErrorResponse = { + /** + * Error code/identifier + */ + error: string + + /** + * Human-readable error description + */ + description: string + + /** + * Optional context about where the error occurred + */ + context?: string +} + +/** + * Type guard to check if an object is a ModrinthErrorResponse + */ +export function isModrinthErrorResponse(obj: unknown): obj is ModrinthErrorResponse { + if (typeof obj !== 'object' || obj === null) { + return false + } + const record = obj as Record + return typeof record.error === 'string' && typeof record.description === 'string' +} diff --git a/packages/api-client/src/types/index.ts b/packages/api-client/src/types/index.ts new file mode 100644 index 0000000000..bec8c57c0b --- /dev/null +++ b/packages/api-client/src/types/index.ts @@ -0,0 +1,12 @@ +export type { FeatureConfig } from '../core/abstract-feature' +export type { AuthConfig } from '../features/auth' +export type { + CircuitBreakerConfig, + CircuitBreakerState, + CircuitBreakerStorage, +} from '../features/circuit-breaker' +export type { BackoffStrategy, RetryConfig } from '../features/retry' +export type { ClientConfig, RequestHooks } from './client' +export type { ApiErrorData, ModrinthErrorResponse } from './errors' +export { isModrinthErrorResponse } from './errors' +export type { HttpMethod, RequestContext, RequestOptions, ResponseData } from './request' diff --git a/packages/api-client/src/types/request.ts b/packages/api-client/src/types/request.ts new file mode 100644 index 0000000000..a9383cfb3e --- /dev/null +++ b/packages/api-client/src/types/request.ts @@ -0,0 +1,131 @@ +/** + * HTTP method types + */ +export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' + +/** + * Options for making a request + */ +export type RequestOptions = { + /** + * API to use for this request + * - 'labrinth': Main Modrinth API (resolves to labrinthBaseUrl) + * - 'archon': Modrinth Servers API (resolves to archonBaseUrl) + * - string: Custom base URL (e.g., 'https://custom-api.com') + */ + api: 'labrinth' | 'archon' | string + + /** + * API version to use + * - number: version number (e.g., 2 for v2, 3 for v3) + * - 'internal': use internal API + */ + version: number | 'internal' + + /** + * HTTP method to use + * @default 'GET' + */ + method?: HttpMethod + + /** + * Request headers + */ + headers?: Record + + /** + * Request body (will be JSON stringified if object) + */ + body?: unknown + + /** + * URL query parameters + */ + params?: Record + + /** + * Request timeout in milliseconds + */ + timeout?: number + + /** + * Abort signal for cancelling requests + */ + signal?: AbortSignal + + /** + * Retry configuration for this specific request + * - false: no retries + * - true: use default retry config + * - number: max retry attempts + */ + retry?: boolean | number + + /** + * Circuit breaker configuration for this specific request + * - false: disable circuit breaker + * - true: use default circuit breaker config + */ + circuitBreaker?: boolean + + /** + * Whether to skip authentication for this request + * @default false + */ + skipAuth?: boolean +} + +/** + * Full context passed to features during request execution + */ +export type RequestContext = { + /** + * Full URL being requested (with base URL and versioning applied) + */ + url: string + + /** + * Original path (before base URL and versioning) + */ + path: string + + /** + * Request options + */ + options: RequestOptions + + /** + * Current attempt number (1-indexed) + */ + attempt: number + + /** + * Timestamp when request started + */ + startTime: number + + /** + * Additional metadata that features can attach + */ + metadata?: Record +} + +/** + * Generic response wrapper + */ +export type ResponseData = { + /** + * Response data + */ + data: T + + /** + * HTTP status code + */ + status: number + + /** + * Response headers + */ + headers: Record +} diff --git a/packages/api-client/tsconfig.json b/packages/api-client/tsconfig.json new file mode 100644 index 0000000000..e8bc1a8a6b --- /dev/null +++ b/packages/api-client/tsconfig.json @@ -0,0 +1,3 @@ +{ + "extends": "@modrinth/tooling-config/typescript/base.json" +} diff --git a/packages/tooling-config/eslint/base.mjs b/packages/tooling-config/eslint/base.mjs index 587ff5a16c..a9d3def75d 100644 --- a/packages/tooling-config/eslint/base.mjs +++ b/packages/tooling-config/eslint/base.mjs @@ -1,10 +1,10 @@ import eslint from '@eslint/js' import prettierEslint from 'eslint-plugin-prettier/recommended' import tseslint from 'typescript-eslint' +import common from './common.mjs' export default tseslint.config( eslint.configs.recommended, - tseslint.configs.recommendedTypeChecked, prettierEslint, ...common, { diff --git a/packages/ui/src/providers/api.ts b/packages/ui/src/providers/api.ts deleted file mode 100644 index b808b2a0e9..0000000000 --- a/packages/ui/src/providers/api.ts +++ /dev/null @@ -1,5 +0,0 @@ -import type { ModrinthApi } from '@modrinth/utils' - -import { createContext } from '.' - -export const [injectApi, provideApi] = createContext('root', 'apiContext') diff --git a/packages/utils/api/default_impl.ts b/packages/utils/api/default_impl.ts deleted file mode 100644 index 79981d2e6e..0000000000 --- a/packages/utils/api/default_impl.ts +++ /dev/null @@ -1,41 +0,0 @@ -import type { Project, ProjectV3Partial } from '../types' -import type { ModrinthApi } from './index' -import type { ModrinthApiProjects, ProjectEditBody, ProjectV3EditBodyPartial } from './projects' - -export class RestModrinthApi implements ModrinthApi { - projects: ModrinthApiProjects - - constructor(requestApi: (url: string, options?: object) => Promise) { - this.projects = new RestModrinthApiProjects(requestApi) - } -} - -class RestModrinthApiProjects implements ModrinthApiProjects { - constructor(private request: (url: string, options?: object) => Promise) {} - - async get(id: string): Promise { - const res = await this.request(`/v2/project/${id}`) - return res.json() - } - - async getV3(id: string): Promise { - const res = await this.request(`/v3/project/${id}`) - return res.json() - } - - async edit(id: string, data: ProjectEditBody): Promise { - await this.request(`/v2/project/${id}`, { - method: 'PATCH', - headers: { 'Content-Type': 'application/json' }, - body: JSON.stringify(data), - }) - } - - async editV3(id: string, data: ProjectV3EditBodyPartial): Promise { - await this.request(`/v3/project/${id}`, { - method: 'PATCH', - headers: { 'Content-Type': 'application/json' }, - body: JSON.stringify(data), - }) - } -} diff --git a/packages/utils/api/index.ts b/packages/utils/api/index.ts deleted file mode 100644 index 8dd1355cf3..0000000000 --- a/packages/utils/api/index.ts +++ /dev/null @@ -1,7 +0,0 @@ -import type { ModrinthApiProjects } from './projects' - -export interface ModrinthApi { - projects: ModrinthApiProjects -} - -export { RestModrinthApi } from './default_impl' diff --git a/packages/utils/api/projects.ts b/packages/utils/api/projects.ts deleted file mode 100644 index 71f2658023..0000000000 --- a/packages/utils/api/projects.ts +++ /dev/null @@ -1,41 +0,0 @@ -import type { - DonationLink, - DonationPlatform, - Environment, - EnvironmentMigrationReviewStatus, - EnvironmentV3, - Project, - ProjectStatus, - ProjectV3Partial, - RequestableStatus, -} from '../types' - -export type ProjectEditBody = { - slug?: string - title?: string - description?: string - categories?: string[] - client_side?: Environment - server_side?: Environment - status?: ProjectStatus - requested_status?: RequestableStatus - additional_categories?: string[] - issues_url?: string - source_url?: string - wiki_url?: string - discord_url?: string - donation_urls?: DonationLink[] - license_id?: string - license_url?: string -} -export type ProjectV3EditBodyPartial = { - environment?: EnvironmentV3 - side_types_migration_review_status: EnvironmentMigrationReviewStatus -} - -export interface ModrinthApiProjects { - get(id: string): Promise - getV3(id: string): Promise - edit(id: string, data: ProjectEditBody): Promise - editV3(id: string, data: ProjectV3EditBodyPartial): Promise -} diff --git a/packages/utils/index.ts b/packages/utils/index.ts index 8ddeeb3937..26df429f62 100644 --- a/packages/utils/index.ts +++ b/packages/utils/index.ts @@ -1,4 +1,3 @@ -export * from './api' export * from './billing' export * from './changelog' export * from './highlightjs' diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7be2c8cf74..1e1146974f 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -218,6 +218,9 @@ importers: '@ltd/j-toml': specifier: ^1.38.0 version: 1.38.0 + '@modrinth/api-client': + specifier: workspace:* + version: link:../../packages/api-client '@modrinth/assets': specifier: workspace:* version: link:../../packages/assets @@ -387,6 +390,19 @@ importers: apps/labrinth: {} + packages/api-client: + dependencies: + '@tauri-apps/plugin-http': + specifier: ^2.0.0 + version: 2.5.0 + ofetch: + specifier: ^1.4.1 + version: 1.4.1 + devDependencies: + '@modrinth/tooling-config': + specifier: workspace:* + version: link:../tooling-config + packages/app-lib: {} packages/assets: