types.d.ts

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import type { XULBrowserWindow } from "components/XULBrowserWindow.sys.mjs";
import "./mozbuild";
import "./third_party/dothq/gecko-types";
import * as Gecko from "./third_party/dothq/gecko-types/lib";
import type { DotBrowserWindow } from "components/DotBrowserWindow.sys.mjs";

type MozXULElement = {
	prototype: Gecko.MozXULElement;
	new (): Gecko.MozXULElement;
} & Gecko.MozElementMixinStatic;

type MozHTMLElement = {
	prototype: Gecko.MozHTMLElement;
	new (): Gecko.MozHTMLElement;
} & Gecko.MozElementMixinStatic;

declare global {
	/* Only available in secure contexts */
	interface Screen {
		availTop: number;
		availLeft: number;
	}

	var BrowserUIUtils: Gecko.BrowserUIUtils;
    var PathUtils: Gecko.PathUtils;
    var IOUtils: Gecko.IOUtils;

	var gDot: BrowserApplication;
	var gDotInit: typeof gDotInit;
	var XULBrowserWindow: XULBrowserWindow;
	var browserDOMWindow: DotBrowserWindow;

	var XULElement: Gecko.XULElement;
	var XULFrameElement: Gecko.XULElement;
	var XULMenuElement: Gecko.XULElement;
	var XULPopupElement: Gecko.XULPopupElement;
	var XULResizerElement: Gecko.XULElement;
	var XULTextElement: Gecko.XULElement;
	var XULTreeElement: Gecko.XULElement;

	var MozXULElement: MozXULElement;
	var MozHTMLElement: MozHTMLElement;

	var MozElements: Gecko.MozElements;

	var BrowsingContext: Gecko.BrowsingContextGlobal;

	var WebExtensionPolicy: Gecko.WebExtensionPolicy;

	var Localization: Gecko.Localization;

	/**
	 * browser-compat is used as a compatibility layer to translate Dot APIs to the original FF/Gecko APIs
	 *
	 * When building Dot Browser, we eventually need to use existing code built by Mozilla, and we don't really
	 * want to move code into the Dot tree that could easily be changed upstream.
	 *
	 * For this reason, it's easier for us to create a compatibility layer between our APIs and the Mozilla APIs,
	 * to avoid breaking these important scripts.
	 *
	 * @deprecated You shouldn't use this in Dot code directly! This is purely intended for use by existing Mozilla modules and scripts to maintain compatibility.
	 */
	var gBrowser: typeof gBrowser;

	interface Window {
		html: (
			tagName: string,
			attributes?: { [key: string]: string | boolean | number },
			...children: Array<HTMLElement | string>
		) => HTMLElement;
		arguments: any;
		CSS: typeof CSS;
		openDialog: (
			url?: string,
			target?: string,
			features?: string,
			...extraArguments: any[]
		) => Window;
		MozXULElement: MozXULElement;
		MozHTMLElement: MozHTMLElement;
		gDot: BrowserApplication;
		minimize(): void;
		maximize(): void;
		restore(): void;
		fullScreen: boolean;
		STATE_MAXIMIZED: 1;
		STATE_MINIMIZED: 2;
		STATE_NORMAL: 3;
		STATE_FULLSCREEN: 4;
		windowState: number;
		gDotInit: typeof gDotInit;
		mozInnerScreenX: number;
		mozInnerScreenY: number;
		windowRoot: Gecko.WindowRoot;
        browsingContext: Gecko.BrowsingContext;
        promiseDocumentFlushed: (callback: Function) => Promise<any>
        XULBrowserWindow: XULBrowserWindow;
        browserDOMWindow: DotBrowserWindow;
	}

	interface Document {
		l10n: Gecko.LocalizationInstance;
		commandDispatcher: Gecko.nsIDOMXULCommandDispatcher;
	}

	interface Event {
		defaultCancelled: boolean;
		defaultPreventedByChrome: boolean;
        composedTarget: EventTarget;
	}

	interface Console {
		createInstance: (options: {
			// An optional function to intercept all strings written to stdout.
			dump?: (message: string) => void;

			// An optional prefix string to be printed before the actual logged message.
			prefix?: string;

			// An ID representing the source of the message. Normally the inner ID of a
			// DOM window.
			innerID?: string;

			// String identified for the console, this will be passed through the console
			// notifications.
			consoleID?: string;

			// Identifier that allows to filter which messages are logged based on their
			// log level.
			maxLogLevel?:
				| "All"
				| "Debug"
				| "Log"
				| "Info"
				| "Clear"
				| "Trace"
				| "TimeLog"
				| "TimeEnd"
				| "Time"
				| "Group"
				| "GroupEnd"
				| "Profile"
				| "ProfileEnd"
				| "Dir"
				| "Dirxml"
				| "Warn"
				| "Error"
				| "Off";

			// String pref name which contains the level to use for maxLogLevel. If the
			// pref doesn't exist, gets removed or it is used in workers, the maxLogLevel
			// will default to the value passed to this constructor (or "all" if it wasn't
			// specified).
			maxLogLevelPref?: string;
		}) => Console;
	}

    interface CustomElementRegistry {
        getName(constructor: CustomElementConstructor): string | undefined;
    }

    interface Element {
        scrollTopMin: number;
        scrollTopMax: number;

        scrollLeftMin: number;
        scrollLeftMax: number;
    }

    interface Node {
        nodePrincipal: any /** @todo: nsIPrincipal */;
    }
}