Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dependency and docs updates #24

Merged
merged 7 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Maven Central](https://img.shields.io/maven-central/v/dev.kotbase/couchbase-lite)](
https://central.sonatype.com/namespace/dev.kotbase)
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.22-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.23-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![GitHub License](https://img.shields.io/github/license/jeffdgr8/kotbase)](LICENSE)
[![Couchbase Community](https://img.shields.io/badge/couchbase-community-ea2328?logo=couchbase&logoColor=ea2328)](
https://www.couchbase.com/developers/community/)
Expand All @@ -13,7 +13,7 @@ https://kotlinlang.slack.com/messages/couchbase/)

## Introduction

Kotbase pairs [Kotlin Multiplatform](https://kotlinlang.org/lp/multiplatform/) with [Couchbase Lite](
Kotbase pairs [Kotlin Multiplatform](https://www.jetbrains.com/kotlin-multiplatform/) with [Couchbase Lite](
https://www.couchbase.com/products/lite/), an embedded NoSQL JSON document database. Couchbase Lite can be used as a
standalone client database, or paired with [Couchbase Server](https://www.couchbase.com/products/server/) and [Sync
Gateway](https://www.couchbase.com/products/sync-gateway/) or [Capella App Services](
Expand Down Expand Up @@ -50,7 +50,7 @@ kotlin {
> **Note**
> The Couchbase Lite Community Edition is free and open source. The Enterprise Edition is free for development and
> testing, but requires a [license from Couchbase](https://www.couchbase.com/pricing/#couchbase-mobile) for production
> use. [See Community vs Enterprise Edition.](https://www.couchbase.com/products/editions/#couchbase_lite)
> use. [See Community vs Enterprise Edition.](https://www.couchbase.com/products/editions/mobile/)

Kotbase is published to Maven Central. The Couchbase Lite Enterprise Edition dependency additionally requires the
Couchbase Maven repository.
Expand Down Expand Up @@ -170,6 +170,7 @@ implementation("dev.kotbase:couchbase-lite-ee-paging:3.1.3-1.1.0")
* [ ] SwiftUI for Kotbase Notes
* [x] Couchbase Lite [3.1 API](https://docs.couchbase.com/couchbase-lite/3.1/cbl-whatsnew.html) - Scopes and Collections
* [x] Versioned docs
* [ ] Couchbase Lite 3.2 API - [Vector Search](https://www.couchbase.com/products/vector-search/)
* [ ] Async coroutines API

## Development
Expand Down
3 changes: 3 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import kotlinx.validation.ExperimentalBCVApi
import org.jetbrains.dokka.versioning.VersioningConfiguration
import org.jetbrains.dokka.versioning.VersioningPlugin

Expand Down Expand Up @@ -63,6 +64,8 @@ apiValidation {
"dev.kotbase.paging.BuildConfig",
"dev.kotbase.kermit.BuildConfig"
)
@OptIn(ExperimentalBCVApi::class)
klib.enabled = true
}

tasks.register<Delete>(BasePlugin.CLEAN_TASK_NAME) {
Expand Down
18 changes: 18 additions & 0 deletions couchbase-lite-ee-kermit/api/couchbase-lite-ee-kermit.klib.api
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Klib ABI Dump
// Targets: [iosArm64, iosSimulatorArm64, iosX64, linuxArm64, linuxX64, macosArm64, macosX64, mingwX64]
// Rendering settings:
// - Signature version: 2
// - Show manifest properties: true
// - Show declarations: true

// Library unique name: <dev.kotbase:couchbase-lite-ee-kermit>
final class kotbase.kermit/KermitCouchbaseLiteLogger : kotbase/Logger { // kotbase.kermit/KermitCouchbaseLiteLogger|null[0]
constructor <init>(co.touchlab.kermit/Logger, kotbase/LogLevel =...) // kotbase.kermit/KermitCouchbaseLiteLogger.<init>|<init>(co.touchlab.kermit.Logger;kotbase.LogLevel){}[0]
final fun log(kotbase/LogLevel, kotbase/LogDomain, kotlin/String) // kotbase.kermit/KermitCouchbaseLiteLogger.log|log(kotbase.LogLevel;kotbase.LogDomain;kotlin.String){}[0]
final fun setDomains(kotlin/Array<out kotbase/LogDomain>...) // kotbase.kermit/KermitCouchbaseLiteLogger.setDomains|setDomains(kotlin.Array<out|kotbase.LogDomain>...){}[0]
final val level // kotbase.kermit/KermitCouchbaseLiteLogger.level|{}level[0]
final fun <get-level>(): kotbase/LogLevel // kotbase.kermit/KermitCouchbaseLiteLogger.level.<get-level>|<get-level>(){}[0]
final var domains // kotbase.kermit/KermitCouchbaseLiteLogger.domains|<get-domains>(){}[0]
final fun <get-domains>(): kotlin.collections/Set<kotbase/LogDomain> // kotbase.kermit/KermitCouchbaseLiteLogger.domains.<get-domains>|<get-domains>(){}[0]
final fun <set-domains>(kotlin.collections/Set<kotbase/LogDomain>) // kotbase.kermit/KermitCouchbaseLiteLogger.domains.<set-domains>|<set-domains>(kotlin.collections.Set<kotbase.LogDomain>){}[0]
}
241 changes: 241 additions & 0 deletions couchbase-lite-ee-ktx/api/couchbase-lite-ee-ktx.klib.api

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions couchbase-lite-ee-paging/api/couchbase-lite-ee-paging.klib.api
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Klib ABI Dump
// Targets: [iosArm64, iosSimulatorArm64, iosX64, linuxArm64, linuxX64, macosArm64, macosX64, mingwX64]
// Rendering settings:
// - Signature version: 2
// - Show manifest properties: true
// - Show declarations: true

// Library unique name: <dev.kotbase:couchbase-lite-ee-paging>
final fun <#A: kotlin/Any> kotbase.paging/QueryPagingSource(kotlin.coroutines/CoroutineContext, kotbase/Select, kotbase/Collection, kotlin/Function1<kotlin.collections/Map<kotlin/String, kotlin/Any?>, #A>, kotlin/Function1<kotbase/From, kotbase/LimitRouter>): androidx.paging/PagingSource<kotlin/Int, #A> // kotbase.paging/QueryPagingSource|QueryPagingSource(kotlin.coroutines.CoroutineContext;kotbase.Select;kotbase.Collection;kotlin.Function1<kotlin.collections.Map<kotlin.String,kotlin.Any?>,0:0>;kotlin.Function1<kotbase.From,kotbase.LimitRouter>){0§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> kotbase.paging/QueryPagingSource(kotlin.coroutines/CoroutineContext, kotbase/Select, kotbase/Collection, kotlin/Function1<kotlin/String, #A>, kotlin/Function1<kotbase/From, kotbase/LimitRouter>): androidx.paging/PagingSource<kotlin/Int, #A> // kotbase.paging/QueryPagingSource|QueryPagingSource(kotlin.coroutines.CoroutineContext;kotbase.Select;kotbase.Collection;kotlin.Function1<kotlin.String,0:0>;kotlin.Function1<kotbase.From,kotbase.LimitRouter>){0§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> kotbase.paging/QueryPagingSource(kotlin.coroutines/CoroutineContext, kotbase/Select, kotbase/Database, kotlin/Function1<kotlin.collections/Map<kotlin/String, kotlin/Any?>, #A>): androidx.paging/PagingSource<kotlin/Int, #A> // kotbase.paging/QueryPagingSource|QueryPagingSource(kotlin.coroutines.CoroutineContext;kotbase.Select;kotbase.Database;kotlin.Function1<kotlin.collections.Map<kotlin.String,kotlin.Any?>,0:0>){0§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> kotbase.paging/QueryPagingSource(kotlin.coroutines/CoroutineContext, kotbase/Select, kotbase/Database, kotlin/Function1<kotlin.collections/Map<kotlin/String, kotlin/Any?>, #A>, kotlin/Function1<kotbase/From, kotbase/LimitRouter>): androidx.paging/PagingSource<kotlin/Int, #A> // kotbase.paging/QueryPagingSource|QueryPagingSource(kotlin.coroutines.CoroutineContext;kotbase.Select;kotbase.Database;kotlin.Function1<kotlin.collections.Map<kotlin.String,kotlin.Any?>,0:0>;kotlin.Function1<kotbase.From,kotbase.LimitRouter>){0§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> kotbase.paging/QueryPagingSource(kotlin.coroutines/CoroutineContext, kotbase/Select, kotbase/Database, kotlin/Function1<kotlin/String, #A>): androidx.paging/PagingSource<kotlin/Int, #A> // kotbase.paging/QueryPagingSource|QueryPagingSource(kotlin.coroutines.CoroutineContext;kotbase.Select;kotbase.Database;kotlin.Function1<kotlin.String,0:0>){0§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> kotbase.paging/QueryPagingSource(kotlin.coroutines/CoroutineContext, kotbase/Select, kotbase/Database, kotlin/Function1<kotlin/String, #A>, kotlin/Function1<kotbase/From, kotbase/LimitRouter>): androidx.paging/PagingSource<kotlin/Int, #A> // kotbase.paging/QueryPagingSource|QueryPagingSource(kotlin.coroutines.CoroutineContext;kotbase.Select;kotbase.Database;kotlin.Function1<kotlin.String,0:0>;kotlin.Function1<kotbase.From,kotbase.LimitRouter>){0§<kotlin.Any>}[0]
Loading