@kvaser/canking-api 7.3.0 → 7.4.1

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 (713) hide show
  1. package/dist/controls/CanIdentifierControl.d.ts +32 -6
  2. package/dist/controls/CanKingDataProvider.d.ts +14 -19
  3. package/dist/controls/CheckboxControl.d.ts +11 -2
  4. package/dist/controls/ColorControl.d.ts +26 -0
  5. package/dist/controls/ExtensionWorkspaceViewProps.d.ts +8 -0
  6. package/dist/controls/InlineEditor.d.ts +2 -2
  7. package/dist/controls/LinIdentifierControl.d.ts +24 -4
  8. package/dist/controls/SelectMessageDialog.d.ts +32 -3
  9. package/dist/controls/SelectSignalDialog.d.ts +102 -1
  10. package/dist/controls/SelectSignalsControl.d.ts +37 -4
  11. package/dist/controls/SizedBox.d.ts +1 -0
  12. package/dist/controls/TableControl.d.ts +2 -3
  13. package/dist/controls/ToolbarControl.d.ts +4 -2
  14. package/dist/controls/index.d.ts +3 -0
  15. package/dist/controls.js +1 -1
  16. package/dist/controls.mjs +2257 -1769
  17. package/dist/grpc.js +1 -1
  18. package/dist/grpc.mjs +196 -168
  19. package/dist/hooks/index.d.ts +382 -27
  20. package/dist/hooks.js +1 -1
  21. package/dist/hooks.mjs +48 -30
  22. package/dist/icons/index.d.ts +36 -0
  23. package/dist/icons.js +1 -1
  24. package/dist/icons.mjs +927 -755
  25. package/dist/index.d.ts +0 -2
  26. package/dist/index.js +1 -1
  27. package/dist/index.mjs +1167 -600
  28. package/dist/ipc/index.d.ts +31 -3
  29. package/dist/ipc.js +1 -1
  30. package/dist/ipc.mjs +132 -104
  31. package/dist/models/Point.d.ts +4 -0
  32. package/dist/models/deep_equal.d.ts +7 -0
  33. package/dist/models/index.d.ts +85 -12
  34. package/dist/models/json_utilities.d.ts +16 -0
  35. package/dist/models.js +1 -1
  36. package/dist/models.mjs +762 -289
  37. package/dist/protos/app_params.d.ts +109 -62
  38. package/dist/protos/app_service.d.ts +81 -50
  39. package/dist/protos/common_params.d.ts +4 -1
  40. package/dist/protos/device_params.d.ts +82 -27
  41. package/dist/protos/frame_params.d.ts +92 -9
  42. package/dist/protos/measurement_params.d.ts +229 -47
  43. package/dist/protos/measurement_service.d.ts +84 -58
  44. package/dist/protos/measurement_settings.d.ts +156 -6
  45. package/dist/protos/signal_params.d.ts +20 -0
  46. package/dist/protos/status_params.d.ts +30 -0
  47. package/dist/status_params.js +1 -1
  48. package/dist/status_params.mjs +8709 -1825
  49. package/doc/assets/hierarchy.js +1 -1
  50. package/doc/assets/navigation.js +1 -1
  51. package/doc/assets/search.js +1 -1
  52. package/doc/enums/models.AccessMode.html +5 -3
  53. package/doc/enums/models.CanChannelCap.html +2 -2
  54. package/doc/enums/models.CanConfigMode.html +16 -0
  55. package/doc/enums/models.CanFrameFlag.html +33 -2
  56. package/doc/enums/models.CanMessageFilterType.html +4 -2
  57. package/doc/enums/models.CanMode.html +7 -2
  58. package/doc/enums/{models.DeviceEvent.html → models.DecimalChar.html} +7 -5
  59. package/doc/enums/models.FileConflictAction.html +5 -2
  60. package/doc/enums/models.LinFrameFlag.html +11 -2
  61. package/doc/enums/models.LogFileFormat.html +4 -2
  62. package/doc/enums/models.LogLevel.html +2 -2
  63. package/doc/enums/models.LogReplayState.html +4 -2
  64. package/doc/enums/models.LoggerState.html +5 -2
  65. package/doc/enums/models.Separator.html +8 -0
  66. package/doc/enums/models.SignalEncoding.html +4 -2
  67. package/doc/enums/models.SignalType.html +2 -2
  68. package/doc/enums/models.SignalValueTriggerOperator.html +11 -2
  69. package/doc/enums/models.StatusLevel.html +5 -2
  70. package/doc/enums/models.TimeReference.html +8 -0
  71. package/doc/enums/models.TriggerOperator.html +4 -2
  72. package/doc/functions/controls.CanChannelSelectControl.html +2 -2
  73. package/doc/functions/controls.CanIdentifierControl.html +2 -2
  74. package/doc/functions/controls.CanIdentifierFrameControl.html +2 -2
  75. package/doc/functions/controls.CanIdentifierGeneratorControl.html +2 -2
  76. package/doc/functions/controls.CanIdentifierGeneratorSettingsControl.html +2 -2
  77. package/doc/functions/controls.CanKingDataProvider.html +2 -2
  78. package/doc/functions/controls.CheckboxControl.html +2 -2
  79. package/doc/functions/controls.ColorControl.html +4 -0
  80. package/doc/functions/controls.ColumnItemControl.html +2 -2
  81. package/doc/functions/controls.ContextMenu.html +2 -2
  82. package/doc/functions/controls.DropdownButton.html +2 -2
  83. package/doc/functions/controls.DropdownButtonTextItems.html +2 -2
  84. package/doc/functions/controls.DropdownPanel.html +2 -2
  85. package/doc/functions/controls.FormControlRow.html +2 -2
  86. package/doc/functions/controls.InlineEditor.html +2 -2
  87. package/doc/functions/controls.LinChannelSelectControl.html +2 -2
  88. package/doc/functions/controls.LinIdentifierControl.html +2 -2
  89. package/doc/functions/controls.LinIdentifierFrameControl.html +2 -2
  90. package/doc/functions/controls.LinIdentifierGeneratorControl.html +2 -2
  91. package/doc/functions/controls.LinIdentifierGeneratorSettingsControl.html +2 -2
  92. package/doc/functions/controls.NumberRangeControl.html +2 -2
  93. package/doc/functions/controls.RadioControl.html +2 -2
  94. package/doc/functions/controls.RadioGroupControl.html +2 -2
  95. package/doc/functions/controls.SectionControl.html +2 -2
  96. package/doc/functions/controls.SelectControl.html +2 -2
  97. package/doc/functions/controls.SelectMessageDialog.html +2 -2
  98. package/doc/functions/controls.SelectSignalDialog.html +2 -2
  99. package/doc/functions/controls.SelectSignalsControl.html +2 -0
  100. package/doc/functions/controls.TableControl.html +2 -2
  101. package/doc/functions/controls.TextControl.html +2 -2
  102. package/doc/functions/controls.ToolbarControl.html +2 -2
  103. package/doc/functions/controls.ValidateableTextControl.html +2 -2
  104. package/doc/functions/controls.useColumnItem.html +2 -2
  105. package/doc/functions/controls.useColumnItems.html +2 -2
  106. package/doc/functions/controls.useMessageDatabases.html +2 -2
  107. package/doc/functions/hooks.useAvailableProtocols.html +3 -0
  108. package/doc/functions/hooks.useDevices.html +2 -2
  109. package/doc/functions/hooks.useFixedPositionModeMeasurementData.html +3 -3
  110. package/doc/functions/hooks.useIsOnline.html +2 -2
  111. package/doc/functions/hooks.useLanguage.html +2 -2
  112. package/doc/functions/hooks.useLocalizedStrings.html +2 -2
  113. package/doc/functions/hooks.useLogMessages.html +2 -2
  114. package/doc/functions/hooks.useMaxDataBytes.html +2 -2
  115. package/doc/functions/hooks.useMeasurementSetup.html +2 -2
  116. package/doc/functions/hooks.useMeasurementStatus.html +2 -2
  117. package/doc/functions/hooks.useMessageData.html +8 -4
  118. package/doc/functions/hooks.useMessageLogFileFormats.html +3 -2
  119. package/doc/functions/hooks.useNewMeasurementData.html +2 -2
  120. package/doc/functions/hooks.useNodeStatus.html +2 -2
  121. package/doc/functions/hooks.useNumericRadix.html +2 -2
  122. package/doc/functions/hooks.useOnlineStatus.html +2 -2
  123. package/doc/functions/hooks.useOnlineStatusSync.html +7 -0
  124. package/doc/functions/hooks.useOverallStatusLevel.html +2 -2
  125. package/doc/functions/hooks.useProjectData.html +11 -4
  126. package/doc/functions/hooks.useProjectDataSlice.html +13 -0
  127. package/doc/functions/hooks.useRecentProjectFiles.html +2 -2
  128. package/doc/functions/hooks.useRunningPeriodicTransmissions.html +2 -2
  129. package/doc/functions/hooks.useScrollModeMeasurementData.html +3 -3
  130. package/doc/functions/hooks.useSessionData.html +13 -4
  131. package/doc/functions/hooks.useSessionDataSlice.html +14 -0
  132. package/doc/functions/hooks.useSignalData.html +8 -4
  133. package/doc/functions/hooks.useSignalDataEnvelopes.html +11 -0
  134. package/doc/functions/hooks.useSignalLogFileFormats.html +3 -2
  135. package/doc/functions/hooks.useUndo.html +7 -0
  136. package/doc/functions/hooks.useUndoRef.html +7 -0
  137. package/doc/functions/hooks.useUndoSessionDataSlice.html +9 -0
  138. package/doc/functions/hooks.useUserSettings.html +2 -2
  139. package/doc/functions/hooks.useWorkspacePaneWithId.html +2 -2
  140. package/doc/functions/ipc.addDataProcessor.html +2 -2
  141. package/doc/functions/ipc.addSource.html +2 -2
  142. package/doc/functions/ipc.addTarget.html +2 -2
  143. package/doc/functions/ipc.clearLinMessage.html +2 -2
  144. package/doc/functions/ipc.connectNodes.html +2 -2
  145. package/doc/functions/ipc.deleteDataProcessor.html +2 -2
  146. package/doc/functions/ipc.deleteSource.html +2 -2
  147. package/doc/functions/ipc.deleteTarget.html +2 -2
  148. package/doc/functions/ipc.disableNode.html +2 -2
  149. package/doc/functions/ipc.disconnectNodes.html +2 -2
  150. package/doc/functions/ipc.enableNode.html +2 -2
  151. package/doc/functions/ipc.getFirstAndLatestTimestamp.html +4 -0
  152. package/doc/functions/ipc.getFirstTimestamp.html +3 -0
  153. package/doc/functions/ipc.getFrameDefinitions.html +2 -2
  154. package/doc/functions/ipc.getLatestTimestamp.html +3 -0
  155. package/doc/functions/ipc.getLogger.html +2 -2
  156. package/doc/functions/ipc.getMessageDataBeforeTimestamp.html +7 -0
  157. package/doc/functions/ipc.getMessageLogFileFormats.html +3 -3
  158. package/doc/functions/ipc.getSignalLogFileFormats.html +3 -3
  159. package/doc/functions/ipc.requestLinMessage.html +2 -2
  160. package/doc/functions/ipc.sendCanMessage.html +2 -2
  161. package/doc/functions/ipc.sendMessage.html +2 -2
  162. package/doc/functions/ipc.showMessageBox.html +2 -2
  163. package/doc/functions/ipc.showQuestionBox.html +2 -2
  164. package/doc/functions/ipc.startLogReplay.html +2 -2
  165. package/doc/functions/ipc.startMeasurement.html +2 -2
  166. package/doc/functions/ipc.startPeriodicTransmission.html +2 -2
  167. package/doc/functions/ipc.stopLogReplay.html +2 -2
  168. package/doc/functions/ipc.stopMeasurement.html +2 -2
  169. package/doc/functions/ipc.stopPeriodicTransmission.html +2 -2
  170. package/doc/functions/ipc.updateDataProcessor.html +2 -2
  171. package/doc/functions/ipc.updateLinMessage.html +2 -2
  172. package/doc/functions/ipc.updatePeriodicTransmission.html +2 -2
  173. package/doc/functions/ipc.updateSource.html +2 -2
  174. package/doc/functions/ipc.updateTarget.html +2 -2
  175. package/doc/functions/models.decimalToFixed.html +5 -0
  176. package/doc/functions/models.decimalToHex.html +6 -0
  177. package/doc/functions/models.deep_equal.html +5 -0
  178. package/doc/functions/models.deserializeFrame.html +4 -0
  179. package/doc/functions/models.jsonReplacer.html +6 -0
  180. package/doc/functions/models.jsonReviver.html +6 -0
  181. package/doc/functions/models.longToNumber.html +4 -0
  182. package/doc/functions/models.serializeFrame.html +4 -0
  183. package/doc/hierarchy.html +1 -1
  184. package/doc/index.html +2 -2
  185. package/doc/interfaces/controls.ButtonGroupProps.html +2 -2
  186. package/doc/interfaces/controls.ButtonProps.html +2 -2
  187. package/doc/interfaces/controls.CanChannelSelectControlProps.html +2 -2
  188. package/doc/interfaces/controls.CanIdentifierControlProps.html +16 -7
  189. package/doc/interfaces/controls.CanIdentifierFrameControlProps.html +6 -3
  190. package/doc/interfaces/controls.CanIdentifierGeneratorControlProps.html +6 -3
  191. package/doc/interfaces/controls.CanIdentifierGeneratorSettingsControlProps.html +6 -3
  192. package/doc/interfaces/controls.CheckboxControlProps.html +8 -3
  193. package/doc/interfaces/controls.ContextMenuProps.html +2 -2
  194. package/doc/interfaces/controls.DropdownButtonChildrenProps.html +3 -3
  195. package/doc/interfaces/controls.DropdownButtonProps.html +2 -2
  196. package/doc/interfaces/controls.DropdownButtonTextItemsProps.html +3 -3
  197. package/doc/interfaces/controls.DropdownPanelProps.html +2 -2
  198. package/doc/interfaces/controls.FormControlRowProps.html +2 -2
  199. package/doc/interfaces/{models.IProject.html → controls.IExtensionWorkspaceViewProps.html} +2 -2
  200. package/doc/interfaces/controls.ILocalizedStrings.html +2 -2
  201. package/doc/interfaces/controls.IMessageDatabase.html +2 -2
  202. package/doc/interfaces/controls.InlineEditorProps.html +2 -2
  203. package/doc/interfaces/controls.LabelProps.html +2 -2
  204. package/doc/interfaces/controls.LinChannelSelectControlProps.html +2 -2
  205. package/doc/interfaces/controls.LinIdentifierControlProps.html +6 -3
  206. package/doc/interfaces/controls.LinIdentifierFrameControlProps.html +6 -3
  207. package/doc/interfaces/controls.LinIdentifierGeneratorControlProps.html +6 -3
  208. package/doc/interfaces/controls.LinIdentifierGeneratorSettingsControlProps.html +6 -3
  209. package/doc/interfaces/controls.NumberRangeControlProps.html +2 -2
  210. package/doc/interfaces/controls.RadioControlProps.html +2 -2
  211. package/doc/interfaces/controls.RadioGroupControlProps.html +2 -2
  212. package/doc/interfaces/controls.SectionControlProps.html +2 -2
  213. package/doc/interfaces/controls.SelectControlProps.html +2 -2
  214. package/doc/interfaces/controls.SelectMessageDialogProps.html +19 -2
  215. package/doc/interfaces/controls.SelectSignalDialogProps.html +71 -2
  216. package/doc/interfaces/controls.SelectSignalsControlProps.html +22 -0
  217. package/doc/interfaces/{models.SetLogLevelRequest.html → controls.SelectedSignalInfo.html} +6 -6
  218. package/doc/interfaces/controls.SelectedSignalInfoChangeArgs.html +9 -0
  219. package/doc/interfaces/controls.TableColumn.html +2 -2
  220. package/doc/interfaces/controls.TableControlProps.html +2 -2
  221. package/doc/interfaces/controls.TextControlProps.html +2 -2
  222. package/doc/interfaces/controls.ToggleButtonGroupProps.html +2 -2
  223. package/doc/interfaces/controls.ToggleButtonProps.html +2 -2
  224. package/doc/interfaces/controls.ToolbarControlProps.html +2 -2
  225. package/doc/interfaces/controls.ValidateableTextControlProps.html +2 -2
  226. package/doc/interfaces/controls.toolbarItem.html +5 -3
  227. package/doc/interfaces/hooks.IEnvelopeView.html +12 -0
  228. package/doc/interfaces/hooks.ISignalData.html +19 -2
  229. package/doc/interfaces/hooks.ISignalDataEnvelope.html +14 -0
  230. package/doc/interfaces/hooks.IUndoObject.html +27 -0
  231. package/doc/interfaces/hooks.IUndoState.html +9 -0
  232. package/doc/interfaces/ipc.ILogger.html +2 -2
  233. package/doc/interfaces/models.BaseNodeProperties.html +14 -2
  234. package/doc/interfaces/models.BusStatus.html +32 -2
  235. package/doc/interfaces/models.CanBusParamLimits.html +12 -2
  236. package/doc/interfaces/models.CanBusParams.html +14 -2
  237. package/doc/interfaces/models.CanChannelCapacity.html +10 -4
  238. package/doc/interfaces/models.CanChannelConfiguration.html +39 -9
  239. package/doc/interfaces/models.CanFrameFlags.html +4 -2
  240. package/doc/interfaces/models.CanMessageFilterSettings.html +8 -2
  241. package/doc/interfaces/models.Channel.html +12 -2
  242. package/doc/interfaces/models.ChannelSettings.html +5 -3
  243. package/doc/interfaces/models.DataProcessingStatus.html +10 -2
  244. package/doc/interfaces/models.DataProcessorNodeProperties.html +14 -2
  245. package/doc/interfaces/models.DatabasesSettings.html +4 -2
  246. package/doc/interfaces/models.Device.html +16 -2
  247. package/doc/interfaces/{models.Licenses.html → models.Devices.html} +4 -4
  248. package/doc/interfaces/models.Empty.html +2 -2
  249. package/doc/interfaces/models.ErrorStatus.html +2 -2
  250. package/doc/interfaces/models.FixedPosFrameIdentifier.html +8 -8
  251. package/doc/interfaces/models.Frame.html +16 -5
  252. package/doc/interfaces/models.FrameDefinition.html +5 -3
  253. package/doc/interfaces/{models.AboutInformation.html → models.FrameDefinitions.html} +4 -8
  254. package/doc/interfaces/models.FramePropertyValue.html +6 -2
  255. package/doc/interfaces/models.FrameReceivedTrigger.html +5 -3
  256. package/doc/interfaces/{models.GetFrameDefinitionsFromDatabaseFilesRequest.html → models.Frames.html} +4 -4
  257. package/doc/interfaces/models.IUserSettings.html +2 -2
  258. package/doc/interfaces/models.IWorkspaceComponentPaneData.html +2 -2
  259. package/doc/interfaces/models.IWorkspaceContainerPaneData.html +2 -2
  260. package/doc/interfaces/models.IWorkspacePaneData.html +2 -2
  261. package/doc/interfaces/models.InterpreterSettings.html +2 -2
  262. package/doc/interfaces/models.J1939InterpreterSettings.html +2 -2
  263. package/doc/interfaces/models.LinChannelConfiguration.html +2 -2
  264. package/doc/interfaces/models.LinFrameFlags.html +4 -2
  265. package/doc/interfaces/models.LogMessage.html +2 -2
  266. package/doc/interfaces/models.LogMessages.html +2 -2
  267. package/doc/interfaces/models.LogReplaySettings.html +2 -2
  268. package/doc/interfaces/models.LogReplayStatus.html +4 -2
  269. package/doc/interfaces/models.LoggerStatus.html +4 -2
  270. package/doc/interfaces/models.MeasurementSetup.html +10 -2
  271. package/doc/interfaces/models.MessageLoggerSettings.html +6 -6
  272. package/doc/interfaces/models.NodeStatus.html +2 -2
  273. package/doc/interfaces/models.NodeStatuses.html +4 -2
  274. package/doc/interfaces/models.OnlineStatus.html +6 -2
  275. package/doc/interfaces/models.PeriodicTransmissionSettings.html +2 -2
  276. package/doc/interfaces/models.ServiceExtensionSettings.html +6 -2
  277. package/doc/interfaces/models.SignalDefinition.html +34 -2
  278. package/doc/interfaces/models.SignalDefinitions.html +4 -0
  279. package/doc/interfaces/models.SignalFilterSettings.html +6 -4
  280. package/doc/interfaces/models.SignalLoggerSettings.html +6 -6
  281. package/doc/interfaces/models.SignalValue.html +12 -2
  282. package/doc/interfaces/models.SignalValueTrigger.html +5 -3
  283. package/doc/interfaces/models.SourceNodeProperties.html +12 -2
  284. package/doc/interfaces/models.TargetNodeProperties.html +12 -2
  285. package/doc/interfaces/models.TdcConfiguration.html +17 -0
  286. package/doc/interfaces/models.TriggerSettings.html +2 -2
  287. package/doc/interfaces/models.WriteFrame.html +2 -2
  288. package/doc/modules/controls.html +2 -2
  289. package/doc/modules/hooks.html +2 -2
  290. package/doc/modules/ipc.html +2 -2
  291. package/doc/modules/models.html +2 -2
  292. package/doc/modules.html +1 -1
  293. package/doc/types/controls.ContextMenuOption.html +2 -2
  294. package/doc/types/controls.SelectOption.html +2 -2
  295. package/doc/types/controls.StringsMap.html +2 -2
  296. package/doc/types/controls.canIdentifierGeneratorType.html +2 -2
  297. package/doc/types/controls.canIdentifierType.html +2 -2
  298. package/doc/types/controls.linIdentifierGeneratorType.html +2 -2
  299. package/doc/types/hooks.OnGoingOfflineCallback.html +6 -0
  300. package/doc/types/hooks.OnGoingOnlineCallback.html +6 -0
  301. package/doc/types/models.SerializableFrame.html +2 -0
  302. package/doc/variables/controls.FillBox.html +2 -2
  303. package/doc/variables/controls.OneLineButton.html +2 -2
  304. package/doc/variables/controls.SizedBox.html +2 -2
  305. package/doc/variables/controls.TabsPanel.html +2 -2
  306. package/doc/variables/models.defaultUserSettings.html +2 -2
  307. package/doc_md/README.md +1 -1
  308. package/doc_md/controls/README.md +7 -1
  309. package/doc_md/controls/functions/CanChannelSelectControl.md +1 -1
  310. package/doc_md/controls/functions/CanIdentifierControl.md +1 -1
  311. package/doc_md/controls/functions/CanIdentifierFrameControl.md +1 -1
  312. package/doc_md/controls/functions/CanIdentifierGeneratorControl.md +1 -1
  313. package/doc_md/controls/functions/CanIdentifierGeneratorSettingsControl.md +1 -1
  314. package/doc_md/controls/functions/CanKingDataProvider.md +1 -1
  315. package/doc_md/controls/functions/CheckboxControl.md +1 -1
  316. package/doc_md/controls/functions/ColorControl.md +25 -0
  317. package/doc_md/controls/functions/ColumnItemControl.md +1 -1
  318. package/doc_md/controls/functions/ContextMenu.md +1 -1
  319. package/doc_md/controls/functions/DropdownButton.md +1 -1
  320. package/doc_md/controls/functions/DropdownButtonTextItems.md +1 -1
  321. package/doc_md/controls/functions/DropdownPanel.md +1 -1
  322. package/doc_md/controls/functions/FormControlRow.md +1 -1
  323. package/doc_md/controls/functions/InlineEditor.md +1 -1
  324. package/doc_md/controls/functions/LinChannelSelectControl.md +1 -1
  325. package/doc_md/controls/functions/LinIdentifierControl.md +1 -1
  326. package/doc_md/controls/functions/LinIdentifierFrameControl.md +1 -1
  327. package/doc_md/controls/functions/LinIdentifierGeneratorControl.md +1 -1
  328. package/doc_md/controls/functions/LinIdentifierGeneratorSettingsControl.md +1 -1
  329. package/doc_md/controls/functions/NumberRangeControl.md +1 -1
  330. package/doc_md/controls/functions/RadioControl.md +1 -1
  331. package/doc_md/controls/functions/RadioGroupControl.md +1 -1
  332. package/doc_md/controls/functions/SectionControl.md +1 -1
  333. package/doc_md/controls/functions/SelectControl.md +1 -1
  334. package/doc_md/controls/functions/SelectMessageDialog.md +1 -1
  335. package/doc_md/controls/functions/SelectSignalDialog.md +1 -1
  336. package/doc_md/controls/functions/SelectSignalsControl.md +21 -0
  337. package/doc_md/controls/functions/TableControl.md +1 -1
  338. package/doc_md/controls/functions/TextControl.md +1 -1
  339. package/doc_md/controls/functions/ToolbarControl.md +1 -1
  340. package/doc_md/controls/functions/ValidateableTextControl.md +1 -1
  341. package/doc_md/controls/functions/useColumnItem.md +1 -1
  342. package/doc_md/controls/functions/useColumnItems.md +1 -1
  343. package/doc_md/controls/functions/useMessageDatabases.md +1 -1
  344. package/doc_md/controls/interfaces/ButtonGroupProps.md +1 -1
  345. package/doc_md/controls/interfaces/ButtonProps.md +1 -1
  346. package/doc_md/controls/interfaces/CanChannelSelectControlProps.md +1 -1
  347. package/doc_md/controls/interfaces/CanIdentifierControlProps.md +40 -3
  348. package/doc_md/controls/interfaces/CanIdentifierFrameControlProps.md +10 -1
  349. package/doc_md/controls/interfaces/CanIdentifierGeneratorControlProps.md +10 -1
  350. package/doc_md/controls/interfaces/CanIdentifierGeneratorSettingsControlProps.md +10 -1
  351. package/doc_md/controls/interfaces/CheckboxControlProps.md +18 -1
  352. package/doc_md/controls/interfaces/ContextMenuProps.md +1 -1
  353. package/doc_md/controls/interfaces/DropdownButtonChildrenProps.md +1 -1
  354. package/doc_md/controls/interfaces/DropdownButtonProps.md +1 -1
  355. package/doc_md/controls/interfaces/DropdownButtonTextItemsProps.md +1 -1
  356. package/doc_md/controls/interfaces/DropdownPanelProps.md +1 -1
  357. package/doc_md/controls/interfaces/FormControlRowProps.md +1 -1
  358. package/doc_md/controls/interfaces/IExtensionWorkspaceViewProps.md +9 -0
  359. package/doc_md/controls/interfaces/ILocalizedStrings.md +1 -1
  360. package/doc_md/controls/interfaces/IMessageDatabase.md +1 -1
  361. package/doc_md/controls/interfaces/InlineEditorProps.md +1 -1
  362. package/doc_md/controls/interfaces/LabelProps.md +1 -1
  363. package/doc_md/controls/interfaces/LinChannelSelectControlProps.md +1 -1
  364. package/doc_md/controls/interfaces/LinIdentifierControlProps.md +10 -1
  365. package/doc_md/controls/interfaces/LinIdentifierFrameControlProps.md +10 -1
  366. package/doc_md/controls/interfaces/LinIdentifierGeneratorControlProps.md +10 -1
  367. package/doc_md/controls/interfaces/LinIdentifierGeneratorSettingsControlProps.md +10 -1
  368. package/doc_md/controls/interfaces/NumberRangeControlProps.md +1 -1
  369. package/doc_md/controls/interfaces/RadioControlProps.md +1 -1
  370. package/doc_md/controls/interfaces/RadioGroupControlProps.md +1 -1
  371. package/doc_md/controls/interfaces/SectionControlProps.md +1 -1
  372. package/doc_md/controls/interfaces/SelectControlProps.md +1 -1
  373. package/doc_md/controls/interfaces/SelectMessageDialogProps.md +78 -1
  374. package/doc_md/controls/interfaces/SelectSignalDialogProps.md +224 -1
  375. package/doc_md/controls/interfaces/SelectSignalsControlProps.md +119 -0
  376. package/doc_md/controls/interfaces/SelectedSignalInfo.md +29 -0
  377. package/doc_md/controls/interfaces/SelectedSignalInfoChangeArgs.md +46 -0
  378. package/doc_md/controls/interfaces/TableColumn.md +1 -1
  379. package/doc_md/controls/interfaces/TableControlProps.md +1 -1
  380. package/doc_md/controls/interfaces/TextControlProps.md +1 -1
  381. package/doc_md/controls/interfaces/ToggleButtonGroupProps.md +1 -1
  382. package/doc_md/controls/interfaces/ToggleButtonProps.md +1 -1
  383. package/doc_md/controls/interfaces/ToolbarControlProps.md +1 -1
  384. package/doc_md/controls/interfaces/ValidateableTextControlProps.md +1 -1
  385. package/doc_md/controls/interfaces/toolbarItem.md +9 -1
  386. package/doc_md/controls/type-aliases/ContextMenuOption.md +1 -1
  387. package/doc_md/controls/type-aliases/SelectOption.md +1 -1
  388. package/doc_md/controls/type-aliases/StringsMap.md +1 -1
  389. package/doc_md/controls/type-aliases/canIdentifierGeneratorType.md +1 -1
  390. package/doc_md/controls/type-aliases/canIdentifierType.md +1 -1
  391. package/doc_md/controls/type-aliases/linIdentifierGeneratorType.md +1 -1
  392. package/doc_md/controls/variables/FillBox.md +1 -1
  393. package/doc_md/controls/variables/OneLineButton.md +2 -2
  394. package/doc_md/controls/variables/SizedBox.md +1 -1
  395. package/doc_md/controls/variables/TabsPanel.md +1 -1
  396. package/doc_md/hooks/README.md +18 -1
  397. package/doc_md/hooks/functions/useAvailableProtocols.md +17 -0
  398. package/doc_md/hooks/functions/useDevices.md +1 -1
  399. package/doc_md/hooks/functions/useFixedPositionModeMeasurementData.md +4 -4
  400. package/doc_md/hooks/functions/useIsOnline.md +1 -1
  401. package/doc_md/hooks/functions/useLanguage.md +1 -1
  402. package/doc_md/hooks/functions/useLocalizedStrings.md +1 -1
  403. package/doc_md/hooks/functions/useLogMessages.md +1 -1
  404. package/doc_md/hooks/functions/useMaxDataBytes.md +1 -1
  405. package/doc_md/hooks/functions/useMeasurementSetup.md +1 -1
  406. package/doc_md/hooks/functions/useMeasurementStatus.md +1 -1
  407. package/doc_md/hooks/functions/useMessageData.md +21 -4
  408. package/doc_md/hooks/functions/useMessageLogFileFormats.md +5 -3
  409. package/doc_md/hooks/functions/useNewMeasurementData.md +1 -1
  410. package/doc_md/hooks/functions/useNodeStatus.md +1 -1
  411. package/doc_md/hooks/functions/useNumericRadix.md +1 -1
  412. package/doc_md/hooks/functions/useOnlineStatus.md +1 -1
  413. package/doc_md/hooks/functions/useOnlineStatusSync.md +43 -0
  414. package/doc_md/hooks/functions/useOverallStatusLevel.md +1 -1
  415. package/doc_md/hooks/functions/useProjectData.md +16 -6
  416. package/doc_md/hooks/functions/useProjectDataSlice.md +58 -0
  417. package/doc_md/hooks/functions/useRecentProjectFiles.md +1 -1
  418. package/doc_md/hooks/functions/useRunningPeriodicTransmissions.md +1 -1
  419. package/doc_md/hooks/functions/useScrollModeMeasurementData.md +4 -4
  420. package/doc_md/hooks/functions/useSessionData.md +24 -6
  421. package/doc_md/hooks/functions/useSessionDataSlice.md +60 -0
  422. package/doc_md/hooks/functions/useSignalData.md +23 -6
  423. package/doc_md/hooks/functions/useSignalDataEnvelopes.md +50 -0
  424. package/doc_md/hooks/functions/useSignalLogFileFormats.md +5 -3
  425. package/doc_md/hooks/functions/useUndo.md +38 -0
  426. package/doc_md/hooks/functions/useUndoRef.md +38 -0
  427. package/doc_md/hooks/functions/useUndoSessionDataSlice.md +50 -0
  428. package/doc_md/hooks/functions/useUserSettings.md +1 -1
  429. package/doc_md/hooks/functions/useWorkspacePaneWithId.md +1 -1
  430. package/doc_md/hooks/interfaces/IEnvelopeView.md +49 -0
  431. package/doc_md/hooks/interfaces/ISignalData.md +69 -1
  432. package/doc_md/hooks/interfaces/ISignalDataEnvelope.md +51 -0
  433. package/doc_md/hooks/interfaces/IUndoObject.md +155 -0
  434. package/doc_md/hooks/interfaces/IUndoState.md +41 -0
  435. package/doc_md/hooks/type-aliases/OnGoingOfflineCallback.md +36 -0
  436. package/doc_md/hooks/type-aliases/OnGoingOnlineCallback.md +36 -0
  437. package/doc_md/ipc/README.md +5 -1
  438. package/doc_md/ipc/functions/addDataProcessor.md +1 -1
  439. package/doc_md/ipc/functions/addSource.md +1 -1
  440. package/doc_md/ipc/functions/addTarget.md +1 -1
  441. package/doc_md/ipc/functions/clearLinMessage.md +1 -1
  442. package/doc_md/ipc/functions/connectNodes.md +1 -1
  443. package/doc_md/ipc/functions/deleteDataProcessor.md +1 -1
  444. package/doc_md/ipc/functions/deleteSource.md +1 -1
  445. package/doc_md/ipc/functions/deleteTarget.md +1 -1
  446. package/doc_md/ipc/functions/disableNode.md +1 -1
  447. package/doc_md/ipc/functions/disconnectNodes.md +1 -1
  448. package/doc_md/ipc/functions/enableNode.md +1 -1
  449. package/doc_md/ipc/functions/getFirstAndLatestTimestamp.md +18 -0
  450. package/doc_md/ipc/functions/getFirstTimestamp.md +17 -0
  451. package/doc_md/ipc/functions/getFrameDefinitions.md +1 -1
  452. package/doc_md/ipc/functions/getLatestTimestamp.md +17 -0
  453. package/doc_md/ipc/functions/getLogger.md +1 -1
  454. package/doc_md/ipc/functions/getMessageDataBeforeTimestamp.md +38 -0
  455. package/doc_md/ipc/functions/getMessageLogFileFormats.md +3 -3
  456. package/doc_md/ipc/functions/getSignalLogFileFormats.md +3 -3
  457. package/doc_md/ipc/functions/requestLinMessage.md +1 -1
  458. package/doc_md/ipc/functions/sendCanMessage.md +1 -1
  459. package/doc_md/ipc/functions/sendMessage.md +1 -1
  460. package/doc_md/ipc/functions/showMessageBox.md +1 -1
  461. package/doc_md/ipc/functions/showQuestionBox.md +1 -1
  462. package/doc_md/ipc/functions/startLogReplay.md +1 -1
  463. package/doc_md/ipc/functions/startMeasurement.md +1 -1
  464. package/doc_md/ipc/functions/startPeriodicTransmission.md +1 -1
  465. package/doc_md/ipc/functions/stopLogReplay.md +1 -1
  466. package/doc_md/ipc/functions/stopMeasurement.md +1 -1
  467. package/doc_md/ipc/functions/stopPeriodicTransmission.md +1 -1
  468. package/doc_md/ipc/functions/updateDataProcessor.md +1 -1
  469. package/doc_md/ipc/functions/updateLinMessage.md +1 -1
  470. package/doc_md/ipc/functions/updatePeriodicTransmission.md +1 -1
  471. package/doc_md/ipc/functions/updateSource.md +1 -1
  472. package/doc_md/ipc/functions/updateTarget.md +1 -1
  473. package/doc_md/ipc/interfaces/ILogger.md +1 -1
  474. package/doc_md/models/README.md +25 -73
  475. package/doc_md/models/enumerations/AccessMode.md +4 -1
  476. package/doc_md/models/enumerations/CanChannelCap.md +1 -1
  477. package/doc_md/models/enumerations/CanConfigMode.md +69 -0
  478. package/doc_md/models/enumerations/CanFrameFlag.md +68 -1
  479. package/doc_md/models/enumerations/CanMessageFilterType.md +5 -1
  480. package/doc_md/models/enumerations/CanMode.md +15 -1
  481. package/doc_md/models/enumerations/DecimalChar.md +37 -0
  482. package/doc_md/models/enumerations/FileConflictAction.md +7 -1
  483. package/doc_md/models/enumerations/LinFrameFlag.md +19 -1
  484. package/doc_md/models/enumerations/LogFileFormat.md +9 -1
  485. package/doc_md/models/enumerations/LogLevel.md +1 -1
  486. package/doc_md/models/enumerations/LogReplayState.md +5 -1
  487. package/doc_md/models/enumerations/LoggerState.md +7 -1
  488. package/doc_md/models/enumerations/Separator.md +37 -0
  489. package/doc_md/models/enumerations/SignalEncoding.md +5 -1
  490. package/doc_md/models/enumerations/SignalType.md +1 -1
  491. package/doc_md/models/enumerations/SignalValueTriggerOperator.md +19 -1
  492. package/doc_md/models/enumerations/StatusLevel.md +7 -1
  493. package/doc_md/models/enumerations/TimeReference.md +37 -0
  494. package/doc_md/models/enumerations/TriggerOperator.md +5 -1
  495. package/doc_md/models/functions/decimalToFixed.md +31 -0
  496. package/doc_md/models/functions/decimalToHex.md +37 -0
  497. package/doc_md/models/functions/deep_equal.md +37 -0
  498. package/doc_md/models/functions/deserializeFrame.md +25 -0
  499. package/doc_md/models/functions/jsonReplacer.md +32 -0
  500. package/doc_md/models/functions/jsonReviver.md +32 -0
  501. package/doc_md/models/functions/longToNumber.md +25 -0
  502. package/doc_md/models/functions/serializeFrame.md +25 -0
  503. package/doc_md/models/interfaces/BaseNodeProperties.md +49 -1
  504. package/doc_md/models/interfaces/BusStatus.md +121 -1
  505. package/doc_md/models/interfaces/CanBusParamLimits.md +41 -1
  506. package/doc_md/models/interfaces/CanBusParams.md +49 -1
  507. package/doc_md/models/interfaces/CanChannelCapacity.md +25 -1
  508. package/doc_md/models/interfaces/CanChannelConfiguration.md +107 -8
  509. package/doc_md/models/interfaces/CanFrameFlags.md +9 -1
  510. package/doc_md/models/interfaces/CanMessageFilterSettings.md +25 -1
  511. package/doc_md/models/interfaces/Channel.md +41 -1
  512. package/doc_md/models/interfaces/ChannelSettings.md +9 -1
  513. package/doc_md/models/interfaces/DataProcessingStatus.md +33 -1
  514. package/doc_md/models/interfaces/DataProcessorNodeProperties.md +49 -1
  515. package/doc_md/models/interfaces/DatabasesSettings.md +9 -1
  516. package/doc_md/models/interfaces/Device.md +57 -1
  517. package/doc_md/models/interfaces/Devices.md +17 -0
  518. package/doc_md/models/interfaces/Empty.md +1 -1
  519. package/doc_md/models/interfaces/ErrorStatus.md +1 -1
  520. package/doc_md/models/interfaces/FixedPosFrameIdentifier.md +8 -8
  521. package/doc_md/models/interfaces/Frame.md +46 -2
  522. package/doc_md/models/interfaces/FrameDefinition.md +9 -1
  523. package/doc_md/models/interfaces/FrameDefinitions.md +17 -0
  524. package/doc_md/models/interfaces/FramePropertyValue.md +17 -1
  525. package/doc_md/models/interfaces/FrameReceivedTrigger.md +9 -1
  526. package/doc_md/models/interfaces/Frames.md +17 -0
  527. package/doc_md/models/interfaces/IUserSettings.md +1 -1
  528. package/doc_md/models/interfaces/IWorkspaceComponentPaneData.md +1 -1
  529. package/doc_md/models/interfaces/IWorkspaceContainerPaneData.md +1 -1
  530. package/doc_md/models/interfaces/IWorkspacePaneData.md +1 -1
  531. package/doc_md/models/interfaces/InterpreterSettings.md +1 -1
  532. package/doc_md/models/interfaces/J1939InterpreterSettings.md +1 -1
  533. package/doc_md/models/interfaces/LinChannelConfiguration.md +1 -1
  534. package/doc_md/models/interfaces/LinFrameFlags.md +9 -1
  535. package/doc_md/models/interfaces/LogMessage.md +1 -1
  536. package/doc_md/models/interfaces/LogMessages.md +1 -1
  537. package/doc_md/models/interfaces/LogReplaySettings.md +1 -1
  538. package/doc_md/models/interfaces/LogReplayStatus.md +9 -1
  539. package/doc_md/models/interfaces/LoggerStatus.md +9 -1
  540. package/doc_md/models/interfaces/MeasurementSetup.md +33 -1
  541. package/doc_md/models/interfaces/MessageLoggerSettings.md +4 -4
  542. package/doc_md/models/interfaces/NodeStatus.md +1 -1
  543. package/doc_md/models/interfaces/NodeStatuses.md +9 -1
  544. package/doc_md/models/interfaces/OnlineStatus.md +17 -1
  545. package/doc_md/models/interfaces/PeriodicTransmissionSettings.md +1 -1
  546. package/doc_md/models/interfaces/ServiceExtensionSettings.md +17 -1
  547. package/doc_md/models/interfaces/SignalDefinition.md +133 -1
  548. package/doc_md/models/interfaces/SignalDefinitions.md +17 -0
  549. package/doc_md/models/interfaces/SignalFilterSettings.md +10 -2
  550. package/doc_md/models/interfaces/SignalLoggerSettings.md +4 -4
  551. package/doc_md/models/interfaces/SignalValue.md +41 -1
  552. package/doc_md/models/interfaces/SignalValueTrigger.md +9 -1
  553. package/doc_md/models/interfaces/SourceNodeProperties.md +41 -1
  554. package/doc_md/models/interfaces/TargetNodeProperties.md +41 -1
  555. package/doc_md/models/interfaces/TdcConfiguration.md +33 -0
  556. package/doc_md/models/interfaces/TriggerSettings.md +1 -1
  557. package/doc_md/models/interfaces/WriteFrame.md +1 -1
  558. package/doc_md/models/type-aliases/SerializableFrame.md +33 -0
  559. package/doc_md/models/variables/defaultUserSettings.md +1 -1
  560. package/doc_md/modules.md +2 -3
  561. package/package.json +16 -4
  562. package/dist/ElectronAPIFake.js +0 -1
  563. package/dist/ElectronAPIFake.mjs +0 -273
  564. package/dist/measurement_settings.js +0 -1
  565. package/dist/measurement_settings.mjs +0 -6121
  566. package/doc/enums/models.AppEvent.html +0 -6
  567. package/doc/enums/models.FileType.html +0 -7
  568. package/doc/enums/models.MeasurementEvent.html +0 -12
  569. package/doc/enums/models.Protocols.html +0 -9
  570. package/doc/enums/models.ServiceExtensionType.html +0 -8
  571. package/doc/interfaces/models.ActivateLicenseRequest.html +0 -8
  572. package/doc/interfaces/models.AddAllConnectedCanChannelsRequest.html +0 -2
  573. package/doc/interfaces/models.AddAllConnectedLinChannelsRequest.html +0 -2
  574. package/doc/interfaces/models.AddOrUpdateDataProcessorRequest.html +0 -10
  575. package/doc/interfaces/models.AddOrUpdateSourceRequest.html +0 -6
  576. package/doc/interfaces/models.AddOrUpdateTargetRequest.html +0 -6
  577. package/doc/interfaces/models.ApiPreferences.html +0 -10
  578. package/doc/interfaces/models.AppEventArgs.html +0 -6
  579. package/doc/interfaces/models.CanBusSpeedInfo.html +0 -14
  580. package/doc/interfaces/models.CanFDBusSpeedCombination.html +0 -2
  581. package/doc/interfaces/models.CanFDBusSpeedInfo.html +0 -10
  582. package/doc/interfaces/models.ClearLinMessageRequest.html +0 -6
  583. package/doc/interfaces/models.ConnectNodesRequest.html +0 -2
  584. package/doc/interfaces/models.DatabaseFiles.html +0 -6
  585. package/doc/interfaces/models.DeviceEventArgs.html +0 -2
  586. package/doc/interfaces/models.DisconnectNodesRequest.html +0 -2
  587. package/doc/interfaces/models.GetCanChannelBusSpeedsRequest.html +0 -2
  588. package/doc/interfaces/models.GetCanChannelBusSpeedsResponse.html +0 -6
  589. package/doc/interfaces/models.GetCanFdBusSpeedsRequest.html +0 -2
  590. package/doc/interfaces/models.GetCanFdBusSpeedsResponse.html +0 -4
  591. package/doc/interfaces/models.GetChannelsFromLogFileRequest.html +0 -4
  592. package/doc/interfaces/models.GetChannelsFromLogFileResponse.html +0 -4
  593. package/doc/interfaces/models.GetClassicCanBusSpeedsRequest.html +0 -2
  594. package/doc/interfaces/models.GetClassicCanBusSpeedsResponse.html +0 -4
  595. package/doc/interfaces/models.GetDataFramesBeforeTimestampRequest.html +0 -6
  596. package/doc/interfaces/models.GetDataProcessorResponse.html +0 -2
  597. package/doc/interfaces/models.GetDevicesRequest.html +0 -2
  598. package/doc/interfaces/models.GetDevicesResponse.html +0 -2
  599. package/doc/interfaces/models.GetLicensesResponse.html +0 -4
  600. package/doc/interfaces/models.GetLogFileFormatsRequest.html +0 -8
  601. package/doc/interfaces/models.GetLogFileFormatsResponse.html +0 -10
  602. package/doc/interfaces/models.GetLogLevelResponse.html +0 -4
  603. package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesRequest.html +0 -4
  604. package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesResponse.html +0 -4
  605. package/doc/interfaces/models.GetServiceExtensionInfoRequest.html +0 -8
  606. package/doc/interfaces/models.GetServiceExtensionInfoResponse.html +0 -16
  607. package/doc/interfaces/models.GetSignalDataFromMessageDataRequest.html +0 -6
  608. package/doc/interfaces/models.GetSignalDataFromMessageDataResponse.html +0 -4
  609. package/doc/interfaces/models.GetSourceResponse.html +0 -2
  610. package/doc/interfaces/models.GetTargetResponse.html +0 -2
  611. package/doc/interfaces/models.ILogFileFormat.html +0 -2
  612. package/doc/interfaces/models.IWorkspaceData.html +0 -2
  613. package/doc/interfaces/models.IdentifierRequest.html +0 -3
  614. package/doc/interfaces/models.IdentifiersRequest.html +0 -3
  615. package/doc/interfaces/models.InstallServiceExtensionRequest.html +0 -8
  616. package/doc/interfaces/models.LicenseInformation.html +0 -18
  617. package/doc/interfaces/models.MeasurementEventArgs.html +0 -2
  618. package/doc/interfaces/models.RequestLinMessageRequest.html +0 -6
  619. package/doc/interfaces/models.ScheduleTable.html +0 -8
  620. package/doc/interfaces/models.ScheduleTableEntry.html +0 -6
  621. package/doc/interfaces/models.SendLinWakeupFrameRequest.html +0 -8
  622. package/doc/interfaces/models.SendMessageRequest.html +0 -2
  623. package/doc/interfaces/models.SetMeasurementSetupRequest.html +0 -2
  624. package/doc/interfaces/models.SetSignalDataToMessageDataRequest.html +0 -8
  625. package/doc/interfaces/models.SetSignalDataToMessageDataResponse.html +0 -7
  626. package/doc/interfaces/models.StartPeriodicTransmissionRequest.html +0 -4
  627. package/doc/interfaces/models.StartPeriodicTransmissionResponse.html +0 -2
  628. package/doc/interfaces/models.SubscribeForDataRequest.html +0 -4
  629. package/doc/interfaces/models.UninstallServiceExtensionRequest.html +0 -6
  630. package/doc/interfaces/models.UpdateLinMessageRequest.html +0 -7
  631. package/doc/interfaces/models.UpdatePeriodicTransmissionRequest.html +0 -6
  632. package/doc/modules/icons.html +0 -2
  633. package/doc_md/icons/README.md +0 -9
  634. package/doc_md/models/enumerations/AppEvent.md +0 -29
  635. package/doc_md/models/enumerations/DeviceEvent.md +0 -29
  636. package/doc_md/models/enumerations/FileType.md +0 -39
  637. package/doc_md/models/enumerations/MeasurementEvent.md +0 -53
  638. package/doc_md/models/enumerations/Protocols.md +0 -39
  639. package/doc_md/models/enumerations/ServiceExtensionType.md +0 -37
  640. package/doc_md/models/interfaces/AboutInformation.md +0 -33
  641. package/doc_md/models/interfaces/ActivateLicenseRequest.md +0 -33
  642. package/doc_md/models/interfaces/AddAllConnectedCanChannelsRequest.md +0 -9
  643. package/doc_md/models/interfaces/AddAllConnectedLinChannelsRequest.md +0 -9
  644. package/doc_md/models/interfaces/AddOrUpdateDataProcessorRequest.md +0 -35
  645. package/doc_md/models/interfaces/AddOrUpdateSourceRequest.md +0 -19
  646. package/doc_md/models/interfaces/AddOrUpdateTargetRequest.md +0 -19
  647. package/doc_md/models/interfaces/ApiPreferences.md +0 -41
  648. package/doc_md/models/interfaces/AppEventArgs.md +0 -25
  649. package/doc_md/models/interfaces/CanBusSpeedInfo.md +0 -57
  650. package/doc_md/models/interfaces/CanFDBusSpeedCombination.md +0 -9
  651. package/doc_md/models/interfaces/CanFDBusSpeedInfo.md +0 -41
  652. package/doc_md/models/interfaces/ClearLinMessageRequest.md +0 -25
  653. package/doc_md/models/interfaces/ConnectNodesRequest.md +0 -9
  654. package/doc_md/models/interfaces/DatabaseFiles.md +0 -25
  655. package/doc_md/models/interfaces/DeviceEventArgs.md +0 -9
  656. package/doc_md/models/interfaces/DisconnectNodesRequest.md +0 -9
  657. package/doc_md/models/interfaces/GetCanChannelBusSpeedsRequest.md +0 -9
  658. package/doc_md/models/interfaces/GetCanChannelBusSpeedsResponse.md +0 -25
  659. package/doc_md/models/interfaces/GetCanFdBusSpeedsRequest.md +0 -9
  660. package/doc_md/models/interfaces/GetCanFdBusSpeedsResponse.md +0 -17
  661. package/doc_md/models/interfaces/GetChannelsFromLogFileRequest.md +0 -17
  662. package/doc_md/models/interfaces/GetChannelsFromLogFileResponse.md +0 -17
  663. package/doc_md/models/interfaces/GetClassicCanBusSpeedsRequest.md +0 -9
  664. package/doc_md/models/interfaces/GetClassicCanBusSpeedsResponse.md +0 -17
  665. package/doc_md/models/interfaces/GetDataFramesBeforeTimestampRequest.md +0 -25
  666. package/doc_md/models/interfaces/GetDataProcessorResponse.md +0 -9
  667. package/doc_md/models/interfaces/GetDevicesRequest.md +0 -9
  668. package/doc_md/models/interfaces/GetDevicesResponse.md +0 -9
  669. package/doc_md/models/interfaces/GetFrameDefinitionsFromDatabaseFilesRequest.md +0 -17
  670. package/doc_md/models/interfaces/GetLicensesResponse.md +0 -17
  671. package/doc_md/models/interfaces/GetLogFileFormatsRequest.md +0 -33
  672. package/doc_md/models/interfaces/GetLogFileFormatsResponse.md +0 -41
  673. package/doc_md/models/interfaces/GetLogLevelResponse.md +0 -17
  674. package/doc_md/models/interfaces/GetScheduleTablesFromDatabaseFilesRequest.md +0 -17
  675. package/doc_md/models/interfaces/GetScheduleTablesFromDatabaseFilesResponse.md +0 -17
  676. package/doc_md/models/interfaces/GetServiceExtensionInfoRequest.md +0 -27
  677. package/doc_md/models/interfaces/GetServiceExtensionInfoResponse.md +0 -65
  678. package/doc_md/models/interfaces/GetSignalDataFromMessageDataRequest.md +0 -25
  679. package/doc_md/models/interfaces/GetSignalDataFromMessageDataResponse.md +0 -17
  680. package/doc_md/models/interfaces/GetSourceResponse.md +0 -9
  681. package/doc_md/models/interfaces/GetTargetResponse.md +0 -9
  682. package/doc_md/models/interfaces/ILogFileFormat.md +0 -9
  683. package/doc_md/models/interfaces/IProject.md +0 -9
  684. package/doc_md/models/interfaces/IWorkspaceData.md +0 -9
  685. package/doc_md/models/interfaces/IdentifierRequest.md +0 -10
  686. package/doc_md/models/interfaces/IdentifiersRequest.md +0 -10
  687. package/doc_md/models/interfaces/InstallServiceExtensionRequest.md +0 -33
  688. package/doc_md/models/interfaces/LicenseInformation.md +0 -73
  689. package/doc_md/models/interfaces/Licenses.md +0 -17
  690. package/doc_md/models/interfaces/MeasurementEventArgs.md +0 -9
  691. package/doc_md/models/interfaces/RequestLinMessageRequest.md +0 -25
  692. package/doc_md/models/interfaces/ScheduleTable.md +0 -33
  693. package/doc_md/models/interfaces/ScheduleTableEntry.md +0 -25
  694. package/doc_md/models/interfaces/SendLinWakeupFrameRequest.md +0 -33
  695. package/doc_md/models/interfaces/SendMessageRequest.md +0 -9
  696. package/doc_md/models/interfaces/SetLogLevelRequest.md +0 -25
  697. package/doc_md/models/interfaces/SetMeasurementSetupRequest.md +0 -9
  698. package/doc_md/models/interfaces/SetSignalDataToMessageDataRequest.md +0 -33
  699. package/doc_md/models/interfaces/SetSignalDataToMessageDataResponse.md +0 -26
  700. package/doc_md/models/interfaces/StartPeriodicTransmissionRequest.md +0 -17
  701. package/doc_md/models/interfaces/StartPeriodicTransmissionResponse.md +0 -9
  702. package/doc_md/models/interfaces/SubscribeForDataRequest.md +0 -17
  703. package/doc_md/models/interfaces/UninstallServiceExtensionRequest.md +0 -25
  704. package/doc_md/models/interfaces/UpdateLinMessageRequest.md +0 -26
  705. package/doc_md/models/interfaces/UpdatePeriodicTransmissionRequest.md +0 -25
  706. package/licenses/ELECTRON-TOOLKIT-PRELOAD_MIT.TXT +0 -21
  707. package/licenses/FAST-DEEP-EQUAL_MIT.TXT +0 -21
  708. package/licenses/GOOGLE-PROTOBUF_(BSD-3-CLAUSE AND APACHE-2.0).TXT +0 -29
  709. package/licenses/REACT-DOM_MIT.TXT +0 -21
  710. package/licenses/REACT_MIT.TXT +0 -21
  711. package/licenses/UUID_MIT.TXT +0 -9
  712. package/licenses/licenses.css +0 -22
  713. package/licenses/licenses.html +0 -67
@@ -1,5 +1,6 @@
1
1
  import { ILocalizedStrings } from '../controls/LocalizedStrings';
2
- import { Device, Frame, NodeStatus, LogMessage, MeasurementSetup, OnlineStatus, StatusLevel, ILogFileFormat, IUserSettings, IWorkspacePaneData, FixedPosFrameIdentifier } from '../models';
2
+ import { Device, Frame, NodeStatus, LogMessage, MeasurementSetup, OnlineStatus, StatusLevel, LogFileFormatInfo, IUserSettings, IWorkspacePaneData, FixedPosFrameIdentifier } from '../models';
3
+ import Long from 'long';
3
4
  /**
4
5
  * A hook for user settings.
5
6
  * @returns The user settings.
@@ -28,6 +29,22 @@ export declare const useLocalizedStrings: () => ILocalizedStrings;
28
29
  * Hook keeping track of recent project files.
29
30
  */
30
31
  export declare const useRecentProjectFiles: () => string[];
32
+ /**
33
+ * A hook for log messages.
34
+ * @returns The log messages.
35
+ */
36
+ export declare const useLogMessages: () => LogMessage[];
37
+ /**
38
+ * Hook keeping track of message log file formats.
39
+ * @param read_support - Optional flag to indicate if read support is required.
40
+ * @returns The message log file formats.
41
+ */
42
+ export declare const useMessageLogFileFormats: (read_support?: boolean) => LogFileFormatInfo[];
43
+ /**
44
+ * Hook keeping track of signal log file formats.
45
+ * @returns The signal log file formats.
46
+ */
47
+ export declare const useSignalLogFileFormats: () => LogFileFormatInfo[];
31
48
  /**
32
49
  * A hook for hardware devices.
33
50
  * @returns The hardware devices.
@@ -38,6 +55,11 @@ export declare const useDevices: () => Device[] | null;
38
55
  * @returns The measurement setup.
39
56
  */
40
57
  export declare const useMeasurementSetup: () => MeasurementSetup;
58
+ /**
59
+ * Hook to get all available protocols from the measurement setup.
60
+ * @returns The available protocols.
61
+ */
62
+ export declare const useAvailableProtocols: () => string[];
41
63
  /**
42
64
  * A hook for measurement status.
43
65
  * @returns The measurement status.
@@ -48,6 +70,20 @@ export declare const useMeasurementStatus: () => NodeStatus[];
48
70
  * @returns The node status.
49
71
  */
50
72
  export declare const useNodeStatus: (id: string) => NodeStatus | null;
73
+ /**
74
+ * Calculates the overall status level from a bus status.
75
+ * @param busStatus - The bus status to calculate from.
76
+ * @returns The overall status level.
77
+ * @internal
78
+ */
79
+ export declare function calculateOverallStatusLevelFromBusStatus(busStatus: NodeStatus['busStatus']): StatusLevel;
80
+ /**
81
+ * Calculates the overall status level from multiple node statuses.
82
+ * @param statuses - Array of node statuses.
83
+ * @returns The highest overall status level.
84
+ * @internal
85
+ */
86
+ export declare function calculateOverallStatusLevel(statuses: NodeStatus[]): StatusLevel;
51
87
  /**
52
88
  * Hook to get the measurement's highest overall status level.
53
89
  * @returns The measurement's highest overall status.
@@ -68,11 +104,6 @@ export declare const useIsOnline: () => boolean;
68
104
  * @returns The running periodic transmissions.
69
105
  */
70
106
  export declare const useRunningPeriodicTransmissions: () => string[];
71
- /**
72
- * A hook for log messages.
73
- * @returns The log messages.
74
- */
75
- export declare const useLogMessages: () => LogMessage[];
76
107
  /**
77
108
  * A hook for new measurement data.
78
109
  * @param numberOfHistoryFrames - Optional number of history frames to read from data buffer when this hook initializes.
@@ -83,71 +114,395 @@ export declare const useLogMessages: () => LogMessage[];
83
114
  export declare const useNewMeasurementData: (numberOfHistoryFrames?: number, predicate?: (frame: Frame) => boolean) => Frame[];
84
115
  /**
85
116
  * A hook for scroll mode measurement data. Will return the latest measurement data. Will include at most 500 frames.
86
- * @param start - Optional start time to read from the scroll data buffer. Any frame with a timestamp less than this will be excluded.
117
+ * @param startUs - Optional start time (in microseconds) to read from the scroll data buffer. Any frame with a timestamp less than this will be excluded.
87
118
  * @returns The measurement data.
88
119
  */
89
- export declare const useScrollModeMeasurementData: (start?: number) => Frame[];
120
+ export declare const useScrollModeMeasurementData: (startUs?: number) => Frame[];
90
121
  /**
91
122
  * A hook for fixed position mode measurement data. Will return the latest measurement data for each unique frame id and type.
92
- * @param start - Optional start time to read from the fixed position data buffer. Any frame with a timestamp less than this will be excluded.
123
+ * @param startUs - Optional start time (in microseconds) to read from the fixed position data buffer. Any frame with a timestamp less than this will be excluded.
93
124
  * @returns The measurement data.
94
125
  */
95
- export declare const useFixedPositionModeMeasurementData: (start?: number) => Frame[];
126
+ export declare const useFixedPositionModeMeasurementData: (startUs?: number) => Frame[];
127
+ /**
128
+ * Merges frame arrays and removes duplicates based on frame timestamp.
129
+ * @param existing - Existing frames to merge into.
130
+ * @param incoming - New frames to add.
131
+ * @returns Merged and deduplicated frames.
132
+ * @internal
133
+ */
134
+ export declare function mergeAndDeduplicateFrames(existing: Frame[], incoming: Frame[]): Frame[];
135
+ /**
136
+ * Merges multiple frame data maps, deduplicating frames within each key.
137
+ * @param base - Base map to merge into (will be modified).
138
+ * @param additional - Additional map to merge from.
139
+ * @returns The merged map (same reference as base).
140
+ * @internal
141
+ */
142
+ export declare function mergeFrameDataMaps(base: Map<string, Frame[]>, additional: Map<string, Frame[]>): Map<string, Frame[]>;
96
143
  /**
97
144
  * A hook for extracting message data from the measurement context. Will return the latest measurement data for the specified identifier.
98
- * @param identifiers - The fixed position frame identifier to get data for. To avoid unnecessary re-renders, make sure to memoize this object.
99
- * @returns The measurement data for the specified identifier.
145
+ *
146
+ * @remarks
147
+ * This hook buffers incoming frame data during initialization (before historical data is ready)
148
+ * and merges it with historical data once available. This ensures no data is lost during the startup phase.
149
+ *
150
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
151
+ * @param subscriptionName - The subscription name for the data. Must be unique per view. To avoid conflicts, use a descriptive name.
152
+ * @param identifiers - The fixed position frame identifiers to get data for. To avoid unnecessary re-renders, make sure to memoize this object.
153
+ * @returns The measurement data for the specified identifiers. If an empty array is returned, then all previously received data is invalid and should be discarded.
100
154
  */
101
- export declare const useMessageData: (identifiers: FixedPosFrameIdentifier[]) => Frame[];
155
+ export declare const useMessageData: (id: number, subscriptionName: string, identifiers: FixedPosFrameIdentifier[]) => Frame[];
102
156
  /**
103
157
  * Interface for signal data.
104
158
  */
105
159
  export interface ISignalData {
160
+ /** The qualified name of the signal. */
106
161
  qualifiedName: string;
162
+ /** The source identifier of the signal. */
163
+ sourceId?: string;
164
+ /** The name of the signal. */
107
165
  name: string;
166
+ /** The unit of the signal. */
108
167
  unit: string;
168
+ /**
169
+ * The timestamp of the signal data.
170
+ * @deprecated Use `timeUs` for higher precision timestamps in microseconds. This field is kept for backward compatibility but may be removed in the future.
171
+ */
109
172
  time: number;
173
+ /** The timestamp of the signal data in microseconds. */
174
+ timeUs: Long;
175
+ /** The double value of the signal. */
110
176
  doubleValue: number;
177
+ /** Optional string value of the signal. */
111
178
  stringValue?: string;
112
179
  }
180
+ /**
181
+ * Initialization state for signal data hook.
182
+ * @internal
183
+ */
184
+ export declare enum SignalDataInitState {
185
+ /** Not yet initialized */
186
+ PENDING = "pending",
187
+ /** Frame keys loaded, waiting for historical data */
188
+ FRAME_KEYS_READY = "frameKeysReady",
189
+ /** Historical data loaded, waiting for frame keys */
190
+ HISTORICAL_DATA_READY = "historicalDataReady",
191
+ /** Fully initialized and ready to process data */
192
+ READY = "ready"
193
+ }
113
194
  /**
114
195
  * A hook for extracting signal data from the measurement context. Will return the latest measurement data for the specified signal names.
115
- * @param qualifiedSignalNames - The qualified names of the signals to extract data for. To avoid unnecessary re-renders, make sure to memoize this object.
116
- * @returns The extracted signal data.
196
+ *
197
+ * @remarks
198
+ * This hook buffers incoming frame data during initialization (before frame keys and historical data are ready)
199
+ * and merges it with historical data once available. This ensures no data is lost during the startup phase.
200
+ *
201
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
202
+ * @param subscriptionName - The subscription name for the data. Must be unique per view. To avoid conflicts, use a descriptive name.
203
+ * @param subscribedSignals - The signals to extract data for, including optional source identifiers. To avoid unnecessary re-renders, make sure to memoize this object.
204
+ * @returns The extracted signal data. If an empty array is returned, then all previously received data is invalid and should be discarded.
205
+ */
206
+ export declare const useSignalData: (id: number, subscriptionName: string, subscribedSignals: {
207
+ qualifiedName: string;
208
+ sourceId?: string;
209
+ }[]) => ISignalData[];
210
+ /**
211
+ * Interface for signal data envelope.
212
+ * Each envelope contains arrays of time, min, and max values for a signal.
213
+ * All arrays are aligned by index.
214
+ */
215
+ export interface ISignalDataEnvelope {
216
+ /** The qualified name of the signal. */
217
+ qualifiedName: string;
218
+ /** The source identifier of the signal. */
219
+ sourceId?: string;
220
+ /** The timestamps of the signal data in microseconds. */
221
+ timeUs: number[];
222
+ /** The minimum values of the signal data. */
223
+ min: number[];
224
+ /** The maximum values of the signal data. */
225
+ max: number[];
226
+ }
227
+ /**
228
+ * Interface for envelope view parameters.
229
+ */
230
+ export interface IEnvelopeView {
231
+ /** The start time of the view in microseconds. */
232
+ startTimeUs?: number;
233
+ /** The end time of the view in microseconds. */
234
+ endTimeUs?: number;
235
+ /** The time window of the view in microseconds. If start and end is not set then this defines the window. */
236
+ windowUs?: number;
237
+ /** The width of the view in pixels. */
238
+ width?: number;
239
+ /** Optional counter to force update the envelopes. Change it to trigger a refresh even if other parameters have not changed. */
240
+ forceUpdateCounter?: number;
241
+ }
242
+ /**
243
+ * A hook for extracting signal data envelopes to be used for graphical visualization.
244
+ * The envelopes contain min/max values for signals over time ranges, suitable for plotting.
245
+ *
246
+ * @remarks
247
+ * This hook subscribes to live envelope data when no view time range is provided.
248
+ * If a view with startTime and endTime is given, it fetches envelopes from historical/cached data instead.
249
+ *
250
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
251
+ * @param subscriptionName - The subscription name for the data. Must be unique per view. To avoid conflicts, use a descriptive name.
252
+ * @param subscribedSignals - The subscribed signals with their qualified names and optional source identifiers. To avoid unnecessary re-renders, make sure to memoize this object.
253
+ * @param view - Optional view parameters to define the time range and width for the envelopes. If startTime and endTime are set then the envelopes
254
+ * will be fetched from history/cached data, otherwise only new/live envelope data will be provided.
255
+ * @returns The extracted signal data. If an empty array is returned, then all previously received data is invalid and should be discarded.
256
+ */
257
+ export declare const useSignalDataEnvelopes: (id: number, subscriptionName: string, subscribedSignals: {
258
+ qualifiedName: string;
259
+ sourceId?: string;
260
+ }[], view: IEnvelopeView) => ISignalDataEnvelope[];
261
+ /**
262
+ * Merges saved session/project data with default values.
263
+ * @param saved - Saved session/project data (will be null/undefined if not present).
264
+ * @param defaultValue - Default value to use as base.
265
+ * @returns Merged data combining default and saved values.
266
+ * @internal
267
+ */
268
+ export declare function mergeData<T>(saved: any, defaultValue: T): T;
269
+ /**
270
+ * Calculate the maximum number of active intervals allowed based on workspace panes.
271
+ * Assumes each pane might have 3-6 project data hooks on average (useProjectData + multiple useProjectDataSlice).
272
+ * @param numPanes - Number of active workspace panes
273
+ * @returns Maximum allowed active intervals
274
+ * @internal
275
+ */
276
+ export declare function calculateMaxActiveProjectDataIntervals(numPanes: number): number;
277
+ /**
278
+ * A hook for data that should be saved to the current project.
279
+ * The state is automatically saved to and restored from the main process.
280
+ * @remarks
281
+ * Use this hook to split your workspace view's project data into multiple named slices.
282
+ * This can improve performance and reduce memory usage and it also allows
283
+ * different parts of the component tree to independently load and save their project data.
284
+ * Make sure to use the workspace view component's `id` prop and to use unique slice names
285
+ * for each slice within the component tree.
286
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
287
+ * @param slice - The slice name for the project data.
288
+ * @param defaultValue - The default value or a function that returns the default value.
289
+ * @param loadedCallback - Optional callback invoked once after data is loaded.
290
+ * @returns An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.
117
291
  */
118
- export declare const useSignalData: (qualifiedSignalNames: string[]) => ISignalData[];
292
+ export declare const useProjectDataSlice: <T>(id: number, slice: string, defaultValue: T | (() => T), loadedCallback?: (value: T) => void) => [T, React.Dispatch<React.SetStateAction<T>>, boolean];
119
293
  /**
120
294
  * A hook for data that should be saved to the current project.
121
- * @param id - The unique id of the view.
122
- * @param defaultValue - The default value or a callback to set default value.
295
+ * The state is automatically saved to and restored from the main process.
296
+ * @remarks
297
+ * It's only possible to use this hook once per workspace view component tree.
298
+ * Use this hook if your view component only needs to store a small amount of project data.
299
+ * For larger amounts of data, consider using `useProjectDataSlice` instead, which allows
300
+ * splitting the project data into multiple named slices.
301
+ * Using multiple slices can improve performance and reduce memory usage and it also allows
302
+ * different parts of the component tree to independently load and save their project data.
303
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
304
+ * @param defaultValue - The default value or a function that returns the default value.
123
305
  * @returns An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.
124
306
  */
125
- export declare const useProjectData: <T>(id: number, defaultValue?: T) => {
307
+ export declare const useProjectData: <T>(id: number, defaultValue: T | (() => T)) => {
126
308
  projectDataIsInitialized: boolean;
127
309
  projectData: T;
128
310
  setProjectData: React.Dispatch<React.SetStateAction<T>>;
129
311
  };
312
+ /**
313
+ * Calculate the maximum number of active intervals allowed based on workspace panes.
314
+ * Assumes each pane might have 3-6 session data hooks on average (useSessionData + multiple useSessionDataSlice).
315
+ * @param numPanes - Number of active workspace panes
316
+ * @returns Maximum allowed active intervals
317
+ * @internal
318
+ */
319
+ export declare function calculateMaxActiveSessionDataIntervals(numPanes: number): number;
130
320
  /**
131
321
  * A hook for data that should be saved to the session data.
132
- * @param id - The unique id of the view.
133
- * @param defaultValue - The default value or a callback to set default value.
322
+ * The state is automatically saved to and restored from the main process.
323
+ * @remarks
324
+ * It's only possible to use this hook once per workspace view component tree.
325
+ * Use this hook if your view component only needs to store a small amount of session data.
326
+ * For larger amounts of data, consider using `useSessionDataSlice` instead, which allows
327
+ * splitting the session data into multiple named slices.
328
+ * Using multiple slices can improve performance and reduce memory usage and it also allows
329
+ * different parts of the component tree to independently load and save their session data.
330
+ * @typeParam T - The type of the session data. Must be JSON serializable.
331
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
332
+ * @param defaultValue - The default value or a function that returns the default value.
333
+ * @param loadedCallback - Optional callback invoked once after data is loaded.
134
334
  * @returns An object with a flag indicating if the session data has been initialized, the current session data and a setter callback.
135
335
  */
136
- export declare const useSessionData: <T>(id: number, defaultValue?: T) => {
336
+ export declare const useSessionData: <T>(id: number, defaultValue: T | (() => T), loadedCallback?: (value: T) => void) => {
137
337
  sessionDataIsInitialized: boolean;
138
338
  sessionData: T;
139
339
  setSessionData: React.Dispatch<React.SetStateAction<T>>;
140
340
  };
341
+ /**
342
+ * A hook for persistent (session) data tied to a specific view slice.
343
+ * The state is automatically saved to and restored from the main process.
344
+ * @remarks
345
+ * Use this hook to split your workspace view's session data into multiple named slices.
346
+ * This can improve performance and reduce memory usage and it also allows
347
+ * different parts of the component tree to independently load and save their session data.
348
+ * Make sure to use the workspace view component's `id` prop and to use unique slice names
349
+ * for each slice within the component tree.
350
+ * @typeParam T - The type of the session data. Must be JSON serializable.
351
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
352
+ * @param slice - The slice name for the session data.
353
+ * @param defaultValue - The default value or a function that returns the default value.
354
+ * @param loadedCallback - Optional callback invoked once after data is loaded.
355
+ * @returns [state, setState, loaded] — the current data, setter, and loaded flag.
356
+ */
357
+ export declare function useSessionDataSlice<T>(id: number, slice: string, defaultValue: T | (() => T), loadedCallback?: (value: T) => void): [T, React.Dispatch<React.SetStateAction<T>>, boolean];
358
+ /**
359
+ * Custom hook to manage undo/redo state using session data storage.
360
+ * @remarks
361
+ * This hook triggers component re-renders whenever the state changes.
362
+ * This is useful for persisting undo/redo state across sessions.
363
+ * @typeParam T - The type of the state being managed, must be serializable to JSON.
364
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
365
+ * @param slice - The slice name for the session data.
366
+ * @param initialState - The initial undo state. Will be used if there is no existing session data.
367
+ * @returns [undoObject, loaded] - An undo object for managing state history and loaded flag.
368
+ */
369
+ export declare function useUndoSessionDataSlice<T>(id: number, slice: string, initialState?: IUndoState<T>): [IUndoObject<T>, boolean];
141
370
  /**
142
371
  * Hook to get/set a workspace pane by id.
143
372
  */
144
373
  export declare const useWorkspacePaneWithId: (id: number) => IWorkspacePaneData | null;
145
374
  /**
146
- * Hook keeping track of message log file formats.
147
- * @param read_support - Optional flag to indicate if read support is required.
375
+ * Callback type for when the view goes online.
376
+ * The online counter can be used to determine if CanKing has been offline and come back online while the view was unmounted.
377
+ * @param isNewView - Whether the view is newly created.
378
+ * @param isMounting - Whether the view is mounting.
379
+ * @param onlineCounter - The number of times CanKing has gone online (including the current one).
148
380
  */
149
- export declare const useMessageLogFileFormats: (read_support?: boolean) => ILogFileFormat[];
381
+ export type OnGoingOnlineCallback = (isNewView: boolean, isMounting: boolean, onlineCounter: number) => void;
150
382
  /**
151
- * Hook keeping track of signal log file formats.
383
+ * Callback type for when the view goes offline.
384
+ * The online counter can be used to determine if CanKing has been online and come back offline while the view was unmounted.
385
+ * @param isNewView - Whether the view is newly created.
386
+ * @param isMounting - Whether the view is mounting.
387
+ * @param onlineCounter - The number of times CanKing has gone online (including the current one).
388
+ */
389
+ export type OnGoingOfflineCallback = (isNewView: boolean, isMounting: boolean, onlineCounter: number) => void;
390
+ /**
391
+ * Custom hook to synchronize session state with online/offline status changes.
392
+ * @param parentIsInitialized - Whether the parent component is initialized and has loaded all project and session data needed before receiving online updates.
393
+ * @param id - The unique id of the view. This is passed to the view component as the `id` prop.
394
+ * @param onGoingOnline - Callback function to handle going online. Called when the CanKing starts a measurement or when the view is mounted while online.
395
+ * @param onGoingOffline - Callback function to handle going offline. Called when the CanKing stops a measurement or when the view is mounted while offline.
396
+ * @returns The current online status.
397
+ */
398
+ export declare function useOnlineStatusSync(parentIsInitialized: boolean, id: number, onGoingOnline: OnGoingOnlineCallback, onGoingOffline: OnGoingOfflineCallback): boolean;
399
+ /**
400
+ * The undo/redo state.
401
+ * @typeParam T - The type of the undo/redo data.
402
+ */
403
+ export interface IUndoState<T> {
404
+ /** The previous values */
405
+ previous: T[];
406
+ /** The current value */
407
+ current?: T;
408
+ /** The next values */
409
+ next: T[];
410
+ }
411
+ /**
412
+ * The undo/redo object. Includes the current state and methods to manipulate it.
413
+ * @typeParam T - The type of the undo/redo data.
414
+ */
415
+ export interface IUndoObject<T> {
416
+ /** The current undo/redo state */
417
+ state: IUndoState<T>;
418
+ /**
419
+ * Set a new current state
420
+ * @param updater - The new value or a function that receives the current value and returns the new value
421
+ */
422
+ set: (updater: T | ((curr?: T) => T)) => void;
423
+ /**
424
+ * Reset the undo/redo history with a new initial value
425
+ * @param current - The new initial value. If undefined, current will be unset.
426
+ * @param previous - The previous values (optional)
427
+ * @param next - The next values (optional)
428
+ */
429
+ reset: (current?: T, previous?: T[], next?: T[]) => void;
430
+ /**
431
+ * Undo to the previous state
432
+ */
433
+ undo: () => void;
434
+ /**
435
+ * Redo to the next state
436
+ */
437
+ redo: () => void;
438
+ /**
439
+ * Check if undo is possible
440
+ * @returns true if there are states to undo to
441
+ */
442
+ canUndo: () => boolean;
443
+ /**
444
+ * Check if redo is possible
445
+ * @returns true if there are states to redo to
446
+ */
447
+ canRedo: () => boolean;
448
+ /**
449
+ * Subscribe to state changes (optional, for triggering re-renders)
450
+ * @param listener - Callback function that will be called whenever state changes
451
+ * @returns Unsubscribe function
452
+ */
453
+ subscribe?: (listener: () => void) => () => void;
454
+ }
455
+ /**
456
+ * Helper function to limit buffer size by keeping only the most recent entries.
457
+ * @param buffer - The buffer to limit.
458
+ * @param maxLength - Maximum allowed length.
459
+ * @returns Limited buffer.
460
+ * @internal
461
+ */
462
+ export declare function limitBuffer<T>(buffer: T[], maxLength: number): T[];
463
+ /**
464
+ * Performs an undo operation on the undo/redo state.
465
+ * @param state - Current undo/redo state.
466
+ * @param maxBufferLength - Maximum buffer length for history.
467
+ * @returns New undo/redo state after undo.
468
+ * @internal
469
+ */
470
+ export declare function performUndo<T>(state: IUndoState<T>, maxBufferLength: number): IUndoState<T>;
471
+ /**
472
+ * Performs a redo operation on the undo/redo state.
473
+ * @param state - Current undo/redo state.
474
+ * @param maxBufferLength - Maximum buffer length for history.
475
+ * @returns New undo/redo state after redo.
476
+ * @internal
477
+ */
478
+ export declare function performRedo<T>(state: IUndoState<T>, maxBufferLength: number): IUndoState<T>;
479
+ /**
480
+ * Performs a set operation on the undo/redo state.
481
+ * @param state - Current undo/redo state.
482
+ * @param newValue - New value to set.
483
+ * @param maxBufferLength - Maximum buffer length for history.
484
+ * @param equalityFn - Optional equality function to check if value changed.
485
+ * @returns New undo/redo state after set, or null if value didn't change.
486
+ * @internal
487
+ */
488
+ export declare function performSet<T>(state: IUndoState<T>, newValue: T, maxBufferLength: number, equalityFn?: (a: T | undefined, b: T) => boolean): IUndoState<T> | null;
489
+ /**
490
+ * Custom hook to manage undo/redo state using a ref (does not trigger re-renders by default).
491
+ * @remarks
492
+ * This hook uses useRef and does not automatically trigger component re-renders.
493
+ * Use the subscribe method if you need to trigger re-renders on state changes, or use useUndo instead.
494
+ * @typeParam T - The type of the undo/redo data.
495
+ * @param initialState - The initial undo state.
496
+ * @returns An undo object for managing state history.
497
+ */
498
+ export declare function useUndoRef<T>(initialState?: IUndoState<T>): IUndoObject<T>;
499
+ /**
500
+ * Custom hook to manage undo/redo state with automatic re-renders.
501
+ * @remarks
502
+ * This hook triggers component re-renders whenever the state changes.
503
+ * If you don't need re-renders, use useUndoRef instead for better performance.
504
+ * @typeParam T - The type of the state being managed.
505
+ * @param initialState - The initial undo state.
506
+ * @returns An undo object for managing state history with automatic re-renders.
152
507
  */
153
- export declare const useSignalLogFileFormats: () => ILogFileFormat[];
508
+ export declare function useUndo<T>(initialState?: IUndoState<T>): IUndoObject<T>;
package/dist/hooks.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});require("react");require("uuid");const e=require("./index.js");require("long");require("./ElectronAPIFake.js");require("./measurement_settings.js");require("./status_params.js");require("./ipc.js");exports.useDevices=e.useDevices;exports.useFixedPositionModeMeasurementData=e.useFixedPositionModeMeasurementData;exports.useIsOnline=e.useIsOnline;exports.useLanguage=e.useLanguage;exports.useLocalizedStrings=e.useLocalizedStrings;exports.useLogMessages=e.useLogMessages;exports.useMaxDataBytes=e.useMaxDataBytes;exports.useMeasurementSetup=e.useMeasurementSetup;exports.useMeasurementStatus=e.useMeasurementStatus;exports.useMessageData=e.useMessageData;exports.useMessageLogFileFormats=e.useMessageLogFileFormats;exports.useNewMeasurementData=e.useNewMeasurementData;exports.useNodeStatus=e.useNodeStatus;exports.useNumericRadix=e.useNumericRadix;exports.useOnlineStatus=e.useOnlineStatus;exports.useOverallStatusLevel=e.useOverallStatusLevel;exports.useProjectData=e.useProjectData;exports.useRecentProjectFiles=e.useRecentProjectFiles;exports.useRunningPeriodicTransmissions=e.useRunningPeriodicTransmissions;exports.useScrollModeMeasurementData=e.useScrollModeMeasurementData;exports.useSessionData=e.useSessionData;exports.useSignalData=e.useSignalData;exports.useSignalLogFileFormats=e.useSignalLogFileFormats;exports.useUserSettings=e.useUserSettings;exports.useWorkspacePaneWithId=e.useWorkspacePaneWithId;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});require("react");require("uuid");const e=require("./index.js");require("./models.js");require("./ipc.js");require("./status_params.js");exports.SignalDataInitState=e.SignalDataInitState;exports.calculateMaxActiveProjectDataIntervals=e.calculateMaxActiveProjectDataIntervals;exports.calculateMaxActiveSessionDataIntervals=e.calculateMaxActiveSessionDataIntervals;exports.calculateOverallStatusLevel=e.calculateOverallStatusLevel;exports.calculateOverallStatusLevelFromBusStatus=e.calculateOverallStatusLevelFromBusStatus;exports.limitBuffer=e.limitBuffer;exports.mergeAndDeduplicateFrames=e.mergeAndDeduplicateFrames;exports.mergeData=e.mergeData;exports.mergeFrameDataMaps=e.mergeFrameDataMaps;exports.performRedo=e.performRedo;exports.performSet=e.performSet;exports.performUndo=e.performUndo;exports.useAvailableProtocols=e.useAvailableProtocols;exports.useDevices=e.useDevices;exports.useFixedPositionModeMeasurementData=e.useFixedPositionModeMeasurementData;exports.useIsOnline=e.useIsOnline;exports.useLanguage=e.useLanguage;exports.useLocalizedStrings=e.useLocalizedStrings;exports.useLogMessages=e.useLogMessages;exports.useMaxDataBytes=e.useMaxDataBytes;exports.useMeasurementSetup=e.useMeasurementSetup;exports.useMeasurementStatus=e.useMeasurementStatus;exports.useMessageData=e.useMessageData;exports.useMessageLogFileFormats=e.useMessageLogFileFormats;exports.useNewMeasurementData=e.useNewMeasurementData;exports.useNodeStatus=e.useNodeStatus;exports.useNumericRadix=e.useNumericRadix;exports.useOnlineStatus=e.useOnlineStatus;exports.useOnlineStatusSync=e.useOnlineStatusSync;exports.useOverallStatusLevel=e.useOverallStatusLevel;exports.useProjectData=e.useProjectData;exports.useProjectDataSlice=e.useProjectDataSlice;exports.useRecentProjectFiles=e.useRecentProjectFiles;exports.useRunningPeriodicTransmissions=e.useRunningPeriodicTransmissions;exports.useScrollModeMeasurementData=e.useScrollModeMeasurementData;exports.useSessionData=e.useSessionData;exports.useSessionDataSlice=e.useSessionDataSlice;exports.useSignalData=e.useSignalData;exports.useSignalDataEnvelopes=e.useSignalDataEnvelopes;exports.useSignalLogFileFormats=e.useSignalLogFileFormats;exports.useUndo=e.useUndo;exports.useUndoRef=e.useUndoRef;exports.useUndoSessionDataSlice=e.useUndoSessionDataSlice;exports.useUserSettings=e.useUserSettings;exports.useWorkspacePaneWithId=e.useWorkspacePaneWithId;
package/dist/hooks.mjs CHANGED
@@ -1,35 +1,53 @@
1
1
  import "react";
2
2
  import "uuid";
3
- import { n as m, z as l, t as g, a as p, u as M, w as S, l as c, d, e as D, A as F, H as L, x, o as P, c as v, q as I, p as N, E as O, m as R, v as j, y as k, F as w, B as y, I as z, k as B, G as W } from "./index.mjs";
4
- import "long";
5
- import "./ElectronAPIFake.mjs";
6
- import "./measurement_settings.mjs";
7
- import "./status_params.mjs";
3
+ import { S as r, N as l, T as n, v as c, t as S, $ as m, F as D, K as g, G as d, a1 as p, a2 as v, a0 as M, q as F, p as P, E as L, y as f, a as x, u as I, m as O, k as j, d as A, e as R, H as U, n as B, A as N, s as y, c as k, x as w, _ as z, w as E, Q as T, P as W, l as b, z as h, B as q, V as G, X as H, I as J, J as K, o as Q, a4 as V, a3 as X, Y, j as Z, Z as _ } from "./index.mjs";
4
+ import "./models.mjs";
8
5
  import "./ipc.mjs";
6
+ import "./status_params.mjs";
9
7
  export {
10
- m as useDevices,
11
- l as useFixedPositionModeMeasurementData,
12
- g as useIsOnline,
13
- p as useLanguage,
14
- M as useLocalizedStrings,
15
- S as useLogMessages,
16
- c as useMaxDataBytes,
17
- d as useMeasurementSetup,
18
- D as useMeasurementStatus,
19
- F as useMessageData,
20
- L as useMessageLogFileFormats,
21
- x as useNewMeasurementData,
22
- P as useNodeStatus,
23
- v as useNumericRadix,
24
- I as useOnlineStatus,
25
- N as useOverallStatusLevel,
26
- O as useProjectData,
27
- R as useRecentProjectFiles,
28
- j as useRunningPeriodicTransmissions,
29
- k as useScrollModeMeasurementData,
30
- w as useSessionData,
31
- y as useSignalData,
32
- z as useSignalLogFileFormats,
33
- B as useUserSettings,
34
- W as useWorkspacePaneWithId
8
+ r as SignalDataInitState,
9
+ l as calculateMaxActiveProjectDataIntervals,
10
+ n as calculateMaxActiveSessionDataIntervals,
11
+ c as calculateOverallStatusLevel,
12
+ S as calculateOverallStatusLevelFromBusStatus,
13
+ m as limitBuffer,
14
+ D as mergeAndDeduplicateFrames,
15
+ g as mergeData,
16
+ d as mergeFrameDataMaps,
17
+ p as performRedo,
18
+ v as performSet,
19
+ M as performUndo,
20
+ F as useAvailableProtocols,
21
+ P as useDevices,
22
+ L as useFixedPositionModeMeasurementData,
23
+ f as useIsOnline,
24
+ x as useLanguage,
25
+ I as useLocalizedStrings,
26
+ O as useLogMessages,
27
+ j as useMaxDataBytes,
28
+ A as useMeasurementSetup,
29
+ R as useMeasurementStatus,
30
+ U as useMessageData,
31
+ B as useMessageLogFileFormats,
32
+ N as useNewMeasurementData,
33
+ y as useNodeStatus,
34
+ k as useNumericRadix,
35
+ w as useOnlineStatus,
36
+ z as useOnlineStatusSync,
37
+ E as useOverallStatusLevel,
38
+ T as useProjectData,
39
+ W as useProjectDataSlice,
40
+ b as useRecentProjectFiles,
41
+ h as useRunningPeriodicTransmissions,
42
+ q as useScrollModeMeasurementData,
43
+ G as useSessionData,
44
+ H as useSessionDataSlice,
45
+ J as useSignalData,
46
+ K as useSignalDataEnvelopes,
47
+ Q as useSignalLogFileFormats,
48
+ V as useUndo,
49
+ X as useUndoRef,
50
+ Y as useUndoSessionDataSlice,
51
+ Z as useUserSettings,
52
+ _ as useWorkspacePaneWithId
35
53
  };
@@ -127,4 +127,40 @@ export declare const ColumnSettingsIcon: import("@mui/material/OverridableCompon
127
127
  export declare const SearchIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
128
128
  muiName: string;
129
129
  };
130
+ export declare const UndoIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
131
+ muiName: string;
132
+ };
133
+ export declare const RedoIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
134
+ muiName: string;
135
+ };
136
+ export declare const Cursor1Icon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
137
+ muiName: string;
138
+ };
139
+ export declare const Cursor2Icon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
140
+ muiName: string;
141
+ };
142
+ export declare const VisibleIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
143
+ muiName: string;
144
+ };
145
+ export declare const InvisibleIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
146
+ muiName: string;
147
+ };
148
+ export declare const BoldTextIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
149
+ muiName: string;
150
+ };
151
+ export declare const LineThicknessIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
152
+ muiName: string;
153
+ };
154
+ export declare const PlotMarkersIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
155
+ muiName: string;
156
+ };
157
+ export declare const ExpandAllIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
158
+ muiName: string;
159
+ };
160
+ export declare const LeftAxisIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
161
+ muiName: string;
162
+ };
163
+ export declare const RightAxisIcon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
164
+ muiName: string;
165
+ };
130
166
  export { CloseIcon as ClearIcon };