feat: protobuf/msgpack support for extended protocol

README.md

@@ -281,6 +281,24 @@ import { createCable } from '@anycable/web'
 export default createCable({protocol: 'actioncable-v1-ext-json'})
 ```
 
+#### Using with Protobuf and Msgpack
+
+You can use the extended protocol with Protobuf and Msgpack encoders as follows:
+
+```js
+// cable.js
+import { createCable } from '@anycable/web'
+import { MsgpackEncoder } from '@anycable/msgpack-encoder'
+
+export default createCable({protocol: 'actioncable-v1-ext-msgpack', encoder: new MsgpackEncoder()})
+
+// or for protobuf
+import { createCable } from '@anycable/web'
+import { ProtobufEncoderV2 } from '@anycable/protobuf-encoder'
+
+export default createCable({protocol: 'actioncable-v1-ext-protobuf', encoder: new ProtobufEncoderV2()})
+```
+
 #### Loading initial history on client initialization
 
 To catch up messages broadcasted during the initial page load (or client-side application initialization), you can specify the `historyTimestamp` option to retrieve messages after the specified time along with subscription requests. The value must be a UTC timestamp (the number of seconds). For example:

package.json

@@ -19,7 +19,12 @@
     "test:dev": "NODE_OPTIONS='--experimental-vm-modules' jest",
     "test": "yarn test:dev --coverage && check-dts",
     "lint": "eslint . && prettier --check 'packages/**/*.{js,ts}'",
-    "lint:fix": "eslint . --fix && prettier --check 'packages/**/*.{js,ts}' --write"
+    "lint:fix": "eslint . --fix && prettier --check 'packages/**/*.{js,ts}' --write",
+    "protos": "yarn protos:build && yarn protos:fix",
+    "protos:build": "yarn protos:build:js && yarn protos:build:ts",
+    "protos:build:js": "pbjs -t static-module --keep-case --force-number -w es6 -o packages/protobuf-encoder/generated/message_pb.js packages/protobuf-encoder/message.proto",
+    "protos:build:ts": "pbts -o packages/protobuf-encoder/generated/message_pb.d.ts packages/protobuf-encoder/generated/message_pb.js",
+    "protos:fix": "sed -i '' 's/import \\* as \\$protobuf from \"protobufjs\\/minimal\";/import \\$protobuf from \"protobufjs\\/minimal.js\"\\\n\\$protobuf.util.Long = undefined;\\\n\\$protobuf.configure();/g' packages/protobuf-encoder/generated/message_pb.js"
   },
   "homepage": "https://anycable.io/",
   "repository": "https://github.com/anycable/anycable-client",

packages/core/cable/index.test.ts

@@ -171,6 +171,7 @@ describe('connect/disconnect', () => {
     let p1 = cable.connect()
     let p2 = cable.connect()
 
+    cable.connected()
     cable.connected()
 
     await p1

packages/core/create-cable/index.d.ts

@@ -8,7 +8,10 @@ import { Channel, Message, ChannelParamsMap } from '../channel/index.js'
 import { Options } from '../action_cable/index.js'
 import { ExtendedOptions } from '../action_cable_ext/index.js'
 
-export type ExtendedProtocolID = 'actioncable-v1-ext-json'
+export type ExtendedProtocolID =
+  | 'actioncable-v1-ext-json'
+  | 'actioncable-v1-ext-msgpack'
+  | 'actioncable-v1-ext-protobuf'
 
 export type ProtocolID =
   | 'actioncable-v1-json'

packages/protobuf-encoder/CHANGELOG.md

@@ -2,4 +2,8 @@
 
 ## master
 
+- Add `ProtobufEncoderV2` class supporting updated Protobuf schema with Message and Reply types separated.
+
+  This encoder MUST be used with the extended protocol.
+
 [@palkan]: https://github.com/palkan