@pulsebeam/peer 0.0.14 → 0.0.16

package/dist/index.d.cts

@@ -114,9 +114,9 @@ declare class RecvReq$Type extends MessageType<RecvReq> {
  */
 interface RecvReq {
     /**
-     * @generated from protobuf field: pulsebeam.v1.PeerInfo info = 1;
+     * @generated from protobuf field: pulsebeam.v1.PeerInfo src = 1;
      */
-    info?: PeerInfo;
+    src?: PeerInfo;
 }
 /**
  * @generated MessageType for protobuf message pulsebeam.v1.RecvReq
@@ -146,13 +146,22 @@ declare class PeerInfo$Type extends MessageType<PeerInfo> {
  */
 interface PeerInfo {
     /**
-     * @generated from protobuf field: uint32 conn_id = 1;
+     * @generated from protobuf field: string group_id = 1;
      */
-    connId: number;
+    groupId: string;
+    /**
+     * where this message is originated from. Special values: "SYSTEM"
+     *
+     * @generated from protobuf field: string peer_id = 2;
+     */
+    peerId: string;
     /**
-     * @generated from protobuf field: bool enable_discovery = 2;
+     * used for deciding polite vs impolite. higher id wins. It also is used to detect connection breakages
+     * WARNING, reserved values: 0-16
+     *
+     * @generated from protobuf field: uint32 conn_id = 3;
      */
-    enableDiscovery: boolean;
+    connId: number;
 }
 /**
  * @generated MessageType for protobuf message pulsebeam.v1.PeerInfo
@@ -235,29 +244,13 @@ declare class MessageHeader$Type extends MessageType<MessageHeader> {
  */
 interface MessageHeader {
     /**
-     * @generated from protobuf field: string group_id = 1;
+     * @generated from protobuf field: pulsebeam.v1.PeerInfo src = 1;
      */
-    groupId: string;
+    src?: PeerInfo;
     /**
-     * @generated from protobuf field: string peer_id = 2;
+     * @generated from protobuf field: pulsebeam.v1.PeerInfo dst = 2;
      */
-    peerId: string;
-    /**
-     * @generated from protobuf field: uint32 conn_id = 3;
-     */
-    connId: number;
-    /**
-     * @generated from protobuf field: string other_group_id = 4;
-     */
-    otherGroupId: string;
-    /**
-     * @generated from protobuf field: string other_peer_id = 5;
-     */
-    otherPeerId: string;
-    /**
-     * @generated from protobuf field: uint32 other_conn_id = 6;
-     */
-    otherConnId: number;
+    dst?: PeerInfo;
     /**
      * @generated from protobuf field: uint32 seqnum = 7;
      */
@@ -520,20 +513,13 @@ interface ISession {
     close(reason?: string): void;
     /**
      * Retrieves the identifier of the other peer in the connection.
-     * @returns {string} The peer ID of the connected peer. Valid UTF-8 string of 1-16 characters.
-     * @example ```console.log(`Connected to peer: ${session.otherPeerId()}`);```
-     */
-    get otherPeerId(): string;
-    /**
-     * Retrieves the connection identifier for the current connection.
-     * Connection IDs are typically unique and help identify connections.
-     * @returns {number} The connection ID for the peer connection.
-     * @example
-     * ```console.log(`Connection ID: ${mySession.otherConnId()}`);```
+     * @returns {PeerInfo} The peer identity of the connected peer. Valid UTF-8 string of 1-16 characters.
+     * @example ```console.log(`Connected to peer: ${session.other.peerId()}`);```
      */
-    get otherConnId(): number;
+    get other(): PeerInfo;
 }
 /**
+ * Intended to be used by for internal and advanced usecases.
  * Options used to configure a Peer.
  * @interface PeerOptionsFull
  * @example```
@@ -576,6 +562,14 @@ interface PeerOptionsFull {
      */
     iceServers?: RTCIceServer[];
 }
+/**
+ * Options used to configure a Peer. See {@link PeerOptionsFull} for properties.
+ * @interface PeerOptions
+ * @example```
+ * const options: PeerOptions = {
+ *   token: "eyJhbGc...49nLmBCg" // fetch token
+ * };```
+ */
 type PeerOptions = Omit<PeerOptionsFull, "groupId" | "peerId">;
 /**
  * Represents the possible states for a Peer.
@@ -665,4 +659,4 @@ declare class Peer {
  */
 declare function createPeer(opts: PeerOptions): Promise<Peer>;
 
-export { type ISession, Peer, type PeerOptions, type PeerOptionsFull, type PeerState, createPeer };
+export { type ISession, Peer, PeerInfo, type PeerOptions, type PeerOptionsFull, type PeerState, createPeer };

package/dist/index.d.ts

@@ -114,9 +114,9 @@ declare class RecvReq$Type extends MessageType<RecvReq> {
  */
 interface RecvReq {
     /**
-     * @generated from protobuf field: pulsebeam.v1.PeerInfo info = 1;
+     * @generated from protobuf field: pulsebeam.v1.PeerInfo src = 1;
      */
-    info?: PeerInfo;
+    src?: PeerInfo;
 }
 /**
  * @generated MessageType for protobuf message pulsebeam.v1.RecvReq
@@ -146,13 +146,22 @@ declare class PeerInfo$Type extends MessageType<PeerInfo> {
  */
 interface PeerInfo {
     /**
-     * @generated from protobuf field: uint32 conn_id = 1;
+     * @generated from protobuf field: string group_id = 1;
      */
-    connId: number;
+    groupId: string;
+    /**
+     * where this message is originated from. Special values: "SYSTEM"
+     *
+     * @generated from protobuf field: string peer_id = 2;
+     */
+    peerId: string;
     /**
-     * @generated from protobuf field: bool enable_discovery = 2;
+     * used for deciding polite vs impolite. higher id wins. It also is used to detect connection breakages
+     * WARNING, reserved values: 0-16
+     *
+     * @generated from protobuf field: uint32 conn_id = 3;
      */
-    enableDiscovery: boolean;
+    connId: number;
 }
 /**
  * @generated MessageType for protobuf message pulsebeam.v1.PeerInfo
@@ -235,29 +244,13 @@ declare class MessageHeader$Type extends MessageType<MessageHeader> {
  */
 interface MessageHeader {
     /**
-     * @generated from protobuf field: string group_id = 1;
+     * @generated from protobuf field: pulsebeam.v1.PeerInfo src = 1;
      */
-    groupId: string;
+    src?: PeerInfo;
     /**
-     * @generated from protobuf field: string peer_id = 2;
+     * @generated from protobuf field: pulsebeam.v1.PeerInfo dst = 2;
      */
-    peerId: string;
-    /**
-     * @generated from protobuf field: uint32 conn_id = 3;
-     */
-    connId: number;
-    /**
-     * @generated from protobuf field: string other_group_id = 4;
-     */
-    otherGroupId: string;
-    /**
-     * @generated from protobuf field: string other_peer_id = 5;
-     */
-    otherPeerId: string;
-    /**
-     * @generated from protobuf field: uint32 other_conn_id = 6;
-     */
-    otherConnId: number;
+    dst?: PeerInfo;
     /**
      * @generated from protobuf field: uint32 seqnum = 7;
      */
@@ -520,20 +513,13 @@ interface ISession {
     close(reason?: string): void;
     /**
      * Retrieves the identifier of the other peer in the connection.
-     * @returns {string} The peer ID of the connected peer. Valid UTF-8 string of 1-16 characters.
-     * @example ```console.log(`Connected to peer: ${session.otherPeerId()}`);```
-     */
-    get otherPeerId(): string;
-    /**
-     * Retrieves the connection identifier for the current connection.
-     * Connection IDs are typically unique and help identify connections.
-     * @returns {number} The connection ID for the peer connection.
-     * @example
-     * ```console.log(`Connection ID: ${mySession.otherConnId()}`);```
+     * @returns {PeerInfo} The peer identity of the connected peer. Valid UTF-8 string of 1-16 characters.
+     * @example ```console.log(`Connected to peer: ${session.other.peerId()}`);```
      */
-    get otherConnId(): number;
+    get other(): PeerInfo;
 }
 /**
+ * Intended to be used by for internal and advanced usecases.
  * Options used to configure a Peer.
  * @interface PeerOptionsFull
  * @example```
@@ -576,6 +562,14 @@ interface PeerOptionsFull {
      */
     iceServers?: RTCIceServer[];
 }
+/**
+ * Options used to configure a Peer. See {@link PeerOptionsFull} for properties.
+ * @interface PeerOptions
+ * @example```
+ * const options: PeerOptions = {
+ *   token: "eyJhbGc...49nLmBCg" // fetch token
+ * };```
+ */
 type PeerOptions = Omit<PeerOptionsFull, "groupId" | "peerId">;
 /**
  * Represents the possible states for a Peer.
@@ -665,4 +659,4 @@ declare class Peer {
  */
 declare function createPeer(opts: PeerOptions): Promise<Peer>;
 
-export { type ISession, Peer, type PeerOptions, type PeerOptionsFull, type PeerState, createPeer };
+export { type ISession, Peer, PeerInfo, type PeerOptions, type PeerOptionsFull, type PeerState, createPeer };