@monkvision/network 4.0.0

package/lib/src/api/models/view.d.ts

@@ -0,0 +1,24 @@
+import type { ApiRenderedOutputs } from './renderedOutput';
+export interface ApiBoundingBox {
+    xmin: number;
+    ymin: number;
+    width: number;
+    height: number;
+}
+export type ApiPolygons = number[][][];
+export interface ApiSpecification {
+    bounding_box?: ApiBoundingBox;
+    polygons?: ApiPolygons;
+}
+export interface ApiImageRegion {
+    id: string;
+    image_id: string;
+    specification: ApiSpecification;
+}
+export interface ApiView {
+    element_id: string;
+    id: string;
+    image_region: ApiImageRegion;
+    rendered_outputs: ApiRenderedOutputs;
+}
+export type ApiViews = ApiView[];

package/lib/src/api/models/view.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=view.js.map

package/lib/src/api/models/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../../src/api/models/view.ts"],"names":[],"mappings":""}

package/lib/src/api/models/wheelAnalysis.d.ts

@@ -0,0 +1,13 @@
+import type { ApiLabelPrediction } from './common';
+export type ApiWheelType = 'wheel_front_left' | 'wheel_front_right' | 'wheel_back_left' | 'wheel_back_right';
+export interface ApiWheelAnalysisWithImageId {
+    hubcap_condition: ApiLabelPrediction;
+    hubcap_over_rim: ApiLabelPrediction;
+    hubcap_visual_aspect: ApiLabelPrediction;
+    image_id?: string;
+    rim_condition: ApiLabelPrediction;
+    rim_material: ApiLabelPrediction;
+    rim_visual_aspect: ApiLabelPrediction;
+    wheel_name?: ApiWheelType;
+}
+export type ApiWheelAnalysis = ApiWheelAnalysisWithImageId[];

package/lib/src/api/models/wheelAnalysis.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=wheelAnalysis.js.map

package/lib/src/api/models/wheelAnalysis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wheelAnalysis.js","sourceRoot":"","sources":["../../../../src/api/models/wheelAnalysis.ts"],"names":[],"mappings":""}

package/lib/src/api/react.d.ts

@@ -0,0 +1,69 @@
+import { MonkApiConfig } from './config';
+/**
+ * Custom hook that returns a MonkApi object in which all the requests don't need a config param (since it is provided
+ * as a prop to this hook), and automatically update the state (using the MonkState hook) when a state has been
+ * received.
+ *
+ * **Note: This hook needs to have the MonkContext set up and defined in order to work properly.**
+ *
+ * @see MonkApi
+ */
+export declare function useMonkApi(config: MonkApiConfig): {
+    /**
+     * Fetch the details of an inspection using its ID.
+     *
+     * @param options The options of the request.
+     */
+    getInspection: (options: import("./inspection").GetInspectionOptions) => Promise<import("./types").MonkApiResponse<import("./inspection").GetInspectionResponse, import("./models").ApiInspectionGet>>;
+    /**
+     * Create a new inspection with the given options. See the `CreateInspectionOptions` interface for more details.
+     *
+     * @param options The options of the inspection.
+     * @see CreateInspectionOptions
+     */
+    createInspection: (options: import("@monkvision/types").CreateInspectionOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
+    /**
+     * Add a new image to an inspection.
+     *
+     * @param options Upload options for the image.
+     */
+    addImage: (options: import("./image").AddImageOptions) => Promise<import("./types").MonkApiResponse<import("./image").AddImageResponse, import("./models").ApiImage>>;
+    /**
+     * Update the progress status of an inspection task.
+     *
+     * **Note : This API call is known to sometimes fail for unknown reasons. In order to fix this, we added a retry
+     * config to this API request : when failing, this request will retry itself up to 4 times (5 API calls in total),
+     * with exponentially increasing delay between each request (max delay : 1.5s).**
+     *
+     * @param options The options of the request.
+     */
+    updateTaskStatus: (options: import("./task").UpdateTaskStatusOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
+    /**
+     * Start some inspection tasks that were in the NOT_STARTED status. This function actually makes one API call for
+     * each task provided using the `updateTaskStatus`.
+     *
+     * **Note : This API call is known to sometimes fail for unknown reasons. Please take note of the details provided
+     * in the TSDoc of the `updateTaskStatus` function.**
+     *
+     * @param options The options of the request.
+     *
+     * @see updateTaskStatus
+     */
+    startInspectionTasks: (options: import("./task").StartInspectionTasksOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>[]>;
+    /**
+     * Fetch a webapp live configuration from the API.
+     *
+     * @param id The ID of the live config to get.
+     */
+    getLiveConfig: (id: string) => Promise<void | import("@monkvision/types").LiveConfig>;
+    /**
+     * Update the vehicle of an inspection.
+     *
+     * @param options The options of the request.
+     */
+    updateInspectionVehicle: (options: import("./vehicle").UpdateInspectionVehicleOptions) => Promise<{
+        id: string;
+        response: import("ky").KyResponse;
+        body: import("./models").ApiIdColumn;
+    }>;
+};

package/lib/src/api/react.js

@@ -0,0 +1,105 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useMonkApi = void 0;
+var react_1 = require("react");
+var common_1 = require("@monkvision/common");
+var monitoring_1 = require("@monkvision/monitoring");
+var api_1 = require("./api");
+function handleAPIError(err, handleError) {
+    var body = err.body;
+    handleError(err, {
+        extras: {
+            body: body,
+            completeResponse: JSON.stringify(body),
+        },
+    });
+    throw err;
+}
+function reactify(request, config, dispatch, handleError) {
+    return (0, react_1.useCallback)(function () {
+        var params = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            params[_i] = arguments[_i];
+        }
+        return request.apply(void 0, __spreadArray(__spreadArray([], params, false), [config, dispatch], false)).catch(function (err) { return handleAPIError(err, handleError); });
+    }, []);
+}
+/**
+ * Custom hook that returns a MonkApi object in which all the requests don't need a config param (since it is provided
+ * as a prop to this hook), and automatically update the state (using the MonkState hook) when a state has been
+ * received.
+ *
+ * **Note: This hook needs to have the MonkContext set up and defined in order to work properly.**
+ *
+ * @see MonkApi
+ */
+function useMonkApi(config) {
+    var dispatch = (0, common_1.useMonkState)().dispatch;
+    var handleError = (0, monitoring_1.useMonitoring)().handleError;
+    return {
+        /**
+         * Fetch the details of an inspection using its ID.
+         *
+         * @param options The options of the request.
+         */
+        getInspection: reactify(api_1.MonkApi.getInspection, config, dispatch, handleError),
+        /**
+         * Create a new inspection with the given options. See the `CreateInspectionOptions` interface for more details.
+         *
+         * @param options The options of the inspection.
+         * @see CreateInspectionOptions
+         */
+        createInspection: reactify(api_1.MonkApi.createInspection, config, dispatch, handleError),
+        /**
+         * Add a new image to an inspection.
+         *
+         * @param options Upload options for the image.
+         */
+        addImage: reactify(api_1.MonkApi.addImage, config, dispatch, handleError),
+        /**
+         * Update the progress status of an inspection task.
+         *
+         * **Note : This API call is known to sometimes fail for unknown reasons. In order to fix this, we added a retry
+         * config to this API request : when failing, this request will retry itself up to 4 times (5 API calls in total),
+         * with exponentially increasing delay between each request (max delay : 1.5s).**
+         *
+         * @param options The options of the request.
+         */
+        updateTaskStatus: reactify(api_1.MonkApi.updateTaskStatus, config, dispatch, handleError),
+        /**
+         * Start some inspection tasks that were in the NOT_STARTED status. This function actually makes one API call for
+         * each task provided using the `updateTaskStatus`.
+         *
+         * **Note : This API call is known to sometimes fail for unknown reasons. Please take note of the details provided
+         * in the TSDoc of the `updateTaskStatus` function.**
+         *
+         * @param options The options of the request.
+         *
+         * @see updateTaskStatus
+         */
+        startInspectionTasks: reactify(api_1.MonkApi.startInspectionTasks, config, dispatch, handleError),
+        /**
+         * Fetch a webapp live configuration from the API.
+         *
+         * @param id The ID of the live config to get.
+         */
+        getLiveConfig: (0, react_1.useCallback)(function (id) { return api_1.MonkApi.getLiveConfig(id).catch(function (err) { return handleAPIError(err, handleError); }); }, [handleError]),
+        /**
+         * Update the vehicle of an inspection.
+         *
+         * @param options The options of the request.
+         */
+        updateInspectionVehicle: reactify(api_1.MonkApi.updateInspectionVehicle, config, dispatch, handleError),
+    };
+}
+exports.useMonkApi = useMonkApi;
+//# sourceMappingURL=react.js.map

package/lib/src/api/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../../../src/api/react.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAA8C;AAC9C,6CAA8D;AAC9D,qDAAmE;AAEnE,6BAAgC;AAOhC,SAAS,cAAc,CACrB,GAAY,EACZ,WAAwE;IAEhE,IAAA,IAAI,GAAK,GAAoB,KAAzB,CAA0B;IACtC,WAAW,CAAC,GAAG,EAAE;QACf,MAAM,EAAE;YACN,IAAI,MAAA;YACJ,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SACvC;KACF,CAAC,CAAC;IACH,MAAM,GAAG,CAAC;AACZ,CAAC;AAED,SAAS,QAAQ,CACf,OAAgC,EAChC,MAAqB,EACrB,QAA8B,EAC9B,WAAwE;IAExE,OAAO,IAAA,mBAAW,EAChB;QAAC,gBAAY;aAAZ,UAAY,EAAZ,qBAAY,EAAZ,IAAY;YAAZ,2BAAY;;QACX,OAAA,OAAO,+CAAI,MAAM,WAAE,MAAM,EAAE,QAAQ,WAAE,KAAK,CAAC,UAAC,GAAG,IAAK,OAAA,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,EAAhC,CAAgC,CAAM;IAA1F,CAA0F,EAC5F,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,MAAqB;IACtC,IAAA,QAAQ,GAAK,IAAA,qBAAY,GAAE,SAAnB,CAAoB;IAC5B,IAAA,WAAW,GAAK,IAAA,0BAAa,GAAE,YAApB,CAAqB;IAExC,OAAO;QACL;;;;WAIG;QACH,aAAa,EAAE,QAAQ,CAAC,aAAO,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC;QAC7E;;;;;WAKG;QACH,gBAAgB,EAAE,QAAQ,CAAC,aAAO,CAAC,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC;QACnF;;;;WAIG;QACH,QAAQ,EAAE,QAAQ,CAAC,aAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC;QACnE;;;;;;;;WAQG;QACH,gBAAgB,EAAE,QAAQ,CAAC,aAAO,CAAC,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC;QACnF;;;;;;;;;;WAUG;QACH,oBAAoB,EAAE,QAAQ,CAAC,aAAO,CAAC,oBAAoB,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC;QAC3F;;;;WAIG;QACH,aAAa,EAAE,IAAA,mBAAW,EACxB,UAAC,EAAU,IAAK,OAAA,aAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,UAAC,GAAG,IAAK,OAAA,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,EAAhC,CAAgC,CAAC,EAA1E,CAA0E,EAC1F,CAAC,WAAW,CAAC,CACd;QACD;;;;WAIG;QACH,uBAAuB,EAAE,QAAQ,CAC/B,aAAO,CAAC,uBAAuB,EAC/B,MAAM,EACN,QAAQ,EACR,WAAW,CACZ;KACF,CAAC;AACJ,CAAC;AAnED,gCAmEC"}

package/lib/src/api/task/index.d.ts

@@ -0,0 +1 @@
+export * from './requests';

package/lib/src/api/task/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);
+//# sourceMappingURL=index.js.map

package/lib/src/api/task/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/task/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B"}

package/lib/src/api/task/requests.d.ts

@@ -0,0 +1,67 @@
+import { MonkUpdatedManyTasksAction } from '@monkvision/common';
+import { ProgressStatus, TaskName } from '@monkvision/types';
+import { Dispatch } from 'react';
+import { MonkApiConfig } from '../config';
+import { MonkApiResponse } from '../types';
+/**
+ * The different progress statuses that can be specified when updating the status of a task.
+ */
+export type UpdateProgressStatus = ProgressStatus.NOT_STARTED | ProgressStatus.TODO | ProgressStatus.DONE | ProgressStatus.VALIDATED;
+/**
+ * Options used to specify how to update the status of an inspection task.
+ */
+export interface UpdateTaskStatusOptions {
+    /**
+     * The ID of the inspection.
+     */
+    inspectionId: string;
+    /**
+     * The name of the task to update the progress status of.
+     */
+    name: TaskName;
+    /**
+     * The new progress status of the task.
+     */
+    status: UpdateProgressStatus;
+}
+/**
+ * Update the progress status of an inspection task.
+ *
+ * **Note : This API call is known to sometimes fail for unknown reasons. In order to fix this, we added a retry config
+ * to this API request : when failing, this request will retry itself up to 4 times (5 API calls in total), with
+ * exponentially increasing delay between each request (max delay : 1.5s).**
+ *
+ * @param options The options of the request.
+ * @param config The API config.
+ * @param [dispatch] Optional MonkState dispatch function that you can pass if you want this request to handle React
+ * state management for you.
+ */
+export declare function updateTaskStatus(options: UpdateTaskStatusOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkUpdatedManyTasksAction>): Promise<MonkApiResponse>;
+/**
+ * Options passed to the `startInspectionTasks` API request.
+ */
+export interface StartInspectionTasksOptions {
+    /**
+     * The ID of the inspection.
+     */
+    inspectionId: string;
+    /**
+     * The names of the tasks to start.
+     */
+    names: TaskName[];
+}
+/**
+ * Start some inspection tasks that were in the NOT_STARTED status. This function actually makes one API call for each
+ * task provided using the `updateTaskStatus`.
+ *
+ * **Note : This API call is known to sometimes fail for unknown reasons. Please take note of the details provided in
+ * the TSDoc of the `updateTaskStatus` function.**
+ *
+ * @param options The options of the request.
+ * @param config The API config.
+ * @param [dispatch] Optional MonkState dispatch function that you can pass if you want this request to handle React
+ * state management for you.
+ *
+ * @see updateTaskStatus
+ */
+export declare function startInspectionTasks(options: StartInspectionTasksOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkUpdatedManyTasksAction>): Promise<MonkApiResponse[]>;

package/lib/src/api/task/requests.js

@@ -0,0 +1,135 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startInspectionTasks = exports.updateTaskStatus = void 0;
+var ky_1 = __importDefault(require("ky"));
+var common_1 = require("@monkvision/common");
+var types_1 = require("@monkvision/types");
+var config_1 = require("../config");
+/**
+ * Update the progress status of an inspection task.
+ *
+ * **Note : This API call is known to sometimes fail for unknown reasons. In order to fix this, we added a retry config
+ * to this API request : when failing, this request will retry itself up to 4 times (5 API calls in total), with
+ * exponentially increasing delay between each request (max delay : 1.5s).**
+ *
+ * @param options The options of the request.
+ * @param config The API config.
+ * @param [dispatch] Optional MonkState dispatch function that you can pass if you want this request to handle React
+ * state management for you.
+ */
+function updateTaskStatus(options, config, dispatch) {
+    return __awaiter(this, void 0, void 0, function () {
+        var kyOptions, response, body;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    kyOptions = (0, config_1.getDefaultOptions)(config);
+                    return [4 /*yield*/, ky_1.default.patch("inspections/".concat(options.inspectionId, "/tasks/").concat(options.name), __assign(__assign({}, kyOptions), { json: { status: options.status }, retry: {
+                                methods: ['patch'],
+                                limit: 4,
+                                backoffLimit: 1500,
+                            } }))];
+                case 1:
+                    response = _a.sent();
+                    return [4 /*yield*/, response.json()];
+                case 2:
+                    body = _a.sent();
+                    dispatch === null || dispatch === void 0 ? void 0 : dispatch({
+                        type: common_1.MonkActionType.UPDATED_MANY_TASKS,
+                        payload: [{ id: body.id, status: options.status }],
+                    });
+                    return [2 /*return*/, {
+                            id: body.id,
+                            response: response,
+                            body: body,
+                        }];
+            }
+        });
+    });
+}
+exports.updateTaskStatus = updateTaskStatus;
+/**
+ * Start some inspection tasks that were in the NOT_STARTED status. This function actually makes one API call for each
+ * task provided using the `updateTaskStatus`.
+ *
+ * **Note : This API call is known to sometimes fail for unknown reasons. Please take note of the details provided in
+ * the TSDoc of the `updateTaskStatus` function.**
+ *
+ * @param options The options of the request.
+ * @param config The API config.
+ * @param [dispatch] Optional MonkState dispatch function that you can pass if you want this request to handle React
+ * state management for you.
+ *
+ * @see updateTaskStatus
+ */
+function startInspectionTasks(options, config, dispatch) {
+    return __awaiter(this, void 0, void 0, function () {
+        var responses;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, Promise.all(options.names.map(function (name) {
+                        return updateTaskStatus({ inspectionId: options.inspectionId, name: name, status: types_1.ProgressStatus.TODO }, config);
+                    }))];
+                case 1:
+                    responses = _a.sent();
+                    dispatch === null || dispatch === void 0 ? void 0 : dispatch({
+                        type: common_1.MonkActionType.UPDATED_MANY_TASKS,
+                        payload: responses.map(function (response) { return ({ id: response.id, status: types_1.ProgressStatus.TODO }); }),
+                    });
+                    return [2 /*return*/, responses];
+            }
+        });
+    });
+}
+exports.startInspectionTasks = startInspectionTasks;
+//# sourceMappingURL=requests.js.map

package/lib/src/api/task/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../../src/api/task/requests.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAAoB;AACpB,6CAAgF;AAChF,2CAA6D;AAE7D,oCAA6D;AA+B7D;;;;;;;;;;;GAWG;AACH,SAAsB,gBAAgB,CACpC,OAAgC,EAChC,MAAqB,EACrB,QAA+C;;;;;;oBAEzC,SAAS,GAAG,IAAA,0BAAiB,EAAC,MAAM,CAAC,CAAC;oBAC3B,qBAAM,YAAE,CAAC,KAAK,CAAC,sBAAe,OAAO,CAAC,YAAY,oBAAU,OAAO,CAAC,IAAI,CAAE,wBACtF,SAAS,KACZ,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EAChC,KAAK,EAAE;gCACL,OAAO,EAAE,CAAC,OAAO,CAAC;gCAClB,KAAK,EAAE,CAAC;gCACR,YAAY,EAAE,IAAI;6BACnB,IACD,EAAA;;oBARI,QAAQ,GAAG,SAQf;oBACW,qBAAM,QAAQ,CAAC,IAAI,EAAe,EAAA;;oBAAzC,IAAI,GAAG,SAAkC;oBAC/C,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG;wBACT,IAAI,EAAE,uBAAc,CAAC,kBAAkB;wBACvC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;qBACnD,CAAC,CAAC;oBACH,sBAAO;4BACL,EAAE,EAAE,IAAI,CAAC,EAAE;4BACX,QAAQ,UAAA;4BACR,IAAI,MAAA;yBACL,EAAC;;;;CACH;AAzBD,4CAyBC;AAgBD;;;;;;;;;;;;;GAaG;AACH,SAAsB,oBAAoB,CACxC,OAAoC,EACpC,MAAqB,EACrB,QAA+C;;;;;wBAE7B,qBAAM,OAAO,CAAC,GAAG,CACjC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,UAAC,IAAI;wBACrB,OAAA,gBAAgB,CACd,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,MAAA,EAAE,MAAM,EAAE,sBAAc,CAAC,IAAI,EAAE,EACzE,MAAM,CACP;oBAHD,CAGC,CACF,CACF,EAAA;;oBAPK,SAAS,GAAG,SAOjB;oBACD,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG;wBACT,IAAI,EAAE,uBAAc,CAAC,kBAAkB;wBACvC,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,sBAAc,CAAC,IAAI,EAAE,CAAC,EAAlD,CAAkD,CAAC;qBACzF,CAAC,CAAC;oBACH,sBAAO,SAAS,EAAC;;;;CAClB;AAlBD,oDAkBC"}

package/lib/src/api/types.d.ts

@@ -0,0 +1,24 @@
+import { KyResponse } from 'ky';
+import { ApiIdColumn } from './models';
+/**
+ * Default return type of Monk API Request, containing just the ID of the affected entity.
+ */
+export interface MonkId {
+    /**
+     * The ID of the entity that was affected by the API request.
+     */
+    id: string;
+}
+/**
+ * Generic type definition for the response returned by a Monk API Request.
+ */
+export type MonkApiResponse<T extends object = MonkId, K extends object = ApiIdColumn> = T & {
+    /**
+     * The raw HTTP response object.
+     */
+    response: KyResponse;
+    /**
+     * The body of the response.
+     */
+    body: K;
+};

package/lib/src/api/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/src/api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/types.ts"],"names":[],"mappings":""}

package/lib/src/api/utils.d.ts

@@ -0,0 +1,9 @@
+import { PixelDimensions } from '@monkvision/types';
+/**
+ * The ratio used to resize the dimensions of the thumbnail.
+ */
+export declare const THUMBNAIL_RESIZE_RATIO = 0.1;
+/**
+ * Util function that generate a thumbnail url.
+ */
+export declare function getThumbnailUrl(thumbnailDomain: string, path: string, dimensions: PixelDimensions): string;

package/lib/src/api/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getThumbnailUrl = exports.THUMBNAIL_RESIZE_RATIO = void 0;
+/**
+ * The ratio used to resize the dimensions of the thumbnail.
+ */
+exports.THUMBNAIL_RESIZE_RATIO = 0.1;
+function getResizedDimension(originalDimension) {
+    return Math.round(originalDimension * exports.THUMBNAIL_RESIZE_RATIO);
+}
+/**
+ * Util function that generate a thumbnail url.
+ */
+function getThumbnailUrl(thumbnailDomain, path, dimensions) {
+    var baseThumbnailUrl = "https://".concat(thumbnailDomain).concat(thumbnailDomain.endsWith('/') ? '' : '/');
+    var imageUrlParam = "image_url=".concat(encodeURIComponent(path));
+    var widthUrlParam = "width=".concat(getResizedDimension(dimensions.width));
+    var heightUrlParam = "height=".concat(getResizedDimension(dimensions.height));
+    return "".concat(baseThumbnailUrl, "?").concat(imageUrlParam, "&").concat(widthUrlParam, "&").concat(heightUrlParam);
+}
+exports.getThumbnailUrl = getThumbnailUrl;
+//# sourceMappingURL=utils.js.map

package/lib/src/api/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/api/utils.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACU,QAAA,sBAAsB,GAAG,GAAG,CAAC;AAE1C,SAAS,mBAAmB,CAAC,iBAAyB;IACpD,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,8BAAsB,CAAC,CAAC;AAChE,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAC7B,eAAuB,EACvB,IAAY,EACZ,UAA2B;IAE3B,IAAM,gBAAgB,GAAG,kBAAW,eAAe,SAAG,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAE,CAAC;IACjG,IAAM,aAAa,GAAG,oBAAa,kBAAkB,CAAC,IAAI,CAAC,CAAE,CAAC;IAC9D,IAAM,aAAa,GAAG,gBAAS,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAE,CAAC;IACvE,IAAM,cAAc,GAAG,iBAAU,mBAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAE,CAAC;IAE1E,OAAO,UAAG,gBAAgB,cAAI,aAAa,cAAI,aAAa,cAAI,cAAc,CAAE,CAAC;AACnF,CAAC;AAXD,0CAWC"}

package/lib/src/api/vehicle/index.d.ts

@@ -0,0 +1 @@
+export * from './requests';

package/lib/src/api/vehicle/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);
+//# sourceMappingURL=index.js.map

package/lib/src/api/vehicle/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/vehicle/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B"}

package/lib/src/api/vehicle/mappers.d.ts

@@ -0,0 +1,3 @@
+import { Vehicle } from '@monkvision/types';
+import { ApiVehiclePostPatch } from '../models';
+export declare function mapApiVehiclePatch(options: Partial<Vehicle>): ApiVehiclePostPatch;

package/lib/src/api/vehicle/mappers.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapApiVehiclePatch = void 0;
+function mapApiVehiclePatch(options) {
+    return {
+        brand: options.brand,
+        model: options.model,
+        plate: options.plate,
+        vehicle_type: options.type,
+        mileage: options.mileageValue && options.mileageUnit
+            ? {
+                value: options.mileageValue,
+                unit: options.mileageUnit,
+            }
+            : undefined,
+        market_value: options.marketValue && options.marketValueUnit
+            ? { value: options.marketValue, unit: options.marketValueUnit }
+            : undefined,
+        vin: options.vin,
+        color: options.color,
+        exterior_cleanliness: options.exteriorCleanliness,
+        interior_cleanliness: options.interiorCleanliness,
+        date_of_circulation: options.dateOfCirculation,
+        duplicate_keys: options.duplicateKeys,
+        expertise_requested: options.expertiseRequested,
+        car_registration: options.carRegistration,
+        vehicle_quotation: options.vehicleQuotation,
+        trade_in_offer: options.tradeInOffer,
+        owner_info: options.ownerInfo,
+    };
+}
+exports.mapApiVehiclePatch = mapApiVehiclePatch;
+//# sourceMappingURL=mappers.js.map

package/lib/src/api/vehicle/mappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.js","sourceRoot":"","sources":["../../../../src/api/vehicle/mappers.ts"],"names":[],"mappings":";;;AAGA,SAAgB,kBAAkB,CAAC,OAAyB;IAC1D,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,YAAY,EAAE,OAAO,CAAC,IAAI;QAC1B,OAAO,EACL,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,WAAW;YACzC,CAAC,CAAC;gBACE,KAAK,EAAE,OAAO,CAAC,YAAY;gBAC3B,IAAI,EAAE,OAAO,CAAC,WAAW;aAC1B;YACH,CAAC,CAAC,SAAS;QACf,YAAY,EACV,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe;YAC5C,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,eAAe,EAAE;YAC/D,CAAC,CAAC,SAAS;QACf,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,oBAAoB,EAAE,OAAO,CAAC,mBAAmB;QACjD,oBAAoB,EAAE,OAAO,CAAC,mBAAmB;QACjD,mBAAmB,EAAE,OAAO,CAAC,iBAAiB;QAC9C,cAAc,EAAE,OAAO,CAAC,aAAa;QACrC,mBAAmB,EAAE,OAAO,CAAC,kBAAkB;QAC/C,gBAAgB,EAAE,OAAO,CAAC,eAAe;QACzC,iBAAiB,EAAE,OAAO,CAAC,gBAAgB;QAC3C,cAAc,EAAE,OAAO,CAAC,YAAY;QACpC,UAAU,EAAE,OAAO,CAAC,SAAS;KAC9B,CAAC;AACJ,CAAC;AA7BD,gDA6BC"}

package/lib/src/api/vehicle/requests.d.ts

@@ -0,0 +1,31 @@
+import { MonkAction } from '@monkvision/common';
+import { Vehicle } from '@monkvision/types';
+import { Dispatch } from 'react';
+import { MonkApiConfig } from '../config';
+import { ApiIdColumn } from '../models';
+/**
+ * Options used to specify how to update the vehicle of an inspection.
+ */
+export interface UpdateInspectionVehicleOptions {
+    /**
+     * The ID of the inspection.
+     */
+    inspectionId: string;
+    /**
+     * The vehicle details to update.
+     */
+    vehicle: Partial<Vehicle>;
+}
+/**
+ * Update the vehicle of an inspection.
+ *
+ * @param options The options of the request.
+ * @param config The API config.
+ * @param [_dispatch] Optional MonkState dispatch function that you can pass if you want this request to handle React
+ * state management for you.
+ */
+export declare function updateInspectionVehicle(options: UpdateInspectionVehicleOptions, config: MonkApiConfig, _dispatch?: Dispatch<MonkAction>): Promise<{
+    id: string;
+    response: import("ky").KyResponse;
+    body: ApiIdColumn;
+}>;