addio-admin-sdk 1.7.142 → 1.7.143

package/dist/Interfaces/CashDrawers/index.d.ts

@@ -30,7 +30,7 @@ export declare enum CashDrawerActionEnum {
     ORDER_CASH_IN = "order_cash_in",
     ORDER_CASH_OUT = "order_cash_out",
     MANUAL_CASH_IN = "manual_cash_in",
-    MANUAL_CASH_OUT = "order_cash_out",
+    MANUAL_CASH_OUT = "manual_cash_out",
     END_SHIFT = "end_shift"
 }
 export declare const getDefaultCashDrawer: () => ICashDrawer;

package/dist/Interfaces/CashDrawers/index.js

@@ -8,7 +8,7 @@ var CashDrawerActionEnum;
     CashDrawerActionEnum["ORDER_CASH_IN"] = "order_cash_in";
     CashDrawerActionEnum["ORDER_CASH_OUT"] = "order_cash_out";
     CashDrawerActionEnum["MANUAL_CASH_IN"] = "manual_cash_in";
-    CashDrawerActionEnum["MANUAL_CASH_OUT"] = "order_cash_out";
+    CashDrawerActionEnum["MANUAL_CASH_OUT"] = "manual_cash_out";
     CashDrawerActionEnum["END_SHIFT"] = "end_shift";
 })(CashDrawerActionEnum = exports.CashDrawerActionEnum || (exports.CashDrawerActionEnum = {}));
 const getDefaultCashDrawer = () => ({

package/dist/Interfaces/CashDrawers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Interfaces/CashDrawers/index.ts"],"names":[],"mappings":";;;AAAA,+BAAyB;AAiCzB,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC/B,kDAA0B,CAAA;IAC1B,uDAA+B,CAAA;IAC/B,yDAAiC,CAAA;IACjC,yDAAiC,CAAA;IACjC,0DAAkC,CAAA;IAClC,+CAAuB,CAAA;AACxB,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B;AAEM,MAAM,oBAAoB,GAAG,GAAgB,EAAE,CAAC,CAAC;IACvD,EAAE,EAAE,IAAA,SAAE,GAAE;IACR,QAAQ,EAAE,EAAE;IACZ,MAAM,EAAE,IAAI;CACZ,CAAC,CAAA;AAJW,QAAA,oBAAoB,wBAI/B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Interfaces/CashDrawers/index.ts"],"names":[],"mappings":";;;AAAA,+BAAyB;AAiCzB,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC/B,kDAA0B,CAAA;IAC1B,uDAA+B,CAAA;IAC/B,yDAAiC,CAAA;IACjC,yDAAiC,CAAA;IACjC,2DAAmC,CAAA;IACnC,+CAAuB,CAAA;AACxB,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B;AAEM,MAAM,oBAAoB,GAAG,GAAgB,EAAE,CAAC,CAAC;IACvD,EAAE,EAAE,IAAA,SAAE,GAAE;IACR,QAAQ,EAAE,EAAE;IACZ,MAAM,EAAE,IAAI;CACZ,CAAC,CAAA;AAJW,QAAA,oBAAoB,wBAI/B"}

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

@@ -23,7 +23,7 @@ export default class CashDrawerShift extends BaseServiceClass<ICashDrawerShift>
      */
     static getTranslatedGenericInteractionReason: (action: Exclude<CashDrawerActionEnum, CashDrawerActionEnum.MANUAL_CASH_IN | CashDrawerActionEnum.MANUAL_CASH_OUT>, locale: string | undefined, orderRef?: string) => string;
     /**
-     * Create a new open shift entry, and save result to database. Also calls function to generates the corresponding interaction.
+     * Create a new open shift entry, and save result to database. Also calls function to generate the corresponding interaction.
      * @static
      * @param amountInDrawer The cash amount in drawer on open.
      * @param space Space obj instance.

package/dist/lib/CashDrawerShift/index.js

@@ -170,7 +170,7 @@ CashDrawerShift.getTranslatedGenericInteractionReason = (action, locale, orderRe
     }
 };
 /**
- * Create a new open shift entry, and save result to database. Also calls function to generates the corresponding interaction.
+ * Create a new open shift entry, and save result to database. Also calls function to generate the corresponding interaction.
  * @static
  * @param amountInDrawer The cash amount in drawer on open.
  * @param space Space obj instance.

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

@@ -64,6 +64,8 @@ import { MenuPositionEnum } from '../../Interfaces/Menu';
 import Menu from '../../lib/Menu';
 import Note from '../Note';
 import { NoteTypeEnum } from '../../Interfaces/Note';
+import { CashDrawerActionEnum, ICashDrawer, ICashDrawerInteraction } from '../../Interfaces/CashDrawers';
+import CashDrawerShift from '../CashDrawerShift';
 /**
  * Class Space
  * A Space represent a company.
@@ -597,6 +599,63 @@ export default class Space {
      * Retourne tous les menus actifs
      */
     private _getAllActiveMenus;
+    /**
+     * Utils to check and return current space cash drawers. Throws an error if space does not has corresponding feature set, or if id provided and same id not found in current cash drawers.
+     * @param idToCheck Optionnal. Cart drawer id to check in current space data.
+     */
+    private _checkCurrentSpaceDataForCashDrawer;
+    /**
+     * Generates new cash drawer from data provided, and saves to cash_drawer array in Space data.
+     * @param data.nickname Nickname for cash drawer (required)
+     * @param data.drawerNumber Optionnal. Number for given cash drawer
+     * @throws If feature for cash drawers is not set in space_options
+     * @returns {ICashDrawer[]} Space's cash drawer array with newly added drawer at last index
+     */
+    private _createNewCashDrawer;
+    /**
+     * Updates existing cash drawer from data provided, and saves to cash_drawer array in Space data.
+     * @param id Id for the cash drawer to update
+     * @param data.nickname Nickname for cash drawer (required)
+     * @param data.drawerNumber Optionnal. Number for given cash drawer
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Updated space cash drawer array
+     */
+    private _editCashDrawer;
+    /**
+     * Toggles active property for existing cash drawer, and saves to cash_drawer array in Space data.
+     * @param id Id for the cash drawer to toggle
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Updated space cash drawer array
+     */
+    private _toggleCashDrawer;
+    /**
+     * Checks if an open shift is found for a corresponding cash drawer id.
+     * @param id The cash drawer id
+     * @returns If open shift found for drawer.
+     */
+    private _checkIfOpenShiftExistsForDrawer;
+    /**
+     * Fetch corresponding open shift for a given drawer ID.
+     * @param id Id for the cash drawer to search.
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Found shift or undefined
+     */
+    private _getOpenShiftForDrawer;
+    /**
+     * Fetch all cash drawer interaction history entries for specified options. All options are optionnal.
+     * @param options.drawerId Specific cash drawer Id
+     * @param options.shiftId Specific shift Id
+     * @param options.action Specific action type
+     * @param options.userEmail Specific user email that generated interaction
+     * @param options.dates Specific dates to filter results. If options.dates if provided, start date is obligatory, and end date optionnal.
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Array of corresponding Interaction history entries, ordered by oldest to newest. If not date provided in options, returns max 100 entries. Else returns all found.
+     */
+    private _getInteractionHistoryForDrawer;
     attributes: {
         get: (options?: IQueryOptions) => Promise<Attribute[]>;
         add: (attribute: IAttribute) => Promise<void>;
@@ -1044,6 +1103,29 @@ export default class Space {
         getActiveBySlug: (slug: MenuPositionEnum) => Promise<Menu | undefined>;
         getAllActive: () => Promise<Menu[]>;
     };
+    cashDrawers: {
+        create: (data: {
+            nickname: string;
+            drawerNumber?: number;
+        }) => Promise<ICashDrawer[]>;
+        edit: (id: string, data: {
+            nickname: string;
+            drawerNumber?: number;
+        }) => Promise<ICashDrawer[]>;
+        toggle: (id: string) => Promise<ICashDrawer[]>;
+        hasOpenShift: (drawerId: string) => Promise<boolean>;
+        getOpenShift: (drawerId: string) => Promise<CashDrawerShift | undefined>;
+        getInteractionHistory: (options?: {
+            drawerId?: string;
+            shiftId?: string;
+            action?: CashDrawerActionEnum;
+            userEmail?: string;
+            dates?: {
+                start: Date;
+                end?: Date;
+            };
+        }) => Promise<ICashDrawerInteraction[]>;
+    };
     /**
      * Get all space properties
      */

package/dist/lib/Space/index.js

@@ -108,6 +108,8 @@ 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"));
+const CashDrawers_1 = require("../../Interfaces/CashDrawers");
+const CashDrawerShift_1 = __importDefault(require("../CashDrawerShift"));
 //#endregion
 /**
  * Class Space
@@ -5069,8 +5071,9 @@ class Space {
             }
             return credits;
         };
-        //#
-        //#region MENUS
+        // #endregion
+        // -------------------------------------------------------------------------------
+        // #region MENUS
         /**
          * Retourne tous les menus du space
          */
@@ -5122,6 +5125,148 @@ class Space {
             return results;
         };
         //#endregion
+        // -------------------------------------------------------------------------------
+        // #region CASH DRAWERS
+        /**
+         * Utils to check and return current space cash drawers. Throws an error if space does not has corresponding feature set, or if id provided and same id not found in current cash drawers.
+         * @param idToCheck Optionnal. Cart drawer id to check in current space data.
+         */
+        this._checkCurrentSpaceDataForCashDrawer = (idToCheck) => {
+            let currentCashDrawers = [];
+            const spaceHasCashDrawersActive = this.options.checkIfOptionIsSet('features.can_manage_cash_drawers');
+            if (!spaceHasCashDrawersActive)
+                throw new Error('Cash drawers not active for space!');
+            if (typeof idToCheck == 'string') {
+                currentCashDrawers = this._space.cash_drawers || [];
+                const sameDrawerInData = currentCashDrawers.some((d) => d.id == idToCheck);
+                if (!sameDrawerInData)
+                    throw new Error(`Cash drawer with id ${idToCheck} not found in space !`);
+            }
+            return currentCashDrawers;
+        };
+        /**
+         * Generates new cash drawer from data provided, and saves to cash_drawer array in Space data.
+         * @param data.nickname Nickname for cash drawer (required)
+         * @param data.drawerNumber Optionnal. Number for given cash drawer
+         * @throws If feature for cash drawers is not set in space_options
+         * @returns {ICashDrawer[]} Space's cash drawer array with newly added drawer at last index
+         */
+        this._createNewCashDrawer = async (data) => {
+            this._checkCurrentSpaceDataForCashDrawer();
+            const cashDrawerData = Object.assign(Object.assign({}, (0, CashDrawers_1.getDefaultCashDrawer)()), { nickname: data.nickname, drawer_number: data.drawerNumber });
+            const currentCashDrawersForSpace = this._space.cash_drawers || [];
+            await this.save({ cash_drawers: [...currentCashDrawersForSpace, cashDrawerData] });
+            return this._space.cash_drawers;
+        };
+        /**
+         * Updates existing cash drawer from data provided, and saves to cash_drawer array in Space data.
+         * @param id Id for the cash drawer to update
+         * @param data.nickname Nickname for cash drawer (required)
+         * @param data.drawerNumber Optionnal. Number for given cash drawer
+         * @throws If feature for cash drawers is not set in space_options
+         * @throws If same drawer id not found in current space data cash drawers.
+         * @returns Updated space cash drawer array
+         */
+        this._editCashDrawer = async (id, data) => {
+            const currentCashDrawersForSpace = this._checkCurrentSpaceDataForCashDrawer(id);
+            await this.save({
+                cash_drawers: currentCashDrawersForSpace.map((d) => {
+                    if (d.id != id)
+                        return d;
+                    return Object.assign(Object.assign({}, d), { nickname: data.nickname, drawer_number: data.drawerNumber });
+                })
+            });
+            return this._space.cash_drawers;
+        };
+        /**
+         * Toggles active property for existing cash drawer, and saves to cash_drawer array in Space data.
+         * @param id Id for the cash drawer to toggle
+         * @throws If feature for cash drawers is not set in space_options
+         * @throws If same drawer id not found in current space data cash drawers.
+         * @returns Updated space cash drawer array
+         */
+        this._toggleCashDrawer = async (id) => {
+            const currentCashDrawersForSpace = this._checkCurrentSpaceDataForCashDrawer(id);
+            await this.save({
+                cash_drawers: currentCashDrawersForSpace.map((d) => {
+                    if (d.id != id)
+                        return d;
+                    return Object.assign(Object.assign({}, d), { active: !d.active });
+                })
+            });
+            return this._space.cash_drawers;
+        };
+        /**
+         * Checks if an open shift is found for a corresponding cash drawer id.
+         * @param id The cash drawer id
+         * @returns If open shift found for drawer.
+         */
+        this._checkIfOpenShiftExistsForDrawer = async (drawerId) => {
+            const foundShift = await this._getOpenShiftForDrawer(drawerId);
+            return !!foundShift && foundShift.data().is_open;
+        };
+        /**
+         * Fetch corresponding open shift for a given drawer ID.
+         * @param id Id for the cash drawer to search.
+         * @throws If feature for cash drawers is not set in space_options
+         * @throws If same drawer id not found in current space data cash drawers.
+         * @returns Found shift or undefined
+         */
+        this._getOpenShiftForDrawer = async (drawerId) => {
+            this._checkCurrentSpaceDataForCashDrawer(drawerId);
+            const path = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/cash_drawer_shifts');
+            const collRef = DatabaseService_1.default.asCollectionObject(this._space_ref.path, this._space_ref.id + '/cash_drawer_shifts');
+            const docs = await DatabaseService_1.default.getDocuments(path, {
+                query: [
+                    { field: 'cash_drawer_id', operator: '==', value: drawerId },
+                    { field: 'is_open', operator: '==', value: true }
+                ]
+            });
+            let filteredDocs = docs
+                .filter((d) => d.exists && !!d.data)
+                .map((d) => new CashDrawerShift_1.default(this, drawerId, Object.assign(Object.assign({}, d.data), { id: d.id }), collRef, this._user));
+            if (filteredDocs.length > 1) {
+                console.log("WARNING - Found more than one shift open for a cash drawer, which shouldn't happen! Will only return value opened most recently.");
+                filteredDocs = (0, orderBy_1.default)(filteredDocs, (d) => d.data().opened_details.date, 'asc');
+            }
+            return filteredDocs[0];
+        };
+        /**
+         * Fetch all cash drawer interaction history entries for specified options. All options are optionnal.
+         * @param options.drawerId Specific cash drawer Id
+         * @param options.shiftId Specific shift Id
+         * @param options.action Specific action type
+         * @param options.userEmail Specific user email that generated interaction
+         * @param options.dates Specific dates to filter results. If options.dates if provided, start date is obligatory, and end date optionnal.
+         * @throws If feature for cash drawers is not set in space_options
+         * @throws If same drawer id not found in current space data cash drawers.
+         * @returns Array of corresponding Interaction history entries, ordered by oldest to newest. If not date provided in options, returns max 100 entries. Else returns all found.
+         */
+        this._getInteractionHistoryForDrawer = async (options = {}) => {
+            this._checkCurrentSpaceDataForCashDrawer(options.drawerId);
+            // Construct search query
+            let queryOptions = [];
+            if (options.drawerId)
+                queryOptions.push({ field: 'cash_drawer_id', operator: '==', value: options.drawerId });
+            if (options.shiftId)
+                queryOptions.push({ field: 'shift_id', operator: '==', value: options.shiftId });
+            if (options.action)
+                queryOptions.push({ field: 'action', operator: '==', value: options.action });
+            if (options.userEmail)
+                queryOptions.push({ field: 'user', operator: '==', value: options.userEmail });
+            if (options.dates) {
+                queryOptions.push({ field: 'date', operator: '>=', value: options.dates.start });
+                if (options.dates.end)
+                    queryOptions.push({ field: 'date', operator: '<=', value: options.dates.end });
+            }
+            const path = DatabaseService_1.default.addToPath(this._space_ref.path, this._space_ref.id + '/cash_drawer_interactions');
+            const docs = await DatabaseService_1.default.getDocuments(path, Object.assign({ query: queryOptions, orderBy: 'date', order: 'asc' }, (!options.dates ? { limit: 100 } : {})));
+            const filteredDocs = docs.filter((d) => d.exists && !!d.data).map((d) => d.data);
+            return filteredDocs;
+        };
+        // #endregion
+        // -------------------------------------------------------------------------------
+        // #region PUBLIC GETTER FUNCTIONS
         this.attributes = {
             get: this._getAttributes,
             add: this._addAttribute,
@@ -5508,6 +5653,15 @@ class Space {
                 return await this._getAllActiveMenus();
             }
         };
+        this.cashDrawers = {
+            create: this._createNewCashDrawer,
+            edit: this._editCashDrawer,
+            toggle: this._toggleCashDrawer,
+            hasOpenShift: this._checkIfOpenShiftExistsForDrawer,
+            getOpenShift: this._getOpenShiftForDrawer,
+            getInteractionHistory: this._getInteractionHistoryForDrawer
+        };
+        // #endregion
         /**
          * Get all space properties
          */
@@ -5529,6 +5683,7 @@ class Space {
             return !!this._space.multipromo_aware ? this._space.multipromo_aware : false;
         };
         //#endregion
+        // -------------------------------------------------------------------------------
         //#region NOTES
         this._getNotes = async (parentId, type) => {
             try {