@veltdev/types-dev 6.0.18 → 6.0.20

package/app/models/data/comment-utils.data.model.d.ts

@@ -7,6 +7,25 @@ export interface IUnreadCommentsCount {
     count: number;
 }
 export type UnreadCommentsCount = IUnreadCommentsCount | null;
+/**
+ * Config for `commentElement.enableIdScopedAnchoring(config)` and
+ * `<velt-comments id-scoped-anchoring>` (which also accepts `true` / `false`).
+ *
+ * Use it when several documents are set (`setDocuments`) and only some of them should use
+ * id-scoped anchoring, e.g. comments made on another page that can only be matched by element id.
+ */
+export interface IdScopedAnchoringConfig {
+    /**
+     * Client document ids (the ids passed to `setDocuments`) whose comment pins use id-scoped
+     * anchoring. Pins of every other document resolve as they do with the feature off.
+     *
+     * - Omitted: every document (same as calling `enableIdScopedAnchoring()` with no config).
+     * - `[]`: no document.
+     *
+     * Calling `enableIdScopedAnchoring` again replaces the list.
+     */
+    documentIds?: string[];
+}
 export interface TransformContext {
     containerSelector: string;
     transforms: {

package/app/models/element/comment-element.model.d.ts

@@ -8,7 +8,7 @@ import { AcceptSuggestionRequest, RejectSuggestionRequest, AcceptCommentAnnotati
 import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
 import { SuggestionAcceptEvent, SuggestionRejectEvent, AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, AssignToConfig, AssignUserEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, ComposerTextChangeEvent, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkResponse, PageModeComposerConfig, RejectCommentAnnotationEvent, SubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarCustomActionsState, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
-import { CommentContextProvider, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
+import { CommentContextProvider, IdScopedAnchoringConfig, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
 import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
 import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
@@ -1397,8 +1397,15 @@ export declare class CommentElement {
    * saved path, else on the id element itself with the saved position percentages), and is not
    * shown where the id is absent, duplicated or hidden. New pins also skip framework-generated ids (React `useId`,
    * Radix) when choosing the id to root at. Applies to existing pins. Defaults to disabled.
-   */
-  public enableIdScopedAnchoring: () => void;
+   *
+   * With several documents set, pass `{ documentIds }` to limit it to those client document ids;
+   * pins of the other documents keep the default resolution. No `documentIds` = every document,
+   * `[]` = none; a `documentIds` that is not an array = none (with a console warning). Calling it again
+   * (or setting `<velt-comments id-scoped-anchoring>`) replaces the list, and pins already on the page
+   * are placed again.
+   * @param config optional {@link IdScopedAnchoringConfig}
+   */
+  public enableIdScopedAnchoring: (config?: IdScopedAnchoringConfig) => void;
 
   /**
    * To disable id-scoped anchoring. Pins resolve through the default anchor resolution,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types-dev",
-    "version": "6.0.18",
+    "version": "6.0.20",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [