appfeedback-android/com.appfeedback.core

Package-level declarations

Types

Locale-invariant, deterministic human-readable byte-count formatter. Port of the Swift DeterministicByteCount. Uses Long arithmetic because Kotlin Int is 32-bit and bytes * 10 overflows at GB scale. Decimal (1000-based) units; unit chosen by magnitude, then rounded half-up within it (never re-promoted), so 999_999 -> "1000 KB". Pinned by the wire spec.

DeviceInfo

@Serializable

data class DeviceInfo(val appName: String, val appVersion: String, val buildNumber: String, val model: String, val osName: String, val osVersion: String)

Per-submission device/app metadata. current() (via android.os.Build) is added in P1b.

FeedbackClient

class FeedbackClient(transport: FeedbackTransport, deviceInfoProvider: () -> DeviceInfo)

Entry point: holds a transport and a DeviceInfo provider, and submits reports. The Android-specific provider (via android.os.Build) is added in the Android library module; here the provider is supplied explicitly.

FeedbackReport

data class FeedbackReport(val type: FeedbackType, val title: String, val description: String, val contactEmail: String? = null, val extraFields: Map<String, String> = emptyMap())

A single user-supplied feedback submission. Attachments (raw files) and the device-info collector are platform concerns handled in later phases.

FeedbackSubmissionError

class FeedbackSubmissionError(message: String, val status: Int? = null) : Exception

Thrown by transports when a submission fails. status is the HTTP status when applicable.

FeedbackTransport

interface FeedbackTransport

Where a report gets delivered. Concrete implementations (GitHub direct, relay) are added in P1b. Returns the backend-assigned identifier (the GitHub issue number for the GitHub transport).

FeedbackType

enum FeedbackType : Enum<FeedbackType>

Bug report or feature request. The raw value is also the GitHub label string.

GitHubDirectTransport

class GitHubDirectTransport(owner: String, repo: String, token: String, httpClient: HttpClient = defaultClient()) : FeedbackTransport

Posts a report directly to the GitHub Issues REST API. The token is held by the caller (acceptable for a native app's secure storage).

IssueBodyFormatter

object IssueBodyFormatter

Renders a report + device info (+ uploaded attachments) into the exact issue body the parser understands. Port of the Swift IssueBodyFormatter.

IssueBodyParser

object IssueBodyParser

Inverse of IssueBodyFormatter: pulls structured fields out of an issue body. Tolerant of hand-written / legacy bodies. Port of the Swift IssueBodyParser.

ParsedAttachment

data class ParsedAttachment(val filename: String, val mimeType: String, val url: String, val sizeBytes: Long?)

ParsedFeedbackBody

data class ParsedFeedbackBody(val description: String = "", val appName: String? = null, val appVersion: String? = null, val device: String? = null, val osVersion: String? = null, val email: String? = null, val attachments: List<ParsedAttachment> = emptyList())

RelayTransport

class RelayTransport(endpoint: String, httpClient: HttpClient = defaultClient(), captchaTokenProvider: suspend () -> String?? = null) : FeedbackTransport

Posts a report to an adopter-operated relay (per the relay contract). The GitHub credential lives on the relay, never in the app.

UploadedAttachment

data class UploadedAttachment(val filename: String, val mimeType: String, val sizeBytes: Long, val url: String)

An attachment already uploaded; drives the body's attachment block.