@deeptrekker/api-domain 0.61.5 → 1.0.0

package/dist/constants/versions/index.d.ts

@@ -1 +1 @@
-export declare const API_VERSION = "0.61.5";
+export declare const API_VERSION = "1.0.0";

package/dist/constants/versions/index.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API_VERSION = void 0;
 /* AUTO GENERATED FILE */
-exports.API_VERSION = "0.61.5";
+exports.API_VERSION = "1.0.0";

package/dist/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./types";
 export * from "./constants";
-export * from "./samples";
 export * from "./utils";

package/dist/index.js

@@ -16,5 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
 __exportStar(require("./constants"), exports);
-__exportStar(require("./samples"), exports);
 __exportStar(require("./utils"), exports);

package/dist/types/clients/index.d.ts

@@ -6,6 +6,8 @@ import { SerialDevice } from "../devices/serial";
 import { Sonar } from "../devices/sonar";
 /**
  * Network Diagnostics Physical Location enum
+ * @category Diagnostics
+ * @group Devices
  */
 export declare enum PhysicalLocation {
     Local = "LOC",
@@ -13,6 +15,8 @@ export declare enum PhysicalLocation {
 }
 /**
  * Network Diagnostics Physical Location enum
+ * @category Diagnostics
+ * @group Devices
  */
 export declare enum NetworkRole {
     CentralCoordinator = "CCO",
@@ -20,92 +24,147 @@ export declare enum NetworkRole {
 }
 /**
  * System unit of measurement enum
+ * @category Core
+ * @group Devices
  */
 export declare enum SystemOfMeasurement {
     Imperial = "IMPERIAL",
     Metric = "METRIC"
 }
+/**
+ * The diagnostics for a network device. For the BridgeBox there should be a local and remote device.
+ *
+ * @example
+ * ```json
+ * {
+ *  "networkDevices": {
+ *      "local": {
+ *          "interfaceName": "ETH0",
+ *          "physicalLocation": "LOC",
+ *          "networkRole": "CCO",
+ *          "terminalEndpointIdentifier": "192.168.1.1",
+ *          "bridgedDestinationAddress": "00:1A:2B:3C:4D:5E",
+ *          "outboundRate": "100",
+ *          "inboundRate": "100",
+ *          "chipset": "Qualcomm",
+ *          "firmwareVersion": "1.0.0"
+ *      },
+ *      "remote": {
+ *          "interfaceName": "ETH1",
+ *          "physicalLocation": "REM",
+ *          "networkRole": "STA",
+ *          "terminalEndpointIdentifier": "192.168.1.2",
+ *          "bridgedDestinationAddress": "00:1A:2B:3C:4D:5F",
+ *          "outboundRate": "50",
+ *          "inboundRate": "50",
+ *          "chipset": "Broadcom",
+ *          "firmwareVersion": "1.0.0"
+ *      }
+ * }
+ * ```
+ * @readonly
+ * @category Diagnostics
+ * @group Devices
+ */
 export type NetworkDiagnostics = {
     /**
+     * @remarks
      * Network interface name.
      *
      * e.g. "ETH0", "ETH1", etc
      *
      * @readonly
      */
-    interfaceName: String;
+    interfaceName: string;
     /**
-     * May be local or remote
+     * @remarks
+     * The physical location of the device. Can be either local or remote.
+     *
+     * @see {@link PhysicalLocation | PhysicalLocation}
      *
      * @readonly
      */
     physicalLocation: PhysicalLocation;
     /**
-     * CCO (Central Coordinator) or STA (Station)
+     * @remarks
+     * The role of the device in the network. Can be either Central Coordinator (CCO) or Station (STA).
      *
+     * @see {@link NetworkRole | NetworkRole}
      * @readonly
      */
     networkRole: NetworkRole;
     /**
-     * A local address
+     * @remarks
+     * The location address of the device.
      *
      * @readonly
      */
-    terminalEndpointIdentifier: String;
+    terminalEndpointIdentifier: string;
     /**
      * MAC of corresponding ethernet IFace behind VDSL
      *
      * @readonly
      */
-    bridgedDestinationAddress: String;
+    bridgedDestinationAddress: string;
     /**
-     * Mbps
+     * @remarks
+     * Outbound transfer rate (in Mbps)
      *
      * @readonly
      */
-    outboundRate: String;
+    outboundRate: string;
     /**
-     * Mbps
+     * @remarks
+     * Inbound transfer rate (in Mbps)
      *
      * @readonly
      */
-    inboundRate: String;
+    inboundRate: string;
     /**
+     * @remarks
      * Hardware chipset name
      *
      * @readonly
      */
-    chipset: String;
+    chipset: string;
     /**
+     * @remarks
      * The device firmware version
      *
      * @readonly
      */
-    firmwareVersion: String;
+    firmwareVersion: string;
 };
 /**
- * systemDiagnostics
+ * SystemDiagnostics
+ *
+ * @category Diagnostics
+ * @group Devices
  */
-export type systemDiagnostics = {
+export type SystemDiagnostics = {
     /**
+     * @remarks
      * CPU usage percent of the back-end application
      *
      * @readonly
      */
     conGuiCpuUsage?: number;
     /**
+     * @remarks
      * Memory usage percent of the back-end application
      *
      * @readonly
      */
     conGuiMemUsage?: number;
     /**
+     * @remarks
      * Total percent of CPU in use
      *
      * @readonly
      */
     totalCpuUsage?: number;
     /**
+     * @remarks
      * Total percent of memory in use
      *
      * @readonly
@@ -113,189 +172,260 @@ export type systemDiagnostics = {
     totalMemUsage?: number;
 };
 /**
- * Handles Clearing of all faults across all devices.
+ * Handles Clearing of all faults across all devices, in a centralized location
+ *
+ * @category Diagnostics
+ * @group Devices
  */
 export type FaultHandler = {
     /**
-     * Non-gettable value that can be SET to true to clear all faults.
+     * @remarks
+     * When sent to the server, clears all faults from all devices.
+     *
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "SET",
+     *   "payload": {
+     *     "faults": {
+     *       "clear": true
+     *     }
+     *   }
+     * }
+     * ```
      */
     clear?: boolean;
 };
 /**
  * BRIDGE Box represents the root of the API endpoint routing
  *
- * TODO: Currently this is a pretty bare bones class, but in the
- * future it will be extended to hold interfaces to other subsystems
- * on the BRIDGE Box. These could include hardware access, storage
- * devices, network interfaces, update system, etc...
+ * This is the top-level type that contains all other types and endpoints.
+ * It is used to represent the state of the BridgeBox and its associated devices.
+ *
+ * @category Core
+ * @group Devices
  */
 export type BridgeBox = {
     /**
-     * Devices
+     * @remarks
      *
-     * This contains a list of devices and associated UUIDs
+     * This contains a list of devices and associated mac addresses
      * for accessing connected devices, such as vehicles, reels, etc.
      *
-
+     * See a specific device type for more information. (Crawler, ROV, etc.)
+     * @example
+     * ```json
+     * {
+     *   "device1_mac": {
+     *     "model": "14", //This is the only required property. It is used to denote which device is being referenced.
+     *   },
+     *   "device2_mac": {
+     *     "model": "13", //See {@link DeviceModel | DeviceModel} for valid properties
+     *   }
+     * }
+     * ```
+     *
+     * @see {@link Devices | Devices}
      */
     devices?: Record<string, Removable<Devices>>;
     /**
-     * Fault Handler
+     * @remarks
+     *
+     * Allows users to clear faults from all of their devices. The BridgeBox will not send anything for this value,
+     * but if it receives it then it clears all active faults from any connected device.
+     *
+     * @example
+     * ```json
+     * {
+     *   "faults": {
+     *     "clear": true
+     *   }
+     * }
+     *```
+     * @see {@link FaultHandler | FaultHandler}
      *
-     * Allows users to clear faults from all of their devices
-     * {@codeblock ~~/dist/samples/json/requests/devices/faults/clearFaults/clearFaultsSample.json}
      */
     faults?: FaultHandler;
     /**
-     * Version
+     * @remarks
      *
      * The BridgeBox version will be incremented when backend services or operating
      * system updates are available. This type should be checked against the BridgeBox
      * version provided within the update package meta data.
+     *
+     * @see {@link DeviceVersion | DeviceVersion}
      */
     version?: DeviceVersion;
     /**
-     * SWUpdate
-     *
-     * ### Offline Update Samples
-     *
-     * - Check for offline updates
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxCheckOfflineUpdatesSample.json}
-     *
-     * - Offline updates available
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxOfflineUpdatesAvailableSample.json}
-     *
-     * - System up-to-date (No new offline updates available)
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxNoOfflineUpdatesAvailableSample.json}
-     *
-     * - Start offline updates
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/swupdate/bridgeBoxStartOfflineUpdatesSample.json}
+     * @remarks
+     *
+     * This is the software update endpoint for the BridgeBox.
+     * It contains information about the current software update state, available updates,
+     * and progress of the update.
+     *
+     * @example
+     * ```json
+     * {
+     *  "swupdate": {
+     *      "progress": 50
+     *   }
+     * }
+     * ```
+     * @see {@link SWUpdate | SWUpdate}
      */
     swupdate?: SWUpdate;
     /**
-     * SystemSettings
+     * @remarks
+     *
+     * An endpoint to facilitate requesting and adjusting system settings. Allows time and system of measurement adjustments.
+     *
+     * @see {@link SystemSettings | SystemSettings}
      */
     systemSettings?: SystemSettings;
     /**
-     * NetworkDiagnostics
+     * @remarks
      *
-     * Record of known network interfaces on the bridgebox and their live performance diagnostics.
+     * Record of known network interfaces on the BridgeBox and their live performance diagnostics.
      *
      * Multiple records may be correlated to a single `interfaceName`. There will typically be two
      * records for a given `interfaceName` to represent local and remote mac addresses of the
      * network connection. Records here are differentiated by the network card's unique MAC Address.
      *
+     * @see {@link NetworkDiagnostics | NetworkDiagnostics}
      * @readonly
      *
-     * @outputSample clients
      */
     networkDiagnostics?: Record<string, NetworkDiagnostics>;
     /**
-     * SerialDevices
-     *
-     *
-     * This list contains all the serial devices that the backend can modify and communicate with.
-     *
-     * It can be updated with a new key(generated by the frontend) to create a WebSerialDevice
-     *
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/serialDevices/bridgeBoxSerialDevicesSample.json}
+     * @remarks
+     *
+     * This list contains all the serial devices that the backend can modify and communicate with. This is how we
+     * achieve serial-over-ip.
+     *
+     * It can be updated with a new key(generated by the frontend) to create a WebSerialDevice.
+     *
+     * @example
+     * ```json
+     * {
+     *   "serialDevices": {
+     *      "External GPS Source": {
+     *          "deviceType": "Internal",
+     *          "baudRate": 115200,
+     *          "name": "External GPS Source",
+     *          "connectionId": "xHCI Host Controller 1",
+     *          "connectionName": "Bottom USB Port"
+     *      },
+     *      "xHCI Host Controller 1": {
+     *          "deviceType": "Controller",
+     *          "baudRate": 115200,
+     *          "name": "xHCI Host Controller 1",
+     *          "connectionId": "External GPS",
+     *          "connectionName": "Gps Source"
+     *      }
+     *   }
+     * }
+     * ```
+     *
+     * @see {@link SerialDevice | SerialDevice}
      */
     serialDevices?: Record<string, SerialDevice>;
     /**
-     * Sonar
+     * @remarks
      *
-     * This is the currently connected sonar device
+     * Endpoint for the connected sonar. There can only be one sonar device connected at a time.
+     *
+     * @see {@link Sonar | Sonar} for more information.
      */
     sonar?: Sonar;
     /**
-     * Enable Passthrough.
+     * @remarks
+     *
+     * Can be set to enable passthrough mode on the BridgeBox, which determines if the device will serve or receive DHCP requests.
      *
-     * Can be set to enable passthrough mode on the bridgebox which modifies its network capabilities
+     * This is useful for scenarios where the BridgeBox needs to act as a DHCP relay or when integrating with existing network infrastructure.
+     *
+     * @example
+     * ```json
+     * {
+     *   "enablePassthrough": true
+     * }
+     * ```
      */
     enablePassthrough?: boolean;
     /**
-     * SystemDiagnostics
-     *
+     * @remarks
+     *
+     * Raw usage values from the hardware running the BridgeBox. (e.g. CPU and memory usage)
+     *
+     * @example
+     * ```json
+     * {
+     *  "systemDiagnostics": {
+     *      "conGuiCpuUsage": 25,
+     *      "conGuiMemUsage": 60,
+     *      "totalCpuUsage": 75,
+     *      "totalMemUsage": 80
+     *  }
+     * }
+     * ```
+     *
+     * @see {@link SystemDiagnostics | SystemDiagnostics}
      * @readonly
      *
      */
-    systemDiagnostics?: systemDiagnostics;
+    systemDiagnostics?: SystemDiagnostics;
 };
 /**
  * SystemSettings
  *
  * An endpoint to facilitate requesting and adjusting system settings.
+ * @category Core
+ * @group Devices
  */
 export type SystemSettings = {
     /**
-     * Date Time
-     *
-     * Date time settings for setting/getting the system time
-     *
-     * ## NetworkTimeSync network examples
-     *
-     * ### NetworkTimeSync enabled
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNetworkTimeSyncEnabledSample.json}
-     *
-     * ### NetworkTimeSync disabled
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNetworkTimeSyncDisabledSample.json}
-     *
-     *
-     * ## Timestamp examples
-     *
-     * References:
-     * - [Timezone IDs](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
-     * - [Temporal Formatting](https://tc39.es/proposal-temporal/docs/index.html#Temporal-Calendar)
-     *
-     * ### Local
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLocaleSample.json}
-     *
-     * ### UTC
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeUTCSample.json}
-     *
-     * ### Greenwich
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeGreenwichSample.json}
-     *
-     * ### Europe/London
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLondonSample.json}
-     *
-     * ### America/Los_Angeles
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLosAngelesSample.json}
-     *
-     * ### America/New_York
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNewYorkSample.json}
-     *
-     * ### Asia/Tokyo
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeTokyoSample.json}
-     *
-     * ### America/Toronto
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeTorontoSample.json}
-     *
+     * @remarks
+     * The date time settings for the BridgeBox. Includes the ability to set the system time and configure NTP synchronization.
+     *
+     * @example
+     * ```json
+     * {
+     *  "systemSettings": {
+     *      "timestamp": "2025-08-06T09:26:48.244808241-04:00[America/Toronto]", //Toronto TZ
+     *      "networkTimeSync": true
+     *  }
+     * }
+     * ```
+     * @see {@link DateTime | DateTime}
+     * {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | Timezone Ids (External)}
+     * {@link https://tc39.es/proposal-temporal/docs/index.html#Temporal-Calendar | Temporal Formatting (External)}
      */
     dateTime?: DateTime;
     /**
-     * System of measurement
-     *
-     * The system of measurement that the BridgeBox will use
-     *
-     * ## SystemOfMeasurement examples
-     *
-     * ### METRIC
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/systemOfMeasurement/bridgeBoxSystemSettingsSystemOfMeasurementMetricSample.json}
-     *
-     * ### IMPERIAL
-     * {@codeblock ~~/dist/samples/json/requests/bridgeBox/systemSettings/systemOfMeasurement/bridgeBoxSystemSettingsSystemOfMeasurementImperialSample.json}
+     * @remarks The system of measurement that the BridgeBox will use. Can be either metric or imperial.
+     *
+     * @example
+     * ```json
+     * {
+     *  "systemSettings": {
+     *      "systemOfMeasurement": "metric"
+     *  }
+     * }
+     * ```
+     * @see {@link SystemOfMeasurement | SystemOfMeasurement}
      */
     systemOfMeasurement?: SystemOfMeasurement;
 };
 /**
- * DateTime
- *
+ * @remarks
  * An endpoint to facilitate requesting and adjusting the datetime of the BridgeBox.
+ * @group Server
+ * @category Core
  */
 export type DateTime = {
     /**
-     * Timestamp
+     * @remarks
      *
      * Used to define the system time.
      *
@@ -306,7 +436,7 @@ export type DateTime = {
      */
     timestamp?: string;
     /**
-     * Automatic Date Time Network Sync
+     * @remarks
      *
      * Automatically sync date and time with the NTP server (requires a network connection with an NTP server to sync time)
      */

package/dist/types/clients/index.js

@@ -3,25 +3,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemOfMeasurement = exports.NetworkRole = exports.PhysicalLocation = void 0;
 /**
  * Network Diagnostics Physical Location enum
+ * @category Diagnostics
+ * @group Devices
  */
 var PhysicalLocation;
 (function (PhysicalLocation) {
     PhysicalLocation["Local"] = "LOC";
     PhysicalLocation["Remote"] = "REM";
-})(PhysicalLocation = exports.PhysicalLocation || (exports.PhysicalLocation = {}));
+})(PhysicalLocation || (exports.PhysicalLocation = PhysicalLocation = {}));
 /**
  * Network Diagnostics Physical Location enum
+ * @category Diagnostics
+ * @group Devices
  */
 var NetworkRole;
 (function (NetworkRole) {
     NetworkRole["CentralCoordinator"] = "CCO";
     NetworkRole["Station"] = "STA";
-})(NetworkRole = exports.NetworkRole || (exports.NetworkRole = {}));
+})(NetworkRole || (exports.NetworkRole = NetworkRole = {}));
 /**
  * System unit of measurement enum
+ * @category Core
+ * @group Devices
  */
 var SystemOfMeasurement;
 (function (SystemOfMeasurement) {
     SystemOfMeasurement["Imperial"] = "IMPERIAL";
     SystemOfMeasurement["Metric"] = "METRIC";
-})(SystemOfMeasurement = exports.SystemOfMeasurement || (exports.SystemOfMeasurement = {}));
+})(SystemOfMeasurement || (exports.SystemOfMeasurement = SystemOfMeasurement = {}));