addio-admin-sdk 1.7.102 → 1.7.104

package/dist/lib/Supplier/index.js

@@ -5,11 +5,14 @@ class Supplier extends baseService_1.BaseServiceClass {
     constructor() {
         super(...arguments);
         this.data = () => this._data;
+        //#region COMMANDS
         this._getCommands = async (_options) => { };
         this._addCommand = async (_command) => { };
         this._deleteCommand = async (_id) => { };
         this._approveCommand = async (_props) => { };
         this._rejectCommand = async (_props) => { };
+        //#endregion
+        //#region GETTER / SETTER
         this.commands = {
             get: this._getCommands,
             add: this._addCommand,
@@ -17,7 +20,9 @@ class Supplier extends baseService_1.BaseServiceClass {
             approve: this._approveCommand,
             reject: this._rejectCommand
         };
+        //#endregion
     }
 }
 exports.default = Supplier;
+//#endregion
 //# sourceMappingURL=index.js.map

package/dist/lib/Supplier/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/Supplier/index.ts"],"names":[],"mappings":";;AAGA,gDAAiD;AAEjD,MAAqB,QAAS,SAAQ,8BAA2B;IAAjE;;QACQ,SAAI,GAAG,GAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAA;QAIjC,iBAAY,GAAG,KAAK,EAAE,QAAwB,EAAE,EAAE,GAAE,CAAC,CAAA;QAErD,gBAAW,GAAG,KAAK,EAAE,QAA0B,EAAE,EAAE,GAAE,CAAC,CAAA;QAEtD,mBAAc,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE,GAAE,CAAC,CAAA;QAE1C,oBAAe,GAAG,KAAK,EAAE,MAA8B,EAAE,EAAE,GAAE,CAAC,CAAA;QAE9D,mBAAc,GAAG,KAAK,EAAE,MAA8B,EAAE,EAAE,GAAE,CAAC,CAAA;QAM9D,aAAQ,GAAG;YACjB,GAAG,EAAE,IAAI,CAAC,YAAY;YACtB,GAAG,EAAE,IAAI,CAAC,WAAW;YACrB,MAAM,EAAE,IAAI,CAAC,cAAc;YAC3B,OAAO,EAAE,IAAI,CAAC,eAAe;YAC7B,MAAM,EAAE,IAAI,CAAC,cAAc;SAC3B,CAAA;IAGF,CAAC;CAAA;AA5BD,2BA4BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/Supplier/index.ts"],"names":[],"mappings":";;AAGA,gDAAiD;AAEjD,MAAqB,QAAS,SAAQ,8BAA2B;IAAjE;;QACQ,SAAI,GAAG,GAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAA;QAEzC,kBAAkB;QAEV,iBAAY,GAAG,KAAK,EAAE,QAAwB,EAAE,EAAE,GAAE,CAAC,CAAA;QAErD,gBAAW,GAAG,KAAK,EAAE,QAA0B,EAAE,EAAE,GAAE,CAAC,CAAA;QAEtD,mBAAc,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE,GAAE,CAAC,CAAA;QAE1C,oBAAe,GAAG,KAAK,EAAE,MAA8B,EAAE,EAAE,GAAE,CAAC,CAAA;QAE9D,mBAAc,GAAG,KAAK,EAAE,MAA8B,EAAE,EAAE,GAAE,CAAC,CAAA;QAErE,YAAY;QAEZ,yBAAyB;QAElB,aAAQ,GAAG;YACjB,GAAG,EAAE,IAAI,CAAC,YAAY;YACtB,GAAG,EAAE,IAAI,CAAC,WAAW;YACrB,MAAM,EAAE,IAAI,CAAC,cAAc;YAC3B,OAAO,EAAE,IAAI,CAAC,eAAe;YAC7B,MAAM,EAAE,IAAI,CAAC,cAAc;SAC3B,CAAA;QAED,YAAY;IACb,CAAC;CAAA;AA5BD,2BA4BC;AAUD,YAAY"}

package/dist/lib/Tags/index.js

@@ -7,6 +7,11 @@ class Tag extends baseService_1.BaseServiceClass {
         this.data = () => {
             return this._data;
         };
+        // ---------------------------------------------------------------------
+        // Removes quantity of 1 for a tag
+        // If new quantity is 0, deletes tag
+        // @returns false if tag was deleted, and true if quantity was reduced
+        // ---------------------------------------------------------------------
         this.removeQte = async () => {
             const newQte = this.data().qte - 1;
             if (newQte <= 0) {

package/dist/lib/Tags/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/Tags/index.ts"],"names":[],"mappings":";;AACA,gDAAiD;AAEjD,MAAqB,GAAI,SAAQ,8BAAsB;IAAvD;;QACQ,SAAI,GAAG,GAAS,EAAE;YACxB,OAAO,IAAI,CAAC,KAAa,CAAA;QAC1B,CAAC,CAAA;QAOM,cAAS,GAAG,KAAK,IAAI,EAAE;YAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAA;YAClC,IAAI,MAAM,IAAI,CAAC,EAAE;gBAChB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;gBACnB,OAAO,KAAK,CAAA;aACZ;YAED,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;YACjD,OAAO,IAAI,CAAA;QACZ,CAAC,CAAA;IACF,CAAC;CAAA;AApBD,sBAoBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/Tags/index.ts"],"names":[],"mappings":";;AACA,gDAAiD;AAEjD,MAAqB,GAAI,SAAQ,8BAAsB;IAAvD;;QACQ,SAAI,GAAG,GAAS,EAAE;YACxB,OAAO,IAAI,CAAC,KAAa,CAAA;QAC1B,CAAC,CAAA;QAED,wEAAwE;QACxE,kCAAkC;QAClC,oCAAoC;QACpC,sEAAsE;QACtE,wEAAwE;QACjE,cAAS,GAAG,KAAK,IAAI,EAAE;YAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAA;YAClC,IAAI,MAAM,IAAI,CAAC,EAAE;gBAChB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;gBACnB,OAAO,KAAK,CAAA;aACZ;YAED,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;YACjD,OAAO,IAAI,CAAA;QACZ,CAAC,CAAA;IACF,CAAC;CAAA;AApBD,sBAoBC"}

package/dist/lib/TransferRequest/index.d.ts

@@ -28,22 +28,60 @@ export declare class TransferRequest extends BaseServiceClass<ITransferRequest>
     static checkIfTransferCanBeCancelled: (currentTransferStatus: TransferRequestStatusEnum, statusOrderObj: {
         [key: number]: TransferRequestStatusEnum[];
     }) => boolean;
+    /**
+     * Test if the transfer can be closed
+     * @returns true if the status allow to close the transfer
+     */
     checkIfTransferCanBeClosedManually: () => boolean;
+    /**
+     * Checks if provided status is included in "completed" transfer statuses list.
+     * @param statusToCheck
+     */
     static checkIfStatusCountsAsCompleted: (statusToCheck: TransferRequestStatusEnum) => boolean;
     static transferAllowAssignFromStore: (data: ITransferRequest) => boolean;
     transferAllowAssignFromStore: () => boolean;
     static transferAllowEditFromStore: (data: ITransferRequest) => boolean;
     transferAllowEditFromStore: () => boolean;
+    /**
+     * Test if the transfer allow adding products
+     * @param data the request data to verify
+     * @returns true if can add product
+     */
     static transferAllowAddProductOnEdit: (data: ITransferRequest) => boolean;
     transferAllowAddProductOnEdit: () => boolean;
+    /**
+     * Test if the transfer allow deleteing products
+     * @param data the request data to verify
+     * @returns true if can delete product
+     */
     static transferAllowProductDelete: (data: ITransferRequest) => boolean;
     transferAllowProductDelete: () => boolean;
+    /**
+     * Test if the transfer allow editing products
+     * @param data the request data to verify
+     * @returns true if can be edited
+     */
     static transferAllowEditProductOnEdit: (data: ITransferRequest) => boolean;
     transferAllowEditProductOnEdit: () => boolean;
+    /**
+     * 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
+     */
     static transferAllowDeleteProductOnEdit: (data: ITransferRequest) => boolean;
     transferAllowDeleteProductOnEdit: () => boolean;
+    /**
+     * Test if the transfer has reached a state where it should display weight
+     * @param data the request data to verify
+     * @returns {boolean}
+     */
     static transferShouldDisplayWeight: (data: ITransferRequest) => boolean;
     transferShouldDisplayWeight: () => boolean;
+    /**
+     * Test if the transfer allows products to be updated without a status change
+     * @param data the request data to verify
+     * @returns {boolean}
+     */
     static transferAllowsIndependantProductUpdate: (data: ITransferRequest) => boolean;
     transferAllowsIndependantProductUpdate: () => boolean;
     fetchAssociatedCart: () => Promise<Cart | undefined>;
@@ -56,28 +94,93 @@ export declare class TransferRequest extends BaseServiceClass<ITransferRequest>
     listen: (callback?: () => void) => boolean;
     private _getTransferRef;
     save: (partial: Partial<ITransferRequest>, saveToDatabase?: boolean, merge?: boolean) => Promise<string | boolean>;
+    /**
+     * Validate the quantities set before submit
+     * @param strictQty Tell if we should only allow equal quantity
+     * @returns
+     */
     validateBeforeSubmit: (strictQty?: boolean) => Promise<boolean>;
+    /**
+     * 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
+     */
     clearValidationQuantitiesFromProductData: (copyQte?: boolean) => void;
+    /**
+     * Add the validation quantities to the received amount
+     */
     addValidationQuantitiesToReceivedQuantities: () => void;
+    /**
+     * Return the previous quantity received for the provided sku
+     * @param sku the product sku to get
+     * @returns
+     */
     getPreviousReceivedQuantity: (sku: string) => number;
+    /**
+     * Return the original reuested quantity
+     * @param sku the product sku to get
+     * @returns
+     */
     getOriginalRequestedQuantity: (sku: string) => number;
+    /**
+     * 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
+     */
     getQuantityAtStatus: (sku: string, status: TransferRequestStatusEnum) => number;
     private getInventoryQuantitiesStillMissingForCartTransfer;
     private handleFreeTransitInventory;
     private handleChangeStoreInventory;
+    /**
+     * Update transfer's associated cart with new reserved quantities. Called when quantities received for transfer.
+     */
     private handleUpdateAssociatedCartReservedQuantities;
+    /**
+     * 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.
+     */
     constructProductObjFromUpdates: (updatesToDo: {
         sku: string;
         ajustmentQte: number;
     }[]) => ITransferProduct[];
+    /**
+     * 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
+     */
     saveUpdatesToContentOnly: (updatedContent: {
         products?: ITransferProduct[];
         fromStore?: string;
     }, options: SaveTransferOptionsType, cancelTransferIfAllProductsAtZero?: boolean, updateContext?: TransferRequestUpdateContextEnum) => Promise<ITransferRequest>;
+    /**
+     * Change or set the draft property value
+     * @param newVal The new value to assign
+     */
     setDraftValue: (newVal: boolean) => void;
+    /**
+     * Change or set the associated_order property value
+     * @param newVal The new value to assign
+     */
     setAssociatedOrder: (newVal: string | null) => void;
+    /**
+     * 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
+     */
     setTransportRef: (newVal: string, saveToDatabase?: boolean) => Promise<void>;
+    /**
+     * Set the original transfer id property value
+     * @param newVal The new value to assign
+     */
     setOriginalTransferId: (newVal: string | undefined) => Promise<void>;
+    /**
+     * Change the completed status to true and save to database
+     */
     setAsCompleted: (user: string, comment?: string) => Promise<void>;
     changeStatus: (newStatus: TransferRequestStatusEnum, comment: string | undefined, user: string, saveToDatabase?: boolean, options?: {
         setAsCompleted?: boolean;
@@ -85,20 +188,90 @@ export declare class TransferRequest extends BaseServiceClass<ITransferRequest>
         space?: Space | undefined;
         context?: TransferRequestUpdateContextEnum;
     }) => Promise<ITransferRequest>;
+    /**
+     * 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
+     */
     saveNewTransfer: (currentUser: string, comment?: string, saveToDatabase?: boolean, skipRef?: boolean) => Promise<string | boolean>;
+    /**
+     * 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
+     */
     static getTotalWeight: (products: ITransferProduct[], unit?: 'pounds' | 'kilograms') => number;
+    /**
+     * Get the total calculated pallet quantities for all transfer items
+     * @param items
+     * @returns
+     */
     static getTotalPalletQte: (items: ITransferProduct[]) => number;
+    /**
+     * 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
+     */
     getProductWeight: (sku: string, unit?: 'pounds' | 'kilograms') => number;
+    /**
+     * Fetches applicable transfer status order object by checking space_options for current space.
+     */
     private _getOrderObject;
+    /**
+     * Checks if provided "new" status follows current transfer status in the correct transfer status order for space.
+     * @param statusToCheck
+     */
     private _checkIfCanChangeToStatus;
+    /**
+     * 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.
+     */
     private _generateNewTransferStatusUpdates;
+    /**
+     * Saves provided status to TransferRequest data. Also generates and saves new entry for `transfer_updates` array.
+     * @param newStatus
+     * @param options
+     */
     private _saveNewStatus;
+    /**
+     * Checks update eligibility, then updates status to OPEN.
+     * @param options
+     */
     private _setAsOpen;
+    /**
+     * Checks update eligibility, then updates status to TO_BE_PREPARED.
+     * @param options
+     */
     private _setAsToBePrepared;
+    /**
+     * Checks update eligibility, then updates status to IN_TRANSIT. Also updates inventory for the origin store.
+     * @param options
+     */
     private _setAsInTransit;
+    /**
+     * Checks update eligibility, then updates status to RECEIVED. Also updates inventory for both stores.
+     * @param options
+     */
     private _setAsReceived;
+    /**
+     * 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.
+     */
     private _setAsReceivedPartially;
+    /**
+     * Checks if transfer can be cancelled, and if so, updates status to CANCELLED.
+     * @param options
+     */
     private _setAsCancelled;
+    /**
+     * Object regrouping all status change functions
+     */
     updateToStatus: {
         open: (options: SaveTransferOptionsType) => Promise<void>;
         toBePrepared: (options: SaveTransferOptionsType) => Promise<void>;
@@ -107,6 +280,11 @@ export declare class TransferRequest extends BaseServiceClass<ITransferRequest>
         receivedPartial: (options: SaveTransferOptionsType) => Promise<void>;
         cancelled: (options: SaveTransferOptionsType, context?: TransferRequestUpdateContextEnum) => Promise<void>;
     };
+    /**
+     * Get formatted ref string for the transfer.
+     * @param spaceTransferSettings
+     * @returns {string | undefined}
+     */
     getFormattedRef: (spaceTransferSettings: IOrderInvoiceNumerotation | undefined) => string | undefined;
 }
 export {};