webext-messenger 0.23.1 → 0.24.0
Sign up to get free protection for your applications and to get access to all the features.
- package/distribution/index.d.ts +1 -1
- package/distribution/index.js +1 -1
- package/distribution/logging.d.ts +5 -0
- package/distribution/logging.js +13 -0
- package/distribution/receiver.js +2 -1
- package/distribution/sender.js +2 -1
- package/distribution/shared.d.ts +0 -5
- package/distribution/shared.js +0 -13
- package/distribution/thisTarget.js +3 -2
- package/package.json +8 -2
package/distribution/index.d.ts
CHANGED
package/distribution/index.js
CHANGED
@@ -3,6 +3,6 @@ export * from "./receiver.js";
|
|
3
3
|
export * from "./sender.js";
|
4
4
|
export * from "./types.js";
|
5
5
|
export { getThisFrame, getTopLevelFrame } from "./thisTarget.js";
|
6
|
-
export { toggleLogging } from "./
|
6
|
+
export { toggleLogging } from "./logging.js";
|
7
7
|
import { initPrivateApi } from "./thisTarget.js";
|
8
8
|
initPrivateApi();
|
@@ -0,0 +1,13 @@
|
|
1
|
+
/* Warning: Do not use import browser-polyfill directly or indirectly */
|
2
|
+
// .bind preserves the call location in the console
|
3
|
+
const debug = console.debug.bind(console, "Messenger:");
|
4
|
+
const warn = console.warn.bind(console, "Messenger:");
|
5
|
+
const noop = () => {
|
6
|
+
/* */
|
7
|
+
};
|
8
|
+
// Default to "no logs"
|
9
|
+
export const log = { debug: noop, warn: noop };
|
10
|
+
export function toggleLogging(enabled) {
|
11
|
+
log.debug = enabled ? debug : noop;
|
12
|
+
log.warn = enabled ? warn : noop;
|
13
|
+
}
|
package/distribution/receiver.js
CHANGED
@@ -1,7 +1,8 @@
|
|
1
1
|
import { serializeError } from "serialize-error";
|
2
2
|
import { getContextName } from "webext-detect-page";
|
3
3
|
import { messenger } from "./sender.js";
|
4
|
-
import { isObject, MessengerError,
|
4
|
+
import { isObject, MessengerError, __webextMessenger } from "./shared.js";
|
5
|
+
import { log } from "./logging.js";
|
5
6
|
import { getActionForMessage } from "./thisTarget.js";
|
6
7
|
import { didUserRegisterMethods, handlers } from "./handlers.js";
|
7
8
|
export function isMessengerMessage(message) {
|
package/distribution/sender.js
CHANGED
@@ -1,7 +1,8 @@
|
|
1
1
|
import pRetry from "p-retry";
|
2
2
|
import { isBackground } from "webext-detect-page";
|
3
3
|
import { deserializeError } from "serialize-error";
|
4
|
-
import { isObject, MessengerError, __webextMessenger
|
4
|
+
import { isObject, MessengerError, __webextMessenger } from "./shared.js";
|
5
|
+
import { log } from "./logging.js";
|
5
6
|
import { handlers } from "./handlers.js";
|
6
7
|
const _errorNonExistingTarget = "Could not establish connection. Receiving end does not exist.";
|
7
8
|
// https://github.com/mozilla/webextension-polyfill/issues/384
|
package/distribution/shared.d.ts
CHANGED
@@ -10,11 +10,6 @@ export declare function isObject(value: unknown): value is Record<string, unknow
|
|
10
10
|
export declare class MessengerError extends Error {
|
11
11
|
name: string;
|
12
12
|
}
|
13
|
-
export declare const log: {
|
14
|
-
debug: (...args: any[]) => void;
|
15
|
-
warn: (...args: any[]) => void;
|
16
|
-
};
|
17
|
-
export declare function toggleLogging(enabled: boolean): void;
|
18
13
|
export declare function isErrorObject(error: unknown): error is ErrorObject;
|
19
14
|
export declare function delay(milliseconds: number): Promise<void>;
|
20
15
|
export declare function once<Callback extends (...arguments_: unknown[]) => unknown>(function_: Callback): Callback;
|
package/distribution/shared.js
CHANGED
@@ -3,9 +3,6 @@ export const __webextMessenger = true;
|
|
3
3
|
export function isObject(value) {
|
4
4
|
return typeof value === "object" && value !== null;
|
5
5
|
}
|
6
|
-
function noop() {
|
7
|
-
/* */
|
8
|
-
}
|
9
6
|
export class MessengerError extends Error {
|
10
7
|
constructor() {
|
11
8
|
super(...arguments);
|
@@ -19,16 +16,6 @@ export class MessengerError extends Error {
|
|
19
16
|
}
|
20
17
|
// @ts-expect-error Wrong `errorConstructors` types
|
21
18
|
errorConstructors.set("MessengerError", MessengerError);
|
22
|
-
// .bind preserves the call location in the console
|
23
|
-
const debug = console.debug.bind(console, "Messenger:");
|
24
|
-
const warn = console.warn.bind(console, "Messenger:");
|
25
|
-
export const log = { debug, warn };
|
26
|
-
export function toggleLogging(enabled) {
|
27
|
-
log.debug = enabled ? debug : noop;
|
28
|
-
log.warn = enabled ? warn : noop;
|
29
|
-
}
|
30
|
-
// Default to "no logs"
|
31
|
-
toggleLogging(false);
|
32
19
|
export function isErrorObject(error) {
|
33
20
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- This is a type guard function and it uses ?.
|
34
21
|
return typeof error?.message === "string";
|
@@ -1,7 +1,8 @@
|
|
1
1
|
import { isBackground, isContentScript, isExtensionContext, } from "webext-detect-page";
|
2
2
|
import { messenger } from "./sender.js";
|
3
3
|
import { registerMethods } from "./receiver.js";
|
4
|
-
import {
|
4
|
+
import { MessengerError, once } from "./shared.js";
|
5
|
+
import { log } from "./logging.js";
|
5
6
|
/**
|
6
7
|
* @file This file exists because `runtime.sendMessage` acts as a broadcast to
|
7
8
|
* all open extension pages, so the receiver needs a way to figure out if the
|
@@ -114,7 +115,7 @@ export function __getTabData() {
|
|
114
115
|
return { tabId: this.trace[0]?.tab?.id, frameId: this.trace[0]?.frameId };
|
115
116
|
}
|
116
117
|
export async function getThisFrame() {
|
117
|
-
await storeTabData(); // It should already have been called
|
118
|
+
await storeTabData(); // It should already have been called but we still need to await it
|
118
119
|
const { tabId, frameId } = thisTarget;
|
119
120
|
if (typeof tabId !== "number" || typeof frameId !== "number") {
|
120
121
|
throw new TypeError("This target is not in a frame");
|
package/package.json
CHANGED
@@ -1,13 +1,19 @@
|
|
1
1
|
{
|
2
2
|
"name": "webext-messenger",
|
3
|
-
"version": "0.
|
3
|
+
"version": "0.24.0",
|
4
4
|
"description": "Browser Extension component messaging framework",
|
5
5
|
"keywords": [],
|
6
6
|
"repository": "pixiebrix/webext-messenger",
|
7
7
|
"license": "MIT",
|
8
8
|
"author": "Federico Brigante for PixieBrix <federico@pixiebrix.com> (https://www.pixiebrix.com)",
|
9
9
|
"type": "module",
|
10
|
-
"
|
10
|
+
"exports": {
|
11
|
+
".": {
|
12
|
+
"types": "./distribution/index.js",
|
13
|
+
"default": "./distribution/index.js"
|
14
|
+
},
|
15
|
+
"./*": "./distribution/*"
|
16
|
+
},
|
11
17
|
"scripts": {
|
12
18
|
"build": "tsc",
|
13
19
|
"demo:watch": "parcel watch --no-cache --no-hmr",
|