@mapcomponents/react-maplibre 1.3.3 → 1.5.0-2

package/dist/src/components/MlWmsLoader/MlWmsLoader.d.ts

@@ -1,125 +0,0 @@
-import React from 'react';
-import { useWmsProps } from '../../hooks/useWms';
-import { Layer2 } from 'wms-capabilities';
-import { useWmsReturnType } from '../../hooks/useWms';
-export interface WmsConfig {
-    /**
-     * The URL to use for the getFeatureInfo request
-     */
-    getFeatureInfoUrl: useWmsReturnType['getFeatureInfoUrl'];
-    /**
-     * The URL of the WMS service
-     */
-    wmsUrl: useWmsReturnType['wmsUrl'];
-    /**
-     * The layers to display on the map
-     */
-    layers: LayerType[];
-    /**
-     * If true, the WMS layer is visible
-     */
-    visible: boolean;
-    /**
-     * If true, the WMS layer is open
-     */
-    open: boolean;
-    /**
-     * The name of the WMS layer
-     */
-    name?: string;
-}
-export interface MlWmsLoaderProps {
-    /**
-     * WMS URL
-     */
-    url: string;
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    layerId?: string;
-    insertBeforeLayer?: string;
-    /**
-     * URL parameters that will be used in the getCapabilities request
-     */
-    urlParameters?: useWmsProps['urlParameters'];
-    /**
-     * URL parameters that will be added when requesting WMS capabilities
-     */
-    wmsUrlParameters?: {
-        [key: string]: string;
-    };
-    /**
-     * If true, zooms to the extent of the WMS layer after loading the getCapabilities response
-     */
-    zoomToExtent?: boolean;
-    /**
-     * The name of the ListItem element representing the WmsLoader
-     */
-    name?: string;
-    /**
-     * If true, enables the feature info functionality
-     */
-    featureInfoEnabled?: boolean;
-    /**
-     * If true, the feature info functionality is active
-     */
-    featureInfoActive?: boolean;
-    /**
-     * A function to set the feature info active state
-     */
-    setFeatureInfoActive?: (val: boolean | ((current: boolean) => boolean)) => void;
-    /**
-     * The WMS configuration object
-     */
-    config?: WmsConfig;
-    /**
-     * A function to handle changes to the WMS configuration
-     */
-    onConfigChange?: (config: WmsConfig | false) => void;
-    /**
-     * A function to update a LayerType config array that is passed to this component at props.config.layers
-     */
-    setLayers?: (layers: LayerType[]) => void;
-    /**
-     * If true, shows the delete button for the WMSLoader
-     */
-    showDeleteButton?: boolean;
-    /**
-     * Custom buttons to display for the WMSLoader
-     */
-    buttons?: React.JSX.Element;
-    sortable?: boolean;
-}
-export type LayerType = {
-    visible: boolean;
-    Name: string;
-    Attribution?: {
-        Title: string;
-    };
-} & Omit<Layer2, 'Layer' | 'CRS'> & Partial<Pick<Layer2, 'Layer'>>;
-/**
- * Loads a WMS getCapabilities xml document and adds a MlWmsLayer component for each layer that is
- * offered by the WMS.
- *
- * @component
- */
-declare const MlWmsLoader: {
-    (props: MlWmsLoaderProps): React.JSX.Element;
-    defaultProps: {
-        mapId: undefined;
-        url: string;
-        urlParameters: {
-            SERVICE: string;
-            VERSION: string;
-            REQUEST: string;
-        };
-        wmsUrlParameters: {
-            TRANSPARENT: string;
-        };
-        featureInfoEnabled: boolean;
-        zoomToExtent: boolean;
-        showDeleteButton: boolean;
-    };
-};
-export default MlWmsLoader;

package/dist/src/components/MlWmsLoader/utils/MlWmsLoaderInstructions.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-export default function MlWmsLoaderInstructions(props: {
-    open: boolean;
-}): React.JSX.Element;

package/dist/src/components/MlWmsLoader/utils/WMSLinks.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-export interface wmsLinksProps {
-    load: (str: string) => void;
-    open: boolean;
-    close: () => void;
-    openWMSLoader: (boolean: boolean) => void;
-}
-export default function WMSLinks(props: wmsLinksProps): React.JSX.Element;

package/dist/src/contexts/LayerContext.d.ts

@@ -1,59 +0,0 @@
-import { StyleSpecification } from 'maplibre-gl';
-import React from 'react';
-import { MlVectorTileLayerProps } from '../components/MlVectorTileLayer/MlVectorTileLayer';
-import { MlGeoJsonLayerProps } from '../components/MlGeoJsonLayer/MlGeoJsonLayer';
-import { Layer } from 'wms-capabilities';
-export interface LayerContextProps {
-    children: React.ReactNode;
-}
-export interface wmsLoaderConfigProps {
-    getFeatureInfoUrl: string;
-    layers: Layer[];
-    name: string;
-    open: boolean;
-    visible: boolean;
-    wmsUrl: string;
-}
-export interface wmsConfig {
-    featureInfoActive?: boolean;
-    config?: wmsLoaderConfigProps;
-    url: string;
-}
-export type WmsLayerConfig = {
-    type: 'wms';
-    name?: string;
-    id?: string;
-    config: wmsConfig;
-};
-export type GeojsonLayerConfig = {
-    type: 'geojson';
-    name?: string;
-    id?: string;
-    config: MlGeoJsonLayerProps;
-};
-export type VtLayerConfig = {
-    type: 'vt';
-    name?: string;
-    id?: string;
-    config: MlVectorTileLayerProps;
-};
-export type LayerConfig = WmsLayerConfig | GeojsonLayerConfig | VtLayerConfig;
-export interface LayerContextType {
-    layers: LayerConfig[];
-    setLayers: (layers: LayerConfig[] | ((layers: LayerConfig[]) => LayerConfig[])) => void;
-    backgroundLayers: MlVectorTileLayerProps['layers'];
-    setBackgroundLayers: (layers: MlVectorTileLayerProps['layers'] | ((layers: MlVectorTileLayerProps['layers']) => MlVectorTileLayerProps['layers'])) => void;
-    symbolLayers: MlVectorTileLayerProps['layers'];
-    setSymbolLayers: (layers: MlVectorTileLayerProps['layers'] | ((layers: MlVectorTileLayerProps['layers']) => MlVectorTileLayerProps['layers'])) => void;
-    updateStyle: (style: StyleSpecification) => void;
-    vtLayerConfig: Partial<MlVectorTileLayerProps>;
-    setTileUrl: (url: string) => void;
-    tileUrl: string;
-    moveUp: (layerId: string) => void;
-    moveDown: (layerId: string) => void;
-    moveLayer: (layerId: string, getNewPos: (oldPos: number) => number) => void;
-}
-declare const LayerContext: React.Context<LayerContextType>;
-declare function LayerContextProvider(props: LayerContextProps): React.JSX.Element;
-export default LayerContext;
-export { LayerContextProvider };

package/dist/src/contexts/MapContext.d.ts

@@ -1,26 +0,0 @@
-import React, { ReactNode } from 'react';
-import MapLibreGlWrapper from '../components/MapLibreMap/lib/MapLibreGlWrapper';
-export interface MapContextType {
-    mapIds: string[];
-    mapExists: (map_id: string | undefined) => boolean;
-    maps: {
-        [key: string]: MapLibreGlWrapper;
-    };
-    map: MapLibreGlWrapper | undefined;
-    getMap: (map_id: string | undefined) => MapLibreGlWrapper;
-    setMap: (map: MapLibreGlWrapper) => void;
-    removeMap: (map_id: string | undefined) => void;
-    registerMap: (map_id: string | undefined, map: MapLibreGlWrapper) => void;
-}
-declare const MapContext: React.Context<MapContextType>;
-/**
- * MapComponentsProvider must be imported and wrapped around component where at least one of its child nodes requires access to a MapLibre-gl or openlayers instance that is registered in this mapContext.
-MapComponentsProvider must be used one level higher than the first use of MapContext.
- *
- * MapComponentsProvider requires at least one use of the MapLibreMap component somewhere down the component tree that will create the MapLibre-gl object and set the reference at MapContext.map. For MapLibre maps it is a good idea to provide a mapId attribute to the MapLibreMap Component even if you are only using a single map instance at start. It will make a later transition to using multiple instances within the same project much easier.
- */
-declare const MapComponentsProvider: ({ children }: {
-    children: ReactNode;
-}) => React.JSX.Element;
-export { MapComponentsProvider };
-export default MapContext;

package/dist/src/contexts/SimpleDataContext.d.ts

@@ -1,4 +0,0 @@
-import React from "react";
-declare const SimpleDataContext: React.Context<{}>;
-export declare const SimpleDataContextProvider: React.Provider<{}>;
-export default SimpleDataContext;

package/dist/src/contexts/SimpleDataProvider.d.ts

@@ -1,12 +0,0 @@
-import React from "react";
-export interface SimpleDataProviderProps {
-    url: string;
-    format: 'json' | 'csv' | 'xml';
-    nodeType: string;
-    data_property: string;
-    formatData?: (data: any) => any;
-    onData: () => void;
-    children: React.ReactNode;
-}
-declare const SimpleDataProvider: (props: SimpleDataProviderProps) => React.JSX.Element;
-export default SimpleDataProvider;

package/dist/src/decorators/EmptyMapDecorator.d.ts

@@ -1,4 +0,0 @@
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const decorators: Decorator[];
-export default decorators;

package/dist/src/decorators/GeoJsonMapDecorator.d.ts

@@ -1,4 +0,0 @@
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const decorators: Decorator[];
-export default decorators;

package/dist/src/decorators/LowZoomDecorator.d.ts

@@ -1,4 +0,0 @@
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const decorators: Decorator[];
-export default decorators;

package/dist/src/decorators/MapContextDecorator.d.ts

@@ -1,7 +0,0 @@
-import { MapLibreMapProps } from '../components/MapLibreMap/MapLibreMap';
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const makeMapContextDecorators: (options: MapLibreMapProps["options"]) => Decorator[];
-declare const _default: Decorator[];
-export default _default;
-export { makeMapContextDecorators };

package/dist/src/decorators/MapContextDecoratorHooks.d.ts

@@ -1,4 +0,0 @@
-import "./style.css";
-import { Decorator } from '@storybook/react-webpack5';
-declare const decorators: Decorator[];
-export default decorators;

package/dist/src/decorators/MapContextReduxStoreDecorator.d.ts

@@ -1,7 +0,0 @@
-import { MapLibreMapProps } from '../components/MapLibreMap/MapLibreMap';
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const makeMapContextDecorators: (options: MapLibreMapProps["options"]) => Decorator[];
-declare const _default: Decorator[];
-export default _default;
-export { makeMapContextDecorators };

package/dist/src/decorators/MultiMapContextDecorator.d.ts

@@ -1,4 +0,0 @@
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const decorators: Decorator[];
-export default decorators;

package/dist/src/decorators/NoNavToolsDecorator.d.ts

@@ -1,4 +0,0 @@
-import './style.css';
-import { Decorator } from '@storybook/react-webpack5';
-declare const decorators: Decorator[];
-export default decorators;

package/dist/src/decorators/ThemeDecorator.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import './style.css';
-import { StoryContext } from '@storybook/react-webpack5';
-declare const decorators: ((Story: React.FC, context?: StoryContext) => React.ReactElement)[];
-export default decorators;

package/dist/src/hooks/useAddImage/useAddImage.d.ts

@@ -1,20 +0,0 @@
-export interface useAddImageProps {
-    /**
-     *
-     */
-    imageId: string;
-    /**
-     *
-     */
-    imagePath: string;
-}
-/**
- *
- */
-declare const useAddImage: {
-    (props: useAddImageProps): void;
-    defaultProps: {
-        mapId: undefined;
-    };
-};
-export default useAddImage;

package/dist/src/hooks/useAddProtocol/useAddProtocol.d.ts

@@ -1,23 +0,0 @@
-import { AddProtocolAction } from 'maplibre-gl';
-export interface useAddProtocolProps {
-    /**
-     * the protocol string, for example `mbtiles`
-     * In this example the handler function is called for all tile requests that start with the string `mbtiles://`
-     */
-    protocol: string;
-    /**
-     * Custom load tile function that will be called when using a source that starts with a custom url schema.
-     */
-    handler: AddProtocolAction;
-}
-/**
- * Enables the use of custom protocols (basically custom tile load functions) in the maplibre-gl-js library.
- *
- */
-declare const useAddProtocol: {
-    (props: useAddProtocolProps): {};
-    defaultProps: {
-        mapId: undefined;
-    };
-};
-export default useAddProtocol;

package/dist/src/hooks/useCameraFollowPath/useCameraFollowPath.d.ts

@@ -1,35 +0,0 @@
-interface useCameraFollowPathProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    /**
-     * Id of an existing layer in the mapLibre instance to help specify the layer order
-     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
-     */
-    insertBeforeLayer?: string;
-    pause?: boolean;
-    zoom?: number;
-    pitch?: number;
-    speed?: number;
-    kmPerStep?: number;
-    route?: any;
-    stepDuration?: number;
-    timeoutId?: number;
-}
-export type { useCameraFollowPathProps };
-/**
- * Component template
- *
- */
-declare const useCameraFollowPath: {
-    (props: useCameraFollowPathProps): {
-        play: () => void;
-        reset: () => void;
-    };
-    defaultProps: {
-        mapId: undefined;
-        zoom: number;
-    };
-};
-export default useCameraFollowPath;

package/dist/src/hooks/useExportMap/index.d.ts

@@ -1,11 +0,0 @@
-import { createExportOptions } from './lib';
-interface exportMapProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-}
-export default function useExportMap(props: exportMapProps): {
-    createExport: ((options: Omit<createExportOptions, "map"> & Partial<Pick<createExportOptions, "map">>) => Promise<import("./lib").createExportResolverParams>) | undefined;
-};
-export {};

package/dist/src/hooks/useExportMap/lib.d.ts

@@ -1,52 +0,0 @@
-import { Map } from 'maplibre-gl';
-import jsPDF from 'jspdf';
-import MapLibreGlWrapper from '../../components/MapLibreMap/lib/MapLibreGlWrapper';
-import { BBox } from 'geojson';
-interface createExportOptions {
-    map: MapLibreGlWrapper;
-    width: number;
-    height: number;
-    bbox: BBox;
-    bboxUnrotated: BBox;
-    bearing: number;
-    format: string;
-    orientation: string;
-}
-export type { createExportOptions };
-declare const createExport: (options: createExportOptions) => Promise<createExportResolverParams>;
-interface createExportResolverParams extends createExportOptions {
-    createPdf: (_options?: createJsPdfOptions) => Promise<createPdfResolverParams>;
-    createPng: (_options?: createPngOptions) => Promise<createPngResolverParams>;
-    renderMap: Map;
-    hiddenContainer: HTMLDivElement;
-}
-export type { createExportResolverParams };
-interface createJsPdfOptions extends createExportOptions {
-    renderMap: Map;
-    hiddenContainer: HTMLDivElement;
-}
-export type { createJsPdfOptions };
-interface createPdfResolverParams extends createJsPdfOptions {
-    formData: FormData;
-    pdf: jsPDF;
-    downloadPdf: (_options?: downloadPdfOptions) => Promise<downloadPdfOptions>;
-}
-interface downloadPdfOptions extends createJsPdfOptions {
-    pdf: jsPDF;
-}
-export type { createPdfResolverParams };
-interface createPngOptions extends createExportOptions {
-    renderMap: Map;
-    hiddenContainer: HTMLDivElement;
-}
-export type { createPngOptions };
-interface createPngResolverParams extends createPngOptions {
-    png: string;
-    downloadPng: (_options?: downloadPngOptions) => Promise<downloadPngOptions>;
-}
-export type { createPngResolverParams };
-interface downloadPngOptions extends createPngOptions {
-    png: string;
-    name?: string;
-}
-export { createExport };

package/dist/src/hooks/useFeatureEditor/useFeatureEditor.d.ts

@@ -1,46 +0,0 @@
-import '@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css';
-import MapboxDraw from '@mapbox/mapbox-gl-draw';
-import { Feature } from 'geojson';
-export interface useFeatureEditorProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    /**
-     * Id of an existing layer in the mapLibre instance to help specify the layer order
-     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
-     */
-    insertBeforeLayer?: string;
-    /**
-     * Input GeoJson data at initialization
-     */
-    geojson?: Feature;
-    /**
-     * Callback function that is called each time the GeoJson data has changed within MlFeatureEditor.
-     * First parameter is the new GeoJson feature.
-     */
-    onChange?: (para: Feature[]) => void;
-    /**
-     * Callback function that is called each time the GeoJson data within has been finished within MlFeatureEditor.
-     * First parameter is the new GeoJson feature.
-     */
-    onFinish?: () => void;
-    /**
-     * Feature editor modes:
-     * - draw_line_string
-     * - draw_polygon
-     * - draw_point
-     * - simple_select
-     * - direct_select
-     */
-    mode?: keyof MapboxDraw.Modes;
-}
-/**
- * GeoJson Feature editor that allows to create or manipulate GeoJson data
- */
-declare const useFeatureEditor: (props: useFeatureEditorProps) => {
-    feature: Feature<import("geojson").Geometry, import("geojson").GeoJsonProperties>[] | undefined;
-    drawToolsReady: boolean;
-    draw: MapboxDraw | null;
-};
-export default useFeatureEditor;

package/dist/src/hooks/useFeatureEditor/utils/FeatureEditorStyle.d.ts

@@ -1,116 +0,0 @@
-declare function featureEditorStyle(): ({
-    id: string;
-    type: string;
-    filter: (string | string[])[];
-    paint: {
-        'fill-color': string;
-        'fill-outline-color': string;
-        'fill-opacity': number;
-        'line-color'?: undefined;
-        'line-width'?: undefined;
-        'line-dasharray'?: undefined;
-        'circle-radius'?: undefined;
-        'circle-color'?: undefined;
-        'circle-stroke-color'?: undefined;
-        'circle-stroke-width'?: undefined;
-        'circle-opacity'?: undefined;
-    };
-    layout?: undefined;
-} | {
-    id: string;
-    type: string;
-    filter: (string | string[])[];
-    layout: {
-        'line-cap': string;
-        'line-join': string;
-    };
-    paint: {
-        'line-color': string;
-        'line-width': number;
-        'fill-color'?: undefined;
-        'fill-outline-color'?: undefined;
-        'fill-opacity'?: undefined;
-        'line-dasharray'?: undefined;
-        'circle-radius'?: undefined;
-        'circle-color'?: undefined;
-        'circle-stroke-color'?: undefined;
-        'circle-stroke-width'?: undefined;
-        'circle-opacity'?: undefined;
-    };
-} | {
-    id: string;
-    type: string;
-    filter: (string | string[])[];
-    layout: {
-        'line-cap': string;
-        'line-join': string;
-    };
-    paint: {
-        'line-color': string;
-        'line-dasharray': number[];
-        'line-width': number;
-        'fill-color'?: undefined;
-        'fill-outline-color'?: undefined;
-        'fill-opacity'?: undefined;
-        'circle-radius'?: undefined;
-        'circle-color'?: undefined;
-        'circle-stroke-color'?: undefined;
-        'circle-stroke-width'?: undefined;
-        'circle-opacity'?: undefined;
-    };
-} | {
-    id: string;
-    type: string;
-    filter: (string | string[])[];
-    paint: {
-        'circle-radius': number;
-        'circle-color': string;
-        'circle-stroke-color': string;
-        'circle-stroke-width': number;
-        'fill-color'?: undefined;
-        'fill-outline-color'?: undefined;
-        'fill-opacity'?: undefined;
-        'line-color'?: undefined;
-        'line-width'?: undefined;
-        'line-dasharray'?: undefined;
-        'circle-opacity'?: undefined;
-    };
-    layout?: undefined;
-} | {
-    id: string;
-    type: string;
-    filter: (string | string[])[];
-    paint: {
-        'circle-radius': number;
-        'circle-color': string;
-        'fill-color'?: undefined;
-        'fill-outline-color'?: undefined;
-        'fill-opacity'?: undefined;
-        'line-color'?: undefined;
-        'line-width'?: undefined;
-        'line-dasharray'?: undefined;
-        'circle-stroke-color'?: undefined;
-        'circle-stroke-width'?: undefined;
-        'circle-opacity'?: undefined;
-    };
-    layout?: undefined;
-} | {
-    id: string;
-    type: string;
-    filter: (string | string[])[];
-    paint: {
-        'circle-radius': number;
-        'circle-opacity': number;
-        'circle-color': string;
-        'fill-color'?: undefined;
-        'fill-outline-color'?: undefined;
-        'fill-opacity'?: undefined;
-        'line-color'?: undefined;
-        'line-width'?: undefined;
-        'line-dasharray'?: undefined;
-        'circle-stroke-color'?: undefined;
-        'circle-stroke-width'?: undefined;
-    };
-    layout?: undefined;
-})[];
-export default featureEditorStyle;

package/dist/src/hooks/useFitLayerBounds.d.ts

@@ -1,8 +0,0 @@
-import { FitBoundsOptions } from 'maplibre-gl';
-export interface useFitLayerBoundsPros {
-    layerId: string;
-    type: "geojson" | "wms" | "vt";
-    fitBoundsOptions?: FitBoundsOptions;
-}
-declare function useFitLayerBounds(props: useFitLayerBoundsPros): void;
-export default useFitLayerBounds;

package/dist/src/hooks/useGpx/useGpx.d.ts

@@ -1,26 +0,0 @@
-import { FeatureCollection } from 'geojson';
-export interface useGpxProps {
-    /**
-     * a string containing GPX data that is supposed to be parsed and converted to GeoJSON by this hook
-     */
-    data?: string;
-}
-export interface MetadataType {
-    title: string;
-    value: string;
-    id: number;
-}
-/**
- * useGpx hook converts GPX data to GeoJSON
- *
- */
-declare const useGpx: {
-    (props: useGpxProps): {
-        geojson: FeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined;
-        metadata: MetadataType[];
-    };
-    defaultProps: {
-        data: undefined;
-    };
-};
-export default useGpx;