@unchainedshop/core-delivery

Delivery provider module for the Unchained Engine. Manages delivery providers, shipping methods, and delivery processing.

Installation

npm install @unchainedshop/core-delivery

Usage

import { configureDeliveryModule, DeliveryProviderType } from '@unchainedshop/core-delivery';

const deliveryModule = await configureDeliveryModule({ db });

// Create a delivery provider
const providerId = await deliveryModule.create({
  type: DeliveryProviderType.SHIPPING,
  adapterKey: 'shop.unchained.delivery.post',
});

// Find providers for a context
const providers = await deliveryModule.findSupported({
  order: orderObject,
});

API Overview

Module Configuration

| Export | Description | |--------|-------------| | configureDeliveryModule | Configure and return the delivery module |

Queries

| Method | Description | |--------|-------------| | findProvider | Find provider by ID | | findProviders | Find providers with filtering | | count | Count providers | | providerExists | Check if provider exists | | findSupported | Find providers supported for context | | findInterface | Get provider interface definition |

Mutations

| Method | Description | |--------|-------------| | create | Create a new delivery provider | | update | Update provider configuration | | delete | Soft delete a provider |

Constants

| Export | Description | |--------|-------------| | DeliveryProviderType | Provider types (SHIPPING, PICKUP) |

Settings

| Export | Description | |--------|-------------| | deliverySettings | Access delivery module settings |

Types

| Export | Description | |--------|-------------| | DeliveryProvider | Provider document type | | DeliveryModule | Module interface type |

Events

| Event | Description | |-------|-------------| | DELIVERY_PROVIDER_CREATE | Provider created | | DELIVERY_PROVIDER_UPDATE | Provider updated | | DELIVERY_PROVIDER_REMOVE | Provider deleted |

License

EUPL-1.2