@buerli.io/core 0.10.0 → 0.12.0

package/build/types/index.d.ts

@@ -1,37 +1,37 @@
-export * from './store';
-export * from './geometry';
-export * from './types';
-export * from './utils/Math';
-export * from './utils/Measure';
-export * from './utils/Timing';
-export * from './store/subscribtion/subscribeToDrawing';
-export * from './graphic/filters';
-/**
- * Because babel typescript tools can not handle the type definitions
- * in an other way, they have to be re-exported as you can see in this code region.
- *
- * Please have a look at https://github.com/awv-informatik/buerli/pull/129 for more information.
- */
-import { BuerliState as BS } from './store/states/buerli';
-export declare type BuerliState = BS;
-import { DrawingAPI as DrawingAPI1, DrawingID as DrawingID1, DrawingState as DrawingState1 } from './store/states/drawing';
-export declare type DrawingID = DrawingID1;
-export declare type DrawingState = DrawingState1;
-export declare type DrawingAPI = DrawingAPI1;
-import { GeometryConfig as GeometryConfig1, GeometryBounds as GeometryBounds1 } from './store/states/geometry';
-export declare type GeometryConfig = GeometryConfig1;
-export declare type GeometryBounds = GeometryBounds1;
-import { Plugin as Plugin1, PluginDescription as PluginDescription1, PluginID as PluginID1, PluginState as PluginState1 } from './store/states/plugin';
-export declare type Plugin = Plugin1;
-export declare type PluginDescription<InternalState = any> = PluginDescription1<InternalState>;
-export declare type PluginID = PluginID1;
-export declare type PluginState<InternalState extends Record<any, any> = any> = PluginState1<InternalState>;
-import { SeletedItemData, SelectedItem as SelectedItem1, SelectionFilter as SelectionFilter1, SelectionScope as SelectionScope1, Selector as Selector1, SelectorID as SelectorID1, CustomSelect as CustomSelect1 } from './store/states/selection';
-export declare type SelectedItem<T extends SeletedItemData<any> = any> = SelectedItem1<T>;
-export declare type SelectionFilter = SelectionFilter1;
-export declare type SelectionScope = SelectionScope1;
-export declare type Selector<T extends SeletedItemData<any> = any> = Selector1<T>;
-export declare type SelectorID = SelectorID1;
-export declare type CustomSelect = CustomSelect1;
-import { Message as Message1 } from './store/states/message';
-export declare type Message = Message1;
+export * from './store';
+export * from './geometry';
+export * from './types';
+export * from './utils/Math';
+export * from './utils/Measure';
+export * from './utils/Timing';
+export * from './store/subscribtion/subscribeToDrawing';
+export * from './graphic/filters';
+/**
+ * Because babel typescript tools can not handle the type definitions
+ * in an other way, they have to be re-exported as you can see in this code region.
+ *
+ * Please have a look at https://github.com/awv-informatik/buerli/pull/129 for more information.
+ */
+import { BuerliState as BS } from './store/states/buerli';
+export declare type BuerliState = BS;
+import { DrawingAPI as DrawingAPI1, DrawingID as DrawingID1, DrawingState as DrawingState1 } from './store/states/drawing';
+export declare type DrawingID = DrawingID1;
+export declare type DrawingState = DrawingState1;
+export declare type DrawingAPI = DrawingAPI1;
+import { GeometryConfig as GeometryConfig1, GeometryBounds as GeometryBounds1 } from './store/states/geometry';
+export declare type GeometryConfig = GeometryConfig1;
+export declare type GeometryBounds = GeometryBounds1;
+import { Plugin as Plugin1, PluginDescription as PluginDescription1, PluginID as PluginID1, PluginState as PluginState1 } from './store/states/plugin';
+export declare type Plugin = Plugin1;
+export declare type PluginDescription<InternalState = any> = PluginDescription1<InternalState>;
+export declare type PluginID = PluginID1;
+export declare type PluginState<InternalState extends Record<any, any> = any> = PluginState1<InternalState>;
+import { SeletedItemData, SelectedItem as SelectedItem1, SelectionFilter as SelectionFilter1, SelectionScope as SelectionScope1, Selector as Selector1, SelectorID as SelectorID1, CustomSelect as CustomSelect1 } from './store/states/selection';
+export declare type SelectedItem<T extends SeletedItemData<any> = any> = SelectedItem1<T>;
+export declare type SelectionFilter = SelectionFilter1;
+export declare type SelectionScope = SelectionScope1;
+export declare type Selector<T extends SeletedItemData<any> = any> = Selector1<T>;
+export declare type SelectorID = SelectorID1;
+export declare type CustomSelect = CustomSelect1;
+import { Message as Message1 } from './store/states/message';
+export declare type Message = Message1;

package/build/types/store/index.d.ts

@@ -1,16 +1,16 @@
-import { BuerliState } from './states/buerli';
-import { DrawingID, DrawingState } from './states/drawing';
-import { Message, MessageID } from './states/message';
-import { PluginID, PluginState } from './states/plugin';
-declare function getDrawing(id: DrawingID): DrawingState;
-/**
- * @returns PluginState or undefined if either drawing or plugin don't exist
- */
-declare function getPlugin(drawingId: DrawingID, pluginId: PluginID): PluginState;
-declare function init(options?: Partial<BuerliState['options']>): void;
-declare function showMessage(message: Message): MessageID;
-declare function updateMessage(id: MessageID, message: Message): void;
-export { BuerliMessageScope } from './states/message';
-export { BuerliScope, createGraphicItem } from './states/selection';
-export { api } from './store';
-export { getDrawing, getPlugin, init, showMessage, updateMessage };
+import { BuerliState } from './states/buerli';
+import { DrawingID, DrawingState } from './states/drawing';
+import { Message, MessageID } from './states/message';
+import { PluginID, PluginState } from './states/plugin';
+declare function getDrawing(id: DrawingID): DrawingState;
+/**
+ * @returns PluginState or undefined if either drawing or plugin don't exist
+ */
+declare function getPlugin(drawingId: DrawingID, pluginId: PluginID): PluginState;
+declare function init(options?: Partial<BuerliState['options']>): void;
+declare function showMessage(message: Message): MessageID;
+declare function updateMessage(id: MessageID, message: Message): void;
+export { BuerliMessageScope } from './states/message';
+export { BuerliScope, createGraphicItem } from './states/selection';
+export { api } from './store';
+export { getDrawing, getPlugin, init, showMessage, updateMessage };

package/build/types/store/states/buerli.d.ts

@@ -1,41 +1,41 @@
-import { StateCreator } from 'zustand';
-import { DrawingID, DrawingState } from './drawing';
-import { GeometryConfig } from './geometry';
-import { MessageState } from './message';
-import { PluginDef, PluginImpl } from './plugin';
-declare type GeneralApi = {
-    init(options?: Partial<BuerliState['options']>): void;
-};
-declare type DrawingManagementApi = {
-    createDrawing(name?: string): Promise<DrawingState>;
-    removeDrawing(id: DrawingID): void;
-    setActiveDrawing(id: DrawingID | null): void;
-};
-export declare type BuerliState = Readonly<{
-    initDone: boolean;
-    options: {
-        elements: any;
-        plugins: Record<string, PluginImpl>;
-        globalPlugins: PluginDef[];
-        theme: {
-            primary: string;
-            secondary: string;
-            dark: string;
-            highlightedGeom: string;
-            hoveredGeom: string;
-        };
-        config: {
-            geometry: GeometryConfig;
-        };
-    };
-    drawing: {
-        ids: DrawingID[];
-        refs: Record<DrawingID, DrawingState>;
-        active: DrawingID | null;
-    };
-    api: GeneralApi & DrawingManagementApi;
-}> & Readonly<MessageState>;
-export declare const createState: StateCreator<BuerliState, [], [], BuerliState>;
-export declare const generalApi: StateCreator<BuerliState, [], [], GeneralApi>;
-export declare const drawingManagementApi: StateCreator<BuerliState, [], [], DrawingManagementApi>;
-export {};
+import { StateCreator } from 'zustand';
+import { DrawingID, DrawingState } from './drawing';
+import { GeometryConfig } from './geometry';
+import { MessageState } from './message';
+import { PluginDef, PluginImpl } from './plugin';
+declare type GeneralApi = {
+    init(options?: Partial<BuerliState['options']>): void;
+};
+declare type DrawingManagementApi = {
+    createDrawing(name?: string): Promise<DrawingState>;
+    removeDrawing(id: DrawingID): void;
+    setActiveDrawing(id: DrawingID | null): void;
+};
+export declare type BuerliState = Readonly<{
+    initDone: boolean;
+    options: {
+        elements: any;
+        plugins: Record<string, PluginImpl>;
+        globalPlugins: PluginDef[];
+        theme: {
+            primary: string;
+            secondary: string;
+            dark: string;
+            highlightedGeom: string;
+            hoveredGeom: string;
+        };
+        config: {
+            geometry: GeometryConfig;
+        };
+    };
+    drawing: {
+        ids: DrawingID[];
+        refs: Record<DrawingID, DrawingState>;
+        active: DrawingID | null;
+    };
+    api: GeneralApi & DrawingManagementApi;
+}> & Readonly<MessageState>;
+export declare const createState: StateCreator<BuerliState, [], [], BuerliState>;
+export declare const generalApi: StateCreator<BuerliState, [], [], GeneralApi>;
+export declare const drawingManagementApi: StateCreator<BuerliState, [], [], DrawingManagementApi>;
+export {};

package/build/types/store/states/cad.d.ts

@@ -1,42 +1,53 @@
-import { StoreApi } from 'zustand';
-import { BuerliState } from './buerli';
-import { DrawingState } from './drawing';
-declare type States = {
-    current: number;
-    stack: string[];
-    captionMap: Record<string, {
-        stateName: string;
-        caption: string;
-    }>;
-};
-declare type Pending = {
-    id: string;
-    name: string;
-    stamp: number;
-    args?: any;
-    promise?: Promise<any>;
-};
-export declare type CadData = {
-    connected: boolean;
-    states: States;
-    pending: Pending[];
-};
-export declare type CadApi = ReturnType<typeof cadApi>;
-export declare const cadData: () => CadData;
-export declare const cadApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
-    setStates: (current: number, stack: string[], captionMap: Record<string, {
-        stateName: string;
-        caption: string;
-    }>) => void;
-    setCaptionMap: (captionMap: Record<string, {
-        stateName: string;
-        caption: string;
-    }>) => void;
-    addPending: (name: string, options?: {
-        args?: any;
-        promise?: Promise<any>;
-    }) => string;
-    removePending: (id: string) => void;
-    setConnected: (connected: boolean) => void;
-};
-export {};
+import { StoreApi } from 'zustand';
+import { BuerliState } from './buerli';
+import { DrawingState } from './drawing';
+declare type States = {
+    current: number;
+    stack: string[];
+    captionMap: Record<string, {
+        stateName: string;
+        caption: string;
+    }>;
+};
+declare type Pending = {
+    id: string;
+    name: string;
+    stamp: number;
+    args?: any;
+    promise?: Promise<any>;
+};
+export declare type CadData = {
+    connection: {
+        active: boolean;
+        connected: boolean;
+    };
+    states: States;
+    pending: Pending[];
+};
+export declare type CadApi = ReturnType<typeof cadApi>;
+export declare const cadData: () => CadData;
+export declare const cadApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
+    setStates: (current: number, stack: string[], captionMap: Record<string, {
+        stateName: string;
+        caption: string;
+    }>) => void;
+    setCaptionMap: (captionMap: Record<string, {
+        stateName: string;
+        caption: string;
+    }>) => void;
+    addPending: (name: string, options?: {
+        args?: any;
+        promise?: Promise<any>;
+    }) => string;
+    removePending: (id: string) => void;
+    setConnected: (connected: boolean) => void;
+    setActive: (active: boolean) => void;
+    /**
+     * Clears the pending requests list.
+     *
+     * **This method is designed for interal usage only, please do not use it in user code!**
+     * **It will be removed in a future release!**
+     */
+    clearPending: () => void;
+};
+export {};

package/build/types/store/states/drawing.d.ts

@@ -1,45 +1,45 @@
-/**!
- * The Drawing manages all necessary data that belong to a model.
- *
- * On the one hand these are the structure and graphic data by which the
- * CAD model is defined, on the other hand it administers additional data
- * for the support with the client-sided development.
- *
- * @image /doc/assets/core/drawing.png
- */
-import { StoreApi } from 'zustand';
-import { BuerliState } from './buerli';
-import { CadApi, CadData } from './cad';
-import { GeometryApi, GeometryData } from './geometry';
-import { GraphicApi, GraphicData } from './graphic';
-import { InteractionApi, InteractionData } from './interaction';
-import { PluginApi, PluginData } from './plugin';
-import { SelectionApi, SelectionData } from './selection';
-import { StructureApi, StructureData } from './structure';
-export declare type DrawingID = string | number;
-export declare type DrawingAPI = {
-    structure: StructureApi;
-    selection: SelectionApi;
-    interaction: InteractionApi;
-    plugin: PluginApi;
-    geometry: GeometryApi;
-    graphic: GraphicApi;
-    cad: CadApi;
-    reset: () => void;
-};
-declare type StateData = {
-    id: DrawingID;
-    name: string;
-    structure: StructureData;
-    geometry: GeometryData;
-    graphic: GraphicData;
-    selection: SelectionData;
-    interaction: InteractionData;
-    plugin: PluginData;
-    cad: CadData;
-};
-export declare type DrawingState = Readonly<StateData> & Readonly<{
-    api: DrawingAPI;
-}>;
-export declare const createDrawingState: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>, drawingNumber: number, name?: string) => DrawingState;
-export {};
+/**!
+ * The Drawing manages all necessary data that belong to a model.
+ *
+ * On the one hand these are the structure and graphic data by which the
+ * CAD model is defined, on the other hand it administers additional data
+ * for the support with the client-sided development.
+ *
+ * @image /doc/assets/core/drawing.png
+ */
+import { StoreApi } from 'zustand';
+import { BuerliState } from './buerli';
+import { CadApi, CadData } from './cad';
+import { GeometryApi, GeometryData } from './geometry';
+import { GraphicApi, GraphicData } from './graphic';
+import { InteractionApi, InteractionData } from './interaction';
+import { PluginApi, PluginData } from './plugin';
+import { SelectionApi, SelectionData } from './selection';
+import { StructureApi, StructureData } from './structure';
+export declare type DrawingID = string | number;
+export declare type DrawingAPI = {
+    structure: StructureApi;
+    selection: SelectionApi;
+    interaction: InteractionApi;
+    plugin: PluginApi;
+    geometry: GeometryApi;
+    graphic: GraphicApi;
+    cad: CadApi;
+    reset: () => void;
+};
+declare type StateData = {
+    id: DrawingID;
+    name: string;
+    structure: StructureData;
+    geometry: GeometryData;
+    graphic: GraphicData;
+    selection: SelectionData;
+    interaction: InteractionData;
+    plugin: PluginData;
+    cad: CadData;
+};
+export declare type DrawingState = Readonly<StateData> & Readonly<{
+    api: DrawingAPI;
+}>;
+export declare const createDrawingState: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>, drawingNumber: number, name?: string) => DrawingState;
+export {};

package/build/types/store/states/geometry.d.ts

@@ -1,63 +1,63 @@
-import * as THREE from 'three';
-import { StoreApi } from 'zustand';
-import { ContainerGeometryT, GeometryElement } from '../../geometry/ThreeGeometryCreator';
-import { ObjectID } from '../../types/IStructureTree';
-import { BuerliState } from './buerli';
-import { DrawingState } from './drawing';
-export declare type GeometryBounds = {
-    center: THREE.Vector3;
-    radius: number;
-    max: THREE.Vector3;
-    min: THREE.Vector3;
-};
-declare type ElementConfig = {
-    hidden?: boolean;
-    color?: any;
-    opacity?: number;
-};
-export declare type GeometryConfig = {
-    disabled?: boolean;
-    meshes?: ElementConfig & {
-        wireframe?: boolean;
-        depthWrite?: boolean;
-    };
-    edges?: ElementConfig;
-    points?: ElementConfig;
-};
-export declare type GeometryData = {
-    cache: Record<ObjectID, // The id of the CADEntity
-    // The id of the CADEntity
-    ContainerGeometryT & {
-        /**
-         * The dirty stamp will be updated, as soon as a client side modification of the geometry will happen!
-         * Examples: 'setColor' or 'setOpacity'
-         *
-         * Can for example be used to trigger the render process for this container.
-         */
-        dirtyStamp?: number;
-    }>;
-    stamp: number;
-    bounds: GeometryBounds;
-    config: {
-        product: Record<ObjectID, GeometryConfig>;
-    };
-};
-export declare type GeometryApi = ReturnType<typeof geometryApi>;
-export declare const geometryData: () => GeometryData;
-export declare const geometryApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
-    /**
-     * Updates the @see geometry.bounds depending on all products of the model.
-     * The update will only happen, if at least one solid of one product is available.
-     */
-    updateBounds: () => void;
-    createGeometryIfNotCached: (containerId: ObjectID, color?: number[]) => ContainerGeometryT | undefined;
-    setColor: (containerId: ObjectID, r: number, g: number, b: number) => void;
-    setOpacity: (containerId: ObjectID, opacity: number) => void;
-    setConfig: (objId: ObjectID, config: Partial<GeometryConfig> | null) => void;
-    findDecorated: () => GeometryElement[];
-    filter: (cb: (elem: GeometryElement) => boolean, options?: {
-        onlyOne?: boolean;
-        containerId?: ObjectID;
-    }) => GeometryElement[];
-};
-export {};
+import * as THREE from 'three';
+import { StoreApi } from 'zustand';
+import { ContainerGeometryT, GeometryElement } from '../../geometry/ThreeGeometryCreator';
+import { ObjectID } from '../../types/IStructureTree';
+import { BuerliState } from './buerli';
+import { DrawingState } from './drawing';
+export declare type GeometryBounds = {
+    center: THREE.Vector3;
+    radius: number;
+    max: THREE.Vector3;
+    min: THREE.Vector3;
+};
+declare type ElementConfig = {
+    hidden?: boolean;
+    color?: any;
+    opacity?: number;
+};
+export declare type GeometryConfig = {
+    disabled?: boolean;
+    meshes?: ElementConfig & {
+        wireframe?: boolean;
+        depthWrite?: boolean;
+    };
+    edges?: ElementConfig;
+    points?: ElementConfig;
+};
+export declare type GeometryData = {
+    cache: Record<ObjectID, // The id of the CADEntity
+    // The id of the CADEntity
+    ContainerGeometryT & {
+        /**
+         * The dirty stamp will be updated, as soon as a client side modification of the geometry will happen!
+         * Examples: 'setColor' or 'setOpacity'
+         *
+         * Can for example be used to trigger the render process for this container.
+         */
+        dirtyStamp?: number;
+    }>;
+    stamp: number;
+    bounds: GeometryBounds;
+    config: {
+        product: Record<ObjectID, GeometryConfig>;
+    };
+};
+export declare type GeometryApi = ReturnType<typeof geometryApi>;
+export declare const geometryData: () => GeometryData;
+export declare const geometryApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
+    /**
+     * Updates the @see geometry.bounds depending on all products of the model.
+     * The update will only happen, if at least one solid of one product is available.
+     */
+    updateBounds: () => void;
+    createGeometryIfNotCached: (containerId: ObjectID, color?: number[]) => ContainerGeometryT | undefined;
+    setColor: (containerId: ObjectID, r: number, g: number, b: number) => void;
+    setOpacity: (containerId: ObjectID, opacity: number) => void;
+    setConfig: (objId: ObjectID, config: Partial<GeometryConfig> | null) => void;
+    findDecorated: () => GeometryElement[];
+    filter: (cb: (elem: GeometryElement) => boolean, options?: {
+        onlyOne?: boolean;
+        containerId?: ObjectID;
+    }) => GeometryElement[];
+};
+export {};

package/build/types/store/states/graphic.d.ts

@@ -1,22 +1,22 @@
-import { StoreApi } from 'zustand';
-import { IGraphicContainer, IGraphicElement, IGraphicPackage } from '../../types/IGraphicPackage';
-import { ObjectID } from '../../types/IStructureTree';
-import { BuerliState } from './buerli';
-import { DrawingState } from './drawing';
-export declare type GraphicData = {
-    containers: Record<number, IGraphicContainer>;
-};
-export declare type GraphicApi = ReturnType<typeof graphicApi>;
-export declare const graphicData: () => GraphicData;
-export declare const graphicApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
-    addPackages: (packages: IGraphicPackage[]) => void;
-    cleanupGraphicRecords: () => void;
-    filter: (cb: (elem: IGraphicElement) => boolean, options?: {
-        onlyOne?: boolean;
-        containerId?: ObjectID;
-    }) => {
-        elem: IGraphicElement;
-        containerId: ObjectID;
-        solidId: ObjectID;
-    }[];
-};
+import { StoreApi } from 'zustand';
+import { IGraphicContainer, IGraphicElement, IGraphicPackage } from '../../types/IGraphicPackage';
+import { ObjectID } from '../../types/IStructureTree';
+import { BuerliState } from './buerli';
+import { DrawingState } from './drawing';
+export declare type GraphicData = {
+    containers: Record<number, IGraphicContainer>;
+};
+export declare type GraphicApi = ReturnType<typeof graphicApi>;
+export declare const graphicData: () => GraphicData;
+export declare const graphicApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
+    addPackages: (packages: IGraphicPackage[]) => void;
+    cleanupGraphicRecords: () => void;
+    filter: (cb: (elem: IGraphicElement) => boolean, options?: {
+        onlyOne?: boolean;
+        containerId?: ObjectID;
+    }) => {
+        elem: IGraphicElement;
+        containerId: ObjectID;
+        solidId: ObjectID;
+    }[];
+};

package/build/types/store/states/interaction.d.ts

@@ -1,34 +1,34 @@
-import { StoreApi } from 'zustand';
-import { InteractionInfo } from '../../types';
-import { BuerliState } from './buerli';
-import { DrawingState } from './drawing';
-export declare type InteractionData = {
-    hovered?: InteractionInfo | null;
-    selected?: InteractionInfo[];
-};
-export declare type InteractionApi = ReturnType<typeof interactionApi>;
-export declare const interactionData: () => InteractionData;
-export declare const interactionApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
-    /**
-     * Sets the hovered item in the store to the given item.
-     *
-     * @param item The item.
-     */
-    setHovered: (item: InteractionInfo | null) => void;
-    /**
-     * Reset the 'selected' array to the given items.
-     *
-     * @param items The items.
-     */
-    setSelected: (items: InteractionInfo[]) => void;
-    /**
-     * Adds the given item to the 'selected' array if it is not yet selected.
-     * If the item is already selected, it will be removed from the 'selected' array.
-     *
-     * With 'multi' enabled, the already selected items will remain selected.
-     *
-     * @param item The item to select.
-     * @param multi Do multi select.
-     */
-    select: (item: InteractionInfo, multi?: boolean) => void;
-};
+import { StoreApi } from 'zustand';
+import { InteractionInfo } from '../../types';
+import { BuerliState } from './buerli';
+import { DrawingState } from './drawing';
+export declare type InteractionData = {
+    hovered?: InteractionInfo | null;
+    selected?: InteractionInfo[];
+};
+export declare type InteractionApi = ReturnType<typeof interactionApi>;
+export declare const interactionData: () => InteractionData;
+export declare const interactionApi: (set: StoreApi<DrawingState>['setState'], get: StoreApi<DrawingState>['getState'], buerliApi: StoreApi<BuerliState>) => {
+    /**
+     * Sets the hovered item in the store to the given item.
+     *
+     * @param item The item.
+     */
+    setHovered: (item: InteractionInfo | null) => void;
+    /**
+     * Reset the 'selected' array to the given items.
+     *
+     * @param items The items.
+     */
+    setSelected: (items: InteractionInfo[]) => void;
+    /**
+     * Adds the given item to the 'selected' array if it is not yet selected.
+     * If the item is already selected, it will be removed from the 'selected' array.
+     *
+     * With 'multi' enabled, the already selected items will remain selected.
+     *
+     * @param item The item to select.
+     * @param multi Do multi select.
+     */
+    select: (item: InteractionInfo, multi?: boolean) => void;
+};