Core library for parsing NSIDs in the AT Protocol standard 🦋

GitHub Sponsor GitHub Sponsor

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

1. Guide 🌎

This library provides the easiest way to use NSID supported by AT Protocol in Dart and Flutter apps.

Give a ⭐ on GitHub repository and follow shinyakato.dev on Bluesky!

1.1. Getting Started ⚡

1.1.1. Install Library

With Dart:

 dart pub add nsid

Or With Flutter:

 flutter pub add nsid

1.1.2. Import

import 'package:nsid/nsid.dart';

1.1.3. Implementation

import 'package:nsid/nsid.dart';

void main(List<String> args) {
  final id1 = NSID.parse('com.example.foo');
  id1.authority; // => 'example.com'
  id1.name; // => 'foo'
  id1.toString(); // => 'com.example.foo'

  final id2 = NSID.create('example.com', 'foo');
  id2.authority; // => 'example.com'
  id2.name; // => 'foo'
  id2.toString(); // => 'com.example.foo'

  final id3 = NSID.create('example.com', '*');
  id3.authority; // => 'example.com'
  id3.name; // => '*'
  id3.toString(); // => 'com.example.*'

1.2. Contribution 🏆

If you would like to contribute to nsid, 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.3. 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:


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

Powered by nsid Powered by nsid Powered by nsid

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

1.4. License 🔑

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

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

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.5. More Information 🧐

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