@kvaser/canking-api 7.3.0 → 7.4.0

package/doc_md/models/interfaces/TdcConfiguration.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / TdcConfiguration
+
+# Interface: TdcConfiguration
+
+A message for defining Transmitter-Delay Compensation (TDC) configuration.
+
+## Properties
+
+### offset
+
+> **offset**: `number`
+
+Secondary Sample Point (SSP) offset (mtq).
+
+#### Remarks
+
+```plaintext
+-+---------------+- TX bit
+ |<-- SP -->|
+              -+---------------+- RX bit
+ |<--- TDC --->|<-- SP -->|
+                          |<->| relative SSP offset
+               |<------------>| absolute SSP offset
+ |<------ Secondary SP ------>|
+```
+This value is relative to the Sample Point (SP), unless
+canMODE_TDC_ABS_SP is set. With canMODE_TDC_MANUAL the transmitter delay
+otherwise dynamically measured by the transceiver should be included.
+Required to be zeroed if canMODE_TDC_OFF is set.

package/doc_md/models/interfaces/TriggerSettings.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 

package/doc_md/models/interfaces/WriteFrame.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 

package/doc_md/models/type-aliases/SerializableFrame.md

@@ -0,0 +1,33 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SerializableFrame
+
+# Type Alias: SerializableFrame
+
+> **SerializableFrame** = [`Frame`](../interfaces/Frame.md) & `object`
+
+A serializable version of the Frame type, which can be used in IPC (Inter-Process Communication).
+
+## Type Declaration
+
+### deltaTimeUsParts
+
+> **deltaTimeUsParts**: \{ `high`: `number`; `low`: `number`; `unsigned`: `boolean`; \} \| `undefined`
+
+### timeUsParts
+
+> **timeUsParts**: `object`
+
+#### timeUsParts.high
+
+> **high**: `number`
+
+#### timeUsParts.low
+
+> **low**: `number`
+
+#### timeUsParts.unsigned
+
+> **unsigned**: `boolean`

package/doc_md/models/variables/defaultUserSettings.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 

package/doc_md/modules.md

@@ -1,13 +1,12 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](README.md)
 
 ***
 
-# Kvaser CanKing GUI Extensions SDK v7.3.0
+# Kvaser CanKing GUI Extensions SDK v7.4.0
 
 ## Modules
 
 - [controls](controls/README.md)
 - [hooks](hooks/README.md)
-- [icons](icons/README.md)
 - [ipc](ipc/README.md)
 - [models](models/README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kvaser/canking-api",
-  "version": "7.3.0",
+  "version": "7.4.0",
   "description": "CanKing API to communicate with the CanKing service using Node.js.",
   "author": "Kvaser AB",
   "license": "SEE LICENSE IN EULA.pdf",
@@ -76,9 +76,14 @@
     "build:doc": "typedoc",
     "prebuild:protos": "rimraf ./src/protos && npx mkdirp ./src/protos",
     "prebuild": "rimraf ./dist && npm run build:protos",
+    "prepublishOnly": "npx license-reporter report --only=prod",
     "lint": "cross-env NODE_ENV=development eslint src",
     "package": "npm pack --pack-destination=./out",
-    "prepackage": "rimraf ./out && npx mkdirp ./out && npm run build"
+    "prepackage": "rimraf ./out && npx mkdirp ./out && npm run build",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
     "@electron-toolkit/preload": "^3.0.1",
@@ -88,8 +93,8 @@
     "@grpc/grpc-js": "^1.12.2",
     "@mui/material": "^6.1.3",
     "@mui/x-tree-view": "^7.20.0",
+    "@rc-component/color-picker": "^3.0.2",
     "electron": "^33.0.0",
-    "fast-deep-equal": "^3.1.3",
     "google-protobuf": "^3.21.4",
     "long": "^5.2.3",
     "react": "^18.3.1",
@@ -97,6 +102,9 @@
     "uuid": "^10.0.0"
   },
   "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
     "@types/google-protobuf": "^3.15.12",
     "@types/node": "^22.7.5",
     "@types/react": "^18.3.11",
@@ -105,6 +113,8 @@
     "@typescript-eslint/eslint-plugin": "^8.9.0",
     "@typescript-eslint/parser": "^8.9.0",
     "@vitejs/plugin-react-swc": "^3.7.1",
+    "@vitest/coverage-v8": "^4.0.5",
+    "@vitest/ui": "^4.0.5",
     "cross-env": "^7.0.3",
     "eslint": "^9.12.0",
     "eslint-config-prettier": "^9.1.0",
@@ -113,6 +123,7 @@
     "eslint-plugin-react-hooks": "^5.0.0",
     "eslint-plugin-tsdoc": "^0.3.0",
     "grpc-tools": "^1.11.3",
+    "jsdom": "^27.1.0",
     "license-reporter": "^1.3.0",
     "prettier": "^3.3.3",
     "prop-types": "^15.8.1",
@@ -124,7 +135,8 @@
     "typedoc-plugin-markdown": "^4.8.1",
     "typescript": "^5.6.3",
     "vite": "^5.4.9",
-    "vite-plugin-externalize-deps": "^0.8.0"
+    "vite-plugin-externalize-deps": "^0.8.0",
+    "vitest": "^4.0.5"
   },
   "prettier": {
     "singleQuote": true,

package/dist/ElectronAPIFake.js

@@ -1 +0,0 @@
-"use strict";var g=Object.defineProperty;var d=(r,e,s)=>e in r?g(r,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[e]=s;var t=(r,e,s)=>d(r,typeof e!="symbol"?e+"":e,s);require("long");const v=require("./measurement_settings.js");class F{constructor(e){t(this,"userSettings");this.userSettings=e}on(e,s){return()=>{}}once(e,s){return()=>{}}removeAllListeners(e){}removeListener(e,s){return this}send(e,...s){}invoke(e,...s){switch(e){case"rpc-get-devices":const n=[];return Promise.resolve(n);case"app-get-session-data":return Promise.resolve(null);case"app-get-user-settings":return Promise.resolve(this.userSettings);case"rpc-get-online-status":const o={isOnline:!1};return Promise.resolve(o);case"rpc-get-node-statuses":const c=[];return Promise.resolve(c);case"prj-get-meas-setup":return Promise.resolve(v.MeasurementSetup.create());case"prj-get-workspaces":const i=[];return Promise.resolve(i);case"prj-get-workspace-panes":const l=[];return Promise.resolve(l);case"app-get-workspace-view-session-data":case"rpc-start-periodic-transmission":return Promise.resolve("");case"rpc-get-message-log-file-formats":const m=[];return Promise.resolve(m);case"rpc-get-signal-log-file-formats":const u=[];return Promise.resolve(u);case"rpc-get-frame-definitions":const p=[];return Promise.resolve(p);case"mm-get-measurement-data-before-timestamp":return Promise.resolve(frames);case"mm-get-latest-timestamp":return Promise.resolve(0);default:return Promise.resolve()}}postMessage(e,s,n){}sendSync(e,...s){}sendTo(e,s,...n){}sendToHost(e,...s){}}class P{insertCSS(e){return""}setZoomFactor(e){}setZoomLevel(e){}}class f{constructor(){t(this,"platform");t(this,"versions");t(this,"env")}}const a=r=>{const e={version:"1.0.0",theme:"light",language:"en",strings:{},showToolsPanel:!0,useHexNumericBase:!0,maxDataBytes:16,defaultProjectFolder:"",defaultLogFilesFolder:"",defaultCANDatabasesFolder:"",defaultLINDatabasesFolder:"",currentProjectFile:"",currentProjectFileName:"",recentProjectFiles:[],closeAppServiceAction:"prompt"};return{ipcRenderer:new F(r??e),webFrame:new P,process:new f}},h=a();exports.createElectronApiFake=a;exports.electronApiFake=h;

package/dist/ElectronAPIFake.mjs

@@ -1,273 +0,0 @@
-var p = Object.defineProperty;
-var g = (r, e, s) => e in r ? p(r, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : r[e] = s;
-var t = (r, e, s) => g(r, typeof e != "symbol" ? e + "" : e, s);
-import "long";
-import { aJ as d } from "./measurement_settings.mjs";
-class v {
-  /**
-   * Creates a new IpcRendererFake.
-   */
-  constructor(e) {
-    t(this, "userSettings");
-    this.userSettings = e;
-  }
-  /**
-   * Listens to `channel`, when a new message arrives `listener` would be called with
-   * `listener(event, args...)`.
-   */
-  on(e, s) {
-    return () => {
-    };
-  }
-  /**
-   * Adds a one time `listener` function for the event. This `listener` is invoked
-   * only the next time a message is sent to `channel`, after which it is removed.
-   */
-  once(e, s) {
-    return () => {
-    };
-  }
-  /**
-   * Removes all listeners, or those of the specified `channel`.
-   */
-  removeAllListeners(e) {
-  }
-  /**
-   * Removes the specified `listener` from the listener array for the specified
-   * `channel`.
-   *
-   * @deprecated Use `on` listen return instead
-   *
-   */
-  removeListener(e, s) {
-    return this;
-  }
-  /**
-   * Send an asynchronous message to the main process via `channel`, along with
-   * arguments. Arguments will be serialized with the Structured Clone Algorithm,
-   * just like `window.postMessage`, so prototype chains will not be included.
-   * Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw an
-   * exception.
-   *
-   * **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
-   * Electron objects will throw an exception.
-   *
-   * Since the main process does not have support for DOM objects such as
-   * `ImageBitmap`, `File`, `DOMMatrix` and so on, such objects cannot be sent over
-   * Electron's IPC to the main process, as the main process would have no way to
-   * decode them. Attempting to send such objects over IPC will result in an error.
-   *
-   * The main process handles it by listening for `channel` with the `ipcMain`
-   * module.
-   *
-   * If you need to transfer a `MessagePort` to the main process, use
-   * `ipcRenderer.postMessage`.
-   *
-   * If you want to receive a single response from the main process, like the result
-   * of a method call, consider using `ipcRenderer.invoke`.
-   */
-  send(e, ...s) {
-  }
-  /**
-   * Resolves with the response from the main process.
-   *
-   * Send a message to the main process via `channel` and expect a result
-   * asynchronously. Arguments will be serialized with the Structured Clone
-   * Algorithm, just like `window.postMessage`, so prototype chains will not be
-   * included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw
-   * an exception.
-   *
-   * **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
-   * Electron objects will throw an exception.
-   *
-   * Since the main process does not have support for DOM objects such as
-   * `ImageBitmap`, `File`, `DOMMatrix` and so on, such objects cannot be sent over
-   * Electron's IPC to the main process, as the main process would have no way to
-   * decode them. Attempting to send such objects over IPC will result in an error.
-   *
-   * The main process should listen for `channel` with `ipcMain.handle()`.
-   *
-   * For example:
-   *
-   * If you need to transfer a `MessagePort` to the main process, use
-   * `ipcRenderer.postMessage`.
-   *
-   * If you do not need a response to the message, consider using `ipcRenderer.send`.
-   */
-  invoke(e, ...s) {
-    switch (e) {
-      case "rpc-get-devices":
-        const n = [];
-        return Promise.resolve(n);
-      case "app-get-session-data":
-        return Promise.resolve(null);
-      case "app-get-user-settings":
-        return Promise.resolve(this.userSettings);
-      case "rpc-get-online-status":
-        const a = { isOnline: !1 };
-        return Promise.resolve(a);
-      case "rpc-get-node-statuses":
-        const o = [];
-        return Promise.resolve(o);
-      case "prj-get-meas-setup":
-        return Promise.resolve(d.create());
-      case "prj-get-workspaces":
-        const c = [];
-        return Promise.resolve(c);
-      case "prj-get-workspace-panes":
-        const i = [];
-        return Promise.resolve(i);
-      case "app-get-workspace-view-session-data":
-      case "rpc-start-periodic-transmission":
-        return Promise.resolve("");
-      case "rpc-get-message-log-file-formats":
-        const l = [];
-        return Promise.resolve(l);
-      case "rpc-get-signal-log-file-formats":
-        const m = [];
-        return Promise.resolve(m);
-      case "rpc-get-frame-definitions":
-        const u = [];
-        return Promise.resolve(u);
-      case "mm-get-measurement-data-before-timestamp":
-        return Promise.resolve(frames);
-      case "mm-get-latest-timestamp":
-        return Promise.resolve(0);
-      default:
-        return Promise.resolve();
-    }
-  }
-  /**
-   * Send a message to the main process, optionally transferring ownership of zero or
-   * more `MessagePort` objects.
-   *
-   * The transferred `MessagePort` objects will be available in the main process as
-   * `MessagePortMain` objects by accessing the `ports` property of the emitted
-   * event.
-   *
-   * **NOTE:** Cannot transfer these when `contextIsolation: true`.
-   *
-   * For example:
-   *
-   * For more information on using `MessagePort` and `MessageChannel`, see the MDN
-   * documentation.
-   */
-  postMessage(e, s, n) {
-  }
-  /**
-   * The value sent back by the `ipcMain` handler.
-   *
-   * Send a message to the main process via `channel` and expect a result
-   * synchronously. Arguments will be serialized with the Structured Clone Algorithm,
-   * just like `window.postMessage`, so prototype chains will not be included.
-   * Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw an
-   * exception.
-   *
-   * **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
-   * Electron objects will throw an exception.
-   *
-   * Since the main process does not have support for DOM objects such as
-   * `ImageBitmap`, `File`, `DOMMatrix` and so on, such objects cannot be sent over
-   * Electron's IPC to the main process, as the main process would have no way to
-   * decode them. Attempting to send such objects over IPC will result in an error.
-   *
-   * The main process handles it by listening for `channel` with `ipcMain` module,
-   * and replies by setting `event.returnValue`.
-   *
-   * warning: **WARNING**: Sending a synchronous message will block the whole
-   * renderer process until the reply is received, so use this method only as a last
-   * resort. It's much better to use the asynchronous version, `invoke()`.
-   */
-  sendSync(e, ...s) {
-  }
-  /**
-   * Sends a message to a window with `webContentsId` via `channel`.
-   *
-   * @deprecated This methond has been removed since Electron 28.
-   */
-  sendTo(e, s, ...n) {
-  }
-  /**
-   * Like `ipcRenderer.send` but the event will be sent to the `<webview>` element in
-   * the host page instead of the main process.
-   */
-  sendToHost(e, ...s) {
-  }
-}
-class F {
-  /**
-   * A key for the inserted CSS that can later be used to remove the CSS via
-   * `webFrame.removeInsertedCSS(key)`.
-   *
-   * Injects CSS into the current web page and returns a unique key for the inserted
-   * stylesheet.
-   */
-  insertCSS(e) {
-    return "";
-  }
-  /**
-   * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
-   * divided by 100, so 300% = 3.0.
-   *
-   * The factor must be greater than 0.0.
-   */
-  setZoomFactor(e) {
-  }
-  /**
-   * Changes the zoom level to the specified level. The original size is 0 and each
-   * increment above or below represents zooming 20% larger or smaller to default
-   * limits of 300% and 50% of original size, respectively.
-   *
-   * **NOTE**: The zoom policy at the Chromium level is same-origin, meaning that
-   * the zoom level for a specific domain propagates across all instances of windows
-   * with the same domain. Differentiating the window URLs will make zoom work
-   * per-window.
-   */
-  setZoomLevel(e) {
-  }
-}
-class P {
-  constructor() {
-    /**
-     * The process.platform property returns a string identifying the operating system platform
-     * on which the Node.js process is running.
-     */
-    t(this, "platform");
-    /**
-     * A list of versions for the current node.js/electron configuration.
-     */
-    t(this, "versions");
-    /**
-     * The process.env property returns an object containing the user environment.
-     */
-    t(this, "env");
-  }
-}
-const f = (r) => {
-  const e = {
-    version: "1.0.0",
-    theme: "light",
-    language: "en",
-    strings: {},
-    showToolsPanel: !0,
-    useHexNumericBase: !0,
-    maxDataBytes: 16,
-    defaultProjectFolder: "",
-    defaultLogFilesFolder: "",
-    defaultCANDatabasesFolder: "",
-    defaultLINDatabasesFolder: "",
-    currentProjectFile: "",
-    currentProjectFileName: "",
-    recentProjectFiles: [],
-    closeAppServiceAction: "prompt"
-  };
-  return {
-    ipcRenderer: new v(r ?? e),
-    webFrame: new F(),
-    process: new P()
-  };
-}, S = f();
-export {
-  f as c,
-  S as e
-};