firebase-kmp-sdk

1.2.3indexed

Replica la API oficial de Firebase, entrega módulos modulares, integración con coroutines/Flow, serialización tipada (value<T>, toObject<T>, set<T>) y testing con emulator.

AndroidJSNative·romancanoniero/firebase-kmp-sdk

Stars

—

Used by

dependents

—

Health

/ 100

🔥 Firebase KMP SDK

Librería Kotlin Multiplatform que replica fielmente la API del Firebase Android SDK para Android, iOS y JavaScript.

✨ Características

📦 Módulos Disponibles

🚀 Instalación

Gradle (Kotlin DSL)

Opción 1: Usando BOM (Recomendado) ⭐

El BOM (Bill of Materials) gestiona las versiones de todos los módulos automáticamente:

// build.gradle.kts (módulo compartido)
kotlin {
    sourceSets {
        commonMain.dependencies {
            // BOM - gestiona las versiones automáticamente
            implementation(platform("io.github.romancanoniero:firebase-bom:1.2.3"))
            
            // Agrega los módulos que necesites SIN especificar versión
            implementation("io.github.romancanoniero:firebase-core")
            implementation("io.github.romancanoniero:firebase-auth")
            implementation()
            implementation()
            implementation()
            implementation()
            implementation()
            implementation()
        }
    }
}

Opción 2: Versiones Explícitas

Si prefieres especificar cada versión manualmente:

// build.gradle.kts (módulo compartido)
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("io.github.romancanoniero:firebase-core:1.2.3")
            implementation("io.github.romancanoniero:firebase-auth:1.2.3")
            implementation("io.github.romancanoniero:firebase-database:1.2.3")
            implementation("io.github.romancanoniero:firebase-firestore:1.2.3")
            implementation("io.github.romancanoniero:firebase-storage:1.2.3")
            implementation("io.github.romancanoniero:firebase-functions:1.2.3")
            implementation("io.github.romancanoniero:firebase-messaging:1.2.3")
            implementation("io.github.romancanoniero:firebase-analytics:1.2.3")
        }
    }
}

Configuración para iOS

Agrega los pods de Firebase en tu Podfile:

# iosApp/Podfile
target 'iosApp' do
  use_frameworks!
  
  pod 'FirebaseCore', '~> 10.29'
  pod 'FirebaseAuth', '~> 10.29'
  pod 'FirebaseDatabase', '~> 10.29'
  pod 'FirebaseFirestore', '~> 10.29'
  pod 'FirebaseStorage', '~> 10.29'
  # ... otros pods según los módulos que uses
end

Configuración para JavaScript

Las dependencias de Firebase JS se incluyen automáticamente via npm.

📚 Documentación

Documento	Descripción
🚀 Guía de Implementación	Setup paso a paso desde cero
📖 API Reference

Guía de Implementación Incluye:

✅ Requisitos previos
✅ Crear proyecto en Firebase Console
✅ Configuración Android, iOS y Web
✅ Instalación de dependencias
✅ Ejemplo completo de app de notas
✅ Testing con Firebase Emulator
✅ Solución de problemas comunes

API Reference Incluye:

📝 Todas las clases y métodos de cada módulo
💻 Ejemplos de código completos
🎯 Casos de uso comunes
🏗️ Patrones recomendados

📖 Uso Básico

Inicialización

// La inicialización es automática si tienes:
// - Android: google-services.json
// - iOS: GoogleService-Info.plist

val app = FirebaseApp.getInstance()

// O inicialización manual:
val options = FirebaseOptions.Builder()
    .setApiKey("AIzaSy...")
    .setApplicationId("1:123456789:android:abc123")
    .setProjectId("my-project")
    .setDatabaseUrl("https://my-project.firebaseio.com")
    .setStorageBucket("my-project.appspot.com")
    .build()
    
FirebaseApp.initializeApp(context, options) // Android
FirebaseApp.initializeApp(options)

Authentication

Realtime Database

Cloud Firestore

Cloud Storage

 storage = FirebaseStorage.getInstance()
 imagesRef = storage.getReference()


 photoRef = imagesRef.child()
 uploadTask = photoRef.putFile()


uploadTask.progressFlow.collect { progress ->
     percent = ( * progress.bytesTransferred / progress.totalByteCount).toInt()
    println()
}


 downloadUrl = photoRef.getDownloadUrl()
println()


photoRef.getFile()


 metadata = photoRef.getMetadata()
println()

Cloud Functions

val functions = FirebaseFunctions.getInstance()

// Llamar función HTTPS
val result = functions.getHttpsCallable("myFunction").call(mapOf(
    "param1" to "value1",
    "param2" to 123
))
val data = result.data as Map<*, *>
println("Respuesta: $data")

Remote Config

val remoteConfig = FirebaseRemoteConfig.getInstance()

// Configurar defaults
remoteConfig.setDefaultsAsync(mapOf(
    "welcome_message" to "Bienvenido!",
    "feature_enabled" to false
))

// Fetch y activar
val success = remoteConfig.fetchAndActivate()
if (success) {
    val welcomeMsg = remoteConfig.getString("welcome_message")
    val featureEnabled = remoteConfig.getBoolean()
    println()
}

Analytics

val analytics = FirebaseAnalytics.getInstance()

// Log evento
analytics.logEvent("purchase", mapOf(
    "item_id" to "SKU_123",
    "item_name" to "Premium Plan",
    "price" to 9.99
))

// Establecer propiedades de usuario
analytics.setUserProperty("subscription_type", "premium")
analytics.setUserId("user_12345")

Performance Monitoring

val performance = FirebasePerformance.getInstance()

// Trace personalizado
val trace = performance.newTrace("my_operation")
trace.start()
// ... operación a medir ...
trace.putAttribute("result", "success")
trace.putMetric("items_processed", 42)
trace.stop()

// HTTP Metric
val httpMetric = performance.newHttpMetric(, )
httpMetric.start()

httpMetric.setHttpResponseCode()
httpMetric.setResponsePayloadSize()
httpMetric.stop()

🆕 Serialización Tipada (v1.1.0)

Una de las características más potentes de esta librería son las extensiones tipadas que permiten serializar/deserializar objetos automáticamente usando kotlinx.serialization.

Definir Modelos

import kotlinx.serialization.Serializable

@Serializable
data class User(
    val name: String,
     email: String,
     age:  = ,
     active:  = 
)


  (
     title: String,
     content: String,
     authorId: String,
     likes:  = 
)

Realtime Database - Lectura Tipada

import com.iyr.firebase.database.*

val database = FirebaseDatabase.getInstance()

// Deserializar un objeto
val user = database.getReference().().value<User>()


 users = database.getReference().().valueList<User>()


 usersMap = database.getReference().().valueMap<User>()


 name = snapshot.getString()
 age = snapshot.getLong()
 active = snapshot.getBoolean()

Realtime Database - Escritura Tipada

val user = User(name = "John", email = "john@example.com", age = 30)

// Guardar objeto tipado
database.getReference("users/user1").set(user)

// Actualizar con objeto tipado
database.getReference("users/user1").update(User(name = "Jane"))

// Push + set en una operación
val newRef = database.getReference("posts").pushValue(post)
println("Created: ${newRef.key}")

Firestore - Lectura Tipada

import com.iyr.firebase.firestore.*

val firestore = FirebaseFirestore.getInstance()

// Deserializar documento
val user = firestore.document("users/user1").get().toObject<User>()

// Deserializar query completa
val users = firestore.collection("users").get().toObjects<User>()


 usersMap = firestore.collection().().toObjectsMap<User>()


firestore.collection().snapshots.collect { query ->
     users = query.toObjects<User>()
}

Firestore - Escritura Tipada

val user = User(name = "John", email = "john@example.com")

// Add tipado
val docRef = firestore.collection().add(user)


firestore.document().(user)


firestore.document().update(User(name = ))


 batch = firestore.batch()
batch.(userRef, user)
batch.update(postRef, postUpdate)
batch.commit()


firestore.runTransaction { tx ->
     user = tx.(userRef).toObject<User>()!!
     updated = user.copy(age = user.age + )
    tx.(userRef, updated)
    updated
}

Tabla de Extensiones Disponibles

Realtime Database

Cloud Firestore

🧪 Testing

Unit Tests

# Android
./gradlew testDebugUnitTest

# iOS
./gradlew iosSimulatorArm64Test

# JavaScript
./gradlew jsNodeTest

Integration Tests con Firebase Emulator

Instala Firebase CLI:

npm install -g firebase-tools

Inicia los emuladores:

firebase emulators:start --only auth,database,firestore,storage,functions

Ejecuta tests de integración:

# Android
./gradlew connectedAndroidTest

# O el script incluido:
./run_integration_tests.sh

🏗️ Arquitectura

firebase-kmp-sdk/
├── firebase-core/          # FirebaseApp, FirebaseOptions
├── firebase-auth/          # Authentication
├── firebase-database/      # Realtime Database
├── firebase-firestore/     # Cloud Firestore
├── firebase-storage/       # Cloud Storage
├── firebase-functions/     # Cloud Functions
├── firebase-messaging/     # Push Notifications
├── firebase-analytics/     # Analytics
├── firebase-crashlytics/   # Crashlytics
├── firebase-remote-config/ # Remote Config
├── firebase-performance/   # Performance Monitoring
├── firebase-appcheck/      
└── firebase-inappmessaging/

Implementación por Plataforma

Plataforma	Tecnología
Android	Wrapper sobre Firebase Android SDK oficial
iOS	Kotlin/Native cinterop → Firebase iOS SDK (Objective-C)

📝 Publicar en Maven Local

Para desarrollo local:

./gradlew publishToMavenLocal

Los artefactos se publican en ~/.m2/repository/com/iyr/firebase/.

🤝 Créditos

Autor Principal

Roman Canoniero - Arquitectura, diseño e implementación inicial

Desarrollado con ❤️ por

IYR Team - https://iyr.com

Agradecimientos

Google Firebase Team por los SDKs oficiales
JetBrains por Kotlin Multiplatform
Comunidad de Kotlin por las herramientas de cinterop

📄 Licencia

Copyright 2024 Roman Canoniero / IYR

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance  the License.
You may obtain a copy of the License at

    http:

Unless   applicable law  agreed to  writing, software
distributed under the License  distributed  an  BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express  implied.
See the License  the specific language governing permissions 
limitations under the License.

🙏 Contribuciones

¡Contribuciones son bienvenidas! Por favor:

Fork el repositorio
Crea una branch para tu feature (git checkout -b feature/AmazingFeature)
Commit tus cambios (git commit -m 'Add some AmazingFeature')
Push a la branch (git push origin feature/AmazingFeature)
Abre un Pull Request

📬 Contacto

Issues: GitHub Issues
Email: romancanoniero@gmail.com

⭐ Si este proyecto te es útil, considera darle una estrella en GitHub!

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

GRPC-Kotlin-Multiplatform★ 133

TimOrtelImplements client-side gRPC with support for parsing proto3 files, generating corresponding code, and suspending RPC calls. Features a DSL for creating proto objects and supports various proto types.Shared: web, kotlin-native, kotlin-coroutines

kotlin.document.store★ 44

lamba92Fast NoSql document store for managing JSON objects with typed and schemaless data. Features developer-friendly APIs, asynchronous operations, indexing, and extensibility for custom serializers or storage backends.Shared: web, kotlin-serialization, kotlin-native

MicroUtils★ 36

InsanusMokrassarLibrary with tools for coroutines, serialization, database interaction, and networking. Modules include common utilities, selection tools, MIME types, pagination, and repository patterns, with a structured approach for complex modules.Shared: web, kotlin-serialization, kotlin-flow

KSafe★ 301

ioannisaEffortlessly encrypts and persists data using hardware-backed security, offering one-code-path simplicity, seamless integration, and protection for sensitive information like OAuth tokens.Shared: kotlin-serialization, kotlin-flow, kotlin-coroutines

TextToSpeechKt★ 57

Marc-JBCross-platform text-to-speech library enabling speech synthesis with coroutine support. Features include volume, pitch, and rate adjustments, with Compose integration for enhanced functionality.Shared: web, kotlin-native, kotlin-coroutines

kmp-socketio★ 47

HackWebRTCSocketIO client implementation enables asynchronous socket creation, streamlined thread safety, and simplified binary message handling. Offers logging integration and example usage across multiple platforms.Shared: web, kotlin-native, client

`snapshot.value<T>()`	Deserializa a objeto @Serializable
`snapshot.valueList<T>()`	Deserializa hijos a List
`snapshot.valueMap<T>()`	Deserializa hijos a Map<String, T>
`ref.set<T>(obj)`	Guarda objeto serializado
`ref.update<T>(obj)`	Actualiza con objeto serializado
`ref.pushValue<T>(obj)`	Push + set, retorna referencia
`obj.toFirebaseMap()`	Convierte @Serializable a Map

`doc.toObject<T>()`	Deserializa documento
`query.toObjects<T>()`	Deserializa query a List
`query.toObjectsMap<T>()`	Deserializa a Map<docId, T>
`docRef.set<T>(obj)`	Guarda objeto serializado
`docRef.update<T>(obj)`	Actualiza con objeto
`collection.add<T>(obj)`	Add tipado
`batch.set<T>(ref, obj)`	Set en batch
`tx.set<T>(ref, obj)`	Set en transaction
`obj.toFirestoreMap()`	Convierte @Serializable a Map

`firebase-bom`	✅	✅	✅	Bill of Materials - Gestión de versiones
`firebase-core`	✅	✅	✅	FirebaseApp, FirebaseOptions
`firebase-auth`	✅	✅	✅	Autenticación completa (Email, Phone, OAuth)
`firebase-database`	✅	✅	✅	Realtime Database
`firebase-firestore`	✅	✅	✅	Cloud Firestore
`firebase-storage`	✅	✅	✅	Cloud Storage
`firebase-functions`	✅	✅	✅	Cloud Functions client
`firebase-messaging`	✅	✅	⚠️	Push Notifications (FCM)
`firebase-analytics`	✅	✅	✅	Google Analytics
`firebase-crashlytics`	✅	✅	❌	Crashlytics
`firebase-remote-config`	✅	✅	✅	Remote Config
`firebase-performance`	✅	✅	❌	Performance Monitoring
`firebase-appcheck`	✅	✅	❌	App Check
`firebase-inappmessaging`	✅	❌	❌	In-App Messaging