@volant-autonomy/via-sdk 1.2773.1 → 1.2801.1

package/README.md

@@ -3,7 +3,7 @@
 `@volant-autonomy/via-sdk` is an auto-generated type-safe wrapper for the Via API with automatic authentication handling.
 Usable in TypeScript or JavaScript.
 
-**Note:** To use this SDK you need access to [the Via API](https://via.volantautonomy.com/api/v1.0/docs). Please contact us at via@volantautonomy.com to obtain access.
+**Note:** To use this SDK you need access to [the Via API](https://via.volantautonomy.com/api/v1.0/docs). Please contact us at <via@volantautonomy.com> to obtain access.
 
 ## Installation
 
@@ -45,8 +45,10 @@ For example, `GET /flightplans/` takes in a filter from a query parameter. The S
 Another example, `GET /flightplans/{flightplan_id}` takes in a flightplan ID through the path. The SDK does this through function arguments, ie: `SDK.direct.getFlightplan('aaaaa-bbbbb-ccccc')`
 
 ## Feature list
+
 As well as offering methods for all endpoints within the API, you have access to a variety of features in this API
 Wrapper that help make some common workflows more convenient. These features are as follows:
+
 | Feature                    | Remark                                                                              | Method                         |
 | -------------------------- |-------------------------------------------------------------------------------------| -------------------------------|
 | Upsert Flightplan          | Create a flightplan no ID is supplied. Update existing flightplan if ID is supplied | upsertFlightplan()             |
@@ -58,7 +60,6 @@ Wrapper that help make some common workflows more convenient. These features are
 | Temporal Deconfliction     | Will attempt to temporally deconflict your flightplan and update the departure time | attemptTemporalDeconfliction() |
 | Pathing                    | Will perform a pathing request and return the pathing result                        | doPathingTask()                |
 
-
 ### Response data format
 
 Direct functions return an object with a data field and an error field. Only exactly one of these is defined, the other is undefined.

package/dist/direct.d.ts

@@ -12,7 +12,6 @@ export type getFlightplan = paths['/flightplans/{flightplan_id}']['get'];
 export type getFlightplanWaypointsDetailed = paths['/flightplans/{flightplan_id}/waypoints_detail']['get'];
 export type getFlightplanStatistics = paths['/flightplans/{flightplan_id}/statistics']['get'];
 export type getFlightplanVolumes = paths['/flightplans/{flightplan_id}/volumes']['get'];
-export type getFlightplanConflicts = paths['/flightplans/{flightplan_id}/conflicts']['get'];
 export type getFlightplanDeconflictedStartTime = paths['/flightplans/{flightplan_id}/start_time_deconflict']['get'];
 export type changeFlightplanState = paths['/flightplans/{flightplan_id}/state']['post'];
 export type getFlightplanAsFile = paths['/flightplans/{flightplan_id}/content']['get'];
@@ -267,42 +266,6 @@ export declare class Direct {
         response: Response;
         aborted: false;
     }>;
-    /**
-     * Retrieve Flightplan Conflicts
-     * @deprecated
-     * @description Retrieve all the conflicts for the specified flightplan, categorised by their state.
-     *
-     *     Flightplans of state `Closed` are ignored.
-     *
-     *     Note that Flightplans which are in the category `Draft` will not prevent transitioning the specified flightplan in
-     *     to the `Accepted` state and instead are intended as a warning. Flightplans in the `Accepted` state will prevent
-     *     transition of the specified flightplan to `Accepted`.
-     */
-    getFlightplanConflicts<Opts extends requestOptions = {}>(id: pathOf<getFlightplanConflicts>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
-        data?: never;
-        error: {
-            errors: {
-                detail: string;
-                status: "401" | "400" | "422" | "404";
-            }[];
-            status: "401" | "400" | "422" | "404";
-        };
-        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: {
-            data: import("./volant-schema").components["schemas"]["FlightplanConflictResponse"] | import("./volant-schema").components["schemas"]["AirspaceConstraintConflictResponse"];
-            links: import("./volant-schema").components["schemas"]["Links"];
-        }[];
-        error?: never;
-        response: Response;
-        aborted: false;
-    }>;
     /**
      * Returns the inputted flightplan with an updated start time that does not conflict
      * @description Get a new start time for a draft flightplan which will not conflict with any occupied airspace.

package/dist/direct.js

@@ -81,15 +81,6 @@ class Direct {
             return resp;
         });
     }
-    getFlightplanConflicts(id, opts) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const resp = yield this.fetcher.GET('/flightplans/{flightplan_id}/conflicts', { path: { flightplan_id: id } }, opts);
-            if (resp.error === undefined && !resp.aborted) {
-                return Object.assign(Object.assign({}, resp), { data: resp.data.data });
-            }
-            return resp;
-        });
-    }
     // TODO: make a wrapper for this which updates the existing flightplan to have this new start time
     getFlightplanDeconflictedStartTime(id, args, opts) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/docstringTransformer.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = default_1;
+let schemaLocated = false;
 /**
  * Follows the 'paths' import to get a mapping of endpoint -> docstrings from the schema file.
  * The relevant part of the schema is in the shape below
@@ -29,6 +30,7 @@ function gatherDocstrings(node, tsInstance, program) {
     // if this import is not the schema, stop
     if (!(importSymbol === null || importSymbol === void 0 ? void 0 : importSymbol.getName().includes('schema')))
         return;
+    schemaLocated = true;
     const exportSymbols = typeChecker.getExportsOfModule(importSymbol);
     for (const rootSymbol of exportSymbols) {
         if (rootSymbol.getName() === 'paths') {
@@ -146,6 +148,9 @@ function default_1(program, _pluginConfig, { ts: tsInstance }) {
             const endpointDocstrings = gatherDocstrings(sourceFile, tsInstance, program);
             if (endpointDocstrings === undefined) {
                 console.error('endpoint docstrings were not found');
+                if (!schemaLocated) {
+                    console.error('the schema file was not found at all, file is likely missing (try npm run gen-schema)');
+                }
                 return sourceFile;
             }
             const endpointIdentifiers = gatherIdentifiers(sourceFile, {}, tsInstance, program);

package/dist/volant-schema.d.ts

@@ -157,33 +157,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/flightplans/{flightplan_id}/conflicts": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Retrieve Flightplan Conflicts
-         * @deprecated
-         * @description Retrieve all the conflicts for the specified flightplan, categorised by their state.
-         *
-         *     Flightplans of state `Closed` are ignored.
-         *
-         *     Note that Flightplans which are in the category `Draft` will not prevent transitioning the specified flightplan in
-         *     to the `Accepted` state and instead are intended as a warning. Flightplans in the `Accepted` state will prevent
-         *     transition of the specified flightplan to `Accepted`.
-         */
-        get: operations["flightplan_conflicts_v1_flightplans__flightplan_id__conflicts_get"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/flightplans/{flightplan_id}/start_time_deconflict": {
         parameters: {
             query?: never;
@@ -794,26 +767,6 @@ export interface components {
              */
             volumes: components["schemas"]["Volume4D-Output"][];
         };
-        /**
-         * AirspaceConstraintConflictResponse
-         * @description Summary of a Conflicting Airspace Constraint Resource.
-         */
-        AirspaceConstraintConflictResponse: {
-            /**
-             * Airspace Constraint ID
-             * Format: uuid
-             * @description Unique identifier of the Airspace Constraint.
-             */
-            id: string;
-            /**
-             * Type
-             * @default airspace_constraint
-             * @constant
-             * @enum {string}
-             */
-            type?: "airspace_constraint";
-            meta: components["schemas"]["AirspaceConstraintMeta"];
-        };
         /** AirspaceConstraintMeta */
         AirspaceConstraintMeta: {
             /** @description State of an airspace constraint.
@@ -1225,26 +1178,6 @@ export interface components {
             /** @default {} */
             volume_settings?: components["schemas"]["VolumeSettings"];
         };
-        /**
-         * FlightplanConflictResponse
-         * @description Summary of a Conflicting Flightplan Resource.
-         */
-        FlightplanConflictResponse: {
-            /**
-             * Flightplan ID
-             * Format: uuid
-             * @description Unique identifier of the flightplan.
-             */
-            id: string;
-            /**
-             * Type
-             * @default flightplan
-             * @constant
-             * @enum {string}
-             */
-            type?: "flightplan";
-            meta: components["schemas"]["FlightplanMeta"];
-        };
         /** FlightplanMeta */
         FlightplanMeta: {
             /** @description State of a flightplan.
@@ -1649,12 +1582,6 @@ export interface components {
             data: components["schemas"]["JsonApiResponse_FlightplanResponse_"][];
             links: components["schemas"]["Links"];
         };
-        /** JsonApiListResponse[JsonApiResponse[Union[FlightplanConflictResponse, AirspaceConstraintConflictResponse]]] */
-        JsonApiListResponse_JsonApiResponse_Union_FlightplanConflictResponse__AirspaceConstraintConflictResponse___: {
-            /** Data */
-            data: components["schemas"]["JsonApiResponse_Union_FlightplanConflictResponse__AirspaceConstraintConflictResponse__"][];
-            links: components["schemas"]["Links"];
-        };
         /** JsonApiListResponse[JsonApiResponse[VolumeResponse]] */
         JsonApiListResponse_JsonApiResponse_VolumeResponse__: {
             /** Data */
@@ -1731,12 +1658,6 @@ export interface components {
             data: components["schemas"]["StatisticsResponse"];
             links: components["schemas"]["Links"];
         };
-        /** JsonApiResponse[Union[FlightplanConflictResponse, AirspaceConstraintConflictResponse]] */
-        JsonApiResponse_Union_FlightplanConflictResponse__AirspaceConstraintConflictResponse__: {
-            /** Data */
-            data: components["schemas"]["FlightplanConflictResponse"] | components["schemas"]["AirspaceConstraintConflictResponse"];
-            links: components["schemas"]["Links"];
-        };
         /** JsonApiResponse[VolumeResponse] */
         JsonApiResponse_VolumeResponse_: {
             data: components["schemas"]["VolumeResponse"];
@@ -2208,6 +2129,16 @@ export interface components {
              * @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;
         };
         /** SoraReportResponse */
         SoraReportResponse: {
@@ -3147,65 +3078,6 @@ export interface operations {
             };
         };
     };
-    flightplan_conflicts_v1_flightplans__flightplan_id__conflicts_get: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description Unique identifier of the flightplan. */
-                flightplan_id: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["JsonApiListResponse_JsonApiResponse_Union_FlightplanConflictResponse__AirspaceConstraintConflictResponse___"];
-                };
-            };
-            /** @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 The requested resource could not be found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["JsonApiExceptionResponse"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
     flightplan_deconflicted_start_time_v1_flightplans__flightplan_id__start_time_deconflict_get: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volant-autonomy/via-sdk",
-  "version": "1.2773.1",
+  "version": "1.2801.1",
   "license": "MIT",
   "source": "src/index.ts",
   "types": "dist/index.d.ts",
@@ -32,12 +32,12 @@
     "standard": "^17.0.0",
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
-    "ts-patch": "^3.2.1",
-    "typescript": "^5.5.4"
+    "ts-patch": "^3.3.0",
+    "typescript": "^5.7.2"
   },
   "scripts": {
     "prepack": "npm run build",
-    "build": "tspc -p tsconfig.build.json",
+    "build": "./build.sh",
     "build-test": "./build-test.sh",
     "gen-schema": "./gen-schema.sh",
     "test": "node --experimental-vm-modules ./node_modules/.bin/jest --silent",