Feat kmp sdk #1040

camka14 · 2025-02-27T23:52:40Z

What does this PR do?

Adds a KMP SDK

Test Plan

Run KMPAndroid14Java17Test
Test OAuth2, cookies, and iOS file uploads using custom project in Android Studio

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

yes

…to feat-kmp-sdk

Certain data classes weren't serializing properly, moved actualSerializer to be above apiParams, added json encoding to data.

The socket was being created unnecessarily whenever a subscription was removed. This change ensures that the socket is only created when there are active channels.

abnegate · 2025-02-28T08:44:32Z

templates/kmp/settings.gradle.kts

+    }
+}
+
+rootProject.name = "Appwrite_KMP_SDK"


Let's name this sdk-for-kmp

abnegate · 2025-02-28T08:49:59Z

templates/kmp/shared/src/androidMain/kotlin/io/package/HttpClientConfig.kt.twig

+    } else {
+        engine {
+            config {
+                val trustManagerFactory =
+                    TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm())
+                trustManagerFactory.init(null as KeyStore?)
+                val sslContext = SSLContext.getInstance("TLS").apply {
+                    init(null, trustManagerFactory.trustManagers, SecureRandom())
+                }
+                sslSocketFactory(
+                    sslContext.socketFactory,
+                    trustManagerFactory.trustManagers[0] as X509TrustManager
+                )
+            }
+        }


Can this else block be skipped? Is it the same as a the default behaviour?

I'm not super familiar with certificates, but from my understanding this uses a PKIX algorithm instead of Trust All. I'm not sure if that's the correct approach, but I figured if there was an option to not run setSelfSigned then it should use a standard algorithm?

We can remove the else block, since the behavior when not setting self-signed will be the same with or without it 👌

abnegate · 2025-03-13T07:57:17Z

src/SDK/Language/Kotlin.php

@@ -466,7 +466,7 @@ protected function getReturnType(array $method, array $spec, string $namespace,

        $ret = $this->toPascalCase($method['responseModel']);

-        if ($this->hasGenericType($method['responseModel'], $spec)) {
+        if ($this->hasGenericType($method['responseModel'], $spec) && $withGeneric) {


What's the use case for skipping the generic?

It's for situations like this:
serializer = io.appwrite.models.Document.serializer(actualSerializer)

without the skip I would get serializer = io.appwrite.models.Document<T>.serializer(actualSerializer)

I just found how it's been done for the same situation:
{{sdk.namespace | caseDot}}.models.{{ method.responseModel | caseUcfirst }}

I can change it to match the original method and get rid of this change if you like that better.

Yep let's do it so we can handle both generics and non-generics in one shot

templates/android/library/src/main/java/io/package/WebAuthComponent.kt.twig

templates/cli/scoop/appwrite.json.twig

abnegate · 2025-05-22T14:37:17Z

templates/kmp/shared/src/jvmMain/kotlin/io/package/Client.jvm.kt.twig

+    private val appVersion by lazy {
+        try {
+            val properties = Properties()
+            properties.load(this.javaClass.getResourceAsStream("/version.properties"))


Is this safe? Can we guarantee the file will always exist?

I'm not in a position to get the JVM stuff working properly right now so I was thinking of removing it entirely. I added it for a quick test that I was doing so I just did a port from the androidMain to jvmMain with chatGPT. I wasn't planning on this PR being a v1.0 or anything so I thought I'd add my JVM stuff to get the ball rolling. Let me know if you think JVM should just be removed in this case. It shouldn't be too difficult to add back since it's so similar to the android side.

Makes sense, we can remove for now and add other platform support in phases 👌

abnegate · 2025-05-22T14:37:49Z

templates/kmp/shared/src/jvmMain/kotlin/io/package/Client.jvm.kt.twig

+            "origin" to "appwrite-jvm://app",
+            "content-type" to "application/json",
+            "origin" to "{{ spec.title | caseLower }}-jvm://app",
+            "user-agent" to "JVM/$appVersion, ${System.getProperty("java.version")}",


Let's remove the first origin

abnegate · 2025-05-22T14:43:25Z

templates/php/tests/IDTest.php.twig

What's changed in these php tests?

Nothing, I think they got caught in me updating the line endings. I'll revert them

abnegate · 2025-05-22T14:46:15Z

tests/KMPAndroid14Java17Test.php

+        'chmod +x tests/sdks/kmp/gradlew',
+    ];
+    protected string $command =
+        'docker run --rm --platform linux/amd64 --network="mockapi" -v $(pwd):/app -w /app/tests/sdks/kmp alvrme/alpine-android:android-34-jdk17 sh -c "./gradlew :shared:testDebugUnitTest --stacktrace -q && cat shared/result.txt"';


Do we need to specify platform here? I think this image is multi-arch right?

abnegate · 2025-05-22T14:48:00Z

tests/KMPAndroid14Java17Test.php

Please add tests for iOS and JVM too. We can also add them in .github/workflows/tests.yml so they run for each PR

Any luck here?

…to feat-kmp-sdk

…ded, Fix http/https check in Client

This commit refactors the OAuth2 authentication flow on iOS to use `ASWebAuthenticationSession` instead of `UIApplication.openURL`. This provides a more secure and user-friendly authentication experience. Key changes: - `WebAuthComponent.ios.kt`: - Replaced `UIApplication.openURL` with `ASWebAuthenticationSession`. - Added `PresentationContextProviderImpl` to provide a presentation anchor for the authentication session. - Updated `PendingAuth` to store the `ASWebAuthenticationSession`. - Improved error handling and cancellation. - Added `setCookieStorage` to allow passing the cookie storage instance. - Modified `handleIncomingCookie` to parse cookie details from the callback URL and store them using the provided `IosCookieStorage` and `NSUserDefaults`. - Added a `cleanup` method to cancel pending authentication sessions. - `OAuth2Extensions.kt`: - Updated `createOAuth2Session` and `createOAuth2Token` to use the new `WebAuthComponent` and pass the `iosCookieStorage`. - Ensured cookies are correctly constructed and stored. - Improved error handling for missing authentication cookies.

abnegate · 2025-08-01T06:51:50Z

templates/kmp/README.md.twig

+   sourceSets {
+      commonMain {
+         dependencies {
+            implementation("io.github.camka14.appwrite:sdk-for-kmp:0.1.0")


Let's template the group name and version here

abnegate · 2025-08-01T06:53:30Z

templates/kmp/androidApp/src/main/res/values/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="app_name">Appwrite KMP SDK</string>


Let's template the values here

abnegate · 2025-08-01T06:53:44Z

templates/kmp/androidApp/src/main/res/values/themes.xml

@@ -0,0 +1,16 @@
+<resources xmlns:tools="http://schemas.android.com/tools">
+    <!-- Base application theme. -->
+    <style name="Theme.AppwriteKMPSDK" parent="Theme.MaterialComponents.DayNight.DarkActionBar">


Let's template

abnegate · 2025-08-01T06:57:45Z

templates/kmp/shared/src/androidMain/kotlin/io/package/Client.android.kt.twig

+import okio.Path.Companion.toPath
+
+actual class Client constructor(
+    private val context: Context,


Any thoughts here? If users don't pass application context specifically this will be a memory leak if the client outlives the context

templates/kmp/shared/src/androidMain/kotlin/io/package/HttpClientConfig.kt.twig

abnegate · 2025-08-01T07:00:42Z

templates/kmp/shared/src/androidMain/kotlin/io/package/HttpClientConfig.kt.twig

+        storage = dataStoreCookieStorage
+    }
+    install(WebSockets) {
+        pingInterval = 30.seconds


Does this integrate with our custom ping 🤔

abnegate · 2025-08-01T07:30:08Z

templates/kmp/shared/src/iosMain/kotlin/io/package/cookies/IosCookieStorage.kt.twig

+        val properties = mutableMapOf<Any?, Any?>(
+            NSHTTPCookieName to storedCookie.name,
+            NSHTTPCookieValue to storedCookie.value,
+            NSHTTPCookiePath to storedCookie.path,
+            NSHTTPCookieDomain to storedCookie.domain
+        )


Lets also handle expires, max-age, samesite, httponly, and secure

abnegate · 2025-08-01T07:32:30Z

templates/kmp/shared/src/iosMain/kotlin/io/package/extensions/OAuth2Extensions.kt.twig

OAuth methods should be handled in the service template so they appear along other Account methods

abnegate · 2025-08-01T07:34:00Z

templates/kmp/shared/src/iosMain/kotlin/io/package/extensions/OAuth2Extensions.kt.twig

+        }
+
+        result.getOrNull()?.let { callbackUrl ->
+            runBlocking {


Let's avoid runBlocking here

abnegate · 2025-08-01T07:35:21Z

templates/kmp/shared/src/jvmMain/kotlin/io/package/Client.jvm.kt.twig

+    private val appVersion by lazy {
+        try {
+            val properties = Properties()
+            properties.load(this.javaClass.getResourceAsStream("/version.properties"))


Makes sense, we can remove for now and add other platform support in phases 👌

abnegate · 2025-08-01T07:36:14Z

tests/KMPAndroid14Java17Test.php

Any luck here?

camka14 and others added 15 commits January 17, 2025 14:57

Initial twig translation of KMP SDK

21d70cc

Add Test Generation,

8ade1e3

Fix Test and Release compiling

eb33d83

Pass all tests

9c5993f

Merge branch 'master' of https://github.com/appwrite/sdk-generator in…

fd9cb4b

…to feat-kmp-sdk

Remove Document twig file, remove Document type form RealtimModels

ec73e97

Update x-appwrite-response-format to 1.6.0

876e363

Fix OAuth2 login handling

e9e3b6f

Merge branch 'master' of https://github.com/appwrite/sdk-generator in…

af0861d

…to feat-kmp-sdk

Switch WebAuthComponent to activity instead of context

a98cca2

Add OAuth2 handling

94f4042

Merge branch 'master' of https://github.com/appwrite/sdk-generator in…

193d171

…to feat-kmp-sdk

Fix iOS and JVM OAuth2Extensions class names

eebc424

Fix update and create document methods

c75c8c1

Certain data classes weren't serializing properly, moved actualSerializer to be above apiParams, added json encoding to data.

Fix old cookies being used when domain is preceded by "."

6b9a5b3

abnegate self-assigned this Mar 19, 2025

Fix socket creation in Realtime.kt

085f227

The socket was being created unnecessarily whenever a subscription was removed. This change ensures that the socket is only created when there are active channels.

camka14 force-pushed the feat-kmp-sdk branch from 6a7f1a4 to 085f227 Compare May 12, 2025 16:57

Fix encoding prefs error

3c5dc82

abnegate reviewed May 22, 2025

View reviewed changes

camka14 and others added 10 commits May 22, 2025 10:20

Merge branch 'master' of https://github.com/appwrite/sdk-generator in…

cf1aeb8

…to feat-kmp-sdk

PR Changes per comments

9e4a3ca

Revert uninteded changes

763ec35

Revert Uninteded File Change

072ad1a

Replace io.appwrite with proper value

40bc4d0

Update KMP tests, replace spec.namespace with sdk.namespace where nee…

4b215e0

…ded, Fix http/https check in Client

Remove println in iosCookieStorage

19aa2d5

Incorrect new line

90ba7b7

Added variables for ios client headers

d7ae324

camka14 added 3 commits May 31, 2025 18:49

AppwriteException incorrect Case

9d5868b

Fix error thrown outside of scope in iOS OAuth Cancellation

107321d

Fix iOS cookie storage not recreating cookies properly

c606846

abnegate reviewed Aug 1, 2025

View reviewed changes

		@@ -0,0 +1,3 @@
		<resources>
		<string name="app_name">Appwrite KMP SDK</string>

Feat kmp sdk #1040

Are you sure you want to change the base?

Feat kmp sdk #1040

Uh oh!

Conversation

camka14 commented Feb 27, 2025

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abnegate Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abnegate Aug 1, 2025 •

edited

Loading