diff --git a/CHANGELOG.md b/CHANGELOG.md index 6684847..a2cf2b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 1.3.0 +- Breaking change: /mcc/mcc.dart removed +- Docs fixes ## 1.2.2 - Fixed CurrencyInfo integer parsing error diff --git a/lib/currency/extensions/currency_countries.dart b/lib/currency/extensions/currency_countries.dart index 8698170..fa939e8 100644 --- a/lib/currency/extensions/currency_countries.dart +++ b/lib/currency/extensions/currency_countries.dart @@ -1 +1,10 @@ +/// Currency countries pack +/// +/// Adds reference information about in which countries +/// currencies are being used +/// +/// {@category Extensions} +/// {@subCategory Currency} +library currency_countries; + export '../../src/currency/extensions/countries.dart'; diff --git a/lib/currency/extensions/currency_names.dart b/lib/currency/extensions/currency_names.dart index e98129d..7faf205 100644 --- a/lib/currency/extensions/currency_names.dart +++ b/lib/currency/extensions/currency_names.dart @@ -1 +1,9 @@ +/// Currency names pack +/// +/// Adds reference information about how currencies are called +/// +/// {@category Extensions} +/// {@subCategory Currency} +library currency_names; + export '../../src/currency/extensions/names.dart'; diff --git a/lib/data/currency/currency_countries_dataset.dart b/lib/data/currency/currency_countries_dataset.dart index 5181a95..c01990f 100644 --- a/lib/data/currency/currency_countries_dataset.dart +++ b/lib/data/currency/currency_countries_dataset.dart @@ -1,3 +1,11 @@ +/// Currency countries dataset +/// +/// Contains info about possible countries some currencies are being used in +/// +/// {@category Datasets} +/// {@subCategory Currency} +library currency_countries_dataset; + const Map> Iso4217Countries = { '8': ['Albania'], '12': ['Algeria'], diff --git a/lib/data/currency/currency_names_dataset.dart b/lib/data/currency/currency_names_dataset.dart index fb64c91..ddbd884 100644 --- a/lib/data/currency/currency_names_dataset.dart +++ b/lib/data/currency/currency_names_dataset.dart @@ -1,3 +1,11 @@ +/// Currency names dataset +/// +/// Contains info about possible names of some currencies +/// +/// {@category Datasets} +/// {@subCategory Currency} +library currency_names_dataset; + const Map Iso4217Names = { '8': 'Lek', '12': 'Algerian Dinar', diff --git a/lib/data/currency/iso4217_dataset.dart b/lib/data/currency/iso4217_dataset.dart index bcaa259..73157cf 100644 --- a/lib/data/currency/iso4217_dataset.dart +++ b/lib/data/currency/iso4217_dataset.dart @@ -1,3 +1,11 @@ +/// ISO-4217 dataset +/// +/// Describes currencies: their number, code and digits +/// +/// {@category Datasets} +/// {@subCategory Currency} +library iso4217_dataset; + const List> Iso4217 = [ {'code': 'AED', 'number': 784, 'digits': 2}, {'code': 'AFN', 'number': 971, 'digits': 2}, diff --git a/lib/data/mcc/mcc_emoji_dataset.dart b/lib/data/mcc/mcc_emoji_dataset.dart index c653893..84965d9 100644 --- a/lib/data/mcc/mcc_emoji_dataset.dart +++ b/lib/data/mcc/mcc_emoji_dataset.dart @@ -1,3 +1,11 @@ +/// MCC emoji dataset +/// +/// Emoji representations for some MCCs +/// +/// {@category Datasets} +/// {@subCategory MCC} +library mcc_emoji_dataset; + const Map> MCCEmojiDataset = { '\uD83D\uDC15': [742, 5995], '\uD83D\uDE9C': [763], diff --git a/lib/data/mcc/mcc_english_dataset.dart b/lib/data/mcc/mcc_english_dataset.dart index b220268..0206295 100644 --- a/lib/data/mcc/mcc_english_dataset.dart +++ b/lib/data/mcc/mcc_english_dataset.dart @@ -1,3 +1,11 @@ +/// MCC English dataset +/// +/// English names for MCCs +/// +/// {@category Datasets} +/// {@subCategory MCC} +library mcc_english_dataset; + const Map MCCEnglishDataset = { '1520': 'General Contractors', '1711': 'Heating, Plumbing, A/C', diff --git a/lib/data/mcc/mcc_russian_dataset.dart b/lib/data/mcc/mcc_russian_dataset.dart index 2d165bf..587d1a9 100644 --- a/lib/data/mcc/mcc_russian_dataset.dart +++ b/lib/data/mcc/mcc_russian_dataset.dart @@ -1,3 +1,11 @@ +/// MCC Russian dataset +/// +/// Russian names for MCCs +/// +/// {@category Datasets} +/// {@subCategory MCC} +library mcc_russian_dataset; + const Map MCCRussianDataset = { '1520': 'Строительство. Подрядчики', '1711': 'Кондиционеры. Установка', diff --git a/lib/data/mcc/mcc_ukrainian_dataset.dart b/lib/data/mcc/mcc_ukrainian_dataset.dart index e4b4003..310560c 100644 --- a/lib/data/mcc/mcc_ukrainian_dataset.dart +++ b/lib/data/mcc/mcc_ukrainian_dataset.dart @@ -1,3 +1,11 @@ +/// MCC Ukrainian dataset +/// +/// Ukrainian names for MCCs +/// +/// {@category Datasets} +/// {@subCategory MCC} +library mcc_ukrainian_dataset; + const Map MCCUkrainianDataset = { '1520': 'Будівництво. Підрядники', '1711': 'Кондиціонери. Встановлення', diff --git a/lib/data/mcc/mcc_visuals_dataset.dart b/lib/data/mcc/mcc_visuals_dataset.dart index b92929a..bc8bb56 100644 --- a/lib/data/mcc/mcc_visuals_dataset.dart +++ b/lib/data/mcc/mcc_visuals_dataset.dart @@ -1,3 +1,11 @@ +/// MCC visuals dataset +/// +/// Visuals (color, material icon name) for MCCs +/// +/// {@category Datasets} +/// {@subCategory MCC} +library mcc__dataset; + const Map> MCCVisualsDataset = { '🐕': {'icon': 'pets', 'color': '#ff9800'}, '🐶': {'icon': 'pets', 'color': '#ff9800'}, diff --git a/lib/mcc/extensions/mcc_emoji.dart b/lib/mcc/extensions/mcc_emoji.dart index 9cf806f..918034c 100644 --- a/lib/mcc/extensions/mcc_emoji.dart +++ b/lib/mcc/extensions/mcc_emoji.dart @@ -1 +1,9 @@ +/// Emoji dataset for MCC +/// +/// Adds emojis for different MCC categories +/// +/// {@category Extensions} +/// {@subCategory MCC} +library mcc_emoji; + export '../../src/mcc/extensions/emoji.dart'; diff --git a/lib/mcc/extensions/mcc_english.dart b/lib/mcc/extensions/mcc_english.dart index f34b535..c2695a1 100644 --- a/lib/mcc/extensions/mcc_english.dart +++ b/lib/mcc/extensions/mcc_english.dart @@ -1 +1,9 @@ +/// English pack for MCC +/// +/// Descriptions of MCC codes in English +/// +/// {@category Extensions} +/// {@subCategory MCC} +library mcc_english; + export '../../src/mcc/extensions/english.dart'; diff --git a/lib/mcc/extensions/mcc_russian.dart b/lib/mcc/extensions/mcc_russian.dart index 28f9dd7..7ea1d43 100644 --- a/lib/mcc/extensions/mcc_russian.dart +++ b/lib/mcc/extensions/mcc_russian.dart @@ -1 +1,9 @@ +/// Russian pack for MCC +/// +/// Descriptions of MCC codes in Russian +/// +/// {@category Extensions} +/// {@subCategory MCC} +library mcc_russian; + export '../../src/mcc/extensions/russian.dart'; diff --git a/lib/mcc/extensions/mcc_ukrainian.dart b/lib/mcc/extensions/mcc_ukrainian.dart index 94b06a5..5f70b65 100644 --- a/lib/mcc/extensions/mcc_ukrainian.dart +++ b/lib/mcc/extensions/mcc_ukrainian.dart @@ -1 +1,9 @@ +/// Ukrainian pack for MCC +/// +/// Descriptions of MCC codes in Ukrainian +/// +/// {@category Extensions} +/// {@subCategory MCC} +library mcc_ukrainian; + export '../../src/mcc/extensions/ukrainian.dart'; diff --git a/lib/mcc/extensions/mcc_visuals.dart b/lib/mcc/extensions/mcc_visuals.dart index 8d18ccf..403a84d 100644 --- a/lib/mcc/extensions/mcc_visuals.dart +++ b/lib/mcc/extensions/mcc_visuals.dart @@ -1 +1,10 @@ +/// Visuals pack for MCC +/// +/// Adds getters with visual assets related to the MCC code +/// (emoji, Material icon name, color) +/// +/// {@category Extensions} +/// {@subCategory MCC} +library mcc_visuals; + export '../../src/mcc/extensions/visuals.dart'; diff --git a/lib/mcc/mcc.dart b/lib/mcc/mcc.dart deleted file mode 100644 index f5246f2..0000000 --- a/lib/mcc/mcc.dart +++ /dev/null @@ -1 +0,0 @@ -export '../src/mcc/mcc.dart'; diff --git a/lib/src/api.dart b/lib/src/api.dart index 691cd14..037840c 100644 --- a/lib/src/api.dart +++ b/lib/src/api.dart @@ -275,7 +275,7 @@ class API { /// No authenication Root path /// /// Is being used instead of [API.domain] when [API.token] is - /// not present or [APIRequst.useAuth] == `false`. + /// not present or [APIRequest.useAuth] == `false`. /// /// Defaults to [API.domain] final Uri noAuthDomain; @@ -283,7 +283,7 @@ class API { /// Request credential /// /// Is being appended in [API.authAttacher] when - /// [APIRequst.useAuth] == `true`. + /// [APIRequest.useAuth] == `true`. final String token; /// Minimal timeout between all requests diff --git a/lib/src/mono.dart b/lib/src/mono.dart index 9988026..144c535 100644 --- a/lib/src/mono.dart +++ b/lib/src/mono.dart @@ -1,4 +1,4 @@ -import 'package:monobank_api/mcc/mcc.dart'; +import 'package:monobank_api/mcc.dart'; import 'package:monobank_api/monobank_api.dart'; /// Default library domain that's being used diff --git a/pubspec.yaml b/pubspec.yaml index 17b14d1..d95b1fd 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -4,7 +4,7 @@ description: > Supports getting currencies and grabbing statement -version: 1.2.2 +version: 1.3.0 homepage: https://github.com/Sominemo/monobank_api environment: