Merge remote-tracking branch 'origin/doc-updates' into feat-improve-java-interop

abnegate · abnegate · commit c8cb08054290 · 2022-10-21T22:40:39.000+13:00
# Conflicts:
#	templates/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig
diff --git a/.travis.yml b/.travis.yml
@@ -27,7 +27,7 @@ env:
   - SDK=FlutterStable
   - SDK=Go112
   - SDK=Go118
-  - SDK=FlutterBeta
+#  - SDK=FlutterBeta
   - SDK=KotlinJava8
   - SDK=KotlinJava11
   - SDK=KotlinJava17
diff --git a/templates/android/docs/java/example.md.twig b/templates/android/docs/java/example.md.twig
@@ -1,93 +1,67 @@
-import androidx.appcompat.app.AppCompatActivity
-import android.os.Bundle
-import kotlinx.coroutines.GlobalScope
-import kotlinx.coroutines.launch
+{% import 'kotlin/base/utils.twig' as utils %}
 import {{ sdk.namespace | caseDot }}.Client
 {% if method.parameters.all | filter((param) => param.type == 'file') | length > 0 %}
 import {{ sdk.namespace | caseDot }}.models.InputFile
 {% endif %}
 import {{ sdk.namespace | caseDot }}.services.{{ service.name | caseUcfirst }}
 
-public class MainActivity extends AppCompatActivity {
-
-    @Override
-    protected void onCreate(Bundle savedInstanceState) {
-        super.onCreate(savedInstanceState);
-        setContentView(R.layout.activity_main);
-
-        Client client = new Client(getApplicationContext())
+Client client = Client(context)
 {% if method.security|length > 0 %}
-            .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
+    .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
 {% for node in method.security %}
 {% for key,header in node|keys %}
-            .set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}"){% if loop.last %};{% endif %} // {{node[header].description}}
-{% endfor %}
-{% endfor %}
-{% endif %}
+    .set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}"){% if loop.last %};{% endif %} // {{node[header].description}}
+{% endfor %}{% endfor %}{% endif %}
 
-        {{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
+{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
 
-        {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}new Continuation<Object>() {
-            @NotNull
-            @Override
-            public CoroutineContext getContext() {
-                return EmptyCoroutineContext.INSTANCE;
-            }
+{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}new Continuation<{{ utils.resultTypeJava(sdk.namespace, method) }}>() {
+    @NotNull
+    @Override
+    public CoroutineContext getContext() {
+        return EmptyCoroutineContext.INSTANCE;
+    }
 
-            @Override
-            public void resumeWith(@NotNull Object o) {
-                String json = "";
-                try {
-                    if (o instanceof Result.Failure) {
-                        Result.Failure failure = (Result.Failure) o;
-                        throw failure.exception;
-                    }{% if method.type != "webAuth" %} else {
-                            Response response = (Response) o;
-                            json = response.body().string();
-                        }{% endif %}
-                    
-                    }
-                } catch (Throwable th) {
-                    Log.e("ERROR", th.toString());
-                }
-            }
-        });{% endif %}
+    @Override
+    public void resumeWith(@NotNull Object o) {
+        if (o instanceof Result.Failure) {
+            Result.Failure failure = (Result.Failure) o;
+            failure.exception.printStackTrace();
+            return;
+        }
+
+        {{ utils.resultTypeJava(sdk.namespace, method) }} response = ({{ utils.resultTypeJava(sdk.namespace, method) }}) o;
+    }
+});{% endif %}
 
-{% if method.type == "webAuth" %}
-            this,
-{% endif %}
 {% for parameter in method.parameters.all %}
 {% if parameter.required %}
-            {{ parameter | paramExample }}{% if not loop.last %}, {% endif %}
+    {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
 
 {% endif %}
 {% if loop.last %}
-            new Continuation<Object>() {
-                @NotNull
-                @Override
-                public CoroutineContext getContext() {
-                    return EmptyCoroutineContext.INSTANCE;
-                }
+    new Continuation<{{ utils.resultTypeJava(sdk.namespace, method) }}>() {
+        @NotNull
+        @Override
+        public CoroutineContext getContext() {
+            return EmptyCoroutineContext.INSTANCE;
+        }
 
-                @Override
-                public void resumeWith(@NotNull Object o) {
-                    String json = "";
-                    try {
-                        if (o instanceof Result.Failure) {
-                            Result.Failure failure = (Result.Failure) o;
-                            throw failure.exception;
-                        }{% if method.type != "webAuth" %} else {
-                            Response response = (Response) o;
-                            json = response.body().string();
-                        }{% endif %}
-                    
-                    } catch (Throwable th) {
-                        Log.e("ERROR", th.toString());
-                    }
-                }
+        @Override
+        public void resumeWith(@NotNull Object o) {
+            if (o instanceof Result.Failure) {
+                Result.Failure failure = (Result.Failure) o;
+                failure.exception.printStackTrace();
+                return;
             }
-        );
-{% endif %}
-{% endfor %}
+
+            {%~ if method.type != 'webAuth' %}
+            {{ utils.resultTypeJava(sdk.namespace, method) }} response = ({{ utils.resultTypeJava(sdk.namespace, method) }}) o;
+            {%~ else %}
+            // Success
+            {%~ endif %}
+        }
     }
-}
+);
+{% endif %}
+{% endfor %}
diff --git a/templates/android/docs/kotlin/example.md.twig b/templates/android/docs/kotlin/example.md.twig
@@ -1,47 +1,27 @@
-import androidx.appcompat.app.AppCompatActivity
-import android.os.Bundle
-import kotlinx.coroutines.GlobalScope
-import kotlinx.coroutines.launch
 import {{ sdk.namespace | caseDot }}.Client
 {% if method.parameters.all | filter((param) => param.type == 'file') | length > 0 %}
 import {{ sdk.namespace | caseDot }}.models.InputFile
 {% endif %}
 import {{ sdk.namespace | caseDot }}.services.{{ service.name | caseUcfirst }}
 
-class MainActivity : AppCompatActivity() {
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-        setContentView(R.layout.activity_main)
-
-        val client = Client(applicationContext)
+val client = Client(context)
 {% if method.security|length > 0 %}
-            .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
+    .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
 {% for node in method.security %}
 {% for key,header in node|keys %}
-            .set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}") // {{node[header].description}}
-{% endfor %}
-{% endfor %}
-{% endif %}
+    .set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}") // {{node[header].description}}
+{% endfor %}{% endfor %}{% endif %}
 
-        val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
+val {{ service.name | caseCamel }} = {{ service.name | caseUcfirst }}(client)
 
-        GlobalScope.launch {
-{% if method.type == 'webAuth' %}            {% elseif method.type == 'location' %}            val result = {% else %}            val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
+{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}val result = {% else %}val response = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}){% endif %}
 
-{% if method.type == "webAuth" %}
-                activity = this@MainActivity,
-{% endif %}
 {% for parameter in method.parameters.all %}
 {% if parameter.required %}
-                {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
+    {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
 
 {% endif %}
 {% if loop.last %}
-            )
+)
 {% endif %}
-{% endfor %}
-{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}            println(result); // Resource URL{% else %}            val json = response.body?.string(){% endif %}
-        
-        }
-    }
-}
+{% endfor %}
diff --git a/templates/kotlin/base/requests/api.twig b/templates/kotlin/base/requests/api.twig
@@ -4,7 +4,7 @@
             path,
             headers,
             params,
-            responseType = {{ utils.resultType(sdk.namespace, method) }}::class.java,
+            responseType = {{ utils.resultTypeKt(sdk.namespace, method) }}::class.java,
 {% if method.responseModel %}
             converter,
 {% endif %}
diff --git a/templates/kotlin/base/requests/file.twig b/templates/kotlin/base/requests/file.twig
@@ -10,7 +10,7 @@
             path,
             headers,
             params,
-            responseType = {{ utils.resultType(sdk.namespace, method) }}::class.java,
+            responseType = {{ utils.resultTypeKt(sdk.namespace, method) }}::class.java,
 {% if method.responseModel %}
             converter,
 {% endif %}
diff --git a/templates/kotlin/base/requests/location.twig b/templates/kotlin/base/requests/location.twig
@@ -3,5 +3,5 @@
             "{{ method.method | caseUpper }}",
             path,
             params = params,
-            responseType = {{ utils.resultType(sdk.namespace, method) }}::class.java
+            responseType = {{ utils.resultTypeKt(sdk.namespace, method) }}::class.java
         )
diff --git a/templates/kotlin/base/utils.twig b/templates/kotlin/base/utils.twig
@@ -5,6 +5,9 @@
 {% macro methodNeedsSecurityParameters(method) %}
 {% if (method.type == "webAuth" or method.type == "location") and method.security|length > 0 %}{{ true }}{% else %}{{false}}{% endif %}
 {% endmacro %}
-{% macro resultType(namespace, method) %}
-{% if method.type == "webAuth" %}Bool{% elseif method.type == "location" %}ByteArray{% elseif not method.responseModel or method.responseModel == 'any' %}Any{% else %}{{ namespace | caseDot}}.models.{{method.responseModel | caseUcfirst}}{% endif %}
+{% macro resultTypeKt(namespace, method) %}
+{% if method.type == "webAuth" %}{% elseif method.type == "location" %}ByteArray{% elseif not method.responseModel or method.responseModel == 'any' %}Any{% else %}{{ namespace | caseDot}}.models.{{method.responseModel | caseUcfirst}}{% endif %}
+{% endmacro %}
+{% macro resultTypeJava(namespace, method) %}
+{% if method.type == "webAuth" %}Void{% elseif method.type == "location" %}byte[]{% elseif not method.responseModel or method.responseModel == 'any' %}Object{% else %}{{ namespace | caseDot}}.models.{{method.responseModel | caseUcfirst}}{% endif %}
 {% endmacro %}
diff --git a/templates/kotlin/docs/java/example.md.twig b/templates/kotlin/docs/java/example.md.twig
@@ -1,71 +1,67 @@
+{% import 'kotlin/base/utils.twig' as utils %}
 import {{ sdk.namespace | caseDot }}.Client
 {% if method.parameters.all | filter((param) => param.type == 'file') | length > 0 %}
 import {{ sdk.namespace | caseDot }}.models.InputFile
 {% endif %}
 import {{ sdk.namespace | caseDot }}.services.{{ service.name | caseUcfirst }}
 
-public void main() {
-    Client client = Client(context)
+Client client = Client(context)
 {% if method.security|length > 0 %}
-        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
+    .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
 {% for node in method.security %}
 {% for key,header in node|keys %}
-        .set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}"){% if loop.last %};{% endif %} // {{node[header].description}}
+    .set{{header | caseUcfirst}}("{{node[header]['x-appwrite']['demo']}}"){% if loop.last %};{% endif %} // {{node[header].description}}
 {% endfor %}{% endfor %}{% endif %}
 
-    {{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
-    {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}new Continuation<Response>() {
-        @NotNull
-        @Override
-        public CoroutineContext getContext() {
-            return EmptyCoroutineContext.INSTANCE;
-        }
+{{ service.name | caseUcfirst }} {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
 
-        @Override
-        public void resumeWith(@NotNull Object o) {
-            String json = "";
-            try {
-                if (o instanceof Result.Failure) {
-                    Result.Failure failure = (Result.Failure) o;
-                    throw failure.exception;
-                } else {
-                    Response response = (Response) o;
-                }
-            } catch (Throwable th) {
-                Log.e("ERROR", th.toString());
-            }
+{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %}new Continuation<{{ utils.resultTypeJava(sdk.namespace, method) }}>() {
+    @NotNull
+    @Override
+    public CoroutineContext getContext() {
+        return EmptyCoroutineContext.INSTANCE;
+    }
+
+    @Override
+    public void resumeWith(@NotNull Object o) {
+        if (o instanceof Result.Failure) {
+            Result.Failure failure = (Result.Failure) o;
+            failure.exception.printStackTrace();
+            return;
         }
-    });{% endif %}
+
+        {{ utils.resultTypeJava(sdk.namespace, method) }} response = ({{ utils.resultTypeJava(sdk.namespace, method) }}) o;
+    }
+});{% endif %}
 
 {% for parameter in method.parameters.all %}
 {% if parameter.required %}
-        {{parameter.name}} = {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
+    {{ parameter | paramExample }}{% if not loop.last %},{% endif %}
 
 {% endif %}
 {% if loop.last %}
-        new Continuation<Response>() {
-            @NotNull
-            @Override
-            public CoroutineContext getContext() {
-                return EmptyCoroutineContext.INSTANCE;
-            }
+    new Continuation<{{ utils.resultTypeJava(sdk.namespace, method) }}>() {
+        @NotNull
+        @Override
+        public CoroutineContext getContext() {
+            return EmptyCoroutineContext.INSTANCE;
+        }
 
-            @Override
-            public void resumeWith(@NotNull Object o) {
-                String json = "";
-                try {
-                    if (o instanceof Result.Failure) {
-                        Result.Failure failure = (Result.Failure) o;
-                        throw failure.exception;
-                    } else {
-                        Response response = (Response) o;
-                    }
-                } catch (Throwable th) {
-                    Log.e("ERROR", th.toString());
-                }
+        @Override
+        public void resumeWith(@NotNull Object o) {
+            if (o instanceof Result.Failure) {
+                Result.Failure failure = (Result.Failure) o;
+                failure.exception.printStackTrace();
+                return;
             }
+
+            {%~ if method.type != 'webAuth' %}
+            {{ utils.resultTypeJava(sdk.namespace, method) }} response = ({{ utils.resultTypeJava(sdk.namespace, method) }}) o;
+            {%~ else %}
+            // Success
+            {%~ endif %}
         }
-    );
+    }
+);
 {% endif %}
-{% endfor %}
-}
+{% endfor %}
diff --git a/templates/kotlin/docs/kotlin/example.md.twig b/templates/kotlin/docs/kotlin/example.md.twig
diff --git a/templates/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig b/templates/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig
diff --git a/templates/swift/docs/example.md.twig b/templates/swift/docs/example.md.twig

Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"{{ method.method \| caseUpper }}",`
`4`	`4`	`path,`
`5`	`5`	`params = params,`
`6`		`- responseType = {{ utils.resultType(sdk.namespace, method) }}::class.java`
	`6`	`+ responseType = {{ utils.resultTypeKt(sdk.namespace, method) }}::class.java`
`7`	`7`	`)`