@reearth/core 0.0.7-alpha.6 → 0.0.7-alpha.60

package/dist/index.d.ts

@@ -6,18 +6,17 @@ 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';
 import { ReactNode } from 'react';
 import { RefAttributes } from 'react';
 import { RefObject } from 'react';
-import { RequireExactlyOne } from 'type-fest';
 import { WritableAtom } from 'jotai';
 
 export declare type AmbientOcclusionProperty = {
@@ -161,16 +160,16 @@ export declare type CameraProperty = {
 
 export declare type Cesium3DTilesAppearance = {
     show?: boolean;
+    height?: number;
     color?: string;
     styleUrl?: string;
     shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
-    colorBlendMode?: "highlight" | "replace" | "mix" | "default";
+    colorBlendMode?: "highlight" | "replace" | "mix";
     edgeWidth?: number;
     edgeColor?: string;
     selectedFeatureColor?: string;
     disableIndexingFeature?: boolean;
     tileset?: string;
-    apiKey?: string;
     experimental_clipping?: EXPERIMENTAL_clipping;
     pointSize?: number;
     meta?: unknown;
@@ -278,9 +277,10 @@ declare type CommonProps = {
     isHidden?: boolean;
     isSelected?: boolean;
     meta?: Record<string, unknown>;
+    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>;
 
@@ -299,6 +299,8 @@ export declare type ConditionsExpression = {
     conditions: [string, string][];
 };
 
+declare type ControlPointMouseEventHandler = (index: number, isExtrudedPoint: boolean, type: "mousedown" | "click") => void;
+
 export declare function convertLayer(l: Layer): LegacyLayer | undefined;
 
 export declare function convertLegacyCluster(clusters: LegacyCluster[]): Cluster[];
@@ -320,6 +322,8 @@ declare type CoreContext = {
     handleCameraForceHorizontalRollChange?: (enable?: boolean) => void;
     handleInteractionModeChange?: (mode?: InteractionModeType | undefined) => void;
     onSketchPluginFeatureCreate?: (cb: SketchEventCallback) => void;
+    onSketchPluginFeatureUpdate?: (cb: SketchEventCallback) => void;
+    onSketchPluginFeatureDelete?: (cb: SketchEventCallback) => void;
     onSketchTypeChange?: (cb: (type: SketchType | undefined) => void) => void;
     onLayerVisibility?: (cb: (e: LayerVisibilityEvent) => void) => void;
     onLayerLoad?: (cb: (e: LayerLoadEvent) => void) => void;
@@ -331,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;
@@ -352,6 +356,7 @@ export declare type CoreVisualizerProps = {
     ready?: boolean;
     hiddenLayers?: string[];
     zoomedLayerId?: string;
+    displayCredits?: boolean;
     onCameraChange?: (camera: Camera) => void;
     onLayerDrop?: (layerId: string, propertyKey: string, position: LatLng | undefined) => void;
     onLayerSelect?: (layerId: string | undefined, layer: (() => Promise<ComputedLayer | undefined>) | undefined, feature: ComputedFeature | undefined, reason: LayerSelectionReason | undefined) => void;
@@ -359,12 +364,26 @@ export declare type CoreVisualizerProps = {
     onMount?: () => void;
     onSketchTypeChangeProp?: (type: SketchType | undefined) => void;
     onSketchFeatureCreate?: (feature: SketchFeature | null) => void;
+    onSketchFeatureUpdate?: (feature: SketchFeature | null) => void;
+    onSketchFeatureDelete?: (layerId: string, featureId: string) => void;
     onInteractionModeChange?: (mode: InteractionModeType) => void;
+    onAPIReady?: () => void;
+    onCreditsUpdate?: (credits?: Credits) => void;
+};
+
+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 Data = {
     type: DataType;
@@ -376,6 +395,9 @@ export declare type Data = {
     updateInterval?: number;
     parameters?: Record<string, any>;
     idProperty?: string;
+    serviceTokens?: {
+        googleMapApiKey?: string;
+    };
     time?: {
         property?: string;
         interval?: number;
@@ -489,7 +511,8 @@ export declare type EngineProps = {
     isLayerDragging?: boolean;
     shouldRender?: boolean;
     meta?: Record<string, unknown>;
-    layersRef?: RefObject<LayersRef>;
+    displayCredits?: boolean;
+    layersRef?: RefObject<LayersRef | null>;
     requestingRenderMode?: MutableRefObject<RequestingRenderMode>;
     timelineManagerRef?: TimelineManagerRef;
     onLayerSelect?: (layerId: string | undefined, featureId?: string, options?: LayerSelectionReason, info?: SelectedFeatureInfo) => void;
@@ -503,6 +526,7 @@ export declare type EngineProps = {
     onLayerSelectWithRectStart?: (e: LayerSelectWithRectStart) => void;
     onLayerSelectWithRectMove?: (e: LayerSelectWithRectMove) => void;
     onLayerSelectWithRectEnd?: (e: LayerSelectWithRectEnd) => void;
+    onCreditsUpdate?: (credits?: Credits) => void;
 };
 
 export declare type EngineRef = {
@@ -531,7 +555,8 @@ export declare type EngineRef = {
     isPositionVisible: (position: [x: number, y: number, z: number]) => boolean;
     setView: (camera: CameraPosition) => void;
     toWindowPosition: (position: [x: number, y: number, z: number]) => [x: number, y: number] | undefined;
-    getExtrudedHeight: (position: [x: number, y: number, z: number], windowPosition: [x: number, y: number]) => number | undefined;
+    getExtrudedHeight: (position: [x: number, y: number, z: number], windowPosition: [x: number, y: number], allowNegative?: boolean) => number | undefined;
+    getExtrudedPoint: (position: [x: number, y: number, z: number], extrutedHeight: number) => Position3d | undefined;
     getSurfaceDistance: (point1: Cartesian3, point2: Cartesian3) => number | undefined;
     equalsEpsilon2d: (point1: Position2d, point2: Position2d, relativeEpsilon: number | undefined, absoluteEpsilon: number | undefined) => boolean;
     equalsEpsilon3d: (point1: Position3d, point2: Position3d, relativeEpsilon: number | undefined, absoluteEpsilon: number | undefined) => boolean;
@@ -539,7 +564,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;
@@ -578,7 +603,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;
@@ -589,6 +614,8 @@ export declare type EngineRef = {
     selectFeatures: (layerId: string, featureId: string[]) => void;
     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: () => Credits | undefined;
 } & MouseEventHandles;
 
 export declare const engines: {
@@ -745,13 +772,19 @@ export declare type FrustumAppearance = {
     length?: number;
 };
 
-export declare type Geometry = Point | LineString | Polygon_2 | MultiPoint | MultiLineString | MultiPolygon;
+export declare type GeoidProperty = {
+    server: {
+        url: string;
+        geoidProperty: string;
+    };
+};
 
-declare type GeometryOptions = {
-    type: SketchType;
-    controlPoints: readonly Position3d[];
+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 = {
     type: SketchType;
     controlPoints: Position3d[];
@@ -761,11 +794,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>;
@@ -844,7 +877,7 @@ declare type InfoboxProperty = {
 
 export declare const INTERACTION_MODES: Record<InteractionModeType, number>;
 
-export declare type InteractionModeType = "default" | "move" | "selection" | "sketch";
+export declare type InteractionModeType = "default" | "move" | "selection" | "sketch" | "spatialId";
 
 export declare function isSketchType(value: unknown): value is SketchType;
 
@@ -955,6 +988,7 @@ export declare type LayersRef = {
     deleteLayer: (...ids: string[]) => void;
     isLayer: (obj: any) => obj is LazyLayer;
     isComputedLayer: (obj: any) => obj is ComputedLayer;
+    isTempLayer: (layerId?: string) => boolean;
     layers: () => LazyLayer[];
     walk: <T>(fn: (layer: LazyLayer, index: number, parents: LazyLayer[]) => T | void) => T | undefined;
     find: (fn: (layer: LazyLayer, index: number, parents: LazyLayer[]) => boolean) => LazyLayer | undefined;
@@ -985,6 +1019,7 @@ export declare type LayerVisibilityEvent = {
  */
 export declare type LazyLayer = Readonly<Layer> & {
     computed?: Readonly<ComputedLayer>;
+    isTempLayer?: boolean;
     pluginId?: string;
     extensionId?: string;
     property?: any;
@@ -1073,17 +1108,18 @@ export declare type LookAtDestination = {
 export declare type LUT = readonly ColorTuple[];
 
 declare const Map_2: ForwardRefExoticComponent<    {
-engines?: Record<string, Engine> | undefined;
-engine?: string | undefined;
-} & Omit<Props_2, "Feature" | "viewerProperty" | "selectionReason" | "delegatedDataTypes" | "clusterComponent" | "selectedLayerId"> & Omit<EngineProps, "onLayerSelect" | "selectedLayerId" | "layerSelectionReason"> & Omit<SketchProps, "engineRef" | "layersRef" | "SketchComponent"> & {
-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 = {
     engine: WrappedRef<EngineRef>;
     layers: WrappedRef<LayersRef>;
     sketch: WrappedRef<SketchRef>;
+    spatialId?: WrappedRef<SpatialIdRef>;
+    geoid: WrappedRef<GeoidRef>;
     timeline?: TimelineManagerRef;
 };
 
@@ -1136,6 +1172,7 @@ export declare type ModelAppearance = {
     model?: string;
     url?: string;
     heightReference?: "none" | "clamp" | "relative";
+    height?: number;
     heading?: number;
     pitch?: number;
     roll?: number;
@@ -1273,6 +1310,7 @@ export declare type PolygonAppearance = {
     stroke?: boolean;
     strokeColor?: string;
     strokeWidth?: number;
+    height?: number;
     heightReference?: "none" | "clamp" | "relative";
     shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
     lineJoin?: CanvasLineJoin;
@@ -1317,9 +1355,8 @@ declare type PropertyItem<T> = {
 export declare type Props = {
     engines?: Record<string, Engine>;
     engine?: string;
-} & Omit<Props_2, "Feature" | "clusterComponent" | "selectionReason" | "delegatedDataTypes" | "selectedLayerId" | "viewerProperty"> & Omit<EngineProps, "onLayerSelect" | "layerSelectionReason" | "selectedLayerId"> & Omit<SketchProps, "layersRef" | "engineRef" | "SketchComponent"> & {
-    cursor?: CursorType;
-};
+    onAPIReady?: () => void;
+} & 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?: {
@@ -1330,8 +1367,9 @@ 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;
 };
 
 declare type Props_3 = {
@@ -1459,17 +1497,34 @@ export declare type ShadowProperty = {
 
 export declare type SketchAppearance = Partial<LayerAppearanceTypes>;
 
-declare type SketchComponentProps = RequireExactlyOne<{
-    geometry?: LineString | Polygon_2 | MultiPolygon | null;
-    geometryOptions?: GeometryOptions | null;
+declare type SketchComponentProps = {
+    geometryOptions?: {
+        type: SketchType;
+        controlPoints: readonly Position3d[];
+    } | null;
     extrudedHeight?: number;
+    extrudedPoint?: Position3d;
+    centroidBasePoint?: Position3d;
+    centroidExtrudedPoint?: Position3d;
     disableShadow?: boolean;
-    enableRelativeHeight?: boolean;
     color?: string;
-}, "geometry" | "geometryOptions">;
+    isEditing?: boolean;
+    catchedControlPointIndex?: number;
+    catchedExtrudedPoint?: boolean;
+    selectedControlPointIndex?: number;
+    handleControlPointMouseEvent?: ControlPointMouseEventHandler;
+    handleAddControlPoint?: (position: Position3d, index: number) => void;
+};
 
 export declare type SketchComponentType = ComponentType<SketchComponentProps>;
 
+export declare type SketchEditFeatureChangeCb = (feature: SketchEditingFeature | undefined) => void;
+
+export declare type SketchEditingFeature = {
+    layerId: string;
+    feature: ComputedFeature;
+};
+
 export declare type SketchEventCallback = (event: SketchEventProps) => void;
 
 export declare type SketchEventProps = {
@@ -1490,14 +1545,14 @@ export declare type SketchOptions = {
     appearance?: SketchAppearance;
     dataOnly?: boolean;
     disableShadow?: boolean;
-    enableRelativeHeight?: boolean;
     rightClickToAbort?: boolean;
     autoResetInteractionMode?: boolean;
+    useCentroidExtrudedHeight?: boolean;
 };
 
 export declare type SketchProps = {
-    layersRef: RefObject<LayersRef>;
-    engineRef: RefObject<EngineRef>;
+    layersRef: RefObject<LayersRef | null>;
+    engineRef: RefObject<EngineRef | null>;
     SketchComponent?: SketchComponentType;
     selectedFeature?: Feature;
     interactionMode?: InteractionModeType;
@@ -1505,7 +1560,17 @@ export declare type SketchProps = {
     onSketchTypeChange?: (type: SketchType | undefined, from?: "editor" | "plugin") => void;
     onSketchFeatureCreate?: (feature: SketchFeature | null) => void;
     onSketchPluginFeatureCreate?: (props: SketchEventProps) => void;
+    onSketchFeatureUpdate?: (feature: SketchFeature | null) => void;
+    onSketchPluginFeatureUpdate?: (props: SketchEventProps) => void;
+    onSketchFeatureDelete?: (layerId: string, featureId: string) => void;
+    onSketchPluginFeatureDelete?: (props: {
+        layerId: string;
+        featureId: string;
+    }) => void;
     onLayerSelect?: OnLayerSelectType;
+    sketchEditingFeature?: SketchEditingFeature;
+    onSketchEditFeature?: (feature: SketchEditingFeature | undefined) => void;
+    onMount?: () => void;
 };
 
 export declare type SketchRef = {
@@ -1513,6 +1578,11 @@ export declare type SketchRef = {
     setType: (type: SketchType | undefined, from?: "editor" | "plugin") => void;
     getOptions: () => SketchOptions;
     overrideOptions: (options: SketchOptions) => void;
+    editFeature: (feature: SketchEditingFeature | undefined) => void;
+    cancelEdit: (ignoreAutoReSelect?: boolean) => void;
+    applyEdit: () => void;
+    deleteFeature: (layerId: string, featureId: string) => void;
+    onEditFeatureChange: (cb: SketchEditFeatureChangeCb) => void;
 };
 
 export declare type SketchType = "marker" | "polyline" | "circle" | "rectangle" | "polygon" | "extrudedCircle" | "extrudedRectangle" | "extrudedPolygon";
@@ -1543,6 +1613,49 @@ export declare type Spacing = {
     top: number;
 };
 
+declare type SpatialIdPickSpaceOptions = {
+    zoom?: number;
+    maxHeight?: number;
+    minHeight?: number;
+    dataOnly?: boolean;
+    rightClickToExit?: boolean;
+    color?: string;
+    outlineColor?: string;
+    groundIndicatorColor?: string;
+    selectorColor?: string;
+    selectorOutlineColor?: string;
+    verticalSpaceIndicatorColor?: string;
+    verticalSpaceIndicatorOutlineColor?: string;
+};
+
+declare type SpatialIdRef = {
+    pickSpace: (options?: SpatialIdPickSpaceOptions) => void;
+    exitPickSpace: () => void;
+    onSpacePick: (cb: (space: SpatialIdSpaceData) => void) => void;
+};
+
+declare type SpatialIdSpaceData = {
+    id: string;
+    center: {
+        lat: number;
+        lng: number;
+        alt?: number;
+    };
+    alt: number;
+    zoom: number;
+    zfxy: {
+        z: number;
+        f: number;
+        x: number;
+        y: number;
+    };
+    zfxyStr: string;
+    tilehash: string;
+    hilbertTilehash: string;
+    hilbertIndex: string;
+    vertices: [number, number, number][];
+};
+
 export declare type StyleExpression = ConditionsExpression | string;
 
 export declare type SunProperty = {
@@ -1581,6 +1694,8 @@ export declare type TileLabelProperty = {
     id: string;
     labelType: "japan_gsi_optimal_bvmap";
     style: Record<string, any>;
+    near?: number;
+    far?: number;
 };
 
 export declare type TileProperty = {
@@ -1612,7 +1727,7 @@ declare type TimelineCommit = (PlayCommand | PauseCommand | SetTimeCommand | Set
 };
 
 export declare type TimelineCommitter = {
-    source: "widgetContext" | "pluginAPI" | "featureResource" | "storyTimelineBlock" | "storyPage" | "initialize";
+    source: string;
     id?: string;
 };
 
@@ -1676,7 +1791,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;
 
@@ -1701,6 +1816,7 @@ export declare type ValueTypes = {
 
 export declare type ViewerProperty = {
     globe?: GlobeProperty;
+    geoid?: GeoidProperty;
     terrain?: TerrainProperty;
     scene?: SceneProperty;
     tiles?: TileProperty[];
@@ -1720,7 +1836,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;
@@ -1729,38 +1845,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"];
-        }
-    }
-