@mapcomponents/react-maplibre 0.1.96 → 1.0.1

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

@@ -1,125 +1,125 @@
-/// <reference types="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?: 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): 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;
+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?: 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/components/MlWmsLoader/utils/MlWmsLoaderInstructions.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
-export default function MlWmsLoaderInstructions(props: {
-    open: boolean;
-}): JSX.Element;
+import React from 'react';
+export default function MlWmsLoaderInstructions(props: {
+    open: boolean;
+}): React.JSX.Element;

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

@@ -1,8 +1,8 @@
-/// <reference types="react" />
-export interface wmsLinksProps {
-    load: (str: string) => void;
-    open: boolean;
-    close: () => void;
-    openWMSLoader: (boolean: boolean) => void;
-}
-export default function WMSLinks(props: wmsLinksProps): JSX.Element;
+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/contexts/LayerContext.d.ts

@@ -1,59 +1,59 @@
-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): JSX.Element;
-export default LayerContext;
-export { LayerContextProvider };
+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/contexts/MapContext.d.ts

@@ -1,24 +1,24 @@
-import React, { ReactNode } from 'react';
-import MapLibreGlWrapper from '../components/MapLibreMap/lib/MapLibreGlWrapper';
-export interface MapContextType {
-    mapIds: string[];
-    mapExists: (map_id: string | undefined) => boolean;
-    maps: 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;
-}) => JSX.Element;
-export { MapComponentsProvider };
-export default MapContext;
+import React, { ReactNode } from 'react';
+import MapLibreGlWrapper from '../components/MapLibreMap/lib/MapLibreGlWrapper';
+export interface MapContextType {
+    mapIds: string[];
+    mapExists: (map_id: string | undefined) => boolean;
+    maps: 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/contexts/SimpleDataContext.d.ts

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

package/dist/contexts/SimpleDataProvider.d.ts

@@ -1,8 +1,18 @@
-export default SimpleDataProvider;
-declare function SimpleDataProvider(props: any): JSX.Element;
-declare namespace SimpleDataProvider {
-    namespace propTypes {
-        const children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
-    }
-}
-import PropTypes from "prop-types";
+import React from "react";
+import PropTypes from "prop-types";
+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;
+    propTypes: {
+        children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
+    };
+};
+export default SimpleDataProvider;

package/dist/decorators/EmptyMapDecorator.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import './style.css';
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/GeoJsonMapDecorator.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import './style.css';
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/LowZoomDecorator.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import './style.css';
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/MapContextDecorator.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import './style.css';
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/MapContextDecoratorHooks.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import "./style.css";
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/MultiMapContextDecorator.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import './style.css';
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/NoNavToolsDecorator.d.ts

@@ -1,2 +1,4 @@
-export default decorators;
-declare const decorators: ((Story: any, context: any) => JSX.Element)[];
+import './style.css';
+import { Decorator } from '@storybook/react';
+declare const decorators: Decorator[];
+export default decorators;

package/dist/decorators/ThemeDecorator.d.ts

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

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

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

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

@@ -1,23 +1,23 @@
-import { Cancelable, RequestParameters, ResponseCallback } 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: (requestParameters: RequestParameters, callback: ResponseCallback<any>) => Cancelable;
-}
-/**
- * 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;
+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;