spree_api 5.4.0.beta4 → 5.4.0.beta6

data/app/serializers/spree/api/v3/admin/order_serializer.rb

@@ -11,34 +11,75 @@ module Spree
                    store_owner_notification_delivered: :boolean,
                    internal_note: [:string, nullable: true], approver_id: [:string, nullable: true],
                    canceler_id: [:string, nullable: true], created_by_id: [:string, nullable: true],
+                   user_id: [:string, nullable: true],
                    canceled_at: [:string, nullable: true], approved_at: [:string, nullable: true],
+                   payment_total: :string, display_payment_total: :string,
                    metadata: 'Record<string, unknown> | null'
 
           # Admin-only attributes
           attributes :channel, :last_ip_address, :considered_risky,
                      :confirmation_delivered, :store_owner_notification_delivered,
-                     :internal_note, :approver_id,
+                     :internal_note, :payment_total, :display_payment_total,
                      canceled_at: :iso8601, approved_at: :iso8601
 
           attribute :metadata do |order|
             order.metadata.presence
           end
 
+          attribute :approver_id do |order|
+            order.approver&.prefixed_id
+          end
+
           attribute :canceler_id do |order|
-            order.canceler_id
+            order.canceler&.prefixed_id
           end
 
           attribute :created_by_id do |order|
-            order.created_by_id
+            order.created_by&.prefixed_id
+          end
+
+          attribute :user_id do |order|
+            order.user&.prefixed_id
           end
 
-          many :line_items, resource: Spree.api.admin_line_item_serializer
+          # Override inherited associations to use admin serializers
+          many :order_promotions, resource: Spree.api.admin_order_promotion_serializer, if: proc { expand?('order_promotions') }
+          many :line_items, resource: Spree.api.admin_line_item_serializer, if: proc { expand?('line_items') }
+          many :shipments, resource: Spree.api.admin_shipment_serializer, if: proc { expand?('shipments') }
+          many :payments, resource: Spree.api.admin_payment_serializer, if: proc { expand?('payments') }
+
+          one :bill_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('bill_address') }
+          one :ship_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('ship_address') }
+
+          many :payment_methods, resource: Spree.api.admin_payment_method_serializer, if: proc { expand?('payment_methods') }
 
           one :user,
               resource: Spree.api.admin_customer_serializer,
-              if: proc { params[:expand]&.include?('user') }
+              if: proc { expand?('user') }
+
+          one :approver,
+              resource: Spree.api.admin_customer_serializer,
+              if: proc { expand?('approver') }
+
+          one :canceler,
+              resource: Spree.api.admin_customer_serializer,
+              if: proc { expand?('canceler') }
+
+          one :created_by,
+              resource: Spree.api.admin_customer_serializer,
+              if: proc { expand?('created_by') }
+
+          many :adjustments,
+               resource: Spree.api.admin_adjustment_serializer,
+               if: proc { expand?('adjustments') }
+
+          many :return_authorizations,
+               resource: Spree.api.admin_return_authorization_serializer,
+               if: proc { expand?('return_authorizations') }
 
-          # TODO: Add adjustments associations when Admin API is implemented
+          many :reimbursements,
+               resource: Spree.api.admin_reimbursement_serializer,
+               if: proc { expand?('reimbursements') }
         end
       end
     end

data/app/serializers/spree/api/v3/admin/payment_method_serializer.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class PaymentMethodSerializer < V3::PaymentMethodSerializer
+          typelize active: :boolean, auto_capture: [:boolean, nullable: true]
+
+          attributes :active, :auto_capture,
+                     created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/payment_serializer.rb

@@ -0,0 +1,56 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class PaymentSerializer < V3::PaymentSerializer
+          typelize metadata: 'Record<string, unknown> | null',
+                   captured_amount: :string,
+                   order_id: [:string, nullable: true],
+                   avs_response: [:string, nullable: true],
+                   cvv_response_code: [:string, nullable: true],
+                   cvv_response_message: [:string, nullable: true]
+
+          attributes :avs_response, :cvv_response_code, :cvv_response_message
+
+          attribute :metadata do |payment|
+            payment.metadata.presence
+          end
+
+          attribute :captured_amount do |payment|
+            payment.captured_amount.to_s
+          end
+
+          attribute :order_id do |payment|
+            payment.order&.prefixed_id
+          end
+
+          # Override inherited associations to use admin serializers
+          one :payment_method, resource: Spree.api.admin_payment_method_serializer, if: proc { expand?('payment_method') }
+
+          attribute :source do |payment|
+            next nil if payment.source.blank?
+
+            serializer = case payment.source_type
+                         when 'Spree::CreditCard'
+                           Spree.api.admin_credit_card_serializer
+                         when 'Spree::StoreCredit'
+                           Spree.api.admin_store_credit_serializer
+                         else
+                           Spree.api.admin_payment_source_serializer
+                         end
+
+            serializer.new(payment.source).to_h
+          end
+
+          one :order,
+              resource: Spree.api.admin_order_serializer,
+              if: proc { expand?('order') }
+
+          many :refunds,
+               resource: Spree.api.admin_refund_serializer,
+               if: proc { expand?('refunds') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/payment_source_serializer.rb

@@ -0,0 +1,10 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class PaymentSourceSerializer < V3::PaymentSourceSerializer
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/product_serializer.rb

@@ -9,14 +9,14 @@ module Spree
 
           # Additional type hints for admin-only computed attributes
           typelize status: :string, make_active_at: [:string, nullable: true], discontinue_on: [:string, nullable: true],
-                   cost_price: [:number, nullable: true], cost_currency: [:string, nullable: true],
+                   cost_price: [:string, nullable: true], cost_currency: [:string, nullable: true],
                    deleted_at: [:string, nullable: true]
 
           # Admin-only attributes
           attributes :status, :make_active_at, :discontinue_on, deleted_at: :iso8601
 
           attribute :cost_price do |product|
-            product.master&.cost_price&.to_f
+            product.master&.cost_price
           end
 
           attribute :cost_currency do |product|
@@ -26,20 +26,37 @@ module Spree
           # Admin uses admin variant serializer
           many :variants,
                resource: Spree.api.admin_variant_serializer,
-               if: proc { params[:expand]&.include?('variants') }
+               if: proc { expand?('variants') }
 
           one :default_variant,
               resource: Spree.api.admin_variant_serializer,
-              if: proc { params[:expand]&.include?('default_variant') }
+              if: proc { expand?('default_variant') }
 
           one :master,
               key: :master_variant,
               resource: Spree.api.admin_variant_serializer,
-              if: proc { params[:expand]&.include?('master_variant') }
+              if: proc { expand?('master_variant') }
+
+          many :variant_images,
+               key: :images,
+               resource: Spree.api.admin_image_serializer,
+               if: proc { expand?('images') }
+
+          many :option_types,
+               resource: Spree.api.admin_option_type_serializer,
+               if: proc { expand?('option_types') }
+
+          many :taxons,
+               proc { |taxons, params|
+                 taxons.select { |t| t.taxonomy.store_id == params[:store].id }
+               },
+               key: :categories,
+               resource: Spree.api.admin_category_serializer,
+               if: proc { expand?('categories') }
 
           many :metafields,
                resource: Spree.api.admin_metafield_serializer,
-               if: proc { params[:expand]&.include?('metafields') }
+               if: proc { expand?('metafields') }
         end
       end
     end

data/app/serializers/spree/api/v3/admin/refund_serializer.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class RefundSerializer < V3::RefundSerializer
+          typelize payment_id: [:string, nullable: true],
+                   refund_reason_id: [:string, nullable: true],
+                   reimbursement_id: [:string, nullable: true]
+
+          one :payment,
+              resource: Spree.api.admin_payment_serializer,
+              if: proc { expand?('payment') }
+
+          one :reimbursement,
+              resource: Spree.api.admin_reimbursement_serializer,
+              if: proc { expand?('reimbursement') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/reimbursement_serializer.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ReimbursementSerializer < V3::ReimbursementSerializer
+          one :order,
+              resource: Spree.api.admin_order_serializer,
+              if: proc { expand?('order') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/return_authorization_serializer.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ReturnAuthorizationSerializer < V3::ReturnAuthorizationSerializer
+          one :order,
+              resource: Spree.api.admin_order_serializer,
+              if: proc { expand?('order') }
+
+          one :stock_location,
+              resource: Spree.api.admin_stock_location_serializer,
+              if: proc { expand?('stock_location') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/shipment_serializer.rb

@@ -0,0 +1,44 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ShipmentSerializer < V3::ShipmentSerializer
+          typelize metadata: 'Record<string, unknown> | null',
+                   order_id: [:string, nullable: true],
+                   stock_location_id: [:string, nullable: true],
+                   adjustment_total: :string, additional_tax_total: :string,
+                   included_tax_total: :string, promo_total: :string,
+                   pre_tax_amount: :string
+
+          attributes :adjustment_total, :additional_tax_total,
+                     :included_tax_total, :promo_total, :pre_tax_amount
+
+          attribute :metadata do |shipment|
+            shipment.metadata.presence
+          end
+
+          attribute :order_id do |shipment|
+            shipment.order&.prefixed_id
+          end
+
+          attribute :stock_location_id do |shipment|
+            shipment.stock_location&.prefixed_id
+          end
+
+          # Override inherited associations to use admin serializers
+          one :shipping_method, resource: Spree.api.admin_shipping_method_serializer, if: proc { expand?('shipping_method') }
+          one :stock_location, resource: Spree.api.admin_stock_location_serializer, if: proc { expand?('stock_location') }
+          many :shipping_rates, resource: Spree.api.admin_shipping_rate_serializer, if: proc { expand?('shipping_rates') }
+
+          one :order,
+              resource: Spree.api.admin_order_serializer,
+              if: proc { expand?('order') }
+
+          many :adjustments,
+               resource: Spree.api.admin_adjustment_serializer,
+               if: proc { expand?('adjustments') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/shipping_category_serializer.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ShippingCategorySerializer < V3::BaseSerializer
+          typelize name: :string
+
+          attributes :name,
+                     created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/shipping_method_serializer.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ShippingMethodSerializer < V3::ShippingMethodSerializer
+          attributes created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ShippingRateSerializer < V3::ShippingRateSerializer
+          one :shipping_method, resource: Spree.api.admin_shipping_method_serializer, if: proc { expand?('shipping_method') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/stock_item_serializer.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class StockItemSerializer < V3::StockItemSerializer
+          one :stock_location,
+              resource: Spree.api.admin_stock_location_serializer,
+              if: proc { expand?('stock_location') }
+
+          one :variant,
+              resource: Spree.api.admin_variant_serializer,
+              if: proc { expand?('variant') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/stock_location_serializer.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class StockLocationSerializer < V3::StockLocationSerializer
+          typelize active: :boolean, default: :boolean, backorderable_default: :boolean,
+                   propagate_all_variants: :boolean
+
+          attributes :active, :default, :backorderable_default, :propagate_all_variants,
+                     created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/store_credit_serializer.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class StoreCreditSerializer < V3::StoreCreditSerializer
+          typelize user_id: [:string, nullable: true],
+                   created_by_id: [:string, nullable: true],
+                   metadata: 'Record<string, unknown> | null'
+
+          attribute :user_id do |store_credit|
+            store_credit.user&.prefixed_id
+          end
+
+          attribute :created_by_id do |store_credit|
+            store_credit.created_by&.prefixed_id
+          end
+
+          attribute :metadata do |store_credit|
+            store_credit.metadata.presence
+          end
+
+          attributes created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/tax_category_serializer.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class TaxCategorySerializer < V3::BaseSerializer
+          typelize name: :string, tax_code: [:string, nullable: true],
+                   is_default: :boolean
+
+          attributes :name, :tax_code, :is_default,
+                     created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/variant_serializer.rb

@@ -8,35 +8,32 @@ module Spree
 
           # Additional type hints for admin-only attributes
           typelize position: :number, tax_category_id: [:string, nullable: true],
-                   cost_price: [:number, nullable: true], cost_currency: [:string, nullable: true],
+                   cost_price: [:string, nullable: true], cost_currency: [:string, nullable: true],
                    total_on_hand: [:number, nullable: true],
                    deleted_at: [:string, nullable: true]
 
           # Admin-only attributes
-          attributes :position, :tax_category_id, deleted_at: :iso8601
-
-          attribute :cost_price do |variant|
-            variant.cost_price&.to_f
-          end
-
-          attribute :cost_currency do |variant|
-            variant.cost_currency
-          end
+          attributes :position, :tax_category_id, :cost_price, :cost_currency, deleted_at: :iso8601
 
           attribute :total_on_hand do |variant|
             variant.total_on_hand
           end
 
+          # Override inherited associations to use admin serializers
+          many :images,
+               resource: Spree.api.admin_image_serializer,
+               if: proc { expand?('images') }
+
+          many :option_values, resource: Spree.api.admin_option_value_serializer
+
           # All prices for this variant (for admin management)
           many :prices,
                resource: Spree.api.admin_price_serializer,
-               if: proc { params[:expand]&.include?('prices') }
+               if: proc { expand?('prices') }
 
           many :metafields,
                resource: Spree.api.admin_metafield_serializer,
-               if: proc { params[:expand]&.include?('metafields') }
-
-          # TODO: Add stock_items association when Admin API is implemented
+               if: proc { expand?('metafields') }
         end
       end
     end

data/app/serializers/spree/api/v3/base_serializer.rb

@@ -38,8 +38,10 @@ module Spree
         end
 
         # Check if an association should be expanded
+        # Supports dot notation: expand?('variants') matches both 'variants' and 'variants.images'
         def expand?(name)
-          expands.include?(name.to_s)
+          name = name.to_s
+          expands.any? { |e| e == name || e.start_with?("#{name}.") }
         end
 
         # Get nested expands for a given parent
@@ -48,9 +50,24 @@ module Spree
           expands.select { |i| i.start_with?(prefix) }.map { |i| i.sub(prefix, '') }
         end
 
-        # Build nested params for child serializers
-        def nested_params(parent = nil)
-          params.merge(expand: parent ? nested_expands_for(parent) : [])
+        # Build nested params for child serializers with depth limit (max 4 levels)
+        def nested_params(parent)
+          depth = params.fetch(:_expand_depth, 0)
+          nested = depth < 4 ? nested_expands_for(parent) : []
+          params.merge(expand: nested, _expand_depth: depth + 1)
+        end
+
+        private
+
+        # Override Alba's fetch_attribute to automatically inject nested expand params
+        # into child serializers via nested_params
+        def fetch_attribute(obj, key, attribute)
+          if attribute.is_a?(Alba::Association)
+            nested = nested_params(attribute.name)
+            yield_if_within(attribute.name.to_sym) { |within| attribute.to_h(obj, params: nested, within: within) }
+          else
+            super
+          end
         end
 
         # Returns price for a variant using full Price List resolution

data/app/serializers/spree/api/v3/category_serializer.rb

@@ -0,0 +1,71 @@
+module Spree
+  module Api
+    module V3
+      class CategorySerializer < BaseSerializer
+        typelize name: :string, permalink: :string, position: :number, depth: :number,
+                 meta_title: [:string, nullable: true], meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
+                 parent_id: [:string, nullable: true], children_count: :number,
+                 description: :string, description_html: :string,
+                 image_url: [:string, nullable: true], square_image_url: [:string, nullable: true],
+                 is_root: :boolean, is_child: :boolean, is_leaf: :boolean
+
+        attributes :name, :permalink, :position, :depth,
+                   :meta_title, :meta_description, :meta_keywords,
+                   :children_count,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :parent_id do |category|
+          category.parent&.prefixed_id
+        end
+
+        attribute :description do |category|
+          category.description&.to_plain_text.to_s
+        end
+
+        attribute :description_html do |category|
+          category.description&.body&.to_s.to_s
+        end
+
+        attribute :image_url do |category|
+          image_url_for(category.image)
+        end
+
+        attribute :square_image_url do |category|
+          image_url_for(category.square_image)
+        end
+
+        attribute :is_root do |category|
+          category.root?
+        end
+
+        attribute :is_child do |category|
+          category.child?
+        end
+
+        attribute :is_leaf do |category|
+          category.leaf?
+        end
+
+        # Conditional associations
+        # Note: We pass empty expand to nested categories to prevent infinite recursion
+        # (e.g., ancestors trying to load their own ancestors)
+        one :parent,
+            resource: Spree.api.category_serializer,
+            if: proc { expand?('parent') }
+
+        many :children,
+             resource: Spree.api.category_serializer,
+             if: proc { expand?('children') }
+
+        many :ancestors,
+             resource: Spree.api.category_serializer,
+             if: proc { expand?('ancestors') }
+
+        many :public_metafields,
+             key: :metafields,
+             resource: Spree.api.metafield_serializer,
+             if: proc { expand?('metafields') }
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/country_serializer.rb

@@ -6,7 +6,8 @@ module Spree
         include Typelizer::DSL
 
         typelize iso: :string, iso3: :string, name: :string,
-                 states_required: :boolean, zipcode_required: :boolean
+                 states_required: :boolean, zipcode_required: :boolean,
+                 market: [:Market, nullable: true]
 
         attributes :iso, :iso3, :name, :states_required, :zipcode_required
 

data/app/serializers/spree/api/v3/customer_serializer.rb

@@ -5,9 +5,10 @@ module Spree
       # Customer-facing user data
       class CustomerSerializer < BaseSerializer
         typelize email: :string, first_name: [:string, nullable: true], last_name: [:string, nullable: true],
+                 phone: [:string, nullable: true], accepts_email_marketing: :boolean,
                  default_billing_address: { nullable: true }, default_shipping_address: { nullable: true }
 
-        attributes :email, :first_name, :last_name,
+        attributes :email, :first_name, :last_name, :phone, :accepts_email_marketing,
                    created_at: :iso8601, updated_at: :iso8601
 
         many :addresses, resource: Spree.api.address_serializer

data/app/serializers/spree/api/v3/gift_card_serializer.rb

@@ -4,10 +4,10 @@ module Spree
       class GiftCardSerializer < BaseSerializer
         typelize code: :string,
                  state: :string,
-                 amount: :number,
-                 amount_used: :number,
-                 amount_authorized: :number,
-                 amount_remaining: :number,
+                 amount: :string,
+                 amount_used: :string,
+                 amount_authorized: :string,
+                 amount_remaining: :string,
                  display_amount: :string,
                  display_amount_used: :string,
                  display_amount_remaining: :string,
@@ -25,23 +25,7 @@ module Spree
           gift_card.display_state
         end
 
-        attributes :currency
-
-        attribute :amount do |gift_card|
-          gift_card.amount.to_f
-        end
-
-        attribute :amount_used do |gift_card|
-          gift_card.amount_used.to_f
-        end
-
-        attribute :amount_authorized do |gift_card|
-          gift_card.amount_authorized.to_f
-        end
-
-        attribute :amount_remaining do |gift_card|
-          gift_card.amount_remaining.to_f
-        end
+        attributes :currency, :amount, :amount_used, :amount_authorized, :amount_remaining
 
         attribute :display_amount do |gift_card|
           gift_card.display_amount.to_s