spree_api 5.3.4 → 5.4.0.beta

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

@@ -0,0 +1,78 @@
+module Spree
+  module Api
+    module V3
+      class GiftCardSerializer < BaseSerializer
+        typelize code: :string,
+                 state: :string,
+                 amount: :number,
+                 amount_used: :number,
+                 amount_authorized: :number,
+                 amount_remaining: :number,
+                 display_amount: :string,
+                 display_amount_used: :string,
+                 display_amount_remaining: :string,
+                 currency: :string,
+                 expires_at: [:string, nullable: true],
+                 redeemed_at: [:string, nullable: true],
+                 expired: :boolean,
+                 active: :boolean
+
+        attribute :code do |gift_card|
+          gift_card.display_code
+        end
+
+        attribute :state do |gift_card|
+          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
+
+        attribute :display_amount do |gift_card|
+          gift_card.display_amount.to_s
+        end
+
+        attribute :display_amount_used do |gift_card|
+          gift_card.display_amount_used.to_s
+        end
+
+        attribute :display_amount_remaining do |gift_card|
+          gift_card.display_amount_remaining.to_s
+        end
+
+        attribute :expires_at do |gift_card|
+          gift_card.expires_at&.iso8601
+        end
+
+        attribute :redeemed_at do |gift_card|
+          gift_card.redeemed_at&.iso8601
+        end
+
+        attribute :expired do |gift_card|
+          gift_card.expired?
+        end
+
+        attribute :active do |gift_card|
+          gift_card.active?
+        end
+
+        attributes created_at: :iso8601, updated_at: :iso8601
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module V3
+      class ImageSerializer < AssetSerializer
+        typelize position: :number, alt: [:string, nullable: true], viewable_type: :string, viewable_id: :string,
+                 original_url: [:string, nullable: true], mini_url: [:string, nullable: true],
+                 small_url: [:string, nullable: true], medium_url: [:string, nullable: true],
+                 large_url: [:string, nullable: true], xlarge_url: [:string, nullable: true],
+                 og_image_url: [:string, nullable: true]
+
+        attribute :viewable_id do |image|
+          image.viewable&.prefixed_id
+        end
+
+        attributes :position, :alt, :viewable_type,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :original_url do |image|
+          image_url_for(image)
+        end
+
+        # Dynamically define attributes for each configured image variant
+        # Uses named variants from Spree::Config.product_image_variant_sizes
+        # (e.g., mini, small, medium, large, xlarge)
+        Spree::Config.product_image_variant_sizes.each_key do |variant_name|
+          attribute :"#{variant_name}_url" do |image|
+            variant_url(image, variant_name)
+          end
+        end
+
+        private
+
+        def variant_url(image, variant_name)
+          return nil unless image&.attachment&.attached?
+
+          Rails.application.routes.url_helpers.cdn_image_url(
+            image.attachment.variant(variant_name)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ImportRowSerializer < BaseSerializer
+        typelize import_id: [:string, nullable: true], row_number: :number,
+                 status: :string, validation_errors: 'unknown',
+                 item_type: [:string, nullable: true], item_id: [:string, nullable: true]
+
+        attributes :row_number, :status, :validation_errors, :item_type,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :import_id do |row|
+          row.import&.prefixed_id
+        end
+
+        attribute :item_id do |row|
+          row.item&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ImportSerializer < BaseSerializer
+        typelize number: :string, type: [:string, nullable: true], status: :string,
+                 owner_type: [:string, nullable: true], owner_id: [:string, nullable: true],
+                 user_id: [:string, nullable: true], rows_count: :number
+
+        attributes :number, :type, :rows_count,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :status do |import|
+          import.status.to_s
+        end
+
+        attribute :owner_type do |import|
+          import.owner_type
+        end
+
+        attribute :owner_id do |import|
+          import.owner&.prefixed_id
+        end
+
+        attribute :user_id do |import|
+          import.user&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class InvitationSerializer < BaseSerializer
+        typelize email: :string, status: :string,
+                 resource_type: [:string, nullable: true], resource_id: [:string, nullable: true],
+                 inviter_type: [:string, nullable: true], inviter_id: [:string, nullable: true],
+                 invitee_type: [:string, nullable: true], invitee_id: [:string, nullable: true],
+                 role_id: [:string, nullable: true],
+                 expires_at: [:string, nullable: true], accepted_at: [:string, nullable: true]
+
+        attributes :email, :resource_type, :inviter_type, :invitee_type,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :status do |invitation|
+          invitation.status.to_s
+        end
+
+        attribute :resource_id do |invitation|
+          invitation.resource&.prefixed_id
+        end
+
+        attribute :inviter_id do |invitation|
+          invitation.inviter&.prefixed_id
+        end
+
+        attribute :invitee_id do |invitation|
+          invitation.invitee&.prefixed_id
+        end
+
+        attribute :role_id do |invitation|
+          invitation.role&.prefixed_id
+        end
+
+        attribute :expires_at do |invitation|
+          invitation.expires_at&.iso8601
+        end
+
+        attribute :accepted_at do |invitation|
+          invitation.accepted_at&.iso8601
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Spree
+  module Api
+    module V3
+      class LineItemSerializer < BaseSerializer
+        typelize variant_id: :string, quantity: :number, currency: :string,
+                 name: :string, slug: :string, options_text: :string,
+                 price: :string, display_price: :string, total: :string, display_total: :string,
+                 adjustment_total: :string, display_adjustment_total: :string,
+                 additional_tax_total: :string, display_additional_tax_total: :string,
+                 included_tax_total: :string, display_included_tax_total: :string,
+                 promo_total: :string, display_promo_total: :string,
+                 pre_tax_amount: :string, display_pre_tax_amount: :string,
+                 discounted_amount: :string, display_discounted_amount: :string,
+                 compare_at_amount: [:string, nullable: true], display_compare_at_amount: [:string, nullable: true],
+                 thumbnail_url: [:string, nullable: true]
+
+        attribute :variant_id do |line_item|
+          line_item.variant&.prefixed_id
+        end
+
+        attributes :quantity, :currency, :name, :slug, :options_text,
+                   :price, :display_price, :total, :display_total,
+                   :adjustment_total, :display_adjustment_total,
+                   :additional_tax_total, :display_additional_tax_total,
+                   :included_tax_total, :display_included_tax_total,
+                   :promo_total, :display_promo_total,
+                   :pre_tax_amount, :display_pre_tax_amount,
+                   :discounted_amount, :display_discounted_amount,
+                   :display_compare_at_amount,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        # Return compare_at_amount as string, nil if zero
+        attribute :compare_at_amount do |line_item|
+          amount = line_item.compare_at_amount
+          amount.present? && amount.positive? ? amount.to_s : nil
+        end
+
+        # Thumbnail URL for line item (variant thumbnail or product thumbnail)
+        attribute :thumbnail_url do |line_item|
+          image_url_for(line_item.thumbnail)
+        end
+
+        many :option_values, resource: Spree.api.option_value_serializer
+        many :digital_links, resource: Spree.api.digital_link_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V3
+      class LocaleSerializer
+        include Alba::Resource
+        include Typelizer::DSL
+
+        typelize code: :string, name: :string
+
+        attributes :code, :name
+      end
+    end
+  end
+end

data/app/serializers/spree/{v2/storefront → api/v3}/metafield_serializer.rb

@@ -1,8 +1,10 @@
 module Spree
-  module V2
-    module Storefront
+  module Api
+    module V3
+      # Store API Metafield Serializer
+      # Customer-facing metafield data (public metafields only)
       class MetafieldSerializer < BaseSerializer
-        set_type :metafield
+        typelize key: :string, name: :string, type: :string, value: :any
 
         attributes :name, :type
 

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class NewsletterSubscriberSerializer < BaseSerializer
+        typelize email: :string, verified: :boolean,
+                 verified_at: [:string, nullable: true],
+                 user_id: [:string, nullable: true]
+
+        attributes :email, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :verified do |subscriber|
+          subscriber.verified?
+        end
+
+        attribute :verified_at do |subscriber|
+          subscriber.verified_at&.iso8601
+        end
+
+        attribute :user_id do |subscriber|
+          subscriber.user&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V3
+      class OptionTypeSerializer < BaseSerializer
+        typelize name: :string, presentation: :string, position: :number
+
+        attributes :name, :presentation, :position
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Spree
+  module Api
+    module V3
+      class OptionValueSerializer < BaseSerializer
+        typelize name: :string, presentation: :string, position: :number, option_type_id: :string,
+                 option_type_name: :string, option_type_presentation: :string
+
+        attribute :option_type_id do |option_value|
+          option_value.option_type&.prefixed_id
+        end
+
+        attributes :name, :presentation, :position
+
+        attribute :option_type_name do |option_value|
+          option_value.option_type.name
+        end
+
+        attribute :option_type_presentation do |option_value|
+          option_value.option_type.presentation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V3
+      class OrderPromotionSerializer < BaseSerializer
+        typelize name: :string, description: [:string, nullable: true], code: [:string, nullable: true],
+                 amount: :string, display_amount: :string, promotion_id: :string
+
+        attribute :promotion_id do |order_promotion|
+          order_promotion.promotion&.prefixed_id
+        end
+
+        attributes :name, :description, :code, :amount, :display_amount
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Spree
+  module Api
+    module V3
+      # Store API Order Serializer
+      # Customer-facing order data
+      class OrderSerializer < BaseSerializer
+        typelize number: :string, state: :string, token: :string, email: [:string, nullable: true],
+                 special_instructions: [:string, nullable: true], currency: :string, item_count: :number,
+                 shipment_state: [:string, nullable: true], payment_state: [:string, nullable: true],
+                 item_total: :string, display_item_total: :string,
+                 ship_total: :string, display_ship_total: :string,
+                 adjustment_total: :string, display_adjustment_total: :string,
+                 promo_total: :string, display_promo_total: :string,
+                 tax_total: :string, display_tax_total: :string,
+                 included_tax_total: :string, display_included_tax_total: :string,
+                 additional_tax_total: :string, display_additional_tax_total: :string,
+                 total: :string, display_total: :string, completed_at: [:string, nullable: true],
+                 bill_address: { nullable: true }, ship_address: { nullable: true }
+
+        attributes :number, :state, :token, :email, :special_instructions,
+                   :currency, :item_count, :shipment_state, :payment_state,
+                   :item_total, :display_item_total, :ship_total, :display_ship_total,
+                   :adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
+                   :tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
+                   :additional_tax_total, :display_additional_tax_total, :total, :display_total,
+                   completed_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
+
+        many :order_promotions, resource: Spree.api.order_promotion_serializer
+        many :line_items, resource: Spree.api.line_item_serializer
+        many :shipments, resource: Spree.api.shipment_serializer
+        many :payments, resource: Spree.api.payment_serializer
+        one :bill_address, resource: Spree.api.address_serializer
+        one :ship_address, resource: Spree.api.address_serializer
+
+        many :payment_methods, resource: Spree.api.payment_method_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V3
+      class PaymentMethodSerializer < BaseSerializer
+        typelize name: :string, description: [:string, nullable: true], type: :string, session_required: :boolean
+
+        attributes :name, :description, :type
+
+        attribute :session_required do |payment_method|
+          payment_method.session_required?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Spree
+  module Api
+    module V3
+      class PaymentSerializer < BaseSerializer
+        typelize state: :string, payment_method_id: :string, response_code: [:string, nullable: true],
+                 number: :string, amount: :string, display_amount: :string,
+                 source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source]],
+                 source_id: [:string, nullable: true],
+                 source: 'StoreCreditCard | StoreStoreCredit | StorePaymentSource | null'
+
+        attribute :payment_method_id do |payment|
+          payment.payment_method&.prefixed_id
+        end
+
+        attributes :state, :response_code, :number, :amount, :display_amount,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :source_type do |payment|
+          case payment.source_type
+          when 'Spree::CreditCard'
+            'credit_card'
+          when 'Spree::StoreCredit'
+            'store_credit'
+          when nil
+            nil
+          else
+            'payment_source'
+          end
+        end
+
+        attribute :source_id do |payment|
+          payment.source&.prefixed_id
+        end
+
+        attribute :source do |payment|
+          next nil if payment.source.blank?
+
+          serializer = case payment.source_type
+                       when 'Spree::CreditCard'
+                         Spree.api.credit_card_serializer
+                       when 'Spree::StoreCredit'
+                         Spree.api.store_credit_serializer
+                       else
+                         Spree.api.payment_source_serializer
+                       end
+
+          serializer.new(payment.source).to_h
+        end
+
+        one :payment_method, resource: Spree.api.payment_method_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Spree
+  module Api
+    module V3
+      class PaymentSessionSerializer < BaseSerializer
+        typelize status: :string, amount: :string, currency: :string,
+                 external_id: :string, external_data: 'Record<string, unknown>',
+                 expires_at: [:string, nullable: true], customer_external_id: [:string, nullable: true],
+                 payment_method_id: :string, order_id: :string
+
+        attributes :status, :currency, :external_id, :external_data,
+                   :customer_external_id,
+                   expires_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :amount do |session|
+          session.amount&.to_s
+        end
+
+        attribute :payment_method_id do |session|
+          session.payment_method&.prefixed_id
+        end
+
+        attribute :order_id do |session|
+          session.order&.prefixed_id
+        end
+
+        one :payment_method, resource: Spree.api.payment_method_serializer
+        one :payment, resource: Spree.api.payment_serializer,
+            if: proc { |session| session.payment.present? }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Spree
+  module Api
+    module V3
+      class PaymentSetupSessionSerializer < BaseSerializer
+        typelize status: :string, external_id: [:string, nullable: true], external_client_secret: [:string, nullable: true],
+                 external_data: 'Record<string, unknown>',
+                 payment_method_id: [:string, nullable: true], payment_source_id: [:string, nullable: true],
+                 payment_source_type: [:string, nullable: true], customer_id: [:string, nullable: true]
+
+        attributes :status, :external_id, :external_client_secret, :external_data,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :payment_method_id do |session|
+          session.payment_method&.prefixed_id
+        end
+
+        attribute :payment_source_id do |session|
+          session.payment_source&.prefixed_id
+        end
+
+        attribute :payment_source_type do |session|
+          session.payment_source_type
+        end
+
+        attribute :customer_id do |session|
+          session.customer&.prefixed_id
+        end
+
+        one :payment_method, resource: Spree.api.payment_method_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module Api
+    module V3
+      class PaymentSourceSerializer < BaseSerializer
+        typelize gateway_payment_profile_id: [:string, nullable: true],
+                 public_metadata: ['Record<string, unknown>', nullable: true]
+
+        attribute :gateway_payment_profile_id do |source|
+          source.try(:gateway_payment_profile_id)
+        end
+
+        attribute :public_metadata do |source|
+          source.try(:public_metadata)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class PostCategorySerializer < BaseSerializer
+        typelize title: :string, slug: :string
+
+        attributes :title, :slug, created_at: :iso8601, updated_at: :iso8601
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class PostSerializer < BaseSerializer
+        typelize title: :string, slug: :string,
+                 meta_title: [:string, nullable: true], meta_description: [:string, nullable: true],
+                 published_at: [:string, nullable: true],
+                 author_id: [:string, nullable: true], post_category_id: [:string, nullable: true]
+
+        attributes :title, :slug, :meta_title, :meta_description,
+                   published_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :author_id do |post|
+          post.author&.prefixed_id
+        end
+
+        attribute :post_category_id do |post|
+          post.post_category&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Spree
+  module Api
+    module V3
+      # Store API Price Serializer
+      # Represents a resolved/calculated price for storefront display
+      # Can represent either a calculated price (with price list resolution) or a base price
+      class PriceSerializer < BaseSerializer
+        typelize amount: [:string, nullable: true],
+                 amount_in_cents: [:number, nullable: true],
+                 display_amount: [:string, nullable: true],
+                 compare_at_amount: [:string, nullable: true],
+                 compare_at_amount_in_cents: [:number, nullable: true],
+                 display_compare_at_amount: [:string, nullable: true],
+                 currency: [:string, nullable: true],
+                 price_list_id: [:string, nullable: true]
+
+        attributes :amount, :amount_in_cents, :compare_at_amount,
+                   :compare_at_amount_in_cents, :currency
+
+        attribute :display_amount do |price|
+          price.display_amount&.to_s
+        end
+
+        attribute :display_compare_at_amount do |price|
+          price.display_compare_at_amount&.to_s
+        end
+
+        attribute :price_list_id do |price|
+          price.price_list&.prefixed_id
+        end
+      end
+    end
+  end
+end