@formant/realtime-sdk 1.1.0 → 1.3.0

package/dist/model/IUser.d.ts

@@ -1,34 +0,0 @@
-import { CognitoRegion } from "./CognitoRegion";
-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?: IUserScope | null;
-    teamId?: Uuid | null;
-    eventTriggerGroupId?: Uuid | null;
-    phoneNumber?: string;
-    enabled?: boolean;
-    isOrganizationOwner?: boolean;
-    termsAccepted?: string;
-    lastLoggedIn?: IsoDate;
-    passwordHash?: string | null;
-    isSingleSignOn?: boolean;
-    isServiceAccount?: boolean;
-    smsOptInStatus?: SmsOptInStatus | null;
-    region: CognitoRegion;
-    jobTitle?: string;
-    language?: LanguageType;
-    units?: string;
-    timezone?: string;
-    allowCustomEmailConfiguration?: boolean;
-}

package/dist/model/IUserScope.d.ts

@@ -1,16 +0,0 @@
-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/IValidation.d.ts

@@ -1,3 +0,0 @@
-export interface IValidation {
-    [key: string]: string[];
-}

package/dist/model/IVector3.d.ts

@@ -1,5 +0,0 @@
-export interface IVector3 {
-    x: number;
-    y: number;
-    z: number;
-}

package/dist/model/IVideo.d.ts

@@ -1,7 +0,0 @@
-import { VideoMimeType } from "./VideoMimeType";
-export interface IVideo {
-    url: string;
-    size?: number;
-    duration: number;
-    mimeType: VideoMimeType;
-}

package/dist/model/IsoDate.d.ts

@@ -1 +0,0 @@
-export type IsoDate = string;

package/dist/model/LanguageType.d.ts

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

package/dist/model/LogLevel.d.ts

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

package/dist/model/Marker3DAction.d.ts

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

package/dist/model/Marker3DType.d.ts

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

package/dist/model/OrganizationPlan.d.ts

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

package/dist/model/RequireKeys.d.ts

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

package/dist/model/RtcConnectionStatus.d.ts

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

package/dist/model/RtcIceServerProtocol.d.ts

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

package/dist/model/RtcIceTransportPolicy.d.ts

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

package/dist/model/RtcSessionType.d.ts

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

package/dist/model/RtcStreamType.d.ts

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

package/dist/model/SmsOptInStatus.d.ts

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

package/dist/model/StreamType.d.ts

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

package/dist/model/Timeout.d.ts

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

package/dist/model/Timestamp.d.ts

@@ -1 +0,0 @@
-export type Timestamp = number;

package/dist/model/Uuid.d.ts

@@ -1 +0,0 @@
-export type Uuid = string;

package/dist/model/VideoMimeType.d.ts

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

package/dist/model/bytes.d.ts

@@ -1,9 +0,0 @@
-export declare const bytes: {
-    readonly byte: number;
-    readonly kilobyte: number;
-    readonly kibibyte: number;
-    readonly megabyte: number;
-    readonly mebibyte: number;
-    readonly gigabyte: number;
-    readonly gibibyte: number;
-};

package/dist/model/cognitoRegions.d.ts

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

package/dist/model/duration.d.ts

@@ -1,10 +0,0 @@
-export declare const duration: {
-    readonly millisecond: 1;
-    readonly second: 1000;
-    readonly minute: number;
-    readonly hour: number;
-    readonly day: number;
-    readonly week: number;
-    readonly month: number;
-    readonly year: number;
-};

package/dist/model/features.d.ts

@@ -1,2 +0,0 @@
-export declare const agentFeatures: readonly ["telemetry", "internalTelemetry", "teleop", "ssh", "customEvents", "triggeredEvents", "portForwarding", "commands", "interventions", "onDemand", "appConfig", "blobStorage"];
-export declare const features: readonly ["telemetry", "internalTelemetry", "teleop", "ssh", "customEvents", "triggeredEvents", "portForwarding", "commands", "interventions", "onDemand", "appConfig", "blobStorage", "events", "analytics", "annotations", "observability", "diagnostics", "advancedConfiguration", "dataExport", "share", "adapters", "s3Export", "fileStorage", "roleViewer", "teams", "schedules", "teleop2.0", "billing", "taskSummaries"];

package/dist/model/healthStatuses.d.ts

@@ -1,5 +0,0 @@
-export declare const healthStatuses: readonly ["unknown", "operational", "offline", "error"];
-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

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

package/dist/model/logLevels.d.ts

@@ -1 +0,0 @@
-export declare const logLevels: readonly ["error", "warn", "info", "debug"];

package/dist/model/marker3DActions.d.ts

@@ -1 +0,0 @@
-export declare const marker3DActions: readonly ["add", "modify", "delete", "delete_all"];

package/dist/model/marker3DTypes.d.ts

@@ -1 +0,0 @@
-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"];

package/dist/model/organizationPlans.d.ts

@@ -1 +0,0 @@
-export declare const organizationPlans: readonly ["self-serve", "paid"];

package/dist/model/rtcConnectionStatuses.d.ts

@@ -1 +0,0 @@
-export declare const rtcConnectionStatuses: readonly ["disconnected", "connected", "connecting"];

package/dist/model/rtcIceServerProtocols.d.ts

@@ -1 +0,0 @@
-export declare const rtcIceServerProtocols: readonly ["udp", "tcp"];

package/dist/model/rtcIceTransportPolicies.d.ts

@@ -1 +0,0 @@
-export declare const rtcIceTransportPolicies: readonly ["stun", "turn"];

package/dist/model/rtcSessionTypes.d.ts

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

package/dist/model/rtcStreamTypes.d.ts

@@ -1,26 +0,0 @@
-export declare const rtcPingStreamType: "ping";
-export declare const rtcPongStreamType: "pong";
-export declare const rtcPingV2StreamType: "ping-v2";
-export declare const rtcPongV2StreamType: "pong-v2";
-export declare const rtcStreamControlStreamType: "stream-control";
-export declare const rtcStreamsInfoStreamType: "streams-info";
-export declare const rtcAgentInfoStreamType: "agent-info";
-export declare const rtcNumericStreamType: "numeric";
-export declare const rtcBooleanStreamType: "boolean";
-export declare const rtcBitsetStreamType: "bitset";
-export declare const rtcTwistStreamType: "twist";
-export declare const rtcCompressedImageStreamType: "compressed-image";
-export declare const rtcH264VideoFrameStreamType: "h264-video-frame";
-export declare const rtcAudioChunkStreamType: "audio-chunk";
-export declare const rtcPoseStreamType: "pose";
-export declare const rtcGoalIDStreamType: "goal-id";
-export declare const rtcJointStateStreamType: "joint-state";
-export declare const rtcPoseWithCovarianceStreamType: "pose-with-covariance";
-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 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

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

package/dist/model/videoMimeTypes.d.ts

@@ -1 +0,0 @@
-export declare const videoMimeTypes: readonly ["video/mp4"];

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

@@ -1,114 +0,0 @@
-syntax = "proto3";
-
-package v1.signaling.api;
-
-import "google/protobuf/wrappers.proto";
-option go_package = "github.com/FormantIO/genproto/go/v1/api/signaling";
-
-service Signaling {
-    rpc GetHealth(GetHealthRequest)
-        returns (GetHealthResponse) {}
-    rpc CreatePeer(CreatePeerRequest)
-        returns (CreatePeerResponse) {}
-    rpc DeletePeer(DeletePeerRequest)
-        returns (DeletePeerResponse) {}
-    rpc RefreshPeer(RefreshPeerRequest)
-        returns (RefreshPeerResponse) {}
-    rpc GetPeers(GetPeersRequest)
-        returns (GetPeersResponse) {}
-    rpc GetIceServers(GetIceServersRequest)
-        returns (GetIceServersResponse) {}
-    rpc SendSignal(SendSignalRequest)
-        returns (SendSignalResponse) {}
-    rpc ReceiveSignalStream(ReceiveSignalStreamRequest)
-        returns (stream ReceiveSignalStreamResponse) {}
-    rpc GetSessions(GetSessionsRequest)
-        returns (GetSessionsResponse) {}
-}
-
-message Peer {
-    string peer_id = 1;
-    string organization_id = 2;
-    google.protobuf.StringValue user_id = 3;
-    google.protobuf.StringValue device_id = 4;
-    repeated string session_ids = 5;
-    google.protobuf.Int64Value peer_created_timestamp = 6; // No value means it's for a new peer
-}
-
-enum SessionType {
-    UNKNOWN = 0;
-    TELEOP = 1;
-    PORT_FORWARD = 2;
-    OBSERVE = 3;
-    HEADLESS = 4;
-}
-
-message Signal {
-    google.protobuf.StringValue session_id = 1; // No value means it's for a new session
-    google.protobuf.Int64Value session_created_timestamp = 2; // No value means it's for a new session
-    string sender_id = 3;
-    string receiver_id = 4;
-    string payload = 5;
-    string ice_servers = 6; // JSON-encoded RTCIceServer list
-    string ice_transport_policy = 7;
-    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;
-}
-
-message CreatePeerRequest {}
-message CreatePeerResponse {
-    Peer peer = 1;
-}
-
-message DeletePeerRequest {
-    string peer_id = 1;
-}
-message DeletePeerResponse {}
-
-message RefreshPeerRequest {
-    Peer peer = 1;
-}
-message RefreshPeerResponse {}
-
-message GetPeersRequest {}
-message GetPeersResponse {
-    repeated Peer peers = 1;
-}
-
-message GetIceServersRequest {}
-message GetIceServersResponse {
-    string ice_servers = 1; // JSON-encoded RTCIceServer list
-}
-
-message SendSignalRequest {
-    Signal signal = 1;
-}
-message SendSignalResponse {
-    google.protobuf.StringValue session_id = 1;
-    google.protobuf.Int64Value session_created_timestamp = 2;
-}
-
-message ReceiveSignalStreamRequest {
-    string peer_id = 1;
-}
-message ReceiveSignalStreamResponse {
-    Signal signal = 1;
-}

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

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