/*!
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

import jqXHR = JQuery.jqXHR;
import { ExtendedKeyboardEvent } from 'mousetrap';

declare global {
  import PlainObject = JQuery.PlainObject;
  type QueryParameterValue = string | number | null | undefined | QueryParameterValue[];
  type QueryParameters = Record<string, QueryParameterValue | QueryParameters>;

  class DataTable_RowAction {
    protected dataTable: any;
    public actionName: string;
    public trEventName: string;

    constructor(dataTable: any);

    openPopover(apiAction: string, idSubtable: string|number, extraParams: QueryParameters);
    trigger(tr: HTMLElement|JQuery, originalEvent: Event, subTableLabel: string);
    performAction(idSubtable: string|number, tr: HTMLElement|JQuery, originalEvent: Event);
    doOpenPopover(urlParam: string);
  }

  interface WrappedEventListener extends Function {
    wrapper?: (evt: Event) => void;
  }

  /**
   * global ajax queue
   *
   * @type {Array} array holding XhrRequests with automatic cleanup
   */
  interface GlobalAjaxQueue extends Array<XMLHttpRequest|null> {
    active:number;

    /**
     * Removes all finished requests from the queue.
     *
     * @return {void}
     */
    clean();

    /**
     * Extend Array.push with automatic cleanup for finished requests
     *
     * @return {Object}
     */
    push(...args: (XMLHttpRequest|jqXHR|null)[]);

    /**
     * Extend with abort function to abort all queued requests
     *
     * @return {void}
     */
    abort();
  }

  interface PiwikPopoverGlobal {
    isOpen();
    close();
    setTitle(title: string): void;
    setContent(html: string|HTMLElement|JQuery|JQLite): void;
    showError(title: string, message?: string, backLabel?: string): void;
    showLoading(loadingName: string, popoverSubject?: string, height?: number, dialogClass?: string): JQuery;
    onClose(fn: () => void);
    createPopupAndLoadUrl(url: string, loadingName: string, dialogClass?: string, ajaxRequest?: QueryParameters): void;
  }

  let Piwik_Popover: PiwikPopoverGlobal;

  type ModalConfirmCallbacks = Record<string, () => void>;

  interface ModalConfirmOptions {
    onCloseEnd?: () => void;
    fixedFooter?: boolean;
  }

  interface PiwikHelperGlobal {
    escape(text: string): string;
    redirect(params?: any);
    getCurrentQueryStringWithParametersModified(newparams: string);
    htmlDecode(encoded: string): string;
    htmlEntities(value: string): string;
    normalize(value: string): string;
    modalConfirm(element: JQuery|HTMLElement|string, callbacks?: ModalConfirmCallbacks, options?: ModalConfirmOptions);
    isReportingPage(): boolean;
    setMarginLeftToBeInViewport(elementToPosition: JQuery|Element|string): void;
    lazyScrollTo(element: JQuery|HTMLElement|string, time: number, forceScroll?: boolean): void;
    lazyScrollToContent(): void;
    registerShortcut(key: string, description: string, callback: (event: ExtendedKeyboardEvent) => void): void;
    compileVueEntryComponents(selector: JQuery|HTMLElement|string, extraProps?: Record<string, unknown>): void;
    destroyVueComponent(selector: JQuery|HTMLElement|string): void;
    compileVueDirectives(selector: JQuery|HTMLElement|string): void;
    calculateEvolution(currentValue: number, pastValue?: number|null): number;
    sendContentAsDownload(filename: string, content: any, mimeType?: string): void;
    showVisitorProfilePopup(visitorId: string, idSite: string|number): void;
    hideAjaxError(): void;
    showAjaxLoading(loadingDivID?: string): void;
    hideAjaxLoading(loadingDivID?: string): void;
    refreshAfter(timeoutPeriod: number): void;
  }

  let piwikHelper: PiwikHelperGlobal;

  interface BroadcastGlobal {
    getValueFromUrl(paramName: string, url?: string): string;
    getValuesFromUrl(paramName: string, decode?: boolean): QueryParameters;
    getValueFromHash(paramName: string, url?: string): string;
    isWidgetizeRequestWithoutSession(): boolean;
    updateParamValue(newParamValue: string, urlStr: string): string;
    propagateNewPage(str?: string, showAjaxLoading?: boolean, strHash?: string, paramsToRemove?: string[], wholeNewUrl?: string);
    propagateNewPopoverParameter(handleName: string, value?: string);
    buildReportingUrl(ajaxUrl: string): string;
    isLoginPage(): boolean;
    isNoDataPage(): boolean;
    resetPopoverStack(): void;
    addPopoverHandler(handlerName: string, callback: (string) => void): void;

    popoverHandlers: Record<string, (param: string) => void>;
  }

  let broadcast: BroadcastGlobal;

  interface ColorManagerService {
    getColor(namespace: string, name: string): string;
    getColors(namespace: string, names: string[], asArray?: boolean): string[]|{[name: string]: string};
  }

  interface SparklineColors extends Record<string, string> {
    lineColor: string[];
  }

  interface PiwikGlobal {
    installation: boolean; // only set while Matomo is installing
    timezoneOffset: number;
    addCustomPeriod: (name: string, periodClass: any) => void;
    shouldPropagateTokenAuth: boolean;
    token_auth: string;
    idSite: string|number;
    /**
     * @deprecated
     */
    siteName: string;
    currentSiteName: string;
    siteMainUrl?: string;
    period?: string;
    currentDateString?: string;
    startDateString?: string;
    endDateString?: string;
    userCapabilities: string[];
    piwik_url: string;
    helper: PiwikHelperGlobal;
    broadcast: BroadcastGlobal;
    ColorManager: ColorManagerService;
    ajaxRequestFinished?: () => void;
    minDateYear: number;
    minDateMonth: number;
    minDateDay: number;
    maxDateYear: number;
    maxDateMonth: number;
    maxDateDay: number;
    config: Record<string, string|number|string[]>;
    hasSuperUserAccess: boolean;
    language: string;
    cacheBuster: string;
    numbers: Record<string, any>;
    visitorProfileEnabled: boolean;
    languageName: string;
    isPagesComparisonApiDisabled: boolean; // can be set to avoid checks on Api.getPagesComparisonsDisabledFor
    userLogin?: string;
    userCurrentRole: string;
    isUserAnonymous: boolean;
    userHasSomeAdminAccess: boolean;
    requiresPasswordConfirmation: boolean;
    disableTrackingMatomoAppLinks: boolean;
    apiBulkRequestLimit: number;

    visitorLogEnabled: boolean;
    updatePeriodParamsFromUrl(): void;
    updateTitle(date: string, period: string, c: string, s: string, segment?: string): void;
    hasUserCapability(capability: string): boolean;
    getLoginModule(): string;
    getBaseDatePickerOptions(defaultDate?: Date|null): {[key: string]: any};
    getSparklineColors(): SparklineColors;
    getBaseDatePickerOptions(defaultDate: Date|null): any;
    getThemeMode(): string;
    setThemeMode(preferredThemeMode: string): void;

    on(eventName: string, listener: WrappedEventListener): void;
    off(eventName: string, listener: WrappedEventListener): void;
    postEvent(eventName: string, ...args: any[]): void;
    postEventNoEmit(eventName: string, ...args: any[]): void;
  }

  let piwik: PiwikGlobal;

  interface WidgetsHelper {
    availableWidgets?: unknown[];
    getAvailableWidgets(callback?: (widgets: Record<string, unknown[]>) => unknown);
    clearAvailableWidgets();
    getWidgetObjectFromUniqueId(id: string, callback: (widget: unknown) => void);

    firstGetAvailableWidgetsCall?: Promise<void>;
  }

  let widgetsHelper: WidgetsHelper;

  interface ListingFormatter {
    formatAnd(values: string[]): string;
    formatOr(values: string[]): string;
  }

  interface Transitions {
    reset(actionType: string, actionName: string, overrideParams: string);
    showPopover(showEmbeddedInReport: boolean): void;
  }

  interface TransitionsGlobal {
    new (actionType: string, actionName: string, rowAction: unknown|null, overrideParams: string): Transitions;
  }

  interface SegmentedVisitorLogService {
    show(apiMethod: string, segment: string, extraParams: Record<string|number, unknown>): void;
  }

  interface VisibilityGlobal {
    isSupported: () => boolean;
    hidden: () => boolean;
    change: (callback: (event?: Event, state?: unknown) => void) => number | null;
    unbind: (id: number) => void;
  }

  interface RowAction {
    name: string;
    dataTableIcon: string;
    order: number;
    dataTableIconTooltip?: string[];
    isAvailableOnReport(dataTableParams: QueryParameters, tr: HTMLElement|JQuery): boolean;
    isAvailableOnRow(dataTableParams: QueryParameters, tr: HTMLElement|JQuery): boolean;
    createInstance(dataTable: any, urlParam: string): DataTable_RowAction;
  }

  interface DataTableRowActionsRegisteryService {
    register(rowAction: RowAction);
  }

  // the jquery type defs have trouble with $(HTMLElement | string | ...), so adding an overload
  // specifically for that
  interface JQueryStaticResolve {
    (selector: HTMLElement | string | JQuery | PlainObject, context?: Element | Document | JQuery | JQuery.Selector): JQuery;
  }

  interface Window {
    globalAjaxQueue: GlobalAjaxQueue;
    piwik: PiwikGlobal;
    piwikHelper: PiwikHelperGlobal;
    broadcast: BroadcastGlobal;
    hasBlockedContent: boolean;
    piwik_translations: {[key: string]: string};
    Materialize: M;
    widgetsHelper: WidgetsHelper;
    $: JQueryStatic & JQueryStaticResolve;
    Piwik_Popover: PiwikPopoverGlobal;
    ListingFormatter: ListingFormatter;
    Piwik_Transitions: TransitionsGlobal;
    SegmentedVisitorLog: SegmentedVisitorLogService;
    DataTable_RowActions_Registry: DataTableRowActionsRegisteryService;
    Visibility?: VisibilityGlobal;
    Cloud: any;

    _pk_translate(translationStringId: string, values: (string|number|boolean)[]): string;
    _pk_externalRawLink(url: string, values: (string|null)[]): string;
    require(p: string): any;
    initTopControls(): void;
    initializeSparklines(): void;
    vueSanitize(content: string): string;
    vueSanitizeUrl(url: string): string;
    showEmptyDashboardNotification(): void;
  }
}

declare module '@vue/runtime-core' {
  export interface ComponentCustomProperties {
    translate: (translationStringId: string, ...values: string[]|string[][]) => string;
    translateOrDefault: (translationStringIdOrText: string, ...values: string[]|string[][]) => string;
    $sanitize: Window['vueSanitize'];
    $sanitizeUrl: Window['vueSanitizeUrl'];
    externalLink: (url: string, ...values:string[]) => string;
    externalRawLink: (url: string, ...values:string[]) => string;
    formatNumber: (val: string|number, maxFractionDigits?: number, minFractionDigits?: number) => string;
    formatPercent: (val: string|number, maxFractionDigits?: number, minFractionDigits?: number) => string;
    formatCurrency: (val: string|number, cur: string, maxFractionDigits?: number, minFractionDigits?: number) => string;
    formatEvolution: (val: string|number, maxFractionDigits?: number, minFractionDigits?: number, noSign?: boolean) => string;
    calculateAndFormatEvolution: (valCur: string|number, valPrev: string|number, noSign?: boolean) => string;
  }
}
