@posx/core 5.5.89 → 5.5.91

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Francisco Hodge
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 Francisco Hodge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,85 +1,85 @@
-# 第一阶段
-- 1. 创建，更新，删除都是通过 -> Http API
-- 2. 读取是通过本地数据库 -> 本地， （例外：订单从云端读取）
-
-# 第二阶段 （单机版）
-1. 创建，更新，删除，读取都通过本地数据库，然后进行数据和云端同步(Web Worker)
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- <div align="center">
- <img align="center" width="230" src="https://i.imgur.com/iHgtvmg.png" />
-  <h2>Typescript Library Boilerplate Basic</h2>
-  <blockquote>Minimal Library Starter Kit for your Typescript projects</blockquote>
- 
- <a href="https://www.npmjs.com/package/@hodgef/ts-library-boilerplate-basic"><img src="https://badgen.net/npm/v/@hodgef/ts-library-boilerplate-basic?color=blue" alt="npm version"></a> <a href="https://github.com/hodgef/ts-library-boilerplate"><img src="https://img.shields.io/github/last-commit/hodgef/ts-library-boilerplate" alt="latest commit"></a> <a href="https://github.com/hodgef/ts-library-boilerplate-basic/actions"><img alt="Build Status" src="https://github.com/hodgef/ts-library-boilerplate-basic/workflows/Build/badge.svg?color=green" /></a> <a href="https://github.com/hodgef/ts-library-boilerplate-basic/actions"> <img alt="Publish Status" src="https://github.com/hodgef/ts-library-boilerplate-basic/workflows/Publish/badge.svg?color=green" /></a>
-
-<strong>For a plain Javascript alternative, check out [js-library-boilerplate-basic](https://github.com/hodgef/js-library-boilerplate-basic).</strong>
-
-</div>
-
-## ⭐️ Features
-
-- Webpack 5
-- Babel 7
-- Hot reloading (`npm start`)
-- Automatic Types file generation (index.d.ts)
-- UMD exports, so your library works everywhere.
-- Jest unit testing
-- Customizable file headers for your build [(Example 1)](https://github.com/hodgef/ts-library-boilerplate-basic/blob/master/build/index.js) [(Example2)](https://github.com/hodgef/ts-library-boilerplate-basic/blob/master/build/css/index.css)
-- Daily [dependabot](https://dependabot.com) dependency updates
-
-## 📦 Getting Started
-
-```
-git clone https://github.com/hodgef/ts-library-boilerplate-basic.git myLibrary
-npm install
-```
-
-## 💎 Customization
-
-> Before shipping, make sure to:
-
-1. Edit `LICENSE` file
-2. Edit `package.json` information (These will be used to generate the headers for your built files)
-3. Edit `library: "MyLibrary"` with your library's export name in `./webpack.config.js`
-
-## 🚀 Deployment
-
-1. `npm publish`
-2. Your users can include your library as usual
-
-### npm
-
-```
-import MyLibrary from 'my-library';
-const libraryInstance = new MyLibrary();
-...
-```
-
-### self-host/cdn
-
-```
-<script src="build/index.js"></script>
-
-const MyLibrary = window.MyLibrary.default;
-const libraryInstance = new MyLibrary();
-...
-```
-
-## ✅ Libraries built with this boilerplate
-
-> Made a library using this starter kit? Share it here by [submitting a pull request](https://github.com/hodgef/ts-library-boilerplate-basic/pulls)!
-
-- [simple-keyboard](https://github.com/hodgef/simple-keyboard) - Javascript Virtual Keyboard
-- [react-simple-keyboard](https://github.com/hodgef/react-simple-keyboard) - React Virtual Keyboard
-- [simple-keyboard-layouts](https://github.com/hodgef/simple-keyboard-layouts) - Keyboard layouts for simple-keyboard
-- [atlas-monaco](https://github.com/datdao/atlas-monaco) - AtlasHCL for monaco editor
+# 第一阶段
+- 1. 创建，更新，删除都是通过 -> Http API
+- 2. 读取是通过本地数据库 -> 本地， （例外：订单从云端读取）
+
+# 第二阶段 （单机版）
+1. 创建，更新，删除，读取都通过本地数据库，然后进行数据和云端同步(Web Worker)
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ <div align="center">
+ <img align="center" width="230" src="https://i.imgur.com/iHgtvmg.png" />
+  <h2>Typescript Library Boilerplate Basic</h2>
+  <blockquote>Minimal Library Starter Kit for your Typescript projects</blockquote>
+ 
+ <a href="https://www.npmjs.com/package/@hodgef/ts-library-boilerplate-basic"><img src="https://badgen.net/npm/v/@hodgef/ts-library-boilerplate-basic?color=blue" alt="npm version"></a> <a href="https://github.com/hodgef/ts-library-boilerplate"><img src="https://img.shields.io/github/last-commit/hodgef/ts-library-boilerplate" alt="latest commit"></a> <a href="https://github.com/hodgef/ts-library-boilerplate-basic/actions"><img alt="Build Status" src="https://github.com/hodgef/ts-library-boilerplate-basic/workflows/Build/badge.svg?color=green" /></a> <a href="https://github.com/hodgef/ts-library-boilerplate-basic/actions"> <img alt="Publish Status" src="https://github.com/hodgef/ts-library-boilerplate-basic/workflows/Publish/badge.svg?color=green" /></a>
+
+<strong>For a plain Javascript alternative, check out [js-library-boilerplate-basic](https://github.com/hodgef/js-library-boilerplate-basic).</strong>
+
+</div>
+
+## ⭐️ Features
+
+- Webpack 5
+- Babel 7
+- Hot reloading (`npm start`)
+- Automatic Types file generation (index.d.ts)
+- UMD exports, so your library works everywhere.
+- Jest unit testing
+- Customizable file headers for your build [(Example 1)](https://github.com/hodgef/ts-library-boilerplate-basic/blob/master/build/index.js) [(Example2)](https://github.com/hodgef/ts-library-boilerplate-basic/blob/master/build/css/index.css)
+- Daily [dependabot](https://dependabot.com) dependency updates
+
+## 📦 Getting Started
+
+```
+git clone https://github.com/hodgef/ts-library-boilerplate-basic.git myLibrary
+npm install
+```
+
+## 💎 Customization
+
+> Before shipping, make sure to:
+
+1. Edit `LICENSE` file
+2. Edit `package.json` information (These will be used to generate the headers for your built files)
+3. Edit `library: "MyLibrary"` with your library's export name in `./webpack.config.js`
+
+## 🚀 Deployment
+
+1. `npm publish`
+2. Your users can include your library as usual
+
+### npm
+
+```
+import MyLibrary from 'my-library';
+const libraryInstance = new MyLibrary();
+...
+```
+
+### self-host/cdn
+
+```
+<script src="build/index.js"></script>
+
+const MyLibrary = window.MyLibrary.default;
+const libraryInstance = new MyLibrary();
+...
+```
+
+## ✅ Libraries built with this boilerplate
+
+> Made a library using this starter kit? Share it here by [submitting a pull request](https://github.com/hodgef/ts-library-boilerplate-basic/pulls)!
+
+- [simple-keyboard](https://github.com/hodgef/simple-keyboard) - Javascript Virtual Keyboard
+- [react-simple-keyboard](https://github.com/hodgef/react-simple-keyboard) - React Virtual Keyboard
+- [simple-keyboard-layouts](https://github.com/hodgef/simple-keyboard-layouts) - Keyboard layouts for simple-keyboard
+- [atlas-monaco](https://github.com/datdao/atlas-monaco) - AtlasHCL for monaco editor

package/build/index.d.ts

@@ -32,6 +32,17 @@ declare module '@posx/core/index' {
   export * from '@posx/core/types/condition.type';
   export * from '@posx/core/types/merchant.type';
 
+}
+declare module '@posx/core/libs/FindOptions' {
+  export const Include: (query?: string) => (val: any) => any;
+  export const In: (query?: never[]) => (val: never) => boolean;
+  export const Between: (begin: number, end: number) => (val: number) => boolean;
+  export const Not: (query?: any) => (val: any, values: any) => boolean;
+  export const Raw: (fn: any) => any;
+  export const filterByParams: (params: {
+      [key: string]: any;
+  }) => (values: any) => boolean;
+
 }
 declare module '@posx/core/libs/electron.socket' {
   export class ElectronSocket {
@@ -247,17 +258,6 @@ declare module '@posx/core/libs/escpos.printer' {
       items: IPrintCommandLine[];
   }
 
-}
-declare module '@posx/core/libs/FindOptions' {
-  export const Include: (query?: string) => (val: any) => any;
-  export const In: (query?: never[]) => (val: never) => boolean;
-  export const Between: (begin: number, end: number) => (val: number) => boolean;
-  export const Not: (query?: any) => (val: any, values: any) => boolean;
-  export const Raw: (fn: any) => any;
-  export const filterByParams: (params: {
-      [key: string]: any;
-  }) => (values: any) => boolean;
-
 }
 declare module '@posx/core/service.factory' {
   import { IServiceOptions } from '@posx/core/types/misc.type';
@@ -1138,13 +1138,11 @@ declare module '@posx/core/services/invoice.service' {
        * @param customer - The customer associated with the invoice.
        * @param appConfig - The app configuration.
        * @param item - The item to add to the invoice line.
-       * @param quantity - The quantity of the item to add.
-       * @param price - The price of the item.
        * @param modifiers - An array of modifiers to apply to the item.
        * @param options - Additional options for the line.
        * @returns The updated invoice.
        */
-      addItemToLine(invoice: IInvoice, customer: ICustomer, appConfig: IAppConfig, item: IItem, modifiers?: IInvoiceCoreLine[], options?: LineOptions): IInvoice;
+      addItemToLine(invoice: IInvoice, customer: ICustomer, appConfig: IAppConfig, item: IItem, modifiers?: IInvoiceCoreLine[], options?: LineOptions): IInvoiceLine;
       /**
        * Duplicates an invoice line
        * @param invoice - The invoice to duplicate the line in.
@@ -1246,9 +1244,29 @@ declare module '@posx/core/services/invoice.service' {
        * @returns The updated invoice line.
        */
       overwriteNoteToLine(line: IInvoiceLine, note: string): IInvoiceLine;
+      /**
+       * To add combo items under one combo
+       * @param invoice - The invoice to add the item to.
+       * @param customer - The customer associated with the invoice.
+       * @param appConfig - The app configuration.
+       * @param item - The item to add to the invoice line.
+       * @param comboLineUid the main combo's line uid
+       * @param comboGroupUid the uid of the combo_group the item belongs to
+       * @param modifiers - An array of modifiers to apply to the item (default is [])
+       * @param options - Additional options for the line.
+       */
+      addComboItemToLine(invoice: IInvoice, customer: ICustomer, appConfig: IAppConfig, item: IItem, comboLineUid: string, comboGroupUid: string, modifiers?: IInvoiceCoreLine[], options?: LineOptions): IInvoiceLine;
+      /**
+       * For combo's operations, if a combo is removed, all combo items under it will be removed
+       * Use this operation to remove all combo items
+       * And use minusLineQuantity to remove main combo.
+       * @param invoice the invoice
+       * @param comboLineUid The combo's line uid
+       */
+      removeAllComboItems(Invoice: IInvoice, comboLineUid: string): IInvoiceLine[];
   }
   export class LineOperationService extends InvoiceBaseService implements ILineOperationService {
-      addItemToLine(invoice: IInvoice, customer: ICustomer, appConfig: IAppConfig, item: IItem, modifiers?: IInvoiceCoreLine[], lineOptions?: LineOptions): IInvoice;
+      addItemToLine(invoice: IInvoice, customer: ICustomer, appConfig: IAppConfig, item: IItem, modifiers?: IInvoiceCoreLine[], lineOptions?: LineOptions): IInvoiceLine;
       duplicateLine(invoice: IInvoice, line: IInvoiceLine): IInvoice;
       calibrateDuplicates(invoice: IInvoice): IInvoice;
       toInvoiceCoreLine(modifier: ICoreItem, quantity?: number): IInvoiceCoreLine;
@@ -1272,6 +1290,8 @@ declare module '@posx/core/services/invoice.service' {
        * @param source
        */
       protected compareLines(target: IInvoiceLine, source: IInvoiceLine): boolean;
+      addComboItemToLine(invoice: IInvoice, customer: ICustomer, appConfig: IAppConfig, item: IItem, comboLineUid: string, comboGroupUid: string, modifiers?: IInvoiceCoreLine[], options?: LineOptions): IInvoiceLine;
+      removeAllComboItems(invoice: IInvoice, comboLineUid: string): IInvoiceLine[];
   }
   /**
    * Interface for invoice operation service that extends line operation service
@@ -1876,10 +1896,16 @@ declare module '@posx/core/types/config.type' {
   export interface IAppConfig extends IAppCoreModel {
       config: IConfig;
       cache: ICache;
+      storage: {
+          pricing_lookup_keys: string[];
+      };
   }
   export class AppConfig extends AppCoreModel implements IAppConfig {
       config: Config;
       cache: Cache;
+      storage: {
+          pricing_lookup_keys: any[];
+      };
       constructor();
   }
   export interface ICache {
@@ -2675,6 +2701,14 @@ declare module '@posx/core/types/invoice.type' {
       is_duplicate: boolean;
       /** The line item that this line item is duplicated from. */
       duplicated_from_uid: string;
+      /** Whether the line item is a combo. */
+      is_combo: boolean;
+      /** Whether the line item is a combo item. */
+      is_combo_item: boolean;
+      /** Combo group unique id. */
+      combo_group_uid: string;
+      /** Combo line unique id. */
+      combo_line_uid: string;
       /** Any modifiers applied to the line item. */
       modifiers: IInvoiceCoreLine[];
       /** Meta data for the line item */
@@ -2853,6 +2887,10 @@ declare module '@posx/core/types/invoice.type' {
       up_size: boolean;
       is_take_out: boolean;
       is_duplicate: boolean;
+      is_combo: boolean;
+      is_combo_item: boolean;
+      combo_group_uid: string;
+      combo_line_uid: string;
       modifiers: any[];
       duplicated_from_uid: string;
       sent: number;
@@ -3041,7 +3079,8 @@ declare module '@posx/core/types/misc.type' {
       EmployeeRole = "emr_",
       OrderDisplaySystem = "ods_",
       Charge = "chr_",
-      Price = "prc_"
+      Price = "prc_",
+      ComboGroup = "cbo_"
   }
   export enum ModelType {
       Merchant = "mnt",
@@ -3795,6 +3834,10 @@ declare module '@posx/core/types/product.type' {
        * The price of the item.
        */
       price: number;
+      /**
+       * The original price of the item.
+       */
+      original_price: number;
       /**
        * The price list of the item.
        */
@@ -3832,6 +3875,7 @@ declare module '@posx/core/types/product.type' {
       barcode: string;
       category_uid: string;
       price: number;
+      original_price: number;
       prices: Array<IPrice>;
       stock: number;
       print_on_receipt: boolean;
@@ -3867,7 +3911,7 @@ declare module '@posx/core/types/product.type' {
       unit: number;
       /**
        * Number of items sold
-      * @ignore
+       * @ignore
        */
       sold: number;
       /**
@@ -3898,7 +3942,7 @@ declare module '@posx/core/types/product.type' {
       likes: number;
       /**
        * Number of dislikes for the item
-        * @ignore
+       * @ignore
        */
       dislikes: number;
       /**
@@ -3953,6 +3997,10 @@ declare module '@posx/core/types/product.type' {
        * if price editor will be opened by default when item is clicked
        */
       open_price_editor: boolean;
+      /**
+       * Combo groups (only applicable when type is ProductType.Combo)
+       */
+      combo_groups: IComboGroup[];
   }
   export class Item extends CoreItem implements IItem {
       codename: string;
@@ -3989,6 +4037,7 @@ declare module '@posx/core/types/product.type' {
       label_printers_uids: any[];
       open_editor_panel: boolean;
       open_price_editor: boolean;
+      combo_groups: IComboGroup[];
       constructor();
   }
   export interface IPrice extends IAppCoreModel {
@@ -4006,6 +4055,93 @@ declare module '@posx/core/types/product.type' {
       amount: number;
       constructor();
   }
+  /**
+   * COMBO PRODUCT IMPLEMENTATION
+   *
+   * Combo products bundle multiple existing products together and sell them as a group,
+   * usually at a discount. This implementation provides minimal impact on existing data structures.
+   *
+   * Usage:
+   * 1. Create combo product with type = ProductType.Combo
+   * 2. Define combo_groups array with component groups and available items
+   * 3. Set combo discount (either amount or percentage)
+   * 4. When adding to invoice, combo appears as single line with selections in combo_components
+   *
+   * Example:
+   * ```
+   * const combo: IItem = {
+   *   type: ProductType.Combo,
+   *   combo_groups: [
+   *     {
+   *       name: "Choose your main",
+   *       min_selections: 1,
+   *       max_selections: 1,
+   *       required: true,
+   *       items: [
+   *         { item_uid: 'burger_uid', is_default: true },
+   *         { item_uid: 'chicken_uid', price_override: 2.00 }
+   *       ]
+   *     },
+   *     {
+   *       name: "Pick a side",
+   *       min_selections: 1,
+   *       max_selections: 1,
+   *       required: true,
+   *       items: [
+   *         { item_uid: 'fries_uid', is_default: true },
+   *         { item_uid: 'onion_rings_uid', price_override: 1.50 }
+   *       ]
+   *     }
+   *   ],
+   *   combo_discount_percent: 15 // 15% discount
+   * }
+   * ```
+   */
+  /**
+   * Interface for individual items within a combo group
+   */
+  export interface IComboGroupItem extends IAppModelSequence {
+      /** Item unique id */
+      item_uid: string;
+      /** Combo item */
+      combo_item: ICoreItem;
+      /** Price of the item in combo */
+      price: number;
+  }
+  /**
+   * Interface for combo component groups (e.g., "Main Course", "Side", "Drink")
+   */
+  export interface IComboGroup extends IAppModelSequence {
+      /** Group unique id */
+      uid: string;
+      /** Group name (e.g., "Choose your main", "Pick a side") */
+      name: string;
+      /** Translations of the name */
+      name_translations: Record<string, string>;
+      /** Minimum selections required from this group */
+      min_order: number;
+      /** Maximum selections allowed from this group */
+      max_order: number;
+      /** Available items in this group */
+      combo_items: IComboGroupItem[];
+  }
+  export class ComboGroupItem implements IComboGroupItem {
+      item_uid: string;
+      combo_item: CoreItem;
+      price: number;
+      sequence: number;
+      constructor();
+  }
+  export class ComboGroup implements IComboGroup {
+      uid: string;
+      name: string;
+      name_translations: Record<string, string>;
+      min_order: number;
+      max_order: number;
+      combo_items: IComboGroupItem[];
+      sequence: number;
+      constructor();
+  }
 
 }
 declare module '@posx/core/types/report.type' {