Firebase for iOS and macOS made easy.

What is EasyFirebase?

Completed Features

Get Started

https://github.com/Flowductive/easy-firebase

import EasyFirebase

// You don't need to call FirebaseApp.configure() when this is called!
EasyFirebase.configure()

🔥 Firestore Feature Showcase

Built-in Document protocol

class Car: Document {
 
 // These properties are inherited from Document
 var id: String = UUID().uuidString
 var dateCreated: Date = Date()
 
 // Define your own custom properties
 var make: String
 var model: String
 var year: Int
 
 init(make: String, model: String, year: Int) {
 // ...
 }
}

Document Storage

var myCar = Car(make: "Toyota", model: "Corolla", year: 2017)
// Store the car instance in the 'car' collection in Firestore
myCar.set()
// Static method that does the same as above
EasyFirestore.Storage.set(myCar)

Document Retrieval

EasyFirestore.Retrieval.get(id: myCarID, ofType: Car.self) { car in
 guard let car = car else { return }
 self.myOtherCar = car
}

Document Updating

// Append element to array
EasyFirestore.Updating.append(\.ingredients, with: "Cheese", in: pizzaDocument) { error in ... }
// Increment field
EasyFirestore.Updating.increment(\.pepperoniCount, by: 5, in: pizzaDocument)
// Remove elements from array
EasyFirestore.Updating.remove(\.ingredients, taking: ["Garlic", "Anchovies", "Pineapple"], from: pizzaDocument)

Update Listeners

EasyFirestore.Listening.listen(to: otherCarID, ofType: Car.self, key: "myCarListenerKey") { car in
 // Updates when changed in Firestore
 guard let car = car else { return }
 self.myOtherCar = car
}

Built-In Cacheing

// EasyFirebase will automatically cache fetched objects for you, here is a manual example
EasyFirestore.Cacheing.register(myCar)
// Get locally cached objects instantly. Retrieving objects using EasyFirestore.Retrieval will grab cached objects if they exist
var cachedCar = EasyFirestore.Cacheing.grab(myCarID, fromType: Car.self)

Easy Linking

var car1 = Car(make: "Toyota", model: "Corolla", year: 2017)
var car2 = Car(make: "Honda", model: "Civic", year: 2019)
var dealership = Dealership(name: "Los Angeles Dealership")
// Set and assign the Toyota Corolla to the Los Angeles Dealership
car1.setAssign(toField: "cars", using: \.cars, in: dealership)
// Set and assign the Honda Civic to the Los Angeles Dealership
car2.set()
car2.assign(toField: "cars", using: \.cars, in: dealership)

Swifty Querying

EasyFirestore.Querying.where(\Car.make, .equals, "Toyota") { cars in
 // Handle your queried documents here...
}

EasyFirestore.Querying.where((\Car.year, .greaterEqualTo, 2010),
 (\Car.model, .in, ["Corolla", "Camry"]),
 order: .ascending,
 limit: 5
) { cars in
 // ...
}

🔑 Authentication Feature Showcase

Easy User Protocol

class MyUser: EasyUser {
 
 // EasyUser comes pre-built with these automatically updated properties
 var lastSignon: Date
 var displayName: String
 var username: String
 var email: String
 var appVersion: String
 var deviceToken: String?
 var notifications: [MessagingNotification]
 var disabledMessageCategories: [MessageCategory]
 var progress: Int
 var id: String
 var dateCreated: Date
 
 // Define your own custom properties
 var cars: [Car.ID]
 // ...
}

Email Auth

EasyAuth.createAccount(email: "easy.firebase@example.com", password: "76dp2[&y4;JLyu:F") { error in
 if let error = error {
 print(error.localizedDescription)
 } else {
 // Account created!
 }
}
EasyAuth.signIn(email: "easy.firebase@example.com", password: "76dp2[&y4;JLyu:F") { error in
 // ...
}

Sign In with Google

// iOS
EasyAuth.signInWithGoogle(clientID: "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx") { error in
 // ...
}
// macOS
EasyAuth.signInWithGoogle(clientID: "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
 secret: "GOCSPX-xxxxxxxxxxxxxxxxxxx-xxxxxxxx") { error in
 // ...
}

Sign In with Apple

// iOS + macOS
EasyAuth.signInWithApple()

Built-In Usernames

user.safelyUpdateUsername(to: "myNewUsername", ofUserType: MyUser.self) { error, suggestion in
 if let error = error {
 // ...
 } else if let suggestion = suggestion {
 // Username taken, provide the user with an available username suggestion.
 } else {
 // Success! Username changed.
 }
}

Robust User Management

// Send a verfication email to the currently signed-in user
user.sendEmailVerification(completion: { error in })
// Upload and update the current user's profile photo
user.updatePhoto(with: myPhotoData, ofUserType: FUser.self, completion: { error in })
// Send the current user's password reset form to a specified email
user.sendPasswordReset(toEmail: "myResetEmail@example.com", completion: { error in })
// Update the current user's display name
user.updateDisplayName(to: "New_DisplayName", ofUserType: MyUser.self, completion: { error in })
// Update the current user's password
user.updatePassword(to: "newPassword", completion: { error in })
// Delete the current user
user.delete(ofUserType: MyUser.self, completion: { error in })

📦 Storage Feature Showcase

Data Storage

// Upload image data and get an associated URL
EasyStorage.put(imageData, to: StorageResource(id: user.id)) { url in }
// EasyStorage will automatically delete existing images matching the same ID (if in the same folder)
EasyStorage.put(imageData,to: StorageResource(id: user.id, folder: "myFolder"), progress: { updatedProgress in
 // Update progress text label using updatedProgress
}, completion: { url in
 // Handle the image's URL
})

☁️ Cloud Messaging Feature Showcase

Built-in User Notifications

// Set your Server Key
EasyMessaging.serverKey = "xxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxx"
// Create the notification
let notification = MessagingNotification("Message body", from: me, in: "Test Category")
// Send the notification to the user
// Appends to the notifications property, unless the specified category is in the user's disabledMessageCategories
EasyMessaging.send(notification, to: you)

📊 Analytics Feature Showcase

Easily Log Events

EasyAnalytics.log("food_eaten", data: [
 "name": "Hot Dog",
 "isHot": true
])

let hotdog = Food(name: "Hot Dog", temperature: 81)
EasyAnalytics.log("food_eaten", model: hotdog)

hotdog.log(key: "food_eaten")

Integrated User Properties

struct MyUser: EasyUser {
 // ...
 var favoriteCar: String
 func analyticsProperties() -> [String: String] {
 return ["app_version": appVersion, "favorite_car": favoriteCar]
 }
}

myUser.updateAnalyticsUserProperties()