AI Assistant Compose

1
/*
2
 *   Copyright © 2025-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.content.Context
11
import android.content.Intent
12
import android.graphics.RectF
13
import android.os.Bundle
14
import androidx.activity.compose.setContent
15
import androidx.activity.enableEdgeToEdge
16
import androidx.appcompat.app.AppCompatActivity
17
import androidx.compose.animation.AnimatedVisibility
18
import androidx.compose.animation.expandVertically
19
import androidx.compose.animation.fadeIn
20
import androidx.compose.animation.fadeOut
21
import androidx.compose.animation.shrinkVertically
22
import androidx.compose.animation.slideInVertically
23
import androidx.compose.animation.slideOutVertically
24
import androidx.compose.foundation.layout.Box
25
import androidx.compose.foundation.layout.fillMaxSize
26
import androidx.compose.foundation.layout.navigationBarsPadding
27
import androidx.compose.material3.ExperimentalMaterial3Api
28
import androidx.compose.material3.Icon
29
import androidx.compose.material3.IconButton
30
import androidx.compose.material3.MaterialTheme
31
import androidx.compose.material3.Text
32
import androidx.compose.material3.TopAppBar
33
import androidx.compose.material3.TopAppBarDefaults
34
import androidx.compose.runtime.Composable
35
import androidx.compose.runtime.getValue
36
import androidx.compose.runtime.mutableStateOf
37
import androidx.compose.runtime.remember
38
import androidx.compose.runtime.setValue
39
import androidx.compose.ui.Alignment
40
import androidx.compose.ui.Modifier
41
import androidx.compose.ui.graphics.Color
42
import androidx.compose.ui.platform.LocalContext
43
import androidx.compose.ui.platform.LocalDensity
44
import androidx.compose.ui.res.painterResource
45
import androidx.compose.ui.unit.dp
46
import com.pspdfkit.ai.createAiAssistant
47
import com.pspdfkit.catalog.R
48
import com.pspdfkit.catalog.SdkExample
49
import com.pspdfkit.catalog.SdkExample.Companion.WELCOME_DOC
50
import com.pspdfkit.catalog.ui.theming.CatalogTheme
51
import com.pspdfkit.catalog.utils.JwtGenerator
52
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
53
import com.pspdfkit.document.providers.AssetDataProvider
54
import com.pspdfkit.jetpack.compose.interactors.DefaultListeners
55
import com.pspdfkit.jetpack.compose.interactors.DocumentState
56
import com.pspdfkit.jetpack.compose.interactors.getDefaultDocumentManager
57
import com.pspdfkit.jetpack.compose.interactors.rememberDocumentState
58
import com.pspdfkit.jetpack.compose.views.DocumentView
59
import com.pspdfkit.ui.DocumentDescriptor
60
import com.pspdfkit.ui.PdfActivity
61
import io.nutrient.domain.ai.AiAssistant
62
import io.nutrient.domain.ai.AiAssistantProvider
63

64
/**
65
 * Shows how to implement AI Assistant for the DocumentView in a Compose way.
66
 */
67
class AiAssistantComposeExample(context: Context) : SdkExample(
68
    context,
69
    R.string.jetpackAiAssistantExampleTitle,
70
    R.string.jetpackAiAssistantExampleDescription
71
) {
72
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
73
        val intent = Intent(context, AiAssistantComposeActivity::class.java)
74
        context.startActivity(intent)
75
    }
76
}
77

78
class AiAssistantComposeActivity : AppCompatActivity(), AiAssistantProvider {
79
    private lateinit var documentState: DocumentState
80
    private val sessionId = AiAssistantComposeActivity::class.java.simpleName
81
    private val assetProvider = AssetDataProvider(WELCOME_DOC)
82
    private var ipAddressValue: String? = null
83

84
    override fun onCreate(savedInstanceState: Bundle?) {
85
        enableEdgeToEdge()
86
        super.onCreate(savedInstanceState)
87

88
        val preferences = getSharedPreferences(PREFERENCES_NAME, MODE_PRIVATE)
89
        ipAddressValue = preferences.getString(PREF_AI_IP_ADDRESS, "") ?: ""
90

91
        setContent {
92
            var enabled by remember { mutableStateOf(false) }
93
            var toolbarVisibility by remember { mutableStateOf(true) }
94

95
            CatalogTheme {
96
                val activityConfiguration = PdfActivityConfiguration.Builder(LocalContext.current)
97
                    .setAiAssistantEnabled(true)
98
                    .defaultToolbarEnabled(false)
99
                    .theme(R.style.PSPDFCatalog_AIAssistantDialog)
100
                    .themeDark(R.style.PSPDFCatalog_AIAssistantDialog_Dark)
101
                    .build()
102

103
                documentState = rememberDocumentState(assetProvider, activityConfiguration)
104

105
                Box(
106
                    modifier = Modifier
107
                        .fillMaxSize()
108
                        .navigationBarsPadding()
109
                ) {
110
                    DocumentView(
111
                        documentState = documentState,
112
                        documentManager = getDefaultDocumentManager(
113
                            documentListener = DefaultListeners.documentListeners(
114
                                onDocumentLoaded = {
115
                                    enabled = true
116
                                }
117
                            ),
118
                            uiListener = DefaultListeners.uiListeners(
119
                                onImmersiveModeEnabled = { toolbarVisibility = !it }
120
                            )
121
                        )
122
                    )
123
                }
124
                CustomToolbar(documentState, enabled, toolbarVisibility)
125
            }
126
        }
127
    }
128
    var assistant: AiAssistant? = null
129

130
    override fun getAiAssistant(): AiAssistant {
131
        val documentDescriptor = DocumentDescriptor.fromDataProviders(listOf(assetProvider), listOf(), listOf())
132

133
        return assistant ?: run {
134
            createAiAssistant(
135
                context = this@AiAssistantComposeActivity,
136
                documentsDescriptors = listOf(documentDescriptor),
137
                serverUrl = "http://$ipAddressValue:4000",
138
                sessionId = sessionId,
139
                jwtToken = { documentIds ->
140
                    JwtGenerator.generateJwtToken(
141
                        this@AiAssistantComposeActivity,
142
                        claims = mapOf(
143
                            "document_ids" to documentIds,
144
                            "session_ids" to listOf(sessionId),
145
                            "request_limit" to mapOf(
146
                                "requests" to 160,
147
                                "time_period_s" to 1000 * 60 * 10
148
                            )
149
                        )
150
                    )
151
                }
152
            ).also {
153
                // Enable/disable text selection in AI Assistant chat messages
154
                // false = disable, true = enable (default)
155
                // it.enableTextSelection(false)
156
                assistant = it
157
            }
158
        }
159
    }
160

161
    override fun navigateTo(
162
        documentRect: List<RectF>,
163
        pageIndex: Int,
164
        documentIndex: Int
165
    ) {
166
        documentState.documentConnection.highlight(pageIndex, documentRect)
167
    }
168

169
    companion object {
170
        const val EXTRA_URI = "JetpackComposeImageActivity.DocumentUri"
171
        const val PREFERENCES_NAME = "Nutrient.AiAssistant"
172
        const val PREF_AI_IP_ADDRESS = "ai_ip_address"
173
    }
174
}
175

176
/**
177
 * A custom toolbar component for document viewer with animated visibility.
178
 *
179
 * @param documentState The current state of the document being viewed
180
 * @param enabled Whether the toolbar actions are enabled
181
 * @param toolbarVisibility Whether the toolbar should be visible
182
 */
183
@OptIn(ExperimentalMaterial3Api::class)
184
@Composable
185
fun CustomToolbar(
186
    documentState: DocumentState,
187
    enabled: Boolean,
188
    toolbarVisibility: Boolean
189
) {
190
    val localDensity = LocalDensity.current
191

192
    // Animate toolbar appearance/disappearance with slide, expand and fade effects
193
    AnimatedVisibility(
194
        visible = toolbarVisibility,
195
        enter = slideInVertically { with(localDensity) { -40.dp.roundToPx() } } +
196
            expandVertically(expandFrom = Alignment.Top) +
197
            fadeIn(initialAlpha = 0.3f),
198
        exit = slideOutVertically() + shrinkVertically() + fadeOut()
199
    ) {
200
        TopAppBar(
201
            title = {
202
                // Display document title or empty string if null
203
                Text(
204
                    text = documentState.getTitle().orEmpty(),
205
                    color = Color.White
206
                )
207
            },
208
            actions = {
209
                // AI Assistant action button
210
                IconButton(
211
                    onClick = {
212
                        documentState.toggleView(PdfActivity.MENU_OPTION_AI_ASSISTANT)
213
                    },
214
                    enabled = enabled
215
                ) {
216
                    Icon(
217
                        painter = painterResource(id = R.drawable.ic_ai_assistant),
218
                        contentDescription = "AI Assistant",
219
                        tint = Color.White
220
                    )
221
                }
222

223
                // Settings action button
224
                IconButton(
225
                    onClick = {
226
                        documentState.toggleView(PdfActivity.MENU_OPTION_SETTINGS)
227
                    },
228
                    enabled = enabled
229
                ) {
230
                    Icon(
231
                        painter = painterResource(id = R.drawable.ic_topbar_settings),
232
                        contentDescription = "Settings",
233
                        tint = Color.White
234
                    )
235
                }
236
            },
237
            colors = TopAppBarDefaults.topAppBarColors(
238
                containerColor = MaterialTheme.colorScheme.primary,
239
                titleContentColor = MaterialTheme.colorScheme.onPrimary
240
            )
241
        )
242
    }
243
}