@spree/docs 0.1.229 → 0.1.231

package/dist/developer/how-to/custom-promotion.md

@@ -21,7 +21,7 @@ Rules determine whether a promotion is eligible for a given order. Each rule imp
 
 Create a new class inheriting from `Spree::PromotionRule`:
 
-```ruby app/models/spree/promotion/rules/minimum_quantity.rb
+```ruby server/app/models/spree/promotion/rules/minimum_quantity.rb
 module Spree
   class Promotion
     module Rules
@@ -67,7 +67,7 @@ The `options` hash passed to `eligible?` can include `:user`, `:email`, and othe
 
 Rules use Spree's preference system for configuration. Each preference creates getter/setter methods automatically:
 
-```ruby
+```ruby server/app/models/spree/promotion/rules/minimum_quantity.rb
 preference :amount, :decimal, default: 100.00
 preference :operator, :string, default: 'gte'
 preference :category_ids, :array, default: []
@@ -82,7 +82,7 @@ Available types: `:string`, `:integer`, `:decimal`, `:boolean`, `:array`.
 
 ### Step 2: Register the Rule
 
-```ruby config/initializers/spree.rb
+```ruby server/config/initializers/spree.rb
 Rails.application.config.after_initialize do
   Spree.promotions.rules << Spree::Promotion::Rules::MinimumQuantity
 end
@@ -90,11 +90,31 @@ end
 
 Registered rules are discoverable at `/api/v3/admin/promotion_rules/types` together with their preference schema, and the dashboard's promotion editor is built on that endpoint — your rule appears there with a generated preferences form, no UI work needed.
 
+The API names your rule by its **shorthand** — the class name demodulized and underscored, so `Spree::Promotion::Rules::MinimumQuantity` is `minimum_quantity`. That is what `/types` returns, what a promotion payload sends, and what the locale key below is named after. The Ruby class name is never accepted on the wire:
+
+
+```typescript Admin SDK
+await adminClient.promotions.rules.create('promo_xxx', {
+  type: 'minimum_quantity',
+  preferences: { amount: 3 },
+})
+```
+
+```bash cURL
+curl -X POST 'https://api.mystore.com/api/v3/admin/promotions/promo_xxx/promotion_rules' \
+  -H 'X-Spree-API-Key: sk_xxx' \
+  -H 'Content-Type: application/json' \
+  -d '{ "type": "minimum_quantity", "preferences": { "amount": 3 } }'
+```
+
+
+Override `self.api_type` on the class when you need the wire value to stay put across a rename.
+
 ### Step 3: Add Translations
 
 The rule's display name and description in the dashboard come from your locale file:
 
-```yaml config/locales/en.yml
+```yaml server/config/locales/en.yml
 en:
   spree:
     promotion_rule_types:
@@ -107,7 +127,7 @@ en:
 
 When your rule targets specific line items (not the whole order), implement `actionable?` so that item-level actions only discount matching items:
 
-```ruby app/models/spree/promotion/rules/brand.rb
+```ruby server/app/models/spree/promotion/rules/brand.rb
 module Spree
   class Promotion
     module Rules
@@ -153,7 +173,7 @@ Three declarations make a discount action:
 | `compute_amount(adjustable)` | The discount for one adjustable — a line item, fulfillment, or the order, matching your scope. Return a **negative** amount, or zero for "no discount". |
 | `perform(options = {})` | Called when the promotion is activated. For discount actions, delegate to `apply_via_adjuster(options)`. |
 
-```ruby app/models/spree/promotion/actions/tiered_discount.rb
+```ruby server/app/models/spree/promotion/actions/tiered_discount.rb
 module Spree
   class Promotion
     module Actions
@@ -195,7 +215,7 @@ With `discount_scope :order`, the winning amount is shared out proportionally ac
 
 For actions that don't create discounts (awarding points, sending notifications), implement `perform` alone:
 
-```ruby app/models/spree/promotion/actions/add_loyalty_points.rb
+```ruby server/app/models/spree/promotion/actions/add_loyalty_points.rb
 module Spree
   class Promotion
     module Actions
@@ -219,13 +239,13 @@ end
 
 ### Register and Translate
 
-```ruby config/initializers/spree.rb
+```ruby server/config/initializers/spree.rb
 Rails.application.config.after_initialize do
   Spree.promotions.actions << Spree::Promotion::Actions::TieredDiscount
 end
 ```
 
-```yaml config/locales/en.yml
+```yaml server/config/locales/en.yml
 en:
   spree:
     promotion_action_types:
@@ -240,7 +260,7 @@ Like rules, registered actions surface automatically in the dashboard's promotio
 
 Not every charge or reduction is a promotion. A gift wrap fee, a payment surcharge, or loyalty pricing has no rules, no coupon codes, and no competition — it just needs to be on the order whenever it applies. That's an **adjuster**: a class invoked on every recalculation that owns a family of [Fee](../core-concepts/fees.md) or [Discount](../core-concepts/discounts.md) rows.
 
-```ruby app/models/my_app/adjusters/gift_wrap.rb
+```ruby server/app/models/my_app/adjusters/gift_wrap.rb
 module MyApp
   module Adjusters
     class GiftWrap < Spree::Adjusters::Base
@@ -258,7 +278,7 @@ module MyApp
 end
 ```
 
-```ruby config/initializers/spree.rb
+```ruby server/config/initializers/spree.rb
 Rails.application.config.after_initialize do
   Spree.adjusters << MyApp::Adjusters::GiftWrap
 end
@@ -272,7 +292,7 @@ Custom discounts work the same way, writing `order.discounts` rows with your own
 
 ## Testing
 
-```ruby spec/models/spree/promotion/rules/minimum_quantity_spec.rb
+```ruby server/spec/models/spree/promotion/rules/minimum_quantity_spec.rb
 require 'spec_helper'
 
 RSpec.describe Spree::Promotion::Rules::MinimumQuantity do
@@ -300,7 +320,7 @@ RSpec.describe Spree::Promotion::Rules::MinimumQuantity do
 end
 ```
 
-```ruby spec/models/spree/promotion/actions/tiered_discount_spec.rb
+```ruby server/spec/models/spree/promotion/actions/tiered_discount_spec.rb
 require 'spec_helper'
 
 RSpec.describe Spree::Promotion::Actions::TieredDiscount do

package/dist/developer/multi-tenant/quickstart.md

@@ -44,7 +44,7 @@ spree eject
 
 ### Adding gems
 
-1. Add the following code to your `backend/Gemfile`:
+1. Add the following code to your `server/Gemfile`:
 
     ```ruby
     source "https://license:#{ENV['KEYGEN_LICENSE_KEY']}@rubygems.pkg.keygen.sh/#{ENV['KEYGEN_ACCOUNT_ID']}" do
@@ -66,10 +66,10 @@ spree eject
 >       In that case the Gemfile reads `KEYGEN_LICENSE_KEY` / `KEYGEN_ACCOUNT_ID` directly from
 >       your shell environment.
 
-    Wrap **every** `bundle install` in your `backend/Dockerfile` with the secret mounts. There
+    Wrap **every** `bundle install` in your `server/Dockerfile` with the secret mounts. There
     are usually two — one in the build stage and one in the dev stage:
 
-    ```dockerfile backend/Dockerfile
+    ```dockerfile server/Dockerfile
     COPY .ruby-version Gemfile Gemfile.lock ./
     RUN bundle install # [!code --]
     RUN --mount=type=secret,id=keygen_license_key,env=KEYGEN_LICENSE_KEY,required=false \ # [!code ++]
@@ -185,7 +185,7 @@ development by default, but `.lvh.me` (and your production domain) are not — r
 `app.lvh.me` are rejected with a "Blocked hosts" error until you allow them. Add your root
 domain to `config/environments/development.rb`:
 
-```ruby backend/config/environments/development.rb
+```ruby server/config/environments/development.rb
 if (root_domain = ENV['SPREE_ROOT_DOMAIN']).present?
   config.hosts << ".#{root_domain}"
 end
@@ -200,7 +200,7 @@ to your customer user model automatically. You then need to **remove the `:valid
 manually. `:validatable` validates the user's email uniqueness globally; the concern re-validates
 it in the scope of the tenant instead, so the same email can exist across different tenants.
 
-```ruby backend/app/models/spree/user.rb
+```ruby server/app/models/spree/user.rb
 class Spree::User < Spree.base_class
   include Spree::UserAddress
   include Spree::UserMethods
@@ -222,7 +222,7 @@ The generator also changes your admin user model's base class from `Spree.base_c
 `Spree::Base`. If your `admin_user.rb` exists, this is applied automatically; otherwise make the
 change yourself:
 
-```ruby backend/app/models/spree/admin_user.rb
+```ruby server/app/models/spree/admin_user.rb
 class Spree::AdminUser < Spree.base_class # [!code --]
 class Spree::AdminUser < Spree::Base # [!code ++]
   include Spree::AdminUserMethods

package/dist/developer/storefront/nextjs/testing.md

@@ -61,7 +61,7 @@ npm run test:e2e
 
 ### A `create-spree-app` project's backend
 
-A project scaffolded with [`create-spree-app`](../../create-spree-app/quickstart.md) has its customizable Spree in `backend/` (built from `backend/Dockerfile`) and this storefront in `apps/storefront/`. Build that backend into a local image and point the suite at it — this is what tests the storefront against the **exact Spree you deploy**, extensions and all:
+A project scaffolded with [`create-spree-app`](../../create-spree-app/quickstart.md) has its customizable Spree in `server/` (built from `server/Dockerfile`) and this storefront in `apps/storefront/`. Build that backend into a local image and point the suite at it — this is what tests the storefront against the **exact Spree you deploy**, extensions and all:
 
 ```bash
 # From the project root — build the customized backend image
@@ -74,7 +74,7 @@ npm run test:e2e
 npm run e2e:down
 ```
 
-> **NOTE:** New `create-spree-app` projects wire this into the generated storefront CI workflow automatically — the workflow builds `backend/Dockerfile` and runs the storefront E2E against that image rather than stock Spree.
+> **NOTE:** New `create-spree-app` projects wire this into the generated storefront CI workflow automatically — the workflow builds `server/Dockerfile` and runs the storefront E2E against that image rather than stock Spree.
 
 ### Interactive / manual
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spree/docs",
-  "version": "0.1.229",
+  "version": "0.1.231",
   "description": "Spree Commerce developer documentation for AI agents and local reference",
   "type": "module",
   "license": "CC-BY-4.0",