@oakoliver/bubblezone 0.0.0-stage → 1.0.0

package/dist/index.cjs

@@ -0,0 +1,436 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AnyInBounds: () => AnyInBounds,
+  AnyInBoundsAndUpdate: () => AnyInBoundsAndUpdate,
+  Clear: () => Clear,
+  Close: () => Close,
+  DefaultManager: () => DefaultManager,
+  Enabled: () => Enabled,
+  Get: () => Get,
+  Manager: () => Manager,
+  Mark: () => Mark,
+  MsgZoneInBounds: () => MsgZoneInBounds,
+  New: () => New,
+  NewGlobal: () => NewGlobal,
+  NewPrefix: () => NewPrefix,
+  Scan: () => Scan,
+  SetEnabled: () => SetEnabled,
+  ZoneInfo: () => ZoneInfo,
+  anyInBounds: () => AnyInBounds,
+  anyInBoundsAndUpdate: () => AnyInBoundsAndUpdate,
+  clear: () => Clear,
+  close: () => Close,
+  enabled: () => Enabled,
+  get: () => Get,
+  mark: () => Mark,
+  newGlobal: () => NewGlobal,
+  newPrefix: () => NewPrefix,
+  printableWidth: () => printableWidth,
+  runeWidth: () => runeWidth,
+  scan: () => Scan,
+  setEnabled: () => SetEnabled
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/manager.ts
+var import_bubbletea = require("@oakoliver/bubbletea");
+
+// src/messages.ts
+var MsgZoneInBounds = class {
+  constructor(zone, event) {
+    this.zone = zone;
+    this.event = event;
+  }
+  zone;
+  event;
+  _tag = "MsgZoneInBounds";
+};
+
+// src/zoneinfo.ts
+function position(msg) {
+  const m = msg;
+  if (typeof m.mouse === "function") return m.mouse();
+  return { x: m.x, y: m.y };
+}
+var ZoneInfo = class {
+  /** The ID passed to `mark()`; empty for a zone that is not known yet. */
+  id;
+  /** @internal The generated marker sequence that stands for `id` in a view. */
+  rid;
+  /** @internal The scan this zone came from, used to drop stale zones. */
+  iteration;
+  /** X of the top-left cell of the zone. */
+  startX;
+  /** Y of the top-left cell of the zone. */
+  startY;
+  /** X of the bottom-right cell of the zone. */
+  endX;
+  /** Y of the bottom-right cell of the zone. */
+  endY;
+  constructor(init = {}) {
+    this.id = init.id ?? "";
+    this.rid = init.rid ?? "";
+    this.iteration = init.iteration ?? 0;
+    this.startX = init.startX ?? 0;
+    this.startY = init.startY ?? 0;
+    this.endX = init.endX ?? 0;
+    this.endY = init.endY ?? 0;
+  }
+  /** Reports whether the zone is not known (yet). `Manager.get()` returns such a zone for unknown IDs. */
+  isZero() {
+    return this.id === "";
+  }
+  /**
+   * Reports whether the mouse event is inside the box between the start and end
+   * cells. Unknown zones are never in bounds. A zone whose end lies before its
+   * start (for example text that wrapped onto the next line) is never in bounds
+   * either; for shapes a box cannot describe, do the check yourself.
+   */
+  inBounds(msg) {
+    if (this.isZero()) return false;
+    if (this.startX > this.endX || this.startY > this.endY) return false;
+    const { x, y } = position(msg);
+    if (x < this.startX || y < this.startY) return false;
+    if (x > this.endX || y > this.endY) return false;
+    return true;
+  }
+  /**
+   * Returns the event position relative to the zone, with (0, 0) at its top-left
+   * cell, or `[-1, -1]` if the zone is unknown or the event is outside it.
+   */
+  pos(msg) {
+    if (this.isZero() || !this.inBounds(msg)) return [-1, -1];
+    const { x, y } = position(msg);
+    return [x - this.startX, y - this.startY];
+  }
+  /** Width in cells (0 for an unknown or inverted zone). */
+  get width() {
+    return this.isZero() || this.endX < this.startX ? 0 : this.endX - this.startX + 1;
+  }
+  /** Height in rows (0 for an unknown or inverted zone). */
+  get height() {
+    return this.isZero() || this.endY < this.startY ? 0 : this.endY - this.startY + 1;
+  }
+};
+
+// src/width.ts
+var ESC = 27;
+var BEL = 7;
+var wideEmoji = /^\p{Emoji_Presentation}$/u;
+var zeroWidth = /^[\p{Mn}\p{Me}\p{Cf}]$/u;
+function isWide(cp) {
+  return cp >= 4352 && (cp <= 4447 || cp === 9001 || cp === 9002 || cp >= 11904 && cp <= 12350 || cp >= 12353 && cp <= 13311 || cp >= 13312 && cp <= 19903 || cp >= 19968 && cp <= 42191 || cp >= 43360 && cp <= 43391 || cp >= 44032 && cp <= 55203 || cp >= 63744 && cp <= 64255 || cp >= 65040 && cp <= 65049 || cp >= 65072 && cp <= 65135 || cp >= 65280 && cp <= 65376 || cp >= 65504 && cp <= 65510 || cp >= 94176 && cp <= 94180 || cp >= 94208 && cp <= 101631 || cp >= 110592 && cp <= 111359 || cp >= 131072 && cp <= 262141);
+}
+function runeWidth(cp) {
+  if (cp < 32 || cp >= 127 && cp < 160) return 0;
+  if (cp < 768) return 1;
+  if (cp === 8203 || cp === 8205 || cp >= 65024 && cp <= 65039) return 0;
+  if (isWide(cp)) return 2;
+  if (zeroWidth.test(String.fromCodePoint(cp))) return 0;
+  if (cp >= 8986 && wideEmoji.test(String.fromCodePoint(cp))) return 2;
+  return 1;
+}
+var plain = /^[\x20-\x7e]*$/;
+function printableWidth(s) {
+  if (plain.test(s)) return s.length;
+  let n = 0;
+  for (let i = 0; i < s.length; ) {
+    const cp = s.codePointAt(i);
+    const len = cp > 65535 ? 2 : 1;
+    if (cp !== ESC) {
+      n += runeWidth(cp);
+      i += len;
+      continue;
+    }
+    const next = s.charCodeAt(i + 1);
+    if (Number.isNaN(next)) break;
+    if (next === 91) {
+      i += 2;
+      while (i < s.length) {
+        const c = s.charCodeAt(i++);
+        if (c >= 64 && c <= 126) break;
+      }
+    } else if (next === 93 || next === 80 || next === 95 || next === 94 || next === 88) {
+      i += 2;
+      while (i < s.length) {
+        const c = s.charCodeAt(i);
+        if (c === BEL) {
+          i++;
+          break;
+        }
+        if (c === ESC && s.charCodeAt(i + 1) === 92) {
+          i += 2;
+          break;
+        }
+        i++;
+      }
+    } else if (next >= 32 && next <= 47) {
+      i += 2;
+      while (i < s.length && s.charCodeAt(i) >= 32 && s.charCodeAt(i) <= 47) i++;
+      i++;
+    } else {
+      i += 2;
+    }
+  }
+  return n;
+}
+
+// src/scanner.ts
+var tokens = /\x1b\[(\d+)z|\n/g;
+function scanView(host, input, iteration) {
+  if (input.indexOf("\x1B[") === -1 && input.indexOf("\n") === -1) return input;
+  let out = "";
+  let line = "";
+  let rows = 0;
+  let last = 0;
+  const tracked = /* @__PURE__ */ new Map();
+  tokens.lastIndex = 0;
+  for (let m = tokens.exec(input); m !== null; m = tokens.exec(input)) {
+    line += input.slice(last, m.index);
+    last = m.index + m[0].length;
+    if (m[0] === "\n") {
+      out += line + "\n";
+      line = "";
+      rows++;
+      continue;
+    }
+    if (!host.enabled) continue;
+    const rid = m[0];
+    const id = host.resolve(rid);
+    if (id === void 0) continue;
+    const open = tracked.get(rid);
+    if (open) {
+      open.endX = printableWidth(line) - 1;
+      open.endY = rows;
+      host.emit(open);
+      tracked.delete(rid);
+    } else {
+      tracked.set(rid, new ZoneInfo({ id, rid, iteration, startX: printableWidth(line), startY: rows }));
+    }
+  }
+  return out + line + input.slice(last);
+}
+
+// src/manager.ts
+var IDENT_START = "\x1B";
+var IDENT_BRACKET = "[";
+var IDENT_END = "z";
+var markerCounter = 1e3;
+var prefixCounter = 0;
+var scanCounter = 0;
+var Manager = class {
+  #enabled = true;
+  #closed = false;
+  #zones = /* @__PURE__ */ new Map();
+  #ids = /* @__PURE__ */ new Map();
+  // user ID -> marker sequence
+  #rids = /* @__PURE__ */ new Map();
+  // marker sequence -> user ID
+  /** Stops the manager. Later scans still strip markers but no longer store zones. */
+  close() {
+    this.#closed = true;
+  }
+  /**
+   * Enables or disables the manager. When disabled, `mark()` returns its input
+   * unchanged and `scan()` only strips markers (from views cached earlier).
+   * Disabling also forgets every stored zone.
+   */
+  setEnabled(enabled) {
+    this.#enabled = enabled;
+    if (!enabled) this.#zones.clear();
+  }
+  /** Reports whether the manager is enabled. */
+  enabled() {
+    return this.#enabled;
+  }
+  /**
+   * Returns a prefix that is unique across calls, for components that build zone
+   * IDs of their own and must not collide with a sibling instance:
+   * `zone.mark(this.id + 'item-3', row)`.
+   */
+  newPrefix() {
+    return "zone_" + String(++prefixCounter) + "__";
+  }
+  /**
+   * Wraps `v` in a start and end marker so `scan()` can find where it ended up
+   * on screen. Returns `v` unchanged when the manager is disabled or when `id`
+   * or `v` is empty.
+   */
+  mark(id, v) {
+    if (!this.#enabled) return v;
+    if (id === "" || v === "") return v;
+    let gid = this.#ids.get(id);
+    if (gid === void 0) {
+      gid = IDENT_START + IDENT_BRACKET + String(++markerCounter) + IDENT_END;
+      this.#ids.set(id, gid);
+      this.#rids.set(gid, id);
+    }
+    return gid + v + gid;
+  }
+  /** Forgets the stored zone for `id`. It is recorded again by the next scan that sees it. */
+  clear(id) {
+    this.#zones.delete(id);
+  }
+  /**
+   * Returns the zone stored for `id`. For an ID that is not known (yet) it
+   * returns a zero zone whose `isZero()` is true and whose `inBounds()` is
+   * false, so `get('x').inBounds(msg)` is always safe to call.
+   */
+  get(id) {
+    return this.#zones.get(id) ?? new ZoneInfo();
+  }
+  /**
+   * Strips the markers out of a view and records where each zone is. Call it
+   * once, on the outermost view, not inside child components.
+   *
+   * Unlike upstream, which hands the zones to a background worker, the zones are
+   * stored before `scan()` returns, so `get()` right afterwards sees them.
+   */
+  scan(v) {
+    const iteration = ++scanCounter;
+    const found = [];
+    const out = scanView(
+      {
+        enabled: this.#enabled,
+        resolve: (rid) => this.#rids.get(rid),
+        emit: (zone) => found.push(zone)
+      },
+      v,
+      iteration
+    );
+    if (this.#closed) return out;
+    for (const zone of found) this.#zones.set(zone.id, zone);
+    for (const [id, zone] of this.#zones) {
+      if (zone.iteration !== iteration) this.#zones.delete(id);
+    }
+    return out;
+  }
+  #findInBounds(mouse) {
+    const ids = [...this.#zones.keys()].sort();
+    const hit = [];
+    for (const id of ids) {
+      const zone = this.#zones.get(id);
+      if (zone.inBounds(mouse)) hit.push(zone);
+    }
+    return hit;
+  }
+  /**
+   * Sends a `MsgZoneInBounds` to `model.update()` for every zone the mouse event
+   * is inside, in alphabetical order of their IDs. The results of `update()` are
+   * discarded.
+   */
+  anyInBounds(model, mouse) {
+    for (const zone of this.#findInBounds(mouse)) {
+      model.update(new MsgZoneInBounds(zone, mouse));
+    }
+  }
+  /**
+   * Like `anyInBounds()`, but the model returned by each `update()` is passed to
+   * the next one and returned at the end; the commands are combined with `Batch`.
+   */
+  anyInBoundsAndUpdate(model, mouse) {
+    const cmds = [];
+    for (const zone of this.#findInBounds(mouse)) {
+      let cmd;
+      [model, cmd] = model.update(new MsgZoneInBounds(zone, mouse));
+      cmds.push(cmd);
+    }
+    return [model, (0, import_bubbletea.Batch)(...cmds)];
+  }
+};
+function New() {
+  return new Manager();
+}
+
+// src/global.ts
+var DefaultManager;
+function manager() {
+  if (!DefaultManager) throw new Error("manager not initialized");
+  return DefaultManager;
+}
+function NewGlobal() {
+  if (DefaultManager) return;
+  DefaultManager = New();
+}
+function Close() {
+  manager().close();
+}
+function SetEnabled(v) {
+  manager().setEnabled(v);
+}
+function Enabled() {
+  return manager().enabled();
+}
+function NewPrefix() {
+  return manager().newPrefix();
+}
+function Mark(id, v) {
+  return manager().mark(id, v);
+}
+function Clear(id) {
+  manager().clear(id);
+}
+function Get(id) {
+  return manager().get(id);
+}
+function Scan(v) {
+  return manager().scan(v);
+}
+function AnyInBounds(model, mouse) {
+  manager().anyInBounds(model, mouse);
+}
+function AnyInBoundsAndUpdate(model, mouse) {
+  return manager().anyInBoundsAndUpdate(model, mouse);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AnyInBounds,
+  AnyInBoundsAndUpdate,
+  Clear,
+  Close,
+  DefaultManager,
+  Enabled,
+  Get,
+  Manager,
+  Mark,
+  MsgZoneInBounds,
+  New,
+  NewGlobal,
+  NewPrefix,
+  Scan,
+  SetEnabled,
+  ZoneInfo,
+  anyInBounds,
+  anyInBoundsAndUpdate,
+  clear,
+  close,
+  enabled,
+  get,
+  mark,
+  newGlobal,
+  newPrefix,
+  printableWidth,
+  runeWidth,
+  scan,
+  setEnabled
+});

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @oakoliver/bubblezone: mouse hit-zones for Bubble Tea.
+ *
+ * Port of lrstanley/bubblezone (Go) for @oakoliver/bubbletea. Wrap the part of
+ * a view you care about in `mark()`, run the whole view through `scan()` once,
+ * and ask `get(id).inBounds(msg)` when a mouse event arrives.
+ *
+ * @module
+ */
+export { Manager, New } from './manager.js';
+export { ZoneInfo } from './zoneinfo.js';
+export type { MouseLike } from './zoneinfo.js';
+export { MsgZoneInBounds } from './messages.js';
+export { printableWidth, runeWidth } from './width.js';
+export { DefaultManager, NewGlobal, Close, SetEnabled, Enabled, NewPrefix, Mark, Clear, Get, Scan, AnyInBounds, AnyInBoundsAndUpdate, newGlobal, close, setEnabled, enabled, newPrefix, mark, clear, get, scan, anyInBounds, anyInBoundsAndUpdate, } from './global.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,YAAY,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EACL,cAAc,EACd,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EACxE,WAAW,EAAE,oBAAoB,EACjC,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EACxE,WAAW,EAAE,oBAAoB,GAClC,MAAM,aAAa,CAAC"}