Add some docs

Author: jan-tennert

KSP/README.md

@@ -0,0 +1,43 @@
+# Supabase KSP compiler
+
+Currently only supports generating columns for `@Selectable` types.
+
+To install it, add the KSP Gradle plugin to your project:
+
+```kotlin
+plugins {
+    id("com.google.devtools.ksp") version "2.0.21-1.0.25" //kotlinVersion-kspVersion
+}
+```
+
+Then add the Supabase KSP compiler to your dependencies:
+
+> [!NOTE]
+> `VERSION` is the same as the Supabase-kt version.
+
+**JVM**:
+
+```kotlin
+depdencies {
+    ksp("io.github.jan-tennert.supabase:ksp-compiler:VERSION")
+}
+```
+
+**Multiplatform**:
+
+```kotlin
+kotlin {
+    //...
+    jvm()
+    androidTarget()
+    iosX64()
+    //...
+}
+
+dependencies {
+    //Advised to use Gradle Version Catalogs
+    add("kspCommonMainMetadata", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")
+    add("kspJvm", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")
+    add("kspAndroid", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")
+    add("kspIosX64", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")
+}

KSP/src/main/kotlin/io/github/jan/supabase/ksp/SelectableSymbolProcessor.kt

@@ -11,8 +11,11 @@ import com.google.devtools.ksp.symbol.KSFile
 import com.google.devtools.ksp.symbol.KSNode
 import com.google.devtools.ksp.symbol.KSValueParameter
 import com.google.devtools.ksp.symbol.Modifier
+import com.squareup.kotlinpoet.AnnotationSpec
+import com.squareup.kotlinpoet.ClassName
 import com.squareup.kotlinpoet.FileSpec
 import com.squareup.kotlinpoet.FunSpec
+import io.github.jan.supabase.annotations.SupabaseInternal
 import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.annotations.ApplyFunction
 import io.github.jan.supabase.postgrest.annotations.Cast
@@ -61,9 +64,10 @@ class SelectableSymbolProcessor(
         columns: Map<String, String>,
         sources: List<KSFile>
     ) {
-        //Maybe add comments and SupabaseInternal annotations
         val function = FunSpec.builder("addSelectableTypes")
             .addKdoc(COMMENT)
+            .addAnnotation(AnnotationSpec.builder(ClassName.bestGuess("kotlin.OptIn")).addMember("%T::class",
+                SupabaseInternal::class).build())
             .receiver(Postgrest.Config::class)
         columns.forEach { (qualifiedName, columns) ->
             function.addStatement("columnRegistry.registerColumns(\"$qualifiedName\", \"$columns\")")

Postgrest/README.md

@@ -59,6 +59,9 @@ val supabase = createSupabaseClient(
 }
 ```
 
+> [!NOTE]
+> Generating columns for `@Selectable` requires the [KSP compiler](/KSP) to be installed.
+
 # Usage
 
 See [Postgrest documentation](https://supabase.com/docs/reference/kotlin/select) for usage

Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/ColumnRegistry.kt

@@ -1,7 +1,9 @@
 package io.github.jan.supabase.postgrest
 
+import io.github.jan.supabase.annotations.SupabaseInternal
 import kotlin.reflect.KClass
 
+@SupabaseInternal
 class ColumnRegistry(
     private val map: MutableMap<String, String> = mutableMapOf()
 ) {

Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/Postgrest.kt

@@ -2,7 +2,8 @@ package io.github.jan.supabase.postgrest
 
 import io.github.jan.supabase.SupabaseClient
 import io.github.jan.supabase.SupabaseSerializer
-import io.github.jan.supabase.exceptions.HttpRequestException
+import io.github.jan.supabase.annotations.SupabaseInternal
+import io.github.jan.supabase.exceptions.RestException
 import io.github.jan.supabase.logging.SupabaseLogger
 import io.github.jan.supabase.plugins.CustomSerializationConfig
 import io.github.jan.supabase.plugins.CustomSerializationPlugin
@@ -101,7 +102,7 @@ interface Postgrest : MainPlugin<Postgrest.Config>, CustomSerializationPlugin {
     data class Config(
         var defaultSchema: String = "public",
         var propertyConversionMethod: PropertyConversionMethod = PropertyConversionMethod.CAMEL_CASE_TO_SNAKE_CASE,
-        var columnRegistry: ColumnRegistry = ColumnRegistry()
+        @property:SupabaseInternal var columnRegistry: ColumnRegistry = ColumnRegistry()
     ): MainConfig(), CustomSerializationConfig {
 
         override var serializer: SupabaseSerializer? = null