@unofficialbox/box-open-elements 0.11.0 → 0.13.0

package/dist/patterns/comments/types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The comment model.
+ *
+ * Kept separate from the component so the data contract does not depend on the
+ * class: a host that only transports comments — a controller, an adapter, a
+ * server route — imports these without pulling a custom element in with them.
+ */
+/** A button offered beneath the thread, e.g. "Resolve" or "Delete". */
+export type CommentAction = {
+    id: string;
+    label: string;
+    tone?: string;
+};
+/**
+ * One comment.
+ *
+ * `badge` is the generic pill beside the author — whatever short qualifier the
+ * surface wants to show. `box-annotation-thread` maps its own `toolLabel` onto
+ * it, which is why the base model does not name it after annotation tools.
+ */
+export type CommentEntry = {
+    author: string;
+    badge?: string;
+    body: string;
+    createdAt?: string;
+    id: string;
+    initials?: string;
+    status?: string;
+};
+/**
+ * A composed comment, before it has an id.
+ *
+ * `inReplyToId` carries the selected entry, so the same event serves both a new
+ * top-level comment and a reply — the host decides which by reading it.
+ */
+export type CommentSubmittedDetail = {
+    body: string;
+    inReplyToId: string | null;
+};

package/dist/patterns/comments/types.js

@@ -0,0 +1,8 @@
+/**
+ * The comment model.
+ *
+ * Kept separate from the component so the data contract does not depend on the
+ * class: a host that only transports comments — a controller, an adapter, a
+ * server route — imports these without pulling a custom element in with them.
+ */
+export {};

package/dist/patterns/preview/annotation-thread.d.ts

@@ -1,57 +1,76 @@
-import { BaseElement } from "../../core/index.js";
-export type AnnotationThreadAction = {
-    id: string;
-    label: string;
-    tone?: string;
-};
-export type AnnotationThreadEntry = {
-    author: string;
-    body: string;
-    createdAt?: string;
-    id: string;
-    initials?: string;
-    status?: string;
+import { CommentThread } from "../comments/index.js";
+import type { CommentAction, CommentEntry, CommentSubmittedDetail } from "../comments/index.js";
+/** @deprecated Prefer `CommentAction`; kept so existing hosts keep compiling. */
+export type AnnotationThreadAction = CommentAction;
+/** @deprecated Prefer `CommentSubmittedDetail`. */
+export type AnnotationThreadEntrySubmittedDetail = CommentSubmittedDetail;
+/**
+ * An annotation comment.
+ *
+ * A comment plus `toolLabel` — which annotation tool produced it (highlight,
+ * draw, stamp). That field is the only thing an annotation entry adds, which is
+ * why the rest of the model lives in `patterns/comments`.
+ */
+export type AnnotationThreadEntry = CommentEntry & {
     toolLabel?: string;
 };
-export type AnnotationThreadEntrySubmittedDetail = {
-    body: string;
-    inReplyToId: string | null;
+/**
+ * Where in the document a thread is attached.
+ *
+ * Every field is optional because anchors arrive in different shapes: a page
+ * number alone for a page-level note, a region for a drawn box, a quote for
+ * selected text. A thread with no anchor at all is a comment, and belongs on
+ * `box-comment-thread` instead.
+ */
+export type AnnotationAnchor = {
+    page?: number;
+    quote?: string;
+    region?: {
+        height: number;
+        width: number;
+        x: number;
+        y: number;
+    };
 };
-export declare class AnnotationThread extends BaseElement {
+/**
+ * A comment thread anchored to a place in a document.
+ *
+ * This is `box-comment-thread` plus the anchor. The distinction is the whole
+ * point: comments stand on their own — on a file, a task, a contract clause —
+ * and only become annotations when something ties them to a page, a region, or
+ * a run of selected text. Hosts that want the former should reach for
+ * `box-comment-thread` directly rather than for an annotation with no anchor.
+ *
+ * Every attribute, part and event of the underlying thread is inherited
+ * unchanged, so this remains a drop-in for the previous implementation.
+ */
+export declare class AnnotationThread extends CommentThread {
     static readonly tagName: string;
     static get observedAttributes(): string[];
-    private titleEl;
-    private messageEl;
-    private entriesEl;
-    private emptyEl;
-    private actionsEl;
-    private composerEl;
-    private composerInputEl;
-    private entriesSignature;
-    private actionsSignature;
-    get actions(): AnnotationThreadAction[];
-    set actions(value: AnnotationThreadAction[]);
-    get composable(): boolean;
-    set composable(value: boolean);
+    private anchorEl;
+    protected threadStyles(): string;
+    protected headerExtras(): string;
+    protected defaultHeading(): string;
+    protected emptyText(): string;
+    protected defaultComposerLabel(): string;
+    protected defaultPlaceholder(): string;
+    /**
+     * Annotations name their pill `toolLabel`. Mapping it here keeps that
+     * vocabulary for existing hosts while the base model stays generic.
+     */
+    protected entryBadge(entry: AnnotationThreadEntry): string | undefined;
+    /** Where in the document this thread sits. Null when unanchored. */
+    get anchor(): AnnotationAnchor | null;
+    set anchor(value: AnnotationAnchor | null);
     get entries(): AnnotationThreadEntry[];
     set entries(value: AnnotationThreadEntry[]);
-    get message(): string;
-    set message(value: string);
-    get selectedEntryId(): string;
-    set selectedEntryId(value: string);
-    get heading(): string;
-    set heading(value: string);
-    private parseJsonAttribute;
-    private emitAction;
-    private emitEntrySelected;
-    private submitComposer;
-    private entriesKey;
-    private actionsKey;
-    private rebuildEntries;
-    private patchEntrySelection;
-    private rebuildActions;
-    private patchActionLabels;
-    protected renderTemplate(): void;
-    protected setupListeners(): void;
+    /**
+     * The anchor in words.
+     *
+     * A region is described by its page rather than by its coordinates: the
+     * numbers locate the highlight for the renderer, but they tell a reader
+     * nothing, and a screen reader least of all.
+     */
+    private anchorLocation;
     protected update(): void;
 }