lemmurorg / lemmy_api_client Goto Github PK

Dart lemmy client

License: MIT License

Dart 100.00%

dart dartlang hacktoberfest

lemmy_api_client's Introduction

⚠️ THIS PROJECT IS NOT MAINTAINED ANYMORE ⚠️

This project has been officially dropped due to lack of interest and political differences. If anyone is interested in continuing developement, feel free to fork it. For any questions you can message krawieck (who was responsible for the flutter app) or shilangyu (who was responsible for lemmy_api_client).

Lemmy Dart API client

A Dart client for the Lemmy API

Features

Future-based
Works both for Web and Native environments
Strictly typed responses
Room websocket joins
Pictrs endpoints
Models have a .instanceHost property that indicate the instance that returned this model

Example

import 'package:lemmy_api_client/v3.dart';

Future<void> main() async {
  // instantiate your lemmy instance with the host uri
  const lemmy = LemmyApiV3('lemmy.ml');

  // call methods that are named after op codes from the lemmy docs
  final response =
      await lemmy.run(const Login(usernameOrEmail: 'asd', password: 'ads'));

  final messages = await lemmy
      .run(GetPrivateMessages(unreadOnly: true, auth: response.jwt!.raw));

  print(messages);
}

check out Lemmur, a mobile Lemmy client in Flutter

Original Lemmy logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license. Remixed by Marcin Wojnarowski (@shilangyu) and re-released under the CC-BY-SA 4.0 license.

lemmy_api_client's People

Contributors

Stargazers

Watchers

Forkers

piconnectdev louismarotta thiur dangilbert anna-log7 79623798464325 genfood anlumo pixelsnake winnleong hkgranli dennisaurus-rex

lemmy_api_client's Issues

Add tests for the websocket interface

I can already see that streamed models are not augmented with the instance_host field, which would cause a deserialization error in some cases.

Support Lemmy API v2

So we're finalizing and readying the release of the v2 of the lemmy API within a week or two. I've updated lemmy-js-client, which is what lemmy-ui uses, and you'll have to do a similar process for this dart client, and lemmur.

Here's the docs for the v2 API, which mostly link to the lemmy-js-client, which has the full typings:

https://github.com/LemmyNet/lemmy-docs/blob/main/src/en/contributing/websocket_http_api.md#data-types

The biggest differences you'll find are that the objects are much more hierarchical and normalized; rather than having a flat PostView, with things like community_name at the top level, you now have hierarchical objects:

export interface PostView {
    post: Post;
    creator: UserSafe;
    community: CommunitySafe;
    creator_banned_from_community: boolean;
    counts: PostAggregates;
    subscribed: boolean;
    saved: boolean;
    read: boolean;
    my_vote?: number;
}

All of these new types, forms, etc are linked in the docs above. Rather than find specific differences, it might be easier to just copy paste the typescript objects, then convert them to dart (I actually did this process going from rust -> typescript, to make sure everything matched exactly).

Let me know if there's anything I can do to help with this effort.

If you need an instance to test these with, https://enterprise.lemmy.ml and all the federation instances are using it.

cc @Nutomic

regular stuff

indirect models

tests are written
implementation is written
tests pass