@monkvision/network 4.2.2 → 4.2.3

package/README.md

@@ -165,7 +165,7 @@ import { MonkApi } from '@monkvision/network';
 MonkApi.deletePricing(options, apiConfig, dispatch);
 ```
 
-Update a pricing of an inspection.
+Delete a pricing of an inspection.
 
 | Parameter | Type                 | Description                 | Required |
 |-----------|----------------------|-----------------------------|----------|
@@ -184,6 +184,31 @@ Update the additional data of an inspection.
 |-----------|-----------------------------|-----------------------------|----------|
 | options   | UpdateAdditionalDataOptions | The options of the request. | ✔️       |
 
+### createDamage
+```typescript
+import { MonkApi } from '@monkvision/network';
+
+MonkApi.createDamage(options, apiConfig, dispatch);
+```
+
+Create a new damage of an inspection.
+
+| Parameter | Type                | Description                 | Required |
+|-----------|---------------------|-----------------------------|----------|
+| options   | CreateDamageOptions | The options of the request. | ✔️       |
+
+### deleteDamage
+```typescript
+import { MonkApi } from '@monkvision/network';
+
+MonkApi.deleteDamage(options, apiConfig, dispatch);
+```
+
+Delete a damage of an inspection.
+
+| Parameter | Type                | Description                 | Required |
+|-----------|---------------------|-----------------------------|----------|
+| options   | DeleteDamageOptions | The options of the request. | ✔️       |
 
 # React Tools
 In order to simply integrate the Monk Api requests into your React app, you can make use of the `useMonkApi` hook. This

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@monkvision/network",
-    "version": "4.2.1",
+    "version": "4.2.2",
     "license": "BSD-3-Clause-Clear",
     "packageManager": "yarn@3.2.4",
     "description": "MonkJs core package used to communicate with the API",
@@ -28,8 +28,8 @@
         "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
     },
     "dependencies": {
-        "@monkvision/common": "4.2.1",
-        "@monkvision/sights": "4.2.1",
+        "@monkvision/common": "4.2.2",
+        "@monkvision/sights": "4.2.2",
         "jsonwebtoken": "^9.0.2",
         "jwt-decode": "^4.0.0",
         "ky": "^1.2.0",
@@ -42,12 +42,12 @@
         "react-router-dom": "^6.22.3"
     },
     "devDependencies": {
-        "@monkvision/eslint-config-base": "4.2.1",
-        "@monkvision/eslint-config-typescript": "4.2.1",
-        "@monkvision/jest-config": "4.2.1",
-        "@monkvision/prettier-config": "4.2.1",
-        "@monkvision/types": "4.2.1",
-        "@monkvision/typescript-config": "4.2.1",
+        "@monkvision/eslint-config-base": "4.2.2",
+        "@monkvision/eslint-config-typescript": "4.2.2",
+        "@monkvision/jest-config": "4.2.2",
+        "@monkvision/prettier-config": "4.2.2",
+        "@monkvision/types": "4.2.2",
+        "@monkvision/typescript-config": "4.2.2",
         "@types/jest": "^29.2.2",
         "@types/jsonwebtoken": "^9.0.5",
         "@types/node": "^18.11.9",

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

@@ -4,6 +4,7 @@ import { startInspectionTasks, updateTaskStatus } from './task';
 import { getLiveConfig } from './liveConfigs';
 import { updateInspectionVehicle } from './vehicle';
 import { createPricing, deletePricing, updatePricing } from './pricing';
+import { createDamage, deleteDamage } from './damage';
 /**
  * Object regrouping the different API requests available to communicate with the API using the `@monkvision/network`
  * package.
@@ -20,4 +21,6 @@ export declare const MonkApi: {
     createPricing: typeof createPricing;
     deletePricing: typeof deletePricing;
     updatePricing: typeof updatePricing;
+    createDamage: typeof createDamage;
+    deleteDamage: typeof deleteDamage;
 };

package/lib/src/api/api.js

@@ -7,6 +7,7 @@ var task_1 = require("./task");
 var liveConfigs_1 = require("./liveConfigs");
 var vehicle_1 = require("./vehicle");
 var pricing_1 = require("./pricing");
+var damage_1 = require("./damage");
 /**
  * Object regrouping the different API requests available to communicate with the API using the `@monkvision/network`
  * package.
@@ -23,4 +24,6 @@ exports.MonkApi = {
     createPricing: pricing_1.createPricing,
     deletePricing: pricing_1.deletePricing,
     updatePricing: pricing_1.updatePricing,
+    createDamage: damage_1.createDamage,
+    deleteDamage: damage_1.deleteDamage,
 };

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

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

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

@@ -0,0 +1,17 @@
+"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);

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

@@ -0,0 +1,3 @@
+import { DamageType, VehiclePart } from '@monkvision/types';
+import { ApiDamagePost } from '../models';
+export declare function mapApiDamagePostRequest(damageType: DamageType, vehiclePart: VehiclePart): ApiDamagePost;

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapApiDamagePostRequest = void 0;
+function mapApiDamagePostRequest(damageType, vehiclePart) {
+    return {
+        damage_type: damageType,
+        part_type: vehiclePart,
+    };
+}
+exports.mapApiDamagePostRequest = mapApiDamagePostRequest;

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

@@ -0,0 +1,55 @@
+import { MonkCreatedOneDamageAction, MonkDeletedOneDamageAction } from '@monkvision/common';
+import { DamageType, VehiclePart } from '@monkvision/types';
+import { Dispatch } from 'react';
+import { MonkApiConfig } from '../config';
+import { MonkApiResponse } from '../types';
+/**
+ * Options passed to the `createDamage` API request.
+ */
+export interface CreateDamageOptions {
+    /**
+     * The ID of the inspection to update via the API.
+     */
+    id: string;
+    /**
+     * Damage type used for the update operation.
+     */
+    damageType: DamageType;
+    /**
+     * Vehicle part used for the update operation.
+     */
+    vehiclePart: VehiclePart;
+}
+/**
+ * Create a new damage with the given options. See the `CreateDamageOptions` interface for more details.
+ *
+ * @param options The options of the inspection.
+ * @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 CreateDamageOptions
+ */
+export declare function createDamage(options: CreateDamageOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkCreatedOneDamageAction>): Promise<MonkApiResponse>;
+/**
+ * Options passed to the `deleteDamage` API request.
+ */
+export interface DeleteDamageOptions {
+    /**
+     * The ID of the inspection to update via the API.
+     */
+    id: string;
+    /**
+     * Damage ID that will be deleted.
+     */
+    damageId: string;
+}
+/**
+ * Delete a damage with the given options. See the `DeleteDamageOptions` interface for more details.
+ *
+ * @param options The options of the inspection.
+ * @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 DeleteDamageOptions
+ */
+export declare function deleteDamage(options: DeleteDamageOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkDeletedOneDamageAction>): Promise<MonkApiResponse>;

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

@@ -0,0 +1,139 @@
+"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.deleteDamage = exports.createDamage = void 0;
+var common_1 = require("@monkvision/common");
+var types_1 = require("@monkvision/types");
+var ky_1 = __importDefault(require("ky"));
+var config_1 = require("../config");
+var mappers_1 = require("./mappers");
+/**
+ * Create a new damage with the given options. See the `CreateDamageOptions` interface for more details.
+ *
+ * @param options The options of the inspection.
+ * @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 CreateDamageOptions
+ */
+function createDamage(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.post("inspections/".concat(options.id, "/damages"), __assign(__assign({}, kyOptions), { json: (0, mappers_1.mapApiDamagePostRequest)(options.damageType, options.vehiclePart) }))];
+                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.CREATED_ONE_DAMAGE,
+                        payload: {
+                            damage: {
+                                entityType: types_1.MonkEntityType.DAMAGE,
+                                id: body.id,
+                                inspectionId: options.id,
+                                parts: [options.vehiclePart],
+                                relatedImages: [],
+                                type: options.damageType,
+                            },
+                        },
+                    });
+                    return [2 /*return*/, {
+                            id: body.id,
+                            response: response,
+                            body: body,
+                        }];
+            }
+        });
+    });
+}
+exports.createDamage = createDamage;
+/**
+ * Delete a damage with the given options. See the `DeleteDamageOptions` interface for more details.
+ *
+ * @param options The options of the inspection.
+ * @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 DeleteDamageOptions
+ */
+function deleteDamage(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.delete("inspections/".concat(options.id, "/damages/").concat(options.damageId), __assign({}, kyOptions))];
+                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.DELETED_ONE_DAMAGE,
+                        payload: { inspectionId: options.id, damageId: body.id },
+                    });
+                    return [2 /*return*/, {
+                            id: body.id,
+                            response: response,
+                            body: body,
+                        }];
+            }
+        });
+    });
+}
+exports.deleteDamage = deleteDamage;

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

@@ -1,3 +1,4 @@
+import { DamageType, VehiclePart } from '@monkvision/types';
 import type { ApiRelatedImages } from './image';
 import type { ApiPartIds } from './part';
 export interface ApiDamage {
@@ -9,3 +10,7 @@ export interface ApiDamage {
 }
 export type ApiDamages = ApiDamage[];
 export type ApiDamageIds = string[];
+export interface ApiDamagePost {
+    damage_type: DamageType;
+    part_type: VehiclePart;
+}

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

@@ -15,7 +15,7 @@ export interface ApiPricingV2 {
     details: ApiDetails;
     total_price?: number;
 }
-export interface ApiPricingPost {
+export interface ApiPricingPostPatch {
     pricing: number;
     related_item_type: PricingV2RelatedItemType;
     part_type: VehiclePart | undefined;

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

@@ -1,5 +1,5 @@
 import { PricingV2 } from '@monkvision/types';
-import { ApiPricingPost, ApiPricingV2Details } from '../models';
+import { ApiPricingPostPatch, ApiPricingV2Details } from '../models';
 import { PricingOptions } from './types';
 export declare function mapApiPricingPost(inspectionId: string, response: ApiPricingV2Details): PricingV2;
-export declare function mapApiPricingPostRequest(options: PricingOptions): ApiPricingPost;
+export declare function mapApiPricingPostRequest(options: PricingOptions): ApiPricingPostPatch;

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

@@ -93,4 +93,18 @@ export declare function useMonkApi(config: MonkApiConfig): {
      * @see UpdatePricingOptions
      */
     updatePricing: (options: import("./pricing").UpdatePricingOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
+    /**
+     * Create a new damage with the given options. See the `CreateDamageOptions` interface for more details.
+     *
+     * @param options The options of the inspection.
+     * @see CreateDamageOptions
+     */
+    createDamage: (options: import("./damage").CreateDamageOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
+    /**
+     * Delete a damage with the given options. See the `DeleteDamageOptions` interface for more details.
+     *
+     * @param options The options of the inspection.
+     * @see DeleteDamageOptions
+     */
+    deleteDamage: (options: import("./damage").DeleteDamageOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
 };

package/lib/src/api/react.js

@@ -126,6 +126,20 @@ function useMonkApi(config) {
          * @see UpdatePricingOptions
          */
         updatePricing: reactify(api_1.MonkApi.updatePricing, config, dispatch, handleError),
+        /**
+         * Create a new damage with the given options. See the `CreateDamageOptions` interface for more details.
+         *
+         * @param options The options of the inspection.
+         * @see CreateDamageOptions
+         */
+        createDamage: reactify(api_1.MonkApi.createDamage, config, dispatch, handleError),
+        /**
+         * Delete a damage with the given options. See the `DeleteDamageOptions` interface for more details.
+         *
+         * @param options The options of the inspection.
+         * @see DeleteDamageOptions
+         */
+        deleteDamage: reactify(api_1.MonkApi.deleteDamage, config, dispatch, handleError),
     };
 }
 exports.useMonkApi = useMonkApi;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/network",
-  "version": "4.2.2",
+  "version": "4.2.3",
   "license": "BSD-3-Clause-Clear",
   "packageManager": "yarn@3.2.4",
   "description": "MonkJs core package used to communicate with the API",
@@ -28,8 +28,8 @@
     "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
   },
   "dependencies": {
-    "@monkvision/common": "4.2.2",
-    "@monkvision/sights": "4.2.2",
+    "@monkvision/common": "4.2.3",
+    "@monkvision/sights": "4.2.3",
     "jsonwebtoken": "^9.0.2",
     "jwt-decode": "^4.0.0",
     "ky": "^1.2.0",
@@ -42,12 +42,12 @@
     "react-router-dom": "^6.22.3"
   },
   "devDependencies": {
-    "@monkvision/eslint-config-base": "4.2.2",
-    "@monkvision/eslint-config-typescript": "4.2.2",
-    "@monkvision/jest-config": "4.2.2",
-    "@monkvision/prettier-config": "4.2.2",
-    "@monkvision/types": "4.2.2",
-    "@monkvision/typescript-config": "4.2.2",
+    "@monkvision/eslint-config-base": "4.2.3",
+    "@monkvision/eslint-config-typescript": "4.2.3",
+    "@monkvision/jest-config": "4.2.3",
+    "@monkvision/prettier-config": "4.2.3",
+    "@monkvision/types": "4.2.3",
+    "@monkvision/typescript-config": "4.2.3",
     "@types/jest": "^29.2.2",
     "@types/jsonwebtoken": "^9.0.5",
     "@types/node": "^18.11.9",
@@ -84,5 +84,5 @@
     "url": "https://github.com/monkvision/monkjs/issues"
   },
   "homepage": "https://github.com/monkvision/monkjs",
-  "gitHead": "6b099cf04f90c80e519fd0cc22ebe0cff740e4cb"
+  "gitHead": "df99196af2f9ed3f1218a383a507f7133cb9cbfe"
 }