Layer functionality, renewed edit mode

Gruntfile.js

@@ -128,6 +128,12 @@ module.exports = function(grunt) {
 
     grunt.registerTask('default', []);
     grunt.registerTask('all', ["uglify", "css"]);
+
+    // todo enable build-only step
+    grunt.registerTask('build', 'Build Necessary Parts of the Viewer', function () {
+        // todo only on a single place:
+        exec("npx esbuild --bundle --sourcemap --format=esm --outfile=ui/index.js ui/index.mjs");
+    });
     grunt.registerTask('plugins', ["uglify:plugins"]);
     grunt.registerTask('modules', ["uglify:modules"]);
     grunt.registerTask('buildUI', function (){

modules/README.md

@@ -128,10 +128,7 @@ Return data exported with the viewer if available. Exporting the data is done th
 
 ### Events
 Modules (and plugins) can have their own event system - in that case, the `EVENTS.md` description
-should be provided. These events require OpenSeadragon.EventSource implementation (which it is based on) and it
-should be invoked on the ``XOpatModule`` or `XOpatModuleSingleton` instance. 
-
-> Events are available only after `this.registerAsEventSource()` has been called.
+should be provided. These events require OpenSeadragon.EventSource implementation (which it is based on).
 
 ### Localization
 Can be done using ``this.loadLocale(locale, data)`` which behaves like plugin's `loadLocale` function

modules/annotations/EVENTS.md

@@ -1,9 +1,14 @@
 # Events in OSD Annotations
 
-##### factory-registered | e: `{factory: OSDAnnotations.AnnotationObjectFactory}`
+Some events are fired on the global instance of OSD Annotations. Some events are
+fired on particular annotation context - depends on the particular viewer the annotations are on.
 
-##### visual-property-changed | ``{[name]: any}``
-Common visual property changed.
+For global events, it is enough to say ``OSDAnnotations.addHandler(...)``. For contextual events,
+ TODO api not finished.
+
+## Global Events
+
+##### factory-registered | e: `{factory: OSDAnnotations.AnnotationObjectFactory}`
 
 ##### osd-interactivity-toggle
 
@@ -112,11 +117,11 @@ This event is fired prior to changing annotation preset. Same usage as `annotati
 
 ##### history-select | ``{incrementId: number, originalEvent: MouseEvent}``
 
-##### import | ``{options: object, clear: boolean, data: object}``
+##### import | ``{options: object, clear: boolean, data: object, owner: FabricWrapper}``
 
-##### export-partial | ``{options: object, data: object}``
+##### export-partial | ``{options: object, data: object, owner: FabricWrapper}``
 
-##### export | ``{data: string}``
+##### export | ``{data: string, owner: FabricWrapper}``
 
 #### mode-changed | ``{mode: OSDAnnotatinos.AnnotationState}``
 
@@ -136,4 +141,82 @@ Called when the annotation modes did not handle mouse release action.
 ##### canvas-release-not-handled
 Called when the annotation modes did not handle mouse release action.
 
+#### canvas-release | ``{originalEvent: Event, pressTime: number}``
+TODO do we want to keep this?
+
 Fires ``warn-user``, ``error-user`` and `warn-system` on the viewer instance.
+
+## Viewer Contextual Events - ``FabricProxy``
+
+#### active-layer-changed | ``{id: string}``
+
+#### layer-selection-changed | ``{ids: string[], isSelected: boolean}``
+
+##### layer-added | ``{layer: OSDAnnotations.AnnotationLayer}``
+
+##### layer-removed | ``{layer: OSDAnnotations.AnnotationLayer}``
+
+##### annotation-selection-changed | ``{ids: string[], isSelected: boolean, fromCanvas: boolean}``
+
+##### annotation-create | ``{object: fabric.Object}``
+Fires when annotation object is created. This does not apply when
+``annotation-replace`` is called - in that case, the replacement is
+considered as the creation.
+
+##### annotation-before-create | ``{object: fabric.Object, isCancelled: () => boolean, setCancelled: (cancelled: boolean) => void}``
+This event is fired prior to inserting any annotation, including promotion (simple helper annotation creation is not affected).
+`isCancelled` can be called to check if the deletion was already requested to be cancelled (by another plugin/module for example)
+`setCancelled` can be used to request to cancel the deletion
+
+##### annotation-delete | ``{object: fabric.Object}``
+
+##### annotation-before-delete | ``{object: fabric.Object, isCancelled: () => boolean, setCancelled: (cancelled: boolean) => void}``
+This event is fired prior to deleting any annotation.
+`isCancelled` can be called to check if the deletion was already requested to be cancelled (by another plugin/module for example)
+`setCancelled` can be used to request to cancel the deletion
+
+##### annotation-replace | ``{previous: fabric.Object, next: fabric.Object}``
+This event is fired when annotation is replaced, e.g. free-form-tool edit. Such edits
+in fact replace annotation with a new one, although the annotation identity as perceived
+by the user remains the same. This event is called only once per update,
+at the end.
+
+##### annotation-before-replace | ``{object: fabric.Object, isCancelled: () => boolean, setCancelled: (cancelled: boolean) => void}``
+This event is fired prior to replacing annotation. Same usage as `annotation-before-delete`
+
+##### annotation-replace-doppelganger | ``{previous: fabric.Object, next: fabric.Object}``
+This event is fired when annotations are replaced, but only temporarily (e.g. via free form tool).
+It can be called several times during one edit action.
+
+##### annotation-before-replace-doppelganger | ``{object: fabric.Object, isCancelled: () => boolean, setCancelled: (cancelled: boolean) => void}``
+This event is fired prior to replacing doppelganger annotation. Same usage as `annotation-before-delete`
+
+##### annotation-edit | ``{object: fabric.Object}``
+This event is fired when user performs direct annotation editing.
+
+##### annotation-before-edit | ``{object: fabric.Object, isCancelled: () => boolean, setCancelled: (cancelled: boolean) => void}``
+This event is fired prior to editing annotation. Same usage as `annotation-before-delete`
+
+##### annotation-set-private | ``{object: fabric.Object}``
+This event is fired when the `private` property of an annotation changes.
+
+##### annotation-add-comment | ``{object: fabric.Object, comment: AnnotationComment}``
+This event is fired when a comment is added, one by one.
+```ts
+type AnnotationComment = {
+  id: string;
+  author: {
+    id: string;
+    name: string;
+  };
+  content: string;
+  createdAt: Date;
+  removed?: boolean;
+}
+```
+
+##### annotation-delete-comment | ``{object: fabric.Object, commentId: string}``
+This event is fired when a comment is deleted, one by one.
+
+##### visual-property-changed | ``{[name]: any}``
+Common visual property changed.