capacitor-lottie-splash 0.1.2 → 0.1.3

package/README.md

@@ -101,9 +101,9 @@ The documented HeadCount defaults are light `#f0f0f0 → #f5f5f5` and dark `#1e1
 
 ## Recovery and accessibility
 
-When playback completes before readiness, its final frame holds. After one second, a subtle indeterminate progress rail appears beneath the mark. After 15 foreground seconds the rail stops and a native/browser recovery surface presents “Still starting…” and “Try again.” The native retry reloads the WebView, so it does not depend on JavaScript having already loaded. Reduced-motion and asset failures retain the theme-matched native cover instead of exposing a blank screen.
+When playback completes before readiness, its final frame holds. After one second, a subtle indeterminate progress rail appears beneath the mark and remains visible until the application is ready. Reduced-motion and asset failures retain the theme-matched native cover instead of exposing a blank screen.
 
-For a staged native/over-the-air rollout, the consuming app must keep its web bundle and native host compatible. The native cover stays visible until the app-ready latch is set; a broken boot transitions to the visible recovery surface instead of exposing a blank page.
+For a staged native/over-the-air rollout, the consuming app must keep its web bundle and native host compatible. The native cover stays visible until the app-ready latch is set.
 
 ## Compatibility
 

package/android/src/main/java/com/headcount/plugins/lottiesplash/LottieSplashCoordinator.kt

@@ -12,10 +12,7 @@ import android.view.View
 import android.view.ViewGroup
 import android.view.animation.AccelerateDecelerateInterpolator
 import android.view.animation.LinearInterpolator
-import android.widget.Button
 import android.widget.FrameLayout
-import android.widget.LinearLayout
-import android.widget.TextView
 import com.airbnb.lottie.LottieAnimationView
 import com.airbnb.lottie.LottieCompositionFactory
 import androidx.activity.ComponentActivity
@@ -23,7 +20,7 @@ import java.util.UUID
 import kotlin.math.max
 import kotlin.math.roundToInt
 
-enum class AndroidSplashPhase { PREPARING, PLAYING, HOLDING, HIDING, HIDDEN, RECOVERY }
+enum class AndroidSplashPhase { PREPARING, PLAYING, HOLDING, HIDING, HIDDEN }
 enum class AndroidSplashPlayback { PLAY, HOLD_FINAL_FRAME }
 
 /** A small indeterminate rail that reads as loading without covering the finished logo. */
@@ -82,7 +79,6 @@ object LottieSplashCoordinator {
     // incorrectly dismissing a healthy native cover during that startup work.
     private const val WEB_ADOPTION_GRACE_MS = 30_000L
     private const val PROGRESS_DELAY_MS = 1_000L
-    private const val RECOVERY_DELAY_MS = 15_000L
     private const val COVER_FADE_OUT_MS = 500L
     private val main = Handler(Looper.getMainLooper())
 
@@ -94,8 +90,6 @@ object LottieSplashCoordinator {
     private var compositionReady = false
     private var requestedPlayback = AndroidSplashPlayback.PLAY
     private var loadingRail: LottieSplashLoadingRail? = null
-    private var recoveryMessage: TextView? = null
-    private var recoveryRetry: Button? = null
     private var presentationId: String? = null
     private var phase = AndroidSplashPhase.HIDDEN
     private var playbackSettled = false
@@ -106,16 +100,13 @@ object LottieSplashCoordinator {
     private var completion: ((String, String?) -> Unit)? = null
     private var pendingHide: ((Throwable?) -> Unit)? = null
     private var progressTask: Runnable? = null
-    private var recoveryTask: Runnable? = null
     private var adoptionTask: Runnable? = null
     private var adoptedByWeb = false
     private var progressRemainingMs = PROGRESS_DELAY_MS
-    private var recoveryRemainingMs = RECOVERY_DELAY_MS
     private var waitingClockStartedAtMs = 0L
     private var waitingClockRunning = false
 
     var onStateChange: (() -> Unit)? = null
-    var onRecoveryRequested: (() -> Unit)? = null
 
     /**
      * Called by AndroidX while deciding whether its system-owned launch surface may leave.
@@ -153,8 +144,6 @@ object LottieSplashCoordinator {
         playbackOutcome = "static-fallback"
         playbackReason = null
         loadingRail = null
-        recoveryMessage = null
-        recoveryRetry = null
 
         val backgroundStart = if (darkTheme) Color.rgb(30, 30, 30) else Color.rgb(240, 240, 240)
         root.setBackgroundColor(backgroundStart)
@@ -354,7 +343,6 @@ object LottieSplashCoordinator {
     private fun resetWaitingUi(id: String) {
         cancelWaitingTasks()
         progressRemainingMs = PROGRESS_DELAY_MS
-        recoveryRemainingMs = RECOVERY_DELAY_MS
         scheduleWaitingUi(id)
     }
 
@@ -371,24 +359,19 @@ object LottieSplashCoordinator {
         waitingClockRunning = true
         waitingClockStartedAtMs = SystemClock.elapsedRealtime()
         progressTask = Runnable { showLoadingRail(id) }
-        recoveryTask = Runnable { showRecovery(id) }
         if (loadingRail == null) main.postDelayed(progressTask!!, progressRemainingMs)
-        main.postDelayed(recoveryTask!!, recoveryRemainingMs)
     }
 
     private fun pauseWaitingClock() {
         if (!waitingClockRunning) return
         val elapsed = SystemClock.elapsedRealtime() - waitingClockStartedAtMs
         progressRemainingMs = max(0, progressRemainingMs - elapsed)
-        recoveryRemainingMs = max(0, recoveryRemainingMs - elapsed)
         cancelWaitingTasks()
     }
 
     private fun cancelWaitingTasks() {
         progressTask?.let(main::removeCallbacks)
-        recoveryTask?.let(main::removeCallbacks)
         progressTask = null
-        recoveryTask = null
         waitingClockRunning = false
     }
 
@@ -404,36 +387,10 @@ object LottieSplashCoordinator {
         }
     }
 
-    private fun showRecovery(id: String) {
-        recoveryRemainingMs = 0
-        if (presentationId != id || appReady || phase != AndroidSplashPhase.HOLDING) return
-        cancelWaitingTasks()
-        phase = AndroidSplashPhase.RECOVERY
-        loadingRail?.visibility = View.GONE
-        val context = cover?.context ?: return
-        val textColor = if (darkTheme) Color.WHITE else Color.rgb(30, 30, 30)
-        val message = TextView(context).apply { text = "Still starting…"; textSize = 16f; setTextColor(textColor); gravity = Gravity.CENTER }
-        val retry = Button(context).apply { text = "Try again"; setOnClickListener { onRecoveryRequested?.invoke() } }
-        val recoveryGroup = LinearLayout(context).apply {
-            orientation = LinearLayout.VERTICAL
-            gravity = Gravity.CENTER_HORIZONTAL
-            addView(message)
-            addView(retry)
-        }
-        recoveryMessage = message
-        recoveryRetry = retry
-        cover?.addView(recoveryGroup, FrameLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT, Gravity.CENTER_HORIZONTAL or Gravity.BOTTOM).apply { bottomMargin = dp(recoveryGroup, 48) })
-        recoveryGroup.announceForAccessibility("Still starting. Try again is available.")
-        emit()
-    }
-
     private fun clearWaitingUi() {
         cancelWaitingTasks()
         loadingRail?.let { cover?.removeView(it) }
-        recoveryMessage?.parent?.let { parent -> (parent as? ViewGroup)?.let { cover?.removeView(it) } }
         loadingRail = null
-        recoveryMessage = null
-        recoveryRetry = null
     }
 
     private fun dismiss(callback: (Throwable?) -> Unit) {
@@ -464,8 +421,6 @@ object LottieSplashCoordinator {
             animation = null
             hostActivity = null
             loadingRail = null
-            recoveryMessage = null
-            recoveryRetry = null
             presentationId = null
             phase = AndroidSplashPhase.HIDDEN
             compositionReady = false

package/android/src/main/java/com/headcount/plugins/lottiesplash/LottieSplashPlugin.kt

@@ -20,7 +20,6 @@ class LottieSplashPlugin : Plugin() {
     }
     override fun load() {
         LottieSplashCoordinator.onStateChange = { notifyListeners("stateChange", stateObject()) }
-        LottieSplashCoordinator.onRecoveryRequested = { bridge?.webView?.reload() }
     }
 
     @PluginMethod
@@ -89,7 +88,7 @@ class LottieSplashPlugin : Plugin() {
                 webView.postVisualStateCallback(SystemClock.uptimeMillis(), object : WebView.VisualStateCallback() {
                     override fun onComplete(requestId: Long) = finishHandoff()
                 })
-                // A stalled GPU/compositor must not leave an app-ready screen in recovery.
+                // A stalled GPU/compositor must not leave an app-ready screen covered.
                 main.postDelayed(fallback, VISUAL_STATE_TIMEOUT_MS)
             } catch (_: Throwable) {
                 finishHandoff()

package/dist/esm/definitions.d.ts

@@ -1,6 +1,6 @@
 import type { PluginListenerHandle } from '@capacitor/core';
 export type SplashRenderer = 'ios' | 'android' | 'web';
-export type SplashPhase = 'preparing' | 'playing' | 'holding' | 'hiding' | 'hidden' | 'recovery';
+export type SplashPhase = 'preparing' | 'playing' | 'holding' | 'hiding' | 'hidden';
 export type PlaybackOutcome = 'completed' | 'reduced-motion' | 'static-fallback';
 export type SplashTheme = 'light' | 'dark';
 export interface SplashAssets {

package/dist/esm/state-machine.d.ts

@@ -10,7 +10,6 @@ export declare class SplashStateMachine {
     playing(presentationId: string): StateMachineSnapshot;
     settlePlayback(presentationId: string, outcome: PlaybackOutcome, reason?: string): StateMachineSnapshot;
     requestHide(presentationId: string): StateMachineSnapshot;
-    recovery(presentationId: string): StateMachineSnapshot;
     hidden(presentationId: string): StateMachineSnapshot;
     getPlaybackResult(presentationId: string): PlaybackResult | undefined;
     current(): StateMachineSnapshot;

package/dist/esm/state-machine.js

@@ -45,12 +45,6 @@ export class SplashStateMachine {
             this.snapshot.phase = 'hiding';
         return this.current();
     }
-    recovery(presentationId) {
-        this.requireCurrent(presentationId);
-        if (!this.snapshot.appReady)
-            this.snapshot.phase = 'recovery';
-        return this.current();
-    }
     hidden(presentationId) {
         this.requireCurrent(presentationId);
         this.snapshot = {

package/dist/esm/web.d.ts

@@ -6,7 +6,6 @@ export declare class LottieSplashWeb extends WebPlugin implements LottieSplashPl
     private resolvePlayback?;
     private overlay?;
     private progressTimer?;
-    private recoveryTimer?;
     show(options: SplashShowOptions): Promise<Presentation>;
     setLaunchTheme(_options: SplashLaunchThemeOptions): Promise<void>;
     waitForCompletion(options: {
@@ -21,7 +20,6 @@ export declare class LottieSplashWeb extends WebPlugin implements LottieSplashPl
     private playComposition;
     private settle;
     private showLoadingRail;
-    private showRecovery;
     private removeOverlay;
     private ensureCurrent;
     private emitState;

package/dist/esm/web.js

@@ -1,6 +1,5 @@
 import { WebPlugin } from '@capacitor/core';
 import { SplashStateMachine } from './state-machine';
-const RECOVERY_TIMEOUT_MS = 15_000;
 const PROGRESS_DELAY_MS = 1_000;
 export class LottieSplashWeb extends WebPlugin {
     stateMachine = new SplashStateMachine();
@@ -8,7 +7,6 @@ export class LottieSplashWeb extends WebPlugin {
     resolvePlayback;
     overlay;
     progressTimer;
-    recoveryTimer;
     async show(options) {
         const state = this.stateMachine.current();
         if (state.visible && state.presentationId)
@@ -104,7 +102,6 @@ export class LottieSplashWeb extends WebPlugin {
             this.emitState();
             if (!state.appReady) {
                 this.progressTimer = window.setTimeout(() => this.showLoadingRail(presentationId), PROGRESS_DELAY_MS);
-                this.recoveryTimer = window.setTimeout(() => this.showRecovery(presentationId), RECOVERY_TIMEOUT_MS);
             }
         }
         catch {
@@ -127,31 +124,8 @@ export class LottieSplashWeb extends WebPlugin {
         rail.append(segment);
         this.overlay?.append(style, rail);
     }
-    showRecovery(presentationId) {
-        let state;
-        try {
-            state = this.stateMachine.recovery(presentationId);
-        }
-        catch {
-            return;
-        }
-        if (state.presentationId !== presentationId || state.appReady)
-            return;
-        this.overlay?.querySelector('[data-splash-loading-rail]')?.remove();
-        const recovery = document.createElement('div');
-        recovery.style.cssText = 'position:absolute;bottom:12%;display:grid;gap:12px;place-items:center;color:inherit;font:500 16px system-ui;';
-        recovery.textContent = 'Still starting…';
-        const retry = document.createElement('button');
-        retry.type = 'button';
-        retry.textContent = 'Try again';
-        retry.onclick = () => window.location.reload();
-        recovery.append(retry);
-        this.overlay?.append(recovery);
-        this.emitState();
-    }
     removeOverlay(presentationId) {
         window.clearTimeout(this.progressTimer);
-        window.clearTimeout(this.recoveryTimer);
         this.overlay?.remove();
         this.overlay = undefined;
         this.stateMachine.hidden(presentationId);

package/dist/plugin.cjs.js

@@ -53,12 +53,6 @@ class SplashStateMachine {
             this.snapshot.phase = 'hiding';
         return this.current();
     }
-    recovery(presentationId) {
-        this.requireCurrent(presentationId);
-        if (!this.snapshot.appReady)
-            this.snapshot.phase = 'recovery';
-        return this.current();
-    }
     hidden(presentationId) {
         this.requireCurrent(presentationId);
         this.snapshot = {
@@ -85,7 +79,6 @@ class SplashStateMachine {
     }
 }
 
-const RECOVERY_TIMEOUT_MS = 15_000;
 const PROGRESS_DELAY_MS = 1_000;
 class LottieSplashWeb extends core.WebPlugin {
     stateMachine = new SplashStateMachine();
@@ -93,7 +86,6 @@ class LottieSplashWeb extends core.WebPlugin {
     resolvePlayback;
     overlay;
     progressTimer;
-    recoveryTimer;
     async show(options) {
         const state = this.stateMachine.current();
         if (state.visible && state.presentationId)
@@ -189,7 +181,6 @@ class LottieSplashWeb extends core.WebPlugin {
             this.emitState();
             if (!state.appReady) {
                 this.progressTimer = window.setTimeout(() => this.showLoadingRail(presentationId), PROGRESS_DELAY_MS);
-                this.recoveryTimer = window.setTimeout(() => this.showRecovery(presentationId), RECOVERY_TIMEOUT_MS);
             }
         }
         catch {
@@ -212,31 +203,8 @@ class LottieSplashWeb extends core.WebPlugin {
         rail.append(segment);
         this.overlay?.append(style, rail);
     }
-    showRecovery(presentationId) {
-        let state;
-        try {
-            state = this.stateMachine.recovery(presentationId);
-        }
-        catch {
-            return;
-        }
-        if (state.presentationId !== presentationId || state.appReady)
-            return;
-        this.overlay?.querySelector('[data-splash-loading-rail]')?.remove();
-        const recovery = document.createElement('div');
-        recovery.style.cssText = 'position:absolute;bottom:12%;display:grid;gap:12px;place-items:center;color:inherit;font:500 16px system-ui;';
-        recovery.textContent = 'Still starting…';
-        const retry = document.createElement('button');
-        retry.type = 'button';
-        retry.textContent = 'Try again';
-        retry.onclick = () => window.location.reload();
-        recovery.append(retry);
-        this.overlay?.append(recovery);
-        this.emitState();
-    }
     removeOverlay(presentationId) {
         window.clearTimeout(this.progressTimer);
-        window.clearTimeout(this.recoveryTimer);
         this.overlay?.remove();
         this.overlay = undefined;
         this.stateMachine.hidden(presentationId);

package/dist/plugin.js

@@ -67,12 +67,6 @@ var capacitorLottieSplash = (function (exports, core) {
                 this.snapshot.phase = 'hiding';
             return this.current();
         }
-        recovery(presentationId) {
-            this.requireCurrent(presentationId);
-            if (!this.snapshot.appReady)
-                this.snapshot.phase = 'recovery';
-            return this.current();
-        }
         hidden(presentationId) {
             this.requireCurrent(presentationId);
             this.snapshot = {
@@ -99,7 +93,6 @@ var capacitorLottieSplash = (function (exports, core) {
         }
     }
 
-    const RECOVERY_TIMEOUT_MS = 15_000;
     const PROGRESS_DELAY_MS = 1_000;
     class LottieSplashWeb extends core.WebPlugin {
         stateMachine = new SplashStateMachine();
@@ -107,7 +100,6 @@ var capacitorLottieSplash = (function (exports, core) {
         resolvePlayback;
         overlay;
         progressTimer;
-        recoveryTimer;
         async show(options) {
             const state = this.stateMachine.current();
             if (state.visible && state.presentationId)
@@ -203,7 +195,6 @@ var capacitorLottieSplash = (function (exports, core) {
                 this.emitState();
                 if (!state.appReady) {
                     this.progressTimer = window.setTimeout(() => this.showLoadingRail(presentationId), PROGRESS_DELAY_MS);
-                    this.recoveryTimer = window.setTimeout(() => this.showRecovery(presentationId), RECOVERY_TIMEOUT_MS);
                 }
             }
             catch {
@@ -226,31 +217,8 @@ var capacitorLottieSplash = (function (exports, core) {
             rail.append(segment);
             this.overlay?.append(style, rail);
         }
-        showRecovery(presentationId) {
-            let state;
-            try {
-                state = this.stateMachine.recovery(presentationId);
-            }
-            catch {
-                return;
-            }
-            if (state.presentationId !== presentationId || state.appReady)
-                return;
-            this.overlay?.querySelector('[data-splash-loading-rail]')?.remove();
-            const recovery = document.createElement('div');
-            recovery.style.cssText = 'position:absolute;bottom:12%;display:grid;gap:12px;place-items:center;color:inherit;font:500 16px system-ui;';
-            recovery.textContent = 'Still starting…';
-            const retry = document.createElement('button');
-            retry.type = 'button';
-            retry.textContent = 'Try again';
-            retry.onclick = () => window.location.reload();
-            recovery.append(retry);
-            this.overlay?.append(recovery);
-            this.emitState();
-        }
         removeOverlay(presentationId) {
             window.clearTimeout(this.progressTimer);
-            window.clearTimeout(this.recoveryTimer);
             this.overlay?.remove();
             this.overlay = undefined;
             this.stateMachine.hidden(presentationId);

package/ios/Sources/LottieSplashPlugin/LottieSplashCoordinator.swift

@@ -149,7 +149,7 @@ public struct LottieSplashConfiguration {
 }
 
 public enum LottieSplashPhase: String {
-    case preparing, playing, holding, hiding, hidden, recovery
+    case preparing, playing, holding, hiding, hidden
 }
 
 public final class LottieSplashCoordinator {
@@ -159,7 +159,6 @@ public final class LottieSplashCoordinator {
     /// permanently obscure that bundle during an over-the-air/native rollout mismatch.
     private let webAdoptionGracePeriod: TimeInterval = 10
     private let progressDelay: TimeInterval = 1
-    private let recoveryDelay: TimeInterval = 15
 
     public private(set) var presentationId: String?
     public private(set) var phase: LottieSplashPhase = .hidden
@@ -167,20 +166,17 @@ public final class LottieSplashCoordinator {
     public private(set) var appReady = false
     public private(set) var theme: LottieSplashTheme = .dark
     public var onStateChange: ((LottieSplashCoordinator) -> Void)?
-    public var onRecoveryRequested: (() -> Void)?
 
     private weak var hostController: UIViewController?
     private var cover: LottieSplashCoverView?
     private var animationWebView: WKWebView?
     private var animationMessageBridge: LottieSplashMessageBridge?
     private var loadingRail: LottieSplashLoadingRail?
-    private var recoveryWorkItem: DispatchWorkItem?
     private var progressWorkItem: DispatchWorkItem?
     private var adoptionWorkItem: DispatchWorkItem?
     private var adoptedByWeb = false
     private var webRendererLoaded = false
     private var progressRemaining = TimeInterval(1)
-    private var recoveryRemaining = TimeInterval(15)
     private var waitingClockStartedAt: Date?
     private var playbackCompletion: ((String, String?) -> Void)?
     private let queue = DispatchQueue.main
@@ -401,20 +397,13 @@ public final class LottieSplashCoordinator {
             ])
             self.loadingRail = rail
         }
-        let recovery = DispatchWorkItem { [weak self] in
-            self?.recoveryRemaining = 0
-            self?.showRecovery(for: id)
-        }
         progressWorkItem = progress
-        recoveryWorkItem = recovery
         if self.loadingRail == nil { queue.asyncAfter(deadline: .now() + progressRemaining, execute: progress) }
-        queue.asyncAfter(deadline: .now() + recoveryRemaining, execute: recovery)
     }
 
     private func resetWaitingIndicators(for id: String) {
         cancelWaitingTasks()
         progressRemaining = progressDelay
-        recoveryRemaining = recoveryDelay
         scheduleWaitingIndicators(for: id)
     }
 
@@ -422,15 +411,12 @@ public final class LottieSplashCoordinator {
         guard let waitingClockStartedAt else { return }
         let elapsed = Date().timeIntervalSince(waitingClockStartedAt)
         progressRemaining = max(0, progressRemaining - elapsed)
-        recoveryRemaining = max(0, recoveryRemaining - elapsed)
         cancelWaitingTasks()
     }
 
     private func cancelWaitingTasks() {
         progressWorkItem?.cancel()
-        recoveryWorkItem?.cancel()
         progressWorkItem = nil
-        recoveryWorkItem = nil
         waitingClockStartedAt = nil
     }
 
@@ -445,33 +431,6 @@ public final class LottieSplashCoordinator {
         queue.asyncAfter(deadline: .now() + webAdoptionGracePeriod, execute: fallback)
     }
 
-    private func showRecovery(for id: String) {
-        guard presentationId == id, !appReady else { return }
-        cancelWaitingTasks()
-        phase = .recovery
-        loadingRail?.removeFromSuperview()
-        loadingRail = nil
-        let stack = UIStackView()
-        stack.axis = .vertical
-        stack.spacing = 12
-        stack.alignment = .center
-        stack.translatesAutoresizingMaskIntoConstraints = false
-        let label = UILabel()
-        label.text = "Still starting…"
-        label.accessibilityTraits = .updatesFrequently
-        let retry = UIButton(type: .system)
-        retry.setTitle("Try again", for: .normal)
-        retry.addAction(UIAction { [weak self] _ in self?.onRecoveryRequested?() }, for: .primaryActionTriggered)
-        stack.addArrangedSubview(label)
-        stack.addArrangedSubview(retry)
-        cover?.addSubview(stack)
-        if let cover {
-            NSLayoutConstraint.activate([stack.centerXAnchor.constraint(equalTo: cover.centerXAnchor), stack.bottomAnchor.constraint(equalTo: cover.safeAreaLayoutGuide.bottomAnchor, constant: -48)])
-        }
-        UIAccessibility.post(notification: .announcement, argument: "Still starting")
-        emitState()
-    }
-
     private func dismiss(completion: @escaping (Error?) -> Void) {
         guard phase != .hidden, let cover, let id = presentationId else { completion(nil); return }
         phase = .hiding

package/ios/Sources/LottieSplashPlugin/LottieSplashPlugin.swift

@@ -17,7 +17,6 @@ public class LottieSplashPlugin: CAPPlugin, CAPBridgedPlugin {
 
     override public func load() {
         coordinator.onStateChange = { [weak self] coordinator in self?.notifyListeners("stateChange", data: self?.stateData(coordinator) ?? [:]) }
-        coordinator.onRecoveryRequested = { [weak self] in self?.bridge?.webView?.reload() }
     }
 
     @objc public func show(_ call: CAPPluginCall) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-lottie-splash",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Native-first Lottie splash presentation for Capacitor 8",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",