Skip to content

Commit badc9e8

Browse files
committed
fix: remove CBOR
Using CBOR forces us to choose between #1271 and #1247. Our complicated importing and bundling situation makes using this library very hard. CBOR support has been undocumented, and we are not aware of significant usage in the wild. Therefore, we do not consider this a breaking change. To make our expectations clearer, this PR also marks MessagePack as `experimental`. We will improve our importing and bundling situation before reintroducing CBOR via a plugin. Closes #1271
1 parent 76bf9cd commit badc9e8

8 files changed

Lines changed: 6 additions & 240 deletions

File tree

e2e/datachannel/serialization.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,8 @@ const serialization = params.get("serialization");
1010
(async () => {
1111
let serializers = {};
1212
try {
13-
const { Cbor } = await import("/dist/serializer.cbor.mjs");
1413
const { MsgPack } = await import("/dist/serializer.msgpack.mjs");
1514
serializers = {
16-
Cbor,
1715
MsgPack,
1816
};
1917
} catch (e) {

e2e/datachannel/serialization_cbor.spec.ts

Lines changed: 0 additions & 35 deletions
This file was deleted.

lib/cborPeer.ts

Lines changed: 0 additions & 9 deletions
This file was deleted.

lib/dataconnection/StreamConnection/Cbor.ts

Lines changed: 0 additions & 75 deletions
This file was deleted.

lib/exports.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
export { util, type Util } from "./util";
22
import { Peer } from "./peer";
3-
import { CborPeer } from "./cborPeer";
43
import { MsgPackPeer } from "./msgPackPeer";
54

65
export type { PeerEvents, PeerOptions } from "./peer";
@@ -19,11 +18,10 @@ export * from "./enums";
1918

2019
export { BufferedConnection } from "./dataconnection/BufferedConnection/BufferedConnection";
2120
export { StreamConnection } from "./dataconnection/StreamConnection/StreamConnection";
22-
export { Cbor } from "./dataconnection/StreamConnection/Cbor";
2321
export { MsgPack } from "./dataconnection/StreamConnection/MsgPack";
2422
export type { SerializerMapping } from "./peer";
2523

26-
export { Peer, MsgPackPeer, CborPeer };
24+
export { Peer, MsgPackPeer };
2725

2826
export { PeerError } from "./peerError";
2927
export default Peer;

lib/msgPackPeer.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import { Peer, type SerializerMapping } from "./peer";
22
import { MsgPack } from "./exports";
33

4+
/**
5+
* @experimental
6+
*/
47
export class MsgPackPeer extends Peer {
58
override _serializers: SerializerMapping = {
69
MsgPack,

package-lock.json

Lines changed: 2 additions & 104 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@
107107
"module": "dist/bundler.mjs",
108108
"browser-minified": "dist/peerjs.min.js",
109109
"browser-unminified": "dist/peerjs.js",
110-
"browser-minified-cbor": "dist/serializer.cbor.mjs",
111110
"browser-minified-msgpack": "dist/serializer.msgpack.mjs",
112111
"types": "dist/types.d.ts",
113112
"engines": {
@@ -150,16 +149,6 @@
150149
},
151150
"source": "lib/global.ts"
152151
},
153-
"browser-minified-cbor": {
154-
"context": "browser",
155-
"outputFormat": "esmodule",
156-
"isLibrary": true,
157-
"optimize": true,
158-
"engines": {
159-
"browsers": "chrome >= 83, edge >= 83, firefox >= 102, safari >= 15"
160-
},
161-
"source": "lib/dataconnection/StreamConnection/Cbor.ts"
162-
},
163152
"browser-minified-msgpack": {
164153
"context": "browser",
165154
"outputFormat": "esmodule",
@@ -216,7 +205,6 @@
216205
},
217206
"dependencies": {
218207
"@msgpack/msgpack": "^2.8.0",
219-
"cbor-x": "1.5.4",
220208
"eventemitter3": "^4.0.7",
221209
"peerjs-js-binarypack": "^2.1.0",
222210
"webrtc-adapter": "^9.0.0"

0 commit comments

Comments
 (0)