import type {Bud, Registry} from '@roots/bud-framework'

/**
 * Hooks service
 */
export interface Hooks {
  /**
   * Store callback to an action handler
   */
  action: <T extends `${keyof Registry.Events & string}`>(
    id: T,
    ...input: Array<Registry.EventsCallback<T>>
  ) => Bud
  /**
   * Register an async function to filter a value.
   *
   * @example
   * ```js
   * app.hooks.on(
   *   'namespace.name.value',
   *   value => 'replaced by this string',
   * )
   * ```
   */
  async: <T extends `${keyof Registry.AsyncStore & string}`>(
    id: T,
    value: Registry.AsyncCallback[T],
  ) => Bud

  /**
   * Async hooks value store
   */
  asyncStore: any

  /**
   * Events value store
   */
  events: any

  /**
   * Filter a value
   *
   * @example
   * ```js
   * bud.hooks.filter(
   *   'namespace.name.event',
   *   ['array', 'of', 'items'],
   * )
   * ```
   */
  filter: <K extends `${keyof Registry.SyncRegistry & string}`>(
    id: K,
    callback?: Registry.SyncRegistry[K],
  ) => Registry.SyncRegistry[K]

  /**
   * Async version of hook.filter
   *
   * @remarks
   * Hooks are processed as a waterfall.
   *
   * @example
   * ```js
   * bud.hooks.filter(
   *   'namespace.name.event',
   *   ['array', 'of', 'items'],
   * )
   * ```
   */
  filterAsync: <T extends keyof Registry.AsyncRegistry & string>(
    id: T,
    fallback?: Registry.AsyncCallback[T],
  ) => Promise<Registry.AsyncRegistry[T]>

  /**
   * Execute an action
   */
  fire: <T extends `${keyof Registry.Events & string}`>(
    id: T,
    ...obj: Registry.Events[T]
  ) => Promise<Bud>

  /**
   * Register a recordset of functions or values to modify or replace existing values
   *
   * @example
   * ```js
   * app.hooks.fromAsyncMap({
   *  'namespace.name.value': 'replaced by this string',
   * 'namespace.name.value2': async value => value.push('modified by this string'),
   * })
   * ```
   */
  fromAsyncMap: (map: Registry.AsyncCallback) => Bud

  /**
   * Register a recordset of functions or values to modify or replace existing values
   *
   * @example
   * ```js
   * app.hooks.fromMap({
   *  'namespace.name.value': 'replaced by this string',
   * 'namespace.name.value2': value => value.push('modified by this string'),
   * })
   * ```
   */
  fromMap: (map: Partial<Registry.SyncCallback>) => Bud

  hasAsyncHook: (hook: keyof Registry.AsyncStore) => boolean

  hasEvent: (hook: keyof Registry.EventsStore) => boolean

  hasSyncHook: (hook: keyof Registry.SyncStore) => boolean

  /**
   * Register a function or value to modify or replace a filtered value
   *
   * @example
   * ```js
   * app.hooks.on(
   *   'namespace.name.value',
   *   value => 'replaced by this string',
   * )
   * ```
   */
  on: <T extends `${keyof Registry.SyncStore & string}`>(
    id: T,
    input: Registry.SyncCallback[T],
  ) => Bud

  /**
   * Sync hooks value store
   */
  syncStore: any
}