js-broadcast-channel 1.3.5 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  interface IBroadcastJS {
2
- close: () => void;
2
+ close: VoidFunction;
3
3
  postMessage: (message: Message) => void;
4
4
  onMessage: (messageName: string, onReceive: (message: Message) => void) => void;
5
5
  canBrowserSupportBroadcastJS: () => boolean;
@@ -15,8 +15,8 @@ interface BroadcastHandlers {
15
15
  onAfterSendMessage?: (message: Message) => void;
16
16
  onBeforePostMessage?: (message: Message) => void;
17
17
  onAfterPostMessage?: (message: Message) => void;
18
- onBeforeClose?: () => void;
19
- onAfterClose?: () => void;
18
+ onBeforeClose?: VoidFunction;
19
+ onAfterClose?: VoidFunction;
20
20
  onError?: (message: Message) => void;
21
21
  }
22
22
  declare class BroadcastJS implements IBroadcastJS {
@@ -25,40 +25,8 @@ declare class BroadcastJS implements IBroadcastJS {
25
25
  private static messageCallbacks;
26
26
  private static handlers;
27
27
  constructor(name: string, handlers?: BroadcastHandlers);
28
- /**
29
- * Closes the broadcast channel.
30
- *
31
- * @returns {void}
32
- *
33
- * @example
34
- * const broadcast = new BroadcastJS("channelName");
35
- * broadcast.close();
36
- */
37
28
  close(): void;
38
- /**
39
- * Posts a message to the broadcast channel.
40
- *
41
- * @param {Message} message - The message to post.
42
- * @returns {void}
43
- *
44
- * @example
45
- * const broadcast = new BroadcastJS("channelName");
46
- * broadcast.postMessage({ message: "message", data: { count: 0 } });
47
- */
48
29
  postMessage(message: Message): void;
49
- /**
50
- * Calls a callback when a message is received.
51
- *
52
- * @param {string} messageName - The name of the message to call the callback for.
53
- * @param {function} onRecieve - The callback to call when a message is received.
54
- * @returns {void}
55
- *
56
- * @example
57
- * const broadcast = new BroadcastJS("channelName");
58
- * broadcast.onMessage("name", (message) => {
59
- * console.log(message);
60
- * });
61
- */
62
30
  onMessage<T>(messageName: string, onRecieve: (message: Message<T>) => void): void;
63
31
  removeMessage(messageName: string): void;
64
32
  canBrowserSupportBroadcastJS(): boolean;
package/dist/index.mjs CHANGED
@@ -1,129 +1 @@
1
- // src/broadcast.ts
2
- var _BroadcastJS = class _BroadcastJS {
3
- constructor(name, handlers) {
4
- if (!this.canBrowserSupportBroadcastJS()) {
5
- throw new Error("BroadcastChannel API is not supported in this browser");
6
- }
7
- if (_BroadcastJS.bcJSInstance) {
8
- return _BroadcastJS.bcJSInstance;
9
- }
10
- if (!_BroadcastJS.bcInstance) {
11
- const broadcast = new BroadcastChannel(name);
12
- _BroadcastJS.bcInstance = broadcast;
13
- }
14
- _BroadcastJS.handlers = handlers || {};
15
- _BroadcastJS.bcJSInstance = this;
16
- return _BroadcastJS.bcJSInstance;
17
- }
18
- /**
19
- * Closes the broadcast channel.
20
- *
21
- * @returns {void}
22
- *
23
- * @example
24
- * const broadcast = new BroadcastJS("channelName");
25
- * broadcast.close();
26
- */
27
- close() {
28
- var _a, _b, _c, _d;
29
- (_b = (_a = _BroadcastJS.handlers).onBeforeClose) == null ? void 0 : _b.call(_a);
30
- _BroadcastJS.bcInstance.close();
31
- _BroadcastJS.messageCallbacks.clear();
32
- _BroadcastJS.handlers = {};
33
- (_d = (_c = _BroadcastJS.handlers).onAfterClose) == null ? void 0 : _d.call(_c);
34
- }
35
- /**
36
- * Posts a message to the broadcast channel.
37
- *
38
- * @param {Message} message - The message to post.
39
- * @returns {void}
40
- *
41
- * @example
42
- * const broadcast = new BroadcastJS("channelName");
43
- * broadcast.postMessage({ message: "message", data: { count: 0 } });
44
- */
45
- postMessage(message) {
46
- var _a, _b, _c, _d;
47
- const serializedMessage = this.createSerializedMessage(message.message, message.data, false);
48
- (_b = (_a = _BroadcastJS.handlers).onBeforePostMessage) == null ? void 0 : _b.call(_a, message);
49
- _BroadcastJS.bcInstance.postMessage(serializedMessage);
50
- (_d = (_c = _BroadcastJS.handlers).onAfterPostMessage) == null ? void 0 : _d.call(_c, message);
51
- }
52
- /**
53
- * Calls a callback when a message is received.
54
- *
55
- * @param {string} messageName - The name of the message to call the callback for.
56
- * @param {function} onRecieve - The callback to call when a message is received.
57
- * @returns {void}
58
- *
59
- * @example
60
- * const broadcast = new BroadcastJS("channelName");
61
- * broadcast.onMessage("name", (message) => {
62
- * console.log(message);
63
- * });
64
- */
65
- onMessage(messageName, onRecieve) {
66
- _BroadcastJS.messageCallbacks.set(messageName, onRecieve);
67
- _BroadcastJS.bcInstance.onmessage = (event) => {
68
- var _a, _b, _c, _d, _e, _f, _g;
69
- const receivedMessage = JSON.parse(event.data);
70
- const message = this.createMessage(receivedMessage.message, receivedMessage.data, (_a = receivedMessage.isInternal) != null ? _a : false);
71
- if (message.isInternal) {
72
- _BroadcastJS.internalMessage(message.message, message);
73
- return;
74
- }
75
- const callback = _BroadcastJS.messageCallbacks.get(receivedMessage.message);
76
- if (callback) {
77
- (_c = (_b = _BroadcastJS.handlers).onBeforeSendMessage) == null ? void 0 : _c.call(_b, message);
78
- callback(message);
79
- (_e = (_d = _BroadcastJS.handlers).onAfterSendMessage) == null ? void 0 : _e.call(_d, message);
80
- } else {
81
- (_g = (_f = _BroadcastJS.handlers).onError) == null ? void 0 : _g.call(_f, message);
82
- console.error("No callback found for message with name: ", receivedMessage.message);
83
- }
84
- };
85
- }
86
- removeMessage(messageName) {
87
- const serializedMessage = this.createSerializedMessage("removeMessage" /* RemoveMessage */, messageName, true);
88
- _BroadcastJS.bcInstance.postMessage(serializedMessage);
89
- _BroadcastJS.messageCallbacks.delete(messageName);
90
- }
91
- canBrowserSupportBroadcastJS() {
92
- return typeof BroadcastChannel !== "undefined";
93
- }
94
- hasListeners(messageName) {
95
- return _BroadcastJS.messageCallbacks.has(messageName);
96
- }
97
- static internalMessage(messageName, message) {
98
- let isInternalMessage = false;
99
- switch (messageName) {
100
- case "removeMessage" /* RemoveMessage */:
101
- _BroadcastJS.messageCallbacks.delete(message.data);
102
- isInternalMessage = true;
103
- break;
104
- default:
105
- isInternalMessage = false;
106
- break;
107
- }
108
- return isInternalMessage;
109
- }
110
- // manual serialization to make it predictable
111
- createMessage(name, data, isInternal) {
112
- const message = {
113
- message: name,
114
- data,
115
- isInternal
116
- };
117
- return message;
118
- }
119
- createSerializedMessage(name, data, isInternal) {
120
- const message = this.createMessage(name, data, isInternal);
121
- return JSON.stringify(message);
122
- }
123
- };
124
- _BroadcastJS.messageCallbacks = /* @__PURE__ */ new Map();
125
- _BroadcastJS.handlers = {};
126
- var BroadcastJS = _BroadcastJS;
127
- export {
128
- BroadcastJS
129
- };
1
+ var e=class e{constructor(s,a){if(!this.canBrowserSupportBroadcastJS())throw new Error("BroadcastChannel API is not supported in this browser");if(e.bcJSInstance)return e.bcJSInstance;if(!e.bcInstance){let n=new BroadcastChannel(s);e.bcInstance=n;}return e.handlers=a||{},e.bcJSInstance=this,e.bcJSInstance}close(){e.handlers.onBeforeClose?.(),e.bcInstance.close(),e.messageCallbacks.clear(),e.handlers={},e.handlers.onAfterClose?.();}postMessage(s){let a=this.createSerializedMessage(s.message,s.data,false);e.handlers.onBeforePostMessage?.(s),e.bcInstance.postMessage(a),e.handlers.onAfterPostMessage?.(s);}onMessage(s,a){e.messageCallbacks.set(s,a),e.bcInstance.onmessage=n=>{let t=JSON.parse(n.data),r=this.createMessage(t.message,t.data,t.isInternal??false);if(r.isInternal){e.internalMessage(r.message,r);return}let i=e.messageCallbacks.get(t.message);i?(e.handlers.onBeforeSendMessage?.(r),i(r),e.handlers.onAfterSendMessage?.(r)):(e.handlers.onError?.(r),console.error("No callback found for message with name: ",t.message));};}removeMessage(s){let a=this.createSerializedMessage("rm",s,true);e.bcInstance.postMessage(a),e.messageCallbacks.delete(s);}canBrowserSupportBroadcastJS(){return typeof BroadcastChannel<"u"}hasListeners(s){return e.messageCallbacks.has(s)}static internalMessage(s,a){let n=false;switch(s){case "rm":e.messageCallbacks.delete(a.data),n=true;break;default:n=false;break}return n}createMessage(s,a,n){return {message:s,data:a,isInternal:n}}createSerializedMessage(s,a,n){let t=this.createMessage(s,a,n);return JSON.stringify(t)}};e.messageCallbacks=new Map,e.handlers={};var o=e;export{o as BroadcastJS};
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "js-broadcast-channel",
3
- "version": "1.3.5",
3
+ "version": "1.4.0",
4
4
  "description": "Broadcast-js",
5
5
  "main": "index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "scripts": {
8
- "build": "tsup src/index.ts --dts --format esm",
8
+ "build": "tsup src/index.ts --dts --format esm --minify --treeshake --target es2020 --clean",
9
9
  "dev": "tsup src/index.ts --dts --format esm --watch",
10
10
  "test": "jest",
11
11
  "prepare": "npm run build"
package/tsup.config.ts ADDED
@@ -0,0 +1,16 @@
1
+ import { defineConfig } from 'tsup'
2
+
3
+ export default defineConfig({
4
+ entry: ['src/index.ts'],
5
+ format: ['esm'],
6
+ dts: true,
7
+ minify: true,
8
+ treeshake: true,
9
+ target: 'es2020',
10
+ clean: true,
11
+ esbuildOptions: (options, { format }) => {
12
+ if (format === 'esm') {
13
+ options.mangleProps = /^_/
14
+ }
15
+ }
16
+ })
package/dist/index.d.ts DELETED
@@ -1,71 +0,0 @@
1
- interface IBroadcastJS {
2
- close: () => void;
3
- postMessage: (message: Message) => void;
4
- onMessage: (messageName: string, onReceive: (message: Message) => void) => void;
5
- canBrowserSupportBroadcastJS: () => boolean;
6
- hasListeners: (messageName: string) => boolean;
7
- }
8
- interface Message<T = unknown> {
9
- message: string;
10
- data: T;
11
- isInternal?: boolean;
12
- }
13
- interface BroadcastHandlers {
14
- onBeforeSendMessage?: (message: Message) => void;
15
- onAfterSendMessage?: (message: Message) => void;
16
- onBeforePostMessage?: (message: Message) => void;
17
- onAfterPostMessage?: (message: Message) => void;
18
- onBeforeClose?: () => void;
19
- onAfterClose?: () => void;
20
- onError?: (message: Message) => void;
21
- }
22
- declare class BroadcastJS implements IBroadcastJS {
23
- private static bcInstance;
24
- private static bcJSInstance;
25
- private static messageCallbacks;
26
- private static handlers;
27
- constructor(name: string, handlers?: BroadcastHandlers);
28
- /**
29
- * Closes the broadcast channel.
30
- *
31
- * @returns {void}
32
- *
33
- * @example
34
- * const broadcast = new BroadcastJS("channelName");
35
- * broadcast.close();
36
- */
37
- close(): void;
38
- /**
39
- * Posts a message to the broadcast channel.
40
- *
41
- * @param {Message} message - The message to post.
42
- * @returns {void}
43
- *
44
- * @example
45
- * const broadcast = new BroadcastJS("channelName");
46
- * broadcast.postMessage({ message: "message", data: { count: 0 } });
47
- */
48
- postMessage(message: Message): void;
49
- /**
50
- * Calls a callback when a message is received.
51
- *
52
- * @param {string} messageName - The name of the message to call the callback for.
53
- * @param {function} onRecieve - The callback to call when a message is received.
54
- * @returns {void}
55
- *
56
- * @example
57
- * const broadcast = new BroadcastJS("channelName");
58
- * broadcast.onMessage("name", (message) => {
59
- * console.log(message);
60
- * });
61
- */
62
- onMessage<T>(messageName: string, onRecieve: (message: Message<T>) => void): void;
63
- removeMessage(messageName: string): void;
64
- canBrowserSupportBroadcastJS(): boolean;
65
- hasListeners(messageName: string): boolean;
66
- private static internalMessage;
67
- private createMessage;
68
- private createSerializedMessage;
69
- }
70
-
71
- export { BroadcastJS, type Message };
package/dist/index.js DELETED
@@ -1,156 +0,0 @@
1
- "use strict";
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __export = (target, all) => {
7
- for (var name in all)
8
- __defProp(target, name, { get: all[name], enumerable: true });
9
- };
10
- var __copyProps = (to, from, except, desc) => {
11
- if (from && typeof from === "object" || typeof from === "function") {
12
- for (let key of __getOwnPropNames(from))
13
- if (!__hasOwnProp.call(to, key) && key !== except)
14
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
- }
16
- return to;
17
- };
18
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
-
20
- // src/index.ts
21
- var index_exports = {};
22
- __export(index_exports, {
23
- BroadcastJS: () => BroadcastJS
24
- });
25
- module.exports = __toCommonJS(index_exports);
26
-
27
- // src/broadcast.ts
28
- var _BroadcastJS = class _BroadcastJS {
29
- constructor(name, handlers) {
30
- if (!this.canBrowserSupportBroadcastJS()) {
31
- throw new Error("BroadcastChannel API is not supported in this browser");
32
- }
33
- if (_BroadcastJS.bcJSInstance) {
34
- return _BroadcastJS.bcJSInstance;
35
- }
36
- if (!_BroadcastJS.bcInstance) {
37
- const broadcast = new BroadcastChannel(name);
38
- _BroadcastJS.bcInstance = broadcast;
39
- }
40
- _BroadcastJS.handlers = handlers || {};
41
- _BroadcastJS.bcJSInstance = this;
42
- return _BroadcastJS.bcJSInstance;
43
- }
44
- /**
45
- * Closes the broadcast channel.
46
- *
47
- * @returns {void}
48
- *
49
- * @example
50
- * const broadcast = new BroadcastJS("channelName");
51
- * broadcast.close();
52
- */
53
- close() {
54
- var _a, _b, _c, _d;
55
- (_b = (_a = _BroadcastJS.handlers).onBeforeClose) == null ? void 0 : _b.call(_a);
56
- _BroadcastJS.bcInstance.close();
57
- _BroadcastJS.messageCallbacks.clear();
58
- _BroadcastJS.handlers = {};
59
- (_d = (_c = _BroadcastJS.handlers).onAfterClose) == null ? void 0 : _d.call(_c);
60
- }
61
- /**
62
- * Posts a message to the broadcast channel.
63
- *
64
- * @param {Message} message - The message to post.
65
- * @returns {void}
66
- *
67
- * @example
68
- * const broadcast = new BroadcastJS("channelName");
69
- * broadcast.postMessage({ message: "message", data: { count: 0 } });
70
- */
71
- postMessage(message) {
72
- var _a, _b, _c, _d;
73
- const serializedMessage = this.createSerializedMessage(message.message, message.data, false);
74
- (_b = (_a = _BroadcastJS.handlers).onBeforePostMessage) == null ? void 0 : _b.call(_a, message);
75
- _BroadcastJS.bcInstance.postMessage(serializedMessage);
76
- (_d = (_c = _BroadcastJS.handlers).onAfterPostMessage) == null ? void 0 : _d.call(_c, message);
77
- }
78
- /**
79
- * Calls a callback when a message is received.
80
- *
81
- * @param {string} messageName - The name of the message to call the callback for.
82
- * @param {function} onRecieve - The callback to call when a message is received.
83
- * @returns {void}
84
- *
85
- * @example
86
- * const broadcast = new BroadcastJS("channelName");
87
- * broadcast.onMessage("name", (message) => {
88
- * console.log(message);
89
- * });
90
- */
91
- onMessage(messageName, onRecieve) {
92
- _BroadcastJS.messageCallbacks.set(messageName, onRecieve);
93
- _BroadcastJS.bcInstance.onmessage = (event) => {
94
- var _a, _b, _c, _d, _e, _f, _g;
95
- const receivedMessage = JSON.parse(event.data);
96
- const message = this.createMessage(receivedMessage.message, receivedMessage.data, (_a = receivedMessage.isInternal) != null ? _a : false);
97
- if (message.isInternal) {
98
- _BroadcastJS.internalMessage(message.message, message);
99
- return;
100
- }
101
- const callback = _BroadcastJS.messageCallbacks.get(receivedMessage.message);
102
- if (callback) {
103
- (_c = (_b = _BroadcastJS.handlers).onBeforeSendMessage) == null ? void 0 : _c.call(_b, message);
104
- callback(message);
105
- (_e = (_d = _BroadcastJS.handlers).onAfterSendMessage) == null ? void 0 : _e.call(_d, message);
106
- } else {
107
- (_g = (_f = _BroadcastJS.handlers).onError) == null ? void 0 : _g.call(_f, message);
108
- console.error("No callback found for message with name: ", receivedMessage.message);
109
- }
110
- };
111
- }
112
- removeMessage(messageName) {
113
- const serializedMessage = this.createSerializedMessage("removeMessage" /* RemoveMessage */, messageName, true);
114
- _BroadcastJS.bcInstance.postMessage(serializedMessage);
115
- _BroadcastJS.messageCallbacks.delete(messageName);
116
- }
117
- canBrowserSupportBroadcastJS() {
118
- return typeof BroadcastChannel !== "undefined";
119
- }
120
- hasListeners(messageName) {
121
- return _BroadcastJS.messageCallbacks.has(messageName);
122
- }
123
- static internalMessage(messageName, message) {
124
- let isInternalMessage = false;
125
- switch (messageName) {
126
- case "removeMessage" /* RemoveMessage */:
127
- _BroadcastJS.messageCallbacks.delete(message.data);
128
- isInternalMessage = true;
129
- break;
130
- default:
131
- isInternalMessage = false;
132
- break;
133
- }
134
- return isInternalMessage;
135
- }
136
- // manual serialization to make it predictable
137
- createMessage(name, data, isInternal) {
138
- const message = {
139
- message: name,
140
- data,
141
- isInternal
142
- };
143
- return message;
144
- }
145
- createSerializedMessage(name, data, isInternal) {
146
- const message = this.createMessage(name, data, isInternal);
147
- return JSON.stringify(message);
148
- }
149
- };
150
- _BroadcastJS.messageCallbacks = /* @__PURE__ */ new Map();
151
- _BroadcastJS.handlers = {};
152
- var BroadcastJS = _BroadcastJS;
153
- // Annotate the CommonJS export names for ESM import in node:
154
- 0 && (module.exports = {
155
- BroadcastJS
156
- });