https://github.com/erb3/jsrinth

Unofficial modrinth API wrapper in TypeScript
https://github.com/erb3/jsrinth

api-bindings minecraft minecraft-modding modrinth modrinth-api rinth

Last synced: 30 days ago
JSON representation

Unofficial modrinth API wrapper in TypeScript

• Host: GitHub
• URL: https://github.com/erb3/jsrinth
• Owner: Erb3
• License: mpl-2.0
• Created: 2023-06-30T14:42:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-09T11:33:14.000Z (5 months ago)
• Last Synced: 2024-08-09T13:25:11.000Z (5 months ago)
• Topics: api-bindings, minecraft, minecraft-modding, modrinth, modrinth-api, rinth
• Language: TypeScript
• Homepage:
• Size: 191 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 JSRinth 



  Unofficial Modrinth API wrapper in Typescript with zero dependencies and full test coverage

  



  



> [!WARNING]

> JSRinth is still in early development, and should probably not be used in production.

## Contributing

We use `bun` for development, but you can use the library Node.js or even web!

> [!IMPORTANT]

> When using with Node.js make sure you are on version v18 or above.

> Otherwise you won't have access to fetch function.

### Install dependencies

Run `bun i`

### Running tests

Run `bun test`

## To-do

- [ ] Linter

- [ ] Formatter

- [x] User-Agent

- [ ] Projects

  - [ ] Search

  - [ ] Get

  - [ ] Edit

  - [ ] Delete

  - [ ] Bulk get

  - [ ] Bulk edit

  - [ ] Random

  - [ ] Create

  - [ ] Change icon

  - [ ] Remove icon

  - [ ] Validate slug / ID

  - [ ] Add gallery image

  - [ ] Edit gallery image

  - [ ] Remove gallery image

  - [ ] Get dependencies

  - [ ] Follow

  - [ ] Unfollow

  - [ ] Schedule publication

- [ ] Versions

  - [ ] List project versions

  - [ ] Get

  - [ ] Edit

  - [ ] Remove

  - [ ] Create

  - [ ] Schedule

  - [ ] Bulk get

  - [ ] Add files

  - [ ] Get by hash

  - [ ] Delete by hash

  - [ ] Bulk get by hash

- [ ] Users

  - [ ] Get

  - [ ] Edit

  - [ ] Get from PAT

  - [ ] Bulk get

  - [ ] Edit avatar

  - [ ] Get projects

  - [ ] Get followed

  - [ ] Get payout history

  - [ ] Withdraw

- [ ] Notifications

  - [ ] Get

  - [ ] Get by ID

  - [ ] Mark as read

  - [ ] Remove

  - [ ] Bulk get

  - [ ] Bulk mark as read

  - [ ] Bulk remove

- [ ] Threads

  - [ ] Get reports

  - [ ] Get report by ID

  - [ ] Edit report

  - [ ] Bulk get reports

  - [ ] Get thread

  - [ ] Send thread message

  - [ ] Bulk get threads

  - [ ] Remove thread message

- [ ] Teams

  - [ ] Get by project

  - [ ] Get by ID

  - [ ] Add user

  - [ ] Bulk get by ID

  - [ ] Join team

  - [ ] Edit team member

  - [ ] Remove team member

  - [ ] Transfer ownership

- [ ] Tags

  - [x] Get categories

  - [ ] Get loaders

  - [ ] Get game versions

  - [ ] Get title + content of license

  - [ ] Get donation platforms

  - [ ] Get report types

  - [ ] Get project types

  - [ ] Get project-side types

- [x] Misc

  - [x] Node statistics

  - [x] Forge updates

## What to implement

JSRinth should **not** implement API endpoints not featured om the API documentation.

## Copyright disclaimer

> [!Important]

> Modrinth is property of Rinth Inc. JSRinth is in no way shape or form affiliated with Rinth Inc.