@formant/realtime-sdk 0.0.20 → 1.1.0

package/dist/model/AnnotationAreaType.d.ts

@@ -1,2 +1,2 @@
 import { IAnnotationAreaTypeMap } from "./IAnnotationAreaTypeMap";
-export declare type AnnotationAreaType = keyof IAnnotationAreaTypeMap;
+export type AnnotationAreaType = keyof IAnnotationAreaTypeMap;

package/dist/model/CognitoRegion.d.ts

@@ -1,2 +1,2 @@
 import { cognitoRegions } from "./cognitoRegions";
-export declare type CognitoRegion = (typeof cognitoRegions)[number];
+export type CognitoRegion = (typeof cognitoRegions)[number];

package/dist/model/Feature.d.ts

@@ -1,3 +1,3 @@
 import { agentFeatures, features } from "./features";
-export declare type Feature = (typeof features)[number];
-export declare type AgentFeature = (typeof agentFeatures)[number];
+export type Feature = (typeof features)[number];
+export type AgentFeature = (typeof agentFeatures)[number];

package/dist/model/HealthStatus.d.ts

@@ -1,2 +1,2 @@
 import { healthStatuses } from "./healthStatuses";
-export declare type HealthStatus = (typeof healthStatuses)[number];
+export type HealthStatus = (typeof healthStatuses)[number];

package/dist/model/HexRgbColor.d.ts

@@ -1 +1 @@
-export declare type HexRgbColor = string;
+export type HexRgbColor = string;

package/dist/model/IDictionary.d.ts

@@ -0,0 +1,3 @@
+export interface IDictionary<T = string> {
+    [key: string]: T;
+}

package/dist/model/IFilter.d.ts

@@ -5,6 +5,6 @@ export interface IFilter {
     deviceIds?: Uuid[];
     names?: string[];
     types?: StreamType[];
-    tags?: ITagSets;
+    tags?: ITagSets | ITagSets[];
     notNames?: string[];
 }

package/dist/model/IPoint.d.ts

@@ -1,2 +1,2 @@
 import { IVector3 } from "./IVector3";
-export declare type IPoint = IVector3;
+export type IPoint = IVector3;

package/dist/model/IRtcSession.d.ts

@@ -1,10 +1,12 @@
 import { IRtcPeerDescription } from "./IRtcPeerDescription";
-import { Uuid } from "./Uuid";
 import { IsoDate } from "./IsoDate";
+import { RtcSessionType } from "./RtcSessionType";
+import { Uuid } from "./Uuid";
 export interface IRtcSession {
     id: Uuid;
     organizationId: Uuid;
     offer: IRtcPeerDescription;
     answer: IRtcPeerDescription;
     created: IsoDate;
+    sessionType?: RtcSessionType;
 }

package/dist/model/ITags.d.ts

@@ -1,3 +1,2 @@
-export interface ITags {
-    [key: string]: string;
-}
+import { IDictionary } from "./IDictionary";
+export type ITags = IDictionary;

package/dist/model/IUser.d.ts

@@ -1,16 +1,21 @@
 import { CognitoRegion } from "./CognitoRegion";
-import { IAccessScope } from "./IAccessScope";
 import { IsoDate } from "./IsoDate";
 import { ITaggedEntity } from "./ITaggedEntity";
+import { IUserScope } from "./IUserScope";
+import { LanguageType } from "./LanguageType";
+import { SmsOptInStatus } from "./SmsOptInStatus";
 import { Uuid } from "./Uuid";
 export interface IUser extends ITaggedEntity {
     organizationId?: Uuid;
+    accountId?: Uuid | null;
+    roleId: Uuid | null;
     email?: string;
+    externalUserId?: string | null;
     firstName?: string;
     lastName?: string;
-    scope?: IAccessScope;
-    roleId: Uuid;
+    scope?: IUserScope | null;
     teamId?: Uuid | null;
+    eventTriggerGroupId?: Uuid | null;
     phoneNumber?: string;
     enabled?: boolean;
     isOrganizationOwner?: boolean;
@@ -19,9 +24,11 @@ export interface IUser extends ITaggedEntity {
     passwordHash?: string | null;
     isSingleSignOn?: boolean;
     isServiceAccount?: boolean;
+    smsOptInStatus?: SmsOptInStatus | null;
     region: CognitoRegion;
     jobTitle?: string;
-    language?: string;
+    language?: LanguageType;
     units?: string;
     timezone?: string;
+    allowCustomEmailConfiguration?: boolean;
 }

package/dist/model/IUserScope.d.ts

@@ -0,0 +1,16 @@
+import { IScopeFilter } from "./IScopeFilter";
+import { RequireKeys } from "./RequireKeys";
+export interface IUserResourceScope {
+    roles?: IScopeFilter;
+    users?: IScopeFilter;
+    teams?: IScopeFilter;
+    devices?: IScopeFilter;
+    fleets?: IScopeFilter;
+    events?: IScopeFilter;
+    views?: IScopeFilter;
+    keyValue?: IScopeFilter;
+}
+export interface IUserScope extends IScopeFilter, IUserResourceScope {
+}
+export type IFullUserScope = IScopeFilter & RequireKeys<IUserResourceScope>;
+export declare const fullAccessUserScope: IFullUserScope;

package/dist/model/IsoDate.d.ts

@@ -1 +1 @@
-export declare type IsoDate = string;
+export type IsoDate = string;

package/dist/model/LanguageType.d.ts

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

package/dist/model/LogLevel.d.ts

@@ -1,2 +1,2 @@
 import { logLevels } from "./logLevels";
-export declare type LogLevel = (typeof logLevels)[number];
+export type LogLevel = (typeof logLevels)[number];

package/dist/model/Marker3DAction.d.ts

@@ -1,2 +1,2 @@
 import { marker3DActions } from "./marker3DActions";
-export declare type Marker3DAction = (typeof marker3DActions)[number];
+export type Marker3DAction = (typeof marker3DActions)[number];

package/dist/model/Marker3DType.d.ts

@@ -1,2 +1,2 @@
 import { marker3DTypes } from "./marker3DTypes";
-export declare type Marker3DType = (typeof marker3DTypes)[number];
+export type Marker3DType = (typeof marker3DTypes)[number];

package/dist/model/OrganizationPlan.d.ts

@@ -1,2 +1,2 @@
 import { organizationPlans } from "./organizationPlans";
-export declare type OrganizationPlan = (typeof organizationPlans)[number];
+export type OrganizationPlan = (typeof organizationPlans)[number];

package/dist/model/RequireKeys.d.ts

@@ -0,0 +1,3 @@
+export type RequireKeys<T> = {
+    [K in keyof T & {}]: T[K];
+};

package/dist/model/RtcConnectionStatus.d.ts

@@ -1,2 +1,2 @@
 import { rtcConnectionStatuses } from "./rtcConnectionStatuses";
-export declare type RtcConnectionStatus = (typeof rtcConnectionStatuses)[number];
+export type RtcConnectionStatus = (typeof rtcConnectionStatuses)[number];

package/dist/model/RtcIceServerProtocol.d.ts

@@ -1,2 +1,2 @@
 import { rtcIceServerProtocols } from "./rtcIceServerProtocols";
-export declare type RtcIceServerProtocol = (typeof rtcIceServerProtocols)[number];
+export type RtcIceServerProtocol = (typeof rtcIceServerProtocols)[number];

package/dist/model/RtcIceTransportPolicy.d.ts

@@ -1,2 +1,2 @@
 import { rtcIceTransportPolicies } from "./rtcIceTransportPolicies";
-export declare type RtcIceTransportPolicy = (typeof rtcIceTransportPolicies)[number];
+export type RtcIceTransportPolicy = (typeof rtcIceTransportPolicies)[number];

package/dist/model/RtcSessionType.d.ts

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

package/dist/model/RtcStreamType.d.ts

@@ -1,3 +1,3 @@
 import { rtcImageStreamTypes, rtcStreamTypes } from "./rtcStreamTypes";
-export declare type RtcStreamType = (typeof rtcStreamTypes)[number];
-export declare type RtcImageStreamType = (typeof rtcImageStreamTypes)[number];
+export type RtcStreamType = (typeof rtcStreamTypes)[number];
+export type RtcImageStreamType = (typeof rtcImageStreamTypes)[number];

package/dist/model/SmsOptInStatus.d.ts

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

package/dist/model/StreamType.d.ts

@@ -1,2 +1,2 @@
 import { IStreamTypeMap } from "./IStreamTypeMap";
-export declare type StreamType = keyof IStreamTypeMap;
+export type StreamType = keyof IStreamTypeMap;

package/dist/model/Timeout.d.ts

@@ -1 +1 @@
-export declare type Timeout = ReturnType<typeof setTimeout>;
+export type Timeout = ReturnType<typeof setTimeout>;

package/dist/model/Timestamp.d.ts

@@ -1 +1 @@
-export declare type Timestamp = number;
+export type Timestamp = number;

package/dist/model/Uuid.d.ts

@@ -1 +1 @@
-export declare type Uuid = string;
+export type Uuid = string;

package/dist/model/VideoMimeType.d.ts

@@ -1,2 +1,2 @@
 import { videoMimeTypes } from "./videoMimeTypes";
-export declare type VideoMimeType = (typeof videoMimeTypes)[number];
+export type VideoMimeType = (typeof videoMimeTypes)[number];

package/dist/model/cognitoRegions.d.ts

@@ -1 +1 @@
-export declare const cognitoRegions: readonly ["AMER", "EMEA"];
+export declare const cognitoRegions: readonly ["AMER", "EMEA", "JAPAC"];

package/dist/model/healthStatuses.d.ts

@@ -1,5 +1,5 @@
 export declare const healthStatuses: readonly ["unknown", "operational", "offline", "error"];
-declare type HealthStatus = (typeof healthStatuses)[number];
+type HealthStatus = (typeof healthStatuses)[number];
 export declare function healthStatusToOrdinal(a: HealthStatus): number;
 export declare function ordinalToHealthStatus(a: number): HealthStatus;
 export {};

package/dist/model/languageTypes.d.ts

@@ -0,0 +1 @@
+export declare const languageTypes: readonly ["en-US", "fr-CA"];

package/dist/model/rtcSessionTypes.d.ts

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

package/dist/model/rtcStreamTypes.d.ts

@@ -20,6 +20,7 @@ export declare const rtcPointCloudStreamType: "point-cloud";
 export declare const rtcMarkerArrayStreamType: "marker-array";
 export declare const rtcPointStreamType: "point";
 export declare const rtcJsonStringType: "json-string";
-export declare const rtcStreamTypes: readonly ["ping", "pong", "ping-v2", "pong-v2", "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", "json-string"];
+export declare const rtcOdometryStreamType: "odometry";
+export declare const rtcStreamTypes: readonly ["ping", "pong", "ping-v2", "pong-v2", "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", "json-string", "odometry"];
 export declare const rtcImageStreamTypes: string[];
 export declare const rtcSystemStreamTypes: string[];

package/dist/model/smsOptInStatuses.d.ts

@@ -0,0 +1 @@
+export declare const smsOptInStatuses: readonly ["OPT_IN", "OPT_OUT"];

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

@@ -1,6 +1,6 @@
 import * as grpcWeb from 'grpc-web';
 
-import * as protos_api_signaling_v1_signaling_pb from '../../../../protos/api/signaling/v1/signaling_pb';
+import * as api_signaling_v1_signaling_pb from '../../../api/signaling/v1/signaling_pb';
 
 
 export class SignalingClient {
@@ -9,58 +9,65 @@ export class SignalingClient {
                options?: null | { [index: string]: any; });
 
   getHealth(
-    request: protos_api_signaling_v1_signaling_pb.GetHealthRequest,
+    request: api_signaling_v1_signaling_pb.GetHealthRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.GetHealthResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.GetHealthResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.GetHealthResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.GetHealthResponse>;
 
   createPeer(
-    request: protos_api_signaling_v1_signaling_pb.CreatePeerRequest,
+    request: api_signaling_v1_signaling_pb.CreatePeerRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.CreatePeerResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.CreatePeerResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.CreatePeerResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.CreatePeerResponse>;
 
   deletePeer(
-    request: protos_api_signaling_v1_signaling_pb.DeletePeerRequest,
+    request: api_signaling_v1_signaling_pb.DeletePeerRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.DeletePeerResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.DeletePeerResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.DeletePeerResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.DeletePeerResponse>;
 
   refreshPeer(
-    request: protos_api_signaling_v1_signaling_pb.RefreshPeerRequest,
+    request: api_signaling_v1_signaling_pb.RefreshPeerRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.RefreshPeerResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.RefreshPeerResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.RefreshPeerResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.RefreshPeerResponse>;
 
   getPeers(
-    request: protos_api_signaling_v1_signaling_pb.GetPeersRequest,
+    request: api_signaling_v1_signaling_pb.GetPeersRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.GetPeersResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.GetPeersResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.GetPeersResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.GetPeersResponse>;
 
   getIceServers(
-    request: protos_api_signaling_v1_signaling_pb.GetIceServersRequest,
+    request: api_signaling_v1_signaling_pb.GetIceServersRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.GetIceServersResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.GetIceServersResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.GetIceServersResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.GetIceServersResponse>;
 
   sendSignal(
-    request: protos_api_signaling_v1_signaling_pb.SendSignalRequest,
+    request: api_signaling_v1_signaling_pb.SendSignalRequest,
     metadata: grpcWeb.Metadata | undefined,
-    callback: (err: grpcWeb.Error,
-               response: protos_api_signaling_v1_signaling_pb.SendSignalResponse) => void
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.SendSignalResponse>;
+    callback: (err: grpcWeb.RpcError,
+               response: api_signaling_v1_signaling_pb.SendSignalResponse) => void
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.SendSignalResponse>;
 
   receiveSignalStream(
-    request: protos_api_signaling_v1_signaling_pb.ReceiveSignalStreamRequest,
+    request: api_signaling_v1_signaling_pb.ReceiveSignalStreamRequest,
     metadata?: grpcWeb.Metadata
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.ReceiveSignalStreamResponse>;
+  ): 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>;
 
 }
 
@@ -70,44 +77,49 @@ export class SignalingPromiseClient {
                options?: null | { [index: string]: any; });
 
   getHealth(
-    request: protos_api_signaling_v1_signaling_pb.GetHealthRequest,
+    request: api_signaling_v1_signaling_pb.GetHealthRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.GetHealthResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.GetHealthResponse>;
 
   createPeer(
-    request: protos_api_signaling_v1_signaling_pb.CreatePeerRequest,
+    request: api_signaling_v1_signaling_pb.CreatePeerRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.CreatePeerResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.CreatePeerResponse>;
 
   deletePeer(
-    request: protos_api_signaling_v1_signaling_pb.DeletePeerRequest,
+    request: api_signaling_v1_signaling_pb.DeletePeerRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.DeletePeerResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.DeletePeerResponse>;
 
   refreshPeer(
-    request: protos_api_signaling_v1_signaling_pb.RefreshPeerRequest,
+    request: api_signaling_v1_signaling_pb.RefreshPeerRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.RefreshPeerResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.RefreshPeerResponse>;
 
   getPeers(
-    request: protos_api_signaling_v1_signaling_pb.GetPeersRequest,
+    request: api_signaling_v1_signaling_pb.GetPeersRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.GetPeersResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.GetPeersResponse>;
 
   getIceServers(
-    request: protos_api_signaling_v1_signaling_pb.GetIceServersRequest,
+    request: api_signaling_v1_signaling_pb.GetIceServersRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.GetIceServersResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.GetIceServersResponse>;
 
   sendSignal(
-    request: protos_api_signaling_v1_signaling_pb.SendSignalRequest,
+    request: api_signaling_v1_signaling_pb.SendSignalRequest,
     metadata?: grpcWeb.Metadata
-  ): Promise<protos_api_signaling_v1_signaling_pb.SendSignalResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.SendSignalResponse>;
 
   receiveSignalStream(
-    request: protos_api_signaling_v1_signaling_pb.ReceiveSignalStreamRequest,
+    request: api_signaling_v1_signaling_pb.ReceiveSignalStreamRequest,
+    metadata?: grpcWeb.Metadata
+  ): grpcWeb.ClientReadableStream<api_signaling_v1_signaling_pb.ReceiveSignalStreamResponse>;
+
+  getSessions(
+    request: api_signaling_v1_signaling_pb.GetSessionsRequest,
     metadata?: grpcWeb.Metadata
-  ): grpcWeb.ClientReadableStream<protos_api_signaling_v1_signaling_pb.ReceiveSignalStreamResponse>;
+  ): Promise<api_signaling_v1_signaling_pb.GetSessionsResponse>;
 
 }