Files
firebase-ios-sdk/FirebaseRemoteConfigSwift/Sources/Codable.swift
T

85 lines
3.3 KiB
Swift

/*
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import Foundation
#if SWIFT_PACKAGE
@_exported import FirebaseRemoteConfigInternal
#endif // SWIFT_PACKAGE
import FirebaseSharedSwift
#if SWIFT_PACKAGE
// This is a trick to force generate a `FirebaseRemoteConfig-Swift.h` header
// that re-exports `FirebaseRemoteConfigInternal` for Objective-C clients. It
// is important for the below code to reference a Remote Config symbol defined
// in Objective-C as that will import the symbol's module
// (`FirebaseRemoteConfigInternal`) in the generated header. This allows
// Objective-C clients to import Remote Config's Objective-C API using
// `@import FirebaseRemoteConfig;`. This API is not needed for Swift clients
// and is therefore hidden for them for the foreseeable future.
@available(iOS 100, *)
@objc public extension RemoteConfig {
var __do_not_call: String { "" }
}
#endif // SWIFT_PACKAGE
public enum RemoteConfigValueCodableError: Error {
case unsupportedType(String)
}
public extension RemoteConfigValue {
/// Extracts a RemoteConfigValue JSON-encoded object and decodes it to the requested type.
///
/// - Parameter asType: The type to decode the JSON-object to
func decoded<Value: Decodable>(asType: Value.Type = Value.self) throws -> Value {
if asType == Date.self {
throw RemoteConfigValueCodableError
.unsupportedType("Date type is not currently supported for " +
" Remote Config Value decoding. Please file a feature request")
}
return try FirebaseDataDecoder()
.decode(Value.self, from: FirebaseRemoteConfigValueDecoderHelper(value: self))
}
}
public enum RemoteConfigCodableError: Error {
case invalidSetDefaultsInput(String)
}
public extension RemoteConfig {
/// Decodes a struct from the respective Remote Config values.
///
/// - Parameter asType: The type to decode to.
func decoded<Value: Decodable>(asType: Value.Type = Value.self) throws -> Value {
let keys = allKeys(from: RemoteConfigSource.default) + allKeys(from: RemoteConfigSource.remote)
let config = keys.reduce(into: [String: FirebaseRemoteConfigValueDecoderHelper]()) {
$0[$1] = FirebaseRemoteConfigValueDecoderHelper(value: configValue(forKey: $1))
}
return try FirebaseDataDecoder().decode(Value.self, from: config)
}
/// Sets config defaults from an encodable struct.
///
/// - Parameter value: The object to use to set the defaults.
func setDefaults<Value: Encodable>(from value: Value) throws {
guard let encoded = try FirebaseDataEncoder().encode(value) as? [String: NSObject] else {
throw RemoteConfigCodableError.invalidSetDefaultsInput(
"The setDefaults input: \(value), must be a Struct that encodes to a Dictionary"
)
}
setDefaults(encoded)
}
}