angel_client
Client library for the Angel framework.
This library provides virtually the same API as an Angel server.
The client can run in the browser, in Flutter, or on the command-line.
In addition, the client supports angel_auth authentication.
Usage
// Choose one or the other, depending on platform
import 'package:angel_client/io.dart';
import 'package:angel_client/browser.dart';
import 'package:angel_client/flutter.dart';
main() async {
Angel app = new Rest("http://localhost:3000");
}You can call service to receive an instance of Service, which acts as a client to a
service on the server at the given path (say that five times fast!).
foo() async {
Service Todos = app.service("todos");
List<Map> todos = await Todos.index();
print(todos.length);
}The CLI client also supports reflection via json_god. There is no need to work with Maps;
you can use the same class on the client and the server.
class Todo extends Model {
String text;
Todo({String this.text});
}
bar() async {
// By the next release, this will just be:
// app.service<Todo>("todos")
Service Todos = app.service("todos", type: Todo);
List<Todo> todos = await Todos.index();
print(todos.length);
}Just like on the server, services support index, read, create, modify, update and
remove.
Authentication
Local auth:
var auth = await app.authenticate(type: 'local', credentials: {username: ..., password: ...});
print(auth.token);
print(auth.data); // User objectRevive an existing jwt:
Future<AngelAuthResult> reviveJwt(String jwt) {
return app.authenticate(credentials: {'token': jwt});
}Via Popup:
app.authenticateViaPopup('/auth/google').listen((jwt) {
// Do something with the JWT
});Resume a session from localStorage (browser only):
// Automatically checks for JSON-encoded 'token' in localStorage,
// and tries to revive it
await app.authenticate();Logout:
await app.logout();Live Updates
Oftentimes, you will want to update a collection based on updates from a service.
Use ServiceList for this case:
build(BuildContext context) async {
var list = new ServiceList(app.service('api/todos'));
return new StreamBuilder(
stream: list.onChange,
builder: _yourBuildFunction,
);
}
