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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Switch API sort parameter to JSON:API standard (-field notation) (#13737)
Damian Legawiec7648edd9f9aa
diff --git a/docs/api-reference/store-api/querying.mdx b/docs/api-reference/store-api/querying.mdxindex 57e9635760..18c2145809 100644--- a/docs/api-reference/store-api/querying.mdx+++ b/docs/api-reference/store-api/querying.mdx@@ -150,24 +150,24 @@ curl -G 'http://localhost:3000/api/v3/store/products' \## Sorting-Use the `sort` parameter to sort product results. The backend handles routing to the appropriate sort mechanism:+Use the `sort` parameter on any list endpoint. Prefix a field with `-` for descending order (ascending is the default). This follows the [JSON:API sorting convention](https://jsonapi.org/format/#fetching-sorting).<CodeGroup>```typescript SDK-// Sort by price+// Sort by price (low to high)const products = await client.store.products.list({- sort: 'price asc',+ sort: 'price',})-// Sort by best selling+// Sort by price (high to low)const products = await client.store.products.list({- sort: 'best_selling',+ sort: '-price',})-// Sort by name+// Sort by best sellingconst products = await client.store.products.list({- sort: 'name asc',+ sort: 'best_selling',})```@@ -175,12 +175,12 @@ const products = await client.store.products.list({# Sort by price low to highcurl -G 'http://localhost:3000/api/v3/store/products' \-H 'X-Spree-Api-Key: spree_pk_xxx' \- -d 'sort=price+asc'+ -d 'sort=price'-# Sort by best selling+# Sort by price high to lowcurl -G 'http://localhost:3000/api/v3/store/products' \-H 'X-Spree-Api-Key: spree_pk_xxx' \- -d 'sort=best_selling'+ -d 'sort=-price'```</CodeGroup>@@ -191,27 +191,47 @@ curl -G 'http://localhost:3000/api/v3/store/products' \|-------|-------------|| `manual` | Manual sort order (default, uses taxon position) || `best_selling` | Best selling products first |-| `price asc` | Price low to high |-| `price desc` | Price high to low |-| `name asc` | Name A-Z |-| `name desc` | Name Z-A |-| `available_on desc` | Newest first |-| `available_on asc` | Oldest first |+| `price` | Price low to high |+| `-price` | Price high to low |+| `name` | Name A-Z |+| `-name` | Name Z-A |+| `-available_on` | Newest first |+| `available_on` | Oldest first |++### Sorting Other Resources-For other resources, use `q[s]` with standard Ransack column sorts:+The `sort` parameter works on all list endpoints. Use any sortable column name:<CodeGroup>```typescript SDK+// Taxons sorted by nameconst taxons = await client.store.taxons.list({- sort: 'name asc',+ sort: 'name',+})++// Customer orders sorted by most recent+const orders = await client.store.customer.orders.list({+ sort: '-completed_at',+})++// Taxonomies sorted by name descending+const taxonomies = await client.store.taxonomies.list({+ sort: '-name',})``````bash cURL+# Taxons sorted by namecurl -G 'http://localhost:3000/api/v3/store/taxons' \-H 'X-Spree-Api-Key: spree_pk_xxx' \- --data-urlencode 'q[s]=name asc'+ -d 'sort=name'++# Customer orders by most recent+curl -G 'http://localhost:3000/api/v3/store/customer/orders' \+ -H 'X-Spree-Api-Key: spree_pk_xxx' \+ -H 'Authorization: Bearer <token>' \+ -d 'sort=-completed_at'```</CodeGroup>diff --git a/docs/developer/sdk/store/products.mdx b/docs/developer/sdk/store/products.mdxindex de0cf404b7..8f43274dc4 100644--- a/docs/developer/sdk/store/products.mdx+++ b/docs/developer/sdk/store/products.mdx@@ -32,12 +32,12 @@ const products = await client.store.products.list({### Sorting Products-Pass `sort` with one of the supported values:+Pass `sort` with one of the supported values. Prefix with `-` for descending order:```typescriptconst products = await client.store.products.list({- sort: 'price asc', // price asc, price desc, best_selling,- // name asc, name desc, available_on desc, available_on asc+ sort: 'price', // price, -price, best_selling,+ // name, -name, -available_on, available_on});```@@ -68,7 +68,7 @@ const filters = await client.store.products.filters({// { id: 'opttype_abc', type: 'option', name: 'color', presentation: 'Color', options: [...] },// { id: 'taxons', type: 'taxon', options: [{ id: 'txn_abc', name: 'Shirts', permalink: '...', count: 12 }] },// ],-// sort_options: [{ id: 'manual' }, { id: 'price asc' }, { id: 'best_selling' }, ...],+// sort_options: [{ id: 'manual' }, { id: 'price' }, { id: 'best_selling' }, ...],// default_sort: 'manual',// total_count: 85,// }diff --git a/packages/sdk/.changeset/api-sort-notation.md b/packages/sdk/.changeset/api-sort-notation.mdnew file mode 100644index 0000000000..30e3373af8--- /dev/null+++ b/packages/sdk/.changeset/api-sort-notation.md@@ -0,0 +1,5 @@+---+"@spree/sdk": patch+---++Switch API `sort` parameter to JSON:API standard `-field` notation. Use `-price` for descending and `price` for ascending instead of `price desc` / `price asc`. The `sort` parameter is now supported on all list endpoints (products, taxons, orders, taxonomies, etc.).diff --git a/packages/sdk/src/types/index.ts b/packages/sdk/src/types/index.tsindex d1ff3fab8c..b4fe42d202 100644--- a/packages/sdk/src/types/index.ts+++ b/packages/sdk/src/types/index.ts@@ -65,12 +65,14 @@ export interface RegisterParams {export interface ListParams {page?: number;limit?: number;+ /** Sort order. Prefix with - for descending, e.g. '-created_at', 'name'. Comma-separated for multiple fields. */+ sort?: string;/** Associations to expand, e.g. ['variants', 'images'] */expand?: string[];}export interface ProductListParams extends ListParams {- /** Sort: 'price asc', 'price desc', 'best_selling', 'name asc', 'name desc', 'available_on desc', 'available_on asc' */+ /** Sort: 'price', '-price', 'best_selling', 'name', '-name', '-available_on', 'available_on' */sort?: string;/** Full-text search across name and SKU */multi_search?: string;@@ -93,7 +95,7 @@ export interface ProductListParams extends ListParams {}export interface TaxonListParams extends ListParams {- /** Sort order, e.g. 'name asc', 'created_at desc' */+ /** Sort order, e.g. 'name', '-created_at' */sort?: string;/** Filter: name contains */name_cont?: string;diff --git a/packages/sdk/tests/params.test.ts b/packages/sdk/tests/params.test.tsindex 6e84e452d5..6a0b90b163 100644--- a/packages/sdk/tests/params.test.ts+++ b/packages/sdk/tests/params.test.ts@@ -22,14 +22,14 @@ describe('transformListParams', () => {expect(result).toEqual({ expand: '' });});- it('passes through sort param unchanged', () => {- const result = transformListParams({ sort: 'price asc' });- expect(result).toEqual({ sort: 'price asc' });+ it('passes through descending sort param unchanged', () => {+ const result = transformListParams({ sort: '-price' });+ expect(result).toEqual({ sort: '-price' });});- it('passes through custom sort values like price-low-to-high', () => {- const result = transformListParams({ sort: 'price-low-to-high' });- expect(result).toEqual({ sort: 'price-low-to-high' });+ it('passes through ascending sort param unchanged', () => {+ const result = transformListParams({ sort: 'name' });+ expect(result).toEqual({ sort: 'name' });});it('wraps filter keys in q[...]', () => {@@ -83,7 +83,7 @@ describe('transformListParams', () => {page: 1,limit: 12,expand: ['images', 'default_variant'],- sort: 'created_at desc',+ sort: '-created_at',name_cont: 'shirt',price_gte: 20,taxons_id_eq: 'txn_abc123',@@ -92,7 +92,7 @@ describe('transformListParams', () => {page: 1,limit: 12,expand: 'images,default_variant',- sort: 'created_at desc',+ sort: '-created_at','q[name_cont]': 'shirt','q[price_gte]': 20,'q[taxons_id_eq]': 'txn_abc123',diff --git a/spree/api/app/controllers/spree/api/v3/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/resource_controller.rbindex a5f891949b..58a5f4f3bd 100644--- a/spree/api/app/controllers/spree/api/v3/resource_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/resource_controller.rb@@ -119,9 +119,30 @@ module Spree[]end- # Ransack query parameters+ # Ransack query parameters with sort translation.+ # Translates `-field` notation (JSON:API standard) to Ransack `s` format.+ # e.g., sort=-price,name → s=price desc,name ascdef ransack_params- params[:q] || {}+ rp = params[:q]&.to_unsafe_h || params[:q] || {}+ sort_value = sort_param++ if sort_value.present?+ rp = rp.dup unless rp.is_a?(Hash)+ rp['s'] = sort_value.split(',').map { |field|+ if field.start_with?('-')+ "#{field[1..]} desc"+ else+ "#{field} asc"+ end+ }.join(',')+ end++ rp+ end++ # Sort parameter from the request+ def sort_param+ params[:sort]end# Pagination parametersdiff --git a/spree/api/app/controllers/spree/api/v3/store/products_controller.rb b/spree/api/app/controllers/spree/api/v3/store/products_controller.rbindex a246ab62e6..792aa781e1 100644--- a/spree/api/app/controllers/spree/api/v3/store/products_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/products_controller.rb@@ -5,8 +5,8 @@ module Spreeclass ProductsController < ResourceController# Sort values that require special scopes (not plain Ransack column sorts).CUSTOM_SORT_SCOPES = {- 'price asc' => :ascend_by_price,- 'price desc' => :descend_by_price,+ 'price' => :ascend_by_price,+ '-price' => :descend_by_price,'best_selling' => :by_best_selling}.freeze@@ -51,8 +51,8 @@ module Spreeend# Applies sorting from the unified `sort` param.- # Custom values ('price asc', 'best_selling') use product-specific scopes.- # Standard Ransack values ('name asc', 'created_at desc') are passed to q[s].+ # Custom values ('price', '-price', 'best_selling') use product-specific scopes.+ # Standard Ransack values ('name', '-created_at') are handled by base ResourceController.def apply_collection_sort(collection)sort_value = sort_paramreturn collection unless sort_value.present?@@ -64,14 +64,14 @@ module Spreesort_value == 'best_selling' ? sorted.distinct(false).send(scope_method) : sorted.send(scope_method)end- # Inject sort into ransack params when it's a standard Ransack sort+ # Skip base Ransack sort injection for custom sort scopesdef ransack_paramsrp = super- sort_value = sort_param- if sort_value.present? && !CUSTOM_SORT_SCOPES.key?(sort_value)- rp = rp.respond_to?(:to_unsafe_h) ? rp.to_unsafe_h : rp.dup- rp['s'] = sort_value+ # Remove Ransack sort when a custom scope handles it+ if sort_param.present? && CUSTOM_SORT_SCOPES.key?(sort_param)+ rp = rp.is_a?(Hash) ? rp.dup : rp.to_unsafe_h+ rp.delete('s')endrp@@ -79,10 +79,6 @@ module Spreeprivate- def sort_param- params[:sort] || params.dig(:q, :s)- end-def custom_sort_requested?CUSTOM_SORT_SCOPES.key?(sort_param)enddiff --git a/spree/api/app/services/spree/api/v3/filters_aggregator.rb b/spree/api/app/services/spree/api/v3/filters_aggregator.rbindex b5d0ad08ef..3fa8ad817a 100644--- a/spree/api/app/services/spree/api/v3/filters_aggregator.rb+++ b/spree/api/app/services/spree/api/v3/filters_aggregator.rb@@ -2,8 +2,6 @@ module Spreemodule Apimodule V3class FiltersAggregator- SORT_OPTION_IDS = Spree::Taxon::SORT_ORDERS-# @param scope [ActiveRecord::Relation] Base product scope (already filtered by store, availability, taxon, etc.)# @param currency [String] Currency for price range# @param taxon [Spree::Taxon, nil] Optional taxon for default_sort and taxon filtering context@@ -17,7 +15,7 @@ module Spree{filters: build_filters,sort_options: sort_options,- default_sort: @taxon&.sort_order || 'manual',+ default_sort: to_api_sort(@taxon&.sort_order || 'manual'),total_count: @scope.distinct.count}end@@ -34,7 +32,15 @@ module Spreeenddef sort_options- SORT_OPTION_IDS.map { |id| { id: id } }+ Spree::Taxon::SORT_ORDERS.map { |id| { id: to_api_sort(id) } }+ end++ # Converts internal sort format ('price asc') to API format ('price', '-price')+ def to_api_sort(sort_value)+ return sort_value unless sort_value.include?(' ')++ field, direction = sort_value.split(' ', 2)+ direction == 'desc' ? "-#{field}" : fieldenddiff --git a/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rbindex 9ca3724285..bcc737b789 100644--- a/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb@@ -96,8 +96,8 @@ RSpec.describe Spree::Api::V3::Store::Products::FiltersController, type: :controsort_ids = json_response['sort_options'].map { |s| s['id'] }expect(sort_ids).to include(- 'manual', 'best_selling', 'price asc', 'price desc',- 'available_on desc', 'available_on asc', 'name asc', 'name desc'+ 'manual', 'best_selling', 'price', '-price',+ '-available_on', 'available_on', 'name', '-name')end@@ -129,7 +129,7 @@ RSpec.describe Spree::Api::V3::Store::Products::FiltersController, type: :controget :index, params: { taxon_id: taxon.prefixed_id }- expect(json_response['default_sort']).to eq('price asc')+ expect(json_response['default_sort']).to eq('price')endenddiff --git a/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rbindex 3b1ae014a5..b52a200dab 100644--- a/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rb@@ -162,7 +162,7 @@ RSpec.describe Spree::Api::V3::Store::ProductsController, type: :controller doendit 'sorts by price low to high' do- get :index, params: { sort: 'price asc' }+ get :index, params: { sort: 'price' }expect(response).to have_http_status(:ok)prices = json_response['data'].map { |p| p['price']['amount'].to_f }@@ -170,7 +170,7 @@ RSpec.describe Spree::Api::V3::Store::ProductsController, type: :controller doendit 'sorts by price high to low' do- get :index, params: { sort: 'price desc' }+ get :index, params: { sort: '-price' }expect(response).to have_http_status(:ok)prices = json_response['data'].map { |p| p['price']['amount'].to_f }@@ -188,8 +188,8 @@ RSpec.describe Spree::Api::V3::Store::ProductsController, type: :controller doexpect(ids.first).to eq(product2.prefixed_id)end- it 'sorts by name a-z with ransack' do- get :index, params: { q: { s: 'name asc' } }+ it 'sorts by name a-z' do+ get :index, params: { sort: 'name' }expect(response).to have_http_status(:ok)names = json_response['data'].map { |p| p['name'] }diff --git a/spree/api/spec/controllers/spree/api/v3/store/taxons/products_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/taxons/products_controller_spec.rbindex 45a18ecf0a..35391a51df 100644--- a/spree/api/spec/controllers/spree/api/v3/store/taxons/products_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/taxons/products_controller_spec.rb@@ -157,7 +157,7 @@ RSpec.describe Spree::Api::V3::Store::Taxons::ProductsController, type: :controlendit 'sorts by price low to high' do- get :index, params: { taxon_id: taxon.permalink, sort: 'price asc' }+ get :index, params: { taxon_id: taxon.permalink, sort: 'price' }expect(response).to have_http_status(:ok)prices = json_response['data'].map { |p| p['price']['amount'].to_f }@@ -165,15 +165,15 @@ RSpec.describe Spree::Api::V3::Store::Taxons::ProductsController, type: :controlendit 'sorts by price high to low' do- get :index, params: { taxon_id: taxon.permalink, sort: 'price desc' }+ get :index, params: { taxon_id: taxon.permalink, sort: '-price' }expect(response).to have_http_status(:ok)prices = json_response['data'].map { |p| p['price']['amount'].to_f }expect(prices).to eq(prices.sort.reverse)end- it 'sorts by name a-z with ransack' do- get :index, params: { taxon_id: taxon.permalink, q: { s: 'name asc' } }+ it 'sorts by name a-z' do+ get :index, params: { taxon_id: taxon.permalink, sort: 'name' }expect(response).to have_http_status(:ok)names = json_response['data'].map { |p| p['name'] }diff --git a/spree/api/spec/controllers/spree/api/v3/store/taxons_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/taxons_controller_spec.rbindex dd34cf8951..788b50cd0f 100644--- a/spree/api/spec/controllers/spree/api/v3/store/taxons_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/taxons_controller_spec.rb@@ -83,6 +83,31 @@ RSpec.describe Spree::Api::V3::Store::TaxonsController, type: :controller doendend+ context 'sorting' do+ let!(:taxon_b) { create(:taxon, taxonomy: taxonomy, name: 'Bags') }+ let!(:taxon_z) { create(:taxon, taxonomy: taxonomy, name: 'Zippers') }++ it 'sorts by name ascending' do+ get :index, params: { sort: 'name' }++ expect(response).to have_http_status(:ok)+ names = json_response['data'].map { |t| t['name'] }+ bags_index = names.index('Bags')+ zippers_index = names.index('Zippers')+ expect(bags_index).to be < zippers_index+ end++ it 'sorts by name descending' do+ get :index, params: { sort: '-name' }++ expect(response).to have_http_status(:ok)+ names = json_response['data'].map { |t| t['name'] }+ bags_index = names.index('Bags')+ zippers_index = names.index('Zippers')+ expect(zippers_index).to be < bags_index+ end+ end+context 'without API key' dobefore { request.headers['X-Spree-Api-Key'] = nil }diff --git a/spree/api/spec/integration/spree/api/v3/store/customer_orders_spec.rb b/spree/api/spec/integration/spree/api/v3/store/customer_orders_spec.rbindex fdcaa4418e..e02e2ee83b 100644--- a/spree/api/spec/integration/spree/api/v3/store/customer_orders_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/store/customer_orders_spec.rb@@ -28,6 +28,8 @@ RSpec.describe 'Customer Orders API', type: :request, swagger_doc: 'api-referencparameter name: 'Authorization', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: falseparameter name: :limit, in: :query, type: :integer, required: false+ parameter name: :sort, in: :query, type: :string, required: false,+ description: 'Sort order. Prefix with - for descending. Example: -completed_at'parameter name: 'q[state_eq]', in: :query, type: :string, required: false,description: 'Filter by order state'parameter name: 'q[completed_at_gte]', in: :query, type: :string, required: false,diff --git a/spree/api/spec/integration/spree/api/v3/store/products_spec.rb b/spree/api/spec/integration/spree/api/v3/store/products_spec.rbindex 3e10872a92..5892230042 100644--- a/spree/api/spec/integration/spree/api/v3/store/products_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/store/products_spec.rb@@ -34,7 +34,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/storeconst products = await client.store.products.list({page: 1,limit: 25,- sort: 'price asc',+ sort: 'price',name_cont: 'shirt',price_gte: 20,price_lte: 100,@@ -50,7 +50,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/storeparameter name: :limit, in: :query, type: :integer, required: false,description: 'Number of items per page (default: 25, max: 100)'parameter name: :sort, in: :query, type: :string, required: false,- description: 'Sort order. Values: price asc, price desc, best_selling, name asc, name desc, available_on desc, available_on asc'+ description: 'Sort order. Prefix with - for descending. Values: price, -price, best_selling, name, -name, -available_on, available_on'parameter name: 'q[name_cont]', in: :query, type: :string, required: false,description: 'Filter by name containing string'parameter name: 'q[taxons_id_eq]', in: :query, type: :string, required: false,@@ -256,7 +256,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store# Check sort optionssort_ids = data['sort_options'].map { |s| s['id'] }- expect(sort_ids).to include('manual', 'price asc', 'available_on desc')+ expect(sort_ids).to include('manual', 'price', '-available_on')endenddiff --git a/spree/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb b/spree/api/spec/integration/spree/api/v3/store/taxonomies_spec.rbindex eba712c8ac..0d13777f64 100644--- a/spree/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb@@ -27,6 +27,8 @@ RSpec.describe 'Taxonomies API', type: :request, swagger_doc: 'api-reference/stoparameter name: 'x-spree-api-key', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: falseparameter name: :limit, in: :query, type: :integer, required: false+ parameter name: :sort, in: :query, type: :string, required: false,+ description: 'Sort order. Prefix with - for descending. Example: name, -name'parameter name: :expand, in: :query, type: :string, required: false,description: 'Expand root taxon'diff --git a/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb b/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rbindex 686ce6d24c..75968ce785 100644--- a/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb@@ -146,7 +146,7 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.yconst products = await client.store.taxons.products.list('categories/clothing', {page: 1,limit: 25,- sort: 'price asc',+ sort: 'price',with_option_value_ids: ['optval_abc'],})JS@@ -159,7 +159,7 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.yparameter name: :limit, in: :query, type: :integer, required: false,description: 'Number of items per page (default: 25, max: 100)'parameter name: :sort, in: :query, type: :string, required: false,- description: 'Sort order. Values: price asc, price desc, best_selling, name asc, name desc, available_on desc, available_on asc'+ description: 'Sort order. Prefix with - for descending. Values: price, -price, best_selling, name, -name, -available_on, available_on'parameter name: 'q[price_gte]', in: :query, type: :number, required: false,description: 'Filter by minimum price'parameter name: 'q[price_lte]', in: :query, type: :number, required: false,diff --git a/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb b/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rbindex b2cc7ead34..4b8e470387 100644--- a/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb+++ b/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb@@ -36,19 +36,31 @@ RSpec.describe Spree::Api::V3::FiltersAggregator doexpect(result[:filters]).to be_an(Array)end- it 'returns sort_options array' do- expect(result[:sort_options]).to be_an(Array)- expect(result[:sort_options].first).to include(id: 'manual')- end+ describe 'sort options' do+ it 'returns sort_options in API format' do+ sort_ids = result[:sort_options].map { |s| s[:id] }+ expect(sort_ids).to eq(%w[manual best_selling price -price -available_on available_on name -name])+ end- it 'returns default_sort from taxon' do- taxon.update!(sort_order: 'available_on desc')- expect(result[:default_sort]).to eq('available_on desc')- end+ it 'converts ascending internal format to field name' do+ taxon.update!(sort_order: 'price asc')+ expect(result[:default_sort]).to eq('price')+ end++ it 'converts descending internal format to -field' do+ taxon.update!(sort_order: 'available_on desc')+ expect(result[:default_sort]).to eq('-available_on')+ end++ it 'passes through values without direction unchanged' do+ taxon.update!(sort_order: 'best_selling')+ expect(result[:default_sort]).to eq('best_selling')+ end- it 'returns manual as default_sort when no taxon' do- aggregator = described_class.new(scope: scope, currency: currency, taxon: nil)- expect(aggregator.call[:default_sort]).to eq('manual')+ it 'returns manual as default_sort when no taxon' do+ aggregator = described_class.new(scope: scope, currency: currency, taxon: nil)+ expect(aggregator.call[:default_sort]).to eq('manual')+ endendit 'returns total_count' do