@volant-autonomy/via-sdk 1.3583.1 → 1.3619.1

package/dist/direct.d.ts

@@ -1,10 +1,14 @@
 import createFetcher from './fetch';
-import { bodyOf, queryOf, pathOf } from './types';
+import { bodyOf, queryOf, pathOf, schemas, PathingTaskState } from './types';
 import type { paths } from './volant-schema';
 type requestOptions = {
     abortKey?: string;
     fetch?: typeof globalThis.fetch;
 };
+type PathingTaskEvent = {
+    state: PathingTaskState;
+    terminated: boolean;
+};
 export type getAllFlightplans = paths['/flightplans/']['get'];
 export type createDraftFlightplan = paths['/flightplans/']['post'];
 export type modifyDraftFlightplan = paths['/flightplans/{flightplan_id}']['put'];
@@ -22,6 +26,7 @@ export type modifyAirspaceConstraint = paths['/airspace_constraints/{airspace_co
 export type changeAirspaceConstraintState = paths['/airspace_constraints/{airspace_constraints_id}/state']['post'];
 export type createPathingTask = paths['/pathing_tasks/']['post'];
 export type getPathingTask = paths['/pathing_tasks/{pathing_task_id}']['get'];
+export type getPathingTaskStateStream = paths['/pathing_tasks/{pathing_task_id}/state']['get'];
 export type getAllCharts = paths['/charts/']['get'];
 export type getChart = paths['/charts/{chart_id}']['get'];
 export type getSailV2_5 = paths['/risk_assessment/sora/v2.5/sail']['get'];
@@ -55,6 +60,10 @@ export type getAllGeocages = paths['/geocages/']['get'];
 export type createGeocage = paths['/geocages/']['post'];
 export type updateGeocage = paths['/geocages/{geocage_id}']['put'];
 export type deleteGeocage = paths['/geocages/{geocage_id}']['delete'];
+export type getCostDataset = paths['/cost_datasets/{cost_dataset_id}']['get'];
+export type getAllCostDatasets = paths['/cost_datasets/']['get'];
+export type createCostDataset = paths['/cost_datasets/']['post'];
+export type deleteCostDataset = paths['/cost_datasets/{cost_dataset_id}']['delete'];
 export declare class Direct {
     private fetcher;
     constructor(fetcher: ReturnType<typeof createFetcher<paths>>);
@@ -218,7 +227,7 @@ export declare class Direct {
      * Retrieve Flightplan Statistics
      * @description Retrieve statistics for the specified flightplan, including the nominal time and cost.
      */
-    getFlightplanStatistics<Opts extends requestOptions = {}>(id: pathOf<getFlightplanStatistics>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
+    getFlightplanStatistics<Opts extends requestOptions = {}>(id: pathOf<getFlightplanStatistics>['flightplan_id'], args: queryOf<getFlightplanStatistics>, opts?: Opts | requestOptions): Promise<{
         data?: never;
         error: {
             errors: {
@@ -590,6 +599,16 @@ export declare class Direct {
         response: Response;
         aborted: false;
     }>;
+    /**
+     * Receive state change updates for a pathing task
+     * @description Opens a persistent connection that sends real-time updates about changes in a pathing task's state using Server-Sent
+     *     Events (SSE).
+     *
+     *     Provides an event stream that can be connected to that will provide updates when the state of the specified pathing
+     *     task changes. Once it has reached it's final state, the last update is pushed and the stream is automatically
+     *     closed.
+     */
+    getPathingTaskStateStream(id: pathOf<getPathingTaskStateStream>['pathing_task_id'], onMessage?: (payload: PathingTaskEvent) => void, onFail?: () => void): Promise<PathingTaskEvent>;
     /**
      * List all available Charts
      * @description List user's charts, including chart id and bounds.
@@ -1533,6 +1552,130 @@ export declare class Direct {
         response: Response;
         aborted: false;
     }>;
+    /**
+     * Get a Cost Dataset
+     * @description Get a Cost Dataset
+     */
+    getCostDataset<Opts extends requestOptions = {}>(id: pathOf<getCostDataset>['cost_dataset_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: {
+            id: string;
+            type?: "cost_dataset";
+            attributes: import("./volant-schema").components["schemas"]["CostDatasetAttributes"];
+        };
+        error?: never;
+        response: Response;
+        aborted: false;
+    }>;
+    /**
+     * List Cost Datasets
+     * @description Get a list of Cost Datasets, ordered by last time updated
+     */
+    getAllCostDatasets<Opts extends requestOptions = {}>(args: queryOf<getAllCostDatasets>, 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: {
+            id: string;
+            type?: "cost_dataset";
+            attributes: import("./volant-schema").components["schemas"]["CostDatasetAttributes"];
+        }[];
+        error?: never;
+        response: Response;
+        aborted: false;
+    }>;
+    /**
+     * Create a Cost Dataset
+     * @description Create a Cost Dataset
+     */
+    createCostDataset<Opts extends requestOptions = {}>(args: {
+        chart_id: string;
+        valid_time_ranges: schemas['RasterValidityTime'][];
+        geotiff: Blob;
+    }, opts?: Opts | requestOptions): Promise<{
+        data?: never;
+        error: {
+            errors: {
+                detail: string;
+                status: "401" | "400" | "422" | "403";
+            }[];
+            status: "401" | "400" | "422" | "403";
+        };
+        response: Response;
+        aborted: false;
+    } | ("contentType" | keyof Opts extends never ? never : (Opts & {
+        contentType: "none";
+    })["abortKey"] extends undefined ? never : (Opts & {
+        contentType: "none";
+    })["abortKey"] extends string | undefined ? {
+        data?: never;
+        error?: never;
+        response?: never;
+        aborted: true;
+    } : never) | {
+        data: {
+            id: string;
+            type?: "cost_dataset";
+            attributes: import("./volant-schema").components["schemas"]["CostDatasetAttributes"];
+        };
+        error?: never;
+        response: Response;
+        aborted: false;
+    }>;
+    /**
+     * Delete a Cost Dataset
+     * @description Delete a Cost Dataset.
+     */
+    deleteCostDataset<Opts extends requestOptions = {}>(id: pathOf<deleteCostDataset>['cost_dataset_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: boolean;
+        error?: never;
+        response: Response;
+        aborted: false;
+    }>;
     /**
      * Generate a raster pattern
      * @description Generate a raster pattern that covers a specified search polygon

package/dist/fetch.d.ts

@@ -5,6 +5,7 @@ type requestOptions = {
     abortKey?: string;
     fetch?: typeof globalThis.fetch;
     parseAs?: ParseAs;
+    contentType?: 'application/json' | 'none';
 };
 /**
  * Get the types of the parameters of an endpoint but if it does not have any
@@ -30,7 +31,7 @@ type BodyOption<Endpoint> = Endpoint extends {
 } : {
     body: bodyOf<Endpoint>;
 } : {
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | BodyInit;
 };
 /**
  * Combines the body and other parameters into one type, with stuff being optional

package/dist/index.cjs.js

@@ -76,8 +76,8 @@ class Composite {
                     await sleep(50);
                     continue;
                 case 'successful':
-                    if ((_a = data.attributes) === null || _a === undefined ? undefined : _a.waypoints) {
-                        return { data: (_b = data.attributes) === null || _b === undefined ? undefined : _b.waypoints };
+                    if ((_a = data.attributes) === null || _a === void 0 ? void 0 : _a.waypoints) {
+                        return { data: (_b = data.attributes) === null || _b === void 0 ? void 0 : _b.waypoints };
                     }
                     else {
                         throw new Error(`endpoint did not return waypoints ${data}`); // TODO:
@@ -133,8 +133,8 @@ class Direct {
         }
         return resp;
     }
-    async getFlightplanStatistics(id, opts) {
-        const resp = await this.fetcher.GET('/flightplans/{flightplan_id}/statistics', { path: { flightplan_id: id } }, opts);
+    async getFlightplanStatistics(id, args, opts) {
+        const resp = await this.fetcher.GET('/flightplans/{flightplan_id}/statistics', { path: { flightplan_id: id }, query: args }, opts);
         if (resp.error === undefined && !resp.aborted) {
             return Object.assign(Object.assign({}, resp), { data: resp.data.data });
         }
@@ -221,6 +221,30 @@ class Direct {
         }
         return resp;
     }
+    getPathingTaskStateStream(id, onMessage, onFail) {
+        return new Promise((resolve, reject) => {
+            const eventSource = new EventSource(`/api/v1.0/pathing_tasks/${id}/state`);
+            eventSource.onmessage = (event) => {
+                const data = JSON.parse(event.data);
+                if (data.error === true) {
+                    onFail === null || onFail === void 0 ? void 0 : onFail();
+                    eventSource.close();
+                    reject(new Error(`Task stream returned error: ${data.payload}`));
+                    return;
+                }
+                if (data.payload.terminated) {
+                    eventSource.close();
+                    resolve(data.payload);
+                }
+                onMessage === null || onMessage === void 0 ? void 0 : onMessage(data.payload);
+            };
+            eventSource.onerror = (err) => {
+                eventSource.close();
+                onFail === null || onFail === void 0 ? void 0 : onFail();
+                reject(err);
+            };
+        });
+    }
     /// charts
     async getAllCharts(opts) {
         const resp = await this.fetcher.GET('/charts/', {}, opts);
@@ -456,6 +480,43 @@ class Direct {
         }
         return resp;
     }
+    /// cost datasets
+    async getCostDataset(id, opts) {
+        const resp = await this.fetcher.GET('/cost_datasets/{cost_dataset_id}', { path: { cost_dataset_id: id } }, opts);
+        if (resp.error === undefined && !resp.aborted) {
+            return Object.assign(Object.assign({}, resp), { data: resp.data.data });
+        }
+        return resp;
+    }
+    async getAllCostDatasets(args, opts) {
+        const resp = await this.fetcher.GET('/cost_datasets/', { query: args }, opts);
+        if (resp.error === undefined && !resp.aborted) {
+            return Object.assign(Object.assign({}, resp), { data: resp.data.data.map((x) => x.data) });
+        }
+        return resp;
+    }
+    async createCostDataset(args, opts) {
+        const formData = new FormData();
+        formData.append('chart_id', args.chart_id);
+        formData.append('valid_time_ranges', JSON.stringify(args.valid_time_ranges));
+        formData.append('geotiff', args.geotiff);
+        const resp = await this.fetcher.POST('/cost_datasets/', { body: formData }, Object.assign(Object.assign({}, opts), { 
+            // when sending a FormData object the browser will automatically
+            // set the Content-Type header to the correct value, if (and only if)
+            // you don't set it yourself
+            contentType: 'none' }));
+        if (resp.error === undefined && !resp.aborted) {
+            return Object.assign(Object.assign({}, resp), { data: resp.data.data });
+        }
+        return resp;
+    }
+    async deleteCostDataset(id, opts) {
+        const resp = await this.fetcher.DELETE('/cost_datasets/{cost_dataset_id}', { path: { cost_dataset_id: id } }, opts);
+        if (resp.error === undefined && !resp.aborted) {
+            return Object.assign(Object.assign({}, resp), { data: true });
+        }
+        return resp;
+    }
     /// flight patterns
     async createRasterPattern(args, opts) {
         const resp = await this.fetcher.POST('/flight_patterns/raster', { body: args }, opts);
@@ -666,17 +727,19 @@ function defaultPathSerializer(pathname, pathParams) {
   return nextURL;
 }
 
+var version = "1.3619.1";
+
 const querySerializer = createQuerySerializer();
 class Fetcher {
     constructor(args) {
         var _a, _b, _c, _d;
         this.opts = {
-            url: (_a = args.url) !== null && _a !== undefined ? _a : 'https://via.volantautonomy.com/api/v1.0',
-            fetchFn: (_b = args.fetchFn) !== null && _b !== undefined ? _b : undefined,
-            authFetchFn: (_c = args.authFetchFn) !== null && _c !== undefined ? _c : undefined,
+            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 : undefined,
             username: args.username,
             password: args.password,
-            ignoreAuth: (_d = args.ignoreAuth) !== null && _d !== undefined ? _d : false
+            ignoreAuth: (_d = args.ignoreAuth) !== null && _d !== void 0 ? _d : false
         };
         this.aborts = {};
         this.accessToken = undefined;
@@ -688,7 +751,7 @@ class Fetcher {
         if (this.opts.username === undefined || this.opts.password === undefined) {
             throw new UnauthenticatedError('ignoreAuth is not true and either username or password is missing');
         }
-        const authFetchFn = (_a = this.opts.authFetchFn) !== null && _a !== undefined ? _a : globalThis.fetch;
+        const authFetchFn = (_a = this.opts.authFetchFn) !== null && _a !== void 0 ? _a : globalThis.fetch;
         const resp = await authFetchFn(this.opts.url + '/login', {
             body: JSON.stringify({
                 username: this.opts.username,
@@ -696,7 +759,7 @@ class Fetcher {
             }),
             redirect: 'follow',
             method: 'post',
-            headers: { 'Content-Type': 'application/json' }
+            headers: { 'Content-Type': 'application/json', 'X-Via-Sdk-Version': version }
         });
         if (resp.ok) {
             const data = (await resp.json());
@@ -711,7 +774,7 @@ class Fetcher {
     handleAbortKey(abortKey) {
         var _a;
         if (abortKey) {
-            (_a = this.aborts[abortKey]) === null || _a === undefined ? undefined : _a.abort();
+            (_a = this.aborts[abortKey]) === null || _a === void 0 ? void 0 : _a.abort();
             const abortController = new AbortController();
             this.aborts[abortKey] = abortController;
             return abortController.signal;
@@ -723,7 +786,7 @@ class Fetcher {
         var _a;
         const error = (await response.json());
         // NOTE: throws away the status codes inside of the individual errors
-        if (((_a = error === null || error === undefined ? undefined : error.errors) === null || _a === undefined ? undefined : _a.length) === 0) {
+        if (((_a = error === null || error === void 0 ? void 0 : error.errors) === null || _a === void 0 ? void 0 : _a.length) === 0) {
             return {
                 status: String(response.status),
                 errors: [
@@ -737,7 +800,7 @@ class Fetcher {
         else {
             return {
                 status: String(response.status),
-                errors: error === null || error === undefined ? undefined : error.errors.map((err) => {
+                errors: error === null || error === void 0 ? void 0 : error.errors.map((err) => {
                     return {
                         status: String(err.status),
                         detail: err.detail
@@ -750,10 +813,10 @@ class Fetcher {
     createFinalURL(path, options) {
         var _a;
         let finalURL = `${this.opts.url}${path}`;
-        if (options === null || options === undefined ? undefined : options.path) {
+        if (options === null || options === void 0 ? void 0 : options.path) {
             finalURL = defaultPathSerializer(finalURL, options.path);
         }
-        const search = querySerializer((_a = options.query) !== null && _a !== undefined ? _a : {});
+        const search = querySerializer((_a = options.query) !== null && _a !== void 0 ? _a : {});
         if (search) {
             finalURL += `?${search}`;
         }
@@ -761,19 +824,25 @@ class Fetcher {
     }
     /** The actual fetch wrapper. It is type inference blind, beyond the parseAs type */
     async fetcher(method, path, data, opts) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         if (!this.opts.ignoreAuth) {
             if (!this.accessToken || this.expiry <= Date.now()) {
                 await this.doAuth();
             }
         }
-        const fetchFn = (_b = (_a = opts === null || opts === undefined ? undefined : opts.fetch) !== null && _a !== undefined ? _a : this.opts.fetchFn) !== null && _b !== undefined ? _b : globalThis.fetch;
-        const parseAs = (_c = opts === null || opts === undefined ? undefined : opts.parseAs) !== null && _c !== undefined ? _c : 'json';
-        const request = new Request(this.createFinalURL(path, { query: data === null || data === undefined ? undefined : data.query, path: data === null || data === undefined ? undefined : data.path }), {
+        const fetchFn = (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.fetch) !== null && _a !== void 0 ? _a : this.opts.fetchFn) !== null && _b !== void 0 ? _b : globalThis.fetch;
+        const parseAs = (_c = opts === null || opts === void 0 ? void 0 : opts.parseAs) !== null && _c !== void 0 ? _c : 'json';
+        const contentType = (_d = opts === null || opts === void 0 ? void 0 : opts.contentType) !== null && _d !== void 0 ? _d : 'application/json';
+        const body = contentType === 'application/json' ? JSON.stringify(data === null || data === void 0 ? void 0 : data.body) : data === null || data === void 0 ? void 0 : data.body;
+        const headers = { 'X-Via-Sdk-Version': version };
+        if (contentType !== 'none') {
+            headers['Content-Type'] = contentType;
+        }
+        const request = new Request(this.createFinalURL(path, { query: data === null || data === void 0 ? void 0 : data.query, path: data === null || data === void 0 ? void 0 : data.path }), {
             redirect: 'follow',
-            signal: this.handleAbortKey(opts === null || opts === undefined ? undefined : opts.abortKey),
-            body: JSON.stringify(data === null || data === undefined ? undefined : data.body),
-            headers: Object.assign({ 'Content-Type': 'application/json' }, data === null || data === undefined ? undefined : data.header),
+            signal: this.handleAbortKey(opts === null || opts === void 0 ? void 0 : opts.abortKey),
+            body,
+            headers: Object.assign(Object.assign({}, headers), data === null || data === void 0 ? void 0 : data.header),
             method
         });
         if (!this.opts.ignoreAuth) {