1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-09-18 02:41:15 +02:00
bitwarden-browser/apps/browser/src/globals.d.ts
Matt Gibson b4ac5a8bef
Ps 1291 fix extension icon updates (#3571)
* Add needed factories for AuthService

WIP: Allow console logs

* Add badge updates

* Init by listener

* Improve tab identification

* Define MV3 background init

* Init services in factories.

Requires conversion of all factories to promises.

We need to initialize in factory since the requester of a service
doesn't necessarily know all dependencies for that service. The only
alternative is to create an out parameter for a
generated init function, which isn't ideal.

* Improve badge setting

* Use `update-badge` in mv2 and mv3

Separates menu and badge updates

* Use update-badge everywhere

* Use BrowserApi where possible

* Update factories

* Merge duplicated methods

* Continue using private mode messager for now

* Add static platform determination.

* Break down methods and extract BrowserApi Concerns

* Prefer strict equals

* Init two-factor service in factory

* Use globalThis types

* Prefer `globalThis`

* Use Window type definition updated with Opera

Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com>

* Distinguish Opera from Safari

Opera includes Gecko, Chrome, Safari, and Opera in its user agent. We need to make sure that
we're not in Opera prior to testing Safari.

* Update import

* Initialize search-service for update badge context

* Build all browser MV3 artifacts

only uploading Chrome, Edge and Opera artifacts for now, as those support manifest V3

Also corrects build artifact to lower case.

* Remove individual dist

Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com>
Co-authored-by: Justin Baur <19896123+justindbaur@users.noreply.github.com>
2022-10-19 08:55:57 -05:00

135 lines
3.7 KiB
TypeScript

declare function escape(s: string): string;
declare function unescape(s: string): string;
/**
* @link https://dev.opera.com/extensions/addons-api/
*/
type OperaAddons = {
/**
* @link https://dev.opera.com/extensions/addons-api/#method-installextension
*/
installExtension: (
id: string,
success_callback: () => void,
error_callback: (errorMessage: string) => void
) => void;
};
type OperaEvent<T> = {
addListener: (callback: (state: T) => void) => void;
};
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#type-colorarray
*/
type ColorArray = [number, number, number, number];
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#type-imagedatatype
*/
type ImageDataType = ImageData;
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/
*/
type OperaSidebarAction = {
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-settitle
*/
setTitle: (details: { title: string; tabId?: number }) => void;
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-gettitle
*/
getTitle: (details: { tabId?: number }, callback: (result: string) => void) => void;
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-seticon
*/
setIcon: (
details: {
imageData?: ImageDataType | Record<number, ImageDataType>;
path?: string | Record<number, string>;
tabId?: number;
},
callback?: () => void
) => void;
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-setpanel
*/
setPanel: (details: { tabId?: number; panel: string }) => void;
/**
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-getpanel
*/
getPanel: (details: { tabId?: number }, callback: (result: string) => void) => void;
/**
* *Not supported on mac*
*
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-setbadgetext
*/
setBadgeText: (details: { text: string; tabId?: number }) => void;
/**
* *Not supported on mac*
*
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-getbadgetext
*/
getBadgeText: (details: { tabId?: number }, callback: (result: string) => void) => void;
/**
* *Not supported on mac*
*
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-setbadgebackgroundcolor
*/
setBadgeBackgroundColor: (details: { color: ColorArray | string; tabId?: number }) => void;
/**
* *Not supported on mac*
*
* @link https://dev.opera.com/extensions/sidebar-action-api/#method-getbadgebackgroundcolor
*/
getBadgeBackgroundColor: (
details: { tabId?: number },
callback: (result: ColorArray) => void
) => void;
/**
* *Not supported on mac*
*
* @link https://dev.opera.com/extensions/sidebar-action-api/#events-onfocus
*/
onFocus: OperaEvent<Window>;
/**
* *Not supported on mac*
*
* @link https://dev.opera.com/extensions/sidebar-action-api/#events-onblur
*/
onBlur: OperaEvent<Window>;
};
/**
* This is for firefox's sidebar action and it is based on the opera one but with a few less methods
*
* @link https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sidebarAction
*/
type FirefoxSidebarAction = Omit<
OperaSidebarAction,
| "setBadgeText"
| "getBadgeText"
| "setBadgeBackgroundColor"
| "getBadgeBackgroundColor"
| "onFocus"
| "onBlur"
>;
type Opera = {
addons: OperaAddons;
sidebarAction: OperaSidebarAction;
};
declare namespace chrome {
let sidebarAction: FirefoxSidebarAction | undefined;
}
interface Window {
opr: Opera | undefined;
opera: unknown;
}
declare let opr: Opera | undefined;
declare let opera: unknown | undefined;
declare let safari: any;