@carto/ps-react-maps 1.3.4 → 1.4.0

package/dist/types/assets/icons/ruler.d.ts

@@ -0,0 +1,2 @@
+import { SVGProps } from 'react';
+export declare function RulerIcon(props: SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;

package/dist/types/common-stories/maps/deckgl-maps.component.d.ts

@@ -0,0 +1,2 @@
+import { DeckGLMapsProps } from '@/map-provider';
+export declare function DeckGLMapsComponent({ basemap, instanceRef, layers, overlayRef, viewState, height, id, initialViewState, style, width, getCursor, getTooltip, onClick, onDrag, onDragEnd, onDragStart, onHover, onResize, onViewStateChange, ...rest }: DeckGLMapsProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/common-stories/maps/google-maps.component.d.ts

@@ -0,0 +1,3 @@
+import { GoogleMapsProps } from '@/map-provider';
+export declare function GoogleMapsComponent(props: GoogleMapsProps): import("react/jsx-runtime").JSX.Element;
+export declare function GoogleMap({ apiKey, basemap, instanceRef, layers, overlayRef, initialViewState, viewState, controller, height, id, language, mapId, mapOptions, style, version, width, getTooltip, onResize, onViewStateChange, ...rest }: GoogleMapsProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/common-stories/maps/map-container.component.d.ts

@@ -0,0 +1,4 @@
+import { MapsProps } from '@/map-provider';
+type MapContainerProps = Pick<MapsProps, 'id' | 'controller' | 'layers'>;
+export declare function MapContainer({ id, layers, controller, }: MapContainerProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/common-stories/maps/map.component.d.ts

@@ -0,0 +1,2 @@
+import { MapsProps } from '@/map-provider';
+export declare function MapComponent(props: MapsProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './map-provider';
+export * from './map-measurement-tool';
 export * from './utils';

package/dist/types/map-measurement-tool/custom-editable-geojson-layer.class.d.ts

@@ -0,0 +1,10 @@
+import { EditableGeoJsonLayer } from '@nebula.gl/layers';
+import { EventManager } from 'mjolnir.js';
+import { CustomEditableLayerProps } from './map-measurement-tool.types';
+export declare class CustomEditableGeojsonLayer extends EditableGeoJsonLayer {
+    eventManager: EventManager;
+    constructor(props: CustomEditableLayerProps);
+    _addEventHandlers(): void;
+    _removeEventHandlers(_eventManager?: undefined): void;
+    _getEventManager(): EventManager;
+}

package/dist/types/map-measurement-tool/custom-measurement-distance-mode.class.d.ts

@@ -0,0 +1,6 @@
+import { FeatureCollection, MeasureDistanceMode, ModeProps } from '@nebula.gl/edit-modes';
+import { BasePointerEvent } from '@nebula.gl/edit-modes/dist-types/types';
+export declare class CustomMeasureDistanceMode extends MeasureDistanceMode {
+    handleClick(event: BasePointerEvent, props: ModeProps<FeatureCollection>): void;
+    handleKeyUp(event: KeyboardEvent, props: ModeProps<FeatureCollection>): void;
+}

package/dist/types/map-measurement-tool/index.d.ts

@@ -0,0 +1,9 @@
+export { CustomEditableGeojsonLayer } from './custom-editable-geojson-layer.class';
+export { CustomMeasureDistanceMode } from './custom-measurement-distance-mode.class';
+export * from './map-measurement-tool.const';
+export { MapMeasurementToolsLayer } from './map-measurement-tool.layer';
+export { MapMeasurementTools } from './map-measurement-tool.component';
+export { MapMeasurementToolsProvider } from './map-measurement-tool.provider';
+export { convertMetersTo, getTextLayerFormattedDistance, } from './map-measurement-tool.util';
+export { useMapMeasurementTools, useMapMeasurementToolsActions, } from './map-measurement-tool.hook';
+export * from './map-measurement-tool.types';

package/dist/types/map-measurement-tool/map-measurement-tool.component.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { MapMeasureToolChildrenProps } from './map-measurement-tool.types';
+export type MapMeasureToolProps = {
+    children: React.FC<MapMeasureToolChildrenProps>;
+};
+export declare function MapMeasurementTools({ children }: MapMeasureToolProps): import("react").ReactNode;

package/dist/types/map-measurement-tool/map-measurement-tool.const.d.ts

@@ -0,0 +1,43 @@
+import { MapMeasurementUnit } from './map-measurement-tool.types';
+import { LengthUnits } from 'convert-units/definitions/length';
+export declare const EVENT_MANAGER_EVENT_TYPES: string[];
+export declare const MAP_MEASURE_LAYER_ID = "mapMeasureLayer";
+export declare const DEFAULT_LAYER_PROPS: {
+    id: string;
+    pickable: boolean;
+    billboard: boolean;
+    editHandlePointRadiusUnits: string;
+    editHandlePointRadiusMinPixels: number;
+    editHandlePointRadiusMaxPixels: number;
+    lineWidthMinPixels: number;
+    editHandlePointStrokeWidth: number;
+    getEditHandlePointRadius: number;
+    _subLayerProps: {
+        tooltips: {
+            fontFamily: string;
+            fontWeight: string;
+            getSize: number;
+            lineHeight: number;
+            getPixelOffset: number[];
+            getTextAnchor: string;
+            getAlignmentBaseline: string;
+            updateTriggers: {};
+        };
+        guides: {
+            getLineWidth: number;
+        };
+    };
+};
+export declare const DEFAULT_COLORS: Record<string, [number, number, number, number]>;
+export declare const DEFAULT_PROPS: {
+    locale: string;
+    getColumnName: string;
+    styles: {
+        colors: {
+            editing: [number, number, number, number];
+            finished: [number, number, number, number];
+        };
+    };
+};
+export declare const CONVERSIONS_UNITS: Record<MapMeasurementUnit, LengthUnits>;
+export declare const INTL_UNITS: Record<MapMeasurementUnit, string>;

package/dist/types/map-measurement-tool/map-measurement-tool.context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { type MapMeasurementToolsContextInterface } from './map-measurement-tool.types';
+export declare const INITIAL_STATE: MapMeasurementToolsContextInterface;
+export declare const MapMeasurementToolsContext: import("react").Context<import("./map-measurement-tool.types").MapMeasurementToolsState>;
+export declare const MapMeasurementToolsActionsContext: import("react").Context<import("./map-measurement-tool.types").MeasurementToolsActionsState>;

package/dist/types/map-measurement-tool/map-measurement-tool.hook.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns the state of the map measurement tools.
+ * @returns The state of the map measurement tools.
+ */
+export declare function useMapMeasurementTools(): import("./map-measurement-tool.types").MapMeasurementToolsState;
+/**
+ * Returns the actions of the map measurement tools.
+ * @returns The actions of the map measurement tools.
+ */
+export declare function useMapMeasurementToolsActions(): import("./map-measurement-tool.types").MeasurementToolsActionsState;

package/dist/types/map-measurement-tool/map-measurement-tool.layer.d.ts

@@ -0,0 +1,10 @@
+import { Layer } from '@deck.gl/core/typed';
+import { type MapMeasurementToolsLayerProps } from './map-measurement-tool.types';
+/**
+ * Renders the map measurement tools layer.
+ * @param {MapMeasurementToolsLayerProps['mapId']} props.mapId - The ID of the map.
+ * @param {MapMeasurementToolsLayerProps['defaultProps']} props.defaultProps - The default props for the layer.
+ * @param {MapMeasurementToolsLayerProps['layerProps']} props.layerProps - The layer props.
+ * @returns The rendered map measurement tools layer.
+ */
+export declare function MapMeasurementToolsLayer({ mapId, defaultProps: { getColumnName, styles }, layerProps, }: MapMeasurementToolsLayerProps): Layer<never> | null;

package/dist/types/map-measurement-tool/map-measurement-tool.provider.d.ts

@@ -0,0 +1,8 @@
+import type { MapMeasurementToolsProviderProps } from './map-measurement-tool.types';
+/**
+ * Provides the context and actions for the map measurement tools.
+ *
+ * @param {MapMeasurementToolsProviderProps} props - The component props.
+ * @returns {JSX.Element} The map measurement tools provider component.
+ */
+export declare function MapMeasurementToolsProvider({ children, defaultProps, locale, }: MapMeasurementToolsProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/map-measurement-tool/map-measurement-tool.reducer.d.ts

@@ -0,0 +1,14 @@
+import type { MapMeasurementToolsState } from './map-measurement-tool.types';
+export declare enum Actions {
+    SetEnable = "SET_ENABLE",
+    SetFinished = "SET_FINISHED",
+    SetDistance = "SET_DISTANCE",
+    SetUnit = "SET_UNIT",
+    SetLocale = "SET_LOCALE"
+}
+type Action = {
+    type: Actions;
+    payload: MapMeasurementToolsState[keyof MapMeasurementToolsState];
+};
+export declare function reducer(state: MapMeasurementToolsState, { type, payload }: Action): MapMeasurementToolsState;
+export {};

package/dist/types/map-measurement-tool/map-measurement-tool.styles.d.ts

@@ -0,0 +1,28 @@
+import { Theme } from '@mui/material';
+export declare const styles: {
+    container: {
+        display: "flex";
+        alignItems: "center";
+        gap: ({ spacing }: Theme) => string;
+    };
+    chip: {
+        color: (theme: Theme) => string;
+        boxShadow: ({ shadows }: Theme) => string;
+        '& .MuiChip-deleteIcon': {
+            color: (theme: Theme) => string;
+            '&:hover': {
+                color: (theme: Theme) => string;
+            };
+        };
+    };
+    trigger: {
+        background: ({ palette }: Theme) => string;
+        '&:hover': {
+            background: ({ palette }: Theme) => string;
+        };
+        '&:disabled': {
+            opacity: number;
+            cursor: "default";
+        };
+    };
+};

package/dist/types/map-measurement-tool/map-measurement-tool.types.d.ts

@@ -0,0 +1,88 @@
+import type { EditableGeojsonLayerProps } from '@nebula.gl/layers/dist-types/layers/editable-geojson-layer';
+import type { EventManager } from 'mjolnir.js';
+import type { ReactNode } from 'react';
+import { Tooltip } from '@/map-provider';
+export declare enum MapMeasurementUnit {
+    milimeter = "milimeter",
+    centimeter = "centimeter",
+    meter = "meter",
+    kilometer = "kilometer",
+    mile = "mile",
+    feet = "feet"
+}
+export declare enum MapMeasurementUnitTurf {
+    meters = "meters",
+    kilometer = "kilometers",
+    mile = "miles"
+}
+export declare const enum EditType {
+    AddPosition = "addPosition",
+    Finish = "finish"
+}
+export type MapMeasurementToolsProviderProps = {
+    children: ReactNode;
+    defaultProps?: Omit<Partial<MapMeasurementToolsState>, MapMeasurementToolsState['locale']>;
+    locale?: MapMeasurementToolsState['locale'];
+};
+export type MapMeasurementToolsState = {
+    enable: boolean;
+    finished: boolean;
+    distance: number;
+    unit: MapMeasurementUnit;
+    locale: string;
+};
+export type MeasurementToolsActionsState = {
+    setEnable: (data: MapMeasurementToolsState['enable']) => void;
+    setFinished: (data: MapMeasurementToolsState['finished']) => void;
+    setDistance: (data: MapMeasurementToolsState['distance']) => void;
+    setUnit: (data: MapMeasurementToolsState['unit']) => void;
+    setLocale: (data: MapMeasurementToolsState['locale']) => void;
+};
+export type MapMeasurementToolsContextInterface = {
+    state: MapMeasurementToolsState;
+    actions: MeasurementToolsActionsState;
+};
+export type CustomEditableLayerProps<D = unknown> = EditableGeojsonLayerProps<D> & {
+    eventManager: EventManager;
+    selectedFeatures: any[];
+    onChangeFeatures: (features: D[]) => void;
+};
+export type CustomEditableLayerHoverProps = {
+    distance: number;
+    unit: string;
+    locale: string;
+};
+export type MapMeasureToolChildrenProps = {
+    enable: boolean;
+    unit: MapMeasurementUnit;
+    text: string;
+    meters: number;
+    distance: number;
+    tooltip?: string;
+    onToggleButton: () => void;
+};
+export type MapMeasurementToolsLayerHoverProps = (info: Tooltip, args: CustomEditableLayerHoverProps) => void;
+export type MapMeasurementToolsLayerEditProps = {
+    editType: string;
+    editContext: {
+        distance: number;
+        finished: boolean;
+    };
+};
+export type DefaultMeasureToolProps = {
+    getColumnName: string;
+    styles?: {
+        colors?: {
+            editing?: [number, number, number, number];
+            finished?: [number, number, number, number];
+        };
+    };
+};
+export type MapMeasurementToolsLayerLayerProps = Partial<CustomEditableLayerProps & {
+    onHover?: MapMeasurementToolsLayerHoverProps;
+}>;
+export type MapMeasurementToolsLayerProps = {
+    mapId: string;
+    defaultProps?: DefaultMeasureToolProps;
+    layerProps?: MapMeasurementToolsLayerLayerProps;
+};

package/dist/types/map-measurement-tool/map-measurement-tool.util.d.ts

@@ -0,0 +1,7 @@
+import { MapMeasurementUnit } from './map-measurement-tool.types';
+export declare function convertMetersTo(distance: number, unit: MapMeasurementUnit): number;
+export declare function getTextLayerFormattedDistance({ meters, unit, locale, }: {
+    meters: number;
+    unit: MapMeasurementUnit;
+    locale: string;
+}): string;

package/dist/types/map-provider/map-provider.context.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import type { MapContextInterface } from './map-provider.types';
 export declare const INITIAL_STATE: MapContextInterface;
 export declare const MapContext: import("react").Context<import("./map-provider.types").MapState>;

package/dist/types/utils/get-map-type/get-map-type.d.ts

@@ -0,0 +1 @@
+export declare function getMapType(basemap: string): import("@/map-provider").MapsTypes;

package/dist/types/utils/get-map-type/index.d.ts

@@ -0,0 +1,2 @@
+export * from './get-map-type';
+export * from './is-gmaps';

package/dist/types/utils/get-map-type/is-gmaps.d.ts

@@ -0,0 +1 @@
+export declare function isGmaps(basemap: string): boolean;

package/dist/types/utils/index.d.ts

@@ -1 +1,2 @@
 export * from './object-to-html';
+export * from './get-map-type';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carto/ps-react-maps",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "CARTO's Professional Service React Maps library",
   "files": [
     "dist"
@@ -28,18 +28,27 @@
     "storybook:start": "storybook dev --no-open -p 6006",
     "storybook:build": "storybook build"
   },
-  "dependencies": {},
+  "dependencies": {
+    "convert-units": "3.0.0-beta.6",
+    "@nebula.gl/edit-modes": "1.0.4",
+    "@nebula.gl/layers": "1.0.4",
+    "mjolnir.js": "2.7.1"
+  },
   "devDependencies": {
-    "@carto/react-basemaps": "2.3.10",
-    "@deck.gl/core": "8.9.34",
-    "@deck.gl/google-maps": "8.9.34",
-    "@deck.gl/react": "8.9.34",
+    "@carto/react-basemaps": "2.3.13",
+    "@deck.gl/core": "8.9.35",
+    "@deck.gl/google-maps": "8.9.35",
+    "@deck.gl/react": "8.9.35",
     "@react-google-maps/api": "2.19.3",
-    "@types/google.maps": "3.55.3",
+    "@types/google.maps": "3.55.4",
     "maplibre-gl": "3.6.2",
     "react-map-gl": "7.1.7"
   },
   "peerDependencies": {
+    "@nebula.gl/edit-modes": "1.x",
+    "@nebula.gl/layers": "1.x",
+    "convert-units": "3.x",
+    "mjolnir.js": "2.x",
     "react": "17.x || 18.x",
     "react-dom": "17.x || 18.x"
   }