@unchainedshop/core-filters

Filter and search module for the Unchained Engine. Provides product filtering, faceted search, and filter option management.

Installation

``bash
npm install @unchainedshop/core-filters
`

Usage

`typescript
import { configureFiltersModule, FilterType } from '@unchainedshop/core-filters';

const filtersModule = await configureFiltersModule({ db });

// Create a filter
const filterId = await filtersModule.create({
key: 'color',
type: FilterType.MULTI_CHOICE,
});

// Search with filters
const result = await filtersModule.search.searchProducts({
filterQuery: { color: ['red', 'blue'] },
assortmentId: 'category-123',
});
`

API Overview

$3

| Export | Description |
|--------|-------------|
| configureFiltersModule | Configure and return the filters module |

$3

| Method | Description |
|--------|-------------|
| findFilter | Find filter by ID or key |
| findFilters | Find filters with filtering and pagination |
| count | Count filters matching query |
| filterExists | Check if filter exists |

$3

| Method | Description |
|--------|-------------|
| create | Create a new filter |
| update | Update filter data |
| delete | Soft delete a filter |

$3

| Method | Description |
|--------|-------------|
| createFilterOption | Add option to filter |
| updateFilterOption | Update filter option |
| removeFilterOption | Remove filter option |

$3

| Method | Description |
|--------|-------------|
| findFilterTexts | Find localized filter texts |
| updateTexts | Update filter texts |

$3

| Method | Description |
|--------|-------------|
| search.searchProducts | Search products with filters |
| search.searchAssortments | Search assortments |

$3

| Export | Description |
|--------|-------------|
| FilterType | Filter types (SWITCH, SINGLE_CHOICE, MULTI_CHOICE, RANGE) |

$3

| Export | Description |
|--------|-------------|
| filtersSettings | Access filter module settings |

$3

| Export | Description |
|--------|-------------|
| Filter | Filter document type |
| FilterOption | Filter option type |
| FilterQuery | Query parameters type |
| FiltersModule | Module interface type |
| SearchQuery | Search query type |

Events

| Event | Description |
|-------|-------------|
| FILTER_CREATE | Filter created |
| FILTER_UPDATE | Filter updated |
| FILTER_REMOVE` | Filter deleted |

License

EUPL-1.2