@formant/realtime-sdk 0.0.1 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/client/AuthClient.d.ts +3 -3
  2. package/dist/client/LanAgentClient.d.ts +7 -0
  3. package/dist/common/config/index.d.ts +1 -0
  4. package/dist/common/narrowError.d.ts +1 -1
  5. package/dist/index.js +1 -1
  6. package/dist/model/Feature.d.ts +3 -0
  7. package/dist/model/IColorRGBA.d.ts +6 -0
  8. package/dist/model/IGetFeaturesResponse.d.ts +4 -0
  9. package/dist/model/IJointState.d.ts +4 -2
  10. package/dist/model/IMarker3D.d.ts +23 -0
  11. package/dist/model/IMarker3DArray.d.ts +4 -0
  12. package/dist/model/IPoint.d.ts +2 -0
  13. package/dist/model/IPoseWithCovariance.d.ts +5 -0
  14. package/dist/model/IPostLanRtcOfferRequest.d.ts +3 -0
  15. package/dist/model/IPostLanRtcOfferResponse.d.ts +3 -0
  16. package/dist/model/IUser.d.ts +3 -2
  17. package/dist/model/Marker3DAction.d.ts +2 -0
  18. package/dist/model/Marker3DType.d.ts +2 -0
  19. package/dist/model/bytes.d.ts +9 -0
  20. package/dist/model/features.d.ts +2 -0
  21. package/dist/model/marker3DActions.d.ts +1 -0
  22. package/dist/model/marker3DTypes.d.ts +1 -0
  23. package/dist/model/rtcStreamTypes.d.ts +6 -1
  24. package/dist/protos/api/signaling/v1/signaling.proto +15 -1
  25. package/dist/protos/api/signaling/v1/signaling_grpc_pb.js +33 -0
  26. package/dist/protos/api/signaling/v1/signaling_grpc_web_pb.d.ts +12 -0
  27. package/dist/protos/api/signaling/v1/signaling_grpc_web_pb.js +80 -0
  28. package/dist/protos/api/signaling/v1/signaling_pb.d.ts +41 -0
  29. package/dist/protos/api/signaling/v1/signaling_pb.js +316 -1
  30. package/dist/rtc-client/RtcClient.d.ts +9 -0
  31. package/dist/rtc-client/RtcConnection.d.ts +4 -2
  32. package/dist/rtc-client/models/IRtcAgentInfo.d.ts +3 -0
  33. package/dist/rtc-client/models/IRtcClientConfiguration.d.ts +10 -5
  34. package/dist/rtc-client/models/IRtcConnectionBaseConfiguration.d.ts +14 -0
  35. package/dist/rtc-client/models/IRtcConnectionConfiguration.d.ts +6 -15
  36. package/dist/rtc-client/models/IRtcConnectionRemoteConfiguration.d.ts +6 -0
  37. package/dist/rtc-client/models/IRtcPointCloud.d.ts +5 -0
  38. package/dist/rtc-client/models/IRtcStreamPayload.d.ts +10 -0
  39. package/dist/rtc-client/models/IStreamControl.d.ts +4 -1
  40. package/package.json +33 -33
  41. package/dist/1.index.js +0 -1
  42. package/dist/model/Role.d.ts +0 -2
  43. package/dist/model/roles.d.ts +0 -1
@@ -0,0 +1,3 @@
1
+ import { agentFeatures, features } from "./features";
2
+ export declare type Feature = typeof features[number];
3
+ export declare type AgentFeature = typeof agentFeatures[number];
@@ -0,0 +1,6 @@
1
+ export interface IColorRGBA {
2
+ r: number;
3
+ g: number;
4
+ b: number;
5
+ a: number;
6
+ }
@@ -0,0 +1,4 @@
1
+ import { Feature } from "./Feature";
2
+ export interface IGetFeaturesResponse {
3
+ features: Feature[];
4
+ }
@@ -1,6 +1,8 @@
1
+ import { ITransform } from "./ITransform";
1
2
  export interface IJointState {
3
+ world_to_local?: ITransform;
2
4
  name: string[];
3
5
  position: number[];
4
- velocity: number[];
5
- effort: number[];
6
+ velocity?: number[];
7
+ effort?: number[];
6
8
  }
@@ -0,0 +1,23 @@
1
+ import { IColorRGBA } from "./IColorRGBA";
2
+ import { ITransform } from "./ITransform";
3
+ import { IVector3 } from "./IVector3";
4
+ import { Marker3DAction } from "./Marker3DAction";
5
+ import { Marker3DType } from "./Marker3DType";
6
+ export interface IMarker3D {
7
+ world_to_local?: ITransform;
8
+ ns: string;
9
+ id: number;
10
+ type: Marker3DType;
11
+ action: Marker3DAction;
12
+ pose: ITransform;
13
+ scale: IVector3;
14
+ color: IColorRGBA;
15
+ lifetime: number;
16
+ frame_id: string;
17
+ frame_locked: boolean;
18
+ points: IVector3[];
19
+ colors: IColorRGBA[];
20
+ text: string;
21
+ mesh_resource: string;
22
+ mesh_use_embedded_materials: boolean;
23
+ }
@@ -0,0 +1,4 @@
1
+ import { IMarker3D } from "./IMarker3D";
2
+ export interface IMarker3DArray {
3
+ markers: IMarker3D[];
4
+ }
@@ -0,0 +1,2 @@
1
+ import { IVector3 } from "./IVector3";
2
+ export declare type IPoint = IVector3;
@@ -0,0 +1,5 @@
1
+ import { ITransform } from "./ITransform";
2
+ export interface IPoseWithCovariance {
3
+ pose: ITransform;
4
+ covariance: Array<number>;
5
+ }
@@ -0,0 +1,3 @@
1
+ export interface IPostLanRtcOfferRequest {
2
+ offer: string;
3
+ }
@@ -0,0 +1,3 @@
1
+ export interface IPostLanRtcOfferResponse {
2
+ answer: string;
3
+ }
@@ -1,15 +1,16 @@
1
1
  import { IBaseEntity } from "./IBaseEntity";
2
2
  import { IsoDate } from "./IsoDate";
3
3
  import { ITags } from "./ITags";
4
- import { Role } from "./Role";
5
4
  import { Uuid } from "./Uuid";
6
5
  export interface IUser extends IBaseEntity {
7
6
  organizationId?: Uuid;
8
7
  email: string;
9
8
  firstName: string;
10
9
  lastName: string;
11
- role: Role;
10
+ roleId: Uuid;
11
+ teamId?: Uuid | null;
12
12
  tags: ITags;
13
+ phoneNumber?: string;
13
14
  enabled?: boolean;
14
15
  isOrganizationOwner?: boolean;
15
16
  termsAccepted?: string;
@@ -0,0 +1,2 @@
1
+ import { marker3DActions } from "./marker3DActions";
2
+ export declare type Marker3DAction = typeof marker3DActions[number];
@@ -0,0 +1,2 @@
1
+ import { marker3DTypes } from "./marker3DTypes";
2
+ export declare type Marker3DType = typeof marker3DTypes[number];
@@ -0,0 +1,9 @@
1
+ export declare const bytes: {
2
+ readonly byte: number;
3
+ readonly kilobyte: number;
4
+ readonly kibibyte: number;
5
+ readonly megabyte: number;
6
+ readonly mebibyte: number;
7
+ readonly gigabyte: number;
8
+ readonly gibibyte: number;
9
+ };
@@ -0,0 +1,2 @@
1
+ export declare const agentFeatures: readonly ["telemetry", "internalTelemetry", "teleop", "ssh", "customEvents", "triggeredEvents", "portForwarding", "commands", "interventions", "onDemand", "appConfig", "blobStorage"];
2
+ export declare const features: readonly ["telemetry", "internalTelemetry", "teleop", "ssh", "customEvents", "triggeredEvents", "portForwarding", "commands", "interventions", "onDemand", "appConfig", "blobStorage", "events", "analytics", "annotations", "observability", "diagnostics", "advancedConfiguration", "dataExport", "onDemand", "share", "adapters", "s3Export", "fileStorage", "roleViewer", "teams"];
@@ -0,0 +1 @@
1
+ export declare const marker3DActions: readonly ["add", "modify", "delete", "delete_all"];
@@ -0,0 +1 @@
1
+ export declare const marker3DTypes: readonly ["arrow", "cube", "sphere", "cylinder", "line_strip", "line_list", "cube_list", "sphere_list", "points", "text_view_facing", "mesh_resource", "triangle_list"];
@@ -2,6 +2,7 @@ export declare const rtcPingStreamType: "ping";
2
2
  export declare const rtcPongStreamType: "pong";
3
3
  export declare const rtcStreamControlStreamType: "stream-control";
4
4
  export declare const rtcStreamsInfoStreamType: "streams-info";
5
+ export declare const rtcAgentInfoStreamType: "agent-info";
5
6
  export declare const rtcNumericStreamType: "numeric";
6
7
  export declare const rtcBooleanStreamType: "boolean";
7
8
  export declare const rtcBitsetStreamType: "bitset";
@@ -12,6 +13,10 @@ export declare const rtcAudioChunkStreamType: "audio-chunk";
12
13
  export declare const rtcPoseStreamType: "pose";
13
14
  export declare const rtcGoalIDStreamType: "goal-id";
14
15
  export declare const rtcJointStateStreamType: "joint-state";
15
- export declare const rtcStreamTypes: readonly ["ping", "pong", "stream-control", "streams-info", "numeric", "boolean", "bitset", "twist", "compressed-image", "h264-video-frame", "audio-chunk", "pose", "goal-id", "joint-state"];
16
+ export declare const rtcPoseWithCovarianceStreamType: "pose-with-covariance";
17
+ export declare const rtcPointCloudStreamType: "point-cloud";
18
+ export declare const rtcMarkerArrayStreamType: "marker-array";
19
+ export declare const rtcPointStreamType: "point";
20
+ export declare const rtcStreamTypes: readonly ["ping", "pong", "stream-control", "streams-info", "agent-info", "numeric", "boolean", "bitset", "twist", "compressed-image", "h264-video-frame", "audio-chunk", "pose", "goal-id", "joint-state", "pose-with-covariance", "point-cloud", "point", "marker-array"];
16
21
  export declare const rtcImageStreamTypes: string[];
17
22
  export declare const rtcSystemStreamTypes: string[];
@@ -14,6 +14,8 @@ service Signaling {
14
14
  returns (RefreshPeerResponse) {}
15
15
  rpc GetPeers(GetPeersRequest)
16
16
  returns (GetPeersResponse) {}
17
+ rpc GetIceServers(GetIceServersRequest)
18
+ returns (GetIceServersResponse) {}
17
19
  rpc SendSignal(SendSignalRequest)
18
20
  returns (SendSignalResponse) {}
19
21
  rpc ReceiveSignalStream(ReceiveSignalStreamRequest)
@@ -29,14 +31,21 @@ message Peer {
29
31
  google.protobuf.Int64Value peer_created_timestamp = 6; // No value means it's for a new peer
30
32
  }
31
33
 
34
+ enum SessionType {
35
+ UNKNOWN = 0;
36
+ TELEOP = 1;
37
+ PORT_FORWARD = 2;
38
+ }
39
+
32
40
  message Signal {
33
41
  google.protobuf.StringValue session_id = 1; // No value means it's for a new session
34
42
  google.protobuf.Int64Value session_created_timestamp = 2; // No value means it's for a new session
35
43
  string sender_id = 3;
36
44
  string receiver_id = 4;
37
45
  string payload = 5;
38
- string ice_servers = 6;
46
+ string ice_servers = 6; // JSON-encoded RTCIceServer list
39
47
  string ice_transport_policy = 7;
48
+ SessionType session_type = 8;
40
49
  }
41
50
 
42
51
  message CreatePeerRequest {}
@@ -59,6 +68,11 @@ message GetPeersResponse {
59
68
  repeated Peer peers = 1;
60
69
  }
61
70
 
71
+ message GetIceServersRequest {}
72
+ message GetIceServersResponse {
73
+ string ice_servers = 1; // JSON-encoded RTCIceServer list
74
+ }
75
+
62
76
  message SendSignalRequest {
63
77
  Signal signal = 1;
64
78
  }
@@ -49,6 +49,28 @@ function deserialize_v1_signaling_api_DeletePeerResponse(buffer_arg) {
49
49
  return protos_api_signaling_v1_signaling_pb.DeletePeerResponse.deserializeBinary(new Uint8Array(buffer_arg));
50
50
  }
51
51
 
52
+ function serialize_v1_signaling_api_GetIceServersRequest(arg) {
53
+ if (!(arg instanceof protos_api_signaling_v1_signaling_pb.GetIceServersRequest)) {
54
+ throw new Error('Expected argument of type v1.signaling.api.GetIceServersRequest');
55
+ }
56
+ return Buffer.from(arg.serializeBinary());
57
+ }
58
+
59
+ function deserialize_v1_signaling_api_GetIceServersRequest(buffer_arg) {
60
+ return protos_api_signaling_v1_signaling_pb.GetIceServersRequest.deserializeBinary(new Uint8Array(buffer_arg));
61
+ }
62
+
63
+ function serialize_v1_signaling_api_GetIceServersResponse(arg) {
64
+ if (!(arg instanceof protos_api_signaling_v1_signaling_pb.GetIceServersResponse)) {
65
+ throw new Error('Expected argument of type v1.signaling.api.GetIceServersResponse');
66
+ }
67
+ return Buffer.from(arg.serializeBinary());
68
+ }
69
+
70
+ function deserialize_v1_signaling_api_GetIceServersResponse(buffer_arg) {
71
+ return protos_api_signaling_v1_signaling_pb.GetIceServersResponse.deserializeBinary(new Uint8Array(buffer_arg));
72
+ }
73
+
52
74
  function serialize_v1_signaling_api_GetPeersRequest(arg) {
53
75
  if (!(arg instanceof protos_api_signaling_v1_signaling_pb.GetPeersRequest)) {
54
76
  throw new Error('Expected argument of type v1.signaling.api.GetPeersRequest');
@@ -183,6 +205,17 @@ var SignalingService = exports.SignalingService = {
183
205
  responseSerialize: serialize_v1_signaling_api_GetPeersResponse,
184
206
  responseDeserialize: deserialize_v1_signaling_api_GetPeersResponse,
185
207
  },
208
+ getIceServers: {
209
+ path: '/v1.signaling.api.Signaling/GetIceServers',
210
+ requestStream: false,
211
+ responseStream: false,
212
+ requestType: protos_api_signaling_v1_signaling_pb.GetIceServersRequest,
213
+ responseType: protos_api_signaling_v1_signaling_pb.GetIceServersResponse,
214
+ requestSerialize: serialize_v1_signaling_api_GetIceServersRequest,
215
+ requestDeserialize: deserialize_v1_signaling_api_GetIceServersRequest,
216
+ responseSerialize: serialize_v1_signaling_api_GetIceServersResponse,
217
+ responseDeserialize: deserialize_v1_signaling_api_GetIceServersResponse,
218
+ },
186
219
  sendSignal: {
187
220
  path: '/v1.signaling.api.Signaling/SendSignal',
188
221
  requestStream: false,
@@ -36,6 +36,13 @@ export class SignalingClient {
36
36
  response: protos_api_signaling_v1_signaling_pb.GetPeersResponse) => void
37
37
  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.GetPeersResponse>;
38
38
 
39
+ getIceServers(
40
+ request: protos_api_signaling_v1_signaling_pb.GetIceServersRequest,
41
+ metadata: grpcWeb.Metadata | undefined,
42
+ callback: (err: grpcWeb.Error,
43
+ response: protos_api_signaling_v1_signaling_pb.GetIceServersResponse) => void
44
+ ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.GetIceServersResponse>;
45
+
39
46
  sendSignal(
40
47
  request: protos_api_signaling_v1_signaling_pb.SendSignalRequest,
41
48
  metadata: grpcWeb.Metadata | undefined,
@@ -75,6 +82,11 @@ export class SignalingPromiseClient {
75
82
  metadata?: grpcWeb.Metadata
76
83
  ): Promise<protos_api_signaling_v1_signaling_pb.GetPeersResponse>;
77
84
 
85
+ getIceServers(
86
+ request: protos_api_signaling_v1_signaling_pb.GetIceServersRequest,
87
+ metadata?: grpcWeb.Metadata
88
+ ): Promise<protos_api_signaling_v1_signaling_pb.GetIceServersResponse>;
89
+
78
90
  sendSignal(
79
91
  request: protos_api_signaling_v1_signaling_pb.SendSignalRequest,
80
92
  metadata?: grpcWeb.Metadata
@@ -394,6 +394,86 @@ proto.v1.signaling.api.SignalingPromiseClient.prototype.getPeers =
394
394
  };
395
395
 
396
396
 
397
+ /**
398
+ * @const
399
+ * @type {!grpc.web.MethodDescriptor<
400
+ * !proto.v1.signaling.api.GetIceServersRequest,
401
+ * !proto.v1.signaling.api.GetIceServersResponse>}
402
+ */
403
+ const methodDescriptor_Signaling_GetIceServers = new grpc.web.MethodDescriptor(
404
+ '/v1.signaling.api.Signaling/GetIceServers',
405
+ grpc.web.MethodType.UNARY,
406
+ proto.v1.signaling.api.GetIceServersRequest,
407
+ proto.v1.signaling.api.GetIceServersResponse,
408
+ /**
409
+ * @param {!proto.v1.signaling.api.GetIceServersRequest} request
410
+ * @return {!Uint8Array}
411
+ */
412
+ function(request) {
413
+ return request.serializeBinary();
414
+ },
415
+ proto.v1.signaling.api.GetIceServersResponse.deserializeBinary
416
+ );
417
+
418
+
419
+ /**
420
+ * @const
421
+ * @type {!grpc.web.AbstractClientBase.MethodInfo<
422
+ * !proto.v1.signaling.api.GetIceServersRequest,
423
+ * !proto.v1.signaling.api.GetIceServersResponse>}
424
+ */
425
+ const methodInfo_Signaling_GetIceServers = new grpc.web.AbstractClientBase.MethodInfo(
426
+ proto.v1.signaling.api.GetIceServersResponse,
427
+ /**
428
+ * @param {!proto.v1.signaling.api.GetIceServersRequest} request
429
+ * @return {!Uint8Array}
430
+ */
431
+ function(request) {
432
+ return request.serializeBinary();
433
+ },
434
+ proto.v1.signaling.api.GetIceServersResponse.deserializeBinary
435
+ );
436
+
437
+
438
+ /**
439
+ * @param {!proto.v1.signaling.api.GetIceServersRequest} request The
440
+ * request proto
441
+ * @param {?Object<string, string>} metadata User defined
442
+ * call metadata
443
+ * @param {function(?grpc.web.Error, ?proto.v1.signaling.api.GetIceServersResponse)}
444
+ * callback The callback function(error, response)
445
+ * @return {!grpc.web.ClientReadableStream<!proto.v1.signaling.api.GetIceServersResponse>|undefined}
446
+ * The XHR Node Readable Stream
447
+ */
448
+ proto.v1.signaling.api.SignalingClient.prototype.getIceServers =
449
+ function(request, metadata, callback) {
450
+ return this.client_.rpcCall(this.hostname_ +
451
+ '/v1.signaling.api.Signaling/GetIceServers',
452
+ request,
453
+ metadata || {},
454
+ methodDescriptor_Signaling_GetIceServers,
455
+ callback);
456
+ };
457
+
458
+
459
+ /**
460
+ * @param {!proto.v1.signaling.api.GetIceServersRequest} request The
461
+ * request proto
462
+ * @param {?Object<string, string>} metadata User defined
463
+ * call metadata
464
+ * @return {!Promise<!proto.v1.signaling.api.GetIceServersResponse>}
465
+ * Promise that resolves to the response
466
+ */
467
+ proto.v1.signaling.api.SignalingPromiseClient.prototype.getIceServers =
468
+ function(request, metadata) {
469
+ return this.client_.unaryCall(this.hostname_ +
470
+ '/v1.signaling.api.Signaling/GetIceServers',
471
+ request,
472
+ metadata || {},
473
+ methodDescriptor_Signaling_GetIceServers);
474
+ };
475
+
476
+
397
477
  /**
398
478
  * @const
399
479
  * @type {!grpc.web.MethodDescriptor<
@@ -75,6 +75,9 @@ export class Signal extends jspb.Message {
75
75
  getIceTransportPolicy(): string;
76
76
  setIceTransportPolicy(value: string): Signal;
77
77
 
78
+ getSessionType(): SessionType;
79
+ setSessionType(value: SessionType): Signal;
80
+
78
81
  serializeBinary(): Uint8Array;
79
82
  toObject(includeInstance?: boolean): Signal.AsObject;
80
83
  static toObject(includeInstance: boolean, msg: Signal): Signal.AsObject;
@@ -92,6 +95,7 @@ export namespace Signal {
92
95
  payload: string,
93
96
  iceServers: string,
94
97
  iceTransportPolicy: string,
98
+ sessionType: SessionType,
95
99
  }
96
100
  }
97
101
 
@@ -229,6 +233,38 @@ export namespace GetPeersResponse {
229
233
  }
230
234
  }
231
235
 
236
+ export class GetIceServersRequest extends jspb.Message {
237
+ serializeBinary(): Uint8Array;
238
+ toObject(includeInstance?: boolean): GetIceServersRequest.AsObject;
239
+ static toObject(includeInstance: boolean, msg: GetIceServersRequest): GetIceServersRequest.AsObject;
240
+ static serializeBinaryToWriter(message: GetIceServersRequest, writer: jspb.BinaryWriter): void;
241
+ static deserializeBinary(bytes: Uint8Array): GetIceServersRequest;
242
+ static deserializeBinaryFromReader(message: GetIceServersRequest, reader: jspb.BinaryReader): GetIceServersRequest;
243
+ }
244
+
245
+ export namespace GetIceServersRequest {
246
+ export type AsObject = {
247
+ }
248
+ }
249
+
250
+ export class GetIceServersResponse extends jspb.Message {
251
+ getIceServers(): string;
252
+ setIceServers(value: string): GetIceServersResponse;
253
+
254
+ serializeBinary(): Uint8Array;
255
+ toObject(includeInstance?: boolean): GetIceServersResponse.AsObject;
256
+ static toObject(includeInstance: boolean, msg: GetIceServersResponse): GetIceServersResponse.AsObject;
257
+ static serializeBinaryToWriter(message: GetIceServersResponse, writer: jspb.BinaryWriter): void;
258
+ static deserializeBinary(bytes: Uint8Array): GetIceServersResponse;
259
+ static deserializeBinaryFromReader(message: GetIceServersResponse, reader: jspb.BinaryReader): GetIceServersResponse;
260
+ }
261
+
262
+ export namespace GetIceServersResponse {
263
+ export type AsObject = {
264
+ iceServers: string,
265
+ }
266
+ }
267
+
232
268
  export class SendSignalRequest extends jspb.Message {
233
269
  getSignal(): Signal | undefined;
234
270
  setSignal(value?: Signal): SendSignalRequest;
@@ -313,3 +349,8 @@ export namespace ReceiveSignalStreamResponse {
313
349
  }
314
350
  }
315
351
 
352
+ export enum SessionType {
353
+ UNKNOWN = 0,
354
+ TELEOP = 1,
355
+ PORT_FORWARD = 2,
356
+ }