Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Types for Opera API #3631

Merged
merged 4 commits into from
Sep 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 131 additions & 1 deletion apps/browser/src/globals.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,134 @@
declare function escape(s: string): string;
declare function unescape(s: string): string;
declare let opr: any;
/**
* @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>;
};

type Opera = {
addons: OperaAddons;
sidebarAction: OperaSidebarAction;
};

declare namespace chrome {
/**
* This is for firefoxes 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
*/
let sidebarAction:
| Omit<
OperaSidebarAction,
| "setBadgeText"
| "getBadgeText"
| "setBadgeBackgroundColor"
| "getBadgeBackgroundColor"
| "onFocus"
| "onBlur"
>
| undefined;
}

interface Window {
opr: Opera | undefined;
opera: unknown;
}

declare let opr: Opera | undefined;
declare let opera: unknown | undefined;
declare let safari: any;
8 changes: 4 additions & 4 deletions apps/browser/src/services/browserPlatformUtils.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ export default class BrowserPlatformUtilsService implements PlatformUtilsService
) {
this.deviceCache = DeviceType.FirefoxExtension;
} else if (
(!!(window as any).opr && !!opr.addons) ||
!!(window as any).opera ||
(self.opr && self.opr.addons) ||
self.opera ||
navigator.userAgent.indexOf(" OPR/") >= 0
) {
this.deviceCache = DeviceType.OperaExtension;
} else if (navigator.userAgent.indexOf(" Edg/") !== -1) {
this.deviceCache = DeviceType.EdgeExtension;
} else if (navigator.userAgent.indexOf(" Vivaldi/") !== -1) {
this.deviceCache = DeviceType.VivaldiExtension;
} else if ((window as any).chrome && navigator.userAgent.indexOf(" Chrome/") !== -1) {
} else if (window.chrome && navigator.userAgent.indexOf(" Chrome/") !== -1) {
this.deviceCache = DeviceType.ChromeExtension;
} else if (navigator.userAgent.indexOf(" Safari/") !== -1) {
this.deviceCache = DeviceType.SafariExtension;
Expand Down Expand Up @@ -335,7 +335,7 @@ export default class BrowserPlatformUtilsService implements PlatformUtilsService
}

sidebarViewName(): string {
if ((window as any).chrome.sidebarAction && this.isFirefox()) {
if (window.chrome.sidebarAction && this.isFirefox()) {
return "sidebar";
} else if (this.isOpera() && typeof opr !== "undefined" && opr.sidebarAction) {
return "sidebar_panel";
Expand Down