@hypit/hypit 0.1.4 → 0.1.5

package/packages/studio/src/ui/comments.ts

@@ -0,0 +1,233 @@
+import { feedbackClock } from "../feedback.js";
+import type { FeedbackComment, FeedbackMutation, FeedbackView } from "../feedback.js";
+import { icon } from "./icons.js";
+import type { Store } from "./selection.js";
+import type { Stage } from "./stage.js";
+
+type Anchor = Pick<FeedbackComment, "at">;
+
+export function createComments(store: Store, stage: Stage) {
+  const element = document.createElement("aside");
+  element.className = "comments-panel";
+  element.innerHTML = `
+    <div class="pane-heading comments-heading">
+      <div class="pane-title">${icon("comments")}<h2>Comments</h2><span data-count></span></div>
+      <button type="button" class="comments-icon" data-refresh aria-label="Refresh comments" title="Refresh comments">${icon("refresh")}</button>
+    </div>
+    <div class="comments-filters" role="group" aria-label="Filter comments">
+      <button type="button" data-filter="all" aria-pressed="true">All</button>
+      <button type="button" data-filter="open" aria-pressed="false">Open</button>
+      <button type="button" data-filter="done" aria-pressed="false">Done</button>
+    </div>
+    <div class="comments-error" role="status" aria-live="polite" hidden></div>
+    <div class="comments-list" aria-label="Comments"></div>
+    <form class="comment-composer">
+      <div class="comment-anchor">
+        <button type="button" class="comment-time" data-current-time title="Use current frame" aria-label="Use current frame">${icon("when")}<span>00:00.00</span></button>
+      </div>
+      <div class="comment-input">
+        <textarea rows="3" aria-label="Write a comment" placeholder="What would you like to change?" spellcheck="true" enterkeyhint="send"></textarea>
+        <div class="comment-input-actions">
+          <div class="comment-tools">
+            <button type="button" class="comments-icon" aria-label="Emoji — coming later" title="Emoji — coming later" disabled>${icon("smile")}</button>
+            <button type="button" class="comments-icon" aria-label="Draw — coming later" title="Draw — coming later" disabled>${icon("edit")}</button>
+          </div>
+          <button class="comment-submit" type="submit" aria-label="Send comment" title="Send comment (Enter)" disabled>${icon("send")}</button>
+        </div>
+      </div>
+    </form>`;
+  const list = element.querySelector<HTMLElement>(".comments-list")!;
+  const form = element.querySelector<HTMLFormElement>("form")!;
+  const input = form.querySelector<HTMLTextAreaElement>("textarea")!;
+  const submit = form.querySelector<HTMLButtonElement>(".comment-submit")!;
+  const counter = element.querySelector<HTMLElement>("[data-count]")!;
+  const timeLabel = form.querySelector<HTMLElement>("[data-current-time] span")!;
+  const errorView = element.querySelector<HTMLElement>(".comments-error")!;
+  let view: FeedbackView | undefined;
+  let filter = "all";
+  let selected: string | undefined;
+  let anchor: Anchor | undefined;
+  let busy = false;
+  let active = false;
+  let fetchId = 0;
+  let editing: { id: string; before: FeedbackComment; text: string } | undefined;
+
+  const showError = (error?: unknown): void => {
+    errorView.hidden = error === undefined;
+    errorView.textContent = error === undefined ? "" : error instanceof Error ? error.message : String(error);
+  };
+  const currentAnchor = (): Anchor | undefined => {
+    const state = store.current();
+    if (state === undefined) return undefined;
+    return {
+      at: state.playhead.frame * state.snapshot.space.frameRate.denominator / state.snapshot.space.frameRate.numerator,
+    };
+  };
+  const renderAnchor = (): void => {
+    timeLabel.textContent = feedbackClock(anchor?.at ?? 0);
+    submit.disabled = busy || view === undefined || anchor === undefined || input.value.trim().length === 0;
+  };
+  const capture = (): void => { stage.pause(); anchor = currentAnchor(); renderAnchor(); };
+  const button = (name: string, label: string, action: () => void): HTMLButtonElement => {
+    const node = document.createElement("button");
+    node.type = "button"; node.className = "comments-icon";
+    node.innerHTML = icon(name); node.title = label; node.setAttribute("aria-label", label);
+    node.disabled = busy;
+    node.addEventListener("click", (event) => { event.stopPropagation(); action(); });
+    return node;
+  };
+  const locate = (comment: FeedbackComment): void => {
+    stage.pause(); stage.showComposition();
+    const state = store.current();
+    if (state === undefined) return;
+    const frame = Math.round(comment.at * state.snapshot.space.frameRate.numerator / state.snapshot.space.frameRate.denominator);
+    store.seek(frame, "video");
+    selected = comment.id;
+    render();
+  };
+  const render = (): void => {
+    const focusedEdit = list.querySelector<HTMLTextAreaElement>(".comment-edit textarea");
+    const cursor = focusedEdit === document.activeElement && focusedEdit !== null
+      ? { start: focusedEdit.selectionStart, end: focusedEdit.selectionEnd } : undefined;
+    counter.textContent = view === undefined ? "" : String(view.comments.length);
+    // Notes are appended to the file in submission order. Number that order;
+    // time sorting and filters only change where a note is displayed.
+    const comments = [...view?.comments ?? []]
+      .map((comment, index) => ({ comment, number: index + 1 }))
+      .sort((a, b) => a.comment.at - b.comment.at)
+      .filter(({ comment }) => filter === "all" || (filter === "done") === (comment.resolved === true));
+    list.replaceChildren();
+    if (comments.length === 0) {
+      const empty = document.createElement("div");
+      empty.className = "comments-empty";
+      empty.innerHTML = `${icon(filter === "done" ? "check" : "comments")}<strong></strong><p></p>`;
+      empty.querySelector("strong")!.textContent = view === undefined ? "Loading comments…" : filter === "done" ? "No completed comments" : filter === "open" ? "All caught up" : "A note starts here";
+      empty.querySelector("p")!.textContent = filter === "all" ? "Pause on a frame and describe what you would like to change." : "Switch filters to see the other comments.";
+      list.append(empty);
+    }
+    for (const { comment, number } of comments) {
+      const row = document.createElement("article");
+      row.className = `comment-card${comment.resolved ? " resolved" : ""}${comment.id === selected ? " selected" : ""}`;
+      row.dataset.commentId = comment.id;
+      const head = document.createElement("div"); head.className = "comment-card-head";
+      const location = document.createElement("button"); location.type = "button"; location.className = "comment-location";
+      const label = document.createElement("span"); label.className = "comment-number"; label.textContent = `#${number}`;
+      const time = document.createElement("span"); time.className = "comment-time"; time.textContent = feedbackClock(comment.at);
+      location.append(time);
+      location.title = "Go to this frame"; location.addEventListener("click", () => locate(comment));
+      row.addEventListener("click", (event) => {
+        if ((event.target as Element).closest("button, form") !== null || window.getSelection()?.isCollapsed === false) return;
+        locate(comment);
+      });
+      const actions = document.createElement("div"); actions.className = "comment-actions";
+      const resolve = button("check", comment.resolved ? "Reopen comment" : "Mark complete", () => {
+        void mutate({ type: "replace", before: comment, comment: { ...comment, resolved: !comment.resolved } });
+      });
+      resolve.classList.toggle("is-done", comment.resolved === true);
+      resolve.setAttribute("aria-pressed", String(comment.resolved === true));
+      actions.append(label, resolve, button("edit", "Edit comment", () => {
+        editing = { id: comment.id, before: comment, text: comment.text }; selected = comment.id; render();
+        list.querySelector<HTMLTextAreaElement>(".comment-edit textarea")?.focus();
+      }), button("trash", "Delete comment", () => { void mutate({ type: "delete", before: comment }); }));
+      head.append(location, actions); row.append(head);
+      if (editing?.id === comment.id) {
+        const edit = document.createElement("form"); edit.className = "comment-edit";
+        const text = document.createElement("textarea"); text.rows = 3; text.value = editing.text;
+        text.setAttribute("aria-label", "Edit comment text");
+        text.addEventListener("input", () => { if (editing !== undefined) editing.text = text.value; });
+        const controls = document.createElement("div"); controls.className = "comment-edit-actions";
+        const cancel = document.createElement("button"); cancel.type = "button"; cancel.textContent = "Cancel";
+        cancel.addEventListener("click", () => { editing = undefined; render(); });
+        const save = document.createElement("button"); save.type = "submit"; save.textContent = "Save"; save.disabled = busy;
+        controls.append(cancel, save); edit.append(text, controls);
+        edit.addEventListener("submit", (event) => {
+          event.preventDefault();
+          if (editing === undefined || text.value.trim().length === 0) return;
+          void mutate({ type: "replace", before: editing.before, comment: { ...editing.before, text: text.value.trim() } }, () => { editing = undefined; });
+        }); row.append(edit);
+      } else {
+        const text = document.createElement("p"); text.className = "comment-text"; text.textContent = comment.text;
+        row.append(text);
+      }
+      list.append(row);
+    }
+    if (cursor !== undefined) {
+      const next = list.querySelector<HTMLTextAreaElement>(".comment-edit textarea");
+      next?.focus({ preventScroll: true }); next?.setSelectionRange(cursor.start, cursor.end);
+    }
+  };
+  const refresh = async (): Promise<void> => {
+    const request = ++fetchId;
+    try {
+      const response = await fetch("/__studio/feedback");
+      const data = await response.json() as FeedbackView & { error?: string };
+      if (!response.ok) throw new Error(data.error ?? "Could not read comments.");
+      if (request !== fetchId) return;
+      if (JSON.stringify(view) !== JSON.stringify(data)) { view = data; render(); }
+      showError(); renderAnchor();
+    } catch (error) { if (request === fetchId) showError(error); }
+  };
+  const mutate = async (mutation: FeedbackMutation, saved?: () => void): Promise<void> => {
+    if (busy) return;
+    busy = true; showError(); renderAnchor();
+    try {
+      const response = await fetch("/__studio/feedback", { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify(mutation) });
+      const data = await response.json() as FeedbackView & { error?: string };
+      if (!response.ok) throw new Error(data.error ?? "Could not save comment.");
+      ++fetchId; view = data; busy = false; saved?.();
+      if (mutation.type === "delete" && selected === mutation.before.id) selected = undefined;
+      if (mutation.type === "delete" && editing?.id === mutation.before.id) editing = undefined;
+      render();
+    } catch (error) { showError(error); }
+    finally { busy = false; renderAnchor(); }
+  };
+  form.addEventListener("submit", (event) => {
+    event.preventDefault();
+    if (view === undefined || anchor === undefined || input.value.trim().length === 0) return;
+    const comment: FeedbackComment = { id: `c-${crypto.randomUUID()}`, run: view.run, ...anchor, text: input.value.trim() };
+    void mutate({ type: "add", comment }, () => {
+      input.value = ""; input.style.height = ""; selected = comment.id; anchor = currentAnchor();
+    });
+  });
+  input.addEventListener("focus", () => { if (input.value.length === 0) capture(); else stage.pause(); });
+  input.addEventListener("input", () => {
+    input.style.height = "auto"; input.style.height = `${Math.min(180, input.scrollHeight)}px`; renderAnchor();
+  });
+  element.addEventListener("keydown", (event) => {
+    if (!(event.target instanceof HTMLTextAreaElement) || event.key !== "Enter") return;
+    // Some IMEs report the confirming Enter as keyCode 229 after compositionend.
+    if (event.isComposing || event.keyCode === 229 || event.shiftKey || event.altKey) return;
+    event.preventDefault();
+    event.stopPropagation();
+    if (!event.repeat) event.target.form?.requestSubmit();
+  });
+  document.addEventListener("pointerdown", (event) => {
+    if (!active || selected === undefined) return;
+    const row = event.target instanceof Element ? event.target.closest(".comment-card") : null;
+    if (row?.getAttribute("data-comment-id") === selected) return;
+    selected = undefined;
+    // Keep the clicked control and any unsaved editor mounted through pointerup.
+    list.querySelector(".comment-card.selected")?.classList.remove("selected");
+  });
+  form.querySelector("[data-current-time]")!.addEventListener("click", capture);
+  element.querySelector("[data-refresh]")!.addEventListener("click", () => { void refresh(); });
+  element.querySelectorAll<HTMLButtonElement>("[data-filter]").forEach((button) => button.addEventListener("click", () => {
+    filter = button.dataset.filter!;
+    element.querySelectorAll<HTMLButtonElement>("[data-filter]").forEach((item) => item.setAttribute("aria-pressed", String(item === button)));
+    render();
+  }));
+  store.subscribe(() => {
+    if (input.value.length === 0) { anchor = currentAnchor(); renderAnchor(); }
+  });
+  type Hot = { on(event: string, listener: () => void): void };
+  (import.meta as ImportMeta & { hot?: Hot }).hot?.on("studio:feedback-changed", () => { if (active) void refresh(); });
+  render();
+  return {
+    element,
+    activate(value: boolean) {
+      active = value;
+      stage.setReviewMode(value);
+      if (active) { stage.showComposition(); anchor ??= currentAnchor(); renderAnchor(); void refresh(); }
+    },
+  };
+}

package/packages/studio/src/ui/icons.ts

@@ -2,6 +2,11 @@ const paths: Readonly<Record<string, string>> = {
   brand: '<g transform="translate(0 1.282) scale(.091603) translate(-50 -180)"><path fill="currentColor" stroke="none" d="M303.78,277.82c-5.98-8.63-15.83-13.77-26.32-13.77h-93.41c-12.28,0-24.92,7.44-29.6,18.8l-28.26,75.82c-4.6,11.25-4.54,24.05,2.22,34.16,6.79,10.15,19.36,16.15,31.57,16.15h85.98c14.12,0,26.9-8.88,31.84-22.1l29.69-79.57c3.67-9.84,2.29-20.86-3.69-29.48v-.02h-.02ZM252.02,377.25c-.94,2.52-3.39,4.22-6.08,4.22h-83.45c-4.34,0-6.68-2.8-7.49-3.99s-2.5-4.43-.84-8.44l23.85-66.24c2.29-6.35,8.08-10.87,14.82-11.22.33-.02.67-.02,1.02-.02h75.41s12.51,1.42,9.29,14.61l-26.53,71.09h0ZM106.85,361.73s-22.36-11.59-17.66-32.66l29.67-82.23c4.78-13.25,17.36-22.09,31.45-22.09h95.02c6.25,0,12.1,3.03,15.71,8.14l13.89,19.68h-112.97c-8.7,0-16.49,5.41-19.52,13.57l-35.59,95.6h0ZM73.3,323.27s-22.37-11.59-17.66-32.66l29.67-82.23c4.79-13.25,17.37-22.09,31.45-22.09h89.91c6.25,0,12.1,3.03,15.71,8.14l13.89,19.68h-107.84c-8.7,0-16.49,5.41-19.52,13.57l-35.59,95.6h-.02Z"/></g>',
   code: '<path d="M9 7 4 12l5 5M15 7l5 5-5 5M13 4l-2 16"/>',
   edit: '<path d="m4 16-.8 4 4-.8L18.5 8.9 15.1 5.5 4 16Z"/><path d="m13.8 6.8 3.4 3.4"/>',
+  studio: '<rect x="3" y="4" width="18" height="16" rx="1.5"/><path d="M3 14h18M8 4v10M15 14v6"/>',
+  comments: '<path d="M6 17H5a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v9a2 2 0 0 1-2 2h-8l-5 4v-4Z"/><path d="M7 8h10M7 12h7"/>',
+  trash: '<path d="M3 6h18M9 6V3h6v3M6 6l1 15h10l1-15M10 10v7M14 10v7"/>',
+  send: '<path d="M12 20V4m-6 6 6-6 6 6"/>',
+  smile: '<circle cx="12" cy="12" r="9"/><path d="M8 14a4.5 4.5 0 0 0 8 0M8.5 9h.01M15.5 9h.01"/>',
   eye: '<path d="M2.5 12s3.5-6 9.5-6 9.5 6 9.5 6-3.5 6-9.5 6-9.5-6-9.5-6Z"/><circle cx="12" cy="12" r="2.5"/>',
   preview: '<rect x="3" y="4" width="18" height="14" rx="2"/><path d="m10 8 5 3.5-5 3.5V8ZM8 21h8"/>',
   tune: '<path d="M4 7h10M18 7h2M4 17h2M10 17h10"/><circle cx="16" cy="7" r="2"/><circle cx="8" cy="17" r="2"/>',