@emuanalytics/flow-rdf-core 0.0.15

package/dist/lib/map/plugins/index.d.cts

@@ -0,0 +1,309 @@
+import { I as MapEvent, y as FlowMap, w as MapSourceIdentifier, J as MapFeatureId, K as MapPluginBase, L as PluginManager, N as MapSourceEvent, O as MapMouseEvent, T as MapFeatureStream, U as PartialBy, r as MapAnimationOptions, V as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, u as MapFeatureIdentifier, t as MapFeature } from '../../../shared/flow-rdf-core.c9d2f730.cjs';
+export { Z as EventHandlers, Y as PluginConstructor, X as PluginEventsType, W as PluginOptionsType } from '../../../shared/flow-rdf-core.c9d2f730.cjs';
+import { F as Func } from '../../../shared/flow-rdf-core.08975378.cjs';
+import EventEmitter from 'eventemitter3';
+import * as lit from 'lit-html';
+import '@emuanalytics/flow-engine-client';
+import 'mobx-utils';
+import '@emuanalytics/maplibre-gl';
+
+type AnnotationMode = 'creating' | 'editing' | 'idle';
+type AnnotationFeatureType = 'Polygon' | 'Circle' | 'LineString' | 'Point';
+interface AnnotationStyle {
+    labelSize: number;
+    labelColor: string;
+    labelMaxWidth: number;
+    labelOffset: number[];
+    labelJustify: string;
+    labelAnchor: string;
+    polygonLabelAnchor: string;
+    radius: number;
+    fillColor: string;
+    strokeWidth: number;
+    strokeColor: string;
+    selectionStrokeColor: string;
+    selectionStrokeOpacity: number;
+    selectionWidth: number;
+    hoverStrokeColor: string;
+}
+interface AnnotationFeatureProps extends AnnotationStyle {
+    id: string;
+    name: string;
+    type: AnnotationFeatureType;
+    selected: boolean;
+    visible: boolean;
+    labelText: string;
+    [extras: string]: any;
+}
+interface AnnotationsServiceConfig {
+    style: AnnotationStyle;
+}
+type AnnotationFeature = GeoJSON.Feature<GeoJSON.Geometry, Partial<AnnotationFeatureProps>> & {
+    id: string;
+};
+
+interface AnnotationEventTypes {
+    annotationStateChanged: (event: AnnotationEvent) => void;
+}
+type AnnotationEventType = keyof AnnotationEventTypes;
+interface AnnotationEventData {
+    features: AnnotationFeature[];
+    mode: AnnotationMode;
+    canUndo: boolean;
+    canRedo: boolean;
+    activeFeatureId: string | null;
+    activeFeatureType: AnnotationFeatureType | null;
+}
+declare class AnnotationEvent extends MapEvent<AnnotationEventType> {
+    mode: AnnotationMode;
+    canUndo: boolean;
+    canRedo: boolean;
+    activeFeatureId: string | null;
+    activeFeatureType: AnnotationFeatureType | null;
+    features: AnnotationFeature[];
+    constructor(type: AnnotationEventType, map: FlowMap, data: AnnotationEventData);
+}
+
+type SelectionEventType = 'selectionChanged';
+interface SelectionEventTypes {
+    selectionChanged: (event: SelectionEvent) => void;
+}
+declare class SelectionEvent extends MapEvent<SelectionEventType> implements MapSourceIdentifier {
+    source: string;
+    sourceLayer?: string;
+    features: MapFeatureId[];
+    constructor(type: SelectionEventType, map: FlowMap, sourceIdentifier: MapSourceIdentifier, features: MapFeatureId[]);
+}
+
+type SelectionMode = 'single' | 'multi' | 'none';
+interface SelectionOptions {
+    clear?: boolean | 'group';
+    group?: string;
+    mode: SelectionMode;
+    popup?: string;
+    selectionState?: string;
+    sourceLayer?: string;
+}
+declare class SelectionPlugin extends MapPluginBase<undefined, SelectionEventTypes> {
+    private _sourceSelections;
+    private _enablePopups;
+    readonly name = "SelectionPlugin";
+    constructor(pluginManager: PluginManager);
+    clearSelection(source: string): void;
+    deselectFeatures(source: string, features: MapFeatureId | MapFeatureId[]): void;
+    destroy(): void;
+    disableSelection(source: string): void;
+    enableSelection(source: string, options: SelectionOptions): void;
+    handleBeforeSourceRemoved(event: MapSourceEvent): void;
+    handleClick(event: MapMouseEvent): void;
+    selectFeatures(source: string, features: MapFeatureId | MapFeatureId[]): void;
+    selectedFeatureIds(source: string): MapFeatureId[];
+    selectedFeatureStream(source: string): MapFeatureStream;
+    enablePopups(enabled?: boolean): void;
+    disablePopups(): void;
+}
+
+interface AnnotationOperation {
+    do: Func;
+    undo: Func;
+}
+interface AnnotationPluginOptions {
+    interactive?: boolean;
+    defaultStyle?: Partial<AnnotationStyle>;
+    selectionOptions?: SelectionOptions;
+}
+declare class AnnotationPlugin extends MapPluginBase<AnnotationPluginOptions, AnnotationEventTypes> {
+    readonly name = "AnnotationPlugin";
+    private static _defaultOptions;
+    private _features;
+    private _featureIds;
+    private _undoStack;
+    private _redoStack;
+    private _mode;
+    private _activeFeatureId;
+    private _activeFeatureType;
+    private _onCommitCleanup;
+    private _annotationDataSource;
+    private _drawControl;
+    private _removeKeyboardShortcuts;
+    constructor(pluginManager: PluginManager, options?: AnnotationPluginOptions);
+    initialize(): void;
+    destroy(): void;
+    clear(): this;
+    undo(): this;
+    /**
+     * Redo the last undone operation.
+     */
+    redo(): this;
+    getFeature(featureId: string): AnnotationFeature;
+    getFeatures(): AnnotationFeature[];
+    setFeatures(features: Array<PartialBy<AnnotationFeature, 'id'>>): this;
+    addFeature(feature: PartialBy<AnnotationFeature, 'id'>): AnnotationFeature;
+    deleteFeature(featureId: string): this;
+    createFeature(featureType: AnnotationFeatureType): void;
+    editFeature(featureId: string): void;
+    zoomToFeature(featureId: string, animationOptions: MapAnimationOptions): this;
+    setFeatureProperty(featureId: string, property: string, value: any): this;
+    setFeatureProperties(featureId: string, properties: Record<string, any>): this;
+    commit(): this;
+    cancel(): this;
+    render(): this;
+    handleDblClick?(event: MapMouseEvent): void;
+    handleBeforeStyleChanged(event: MapStyleChangeEvent): MapStyleSpecification;
+    private startDrawing;
+    private endDrawing;
+    private applyDefaults;
+    private generateFeatureId;
+    private generateFeatureName;
+    private performOperation;
+    private deselectFeature;
+    private deleteSelectedFeature;
+    private editModeForFeature;
+    private drawModeForFeatureType;
+    private setFeatureGeometry;
+    private isValidGeometry;
+    private emitStateChange;
+}
+
+interface DataJoinOptions {
+    /** Set to `true` to clear feature state before applying data join. */
+    clear?: boolean;
+    data: string | any[];
+    /** Data join foreign key. */
+    foreignKey: string;
+    parameters?: DataJoinParameter[];
+    source: string;
+    sourceLayer?: string;
+}
+interface DataJoinParameter {
+    name: string;
+    required?: boolean;
+    value: string | number | boolean;
+}
+declare class DataJoin {
+    readonly id: string;
+    readonly map: FlowMap;
+    private static defaultOptions;
+    private autorunDisposer;
+    private dataExpression;
+    private options;
+    private parameterExpressions;
+    constructor(id: string, map: FlowMap, options: DataJoinOptions);
+    get source(): string;
+    start(): void;
+    stop(): void;
+    private doDataJoin;
+    private loadData;
+}
+declare class DataJoinPlugin extends MapPluginBase {
+    private _joins;
+    readonly name = "DataJoinPlugin";
+    constructor(pluginManager: PluginManager);
+    addDataJoin(id: string, options: DataJoinOptions): void;
+    bindState(state: StateStore): void;
+    destroy(): void;
+    handleSourceRemoved(event: MapSourceEvent): void;
+    removeDataJoin(id: string): void;
+}
+
+declare class HoverEffectPlugin extends MapPluginBase {
+    private hoveredFeature;
+    readonly name = "HoverEffectPlugin";
+    constructor(pluginManager: PluginManager);
+    handleMouseMove(event: MapMouseEvent): void;
+    handleMouseOut(event: MapEvent): void;
+    handleSetExclusivePlugin(exclusivePlugins: MapPluginBase[]): void;
+    private compareFeatures;
+    private clearHover;
+}
+
+type MapPopupTemplateFn<TState extends StateStore = StateStore> = (feature: MapFeature | null, state: TState) => string | Node | lit.TemplateResult;
+interface MapPopupEvents {
+    closed: (popup: MapPopup) => void;
+}
+/**
+ * [[MapPopup]] options.
+ */
+interface MapPopupOptions {
+    /** Specify a CSS class to add to the popup. */
+    class?: string;
+    /** Enable 'close' button. */
+    closeButton?: boolean;
+    /** Enable closing popup on click on map. */
+    closeOnClick?: boolean;
+    /** Enable closing pop when map is moved. */
+    closeOnMove?: boolean;
+    /** Specify popup content as HTML string or HTML node. */
+    content: string | Node | MapPopupTemplateFn;
+    /** Maximum width of popup in CSS units. */
+    maxWidth?: string;
+    trackFeature?: boolean;
+}
+/**
+ * Core functionality for Flo.w map popups.
+ *
+ * @noInheritDoc
+ */
+declare class MapPopup extends EventEmitter<MapPopupEvents> {
+    readonly map: FlowMap;
+    readonly options: MapPopupOptions;
+    private _feature?;
+    private _contentContainer;
+    private _featureStream;
+    private _maplibrePopup;
+    private _featureStreamDisposer?;
+    /**
+     * Constructs a new `MapPopup` instance.
+     *
+     * This is called by the `FlowMap::openPopup` method.
+     *
+     * @param map Parent Flo.w map.
+     * @param options Popup options.
+     */
+    constructor(map: FlowMap, options: MapPopupOptions);
+    get feature(): MapFeatureIdentifier | undefined;
+    /**
+     * Close the popup.
+     */
+    close(): void;
+    /**
+     * Move the popup to a new location.
+     *
+     * @param lngLat New location.
+     */
+    moveTo(lngLat: [number, number]): void;
+    /**
+     * Open the popup at the specified location.
+     *
+     * @param lngLat Popup location.
+     */
+    open(event: MapMouseEvent): void;
+    open(lngLat: [number, number], feature?: MapFeatureIdentifier): void;
+    private cssClasses;
+    private handleFeatureUpdate;
+    private popupCloseHandler;
+    private renderContent;
+}
+
+declare class PopupPlugin extends MapPluginBase {
+    private _popupTemplates;
+    private _popups;
+    readonly name = "PopupPlugin";
+    constructor(pluginManager: PluginManager);
+    registerPopup(id: string, options: MapPopupOptions): void;
+    openPopup(id: string, event: MapMouseEvent): MapPopup;
+    openPopup(id: string, lngLat: [number, number], feature?: MapFeatureIdentifier): MapPopup;
+    closeAllPopups(): void;
+    closePopupsForSources(sources: string | string[]): void;
+}
+
+declare class UrlSyncPlugin extends MapPluginBase {
+    readonly name = "UrlSyncPlugin";
+    constructor(pluginManager: PluginManager);
+    initialize(): void;
+    handleMoveEnd(event: MapEvent): void;
+    private mapStateToHash;
+    private hashToMapState;
+}
+
+export { AnnotationEvent, AnnotationEventData, AnnotationEventType, AnnotationEventTypes, AnnotationFeature, AnnotationFeatureProps, AnnotationFeatureType, AnnotationMode, AnnotationOperation, AnnotationPlugin, AnnotationPluginOptions, AnnotationStyle, AnnotationsServiceConfig, DataJoin, DataJoinOptions, DataJoinPlugin, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, SelectionEventType, SelectionEventTypes, SelectionMode, SelectionOptions, SelectionPlugin, UrlSyncPlugin };

package/dist/lib/map/plugins/index.d.mts

@@ -0,0 +1,309 @@
+import { I as MapEvent, y as FlowMap, w as MapSourceIdentifier, J as MapFeatureId, K as MapPluginBase, L as PluginManager, N as MapSourceEvent, O as MapMouseEvent, T as MapFeatureStream, U as PartialBy, r as MapAnimationOptions, V as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, u as MapFeatureIdentifier, t as MapFeature } from '../../../shared/flow-rdf-core.c9d2f730.mjs';
+export { Z as EventHandlers, Y as PluginConstructor, X as PluginEventsType, W as PluginOptionsType } from '../../../shared/flow-rdf-core.c9d2f730.mjs';
+import { F as Func } from '../../../shared/flow-rdf-core.08975378.mjs';
+import EventEmitter from 'eventemitter3';
+import * as lit from 'lit-html';
+import '@emuanalytics/flow-engine-client';
+import 'mobx-utils';
+import '@emuanalytics/maplibre-gl';
+
+type AnnotationMode = 'creating' | 'editing' | 'idle';
+type AnnotationFeatureType = 'Polygon' | 'Circle' | 'LineString' | 'Point';
+interface AnnotationStyle {
+    labelSize: number;
+    labelColor: string;
+    labelMaxWidth: number;
+    labelOffset: number[];
+    labelJustify: string;
+    labelAnchor: string;
+    polygonLabelAnchor: string;
+    radius: number;
+    fillColor: string;
+    strokeWidth: number;
+    strokeColor: string;
+    selectionStrokeColor: string;
+    selectionStrokeOpacity: number;
+    selectionWidth: number;
+    hoverStrokeColor: string;
+}
+interface AnnotationFeatureProps extends AnnotationStyle {
+    id: string;
+    name: string;
+    type: AnnotationFeatureType;
+    selected: boolean;
+    visible: boolean;
+    labelText: string;
+    [extras: string]: any;
+}
+interface AnnotationsServiceConfig {
+    style: AnnotationStyle;
+}
+type AnnotationFeature = GeoJSON.Feature<GeoJSON.Geometry, Partial<AnnotationFeatureProps>> & {
+    id: string;
+};
+
+interface AnnotationEventTypes {
+    annotationStateChanged: (event: AnnotationEvent) => void;
+}
+type AnnotationEventType = keyof AnnotationEventTypes;
+interface AnnotationEventData {
+    features: AnnotationFeature[];
+    mode: AnnotationMode;
+    canUndo: boolean;
+    canRedo: boolean;
+    activeFeatureId: string | null;
+    activeFeatureType: AnnotationFeatureType | null;
+}
+declare class AnnotationEvent extends MapEvent<AnnotationEventType> {
+    mode: AnnotationMode;
+    canUndo: boolean;
+    canRedo: boolean;
+    activeFeatureId: string | null;
+    activeFeatureType: AnnotationFeatureType | null;
+    features: AnnotationFeature[];
+    constructor(type: AnnotationEventType, map: FlowMap, data: AnnotationEventData);
+}
+
+type SelectionEventType = 'selectionChanged';
+interface SelectionEventTypes {
+    selectionChanged: (event: SelectionEvent) => void;
+}
+declare class SelectionEvent extends MapEvent<SelectionEventType> implements MapSourceIdentifier {
+    source: string;
+    sourceLayer?: string;
+    features: MapFeatureId[];
+    constructor(type: SelectionEventType, map: FlowMap, sourceIdentifier: MapSourceIdentifier, features: MapFeatureId[]);
+}
+
+type SelectionMode = 'single' | 'multi' | 'none';
+interface SelectionOptions {
+    clear?: boolean | 'group';
+    group?: string;
+    mode: SelectionMode;
+    popup?: string;
+    selectionState?: string;
+    sourceLayer?: string;
+}
+declare class SelectionPlugin extends MapPluginBase<undefined, SelectionEventTypes> {
+    private _sourceSelections;
+    private _enablePopups;
+    readonly name = "SelectionPlugin";
+    constructor(pluginManager: PluginManager);
+    clearSelection(source: string): void;
+    deselectFeatures(source: string, features: MapFeatureId | MapFeatureId[]): void;
+    destroy(): void;
+    disableSelection(source: string): void;
+    enableSelection(source: string, options: SelectionOptions): void;
+    handleBeforeSourceRemoved(event: MapSourceEvent): void;
+    handleClick(event: MapMouseEvent): void;
+    selectFeatures(source: string, features: MapFeatureId | MapFeatureId[]): void;
+    selectedFeatureIds(source: string): MapFeatureId[];
+    selectedFeatureStream(source: string): MapFeatureStream;
+    enablePopups(enabled?: boolean): void;
+    disablePopups(): void;
+}
+
+interface AnnotationOperation {
+    do: Func;
+    undo: Func;
+}
+interface AnnotationPluginOptions {
+    interactive?: boolean;
+    defaultStyle?: Partial<AnnotationStyle>;
+    selectionOptions?: SelectionOptions;
+}
+declare class AnnotationPlugin extends MapPluginBase<AnnotationPluginOptions, AnnotationEventTypes> {
+    readonly name = "AnnotationPlugin";
+    private static _defaultOptions;
+    private _features;
+    private _featureIds;
+    private _undoStack;
+    private _redoStack;
+    private _mode;
+    private _activeFeatureId;
+    private _activeFeatureType;
+    private _onCommitCleanup;
+    private _annotationDataSource;
+    private _drawControl;
+    private _removeKeyboardShortcuts;
+    constructor(pluginManager: PluginManager, options?: AnnotationPluginOptions);
+    initialize(): void;
+    destroy(): void;
+    clear(): this;
+    undo(): this;
+    /**
+     * Redo the last undone operation.
+     */
+    redo(): this;
+    getFeature(featureId: string): AnnotationFeature;
+    getFeatures(): AnnotationFeature[];
+    setFeatures(features: Array<PartialBy<AnnotationFeature, 'id'>>): this;
+    addFeature(feature: PartialBy<AnnotationFeature, 'id'>): AnnotationFeature;
+    deleteFeature(featureId: string): this;
+    createFeature(featureType: AnnotationFeatureType): void;
+    editFeature(featureId: string): void;
+    zoomToFeature(featureId: string, animationOptions: MapAnimationOptions): this;
+    setFeatureProperty(featureId: string, property: string, value: any): this;
+    setFeatureProperties(featureId: string, properties: Record<string, any>): this;
+    commit(): this;
+    cancel(): this;
+    render(): this;
+    handleDblClick?(event: MapMouseEvent): void;
+    handleBeforeStyleChanged(event: MapStyleChangeEvent): MapStyleSpecification;
+    private startDrawing;
+    private endDrawing;
+    private applyDefaults;
+    private generateFeatureId;
+    private generateFeatureName;
+    private performOperation;
+    private deselectFeature;
+    private deleteSelectedFeature;
+    private editModeForFeature;
+    private drawModeForFeatureType;
+    private setFeatureGeometry;
+    private isValidGeometry;
+    private emitStateChange;
+}
+
+interface DataJoinOptions {
+    /** Set to `true` to clear feature state before applying data join. */
+    clear?: boolean;
+    data: string | any[];
+    /** Data join foreign key. */
+    foreignKey: string;
+    parameters?: DataJoinParameter[];
+    source: string;
+    sourceLayer?: string;
+}
+interface DataJoinParameter {
+    name: string;
+    required?: boolean;
+    value: string | number | boolean;
+}
+declare class DataJoin {
+    readonly id: string;
+    readonly map: FlowMap;
+    private static defaultOptions;
+    private autorunDisposer;
+    private dataExpression;
+    private options;
+    private parameterExpressions;
+    constructor(id: string, map: FlowMap, options: DataJoinOptions);
+    get source(): string;
+    start(): void;
+    stop(): void;
+    private doDataJoin;
+    private loadData;
+}
+declare class DataJoinPlugin extends MapPluginBase {
+    private _joins;
+    readonly name = "DataJoinPlugin";
+    constructor(pluginManager: PluginManager);
+    addDataJoin(id: string, options: DataJoinOptions): void;
+    bindState(state: StateStore): void;
+    destroy(): void;
+    handleSourceRemoved(event: MapSourceEvent): void;
+    removeDataJoin(id: string): void;
+}
+
+declare class HoverEffectPlugin extends MapPluginBase {
+    private hoveredFeature;
+    readonly name = "HoverEffectPlugin";
+    constructor(pluginManager: PluginManager);
+    handleMouseMove(event: MapMouseEvent): void;
+    handleMouseOut(event: MapEvent): void;
+    handleSetExclusivePlugin(exclusivePlugins: MapPluginBase[]): void;
+    private compareFeatures;
+    private clearHover;
+}
+
+type MapPopupTemplateFn<TState extends StateStore = StateStore> = (feature: MapFeature | null, state: TState) => string | Node | lit.TemplateResult;
+interface MapPopupEvents {
+    closed: (popup: MapPopup) => void;
+}
+/**
+ * [[MapPopup]] options.
+ */
+interface MapPopupOptions {
+    /** Specify a CSS class to add to the popup. */
+    class?: string;
+    /** Enable 'close' button. */
+    closeButton?: boolean;
+    /** Enable closing popup on click on map. */
+    closeOnClick?: boolean;
+    /** Enable closing pop when map is moved. */
+    closeOnMove?: boolean;
+    /** Specify popup content as HTML string or HTML node. */
+    content: string | Node | MapPopupTemplateFn;
+    /** Maximum width of popup in CSS units. */
+    maxWidth?: string;
+    trackFeature?: boolean;
+}
+/**
+ * Core functionality for Flo.w map popups.
+ *
+ * @noInheritDoc
+ */
+declare class MapPopup extends EventEmitter<MapPopupEvents> {
+    readonly map: FlowMap;
+    readonly options: MapPopupOptions;
+    private _feature?;
+    private _contentContainer;
+    private _featureStream;
+    private _maplibrePopup;
+    private _featureStreamDisposer?;
+    /**
+     * Constructs a new `MapPopup` instance.
+     *
+     * This is called by the `FlowMap::openPopup` method.
+     *
+     * @param map Parent Flo.w map.
+     * @param options Popup options.
+     */
+    constructor(map: FlowMap, options: MapPopupOptions);
+    get feature(): MapFeatureIdentifier | undefined;
+    /**
+     * Close the popup.
+     */
+    close(): void;
+    /**
+     * Move the popup to a new location.
+     *
+     * @param lngLat New location.
+     */
+    moveTo(lngLat: [number, number]): void;
+    /**
+     * Open the popup at the specified location.
+     *
+     * @param lngLat Popup location.
+     */
+    open(event: MapMouseEvent): void;
+    open(lngLat: [number, number], feature?: MapFeatureIdentifier): void;
+    private cssClasses;
+    private handleFeatureUpdate;
+    private popupCloseHandler;
+    private renderContent;
+}
+
+declare class PopupPlugin extends MapPluginBase {
+    private _popupTemplates;
+    private _popups;
+    readonly name = "PopupPlugin";
+    constructor(pluginManager: PluginManager);
+    registerPopup(id: string, options: MapPopupOptions): void;
+    openPopup(id: string, event: MapMouseEvent): MapPopup;
+    openPopup(id: string, lngLat: [number, number], feature?: MapFeatureIdentifier): MapPopup;
+    closeAllPopups(): void;
+    closePopupsForSources(sources: string | string[]): void;
+}
+
+declare class UrlSyncPlugin extends MapPluginBase {
+    readonly name = "UrlSyncPlugin";
+    constructor(pluginManager: PluginManager);
+    initialize(): void;
+    handleMoveEnd(event: MapEvent): void;
+    private mapStateToHash;
+    private hashToMapState;
+}
+
+export { AnnotationEvent, AnnotationEventData, AnnotationEventType, AnnotationEventTypes, AnnotationFeature, AnnotationFeatureProps, AnnotationFeatureType, AnnotationMode, AnnotationOperation, AnnotationPlugin, AnnotationPluginOptions, AnnotationStyle, AnnotationsServiceConfig, DataJoin, DataJoinOptions, DataJoinPlugin, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, SelectionEventType, SelectionEventTypes, SelectionMode, SelectionOptions, SelectionPlugin, UrlSyncPlugin };