@octane-xplat/lottie 0.9.0 → 0.11.0

package/platforms/macos/src/vendor/Lottie/Public/iOS/FilepathImageProvider.swift

@@ -0,0 +1,78 @@
+//
+//  FilepathImageProvider.swift
+//  lottie-swift
+//
+//  Created by Brandon Withrow on 2/1/19.
+//
+
+import Foundation
+#if canImport(UIKit)
+import UIKit
+
+/// Provides an image for a lottie animation from a provided Bundle.
+public final class FilepathImageProvider: AnimationImageProvider {
+
+  // MARK: Lifecycle
+
+  /// Initializes an image provider with a specific filepath.
+  ///
+  /// - Parameter filepath: The absolute filepath containing the images.
+  /// - Parameter contentsGravity: The contents gravity to use when rendering the images.
+  ///
+  public init(filepath: String, contentsGravity: CALayerContentsGravity = .resize) {
+    self.filepath = URL(fileURLWithPath: filepath)
+    self.contentsGravity = contentsGravity
+  }
+
+  /// Initializes an image provider with a specific filepath.
+  ///
+  /// - Parameter filepath: The absolute filepath containing the images.
+  /// - Parameter contentsGravity: The contents gravity to use when rendering the images.
+  ///
+  public init(filepath: URL, contentsGravity: CALayerContentsGravity = .resize) {
+    self.filepath = filepath
+    self.contentsGravity = contentsGravity
+  }
+
+  // MARK: Public
+
+  public func imageForAsset(asset: ImageAsset) -> CGImage? {
+    if
+      asset.name.hasPrefix("data:"),
+      let url = URL(string: asset.name),
+      let data = try? Data(contentsOf: url),
+      let image = UIImage(data: data)
+    {
+      return image.cgImage
+    }
+
+    let directPath = filepath.appendingPathComponent(asset.name).path
+    if FileManager.default.fileExists(atPath: directPath) {
+      return UIImage(contentsOfFile: directPath)?.cgImage
+    }
+
+    let pathWithDirectory = filepath.appendingPathComponent(asset.directory).appendingPathComponent(asset.name).path
+    if FileManager.default.fileExists(atPath: pathWithDirectory) {
+      return UIImage(contentsOfFile: pathWithDirectory)?.cgImage
+    }
+
+    LottieLogger.shared.warn("Could not find image \"\(asset.name)\" in bundle")
+    return nil
+  }
+
+  public func contentsGravity(for _: ImageAsset) -> CALayerContentsGravity {
+    contentsGravity
+  }
+
+  // MARK: Internal
+
+  let filepath: URL
+  let contentsGravity: CALayerContentsGravity
+}
+
+extension FilepathImageProvider: Equatable {
+  public static func ==(_ lhs: FilepathImageProvider, _ rhs: FilepathImageProvider) -> Bool {
+    lhs.filepath == rhs.filepath
+  }
+}
+#endif

package/platforms/macos/src/vendor/Lottie/Public/iOS/LottieAnimationViewBase.swift

@@ -0,0 +1,85 @@
+//
+//  LottieAnimationViewBase.swift
+//  lottie-swift-iOS
+//
+//  Created by Brandon Withrow on 2/6/19.
+//
+
+#if canImport(UIKit)
+import UIKit
+
+/// The base view for `LottieAnimationView` on iOS, tvOS, watchOS, and macCatalyst.
+///
+/// Enables the `LottieAnimationView` implementation to be shared across platforms.
+open class LottieAnimationViewBase: UIView {
+
+  // MARK: Public
+
+  public override var contentMode: UIView.ContentMode {
+    didSet {
+      setNeedsLayout()
+    }
+  }
+
+  public override func didMoveToWindow() {
+    super.didMoveToWindow()
+    animationMovedToWindow()
+  }
+
+  public override func layoutSubviews() {
+    super.layoutSubviews()
+    layoutAnimation()
+  }
+
+  // MARK: Internal
+
+  var viewLayer: CALayer? {
+    layer
+  }
+
+  var screenScale: CGFloat {
+    #if os(iOS) || os(tvOS)
+    max(UITraitCollection.current.displayScale, 1)
+    #else // if os(visionOS)
+    // We intentionally don't check `#if os(visionOS)`, because that emits
+    // a warning when building on Xcode 14 and earlier.
+    1.0
+    #endif
+  }
+
+  func layoutAnimation() {
+    // Implemented by subclasses.
+  }
+
+  func animationMovedToWindow() {
+    // Implemented by subclasses.
+  }
+
+  func commonInit() {
+    contentMode = .scaleAspectFit
+    clipsToBounds = true
+    NotificationCenter.default.addObserver(
+      self,
+      selector: #selector(animationWillEnterForeground),
+      name: UIApplication.willEnterForegroundNotification,
+      object: nil
+    )
+    NotificationCenter.default.addObserver(
+      self,
+      selector: #selector(animationWillMoveToBackground),
+      name: UIApplication.didEnterBackgroundNotification,
+      object: nil
+    )
+  }
+
+  @objc
+  func animationWillMoveToBackground() {
+    // Implemented by subclasses.
+  }
+
+  @objc
+  func animationWillEnterForeground() {
+    // Implemented by subclasses.
+  }
+}
+#endif

package/platforms/macos/src/vendor/Lottie/Public/iOS/UIColorExtension.swift

@@ -0,0 +1,23 @@
+//
+//  UIColorExtension.swift
+//  lottie-swift
+//
+//  Created by Brandon Withrow on 2/4/19.
+//
+
+#if canImport(UIKit)
+import UIKit
+
+extension UIColor {
+
+  public var lottieColorValue: LottieColor {
+    var r: CGFloat = 0
+    var g: CGFloat = 0
+    var b: CGFloat = 0
+    var a: CGFloat = 0
+    getRed(&r, green: &g, blue: &b, alpha: &a)
+    return LottieColor(r: Double(r), g: Double(g), b: Double(b), a: Double(a))
+  }
+
+}
+#endif

package/platforms/macos/src/vendor/Lottie/Public/macOS/AnimationSubview.macOS.swift

@@ -0,0 +1,19 @@
+//
+//  AnimationSubview.swift
+//  lottie-swift-iOS
+//
+//  Created by Brandon Withrow on 2/5/19.
+//
+
+#if os(macOS)
+import AppKit
+
+/// A view that can be added to a keypath of an AnimationView
+public final class AnimationSubview: NSView {
+
+  var viewLayer: CALayer? {
+    layer
+  }
+
+}
+#endif

package/platforms/macos/src/vendor/Lottie/Public/macOS/BundleImageProvider.macOS.swift

@@ -0,0 +1,90 @@
+//
+//  LottieBundleImageProvider.swift
+//  lottie-swift
+//
+//  Created by Brandon Withrow on 1/25/19.
+//
+
+#if os(macOS)
+import AppKit
+
+/// Provides an image for a lottie animation from a provided Bundle.
+public final class BundleImageProvider: AnimationImageProvider {
+
+  // MARK: Lifecycle
+
+  /// Initializes an image provider with a bundle and an optional subpath.
+  ///
+  /// Provides images for an animation from a bundle. Additionally the provider can
+  /// search a specific subpath for the images.
+  ///
+  /// - Parameter bundle: The bundle containing images for the provider.
+  /// - Parameter searchPath: The subpath is a path within the bundle to search for image assets.
+  /// - Parameter contentsGravity: The contents gravity to use when rendering the image.
+  ///
+  public init(bundle: Bundle, searchPath: String?, contentsGravity: CALayerContentsGravity = .resize) {
+    self.bundle = bundle
+    self.searchPath = searchPath
+    self.contentsGravity = contentsGravity
+  }
+
+  // MARK: Public
+
+  public func imageForAsset(asset: ImageAsset) -> CGImage? {
+    if let base64Image = asset.base64Image {
+      return base64Image
+    }
+
+    let imagePath: String?
+    /// Try to find the image in the bundle.
+    if let searchPath {
+      /// Search in the provided search path for the image
+      var directoryPath = URL(fileURLWithPath: searchPath)
+      directoryPath.appendPathComponent(asset.directory)
+
+      if let path = bundle.path(forResource: asset.name, ofType: nil, inDirectory: directoryPath.path) {
+        /// First search for the image in the asset provided sub directory.
+        imagePath = path
+      } else if let path = bundle.path(forResource: asset.name, ofType: nil, inDirectory: searchPath) {
+        /// Try finding the image in the search path.
+        imagePath = path
+      } else {
+        imagePath = bundle.path(forResource: asset.name, ofType: nil)
+      }
+    } else {
+      if let path = bundle.path(forResource: asset.name, ofType: nil, inDirectory: asset.directory) {
+        /// First search for the image in the asset provided sub directory.
+        imagePath = path
+      } else {
+        /// First search for the image in bundle.
+        imagePath = bundle.path(forResource: asset.name, ofType: nil)
+      }
+    }
+
+    guard let foundPath = imagePath, let image = NSImage(contentsOfFile: foundPath) else {
+      /// No image found.
+      LottieLogger.shared.warn("Could not find image \"\(asset.name)\" in bundle")
+      return nil
+    }
+    return image.lottie_CGImage
+  }
+
+  public func contentsGravity(for _: ImageAsset) -> CALayerContentsGravity {
+    contentsGravity
+  }
+
+  // MARK: Internal
+
+  let bundle: Bundle
+  let searchPath: String?
+  let contentsGravity: CALayerContentsGravity
+}
+
+extension BundleImageProvider: Equatable {
+  public static func ==(_ lhs: BundleImageProvider, _ rhs: BundleImageProvider) -> Bool {
+    lhs.bundle == rhs.bundle
+      && lhs.searchPath == rhs.searchPath
+  }
+}
+
+#endif

package/platforms/macos/src/vendor/Lottie/Public/macOS/FilepathImageProvider.macOS.swift

@@ -0,0 +1,86 @@
+//
+//  FilepathImageProvider.swift
+//  lottie-swift
+//
+//  Created by Brandon Withrow on 2/1/19.
+//
+
+#if os(macOS)
+import AppKit
+
+/// An `AnimationImageProvider` that provides images by name from a specific filepath.
+public final class FilepathImageProvider: AnimationImageProvider {
+
+  // MARK: Lifecycle
+
+  /// Initializes an image provider with a specific filepath.
+  ///
+  /// - Parameter filepath: The absolute filepath containing the images.
+  /// - Parameter contentsGravity: The contents gravity to use when rendering the images.
+  ///
+  public init(filepath: String, contentsGravity: CALayerContentsGravity = .resize) {
+    self.filepath = URL(fileURLWithPath: filepath)
+    self.contentsGravity = contentsGravity
+  }
+
+  /// Initializes an image provider with a specific filepath.
+  ///
+  /// - Parameter filepath: The absolute filepath containing the images.
+  /// - Parameter contentsGravity: The contents gravity to use when rendering the images.
+  ///
+  public init(filepath: URL, contentsGravity: CALayerContentsGravity = .resize) {
+    self.filepath = filepath
+    self.contentsGravity = contentsGravity
+  }
+
+  // MARK: Public
+
+  public func imageForAsset(asset: ImageAsset) -> CGImage? {
+    if
+      asset.name.hasPrefix("data:"),
+      let url = URL(string: asset.name),
+      let data = try? Data(contentsOf: url),
+      let image = NSImage(data: data)
+    {
+      return image.lottie_CGImage
+    }
+
+    let directPath = filepath.appendingPathComponent(asset.name).path
+    if FileManager.default.fileExists(atPath: directPath) {
+      return NSImage(contentsOfFile: directPath)?.lottie_CGImage
+    }
+
+    let pathWithDirectory = filepath.appendingPathComponent(asset.directory).appendingPathComponent(asset.name).path
+    if FileManager.default.fileExists(atPath: pathWithDirectory) {
+      return NSImage(contentsOfFile: pathWithDirectory)?.lottie_CGImage
+    }
+
+    LottieLogger.shared.warn("Could not find image \"\(asset.name)\" in bundle")
+    return nil
+  }
+
+  public func contentsGravity(for _: ImageAsset) -> CALayerContentsGravity {
+    contentsGravity
+  }
+
+  // MARK: Internal
+
+  let filepath: URL
+  let contentsGravity: CALayerContentsGravity
+}
+
+extension FilepathImageProvider: Equatable {
+  public static func ==(_ lhs: FilepathImageProvider, _ rhs: FilepathImageProvider) -> Bool {
+    lhs.filepath == rhs.filepath
+  }
+}
+
+extension NSImage {
+  @nonobjc
+  var lottie_CGImage: CGImage? {
+    guard let imageData = tiffRepresentation else { return nil }
+    guard let sourceData = CGImageSourceCreateWithData(imageData as CFData, nil) else { return nil }
+    return CGImageSourceCreateImageAtIndex(sourceData, 0, nil)
+  }
+}
+#endif

package/platforms/macos/src/vendor/Lottie/Public/macOS/LottieAnimationViewBase.macOS.swift

@@ -0,0 +1,102 @@
+//
+//  LottieAnimationViewBase.swift
+//  lottie-swift-iOS
+//
+//  Created by Brandon Withrow on 2/6/19.
+//
+
+#if os(macOS)
+import AppKit
+
+public enum LottieContentMode: Int {
+  case scaleToFill
+  case scaleAspectFit
+  case scaleAspectFill
+  case redraw
+  case center
+  case top
+  case bottom
+  case left
+  case right
+  case topLeft
+  case topRight
+  case bottomLeft
+  case bottomRight
+}
+
+/// The base view for `LottieAnimationView` on macOs.
+///
+/// Enables the `LottieAnimationView` implementation to be shared across platforms.
+open class LottieAnimationViewBase: NSView {
+
+  // MARK: Public
+
+  public override var wantsUpdateLayer: Bool {
+    true
+  }
+
+  public override var isFlipped: Bool {
+    true
+  }
+
+  public var contentMode = LottieContentMode.scaleAspectFit {
+    didSet {
+      setNeedsLayout()
+    }
+  }
+
+  public override func viewDidMoveToWindow() {
+    super.viewDidMoveToWindow()
+    animationMovedToWindow()
+  }
+
+  public override func layout() {
+    super.layout()
+    CATransaction.begin()
+    CATransaction.setDisableActions(true)
+    layoutAnimation()
+    CATransaction.commit()
+  }
+
+  // MARK: Internal
+
+  var screenScale: CGFloat {
+    NSApp.mainWindow?.backingScaleFactor ?? 1
+  }
+
+  var viewLayer: CALayer? {
+    layer
+  }
+
+  func layoutAnimation() {
+    // Implemented by subclasses.
+  }
+
+  func animationMovedToWindow() {
+    // Implemented by subclasses.
+  }
+
+  func commonInit() {
+    wantsLayer = true
+  }
+
+  func setNeedsLayout() {
+    needsLayout = true
+  }
+
+  func layoutIfNeeded() {
+    // Implemented by subclasses.
+  }
+
+  @objc
+  func animationWillMoveToBackground() {
+    // Implemented by subclasses.
+  }
+
+  @objc
+  func animationWillEnterForeground() {
+    // Implemented by subclasses.
+  }
+
+}
+#endif

package/src/Lottie.macos.tsrx

@@ -0,0 +1,129 @@
+/** @jsxImportSource @octane-xplat/macos-renderer */
+import { useEffect, useImperativeHandle, useMemo, useRef } from 'octane'
+import { layoutChildProps } from './layout-child'
+import type { LottieHandle, LottieProps } from './props'
+
+type AppKitLottieAdapter = {
+	nativeView: any
+	durationMs: number
+	progress: number
+	isPlaying: boolean
+	onLoaded: ((duration: number) => void) | null
+	onEnded: (() => void) | null
+	onError: ((message: string) => void) | null
+	mountIn(host: any): void
+	loadJSON(json: string): void
+	loadFile(pathOrURL: string): void
+	loadURL(address: string): void
+	clear(): void
+	play(): void
+	pause(): void
+	stop(): void
+	seekTo(progress: number): void
+	speed: number
+	loop: boolean
+	fit: string
+	dispose(): void
+}
+
+function createHandle(adapter: AppKitLottieAdapter): LottieHandle {
+	return {
+		play: () => adapter.play(),
+		pause: () => adapter.pause(),
+		stop: () => adapter.stop(),
+		seekTo: (progress) => adapter.seekTo(progress),
+		setSpeed: (speed) => {
+			adapter.speed = speed
+		},
+		progress: () => adapter.progress,
+		duration: () => adapter.durationMs,
+		isPlaying: () => adapter.isPlaying,
+		native: adapter.nativeView,
+	}
+}
+
+/** AppKit Lottie uses the vendored Airbnb engine through the macOS leaf build. */
+export function Lottie(props: LottieProps) @{
+	const adapter = useMemo(
+		() => (globalThis as any).XplatLottieAdapter.new() as AppKitLottieAdapter,
+		[],
+	)
+	const latest = useRef(props)
+	latest.current = props
+
+	useImperativeHandle<LottieHandle>(props.ref, () => createHandle(adapter), [adapter])
+
+	useEffect(() => {
+		adapter.onLoaded = (duration) => {
+			const current = latest.current
+			if (current.speed !== undefined) adapter.speed = current.speed
+			if (current.progress !== undefined) adapter.seekTo(current.progress)
+			current.onLoaded?.({ duration })
+			if (current.playing ?? current.autoPlay ?? true) adapter.play()
+		}
+		adapter.onEnded = () => latest.current.onEnded?.()
+		adapter.onError = (message) => latest.current.onError?.({ message })
+
+		return () => adapter.dispose()
+	}, [])
+
+	useEffect(() => {
+		if (props.data !== undefined) {
+			try {
+				adapter.loadJSON(JSON.stringify(props.data))
+			} catch (error) {
+				props.onError?.({ message: String(error) })
+			}
+			return
+		}
+
+		const src = props.src
+		if (!src) {
+			adapter.clear()
+		} else if (src.trimStart().startsWith('{')) {
+			adapter.loadJSON(src)
+		} else if (/^https?:\/\//i.test(src)) {
+			adapter.loadURL(src)
+		} else {
+			adapter.loadFile(src)
+		}
+	}, [props.src, props.data])
+
+	useEffect(() => {
+		adapter.fit = props.fit ?? 'contain'
+	}, [props.fit])
+
+	useEffect(() => {
+		if (props.loop !== undefined) adapter.loop = props.loop
+	}, [props.loop])
+
+	useEffect(() => {
+		if (props.speed !== undefined) adapter.speed = props.speed
+	}, [props.speed])
+
+	useEffect(() => {
+		if (props.progress !== undefined && adapter.durationMs > 0) {
+			adapter.seekTo(props.progress)
+		}
+	}, [props.progress])
+
+	useEffect(() => {
+		if (props.playing === undefined || adapter.durationMs === 0) return
+		if (props.playing) adapter.play()
+		else adapter.pause()
+	}, [props.playing])
+
+	<flexboxlayout
+		ref={(host: any) => host && adapter.mountIn(host)}
+		id={props.id}
+		className={props.className}
+		style={props.style}
+		{...layoutChildProps(props)}
+		accessible={props.accessible}
+		accessibilityLabel={props.accessibilityLabel}
+		accessibilityRole={props.accessibilityRole ?? 'image'}
+		accessibilityHint={props.accessibilityHint}
+		accessibilityValue={props.accessibilityValue}
+		accessibilityState={props.accessibilityState}
+	/>
+}

package/src/Lottie.tsrx

@@ -1,5 +1,5 @@
 /** @jsxImportSource @nativescript-community/octane */
-import { useCallback, useEffect, useRef } from 'octane';
+import { useImperativeHandle, useCallback, useEffect, useRef } from 'octane';
 import { registerElement } from '@nativescript-community/octane';
 import { isAndroid } from '@nativescript/core';
 import { LottieView } from './vendor/ui-lottie/src/lottie';
@@ -34,10 +34,11 @@ function currentProgress(v: LottieView): number {
 
 /** Stop = pause + reset playhead. iOS `stop()` resets to the start;
  *  Android's `cancelAnimation()` ends the animator and the next
- *  `playAnimation()` restarts from 0. */
+ *  `playAnimation()` restarts from 0. `nativeViewProtected` is typed
+ *  per-platform — `stop` only exists on iOS's CompatibleAnimationView. */
 function stopView(v: LottieView) {
 	if (isAndroid) v.cancelAnimation();
-	else v.nativeViewProtected?.stop();
+	else (v.nativeViewProtected as any)?.stop();
 
 	v.progress = 0;
 }
@@ -52,6 +53,8 @@ export function Lottie(props: LottieProps) @{
 	const appliedSrc = useRef<string | undefined>(undefined);
 	const loadedRef = useRef(false);
 
+	useImperativeHandle(props.ref, () => handle(host.current!), []);
+
 	const bindHost = useCallback((v: LottieView) => {
 		host.current = v;
 	}, []);
@@ -89,7 +92,6 @@ export function Lottie(props: LottieProps) @{
 			if (finished) props.onEnded?.();
 		};
 
-		props.bind?.(handle(v));
 	}, []);
 
 	// src — applied imperatively after the listeners exist.