[!IMPORTANT] Disclaimer: This is an unofficial, community-maintained library. It is not officially endorsed by, affiliated with, or sponsored by JSC "KazakhTelecom" or the State Revenue Committee of the Republic of Kazakhstan. All product names, logos, and brands are property of their respective owners.

Дисклеймер: Данный проект является неофициальной библиотекой, поддерживаемой сообществом. Он не связан, не спонсируется и не утверждался АО «Казахтелеком» или Комитетом государственных доходов РК. Все названия продуктов, товарные знаки и логотипы принадлежат их законным владельцам.

A Kotlin Multiplatform (KMP) library containing code entities generated from KazakhTelecom OFD (State Revenue Committee of the Republic of Kazakhstan) .proto files.

The current protocol version is 2.0.3 (module proto-v203). These proto files implement the data transmission protocol between Cash Registers (KKM) and the OFD.

• Kotlin Multiplatform Support: Compiles to standard JVM bytecode (compatible with Java 17+ and Android) and Apple/iOS Native targets.
• Type-safe Kotlin Protobuf bindings: Uses Square Wire Gradle plugin to generate KMP-compliant code without JVM/Java runtime dependencies.
• Modular design: Designed to support multiple protocol versions side-by-side in the same project without package collisions.

The library is not published to Maven Central. Every GitHub release carries the compiled library as a ready-to-use Maven repository: <module>-maven-<version>.zip, e.g. ofd-kt-proto-v204-maven-2.0.4-2.zip. It contains all targets (JVM, Android, iOS klibs) together with Gradle module metadata, so Gradle picks the right target and resolves the library's own dependencies.

1. Download <module>-maven-<version>.zip from the release.
2. Unzip it into a folder of your project, e.g. libs/maven.
3. Add the folder as a repository in settings.gradle.kts (or build.gradle.kts):

dependencyResolutionManagement {
    repositories {
        maven(uri("libs/maven"))
        google()
        mavenCentral()
    }
}

4. Add the dependency to your shared commonMain source set inside build.gradle.kts:

kotlin {
    sourceSets {
        commonMain {
            dependencies {
                // protocol 2.0.3
                implementation("io.github.texport:ofd-kt-proto:2.0.3-4")
                // protocol 2.0.4
                implementation("io.github.texport:ofd-kt-proto-v204:2.0.4-2")
            }
        }
    }
}

To build and publish to your local maven repository for testing:

./gradlew publishToMavenLocal

Мультиплатформенная библиотека Kotlin Multiplatform (KMP). Содержит сущности, сгенерированные из .proto файлов ОФД Казахтелеком (Комитет государственных доходов РК).

Текущая версия протокола — 2.0.3 (модуль proto-v203). Прото-файлы реализуют протокол передачи данных ККМ в ОФД.

• Поддержка Kotlin Multiplatform: Компилируется под JVM (совместима с Java 17+ и Android) и Apple/iOS Native таргеты.
• Типизированные KMP биндинги: Использует плагин Square Wire для кодогенерации чистых Kotlin-классов без привязки к Java SDK.
• Поддержка параллельных версий: Несколько версий протокола могут одновременно использоваться в одном проекте без конфликтов пакетов.

В Maven Central библиотека не публикуется. Каждый выпуск на GitHub несёт собранную библиотеку в виде готового Maven-репозитория: <модуль>-maven-<версия>.zip, например ofd-kt-proto-v204-maven-2.0.4-2.zip. В нём все цели (JVM, Android, klib для iOS) с метаданными модуля Gradle, поэтому Gradle сам выбирает нужную цель и подтягивает зависимости библиотеки.

1. Скачайте <модуль>-maven-<версия>.zip из выпуска.
2. Распакуйте его в папку проекта, например libs/maven.
3. Добавьте папку в репозитории в settings.gradle.kts (или build.gradle.kts):

dependencyResolutionManagement {
    repositories {
        maven(uri("libs/maven"))
        google()
        mavenCentral()
    }
}

4. Добавьте зависимость в ваш общий набор исходников commonMain в build.gradle.kts:

kotlin {
    sourceSets {
        commonMain {
            dependencies {
                // протокол 2.0.3
                implementation("io.github.texport:ofd-kt-proto:2.0.3-4")
                // протокол 2.0.4
                implementation("io.github.texport:ofd-kt-proto-v204:2.0.4-2")
            }
        }
    }
}

Для сборки и публикации в локальный Maven-репозиторий выполните команду:

./gradlew publishToMavenLocal

Because ofd-kt-proto is a pure Protobuf schema definition library generating common Kotlin classes via Wire, it is not distributed directly as a Swift Package Manager (SPM) XCFramework binary.

Instead, it is consumed as a dependency by the ofd-proto-codec library which wraps these models and provides the native SPM configuration block for iOS consumers.

This library operates strictly as a data definition module containing schema contracts:

• Included: Auto-generated types and message definitions representing KazakhTelecom OFD v2.0.3 objects.
• Delegated: Network client sockets, logging, trilingual error localization, and business flow implementations are delegated to downstream consumers (ofd-network-client and ofd-proto-codec).