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.

Render a provider's settings form in the dashboard

Damian Legawiecf151d8debfeb
diff --git a/packages/admin-sdk/src/params.ts b/packages/admin-sdk/src/params.ts
index 54243b636d..7abd59380b 100644
--- a/packages/admin-sdk/src/params.ts
+++ b/packages/admin-sdk/src/params.ts
@@ -668,6 +668,15 @@ export interface ProductMediaInput {
variant_ids?: Array<string>
}
+/** One per-asset configuration field a provider declares. */
+export interface DigitalAssetProviderSettingField {
+ key: string
+ type: 'string' | 'number' | 'boolean' | 'select'
+ default?: unknown
+ /** Allowed values for a `select` field. */
+ in?: string[]
+}
+
/** A selectable digital-asset source, from the `providers` discovery endpoint. */
export interface DigitalAssetProvider {
/** Class name to send as `provider_type`. */
@@ -676,6 +685,8 @@ export interface DigitalAssetProvider {
name: string
/** Whether picking this source requires uploading a file. */
requires_attachment: boolean
+ /** Per-asset fields to render as a form when this source is picked. */
+ settings_schema: DigitalAssetProviderSettingField[]
}
export interface DigitalAssetCreateParams {
@@ -684,6 +695,8 @@ export interface DigitalAssetCreateParams {
signed_id?: string
/** Provider class name. Omit for an uploaded file (the default source). */
provider_type?: string
+ /** Values for the provider's `settings_schema`, keyed by field name. */
+ provider_settings?: Record<string, unknown>
/** Defaults to the product's default variant when omitted. */
variant_id?: string
/** Null (or omitted) means the store's download settings apply. */
@@ -695,6 +708,7 @@ export interface DigitalAssetUpdateParams {
/** Replaces the file for everyone who already bought it. */
signed_id?: string
provider_type?: string
+ provider_settings?: Record<string, unknown>
variant_id?: string
authorized_clicks?: number | null
authorized_days?: number | null
diff --git a/packages/dashboard/src/components/spree/products/digital-asset-edit-sheet.tsx b/packages/dashboard/src/components/spree/products/digital-asset-edit-sheet.tsx
index 078469bf81..0a127fedbe 100644
--- a/packages/dashboard/src/components/spree/products/digital-asset-edit-sheet.tsx
+++ b/packages/dashboard/src/components/spree/products/digital-asset-edit-sheet.tsx
@@ -1,4 +1,4 @@
-import type { DigitalAsset, Variant } from '@spree/admin-sdk'
+import type { DigitalAsset, DigitalAssetProviderSettingField, Variant } from '@spree/admin-sdk'
import {
Button,
Field,
@@ -18,11 +18,14 @@ import {
import { useEffect, useState } from 'react'
import { useTranslation } from 'react-i18next'
import { useUpdateDigitalAsset } from '../../../hooks/use-digital-assets'
+import { ProviderSettingsFields } from './provider-settings-fields'
interface Props {
productId: string
asset: DigitalAsset | null
variants?: Variant[]
+ /** Fields for a provider-backed asset; empty for an uploaded file. */
+ settingsSchema?: DigitalAssetProviderSettingField[]
open: boolean
onOpenChange: (open: boolean) => void
}
@@ -38,13 +41,21 @@ function parseLimit(raw: string): number | null | undefined {
return Number.isInteger(parsed) && parsed >= 1 ? parsed : undefined
}
-export function DigitalAssetEditSheet({ productId, asset, variants, open, onOpenChange }: Props) {
+export function DigitalAssetEditSheet({
+ productId,
+ asset,
+ variants,
+ settingsSchema = [],
+ open,
+ onOpenChange,
+}: Props) {
const { t } = useTranslation()
const updateAsset = useUpdateDigitalAsset(productId)
const [clicks, setClicks] = useState('')
const [days, setDays] = useState('')
const [variantId, setVariantId] = useState('')
+ const [settings, setSettings] = useState<Record<string, unknown>>({})
const [error, setError] = useState<string | null>(null)
// Re-seed whenever a different file is opened, so the sheet never shows the
@@ -54,6 +65,7 @@ export function DigitalAssetEditSheet({ productId, asset, variants, open, onOpen
setClicks(toInput(asset.authorized_clicks))
setDays(toInput(asset.authorized_days))
setVariantId(asset.variant_id ?? '')
+ setSettings(asset.provider_settings ?? {})
setError(null)
}, [asset])
@@ -75,6 +87,7 @@ export function DigitalAssetEditSheet({ productId, asset, variants, open, onOpen
authorized_clicks: parsedClicks,
authorized_days: parsedDays,
...(hasVariants && variantId ? { variant_id: variantId } : {}),
+ ...(settingsSchema.length > 0 ? { provider_settings: settings } : {}),
})
onOpenChange(false)
}
@@ -83,10 +96,18 @@ export function DigitalAssetEditSheet({ productId, asset, variants, open, onOpen
<Sheet open={open} onOpenChange={onOpenChange}>
<SheetContent side="right" className="flex flex-col">
<SheetHeader>
- <SheetTitle>{asset.filename ?? t('admin.digital_assets.untitled')}</SheetTitle>
+ <SheetTitle>
+ {asset.filename ?? asset.provider_name ?? t('admin.digital_assets.untitled')}
+ </SheetTitle>
</SheetHeader>
<div className="flex flex-1 flex-col gap-6 overflow-y-auto p-4">
+ <ProviderSettingsFields
+ schema={settingsSchema}
+ values={settings}
+ onChange={setSettings}
+ />
+
{hasVariants && (
<Field>
<FieldLabel htmlFor="digital-asset-variant">
diff --git a/packages/dashboard/src/components/spree/products/digital-asset-provider-sheet.tsx b/packages/dashboard/src/components/spree/products/digital-asset-provider-sheet.tsx
new file mode 100644
index 0000000000..96dceb6a30
--- /dev/null
+++ b/packages/dashboard/src/components/spree/products/digital-asset-provider-sheet.tsx
@@ -0,0 +1,75 @@
+import type { DigitalAssetProvider } from '@spree/admin-sdk'
+import {
+ Button,
+ Sheet,
+ SheetContent,
+ SheetFooter,
+ SheetHeader,
+ SheetTitle,
+} from '@spree/dashboard-ui'
+import { useEffect, useState } from 'react'
+import { useTranslation } from 'react-i18next'
+import { useCreateDigitalAsset } from '../../../hooks/use-digital-assets'
+import { defaultProviderSettings, ProviderSettingsFields } from './provider-settings-fields'
+
+interface Props {
+ productId: string
+ /** The picked source, or null when the sheet is closed. */
+ provider: DigitalAssetProvider | null
+ onOpenChange: (open: boolean) => void
+ onCreated: () => void
+}
+
+/**
+ * Captures a provider-backed asset's settings before creating it. Only opened
+ * for a provider that declares fields; a settings-free provider creates in one
+ * click from the source menu without this sheet.
+ */
+export function DigitalAssetProviderSheet({ productId, provider, onOpenChange, onCreated }: Props) {
+ const { t } = useTranslation()
+ const createAsset = useCreateDigitalAsset(productId)
+ const [values, setValues] = useState<Record<string, unknown>>({})
+
+ // Re-seed with the provider's defaults each time a source is picked.
+ useEffect(() => {
+ if (provider) setValues(defaultProviderSettings(provider.settings_schema))
+ }, [provider])
+
+ if (!provider) return null
+
+ async function handleCreate() {
+ await createAsset.mutateAsync({
+ provider_type: provider!.type,
+ provider_settings: values,
+ })
+ onCreated()
+ onOpenChange(false)
+ }
+
+ return (
+ <Sheet open={Boolean(provider)} onOpenChange={onOpenChange}>
+ <SheetContent side="right" className="flex flex-col">
+ <SheetHeader>
+ <SheetTitle>{provider.name}</SheetTitle>
+ </SheetHeader>
+
+ <div className="flex flex-1 flex-col gap-6 overflow-y-auto p-4">
+ <ProviderSettingsFields
+ schema={provider.settings_schema}
+ values={values}
+ onChange={setValues}
+ />
+ </div>
+
+ <SheetFooter>
+ <Button type="button" variant="outline" onClick={() => onOpenChange(false)}>
+ {t('admin.actions.cancel')}
+ </Button>
+ <Button type="button" onClick={handleCreate} disabled={createAsset.isPending}>
+ {createAsset.isPending ? t('admin.actions.saving') : t('admin.actions.add')}
+ </Button>
+ </SheetFooter>
+ </SheetContent>
+ </Sheet>
+ )
+}
diff --git a/packages/dashboard/src/components/spree/products/digital-assets-card.tsx b/packages/dashboard/src/components/spree/products/digital-assets-card.tsx
index 9f9a7128fb..e9315d1a5e 100644
--- a/packages/dashboard/src/components/spree/products/digital-assets-card.tsx
+++ b/packages/dashboard/src/components/spree/products/digital-assets-card.tsx
@@ -1,4 +1,4 @@
-import type { DigitalAsset, Variant } from '@spree/admin-sdk'
+import type { DigitalAsset, DigitalAssetProvider, Variant } from '@spree/admin-sdk'
import { formatFileSize, useDirectUpload } from '@spree/dashboard-core'
import {
Button,
@@ -33,6 +33,7 @@ import {
useDigitalAssets,
} from '../../../hooks/use-digital-assets'
import { DigitalAssetEditSheet } from './digital-asset-edit-sheet'
+import { DigitalAssetProviderSheet } from './digital-asset-provider-sheet'
export function DigitalAssetsCard({
productId,
@@ -47,6 +48,8 @@ export function DigitalAssetsCard({
const [uploading, setUploading] = useState(false)
const [page, setPage] = useState(1)
const [editing, setEditing] = useState<DigitalAsset | null>(null)
+ // The provider whose settings sheet is open, before its asset is created.
+ const [configuring, setConfiguring] = useState<DigitalAssetProvider | null>(null)
// Digital files live on private storage: they are only ever served through an
// authorized, signed link, never from the public bucket.
@@ -92,8 +95,14 @@ export function DigitalAssetsCard({
if (event.dataTransfer.files.length > 0) void handleFiles(event.dataTransfer.files)
}
- async function handleAddProvider(providerType: string) {
- await createAsset.mutateAsync({ provider_type: providerType })
+ // A provider with settings opens a sheet to collect them; one without
+ // creates its asset immediately, exactly like the file default.
+ async function handleAddProvider(provider: DigitalAssetProvider) {
+ if (provider.settings_schema.length > 0) {
+ setConfiguring(provider)
+ return
+ }
+ await createAsset.mutateAsync({ provider_type: provider.type })
setPage(1)
}
@@ -156,7 +165,7 @@ export function DigitalAssetsCard({
{sourceProviders.map((provider) => (
<DropdownMenuItem
key={provider.type}
- onClick={() => handleAddProvider(provider.type)}
+ onClick={() => handleAddProvider(provider)}
>
{provider.name}
</DropdownMenuItem>
@@ -282,9 +291,19 @@ export function DigitalAssetsCard({
productId={productId}
asset={editing}
variants={variants}
+ settingsSchema={
+ providers.find((p) => p.type === editing?.provider_type)?.settings_schema ?? []
+ }
open={Boolean(editing)}
onOpenChange={(open) => !open && setEditing(null)}
/>
+
+ <DigitalAssetProviderSheet
+ productId={productId}
+ provider={configuring}
+ onOpenChange={(open) => !open && setConfiguring(null)}
+ onCreated={() => setPage(1)}
+ />
</Card>
)
}
diff --git a/packages/dashboard/src/components/spree/products/provider-settings-fields.tsx b/packages/dashboard/src/components/spree/products/provider-settings-fields.tsx
new file mode 100644
index 0000000000..5e01685332
--- /dev/null
+++ b/packages/dashboard/src/components/spree/products/provider-settings-fields.tsx
@@ -0,0 +1,102 @@
+import type { DigitalAssetProviderSettingField } from '@spree/admin-sdk'
+import {
+ Field,
+ FieldLabel,
+ Input,
+ Select,
+ SelectContent,
+ SelectItem,
+ SelectTrigger,
+ SelectValue,
+ Switch,
+} from '@spree/dashboard-ui'
+
+interface Props {
+ schema: DigitalAssetProviderSettingField[]
+ values: Record<string, unknown>
+ onChange: (values: Record<string, unknown>) => void
+}
+
+/**
+ * Renders one input per provider-declared setting. The provider owns the field
+ * list (its `settings_schema`), so this stays generic: a provider ships no
+ * dashboard code, it just names its fields and types. Labels come straight from
+ * the field key — a provider names a setting for the merchant, not for i18n.
+ */
+export function ProviderSettingsFields({ schema, values, onChange }: Props) {
+ if (schema.length === 0) return null
+
+ function set(key: string, value: unknown) {
+ onChange({ ...values, [key]: value })
+ }
+
+ return (
+ <>
+ {schema.map((field) => {
+ const value = values[field.key]
+ const id = `provider-setting-${field.key}`
+
+ if (field.type === 'boolean') {
+ return (
+ <Field key={field.key} className="flex-row items-center justify-between">
+ <FieldLabel htmlFor={id}>{field.key}</FieldLabel>
+ <Switch
+ id={id}
+ checked={Boolean(value)}
+ onCheckedChange={(checked) => set(field.key, checked)}
+ />
+ </Field>
+ )
+ }
+
+ if (field.type === 'select') {
+ return (
+ <Field key={field.key}>
+ <FieldLabel htmlFor={id}>{field.key}</FieldLabel>
+ <Select
+ value={value == null ? '' : String(value)}
+ onValueChange={(v) => set(field.key, v)}
+ >
+ <SelectTrigger id={id}>
+ <SelectValue />
+ </SelectTrigger>
+ <SelectContent>
+ {(field.in ?? []).map((option) => (
+ <SelectItem key={option} value={option}>
+ {option}
+ </SelectItem>
+ ))}
+ </SelectContent>
+ </Select>
+ </Field>
+ )
+ }
+
+ return (
+ <Field key={field.key}>
+ <FieldLabel htmlFor={id}>{field.key}</FieldLabel>
+ <Input
+ id={id}
+ type={field.type === 'number' ? 'number' : 'text'}
+ value={value == null ? '' : String(value)}
+ onChange={(e) =>
+ set(field.key, field.type === 'number' ? e.target.valueAsNumber : e.target.value)
+ }
+ />
+ </Field>
+ )
+ })}
+ </>
+ )
+}
+
+/** Seed field values from a provider's schema defaults (create flow). */
+export function defaultProviderSettings(
+ schema: DigitalAssetProviderSettingField[],
+): Record<string, unknown> {
+ const values: Record<string, unknown> = {}
+ for (const field of schema) {
+ if (field.default !== undefined) values[field.key] = field.default
+ }
+ return values
+}