@youversion/platform-react-native 0.7.2 → 0.9.0

package/.releaserc.json

@@ -68,6 +68,7 @@
       "@semantic-release/npm",
       {
         "npmPublish": true,
+        "provenance": true,
         "tarballDir": "dist"
       }
     ],

package/AGENTS.md

@@ -0,0 +1,86 @@
+# AI Agent Instructions
+
+This document provides guidelines and instructions for AI agents working with this codebase.
+
+## Review Guidelines
+
+When conducting code reviews, AI agents should systematically evaluate the following aspects:
+
+### Code Standards and Conventions
+- Do the changes follow the established conventions and patterns used throughout the codebase?
+- Is the code style consistent with existing code (indentation, naming conventions, file organization)?
+- Are the appropriate design patterns being used where applicable?
+- Does the code follow the project's established architecture and structure?
+
+### Security Assessment
+- Do the changes introduce any security vulnerabilities or risks?
+- Are user inputs properly validated and sanitized?
+- Is sensitive data properly handled and protected?
+- Are authentication and authorization checks properly implemented?
+- Are there any exposed API keys, credentials, or sensitive configuration data?
+- Are network requests using appropriate security protocols (HTTPS, proper headers)?
+
+### Performance Considerations
+- Do the changes introduce potential performance bottlenecks?
+- Are there any inefficient algorithms or data structures being used?
+- Is there unnecessary re-rendering or state updates in React components?
+- Are large lists properly virtualized where appropriate?
+- Is lazy loading implemented for heavy resources?
+- Are bundle sizes kept reasonable (no unnecessary dependencies)?
+- Are database queries optimized and avoiding N+1 problems?
+- Is proper caching implemented where beneficial?
+
+### Platform-Specific Best Practices
+
+#### React Native
+- Are components properly optimized using React.memo, useMemo, and useCallback where appropriate?
+- Is the SDK using the appropriate React Native APIs for the target architecture version?
+- Are platform-specific code paths properly handled?
+- Are native modules properly linked and configured?
+
+#### Kotlin (Android)
+- Does the code follow Kotlin idioms and best practices?
+- Are coroutines used properly for asynchronous operations?
+- Is proper null safety maintained throughout?
+- Are Android lifecycle methods properly handled?
+- Is memory management appropriate (avoiding leaks)?
+
+#### Swift (iOS)
+- Does the code follow Swift conventions and best practices?
+- Is proper memory management used (weak/unowned references where appropriate)?
+- Are optionals handled safely?
+- Is the code taking advantage of Swift's type safety?
+- Are iOS-specific considerations handled (app states, background tasks)?
+
+### Functional Verification
+- Does the code actually implement what the PR description claims?
+- Are all acceptance criteria from the related issue/ticket met?
+- Are edge cases properly handled?
+- Is error handling comprehensive and user-friendly?
+- Are all promised features fully implemented and working?
+
+### Testing and Documentation
+- Are appropriate tests included for new functionality?
+- Do existing tests still pass?
+- Is the code self-documenting with clear variable and function names?
+- Are complex logic sections properly commented?
+- Are API changes documented?
+- Are breaking changes clearly identified?
+
+### Dependencies and Compatibility
+- Are new dependencies necessary and well-maintained?
+- Are version requirements appropriate?
+- Is backward compatibility maintained where expected?
+- Are deprecated APIs avoided?
+- Are platform version requirements respected?
+
+### Accessibility
+- Are accessibility features properly implemented (screen readers, keyboard navigation)?
+- Are appropriate accessibility labels and hints provided?
+- Do UI changes maintain or improve accessibility?
+
+### User Experience
+- Do the changes provide a smooth and intuitive user experience?
+- Are loading states and error messages user-friendly?
+- Is feedback provided for user actions?
+- Are animations and transitions smooth and purposeful?

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 0.9.0 (2026-01-31)
+
+* feat: Update Kotlin SDK and fix all breaking changes (#36) ([0e03b0e](https://github.com/youversion/platform-sdk-reactnative/commit/0e03b0e)), closes [#36](https://github.com/youversion/platform-sdk-reactnative/issues/36)
+* feat (android): add view module stubs for RN bridging (#31) ([66cf642](https://github.com/youversion/platform-sdk-reactnative/commit/66cf642)), closes [#31](https://github.com/youversion/platform-sdk-reactnative/issues/31)
+
+## 0.8.0 (2026-01-16)
+
+* chore: Depend on most recent Swift SDK version and update breaking changes (#27) ([a042211](https://github.com/youversion/platform-sdk-reactnative/commit/a042211)), closes [#27](https://github.com/youversion/platform-sdk-reactnative/issues/27)
+* chore(ci): Disable NPM tokens in release workflow (#28) ([c63c21a](https://github.com/youversion/platform-sdk-reactnative/commit/c63c21a)), closes [#28](https://github.com/youversion/platform-sdk-reactnative/issues/28)
+* chore(ci): update semantic-release to support OIDC workflow (#29) ([de337dc](https://github.com/youversion/platform-sdk-reactnative/commit/de337dc)), closes [#29](https://github.com/youversion/platform-sdk-reactnative/issues/29)
+* chore(ci): YPE-1050 Modify release.yml for permissions and Node.js version ([2c86c6f](https://github.com/youversion/platform-sdk-reactnative/commit/2c86c6f))
+* Add NODE_AUTH_TOKEN to release workflow ([2bdc89c](https://github.com/youversion/platform-sdk-reactnative/commit/2bdc89c))
+* Add provenance option to npm release configuration ([d746acf](https://github.com/youversion/platform-sdk-reactnative/commit/d746acf))
+* Enable NPM_CONFIG_PROVENANCE in release workflow ([e027853](https://github.com/youversion/platform-sdk-reactnative/commit/e027853))
+* Update Node.js version and add NPM upgrade step ([ee94aa2](https://github.com/youversion/platform-sdk-reactnative/commit/ee94aa2))
+* feat: add support for `configure` in Kotlin (#16) ([d9bca2d](https://github.com/youversion/platform-sdk-reactnative/commit/d9bca2d)), closes [#16](https://github.com/youversion/platform-sdk-reactnative/issues/16)
+* feat: implement `setApiHost` and `getAccessToken` in Kotlin (#17) ([a4ee43c](https://github.com/youversion/platform-sdk-reactnative/commit/a4ee43c)), closes [#17](https://github.com/youversion/platform-sdk-reactnative/issues/17)
+* feat: Implement `SignInWithYouVersionButton` for Kotlin (#26) ([5072471](https://github.com/youversion/platform-sdk-reactnative/commit/5072471)), closes [#26](https://github.com/youversion/platform-sdk-reactnative/issues/26)
+* feat: Implement API utils for Kotlin/Android (#25) ([9a88926](https://github.com/youversion/platform-sdk-reactnative/commit/9a88926)), closes [#25](https://github.com/youversion/platform-sdk-reactnative/issues/25)
+* feat: implement votd API endpoint for Kotlin (#19) ([59e6874](https://github.com/youversion/platform-sdk-reactnative/commit/59e6874)), closes [#19](https://github.com/youversion/platform-sdk-reactnative/issues/19)
+* docs: add AI agent code review guidelines (#23) ([8218cec](https://github.com/youversion/platform-sdk-reactnative/commit/8218cec)), closes [#23](https://github.com/youversion/platform-sdk-reactnative/issues/23)
+
 ## <small>0.7.2 (2025-11-24)</small>
 
 * fix(release): update package name to align to SDK naming (#24) ([9d4a1d7](https://github.com/youversion/platform-sdk-reactnative/commit/9d4a1d7)), closes [#24](https://github.com/youversion/platform-sdk-reactnative/issues/24)

package/android/build.gradle

@@ -1,10 +1,20 @@
+buildscript {
+  repositories {
+    mavenCentral()
+  }
+  dependencies {
+    classpath("org.jetbrains.kotlin.plugin.compose:org.jetbrains.kotlin.plugin.compose.gradle.plugin:${kotlinVersion}")
+  }
+}
+
 apply plugin: 'com.android.library'
 
 group = 'com.youversion.reactnativesdk'
-version = '0.7.2'
+version = '0.9.0'
 
 def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
 apply from: expoModulesCorePlugin
+apply plugin: 'org.jetbrains.kotlin.plugin.compose'
 applyKotlinExpoModulesCorePlugin()
 useCoreDependencies()
 useExpoPublishing()
@@ -35,9 +45,22 @@ android {
   namespace "com.youversion.reactnativesdk"
   defaultConfig {
     versionCode 1
-    versionName "0.7.2"
+    versionName "0.9.0"
+  }
+  buildFeatures {
+    compose true
   }
   lintOptions {
     abortOnError false
   }
 }
+
+dependencies {
+  implementation 'androidx.compose.ui:ui-android:1.9.1'
+  implementation 'androidx.compose.foundation:foundation-android:1.9.1'
+  implementation 'androidx.compose.material3:material3-android:1.3.2'
+
+  implementation 'com.youversion.platform:platform-core:0.6.0'
+  implementation 'com.youversion.platform:platform-ui:0.6.0'
+  implementation 'com.youversion.platform:platform-reader:0.6.0'
+}

package/android/src/main/java/com/youversion/reactnativesdk/RNBibleReaderViewModule.kt

@@ -0,0 +1,13 @@
+package com.youversion.reactnativesdk
+
+import com.youversion.reactnativesdk.views.YVPBibleReaderView
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class RNBibleReaderViewModule : Module() {
+    override fun definition() = ModuleDefinition {
+        Name("BibleReaderView")
+
+        View(YVPBibleReaderView::class)
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/RNBibleTextViewModule.kt

@@ -0,0 +1,15 @@
+package com.youversion.reactnativesdk
+
+import com.youversion.reactnativesdk.views.YVPBibleTextView
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class RNBibleTextViewModule : Module() {
+    override fun definition() = ModuleDefinition {
+        Name("BibleTextView")
+
+        View(YVPBibleTextView::class) {
+            Events("onTap")
+        }
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/RNBibleWidgetViewModule.kt

@@ -0,0 +1,13 @@
+package com.youversion.reactnativesdk
+
+import com.youversion.reactnativesdk.views.YVPBibleWidgetView
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class RNBibleWidgetViewModule : Module() {
+    override fun definition() = ModuleDefinition {
+        Name("BibleWidgetView")
+
+        View(YVPBibleWidgetView::class)
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/RNSignInWithYouVersionButtonModule.kt

@@ -0,0 +1,15 @@
+package com.youversion.reactnativesdk
+
+import com.youversion.reactnativesdk.views.YVPSignInWithYouVersionButton
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class RNSignInWithYouVersionButtonModule : Module() {
+    override fun definition() = ModuleDefinition {
+        Name("SignInWithYouVersionButton")
+
+        View(YVPSignInWithYouVersionButton::class) {
+            Events("onTap")
+        }
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/RNVotdViewModule.kt

@@ -0,0 +1,13 @@
+package com.youversion.reactnativesdk
+
+import com.youversion.reactnativesdk.views.YVPVotdView
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class RNVotdViewModule : Module() {
+    override fun definition() = ModuleDefinition {
+        Name("VotdView")
+
+        View(YVPVotdView::class)
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/RNYouVersionPlatformModule.kt

@@ -0,0 +1,99 @@
+package com.youversion.reactnativesdk
+
+import com.youversion.platform.core.YouVersionPlatformConfiguration
+import com.youversion.reactnativesdk.api.BibleReferenceRecord
+import com.youversion.reactnativesdk.api.YVPBibleApi
+import com.youversion.reactnativesdk.api.YVPHighlightsApi
+import com.youversion.reactnativesdk.api.YVPLanguagesApi
+import com.youversion.reactnativesdk.api.YVPVotdApi
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+import expo.modules.kotlin.functions.Coroutine
+
+class RNYouVersionPlatformModule : Module() {
+    override fun definition() = ModuleDefinition {
+        Name("RNYouVersionPlatform")
+
+        Function("configure") { appKey: String ->
+            val context = appContext.reactContext
+                ?: throw IllegalStateException("ReactContext is not available yet")
+
+            YouVersionPlatformConfiguration.configure(
+                context = context,
+                appKey = appKey,
+            )
+        }
+
+        Function("setApiHost") { apiHost: String ->
+            YouVersionPlatformConfiguration.setApiHost(apiHost)
+        }
+        
+        Function("getAccessToken") {
+            YouVersionPlatformConfiguration.accessToken
+        }
+
+        AsyncFunction("verseOfTheDay") Coroutine { dayOfYear: Int ->
+            return@Coroutine YVPVotdApi.verseOfTheDay(
+                dayOfYear = dayOfYear
+            )
+        }
+
+        AsyncFunction("languages") Coroutine { country: String? ->
+            return@Coroutine YVPLanguagesApi.languages(
+                country = country
+            )
+        }
+
+        AsyncFunction("versions") Coroutine { languageTag: String? ->
+            return@Coroutine YVPBibleApi.versions(
+                languageTag = languageTag
+            )
+        }
+
+        AsyncFunction("version") Coroutine { versionId: Int ->
+            return@Coroutine YVPBibleApi.version(
+                versionId = versionId
+            )
+        }
+
+        AsyncFunction("chapter") Coroutine { bibleReference: BibleReferenceRecord ->
+            val context = appContext.reactContext
+                ?: throw IllegalStateException("ReactContext is not available yet")
+
+            return@Coroutine YVPBibleApi.chapter(
+                bibleReference = bibleReference,
+                context = context
+            )
+        }
+
+        AsyncFunction("createHighlight") Coroutine { bibleId: Int, passageId: String, color: String ->
+            return@Coroutine YVPHighlightsApi.createHighlight(
+                bibleId = bibleId,
+                passageId = passageId,
+                color = color
+            )
+        }
+
+        AsyncFunction("getHighlights") Coroutine { bibleId: Int, passageId: String ->
+            return@Coroutine YVPHighlightsApi.getHighlights(
+                bibleId = bibleId,
+                passageId = passageId,
+            )
+        }
+
+        AsyncFunction("updateHighlight") Coroutine { bibleId: Int, passageId: String, color: String ->
+            return@Coroutine YVPHighlightsApi.updateHighlight(
+                bibleId = bibleId,
+                passageId = passageId,
+                color = color
+            )
+        }
+
+        AsyncFunction("deleteHighlight") Coroutine { bibleId: Int, passageId: String ->
+            return@Coroutine YVPHighlightsApi.deleteHighlight(
+                bibleId = bibleId,
+                passageId = passageId
+            )
+        }
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/api/YVPBibleApi.kt

@@ -0,0 +1,32 @@
+package com.youversion.reactnativesdk.api
+
+import android.content.Context
+import com.youversion.platform.core.api.YouVersionApi
+import com.youversion.platform.core.bibles.domain.BibleReference
+import com.youversion.platform.core.bibles.domain.BibleVersionRepository
+
+object YVPBibleApi {
+    suspend fun versions(languageTag: String?): List<BibleVersionRecord> {
+        val response = YouVersionApi.bible.versions(languageTag)
+        val records = response.map { BibleVersionRecord(it) }
+        return records
+    }
+
+    suspend fun version(versionId: Int): BibleVersionRecord {
+        val response = YouVersionApi.bible.version(versionId)
+        val record = BibleVersionRecord(response)
+        return record
+    }
+
+    suspend fun chapter(bibleReference: BibleReferenceRecord, context: Context): String {
+        val response = BibleVersionRepository(context).chapter(
+            reference = BibleReference(
+                versionId = bibleReference.versionId,
+                bookUSFM = bibleReference.bookUSFM,
+                chapter = bibleReference.chapter,
+            )
+        )
+
+        return response
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/api/YVPHighlightsApi.kt

@@ -0,0 +1,44 @@
+package com.youversion.reactnativesdk.api
+
+import com.youversion.platform.core.api.YouVersionApi
+
+object YVPHighlightsApi {
+    suspend fun createHighlight(bibleId: Int, passageId: String, color: String): Boolean {
+        val response = YouVersionApi.highlights.createHighlight(
+            versionId = bibleId,
+            passageId = passageId,
+            color = color
+        )
+
+        return response
+    }
+
+    suspend fun getHighlights(bibleId: Int, passageId: String): List<HighlightRecord> {
+        val response = YouVersionApi.highlights.highlights(
+            versionId = bibleId,
+            passageId = passageId
+        )
+
+        val records = response.map { HighlightRecord(it) }
+        return records
+    }
+
+    suspend fun updateHighlight(bibleId: Int, passageId: String, color: String): Boolean {
+        val response = YouVersionApi.highlights.updateHighlight(
+            versionId = bibleId,
+            passageId = passageId,
+            color = color
+        )
+
+        return response
+    }
+
+    suspend fun deleteHighlight(bibleId: Int, passageId: String): Boolean {
+        val response = YouVersionApi.highlights.deleteHighlight(
+            versionId = bibleId,
+            passageId = passageId,
+        )
+
+        return response
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/api/YVPLanguagesApi.kt

@@ -0,0 +1,11 @@
+package com.youversion.reactnativesdk.api
+
+import com.youversion.platform.core.api.YouVersionApi
+
+object YVPLanguagesApi {
+    suspend fun languages(country: String?): List<LanguageRecord> {
+        val response = YouVersionApi.languages.languages(country)
+        val records = response.map { LanguageRecord(it) }
+        return records
+    }
+}

package/android/src/main/java/com/youversion/reactnativesdk/api/YVPRecords.kt

@@ -0,0 +1,185 @@
+package com.youversion.reactnativesdk.api
+
+import com.youversion.platform.core.bibles.models.BibleBook
+import com.youversion.platform.core.bibles.models.BibleChapter
+import com.youversion.platform.core.bibles.models.BibleVersion
+import com.youversion.platform.core.highlights.models.Highlight
+import com.youversion.platform.core.languages.models.Language
+import com.youversion.platform.core.votd.models.YouVersionVerseOfTheDay
+import expo.modules.kotlin.records.Field
+import expo.modules.kotlin.records.Record
+
+data class YouVersionVerseOfTheDayRecord(
+    @Field
+    val passageId: String,
+    @Field
+    val day: Int
+) : Record {
+    constructor(votd: YouVersionVerseOfTheDay) : this(
+        passageId = votd.passageUsfm,
+        day = votd.day
+    )
+}
+
+data class LanguageRecord(
+    @Field
+    val id: String,
+    @Field
+    val language: String,
+    @Field
+    val script: String?,
+    @Field
+    val scriptName: String?,
+    @Field
+    val aliases: List<String>,
+    @Field
+    val displayNames: Map<String, String>,
+    @Field
+    val scripts: List<String>,
+    @Field
+    val variants: List<String>,
+    @Field
+    val countries: List<String>,
+    @Field
+    val textDirection: String,
+    @Field
+    val defaultBibleId: Int?
+
+) : Record {
+    constructor(language: Language) : this(
+        id = language.id,
+        language = language.language,
+        script = language.script,
+        scriptName = language.scriptName,
+        aliases = language.aliases,
+        displayNames = language.displayNames,
+        scripts = language.scripts,
+        variants = language.variants,
+        countries = language.countries,
+        textDirection = language.textDirection,
+        defaultBibleId = language.defaultBibleVersionId
+    )
+}
+
+data class BibleVersionRecord(
+    @Field
+    val id: Int,
+    @Field
+    val abbreviation: String?,
+    @Field
+    val promotionalContent: String?,
+    @Field
+    val copyright: String?,
+    @Field
+    val languageTag: String?,
+    @Field
+    val localizedAbbreviation: String?,
+    @Field
+    val localizedTitle: String?,
+    @Field
+    val readerFooter: String?,
+    @Field
+    val readerFooterUrl: String?,
+    @Field
+    val title: String?,
+    @Field
+    val bookCodes: List<String>?,
+    @Field
+    val books: List<BibleBookRecord>?,
+    @Field
+    val textDirection: String?,
+    @Field
+    val organizationId: String?
+) : Record {
+    constructor(bibleVersion: BibleVersion) : this(
+        id = bibleVersion.id,
+        abbreviation = bibleVersion.abbreviation,
+        promotionalContent = bibleVersion.promotionalContent,
+        copyright = bibleVersion.copyright,
+        languageTag = bibleVersion.languageTag,
+        localizedAbbreviation = bibleVersion.localizedAbbreviation,
+        localizedTitle = bibleVersion.localizedTitle,
+        readerFooter = bibleVersion.readerFooter,
+        readerFooterUrl = bibleVersion.readerFooterUrl,
+        title = bibleVersion.title,
+        bookCodes = bibleVersion.bookCodes,
+        books = bibleVersion.books?.map { BibleBookRecord(it) },
+        textDirection = bibleVersion.textDirection,
+        organizationId = bibleVersion.organizationId
+    )
+}
+
+data class BibleBookRecord(
+    @Field
+    val id: String?,
+    @Field
+    val title: String?,
+    @Field
+    val abbreviation: String?,
+    @Field
+    val canon: String?,
+    @Field
+    val chapters: List<BibleChapterRecord>?,
+    @Field
+    val fullTitle: String?
+) : Record {
+    constructor(bibleBook: BibleBook) : this(
+        id = bibleBook.id,
+        title = bibleBook.title,
+        abbreviation = bibleBook.abbreviation,
+        canon = bibleBook.canon,
+        chapters = bibleBook.chapters?.map { BibleChapterRecord(it) },
+        fullTitle = bibleBook.fullTitle
+    )
+}
+
+data class BibleChapterRecord(
+    @Field
+    val id: String?,
+    @Field
+    val passageId: String?,
+    @Field
+    val title: String?
+) : Record {
+    constructor(bibleChapter: BibleChapter) : this(
+        id = bibleChapter.id,
+        passageId = bibleChapter.passageId,
+        title = bibleChapter.title
+    )
+}
+
+data class BibleReferenceRecord(
+    @Field
+    val versionId: Int,
+    @Field
+    val bookUSFM: String,
+    @Field
+    val chapter: Int,
+) : Record
+
+data class HighlightRecord(
+    @Field
+    val id: String?,
+    @Field
+    val bibleId: Int,
+    @Field
+    val passageId: String,
+    @Field
+    val color: String,
+    @Field
+    val userId: String?,
+    @Field
+    val createTime: String?,
+    @Field
+    val updateTime: String?
+) : Record {
+    constructor(highlight: Highlight) : this(
+        id = highlight.id,
+        bibleId = highlight.versionId,
+        passageId = highlight.passageId,
+        color = highlight.color,
+        userId = highlight.userId,
+        createTime = highlight.createTime,
+        updateTime = highlight.updateTime
+    )
+}

package/android/src/main/java/com/youversion/reactnativesdk/api/YVPVotdApi.kt

@@ -0,0 +1,12 @@
+package com.youversion.reactnativesdk.api
+
+import com.youversion.platform.core.api.YouVersionApi
+
+object YVPVotdApi {
+    suspend fun verseOfTheDay(dayOfYear: Int): YouVersionVerseOfTheDayRecord {
+        val votd = YouVersionApi.votd
+            .verseOfTheDay(dayOfTheYear = dayOfYear)
+
+        return YouVersionVerseOfTheDayRecord(votd)
+    }
+}