Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Merge branch 'main' into feat/seller-payouts

Damian Legawiecfba3aa335cce
diff --cc packages/admin-sdk/src/types/generated/SellerRequirementStatus.ts
index 91c0019cc7,9c9c94a487..b704205510
--- a/packages/admin-sdk/src/types/generated/SellerRequirementStatus.ts
+++ b/packages/admin-sdk/src/types/generated/SellerRequirementStatus.ts
@@@ -1,7 -1,7 +1,7 @@@
- // Typelizer digest 09545124df8c5b19913250147c0be3ac
-// Typelizer digest 31a4f85a680f632ab8f244338b42e7a3
++// Typelizer digest aff2a479d8767a5e6fe3e7417b5b9e94
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
- import type {SellerRequirementSubmission} from '@/types'
+ import type {SellerRequirementSubmission, Policy} from '@/types'
interface SellerRequirementStatus {
id: string;
@@@ -12,9 -12,10 +12,11 @@@
position: number;
status: string;
action_url: string | null;
+ blocker: { state: string; message: string | null } | null;
blocking: boolean;
+ required_policy_name: string | null;
submission?: SellerRequirementSubmission;
+ published_policy?: Policy;
}
export default SellerRequirementStatus;
diff --cc packages/admin-sdk/src/types/generated/index.ts
index 622c8e93d3,a813e9ab4e..91d795f4b7
--- a/packages/admin-sdk/src/types/generated/index.ts
+++ b/packages/admin-sdk/src/types/generated/index.ts
@@@ -1,4 -1,4 +1,4 @@@
- // Typelizer digest 6b72dd432f9ad836abc3a73207e757f7
-// Typelizer digest 8c445815bae3ce7c389cf8d6e481f7a1
++// Typelizer digest fbb5bda7997c319242cbc1176a37e74f
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
diff --cc packages/dashboard-starter/src/routeTree.gen.ts
index d49ab3583f,cf6c752f6c..dde5c800f3
--- a/packages/dashboard-starter/src/routeTree.gen.ts
+++ b/packages/dashboard-starter/src/routeTree.gen.ts
@@@ -41,7 -41,7 +41,8 @@@ import { Route as SettingsSellerRequire
import { Route as SettingsRolesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/roles'
import { Route as SettingsReasonsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/reasons'
import { Route as SettingsProductTypesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/product-types'
+ import { Route as SettingsPoliciesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/policies'
+import { Route as SettingsPayoutsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/payouts'
import { Route as SettingsPaymentMethodsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/payment-methods'
import { Route as SettingsMarketsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/markets'
import { Route as SettingsIntegrationsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/integrations'
@@@ -248,11 -248,11 +249,16 @@@ const SettingsProductTypesRoute = Setti
path: '/product-types',
getParentRoute: () => SettingsRoute,
} as any)
+ const SettingsPoliciesRoute = SettingsPoliciesRouteImport.update({
+ id: '/policies',
+ path: '/policies',
+ getParentRoute: () => SettingsRoute,
+ } as any)
+const SettingsPayoutsRoute = SettingsPayoutsRouteImport.update({
+ id: '/payouts',
+ path: '/payouts',
+ getParentRoute: () => SettingsRoute,
+} as any)
const SettingsPaymentMethodsRoute = SettingsPaymentMethodsRouteImport.update({
id: '/payment-methods',
path: '/payment-methods',
@@@ -524,7 -524,7 +530,8 @@@ export interface FileRoutesByFullPath
'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute
'/$storeId/settings/markets': typeof SettingsMarketsRoute
'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute
+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute
+ '/$storeId/settings/policies': typeof SettingsPoliciesRoute
'/$storeId/settings/product-types': typeof SettingsProductTypesRoute
'/$storeId/settings/reasons': typeof SettingsReasonsRoute
'/$storeId/settings/roles': typeof SettingsRolesRoute
@@@ -600,7 -600,7 +607,8 @@@ export interface FileRoutesByTo
'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute
'/$storeId/settings/markets': typeof SettingsMarketsRoute
'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute
+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute
+ '/$storeId/settings/policies': typeof SettingsPoliciesRoute
'/$storeId/settings/product-types': typeof SettingsProductTypesRoute
'/$storeId/settings/reasons': typeof SettingsReasonsRoute
'/$storeId/settings/roles': typeof SettingsRolesRoute
@@@ -680,7 -680,7 +688,8 @@@ export interface FileRoutesById
'/_authenticated/$storeId/settings/integrations': typeof SettingsIntegrationsRoute
'/_authenticated/$storeId/settings/markets': typeof SettingsMarketsRoute
'/_authenticated/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute
+ '/_authenticated/$storeId/settings/payouts': typeof SettingsPayoutsRoute
+ '/_authenticated/$storeId/settings/policies': typeof SettingsPoliciesRoute
'/_authenticated/$storeId/settings/product-types': typeof SettingsProductTypesRoute
'/_authenticated/$storeId/settings/reasons': typeof SettingsReasonsRoute
'/_authenticated/$storeId/settings/roles': typeof SettingsRolesRoute
@@@ -760,7 -760,7 +769,8 @@@ export interface FileRouteTypes
| '/$storeId/settings/integrations'
| '/$storeId/settings/markets'
| '/$storeId/settings/payment-methods'
+ | '/$storeId/settings/payouts'
+ | '/$storeId/settings/policies'
| '/$storeId/settings/product-types'
| '/$storeId/settings/reasons'
| '/$storeId/settings/roles'
@@@ -836,7 -836,7 +846,8 @@@
| '/$storeId/settings/integrations'
| '/$storeId/settings/markets'
| '/$storeId/settings/payment-methods'
+ | '/$storeId/settings/payouts'
+ | '/$storeId/settings/policies'
| '/$storeId/settings/product-types'
| '/$storeId/settings/reasons'
| '/$storeId/settings/roles'
@@@ -915,7 -915,7 +926,8 @@@
| '/_authenticated/$storeId/settings/integrations'
| '/_authenticated/$storeId/settings/markets'
| '/_authenticated/$storeId/settings/payment-methods'
+ | '/_authenticated/$storeId/settings/payouts'
+ | '/_authenticated/$storeId/settings/policies'
| '/_authenticated/$storeId/settings/product-types'
| '/_authenticated/$storeId/settings/reasons'
| '/_authenticated/$storeId/settings/roles'
@@@ -1190,13 -1190,13 +1202,20 @@@ declare module '@tanstack/react-router
preLoaderRoute: typeof SettingsProductTypesRouteImport
parentRoute: typeof SettingsRoute
}
+ '/_authenticated/$storeId/settings/policies': {
+ id: '/_authenticated/$storeId/settings/policies'
+ path: '/policies'
+ fullPath: '/$storeId/settings/policies'
+ preLoaderRoute: typeof SettingsPoliciesRouteImport
+ parentRoute: typeof SettingsRoute
+ }
+ '/_authenticated/$storeId/settings/payouts': {
+ id: '/_authenticated/$storeId/settings/payouts'
+ path: '/payouts'
+ fullPath: '/$storeId/settings/payouts'
+ preLoaderRoute: typeof SettingsPayoutsRouteImport
+ parentRoute: typeof SettingsRoute
+ }
'/_authenticated/$storeId/settings/payment-methods': {
id: '/_authenticated/$storeId/settings/payment-methods'
path: '/payment-methods'
@@@ -1518,7 -1518,7 +1537,8 @@@ interface SettingsRouteChildren
SettingsIntegrationsRoute: typeof SettingsIntegrationsRoute
SettingsMarketsRoute: typeof SettingsMarketsRoute
SettingsPaymentMethodsRoute: typeof SettingsPaymentMethodsRoute
+ SettingsPayoutsRoute: typeof SettingsPayoutsRoute
+ SettingsPoliciesRoute: typeof SettingsPoliciesRoute
SettingsProductTypesRoute: typeof SettingsProductTypesRoute
SettingsReasonsRoute: typeof SettingsReasonsRoute
SettingsRolesRoute: typeof SettingsRolesRoute
@@@ -1548,7 -1548,7 +1568,8 @@@ const SettingsRouteChildren: SettingsRo
SettingsIntegrationsRoute: SettingsIntegrationsRoute,
SettingsMarketsRoute: SettingsMarketsRoute,
SettingsPaymentMethodsRoute: SettingsPaymentMethodsRoute,
+ SettingsPayoutsRoute: SettingsPayoutsRoute,
+ SettingsPoliciesRoute: SettingsPoliciesRoute,
SettingsProductTypesRoute: SettingsProductTypesRoute,
SettingsReasonsRoute: SettingsReasonsRoute,
SettingsRolesRoute: SettingsRolesRoute,
diff --cc packages/dashboard/src/routeTree.gen.ts
index ef4603e6cc,bb20a27fb3..4425cb6b05
--- a/packages/dashboard/src/routeTree.gen.ts
+++ b/packages/dashboard/src/routeTree.gen.ts
@@@ -40,7 -40,7 +40,8 @@@ import { Route as SettingsSellerRequire
import { Route as SettingsRolesRouteImport } from './routes/_authenticated/$storeId/settings/roles'
import { Route as SettingsReasonsRouteImport } from './routes/_authenticated/$storeId/settings/reasons'
import { Route as SettingsProductTypesRouteImport } from './routes/_authenticated/$storeId/settings/product-types'
+ import { Route as SettingsPoliciesRouteImport } from './routes/_authenticated/$storeId/settings/policies'
+import { Route as SettingsPayoutsRouteImport } from './routes/_authenticated/$storeId/settings/payouts'
import { Route as SettingsPaymentMethodsRouteImport } from './routes/_authenticated/$storeId/settings/payment-methods'
import { Route as SettingsMarketsRouteImport } from './routes/_authenticated/$storeId/settings/markets'
import { Route as SettingsIntegrationsRouteImport } from './routes/_authenticated/$storeId/settings/integrations'
@@@ -241,11 -241,11 +242,16 @@@ const SettingsProductTypesRoute = Setti
path: '/product-types',
getParentRoute: () => SettingsRoute,
} as any)
+ const SettingsPoliciesRoute = SettingsPoliciesRouteImport.update({
+ id: '/policies',
+ path: '/policies',
+ getParentRoute: () => SettingsRoute,
+ } as any)
+const SettingsPayoutsRoute = SettingsPayoutsRouteImport.update({
+ id: '/payouts',
+ path: '/payouts',
+ getParentRoute: () => SettingsRoute,
+} as any)
const SettingsPaymentMethodsRoute = SettingsPaymentMethodsRouteImport.update({
id: '/payment-methods',
path: '/payment-methods',
@@@ -511,7 -511,7 +517,8 @@@ export interface FileRoutesByFullPath
'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute
'/$storeId/settings/markets': typeof SettingsMarketsRoute
'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute
+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute
+ '/$storeId/settings/policies': typeof SettingsPoliciesRoute
'/$storeId/settings/product-types': typeof SettingsProductTypesRoute
'/$storeId/settings/reasons': typeof SettingsReasonsRoute
'/$storeId/settings/roles': typeof SettingsRolesRoute
@@@ -585,7 -585,7 +592,8 @@@ export interface FileRoutesByTo
'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute
'/$storeId/settings/markets': typeof SettingsMarketsRoute
'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute
+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute
+ '/$storeId/settings/policies': typeof SettingsPoliciesRoute
'/$storeId/settings/product-types': typeof SettingsProductTypesRoute
'/$storeId/settings/reasons': typeof SettingsReasonsRoute
'/$storeId/settings/roles': typeof SettingsRolesRoute
@@@ -663,7 -663,7 +671,8 @@@ export interface FileRoutesById
'/_authenticated/$storeId/settings/integrations': typeof SettingsIntegrationsRoute
'/_authenticated/$storeId/settings/markets': typeof SettingsMarketsRoute
'/_authenticated/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute
+ '/_authenticated/$storeId/settings/payouts': typeof SettingsPayoutsRoute
+ '/_authenticated/$storeId/settings/policies': typeof SettingsPoliciesRoute
'/_authenticated/$storeId/settings/product-types': typeof SettingsProductTypesRoute
'/_authenticated/$storeId/settings/reasons': typeof SettingsReasonsRoute
'/_authenticated/$storeId/settings/roles': typeof SettingsRolesRoute
@@@ -741,7 -741,7 +750,8 @@@ export interface FileRouteTypes
| '/$storeId/settings/integrations'
| '/$storeId/settings/markets'
| '/$storeId/settings/payment-methods'
+ | '/$storeId/settings/payouts'
+ | '/$storeId/settings/policies'
| '/$storeId/settings/product-types'
| '/$storeId/settings/reasons'
| '/$storeId/settings/roles'
@@@ -815,7 -815,7 +825,8 @@@
| '/$storeId/settings/integrations'
| '/$storeId/settings/markets'
| '/$storeId/settings/payment-methods'
+ | '/$storeId/settings/payouts'
+ | '/$storeId/settings/policies'
| '/$storeId/settings/product-types'
| '/$storeId/settings/reasons'
| '/$storeId/settings/roles'
@@@ -892,7 -892,7 +903,8 @@@
| '/_authenticated/$storeId/settings/integrations'
| '/_authenticated/$storeId/settings/markets'
| '/_authenticated/$storeId/settings/payment-methods'
+ | '/_authenticated/$storeId/settings/payouts'
+ | '/_authenticated/$storeId/settings/policies'
| '/_authenticated/$storeId/settings/product-types'
| '/_authenticated/$storeId/settings/reasons'
| '/_authenticated/$storeId/settings/roles'
@@@ -1159,13 -1159,13 +1171,20 @@@ declare module '@tanstack/react-router
preLoaderRoute: typeof SettingsProductTypesRouteImport
parentRoute: typeof SettingsRoute
}
+ '/_authenticated/$storeId/settings/policies': {
+ id: '/_authenticated/$storeId/settings/policies'
+ path: '/policies'
+ fullPath: '/$storeId/settings/policies'
+ preLoaderRoute: typeof SettingsPoliciesRouteImport
+ parentRoute: typeof SettingsRoute
+ }
+ '/_authenticated/$storeId/settings/payouts': {
+ id: '/_authenticated/$storeId/settings/payouts'
+ path: '/payouts'
+ fullPath: '/$storeId/settings/payouts'
+ preLoaderRoute: typeof SettingsPayoutsRouteImport
+ parentRoute: typeof SettingsRoute
+ }
'/_authenticated/$storeId/settings/payment-methods': {
id: '/_authenticated/$storeId/settings/payment-methods'
path: '/payment-methods'
@@@ -1480,7 -1480,7 +1499,8 @@@ interface SettingsRouteChildren
SettingsIntegrationsRoute: typeof SettingsIntegrationsRoute
SettingsMarketsRoute: typeof SettingsMarketsRoute
SettingsPaymentMethodsRoute: typeof SettingsPaymentMethodsRoute
+ SettingsPayoutsRoute: typeof SettingsPayoutsRoute
+ SettingsPoliciesRoute: typeof SettingsPoliciesRoute
SettingsProductTypesRoute: typeof SettingsProductTypesRoute
SettingsReasonsRoute: typeof SettingsReasonsRoute
SettingsRolesRoute: typeof SettingsRolesRoute
@@@ -1510,7 -1510,7 +1530,8 @@@ const SettingsRouteChildren: SettingsRo
SettingsIntegrationsRoute: SettingsIntegrationsRoute,
SettingsMarketsRoute: SettingsMarketsRoute,
SettingsPaymentMethodsRoute: SettingsPaymentMethodsRoute,
+ SettingsPayoutsRoute: SettingsPayoutsRoute,
+ SettingsPoliciesRoute: SettingsPoliciesRoute,
SettingsProductTypesRoute: SettingsProductTypesRoute,
SettingsReasonsRoute: SettingsReasonsRoute,
SettingsRolesRoute: SettingsRolesRoute,
diff --cc packages/seller-dashboard/src/pages/onboarding.tsx
index c881c03ddd,188688ecdf..bdac1af442
--- a/packages/seller-dashboard/src/pages/onboarding.tsx
+++ b/packages/seller-dashboard/src/pages/onboarding.tsx
@@@ -463,19 -405,19 +460,21 @@@ function RequirementAction({ requiremen
</div>
)}
+ {/* Which documents are still owed. The generic link below says where to
+ go; without this the seller would arrive not knowing what to write. */}
{/* `accept_terms` renders its own link above, with different words. */}
- {requirement.action_url && requirement.kind !== 'accept_terms' && (
- <div className="flex justify-start">
- <Button variant="outline" asChild>
- <a href={requirement.action_url} target="_blank" rel="noreferrer">
- {t('onboarding.go')}
- <ExternalLinkIcon className="size-4" />
- </a>
- </Button>
- </div>
- )}
+ {requirement.action_url &&
+ requirement.kind !== 'accept_terms' &&
+ requirement.kind !== 'payout_account' && (
+ <div className="flex justify-start">
+ <Button variant="outline" asChild>
+ <a href={requirement.action_url} target="_blank" rel="noreferrer">
+ {t('onboarding.go')}
+ <ExternalLinkIcon className="size-4" />
+ </a>
+ </Button>
+ </div>
+ )}
</>
)
}
diff --cc packages/seller-sdk/src/types/generated/RequirementStatus.ts
index d10419f041,49e00f47a7..7a8b6b7a58
--- a/packages/seller-sdk/src/types/generated/RequirementStatus.ts
+++ b/packages/seller-sdk/src/types/generated/RequirementStatus.ts
@@@ -1,4 -1,4 +1,4 @@@
- // Typelizer digest 10484e01e4987aa4c449c3c379797d7d
-// Typelizer digest b107acf4fbe619356f53cbff2a848699
++// Typelizer digest ce18c945ef023253a793ddca9da7a193
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {RequirementSubmission, RequirementCustomField} from '@/types'
diff --cc spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb
index eb6f1ad0dd,b4ffb73177..569c86550b
--- a/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb
@@@ -14,9 -14,9 +14,10 @@@ module Spre
description: [:string, nullable: true],
required: :boolean, position: :number, status: :string,
blocking: :boolean, action_url: [:string, nullable: true],
- blocker: ['{ state: string; message: string | null } | null']
++ blocker: ['{ state: string; message: string | null } | null'],
+ required_policy_name: [:string, nullable: true]
- attributes :id, :kind, :name, :description, :required, :position, :status, :action_url
+ attributes :id, :kind, :name, :description, :required, :position, :status, :action_url, :blocker
# Whether this stands between the seller and approval. Serialized
# rather than left to each client to derive, so the dashboard's
diff --cc spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb
index aa91830cf1,775acbcb79..db5c96a945
--- a/spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb
@@@ -10,11 -10,11 +10,12 @@@ module Spre
description: [:string, nullable: true],
required: :boolean, position: :number, status: :string,
blocking: :boolean, action_url: [:string, nullable: true],
+ blocker: ['{ state: string; message: string | null } | null'],
accepts_submissions: :boolean, requires_file: :boolean,
- accepted_content_types: [:string, multi: true]
+ accepted_content_types: [:string, multi: true],
+ required_policy_name: [:string, nullable: true]
- attributes :id, :kind, :name, :description, :required, :position, :status, :action_url
+ attributes :id, :kind, :name, :description, :required, :position, :status, :action_url, :blocker
attribute :blocking do |status|
status.blocking?
diff --cc spree/core/app/models/spree/seller.rb
index 0806a30a73,80a34c4307..fcfe055f7a
--- a/spree/core/app/models/spree/seller.rb
+++ b/spree/core/app/models/spree/seller.rb
@@@ -137,12 -134,10 +137,16 @@@ module Spre
has_many :orders, class_name: 'Spree::Order', dependent: nil
has_many :payment_splits, through: :orders, class_name: 'Spree::PaymentSplit', source: :payment_splits
+ # The two levels of the fund ledger: what this seller has earned, and what
+ # has been settled to them. Left alone when the seller goes, for the same
+ # reason as their orders and commission — money that moved is a fact about
+ # the past.
+ has_many :seller_transfers, class_name: 'Spree::SellerTransfer', dependent: nil
+ has_many :seller_payouts, class_name: 'Spree::SellerPayout', dependent: nil
+ # CSV files this seller asked for. Destroyed with the seller: an export is
+ # a copy of records held elsewhere, so nothing is lost by dropping it, and
+ # a file of one seller's orders should not outlive them.
+ has_many :exports, class_name: 'Spree::Export', dependent: :destroy_async, inverse_of: :seller
# What this seller has done about the marketplace's requirements — their
# attestations, the documents they uploaded, what the operator made of
diff --cc spree/core/lib/spree/core/engine.rb
index de3b57b97e,6e2cfe89b7..2e692e468d
--- a/spree/core/lib/spree/core/engine.rb
+++ b/spree/core/lib/spree/core/engine.rb
@@@ -362,8 -347,8 +362,9 @@@ module Spre
Spree::SellerRequirements::BillingAddress,
Spree::SellerRequirements::ReturnsAddress,
Spree::SellerRequirements::MinimumProducts,
+ Spree::SellerRequirements::PayoutAccount,
Spree::SellerRequirements::RequiredCustomFields,
+ Spree::SellerRequirements::Policy,
Spree::SellerRequirements::Attestation,
Spree::SellerRequirements::OperatorReview,
Spree::SellerRequirements::Document