@linkurious/ogma-annotations-react 1.1.26 → 2.0.0

package/dist/types/index.d.ts

@@ -1,27 +1,27 @@
 import { Annotation } from '@linkurious/ogma-annotations';
 import { AnnotationCollection } from '@linkurious/ogma-annotations';
 import { AnnotationFeature } from '@linkurious/ogma-annotations';
+import { ArrowProperties } from '@linkurious/ogma-annotations';
 import { ArrowStyles } from '@linkurious/ogma-annotations';
+import { Box } from '@linkurious/ogma-annotations';
+import { BoxProperties } from '@linkurious/ogma-annotations';
+import { Comment as Comment_2 } from '@linkurious/ogma-annotations';
+import { CommentProps } from '@linkurious/ogma-annotations';
+import { Context } from 'react';
 import { Control } from '@linkurious/ogma-annotations';
+import { createBox } from '@linkurious/ogma-annotations';
+import { createComment } from '@linkurious/ogma-annotations';
+import { createPolygon } from '@linkurious/ogma-annotations';
 import { default as default_2 } from 'react';
+import { getAnnotationsBounds } from '@linkurious/ogma-annotations';
+import { isBox } from '@linkurious/ogma-annotations';
+import { isComment } from '@linkurious/ogma-annotations';
+import { isPolygon } from '@linkurious/ogma-annotations';
+import { Polygon } from '@linkurious/ogma-annotations';
+import { PolygonProperties } from '@linkurious/ogma-annotations';
 import { ReactElement } from 'react';
 import { TextStyle } from '@linkurious/ogma-annotations';
 
-declare type AnnotationAction = {
-    type: AnnotationActionType;
-    payload: Annotation;
-};
-
-declare type AnnotationActionType = "add" | "remove" | "update";
-
-/**
- * Creates a React context for managing annotations with type safety.
- *
- * @type {Context<IAnnotationsContext>} A typed context for annotation-related
- * state and operations
- */
-export declare const AnnotationsContext: default_2.Context<IAnnotationsContext>;
-
 /**
  * Provides a context provider for managing annotations in a graph visualization.
  *
@@ -33,14 +33,31 @@ export declare const AnnotationsContext: default_2.Context<IAnnotationsContext>;
  */
 export declare const AnnotationsContextProvider: ({ children, annotations: initialAnnotations }: Props) => default_2.JSX.Element;
 
+export { ArrowProperties }
+
+/** @private */
 export declare const BLACK = "#333333";
 
+export { Box }
+
+export { BoxProperties }
+
+export { Comment_2 as Comment }
+
+export { CommentProps }
+
 /**
  * Creates a React context for managing annotations with optional type safety.
  *
  * @returns {Context<IAnnotationsContext | null>} A context for annotation-related state and operations that can be null
  */
-export declare function createAnnotationsContext(): default_2.Context<IAnnotationsContext | null>;
+export declare function createAnnotationsContext(): Context<IAnnotationsContext | null>;
+
+export { createBox }
+
+export { createComment }
+
+export { createPolygon }
 
 /**
  * Default arrow style for annotations.
@@ -62,11 +79,15 @@ export declare const defaultTextStyle: TextStyle;
 
 /**
  * List of available fonts for annotations.
+ * @private
  */
 export declare const fonts: string[];
 
+/** @private */
 export declare const fontSizes: number[];
 
+export { getAnnotationsBounds }
+
 /**
  * Defines the context interface for managing annotations in a React application.
  *
@@ -77,8 +98,6 @@ export declare const fontSizes: number[];
 export declare interface IAnnotationsContext {
     /** Current annotations in the application. */
     annotations: AnnotationCollection;
-    /** Updates the annotations in the application. */
-    updateAnnotations: default_2.Dispatch<AnnotationAction>;
     /** The currently selected annotation in the application. */
     currentAnnotation: AnnotationFeature | null;
     /** Sets the currently selected annotation in the application. */
@@ -103,16 +122,55 @@ export declare interface IAnnotationsContext {
     editor: Control;
     /** Sets the current annotations editor for managing annotations. */
     setEditor: (editor: Control) => void;
+    /** Whether undo is available */
+    canUndo: boolean;
+    /** Whether redo is available */
+    canRedo: boolean;
+    /** Undo the last action */
+    undo: () => boolean;
+    /** Redo the last undone action */
+    redo: () => boolean;
+    /** Clear the history */
+    clearHistory: () => void;
+    /** Add annotations */
+    add: (annotation: Annotation | AnnotationCollection) => void;
+    /** Remove annotations */
+    remove: (annotation: Annotation | AnnotationCollection) => void;
+    /** Cancel the current drawing operation */
+    cancelDrawing: () => void;
+    /** Select annotations by ID */
+    select: (ids: string | string[]) => void;
+    /** Enable box drawing mode */
+    enableBoxDrawing: (style?: Partial<Box["properties"]["style"]>) => void;
+    /** Enable polygon drawing mode */
+    enablePolygonDrawing: (style?: Partial<Polygon["properties"]["style"]>) => void;
+    /** Enable comment drawing mode */
+    enableCommentDrawing: (options?: {
+        offsetX?: number;
+        offsetY?: number;
+        commentStyle?: Partial<Comment_2["properties"]>;
+        arrowStyle?: Partial<ArrowProperties>;
+    }) => void;
 }
 
 export declare function interpolate(t: number, min?: number, max?: number): number;
 
+export { isBox }
+
+export { isComment }
+
+export { isPolygon }
+
 export declare function mean(array: number[]): number;
 
 export declare function normalize(t: number, min?: number, max?: number): number;
 
+export { Polygon }
+
+export { PolygonProperties }
+
 declare interface Props {
-    children: ReactElement;
+    children: ReactElement | ReactElement[];
     annotations?: AnnotationCollection;
 }
 
@@ -121,6 +179,7 @@ declare interface Props {
  */
 export declare const RELATIVE_PADDING = 0.25;
 
+/** @private */
 export declare const TRANSPARENT = "none";
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/ogma-annotations-react",
-  "version": "1.1.26",
+  "version": "2.0.0",
   "description": "A react component to add ogma annotations with  react",
   "type": "module",
   "main": "dist/index.mjs",
@@ -15,12 +15,16 @@
   ],
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
-      "default": "./dist/index.mjs",
-      "types": "./dist/types/index.d.ts"
+      "default": "./dist/index.mjs"
+    },
+    "./umd": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     },
-    "./umd": "./dist/index.js",
     "./esm": "./dist/index.mjs"
   },
   "scripts": {
@@ -30,10 +34,10 @@
     "bump:patch": "bump2version patch && npm version --no-git-tag-version patch",
     "bump:minor": "bump2version minor && npm version --no-git-tag-version minor",
     "bump:major": "bump2version major && npm version --no-git-tag-version major",
-    "docs:build": "vite build -c web/vite.config.mts",
+    "docs:build": "typedoc && vite build -c web/vite.config.mts",
     "postdocs:build": "bash scripts/postdocs.sh",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
-    "lint:ci": "eslint -f checkstyle -o reports/checkstyle.xml --ext ts,tsx src",
+    "lint": "eslint src web --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint:ci": "eslint -f checkstyle -o reports/checkstyle.xml --ext ts,tsx src web",
     "test:unit": "vitest run",
     "test": "npm run test:unit"
   },
@@ -52,7 +56,7 @@
   "license": "Apache-2.0",
   "peerDependencies": {
     "@linkurious/ogma": ">=4.5.6 || ^5.0.0",
-    "@linkurious/ogma-annotations": "^1.1.26",
+    "@linkurious/ogma-annotations": "2.0.0",
     "@linkurious/ogma-react": ">=5",
     "react": ">=17"
   },
@@ -65,14 +69,18 @@
     "eslint": "8.56.0",
     "eslint-plugin-react-hooks": "4.6.0",
     "eslint-plugin-react-refresh": "0.4.5",
-    "iconoir-react": "^7.10.1",
+    "lucide-react": "0.562.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",
+    "typedoc": "0.28.15",
+    "typedoc-plugin-markdown": "4.9.0",
+    "typedoc-vitepress-theme": "1.1.2",
     "typescript": "5.3.3",
-    "vite": "6.3.5",
+    "vanilla-colorful": "0.7.2",
+    "vite": "latest",
     "vite-plugin-dts": "4.5.1",
     "vite-plugin-lib-inject-css": "1.3.0",
-    "vitest": "3.0.7"
+    "vitest": "latest"
   },
   "eslintConfig": {
     "extends": [
@@ -89,7 +97,11 @@
         {
           "allowConstantExport": true
         }
-      ]
+      ],
+      "import/no-unresolved": "off"
     }
+  },
+  "dependencies": {
+    "react-day-picker": "9.13.0"
   }
 }