Socketio is set to default client & error handling improved & docs improved

Author: Dahkenangnon

README.md

@@ -6,4 +6,8 @@ Communicate with your feathers js (https://feathersjs.com/) server from flutter.
 
 ## Documentation
 
-Documentation is now available from: [https://dahkenangnon.github.io/flutter_feathersjs.dart/](https://dahkenangnon.github.io/flutter_feathersjs.dart/)
+Documentation is now available from: [https://dahkenangnon.github.io/flutter_feathersjs.dart/](https://dahkenangnon.github.io/flutter_feathersjs.dart/)
+
+1. shit+alt+select
+2. alt+clik to add new cursor (a time your want)
+3. Now replace

docs/src/.vuepress/config.js

@@ -55,6 +55,7 @@ module.exports = {
                     '',
                     'installation',
                     'authentication',
+                    'socketio-is-default-client',
                     'using-rest',
                     'using-socketio',
                     'how-to-upload-file',

docs/src/guide/README.md

@@ -1,6 +1,6 @@
 # Introduction
 
-## :bird: flutter_feathersjs :bird
+## :bird: flutter_feathersjs :bird:
 
 Communicate with your feathers js [https://feathersjs.com/](https://feathersjs.com/) server from flutter.
 

docs/src/guide/authentication.md

@@ -140,3 +140,10 @@ Then reAutenticate user, if JWT still validated without request credentials from
         // why => print(e.message);
     }
 ```
+
+
+
+
+
+
+Now, let's send request and listen to feathers js event :notes: :zzz: :car:

docs/src/guide/listening-event.md

@@ -1,5 +1,5 @@
 # Realtime with FlutterFeatherJs
 
-You can listen to feathers js realtime event with scketio client
+You can listen to feathers js realtime event with listen method
 
-[Listen to realtime event with scketio client](using-socketio.html#listen)
+[Listen to realtime event with scketio client](socketio-is-default-client.html#listen)

docs/src/guide/socketio-is-default-client.md

@@ -0,0 +1,299 @@
+# Default Client
+
+**Because we love the realtime side of feathers js, by default socketio's methods are available on FlutterFeathersjs.{methodName}**
+
+You get exactly what feathers server send (_Serialization and Deserialization are not supported._) except in the listen method.
+
+This client don't support file upload
+
+Recommended: Use rest client to upload file
+
+## find
+
+Retrieves a list of all matching resources from the service
+
+All message
+
+```dart
+     try {
+       var messageResponse = await flutterFeathersjs.find(serviceName: "message",
+       query: {});
+
+       // print(messageResponse); => feathers's find data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+message matching certain query
+
+```dart
+
+     try {
+      // Find message with query: here with {"_id": "5f7643f0462f4348970cd32e"}
+ var messageResponse = await flutterFeathersjs.find(serviceName: "message", query: {"_id": "5f7643f0462f4348970cd32e"});
+
+       // print(messageResponse); => feathers's find data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+## get
+
+Retrieve a single resource from the service with an `_id`
+
+```dart
+
+
+     try {
+      // Get a single new with it _id
+ var messageResponse = await flutterFeathersjs.get(serviceName: "message", objectId: "5f7643f0462f4348970cd32e");
+
+       // print(messageResponse); => feathers's get data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+## create
+
+Create a new resource with data.
+
+```dart
+
+
+    try {
+
+   // Create a message on the server without file upload
+      var messageResponse = await flutterFeathersjs.create(
+        serviceName: "message",
+        data: {"title": "Using FlutterFeathersjs is easy", "content": "Yes very easy" , "author" :"5f7h43f0462f4348970cd32e"});
+
+       // print(messageResponse); => feathers's get data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+## update
+
+Completely replace a single resource with the `_id = objectId`
+
+```dart
+
+    try {
+
+     var messageResponse = await flutterFeathersjs.update(
+        objectId: "5f7h43f0462f4t48970cd32e",
+        serviceName: "message",
+        data: {"title": "Using FlutterFeathersjs is easy", "content": "Yes very easy" , "author" :"5f7h43f0462f4348970cd32e"});
+
+       // print(messageResponse); => feathers's get data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+## patch
+
+Completely replace a single resource with the `_id = objectId`
+
+```dart
+ try {
+
+    var messageResponse = await flutterFeathersjs.patch(
+        objectId: "5f7h43f0462f4t48970cd32e",
+        serviceName: "message",
+        data: {"title": "Using FlutterFeathersjs is easy", "content": "Yes very easy" , "author" :"5f7h43f0462f4348970cd32e"});
+       // print(messageResponse); => feathers's get data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+## remove
+
+Remove a single resource with `_id = objectId`:
+
+```dart
+try {
+    var messageResponse = await flutterFeathersjs.remove(serviceName: "message", objectId: "5f7643f0462f4348970cd32e");
+
+       // print(messageResponse); => feathers's remove data format
+    } on FeatherJsError catch (e) {
+
+      // When error is FeatherJsErrorType
+      // if(e.type == FeatherJsErrorType.IS_SERVER_ERROR)
+      // Check the error type as above and handle it
+    } catch (er) {
+      // Catch  unknown error
+
+    }
+```
+
+## listen  :zzz:
+
+For realtime event listening, keep in mind these informations:
+
+0. `On updated | patched | created | removed` event are all supported;
+1. You need a [StreamSubscription](https://api.flutter.dev/flutter/dart-async/StreamSubscription-class.html)
+2. You need a state manangment plugin like [flutter_bloc](https://pub.dev/packages/flutter_bloc)
+
+Now assume that we want to listen to `On created` on `message` service in realtime
+
+Add an event in your `message_event.dart`:
+
+```dart
+
+class FeatherCreatedMessageEvent extends MessageEvent {
+  final Message message;
+
+  FeatherCreatedMessageEvent({@required this.message});
+
+  @override
+  List<Object> get props => [message];
+}
+
+```
+
+Add a state in your `message_state.dart`:
+
+```dart
+class FeatherCreatedMessageState extends MessageState {
+  final String message;
+
+  FeatherCreatedMessageState({@required this.message});
+
+  @override
+  List<Object> get props => [message];
+}
+
+```
+
+Now listen the event and broadcast it to your widget in your `message_bloc.dart`:
+
+```dart
+
+import 'dart:async';
+import 'package:flutter_feathersjs/src/helper.dart';
+
+// Other required import
+
+part 'message_event.dart';
+part 'message_state.dart';
+
+class MessageBloc extends Bloc<MessageEvent, MessageState> {
+
+  // FlutterFeathersjs
+  final FlutterFeathersjs flutterFeathersjs;
+
+  // StreamSubscription
+  StreamSubscription streamSubscription;
+
+
+  // MessageBloc constructor
+  MessageBloc(
+      {this.flutterFeathersjs})
+      : super(MessageInitial()) {
+
+    // Listen to realtime event
+    streamSubscription = flutterFeathersjs
+        .listen<Message>(
+            serviceName: "message",
+            fromJson: Message.fromMap)
+        .listen(
+
+            // onData:
+            (event) {
+
+        // event is FeathersJsEventData<Message>
+        // What event is sent by feathers js ?
+        if(event.type == FeathersJsEventType.created){
+            // Trigger flutter_bloc event
+            add(FeatherCreatedMessageEvent(message: event));
+
+        }else if(event.type == FeathersJsEventType.removed){
+            // 
+        } else if (event.type == FeathersJsEventType.patched){
+            // ...
+        }
+      
+    },
+
+
+     // onError:
+    (e) {
+    // e is a FeatherJsError
+    // You can check what error occured: e.type
+     
+     // Add the event to flutter_bloc
+      add(MessageError(message: e.error));
+    },
+
+    );
+  }
+
+  @override
+  Stream<MessageState> mapEventToState(
+    MessageEvent event,
+  ) async* {
+    try {
+
+        // Listen to flutter_bloc event which correspond to our case for realtime 
+      if (event is FeatherCreatedMessageEvent) {
+        
+        // Change the state to allow ui update 
+        yield FeatherCreatedMessageState(message: event.message);
+      }
+    } catch (e) {
+      //yield MessageError(message: "Error");
+    }
+  }
+
+  //This method should be called when a [Bloc] is no longer needed.
+  // Just add it, nothing to customize except the streamSubscription var name 
+  @override
+  Future<void> close() {
+    streamSubscription.cancel();
+    return super.close();
+  }
+}
+
+```

docs/src/guide/using-rest.md

@@ -1,4 +1,4 @@
-# Rest methods
+# Rest Client
 
 ****Feathers Js rest client for rest api call****
 

docs/src/guide/using-socketio.md

@@ -1,4 +1,4 @@
-# Socketio methods
+# Socketio client
 
 \***\*Feathers Js scketio client for realtime communication\*\***
 
@@ -168,7 +168,7 @@ try {
     }
 ```
 
-## listen
+## listen  :zzz:
 
 For realtime event listening, keep in mind these informations: