@monkvision/network 4.3.5 → 4.3.7

package/README.md

@@ -224,6 +224,20 @@ a list of all entities that match the specified criteria.
 |-----------|-----------------------|-----------------------------|----------|
 | options   | getInspectionsOptions | The options of the request. | ✔️       |
 
+
+### getInspectionsCount
+```typescript
+import { MonkApi } from '@monkvision/network';
+
+MonkApi.getInspectionsCount(options, apiConfig, dispatch);
+```
+
+Gets the count of inspections that match the given filters.
+
+| Parameter | Type                  | Description                 | Required |
+|-----------|-----------------------|-----------------------------|----------|
+| options   | getInspectionsOptions | 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
 custom hook returns a custom version of the `MonkApi` object described in the section above, in which the requests do

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@monkvision/network",
-    "version": "4.3.4",
+    "version": "4.3.6",
     "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.3.4",
-        "@monkvision/sights": "4.3.4",
+        "@monkvision/common": "4.3.6",
+        "@monkvision/sights": "4.3.6",
         "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.3.4",
-        "@monkvision/eslint-config-typescript": "4.3.4",
-        "@monkvision/jest-config": "4.3.4",
-        "@monkvision/prettier-config": "4.3.4",
-        "@monkvision/types": "4.3.4",
-        "@monkvision/typescript-config": "4.3.4",
+        "@monkvision/eslint-config-base": "4.3.6",
+        "@monkvision/eslint-config-typescript": "4.3.6",
+        "@monkvision/jest-config": "4.3.6",
+        "@monkvision/prettier-config": "4.3.6",
+        "@monkvision/types": "4.3.6",
+        "@monkvision/typescript-config": "4.3.6",
         "@types/jest": "^29.2.2",
         "@types/jsonwebtoken": "^9.0.5",
         "@types/node": "^18.11.9",

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

@@ -1,4 +1,4 @@
-import { getInspection, createInspection, updateAdditionalData, getInspections } from './inspection';
+import { getInspection, createInspection, updateAdditionalData, getInspections, getInspectionsCount } from './inspection';
 import { addImage } from './image';
 import { startInspectionTasks, updateTaskStatus } from './task';
 import { getLiveConfig } from './liveConfigs';
@@ -12,6 +12,7 @@ import { createDamage, deleteDamage } from './damage';
 export declare const MonkApi: {
     getInspection: typeof getInspection;
     getInspections: typeof getInspections;
+    getInspectionsCount: typeof getInspectionsCount;
     createInspection: typeof createInspection;
     addImage: typeof addImage;
     updateTaskStatus: typeof updateTaskStatus;

package/lib/src/api/api.js

@@ -15,6 +15,7 @@ var damage_1 = require("./damage");
 exports.MonkApi = {
     getInspection: inspection_1.getInspection,
     getInspections: inspection_1.getInspections,
+    getInspectionsCount: inspection_1.getInspectionsCount,
     createInspection: inspection_1.createInspection,
     addImage: image_1.addImage,
     updateTaskStatus: task_1.updateTaskStatus,

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

@@ -39,15 +39,9 @@ export interface SortRequestParams {
     sortOrder?: SortOrder;
 }
 /**
- * Options passed to the `getInspections` API request.
+ * Options passed to the `getInspections` or `getInspectionsCount` API request.
  */
 export interface GetInspectionsOptions {
-    /**
-     * If true, only the total count of inspections will be returned.
-     *
-     * @default false
-     */
-    count?: boolean;
     /**
      * The filter request parameters.
      */

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

@@ -221,6 +221,7 @@ function mapTasks(response) {
     return { taskIds: taskIds, tasks: tasks };
 }
 function mapVehicle(response) {
+    var _a, _b, _c, _d;
     return (response === null || response === void 0 ? void 0 : response.vehicle)
         ? {
             id: response.vehicle.id,
@@ -231,10 +232,10 @@ function mapVehicle(response) {
             serie: response.vehicle.serie,
             plate: response.vehicle.plate,
             type: response.vehicle.vehicle_type,
-            mileageUnit: response.vehicle.mileage_unit,
-            mileageValue: response.vehicle.mileage_value,
-            marketValueUnit: response.vehicle.market_value_unit,
-            marketValue: response.vehicle.market_value_value,
+            mileageUnit: (_a = response.vehicle.mileage) === null || _a === void 0 ? void 0 : _a.mileage_unit,
+            mileageValue: (_b = response.vehicle.mileage) === null || _b === void 0 ? void 0 : _b.mileage_value,
+            marketValueUnit: (_c = response.vehicle.market_value) === null || _c === void 0 ? void 0 : _c.market_value_unit,
+            marketValue: (_d = response.vehicle.market_value) === null || _d === void 0 ? void 0 : _d.market_value_value,
             vin: response.vehicle.vin,
             color: response.vehicle.color,
             exteriorCleanliness: response.vehicle.exterior_cleanliness,
@@ -454,14 +455,14 @@ function mapApiInspectionPost(options) {
                 vehicle_type: options.vehicle.type,
                 mileage: options.vehicle.mileageUnit && options.vehicle.mileageValue
                     ? {
-                        value: options.vehicle.mileageValue,
-                        unit: options.vehicle.mileageUnit,
+                        mileage_value: options.vehicle.mileageValue,
+                        mileage_unit: options.vehicle.mileageUnit,
                     }
                     : undefined,
                 market_value: options.vehicle.marketValueUnit && options.vehicle.marketValue
                     ? {
-                        value: options.vehicle.marketValue,
-                        unit: options.vehicle.marketValueUnit,
+                        market_value_value: options.vehicle.marketValue,
+                        market_value_unit: options.vehicle.marketValueUnit,
                     }
                     : undefined,
                 vin: options.vehicle.vin,
@@ -485,8 +486,7 @@ function mapApiInspectionPost(options) {
 exports.mapApiInspectionPost = mapApiInspectionPost;
 function mapApiInspectionsUrlParamsGet(options) {
     var params = new URLSearchParams();
-    var url = options.count ? '/count' : '';
-    url = options.filters || options.pagination ? "".concat(url, "?") : url;
+    var url = options.filters || options.pagination ? '?' : '';
     if (options.filters) {
         Object.entries(options.filters).forEach(function (_a) {
             var key = _a[0], value = _a[1];

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

@@ -2,7 +2,7 @@ import { MonkAction, MonkGotOneInspectionAction, MonkState, MonkUpdatedOneInspec
 import { AdditionalData, ComplianceOptions, CreateInspectionOptions } from '@monkvision/types';
 import { Dispatch } from 'react';
 import { MonkApiConfig } from '../config';
-import { ApiInspectionGet, ApiInspectionsGet } from '../models';
+import { ApiInspectionGet, ApiInspectionsCountGet, ApiInspectionsGet } from '../models';
 import { GetInspectionsOptions } from './mappers';
 import { MonkApiResponse } from '../types';
 /**
@@ -27,6 +27,15 @@ export interface GetInspectionResponse {
      */
     entities: MonkState;
 }
+/**
+ * Type definition for the result of the `getInspectionsCount` API request.
+ */
+export interface GetInspectionsCountResponse {
+    /**
+     * The total number of inspections that match the given filters.
+     */
+    count: number;
+}
 /**
  * Fetch the details of an inspection using its ID.
  *
@@ -79,3 +88,12 @@ export declare function updateAdditionalData(options: UpdateAdditionalDataOption
  * state management for you.
  */
 export declare function getInspections(options: GetInspectionsOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkGotOneInspectionAction>): Promise<MonkApiResponse<GetInspectionResponse, ApiInspectionsGet>>;
+/**
+ * Gets the count of inspections that match the given filters.
+ *
+ * @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 getInspectionsCount(options: GetInspectionsOptions, config: MonkApiConfig, _dispatch?: Dispatch<MonkAction>): Promise<MonkApiResponse<GetInspectionsCountResponse, ApiInspectionsCountGet>>;

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

@@ -50,7 +50,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInspections = exports.updateAdditionalData = exports.createInspection = exports.getInspection = void 0;
+exports.getInspectionsCount = exports.getInspections = exports.updateAdditionalData = exports.createInspection = exports.getInspection = void 0;
 var ky_1 = __importDefault(require("ky"));
 var common_1 = require("@monkvision/common");
 var config_1 = require("../config");
@@ -198,3 +198,30 @@ function getInspections(options, config, dispatch) {
     });
 }
 exports.getInspections = getInspections;
+/**
+ * Gets the count of inspections that match the given filters.
+ *
+ * @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 getInspectionsCount(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.get("inspections/count".concat((0, mappers_1.mapApiInspectionsUrlParamsGet)(options)), kyOptions)];
+                case 1:
+                    response = _a.sent();
+                    return [4 /*yield*/, response.json()];
+                case 2:
+                    body = _a.sent();
+                    return [2 /*return*/, { count: body.total, response: response, body: body }];
+            }
+        });
+    });
+}
+exports.getInspectionsCount = getInspectionsCount;

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

@@ -49,6 +49,9 @@ export interface ApiInspectionsGet {
     data: ApiData[];
     paging: ApiPagination;
 }
+export interface ApiInspectionsCountGet {
+    total: number;
+}
 export interface ApiDamageSeverity {
     output_format: ApiBusinessClients;
 }

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

@@ -2,6 +2,14 @@ import type { ApiAdditionalData } from './common';
 export type ApiOwnerInfo = Record<string, unknown>;
 export type ApiMileageUnit = 'km' | 'miles';
 export type ApiMarketValueUnit = 'USD' | 'EUR';
+export interface ApiMileage {
+    mileage_value: number;
+    mileage_unit: ApiMileageUnit;
+}
+export interface ApiMarketValue {
+    market_value_value: number;
+    market_value_unit: ApiMarketValueUnit;
+}
 export interface ApiVehicleComponent {
     additional_data?: ApiAdditionalData;
     brand?: string;
@@ -14,10 +22,8 @@ export interface ApiVehicleComponent {
     exterior_cleanliness?: string;
     id: string;
     interior_cleanliness?: string;
-    market_value_unit?: ApiMarketValueUnit;
-    market_value_value?: number;
-    mileage_unit?: ApiMileageUnit;
-    mileage_value?: number;
+    mileage?: ApiMileage;
+    market_value?: ApiMarketValue;
     model?: string;
     serie?: string;
     owner_info?: ApiOwnerInfo;
@@ -27,14 +33,6 @@ export interface ApiVehicleComponent {
     vehicle_type?: string;
     vin?: string;
 }
-export interface ApiMileage {
-    value: number;
-    unit: ApiMileageUnit;
-}
-export interface ApiMarketValue {
-    value: number;
-    unit: ApiMarketValueUnit;
-}
 export interface ApiVehiclePostPatch {
     brand?: string;
     model?: string;

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

@@ -21,6 +21,12 @@ export declare function useMonkApi(config: MonkApiConfig): {
      * @param options The options of the request.
      */
     getInspections: (options: import("./inspection/mappers").GetInspectionsOptions) => Promise<import("./types").MonkApiResponse<import("./inspection").GetInspectionResponse, import("./models").ApiInspectionsGet>>;
+    /**
+     * Gets the count of inspections that match the given filters.
+     *
+     * @param options The options of the request.
+     */
+    getInspectionsCount: (options: import("./inspection/mappers").GetInspectionsOptions) => Promise<import("./types").MonkApiResponse<import("./inspection").GetInspectionsCountResponse, import("./models").ApiInspectionsCountGet>>;
     /**
      * Create a new inspection with the given options. See the `CreateInspectionOptions` interface for more details.
      *

package/lib/src/api/react.js

@@ -58,6 +58,12 @@ function useMonkApi(config) {
          * @param options The options of the request.
          */
         getInspections: reactify(api_1.MonkApi.getInspections, config, dispatch, handleError),
+        /**
+         * Gets the count of inspections that match the given filters.
+         *
+         * @param options The options of the request.
+         */
+        getInspectionsCount: reactify(api_1.MonkApi.getInspectionsCount, config, dispatch, handleError),
         /**
          * Create a new inspection with the given options. See the `CreateInspectionOptions` interface for more details.
          *

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

@@ -9,12 +9,12 @@ function mapApiVehiclePatch(options) {
         vehicle_type: options.type,
         mileage: options.mileageValue && options.mileageUnit
             ? {
-                value: options.mileageValue,
-                unit: options.mileageUnit,
+                mileage_value: options.mileageValue,
+                mileage_unit: options.mileageUnit,
             }
             : undefined,
         market_value: options.marketValue && options.marketValueUnit
-            ? { value: options.marketValue, unit: options.marketValueUnit }
+            ? { market_value_value: options.marketValue, market_value_unit: options.marketValueUnit }
             : undefined,
         vin: options.vin,
         color: options.color,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/network",
-  "version": "4.3.5",
+  "version": "4.3.7",
   "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.3.5",
-    "@monkvision/sights": "4.3.5",
+    "@monkvision/common": "4.3.7",
+    "@monkvision/sights": "4.3.7",
     "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.3.5",
-    "@monkvision/eslint-config-typescript": "4.3.5",
-    "@monkvision/jest-config": "4.3.5",
-    "@monkvision/prettier-config": "4.3.5",
-    "@monkvision/types": "4.3.5",
-    "@monkvision/typescript-config": "4.3.5",
+    "@monkvision/eslint-config-base": "4.3.7",
+    "@monkvision/eslint-config-typescript": "4.3.7",
+    "@monkvision/jest-config": "4.3.7",
+    "@monkvision/prettier-config": "4.3.7",
+    "@monkvision/types": "4.3.7",
+    "@monkvision/typescript-config": "4.3.7",
     "@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": "a9e9963cdf3c9495f9d709e14638b14970fc8ab8"
+  "gitHead": "04dad018a2eab4da78912e328670e9b9b55cde94"
 }