Skip to main content

Strict Equal Filter

The Strict Equal filter provides simple exact-match filtering on product fields.

Installation​

import '@unchainedshop/plugins/filters/strict-equal';

Adapter Details​

PropertyValue
Keyshop.unchained.filters.strict-qual
Order Index0 (runs first)
Version1.0.0
Sourcefilters/strict-equal.ts

Behavior​

transformProductSelector()​

Transforms the MongoDB selector to match exact values:

// Input: { key: "brand", value: "nike" }
// Output: { brand: "nike" }

// Input: { key: "inStock", value: undefined }
// Output: { inStock: { $exists: true } }

When value is provided, it matches exactly. When value is undefined, it checks field existence.

Use Cases​

Single-Choice Filters​

# Create a brand filter
mutation CreateBrandFilter {
  createFilter(filter: {
    key: "brand"
    type: SINGLE_CHOICE
  }) {
    _id
  }
}
# Add brand options
mutation AddBrandOption {
  createFilterOption(filterId: "...", option: "nike") {
    _id
  }
}

Products must have matching field:

// Product document
{
  _id: "product-1",
  brand: "nike", // Matches filter key
}

Multi-Choice Filters​

mutation {
  createFilter(filter: {
    key: "color"
    type: MULTI_CHOICE
  }) {
    _id
  }
}

Boolean Filters​

mutation {
  createFilter(filter: {
    key: "isOrganic"
    type: SWITCH
  }) {
    _id
  }
}

Query Example​

query FilteredProducts {
  searchProducts(
    filterQuery: [
      { key: "brand", value: "nike" }
      { key: "isOrganic", value: "true" }
    ]
  ) {
    products {
      _id
      texts { title }
    }
    filteredProductsCount
  }
}

Product Field Mapping​

The filter key maps directly to product fields. Common patterns:

Filter KeyProduct FieldExample Value
brandbrand"nike"
colorcolor"blue"
sizesize"M"
categorycategory"clothing"
meta.materialmeta.material"cotton"

Nested Field Filtering​

For nested fields, use dot notation:

filterQuery: [
  { key: "meta.material", value: "cotton" }
  { key: "specs.weight", value: "500g" }
]

Limitations​

  • Exact matching only: No partial matches, ranges, or fuzzy search
  • Case-sensitive: "Nike" ≠ "nike"
  • Single value: Each filter key matches one value

For more complex filtering, create a custom filter adapter or use Local Search for text queries.

Combining with Other Filters​

Strict Equal runs at orderIndex: 0, so it processes first. Subsequent adapters receive its transformed selector:

// Strict Equal output
{ brand: "nike", color: "blue" }

// Next adapter (e.g., Local Search) receives this and can add more conditions
{ brand: "nike", color: "blue", $text: { $search: "running shoes" } }