addio-admin-sdk 1.7.143 → 1.7.144

package/dist/utils/inventories.d.ts

@@ -1,101 +1,101 @@
-/// <reference types="lodash" />
-import IAttribute from '../Interfaces/Attribute';
-import { ICartItem, IIndexedDeclination } from '../Interfaces/Cart';
-import ICategory from '../Interfaces/Category';
-import { IFilledDimensionUnits } from '../Interfaces/Declination';
-import IInventoryItem, { IInventoryByStore, IInventoryQuantities } from '../Interfaces/Product/IInventoryItem';
-import ILang from './string';
-import IIndexedProduct, { IIndexedDeclinationWithCategories } from '../Interfaces/Indexed/Product';
-import IStore from '../Interfaces/Store';
-import ISpace from '../Interfaces/Space';
-export declare const checkWebInventoryForType: (inventories: IInventoryByStore[], currentWebInventory: IInventoryQuantities | undefined, type: 'available' | 'processing' | 'in_transit' | 'completed') => IInventoryQuantities | undefined;
-export declare const orderByBeton: string[];
-export declare const orderByAccessoires: string[];
-export declare const unitDict: any;
-export declare const unitShortDict: {
-    [key: string]: ILang;
-};
-/**
- * Returns the dictionnary containing the shortened version of unit labels in multiple languages
- * @param {string} slug The slug for which we want to get the shortened dictionnary
- * @param {string[]} returnUnitForSlugs An array of slugs that we want to return a default dictionnary for, in this case the unit dictionnary for unit
- * @returns {ILang} The dictionnary containing the shortened unit label in multiple languages
- */
-export declare const getUnitShortDict: (slug: string, returnUnitForSlugs?: string[]) => ILang;
-export declare const getAttributesToShow: (currentItems: IInventoryItem[] | IIndexedDeclination[]) => string[];
-export declare const getAttrStringForItem: (inventoryItem: IInventoryItem | IIndexedDeclination, attributesToShow: string[], attributes: IAttribute[], locale?: string) => string;
-export declare const getGroupedByBetonProducts: (arrBeton: IIndexedDeclinationWithCategories[], categories: ICategory[]) => import("lodash").Dictionary<IIndexedDeclinationWithCategories[]>;
-/**
- * Convert a given quantity to either inventory of sale unit, using an item's unit array.
- * @param otherUnits The item's possible units array
- * @param qte The quantity to convert
- * @param convertTo The unit type for conversion.
- * @param roundResult Optionnal. If result should be rounded. Checks if unit supports decimals (if so, rounds to 2 decimals. Else, rounds to 0).
- */
-export declare const getConvertedUnitQuantity: (otherUnits: IFilledDimensionUnits[] | undefined, qte: number, convertTo: 'inventory_unit' | 'sale_unit', roundResult?: boolean) => number;
-export interface IGetQty {
-    value: number;
-    fitting_unit: number;
-    true_unit?: string;
-    is_inventory_unit?: boolean;
-}
-/**
- * Constructs object with detailled inventory quantities by unit (based on other_units for product)
- * @param otherUnits
- * @param inventoryQuantity
- * @param options.showNegativeInventory - Optionnal
- * @param options.unitSlugsToCheck - Optionnal. If provided, only checks for provided units.
- * @param options.log - Ooptionnal. If true, logs found data at each step to browser
- * @returns A key-value object where the key is the unit slug, and the value contains the calculated amount for unit, the fitting unit ratio, and if is the "smallest" unit, the true slug of the corresponding unit
- */
-export declare const getQty: (otherUnits: IFilledDimensionUnits[] | undefined, inventoryQuantity: number, unitSlugsToCheck: {
-    slug: string;
-    roundToOneQte: boolean;
-}[] | undefined, options?: {
-    showNegativeInventory?: boolean;
-    returnTrueUnitSlug?: boolean;
-    log?: boolean;
-}) => {
-    [key: string]: IGetQty | undefined;
-};
-export declare const convertQtyFromSellUnit: (allUnits: IFilledDimensionUnits[] | undefined, sellUnitQty: number, convertToUnitSlug: string) => number;
-/**
- * Returns the quantities available for a product based on the current store branch.
- *
- * @param {IInventoryItem} [inventory] - The inventoryItem to check
- * @param {string | null | undefined} [currentSucc] - The current store's slug
- * @param {IFilledDimensionUnits[] | undefined} [otherUnits] - The item's other_units
- * @param {IIndexedProduct | ICartItem} [product] - The item to check
- * @param {boolean} [roundQty] - Wether we want to round to qty string or not
- * @returns {{value: number|string, unit:string}} - The string representation of the available quantity or 'Non disponible' if there's no inventory available.
- */
-export declare const getAvailableSellUnitQuantity: (inventory: IInventoryItem, currentSucc: string | null | undefined, otherUnits: IFilledDimensionUnits[] | undefined, product: IIndexedProduct | ICartItem, roundQty?: boolean) => {
-    value: string;
-    unit: string;
-};
-/**
- * Returns true or false depending on if an item is unavailable for a specific store
- *
- * @param {number} [qte] - The quantity of the item to check in the store's inventory
- * @param {IIndexedProduct | ICartItem} [product] - The item
- * @param {IFilledDimensionUnits[] | undefined} [otherUnits] - The item's otherUnits
- * @param {IInventoryItem | undefined} [inventoryItem] - The inventoryItem for the store to check
- * @param {string | null} [storeId] - The id of the store to check
- * @returns {boolean} - True if the item is unavailable for that store, or false if it's available
- */
-export declare const checkIfItemIsUnavailableForStore: (qte: number, product: IIndexedProduct | ICartItem, otherUnits: IFilledDimensionUnits[] | undefined, inventoryItem: IInventoryItem | undefined, storeID?: string | null) => boolean;
-/**
- * Does the store have an inventory
- * @param store Store info
- * @returns True if the store has an inventory, false otherwise
- */
-export declare const checkIfStoreHasInventory: (store: IStore) => boolean;
-/**
- * Gets units to use in specific context for a specified space. Returns the condensed version with the unit's slug and if leftover unit quantities should be rounded to 1 in inventory calculatios
- * @param spaceData
- * @param context
- */
-export declare const getSpaceUnitsToUseForContext: (spaceData: ISpace, context: 'inventory' | 'transfers') => {
-    slug: string;
-    roundToOneQte: boolean;
-}[];
+/// <reference types="lodash" />
+import IAttribute from '../Interfaces/Attribute';
+import { ICartItem, IIndexedDeclination } from '../Interfaces/Cart';
+import ICategory from '../Interfaces/Category';
+import { IFilledDimensionUnits } from '../Interfaces/Declination';
+import IInventoryItem, { IInventoryByStore, IInventoryQuantities } from '../Interfaces/Product/IInventoryItem';
+import ILang from './string';
+import IIndexedProduct, { IIndexedDeclinationWithCategories } from '../Interfaces/Indexed/Product';
+import IStore from '../Interfaces/Store';
+import ISpace from '../Interfaces/Space';
+export declare const checkWebInventoryForType: (inventories: IInventoryByStore[], currentWebInventory: IInventoryQuantities | undefined, type: 'available' | 'processing' | 'in_transit' | 'completed') => IInventoryQuantities | undefined;
+export declare const orderByBeton: string[];
+export declare const orderByAccessoires: string[];
+export declare const unitDict: any;
+export declare const unitShortDict: {
+    [key: string]: ILang;
+};
+/**
+ * Returns the dictionnary containing the shortened version of unit labels in multiple languages
+ * @param {string} slug The slug for which we want to get the shortened dictionnary
+ * @param {string[]} returnUnitForSlugs An array of slugs that we want to return a default dictionnary for, in this case the unit dictionnary for unit
+ * @returns {ILang} The dictionnary containing the shortened unit label in multiple languages
+ */
+export declare const getUnitShortDict: (slug: string, returnUnitForSlugs?: string[]) => ILang;
+export declare const getAttributesToShow: (currentItems: IInventoryItem[] | IIndexedDeclination[]) => string[];
+export declare const getAttrStringForItem: (inventoryItem: IInventoryItem | IIndexedDeclination, attributesToShow: string[], attributes: IAttribute[], locale?: string) => string;
+export declare const getGroupedByBetonProducts: (arrBeton: IIndexedDeclinationWithCategories[], categories: ICategory[]) => import("lodash").Dictionary<IIndexedDeclinationWithCategories[]>;
+/**
+ * Convert a given quantity to either inventory of sale unit, using an item's unit array.
+ * @param otherUnits The item's possible units array
+ * @param qte The quantity to convert
+ * @param convertTo The unit type for conversion.
+ * @param roundResult Optionnal. If result should be rounded. Checks if unit supports decimals (if so, rounds to 2 decimals. Else, rounds to 0).
+ */
+export declare const getConvertedUnitQuantity: (otherUnits: IFilledDimensionUnits[] | undefined, qte: number, convertTo: 'inventory_unit' | 'sale_unit', roundResult?: boolean) => number;
+export interface IGetQty {
+    value: number;
+    fitting_unit: number;
+    true_unit?: string;
+    is_inventory_unit?: boolean;
+}
+/**
+ * Constructs object with detailled inventory quantities by unit (based on other_units for product)
+ * @param otherUnits
+ * @param inventoryQuantity
+ * @param options.showNegativeInventory - Optionnal
+ * @param options.unitSlugsToCheck - Optionnal. If provided, only checks for provided units.
+ * @param options.log - Ooptionnal. If true, logs found data at each step to browser
+ * @returns A key-value object where the key is the unit slug, and the value contains the calculated amount for unit, the fitting unit ratio, and if is the "smallest" unit, the true slug of the corresponding unit
+ */
+export declare const getQty: (otherUnits: IFilledDimensionUnits[] | undefined, inventoryQuantity: number, unitSlugsToCheck: {
+    slug: string;
+    roundToOneQte: boolean;
+}[] | undefined, options?: {
+    showNegativeInventory?: boolean;
+    returnTrueUnitSlug?: boolean;
+    log?: boolean;
+}) => {
+    [key: string]: IGetQty | undefined;
+};
+export declare const convertQtyFromSellUnit: (allUnits: IFilledDimensionUnits[] | undefined, sellUnitQty: number, convertToUnitSlug: string) => number;
+/**
+ * Returns the quantities available for a product based on the current store branch.
+ *
+ * @param {IInventoryItem} [inventory] - The inventoryItem to check
+ * @param {string | null | undefined} [currentSucc] - The current store's slug
+ * @param {IFilledDimensionUnits[] | undefined} [otherUnits] - The item's other_units
+ * @param {IIndexedProduct | ICartItem} [product] - The item to check
+ * @param {boolean} [roundQty] - Wether we want to round to qty string or not
+ * @returns {{value: number|string, unit:string}} - The string representation of the available quantity or 'Non disponible' if there's no inventory available.
+ */
+export declare const getAvailableSellUnitQuantity: (inventory: IInventoryItem, currentSucc: string | null | undefined, otherUnits: IFilledDimensionUnits[] | undefined, product: IIndexedProduct | ICartItem, roundQty?: boolean) => {
+    value: string;
+    unit: string;
+};
+/**
+ * Returns true or false depending on if an item is unavailable for a specific store
+ *
+ * @param {number} [qte] - The quantity of the item to check in the store's inventory
+ * @param {IIndexedProduct | ICartItem} [product] - The item
+ * @param {IFilledDimensionUnits[] | undefined} [otherUnits] - The item's otherUnits
+ * @param {IInventoryItem | undefined} [inventoryItem] - The inventoryItem for the store to check
+ * @param {string | null} [storeId] - The id of the store to check
+ * @returns {boolean} - True if the item is unavailable for that store, or false if it's available
+ */
+export declare const checkIfItemIsUnavailableForStore: (qte: number, product: IIndexedProduct | ICartItem, otherUnits: IFilledDimensionUnits[] | undefined, inventoryItem: IInventoryItem | undefined, storeID?: string | null) => boolean;
+/**
+ * Does the store have an inventory
+ * @param store Store info
+ * @returns True if the store has an inventory, false otherwise
+ */
+export declare const checkIfStoreHasInventory: (store: IStore) => boolean;
+/**
+ * Gets units to use in specific context for a specified space. Returns the condensed version with the unit's slug and if leftover unit quantities should be rounded to 1 in inventory calculatios
+ * @param spaceData
+ * @param context
+ */
+export declare const getSpaceUnitsToUseForContext: (spaceData: ISpace, context: 'inventory' | 'transfers') => {
+    slug: string;
+    roundToOneQte: boolean;
+}[];