@formant/realtime-sdk 1.3.0 → 1.4.0

package/dist/index.js.LICENSE.txt

@@ -0,0 +1,19 @@
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
+ * @license  MIT
+ */
+
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*! https://mths.be/punycode v1.4.1 by @mathias */
+
+/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
+/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */

package/dist/model/AnnotationAreaType.d.ts

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

package/dist/model/AuditLogActionType.d.ts

@@ -0,0 +1,5 @@
+import { auditLogActionTypes } from "./auditLogActionTypes";
+export type AuditLogActionType = (typeof auditLogActionTypes)[number];
+export declare const httpMethodToAuditLogTypeMap: {
+    [httpMethod: string]: AuditLogActionType;
+};

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

@@ -0,0 +1,3 @@
+import { agentFeatures, features } from "./features";
+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/IAdminSignupRequest.d.ts

@@ -0,0 +1,14 @@
+import { IsoDate } from "./IsoDate";
+import { OrganizationPlan } from "./OrganizationPlan";
+export interface IAdminSignupRequest {
+    email: string;
+    password?: string;
+    firstName: string;
+    lastName: string;
+    organizationName?: string;
+    organizationPlan?: OrganizationPlan;
+    stripeBillingEnabled?: boolean;
+    stripeSubscriptionEnabled?: boolean;
+    isSingleSignOn?: boolean;
+    trialPeriodEnd?: IsoDate | null;
+}

package/dist/model/IAnnotationAreaTypeMap.d.ts

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

package/dist/model/IAudioChunk.d.ts

@@ -0,0 +1,5 @@
+export interface IAudioChunk {
+    index: number;
+    format: string;
+    chunk_data: string;
+}

package/dist/model/IAuditLog.d.ts

@@ -0,0 +1,14 @@
+import { AuditLogActionType } from "./AuditLogActionType";
+import { Uuid } from "./Uuid";
+export interface IAuditLog {
+    organizationId: Uuid;
+    userId?: Uuid;
+    deviceId?: Uuid;
+    impersonatorUserId?: Uuid;
+    action: AuditLogActionType;
+    statusOk: boolean;
+    entityName: string;
+    entityId: Uuid;
+    entity?: any;
+    lastFiveDigitsPhoneNumber?: string;
+}

package/dist/model/IAuthentication.d.ts

@@ -0,0 +1,8 @@
+import { Uuid } from "./Uuid";
+export interface IAuthentication {
+    accessToken: string;
+    refreshToken?: string;
+    organizationId: Uuid;
+    userId: Uuid;
+    isSuperuser?: boolean;
+}

package/dist/model/IBaseEntity.d.ts

@@ -0,0 +1,7 @@
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface IBaseEntity {
+    id?: Uuid;
+    createdAt?: IsoDate;
+    updatedAt?: IsoDate;
+}

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

@@ -0,0 +1,7 @@
+import { Uuid } from "./Uuid";
+export interface IChallenge {
+    type: "new-password-required";
+    userId: Uuid;
+    email: string;
+    session: string;
+}

package/dist/model/ICheckSsoResult.d.ts

@@ -0,0 +1,5 @@
+export interface ICheckSsoResult {
+    issuer: string;
+    clientId: string;
+    isSso?: boolean;
+}

package/dist/model/IColorRGBA.d.ts

@@ -0,0 +1,6 @@
+export interface IColorRGBA {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}

package/dist/model/ICompressedImage.d.ts

@@ -0,0 +1,3 @@
+export interface ICompressedImage {
+    data: string;
+}

package/dist/model/ICreateServiceAccountResponse.d.ts

@@ -0,0 +1,5 @@
+import { IUser } from "./IUser";
+export interface ICreateServiceAccountResponse {
+    user: IUser;
+    password: string;
+}

package/dist/model/IDeviceCredentials.d.ts

@@ -0,0 +1,9 @@
+import { IsoDate } from "./IsoDate";
+export interface IDeviceCredentials {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken: string;
+    expiration: IsoDate;
+    s3Region: string;
+    s3UploadBucket: string;
+}

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,11 @@
+import { ITagFilter } from "./ITagFilter";
+import { ITagSets } from "./ITagSets";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface IFilter extends ITagFilter {
+    deviceIds?: Uuid[];
+    names?: string[];
+    types?: StreamType[];
+    notTags?: ITagSets | ITagSets[];
+    notNames?: string[];
+}

package/dist/model/IGetFeaturesResponse.d.ts

@@ -0,0 +1,4 @@
+import { Feature } from "./Feature";
+export interface IGetFeaturesResponse {
+    features: Feature[];
+}

package/dist/model/IGoal.d.ts

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

package/dist/model/IGoalID.d.ts

@@ -0,0 +1,3 @@
+export interface IGoalID {
+    id?: string;
+}

package/dist/model/IGoogleLoginRequest.d.ts

@@ -0,0 +1,4 @@
+export interface IGoogleLoginRequest {
+    token: string;
+    autoCreateOrg?: boolean;
+}

package/dist/model/IH264VideoFrame.d.ts

@@ -0,0 +1,5 @@
+export interface IH264VideoFrame {
+    index: number;
+    flags: number;
+    frame_data: string;
+}

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

@@ -0,0 +1,8 @@
+import { ITransform } from "./ITransform";
+export interface IJointState {
+    world_to_local?: ITransform;
+    name: string[];
+    position: number[];
+    velocity?: number[];
+    effort?: number[];
+}

package/dist/model/IJoy.d.ts

@@ -0,0 +1,4 @@
+export interface IJoy {
+    axes: number[];
+    buttons: number[];
+}

package/dist/model/IJsonString.d.ts

@@ -0,0 +1,3 @@
+export interface IJsonString {
+    value: string;
+}

package/dist/model/IListResponse.d.ts

@@ -0,0 +1,3 @@
+export interface IListResponse<T> {
+    items: T[];
+}

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

@@ -0,0 +1,9 @@
+import { IsoDate } from "./IsoDate";
+import { LogLevel } from "./LogLevel";
+export interface ILogLine {
+    timestamp: IsoDate;
+    level: LogLevel;
+    message: string;
+    error?: any;
+    meta?: any;
+}

package/dist/model/ILoginRequest.d.ts

@@ -0,0 +1,7 @@
+import { ITagFilter } from "./ITagFilter";
+export interface ILoginRequest {
+    email: string;
+    password: string;
+    tokenExpirationSeconds?: number;
+    filter?: ITagFilter;
+}

package/dist/model/ILoginResult.d.ts

@@ -0,0 +1,7 @@
+import { IAuthentication } from "./IAuthentication";
+import { IChallenge } from "./IChallenge";
+export interface ILoginResult {
+    authentication?: IAuthentication;
+    challenge?: IChallenge;
+    isExistingUser?: boolean;
+}

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

@@ -0,0 +1,23 @@
+import { IColorRGBA } from "./IColorRGBA";
+import { ITransform } from "./ITransform";
+import { IVector3 } from "./IVector3";
+import { Marker3DAction } from "./Marker3DAction";
+import { Marker3DType } from "./Marker3DType";
+export interface IMarker3D {
+    world_to_local?: ITransform;
+    ns: string;
+    id: number;
+    type: Marker3DType;
+    action: Marker3DAction;
+    pose: ITransform;
+    scale: IVector3;
+    color: IColorRGBA;
+    lifetime: number;
+    frame_id: string;
+    frame_locked: boolean;
+    points: IVector3[];
+    colors: IColorRGBA[];
+    text: string;
+    mesh_resource: string;
+    mesh_use_embedded_materials: boolean;
+}

package/dist/model/IMarker3DArray.d.ts

@@ -0,0 +1,4 @@
+import { IMarker3D } from "./IMarker3D";
+export interface IMarker3DArray {
+    markers: IMarker3D[];
+}

package/dist/model/IMetric.d.ts

@@ -0,0 +1,7 @@
+import { IStat } from "./IStat";
+import { ITags } from "./ITags";
+export interface IMetric {
+    name: string;
+    tags?: ITags;
+    stat: IStat;
+}

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

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

@@ -0,0 +1,5 @@
+import { ITransform } from "./ITransform";
+export interface IPoseWithCovariance {
+    pose: ITransform;
+    covariance: Array<number>;
+}

package/dist/model/IPostLanRtcOfferRequest.d.ts

@@ -0,0 +1,3 @@
+export interface IPostLanRtcOfferRequest {
+    offer: string;
+}

package/dist/model/IPostLanRtcOfferResponse.d.ts

@@ -0,0 +1,3 @@
+export interface IPostLanRtcOfferResponse {
+    answer: string;
+}

package/dist/model/IQuaternion.d.ts

@@ -0,0 +1,6 @@
+export interface IQuaternion {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}

package/dist/model/IRtcAddSignalsRequest.d.ts

@@ -0,0 +1,4 @@
+import { IRtcSignal } from "./IRtcSignal";
+export interface IRtcAddSignalsRequest {
+    signals: IRtcSignal[];
+}

package/dist/model/IRtcCapabilitySet.d.ts

@@ -0,0 +1,6 @@
+import { IRtcPortForwardingConfiguration } from "./IRtcPortForwardingConfiguration";
+import { IRtcStreamingConfiguration } from "./IRtcStreamingConfiguration";
+export interface IRtcCapabilitySet {
+    streaming?: IRtcStreamingConfiguration | null;
+    portForwarding?: IRtcPortForwardingConfiguration | null;
+}

package/dist/model/IRtcCreatePeerRequest.d.ts

@@ -0,0 +1,6 @@
+import { IRtcCapabilitySet } from "./IRtcCapabilitySet";
+import { IRtcStreamCapability } from "./IRtcStreamCapability";
+export interface IRtcCreatePeerRequest {
+    capabilitySet?: IRtcCapabilitySet;
+    capabilities?: IRtcStreamCapability[];
+}

package/dist/model/IRtcCreateSessionRequest.d.ts

@@ -0,0 +1,5 @@
+import { Uuid } from "./Uuid";
+export interface IRtcCreateSessionRequest {
+    offerPeerId: Uuid;
+    answerPeerId: Uuid;
+}

package/dist/model/IRtcIceServer.d.ts

@@ -0,0 +1,5 @@
+export interface IRtcIceServer {
+    urls: string[];
+    username?: string;
+    credential?: string;
+}

package/dist/model/IRtcInfo.d.ts

@@ -0,0 +1,7 @@
+import { RtcIceServerProtocol } from "./RtcIceServerProtocol";
+import { RtcIceTransportPolicy } from "./RtcIceTransportPolicy";
+export interface IRtcInfo {
+    rtcIceTransportPolicies?: RtcIceTransportPolicy[];
+    rtcIceServerProtocol?: RtcIceServerProtocol;
+    useAllServers?: boolean;
+}

package/dist/model/IRtcPeer.d.ts

@@ -0,0 +1,11 @@
+import { IRtcCapabilitySet } from "./IRtcCapabilitySet";
+import { IRtcStreamCapability } from "./IRtcStreamCapability";
+import { Uuid } from "./Uuid";
+export interface IRtcPeer {
+    id: Uuid;
+    organizationId: Uuid;
+    deviceId?: Uuid;
+    userId?: Uuid;
+    capabilities: IRtcStreamCapability[];
+    capabilitySet: IRtcCapabilitySet;
+}

package/dist/model/IRtcPeerDescription.d.ts

@@ -0,0 +1,6 @@
+import { IRtcPeer } from "./IRtcPeer";
+import { IRtcSignal } from "./IRtcSignal";
+export interface IRtcPeerDescription {
+    peer: IRtcPeer;
+    signals: IRtcSignal[];
+}

package/dist/model/IRtcPortForwardingConfiguration.d.ts

@@ -0,0 +1,3 @@
+export interface IRtcPortForwardingConfiguration {
+    ports?: number[] | null;
+}

package/dist/model/IRtcSession.d.ts

@@ -0,0 +1,12 @@
+import { IRtcPeerDescription } from "./IRtcPeerDescription";
+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/IRtcSignal.d.ts

@@ -0,0 +1,3 @@
+export interface IRtcSignal {
+    payload: string;
+}

package/dist/model/IRtcStream.d.ts

@@ -0,0 +1,9 @@
+import { RtcStreamType } from "./RtcStreamType";
+import { Uuid } from "./Uuid";
+export interface IRtcStream {
+    entityId: Uuid;
+    streamName: string;
+    streamType: RtcStreamType;
+    label?: string;
+    buttonLabel?: string;
+}

package/dist/model/IRtcStreamCapability.d.ts

@@ -0,0 +1,6 @@
+import { IRtcStream } from "./IRtcStream";
+export interface IRtcStreamCapability {
+    stream: IRtcStream;
+    send: boolean;
+    receive: boolean;
+}

package/dist/model/IRtcStreamingConfiguration.d.ts

@@ -0,0 +1,4 @@
+import { IRtcStreamCapability } from "./IRtcStreamCapability";
+export interface IRtcStreamingConfiguration {
+    streams: IRtcStreamCapability[];
+}

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

@@ -0,0 +1,21 @@
+/**
+ * An aggregation of metric samples collected during a sample period.
+ */
+export interface IStat {
+    /**
+     * The minimum sampled value.
+     */
+    min: number;
+    /**
+     * The maximum sampled value.
+     */
+    max: number;
+    /**
+     * The sum of sampled values.
+     */
+    sum: number;
+    /**
+     * The count of sampled values.
+     */
+    count: number;
+}

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

@@ -0,0 +1,4 @@
+import { ITagSets } from "./ITagSets";
+export interface ITagFilter {
+    tags?: ITagSets | ITagSets[];
+}

package/dist/model/ITagSets.d.ts

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