spree_api 5.5.2 → 5.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d3239fe21ccaa81a45ba98e56cf9729a2a1e19717753acd2a2bc7942486ed65
-  data.tar.gz: 145a65f51b1cf39e0a0e8ed74e1c2a964abce29f2eac0bc6403894bb85ccbde2
+  metadata.gz: e6fe1449422b9662417af9cc9e31ea0b9dc08624e7ad70b0a0e1570cf0f98698
+  data.tar.gz: b859292883306b7128b3057e2df54a298469ea94cb246bb064e58b16e21d9f3c
 SHA512:
-  metadata.gz: f361c60828f3dc8d9e2d67191333ca91947ba5d8cc7c11cb3c93ca691c7cb151cd7db27d9b9fbadea1fcec190709de9de4b61a569bba0c00a9173037659bceba
-  data.tar.gz: 17634d38ca453b81aeac073b9cb77e81d6ed70b621e1f9aadd161060373cf0a70b44a10d91f910e0a5ffc0f28a93e83214e18bfcfaacd57572d702ed3b7d0c2d
+  metadata.gz: d4b81e56588d8ea4afa9756d6d3d128ff11222fd3fe34acf52ffc1715e83a87e58b4749f8b0dcfc7254fedad589133c15b5c828ae1e501b4f94df0bdc753afd3
+  data.tar.gz: 4b28146ceb74aa7114c2ffea51f1fa4b107f5a65c48ed331c59354da6bd5bf99ed38242a298643832622a14e69958c8b4038af72c338430dc5c6ff72acc5b810

data/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

data/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

data/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

data/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

data/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

data/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

data/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

data/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

data/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

data/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

data/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',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.5.2
+  version: 5.5.3
 platform: ruby
 authors:
 - Vendo Connect Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-06 00:00:00.000000000 Z
+date: 2026-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rswag-specs
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.5.2
+        version: 5.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.5.2
+        version: 5.5.3
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -305,6 +305,15 @@ files:
 - app/serializers/spree/api/v3/policy_serializer.rb
 - app/serializers/spree/api/v3/price_history_serializer.rb
 - app/serializers/spree/api/v3/price_serializer.rb
+- app/serializers/spree/api/v3/product_filter_availability_option_serializer.rb
+- app/serializers/spree/api/v3/product_filter_availability_serializer.rb
+- app/serializers/spree/api/v3/product_filter_category_option_serializer.rb
+- app/serializers/spree/api/v3/product_filter_category_serializer.rb
+- app/serializers/spree/api/v3/product_filter_option_serializer.rb
+- app/serializers/spree/api/v3/product_filter_option_value_serializer.rb
+- app/serializers/spree/api/v3/product_filter_price_range_serializer.rb
+- app/serializers/spree/api/v3/product_filter_sort_option_serializer.rb
+- app/serializers/spree/api/v3/product_filters_serializer.rb
 - app/serializers/spree/api/v3/product_publication_serializer.rb
 - app/serializers/spree/api/v3/product_serializer.rb
 - app/serializers/spree/api/v3/promotion_serializer.rb
@@ -355,9 +364,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.5.2
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.5.3
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.5.2
+  source_code_uri: https://github.com/spree/spree/tree/v5.5.3
 post_install_message:
 rdoc_options: []
 require_paths: