@ckeditor/ckeditor5-comments 36.0.1 → 37.0.0

package/lang/translations/uk.po

@@ -36,14 +36,30 @@ msgctxt "The placeholder for the reply field."
 msgid "Reply..."
 msgstr "Відповісти..."
 
+msgctxt "The placeholder for the reply field when the comment thread is resolved."
+msgid "Reply to reopen discussion..."
+msgstr "Відповісти, щоб відновити обговорення..."
+
 msgctxt "The placeholder for the new commend field."
 msgid "Write a comment..."
 msgstr "Написати коментар..."
 
+msgctxt "The information that comment was made on element and has no context"
+msgid "Comment was made on an element"
+msgstr "Було зроблено коментар до елемента"
+
 msgctxt "The label for the button that enables editing a comment."
 msgid "Edit"
 msgstr "Редагувати"
 
+msgctxt "The label for the button that resolves a comment thread."
+msgid "Resolve"
+msgstr "Вирішити"
+
+msgctxt "The label for the button that reopens a resolved comment thread."
+msgid "Reopen"
+msgstr "Відновити"
+
 msgctxt "The label for the button that deletes a comment."
 msgid "Remove"
 msgstr "Видалити"
@@ -60,6 +76,10 @@ msgctxt "The confirmation message shown after pressing the delete comment thread
 msgid "Delete comment thread?"
 msgstr "Видати ланцюжок коментарів?"
 
+msgctxt "A message informing that the comment has been resolved"
+msgid "Marked as resolved"
+msgstr "Позначено як вирішене"
+
 msgctxt "The tooltip for the comment toolbar button."
 msgid "Comment"
 msgstr "Коментар"
@@ -83,3 +103,11 @@ msgstr "Показане ім'я автора походить із зовніш
 msgctxt "The additional information that displayed author name comes from imported Word file."
 msgid "EXTERNAL_IMPORT_WORD_AVATAR"
 msgstr "Показане ім'я автора походить із документу Word імпортованого %0"
+
+msgctxt "The label for the comments archive dropdown UI."
+msgid "COMMENTS_ARCHIVE"
+msgstr "Архів коментарів"
+
+msgctxt "The information that comments archive is empty."
+msgid "EMPTY_COMMENTS_ARCHIVE"
+msgstr "Немає архівних гілок коментарів."

package/lang/translations/ur.po

@@ -34,14 +34,30 @@ msgctxt "The placeholder for the reply field."
 msgid "Reply..."
 msgstr "جواب۔۔۔"
 
+msgctxt "The placeholder for the reply field when the comment thread is resolved."
+msgid "Reply to reopen discussion..."
+msgstr ""
+
 msgctxt "The placeholder for the new commend field."
 msgid "Write a comment..."
 msgstr "تبصرہ کریں۔۔۔"
 
+msgctxt "The information that comment was made on element and has no context"
+msgid "Comment was made on an element"
+msgstr ""
+
 msgctxt "The label for the button that enables editing a comment."
 msgid "Edit"
 msgstr "ترمیم"
 
+msgctxt "The label for the button that resolves a comment thread."
+msgid "Resolve"
+msgstr ""
+
+msgctxt "The label for the button that reopens a resolved comment thread."
+msgid "Reopen"
+msgstr ""
+
 msgctxt "The label for the button that deletes a comment."
 msgid "Remove"
 msgstr "حذف کریں"
@@ -58,6 +74,10 @@ msgctxt "The confirmation message shown after pressing the delete comment thread
 msgid "Delete comment thread?"
 msgstr "تبصرے کا دھاگہ حذف کریں؟"
 
+msgctxt "A message informing that the comment has been resolved"
+msgid "Marked as resolved"
+msgstr ""
+
 msgctxt "The tooltip for the comment toolbar button."
 msgid "Comment"
 msgstr "تبصرہ"
@@ -81,3 +101,11 @@ msgstr ""
 msgctxt "The additional information that displayed author name comes from imported Word file."
 msgid "EXTERNAL_IMPORT_WORD_AVATAR"
 msgstr ""
+
+msgctxt "The label for the comments archive dropdown UI."
+msgid "COMMENTS_ARCHIVE"
+msgstr ""
+
+msgctxt "The information that comments archive is empty."
+msgid "EMPTY_COMMENTS_ARCHIVE"
+msgstr ""

package/lang/translations/vi.po

@@ -33,14 +33,30 @@ msgctxt "The placeholder for the reply field."
 msgid "Reply..."
 msgstr "Trả lời..."
 
+msgctxt "The placeholder for the reply field when the comment thread is resolved."
+msgid "Reply to reopen discussion..."
+msgstr "Trả lời để mở lại cuộc thảo luận..."
+
 msgctxt "The placeholder for the new commend field."
 msgid "Write a comment..."
 msgstr "Viết bình luận..."
 
+msgctxt "The information that comment was made on element and has no context"
+msgid "Comment was made on an element"
+msgstr "Bình luận được tạo trên một yếu tố"
+
 msgctxt "The label for the button that enables editing a comment."
 msgid "Edit"
 msgstr "Chỉnh sửa"
 
+msgctxt "The label for the button that resolves a comment thread."
+msgid "Resolve"
+msgstr "Xử lí"
+
+msgctxt "The label for the button that reopens a resolved comment thread."
+msgid "Reopen"
+msgstr "Mở lại"
+
 msgctxt "The label for the button that deletes a comment."
 msgid "Remove"
 msgstr "Xóa"
@@ -57,6 +73,10 @@ msgctxt "The confirmation message shown after pressing the delete comment thread
 msgid "Delete comment thread?"
 msgstr "Xóa chuỗi bình luận?"
 
+msgctxt "A message informing that the comment has been resolved"
+msgid "Marked as resolved"
+msgstr "Đánh dấu là đã xử lí"
+
 msgctxt "The tooltip for the comment toolbar button."
 msgid "Comment"
 msgstr "Bình luận"
@@ -80,3 +100,11 @@ msgstr "Tên tác giả được hiển thị đến từ nguồn bên ngoài  (
 msgctxt "The additional information that displayed author name comes from imported Word file."
 msgid "EXTERNAL_IMPORT_WORD_AVATAR"
 msgstr "Tên tác giả được hiển thị đến từ một tài liệu Word do %0 nhập"
+
+msgctxt "The label for the comments archive dropdown UI."
+msgid "COMMENTS_ARCHIVE"
+msgstr "Kho lưu trữ bình luận"
+
+msgctxt "The information that comments archive is empty."
+msgid "EMPTY_COMMENTS_ARCHIVE"
+msgstr "Không có chủ đề bình luận nào được lưu trữ."

package/lang/translations/zh-cn.po

@@ -33,14 +33,30 @@ msgctxt "The placeholder for the reply field."
 msgid "Reply..."
 msgstr "回复..."
 
+msgctxt "The placeholder for the reply field when the comment thread is resolved."
+msgid "Reply to reopen discussion..."
+msgstr "回复以重新开启讨论……"
+
 msgctxt "The placeholder for the new commend field."
 msgid "Write a comment..."
 msgstr "编写评论..."
 
+msgctxt "The information that comment was made on element and has no context"
+msgid "Comment was made on an element"
+msgstr "对元素进行了评论"
+
 msgctxt "The label for the button that enables editing a comment."
 msgid "Edit"
 msgstr "编辑"
 
+msgctxt "The label for the button that resolves a comment thread."
+msgid "Resolve"
+msgstr "解决"
+
+msgctxt "The label for the button that reopens a resolved comment thread."
+msgid "Reopen"
+msgstr "重新开启"
+
 msgctxt "The label for the button that deletes a comment."
 msgid "Remove"
 msgstr "删除"
@@ -57,6 +73,10 @@ msgctxt "The confirmation message shown after pressing the delete comment thread
 msgid "Delete comment thread?"
 msgstr "删除这组评论？"
 
+msgctxt "A message informing that the comment has been resolved"
+msgid "Marked as resolved"
+msgstr "标记为已解决"
+
 msgctxt "The tooltip for the comment toolbar button."
 msgid "Comment"
 msgstr "评论"
@@ -80,3 +100,11 @@ msgstr "显示的作者名来自（%0 添加的）外部来源"
 msgctxt "The additional information that displayed author name comes from imported Word file."
 msgid "EXTERNAL_IMPORT_WORD_AVATAR"
 msgstr "显示的作者名来自 %0 导入的 Word 文件"
+
+msgctxt "The label for the comments archive dropdown UI."
+msgid "COMMENTS_ARCHIVE"
+msgstr "评论存档"
+
+msgctxt "The information that comments archive is empty."
+msgid "EMPTY_COMMENTS_ARCHIVE"
+msgstr "没有已存档的评论。"

package/lang/translations/zh.po

@@ -33,14 +33,30 @@ msgctxt "The placeholder for the reply field."
 msgid "Reply..."
 msgstr "回覆..."
 
+msgctxt "The placeholder for the reply field when the comment thread is resolved."
+msgid "Reply to reopen discussion..."
+msgstr "回覆以重新開啟討論..."
+
 msgctxt "The placeholder for the new commend field."
 msgid "Write a comment..."
 msgstr "撰寫留言..."
 
+msgctxt "The information that comment was made on element and has no context"
+msgid "Comment was made on an element"
+msgstr "對元件進行的留言"
+
 msgctxt "The label for the button that enables editing a comment."
 msgid "Edit"
 msgstr "編輯"
 
+msgctxt "The label for the button that resolves a comment thread."
+msgid "Resolve"
+msgstr "解決"
+
+msgctxt "The label for the button that reopens a resolved comment thread."
+msgid "Reopen"
+msgstr "重新開啟"
+
 msgctxt "The label for the button that deletes a comment."
 msgid "Remove"
 msgstr "刪除"
@@ -57,6 +73,10 @@ msgctxt "The confirmation message shown after pressing the delete comment thread
 msgid "Delete comment thread?"
 msgstr "刪除討論串？"
 
+msgctxt "A message informing that the comment has been resolved"
+msgid "Marked as resolved"
+msgstr "已標記為解決"
+
 msgctxt "The tooltip for the comment toolbar button."
 msgid "Comment"
 msgstr "留言"
@@ -80,3 +100,11 @@ msgstr "顯示的作者名稱來自外部來源（由 %0 新增）"
 msgctxt "The additional information that displayed author name comes from imported Word file."
 msgid "EXTERNAL_IMPORT_WORD_AVATAR"
 msgstr "顯示的作者名稱來自由 %0 匯入的 Word 文件"
+
+msgctxt "The label for the comments archive dropdown UI."
+msgid "COMMENTS_ARCHIVE"
+msgstr "留言封存紀錄"
+
+msgctxt "The information that comments archive is empty."
+msgid "EMPTY_COMMENTS_ARCHIVE"
+msgstr "無封存的留言串。"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-comments",
-  "version": "36.0.1",
+  "version": "37.0.0",
   "description": "Collaborative comments feature for CKEditor 5.",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "CKSource (http://cksource.com/)",
@@ -30,9 +30,25 @@
     "discussions"
   ],
   "main": "src/index.js",
+  "files": [
+    "build",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "dll:build": "webpack",
+    "build": "tsc -p ./tsconfig.json",
+    "postversion": "npm run build"
+  },
   "dependencies": {
-    "ckeditor5": "^36.0.1",
+    "ckeditor5": "^37.0.0",
     "ckeditor5-collaboration": "^36.0.1",
     "lodash-es": "^4.17.11"
-  }
+  },
+  "types": "src/index.d.ts",
+  "obfuscated": true
 }

package/src/annotations/annotation.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @module comments/annotations/annotation
+ * @publicApi
+ */
+import { Rect, Collection } from 'ckeditor5/src/utils';
+import type { View } from 'ckeditor5/src/ui';
+import type AnnotationView from './view/annotationview';
+import type { AnnotationOptions } from './annotations';
+declare const Annotation_base: {
+    new (): import("ckeditor5/src/utils").Observable;
+    prototype: import("ckeditor5/src/utils").Observable;
+};
+/**
+ * Represents an annotation.
+ *
+ * Annotation is an entity that combines an {@link module:comments/annotations/view/annotationview~AnnotationView}
+ * and an annotation target (a DOM element or a {@link module:utils/dom/rect~Rect}) to which the annotation is bound.
+ */
+export default class Annotation extends Annotation_base {
+    /**
+     * The visibility of the annotation. Annotations that are not visible, are filtered from Annotation UI collections.
+     *
+     * @observable
+     */
+    isVisible: boolean;
+    /**
+     * The annotation view.
+     */
+    view: AnnotationView;
+    /**
+     * A collection of DOM elements which, when focused, make the annotation active.
+     *
+     * By default, this collection only contains the annotation view element.
+     * It can be extended with custom targets that will be tracked by the annotation focus tracking system.
+     */
+    focusableElements: Collection<HTMLElement>;
+    /**
+     * Creates an instance of the {@link module:comments/annotations/annotation~Annotation}.
+     */
+    constructor({ view, target, type, isVisible }: AnnotationOptions);
+    /**
+     * The type of the annotation.
+     */
+    get type(): string;
+    /**
+     * The annotation inner view.
+     *
+     * It is the view that is wrapped by the annotation view.*
+     */
+    get innerView(): View;
+    /**
+     * The annotation target to which the annotation view should be pinned.
+     *
+     * It can be an array of DOM elements or {@link module:utils/dom/rect~Rect a rect instance} or `null`.
+     */
+    get target(): Rect | Array<HTMLElement> | null;
+    /**
+     * The position and dimensions of the annotation target to which the annotation is bound.
+     */
+    get targetRect(): Rect | null;
+    /**
+     * The state of the annotation.
+     */
+    get isActive(): boolean;
+    set isActive(value: boolean);
+    /**
+     * Updates the target rect in the annotation view instance.
+     */
+    updateTargetRect(): void;
+    /**
+     * Clears all event listeners and internal collections.
+     */
+    destroy(): void;
+    /**
+     * Refreshes the visibility of the annotation based on the visibility of the annotation target.
+     *
+     * It sets the {@link #isVisible} property when the target is not attached to DOM or if the target or its descendant has
+     * set the `display` attribute to `none`.
+     *
+     * This method only updates an annotation if the annotation target is an HTML Element.
+     */
+    refreshVisibility(): void;
+}
+type Target = Rect | HTMLElement | null;
+export type AnnotationTarget = Target | (() => Target | Array<Target>);
+export {};

package/src/annotations/annotation.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x5cbb=['add','refreshVisibility','view','render','_getNormalizedTarget','remove','destroy','nodeType','mainView','innerView','function','target','focusTracker','_id','_type','every','type','filter','item','targetRect','getClientRects','isVisible','isActive','offsetParent','focusableElements','stopListening','_assertCorrectTarget','updateTargetRect','length','_target','element'];(function(_0x4aa9ea,_0x5cbbcf){const _0x459f19=function(_0x39eb5a){while(--_0x39eb5a){_0x4aa9ea['push'](_0x4aa9ea['shift']());}};_0x459f19(++_0x5cbbcf);}(_0x5cbb,0x19d));const _0x459f=function(_0x4aa9ea,_0x5cbbcf){_0x4aa9ea=_0x4aa9ea-0x0;let _0x459f19=_0x5cbb[_0x4aa9ea];return _0x459f19;};import{CKEditorError as _0x3230cb,Rect as _0x31c47d,Collection as _0x24fb1f,mix as _0x44559c,ObservableMixin as _0x5f44f2}from'ckeditor5/src/utils';export default class d{constructor({view:_0x5619b3,target:_0x5349fa,type:_0x45a2d1,isVisible:_0x240135=!0x0}){this[_0x459f('0x17')]=_0x5619b3,this['view'][_0x459f('0x14')]||this['view'][_0x459f('0x18')](),this[_0x459f('0x4')]=_0x45a2d1,this[_0x459f('0x13')]=_0x5349fa,d[_0x459f('0x10')](this['_getNormalizedTarget']()),this[_0x459f('0xe')]=new _0x24fb1f([this['view'][_0x459f('0x14')]],{'idProperty':_0x459f('0x3')}),this[_0x459f('0xe')]['on'](_0x459f('0x15'),(_0x3a130f,_0xd019c1)=>{this[_0x459f('0x17')][_0x459f('0x2')]['add'](_0xd019c1);}),this['focusableElements']['on'](_0x459f('0x1a'),(_0x2a319c,_0x56eb7c)=>{this[_0x459f('0x17')]['focusTracker'][_0x459f('0x1a')](_0x56eb7c);}),this['set'](_0x459f('0xb'),_0x240135);}get[_0x459f('0x6')](){return'function'==typeof this[_0x459f('0x4')]?this['_type']():this[_0x459f('0x4')];}get[_0x459f('0x1e')](){return this[_0x459f('0x17')][_0x459f('0x1d')];}get[_0x459f('0x1')](){const _0x53362d=this[_0x459f('0x19')]();return d[_0x459f('0x10')](_0x53362d),_0x53362d;}get[_0x459f('0x9')](){const _0x1fed67=this['target'];if(null===_0x1fed67)return null;if(_0x1fed67 instanceof _0x31c47d)return _0x1fed67;const _0x51d11d=_0x1fed67[_0x459f('0x7')](_0x7dfca4=>function(_0x28253c){const _0x2ebd16=_0x28253c[_0x459f('0xd')];if(_0x2ebd16)return!0x0;const _0x41f11a=_0x28253c[_0x459f('0xa')]()[_0x459f('0x8')](0x0);return!!_0x41f11a;}(_0x7dfca4));return 0x0===_0x51d11d[_0x459f('0x12')]?null:new _0x31c47d(_0x51d11d[0x0][_0x459f('0xa')]()['item'](0x0));}get[_0x459f('0xc')](){return this[_0x459f('0x17')][_0x459f('0xc')];}set[_0x459f('0xc')](_0x4382db){this[_0x459f('0x17')][_0x459f('0xc')]=_0x4382db,this['view']['mainView']['isActive']=_0x4382db;}[_0x459f('0x11')](){this[_0x459f('0x17')]['targetRect']=this[_0x459f('0x9')];}[_0x459f('0x1b')](){this[_0x459f('0xe')]['stopListening'](),this[_0x459f('0xe')]['clear'](),this[_0x459f('0xf')]();}[_0x459f('0x16')](){this['isVisible']=!!this[_0x459f('0x9')];}static[_0x459f('0x10')](_0x17d70c){if(!(null===_0x17d70c||_0x17d70c instanceof _0x31c47d||Array['isArray'](_0x17d70c)&&_0x17d70c[_0x459f('0x5')](_0x5d6383=>p(_0x5d6383))))throw new _0x3230cb('annotation-invalid-target',null,{'target':_0x17d70c});}['_getNormalizedTarget'](){let _0x4d3ce7=_0x459f('0x0')==typeof this[_0x459f('0x13')]?this[_0x459f('0x13')]():this[_0x459f('0x13')];return _0x4d3ce7=p(_0x4d3ce7)?[_0x4d3ce7]:_0x4d3ce7,_0x4d3ce7;}}function p(_0x140d8a){return null!==_0x140d8a&&'object'==typeof _0x140d8a&&0x1===_0x140d8a[_0x459f('0x1c')];}_0x44559c(d,_0x5f44f2);
+const _0x4219=['filter','item','mainView','targetRect','function','focusableElements','getClientRects','set','isActive','element','updateTargetRect','focusTracker','destroy','target','_assertCorrectTarget','annotation-invalid-target','_target','clear','_getNormalizedTarget','add','offsetParent','_type','isVisible','view','stopListening','remove','length','every','refreshVisibility','nodeType','innerView'];(function(_0xc09e6e,_0x421957){const _0x2f3c02=function(_0x581287){while(--_0x581287){_0xc09e6e['push'](_0xc09e6e['shift']());}};_0x2f3c02(++_0x421957);}(_0x4219,0x96));const _0x2f3c=function(_0xc09e6e,_0x421957){_0xc09e6e=_0xc09e6e-0x0;let _0x2f3c02=_0x4219[_0xc09e6e];return _0x2f3c02;};import{CKEditorError as _0x39190c,Rect as _0x100afd,Collection as _0x13ddaf,ObservableMixin as _0x146ec4}from'ckeditor5/src/utils';export default class d extends _0x146ec4(){constructor({view:_0x551cab,target:_0x3d17d9,type:_0x111136,isVisible:_0x272e01=!0x0}){super(),this['view']=_0x551cab,this[_0x2f3c('0x1c')][_0x2f3c('0xe')]||this[_0x2f3c('0x1c')]['render'](),this[_0x2f3c('0x1a')]=_0x111136,this[_0x2f3c('0x15')]=_0x3d17d9,d[_0x2f3c('0x13')](this[_0x2f3c('0x17')]()),this['focusableElements']=new _0x13ddaf([this['view'][_0x2f3c('0xe')]],{'idProperty':'_id'}),this[_0x2f3c('0xa')]['on'](_0x2f3c('0x18'),(_0x4ae4b9,_0x381d9d)=>{this[_0x2f3c('0x1c')][_0x2f3c('0x10')][_0x2f3c('0x18')](_0x381d9d);}),this[_0x2f3c('0xa')]['on'](_0x2f3c('0x1e'),(_0x206f6c,_0x2217ca)=>{this[_0x2f3c('0x1c')][_0x2f3c('0x10')][_0x2f3c('0x1e')](_0x2217ca);}),this[_0x2f3c('0xc')](_0x2f3c('0x1b'),_0x272e01);}get['type'](){return'function'==typeof this[_0x2f3c('0x1a')]?this[_0x2f3c('0x1a')]():this[_0x2f3c('0x1a')];}get[_0x2f3c('0x4')](){return this[_0x2f3c('0x1c')][_0x2f3c('0x7')];}get[_0x2f3c('0x12')](){const _0x3c2670=this[_0x2f3c('0x17')]();return d[_0x2f3c('0x13')](_0x3c2670),_0x3c2670;}get['targetRect'](){const _0x5c73aa=this['target'];if(null===_0x5c73aa)return null;if(_0x5c73aa instanceof _0x100afd)return _0x5c73aa;const _0x32fc63=_0x5c73aa[_0x2f3c('0x5')](_0x8239df=>function(_0x928fc9){const _0x3fd192=_0x928fc9[_0x2f3c('0x19')];if(_0x3fd192)return!0x0;const _0x2417d5=_0x928fc9['getClientRects']()[_0x2f3c('0x6')](0x0);return!!_0x2417d5;}(_0x8239df));return 0x0===_0x32fc63[_0x2f3c('0x0')]?null:new _0x100afd(_0x32fc63[0x0][_0x2f3c('0xb')]()[_0x2f3c('0x6')](0x0));}get[_0x2f3c('0xd')](){return this[_0x2f3c('0x1c')][_0x2f3c('0xd')];}set[_0x2f3c('0xd')](_0x1078e0){this['view']['isActive']=_0x1078e0,this[_0x2f3c('0x1c')][_0x2f3c('0x7')]['isActive']=_0x1078e0;}[_0x2f3c('0xf')](){this[_0x2f3c('0x1c')][_0x2f3c('0x8')]=this[_0x2f3c('0x8')];}[_0x2f3c('0x11')](){this['focusableElements'][_0x2f3c('0x1d')](),this[_0x2f3c('0xa')][_0x2f3c('0x16')](),this[_0x2f3c('0x1d')]();}[_0x2f3c('0x2')](){this['isVisible']=!!this['targetRect'];}static[_0x2f3c('0x13')](_0x184f4b){if(!(null===_0x184f4b||_0x184f4b instanceof _0x100afd||Array['isArray'](_0x184f4b)&&_0x184f4b[_0x2f3c('0x1')](_0x29490f=>y(_0x29490f))))throw new _0x39190c(_0x2f3c('0x14'),null,{'target':_0x184f4b});}['_getNormalizedTarget'](){const _0x1e029e=_0x2f3c('0x9')==typeof this['_target']?this[_0x2f3c('0x15')]():this[_0x2f3c('0x15')];return y(_0x1e029e)?[_0x1e029e]:_0x1e029e;}}function y(_0x2c4faa){return null!==_0x2c4faa&&'object'==typeof _0x2c4faa&&_0x2f3c('0x3')in _0x2c4faa&&0x1===_0x2c4faa['nodeType'];}

package/src/annotations/annotationcollection.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @module comments/annotations/annotationcollection
+ * @publicApi
+ */
+import { Collection } from 'ckeditor5/src/utils';
+import type { View } from 'ckeditor5/src/ui';
+import type Annotation from './annotation';
+/**
+ * A collection of {@link module:comments/annotations/annotation~Annotation annotations}.
+ *
+ * It implements methods for managing annotations and creates a focus tracker for them to make it easier to manage
+ * the focus for all annotations.
+ *
+ * `AnnotationCollection` fires {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:focus} when an annotation
+ * becomes focused and {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:blur} when all annotations
+ * lose focus.
+ */
+export default class AnnotationCollection extends Collection<Annotation> {
+    /**
+     * @param annotations Initial annotations.
+     */
+    constructor(annotations?: Iterable<Annotation>);
+    /**
+    * Equals to `true` when one of the annotation in the collection is focused.
+    */
+    get isFocused(): boolean;
+    /**
+     * Adds an annotation to the collection.
+     */
+    add(annotation: Annotation): this;
+    /**
+     * Removes the annotation from the collection.
+     */
+    remove(annotation: Annotation): Annotation;
+    /**
+     * Gets the annotation for a given annotation view's inner view.
+     */
+    getByInnerView(innerView: View): Annotation | undefined;
+    /**
+     * Gets the annotation for a given annotation view.
+     */
+    getByView(view: View): Annotation | undefined;
+    /**
+     * Destroys all bindings and clears the collection.
+     */
+    destroy(): void;
+    /**
+     * Refreshes the positioning of all annotations and sorts them topmost and leftmost.
+     */
+    refreshPositioning(): void;
+}
+/**
+ * Fired when an annotation becomes active.
+ *
+ * @eventName ~AnnotationCollection#focus
+ * @param annotation An annotation that was focused.
+ */
+export type AnnotationFocusEvent = {
+    name: 'focus';
+    args: [annotation: Annotation];
+};
+/**
+ * Fired when all annotations become blurred.
+ *
+ * @eventName ~AnnotationCollection#blur
+ */
+export type AnnotationBlurEvent = {
+    name: 'blur';
+    args: [];
+};
+/**
+ * A helper function that binds two {@link module:comments/annotations/annotationcollection~AnnotationCollection AnnotationCollection}s
+ * and allows filtering items based on the passed callback.
+ *
+ * Since {@link module:comments/annotations/annotationcollection~AnnotationCollection#refreshPositioning}
+ * sorts the annotations by removing and inserting items, the binding implemented by the `bindTo()` method is lost. This is why
+ * this helper needs to be used.
+ *
+ * This helper is used by the annotations UIs to filter which annotations from the
+ * {@link module:comments/annotations/annotations~Annotations#collection main annotation collection} should be handled by
+ * a given annotations UI.
+ *
+ * @param `options.source` The source collection
+ * from which the annotations will be taken.
+ * @param `options.target` The target collection
+ * that will be synced to the source collection.
+ * @param options.filter Filtering function that gets an annotation and should return `true` if the annotation should be
+ * copied to the `target` collection.
+ */
+export declare function bindAnnotationCollections({ source, target, filter }: {
+    source: AnnotationCollection;
+    target: AnnotationCollection;
+    filter: (annotation: Annotation) => boolean;
+}): void;

package/src/annotations/annotationcollection.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x1d75=['delete','get','_sort','innerView','_viewToAnnotation','blur','from','set','_focusTracker','targetRect','add','focusableElements','_items','focus','left','fire','getIndex','clear','_innerViewToAnnotation','stopListening','destroy','isFocused','remove','updateTargetRect','change:isFocused','view','has','listenTo','length','top','annotationcollection-not-existing-item','annotationcollection-duplicated-item','focusTracker','_getOrderInContent'];(function(_0x29065e,_0x1d7561){const _0x5ca990=function(_0x3add6a){while(--_0x3add6a){_0x29065e['push'](_0x29065e['shift']());}};_0x5ca990(++_0x1d7561);}(_0x1d75,0x110));const _0x5ca9=function(_0x29065e,_0x1d7561){_0x29065e=_0x29065e-0x0;let _0x5ca990=_0x1d75[_0x29065e];return _0x5ca990;};import{CKEditorError as _0x168375,Collection as _0x2f760d,FocusTracker as _0x4f0564}from'ckeditor5/src/utils';export default class x extends _0x2f760d{constructor(_0x256044=[]){super(),this[_0x5ca9('0x12')]=new Map(),this[_0x5ca9('0x4')]=new Map(),this[_0x5ca9('0x8')]=new _0x4f0564(),this[_0x5ca9('0x8')]['on'](_0x5ca9('0x18'),(_0x2a558b,_0x1cda4d,_0x31a795)=>{_0x31a795||this[_0x5ca9('0xf')](_0x5ca9('0x5'));});for(const _0x208adb of _0x256044)this[_0x5ca9('0xa')](_0x208adb);}get[_0x5ca9('0x15')](){return this[_0x5ca9('0x8')][_0x5ca9('0x15')];}[_0x5ca9('0xa')](_0x2815b9){if(this[_0x5ca9('0x1a')](_0x2815b9))throw new _0x168375(_0x5ca9('0x1f'),null);this[_0x5ca9('0x12')][_0x5ca9('0x7')](_0x2815b9[_0x5ca9('0x3')],_0x2815b9),this[_0x5ca9('0x4')][_0x5ca9('0x7')](_0x2815b9[_0x5ca9('0x19')],_0x2815b9);for(const _0x87403f of _0x2815b9[_0x5ca9('0xb')])this[_0x5ca9('0x8')][_0x5ca9('0xa')](_0x87403f);this[_0x5ca9('0x1b')](_0x2815b9[_0x5ca9('0xb')],'add',(_0x3b0b8d,_0x20a9e3)=>{this[_0x5ca9('0x8')][_0x5ca9('0xa')](_0x20a9e3);}),this[_0x5ca9('0x1b')](_0x2815b9[_0x5ca9('0xb')],'remove',(_0x1329be,_0x85c974)=>{this[_0x5ca9('0x8')][_0x5ca9('0x16')](_0x85c974);}),this[_0x5ca9('0x1b')](_0x2815b9['view'][_0x5ca9('0x20')],_0x5ca9('0x18'),(_0x5bc089,_0x1bd36b,_0x457b9a)=>{_0x457b9a&&this['fire'](_0x5ca9('0xd'),_0x2815b9);}),_0x2815b9[_0x5ca9('0x17')]();const _0x128b47=this[_0x5ca9('0x21')](_0x2815b9[_0x5ca9('0x19')][_0x5ca9('0x9')]);super[_0x5ca9('0xa')](_0x2815b9,_0x128b47);}['remove'](_0x41c10c){if(!this[_0x5ca9('0x1a')](_0x41c10c))throw new _0x168375(_0x5ca9('0x1e'),null);this[_0x5ca9('0x13')](_0x41c10c[_0x5ca9('0x19')][_0x5ca9('0x20')]),this['stopListening'](_0x41c10c[_0x5ca9('0xb')]);for(const _0x20d953 of _0x41c10c[_0x5ca9('0xb')])this['_focusTracker']['remove'](_0x20d953);this[_0x5ca9('0x4')][_0x5ca9('0x0')](_0x41c10c[_0x5ca9('0x19')]),this[_0x5ca9('0x12')][_0x5ca9('0x0')](_0x41c10c[_0x5ca9('0x3')]),super[_0x5ca9('0x16')](_0x41c10c);}['getByInnerView'](_0x5f28b1){return this[_0x5ca9('0x12')][_0x5ca9('0x1')](_0x5f28b1);}['getByView'](_0x43beff){return this['_viewToAnnotation']['get'](_0x43beff);}[_0x5ca9('0x14')](){super['clear'](),this[_0x5ca9('0x13')](),this['_innerViewToAnnotation'][_0x5ca9('0x11')](),this[_0x5ca9('0x4')][_0x5ca9('0x11')](),this['_focusTracker']['destroy']();}['refreshPositioning'](){for(const _0x5593fd of this)_0x5593fd['updateTargetRect']();this[_0x5ca9('0x2')]();}[_0x5ca9('0x2')](){const _0x411b83=Array[_0x5ca9('0x6')](this)['sort']((_0x5d4998,_0x39a42c)=>y(_0x5d4998[_0x5ca9('0x19')][_0x5ca9('0x9')],_0x39a42c[_0x5ca9('0x19')]['targetRect']));for(let _0x24c7f2=_0x411b83[_0x5ca9('0x1c')]-0x1;_0x24c7f2>0x0;_0x24c7f2--){const _0x506fa6=_0x411b83[_0x24c7f2];_0x24c7f2!==this[_0x5ca9('0x10')](_0x506fa6)&&(this['remove'](_0x506fa6),this[_0x5ca9('0xa')](_0x506fa6,_0x24c7f2));}}[_0x5ca9('0x21')](_0x501b51){let _0x1eed03=0x0;if(!_0x501b51)return this[_0x5ca9('0xc')]['length'];for(const _0x11e978 of this){const _0x5c37e8=_0x11e978[_0x5ca9('0x19')]['targetRect'];if(_0x5c37e8){if(y(_0x501b51,_0x5c37e8)<0x0)return _0x1eed03;_0x1eed03++;}}return _0x1eed03;}}export function bindAnnotationCollections({source:_0x11e2d3,target:_0x131a42,filter:_0x3cc393}){for(const _0x5979c0 of _0x11e2d3)_0x3cc393(_0x5979c0)&&_0x131a42[_0x5ca9('0xa')](_0x5979c0);_0x131a42['listenTo'](_0x11e2d3,_0x5ca9('0xa'),(_0x4a7981,_0x3530b7)=>{_0x3cc393(_0x3530b7)&&_0x131a42['add'](_0x3530b7);}),_0x131a42['listenTo'](_0x11e2d3,_0x5ca9('0x16'),(_0x581f4b,_0x405fca)=>{_0x131a42[_0x5ca9('0x1a')](_0x405fca)&&_0x131a42[_0x5ca9('0x16')](_0x405fca);});}function y(_0x4dac6e,_0x3ce51c){if(null===_0x4dac6e&&null===_0x3ce51c)return 0x0;if(null===_0x4dac6e)return-0x1;if(null===_0x3ce51c)return 0x1;const _0x3235d3=_0x4dac6e[_0x5ca9('0x1d')]-_0x3ce51c[_0x5ca9('0x1d')];return 0x0==_0x3235d3?_0x4dac6e[_0x5ca9('0xe')]-_0x3ce51c[_0x5ca9('0xe')]:_0x3235d3;}
+const _0x533b=['get','from','add','_sort','_getOrderInContent','length','fire','top','remove','focus','getByInnerView','stopListening','listenTo','view','clear','_innerViewToAnnotation','annotationcollection-not-existing-item','getIndex','annotationcollection-duplicated-item','getByView','_focusTracker','focusableElements','blur','delete','has','refreshPositioning','updateTargetRect','set','innerView','change:isFocused','targetRect','_viewToAnnotation'];(function(_0x52f59f,_0x533bc1){const _0x5ca27c=function(_0x144e3c){while(--_0x144e3c){_0x52f59f['push'](_0x52f59f['shift']());}};_0x5ca27c(++_0x533bc1);}(_0x533b,0x1c0));const _0x5ca2=function(_0x52f59f,_0x533bc1){_0x52f59f=_0x52f59f-0x0;let _0x5ca27c=_0x533b[_0x52f59f];return _0x5ca27c;};import{CKEditorError as _0x3500a6,Collection as _0xcc458b,FocusTracker as _0x5a5bd2}from'ckeditor5/src/utils';export default class x extends _0xcc458b{constructor(_0x15cc32=[]){super(),this[_0x5ca2('0xf')]=new Map(),this[_0x5ca2('0x1f')]=new Map(),this[_0x5ca2('0x14')]=new _0x5a5bd2(),this[_0x5ca2('0x14')]['on'](_0x5ca2('0x1d'),(_0x30b14f,_0x77dba5,_0x56989a)=>{_0x56989a||this[_0x5ca2('0x6')](_0x5ca2('0x16'));});for(const _0x22e550 of _0x15cc32)this['add'](_0x22e550);}get['isFocused'](){return this['_focusTracker']['isFocused'];}['add'](_0x55427c){if(this[_0x5ca2('0x18')](_0x55427c))throw new _0x3500a6(_0x5ca2('0x12'),null);this[_0x5ca2('0xf')]['set'](_0x55427c[_0x5ca2('0x1c')],_0x55427c),this[_0x5ca2('0x1f')][_0x5ca2('0x1b')](_0x55427c[_0x5ca2('0xd')],_0x55427c);for(const _0x336fab of _0x55427c['focusableElements'])this[_0x5ca2('0x14')][_0x5ca2('0x2')](_0x336fab);this[_0x5ca2('0xc')](_0x55427c['focusableElements'],_0x5ca2('0x2'),(_0x409890,_0x46bb3c)=>{this[_0x5ca2('0x14')]['add'](_0x46bb3c);}),this['listenTo'](_0x55427c[_0x5ca2('0x15')],_0x5ca2('0x8'),(_0x53c979,_0x50c393)=>{this[_0x5ca2('0x14')][_0x5ca2('0x8')](_0x50c393);}),this[_0x5ca2('0xc')](_0x55427c['view']['focusTracker'],_0x5ca2('0x1d'),(_0x34ef4b,_0x2ce32d,_0x22b5c0)=>{_0x22b5c0&&this[_0x5ca2('0x6')](_0x5ca2('0x9'),_0x55427c);}),_0x55427c[_0x5ca2('0x1a')]();const _0x353f69=this[_0x5ca2('0x4')](_0x55427c[_0x5ca2('0xd')][_0x5ca2('0x1e')]);return super[_0x5ca2('0x2')](_0x55427c,_0x353f69);}[_0x5ca2('0x8')](_0x268392){if(!this[_0x5ca2('0x18')](_0x268392))throw new _0x3500a6(_0x5ca2('0x10'),null);this[_0x5ca2('0xb')](_0x268392[_0x5ca2('0xd')]['focusTracker']),this[_0x5ca2('0xb')](_0x268392['focusableElements']);for(const _0x453fb5 of _0x268392[_0x5ca2('0x15')])this[_0x5ca2('0x14')][_0x5ca2('0x8')](_0x453fb5);return this[_0x5ca2('0x1f')][_0x5ca2('0x17')](_0x268392[_0x5ca2('0xd')]),this[_0x5ca2('0xf')][_0x5ca2('0x17')](_0x268392[_0x5ca2('0x1c')]),super[_0x5ca2('0x8')](_0x268392);}[_0x5ca2('0xa')](_0x4a7429){return this['_innerViewToAnnotation'][_0x5ca2('0x0')](_0x4a7429);}[_0x5ca2('0x13')](_0x51a91a){return this[_0x5ca2('0x1f')][_0x5ca2('0x0')](_0x51a91a);}['destroy'](){super[_0x5ca2('0xe')](),this[_0x5ca2('0xb')](),this[_0x5ca2('0xf')][_0x5ca2('0xe')](),this[_0x5ca2('0x1f')][_0x5ca2('0xe')](),this['_focusTracker']['destroy']();}[_0x5ca2('0x19')](){for(const _0xf3f0f8 of this)_0xf3f0f8[_0x5ca2('0x1a')]();this[_0x5ca2('0x3')]();}['_sort'](){const _0x36a32b=Array[_0x5ca2('0x1')](this)['sort']((_0x352002,_0x3aa1e0)=>v(_0x352002['view'][_0x5ca2('0x1e')],_0x3aa1e0[_0x5ca2('0xd')][_0x5ca2('0x1e')]));for(let _0x3b819d=_0x36a32b['length']-0x1;_0x3b819d>0x0;_0x3b819d--){const _0x243329=_0x36a32b[_0x3b819d];_0x3b819d!==this[_0x5ca2('0x11')](_0x243329)&&(this[_0x5ca2('0x8')](_0x243329),this[_0x5ca2('0x2')](_0x243329));}}[_0x5ca2('0x4')](_0x591b78){let _0x20d20d=0x0;if(!_0x591b78)return this[_0x5ca2('0x5')];for(const _0xd35c96 of this){const _0x3f6f17=_0xd35c96[_0x5ca2('0xd')][_0x5ca2('0x1e')];if(_0x3f6f17){if(v(_0x591b78,_0x3f6f17)<0x0)return _0x20d20d;_0x20d20d++;}}return _0x20d20d;}}export function bindAnnotationCollections({source:_0xee54f8,target:_0x57a66e,filter:_0x34e3a9}){for(const _0x1331ff of _0xee54f8)_0x34e3a9(_0x1331ff)&&_0x57a66e[_0x5ca2('0x2')](_0x1331ff);_0x57a66e[_0x5ca2('0xc')](_0xee54f8,'add',(_0x5df793,_0x941097)=>{_0x34e3a9(_0x941097)&&_0x57a66e[_0x5ca2('0x2')](_0x941097);}),_0x57a66e['listenTo'](_0xee54f8,_0x5ca2('0x8'),(_0x1cbb6e,_0x5951b4)=>{_0x57a66e[_0x5ca2('0x18')](_0x5951b4)&&_0x57a66e['remove'](_0x5951b4);});}function v(_0x163526,_0x3c8709){if(null===_0x163526&&null===_0x3c8709)return 0x0;if(null===_0x163526)return-0x1;if(null===_0x3c8709)return 0x1;const _0x53cff0=_0x163526['top']-_0x3c8709[_0x5ca2('0x7')];return 0x0==_0x53cff0?_0x163526['left']-_0x3c8709['left']:_0x53cff0;}