@inditextech/weave-sdk 0.14.3 → 0.16.0

package/dist/sdk.d.cts

@@ -63,7 +63,6 @@ type WeaveConfig = {
   actions?: WeaveActionBase[];
   plugins?: WeavePluginBase[];
   fonts?: WeaveFont[];
-  callbacks?: WeaveCallbacks;
   logger?: WeaveLoggerConfig;
 };
 type WeaveStatusKeys = keyof typeof WEAVE_INSTANCE_STATUS;
@@ -141,20 +140,6 @@ type WeaveUndoManagerOptions = {
   captureTimeout?: number;
   trackedOrigins?: Set<any>;
 };
-type WeaveUndoRedoChange = {
-  canRedo: boolean;
-  canUndo: boolean;
-  redoStackLength: number;
-  undoStackLength: number;
-};
-type WeaveCallbacks = {
-  onRender?: () => void;
-  onRoomLoaded?: (loaded: boolean) => void;
-  onInstanceStatus?: (status: WeaveStatus) => void;
-  onActiveActionChange?: (actionName: string | undefined) => void;
-  onStateChange?: (state: WeaveState) => void;
-  onUndoManagerStatusChange?: (undoManagerStatus: WeaveUndoRedoChange) => void;
-};
 declare type docElementTypeDescription = "xml" | "text" | Array<any> | object;
 declare type DocTypeDescription = {
   [key: string]: docElementTypeDescription;
@@ -393,6 +378,7 @@ declare class Weave extends Emittery {
   getStatus(): WeaveStatus;
   setStore(store: WeaveStore): void;
   start(): Promise<void>;
+  destroy(): void;
   getId(): string;
   getConfiguration(): WeaveConfig;
   emitEvent<T>(event: string, payload?: T): void;
@@ -450,7 +436,7 @@ declare class Weave extends Emittery {
   bringToFront(node: WeaveElementInstance): void;
   group(nodes: WeaveStateElement[]): void;
   unGroup(group: WeaveStateElement): void;
-  pointIntersectsContainerElement(point?: Vector2d): Konva.Node | undefined;
+  pointIntersectsContainerElement(actualLayer?: Konva.Layer | Konva.Group, point?: Vector2d): Konva.Node | undefined;
   getMousePointer(point?: Vector2d): WeaveMousePointInfo;
   getMousePointerRelativeToContainer(container: Konva.Group | Konva.Layer): WeaveMousePointInfoSimple;
   selectNodesByKey(nodesIds: string[]): void;
@@ -1292,14 +1278,90 @@ declare class WeaveConnectedUsersPlugin extends WeavePlugin {
   disable(): void;
 }
 
+//#endregion
+//#region src/plugins/users-selection/constants.d.ts
+declare const WEAVE_USERS_SELECTION_KEY = "usersSelection";
+declare const WEAVE_USERS_SELECTION_LAYER_ID = "usersPointersLayer";
+declare const WEAVE_USER_SELECTION_KEY = "userSelection";
+
+//#endregion
+//#region src/plugins/users-selection/types.d.ts
+type WeaveUsersSelectionPluginConfig = {
+  getUser: () => WeaveUser;
+};
+type WeaveUsersSelectionPluginParams = {
+  config: WeaveUsersSelectionPluginConfig;
+};
+type WeaveUserSelectionInfo = {
+  user: string;
+  nodes: string[];
+};
+type WeaveUserSelectionKey = typeof WEAVE_USER_SELECTION_KEY;
+
+//#endregion
+//#region src/plugins/users-selection/users-selection.d.ts
+declare class WeaveUsersSelectionPlugin extends WeavePlugin {
+  private usersSelection;
+  private config;
+  constructor(params: WeaveUsersSelectionPluginParams);
+  getName(): string;
+  getLayerName(): string;
+  initLayer(): void;
+  onRender(): void;
+  getLayer(): Konva.Layer | undefined;
+  onInit(): void;
+  sendSelectionAwarenessInfo(tr: Konva.Transformer): void;
+  removeSelectionAwarenessInfo(): void;
+  private stringToColor;
+  private getSelectedNodesRect;
+  private renderSelectors;
+  enable(): void;
+  disable(): void;
+}
+
 //#endregion
 //#region src/plugins/users-pointers/constants.d.ts
+declare const WEAVE_USERS_POINTERS_KEY = "usersPointers";
+declare const WEAVE_USERS_POINTERS_LAYER_ID = "usersPointersLayer";
 declare const WEAVE_USER_POINTER_KEY = "userPointer";
+declare const WEAVE_DEFAULT_USER_INFO_FUNCTION: () => {
+  name: string;
+  email: string;
+};
+declare const WEAVE_USER_POINTERS_DEFAULT_PROPS: {
+  separation: number;
+  pointer: {
+    circleRadius: number;
+    circleStrokeWidth: number;
+  };
+  name: {
+    fontFamily: string;
+    fontSize: number;
+    backgroundCornerRadius: number;
+    backgroundPaddingX: number;
+    backgroundPaddingY: number;
+  };
+};
 
 //#endregion
 //#region src/plugins/users-pointers/types.d.ts
+type WeaveUserPointersUIProperties = {
+  separation: number;
+  pointer: {
+    circleRadius: number;
+    circleStrokeWidth: number;
+  };
+  name: {
+    fontFamily: string;
+    fontSize: number;
+    backgroundCornerRadius: number;
+    backgroundPaddingX: number;
+    backgroundPaddingY: number;
+  };
+};
 type WeaveUsersPointersPluginConfig = {
   getUser: () => WeaveUser;
+  ui?: WeaveUserPointersUIProperties;
 };
 type WeaveUsersPointersPluginParams = {
   config: WeaveUsersPointersPluginConfig;
@@ -1316,13 +1378,7 @@ type WeaveUserPointerKey = typeof WEAVE_USER_POINTER_KEY;
 declare class WeaveUsersPointersPlugin extends WeavePlugin {
   private usersPointers;
   private config;
-  private userPointerCircleRadius;
-  private userPointerSeparation;
-  private userPointerCircleStrokeWidth;
-  private userPointerNameFontSize;
-  private userPointerBackgroundCornerRadius;
-  private userPointerBackgroundPaddingX;
-  private userPointerBackgroundPaddingY;
+  private uiConfig;
   constructor(params: WeaveUsersPointersPluginParams);
   getName(): string;
   getLayerName(): string;
@@ -1330,7 +1386,8 @@ declare class WeaveUsersPointersPlugin extends WeavePlugin {
   onRender(): void;
   getLayer(): Konva.Layer | undefined;
   onInit(): void;
-  private stringToColour;
+  private getContrastTextColor;
+  private stringToColor;
   private renderPointers;
   enable(): void;
   disable(): void;
@@ -1528,4 +1585,4 @@ declare class WeaveNodesSnappingPlugin extends WeavePlugin {
 }
 
 //#endregion
-export { BRUSH_TOOL_ACTION_NAME, BRUSH_TOOL_STATE, COPY_PASTE_NODES_PLUGIN_STATE, FRAME_TOOL_ACTION_NAME, FRAME_TOOL_STATE, GUIDE_LINE_DEFAULT_CONFIG, GUIDE_LINE_DRAG_SNAPPING_THRESHOLD, GUIDE_LINE_NAME, GUIDE_LINE_TRANSFORM_SNAPPING_THRESHOLD, GUIDE_ORIENTATION, Guide, GuideOrientation, GuideOrientationKeys, IMAGE_TOOL_ACTION_NAME, IMAGE_TOOL_STATE, ImageProps, LineGuide, LineGuideStop, MOVE_TOOL_ACTION_NAME, MOVE_TOOL_STATE, NODE_SNAP, NodeSnap, NodeSnapKeys, NodeSnappingEdge, NodeSnappingEdges, PEN_TOOL_ACTION_NAME, PEN_TOOL_STATE, RECTANGLE_TOOL_ACTION_NAME, RECTANGLE_TOOL_STATE, SELECTION_TOOL_ACTION_NAME, SELECTION_TOOL_STATE, TEXT_TOOL_ACTION_NAME, TEXT_TOOL_STATE, TextSerializable, WEAVE_COPY_PASTE_NODES_KEY, WEAVE_FRAME_NODE_DEFAULT_CONFIG, WEAVE_FRAME_NODE_DEFAULT_PROPS, WEAVE_FRAME_NODE_SIZES, WEAVE_FRAME_NODE_SIZES_MULTIPLIER, WEAVE_FRAME_NODE_SIZES_ORIENTATION, WEAVE_FRAME_NODE_SIZES_TYPES, WEAVE_FRAME_NODE_TYPE, WEAVE_GRID_DEFAULT_COLOR, WEAVE_GRID_DEFAULT_ORIGIN_COLOR, WEAVE_GRID_DEFAULT_SIZE, WEAVE_GRID_DEFAULT_TYPE, WEAVE_GRID_LAYER_ID, WEAVE_GRID_TYPES, WEAVE_NODES_SELECTION_KEY, WEAVE_NODES_SELECTION_LAYER_ID, WEAVE_NODES_SNAPPING_KEY, WEAVE_STAGE_GRID_KEY, Weave, WeaveAction, WeaveActionPropsChangeEvent, WeaveBrushToolAction, WeaveBrushToolActionState, WeaveBrushToolActionStateKeys, WeaveConnectedUserInfoKey, WeaveConnectedUsers, WeaveConnectedUsersChangeEvent, WeaveConnectedUsersPlugin, WeaveConnectedUsersPluginConfig, WeaveConnectedUsersPluginParams, WeaveContextMenuPlugin, WeaveCopyPasteNodesPlugin, WeaveCopyPasteNodesPluginOnCopyEvent, WeaveCopyPasteNodesPluginOnPasteEvent, WeaveCopyPasteNodesPluginOnPasteExternalEvent, WeaveCopyPasteNodesPluginState, WeaveCopyPasteNodesPluginStateKeys, WeaveExportNodeActionParams, WeaveExportNodeToolAction, WeaveExportStageActionParams, WeaveExportStageToolAction, WeaveFitToScreenToolAction, WeaveFitToScreenToolActionParams, WeaveFitToSelectionToolAction, WeaveFitToSelectionToolActionParams, WeaveFrameAttributes, WeaveFrameNode, WeaveFrameNodeParams, WeaveFrameNodeSizes, WeaveFrameNodeSizesInfo, WeaveFrameNodeSizesKeys, WeaveFrameNodeSizesOrientation, WeaveFrameNodeSizesOrientationKeys, WeaveFrameProperties, WeaveFrameToolAction, WeaveFrameToolActionState, WeaveFrameToolActionStateKeys, WeaveFrameToolActionTriggerParams, WeaveFrameToolProps, WeaveGroupNode, WeaveImageNode, WeaveImageToolAction, WeaveImageToolActionOnEndLoadImageEvent, WeaveImageToolActionOnStartLoadImageEvent, WeaveImageToolActionState, WeaveImageToolActionStateKeys, WeaveImageToolActionTriggerParams, WeaveImageToolActionTriggerReturn, WeaveLayerNode, WeaveLineNode, WeaveMoveToolAction, WeaveMoveToolActionState, WeaveMoveToolActionStateKeys, WeaveNode, WeaveNodesSelectionPlugin, WeaveNodesSelectionPluginConfig, WeaveNodesSelectionPluginOnNodesChangeEvent, WeaveNodesSelectionPluginOnSelectionStateEvent, WeaveNodesSelectionPluginOnStageSelectionEvent, WeaveNodesSelectionPluginParams, WeaveNodesSnappingPlugin, WeaveNodesSnappingPluginConfig, WeaveNodesSnappingPluginParams, WeavePasteModel, WeavePenToolAction, WeavePenToolActionState, WeavePenToolActionStateKeys, WeavePlugin, WeaveRectangleNode, WeaveRectangleToolAction, WeaveRectangleToolActionState, WeaveRectangleToolActionStateKeys, WeaveSelectionToolAction, WeaveSelectionToolActionState, WeaveSelectionToolActionStateKeys, WeaveStageContextMenuPluginConfig, WeaveStageContextMenuPluginOnNodeContextMenuEvent, WeaveStageContextMenuPluginParams, WeaveStageDropAreaPlugin, WeaveStageDropPluginOnStageDropEvent, WeaveStageGridPlugin, WeaveStageGridPluginConfig, WeaveStageGridPluginParams, WeaveStageGridType, WeaveStageGridTypeKeys, WeaveStageNode, WeaveStagePanningPlugin, WeaveStageResizePlugin, WeaveStageZoomChanged, WeaveStageZoomPlugin, WeaveStageZoomPluginConfig, WeaveStageZoomPluginOnZoomChangeEvent, WeaveStageZoomPluginParams, WeaveStore, WeaveTextNode, WeaveTextToolAction, WeaveTextToolActionState, WeaveTextToolActionStateKeys, WeaveToPasteNode, WeaveUserPointer, WeaveUserPointerKey, WeaveUsersPointersPlugin, WeaveUsersPointersPluginConfig, WeaveUsersPointersPluginParams, WeaveZoomInToolAction, WeaveZoomInToolActionParams, WeaveZoomOutToolAction, WeaveZoomOutToolActionParams, checkIfOverContainer, clearContainerTargets, moveNodeToContainer, resetScale };
+export { BRUSH_TOOL_ACTION_NAME, BRUSH_TOOL_STATE, COPY_PASTE_NODES_PLUGIN_STATE, FRAME_TOOL_ACTION_NAME, FRAME_TOOL_STATE, GUIDE_LINE_DEFAULT_CONFIG, GUIDE_LINE_DRAG_SNAPPING_THRESHOLD, GUIDE_LINE_NAME, GUIDE_LINE_TRANSFORM_SNAPPING_THRESHOLD, GUIDE_ORIENTATION, Guide, GuideOrientation, GuideOrientationKeys, IMAGE_TOOL_ACTION_NAME, IMAGE_TOOL_STATE, ImageProps, LineGuide, LineGuideStop, MOVE_TOOL_ACTION_NAME, MOVE_TOOL_STATE, NODE_SNAP, NodeSnap, NodeSnapKeys, NodeSnappingEdge, NodeSnappingEdges, PEN_TOOL_ACTION_NAME, PEN_TOOL_STATE, RECTANGLE_TOOL_ACTION_NAME, RECTANGLE_TOOL_STATE, SELECTION_TOOL_ACTION_NAME, SELECTION_TOOL_STATE, TEXT_TOOL_ACTION_NAME, TEXT_TOOL_STATE, TextSerializable, WEAVE_COPY_PASTE_NODES_KEY, WEAVE_DEFAULT_USER_INFO_FUNCTION, WEAVE_FRAME_NODE_DEFAULT_CONFIG, WEAVE_FRAME_NODE_DEFAULT_PROPS, WEAVE_FRAME_NODE_SIZES, WEAVE_FRAME_NODE_SIZES_MULTIPLIER, WEAVE_FRAME_NODE_SIZES_ORIENTATION, WEAVE_FRAME_NODE_SIZES_TYPES, WEAVE_FRAME_NODE_TYPE, WEAVE_GRID_DEFAULT_COLOR, WEAVE_GRID_DEFAULT_ORIGIN_COLOR, WEAVE_GRID_DEFAULT_SIZE, WEAVE_GRID_DEFAULT_TYPE, WEAVE_GRID_LAYER_ID, WEAVE_GRID_TYPES, WEAVE_NODES_SELECTION_KEY, WEAVE_NODES_SELECTION_LAYER_ID, WEAVE_NODES_SNAPPING_KEY, WEAVE_STAGE_GRID_KEY, WEAVE_USERS_POINTERS_KEY, WEAVE_USERS_POINTERS_LAYER_ID, WEAVE_USERS_SELECTION_KEY, WEAVE_USERS_SELECTION_LAYER_ID, WEAVE_USER_POINTERS_DEFAULT_PROPS, WEAVE_USER_POINTER_KEY, WEAVE_USER_SELECTION_KEY, Weave, WeaveAction, WeaveActionPropsChangeEvent, WeaveBrushToolAction, WeaveBrushToolActionState, WeaveBrushToolActionStateKeys, WeaveConnectedUserInfoKey, WeaveConnectedUsers, WeaveConnectedUsersChangeEvent, WeaveConnectedUsersPlugin, WeaveConnectedUsersPluginConfig, WeaveConnectedUsersPluginParams, WeaveContextMenuPlugin, WeaveCopyPasteNodesPlugin, WeaveCopyPasteNodesPluginOnCopyEvent, WeaveCopyPasteNodesPluginOnPasteEvent, WeaveCopyPasteNodesPluginOnPasteExternalEvent, WeaveCopyPasteNodesPluginState, WeaveCopyPasteNodesPluginStateKeys, WeaveExportNodeActionParams, WeaveExportNodeToolAction, WeaveExportStageActionParams, WeaveExportStageToolAction, WeaveFitToScreenToolAction, WeaveFitToScreenToolActionParams, WeaveFitToSelectionToolAction, WeaveFitToSelectionToolActionParams, WeaveFrameAttributes, WeaveFrameNode, WeaveFrameNodeParams, WeaveFrameNodeSizes, WeaveFrameNodeSizesInfo, WeaveFrameNodeSizesKeys, WeaveFrameNodeSizesOrientation, WeaveFrameNodeSizesOrientationKeys, WeaveFrameProperties, WeaveFrameToolAction, WeaveFrameToolActionState, WeaveFrameToolActionStateKeys, WeaveFrameToolActionTriggerParams, WeaveFrameToolProps, WeaveGroupNode, WeaveImageNode, WeaveImageToolAction, WeaveImageToolActionOnEndLoadImageEvent, WeaveImageToolActionOnStartLoadImageEvent, WeaveImageToolActionState, WeaveImageToolActionStateKeys, WeaveImageToolActionTriggerParams, WeaveImageToolActionTriggerReturn, WeaveLayerNode, WeaveLineNode, WeaveMoveToolAction, WeaveMoveToolActionState, WeaveMoveToolActionStateKeys, WeaveNode, WeaveNodesSelectionPlugin, WeaveNodesSelectionPluginConfig, WeaveNodesSelectionPluginOnNodesChangeEvent, WeaveNodesSelectionPluginOnSelectionStateEvent, WeaveNodesSelectionPluginOnStageSelectionEvent, WeaveNodesSelectionPluginParams, WeaveNodesSnappingPlugin, WeaveNodesSnappingPluginConfig, WeaveNodesSnappingPluginParams, WeavePasteModel, WeavePenToolAction, WeavePenToolActionState, WeavePenToolActionStateKeys, WeavePlugin, WeaveRectangleNode, WeaveRectangleToolAction, WeaveRectangleToolActionState, WeaveRectangleToolActionStateKeys, WeaveSelectionToolAction, WeaveSelectionToolActionState, WeaveSelectionToolActionStateKeys, WeaveStageContextMenuPluginConfig, WeaveStageContextMenuPluginOnNodeContextMenuEvent, WeaveStageContextMenuPluginParams, WeaveStageDropAreaPlugin, WeaveStageDropPluginOnStageDropEvent, WeaveStageGridPlugin, WeaveStageGridPluginConfig, WeaveStageGridPluginParams, WeaveStageGridType, WeaveStageGridTypeKeys, WeaveStageNode, WeaveStagePanningPlugin, WeaveStageResizePlugin, WeaveStageZoomChanged, WeaveStageZoomPlugin, WeaveStageZoomPluginConfig, WeaveStageZoomPluginOnZoomChangeEvent, WeaveStageZoomPluginParams, WeaveStore, WeaveTextNode, WeaveTextToolAction, WeaveTextToolActionState, WeaveTextToolActionStateKeys, WeaveToPasteNode, WeaveUserPointer, WeaveUserPointerKey, WeaveUserPointersUIProperties, WeaveUserSelectionInfo, WeaveUserSelectionKey, WeaveUsersPointersPlugin, WeaveUsersPointersPluginConfig, WeaveUsersPointersPluginParams, WeaveUsersSelectionPlugin, WeaveUsersSelectionPluginConfig, WeaveUsersSelectionPluginParams, WeaveZoomInToolAction, WeaveZoomInToolActionParams, WeaveZoomOutToolAction, WeaveZoomOutToolActionParams, checkIfOverContainer, clearContainerTargets, moveNodeToContainer, resetScale };

package/dist/sdk.d.ts

@@ -63,7 +63,6 @@ type WeaveConfig = {
   actions?: WeaveActionBase[];
   plugins?: WeavePluginBase[];
   fonts?: WeaveFont[];
-  callbacks?: WeaveCallbacks;
   logger?: WeaveLoggerConfig;
 };
 type WeaveStatusKeys = keyof typeof WEAVE_INSTANCE_STATUS;
@@ -141,20 +140,6 @@ type WeaveUndoManagerOptions = {
   captureTimeout?: number;
   trackedOrigins?: Set<any>;
 };
-type WeaveUndoRedoChange = {
-  canRedo: boolean;
-  canUndo: boolean;
-  redoStackLength: number;
-  undoStackLength: number;
-};
-type WeaveCallbacks = {
-  onRender?: () => void;
-  onRoomLoaded?: (loaded: boolean) => void;
-  onInstanceStatus?: (status: WeaveStatus) => void;
-  onActiveActionChange?: (actionName: string | undefined) => void;
-  onStateChange?: (state: WeaveState) => void;
-  onUndoManagerStatusChange?: (undoManagerStatus: WeaveUndoRedoChange) => void;
-};
 declare type docElementTypeDescription = "xml" | "text" | Array<any> | object;
 declare type DocTypeDescription = {
   [key: string]: docElementTypeDescription;
@@ -393,6 +378,7 @@ declare class Weave extends Emittery {
   getStatus(): WeaveStatus;
   setStore(store: WeaveStore): void;
   start(): Promise<void>;
+  destroy(): void;
   getId(): string;
   getConfiguration(): WeaveConfig;
   emitEvent<T>(event: string, payload?: T): void;
@@ -450,7 +436,7 @@ declare class Weave extends Emittery {
   bringToFront(node: WeaveElementInstance): void;
   group(nodes: WeaveStateElement[]): void;
   unGroup(group: WeaveStateElement): void;
-  pointIntersectsContainerElement(point?: Vector2d): Konva.Node | undefined;
+  pointIntersectsContainerElement(actualLayer?: Konva.Layer | Konva.Group, point?: Vector2d): Konva.Node | undefined;
   getMousePointer(point?: Vector2d): WeaveMousePointInfo;
   getMousePointerRelativeToContainer(container: Konva.Group | Konva.Layer): WeaveMousePointInfoSimple;
   selectNodesByKey(nodesIds: string[]): void;
@@ -1292,14 +1278,90 @@ declare class WeaveConnectedUsersPlugin extends WeavePlugin {
   disable(): void;
 }
 
+//#endregion
+//#region src/plugins/users-selection/constants.d.ts
+declare const WEAVE_USERS_SELECTION_KEY = "usersSelection";
+declare const WEAVE_USERS_SELECTION_LAYER_ID = "usersPointersLayer";
+declare const WEAVE_USER_SELECTION_KEY = "userSelection";
+
+//#endregion
+//#region src/plugins/users-selection/types.d.ts
+type WeaveUsersSelectionPluginConfig = {
+  getUser: () => WeaveUser;
+};
+type WeaveUsersSelectionPluginParams = {
+  config: WeaveUsersSelectionPluginConfig;
+};
+type WeaveUserSelectionInfo = {
+  user: string;
+  nodes: string[];
+};
+type WeaveUserSelectionKey = typeof WEAVE_USER_SELECTION_KEY;
+
+//#endregion
+//#region src/plugins/users-selection/users-selection.d.ts
+declare class WeaveUsersSelectionPlugin extends WeavePlugin {
+  private usersSelection;
+  private config;
+  constructor(params: WeaveUsersSelectionPluginParams);
+  getName(): string;
+  getLayerName(): string;
+  initLayer(): void;
+  onRender(): void;
+  getLayer(): Konva.Layer | undefined;
+  onInit(): void;
+  sendSelectionAwarenessInfo(tr: Konva.Transformer): void;
+  removeSelectionAwarenessInfo(): void;
+  private stringToColor;
+  private getSelectedNodesRect;
+  private renderSelectors;
+  enable(): void;
+  disable(): void;
+}
+
 //#endregion
 //#region src/plugins/users-pointers/constants.d.ts
+declare const WEAVE_USERS_POINTERS_KEY = "usersPointers";
+declare const WEAVE_USERS_POINTERS_LAYER_ID = "usersPointersLayer";
 declare const WEAVE_USER_POINTER_KEY = "userPointer";
+declare const WEAVE_DEFAULT_USER_INFO_FUNCTION: () => {
+  name: string;
+  email: string;
+};
+declare const WEAVE_USER_POINTERS_DEFAULT_PROPS: {
+  separation: number;
+  pointer: {
+    circleRadius: number;
+    circleStrokeWidth: number;
+  };
+  name: {
+    fontFamily: string;
+    fontSize: number;
+    backgroundCornerRadius: number;
+    backgroundPaddingX: number;
+    backgroundPaddingY: number;
+  };
+};
 
 //#endregion
 //#region src/plugins/users-pointers/types.d.ts
+type WeaveUserPointersUIProperties = {
+  separation: number;
+  pointer: {
+    circleRadius: number;
+    circleStrokeWidth: number;
+  };
+  name: {
+    fontFamily: string;
+    fontSize: number;
+    backgroundCornerRadius: number;
+    backgroundPaddingX: number;
+    backgroundPaddingY: number;
+  };
+};
 type WeaveUsersPointersPluginConfig = {
   getUser: () => WeaveUser;
+  ui?: WeaveUserPointersUIProperties;
 };
 type WeaveUsersPointersPluginParams = {
   config: WeaveUsersPointersPluginConfig;
@@ -1316,13 +1378,7 @@ type WeaveUserPointerKey = typeof WEAVE_USER_POINTER_KEY;
 declare class WeaveUsersPointersPlugin extends WeavePlugin {
   private usersPointers;
   private config;
-  private userPointerCircleRadius;
-  private userPointerSeparation;
-  private userPointerCircleStrokeWidth;
-  private userPointerNameFontSize;
-  private userPointerBackgroundCornerRadius;
-  private userPointerBackgroundPaddingX;
-  private userPointerBackgroundPaddingY;
+  private uiConfig;
   constructor(params: WeaveUsersPointersPluginParams);
   getName(): string;
   getLayerName(): string;
@@ -1330,7 +1386,8 @@ declare class WeaveUsersPointersPlugin extends WeavePlugin {
   onRender(): void;
   getLayer(): Konva.Layer | undefined;
   onInit(): void;
-  private stringToColour;
+  private getContrastTextColor;
+  private stringToColor;
   private renderPointers;
   enable(): void;
   disable(): void;
@@ -1528,4 +1585,4 @@ declare class WeaveNodesSnappingPlugin extends WeavePlugin {
 }
 
 //#endregion
-export { BRUSH_TOOL_ACTION_NAME, BRUSH_TOOL_STATE, COPY_PASTE_NODES_PLUGIN_STATE, FRAME_TOOL_ACTION_NAME, FRAME_TOOL_STATE, GUIDE_LINE_DEFAULT_CONFIG, GUIDE_LINE_DRAG_SNAPPING_THRESHOLD, GUIDE_LINE_NAME, GUIDE_LINE_TRANSFORM_SNAPPING_THRESHOLD, GUIDE_ORIENTATION, Guide, GuideOrientation, GuideOrientationKeys, IMAGE_TOOL_ACTION_NAME, IMAGE_TOOL_STATE, ImageProps, LineGuide, LineGuideStop, MOVE_TOOL_ACTION_NAME, MOVE_TOOL_STATE, NODE_SNAP, NodeSnap, NodeSnapKeys, NodeSnappingEdge, NodeSnappingEdges, PEN_TOOL_ACTION_NAME, PEN_TOOL_STATE, RECTANGLE_TOOL_ACTION_NAME, RECTANGLE_TOOL_STATE, SELECTION_TOOL_ACTION_NAME, SELECTION_TOOL_STATE, TEXT_TOOL_ACTION_NAME, TEXT_TOOL_STATE, TextSerializable, WEAVE_COPY_PASTE_NODES_KEY, WEAVE_FRAME_NODE_DEFAULT_CONFIG, WEAVE_FRAME_NODE_DEFAULT_PROPS, WEAVE_FRAME_NODE_SIZES, WEAVE_FRAME_NODE_SIZES_MULTIPLIER, WEAVE_FRAME_NODE_SIZES_ORIENTATION, WEAVE_FRAME_NODE_SIZES_TYPES, WEAVE_FRAME_NODE_TYPE, WEAVE_GRID_DEFAULT_COLOR, WEAVE_GRID_DEFAULT_ORIGIN_COLOR, WEAVE_GRID_DEFAULT_SIZE, WEAVE_GRID_DEFAULT_TYPE, WEAVE_GRID_LAYER_ID, WEAVE_GRID_TYPES, WEAVE_NODES_SELECTION_KEY, WEAVE_NODES_SELECTION_LAYER_ID, WEAVE_NODES_SNAPPING_KEY, WEAVE_STAGE_GRID_KEY, Weave, WeaveAction, WeaveActionPropsChangeEvent, WeaveBrushToolAction, WeaveBrushToolActionState, WeaveBrushToolActionStateKeys, WeaveConnectedUserInfoKey, WeaveConnectedUsers, WeaveConnectedUsersChangeEvent, WeaveConnectedUsersPlugin, WeaveConnectedUsersPluginConfig, WeaveConnectedUsersPluginParams, WeaveContextMenuPlugin, WeaveCopyPasteNodesPlugin, WeaveCopyPasteNodesPluginOnCopyEvent, WeaveCopyPasteNodesPluginOnPasteEvent, WeaveCopyPasteNodesPluginOnPasteExternalEvent, WeaveCopyPasteNodesPluginState, WeaveCopyPasteNodesPluginStateKeys, WeaveExportNodeActionParams, WeaveExportNodeToolAction, WeaveExportStageActionParams, WeaveExportStageToolAction, WeaveFitToScreenToolAction, WeaveFitToScreenToolActionParams, WeaveFitToSelectionToolAction, WeaveFitToSelectionToolActionParams, WeaveFrameAttributes, WeaveFrameNode, WeaveFrameNodeParams, WeaveFrameNodeSizes, WeaveFrameNodeSizesInfo, WeaveFrameNodeSizesKeys, WeaveFrameNodeSizesOrientation, WeaveFrameNodeSizesOrientationKeys, WeaveFrameProperties, WeaveFrameToolAction, WeaveFrameToolActionState, WeaveFrameToolActionStateKeys, WeaveFrameToolActionTriggerParams, WeaveFrameToolProps, WeaveGroupNode, WeaveImageNode, WeaveImageToolAction, WeaveImageToolActionOnEndLoadImageEvent, WeaveImageToolActionOnStartLoadImageEvent, WeaveImageToolActionState, WeaveImageToolActionStateKeys, WeaveImageToolActionTriggerParams, WeaveImageToolActionTriggerReturn, WeaveLayerNode, WeaveLineNode, WeaveMoveToolAction, WeaveMoveToolActionState, WeaveMoveToolActionStateKeys, WeaveNode, WeaveNodesSelectionPlugin, WeaveNodesSelectionPluginConfig, WeaveNodesSelectionPluginOnNodesChangeEvent, WeaveNodesSelectionPluginOnSelectionStateEvent, WeaveNodesSelectionPluginOnStageSelectionEvent, WeaveNodesSelectionPluginParams, WeaveNodesSnappingPlugin, WeaveNodesSnappingPluginConfig, WeaveNodesSnappingPluginParams, WeavePasteModel, WeavePenToolAction, WeavePenToolActionState, WeavePenToolActionStateKeys, WeavePlugin, WeaveRectangleNode, WeaveRectangleToolAction, WeaveRectangleToolActionState, WeaveRectangleToolActionStateKeys, WeaveSelectionToolAction, WeaveSelectionToolActionState, WeaveSelectionToolActionStateKeys, WeaveStageContextMenuPluginConfig, WeaveStageContextMenuPluginOnNodeContextMenuEvent, WeaveStageContextMenuPluginParams, WeaveStageDropAreaPlugin, WeaveStageDropPluginOnStageDropEvent, WeaveStageGridPlugin, WeaveStageGridPluginConfig, WeaveStageGridPluginParams, WeaveStageGridType, WeaveStageGridTypeKeys, WeaveStageNode, WeaveStagePanningPlugin, WeaveStageResizePlugin, WeaveStageZoomChanged, WeaveStageZoomPlugin, WeaveStageZoomPluginConfig, WeaveStageZoomPluginOnZoomChangeEvent, WeaveStageZoomPluginParams, WeaveStore, WeaveTextNode, WeaveTextToolAction, WeaveTextToolActionState, WeaveTextToolActionStateKeys, WeaveToPasteNode, WeaveUserPointer, WeaveUserPointerKey, WeaveUsersPointersPlugin, WeaveUsersPointersPluginConfig, WeaveUsersPointersPluginParams, WeaveZoomInToolAction, WeaveZoomInToolActionParams, WeaveZoomOutToolAction, WeaveZoomOutToolActionParams, checkIfOverContainer, clearContainerTargets, moveNodeToContainer, resetScale };
+export { BRUSH_TOOL_ACTION_NAME, BRUSH_TOOL_STATE, COPY_PASTE_NODES_PLUGIN_STATE, FRAME_TOOL_ACTION_NAME, FRAME_TOOL_STATE, GUIDE_LINE_DEFAULT_CONFIG, GUIDE_LINE_DRAG_SNAPPING_THRESHOLD, GUIDE_LINE_NAME, GUIDE_LINE_TRANSFORM_SNAPPING_THRESHOLD, GUIDE_ORIENTATION, Guide, GuideOrientation, GuideOrientationKeys, IMAGE_TOOL_ACTION_NAME, IMAGE_TOOL_STATE, ImageProps, LineGuide, LineGuideStop, MOVE_TOOL_ACTION_NAME, MOVE_TOOL_STATE, NODE_SNAP, NodeSnap, NodeSnapKeys, NodeSnappingEdge, NodeSnappingEdges, PEN_TOOL_ACTION_NAME, PEN_TOOL_STATE, RECTANGLE_TOOL_ACTION_NAME, RECTANGLE_TOOL_STATE, SELECTION_TOOL_ACTION_NAME, SELECTION_TOOL_STATE, TEXT_TOOL_ACTION_NAME, TEXT_TOOL_STATE, TextSerializable, WEAVE_COPY_PASTE_NODES_KEY, WEAVE_DEFAULT_USER_INFO_FUNCTION, WEAVE_FRAME_NODE_DEFAULT_CONFIG, WEAVE_FRAME_NODE_DEFAULT_PROPS, WEAVE_FRAME_NODE_SIZES, WEAVE_FRAME_NODE_SIZES_MULTIPLIER, WEAVE_FRAME_NODE_SIZES_ORIENTATION, WEAVE_FRAME_NODE_SIZES_TYPES, WEAVE_FRAME_NODE_TYPE, WEAVE_GRID_DEFAULT_COLOR, WEAVE_GRID_DEFAULT_ORIGIN_COLOR, WEAVE_GRID_DEFAULT_SIZE, WEAVE_GRID_DEFAULT_TYPE, WEAVE_GRID_LAYER_ID, WEAVE_GRID_TYPES, WEAVE_NODES_SELECTION_KEY, WEAVE_NODES_SELECTION_LAYER_ID, WEAVE_NODES_SNAPPING_KEY, WEAVE_STAGE_GRID_KEY, WEAVE_USERS_POINTERS_KEY, WEAVE_USERS_POINTERS_LAYER_ID, WEAVE_USERS_SELECTION_KEY, WEAVE_USERS_SELECTION_LAYER_ID, WEAVE_USER_POINTERS_DEFAULT_PROPS, WEAVE_USER_POINTER_KEY, WEAVE_USER_SELECTION_KEY, Weave, WeaveAction, WeaveActionPropsChangeEvent, WeaveBrushToolAction, WeaveBrushToolActionState, WeaveBrushToolActionStateKeys, WeaveConnectedUserInfoKey, WeaveConnectedUsers, WeaveConnectedUsersChangeEvent, WeaveConnectedUsersPlugin, WeaveConnectedUsersPluginConfig, WeaveConnectedUsersPluginParams, WeaveContextMenuPlugin, WeaveCopyPasteNodesPlugin, WeaveCopyPasteNodesPluginOnCopyEvent, WeaveCopyPasteNodesPluginOnPasteEvent, WeaveCopyPasteNodesPluginOnPasteExternalEvent, WeaveCopyPasteNodesPluginState, WeaveCopyPasteNodesPluginStateKeys, WeaveExportNodeActionParams, WeaveExportNodeToolAction, WeaveExportStageActionParams, WeaveExportStageToolAction, WeaveFitToScreenToolAction, WeaveFitToScreenToolActionParams, WeaveFitToSelectionToolAction, WeaveFitToSelectionToolActionParams, WeaveFrameAttributes, WeaveFrameNode, WeaveFrameNodeParams, WeaveFrameNodeSizes, WeaveFrameNodeSizesInfo, WeaveFrameNodeSizesKeys, WeaveFrameNodeSizesOrientation, WeaveFrameNodeSizesOrientationKeys, WeaveFrameProperties, WeaveFrameToolAction, WeaveFrameToolActionState, WeaveFrameToolActionStateKeys, WeaveFrameToolActionTriggerParams, WeaveFrameToolProps, WeaveGroupNode, WeaveImageNode, WeaveImageToolAction, WeaveImageToolActionOnEndLoadImageEvent, WeaveImageToolActionOnStartLoadImageEvent, WeaveImageToolActionState, WeaveImageToolActionStateKeys, WeaveImageToolActionTriggerParams, WeaveImageToolActionTriggerReturn, WeaveLayerNode, WeaveLineNode, WeaveMoveToolAction, WeaveMoveToolActionState, WeaveMoveToolActionStateKeys, WeaveNode, WeaveNodesSelectionPlugin, WeaveNodesSelectionPluginConfig, WeaveNodesSelectionPluginOnNodesChangeEvent, WeaveNodesSelectionPluginOnSelectionStateEvent, WeaveNodesSelectionPluginOnStageSelectionEvent, WeaveNodesSelectionPluginParams, WeaveNodesSnappingPlugin, WeaveNodesSnappingPluginConfig, WeaveNodesSnappingPluginParams, WeavePasteModel, WeavePenToolAction, WeavePenToolActionState, WeavePenToolActionStateKeys, WeavePlugin, WeaveRectangleNode, WeaveRectangleToolAction, WeaveRectangleToolActionState, WeaveRectangleToolActionStateKeys, WeaveSelectionToolAction, WeaveSelectionToolActionState, WeaveSelectionToolActionStateKeys, WeaveStageContextMenuPluginConfig, WeaveStageContextMenuPluginOnNodeContextMenuEvent, WeaveStageContextMenuPluginParams, WeaveStageDropAreaPlugin, WeaveStageDropPluginOnStageDropEvent, WeaveStageGridPlugin, WeaveStageGridPluginConfig, WeaveStageGridPluginParams, WeaveStageGridType, WeaveStageGridTypeKeys, WeaveStageNode, WeaveStagePanningPlugin, WeaveStageResizePlugin, WeaveStageZoomChanged, WeaveStageZoomPlugin, WeaveStageZoomPluginConfig, WeaveStageZoomPluginOnZoomChangeEvent, WeaveStageZoomPluginParams, WeaveStore, WeaveTextNode, WeaveTextToolAction, WeaveTextToolActionState, WeaveTextToolActionStateKeys, WeaveToPasteNode, WeaveUserPointer, WeaveUserPointerKey, WeaveUserPointersUIProperties, WeaveUserSelectionInfo, WeaveUserSelectionKey, WeaveUsersPointersPlugin, WeaveUsersPointersPluginConfig, WeaveUsersPointersPluginParams, WeaveUsersSelectionPlugin, WeaveUsersSelectionPluginConfig, WeaveUsersSelectionPluginParams, WeaveZoomInToolAction, WeaveZoomInToolActionParams, WeaveZoomOutToolAction, WeaveZoomOutToolActionParams, checkIfOverContainer, clearContainerTargets, moveNodeToContainer, resetScale };