This PR is replaced by #6614

Signed-off-by: Sujith mail.sujithvn@gmail.com

Resolves #6471
Impact: breaking
Type: feature

Issue

In the current system, the only way for order fulfillment is via shipping which is hardcoded into the system. We need to introduce the flexibility for users to add their own fulfillment types via plugins.

Solution

We are creating a base fulfillment plugin which would enable other fulfillment types (like shipping, pickup, digital) to be introduced via plugins. Each of the newly introduced fulfillment type plugin would need to have the specific fulfillment methods also to be added as separate plugins. Example, fulfillment type 'pickup' could have fulfillment methods like 'store pickup' and 'curb-side pickup'.

This PR is 2nd entry for 01-01 fulfillment-type-shipping

PR Details in order

feat/fulfillment-types
 | 
 | __ 01 fulfillment base #6570 
 |        | __ 01-01 fulfillment-type-shipping       <--- This PR #6579
 |        | __ 01-02 fulfillment-type-pickup. #6577 
 |__02 fulfillment-type-impacted-plugins. [carts, products, orders, catalogs] #6582 
 |__03 placeOrder refactor #6583 

Existing PRs originally based on the #6480 (to be updated to point to #6570)

We shall change the base branch of the 3 existing PRs (i18n #6545, dataMigration #6544, setDefaultFFtype #6543) to point to 01 fulfillment base

API-PLUGIN-FULFILLMENT-TYPE-SHIPPING

• Registers the 'shipping' as a ff-type via registeredFulfillmentTypes: ["shipping"]
• Inserts the default entry for shipping ff-type in Fulfillment collection

API-PLUGIN-FULFILLMENT-METHOD-SHIPPING-FLAT-RATE

• Mostly copied over from api-plugin-shipment-flat-rate by making certain fixes to adhere to new structure and new DB collections. Fixes are similar to the details provided for the other 2 ff-method plugins below.
• The mutations & queries present were left as it is and it works slightly differently compared to the new mutations/queries that were introduced in api-plugin-fulfillment (which is used by remaining ff-methods)
• Shipping restrictions feature is copied over from existing code. This feature is not added to other ff-methods.

API-PLUGIN-FULFILLMENT-METHOD-SHIPPING-UPS

• getFulfillmentMethodsWithQuotesShippingUPS - returns the quote or equivalent details for the method when called from base ff plugin
• preStartup - extends the union of "methodAdditionalData" with data structure specific to UPS
• startup - Inserts the required ff-method entry into Fulfillment collection
• util/checkAndCreateFulfillmentMethod - confirms existing ff-type entry and adds a new ff-method under it.
• util/calculateUPSRate - dummy function to simulate api providing UPS specific info while returning quotes.
• util/ validateOrderMethodsups - dummy function to simulate UPS specific validations done. Called by prepareOrder.js

Breaking changes

Since this is the new way of handling fulfillment, the existing shipment plugins would not work along with this. User would need to migrate the data (migration script will be developed) and remove the shipment plugins (api-plugin-shipments and api-plugin-shipments-flat-rate).

Testing

All this is new code and at this stage this is not integrated to reaction, meaning the plugins.json is not updated to include this plugin. Hence proper testing can be carried out only after merging in the remaining PRs.