@formant/realtime-sdk 1.3.0 → 1.4.0

package/dist/model/ITaggedEntity.d.ts

@@ -0,0 +1,5 @@
+import { IBaseEntity } from "./IBaseEntity";
+import { ITags } from "./ITags";
+export interface ITaggedEntity extends IBaseEntity {
+    tags: ITags;
+}

package/dist/model/ITags.d.ts

@@ -0,0 +1,2 @@
+import { IDictionary } from "./IDictionary";
+export type ITags = IDictionary;

package/dist/model/ITransform.d.ts

@@ -0,0 +1,6 @@
+import { IQuaternion } from "./IQuaternion";
+import { IVector3 } from "./IVector3";
+export interface ITransform {
+    translation: IVector3;
+    rotation: IQuaternion;
+}

package/dist/model/ITransformNode.d.ts

@@ -0,0 +1,8 @@
+import { ITransform } from "./ITransform";
+export interface ITransformNode {
+    name?: string;
+    transform?: ITransform;
+    children?: ITransformNode[];
+    url?: string;
+    size?: number;
+}

package/dist/model/ITwist.d.ts

@@ -0,0 +1,5 @@
+import { IVector3 } from "./IVector3";
+export interface ITwist {
+    linear: IVector3;
+    angular: IVector3;
+}

package/dist/model/IUser.d.ts

@@ -0,0 +1,36 @@
+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;
+    title?: string | null;
+    description?: string | null;
+}

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/IValidation.d.ts

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

package/dist/model/IVector3.d.ts

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

package/dist/model/IVideo.d.ts

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

package/dist/model/IsoDate.d.ts

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

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

package/dist/model/Marker3DAction.d.ts

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

package/dist/model/Marker3DType.d.ts

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

package/dist/model/OrganizationPlan.d.ts

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

package/dist/model/RequireKeys.d.ts

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

package/dist/model/RtcConnectionStatus.d.ts

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

package/dist/model/RtcIceServerProtocol.d.ts

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

package/dist/model/RtcIceTransportPolicy.d.ts

@@ -0,0 +1,2 @@
+import { rtcIceTransportPolicies } from "./rtcIceTransportPolicies";
+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

@@ -0,0 +1,3 @@
+import { rtcImageStreamTypes, rtcStreamTypes } from "./rtcStreamTypes";
+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

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

package/dist/model/Timeout.d.ts

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

package/dist/model/Timestamp.d.ts

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

package/dist/model/Uuid.d.ts

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

package/dist/model/VideoMimeType.d.ts

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

package/dist/model/auditLogActionTypes.d.ts

@@ -0,0 +1 @@
+export declare const auditLogActionTypes: readonly ["create", "update", "delete", "provision", "unprovision", "sso-login", "forgot-password"];

package/dist/model/bytes.d.ts

@@ -0,0 +1,9 @@
+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

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

package/dist/model/duration.d.ts

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,5 @@
+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

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

package/dist/model/logLevels.d.ts

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

package/dist/model/marker3DActions.d.ts

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

package/dist/model/marker3DTypes.d.ts

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

package/dist/model/organizationPlans.d.ts

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

package/dist/model/rtcConnectionStatuses.d.ts

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

package/dist/model/rtcIceServerProtocols.d.ts

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

package/dist/model/rtcIceTransportPolicies.d.ts

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

package/dist/model/rtcSessionTypes.d.ts

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

package/dist/model/rtcStreamTypes.d.ts

@@ -0,0 +1,28 @@
+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 rtcVideoMetadataStreamType: "video-metadata";
+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 rtcJoyStreamType: "joy";
+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", "joy"];
+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/model/videoMimeTypes.d.ts

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

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

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