@formant/data-sdk 0.0.139 → 0.0.141

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 (154) hide show
  1. package/dist/data-sdk.es.js +3292 -3212
  2. package/dist/data-sdk.umd.js +29 -29
  3. package/package.json +4 -3
  4. package/dist/types/common/browser.d.ts +0 -2
  5. package/dist/types/common/defined.d.ts +0 -3
  6. package/dist/types/common/delay.d.ts +0 -1
  7. package/dist/types/common/duration.d.ts +0 -10
  8. package/dist/types/common/fork.d.ts +0 -5
  9. package/dist/types/common/stringToArrayBuffer.d.ts +0 -1
  10. package/dist/types/data-sdk/src/App.d.ts +0 -131
  11. package/dist/types/data-sdk/src/AudioPlayer.d.ts +0 -22
  12. package/dist/types/data-sdk/src/Authentication.d.ts +0 -52
  13. package/dist/types/data-sdk/src/CaptureStream.d.ts +0 -18
  14. package/dist/types/data-sdk/src/DataChannel.d.ts +0 -29
  15. package/dist/types/data-sdk/src/Device.d.ts +0 -152
  16. package/dist/types/data-sdk/src/Fleet.d.ts +0 -204
  17. package/dist/types/data-sdk/src/KeyValue.d.ts +0 -6
  18. package/dist/types/data-sdk/src/Manipulator.d.ts +0 -20
  19. package/dist/types/data-sdk/src/PeerDevice.d.ts +0 -37
  20. package/dist/types/data-sdk/src/RequestDataChannel.d.ts +0 -29
  21. package/dist/types/data-sdk/src/cache/StoreCache.d.ts +0 -17
  22. package/dist/types/data-sdk/src/cache/filterDataByTime.d.ts +0 -2
  23. package/dist/types/data-sdk/src/cache/filterDataByType.d.ts +0 -3
  24. package/dist/types/data-sdk/src/cache/queryStore.d.ts +0 -11
  25. package/dist/types/data-sdk/src/config.d.ts +0 -1
  26. package/dist/types/data-sdk/src/main.d.ts +0 -131
  27. package/dist/types/data-sdk/src/model/AccessLevel.d.ts +0 -5
  28. package/dist/types/data-sdk/src/model/AggregateLevel.d.ts +0 -1
  29. package/dist/types/data-sdk/src/model/AnalyticsAggregateType.d.ts +0 -2
  30. package/dist/types/data-sdk/src/model/AnalyticsChartType.d.ts +0 -2
  31. package/dist/types/data-sdk/src/model/AnnotationAreaType.d.ts +0 -2
  32. package/dist/types/data-sdk/src/model/AnnotationType.d.ts +0 -2
  33. package/dist/types/data-sdk/src/model/DeviceType.d.ts +0 -2
  34. package/dist/types/data-sdk/src/model/EventSortableColumn.d.ts +0 -1
  35. package/dist/types/data-sdk/src/model/EventType.d.ts +0 -2
  36. package/dist/types/data-sdk/src/model/HealthStatus.d.ts +0 -2
  37. package/dist/types/data-sdk/src/model/HexRgbColor.d.ts +0 -1
  38. package/dist/types/data-sdk/src/model/IAggregateRow.d.ts +0 -8
  39. package/dist/types/data-sdk/src/model/IAnalyticsModule.d.ts +0 -15
  40. package/dist/types/data-sdk/src/model/IAnalyticsModuleConfiguration.d.ts +0 -6
  41. package/dist/types/data-sdk/src/model/IAnnotation.d.ts +0 -13
  42. package/dist/types/data-sdk/src/model/IAnnotationAreaTypeMap.d.ts +0 -4
  43. package/dist/types/data-sdk/src/model/IAnnotationQuery.d.ts +0 -7
  44. package/dist/types/data-sdk/src/model/IBaseEntity.d.ts +0 -7
  45. package/dist/types/data-sdk/src/model/IBaseEvent.d.ts +0 -19
  46. package/dist/types/data-sdk/src/model/IBattery.d.ts +0 -6
  47. package/dist/types/data-sdk/src/model/IBitset.d.ts +0 -4
  48. package/dist/types/data-sdk/src/model/IBoundingBox.d.ts +0 -6
  49. package/dist/types/data-sdk/src/model/IColorRGBA.d.ts +0 -6
  50. package/dist/types/data-sdk/src/model/ICommandDeliveryEvent.d.ts +0 -3
  51. package/dist/types/data-sdk/src/model/ICommandEventBase.d.ts +0 -5
  52. package/dist/types/data-sdk/src/model/ICommandParameter.d.ts +0 -9
  53. package/dist/types/data-sdk/src/model/ICommandRequest.d.ts +0 -9
  54. package/dist/types/data-sdk/src/model/ICommandRequestEvent.d.ts +0 -5
  55. package/dist/types/data-sdk/src/model/ICommandResponse.d.ts +0 -13
  56. package/dist/types/data-sdk/src/model/ICommandResponseEvent.d.ts +0 -3
  57. package/dist/types/data-sdk/src/model/IComment.d.ts +0 -7
  58. package/dist/types/data-sdk/src/model/IConfigurationMap.d.ts +0 -3
  59. package/dist/types/data-sdk/src/model/ICustomEvent.d.ts +0 -5
  60. package/dist/types/data-sdk/src/model/IDataAggregate.d.ts +0 -7
  61. package/dist/types/data-sdk/src/model/IDataPoint.d.ts +0 -7
  62. package/dist/types/data-sdk/src/model/IDeviceQuery.d.ts +0 -14
  63. package/dist/types/data-sdk/src/model/IEvent.d.ts +0 -12
  64. package/dist/types/data-sdk/src/model/IEventFilter.d.ts +0 -19
  65. package/dist/types/data-sdk/src/model/IEventQuery.d.ts +0 -7
  66. package/dist/types/data-sdk/src/model/IEventSort.d.ts +0 -6
  67. package/dist/types/data-sdk/src/model/IFieldParametersTypeMap.d.ts +0 -8
  68. package/dist/types/data-sdk/src/model/IFile.d.ts +0 -6
  69. package/dist/types/data-sdk/src/model/IFileInfo.d.ts +0 -6
  70. package/dist/types/data-sdk/src/model/IFilter.d.ts +0 -10
  71. package/dist/types/data-sdk/src/model/IGoal.d.ts +0 -5
  72. package/dist/types/data-sdk/src/model/IGoalID.d.ts +0 -3
  73. package/dist/types/data-sdk/src/model/IHealth.d.ts +0 -4
  74. package/dist/types/data-sdk/src/model/IImage.d.ts +0 -6
  75. package/dist/types/data-sdk/src/model/IImageAnnotation.d.ts +0 -9
  76. package/dist/types/data-sdk/src/model/IInterventionRequest.d.ts +0 -9
  77. package/dist/types/data-sdk/src/model/IInterventionResponse.d.ts +0 -10
  78. package/dist/types/data-sdk/src/model/IInterventionTypeMap.d.ts +0 -20
  79. package/dist/types/data-sdk/src/model/ILabel.d.ts +0 -4
  80. package/dist/types/data-sdk/src/model/ILabeledPolygon.d.ts +0 -4
  81. package/dist/types/data-sdk/src/model/ILabelingRequestData.d.ts +0 -8
  82. package/dist/types/data-sdk/src/model/ILabelingResponseData.d.ts +0 -4
  83. package/dist/types/data-sdk/src/model/ILocalization.d.ts +0 -14
  84. package/dist/types/data-sdk/src/model/ILocation.d.ts +0 -6
  85. package/dist/types/data-sdk/src/model/IMap.d.ts +0 -10
  86. package/dist/types/data-sdk/src/model/INumericAggregate.d.ts +0 -7
  87. package/dist/types/data-sdk/src/model/INumericSetAggregateMap.d.ts +0 -5
  88. package/dist/types/data-sdk/src/model/INumericSetEntry.d.ts +0 -5
  89. package/dist/types/data-sdk/src/model/IOdometry.d.ts +0 -7
  90. package/dist/types/data-sdk/src/model/IPath.d.ts +0 -5
  91. package/dist/types/data-sdk/src/model/IPointCloud.d.ts +0 -6
  92. package/dist/types/data-sdk/src/model/IPortForwardingSessionRecord.d.ts +0 -3
  93. package/dist/types/data-sdk/src/model/IQuaternion.d.ts +0 -6
  94. package/dist/types/data-sdk/src/model/IQuery.d.ts +0 -9
  95. package/dist/types/data-sdk/src/model/IRtcSessionRecord.d.ts +0 -9
  96. package/dist/types/data-sdk/src/model/IScopeFilter.d.ts +0 -6
  97. package/dist/types/data-sdk/src/model/ISelectionRequestData.d.ts +0 -6
  98. package/dist/types/data-sdk/src/model/ISelectionResponseData.d.ts +0 -3
  99. package/dist/types/data-sdk/src/model/IShare.d.ts +0 -16
  100. package/dist/types/data-sdk/src/model/ISheetParameters.d.ts +0 -5
  101. package/dist/types/data-sdk/src/model/ISpreadsheetIdRange.d.ts +0 -4
  102. package/dist/types/data-sdk/src/model/ISqlColumn.d.ts +0 -6
  103. package/dist/types/data-sdk/src/model/ISqlQuery.d.ts +0 -21
  104. package/dist/types/data-sdk/src/model/ISqlResult.d.ts +0 -12
  105. package/dist/types/data-sdk/src/model/ISqlRow.d.ts +0 -5
  106. package/dist/types/data-sdk/src/model/IStream.d.ts +0 -18
  107. package/dist/types/data-sdk/src/model/IStreamAggregateData.d.ts +0 -11
  108. package/dist/types/data-sdk/src/model/IStreamAggregateTypeMap.d.ts +0 -10
  109. package/dist/types/data-sdk/src/model/IStreamColumn.d.ts +0 -7
  110. package/dist/types/data-sdk/src/model/IStreamCurrentValue.d.ts +0 -13
  111. package/dist/types/data-sdk/src/model/IStreamData.d.ts +0 -11
  112. package/dist/types/data-sdk/src/model/IStreamTypeMap.d.ts +0 -27
  113. package/dist/types/data-sdk/src/model/ISystemEvent.d.ts +0 -3
  114. package/dist/types/data-sdk/src/model/ITagParameters.d.ts +0 -3
  115. package/dist/types/data-sdk/src/model/ITagSets.d.ts +0 -3
  116. package/dist/types/data-sdk/src/model/ITaggedUsers.d.ts +0 -4
  117. package/dist/types/data-sdk/src/model/ITags.d.ts +0 -3
  118. package/dist/types/data-sdk/src/model/ITaskReportColumn.d.ts +0 -7
  119. package/dist/types/data-sdk/src/model/ITeleopRequestData.d.ts +0 -3
  120. package/dist/types/data-sdk/src/model/ITeleopResponseData.d.ts +0 -4
  121. package/dist/types/data-sdk/src/model/ITeleopSessionRecord.d.ts +0 -3
  122. package/dist/types/data-sdk/src/model/ITransform.d.ts +0 -6
  123. package/dist/types/data-sdk/src/model/ITransformNode.d.ts +0 -7
  124. package/dist/types/data-sdk/src/model/ITriggeredEvent.d.ts +0 -10
  125. package/dist/types/data-sdk/src/model/ITwist.d.ts +0 -5
  126. package/dist/types/data-sdk/src/model/IUserParameters.d.ts +0 -4
  127. package/dist/types/data-sdk/src/model/IVector3.d.ts +0 -5
  128. package/dist/types/data-sdk/src/model/IVideo.d.ts +0 -7
  129. package/dist/types/data-sdk/src/model/IView.d.ts +0 -15
  130. package/dist/types/data-sdk/src/model/InterventionType.d.ts +0 -2
  131. package/dist/types/data-sdk/src/model/IsoDate.d.ts +0 -1
  132. package/dist/types/data-sdk/src/model/JsonSchema.d.ts +0 -39
  133. package/dist/types/data-sdk/src/model/Severity.d.ts +0 -2
  134. package/dist/types/data-sdk/src/model/SortOrder.d.ts +0 -1
  135. package/dist/types/data-sdk/src/model/StreamType.d.ts +0 -2
  136. package/dist/types/data-sdk/src/model/Timestamp.d.ts +0 -1
  137. package/dist/types/data-sdk/src/model/Uuid.d.ts +0 -1
  138. package/dist/types/data-sdk/src/model/VideoMimeType.d.ts +0 -2
  139. package/dist/types/data-sdk/src/model/accessLevels.d.ts +0 -1
  140. package/dist/types/data-sdk/src/model/aggregateLevels.d.ts +0 -2
  141. package/dist/types/data-sdk/src/model/analyticsAggregteTypes.d.ts +0 -1
  142. package/dist/types/data-sdk/src/model/analyticsChartTypes.d.ts +0 -1
  143. package/dist/types/data-sdk/src/model/annotationTypes.d.ts +0 -1
  144. package/dist/types/data-sdk/src/model/deviceTypes.d.ts +0 -1
  145. package/dist/types/data-sdk/src/model/eventTypes.d.ts +0 -1
  146. package/dist/types/data-sdk/src/model/healthStatuses.d.ts +0 -1
  147. package/dist/types/data-sdk/src/model/interventionTypes.d.ts +0 -1
  148. package/dist/types/data-sdk/src/model/severities.d.ts +0 -1
  149. package/dist/types/data-sdk/src/model/videoMimeTypes.d.ts +0 -1
  150. package/dist/types/data-sdk/src/utils/aggregateFunctionUtils.d.ts +0 -28
  151. package/dist/types/data-sdk/src/utils/index.d.ts +0 -4
  152. package/dist/types/data-sdk/src/utils/numericAggregateUtils.d.ts +0 -24
  153. package/dist/types/data-sdk/src/utils/serializeHash.d.ts +0 -2
  154. package/dist/types/data-sdk/src/utils/timeout.d.ts +0 -1
package/package.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "require": "./dist/data-sdk.umd.js"
19
19
  }
20
20
  },
21
- "version": "0.0.139",
21
+ "version": "0.0.141",
22
22
  "scripts": {
23
23
  "dev": "vite --port 9146",
24
24
  "build": "tsc && vite build",
@@ -33,11 +33,12 @@
33
33
  "@types/node": "^18.15.11",
34
34
  "typedoc": "^0.22.13",
35
35
  "typescript": "^4.9.3",
36
- "vite": "^4.1.0"
36
+ "vite": "^4.1.0",
37
+ "grpc-web": "1.2.1"
37
38
  },
38
39
  "types": "./dist/types/data-sdk/src/main.d.ts",
39
40
  "dependencies": {
40
- "@formant/realtime-sdk": "^0.0.19",
41
+ "@formant/realtime-sdk": "0.0.20",
41
42
  "date-fns": "^2.29.3"
42
43
  }
43
44
  }
@@ -1,2 +0,0 @@
1
- export type BrowserType = "Firefox" | "Chrome" | "Edge" | "Safari" | "IE" | "Other";
2
- export declare function browser(): BrowserType;
@@ -1,3 +0,0 @@
1
- export declare function defined<T>(value: T | undefined, errorMessage?: string): T;
2
- export declare function notNull<T>(value: T | null, errorMessage?: string): T;
3
- export declare function definedAndNotNull<T>(value: T | undefined | null, errorMessage?: string): T;
@@ -1 +0,0 @@
1
- export declare function delay(ms: number): Promise<unknown>;
@@ -1,10 +0,0 @@
1
- export declare const duration: {
2
- readonly millisecond: 1;
3
- readonly second: 1000;
4
- readonly minute: number;
5
- readonly hour: number;
6
- readonly day: number;
7
- readonly week: number;
8
- readonly month: number;
9
- readonly year: number;
10
- };
@@ -1,5 +0,0 @@
1
- /**
2
- * Used to fire-and-forget a promise.
3
- * This is useful as a function wrapper to suppress floating promise warnings.
4
- */
5
- export declare function fork<T>(_: Promise<T>): void;
@@ -1 +0,0 @@
1
- export declare function stringToArrayBuffer(input: string): Uint8Array;
@@ -1,131 +0,0 @@
1
- import { IStreamData, StreamType } from "./main";
2
- import { JsonSchema } from "./model/JsonSchema";
3
- export type AppMessage = {
4
- type: "go_to_time";
5
- time: number;
6
- } | {
7
- type: "prompt";
8
- promptId: string;
9
- schema: JsonSchema;
10
- okText?: string;
11
- cancelText?: string;
12
- } | {
13
- type: "go_to_device";
14
- deviceId: string;
15
- } | {
16
- type: "request_module_data";
17
- module: string;
18
- } | {
19
- type: "show_message";
20
- message: string;
21
- } | {
22
- type: "refresh_auth_token";
23
- module: string;
24
- } | {
25
- type: "set_module_data_time_range";
26
- module: string;
27
- before: number;
28
- after: number;
29
- } | {
30
- type: "setup_module_menus";
31
- module: string;
32
- menus: {
33
- label: string;
34
- }[];
35
- } | {
36
- type: "send_channel_data";
37
- channel: string;
38
- source: string;
39
- data: any;
40
- } | {
41
- type: "request_devices";
42
- };
43
- export type ModuleConfigurationMessage = {
44
- type: "module_configuration";
45
- temporary: boolean;
46
- configuration: string;
47
- };
48
- export type EmbeddedAppMessage = {
49
- type: "module_menu_item_clicked";
50
- menu: string;
51
- } | {
52
- type: "auth_token";
53
- token: string;
54
- } | {
55
- type: "module_data";
56
- streams: {
57
- [x: string]: any;
58
- };
59
- time: number;
60
- queryRange: {
61
- start: number;
62
- end: number;
63
- };
64
- } | {
65
- type: "channel_data";
66
- channel: string;
67
- source: string;
68
- data: any;
69
- } | {
70
- type: "prompt_response";
71
- promptId: string;
72
- data: any;
73
- } | ModuleConfigurationMessage;
74
- export interface ModuleData {
75
- queryRange: QueryRange;
76
- time: number;
77
- streams: {
78
- [stream_name: string]: Stream;
79
- };
80
- }
81
- export interface QueryRange {
82
- start: number;
83
- end: number;
84
- }
85
- export interface Stream {
86
- data: StreamData[];
87
- loading: boolean;
88
- tooMuchData: boolean;
89
- type: string;
90
- }
91
- export interface StreamData {
92
- points: DataPoint[];
93
- deviceId: string;
94
- agentId: string;
95
- name: string;
96
- tags: {
97
- [key: string]: string;
98
- };
99
- type: string;
100
- }
101
- export type DataPoint = [number, any];
102
- export declare class App {
103
- private static sendAppMessage;
104
- static getCurrentModuleContext(): string | null;
105
- static getCurrentModuleConfiguration(): Promise<string | undefined>;
106
- static isModule(): boolean;
107
- static goToTime(date: Date): void;
108
- static goToDevice(deviceId: string): void;
109
- static showMessage(message: string): void;
110
- static requestModuleData(): void;
111
- static setModuleDateTimeRange(beforeInMilliseconds: number, afterInMilliseconds?: number): void;
112
- static refreshAuthToken(): void;
113
- static sendChannelData(channel: string, data: any): void;
114
- static setupModuleMenus(menus: {
115
- label: string;
116
- }[]): void;
117
- static addMenuListener(handler: (label: string) => void): void;
118
- static addAccessTokenRefreshListener(handler: (token: string) => void): void;
119
- static addModuleDataListener(handler: (data: ModuleData) => void): void;
120
- static addStreamListener(streamNames: string[], streamTypes: StreamType[], handler: (response: IStreamData[] | "too much data" | undefined) => void): () => void;
121
- static addModuleConfigurationListener(handler: (event: ModuleConfigurationMessage) => void): void;
122
- static addChannelDataListener(channel: string, handler: (e: {
123
- source: string;
124
- data: any;
125
- }) => void): void;
126
- static requestOverviewDevices(handler: (data: any) => void): void;
127
- static prompt(schema: JsonSchema, options?: {
128
- okText?: string;
129
- cancelText?: string;
130
- }): Promise<any>;
131
- }
@@ -1,22 +0,0 @@
1
- import { IRtcStreamMessage } from "@formant/realtime-sdk";
2
- import { Device, RealtimeDataStream } from "./Device";
3
- export declare class AudioPlayer {
4
- private device;
5
- private stream;
6
- private muted;
7
- play(): Promise<void>;
8
- pause(): Promise<void>;
9
- private hasReceivedData;
10
- private audioContext;
11
- private chunks;
12
- private isPlaying;
13
- private startTime;
14
- private lastChunkOffset;
15
- private bufferSize;
16
- constructor(device: Device, stream: RealtimeDataStream);
17
- destroy(): void;
18
- receive: (msg: IRtcStreamMessage) => Promise<void>;
19
- private scheduleChunk;
20
- private createChunk;
21
- private changeAudioWireFormat;
22
- }
@@ -1,52 +0,0 @@
1
- export interface User {
2
- firstName: string;
3
- lastName: string;
4
- email: string;
5
- organizationId: string;
6
- id: string;
7
- }
8
- export interface IAuthentication {
9
- accessToken: string;
10
- organizationId: string;
11
- refreshToken: string;
12
- userId: string;
13
- }
14
- export interface IConfirmForgotPasswordRequest {
15
- email: string;
16
- confirmationCode: string;
17
- newPassword: string;
18
- }
19
- export interface IRespondToNewPasswordRequiredChallengeRequest {
20
- userId: string;
21
- session: string;
22
- newPassword: string;
23
- }
24
- export declare class Authentication {
25
- static token: string | undefined;
26
- static refreshToken: string | undefined;
27
- static currentUser: User | undefined;
28
- static currentOrganization: string | undefined;
29
- static isShareToken: boolean;
30
- static defaultDeviceId: string | undefined;
31
- static waitingForAuth: ((result: boolean) => void)[];
32
- static login(email: string, password: string): Promise<IAuthentication | Error>;
33
- static loginWithToken(token: string, refreshToken?: string): Promise<void>;
34
- static isAuthenticated(): boolean;
35
- static getCurrentUser(): User | undefined;
36
- static waitTilAuthenticated(): Promise<boolean>;
37
- static listenForRefresh(): Promise<void>;
38
- static forgotPassword(email: string): Promise<void>;
39
- /**
40
- * @example
41
- * // Body
42
- * await Authentication.confirmForgotPassword({
43
- * email: "joe@gmail.com"
44
- * confirmationCode: "1",
45
- * newPassword: "NewPassword"
46
- * });
47
- */
48
- static confirmForgotPassword(request: IConfirmForgotPasswordRequest): Promise<boolean>;
49
- static respondToNewPasswordRequiredChallenge(request: IRespondToNewPasswordRequiredChallengeRequest): Promise<any>;
50
- static loginWithGoogle(token: string): Promise<any>;
51
- static refresh(token: string): Promise<void>;
52
- }
@@ -1,18 +0,0 @@
1
- export interface CaptureSession {
2
- deviceId: string;
3
- streamName: string;
4
- tags: {};
5
- expiration: string;
6
- organizationId: string;
7
- userId: string;
8
- code: string;
9
- id: string;
10
- createdAt: string;
11
- updatedAt: string;
12
- }
13
- export declare class CaptureStream {
14
- captureSession: CaptureSession;
15
- token: string | undefined;
16
- constructor(captureSession: CaptureSession);
17
- ingestJSON(value: {}): Promise<void>;
18
- }
@@ -1,29 +0,0 @@
1
- export type DataChannelStringListener = (message: string) => void;
2
- export type DataChannelBinaryListener = (message: Uint8Array) => void;
3
- export type DataChannelListener = () => void;
4
- export type DataChannelErrorListener = (ev: Event) => void;
5
- export declare class DataChannel {
6
- private dataChannel;
7
- ready: boolean;
8
- listeners: DataChannelStringListener[];
9
- openListeners: DataChannelListener[];
10
- closeListeners: DataChannelListener[];
11
- errorListeners: DataChannelErrorListener[];
12
- binaryListeners: DataChannelBinaryListener[];
13
- error: string | undefined;
14
- decoder: TextDecoder;
15
- constructor(dataChannel: RTCDataChannel);
16
- addOpenListener(listener: DataChannelListener): void;
17
- removeOpenListener(listener: DataChannelListener): void;
18
- addCloseListener(listener: DataChannelListener): void;
19
- removeCloseListener(listener: DataChannelListener): void;
20
- addErrorListener(listener: DataChannelErrorListener): void;
21
- removeErrorListener(listener: DataChannelErrorListener): void;
22
- waitTilReady(): Promise<boolean>;
23
- send(data: string): void;
24
- sendBinary(data: Uint8Array): void;
25
- addListener(listener: DataChannelStringListener): void;
26
- removeListener(listener: DataChannelStringListener): void;
27
- addBinaryListener(listener: DataChannelBinaryListener): void;
28
- removeBinaryListener(listener: DataChannelBinaryListener): void;
29
- }
@@ -1,152 +0,0 @@
1
- import { IRtcSendConfiguration, IRtcStreamMessage, IRtcStreamPayload, RtcClient, RtcClientV1 } from "@formant/realtime-sdk";
2
- import { DataChannel } from "./DataChannel";
3
- import { CaptureStream } from "./CaptureStream";
4
- import { Manipulator } from "./Manipulator";
5
- import { TextRequestDataChannel, BinaryRequestDataChannel } from "./RequestDataChannel";
6
- import { InterventionType } from "./main";
7
- import { IInterventionTypeMap } from "./main";
8
- import { IInterventionResponse } from "./main";
9
- import { RtcStreamType } from "@formant/realtime-sdk/dist/model/RtcStreamType";
10
- import { IEventQuery } from "./main";
11
- import { AggregateLevel } from "./main";
12
- import { EventType } from "./main";
13
- import { IShare } from "./model/IShare";
14
- export interface ConfigurationDocument {
15
- urdfFiles: string[];
16
- telemetry?: {
17
- streams?: {
18
- name: string;
19
- disabled?: boolean;
20
- onDemand?: boolean;
21
- }[];
22
- };
23
- teleop?: {
24
- customStreams?: {
25
- name: string;
26
- rtcStreamType: RtcStreamType;
27
- }[];
28
- hardwareStreams?: {
29
- name: string;
30
- rtcStreamType: RtcStreamType;
31
- }[];
32
- rosStreams?: {
33
- rtcStreamType: RtcStreamType;
34
- topicName: string;
35
- topicType: string;
36
- }[];
37
- };
38
- }
39
- export interface Command {
40
- id: string;
41
- name: string;
42
- command: string;
43
- description: string;
44
- parameterEnabled: true;
45
- parameterValue: string | null;
46
- parameterMeta?: {
47
- topic?: string;
48
- };
49
- }
50
- export interface IJointState {
51
- name: string[];
52
- position: number[];
53
- velocity?: number[];
54
- effort?: number[];
55
- }
56
- export interface TelemetryStream {
57
- name: string;
58
- onDemand: boolean;
59
- }
60
- export type RealtimeMessage = {
61
- header: {
62
- created: number;
63
- stream: {
64
- entityId: string;
65
- streamName: string;
66
- streamType: RtcStreamType;
67
- };
68
- };
69
- payload: IRtcStreamPayload;
70
- };
71
- export type RealtimeListener = (peerId: string, message: RealtimeMessage) => void;
72
- export type RealtimeAudioStream = {
73
- name: string;
74
- };
75
- export type RealtimeVideoStream = {
76
- name: string;
77
- };
78
- export type RealtimeDataStream = {
79
- name: string;
80
- };
81
- export declare const SessionType: {
82
- Teleop: number;
83
- Observe: number;
84
- };
85
- export interface IRealtimeDevice {
86
- startRealtimeConnection(sessionType?: number): Promise<void>;
87
- startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
88
- stopListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
89
- addRealtimeListener(listener: RealtimeListener): void;
90
- removeRealtimeListener(listener: RealtimeListener): void;
91
- createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>;
92
- }
93
- export declare class Device implements IRealtimeDevice {
94
- id: string;
95
- name: string;
96
- private organizationId;
97
- rtcClient: RtcClient | RtcClientV1 | undefined;
98
- remoteDevicePeerId: string | undefined;
99
- realtimeListeners: RealtimeListener[];
100
- constructor(id: string, name: string, organizationId: string);
101
- getLatestTelemetry(): Promise<any>;
102
- getConfiguration(): Promise<ConfigurationDocument>;
103
- getFileUrl(fileId: string): Promise<string[]>;
104
- private handleMessage;
105
- getRealtimeStatus(): "disconnected" | "connecting" | "connected";
106
- getRealtimePing(): number | undefined;
107
- startRealtimeConnection(sessionType?: number): Promise<void>;
108
- sendRealtimeMessage(message: IRtcStreamMessage, config?: IRtcSendConfiguration): Promise<void>;
109
- addRealtimeListener(listener: RealtimeListener): void;
110
- removeRealtimeListener(listener: RealtimeListener): void;
111
- getRealtimeAudioStreams(): Promise<RealtimeAudioStream[]>;
112
- getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>;
113
- getRealtimeManipulators(): Promise<Manipulator[]>;
114
- startListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
115
- stopListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
116
- startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
117
- stopListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
118
- enableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
119
- changeStreamAudioType(streamName: string, newFormat: "wav" | "opus"): Promise<void>;
120
- disableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
121
- getRemotePeer(): Promise<import("@formant/realtime-sdk/dist/model/IRtcPeer").IRtcPeer>;
122
- stopRealtimeConnection(): Promise<void>;
123
- isInRealtimeSession(): Promise<boolean>;
124
- getAvailableCommands(): Promise<Command[]>;
125
- sendCommand(name: string, data?: string, time?: Date, metadata?: {}): Promise<void>;
126
- createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>;
127
- createCustomRequestDataChannel(channelName: string, timeout?: number): TextRequestDataChannel;
128
- createCustomBinaryRequestDataChannel(channelName: string, timeout?: number): BinaryRequestDataChannel;
129
- createCaptureStream(streamName: string): Promise<CaptureStream>;
130
- getTelemetry(streamNameOrStreamNames: string | string[], start: Date, end: Date, tags?: {
131
- [key in string]: string[];
132
- }): Promise<import("./Fleet").TelemetryResult[]>;
133
- getTelemetryStreams(): Promise<TelemetryStream[]>;
134
- createInterventionRequest<T extends InterventionType>(message: string, interventionType: InterventionType, interventionRequest: IInterventionTypeMap[T]["request"], tags?: {
135
- [key in string]: string[];
136
- }): Promise<(id: string) => IInterventionTypeMap[T]["response"]>;
137
- addInterventionResponse<T extends InterventionType>(interventionId: string, interventionType: InterventionType, data: IInterventionTypeMap[T]["response"]): Promise<IInterventionResponse>;
138
- getAnnotationCount(query: IEventQuery, tagKey: string): Promise<{
139
- [key: string]: number;
140
- }>;
141
- getAnnotationCountByIntervals(query: IEventQuery, tagKey: string, aggregate: AggregateLevel): Promise<{
142
- date: string;
143
- annotations: {
144
- [key: string]: number;
145
- };
146
- }[]>;
147
- eventsCounter(eventTypes: EventType[], timeFrame: AggregateLevel, range: number, time: number, query?: IEventQuery): Promise<{
148
- date: string;
149
- events: import("./main").IEvent[];
150
- }[]>;
151
- createShareLink(share: IShare, view: string): Promise<string>;
152
- }
@@ -1,204 +0,0 @@
1
- import { IRtcPeer } from "@formant/realtime-sdk/dist/model/IRtcPeer";
2
- import { Device } from "./Device";
3
- import { IEvent } from "./model/IEvent";
4
- import { IEventQuery } from "./model/IEventQuery";
5
- import { IQuery } from "./model/IQuery";
6
- import { IStreamAggregateData } from "./model/IStreamAggregateData";
7
- import { IStreamData } from "./model/IStreamData";
8
- import { PeerDevice } from "./PeerDevice";
9
- import { IDeviceQuery } from "./model/IDeviceQuery";
10
- import { IStream } from "./model/IStream";
11
- import { IView } from "./model/IView";
12
- import { EventType, AggregateLevel, IShare } from "./main";
13
- import { IAnalyticsModule } from "./model/IAnalyticsModule";
14
- import { IStreamColumn } from "./model/IStreamColumn";
15
- import { ITaskReportColumn } from "./model/ITaskReportColumn";
16
- import { ISqlQuery } from "./model/ISqlQuery";
17
- import { ISqlResult } from "./model/ISqlResult";
18
- export interface TelemetryResult {
19
- deviceId: string;
20
- name: string;
21
- points: [number, any][];
22
- tags: {
23
- [key in string]: string | number;
24
- };
25
- type: string;
26
- }
27
- export declare class Fleet {
28
- static defaultDeviceId: string | undefined;
29
- static knownContext: WeakRef<Device>[];
30
- static setDefaultDevice(deviceId: string): Promise<void>;
31
- static getCurrentDevice(): Promise<Device>;
32
- static getPeerDevice(url: string): Promise<PeerDevice>;
33
- static getDevice(deviceId: string): Promise<Device>;
34
- static getDevices(): Promise<Device[]>;
35
- static queryDevices(query: IDeviceQuery): Promise<Device[]>;
36
- static getOnlineDevices(): Promise<Device[]>;
37
- static getPeers(): Promise<IRtcPeer[]>;
38
- static getRealtimeSessions(): Promise<{
39
- [key in string]: string[];
40
- }>;
41
- static getRealtimeDevices(): Promise<Device[]>;
42
- static getLatestTelemetry(deviceIdOrDeviceIds?: string | string[]): Promise<any>;
43
- static getTelemetry(deviceIdOrDeviceIds: string | string[], streamNameOrStreamNames: string | string[], start: Date, end: Date, tags?: {
44
- [key in string]: string[];
45
- }): Promise<TelemetryResult[]>;
46
- static getFileUrl(uuid: string): Promise<string>;
47
- static queryTelemetry(query: IQuery): Promise<IStreamData<keyof import("./main").IStreamTypeMap>[]>;
48
- static aggregateTelemetry(query: IQuery): Promise<IStreamAggregateData<keyof import("./main").IStreamTypeMap>[]>;
49
- static queryEvents(query: IEventQuery): Promise<IEvent[]>;
50
- static getEvent(uuid: string): Promise<IEvent>;
51
- static getInterventions(): Promise<IEvent[]>;
52
- static getCurrentGroup(): Promise<Device[] | undefined>;
53
- static getAnnotationCount(query: IEventQuery, tagKey: string): Promise<{
54
- [key: string]: number;
55
- }>;
56
- static getAnnotationCountByIntervals(query: IEventQuery, tagKey: string, aggregate: AggregateLevel): Promise<{
57
- date: string;
58
- annotations: {
59
- [key: string]: number;
60
- };
61
- }[]>;
62
- static getStreams(): Promise<IStream[]>;
63
- static patchStream(stream: IStream): Promise<IStream>;
64
- static getViews(): Promise<IView[]>;
65
- static patchView(view: IView): Promise<IView>;
66
- static eventsCounter(eventTypes: EventType[], timeFrame: AggregateLevel, range: number, time: number, query?: IEventQuery): Promise<{
67
- date: string;
68
- events: IEvent[];
69
- }[]>;
70
- static getAnalyticsModules(): Promise<IAnalyticsModule>;
71
- /**
72
- * retrieves a list of all available data streams that can be used for running analytics.
73
- * This function takes no arguments and returns a list of stream names that can be used for analyzing data.
74
- * @example
75
- * // Returns
76
- * [
77
- * {
78
- * streamName: "$.agent.health",
79
- streamType : "health"
80
- },
81
- {
82
- * streamName: "up.hours",
83
- streamType : "numeric"
84
- }
85
- ]
86
- */
87
- static getAnalyticStreams(): Promise<IStreamColumn[]>;
88
- /**
89
- * retrieves a list of all available tables that can be used to create task reports.
90
- * This function takes no arguments and returns a list of table names that can be used for creating task reports.
91
- * @returns List all available tables
92
- * @example
93
- * // Returns
94
- *[
95
- * {
96
- * name: "",
97
- * tableName: "TASK_REPORTS_CLEANING_MODE",
98
- * columns: [
99
- * {
100
- * name: "TYPE",
101
- * isNullable: true,
102
- * dataType: "string",
103
- * tableName: "custom"
104
- * }
105
- * ]
106
- * }
107
- *]
108
- */
109
- static getTaskReportTables(): Promise<ITaskReportColumn[]>;
110
- /**
111
- *Retrieves all stream rows
112
- * @example
113
- * // Body
114
- * const analytics = await Fleet.queryAnalytics({
115
- * aggregateLevel: "day",
116
- * orderByColumn: "TIMESTAMP",
117
- * streamColumns: [
118
- * {
119
- * streamName: "consumables_residual_percentage",
120
- * streamType: "numeric set",
121
- * },
122
- * ],
123
- * });
124
- * //Returns
125
- * {
126
- * aggregates: [],
127
- * columns: [
128
- * {
129
- * name: 'TIMESTAMP',
130
- * isNullable: true,
131
- * dataType: 'string',
132
- * tableName: 'NUMERIC_SET_MAIN'
133
- * }
134
- * ],
135
- * items: [
136
- * {
137
- * axisLabel: "suction_blade",
138
- * name: "consumables_residual_percentage",
139
- * tableName: "NUMERIC_SET_TEST",
140
- * time: "2020-04-20T08:00:00.000Z",
141
- * type: "numeric set",
142
- * unitLabel: "percent"
143
- * }
144
- * ],
145
- * rowCount: 14,
146
- * rows: []
147
- * sqlText: "SELECT dateadd(day, dayofweek(TIMESTAMP), to_timestamp_tz('4/20/2020')) AS TIMESTAMP, SUM(VALUE)"
148
- * }
149
- */
150
- static queryAnalytics(query: ISqlQuery): Promise<ISqlResult>;
151
- /**
152
- * Retrieves all rows
153
- * sqlQuery is required
154
- * @param query
155
- * @returns
156
- */
157
- static getAnalyticsRows(query: ISqlQuery): Promise<any>;
158
- /**
159
- * @param taskColumns is required
160
- * @returns
161
- * All task reports
162
- * @example
163
- * // Body
164
- * const tasks = await Fleet.getTaskReports({
165
- * taskColumns: [
166
- * {
167
- * columns: [
168
- * {
169
- * dataType: "string",
170
- * isNullable: true,
171
- * name: "TYPE",
172
- * tableName: "custom",
173
- * },
174
- * ],
175
- * name: "DURATION_SECONDS",
176
- * tableName: "TASK_REPORTS_CLEANING_MODE",
177
- * yAxis: "DURATION_SECONDS",
178
- * },
179
- * ],
180
- * });
181
- */
182
- static getTaskReportRows(query: ISqlQuery): Promise<any>;
183
- /**
184
- * @param scope is required
185
- * @param time is required
186
- * @param view View name
187
- * @returns
188
- * Share link
189
- * @example
190
- * // Body
191
- * const link = await Fleet.createShareLink({
192
- * delegateTeleop: false
193
- * message: "See bot in action",
194
- * scope: {
195
- * deviceIds: ["d64520a6-a308-4a59-9267-b7f8a7bfc7ab"],
196
- * start: "2023-04-04T19:51:47.125Z",
197
- * end: "2023-04-04T20:51:47.125Z"
198
- * },
199
- * time: "2023-04-04T20:21:47.125Z",
200
- * userName: "User",
201
- * });
202
- */
203
- static createShareLink(share: IShare, view: string): Promise<string>;
204
- }
@@ -1,6 +0,0 @@
1
- export declare class KeyValue {
2
- static set(key: string, value: string): Promise<void>;
3
- static get(key: string): Promise<string>;
4
- static list(): Promise<string[]>;
5
- static delete(key: string): Promise<void>;
6
- }