@formant/data-sdk 1.80.4 → 1.80.5

package/dist/types/data-sdk/src/model/IPath.d.ts

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

package/dist/types/data-sdk/src/model/IPhysicalInterventionMetadata.d.ts

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

package/dist/types/data-sdk/src/model/IPhysicalRequestData.d.ts

@@ -0,0 +1,8 @@
+import { IPhysicalInterventionMetadata } from "./IPhysicalInterventionMetadata";
+import { IsoDate } from "./IsoDate";
+export interface IPhysicalRequestData {
+    reason: string;
+    metadata?: IPhysicalInterventionMetadata;
+    startTime: IsoDate;
+    endTime: IsoDate;
+}

package/dist/types/data-sdk/src/model/IPhysicalResponsetData.d.ts

@@ -0,0 +1,3 @@
+export interface IPhysicalResponseData {
+    value: boolean;
+}

package/dist/types/data-sdk/src/model/IPointCloud.d.ts

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

package/dist/types/data-sdk/src/model/IPortForwardingSessionRecord.d.ts

@@ -0,0 +1,3 @@
+import { IRtcSessionRecord } from "./IRtcSessionRecord";
+export interface IPortForwardingSessionRecord extends IRtcSessionRecord<"port-forwarding-session-record"> {
+}

package/dist/types/data-sdk/src/model/IPoseWithCovariance.d.ts

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

package/dist/types/data-sdk/src/model/IQuaternion.d.ts

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

package/dist/types/data-sdk/src/model/IQuery.d.ts

@@ -0,0 +1,9 @@
+import { AggregateLevel } from "./AggregateLevel";
+import { IFilter } from "./IFilter";
+import { IsoDate } from "./IsoDate";
+export interface IQuery extends IFilter {
+    aggregate?: AggregateLevel;
+    start: IsoDate;
+    end: IsoDate;
+    latestOnly?: boolean;
+}

package/dist/types/data-sdk/src/model/IRole.d.ts

@@ -0,0 +1,9 @@
+import { ITaggedEntity } from "./ITaggedEntity";
+import { Policies } from "./Policies";
+import { Uuid } from "./Uuid";
+export interface IRole extends ITaggedEntity {
+    organizationId?: Uuid;
+    name: string;
+    policies: Policies;
+    isImmutable?: boolean;
+}

package/dist/types/data-sdk/src/model/IRosTopic.d.ts

@@ -0,0 +1,4 @@
+export interface IRosTopic {
+    name: string;
+    type: string;
+}

package/dist/types/data-sdk/src/model/IRtcPointCloud.d.ts

@@ -0,0 +1,5 @@
+import { ITransform } from "./ITransform";
+export interface IRtcPointCloud {
+    world_to_local?: ITransform;
+    data: string;
+}

package/dist/types/data-sdk/src/model/IRtcSessionRecord.d.ts

@@ -0,0 +1,9 @@
+import { Uuid } from "./Uuid";
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+export interface IRtcSessionRecord<T extends "teleop-session-record" | "port-forwarding-session-record"> extends IBaseEvent<T> {
+    sessionId: Uuid;
+    userId: Uuid;
+    deviceId: Uuid;
+    endTime: IsoDate;
+}

package/dist/types/data-sdk/src/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/types/data-sdk/src/model/ISelectionRequestData.d.ts

@@ -0,0 +1,6 @@
+export interface ISelectionRequestData {
+    instruction: string;
+    imageUrl: string;
+    options: string[];
+    hint?: number;
+}

package/dist/types/data-sdk/src/model/ISelectionResponseData.d.ts

@@ -0,0 +1,3 @@
+export interface ISelectionResponseData {
+    value: number;
+}

package/dist/types/data-sdk/src/model/IShare.d.ts

@@ -0,0 +1,16 @@
+import { IBaseEntity } from "./IBaseEntity";
+import { Uuid } from "./Uuid";
+import { IScopeFilter } from "./IScopeFilter";
+import { IsoDate } from "./IsoDate";
+export interface IShare extends IBaseEntity {
+    organizationId?: Uuid;
+    userId?: Uuid;
+    code?: string;
+    scope: IScopeFilter;
+    time: IsoDate;
+    expiration?: IsoDate | null;
+    channelId?: Uuid;
+    message?: string;
+    userName?: string;
+    delegateTeleop?: boolean;
+}

package/dist/types/data-sdk/src/model/ISheetParameters.d.ts

@@ -0,0 +1,5 @@
+export interface ISheetParameters {
+    url?: string;
+    spreadsheetId: string;
+    range: string;
+}

package/dist/types/data-sdk/src/model/ISpreadsheetIdRange.d.ts

@@ -0,0 +1,4 @@
+export interface ISpreadsheetIdRange {
+    spreadsheetId: string;
+    range: string;
+}

package/dist/types/data-sdk/src/model/ISqlColumn.d.ts

@@ -0,0 +1,6 @@
+export interface ISqlColumn {
+    name: string;
+    tableName: string;
+    isNullable?: boolean;
+    dataType: "string" | "timestamp" | "boolean" | "number" | "null";
+}

package/dist/types/data-sdk/src/model/ISqlQuery.d.ts

@@ -0,0 +1,21 @@
+import { IsoDate } from "./IsoDate";
+import { IFilter } from "./IFilter";
+import { AggregateLevel } from "./AggregateLevel";
+import { IStreamColumn } from "./IStreamColumn";
+import { ITaskReportColumn } from "./ITaskReportColumn";
+export interface ISqlQuery extends IFilter {
+    sqlQuery?: string;
+    parameters?: string[];
+    start?: IsoDate;
+    end?: IsoDate;
+    streamColumns?: IStreamColumn[];
+    taskColumns?: ITaskReportColumn[];
+    aggregateLevel?: AggregateLevel;
+    limit?: number;
+    orderByColumn?: string;
+    orderByDescending?: boolean;
+    visibleColumns?: string[];
+    filters?: string[];
+    type?: "stream" | "task" | "advanced";
+    unit?: string;
+}

package/dist/types/data-sdk/src/model/ISqlResult.d.ts

@@ -0,0 +1,12 @@
+import { IAggregateRow } from "./IAggregateRow";
+import { ISqlColumn } from "./ISqlColumn";
+import { ISqlRow } from "./ISqlRow";
+export interface ISqlResult {
+    rows: ISqlRow[];
+    columns: ISqlColumn[];
+    aggregates?: IAggregateRow[];
+    sqlText: string;
+    aggregateSqlText?: string;
+    rowCount: number;
+    unit?: string;
+}

package/dist/types/data-sdk/src/model/ISqlRow.d.ts

@@ -0,0 +1,5 @@
+import { IsoDate } from "./IsoDate";
+export interface ISqlRow {
+    [key: string]: string | IsoDate | number | boolean | null;
+    tableName: string;
+}

package/dist/types/data-sdk/src/model/IStatefulEvent.d.ts

@@ -0,0 +1,5 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { Severity } from "./Severity";
+export interface IStatefulEvent extends IBaseEvent<"stateful"> {
+    severity?: Severity;
+}

package/dist/types/data-sdk/src/model/IStream.d.ts

@@ -0,0 +1,18 @@
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+import { StreamType } from "./StreamType";
+export interface IStream {
+    active: boolean;
+    alias: string;
+    createdAt: IsoDate;
+    enabled: boolean;
+    id: Uuid;
+    isEventFilter: boolean;
+    isOverviewColumn: boolean;
+    isOverviewRow: boolean;
+    isTelemetryFilter: boolean;
+    organizationId: Uuid;
+    streamName: string;
+    streamType: StreamType;
+    updatedAt: IsoDate;
+}

package/dist/types/data-sdk/src/model/IStreamAggregateData.d.ts

@@ -0,0 +1,11 @@
+import { IDataAggregate } from "./IDataAggregate";
+import { ITags } from "./ITags";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface IStreamAggregateData<T extends StreamType = StreamType> {
+    deviceId: Uuid;
+    name: string;
+    type: T;
+    tags: ITags;
+    aggregates: IDataAggregate<T>[];
+}

package/dist/types/data-sdk/src/model/IStreamAggregateTypeMap.d.ts

@@ -0,0 +1,10 @@
+import { INumericAggregate } from "./INumericAggregate";
+import { INumericSetAggregateMap } from "./INumericSetAggregateMap";
+import { StreamType } from "./StreamType";
+export interface ISupportedStreamAggregateTypeMap {
+    "numeric set": INumericSetAggregateMap;
+    numeric: INumericAggregate;
+}
+export type IStreamAggregateTypeMap = Omit<{
+    [_ in StreamType]: undefined;
+}, keyof ISupportedStreamAggregateTypeMap> & ISupportedStreamAggregateTypeMap;

package/dist/types/data-sdk/src/model/IStreamColumn.d.ts

@@ -0,0 +1,7 @@
+import { StreamType } from "./StreamType";
+import { AnalyticsAggregateType } from "./AnalyticsAggregateType";
+export interface IStreamColumn {
+    streamName: string;
+    streamType: StreamType;
+    aggregateType?: AnalyticsAggregateType;
+}

package/dist/types/data-sdk/src/model/IStreamCurrentValue.d.ts

@@ -0,0 +1,13 @@
+import { IsoDate } from "./IsoDate";
+import { IStreamTypeMap } from "./IStreamTypeMap";
+import { ITags } from "./ITags";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface IStreamCurrentValue<T extends StreamType = any> {
+    deviceId: Uuid;
+    streamName: string;
+    streamType: StreamType;
+    tags: ITags;
+    currentValue: IStreamTypeMap[T];
+    currentValueTime: IsoDate;
+}

package/dist/types/data-sdk/src/model/IStreamData.d.ts

@@ -0,0 +1,11 @@
+import { IDataPoint } from "./IDataPoint";
+import { ITags } from "./ITags";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface IStreamData<T extends StreamType = StreamType> {
+    deviceId: Uuid;
+    name: string;
+    type: T;
+    tags: ITags;
+    points: IDataPoint<T>[];
+}

package/dist/types/data-sdk/src/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/types/data-sdk/src/model/ISystemEvent.d.ts

@@ -0,0 +1,3 @@
+import { IBaseEvent } from "./IBaseEvent";
+export interface ISystemEvent extends IBaseEvent<"system"> {
+}

package/dist/types/data-sdk/src/model/ITagParameters.d.ts

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

package/dist/types/data-sdk/src/model/ITagSets.d.ts

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

package/dist/types/data-sdk/src/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/types/data-sdk/src/model/ITaggedUsers.d.ts

@@ -0,0 +1,4 @@
+import { Uuid } from "./Uuid";
+export interface ITaggedUsers {
+    [key: string]: Uuid[];
+}

package/dist/types/data-sdk/src/model/ITags.d.ts

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

package/dist/types/data-sdk/src/model/ITaskReportColumn.d.ts

@@ -0,0 +1,7 @@
+import { ISqlColumn } from "./ISqlColumn";
+export interface ITaskReportColumn {
+    tableName: string;
+    columns?: ISqlColumn[];
+    name: string;
+    yAxis?: string;
+}

package/dist/types/data-sdk/src/model/ITaskSummary.d.ts

@@ -0,0 +1,14 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface ITaskSummary extends IBaseEvent<"task-summary"> {
+    taskSummaryFormatId: Uuid;
+    report: {
+        [key: string]: any;
+    };
+    taskId: string;
+    deviceId: Uuid;
+    generatedAt: IsoDate;
+    endTime: IsoDate;
+    deletedAt?: IsoDate | null;
+}

package/dist/types/data-sdk/src/model/ITeleopRequestData.d.ts

@@ -0,0 +1,3 @@
+export interface ITeleopRequestData {
+    instruction: string;
+}

package/dist/types/data-sdk/src/model/ITeleopResponseData.d.ts

@@ -0,0 +1,4 @@
+export interface ITeleopResponseData {
+    state: "inProgress" | "requestAssistance" | "success" | "failure";
+    notes?: string;
+}

package/dist/types/data-sdk/src/model/ITeleopSessionRecord.d.ts

@@ -0,0 +1,3 @@
+import { IRtcSessionRecord } from "./IRtcSessionRecord";
+export interface ITeleopSessionRecord extends IRtcSessionRecord<"teleop-session-record"> {
+}

package/dist/types/data-sdk/src/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/types/data-sdk/src/model/ITransformNode.d.ts

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

package/dist/types/data-sdk/src/model/ITriggeredEvent.d.ts

@@ -0,0 +1,11 @@
+import { EventType } from "./EventType";
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Severity } from "./Severity";
+import { Uuid } from "./Uuid";
+export interface ITriggeredEvent<T extends EventType = EventType> extends IBaseEvent<T> {
+    severity: Severity;
+    eventTriggerId: Uuid;
+    interval?: number;
+    intervalStart?: IsoDate;
+}

package/dist/types/data-sdk/src/model/ITwist.d.ts

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

package/dist/types/data-sdk/src/model/IUser.d.ts

@@ -0,0 +1,29 @@
+import { ITaggedEntity } from "./ITaggedEntity";
+import { Uuid } from "./Uuid";
+import { IsoDate } from "./IsoDate";
+import { CognitoRegion } from "./CognitoRegion";
+import { IUserScope } from "./IUserScope";
+export interface IUser extends ITaggedEntity {
+    organizationId?: 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;
+    termsAccepted?: string;
+    lastLoggedIn?: IsoDate;
+    passwordHash?: string | null;
+    isSingleSignOn?: boolean;
+    isServiceAccount?: boolean;
+    region: CognitoRegion;
+    jobTitle?: string;
+    language?: string;
+    units?: string;
+    timezone?: string;
+}

package/dist/types/data-sdk/src/model/IUserParameters.d.ts

@@ -0,0 +1,4 @@
+import { AccessLevel } from "./AccessLevel";
+export interface IUserParameters {
+    roles?: AccessLevel[];
+}

package/dist/types/data-sdk/src/model/IUserScope.d.ts

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

package/dist/types/data-sdk/src/model/IVector2.d.ts

@@ -0,0 +1,4 @@
+export interface IVector2 {
+    x: number;
+    y: number;
+}

package/dist/types/data-sdk/src/model/IVector3.d.ts

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

package/dist/types/data-sdk/src/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/types/data-sdk/src/model/IVideoDevice.d.ts

@@ -0,0 +1,4 @@
+export interface IVideoDevice {
+    path: string;
+    name: string;
+}

package/dist/types/data-sdk/src/model/IView.d.ts

@@ -0,0 +1,15 @@
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface IView {
+    id: Uuid;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+    organizationId: Uuid;
+    name: string;
+    url: string;
+    showOnSingleDevice: boolean;
+    showOnMultiDevice: boolean;
+    showOnTeleop: boolean;
+    showOnAnalytics: boolean;
+    showTimeline: boolean;
+}

package/dist/types/data-sdk/src/model/IdeviceFollower.d.ts

@@ -0,0 +1,4 @@
+import { Uuid } from "./Uuid";
+export interface IDeviceFollower {
+    userId: Uuid;
+}

package/dist/types/data-sdk/src/model/InetworkInfo.d.ts

@@ -0,0 +1,4 @@
+import { INetwork } from "./INetwork";
+export interface INetworkInfo {
+    networks: INetwork[];
+}

package/dist/types/data-sdk/src/model/InterventionType.d.ts

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

package/dist/types/data-sdk/src/model/IsoDate.d.ts

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

package/dist/types/data-sdk/src/model/JsonSchema.d.ts

@@ -0,0 +1,39 @@
+import { StreamType } from "./StreamType";
+export type FieldType = "string" | "integer" | "number" | "array" | "object" | "boolean";
+export interface IJsonBaseSchema<T extends FieldType> {
+    title?: string;
+    description?: string;
+    type: T;
+    required?: string[];
+    $schema?: string;
+    "$formant.visible.when"?: [string, "=", string];
+}
+export interface IJsonBaseSchemaWithDefault<T extends FieldType, U> extends IJsonBaseSchema<T> {
+    default?: U;
+}
+export interface IPropertyObject {
+    [key: string]: JsonSchema;
+}
+export interface IJsonObjectSchema extends IJsonBaseSchema<"object"> {
+    properties?: IPropertyObject;
+    "$formant.documentationUrl"?: string;
+}
+export interface IJsonArraySchema extends IJsonBaseSchema<"array"> {
+    items: {
+        type: "integer" | "number" | "string" | "object";
+        properties: IPropertyObject;
+        required?: string[];
+        "$formant.itemName"?: string;
+    };
+}
+export interface IJsonStringSchema extends IJsonBaseSchemaWithDefault<"string", string> {
+    enum?: string[];
+    "$formant.streams.byType"?: StreamType;
+    "$formant.placeholder"?: string;
+    "$formant.groups"?: boolean;
+    "$formant.date"?: boolean;
+}
+export type IJsonBooleanSchema = IJsonBaseSchemaWithDefault<"boolean", boolean>;
+export type IJsonIntegerSchema = IJsonBaseSchemaWithDefault<"integer", number>;
+export type IJsonNumberSchema = IJsonBaseSchemaWithDefault<"number", number>;
+export type JsonSchema = IJsonObjectSchema | IJsonStringSchema | IJsonArraySchema | IJsonBooleanSchema | IJsonIntegerSchema | IJsonNumberSchema;

package/dist/types/data-sdk/src/model/Marker3DAction.d.ts

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

package/dist/types/data-sdk/src/model/Marker3DType.d.ts

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

package/dist/types/data-sdk/src/model/OnDemandBufferType.d.ts

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