@spree/docs 0.1.298 → 0.1.300

package/dist/api-reference/store.yaml

@@ -8461,7 +8461,7 @@ paths:
                   client_secret: secret_123
                 payment_method_id: pm_UkLWZg9DAJ
                 payment_source_id: card_UkLWZg9DAJ
-                payment_source_type: Spree::CreditCard
+                payment_source_type: credit_card
                 customer_id: cust_UkLWZg9DAJ
                 payment_method:
                   id: pm_UkLWZg9DAJ
@@ -11738,7 +11738,7 @@ components:
           type: array
           items:
             type: string
-          description: Subject class names, e.g. ["Spree::Product"] or ["all"]
+          description: Subject short names, e.g. ["product"] or ["all"]
         has_conditions:
           type: boolean
           description: True if the server-side rule has per-record conditions. The
@@ -12746,9 +12746,6 @@ components:
           type: string
         label:
           type: string
-        type:
-          type: string
-          deprecated: true
         field_type:
           type: string
           enum:
@@ -12765,7 +12762,6 @@ components:
       required:
       - id
       - label
-      - type
       - field_type
       - key
       - value

package/dist/developer/core-concepts/channels.md

@@ -38,7 +38,7 @@ erDiagram
 | `default` | Exactly one channel per store is the default. Used as a fallback when no channel header is present and as the auto-publish target for new products | `true` |
 | `storefront_access` | Controls what an anonymous visitor may see: `public`, `prices_hidden`, or `login_required`. Unset inherits the store's setting. See [Storefront Access Gating](#storefront-access-gating) | `login_required` |
 | `guest_checkout` | Whether an order may be placed without an account on this channel. Unset inherits the store's setting | `false` |
-| `preferred_order_routing_strategy` | Optional per-channel override of the store's [Order Routing](../how-to/custom-order-routing.md) strategy | `Spree::OrderRouting::Strategy::Rules` |
+| `preferred_order_routing_strategy` | Optional per-channel override of the store's [Order Routing](../how-to/custom-order-routing.md) strategy | `rules` |
 
 `code` is normalized to a URL-safe slug on save — `POS` becomes `pos`, `Point of Sale!` becomes `point-of-sale`. Leaving `code` blank derives it from `name`.
 

package/dist/developer/core-concepts/freight.md

@@ -243,7 +243,7 @@ split.
 ```typescript Admin SDK
 await adminClient.deliveryMethods.create({
   name: 'Pallet freight',
-  rate_provider: 'Spree::DeliveryRateProvider::Freight',
+  rate_provider: 'freight',
   rules: [
     { type: 'volume_rule', preferences: { minimum_volume: 1, maximum_volume: 15 } },
     { type: 'company_rule', preferences: { company_orders_only: true } },
@@ -257,7 +257,7 @@ curl -X POST 'https://api.mystore.com/api/v3/admin/delivery_methods' \
   -H 'Content-Type: application/json' \
   -d '{
     "name": "Pallet freight",
-    "rate_provider": "Spree::DeliveryRateProvider::Freight",
+    "rate_provider": "freight",
     "rules": [
       { "type": "volume_rule", "preferences": { "minimum_volume": 1, "maximum_volume": 15 } },
       { "type": "company_rule", "preferences": { "company_orders_only": true } }

package/dist/developer/core-concepts/fulfillments.md

@@ -257,6 +257,16 @@ curl 'https://api.mystore.com/api/v3/store/delivery_methods/dm_xxx/pickup_locati
 ```
 
 
+Third-party pickup points come from a pickup point provider — a locker network or partner-shop integration. Spree ships none; an extension registers its provider so a delivery method can select it by its short name (for example `inpost` for `SpreeInpost::PickupPointProvider`):
+
+```ruby server/config/initializers/spree.rb
+Rails.application.config.after_initialize do
+  Spree.pickup_point_providers << SpreeInpost::PickupPointProvider
+end
+```
+
+A delivery method can only use a registered provider.
+
 ## Managing fulfillments
 
 

package/dist/developer/core-concepts/metafields.md

@@ -71,7 +71,7 @@ Because the definition carries the type and the label, the dashboard can build a
 
 ```typescript Admin SDK
 const definition = await adminClient.customFieldDefinitions.create({
-  resource_type: 'Spree::Product',
+  resource_type: 'product',
   namespace: 'properties',
   key: 'material',
   label: 'Material',
@@ -83,7 +83,7 @@ const definition = await adminClient.customFieldDefinitions.create({
 
 ```bash CLI
 spree api post /custom_field_definitions -d '{
-  "resource_type": "Spree::Product",
+  "resource_type": "product",
   "namespace": "properties",
   "key": "material",
   "label": "Material",

package/dist/developer/core-concepts/payments.md

@@ -686,7 +686,7 @@ sequenceDiagram
 | `external_client_secret` | Client secret for the frontend SDK | `seti_ABC123_secret_xyz` |
 | `external_data` | Provider-specific data | `{}` |
 | `payment_source_id` | The saved payment source created after completion | `card_xyz789` |
-| `payment_source_type` | The type of saved payment source | `Spree::CreditCard` |
+| `payment_source_type` | The type of saved payment source | `credit_card` |
 
 ### Payment Setup Session API
 

package/dist/developer/dashboard/customization/navigation.md

@@ -22,7 +22,7 @@ nav.add({
   path: '/analytics',      // prefixed with /$storeId at render time
   icon: BarChartIcon,
   position: 650,
-  subject: 'Spree::Order', // optional permission subject — hides item without read permission
+  subject: 'order', // optional permission subject — hides item without read permission
 })
 ```
 
@@ -70,7 +70,7 @@ nav.addChild('products', {
   key: 'products.brands',
   label: 'Brands',
   path: '/products/brands',
-  subject: 'Spree::Brand',
+  subject: 'brand',
 })
 ```
 
@@ -177,7 +177,7 @@ settingsNav.add({
   path: '/integrations/stripe-tax',  // prefixed with /$storeId/settings
   group: 'integrations',
   position: 100,
-  subject: 'Spree::TaxRate',
+  subject: 'tax_rate',
 })
 ```
 

package/dist/developer/dashboard/customization/permissions.md

@@ -33,10 +33,10 @@ interface Permissions {
 It mirrors the backend ability at the **class level**:
 
 ```ts
-permissions.can('read', 'Spree::Order')
+permissions.can('read', 'order')
 ```
 
-Subjects are strings (`'Spree::Order'`, `'Spree::Product'`, or your own `'MyApp::Report'`). There is no client-side record-level check — when a rule is conditional on record attributes, `isConditional` returns `true` and the API is the arbiter: render the control and handle a possible 403.
+Subjects are short names: the model's class name without its namespace, underscored (`'order'`, `'product'`, or `'report'` for your own `MyApp::Report`). Use the `Subject` constants from `@spree/dashboard-core` for Spree's own models. There is no client-side record-level check — when a rule is conditional on record attributes, `isConditional` returns `true` and the API is the arbiter: render the control and handle a possible 403.
 
 ## `subject` shortcut
 
@@ -47,7 +47,7 @@ nav.add({
   key: 'reports',
   label: 'Reports',
   path: '/reports',
-  subject: 'Spree::Order',  // hides nav item without read:Spree::Order
+  subject: 'order',  // hides nav item without read:order
 })
 ```
 
@@ -58,7 +58,7 @@ routes: [{
   key: 'reports',
   path: '/reports',
   component: ReportsPage,
-  subject: 'Spree::Order',
+  subject: 'order',
 }],
 ```
 
@@ -76,7 +76,7 @@ nav.add({
   label: 'Reports',
   path: '/reports',
   if: ({ permissions, store }) =>
-    permissions.can('read', 'Spree::Order') &&
+    permissions.can('read', 'order') &&
     !!(store as Store | null)?.setup_tasks?.every((task) => task.done),
 })
 ```
@@ -94,18 +94,18 @@ import { usePermissions } from '@spree/dashboard'
 
 function ReportsPage() {
   const { permissions } = usePermissions()
-  if (!permissions.can('read', 'Spree::Order')) {
+  if (!permissions.can('read', 'order')) {
     return <Forbidden />
   }
   return <ReportsList />
 }
 ```
 
-The same `permissions` object backs the nav registry's `if` predicate, so you can move logic between the two without changing behaviour. For declarative gating, `<Can I="update" a="Spree::Order">…</Can>` (also from `@spree/dashboard-core`) renders children only when the check passes.
+The same `permissions` object backs the nav registry's `if` predicate, so you can move logic between the two without changing behaviour. For declarative gating, `<Can I="update" a="order">…</Can>` (also from `@spree/dashboard-core`) renders children only when the check passes.
 
 ## Custom permissions
 
-If your customization introduces a new model on the backend, register it as a permission catalog scope there (`Spree.permissions.register_scope` in your engine's initializer). Its keys then appear in the role editor and the API-key scope picker, and any role granted them makes `permissions.can('read', 'MyApp::Report')` resolve in the dashboard exactly like a first-party check — the abilities ship with the current-user response (`GET /api/v3/admin/me`) at sign-in, alongside `permission_keys`, the flat key list the role editor grants from.
+If your customization introduces a new model on the backend, register it as a permission catalog scope there (`Spree.permissions.register_scope` in your engine's initializer). Its keys then appear in the role editor and the API-key scope picker, and any role granted them makes `permissions.can('read', 'report')` resolve in the dashboard exactly like a first-party check — the abilities ship with the current-user response (`GET /api/v3/admin/me`) at sign-in, alongside `permission_keys`, the flat key list the role editor grants from.
 
 ## Reference
 

package/dist/developer/dashboard/customization/routes.md

@@ -135,7 +135,7 @@ routes: [{
   key: 'reports',
   path: '/reports',
   component: ReportsPage,
-  subject: 'Spree::Order',
+  subject: 'order',
 }],
 ```
 

package/dist/developer/dashboard/customization/slots.md

@@ -68,7 +68,7 @@ import { usePermissions } from '@spree/dashboard'
 
 function AdminOnlyMenuItem() {
   const { permissions } = usePermissions()
-  if (!permissions.can('manage', 'Spree::Customer')) return null
+  if (!permissions.can('manage', 'customer')) return null
   return <DropdownMenuItem>…</DropdownMenuItem>
 }
 ```

package/dist/developer/dashboard/recipes/custom-form-field.md

@@ -15,7 +15,7 @@ Create a definition for products (Settings → Custom fields, the in-place "Set
 
 ```bash
 npx spree api post custom_field_definitions --data '{
-  "resource_type": "Spree::Product",
+  "resource_type": "product",
   "namespace": "specs",
   "key": "tech_specs",
   "label": "Technical specifications",

package/dist/developer/dashboard/recipes/page-action-button.md

@@ -33,7 +33,7 @@ export function SendInvoiceButton({ resource }: Props) {
   })
 
   // Only show to users who can act, and only on completed orders.
-  if (!permissions.can('update', 'Spree::Order')) return null
+  if (!permissions.can('update', 'order')) return null
   if (resource.status !== 'placed') return null
 
   return (
@@ -95,7 +95,7 @@ export function SyncToErpItem({ resource }: Props) {
     successMessage: 'Synced',
   })
 
-  if (!permissions.can('manage', 'Spree::Order')) return null
+  if (!permissions.can('manage', 'order')) return null
 
   return (
     <DropdownMenuItem

package/dist/developer/dashboard/recipes/sidebar-widget.md

@@ -42,7 +42,7 @@ interface Props {
 export function LoyaltyStatusCard({ customer }: Props) {
   const { storeId } = useStore()
   const { permissions } = usePermissions()
-  const canRead = permissions.can('read', 'MyApp::LoyaltyRecord')
+  const canRead = permissions.can('read', 'loyalty_record')
   const { data, isLoading } = useQuery({
     queryKey: ['loyalty', storeId, customer.id],
     queryFn: () =>

package/dist/developer/dashboard/slots-catalog.md

@@ -44,7 +44,7 @@ import { usePermissions, useStore } from '@spree/dashboard'
 function MyWidget({ product }: { product: Product }) {
   const { permissions } = usePermissions()
   const { store } = useStore()
-  if (!permissions.can('read', 'MyApp::LoyaltyRecord')) return null
+  if (!permissions.can('read', 'loyalty_record')) return null
   // ...
 }
 ```

package/dist/developer/how-to/build-a-b2b-store.md

@@ -808,7 +808,7 @@ A method priced by the **Freight** rate provider returns an unpriced rate. It re
 ```typescript Admin SDK
 await adminClient.deliveryMethods.create({
   name: 'Pallet freight',
-  rate_provider: 'Spree::DeliveryRateProvider::Freight',
+  rate_provider: 'freight',
   rules: [
     { type: 'volume_rule', preferences: { minimum_volume: 1, maximum_volume: 15 } },
     { type: 'company_rule', preferences: { company_orders_only: true } },
@@ -822,7 +822,7 @@ curl -X POST 'https://api.mystore.com/api/v3/admin/delivery_methods' \
   -H 'Content-Type: application/json' \
   -d '{
         "name": "Pallet freight",
-        "rate_provider": "Spree::DeliveryRateProvider::Freight",
+        "rate_provider": "freight",
         "rules": [
           { "type": "volume_rule", "preferences": { "minimum_volume": 1, "maximum_volume": 15 } },
           { "type": "company_rule", "preferences": { "company_orders_only": true } }

package/dist/developer/how-to/custom-digital-asset-provider.md

@@ -94,7 +94,7 @@ end
 
 Once registered, the provider appears as a source on the product's **Digital files** card: the **Add** button becomes a menu offering **Upload a file** alongside each registered provider. Picking your provider creates an asset with its `provider_type` set and no file attached.
 
-> **NOTE:** Registration is what makes a `provider_type` valid. An asset validates that its `provider_type` names a registered provider, so an unregistered or misspelled class name is rejected with a 422 rather than failing at download time. A blank `provider_type` is always the built-in `File` provider.
+> **NOTE:** Registration is what makes a `provider_type` valid. The Admin API names a provider by its shorthand — the class name's last segment, underscored, so `license_key` for the provider above and `file` for the built-in one — and an asset validates that its `provider_type` names a registered provider, so an unregistered or misspelled value is rejected with a 422 rather than failing at download time. A blank `provider_type` is always the built-in `File` provider.
 
 ## The download contract
 

package/dist/developer/how-to/custom-order-routing.md

@@ -236,7 +236,11 @@ First register the class so it's selectable (this is the allowlist the model val
 Spree.order_routing.strategies << 'Acme::Oms::Strategy'.constantize
 ```
 
-Then select it by class name string — set on `Spree::Store` (default) or `Spree::Channel` (override). Setting an unregistered class fails validation.
+Then select it — set on `Spree::Store` (default) or `Spree::Channel` (override). Setting an unregistered strategy fails validation. Ruby code may name the class; the Admin API and the dashboard name a strategy by its shorthand, `api_type` (the class name's last segment, underscored — `rules` for the built-in one). Override `self.api_type` on your strategy to give it a distinct, stable shorthand:
+
+```ruby
+def self.api_type = 'acme_oms'
+```
 
 Activate on the whole store:
 

package/dist/developer/sdk/admin/resources.md

@@ -122,7 +122,7 @@ await client.products.customFields.create('prod_xxx', {
 The generic escape hatch covers any owner type:
 
 ```typescript
-await client.customFields('Spree::Product', 'prod_xxx').list()
+await client.customFields('product', 'prod_xxx').list()
 ```
 
 ## Adding your own resources

package/dist/developer/upgrades/5.6-to-6.0.md

@@ -495,6 +495,19 @@ now returns `nil` for an ID with another model's prefix, the same as
 `find_by_prefix_id`. Call `Spree::PrefixedId.decode_prefixed_id` if you
 really need to decode any prefix.
 
+## Type values are short names, not class names
+
+The API no longer sends or accepts Ruby class names. Every value that used to name a class is now a short name (`Spree::CreditCard` becomes `credit_card`), so the API keeps the same shape whatever the server is built with. Records in the database are not touched.
+
+If your storefront or webhook receiver reads any of these fields, compare against the short name instead:
+
+| Field | Where | Before | After |
+|---|---|---|---|
+| `payment_source_type` | Store API payment setup sessions, `payment_setup_session.*` webhooks | `Spree::CreditCard` | `credit_card` |
+| `type` | Custom fields on products, variants, categories and collections | `Spree::CustomFields::ShortText` | removed — read `field_type` (`short_text`) |
+
+The Admin API follows the same rule everywhere: providers and strategies (`fulfillment_provider: 'manual'`, `preferred_order_routing_strategy: 'rules'`), custom field definition `resource_type` (`product`, `category`), tag `taggable_type`, the owner and originator types on records, the permission subjects `/me` returns (`product`, `category`), and filters such as `q[type_eq]=orders`. An integration written against the Admin API preview sends and expects these short names; the [Admin SDK](../sdk/admin/resources.md) types list them.
+
 ## Every event is declared
 
 Events are now declared on the model that publishes them (`publishes_event`, `publishes_events`), and `publish_event` raises in development and test for a name nobody declared. Extensions that publish their own events need one line each — see [Publishing your own events](../core-concepts/events.md#publishing-your-own-events). In production an undeclared event is logged and still delivered.

package/dist/integrations/payments/stripe-connect.md

@@ -21,10 +21,10 @@ The same setting through the Admin API:
 
 ```typescript Admin SDK
 const { data: providers } = await adminClient.payoutProviders.list()
-// find the row with id 'SpreeStripe::PayoutProvider' — `available` says whether this store can use it
+// find the row with id 'stripe' — `available` says whether this store can use it
 
 await adminClient.store.update({
-  preferred_payout_provider: 'SpreeStripe::PayoutProvider',
+  preferred_payout_provider: 'stripe',
   preferred_default_payouts_schedule_interval: 'weekly',
   preferred_default_minimum_payout_amount: 50,
 })
@@ -34,7 +34,7 @@ await adminClient.store.update({
 curl -X PATCH https://your-store.com/api/v3/admin/store \
   -H "X-Spree-API-Key: sk_xxx" \
   -H "Content-Type: application/json" \
-  -d '{"preferred_payout_provider": "SpreeStripe::PayoutProvider", "preferred_default_payouts_schedule_interval": "weekly", "preferred_default_minimum_payout_amount": 50}'
+  -d '{"preferred_payout_provider": "stripe", "preferred_default_payouts_schedule_interval": "weekly", "preferred_default_minimum_payout_amount": 50}'
 ```
 
 

package/package.json

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