@volant-autonomy/via-sdk 1.2910.1 → 1.2935.1

package/dist/direct.d.ts

@@ -791,7 +791,7 @@ export declare class Direct {
         aborted: false;
     }>;
     /**
-     * Generate a report containing derived SORA information used for regulatory evidence
+     * Generate a report containing derived information used for regulatory evidence
      * @description Generate a report containing derived SORA information used for regulatory evidence.
      *
      *

package/dist/direct.js

@@ -214,6 +214,7 @@ class Direct {
         });
     }
     /// risk assessment
+    // TODO rename to get
     calculateSailV2_5(args, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.fetcher.GET('/risk_assessment/sora/v2.5/sail', { query: args }, opts);

package/dist/fetch.d.ts

@@ -90,7 +90,7 @@ export type FetcherArgs = {
     /** Override the fetch function used for requests */
     fetchFn?: typeof globalThis.fetch;
     /** Override the fetch function used for auth requests */
-    authFetchFn: typeof globalThis.fetch;
+    authFetchFn?: typeof globalThis.fetch;
     /** Used for auth, needed unless ignoreAuth is true */
     username?: string;
     /** Used for auth, needed unless ignoreAuth is true */

package/dist/fetch.js

@@ -20,7 +20,7 @@ class Fetcher {
         this.opts = {
             url: (_a = args.url) !== null && _a !== void 0 ? _a : 'https://via.volantautonomy.com/api/v1.0',
             fetchFn: (_b = args.fetchFn) !== null && _b !== void 0 ? _b : undefined,
-            authFetchFn: (_c = args.authFetchFn) !== null && _c !== void 0 ? _c : globalThis.fetch,
+            authFetchFn: (_c = args.authFetchFn) !== null && _c !== void 0 ? _c : undefined,
             username: args.username,
             password: args.password,
             ignoreAuth: (_d = args.ignoreAuth) !== null && _d !== void 0 ? _d : false
@@ -31,11 +31,13 @@ class Fetcher {
     }
     doAuth() {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             // NOTE: THIS REQUEST IS NOT TYPE CHECKED PROPERLY AS paths IS NOT KNOWN HERE!
             if (this.opts.username === undefined || this.opts.password === undefined) {
                 throw new types_1.UnauthenticatedError('ignoreAuth is not true and either username or password is missing');
             }
-            const resp = yield this.opts.authFetchFn(this.opts.url + '/login', {
+            const authFetchFn = (_a = this.opts.authFetchFn) !== null && _a !== void 0 ? _a : globalThis.fetch;
+            const resp = yield authFetchFn(this.opts.url + '/login', {
                 body: JSON.stringify({
                     username: this.opts.username,
                     password: this.opts.password

package/dist/volant-schema.d.ts

@@ -517,7 +517,7 @@ export interface paths {
          * Calculate SAIL
          * @description Calculate Specific Assurance Integrity Level (SAIL).
          */
-        get: operations["sora_sail_score_v1_risk_assessment_sora_v2_5_sail_get"];
+        get: operations["jarus_v2_5_sail_v1_risk_assessment_sora_v2_5_sail_get"];
         put?: never;
         post?: never;
         delete?: never;
@@ -537,7 +537,7 @@ export interface paths {
          * List available ARCs
          * @description List available ARCs.
          */
-        get: operations["ARCs_list_v1_risk_assessment_sora_v2_5_air_risk_classifications_get"];
+        get: operations["jarus_v2_5_ARCs_list_v1_risk_assessment_sora_v2_5_air_risk_classifications_get"];
         put?: never;
         post?: never;
         delete?: never;
@@ -557,7 +557,7 @@ export interface paths {
          * Retrieve the specified Air Risk Classification
          * @description Retrieve the specified Air Risk Classification.
          */
-        get: operations["arc_single_v1_risk_assessment_sora_v2_5_air_risk_classifications__arc_id__get"];
+        get: operations["jarus_v2_5_arc_single_v1_risk_assessment_sora_v2_5_air_risk_classifications__arc_id__get"];
         put?: never;
         post?: never;
         delete?: never;
@@ -576,7 +576,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Generate a report containing derived SORA information used for regulatory evidence
+         * Generate a report containing derived information used for regulatory evidence
          * @description Generate a report containing derived SORA information used for regulatory evidence.
          *
          *
@@ -585,7 +585,7 @@ export interface paths {
          *     Intrinsic GRC determined and the highest likelihood to encounter another aircraft (as defined by Airspace Encounter
          *     Class) determining the ARC.
          */
-        post: operations["sora_report_v1_risk_assessment_sora_v2_5_report_post"];
+        post: operations["jarus_v2_5_sora_report_v1_risk_assessment_sora_v2_5_report_post"];
         delete?: never;
         options?: never;
         head?: never;
@@ -605,7 +605,7 @@ export interface paths {
          * Generate volumes that correspond to the SORA Semantic Model
          * @description Generate volumes that correspond to the SORA Semantic Model
          */
-        post: operations["semantic_model_volumes_v1_risk_assessment_sora_v2_5_semantic_model_volumes_post"];
+        post: operations["jarus_v2_5_semantic_model_volumes_v1_risk_assessment_sora_v2_5_semantic_model_volumes_post"];
         delete?: never;
         options?: never;
         head?: never;
@@ -680,7 +680,7 @@ export interface components {
          * ARC
          * @enum {string}
          */
-        ARC: "disabled" | "arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-b2" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-c5" | "arc-c6" | "arc-c7" | "arc-d1" | "arc-d2" | "arc-d3" | "arc-d4";
+        ARC: "arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-b2" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-c5" | "arc-c6" | "arc-c7" | "arc-d1" | "arc-d2" | "arc-d3" | "arc-d4";
         /**
          * Aircraft
          * @description Characteristics that define an aircraft for SORA calculations.
@@ -984,6 +984,34 @@ export interface components {
             type?: "chart";
             attributes: components["schemas"]["ChartAttributes"];
         };
+        /** Classification */
+        Classification: {
+            /**
+             * 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.
+             * @enum {integer}
+             */
+            final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+            /** Residual Arc */
+            residual_arc: components["schemas"]["ARC"][];
+            mitigations: components["schemas"]["Mitigations"];
+            /**
+             * 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;
+            /** @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"];
+            /** Controlled Ground Area Id */
+            controlled_ground_area_id?: string | null;
+            /** Atypical Airspace Id */
+            atypical_airspace_id?: string | null;
+            /** @default {
+             *       "max_cruise_speed": 20,
+             *       "characteristic_dimension": 0.5
+             *     } */
+            aircraft?: components["schemas"]["Aircraft"];
+        };
         /**
          * ContainmentRequirements
          * @description The containment requirements ensure that the target level of safety can be met for both ground and air risk in the
@@ -1320,9 +1348,8 @@ export interface components {
         };
         /**
          * GotoPathingCheckpoint
-         * @description Generate a path to a specified location under given `flight_parameters` accounting for given
-         *     `wind_parameters` and `pathing_settings`. All parameters are defined as to be used during the
-         *     leg flying towards this checkpoint.
+         * @description Generate a path to a specified location under given `flight_parameters` accounting for given `wind_parameters` and
+         *     `pathing_settings`. All parameters are defined as to be used during the leg flying towards this checkpoint.
          */
         GotoPathingCheckpoint: {
             /**
@@ -1436,101 +1463,6 @@ export interface components {
          * @enum {integer}
          */
         IntrinsicGRC: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
-        /** JarusV2_5Mitigations */
-        JarusV2_5Mitigations: {
-            /**
-             * Mitigation 1(A)
-             * @description Strategic mitigations for ground risk.
-             * @enum {string}
-             */
-            m1a: "none" | "low" | "medium";
-            /**
-             * Mitigation 1(B)
-             * @description Visual Line of Sight (VLOS) - avoid flying over people
-             * @enum {string}
-             */
-            m1b: "none" | "medium" | "high";
-            /**
-             * Mitigation 1(C)
-             * @description Tactical Mitigations - Ground observation
-             * @enum {string}
-             */
-            m1c: "none" | "low";
-            /**
-             * Mitigation 2
-             * @description Efforts to reduce UA impact dynamics
-             * @enum {string}
-             */
-            m2: "none" | "medium" | "high";
-        };
-        /** JarusV2_5SoraClassification */
-        JarusV2_5SoraClassification: {
-            /**
-             * 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.
-             * @enum {integer}
-             */
-            final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
-            /**
-             * Residual Air Risk Class (ARC)
-             * @description Qualitative classification of the rate at which a UAS would encounter a         manned aircraft in a given airspace environment.
-             *
-             *             - 'arc-a1' - ARC-a (NMAC Encounter Rate)
-             *
-             *             - 'arc-a2' - ARC-a (Linear Infrastructure)
-             *
-             *             - 'arc-a3' - ARC-a (Restricted Airspace)
-             *
-             *             - 'arc-a4' - ARC-a (Danger Area)
-             *
-             *             - 'arc-a5' - ARC-a (Self Declared)
-             *
-             *             - 'arc-b1' - ARC-b (>FL600)
-             *
-             *             - 'arc-b2' - ARC-b (<500ft AGL in Uncontrolled Airspace Over Rural Areas)
-             *
-             *             - 'arc-c1' - ARC-c (>500ft AGL but <FL600 in Uncontrolled Airspace Over Urban Areas)
-             *
-             *             - 'arc-c2' - ARC-c (>500ft AGL but <FL600 in Uncontrolled Airspace Over Rural Areas)
-             *
-             *             - 'arc-c3' - ARC-c (<500ft AGL in Controlled Airspace)
-             *
-             *             - 'arc-c4' - ARC-c (<500ft AGL in Uncontrolled Airspace Over Urban Areas)
-             *
-             *             - 'arc-c5' - ARC-c (<500ft AGL and TMZ)
-             *
-             *             - 'arc-c6' - ARC-c (<500ft AGL and Mode-C Veil)
-             *
-             *             - 'arc-c7' - ARC-c (Non Class B/C/D Airspace in an Airport/Heliport environment)
-             *
-             *             - 'arc-d1' - ARC-d (>500ft AGL but <FL600 in Controlled Airspace)
-             *
-             *             - 'arc-d2' - ARC-d (Class B/C/D Airspace in an Airport/Heliport environment)
-             *
-             *             - 'arc-d3' - ARC-d (>500ft AGL but <FL600 and TMZ)
-             *
-             *             - 'arc-d4' - ARC-d (>500ft AGL but <FL600 Mode-C Veil)
-             *
-             */
-            residual_arc: components["schemas"]["ARC"];
-            mitigations: components["schemas"]["JarusV2_5Mitigations"];
-            /**
-             * 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;
-            /** @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"];
-            /** Controlled Ground Area Id */
-            controlled_ground_area_id?: string | null;
-            /** Atypical Airspace Id */
-            atypical_airspace_id?: string | null;
-            /** @default {
-             *       "max_cruise_speed": 20,
-             *       "characteristic_dimension": 0.5
-             *     } */
-            aircraft?: components["schemas"]["Aircraft"];
-        };
         /** JsonApiException */
         JsonApiException: {
             /**
@@ -1731,6 +1663,33 @@ export interface components {
              */
             expires_in: number;
         };
+        /** Mitigations */
+        Mitigations: {
+            /**
+             * Mitigation 1(A)
+             * @description Strategic mitigations for ground risk.
+             * @enum {string}
+             */
+            m1a: "none" | "low" | "medium";
+            /**
+             * Mitigation 1(B)
+             * @description Visual Line of Sight (VLOS) - avoid flying over people
+             * @enum {string}
+             */
+            m1b: "none" | "medium" | "high";
+            /**
+             * Mitigation 1(C)
+             * @description Tactical Mitigations - Ground observation
+             * @enum {string}
+             */
+            m1c: "none" | "low";
+            /**
+             * Mitigation 2
+             * @description Efforts to reduce UA impact dynamics
+             * @enum {string}
+             */
+            m2: "none" | "medium" | "high";
+        };
         /**
          * PathingCheckpointParameters
          * @description Parameters that are applied to the leg of the journey towards the checkpoint
@@ -1840,14 +1799,14 @@ export interface components {
             volume_settings?: components["schemas"]["VolumeSettings"];
             /**
              * Checkpoints
-             * @description Points defining the Pathing Task that must be passed through along with                 flight parameters and settings for pathing. The first checkpoint must be of type:                 PathingCheckpointType.START and only occur once
+             * @description Points defining the Pathing Task that must be passed through along with flight parameters                 and settings for pathing. The first checkpoint must be of type: PathingCheckpointType.START and only                 occur once
              */
             checkpoints: (components["schemas"]["StartPathingCheckpoint"] | components["schemas"]["GotoPathingCheckpoint"])[];
         };
         /**
          * PathingTaskResponse
-         * @description Standard response for pathing task GET endpoint. The attributes with waypoints are included in
-         *     the response if the state is "successful".
+         * @description Standard response for pathing task GET endpoint. The attributes with waypoints are included in the response if the
+         *     state is "successful".
          */
         PathingTaskResponse: {
             /**
@@ -1938,53 +1897,6 @@ export interface components {
         };
         /** SailAttributes */
         SailAttributes: {
-            /**
-             * 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: components["schemas"]["FinalGRC"];
-            /**
-             * Residual Air Risk Class (ARC)
-             * @description Qualitative classification of the rate at which a UAS would encounter a         manned aircraft in a given airspace environment.
-             *
-             *             - 'arc-a1' - ARC-a (NMAC Encounter Rate)
-             *
-             *             - 'arc-a2' - ARC-a (Linear Infrastructure)
-             *
-             *             - 'arc-a3' - ARC-a (Restricted Airspace)
-             *
-             *             - 'arc-a4' - ARC-a (Danger Area)
-             *
-             *             - 'arc-a5' - ARC-a (Self Declared)
-             *
-             *             - 'arc-b1' - ARC-b (>FL600)
-             *
-             *             - 'arc-b2' - ARC-b (<500ft AGL in Uncontrolled Airspace Over Rural Areas)
-             *
-             *             - 'arc-c1' - ARC-c (>500ft AGL but <FL600 in Uncontrolled Airspace Over Urban Areas)
-             *
-             *             - 'arc-c2' - ARC-c (>500ft AGL but <FL600 in Uncontrolled Airspace Over Rural Areas)
-             *
-             *             - 'arc-c3' - ARC-c (<500ft AGL in Controlled Airspace)
-             *
-             *             - 'arc-c4' - ARC-c (<500ft AGL in Uncontrolled Airspace Over Urban Areas)
-             *
-             *             - 'arc-c5' - ARC-c (<500ft AGL and TMZ)
-             *
-             *             - 'arc-c6' - ARC-c (<500ft AGL and Mode-C Veil)
-             *
-             *             - 'arc-c7' - ARC-c (Non Class B/C/D Airspace in an Airport/Heliport environment)
-             *
-             *             - 'arc-d1' - ARC-d (>500ft AGL but <FL600 in Controlled Airspace)
-             *
-             *             - 'arc-d2' - ARC-d (Class B/C/D Airspace in an Airport/Heliport environment)
-             *
-             *             - 'arc-d3' - ARC-d (>500ft AGL but <FL600 and TMZ)
-             *
-             *             - 'arc-d4' - ARC-d (>500ft AGL but <FL600 Mode-C Veil)
-             *
-             */
-            arc: components["schemas"]["ARC"];
             /**
              * SAIL
              * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
@@ -2002,13 +1914,13 @@ export interface components {
         "SoraClassification-Input": {
             /** @description The implementation of SORA that is described by `payload` */
             implementation: components["schemas"]["SoraImplementation"];
-            payload: components["schemas"]["JarusV2_5SoraClassification"];
+            payload: components["schemas"]["Classification"];
         };
         /** SoraClassification */
         "SoraClassification-Output": {
             /** @description The implementation of SORA that is described by `payload` */
             implementation: components["schemas"]["SoraImplementation"];
-            payload: components["schemas"]["JarusV2_5SoraClassification"];
+            payload: components["schemas"]["Classification"];
         };
         /** SoraClassificationResponse */
         SoraClassificationResponse: {
@@ -2128,7 +2040,7 @@ export interface components {
              *       "characteristic_dimension": 0.5
              *     } */
             aircraft?: components["schemas"]["Aircraft"];
-            mitigations: components["schemas"]["JarusV2_5Mitigations"];
+            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"];
             /** @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. */
@@ -4383,12 +4295,13 @@ export interface operations {
             };
         };
     };
-    sora_sail_score_v1_risk_assessment_sora_v2_5_sail_get: {
+    jarus_v2_5_sail_v1_risk_assessment_sora_v2_5_sail_get: {
         parameters: {
             query: {
                 /** @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: components["schemas"]["FinalGRC"];
-                /** @description Qualitative classification of the rate at which a UAS would encounter a         manned aircraft in a given airspace environment.
+                /**
+                 * @description Qualitative classification of the rate at which a UAS would encounter a         manned aircraft in a given airspace environment.
                  *
                  *             - 'arc-a1' - ARC-a (NMAC Encounter Rate)
                  *
@@ -4425,8 +4338,13 @@ export interface operations {
                  *             - 'arc-d3' - ARC-d (>500ft AGL but <FL600 and TMZ)
                  *
                  *             - 'arc-d4' - ARC-d (>500ft AGL but <FL600 Mode-C Veil)
-                 *                */
-                arc: components["schemas"]["ARC"];
+                 *
+                 * @example [
+                 *       "arc-b2",
+                 *       "arc-b3"
+                 *     ]
+                 */
+                arc: components["schemas"]["ARC"][];
             };
             header?: never;
             path?: never;
@@ -4472,7 +4390,7 @@ export interface operations {
             };
         };
     };
-    ARCs_list_v1_risk_assessment_sora_v2_5_air_risk_classifications_get: {
+    jarus_v2_5_ARCs_list_v1_risk_assessment_sora_v2_5_air_risk_classifications_get: {
         parameters: {
             query?: never;
             header?: never;
@@ -4510,7 +4428,7 @@ export interface operations {
             };
         };
     };
-    arc_single_v1_risk_assessment_sora_v2_5_air_risk_classifications__arc_id__get: {
+    jarus_v2_5_arc_single_v1_risk_assessment_sora_v2_5_air_risk_classifications__arc_id__get: {
         parameters: {
             query?: never;
             header?: never;
@@ -4606,7 +4524,7 @@ export interface operations {
             };
         };
     };
-    sora_report_v1_risk_assessment_sora_v2_5_report_post: {
+    jarus_v2_5_sora_report_v1_risk_assessment_sora_v2_5_report_post: {
         parameters: {
             query?: never;
             header?: never;
@@ -4657,7 +4575,7 @@ export interface operations {
             };
         };
     };
-    semantic_model_volumes_v1_risk_assessment_sora_v2_5_semantic_model_volumes_post: {
+    jarus_v2_5_semantic_model_volumes_v1_risk_assessment_sora_v2_5_semantic_model_volumes_post: {
         parameters: {
             query?: never;
             header?: never;

package/package.json

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