@formant/realtime-sdk 0.0.19 → 1.0.0

package/dist/model/AnnotationAreaType.d.ts

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

package/dist/model/CognitoRegion.d.ts

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

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

package/dist/model/HexRgbColor.d.ts

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

package/dist/model/IAnnotationAreaTypeMap.d.ts

@@ -0,0 +1,4 @@
+import { IBoundingBox } from "./IBoundingBox";
+export interface IAnnotationAreaTypeMap {
+    "bounding box": IBoundingBox;
+}

package/dist/model/IBattery.d.ts

@@ -0,0 +1,6 @@
+export interface IBattery {
+    percentage: number;
+    voltage?: number;
+    current?: number;
+    charge?: number;
+}

package/dist/model/IBitset.d.ts

@@ -0,0 +1,4 @@
+export interface IBitset {
+    keys: string[];
+    values: boolean[];
+}

package/dist/model/IBoundingBox.d.ts

@@ -0,0 +1,6 @@
+export interface IBoundingBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}

package/dist/model/IDictionary.d.ts

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

package/dist/model/IFile.d.ts

@@ -0,0 +1,6 @@
+export interface IFile {
+    url: string;
+    filename: string;
+    size: number;
+    previewUrl?: string;
+}

package/dist/model/IFilter.d.ts

@@ -0,0 +1,10 @@
+import { ITagSets } from "./ITagSets";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface IFilter {
+    deviceIds?: Uuid[];
+    names?: string[];
+    types?: StreamType[];
+    tags?: ITagSets | ITagSets[];
+    notNames?: string[];
+}

package/dist/model/IGoal.d.ts

@@ -0,0 +1,5 @@
+import { ITransform } from "./ITransform";
+export interface IGoal {
+    worldToLocal: ITransform;
+    pose: ITransform;
+}

package/dist/model/IHealth.d.ts

@@ -0,0 +1,5 @@
+import { HealthStatus } from "./HealthStatus";
+export interface IHealth {
+    status: HealthStatus;
+    clockSkewMs?: number;
+}

package/dist/model/IImage.d.ts

@@ -0,0 +1,6 @@
+import { IImageAnnotation } from "./IImageAnnotation";
+export interface IImage {
+    url: string;
+    size?: number;
+    annotations?: IImageAnnotation[];
+}

package/dist/model/IImageAnnotation.d.ts

@@ -0,0 +1,9 @@
+import { AnnotationAreaType } from "./AnnotationAreaType";
+import { HexRgbColor } from "./HexRgbColor";
+import { IAnnotationAreaTypeMap } from "./IAnnotationAreaTypeMap";
+export interface IImageAnnotation<T extends AnnotationAreaType = AnnotationAreaType> {
+    label: string;
+    type: AnnotationAreaType;
+    area: IAnnotationAreaTypeMap[T];
+    color: HexRgbColor;
+}

package/dist/model/ILocalization.d.ts

@@ -0,0 +1,14 @@
+import { IGoal } from "./IGoal";
+import { IMap } from "./IMap";
+import { IOdometry } from "./IOdometry";
+import { IPath } from "./IPath";
+import { IPointCloud } from "./IPointCloud";
+export interface ILocalization {
+    odometry?: IOdometry;
+    map?: IMap;
+    pointClouds?: IPointCloud[];
+    path?: IPath;
+    goal?: IGoal;
+    url?: string;
+    size?: number;
+}

package/dist/model/ILocation.d.ts

@@ -0,0 +1,6 @@
+export interface ILocation {
+    latitude: number;
+    longitude: number;
+    altitude?: number;
+    orientation?: number;
+}

package/dist/model/IMap.d.ts

@@ -0,0 +1,10 @@
+import { ITransform } from "./ITransform";
+export interface IMap {
+    url: string;
+    size?: number;
+    width: number;
+    height: number;
+    resolution: number;
+    origin: ITransform;
+    worldToLocal: ITransform;
+}

package/dist/model/INumericSetEntry.d.ts

@@ -0,0 +1,5 @@
+export interface INumericSetEntry {
+    label: string;
+    value: number;
+    unit?: string;
+}

package/dist/model/IOdometry.d.ts

@@ -0,0 +1,7 @@
+import { ITransform } from "./ITransform";
+import { ITwist } from "./ITwist";
+export interface IOdometry {
+    pose: ITransform;
+    twist: ITwist;
+    worldToLocal: ITransform;
+}

package/dist/model/IPath.d.ts

@@ -0,0 +1,5 @@
+import { ITransform } from "./ITransform";
+export interface IPath {
+    worldToLocal: ITransform;
+    poses: ITransform[];
+}

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

@@ -0,0 +1,6 @@
+import { ITransform } from "./ITransform";
+export interface IPointCloud {
+    url: string;
+    size?: number;
+    worldToLocal?: ITransform;
+}

package/dist/model/IRtcSession.d.ts

@@ -1,6 +1,6 @@
 import { IRtcPeerDescription } from "./IRtcPeerDescription";
-import { Uuid } from "./Uuid";
 import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
 export interface IRtcSession {
     id: Uuid;
     organizationId: Uuid;

package/dist/model/IRtcStream.d.ts

@@ -5,4 +5,5 @@ export interface IRtcStream {
     streamName: string;
     streamType: RtcStreamType;
     label?: string;
+    buttonLabel?: string;
 }

package/dist/model/IScopeFilter.d.ts

@@ -0,0 +1,6 @@
+import { IFilter } from "./IFilter";
+import { IsoDate } from "./IsoDate";
+export interface IScopeFilter extends IFilter {
+    start?: IsoDate;
+    end?: IsoDate;
+}

package/dist/model/IStreamTypeMap.d.ts

@@ -0,0 +1,27 @@
+import { IBattery } from "./IBattery";
+import { IBitset } from "./IBitset";
+import { IFile } from "./IFile";
+import { IHealth } from "./IHealth";
+import { IImage } from "./IImage";
+import { ILocalization } from "./ILocalization";
+import { ILocation } from "./ILocation";
+import { INumericSetEntry } from "./INumericSetEntry";
+import { IPointCloud } from "./IPointCloud";
+import { ITransformNode } from "./ITransformNode";
+import { IVideo } from "./IVideo";
+export interface IStreamTypeMap {
+    bitset: IBitset;
+    localization: ILocalization;
+    "point cloud": IPointCloud;
+    location: ILocation;
+    file: IFile;
+    health: IHealth;
+    "transform tree": ITransformNode;
+    battery: IBattery;
+    video: IVideo;
+    "numeric set": INumericSetEntry[];
+    json: string;
+    image: IImage;
+    numeric: number;
+    text: string;
+}

package/dist/model/ITagSets.d.ts

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

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

@@ -1,13 +1,20 @@
+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;
-    email: string;
-    firstName: string;
-    lastName: string;
-    roleId: Uuid;
+    accountId?: Uuid | null;
+    roleId: Uuid | null;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    scope?: IUserScope | null;
     teamId?: Uuid | null;
+    eventTriggerGroupId?: Uuid | null;
     phoneNumber?: string;
     enabled?: boolean;
     isOrganizationOwner?: boolean;
@@ -16,4 +23,11 @@ export interface IUser extends ITaggedEntity {
     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

@@ -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/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

@@ -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/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

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

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

package/dist/model/cognitoRegions.d.ts

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

package/dist/model/features.d.ts

@@ -1,2 +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", "onDemand", "share", "adapters", "s3Export", "fileStorage", "roleViewer", "teams", "schedules"];
+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/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/model/videoMimeTypes.d.ts

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