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.

Added generated TypeScript types for email template data

Damian Legawiece0f5f51087fd
diff --git a/lefthook.yml b/lefthook.yml
index 14c407f4c1..58867ee4ac 100644
--- a/lefthook.yml
+++ b/lefthook.yml
@@ -8,6 +8,9 @@ pre-commit:
glob:
- "spree/api/app/serializers/**/*.rb"
- "spree/api/lib/spree/api/webhook_event_types.rb"
+ - "spree/emails/app/serializers/**/*.rb"
+ - "spree/core/app/serializers/spree/emails/**/*.rb"
+ - "spree/*/config/initializers/typelizer.rb"
run: |
echo "Serializer changes detected — regenerating TypeScript types and Zod schemas..."
cd spree/api && bundle exec rake typelizer:generate && cd ../..
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailAmountLine.ts b/packages/admin-sdk/src/types/generated/emails/EmailAmountLine.ts
new file mode 100644
index 0000000000..e1b5492aa7
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailAmountLine.ts
@@ -0,0 +1,11 @@
+// Typelizer digest 9e77c6a3ab83fa351cbd7904236960a0
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface EmailAmountLine {
+ label: string | null;
+ display_amount: string;
+ amount: string;
+}
+
+export default EmailAmountLine;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailFulfillment.ts b/packages/admin-sdk/src/types/generated/emails/EmailFulfillment.ts
new file mode 100644
index 0000000000..76be643a85
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailFulfillment.ts
@@ -0,0 +1,40 @@
+// Typelizer digest 3b10580d72627dbd3924ce4a945ba3ec
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {Delivery, DeliveryMethod, StockLocation, DeliveryRate, TaxLine, EmailParcelItem, FulfillmentStatus} from '../..'
+
+interface EmailFulfillment {
+ id: string;
+ number: string;
+ tracking: string | null;
+ tracking_url: string | null;
+ pickup_point_data: Record<string, unknown> | null;
+ selected_delivery_rate_id: string | null;
+ unpriced: boolean;
+ cost: string | null;
+ display_cost: string | null;
+ total: string | null;
+ display_total: string | null;
+ discount_total: string | null;
+ display_discount_total: string | null;
+ additional_tax_total: string | null;
+ display_additional_tax_total: string | null;
+ included_tax_total: string | null;
+ display_included_tax_total: string | null;
+ tax_total: string | null;
+ display_tax_total: string | null;
+ status: FulfillmentStatus;
+ fulfillment_type: 'shipping' | 'digital' | 'pickup' | 'pickup_point';
+ fulfilled_at: string | null;
+ delivered_at: string | null;
+ items: Array<{ item_id: string; variant_id: string; quantity: number }>;
+ deliveries: Array<Delivery>;
+ delivery_method: DeliveryMethod;
+ stock_location: StockLocation;
+ delivery_rates: Array<DeliveryRate>;
+ tax_lines?: Array<TaxLine>;
+ delivery_method_name: string | null;
+ manifest_items: Array<EmailParcelItem>;
+}
+
+export default EmailFulfillment;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailFulfillmentGroup.ts b/packages/admin-sdk/src/types/generated/emails/EmailFulfillmentGroup.ts
new file mode 100644
index 0000000000..13398cc3fd
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailFulfillmentGroup.ts
@@ -0,0 +1,13 @@
+// Typelizer digest 1a068b1bf4fdd4c5542a98e9c6f4f7c7
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {EmailParcelItem} from '../..'
+
+interface EmailFulfillmentGroup {
+ name: string | null;
+ display_cost: string;
+ seller_names: Array<string>;
+ items: EmailParcelItem;
+}
+
+export default EmailFulfillmentGroup;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailLineItem.ts b/packages/admin-sdk/src/types/generated/emails/EmailLineItem.ts
new file mode 100644
index 0000000000..5e3615943e
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailLineItem.ts
@@ -0,0 +1,46 @@
+// Typelizer digest 2502e6bd5c843ad0cb02c6fdb71ae71f
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {Seller, OptionValue, DigitalLink, TaxLine} from '../..'
+
+interface EmailLineItem {
+ id: string;
+ variant_id: string;
+ seller_id: string | null;
+ preorder: boolean;
+ preorder_ships_at: string | null;
+ quantity: number;
+ currency: string;
+ name: string;
+ slug: string;
+ options_text: string;
+ price: string | null;
+ display_price: string | null;
+ total: string | null;
+ display_total: string | null;
+ adjustment_total: string | null;
+ display_adjustment_total: string | null;
+ additional_tax_total: string | null;
+ display_additional_tax_total: string | null;
+ included_tax_total: string | null;
+ display_included_tax_total: string | null;
+ discount_total: string | null;
+ display_discount_total: string | null;
+ pre_tax_amount: string | null;
+ display_pre_tax_amount: string | null;
+ discounted_amount: string | null;
+ display_discounted_amount: string | null;
+ display_compare_at_amount: string | null;
+ compare_at_amount: string | null;
+ thumbnail_url?: string | null;
+ seller?: Seller;
+ option_values: Array<OptionValue>;
+ digital_links?: Array<DigitalLink>;
+ tax_lines?: Array<TaxLine>;
+ url: string | null;
+ image_url: string | null;
+ sku: string | null;
+ display_amount: string;
+}
+
+export default EmailLineItem;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailOrder.ts b/packages/admin-sdk/src/types/generated/emails/EmailOrder.ts
new file mode 100644
index 0000000000..4742ec135a
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailOrder.ts
@@ -0,0 +1,70 @@
+// Typelizer digest 00fe4b5bcd0fc377d825a91a120d0079
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {AppliedPromotion, Fee, EmailLineItem, Fulfillment, Payment, Address, GiftCard, Market, EmailAmountLine} from '../..'
+
+interface EmailOrder {
+ id: string;
+ market_id: string | null;
+ withdrawal_period_ends_at: string | null;
+ within_withdrawal_period: boolean;
+ cart_id: string | null;
+ channel_id: string | null;
+ company_id: string | null;
+ company_name: string | null;
+ po_document_filename: string | null;
+ po_document_byte_size: number | null;
+ number: string;
+ email: string;
+ customer_note: string | null;
+ po_number: string | null;
+ currency: string;
+ locale: string | null;
+ total_quantity: number;
+ coupon_code: string | null;
+ fulfillment_status: 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped' | null;
+ payment_status: 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | null;
+ completed_at: string | null;
+ item_total: string | null;
+ display_item_total: string | null;
+ adjustment_total: string | null;
+ display_adjustment_total: string | null;
+ discount_total: string | null;
+ display_discount_total: string | null;
+ tax_total: string | null;
+ display_tax_total: string | null;
+ included_tax_total: string | null;
+ display_included_tax_total: string | null;
+ additional_tax_total: string | null;
+ display_additional_tax_total: string | null;
+ total: string | null;
+ display_total: string | null;
+ gift_card_total: string | null;
+ display_gift_card_total: string | null;
+ amount_due: string | null;
+ display_amount_due: string | null;
+ delivery_total: string | null;
+ display_delivery_total: string | null;
+ fee_total: string | null;
+ display_fee_total: string | null;
+ store_credit_total: string | null;
+ display_store_credit_total: string | null;
+ covered_by_store_credit: boolean;
+ discounts: Array<AppliedPromotion>;
+ fees: Array<Fee>;
+ items: Array<EmailLineItem>;
+ fulfillments: Array<Fulfillment>;
+ payments: Array<Payment>;
+ billing_address: Address | null;
+ shipping_address: Address | null;
+ gift_card: GiftCard | null;
+ market: Market | null;
+ customer_name: string;
+ display_total_minus_store_credits: string;
+ promotion_discounts: Array<EmailAmountLine>;
+ manual_discounts: Array<EmailAmountLine>;
+ fee_lines: Array<EmailAmountLine>;
+ delivery_lines: Array<EmailAmountLine>;
+}
+
+export default EmailOrder;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailOrderGroup.ts b/packages/admin-sdk/src/types/generated/emails/EmailOrderGroup.ts
new file mode 100644
index 0000000000..8fabf9fc86
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailOrderGroup.ts
@@ -0,0 +1,40 @@
+// Typelizer digest d95e5ee0b0eca30c9000af6cf47eec07
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {Address, Order, EmailLineItem, EmailAmountLine, EmailFulfillmentGroup} from '../..'
+
+interface EmailOrderGroup {
+ id: string;
+ number: string;
+ email: string | null;
+ currency: string;
+ total: string | null;
+ display_total: string | null;
+ item_total: string | null;
+ display_item_total: string | null;
+ fulfillment_status: 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped' | null;
+ payment_status: 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | null;
+ completed_at: string | null;
+ billing_address: Address | null;
+ shipping_address: Address | null;
+ orders?: Array<Order>;
+ customer_name: string;
+ display_total_minus_store_credits: string;
+ items: Array<EmailLineItem>;
+ promotion_discounts: Array<EmailAmountLine>;
+ manual_discounts: Array<EmailAmountLine>;
+ fee_lines: Array<EmailAmountLine>;
+ po_number: string | null;
+ order_count: number;
+ display_delivery_total: string;
+ delivery_total: string;
+ additional_tax_total: string;
+ display_additional_tax_total: string;
+ gift_card_total: string;
+ display_gift_card_total: string;
+ fulfillment_groups: Array<EmailFulfillmentGroup>;
+ unfulfilled_items: Array<EmailLineItem>;
+ delivery_lines: Array<EmailAmountLine>;
+}
+
+export default EmailOrderGroup;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailParcelItem.ts b/packages/admin-sdk/src/types/generated/emails/EmailParcelItem.ts
new file mode 100644
index 0000000000..5c8e2d61de
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailParcelItem.ts
@@ -0,0 +1,17 @@
+// Typelizer digest 734e21efefce79d24adce4a20423f78a
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface EmailParcelItem {
+ id: string;
+ url: string | null;
+ image_url: string | null;
+ name: string;
+ quantity: number;
+ sku: string | null;
+ options_text: string | null;
+ display_price: string;
+ display_amount: string;
+}
+
+export default EmailParcelItem;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailReturn.ts b/packages/admin-sdk/src/types/generated/emails/EmailReturn.ts
new file mode 100644
index 0000000000..0873903bdd
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailReturn.ts
@@ -0,0 +1,24 @@
+// Typelizer digest fd66640be5139e148e631ff1e0c98808
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {ReturnReason, ReturnLineItem, EmailLineItem, ReturnStatus} from '../..'
+
+interface EmailReturn {
+ id: string;
+ number: string;
+ status: ReturnStatus;
+ order_id: string | null;
+ reason_id: string | null;
+ refund_total: string;
+ display_refund_total: string;
+ approved_at: string | null;
+ received_at: string | null;
+ refunded_at: string | null;
+ canceled_at: string | null;
+ reason?: ReturnReason;
+ return_line_items?: Array<ReturnLineItem>;
+ display_refunded_total: string;
+ returned_items: Array<EmailLineItem>;
+}
+
+export default EmailReturn;
diff --git a/packages/admin-sdk/src/types/generated/emails/EmailStore.ts b/packages/admin-sdk/src/types/generated/emails/EmailStore.ts
new file mode 100644
index 0000000000..8ff96eda1c
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/EmailStore.ts
@@ -0,0 +1,18 @@
+// Typelizer digest e2d71c11c3fe406fb8bcd62062058cb4
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface EmailStore {
+ id: string;
+ name: string;
+ address: string | null;
+ mail_from_address: string;
+ default_currency: string;
+ default_locale: string;
+ url: string;
+ support_email: string;
+ logo_url: string | null;
+ logo_width: number | null;
+}
+
+export default EmailStore;
diff --git a/packages/admin-sdk/src/types/generated/emails/Enums.ts b/packages/admin-sdk/src/types/generated/emails/Enums.ts
new file mode 100644
index 0000000000..7fb0919636
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/Enums.ts
@@ -0,0 +1,5 @@
+// Typelizer digest c1a7c09ce2e9581e7dd1bc313042e168
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+export type FulfillmentStatus = 'unfulfilled' | 'fulfilled' | 'delivered' | 'canceled' | (string & {});
+export type ReturnStatus = 'requested' | 'approved' | 'received' | 'refunded' | 'canceled' | (string & {});
diff --git a/packages/admin-sdk/src/types/generated/emails/index.ts b/packages/admin-sdk/src/types/generated/emails/index.ts
new file mode 100644
index 0000000000..fb5c43ef51
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/emails/index.ts
@@ -0,0 +1,13 @@
+// Typelizer digest 7b5e1e70b5bd0a792e788ccdc11f38ba
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+export type { FulfillmentStatus, ReturnStatus } from './Enums'
+export type { default as EmailAmountLine } from './EmailAmountLine'
+export type { default as EmailFulfillmentGroup } from './EmailFulfillmentGroup'
+export type { default as EmailFulfillment } from './EmailFulfillment'
+export type { default as EmailLineItem } from './EmailLineItem'
+export type { default as EmailOrderGroup } from './EmailOrderGroup'
+export type { default as EmailOrder } from './EmailOrder'
+export type { default as EmailParcelItem } from './EmailParcelItem'
+export type { default as EmailReturn } from './EmailReturn'
+export type { default as EmailStore } from './EmailStore'
diff --git a/packages/admin-sdk/src/types/index.ts b/packages/admin-sdk/src/types/index.ts
index 93190d9864..9802a28734 100644
--- a/packages/admin-sdk/src/types/index.ts
+++ b/packages/admin-sdk/src/types/index.ts
@@ -65,6 +65,16 @@ export type * from './generated/Enums'
export type { default as Exchange } from './generated/Exchange'
export type { default as ExchangeLineItem } from './generated/ExchangeLineItem'
export type { default as Export } from './generated/Export'
+// The data customer email templates render with (generated from spree_emails)
+export type { default as EmailAmountLine } from './generated/emails/EmailAmountLine'
+export type { default as EmailFulfillment } from './generated/emails/EmailFulfillment'
+export type { default as EmailFulfillmentGroup } from './generated/emails/EmailFulfillmentGroup'
+export type { default as EmailLineItem } from './generated/emails/EmailLineItem'
+export type { default as EmailOrder } from './generated/emails/EmailOrder'
+export type { default as EmailOrderGroup } from './generated/emails/EmailOrderGroup'
+export type { default as EmailParcelItem } from './generated/emails/EmailParcelItem'
+export type { default as EmailReturn } from './generated/emails/EmailReturn'
+export type { default as EmailStore } from './generated/emails/EmailStore'
export type { default as Fee } from './generated/Fee'
export type { default as FreightSummary } from './generated/FreightSummary'
export type { default as FreightSummaryLine } from './generated/FreightSummaryLine'
diff --git a/spree/api/Rakefile b/spree/api/Rakefile
index 3b2ca2ef19..bc07ccb39c 100644
--- a/spree/api/Rakefile
+++ b/spree/api/Rakefile
@@ -67,43 +67,12 @@ namespace :rswag do
end
namespace :typelizer do
- desc 'Generate TypeScript types for both Store and Admin SDKs'
+ desc 'Generate TypeScript types for every SDK (runs in spree_emails, where all serializers load)'
task :generate do
- ENV['RAILS_ENV'] ||= 'test'
- ENV['DISABLE_TYPELIZER'] = 'false'
-
- require File.expand_path('spec/dummy/config/environment', __dir__)
-
- # Eager load serializers so typelizer can find them
- serializers_path = File.expand_path('app/serializers/spree/api/v3', __dir__)
- Rails.autoloaders.main.eager_load_dir(serializers_path)
-
- require 'typelizer/generator'
-
- # Writer config is in config/initializers/typelizer.rb
- Typelizer::Generator.call(force: true)
-
- # Post-process: convert `type Foo = {` to `interface Foo {` for declaration merging support.
- # This lets SDK consumers extend generated types via `declare module '@spree/sdk' { interface Product { ... } }`.
- api_root = Spree::Api::Engine.root
- [
- api_root.join('../../packages/sdk/src/types/generated'),
- api_root.join('../../packages/admin-sdk/src/types/generated')
- ].each do |dir|
- Dir[File.join(dir, '*.ts')].each do |file|
- next if File.basename(file) == 'index.ts'
-
- content = File.read(file)
- updated = content.gsub(/^type (\w+) = \{/, 'interface \1 {')
- File.write(file, updated) if updated != content
- end
+ emails_dir = File.expand_path('../emails', __dir__)
+ Bundler.with_unbundled_env do
+ sh "cd #{emails_dir} && bundle exec rake typelizer:generate"
end
-
- require Spree::Api::Engine.root.join('lib/spree/api/webhook_event_types').to_s
- Spree::Api::WebhookEventTypes.new.write!(api_root.join('../..'))
-
- puts "Generated types → packages/sdk/src/types/generated/ & packages/admin-sdk/src/types/generated/"
- puts "Generated webhook events → packages/sdk/src/webhooks/generated/"
end
desc 'Clean and regenerate TypeScript types'
diff --git a/spree/api/config/initializers/typelizer.rb b/spree/api/config/initializers/typelizer.rb
index 7f98d38a99..e766ec688b 100644
--- a/spree/api/config/initializers/typelizer.rb
+++ b/spree/api/config/initializers/typelizer.rb
@@ -32,7 +32,7 @@ Rails.application.config.after_initialize do
c.output_dir = api_root.join('../../packages/sdk/src/types/generated')
c.reject_class = ->(serializer:) {
name = serializer.name.to_s
- name.include?('::Admin::') || name.include?('::Seller::') ||
+ !name.start_with?('Spree::Api::V3::') || name.include?('::Admin::') || name.include?('::Seller::') ||
store_excluded.include?(name.sub(/\ASpree::Api::V3::/, '').sub(/Serializer\z/, ''))
}
c.serializer_name_mapper = ->(serializer) {
diff --git a/spree/api/lib/spree/api/typelizer_generation.rb b/spree/api/lib/spree/api/typelizer_generation.rb
new file mode 100644
index 0000000000..2252da8bf9
--- /dev/null
+++ b/spree/api/lib/spree/api/typelizer_generation.rb
@@ -0,0 +1,35 @@
+module Spree
+ module Api
+ # Generates every SDK's TypeScript types from the serializers, the email
+ # template types included. Runs inside spree_emails' test app, the one
+ # place where the API's and the email serializers are all loaded: running
+ # it with any serializer missing would delete that serializer's types.
+ module TypelizerGeneration
+ # @param serializer_dirs [Array<String, Pathname>] directories to load before generating
+ def self.call(serializer_dirs)
+ serializer_dirs.each { |dir| Rails.autoloaders.main.eager_load_dir(dir.to_s) }
+
+ require 'typelizer/generator'
+ Typelizer::Generator.call(force: true)
+
+ # `interface` rather than `type`, so SDK consumers can extend generated
+ # types through declaration merging.
+ api_root = Spree::Api::Engine.root
+ [api_root.join('../../packages/sdk/src/types/generated'), api_root.join('../../packages/admin-sdk/src/types/generated'),
+ api_root.join('../../packages/admin-sdk/src/types/generated/emails')].each do |dir|
+ Dir[File.join(dir, '*.ts')].each do |file|
+ next if File.basename(file) == 'index.ts'
+
+ content = File.read(file)
+ updated = content.gsub(/^type (\w+) = \{/, 'interface \1 {')
+ File.write(file, updated) if updated != content
+ end
+ end
+
+ # The typed webhook events in @spree/sdk, from the event catalog.
+ require Spree::Api::Engine.root.join('lib/spree/api/webhook_event_types').to_s
+ Spree::Api::WebhookEventTypes.new.write!(api_root.join('../..'))
+ end
+ end
+ end
+end
diff --git a/spree/emails/Rakefile b/spree/emails/Rakefile
index 1b7712acc9..79bf870d16 100644
--- a/spree/emails/Rakefile
+++ b/spree/emails/Rakefile
@@ -13,3 +13,26 @@ task :test_app do
ENV['LIB_NAME'] = 'spree/emails'
Rake::Task['common:test_app'].invoke
end
+
+namespace :typelizer do
+ desc 'Generate TypeScript types for every SDK, the email template types included'
+ task :generate do
+ ENV['RAILS_ENV'] ||= 'test'
+ ENV['DISABLE_TYPELIZER'] = 'false'
+ ENV['ENABLE_TYPELIZER'] = '1'
+
+ dummy = File.expand_path('spec/dummy/config/environment.rb', __dir__)
+ abort 'Build the test app first: cd spree/emails && bundle exec rake test_app' unless File.exist?(dummy)
+
+ require dummy
+ require 'spree/api/typelizer_generation'
+
+ Spree::Api::TypelizerGeneration.call([
+ Spree::Api::Engine.root.join('app/serializers/spree/api/v3'),
+ Spree::Emails::Engine.root.join('app/serializers/spree/emails'),
+ Spree::Core::Engine.root.join('app/serializers/spree/emails')
+ ])
+
+ puts 'Generated types → packages/sdk, packages/admin-sdk and packages/seller-sdk'
+ end
+end
diff --git a/spree/emails/app/serializers/spree/emails/fulfillment_serializer.rb b/spree/emails/app/serializers/spree/emails/fulfillment_serializer.rb
index 9140e0ed10..feb889de30 100644
--- a/spree/emails/app/serializers/spree/emails/fulfillment_serializer.rb
+++ b/spree/emails/app/serializers/spree/emails/fulfillment_serializer.rb
@@ -1,6 +1,8 @@
module Spree
module Emails
class FulfillmentSerializer < Spree::Api::V3::FulfillmentSerializer
+ typelize delivery_method_name: [:string, nullable: true]
+
attribute :delivery_method_name do |fulfillment|
fulfillment.delivery_method&.name
end
diff --git a/spree/emails/app/serializers/spree/emails/line_item_serializer.rb b/spree/emails/app/serializers/spree/emails/line_item_serializer.rb
index 5a81a2fa7d..0f27619a43 100644
--- a/spree/emails/app/serializers/spree/emails/line_item_serializer.rb
+++ b/spree/emails/app/serializers/spree/emails/line_item_serializer.rb
@@ -3,6 +3,9 @@ module Spree
class LineItemSerializer < Spree::Api::V3::LineItemSerializer
include Spree::Emails::PurchasedItemAttributes
+ typelize sku: [:string, nullable: true], display_amount: :string,
+ url: [:string, nullable: true], image_url: [:string, nullable: true]
+
attributes :sku
# Price times quantity, before discounts — what the line cost.
diff --git a/spree/emails/app/serializers/spree/emails/order_group_serializer.rb b/spree/emails/app/serializers/spree/emails/order_group_serializer.rb
index dc84c7bc4b..c99fe0d6d0 100644
--- a/spree/emails/app/serializers/spree/emails/order_group_serializer.rb
+++ b/spree/emails/app/serializers/spree/emails/order_group_serializer.rb
@@ -5,6 +5,11 @@ module Spree
class OrderGroupSerializer < Spree::Api::V3::OrderGroupSerializer
include Spree::Emails::PurchaseSummaryAttributes
+ typelize po_number: [:string, nullable: true], order_count: :number,
+ delivery_total: :string, display_delivery_total: :string,
+ additional_tax_total: :string, display_additional_tax_total: :string,
+ gift_card_total: :string, display_gift_card_total: :string
+
attributes :po_number
attribute :order_count do |group|
diff --git a/spree/emails/app/serializers/spree/emails/purchase_summary_attributes.rb b/spree/emails/app/serializers/spree/emails/purchase_summary_attributes.rb
index 618c5ebcc2..00dc686bdc 100644
--- a/spree/emails/app/serializers/spree/emails/purchase_summary_attributes.rb
+++ b/spree/emails/app/serializers/spree/emails/purchase_summary_attributes.rb
@@ -7,6 +7,8 @@ module Spree
extend ActiveSupport::Concern
included do
+ typelize customer_name: :string, display_total_minus_store_credits: :string
+
attribute :customer_name do |purchase|
purchase.name.presence || Spree.t(:customer)
end
diff --git a/spree/emails/app/serializers/spree/emails/return_serializer.rb b/spree/emails/app/serializers/spree/emails/return_serializer.rb
index be7c30f288..b35c4efad2 100644
--- a/spree/emails/app/serializers/spree/emails/return_serializer.rb
+++ b/spree/emails/app/serializers/spree/emails/return_serializer.rb
@@ -1,6 +1,8 @@
module Spree
module Emails
class ReturnSerializer < Spree::Api::V3::ReturnSerializer
+ typelize display_refunded_total: :string
+
# What was actually paid back — not the Store API's refund_total, which
# is the figure the return was expected to refund.
attribute :display_refunded_total do |return_record|
diff --git a/spree/emails/config/initializers/typelizer.rb b/spree/emails/config/initializers/typelizer.rb
new file mode 100644
index 0000000000..4a688ae174
--- /dev/null
+++ b/spree/emails/config/initializers/typelizer.rb
@@ -0,0 +1,55 @@
+# Generates TypeScript types for the data customer email templates receive,
+# into @spree/admin-sdk as Email* types, for the dashboard's template editor.
+# Runs only under `bundle exec rake typelizer:generate`.
+Rails.application.config.after_initialize do
+ next unless defined?(Typelizer) && ENV['ENABLE_TYPELIZER']
+
+ emails_root = Spree::Emails::Engine.root
+
+ # Core's email serializers cannot depend on Typelizer, and two of the
+ # customer email serializers stand alone, so they get its DSL here.
+ [Spree::Emails::BaseSerializer, Spree::Emails::AmountLineSerializer, Spree::Emails::FulfillmentGroupSerializer].each do |serializer|
+ serializer.extend(Typelizer::DSL) unless serializer.respond_to?(:typelize)
+ end
+
+ Spree::Emails::AmountLineSerializer.typelize(label: [:string, nullable: true], amount: :string, display_amount: :string)
+ Spree::Emails::FulfillmentGroupSerializer.typelize(name: [:string, nullable: true], display_cost: :string,
+ seller_names: [:string, multi: true])
+ Spree::Emails::ParcelItemSerializer.typelize(
+ id: :string, name: :string, quantity: :number, sku: [:string, nullable: true], options_text: [:string, nullable: true],
+ display_price: :string, display_amount: :string, url: [:string, nullable: true], image_url: [:string, nullable: true]
+ )
+ Spree::Emails::StoreSerializer.typelize(
+ id: :string, name: :string, address: [:string, nullable: true], mail_from_address: :string, default_currency: :string,
+ default_locale: :string, url: :string, support_email: :string, logo_url: [:string, nullable: true],
+ logo_width: [:number, nullable: true]
+ )
+
+ # Staff emails are not editable, so their data has no type.
+ staff = %w[User Invitation Import Export WebhookEndpoint].to_set
+
+ Typelizer.configure do |config|
+ config.dirs += [emails_root.join('app/serializers/spree/emails'), Spree::Core::Engine.root.join('app/serializers/spree/emails')]
+
+ # Their own folder in the admin SDK; the Store API types they nest
+ # (Payment, Address, ...) import from the admin SDK's types of that name.
+ config.writer(:emails, from: :admin) do |c|
+ c.output_dir = emails_root.join('../../packages/admin-sdk/src/types/generated/emails')
+ # The SDK's full type index, which exports these and the admin types alike.
+ c.types_import_path = '../..'
+ c.reject_class = ->(serializer:) {
+ name = serializer.name.to_s
+ bare = name.delete_prefix('Spree::Emails::').delete_suffix('Serializer')
+ !name.start_with?('Spree::Emails::') || staff.include?(bare) || bare == 'Base'
+ }
+ c.serializer_name_mapper = ->(serializer) {
+ name = serializer.name.to_s
+ if name.start_with?('Spree::Emails::')
+ "Email#{name.delete_prefix('Spree::Emails::').delete_suffix('Serializer')}"
+ else
+ name.sub(/\ASpree::Api::V3::(Admin::)?/, '').delete_suffix('Serializer')
+ end
+ }
+ end
+ end
+end