@deeptrekker/api-domain 0.61.6 → 1.0.0

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

@@ -4,30 +4,53 @@
  * TransferPayload represents the payload structure that should
  * be used via an API to send a payload with a specific load type.
  *
- * @typeParam T - BridgeBox
  *
  * @category Core
+ * @group Server
  * @example
- * <br>
- * {@codeblock ~~/dist/samples/json/requests/errors/notAccepted405.json}
+ * ```json
+ * {
+ *   "apiVersion": "1.0.0",
+ *   "method": "SET",
+ *   "payload": {
+ *     "devices": {
+ *       "001A2B3C4D5E": {
+ *          "model": 13,
+ *          "auxLight": {
+ *            "intensity": 100
+ *          }
+ *        }
+ *     }
+ *   }
+ * }
+ * ```
  */
 export type TransferPayload<T> = {
     /**
-     * API target version (defaults to the latest)
+     * @remarks
+     * API target version (defaults to the latest). The server's version will not reflect the API version.
      *
      * @pattern (^[0-9]{1,3}[.][0-9]{1,3}([.][0-9]{1,3})?.*$)
      * */
     apiVersion: string;
     /**
-     * Method action type
+     * @remarks
+     * The action type for the payload. Indicates whether it's sent  or received, and how the payload should be handled.
+     *
+     * @see {@link TransferMethodType | TransferMethodType}
      */
     method: TransferMethodType;
     /**
-     * Transfer error type
+     * @remarks
+     * Transfer error type that the server sends for a variety of reasons.
+     *
+     * @see {@link TransferError | TransferError}
+     * @readonly
      */
     error?: TransferError;
     /**
-     * Payload
+     * @remarks
+     * The payload that the API expects to receive. .
      */
     payload: T;
 };
@@ -36,10 +59,14 @@ export type TransferPayload<T> = {
  *
  * Represents a movement command with speed and position.
  *
- * @category Core
+ * @category Controls
+ * @group X4
+ * @alpha
+ * @internal
  */
 export type Movement = {
     /**
+     * @remarks
      * Speed of the movement as a rate.
      *
      * @minimum -100
@@ -47,20 +74,25 @@ export type Movement = {
      */
     speed?: number;
     /**
+     * @remarks
      * Set position of the movement. (e.g. currentPosition + distance). Can only move a maximum of 1 meter.
      * This is in meters.
      */
     position?: number;
     /**
+     * @remarks
      * Whether to enable or disable the associated movement thruster.
      */
     enabled?: boolean;
 };
 /**
  * The different kinds of payload requests that can be sent and received.
+ * @category Core
+ * @group Server
  */
 export declare enum TransferMethodType {
     /**
+     * @remarks
      * Used to request a payload response to be sent by the receiving end.
      *
      * | Feature | Description |
@@ -68,11 +100,18 @@ export declare enum TransferMethodType {
      * | HTTP Method | Like GET |
      * | Idempotent | ✅ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferGetRequest.json}
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "GET",
+     *   "payload": {}
+     * }
+     * ```
      * */
     Get = "GET",
     /**
+     * @remarks
      * A request by a client to set data on the device server.
      *
      * | Feature | Description |
@@ -80,11 +119,26 @@ export declare enum TransferMethodType {
      * | HTTP Method | Like POST/PUT |
      * | Idempotent | ❌ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferSetRequest.json}
+     * @example
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "SET",
+     *   "payload": {
+     *     "devices": {
+     *       "001A2B3C4D5E": {
+     *          "model": 13,
+     *          "auxLight": {
+     *            "intensity": 100
+     *          }
+     *        }
+     *     }
+     *   }
+     * }
+     * ```
      * */
     Set = "SET",
     /**
+     * @remarks
      * A request by the device server to update data on the client.
      *
      * | Feature | Description |
@@ -92,11 +146,27 @@ export declare enum TransferMethodType {
      * | HTTP Method | Like POST/PUT |
      * | Idempotent | ❌ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferUpdateRequest.json}
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "UPDATE",
+     *   "payload": {
+     *     "devices": {
+     *       "001A2B3C4D5E": {
+     *          "model": 13,
+     *          "auxLight": {
+     *            "intensity": 100
+     *          }
+     *        }
+     *     }
+     *   }
+     * }
+     * ```
      * */
     Update = "UPDATE",
     /**
+     * @remarks
      * A request by the device server to remove data on the client.
      *
      * | Feature | Description |
@@ -104,11 +174,22 @@ export declare enum TransferMethodType {
      * | HTTP Method | Like POST/PUT |
      * | Idempotent | ❌ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferDeleteRequest.json}
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "DELETE",
+     *   "payload": {
+     *     "devices": {
+     *       "001A2B3C4D5E": {} //Delete the reference to this device with this mac address.
+     *     }
+     *   }
+     * }
+     * ```
      * */
     Delete = "DELETE",
     /**
+     * @remarks
      * A response sent to communicate errors.
      *
      * | Feature | Description |
@@ -116,13 +197,27 @@ export declare enum TransferMethodType {
      * | HTTP Response | Like 4xx, 5xx errors. See {@link ErrorCode | ErrorCodes}. |
      * | Idempotent | ✅ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferErrorRequest.json}
-     * */
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "ERROR",
+     *   "error": {
+     *      "code": 400,
+     *      "message": "Invalid data or payload is malformed."
+     *     },
+     *   "payload": {}
+     *   }
+     * }
+     * ```
+     *
+     */
     Error = "ERROR"
 }
 /**
  * Error message from the Bridge Box
+ * @category Core
+ * @group Server
  */
 export type TransferError = {
     /**
@@ -136,84 +231,76 @@ export type TransferError = {
 };
 /**
  * Error Codes
+ * @category Core
+ * @group Server
  */
 export declare enum ErrorCode {
     /**
+     * @remarks
      * The payload has invalid data or is malformed.
      *
-     * {@codeblock ~~/dist/samples/json/requests/errors/badRequest400.json}
      */
     BadRequest400 = 400,
     /**
+     * @remarks
      * The client has not logged in.
      *
      * @readonly
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/unauthenticated401.json}
      */
     Unauthenticated401 = 401,
     /**
+     * @remarks
      * The client has provided a token but is unauthorized to perform the request.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/unauthorized403.json}
      */
     Unauthorized403 = 403,
     /**
+     * @remarks
      * The transfer method is not accepted.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/notAccepted405.json}
      */
     NotAccepted405 = 405,
     /**
+     * @remarks
      * Something went wrong on the operating device.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/serverError500.json}
      */
     ServerError500 = 500,
     /**
+     * @remarks
      * The client/server is temporarily not available in the hub or is disconnected.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/serviceUnavailable503.json}
      */
     ServiceUnavailable503 = 503,
     /**
+     *
      * The system updates encountered an error.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/systemUpdateError519.json}
      */
     SystemUpdateError519 = 519
 }
 /**
  * Error messages
+ * @category Core
+ * @group Server
  */
 export declare const ERROR_MESSAGES: Readonly<Record<ErrorCode, string>>;
 /**
  * Removable
  *
  * Represents an object that can be removed.
+ * @group Devices
+ * @category Core
  */
 export type Removable<T> = T | Record<string, never>;
 /**
- * Indexed look up structure records
+ * @hidden
  */
-export type Lookup<T extends number | string> = {
-    [_key in T]?: string;
-};
 export type Match<T, M> = T extends keyof M ? M[T] : never;
 export * from "../../types/core";

package/dist/types/core/index.js

@@ -18,10 +18,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = void 0;
 /**
  * The different kinds of payload requests that can be sent and received.
+ * @category Core
+ * @group Server
  */
 var TransferMethodType;
 (function (TransferMethodType) {
     /**
+     * @remarks
      * Used to request a payload response to be sent by the receiving end.
      *
      * | Feature | Description |
@@ -29,11 +32,18 @@ var TransferMethodType;
      * | HTTP Method | Like GET |
      * | Idempotent | ✅ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferGetRequest.json}
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "GET",
+     *   "payload": {}
+     * }
+     * ```
      * */
     TransferMethodType["Get"] = "GET";
     /**
+     * @remarks
      * A request by a client to set data on the device server.
      *
      * | Feature | Description |
@@ -41,11 +51,26 @@ var TransferMethodType;
      * | HTTP Method | Like POST/PUT |
      * | Idempotent | ❌ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferSetRequest.json}
+     * @example
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "SET",
+     *   "payload": {
+     *     "devices": {
+     *       "001A2B3C4D5E": {
+     *          "model": 13,
+     *          "auxLight": {
+     *            "intensity": 100
+     *          }
+     *        }
+     *     }
+     *   }
+     * }
+     * ```
      * */
     TransferMethodType["Set"] = "SET";
     /**
+     * @remarks
      * A request by the device server to update data on the client.
      *
      * | Feature | Description |
@@ -53,11 +78,27 @@ var TransferMethodType;
      * | HTTP Method | Like POST/PUT |
      * | Idempotent | ❌ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferUpdateRequest.json}
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "UPDATE",
+     *   "payload": {
+     *     "devices": {
+     *       "001A2B3C4D5E": {
+     *          "model": 13,
+     *          "auxLight": {
+     *            "intensity": 100
+     *          }
+     *        }
+     *     }
+     *   }
+     * }
+     * ```
      * */
     TransferMethodType["Update"] = "UPDATE";
     /**
+     * @remarks
      * A request by the device server to remove data on the client.
      *
      * | Feature | Description |
@@ -65,11 +106,22 @@ var TransferMethodType;
      * | HTTP Method | Like POST/PUT |
      * | Idempotent | ❌ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferDeleteRequest.json}
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "DELETE",
+     *   "payload": {
+     *     "devices": {
+     *       "001A2B3C4D5E": {} //Delete the reference to this device with this mac address.
+     *     }
+     *   }
+     * }
+     * ```
      * */
     TransferMethodType["Delete"] = "DELETE";
     /**
+     * @remarks
      * A response sent to communicate errors.
      *
      * | Feature | Description |
@@ -77,79 +129,84 @@ var TransferMethodType;
      * | HTTP Response | Like 4xx, 5xx errors. See {@link ErrorCode | ErrorCodes}. |
      * | Idempotent | ✅ |
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/transferErrorRequest.json}
-     * */
+     * @example
+     * ```json
+     * {
+     *   "apiVersion": "1.0.0",
+     *   "method": "ERROR",
+     *   "error": {
+     *      "code": 400,
+     *      "message": "Invalid data or payload is malformed."
+     *     },
+     *   "payload": {}
+     *   }
+     * }
+     * ```
+     *
+     */
     TransferMethodType["Error"] = "ERROR";
-})(TransferMethodType = exports.TransferMethodType || (exports.TransferMethodType = {}));
+})(TransferMethodType || (exports.TransferMethodType = TransferMethodType = {}));
 /**
  * Error Codes
+ * @category Core
+ * @group Server
  */
 var ErrorCode;
 (function (ErrorCode) {
     /**
+     * @remarks
      * The payload has invalid data or is malformed.
      *
-     * {@codeblock ~~/dist/samples/json/requests/errors/badRequest400.json}
      */
     ErrorCode[ErrorCode["BadRequest400"] = 400] = "BadRequest400";
     /**
+     * @remarks
      * The client has not logged in.
      *
      * @readonly
      *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/unauthenticated401.json}
      */
     ErrorCode[ErrorCode["Unauthenticated401"] = 401] = "Unauthenticated401";
     /**
+     * @remarks
      * The client has provided a token but is unauthorized to perform the request.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/unauthorized403.json}
      */
     ErrorCode[ErrorCode["Unauthorized403"] = 403] = "Unauthorized403";
     /**
+     * @remarks
      * The transfer method is not accepted.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/notAccepted405.json}
      */
     ErrorCode[ErrorCode["NotAccepted405"] = 405] = "NotAccepted405";
     /**
+     * @remarks
      * Something went wrong on the operating device.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/serverError500.json}
      */
     ErrorCode[ErrorCode["ServerError500"] = 500] = "ServerError500";
     /**
+     * @remarks
      * The client/server is temporarily not available in the hub or is disconnected.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/serviceUnavailable503.json}
      */
     ErrorCode[ErrorCode["ServiceUnavailable503"] = 503] = "ServiceUnavailable503";
     /**
+     *
      * The system updates encountered an error.
      *
      * @readonly
-     *
-     * ### Example Payload
-     * {@codeblock ~~/dist/samples/json/requests/errors/systemUpdateError519.json}
      */
     ErrorCode[ErrorCode["SystemUpdateError519"] = 519] = "SystemUpdateError519";
-})(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
 /**
  * Error messages
+ * @category Core
+ * @group Server
  */
 exports.ERROR_MESSAGES = (_a = {},
     _a[ErrorCode.BadRequest400] = "Invalid data or payload is malformed.",

package/dist/types/devices/cameraHeads/core/index.d.ts

@@ -1,11 +1,22 @@
 import { A150CameraHead, A200CameraHead, DeviceModel, TiltCameraHead } from "..";
 import { Match } from "../../../core";
+/**
+ * Camera head model mapping
+ * @group Devices
+ * @category Camera Heads
+ */
 export type CameraHeadModelMap = {
     [DeviceModel.A200CameraHead]: A200CameraHead;
     [DeviceModel.A150CameraHead]: A150CameraHead;
     [DeviceModel.PivotCameraHead]: TiltCameraHead;
     [DeviceModel.RevolutionCameraHead]: TiltCameraHead;
 };
+/**
+ * Camera head device mapping
+ * Maps device models to their corresponding camera head types.
+ * @group Devices
+ * @category Camera Heads
+ */
 export type CameraHeadDeviceFromModel<T> = Match<T, CameraHeadModelMap>;
 /**
  * Camera head orientation config
@@ -13,6 +24,8 @@ export type CameraHeadDeviceFromModel<T> = Match<T, CameraHeadModelMap>;
  * The orientation in which the camera head is physically assembled
  *
  * @enum
+ * @group Devices
+ * @category Camera Heads
  */
 export declare enum CameraHeadOrientation {
     /**
@@ -24,4 +37,9 @@ export declare enum CameraHeadOrientation {
      */
     Vertical = "VERTICAL"
 }
+/**
+ * Camera head model types
+ * @group Devices
+ * @category Camera Heads
+ */
 export type CameraHeadModels = DeviceModel.A200CameraHead | DeviceModel.A150CameraHead | DeviceModel.RevolutionCameraHead | DeviceModel.PivotCameraHead;

package/dist/types/devices/cameraHeads/core/index.js

@@ -8,6 +8,8 @@ var __1 = require("..");
  * The orientation in which the camera head is physically assembled
  *
  * @enum
+ * @group Devices
+ * @category Camera Heads
  */
 var CameraHeadOrientation;
 (function (CameraHeadOrientation) {
@@ -19,4 +21,4 @@ var CameraHeadOrientation;
      * A vertical orientation of the camera head in which the camera moves vertically relative to it's home position.
      */
     CameraHeadOrientation["Vertical"] = "VERTICAL";
-})(CameraHeadOrientation = exports.CameraHeadOrientation || (exports.CameraHeadOrientation = {}));
+})(CameraHeadOrientation || (exports.CameraHeadOrientation = CameraHeadOrientation = {}));

package/dist/types/devices/cameraHeads/crawlerCameraHead/a150CameraHead/index.d.ts

@@ -5,20 +5,24 @@ import { CrawlerCameraHead, DeviceModel } from "../..";
  * Camera head joint 2 minimum rotation limit in degrees
  *
  * Useful for front-end client to constrain UI limits of joint 2 position
+ * @group Devices
+ * @category Crawlers
  */
 export declare const CRAWLER_CAMERAHEAD_JOINT2_POSITION_MIN = -140;
 /**
  * Camera head joint 2 maximum rotation limit in degrees
  *
  * Useful for front-end client to constrain UI limits of joint 2 position
+ * @group Devices
+ * @category Crawlers
  */
 export declare const CRAWLER_CAMERAHEAD_JOINT2_POSITION_MAX = 140;
 /**
- * {@link ICameraHead | 📖 See extended definition}
  *
  * Pan-Tilt Camera Head
  *
- * @category Device/CameraHead
+ * @group A150
+ * @category Camera Heads
  */
 export type A150CameraHead = {
     model: DeviceModel.A150CameraHead;

package/dist/types/devices/cameraHeads/crawlerCameraHead/a150CameraHead/index.js

@@ -20,12 +20,16 @@ exports.CRAWLER_CAMERAHEAD_JOINT2_POSITION_MAX = exports.CRAWLER_CAMERAHEAD_JOIN
  * Camera head joint 2 minimum rotation limit in degrees
  *
  * Useful for front-end client to constrain UI limits of joint 2 position
+ * @group Devices
+ * @category Crawlers
  */
 exports.CRAWLER_CAMERAHEAD_JOINT2_POSITION_MIN = -140;
 /**
  * Camera head joint 2 maximum rotation limit in degrees
  *
  * Useful for front-end client to constrain UI limits of joint 2 position
+ * @group Devices
+ * @category Crawlers
  */
 exports.CRAWLER_CAMERAHEAD_JOINT2_POSITION_MAX = 140;
 __exportStar(require(".."), exports);

package/dist/types/devices/cameraHeads/crawlerCameraHead/a200CameraHead/index.d.ts

@@ -3,11 +3,10 @@ import { CrawlerCameraHead, DeviceModel } from "../..";
 import { Laser } from "../../../peripherals";
 /** Pan Tilt Camera Head */
 /**
- * {@link IA200CameraHead | 📖 See extended definition}
- *
  * Pan-Tilt Camera Head
  *
- * @category Device/CameraHead
+ * @category Camera Heads
+ * @group A200
  */
 export type A200CameraHead = {
     model: DeviceModel.A200CameraHead;
@@ -22,6 +21,9 @@ export type A200CameraHead = {
 } & CrawlerCameraHead & Calibratable;
 /**
  * Camera head sensor type
+ *
+ * @category Camera Heads
+ * @group A200
  */
 export declare enum CameraHeadSensorType {
     /**