@formant/data-sdk 0.0.141 → 0.0.142

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/dist/types/common/browser.d.ts +2 -0
  2. package/dist/types/common/defined.d.ts +3 -0
  3. package/dist/types/common/delay.d.ts +1 -0
  4. package/dist/types/common/duration.d.ts +10 -0
  5. package/dist/types/common/fork.d.ts +5 -0
  6. package/dist/types/common/stringToArrayBuffer.d.ts +1 -0
  7. package/dist/types/data-sdk/src/App.d.ts +131 -0
  8. package/dist/types/data-sdk/src/AudioPlayer.d.ts +22 -0
  9. package/dist/types/data-sdk/src/Authentication.d.ts +52 -0
  10. package/dist/types/data-sdk/src/CaptureStream.d.ts +18 -0
  11. package/dist/types/data-sdk/src/DataChannel.d.ts +29 -0
  12. package/dist/types/data-sdk/src/Device.d.ts +157 -0
  13. package/dist/types/data-sdk/src/Fleet.d.ts +204 -0
  14. package/dist/types/data-sdk/src/KeyValue.d.ts +6 -0
  15. package/dist/types/data-sdk/src/Manipulator.d.ts +20 -0
  16. package/dist/types/data-sdk/src/PeerDevice.d.ts +37 -0
  17. package/dist/types/data-sdk/src/RequestDataChannel.d.ts +29 -0
  18. package/dist/types/data-sdk/src/cache/StoreCache.d.ts +17 -0
  19. package/dist/types/data-sdk/src/cache/filterDataByTime.d.ts +2 -0
  20. package/dist/types/data-sdk/src/cache/filterDataByType.d.ts +3 -0
  21. package/dist/types/data-sdk/src/cache/queryStore.d.ts +11 -0
  22. package/dist/types/data-sdk/src/config.d.ts +1 -0
  23. package/dist/types/data-sdk/src/main.d.ts +131 -0
  24. package/dist/types/data-sdk/src/model/AccessLevel.d.ts +5 -0
  25. package/dist/types/data-sdk/src/model/AggregateLevel.d.ts +1 -0
  26. package/dist/types/data-sdk/src/model/AnalyticsAggregateType.d.ts +2 -0
  27. package/dist/types/data-sdk/src/model/AnalyticsChartType.d.ts +2 -0
  28. package/dist/types/data-sdk/src/model/AnnotationAreaType.d.ts +2 -0
  29. package/dist/types/data-sdk/src/model/AnnotationType.d.ts +2 -0
  30. package/dist/types/data-sdk/src/model/DeviceType.d.ts +2 -0
  31. package/dist/types/data-sdk/src/model/EventSortableColumn.d.ts +1 -0
  32. package/dist/types/data-sdk/src/model/EventType.d.ts +2 -0
  33. package/dist/types/data-sdk/src/model/HealthStatus.d.ts +2 -0
  34. package/dist/types/data-sdk/src/model/HexRgbColor.d.ts +1 -0
  35. package/dist/types/data-sdk/src/model/IAggregateRow.d.ts +8 -0
  36. package/dist/types/data-sdk/src/model/IAnalyticsModule.d.ts +15 -0
  37. package/dist/types/data-sdk/src/model/IAnalyticsModuleConfiguration.d.ts +6 -0
  38. package/dist/types/data-sdk/src/model/IAnnotation.d.ts +13 -0
  39. package/dist/types/data-sdk/src/model/IAnnotationAreaTypeMap.d.ts +4 -0
  40. package/dist/types/data-sdk/src/model/IAnnotationQuery.d.ts +7 -0
  41. package/dist/types/data-sdk/src/model/IBaseEntity.d.ts +7 -0
  42. package/dist/types/data-sdk/src/model/IBaseEvent.d.ts +19 -0
  43. package/dist/types/data-sdk/src/model/IBattery.d.ts +6 -0
  44. package/dist/types/data-sdk/src/model/IBitset.d.ts +4 -0
  45. package/dist/types/data-sdk/src/model/IBoundingBox.d.ts +6 -0
  46. package/dist/types/data-sdk/src/model/IColorRGBA.d.ts +6 -0
  47. package/dist/types/data-sdk/src/model/ICommandDeliveryEvent.d.ts +3 -0
  48. package/dist/types/data-sdk/src/model/ICommandEventBase.d.ts +5 -0
  49. package/dist/types/data-sdk/src/model/ICommandParameter.d.ts +9 -0
  50. package/dist/types/data-sdk/src/model/ICommandRequest.d.ts +9 -0
  51. package/dist/types/data-sdk/src/model/ICommandRequestEvent.d.ts +5 -0
  52. package/dist/types/data-sdk/src/model/ICommandResponse.d.ts +13 -0
  53. package/dist/types/data-sdk/src/model/ICommandResponseEvent.d.ts +3 -0
  54. package/dist/types/data-sdk/src/model/IComment.d.ts +7 -0
  55. package/dist/types/data-sdk/src/model/IConfigurationMap.d.ts +3 -0
  56. package/dist/types/data-sdk/src/model/ICustomEvent.d.ts +5 -0
  57. package/dist/types/data-sdk/src/model/IDataAggregate.d.ts +7 -0
  58. package/dist/types/data-sdk/src/model/IDataPoint.d.ts +7 -0
  59. package/dist/types/data-sdk/src/model/IDeviceQuery.d.ts +14 -0
  60. package/dist/types/data-sdk/src/model/IEvent.d.ts +12 -0
  61. package/dist/types/data-sdk/src/model/IEventFilter.d.ts +19 -0
  62. package/dist/types/data-sdk/src/model/IEventQuery.d.ts +7 -0
  63. package/dist/types/data-sdk/src/model/IEventSort.d.ts +6 -0
  64. package/dist/types/data-sdk/src/model/IFieldParametersTypeMap.d.ts +8 -0
  65. package/dist/types/data-sdk/src/model/IFile.d.ts +6 -0
  66. package/dist/types/data-sdk/src/model/IFileInfo.d.ts +6 -0
  67. package/dist/types/data-sdk/src/model/IFilter.d.ts +10 -0
  68. package/dist/types/data-sdk/src/model/IGoal.d.ts +5 -0
  69. package/dist/types/data-sdk/src/model/IGoalID.d.ts +3 -0
  70. package/dist/types/data-sdk/src/model/IHealth.d.ts +4 -0
  71. package/dist/types/data-sdk/src/model/IImage.d.ts +6 -0
  72. package/dist/types/data-sdk/src/model/IImageAnnotation.d.ts +9 -0
  73. package/dist/types/data-sdk/src/model/IInterventionRequest.d.ts +9 -0
  74. package/dist/types/data-sdk/src/model/IInterventionResponse.d.ts +10 -0
  75. package/dist/types/data-sdk/src/model/IInterventionTypeMap.d.ts +20 -0
  76. package/dist/types/data-sdk/src/model/ILabel.d.ts +4 -0
  77. package/dist/types/data-sdk/src/model/ILabeledPolygon.d.ts +4 -0
  78. package/dist/types/data-sdk/src/model/ILabelingRequestData.d.ts +8 -0
  79. package/dist/types/data-sdk/src/model/ILabelingResponseData.d.ts +4 -0
  80. package/dist/types/data-sdk/src/model/ILocalization.d.ts +14 -0
  81. package/dist/types/data-sdk/src/model/ILocation.d.ts +6 -0
  82. package/dist/types/data-sdk/src/model/IMap.d.ts +10 -0
  83. package/dist/types/data-sdk/src/model/INumericAggregate.d.ts +7 -0
  84. package/dist/types/data-sdk/src/model/INumericSetAggregateMap.d.ts +5 -0
  85. package/dist/types/data-sdk/src/model/INumericSetEntry.d.ts +5 -0
  86. package/dist/types/data-sdk/src/model/IOdometry.d.ts +7 -0
  87. package/dist/types/data-sdk/src/model/IPath.d.ts +5 -0
  88. package/dist/types/data-sdk/src/model/IPointCloud.d.ts +6 -0
  89. package/dist/types/data-sdk/src/model/IPortForwardingSessionRecord.d.ts +3 -0
  90. package/dist/types/data-sdk/src/model/IQuaternion.d.ts +6 -0
  91. package/dist/types/data-sdk/src/model/IQuery.d.ts +9 -0
  92. package/dist/types/data-sdk/src/model/IRtcSessionRecord.d.ts +9 -0
  93. package/dist/types/data-sdk/src/model/IScopeFilter.d.ts +6 -0
  94. package/dist/types/data-sdk/src/model/ISelectionRequestData.d.ts +6 -0
  95. package/dist/types/data-sdk/src/model/ISelectionResponseData.d.ts +3 -0
  96. package/dist/types/data-sdk/src/model/IShare.d.ts +16 -0
  97. package/dist/types/data-sdk/src/model/ISheetParameters.d.ts +5 -0
  98. package/dist/types/data-sdk/src/model/ISpreadsheetIdRange.d.ts +4 -0
  99. package/dist/types/data-sdk/src/model/ISqlColumn.d.ts +6 -0
  100. package/dist/types/data-sdk/src/model/ISqlQuery.d.ts +21 -0
  101. package/dist/types/data-sdk/src/model/ISqlResult.d.ts +12 -0
  102. package/dist/types/data-sdk/src/model/ISqlRow.d.ts +5 -0
  103. package/dist/types/data-sdk/src/model/IStream.d.ts +18 -0
  104. package/dist/types/data-sdk/src/model/IStreamAggregateData.d.ts +11 -0
  105. package/dist/types/data-sdk/src/model/IStreamAggregateTypeMap.d.ts +10 -0
  106. package/dist/types/data-sdk/src/model/IStreamColumn.d.ts +7 -0
  107. package/dist/types/data-sdk/src/model/IStreamCurrentValue.d.ts +13 -0
  108. package/dist/types/data-sdk/src/model/IStreamData.d.ts +11 -0
  109. package/dist/types/data-sdk/src/model/IStreamTypeMap.d.ts +27 -0
  110. package/dist/types/data-sdk/src/model/ISystemEvent.d.ts +3 -0
  111. package/dist/types/data-sdk/src/model/ITagParameters.d.ts +3 -0
  112. package/dist/types/data-sdk/src/model/ITagSets.d.ts +3 -0
  113. package/dist/types/data-sdk/src/model/ITaggedUsers.d.ts +4 -0
  114. package/dist/types/data-sdk/src/model/ITags.d.ts +3 -0
  115. package/dist/types/data-sdk/src/model/ITaskReportColumn.d.ts +7 -0
  116. package/dist/types/data-sdk/src/model/ITeleopRequestData.d.ts +3 -0
  117. package/dist/types/data-sdk/src/model/ITeleopResponseData.d.ts +4 -0
  118. package/dist/types/data-sdk/src/model/ITeleopSessionRecord.d.ts +3 -0
  119. package/dist/types/data-sdk/src/model/ITransform.d.ts +6 -0
  120. package/dist/types/data-sdk/src/model/ITransformNode.d.ts +7 -0
  121. package/dist/types/data-sdk/src/model/ITriggeredEvent.d.ts +10 -0
  122. package/dist/types/data-sdk/src/model/ITwist.d.ts +5 -0
  123. package/dist/types/data-sdk/src/model/IUserParameters.d.ts +4 -0
  124. package/dist/types/data-sdk/src/model/IVector3.d.ts +5 -0
  125. package/dist/types/data-sdk/src/model/IVideo.d.ts +7 -0
  126. package/dist/types/data-sdk/src/model/IView.d.ts +15 -0
  127. package/dist/types/data-sdk/src/model/InterventionType.d.ts +2 -0
  128. package/dist/types/data-sdk/src/model/IsoDate.d.ts +1 -0
  129. package/dist/types/data-sdk/src/model/JsonSchema.d.ts +39 -0
  130. package/dist/types/data-sdk/src/model/Severity.d.ts +2 -0
  131. package/dist/types/data-sdk/src/model/SortOrder.d.ts +1 -0
  132. package/dist/types/data-sdk/src/model/StreamType.d.ts +2 -0
  133. package/dist/types/data-sdk/src/model/Timestamp.d.ts +1 -0
  134. package/dist/types/data-sdk/src/model/Uuid.d.ts +1 -0
  135. package/dist/types/data-sdk/src/model/VideoMimeType.d.ts +2 -0
  136. package/dist/types/data-sdk/src/model/accessLevels.d.ts +1 -0
  137. package/dist/types/data-sdk/src/model/aggregateLevels.d.ts +2 -0
  138. package/dist/types/data-sdk/src/model/analyticsAggregteTypes.d.ts +1 -0
  139. package/dist/types/data-sdk/src/model/analyticsChartTypes.d.ts +1 -0
  140. package/dist/types/data-sdk/src/model/annotationTypes.d.ts +1 -0
  141. package/dist/types/data-sdk/src/model/deviceTypes.d.ts +1 -0
  142. package/dist/types/data-sdk/src/model/eventTypes.d.ts +1 -0
  143. package/dist/types/data-sdk/src/model/healthStatuses.d.ts +1 -0
  144. package/dist/types/data-sdk/src/model/interventionTypes.d.ts +1 -0
  145. package/dist/types/data-sdk/src/model/severities.d.ts +1 -0
  146. package/dist/types/data-sdk/src/model/videoMimeTypes.d.ts +1 -0
  147. package/dist/types/data-sdk/src/utils/aggregateFunctionUtils.d.ts +28 -0
  148. package/dist/types/data-sdk/src/utils/index.d.ts +4 -0
  149. package/dist/types/data-sdk/src/utils/numericAggregateUtils.d.ts +24 -0
  150. package/dist/types/data-sdk/src/utils/serializeHash.d.ts +2 -0
  151. package/dist/types/data-sdk/src/utils/timeout.d.ts +1 -0
  152. package/package.json +1 -1
@@ -0,0 +1,6 @@
1
+ import { IImageAnnotation } from "./IImageAnnotation";
2
+ export interface IImage {
3
+ url: string;
4
+ size?: number;
5
+ annotations?: IImageAnnotation[];
6
+ }
@@ -0,0 +1,9 @@
1
+ import { AnnotationAreaType } from "./AnnotationAreaType";
2
+ import { HexRgbColor } from "./HexRgbColor";
3
+ import { IAnnotationAreaTypeMap } from "./IAnnotationAreaTypeMap";
4
+ export interface IImageAnnotation<T extends AnnotationAreaType = AnnotationAreaType> {
5
+ label: string;
6
+ type: AnnotationAreaType;
7
+ area: IAnnotationAreaTypeMap[T];
8
+ color: HexRgbColor;
9
+ }
@@ -0,0 +1,9 @@
1
+ import { IBaseEvent } from "./IBaseEvent";
2
+ import { IInterventionResponse } from "./IInterventionResponse";
3
+ import { IInterventionTypeMap } from "./IInterventionTypeMap";
4
+ import { InterventionType } from "./InterventionType";
5
+ export interface IInterventionRequest<T extends InterventionType = InterventionType> extends IBaseEvent<"intervention-request"> {
6
+ interventionType: T;
7
+ data: IInterventionTypeMap[T]["request"];
8
+ responses?: IInterventionResponse<T>[];
9
+ }
@@ -0,0 +1,10 @@
1
+ import { IBaseEntity } from "./IBaseEntity";
2
+ import { IInterventionTypeMap } from "./IInterventionTypeMap";
3
+ import { InterventionType } from "./InterventionType";
4
+ import { Uuid } from "./Uuid";
5
+ export interface IInterventionResponse<T extends InterventionType = InterventionType> extends IBaseEntity {
6
+ userId?: Uuid;
7
+ interventionId: Uuid;
8
+ interventionType: T;
9
+ data: IInterventionTypeMap[T]["response"];
10
+ }
@@ -0,0 +1,20 @@
1
+ import { ILabelingRequestData } from "./ILabelingRequestData";
2
+ import { ILabelingResponseData } from "./ILabelingResponseData";
3
+ import { ISelectionRequestData } from "./ISelectionRequestData";
4
+ import { ISelectionResponseData } from "./ISelectionResponseData";
5
+ import { ITeleopRequestData } from "./ITeleopRequestData";
6
+ import { ITeleopResponseData } from "./ITeleopResponseData";
7
+ export interface IInterventionTypeMap {
8
+ selection: {
9
+ request: ISelectionRequestData;
10
+ response: ISelectionResponseData;
11
+ };
12
+ labeling: {
13
+ request: ILabelingRequestData;
14
+ response: ILabelingResponseData;
15
+ };
16
+ teleop: {
17
+ request: ITeleopRequestData;
18
+ response: ITeleopResponseData;
19
+ };
20
+ }
@@ -0,0 +1,4 @@
1
+ export interface ILabel {
2
+ value: string;
3
+ displayName?: string;
4
+ }
@@ -0,0 +1,4 @@
1
+ export interface ILabeledPolygon {
2
+ vertices: [number, number][];
3
+ labels: string[];
4
+ }
@@ -0,0 +1,8 @@
1
+ import { ILabel } from "./ILabel";
2
+ import { ILabeledPolygon } from "./ILabeledPolygon";
3
+ export interface ILabelingRequestData {
4
+ instruction: string;
5
+ imageUrl: string;
6
+ labels: ILabel[];
7
+ hint?: ILabeledPolygon[];
8
+ }
@@ -0,0 +1,4 @@
1
+ import { ILabeledPolygon } from "./ILabeledPolygon";
2
+ export interface ILabelingResponseData {
3
+ value: ILabeledPolygon[];
4
+ }
@@ -0,0 +1,14 @@
1
+ import { IGoal } from "./IGoal";
2
+ import { IMap } from "./IMap";
3
+ import { IOdometry } from "./IOdometry";
4
+ import { IPath } from "./IPath";
5
+ import { IPointCloud } from "./IPointCloud";
6
+ export interface ILocalization {
7
+ odometry?: IOdometry;
8
+ map?: IMap;
9
+ pointClouds?: IPointCloud[];
10
+ path?: IPath;
11
+ goal?: IGoal;
12
+ url?: string;
13
+ size?: number;
14
+ }
@@ -0,0 +1,6 @@
1
+ export interface ILocation {
2
+ latitude: number;
3
+ longitude: number;
4
+ altitude?: number;
5
+ orientation?: number;
6
+ }
@@ -0,0 +1,10 @@
1
+ import { ITransform } from "./ITransform";
2
+ export interface IMap {
3
+ url: string;
4
+ size?: number;
5
+ width: number;
6
+ height: number;
7
+ resolution: number;
8
+ origin: ITransform;
9
+ worldToLocal: ITransform;
10
+ }
@@ -0,0 +1,7 @@
1
+ export interface INumericAggregate {
2
+ min: number;
3
+ max: number;
4
+ sum: number;
5
+ count: number;
6
+ sumOfSquares: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ import { INumericAggregate } from "./INumericAggregate";
2
+ export type INumericSetAggregateMap = Map<string, {
3
+ value: INumericAggregate;
4
+ unit?: string;
5
+ }>;
@@ -0,0 +1,5 @@
1
+ export interface INumericSetEntry {
2
+ label: string;
3
+ value: number;
4
+ unit?: string;
5
+ }
@@ -0,0 +1,7 @@
1
+ import { ITransform } from "./ITransform";
2
+ import { ITwist } from "./ITwist";
3
+ export interface IOdometry {
4
+ pose: ITransform;
5
+ twist: ITwist;
6
+ worldToLocal: ITransform;
7
+ }
@@ -0,0 +1,5 @@
1
+ import { ITransform } from "./ITransform";
2
+ export interface IPath {
3
+ worldToLocal: ITransform;
4
+ poses: ITransform[];
5
+ }
@@ -0,0 +1,6 @@
1
+ import { ITransform } from "./ITransform";
2
+ export interface IPointCloud {
3
+ url: string;
4
+ size?: number;
5
+ worldToLocal?: ITransform;
6
+ }
@@ -0,0 +1,3 @@
1
+ import { IRtcSessionRecord } from "./IRtcSessionRecord";
2
+ export interface IPortForwardingSessionRecord extends IRtcSessionRecord<"port-forwarding-session-record"> {
3
+ }
@@ -0,0 +1,6 @@
1
+ export interface IQuaternion {
2
+ x: number;
3
+ y: number;
4
+ z: number;
5
+ w: number;
6
+ }
@@ -0,0 +1,9 @@
1
+ import { AggregateLevel } from "./AggregateLevel";
2
+ import { IFilter } from "./IFilter";
3
+ import { IsoDate } from "./IsoDate";
4
+ export interface IQuery extends IFilter {
5
+ aggregate?: AggregateLevel;
6
+ start: IsoDate;
7
+ end: IsoDate;
8
+ latestOnly?: boolean;
9
+ }
@@ -0,0 +1,9 @@
1
+ import { Uuid } from "./Uuid";
2
+ import { IBaseEvent } from "./IBaseEvent";
3
+ import { IsoDate } from "./IsoDate";
4
+ export interface IRtcSessionRecord<T extends "teleop-session-record" | "port-forwarding-session-record"> extends IBaseEvent<T> {
5
+ sessionId: Uuid;
6
+ userId: Uuid;
7
+ deviceId: Uuid;
8
+ endTime: IsoDate;
9
+ }
@@ -0,0 +1,6 @@
1
+ import { IFilter } from "./IFilter";
2
+ import { IsoDate } from "./IsoDate";
3
+ export interface IScopeFilter extends IFilter {
4
+ start?: IsoDate;
5
+ end?: IsoDate;
6
+ }
@@ -0,0 +1,6 @@
1
+ export interface ISelectionRequestData {
2
+ instruction: string;
3
+ imageUrl: string;
4
+ options: string[];
5
+ hint?: number;
6
+ }
@@ -0,0 +1,3 @@
1
+ export interface ISelectionResponseData {
2
+ value: number;
3
+ }
@@ -0,0 +1,16 @@
1
+ import { IBaseEntity } from "./IBaseEntity";
2
+ import { Uuid } from "./Uuid";
3
+ import { IScopeFilter } from "./IScopeFilter";
4
+ import { IsoDate } from "./IsoDate";
5
+ export interface IShare extends IBaseEntity {
6
+ organizationId?: Uuid;
7
+ userId?: Uuid;
8
+ code?: string;
9
+ scope: IScopeFilter;
10
+ time: IsoDate;
11
+ expiration?: IsoDate | null;
12
+ channelId?: Uuid;
13
+ message?: string;
14
+ userName?: string;
15
+ delegateTeleop?: boolean;
16
+ }
@@ -0,0 +1,5 @@
1
+ export interface ISheetParameters {
2
+ url?: string;
3
+ spreadsheetId: string;
4
+ range: string;
5
+ }
@@ -0,0 +1,4 @@
1
+ export interface ISpreadsheetIdRange {
2
+ spreadsheetId: string;
3
+ range: string;
4
+ }
@@ -0,0 +1,6 @@
1
+ export interface ISqlColumn {
2
+ name: string;
3
+ tableName: string;
4
+ isNullable?: boolean;
5
+ dataType: "string" | "timestamp" | "boolean" | "number" | "null";
6
+ }
@@ -0,0 +1,21 @@
1
+ import { IsoDate } from "./IsoDate";
2
+ import { IFilter } from "./IFilter";
3
+ import { AggregateLevel } from "./AggregateLevel";
4
+ import { IStreamColumn } from "./IStreamColumn";
5
+ import { ITaskReportColumn } from "./ITaskReportColumn";
6
+ export interface ISqlQuery extends IFilter {
7
+ sqlQuery?: string;
8
+ parameters?: string[];
9
+ start?: IsoDate;
10
+ end?: IsoDate;
11
+ streamColumns?: IStreamColumn[];
12
+ taskColumns?: ITaskReportColumn[];
13
+ aggregateLevel?: AggregateLevel;
14
+ limit?: number;
15
+ orderByColumn?: string;
16
+ orderByDescending?: boolean;
17
+ visibleColumns?: string[];
18
+ filters?: string[];
19
+ type?: "stream" | "task" | "advanced";
20
+ unit?: string;
21
+ }
@@ -0,0 +1,12 @@
1
+ import { IAggregateRow } from "./IAggregateRow";
2
+ import { ISqlColumn } from "./ISqlColumn";
3
+ import { ISqlRow } from "./ISqlRow";
4
+ export interface ISqlResult {
5
+ rows: ISqlRow[];
6
+ columns: ISqlColumn[];
7
+ aggregates?: IAggregateRow[];
8
+ sqlText: string;
9
+ aggregateSqlText?: string;
10
+ rowCount: number;
11
+ unit?: string;
12
+ }
@@ -0,0 +1,5 @@
1
+ import { IsoDate } from "./IsoDate";
2
+ export interface ISqlRow {
3
+ [key: string]: string | IsoDate | number | boolean | null;
4
+ tableName: string;
5
+ }
@@ -0,0 +1,18 @@
1
+ import { IsoDate } from "./IsoDate";
2
+ import { Uuid } from "./Uuid";
3
+ import { StreamType } from "./StreamType";
4
+ export interface IStream {
5
+ active: boolean;
6
+ alias: string;
7
+ createdAt: IsoDate;
8
+ enabled: boolean;
9
+ id: Uuid;
10
+ isEventFilter: boolean;
11
+ isOverviewColumn: boolean;
12
+ isOverviewRow: boolean;
13
+ isTelemetryFilter: boolean;
14
+ organizationId: Uuid;
15
+ streamName: string;
16
+ streamType: StreamType;
17
+ updatedAt: IsoDate;
18
+ }
@@ -0,0 +1,11 @@
1
+ import { IDataAggregate } from "./IDataAggregate";
2
+ import { ITags } from "./ITags";
3
+ import { StreamType } from "./StreamType";
4
+ import { Uuid } from "./Uuid";
5
+ export interface IStreamAggregateData<T extends StreamType = StreamType> {
6
+ deviceId: Uuid;
7
+ name: string;
8
+ type: T;
9
+ tags: ITags;
10
+ aggregates: IDataAggregate<T>[];
11
+ }
@@ -0,0 +1,10 @@
1
+ import { INumericAggregate } from "./INumericAggregate";
2
+ import { INumericSetAggregateMap } from "./INumericSetAggregateMap";
3
+ import { StreamType } from "./StreamType";
4
+ export interface ISupportedStreamAggregateTypeMap {
5
+ "numeric set": INumericSetAggregateMap;
6
+ numeric: INumericAggregate;
7
+ }
8
+ export type IStreamAggregateTypeMap = Omit<{
9
+ [_ in StreamType]: undefined;
10
+ }, keyof ISupportedStreamAggregateTypeMap> & ISupportedStreamAggregateTypeMap;
@@ -0,0 +1,7 @@
1
+ import { StreamType } from "./StreamType";
2
+ import { AnalyticsAggregateType } from "./AnalyticsAggregateType";
3
+ export interface IStreamColumn {
4
+ streamName: string;
5
+ streamType: StreamType;
6
+ aggregateType?: AnalyticsAggregateType;
7
+ }
@@ -0,0 +1,13 @@
1
+ import { IsoDate } from "./IsoDate";
2
+ import { IStreamTypeMap } from "./IStreamTypeMap";
3
+ import { ITags } from "./ITags";
4
+ import { StreamType } from "./StreamType";
5
+ import { Uuid } from "./Uuid";
6
+ export interface IStreamCurrentValue<T extends StreamType = any> {
7
+ deviceId: Uuid;
8
+ streamName: string;
9
+ streamType: StreamType;
10
+ tags: ITags;
11
+ currentValue: IStreamTypeMap[T];
12
+ currentValueTime: IsoDate;
13
+ }
@@ -0,0 +1,11 @@
1
+ import { IDataPoint } from "./IDataPoint";
2
+ import { ITags } from "./ITags";
3
+ import { StreamType } from "./StreamType";
4
+ import { Uuid } from "./Uuid";
5
+ export interface IStreamData<T extends StreamType = StreamType> {
6
+ deviceId: Uuid;
7
+ name: string;
8
+ type: T;
9
+ tags: ITags;
10
+ points: IDataPoint<T>[];
11
+ }
@@ -0,0 +1,27 @@
1
+ import { IBattery } from "./IBattery";
2
+ import { IBitset } from "./IBitset";
3
+ import { IFile } from "./IFile";
4
+ import { IHealth } from "./IHealth";
5
+ import { IImage } from "./IImage";
6
+ import { ILocalization } from "./ILocalization";
7
+ import { ILocation } from "./ILocation";
8
+ import { INumericSetEntry } from "./INumericSetEntry";
9
+ import { IPointCloud } from "./IPointCloud";
10
+ import { ITransformNode } from "./ITransformNode";
11
+ import { IVideo } from "./IVideo";
12
+ export interface IStreamTypeMap {
13
+ bitset: IBitset;
14
+ localization: ILocalization;
15
+ "point cloud": IPointCloud;
16
+ location: ILocation;
17
+ file: IFile;
18
+ health: IHealth;
19
+ "transform tree": ITransformNode;
20
+ battery: IBattery;
21
+ video: IVideo;
22
+ "numeric set": INumericSetEntry[];
23
+ json: string;
24
+ image: IImage;
25
+ numeric: number;
26
+ text: string;
27
+ }
@@ -0,0 +1,3 @@
1
+ import { IBaseEvent } from "./IBaseEvent";
2
+ export interface ISystemEvent extends IBaseEvent<"system"> {
3
+ }
@@ -0,0 +1,3 @@
1
+ export interface ITagParameters {
2
+ choices: string[];
3
+ }
@@ -0,0 +1,3 @@
1
+ export interface ITagSets {
2
+ [key: string]: string[];
3
+ }
@@ -0,0 +1,4 @@
1
+ import { Uuid } from "./Uuid";
2
+ export interface ITaggedUsers {
3
+ [key: string]: Uuid[];
4
+ }
@@ -0,0 +1,3 @@
1
+ export interface ITags {
2
+ [key: string]: string;
3
+ }
@@ -0,0 +1,7 @@
1
+ import { ISqlColumn } from "./ISqlColumn";
2
+ export interface ITaskReportColumn {
3
+ tableName: string;
4
+ columns?: ISqlColumn[];
5
+ name: string;
6
+ yAxis?: string;
7
+ }
@@ -0,0 +1,3 @@
1
+ export interface ITeleopRequestData {
2
+ instruction: string;
3
+ }
@@ -0,0 +1,4 @@
1
+ export interface ITeleopResponseData {
2
+ state: "inProgress" | "requestAssistance" | "success" | "failure";
3
+ notes?: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ import { IRtcSessionRecord } from "./IRtcSessionRecord";
2
+ export interface ITeleopSessionRecord extends IRtcSessionRecord<"teleop-session-record"> {
3
+ }
@@ -0,0 +1,6 @@
1
+ import { IQuaternion } from "./IQuaternion";
2
+ import { IVector3 } from "./IVector3";
3
+ export interface ITransform {
4
+ translation: IVector3;
5
+ rotation: IQuaternion;
6
+ }
@@ -0,0 +1,7 @@
1
+ import { ITransform } from "./ITransform";
2
+ export interface ITransformNode {
3
+ name?: string;
4
+ transform?: ITransform;
5
+ children?: ITransformNode[];
6
+ url?: string;
7
+ }
@@ -0,0 +1,10 @@
1
+ import { IBaseEvent } from "./IBaseEvent";
2
+ import { IsoDate } from "./IsoDate";
3
+ import { Severity } from "./Severity";
4
+ import { Uuid } from "./Uuid";
5
+ export interface ITriggeredEvent extends IBaseEvent<"triggered-event"> {
6
+ severity: Severity;
7
+ eventTriggerId: Uuid;
8
+ interval: number;
9
+ intervalStart?: IsoDate;
10
+ }
@@ -0,0 +1,5 @@
1
+ import { IVector3 } from "./IVector3";
2
+ export interface ITwist {
3
+ linear: IVector3;
4
+ angular: IVector3;
5
+ }
@@ -0,0 +1,4 @@
1
+ import { AccessLevel } from "./AccessLevel";
2
+ export interface IUserParameters {
3
+ roles?: AccessLevel[];
4
+ }
@@ -0,0 +1,5 @@
1
+ export interface IVector3 {
2
+ x: number;
3
+ y: number;
4
+ z: number;
5
+ }
@@ -0,0 +1,7 @@
1
+ import { VideoMimeType } from "./VideoMimeType";
2
+ export interface IVideo {
3
+ url: string;
4
+ size?: number;
5
+ duration: number;
6
+ mimeType: VideoMimeType;
7
+ }
@@ -0,0 +1,15 @@
1
+ import { IsoDate } from "./IsoDate";
2
+ import { Uuid } from "./Uuid";
3
+ export interface IView {
4
+ id: Uuid;
5
+ createdAt: IsoDate;
6
+ updatedAt: IsoDate;
7
+ organizationId: Uuid;
8
+ name: string;
9
+ url: string;
10
+ showOnSingleDevice: boolean;
11
+ showOnMultiDevice: boolean;
12
+ showOnTeleop: boolean;
13
+ showOnAnalytics: boolean;
14
+ showTimeline: boolean;
15
+ }
@@ -0,0 +1,2 @@
1
+ import { IInterventionTypeMap } from "./IInterventionTypeMap";
2
+ export type InterventionType = keyof IInterventionTypeMap;
@@ -0,0 +1 @@
1
+ export type IsoDate = string;
@@ -0,0 +1,39 @@
1
+ import { StreamType } from "./StreamType";
2
+ export type FieldType = "string" | "integer" | "number" | "array" | "object" | "boolean";
3
+ export interface IJsonBaseSchema<T extends FieldType> {
4
+ title?: string;
5
+ description?: string;
6
+ type: T;
7
+ required?: string[];
8
+ $schema?: string;
9
+ "$formant.visible.when"?: [string, "=", string];
10
+ }
11
+ export interface IJsonBaseSchemaWithDefault<T extends FieldType, U> extends IJsonBaseSchema<T> {
12
+ default?: U;
13
+ }
14
+ export interface IPropertyObject {
15
+ [key: string]: JsonSchema;
16
+ }
17
+ export interface IJsonObjectSchema extends IJsonBaseSchema<"object"> {
18
+ properties?: IPropertyObject;
19
+ "$formant.documentationUrl"?: string;
20
+ }
21
+ export interface IJsonArraySchema extends IJsonBaseSchema<"array"> {
22
+ items: {
23
+ type: "integer" | "number" | "string" | "object";
24
+ properties: IPropertyObject;
25
+ required?: string[];
26
+ "$formant.itemName"?: string;
27
+ };
28
+ }
29
+ export interface IJsonStringSchema extends IJsonBaseSchemaWithDefault<"string", string> {
30
+ enum?: string[];
31
+ "$formant.streams.byType"?: StreamType;
32
+ "$formant.placeholder"?: string;
33
+ "$formant.groups"?: boolean;
34
+ "$formant.date"?: boolean;
35
+ }
36
+ export type IJsonBooleanSchema = IJsonBaseSchemaWithDefault<"boolean", boolean>;
37
+ export type IJsonIntegerSchema = IJsonBaseSchemaWithDefault<"integer", number>;
38
+ export type IJsonNumberSchema = IJsonBaseSchemaWithDefault<"number", number>;
39
+ export type JsonSchema = IJsonObjectSchema | IJsonStringSchema | IJsonArraySchema | IJsonBooleanSchema | IJsonIntegerSchema | IJsonNumberSchema;
@@ -0,0 +1,2 @@
1
+ import { severities } from "./severities";
2
+ export type Severity = typeof severities[number];
@@ -0,0 +1 @@
1
+ export type SortOrder = "asc" | "desc";
@@ -0,0 +1,2 @@
1
+ import { IStreamTypeMap } from "./IStreamTypeMap";
2
+ export type StreamType = keyof IStreamTypeMap;
@@ -0,0 +1 @@
1
+ export type Timestamp = number;
@@ -0,0 +1 @@
1
+ export type Uuid = string;
@@ -0,0 +1,2 @@
1
+ import { videoMimeTypes } from "./videoMimeTypes";
2
+ export type VideoMimeType = typeof videoMimeTypes[number];
@@ -0,0 +1 @@
1
+ export declare const accessLevels: readonly ["viewer", "operator", "administrator"];
@@ -0,0 +1,2 @@
1
+ import { AggregateLevel } from "./AggregateLevel";
2
+ export declare const aggregateLevels: AggregateLevel[];
@@ -0,0 +1 @@
1
+ export declare const analyticsAggregateTypes: readonly ["avg", "sum", "count", "min", "max"];
@@ -0,0 +1 @@
1
+ export declare const analyicsChartTypes: readonly ["line", "bar", "table", "pie", "summary"];
@@ -0,0 +1 @@
1
+ export declare const annotationTypes: string[];