grant-core/dev.brewkits.grant

Package-level declarations

Types

AndroidSavedStateDelegate

class AndroidSavedStateDelegate(savedStateHandle: SavedStateHandle) : SavedStateDelegate

Android implementation of SavedStateDelegate using SavedStateHandle.

AppGrant

enum AppGrant : Enum<AppGrant> , GrantPermission

A platform-agnostic abstraction for the most common system permissions.

BluetoothReadyStatus

sealed class BluetoothReadyStatus

Aggregate status for Bluetooth feature readiness.

GrantAndServiceChecker

class GrantAndServiceChecker(grantManager: GrantManager, serviceManager: ServiceManager)

A utility that combines OS permission checks and hardware service monitoring into a single unified API.

GrantAndServiceHandler

class GrantAndServiceHandler(grantManager: GrantManager, serviceManager: ServiceManager, grant: GrantPermission, serviceType: ServiceType, scope: CoroutineScope, savedStateDelegate: SavedStateDelegate = NoOpSavedStateDelegate(), eventListener: GrantEventListener? = null)

A unified handler that orchestrates both OS permission requests and hardware service enablement (e.g., GPS, Bluetooth).

GrantAndServiceUiState

data class GrantAndServiceUiState(val isVisible: Boolean = false, val showRationale: Boolean = false, val showPermissionSettings: Boolean = false, val showServiceSettings: Boolean = false, val rationaleMessage: String? = null, val permissionSettingsMessage: String? = null, val serviceSettingsMessage: String? = null, val isReady: Boolean = false)

UI State for the unified Grant and Service flow.

GrantEventListener

interface GrantEventListener

Observer for permission flow events across GrantHandler, GrantGroupHandler, and GrantAndServiceHandler.

GrantFactory

object GrantFactory

A static factory for creating GrantManager instances without a Dependency Injection framework.

GrantFlow

class GrantFlow

A DSL builder for orchestrating sequential multi-permission flows.

GrantFlowScope

interface GrantFlowScope

Scope for the grantFlow builder, providing utility functions for sequential permission handling.

GrantGroupHandler

class GrantGroupHandler(grantManager: GrantManager, grants: List<GrantPermission>, scope: CoroutineScope, eventListener: GrantEventListener? = null)

A specialized handler for managing multiple permissions as a single logical group.

GrantGroupUiState

data class GrantGroupUiState(val isVisible: Boolean = false, val currentGrant: GrantPermission? = null, val showRationale: Boolean = false, val showSettingsGuide: Boolean = false, val rationaleMessage: String? = null, val settingsMessage: String? = null, val grantedGrants: Set<GrantPermission> = emptySet(), val totalGrants: Int = 0)

The UI state produced by GrantGroupHandler.

GrantHandler

class GrantHandler(grantManager: GrantManager, grant: GrantPermission, scope: CoroutineScope, savedStateDelegate: SavedStateDelegate = NoOpSavedStateDelegate(), eventListener: GrantEventListener? = null)

Encapsulates ALL grant logic in a clean, reusable component.

GrantLauncher

interface GrantLauncher

Interface for platform-specific permission launchers.

GrantManager

interface GrantManager

Core interface for grant management.

GrantPermission

sealed interface GrantPermission

Represents a system permission that can be requested on Android and iOS.

GrantStatus

enum GrantStatus : Enum<GrantStatus>

The unified state of a system permission across Android and iOS.

GrantStore

interface GrantStore

An abstraction for tracking the history of permission requests.

GrantUiState

data class GrantUiState(val isVisible: Boolean = false, val showRationale: Boolean = false, val showSettingsGuide: Boolean = false, val rationaleMessage: String? = null, val settingsMessage: String? = null)

UI State for grant dialogs.

InMemoryGrantStore

class InMemoryGrantStore : GrantStore

The default implementation of GrantStore that persists state in-memory.

LocationReadyStatus

sealed class LocationReadyStatus

Aggregate status for Location feature readiness.

NoOpSavedStateDelegate

class NoOpSavedStateDelegate : SavedStateDelegate

A no-op implementation used on platforms where process death recovery is not required (e.g., iOS, Desktop).

RawPermission

data class RawPermission(val identifier: String, val androidPermissions: List<String>, val iosUsageKey: String? = null) : GrantPermission

A custom permission defined by raw platform strings.

ReadyStatus

data class ReadyStatus(val grantStatus: GrantStatus, val serviceStatus: ServiceStatus, val isReady: Boolean)

A generic data structure representing the aggregate state of a permission and service.

SavedStateDelegate

interface SavedStateDelegate

A platform-agnostic interface for persisting UI state across system-initiated process death.

ServiceFactory

actual object ServiceFactory

expect object ServiceFactory

A static factory for creating ServiceManager instances.

actual object ServiceFactory

ServiceManager

interface ServiceManager

Manages the status of system-level services like GPS, Bluetooth, and Wi-Fi.

ServiceStatus

enum ServiceStatus : Enum<ServiceStatus>

The operational state of a system service.

ServiceType

enum ServiceType : Enum<ServiceType>

The types of hardware or system services that can be monitored.

SharedPreferencesGrantStore

class SharedPreferencesGrantStore(context: Context) : GrantStore

A GrantStore that persists permission request history across process death.

Functions

createPlatformDelegate

actual fun createPlatformDelegate(context: Any?, store: GrantStore?): PlatformGrantDelegate

Android implementation of platform delegate factory.

expect fun createPlatformDelegate(context: Any?, store: GrantStore?): PlatformGrantDelegate

Platform-specific factory function. Internal use only.

actual fun createPlatformDelegate(context: Any?, store: <Error class: unknown class>?): PlatformGrantDelegate

iOS implementation of platform delegate factory.

actual fun createPlatformDelegate(context: Any?, store: GrantStore?): PlatformGrantDelegate

JVM desktop implementation of the platform delegate factory.

actual fun createPlatformDelegate(context: Any?, store: GrantStore?): PlatformGrantDelegate

The browser has no "context" concept — context is accepted for API-shape parity with Android/iOS and ignored. store defaults to InMemoryGrantStore and, unlike Android, that default is also the correct choice on the web: the browser's own permission record is already durable across page loads, so there is no process-death-style gap for a persistent store to close here.

getStatus

fun GrantStore.getStatus(grant: GrantPermission): GrantStatus?

Extension for getting the status of any GrantPermission.

grantFlow

fun grantFlow(block: suspend GrantFlowScope.() -> Unit): GrantFlow

Creates a new GrantFlow for orchestrating sequential permission requests.

isRequestedBefore

fun GrantStore.isRequestedBefore(grant: GrantPermission): Boolean

Extension for checking if any GrantPermission has been requested before.

setRequested

fun GrantStore.setRequested(grant: GrantPermission)

Extension for marking any GrantPermission as requested.