@posx/core 5.3.69 → 5.3.70

package/build/index.d.ts

@@ -29,6 +29,7 @@ declare module '@posx/core/index' {
   export * from '@posx/core/types/ods.type';
   export * from '@posx/core/utils/autoquery.utils';
   export * from '@posx/core/libs/electron.socket';
+  export * from '@posx/core/types/condition.type';
 
 }
 declare module '@posx/core/libs/FindOptions' {
@@ -967,6 +968,7 @@ declare module '@posx/core/services/invoice.service' {
       calculateAddCredit(invoice: IInvoice): void;
       calculateRewardPoint(invoice: IInvoice, aboveInvoiceAmount: number, includeServiceCharge: boolean, includeTax: boolean): void;
       calculateChangeAmount(invoice: IInvoice): void;
+      calculateInvoiceCharges(invoice: IInvoice, flow: CalcFlow): void;
   }
   export type LineOptions = {
       quantity?: number;
@@ -1071,6 +1073,7 @@ declare module '@posx/core/services/invoice.service' {
       private resetInvoiceCalculations;
       private resetLineCalculations;
       calculateChangeAmount(invoice: IInvoice): void;
+      calculateInvoiceCharges(invoice: IInvoice, flow: CalcFlow): void;
   }
   /**
    * Interface for the Invoice Operation Service, which extends the IInvoiceBaseService interface.
@@ -1386,6 +1389,23 @@ declare module '@posx/core/services/invoice.service' {
        * @param payments payments to change
        */
       changePayments(invoice: IInvoice, options: IChangePaymentMethodOption[]): Promise<IInvoice>;
+      /**
+       * Adds a charge to an invoice
+       * @param invoice - The invoice to add the charge to
+       * @param name - The name of the charge
+       * @param percentage - The percentage of the charge (0 for flat amount)
+       * @param amount - The flat amount of the charge (0 for percentage)
+       * @param calcFlow - The calculation flow to use for the charge
+       * @returns The updated invoice with the added charge
+       */
+      addInvoiceCharge(invoice: IInvoice, name: string, percentage: number, amount: number, calcFlow?: CalcFlow): IInvoice;
+      /**
+       * Removes a charge from an invoice
+       * @param invoice - The invoice to remove the charge from
+       * @param chargeUid - The uid of the charge to remove
+       * @returns The updated invoice with the removed charge
+       */
+      removeInvoiceCharge(invoice: IInvoice, chargeUid: string): IInvoice;
   }
   export class InvoiceOperationService extends LineOperationService implements IInvoiceOperationService {
       createInvoice(invoice: IInvoice, sectionItem: ISectionItem, employee?: IEmployee): Promise<CreateInvoiceOptions>;
@@ -1415,6 +1435,23 @@ declare module '@posx/core/services/invoice.service' {
       private createOrderPrintJobs;
       private filterLinesAndPrintersToPrint;
       private preprocessInvoice;
+      /**
+       * Adds a charge to an invoice
+       * @param invoice - The invoice to add the charge to
+       * @param name - The name of the charge
+       * @param percentage - The percentage of the charge (0 for flat amount)
+       * @param amount - The flat amount of the charge (0 for percentage)
+       * @param calcFlow - The calculation flow to use for the charge
+       * @returns The updated invoice with the added charge
+       */
+      addInvoiceCharge(invoice: IInvoice, name: string, percentage: number, amount: number, calcFlow?: CalcFlow): IInvoice;
+      /**
+       * Removes a charge from an invoice
+       * @param invoice - The invoice to remove the charge from
+       * @param chargeUid - The uid of the charge to remove
+       * @returns The updated invoice with the removed charge
+       */
+      removeInvoiceCharge(invoice: IInvoice, chargeUid: string): IInvoice;
   }
   export type IInvoiceService = IInvoiceOperationService;
   export class InvoiceService extends InvoiceOperationService implements IInvoiceService {
@@ -1743,6 +1780,13 @@ declare module '@posx/core/types/auto.query.type' {
       Dec = "-12-"
   }
 
+}
+declare module '@posx/core/types/condition.type' {
+  export enum Condition {
+      None = "",
+      Always = "always"
+  }
+
 }
 declare module '@posx/core/types/config.type' {
   import { AppCoreModel, IAppCoreModel } from '@posx/core/types/abstract.type';
@@ -2254,6 +2298,7 @@ declare module '@posx/core/types/invoice.type' {
   import { ISectionItem } from '@posx/core/types/section.type';
   import { ITill } from '@posx/core/types/shift.type';
   import { IPrintJob } from '@posx/core/types/printer.type';
+  import { Condition } from '@posx/core/types/condition.type';
   export enum InvoiceType {
       DineIn = "dine_in",
       TakeOut = "take_out",
@@ -2309,6 +2354,28 @@ declare module '@posx/core/types/invoice.type' {
       Voucher = "voucher",
       Coupon = "coupon"
   }
+  /**
+   * Interface for invoice charge items
+   */
+  export interface IInvoiceCharge {
+      /** Charge unique id */
+      uid: string;
+      /** Charge name */
+      name: string;
+      /** Charge amount */
+      percentage: number;
+      /** Charge amount */
+      amount: number;
+      /** Charge calculation flow */
+      calc_flow: CalcFlow;
+  }
+  export class InvoiceCharge implements IInvoiceCharge {
+      uid: string;
+      name: string;
+      percentage: number;
+      amount: number;
+      calc_flow: CalcFlow;
+  }
   export interface IInvoiceActivity {
       /** Action */
       action: InvoiceAction;
@@ -2330,6 +2397,21 @@ declare module '@posx/core/types/invoice.type' {
       calc_type: CalcType;
       amount: number;
       percent: number;
+      percent_amount: number;
+  }
+  export interface ICharge {
+      uid: string;
+      name: string;
+      percent: number;
+      calc_flow: CalcFlow;
+      trigger_condition: Condition | string;
+  }
+  export class Charge implements ICharge {
+      uid: string;
+      name: string;
+      percent: number;
+      calc_flow: CalcFlow;
+      trigger_condition: string;
   }
   export interface IInvoiceDiscount extends IDiscount {
       /** the name can be the voucher or coupon name */
@@ -2347,6 +2429,7 @@ declare module '@posx/core/types/invoice.type' {
       calc_type: CalcType;
       amount: number;
       percent: number;
+      percent_amount: number;
       type: DiscountType;
       calc_flow: CalcFlow;
       name: string;
@@ -2471,7 +2554,7 @@ declare module '@posx/core/types/invoice.type' {
       /** Rewarded Credit */
       rewarded_credit: number;
       /** Discount List */
-      discounts: InvoiceDiscount[];
+      discounts: IInvoiceDiscount[];
       /** Total discount amount */
       discount_amount: number;
       /** Tax */
@@ -2547,6 +2630,10 @@ declare module '@posx/core/types/invoice.type' {
       activities: any[];
       /** Receipt printer unique id */
       receipt_print_job_uid: string;
+      /** Additional charges */
+      charges: IInvoiceCharge[];
+      /** Flag to track if charge has been manually deleted by user */
+      is_charge_triggered?: boolean;
   }
   export class InvoiceCoreLine implements IInvoiceCoreLine {
       item_uid: string;
@@ -2646,6 +2733,9 @@ declare module '@posx/core/types/invoice.type' {
       otp: string;
       activities: any[];
       receipt_print_job_uid: string;
+      charges: IInvoiceCharge[];
+      /** Flag to track if charge has been manually deleted by user */
+      is_charge_triggered: boolean;
       uid: string;
       constructor();
   }
@@ -2740,6 +2830,7 @@ declare module '@posx/core/types/misc.type' {
       Device = "dev_",
       Invoice = "inv_",
       InvoiceLine = "iln_",
+      InvoiceCharge = "ich_",
       Payment = "pay_",
       Employee = "emp_",
       Shift = "shf_",
@@ -2753,7 +2844,8 @@ declare module '@posx/core/types/misc.type' {
       Printer = "prt_",
       InvoiceDiscount = "ind_",
       EmployeeRole = "emr_",
-      OrderDisplaySystem = "ods_"
+      OrderDisplaySystem = "ods_",
+      Charge = "chr_"
   }
   export enum ModelType {
       Merchant = "mnt",