@medusajs/medusa 1.2.2-dev.53 → 1.3.1-next.14

package/dist/services/product-variant.d.ts

@@ -1,12 +1,13 @@
 import { BaseService } from "medusa-interfaces";
 import { EntityManager, SelectQueryBuilder } from "typeorm";
+import { PriceSelectionContext } from "../interfaces/price-selection-strategy";
 import { MoneyAmount } from "../models/money-amount";
 import { Product } from "../models/product";
 import { ProductOptionValue } from "../models/product-option-value";
 import { ProductVariant } from "../models/product-variant";
 import { FindWithRelationsOptions, ProductVariantRepository } from "../repositories/product-variant";
 import { FindConfig } from "../types/common";
-import { CreateProductVariantInput, FilterableProductVariantProps, ProductVariantPrice, UpdateProductVariantInput } from "../types/product-variant";
+import { CreateProductVariantInput, FilterableProductVariantProps, GetRegionPriceContext, ProductVariantPrice, UpdateProductVariantInput } from "../types/product-variant";
 /**
  * Provides layer to manipulate product variants.
  * @extends BaseService
@@ -22,9 +23,11 @@ declare class ProductVariantService extends BaseService {
     private productRepository_;
     private eventBus_;
     private regionService_;
+    private priceSelectionStrategy_;
     private moneyAmountRepository_;
     private productOptionValueRepository_;
-    constructor({ manager, productVariantRepository, productRepository, eventBusService, regionService, moneyAmountRepository, productOptionValueRepository, }: {
+    private cartRepository_;
+    constructor({ manager, productVariantRepository, productRepository, eventBusService, regionService, moneyAmountRepository, productOptionValueRepository, cartRepository, priceSelectionStrategy, }: {
         manager: any;
         productVariantRepository: any;
         productRepository: any;
@@ -32,6 +35,8 @@ declare class ProductVariantService extends BaseService {
         regionService: any;
         moneyAmountRepository: any;
         productOptionValueRepository: any;
+        cartRepository: any;
+        priceSelectionStrategy: any;
     });
     withTransaction(transactionManager: EntityManager): ProductVariantService;
     /**
@@ -40,14 +45,14 @@ declare class ProductVariantService extends BaseService {
      * @param {FindConfig<ProductVariant>} config - query config object for variant retrieval.
      * @return {Promise<Product>} the product document.
      */
-    retrieve(variantId: string, config?: FindConfig<ProductVariant>): Promise<ProductVariant>;
+    retrieve(variantId: string, config?: FindConfig<ProductVariant> & PriceSelectionContext): Promise<ProductVariant>;
     /**
      * Gets a product variant by id.
      * @param {string} sku - The unique stock keeping unit used to identify the product variant.
      * @param {FindConfig<ProductVariant>} config - query config object for variant retrieval.
      * @return {Promise<Product>} the product document.
      */
-    retrieveBySKU(sku: string, config?: FindConfig<ProductVariant>): Promise<ProductVariant>;
+    retrieveBySKU(sku: string, config?: FindConfig<ProductVariant> & PriceSelectionContext): Promise<ProductVariant>;
     /**
      * Creates an unpublished product variant. Will validate against parent product
      * to ensure that the variant can in fact be created.
@@ -62,33 +67,41 @@ declare class ProductVariantService extends BaseService {
      * The function will throw, if price updates are attempted.
      * @param {string | ProductVariant} variantOrVariantId - variant or id of a variant.
      * @param {object} update - an object with the update values.
+     * @param {object} config - an object with the config values for returning the variant.
      * @return {Promise} resolves to the update result.
      */
     update(variantOrVariantId: string | Partial<ProductVariant>, update: UpdateProductVariantInput): Promise<ProductVariant>;
-    updateVariantPrices(variantId: string, prices: ProductVariantPrice[]): Promise<void>;
     /**
-     * Sets the default price for the given currency.
-     * @param {string} variantId - the id of the variant to set prices for
-     * @param {ProductVariantPrice} price - the price for the variant
-     * @return {Promise} the result of the update operation
+     * Updates a variant's prices.
+     * Deletes any prices that are not in the update object, and is not associated with a price list.
+     * @param variantId - the id of variant variant
+     * @param prices - the update prices
+     * @returns {Promise<void>} empty promise
      */
-    setCurrencyPrice(variantId: string, price: ProductVariantPrice): Promise<MoneyAmount>;
+    updateVariantPrices(variantId: string, prices: ProductVariantPrice[]): Promise<void>;
     /**
      * Gets the price specific to a region. If no region specific money amount
      * exists the function will try to use a currency price. If no default
      * currency price exists the function will throw an error.
      * @param {string} variantId - the id of the variant to get price from
-     * @param {string} regionId - the id of the region to get price for
+     * @param {GetRegionPriceContext} context - context for getting region price
      * @return {number} the price specific to the region
      */
-    getRegionPrice(variantId: string, regionId: string): Promise<number>;
+    getRegionPrice(variantId: string, context: GetRegionPriceContext): Promise<number>;
     /**
-     * Sets the price of a specific region
+     * Sets the default price of a specific region
      * @param {string} variantId - the id of the variant to update
      * @param {string} price - the price for the variant.
      * @return {Promise} the result of the update operation
      */
     setRegionPrice(variantId: string, price: ProductVariantPrice): Promise<MoneyAmount>;
+    /**
+     * Sets the default price for the given currency.
+     * @param {string} variantId - the id of the variant to set prices for
+     * @param {ProductVariantPrice} price - the price for the variant
+     * @return {Promise} the result of the update operation
+     */
+    setCurrencyPrice(variantId: string, price: ProductVariantPrice): Promise<MoneyAmount>;
     /**
      * Updates variant's option value.
      * Option value must be of type string or number.
@@ -123,13 +136,13 @@ declare class ProductVariantService extends BaseService {
      * @param {FindConfig<ProductVariant>} config - query config object for variant retrieval
      * @return {Promise} the result of the find operation
      */
-    listAndCount(selector: FilterableProductVariantProps, config?: FindConfig<ProductVariant>): Promise<[ProductVariant[], number]>;
+    listAndCount(selector: FilterableProductVariantProps, config?: FindConfig<ProductVariant> & PriceSelectionContext): Promise<[ProductVariant[], number]>;
     /**
      * @param {FilterableProductVariantProps} selector - the query object for find
      * @param {FindConfig<ProductVariant>} config - query config object for variant retrieval
      * @return {Promise} the result of the find operation
      */
-    list(selector: FilterableProductVariantProps, config?: FindConfig<ProductVariant>): Promise<ProductVariant[]>;
+    list(selector: FilterableProductVariantProps, config?: FindConfig<ProductVariant> & PriceSelectionContext): Promise<ProductVariant[]>;
     /**
      * Deletes variant.
      * Will never fail due to delete being idempotent.
@@ -144,7 +157,7 @@ declare class ProductVariantService extends BaseService {
      * @param {Object} metadata - the metadata to set
      * @return {Object} updated metadata object
      */
-    setMetadata_(variant: ProductVariant, metadata: object): Record<string, any>;
+    setMetadata_(variant: ProductVariant, metadata: object): Record<string, unknown>;
     /**
      * Creates a query object to be used for list queries.
      * @param {object} selector - the selector to create the query from
@@ -167,5 +180,16 @@ declare class ProductVariantService extends BaseService {
      *   count of products that matches the query as the second element.
      */
     getFreeTextQueryBuilder_(variantRepo: ProductVariantRepository, query: FindWithRelationsOptions, q?: string): SelectQueryBuilder<ProductVariant>;
+    /**
+     * Set additional prices on a list of variants.
+     * @param {ProductVariant | ProductVariant[] } variant variant on which to set additional prices
+     * @param {string} currency_code currency code to fetch prices for
+     * @param {string} region_id region to fetch prices for
+     * @param {string} cart_id string of cart to use as a basis for getting currency and region
+     * @param {string} customer_id id of potentially logged in customer, used to get prices valid for their customer groups
+     * @param {boolean} include_discount_prices should result include discount pricing
+     * @return {Promise<ProductVariant | ProductVariant[]>} A list of variants with variants decorated with "additional_prices"
+     */
+    setAdditionalPrices(variant: any, currency_code: any, region_id: any, cart_id: any, customer_id: any, include_discount_prices?: boolean): Promise<ProductVariant | ProductVariant[]>;
 }
 export default ProductVariantService;