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
Use Platform API for fetching and populating select options.
Matthew Kennedyef9e1f90c3fa
diff --git a/api/app/controllers/spree/api/v2/platform/products_controller.rb b/api/app/controllers/spree/api/v2/platform/products_controller.rbnew file mode 100644index 0000000000..aa4cd6ec1a--- /dev/null+++ b/api/app/controllers/spree/api/v2/platform/products_controller.rb@@ -0,0 +1,55 @@+module Spree+ module Api+ module V2+ module Platform+ class ProductsController < ::Spree::Api::V2::ResourceController+ private++ def sorted_collection+ collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call+ end++ def collection+ @collection ||= collection_finder.new(scope: scope, params: params, current_currency: current_currency).execute+ end++ def resource+ @resource ||= scope.find_by(slug: params[:id]) || scope.find(params[:id])+ end++ def collection_sorter+ Spree::Api::Dependencies.storefront_products_sorter.constantize+ end++ def collection_finder+ Spree::Api::Dependencies.storefront_products_finder.constantize+ end++ def collection_serializer+ Spree::Api::Dependencies.storefront_product_serializer.constantize+ end++ def resource_serializer+ Spree::Api::Dependencies.storefront_product_serializer.constantize+ end++ def model_class+ Spree::Product+ end++ def scope_includes+ {+ master: :default_price,+ variants: [],+ variant_images: [],+ taxons: [],+ product_properties: :property,+ option_types: :option_values,+ variants_including_master: %i[default_price option_values]+ }+ end+ end+ end+ end+ end+enddiff --git a/api/app/controllers/spree/api/v2/platform/taxons_controller.rb b/api/app/controllers/spree/api/v2/platform/taxons_controller.rbnew file mode 100644index 0000000000..b748a9b148--- /dev/null+++ b/api/app/controllers/spree/api/v2/platform/taxons_controller.rb@@ -0,0 +1,47 @@+module Spree+ module Api+ module V2+ module Platform+ class TaxonsController < ::Spree::Api::V2::ResourceController+ private++ def collection_serializer+ Spree::Api::Dependencies.storefront_taxon_serializer.constantize+ end++ def resource_serializer+ Spree::Api::Dependencies.storefront_taxon_serializer.constantize+ end++ def collection_finder+ Spree::Api::Dependencies.storefront_taxon_finder.constantize+ end++ def paginated_collection+ @paginated_collection ||= collection_paginator.new(collection, params).call+ end++ def resource+ @resource ||= scope.find_by(permalink: params[:id]) || scope.find(params[:id])+ end++ def model_class+ Spree::Taxon+ end++ def scope_includes+ node_includes = %i[icon products parent taxonomy]++ {+ parent: node_includes,+ children: node_includes,+ taxonomy: [root: node_includes],+ products: [],+ icon: [attachment_attachment: :blob]+ }+ end+ end+ end+ end+ end+enddiff --git a/api/app/serializers/spree/api/v2/platform/product_serializer.rb b/api/app/serializers/spree/api/v2/platform/product_serializer.rbnew file mode 100644index 0000000000..0e30ebd9ab--- /dev/null+++ b/api/app/serializers/spree/api/v2/platform/product_serializer.rb@@ -0,0 +1,69 @@+module Spree+ module Api+ module V2+ module Platform+ class ProductSerializer < BaseSerializer+ include ::Spree::Api::V2::DisplayMoneyHelper++ set_type :product++ attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at++ attribute :purchasable do |product|+ product.purchasable?+ end++ attribute :in_stock do |product|+ product.in_stock?+ end++ attribute :backorderable do |product|+ product.backorderable?+ end++ attribute :available do |product|+ product.available?+ end++ attribute :currency do |_product, params|+ params[:currency]+ end++ attribute :price do |product, params|+ price(product, params[:currency])+ end++ attribute :display_price do |product, params|+ display_price(product, params[:currency])+ end++ attribute :compare_at_price do |product, params|+ compare_at_price(product, params[:currency])+ end++ attribute :display_compare_at_price do |product, params|+ display_compare_at_price(product, params[:currency])+ end++ has_many :variants+ has_many :option_types+ has_many :product_properties+ has_many :taxons++ # all images from all variants+ has_many :images,+ object_method_name: :variant_images,+ id_method_name: :variant_image_ids,+ record_type: :image,+ serializer: :image++ has_one :default_variant,+ object_method_name: :default_variant,+ id_method_name: :default_variant_id,+ record_type: :variant,+ serializer: :variant+ end+ end+ end+ end+enddiff --git a/api/app/serializers/spree/api/v2/platform/taxon_image_serializer.rb b/api/app/serializers/spree/api/v2/platform/taxon_image_serializer.rbnew file mode 100644index 0000000000..ed3110469e--- /dev/null+++ b/api/app/serializers/spree/api/v2/platform/taxon_image_serializer.rb@@ -0,0 +1,13 @@+module Spree+ module Api+ module V2+ module Platform+ class TaxonImageSerializer < BaseSerializer+ set_type :taxon_image++ attributes :viewable_type, :viewable_id, :styles+ end+ end+ end+ end+enddiff --git a/api/app/serializers/spree/api/v2/platform/taxon_serializer.rb b/api/app/serializers/spree/api/v2/platform/taxon_serializer.rbnew file mode 100644index 0000000000..c223a59125--- /dev/null+++ b/api/app/serializers/spree/api/v2/platform/taxon_serializer.rb@@ -0,0 +1,40 @@+module Spree+ module Api+ module V2+ module Platform+ class TaxonSerializer < BaseSerializer+ include ::Spree::Api::V2::ResourceSerializerConcern++ set_type :taxon++ attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,+ :meta_keywords, :left, :right, :position, :depth, :updated_at++ attribute :is_root do |taxon|+ taxon.root?+ end++ attribute :is_child do |taxon|+ taxon.child?+ end++ attribute :is_leaf do |taxon|+ taxon.leaf?+ end++ belongs_to :parent, record_type: :taxon, serializer: :taxon+ belongs_to :taxonomy, record_type: :taxonomy++ has_many :children, record_type: :taxon, serializer: :taxon+ has_many :products, record_type: :product++ has_one :image,+ object_method_name: :icon,+ id_method_name: :icon_id,+ record_type: :taxon_image,+ serializer: :taxon_image+ end+ end+ end+ end+enddiff --git a/api/app/serializers/spree/api/v2/platform/taxonomy_serializer.rb b/api/app/serializers/spree/api/v2/platform/taxonomy_serializer.rbnew file mode 100644index 0000000000..f017a13a70--- /dev/null+++ b/api/app/serializers/spree/api/v2/platform/taxonomy_serializer.rb@@ -0,0 +1,13 @@+module Spree+ module Api+ module V2+ module Platform+ class TaxonomySerializer < BaseSerializer+ set_type :taxonomy++ attributes :name, :position+ end+ end+ end+ end+enddiff --git a/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb b/api/app/serializers/spree/v2/storefront/menu_item_serializer.rbindex 80ee63a6a9..49db4c9cd3 100644--- a/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb+++ b/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb@@ -26,6 +26,8 @@ module Spreebelongs_to :menubelongs_to :parent, record_type: :menu_item, serializer: :menu_item++ has_many :children, record_type: :menu_item, serializer: :menu_itemendendenddiff --git a/backend/app/assets/javascripts/spree/backend.js b/backend/app/assets/javascripts/spree/backend.jsindex 916b21d89c..e6bc938608 100644--- a/backend/app/assets/javascripts/spree/backend.js+++ b/backend/app/assets/javascripts/spree/backend.js@@ -16,13 +16,7 @@//= require underscore-min.js//= require jsonapi-serializer.min-//= require spree/backend/global/alerts-//= require spree/backend/global/bootstrap-//= require spree/backend/global/flatpickr-//= require spree/backend/global/ransack-//= require spree/backend/global/radio_panel_toggle-//= require spree/backend/global/responsive_menus-//= require spree/backend/global/sortable+//= require spree/backend/global/index//= require spree//= require spree/backend/spree-select2@@ -99,6 +93,8 @@ Spree.routes.menus_api_v2 = Spree.pathFor('api/v2/platform/menus')Spree.routes.menus_items_api_v2 = Spree.pathFor('api/v2/platform/menu_items/reposition')Spree.routes.option_types_api_v2 = Spree.pathFor('api/v2/platform/option_types')Spree.routes.option_values_api_v2 = Spree.pathFor('api/v2/platform/option_values')+Spree.routes.products_api_v2 = Spree.pathFor('/api/v2/platform/products')+Spree.routes.taxons_api_v2 = Spree.pathFor('/api/v2/platform/taxons')Spree.routes.users_api_v2 = Spree.pathFor('api/v2/platform/users')Spree.apiV2Authentication = function() {diff --git a/backend/app/assets/javascripts/spree/backend/global/index.js b/backend/app/assets/javascripts/spree/backend/global/index.jsnew file mode 100644index 0000000000..1ed9015e4c--- /dev/null+++ b/backend/app/assets/javascripts/spree/backend/global/index.js@@ -0,0 +1,8 @@+//= require spree/backend/global/alerts+//= require spree/backend/global/bootstrap+//= require spree/backend/global/flatpickr+//= require spree/backend/global/ransack+//= require spree/backend/global/radio_panel_toggle+//= require spree/backend/global/responsive_menus+//= require spree/backend/global/sortable+//= require spree/backend/global/utilsdiff --git a/backend/app/assets/javascripts/spree/backend/global/utils.es6 b/backend/app/assets/javascripts/spree/backend/global/utils.es6new file mode 100644index 0000000000..2c58370cf4--- /dev/null+++ b/backend/app/assets/javascripts/spree/backend/global/utils.es6@@ -0,0 +1,36 @@+/* eslint-disable no-unused-vars */+function populateSelectOptionsFromApi(params) {+ const targetElement = params.targetElement+ const apiUrl = params.apiUrl+ const returnAttribute = params.returnAttribute+ const selectedOption = params.selectedOption++ fetch(apiUrl, {+ headers: Spree.apiV2Authentication()+ }).then((response) => {+ switch (response.status) {+ case 200:+ response.json()+ .then((json) => {+ const object = json.data+ populateSelect(object, returnAttribute, targetElement, selectedOption)+ })+ break+ }+ })+}++function populateSelect (object, returnAttribute, targetElement, selectedOption) {+ const resourceSelect = document.querySelector(targetElement)++ object.forEach((item) => {+ const oppt = document.createElement('option');+ oppt.value = item.id;+ oppt.innerHTML = item.attributes[returnAttribute];++ if (parseInt(selectedOption, 10) === parseInt(item.id, 10)) {+ oppt.selected = true;+ }+ resourceSelect.appendChild(oppt)+ })+}diff --git a/backend/app/controllers/spree/admin/menu_items_controller.rb b/backend/app/controllers/spree/admin/menu_items_controller.rbindex 9223718f30..4b9dd0e709 100644--- a/backend/app/controllers/spree/admin/menu_items_controller.rb+++ b/backend/app/controllers/spree/admin/menu_items_controller.rb@@ -16,9 +16,6 @@ module Spreedef load_data@menu_item_types = Spree::MenuItem::ITEM_TYPE@linked_resource_types = Spree::MenuItem::LINKED_RESOURCE_TYPE-- @taxons = Spree::Taxon.all- @products = Spree::Product.allendendenddiff --git a/backend/app/views/spree/admin/menu_items/_link_input.html.erb b/backend/app/views/spree/admin/menu_items/_link_input.html.erbindex a78b7644de..9d8a8a12f2 100644--- a/backend/app/views/spree/admin/menu_items/_link_input.html.erb+++ b/backend/app/views/spree/admin/menu_items/_link_input.html.erb@@ -4,9 +4,7 @@<%= render 'spree/admin/menu_items/link_inputs/url', f: f %><% when 'Home Page' %><%= render 'spree/admin/menu_items/link_inputs/home_page', f: f %>- <% when 'Spree::Taxon' %>- <%= render 'spree/admin/menu_items/link_inputs/taxon', linked_resource: linked_resource_type, f: f %>- <% when 'Spree::Product' %>- <%= render 'spree/admin/menu_items/link_inputs/product', linked_resource: linked_resource_type, f: f %>+ <% else %>+ <%= render 'spree/admin/menu_items/link_inputs/resource', linked_resource: linked_resource_type, f: f %><% end %></div>diff --git a/backend/app/views/spree/admin/menu_items/link_inputs/_product.html.erb b/backend/app/views/spree/admin/menu_items/link_inputs/_product.html.erbdeleted file mode 100644index a32d2846bc..0000000000--- a/backend/app/views/spree/admin/menu_items/link_inputs/_product.html.erb+++ /dev/null@@ -1,6 +0,0 @@-<%= f.field_container :linked_resource_id, class: ['form-group'] do %>- <%= f.label :linked_resource_id, Spree.t('product') %>- <%= f.select :linked_resource_id, options_from_collection_for_select(@products, :id, :name, @menu_item.linked_resource_id), {include_blank: true}, multiple: false, class: 'select2-clear' %>- <%= f.error_message_on :linked_resource_id %>- <small class="form-text text-muted"><%= @menu_item.destination %></small>-<% end %>diff --git a/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erb b/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erbnew file mode 100644index 0000000000..0824bdf6ca--- /dev/null+++ b/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erb@@ -0,0 +1,31 @@+<%= f.field_container :linked_resource_id, class: ['form-group'] do %>+ <% if @menu_item.linked_resource_type == 'Spree::Taxon' %>+ <%= f.label :linked_resource_id, Spree.t('taxon') %>+ <% elsif @menu_item.linked_resource_type == 'Spree::Product' %>+ <%= f.label :linked_resource_id, Spree.t('product') %>+ <% end %>++ <%= f.select :linked_resource_id, options_from_collection_for_select([], nil, nil, @menu_item.linked_resource_id), {include_blank: true}, multiple: false, class: 'select2-clear' %>+ <%= f.error_message_on :linked_resource_id %>+ <small class="form-text text-muted"><%= @menu_item.destination %></small>+<% end %>++<script>+ document.addEventListener("DOMContentLoaded", () => {+ populateSelectOptionsFromApi({+ targetElement: '#menu_item_linked_resource_id',++ <% if @menu_item.linked_resource_type == 'Spree::Taxon' %>+ apiUrl: Spree.routes.taxons_api_v2,+ returnAttribute: 'pretty_name',+ <% elsif @menu_item.linked_resource_type == 'Spree::Product' %>+ apiUrl: Spree.routes.products_api_v2,+ returnAttribute: 'name',+ <% end %>++ <% if @menu_item.linked_resource_id %>+ selectedOption: <%= @menu_item.linked_resource_id %>+ <% end %>+ })+ });+</script>diff --git a/backend/app/views/spree/admin/menu_items/link_inputs/_taxon.html.erb b/backend/app/views/spree/admin/menu_items/link_inputs/_taxon.html.erbdeleted file mode 100644index bcdbe66b99..0000000000--- a/backend/app/views/spree/admin/menu_items/link_inputs/_taxon.html.erb+++ /dev/null@@ -1,6 +0,0 @@-<%= f.field_container :linked_resource_id, class: ['form-group'] do %>- <%= f.label :linked_resource_id, Spree.t('taxon') %>- <%= f.select :linked_resource_id, options_from_collection_for_select(@taxons, :id, :pretty_name, @menu_item.linked_resource_id), {include_blank: true}, multiple: false, class: 'select2-clear' %>- <%= f.error_message_on :linked_resource_id %>- <small class="form-text text-muted"><%= @menu_item.destination %></small>-<% end %>