tillhub_sdk_flutter 0.0.1

  • Readme
  • Changelog
  • Installing
  • new48

tillhub_sdk_flutter #

Flutter SDK for the Tillhub API and common local functionality.

Getting Started #

// 1. get an instance of the SDK
var sdk = await TillhubSdk.getInstance();

// 2. login as a user
await sdk.api.login('name', 'password', 'organization');

// 3. request some resources, .e.g:
var results = await sdk.api.products.getAll(query: { 'deleted': false });

Authentication information from a successful login is automatically saved to SharedPreferences, and loaded when the instance is created.

License #

Apache-2.0

[0.0.1] - 2020-01-15

  • initial release of the SDK
  • provides login, API interaction as user or as device, and a few routes

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  tillhub_sdk_flutter: ^0.0.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:tillhub_sdk_flutter/api/api.dart';
import 'package:tillhub_sdk_flutter/api/auth_info.dart';
import 'package:tillhub_sdk_flutter/api/device_api.dart';
import 'package:tillhub_sdk_flutter/api/device_auth_info.dart';
import 'package:tillhub_sdk_flutter/api/routes/base_route.dart';
import 'package:tillhub_sdk_flutter/api/routes/devices_route.dart';
import 'package:tillhub_sdk_flutter/api/routes/stocks_route.dart';
import 'package:tillhub_sdk_flutter/tillhub_sdk.dart';
import 'package:tillhub_sdk_flutter/utils/pather.dart';
import 'package:tillhub_sdk_flutter/utils/utils.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
11
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
48
Learn more about scoring.

We analyzed this package on Jan 19, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.0
  • pana: 0.13.4
  • Flutter: 1.12.13+hotfix.5

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and tillhub_sdk_flutter.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.3.0 <3.0.0
connectivity ^0.4.2 0.4.6+2
device_id ^0.2.0 0.2.0
dio ^3.0.8 3.0.8
dio_retry ^0.1.9-beta 0.1.9-beta
flutter 0.0.0
jaguar_jwt ^2.1.6 2.1.6
logging ^0.11.3+2 0.11.4
shared_preferences ^0.5.0 0.5.6
Transitive dependencies
auth_header 2.1.4
charcode 1.1.2
collection 1.14.11 1.14.12
convert 2.1.1
crypto 2.1.4
flutter_web_plugins 0.0.0
http_parser 3.1.3
meta 1.1.8
path 1.6.4
shared_preferences_macos 0.0.1+3
shared_preferences_platform_interface 1.0.1
shared_preferences_web 0.1.2+2
sky_engine 0.0.99
source_span 1.6.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test