@box/threaded-annotations 3.2.3 → 4.0.0

package/dist/chunks/messages-view.js

@@ -15,26 +15,26 @@ import '../styles/messages-view.css';var u = {
 	repliesContainer: "_repliesContainer_gor1q_56",
 	messagesFade: "_messagesFade_gor1q_62"
 }, d = ({ messages: d, isResolved: f = !1, resolvedBy: p, resolvedAt: m, maxCharacterCount: h, onDelete: g, onThreadDelete: _, onAvatarClick: v, onCopyLink: y, onEdit: b, onEditError: x, onResolve: S, onUnresolve: C, userSelectorProps: w, annotationTarget: T, onAnnotationBadgeClick: E, originalContentDeleted: D }) => {
-	let { viewState: O, dispatch: k, isAnnotations: A, scrollTargetMessageId: j } = t(), M = s(null), N = O !== e.Collapsed, P = O === e.Composing, F = d.length > 2, I = F && !N, { handleScroll: L, isOverflowing: R } = a({
+	let { viewState: O, dispatch: k, isAnnotations: A } = t(), j = s(null), M = O !== e.Collapsed, N = O === e.Composing, P = d.length > 2, F = P && !M, { handleScroll: I, isOverflowing: L } = a({
 		messageCount: d.length,
-		containerRef: M,
+		containerRef: j,
 		enabled: A,
-		isExpanded: N,
-		suppressAutoScroll: I || !!j
-	}), z = d[0], B = d.slice(1), V = B.length >= 1, H = B[B.length - 1], U = B.slice(0, -1), W = F && !N;
-	if (!z) return null;
-	let G = U[U.length - 1]?.author, K = U.length >= 2 ? U[U.length - 2].author : void 0, q = () => k({ type: "EXPAND" });
+		isExpanded: M,
+		suppressAutoScroll: F
+	}), R = d[0], z = d.slice(1), B = z.length >= 1, V = z[z.length - 1], H = z.slice(0, -1), U = P && !M;
+	if (!R) return null;
+	let W = H[H.length - 1]?.author, G = H.length >= 2 ? H[H.length - 2].author : void 0, K = () => k({ type: "EXPAND" });
 	return /* @__PURE__ */ l("div", {
-		className: o(u.messagesViewWrapper, R && u.overflowing, R && P && u.withEditorBelow),
+		className: o(u.messagesViewWrapper, L && u.overflowing, L && N && u.withEditorBelow),
 		children: [/* @__PURE__ */ l("div", {
-			ref: M,
+			ref: j,
 			className: o(u.messagesView, A && u.scrollable),
-			onScroll: L,
+			onScroll: I,
 			children: [
 				/* @__PURE__ */ c(i, {
-					...z,
-					hasReplies: V,
-					showThreadedIndicator: V || f,
+					...R,
+					hasReplies: B,
+					showThreadedIndicator: B || f,
 					isResolved: f,
 					maxCharacterCount: h,
 					onDelete: g,
@@ -51,15 +51,15 @@ import '../styles/messages-view.css';var u = {
 					onAnnotationBadgeClick: E,
 					originalContentDeleted: D
 				}),
-				W && G && /* @__PURE__ */ c(r, {
-					lastUser: G,
-					repliesCount: U.length,
-					secondLastUser: K,
-					onShowReplies: q
+				U && W && /* @__PURE__ */ c(r, {
+					lastUser: W,
+					repliesCount: H.length,
+					secondLastUser: G,
+					onShowReplies: K
 				}),
-				N && U.length > 0 && /* @__PURE__ */ c("div", {
+				M && H.length > 0 && /* @__PURE__ */ c("div", {
 					className: u.repliesContainer,
-					children: U.map((e) => /* @__PURE__ */ c(i, {
+					children: H.map((e) => /* @__PURE__ */ c(i, {
 						...e,
 						showThreadedIndicator: !0,
 						isResolved: f,
@@ -74,8 +74,8 @@ import '../styles/messages-view.css';var u = {
 						userSelectorProps: w
 					}, e.id))
 				}),
-				H && /* @__PURE__ */ c(i, {
-					...H,
+				V && /* @__PURE__ */ c(i, {
+					...V,
 					showThreadedIndicator: f,
 					isResolved: f,
 					maxCharacterCount: h,
@@ -93,7 +93,7 @@ import '../styles/messages-view.css';var u = {
 					createdAt: m
 				})
 			]
-		}), R && /* @__PURE__ */ c("div", { className: u.messagesFade })]
+		}), L && /* @__PURE__ */ c("div", { className: u.messagesFade })]
 	});
 };
 export { d as t };

package/dist/chunks/threaded-annotations2.js

@@ -2,91 +2,85 @@ import { THREADED_ANNOTATIONS_PORTAL as e } from "../esm/lib/v2/constants.js";
 import { MessageEditor as t } from "../esm/lib/components/v2/message-editor/message-editor.js";
 import { ThreadViewState as n, ThreadedAnnotationsProvider as r, useThreadedAnnotationsContext as i } from "../esm/lib/v2/threaded-annotations-context.js";
 import { t as a } from "./messages-view.js";
-import { useScrollToMessage as o } from "../esm/lib/v2/hooks/useScrollToMessage.js";
-import { buildMentionContent as s } from "../esm/lib/v2/utils/build-mention-content.js";
-import c from "clsx";
-import { useCallback as l, useEffect as u, useMemo as d, useRef as f } from "react";
-import { jsx as p, jsxs as m } from "react/jsx-runtime";
-import '../styles/threaded-annotations2.css';var h = {
+import { buildMentionContent as o } from "../esm/lib/v2/utils/build-mention-content.js";
+import s from "clsx";
+import { useCallback as c, useEffect as l, useMemo as u, useRef as d } from "react";
+import { jsx as f, jsxs as p } from "react/jsx-runtime";
+import '../styles/threaded-annotations2.css';var m = {
 	threadedAnnotations: "_threadedAnnotations_16hhz_1",
 	expandable: "_expandable_16hhz_10",
 	annotations: "_annotations_16hhz_18",
 	highlighted: "_highlighted_16hhz_18"
-}, g = ({ messages: r, isResolved: g = !1, resolvedBy: _, resolvedAt: v, maxCharacterCount: y, onDelete: b, onThreadDelete: x, onAvatarClick: S, onCopyLink: C, onEdit: w, onEditError: T, onResolve: E, onUnresolve: D, onPost: O, onPostError: k, userSelectorProps: A, onEditorOpenChange: j, annotationTarget: M, onAnnotationBadgeClick: N, originalContentDeleted: P, scrollToMessageId: F, onScrollToMessageComplete: I, isHighlighted: L = !1 }) => {
-	let { viewState: R, dispatch: z, editingMessageId: B, replyMention: V, isReplyDisabled: H, isAnnotations: U } = i(), W = f(null), G = R !== n.Collapsed, K = r.length > 2, q = R === n.Collapsed && (K || !H && !g);
-	o({
-		containerRef: W,
-		messages: r,
-		scrollToMessageId: F,
-		onScrollToMessageComplete: I
-	}), u(() => {
-		B && !r.some((e) => e.id === B) && z({ type: "CLEAR_EDIT" });
+}, h = ({ messages: r, isResolved: h = !1, resolvedBy: g, resolvedAt: _, maxCharacterCount: v, onDelete: y, onThreadDelete: b, onAvatarClick: x, onCopyLink: S, onEdit: C, onEditError: w, onResolve: T, onUnresolve: E, onPost: D, onPostError: O, userSelectorProps: k, onEditorOpenChange: A, annotationTarget: j, onAnnotationBadgeClick: M, originalContentDeleted: N, isHighlighted: P = !1 }) => {
+	let { viewState: F, dispatch: I, editingMessageId: L, replyMention: R, isReplyDisabled: z, isAnnotations: B } = i(), V = d(null), H = F !== n.Collapsed, U = r.length > 2, W = F === n.Collapsed && (U || !z && !h);
+	l(() => {
+		L && !r.some((e) => e.id === L) && I({ type: "CLEAR_EDIT" });
 	}, [
-		B,
+		L,
 		r,
-		z
-	]), u(() => {
-		j?.(G);
-	}, [G, j]), u(() => {
-		if (!G) return;
+		I
+	]), l(() => {
+		A?.(H);
+	}, [H, A]), l(() => {
+		if (!H) return;
 		let t = `[${Object.keys(e)[0]}]`, n = (e) => {
 			let n = e.target;
-			W.current?.contains(n) || document.querySelector(t)?.contains(n) || z({ type: "COLLAPSE" });
+			V.current?.contains(n) || document.querySelector(t)?.contains(n) || I({ type: "COLLAPSE" });
 		};
 		return document.addEventListener("mousedown", n), () => document.removeEventListener("mousedown", n);
-	}, [G, z]);
-	let J = r.length === 0, Y = l(() => z({ type: "CLEAR_MENTION" }), [z]), X = d(() => V ? s(V) : null, [V]), Z = l((e) => {
-		if (!q) return;
+	}, [H, I]);
+	let G = r.length === 0, K = c(() => I({ type: "CLEAR_MENTION" }), [I]), q = u(() => R ? o(R) : null, [R]), J = c((e) => {
+		if (!W) return;
 		let t = e.target;
-		!e.currentTarget.contains(t) || t.closest("[data-no-expand]") || z({ type: "EXPAND" });
-	}, [q, z]);
-	return U && J ? /* @__PURE__ */ p(t, {
+		!e.currentTarget.contains(t) || t.closest("[data-no-expand]") || I({ type: "EXPAND" });
+	}, [W, I]);
+	return B && G ? /* @__PURE__ */ f(t, {
 		isFirstAnnotation: !0,
-		maxCharacterCount: y,
-		onPost: O,
-		onPostError: k,
-		onPostSuccess: Y,
-		userSelectorProps: A
-	}) : /* @__PURE__ */ m("div", {
-		ref: W,
-		className: c(h.threadedAnnotations, q && h.expandable, U && h.annotations, L && h.highlighted),
-		"data-thread-expandable": q ? !0 : void 0,
-		"data-thread-highlighted": L ? !0 : void 0,
-		onClick: q ? Z : void 0,
-		children: [/* @__PURE__ */ p(a, {
+		maxCharacterCount: v,
+		onPost: D,
+		onPostError: O,
+		onPostSuccess: K,
+		userSelectorProps: k
+	}) : /* @__PURE__ */ p("div", {
+		ref: V,
+		className: s(m.threadedAnnotations, W && m.expandable, B && m.annotations, P && m.highlighted),
+		"data-thread-expandable": W ? !0 : void 0,
+		"data-thread-highlighted": P ? !0 : void 0,
+		onClick: W ? J : void 0,
+		children: [/* @__PURE__ */ f(a, {
 			messages: r,
-			isResolved: g,
-			resolvedBy: _,
-			resolvedAt: v,
-			maxCharacterCount: y,
-			onDelete: b,
-			onThreadDelete: x,
-			onAvatarClick: S,
-			onCopyLink: C,
-			onEdit: w,
-			onEditError: T,
-			onResolve: E,
-			onUnresolve: D,
-			userSelectorProps: A,
-			annotationTarget: M,
-			onAnnotationBadgeClick: N,
-			originalContentDeleted: P
-		}), R === n.Composing && /* @__PURE__ */ p(t, {
-			initialContent: X,
-			maxCharacterCount: y,
-			onPost: O,
-			onPostError: k,
-			onPostSuccess: Y,
+			isResolved: h,
+			resolvedBy: g,
+			resolvedAt: _,
+			maxCharacterCount: v,
+			onDelete: y,
+			onThreadDelete: b,
+			onAvatarClick: x,
+			onCopyLink: S,
+			onEdit: C,
+			onEditError: w,
+			onResolve: T,
+			onUnresolve: E,
+			userSelectorProps: k,
+			annotationTarget: j,
+			onAnnotationBadgeClick: M,
+			originalContentDeleted: N
+		}), F === n.Composing && /* @__PURE__ */ f(t, {
+			initialContent: q,
+			maxCharacterCount: v,
+			onPost: D,
+			onPostError: O,
+			onPostSuccess: K,
 			isReply: !0,
-			userSelectorProps: A
+			userSelectorProps: k
 		})]
 	});
-}, _ = (e) => /* @__PURE__ */ p(r, {
-	defaultExpanded: e.messages.length === 0,
+}, g = (e) => /* @__PURE__ */ f(r, {
+	defaultExpanded: e.defaultExpanded || e.messages.length === 0,
 	isReplyDisabled: e.isReplyDisabled || e.isResolved,
 	isEditDisabled: e.isEditDisabled || e.isResolved,
 	isAnnotations: e.isAnnotations,
 	collapsed: e.collapsed,
-	children: /* @__PURE__ */ p(g, { ...e })
+	children: /* @__PURE__ */ f(h, { ...e })
 });
-export { _ as t };
+export { g as t };

package/dist/esm/lib/v2/threaded-annotations-context.js

@@ -3,15 +3,15 @@ import { jsx as o } from "react/jsx-runtime";
 var s = /* @__PURE__ */ function(e) {
 	return e.Collapsed = "collapsed", e.RepliesOnly = "repliesOnly", e.Composing = "composing", e;
 }({}), c = /*#__PURE__*/ e(void 0), l = ({ children: e, defaultExpanded: n = !1, isReplyDisabled: s = !1, isEditDisabled: l = !1, collapsed: u = !1, isAnnotations: d = !1 }) => {
-	let [f, p] = a(() => n ? s ? "repliesOnly" : "composing" : "collapsed"), [m, h] = a(null), [g, _] = a(null), [v, y] = a(null);
+	let [f, p] = a(() => n ? s ? "repliesOnly" : "composing" : "collapsed"), [m, h] = a(null), [g, _] = a(null);
 	r(() => {
 		s ? (p((e) => e === "composing" ? "collapsed" : e), h(null)) : p((e) => e === "repliesOnly" ? "composing" : e);
 	}, [s]), r(() => {
 		l && _(null);
 	}, [l]), r(() => {
-		u && (p("collapsed"), h(null), _(null), y(null));
+		u && (p("collapsed"), h(null), _(null));
 	}, [u]);
-	let b = t((e) => {
+	let v = t((e) => {
 		switch (e.type) {
 			case "EXPAND":
 				p((e) => e === "collapsed" ? s ? "repliesOnly" : "composing" : e);
@@ -26,39 +26,31 @@ var s = /* @__PURE__ */ function(e) {
 				_(null);
 				break;
 			case "COLLAPSE":
-				p("collapsed"), h(null), _(null), y(null);
+				p("collapsed"), h(null), _(null);
 				break;
 			case "CLEAR_MENTION":
 				h(null);
 				break;
-			case "SET_SCROLL_TARGET":
-				y(e.id), p((e) => e === "collapsed" ? s ? "repliesOnly" : "composing" : e);
-				break;
-			case "CLEAR_SCROLL_TARGET":
-				y(null);
-				break;
 		}
-	}, [s, l]), x = i(() => ({
+	}, [s, l]), y = i(() => ({
 		viewState: f,
 		replyMention: m,
 		editingMessageId: g,
-		scrollTargetMessageId: v,
 		isAnnotations: d,
 		isReplyDisabled: s,
 		isEditDisabled: l,
-		dispatch: b
+		dispatch: v
 	}), [
 		f,
 		m,
 		g,
-		v,
 		d,
 		s,
 		l,
-		b
+		v
 	]);
 	return /* @__PURE__ */ o(c.Provider, {
-		value: x,
+		value: y,
 		children: e
 	});
 }, u = () => {

package/dist/types/lib/v2/stories/shared.d.ts

@@ -7,13 +7,12 @@ export declare const defaultUserSelectorProps: Omit<import('@box/user-selector')
 export declare const DefaultThreadedAnnotations: (props: ThreadedAnnotationsProps) => import("react/jsx-runtime").JSX.Element;
 interface InteractiveModuleBaseProps {
     initialMessages?: TextMessageType[];
+    defaultExpanded?: boolean;
     isEditDisabled?: boolean;
     isHighlighted?: boolean;
     isReplyDisabled?: boolean;
     maxCharacterCount?: number;
     onCopyLink?: (id: string) => void;
-    scrollToMessageId?: string;
-    onScrollToMessageComplete?: (messageId: string, found: boolean) => void;
 }
 type InteractiveModuleProps = (InteractiveModuleBaseProps & {
     isAnnotations: true;

package/dist/types/lib/v2/threaded-annotations-context.d.ts

@@ -30,13 +30,6 @@ export type ThreadEvent = {
     type: 'COLLAPSE';
 } | {
     type: 'CLEAR_MENTION';
-}
-/** Mark a message as the pending scroll target and expand the thread so hidden replies mount. */
- | {
-    type: 'SET_SCROLL_TARGET';
-    id: string;
-} | {
-    type: 'CLEAR_SCROLL_TARGET';
 };
 export interface ThreadedAnnotationsContextValue {
     viewState: ThreadViewState;
@@ -46,11 +39,6 @@ export interface ThreadedAnnotationsContextValue {
      * `isEditDisabled` or `collapsed` flip true, or when the id disappears from the messages list.
      */
     editingMessageId: string | null;
-    /**
-     * Id of the message to scroll into view, or null. Set via SET_SCROLL_TARGET (which also expands
-     * the thread). Cleared once the scroll runs, or on COLLAPSE / when `collapsed` flips true.
-     */
-    scrollTargetMessageId: string | null;
     /** Whether the component is rendered in annotation mode (scrollable, fixed-height) vs comments mode. */
     isAnnotations: boolean;
     /** When true, globally disables replies (hides reply buttons and blocks editor opening on click). */

package/dist/types/lib/v2/threaded-annotations.d.ts

@@ -44,13 +44,11 @@ interface ThreadedAnnotationsBaseProps {
     /** When true, collapses the editor and replies panel. */
     collapsed?: boolean;
     /**
-     * Scrolls the message with this id into view (comments mode only). When the message is a
-     * hidden (middle) reply, the thread expands first so the row mounts. Ignored when the id
-     * is not in `messages`, or in annotations mode where the messages list scrolls internally.
+     * When true, the thread mounts expanded (all replies visible, editor open unless replies are
+     * disabled) instead of collapsed. Initial state only — changing it after mount has no effect,
+     * and `collapsed` always wins. Threads with no messages always mount expanded.
      */
-    scrollToMessageId?: string;
-    /** Called after a scroll attempt. `found` is false when `scrollToMessageId` was not in the DOM. */
-    onScrollToMessageComplete?: (messageId: string, found: boolean) => void;
+    defaultExpanded?: boolean;
     /** When true, applies a visual highlight (border + background tint) to the thread card. Not a focus state. */
     isHighlighted?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@box/threaded-annotations",
-    "version": "3.2.3",
+    "version": "4.0.0",
     "license": "SEE LICENSE IN LICENSE",
     "dependencies": {
         "@floating-ui/dom": "^1.6.0",

package/dist/esm/lib/v2/hooks/useScrollToMessage.js

@@ -1,37 +0,0 @@
-import { useThreadedAnnotationsContext as e } from "../threaded-annotations-context.js";
-import { useEffect as t, useLayoutEffect as n } from "react";
-var r = ({ containerRef: r, messages: i, scrollToMessageId: a, onScrollToMessageComplete: o }) => {
-	let { scrollTargetMessageId: s, dispatch: c, isAnnotations: l } = e();
-	t(() => {
-		if (!(l || !a)) {
-			if (!i.some((e) => e.id === a)) {
-				o?.(a, !1);
-				return;
-			}
-			c({
-				type: "SET_SCROLL_TARGET",
-				id: a
-			});
-		}
-	}, [
-		l,
-		a,
-		i,
-		c,
-		o
-	]), n(() => {
-		if (l || !s) return;
-		let e = r.current?.querySelector(`[data-message-id="${CSS.escape(s)}"]`);
-		e?.scrollIntoView({
-			behavior: "smooth",
-			block: "nearest"
-		}), o?.(s, !!e), c({ type: "CLEAR_SCROLL_TARGET" });
-	}, [
-		l,
-		s,
-		c,
-		o,
-		r
-	]);
-};
-export { r as useScrollToMessage };

package/dist/types/lib/v2/hooks/useScrollToMessage.d.ts

@@ -1,24 +0,0 @@
-import { RefObject } from 'react';
-import { TextMessageType } from '../types/message-types';
-interface UseScrollToMessageProps {
-    /** Scroll container that holds the message elements (`[data-message-id]`). */
-    containerRef: RefObject<HTMLElement | null>;
-    /** Messages in the thread; used to ignore unknown `scrollToMessageId` values. */
-    messages: TextMessageType[];
-    /**
-     * Id of the message to scroll into view. Setting it expands the thread (so hidden replies
-     * mount) and then scrolls the matching element into view. Ignored when not in `messages`.
-     * Only active in comments mode (no internal messages scroll); ignored in annotations mode.
-     */
-    scrollToMessageId?: string;
-    /** Called after a scroll attempt. `found` is false when the id was not in the DOM. */
-    onScrollToMessageComplete?: (messageId: string, found: boolean) => void;
-}
-/**
- * Wires the declarative `scrollToMessageId` prop to the thread's scroll behavior in comments
- * mode: registers the target (which expands the thread), then scrolls the matching element
- * into view via the nearest outer scroll container. No-op in annotations mode where the
- * messages list has its own internal scroll.
- */
-export declare const useScrollToMessage: ({ containerRef, messages, scrollToMessageId, onScrollToMessageComplete, }: UseScrollToMessageProps) => void;
-export {};