@formant/realtime-sdk 1.0.0 → 1.2.0

package/dist/model/IRtcSession.d.ts

@@ -1,5 +1,6 @@
 import { IRtcPeerDescription } from "./IRtcPeerDescription";
 import { IsoDate } from "./IsoDate";
+import { RtcSessionType } from "./RtcSessionType";
 import { Uuid } from "./Uuid";
 export interface IRtcSession {
     id: Uuid;
@@ -7,4 +8,5 @@ export interface IRtcSession {
     offer: IRtcPeerDescription;
     answer: IRtcPeerDescription;
     created: IsoDate;
+    sessionType?: RtcSessionType;
 }

package/dist/model/IUser.d.ts

@@ -10,6 +10,7 @@ export interface IUser extends ITaggedEntity {
     accountId?: Uuid | null;
     roleId: Uuid | null;
     email?: string;
+    externalUserId?: string | null;
     firstName?: string;
     lastName?: string;
     scope?: IUserScope | null;

package/dist/model/RtcSessionType.d.ts

@@ -0,0 +1,2 @@
+import { rtcSessionTypes } from "./rtcSessionTypes";
+export type RtcSessionType = (typeof rtcSessionTypes)[number];

package/dist/model/rtcSessionTypes.d.ts

@@ -0,0 +1 @@
+export declare const rtcSessionTypes: readonly ["teleop", "port-forwarding", "observe"];

package/dist/protos/api/signaling/v1/signaling.proto

@@ -22,6 +22,8 @@ service Signaling {
         returns (SendSignalResponse) {}
     rpc ReceiveSignalStream(ReceiveSignalStreamRequest)
         returns (stream ReceiveSignalStreamResponse) {}
+    rpc GetSessions(GetSessionsRequest)
+        returns (GetSessionsResponse) {}
 }
 
 message Peer {
@@ -38,6 +40,7 @@ enum SessionType {
     TELEOP = 1;
     PORT_FORWARD = 2;
     OBSERVE = 3;
+    HEADLESS = 4;
 }
 
 message Signal {
@@ -51,6 +54,20 @@ message Signal {
     SessionType session_type = 8;
 }
 
+message RtcSession {
+    string session_id = 1;
+    string offer_peer_id = 2;
+    string answer_peer_id = 3;
+    string organization_id = 4;
+    string session_type = 5;
+}
+
+message GetSessionsRequest {
+}
+message GetSessionsResponse {
+    repeated RtcSession sessions = 1;
+}
+
 message GetHealthRequest {}
 message GetHealthResponse {
     string version = 1;

package/dist/protos/api/signaling/v1/signaling_grpc_web_pb.d.ts

@@ -62,6 +62,13 @@ export class SignalingClient {
     metadata?: grpcWeb.Metadata
   ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.ReceiveSignalStreamResponse>;
 
+  getSessions(
+    request: api_signaling_v1_signaling_pb.GetSessionsRequest,
+    metadata: grpcWeb.Metadata | undefined,
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.GetSessionsResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.GetSessionsResponse>;
+
 }
 
 export class SignalingPromiseClient {
@@ -109,5 +116,10 @@ export class SignalingPromiseClient {
     metadata?: grpcWeb.Metadata
   ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.ReceiveSignalStreamResponse>;
 
+  getSessions(
+    request: api_signaling_v1_signaling_pb.GetSessionsRequest,
+    metadata?: grpcWeb.Metadata
+  ): Promise<api_signaling_v1_signaling_pb.GetSessionsResponse>;
+
 }
 

package/dist/protos/api/signaling/v1/signaling_grpc_web_pb.js

@@ -561,5 +561,66 @@ proto.v1.signaling.api.SignalingPromiseClient.prototype.receiveSignalStream =
 };
 
 
+/**
+ * @const
+ * @type {!grpc.web.MethodDescriptor<
+ *   !proto.v1.signaling.api.GetSessionsRequest,
+ *   !proto.v1.signaling.api.GetSessionsResponse>}
+ */
+const methodDescriptor_Signaling_GetSessions = new grpc.web.MethodDescriptor(
+  '/v1.signaling.api.Signaling/GetSessions',
+  grpc.web.MethodType.UNARY,
+  proto.v1.signaling.api.GetSessionsRequest,
+  proto.v1.signaling.api.GetSessionsResponse,
+  /**
+   * @param {!proto.v1.signaling.api.GetSessionsRequest} request
+   * @return {!Uint8Array}
+   */
+  function(request) {
+    return request.serializeBinary();
+  },
+  proto.v1.signaling.api.GetSessionsResponse.deserializeBinary
+);
+
+
+/**
+ * @param {!proto.v1.signaling.api.GetSessionsRequest} request The
+ *     request proto
+ * @param {?Object<string, string>} metadata User defined
+ *     call metadata
+ * @param {function(?grpc.web.RpcError, ?proto.v1.signaling.api.GetSessionsResponse)}
+ *     callback The callback function(error, response)
+ * @return {!grpc.web.ClientReadableStream<!proto.v1.signaling.api.GetSessionsResponse>|undefined}
+ *     The XHR Node Readable Stream
+ */
+proto.v1.signaling.api.SignalingClient.prototype.getSessions =
+    function(request, metadata, callback) {
+  return this.client_.rpcCall(this.hostname_ +
+      '/v1.signaling.api.Signaling/GetSessions',
+      request,
+      metadata || {},
+      methodDescriptor_Signaling_GetSessions,
+      callback);
+};
+
+
+/**
+ * @param {!proto.v1.signaling.api.GetSessionsRequest} request The
+ *     request proto
+ * @param {?Object<string, string>=} metadata User defined
+ *     call metadata
+ * @return {!Promise<!proto.v1.signaling.api.GetSessionsResponse>}
+ *     Promise that resolves to the response
+ */
+proto.v1.signaling.api.SignalingPromiseClient.prototype.getSessions =
+    function(request, metadata) {
+  return this.client_.unaryCall(this.hostname_ +
+      '/v1.signaling.api.Signaling/GetSessions',
+      request,
+      metadata || {},
+      methodDescriptor_Signaling_GetSessions);
+};
+
+
 module.exports = proto.v1.signaling.api;
 

package/dist/protos/api/signaling/v1/signaling_pb.d.ts

@@ -99,6 +99,74 @@ export namespace Signal {
   }
 }
 
+export class RtcSession extends jspb.Message {
+  getSessionId(): string;
+  setSessionId(value: string): RtcSession;
+
+  getOfferPeerId(): string;
+  setOfferPeerId(value: string): RtcSession;
+
+  getAnswerPeerId(): string;
+  setAnswerPeerId(value: string): RtcSession;
+
+  getOrganizationId(): string;
+  setOrganizationId(value: string): RtcSession;
+
+  getSessionType(): string;
+  setSessionType(value: string): RtcSession;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): RtcSession.AsObject;
+  static toObject(includeInstance: boolean, msg: RtcSession): RtcSession.AsObject;
+  static serializeBinaryToWriter(message: RtcSession, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): RtcSession;
+  static deserializeBinaryFromReader(message: RtcSession, reader: jspb.BinaryReader): RtcSession;
+}
+
+export namespace RtcSession {
+  export type AsObject = {
+    sessionId: string,
+    offerPeerId: string,
+    answerPeerId: string,
+    organizationId: string,
+    sessionType: string,
+  }
+}
+
+export class GetSessionsRequest extends jspb.Message {
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): GetSessionsRequest.AsObject;
+  static toObject(includeInstance: boolean, msg: GetSessionsRequest): GetSessionsRequest.AsObject;
+  static serializeBinaryToWriter(message: GetSessionsRequest, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): GetSessionsRequest;
+  static deserializeBinaryFromReader(message: GetSessionsRequest, reader: jspb.BinaryReader): GetSessionsRequest;
+}
+
+export namespace GetSessionsRequest {
+  export type AsObject = {
+  }
+}
+
+export class GetSessionsResponse extends jspb.Message {
+  getSessionsList(): Array<RtcSession>;
+  setSessionsList(value: Array<RtcSession>): GetSessionsResponse;
+  clearSessionsList(): GetSessionsResponse;
+  addSessions(value?: RtcSession, index?: number): RtcSession;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): GetSessionsResponse.AsObject;
+  static toObject(includeInstance: boolean, msg: GetSessionsResponse): GetSessionsResponse.AsObject;
+  static serializeBinaryToWriter(message: GetSessionsResponse, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): GetSessionsResponse;
+  static deserializeBinaryFromReader(message: GetSessionsResponse, reader: jspb.BinaryReader): GetSessionsResponse;
+}
+
+export namespace GetSessionsResponse {
+  export type AsObject = {
+    sessionsList: Array<RtcSession.AsObject>,
+  }
+}
+
 export class GetHealthRequest extends jspb.Message {
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): GetHealthRequest.AsObject;
@@ -386,4 +454,5 @@ export enum SessionType {
   TELEOP = 1,
   PORT_FORWARD = 2,
   OBSERVE = 3,
+  HEADLESS = 4,
 }