@reearth/core 0.0.7-alpha.63 → 0.0.7-alpha.64

package/dist/index.d.ts

@@ -6,11 +6,11 @@ import { CSSProperties } from 'react';
 import { Feature as Feature_2 } from 'geojson';
 import { ForwardRefExoticComponent } from 'react';
 import { LineString } from 'geojson';
-import { MemoExoticComponent } from 'react';
 import { MultiLineString } from 'geojson';
 import { MultiPoint } from 'geojson';
 import { MultiPolygon } from 'geojson';
 import { MutableRefObject } from 'react';
+import { NamedExoticComponent } from 'react';
 import { Point } from 'geojson';
 import { Polygon as Polygon_2 } from 'geojson';
 import { PropsWithoutRef } from 'react';
@@ -160,6 +160,7 @@ export declare type CameraProperty = {
 
 export declare type Cesium3DTilesAppearance = {
     show?: boolean;
+    height?: number;
     color?: string;
     styleUrl?: string;
     shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
@@ -279,7 +280,7 @@ declare type CommonProps = {
     sketchEditingFeature?: SketchEditingFeature;
 };
 
-export declare function computeAtom(cache?: typeof globalDataFeaturesCache): WritableAtom<ComputedLayer | undefined, Command, void>;
+export declare function computeAtom(cache?: typeof globalDataFeaturesCache): WritableAtom<ComputedLayer | undefined, [Command], void>;
 
 export declare type ComputedFeature = CommonFeature<"computedFeature"> & Partial<AppearanceTypes>;
 
@@ -334,9 +335,9 @@ declare type CoreContext = {
 
 export declare const coreContext: Context<CoreContext>;
 
-export declare const CoreVisualizer: MemoExoticComponent<ForwardRefExoticComponent<CoreVisualizerProps & {
-children?: ReactNode;
-} & RefAttributes<MapRef>>>;
+export declare const CoreVisualizer: NamedExoticComponent<CoreVisualizerProps & {
+children?: ReactNode | undefined;
+} & RefAttributes<MapRef>>;
 
 export declare type CoreVisualizerProps = {
     engine?: EngineType;
@@ -350,6 +351,7 @@ export declare type CoreVisualizerProps = {
     interactionMode?: InteractionModeType;
     shouldRender?: boolean;
     meta?: Record<string, unknown>;
+    customProvider?: CustomProviderConfig;
     style?: CSSProperties;
     small?: boolean;
     ready?: boolean;
@@ -367,16 +369,31 @@ export declare type CoreVisualizerProps = {
     onSketchFeatureDelete?: (layerId: string, featureId: string) => void;
     onInteractionModeChange?: (mode: InteractionModeType) => void;
     onAPIReady?: () => void;
-    onCreditsUpdate?: (credits: Credit[]) => void;
+    onCreditsUpdate?: (credits?: Credits) => void;
 };
 
-export declare type Credit = {
+export declare type CreditItem = {
     html?: string;
 };
 
-export declare type CursorType = "auto" | "grab" | "crosshair";
+export declare type Credits = {
+    engine: {
+        cesium?: CreditItem;
+    };
+    lightbox: CreditItem[];
+    screen: CreditItem[];
+};
 
-declare type CursorType_2 = "default" | "auto" | "help" | "pointer" | "grab" | "crosshair";
+declare type CursorType = "default" | "auto" | "help" | "pointer" | "grab" | "crosshair" | "wait";
+
+export declare type CustomProviderConfig = {
+    imagery?: {
+        providers?: ImageryProviderEntry[];
+    };
+    layers?: {
+        providers?: LayerProviderEntry[];
+    };
+};
 
 export declare type Data = {
     type: DataType;
@@ -388,6 +405,7 @@ export declare type Data = {
     updateInterval?: number;
     parameters?: Record<string, any>;
     idProperty?: string;
+    provider?: string;
     serviceTokens?: {
         googleMapApiKey?: string;
     };
@@ -415,7 +433,7 @@ export declare type DataRange = {
     z: number;
 };
 
-export declare type DataType = "geojson" | "3dtiles" | "osm-buildings" | "google-photorealistic" | "czml" | "csv" | "wms" | "mvt" | "kml" | "gpx" | "shapefile" | "gtfs" | "gml" | "georss" | "gltf" | "tiles" | "tms" | "heatMap";
+export declare type DataType = "geojson" | "3dtiles" | "osm-buildings" | "reearth-buildings" | "google-photorealistic" | "czml" | "csv" | "wms" | "mvt" | "kml" | "gpx" | "shapefile" | "gtfs" | "gml" | "georss" | "gltf" | "tiles" | "tms" | "heatMap";
 
 export declare type DebugProperty = {
     showGlobeWireframe?: boolean;
@@ -504,8 +522,9 @@ export declare type EngineProps = {
     isLayerDragging?: boolean;
     shouldRender?: boolean;
     meta?: Record<string, unknown>;
+    customProvider?: CustomProviderConfig;
     displayCredits?: boolean;
-    layersRef?: RefObject<LayersRef>;
+    layersRef?: RefObject<LayersRef | null>;
     requestingRenderMode?: MutableRefObject<RequestingRenderMode>;
     timelineManagerRef?: TimelineManagerRef;
     onLayerSelect?: (layerId: string | undefined, featureId?: string, options?: LayerSelectionReason, info?: SelectedFeatureInfo) => void;
@@ -519,7 +538,7 @@ export declare type EngineProps = {
     onLayerSelectWithRectStart?: (e: LayerSelectWithRectStart) => void;
     onLayerSelectWithRectMove?: (e: LayerSelectWithRectMove) => void;
     onLayerSelectWithRectEnd?: (e: LayerSelectWithRectEnd) => void;
-    onCreditsUpdate?: (credits: Credit[]) => void;
+    onCreditsUpdate?: (credits?: Credits) => void;
 };
 
 export declare type EngineRef = {
@@ -557,7 +576,7 @@ export declare type EngineRef = {
         type: SketchType;
         controlPoints: Position3d[];
     }) => LineString | Polygon_2 | MultiPolygon | Point | undefined;
-    setCursor: (cursor: CursorType_2) => void;
+    setCursor: (cursor: CursorType) => void;
     flyTo: FlyTo;
     flyToBBox: (bbox: [number, number, number, number], options?: CameraOptions & {
         heading?: number;
@@ -596,7 +615,7 @@ export declare type EngineRef = {
     tick: () => Date | void;
     inViewport: (location?: LatLng) => boolean;
     onTick: TickEvent;
-    tickEventCallback?: RefObject<TickEventCallback[]>;
+    tickEventCallback?: RefObject<TickEventCallback[] | null>;
     removeTickEventListener: TickEvent;
     findFeatureById: (layerId: string, featureId: string) => Feature | undefined;
     bringToFront: (layerId: string) => void;
@@ -608,7 +627,7 @@ export declare type EngineRef = {
     unselectFeatures: (layerId: string, featureId: string[]) => void;
     pickManyFromViewport: (windowPosition: [x: number, y: number], windowWidth: number, windowHeight: number, condition?: (f: PickedFeature) => boolean) => PickedFeature[] | undefined;
     calcRectangleControlPoint: (p1: Position3d, p2: Position3d, p3: Position3d) => [p1: Position3d, p2: Position3d, p3: Position3d];
-    getCredits: () => Credit[] | undefined;
+    getCredits: () => Credits | undefined;
 } & MouseEventHandles;
 
 export declare const engines: {
@@ -765,6 +784,17 @@ export declare type FrustumAppearance = {
     length?: number;
 };
 
+export declare type GeoidProperty = {
+    server: {
+        url: string;
+        geoidProperty: string;
+    };
+};
+
+declare type GeoidRef = {
+    getGeoidHeight: (lat?: number, lng?: number) => Promise<number | undefined>;
+};
+
 export declare type Geometry = Point | LineString | Polygon_2 | MultiPoint | MultiLineString | MultiPolygon;
 
 export declare type GeometryOptionsXYZ = {
@@ -776,11 +806,11 @@ export declare function getCompat(l: Layer | undefined): LayerCompat | undefined
 
 declare const globalDataFeaturesCache: {
     get: Atom_2<(key: string, key2: string) => Feature[] | undefined>;
-    set: WritableAtom<null, {
+    set: WritableAtom<null, [value: {
     key: string;
     key2: string;
     value?: Feature[] | undefined;
-    }, void> & {
+    }], void> & {
         init: null;
     };
     getAll: Atom_2<(key: string) => Feature[][] | undefined>;
@@ -826,6 +856,23 @@ export declare type ImageBasedLighting = {
     sphericalHarmonicCoefficients?: [number, number, number][];
 };
 
+/**
+ * Generic provider configuration for overriding external data sources.
+ *
+ * - imagery.providers: imagery tile providers keyed by id
+ * - layers.providers: 3D tileset providers keyed by id
+ *
+ * Terrain is configured via viewer/engine terrain settings (see useTerrainProviderPromise)
+ * or via each layer's own `url` field.
+ */
+export declare type ImageryProviderEntry = {
+    id: string;
+    url: string;
+    credit?: string;
+    maximumLevel?: number;
+    minimumLevel?: number;
+};
+
 export declare type IndicatorProperty = {
     type?: "default" | "crosshair" | "custom";
     image?: string;
@@ -926,6 +973,12 @@ export declare type LayerLoadEvent = {
     layerId: string | undefined;
 };
 
+export declare type LayerProviderEntry = {
+    id: string;
+    url: string;
+    options?: Record<string, unknown>;
+};
+
 export declare type LayerSelectionReason = {
     reason?: string;
     defaultInfobox?: DefaultInfobox;
@@ -1090,12 +1143,10 @@ export declare type LookAtDestination = {
 export declare type LUT = readonly ColorTuple[];
 
 declare const Map_2: ForwardRefExoticComponent<    {
-engines?: Record<string, Engine> | undefined;
-engine?: string | undefined;
-onAPIReady?: (() => void) | undefined;
-} & Omit<Props_2, "Feature" | "viewerProperty" | "selectionReason" | "delegatedDataTypes" | "clusterComponent" | "selectedLayerId"> & Omit<EngineProps, "onLayerSelect" | "selectedLayerId" | "layerSelectionReason"> & Omit<SketchProps, "engineRef" | "SketchComponent" | "layersRef"> & {
-cursor?: CursorType | undefined;
-} & RefAttributes<MapRef>>;
+engines?: Record<string, Engine>;
+engine?: string;
+onAPIReady?: () => void;
+} & Omit<Props_2, "Feature" | "viewerProperty" | "selectionReason" | "delegatedDataTypes" | "clusterComponent" | "selectedLayerId"> & Omit<EngineProps, "onLayerSelect" | "selectedLayerId" | "layerSelectionReason"> & Omit<SketchProps, "engineRef" | "SketchComponent" | "layersRef"> & RefAttributes<MapRef>>;
 export { Map_2 as Map }
 
 export declare type MapRef = {
@@ -1103,6 +1154,7 @@ export declare type MapRef = {
     layers: WrappedRef<LayersRef>;
     sketch: WrappedRef<SketchRef>;
     spatialId?: WrappedRef<SpatialIdRef>;
+    geoid: WrappedRef<GeoidRef>;
     timeline?: TimelineManagerRef;
 };
 
@@ -1155,6 +1207,7 @@ export declare type ModelAppearance = {
     model?: string;
     url?: string;
     heightReference?: "none" | "clamp" | "relative";
+    height?: number;
     heading?: number;
     pitch?: number;
     roll?: number;
@@ -1338,9 +1391,7 @@ export declare type Props = {
     engines?: Record<string, Engine>;
     engine?: string;
     onAPIReady?: () => void;
-} & Omit<Props_2, "Feature" | "clusterComponent" | "selectionReason" | "delegatedDataTypes" | "selectedLayerId" | "viewerProperty"> & Omit<EngineProps, "onLayerSelect" | "layerSelectionReason" | "selectedLayerId"> & Omit<SketchProps, "layersRef" | "engineRef" | "SketchComponent"> & {
-    cursor?: CursorType;
-};
+} & Omit<Props_2, "Feature" | "clusterComponent" | "selectionReason" | "delegatedDataTypes" | "selectedLayerId" | "viewerProperty"> & Omit<EngineProps, "onLayerSelect" | "layerSelectionReason" | "selectedLayerId"> & Omit<SketchProps, "layersRef" | "engineRef" | "SketchComponent">;
 
 declare type Props_2 = Omit<Props_3, "atomMap" | "isHidden" | "selectedLayerId"> & {
     selectedLayer?: {
@@ -1351,7 +1402,7 @@ declare type Props_2 = Omit<Props_3, "atomMap" | "isHidden" | "selectedLayerId">
     hiddenLayers?: string[];
     viewerProperty?: ViewerProperty;
     requestingRenderMode?: MutableRefObject<RequestingRenderMode>;
-    engineRef?: RefObject<EngineRef>;
+    engineRef?: RefObject<EngineRef | null>;
     onLayerSelect?: (layerId: string | undefined, featureId: string | undefined, layer: (() => Promise<ComputedLayer | undefined>) | undefined, reason: LayerSelectionReason | undefined, info: SelectedFeatureInfo | undefined) => void;
     onMount?: () => void;
 };
@@ -1535,8 +1586,8 @@ export declare type SketchOptions = {
 };
 
 export declare type SketchProps = {
-    layersRef: RefObject<LayersRef>;
-    engineRef: RefObject<EngineRef>;
+    layersRef: RefObject<LayersRef | null>;
+    engineRef: RefObject<EngineRef | null>;
     SketchComponent?: SketchComponentType;
     selectedFeature?: Feature;
     interactionMode?: InteractionModeType;
@@ -1600,9 +1651,16 @@ export declare type Spacing = {
 declare type SpatialIdPickSpaceOptions = {
     zoom?: number;
     maxHeight?: number;
-    color?: string;
+    minHeight?: number;
     dataOnly?: boolean;
     rightClickToExit?: boolean;
+    color?: string;
+    outlineColor?: string;
+    groundIndicatorColor?: string;
+    selectorColor?: string;
+    selectorOutlineColor?: string;
+    verticalSpaceIndicatorColor?: string;
+    verticalSpaceIndicatorOutlineColor?: string;
 };
 
 declare type SpatialIdRef = {
@@ -1647,7 +1705,7 @@ export declare type Tag = {
 
 export declare type TerrainProperty = {
     enabled?: boolean;
-    type?: "cesium" | "arcgis" | "cesiumion";
+    type?: "cesium" | "cesiumion" | "reearth_terrain";
     url?: string;
     normal?: boolean;
     elevationHeatMap?: ElevationHeatMapProperty;
@@ -1679,6 +1737,7 @@ export declare type TileProperty = {
     id: string;
     type?: string;
     url?: string;
+    cesiumIonAssetId?: number;
     opacity?: number;
     zoomLevel?: number[];
     zoomLevelForURL?: number[];
@@ -1704,7 +1763,7 @@ declare type TimelineCommit = (PlayCommand | PauseCommand | SetTimeCommand | Set
 };
 
 export declare type TimelineCommitter = {
-    source: "widgetContext" | "pluginAPI" | "featureResource" | "storyTimelineBlock" | "storyPage" | "initialize";
+    source: string;
     id?: string;
 };
 
@@ -1768,7 +1827,7 @@ export declare type Undefinable<T extends object> = {
 
 export declare function useGet<T>(value: T): () => T;
 
-export declare const useVisualizer: () => RefObject<MapRef>;
+export declare const useVisualizer: () => RefObject<MapRef | null>;
 
 export declare type ValueType = keyof ValueTypes;
 
@@ -1793,6 +1852,7 @@ export declare type ValueTypes = {
 
 export declare type ViewerProperty = {
     globe?: GlobeProperty;
+    geoid?: GeoidProperty;
     terrain?: TerrainProperty;
     scene?: SceneProperty;
     tiles?: TileProperty[];
@@ -1812,7 +1872,7 @@ export declare type Viewport = {
     query: Record<string, string>;
 };
 
-export declare type VisualizerContext = RefObject<MapRef>;
+export declare type VisualizerContext = RefObject<MapRef | null>;
 
 export declare type WrappedRef<T> = {
     [P in keyof T as T[P] extends (...args: any[]) => any ? P : never]: T[P] extends (...args: infer A) => infer R ? (...args: A) => R | undefined : never;
@@ -1821,38 +1881,8 @@ export declare type WrappedRef<T> = {
 export { }
 
 
-declare global {
-    interface Window {
-        REEARTH_E2E_ACCESS_TOKEN?: string;
-        REEARTH_E2E_CESIUM_VIEWER?: any;
-    }
-}
-
-
 declare module "@cesium/engine" {
     namespace SceneTransforms {
         function transformWindowToDrawingBuffer(scene: Scene, windowPosition: Cartesian2, result?: Cartesian2): Cartesian2;
     }
 }
-
-
-    namespace SceneTransforms {
-        function transformWindowToDrawingBuffer(scene: Scene, windowPosition: Cartesian2, result?: Cartesian2): Cartesian2;
-    }
-
-
-declare global {
-    namespace Vi {
-        interface JestAssertion<T = any> extends jest.Matchers<void, T>, EmotionMatchers {
-            toHaveStyleRule: EmotionMatchers["toHaveStyleRule"];
-        }
-    }
-}
-
-
-    namespace Vi {
-        interface JestAssertion<T = any> extends jest.Matchers<void, T>, EmotionMatchers {
-            toHaveStyleRule: EmotionMatchers["toHaveStyleRule"];
-        }
-    }
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reearth/core",
-  "version": "0.0.7-alpha.63",
+  "version": "0.0.7-alpha.64",
   "author": "Re:Earth contributors <community@reearth.io>",
   "license": "Apache-2.0",
   "description": "A library that abstracts a map engine as one common API.",