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'.

PR Details in order

feat/fulfillment-types
 | 
 | __ 00 fulfillment base <--- This PR #6610 
 |        | __ 01-01 fulfillment-type-shipping       #6614 (old #6579)
 |        | __ 01-02 fulfillment-type-pickup. #6613 (old #6577) 
 |__02 fulfillment-type-impacted-plugins. [carts, products, orders, catalogs] #6615 (old #6582) 
 |__03 placeOrder refactor #6616 (old #6583)

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

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

API-PLUGIN-FULFILLMENT

This is the base plugin, basic features listed below.
Mutations

• createFulfillmentType - this is for internal call only from ff-type plugins (NEW)
• createFulfillmentMethod - this is for internal call only from ff-method plugins (NEW)
• updateFulfillmentType - public mutation which allows to update certain specific fields of the ff-type (NEW)
• updateFulfillmentMethod - public mutation which allows to update certain specific fields of the ff-type (NEW)
• updateFulfillmentOptionsForGroup - Existing code/functionality from the old shipment plugin. This updates the cart with quote details from all available ff-methods for the provided ff-type
• selectFulfillmentOptionForGroup - Existing code/functionality from the old shipment plugin. This updates the cart with one of the selected ff-method from the available quote presented by above mutation.

Queries

• fulfillmentType - returns the ff-type matching the provided ID (NEW)
• fulfillmentTypes - returns all the ff-types (NEW)
• fulfillmentMethods - returns all the ff-methods for the specified ff-type (NEW)
• fulfillmentMethodsWithQuotes - Calls the quote providing functions by collecting them via functionByType. Calls are made only for the specific methods of the provided ff-type.
• getFulfillmentMethodsWithQuotes - Existing code/functionality from the old shipment plugin. Deprecated and calls fulfillmentMethodsWithQuotes internally

Others

• preStartup - extends all impacted schemas mostly with dynamic values for 'allowedValues' (NEW)
• startup - inserts the default 'undecided' entry to the new Fulfillment collection (NEW)
• registration - collects all the "registeredFulfillmentType" from ff-type plugins and adds allRegisteredFulfillmentTypes to context (contextAddition) (NEW)
• util folder - copied over from shipment plugin (Existing code)

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.