@neo4j-nvl/base 0.3.1 → 0.3.2

package/dist/types/utils/constants.d.ts

@@ -4,6 +4,7 @@ export declare const MaxIndexBuffer = 65536;
 export declare const MinRelLength = 100;
 export declare const Gravity = 100;
 export declare const SimulationStopVelocity = 100;
+export declare const VerletSimulationStopVelocity = 0.1;
 export declare const MappingEnd = 999999;
 export declare const ActiveAnimDuration = 1000;
 export declare const DefaultNodeSize = 25;
@@ -28,3 +29,4 @@ export declare const GlAdjust: number;
  */
 export declare const getDevicePixelRatio: () => number;
 export declare const HtmlCaptionMinWidthThreshold = 5;
+export declare const allowedWrappers: string[];

package/dist/types/utils/errors.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/geometry.d.ts

@@ -10,11 +10,11 @@ export interface Point {
 }
 /**
  * This function checks if the coordinates are defined.
- * @param {Point} from - The node the edge starts from.
- * @param {Point} to - The node the edge ends at.
+ * @param {Point | Node} from - The node the edge starts from.
+ * @param {Point | Node} to - The node the edge ends at.
  * @returns {boolean} True if the coordinates are defined.
  */
-export declare const areCoordinateDefined: (from: Point, to: Point) => boolean;
+export declare const areCoordinateDefined: (from: Point | Node, to: Point | Node) => boolean;
 /**
  * Returns true if the two points are within PointDelta pixels of each other
  * This function is used to determine if a new point is close enough to an

package/dist/types/utils/geometry.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/graphObjectUtils.d.ts

@@ -1,9 +1,23 @@
-export function relItemsToFlatList(relItems: any[]): any[];
-export function getAdjNodesMapAndRelMap(rels: any): {
-    adjNodesMap: {};
-    relMap: {};
+import type { DataSet } from '../modules/dataset';
+import type { Node, Relationship } from '../types/graph-element';
+export type FlatRel = Omit<Relationship & {
+    bundledRels: Omit<Relationship, 'from' | 'to'>[];
+    key: string;
+}, 'id'>;
+/**
+ * Flattens a list of relationships so only one relationship remains between two nodes.
+ * Falls back to default rel color when relationships between two nodes have varying colors.
+ * Sums widths of relationships when more than one relationship exists between two nodes.
+ * @param {Relationship[]} relItems List of all relationships and their connected ids.
+ * @return {FlatRel[]} A flattened list of relationships.
+ */
+export declare const relItemsToFlatList: (relItems: Relationship[]) => FlatRel[];
+export declare const getAdjNodesMapAndRelMap: (rels: Relationship[]) => {
+    adjNodesMap: Record<string, Set<string>>;
+    relMap: Record<string, Relationship[]>;
 };
-export function getConnectedNodesAndRels(addedNodes: any, addedRels: any, nodes: any, rels: any): {
-    connectedNodes: {};
-    connectedRels: {};
+export declare const getConnectedNodesAndRels: (addedNodes: Set<Node['id']>, addedRels: Set<Relationship['id']>, nodes: DataSet<Node>, rels: DataSet<Relationship>) => {
+    connectedNodes: Record<string, Node>;
+    connectedRels: Record<string, Relationship>;
 };
+export declare const hasSizeChanged: (graphObjectUpdates?: Node[]) => boolean;

package/dist/types/utils/graphObjectUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/hittest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/mouseUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/segmentAnalytics.d.ts

@@ -0,0 +1,51 @@
+import * as SegmentJS from '@segment/analytics-next';
+type AnalyticsTrackPayload = {
+    eventPrefix: string;
+    event: string;
+    properties?: Record<string, unknown>;
+};
+export declare abstract class AnalyticsFunction {
+    /**
+     * Perform asynchronous bootstrapping
+     */
+    abstract init(apiKey: string): void;
+    /**
+     * Associate session with known user identifier
+     */
+    abstract identify(): void;
+    /**
+     * Load unique segment Id in the localstorage
+     */
+    abstract loadSavedSegmentId(): string;
+    /**
+     * save unique segment Id in the localstorage
+     */
+    abstract saveTrackingId(segmentId: string): void;
+    /**
+     * get/fetch unique segment Id from the localstorage
+     */
+    abstract getSegmentTrackingId(): Record<string, unknown>;
+    /**
+     * Track arbitrary event
+     */
+    abstract trackEvent(payload: AnalyticsTrackPayload): void;
+}
+/**
+ * Analytics adapter for Segment Analytics.js
+ */
+export declare class SegmentAnalytics implements AnalyticsFunction {
+    private analytics;
+    constructor();
+    init(apiKey: string): void;
+    trackEvent(payload: {
+        eventPrefix: string;
+        event: string;
+        properties: SegmentJS.EventProperties;
+    }): Promise<void>;
+    identify(): void;
+    loadSavedSegmentId(): string;
+    getSegmentTrackingId(): any;
+    saveTrackingId(segmentId: string): void;
+    private ready;
+}
+export {};

package/dist/types/utils/zoomFunctions.d.ts

@@ -1,6 +1,6 @@
 import type { Node } from '../index';
 import type { Point } from './geometry';
-declare const getExtremeLimits: (nodePositions: Point[] | Node[]) => Point[];
+declare const getExtremeLimits: (nodePositions: Point[]) => Point[];
 declare const getMaxDistance: (extremeLimits?: Point[]) => number;
 declare const getPositionBoundaries: (nodePositions?: Point[] | Node[], maxNodeRadius?: number) => {
     centerX: number;
@@ -13,8 +13,8 @@ declare const getZoomLevel: (viewWidth: number, viewHeight: number, sceneWidth:
     zoomY: number;
 };
 declare const createZoomTarget: (zoomX: number, zoomY: number, minZoom?: number, maxZoom?: number) => number;
-declare const getFlexibleZoomLimit: (nodePositions: Point[] | Node[], rect: HTMLCanvasElement, maxNodeRadius: number) => number;
+declare const getFlexibleZoomLimit: (nodePositions: Point[], rect: HTMLCanvasElement, maxNodeRadius: number) => number;
 declare const getNewZoomWithinLimits: (newZoom: number, oldZoom: number, minZoom: number, maxZoom: number) => number;
 declare const isZoomOutAtLimit: (newZoom: number, oldZoom: number, zoomOutLimit: number) => boolean;
-declare const getDynamicZoom: (nodePositions: Point[] | Node[], minZoom: number, maxZoom: number, rect: HTMLCanvasElement, newZoom: number, currentZoom: number) => number;
+declare const getDynamicZoom: (nodePositions: Point[] & Node[], minZoom: number, maxZoom: number, rect: HTMLCanvasElement, newZoom: number, currentZoom: number) => number;
 export { getFlexibleZoomLimit, isZoomOutAtLimit, getNewZoomWithinLimits, getExtremeLimits, getMaxDistance, getPositionBoundaries, getZoomLevel, createZoomTarget, getDynamicZoom };

package/dist/types/utils/zoomFunctions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,17 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
+  "homepage": "https://neo4j.com/docs/nvl/current/",
+  "description": "Base library for the Neo4j Visualization Library",
+  "keywords": [
+    "neo4j",
+    "visualization",
+    "graph"
+  ],
+  "bugs": {
+    "url": "https://community.neo4j.com/c/neo4j-graph-platform/neo4j-bloom"
+  },
   "main": "dist/base.mjs",
   "types": "dist/types/index.d.ts",
   "files": [
@@ -9,8 +19,10 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf lib/ dist/ && tsc && webpack",
+    "build": "tsc && webpack",
+    "watch": "concurrently 'tsc -w' 'webpack -w' -k -n 'tsc,webpack' -c 'cyan,magenta'",
     "test": "jest",
+    "eslint": "eslint ./src/ --plugin only-warn",
     "coverage": "yarn test --coverage --silent",
     "prepack": "cp ../../LICENSE.txt ./",
     "postpack": "rm LICENSE.txt"
@@ -22,9 +34,8 @@
     "tsconfig": "./tsconfig.json"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "^0.3.1",
+    "@neo4j-nvl/layout-workers": "^0.3.2",
     "color-string": "^1.9.1",
-    "contrast": "1.0.1",
     "d3-force": "^3.0.0",
     "gl-matrix": "^3.3.0",
     "glsl-inject-defines": "^1.0.3",
@@ -32,14 +43,20 @@
     "loglevel": "^1.8.0",
     "mobx": "^3.2.2",
     "node-pid-controller": "^1.0.1",
-    "resizelistener": "^1.1.0"
+    "resizelistener": "^1.1.0",
+    "tinycolor2": "1.6.0",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
+    "@segment/analytics-next": "^1.70.0",
     "@types/color-string": "^1.5.5",
     "@types/d3-force": "^3.0.3",
     "@types/lodash": "4.14.202",
+    "@types/segment-analytics": "0.0.38",
+    "@types/tinycolor2": "^1.4.6",
     "babel-loader": "^8.2.5",
     "copy-webpack-plugin": "^11.0.0",
+    "eslint": "^8.38.0",
     "jest": "^29.7.0",
     "typedoc": "^0.23.15",
     "typescript": "^5.4.5",
@@ -47,6 +64,7 @@
     "webpack-cli": "^5.0.0"
   },
   "peerDependencies": {
+    "eslint": "*",
     "jest": "*",
     "typescript": "*"
   }