lottie-ios 4.1.3 → 4.2.0

package/Sources/Private/MainThread/LayerContainers/CompLayers/MaskContainerLayer.swift

@@ -167,7 +167,7 @@ private class MaskNodeProperties: NodePropertyMap {
     shape = NodeProperty(provider: KeyframeInterpolator(keyframes: mask.shape.keyframes))
     expansion = NodeProperty(provider: KeyframeInterpolator(keyframes: mask.expansion.keyframes))
     propertyMap = [
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
       "Shape" : shape,
       "Expansion" : expansion,
     ]

package/Sources/Private/MainThread/LayerContainers/MainThreadAnimationLayer.swift

@@ -23,6 +23,7 @@ final class MainThreadAnimationLayer: CALayer, RootAnimationLayer {
     imageProvider: AnimationImageProvider,
     textProvider: AnimationTextProvider,
     fontProvider: AnimationFontProvider,
+    maskAnimationToBounds: Bool,
     logger: LottieLogger)
   {
     layerImageProvider = LayerImageProvider(imageProvider: imageProvider, assets: animation.assetLibrary?.imageAssets)
@@ -31,7 +32,7 @@ final class MainThreadAnimationLayer: CALayer, RootAnimationLayer {
     animationLayers = []
     self.logger = logger
     super.init()
-    masksToBounds = true
+    masksToBounds = maskAnimationToBounds
     bounds = animation.bounds
     let layers = animation.layers.initializeCompositionLayers(
       assetLibrary: animation.assetLibrary,
@@ -146,6 +147,9 @@ final class MainThreadAnimationLayer: CALayer, RootAnimationLayer {
   /// The animatable Current Frame Property
   @NSManaged var currentFrame: CGFloat
 
+  /// The parent `LottieAnimationView` that manages this layer
+  weak var animationView: LottieAnimationView?
+
   var animationLayers: ContiguousArray<CompositionLayer>
 
   var primaryAnimationKey: AnimationKey {
@@ -200,7 +204,14 @@ final class MainThreadAnimationLayer: CALayer, RootAnimationLayer {
 
   func logHierarchyKeypaths() {
     logger.info("Lottie: Logging Animation Keypaths")
-    animationLayers.forEach { $0.logKeypaths(for: nil, logger: self.logger) }
+
+    for keypath in allHierarchyKeypaths() {
+      logger.info(keypath)
+    }
+  }
+
+  func allHierarchyKeypaths() -> [String] {
+    animationLayers.flatMap { $0.allKeypaths() }
   }
 
   func setValueProvider(_ valueProvider: AnyValueProvider, keypath: AnimationKeypath) {

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

@@ -25,12 +25,12 @@ final class LayerTransformProperties: NodePropertyMap, KeypathSearchable {
 
     var propertyMap: [String: AnyNodeProperty] = [
       "Anchor Point" : anchor,
-      "Scale" : scale,
-      "Rotation": rotationZ,
+      PropertyName.scale.rawValue : scale,
+      PropertyName.rotation.rawValue: rotationZ,
       "Rotation X" : rotationX,
       "Rotation Y" : rotationY,
       "Rotation Z" : rotationZ,
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
     ]
 
     if
@@ -46,7 +46,7 @@ final class LayerTransformProperties: NodePropertyMap, KeypathSearchable {
       position = nil
     } else if let positionKeyframes = transform.position?.keyframes {
       let position: NodeProperty<LottieVector3D> = NodeProperty(provider: KeyframeInterpolator(keyframes: positionKeyframes))
-      propertyMap["Position"] = position
+      propertyMap[PropertyName.position.rawValue] = position
       self.position = position
       positionX = nil
       positionY = nil

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/PathNodes/EllipseNode.swift

@@ -20,7 +20,7 @@ final class EllipseNodeProperties: NodePropertyMap, KeypathSearchable {
     position = NodeProperty(provider: KeyframeInterpolator(keyframes: ellipse.position.keyframes))
     size = NodeProperty(provider: KeyframeInterpolator(keyframes: ellipse.size.keyframes))
     keypathProperties = [
-      "Position" : position,
+      PropertyName.position.rawValue : position,
       "Size" : size,
     ]
     properties = Array(keypathProperties.values)

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/PathNodes/PolygonNode.swift

@@ -23,10 +23,10 @@ final class PolygonNodeProperties: NodePropertyMap, KeypathSearchable {
     rotation = NodeProperty(provider: KeyframeInterpolator(keyframes: star.rotation.keyframes))
     points = NodeProperty(provider: KeyframeInterpolator(keyframes: star.points.keyframes))
     keypathProperties = [
-      "Position" : position,
+      PropertyName.position.rawValue : position,
       "Outer Radius" : outerRadius,
       "Outer Roundedness" : outerRoundedness,
-      "Rotation" : rotation,
+      PropertyName.rotation.rawValue : rotation,
       "Points" : points,
     ]
     properties = Array(keypathProperties.values)

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/PathNodes/RectNode.swift

@@ -22,7 +22,7 @@ final class RectNodeProperties: NodePropertyMap, KeypathSearchable {
     cornerRadius = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.cornerRadius.keyframes))
 
     keypathProperties = [
-      "Position" : position,
+      PropertyName.position.rawValue : position,
       "Size" : size,
       "Roundness" : cornerRadius,
     ]

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/PathNodes/StarNode.swift

@@ -33,12 +33,12 @@ final class StarNodeProperties: NodePropertyMap, KeypathSearchable {
     rotation = NodeProperty(provider: KeyframeInterpolator(keyframes: star.rotation.keyframes))
     points = NodeProperty(provider: KeyframeInterpolator(keyframes: star.points.keyframes))
     keypathProperties = [
-      "Position" : position,
+      PropertyName.position.rawValue : position,
       "Outer Radius" : outerRadius,
       "Outer Roundedness" : outerRoundedness,
       "Inner Radius" : innerRadius,
       "Inner Roundedness" : innerRoundedness,
-      "Rotation" : rotation,
+      PropertyName.rotation.rawValue : rotation,
       "Points" : points,
     ]
     properties = Array(keypathProperties.values)

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderContainers/GroupNode.swift

@@ -40,13 +40,13 @@ final class GroupNodeProperties: NodePropertyMap, KeypathSearchable {
     }
     keypathProperties = [
       "Anchor Point" : anchor,
-      "Position" : position,
-      "Scale" : scale,
-      "Rotation" : rotationZ,
+      PropertyName.position.rawValue : position,
+      PropertyName.scale.rawValue : scale,
+      PropertyName.rotation.rawValue : rotationZ,
       "Rotation X" : rotationX,
       "Rotation Y" : rotationY,
       "Rotation Z" : rotationZ,
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
       "Skew" : skew,
       "Skew Axis" : skewAxis,
     ]

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderNodes/FillNode.swift

@@ -20,7 +20,7 @@ final class FillNodeProperties: NodePropertyMap, KeypathSearchable {
     opacity = NodeProperty(provider: KeyframeInterpolator(keyframes: fill.opacity.keyframes))
     type = fill.fillRule
     keypathProperties = [
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
       PropertyName.color.rawValue : color,
     ]
     properties = Array(keypathProperties.values)

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderNodes/GradientFillNode.swift

@@ -24,7 +24,7 @@ final class GradientFillProperties: NodePropertyMap, KeypathSearchable {
     numberOfColors = gradientfill.numberOfColors
     fillRule = gradientfill.fillRule
     keypathProperties = [
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
       "Start Point" : startPoint,
       "End Point" : endPoint,
       "Colors" : colors,

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderNodes/GradientStrokeNode.swift

@@ -44,7 +44,7 @@ final class GradientStrokeProperties: NodePropertyMap, KeypathSearchable {
       dashPhase = NodeProperty(provider: SingleValueProvider(LottieVector1D(0)))
     }
     keypathProperties = [
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
       "Start Point" : startPoint,
       "End Point" : endPoint,
       "Colors" : colors,

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderNodes/StrokeNode.swift

@@ -36,7 +36,7 @@ final class StrokeNodeProperties: NodePropertyMap, KeypathSearchable {
       dashPhase = NodeProperty(provider: SingleValueProvider(LottieVector1D(0)))
     }
     keypathProperties = [
-      "Opacity" : opacity,
+      PropertyName.opacity.rawValue : opacity,
       PropertyName.color.rawValue : color,
       "Stroke Width" : width,
       "Dashes" : dashPattern,

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/Text/TextAnimatorNode.swift

@@ -28,14 +28,14 @@ final class TextAnimatorNodeProperties: NodePropertyMap, KeypathSearchable {
 
     if let keyframeGroup = textAnimator.position {
       position = NodeProperty(provider: KeyframeInterpolator(keyframes: keyframeGroup.keyframes))
-      properties["Position"] = position
+      properties[PropertyName.position.rawValue] = position
     } else {
       position = nil
     }
 
     if let keyframeGroup = textAnimator.scale {
       scale = NodeProperty(provider: KeyframeInterpolator(keyframes: keyframeGroup.keyframes))
-      properties["Scale"] = scale
+      properties[PropertyName.scale.rawValue] = scale
     } else {
       scale = nil
     }
@@ -71,14 +71,14 @@ final class TextAnimatorNodeProperties: NodePropertyMap, KeypathSearchable {
     if let keyframeGroup = textAnimator.rotationZ {
       rotationZ = NodeProperty(provider: KeyframeInterpolator(keyframes: keyframeGroup.keyframes))
       properties["Rotation Z"] = rotationZ
-      properties["Rotation"] = rotationZ
+      properties[PropertyName.rotation.rawValue] = rotationZ
     } else {
       rotationZ = nil
     }
 
     if let keyframeGroup = textAnimator.opacity {
       opacity = NodeProperty(provider: KeyframeInterpolator(keyframes: keyframeGroup.keyframes))
-      properties["Opacity"] = opacity
+      properties[PropertyName.opacity.rawValue] = opacity
     } else {
       opacity = nil
     }

package/Sources/Private/Model/Assets/ImageAsset.swift

@@ -80,9 +80,10 @@ extension Data {
   /// - parameter dataString: The data string to parse.
   /// - parameter options: Options for the string parsing. Default value is `[]`.
   internal init?(dataString: String, options: DataURLReadOptions = []) {
+    let trimmedDataString = dataString.trimmingCharacters(in: .whitespacesAndNewlines)
     guard
       dataString.hasPrefix("data:"),
-      let url = URL(string: dataString)
+      let url = URL(string: trimmedDataString)
     else {
       return nil
     }
@@ -90,10 +91,10 @@ extension Data {
     // with messages since url doesn't have a host. This only fixes flooding logs
     // when data inside Data URL is base64 encoded.
     if
-      let base64Range = dataString.range(of: ";base64,"),
+      let base64Range = trimmedDataString.range(of: ";base64,"),
       !options.contains(DataURLReadOptions.legacy)
     {
-      let encodedString = String(dataString[base64Range.upperBound...])
+      let encodedString = String(trimmedDataString[base64Range.upperBound...])
       self.init(base64Encoded: encodedString)
     } else {
       try? self.init(contentsOf: url)

package/Sources/Private/Model/DotLottie/DotLottieAnimation.swift

@@ -23,9 +23,6 @@ struct DotLottieAnimation: Codable {
   /// mode - "bounce" | "normal"
   var mode: String? = "normal"
 
-  /// URL to animation, to be set internally
-  var animationUrl: URL?
-
   /// Loop mode for animation
   var loopMode: LottieLoopMode {
     mode == "bounce" ? .autoReverse : ((loop ?? false) ? .loop : .playOnce)
@@ -38,12 +35,9 @@ struct DotLottieAnimation: Codable {
 
   /// Loads `LottieAnimation` from `animationUrl`
   /// - Returns: Deserialized `LottieAnimation`. Optional.
-  func animation() throws -> LottieAnimation {
-    guard let animationUrl = animationUrl else {
-      throw DotLottieError.animationNotAvailable
-    }
+  func animation(url: URL) throws -> LottieAnimation {
+    let animationUrl = url.appendingPathComponent("\(id).json")
     let data = try Data(contentsOf: animationUrl)
     return try LottieAnimation.from(data: data)
   }
-
 }

package/Sources/Private/Model/DotLottie/DotLottieManifest.swift

@@ -10,21 +10,10 @@ import Foundation
 /// Manifest model for .lottie File
 struct DotLottieManifest: Codable {
 
-  // MARK: Lifecycle
-
-  init(animations: [DotLottieAnimation], version: String, author: String, generator: String) {
-    self.animations = animations
-    self.version = version
-    self.author = author
-    self.generator = generator
-  }
-
-  // MARK: Internal
-
   var animations: [DotLottieAnimation]
-  var version: String
-  var author: String
-  var generator: String
+  var version: String?
+  var author: String?
+  var generator: String?
 
   /// Decodes data to Manifest model
   /// - Parameter data: Data to decode

package/Sources/Private/Model/DotLottie/DotLottieUtils.swift

@@ -15,7 +15,7 @@ struct DotLottieUtils {
 
   /// Temp folder to app directory
   static var tempDirectoryURL: URL {
-    if #available(iOS 10.0, *) {
+    if #available(iOS 10.0, macOS 10.12, *) {
       return FileManager.default.temporaryDirectory
     }
     return URL(fileURLWithPath: NSTemporaryDirectory())
@@ -52,7 +52,17 @@ extension FileManager {
 // MARK: - DotLottieError
 
 public enum DotLottieError: Error {
+  /// URL response has no data.
+  case noDataLoaded
+  /// Asset with this name was not found in the provided bundle.
+  case assetNotFound(name: String, bundle: Bundle?)
+  /// Animation loading from asset is not supported on macOS 10.10.
+  case loadingFromAssetNotSupported
+
+  @available(*, deprecated, message: "Unused")
   case invalidFileFormat
+  @available(*, deprecated, message: "Unused")
   case invalidData
+  @available(*, deprecated, message: "Unused")
   case animationNotAvailable
 }

package/Sources/Private/Model/DotLottie/ZipFoundation/Archive+BackingConfiguration.swift

@@ -0,0 +1,147 @@
+//
+//  Archive+BackingConfiguration.swift
+//  ZIPFoundation
+//
+//  Copyright © 2017-2021 Thomas Zoechling, https://www.peakstep.com and the ZIP Foundation project authors.
+//  Released under the MIT License.
+//
+//  See https://github.com/weichsel/ZIPFoundation/blob/master/LICENSE for license information.
+//
+
+import Foundation
+
+extension Archive {
+
+  struct BackingConfiguration {
+    let file: FILEPointer
+    let endOfCentralDirectoryRecord: EndOfCentralDirectoryRecord
+    let zip64EndOfCentralDirectory: ZIP64EndOfCentralDirectory?
+
+    #if swift(>=5.0)
+    let memoryFile: MemoryFile?
+
+    init(
+      file: FILEPointer,
+      endOfCentralDirectoryRecord: EndOfCentralDirectoryRecord,
+      zip64EndOfCentralDirectory: ZIP64EndOfCentralDirectory? = nil,
+      memoryFile: MemoryFile? = nil)
+    {
+      self.file = file
+      self.endOfCentralDirectoryRecord = endOfCentralDirectoryRecord
+      self.zip64EndOfCentralDirectory = zip64EndOfCentralDirectory
+      self.memoryFile = memoryFile
+    }
+    #else
+
+    init(
+      file: FILEPointer,
+      endOfCentralDirectoryRecord: EndOfCentralDirectoryRecord,
+      zip64EndOfCentralDirectory: ZIP64EndOfCentralDirectory?)
+    {
+      self.file = file
+      self.endOfCentralDirectoryRecord = endOfCentralDirectoryRecord
+      self.zip64EndOfCentralDirectory = zip64EndOfCentralDirectory
+    }
+    #endif
+  }
+
+  static func makeBackingConfiguration(for url: URL, mode: AccessMode)
+    -> BackingConfiguration?
+  {
+    let fileManager = FileManager()
+    switch mode {
+    case .read:
+      let fileSystemRepresentation = fileManager.fileSystemRepresentation(withPath: url.path)
+      guard
+        let archiveFile = fopen(fileSystemRepresentation, "rb"),
+        let (eocdRecord, zip64EOCD) = Archive.scanForEndOfCentralDirectoryRecord(in: archiveFile) else
+      {
+        return nil
+      }
+      return BackingConfiguration(
+        file: archiveFile,
+        endOfCentralDirectoryRecord: eocdRecord,
+        zip64EndOfCentralDirectory: zip64EOCD)
+    case .create:
+      let endOfCentralDirectoryRecord = EndOfCentralDirectoryRecord(
+        numberOfDisk: 0,
+        numberOfDiskStart: 0,
+        totalNumberOfEntriesOnDisk: 0,
+        totalNumberOfEntriesInCentralDirectory: 0,
+        sizeOfCentralDirectory: 0,
+        offsetToStartOfCentralDirectory: 0,
+        zipFileCommentLength: 0,
+        zipFileCommentData: Data())
+      do {
+        try endOfCentralDirectoryRecord.data.write(to: url, options: .withoutOverwriting)
+      } catch { return nil }
+      fallthrough
+    case .update:
+      let fileSystemRepresentation = fileManager.fileSystemRepresentation(withPath: url.path)
+      guard
+        let archiveFile = fopen(fileSystemRepresentation, "rb+"),
+        let (eocdRecord, zip64EOCD) = Archive.scanForEndOfCentralDirectoryRecord(in: archiveFile) else
+      {
+        return nil
+      }
+      fseeko(archiveFile, 0, SEEK_SET)
+      return BackingConfiguration(
+        file: archiveFile,
+        endOfCentralDirectoryRecord: eocdRecord,
+        zip64EndOfCentralDirectory: zip64EOCD)
+    }
+  }
+
+  #if swift(>=5.0)
+  static func makeBackingConfiguration(for data: Data, mode: AccessMode)
+    -> BackingConfiguration?
+  {
+    let posixMode: String
+    switch mode {
+    case .read: posixMode = "rb"
+    case .create: posixMode = "wb+"
+    case .update: posixMode = "rb+"
+    }
+    let memoryFile = MemoryFile(data: data)
+    guard let archiveFile = memoryFile.open(mode: posixMode) else { return nil }
+
+    switch mode {
+    case .read:
+      guard let (eocdRecord, zip64EOCD) = Archive.scanForEndOfCentralDirectoryRecord(in: archiveFile) else {
+        return nil
+      }
+
+      return BackingConfiguration(
+        file: archiveFile,
+        endOfCentralDirectoryRecord: eocdRecord,
+        zip64EndOfCentralDirectory: zip64EOCD,
+        memoryFile: memoryFile)
+    case .create:
+      let endOfCentralDirectoryRecord = EndOfCentralDirectoryRecord(
+        numberOfDisk: 0,
+        numberOfDiskStart: 0,
+        totalNumberOfEntriesOnDisk: 0,
+        totalNumberOfEntriesInCentralDirectory: 0,
+        sizeOfCentralDirectory: 0,
+        offsetToStartOfCentralDirectory: 0,
+        zipFileCommentLength: 0,
+        zipFileCommentData: Data())
+      _ = endOfCentralDirectoryRecord.data.withUnsafeBytes { (buffer: UnsafeRawBufferPointer) in
+        fwrite(buffer.baseAddress, buffer.count, 1, archiveFile) // Errors handled during read
+      }
+      fallthrough
+    case .update:
+      guard let (eocdRecord, zip64EOCD) = Archive.scanForEndOfCentralDirectoryRecord(in: archiveFile) else {
+        return nil
+      }
+
+      fseeko(archiveFile, 0, SEEK_SET)
+      return BackingConfiguration(
+        file: archiveFile,
+        endOfCentralDirectoryRecord: eocdRecord,
+        zip64EndOfCentralDirectory: zip64EOCD,
+        memoryFile: memoryFile)
+    }
+  }
+  #endif
+}