@formant/data-sdk 0.0.90 → 0.0.91

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

@@ -0,0 +1,9 @@
+import { ICommandParameter } from "./ICommandParameter";
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface ICommandRequest {
+    id: Uuid;
+    command: string;
+    parameter: ICommandParameter;
+    createdAt: IsoDate;
+}

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

@@ -0,0 +1,5 @@
+import { ICommandEventBase } from "./ICommandEventBase";
+import { Uuid } from "./Uuid";
+export interface ICommandRequestEvent extends ICommandEventBase<"command-request"> {
+    userId?: Uuid;
+}

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

@@ -0,0 +1,13 @@
+import { IsoDate } from "./IsoDate";
+import { ITags } from "./ITags";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface ICommandResponse {
+    time: IsoDate;
+    message: string;
+    success: boolean;
+    replyToCommandRequestId: Uuid;
+    streamName?: string;
+    streamType?: StreamType;
+    tags?: ITags;
+}

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

@@ -0,0 +1,3 @@
+import { ICommandEventBase } from "./ICommandEventBase";
+export interface ICommandResponseEvent extends ICommandEventBase<"command-response"> {
+}

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

@@ -0,0 +1,7 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface IComment extends IBaseEvent<"comment"> {
+    editedAt?: IsoDate;
+    userId: Uuid;
+}

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

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

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

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

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

@@ -0,0 +1,7 @@
+import { IStreamTypeMap } from "./IStreamTypeMap";
+import { StreamType } from "./StreamType";
+import { Timestamp } from "./Timestamp";
+export declare type IDataPoint<T extends StreamType = StreamType> = [
+    Timestamp,
+    IStreamTypeMap[T]
+];

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

@@ -0,0 +1,12 @@
+import { IAnnotation } from "./IAnnotation";
+import { ICommandDeliveryEvent } from "./ICommandDeliveryEvent";
+import { ICommandRequestEvent } from "./ICommandRequestEvent";
+import { ICommandResponseEvent } from "./ICommandResponseEvent";
+import { IComment } from "./IComment";
+import { ICustomEvent } from "./ICustomEvent";
+import { IInterventionRequest } from "./IInterventionRequest";
+import { IPortForwardingSessionRecord } from "./IPortForwardingSessionRecord";
+import { ISystemEvent } from "./ISystemEvent";
+import { ITeleopSessionRecord } from "./ITeleopSessionRecord";
+import { ITriggeredEvent } from "./ITriggeredEvent";
+export declare type IEvent = ITriggeredEvent | IInterventionRequest | ITeleopSessionRecord | IPortForwardingSessionRecord | ICommandRequestEvent | ICommandResponseEvent | ICommandDeliveryEvent | ICustomEvent | IComment | ISystemEvent | IAnnotation;

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

@@ -0,0 +1,19 @@
+import { EventType } from "./EventType";
+import { IFilter } from "./IFilter";
+import { IsoDate } from "./IsoDate";
+import { Severity } from "./Severity";
+import { Uuid } from "./Uuid";
+export interface IEventFilter extends IFilter {
+    id?: Uuid;
+    viewed?: boolean;
+    keyword?: string;
+    message?: string;
+    start?: IsoDate;
+    end?: IsoDate;
+    eventTypes?: EventType[];
+    notificationEnabled?: boolean;
+    userIds?: Uuid[];
+    annotationTemplateIds?: Uuid[];
+    disableNullMatches?: boolean;
+    severities?: Severity[];
+}

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

@@ -0,0 +1,7 @@
+import { IEventFilter } from "./IEventFilter";
+import { IEventSort } from "./IEventSort";
+export interface IEventQuery extends IEventFilter {
+    offset?: number;
+    count?: number;
+    sort?: IEventSort;
+}

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

@@ -0,0 +1,6 @@
+import { EventSortableColumn } from "./EventSortableColumn";
+import { SortOrder } from "./SortOrder";
+export interface IEventSort {
+    column: EventSortableColumn;
+    order: SortOrder;
+}

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

@@ -0,0 +1,8 @@
+import { ISheetParameters } from "./ISheetParameters";
+import { ITagParameters } from "./ITagParameters";
+import { IUserParameters } from "./IUserParameters";
+export interface IFieldParametersTypeMap {
+    tag: ITagParameters;
+    sheet: ISheetParameters;
+    user: IUserParameters;
+}

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

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

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

@@ -0,0 +1,6 @@
+import { Uuid } from "./Uuid";
+export interface IFileInfo {
+    id: Uuid;
+    name?: string;
+    url?: string;
+}

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { IInterventionResponse } from "./IInterventionResponse";
+import { IInterventionTypeMap } from "./IInterventionTypeMap";
+import { InterventionType } from "./InterventionType";
+export interface IInterventionRequest<T extends InterventionType = InterventionType> extends IBaseEvent<"intervention-request"> {
+    interventionType: T;
+    data: IInterventionTypeMap[T]["request"];
+    responses?: IInterventionResponse<T>[];
+}

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

@@ -0,0 +1,10 @@
+import { IBaseEntity } from "./IBaseEntity";
+import { IInterventionTypeMap } from "./IInterventionTypeMap";
+import { InterventionType } from "./InterventionType";
+import { Uuid } from "./Uuid";
+export interface IInterventionResponse<T extends InterventionType = InterventionType> extends IBaseEntity {
+    userId?: Uuid;
+    interventionId: Uuid;
+    interventionType: T;
+    data: IInterventionTypeMap[T]["response"];
+}

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

@@ -0,0 +1,20 @@
+import { ILabelingRequestData } from "./ILabelingRequestData";
+import { ILabelingResponseData } from "./ILabelingResponseData";
+import { ISelectionRequestData } from "./ISelectionRequestData";
+import { ISelectionResponseData } from "./ISelectionResponseData";
+import { ITeleopRequestData } from "./ITeleopRequestData";
+import { ITeleopResponseData } from "./ITeleopResponseData";
+export interface IInterventionTypeMap {
+    selection: {
+        request: ISelectionRequestData;
+        response: ISelectionResponseData;
+    };
+    labeling: {
+        request: ILabelingRequestData;
+        response: ILabelingResponseData;
+    };
+    teleop: {
+        request: ITeleopRequestData;
+        response: ITeleopResponseData;
+    };
+}

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

@@ -0,0 +1,4 @@
+export interface ILabel {
+    value: string;
+    displayName?: string;
+}

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

@@ -0,0 +1,4 @@
+export interface ILabeledPolygon {
+    vertices: [number, number][];
+    labels: string[];
+}

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

@@ -0,0 +1,8 @@
+import { ILabel } from "./ILabel";
+import { ILabeledPolygon } from "./ILabeledPolygon";
+export interface ILabelingRequestData {
+    instruction: string;
+    imageUrl: string;
+    labels: ILabel[];
+    hint?: ILabeledPolygon[];
+}

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

@@ -0,0 +1,4 @@
+import { ILabeledPolygon } from "./ILabeledPolygon";
+export interface ILabelingResponseData {
+    value: ILabeledPolygon[];
+}

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

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

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

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

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

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

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

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

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/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/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/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/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/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/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/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,10 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Severity } from "./Severity";
+import { Uuid } from "./Uuid";
+export interface ITriggeredEvent extends IBaseEvent<"triggered-event"> {
+    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/IUserParameters.d.ts

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+import { severities } from "./severities";
+export declare type Severity = typeof severities[number];

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

@@ -0,0 +1 @@
+export declare type SortOrder = "asc" | "desc";

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+export declare const accessLevels: readonly ["viewer", "operator", "administrator"];

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

@@ -0,0 +1,2 @@
+import { AggregateLevel } from "./AggregateLevel";
+export declare const aggregateLevels: AggregateLevel[];

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

@@ -0,0 +1 @@
+export declare const annotationTypes: string[];

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

@@ -0,0 +1 @@
+export declare const eventTypes: readonly ["triggered-event", "intervention-request", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation"];

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

@@ -0,0 +1 @@
+export declare const healthStatuses: readonly ["unknown", "operational", "offline", "error"];

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

@@ -0,0 +1 @@
+export declare const interventionTypes: string[];

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

@@ -0,0 +1 @@
+export declare const severities: readonly ["info", "warning", "error", "critical"];

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

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

package/package.json

@@ -18,7 +18,7 @@
       "require": "./dist/data-sdk.umd.js"
     }
   },
-  "version": "0.0.90",
+  "version": "0.0.91",
   "scripts": {
     "dev": "vite --port 9146",
     "build": "tsc && vite build",