@juzi/wechaty-grpc 1.0.110 → 1.0.111

package/dist/cjs/out/wechaty/puppet/event_pb.d.ts

@@ -10,6 +10,9 @@ export class EventRequest extends jspb.Message {
   getAccountId(): string;
   setAccountId(value: string): void;
 
+  getReplayBarrier(): boolean;
+  setReplayBarrier(value: boolean): void;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): EventRequest.AsObject;
   static toObject(includeInstance: boolean, msg: EventRequest): EventRequest.AsObject;
@@ -24,6 +27,7 @@ export namespace EventRequest {
   export type AsObject = {
     seq: number,
     accountId: string,
+    replayBarrier: boolean,
   }
 }
 
@@ -85,6 +89,7 @@ export interface EventTypeMap {
   EVENT_TYPE_ORG_BROADCAST_CREATED: 37;
   EVENT_TYPE_ORG_BROADCAST_SENT: 38;
   EVENT_TYPE_ROOM_MEMBER_LOAD: 39;
+  EVENT_TYPE_REPLAY_COMPLETE: 40;
 }
 
 export const EventType: EventTypeMap;

package/dist/cjs/out/wechaty/puppet/event_pb.js

@@ -93,7 +93,8 @@ proto.wechaty.puppet.EventRequest.prototype.toObject = function(opt_includeInsta
 proto.wechaty.puppet.EventRequest.toObject = function(includeInstance, msg) {
   var f, obj = {
     seq: jspb.Message.getFieldWithDefault(msg, 1, 0),
-    accountId: jspb.Message.getFieldWithDefault(msg, 2, "")
+    accountId: jspb.Message.getFieldWithDefault(msg, 2, ""),
+    replayBarrier: jspb.Message.getBooleanFieldWithDefault(msg, 3, false)
   };
 
   if (includeInstance) {
@@ -138,6 +139,10 @@ proto.wechaty.puppet.EventRequest.deserializeBinaryFromReader = function(msg, re
       var value = /** @type {string} */ (reader.readString());
       msg.setAccountId(value);
       break;
+    case 3:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setReplayBarrier(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -181,6 +186,13 @@ proto.wechaty.puppet.EventRequest.serializeBinaryToWriter = function(message, wr
       f
     );
   }
+  f = message.getReplayBarrier();
+  if (f) {
+    writer.writeBool(
+      3,
+      f
+    );
+  }
 };
 
 
@@ -220,6 +232,24 @@ proto.wechaty.puppet.EventRequest.prototype.setAccountId = function(value) {
 };
 
 
+/**
+ * optional bool replay_barrier = 3;
+ * @return {boolean}
+ */
+proto.wechaty.puppet.EventRequest.prototype.getReplayBarrier = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 3, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.wechaty.puppet.EventRequest} returns this
+ */
+proto.wechaty.puppet.EventRequest.prototype.setReplayBarrier = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 3, value);
+};
+
+
 
 
 
@@ -442,7 +472,8 @@ proto.wechaty.puppet.EventType = {
   EVENT_TYPE_SAME_NET_VERIFY: 36,
   EVENT_TYPE_ORG_BROADCAST_CREATED: 37,
   EVENT_TYPE_ORG_BROADCAST_SENT: 38,
-  EVENT_TYPE_ROOM_MEMBER_LOAD: 39
+  EVENT_TYPE_ROOM_MEMBER_LOAD: 39,
+  EVENT_TYPE_REPLAY_COMPLETE: 40
 };
 
 goog.object.extend(exports, proto.wechaty.puppet);

package/dist/cjs/out/wechaty/puppet.openapi.yaml

@@ -9,7 +9,7 @@ info:
 
     Wechaty Puppet Service is the RESTful API for Wechaty API, which is build on
     top of the Wechaty Puppet Abstraction and the gRPC proto definition.
-  version: 1.0.110
+  version: 1.0.111
   contact:
     name: Wechaty
     url: https://github.com/wechaty/openapi
@@ -1233,6 +1233,11 @@ paths:
           in: query
           required: false
           type: string
+        - name: replayBarrier
+          description: request a completion marker after ordered replay
+          in: query
+          required: false
+          type: boolean
       tags:
         - Puppet
   /friendship/accept/{id}:
@@ -4315,12 +4320,13 @@ definitions:
       - EVENT_TYPE_ORG_BROADCAST_CREATED
       - EVENT_TYPE_ORG_BROADCAST_SENT
       - EVENT_TYPE_ROOM_MEMBER_LOAD
+      - EVENT_TYPE_REPLAY_COMPLETE
     default: EVENT_TYPE_UNSPECIFIED
-    description: >-
-      - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat
-      login on Mac protocol
+    description: |2-
+       - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol
        - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card
        - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client
+       - EVENT_TYPE_REPLAY_COMPLETE: Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0.
   puppetFriendshipAcceptResponse:
     type: object
   puppetFriendshipAddResponse:

package/dist/cjs/out/wechaty/puppet.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Wechaty Puppet Service OpenAPI Specification",
     "description": "Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.\n\nWechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.",
-    "version": "1.0.110",
+    "version": "1.0.111",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -1897,6 +1897,13 @@
             "in": "query",
             "required": false,
             "type": "string"
+          },
+          {
+            "name": "replayBarrier",
+            "description": "request a completion marker after ordered replay",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
           }
         ],
         "tags": [
@@ -6331,10 +6338,11 @@
         "EVENT_TYPE_SAME_NET_VERIFY",
         "EVENT_TYPE_ORG_BROADCAST_CREATED",
         "EVENT_TYPE_ORG_BROADCAST_SENT",
-        "EVENT_TYPE_ROOM_MEMBER_LOAD"
+        "EVENT_TYPE_ROOM_MEMBER_LOAD",
+        "EVENT_TYPE_REPLAY_COMPLETE"
       ],
       "default": "EVENT_TYPE_UNSPECIFIED",
-      "description": "- EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol\n - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card\n - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client"
+      "description": " - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol\n - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card\n - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client\n - EVENT_TYPE_REPLAY_COMPLETE: Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0."
     },
     "puppetFriendshipAcceptResponse": {
       "type": "object"

package/dist/cjs/proto/wechaty/puppet/event.proto

@@ -42,11 +42,14 @@ enum EventType {
   // wecom org (admin) broadcast plan executed, from any client
   EVENT_TYPE_ORG_BROADCAST_SENT    = 38;
   EVENT_TYPE_ROOM_MEMBER_LOAD     = 39;
+  // Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0.
+  EVENT_TYPE_REPLAY_COMPLETE      = 40;
 }
 
 message EventRequest {
   int32 seq = 1; // the seq of the last event
   string account_id = 2;  // the accountId of the last event
+  bool replay_barrier = 3; // request a completion marker after ordered replay
 }
 
 message EventResponse {

package/dist/cjs/src/package-json.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageJson = void 0;
 exports.packageJson = {
     "name": "@juzi/wechaty-grpc",
-    "version": "1.0.110",
+    "version": "1.0.111",
     "description": "gRPC for Wechaty",
     "type": "module",
     "exports": {

package/dist/cjs/tests/replay-barrier.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=replay-barrier.spec.d.ts.map

package/dist/cjs/tests/replay-barrier.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"replay-barrier.spec.d.ts","sourceRoot":"","sources":["../../../tests/replay-barrier.spec.ts"],"names":[],"mappings":""}

package/dist/cjs/tests/replay-barrier.spec.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tstest_1 = require("tstest");
+const cjs_js_1 = require("../src/cjs.js");
+(0, tstest_1.test)('replay capability is opt-in and preserves the existing resume cursor', t => {
+    const legacy = cjs_js_1.puppet.EventRequest.deserializeBinary(Uint8Array.from([8, 7, 18, 1, 97]));
+    t.equal(legacy.getSeq(), 7);
+    t.equal(legacy.getAccountId(), 'a');
+    t.equal(legacy.getReplayBarrier(), false);
+    t.same([...legacy.serializeBinary()], [8, 7, 18, 1, 97]);
+    legacy.setReplayBarrier(true);
+    t.same([...legacy.serializeBinary()], [8, 7, 18, 1, 97, 24, 1]);
+    const decoded = cjs_js_1.puppet.EventRequest.deserializeBinary(legacy.serializeBinary());
+    t.equal(decoded.getReplayBarrier(), true);
+    t.equal(decoded.getSeq(), 7);
+    t.equal(decoded.getAccountId(), 'a');
+    t.end();
+});
+(0, tstest_1.test)('replay completion carries a watermark without advancing the business event cursor', t => {
+    const response = new cjs_js_1.puppet.EventResponse();
+    response.setType(cjs_js_1.puppet.EventType.EVENT_TYPE_REPLAY_COMPLETE);
+    response.setPayload(JSON.stringify({ accountId: 'account', throughSeq: 42 }));
+    const decoded = cjs_js_1.puppet.EventResponse.deserializeBinary(response.serializeBinary());
+    t.equal(decoded.getType(), 40);
+    t.equal(decoded.getSeq(), 0);
+    t.same(JSON.parse(decoded.getPayload()), { accountId: 'account', throughSeq: 42 });
+    t.equal(cjs_js_1.puppet.EventType.EVENT_TYPE_READY, 23);
+    t.equal(cjs_js_1.puppet.EventType.EVENT_TYPE_ROOM_MEMBER_LOAD, 39);
+    t.end();
+});
+//# sourceMappingURL=replay-barrier.spec.js.map

package/dist/cjs/tests/replay-barrier.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replay-barrier.spec.js","sourceRoot":"","sources":["../../../tests/replay-barrier.spec.ts"],"names":[],"mappings":";;AAAA,mCAA6B;AAE7B,0CAAsC;AAEtC,IAAA,aAAI,EAAC,sEAAsE,EAAE,CAAC,CAAC,EAAE;IAC/E,MAAM,MAAM,GAAG,eAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAA;IAC1F,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAC3B,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,GAAG,CAAC,CAAA;IACnC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC,CAAC,IAAI,CAAC,CAAE,GAAG,MAAM,CAAC,eAAe,EAAE,CAAE,EAAE,CAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAE,CAAC,CAAA;IAC5D,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC,CAAC,IAAI,CAAC,CAAE,GAAG,MAAM,CAAC,eAAe,EAAE,CAAE,EAAE,CAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAE,CAAC,CAAA;IACnE,MAAM,OAAO,GAAG,eAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAA;IAC/E,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,GAAG,CAAC,CAAA;IACpC,CAAC,CAAC,GAAG,EAAE,CAAA;AACT,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,mFAAmF,EAAE,CAAC,CAAC,EAAE;IAC5F,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,aAAa,EAAE,CAAA;IAC3C,QAAQ,CAAC,OAAO,CAAC,eAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAA;IAC7D,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;IAC7E,MAAM,OAAO,GAAG,eAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAA;IAClF,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;IAC9B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAA;IAClF,CAAC,CAAC,KAAK,CAAC,eAAM,CAAC,SAAS,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAC,KAAK,CAAC,eAAM,CAAC,SAAS,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAA;IACzD,CAAC,CAAC,GAAG,EAAE,CAAA;AACT,CAAC,CAAC,CAAA"}

package/dist/esm/out/wechaty/puppet/event_pb.d.ts

@@ -10,6 +10,9 @@ export class EventRequest extends jspb.Message {
   getAccountId(): string;
   setAccountId(value: string): void;
 
+  getReplayBarrier(): boolean;
+  setReplayBarrier(value: boolean): void;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): EventRequest.AsObject;
   static toObject(includeInstance: boolean, msg: EventRequest): EventRequest.AsObject;
@@ -24,6 +27,7 @@ export namespace EventRequest {
   export type AsObject = {
     seq: number,
     accountId: string,
+    replayBarrier: boolean,
   }
 }
 
@@ -85,6 +89,7 @@ export interface EventTypeMap {
   EVENT_TYPE_ORG_BROADCAST_CREATED: 37;
   EVENT_TYPE_ORG_BROADCAST_SENT: 38;
   EVENT_TYPE_ROOM_MEMBER_LOAD: 39;
+  EVENT_TYPE_REPLAY_COMPLETE: 40;
 }
 
 export const EventType: EventTypeMap;

package/dist/esm/out/wechaty/puppet/event_pb.js

@@ -93,7 +93,8 @@ proto.wechaty.puppet.EventRequest.prototype.toObject = function(opt_includeInsta
 proto.wechaty.puppet.EventRequest.toObject = function(includeInstance, msg) {
   var f, obj = {
     seq: jspb.Message.getFieldWithDefault(msg, 1, 0),
-    accountId: jspb.Message.getFieldWithDefault(msg, 2, "")
+    accountId: jspb.Message.getFieldWithDefault(msg, 2, ""),
+    replayBarrier: jspb.Message.getBooleanFieldWithDefault(msg, 3, false)
   };
 
   if (includeInstance) {
@@ -138,6 +139,10 @@ proto.wechaty.puppet.EventRequest.deserializeBinaryFromReader = function(msg, re
       var value = /** @type {string} */ (reader.readString());
       msg.setAccountId(value);
       break;
+    case 3:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setReplayBarrier(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -181,6 +186,13 @@ proto.wechaty.puppet.EventRequest.serializeBinaryToWriter = function(message, wr
       f
     );
   }
+  f = message.getReplayBarrier();
+  if (f) {
+    writer.writeBool(
+      3,
+      f
+    );
+  }
 };
 
 
@@ -220,6 +232,24 @@ proto.wechaty.puppet.EventRequest.prototype.setAccountId = function(value) {
 };
 
 
+/**
+ * optional bool replay_barrier = 3;
+ * @return {boolean}
+ */
+proto.wechaty.puppet.EventRequest.prototype.getReplayBarrier = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 3, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.wechaty.puppet.EventRequest} returns this
+ */
+proto.wechaty.puppet.EventRequest.prototype.setReplayBarrier = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 3, value);
+};
+
+
 
 
 
@@ -442,7 +472,8 @@ proto.wechaty.puppet.EventType = {
   EVENT_TYPE_SAME_NET_VERIFY: 36,
   EVENT_TYPE_ORG_BROADCAST_CREATED: 37,
   EVENT_TYPE_ORG_BROADCAST_SENT: 38,
-  EVENT_TYPE_ROOM_MEMBER_LOAD: 39
+  EVENT_TYPE_ROOM_MEMBER_LOAD: 39,
+  EVENT_TYPE_REPLAY_COMPLETE: 40
 };
 
 goog.object.extend(exports, proto.wechaty.puppet);

package/dist/esm/out/wechaty/puppet.openapi.yaml

@@ -9,7 +9,7 @@ info:
 
     Wechaty Puppet Service is the RESTful API for Wechaty API, which is build on
     top of the Wechaty Puppet Abstraction and the gRPC proto definition.
-  version: 1.0.110
+  version: 1.0.111
   contact:
     name: Wechaty
     url: https://github.com/wechaty/openapi
@@ -1233,6 +1233,11 @@ paths:
           in: query
           required: false
           type: string
+        - name: replayBarrier
+          description: request a completion marker after ordered replay
+          in: query
+          required: false
+          type: boolean
       tags:
         - Puppet
   /friendship/accept/{id}:
@@ -4315,12 +4320,13 @@ definitions:
       - EVENT_TYPE_ORG_BROADCAST_CREATED
       - EVENT_TYPE_ORG_BROADCAST_SENT
       - EVENT_TYPE_ROOM_MEMBER_LOAD
+      - EVENT_TYPE_REPLAY_COMPLETE
     default: EVENT_TYPE_UNSPECIFIED
-    description: >-
-      - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat
-      login on Mac protocol
+    description: |2-
+       - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol
        - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card
        - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client
+       - EVENT_TYPE_REPLAY_COMPLETE: Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0.
   puppetFriendshipAcceptResponse:
     type: object
   puppetFriendshipAddResponse:

package/dist/esm/out/wechaty/puppet.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Wechaty Puppet Service OpenAPI Specification",
     "description": "Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.\n\nWechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.",
-    "version": "1.0.110",
+    "version": "1.0.111",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -1897,6 +1897,13 @@
             "in": "query",
             "required": false,
             "type": "string"
+          },
+          {
+            "name": "replayBarrier",
+            "description": "request a completion marker after ordered replay",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
           }
         ],
         "tags": [
@@ -6331,10 +6338,11 @@
         "EVENT_TYPE_SAME_NET_VERIFY",
         "EVENT_TYPE_ORG_BROADCAST_CREATED",
         "EVENT_TYPE_ORG_BROADCAST_SENT",
-        "EVENT_TYPE_ROOM_MEMBER_LOAD"
+        "EVENT_TYPE_ROOM_MEMBER_LOAD",
+        "EVENT_TYPE_REPLAY_COMPLETE"
       ],
       "default": "EVENT_TYPE_UNSPECIFIED",
-      "description": "- EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol\n - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card\n - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client"
+      "description": " - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol\n - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card\n - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client\n - EVENT_TYPE_REPLAY_COMPLETE: Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0."
     },
     "puppetFriendshipAcceptResponse": {
       "type": "object"

package/dist/esm/proto/wechaty/puppet/event.proto

@@ -42,11 +42,14 @@ enum EventType {
   // wecom org (admin) broadcast plan executed, from any client
   EVENT_TYPE_ORG_BROADCAST_SENT    = 38;
   EVENT_TYPE_ROOM_MEMBER_LOAD     = 39;
+  // Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0.
+  EVENT_TYPE_REPLAY_COMPLETE      = 40;
 }
 
 message EventRequest {
   int32 seq = 1; // the seq of the last event
   string account_id = 2;  // the accountId of the last event
+  bool replay_barrier = 3; // request a completion marker after ordered replay
 }
 
 message EventResponse {

package/dist/esm/src/package-json.js

@@ -1,6 +1,6 @@
 export const packageJson = {
     "name": "@juzi/wechaty-grpc",
-    "version": "1.0.110",
+    "version": "1.0.111",
     "description": "gRPC for Wechaty",
     "type": "module",
     "exports": {

package/dist/esm/tests/replay-barrier.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=replay-barrier.spec.d.ts.map

package/dist/esm/tests/replay-barrier.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"replay-barrier.spec.d.ts","sourceRoot":"","sources":["../../../tests/replay-barrier.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/replay-barrier.spec.js

@@ -0,0 +1,29 @@
+import { test } from 'tstest';
+import { puppet } from '../src/cjs.js';
+test('replay capability is opt-in and preserves the existing resume cursor', t => {
+    const legacy = puppet.EventRequest.deserializeBinary(Uint8Array.from([8, 7, 18, 1, 97]));
+    t.equal(legacy.getSeq(), 7);
+    t.equal(legacy.getAccountId(), 'a');
+    t.equal(legacy.getReplayBarrier(), false);
+    t.same([...legacy.serializeBinary()], [8, 7, 18, 1, 97]);
+    legacy.setReplayBarrier(true);
+    t.same([...legacy.serializeBinary()], [8, 7, 18, 1, 97, 24, 1]);
+    const decoded = puppet.EventRequest.deserializeBinary(legacy.serializeBinary());
+    t.equal(decoded.getReplayBarrier(), true);
+    t.equal(decoded.getSeq(), 7);
+    t.equal(decoded.getAccountId(), 'a');
+    t.end();
+});
+test('replay completion carries a watermark without advancing the business event cursor', t => {
+    const response = new puppet.EventResponse();
+    response.setType(puppet.EventType.EVENT_TYPE_REPLAY_COMPLETE);
+    response.setPayload(JSON.stringify({ accountId: 'account', throughSeq: 42 }));
+    const decoded = puppet.EventResponse.deserializeBinary(response.serializeBinary());
+    t.equal(decoded.getType(), 40);
+    t.equal(decoded.getSeq(), 0);
+    t.same(JSON.parse(decoded.getPayload()), { accountId: 'account', throughSeq: 42 });
+    t.equal(puppet.EventType.EVENT_TYPE_READY, 23);
+    t.equal(puppet.EventType.EVENT_TYPE_ROOM_MEMBER_LOAD, 39);
+    t.end();
+});
+//# sourceMappingURL=replay-barrier.spec.js.map

package/dist/esm/tests/replay-barrier.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replay-barrier.spec.js","sourceRoot":"","sources":["../../../tests/replay-barrier.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtC,IAAI,CAAC,sEAAsE,EAAE,CAAC,CAAC,EAAE;IAC/E,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAA;IAC1F,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAC3B,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,GAAG,CAAC,CAAA;IACnC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC,CAAC,IAAI,CAAC,CAAE,GAAG,MAAM,CAAC,eAAe,EAAE,CAAE,EAAE,CAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAE,CAAC,CAAA;IAC5D,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC,CAAC,IAAI,CAAC,CAAE,GAAG,MAAM,CAAC,eAAe,EAAE,CAAE,EAAE,CAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAE,CAAC,CAAA;IACnE,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAA;IAC/E,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,GAAG,CAAC,CAAA;IACpC,CAAC,CAAC,GAAG,EAAE,CAAA;AACT,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,mFAAmF,EAAE,CAAC,CAAC,EAAE;IAC5F,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE,CAAA;IAC3C,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAA;IAC7D,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;IAC7E,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAA;IAClF,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;IAC9B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAA;IAClF,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAA;IACzD,CAAC,CAAC,GAAG,EAAE,CAAA;AACT,CAAC,CAAC,CAAA"}

package/out/wechaty/puppet/event_pb.d.ts

@@ -10,6 +10,9 @@ export class EventRequest extends jspb.Message {
   getAccountId(): string;
   setAccountId(value: string): void;
 
+  getReplayBarrier(): boolean;
+  setReplayBarrier(value: boolean): void;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): EventRequest.AsObject;
   static toObject(includeInstance: boolean, msg: EventRequest): EventRequest.AsObject;
@@ -24,6 +27,7 @@ export namespace EventRequest {
   export type AsObject = {
     seq: number,
     accountId: string,
+    replayBarrier: boolean,
   }
 }
 
@@ -85,6 +89,7 @@ export interface EventTypeMap {
   EVENT_TYPE_ORG_BROADCAST_CREATED: 37;
   EVENT_TYPE_ORG_BROADCAST_SENT: 38;
   EVENT_TYPE_ROOM_MEMBER_LOAD: 39;
+  EVENT_TYPE_REPLAY_COMPLETE: 40;
 }
 
 export const EventType: EventTypeMap;

package/out/wechaty/puppet/event_pb.js

@@ -93,7 +93,8 @@ proto.wechaty.puppet.EventRequest.prototype.toObject = function(opt_includeInsta
 proto.wechaty.puppet.EventRequest.toObject = function(includeInstance, msg) {
   var f, obj = {
     seq: jspb.Message.getFieldWithDefault(msg, 1, 0),
-    accountId: jspb.Message.getFieldWithDefault(msg, 2, "")
+    accountId: jspb.Message.getFieldWithDefault(msg, 2, ""),
+    replayBarrier: jspb.Message.getBooleanFieldWithDefault(msg, 3, false)
   };
 
   if (includeInstance) {
@@ -138,6 +139,10 @@ proto.wechaty.puppet.EventRequest.deserializeBinaryFromReader = function(msg, re
       var value = /** @type {string} */ (reader.readString());
       msg.setAccountId(value);
       break;
+    case 3:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setReplayBarrier(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -181,6 +186,13 @@ proto.wechaty.puppet.EventRequest.serializeBinaryToWriter = function(message, wr
       f
     );
   }
+  f = message.getReplayBarrier();
+  if (f) {
+    writer.writeBool(
+      3,
+      f
+    );
+  }
 };
 
 
@@ -220,6 +232,24 @@ proto.wechaty.puppet.EventRequest.prototype.setAccountId = function(value) {
 };
 
 
+/**
+ * optional bool replay_barrier = 3;
+ * @return {boolean}
+ */
+proto.wechaty.puppet.EventRequest.prototype.getReplayBarrier = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 3, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.wechaty.puppet.EventRequest} returns this
+ */
+proto.wechaty.puppet.EventRequest.prototype.setReplayBarrier = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 3, value);
+};
+
+
 
 
 
@@ -442,7 +472,8 @@ proto.wechaty.puppet.EventType = {
   EVENT_TYPE_SAME_NET_VERIFY: 36,
   EVENT_TYPE_ORG_BROADCAST_CREATED: 37,
   EVENT_TYPE_ORG_BROADCAST_SENT: 38,
-  EVENT_TYPE_ROOM_MEMBER_LOAD: 39
+  EVENT_TYPE_ROOM_MEMBER_LOAD: 39,
+  EVENT_TYPE_REPLAY_COMPLETE: 40
 };
 
 goog.object.extend(exports, proto.wechaty.puppet);

package/out/wechaty/puppet.openapi.yaml

@@ -9,7 +9,7 @@ info:
 
     Wechaty Puppet Service is the RESTful API for Wechaty API, which is build on
     top of the Wechaty Puppet Abstraction and the gRPC proto definition.
-  version: 1.0.110
+  version: 1.0.111
   contact:
     name: Wechaty
     url: https://github.com/wechaty/openapi
@@ -1233,6 +1233,11 @@ paths:
           in: query
           required: false
           type: string
+        - name: replayBarrier
+          description: request a completion marker after ordered replay
+          in: query
+          required: false
+          type: boolean
       tags:
         - Puppet
   /friendship/accept/{id}:
@@ -4315,12 +4320,13 @@ definitions:
       - EVENT_TYPE_ORG_BROADCAST_CREATED
       - EVENT_TYPE_ORG_BROADCAST_SENT
       - EVENT_TYPE_ROOM_MEMBER_LOAD
+      - EVENT_TYPE_REPLAY_COMPLETE
     default: EVENT_TYPE_UNSPECIFIED
-    description: >-
-      - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat
-      login on Mac protocol
+    description: |2-
+       - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol
        - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card
        - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client
+       - EVENT_TYPE_REPLAY_COMPLETE: Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0.
   puppetFriendshipAcceptResponse:
     type: object
   puppetFriendshipAddResponse:

package/out/wechaty/puppet.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Wechaty Puppet Service OpenAPI Specification",
     "description": "Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.\n\nWechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.",
-    "version": "1.0.110",
+    "version": "1.0.111",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -1897,6 +1897,13 @@
             "in": "query",
             "required": false,
             "type": "string"
+          },
+          {
+            "name": "replayBarrier",
+            "description": "request a completion marker after ordered replay",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
           }
         ],
         "tags": [
@@ -6331,10 +6338,11 @@
         "EVENT_TYPE_SAME_NET_VERIFY",
         "EVENT_TYPE_ORG_BROADCAST_CREATED",
         "EVENT_TYPE_ORG_BROADCAST_SENT",
-        "EVENT_TYPE_ROOM_MEMBER_LOAD"
+        "EVENT_TYPE_ROOM_MEMBER_LOAD",
+        "EVENT_TYPE_REPLAY_COMPLETE"
       ],
       "default": "EVENT_TYPE_UNSPECIFIED",
-      "description": "- EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol\n - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card\n - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client"
+      "description": " - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat login on Mac protocol\n - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card\n - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client\n - EVENT_TYPE_REPLAY_COMPLETE: Opt-in stream barrier: payload {accountId, throughSeq}, envelope seq=0."
     },
     "puppetFriendshipAcceptResponse": {
       "type": "object"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-grpc",
-  "version": "1.0.110",
+  "version": "1.0.111",
   "description": "gRPC for Wechaty",
   "type": "module",
   "exports": {

package/src/package-json.ts

@@ -4,7 +4,7 @@
 import type { PackageJson } from 'type-fest'
 export const packageJson: PackageJson = {
   "name": "@juzi/wechaty-grpc",
-  "version": "1.0.110",
+  "version": "1.0.111",
   "description": "gRPC for Wechaty",
   "type": "module",
   "exports": {