@etsoo/appscript 1.3.90 → 1.3.91

package/lib/mjs/business/ShoppingCart.d.ts

@@ -0,0 +1,285 @@
+import { DataTypes, IStorage } from '@etsoo/shared';
+/**
+ * Shopping cart owner
+ * 购物篮所有人
+ */
+export type ShoppingCartOwner = DataTypes.IdNameItem & {
+    isSupplier?: boolean;
+};
+/**
+ * Shopping cart data
+ * 购物篮数据
+ */
+export type ShoppingCartData<T extends ShoppingCartItem> = {
+    currency: string;
+    owner: ShoppingCartOwner;
+    items: T[];
+    promotions: ShoppingPromotion[];
+    formData?: any;
+};
+/**
+ * Shopping promotion
+ * 购物促销
+ */
+export type ShoppingPromotion = {
+    /**
+     * Promotion id
+     * 促销编号
+     */
+    id: number;
+    /**
+     * Promotion title
+     * 促销标题
+     */
+    title: string;
+    /**
+     * Discount amount
+     * 折扣金额
+     */
+    amount: number;
+};
+/**
+ * Shopping cart base item
+ * 购物篮基础项目
+ */
+export type ShoppingCartItemBase = {
+    /**
+     * Product id
+     * 产品编号
+     */
+    id: DataTypes.IdType;
+    /**
+     * Product title, default is name
+     * 产品标题，默认为name
+     */
+    title?: string;
+    /**
+     * Sale price
+     * 销售价格
+     */
+    price: number;
+    /**
+     * Qty
+     * 数量
+     */
+    qty: number;
+    /**
+     * Product level promotions
+     * 产品层次促销
+     */
+    promotions: ShoppingPromotion[];
+};
+/**
+ * Shopping cart item
+ * 购物篮项目
+ */
+export type ShoppingCartItem = ShoppingCartItemBase & {
+    /**
+     * Product name
+     * 产品名称
+     */
+    name: string;
+    /**
+     * Current price for cache
+     * 当前缓存价格
+     */
+    currentPrice?: number;
+    /**
+     * Subtotal
+     * 小计
+     */
+    subtotal: number;
+    /**
+     * Total discount amount
+     * 总折扣金额
+     */
+    discount: number;
+};
+/**
+ * Shopping cart change reason
+ * 购物篮改变原因
+ */
+export type ShoppingCartChangeReason = 'add' | 'clear' | 'remove' | 'title' | 'update';
+/**
+ * Shopping cart
+ * 购物篮
+ */
+export declare class ShoppingCart<T extends ShoppingCartItem> {
+    private readonly storage;
+    /**
+     * Create identifier key
+     * 创建识别键
+     * @param currency Currency
+     * @returns Result
+     */
+    static createKey(currency: string): string;
+    /**
+     * Clear shopping cart
+     * 清除购物篮
+     * @param identifier Identifier
+     * @param storage Storage
+     */
+    static clear(identifier: string, storage: IStorage): void;
+    /**
+     * Clear shopping cart
+     * 清除购物篮
+     * @param currency Currency
+     * @param storage Storage
+     */
+    static clearWith(currency: string, storage?: IStorage): void;
+    /**
+     * Owner data
+     * 所有者信息
+     */
+    owner?: ShoppingCartOwner;
+    /**
+     * ISO currency id
+     * 标准货币编号
+     */
+    readonly currency: string;
+    /**
+     * Items
+     * 项目
+     */
+    readonly items: T[];
+    /**
+     * Order level promotions
+     * 订单层面促销
+     */
+    readonly promotions: ShoppingPromotion[];
+    /**
+     * Related form data
+     * 关联的表单数据
+     */
+    formData: any;
+    /**
+     * Currency symbol
+     * 币种符号
+     */
+    readonly symbol: string | undefined;
+    /**
+     * Cart identifier
+     * 购物篮标识
+     */
+    private readonly identifier;
+    /**
+     * Lines count
+     * 项目数量
+     */
+    get lines(): number;
+    /**
+     * Total qty
+     * 总数量
+     */
+    get totalQty(): number;
+    /**
+     * Total amount
+     * 总金额
+     */
+    get totalAmount(): number;
+    /**
+     * Total amount string
+     * 总金额字符串
+     */
+    get totalAmountStr(): string;
+    /**
+     * Cached prices
+     * 缓存的价格
+     */
+    private readonly prices;
+    /**
+     * Onchange callback
+     * 改变时回调
+     */
+    onChange?: (reason: ShoppingCartChangeReason, changedItems: T[]) => void;
+    /**
+     * Constructor
+     * 构造函数
+     * @param currency Currency ISO code
+     * @param storage Data storage
+     */
+    constructor(currency: string, storage?: IStorage);
+    /**
+     * Constructor
+     * 构造函数
+     * @param state Initialization state
+     * @param storage Data storage
+     */
+    constructor(state: ShoppingCartData<T>, storage?: IStorage);
+    private doChange;
+    /**
+     * Add item
+     * 添加项目
+     * @param item New item
+     */
+    addItem(item: T): void;
+    /**
+     * Add items
+     * @param items New items
+     */
+    addItems(items: T[]): void;
+    /**
+     * Cache price
+     * @param id Item id
+     * @param price Price
+     */
+    cachePrice(id: T['id'], price: number): void;
+    /**
+     * Clear storage
+     * @param keepOwner Keep owner data
+     */
+    clear(keepOwner?: boolean): void;
+    /**
+     * Format amount
+     * @param amount Amount
+     * @returns Result
+     */
+    formatAmount(amount: number): string;
+    /**
+     * Get item
+     * @param id Item id
+     * @returns Result
+     */
+    getItem(id: T['id']): T | undefined;
+    /**
+     * Reset
+     * @param item Shopping cart item
+     */
+    reset(item: ShoppingCartItem): void;
+    /**
+     * Save cart data
+     * @param persisted For persisted storage
+     */
+    save(persisted?: boolean): ShoppingCartData<T> | undefined;
+    /**
+     * Trigger update
+     * 触发更新
+     */
+    update(): void;
+    /**
+     * Update discount
+     * @param item Shopping cart item
+     */
+    updateDiscount(item: ShoppingCartItem): void;
+    /**
+     * Update item
+     * 更新项目
+     * @param id Product id
+     * @param qty Qty
+     * @param itemCreator New item creator
+     * @returns Updated or not
+     */
+    updateItem(id: T['id'], qty: number | undefined, itemCreator?: () => Omit<T, 'id' | 'price' | 'qty' | 'subtotal' | 'discount' | 'promotions'>): boolean;
+    /**
+     * Update price
+     * @param id Item id
+     * @param price New price
+     */
+    updatePrice(id: T['id'], price: number): void;
+    /**
+     * Update title
+     * @param id Item id
+     * @param title New title
+     */
+    updateTitle(id: T['id'], title: string): void;
+}

package/lib/mjs/business/ShoppingCart.js

@@ -0,0 +1,302 @@
+import { NumberUtils, WindowStorage } from '@etsoo/shared';
+/**
+ * Shopping cart
+ * 购物篮
+ */
+export class ShoppingCart {
+    /**
+     * Create identifier key
+     * 创建识别键
+     * @param currency Currency
+     * @returns Result
+     */
+    static createKey(currency) {
+        return `ETSOO-CART-${currency}`;
+    }
+    /**
+     * Clear shopping cart
+     * 清除购物篮
+     * @param identifier Identifier
+     * @param storage Storage
+     */
+    static clear(identifier, storage) {
+        try {
+            storage.setData(identifier, null);
+            storage.setPersistedData(identifier, null);
+        }
+        catch (error) {
+            console.log('ShoppingCart clear', error);
+        }
+    }
+    /**
+     * Clear shopping cart
+     * 清除购物篮
+     * @param currency Currency
+     * @param storage Storage
+     */
+    static clearWith(currency, storage = new WindowStorage()) {
+        const identifier = this.createKey(currency);
+        this.clear(identifier, storage);
+    }
+    /**
+     * Lines count
+     * 项目数量
+     */
+    get lines() {
+        return this.items.length;
+    }
+    /**
+     * Total qty
+     * 总数量
+     */
+    get totalQty() {
+        return this.items.map((item) => item.qty).sum();
+    }
+    /**
+     * Total amount
+     * 总金额
+     */
+    get totalAmount() {
+        const subtotal = this.items
+            .map((item) => item.subtotal - item.discount)
+            .sum();
+        const discount = this.promotions.sum('amount');
+        return subtotal - discount;
+    }
+    /**
+     * Total amount string
+     * 总金额字符串
+     */
+    get totalAmountStr() {
+        return this.formatAmount(this.totalAmount);
+    }
+    /**
+     * Constructor
+     * 构造函数
+     * @param currency Currency ISO code
+     * @param storage Data storage
+     * @param state Initialization state
+     */
+    constructor(currencyOrState, storage = new WindowStorage()) {
+        var _a;
+        this.storage = storage;
+        /**
+         * Cached prices
+         * 缓存的价格
+         */
+        this.prices = {};
+        const isCurrency = typeof currencyOrState === 'string';
+        this.currency = isCurrency ? currencyOrState : currencyOrState.currency;
+        const key = ShoppingCart.createKey(this.currency);
+        this.identifier = key;
+        this.symbol = NumberUtils.getCurrencySymbol(this.currency);
+        let state;
+        if (isCurrency) {
+            try {
+                state =
+                    (_a = storage.getPersistedObject(key)) !== null && _a !== void 0 ? _a : storage.getObject(key);
+            }
+            catch (error) {
+                console.log('ShoppingCart constructor', error);
+            }
+        }
+        else {
+            state = currencyOrState;
+        }
+        const { owner, items = [], promotions = [], formData } = state !== null && state !== void 0 ? state : {};
+        this.owner = owner;
+        this.items = items;
+        this.promotions = promotions;
+        this.formData = formData;
+    }
+    doChange(reason, changedItems) {
+        if (this.onChange)
+            this.onChange(reason, changedItems);
+    }
+    /**
+     * Add item
+     * 添加项目
+     * @param item New item
+     */
+    addItem(item) {
+        this.addItems([item]);
+    }
+    /**
+     * Add items
+     * @param items New items
+     */
+    addItems(items) {
+        this.items.push(...items);
+        this.doChange('add', items);
+    }
+    /**
+     * Cache price
+     * @param id Item id
+     * @param price Price
+     */
+    cachePrice(id, price) {
+        this.prices[id] = price;
+    }
+    /**
+     * Clear storage
+     * @param keepOwner Keep owner data
+     */
+    clear(keepOwner) {
+        this.items.length = 0;
+        this.promotions.length = 0;
+        if (keepOwner) {
+            this.save();
+        }
+        else {
+            ShoppingCart.clear(this.identifier, this.storage);
+        }
+        this.doChange('clear', []);
+    }
+    /**
+     * Format amount
+     * @param amount Amount
+     * @returns Result
+     */
+    formatAmount(amount) {
+        return NumberUtils.formatMoney(amount, this.currency);
+    }
+    /**
+     * Get item
+     * @param id Item id
+     * @returns Result
+     */
+    getItem(id) {
+        return this.items.find((item) => item.id === id);
+    }
+    /**
+     * Reset
+     * @param item Shopping cart item
+     */
+    reset(item) {
+        item.discount = 0;
+        item.currentPrice = undefined;
+        item.promotions = [];
+    }
+    /**
+     * Save cart data
+     * @param persisted For persisted storage
+     */
+    save(persisted = true) {
+        if (this.owner == null)
+            return;
+        const { currency, owner, items, promotions, formData } = this;
+        const data = {
+            currency,
+            owner,
+            items,
+            promotions,
+            formData
+        };
+        try {
+            if (persisted) {
+                this.storage.setPersistedData(this.identifier, data);
+            }
+            else {
+                this.storage.setData(this.identifier, data);
+            }
+        }
+        catch (error) {
+            console.log('ShoppingCart save', error);
+        }
+        return data;
+    }
+    /**
+     * Trigger update
+     * 触发更新
+     */
+    update() {
+        this.doChange('update', []);
+    }
+    /**
+     * Update discount
+     * @param item Shopping cart item
+     */
+    updateDiscount(item) {
+        item.discount = item.promotions.sum('amount');
+    }
+    /**
+     * Update item
+     * 更新项目
+     * @param id Product id
+     * @param qty Qty
+     * @param itemCreator New item creator
+     * @returns Updated or not
+     */
+    updateItem(id, qty, itemCreator) {
+        const index = this.items.findIndex((item) => item.id === id);
+        if (qty == null) {
+            // Remove the item
+            if (index !== -1) {
+                const removedItems = this.items.splice(index, 1);
+                this.doChange('remove', removedItems);
+            }
+        }
+        else if (index === -1) {
+            // New
+            if (itemCreator) {
+                const price = this.prices[id];
+                const newItem = {
+                    ...itemCreator(),
+                    id,
+                    price,
+                    qty,
+                    subtotal: price * qty,
+                    discount: 0
+                };
+                this.addItem(newItem);
+            }
+            return false;
+        }
+        else {
+            // Update
+            const item = this.items[index];
+            const price = item.price;
+            const newItem = {
+                ...item,
+                qty,
+                subtotal: price * qty,
+                discount: 0
+            };
+            this.items.splice(index, 1, newItem);
+            this.doChange('update', [item, newItem]);
+        }
+        return true;
+    }
+    /**
+     * Update price
+     * @param id Item id
+     * @param price New price
+     */
+    updatePrice(id, price) {
+        this.cachePrice(id, price);
+        const index = this.items.findIndex((item) => item.id === id);
+        if (index !== -1) {
+            const item = this.items[index];
+            const qty = item.qty;
+            const newItem = { ...item, price, subtotal: price * qty };
+            this.items.splice(index, 1, newItem);
+            this.doChange('update', [item, newItem]);
+        }
+    }
+    /**
+     * Update title
+     * @param id Item id
+     * @param title New title
+     */
+    updateTitle(id, title) {
+        const index = this.items.findIndex((item) => item.id === id);
+        if (index !== -1) {
+            const item = this.items[index];
+            const newItem = { ...item, title };
+            if (newItem.name === newItem.title)
+                newItem.title = undefined;
+            this.items.splice(index, 1, newItem);
+            this.doChange('title', [item, newItem]);
+        }
+    }
+}

package/lib/mjs/index.d.ts

@@ -22,6 +22,7 @@ export * from './business/DataPrivacy';
 export * from './business/EntityStatus';
 export * from './business/ProductUnit';
 export * from './business/RepeatOption';
+export * from './business/ShoppingCart';
 export * from './def/ListItem';
 export * from './erp/dto/AuditLineDto';
 export * from './erp/dto/CurrencyDto';

package/lib/mjs/index.js

@@ -26,6 +26,7 @@ export * from './business/DataPrivacy';
 export * from './business/EntityStatus';
 export * from './business/ProductUnit';
 export * from './business/RepeatOption';
+export * from './business/ShoppingCart';
 // def
 export * from './def/ListItem';
 // erp dto

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.3.90",
+    "version": "1.3.91",
     "description": "Applications shared TypeScript framework",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",