spree_api 5.3.4 → 5.4.0.beta

data/app/controllers/spree/api/v3/store/wishlists_controller.rb

@@ -0,0 +1,41 @@
+module Spree
+  module Api
+    module V3
+      module Store
+        class WishlistsController < ResourceController
+          prepend_before_action :require_authentication!
+
+          # POST /api/v3/store/wishlists
+          def create
+            @resource = current_user.wishlists.build(permitted_params)
+            @resource.store = current_store
+
+            if @resource.save
+              render json: serialize_resource(@resource), status: :created
+            else
+              render_errors(@resource.errors)
+            end
+          end
+
+          protected
+
+          def scope
+            current_user.wishlists.for_store(current_store)
+          end
+
+          def model_class
+            Spree::Wishlist
+          end
+
+          def serializer_class
+            Spree.api.wishlist_serializer
+          end
+
+          def permitted_params
+            params.permit(Spree::PermittedAttributes.wishlist_attributes)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Spree
+  module Api
+    module V3
+      class AddressSerializer < BaseSerializer
+        typelize firstname: [:string, nullable: true], lastname: [:string, nullable: true], full_name: :string,
+                 address1: [:string, nullable: true], address2: [:string, nullable: true],
+                 city: [:string, nullable: true], zipcode: [:string, nullable: true], phone: [:string, nullable: true],
+                 company: [:string, nullable: true], state_abbr: [:string, nullable: true], state_name: [:string, nullable: true],
+                 state_text: [:string, nullable: true], country_iso: :string, country_name: :string
+
+        attributes :firstname, :lastname, :full_name, :address1, :address2,
+                   :city, :zipcode, :phone, :company, :country_name, :country_iso, :state_text,
+                   :state_abbr
+
+        # State name - used for countries without predefined states
+        attribute :state_name do |address|
+          address.state_name.presence || address.state&.name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Customer Serializer
+        # Full customer data including admin-only fields
+        class CustomerSerializer < V3::CustomerSerializer
+          typelize phone: [:string, nullable: true], login: [:string, nullable: true],
+                   accepts_email_marketing: :boolean,
+                   last_sign_in_at: [:string, nullable: true], current_sign_in_at: [:string, nullable: true],
+                   sign_in_count: :number, failed_attempts: :number,
+                   last_sign_in_ip: [:string, nullable: true], current_sign_in_ip: [:string, nullable: true]
+
+          # Admin-only attributes
+          attributes :phone, :login, :accepts_email_marketing,
+                     last_sign_in_at: :iso8601, current_sign_in_at: :iso8601
+
+          attribute :sign_in_count do |user|
+            user.sign_in_count
+          end
+
+          attribute :failed_attempts do |user|
+            user.failed_attempts
+          end
+
+          attribute :last_sign_in_ip do |user|
+            user.last_sign_in_ip
+          end
+
+          attribute :current_sign_in_ip do |user|
+            user.current_sign_in_ip
+          end
+
+          many :orders,
+               resource: Spree.api.admin_order_serializer,
+               if: proc { params[:includes]&.include?('orders') }
+
+          # TODO: Add store_credits association when Admin API is implemented
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Metafield Serializer
+        # Full metafield data including admin-only fields
+        class MetafieldSerializer < V3::MetafieldSerializer
+          typelize display_on: :string
+
+          attributes :display_on
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Order Serializer
+        # Full order data including admin-only fields
+        class OrderSerializer < V3::OrderSerializer
+
+          typelize channel: [:string, nullable: true], last_ip_address: [:string, nullable: true],
+                   considered_risky: :boolean, confirmation_delivered: :boolean,
+                   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],
+                   canceled_at: [:string, nullable: true], approved_at: [:string, nullable: true]
+
+          # Admin-only attributes
+          attributes :channel, :last_ip_address, :considered_risky,
+                     :confirmation_delivered, :store_owner_notification_delivered,
+                     :internal_note, :approver_id,
+                     canceled_at: :iso8601, approved_at: :iso8601
+
+          attribute :canceler_id do |order|
+            order.canceler_id
+          end
+
+          attribute :created_by_id do |order|
+            order.created_by_id
+          end
+
+          one :user,
+              resource: Spree.api.admin_customer_serializer,
+              if: proc { params[:includes]&.include?('user') }
+
+          # TODO: Add adjustments associations when Admin API is implemented
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Price Serializer
+        # Extends Store Price Serializer with admin-only fields
+        class PriceSerializer < V3::PriceSerializer
+          typelize variant_id: [:string, nullable: true],
+                   created_at: :string,
+                   updated_at: :string
+
+          attribute :variant_id do |price|
+            price&.variant&.prefixed_id
+          end
+
+          attributes created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Product Serializer
+        # Full product data including admin-only fields
+        # Extends the store serializer with additional attributes
+        class ProductSerializer < V3::ProductSerializer
+
+          # 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],
+                   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
+          end
+
+          attribute :cost_currency do |product|
+            product.master&.cost_currency
+          end
+
+          # Admin uses admin variant serializer
+          many :variants,
+               resource: Spree.api.admin_variant_serializer,
+               if: proc { params[:includes]&.include?('variants') }
+
+          one :default_variant,
+              resource: Spree.api.admin_variant_serializer,
+              if: proc { params[:includes]&.include?('default_variant') }
+
+          one :master,
+              key: :master_variant,
+              resource: Spree.api.admin_variant_serializer,
+              if: proc { params[:includes]&.include?('master_variant') }
+
+          many :metafields,
+               resource: Spree.api.admin_metafield_serializer,
+               if: proc { params[:includes]&.include?('metafields') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Taxon Serializer
+        # Full taxon data including admin-only fields
+        class TaxonSerializer < V3::TaxonSerializer
+          typelize lft: :number, rgt: :number
+
+          # Nested set columns for tree operations
+          attributes :lft, :rgt
+
+          many :metafields,
+               resource: Spree.api.admin_metafield_serializer,
+               if: proc { params[:includes]&.include?('metafields') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Taxonomy Serializer
+        # Full taxonomy data including admin-only fields
+        class TaxonomySerializer < V3::TaxonomySerializer
+          many :metafields,
+               resource: Spree.api.admin_metafield_serializer,
+               if: proc { params[:includes]&.include?('metafields') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Variant Serializer
+        # Full variant data including admin-only fields
+        class VariantSerializer < V3::VariantSerializer
+
+          # 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],
+                   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
+
+          attribute :total_on_hand do |variant|
+            variant.total_on_hand
+          end
+
+          # All prices for this variant (for admin management)
+          many :prices,
+               resource: Spree.api.admin_price_serializer,
+               if: proc { params[:includes]&.include?('prices') }
+
+          many :metafields,
+               resource: Spree.api.admin_metafield_serializer,
+               if: proc { params[:includes]&.include?('metafields') }
+
+          # TODO: Add stock_items association when Admin API is implemented
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class AssetSerializer < BaseSerializer
+        typelize type: [:string, nullable: true], viewable_type: :string,
+                 viewable_id: :string, position: [:number, nullable: true],
+                 alt: [:string, nullable: true]
+
+        attribute :viewable_id do |asset|
+          asset.viewable&.prefixed_id
+        end
+
+        attributes :type, :viewable_type, :position, :alt,
+                   created_at: :iso8601, updated_at: :iso8601
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+module Spree
+  module Api
+    module V3
+      class BaseSerializer
+        include Alba::Resource
+        include Typelizer::DSL
+
+        # Common type hints for fields present in most serializers
+        typelize id: :string, created_at: :string, updated_at: :string
+
+        # Use prefixed IDs (Stripe-style) for all API v3 serializers
+        # e.g., prod_86Rf07xd4z, variant_k5nR8xLq, or_m3Rp9wXz
+        attribute :id do |object|
+          next nil unless object.respond_to?(:prefixed_id)
+
+          object.prefixed_id
+        end
+
+        # Context accessors
+        def current_store
+          params[:store]
+        end
+
+        def current_currency
+          params[:currency]
+        end
+
+        def current_user
+          params[:user]
+        end
+
+        def current_locale
+          params[:locale]
+        end
+
+        def includes
+          @includes ||= Array(params[:includes] || [])
+        end
+
+        # Check if an association should be included
+        def include?(name)
+          includes.include?(name.to_s)
+        end
+
+        # Get nested includes for a given parent
+        def nested_includes_for(parent)
+          prefix = "#{parent}."
+          includes.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(includes: parent ? nested_includes_for(parent) : [])
+        end
+
+        # Returns price for a variant using full Price List resolution
+        # This may return a price from a price list if applicable
+        # Memoized per variant to avoid duplicate queries
+        def price_for(variant, quantity: nil)
+          return nil unless variant.respond_to?(:price_for)
+
+          @price_for_cache ||= {}
+          cache_key = [variant.id, quantity]
+          return @price_for_cache[cache_key] if @price_for_cache.key?(cache_key)
+
+          @price_for_cache[cache_key] = variant.price_for(
+            currency: current_currency,
+            store: current_store,
+            user: current_user,
+            quantity: quantity
+          )
+        end
+
+        # Returns the base price for a variant without Price List resolution
+        # This is the "original" price before any price list discounts
+        # Memoized per variant to avoid duplicate queries
+        def price_in(variant)
+          return nil unless variant.respond_to?(:price_in)
+
+          @price_in_cache ||= {}
+          return @price_in_cache[variant.id] if @price_in_cache.key?(variant.id)
+
+          @price_in_cache[variant.id] = variant.price_in(current_currency)
+        end
+
+        def image_url_for(image)
+          return nil if image.nil?
+          return nil unless image.respond_to?(:attached?) && image.attached?
+
+          # Handle Spree::Asset models (like Spree::Image) which have attachment inside
+          # vs direct ActiveStorage attachments (like taxon.image)
+          attachment = image.is_a?(Spree::Asset) ? image.attachment : image
+          Rails.application.routes.url_helpers.cdn_image_url(attachment)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Spree
+  module Api
+    module V3
+      class CountrySerializer
+        include Alba::Resource
+        include Typelizer::DSL
+
+        # ISO 3166-1 codes - iso is the identifier, no redundant id field
+        typelize iso: :string, iso3: :string, name: :string,
+                 states_required: :boolean, zipcode_required: :boolean,
+                 currency: [:string, nullable: true],
+                 default_locale: [:string, nullable: true],
+                 supported_locales: [:string, multi: true]
+
+        attributes :iso, :iso3, :name, :states_required, :zipcode_required
+
+        attribute :currency do |country|
+          country.market_currency
+        end
+
+        attribute :default_locale do |country|
+          country.market_locale
+        end
+
+        attribute :supported_locales do |country|
+          country.market_supported_locales
+        end
+
+        many :states,
+             resource: Spree.api.state_serializer,
+             if: proc { params[:includes]&.include?('states') }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  module Api
+    module V3
+      class CreditCardSerializer < BaseSerializer
+        typelize cc_type: :string, last_digits: :string, month: :number, year: :number,
+                 name: [:string, nullable: true], default: :boolean, gateway_payment_profile_id: [:string, nullable: true]
+
+        attributes :cc_type, :last_digits, :month, :year, :name, :default, :gateway_payment_profile_id
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class CustomerReturnSerializer < BaseSerializer
+        typelize number: :string, stock_location_id: [:string, nullable: true]
+
+        attributes :number, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :stock_location_id do |customer_return|
+          customer_return.stock_location&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V3
+      # Store API Customer Serializer
+      # Customer-facing user data
+      class CustomerSerializer < BaseSerializer
+        typelize email: :string, first_name: [:string, nullable: true], last_name: [:string, nullable: true],
+                 default_billing_address: { nullable: true }, default_shipping_address: { nullable: true }
+
+        attributes :email, :first_name, :last_name,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        many :addresses, resource: Spree.api.address_serializer
+        one :bill_address, key: :default_billing_address, resource: Spree.api.address_serializer
+        one :ship_address, key: :default_shipping_address, resource: Spree.api.address_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Spree
+  module Api
+    module V3
+      class DigitalLinkSerializer < BaseSerializer
+        typelize access_counter: :number, filename: :string, content_type: :string,
+                 download_url: :string,
+                 authorizable: :boolean, expired: :boolean, access_limit_exceeded: :boolean
+
+        attributes :access_counter, :filename, :content_type,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :download_url do |digital_link|
+          Spree::Core::Engine.routes.url_helpers.api_v3_store_digital_download_path(token: digital_link.token)
+        end
+
+        attribute :authorizable do |digital_link|
+          digital_link.authorizable?
+        end
+
+        attribute :expired do |digital_link|
+          digital_link.expired?
+        end
+
+        attribute :access_limit_exceeded do |digital_link|
+          digital_link.access_limit_exceeded?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class DigitalSerializer < BaseSerializer
+        typelize variant_id: [:string, nullable: true]
+
+        attributes created_at: :iso8601, updated_at: :iso8601
+
+        attribute :variant_id do |digital|
+          digital.variant&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ExportSerializer < BaseSerializer
+        typelize number: :string, type: [:string, nullable: true], format: [:string, nullable: true],
+                 user_id: [:string, nullable: true]
+
+        attributes :number, :type, :format,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :user_id do |export|
+          export.user&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class GiftCardBatchSerializer < BaseSerializer
+        typelize codes_count: :number, amount: [:string, nullable: true], currency: [:string, nullable: true],
+                 prefix: [:string, nullable: true], expires_at: [:string, nullable: true],
+                 created_by_id: [:string, nullable: true]
+
+        attributes :codes_count, :currency, :prefix,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :amount do |batch|
+          batch.amount&.to_s
+        end
+
+        attribute :expires_at do |batch|
+          batch.expires_at&.iso8601
+        end
+
+        attribute :created_by_id do |batch|
+          batch.created_by&.prefixed_id
+        end
+      end
+    end
+  end
+end