[Feature Request] BookOrbit service widget

[spocoeric]

Description

BookOrbit now includes API. Any chance a service widget can be made?

Other

https://github.com/bookorbit/bookorbit

[drinksomewhiskey]

@shamoon - disclaimer AI assisted, but I reviewed code and validated against a live BookOrbit instance. I'm holding off on a PR until the feature request reaches 20 upvotes. I am happy to open a PR when ready.

I've built this branch here: https://github.com/drinksomewhiskey/homepage/tree/feature/bookorbit-widget

The BookOrbit widget shows libraries, books, reading and finished. BookOrbit issues short-lived access tokens rather than API keys, so the widget signs in with a username and password and renews the token as it expires (similar to Booklore's widget).

widget:
  type: bookorbit
  url: https://bookorbit.host.or.ip
  username: username
  password: password
  libraries: [eBooks, Audiobooks] # optional, defaults to all if excluded
  combine: false # optional, defaults to true

Option	Values
libraries	all for every library in BookOrbit, or names or ids for specific libraries: eBooks, [eBooks, Audiobooks], [1, 2]
combine	true for one aggregate row, false for a row per library

I realize the guidelines say 1 row per widget. I allowed for multiple rows in this build to show ebooks and audiobooks in one widget since BookOrbit services both. I can limit to one row (i.e., all or one selected library) if required.

Wrap more than one value in []: libraries: [eBooks, Audiobooks]. A single value needs no brackets.

A library of audiobooks is labelled "Listening" rather than "Reading".

For anyone eager to try it out / provide feedback... It needs a custom image until it's merged:

git clone -b feature/bookorbit-widget https://github.com/drinksomewhiskey/homepage.git
cd homepage && docker build -t homepage:bookorbit .

then point your compose image: at homepage:bookorbit.

[spocoeric]

I'm holding off on a PR until the feature request reaches 20 upvotes. I am happy to open a PR when ready.

I hope a few others show some interest here, as I deploy homepage via a Proxmox LXC, and switching to a fork is a pain.

Regardless, looks like some great work @drinksomewhiskey, thank you!

[drinksomewhiskey]

Thank you. Guidelines state 20 upvotes and the widget must be one row:

https://gethomepage.dev/widgets/authoring/getting-started/#service-widget-guidelines

My current build allows for more than one row with the intention of detailing separate libraries (one per row). However, I don't think that will fly given the rules.

My thought is to update it and limit as a single row showing [Libraries Books Reading Finished], which I wasn't too fond of given the mix of media types BookOrbit handles (e.g., audiobooks or comics). I'm open to ideas and welcome suggestions.

[spocoeric]

For my personal use case, I only need eBooks, as I use other projects for comics and audiobooks. So a single row would be perfect. Would it be possible to limit to a single row, but include the option to select different media types? Maybe with differing default fields per type? That way anyone wanting those could just use multiple instances of the widget pointed to each library?