@ckeditor/ckeditor5-comments 38.1.1 → 38.2.0-alpha.1

package/src/annotations/annotations.d.ts

@@ -1,150 +1,150 @@
-/**
- * @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: [];
-};
+/**
+ * @module comments/annotations/annotations
+ * @publicApi
+ */
+import { ContextPlugin, type Context, type Editor } from 'ckeditor5/src/core.js';
+import type { View } from 'ckeditor5/src/ui.js';
+import { type Locale } from 'ckeditor5/src/utils.js';
+import Annotation, { type AnnotationTarget } from './annotation.js';
+import AnnotationCollection from './annotationcollection.js';
+import AnnotationView, { type AnnotationMainView } from './view/annotationview.js';
+/**
+ * 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 _0xab17=['focusTracker','_removeActiveAnnotation','change:isVisible','_deactivateAllAnnotations','createAnnotation','pluginName','createAnnotationView','set','isVisible','getByInnerView','refreshPositioning','element','deactivateAll','listenTo','_activateAnnotation','collection','Annotations','add','delete','fire','view','remove','refreshVisibility','has','_bindAnnotationsToVisibleAnnotations','destroy','source','_addActiveAnnotation','activeAnnotations','_visibleAnnotations'];(function(_0x5c9264,_0xab1730){const _0x50b19e=function(_0x3e96c2){while(--_0x3e96c2){_0x5c9264['push'](_0x5c9264['shift']());}};_0x50b19e(++_0xab1730);}(_0xab17,0x1e9));const _0x50b1=function(_0x5c9264,_0xab1730){_0x5c9264=_0x5c9264-0x0;let _0x50b19e=_0xab17[_0x5c9264];return _0x50b19e;};import{ContextPlugin as _0x51097d}from'ckeditor5/src/core';import _0x43ff16 from'./annotation';import _0x1d4d19 from'./annotationcollection';import _0x260d34 from'./view/annotationview';export default class b extends _0x51097d{static get[_0x50b1('0x1a')](){return _0x50b1('0x7');}constructor(_0x285e48){super(_0x285e48),this[_0x50b1('0x6')]=new _0x1d4d19(),this['_visibleAnnotations']=new _0x1d4d19(),this[_0x50b1('0x1c')]('activeAnnotations',new Set()),this[_0x50b1('0xf')]();}[_0x50b1('0x8')](_0x48de32){this['collection'][_0x50b1('0x8')](_0x48de32);}[_0x50b1('0xc')](_0x3700b3){this[_0x50b1('0x6')][_0x50b1('0xc')](_0x3700b3),_0x3700b3[_0x50b1('0x10')]();}[_0x50b1('0xd')](){for(const _0x1ffcd9 of this[_0x50b1('0x6')])_0x1ffcd9[_0x50b1('0xd')]();}[_0x50b1('0x1')](){this['_visibleAnnotations'][_0x50b1('0x1')]();}[_0x50b1('0x0')](_0xc1330e){return this[_0x50b1('0x6')]['getByInnerView'](_0xc1330e);}[_0x50b1('0x3')](){this[_0x50b1('0xa')](_0x50b1('0x18'));}[_0x50b1('0x10')](){for(const _0x1b3e2a of this['collection'])_0x1b3e2a['destroy']();this['_visibleAnnotations'][_0x50b1('0x10')](),this[_0x50b1('0x6')]['destroy'](),super[_0x50b1('0x10')]();}['activate'](_0x2813a6){this[_0x50b1('0xa')](_0x50b1('0x5'),_0x2813a6);}[_0x50b1('0x19')](_0x2736ac){return new _0x43ff16(_0x2736ac);}[_0x50b1('0x1b')](_0x5a0c97,_0x1f7176){return new _0x260d34(_0x5a0c97,_0x1f7176);}[_0x50b1('0x12')](_0x3fb498){const _0x147848=new Set(this[_0x50b1('0x13')]);_0x147848[_0x50b1('0x8')](_0x3fb498),this[_0x50b1('0x13')]=_0x147848;}[_0x50b1('0x16')](_0x57b9c4){const _0x24b807=new Set(this['activeAnnotations']);_0x24b807[_0x50b1('0x9')](_0x57b9c4),this['activeAnnotations']=_0x24b807;}[_0x50b1('0xf')](){const _0x5f03e1=this[_0x50b1('0x6')],_0x383016=this[_0x50b1('0x14')];function _0x5f0b7e(_0x471d4f){const _0x50aae7=_0x471d4f[_0x50b1('0x11')];_0x50aae7[_0x50b1('0x1d')]&&!_0x383016[_0x50b1('0xe')](_0x50aae7)?_0x383016[_0x50b1('0x8')](_0x50aae7):!_0x50aae7[_0x50b1('0x1d')]&&_0x383016[_0x50b1('0xe')](_0x50aae7)&&_0x383016[_0x50b1('0xc')](_0x50aae7),_0x50aae7[_0x50b1('0xb')][_0x50b1('0x15')][_0x50b1('0xc')](_0x50aae7[_0x50b1('0xb')][_0x50b1('0x2')]),_0x50aae7['view'][_0x50b1('0x15')]['add'](_0x50aae7[_0x50b1('0xb')][_0x50b1('0x2')]);}this[_0x50b1('0x4')](_0x5f03e1,_0x50b1('0x8'),(_0x402504,_0x3c9708)=>{_0x3c9708['isVisible']&&_0x383016[_0x50b1('0x8')](_0x3c9708),this[_0x50b1('0x4')](_0x3c9708,'change:isVisible',_0x5f0b7e);}),this[_0x50b1('0x4')](_0x5f03e1,_0x50b1('0xc'),(_0x3b0e29,_0x1d8716)=>{_0x383016[_0x50b1('0xe')](_0x1d8716)&&_0x383016['remove'](_0x1d8716),this['stopListening'](_0x1d8716,_0x50b1('0x17'),_0x5f0b7e);});}}
+const _0x5a99=['element','focusTracker','listenTo','Annotations','deactivateAll','_addActiveAnnotation','collection','getByInnerView','add','change:isVisible','stopListening','_bindAnnotationsToVisibleAnnotations','refreshVisibility','delete','pluginName','refreshPositioning','has','view','fire','destroy','_activateAnnotation','_visibleAnnotations','remove','activeAnnotations','isVisible','source'];(function(_0x59d138,_0x5a9928){const _0x5a84f9=function(_0x18fa55){while(--_0x18fa55){_0x59d138['push'](_0x59d138['shift']());}};_0x5a84f9(++_0x5a9928);}(_0x5a99,0x1dd));const _0x5a84=function(_0x59d138,_0x5a9928){_0x59d138=_0x59d138-0x0;let _0x5a84f9=_0x5a99[_0x59d138];return _0x5a84f9;};import{ContextPlugin as _0x14d2ba}from'ckeditor5/src/core.js';import _0x3d0bdf from'./annotation.js';import _0x18883b from'./annotationcollection.js';import _0x28232b from'./view/annotationview.js';export default class b extends _0x14d2ba{static get[_0x5a84('0x5')](){return _0x5a84('0x14');}constructor(_0x47ddb4){super(_0x47ddb4),this[_0x5a84('0x17')]=new _0x18883b(),this['_visibleAnnotations']=new _0x18883b(),this['set']('activeAnnotations',new Set()),this[_0x5a84('0x2')]();}[_0x5a84('0x19')](_0x5b217c){this[_0x5a84('0x17')][_0x5a84('0x19')](_0x5b217c);}[_0x5a84('0xd')](_0x502335){this[_0x5a84('0x17')][_0x5a84('0xd')](_0x502335),_0x502335[_0x5a84('0xa')]();}[_0x5a84('0x3')](){for(const _0x37531d of this['collection'])_0x37531d[_0x5a84('0x3')]();}[_0x5a84('0x6')](){this['_visibleAnnotations'][_0x5a84('0x6')]();}[_0x5a84('0x18')](_0x4a6554){return this[_0x5a84('0x17')]['getByInnerView'](_0x4a6554);}[_0x5a84('0x15')](){this['fire']('_deactivateAllAnnotations');}[_0x5a84('0xa')](){for(const _0x34665c of this[_0x5a84('0x17')])_0x34665c[_0x5a84('0xa')]();this[_0x5a84('0xc')][_0x5a84('0xa')](),this[_0x5a84('0x17')][_0x5a84('0xa')](),super[_0x5a84('0xa')]();}['activate'](_0x48e6c0){this[_0x5a84('0x9')](_0x5a84('0xb'),_0x48e6c0);}['createAnnotation'](_0xa2492){return new _0x3d0bdf(_0xa2492);}['createAnnotationView'](_0x35c266,_0x42f684){return new _0x28232b(_0x35c266,_0x42f684);}[_0x5a84('0x16')](_0x1c528d){const _0x1c9701=new Set(this[_0x5a84('0xe')]);_0x1c9701[_0x5a84('0x19')](_0x1c528d),this[_0x5a84('0xe')]=_0x1c9701;}['_removeActiveAnnotation'](_0x5953b7){const _0x3f02df=new Set(this[_0x5a84('0xe')]);_0x3f02df[_0x5a84('0x4')](_0x5953b7),this['activeAnnotations']=_0x3f02df;}[_0x5a84('0x2')](){const _0x37781a=this[_0x5a84('0x17')],_0x1c5a41=this['_visibleAnnotations'];function _0x50a938(_0x4228e2){const _0x371cb6=_0x4228e2[_0x5a84('0x10')];_0x371cb6[_0x5a84('0xf')]&&!_0x1c5a41['has'](_0x371cb6)?_0x1c5a41[_0x5a84('0x19')](_0x371cb6):!_0x371cb6['isVisible']&&_0x1c5a41[_0x5a84('0x7')](_0x371cb6)&&_0x1c5a41[_0x5a84('0xd')](_0x371cb6),_0x371cb6[_0x5a84('0x8')][_0x5a84('0x12')][_0x5a84('0xd')](_0x371cb6['view'][_0x5a84('0x11')]),_0x371cb6[_0x5a84('0x8')]['focusTracker'][_0x5a84('0x19')](_0x371cb6['view'][_0x5a84('0x11')]);}this[_0x5a84('0x13')](_0x37781a,_0x5a84('0x19'),(_0x1689fc,_0x4a0dab)=>{_0x4a0dab[_0x5a84('0xf')]&&_0x1c5a41['add'](_0x4a0dab),this['listenTo'](_0x4a0dab,_0x5a84('0x0'),_0x50a938);}),this['listenTo'](_0x37781a,_0x5a84('0xd'),(_0x410f44,_0x3d9224)=>{_0x1c5a41[_0x5a84('0x7')](_0x3d9224)&&_0x1c5a41[_0x5a84('0xd')](_0x3d9224),this[_0x5a84('0x1')](_0x3d9224,_0x5a84('0x0'),_0x50a938);});}}