feat(#61): generate client for Serinus Applications

.gitignore

@@ -7,7 +7,7 @@
 *.ipr
 *.iws
 .idea/
-
+*.DS_Store
 # Conventional directory for build output.
 build/
 

.website/techniques/cli/generate.md

@@ -9,12 +9,29 @@ The `generate` command is used to generate code for your Serinus project. This c
 | `provider` | Generate a provider class for your project. |
 | `module` | Generate a module class for your project |
 | `resource` | Generate a controller, a provider and a module for your project |
+| `client` | Generate a client for your project |
 
 ## Models
 
 The `models` sub-command is used to generate a model provider class for your project. This class is used to convert JSON objects to Dart objects and vice versa.
 
 It also execute build_runner to generate the necessary files. This allows you to use libraries like `json_serializable`, `dart_mappable`, `freezed` to generate your data classes.
 
-This commands can also be tweaked by the usage of the configuration in the `pubspec.yaml` file.
-[Here](/techniques/configuration#models-configuration) is how you can configure the models generation.
+This commands can also be tweaked thanks to the configuration in the `pubspec.yaml` file.
+[Here](/techniques/configuration#models-configuration) you can see the available options.
+
+## Client
+
+The `client` sub-command is used to generate a client for your project.
+The client provide an immediate way to interact with your API from your frontend application.
+
+Right now the client supports the following languages and libraries:
+
+| Language | Library |
+| --- | --- |
+| Dart | `http` |
+| Dart | `dio` |
+| Dart | `chopper` |
+
+This commands can also be tweaked thanks to the configuration in the `pubspec.yaml` file.
+[Here](/techniques/configuration#client-configuration) you can see the available options.

packages/serinus/bin/serinus.dart

@@ -90,13 +90,21 @@ class AppModule extends Module {
       : super(imports: [
           AnotherModule(),
           CircularDependencyModule()
-        ], controllers: [], providers: [
+        ], controllers: [
+          AppController()
+        ], providers: [
           TestProvider(isGlobal: true),
           Provider.deferred((TestProviderThree tp) => TestProviderTwo(tp),
               inject: [TestProviderThree], type: TestProviderTwo),
         ], middlewares: []);
 }
 
+class AppController extends Controller {
+  AppController({super.path = '/'}) {
+    onStatic(Route.get('/'), 'ok!');
+  }
+}
+
 void main(List<String> arguments) async {
   SerinusApplication application = await serinus.createApplication(
       entrypoint: AppModule(), host: InternetAddress.anyIPv4.address);

packages/serinus/example/lib/app_controller.dart

@@ -5,8 +5,11 @@ import 'app_routes.dart';
 /// The [AppController] class is used to create the application controller.
 class AppController extends Controller {
   /// The constructor of the [AppController] class.
-  AppController({super.path = '/'}) {
+  AppController({super.path = '/users'}) {
     on(HelloWorldRoute(), _handleEcho);
+    on(Route.get('/<id>/details/<name>'), (context) async {
+      return 'Hello';
+    }, body: String);
   }
 
   Future<Map<String, dynamic>> _handleEcho(RequestContext context) async {

packages/serinus/example/lib/app_routes.dart

@@ -3,5 +3,9 @@ import 'package:serinus/serinus.dart';
 /// The [HelloWorldRoute] class is used to create a route that returns 'Hello, World!'.
 class HelloWorldRoute extends Route {
   /// The constructor of the [HelloWorldRoute] class.
-  HelloWorldRoute() : super(path: '/', method: HttpMethod.get);
+  HelloWorldRoute()
+      : super(
+            path: '/',
+            method: HttpMethod.get,
+            queryParameters: {'hello': String});
 }

packages/serinus/example/pubspec.lock

@@ -206,6 +206,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.3.7"
+  dio:
+    dependency: "direct main"
+    description:
+      name: dio
+      sha256: "5598aa796bbf4699afd5c67c0f5f6e2ed542afc956884b9cd58c306966efc260"
+      url: "https://pub.dev"
+    source: hosted
+    version: "5.7.0"
+  dio_web_adapter:
+    dependency: transitive
+    description:
+      name: dio_web_adapter
+      sha256: "33259a9276d6cea88774a0000cfae0d861003497755969c92faa223108620dc8"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.0"
   email_validator:
     dependency: transitive
     description:

packages/serinus/example/pubspec.yaml

@@ -6,10 +6,11 @@ environment:
   sdk: '>=3.0.0 <4.0.0'
 
 dependencies:
-  serinus: ^0.6.0
+  serinus: ^0.6.2
   dart_mappable: ^4.2.2
   freezed_annotation: ^2.4.4
   json_annotation: ^4.9.0
+  dio: ^5.7.0
 dev_dependencies:
   freezed: ^2.5.7
   build_runner: ^2.4.12
@@ -25,4 +26,8 @@ serinus:
         static_method: true
     serialize_keywords:
       - keyword: "toBody"
+  client:
+    verbose: false
+    language: 'Dart'
+    httpClient: 'dio'
 

packages/serinus/lib/src/containers/module_container.dart

@@ -339,6 +339,7 @@ final class ModulesContainer {
         ...providers.providers.whereNot((e) => e is DeferredProvider),
         ...providers.exportedProviders.whereNot((e) => e is DeferredProvider),
         ...injectables.providers.whereNot((e) => e is DeferredProvider),
+        ...globalProviders
       },
     );
     _moduleInjectables[token]?.providers.addAllIfAbsent(globalProviders);
@@ -369,7 +370,8 @@ final class ModulesContainer {
         providers: {
           ...providersInjectable,
           ...subModuleInjectables.providers,
-          ...exportedProvidersInjectables
+          ...exportedProvidersInjectables,
+          ...globalProviders,
         },
       );
     }

packages/serinus/lib/src/containers/router.dart

@@ -80,14 +80,18 @@ class RouteData {
   /// The [isStatic] property defines if a route is a static one.
   final bool isStatic;
 
+  /// The [spec] property contains the specification of the route.
+  final RouteHandler spec;
+
   /// The [RouteData] constructor is used to create a new instance of the [RouteData] class.
-  RouteData({
+  const RouteData({
     required this.id,
     required this.path,
     required this.method,
     required this.controller,
     required this.routeCls,
     required this.moduleToken,
+    required this.spec,
     this.isStatic = false,
     this.queryParameters = const {},
   });

packages/serinus/lib/src/contexts/request_context.dart

@@ -72,7 +72,7 @@ class RequestContext extends BaseContext {
 
   /// The [stream] method is used to stream data to the response.
   StreamableResponse stream() {
-    return _streamable..init();
+    return _streamable;
   }
 }
 

packages/serinus/lib/src/contexts/ws_context.dart

@@ -33,19 +33,13 @@ final class WebSocketContext extends BaseContext {
   ///
   /// The [broadcast] parameter is used to broadcast the data to all clients.
   void send(dynamic data) {
-    if (_serializer != null) {
-      data = _serializer!.serialize(data);
-    }
-    _wsAdapter.send(data, key: id);
+    _wsAdapter.send(_serializer?.serialize(data) ?? data, key: id);
   }
 
   /// This method is used to broadcast data to all clients.
   ///
   /// The [data] parameter is the data to be sent.
   void broadcast(dynamic data) {
-    if (_serializer != null) {
-      data = _serializer!.serialize(data);
-    }
-    _wsAdapter.send(data);
+    _wsAdapter.send(_serializer?.serialize(data) ?? data);
   }
 }

packages/serinus/lib/src/core/controller.dart

@@ -4,7 +4,6 @@ import 'package:collection/collection.dart';
 import 'package:meta/meta.dart';
 import 'package:uuid/v4.dart';
 
-import '../containers/router.dart';
 import '../contexts/contexts.dart';
 import 'metadata.dart';
 import 'parse_schema.dart';
@@ -37,8 +36,8 @@ abstract class Controller {
   Map<String, RouteHandler> get routes => UnmodifiableMapView(_routes);
 
   /// The [get] method is used to get a route.
-  RouteHandler? get(RouteData routeData) {
-    return _routes[routeData.id];
+  RouteHandler? get(String routeId) {
+    return _routes[routeId];
   }
 
   /// The [metadata] property contains the metadata of the controller.

packages/serinus/lib/src/extensions/object_extensions.dart

@@ -15,7 +15,7 @@ extension JsonParsing on Object {
 
   /// This method is used to check if the object can be converted to a json.
   bool canBeJson() {
-    if (this is Uint8List) {
+    if (this is Uint8List || isPrimitive()) {
       return false;
     }
     return this is Map ||

packages/serinus/lib/src/handlers/request_handler.dart

@@ -64,13 +64,8 @@ class RequestHandler extends Handler {
 
     final injectables =
         modulesContainer.getModuleInjectablesByToken(routeData.moduleToken);
+    final routeSpec = routeData.spec;
     final controller = routeData.controller;
-    final routeSpec = controller.get(routeData);
-    if (routeSpec == null) {
-      throw InternalServerErrorException(
-          message: 'Route spec not found for route ${routeData.path}');
-    }
-
     final route = routeSpec.route;
     final handler = routeSpec.handler;
     final schema = routeSpec.schema;

packages/serinus/lib/src/http/internal_response.dart

@@ -63,6 +63,9 @@ class InternalResponse {
 
   /// This method is used to set the status code of the response.
   void status(int statusCode) {
+    if (statusCode == _original.statusCode) {
+      return;
+    }
     _original.statusCode = statusCode;
   }
 

packages/serinus/lib/src/http/streamable_response.dart

@@ -32,6 +32,9 @@ class StreamableResponse {
 
   /// This method is used to send data to the response.
   void send(Object data) {
+    if (!_initialized) {
+      init();
+    }
     _response.write(data.toString());
   }
 

packages/serinus/lib/src/injector/explorer.dart

@@ -59,19 +59,18 @@ final class Explorer {
       }
       routePath = normalizePath(routePath);
       final routeMethod = spec.route.method;
-      _router.registerRoute(
-        RouteData(
-            id: entry.key,
-            path: routePath,
-            controller: controller,
-            routeCls: spec.route.runtimeType,
-            method: routeMethod,
-            moduleToken: module.token.isEmpty
-                ? module.runtimeType.toString()
-                : module.token,
-            isStatic: spec.handler is! Function,
-            queryParameters: spec.route.queryParameters),
-      );
+      _router.registerRoute(RouteData(
+        id: entry.key,
+        path: routePath,
+        controller: controller,
+        routeCls: spec.route.runtimeType,
+        method: routeMethod,
+        moduleToken:
+            module.token.isEmpty ? module.runtimeType.toString() : module.token,
+        isStatic: spec.handler is! Function,
+        queryParameters: spec.route.queryParameters,
+        spec: spec,
+      ));
       logger.info('Mapped {$routePath, $routeMethod} route');
     }
   }

packages/serinus/pubspec.yaml

@@ -16,7 +16,7 @@ topics:
   - http
 
 environment:
-  sdk: '>=3.0.0 <4.0.0'
+  sdk: '>=3.5.0 <4.0.0'
 
 dependencies:
   async: ^2.12.0

packages/serinus/test/containers/router_test.dart

@@ -32,7 +32,13 @@ void main() async {
           method: HttpMethod.get,
           controller: TestController(),
           routeCls: Type,
-          moduleToken: 'moduleToken');
+          moduleToken: 'moduleToken',
+          spec: (
+            body: null,
+            schema: null,
+            handler: 'hi',
+            route: Route.get('/test'),
+          ));
       router.registerRoute(routeData);
     });
 
@@ -47,7 +53,13 @@ void main() async {
           method: HttpMethod.get,
           controller: TestController(),
           routeCls: Type,
-          moduleToken: 'moduleToken');
+          moduleToken: 'moduleToken',
+          spec: (
+            body: null,
+            schema: null,
+            handler: 'hi',
+            route: Route.get('/test'),
+          ));
       router.registerRoute(routeData);
       final result = router.getRouteByPathAndMethod('/test', HttpMethod.get);
       expect(result.route, routeData);
@@ -64,7 +76,13 @@ void main() async {
           method: HttpMethod.get,
           controller: TestController(),
           routeCls: Type,
-          moduleToken: 'moduleToken');
+          moduleToken: 'moduleToken',
+          spec: (
+            body: null,
+            schema: null,
+            handler: 'hi',
+            route: Route.get('/test'),
+          ));
       router.registerRoute(routeData);
       final result = router.getRouteByPathAndMethod('/test', HttpMethod.post);
       expect(result.route, isNull);