@monkvision/network 4.4.2 → 4.4.4

package/README.md

@@ -238,6 +238,32 @@ Gets the count of inspections that match the given filters.
 |-----------|--------------------------|-----------------------------|----------|
 | options   | GetAllInspectionsOptions | The options of the request. | ✔️       |
 
+### getPdf
+```typescript
+import { MonkApi } from '@monkvision/network';
+
+MonkApi.getPdf(options, apiConfig, dispatch);
+```
+
+Gets the PDF url of an inspection.
+
+| Parameter | Type          | Description                 | Required |
+|-----------|---------------|-----------------------------|----------|
+| options   | GetPdfOptions | The options of the request. | ✔️       |
+
+### uploadPdf
+```typescript
+import { MonkApi } from '@monkvision/network';
+
+MonkApi.uploadPdf(options, apiConfig, dispatch);
+```
+
+Upload a new PDF to an inspection.
+
+| Parameter | Type             | Description                 | Required |
+|-----------|------------------|-----------------------------|----------|
+| options   | UploadPdfOptions | 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.4.1",
+    "version": "4.4.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.4.1",
-        "@monkvision/sights": "4.4.1",
+        "@monkvision/common": "4.4.3",
+        "@monkvision/sights": "4.4.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.4.1",
-        "@monkvision/eslint-config-typescript": "4.4.1",
-        "@monkvision/jest-config": "4.4.1",
-        "@monkvision/prettier-config": "4.4.1",
-        "@monkvision/types": "4.4.1",
-        "@monkvision/typescript-config": "4.4.1",
+        "@monkvision/eslint-config-base": "4.4.3",
+        "@monkvision/eslint-config-typescript": "4.4.3",
+        "@monkvision/jest-config": "4.4.3",
+        "@monkvision/prettier-config": "4.4.3",
+        "@monkvision/types": "4.4.3",
+        "@monkvision/typescript-config": "4.4.3",
         "@types/jest": "^29.2.2",
         "@types/jsonwebtoken": "^9.0.5",
         "@types/node": "^18.11.9",

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

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

package/lib/src/api/api.js

@@ -8,6 +8,7 @@ var liveConfigs_1 = require("./liveConfigs");
 var vehicle_1 = require("./vehicle");
 var pricing_1 = require("./pricing");
 var damage_1 = require("./damage");
+var pdf_1 = require("./pdf");
 /**
  * Object regrouping the different API requests available to communicate with the API using the `@monkvision/network`
  * package.
@@ -28,4 +29,6 @@ exports.MonkApi = {
     updatePricing: pricing_1.updatePricing,
     createDamage: damage_1.createDamage,
     deleteDamage: damage_1.deleteDamage,
+    uploadPdf: pdf_1.uploadPdf,
+    getPdf: pdf_1.getPdf,
 };

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

@@ -23,7 +23,7 @@ export interface CreateDamageOptions {
 /**
  * Create a new damage with the given options. See the `CreateDamageOptions` interface for more details.
  *
- * @param options The options of the 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.
@@ -46,7 +46,7 @@ export interface DeleteDamageOptions {
 /**
  * Delete a damage with the given options. See the `DeleteDamageOptions` interface for more details.
  *
- * @param options The options of the 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.

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

@@ -60,7 +60,7 @@ 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 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.
@@ -120,7 +120,7 @@ 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 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.

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

@@ -21,7 +21,11 @@ export declare enum MonkNetworkError {
      * The user corresponding to the authentication token provided in the request does not have the sufficient
      * authorization to perform the request.
      */
-    INSUFFICIENT_AUTHORIZATION = "InsufficientAuthorization"
+    INSUFFICIENT_AUTHORIZATION = "InsufficientAuthorization",
+    /**
+     * The PDF requested is not available.
+     */
+    UNAVAILABLE_PDF = "UnavailablePdf"
 }
 /**
  * Type definition for a network error catched by the Monk SDK. Requests made by this package will usually process the

package/lib/src/api/error.js

@@ -59,6 +59,10 @@ var MonkNetworkError;
      * authorization to perform the request.
      */
     MonkNetworkError["INSUFFICIENT_AUTHORIZATION"] = "InsufficientAuthorization";
+    /**
+     * The PDF requested is not available.
+     */
+    MonkNetworkError["UNAVAILABLE_PDF"] = "UnavailablePdf";
 })(MonkNetworkError = exports.MonkNetworkError || (exports.MonkNetworkError = {}));
 function getErrorMessage(name) {
     switch (name) {
@@ -70,6 +74,8 @@ function getErrorMessage(name) {
             return 'Authentication token is expired.';
         case MonkNetworkError.INSUFFICIENT_AUTHORIZATION:
             return 'User does not have the proper authorization grants to perform this request.';
+        case MonkNetworkError.UNAVAILABLE_PDF:
+            return 'The PDF requested is not available.';
         default:
             return null;
     }
@@ -92,6 +98,9 @@ function getErrorName(status, message) {
     if (status === 401 && message.includes('Token is expired')) {
         return MonkNetworkError.EXPIRED_TOKEN;
     }
+    if (status === 422 && message.includes('PDF has not been required to be generated')) {
+        return MonkNetworkError.UNAVAILABLE_PDF;
+    }
     // TODO : Also check conditions for MonkNetworkError.INSUFFICIENT_AUTHORIZATION.
     return null;
 }

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

@@ -287,6 +287,7 @@ function mapInspection(response, ids) {
         wheelAnalysis: mapWheelAnalysis(response),
         severityResults: ids.severityResultIds,
         pricings: ids.pricingIds,
+        pdfUrl: 'pdf_url' in response ? response.pdf_url : undefined,
         additionalData: response.additional_data,
     };
 }

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

@@ -0,0 +1,7 @@
+export interface ApiPdfPost {
+    pdf_post_strategy?: string;
+}
+export interface ApiPdf {
+    id: string;
+    pdf_url: string;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/lib/src/api/pdf/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/pdf/requests.d.ts

@@ -0,0 +1,50 @@
+import { MonkGotOneInspectionPdfAction } from '@monkvision/common';
+import { Dispatch } from 'react';
+import { MonkApiConfig } from '../config';
+import { ApiPdf } from '../models/pdf';
+import { MonkApiResponse } from '../types';
+/**
+ * Options passed to the `uploadPdf` API request.
+ */
+export interface UploadPdfOptions {
+    /**
+     * The ID of the inspection to update via the API.
+     */
+    id: string;
+    /**
+     * The PDF file to upload.
+     */
+    pdf: Blob;
+}
+/**
+ * Options passed to the `getPdf` API request.
+ */
+export interface GetPdfOptions {
+    /**
+     * The ID of the inspection to get the PDF from.
+     */
+    id: string;
+}
+/**
+ * Upload a PDF file to an inspection. See the `UploadPdfOptions` interface for more details.
+ *
+ * @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 UploadPdfOptions
+ */
+export declare function uploadPdf(options: UploadPdfOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkGotOneInspectionPdfAction>): Promise<MonkApiResponse>;
+/**
+ * Get a PDF file from an inspection. See the `GetPdfOptions` interface for more details.
+ *
+ * @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 GetPdfOptions
+ */
+export declare function getPdf(options: GetPdfOptions, config: MonkApiConfig, dispatch?: Dispatch<MonkGotOneInspectionPdfAction>): Promise<{
+    response: import("ky").KyResponse;
+    body: ApiPdf;
+}>;

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

@@ -0,0 +1,158 @@
+"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.getPdf = exports.uploadPdf = void 0;
+var common_1 = require("@monkvision/common");
+var ky_1 = __importDefault(require("ky"));
+var config_1 = require("../config");
+function getPdfData(options, filetype) {
+    var filename = "".concat(options.id, "-").concat(Date.now(), ".").concat(filetype);
+    var body = { pdf_post_strategy: 'upload' };
+    return { filename: filename, body: body };
+}
+var MULTIPART_KEY_PDF_DATA = 'pdf_data';
+var MULTIPART_KEY_JSON = 'json';
+function createPdfData(options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var extensions, filetype, _a, filename, body, file, data;
+        return __generator(this, function (_b) {
+            extensions = (0, common_1.getFileExtensions)(options.pdf.type);
+            if (!extensions) {
+                throw new Error("Unknown pdf mimetype : ".concat(options.pdf.type));
+            }
+            filetype = extensions[0];
+            _a = getPdfData(options, filetype), filename = _a.filename, body = _a.body;
+            file = new File([options.pdf], filename, { type: filetype });
+            data = new FormData();
+            data.append(MULTIPART_KEY_JSON, JSON.stringify(body));
+            data.append(MULTIPART_KEY_PDF_DATA, file);
+            return [2 /*return*/, data];
+        });
+    });
+}
+/**
+ * Upload a PDF file to an inspection. See the `UploadPdfOptions` interface for more details.
+ *
+ * @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 UploadPdfOptions
+ */
+function uploadPdf(options, config, dispatch) {
+    return __awaiter(this, void 0, void 0, function () {
+        var kyOptions, formData, response, body;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    kyOptions = (0, config_1.getDefaultOptions)(config);
+                    return [4 /*yield*/, createPdfData(options)];
+                case 1:
+                    formData = _a.sent();
+                    return [4 /*yield*/, ky_1.default.post("inspections/".concat(options.id, "/pdf"), __assign(__assign({}, kyOptions), { body: formData }))];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, ky_1.default.get("inspections/".concat(options.id, "/pdf"), __assign({}, kyOptions))];
+                case 3:
+                    response = _a.sent();
+                    return [4 /*yield*/, response.json()];
+                case 4:
+                    body = _a.sent();
+                    dispatch === null || dispatch === void 0 ? void 0 : dispatch({
+                        type: common_1.MonkActionType.GOT_ONE_INSPECTION_PDF,
+                        payload: { inspectionId: options.id, pdfUrl: body.pdf_url },
+                    });
+                    return [2 /*return*/, {
+                            id: body.id,
+                            response: response,
+                            body: body,
+                        }];
+            }
+        });
+    });
+}
+exports.uploadPdf = uploadPdf;
+/**
+ * Get a PDF file from an inspection. See the `GetPdfOptions` interface for more details.
+ *
+ * @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 GetPdfOptions
+ */
+function getPdf(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/".concat(options.id, "/pdf"), __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.GOT_ONE_INSPECTION_PDF,
+                        payload: { inspectionId: options.id, pdfUrl: body.pdf_url },
+                    });
+                    return [2 /*return*/, {
+                            response: response,
+                            body: body,
+                        }];
+            }
+        });
+    });
+}
+exports.getPdf = getPdf;

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

@@ -119,4 +119,21 @@ export declare function useMonkApi(config: MonkApiConfig): {
      * @see DeleteDamageOptions
      */
     deleteDamage: (options: import("./damage").DeleteDamageOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
+    /**
+     * Upload a PDF file to the API. See the `UploadPdfOptions` interface for more details.
+     *
+     * @param options The options of the inspection.
+     * @see UploadPdfOptions
+     */
+    uploadPdf: (options: import("./pdf").UploadPdfOptions) => Promise<import("./types").MonkApiResponse<import("./types").MonkId, import("./models").ApiIdColumn>>;
+    /**
+     * Get a PDF file from an inspection. See the `GetPdfOptions` interface for more details.
+     *
+     * @param options The options of the inspection.
+     * @see GetPdfOptions
+     */
+    getPdf: (options: import("./pdf").GetPdfOptions) => Promise<{
+        response: import("ky").KyResponse;
+        body: import("./models/pdf").ApiPdf;
+    }>;
 };

package/lib/src/api/react.js

@@ -152,6 +152,20 @@ function useMonkApi(config) {
          * @see DeleteDamageOptions
          */
         deleteDamage: reactify(api_1.MonkApi.deleteDamage, config, dispatch, handleError),
+        /**
+         * Upload a PDF file to the API. See the `UploadPdfOptions` interface for more details.
+         *
+         * @param options The options of the inspection.
+         * @see UploadPdfOptions
+         */
+        uploadPdf: reactify(api_1.MonkApi.uploadPdf, config, dispatch, handleError),
+        /**
+         * Get a PDF file from an inspection. See the `GetPdfOptions` interface for more details.
+         *
+         * @param options The options of the inspection.
+         * @see GetPdfOptions
+         */
+        getPdf: reactify(api_1.MonkApi.getPdf, config, dispatch, handleError),
     };
 }
 exports.useMonkApi = useMonkApi;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/network",
-  "version": "4.4.2",
+  "version": "4.4.4",
   "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.4.2",
-    "@monkvision/sights": "4.4.2",
+    "@monkvision/common": "4.4.4",
+    "@monkvision/sights": "4.4.4",
     "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.4.2",
-    "@monkvision/eslint-config-typescript": "4.4.2",
-    "@monkvision/jest-config": "4.4.2",
-    "@monkvision/prettier-config": "4.4.2",
-    "@monkvision/types": "4.4.2",
-    "@monkvision/typescript-config": "4.4.2",
+    "@monkvision/eslint-config-base": "4.4.4",
+    "@monkvision/eslint-config-typescript": "4.4.4",
+    "@monkvision/jest-config": "4.4.4",
+    "@monkvision/prettier-config": "4.4.4",
+    "@monkvision/types": "4.4.4",
+    "@monkvision/typescript-config": "4.4.4",
     "@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": "5258aa19cfb4c5b6d84ee38feb6af0a0e3fb73b6"
+  "gitHead": "7abfa7fbb0b482a6dd916c92cfc994f2b4e74257"
 }