Merge pull request #1076 from appwrite/PLA-2728

feat (breaking): methods to generate file URLs

Author: christyjacob4

src/SDK/Language/ReactNative.php

@@ -215,7 +215,7 @@ public function getReturn(array $method, array $spec): string
         if ($method['type'] === 'webAuth') {
             return 'void | URL';
         } elseif ($method['type'] === 'location') {
-            return 'URL';
+            return 'Promise<ArrayBuffer>';
         }
 
         if (array_key_exists('responseModel', $method) && !empty($method['responseModel']) && $method['responseModel'] !== 'any') {

templates/react-native/src/client.ts.twig

@@ -378,7 +378,7 @@ class Client {
         }
     }
 
-    async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<any> {
+    async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
         method = method.toUpperCase();
 
         headers = Object.assign({}, this.headers, headers);
@@ -434,6 +434,8 @@ class Client {
 
             if (response.headers.get('content-type')?.includes('application/json')) {
                 data = await response.json();
+            } else if (responseType === 'arrayBuffer') {
+                data = await response.arrayBuffer();
             } else {
                 data = {
                     message: await response.text()

templates/react-native/src/services/template.ts.twig

@@ -39,7 +39,7 @@ export class {{ service.name | caseUcfirst }} extends Service {
      * @param {{ '{' }}{{ parameter | getPropertyType(method) | raw }}{{ '}' }} {{ parameter.name | caseCamel | escapeKeyword }}
 {% endfor %}
      * @throws {{ '{' }}{{ spec.title | caseUcfirst}}Exception}
-     * @returns {% if method.type == 'webAuth' %}{void|string}{% elseif method.type == 'location' %}{URL}{% else %}{Promise}{% endif %}
+     * @returns {% if method.type == 'webAuth' %}{void|string}{% elseif method.type == 'location' %}{ArrayBuffer}{% else %}{Promise}{% endif %}
 
     */
     {% if method.type == 'upload'%}async {% endif %}{{ method.name | caseCamel }}{{ method.responseModel | getGenerics(spec) | raw }}({% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required or parameter.nullable %}?{% endif %}: {{ parameter | getPropertyType(method) | raw }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in method.consumes %}, onProgress = (progress: UploadProgress) => {}{% endif %}): {{ method | getReturn(spec) | raw }} {
@@ -83,8 +83,6 @@ export class {{ service.name | caseUcfirst }} extends Service {
 {% endif %}
 {% if method.type == 'webAuth' %}
         return uri;
-{% elseif method.type == 'location' %}
-        return uri;
 {% else %}
 {% if 'multipart/form-data' in method.consumes %}
 {% for parameter in method.parameters.all %}
@@ -170,9 +168,46 @@ export class {{ service.name | caseUcfirst }} extends Service {
 {% for key, header in method.headers %}
             '{{ key }}': '{{ header }}',
 {% endfor %}
-        }, payload);
+        }, payload{% if method.type == 'location' %}, 'arrayBuffer'{% endif %});
+{% endif %}
 {% endif %}
+    }
+{% endfor %}
+{# Extra methods for just getting the URL of 'location' type methods #}
+{% for method in service.methods %}
+{% if method.type == 'location' %}
+
+    /**
+{% if method.description %}
+{{ method.description|comment2 }}
 {% endif %}
+     *
+{% for parameter in method.parameters.all %}
+     * @param {{ '{' }}{{ parameter | getPropertyType(method) | raw }}{{ '}' }} {{ parameter.name | caseCamel | escapeKeyword }}
+{% endfor %}
+     * @throws {{ '{' }}{{ spec.title | caseUcfirst}}Exception}
+     * @returns {{ '{' }}URL{{ '}' }}
+    */
+    {{ method.name | caseCamel }}URL({% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required or parameter.nullable %}?{% endif %}: {{ parameter | getPropertyType(method) | raw }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in method.consumes %}, onProgress = (progress: UploadProgress) => {}{% endif %}): URL {
+        const apiPath = '{{ method.path }}'{% for parameter in method.parameters.path %}.replace('{{ '{' }}{{ parameter.name | caseCamel | escapeKeyword }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
+        const payload: Payload = {};
+
+{% for parameter in method.parameters.query %}
+        if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
+            payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword }};
+        }
+
+{% endfor %}
+{% for parameter in method.parameters.body %}
+        if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
+            payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword }};
+        }
+
+{% endfor %}
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
     }
+{% endif %}
 {% endfor %}
 };