Merge pull request #469 from appwrite/feat-service-level-params

Service level attributes

Author: TorstenDittmann

specs/swagger2-latest-console.json

@@ -112,7 +112,7 @@ public function getKeywords()
      */
     public function getIdentifierOverrides()
     {
-        return ['Function' => 'Func'];
+        return ['Function' => 'Func', 'default' => 'xdefault', 'required' => 'xrequired'];
     }
 
     /**

src/SDK/Language/Dart.php

@@ -556,6 +556,7 @@ public function generate($target)
                     foreach ($this->spec->getServices() as $key => $service) {
                         $methods = $this->spec->getMethods($key);
                         $params['service'] = [
+                            'globalParams' => $service['globalParams'] ?? [],
                             'description' => $service['description'] ?? '',
                             'name' => $key,
                             'features' => [

src/SDK/SDK.php

@@ -6,6 +6,10 @@
 
 class Swagger2 extends Spec
 {
+    /**
+     * @var array
+     */
+    private array $serviceParams = [];
 
     /**
      * @return string
@@ -104,9 +108,11 @@ public function getServices()
                 if (isset($method['tags'])) {
                     foreach ($method['tags'] as $tag) {
                         if (!array_key_exists($tag, $list)) {
+                            $methods = $this->getMethods($tag);
                             $list[$tag] = [
                                 'name' => $tag,
-                                'methods' => $this->getMethods($tag),
+                                'methods' => $methods,
+                                'globalParams' => $this->serviceParams[$tag] ?? [],
                             ];
                         }
                     }
@@ -132,7 +138,7 @@ public function getServices()
     public function getMethods($service)
     {
         $list = [];
-
+        $serviceParams= [];
         $security = $this->getAttribute('securityDefinitions', []);
         $paths = $this->getAttribute('paths', []);
 
@@ -204,6 +210,7 @@ public function getMethods($service)
                             'default' => $parameter['default'] ?? null,
                             'example' => $parameter['x-example'] ?? null,
                             'isUploadID' => $parameter['x-upload-id'] ?? false,
+                            'isGlobal' => $parameter['x-global'] ?? false,
                             'array' => [
                                 'type' => $parameter['items']['type'] ?? '',
                             ],
@@ -215,6 +222,10 @@ public function getMethods($service)
 
                         $param['default'] = (is_array($param['default'])) ? json_encode($param['default']) : $param['default'];
 
+                        if(($parameter['x-global'] ?? false)) {
+                            $serviceParams[$param['name']] = $param;
+                        }
+
                         switch ($parameter['in']) {
                             case 'header':
                                 $output['parameters']['header'][] = $param;
@@ -239,6 +250,7 @@ public function getMethods($service)
                                     $param['required'] = (in_array($key, $bodyRequired));
                                     $param['default'] = $value['default'] ?? null;
                                     $param['example'] = $value['x-example'] ?? null;
+                                    $param['isGlobal'] = $value['x-global'] ?? false;
                                     $param['isUploadID'] = $value['x-upload-id'] ?? false;
                                     $param['array'] = [
                                         'type' => $value['items']['type'] ?? '',
@@ -270,6 +282,8 @@ public function getMethods($service)
             }
         }
 
+        $this->serviceParams[$service] = $serviceParams;
+
         return $list;
     }
 

src/Spec/Swagger2.php

@@ -1,4 +1,4 @@
-{% import 'flutter/base/utils.twig' as utils %}
+{% import 'dart/base/utils.twig' as utils %}
         final Map<String, dynamic> params = {
             {{ utils.map_parameter(method.parameters.query) }}
             {{ utils.map_parameter(method.parameters.body) }}

templates/dart/base/requests/api.twig

@@ -1,4 +1,4 @@
-      {% import 'flutter/base/utils.twig' as utils %}
+{% import 'dart/base/utils.twig' as utils %}
         final Map<String, dynamic> params = {
             {{ utils.map_parameter(method.parameters.query) }}
             {{ utils.map_parameter(method.parameters.body) }}

templates/dart/base/requests/file.twig

@@ -1,4 +1,4 @@
-{% import 'flutter/base/utils.twig' as utils %}
+{% import 'dart/base/utils.twig' as utils %}
         final Map<String, dynamic> params = {
             {{ utils.map_parameter(method.parameters.query) }}
             {{ utils.map_parameter(method.parameters.body) }}

templates/dart/base/requests/location.twig

@@ -1,4 +1,4 @@
-{% import 'flutter/base/utils.twig' as utils %}
+{% import 'dart/base/utils.twig' as utils %}
         final Map<String, dynamic> params = {
             {{ utils.map_parameter(method.parameters.query) }}
             {{ utils.map_parameter(method.parameters.body) }}

templates/dart/base/requests/oauth.twig

@@ -8,4 +8,4 @@
 {% for key, header in headers %}
 '{{ key }}': '{{ header }}',
 {% endfor %}
-{% endmacro %}
+{% endmacro %}

templates/dart/base/utils.twig

@@ -1,15 +1,22 @@
 part of {{ language.params.packageName }};
-{% macro parameter(parameter) %}
-{% if parameter.required %}required {{ parameter.type | typeName }}{% else %}{{ parameter.type | typeName }}?{% endif %} {{ parameter.name | caseCamel | escapeKeyword }}{% endmacro %}
+{% macro parameter(parameter) %}{% if parameter.required %}required {{ parameter.type | typeName }}{% else %}{{ parameter.type | typeName }}?{% endif %} {{ parameter.name | caseCamel | overrideIdentifier }}{% endmacro %}
 {% macro method_parameters(parameters, consumes) %}
-{% if parameters.all|length > 0 %}{{ '{' }}{% for parameter in parameters.all %}{{ _self.parameter(parameter) }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, Function(UploadProgress)? onProgress{% endif %}{{ '}' }}{% endif %}
+{% if parameters|length > 0 %}{{ '{' }}{% for parameter in parameters %}{{ _self.parameter(parameter) }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, Function(UploadProgress)? onProgress{% endif %}{{ '}' }}{% endif %}
+{% endmacro %}
+{% macro service_params(parameters) %}
+{% if parameters|length > 0 %}{{ ', {' }}{% for parameter in parameters %}{% if parameter.required %}required {% endif %}this.{{ parameter.name | caseCamel | overrideIdentifier }}{% if not loop.last %}, {% endif %}{% endfor %}{{ '}' }}{% endif %}
 {% endmacro %}
 
 {%if service.description %}
 {{ service.description|dartComment}}
 {% endif %}
 class {{ service.name | caseUcfirst }} extends Service {
-    {{ service.name | caseUcfirst }}(Client client): super(client);
+    {{ service.name | caseUcfirst }}(Client client{{ _self.service_params(service.globalParams) }}): super(client);
+{% if service.globalParams | length %}
+{% for parameter in service.globalParams %}
+    {{ parameter.type | typeName }}{% if not parameter.required %}?{% endif %} {{ parameter.name | caseCamel | overrideIdentifier }};
+{% endfor %}
+{% endif %}
 {% for method in service.methods %}
 
      /// {{ method.title }}
@@ -18,7 +25,7 @@ class {{ service.name | caseUcfirst }} extends Service {
 {{ method.description | dartComment }}
      ///
 {% endif %}
-    {% if method.type == 'location' %} Future<Uint8List> {% else %} {% if method.responseModel and method.responseModel != 'any' %}Future<models.{{method.responseModel | caseUcfirst | overrideIdentifier}}>{% else %}Future{% endif %}{% endif %} {{ method.name | caseCamel }}({{ _self.method_parameters(method.parameters, method.consumes) }}) async {
+    {% if method.type == 'location' %} Future<Uint8List> {% else %} {% if method.responseModel and method.responseModel != 'any' %}Future<models.{{method.responseModel | caseUcfirst | overrideIdentifier}}>{% else %}Future{% endif %}{% endif %} {{ method.name | caseCamel }}({{ _self.method_parameters(method.parameters.all | filter((param) => not param.isGlobal), method.consumes) }}) async {
         final String path = '{{ method.path }}'{% for parameter in method.parameters.path %}.replaceAll('{{ '{' }}{{ parameter.name | caseCamel }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
 
 {% if 'multipart/form-data' in method.consumes %}