@medusajs/medusa 1.3.0 → 1.3.1-alpha.63

package/dist/services/shipping-option.d.ts

@@ -1,11 +1,24 @@
-export default ShippingOptionService;
-declare const ShippingOptionService_base: any;
+import { EntityManager } from "typeorm";
+import { TransactionBaseService } from "../interfaces";
+import { Cart, Order, ShippingMethod, ShippingOption, ShippingOptionPriceType, ShippingOptionRequirement } from "../models";
+import { ShippingMethodRepository } from "../repositories/shipping-method";
+import { ShippingOptionRepository } from "../repositories/shipping-option";
+import { ShippingOptionRequirementRepository } from "../repositories/shipping-option-requirement";
+import { FindConfig, Selector } from "../types/common";
+import { CreateShippingMethodDto, ShippingMethodUpdate, UpdateShippingOptionInput, CreateShippingOptionInput } from "../types/shipping-options";
+import FulfillmentProviderService from "./fulfillment-provider";
+import RegionService from "./region";
 /**
  * Provides layer to manipulate profiles.
- * @extends BaseService
  */
-declare class ShippingOptionService extends ShippingOptionService_base {
-    [x: string]: any;
+declare class ShippingOptionService extends TransactionBaseService<ShippingOptionService> {
+    protected readonly providerService_: FulfillmentProviderService;
+    protected readonly regionService_: RegionService;
+    protected readonly requirementRepository_: typeof ShippingOptionRequirementRepository;
+    protected readonly optionRepository_: typeof ShippingOptionRepository;
+    protected readonly methodRepository_: typeof ShippingMethodRepository;
+    protected manager_: EntityManager;
+    protected transactionManager_: EntityManager | undefined;
     constructor({ manager, shippingOptionRepository, shippingOptionRequirementRepository, shippingMethodRepository, fulfillmentProviderService, regionService, }: {
         manager: any;
         shippingOptionRepository: any;
@@ -14,56 +27,25 @@ declare class ShippingOptionService extends ShippingOptionService_base {
         fulfillmentProviderService: any;
         regionService: any;
     });
-    /** @private @const {EntityManager} */
-    private manager_;
-    /** @private @const {ShippingOptionRepository} */
-    private optionRepository_;
-    /** @private @const {ShippingMethodRepository} */
-    private methodRepository_;
-    /** @private @const {ShippingOptionRequirementRepository} */
-    private requirementRepository_;
-    /** @private @const {ProductService} */
-    private providerService_;
-    /** @private @const {RegionService} */
-    private regionService_;
-    withTransaction(transactionManager: any): ShippingOptionService;
     /**
      * Validates a requirement
-     * @param {ShippingRequirement} requirement - the requirement to validate
+     * @param {ShippingOptionRequirement} requirement - the requirement to validate
      * @param {string} optionId - the id to validate the requirement
-     * @return {ShippingRequirement} a validated shipping requirement
+     * @return {ShippingOptionRequirement} a validated shipping requirement
      */
-    validateRequirement_(requirement: {
-        /**
-         * - one of max_subtotal, min_subtotal
-         */
-        type: string;
-        /**
-         * - the value to match against
-         */
-        amount: number;
-    }, optionId: string): {
-        /**
-         * - one of max_subtotal, min_subtotal
-         */
-        type: string;
-        /**
-         * - the value to match against
-         */
-        amount: number;
-    };
+    validateRequirement_(requirement: ShippingOptionRequirement, optionId?: string | undefined): Promise<ShippingOptionRequirement>;
     /**
      * @param {Object} selector - the query object for find
      * @param {object} config - config object
      * @return {Promise} the result of the find operation
      */
-    list(selector: any, config?: object): Promise<any>;
+    list(selector: Selector<ShippingMethod>, config?: FindConfig<ShippingOption>): Promise<ShippingOption[]>;
     /**
      * @param {Object} selector - the query object for find
      * @param {object} config - config object
      * @return {Promise} the result of the find operation
      */
-    listAndCount(selector: any, config?: object): Promise<any>;
+    listAndCount(selector: Selector<ShippingMethod>, config?: FindConfig<ShippingOption>): Promise<[ShippingOption[], number]>;
     /**
      * Gets a profile by id.
      * Throws in case of DB Error and if profile was not found.
@@ -71,7 +53,10 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      * @param {object} options - the options to get a profile
      * @return {Promise<Product>} the profile document.
      */
-    retrieve(optionId: string, options?: object): Promise<Product>;
+    retrieve(optionId: any, options?: {
+        select?: (keyof ShippingOption)[];
+        relations?: string[];
+    }): Promise<ShippingOption>;
     /**
      * Updates a shipping method's associations. Useful when a cart is completed
      * and its methods should be copied to an order/swap entity.
@@ -79,12 +64,13 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      * @param {object} update - the values to update the method with
      * @return {Promise<ShippingMethod>} the resulting shipping method
      */
-    updateShippingMethod(id: string, update: object): Promise<ShippingMethod>;
+    updateShippingMethod(id: string, update: ShippingMethodUpdate): Promise<ShippingMethod | undefined>;
     /**
      * Removes a given shipping method
      * @param {ShippingMethod | Array<ShippingMethod>} shippingMethods - the shipping method to remove
+     * @returns removed shipping methods
      */
-    deleteShippingMethods(shippingMethods: ShippingMethod | Array<ShippingMethod>): Promise<any>;
+    deleteShippingMethods(shippingMethods: ShippingMethod | ShippingMethod[]): Promise<ShippingMethod[]>;
     /**
      * Creates a shipping method for a given cart.
      * @param {string} optionId - the id of the option to use for the method.
@@ -92,7 +78,7 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      * @param {object} config - the cart to create the shipping method for.
      * @return {ShippingMethod} the resulting shipping method.
      */
-    createShippingMethod(optionId: string, data: object, config: object): ShippingMethod;
+    createShippingMethod(optionId: string, data: object, config: CreateShippingMethodDto): Promise<ShippingMethod>;
     /**
      * Checks if a given option id is a valid option for a cart. If it is the
      * option is returned with the correct price. Throws when region_ids do not
@@ -101,7 +87,7 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      * @param {Cart} cart - the cart object to check against
      * @return {ShippingOption} the validated shipping option
      */
-    validateCartOption(option: object, cart: Cart): ShippingOption;
+    validateCartOption(option: ShippingOption, cart: Cart): ShippingOption | null;
     /**
      * Creates a new shipping option. Used both for outbound and inbound shipping
      * options. The difference is registered by the `is_return` field which
@@ -109,37 +95,14 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      * @param {ShippingOption} data - the data to create shipping options
      * @return {Promise<ShippingOption>} the result of the create operation
      */
-    create(data: ShippingOption): Promise<ShippingOption>;
-    /**
-     * @typedef ShippingOptionPrice
-     * @property {string} type - one of flat_rate, calculated
-     * @property {number} value - the value if available
-     */
+    create(data: CreateShippingOptionInput): Promise<ShippingOption>;
     /**
      * Validates a shipping option price
-     * @param {ShippingOptionPrice} priceType - the price to validate
+     * @param {ShippingOptionPriceType} priceType - the price to validate
      * @param {ShippingOption} option - the option to validate against
-     * @return {Promise<ShippingOptionPrice>} the validated price
+     * @return {Promise<ShippingOptionPriceType>} the validated price
      */
-    validatePriceType_(priceType: {
-        /**
-         * - one of flat_rate, calculated
-         */
-        type: string;
-        /**
-         * - the value if available
-         */
-        value: number;
-    }, option: ShippingOption): Promise<{
-        /**
-         * - one of flat_rate, calculated
-         */
-        type: string;
-        /**
-         * - the value if available
-         */
-        value: number;
-    }>;
+    validatePriceType_(priceType: ShippingOptionPriceType, option: ShippingOption): Promise<ShippingOptionPriceType>;
     /**
      * Updates a profile. Metadata updates and product updates should use
      * dedicated methods, e.g. `setMetadata`, etc. The function
@@ -149,57 +112,28 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      * @param {object} update - an object with the update values.
      * @return {Promise} resolves to the update result.
      */
-    update(optionId: string, update: object): Promise<any>;
+    update(optionId: string, update: UpdateShippingOptionInput): Promise<ShippingOption>;
     /**
      * Deletes a profile with a given profile id.
      * @param {string} optionId - the id of the profile to delete. Must be
      *   castable as an ObjectId
      * @return {Promise} the result of the delete operation.
      */
-    delete(optionId: string): Promise<any>;
-    /**
-     * @typedef ShippingRequirement
-     * @property {string} type - one of max_subtotal, min_subtotal
-     * @property {number} amount - the value to match against
-     */
+    delete(optionId: string): Promise<ShippingOption | void>;
     /**
      * Adds a requirement to a shipping option. Only 1 requirement of each type
      * is allowed.
      * @param {string} optionId - the option to add the requirement to.
-     * @param {ShippingRequirement} requirement - the requirement for the option.
+     * @param {ShippingOptionRequirement} requirement - the requirement for the option.
      * @return {Promise} the result of update
      */
-    addRequirement(optionId: string, requirement: {
-        /**
-         * - one of max_subtotal, min_subtotal
-         */
-        type: string;
-        /**
-         * - the value to match against
-         */
-        amount: number;
-    }): Promise<any>;
+    addRequirement(optionId: string, requirement: ShippingOptionRequirement): Promise<ShippingOption>;
     /**
      * Removes a requirement from a shipping option
      * @param {string} requirementId - the id of the requirement to remove
      * @return {Promise} the result of update
      */
-    removeRequirement(requirementId: string): Promise<any>;
-    /**
-     * Decorates a shipping option.
-     * @param {ShippingOption} optionId - the shipping option to decorate using optionId.
-     * @param {string[]} fields - the fields to include.
-     * @param {string[]} expandFields - fields to expand.
-     * @return {ShippingOption} the decorated ShippingOption.
-     */
-    decorate(optionId: ShippingOption, fields?: string[], expandFields?: string[]): ShippingOption;
-    /**
-     * Dedicated method to set metadata for a shipping option.
-     * @param {object} option - the option to set metadata for.
-     * @param {object} metadata - object for metadata field
-     * @return {Promise} resolves to the updated result.
-     */
-    setMetadata_(option: object, metadata: object): Promise<any>;
+    removeRequirement(requirementId: any): Promise<ShippingOptionRequirement | void>;
     /**
      * Returns the amount to be paid for a shipping method. Will ask the
      * fulfillment provider to calculate the price if the shipping option has the
@@ -211,5 +145,6 @@ declare class ShippingOptionService extends ShippingOptionService_base {
      *   retrieved.
      * @return {Promise<Number>} the price of the shipping option.
      */
-    getPrice_(option: ShippingOption, data: ShippingData, cart: Cart | Order): Promise<number>;
+    getPrice_(option: ShippingOption, data: object, cart: Cart | Order | undefined): Promise<number>;
 }
+export default ShippingOptionService;