@stamhoofd/structures 1.12.8 → 2.1.1

package/dist/src/webshops/CartItem.d.ts

@@ -0,0 +1,139 @@
+import { AutoEncoder, PartialWithoutMethods } from '@simonbackx/simple-encoding';
+import { SimpleError, SimpleErrors } from '@simonbackx/simple-errors';
+import { CartReservedSeat } from '../SeatingPlan';
+import { StockDefinition } from './CartStockHelper';
+import { Option, OptionMenu, Product, ProductPrice } from './Product';
+import { Webshop } from './Webshop';
+import { WebshopFieldAnswer } from './WebshopField';
+import { ProductDiscountSettings } from './Discount';
+import { Cart } from './Cart';
+export declare class CartItemPrice extends AutoEncoder {
+    price: number;
+    fixedDiscount: number;
+    percentageDiscount: number;
+    get discountedPrice(): number;
+}
+export declare class CartItemOption extends AutoEncoder {
+    option: Option;
+    optionMenu: OptionMenu;
+}
+export declare class CartItem extends AutoEncoder {
+    id: string;
+    product: Product;
+    productPrice: ProductPrice;
+    options: CartItemOption[];
+    fieldAnswers: WebshopFieldAnswer[];
+    seats: CartReservedSeat[];
+    amount: number;
+    /**
+     * Discounts that are actually applied
+     */
+    discounts: ProductDiscountSettings[];
+    /**
+     * When an order is correctly placed, we store the reserved amount in the stock here.
+     * We need this to check the stock changes when an order is edited after placement.
+     */
+    reservedAmount: number;
+    /**
+     * Holds a list of what we reserved a stock for (which produce prices and which options specifically so we don't reserve the same thing multiple times or revert when it wasn't reserved earlier)
+     */
+    reservedOptions: Map<string, number>;
+    /**
+     * Holds a list of what we reserved a stock for (which produce prices and which options specifically so we don't reserve the same thing multiple times or revert when it wasn't reserved earlier)
+     */
+    reservedPrices: Map<string, number>;
+    /**
+     * When the seats are successfully reserved, we store them here
+     * This makes editing seats possible because we know we can still use these seats even if they are blocked normally
+     */
+    reservedSeats: CartReservedSeat[];
+    /**
+     * @deprecated
+     * Saved unitPrice (migration needed)
+     */
+    unitPrice: number | null;
+    /**
+     * Detailed list of prices
+     */
+    calculatedPrices: CartItemPrice[];
+    /**
+     * Show an error in the cart for recovery
+     */
+    cartError: SimpleError | SimpleErrors | null;
+    /**
+     * @deprecated
+     */
+    get price(): number | null;
+    getReservedAmountPrice(priceId: string): number;
+    getReservedAmountOption(optionId: string): number;
+    static createDefault(product: Product, cart: Cart, webshop: Webshop, data: {
+        admin: boolean;
+    }): CartItem;
+    static create<T extends typeof AutoEncoder>(this: T, object: PartialWithoutMethods<CartItem>): InstanceType<T>;
+    /**
+     * Unique identifier to check if two cart items are the same
+     */
+    get code(): string;
+    get codeWithoutFields(): string;
+    /**
+     * Return total amount of same product in the given cart. Always includes the current item, even when it isn't in the cart. Doesn't count it twice
+     */
+    getTotalAmount(cart: Cart): number;
+    /**
+     * Note: this resets any discounts that are applied to the cart item
+     */
+    calculatePrices(cart: Cart): void;
+    private calculateUnitPrice;
+    /**
+     * @deprecated
+     * Use this method if you need temporary prices in case it is not yet calculated
+     */
+    getUnitPrice(cart: Cart): number;
+    getPriceWithDiscounts(): number;
+    getPriceWithoutDiscounts(): number;
+    /**
+     * @deprecated: use other systems
+     * Prices that are only applicable to some amount, but not all (e.g. seat extra prices)
+     */
+    getPartialExtraPrice(cart: Cart): number;
+    /**
+     * @deprecated use getPriceWithDiscounts instead for clarity
+     */
+    getPrice(): number;
+    private getUnitPriceCombinationsWithoutDiscount;
+    private getUnitPriceCombinationsWithDiscount;
+    get formattedAmount(): string | null;
+    /**
+     * Without discounts
+     */
+    getFormattedPriceWithoutDiscount(): string;
+    getFormattedPriceWithDiscount(): string | null;
+    private priceCombinationToString;
+    /**
+     * Used for statistics
+     */
+    get descriptionWithoutFields(): string;
+    get descriptionWithoutDate(): string;
+    get description(): string;
+    validateAnswers(): void;
+    /**
+     * Update self to the newest available data, and throw error if something failed (only after refreshing other ones)
+     */
+    refresh(webshop: Webshop): void;
+    getFixedStockDefinitions(oldItem: CartItem | null | undefined, cart: Cart, webshop: Webshop, admin: boolean): StockDefinition[];
+    /**
+     * Return all the stock definitions for this cart item with the currently selected options
+     * = calculate how much you can order with these options
+     */
+    getAvailableStock(oldItem: CartItem | null | undefined, cart: Cart, webshop: Webshop, admin: boolean): StockDefinition[];
+    getMaximumRemaining(oldItem: CartItem | null | undefined, cart: Cart, webshop: Webshop, admin: boolean): number | null;
+    /**
+     * Update self to the newest available data and throw if it was not able to recover
+     */
+    validate(webshop: Webshop, cart: Cart, { refresh, admin, validateSeats }?: {
+        refresh?: boolean;
+        admin?: boolean;
+        validateSeats?: boolean;
+    }): void;
+}
+//# sourceMappingURL=CartItem.d.ts.map

package/dist/src/webshops/CartItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CartItem.d.ts","sourceRoot":"","sources":["../../../src/webshops/CartItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAqC,qBAAqB,EAAgC,MAAM,6BAA6B,CAAC;AAChK,OAAO,EAAiC,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAIrG,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAe,MAAM,WAAW,CAAC;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAmB,uBAAuB,EAA0B,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,qBAAa,aAAc,SAAQ,WAAW;IAE1C,KAAK,SAAK;IAGV,aAAa,SAAK;IAGlB,kBAAkB,SAAK;IAEvB,IAAI,eAAe,WAKlB;CACJ;AAED,qBAAa,cAAe,SAAQ,WAAW;IAE3C,MAAM,EAAE,MAAM,CAAC;IAGf,UAAU,EAAE,UAAU,CAAC;CAC1B;AAED,qBAAa,QAAS,SAAQ,WAAW;IAMrC,EAAE,EAAE,MAAM,CAAC;IAGX,OAAO,EAAE,OAAO,CAAC;IAGjB,YAAY,EAAE,YAAY,CAAC;IAG3B,OAAO,EAAE,cAAc,EAAE,CAAK;IAG9B,YAAY,EAAE,kBAAkB,EAAE,CAAK;IAGvC,KAAK,EAAE,gBAAgB,EAAE,CAAK;IAG9B,MAAM,SAAK;IAEX;;OAEG;IAEH,SAAS,EAAE,uBAAuB,EAAE,CAAK;IAEzC;;;OAGG;IAEH,cAAc,SAAK;IAEnB;;OAEG;IAEH,eAAe,sBAA6B;IAE5C;;OAEG;IAEH,cAAc,sBAA6B;IAE3C;;;OAGG;IAEH,aAAa,EAAE,gBAAgB,EAAE,CAAK;IAEtC;;;OAGG;IAEH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhC;;OAEG;IAwBH,gBAAgB,EAAE,aAAa,EAAE,CAAK;IAEtC;;OAEG;IACH,SAAS,EAAE,WAAW,GAAC,YAAY,GAAG,IAAI,CAAQ;IAElD;;OAEG;IACH,IAAI,KAAK,kBAER;IAED,sBAAsB,CAAC,OAAO,EAAE,MAAM;IAItC,uBAAuB,CAAC,QAAQ,EAAE,MAAM;IAIxC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;QAAC,KAAK,EAAE,OAAO,CAAA;KAAC,GAAG,QAAQ;IAmDtG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,OAAO,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAuB9G;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAGD,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,IAAI;IAazB;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,IAAI;IAwB1B,OAAO,CAAC,kBAAkB;IAoB1B;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAOhC,qBAAqB,IAAI,MAAM;IAI/B,wBAAwB;IAIxB;;;OAGG;IACH,oBAAoB,CAAC,IAAI,EAAE,IAAI;IAO/B;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB,OAAO,CAAC,uCAAuC;IAU/C,OAAO,CAAC,oCAAoC;IAW5C,IAAI,eAAe,IAAI,MAAM,GAAC,IAAI,CAKjC;IAED;;OAEG;IACH,gCAAgC;IAMhC,6BAA6B,IAAI,MAAM,GAAC,IAAI;IAU5C,OAAO,CAAC,wBAAwB;IA0ChC;;OAEG;IACH,IAAI,wBAAwB,IAAI,MAAM,CAerC;IAED,IAAI,sBAAsB,IAAI,MAAM,CAiBnC;IAED,IAAI,WAAW,IAAI,MAAM,CAOxB;IAED,eAAe;IA0Bf;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO;IAyFxB,wBAAwB,CAAC,OAAO,EAAE,QAAQ,GAAC,IAAI,GAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,eAAe,EAAE;IAI3H;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,QAAQ,GAAC,IAAI,GAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,eAAe,EAAE;IAIpH,mBAAmB,CAAC,OAAO,EAAE,QAAQ,GAAC,IAAI,GAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO;IAIlG;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,aAAa,EAAC,GAAE;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAsD;CAkK7L"}