/// Client library for the Angel framework. library angel_client; import 'dart:async'; import 'package:collection/collection.dart'; import 'dart:convert'; import 'package:http/http.dart' as http; export 'package:angel_http_exception/angel_http_exception.dart'; import 'package:meta/meta.dart'; /// A function that configures an [Angel] client in some way. typedef FutureOr AngelConfigurer(Angel app); /// A function that deserializes data received from the server. /// /// This is only really necessary in the browser, where `json_god` /// doesn't work. typedef T AngelDeserializer(x); /// Represents an Angel server that we are querying. abstract class Angel extends http.BaseClient { /// A mutable member. When this is set, it holds a JSON Web Token /// that is automatically attached to every request sent. /// /// This is designed with `package:angel_auth` in mind. String authToken; /// The root URL at which the target server. final Uri baseUrl; Angel(baseUrl) : this.baseUrl = baseUrl is Uri ? baseUrl : Uri.parse(baseUrl.toString()); /// Prefer to use [baseUrl] instead. @deprecated String get basePath => baseUrl.toString(); /// Fired whenever a WebSocket is successfully authenticated. Stream get onAuthenticated; /// Authenticates against the server. /// /// This is designed with `package:angel_auth` in mind. /// /// The [type] is appended to the [authEndpoint], ex. `local` becomes `/auth/local`. /// /// The given [credentials] are sent to server as-is; the request body is sent as JSON. Future authenticate( {@required String type, credentials, String authEndpoint = '/auth', @deprecated String reviveEndpoint = '/auth/token'}); /// Shorthand for authenticating via a JWT string. Future reviveJwt(String token, {String authEndpoint = '/auth'}) { return authenticate( type: 'token', credentials: {'token': token}, authEndpoint: authEndpoint); } /// Opens the [url] in a new window, and returns a [Stream] that will fire a JWT on successful authentication. Stream authenticateViaPopup(String url, {String eventName = 'token'}); /// Disposes of any outstanding resources. Future close(); /// Applies an [AngelConfigurer] to this instance. Future configure(AngelConfigurer configurer) async { await configurer(this); } /// Logs the current user out of the application. FutureOr logout(); /// Creates a [Service] instance that queries a given path on the server. /// /// This expects that there is an Angel `Service` mounted on the server. /// /// In other words, all endpoints will return [Data], except for the root of /// [path], which returns a [List]. /// /// You can pass a custom [deserializer], which is typically necessary in cases where /// `dart:mirrors` does not exist. Service service(String path, {@deprecated Type type, AngelDeserializer deserializer}); @override Future delete(url, {Map headers}); @override Future get(url, {Map headers}); @override Future head(url, {Map headers}); @override Future patch(url, {body, Map headers, Encoding encoding}); @override Future post(url, {body, Map headers, Encoding encoding}); @override Future put(url, {body, Map headers, Encoding encoding}); } /// Represents the result of authentication with an Angel server. class AngelAuthResult { String _token; final Map data = {}; /// The JSON Web token that was sent with this response. String get token => _token; AngelAuthResult({String token, Map data = const {}}) { _token = token; this.data.addAll(data ?? {}); } /// Attempts to deserialize a response from a [Map]. factory AngelAuthResult.fromMap(Map data) { final result = new AngelAuthResult(); if (data is Map && data.containsKey('token') && data['token'] is String) result._token = data['token'].toString(); if (data is Map) result.data.addAll((data['data'] as Map) ?? {}); if (result.token == null) { throw new FormatException( 'The required "token" field was not present in the given data.'); } else if (data['data'] is! Map) { throw new FormatException( 'The required "data" field in the given data was not a map; instead, it was ${data['data']}.'); } return result; } /// Attempts to deserialize a response from a [String]. factory AngelAuthResult.fromJson(String s) => new AngelAuthResult.fromMap(json.decode(s) as Map); /// Converts this instance into a JSON-friendly representation. Map toJson() { return {'token': token, 'data': data}; } } /// Queries a service on an Angel server, with the same API. abstract class Service { /// Fired on `indexed` events. Stream> get onIndexed; /// Fired on `read` events. Stream get onRead; /// Fired on `created` events. Stream get onCreated; /// Fired on `modified` events. Stream get onModified; /// Fired on `updated` events. Stream get onUpdated; /// Fired on `removed` events. Stream get onRemoved; /// The Angel instance powering this service. Angel get app; Future close(); /// Retrieves all resources. Future> index([Map params]); /// Retrieves the desired resource. Future read(Id id, [Map params]); /// Creates a resource. Future create(Data data, [Map params]); /// Modifies a resource. Future modify(Id id, Data data, [Map params]); /// Overwrites a resource. Future update(Id id, Data data, [Map params]); /// Removes the given resource. Future remove(Id id, [Map params]); /// Creates a [Service] that wraps over this one, and maps input and output using two converter functions. /// /// Handy utility for handling data in a type-safe manner. Service map(U Function(Data) encoder, Data Function(U) decoder) { return new _MappedService(this, encoder, decoder); } } class _MappedService extends Service { final Service inner; final U Function(Data) encoder; final Data Function(U) decoder; _MappedService(this.inner, this.encoder, this.decoder); @override Angel get app => inner.app; @override Future close() => new Future.value(); @override Future create(U data, [Map params]) { return inner.create(decoder(data)).then(encoder); } @override Future> index([Map params]) { return inner.index(params).then((l) => l.map(encoder).toList()); } @override Future modify(Id id, U data, [Map params]) { return inner.modify(id, decoder(data), params).then(encoder); } @override Stream get onCreated => inner.onCreated.map(encoder); @override Stream> get onIndexed => inner.onIndexed.map((l) => l.map(encoder).toList()); @override Stream get onModified => inner.onModified.map(encoder); @override Stream get onRead => inner.onRead.map(encoder); @override Stream get onRemoved => inner.onRemoved.map(encoder); @override Stream get onUpdated => inner.onUpdated.map(encoder); @override Future read(Id id, [Map params]) { return inner.read(id, params).then(encoder); } @override Future remove(Id id, [Map params]) { return inner.remove(id, params).then(encoder); } @override Future update(Id id, U data, [Map params]) { return inner.update(id, decoder(data), params).then(encoder); } } /// A [List] that automatically updates itself whenever the referenced [service] fires an event. class ServiceList extends DelegatingList { /// A field name used to compare [Map] by ID. final String idField; /// A function used to compare the ID's two items for equality. /// /// Defaults to comparing the [idField] of `Map` instances. Equality get equality => _equality; Equality _equality; final Service service; final StreamController> _onChange = new StreamController(); final List _subs = []; ServiceList(this.service, {this.idField = 'id', Equality equality}) : super([]) { _equality = equality; _equality ??= new EqualityBy((map) { if (map is Map) return map[idField ?? 'id'] as Id; else throw new UnsupportedError( 'ServiceList only knows how to find the id from a Map object. Provide a custom `Equality` in your call to the constructor.'); }); // Index _subs.add(service.onIndexed.where(_notNull).listen((data) { this ..clear() ..addAll(data); _onChange.add(this); })); // Created _subs.add(service.onCreated.where(_notNull).listen((item) { add(item); _onChange.add(this); })); // Modified/Updated handleModified(Data item) { var indices = []; for (int i = 0; i < length; i++) { if (_equality.equals(item, this[i])) indices.add(i); } if (indices.isNotEmpty) { for (var i in indices) this[i] = item; _onChange.add(this); } } _subs.addAll([ service.onModified.where(_notNull).listen(handleModified), service.onUpdated.where(_notNull).listen(handleModified), ]); // Removed _subs.add(service.onRemoved.where(_notNull).listen((item) { removeWhere((x) => _equality.equals(item, x)); _onChange.add(this); })); } static bool _notNull(x) => x != null; /// Fires whenever the underlying [service] fires a change event. Stream> get onChange => _onChange.stream; Future close() async { await _onChange.close(); } }