@livetemplate/client 0.11.3 → 0.11.5

package/dist/dom/loading-indicator.js

@@ -3,15 +3,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoadingIndicator = void 0;
 /**
  * Handles showing and hiding the global LiveTemplate loading indicator.
+ *
+ * Two activation paths share the same physical bar:
+ *
+ *   1. Initial connect — `data-lvt-loading="true"` on the wrapper triggers
+ *      `show()` in autoInit; `hide()` fires from the first server payload.
+ *   2. Per-action wait — `data-lvt-loading-debounce-ms="<ms>"` on the wrapper
+ *      enables `enablePerActionIndicator(ms)`, which arms a timer on
+ *      `lvt:pending` (capture-phase) and hides on `lvt:updated`. Idempotent.
  */
 class LoadingIndicator {
     constructor() {
         this.bar = null;
+        this.actionTimer = null;
+        // Counts in-flight actions so concurrent server roundtrips don't hide
+        // the bar prematurely: the bar stays visible as long as at least one
+        // `lvt:pending` is outstanding. Without this counter, action B
+        // completing first would clear the bar even though action A is still
+        // in flight.
+        this.pendingCount = 0;
+        this.pendingHandler = null;
+        this.updatedHandler = null;
+        // Current per-action debounce — tracked so a follow-up enable call
+        // with a different value reconfigures cleanly instead of silently
+        // dropping the new value.
+        this.currentDebounceMs = null;
     }
     show() {
         if (this.bar)
             return;
         const bar = document.createElement("div");
+        bar.className = "lvt-loading-bar";
         bar.style.cssText = `
       position: fixed;
       top: 0;
@@ -45,6 +67,91 @@ class LoadingIndicator {
         }
         this.bar = null;
     }
+    /**
+     * Show the loading bar after `debounceMs` of an action being in flight;
+     * hide on the next `lvt:updated`. Capture-phase listeners on document
+     * catch both events regardless of dispatch target. Safe to call more
+     * than once — repeat calls are no-ops.
+     */
+    enablePerActionIndicator(debounceMs) {
+        // Same value as already enabled → no-op (idempotent).
+        // Different value → tear down and re-register cleanly. This
+        // matters for callers that re-read the debounce attribute after
+        // a config change; without it, the second call would silently
+        // discard the new value.
+        if (this.pendingHandler) {
+            if (this.currentDebounceMs === debounceMs)
+                return;
+            this.disablePerActionIndicator();
+        }
+        this.pendingCount = 0;
+        this.currentDebounceMs = debounceMs;
+        this.pendingHandler = () => {
+            this.pendingCount++;
+            // Only arm a debounce timer on the 0→1 transition. Subsequent
+            // concurrent actions don't reset the timer or re-show the bar —
+            // the bar that is or will become visible already represents "at
+            // least one action in flight".
+            if (this.pendingCount === 1 &&
+                this.actionTimer === null &&
+                this.bar === null) {
+                this.actionTimer = setTimeout(() => {
+                    this.actionTimer = null;
+                    // Re-check pendingCount at fire time. In single-threaded JS
+                    // `updatedHandler` would have called `clearTimeout` before the
+                    // count could reach zero, so this guard is defensive: it
+                    // documents the invariant and protects against any future
+                    // reordering of teardown vs. show.
+                    if (this.pendingCount > 0)
+                        this.show();
+                }, debounceMs);
+            }
+        };
+        this.updatedHandler = () => {
+            // Math.max guards against an `lvt:updated` arriving without a
+            // matching `lvt:pending` (e.g. a server push, or an action whose
+            // pending event was dispatched before the listener was attached).
+            this.pendingCount = Math.max(0, this.pendingCount - 1);
+            if (this.pendingCount === 0) {
+                if (this.actionTimer !== null) {
+                    clearTimeout(this.actionTimer);
+                    this.actionTimer = null;
+                }
+                this.hide();
+            }
+        };
+        document.addEventListener("lvt:pending", this.pendingHandler, true);
+        document.addEventListener("lvt:updated", this.updatedHandler, true);
+    }
+    /**
+     * Teardown for `enablePerActionIndicator`. Stops the listeners, cancels
+     * any pending debounce timer, resets the counter, and hides the bar
+     * if it's currently visible. Hiding is part of teardown so a caller
+     * that reconfigures (different debounce → disable + re-enable) doesn't
+     * leave the prior cycle's bar orphaned waiting for an `lvt:updated`
+     * that no listener will receive.
+     *
+     * Production callers reach this path via two routes: an explicit
+     * reconfigure inside `enablePerActionIndicator`, and the LiveTemplate
+     * client's `disconnect()` teardown.
+     */
+    disablePerActionIndicator() {
+        if (this.pendingHandler) {
+            document.removeEventListener("lvt:pending", this.pendingHandler, true);
+            this.pendingHandler = null;
+        }
+        if (this.updatedHandler) {
+            document.removeEventListener("lvt:updated", this.updatedHandler, true);
+            this.updatedHandler = null;
+        }
+        if (this.actionTimer !== null) {
+            clearTimeout(this.actionTimer);
+            this.actionTimer = null;
+        }
+        this.pendingCount = 0;
+        this.currentDebounceMs = null;
+        this.hide();
+    }
 }
 exports.LoadingIndicator = LoadingIndicator;
 //# sourceMappingURL=loading-indicator.js.map

package/dist/dom/loading-indicator.js.map

@@ -1 +1 @@
-{"version":3,"file":"loading-indicator.js","sourceRoot":"","sources":["../../dom/loading-indicator.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,gBAAgB;IAA7B;QACU,QAAG,GAAuB,IAAI,CAAC;IA0CzC,CAAC;IAxCC,IAAI;QACF,IAAI,IAAI,CAAC,GAAG;YAAE,OAAO;QAErB,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,GAAG,CAAC,KAAK,CAAC,OAAO,GAAG;;;;;;;;;;KAUnB,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACnD,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAC9C,KAAK,CAAC,EAAE,GAAG,oBAAoB,CAAC;YAChC,KAAK,CAAC,WAAW,GAAG;;;;;OAKnB,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,GAAG;YAAE,OAAO;QAEtB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;IAClB,CAAC;CACF;AA3CD,4CA2CC"}
+{"version":3,"file":"loading-indicator.js","sourceRoot":"","sources":["../../dom/loading-indicator.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,MAAa,gBAAgB;IAA7B;QACU,QAAG,GAAuB,IAAI,CAAC;QAC/B,gBAAW,GAAyC,IAAI,CAAC;QACjE,sEAAsE;QACtE,qEAAqE;QACrE,+DAA+D;QAC/D,qEAAqE;QACrE,aAAa;QACL,iBAAY,GAAG,CAAC,CAAC;QACjB,mBAAc,GAAiC,IAAI,CAAC;QACpD,mBAAc,GAAiC,IAAI,CAAC;QAC5D,mEAAmE;QACnE,kEAAkE;QAClE,0BAA0B;QAClB,sBAAiB,GAAkB,IAAI,CAAC;IAmIlD,CAAC;IAjIC,IAAI;QACF,IAAI,IAAI,CAAC,GAAG;YAAE,OAAO;QAErB,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,GAAG,CAAC,SAAS,GAAG,iBAAiB,CAAC;QAClC,GAAG,CAAC,KAAK,CAAC,OAAO,GAAG;;;;;;;;;;KAUnB,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACnD,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAC9C,KAAK,CAAC,EAAE,GAAG,oBAAoB,CAAC;YAChC,KAAK,CAAC,WAAW,GAAG;;;;;OAKnB,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,GAAG;YAAE,OAAO;QAEtB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CAAC,UAAkB;QACzC,sDAAsD;QACtD,4DAA4D;QAC5D,gEAAgE;QAChE,8DAA8D;QAC9D,yBAAyB;QACzB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,iBAAiB,KAAK,UAAU;gBAAE,OAAO;YAClD,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;QAEpC,IAAI,CAAC,cAAc,GAAG,GAAG,EAAE;YACzB,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,8DAA8D;YAC9D,gEAAgE;YAChE,gEAAgE;YAChE,+BAA+B;YAC/B,IACE,IAAI,CAAC,YAAY,KAAK,CAAC;gBACvB,IAAI,CAAC,WAAW,KAAK,IAAI;gBACzB,IAAI,CAAC,GAAG,KAAK,IAAI,EACjB,CAAC;gBACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;oBACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;oBACxB,4DAA4D;oBAC5D,+DAA+D;oBAC/D,yDAAyD;oBACzD,0DAA0D;oBAC1D,mCAAmC;oBACnC,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC;wBAAE,IAAI,CAAC,IAAI,EAAE,CAAC;gBACzC,CAAC,EAAE,UAAU,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,GAAG,EAAE;YACzB,8DAA8D;YAC9D,iEAAiE;YACjE,kEAAkE;YAClE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;gBAC5B,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;oBAC9B,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC1B,CAAC;gBACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,CAAC;QACH,CAAC,CAAC;QACF,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpE,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,yBAAyB;QACvB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,QAAQ,CAAC,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,QAAQ,CAAC,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YAC9B,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;CACF;AAjJD,4CAiJC"}