lottie-ios 4.3.2 → 4.3.4

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/EpoxySwiftUIIntrinsicContentSizeInvalidator.swift

@@ -1,6 +1,7 @@
 // Created by matthew_cheok on 11/19/21.
 // Copyright © 2021 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - EpoxyIntrinsicContentSizeInvalidator
@@ -42,3 +43,4 @@ extension EnvironmentValues {
 private struct EpoxyIntrinsicContentSizeInvalidatorKey: EnvironmentKey {
   static let defaultValue = EpoxyIntrinsicContentSizeInvalidator(invalidate: { })
 }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/EpoxySwiftUILayoutMargins.swift

@@ -1,6 +1,7 @@
 // Created by eric_horacek on 10/8/21.
 // Copyright © 2021 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - View
@@ -49,3 +50,4 @@ private struct EpoxyLayoutMarginsPadding: ViewModifier {
     content.padding(epoxyLayoutMargins)
   }
 }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/EpoxyableView+SwiftUIView.swift

@@ -1,6 +1,7 @@
 // Created by eric_horacek on 9/13/21.
 // Copyright © 2021 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - StyledView
@@ -170,3 +171,4 @@ extension StyledView
     }
   }
 }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/LayoutUtilities/MeasuringViewRepresentable.swift

@@ -1,6 +1,7 @@
 // Created by eric_horacek on 6/22/22.
 // Copyright © 2022 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - MeasuringViewRepresentable
@@ -126,3 +127,4 @@ extension MeasuringViewRepresentable {
   #endif
 }
 #endif
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/LayoutUtilities/SwiftUIMeasurementContainer.swift

@@ -1,6 +1,7 @@
 // Created by Bryn Bodayle on 1/24/22.
 // Copyright © 2022 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - SwiftUIMeasurementContainer
@@ -450,3 +451,4 @@ extension CGSize {
       height: height == ViewType.noIntrinsicMetric ? fallback.height : height)
   }
 }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/SwiftUIView.swift

@@ -1,6 +1,7 @@
 // Created by eric_horacek on 9/8/22.
 // Copyright © 2022 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - SwiftUIView
@@ -146,3 +147,4 @@ extension SwiftUIView {
     fileprivate(set) var storage: Storage
   }
 }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/UIView+SwiftUIView.swift

@@ -1,6 +1,7 @@
 // Created by eric_horacek on 3/3/22.
 // Copyright © 2022 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - ViewTypeProtocol + swiftUIView
@@ -38,3 +39,4 @@ protocol ViewTypeProtocol: ViewType { }
 // MARK: - ViewType + ViewTypeProtocol
 
 extension ViewType: ViewTypeProtocol { }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/UIViewConfiguringSwiftUIView.swift

@@ -1,6 +1,7 @@
 // Created by eric_horacek on 3/4/22.
 // Copyright © 2022 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - UIViewConfiguringSwiftUIView
@@ -41,3 +42,4 @@ extension UIViewConfiguringSwiftUIView {
     return copy
   }
 }
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Views/ViewType.swift

@@ -1,8 +1,8 @@
 // Created by Cal Stephens on 6/26/23.
 // Copyright © 2023 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
-
 #if canImport(UIKit)
 import UIKit
 
@@ -49,3 +49,4 @@ extension ViewRepresentableType {
   typealias RepresentableViewType = NSViewType
 }
 #endif
+#endif

package/Sources/Private/EmbeddedLibraries/LRUCache/LRUCache.swift

@@ -0,0 +1,256 @@
+//
+//  LRUCache.swift
+//  LRUCache
+//
+//  Version 1.0.2
+//
+//  Created by Nick Lockwood on 05/08/2021.
+//  Copyright © 2021 Nick Lockwood. All rights reserved.
+//
+//  Distributed under the permissive MIT license
+//  Get the latest version from here:
+//
+//  https://github.com/nicklockwood/LRUCache
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+//
+
+import Foundation
+
+#if os(iOS) || os(tvOS)
+import UIKit
+
+/// Notification that cache should be cleared
+let LRUCacheMemoryWarningNotification: NSNotification.Name =
+  UIApplication.didReceiveMemoryWarningNotification
+
+#else
+
+/// Notification that cache should be cleared
+let LRUCacheMemoryWarningNotification: NSNotification.Name =
+  .init("LRUCacheMemoryWarningNotification")
+
+#endif
+
+// MARK: - LRUCache
+
+final class LRUCache<Key: Hashable, Value> {
+
+  // MARK: Lifecycle
+
+  /// Initialize the cache with the specified `totalCostLimit` and `countLimit`
+  init(
+    totalCostLimit: Int = .max,
+    countLimit: Int = .max,
+    notificationCenter: NotificationCenter = .default)
+  {
+    self.totalCostLimit = totalCostLimit
+    self.countLimit = countLimit
+    self.notificationCenter = notificationCenter
+
+    token = notificationCenter.addObserver(
+      forName: LRUCacheMemoryWarningNotification,
+      object: nil,
+      queue: nil)
+    { [weak self] _ in
+      self?.removeAllValues()
+    }
+  }
+
+  deinit {
+    if let token = token {
+      notificationCenter.removeObserver(token)
+    }
+  }
+
+  // MARK: Internal
+
+  /// The current total cost of values in the cache
+  private(set) var totalCost = 0
+
+  /// The maximum total cost permitted
+  var totalCostLimit: Int {
+    didSet { clean() }
+  }
+
+  /// The maximum number of values permitted
+  var countLimit: Int {
+    didSet { clean() }
+  }
+
+  // MARK: Private
+
+  private var values: [Key: Container] = [:]
+  private unowned(unsafe) var head: Container?
+  private unowned(unsafe) var tail: Container?
+  private let lock: NSLock = .init()
+  private var token: AnyObject?
+  private let notificationCenter: NotificationCenter
+
+}
+
+extension LRUCache {
+  /// The number of values currently stored in the cache
+  var count: Int {
+    values.count
+  }
+
+  /// Is the cache empty?
+  var isEmpty: Bool {
+    values.isEmpty
+  }
+
+  /// Returns all values in the cache from oldest to newest
+  var allValues: [Value] {
+    lock.lock()
+    defer { lock.unlock() }
+    var values = [Value]()
+    var next = head
+    while let container = next {
+      values.append(container.value)
+      next = container.next
+    }
+    return values
+  }
+
+  /// Insert a value into the cache with optional `cost`
+  func setValue(_ value: Value?, forKey key: Key, cost: Int = 0) {
+    guard let value = value else {
+      removeValue(forKey: key)
+      return
+    }
+    lock.lock()
+    if let container = values[key] {
+      container.value = value
+      totalCost -= container.cost
+      container.cost = cost
+      remove(container)
+      append(container)
+    } else {
+      let container = Container(
+        value: value,
+        cost: cost,
+        key: key)
+      values[key] = container
+      append(container)
+    }
+    totalCost += cost
+    lock.unlock()
+    clean()
+  }
+
+  /// Remove a value  from the cache and return it
+  @discardableResult
+  func removeValue(forKey key: Key) -> Value? {
+    lock.lock()
+    defer { lock.unlock() }
+    guard let container = values.removeValue(forKey: key) else {
+      return nil
+    }
+    remove(container)
+    totalCost -= container.cost
+    return container.value
+  }
+
+  /// Fetch a value from the cache
+  func value(forKey key: Key) -> Value? {
+    lock.lock()
+    defer { lock.unlock() }
+    if let container = values[key] {
+      remove(container)
+      append(container)
+      return container.value
+    }
+    return nil
+  }
+
+  /// Remove all values from the cache
+  func removeAllValues() {
+    lock.lock()
+    values.removeAll()
+    head = nil
+    tail = nil
+    lock.unlock()
+  }
+}
+
+extension LRUCache {
+
+  // MARK: Fileprivate
+
+  fileprivate final class Container {
+
+    // MARK: Lifecycle
+
+    init(value: Value, cost: Int, key: Key) {
+      self.value = value
+      self.cost = cost
+      self.key = key
+    }
+
+    // MARK: Internal
+
+    var value: Value
+    var cost: Int
+    let key: Key
+    unowned(unsafe) var prev: Container?
+    unowned(unsafe) var next: Container?
+
+  }
+
+  // MARK: Private
+
+  // Remove container from list (must be called inside lock)
+  private func remove(_ container: Container) {
+    if head === container {
+      head = container.next
+    }
+    if tail === container {
+      tail = container.prev
+    }
+    container.next?.prev = container.prev
+    container.prev?.next = container.next
+    container.next = nil
+  }
+
+  // Append container to list (must be called inside lock)
+  private func append(_ container: Container) {
+    assert(container.next == nil)
+    if head == nil {
+      head = container
+    }
+    container.prev = tail
+    tail?.next = container
+    tail = container
+  }
+
+  // Remove expired values (must be called outside lock)
+  private func clean() {
+    lock.lock()
+    defer { lock.unlock() }
+    while
+      totalCost > totalCostLimit || count > countLimit,
+      let container = head
+    {
+      remove(container)
+      values.removeValue(forKey: container.key)
+      totalCost -= container.cost
+    }
+  }
+}

package/Sources/Private/EmbeddedLibraries/LRUCache/README.md

@@ -0,0 +1,24 @@
+## LRUCache
+
+This directory includes the source code of the LRUCache library, from the following release:
+https://github.com/nicklockwood/LRUCache/releases/tag/1.0.4
+
+Lottie is distributed via multiple package managers (SPM, Cocoapods, Carthage, and NPM),
+each with different packaging and compilation requirements. 
+
+Due to limitations of these package managers, we can't depend on / import 
+a separate LRUCache module / library. Instead, we include the source
+directly within the Lottie library and compile everything as a single unit.
+
+### Update instructions
+
+From time to time we may need to update to a more recent version of LRUCache.
+When doing this, follow these steps:
+
+ 1. Download the latest release from https://github.com/nicklockwood/LRUCache
+    and replace the source code in this directory with the updated code.
+
+ 2. Update the URL at the top of this file to indicate what release is being used.
+
+ 3. Change all of the `public` symbols defined in this module to instead be `internal`
+    to prevent Lottie from exposing any EpoxyCore APIs.

package/Sources/Private/EmbeddedLibraries/README.md

@@ -5,6 +5,7 @@ This directory includes the source code of libraries that are embedded within lo
 This includes:
  - ZipFoundation (https://github.com/weichsel/ZIPFoundation)
  - EpoxyCore (https://github.com/airbnb/epoxy-ios)
+ - LRUCache (https://github.com/nicklockwood/LRUCache)
 
 Lottie is distributed via multiple package managers (SPM, Cocoapods, Carthage, and NPM),
 each with different packaging and compilation requirements. 
@@ -25,3 +26,16 @@ When doing this, follow these steps:
  
  3. Change all of the `public` symbols defined in the module to instead be `internal`
     to prevent Lottie from exposing any APIs from other libraries.
+
+### Adding a new dependencies
+
+ 1. Create a subdirectory in `EmbeddedLibraries` for the new dependency.
+
+ 2. Add the dependency to the list at the top of this file.
+
+ 3. Add a `README.md` to the directory for the new library, using the same formatting as the `README.md` file used by other dependencies.
+
+ 4. Exclude the new `README.md` file from the lottie-ios package by adding it to the `exclude:` list in `Package.swift`.
+
+ 5. Change all of the `public` symbols defined in the module to instead be `internal`
+    to prevent Lottie from exposing any APIs from other libraries.

package/Sources/Private/MainThread/LayerContainers/Utility/CachedImageProvider.swift

@@ -22,11 +22,11 @@ private final class CachedImageProvider: AnimationImageProvider {
   // MARK: Public
 
   public func imageForAsset(asset: ImageAsset) -> CGImage? {
-    if let image = imageCache.object(forKey: asset.id as NSString) {
+    if let image = imageCache.value(forKey: asset.id) {
       return image
     }
     if let image = imageProvider.imageForAsset(asset: asset) {
-      imageCache.setObject(image, forKey: asset.id as NSString)
+      imageCache.setValue(image, forKey: asset.id)
       return image
     }
     return nil
@@ -34,13 +34,19 @@ private final class CachedImageProvider: AnimationImageProvider {
 
   // MARK: Internal
 
-  let imageCache: NSCache<NSString, CGImage> = .init()
-  let imageProvider: AnimationImageProvider
-
   func contentsGravity(for asset: ImageAsset) -> CALayerContentsGravity {
     imageProvider.contentsGravity(for: asset)
   }
 
+  // MARK: Private
+
+  /// The underlying storage of this cache.
+  ///  - We use the `LRUCache` library instead of `NSCache`, because `NSCache`
+  ///    clears all cached values when the app is backgrounded instead of
+  ///    only when the app receives a memory warning notification.
+  private var imageCache = LRUCache<String, CGImage>()
+  private let imageProvider: AnimationImageProvider
+
 }
 
 extension AnimationImageProvider {

package/Sources/Private/MainThread/LayerContainers/Utility/InvertedMatteLayer.swift

@@ -39,7 +39,6 @@ final class InvertedMatteLayer: CALayer, CompositionLayerDelegate {
   // MARK: Internal
 
   let inputMatte: CompositionLayer?
-  let wrapperLayer = CALayer()
 
   func frameUpdated(frame _: CGFloat) {
     setNeedsDisplay()

package/Sources/Private/Model/Extensions/KeyedDecodingContainerExtensions.swift

@@ -9,6 +9,9 @@ protocol ClassFamily: Decodable {
   /// The discriminator key.
   static var discriminator: Discriminator { get }
 
+  /// The "unknown" fallback case if the type discriminator could not be parsed successfully.
+  static var unknown: Self { get }
+
   /// Returns the class type of the object corresponding to the value.
   func getType() -> AnyObject.Type
 }
@@ -34,7 +37,7 @@ extension KeyedDecodingContainer {
     var tmpContainer = container
     while !container.isAtEnd {
       let typeContainer = try container.nestedContainer(keyedBy: Discriminator.self)
-      let family: U = try typeContainer.decode(U.self, forKey: U.discriminator)
+      let family: U = (try? typeContainer.decodeIfPresent(U.self, forKey: U.discriminator)) ?? .unknown
       if let type = family.getType() as? T.Type {
         list.append(try tmpContainer.decode(type))
       }
@@ -60,7 +63,7 @@ extension KeyedDecodingContainer {
     var tmpContainer = container
     while !container.isAtEnd {
       let typeContainer = try container.nestedContainer(keyedBy: Discriminator.self)
-      let family: U = try typeContainer.decode(U.self, forKey: U.discriminator)
+      let family: U = (try? typeContainer.decodeIfPresent(U.self, forKey: U.discriminator)) ?? .unknown
       if let type = family.getType() as? T.Type {
         list.append(try tmpContainer.decode(type))
       }

package/Sources/Private/Model/LayerEffects/EffectValues/EffectValue.swift

@@ -50,8 +50,8 @@ class EffectValue: Codable, DictionaryInitializable {
   }
 
   required init(dictionary: [String: Any]) throws {
-    type = EffectValueType(rawValue: try dictionary.value(for: CodingKeys.type)) ?? .unknown
-    name = try dictionary.value(for: CodingKeys.name) ?? "Effect"
+    type = (try? dictionary.value(for: CodingKeys.type)).flatMap(EffectValueType.init(rawValue:)) ?? .unknown
+    name = (try? dictionary.value(for: CodingKeys.name)) ?? "Effect"
   }
 
   // MARK: Internal

package/Sources/Private/Model/Layers/LayerModel.swift

@@ -27,6 +27,8 @@ extension LayerType: ClassFamily {
       return ShapeLayerModel.self
     case .text:
       return TextLayerModel.self
+    case .unknown:
+      return LayerModel.self
     }
   }
 }
@@ -40,6 +42,7 @@ public enum LayerType: Int, Codable {
   case null
   case shape
   case text
+  case unknown
 
   public init(from decoder: Decoder) throws {
     self = try LayerType(rawValue: decoder.singleValueContainer().decode(RawValue.self)) ?? .null
@@ -241,6 +244,8 @@ extension Array where Element == LayerModel {
         return try ShapeLayerModel(dictionary: dictionary)
       case .text:
         return try TextLayerModel(dictionary: dictionary)
+      case .unknown:
+        return try LayerModel(dictionary: dictionary)
       case .none:
         return nil
       }

package/Sources/Private/Utility/Helpers/Binding+Map.swift

@@ -1,6 +1,7 @@
 // Created by miguel_jimenez on 7/27/23.
 // Copyright © 2023 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 @available(iOS 13.0, tvOS 13.0, macOS 10.15, *)
@@ -16,3 +17,4 @@ extension Binding {
     }
   }
 }
+#endif

package/Sources/Private/Utility/Helpers/View+ValueChanged.swift

@@ -1,6 +1,7 @@
 // Created by miguel_jimenez on 7/26/23.
 // Copyright © 2023 Airbnb Inc. All rights reserved.
 
+#if canImport(Combine) && canImport(SwiftUI)
 import Combine
 import SwiftUI
 
@@ -18,3 +19,4 @@ extension View {
     }
   }
 }
+#endif

package/Sources/Public/Animation/LottieAnimationLayer.swift

@@ -1134,11 +1134,16 @@ public class LottieAnimationLayer: CALayer {
   }
 
   fileprivate func makeAnimationLayer(usingEngine renderingEngine: RenderingEngineOption) {
+    /// Disable the default implicit crossfade animation Core Animation creates
+    /// when adding or removing sublayers.
+    actions = ["sublayers": NSNull()]
+
     /// Remove current animation if any
     removeCurrentAnimation()
 
     if let oldAnimation = animationLayer {
       oldAnimation.removeFromSuperlayer()
+      rootAnimationLayer = nil
     }
 
     guard let animation = animation else {

package/Sources/Public/Animation/LottieAnimationView.swift

@@ -368,6 +368,13 @@ open class LottieAnimationView: LottieAnimationViewBase {
 
   // MARK: Public
 
+  /// Whether or not transform and position changes of the view should animate alongside
+  /// any existing animation context.
+  ///  - Defaults to `true` which will grab the current animation context and animate position and
+  ///    transform changes matching the current context's curve and duration.
+  ///    `false` will cause transform and position changes to happen unanimated
+  public var animateLayoutChangesWithCurrentCoreAnimationContext = true
+
   /// The configuration that this `LottieAnimationView` uses when playing its animation
   public var configuration: LottieConfiguration {
     get { lottieAnimationLayer.configuration }
@@ -933,7 +940,11 @@ open class LottieAnimationView: LottieAnimationViewBase {
     // If layout is changed without animation, explicitly set animation duration to 0.0
     // inside CATransaction to avoid unwanted artifacts.
     /// Check if any animation exist on the view's layer, and match it.
-    if let key = lottieAnimationLayer.animationKeys()?.first, let animation = lottieAnimationLayer.animation(forKey: key) {
+    if
+      let key = lottieAnimationLayer.animationKeys()?.first,
+      let animation = lottieAnimationLayer.animation(forKey: key),
+      animateLayoutChangesWithCurrentCoreAnimationContext
+    {
       // The layout is happening within an animation block. Grab the animation data.
 
       let positionKey = "LayoutPositionAnimation"

package/Sources/Public/Animation/LottieView.swift

@@ -1,6 +1,7 @@
 // Created by Bryn Bodayle on 1/20/22.
 // Copyright © 2022 Airbnb Inc. All rights reserved.
 
+#if canImport(SwiftUI)
 import SwiftUI
 
 // MARK: - LottieView
@@ -480,3 +481,4 @@ public struct LottieView<Placeholder: View>: UIViewConfiguringSwiftUIView {
     loadAnimationIfNecessary()
   }
 }
+#endif

package/Sources/Public/AnimationCache/DefaultAnimationCache.swift

@@ -12,7 +12,7 @@ import Foundation
 /// Once `cacheSize` is reached, animations can be ejected.
 /// The default size of the cache is 100.
 ///
-/// This cache implementation also responds to memory pressure, as it's backed by `NSCache`.
+/// This cache implementation also responds to memory pressure.
 public class DefaultAnimationCache: AnimationCacheProvider, @unchecked Sendable {
 
   // MARK: Lifecycle
@@ -26,7 +26,7 @@ public class DefaultAnimationCache: AnimationCacheProvider, @unchecked Sendable
   /// The global shared Cache.
   public static let sharedCache = DefaultAnimationCache()
 
-  /// The size of the cache.
+  /// The maximum number of animations that can be stored in the cache.
   public var cacheSize: Int {
     get { cache.countLimit }
     set { cache.countLimit = newValue }
@@ -34,20 +34,24 @@ public class DefaultAnimationCache: AnimationCacheProvider, @unchecked Sendable
 
   /// Clears the Cache.
   public func clearCache() {
-    cache.removeAllObjects()
+    cache.removeAllValues()
   }
 
   public func animation(forKey key: String) -> LottieAnimation? {
-    cache.object(forKey: key as NSString)
+    cache.value(forKey: key)
   }
 
   public func setAnimation(_ animation: LottieAnimation, forKey key: String) {
-    cache.setObject(animation, forKey: key as NSString)
+    cache.setValue(animation, forKey: key)
   }
 
   // MARK: Private
 
   private static let defaultCacheCountLimit = 100
 
-  private let cache = NSCache<NSString, LottieAnimation>()
+  /// The underlying storage of this cache.
+  ///  - We use the `LRUCache` library instead of `NSCache`, because `NSCache`
+  ///    clears all cached values when the app is backgrounded instead of
+  ///    only when the app receives a memory warning notification.
+  private let cache = LRUCache<String, LottieAnimation>()
 }