@react-native-kakao/map 2.2.7 → 3.1.0-next.2

package/src/types-gui.ts

@@ -0,0 +1,171 @@
+import type { Coordinate, MapPadding, MapWidgetPosition, ScreenPoint } from './types';
+import type { MapImageSource } from './types-assets';
+
+export type GuiColor = string;
+export type GuiAlignment =
+  | 'topLeft'
+  | 'topCenter'
+  | 'topRight'
+  | 'centerLeft'
+  | 'center'
+  | 'centerRight'
+  | 'bottomLeft'
+  | 'bottomCenter'
+  | 'bottomRight';
+
+type GuiComponent = {
+  id: string;
+  /** Android supports taps on any clickable component; iOS emits taps from `button` nodes. */
+  clickable?: boolean;
+  padding?: MapPadding;
+  origin?: GuiAlignment;
+  align?: GuiAlignment;
+};
+
+export type GuiLayout = GuiComponent & {
+  type: 'layout';
+  orientation: 'horizontal' | 'vertical';
+  children: GuiNode[];
+  android?: { background?: GuiImage };
+  ios?: {
+    backgroundColor?: GuiColor;
+    splitLine?: { color: GuiColor; width: number };
+  };
+};
+
+export type GuiImage = GuiComponent & {
+  type: 'image';
+  source: MapImageSource;
+  size?: { width: number; height: number };
+  stretch?: MapPadding;
+  child?: GuiNode;
+};
+
+export type GuiText = GuiComponent & {
+  type: 'text';
+  text: string;
+  textSize: number;
+  color: GuiColor;
+  stroke?: { color: GuiColor; width: number };
+};
+
+export type GuiButton = GuiComponent & {
+  type: 'button';
+  /** Android SDK 2.15.2 does not contain its documented button class. */
+  platform: 'ios';
+  source: MapImageSource;
+  pressedSource: MapImageSource;
+  size?: { width: number; height: number };
+  pressedSize?: { width: number; height: number };
+  child?: GuiNode;
+};
+
+export type GuiAnimatedImage = GuiComponent & {
+  type: 'animatedImage';
+  /** Android SDK 2.15.2 does not contain its documented animated-image class. */
+  platform: 'ios';
+  sources: MapImageSource[];
+  duration: number;
+  repeat?: number;
+  autoStart?: boolean;
+  size?: { width: number; height: number };
+  child?: GuiNode;
+};
+
+export type GuiNode = GuiLayout | GuiImage | GuiText | GuiButton | GuiAnimatedImage;
+
+export type MapInfoWindow = {
+  id: string;
+  position: Coordinate;
+  body: GuiNode;
+  tail?: GuiImage;
+  bodyOffset?: ScreenPoint;
+  tailOffset?: ScreenPoint;
+  visible?: boolean;
+  zIndex?: number;
+  autoMove?: { enabled: boolean; duration?: number };
+};
+
+export type MapWidget = {
+  id: string;
+  position: MapWidgetPosition;
+  root: GuiLayout;
+  visible?: boolean;
+  zIndex?: number;
+  rotation?: number;
+  ios?: {
+    backgroundColor?: GuiColor;
+    splitLine?: { color: GuiColor; width: number };
+  };
+};
+
+export type GuiInterpolation = 'linear' | 'cubicIn' | 'cubicOut' | 'cubicInOut';
+
+export type InfoWindowDropAnimation = {
+  id: string;
+  /** Info-window animators are unavailable in Android SDK 2.15.2. */
+  platform: 'ios';
+  infoWindowIds: string[];
+  duration: number;
+  pixelHeight: number;
+  interpolation?: GuiInterpolation;
+  repeat?: number;
+  hideAtStop?: boolean;
+  removeAtStop?: boolean;
+};
+
+export type MapGuiScene = {
+  infoWindows?: MapInfoWindow[];
+  widgets?: MapWidget[];
+  animations?: InfoWindowDropAnimation[];
+};
+
+export type MapGuiEvent =
+  | {
+      type: 'tap';
+      ownerType: 'infoWindow' | 'widget';
+      ownerId: string;
+      componentId: string;
+    }
+  | {
+      type: 'componentAnimationState';
+      ownerType: 'infoWindow' | 'widget';
+      ownerId: string;
+      componentId: string;
+      state: 'started' | 'paused' | 'resumed' | 'stopped' | 'unknown';
+    }
+  | {
+      type: 'guiMoveEnd';
+      ownerType: 'infoWindow' | 'widget';
+      ownerId: string;
+      position: Coordinate;
+    }
+  | { type: 'animatorStopped'; id: string };
+
+export type MapGuiCapabilities = {
+  button: boolean;
+  animatedImage: boolean;
+  infoWindowAnimation: boolean;
+  arbitraryComponentClicks: boolean;
+  componentAnimationEvents: boolean;
+  guiMoveEvents: boolean;
+  autoMoveDuration: boolean;
+};
+
+export type MapGuiStatus = {
+  infoWindows: { id: string; visible: boolean; position: Coordinate; zIndex: number }[];
+  widgets: {
+    id: string;
+    visible: boolean;
+    position: MapWidgetPosition;
+    rotation: number;
+    zIndex: number;
+  }[];
+  animations: { id: string; running: boolean }[];
+  counts: { infoWindows: number; widgets: number; animations: number };
+  capabilities: MapGuiCapabilities;
+};
+
+export type ShowInfoWindowOptions = { autoMove?: boolean; duration?: number };
+export type MoveInfoWindowOptions = { duration?: number };
+export type AnimatedImageAction = 'start' | 'pause' | 'resume' | 'stop';

package/src/types-labels.ts

@@ -0,0 +1,207 @@
+import type { Coordinate, ScreenPoint } from './types';
+import type { MapImageSource } from './types-assets';
+
+export type LabelTransition = 'none' | 'alpha' | 'scale';
+export type LabelTransitionStyle = {
+  entrance: LabelTransition;
+  exit: LabelTransition;
+  enableEntrance?: boolean;
+  enableExit?: boolean;
+};
+export type LabelTransform =
+  | 'none'
+  | 'absoluteRotation'
+  | 'default'
+  | 'absoluteRotationKeepUpright'
+  | 'absoluteRotationDecal'
+  | 'decal';
+export type LabelCompetition =
+  | 'none'
+  | 'all'
+  | 'upper'
+  | 'upperLower'
+  | 'upperSame'
+  | 'same'
+  | 'sameLower'
+  | 'lower';
+export type LabelCompetitionUnit = 'iconAndText' | 'iconFirst';
+export type LabelOrdering = 'rank' | 'leftBottom';
+export type LabelInterpolation = 'linear' | 'cubicIn' | 'cubicOut' | 'cubicInOut';
+export type LabelTextLayout = 'center' | 'top' | 'bottom' | 'left' | 'right';
+
+export type LabelBadgeStyle = {
+  id: string;
+  image: MapImageSource;
+  offset?: ScreenPoint;
+  zOrder?: number;
+};
+
+export type LabelTextLineStyle = {
+  fontFamily?: string;
+  fontSize: number;
+  color: string;
+  strokeColor?: string;
+  strokeWidth?: number;
+  /** Logical spacing; Android requires at least -2 native pixels after conversion. */
+  characterSpacing?: number;
+  /** Line-height multiplier, at least 1. Defaults to 1. */
+  lineSpacing?: number;
+  aspectRatio?: number;
+};
+
+export type PerLevelLabelStyle = {
+  level: number;
+  image?: MapImageSource;
+  anchor?: ScreenPoint;
+  padding?: number;
+  iconTransition?: LabelTransitionStyle;
+  textTransition?: LabelTransitionStyle;
+  textLayout?: LabelTextLayout;
+  textLines?: LabelTextLineStyle[];
+  badges?: LabelBadgeStyle[];
+};
+
+export type LabelStyle = { id: string; levels: PerLevelLabelStyle[] };
+export type PathTextStyle = {
+  id: string;
+  levels: { level: number; text: LabelTextLineStyle }[];
+};
+
+export type LabelLayer = {
+  id: string;
+  visible?: boolean;
+  clickable?: boolean;
+  zOrder?: number;
+  competition?: LabelCompetition;
+  competitionUnit?: LabelCompetitionUnit;
+  ordering?: LabelOrdering;
+  competitionExceptions?: string[];
+};
+
+export type LodLabelLayer = LabelLayer & { radius?: number };
+
+export type LabelText = { value: string; styleIndex?: number };
+export type LabelBadge = LabelBadgeStyle & { visible?: boolean };
+
+export type MapLabel = {
+  id: string;
+  layerId: string;
+  styleId: string;
+  coordinate: Coordinate;
+  text?: LabelText[];
+  rank?: number;
+  clickable?: boolean;
+  visible?: boolean;
+  transform?: LabelTransform;
+  pixelOffset?: ScreenPoint;
+  orientation?: number;
+  scale?: ScreenPoint;
+  badges?: LabelBadge[];
+};
+
+export type LodMapLabel = Omit<MapLabel, 'pixelOffset' | 'orientation' | 'scale'>;
+
+export type PathMapLabel = {
+  id: string;
+  layerId: string;
+  styleId: string;
+  points: Coordinate[];
+  text: string;
+  rank?: number;
+  visible?: boolean;
+};
+
+export type LabelAnimationKeyframe = {
+  duration: number;
+  interpolation?: LabelInterpolation;
+  alpha?: number;
+  scale?: ScreenPoint;
+  translation?: ScreenPoint;
+  rotation?: number;
+};
+
+export type LabelAnimation = {
+  id: string;
+  labelIds: string[];
+  effect: 'drop' | 'alpha' | 'scale' | 'scaleAlpha' | 'transform';
+  keyframes: LabelAnimationKeyframe[];
+  repeatCount?: number;
+  hideAtStop?: boolean;
+  removeAtStop?: boolean;
+  resetToInitialState?: boolean;
+};
+
+export type LabelScene = {
+  styles?: LabelStyle[];
+  pathTextStyles?: PathTextStyle[];
+  layers?: LabelLayer[];
+  lodLayers?: LodLabelLayer[];
+  labels?: MapLabel[];
+  lodLabels?: LodMapLabel[];
+  pathLabels?: PathMapLabel[];
+  animations?: LabelAnimation[];
+};
+
+export type LabelCommand =
+  | { type: 'show'; id: string; visible: boolean; autoMove?: boolean; duration?: number }
+  | { type: 'move'; id: string; coordinate: Coordinate; duration?: number }
+  | {
+      type: 'movePath';
+      id: string;
+      points: Coordinate[];
+      duration: number;
+      /** These two path parameters pass through raw SDK values; their units are undocumented. */
+      cornerRadius?: number;
+      jumpThreshold?: number;
+      rotate?: boolean;
+      baseRotation?: number;
+    }
+  | { type: 'rotate'; id: string; rotation: number; duration?: number }
+  | { type: 'scale'; id: string; scale: ScreenPoint; duration?: number }
+  | { type: 'sharePosition'; sourceId: string; targetId: string; enabled: boolean }
+  | { type: 'shareTransform'; sourceId: string; targetId: string; enabled: boolean }
+  | { type: 'shareShapeTransform'; sourceId: string; targetId: string; enabled: boolean }
+  | { type: 'setBadgeVisibility'; id: string; badgeId: string; visible: boolean; style?: boolean }
+  | { type: 'startAnimation'; id: string }
+  | { type: 'stopAnimation'; id: string }
+  | { type: 'startTracking'; id: string; rotate?: boolean }
+  | { type: 'stopTracking' };
+
+export type LabelClickEvent = {
+  id: string;
+  layerId: string;
+  kind: 'label' | 'lodLabel';
+  coordinate: Coordinate;
+};
+
+export type LabelAnimationEvent = { id: string; finished: boolean };
+
+export type LabelCapabilities = {
+  pathText: 'polylineLabel' | 'waveText';
+  pathTextRank: boolean;
+  pathTextStyleAddition: true;
+  pathTextStyleDefinitionUpdate: boolean;
+  pathTextStyleRegistrationRemoval: boolean;
+  lodPositionMutation: false;
+  lodAutoMove: boolean;
+  autoMoveDuration: boolean;
+  labelScaleCommand: boolean;
+  sharedShapeTransform: boolean;
+  sharedShapeTarget: 'polygon' | 'shape';
+  competitionExceptions: boolean;
+  supportedTransforms: LabelTransform[];
+  keyframeRepeatCount: false;
+  trackingStateSource: 'native' | 'managed';
+  remoteImages: boolean;
+};
+
+export type LabelRuntimeState = {
+  labels: (
+    | { id: string; kind: 'label'; visible: boolean; coordinate: Coordinate }
+    /** iOS does not expose the current LOD label position. */
+    | { id: string; kind: 'lodLabel'; visible: boolean; coordinate?: Coordinate }
+    | { id: string; kind: 'pathLabel'; visible: boolean }
+  )[];
+  animationIds: string[];
+  tracking: { active: boolean; source: 'native' | 'managed' };
+};

package/src/types-routes.ts

@@ -0,0 +1,118 @@
+import type { Coordinate } from './types';
+import type { MapImageSource } from './types-assets';
+import type { ShapeColor, ShapeInterpolation } from './types-shapes';
+
+export type RoutePattern = {
+  /** Kakao route patterns use the source bitmap size; width and height overrides are rejected. */
+  image: MapImageSource;
+  /** Kakao route symbols use the source bitmap size; width and height overrides are rejected. */
+  symbol?: MapImageSource;
+  /** Density-independent pixels between patterns. */
+  distance: number;
+  pinStart?: boolean;
+  pinEnd?: boolean;
+};
+
+export type RouteStyleLevel = {
+  level: number;
+  /** Density-independent pixels. */
+  width: number;
+  color: ShapeColor;
+  /** Density-independent pixels. */
+  strokeWidth?: number;
+  strokeColor?: ShapeColor;
+  patternIndex?: number;
+};
+
+export type RouteStyleSet = {
+  id: string;
+  styles: { levels: RouteStyleLevel[] }[];
+  patterns?: RoutePattern[];
+};
+
+export type RouteLayerSpec = { id: string; zIndex?: number; visible?: boolean };
+
+export type RouteSegmentSpec = {
+  coordinates: Coordinate[];
+  styleIndex?: number;
+  /** Curves connect every adjacent coordinate pair. */
+  curve?: 'none' | 'left' | 'right';
+};
+
+export type RouteSpec = {
+  id: string;
+  layerId: string;
+  styleSetId: string;
+  zIndex?: number;
+  visible?: boolean;
+  segments: RouteSegmentSpec[];
+};
+
+export type RouteScene = {
+  styleSets?: RouteStyleSet[];
+  layers?: RouteLayerSpec[];
+  routes?: RouteSpec[];
+};
+
+export type RouteProgressAnimation = {
+  animationId: string;
+  routeIds: string[];
+  direction: 'forward' | 'backward';
+  mode: 'fill' | 'clear';
+  duration: number;
+  interpolation?: ShapeInterpolation;
+  repeat?: number;
+  hideAtStop?: boolean;
+  resetToInitial?: boolean;
+};
+
+export type RouteCommand =
+  | { type: 'setVisible'; ids: string[]; visible: boolean }
+  | { type: 'setZIndex'; id: string; zIndex: number }
+  | { type: 'changeData'; id: string; styleSetId: string; segments: RouteSegmentSpec[] }
+  | { type: 'setProgress'; id: string; progress: number; mode: 'fill' | 'clear'; duration?: number }
+  | { type: 'getProgress'; id: string }
+  | { type: 'getRequestedProgress'; id: string }
+  | { type: 'getProgressAtCoordinate'; id: string; coordinate: Coordinate }
+  | { type: 'getCoordinateAtProgress'; id: string; progress: number }
+  | { type: 'getState'; id: string }
+  | { type: 'getCounts' }
+  | { type: 'getCapabilities' }
+  | { type: 'startProgressAnimation'; animation: RouteProgressAnimation }
+  | { type: 'stopAnimation'; animationId: string }
+  | { type: 'remove'; ids: string[] };
+
+export type RouteCounts = { type: 'counts'; layers: number; routes: number; animations: number };
+
+export type RouteCommandResult =
+  | { type: 'none' }
+  | { type: 'progress'; progress: number; source: 'native' | 'requested' }
+  | ({ type: 'coordinate'; orientation?: number } & Coordinate)
+  | {
+      type: 'state';
+      id: string;
+      layerId: string;
+      visible: boolean;
+      zIndex: number;
+      nativeProgress: number | null;
+      requestedProgress: number;
+    }
+  | RouteCounts
+  | ({ type: 'capabilities' } & RouteCapabilities);
+
+export type RouteCapabilities = {
+  curves: boolean;
+  patterns: boolean;
+  patternSymbols: boolean;
+  patternImageSizing: boolean;
+  progressAtCoordinate: boolean;
+  coordinateAtProgress: boolean;
+  nativeProgressRead: boolean;
+  fractionalStyleWidth: boolean;
+  progressAnimationRepeat: boolean;
+};
+
+export type RouteAnimationStopEvent = { animationId: string };
+
+/** Completion of the latest requested route progress transition, not a native progress measurement. */
+export type RouteProgressEvent = { id: string; progress: number; source: 'requested' };