import type { Options as ControlOptions } from 'ol/control/Control'
import ol_control_Control from 'ol/control/Control'
import type { Coordinate } from 'ol/coordinate'
import type { EventsKey } from 'ol/events'
import BaseEvent from 'ol/events/Event'
import type { ObjectEvent } from 'ol/Object'
import type { Types } from 'ol/ObjectEventType'
import type { CombinedOnSignature, EventTypes, OnSignature } from 'ol/Observable'

export type GeoBookmarkOnSignature<Return> = OnSignature<EventTypes, Event, Return> &
  OnSignature<Types | 'change' | 'error' | 'propertychange', ObjectEvent, Return> &
  OnSignature<Types | 'add' | 'remove' | 'select', BookmarkEvent, Return> &
  CombinedOnSignature<EventTypes | Types | 'change' | 'error' | 'propertychange' | 'add' | 'remove' | 'select', Return>;

export interface BookmarkContent {
  pos: number[];
  zoom: number;
  permanent?: boolean;
  rot?: number;
}

export type Bookmarks = { [key: string]: BookmarkContent }

export interface Options extends ControlOptions {
  className?: string;
  placeholder?: string;
  deleteTitle?: string;
  editable?: boolean;
  namespace?: string;
  marks?: Bookmarks;
}

/** Bookmark positions on ol maps.
 *
 * @constructor
 * @extends {ol_control_Control}
 * @fires add
 * @fires remove
 * @fires select
 * @see [Geobookmark example](../../examples/control/map.control.geobookmark.html)
 * @example
 var bm = new GeoBookmark ({
  marks: {
    "Paris": {pos:ol.proj.transform([2.351828, 48.856578], 'EPSG:4326', 'EPSG:3857'), zoom:11, permanent: true },
    "London": {pos:ol.proj.transform([-0.1275,51.507222], 'EPSG:4326', 'EPSG:3857'), zoom:12}
  }
});
 */
export default class GeoBookmark extends ol_control_Control {
  /**
   * @param {} options Geobookmark's options
   *  @param {string} options.className default ol-bookmark
   *  @param {string | undefined} options.title Title to use for the button tooltip, default "Geobookmarks"
   *  @param {string} options.placeholder input placeholder, default Add a new geomark...
   *  @param {string} [options.deleteTitle='Suppr.'] title for delete buttons
   *  @param {bool} options.editable enable modification, default true
   *  @param {string} options.namespace a namespace to save the boolmark (if more than one on a page), default ol
   *  @param {Array<any>} options.marks a list of default bookmarks:
   */
  constructor(options?: Options);

  /** Set bookmarks
   * @param {} bmark a list of bookmarks, default retreave in the localstorage
   * @example
   bm.setBookmarks({
    "Paris": {pos:_ol_proj_.transform([2.351828, 48.856578], 'EPSG:4326', 'EPSG:3857'), zoom:11, permanent: true },
    "London": {pos:_ol_proj_.transform([-0.1275,51.507222], 'EPSG:4326', 'EPSG:3857'), zoom:12}
  });
   */
  setBookmarks(bmark: Bookmarks): void;

  /** Get Geo bookmarks
   * @return {any} a list of bookmarks : { BM1:{pos:Coordinates, zoom: number}, BM2:{pos:Coordinates, zoom: number} }
   */
  getBookmarks(): Bookmarks;

  /** Remove a Geo bookmark
   * @param {string} name
   */
  removeBookmark(name: string): void;

  /** Add a new Geo bookmark (replace existing one if any)
   * @param {string} name name of the bookmark (display in the menu)
   * @param {Coordinate} position default current position
   * @param {number} zoom default current map zoom
   * @param {bool} permanent prevent from deletion, default false
   */
  addBookmark(name: string, position?: Coordinate, zoom?: number, permanent?: boolean): void;

  on: GeoBookmarkOnSignature<EventsKey>

  once: GeoBookmarkOnSignature<EventsKey>

  un: GeoBookmarkOnSignature<void>
}

export class BookmarkEvent extends BaseEvent {
  constructor(
    // @ts-ignore TODO fix it
    type: BookMarkEventType,
    name: string,
    bm?: BookmarkContent
  );

  name: string

  bm?: BookmarkContent
}