@linkurious/ogma-annotations 1.1.12 → 1.1.13

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/Readme.md

@@ -0,0 +1,139 @@
+# `@linkurious/ogma-annotations`
+
+This package provides a set of utilities to help you annotate your Ogma graph. It's a plugin for the [Ogma](https://ogma.linkurio.us) graph visualization library.
+
+## Installation
+
+```bash
+npm install @linkurious/ogma @linkurious/ogma-annotations
+```
+
+## Usage
+
+The plugin comes with no UI of its own, but provides a set of tools that you can enable in your Ogma instance. Currently, it supports the following features:
+
+- **Text boxes**: You can create text boxes on top of your visualisation. They can be moved around and resized. Styling is encoded in the feature's data.
+- **Arrows**: Arrows can be drawn between nodes. They can be styled and can snap to both nodes and text annotations.
+
+```ts
+import Ogma from '@linkurious/ogma';
+import {
+  Control,
+  createArrow,
+  createText,
+  AnnotationCollection,
+} from "@linkurious/ogma-annotations";
+// CSS required to style the controls and handles
+import "@linkurious/ogma-annotations/style.css";
+
+const ogma = new Ogma({...});
+const annotationsEditor = new Control(ogma);
+
+// we assume you have a button with the id 'add-text'
+const addTexts = document.getElementById("add-text")! as HTMLButtonElement;
+
+// user has clicked on the button to add text annotations
+addTexts.addEventListener("click", () => {
+  // disable the button to prevent multiple text annotations from being created
+  addTexts.disabled = true;
+
+  // create a new text annotation when user starts dragging the pointer
+  ogma.events.once("mousedown", (evt) => {
+    // annotations are in graph coordinates
+    const { x, y } = ogma.view.screenToGraphCoordinates(evt);
+    // create a text annotation feature
+    const text = createText(x, y, 0, 0);
+
+    // start drawing
+    annotationsEditor.startText(x, y, text);
+    // finish drawing
+    annotationsEditor.once('dragend', (annotation) => {
+      if (annotation.id !== text.id) return;
+      addTexts.disabled = false;
+    });
+  });
+});
+
+// also stop drawing but pressing the escape key
+document.addEventListener("keydown", (evt) => {
+  if (evt.key === "Escape") annotationsEditor.cancelDrawing();
+});
+```
+
+## API
+
+### `Control`
+
+The `Control` class is the main entry point for the plugin. It provides a set of methods to create and manage annotations.
+
+#### `new Control(ogma: Ogma)`
+
+Creates a new control instance.
+
+#### `.add(annotation: AnnotationCollection | Text | Arrow)`
+
+Adds an annotation to the graph.
+
+#### `.remove(annotation: AnnotationCollection | Text | Arrow)`
+
+Removes an annotation from the graph.
+
+#### `.startText(x: number, y: number, text: Text)`
+
+Starts drawing a text annotation at the given coordinates.
+
+#### `.startArrow(x: number, y: number, arrow: Arrow)`
+
+Starts drawing an arrow annotation at the given coordinates.
+
+#### `.cancelDrawing()`
+
+Cancels the current drawing operation.
+
+#### `.on(event: 'dragend' | 'dragstart' | 'drag' | 'click', listener: (annotation: AnnotationCollection) => void)`
+
+Registers an event listener.
+
+#### `.once(event: 'dragend' | 'dragstart' | 'drag' | 'click', listener: (annotation: AnnotationCollection) => void)`
+
+Registers a one-time event listener.
+
+## `createText(x[=0], y[=0], width[=100], height[=50], content = '', styles?: TextStyles): Text`
+
+Creates a new text annotation.
+
+## `createArrow(x0: number, y0: number, x1: number, y1: number, styles?: ArrowStyles): Arrow`
+
+Creates a new arrow annotation.
+
+## `AnnotationCollection`
+
+An annotation collection is a group of annotations that are related to each other. It can be a text annotation or an arrow annotation. It follows GeoJSON's feature collection format.
+
+## `Text`
+
+A text annotation is a feature that represents a text box on the graph. It has the following properties:
+
+- `id`: a unique identifier for the text annotation.
+- `type`: the type of the feature, which is always `text`.
+- `properties`: an object that contains the text content and the style of the text.
+  - `properties.content: string`: the content of the text.
+  - `properties.style: TextStyle`: the style of the text.
+
+## `Arrow`
+
+An arrow annotation is a feature that represents an arrow on the graph. It has the following properties:
+
+- `id`: a unique identifier for the arrow annotation.
+- `type`: the type of the feature, which is always `arrow`.
+- `properties`: an object that contains the style of the arrow.
+  - `properties.style: ArrowStyle`: the style of the arrow.
+  - `properties.links: { ['start'| 'end']: Link }`: Encoded connections of the arrow to nodes or text annotations.
+
+## [`TextStyle`](src/types.ts)
+
+## [`ArrowStyle`](src/types.ts)
+
+## License
+
+Apache-2.0

package/dist/index.mjs

@@ -841,7 +841,7 @@ class Ye extends Ue {
    * @method update
    * Updates an annotation (position, color etc)
    * @param id Id of the annotation to update
-   * @param new params of the annotation
+   * @param element params of the annotation
    */
   update(t, r) {
     const a = this.getById(t);

package/dist/types/Editor/Arrows/index.d.ts

@@ -1,7 +1,7 @@
 import Ogma, { Point } from "@linkurious/ogma";
 import { createArrow, defaultOptions, defaultStyle } from "./defaults";
 import { Arrow, ControllerOptions } from "../../types";
-import Editor from "../base";
+import { Editor } from "../base";
 /**
  * @class Arrows
  * Draw and edit arrows

package/dist/types/Editor/Texts/index.d.ts

@@ -1,7 +1,7 @@
 import Ogma, { Point } from "@linkurious/ogma";
 import { createText, defaultControllerOptions, defaultOptions, defaultStyle } from "./defaults";
 import { ControllerOptions, Id, Text } from "../../types";
-import Editor from "../base";
+import { Editor } from "../base";
 /**
  * @class Texts
  * Draw, update, edit texts

package/dist/types/Editor/base.d.ts

@@ -6,7 +6,7 @@ import { Annotation, Events, Id } from "../types";
  * Abstract class to display Texts and Arrows, provide add/remove/update and mouse events
  * Modifying annotation is handled by the child classes, it is too specific
  */
-export default abstract class Editor<T extends Annotation> extends eventEmmitter<Events<T>> {
+export declare abstract class Editor<T extends Annotation> extends eventEmmitter<Events<T>> {
     protected ogma: Ogma;
     protected elements: T[];
     protected layer: SVGLayer;
@@ -34,7 +34,7 @@ export default abstract class Editor<T extends Annotation> extends eventEmmitter
      * @method update
      * Updates an annotation (position, color etc)
      * @param id Id of the annotation to update
-     * @param new params of the annotation
+     * @param element params of the annotation
      */
     update(id: Id, element: Partial<T>): void;
     updateAnnotation(target: T, element: Partial<T>): void;

package/dist/types/links.d.ts

@@ -1,5 +1,5 @@
-import { Point } from '@linkurious/ogma';
-import { Arrow, Id, TargetType, Link, Side } from './types';
+import { Point } from "@linkurious/ogma";
+import { Arrow, Id, TargetType, Link, Side } from "./types";
 /**
  * Class that implements linking between annotation arrows and different items.
  * An arrow can be connected to a text or to a node. It supports double indexing

package/dist/types/types.d.ts

@@ -1,10 +1,10 @@
-import { Point } from '@linkurious/ogma';
-import type { Feature, FeatureCollection, Geometry, GeometryObject, LineString, Polygon } from 'geojson';
-import { EVT_ADD, EVT_CANCEL_DRAWING, EVT_DRAG, EVT_DRAG_END, EVT_DRAG_START, EVT_HOVER, EVT_REMOVE, EVT_SELECT, EVT_UNHOVER, EVT_UNSELECT, EVT_UPDATE, EVT_LINK } from './constants';
+import { Point } from "@linkurious/ogma";
+import type { Feature, FeatureCollection, Geometry, GeometryObject, LineString, Polygon } from "geojson";
+import { EVT_ADD, EVT_CANCEL_DRAWING, EVT_DRAG, EVT_DRAG_END, EVT_DRAG_START, EVT_HOVER, EVT_REMOVE, EVT_SELECT, EVT_UNHOVER, EVT_UNSELECT, EVT_UPDATE, EVT_LINK } from "./constants";
 export declare const isArrow: (a: AnnotationFeature<Geometry, AnnotationProps>) => a is Arrow;
 export declare const isText: (a: AnnotationFeature<Geometry, AnnotationProps>) => a is Text;
 export declare const isAnnotationCollection: (a: AnnotationFeature<Geometry, AnnotationProps> | FeatureCollection) => a is AnnotationCollection;
-type AnnotationType = 'arrow' | 'text';
+type AnnotationType = "arrow" | "text";
 export interface AnnotationProps {
     type: AnnotationType;
     style?: unknown;
@@ -19,12 +19,12 @@ export interface ArrowStyles extends StrokeOptions {
 }
 type ExportedLink = {
     id: Id;
-    side: 'start' | 'end';
-    type: 'node' | 'text';
+    side: "start" | "end";
+    type: "node" | "text";
     magnet?: Point;
 };
 export interface ArrowProperties extends AnnotationProps {
-    type: 'arrow';
+    type: "arrow";
     style?: ArrowStyles;
     link?: Partial<Record<Side, ExportedLink>>;
 }
@@ -33,7 +33,7 @@ export interface AnnotationCollection extends FeatureCollection {
     features: (Arrow | Text)[];
 }
 export type StrokeOptions = {
-    strokeType?: 'plain' | 'dashed' | 'none';
+    strokeType?: "plain" | "dashed" | "none";
     strokeColor?: string;
     strokeWidth?: number;
 };
@@ -50,19 +50,19 @@ export interface TextStyle extends StrokeOptions {
     padding?: number;
 }
 export interface TextProperties extends AnnotationProps {
-    type: 'text';
+    type: "text";
     /**text to display*/
     content: string;
     style?: TextStyle;
 }
 export type Text = AnnotationFeature<Polygon, TextProperties>;
 export type Stroke = {
-    type: 'plain' | 'dashed' | 'none';
+    type: "plain" | "dashed" | "none";
     color: string;
     width: number;
 };
 export type StrokeStyle = Stroke;
-export type Extremity = 'none' | 'arrow' | 'arrow-plain';
+export type Extremity = "none" | "arrow" | "arrow-plain";
 export type AnnotationOptions = {
     handleSize: number;
     placeholder: string;
@@ -73,7 +73,7 @@ export type Events<T> = {
     [EVT_SELECT]: (evt: T) => void;
     [EVT_UNSELECT]: (evt: T) => void;
     [EVT_DRAG_START]: (evt: T) => void;
-    [EVT_DRAG]: (evt: T, key: 'line' | 'start' | 'end' | 'text') => void;
+    [EVT_DRAG]: (evt: T, key: "line" | "start" | "end" | "text") => void;
     [EVT_DRAG_END]: (evt: T) => void;
     [EVT_REMOVE]: (evt: T) => void;
     [EVT_ADD]: (evt: T) => void;
@@ -120,16 +120,16 @@ export type FeatureEvents = {
     /**
      * Event trigerred when dragging an arrow or a text
      */
-    [EVT_DRAG]: (evt: Arrow | Text, key: 'line' | 'start' | 'end' | 'text') => void;
+    [EVT_DRAG]: (evt: Arrow | Text, key: "line" | "start" | "end" | "text") => void;
     /**
      * Event trigerred when stopped dragging an arrow or a text
      */
     [EVT_DRAG_END]: (evt: Arrow | Text) => void;
 };
-export type TargetType = 'text' | 'node';
-export type Side = 'start' | 'end';
+export type TargetType = "text" | "node";
+export type Side = "start" | "end";
 export type Link = {
-    /** arrow atteched to the text or node */
+    /** arrow attached to the text or node */
     arrow: Id;
     /** id of the text the arrow is attached to */
     id: Id;
@@ -146,6 +146,9 @@ export type Link = {
     connectionPoint: Point;
 };
 export type ControllerOptions = {
+    /**
+     * The color of the magnet points
+     */
     magnetColor: string;
     /**
      * The radius in which arrows are attracted

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/ogma-annotations",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "Headless annotation plugin for Ogma",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",
@@ -30,7 +30,7 @@
     "prepare": "playwright install",
     "start": "npm run dev",
     "dev": "vite -c web/vite.config.ts",
-    "build:ui": "vite build -c vite.config-ui.ts",
+    "build:demo": "vite build -c web/vite.config.mts",
     "prebuild": "rm -rf dist",
     "bump:patch": "bump2version patch && npm version --no-git-tag-version patch",
     "bump:minor": "bump2version minor && npm version --no-git-tag-version minor",
@@ -40,7 +40,8 @@
     "lint": "eslint --ext ts --ext js src",
     "types": "tsc --d -emitDeclarationOnly --outDir dist/types",
     "preview": "vite preview",
-    "docs:build": "typedoc --plugin typedoc-plugin-markdown --out ../../docs/annotations src/index.ts",
+    "docs:build": "typedoc --plugin typedoc-plugin-markdown --out ../../docs/api src/index.ts",
+    "postdocs:build": "npm run build:demo",
     "test:unit": "vitest run -c test/unit/vitest.config.mts",
     "test:watch": "vitest watch -c test/unit/vitest.config.mts",
     "test:e2e": "vitest run -c test/e2e/vitest.config.mts",
@@ -64,7 +65,7 @@
   "author": "Linkurious SAS",
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@linkurious/ogma": ">=5.0.4"
+    "@linkurious/ogma": ">=4.5.6 || ^5.0.0"
   },
   "dependencies": {
     "@borgar/textbox": "1.6.0",
@@ -80,12 +81,13 @@
     "get-port": "7.0.0",
     "jsdom": "24.0.0",
     "playwright": "1.42.1",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "5.3.3",
     "vite": "5.2.0",
     "vitest": "1.4.0"
   },
   "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
     "extends": [
       "@linkurious/eslint-config-ogma"
     ]