@shortkitsdk/react-native 0.2.22 → 0.2.24

package/ios/ShortKitSDK.xcframework/ios-arm64_x86_64-simulator/ShortKitSDK.framework/Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface

@@ -337,6 +337,34 @@ extension ShortKitSDK.ShortKitDelegate {
   public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didTapContent contentId: Swift.String, at index: Swift.Int)
   public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didFetchContentItems items: [ShortKitSDK.ContentItem])
 }
+public protocol ShortKitDownloadDelegate : AnyObject {
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didStartDownload item: ShortKitSDK.ContentItem)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didCompleteDownload item: ShortKitSDK.ContentItem, fileURL: Foundation.URL)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didFailDownload item: ShortKitSDK.ContentItem, error: ShortKitSDK.ShortKitDownloadError)
+}
+extension ShortKitSDK.ShortKitDownloadDelegate {
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didStartDownload item: ShortKitSDK.ContentItem)
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double)
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didCompleteDownload item: ShortKitSDK.ContentItem, fileURL: Foundation.URL)
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didFailDownload item: ShortKitSDK.ContentItem, error: ShortKitSDK.ShortKitDownloadError)
+}
+public enum DownloadMode {
+  case nonInterruptive
+  case interruptive
+  public static func == (a: ShortKitSDK.DownloadMode, b: ShortKitSDK.DownloadMode) -> Swift.Bool
+  public func hash(into hasher: inout Swift.Hasher)
+  public var hashValue: Swift.Int {
+    get
+  }
+}
+public enum ShortKitDownloadError : Swift.Error {
+  case downloadNotAvailable
+  case downloadInProgress
+  case networkError(any Swift.Error)
+  case httpError(statusCode: Swift.Int)
+  case cancelled
+}
 @_hasMissingDesignatedInitializers final public class FeedPreload : @unchecked Swift.Sendable {
   @objc deinit
 }
@@ -479,14 +507,21 @@ public struct ContentItem : Swift.Codable, Swift.Equatable, @unchecked Swift.Sen
   public let articleUrl: Swift.String?
   public let commentCount: Swift.Int?
   public var fallbackUrl: Swift.String?
+  public var downloadUrl: Swift.String?
+  public init(id: Swift.String, playbackId: Swift.String? = nil, title: Swift.String, description: Swift.String? = nil, duration: Swift.Double, streamingUrl: Swift.String, thumbnailUrl: Swift.String, captionTracks: [ShortKitSDK.CaptionTrack] = [], customMetadata: [Swift.String : ShortKitSDK.JSONValue]? = nil, author: Swift.String? = nil, articleUrl: Swift.String? = nil, commentCount: Swift.Int? = nil, fallbackUrl: Swift.String? = nil, downloadUrl: Swift.String? = nil)
   public static func == (a: ShortKitSDK.ContentItem, b: ShortKitSDK.ContentItem) -> Swift.Bool
   public func encode(to encoder: any Swift.Encoder) throws
   public init(from decoder: any Swift.Decoder) throws
 }
+extension ShortKitSDK.ContentItem {
+  public var isDownloadable: Swift.Bool {
+    get
+  }
+}
 public enum FeedInput : Swift.Sendable {
   case video(playbackId: Swift.String, fallbackUrl: Swift.String? = nil)
   case imageCarousel(ShortKitSDK.ImageCarouselItem)
-  case videoCarousel(ShortKitSDK.VideoCarouselItem)
+  case videoCarousel(ShortKitSDK.VideoCarouselInput)
 }
 public enum FeedItem : Swift.Sendable {
   case content(ShortKitSDK.ContentItem)
@@ -630,6 +665,19 @@ public struct VTTCue : Swift.Equatable, Swift.Sendable {
   public init(startTime: Swift.Double, endTime: Swift.Double, text: Swift.String)
   public static func == (a: ShortKitSDK.VTTCue, b: ShortKitSDK.VTTCue) -> Swift.Bool
 }
+public struct VideoCarouselInput : Swift.Codable, Swift.Equatable, Swift.Sendable {
+  public let id: Swift.String
+  public let videos: [ShortKitSDK.VideoCarouselVideoInput]
+  public let title: Swift.String?
+  public let description: Swift.String?
+  public let author: Swift.String?
+  public let section: Swift.String?
+  public let articleUrl: Swift.String?
+  public init(id: Swift.String, videos: [ShortKitSDK.VideoCarouselVideoInput], title: Swift.String? = nil, description: Swift.String? = nil, author: Swift.String? = nil, section: Swift.String? = nil, articleUrl: Swift.String? = nil)
+  public static func == (a: ShortKitSDK.VideoCarouselInput, b: ShortKitSDK.VideoCarouselInput) -> Swift.Bool
+  public func encode(to encoder: any Swift.Encoder) throws
+  public init(from decoder: any Swift.Decoder) throws
+}
 public struct VideoCarouselItem : Swift.Codable, Swift.Equatable, Swift.Sendable {
   public let id: Swift.String
   public let videos: [ShortKitSDK.ContentItem]
@@ -643,6 +691,14 @@ public struct VideoCarouselItem : Swift.Codable, Swift.Equatable, Swift.Sendable
   public func encode(to encoder: any Swift.Encoder) throws
   public init(from decoder: any Swift.Decoder) throws
 }
+public struct VideoCarouselVideoInput : Swift.Codable, Swift.Equatable, Swift.Sendable {
+  public let playbackId: Swift.String
+  public let fallbackUrl: Swift.String?
+  public init(playbackId: Swift.String, fallbackUrl: Swift.String? = nil)
+  public static func == (a: ShortKitSDK.VideoCarouselVideoInput, b: ShortKitSDK.VideoCarouselVideoInput) -> Swift.Bool
+  public func encode(to encoder: any Swift.Encoder) throws
+  public init(from decoder: any Swift.Decoder) throws
+}
 public protocol AdOverlay : AnyObject {
   func configure(with content: ShortKitSDK.NativeAdContent)
   func resetState()
@@ -654,6 +710,7 @@ public protocol CarouselOverlay : AnyObject {
   var wantsNativeImagePrefetch: Swift.Bool { get }
   func activatePlayback()
   func updateActiveImage(index: Swift.Int)
+  func resetToFirstImage()
 }
 extension ShortKitSDK.CarouselOverlay {
   public var cachedImage: ((Swift.String) -> UIKit.UIImage?)? {
@@ -665,6 +722,7 @@ extension ShortKitSDK.CarouselOverlay {
   }
   public func activatePlayback()
   public func updateActiveImage(index: Swift.Int)
+  public func resetToFirstImage()
 }
 final public class CellContent : Combine.ObservableObject {
   @Combine.Published<ShortKitSDK.ContentItem?> @_projectedValueProperty($item) final public var item: ShortKitSDK.ContentItem? {
@@ -884,6 +942,7 @@ final public class ShortKit {
   final public let player: ShortKitSDK.ShortKitPlayer
   final public let debugPanelEnabled: Swift.Bool
   weak final public var delegate: (any ShortKitSDK.ShortKitDelegate)?
+  weak final public var downloadDelegate: (any ShortKitSDK.ShortKitDownloadDelegate)?
   final public var loadingViewProvider: (() -> UIKit.UIView)?
   public init(apiKey: Swift.String, userId: Swift.String? = nil, adProvider: (any ShortKitSDK.ShortKitAdProvider)? = nil, clientAppName: Swift.String? = nil, clientAppVersion: Swift.String? = nil, customDimensions: [Swift.String : Swift.String]? = nil, loadingViewProvider: (() -> UIKit.UIView)? = nil, debugPanelEnabled: Swift.Bool = false)
   final public func preloadFeed(filter: ShortKitSDK.FeedFilter? = nil, limit: Swift.Int = 10) -> ShortKitSDK.FeedPreload
@@ -893,6 +952,8 @@ final public class ShortKit {
   final public func clearUserId()
   @_Concurrency.MainActor final public func setColdStartQueue(_ items: [ShortKitSDK.FeedInput])
   final public func clearColdStartCache()
+  final public func downloadVideo(_ item: ShortKitSDK.ContentItem, mode: ShortKitSDK.DownloadMode = .nonInterruptive) async throws -> Foundation.URL
+  final public func cancelDownload()
   @objc deinit
 }
 public enum PlayerClickAction : Swift.Sendable {
@@ -984,6 +1045,8 @@ extension ShortKitSDK.FeedSource : Swift.RawRepresentable {}
 extension ShortKitSDK.SwipeCurve : Swift.Equatable {}
 extension ShortKitSDK.SwipeCurve : Swift.Hashable {}
 extension ShortKitSDK.SwipeCurve : Swift.RawRepresentable {}
+extension ShortKitSDK.DownloadMode : Swift.Equatable {}
+extension ShortKitSDK.DownloadMode : Swift.Hashable {}
 extension ShortKitSDK.ShortKitFeedView : Swift.Sendable {}
 extension ShortKitSDK.CaptionSource : Swift.Equatable {}
 extension ShortKitSDK.CaptionSource : Swift.Hashable {}

package/ios/ShortKitSDK.xcframework/ios-arm64_x86_64-simulator/ShortKitSDK.framework/Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.swiftinterface

@@ -337,6 +337,34 @@ extension ShortKitSDK.ShortKitDelegate {
   public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didTapContent contentId: Swift.String, at index: Swift.Int)
   public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didFetchContentItems items: [ShortKitSDK.ContentItem])
 }
+public protocol ShortKitDownloadDelegate : AnyObject {
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didStartDownload item: ShortKitSDK.ContentItem)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didCompleteDownload item: ShortKitSDK.ContentItem, fileURL: Foundation.URL)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didFailDownload item: ShortKitSDK.ContentItem, error: ShortKitSDK.ShortKitDownloadError)
+}
+extension ShortKitSDK.ShortKitDownloadDelegate {
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didStartDownload item: ShortKitSDK.ContentItem)
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double)
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didCompleteDownload item: ShortKitSDK.ContentItem, fileURL: Foundation.URL)
+  public func shortKit(_ shortKit: ShortKitSDK.ShortKit, didFailDownload item: ShortKitSDK.ContentItem, error: ShortKitSDK.ShortKitDownloadError)
+}
+public enum DownloadMode {
+  case nonInterruptive
+  case interruptive
+  public static func == (a: ShortKitSDK.DownloadMode, b: ShortKitSDK.DownloadMode) -> Swift.Bool
+  public func hash(into hasher: inout Swift.Hasher)
+  public var hashValue: Swift.Int {
+    get
+  }
+}
+public enum ShortKitDownloadError : Swift.Error {
+  case downloadNotAvailable
+  case downloadInProgress
+  case networkError(any Swift.Error)
+  case httpError(statusCode: Swift.Int)
+  case cancelled
+}
 @_hasMissingDesignatedInitializers final public class FeedPreload : @unchecked Swift.Sendable {
   @objc deinit
 }
@@ -479,14 +507,21 @@ public struct ContentItem : Swift.Codable, Swift.Equatable, @unchecked Swift.Sen
   public let articleUrl: Swift.String?
   public let commentCount: Swift.Int?
   public var fallbackUrl: Swift.String?
+  public var downloadUrl: Swift.String?
+  public init(id: Swift.String, playbackId: Swift.String? = nil, title: Swift.String, description: Swift.String? = nil, duration: Swift.Double, streamingUrl: Swift.String, thumbnailUrl: Swift.String, captionTracks: [ShortKitSDK.CaptionTrack] = [], customMetadata: [Swift.String : ShortKitSDK.JSONValue]? = nil, author: Swift.String? = nil, articleUrl: Swift.String? = nil, commentCount: Swift.Int? = nil, fallbackUrl: Swift.String? = nil, downloadUrl: Swift.String? = nil)
   public static func == (a: ShortKitSDK.ContentItem, b: ShortKitSDK.ContentItem) -> Swift.Bool
   public func encode(to encoder: any Swift.Encoder) throws
   public init(from decoder: any Swift.Decoder) throws
 }
+extension ShortKitSDK.ContentItem {
+  public var isDownloadable: Swift.Bool {
+    get
+  }
+}
 public enum FeedInput : Swift.Sendable {
   case video(playbackId: Swift.String, fallbackUrl: Swift.String? = nil)
   case imageCarousel(ShortKitSDK.ImageCarouselItem)
-  case videoCarousel(ShortKitSDK.VideoCarouselItem)
+  case videoCarousel(ShortKitSDK.VideoCarouselInput)
 }
 public enum FeedItem : Swift.Sendable {
   case content(ShortKitSDK.ContentItem)
@@ -630,6 +665,19 @@ public struct VTTCue : Swift.Equatable, Swift.Sendable {
   public init(startTime: Swift.Double, endTime: Swift.Double, text: Swift.String)
   public static func == (a: ShortKitSDK.VTTCue, b: ShortKitSDK.VTTCue) -> Swift.Bool
 }
+public struct VideoCarouselInput : Swift.Codable, Swift.Equatable, Swift.Sendable {
+  public let id: Swift.String
+  public let videos: [ShortKitSDK.VideoCarouselVideoInput]
+  public let title: Swift.String?
+  public let description: Swift.String?
+  public let author: Swift.String?
+  public let section: Swift.String?
+  public let articleUrl: Swift.String?
+  public init(id: Swift.String, videos: [ShortKitSDK.VideoCarouselVideoInput], title: Swift.String? = nil, description: Swift.String? = nil, author: Swift.String? = nil, section: Swift.String? = nil, articleUrl: Swift.String? = nil)
+  public static func == (a: ShortKitSDK.VideoCarouselInput, b: ShortKitSDK.VideoCarouselInput) -> Swift.Bool
+  public func encode(to encoder: any Swift.Encoder) throws
+  public init(from decoder: any Swift.Decoder) throws
+}
 public struct VideoCarouselItem : Swift.Codable, Swift.Equatable, Swift.Sendable {
   public let id: Swift.String
   public let videos: [ShortKitSDK.ContentItem]
@@ -643,6 +691,14 @@ public struct VideoCarouselItem : Swift.Codable, Swift.Equatable, Swift.Sendable
   public func encode(to encoder: any Swift.Encoder) throws
   public init(from decoder: any Swift.Decoder) throws
 }
+public struct VideoCarouselVideoInput : Swift.Codable, Swift.Equatable, Swift.Sendable {
+  public let playbackId: Swift.String
+  public let fallbackUrl: Swift.String?
+  public init(playbackId: Swift.String, fallbackUrl: Swift.String? = nil)
+  public static func == (a: ShortKitSDK.VideoCarouselVideoInput, b: ShortKitSDK.VideoCarouselVideoInput) -> Swift.Bool
+  public func encode(to encoder: any Swift.Encoder) throws
+  public init(from decoder: any Swift.Decoder) throws
+}
 public protocol AdOverlay : AnyObject {
   func configure(with content: ShortKitSDK.NativeAdContent)
   func resetState()
@@ -654,6 +710,7 @@ public protocol CarouselOverlay : AnyObject {
   var wantsNativeImagePrefetch: Swift.Bool { get }
   func activatePlayback()
   func updateActiveImage(index: Swift.Int)
+  func resetToFirstImage()
 }
 extension ShortKitSDK.CarouselOverlay {
   public var cachedImage: ((Swift.String) -> UIKit.UIImage?)? {
@@ -665,6 +722,7 @@ extension ShortKitSDK.CarouselOverlay {
   }
   public func activatePlayback()
   public func updateActiveImage(index: Swift.Int)
+  public func resetToFirstImage()
 }
 final public class CellContent : Combine.ObservableObject {
   @Combine.Published<ShortKitSDK.ContentItem?> @_projectedValueProperty($item) final public var item: ShortKitSDK.ContentItem? {
@@ -884,6 +942,7 @@ final public class ShortKit {
   final public let player: ShortKitSDK.ShortKitPlayer
   final public let debugPanelEnabled: Swift.Bool
   weak final public var delegate: (any ShortKitSDK.ShortKitDelegate)?
+  weak final public var downloadDelegate: (any ShortKitSDK.ShortKitDownloadDelegate)?
   final public var loadingViewProvider: (() -> UIKit.UIView)?
   public init(apiKey: Swift.String, userId: Swift.String? = nil, adProvider: (any ShortKitSDK.ShortKitAdProvider)? = nil, clientAppName: Swift.String? = nil, clientAppVersion: Swift.String? = nil, customDimensions: [Swift.String : Swift.String]? = nil, loadingViewProvider: (() -> UIKit.UIView)? = nil, debugPanelEnabled: Swift.Bool = false)
   final public func preloadFeed(filter: ShortKitSDK.FeedFilter? = nil, limit: Swift.Int = 10) -> ShortKitSDK.FeedPreload
@@ -893,6 +952,8 @@ final public class ShortKit {
   final public func clearUserId()
   @_Concurrency.MainActor final public func setColdStartQueue(_ items: [ShortKitSDK.FeedInput])
   final public func clearColdStartCache()
+  final public func downloadVideo(_ item: ShortKitSDK.ContentItem, mode: ShortKitSDK.DownloadMode = .nonInterruptive) async throws -> Foundation.URL
+  final public func cancelDownload()
   @objc deinit
 }
 public enum PlayerClickAction : Swift.Sendable {
@@ -984,6 +1045,8 @@ extension ShortKitSDK.FeedSource : Swift.RawRepresentable {}
 extension ShortKitSDK.SwipeCurve : Swift.Equatable {}
 extension ShortKitSDK.SwipeCurve : Swift.Hashable {}
 extension ShortKitSDK.SwipeCurve : Swift.RawRepresentable {}
+extension ShortKitSDK.DownloadMode : Swift.Equatable {}
+extension ShortKitSDK.DownloadMode : Swift.Hashable {}
 extension ShortKitSDK.ShortKitFeedView : Swift.Sendable {}
 extension ShortKitSDK.CaptionSource : Swift.Equatable {}
 extension ShortKitSDK.CaptionSource : Swift.Hashable {}