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.

Standarize exposing `metadata` in Admin API/SDK

Damian Legawiecc34905ae4b9e
diff --git a/packages/admin-sdk/src/types/generated/Address.ts b/packages/admin-sdk/src/types/generated/Address.ts
index f2fdb5869f..0732f818da 100644
--- a/packages/admin-sdk/src/types/generated/Address.ts
+++ b/packages/admin-sdk/src/types/generated/Address.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 71431f96db940ccb09276f6ff6a5012a
+// Typelizer digest 2990a1af0c5eda55c99dbc353082f093
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -22,10 +22,10 @@ interface Address {
is_default_shipping: boolean;
state_name: string | null;
label: string | null;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
customer_id: string | null;
- metadata: Record<string, unknown> | null;
}
export default Address;
diff --git a/packages/admin-sdk/src/types/generated/Asset.ts b/packages/admin-sdk/src/types/generated/Asset.ts
deleted file mode 100644
index 52635e89c7..0000000000
--- a/packages/admin-sdk/src/types/generated/Asset.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest a023551d7c3344c9a60e7464f82839fa
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Asset {
- id: string;
- viewable_id: string;
- type: string | null;
- viewable_type: string;
- position: number | null;
- alt: string | null;
- created_at: string;
- updated_at: string;
-}
-
-export default Asset;
diff --git a/packages/admin-sdk/src/types/generated/Category.ts b/packages/admin-sdk/src/types/generated/Category.ts
index b36d8960d0..c900812204 100644
--- a/packages/admin-sdk/src/types/generated/Category.ts
+++ b/packages/admin-sdk/src/types/generated/Category.ts
@@ -1,4 +1,4 @@
-// Typelizer digest a24d2bc437662d7db7897765546e6d92
+// Typelizer digest 2a68628bc9ccd18fda78c94ec72a0039
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CustomField} from '@/types'
@@ -25,6 +25,7 @@ interface Category {
children?: Array<Category>;
ancestors?: Array<Category>;
custom_fields?: Array<CustomField>;
+ metadata: Record<string, unknown>;
pretty_name: string;
lft: number;
rgt: number;
diff --git a/packages/admin-sdk/src/types/generated/CreditCard.ts b/packages/admin-sdk/src/types/generated/CreditCard.ts
index 1aaab61683..fd91a02e01 100644
--- a/packages/admin-sdk/src/types/generated/CreditCard.ts
+++ b/packages/admin-sdk/src/types/generated/CreditCard.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 7af041661f6e70eb051d603e80c7a838
+// Typelizer digest 6fc95c0bf97377426f872f38616d0019
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -13,6 +13,7 @@ interface CreditCard {
gateway_payment_profile_id: string | null;
customer_id: string | null;
payment_method_id: string | null;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
}
diff --git a/packages/admin-sdk/src/types/generated/Customer.ts b/packages/admin-sdk/src/types/generated/Customer.ts
index cb58431d06..e1aee66394 100644
--- a/packages/admin-sdk/src/types/generated/Customer.ts
+++ b/packages/admin-sdk/src/types/generated/Customer.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 364c7ca82f639cea2fcf7042221c78cb
+// Typelizer digest 2a77c7f4b9fa96a9a727312b874fcc5f
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Address, Order, StoreCredit} from '@/types'
@@ -17,6 +17,7 @@ interface Customer {
default_billing_address?: Address | null;
default_shipping_address?: Address | null;
login: string | null;
+ metadata: Record<string, unknown>;
last_sign_in_at: string | null;
current_sign_in_at: string | null;
created_at: string;
@@ -27,7 +28,6 @@ interface Customer {
current_sign_in_ip: string | null;
tags: Array<string>;
internal_note_html: string | null;
- metadata: Record<string, unknown> | null;
default_billing_address_id: string | null;
default_shipping_address_id: string | null;
orders_count: number;
diff --git a/packages/admin-sdk/src/types/generated/Fulfillment.ts b/packages/admin-sdk/src/types/generated/Fulfillment.ts
index 7147e218b1..3a4b532c86 100644
--- a/packages/admin-sdk/src/types/generated/Fulfillment.ts
+++ b/packages/admin-sdk/src/types/generated/Fulfillment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest ac09b2c7e252da1a0f95026db19377ab
+// Typelizer digest f0238fdf3627e79f0daeda84320bf6e5
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {DeliveryMethod, StockLocation, DeliveryRate, Order, Adjustment} from '@/types'
@@ -27,11 +27,11 @@ interface Fulfillment {
delivery_method?: DeliveryMethod;
stock_location?: StockLocation;
delivery_rates?: Array<DeliveryRate>;
+ metadata: Record<string, unknown>;
adjustment_total: string;
pre_tax_amount: string;
created_at: string;
updated_at: string;
- metadata: Record<string, unknown> | null;
order_id: string | null;
stock_location_id: string | null;
order?: Order;
diff --git a/packages/admin-sdk/src/types/generated/LineItem.ts b/packages/admin-sdk/src/types/generated/LineItem.ts
index 05d399a0bb..b8649b5514 100644
--- a/packages/admin-sdk/src/types/generated/LineItem.ts
+++ b/packages/admin-sdk/src/types/generated/LineItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 6e76e5b742f88ca476af53f830dd13a5
+// Typelizer digest 5c0fdc4c5206fbfac144e7ed4197f811
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue, DigitalLink, Variant, TaxCategory, Adjustment} from '@/types'
@@ -32,9 +32,9 @@ interface LineItem {
thumbnail_url: string | null;
option_values: Array<OptionValue>;
digital_links: Array<DigitalLink>;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
- metadata: Record<string, unknown> | null;
cost_price: string | null;
tax_category_id: string | null;
variant?: Variant;
diff --git a/packages/admin-sdk/src/types/generated/Media.ts b/packages/admin-sdk/src/types/generated/Media.ts
index 46719f61ec..6c5f7b2f0d 100644
--- a/packages/admin-sdk/src/types/generated/Media.ts
+++ b/packages/admin-sdk/src/types/generated/Media.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 37586f8a2f663d57141a69ea6db4b03c
+// Typelizer digest e53e1b7e1e95ba9a2734772080dbfb1b
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -22,6 +22,7 @@ interface Media {
created_at: string;
updated_at: string;
viewable_id: string;
+ metadata: Record<string, unknown>;
viewable_type: string;
}
diff --git a/packages/admin-sdk/src/types/generated/OptionType.ts b/packages/admin-sdk/src/types/generated/OptionType.ts
index be57c72bc9..38164807e4 100644
--- a/packages/admin-sdk/src/types/generated/OptionType.ts
+++ b/packages/admin-sdk/src/types/generated/OptionType.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 48a3b3751e01501ddfb330ed86b365e4
+// Typelizer digest aafd25e420f86988b84c09e7c92a5b80
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue} from '@/types'
@@ -9,6 +9,7 @@ interface OptionType {
label: string;
position: number;
kind: string;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
option_values: Array<OptionValue>;
diff --git a/packages/admin-sdk/src/types/generated/OptionValue.ts b/packages/admin-sdk/src/types/generated/OptionValue.ts
index 29f6b8ccb1..e76e8aae95 100644
--- a/packages/admin-sdk/src/types/generated/OptionValue.ts
+++ b/packages/admin-sdk/src/types/generated/OptionValue.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 99e45880315db7b7b4e5862ba39ad816
+// Typelizer digest 7be6a768dcba264bd230c26f157842ef
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionType} from '@/types'
@@ -13,6 +13,7 @@ interface OptionValue {
option_type_name: string;
option_type_label: string;
image_url: string | null;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
option_type?: OptionType;
diff --git a/packages/admin-sdk/src/types/generated/Order.ts b/packages/admin-sdk/src/types/generated/Order.ts
index 2f1fa2a5e1..ea2a817692 100644
--- a/packages/admin-sdk/src/types/generated/Order.ts
+++ b/packages/admin-sdk/src/types/generated/Order.ts
@@ -1,4 +1,4 @@
-// Typelizer digest cd79116d7a5ace207b4bf85fcfe4c2b5
+// Typelizer digest 281d9728ced03c79717405ad8d44aeb7
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Discount, LineItem, Fulfillment, Payment, Address, GiftCard, Market, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
@@ -53,13 +53,13 @@ interface Order {
store_owner_notification_delivered: boolean;
payment_total: string;
display_payment_total: string;
+ metadata: Record<string, unknown>;
canceled_at: string | null;
approved_at: string | null;
created_at: string;
updated_at: string;
tags: Array<string>;
internal_note: string | null;
- metadata: Record<string, unknown> | null;
approver_id: string | null;
canceler_id: string | null;
created_by_id: string | null;
diff --git a/packages/admin-sdk/src/types/generated/Payment.ts b/packages/admin-sdk/src/types/generated/Payment.ts
index 43f7c00d51..e7194901a4 100644
--- a/packages/admin-sdk/src/types/generated/Payment.ts
+++ b/packages/admin-sdk/src/types/generated/Payment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 9e58f5d94600ca1f0cffa3176b7b74d8
+// Typelizer digest 49166d15c603f4e8838e8e00d5ec2d17
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod, Order, Refund} from '@/types'
@@ -15,12 +15,12 @@ interface Payment {
source_id: string | null;
source: CreditCard | StoreCredit | PaymentSource | null;
payment_method?: PaymentMethod;
+ metadata: Record<string, unknown>;
avs_response: string | null;
cvv_response_code: string | null;
cvv_response_message: string | null;
created_at: string;
updated_at: string;
- metadata: Record<string, unknown> | null;
captured_amount: string;
order_id: string | null;
order?: Order;
diff --git a/packages/admin-sdk/src/types/generated/PaymentMethod.ts b/packages/admin-sdk/src/types/generated/PaymentMethod.ts
index 4fdbf13df9..3337f81a56 100644
--- a/packages/admin-sdk/src/types/generated/PaymentMethod.ts
+++ b/packages/admin-sdk/src/types/generated/PaymentMethod.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 1639362fb6ae1abe86a8de8682417eb0
+// Typelizer digest 54dbf7d0a58f85679adeb642593391a6
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -9,6 +9,7 @@ interface PaymentMethod {
type: string;
session_required: boolean;
source_required: boolean;
+ metadata: Record<string, unknown>;
active: boolean;
auto_capture: boolean | null;
created_at: string;
diff --git a/packages/admin-sdk/src/types/generated/PaymentSource.ts b/packages/admin-sdk/src/types/generated/PaymentSource.ts
index 8d3f89da1f..278a853bfb 100644
--- a/packages/admin-sdk/src/types/generated/PaymentSource.ts
+++ b/packages/admin-sdk/src/types/generated/PaymentSource.ts
@@ -1,10 +1,11 @@
-// Typelizer digest 5546618ce87498596dfb5c82d7524b93
+// Typelizer digest 3ec14d169c0151499f601376ca6932f0
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface PaymentSource {
id: string;
gateway_payment_profile_id: string | null;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
}
diff --git a/packages/admin-sdk/src/types/generated/Product.ts b/packages/admin-sdk/src/types/generated/Product.ts
index f57aa2b1c5..16257e6531 100644
--- a/packages/admin-sdk/src/types/generated/Product.ts
+++ b/packages/admin-sdk/src/types/generated/Product.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 2924cca23864ab744b207ce314f34f14
+// Typelizer digest b3467d88e70b8b6f05594cb7f7fed322
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Price, PriceHistory, Media, Variant, OptionType, Category, CustomField} from '@/types'
@@ -33,6 +33,7 @@ interface Product {
status: string;
make_active_at: string | null;
discontinue_on: string | null;
+ metadata: Record<string, unknown>;
deleted_at: string | null;
created_at: string;
updated_at: string;
diff --git a/packages/admin-sdk/src/types/generated/Refund.ts b/packages/admin-sdk/src/types/generated/Refund.ts
index f5335395d0..d96faa2971 100644
--- a/packages/admin-sdk/src/types/generated/Refund.ts
+++ b/packages/admin-sdk/src/types/generated/Refund.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 9d5957d1cb8255a6a241c54a69b16331
+// Typelizer digest 84cd1e71b4e7e9483ab8d9bb26209317
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Payment, Reimbursement} from '@/types'
@@ -10,6 +10,7 @@ interface Refund {
payment_id: string | null;
refund_reason_id: string | null;
reimbursement_id: string | null;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
payment?: Payment;
diff --git a/packages/admin-sdk/src/types/generated/StockItem.ts b/packages/admin-sdk/src/types/generated/StockItem.ts
index cd800c304e..2c185094a1 100644
--- a/packages/admin-sdk/src/types/generated/StockItem.ts
+++ b/packages/admin-sdk/src/types/generated/StockItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 1bf13e390e69a23008e120ed93074c6b
+// Typelizer digest 53765d02650cb44b65558ad8ba2da6ab
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {StockLocation, Variant} from '@/types'
@@ -9,6 +9,7 @@ interface StockItem {
backorderable: boolean;
stock_location_id: string | null;
variant_id: string | null;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
stock_location?: StockLocation;
diff --git a/packages/admin-sdk/src/types/generated/Store.ts b/packages/admin-sdk/src/types/generated/Store.ts
index 6c29b6c66d..74ae9c85a9 100644
--- a/packages/admin-sdk/src/types/generated/Store.ts
+++ b/packages/admin-sdk/src/types/generated/Store.ts
@@ -1,9 +1,10 @@
-// Typelizer digest cd7defafc23e2cb5169a499bc4a3aa6a
+// Typelizer digest 0658f530ce9dcfb753fa0400270e03ac
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface Store {
id: string;
+ metadata: Record<string, unknown>;
name: string;
url: string;
code: string;
diff --git a/packages/admin-sdk/src/types/generated/StoreCredit.ts b/packages/admin-sdk/src/types/generated/StoreCredit.ts
index 718f0647d3..86d20263b0 100644
--- a/packages/admin-sdk/src/types/generated/StoreCredit.ts
+++ b/packages/admin-sdk/src/types/generated/StoreCredit.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 703c5e72241f2b5e7be5ccc793735f3a
+// Typelizer digest eab538fe144c9c626a5de9e6e2c22710
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -11,11 +11,11 @@ interface StoreCredit {
display_amount_used: string;
display_amount_remaining: string;
currency: string;
+ metadata: Record<string, unknown>;
created_at: string;
updated_at: string;
customer_id: string | null;
created_by_id: string | null;
- metadata: Record<string, unknown> | null;
}
export default StoreCredit;
diff --git a/packages/admin-sdk/src/types/generated/Variant.ts b/packages/admin-sdk/src/types/generated/Variant.ts
index 79d3525e24..2feae447c7 100644
--- a/packages/admin-sdk/src/types/generated/Variant.ts
+++ b/packages/admin-sdk/src/types/generated/Variant.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 63a3c10ff6fb4f3bcde508c7ce86f6d4
+// Typelizer digest 050e17e8f5983d79e65407dd4a655f96
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Price, PriceHistory, Media, OptionValue, CustomField} from '@/types'
@@ -25,6 +25,7 @@ interface Variant {
option_values: Array<OptionValue>;
custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
+ metadata: Record<string, unknown>;
position: number;
total_on_hand: number | null;
tax_category_id: string | null;
diff --git a/packages/admin-sdk/src/types/generated/index.ts b/packages/admin-sdk/src/types/generated/index.ts
index f056db6e1e..9298923ba8 100644
--- a/packages/admin-sdk/src/types/generated/index.ts
+++ b/packages/admin-sdk/src/types/generated/index.ts
@@ -1,11 +1,10 @@
-// Typelizer digest f21ed7aed461a77dbdf7485b9b652c5e
+// Typelizer digest d10fc03e8f757b74e4cf20fa26a753f4
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
export type { default as Adjustment } from './Adjustment'
export type { default as AdminUser } from './AdminUser'
export type { default as AllowedOrigin } from './AllowedOrigin'
-export type { default as Asset } from './Asset'
export type { default as Category } from './Category'
export type { default as Country } from './Country'
export type { default as CreditCard } from './CreditCard'
diff --git a/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
index 13bb166fc2..279d692f01 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
@@ -5,18 +5,14 @@ module Spree
class AddressSerializer < V3::AddressSerializer
typelize label: [:string, nullable: true],
customer_id: [:string, nullable: true],
- metadata: 'Record<string, unknown> | null'
+ metadata: 'Record<string, unknown>'
- attributes :label,
+ attributes :label, :metadata,
created_at: :iso8601, updated_at: :iso8601
attribute :customer_id do |address|
address.user&.prefixed_id
end
-
- attribute :metadata do |address|
- address.metadata.presence
- end
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/asset_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/asset_serializer.rb
deleted file mode 100644
index f13a930f9f..0000000000
--- a/spree/api/app/serializers/spree/api/v3/admin/asset_serializer.rb
+++ /dev/null
@@ -1,10 +0,0 @@
-module Spree
- module Api
- module V3
- module Admin
- class AssetSerializer < V3::AssetSerializer
- end
- end
- end
- end
-end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
index dae809eaf1..40bd61fe87 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
@@ -5,10 +5,11 @@ module Spree
# Admin API Category Serializer
# Full category data including admin-only fields
class CategorySerializer < V3::CategorySerializer
- typelize pretty_name: :string, lft: :number, rgt: :number, sort_order: :string
+ typelize pretty_name: :string, lft: :number, rgt: :number, sort_order: :string,
+ metadata: 'Record<string, unknown>'
# Admin-only attributes
- attributes :pretty_name, :lft, :rgt, created_at: :iso8601, updated_at: :iso8601
+ attributes :metadata, :pretty_name, :lft, :rgt, created_at: :iso8601, updated_at: :iso8601
# Override inherited associations to use admin serializers
one :parent,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
index ebadc8faf9..f1af54272f 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
@@ -4,7 +4,8 @@ module Spree
module Admin
class CreditCardSerializer < V3::CreditCardSerializer
typelize customer_id: [:string, nullable: true],
- payment_method_id: [:string, nullable: true]
+ payment_method_id: [:string, nullable: true],
+ metadata: 'Record<string, unknown>'
attribute :customer_id do |credit_card|
credit_card.user&.prefixed_id
@@ -14,7 +15,8 @@ module Spree
credit_card.payment_method&.prefixed_id
end
- attributes created_at: :iso8601, updated_at: :iso8601
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
index cbe432ff48..aef729f52e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
@@ -11,7 +11,7 @@ module Spree
last_sign_in_ip: [:string, nullable: true], current_sign_in_ip: [:string, nullable: true],
tags: [:string, multi: true],
internal_note_html: [:string, nullable: true],
- metadata: 'Record<string, unknown> | null',
+ metadata: 'Record<string, unknown>',
orders_count: :number,
total_spent: :string,
display_total_spent: :string,
@@ -20,7 +20,7 @@ module Spree
default_shipping_address_id: [:string, nullable: true]
# Admin-only attributes
- attributes :login,
+ attributes :login, :metadata,
last_sign_in_at: :iso8601, current_sign_in_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
@@ -48,10 +48,6 @@ module Spree
user.respond_to?(:internal_note) ? user.internal_note&.body&.to_s.presence : nil
end
- attribute :metadata do |user|
- user.metadata.presence
- end
-
attribute :default_billing_address_id do |user|
user.bill_address&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
index c7488351ef..e8110914c9 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
@@ -3,19 +3,15 @@ module Spree
module V3
module Admin
class FulfillmentSerializer < V3::FulfillmentSerializer
- typelize metadata: 'Record<string, unknown> | null',
+ typelize metadata: 'Record<string, unknown>',
order_id: [:string, nullable: true],
stock_location_id: [:string, nullable: true],
adjustment_total: :string,
pre_tax_amount: :string
- attributes :adjustment_total, :pre_tax_amount,
+ attributes :metadata, :adjustment_total, :pre_tax_amount,
created_at: :iso8601, updated_at: :iso8601
- attribute :metadata do |shipment|
- shipment.metadata.presence
- end
-
attribute :order_id do |shipment|
shipment.order&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
index df27f796f0..7279f22629 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
@@ -5,15 +5,12 @@ module Spree
# Admin API Line Item Serializer
# Extends the store serializer with metadata visibility
class LineItemSerializer < V3::LineItemSerializer
- typelize metadata: 'Record<string, unknown> | null',
+ typelize metadata: 'Record<string, unknown>',
cost_price: [:string, nullable: true],
tax_category_id: [:string, nullable: true]
- attributes created_at: :iso8601, updated_at: :iso8601
-
- attribute :metadata do |line_item|
- line_item.metadata.presence
- end
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
attribute :cost_price do |line_item|
line_item.cost_price&.to_s
diff --git a/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
index 578b173d1c..1c44338557 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
@@ -3,7 +3,8 @@ module Spree
module V3
module Admin
class MediaSerializer < V3::MediaSerializer
- typelize viewable_type: :string, viewable_id: :string
+ typelize viewable_type: :string, viewable_id: :string,
+ metadata: 'Record<string, unknown>'
attributes created_at: :iso8601, updated_at: :iso8601
@@ -11,7 +12,7 @@ module Spree
asset.viewable&.prefixed_id
end
- attributes :viewable_type
+ attributes :metadata, :viewable_type
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
index 356c0e069f..cd1cb02618 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
@@ -3,7 +3,10 @@ module Spree
module V3
module Admin
class OptionTypeSerializer < V3::OptionTypeSerializer
- attributes created_at: :iso8601, updated_at: :iso8601
+ typelize metadata: 'Record<string, unknown>'
+
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
many :option_values,
resource: Spree.api.admin_option_value_serializer
diff --git a/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
index cdd5a089a4..f318859ccd 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
@@ -3,7 +3,10 @@ module Spree
module V3
module Admin
class OptionValueSerializer < V3::OptionValueSerializer
- attributes created_at: :iso8601, updated_at: :iso8601
+ typelize metadata: 'Record<string, unknown>'
+
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
one :option_type,
resource: Spree.api.admin_option_type_serializer,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
index 468c28c39c..7acf1c3e2c 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
@@ -16,12 +16,12 @@ module Spree
canceled_at: [:string, nullable: true], approved_at: [:string, nullable: true],
payment_total: :string, display_payment_total: :string,
tags: [:string, multi: true],
- metadata: 'Record<string, unknown> | null'
+ metadata: 'Record<string, unknown>'
# Admin-only attributes
attributes :status, :last_ip_address, :considered_risky,
:confirmation_delivered, :store_owner_notification_delivered,
- :payment_total, :display_payment_total,
+ :payment_total, :display_payment_total, :metadata,
canceled_at: :iso8601, approved_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
@@ -33,10 +33,6 @@ module Spree
order.internal_note&.to_plain_text.presence
end
- attribute :metadata do |order|
- order.metadata.presence
- end
-
attribute :approver_id do |order|
order.approver&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_method_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_method_serializer.rb
index 81091d6711..d4b85d08bd 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_method_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_method_serializer.rb
@@ -3,9 +3,10 @@ module Spree
module V3
module Admin
class PaymentMethodSerializer < V3::PaymentMethodSerializer
- typelize active: :boolean, auto_capture: [:boolean, nullable: true]
+ typelize active: :boolean, auto_capture: [:boolean, nullable: true],
+ metadata: 'Record<string, unknown>'
- attributes :active, :auto_capture,
+ attributes :metadata, :active, :auto_capture,
created_at: :iso8601, updated_at: :iso8601
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
index 671559a458..109ccf9986 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
@@ -3,20 +3,16 @@ module Spree
module V3
module Admin
class PaymentSerializer < V3::PaymentSerializer
- typelize metadata: 'Record<string, unknown> | null',
+ typelize metadata: 'Record<string, unknown>',
captured_amount: :string,
order_id: [:string, nullable: true],
avs_response: [:string, nullable: true],
cvv_response_code: [:string, nullable: true],
cvv_response_message: [:string, nullable: true]
- attributes :avs_response, :cvv_response_code, :cvv_response_message,
+ attributes :metadata, :avs_response, :cvv_response_code, :cvv_response_message,
created_at: :iso8601, updated_at: :iso8601
- attribute :metadata do |payment|
- payment.metadata.presence
- end
-
attribute :captured_amount do |payment|
payment.captured_amount.to_s
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
index c177d69f87..1824664ae6 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
@@ -3,7 +3,10 @@ module Spree
module V3
module Admin
class PaymentSourceSerializer < V3::PaymentSourceSerializer
- attributes created_at: :iso8601, updated_at: :iso8601
+ typelize metadata: 'Record<string, unknown>'
+
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
index 9361cf7098..834bb45664 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
@@ -10,10 +10,11 @@ module Spree
# Additional type hints for admin-only computed attributes
typelize status: :string, make_active_at: [:string, nullable: true], discontinue_on: [:string, nullable: true],
cost_price: [:string, nullable: true], cost_currency: [:string, nullable: true],
- deleted_at: [:string, nullable: true]
+ deleted_at: [:string, nullable: true],
+ metadata: 'Record<string, unknown>'
# Admin-only attributes
- attributes :status, :make_active_at, :discontinue_on, deleted_at: :iso8601,
+ attributes :status, :make_active_at, :discontinue_on, :metadata, deleted_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
attribute :cost_price do |product|
diff --git a/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
index 38c1ab318b..2a719a3383 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
@@ -5,9 +5,11 @@ module Spree
class RefundSerializer < V3::RefundSerializer
typelize payment_id: [:string, nullable: true],
refund_reason_id: [:string, nullable: true],
- reimbursement_id: [:string, nullable: true]
+ reimbursement_id: [:string, nullable: true],
+ metadata: 'Record<string, unknown>'
- attributes created_at: :iso8601, updated_at: :iso8601
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
one :payment,
resource: Spree.api.admin_payment_serializer,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb
index fb002062a4..91d544501b 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb
@@ -3,7 +3,10 @@ module Spree
module V3
module Admin
class StockItemSerializer < V3::StockItemSerializer
- attributes created_at: :iso8601, updated_at: :iso8601
+ typelize metadata: 'Record<string, unknown>'
+
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
one :stock_location,
resource: Spree.api.admin_stock_location_serializer,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
index ab5d439154..17cf422cf9 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
@@ -5,9 +5,10 @@ module Spree
class StoreCreditSerializer < V3::StoreCreditSerializer
typelize customer_id: [:string, nullable: true],
created_by_id: [:string, nullable: true],
- metadata: 'Record<string, unknown> | null'
+ metadata: 'Record<string, unknown>'
- attributes created_at: :iso8601, updated_at: :iso8601
+ attributes :metadata,
+ created_at: :iso8601, updated_at: :iso8601
attribute :customer_id do |store_credit|
store_credit.user&.prefixed_id
@@ -17,10 +18,6 @@ module Spree
store_credit.created_by&.prefixed_id
end
- attribute :metadata do |store_credit|
- store_credit.metadata.presence
- end
-
attributes created_at: :iso8601, updated_at: :iso8601
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
index ffb40f5c13..03ee1a6036 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
@@ -18,9 +18,10 @@ module Spree
meta_description: [:string, nullable: true],
default: :boolean,
logo_url: [:string, nullable: true],
- mailer_logo_url: [:string, nullable: true]
+ mailer_logo_url: [:string, nullable: true],
+ metadata: 'Record<string, unknown>'
- attributes :id, :name, :url, :code,
+ attributes :metadata, :id, :name, :url, :code,
:mail_from_address, :customer_support_email,
:new_order_notifications_email,
:description, :address, :contact_phone,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
index ac835c47d8..99cd877ddc 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
@@ -11,10 +11,11 @@ module Spree
position: :number, tax_category_id: [:string, nullable: true],
cost_price: [:string, nullable: true], cost_currency: [:string, nullable: true],
total_on_hand: [:number, nullable: true],
- deleted_at: [:string, nullable: true]
+ deleted_at: [:string, nullable: true],
+ metadata: 'Record<string, unknown>'
# Admin-only attributes
- attributes :position, :total_on_hand, :tax_category_id, :cost_price, :cost_currency, deleted_at: :iso8601,
+ attributes :metadata, :position, :total_on_hand, :tax_category_id, :cost_price, :cost_currency, deleted_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
attribute :product_name do |variant|
diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rb
index 15ddf5ce3c..d4972b32a1 100644
--- a/spree/api/lib/spree/api/dependencies.rb
+++ b/spree/api/lib/spree/api/dependencies.rb
@@ -172,7 +172,6 @@ module Spree
admin_option_type_serializer: 'Spree::Api::V3::Admin::OptionTypeSerializer',
admin_option_value_serializer: 'Spree::Api::V3::Admin::OptionValueSerializer',
admin_media_serializer: 'Spree::Api::V3::Admin::MediaSerializer',
- admin_asset_serializer: 'Spree::Api::V3::Admin::AssetSerializer',
admin_stock_item_serializer: 'Spree::Api::V3::Admin::StockItemSerializer',
admin_shipment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
admin_fulfillment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
diff --git a/spree/api/spec/serializers/spree/api/v3/admin/line_item_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/admin/line_item_serializer_spec.rb
index ce4639dad3..9db75638bc 100644
--- a/spree/api/spec/serializers/spree/api/v3/admin/line_item_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/admin/line_item_serializer_spec.rb
@@ -18,8 +18,8 @@ RSpec.describe Spree::Api::V3::Admin::LineItemSerializer do
end
context 'when line item has no metadata' do
- it 'returns nil' do
- expect(subject['metadata']).to be_nil
+ it 'returns empty hash' do
+ expect(subject['metadata']).to eq({})
end
end
end
diff --git a/spree/api/spec/serializers/spree/api/v3/admin/order_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/admin/order_serializer_spec.rb
index 383b58ac1a..ffcddf7619 100644
--- a/spree/api/spec/serializers/spree/api/v3/admin/order_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/admin/order_serializer_spec.rb
@@ -17,8 +17,8 @@ RSpec.describe Spree::Api::V3::Admin::OrderSerializer do
end
context 'when order has no metadata' do
- it 'returns nil' do
- expect(subject['metadata']).to be_nil
+ it 'returns empty hash' do
+ expect(subject['metadata']).to eq({})
end
end
end