@shortkitsdk/react-native 0.2.31 → 0.2.32

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

@@ -5,6 +5,9 @@
 import AVFoundation
 import Combine
 import CoreGraphics
+import CoreImage
+import CoreMedia
+import CoreVideo
 import Foundation
 import Network
 import QuartzCore
@@ -459,17 +462,29 @@ 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 enum DownloadPhase : Swift.String, Swift.Sendable {
+  case downloading
+  case compositing
+  case finalizing
+  public init?(rawValue: Swift.String)
+  public typealias RawValue = Swift.String
+  public var rawValue: Swift.String {
+    get
+  }
+}
 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)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double, phase: ShortKitSDK.DownloadPhase)
 }
 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 func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double, phase: ShortKitSDK.DownloadPhase)
 }
 public enum DownloadMode {
   case nonInterruptive
@@ -480,12 +495,26 @@ public enum DownloadMode {
     get
   }
 }
-public enum ShortKitDownloadError : Swift.Error {
+public enum DownloadOverlayMode {
+  case none
+  case staticSnapshot(source: any UIKit.UIView & ShortKitSDK.FeedOverlay)
+}
+public protocol ExportableFeedOverlay : AnyObject {
+  func prepareForExport(duration: Foundation.TimeInterval, size: CoreFoundation.CGSize) async
+  func snapshotAtTime(_ time: Foundation.TimeInterval) async -> UIKit.UIImage?
+  func tearDownAfterExport()
+}
+public enum ShortKitDownloadError : Swift.Error, Foundation.LocalizedError {
   case downloadNotAvailable
   case downloadInProgress
   case networkError(any Swift.Error)
   case httpError(statusCode: Swift.Int)
   case cancelled
+  case exportFailed(underlying: any Swift.Error)
+  case overlayNotVisibleForSnapshot
+  public var errorDescription: Swift.String? {
+    get
+  }
 }
 @_hasMissingDesignatedInitializers final public class FeedPreload : @unchecked Swift.Sendable {
   public init(immediateItems items: [ShortKitSDK.FeedInput])
@@ -553,6 +582,7 @@ public enum ShortKitFeedLifecycle {
     @objc get
   }
   @_Concurrency.MainActor @preconcurrency @objc override dynamic public func motionEnded(_ motion: UIKit.UIEvent.EventSubtype, with event: UIKit.UIEvent?)
+  @_Concurrency.MainActor @preconcurrency public func overlayView(forItemId itemId: Swift.String) -> (any UIKit.UIView & ShortKitSDK.FeedOverlay)?
 }
 extension ShortKitSDK.ShortKitFeedViewController : UIKit.UICollectionViewDelegate {
   @_Concurrency.MainActor @preconcurrency @objc dynamic public func collectionView(_ collectionView: UIKit.UICollectionView, willDisplay cell: UIKit.UICollectionViewCell, forItemAt indexPath: Foundation.IndexPath)
@@ -1171,7 +1201,7 @@ 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 downloadVideo(_ item: ShortKitSDK.ContentItem, mode: ShortKitSDK.DownloadMode = .nonInterruptive, overlayMode: ShortKitSDK.DownloadOverlayMode = .none) async throws -> Foundation.URL
   final public func cancelDownload()
   @objc deinit
 }
@@ -1274,6 +1304,9 @@ extension ShortKitSDK.DebugTimeControl : Swift.Hashable {}
 extension ShortKitSDK.SwipeCurve : Swift.Equatable {}
 extension ShortKitSDK.SwipeCurve : Swift.Hashable {}
 extension ShortKitSDK.SwipeCurve : Swift.RawRepresentable {}
+extension ShortKitSDK.DownloadPhase : Swift.Equatable {}
+extension ShortKitSDK.DownloadPhase : Swift.Hashable {}
+extension ShortKitSDK.DownloadPhase : Swift.RawRepresentable {}
 extension ShortKitSDK.DownloadMode : Swift.Equatable {}
 extension ShortKitSDK.DownloadMode : Swift.Hashable {}
 extension ShortKitSDK.ShortKitFeedView : Swift.Sendable {}

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

@@ -5,6 +5,9 @@
 import AVFoundation
 import Combine
 import CoreGraphics
+import CoreImage
+import CoreMedia
+import CoreVideo
 import Foundation
 import Network
 import QuartzCore
@@ -459,17 +462,29 @@ 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 enum DownloadPhase : Swift.String, Swift.Sendable {
+  case downloading
+  case compositing
+  case finalizing
+  public init?(rawValue: Swift.String)
+  public typealias RawValue = Swift.String
+  public var rawValue: Swift.String {
+    get
+  }
+}
 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)
+  func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double, phase: ShortKitSDK.DownloadPhase)
 }
 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 func shortKit(_ shortKit: ShortKitSDK.ShortKit, didUpdateDownloadProgress item: ShortKitSDK.ContentItem, progress: Swift.Double, phase: ShortKitSDK.DownloadPhase)
 }
 public enum DownloadMode {
   case nonInterruptive
@@ -480,12 +495,26 @@ public enum DownloadMode {
     get
   }
 }
-public enum ShortKitDownloadError : Swift.Error {
+public enum DownloadOverlayMode {
+  case none
+  case staticSnapshot(source: any UIKit.UIView & ShortKitSDK.FeedOverlay)
+}
+public protocol ExportableFeedOverlay : AnyObject {
+  func prepareForExport(duration: Foundation.TimeInterval, size: CoreFoundation.CGSize) async
+  func snapshotAtTime(_ time: Foundation.TimeInterval) async -> UIKit.UIImage?
+  func tearDownAfterExport()
+}
+public enum ShortKitDownloadError : Swift.Error, Foundation.LocalizedError {
   case downloadNotAvailable
   case downloadInProgress
   case networkError(any Swift.Error)
   case httpError(statusCode: Swift.Int)
   case cancelled
+  case exportFailed(underlying: any Swift.Error)
+  case overlayNotVisibleForSnapshot
+  public var errorDescription: Swift.String? {
+    get
+  }
 }
 @_hasMissingDesignatedInitializers final public class FeedPreload : @unchecked Swift.Sendable {
   public init(immediateItems items: [ShortKitSDK.FeedInput])
@@ -553,6 +582,7 @@ public enum ShortKitFeedLifecycle {
     @objc get
   }
   @_Concurrency.MainActor @preconcurrency @objc override dynamic public func motionEnded(_ motion: UIKit.UIEvent.EventSubtype, with event: UIKit.UIEvent?)
+  @_Concurrency.MainActor @preconcurrency public func overlayView(forItemId itemId: Swift.String) -> (any UIKit.UIView & ShortKitSDK.FeedOverlay)?
 }
 extension ShortKitSDK.ShortKitFeedViewController : UIKit.UICollectionViewDelegate {
   @_Concurrency.MainActor @preconcurrency @objc dynamic public func collectionView(_ collectionView: UIKit.UICollectionView, willDisplay cell: UIKit.UICollectionViewCell, forItemAt indexPath: Foundation.IndexPath)
@@ -1171,7 +1201,7 @@ 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 downloadVideo(_ item: ShortKitSDK.ContentItem, mode: ShortKitSDK.DownloadMode = .nonInterruptive, overlayMode: ShortKitSDK.DownloadOverlayMode = .none) async throws -> Foundation.URL
   final public func cancelDownload()
   @objc deinit
 }
@@ -1274,6 +1304,9 @@ extension ShortKitSDK.DebugTimeControl : Swift.Hashable {}
 extension ShortKitSDK.SwipeCurve : Swift.Equatable {}
 extension ShortKitSDK.SwipeCurve : Swift.Hashable {}
 extension ShortKitSDK.SwipeCurve : Swift.RawRepresentable {}
+extension ShortKitSDK.DownloadPhase : Swift.Equatable {}
+extension ShortKitSDK.DownloadPhase : Swift.Hashable {}
+extension ShortKitSDK.DownloadPhase : Swift.RawRepresentable {}
 extension ShortKitSDK.DownloadMode : Swift.Equatable {}
 extension ShortKitSDK.DownloadMode : Swift.Hashable {}
 extension ShortKitSDK.ShortKitFeedView : Swift.Sendable {}

package/ios/ShortKitSDK.xcframework/ios-arm64_x86_64-simulator/ShortKitSDK.framework/_CodeSignature/CodeResources

@@ -10,39 +10,39 @@
 		</data>
 		<key>Info.plist</key>
 		<data>
-		PYkIcNDUEgyhTyEpFbDaCBPo+UE=
+		c83UUfp8vl8OKNZgemM5Ckeupdw=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.abi.json</key>
 		<data>
-		UaBdqrMhIeApH2d1RUSHIj0Zhu8=
+		YIhDAI7GfkS3Bw8cCovcAQ/5bkc=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface</key>
 		<data>
-		8YGTcgWDbl8y4dDSIpll5eJ4obE=
+		jVb2+supqwkO14hFF9JSxbmcFUI=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.swiftdoc</key>
 		<data>
-		lzX6ESVjVhhWPe6DxnX73NDmZxw=
+		FQPcCHhpOilSUl89AxPXIKCLN/E=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.swiftinterface</key>
 		<data>
-		8YGTcgWDbl8y4dDSIpll5eJ4obE=
+		jVb2+supqwkO14hFF9JSxbmcFUI=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.abi.json</key>
 		<data>
-		UaBdqrMhIeApH2d1RUSHIj0Zhu8=
+		YIhDAI7GfkS3Bw8cCovcAQ/5bkc=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface</key>
 		<data>
-		H7HRD+aObjI7xoUhzCeaCSiqjmk=
+		lr+Br5j/UDEGV7GBxg48gH/rncc=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.swiftdoc</key>
 		<data>
-		ggGgO2zWeWv56r6SC+RCZNJLMTE=
+		rTbauAd6wfGmUohCAGP+wwgmsNc=
 		</data>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.swiftinterface</key>
 		<data>
-		H7HRD+aObjI7xoUhzCeaCSiqjmk=
+		lr+Br5j/UDEGV7GBxg48gH/rncc=
 		</data>
 		<key>Modules/module.modulemap</key>
 		<data>
@@ -66,56 +66,56 @@
 		<dict>
 			<key>hash2</key>
 			<data>
-			1d0XBLVpugO7SBVSLPAAz9em40Jjg3uSJDz2K7kZLt4=
+			v/uw62M6gyB+9mO/YoZTKs+xDZr5p0ehAwX9vFBOrA0=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			3D6bnZQIYaJD/ZJLQcVC4KUbwNgvDl/iiBHyIFmY1u8=
+			rxdNx/TSUVd/Pd8Fok5Kgwj/fUtUaq0HgqKC4JVJUx0=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.swiftdoc</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			CFHa4/rm1ZPInefpRBxbmuzlobIbnb847Q0i2xy1q9A=
+			khqs3UMVZ5tpEkBvJa5S2d3uTs80aVX+io6b4/TDNPE=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/arm64-apple-ios-simulator.swiftinterface</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			3D6bnZQIYaJD/ZJLQcVC4KUbwNgvDl/iiBHyIFmY1u8=
+			rxdNx/TSUVd/Pd8Fok5Kgwj/fUtUaq0HgqKC4JVJUx0=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.abi.json</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			1d0XBLVpugO7SBVSLPAAz9em40Jjg3uSJDz2K7kZLt4=
+			v/uw62M6gyB+9mO/YoZTKs+xDZr5p0ehAwX9vFBOrA0=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			+RR1yKVxk7eM89sQaZV/Ks3KftiCvYiEXqvAWayvf/s=
+			o9sGqAin0CW2u4q6wc85avBuxWQyEOnzzDME35fQ3ZY=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.swiftdoc</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			ppdE9CD5J+SnQP9npRDKhbCFuonZyTCN1TcUzRTdPfg=
+			HACqT0qILr02nDrz4hMSwIx1+67UnBeq1ote6RrUXWs=
 			</data>
 		</dict>
 		<key>Modules/ShortKitSDK.swiftmodule/x86_64-apple-ios-simulator.swiftinterface</key>
 		<dict>
 			<key>hash2</key>
 			<data>
-			+RR1yKVxk7eM89sQaZV/Ks3KftiCvYiEXqvAWayvf/s=
+			o9sGqAin0CW2u4q6wc85avBuxWQyEOnzzDME35fQ3ZY=
 			</data>
 		</dict>
 		<key>Modules/module.modulemap</key>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shortkitsdk/react-native",
-  "version": "0.2.31",
+  "version": "0.2.32",
   "description": "ShortKit React Native SDK — short-form video feed",
   "react-native": "src/index",
   "source": "src/index",

package/src/ShortKitCommands.ts

@@ -32,7 +32,17 @@ export const ShortKitCommands = {
     NativeShortKitModule?.prefetchStoryboard(playbackId),
   getStoryboardData: (playbackId: string): Promise<string | null> =>
     NativeShortKitModule?.getStoryboardData(playbackId) ?? Promise.resolve(null),
-  downloadVideo: (itemId: string, mode: 'nonInterruptive' | 'interruptive' = 'nonInterruptive'): Promise<string> =>
-    NativeShortKitModule?.downloadVideo(itemId, mode) ?? Promise.reject(new Error('ShortKit not initialized')),
+  downloadVideo: (
+    itemId: string,
+    options?: {
+      mode?: 'interruptive' | 'nonInterruptive';
+      overlayMode?: 'none' | 'static' | 'deterministic';
+    }
+  ): Promise<string> => {
+    const mode = options?.mode ?? 'nonInterruptive';
+    const overlayMode = options?.overlayMode ?? 'none';
+    return NativeShortKitModule?.downloadVideo(itemId, mode, overlayMode)
+      ?? Promise.reject(new Error('ShortKit not initialized'));
+  },
   cancelDownload: () => NativeShortKitModule?.cancelDownload(),
 } as const;

package/src/ShortKitContext.ts

@@ -55,7 +55,13 @@ export interface ShortKitContextValue {
 
   // Download
   downloadState: DownloadState;
-  downloadVideo: (itemId: string, mode?: 'nonInterruptive' | 'interruptive') => Promise<string>;
+  downloadVideo: (
+    itemId: string,
+    options?: {
+      mode?: 'interruptive' | 'nonInterruptive';
+      overlayMode?: 'none' | 'static' | 'deterministic';
+    }
+  ) => Promise<string>;
   cancelDownload: () => void;
 }
 

package/src/specs/NativeShortKitModule.ts

@@ -140,6 +140,7 @@ type DownloadStartedEvent = Readonly<{
 type DownloadProgressEvent = Readonly<{
   itemId: string;
   progress: number;
+  phase: 'downloading' | 'compositing' | 'finalizing';
 }>;
 
 type DownloadCompletedEvent = Readonly<{
@@ -306,7 +307,7 @@ export interface Spec extends TurboModule {
   getStoryboardData(playbackId: string): Promise<string>;
 
   // --- Download ---
-  downloadVideo(itemId: string, mode: string): Promise<string>;
+  downloadVideo(itemId: string, mode: string, overlayMode: string): Promise<string>;
   cancelDownload(): void;
 
   // --- Carousel accessors ---

package/src/types.ts

@@ -73,6 +73,10 @@ export interface ContentItem {
 
 export type DownloadStatus = 'idle' | 'downloading' | 'completed' | 'failed';
 
+export type DownloadOverlayMode = 'none' | 'static' | 'deterministic';
+
+export type DownloadPhase = 'downloading' | 'compositing' | 'finalizing';
+
 export interface DownloadState {
   status: DownloadStatus;
   /** ID of the content item being downloaded, if any. */