import type { PluginListenerHandle } from '@capacitor/core';

export interface NetworkPlugin {
  /**
   * Query the current status of the network connection.
   *
   * @since 1.0.0
   */
  getStatus(): Promise<ConnectionStatus>;

  /**
   * Listen for changes in the network connection.
   *
   * @since 1.0.0
   */
  addListener(
    eventName: 'networkStatusChange',
    listenerFunc: ConnectionStatusChangeListener,
  ): Promise<PluginListenerHandle> & PluginListenerHandle;

  /**
   * Remove all listeners (including the network status changes) for this plugin.
   *
   * @since 1.0.0
   */
  removeAllListeners(): Promise<void>;
}

/**
 * Represents the state and type of the network connection.
 *
 * @since 1.0.0
 */
export interface ConnectionStatus {
  /**
   * Whether there is an active connection or not.
   *
   * @since 1.0.0
   */
  connected: boolean;

  /**
   * The type of network connection currently in use.
   *
   * If there is no active network connection, `connectionType` will be `'none'`.
   *
   * @since 1.0.0
   */
  connectionType: ConnectionType;
}

/**
 * Callback to receive the status change notifications.
 *
 * @since 1.0.0
 */
export type ConnectionStatusChangeListener = (status: ConnectionStatus) => void;

/**
 * The type of network connection that a device might have.
 *
 * @since 1.0.0
 */
export type ConnectionType = 'wifi' | 'cellular' | 'none' | 'unknown';

/**
 * @deprecated Use `ConnectionStatus`.
 * @since 1.0.0
 */
export type NetworkStatus = ConnectionStatus;

/**
 * @deprecated Use `ConnectionStatusChangeListener`.
 * @since 1.0.0
 */
export type NetworkStatusChangeCallback = ConnectionStatusChangeListener;