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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
import type { CountryCode } from '@spree/core'
import type { PanelAccountParams } from '../api-client'
/**
* Treat a blank or whitespace-only string as "not set" — common when mapping
* form values to API params, where a blank `<input>` should become `undefined`
* (omit the field) or `null` (clear the server value) rather than passing the
* empty string through. Returns the trimmed value when present.
*/
export function blankToUndefined(s: string | null | undefined): string | undefined {
const trimmed = s?.trim()
return trimmed ? trimmed : undefined
}
export function blankToNull(s: string | null | undefined): string | null {
const trimmed = s?.trim()
return trimmed ? trimmed : null
}
/**
* Preprocessor for Zod optional-number fields backed by `<input type="number">`.
* Empty inputs return `''`, which `z.coerce.number()` would coerce to `0` —
* tripping `.positive()` / `.min()` on otherwise-optional fields. Map empty
* to `undefined` so the optional branch wins.
*
* ```ts
* usage_limit: z.preprocess(emptyToUndefined, z.coerce.number().int().positive().optional())
* ```
*/
export function emptyToUndefined(value: unknown): unknown {
if (value === '' || value === null) return undefined
return value
}
/**
* The address columns a stock location carries, in either panel's SDK shape.
* Structural rather than either `StockLocation` type so both the admin and
* seller panels can map their own rows through the helpers below.
*/
export interface StockLocationAddressFields {
company?: string | null
address1?: string | null
address2?: string | null
city?: string | null
zipcode?: string | null
state_code?: string | null
state_text?: string | null
country_code?: string | null
country_name?: string | null
phone?: string | null
}
/**
* The three shapes a stock location's address sits between. A location stores
* `zipcode` where an address says `postal_code`, and carries no personal name
* — mapping the fields explicitly keeps that difference in one place instead
* of leaking a cast into every call.
*/
export function stockLocationToAddressBlock(location: StockLocationAddressFields) {
return {
company: location.company,
address1: location.address1,
address2: location.address2,
city: location.city,
state_text: location.state_text,
postal_code: location.zipcode,
country_code: location.country_code,
country_name: location.country_name,
phone: location.phone,
}
}
export function stockLocationToEditableAddress(
location: StockLocationAddressFields & { id: string },
) {
return {
id: location.id,
company: location.company,
address1: location.address1,
address2: location.address2,
city: location.city,
postal_code: location.zipcode,
country_code: location.country_code,
state_code: location.state_code,
phone: location.phone,
}
}
export function editableAddressToStockLocationParams(values: {
company?: string | null
address1?: string | null
address2?: string | null
city?: string | null
postal_code?: string | null
country_code?: CountryCode | null
state_code?: string | null
phone?: string | null
}) {
return {
company: values.company,
address1: values.address1,
address2: values.address2,
city: values.city,
zipcode: values.postal_code,
country_code: values.country_code,
state_code: values.state_code,
phone: values.phone,
}
}
/**
* The signed-in person's own account, mapped from either panel's edit form to
* the params its API accepts.
*
* Shared because the three rules here are the same on both panels and each is
* easy to get subtly wrong:
*
* - A name is sent as typed, empty string included. Blank is how a person
* removes a name they once gave — the model normalizes it away — so
* coercing blank to `undefined` would drop the field and leave the old name
* in place while the form reported success.
* - A blank language is omitted instead: it means none was chosen, never
* "clear the one I have".
* - The photo is a three-state field — a fresh upload sends its signed id, an
* explicit clear sends `null` to purge the attachment, and an untouched
* field is left out entirely.
*/
export function accountFormToParams(values: {
first_name?: string | null
last_name?: string | null
selected_locale?: string | null
avatar_signed_id: string | null
avatar_cleared: boolean
}): PanelAccountParams {
return {
first_name: values.first_name ?? undefined,
last_name: values.last_name ?? undefined,
selected_locale: blankToUndefined(values.selected_locale),
...signedIdParam('avatar', values.avatar_signed_id, values.avatar_cleared),
}
}
/**
* The write for one attachment slot, under the API's `<slot>_signed_id` name:
* a fresh upload sends its signed id, an explicit clear sends `null` to remove
* the file, and an untouched field is left out entirely.
*/
export function signedIdParam<Slot extends string>(
slot: Slot,
signedId: string | null | undefined,
): Partial<Record<`${Slot}_signed_id`, string>>
export function signedIdParam<Slot extends string>(
slot: Slot,
signedId: string | null | undefined,
cleared: boolean | undefined,
): Partial<Record<`${Slot}_signed_id`, string | null>>
export function signedIdParam<Slot extends string>(
slot: Slot,
signedId: string | null | undefined,
cleared?: boolean,
): Partial<Record<`${Slot}_signed_id`, string | null>> {
const key = `${slot}_signed_id` as `${Slot}_signed_id`
if (signedId) return { [key]: signedId } as Record<`${Slot}_signed_id`, string>
if (cleared) return { [key]: null } as Record<`${Slot}_signed_id`, null>
return {}
}