addio-admin-sdk 1.7.102 → 1.7.104

package/dist/lib/TransferRequest/index.js

@@ -6,10 +6,12 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransferRequest = void 0;
 const TransferRequest_1 = require("../../Interfaces/TransferRequest");
+// Classes
 const DatabaseService_1 = __importDefault(require("../../services/database/DatabaseService"));
 const baseService_1 = require("../baseService");
 const Inventory_1 = __importDefault(require("../Inventory"));
 const Space_1 = __importDefault(require("../Space"));
+// Utils
 const toNumber_1 = __importDefault(require("lodash/toNumber"));
 const ceil_1 = __importDefault(require("lodash/ceil"));
 const round_1 = __importDefault(require("lodash/round"));
@@ -32,6 +34,10 @@ class TransferRequest extends baseService_1.BaseServiceClass {
         this.prevProducts = [];
         this.prevFromStore = undefined;
         this.processData = (data) => (Object.assign(Object.assign({}, data), { transfer_updates: data.transfer_updates.map((update) => (Object.assign(Object.assign({}, update), { date: (0, data_1.formatDate)(update.date) }))) }));
+        /**
+         * Test if the transfer can be closed
+         * @returns true if the status allow to close the transfer
+         */
         this.checkIfTransferCanBeClosedManually = () => {
             return this._data.status == TransferRequest_1.TransferRequestStatusEnum.RECEIVED_PARTIAL;
         };
@@ -159,7 +165,7 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                     catch (e) {
                         console.log('Error fetching transfer number', e);
                     }
-                    await (0, tools_1.waitFor)(1000);
+                    await (0, tools_1.waitFor)(1000); // wait a second before trying again, server needs to recover
                     triesLeft--;
                 }
                 if (triesLeft == 0)
@@ -178,27 +184,53 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             }
             return saveResult;
         };
+        /**
+         * Validate the quantities set before submit
+         * @param strictQty Tell if we should only allow equal quantity
+         * @returns
+         */
         this.validateBeforeSubmit = async (strictQty = true) => {
             if (strictQty) {
                 return this.data().products.every((p) => typeof p.qte_validation == 'undefined' || p.qte === p.qte_validation);
             }
             return this.data().products.every((p) => typeof p.qte_validation == 'undefined' || p.qte_validation >= 0);
         };
+        // --------------------------------------------------------------------
+        // #region QUANTITIES AND INVENTORY MANAGEMENT
+        /**
+         * Strip out the validation qty field in products data
+         * Do this before saving so the qte_validation doesnt get save in database
+         * @param copyQte should copy validation qty to the actual qty
+         */
         this.clearValidationQuantitiesFromProductData = (copyQte = false) => {
             this._data = Object.assign(Object.assign({}, this._data), { products: this._data.products.map((p) => (Object.assign(Object.assign({}, p), { qte: copyQte ? p.qte_validation || 0 : p.qte, qte_validation: undefined }))) });
         };
+        /**
+         * Add the validation quantities to the received amount
+         */
         this.addValidationQuantitiesToReceivedQuantities = () => {
             this._data = Object.assign(Object.assign({}, this._data), { products: this._data.products.map((p) => (Object.assign(Object.assign({}, p), { qte_received: (p.qte_validation || 0) + (p.qte_received || 0), qte_validation: undefined }))) });
         };
+        /**
+         * Return the previous quantity received for the provided sku
+         * @param sku the product sku to get
+         * @returns
+         */
         this.getPreviousReceivedQuantity = (sku) => {
             const entry = this._data.transfer_updates.find((u) => (u.status == TransferRequest_1.TransferRequestStatusEnum.RECEIVED_PARTIAL || u.status == TransferRequest_1.TransferRequestStatusEnum.RECEIVED) &&
                 u.products &&
                 u.products[sku]);
             if (entry) {
+                // if we got an entry then the sku exists inside
                 return entry.products[sku].qte_after;
             }
             return 0;
         };
+        /**
+         * Return the original reuested quantity
+         * @param sku the product sku to get
+         * @returns
+         */
         this.getOriginalRequestedQuantity = (sku) => {
             const product = this._data.products.find((p) => p.sku == sku);
             if (!product)
@@ -213,10 +245,18 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             });
             return result;
         };
+        /**
+         * Get the quantity at the requested status
+         * @param sku the product sku
+         * @param status the status to look for
+         * @returns the quantity at the specified status
+         */
         this.getQuantityAtStatus = (sku, status) => {
             const statusPos = (0, transferRequests_1.getOrderPositionForStatus)(status, TransferRequest_1.transferRequestStatusOrder) || 0;
+            // If status if first status in order
             if (statusPos == 0) {
                 const updates = this._data.transfer_updates.filter((u) => u.status == status);
+                // If no updates were done to products at same status. get original request quantity. Else, keep going in logic!
                 if (!updates.some((u) => !!u.products && !!u.products && !!u.products[sku]))
                     return this.getOriginalRequestedQuantity(sku);
             }
@@ -260,7 +300,8 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                     if (!!!inventoryItemQuery.exists)
                         continue;
                     const inventoryItem = new Inventory_1.default(inventoryItemQuery.data, inventoryColl, this._user);
-                    await inventoryItem.handleCancelInTransit(this._data.from, product.qte - product.qte_received, undefined, !!this._data.associated_order);
+                    await inventoryItem.handleCancelInTransit(this._data.from, product.qte - product.qte_received, // TODO - NEW INVENTORY UNIT : Here in old logic we didn't change to inventory unit. Normal?
+                    undefined, !!this._data.associated_order);
                 }
             }
             catch (err) {
@@ -269,12 +310,14 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             }
         };
         this.handleChangeStoreInventory = async (newStatus) => {
+            // test if can be processed
             if (!this._data.from)
                 return false;
             try {
                 if (DatabaseService_1.default.getPathParent(this._collection.path) == '/')
                     return false;
                 const inventoryColl = DatabaseService_1.default.asCollectionObject(DatabaseService_1.default.getPathParent(this._collection.path), 'inventories');
+                // Fetch associated cart
                 let associatedCart;
                 if (newStatus == TransferRequest_1.TransferRequestStatusEnum.RECEIVED || newStatus == TransferRequest_1.TransferRequestStatusEnum.RECEIVED_PARTIAL) {
                     try {
@@ -297,7 +340,9 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                         case TransferRequest_1.TransferRequestStatusEnum.RECEIVED_PARTIAL:
                             const qteReceivedSinceLastStatus = product.qte_received - this.getPreviousReceivedQuantity(product.sku);
                             if (qteReceivedSinceLastStatus == 0)
-                                continue;
+                                continue; // no need to update inventory if no quantities were received
+                            // If associated cart was already processed, ignore reserved quantities (all quantities received should be added to available quantities)
+                            // Else, calculate missing quantities for transfer
                             const cartWasProcessed = !!associatedCart && associatedCart.data().status > Cart_1.CartStatusEnum.CHECKOUT_PAYMENT_SUCCESS;
                             const qteToReserve = cartWasProcessed
                                 ? undefined
@@ -309,6 +354,7 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                                         ? qteReceivedSinceLastStatus
                                         : qteToReserve
                                     : 0,
+                                // If cart was already processed, skip web inventory update for availalble quantities
                                 skipWebUpdateForAvailable: cartWasProcessed
                             });
                             break;
@@ -322,11 +368,15 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 return false;
             }
         };
+        /**
+         * Update transfer's associated cart with new reserved quantities. Called when quantities received for transfer.
+         */
         this.handleUpdateAssociatedCartReservedQuantities = async () => {
             var _b, _c;
             const associatedCart = await this.fetchAssociatedCart();
             if (!!!associatedCart)
                 return;
+            // If cart was already processed (status > 5) skip cart quantity update
             if (associatedCart.data().status > Cart_1.CartStatusEnum.CHECKOUT_PAYMENT_SUCCESS)
                 return;
             let somethingHasChanged = false;
@@ -340,15 +390,18 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 }
                 const sellUnit = (item.other_units || []).find((o) => o.is_sale_unit);
                 const unitHasDecimals = !!sellUnit && (0, products_1.productUnitSupportsDecimals)(sellUnit.unit_slug);
+                // If reserved quantity is already same or larger than expected quantities, no need to update product
                 if (typeof item.qte_reserved == 'number' && (0, round_1.default)(item.qte_reserved, unitHasDecimals ? 2 : 0) >= item.qte) {
                     updatedCartItems.push(item);
                     continue;
                 }
+                // If no quantities were received since last status change, no need to update product
                 const qteReceivedSinceLastStatus = sameInTransfer.qte_received - this.getPreviousReceivedQuantity(sameInTransfer.sku);
                 if (!!!qteReceivedSinceLastStatus) {
                     updatedCartItems.push(item);
                     continue;
                 }
+                // Set new reserved quantities, capping at the quantity asked initially for order (rest is sent to available inventory for store when transfer is received)
                 const reservedQteInInventoryUnit = (0, inventories_1.getConvertedUnitQuantity)(item.other_units, (_b = item.qte_reserved) !== null && _b !== void 0 ? _b : 0, 'inventory_unit');
                 const qteInInventoryUnit = (0, inventories_1.getConvertedUnitQuantity)(item.other_units, (_c = item.qte) !== null && _c !== void 0 ? _c : 0, 'inventory_unit');
                 const newReservedQte = reservedQteInInventoryUnit + qteReceivedSinceLastStatus;
@@ -358,17 +411,24 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             if (!!!somethingHasChanged)
                 return;
             try {
-                await associatedCart.save({ items: updatedCartItems, id: associatedCart.data().id }, undefined, true, true, true);
+                await associatedCart.save({ items: updatedCartItems, id: associatedCart.data().id }, undefined, true, true, true); // Will save partial cart only. Skips indexed cart save (does not trigger cloud functions)
             }
             catch (e) {
                 console.log('error on saving cart with new qte_received in items: ', e.toString());
             }
         };
+        /**
+         * Use provided update object to construct new products object for current transfer
+         * @param updatesToDo The product updates to apply
+         * @param updatesToDo.sku The product sku to update
+         * @param updatesToDo.ajustementQte The quantity to ajust. Must be negative if quantity REMOVED, and positive if ADDED.
+         */
         this.constructProductObjFromUpdates = (updatesToDo) => {
             let updatedProducts = this._data.products.map((currentProd) => {
                 const sameInUpdates = updatesToDo.find((u) => u.sku == currentProd.sku);
                 if (!!!sameInUpdates)
                     return currentProd;
+                // Calculated new quantity with ajustmentQte, rounded up to zero
                 let newQte = currentProd.qte + sameInUpdates.ajustmentQte;
                 if (newQte < 0)
                     newQte = 0;
@@ -376,12 +436,20 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             });
             return updatedProducts;
         };
+        /**
+         * Will update content in transfer without triggering a status change, if current transfer status permits. Still adds entry to the transfer_updates array.
+         * @param updatedContent.products The array of products to update product
+         * @param updatedContent.fromStore The new from store slug value if changed
+         * @param options Options to create the associated transfer_updates entry
+         * @param cancelTransferIfAllProductsAtZero Optionnal. If transfer should be auto-cancelled if all products are now at 0 quantities
+         */
         this.saveUpdatesToContentOnly = async (updatedContent, options, cancelTransferIfAllProductsAtZero, updateContext = TransferRequest_1.TransferRequestUpdateContextEnum.TRANSFER_UPDATED) => {
             if (updatedContent.products) {
                 if (!TransferRequest.transferAllowsIndependantProductUpdate(this._data)) {
                     throw new Error('Cannot update products without changing status for current transfer status.');
                 }
                 await this.save({ products: updatedContent.products }, false, true);
+                // if validation quantities found, push values to qte and remove prop
                 if (!!updatedContent.products.some((p) => typeof p.qte_validation == 'number')) {
                     this.clearValidationQuantitiesFromProductData(true);
                 }
@@ -394,11 +462,13 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             }
             try {
                 const statusPositionObj = await this._getOrderObject();
+                // If flag to cancel transfer is provided and all products are now at 0 quantities, change status to cancelled. Else, keep current status
                 const shouldCancelTransfer = updatedContent.products &&
                     cancelTransferIfAllProductsAtZero &&
                     updatedContent.products.every((p) => p.qte <= 0) &&
                     TransferRequest.checkIfTransferCanBeCancelled(this._data.status, statusPositionObj);
                 const statusToUse = !!shouldCancelTransfer ? TransferRequest_1.TransferRequestStatusEnum.CANCELLED : this._data.status;
+                // Create new update entry for transfer and save
                 const newUpdates = this._generateNewTransferStatusUpdates(statusToUse, options.user, options.comment, undefined, updateContext);
                 await this.save(Object.assign({ transfer_updates: newUpdates }, (shouldCancelTransfer ? { status: statusToUse, completed: true } : {})), true, true);
             }
@@ -409,23 +479,49 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             }
             return this.data();
         };
+        // #endregion
+        // --------------------------------------------------------------------
+        // #region SPECIFIC PROP MANAGEMENT
+        /**
+         * Change or set the draft property value
+         * @param newVal The new value to assign
+         */
         this.setDraftValue = (newVal) => {
             this._data = Object.assign(Object.assign({}, this._data), { draft: newVal });
         };
+        /**
+         * Change or set the associated_order property value
+         * @param newVal The new value to assign
+         */
         this.setAssociatedOrder = (newVal) => {
             this._data = Object.assign(Object.assign({}, this._data), { associated_order: newVal });
         };
+        /**
+         * Change or set the transport_ref property value
+         * @param newVal The new value to assign
+         * @param saveToDatabase Do we save the new value in the database
+         */
         this.setTransportRef = async (newVal, saveToDatabase = false) => {
             await this.save({ transport_ref: newVal }, saveToDatabase, true);
         };
+        /**
+         * Set the original transfer id property value
+         * @param newVal The new value to assign
+         */
         this.setOriginalTransferId = async (newVal) => {
             this._data = Object.assign(Object.assign({}, this._data), { original_transfer_id: newVal });
         };
+        /**
+         * Change the completed status to true and save to database
+         */
         this.setAsCompleted = async (user, comment) => {
             this._generateNewTransferStatusUpdates(this._data.status, user, `Fermé manuellement${!!comment ? ' : ' + comment : ''}`, this._data.products, TransferRequest_1.TransferRequestUpdateContextEnum.TRANSFER_COMPLETED_MANUALLY);
+            // cancel any transit items
             await this.handleFreeTransitInventory();
             await this.save({ completed: true }, true, true);
         };
+        // --------------------------------------------------------------------
+        // #region STATUS MANAGEMENT
         this.changeStatus = async (newStatus, comment, user, saveToDatabase = true, options = {}) => {
             const saveOptions = {
                 comment,
@@ -466,6 +562,13 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 throw new Error('Impossible de soumettre le(s) transfert(s)');
             }
         };
+        /**
+         * Generates updates array and saves transfer for the first time in the database.
+         * @param currentUser
+         * @param comment
+         * @param saveToDatabase
+         * @throws if transfer already has an ID or doesn't have a status set
+         */
         this.saveNewTransfer = async (currentUser, comment, saveToDatabase = true, skipRef) => {
             if (!!this.data().id)
                 throw 'Cette demande de transfert existe déjà en base de données!';
@@ -474,10 +577,17 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             const newUpdates = this._generateNewTransferStatusUpdates(this.data().status, currentUser, comment);
             let newTransferRef = undefined;
             if (!!!skipRef) {
+                // Fetch next ref for transfer
                 newTransferRef = await this._getTransferRef();
             }
             return await this.save(Object.assign(Object.assign({}, this.data()), { ref: newTransferRef, transfer_updates: newUpdates }), saveToDatabase);
         };
+        /**
+         * Get the weight of a selected sku in this transfer
+         * @param sku the product sku
+         * @param unit the unit to return
+         * @returns the weight in the requested unit
+         */
         this.getProductWeight = (sku, unit = 'pounds') => {
             const item = this.data().products.find((p) => p.sku == sku);
             if (!item)
@@ -487,11 +597,18 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             const value = (0, toNumber_1.default)(item.weight.value) || 0;
             return item.weight.unit === unit ? value * item.qte : (0, weight_1.convertWeight)(value, item.weight.unit, unit) * item.qte;
         };
+        /**
+         * Fetches applicable transfer status order object by checking space_options for current space.
+         */
         this._getOrderObject = async (space) => {
             if (!space)
                 space = await Space_1.default.getCurrentSpaceWithRef(this._collection.path, this._user);
             return space.transferRequests.getTransferStatusOrder();
         };
+        /**
+         * Checks if provided "new" status follows current transfer status in the correct transfer status order for space.
+         * @param statusToCheck
+         */
         this._checkIfCanChangeToStatus = async (statusToCheck, space) => {
             const currentStatus = this._data.status;
             if (currentStatus == statusToCheck)
@@ -506,13 +623,24 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 return false;
             }
         };
+        /**
+         * Creates new entry for a status change, copies transfer_updates property and adds new entry to the start of copied array.
+         * @param newStatus
+         * @param user The email (or id) of Addio user that triggered the status change
+         * @param comment The user added comment for status change (can be undefined)
+         * @returns The copied array with the new value added.
+         */
         this._generateNewTransferStatusUpdates = (newStatus, user, comment, originalRequestProducts, context) => {
             const updates = this._data.transfer_updates;
             const newProducts = this._data.products;
             const newFromStore = this._data.from;
+            // If props id is set in transfer request (meaning it was saved to database at least once),
+            // create products update obj if some changes were made
             let prodUpdateObj = {};
+            // Id set means the transfer was saved to database
             if (!!this._data.id || !!originalRequestProducts) {
                 if (newStatus == TransferRequest_1.TransferRequestStatusEnum.RECEIVED || newStatus == TransferRequest_1.TransferRequestStatusEnum.RECEIVED_PARTIAL) {
+                    // at this step only received qty is allowed to change
                     for (let prod of newProducts) {
                         const addedQty = prod.qte_received - this.getPreviousReceivedQuantity(prod.sku);
                         if (addedQty != 0) {
@@ -525,30 +653,41 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                     }
                 }
                 else {
+                    // Use provided prevProducts, or "normal" prevProducts if undefined, for comparaison with new products
                     const prevProducts = !!originalRequestProducts ? originalRequestProducts : this.prevProducts;
                     for (let prod of newProducts) {
                         const name = prod.name;
                         const sameInPrev = prevProducts.find((p) => p.sku == prod.sku);
+                        // a. If product not found in prev array, it was added to transfer, add entry to update obj
                         if (!!!sameInPrev) {
                             prodUpdateObj[prod.sku] = { qte_before: 0, qte_after: prod.qte, name };
                         }
+                        // b. If product's quantities are different, add entry to update obj
                         else if (sameInPrev.qte !== prod.qte) {
                             prodUpdateObj[prod.sku] = { qte_before: sameInPrev.qte, qte_after: prod.qte, name };
                         }
                     }
+                    // Always use "normal" prevProducts for check here
                     for (let prevProd of this.prevProducts) {
                         const sameInNew = newProducts.find((p) => p.sku == prevProd.sku);
+                        // c. If product in prev array but not in new one, it was deleted fron transfer, add entry to update obj
                         if (!!!sameInNew) {
                             prodUpdateObj[prevProd.sku] = { qte_before: prevProd.qte, qte_after: 0, name: prevProd.name };
                         }
                     }
                 }
             }
+            // Add new update obj at start of array
             updates.unshift(Object.assign({ status: newStatus, date: new Date(), updated_by: user, comment: comment, products: !!Object.keys(prodUpdateObj).length ? prodUpdateObj : null, fromStore: this.prevFromStore != this._data.from && this._data.status == TransferRequest_1.TransferRequestStatusEnum.OPEN
                     ? { before: this.prevFromStore || '', after: newFromStore || '' }
                     : null }, (!!context ? { context } : {})));
             return updates;
         };
+        /**
+         * Saves provided status to TransferRequest data. Also generates and saves new entry for `transfer_updates` array.
+         * @param newStatus
+         * @param options
+         */
         this._saveNewStatus = async (newStatus, options, forceCompleted = false, context = TransferRequest_1.TransferRequestUpdateContextEnum.TRANSFER_STATUS_CHANGE) => {
             const newUpdates = this._generateNewTransferStatusUpdates(newStatus, options.user, options.comment, options.originalRequestProducts, context);
             const completedProps = options.markAsCompleted;
@@ -566,6 +705,10 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 throw new Error('Error while saving the transfer reqeust.');
             }
         };
+        /**
+         * Checks update eligibility, then updates status to OPEN.
+         * @param options
+         */
         this._setAsOpen = async (options) => {
             const newStatus = TransferRequest_1.TransferRequestStatusEnum.OPEN;
             const statusChangeValid = await this._checkIfCanChangeToStatus(newStatus, options.space);
@@ -573,6 +716,10 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 throw new Error('Trying to change to wrong status! Returning.');
             await this._saveNewStatus(newStatus, options);
         };
+        /**
+         * Checks update eligibility, then updates status to TO_BE_PREPARED.
+         * @param options
+         */
         this._setAsToBePrepared = async (options) => {
             const newStatus = TransferRequest_1.TransferRequestStatusEnum.TO_BE_PREPARED;
             const statusChangeValid = await this._checkIfCanChangeToStatus(newStatus, options.space);
@@ -580,6 +727,10 @@ class TransferRequest extends baseService_1.BaseServiceClass {
                 throw new Error('Trying to change to wrong status! Returning.');
             await this._saveNewStatus(newStatus, options);
         };
+        /**
+         * Checks update eligibility, then updates status to IN_TRANSIT. Also updates inventory for the origin store.
+         * @param options
+         */
         this._setAsInTransit = async (options) => {
             const newStatus = TransferRequest_1.TransferRequestStatusEnum.IN_TRANSIT;
             const statusChangeValid = await this._checkIfCanChangeToStatus(newStatus, options.space);
@@ -591,18 +742,30 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             }
             await this._saveNewStatus(newStatus, options);
         };
+        /**
+         * Checks update eligibility, then updates status to RECEIVED. Also updates inventory for both stores.
+         * @param options
+         */
         this._setAsReceived = async (options) => {
             const newStatus = TransferRequest_1.TransferRequestStatusEnum.RECEIVED;
             const statusChangeValid = await this._checkIfCanChangeToStatus(newStatus, options.space);
             if (!statusChangeValid)
                 throw new Error('Trying to change to wrong status! Returning.');
+            // Update inventory for items received
             const inventoryChangesSuccess = await this.handleChangeStoreInventory(newStatus);
             if (!!!inventoryChangesSuccess) {
                 throw "Une erreur est survenue lors de la mise à jour de l'inventaire.";
             }
+            // Update associated cart for reserved quantities
             await this.handleUpdateAssociatedCartReservedQuantities();
+            // Update transfer and status
             await this._saveNewStatus(newStatus, options, true);
         };
+        /**
+         * Checks update eligibility, then updates status to RECEIVED_PARTIAL. Also updates inventory for both stores.
+         * @param options
+         * @todo Update inventory logic to deal with partially received quantities.
+         */
         this._setAsReceivedPartially = async (options) => {
             const newStatus = TransferRequest_1.TransferRequestStatusEnum.RECEIVED_PARTIAL;
             const statusChangeValid = await this._checkIfCanChangeToStatus(newStatus, options.space);
@@ -612,9 +775,15 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             if (!!!inventoryChangesSuccess) {
                 throw "Une erreur est survenue lors de la mise à jour de l'inventaire.";
             }
+            // Update associated cart for reserved quantities
             await this.handleUpdateAssociatedCartReservedQuantities();
+            // Update transfer and status
             await this._saveNewStatus(newStatus, options);
         };
+        /**
+         * Checks if transfer can be cancelled, and if so, updates status to CANCELLED.
+         * @param options
+         */
         this._setAsCancelled = async (options, context) => {
             const newStatus = TransferRequest_1.TransferRequestStatusEnum.CANCELLED;
             const statusPositionObj = await this._getOrderObject();
@@ -624,6 +793,9 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             }
             await this._saveNewStatus(newStatus, options, true, context);
         };
+        /**
+         * Object regrouping all status change functions
+         */
         this.updateToStatus = {
             open: this._setAsOpen,
             toBePrepared: this._setAsToBePrepared,
@@ -632,6 +804,14 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             receivedPartial: this._setAsReceivedPartially,
             cancelled: this._setAsCancelled
         };
+        // #endregion
+        // --------------------------------------------------------------------
+        // #region FORMAT DATA
+        /**
+         * Get formatted ref string for the transfer.
+         * @param spaceTransferSettings
+         * @returns {string | undefined}
+         */
         this.getFormattedRef = (spaceTransferSettings) => {
             if (typeof this._data.ref == 'undefined') {
                 console.log('transfer has no ref, returning!');
@@ -643,10 +823,13 @@ class TransferRequest extends baseService_1.BaseServiceClass {
             const suffix = spaceTransferSettings.suffix;
             return `${prefix ? prefix + '-' : ''}${this._data.ref}${suffix ? '-' + suffix : ''}`;
         };
+        // Format dates in data
         this._data = this.processData(_data);
+        // Keep products in current transfer for update reference
         if (!!this._data.products.length) {
             this.prevProducts = [...this._data.products];
         }
+        // Keep from store in current transfer for update reference
         if (!!this._data.from)
             this.prevFromStore = this._data.from;
     }
@@ -713,6 +896,10 @@ TransferRequest.checkIfTransferCanBeCancelled = (currentTransferStatus, statusOr
     }
     return (0, toNumber_1.default)(currentPosition) < (0, toNumber_1.default)(inTransitPosition);
 };
+/**
+ * Checks if provided status is included in "completed" transfer statuses list.
+ * @param statusToCheck
+ */
 TransferRequest.checkIfStatusCountsAsCompleted = (statusToCheck) => {
     return [
         TransferRequest_1.TransferRequestStatusEnum.RECEIVED,
@@ -723,13 +910,20 @@ TransferRequest.checkIfStatusCountsAsCompleted = (statusToCheck) => {
 TransferRequest.transferAllowAssignFromStore = (data) => {
     if (!!data.completed)
         return false;
+    // Id set means the transfer was saved to database
     return !!data.id && TransferRequest_1.TransferRequestStatusEnum.INITIATED === data.status;
 };
 TransferRequest.transferAllowEditFromStore = (data) => {
     if (!!data.completed)
         return false;
+    // Id set means the transfer was saved to database
     return !!data.id && TransferRequest_1.TransferRequestStatusEnum.OPEN === data.status;
 };
+/**
+ * Test if the transfer allow adding products
+ * @param data the request data to verify
+ * @returns true if can add product
+ */
 TransferRequest.transferAllowAddProductOnEdit = (data) => {
     if (!!data.completed)
         return false;
@@ -737,13 +931,24 @@ TransferRequest.transferAllowAddProductOnEdit = (data) => {
         return true;
     return [TransferRequest_1.TransferRequestStatusEnum.INITIATED].includes(data.status);
 };
+/**
+ * Test if the transfer allow deleteing products
+ * @param data the request data to verify
+ * @returns true if can delete product
+ */
 TransferRequest.transferAllowProductDelete = (data) => {
     if (!!data.completed)
         return false;
+    // Id not set yet means the transfer is in creation mode. Product deletion should be allowed!
     if (!!!data.id)
         return true;
     return [TransferRequest_1.TransferRequestStatusEnum.INITIATED].includes(data.status);
 };
+/**
+ * Test if the transfer allow editing products
+ * @param data the request data to verify
+ * @returns true if can be edited
+ */
 TransferRequest.transferAllowEditProductOnEdit = (data) => {
     if (!!data.completed)
         return false;
@@ -753,24 +958,46 @@ TransferRequest.transferAllowEditProductOnEdit = (data) => {
         TransferRequest_1.TransferRequestStatusEnum.TO_BE_PREPARED
     ].includes(data.status);
 };
+/**
+ * Test if the transfer allow deleteing products when editing (not changing status)
+ * @param data the request data to verify
+ * @returns {boolean} true if can delete product
+ */
 TransferRequest.transferAllowDeleteProductOnEdit = (data) => {
     if (!!data.completed)
         return false;
+    // Id not set yet means the transfer is in creation mode. Product deletion should be allowed!
     if (!!!data.id)
         return true;
     return [TransferRequest_1.TransferRequestStatusEnum.INITIATED, TransferRequest_1.TransferRequestStatusEnum.OPEN].includes(data.status);
 };
+/**
+ * Test if the transfer has reached a state where it should display weight
+ * @param data the request data to verify
+ * @returns {boolean}
+ */
 TransferRequest.transferShouldDisplayWeight = (data) => {
     return ![TransferRequest_1.TransferRequestStatusEnum.INITIATED].includes(data.status);
 };
+/**
+ * Test if the transfer allows products to be updated without a status change
+ * @param data the request data to verify
+ * @returns {boolean}
+ */
 TransferRequest.transferAllowsIndependantProductUpdate = (data) => {
     if (!!data.completed)
         return false;
     let acceptedStatuses = [TransferRequest_1.TransferRequestStatusEnum.INITIATED, TransferRequest_1.TransferRequestStatusEnum.OPEN];
+    // If no cart associated to transfer, update can be done at TO_BE_PREPARED status as well
     if (!data.associated_order)
         acceptedStatuses.push(TransferRequest_1.TransferRequestStatusEnum.TO_BE_PREPARED);
     return acceptedStatuses.includes(data.status);
 };
+/**
+ * Get the total estimated weight by calculating each product's weigth times inventory quantity
+ * @param unit the unit to return
+ * @returns the weight in the requested unit
+ */
 TransferRequest.getTotalWeight = (products, unit = 'pounds') => {
     return (0, sumBy_1.default)(products, (item) => {
         if (!!!item.weight)
@@ -779,6 +1006,11 @@ TransferRequest.getTotalWeight = (products, unit = 'pounds') => {
         return item.weight.unit === unit ? value * item.qte : (0, weight_1.convertWeight)(value, item.weight.unit, unit) * item.qte;
     });
 };
+/**
+ * Get the total calculated pallet quantities for all transfer items
+ * @param items
+ * @returns
+ */
 TransferRequest.getTotalPalletQte = (items) => {
     const total = (0, sumBy_1.default)(items.map((item) => {
         if (!!!item.other_units || !!!item.count_in_pallet_total) {