@mapcomponents/react-maplibre 0.1.56 → 0.1.58

package/dist/components/MlCreatePdfForm/MlCreatePdfForm.stories.d.ts

@@ -0,0 +1,13 @@
+declare const storyoptions: {
+    title: string;
+    component: {
+        (props: import("./MlCreatePdfForm").MlCreatePdfFormProps): JSX.Element;
+        defaultProps: {
+            mapId: undefined;
+        };
+    };
+    argTypes: {};
+    decorators: ((Story: any) => JSX.Element)[];
+};
+export default storyoptions;
+export declare const ExampleConfig: any;

package/dist/components/MlCreatePdfForm/lib/PdfContext.d.ts

@@ -0,0 +1,21 @@
+import React, { MutableRefObject } from 'react';
+import { Feature } from '@turf/turf';
+interface PdfContextInterface {
+    format: string;
+    setFormat: (format: string) => void;
+    quality: string;
+    setQuality: (quality: string) => void;
+    orientation: string;
+    setOrientation: (orientation: string) => void;
+    geojsonRef: MutableRefObject<Feature | undefined>;
+    template: {
+        width: number;
+        height: number;
+    };
+}
+declare const PdfContext: React.Context<Partial<PdfContextInterface>>;
+declare const PdfContextProvider: ({ children }: {
+    children: React.ReactNode;
+}) => JSX.Element;
+export { PdfContextProvider };
+export default PdfContext;

package/dist/components/MlCreatePdfForm/lib/PdfForm.d.ts

@@ -0,0 +1,10 @@
+import { createPdfResolverParams } from '../../../hooks/exportMap/lib';
+interface PdfFormProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    onCreatePdf?: (options: createPdfResolverParams) => createPdfResolverParams;
+}
+export default function PdfForm(props: PdfFormProps): JSX.Element;
+export {};

package/dist/components/MlCreatePdfForm/lib/PdfPreview.d.ts

@@ -0,0 +1,13 @@
+interface PdfPreviewProps {
+    /**
+     * 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;
+}
+export default function PdfPreview(props: PdfPreviewProps): JSX.Element;
+export {};

package/dist/components/MlCreatePdfForm/lib/pdf.templates.d.ts

@@ -0,0 +1,11 @@
+interface PdfTemplateType {
+    width: number;
+    height: number;
+}
+interface PdfTemplateObject {
+    [key: string]: ({
+        [key: string]: PdfTemplateType;
+    });
+}
+declare const PdfTemplates: PdfTemplateObject;
+export default PdfTemplates;

package/dist/components/MlFeatureEditor/lib/create_vertex.d.ts

@@ -6,7 +6,7 @@ export default create_vertex;
  * @param {string} parentId
  * @param {Array<number>} coordinates
  * @param {string} path - Dot-separated numbers indicating exactly
- *   where the point exists within its parent feature's coordinates.
+ *	 where the point exists within its parent feature's coordinates.
  * @param {boolean} selected
  * @return {GeoJSON} Point
  */

package/dist/components/MlGeojsonLayerWithSource/MlGeojsonLayerWithSource.d.ts

@@ -0,0 +1,22 @@
+interface MlGeojsonLayerWithSourceProps {
+    /**
+     * 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;
+}
+/**
+ * MlGeojsonLayerWithSource
+ *
+ */
+declare const MlGeojsonLayerWithSource: {
+    (props: MlGeojsonLayerWithSourceProps): JSX.Element;
+    defaultProps: {
+        mapId: string;
+    };
+};
+export default MlGeojsonLayerWithSource;

package/dist/components/MlGeojsonLayerWithSource/MlGeojsonLayerWithSource.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlGeojsonLayerWithSource as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlGeojsonLayerWithSource from "./MlGeojsonLayerWithSource";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlLayerSwipe/MlLayerSwipe.d.ts

@@ -10,7 +10,7 @@ interface MlLayerSwipeProps {
     map2Id: string;
 }
 /**
- *  creates a split view of 2 synchronised maplibre instances
+ *	creates a split view of 2 synchronised maplibre instances
  */
 declare const MlLayerSwipe: (props: MlLayerSwipeProps) => JSX.Element;
 export default MlLayerSwipe;

package/dist/components/MlWmsLayer/MlWmsLayer.d.ts

@@ -16,13 +16,13 @@ interface MlWmsLayerProps {
  * @param {object} props
  * @param {object} props.urlParameters URL query parameters that will be added to the WMS URL. A layers property (string) is mandatory. Any value defined on this attribute will extend the default object
  * @param {string} props.url WMS URL
- * @param {bool}   props.visible Sets layer "visibility" property to "visible" if true or "none" if false
+ * @param {bool}	 props.visible Sets layer "visibility" property to "visible" if true or "none" if false
  * @param {string} props.attribution MapLibre attribution shown in the bottom right of the map, if this layer is visible
  * @param {string} props.mapId Id of the target MapLibre instance in mapContext
  * @param {object} props.sourceOptions Object that is passed to the MapLibre.addSource call as config option parameter
  * @param {object} props.layerOptions Object that is passed to the MapLibre.addLayer call as config option parameter
  * @param {string} props.insertBeforeLayer 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
+                                                                                     This layer will be visually beneath the layer with the "insertBeforeLayer" id
  *
  * @component
  */

package/dist/decorators/MapContextDecoratorHooks.d.ts

@@ -0,0 +1,2 @@
+export default decorators;
+declare const decorators: ((Story: any) => JSX.Element)[];

package/dist/decorators/ThemeWrapper.d.ts

@@ -0,0 +1 @@
+export default function ThemeWrapper(props: any): JSX.Element;

package/dist/hooks/exportMap/index.d.ts

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

package/dist/hooks/exportMap/lib.d.ts

@@ -0,0 +1,36 @@
+import { Map } from 'maplibre-gl';
+import jsPDF from 'jspdf';
+import MapLibreGlWrapper from '../../components/MapLibreMap/lib/MapLibreGlWrapper';
+import { BBox } from '@turf/turf';
+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>;
+    renderMap: Map;
+    hiddenContainer: HTMLDivElement;
+}
+export type { createExportResolverParams };
+interface createJsPdfOptions extends createExportOptions {
+    renderMap: Map;
+    hiddenContainer: HTMLDivElement;
+}
+export type { createJsPdfOptions };
+interface createPdfResolverParams extends createJsPdfOptions {
+    pdf: jsPDF;
+    downloadPdf: (_options?: downloadPdfOptions) => Promise<downloadPdfOptions>;
+}
+export type { createPdfResolverParams };
+interface downloadPdfOptions extends createJsPdfOptions {
+    pdf: jsPDF;
+}
+export { createExport };

package/dist/hooks/useLayer.d.ts

@@ -1,8 +1,8 @@
-import { useMapType } from "./useMap";
-import { LayerSpecification } from "maplibre-gl";
-import MapLibreGlWrapper from "../components/MapLibreMap/lib/MapLibreGlWrapper";
-import { MapLayerMouseEvent } from "maplibre-gl";
-import { GeoJSONObject } from "@turf/turf";
+import { useMapType } from './useMap';
+import { SourceSpecification, LayerSpecification } from 'maplibre-gl';
+import MapLibreGlWrapper from '../components/MapLibreMap/lib/MapLibreGlWrapper';
+import { MapLayerMouseEvent } from 'maplibre-gl';
+import { GeoJSONObject } from '@turf/turf';
 declare type useLayerType = {
     map: MapLibreGlWrapper | undefined;
     layer: LayerSpecification;
@@ -17,6 +17,7 @@ interface useLayerProps {
     insertBeforeLayer?: string;
     insertBeforeFirstSymbolLayer?: boolean;
     geojson?: GeoJSONObject;
+    source?: SourceSpecification | string;
     options: Partial<LayerSpecification>;
     onHover?: MapLayerMouseEvent;
     onClick?: MapLayerMouseEvent;

package/dist/hooks/useLayerEvent.d.ts

@@ -0,0 +1,2 @@
+export default useLayerEvent;
+declare function useLayerEvent(props: any): {};

package/dist/hooks/useMap.d.ts

@@ -4,7 +4,7 @@ declare type useMapType = {
     mapIsReady: boolean;
     componentId: string;
     layers: (LayerState | undefined)[];
-    cleanup: Function;
+    cleanup: () => void;
 };
 declare function useMap(props: {
     mapId?: string;

package/dist/hooks/useMapState.stories.d.ts

@@ -8,7 +8,7 @@ declare namespace storyoptions {
     export const title: string;
     export { useMapState as component };
     export const argTypes: {};
-    export { mapContextDecorator as decorators };
+    export { mapContextDecoratorHooks as decorators };
 }
 import useMapState from "./useMapState";
-import mapContextDecorator from "../decorators/MapContextDecorator";
+import mapContextDecoratorHooks from "../decorators/MapContextDecoratorHooks";

package/dist/hooks/useSource.d.ts

@@ -0,0 +1,17 @@
+import { useMapType } from "./useMap";
+import MapLibreGlWrapper from "../components/MapLibreMap/lib/MapLibreGlWrapper";
+import { SourceSpecification } from "maplibre-gl";
+declare type useSourceType = {
+    map: MapLibreGlWrapper | undefined;
+    source: SourceSpecification;
+    componentId: string;
+    mapHook: useMapType;
+};
+interface useSourceProps {
+    mapId?: string;
+    idPrefix?: string;
+    source: SourceSpecification;
+    sourceId: string;
+}
+declare function useSource(props: useSourceProps): useSourceType;
+export default useSource;

package/dist/hooks/useSources.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const useGeojsonSourceExample: any;
+export const useVectorSourceExample: any;
+export const useRasterSourceExample: any;
+export const removeSourceExample: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { useSource as component };
+    export const argTypes: {};
+    export { mapContextDecoratorHooks as decorators };
+}
+import useSource from "./useSource";
+import mapContextDecoratorHooks from "../decorators/MapContextDecoratorHooks";

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { default as MapLibreMap } from "./components/MapLibreMap/MapLibreMap";
 export { default as MlComponentTemplate } from "./components/MlComponentTemplate/MlComponentTemplate";
 export { default as MlCreatePdfButton } from "./components/MlCreatePdfButton/MlCreatePdfButton";
+export { default as MlCreatePdfForm } from "./components/MlCreatePdfButton/MlCreatePdfButton";
 export { default as MlFeatureEditor } from "./components/MlFeatureEditor/MlFeatureEditor";
 export { default as MlFillExtrusionLayer } from "./components/MlFillExtrusionLayer/MlFillExtrusionLayer";
 export { default as MlFollowGps } from "./components/MlFollowGps/MlFollowGps";
@@ -12,6 +13,7 @@ export { default as MlNavigationCompass } from "./components/MlNavigationCompass
 export { default as MlLayer } from "./components/MlLayer/MlLayer";
 export { default as MlVectorTileLayer } from "./components/MlVectorTileLayer/MlVectorTileLayer";
 export { default as MlWmsLayer } from "./components/MlWmsLayer/MlWmsLayer";
+export { default as MlScaleReference } from "./components/MlScaleReference/MlScaleReference";
 export { default as MlLayerMagnify } from "./components/MlLayerMagnify/MlLayerMagnify";
 export { default as MlLayerSwipe } from "./components/MlLayerSwipe/MlLayerSwipe";
 export { default as MlTransitionGeoJsonLayer } from "./components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer";
@@ -26,6 +28,8 @@ export { default as useLayer } from "./hooks/useLayer";
 export { default as useMapState } from "./hooks/useMapState";
 export { default as useMap } from "./hooks/useMap";
 export { default as useWms } from "./hooks/useWms.js";
+export { default as useSource } from "./hooks/useSource";
+export { default as useExportMap } from "./hooks/exportMap";
 export { MapComponentsProvider } from "./contexts/MapContext";
 export { default as MapContext } from "./contexts/MapContext";
 export { default as SimpleDataProvider } from "./contexts/SimpleDataProvider";