@medusajs/medusa 1.2.2-dev.56 → 1.3.1-next.24

package/dist/services/cart.d.ts

@@ -1,37 +1,41 @@
 import { EntityManager } from "typeorm";
-import { BaseService } from "medusa-interfaces";
-import { ShippingMethodRepository } from "../repositories/shipping-method";
-import { CartRepository } from "../repositories/cart";
-import { AddressRepository } from "../repositories/address";
-import { PaymentSessionRepository } from "../repositories/payment-session";
+import { TransactionBaseService } from "../interfaces";
+import { IPriceSelectionStrategy } from "../interfaces/price-selection-strategy";
 import { Address } from "../models/address";
 import { Cart } from "../models/cart";
+import { CustomShippingOption } from "../models/custom-shipping-option";
 import { Customer } from "../models/customer";
 import { LineItem } from "../models/line-item";
 import { ShippingMethod } from "../models/shipping-method";
-import { CustomShippingOption } from "../models/custom-shipping-option";
-import { TotalField, FindConfig } from "../types/common";
-import { FilterableCartProps, LineItemUpdate, CartUpdateProps, CartCreateProps } from "../types/cart";
+import { AddressRepository } from "../repositories/address";
+import { CartRepository } from "../repositories/cart";
+import { LineItemRepository } from "../repositories/line-item";
+import { PaymentSessionRepository } from "../repositories/payment-session";
+import { ShippingMethodRepository } from "../repositories/shipping-method";
+import { CartCreateProps, CartUpdateProps, FilterableCartProps, LineItemUpdate } from "../types/cart";
+import { FindConfig, TotalField } from "../types/common";
+import CustomShippingOptionService from "./custom-shipping-option";
+import CustomerService from "./customer";
+import DiscountService from "./discount";
 import EventBusService from "./event-bus";
-import ProductVariantService from "./product-variant";
-import ProductService from "./product";
-import RegionService from "./region";
+import GiftCardService from "./gift-card";
+import InventoryService from "./inventory";
 import LineItemService from "./line-item";
+import LineItemAdjustmentService from "./line-item-adjustment";
 import PaymentProviderService from "./payment-provider";
+import ProductService from "./product";
+import ProductVariantService from "./product-variant";
+import RegionService from "./region";
 import ShippingOptionService from "./shipping-option";
-import CustomerService from "./customer";
 import TaxProviderService from "./tax-provider";
-import DiscountService from "./discount";
-import GiftCardService from "./gift-card";
 import TotalsService from "./totals";
-import InventoryService from "./inventory";
-import CustomShippingOptionService from "./custom-shipping-option";
-declare type CartConstructorProps = {
+declare type InjectedDependencies = {
     manager: EntityManager;
     cartRepository: typeof CartRepository;
     shippingMethodRepository: typeof ShippingMethodRepository;
     addressRepository: typeof AddressRepository;
     paymentSessionRepository: typeof PaymentSessionRepository;
+    lineItemRepository: typeof LineItemRepository;
     eventBusService: EventBusService;
     taxProviderService: TaxProviderService;
     paymentProviderService: PaymentProviderService;
@@ -46,41 +50,46 @@ declare type CartConstructorProps = {
     totalsService: TotalsService;
     inventoryService: InventoryService;
     customShippingOptionService: CustomShippingOptionService;
+    lineItemAdjustmentService: LineItemAdjustmentService;
+    priceSelectionStrategy: IPriceSelectionStrategy;
 };
 declare type TotalsConfig = {
     force_taxes?: boolean;
 };
-declare class CartService extends BaseService {
-    static Events: {
+declare class CartService extends TransactionBaseService<CartService> {
+    static readonly Events: {
         CUSTOMER_UPDATED: string;
         CREATED: string;
         UPDATED: string;
     };
-    private manager_;
-    private shippingMethodRepository_;
-    private cartRepository_;
-    private eventBus_;
-    private productVariantService_;
-    private productService_;
-    private regionService_;
-    private lineItemService_;
-    private paymentProviderService_;
-    private customerService_;
-    private shippingOptionService_;
-    private discountService_;
-    private giftCardService_;
-    private taxProviderService_;
-    private totalsService_;
-    private addressRepository_;
-    private paymentSessionRepository_;
-    private inventoryService_;
-    private customShippingOptionService_;
-    constructor({ manager, cartRepository, shippingMethodRepository, eventBusService, paymentProviderService, productService, productVariantService, taxProviderService, regionService, lineItemService, shippingOptionService, customerService, discountService, giftCardService, totalsService, addressRepository, paymentSessionRepository, inventoryService, customShippingOptionService, }: CartConstructorProps);
-    withTransaction(transactionManager: EntityManager): CartService;
-    transformQueryForTotals_(config: FindConfig<Cart>): FindConfig<Cart> & {
+    protected manager_: EntityManager;
+    protected transactionManager_: EntityManager | undefined;
+    protected readonly shippingMethodRepository_: typeof ShippingMethodRepository;
+    protected readonly cartRepository_: typeof CartRepository;
+    protected readonly addressRepository_: typeof AddressRepository;
+    protected readonly paymentSessionRepository_: typeof PaymentSessionRepository;
+    protected readonly lineItemRepository_: typeof LineItemRepository;
+    protected readonly eventBus_: EventBusService;
+    protected readonly productVariantService_: ProductVariantService;
+    protected readonly productService_: ProductService;
+    protected readonly regionService_: RegionService;
+    protected readonly lineItemService_: LineItemService;
+    protected readonly paymentProviderService_: PaymentProviderService;
+    protected readonly customerService_: CustomerService;
+    protected readonly shippingOptionService_: ShippingOptionService;
+    protected readonly discountService_: DiscountService;
+    protected readonly giftCardService_: GiftCardService;
+    protected readonly taxProviderService_: TaxProviderService;
+    protected readonly totalsService_: TotalsService;
+    protected readonly inventoryService_: InventoryService;
+    protected readonly customShippingOptionService_: CustomShippingOptionService;
+    protected readonly priceSelectionStrategy_: IPriceSelectionStrategy;
+    protected readonly lineItemAdjustmentService_: LineItemAdjustmentService;
+    constructor({ manager, cartRepository, shippingMethodRepository, lineItemRepository, eventBusService, paymentProviderService, productService, productVariantService, taxProviderService, regionService, lineItemService, shippingOptionService, customerService, discountService, giftCardService, totalsService, addressRepository, paymentSessionRepository, inventoryService, customShippingOptionService, lineItemAdjustmentService, priceSelectionStrategy, }: InjectedDependencies);
+    protected transformQueryForTotals_(config: FindConfig<Cart>): FindConfig<Cart> & {
         totalsToSelect: TotalField[];
     };
-    decorateTotals_(cart: Cart, totalsToSelect: TotalField[], options?: TotalsConfig): Promise<Cart>;
+    protected decorateTotals_(cart: Cart, totalsToSelect: TotalField[], options?: TotalsConfig): Promise<Cart>;
     /**
      * @param selector - the query object for find
      * @param config - config object
@@ -116,7 +125,7 @@ declare class CartService extends BaseService {
      * @param lineItem - the line item
      * @return boolean representing wheter shipping method is validated
      */
-    validateLineItemShipping_(shippingMethods: ShippingMethod[], lineItem: LineItem): boolean;
+    protected validateLineItemShipping_(shippingMethods: ShippingMethod[], lineItem: LineItem): boolean;
     /**
      * Adds a line item to the cart.
      * @param cartId - the id of the cart that we will add to
@@ -141,21 +150,21 @@ declare class CartService extends BaseService {
      * @param shouldAdd - flag to indicate, if we should add or remove
      * @return void
      */
-    adjustFreeShipping_(cart: Cart, shouldAdd: boolean): Promise<void>;
-    update(cartId: string, update: CartUpdateProps): Promise<Cart>;
+    protected adjustFreeShipping_(cart: Cart, shouldAdd: boolean): Promise<void>;
+    update(cartId: string, data: CartUpdateProps): Promise<Cart>;
     /**
      * Sets the customer id of a cart
      * @param cart - the cart to add email to
      * @param customerId - the customer to add to cart
      * @return the result of the update operation
      */
-    updateCustomerId_(cart: Cart, customerId: string): Promise<void>;
+    protected updateCustomerId_(cart: Cart, customerId: string): Promise<void>;
     /**
      * Creates or fetches a user based on an email.
      * @param email - the email to use
      * @return the resultign customer object
      */
-    createOrFetchUserFromEmail_(email: string): Promise<Customer>;
+    protected createOrFetchUserFromEmail_(email: string): Promise<Customer>;
     /**
      * Updates the cart's billing address.
      * @param cart - the cart to update
@@ -163,7 +172,7 @@ declare class CartService extends BaseService {
      * @param addrRepo - the repository to use for address updates
      * @return the result of the update operation
      */
-    updateBillingAddress_(cart: Cart, addressOrId: Partial<Address> | string, addrRepo: AddressRepository): Promise<void>;
+    protected updateBillingAddress_(cart: Cart, addressOrId: Partial<Address> | string, addrRepo: AddressRepository): Promise<void>;
     /**
      * Updates the cart's shipping address.
      * @param cart - the cart to update
@@ -171,8 +180,8 @@ declare class CartService extends BaseService {
      * @param addrRepo - the repository to use for address updates
      * @return the result of the update operation
      */
-    updateShippingAddress_(cart: Cart, addressOrId: Partial<Address> | string, addrRepo: AddressRepository): Promise<void>;
-    applyGiftCard_(cart: Cart, code: string): Promise<void>;
+    protected updateShippingAddress_(cart: Cart, addressOrId: Partial<Address> | string, addrRepo: AddressRepository): Promise<void>;
+    protected applyGiftCard_(cart: Cart, code: string): Promise<void>;
     /**
      * Updates the cart's discounts.
      * If discount besides free shipping is already applied, this
@@ -209,7 +218,7 @@ declare class CartService extends BaseService {
      *    this could be IP address or similar for fraud handling.
      * @return the resulting cart
      */
-    authorizePayment(cartId: string, context?: Record<string, any>): Promise<Cart>;
+    authorizePayment(cartId: string, context?: Record<string, unknown>): Promise<Cart>;
     /**
      * Sets a payment method for a cart.
      * @param cartId - the id of the cart to add payment method to
@@ -226,7 +235,7 @@ declare class CartService extends BaseService {
      * @param cartOrCartId - the id of the cart to set payment session for
      * @return the result of the update operation.
      */
-    setPaymentSessions(cartOrCartId: Cart | string): Promise<Cart>;
+    setPaymentSessions(cartOrCartId: Cart | string): Promise<void>;
     /**
      * Removes a payment session from the cart.
      * @param cartId - the id of the cart to remove from
@@ -254,7 +263,7 @@ declare class CartService extends BaseService {
      * @param data - the fulmillment data for the method
      * @return the result of the update operation
      */
-    addShippingMethod(cartId: string, optionId: string, data?: Record<string, any>): Promise<Cart>;
+    addShippingMethod(cartId: string, optionId: string, data?: Record<string, unknown>): Promise<Cart>;
     /**
      * Finds the cart's custom shipping options based on the passed option id.
      * throws if custom options is not empty and no shipping option corresponds to optionId
@@ -263,6 +272,7 @@ declare class CartService extends BaseService {
      * @return custom shipping option
      */
     findCustomShippingOption(cartCustomShippingOptions: CustomShippingOption[], optionId: string): CustomShippingOption | undefined;
+    protected updateUnitPrices_(cart: Cart, regionId?: string, customer_id?: string): Promise<void>;
     /**
      * Set's the region of a cart.
      * @param cart - the cart to set region on
@@ -270,13 +280,13 @@ declare class CartService extends BaseService {
      * @param countryCode - the country code to set the country to
      * @return the result of the update operation
      */
-    setRegion_(cart: Cart, regionId: string, countryCode: string | null): Promise<void>;
+    protected setRegion_(cart: Cart, regionId: string, countryCode: string | null): Promise<void>;
     /**
      * Deletes a cart from the database. Completed carts cannot be deleted.
      * @param cartId - the id of the cart to delete
      * @return the deleted cart or undefined if the cart was not found.
      */
-    delete(cartId: string): Promise<string>;
+    delete(cartId: string): Promise<Cart>;
     /**
      * Dedicated method to set metadata for a cart.
      * To ensure that plugins does not overwrite each
@@ -288,6 +298,7 @@ declare class CartService extends BaseService {
      */
     setMetadata(cartId: string, key: string, value: string | number): Promise<Cart>;
     createTaxLines(id: string): Promise<Cart>;
+    protected refreshAdjustments_(cart: Cart): Promise<void>;
     /**
      * Dedicated method to delete metadata for a cart.
      * @param cartId - the cart to delete metadata from.