addio-admin-sdk 1.7.103 → 1.7.104

package/dist/lib/Space/index.js

@@ -1,4 +1,5 @@
 "use strict";
+//#region IMPORTS
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -107,7 +108,14 @@ const IExternalService_1 = require("../../Interfaces/Space/IExternalService");
 const utils_1 = require("../../services/products/utils");
 const Menu_1 = __importDefault(require("../../lib/Menu"));
 const Note_1 = __importDefault(require("../Note"));
+//#endregion
+/**
+ * Class Space
+ * A Space represent a company.
+ */
 class Space {
+    //#endregion
+    //#region CONSTRUCTOR
     constructor(space, user, space_ref) {
         this.getRef = () => this._space_ref;
         this.initCurrencies = async () => {
@@ -125,6 +133,11 @@ class Space {
                 throw _e;
             }
         };
+        //#endregion
+        //#region SPACE
+        /**
+         * Create the actual space
+         */
         this.create = async () => {
             try {
                 const newSpaceDoc = await DatabaseService_1.default.addDocument(this._space_ref.path, Object.assign({}, this._space));
@@ -136,6 +149,10 @@ class Space {
                 throw `Error while creating the new space: ${error}`;
             }
         };
+        /**
+         * Update current space with a partial space pass as parameters.
+         * @param updates Updates to be made on the space - Partial<Space>
+         */
         this.update = async (updates) => {
             try {
                 this._space = Object.assign(Object.assign({}, this._space), updates);
@@ -199,9 +216,13 @@ class Space {
         this.listenOnChange = (callback) => {
             return DatabaseService_1.default.registerListener((values) => callback(values), DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id));
         };
+        //#endregion
+        //#region SPACE - PREFERENCES - CUSTOMERS
         this._getAllCustomerGroups = () => {
             return !!this.data().customer_groups ? this.data().customer_groups : [];
         };
+        //#endregion
+        //#region SPACE - PREFERENCES - SHIPPING
         this._updateShippingFee = async (forProps, value) => {
             this._space = Object.assign(Object.assign({}, this._space), { transport_preferences: Object.assign(Object.assign({}, this._space.transport_preferences), { [forProps]: value }) });
             return await DatabaseService_1.default.saveDocument(this._space_ref.path, this._space_ref.id, 0, {
@@ -241,6 +262,8 @@ class Space {
         };
         this._setShippingAsProduct = async (value) => {
             this._space = Object.assign(Object.assign({}, this._space), { transport_preferences: Object.assign(Object.assign({}, this._space.transport_preferences), { shipping_as_product: value }) });
+            // If shipping_as_product is set to true,
+            // save all discounts applied to shipping with draft: true
             if (!!value) {
                 try {
                     const allDiscounts = await this.discountRules.get();
@@ -500,9 +523,13 @@ class Space {
                 return [];
             return transport_preferences.predefined_envelops;
         };
+        //#endregion
+        //#region SPACE - PREFERENCES - PRODUCTS
         this._getAllProductPreferences = () => {
             return this.data().product_preferences;
         };
+        //#endregion
+        //#region SPACE - OPTIONS
         this._getOptions = () => {
             const options = this.data().space_options || (0, Space_1.getDefaultSpaceOptions)();
             return options;
@@ -521,6 +548,8 @@ class Space {
             const allOptions = this._getOptions();
             return (0, object_1.recursiveCheckObject)(allOptions, path);
         };
+        //#endregion
+        //#region SPACE - STORES
         this._getAllStores = () => {
             return this.data().stores_warehouses;
         };
@@ -545,7 +574,10 @@ class Space {
                 ]
             });
         };
+        //#endregion
+        //#region SPACE - EXTERNAL SERVICES
         this._getExternalServices = async () => {
+            //const servicesSnap = await this._space_ref.collection('external_services').get()
             const servicesSnap = await DatabaseService_1.default.getDocuments(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/external_services'));
             if (servicesSnap.length)
                 return [];
@@ -587,6 +619,11 @@ class Space {
             const currentExternalServices = (_c = this.data().external_services) !== null && _c !== void 0 ? _c : [];
             return currentExternalServices.filter((s) => (!!s.is_active || !!returnIfInactive) && !!s[query.field] && s[query.field] === query.value);
         };
+        /**
+         * Fetch the external service for the name provided
+         * @param serviceName
+         * @param returnInactiveService Optionnal, defaults to false. Must be set if service should be returned even if it is inactive
+         */
         this._getSpecificServiceByName = (serviceName, returnInactiveService = false) => {
             const serviceQuery = this._fetchServices({ field: 'external_service_name', operator: '==', value: serviceName });
             if (!!!serviceQuery.length)
@@ -621,6 +658,9 @@ class Space {
                 return false;
             }
         };
+        /**
+         * Check if external_value fields should be shown for space
+         */
         this._showExternalValueFieldsForSpace = () => {
             const spaceID = this._space.id;
             switch (true) {
@@ -638,6 +678,10 @@ class Space {
                     return;
             }
         };
+        /**
+         * Get array of field data nesessary to show space's external_values per objet type
+         * @param objType The object type to check for external_values
+         */
         this._getExternalFieldsToShowForPageType = (objType) => {
             const allTypesForSpace = this._showExternalValueFieldsForSpace();
             if (!!!allTypesForSpace || allTypesForSpace.pages.every((t) => t !== objType))
@@ -714,6 +758,8 @@ class Space {
                     return [];
             }
         };
+        //#endregion
+        //#region TAXES
         this._getAllTaxes = async () => {
             return await Tax_1.default.getAllTaxes();
         };
@@ -726,9 +772,13 @@ class Space {
                 throw new Error(`Can't find tax for code ${taxCode}`);
             return Object.assign(Object.assign({}, tax), { id: taxReq.id });
         };
+        //#endregion
+        //#region CONSENT
         this._getMostRecentConsentForm = async () => {
             return await Consent_1.default.getMostRecentConsent();
         };
+        //#endregion
+        //#region BRANDS
         this._brandsListener = (callback, _options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -804,6 +854,8 @@ class Space {
                 (0, console_1.errorMessage)(`Error while creating new brand: ${error}`);
             }
         };
+        //#endregion
+        //#region BLOG ARTICLES
         this._getBlogArticles = async () => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -821,6 +873,8 @@ class Space {
                 return [];
             }
         };
+        //#endregion
+        //#region BLOG AUTHORS
         this._getBlogAuthors = async () => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -838,6 +892,8 @@ class Space {
                 return [];
             }
         };
+        //#endregion
+        //#region BLOG CATEGORIES
         this._getBlogCategories = async () => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -874,6 +930,8 @@ class Space {
                 return '';
             }
         };
+        //#endregion
+        //#region BLOG KEYWORDS
         this._getBlogKeywords = async () => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -891,6 +949,8 @@ class Space {
                 return [];
             }
         };
+        //#endregion
+        //#region CATALOGUES
         this._getCatalogues = async () => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -943,10 +1003,13 @@ class Space {
                         }
                     ]
                 });
+                // If no docs returned, return true
                 if (!!!query || !!!query.length)
                     return true;
+                // If only one doc returned, and is same ID as current catalogue, return true
                 if (query.length === 1 && query[0].id === id)
                     return true;
+                // Else, slug already exists
                 return false;
             }
             catch (e) {
@@ -993,6 +1056,8 @@ class Space {
                 return false;
             }
         };
+        //#endregion
+        //#region CATEGORIES
         this._categoriesListener = (callback, options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -1016,6 +1081,12 @@ class Space {
             if (this._user === undefined)
                 throw 'Invalid or unauthenticated user';
             try {
+                /*let call = this._space_ref.collection('categories')
+                if (!!options) {
+                    call = constructFirebaseCallWithOptions(call, options)
+                }
+    
+                let categoriesCollection = await call.get()*/
                 let categoriesCollection = await DatabaseService_1.default.getDocuments(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/categories'), options);
                 if (categoriesCollection.length == 0)
                     return [];
@@ -1026,6 +1097,13 @@ class Space {
                 return [];
             }
         };
+        /**
+         * Get full category tree
+         * @deprecated use new _getTreeNew function instead
+         * @param categories
+         * @param level
+         * @param parent
+         */
         this._getTree = (categories, level = 0, parent) => {
             const _categories = categories.filter((c) => c.getHierarchicalOrderBasedOnCategories(categories) === level);
             if (_categories.length === 0)
@@ -1035,6 +1113,11 @@ class Space {
             }
             return (0, orderBy_1.default)(_categories.filter((c) => !!c.data().parent && c.data().parent === parent), (c) => c.data().order).map((c) => (Object.assign(Object.assign({}, c.data()), { children: this._getTree(categories, level + 1, c.data().id), items_count: 2 })));
         };
+        /**
+         * Get array of ordered categories
+         * @param categories
+         * @param parentID
+         */
         this._getTreeNew = (categories, parentID) => {
             return (0, categories_1.buildTree)(categories.map((c) => c.data()), parentID);
         };
@@ -1048,6 +1131,7 @@ class Space {
         };
         this._resetInventories = async (categoryId) => {
             try {
+                // Fetch les produits (inventaires) de la catégories
                 const inventorieToUpdateFromCategoryId = await this.inventoryItems.get({
                     query: [
                         {
@@ -1058,6 +1142,7 @@ class Space {
                     ]
                 });
                 (0, console_1.workingMessage)(`${inventorieToUpdateFromCategoryId.length} inventaires trouvés. Processing...`, true);
+                // Mettre les inventaires à 0
                 for (const inventoryGroup of (0, chunk_1.default)(inventorieToUpdateFromCategoryId, 250)) {
                     (0, console_1.workingMessage)(`Exécution d'une batch de 250...`, true);
                     const inventoryBatch = new BatchUtils_1.default();
@@ -1065,6 +1150,7 @@ class Space {
                         try {
                             if (!!!inventory.id)
                                 continue;
+                            // Mettre les valeurs d'inventaire à 0
                             inventoryBatch.set(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/inventories'), inventory.id, {
                                 web_inventory: {
                                     available: 0,
@@ -1093,6 +1179,12 @@ class Space {
                 (0, console_1.errorMessage)(error.toString(), true);
             }
         };
+        /**
+         * Private function to save a bulk of document to a collection
+         * @param obj an array of documents
+         * @param collection the collection name where to save
+         * @returns the amount of save vs errors
+         */
         this._batchSaveCollection = async (obj, collection) => {
             let errorsOccured = 0;
             let totalSaves = 0;
@@ -1183,6 +1275,8 @@ class Space {
                 throw `Failed to update category ${category.id}: ${error}`;
             }
         };
+        //#endregion
+        //#region ATTRIBUTES
         this.addAttribute = async (attribute) => {
             if (!!!this._user) {
                 (0, console_1.errorMessage)(`A user must be authenticated to create a new attribute`);
@@ -1236,11 +1330,15 @@ class Space {
             const productAttributeObj = new Attribute_1.default(attribute, DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/attributes'), this._user);
             await productAttributeObj.save();
         };
+        //#endregion
+        //#region PRODUCTS
         this._saveAllActiveProducts = async () => {
             try {
                 const products = await this.products.get();
+                // let _pIndex = 1
                 for (const p of products.filter((p) => !!!p.data().draft && !!p.data().declinations && !!p.data().declinations.length)) {
                     await p.save(undefined, { index: true });
+                    // _pIndex++
                 }
             }
             catch (error) {
@@ -1540,12 +1638,17 @@ class Space {
             for (const service of services) {
                 const serviceClass = (0, utils_1.getInstanceToUseForProductService)(service.external_service_slug, pathInfo.space, pathInfo.org);
                 if (serviceClass) {
+                    // try to get the product from this provider
                     const prod = await serviceClass.getProduct(slug, this._space);
                     if (prod)
                         return prod;
                 }
             }
         };
+        /**
+         * Fetch all options with - optionnal - query
+         * @param options Query options - optionnal
+         */
         this._getProducts = async (options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -1553,6 +1656,7 @@ class Space {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/products');
                 const productsCollection = await DatabaseService_1.default.getDocuments(call, options);
                 if (productsCollection.length == 0) {
+                    // Search in external products too
                     const slug = this._getExternalProductsSlugToTry(options);
                     if (slug) {
                         const productFound = await this._getExternalProductBySlug(slug);
@@ -1570,6 +1674,12 @@ class Space {
                 return [];
             }
         };
+        /**
+         * Obtenir une partie des produits à partir de l'indentifiant fournis
+         * @param from le id du dernier document ou continuer ou undefine si on veut le premier
+         * @param limit la taille max à lire, idéalement 500 ou moins
+         * @returns la liste de produits récupéré
+         */
         this._getProductsPage = async (from, limit) => {
             const productsCollection = await DatabaseService_1.default.getDocuments(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/products'), { orderBy: '__id', limit: limit, startAfter: !!from ? from : undefined });
             if (productsCollection.length == 0)
@@ -1702,6 +1812,29 @@ class Space {
                 ? undefined
                 : (0, currency_1.calculateAmountByCurrencyAllDetails)(this, this.preferences.default.currency(), d.price.discountPrice.amount);
             let regular = (0, currency_1.calculateAmountByCurrencyAllDetails)(this, this.preferences.default.currency(), d.price.regular.amount);
+            // const tierPricing = flatten(
+            // 	d.discount_rules
+            // 		.filter((d) => d.discountRule_type === 'tier-pricing')
+            // 		.map((discount) =>
+            // 			applyTierPricing(
+            // 				discount,
+            // 				Number(
+            // 					!!discount.result.apply_on_discounted_price && !!d.price.discountPrice
+            // 						? d.price.discountPrice.amount
+            // 						: d.price.regular.amount
+            // 				),
+            // 				this
+            // 			)
+            // 		)
+            // )
+            // if (!!tierPricing && !!tierPricing.length) {
+            // 	const lowestTier = minBy(tierPricing, (t) => t.price.amount)
+            // 	if (!!lowestTier) {
+            // 		if (lowestTier.price.amount < regular.amount) {
+            // 			regular = lowestTier.price
+            // 		}
+            // 	}
+            // }
             if (!!promo) {
                 if (!!discount && promo.amount <= discount.amount && promo.amount !== 0)
                     return promo;
@@ -1757,10 +1890,12 @@ class Space {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/indexes/products/public');
                 const indexedProducts = await DatabaseService_1.default.getDocuments(call, options);
                 if (indexedProducts.length == 0) {
+                    // search in external products too
                     const slug = this._getExternalProductsSlugToTry(options);
                     if (slug) {
                         const productFound = await this._getExternalProductBySlug(slug);
                         if (productFound) {
+                            // get the category and brand
                             return [await this._getIndexedProductFromProduct(productFound)];
                         }
                     }
@@ -1781,10 +1916,12 @@ class Space {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/indexes/products/public');
                 const allExistingIndexes = await DatabaseService_1.default.getDocuments(call, options);
                 if (allExistingIndexes.length == 0) {
+                    // search in external products too
                     const slug = this._getExternalProductsSlugToTry(options);
                     if (slug) {
                         const productFound = await this._getExternalProductBySlug(slug);
                         if (productFound) {
+                            // get the category and brand
                             return [
                                 new Product_2.default(await this._getIndexedProductFromProduct(productFound), DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/indexes/products/public'), this._user)
                             ];
@@ -1803,6 +1940,7 @@ class Space {
         };
         this._saveAllIndexedCategories = async (tree) => {
             try {
+                //TODO- check with Christian if this is okay: this._space_ref.collection('indexes').doc('categories').set({ data: tree })
                 DatabaseService_1.default.saveDocument(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/indexes'), 'categories', 0, tree, { merge: false });
             }
             catch (error) {
@@ -1838,6 +1976,13 @@ class Space {
                 throw error;
             }
         };
+        /**
+         * Finds indexed declination corresponding to parent slug and sku provided
+         * @param space
+         * @param parentSlug - The parent product slug (to search space indexed products)
+         * @param sku - The specific sku for the declination
+         * @param customPriceList - Optionnal. If provided, indexed decli is returned with adjusted prices from price list
+         */
         this._fetchIndexedDecliBySlugAndSku = async (parentSlug, sku, customPriceList) => {
             try {
                 let indexedDecli = undefined;
@@ -1865,6 +2010,8 @@ class Space {
                 return;
             }
         };
+        //#endregion
+        //#region INVENTORY ITEMS
         this._getAllInventoryItems = async (options) => {
             let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/inventories');
             const allExistingInventoryItemsQuery = await DatabaseService_1.default.getDocuments(call, options);
@@ -1882,6 +2029,12 @@ class Space {
             });
             return allExistingInventoryItems;
         };
+        /**
+         * Obtenir une partie des inventaires à partir de l'indentifiant fournis
+         * @param from le id du dernier document ou continuer ou undefine si on veut le premier
+         * @param limit la taille max à lire, idéalement 500 ou moins
+         * @returns la liste de l'inventaires récupéré
+         */
         this._getInventoryPage = async (from, limit) => {
             let productsCollection = await DatabaseService_1.default.getDocuments(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/inventories'), {
                 order: 'asc',
@@ -1983,6 +2136,8 @@ class Space {
         this._setIsSaving = async (user_email) => {
             await this.save({ is_saving_inventory: user_email });
         };
+        //#endregion
+        //#region TRANSFER REQUESTS
         this._getAllTransfertRequests = async () => {
             const collRef = DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/transfer_requests');
             const allTransferRequests = await DatabaseService_1.default.getDocuments(collRef.path);
@@ -2036,6 +2191,8 @@ class Space {
                 console.log('error on fetching transfer for ref: ', e.toString());
             }
         };
+        //#endregion
+        //#region DISCOUNT RULES
         this._discountRulesListener = (callback, options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -2124,6 +2281,8 @@ class Space {
                 return [];
             }
         };
+        //#endregion
+        //#region PURCHASE ORDERS
         this._getPurchaseOrders = async (options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -2163,11 +2322,13 @@ class Space {
             orderState: 'draft'
         }, DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/purchaseOrders'), this._user);
         this.generatePurchaseOrders = async (declinationsToAdd) => {
+            // const suppliers = await this._getSuppliers()
             const products = await this._getProducts();
             const purchaseOrders = [];
             declinationsToAdd.forEach((declinationData) => {
                 const productOfDeclination = products.filter((product) => product.declinations.get().some((decli) => decli.data().slug == declinationData.declination.slug))[0];
                 const supplier_id = productOfDeclination.getDefaultSupplier();
+                // Si la purchase order existe déjà
                 if (purchaseOrders.some((purchaseOrder) => purchaseOrder.supplier_id === supplier_id)) {
                     const purchaseOrderIndex = (0, findIndex_1.default)(purchaseOrders, (order) => order.supplier_id == supplier_id);
                     purchaseOrders[purchaseOrderIndex] = Object.assign(Object.assign({}, purchaseOrders[purchaseOrderIndex]), { items: [
@@ -2204,7 +2365,9 @@ class Space {
             if (this._user === undefined)
                 throw 'Invalid or unauthenticated user';
             try {
+                //TODO- check with Christian if this is okay
                 return DatabaseService_1.default.registerListener((dataSnap) => {
+                    // tslint:disable-next-line: no-null-keyword
                     if (dataSnap.length == 0)
                         callback(null);
                     (0, console_1.workingMessage)(`Purchase order list has been udpated. Refreshing...`);
@@ -2213,6 +2376,7 @@ class Space {
             }
             catch (err) {
                 (0, console_1.errorMessage)(JSON.stringify(err));
+                // tslint:disable-next-line: no-null-keyword
                 callback(null);
                 return '';
             }
@@ -2238,6 +2402,8 @@ class Space {
                 return '';
             }
         };
+        //#endregion
+        //#region CLASSES
         this._getClasses = async (options) => {
             try {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/classes');
@@ -2286,6 +2452,8 @@ class Space {
                 (0, console_1.errorMessage)(`Error while creating new class: ${error}`);
             }
         };
+        //#endregion
+        //#region SUPPLIERS
         this._getSuppliers = async (options) => {
             try {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/suppliers');
@@ -2326,6 +2494,8 @@ class Space {
                 return '';
             }
         };
+        //#endregion
+        //#region CART
         this.createEmptyCart = async (save = false, cartType = Cart_1.CartTypeEnum.WEB, defaultPickup = false) => {
             const cart = new Cart_2.default(Object.assign(Object.assign({}, (0, Cart_1.getDefaultCart)(cartType)), (!!defaultPickup ? { is_pickup: true } : {})), DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/carts'), this._user);
             await cart.save({}, undefined, save);
@@ -2346,7 +2516,7 @@ class Space {
                     const data = d.data;
                     const paid_at = !!!data.paid_at
                         ? undefined
-                        : data.paid_at instanceof app_1.default.firestore.Timestamp
+                        : data.paid_at instanceof app_1.default.firestore.Timestamp // TODO - remplacer par formatDate
                             ? data.paid_at.toDate()
                             : data.paid_at;
                     return new Cart_2.default(Object.assign(Object.assign({}, data), { id: d.id, paid_at }), DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/carts'), this._user);
@@ -2417,6 +2587,8 @@ class Space {
                 store: (0, sumBy_1.default)(inventories.filter((i) => !!i), (i) => (0, sumBy_1.default)(i.inventories, (inventory) => inventory.qty.available || 0))
             };
         };
+        //#endregion
+        //#region ALL ORDER TYPES
         this._getAllOrderTypes = async (id = '') => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -2448,6 +2620,71 @@ class Space {
                 throw new Error(`Error while getting invoices: ${err}`);
             }
         };
+        // private _listenOrder = async (id: string = '', callback: any) => {
+        // 	if (!!!this._user) throw 'Invalid or unauthenticated user'
+        // 	if (this._user === undefined) throw 'Invalid or unauthenticated user'
+        // 	try {
+        // 		let invoicesDocs
+        // 		let ordersDocs
+        // 		let cartsDocs
+        // 		invoicesDocs = await DatabaseService.getDocuments(
+        // 			DatabaseService.addToPath(this._space_ref.path, this._space_ref.id + '/invoices')
+        // 		)
+        // 		ordersDocs = await DatabaseService.getDocuments(
+        // 			DatabaseService.addToPath(this._space_ref.path, this._space_ref.id + '/orders')
+        // 		)
+        // 		cartsDocs = await DatabaseService.getDocuments(
+        // 			DatabaseService.addToPath(this._space_ref.path, this._space_ref.id + '/carts')
+        // 		)
+        // 		let allOrderTypes: any[] = []
+        // 		allOrderTypes.push(
+        // 			invoicesDocs
+        // 				.filter((d) => d.exists && !!d.data)
+        // 				.map(
+        // 					(d) =>
+        // 						new Invoice(
+        // 							{ ...d.data, id: d.id } as IInvoice,
+        // 							DatabaseService.asCollectionObject(this._space_ref.path, this._space_ref.id + '/invoices'),
+        // 							this._user
+        // 						)
+        // 				)
+        // 		)
+        // 		allOrderTypes.push(
+        // 			ordersDocs
+        // 				.filter((d) => d.exists && !!d.data)
+        // 				.map(
+        // 					(d) =>
+        // 						new Order(
+        // 							{ ...d.data, id: d.id } as IOrder,
+        // 							DatabaseService.asCollectionObject(this._space_ref.path, this._space_ref.id + '/orders'),
+        // 							this._user
+        // 						)
+        // 				)
+        // 		)
+        // 		allOrderTypes.push(
+        // 			cartsDocs
+        // 				.filter((d) => d.exists && !!d.data)
+        // 				.map(
+        // 					(d) =>
+        // 						new Cart(
+        // 							{ ...d.data, id: d.id } as ICart,
+        // 							DatabaseService.asCollectionObject(this._space_ref.path, this._space_ref.id + '/carts'),
+        // 							this._user
+        // 						)
+        // 				)
+        // 		)
+        // 		if (!!!id) {
+        // 			return flatten(allOrderTypes)
+        // 		}
+        // 		return flatten(allOrderTypes).filter((orderType: any) => orderType.data().id === id)[0]
+        // 	} catch (err) {
+        // 		throw new Error(`Error while getting invoices: ${err}`)
+        // 	}
+        // }
+        //#endregion
+        //#region INVOICE
+        // public createEmptyInvoice = () =>
+        // 	new Invoice(getDefaultInvoice(), this._space_ref.collection('invoices'), this._user)
         this._getInvoices = async (options) => {
             try {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/invoices');
@@ -2480,6 +2717,8 @@ class Space {
             }
         };
         this._getUnknownCartItem = (cartItem, product, orderImport) => {
+            // METTRE LE TABLEAU DE LANGUES DU SPACE DYNAMIQUE
+            // *** type cause problème présement....
             return Object.assign(Object.assign({}, cartItem), { sku: 'UNK-000000-00000', slug: 'unknown', parent_product_id: product.split('*')[0], name: (0, locale_1.getLanguageDictFromString)('unknown', ['fr', 'en']), description: (0, locale_1.getLanguageDictFromString)("Produit venant de l'ancien site", ['fr', 'en']), regular_price: {
                     currency: orderImport.currency,
                     amount: Number(product.split('*')[2])
@@ -2489,6 +2728,7 @@ class Space {
             let allCarts = [];
             const fileData = fileImport.data;
             allCarts = await Promise.all(fileData.map(async (orderImport) => {
+                // 1. Get customer
                 const customerQuery = await this.customers.get({
                     query: [{ field: 'id', operator: '==', value: orderImport.customer_id }]
                 });
@@ -2496,6 +2736,7 @@ class Space {
                 if (!!customerQuery && !!customerQuery.length) {
                     customer = customerQuery[0].data();
                 }
+                // 2. Get products
                 const orderImportProducts = orderImport.products.split(';');
                 const cartItems = [];
                 if (!!orderImportProducts && !!orderImportProducts.length) {
@@ -2541,7 +2782,9 @@ class Space {
                                         .reduce((map, obj) => {
                                         map[obj.key] = obj.value;
                                         return map;
-                                    }, {}), description: closestDeclination.description, images_path: closestDeclination.image_files, tax_family_id: 'QC', parent_product_id: !!parentProduct.id ? parentProduct.id : '', shipping_info: closestDeclination.shipping_info, regular_price: {
+                                    }, {}), description: closestDeclination.description, images_path: closestDeclination.image_files, tax_family_id: 'QC', parent_product_id: !!parentProduct.id ? parentProduct.id : '', shipping_info: closestDeclination.shipping_info, 
+                                    // stock_level: closestDeclination.stock_level,
+                                    regular_price: {
                                         currency: orderImport.currency,
                                         amount: Number(product.split('*')[2])
                                     }, discount_price: null, promo_price: null, qte: Number(product.split('*')[1]), parent_slug: parentProduct.slug });
@@ -2550,6 +2793,7 @@ class Space {
                         cartItems.push(cartItem);
                     }
                 }
+                // 3. Construct cart
                 let cart = (0, Cart_1.getDefaultCart)();
                 cart = Object.assign(Object.assign({}, cart), { customer_id: !!customer ? customer.id : 'unknown', customer_info: !!customer
                         ? {
@@ -2635,10 +2879,19 @@ class Space {
             }));
             return allCarts.filter((cart) => !!cart);
         };
+        /**
+         * Generate the next unique ID for a customers new promise to purchase. Recursive function : always checks if ID exists in database before returning ID.
+         * @param customerId - The customer for whom we're creating a new promise
+         * @param useNextSeason - If we should check the values for next season instead of current one
+         * @param idToIncrement - Optionnal. Only set when calling the function recursively.
+         */
         this._generateNewPromiseId = async (customerId, useNextSeason, idToIncrement) => {
             const yearToUse = useNextSeason ? (0, moment_1.default)().add(1, 'year').format('YY') : (0, moment_1.default)().format('YY');
             let existingPAs;
             try {
+                // NOTE - Pour firebase, si le champ est une string, le [ > et >= ] ou [ < et <= ] veullent dire "commence par" et "termine par", respectivement.
+                //        Par contre, la vérification continue de foncitonner comme si c'était des number. Il faut donc même une close >= ET < ici pour pas que le code retourne
+                //        celles de l'année en cours ET des années prochaines aussi!!
                 existingPAs = await this.promisesToPurchase.get({
                     query: [
                         { field: 'customer_id', operator: '==', value: customerId },
@@ -2683,6 +2936,7 @@ class Space {
                 throw new Error('invoice data not set in space');
             }
             let newInvoiceRef = '';
+            // if should be same as cart ref
             if (!!invoiceData.inherit_order_number && !!cartData.ref) {
                 try {
                     await this.save({
@@ -2695,9 +2949,12 @@ class Space {
                 }
             }
             else {
+                // invoice ref by store variables
                 let wasPaidAtStore = false;
                 let storeToUse;
                 if (!!cartData.current_store_id) {
+                    // Get store where payment was taken (invoice should be associated to that store)
+                    // If not found, use current_store_id (which should be store where order was processed)
                     const createdAtStore = (0, object_1.recursiveCheckObject)(cartData, 'created_by.at_store_id');
                     const processedAtStore = (0, object_1.recursiveCheckObject)(cartData, 'processed_by.at_store_id');
                     const paidAtStore = !!(0, object_1.recursiveCheckObject)(cartData, 'created_by.took_payment')
@@ -2732,7 +2989,7 @@ class Space {
                     catch (e) {
                         console.log('Error fetching invoice number', e);
                     }
-                    await (0, tools_1.waitFor)(1000);
+                    await (0, tools_1.waitFor)(1000); // whait a second before trying again, server need to recover
                     triesLeft--;
                 }
                 if (triesLeft == 0)
@@ -2744,6 +3001,7 @@ class Space {
             if (!!!invoiceData) {
                 throw new Error('invoice data not set in space');
             }
+            // get min invoice ref number length
             const newInvoiceRef = this._constructNewRefForInvoice(invoiceData);
             try {
                 await this.save({
@@ -2842,6 +3100,8 @@ class Space {
                 return;
             }
         };
+        //#endregion
+        //#region ORDERS
         this._getOrders = async (options) => {
             try {
                 let call = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/orders');
@@ -2873,6 +3133,8 @@ class Space {
                 return '';
             }
         };
+        //#endregion
+        //#region CUSTOMERS
         this._customersListener = (callback, _options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -3172,6 +3434,11 @@ class Space {
                 throw error;
             }
         };
+        /**
+         * Fetches and returns all promises to purchase associated with a customer ID.
+         * @param customerID - The customer ID to check
+         * @param onlyActive - Optionnal. If true, function only returns currently active promises
+         */
         this._getCustomerPromisesToPurchase = async (customerID, onlyActive) => {
             try {
                 const customerPromisesToPurchase = await this.promisesToPurchase.get({
@@ -3179,9 +3446,11 @@ class Space {
                 });
                 if (!!!customerPromisesToPurchase)
                     throw new Error(`Error while getting promises to purchase for customer: ${customerID}`);
+                // If onlyActive is false, return all found promises to purchase
                 if (!!!onlyActive) {
                     return customerPromisesToPurchase;
                 }
+                // Filter to keep only active promises
                 const allActive = customerPromisesToPurchase.filter((promise) => !!(0, promiseToPurchase_1.isPromiseActive)(promise.data()));
                 return allActive;
             }
@@ -3189,6 +3458,11 @@ class Space {
                 throw new Error(`Error while getting PAs: ${err}`);
             }
         };
+        /**
+         * For all possible bank types for space, checks all active promises for customer and returns an object containing currently active bank applicable.
+         * @param customerID - The customer ID to check
+         * @param promisesToCheck - Optionnal. If defined, uses provided array of promises instead of calling DB.
+         */
         this._getPossibleActiveBanksForCustomer = async (customerID, promisesToCheck) => {
             try {
                 let promisesForCustomer = promisesToCheck;
@@ -3198,7 +3472,9 @@ class Space {
                 }
                 if (!!!promisesForCustomer)
                     return [];
+                // Order promises data by promise_unique_id
                 const promisesData = (0, promiseToPurchase_1.getOrderedPromises)(promisesForCustomer.map((p) => p.data()), 'promise_unique_id');
+                // Loop through all possible banks to find applicable options in active promises for customer
                 const possibleBanks = this.bankTypes.get(undefined, true);
                 return (0, promiseToPurchase_1.checkForApplicableBanks)(promisesData, possibleBanks);
             }
@@ -3225,10 +3501,26 @@ class Space {
                 console.log(`Could not set last_activity prop for customer: ${customerId}, ${e}`);
             }
         };
+        //#endregion
+        //#region INVENTORY
+        /**
+         * Function that adjusts store and / or web inventories for a cart depending on it's state
+         * @param items an array of ICartItem objects through which we will loop to adjust their inventories
+         * @param cartState the state of the cart for which we are adjusting the inventory, this affects what inventory actions will be made
+         * @param cartType type of the cart
+         * @param options.currentStoreId the store at which we are doing the inventory manipulation
+         * @param options.onlyWeb if the inventory should only be adjusted for WEB or also for the current store
+         * @param options.fromStoreId the store at which the inventories were initially modified, it is only used in the context of a refund, where we might return items to a different store than where they were taken.
+         * @param options.associatedTransferForCart Optionnal. Array of TransferRequest objects associated to order (used in 'cancelled' cart state)
+         * @param options.previousItems Optionnal. Array of ICartItem corresponding to prevState in cart
+         * @param options.inventoryItemsDataToUse Optionnal. Array of inventoryItem data to use instead of calling Db twice.
+         * @param options.shouldCheckReservedQte Optionnal. If reserved quantities should be check for inventory or not
+         */
         this._ajustInventoryWithCart = async (items, cartState, cartType, options = {}) => {
             var _c;
             if (!!!this._space.stores_warehouses.length)
                 return;
+            // Check for stores that either sell online, or offer immediate pickup. Will be used as "possible" stores for inventory ajustment
             const canShipStores = this._space.stores_warehouses.filter((store) => !store.no_inventory_for_store && (store.can_sell_online || store.allow_immediate_pickup));
             if (!!!canShipStores.length)
                 return;
@@ -3283,6 +3575,7 @@ class Space {
                             result = await inventoryObj.handleProductSold(options.currentStoreId, inventoryToRemove, cartType, cartType !== Cart_1.CartTypeEnum.POS_TRANSACTIONNAL);
                         }
                         else if (cartState === 'cancelled' || cartState === 'refunded') {
+                            //TODO Add logic for item should be deleted on cancel inventory
                             result = await inventoryObj.handleOrderCancelled(options.currentStoreId, (_c = options.fromStoreId) !== null && _c !== void 0 ? _c : options.currentStoreId, inventoryToRemove, cartState, cartType, {
                                 deleteItem: false,
                                 onlyWeb: options.onlyWeb,
@@ -3324,6 +3617,8 @@ class Space {
             const spaceOptions = this.options.get();
             return !!(0, object_1.recursiveCheckObject)(spaceOptions, 'inventory.minimum_inventory_per_sku');
         };
+        //#endregion
+        //#region TAGS
         this._addTag = async (declination, product, category_slug, inventory, currentStoreId, maxQte, isOtherCategory) => {
             try {
                 if (!!!declination)
@@ -3384,7 +3679,9 @@ class Space {
                             const _d = d;
                             if (!!_d.upc)
                                 continue;
+                            // Fetch last UPC that can be use
                             const lastUpc = this.data().product_preferences.barcode_next || '0';
+                            // Assign the last UPC to the declination
                             await productObj.save({
                                 declinations: (_p.declinations || []).map((__d) => {
                                     if (__d.sku !== _d.sku)
@@ -3392,10 +3689,13 @@ class Space {
                                     return Object.assign(Object.assign({}, __d), { upc: lastUpc });
                                 })
                             });
+                            // Check if we should change current declination UPC
                             if (declination.sku === _d.sku) {
                                 declination = Object.assign(Object.assign({}, declination), { upc: lastUpc });
                             }
+                            // Increment the UPC
                             const newUpc = parseInt(lastUpc) + 1;
+                            // Save it to the Space
                             await this.save({
                                 product_preferences: Object.assign(Object.assign({}, this.data().product_preferences), { barcode_next: newUpc.toString() })
                             });
@@ -3414,6 +3714,7 @@ class Space {
             catch (error) {
                 console.log(error);
                 throw error;
+                // return
             }
         };
         this._getAllTags = async (options) => {
@@ -3440,6 +3741,12 @@ class Space {
                 throw error;
             }
         };
+        //#endregion
+        //#region USERS
+        /**
+         * Fetches user from database by unique ID.
+         * @param uid - The users unique ID (same as the email)
+         */
         this._getUser = async (uid) => {
             if (this._space_ref === undefined)
                 throw new Error(`Space ref is undefined`);
@@ -3447,6 +3754,11 @@ class Space {
                 throw new Error(`User ID must be defined and not empty. Value received: ${uid}`);
             return await User_1.default.FetchUser({ email: uid });
         };
+        /**
+         * Fetches user from database by external ID
+         * @param externalID - The user's external ID
+         * @param userEmail - The user's email
+         */
         this._getUserByExternalID = async (externalID) => {
             if (this._space_ref === undefined)
                 throw new Error(`Space ref is undefined`);
@@ -3540,7 +3852,11 @@ class Space {
             const orgRef = DatabaseService_1.default.getPathParent(this._space_ref.path);
             if (!!!orgRef)
                 throw new Error(`Can't access org ref`);
+            // --------------------------------------------------------------------
+            // STEP 1 - Delete user from Users collection in Org
             try {
+                // Since not all users have props id set in document,
+                // fetch using FB doc id instead
                 const userDoc = await DatabaseService_1.default.getDocument(DatabaseService_1.default.addToPath(orgRef, 'users'), userId);
                 if (!!!userDoc || !!!userDoc.exists)
                     throw new Error(`Can't retreive user with ID ${userId}`);
@@ -3553,6 +3869,8 @@ class Space {
                 console.log('---- in catch for STEP 1 ----');
                 throw error;
             }
+            // --------------------------------------------------------------------
+            // STEP 2 - Delete user relation to org in collection rel_orgs_users
             try {
                 if (!!!DatabaseService_1.default.getPathParent(DatabaseService_1.default.getPathParent(orgRef)))
                     throw new Error(`can't access base DB to delete relation to org of user. Please check manually in Firestore`);
@@ -3577,6 +3895,8 @@ class Space {
                 console.log('---- in catch for STEP 2 ----');
                 throw error;
             }
+            // --------------------------------------------------------------------
+            // STEP 3 - Delete user from FirebaseAuth
             if (!!!credentials)
                 throw new Error(`Admin Firebase must be passed`);
             try {
@@ -3593,6 +3913,8 @@ class Space {
                 throw error;
             }
         };
+        //#endregion
+        //#region UTILS
         this.translateToDefault = (dict) => {
             if (!!!dict.length)
                 return '';
@@ -3671,6 +3993,8 @@ class Space {
                 return false;
             }
         };
+        //#endregion
+        //#region BOOKINGS
         this._getBookings = async (options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -3730,6 +4054,8 @@ class Space {
                 return { saved: false, booking: undefined };
             }
         };
+        //#endregion
+        //#region G2 CALLS (GR ONLY)
         this._updateG2Calls = async (optionsToUpdate) => {
             try {
                 await this.save({
@@ -3742,6 +4068,8 @@ class Space {
                 return false;
             }
         };
+        //#endregion
+        //#region GETTERS
         this.publicToken = () => {
             if (!!!DatabaseService_1.default.getPathParent(this._space_ref.path + this._space_ref.id))
                 return '';
@@ -3811,6 +4139,9 @@ class Space {
             const storageSettings = this.preferences.storage.getServiceConfig();
             return { name: storageService, config: storageSettings };
         };
+        // #endregion
+        // -------------------------------------------------------------------------------
+        // #region UPDATES
         this._getUpdateByObjectID = async (objectID) => {
             const query = await DatabaseService_1.default.getDocuments(DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/updates'), { query: [{ field: 'object_id', operator: '==', value: objectID }] });
             if (!!!query || !!!query.length)
@@ -3823,6 +4154,9 @@ class Space {
                 return;
             return query.map((doc) => doc.data);
         };
+        // #endregion
+        // -------------------------------------------------------------------------------
+        // #region BANK TYPES
         this._getBankTypes = (id, returnInactive) => {
             const allBankTypes = this.data().bank_types || [];
             if (!!id) {
@@ -3892,6 +4226,13 @@ class Space {
             const onlyMostRecent = (0, promiseToPurchase_1.getMostRecentVersionOfRules)(typeToCheck);
             return onlyMostRecent;
         };
+        // #endregion
+        // -------------------------------------------------------------------------------
+        // #region PROMISES TO PURCHASE
+        /**
+         * Synchronizes the customers with the list of promise to purchase.
+         * @param associations - Record dont la clé est l'id d'un customer et la valeur est un record de promesses d'achats avec leur id et leurs infos
+         */
         this._syncCustomerPromiseToPurchaseAssoc = async (associations) => {
             const prospr = new prosprsearch_1.ProsprSearch({
                 app: this.preferences.prosprsearch.app(),
@@ -3959,6 +4300,9 @@ class Space {
             }
             return sync.every((r) => !!r);
         };
+        /**
+         * Retrieves and returns only the customers who have a PA.
+         */
         this._getAllWithActivePromises = async () => {
             const prosprResult = await PromiseToPurchase_1.default.fetch({
                 app: this.preferences.prosprsearch.app(),
@@ -3969,7 +4313,7 @@ class Space {
                 space: this,
                 filters: '',
                 f: `(has_active_promise:true)`,
-                hpp: 100000
+                hpp: 100000 // gimme gimme
             });
             const { customers, error } = await (async () => {
                 try {
@@ -4001,6 +4345,10 @@ class Space {
                 return;
             }
         };
+        /**
+         * Checks for currently active banks, and returns their available amount, as well as the ones for all previous PAs with same bank type.
+         * @param customerID
+         */
         this._getAvailableBankAmountsByBankType = async (customerID, filterToApply = 'active-and-before') => {
             var _c;
             try {
@@ -4013,6 +4361,8 @@ class Space {
                 });
                 if (!!!historyForCustomer)
                     throw new Error('Error on fetching history for customer');
+                // Get currently active banks in PAs
+                // We will use info to check if PA should be considered in history shown
                 let currentlyActiveBanksInPAs = [];
                 let allCustomerBanks = [];
                 for (let pa of (0, orderBy_1.default)(allCustomerPAsData, (pa) => (0, toNumber_1.default)(pa.promise_unique_id), 'desc')) {
@@ -4024,16 +4374,22 @@ class Space {
                             currentlyActiveBanksInPAs.push({ bankID: bank.bank_type_id, promiseUniqueID: pa.promise_unique_id });
                     }
                 }
+                // ** TODO - Check what to do if history array is empty for customer?
+                // **        should we only return values for currently active banks?
+                // Group history entries by promise_id
                 let orderedHistoryById = (0, groupBy_1.default)(historyForCustomer, 'promise_id');
+                // Save remaining amounts by grouping them by bank_type
                 let orderedByBankType = {};
                 for (const bank of allCustomerBanks) {
                     const bankInfo = bank.data;
                     const currentActivePaForBank = currentlyActiveBanksInPAs.find((b) => b.bankID === bankInfo.bank_type_id);
                     if (!!currentActivePaForBank) {
                         const mostRecentlyEmptiedBankOfType = (0, promiseToPurchase_1.getLatestEmptiedBankOfType)(allCustomerPAsData, bankInfo.bank_type_id, currentActivePaForBank.promiseUniqueID);
+                        // Set cutoff id to check for filterToApply
                         let cutoffPromiseUniqueID = (0, toNumber_1.default)(currentActivePaForBank.promiseUniqueID);
                         if (!!mostRecentlyEmptiedBankOfType && filterToApply === 'last-emptied-active-and-after')
                             cutoffPromiseUniqueID = mostRecentlyEmptiedBankOfType.promise_unique_id;
+                        // Ignore all entries that do not correspond
                         if (['active-and-before'].includes(filterToApply) && (0, toNumber_1.default)(bank.promiseUniqueID) > cutoffPromiseUniqueID)
                             continue;
                         if (['active-and-after', 'last-emptied-active-and-after'].includes(filterToApply) &&
@@ -4053,6 +4409,7 @@ class Space {
                         Object.assign({ promise_id: (_c = bank.promiseId) !== null && _c !== void 0 ? _c : '', promise_unique_id: bank.promiseUniqueID, bank_type_id: bankInfo.bank_type_id }, amounts)
                     ];
                 }
+                // Order values by promise_unique_id (from most recent to oldest)
                 for (let [bankID, values] of Object.entries(orderedByBankType)) {
                     orderedByBankType[bankID] = (0, orderBy_1.default)(values, (v) => (0, toNumber_1.default)(v.promise_unique_id), 'desc');
                 }
@@ -4152,9 +4509,11 @@ class Space {
         this._closeSeasonPromisesToPurchase = async (yearToClose, userClosingID) => {
             const currentClosed = this.promisesToPurchase.getPromiseSeasons('closed');
             const yearAlreadyClosed = currentClosed.find((c) => c.season_year === yearToClose);
+            // Si l'année est déjà fermée, return
             if (!!yearAlreadyClosed)
                 return false;
             const currentValues = this.data().promise_to_purchase_seasons;
+            // Si il n'y a aucune saison dans la space, on ne peut pas la fermer
             if (!!!currentValues)
                 return false;
             currentValues[yearToClose.toString()] = Object.assign(Object.assign({}, currentValues[yearToClose.toString()]), { closed: {
@@ -4181,6 +4540,7 @@ class Space {
             const currentValues = this.data().promise_to_purchase_seasons;
             let newRecord = {};
             if (!!!currentValues) {
+                // If there are no current seasons saved, create a new record and populate it with the new season to open
                 newRecord[yearToOpen.toString()] = {
                     opened: {
                         date: new Date(),
@@ -4215,9 +4575,11 @@ class Space {
         this._endSeasonPromisesToPurchase = async (yearToEnd, userEndingId) => {
             const currentEnded = this.promisesToPurchase.getPromiseSeasons('ended');
             const yearAlreadyEnded = currentEnded.find((c) => c.season_year === yearToEnd);
+            // Si l'année est déjà terminée, return
             if (!!yearAlreadyEnded)
                 return false;
             const currentValues = this.data().promise_to_purchase_seasons;
+            // Si il n'y a aucune saison dans la space, on ne peut pas en end
             if (!!!currentValues)
                 return false;
             currentValues[yearToEnd.toString()] = Object.assign(Object.assign({}, currentValues[yearToEnd.toString()]), { ended: {
@@ -4241,6 +4603,11 @@ class Space {
             });
             return escompteSuppProduct;
         };
+        /**
+         * Retrieves and returns all the carts containing a specific promise ID.
+         * @param promiseID - The ID to check
+         * @param options - Optionnal. Additionnal query options
+         */
         this._getPromiseAssociatedCarts = async (promiseID, options) => {
             const carts = await this.carts.get(Object.assign({ query: [
                     {
@@ -4249,9 +4616,11 @@ class Space {
                         value: promiseID
                     }
                 ] }, (!!options ? options : {})));
+            // Only return paid carts
             return carts.filter((f) => !!f.data().paid_at && f.data().status >= Cart_1.CartStatusEnum.CHECKOUT_PAYMENT_SUCCESS);
         };
         this._getBanksUsedHistory = async (filterOptions, searchOptions) => {
+            // Construct filters
             let filtersToSet = [];
             if (!!filterOptions.customerID) {
                 filtersToSet.push(`customer_id:${filterOptions.customerID}`);
@@ -4269,6 +4638,7 @@ class Space {
                 filtersToSet.push(`date:${filterOptions.unixDateRange.start} TO ${filterOptions.unixDateRange.end}`);
             }
             const filters = !!filtersToSet.length ? filtersToSet.join(' AND ') : '';
+            // Fetch history
             try {
                 const basicSearchInfo = (0, searchIndexes_1.getFetchInfoAlgoliaAddioSearch)(this);
                 const results = await PromiseToPurchase_1.default.fetchHistory(Object.assign(Object.assign(Object.assign({}, basicSearchInfo), (!!filters ? { f: filters } : {})), (searchOptions || {})));
@@ -4282,6 +4652,7 @@ class Space {
             }
         };
         this._getAvailableBankAmountForApplicableBanks = (applicableBanks, applicableBanksHistory) => {
+            // No need to query promises here, since initialAmount can be found in applicableBank.bank!
             let remainingAmounts = {};
             for (let applicable of applicableBanks) {
                 const { bank, promise_id } = applicable;
@@ -4300,6 +4671,11 @@ class Space {
             }
             return remainingAmounts;
         };
+        /**
+         * Returns all available amounts for banks found in specific promise.
+         * @param promiseID The ID of the promise to check
+         * @param promiseObj Optionnal. If provided, saves a call to the DB.
+         */
         this._getAvailableBankAmountsForPromise = async (promiseID, promiseObj) => {
             try {
                 let promiseToCheck = promiseObj;
@@ -4344,6 +4720,12 @@ class Space {
                 return;
             }
         };
+        /**
+         * Returns remaining amount and other info for a specific bank of a specific PA.
+         * @param promiseID - The promise to purchase ID
+         * @param bankID - The bank type ID
+         * @param promiseObj - Optionnal. If provided, removes one fetch from database
+         */
         this._getSpecificAvailableBankAmount = async (promiseID, bankID, promiseObj) => {
             try {
                 let promiseToCheck = promiseObj;
@@ -4378,6 +4760,9 @@ class Space {
                 return;
             }
         };
+        // #endregion
+        // -------------------------------------------------------------------------------
+        // #region JOBS
         this._getJobs = async (options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -4395,6 +4780,30 @@ class Space {
                 throw 'Invalid or unauthenticated user';
             if (this._user === undefined)
                 throw 'Invalid or unauthenticated user';
+            // TODO- modify to use DatabaseService.getDocumentsListener
+            // try {
+            // 	let call = DatabaseService.addToPath(this._space_ref.path, this._space_ref.id + '/bg_jobs')
+            // 	if (!!options) {
+            // 		call = constructFirebaseCallWithOptions(call, options)
+            // 	}
+            // 	return call.withConverter(BgJobConverter).onSnapshot((dataSnap) => {
+            // 		if (dataSnap.empty) callback([])
+            // 		workingMessage(`Jobs list has been udpated. Refreshing...`)
+            // 		callback(
+            // 			dataSnap.docs.map(
+            // 				(jobDoc) =>
+            // 					new BGJob(
+            // 						{ ...jobDoc.data(), id: jobDoc.id } as IBGJob,
+            // 						DatabaseService.asCollectionObject(this._space_ref.path, this._space_ref.id + '/bg_jobs'),
+            // 						this._user
+            // 					)
+            // 			)
+            // 		)
+            // 	})
+            // } catch (error) {
+            // 	errorMessage(JSON.stringify(error))
+            // 	callback([])
+            // }
             return '';
         };
         this._startJob = async (jobToStart) => {
@@ -4430,6 +4839,9 @@ class Space {
                 (0, console_1.errorMessage)(JSON.stringify(error));
             }
         };
+        //#endregion
+        // -------------------------------------------------------------------------------
+        // #region SLIDERS
         this._getSliders = async (options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -4442,6 +4854,9 @@ class Space {
             }
             catch (error) { }
         };
+        //#endregion
+        // -------------------------------------------------------------------------------
+        // #region FIRST ORDER TRACKING
         this._getFirstOrders = async (options) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -4454,6 +4869,9 @@ class Space {
             }
             catch (error) { }
         };
+        //#endregion
+        // -------------------------------------------------------------------------------
+        // #region DOCUMENTS
         this._getAllDocuments = async (specificPath) => {
             if (!!!this._user)
                 throw 'Invalid or unauthenticated user';
@@ -4505,6 +4923,18 @@ class Space {
                 console.log('Error while updating document in firebase bucket: ', e);
             }
         };
+        //#endregion
+        // -------------------------------------------------------------------------------
+        // #region STORE CREDITS
+        /**
+         * Apply a credit change, the value is negative for a purchasse
+         * @param customerId The id of the customer
+         * @param creditSlug The credit *slug name as configured in the space
+         * @param amount The amount to add or remove
+         * @param comment The reason for this change
+         * @param user The user doing the action
+         * @returns
+         */
         this._modifyStoreCredit = async (customerId, creditSlug, amount, comment, user) => {
             if (!customerId)
                 throw new Error('Customer ID is required');
@@ -4515,15 +4945,18 @@ class Space {
             if (!user)
                 throw new Error('The user doing the action is required');
             if (amount == 0)
-                return true;
+                return true; // do nothing if amount is 0
             const customerPath = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/customers');
             const historyPath = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/store_credit_history');
+            // fetch the user document
             const customer = await DatabaseService_1.default.getDocument(customerPath, customerId);
             if (!customer.exists)
                 new Error('Could not find customer');
+            // add the amount
             const credits = customer.data.store_credits || [];
             const index = credits.findIndex((x) => x.credit_slug == creditSlug);
             if (index == -1) {
+                // first time, add a new entry
                 credits.push({
                     amount: amount,
                     credit_slug: creditSlug
@@ -4532,6 +4965,7 @@ class Space {
             else {
                 credits[index] = Object.assign(Object.assign({}, credits[index]), { amount: credits[index].amount + amount });
             }
+            // create history
             const history = {
                 amount: amount,
                 comment: comment,
@@ -4543,16 +4977,24 @@ class Space {
             const newDoc = await DatabaseService_1.default.addDocument(historyPath, history);
             if (!newDoc)
                 throw new Error('Unable to create the credit history');
+            // save the new amount
             if (!(await DatabaseService_1.default.saveDocument(customerPath, customerId, 0, { store_credits: credits }, { merge: true })))
                 throw new Error('Unable to save new credit value');
             return true;
         };
+        /**
+         * Get the latess credit amount for a customer
+         * @param customerId The customer ID
+         * @param creditSlug The slug of the credit to get
+         * @returns The amount
+         */
         this._getStoreCredit = async (customerId, creditSlug) => {
             if (!customerId)
                 throw new Error('Customer ID is required');
             if (!creditSlug)
                 throw new Error('The credit slug is required');
             const customerPath = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/customers');
+            // fetch the user document
             const customer = await DatabaseService_1.default.getDocument(customerPath, customerId);
             if (!customer.exists)
                 new Error('Could not find customer');
@@ -4561,6 +5003,12 @@ class Space {
                 return 0;
             return credit.amount;
         };
+        /**
+         * Get the full history of credit for a customer
+         * @param customerId The customer ID
+         * @param creditSlug The slug of the credit to get
+         * @returns A list of IStoreCreditHistory
+         */
         this._getStoreCreditHistory = async (customerId, creditSlug) => {
             if (!customerId)
                 throw new Error('Customer ID is required');
@@ -4577,6 +5025,13 @@ class Space {
             });
             return histories.map((x) => x.data);
         };
+        /**
+         * Validate if an amount can be deducted from the credit of a customer
+         * @param customerId The customer ID
+         * @param creditSlug The credit slug to verify
+         * @param amount The amount to deduct
+         * @returns True if the amount is less or equal to the customer credit
+         */
         this._validateCredit = async (customerId, creditSlug, amount) => {
             if (!customerId)
                 throw new Error('Customer ID is required');
@@ -4587,9 +5042,13 @@ class Space {
             const current = await this._getStoreCredit(customerId, creditSlug);
             return amount <= current;
         };
+        /**
+         * Get the space available credits
+         */
         this._getSpaceCredits = () => {
             const credits = [...(this._space.store_credits || [])];
             if (!credits.some((x) => x.credit_slug == 'default')) {
+                // add the default one if not present
                 credits.push({
                     credit_slug: 'default',
                     name: [
@@ -4600,6 +5059,11 @@ class Space {
             }
             return credits;
         };
+        //#
+        //#region MENUS
+        /**
+         * Retourne tous les menus du space
+         */
         this._getMenus = async (options) => {
             if (!this._user)
                 throw new Error('Invalid or unauthenticated user');
@@ -4623,6 +5087,9 @@ class Space {
                 return [];
             }
         };
+        /**
+         * Retourne le menu actif pour un slug
+         */
         this._getActiveMenuBySlug = async (slug) => {
             if (!slug)
                 return undefined;
@@ -4635,12 +5102,16 @@ class Space {
             });
             return results.length ? results[0] : undefined;
         };
+        /**
+         * Retourne tous les menus actifs
+         */
         this._getAllActiveMenus = async () => {
             const results = await this._getMenus({
                 query: [{ field: 'active', operator: '==', value: true }]
             });
             return results;
         };
+        //#endregion
         this.attributes = {
             get: this._getAttributes,
             add: this._addAttribute,
@@ -4685,6 +5156,10 @@ class Space {
             getPage: this._getProductsPage,
             getAll: this._getAllProducts,
             listener: this._productsListener,
+            // Automatic declinations
+            // generate: {
+            // 	declinations: this._generateProductDeclinations
+            // },
             batch: {
                 create: this._batchProductsCreate,
                 set: this._batchProductsSet
@@ -5019,8 +5494,17 @@ class Space {
                 return await this._getAllActiveMenus();
             }
         };
+        /**
+         * Get all space properties
+         */
         this.data = () => this._space;
+        /**
+         * Get the space name
+         */
         this.getName = () => this._space.name;
+        /**
+         * Get the space ID
+         */
         this.getId = () => {
             if (!!!this._space.id) {
                 throw 'Id not yet set';
@@ -5030,6 +5514,8 @@ class Space {
         this.isMultiPromo = () => {
             return !!this._space.multipromo_aware ? this._space.multipromo_aware : false;
         };
+        //#endregion
+        //#region NOTES
         this._getNotes = async (parentId, type) => {
             try {
                 const path = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/notes');
@@ -5069,6 +5555,7 @@ class Space {
             add: this._addNote,
             delete: this._deleteNote
         };
+        // Console.log if space ref has less or more path elements than expected
         const lengthToCheck = space_ref.path.startsWith('/') ? 6 : 5;
         if (space_ref.path.split('/').length != lengthToCheck) {
             try {
@@ -5089,13 +5576,15 @@ class Space {
         if (!options)
             return undefined;
         if (options.id)
-            return options.id;
+            return options.id; // request a specific id
         if (options.query && options.query.length == 1 && options.query[0].operator == '==') {
             if (options.query[0].field == 'id' || options.query[0].field == 'slug')
                 return options.query[0].value;
         }
         return undefined;
     }
+    //#endregion
+    //#region INDEXED PRODUCTS
     async _getIndexedProductFromProduct(product) {
         const categories = product.category ? await this.categories.get({ id: product.category }) : undefined;
         const brands = product.brand ? await this.brands.get({ id: product.brand }) : undefined;