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.

Add `gateway_payment_profile_id` to `StoreCreditCard` type — exposes … (#13602)

Damian Legawiecb4f406d7535b
diff --git a/backend/engines/api/app/serializers/spree/api/v3/credit_card_serializer.rb b/backend/engines/api/app/serializers/spree/api/v3/credit_card_serializer.rb
index 566d92247d..302a23bbdf 100644
--- a/backend/engines/api/app/serializers/spree/api/v3/credit_card_serializer.rb
+++ b/backend/engines/api/app/serializers/spree/api/v3/credit_card_serializer.rb
@@ -3,9 +3,9 @@ module Spree
module V3
class CreditCardSerializer < BaseSerializer
typelize cc_type: :string, last_digits: :string, month: :number, year: :number,
- name: 'string | null', default: :boolean
+ name: 'string | null', default: :boolean, gateway_payment_profile_id: 'string | null'
- attributes :cc_type, :last_digits, :month, :year, :name, :default
+ attributes :cc_type, :last_digits, :month, :year, :name, :default, :gateway_payment_profile_id
end
end
end
diff --git a/backend/engines/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb b/backend/engines/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb
new file mode 100644
index 0000000000..383477e659
--- /dev/null
+++ b/backend/engines/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb
@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::CreditCardSerializer do
+ let(:store) { @default_store }
+ let(:credit_card) do
+ create(:credit_card,
+ cc_type: 'visa',
+ month: 12,
+ year: 1.year.from_now.year,
+ name: 'John Doe',
+ default: true,
+ gateway_payment_profile_id: 'pm_abc123')
+ end
+ let(:base_params) { { store: store, currency: store.default_currency } }
+
+ subject { described_class.new(credit_card, params: base_params).to_h }
+
+ it 'includes all expected attributes' do
+ expect(subject.keys).to match_array(%w[
+ id cc_type last_digits month year name default gateway_payment_profile_id
+ ])
+ end
+
+ it 'returns the prefixed id' do
+ expect(subject['id']).to eq(credit_card.prefixed_id)
+ end
+
+ it 'returns correct attribute values' do
+ expect(subject['cc_type']).to eq('visa')
+ expect(subject['last_digits']).to eq('1111')
+ expect(subject['month']).to eq(12)
+ expect(subject['year']).to eq(1.year.from_now.year)
+ expect(subject['name']).to eq('John Doe')
+ expect(subject['default']).to be true
+ expect(subject['gateway_payment_profile_id']).to eq('pm_abc123')
+ end
+
+ context 'without gateway_payment_profile_id' do
+ let(:credit_card) { create(:credit_card, gateway_payment_profile_id: nil) }
+
+ it 'returns nil for gateway_payment_profile_id' do
+ expect(subject['gateway_payment_profile_id']).to be_nil
+ end
+ end
+
+ context 'without name' do
+ let(:credit_card) do
+ card = build(:credit_card, name: nil)
+ card.save(validate: false)
+ card
+ end
+
+ it 'returns nil for name' do
+ expect(subject['name']).to be_nil
+ end
+ end
+end
diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
index ddf09a435f..a3a35cfa06 100644
--- a/packages/next/CHANGELOG.md
+++ b/packages/next/CHANGELOG.md
@@ -1,5 +1,12 @@
# @spree/next
+## 0.2.3
+
+### Patch Changes
+
+- Update `StoreCreditCard` type with `gateway_payment_profile_id` field (from @spree/sdk 0.2.3)
+- `getCart()` now clears stale cart token when the backend returns 404 (e.g., after order completion), preventing the storefront from showing a completed order in the cart
+
## 0.2.2
### Patch Changes
diff --git a/packages/next/package.json b/packages/next/package.json
index 82b711ac7f..f90f278280 100644
--- a/packages/next/package.json
+++ b/packages/next/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/next",
- "version": "0.2.2",
+ "version": "0.2.3",
"description": "Next.js integration for Spree Commerce — server actions, caching, and cookie-based auth",
"type": "module",
"main": "./dist/index.js",
diff --git a/packages/next/src/actions/cart.ts b/packages/next/src/actions/cart.ts
index 598ad54ae1..ff7d0b3db7 100644
--- a/packages/next/src/actions/cart.ts
+++ b/packages/next/src/actions/cart.ts
@@ -16,6 +16,10 @@ export async function getCart(): Promise<(StoreOrder & { token: string }) | null
try {
return await getClient().store.cart.get({ orderToken, token });
} catch {
+ // Cart not found (e.g., order was completed) — clear stale token
+ if (orderToken) {
+ await clearCartToken();
+ }
return null;
}
}
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
index 36a4be222e..f535fa1f1f 100644
--- a/packages/sdk/CHANGELOG.md
+++ b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,12 @@
# @spree/sdk
+## 0.2.3
+
+### Patch Changes
+
+- Add `gateway_payment_profile_id` to `StoreCreditCard` type — exposes the Stripe PaymentMethod ID (`pm_xxx`) needed for saved card checkout flows
+- `getCart()` now clears stale cart token when the backend returns 404 (e.g., after order completion)
+
## 0.2.2
### Patch Changes
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index 1365f91781..eabe387d75 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/sdk",
- "version": "0.2.2",
+ "version": "0.2.3",
"description": "Official TypeScript SDK for Spree Commerce API",
"type": "module",
"main": "./dist/index.cjs",
diff --git a/packages/sdk/src/types/generated/StoreCreditCard.ts b/packages/sdk/src/types/generated/StoreCreditCard.ts
index 12d9c4853e..3531003498 100644
--- a/packages/sdk/src/types/generated/StoreCreditCard.ts
+++ b/packages/sdk/src/types/generated/StoreCreditCard.ts
@@ -1,4 +1,4 @@
-// Typelizer digest af446e7ffc65a184154c23090150a4a0
+// Typelizer digest 3a6d3c71bc915c7d26cd09b3e759297b
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -10,6 +10,7 @@ type StoreCreditCard = {
year: number;
name: string | null;
default: boolean;
+ gateway_payment_profile_id: string | null;
}
export default StoreCreditCard;