@jsplumb/community - npm Package Compare versions

Comparing version 4.0.0-RC45 to 4.0.0-RC46

package.json

 {
   "name": "@jsplumb/community",
-  "version": "4.0.0-RC45",
+  "version": "4.0.0-RC46",
   "description": "Visual connectivity for webapps. This package contains `community-core` and `browser-ui`, and is equivalent to the way that previous versions of the Community edition were packaged. Note that this package is effectively deprecated, and will not always be available. Try importing `@jsplumb/browser-ui` instead.",
@@ -5,0 +5,0 @@ "main": "js/jsplumb.community.cjs.js",

types/browser-ui/browser-jsplumb-instance.d.ts

@@ -1,2 +0,2 @@
-import { jsPlumbDefaults, jsPlumbHelperFunctions, Dictionary, Offset, PointArray, Size, jsPlumbElement, TypeDescriptor, JsPlumbInstance, AbstractConnector, Endpoint, Overlay, RedrawResult, PaintStyle, OverlayCapableComponent, Segment, LabelOverlay, Connection, Component, DeleteConnectionOptions } from '@jsplumb/community-core';
+import { jsPlumbDefaults, Dictionary, Offset, PointArray, Size, jsPlumbElement, TypeDescriptor, JsPlumbInstance, AbstractConnector, Endpoint, Overlay, RedrawResult, PaintStyle, OverlayCapableComponent, Segment, LabelOverlay, Connection, Component, DeleteConnectionOptions } from '@jsplumb/community-core';
 import { ElementAttributes } from './svg-util';
@@ -116,3 +116,3 @@ import { DragManager } from "./drag-manager";
     private elementDragHandler;
-    constructor(_instanceIndex: number, defaults?: BrowserJsPlumbDefaults, helpers?: jsPlumbHelperFunctions);
+    constructor(_instanceIndex: number, defaults?: BrowserJsPlumbDefaults);
     addDragFilter(filter: Function | string, exclude?: boolean): void;
@@ -137,5 +137,5 @@ removeDragFilter(filter: Function | string): void;
     trigger(el: Element, event: string, originalEvent?: Event, payload?: any): void;
-    _getOffsetRelativeToRoot(el: Element): Offset;
-    _getOffset(el: Element): Offset;
-    _getSize(el: Element): Size;
+    getOffsetRelativeToRoot(el: Element): Offset;
+    getOffset(el: Element): Offset;
+    getSize(el: Element): Size;
     getStyle(el: Element, prop: string): any;
@@ -142,0 +142,0 @@ getSelector(ctx: string | Element, spec: string): NodeListOf<jsPlumbDOMElement>;

types/browser-ui/index.d.ts

 import { BrowserJsPlumbDefaults, BrowserJsPlumbInstance } from "./browser-jsplumb-instance";
-import { jsPlumbHelperFunctions } from "@jsplumb/community-core";
 export * from './browser-jsplumb-instance';
@@ -8,3 +7,3 @@ export * from './collicat';
 export * from "./browser-util";
-export declare function newInstance(defaults?: BrowserJsPlumbDefaults, helpers?: jsPlumbHelperFunctions): BrowserJsPlumbInstance;
+export declare function newInstance(defaults?: BrowserJsPlumbDefaults): BrowserJsPlumbInstance;
 export declare function ready(f: Function): void;

types/core/core.d.ts

@@ -1,2 +0,2 @@
-import { jsPlumbDefaults, jsPlumbHelperFunctions } from "./defaults";
+import { jsPlumbDefaults } from "./defaults";
 import { Connection } from "./connector/connection-impl";
@@ -61,3 +61,3 @@ import { Endpoint } from "./endpoint/endpoint";
     el: jsPlumbElement<E>;
-    viewportElement?: ViewportElement;
+    viewportElement?: ViewportElement<E>;
     endpoints?: Array<Endpoint>;
@@ -93,4 +93,4 @@ connections?: Array<Connection>;
     private _curIdStamp;
-    readonly viewport: Viewport;
-    readonly router: Router;
+    readonly viewport: Viewport<T>;
+    readonly router: Router<T>;
     readonly groupManager: GroupManager<T["E"]>;
@@ -103,9 +103,6 @@ private _connectionTypes;
     get defaultScope(): string;
-    private _helpers;
     geometry: jsPlumbGeometryHelpers;
     private _zoom;
     get currentZoom(): number;
-    constructor(_instanceIndex: number, defaults?: jsPlumbDefaults<T["E"]>, helpers?: jsPlumbHelperFunctions);
-    getSize(el: T["E"]): Size;
-    getOffset(el: T["E"], relativeToRoot?: boolean): Offset;
+    constructor(_instanceIndex: number, defaults?: jsPlumbDefaults<T["E"]>);
     getContainer(): any;
@@ -152,3 +149,3 @@ setZoom(z: number, repaintEverything?: boolean): boolean;
      */
-    updateOffset(params?: UpdateOffsetOptions): ViewportElement;
+    updateOffset(params?: UpdateOffsetOptions): ViewportElement<T["E"]>;
     /**
@@ -286,3 +283,3 @@ * Delete the given connection.
         timestamp?: string;
-        offset?: ViewportElement;
+        offset?: ViewportElement<T["E"]>;
         recalc?: boolean;
@@ -317,5 +314,5 @@ elementWithPrecedence?: string;
     abstract getStyle(el: T["E"], prop: string): any;
-    abstract _getSize(el: T["E"]): Size;
-    abstract _getOffset(el: T["E"]): Offset;
-    abstract _getOffsetRelativeToRoot(el: T["E"] | string): Offset;
+    abstract getSize(el: T["E"]): Size;
+    abstract getOffset(el: T["E"]): Offset;
+    abstract getOffsetRelativeToRoot(el: T["E"] | string): Offset;
     abstract setPosition(el: T["E"], p: Offset): void;
@@ -322,0 +319,0 @@ abstract on(el: T["E"], event: string, callbackOrSelector: Function | string, callback?: Function): void;

types/core/defaults.d.ts

@@ -6,3 +6,2 @@ import { EndpointSpec } from "./endpoint/endpoint";
 import { ConnectorSpec } from "./connector/abstract-connector";
-import { Offset, Size } from "./common";
 export interface ListSpec {
@@ -34,6 +33,1 @@ endpoint?: EndpointSpec;
 }
-export interface jsPlumbHelperFunctions {
-    getSize?: (el: any) => Size;
-    getOffset?: (el: any | string) => Offset;
-    getOffsetRelativeToRoot?: (el: any | string) => Offset;
-}

types/core/router/default-router.d.ts

@@ -11,3 +11,3 @@ import { Router, RedrawResult, AnchorPlacement } from "./router";
     E: unknown;
-}> implements Router {
+}> implements Router<T> {
     instance: JsPlumbInstance;
@@ -30,4 +30,4 @@ continuousAnchorLocations: Dictionary<[number, number, number, number]>;
     private _updateAnchorList;
-    redraw(elementId: string, ui?: ViewportElement, timestamp?: string, offsetToUI?: Offset): RedrawResult;
+    redraw(elementId: string, ui?: ViewportElement<T["E"]>, timestamp?: string, offsetToUI?: Offset): RedrawResult;
     private calculateOrientation;
 }

types/core/router/router.d.ts

@@ -13,5 +13,7 @@ import { Connection } from '../connector/connection-impl';
 export declare type ContinuousAnchorPlacement = [number, number, number, number, Connection, Connection];
-export interface Router {
+export interface Router<T extends {
+    E: unknown;
+}> {
     reset(): void;
-    redraw(elementId: string, ui?: ViewportElement, timestamp?: string, offsetToUI?: Offset): RedrawResult;
+    redraw(elementId: string, ui?: ViewportElement<T["E"]>, timestamp?: string, offsetToUI?: Offset): RedrawResult;
     computePath(connection: Connection, timestamp: string): void;
@@ -18,0 +20,0 @@ computeAnchorLocation(anchor: Anchor, params: AnchorComputeParams): AnchorPlacement;

types/core/viewport.d.ts

@@ -1,3 +0,4 @@
-import { PointArray } from "./common";
+import { Size, PointArray, Offset } from "./common";
 import { EventGenerator } from "./event-generator";
+import { JsPlumbInstance } from "../core";
 export interface ViewportPosition {
@@ -7,3 +8,3 @@ x: number;
 }
-export interface ViewportElementBase extends ViewportPosition {
+export interface ViewportElementBase<E> extends ViewportPosition {
     w: number;
@@ -17,15 +18,19 @@ h: number;
 }
-export interface ViewportElement extends ViewportElementBase {
-    t: TranslatedViewportElement;
+export interface ViewportElement<E> extends ViewportElementBase<E> {
+    t: TranslatedViewportElement<E>;
 }
-export interface TranslatedViewportElementBase extends ViewportElementBase {
+export interface TranslatedViewportElementBase<E> extends ViewportElementBase<E> {
     cr: number;
     sr: number;
 }
-export declare type TranslatedViewportElement = Omit<TranslatedViewportElementBase, "dirty">;
-export declare class Viewport extends EventGenerator {
+export declare type TranslatedViewportElement<E> = Omit<TranslatedViewportElementBase<E>, "dirty">;
+export declare class Viewport<T extends {
+    E: unknown;
+}> extends EventGenerator {
+    instance: JsPlumbInstance<T>;
     private _eventsSuspended;
+    constructor(instance: JsPlumbInstance<T>);
     _sortedElements: Record<string, Array<[string, number]>>;
-    _elementMap: Map<string, ViewportElement>;
-    _transformedElementMap: Map<string, TranslatedViewportElement>;
+    _elementMap: Map<string, ViewportElement<T["E"]>>;
+    _transformedElementMap: Map<string, TranslatedViewportElement<T["E"]>>;
     _bounds: Record<string, number>;
@@ -59,3 +64,6 @@ private _clearElementIndex;
      */
-    updateElement(id: string, x: number, y: number, width: number, height: number, rotation: number): ViewportElement;
+    updateElement(id: string, x: number, y: number, width: number, height: number, rotation: number): ViewportElement<T["E"]>;
+    refreshElement(elId: string): ViewportElement<T["E"]>;
+    protected getSize(el: T["E"]): Size;
+    protected getOffset(el: T["E"]): Offset;
     /**
@@ -65,3 +73,3 @@ * Creates an empty entry for an element with the given ID.
      */
-    registerElement(id: string): ViewportElement;
+    registerElement(id: string): ViewportElement<T["E"]>;
     /**
@@ -76,3 +84,3 @@ * Adds the element with the given id, with the given values for x, y, width, height and rotation. Any of these may be null.
      */
-    addElement(id: string, x: number, y: number, width: number, height: number, rotation: number): ViewportElement;
+    addElement(id: string, x: number, y: number, width: number, height: number, rotation: number): ViewportElement<T["E"]>;
     /**
@@ -83,3 +91,3 @@ * Rotates the element with the given id, recalculating bounds afterwards.
      */
-    rotateElement(id: string, rotation: number): ViewportElement;
+    rotateElement(id: string, rotation: number): ViewportElement<T["E"]>;
     /**
@@ -107,3 +115,3 @@ * Gets the width of the content managed by the viewport, taking any rotated elements into account.
      */
-    setSize(id: string, w: number, h: number): ViewportElement;
+    setSize(id: string, w: number, h: number): ViewportElement<T["E"]>;
     /**
@@ -115,3 +123,3 @@ * Sets the [x,y] position of the element with the given ID, recalculating bounds.
      */
-    setPosition(id: string, x: number, y: number): ViewportElement;
+    setPosition(id: string, x: number, y: number): ViewportElement<T["E"]>;
     /**
@@ -132,7 +140,7 @@ * Clears the internal state of the viewport, removing all elements.
      */
-    getPosition(id: string): ViewportElement;
+    getPosition(id: string): ViewportElement<T["E"]>;
     /**
      * Get all elements managed by the Viewport.
      */
-    getElements(): Map<string, ViewportElement>;
+    getElements(): Map<string, ViewportElement<T["E"]>>;
     /**
@@ -139,0 +147,0 @@ * Returns whether or not the viewport is empty.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

1662407

decreased by-0.08%

Lines of code

46450

decreased by-0.01%

No dependency changes