stimeo-ui 0.7.0 → 0.9.0

data/dist/controllers/nested_form_controller.js

@@ -1,6 +1,238 @@
 import { Controller } from '@hotwired/stimulus';
 
 // src/controllers/nested_form_controller.ts
+
+// src/utils/announce.ts
+function announce(message, options = {}) {
+  const text = message.trim();
+  if (text.length === 0) return;
+  window.dispatchEvent(
+    new CustomEvent("stimeo--announcer:announce", {
+      detail: { message: text, assertive: options.assertive === true }
+    })
+  );
+}
+function fillTemplate(template, values) {
+  return template.replace(/\{([a-zA-Z][a-zA-Z0-9]*)\}/g, (match, name) => {
+    const replacement = values[name];
+    return replacement === void 0 ? match : String(replacement);
+  });
+}
+
+// src/utils/attribute_lease.ts
+var AttributeLease = class {
+  #attribute;
+  #records = /* @__PURE__ */ new Map();
+  /** @param attribute - The attribute whose temporary values this lease owns. */
+  constructor(attribute) {
+    this.#attribute = attribute;
+  }
+  /** Writes or removes the leased attribute while preserving its authored value. */
+  write(element, value) {
+    const existing = this.#records.get(element);
+    if (existing) {
+      existing.written = value;
+    } else {
+      this.#records.set(element, {
+        original: element.getAttribute(this.#attribute),
+        written: value
+      });
+    }
+    this.#reflect(element, value);
+  }
+  /** Returns one lease without overwriting a value subsequently authored by a consumer. */
+  return(element) {
+    const record = this.#records.get(element);
+    if (!record) return;
+    this.#records.delete(element);
+    const stillOwned = element.getAttribute(this.#attribute) === record.written;
+    if (stillOwned) this.#reflect(element, record.original);
+  }
+  /** Reflects only a real value transition, avoiding self-triggered mutation work. */
+  #reflect(element, value) {
+    if (element.getAttribute(this.#attribute) === value) return;
+    if (value === null) element.removeAttribute(this.#attribute);
+    else element.setAttribute(this.#attribute, value);
+  }
+  /** Returns every outstanding lease using the same ownership check as {@link return}. */
+  returnAll() {
+    for (const element of Array.from(this.#records.keys())) this.return(element);
+  }
+};
+
+// src/utils/before_cache_reset.ts
+var BeforeCacheReset = class _BeforeCacheReset {
+  /** Every subscribed instance, iterated by the one shared document listener. */
+  static #subscribers = /* @__PURE__ */ new Set();
+  /** The shared listener; installed while at least one instance is subscribed. */
+  static #onBeforeCache = () => {
+    for (const subscriber of _BeforeCacheReset.#subscribers) subscriber.#rewind();
+  };
+  #rewind;
+  /** @param rewind - the pass that returns this controller's state to its initial form. */
+  constructor(rewind) {
+    this.#rewind = rewind;
+  }
+  /** Subscribes to `turbo:before-cache`; call from `connect()`. Idempotent. */
+  activate() {
+    const first = _BeforeCacheReset.#subscribers.size === 0;
+    _BeforeCacheReset.#subscribers.add(this);
+    if (first) {
+      document.addEventListener("turbo:before-cache", _BeforeCacheReset.#onBeforeCache);
+    }
+  }
+  /** Unsubscribes; call from `disconnect()`. Safe when never subscribed. */
+  deactivate() {
+    _BeforeCacheReset.#subscribers.delete(this);
+    if (_BeforeCacheReset.#subscribers.size > 0) return;
+    document.removeEventListener("turbo:before-cache", _BeforeCacheReset.#onBeforeCache);
+  }
+};
+
+// src/utils/focus_candidate.ts
+function inheritsFieldsetDisabled(control) {
+  let fieldset = control.closest("fieldset[disabled]");
+  while (fieldset) {
+    const legend = Array.from(fieldset.children).find((child) => child.tagName === "LEGEND");
+    if (!legend?.contains(control)) return true;
+    fieldset = fieldset.parentElement?.closest("fieldset[disabled]") ?? null;
+  }
+  return false;
+}
+function canTakeFocus(element) {
+  if (element.closest("[hidden], [inert]")) return false;
+  if (element instanceof HTMLInputElement && element.type === "hidden") return false;
+  if (!("disabled" in element)) return true;
+  if (element.disabled) return false;
+  return !inheritsFieldsetDisabled(element);
+}
+var TAB_STOP_CANDIDATE_SELECTOR = [
+  "a[href]",
+  "area[href]",
+  "button",
+  "input",
+  "select",
+  "textarea",
+  "summary",
+  "iframe",
+  "audio[controls]",
+  "video[controls]",
+  "[tabindex]",
+  "[contenteditable]"
+].join(",");
+function isRenderedForFocus(element) {
+  const check = element.checkVisibility;
+  return typeof check === "function" ? check.call(element, { visibilityProperty: true }) : true;
+}
+function authoredTabindex(element) {
+  const value = element.getAttribute("tabindex");
+  if (value === null || !/^[+-]?\d+$/.test(value.trim())) return null;
+  return Number(value);
+}
+function hasNativeTabStop(element) {
+  if (element instanceof HTMLAnchorElement || element instanceof HTMLAreaElement) {
+    return element.hasAttribute("href");
+  }
+  if (element instanceof HTMLButtonElement || element instanceof HTMLSelectElement || element instanceof HTMLTextAreaElement) {
+    return true;
+  }
+  if (element instanceof HTMLInputElement) return element.type !== "hidden";
+  if (element instanceof HTMLIFrameElement) return true;
+  if (element.tagName === "AUDIO" || element.tagName === "VIDEO") {
+    return element.hasAttribute("controls");
+  }
+  if (element instanceof HTMLElement && element.tagName === "SUMMARY") {
+    const details = element.parentElement;
+    return details instanceof HTMLDetailsElement && Array.from(details.children).find((child) => child.tagName === "SUMMARY") === element;
+  }
+  return false;
+}
+function hasEditableTabStop(element) {
+  const value = element.getAttribute("contenteditable")?.toLowerCase();
+  return value === "" || value === "true" || value === "plaintext-only";
+}
+function isTabStop(element) {
+  if (!canTakeFocus(element) || !isRenderedForFocus(element)) return false;
+  const tabindex = authoredTabindex(element);
+  if (tabindex !== null) return tabindex >= 0;
+  return hasNativeTabStop(element) || hasEditableTabStop(element);
+}
+function firstTabStop(root) {
+  for (const candidate of root.querySelectorAll(TAB_STOP_CANDIDATE_SELECTOR)) {
+    if (isTabStop(candidate)) return candidate;
+  }
+  return null;
+}
+
+// src/utils/microtask_coalescer.ts
+var MicrotaskCoalescer = class {
+  #run;
+  #queued = false;
+  #active = false;
+  #generation = 0;
+  /** @param run - the single reconciliation pass, invoked at most once per batch. */
+  constructor(run) {
+    this.#run = run;
+  }
+  /** Opens the window in which {@link schedule} is honoured; call from `connect()`. */
+  activate() {
+    this.#active = true;
+  }
+  /** Closes the window and drops any pending pass; call from `disconnect()`. */
+  cancel() {
+    this.#active = false;
+    this.#queued = false;
+    this.#generation += 1;
+  }
+  /** Requests one pass after the batch settles. Idempotent; inert outside the window. */
+  schedule() {
+    if (!this.#active || this.#queued) return;
+    this.#queued = true;
+    const generation = this.#generation;
+    queueMicrotask(() => {
+      if (generation !== this.#generation || !this.#queued || !this.#active) return;
+      this.#queued = false;
+      this.#run();
+    });
+  }
+};
+
+// src/utils/tabindex_loan.ts
+var TabindexLoan = class {
+  #value;
+  #lent = /* @__PURE__ */ new Set();
+  /** Returns live loans before Turbo can copy them into its page snapshot. */
+  #beforeCache = new BeforeCacheReset(() => this.returnAll());
+  /**
+   * @param value - the `tabindex` to lend. `"-1"` (the default) is
+   *   programmatically focusable but not a Tab stop; `"0"` is a real Tab stop,
+   *   which a scroll region with no focusable content of its own needs.
+   */
+  constructor(value = "-1") {
+    this.#value = value;
+  }
+  /** Lends `element` the value; no-ops when it already carries a `tabindex`. */
+  lend(element) {
+    if (element.hasAttribute("tabindex")) return;
+    element.setAttribute("tabindex", this.#value);
+    this.#lent.add(element);
+    this.#beforeCache.activate();
+  }
+  /** Takes back every loan whose value is still the one that was lent. */
+  returnAll() {
+    for (const element of this.#lent) {
+      if (element.getAttribute("tabindex") === this.#value) element.removeAttribute("tabindex");
+    }
+    this.#lent.clear();
+    this.#beforeCache.deactivate();
+  }
+};
+
+// src/controllers/nested_form_controller.ts
+var ROOT_SELECTOR = '[data-controller~="stimeo--nested-form"]';
+var REMOVE_SELECTOR = '[data-stimeo--nested-form-target="remove"]';
+var DESTROY_FLAG_SELECTOR = '[data-stimeo--nested-form-target="destroyFlag"]';
+var DESTROYED_VALUES = /* @__PURE__ */ new Set(["1", "true"]);
 var NestedFormController = class extends Controller {
   static targets = ["list", "template", "add", "remove", "destroyFlag"];
   static values = {
@@ -11,92 +243,251 @@ var NestedFormController = class extends Controller {
     countMessage: { type: String, default: "" }
   };
   static actions = ["add"];
-  static events = ["add", "remove"];
+  static events = ["add", "remove", "reconcile"];
   /** Monotonic source for unique row indices; never a row-state counter. */
   #lastIndex = 0;
-  /** Delegated click handler for the per-row remove buttons (dynamic-safe). */
+  #warnedMissing = false;
+  #warnedTemplate = false;
+  /** The state last written to the hooks; reconciliation reports only real moves. */
+  #published = null;
+  /** Watches the list for row changes the controller did not perform itself. */
+  #observer = null;
+  #reconcile = new MicrotaskCoalescer(() => this.#reconcileNow());
+  /** Restores the authored add-button `disabled` when a lease ends. */
+  #addDisabled = new AttributeLease("disabled");
+  #beforeCache = new BeforeCacheReset(() => this.#rewindForCache());
+  /** Makes the root a programmatic focus destination when no other candidate survives. */
+  #tabindex = new TabindexLoan();
+  /**
+   * Delegated click handler for the per-row remove buttons (dynamic-safe). Only
+   * buttons whose nearest nested-form root is this instance are acted on, so a
+   * nested inner form's buttons never remove an outer row.
+   */
   #onClick = (event) => {
     const target = event.target;
-    const button = target?.closest('[data-stimeo--nested-form-target="remove"]');
-    if (!button || !this.element.contains(button)) return;
+    const button = target?.closest(REMOVE_SELECTOR);
+    if (!button || this.#ownerOf(button) !== this.element) return;
     const row = this.#rowContaining(button);
     if (row) this.#removeRow(row);
   };
   connect() {
+    this.#warnedMissing = false;
+    this.#warnedTemplate = false;
     this.element.addEventListener("click", this.#onClick);
+    this.#reconcile.activate();
+    this.#beforeCache.activate();
+    if (!this.hasListTarget || !this.hasTemplateTarget) this.#warnMissing();
     this.#refresh();
   }
   disconnect() {
     this.element.removeEventListener("click", this.#onClick);
+    this.#observer?.disconnect();
+    this.#observer = null;
+    this.#reconcile.cancel();
+    this.#beforeCache.deactivate();
+    this.#rewindForCache();
+    this.#tabindex.returnAll();
+    this.#published = null;
+  }
+  /** Follows an arriving or swapped-in list: rebind to the primary, then reconcile. */
+  listTargetConnected() {
+    this.#rebindObserver();
+    this.#reconcile.schedule();
+  }
+  /** Follows a departing list the same way — the primary may have changed. */
+  listTargetDisconnected() {
+    this.#rebindObserver();
+    this.#reconcile.schedule();
+  }
+  /**
+   * Points the observer at the current primary list. Re-deriving on every list
+   * arrival and departure makes the binding independent of the order Stimulus
+   * reports an overlapping swap in — a staggered swap (successor appended before
+   * the old list leaves) ends observed and reconciled either way.
+   */
+  #rebindObserver() {
+    this.#observer?.disconnect();
+    this.#observer = null;
+    if (!this.hasListTarget) return;
+    this.#observer = new MutationObserver(() => this.#reconcile.schedule());
+    this.#observer.observe(this.listTarget, {
+      childList: true,
+      subtree: true,
+      attributes: true,
+      attributeFilter: ["value"]
+    });
+  }
+  /** Returns the lease with a departing add button; a new one re-arms on refresh. */
+  addTargetDisconnected(target) {
+    this.#addDisabled.return(target);
+    this.#reconcile.schedule();
+  }
+  addTargetConnected() {
+    this.#reconcile.schedule();
+  }
+  /** Re-clamps when application code or a Turbo morph changes `min`. */
+  minValueChanged() {
+    this.#reconcile.schedule();
+  }
+  /** Re-clamps when application code or a Turbo morph changes `max`. */
+  maxValueChanged() {
+    this.#reconcile.schedule();
   }
   /**
    * Clones the template row, replaces the index placeholder with a unique value,
-   * appends it, focuses its first control, and announces the new count. No-ops at
-   * `max`.
+   * appends it, focuses its first tab stop, and announces the new count. No-ops at
+   * `max`, when the required targets are missing (named on the console once per
+   * connection), or when the template does not produce exactly one root element
+   * (also named once; the insertion is rolled back so nothing accumulates).
    */
   add() {
-    if (!this.hasTemplateTarget || !this.hasListTarget || this.#atMax) return;
+    if (!this.hasListTarget || !this.hasTemplateTarget) {
+      this.#warnMissing();
+      return;
+    }
+    if (this.#atMax) return;
     const index = this.#nextIndex();
     const markup = this.templateTarget.innerHTML.replaceAll(
       this.indexPlaceholderValue,
       String(index)
     );
-    this.listTarget.insertAdjacentHTML("beforeend", markup);
-    const row = this.listTarget.lastElementChild;
-    if (!row) return;
+    const list = this.listTarget;
+    const beforeNodes = list.childNodes.length;
+    const beforeElements = list.childElementCount;
+    list.insertAdjacentHTML("beforeend", markup);
+    const added = Array.from(list.children).slice(beforeElements);
+    if (added.length !== 1) {
+      while (list.childNodes.length > beforeNodes) list.lastChild?.remove();
+      this.#warnBadTemplate(added.length);
+      return;
+    }
+    const row = added[0];
     this.#refresh();
-    this.#firstControl(row)?.focus();
+    firstTabStop(row)?.focus();
     this.dispatch("add", { detail: { index, element: row } });
     this.#announce();
   }
   /**
-   * Removes a row: a persisted row (one carrying a `destroyFlag`) has its flag set
-   * to `1` and is hidden so Rails destroys it on submit; an unsaved row is dropped
-   * from the DOM. Returns focus to a neighboring row. No-ops at `min`.
+   * Removes a row: a persisted row (one carrying its own `destroyFlag`) has the
+   * flag set to `1` and is hidden so Rails destroys it on submit; an unsaved row
+   * is dropped from the DOM. Returns focus to a surviving row. No-ops at `min`.
    */
   #removeRow(row) {
-    if (this.#effectiveRows.length <= this.minValue) return;
-    const neighbors = this.#effectiveRows;
-    const position = neighbors.indexOf(row);
-    const neighbor = neighbors[position + 1] ?? neighbors[position - 1] ?? null;
-    const flag = row.querySelector(
-      '[data-stimeo--nested-form-target="destroyFlag"]'
-    );
+    const rows = this.#effectiveRows;
+    if (this.#destroyed(row)) {
+      row.hidden = true;
+      this.#focusAfterRemove(this.#positionAmong(rows, row));
+      return;
+    }
+    if (rows.length <= this.minValue) return;
+    const position = rows.indexOf(row);
+    const flag = this.#destroyFlagOf(row);
     const persisted = flag !== null;
-    if (persisted) {
+    if (flag) {
       flag.value = "1";
       row.hidden = true;
     } else {
       row.remove();
     }
     this.#refresh();
-    const focusTarget = neighbor ? this.#firstControl(neighbor) : this.hasAddTarget ? this.addTarget : null;
-    focusTarget?.focus();
+    this.#focusAfterRemove(Math.max(0, position));
     this.dispatch("remove", { detail: { element: row, persisted } });
     this.#announce();
   }
-  /** Recomputes the live count and the min/max state hooks from the DOM. */
+  /**
+   * The index of the first effective row following `row` in document order.
+   * -1 (no following row) feeds the focus slices as a negative index, which
+   * yields the same fully-reversed nearest-first order as `rows.length` would.
+   */
+  #positionAmong(rows, row) {
+    return rows.findIndex(
+      (candidate) => (row.compareDocumentPosition(candidate) & Node.DOCUMENT_POSITION_FOLLOWING) !== 0
+    );
+  }
+  /**
+   * Moves focus to the first tab stop of the nearest surviving row — following
+   * rows first, then preceding ones — falling back to the add button and finally
+   * to the root via a temporary `tabindex`.
+   */
+  #focusAfterRemove(position) {
+    const rows = this.#effectiveRows;
+    const ordered = [...rows.slice(position), ...rows.slice(0, position).reverse()];
+    for (const row of ordered) {
+      const stop = firstTabStop(row);
+      if (stop) {
+        stop.focus();
+        return;
+      }
+    }
+    if (this.hasAddTarget && isTabStop(this.addTarget)) {
+      this.addTarget.focus();
+      return;
+    }
+    this.#tabindex.lend(this.element);
+    this.element.focus();
+  }
+  /** Recomputes the count and min/max hooks from the DOM and records them as published. */
   #refresh() {
+    if (!this.hasListTarget) return;
     const count = this.#effectiveRows.length;
+    const atMin = count <= this.minValue;
+    const atMax = this.maxValue > 0 && count >= this.maxValue;
     this.element.setAttribute("data-nested-count", String(count));
-    this.#reflect("data-nested-at-max", this.maxValue > 0 && count >= this.maxValue);
-    this.#reflect("data-nested-at-min", count <= this.minValue);
-    if (this.hasAddTarget) this.addTarget.disabled = this.#atMax;
+    this.#reflect("data-nested-at-max", atMax);
+    this.#reflect("data-nested-at-min", atMin);
+    if (this.hasAddTarget) {
+      if (this.maxValue > 0) this.#addDisabled.write(this.addTarget, atMax ? "" : null);
+      else this.#addDisabled.return(this.addTarget);
+    }
+    this.#published = { count, atMin, atMax };
+  }
+  /**
+   * Applies row changes the controller did not perform itself (Turbo Streams,
+   * morphs, runtime Value changes): refreshes the hooks and reports a moved
+   * public state as `reconcile`. The controller's own operations refresh
+   * synchronously first, so their observer echo arrives here as a no-move.
+   */
+  #reconcileNow() {
+    const previous = this.#published;
+    this.#refresh();
+    const current = this.#published;
+    if (!previous || !current) return;
+    const moved = previous.count !== current.count || previous.atMin !== current.atMin || previous.atMax !== current.atMax;
+    if (moved) this.dispatch("reconcile", { detail: { ...current } });
   }
   /** Bridges the count change to the shared announcer when configured. */
   #announce() {
-    if (!this.announceValue || !this.countMessageValue) return;
-    const message = this.countMessageValue.replaceAll(
-      "{count}",
-      String(this.#effectiveRows.length)
-    );
-    window.dispatchEvent(new CustomEvent("stimeo--announcer:announce", { detail: { message } }));
+    if (!this.announceValue || this.countMessageValue === "") return;
+    announce(fillTemplate(this.countMessageValue, { count: this.#effectiveRows.length }));
   }
   /** Sets `attribute` to `"true"` when `on`, else removes it. */
   #reflect(attribute, on) {
     if (on) this.element.setAttribute(attribute, "true");
     else this.element.removeAttribute(attribute);
   }
+  /** Returns the disabled lease so an authored value never leaks into a snapshot. */
+  #rewindForCache() {
+    if (this.hasAddTarget) this.#addDisabled.return(this.addTarget);
+  }
+  /** Names the missing required target(s) once per connection. */
+  #warnMissing() {
+    if (this.#warnedMissing) return;
+    this.#warnedMissing = true;
+    const missing = [
+      this.hasListTarget ? null : 'a "list" target',
+      this.hasTemplateTarget ? null : 'a "template" target'
+    ].filter((part) => part !== null).join(" and ");
+    console.warn(
+      `Stimeo UI: "${this.identifier}" cannot manage rows because its markup lacks ${missing}.`
+    );
+  }
+  /** Names a template that does not produce exactly one element, once per connection. */
+  #warnBadTemplate(produced) {
+    if (this.#warnedTemplate) return;
+    this.#warnedTemplate = true;
+    const reason = produced === 0 ? "produces no element" : "must produce exactly one root element";
+    console.warn(`Stimeo UI: "${this.identifier}" added no row because its template ${reason}.`);
+  }
   /** A strictly-increasing unique index (collision-free even on rapid adds). */
   #nextIndex() {
     const index = Math.max(Date.now(), this.#lastIndex + 1);
@@ -106,24 +497,41 @@ var NestedFormController = class extends Controller {
   get #atMax() {
     return this.maxValue > 0 && this.#effectiveRows.length >= this.maxValue;
   }
-  /** Direct child rows of the list that are not flagged for destruction. */
+  /**
+   * Direct child rows of the list whose own destroy flag is not set. Callers
+   * reach this only behind a list-presence gate (`add`, `#refresh`, and the
+   * click path through `#rowContaining`).
+   */
   get #effectiveRows() {
-    return Array.from(this.listTarget.children).filter((row) => !row.hidden);
+    return Array.from(this.listTarget.children).filter(
+      (row) => !this.#destroyed(row)
+    );
+  }
+  /** Whether `row` is flagged for destruction; the flag value is the truth source. */
+  #destroyed(row) {
+    const flag = this.#destroyFlagOf(row);
+    return flag !== null && DESTROYED_VALUES.has(flag.value);
+  }
+  /** The row's own destroy flag, skipping flags owned by a nested inner form. */
+  #destroyFlagOf(row) {
+    for (const flag of row.querySelectorAll(DESTROY_FLAG_SELECTOR)) {
+      if (this.#ownerOf(flag) === this.element) return flag;
+    }
+    return null;
+  }
+  /** The nearest nested-form root that owns `el`. */
+  #ownerOf(el) {
+    return el.closest(ROOT_SELECTOR);
   }
   /** The nearest ancestor of `el` that is a direct child of the list, else null. */
   #rowContaining(el) {
+    if (!this.hasListTarget) return null;
     let node = el;
     while (node && node.parentElement !== this.listTarget) {
       node = node.parentElement;
     }
     return node;
   }
-  /** First visible focusable control inside `row` (skips hidden inputs). */
-  #firstControl(row) {
-    return row.querySelector(
-      'input:not([type="hidden"]), select, textarea, button, [tabindex]'
-    );
-  }
 };
 
 export { NestedFormController };