spree_api 5.4.4 → 5.5.0.rc1

data/lib/spree/api/openapi/schema_helper.rb

@@ -86,6 +86,26 @@ module Spree
               },
               required: %w[token refresh_token user]
             },
+            PermissionRule: {
+              type: :object,
+              description: 'A single permission rule (CanCanCan rule). Rules are applied in order, last-matching-wins.',
+              properties: {
+                allow: { type: :boolean, description: 'true for `can`, false for `cannot`' },
+                actions: { type: :array, items: { type: :string }, description: 'Action names, e.g. ["read", "update"] or ["manage"]' },
+                subjects: { type: :array, items: { type: :string }, description: 'Subject class names, e.g. ["Spree::Product"] or ["all"]' },
+                has_conditions: { type: :boolean, description: 'True if the server-side rule has per-record conditions. The SPA shows the action optimistically and handles 403 from the API.' }
+              },
+              required: %w[allow actions subjects has_conditions]
+            },
+            MeResponse: {
+              type: :object,
+              description: 'Current admin user profile and serialized permissions',
+              properties: {
+                user: { '$ref' => '#/components/schemas/AdminUser' },
+                permissions: { type: :array, items: { '$ref' => '#/components/schemas/PermissionRule' } }
+              },
+              required: %w[user permissions]
+            },
             CheckoutRequirement: {
               type: :object,
               properties: {
@@ -110,21 +130,60 @@ module Spree
               type: :object,
               description: 'An item within a fulfillment — which line item and how many units are in this fulfillment',
               properties: {
-                item_id: { type: :string, description: 'Line item prefixed ID', example: 'li_abc123' },
-                variant_id: { type: :string, description: 'Variant prefixed ID', example: 'variant_abc123' },
+                item_id: { type: :string, description: 'Line item ID', example: 'li_abc123' },
+                variant_id: { type: :string, description: 'Variant ID', example: 'variant_abc123' },
                 quantity: { type: :integer, description: 'Quantity in this fulfillment', example: 2 }
               },
               required: %w[item_id variant_id quantity]
+            },
+            AdminUserRoleAssignment: {
+              type: :object,
+              description: 'A role assignment for the current store on a staff member',
+              properties: {
+                id: { type: :string, description: 'Prefixed role ID', example: 'role_abc123' },
+                name: { type: :string, description: 'Role name', example: 'admin' }
+              },
+              required: %w[id name]
+            },
+            PreferenceField: {
+              type: :object,
+              description: 'A single configurable preference on a payment method, promotion rule/action, or calculator. The frontend uses `type` + `default` to render a sensible input.',
+              properties: {
+                key: { type: :string, example: 'amount_min' },
+                type: { type: :string, example: 'decimal', description: 'string | text | password | integer | decimal | boolean | array | hash' },
+                default: { description: 'Default value (any JSON type), null when there is no default', nullable: true }
+              },
+              required: %w[key type]
+            },
+            PromotionActionCalculator: {
+              type: :object,
+              description: "The action's nested calculator (when the action carries one — null for actions like `free_shipping`)",
+              properties: {
+                type: { type: :string, example: 'flat_rate', description: 'Wire shorthand for the calculator subclass' },
+                label: { type: :string, example: 'Flat Rate' },
+                preferences: { type: :object, additionalProperties: true },
+                preference_schema: { type: :array, items: { '$ref' => '#/components/schemas/PreferenceField' } }
+              },
+              required: %w[type label preferences preference_schema]
+            },
+            PromotionActionLineItem: {
+              type: :object,
+              description: 'One row in a `create_line_items` action — the variant added to the order and how many',
+              properties: {
+                variant_id: { type: :string, example: 'variant_abc123' },
+                quantity: { type: :integer, example: 1 }
+              },
+              required: %w[variant_id quantity]
             }
           }
         end
 
-        # Get all schemas (Typelizer + common)
+        # Get all store schemas (Typelizer + common)
         def all_schemas
           schemas = common_schemas
 
           begin
-            schemas.merge!(typelizer_schemas)
+            schemas.merge!(typelizer_schemas(:store))
           rescue StandardError => e
             Rails.logger.warn "Failed to load Typelizer schemas: #{e.message}"
           end
@@ -132,17 +191,45 @@ module Spree
           schemas
         end
 
+        # Get all admin schemas (Typelizer + common)
+        def admin_schemas
+          schemas = common_schemas
+
+          # Override AuthResponse for admin: reference AdminUser, and drop refresh_token from the body
+          # (admin sets the refresh token as an HttpOnly cookie, not in the JSON response).
+          schemas[:AuthResponse] = {
+            type: :object,
+            properties: {
+              token: { type: :string, description: 'JWT access token' },
+              user: { '$ref' => '#/components/schemas/AdminUser' }
+            },
+            required: %w[token user]
+          }
+
+          begin
+            schemas.merge!(typelizer_schemas(:admin))
+          rescue StandardError => e
+            Rails.logger.warn "Failed to load Typelizer admin schemas: #{e.message}"
+          end
+
+          schemas
+        end
+
         private
 
-        def typelizer_schemas
+        def typelizer_schemas(writer_name)
           with_typelizer_enabled do
-            schemas = Typelizer.openapi_schemas(writer_name: :store)
+            schemas = Typelizer.openapi_schemas(writer_name: writer_name)
             schemas.each_value do |s|
               s[:'x-typelizer'] = true
               strip_null_from_enums(s)
             end
             patch_cart_schema(schemas)
             patch_fulfillment_schema(schemas)
+            patch_admin_user_schema(schemas)
+            patch_promotion_rule_schema(schemas)
+            patch_promotion_action_schema(schemas)
+            patch_price_rule_schema(schemas)
             schemas
           end
         end
@@ -173,6 +260,98 @@ module Spree
           end
         end
 
+        # Same Array<{...}> issue as cart/fulfillment — patch AdminUser#roles
+        # to reference the AdminUserRoleAssignment component schema.
+        def patch_admin_user_schema(schemas)
+          admin_user = schemas['AdminUser'] || schemas[:AdminUser]
+          return unless admin_user
+
+          props = admin_user[:properties]
+          return unless props
+
+          roles_key = props.key?('roles') ? 'roles' : :roles
+          if props[roles_key]
+            props[roles_key] = {
+              type: :array,
+              items: { '$ref' => '#/components/schemas/AdminUserRoleAssignment' }
+            }
+          end
+        end
+
+        # Same Array<{...}> + Array<string> typelize hints that Typelizer
+        # collapses to `object` in OpenAPI. Patch the affected properties to
+        # their correct array shapes.
+        def patch_promotion_rule_schema(schemas)
+          rule = schemas['PromotionRule'] || schemas[:PromotionRule]
+          return unless rule
+
+          patch_id_arrays(rule, %w[product_ids category_ids customer_ids])
+          patch_preference_schema(rule)
+        end
+
+        def patch_price_rule_schema(schemas)
+          rule = schemas['PriceRule'] || schemas[:PriceRule]
+          return unless rule
+
+          patch_preference_schema(rule)
+        end
+
+        def patch_promotion_action_schema(schemas)
+          action = schemas['PromotionAction'] || schemas[:PromotionAction]
+          return unless action
+
+          patch_preference_schema(action)
+
+          props = action[:properties]
+          return unless props
+
+          calc_key = props.key?('calculator') ? 'calculator' : :calculator
+          if props[calc_key]
+            props[calc_key] = {
+              allOf: [{ '$ref' => '#/components/schemas/PromotionActionCalculator' }],
+              nullable: true
+            }
+          end
+
+          items_key = props.key?('line_items') ? 'line_items' : :line_items
+          if props[items_key]
+            props[items_key] = {
+              type: :array,
+              items: { '$ref' => '#/components/schemas/PromotionActionLineItem' },
+              nullable: true
+            }
+          end
+        end
+
+        def patch_id_arrays(schema, keys)
+          props = schema[:properties]
+          return unless props
+
+          keys.each do |key|
+            actual = props.key?(key) ? key : key.to_sym
+            next unless props[actual]
+
+            props[actual] = {
+              type: :array,
+              items: { type: :string },
+              nullable: true
+            }
+          end
+        end
+
+        def patch_preference_schema(schema)
+          props = schema[:properties]
+          return unless props
+
+          key = props.key?('preference_schema') ? 'preference_schema' : :preference_schema
+          return unless props[key]
+
+          props[key] = {
+            type: :array,
+            items: { '$ref' => '#/components/schemas/PreferenceField' }
+          }
+        end
+
         # Typelizer cannot represent Array<{...}> inline object types in OpenAPI,
         # so we patch Fulfillment#items to reference the FulfillmentManifestItem component schema.
         def patch_fulfillment_schema(schemas)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.4.4
+  version: 5.5.0.rc1
 platform: ruby
 authors:
 - Vendo Connect Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-20 00:00:00.000000000 Z
+date: 2026-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rswag-specs
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.4
+        version: 5.5.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.4
+        version: 5.5.0.rc1
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -89,20 +89,82 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- app/controllers/concerns/spree/api/v3/admin/auth_cookies.rb
+- app/controllers/concerns/spree/api/v3/admin/subclassed_resource.rb
+- app/controllers/concerns/spree/api/v3/admin_authentication.rb
 - app/controllers/concerns/spree/api/v3/api_key_authentication.rb
+- app/controllers/concerns/spree/api/v3/bulk_operations.rb
 - app/controllers/concerns/spree/api/v3/cart_resolvable.rb
+- app/controllers/concerns/spree/api/v3/channel_resolution.rb
 - app/controllers/concerns/spree/api/v3/error_handler.rb
 - app/controllers/concerns/spree/api/v3/http_caching.rb
 - app/controllers/concerns/spree/api/v3/idempotent.rb
 - app/controllers/concerns/spree/api/v3/jwt_authentication.rb
 - app/controllers/concerns/spree/api/v3/locale_and_currency.rb
 - app/controllers/concerns/spree/api/v3/order_lock.rb
+- app/controllers/concerns/spree/api/v3/params_normalizer.rb
 - app/controllers/concerns/spree/api/v3/rate_limit_headers.rb
 - app/controllers/concerns/spree/api/v3/resource_serializer.rb
+- app/controllers/concerns/spree/api/v3/scoped_authorization.rb
 - app/controllers/concerns/spree/api/v3/security_headers.rb
 - app/controllers/concerns/spree/api/v3/store/search_provider_support.rb
+- app/controllers/spree/api/v3/admin/admin_users_controller.rb
+- app/controllers/spree/api/v3/admin/allowed_origins_controller.rb
+- app/controllers/spree/api/v3/admin/api_keys_controller.rb
+- app/controllers/spree/api/v3/admin/auth_controller.rb
 - app/controllers/spree/api/v3/admin/base_controller.rb
+- app/controllers/spree/api/v3/admin/categories_controller.rb
+- app/controllers/spree/api/v3/admin/channels_controller.rb
+- app/controllers/spree/api/v3/admin/countries_controller.rb
+- app/controllers/spree/api/v3/admin/coupon_codes_controller.rb
+- app/controllers/spree/api/v3/admin/custom_field_definitions_controller.rb
+- app/controllers/spree/api/v3/admin/custom_fields_controller.rb
+- app/controllers/spree/api/v3/admin/customer_groups_controller.rb
+- app/controllers/spree/api/v3/admin/customers/addresses_controller.rb
+- app/controllers/spree/api/v3/admin/customers/credit_cards_controller.rb
+- app/controllers/spree/api/v3/admin/customers/store_credits_controller.rb
+- app/controllers/spree/api/v3/admin/customers_controller.rb
+- app/controllers/spree/api/v3/admin/dashboard_controller.rb
+- app/controllers/spree/api/v3/admin/direct_uploads_controller.rb
+- app/controllers/spree/api/v3/admin/exports_controller.rb
+- app/controllers/spree/api/v3/admin/gift_card_batches_controller.rb
+- app/controllers/spree/api/v3/admin/gift_cards_controller.rb
+- app/controllers/spree/api/v3/admin/invitation_acceptances_controller.rb
+- app/controllers/spree/api/v3/admin/invitations_controller.rb
+- app/controllers/spree/api/v3/admin/markets_controller.rb
+- app/controllers/spree/api/v3/admin/me_controller.rb
+- app/controllers/spree/api/v3/admin/media_controller.rb
+- app/controllers/spree/api/v3/admin/option_types_controller.rb
+- app/controllers/spree/api/v3/admin/orders/adjustments_controller.rb
+- app/controllers/spree/api/v3/admin/orders/base_controller.rb
+- app/controllers/spree/api/v3/admin/orders/fulfillments_controller.rb
+- app/controllers/spree/api/v3/admin/orders/gift_cards_controller.rb
+- app/controllers/spree/api/v3/admin/orders/items_controller.rb
+- app/controllers/spree/api/v3/admin/orders/payments_controller.rb
+- app/controllers/spree/api/v3/admin/orders/refunds_controller.rb
+- app/controllers/spree/api/v3/admin/orders/store_credits_controller.rb
+- app/controllers/spree/api/v3/admin/orders_controller.rb
+- app/controllers/spree/api/v3/admin/payment_methods_controller.rb
+- app/controllers/spree/api/v3/admin/price_lists_controller.rb
+- app/controllers/spree/api/v3/admin/prices_controller.rb
+- app/controllers/spree/api/v3/admin/products/variants_controller.rb
+- app/controllers/spree/api/v3/admin/products_controller.rb
+- app/controllers/spree/api/v3/admin/promotion_actions_controller.rb
+- app/controllers/spree/api/v3/admin/promotion_rules_controller.rb
+- app/controllers/spree/api/v3/admin/promotions_controller.rb
 - app/controllers/spree/api/v3/admin/resource_controller.rb
+- app/controllers/spree/api/v3/admin/roles_controller.rb
+- app/controllers/spree/api/v3/admin/stock_items_controller.rb
+- app/controllers/spree/api/v3/admin/stock_locations_controller.rb
+- app/controllers/spree/api/v3/admin/stock_reservations_controller.rb
+- app/controllers/spree/api/v3/admin/stock_transfers_controller.rb
+- app/controllers/spree/api/v3/admin/store_controller.rb
+- app/controllers/spree/api/v3/admin/store_credit_categories_controller.rb
+- app/controllers/spree/api/v3/admin/tags_controller.rb
+- app/controllers/spree/api/v3/admin/tax_categories_controller.rb
+- app/controllers/spree/api/v3/admin/variants_controller.rb
+- app/controllers/spree/api/v3/admin/webhook_deliveries_controller.rb
+- app/controllers/spree/api/v3/admin/webhook_endpoints_controller.rb
 - app/controllers/spree/api/v3/base_controller.rb
 - app/controllers/spree/api/v3/resource_controller.rb
 - app/controllers/spree/api/v3/store/auth_controller.rb
@@ -131,6 +193,7 @@ files:
 - app/controllers/spree/api/v3/store/locales_controller.rb
 - app/controllers/spree/api/v3/store/markets/countries_controller.rb
 - app/controllers/spree/api/v3/store/markets_controller.rb
+- app/controllers/spree/api/v3/store/newsletter_subscribers_controller.rb
 - app/controllers/spree/api/v3/store/orders_controller.rb
 - app/controllers/spree/api/v3/store/policies_controller.rb
 - app/controllers/spree/api/v3/store/products/filters_controller.rb
@@ -141,23 +204,32 @@ files:
 - app/controllers/spree/api/v3/webhooks/payments_controller.rb
 - app/jobs/spree/api_keys/mark_as_used.rb
 - app/jobs/spree/webhook_delivery_job.rb
+- app/models/spree/api_key_ability.rb
 - app/serializers/spree/api/v3/address_serializer.rb
 - app/serializers/spree/api/v3/admin/address_serializer.rb
 - app/serializers/spree/api/v3/admin/adjustment_serializer.rb
 - app/serializers/spree/api/v3/admin/admin_user_serializer.rb
 - app/serializers/spree/api/v3/admin/allowed_origin_serializer.rb
-- app/serializers/spree/api/v3/admin/asset_serializer.rb
+- app/serializers/spree/api/v3/admin/api_key_serializer.rb
 - app/serializers/spree/api/v3/admin/category_serializer.rb
+- app/serializers/spree/api/v3/admin/channel_serializer.rb
 - app/serializers/spree/api/v3/admin/country_serializer.rb
+- app/serializers/spree/api/v3/admin/coupon_code_serializer.rb
 - app/serializers/spree/api/v3/admin/credit_card_serializer.rb
+- app/serializers/spree/api/v3/admin/custom_field_definition_serializer.rb
 - app/serializers/spree/api/v3/admin/custom_field_serializer.rb
+- app/serializers/spree/api/v3/admin/customer_group_serializer.rb
 - app/serializers/spree/api/v3/admin/customer_serializer.rb
+- app/serializers/spree/api/v3/admin/dashboard_analytics_serializer.rb
 - app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
 - app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
 - app/serializers/spree/api/v3/admin/digital_link_serializer.rb
 - app/serializers/spree/api/v3/admin/discount_serializer.rb
+- app/serializers/spree/api/v3/admin/export_serializer.rb
 - app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
+- app/serializers/spree/api/v3/admin/gift_card_batch_serializer.rb
 - app/serializers/spree/api/v3/admin/gift_card_serializer.rb
+- app/serializers/spree/api/v3/admin/invitation_serializer.rb
 - app/serializers/spree/api/v3/admin/line_item_serializer.rb
 - app/serializers/spree/api/v3/admin/market_serializer.rb
 - app/serializers/spree/api/v3/admin/media_serializer.rb
@@ -168,23 +240,35 @@ files:
 - app/serializers/spree/api/v3/admin/payment_serializer.rb
 - app/serializers/spree/api/v3/admin/payment_source_serializer.rb
 - app/serializers/spree/api/v3/admin/price_history_serializer.rb
+- app/serializers/spree/api/v3/admin/price_list_serializer.rb
+- app/serializers/spree/api/v3/admin/price_rule_serializer.rb
 - app/serializers/spree/api/v3/admin/price_serializer.rb
+- app/serializers/spree/api/v3/admin/product_publication_serializer.rb
 - app/serializers/spree/api/v3/admin/product_serializer.rb
+- app/serializers/spree/api/v3/admin/promotion_action_serializer.rb
+- app/serializers/spree/api/v3/admin/promotion_rule_serializer.rb
+- app/serializers/spree/api/v3/admin/promotion_serializer.rb
 - app/serializers/spree/api/v3/admin/refund_serializer.rb
 - app/serializers/spree/api/v3/admin/reimbursement_serializer.rb
 - app/serializers/spree/api/v3/admin/return_authorization_serializer.rb
-- app/serializers/spree/api/v3/admin/shipping_category_serializer.rb
+- app/serializers/spree/api/v3/admin/role_serializer.rb
 - app/serializers/spree/api/v3/admin/state_serializer.rb
 - app/serializers/spree/api/v3/admin/stock_item_serializer.rb
 - app/serializers/spree/api/v3/admin/stock_location_serializer.rb
+- app/serializers/spree/api/v3/admin/stock_reservation_serializer.rb
+- app/serializers/spree/api/v3/admin/stock_transfer_serializer.rb
+- app/serializers/spree/api/v3/admin/store_credit_category_serializer.rb
 - app/serializers/spree/api/v3/admin/store_credit_serializer.rb
+- app/serializers/spree/api/v3/admin/store_serializer.rb
 - app/serializers/spree/api/v3/admin/tax_category_serializer.rb
 - app/serializers/spree/api/v3/admin/variant_serializer.rb
 - app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb
+- app/serializers/spree/api/v3/admin/webhook_endpoint_serializer.rb
 - app/serializers/spree/api/v3/asset_serializer.rb
 - app/serializers/spree/api/v3/base_serializer.rb
 - app/serializers/spree/api/v3/cart_serializer.rb
 - app/serializers/spree/api/v3/category_serializer.rb
+- app/serializers/spree/api/v3/channel_serializer.rb
 - app/serializers/spree/api/v3/country_serializer.rb
 - app/serializers/spree/api/v3/credit_card_serializer.rb
 - app/serializers/spree/api/v3/currency_serializer.rb
@@ -219,6 +303,7 @@ files:
 - app/serializers/spree/api/v3/policy_serializer.rb
 - app/serializers/spree/api/v3/price_history_serializer.rb
 - app/serializers/spree/api/v3/price_serializer.rb
+- app/serializers/spree/api/v3/product_publication_serializer.rb
 - app/serializers/spree/api/v3/product_serializer.rb
 - app/serializers/spree/api/v3/promotion_serializer.rb
 - app/serializers/spree/api/v3/refund_serializer.rb
@@ -231,6 +316,7 @@ files:
 - app/serializers/spree/api/v3/stock_item_serializer.rb
 - app/serializers/spree/api/v3/stock_location_serializer.rb
 - app/serializers/spree/api/v3/stock_movement_serializer.rb
+- app/serializers/spree/api/v3/stock_reservation_serializer.rb
 - app/serializers/spree/api/v3/stock_transfer_serializer.rb
 - app/serializers/spree/api/v3/store_credit_serializer.rb
 - app/serializers/spree/api/v3/tax_category_serializer.rb
@@ -253,6 +339,7 @@ files:
 - lib/spree/api/dependencies.rb
 - lib/spree/api/engine.rb
 - lib/spree/api/middleware/request_size_limit.rb
+- lib/spree/api/openapi/path_sorter.rb
 - lib/spree/api/openapi/schema_helper.rb
 - lib/spree/api/testing_support/factories.rb
 - lib/spree/api/testing_support/matchers/webhooks.rb
@@ -264,9 +351,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.4
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.5.0.rc1
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.4.4
+  source_code_uri: https://github.com/spree/spree/tree/v5.5.0.rc1
 post_install_message:
 rdoc_options: []
 require_paths:

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

@@ -1,14 +0,0 @@
-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