@ckeditor/ckeditor5-comments 39.0.1 → 40.0.0

package/src/annotations/annotations.d.ts

@@ -1,154 +1,154 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/annotations/annotations
- * @publicApi
- */
-import { ContextPlugin, type Context, type Editor } from 'ckeditor5/src/core';
-import type { View } from 'ckeditor5/src/ui';
-import { type Locale } from 'ckeditor5/src/utils';
-import Annotation, { type AnnotationTarget } from './annotation';
-import AnnotationCollection from './annotationcollection';
-import AnnotationView, { type AnnotationMainView } from './view/annotationview';
-/**
- * Stores and manages all {@link module:comments/annotations/annotation~Annotation annotations} created
- * for the entire {@link module:core/context~Context} or {@link module:core/editor/editor~Editor}.
- *
- * It allows for {@link module:comments/annotations/annotations~Annotations#add adding} and
- * {@link module:comments/annotations/annotations~Annotations#remove removing} annotations.
- *
- * It manages {@link module:comments/annotations/annotations~Annotations#activate activating} and
- * {@link module:comments/annotations/annotations~Annotations#deactivateAll deactivating} annotations. Using those methods will
- * result in setting {@link module:comments/annotations/annotationsuis~AnnotationUI#activeAnnotation} in the appropriate
- * {@link module:comments/annotations/annotationsuis~AnnotationsUI annotations UI} plugins.
- *
- * All active annotations are stored in {@link module:comments/annotations/annotations~Annotations#activeAnnotations}.
- *
- * `Annotations` is linked with {@link module:comments/annotations/annotationsuis~AnnotationsUIs}, which listens to events fired by
- * `Annotations` and propagates information to and from annotations UI plugins.
- */
-export default class Annotations extends ContextPlugin {
-    /**
-     * A set of currently active annotations.
-     *
-     * @observable
-     */
-    activeAnnotations: Set<Annotation>;
-    /**
-     * A collection of all annotations. It should not be operated on directly.
-     */
-    readonly collection: AnnotationCollection;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Annotations";
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * Adds an annotation to the collection.
-     */
-    add(annotation: Annotation): void;
-    /**
-     * Removes the given annotation from the collection.
-     */
-    remove(annotation: Annotation): void;
-    /**
-     * Refreshes the visibility of annotations based on the visibility of their annotation targets.
-     *
-     * This method should be called when one or more annotations' targets changed their visibility,
-     * for example when one of the editors was shown or hidden.
-     *
-     * This method recalculates all annotations' {@link module:comments/annotations/annotation~Annotation#isVisible `isVisible`} property.
-     */
-    refreshVisibility(): void;
-    /**
-     * Refreshes the positioning of all visible annotations and sorts them topmost and leftmost.
-     */
-    refreshPositioning(): void;
-    /**
-     * Returns the annotation that "contains" the given annotation view's inner view.
-     */
-    getByInnerView(innerView: View): Annotation | undefined;
-    /**
-     * Deactivates all active annotations.
-     *
-     * @fires _deactivateAllAnnotations
-     */
-    deactivateAll(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Activates the given annotation.
-     *
-     * If annotations UI that handles the given annotation already has an active annotation,
-     * then it deactivates it and activates the provided one.
-     *
-     * @fires _activateAnnotation
-     */
-    activate(annotation: Annotation): void;
-    /**
-     * Creates an annotation.
-     *
-     * ```ts
-     * const annotationView = annotations.createAnnotationView( editor.locale, innerView );
-     *
-     * const annotation = annotations.createAnnotation( {
-     * 	view: annotationView,
-     * 	target: document.getElementById( 'target' ),
-     * 	type: 'comment'
-     * } );
-     * ```
-     *
-     * @returns An annotation.
-     */
-    createAnnotation(options: AnnotationOptions): Annotation;
-    /**
-     * Creates an annotation view wrapper for the annotation content.
-     *
-     * ```ts
-     * const innerView = createCustomView();
-     * const annotationView = annotations.createAnnotationView( editor.locale, innerView );
-     * ```
-     *
-     * @returns An annotation view.
-     */
-    createAnnotationView(locale: Locale, view: AnnotationMainView): AnnotationView;
-}
-/**
- * The configuration options which are used to create new {@link module:comments/annotations/annotation~Annotation annotations}.
- *
- * @param view The annotation view.
- * @param target The annotation target.
- * @param type The annotation type.
- * @param isVisible The initial visibility of the annotation.
- */
-export interface AnnotationOptions {
-    view: AnnotationView;
-    target: AnnotationTarget;
-    type: string | (() => string);
-    isVisible?: boolean;
-}
-/**
- * An internal event that fires when the annotation should be activated.
- *
- * @eventName ~Annotations#_activateAnnotation
- */
-export type ActivateAnnotationEvent = {
-    name: '_activateAnnotation';
-    args: [annotation: Annotation];
-};
-/**
- * An internal event that fires when all annotations should be deactivated.
- *
- * @eventName ~Annotations#_deactivateAllAnnotations
- */
-export type DeactivateAllAnnotationsEvent = {
-    name: '_deactivateAllAnnotations';
-    args: [];
-};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module comments/annotations/annotations
+ * @publicApi
+ */
+import { ContextPlugin, type Context, type Editor } from 'ckeditor5/src/core';
+import type { View } from 'ckeditor5/src/ui';
+import { type Locale } from 'ckeditor5/src/utils';
+import Annotation, { type AnnotationTarget } from './annotation';
+import AnnotationCollection from './annotationcollection';
+import AnnotationView, { type AnnotationMainView } from './view/annotationview';
+/**
+ * Stores and manages all {@link module:comments/annotations/annotation~Annotation annotations} created
+ * for the entire {@link module:core/context~Context} or {@link module:core/editor/editor~Editor}.
+ *
+ * It allows for {@link module:comments/annotations/annotations~Annotations#add adding} and
+ * {@link module:comments/annotations/annotations~Annotations#remove removing} annotations.
+ *
+ * It manages {@link module:comments/annotations/annotations~Annotations#activate activating} and
+ * {@link module:comments/annotations/annotations~Annotations#deactivateAll deactivating} annotations. Using those methods will
+ * result in setting {@link module:comments/annotations/annotationsuis~AnnotationUI#activeAnnotation} in the appropriate
+ * {@link module:comments/annotations/annotationsuis~AnnotationsUI annotations UI} plugins.
+ *
+ * All active annotations are stored in {@link module:comments/annotations/annotations~Annotations#activeAnnotations}.
+ *
+ * `Annotations` is linked with {@link module:comments/annotations/annotationsuis~AnnotationsUIs}, which listens to events fired by
+ * `Annotations` and propagates information to and from annotations UI plugins.
+ */
+export default class Annotations extends ContextPlugin {
+    /**
+     * A set of currently active annotations.
+     *
+     * @observable
+     */
+    activeAnnotations: Set<Annotation>;
+    /**
+     * A collection of all annotations. It should not be operated on directly.
+     */
+    readonly collection: AnnotationCollection;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Annotations";
+    /**
+     * @inheritDoc
+     */
+    constructor(context: Context | Editor);
+    /**
+     * Adds an annotation to the collection.
+     */
+    add(annotation: Annotation): void;
+    /**
+     * Removes the given annotation from the collection.
+     */
+    remove(annotation: Annotation): void;
+    /**
+     * Refreshes the visibility of annotations based on the visibility of their annotation targets.
+     *
+     * This method should be called when one or more annotations' targets changed their visibility,
+     * for example when one of the editors was shown or hidden.
+     *
+     * This method recalculates all annotations' {@link module:comments/annotations/annotation~Annotation#isVisible `isVisible`} property.
+     */
+    refreshVisibility(): void;
+    /**
+     * Refreshes the positioning of all visible annotations and sorts them topmost and leftmost.
+     */
+    refreshPositioning(): void;
+    /**
+     * Returns the annotation that "contains" the given annotation view's inner view.
+     */
+    getByInnerView(innerView: View): Annotation | undefined;
+    /**
+     * Deactivates all active annotations.
+     *
+     * @fires _deactivateAllAnnotations
+     */
+    deactivateAll(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Activates the given annotation.
+     *
+     * If annotations UI that handles the given annotation already has an active annotation,
+     * then it deactivates it and activates the provided one.
+     *
+     * @fires _activateAnnotation
+     */
+    activate(annotation: Annotation): void;
+    /**
+     * Creates an annotation.
+     *
+     * ```ts
+     * const annotationView = annotations.createAnnotationView( editor.locale, innerView );
+     *
+     * const annotation = annotations.createAnnotation( {
+     * 	view: annotationView,
+     * 	target: document.getElementById( 'target' ),
+     * 	type: 'comment'
+     * } );
+     * ```
+     *
+     * @returns An annotation.
+     */
+    createAnnotation(options: AnnotationOptions): Annotation;
+    /**
+     * Creates an annotation view wrapper for the annotation content.
+     *
+     * ```ts
+     * const innerView = createCustomView();
+     * const annotationView = annotations.createAnnotationView( editor.locale, innerView );
+     * ```
+     *
+     * @returns An annotation view.
+     */
+    createAnnotationView(locale: Locale, view: AnnotationMainView): AnnotationView;
+}
+/**
+ * The configuration options which are used to create new {@link module:comments/annotations/annotation~Annotation annotations}.
+ *
+ * @param view The annotation view.
+ * @param target The annotation target.
+ * @param type The annotation type.
+ * @param isVisible The initial visibility of the annotation.
+ */
+export interface AnnotationOptions {
+    view: AnnotationView;
+    target: AnnotationTarget;
+    type: string | (() => string);
+    isVisible?: boolean;
+}
+/**
+ * An internal event that fires when the annotation should be activated.
+ *
+ * @eventName ~Annotations#_activateAnnotation
+ */
+export type ActivateAnnotationEvent = {
+    name: '_activateAnnotation';
+    args: [annotation: Annotation];
+};
+/**
+ * An internal event that fires when all annotations should be deactivated.
+ *
+ * @eventName ~Annotations#_deactivateAllAnnotations
+ */
+export type DeactivateAllAnnotationsEvent = {
+    name: '_deactivateAllAnnotations';
+    args: [];
+};

package/src/annotations/annotations.js

@@ -20,4 +20,4 @@
  *
  *
  */
-const _0x5af9=['change:isVisible','has','refreshPositioning','source','refreshVisibility','createAnnotationView','delete','activate','collection','isVisible','activeAnnotations','createAnnotation','_activateAnnotation','destroy','view','getByInnerView','Annotations','fire','deactivateAll','_addActiveAnnotation','set','_deactivateAllAnnotations','add','remove','_removeActiveAnnotation','element','focusTracker','listenTo','_visibleAnnotations','_bindAnnotationsToVisibleAnnotations'];(function(_0x12f9db,_0x5af9f5){const _0x5219ee=function(_0x3b80cf){while(--_0x3b80cf){_0x12f9db['push'](_0x12f9db['shift']());}};_0x5219ee(++_0x5af9f5);}(_0x5af9,0xb3));const _0x5219=function(_0x12f9db,_0x5af9f5){_0x12f9db=_0x12f9db-0x0;let _0x5219ee=_0x5af9[_0x12f9db];return _0x5219ee;};import{ContextPlugin as _0x25ada4}from'ckeditor5/src/core';import _0x9cfe95 from'./annotation';import _0x3ed50e from'./annotationcollection';import _0x22f3e5 from'./view/annotationview';export default class b extends _0x25ada4{static get['pluginName'](){return _0x5219('0x11');}constructor(_0x2df73){super(_0x2df73),this['collection']=new _0x3ed50e(),this[_0x5219('0x1d')]=new _0x3ed50e(),this[_0x5219('0x15')]('activeAnnotations',new Set()),this[_0x5219('0x0')]();}[_0x5219('0x17')](_0x499b01){this[_0x5219('0x9')][_0x5219('0x17')](_0x499b01);}[_0x5219('0x18')](_0x51e582){this[_0x5219('0x9')][_0x5219('0x18')](_0x51e582),_0x51e582[_0x5219('0xe')]();}[_0x5219('0x5')](){for(const _0x19f1cb of this[_0x5219('0x9')])_0x19f1cb['refreshVisibility']();}[_0x5219('0x3')](){this['_visibleAnnotations'][_0x5219('0x3')]();}[_0x5219('0x10')](_0x5a0987){return this[_0x5219('0x9')][_0x5219('0x10')](_0x5a0987);}[_0x5219('0x13')](){this[_0x5219('0x12')](_0x5219('0x16'));}[_0x5219('0xe')](){for(const _0x3ec537 of this[_0x5219('0x9')])_0x3ec537[_0x5219('0xe')]();this['_visibleAnnotations'][_0x5219('0xe')](),this['collection'][_0x5219('0xe')](),super[_0x5219('0xe')]();}[_0x5219('0x8')](_0x24d0dd){this[_0x5219('0x12')](_0x5219('0xd'),_0x24d0dd);}[_0x5219('0xc')](_0x18e8ff){return new _0x9cfe95(_0x18e8ff);}[_0x5219('0x6')](_0x1cdc1d,_0x47073c){return new _0x22f3e5(_0x1cdc1d,_0x47073c);}[_0x5219('0x14')](_0x1b3f05){const _0xb9cf19=new Set(this[_0x5219('0xb')]);_0xb9cf19[_0x5219('0x17')](_0x1b3f05),this[_0x5219('0xb')]=_0xb9cf19;}[_0x5219('0x19')](_0x516289){const _0x71394f=new Set(this[_0x5219('0xb')]);_0x71394f[_0x5219('0x7')](_0x516289),this['activeAnnotations']=_0x71394f;}[_0x5219('0x0')](){const _0x535ddf=this[_0x5219('0x9')],_0x36582a=this[_0x5219('0x1d')];function _0x3a657e(_0x3b4f65){const _0x17f4df=_0x3b4f65[_0x5219('0x4')];_0x17f4df['isVisible']&&!_0x36582a['has'](_0x17f4df)?_0x36582a['add'](_0x17f4df):!_0x17f4df['isVisible']&&_0x36582a[_0x5219('0x2')](_0x17f4df)&&_0x36582a[_0x5219('0x18')](_0x17f4df),_0x17f4df[_0x5219('0xf')][_0x5219('0x1b')][_0x5219('0x18')](_0x17f4df[_0x5219('0xf')][_0x5219('0x1a')]),_0x17f4df[_0x5219('0xf')][_0x5219('0x1b')][_0x5219('0x17')](_0x17f4df[_0x5219('0xf')]['element']);}this[_0x5219('0x1c')](_0x535ddf,_0x5219('0x17'),(_0x3ae8c9,_0x571df8)=>{_0x571df8[_0x5219('0xa')]&&_0x36582a[_0x5219('0x17')](_0x571df8),this[_0x5219('0x1c')](_0x571df8,_0x5219('0x1'),_0x3a657e);}),this[_0x5219('0x1c')](_0x535ddf,_0x5219('0x18'),(_0x42a2ae,_0x4577b9)=>{_0x36582a[_0x5219('0x2')](_0x4577b9)&&_0x36582a[_0x5219('0x18')](_0x4577b9),this['stopListening'](_0x4577b9,_0x5219('0x1'),_0x3a657e);});}}
+const _0x2741=['view','remove','refreshVisibility','pluginName','getByInnerView','element','Annotations','focusTracker','set','stopListening','collection','change:isVisible','refreshPositioning','activeAnnotations','isVisible','createAnnotationView','_deactivateAllAnnotations','deactivateAll','_visibleAnnotations','has','createAnnotation','_activateAnnotation','destroy','add','delete','_removeActiveAnnotation','activate'];(function(_0x575018,_0x2741b8){const _0x558989=function(_0x4236f4){while(--_0x4236f4){_0x575018['push'](_0x575018['shift']());}};_0x558989(++_0x2741b8);}(_0x2741,0x1d3));const _0x5589=function(_0x575018,_0x2741b8){_0x575018=_0x575018-0x0;let _0x558989=_0x2741[_0x575018];return _0x558989;};import{ContextPlugin as _0x36b842}from'ckeditor5/src/core';import _0x27df80 from'./annotation';import _0x4c6d8a from'./annotationcollection';import _0x49014c from'./view/annotationview';export default class b extends _0x36b842{static get[_0x5589('0x16')](){return _0x5589('0x19');}constructor(_0x5d7fe1){super(_0x5d7fe1),this[_0x5589('0x2')]=new _0x4c6d8a(),this['_visibleAnnotations']=new _0x4c6d8a(),this[_0x5589('0x0')](_0x5589('0x5'),new Set()),this['_bindAnnotationsToVisibleAnnotations']();}[_0x5589('0xf')](_0x3ac2ea){this[_0x5589('0x2')]['add'](_0x3ac2ea);}['remove'](_0x1fd251){this['collection']['remove'](_0x1fd251),_0x1fd251['destroy']();}[_0x5589('0x15')](){for(const _0x400b3d of this['collection'])_0x400b3d[_0x5589('0x15')]();}[_0x5589('0x4')](){this[_0x5589('0xa')]['refreshPositioning']();}[_0x5589('0x17')](_0x30c02a){return this[_0x5589('0x2')][_0x5589('0x17')](_0x30c02a);}[_0x5589('0x9')](){this['fire'](_0x5589('0x8'));}[_0x5589('0xe')](){for(const _0x8d05fe of this[_0x5589('0x2')])_0x8d05fe[_0x5589('0xe')]();this['_visibleAnnotations'][_0x5589('0xe')](),this[_0x5589('0x2')][_0x5589('0xe')](),super[_0x5589('0xe')]();}[_0x5589('0x12')](_0x119214){this['fire'](_0x5589('0xd'),_0x119214);}[_0x5589('0xc')](_0x58213b){return new _0x27df80(_0x58213b);}[_0x5589('0x7')](_0x2f3e05,_0x37443e){return new _0x49014c(_0x2f3e05,_0x37443e);}['_addActiveAnnotation'](_0x13be01){const _0x1cc4f0=new Set(this['activeAnnotations']);_0x1cc4f0[_0x5589('0xf')](_0x13be01),this['activeAnnotations']=_0x1cc4f0;}[_0x5589('0x11')](_0x3fa313){const _0x5883c7=new Set(this['activeAnnotations']);_0x5883c7[_0x5589('0x10')](_0x3fa313),this[_0x5589('0x5')]=_0x5883c7;}['_bindAnnotationsToVisibleAnnotations'](){const _0x2d2205=this['collection'],_0x522c92=this[_0x5589('0xa')];function _0x5e7d30(_0x35f99e){const _0xe13085=_0x35f99e['source'];_0xe13085[_0x5589('0x6')]&&!_0x522c92[_0x5589('0xb')](_0xe13085)?_0x522c92[_0x5589('0xf')](_0xe13085):!_0xe13085[_0x5589('0x6')]&&_0x522c92['has'](_0xe13085)&&_0x522c92['remove'](_0xe13085),_0xe13085[_0x5589('0x13')][_0x5589('0x1a')][_0x5589('0x14')](_0xe13085[_0x5589('0x13')][_0x5589('0x18')]),_0xe13085[_0x5589('0x13')][_0x5589('0x1a')]['add'](_0xe13085[_0x5589('0x13')][_0x5589('0x18')]);}this['listenTo'](_0x2d2205,_0x5589('0xf'),(_0x18885a,_0x2dcada)=>{_0x2dcada['isVisible']&&_0x522c92[_0x5589('0xf')](_0x2dcada),this['listenTo'](_0x2dcada,_0x5589('0x3'),_0x5e7d30);}),this['listenTo'](_0x2d2205,'remove',(_0x245b7c,_0xb424ff)=>{_0x522c92['has'](_0xb424ff)&&_0x522c92['remove'](_0xb424ff),this[_0x5589('0x1')](_0xb424ff,_0x5589('0x3'),_0x5e7d30);});}}