@carto/ps-react-maps 2.1.0 → 3.0.0-canary.0

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

@@ -1,87 +0,0 @@
-import type { DeckGLMapsProps, MapProviderMapProps, MapReferences, MapResize, MapViewState, OverlayMapRef, ViewportRect } from './map-provider.types';
-import type { Deck, WebMercatorViewport } from '@deck.gl/core';
-/**
- * Custom hook that retrieves the map configuration for a given ID.
- * @param id - The ID of the map.
- * @returns The map configuration for the specified ID.
- */
-export declare function useMap(id: string): MapProviderMapProps;
-/**
- * Custom hook that provides access to the map references and related functions.
- *
- * @param id - The ID of the map reference.
- * @returns An object containing the map references and functions.
- */
-export declare function useMapReferences(id: string): MapReferences & {
-    getDeckInstance: () => Deck | undefined;
-    getOverlayInstance: () => OverlayMapRef | undefined;
-    getViewState: () => DeckGLMapsProps['viewState'];
-    getViewports: (rect?: ViewportRect) => WebMercatorViewport[];
-    getViewport: (index?: number, rect?: ViewportRect) => WebMercatorViewport;
-};
-/**
- * Custom hook that provides map actions for a specific map ID.
- * @param id - The ID of the map.
- * @returns An object containing map actions.
- */
-export declare function useMapActions(id: string): {
-    setBasemap: (basemap: any) => void;
-    setResize: (props: MapResize) => void;
-    setViewState: (viewState: MapViewState) => void;
-    setZoom: (zoom: number) => void;
-    setLoaded: (loaded: boolean) => void;
-    fitBounds: (bounds: Parameters<WebMercatorViewport['fitBounds']>[0], { boundsOptions, viewStateOptions, }?: {
-        boundsOptions?: Parameters<WebMercatorViewport['fitBounds']>[1];
-        viewStateOptions?: any;
-    }) => void;
-};
-/**
- * Returns the map with the given ID from the current map state.
- * @param {string} id - The ID of the map to retrieve.
- * @returns {MapContextInterface['state']['maps'][string]} The map with the given ID.
- *
- * @deprecated Use `useMap` with id param instead.
- */
-export declare function useMapByID(id: string): MapProviderMapProps;
-/**
- * @deprecated Use `useMapReferences` with id param instead.
- */
-export declare function useMapReferencesByID(id: string): MapReferences & {
-    getDeckInstance: () => Deck<null> | undefined;
-    getOverlayInstance: () => OverlayMapRef | undefined;
-    getViewState: () => ({
-        longitude: number;
-        latitude: number;
-        zoom: number;
-        pitch?: number | undefined;
-        bearing?: number | undefined;
-        minZoom?: number | undefined;
-        maxZoom?: number | undefined;
-        minPitch?: number | undefined;
-        maxPitch?: number | undefined;
-        position?: number[] | undefined;
-    } & import("@deck.gl/core/dist/controllers/transition-manager").TransitionProps) | undefined;
-    getViewports: (rect?: ViewportRect | undefined) => WebMercatorViewport[];
-    getViewport: (index?: number | undefined, rect?: ViewportRect | undefined) => WebMercatorViewport;
-};
-/**
-  @deprecated Use `useMapActions` with id param instead.
-*/
-export declare function useMapActionsByID(id: string): {
-    setBasemap: (basemap: any) => void;
-    setResize: (props: MapResize) => void;
-    setViewState: (viewState: import("@deck.gl/core").MapViewState) => void;
-    setZoom: (zoom: number) => void;
-    setLoaded: (loaded: boolean) => void;
-    fitBounds: (bounds: [[number, number], [number, number]], { boundsOptions, viewStateOptions, }?: {
-        boundsOptions?: {
-            width?: number | undefined;
-            height?: number | undefined;
-            minExtent?: number | undefined;
-            maxZoom?: number | undefined;
-            padding?: number | Required<import("@deck.gl/core/dist/viewports/viewport").Padding> | undefined;
-            offset?: number[] | undefined;
-        } | undefined;
-        viewStateOptions?: any;
-    }) => void;
-};

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

@@ -1,13 +0,0 @@
-import type { MapProviderProps } from './map-provider.types';
-/**
- * Provides a context for maps and their state management.
- * @param {MapProviderProps} props - The props for the MapProvider component.
- * @returns {JSX.Element} - The MapProvider component.
- *
- * @remarks
- * The MapProvider component is used to manage the state of multiple maps.
- *
- * The externalSync prop is used to sync the state with an external source, such as C4R. The externalSync function should accept an action object with a type and payload property.
- * The type property should be a string that matches the action type described in the Action enum. The payload property should be an object that contains the data to be synced.
- */
-export declare function MapProvider({ children, maps, externalSync, }: MapProviderProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,24 +0,0 @@
-import type { MapResize, MapsProps, MapState, MapViewState } from './map-provider.types';
-export declare enum Actions {
-    SetViewState = "SetViewState",
-    SetBasemap = "SetBasemap",
-    SetResize = "SetResize",
-    SetZoom = "SetZoom",
-    SetLoaded = "SetLoaded"
-}
-type Action = {
-    type: Actions;
-    payload: MapsProps | MapResize | {
-        viewState: MapViewState;
-    } | {
-        zoom: MapViewState['zoom'];
-    } | boolean;
-};
-/**
- * Reducer function for the MapProvider component.
- * @param state - The current state of the MapProvider.
- * @param action - The action to be performed on the state.
- * @returns The new state of the MapProvider.
- */
-export declare function reducer(state: MapState, { type, payload }: Action): MapState;
-export {};

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

@@ -1,122 +0,0 @@
-/// <reference types="google.maps" />
-import type { MapViewState as _MapViewState, PickingInfo } from '@deck.gl/core';
-import type { GoogleMapsOverlay, GoogleMapsOverlayProps } from '@deck.gl/google-maps';
-import type { DeckGLProps, DeckGLRef } from '@deck.gl/react';
-import type { Properties } from 'csstype';
-import type { MutableRefObject, ReactNode } from 'react';
-import type { MapRef } from 'react-map-gl';
-import { CartoBasemapsNames, GMapsBasemap } from './map-provider.const';
-import type { Actions } from './map-provider.reducer';
-import type { ControllerOptions } from '@deck.gl/core/dist/controllers/controller';
-export type MapViewState = _MapViewState;
-export type MapProviderMapProps = {
-    id: MapsProps['id'];
-    basemap: MapsProps['basemap'];
-    viewState: MapViewState;
-    isLoaded?: boolean;
-} & Partial<MapResize>;
-/**
- * Props for the MapProvider component.
- */
-export type MapProviderProps = {
-    children: ReactNode;
-    maps: MapProviderMapProps[];
-    externalSync?: ExternalSync;
-};
-export type ExternalSync = (data: ExternalSyncProps) => void;
-export type ExternalSyncProps = {
-    type: Actions.SetViewState | Actions.SetResize;
-    payload: MapViewState | MapResize;
-};
-/**
- * State for the MapProvider component.
- */
-export type MapState = {
-    maps: Record<MapsProps['id'], MapProviderMapProps>;
-};
-/**
- * Resize properties for the map.
- */
-export type MapResize = {
-    width: MapsProps['width'];
-    height: MapsProps['height'];
-};
-export type MapReferences = {
-    instanceRef: MutableRefObject<InstanceMapRef>;
-    overlayRef: MutableRefObject<OverlayMapRef>;
-};
-export type MapReferencesState = Record<MapsProps['id'], MapReferences>;
-/**
- * Actions that can be performed on the map.
- */
-export type MapActionsState = {
-    setViewState: (viewState: MapViewState, id: MapsProps['id']) => void;
-    setResize: (props: MapResize, id: MapsProps['id']) => void;
-    setBasemap: (basemap: Basemap, id: MapsProps['id']) => void;
-    setZoom: (zoom: number, id: MapsProps['id']) => void;
-    setLoaded: (loaded: boolean, id: MapsProps['id']) => void;
-};
-/**
- * Context interface for the MapProvider component.
- */
-export type MapContextInterface = {
-    state: MapState;
-    references: MutableRefObject<MapReferencesState>;
-    actions: MapActionsState;
-};
-/**
- * Basemap types.
- */
-export type Basemap = (typeof GMapsBasemap)[keyof typeof GMapsBasemap] | (typeof CartoBasemapsNames)[keyof typeof CartoBasemapsNames] | string;
-/**
- * Common properties for the map.
- */
-export type CommonProps = {
-    id: string;
-    basemap: Basemap;
-    viewState?: MapViewState;
-    initialViewState?: MapViewState;
-    controller?: ControllerOptions;
-} & DeckGLProps & Partial<MapReferences>;
-/**
- * Properties for the maps.
- */
-export type MapsProps = DeckGLMapsProps & GoogleMapsProps;
-/**
- * Reference to the instance map.
- */
-export type InstanceMapRef = GoogleMapsOverlay | DeckGLRef | null;
-/**
- * Reference to the overlay map.
- */
-export type OverlayMapRef = google.maps.Map | MapRef | null;
-/**
- * Properties for the DeckGL maps.
- */
-export type DeckGLMapsProps = CommonProps;
-/**
- * Properties for the Google Maps.
- */
-export type GoogleMapsProps = {
-    apiKey?: string;
-    language?: string;
-    mapId?: string;
-    mapOptions?: Record<string, number | string>;
-    style?: Properties;
-    version?: string;
-} & CommonProps & GoogleMapsOverlayProps;
-/**
- * Tooltip properties.
- */
-export type Tooltip = {
-    text?: string | undefined;
-    html?: string | undefined;
-    className?: string | undefined;
-    style?: Partial<CSSStyleDeclaration> | undefined;
-} & PickingInfo;
-export type ViewportRect = {
-    x: number;
-    y: number;
-    width?: number;
-    height?: number;
-};

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

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

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

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

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

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

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

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

package/dist/types/utils/object-to-html/index.d.ts

@@ -1,2 +0,0 @@
-export { objectToHtml } from './object-to-html';
-export * from './types';