The audiobookshelf_api from audiobookshelf-flutter

Use Audiobookshelf API flutter package

The app should use the api package instead of including it as a sub project.

Cache Endpoints

Add all the cache endpoints to the cache service.

Purge All Cache
Purge Items Cache

Filesystem Endpoints

Add all the filesystem endpoints to the filesystem service.

Me Endpoints

Add all the me endpoints to the me service.

Backups Endpoints

Add all the backups endpoints to the backups service.

LibrarySearchResult.book and LibrarySearchResult.podcast should be lists of LibraryItemSearchResult

class LibrarySearchResponse with _$LibrarySearchResponse {
  const factory LibrarySearchResponse.book({
    required LibraryItemSearchResult book,
    required List<String> tags,
    required List<Author> authors,
    required List<Series> series,
  }) = BookLibrarySearchResponse;

  const factory LibrarySearchResponse.podcast({
    required LibraryItemSearchResult podcast,
    required List<String> tags,
    required List<Author> authors,
    required List<Series> series,
  }) = PodcastLibrarySearchResponse;

  factory LibrarySearchResponse.fromJson(Map<String, dynamic> json) =>
      LibrarySearchResponseConverter().fromJson(json);
}

class LibrarySearchResponse with _$LibrarySearchResponse {
  const factory LibrarySearchResponse.book({
    required List<LibraryItemSearchResult> book,
    required List<String> tags,
    required List<Author> authors,
    required List<Series> series,
  }) = BookLibrarySearchResponse;

  const factory LibrarySearchResponse.podcast({
    required LibraryItemSearchResult podcast,
    required List<String> tags,
    required List<Author> authors,
    required List<Series> series,
  }) = PodcastLibrarySearchResponse;

  factory LibrarySearchResponse.fromJson(Map<String, dynamic> json) =>
      LibrarySearchResponseConverter().fromJson(json);
}

Notifications Endpoints

Add all the notifications endpoints to the notifications service.

Publish to pub.dev

I think this package is just about ready for publishing. Here are the final tasks that I've thought of. I'll add any others that are suggested.

Authors Endpoints

Add all the authors endpoints to the authors service.

Removal of `ResponseErrorHandler`

I'm thinking about removing ResponseErrorHandler and it's corresponding function arguments that are in every endpoint, stemming from AudiobookshelfApi.requestJson(). This would also make the return types of those functions non-nullable.
The original idea of ResponseErrorHandler was to provide a place where the caller could have access to the original http.Response when doing JSON conversion and something went wrong. An alternative solution for this is to catch all throws from fromJson(), wrap it in a new error type that also includes the http.Response, and throw that.

@keaganhilliard, I would like your thoughts on this.

Misc Endpoints

Add all the misc endpoints to the misc service.

Query Parameters all have to be Strings or Lists of Strings

Fun fact about http calls in dart. They will fail if pass anything other than a string or list of strings into the query parameters.

class BoolBinaryConverter implements JsonConverter<bool, int> {
  const BoolBinaryConverter();

  @override
  bool fromJson(int json) => json == 1;

  @override
  int toJson(bool object) => object ? 1 : 0;
}

This causes items.get requests to fail. To use this in a query parameter it has to either be '1' or '0'. So you could potentially explicitly call toString() on any parameters or coerce parameter attributes to strings.

Sessions Endpoints

Add all the sessions endpoints to the sessions service.

Restructure

I would like to restructure the package so that it works similar to the GitHub Dart package. See this file for reference. Essentially, I want to break up each part of the API into its own "service". So for example, to get all libraries, you would do api.libraries.getAll().

Tools Endpoints

Add all the tools endpoints to the tools service.

Encode a Book as M4B
Cancel an M4B Encode Task
Update a Library Item's Audio Files' Embedded Metadata

Search for Series
Get a Series
Update a Series

Users Endpoints

Add all the users endpoints to the users service.

Endpoint Services

Add all the endpoints for each service of each section on the docs.

audiobookshelf-flutter / audiobookshelf_api Goto Github PK

audiobookshelf_api's People

Contributors

Stargazers

Watchers

Forkers

audiobookshelf_api's Issues

Recommend Projects

Recommend Topics

Recommend Org