@deeptrekker/api-domain 1.0.2 → 1.0.4

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

@@ -1 +1 @@
-export declare const API_VERSION = "1.0.2";
+export declare const API_VERSION = "1.0.4";

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 = "1.0.2";
+exports.API_VERSION = "1.0.4";

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

@@ -57,7 +57,9 @@ export type TransferPayload<T> = {
 /**
  * Movement
  *
- * Represents a movement command with speed and position.
+ * Represents a movement command with speed and position. Only one movement command can be active at a time.
+ *
+ * **When position is the active command, the vehicle will target and hold that position until a velocity command is received**
  *
  * @category Controls
  * @group X4

package/dist/types/devices/vehicles/x4/index.d.ts

@@ -86,8 +86,9 @@ export type X4Thruster = {
 };
 /**
  * The X4 drive command type.
- * It includes properties for controlling the vehicle's movement in various directions (forward, lateral, vertical depth, roll, pitch, yaw).
+ * It includes properties for controlling the vehicle's movement in various directions (forward, lateral, vertical depth, roll, pitch, yaw). **The vehicle will disable all motors after 500ms if no commands are received.**
  * It also includes options for coordinate type and reference frame. As the vehicle can be controlled in different coordinate systems, this type allows for flexibility in how commands are issued.
+ *
  * @internal
  * @alpha
  * @group X4
@@ -265,6 +266,54 @@ export type X4Position = {
      * @readonly
      */
     heading?: number;
+    /**
+     * Indicates that a position for x has been set. Sending a velocity command for x will disable the lock.
+     *
+     * @readonly
+     */
+    xLock?: boolean;
+    /**
+     * Indicates that a position for y has been set. Sending a velocity command for y will disable the lock.
+     *
+     * @readonly
+     */
+    yLock?: boolean;
+    /**
+     * Indicates that a position for zDepth has been set. Sending a velocity command for zDepth will disable the lock.
+     *
+     * @readonly
+     */
+    zDepthLock?: boolean;
+    /**
+     * Indicates that a position for zAltitude has been set. Sending a velocity command for zAltitude will disable the lock.
+     *
+     * @readonly
+     */
+    zAltitudeLock?: boolean;
+    /**
+     * Indicates that a position for roll has been set. Sending a velocity command for roll will disable the lock.
+     *
+     * @readonly
+     */
+    rollLock?: boolean;
+    /**
+     * Indicates that a position for pitch has been set. Sending a velocity command for pitch will disable the lock.
+     *
+     * @readonly
+     */
+    pitchLock?: boolean;
+    /**
+     * Indicates that a position for yaw has been set. Sending a velocity command for yaw or a drive command for heading will disable the yaw lock.
+     *
+     * @readonly
+     */
+    yawLock?: boolean;
+    /**
+     * Indicates that a position for heading has been set. Sending a velocity command for heading or a drive command for yaw will disable the heading lock.
+     *
+     * @readonly
+     */
+    headingLock?: boolean;
 };
 /**
  * The X4 tracked position type.

package/dist/utils/index.js

@@ -20,7 +20,7 @@ exports.payload = payload;
 var ajv_1 = __importDefault(require("ajv"));
 var ts_pattern_1 = require("ts-pattern");
 var types_1 = require("../types");
-exports.ajv = new ajv_1.default();
+exports.ajv = new ajv_1.default({ allowUnionTypes: true });
 /** Compiled JSON schema Validator */
 var schema_json_1 = __importDefault(require("../constants/schema/schema.json"));
 var Validator = exports.ajv.compile(schema_json_1.default);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
     "main": "dist/index.js",
     "engines": {