@volant-autonomy/via-sdk 1.5324.1 → 1.5334.1

package/dist/types.d.ts

@@ -18,7 +18,7 @@ export type Expand<T> = T extends infer O ? {
 } : never;
 /** The raw API schemas from openapi.json */
 export type schemas = components['schemas'];
-export type Waypoint = schemas['StartWaypoint-Input'] | schemas['GotoWaypoint-Input'];
+export type Waypoint = schemas['StartWaypoint-Input'] | schemas['GotoWaypoint-Input'] | schemas['GotoLoiterWaypoint-Input'];
 export type Checkpoint = schemas['GotoPathingCheckpoint'] | schemas['StartPathingCheckpoint'];
 export type PathingTaskState = schemas['PathingTaskState'];
 export declare class UnauthenticatedError extends Error {

package/dist/volant-schema.d.ts

@@ -212,6 +212,8 @@ export interface paths {
         /**
          * Retrieve a formatted version of a Flightplan
          * @description Retrieve a formatted version of the specified flightplan to download as a file.
+         *
+         *     Exports flightplan waypoints with AMSL (Above Mean Sea Level) altitudes in KML format.
          */
         get: operations["flightplan_content_download_v1_flightplans__flightplan_id__content_get"];
         put?: never;
@@ -1788,6 +1790,8 @@ export interface components {
             population_density: components["schemas"]["PopulationSource"][];
             /** Terrain Elevation */
             terrain_elevation: components["schemas"]["TerrainSource"][];
+            /** Surface Elevation */
+            surface_elevation: components["schemas"]["SurfaceSource"][];
         };
         /**
          * FinalGRC
@@ -1899,7 +1903,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"] | components["schemas"]["GotoLoiterWaypoint-Input"])[];
             /**
              * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM             coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest             value present in any of the cells of the source grid it intersects.             Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include             buildings or man-made structures.
              * @default NASADEM
@@ -2010,7 +2014,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Output"] | components["schemas"]["GotoWaypoint-Output"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Output"] | components["schemas"]["GotoWaypoint-Output"] | components["schemas"]["GotoLoiterWaypoint-Output"])[];
             /**
              * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM             coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest             value present in any of the cells of the source grid it intersects.             Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include             buildings or man-made structures.
              * @default NASADEM
@@ -2391,6 +2395,120 @@ export interface components {
              */
             affine_transform: number[];
         };
+        /**
+         * GotoLoiterWaypoint
+         * @description Fly to a specified location under given `flight_parameters` accounting for given `wind_parameters` and loiter at the
+         *     location.
+         *
+         *     All parameters are defined as to be used during the leg flying towards this waypoint. Loiters are defined as
+         *     circular about the position with diameter equal to the volumes derived for the goto section with altitude bounds
+         *     derived as a "puck" about the position's altitude.
+         *
+         *     NOTE: The `speed` provided in `wind_parameters` must be less than the `airspeed` provided in `flight_parameters`
+         */
+        "GotoLoiterWaypoint-Input": {
+            /**
+             * @description The type of a `Waypoint`
+             *
+             *         - `START`: The beginning of a `Flightplan`
+             *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
+             *          (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "goto_loiter";
+            position: components["schemas"]["Wgs84Position-Input"];
+            flight_parameters: components["schemas"]["FlightParameters"];
+            wind_parameters?: components["schemas"]["WindParameters"];
+            loiter_parameters: components["schemas"]["LoiterParameters"];
+        };
+        /**
+         * GotoLoiterWaypoint
+         * @description Fly to a specified location under given `flight_parameters` accounting for given `wind_parameters` and loiter at the
+         *     location.
+         *
+         *     All parameters are defined as to be used during the leg flying towards this waypoint. Loiters are defined as
+         *     circular about the position with diameter equal to the volumes derived for the goto section with altitude bounds
+         *     derived as a "puck" about the position's altitude.
+         *
+         *     NOTE: The `speed` provided in `wind_parameters` must be less than the `airspeed` provided in `flight_parameters`
+         */
+        "GotoLoiterWaypoint-Output": {
+            /**
+             * @description The type of a `Waypoint`
+             *
+             *         - `START`: The beginning of a `Flightplan`
+             *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
+             *          (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "goto_loiter";
+            position: components["schemas"]["Wgs84Position-Output"];
+            flight_parameters: components["schemas"]["FlightParameters"];
+            wind_parameters?: components["schemas"]["WindParameters"];
+            loiter_parameters: components["schemas"]["LoiterParameters"];
+        };
+        /** GotoLoiterWaypointDetail */
+        GotoLoiterWaypointDetail: {
+            /**
+             * Type
+             * @description The type of a `Waypoint`
+             *
+             *         - `START`: The beginning of a `Flightplan`
+             *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
+             * @constant
+             */
+            type: "goto_loiter";
+            position: components["schemas"]["Wgs84Position-Output"];
+            flight_parameters: components["schemas"]["FlightParameters"];
+            wind_parameters?: components["schemas"]["WindParameters"];
+            loiter_parameters: components["schemas"]["LoiterParameters"];
+            /**
+             * Waypoint ID
+             * Format: uuid
+             * @description Unique identifier of the waypoint.
+             * @default {
+             *       "strict": false
+             *     }
+             * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
+             */
+            id?: string;
+            /**
+             * Waypoint Index
+             * @description The position of the waypoint in the flightplan.
+             * @example 0
+             * @example 1
+             * @example 2
+             */
+            index: number;
+            /**
+             * Time
+             * Format: date-time
+             * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
+             * @example 2023-10-30T10:57:57Z
+             * @example 2023-10-30T10:57:57+00:00
+             */
+            time: string;
+            /**
+             * Planar Distance
+             * @description The cumulative distance along a flat horizontal 2D plane (ignoring altitude) of the projected path            between the start position and this position following all prior waypoints. This value is expressed in            metres and is the result of a cartesian reprojection and therefore is not guaranteed to match the minimum            straight-line distance between waypoints.
+             */
+            planar_distance: number;
+            /**
+             * Above Mean Sea Level (AMSL) Altitude
+             * @description Altitude above mean sea level (AMSL), expressed in metres. This value is derived by combining the            input altitude (specified above ground level (AGL)) with the terrain elevation from the selected elevation            dataset.
+             * @example 100
+             */
+            altitude_amsl: number;
+            /**
+             * WGS84 Ellipsoidal Altitude
+             * @description Height above the WGS84 Ellipsoid, expressed in metres.
+             * @example 120
+             */
+            altitude_wgs84_ellipsoidal: number;
+        };
         /**
          * GotoPathingCheckpoint
          * @description A position that the resulting path must pass through.
@@ -2425,6 +2543,7 @@ export interface components {
              *
              *         - `START`: The beginning of a `Flightplan`
              *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
              *          (enum property replaced by openapi-typescript)
              * @enum {string}
              */
@@ -2447,6 +2566,7 @@ export interface components {
              *
              *         - `START`: The beginning of a `Flightplan`
              *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
              *          (enum property replaced by openapi-typescript)
              * @enum {string}
              */
@@ -2463,6 +2583,7 @@ export interface components {
              *
              *         - `START`: The beginning of a `Flightplan`
              *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
              * @constant
              */
             type: "goto";
@@ -2480,8 +2601,8 @@ export interface components {
              */
             id?: string;
             /**
-             * Index
-             * @description The position of the waypoint in the flightplan
+             * Waypoint Index
+             * @description The position of the waypoint in the flightplan.
              * @example 0
              * @example 1
              * @example 2
@@ -2905,6 +3026,16 @@ export interface components {
              */
             expires_in: number;
         };
+        /** LoiterParameters */
+        LoiterParameters: {
+            /**
+             * Duration
+             * Format: duration
+             * @description The duration to loiter at the waypoint position.
+             * @example PT5M
+             */
+            duration: string;
+        };
         /**
          * ManagedCostDatasetMetadata
          * @description Set of parameters to calculate the pre-processed chart cost fields that uniquely specify a pre-processed cost field.
@@ -3036,7 +3167,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Output"] | components["schemas"]["GotoWaypoint-Output"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Output"] | components["schemas"]["GotoWaypoint-Output"] | components["schemas"]["GotoLoiterWaypoint-Output"])[];
             /**
              * Time Start
              * Format: date-time
@@ -3623,7 +3754,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"] | components["schemas"]["GotoLoiterWaypoint-Input"])[];
             aircraft: components["schemas"]["Aircraft"];
             ground_risk_mitigations: components["schemas"]["JarusV25GroundRiskMitigations"];
             /**
@@ -3722,7 +3853,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"] | components["schemas"]["GotoLoiterWaypoint-Input"])[];
             /**
              * Ground Risk Buffer
              * @description The ground risk buffer is an                 area on the ground that surrounds the footprint of the contingency volume. It is                 expected that if the flight exits the contingency volume during a loss of control                 of the operation that the flight will be terminated within this lateral distance.
@@ -3760,6 +3891,7 @@ export interface components {
              *
              *         - `START`: The beginning of a `Flightplan`
              *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
              *          (enum property replaced by openapi-typescript)
              * @enum {string}
              */
@@ -3776,6 +3908,7 @@ export interface components {
              *
              *         - `START`: The beginning of a `Flightplan`
              *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
              *          (enum property replaced by openapi-typescript)
              * @enum {string}
              */
@@ -3790,6 +3923,7 @@ export interface components {
              *
              *         - `START`: The beginning of a `Flightplan`
              *         - `GOTO` : Fly to and directly pass through a location under certain parameters
+             *         - `GOTO_LOITER`: Fly to and loiter at a location under certain parameters
              * @constant
              */
             type: "start";
@@ -3805,8 +3939,8 @@ export interface components {
              */
             id?: string;
             /**
-             * Index
-             * @description The position of the waypoint in the flightplan
+             * Waypoint Index
+             * @description The position of the waypoint in the flightplan.
              * @example 0
              * @example 1
              * @example 2
@@ -4272,7 +4406,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"] | components["schemas"]["GotoLoiterWaypoint-Input"])[];
             /**
              * Ground Risk Buffer
              * @description The ground risk buffer is an                 area on the ground that surrounds the footprint of the contingency volume. It is                 expected that if the flight exits the contingency volume during a loss of control                 of the operation that the flight will be terminated within this lateral distance.
@@ -4375,7 +4509,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"])[];
+            waypoints: (components["schemas"]["StartWaypoint-Input"] | components["schemas"]["GotoWaypoint-Input"] | components["schemas"]["GotoLoiterWaypoint-Input"])[];
             aircraft: components["schemas"]["Aircraft"];
             ground_risk_mitigations: components["schemas"]["UkGroundRiskMitigations"];
             /**
@@ -4562,6 +4696,7 @@ export interface components {
              */
             maximum_length?: number | null;
         };
+        WaypointDetail: components["schemas"]["StartWaypointDetail"] | components["schemas"]["GotoWaypointDetail"] | components["schemas"]["GotoLoiterWaypointDetail"];
         /** WaypointDetailAttributes */
         WaypointDetailAttributes: {
             /**
@@ -4615,7 +4750,7 @@ export interface components {
              *       }
              *     ]
              */
-            waypoints: (components["schemas"]["StartWaypointDetail"] | components["schemas"]["GotoWaypointDetail"])[];
+            waypoints: components["schemas"]["WaypointDetail"][];
         };
         /**
          * WaypointDetailResponse

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volant-autonomy/via-sdk",
-  "version": "1.5324.1",
+  "version": "1.5334.1",
   "license": "MIT",
   "source": "src/index.ts",
   "types": "dist/index.d.ts",