misskey

The Easiest and Powerful Dart/Flutter Library for Misskey API 🎯

GitHub Sponsor GitHub Sponsor

pub package Dart SDK Version Test Analyzer codecov Issues Pull Requests Stars Contributors Code size Last Commits License Contributor Covenant

1. Guide 🌎

This library provides the easiest way to use Misskey API in Dart and Flutter apps.

Show some ❤️ and star the repo to support the project.

1.1. Features 💎

✅ The wrapper library for Misskey API.
✅ Easily integrates with the Dart & Flutter apps.
✅ Provides response objects with a guaranteed safe types.
✅ Well documented and well tested.
✅ Supports the powerful automatic retry.

1.2. Getting Started ⚡

1.2.1. Install Library

With Dart:

 dart pub add misskey

Or With Flutter:

 flutter pub add misskey

1.2.2. Import

import 'package:misskey/misskey.dart';

1.2.3. Implementation

import 'package:misskey/misskey.dart';

Future<void> main() async {
  //! You need to specify misskey instance (domain) you want to access.
  final misskey = MisskeyApi(
    instance: 'misskey.io',
    accessToken: 'YOUR_ACCESS_TOKEN',

    //! Automatic retry is available when server error or network error occurs
    //! when communicating with the API.
    retryConfig: RetryConfig(
      maxAttempts: 5,
      onExecute: (event) => print(
        'Retry after ${event.intervalInSeconds} seconds...'
        '[${event.retryCount} times]',
      ),
    ),

    //! The default timeout is 10 seconds.
    timeout: Duration(seconds: 20),
  );

  try {
    final me = await misskey.accounts.lookupMe();

    print(me);
  } on UnauthorizedException catch (e) {
    print(e);
  } on RateLimitExceededException catch (e) {
    print(e);
  } on MisskeyException catch (e) {
    print(e);
  }
}

1.3. Supported Endpoints 👀

1.4. Tips 🏄

1.4.1. Method Names

misskey uses the following standard prefixes depending on endpoint characteristics. So it's very easy to find the method corresponding to the endpoint you want to use!

Prefix Description
lookup This prefix is attached to endpoints that reference toots, accounts, etc.
create This prefix is attached to the endpoint performing the create state.
destroy This prefix is attached to the endpoint performing the destroy state.

1.4.2. Null Parameter at Request

In this library, parameters that are not required at request time, i.e., optional parameters, are defined as nullable. However, developers do not need to be aware of the null parameter when sending requests when using this library.

It means the parameters specified with a null value are safely removed and ignored before the request is sent.

For example, arguments specified with null are ignored in the following request.

import 'package:misskey/misskey.dart';

Future<void> main() async {
  final misskey = MisskeyApi(
    instance: 'misskey.io',
    accessToken: 'YOUR_ACCESS_TOKEN',
  );

  await misskey.notes.createNote(
    text: 'Ai',

    //! These parameters are ignored at request because they are null.
    poll: null,
    sensitive: null,
  );
}

1.4.3. Change the Timeout Duration

The library specifies a default timeout of 10 seconds for all API communications.

However, there may be times when you wish to specify an arbitrary timeout duration. If there is such a demand, an arbitrary timeout duration can be specified as follows.

import 'package:misskey/misskey.dart';

Future<void> main() {
 final misskey = MisskeyApi(
    instance: 'misskey.io',
    accessToken: 'YOUR_ACCESS_TOKEN',

    //! The default timeout is 10 seconds.
    timeout: Duration(seconds: 20),
  );
}

1.4.4. Automatic Retry

Due to the nature of this library's communication with external systems, timeouts may occur due to inevitable communication failures or temporary crashes of the server to which requests are sent.

When such timeouts occur, an effective countermeasure in many cases is to send the request again after a certain interval. And misskey provides an automatic retry feature as a solution to this problem.

Also, errors subject to retry are as follows.

  • When the status code of the response returned from Misskey instance is 500 or 503.
  • When the network is temporarily lost and a SocketException is thrown.
  • When communication times out temporarily and a TimeoutException is thrown

1.4.4.1. Exponential Backoff and Jitter

Although the algorithm introduced earlier that exponentially increases the retry interval is already powerful, some may believe that it is not yet sufficient to distribute the sensation of retries. It's more distributed than equally spaced retries, but retries still occur at static intervals.

This problem can be solved by adding a random number called Jitter, and this method is called the Exponential Backoff and Jitter algorithm. By adding a random number to the exponentially increasing retry interval, the retry interval can be distributed more flexibly.

Similar to the previous example, misskey can be implemented as follows.

import 'package:misskey/misskey.dart';

Future<void> main() async {
  final misskey = MisskeyApi(
    instance: 'misskey.io',
    accessToken: 'YOUR_ACCESS_TOKEN',

    //! Add these lines.
    retryConfig: RetryConfig(
      maxAttempts: 3,
    ),
  );
}

In the above implementation, the interval increases exponentially for each retry count with jitter. It can be expressed by next formula.

(2 ^ retryCount) + jitter(Random Number between 0 ~ 3)

1.4.4.2. Do Something on Retry

It would be useful to output logging on retries and a popup notifying the user that a retry has been executed. So misskey provides callbacks that can perform arbitrary processing when retries are executed.

It can be implemented as follows.

import 'package:misskey/misskey.dart';

Future<void> main() async {
  final misskey = MisskeyApi(
    instance: 'misskey.io',
    accessToken: 'YOUR_ACCESS_TOKEN',
    retryConfig: RetryConfig(
      maxAttempts: 3,

      //! Add this line.
      onExecute: (event) => print('Retrying... ${event.retryCount} times.'),
    ),
  );
}

The RetryEvent passed to the callback contains information on retries.

1.4.5. Thrown Exceptions

misskey provides a convenient exception object for easy handling of exceptional responses and errors returned from Misskey API.

Exception Description
MisskeyException The most basic exception object. For example, it can be used to search for posts that have already been deleted, etc.
UnauthorizedException Thrown when authentication fails with the specified access token.
RateLimitExceededException Thrown when the request rate limit is exceeded.
DataNotFoundException Thrown when response has no body or data field in body string, or when 404 status is returned.

Also, all of the above exceptions thrown from the misskey process extend MisskeyException. This means that you can take all exceptions as MisskeyException or handle them as certain exception types, depending on the situation.

However note that, if you receive an individual type exception, be sure to define the process so that the individual exception type is cached before MisskeyException. Otherwise, certain type exceptions will also be caught as MisskeyException.

Therefore, if you need to catch a specific type of exception in addition to MisskeyException, be sure to catch MisskeyException in the bottom catch clause as in the following example.

import 'package:misskey/misskey.dart';

Future<void> main() async {
  final misskey = MisskeyApi(
    instance: 'misskey.io',
    accessToken: 'YOUR_ACCESS_TOKEN',
  );

  try {
    final response = await misskey.notes.createNote(text: 'Yay!');

    print(response);
  } on UnauthorizedException catch (e) {
    print(e);
  } on RateLimitExceededException catch (e) {
    print(e);
  } on MisskeyException catch (e) {
    print(e);
  }
}

1.5. Contribution 🏆

If you would like to contribute to misskey, please create an issue or create a Pull Request.

There are many ways to contribute to the OSS. For example, the following subjects can be considered:

  • There are request parameters or response fields that are not implemented.
  • Documentation is outdated or incomplete.
  • Have a better way or idea to achieve the functionality.
  • etc...

You can see more details from resources below:

Or you can create a discussion if you like.

Feel free to join this development, diverse opinions make software better!

1.6. Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

1.7. Support ❤️

The simplest way to show us your support is by giving the project a star at GitHub and Pub.dev.

You can also support this project by becoming a sponsor on GitHub:

myconsciousness

You can also show on your repository that your app is made with misskey by using one of the following badges:

Powered by misskey Powered by misskey Powered by misskey

[![Powered by misskey](https://img.shields.io/badge/Powered%20by-misskey-00acee.svg)](https://github.com/misskey-dart/misskey)
[![Powered by misskey](https://img.shields.io/badge/Powered%20by-misskey-00acee.svg?style=flat-square)](https://github.com/misskey-dart/misskey)
[![Powered by misskey](https://img.shields.io/badge/Powered%20by-misskey-00acee.svg?style=for-the-badge)](https://github.com/misskey-dart/misskey)

1.8. License 🔑

All resources of misskey is provided under the BSD-3 license.

Copyright 2023 Kato Shinya. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided the conditions.

Note
License notices in the source are strictly validated based on .github/header-checker-lint.yml. Please check header-checker-lint.yml for the permitted standards.

1.9. More Information 🧐

misskey was designed and implemented by Kato Shinya (@myConsciousness).

Libraries

misskey