@reearth/core 0.0.1

package/src/mantle/types/appearance.ts

@@ -0,0 +1,318 @@
+import { objKeys } from "../utils";
+
+import type { ExpressionContainer } from "./expression";
+import type {
+  LUT,
+  Bound,
+  Camera,
+  ClassificationType,
+  EXPERIMENTAL_clipping,
+  LatLng,
+  Typography,
+} from "./value";
+
+export type LayerAppearance<T> = {
+  [K in keyof T]?: T[K] | LayerAppearance<T[K]> | ExpressionContainer;
+};
+
+export type LayerAppearanceTypes = {
+  [K in keyof AppearanceTypes]: LayerAppearance<AppearanceTypes[K]>;
+};
+
+export type AppearanceTypes = {
+  marker: MarkerAppearance;
+  polyline: PolylineAppearance;
+  polygon: PolygonAppearance;
+  model: ModelAppearance;
+  "3dtiles": Cesium3DTilesAppearance;
+  ellipsoid: EllipsoidAppearance;
+  ellipse: EllipseAppearance;
+  box: BoxAppearance;
+  photooverlay: LegacyPhotooverlayAppearance;
+  resource: ResourceAppearance;
+  raster: RasterAppearance;
+  heatMap: HeatMapAppearance;
+  frustum: FrustumAppearance;
+  transition: TransitionAppearance;
+};
+
+export type MarkerAppearance = {
+  show?: boolean;
+  height?: number;
+  heightReference?: "none" | "clamp" | "relative";
+  style?: "none" | "point" | "image";
+  pointSize?: number;
+  pointColor?: string;
+  pointOutlineColor?: string;
+  pointOutlineWidth?: number;
+  image?: string;
+  imageSize?: number;
+  imageSizeInMeters?: boolean;
+  imageHorizontalOrigin?: "left" | "center" | "right";
+  imageVerticalOrigin?: "top" | "center" | "baseline" | "bottom";
+  imageColor?: string;
+  imageCrop?: "none" | "rounded" | "circle";
+  imageShadow?: boolean;
+  imageShadowColor?: string;
+  imageShadowBlur?: number;
+  imageShadowPositionX?: number;
+  imageShadowPositionY?: number;
+  label?: boolean;
+  labelText?: string;
+  labelPosition?:
+    | "left"
+    | "right"
+    | "top"
+    | "bottom"
+    | "lefttop"
+    | "leftbottom"
+    | "righttop"
+    | "rightbottom";
+  labelTypography?: Typography;
+  labelBackground?: boolean;
+  labelBackgroundColor?: string;
+  labelBackgroundPaddingHorizontal?: number;
+  labelBackgroundPaddingVertical?: number;
+  extrude?: boolean;
+  near?: number;
+  far?: number;
+  pixelOffset?: [number, number];
+  eyeOffset?: [number, number, number];
+  hideIndicator?: boolean;
+  selectedFeatureColor?: string; // This doesn't support expression
+};
+
+export type PolylineAppearance = {
+  show?: boolean;
+  clampToGround?: boolean;
+  strokeColor?: string;
+  strokeWidth?: number;
+  shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
+  near?: number;
+  far?: number;
+  classificationType?: ClassificationType;
+  hideIndicator?: boolean;
+  selectedFeatureColor?: string; // This doesn't support expression
+};
+
+export type PolygonAppearance = {
+  show?: boolean;
+  fill?: boolean;
+  fillColor?: string;
+  stroke?: boolean;
+  strokeColor?: string;
+  strokeWidth?: number;
+  heightReference?: "none" | "clamp" | "relative";
+  shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
+  lineJoin?: CanvasLineJoin;
+  near?: number;
+  far?: number;
+  extrudedHeight?: number;
+  classificationType?: ClassificationType;
+  hideIndicator?: boolean;
+  selectedFeatureColor?: string; // This doesn't support expression
+};
+
+export type HeatMapAppearance = {
+  valueMap: string;
+  bounds: Bound;
+  colorMap?: LUT;
+  cropBounds?: Bound;
+  width?: number;
+  height?: number;
+  minValue?: number;
+  maxValue?: number;
+  opacity?: number;
+  contourSpacing?: number;
+  contourThickness?: number;
+  contourAlpha?: number;
+  logarithmic?: boolean;
+};
+
+export type EllipsoidAppearance = {
+  show?: boolean;
+  heightReference?: "none" | "clamp" | "relative";
+  shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
+  radius?: number;
+  fillColor?: string;
+  near?: number;
+  far?: number;
+};
+
+export type EllipseAppearance = {
+  show?: boolean;
+  heightReference?: "none" | "clamp" | "relative";
+  classificationType?: ClassificationType;
+  shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
+  radius?: number;
+  fill?: boolean;
+  fillColor?: string;
+  near?: number;
+  far?: number;
+};
+
+export type ModelAppearance = {
+  show?: boolean;
+  model?: string; // For compat
+  url?: string;
+  heightReference?: "none" | "clamp" | "relative";
+  heading?: number;
+  pitch?: number;
+  roll?: number;
+  scale?: number;
+  maximumScale?: number;
+  minimumPixelSize?: number;
+  animation?: boolean; // default: true
+  shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
+  colorBlend?: "none" | "highlight" | "replace" | "mix";
+  color?: string;
+  colorBlendAmount?: number;
+  lightColor?: string;
+  silhouette?: boolean;
+  silhouetteColor?: string;
+  bearing?: number;
+  silhouetteSize?: number; // default: 1
+  near?: number;
+  far?: number;
+  pbr?: boolean | "withTexture";
+  specularEnvironmentMaps?: string;
+  sphericalHarmonicCoefficients?: [x: number, y: number, z: number][];
+  imageBasedLightIntensity?: number;
+};
+
+export type FrustumAppearance = {
+  show?: boolean;
+  color?: string;
+  opacity?: number;
+  zoom?: number;
+  aspectRatio?: number;
+  length?: number;
+};
+
+export type Cesium3DTilesAppearance = {
+  show?: boolean;
+  color?: string;
+  styleUrl?: string;
+  shadows?: "disabled" | "enabled" | "cast_only" | "receive_only";
+  colorBlendMode?: "highlight" | "replace" | "mix" | "default";
+  edgeWidth?: number;
+  edgeColor?: string;
+  selectedFeatureColor?: string; // This doesn't support expression
+  disableIndexingFeature?: boolean;
+  tileset?: string;
+  apiKey?: string;
+  experimental_clipping?: EXPERIMENTAL_clipping;
+  pointSize?: number;
+  meta?: unknown;
+  pbr?: boolean | "withTexture";
+  specularEnvironmentMaps?: string;
+  sphericalHarmonicCoefficients?: [x: number, y: number, z: number][];
+  imageBasedLightIntensity?: number;
+  showWireframe?: boolean;
+  showBoundingVolume?: boolean;
+};
+
+export type LegacyPhotooverlayAppearance = {
+  show?: boolean;
+  location?: LatLng;
+  height?: number;
+  heightReference?: "none" | "clamp" | "relative";
+  camera?: Camera; // You may also update the field name in storytelling widget
+  image?: string;
+  imageSize?: number;
+  imageHorizontalOrigin?: "left" | "center" | "right";
+  imageVerticalOrigin?: "top" | "center" | "baseline" | "bottom";
+  imageCrop?: "none" | "rounded" | "circle";
+  imageShadow?: boolean;
+  imageShadowColor?: string;
+  imageShadowBlur?: number;
+  imageShadowPositionX?: number;
+  imageShadowPositionY?: number;
+  photoOverlayImage?: string;
+  photoOverlayDescription?: string;
+  near?: number;
+  far?: number;
+};
+
+export type ResourceAppearance = {
+  show?: boolean;
+  url?: string;
+  type?: "geojson" | "kml" | "czml" | "auto";
+  clampToGround?: boolean;
+  markerSize?: number;
+  markerColor?: string;
+  stroke?: string;
+  strokeWidth?: number;
+  fill?: string;
+  hideIndicator?: boolean;
+};
+
+export type RasterAppearance = {
+  show?: boolean;
+  minimumLevel?: number;
+  maximumLevel?: number;
+  credit?: string;
+  alpha?: number;
+  hideIndicator?: boolean;
+  bounds?: string;
+};
+
+export type BoxAppearance = {
+  show?: boolean;
+  height?: number;
+  width?: number;
+  length?: number;
+  heading?: number;
+  pitch?: number;
+  roll?: number;
+  fillColor?: string;
+  outlineColor?: string;
+  activeOutlineColor?: string;
+  outlineWidth?: number;
+  draggableOutlineColor?: string;
+  activeDraggableOutlineColor?: string;
+  draggableOutlineWidth?: number;
+  scalePoint?: boolean;
+  axisLine?: boolean;
+  pointFillColor?: string;
+  pointOutlineColor?: string;
+  activePointOutlineColor?: string;
+  pointOutlineWidth?: number;
+  axisLineColor?: string;
+  axisLineWidth?: number;
+  allowEnterGround?: boolean;
+  cursor?: string;
+  activeBox?: boolean;
+  activeScalePointIndex?: number; // 0 ~ 11
+  activeEdgeIndex?: number; // 0 ~ 11
+  near?: number;
+  far?: number;
+  hideIndicator?: boolean;
+  disabledSelection?: boolean;
+};
+
+export type TransitionAppearance = {
+  useTransition?: boolean;
+  translate?: [lng: number, lat: number, height: number];
+  rotate?: [heading: number, pitch: number, roll: number];
+  scale?: [x: number, y: number, z: number];
+};
+
+export const appearanceKeyObj: { [k in keyof AppearanceTypes]: 1 } = {
+  marker: 1,
+  polyline: 1,
+  polygon: 1,
+  ellipsoid: 1,
+  ellipse: 1,
+  model: 1,
+  "3dtiles": 1,
+  box: 1,
+  photooverlay: 1,
+  resource: 1,
+  raster: 1,
+  heatMap: 1,
+  frustum: 1,
+  transition: 1,
+};
+
+export const appearanceKeys = objKeys<keyof AppearanceTypes>(appearanceKeyObj);

package/src/mantle/types/events.ts

@@ -0,0 +1,16 @@
+export type Events = {
+  select?: SelectEvent;
+};
+
+export type SelectEvent = {
+  // disabled?: boolean;
+  openUrl?: OpenUrlEvent;
+  // photoOverlay?: PhotoOverlayEvent;
+};
+
+export type OpenUrlEvent = {
+  url?: string;
+  urlKey?: string;
+};
+
+// export type PhotoOverlayEvent = {};

package/src/mantle/types/expression.ts

@@ -0,0 +1,9 @@
+export type ExpressionContainer = {
+  expression: StyleExpression;
+};
+
+export type StyleExpression = ConditionsExpression | string;
+
+export type ConditionsExpression = {
+  conditions: [string, string][];
+};

package/src/mantle/types/index.ts

@@ -0,0 +1,156 @@
+import type {
+  LineString,
+  Point,
+  Polygon,
+  MultiPoint,
+  MultiLineString,
+  MultiPolygon,
+} from "geojson";
+
+import type { Infobox, InfoboxBlock } from "../../reearthTypes";
+import type { Tag } from "../compat/types";
+
+import type { AppearanceTypes, LayerAppearanceTypes } from "./appearance";
+import type { Events } from "./events";
+
+export * from "./appearance";
+export * from "./value";
+export * from "./expression";
+
+// Layer
+
+export type Layer = LayerSimple | LayerGroup;
+
+export type LayerSimple = {
+  type: "simple";
+  data?: Data;
+  properties?: any;
+  defines?: Record<string, string>;
+  events?: Events;
+  layerStyleId?: string;
+} & Partial<LayerAppearanceTypes> &
+  LayerCommon;
+
+export type LayerGroup = {
+  type: "group";
+  children: Layer[];
+} & LayerCommon;
+
+export type LayerCommon = {
+  id: string;
+  title?: string;
+  /** default is true */
+  visible?: boolean;
+  infobox?: Infobox;
+  tags?: Tag[];
+  creator?: string;
+  compat?: LayerCompat;
+  _updateStyle?: number;
+};
+
+export type LayerCompat = { extensionId?: string; property?: any; propertyId?: string };
+
+/** Same as a Layer, but its ID is unknown. */
+export type NaiveLayer = NaiveLayerSimple | NaiveLayerGroup;
+export type NaiveLayerSimple = Omit<LayerSimple, "id" | "infobox"> & { infobox?: NaiveInfobox };
+export type NaiveLayerGroup = Omit<LayerGroup, "id" | "children" | "infobox"> & {
+  infobox?: NaiveInfobox;
+  children?: NaiveLayer[];
+};
+export type NaiveInfobox = Omit<Infobox, "id" | "blocks"> & { blocks?: NaiveBlock[] };
+export type NaiveBlock<P = any> = Omit<InfoboxBlock<P>, "id">;
+
+export type SelectedFeatureInfo = {
+  feature?: ComputedFeature;
+};
+
+// Data
+
+export type Data = {
+  type: DataType;
+  url?: string;
+  value?: any;
+  layers?: string | string[];
+  jsonProperties?: string[];
+  isSketchLayer?: boolean;
+  updateInterval?: number; // milliseconds
+  parameters?: Record<string, any>;
+  idProperty?: string;
+  time?: {
+    property?: string;
+    interval?: number; // milliseconds
+    updateClockOnLoad?: boolean;
+  };
+  csv?: {
+    idColumn?: string | number;
+    latColumn?: string | number;
+    lngColumn?: string | number;
+    heightColumn?: string | number;
+    noHeader?: boolean;
+    disableTypeConversion?: boolean;
+  };
+  geojson?: {
+    useAsResource?: boolean;
+  };
+};
+
+export type DataRange = {
+  x: number;
+  y: number;
+  z: number;
+};
+
+export type DataType =
+  | "geojson"
+  | "3dtiles"
+  | "osm-buildings"
+  | "google-photorealistic"
+  | "czml"
+  | "csv"
+  | "wms"
+  | "mvt"
+  | "kml"
+  | "gpx"
+  | "shapefile"
+  | "gtfs"
+  | "gml"
+  | "georss"
+  | "gltf"
+  | "tiles"
+  | "tms"
+  | "heatMap";
+
+export type TimeInterval = [start: Date, end?: Date];
+
+// Feature
+export type CommonFeature<T extends "feature" | "computedFeature"> = {
+  type: T;
+  id: string;
+  geometry?: Geometry;
+  interval?: TimeInterval;
+  properties?: any;
+  // Map engine specific information.
+  metaData?: {
+    description?: string;
+  };
+  range?: DataRange;
+};
+
+export type Feature = CommonFeature<"feature">;
+
+export type Geometry = Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon;
+
+export type ComputedLayerStatus = "fetching" | "ready";
+
+// Computed
+
+export type ComputedLayer = {
+  id: string;
+  status: ComputedLayerStatus;
+  layer: Layer;
+  originalFeatures: Feature[];
+  features: ComputedFeature[];
+  properties?: any;
+} & Partial<AppearanceTypes>;
+
+export type ComputedFeature = CommonFeature<"computedFeature"> & Partial<AppearanceTypes>;

package/src/mantle/types/value.ts

@@ -0,0 +1,153 @@
+export type LatLng = {
+  lat: number;
+  lng: number;
+};
+
+export type LatLngHeight = {
+  lat: number;
+  lng: number;
+  height: number;
+};
+
+export type Camera = {
+  lat: number;
+  lng: number;
+  height: number;
+  heading: number;
+  pitch: number;
+  roll: number;
+  fov: number;
+  aspectRatio?: number;
+};
+
+export type Typography = {
+  fontFamily?: string;
+  fontSize?: number;
+  fontWeight?: number;
+  color?: string;
+  textAlign?: "left" | "center" | "right" | "justify" | "justify_all";
+  bold?: boolean;
+  italic?: boolean;
+  underline?: boolean;
+};
+
+export type Spacing = {
+  bottom: number;
+  left: number;
+  right: number;
+  top: number;
+};
+
+export type Bound = {
+  east: number;
+  north: number;
+  south: number;
+  west: number;
+};
+
+export type ColorTuple = [number, number, number];
+export type LUT = readonly ColorTuple[];
+
+export type Coordinates = LatLngHeight[];
+
+export type Polygon = LatLngHeight[][];
+
+export type Rect = {
+  west: number;
+  south: number;
+  east: number;
+  north: number;
+};
+
+// Ideal for plugin developers, but it's hard to implement it with Cesium
+export type Plane = {
+  location: LatLngHeight;
+  width: number;
+  height: number;
+  length: number;
+  heading: number;
+  pitch: number;
+};
+
+// Familiar with Cesium
+export type EXPERIMENTAL_clipping = {
+  useBuiltinBox?: boolean;
+  allowEnterGround?: boolean;
+  planes?: {
+    normal: {
+      x: number;
+      y: number;
+      z: number;
+    };
+    distance: number;
+  }[];
+  visible?: boolean;
+  // for compat
+  location?: LatLngHeight;
+  coordinates?: number[];
+  /**
+   * x-axis
+   */
+  width?: number;
+  /**
+   * y-axis
+   */
+  length?: number;
+  /**
+   * z-axis
+   */
+  height?: number;
+  heading?: number;
+  pitch?: number;
+  roll?: number;
+  direction?: "inside" | "outside";
+  disabledSelection?: boolean;
+  // draw clipping
+  draw?: {
+    enabled?: boolean;
+    surfacePoints?: LatLng[];
+    top?: number;
+    bottom?: number;
+    visible?: boolean;
+    direction?: "inside" | "outside";
+    style?: {
+      fill?: boolean;
+      fillColor?: string;
+      stroke?: boolean;
+      strokeColor?: string;
+      strokeWidth?: number;
+    };
+  };
+};
+
+export type Array = any[];
+
+export type Timeline = {
+  startTime?: string;
+  endTime?: string;
+  currentTime?: string;
+};
+
+// Don't forget adding a new field to valueTypeMapper also!
+export type ValueTypes = {
+  string: string;
+  number: number;
+  bool: boolean;
+  latlng: LatLng;
+  latlngheight: LatLngHeight;
+  url: string;
+  camera: Camera;
+  typography: Typography;
+  coordinates: Coordinates;
+  polygon: Polygon;
+  rect: Rect;
+  ref: string;
+  tiletype: string;
+  spacing: Spacing;
+  array: Array;
+  timeline: Timeline;
+};
+
+export type ValueType = keyof ValueTypes;
+
+export type ClassificationType = "both" | "terrain" | "3dtiles";