@couch-kit/client 0.15.1 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @couch-kit/client
 
+## 0.16.0
+
+### Minor Changes
+
+- [#210](https://github.com/faluciano/react-native-couch-kit/pull/210) [`0810bd2`](https://github.com/faluciano/react-native-couch-kit/commit/0810bd28a55fca11eb780c9ba19e3c8e17d4086d) Thanks [@faluciano](https://github.com/faluciano)! - Relay protocol support for display resumption. `CreateRoomMessage` gains an optional `resumeToken` and `RoomCreatedMessage` carries one. New in this release:
+
+  - the `ROOM_RESUMED` message type (`RoomResumedMessage`, which lists the phones still in the room)
+  - the `RELAY_CLOSE_HOST_REPLACED` (4002) close code
+  - `RELAY_HOST_RESUME_GRACE_MS` (30 seconds)
+
+  Phones need no change. They stay connected while a display reconnects.
+
 ## 0.15.1
 
 ### Patch Changes

package/dist/index.js

@@ -399,6 +399,7 @@ function useGameClient(config) {
 var RelayMessageTypes = {
   CREATE_ROOM: "CREATE_ROOM",
   ROOM_CREATED: "ROOM_CREATED",
+  ROOM_RESUMED: "ROOM_RESUMED",
   JOIN_ROOM: "JOIN_ROOM",
   ROOM_JOINED: "ROOM_JOINED",
   PEER_JOINED: "PEER_JOINED",
@@ -419,6 +420,8 @@ var RelayErrorCodes = {
   HOST_LEFT: "HOST_LEFT"
 };
 var RELAY_CLOSE_HOST_LEFT = 4001;
+var RELAY_CLOSE_HOST_REPLACED = 4002;
+var RELAY_HOST_RESUME_GRACE_MS = 30000;
 function relayRoomUrl(url, roomId) {
   const trimmed = url.replace(/\/+$/, "");
   const [base, query] = trimmed.split("?", 2);
@@ -717,6 +720,8 @@ function useDebugPanel(options) {
 export {
   DEFAULT_OPTIMISTIC_TIMEOUT,
   RELAY_CLOSE_HOST_LEFT,
+  RELAY_CLOSE_HOST_REPLACED,
+  RELAY_HOST_RESUME_GRACE_MS,
   RELAY_MINT_PATH,
   RelayClientTransport,
   RelayErrorCodes,

package/lib/relay-protocol.d.ts

@@ -17,6 +17,8 @@ export declare const RelayMessageTypes: {
     readonly CREATE_ROOM: "CREATE_ROOM";
     /** Relay → display: room created; includes the display's own `peerId`. */
     readonly ROOM_CREATED: "ROOM_CREATED";
+    /** Relay → display: a dropped display took its room back; lists the phones still in it. */
+    readonly ROOM_RESUMED: "ROOM_RESUMED";
     /** Phone → relay: join an existing room. */
     readonly JOIN_ROOM: "JOIN_ROOM";
     /** Relay → phone: joined; includes the phone's assigned `peerId`. */
@@ -57,17 +59,56 @@ export declare const RelayErrorCodes: {
  * phones are dropped with it.
  */
 export declare const RELAY_CLOSE_HOST_LEFT = 4001;
+/**
+ * WebSocket close code the relay sends a host connection that another
+ * connection has resumed the room from — typically the display's own previous
+ * socket, which the relay had not yet noticed was dead.
+ */
+export declare const RELAY_CLOSE_HOST_REPLACED = 4002;
+/**
+ * How long the relay keeps a room whose display dropped without closing its
+ * socket, waiting for it to resume. Phones stay connected meanwhile, and what
+ * they send is held for the display (up to a bound).
+ */
+export declare const RELAY_HOST_RESUME_GRACE_MS = 30000;
 export type RelayErrorCode = (typeof RelayErrorCodes)[keyof typeof RelayErrorCodes];
-/** Display → relay: create and host a room. */
+/**
+ * Display → relay: create and host a room — or, with `resumeToken`, take back
+ * a room this display was hosting before its connection dropped.
+ */
 export interface CreateRoomMessage {
     type: typeof RelayMessageTypes.CREATE_ROOM;
     roomId: string;
+    /**
+     * The token from this room's {@link RoomCreatedMessage}. Present only when
+     * resuming; the relay then answers {@link RoomResumedMessage}, or
+     * `ROOM_NOT_FOUND` if the room has already gone.
+     */
+    resumeToken?: string;
 }
 /** Relay → display: room created; `peerId` is the display's own id. */
 export interface RoomCreatedMessage {
     type: typeof RelayMessageTypes.ROOM_CREATED;
     roomId: string;
     peerId: string;
+    /**
+     * The credential for resuming this room after a dropped connection. Sent
+     * only to the host; anyone holding it can take the room over. Absent from
+     * relays that predate resumption.
+     */
+    resumeToken?: string;
+}
+/**
+ * Relay → display: the room is this connection's again. `peers` are the phones
+ * in the room now — phones that left while the display was away are not in
+ * it, and phones that arrived are. Anything phones sent meanwhile follows as
+ * ordinary `DATA` frames.
+ */
+export interface RoomResumedMessage {
+    type: typeof RelayMessageTypes.ROOM_RESUMED;
+    roomId: string;
+    peerId: string;
+    peers: string[];
 }
 /** Phone → relay: join an existing room. */
 export interface JoinRoomMessage {
@@ -136,7 +177,7 @@ export interface RelayErrorMessage {
 /** Any message a client may send to the relay. */
 export type RelayClientMessage = CreateRoomMessage | JoinRoomMessage | DataMessage | DataMultiMessage;
 /** Any message the relay may send to a client. */
-export type RelayServerMessage = RoomCreatedMessage | RoomJoinedMessage | PeerJoinedMessage | PeerLeftMessage | DataMessage | RelayErrorMessage;
+export type RelayServerMessage = RoomCreatedMessage | RoomResumedMessage | RoomJoinedMessage | PeerJoinedMessage | PeerLeftMessage | DataMessage | RelayErrorMessage;
 /** Every relay wire message. */
 export type RelayMessage = RelayClientMessage | RelayServerMessage;
 /**

package/lib/relay-protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"relay-protocol.d.ts","sourceRoot":"","sources":["../src/relay-protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB;IAC5B,8DAA8D;aAC9D,WAAW,EAAE,aAAa;IAC1B,0EAA0E;aAC1E,YAAY,EAAE,cAAc;IAC5B,4CAA4C;aAC5C,SAAS,EAAE,WAAW;IACtB,qEAAqE;aACrE,WAAW,EAAE,aAAa;IAC1B,gDAAgD;aAChD,WAAW,EAAE,aAAa;IAC1B,8CAA8C;aAC9C,SAAS,EAAE,WAAW;IACtB,yEAAyE;aACzE,IAAI,EAAE,MAAM;IACZ,yEAAyE;aACzE,UAAU,EAAE,YAAY;IACxB,6CAA6C;aAC7C,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,eAAe;aAC1B,cAAc,EAAE,gBAAgB;aAChC,WAAW,EAAE,aAAa;aAC1B,SAAS,EAAE,WAAW;aACtB,WAAW,EAAE,aAAa;aAC1B,iBAAiB,EAAE,mBAAmB;aACtC,SAAS,EAAE,WAAW;IACtB,yEAAyE;aACzE,YAAY,EAAE,cAAc;IAC5B,qCAAqC;aACrC,WAAW,EAAE,aAAa;IAC1B;;;;;OAKG;aACH,SAAS,EAAE,WAAW;CACd,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,qBAAqB,OAAO,CAAC;AAE1C,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEzD,+CAA+C;AAC/C,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,uEAAuE;AACvE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,iBAAiB,CAAC,YAAY,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qCAAqC;AACrC,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,iBAAiB,CAAC,IAAI,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,iBAAiB,CAAC,UAAU,CAAC;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,GAC5B,iBAAiB,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC;AAEvE,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,WAAW,GACX,iBAAiB,CAAC;AAEtB,gCAAgC;AAChC,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEnE;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAQjE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,SAAS,CAAC"}
+{"version":3,"file":"relay-protocol.d.ts","sourceRoot":"","sources":["../src/relay-protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB;IAC5B,8DAA8D;aAC9D,WAAW,EAAE,aAAa;IAC1B,0EAA0E;aAC1E,YAAY,EAAE,cAAc;IAC5B,2FAA2F;aAC3F,YAAY,EAAE,cAAc;IAC5B,4CAA4C;aAC5C,SAAS,EAAE,WAAW;IACtB,qEAAqE;aACrE,WAAW,EAAE,aAAa;IAC1B,gDAAgD;aAChD,WAAW,EAAE,aAAa;IAC1B,8CAA8C;aAC9C,SAAS,EAAE,WAAW;IACtB,yEAAyE;aACzE,IAAI,EAAE,MAAM;IACZ,yEAAyE;aACzE,UAAU,EAAE,YAAY;IACxB,6CAA6C;aAC7C,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,eAAe;aAC1B,cAAc,EAAE,gBAAgB;aAChC,WAAW,EAAE,aAAa;aAC1B,SAAS,EAAE,WAAW;aACtB,WAAW,EAAE,aAAa;aAC1B,iBAAiB,EAAE,mBAAmB;aACtC,SAAS,EAAE,WAAW;IACtB,yEAAyE;aACzE,YAAY,EAAE,cAAc;IAC5B,qCAAqC;aACrC,WAAW,EAAE,aAAa;IAC1B;;;;;OAKG;aACH,SAAS,EAAE,WAAW;CACd,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,qBAAqB,OAAO,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,OAAO,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,QAAS,CAAC;AAEjD,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,uEAAuE;AACvE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,iBAAiB,CAAC,YAAY,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,iBAAiB,CAAC,YAAY,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qCAAqC;AACrC,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,iBAAiB,CAAC,IAAI,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,iBAAiB,CAAC,UAAU,CAAC;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,GAC5B,iBAAiB,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC;AAEvE,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,WAAW,GACX,iBAAiB,CAAC;AAEtB,gCAAgC;AAChC,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEnE;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAQjE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,SAAS,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@couch-kit/client",
-  "version": "0.15.1",
+  "version": "0.16.0",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/relay-protocol.ts

@@ -18,6 +18,8 @@ export const RelayMessageTypes = {
   CREATE_ROOM: "CREATE_ROOM",
   /** Relay → display: room created; includes the display's own `peerId`. */
   ROOM_CREATED: "ROOM_CREATED",
+  /** Relay → display: a dropped display took its room back; lists the phones still in it. */
+  ROOM_RESUMED: "ROOM_RESUMED",
   /** Phone → relay: join an existing room. */
   JOIN_ROOM: "JOIN_ROOM",
   /** Relay → phone: joined; includes the phone's assigned `peerId`. */
@@ -61,13 +63,36 @@ export const RelayErrorCodes = {
  */
 export const RELAY_CLOSE_HOST_LEFT = 4001;
 
+/**
+ * WebSocket close code the relay sends a host connection that another
+ * connection has resumed the room from — typically the display's own previous
+ * socket, which the relay had not yet noticed was dead.
+ */
+export const RELAY_CLOSE_HOST_REPLACED = 4002;
+
+/**
+ * How long the relay keeps a room whose display dropped without closing its
+ * socket, waiting for it to resume. Phones stay connected meanwhile, and what
+ * they send is held for the display (up to a bound).
+ */
+export const RELAY_HOST_RESUME_GRACE_MS = 30_000;
+
 export type RelayErrorCode =
   (typeof RelayErrorCodes)[keyof typeof RelayErrorCodes];
 
-/** Display → relay: create and host a room. */
+/**
+ * Display → relay: create and host a room — or, with `resumeToken`, take back
+ * a room this display was hosting before its connection dropped.
+ */
 export interface CreateRoomMessage {
   type: typeof RelayMessageTypes.CREATE_ROOM;
   roomId: string;
+  /**
+   * The token from this room's {@link RoomCreatedMessage}. Present only when
+   * resuming; the relay then answers {@link RoomResumedMessage}, or
+   * `ROOM_NOT_FOUND` if the room has already gone.
+   */
+  resumeToken?: string;
 }
 
 /** Relay → display: room created; `peerId` is the display's own id. */
@@ -75,6 +100,25 @@ export interface RoomCreatedMessage {
   type: typeof RelayMessageTypes.ROOM_CREATED;
   roomId: string;
   peerId: string;
+  /**
+   * The credential for resuming this room after a dropped connection. Sent
+   * only to the host; anyone holding it can take the room over. Absent from
+   * relays that predate resumption.
+   */
+  resumeToken?: string;
+}
+
+/**
+ * Relay → display: the room is this connection's again. `peers` are the phones
+ * in the room now — phones that left while the display was away are not in
+ * it, and phones that arrived are. Anything phones sent meanwhile follows as
+ * ordinary `DATA` frames.
+ */
+export interface RoomResumedMessage {
+  type: typeof RelayMessageTypes.ROOM_RESUMED;
+  roomId: string;
+  peerId: string;
+  peers: string[];
 }
 
 /** Phone → relay: join an existing room. */
@@ -155,6 +199,7 @@ export type RelayClientMessage =
 /** Any message the relay may send to a client. */
 export type RelayServerMessage =
   | RoomCreatedMessage
+  | RoomResumedMessage
   | RoomJoinedMessage
   | PeerJoinedMessage
   | PeerLeftMessage