Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Adds serializers for Store API product filters (#14277)

ifizza23e7ffe86a98
diff --git a/packages/sdk/src/types/generated/ProductFilterAvailability.ts b/packages/sdk/src/types/generated/ProductFilterAvailability.ts
new file mode 100644
index 0000000000..a5cc2fdd24
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterAvailability.ts
@@ -0,0 +1,12 @@
+// Typelizer digest 95fa9d0e1eb634e9f6a78533b163a8d5
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {ProductFilterAvailabilityOption} from '@/types'
+
+interface ProductFilterAvailability {
+ id: string;
+ type: 'availability';
+ options: Array<ProductFilterAvailabilityOption>;
+}
+
+export default ProductFilterAvailability;
diff --git a/packages/sdk/src/types/generated/ProductFilterAvailabilityOption.ts b/packages/sdk/src/types/generated/ProductFilterAvailabilityOption.ts
new file mode 100644
index 0000000000..094e54eebf
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterAvailabilityOption.ts
@@ -0,0 +1,10 @@
+// Typelizer digest 55cf1d7d82e3023e844ac6a1be1603e4
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface ProductFilterAvailabilityOption {
+ id: 'in_stock' | 'out_of_stock';
+ count: number;
+}
+
+export default ProductFilterAvailabilityOption;
diff --git a/packages/sdk/src/types/generated/ProductFilterCategory.ts b/packages/sdk/src/types/generated/ProductFilterCategory.ts
new file mode 100644
index 0000000000..bd78a922a7
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterCategory.ts
@@ -0,0 +1,12 @@
+// Typelizer digest dc7ad8098045ea2a63af79dd40f5a1d5
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {ProductFilterCategoryOption} from '@/types'
+
+interface ProductFilterCategory {
+ id: string;
+ type: 'category';
+ options: Array<ProductFilterCategoryOption>;
+}
+
+export default ProductFilterCategory;
diff --git a/packages/sdk/src/types/generated/ProductFilterCategoryOption.ts b/packages/sdk/src/types/generated/ProductFilterCategoryOption.ts
new file mode 100644
index 0000000000..06941cbd97
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterCategoryOption.ts
@@ -0,0 +1,12 @@
+// Typelizer digest e00d5b6e18c9fb25318ed9cd733dadc8
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface ProductFilterCategoryOption {
+ id: string;
+ name: string;
+ permalink: string;
+ count: number;
+}
+
+export default ProductFilterCategoryOption;
diff --git a/packages/sdk/src/types/generated/ProductFilterOption.ts b/packages/sdk/src/types/generated/ProductFilterOption.ts
new file mode 100644
index 0000000000..bc7f1595a9
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterOption.ts
@@ -0,0 +1,15 @@
+// Typelizer digest 99cb5b59ce478cbe9577520b47aa9b24
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {ProductFilterOptionValue} from '@/types'
+
+interface ProductFilterOption {
+ id: string;
+ type: 'option';
+ name: string;
+ label: string;
+ kind: string;
+ options: Array<ProductFilterOptionValue>;
+}
+
+export default ProductFilterOption;
diff --git a/packages/sdk/src/types/generated/ProductFilterOptionValue.ts b/packages/sdk/src/types/generated/ProductFilterOptionValue.ts
new file mode 100644
index 0000000000..326496a882
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterOptionValue.ts
@@ -0,0 +1,15 @@
+// Typelizer digest 82ea988a16e112068d8ea90d650f6918
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface ProductFilterOptionValue {
+ id: string;
+ name: string;
+ label: string;
+ position: number;
+ color_code: string | null;
+ image_url: string | null;
+ count: number;
+}
+
+export default ProductFilterOptionValue;
diff --git a/packages/sdk/src/types/generated/ProductFilterPriceRange.ts b/packages/sdk/src/types/generated/ProductFilterPriceRange.ts
new file mode 100644
index 0000000000..9399874a7f
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterPriceRange.ts
@@ -0,0 +1,13 @@
+// Typelizer digest 20a24a200790cfa21c817870c92a59b0
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface ProductFilterPriceRange {
+ id: string;
+ type: 'price_range';
+ min: number;
+ max: number;
+ currency: string;
+}
+
+export default ProductFilterPriceRange;
diff --git a/packages/sdk/src/types/generated/ProductFilterSortOption.ts b/packages/sdk/src/types/generated/ProductFilterSortOption.ts
new file mode 100644
index 0000000000..a4623c6f45
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilterSortOption.ts
@@ -0,0 +1,9 @@
+// Typelizer digest 22213cc47cc63b7e426e559c3be7e787
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface ProductFilterSortOption {
+ id: string;
+}
+
+export default ProductFilterSortOption;
diff --git a/packages/sdk/src/types/generated/ProductFilters.ts b/packages/sdk/src/types/generated/ProductFilters.ts
new file mode 100644
index 0000000000..b6b75ad9ca
--- /dev/null
+++ b/packages/sdk/src/types/generated/ProductFilters.ts
@@ -0,0 +1,14 @@
+// Typelizer digest 8113f41f615f883942fd9fe6a5e46f2a
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {ProductFilterPriceRange, ProductFilterAvailability, ProductFilterOption, ProductFilterCategory, ProductFilterSortOption} from '@/types'
+
+interface ProductFilters {
+ id: string;
+ default_sort: string;
+ total_count: number;
+ filters: Array<ProductFilterPriceRange | ProductFilterAvailability | ProductFilterOption | ProductFilterCategory>;
+ sort_options: Array<ProductFilterSortOption>;
+}
+
+export default ProductFilters;
diff --git a/packages/sdk/src/types/generated/index.ts b/packages/sdk/src/types/generated/index.ts
index 43bd0eda87..77dacf237c 100644
--- a/packages/sdk/src/types/generated/index.ts
+++ b/packages/sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 62abadc4940a9933fc2882ec3b1eda4b
+// Typelizer digest 9b1789c87f8132e83201b9c260b20a5a
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -36,6 +36,15 @@ export type { default as PaymentSource } from './PaymentSource'
export type { default as Policy } from './Policy'
export type { default as PriceHistory } from './PriceHistory'
export type { default as Price } from './Price'
+export type { default as ProductFilterAvailabilityOption } from './ProductFilterAvailabilityOption'
+export type { default as ProductFilterAvailability } from './ProductFilterAvailability'
+export type { default as ProductFilterCategoryOption } from './ProductFilterCategoryOption'
+export type { default as ProductFilterCategory } from './ProductFilterCategory'
+export type { default as ProductFilterOption } from './ProductFilterOption'
+export type { default as ProductFilterOptionValue } from './ProductFilterOptionValue'
+export type { default as ProductFilterPriceRange } from './ProductFilterPriceRange'
+export type { default as ProductFilterSortOption } from './ProductFilterSortOption'
+export type { default as ProductFilters } from './ProductFilters'
export type { default as ProductPublication } from './ProductPublication'
export type { default as Product } from './Product'
export type { default as Promotion } from './Promotion'
diff --git a/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb b/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb
index 16df648b96..8daf57206a 100644
--- a/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb
@@ -14,17 +14,18 @@ module Spree
filters: (search_filters || {}).merge('_category' => category)
)
- {
- filters: result.filters,
- sort_options: result.sort_options,
- default_sort: result.default_sort,
- total_count: result.total_count
- }
+ serialize_resource(result)
end
render json: json
end
+ protected
+
+ def serializer_class
+ Spree.api.product_filters_serializer
+ end
+
private
def filters_cache_key
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_availability_option_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_availability_option_serializer.rb
new file mode 100644
index 0000000000..99e0c1ac35
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_availability_option_serializer.rb
@@ -0,0 +1,11 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterAvailabilityOptionSerializer < BaseSerializer
+ typelize id: [:string, enum: %w[in_stock out_of_stock]], count: :number
+
+ attributes :id, :count
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_availability_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_availability_serializer.rb
new file mode 100644
index 0000000000..b434b2f1ab
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_availability_serializer.rb
@@ -0,0 +1,15 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterAvailabilitySerializer < BaseSerializer
+ typelize id: :string,
+ type: "'availability'",
+ options: [:ProductFilterAvailabilityOption, multi: true]
+
+ attributes :id, :type
+
+ many :options, resource: proc { Spree.api.product_filter_availability_option_serializer }
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_category_option_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_category_option_serializer.rb
new file mode 100644
index 0000000000..682a2fb74a
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_category_option_serializer.rb
@@ -0,0 +1,14 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterCategoryOptionSerializer < BaseSerializer
+ typelize id: :string,
+ name: :string,
+ permalink: :string,
+ count: :number
+
+ attributes :id, :name, :permalink, :count
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_category_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_category_serializer.rb
new file mode 100644
index 0000000000..d2c2dcbdf3
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_category_serializer.rb
@@ -0,0 +1,15 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterCategorySerializer < BaseSerializer
+ typelize id: :string,
+ type: "'category'",
+ options: [:ProductFilterCategoryOption, multi: true]
+
+ attributes :id, :type
+
+ many :options, resource: proc { Spree.api.product_filter_category_option_serializer }
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_option_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_option_serializer.rb
new file mode 100644
index 0000000000..41cb068527
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_option_serializer.rb
@@ -0,0 +1,18 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterOptionSerializer < BaseSerializer
+ typelize id: :string,
+ type: "'option'",
+ name: :string,
+ label: :string,
+ kind: :string,
+ options: [:ProductFilterOptionValue, multi: true]
+
+ attributes :id, :type, :name, :label, :kind
+
+ many :options, resource: proc { Spree.api.product_filter_option_value_serializer }
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_option_value_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_option_value_serializer.rb
new file mode 100644
index 0000000000..95294cbc00
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_option_value_serializer.rb
@@ -0,0 +1,17 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterOptionValueSerializer < BaseSerializer
+ typelize id: :string,
+ name: :string,
+ label: :string,
+ position: :number,
+ color_code: [:string, nullable: true],
+ image_url: [:string, nullable: true],
+ count: :number
+
+ attributes :id, :name, :label, :position, :color_code, :image_url, :count
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_price_range_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_price_range_serializer.rb
new file mode 100644
index 0000000000..59d1974bdd
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_price_range_serializer.rb
@@ -0,0 +1,15 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterPriceRangeSerializer < BaseSerializer
+ typelize id: :string,
+ type: "'price_range'",
+ min: :number,
+ max: :number,
+ currency: :string
+
+ attributes :id, :type, :min, :max, :currency
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filter_sort_option_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filter_sort_option_serializer.rb
new file mode 100644
index 0000000000..1f99106869
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filter_sort_option_serializer.rb
@@ -0,0 +1,11 @@
+module Spree
+ module Api
+ module V3
+ class ProductFilterSortOptionSerializer < BaseSerializer
+ typelize id: :string
+
+ attributes :id
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/product_filters_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_filters_serializer.rb
new file mode 100644
index 0000000000..41bef6ec9a
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/product_filters_serializer.rb
@@ -0,0 +1,36 @@
+module Spree
+ module Api
+ module V3
+ class ProductFiltersSerializer < BaseSerializer
+ typelize default_sort: :string,
+ total_count: :number,
+ filters: 'Array<ProductFilterPriceRange | ProductFilterAvailability | ProductFilterOption | ProductFilterCategory>',
+ sort_options: [:ProductFilterSortOption, { multi: true }]
+
+ attributes :default_sort, :total_count
+
+ attribute :filters do |result|
+ result.filters.filter_map do |filter|
+ filter_type = filter[:type]
+ serializer_class = case filter_type
+ when 'price_range'
+ Spree.api.product_filter_price_range_serializer
+ when 'availability'
+ Spree.api.product_filter_availability_serializer
+ when 'option'
+ Spree.api.product_filter_option_serializer
+ when 'category'
+ Spree.api.product_filter_category_serializer
+ else
+ raise ArgumentError, "Unknown filter type: #{filter_type.inspect}"
+ end
+
+ serializer_class.new(filter, params: params).serializable_hash
+ end
+ end
+
+ many :sort_options, resource: proc { Spree.api.product_filter_sort_option_serializer }
+ end
+ end
+ end
+end
diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rb
index 25988cbbe9..b828634638 100644
--- a/spree/api/lib/spree/api/dependencies.rb
+++ b/spree/api/lib/spree/api/dependencies.rb
@@ -136,6 +136,15 @@ module Spree
custom_field_serializer: 'Spree::Api::V3::CustomFieldSerializer',
shipping_category_serializer: 'Spree::Api::V3::ShippingCategorySerializer',
tax_category_serializer: 'Spree::Api::V3::TaxCategorySerializer',
+ product_filters_serializer: 'Spree::Api::V3::ProductFiltersSerializer',
+ product_filter_price_range_serializer: 'Spree::Api::V3::ProductFilterPriceRangeSerializer',
+ product_filter_availability_serializer: 'Spree::Api::V3::ProductFilterAvailabilitySerializer',
+ product_filter_availability_option_serializer: 'Spree::Api::V3::ProductFilterAvailabilityOptionSerializer',
+ product_filter_option_serializer: 'Spree::Api::V3::ProductFilterOptionSerializer',
+ product_filter_option_value_serializer: 'Spree::Api::V3::ProductFilterOptionValueSerializer',
+ product_filter_category_serializer: 'Spree::Api::V3::ProductFilterCategorySerializer',
+ product_filter_category_option_serializer: 'Spree::Api::V3::ProductFilterCategoryOptionSerializer',
+ product_filter_sort_option_serializer: 'Spree::Api::V3::ProductFilterSortOptionSerializer',
# v3 event serializers (for models without Store API endpoints yet)
asset_serializer: 'Spree::Api::V3::AssetSerializer',
diff --git a/spree/api/spec/serializers/spree/api/v3/product_filters_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/product_filters_serializer_spec.rb
new file mode 100644
index 0000000000..c2d6620fb9
--- /dev/null
+++ b/spree/api/spec/serializers/spree/api/v3/product_filters_serializer_spec.rb
@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::ProductFiltersSerializer do
+ let(:store) { @default_store }
+ let(:result) do
+ Spree::SearchProvider::FiltersResult.new(
+ filters: [
+ { id: 'price', type: 'price_range', min: 10.0, max: 100.0, currency: 'USD' },
+ {
+ id: 'availability',
+ type: 'availability',
+ options: [
+ { id: 'in_stock', count: 2 },
+ { id: 'out_of_stock', count: 0 }
+ ]
+ },
+ {
+ id: 'opt_abc123',
+ type: 'option',
+ name: 'size',
+ label: 'Size',
+ kind: 'dropdown',
+ options: [
+ {
+ id: 'optval_abc123',
+ name: 'small',
+ label: 'S',
+ position: 1,
+ color_code: nil,
+ image_url: nil,
+ count: 1
+ }
+ ]
+ },
+ {
+ id: 'categories',
+ type: 'category',
+ options: [
+ {
+ id: 'ctg_abc123',
+ name: 'Shirts',
+ permalink: 'clothing/shirts',
+ count: 2
+ }
+ ]
+ }
+ ],
+ sort_options: [{ id: 'price' }, { id: '-price' }],
+ default_sort: 'manual',
+ total_count: 5
+ )
+ end
+ let(:base_params) { { store: store, currency: 'USD', locale: 'en' } }
+
+ describe 'store serializer' do
+ subject { described_class.new(result, params: base_params).to_h }
+
+ it 'serializes filter metadata' do
+ expect(subject).to eq(
+ 'filters' => [
+ { 'id' => 'price', 'type' => 'price_range', 'min' => 10.0, 'max' => 100.0, 'currency' => 'USD' },
+ {
+ 'id' => 'availability',
+ 'type' => 'availability',
+ 'options' => [
+ { 'id' => 'in_stock', 'count' => 2 },
+ { 'id' => 'out_of_stock', 'count' => 0 }
+ ]
+ },
+ {
+ 'id' => 'opt_abc123',
+ 'type' => 'option',
+ 'name' => 'size',
+ 'label' => 'Size',
+ 'kind' => 'dropdown',
+ 'options' => [
+ {
+ 'id' => 'optval_abc123',
+ 'name' => 'small',
+ 'label' => 'S',
+ 'position' => 1,
+ 'color_code' => nil,
+ 'image_url' => nil,
+ 'count' => 1
+ }
+ ]
+ },
+ {
+ 'id' => 'categories',
+ 'type' => 'category',
+ 'options' => [
+ {
+ 'id' => 'ctg_abc123',
+ 'name' => 'Shirts',
+ 'permalink' => 'clothing/shirts',
+ 'count' => 2
+ }
+ ]
+ }
+ ],
+ 'id' => nil,
+ 'sort_options' => [{ 'id' => 'price' }, { 'id' => '-price' }],
+ 'default_sort' => 'manual',
+ 'total_count' => 5
+ )
+ end
+
+ it 'raises for unknown filter types' do
+ invalid_result = Spree::SearchProvider::FiltersResult.new(
+ filters: [{ type: 'unknown' }],
+ sort_options: [],
+ default_sort: 'manual',
+ total_count: 0
+ )
+
+ expect {
+ described_class.new(invalid_result, params: base_params).to_h
+ }.to raise_error(ArgumentError, 'Unknown filter type: "unknown"')
+ end
+ end
+end