@volant-autonomy/via-sdk 1.3188.1 → 1.3194.1

package/dist/direct.d.ts

@@ -29,11 +29,12 @@ export type getChart = paths['/charts/{chart_id}']['get'];
 export type getSailV2_5 = paths['/risk_assessment/sora/v2.5/sail']['get'];
 export type getAllArcsV2_5 = paths['/risk_assessment/sora/v2.5/air_risk_classifications']['get'];
 export type getArcV2_5 = paths['/risk_assessment/sora/v2.5/air_risk_classifications/{arc_id}']['get'];
-export type createSoraReportV2_5 = paths['/risk_assessment/sora/v2.5/report']['post'];
-export type createSoraSemanticModelVolumesV2_5 = paths['/risk_assessment/sora/v2.5/semantic_model_volumes']['post'];
+export type generateSoraReportV2_5 = paths['/risk_assessment/sora/v2.5/report']['post'];
+export type generateSoraSemanticModelVolumesV2_5 = paths['/risk_assessment/sora/v2.5/semantic_model_volumes']['post'];
 export type getAllArcsUk = paths['/risk_assessment/sora/uk/air_risk_classifications']['get'];
 export type getArcUk = paths['/risk_assessment/sora/uk/air_risk_classifications/{arc_id}']['get'];
 export type getSailUk = paths['/risk_assessment/sora/uk/sail']['get'];
+export type createSoraReportUk = paths['/risk_assessment/sora/uk/report']['post'];
 export type createSoraSemanticModelVolumesUk = paths['/risk_assessment/sora/uk/semantic_model_volumes']['post'];
 export type createSoraClassification = paths['/risk_assessment/sora/classifications']['post'];
 export type updateSoraClassification = paths['/risk_assessment/sora/classifications/{classification_id}']['put'];
@@ -805,7 +806,7 @@ export declare class Direct {
      *     Intrinsic GRC determined and the highest likelihood to encounter another aircraft (as defined by Airspace Encounter
      *     Class) determining the ARC.
      */
-    createSoraReportV2_5<Opts extends requestOptions = {}>(args: bodyOf<createSoraReportV2_5>, opts?: Opts | requestOptions): Promise<{
+    generateSoraReportV2_5<Opts extends requestOptions = {}>(args: bodyOf<generateSoraReportV2_5>, opts?: Opts | requestOptions): Promise<{
         data?: never;
         error: {
             errors: {
@@ -834,7 +835,7 @@ export declare class Direct {
      * Generate volumes that correspond to the SORA Semantic Model
      * @description Generate volumes that correspond to the SORA Semantic Model
      */
-    createSoraSemanticModelVolumesV2_5<Opts extends requestOptions = {}>(args: bodyOf<createSoraSemanticModelVolumesV2_5>, opts?: Opts | requestOptions): Promise<{
+    generateSoraSemanticModelVolumesV2_5<Opts extends requestOptions = {}>(args: bodyOf<generateSoraSemanticModelVolumesV2_5>, opts?: Opts | requestOptions): Promise<{
         data?: never;
         error: {
             errors: {
@@ -948,11 +949,32 @@ export declare class Direct {
         response: Response;
         aborted: false;
     }>;
-    /**
-     * Generate volumes that correspond to the SORA Semantic Model
-     * @description Generate volumes that correspond to the SORA Semantic Model
-     */
-    createSoraSemanticModelVolumesUk<Opts extends requestOptions = {}>(args: bodyOf<createSoraSemanticModelVolumesV2_5>, opts?: Opts | requestOptions): Promise<{
+    generateSoraReportUk<Opts extends requestOptions = {}>(args: bodyOf<createSoraReportUk>, opts?: Opts | requestOptions): Promise<{
+        data?: never;
+        error: {
+            errors: {
+                detail: string;
+                status: "401" | "400" | "422";
+            }[];
+            status: "401" | "400" | "422";
+        };
+        response: Response;
+        aborted: false;
+    } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
+        data?: never;
+        error?: never;
+        response?: never;
+        aborted: true;
+    } : never) | {
+        data: {
+            attributes: import("./volant-schema").components["schemas"]["UkSoraReportAttributes"];
+            type?: "sora_report";
+        };
+        error?: never;
+        response: Response;
+        aborted: false;
+    }>;
+    generateSoraSemanticModelVolumesUk<Opts extends requestOptions = {}>(args: bodyOf<generateSoraSemanticModelVolumesV2_5>, opts?: Opts | requestOptions): Promise<{
         data?: never;
         error: {
             errors: {

package/dist/direct.js

@@ -241,7 +241,7 @@ class Direct {
             return resp;
         });
     }
-    createSoraReportV2_5(args, opts) {
+    generateSoraReportV2_5(args, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.fetcher.POST('/risk_assessment/sora/v2.5/report', { body: args }, opts);
             if (resp.error === undefined && !resp.aborted) {
@@ -250,7 +250,7 @@ class Direct {
             return resp;
         });
     }
-    createSoraSemanticModelVolumesV2_5(args, opts) {
+    generateSoraSemanticModelVolumesV2_5(args, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.fetcher.POST('/risk_assessment/sora/v2.5/semantic_model_volumes', { body: args }, opts);
             if (resp.error === undefined && !resp.aborted) {
@@ -286,7 +286,16 @@ class Direct {
             return resp;
         });
     }
-    createSoraSemanticModelVolumesUk(args, opts) {
+    generateSoraReportUk(args, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.fetcher.POST('/risk_assessment/sora/uk/report', { body: args }, opts);
+            if (resp.error === undefined && !resp.aborted) {
+                return Object.assign(Object.assign({}, resp), { data: resp.data.data });
+            }
+            return resp;
+        });
+    }
+    generateSoraSemanticModelVolumesUk(args, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.fetcher.POST('/risk_assessment/sora/uk/semantic_model_volumes', { body: args }, opts);
             if (resp.error === undefined && !resp.aborted) {

package/dist/volant-schema.d.ts

@@ -672,6 +672,31 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/risk_assessment/sora/uk/report": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Generate a report containing derived information used for regulatory evidence
+         * @description Generate a report containing derived SORA information used for regulatory evidence.
+         *
+         *
+         *     GRC and ARC determination is considered across the entire operational volume as determined by the supplied
+         *     `waypoints`. Where the operational environment differs across the volume, the worst case is taken, i.e. the highest
+         *     Intrinsic GRC determined and the highest risk Air Risk Classification.
+         */
+        post: operations["uk_sora_report_v1_risk_assessment_sora_uk_report_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/risk_assessment/sora/uk/semantic_model_volumes": {
         parameters: {
             query?: never;
@@ -1733,6 +1758,11 @@ export interface components {
             data: components["schemas"]["UkSailResponse"];
             links: components["schemas"]["Links"];
         };
+        /** JsonApiResponse[UkSoraReportResponse] */
+        JsonApiResponse_UkSoraReportResponse_: {
+            data: components["schemas"]["UkSoraReportResponse"];
+            links: components["schemas"]["Links"];
+        };
         /** JsonApiResponse[VolumeResponse] */
         JsonApiResponse_VolumeResponse_: {
             data: components["schemas"]["VolumeResponse"];
@@ -2141,11 +2171,6 @@ export interface components {
              */
             sail: ("NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII") | "Category C";
             containment: components["schemas"]["ContainmentRequirements"];
-            /**
-             * Avg Adjacent Area Population Density
-             * @deprecated
-             */
-            readonly avg_adjacent_area_population_density: number;
         };
         /** SoraReportRequest */
         SoraReportRequest: {
@@ -2154,22 +2179,12 @@ export interface components {
              * @description Unique identifier for a chart.
              */
             chart_id: string;
-            /**
-             * Aircraft Id
-             * @deprecated
-             * @description Deprecated, if provided will override `aircraft`
-             */
-            aircraft_id?: string | null;
             /**
              * Waypoints
              * @description Points defining a Flightplan that must be passed through along with flight parameters. The first             waypoint must be of type: WaypointType.START and only occur once
              */
             waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
-            /** @default {
-             *       "max_cruise_speed": 20,
-             *       "characteristic_dimension": 0.5
-             *     } */
-            aircraft?: components["schemas"]["Aircraft"];
+            aircraft: components["schemas"]["Aircraft"];
             mitigations: components["schemas"]["Mitigations"];
             /** @description Population Density Data Source. Data has been re-projected 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.             The values are normalised by source data cell area to derive a density value of people per square metre. */
             population_density_source: components["schemas"]["PopulationSource"];
@@ -2185,12 +2200,12 @@ export interface components {
             ground_risk_buffer: number;
             /**
              * Controlled Ground Area Id
-             * @description Applies a Controlled Ground Area to the determination of the GRC for the provided waypoints.                 If any 2 waypoints and their associated ground risk footprint are found to be wholly contained within                 the Controlled Ground Area then the intrinsic GRC for this section will be equal to that of a                 Controlled Ground Area for the supplied aircraft. If there is partial overlap, then any population                 within it will be set to 0 for the purposes of determining maximum overflown population density.
+             * @description Applies a Controlled Ground Area to the determination of the GRC for the provided     waypoints. If any 2 waypoints and their associated ground risk footprint are found to be wholly contained within     the Controlled Ground Area then the intrinsic GRC for this section will be equal to that of a Controlled Ground     Area for the supplied aircraft. If there is partial overlap, then any population within it will be set to 0 for     the purposes of determining maximum overflown population density.
              */
             controlled_ground_area_id?: string | null;
             /**
              * Atypical Airspace Id
-             * @description Applies an Atypical Airspace to the determination of the ARC for the provided waypoints.                 If any 2 waypoints and their associated operational volume are found to be wholly contained within the                 the Atypical Airspace in 3D space then the ARC for this section will be ARC-A. Atypical Airspaces will                 not have an effect if there is only partial overlap.
+             * @description Applies an Atypical Airspace to the determination of the ARC for the provided     waypoints. If any 2 waypoints and their associated operational volume are found to be wholly contained within the     the Atypical Airspace in 3D space then the ARC for this section will be ARC-A. Atypical Airspaces will not have an     effect if there is only partial overlap.
              */
             atypical_airspace_id?: string | null;
         };
@@ -2217,17 +2232,7 @@ export interface components {
              * @default NASADEM
              */
             terrain_source?: components["schemas"]["TerrainSource"];
-            /**
-             * Aircraft Id
-             * @deprecated
-             * @description Deprecated, if provided will override `aircraft`
-             */
-            aircraft_id?: string | null;
-            /** @default {
-             *       "max_cruise_speed": 20,
-             *       "characteristic_dimension": 0.5
-             *     } */
-            aircraft?: components["schemas"]["Aircraft"];
+            aircraft: components["schemas"]["Aircraft"];
             /**
              * Waypoints
              * @description Points defining a Flightplan that must be passed through along with flight parameters. The first             waypoint must be of type: WaypointType.START and only occur once
@@ -2478,6 +2483,41 @@ export interface components {
              */
             containment_robustness?: "low" | "medium" | "high";
         };
+        /**
+         * UkContainmentRequirements
+         * @description The containment requirements ensure that the target level of safety can be met for both ground and air risk in the
+         *     adjacent area, they encompass a set of operational limits and a derived level of robustness. Each level of
+         *     robustness comes with a set of safety requirements.
+         */
+        UkContainmentRequirements: {
+            /**
+             * Robustness
+             * @description The combination of level of integrity (how good the mitigation is at reducing risk) and level                 of assurance (the degree of certainty to which the level of integrity is ensured) in ensuring the                 target level of safety can be met in the adjacent area. 'out of scope' indicates that the operation                 cannot be conducted in the specific category.
+             */
+            robustness: ("low" | "medium" | "high" | "out of scope") | "Category C";
+            /**
+             * Adjacent Area Average Population Density Operational Limit
+             * @description The limit of population density in the adjacent area permissible to keep the same level of                 containment robustness, defined in people/km².
+             * @enum {string}
+             */
+            adjacent_area_average_population_density_operational_limit: "<50" | "<500" | "<5000" | "<50000" | "none";
+            /**
+             * Outdoor Assembly Size Operational Limit
+             * @description The maximum size of outdoor assemblies permissible within 1km of the operational volume to             to keep the same level of containment robustness, defined in people.
+             * @enum {string}
+             */
+            outdoor_assembly_size_operational_limit: "<40000" | "<=400000" | "none";
+            /**
+             * Adjacent Area Average Population Density
+             * @description The average population density within the adjacent area used in                 determining containment requirements, defined in people/km². The adjacent area spans                 from the outer limit of the ground risk buffer up to 3 minutes flight time from                 the outer limit of the operational volume at max cruise speed of the aircraft.                 The adjacent area is fixed between a lower limit of 5km and upper limit of 35km.
+             */
+            adjacent_area_average_population_density: number;
+            /**
+             * Sheltering Applied
+             * @description Whether the assumption of sheltering was applied in the determination of the containment                 robustness level and operational limits.
+             */
+            sheltering_applied: boolean;
+        };
         /** UkMitigations */
         UkMitigations: {
             /**
@@ -2536,11 +2576,7 @@ export interface components {
              * @default NASADEM
              */
             terrain_source?: components["schemas"]["TerrainSource"];
-            /** @default {
-             *       "max_cruise_speed": 20,
-             *       "characteristic_dimension": 0.5
-             *     } */
-            aircraft?: components["schemas"]["Aircraft"];
+            aircraft: components["schemas"]["Aircraft"];
             /**
              * Waypoints
              * @description Points defining a Flightplan that must be passed through along with flight parameters. The first             waypoint must be of type: WaypointType.START and only occur once
@@ -2572,6 +2608,85 @@ export interface components {
             implementation: "uk";
             payload: components["schemas"]["UkClassificationPayload"];
         };
+        /** UkSoraReportAttributes */
+        UkSoraReportAttributes: {
+            /**
+             * Final GRC Determination
+             * @description The Final GRC determination, based on the availability and correct application of mitigations to         the operation after determination of the intrinsic GRC.
+             */
+            final_grc: number | "Category C";
+            /**
+             * Intrinsic UAS Ground Risk Class (iGRC)
+             * @description The intrinsic UAS ground risk relates to the risk of a person being fatally struck by the UAS         in the case where the UAS operation is out of control) absent of any mitigations being present
+             */
+            intrinsic_grc: (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | "Category C";
+            /**
+             * Max Operational Population Density
+             * @description The maximum population density overflown within the nominal                 flight operational volume and ground risk buffer, defined in people/km². Determined                 in the assessment of intrinsic ground risk before application of any mitigations.
+             */
+            max_operational_population_density: number;
+            /**
+             * Residual Air Risk Classification
+             * @description Determination of Air Risk after the application of any strategic mitigations intended to control             the crewed aircraft type, encounter rates or time of exposure, prior to take-off
+             * @example arc-c
+             * @enum {string}
+             */
+            residual_arc: "arc-a" | "arc-b" | "arc-c" | "arc-d";
+            /**
+             * SAIL
+             * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
+             */
+            sail: ("NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII") | "Category C";
+            containment: components["schemas"]["UkContainmentRequirements"];
+        };
+        /** UkSoraReportRequest */
+        UkSoraReportRequest: {
+            /**
+             * Chart ID
+             * @description Unique identifier for a chart.
+             */
+            chart_id: string;
+            /**
+             * Waypoints
+             * @description Points defining a Flightplan that must be passed through along with flight parameters. The first             waypoint must be of type: WaypointType.START and only occur once
+             */
+            waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
+            aircraft: components["schemas"]["Aircraft"];
+            mitigations: components["schemas"]["UkMitigations"];
+            /** @description Population Density Data Source. Data has been re-projected 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.             The values are normalised by source data cell area to derive a density value of people per square metre. */
+            population_density_source: components["schemas"]["PopulationSource"];
+            /**
+             * @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
+             */
+            terrain_source?: components["schemas"]["TerrainSource"];
+            /**
+             * 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.
+             */
+            ground_risk_buffer: number;
+            /**
+             * Controlled Ground Area Id
+             * @description Applies a Controlled Ground Area to the determination of the GRC for the provided     waypoints. If any 2 waypoints and their associated ground risk footprint are found to be wholly contained within     the Controlled Ground Area then the intrinsic GRC for this section will be equal to that of a Controlled Ground     Area for the supplied aircraft. If there is partial overlap, then any population within it will be set to 0 for     the purposes of determining maximum overflown population density.
+             */
+            controlled_ground_area_id?: string | null;
+            /**
+             * Atypical Airspace Id
+             * @description Applies an Atypical Airspace to the determination of the ARC for the provided     waypoints. If any 2 waypoints and their associated operational volume are found to be wholly contained within the     the Atypical Airspace in 3D space then the ARC for this section will be ARC-A. Atypical Airspaces will not have an     effect if there is only partial overlap.
+             */
+            atypical_airspace_id?: string | null;
+        };
+        /** UkSoraReportResponse */
+        UkSoraReportResponse: {
+            attributes: components["schemas"]["UkSoraReportAttributes"];
+            /**
+             * Type
+             * @default sora_report
+             * @constant
+             * @enum {string}
+             */
+            type?: "sora_report";
+        };
         /** ValidationError */
         ValidationError: {
             /** Location */
@@ -5150,6 +5265,57 @@ export interface operations {
             };
         };
     };
+    uk_sora_report_v1_risk_assessment_sora_uk_report_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UkSoraReportRequest"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiResponse_UkSoraReportResponse_"];
+                };
+            };
+            /** @description One or more input parameters were missing or invalid. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiExceptionResponse"];
+                };
+            };
+            /** @description Bearer access token was not provided in Authorization header, token could not         be decoded, or token was invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiExceptionResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     uk_semantic_model_volumes_v1_risk_assessment_sora_uk_semantic_model_volumes_post: {
         parameters: {
             query?: never;

package/package.json

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