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.

Changed filter tables to read type columns from the model

Damian Legawiec2d2a12f9ea9d
diff --git a/CLAUDE.md b/CLAUDE.md
index 9ff7954b82..eace2a1e2e 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -351,7 +351,7 @@ attribute :variant_id
- Serialize with `Spree::Base.polymorphic_api_type(record.owner_type)` — the configured customer and admin user classes always read `customer` / `admin_user`
- Accept with `Spree::Base.polymorphic_type_for(value, candidates)` against the classes that column may hold
-- **Filters**: the base `ResourceController` translates `type_*` and polymorphic `*_type_*` predicates (`q[receivable_type_eq]=purchase_order`) to class names; a plain column holding class names (`CustomFieldDefinition#resource_type`) overrides `api_type_resolver`
+- **Filters**: the base `ResourceController` translates `type_*` and polymorphic `*_type_*` predicates (`q[receivable_type_eq]=purchase_order`) to class names; a plain column holding class names (`CustomFieldDefinition#resource_type`) overrides the model's `api_type_resolver`, which the published filter tables read too
**Permission subjects** follow the same rule: `/me` serializes class subjects through `polymorphic_api_type` (`product`, `category`), and the dashboard checks them with the `Subject` constants.
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yaml
index 35cf694b92..0a5bb4f562 100644
--- a/docs/api-reference/admin.yaml
+++ b/docs/api-reference/admin.yaml
@@ -54123,12 +54123,12 @@ components:
CustomFieldDefinition:
attributes:
created_at: datetime
- field_type: text
+ field_type: type
id: id
key: text
label: text
namespace: text
- resource_type: text
+ resource_type: type
searchable: boolean
sortable: boolean
storefront_visible: boolean
diff --git a/packages/admin-sdk/src/types/filters.generated.ts b/packages/admin-sdk/src/types/filters.generated.ts
index 4a0416183c..674e0bc219 100644
--- a/packages/admin-sdk/src/types/filters.generated.ts
+++ b/packages/admin-sdk/src/types/filters.generated.ts
@@ -6,70 +6,70 @@ export type AddressFields = Filter.TextFilters<'address1' | 'address2' | 'city'
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type AdminUserFields = Filter.TextFilters<'email' | 'first_name' | 'last_name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type AdminUserFields = Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'email' | 'first_name' | 'last_name'>
& Filter.IdFilters<'id'>
-export type AllowedOriginFields = Filter.TextFilters<'origin'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type AllowedOriginFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'origin'>
-export type ApiKeyFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ApiKeyFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type CatalogFields = Filter.TextFilters<'name'>
+export type CatalogFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
+ & Filter.RangeFilters<'position', number>
export type CatalogOrderMinimumFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type CategoryFields = Filter.TextFilters<'name' | 'permalink' | 'pretty_name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type CategoryFields = Filter.BooleanFilters<'automatic'>
& Filter.RangeFilters<'children_count' | 'depth' | 'position' | 'products_count', number>
+ & Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'parent_id'>
- & Filter.BooleanFilters<'automatic'>
+ & Filter.TextFilters<'name' | 'permalink' | 'pretty_name'>
-export type ChannelFields = Filter.TextFilters<'code' | 'name'>
+export type ChannelFields = Filter.BooleanFilters<'active' | 'default'>
+ & Filter.TextFilters<'code' | 'name'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'store_id'>
- & Filter.BooleanFilters<'active' | 'default'>
-export type ClaimReasonFields = Filter.TextFilters<'name'>
+export type ClaimReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type CollectionFields = Filter.TextFilters<'name' | 'permalink'>
+export type CollectionFields = Filter.BooleanFilters<'automatic'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position' | 'products_count', number>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'automatic'>
+ & Filter.TextFilters<'name' | 'permalink'>
+ & Filter.RangeFilters<'position' | 'products_count', number>
& Filter.EnumFilters<'sort_order', 'manual' | 'best_selling' | 'price asc' | 'price desc' | 'available_on desc' | 'available_on asc' | 'name asc' | 'name desc'>
-export type CommissionLineFields = Filter.TextFilters<'currency'>
- & Filter.RangeFilters<'amount' | 'rate' | 'tax_amount' | 'total', string | number>
+export type CommissionLineFields = Filter.RangeFilters<'amount' | 'rate' | 'tax_amount' | 'total', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency'>
& Filter.IdFilters<'id' | 'order_id'>
& Filter.EnumFilters<'kind', 'percentage' | 'fixed'>
export type CommissionRateFields = Filter.TextFilters<'code' | 'name'>
- & Filter.RangeFilters<'value', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
- & Filter.IdFilters<'id'>
& Filter.BooleanFilters<'enabled' | 'include_shipping' | 'tax_inclusive'>
+ & Filter.IdFilters<'id'>
+ & Filter.RangeFilters<'position', number>
+ & Filter.RangeFilters<'value', string | number>
& Filter.EnumFilters<'kind', 'percentage' | 'fixed'>
export type CommissionRuleFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type CompanyFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type CompanyFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'parent_id'>
+ & Filter.TextFilters<'name'>
& Filter.BooleanFilters<'po_number_required'>
& Filter.EnumFilters<'kind', 'company' | 'division'>
@@ -81,41 +81,41 @@ export type CouponCodeFields = Filter.TextFilters<'code'>
& Filter.IdFilters<'id' | 'promotion_id'>
& Filter.EnumFilters<'state', 'unused' | 'used'>
-export type CreditCardFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type CreditCardFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
export type CustomFieldFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type CustomFieldDefinitionFields = Filter.TextFilters<'field_type' | 'key' | 'label' | 'namespace' | 'resource_type'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.IdFilters<'id'>
+export type CustomFieldDefinitionFields = Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.IdFilters<'field_type' | 'id' | 'resource_type'>
+ & Filter.TextFilters<'key' | 'label' | 'namespace'>
& Filter.BooleanFilters<'searchable' | 'sortable' | 'storefront_visible'>
-export type CustomerFields = Filter.TextFilters<'email' | 'first_name' | 'last_name' | 'phone'>
+export type CustomerFields = Filter.BooleanFilters<'accepts_email_marketing'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'email' | 'first_name' | 'last_name' | 'phone'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'accepts_email_marketing'>
-export type CustomerGroupFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type CustomerGroupFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
export type DeliveryFields = Filter.TextFilters<'carrier' | 'tracking_number'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
& Filter.EnumFilters<'status', 'pending' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'available_for_pickup' | 'delivered' | 'return_to_sender' | 'failure' | 'unknown'>
-export type DeliveryMethodFields = Filter.TextFilters<'name'>
+export type DeliveryMethodFields = Filter.BooleanFilters<'available_to_sellers' | 'storefront_visible'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id'>
- & Filter.BooleanFilters<'available_to_sellers' | 'storefront_visible'>
+ & Filter.TextFilters<'name'>
-export type DeliveryProfileFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type DeliveryProfileFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
+ & Filter.RangeFilters<'position', number>
export type DiscountFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
@@ -123,37 +123,37 @@ export type DiscountFields = Filter.RangeFilters<'created_at' | 'updated_at'>
export type EmailTemplateRevisionFields = Filter.RangeFilters<'created_at'>
& Filter.IdFilters<'id'>
-export type ExportFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ExportFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id' | 'type'>
+ & Filter.TextFilters<'number'>
& Filter.EnumFilters<'format', 'csv'>
-export type ExternalReferenceFields = Filter.TextFilters<'external_id' | 'system'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ExternalReferenceFields = Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'external_id' | 'system'>
& Filter.IdFilters<'id' | 'resource_type'>
-export type FulfillmentFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type FulfillmentFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'number'>
export type GiftCardFields = Filter.TextFilters<'code' | 'currency'>
- & Filter.RangeFilters<'expires_at' | 'created_at' | 'updated_at'>
+ & Filter.RangeFilters<'created_at' | 'expires_at' | 'updated_at'>
& Filter.IdFilters<'created_by_id' | 'customer_id' | 'gift_card_batch_id' | 'id'>
& Filter.EnumFilters<'state', 'active' | 'partially_redeemed' | 'redeemed' | 'canceled'>
& Filter.EnumFilters<'status', 'active' | 'partially_redeemed' | 'redeemed' | 'canceled'>
-export type GiftCardBatchFields = Filter.TextFilters<'prefix'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type GiftCardBatchFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'prefix'>
-export type ImportFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ImportFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id' | 'type'>
+ & Filter.TextFilters<'number'>
& Filter.EnumFilters<'status', 'pending' | 'mapping' | 'completed_mapping' | 'processing' | 'completed' | 'failed'>
export type ImportRowFields = Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'row_number', number>
& Filter.IdFilters<'id'>
+ & Filter.RangeFilters<'row_number', number>
& Filter.EnumFilters<'status', 'pending' | 'processing' | 'completed' | 'failed'>
export type IntegrationFields = Filter.RangeFilters<'created_at' | 'updated_at'>
@@ -164,105 +164,105 @@ export type InvitationFields = Filter.RangeFilters<'created_at' | 'updated_at'>
export type LineItemFields = Filter.RangeFilters<'additional_tax_total' | 'adjustment_total' | 'cost_price' | 'discount_total' | 'included_tax_total' | 'non_taxable_adjustment_total' | 'pre_tax_amount' | 'price' | 'taxable_adjustment_total', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'quantity', number>
& Filter.IdFilters<'id' | 'order_id' | 'tax_category_id' | 'variant_id'>
+ & Filter.RangeFilters<'quantity', number>
-export type MarketFields = Filter.TextFilters<'currency' | 'default_locale' | 'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type MarketFields = Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'default_locale' | 'name'>
& Filter.IdFilters<'id'>
+ & Filter.RangeFilters<'position', number>
export type MediaFields = Filter.TextFilters<'alt'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
& Filter.IdFilters<'id'>
+ & Filter.RangeFilters<'position', number>
& Filter.EnumFilters<'media_type', 'image' | 'video' | 'external_video'>
-export type OptionTypeFields = Filter.TextFilters<'label' | 'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type OptionTypeFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'label' | 'name'>
+ & Filter.RangeFilters<'position', number>
& Filter.EnumFilters<'kind', 'dropdown' | 'color_swatch' | 'buttons'>
-export type OptionValueFields = Filter.TextFilters<'label' | 'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type OptionValueFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'label' | 'name'>
+ & Filter.RangeFilters<'position', number>
-export type OrderFields = Filter.TextFilters<'coupon_code' | 'currency' | 'email' | 'number' | 'po_number'>
- & Filter.RangeFilters<'delivery_total' | 'item_total' | 'total', string | number>
+export type OrderFields = Filter.IdFilters<'channel_id' | 'customer_id' | 'id' | 'order_group_id' | 'seller_id'>
& Filter.RangeFilters<'completed_at' | 'created_at' | 'updated_at'>
- & Filter.RangeFilters<'total_quantity', number>
- & Filter.IdFilters<'channel_id' | 'customer_id' | 'id' | 'order_group_id' | 'seller_id'>
& Filter.BooleanFilters<'considered_risky'>
+ & Filter.TextFilters<'coupon_code' | 'currency' | 'email' | 'number' | 'po_number'>
+ & Filter.RangeFilters<'delivery_total' | 'item_total' | 'total', string | number>
+ & Filter.RangeFilters<'total_quantity', number>
& Filter.EnumFilters<'fulfillment_status', 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped'>
& Filter.EnumFilters<'payment_state', 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | 'balance_due' | 'credit_owed' | 'failed' | 'void'>
& Filter.EnumFilters<'payment_status', 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | 'balance_due' | 'credit_owed' | 'failed' | 'void'>
& Filter.EnumFilters<'shipment_state', 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped'>
& Filter.EnumFilters<'status', 'draft' | 'placed' | 'canceled'>
-export type OrderCancellationReasonFields = Filter.TextFilters<'name'>
+export type OrderCancellationReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type OrderGroupFields = Filter.TextFilters<'currency' | 'email' | 'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type OrderGroupFields = Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'email' | 'number'>
& Filter.IdFilters<'id'>
-export type OrderRoutingRuleFields = Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type OrderRoutingRuleFields = Filter.BooleanFilters<'active'>
& Filter.IdFilters<'channel_id' | 'id' | 'store_id' | 'type'>
- & Filter.BooleanFilters<'active'>
-
-export type PackageTypeFields = Filter.TextFilters<'name'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.IdFilters<'id' | 'seller_id'>
+ & Filter.RangeFilters<'position', number>
+
+export type PackageTypeFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.BooleanFilters<'default'>
+ & Filter.IdFilters<'id' | 'seller_id'>
+ & Filter.TextFilters<'name'>
& Filter.EnumFilters<'kind', 'box' | 'envelope' | 'carton' | 'pallet' | 'container'>
-export type PaymentFields = Filter.TextFilters<'avs_response' | 'cvv_response_code' | 'cvv_response_message' | 'response_code'>
- & Filter.RangeFilters<'amount', string | number>
+export type PaymentFields = Filter.RangeFilters<'amount', string | number>
+ & Filter.TextFilters<'avs_response' | 'cvv_response_code' | 'cvv_response_message' | 'response_code'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
& Filter.EnumFilters<'state', 'checkout' | 'processing' | 'pending' | 'completed' | 'failed' | 'void' | 'invalid'>
& Filter.EnumFilters<'status', 'checkout' | 'processing' | 'pending' | 'completed' | 'failed' | 'void' | 'invalid'>
-export type PaymentMethodFields = Filter.TextFilters<'name'>
+export type PaymentMethodFields = Filter.BooleanFilters<'active' | 'storefront_visible'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
& Filter.IdFilters<'id' | 'type'>
- & Filter.BooleanFilters<'active' | 'storefront_visible'>
+ & Filter.TextFilters<'name'>
+ & Filter.RangeFilters<'position', number>
-export type PolicyFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type PolicyFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'owner_id' | 'owner_type'>
+ & Filter.TextFilters<'name'>
-export type PriceFields = Filter.TextFilters<'currency'>
- & Filter.RangeFilters<'amount' | 'compare_at_amount', string | number>
+export type PriceFields = Filter.RangeFilters<'amount' | 'compare_at_amount', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'min_quantity', number>
+ & Filter.TextFilters<'currency'>
& Filter.IdFilters<'id' | 'price_list_id' | 'variant_id'>
+ & Filter.RangeFilters<'min_quantity', number>
-export type PriceListFields = Filter.TextFilters<'name'>
+export type PriceListFields = Filter.IdFilters<'catalog_id' | 'id'>
& Filter.RangeFilters<'created_at' | 'ends_at' | 'starts_at' | 'updated_at'>
+ & Filter.TextFilters<'name'>
& Filter.RangeFilters<'position', number>
- & Filter.IdFilters<'catalog_id' | 'id'>
& Filter.EnumFilters<'match_policy', 'all' | 'any'>
& Filter.EnumFilters<'status', 'draft' | 'active' | 'inactive' | 'scheduled'>
-export type ProductFields = Filter.TextFilters<'description' | 'name' | 'slug'>
- & Filter.RangeFilters<'available_on' | 'created_at' | 'discontinue_on' | 'updated_at'>
+export type ProductFields = Filter.RangeFilters<'available_on' | 'created_at' | 'discontinue_on' | 'updated_at'>
+ & Filter.TextFilters<'description' | 'name' | 'slug'>
& Filter.IdFilters<'id' | 'seller_id'>
& Filter.EnumFilters<'status', 'draft' | 'active' | 'archived' | 'proposed' | 'rejected'>
-export type ProductCategoryFields = Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ProductCategoryFields = Filter.IdFilters<'category_id' | 'id' | 'product_id'>
+ & Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.RangeFilters<'position', number>
- & Filter.IdFilters<'category_id' | 'id' | 'product_id'>
-export type ProductTypeFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ProductTypeFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
export type PromotionFields = Filter.TextFilters<'code' | 'name' | 'path'>
& Filter.RangeFilters<'created_at' | 'expires_at' | 'starts_at' | 'updated_at'>
@@ -270,48 +270,48 @@ export type PromotionFields = Filter.TextFilters<'code' | 'name' | 'path'>
& Filter.EnumFilters<'kind', 'coupon_code' | 'automatic'>
export type PromotionActionFields = Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
& Filter.IdFilters<'id'>
+ & Filter.RangeFilters<'position', number>
export type PromotionRuleFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type PurchaseOrderFields = Filter.TextFilters<'currency' | 'number' | 'reference'>
- & Filter.RangeFilters<'cancel_by' | 'expected_at' | 'closed_short_at' | 'created_at' | 'ordered_at' | 'received_at' | 'updated_at'>
+export type PurchaseOrderFields = Filter.RangeFilters<'cancel_by' | 'closed_short_at' | 'created_at' | 'expected_at' | 'ordered_at' | 'received_at' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'number' | 'reference'>
& Filter.IdFilters<'destination_location_id' | 'id' | 'supplier_id'>
& Filter.EnumFilters<'status', 'draft' | 'ordered' | 'partially_received' | 'received' | 'over_received' | 'canceled'>
-export type PurchaseOrderItemFields = Filter.RangeFilters<'unit_cost', string | number>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'quantity_ordered' | 'quantity_received' | 'quantity_rejected', number>
+export type PurchaseOrderItemFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'variant_id'>
+ & Filter.RangeFilters<'quantity_ordered' | 'quantity_received' | 'quantity_rejected', number>
+ & Filter.RangeFilters<'unit_cost', string | number>
export type RefundFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type RefundReasonFields = Filter.TextFilters<'name'>
+export type RefundReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type ReturnReasonFields = Filter.TextFilters<'name'>
+export type ReturnReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type RoleFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type RoleFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
export type SellerFields = Filter.TextFilters<'contact_email' | 'name'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
& Filter.EnumFilters<'status', 'pending' | 'invited' | 'canceled' | 'onboarding' | 'ready_for_review' | 'approved' | 'rejected' | 'suspended'>
-export type SellerRequirementFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type SellerRequirementFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
+ & Filter.RangeFilters<'position', number>
export type ShippingLabelFields = Filter.TextFilters<'carrier' | 'tracking_number'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
@@ -319,43 +319,43 @@ export type ShippingLabelFields = Filter.TextFilters<'carrier' | 'tracking_numbe
& Filter.EnumFilters<'source', 'purchased' | 'uploaded'>
& Filter.EnumFilters<'status', 'purchased' | 'refund_requested' | 'refunded'>
-export type StockLevelFields = Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'allocated_count' | 'count_on_hand' | 'incoming_count' | 'reserved_count', number>
+export type StockLevelFields = Filter.RangeFilters<'allocated_count' | 'count_on_hand' | 'incoming_count' | 'reserved_count', number>
+ & Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'stock_location_id' | 'variant_id'>
-export type StockLocationFields = Filter.TextFilters<'country_code' | 'kind' | 'name' | 'state_code'>
+export type StockLocationFields = Filter.BooleanFilters<'active' | 'default' | 'pickup_enabled' | 'returns_enabled'>
+ & Filter.TextFilters<'country_code' | 'kind' | 'name' | 'state_code'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id'>
- & Filter.BooleanFilters<'active' | 'default' | 'pickup_enabled' | 'returns_enabled'>
-export type StockMovementFields = Filter.TextFilters<'reason'>
- & Filter.RangeFilters<'unit_cost', string | number>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'quantity', number>
+export type StockMovementFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'exchange_id' | 'fulfillment_id' | 'id' | 'order_id' | 'purchase_order_id' | 'return_id' | 'stock_item_id' | 'stock_level_id' | 'stock_receipt_id' | 'stock_transfer_id'>
+ & Filter.RangeFilters<'quantity', number>
+ & Filter.TextFilters<'reason'>
+ & Filter.RangeFilters<'unit_cost', string | number>
& Filter.EnumFilters<'kind', 'received' | 'allocated' | 'shipped' | 'released' | 'adjusted'>
-export type StockReceiptFields = Filter.TextFilters<'number' | 'reference'>
- & Filter.RangeFilters<'created_at' | 'received_at' | 'updated_at'>
- & Filter.IdFilters<'id' | 'receivable_id' | 'received_by_id' | 'receivable_type' | 'received_by_type'>
+export type StockReceiptFields = Filter.RangeFilters<'created_at' | 'received_at' | 'updated_at'>
+ & Filter.IdFilters<'id' | 'receivable_id' | 'receivable_type' | 'received_by_id' | 'received_by_type'>
+ & Filter.TextFilters<'number' | 'reference'>
-export type StockTransferFields = Filter.TextFilters<'number' | 'reference'>
- & Filter.RangeFilters<'closed_short_at' | 'created_at' | 'received_at' | 'shipped_at' | 'updated_at'>
+export type StockTransferFields = Filter.RangeFilters<'closed_short_at' | 'created_at' | 'received_at' | 'shipped_at' | 'updated_at'>
& Filter.IdFilters<'destination_location_id' | 'id' | 'source_location_id'>
+ & Filter.TextFilters<'number' | 'reference'>
& Filter.EnumFilters<'status', 'draft' | 'ready_to_ship' | 'in_transit' | 'partially_received' | 'received' | 'over_received' | 'canceled'>
export type StockTransferItemFields = Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'quantity_received' | 'quantity_rejected' | 'quantity_shipped', number>
& Filter.IdFilters<'id' | 'variant_id'>
+ & Filter.RangeFilters<'quantity_received' | 'quantity_rejected' | 'quantity_shipped', number>
-export type StoreFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type StoreFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type StoreCreditFields = Filter.TextFilters<'currency' | 'memo'>
- & Filter.RangeFilters<'amount', string | number>
+export type StoreCreditFields = Filter.RangeFilters<'amount', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'created_by_id' | 'customer_id' | 'id'>
+ & Filter.TextFilters<'currency' | 'memo'>
export type StoreCreditEventFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
@@ -364,14 +364,14 @@ export type SupplierFields = Filter.TextFilters<'city' | 'contact_name' | 'count
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type TagFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type TagFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type TaxCategoryFields = Filter.TextFilters<'name' | 'tax_code'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type TaxCategoryFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
& Filter.BooleanFilters<'is_default'>
+ & Filter.TextFilters<'name' | 'tax_code'>
export type TaxExemptionCertificateFields = Filter.TextFilters<'certificate_number' | 'reason_code'>
& Filter.RangeFilters<'created_at' | 'expires_at' | 'updated_at'>
@@ -386,32 +386,31 @@ export type TaxLineFields = Filter.TextFilters<'country_code' | 'provider_id' |
& Filter.IdFilters<'id'>
& Filter.BooleanFilters<'included'>
-export type TaxRateFields = Filter.TextFilters<'country_code' | 'name' | 'state_code'>
- & Filter.RangeFilters<'amount', string | number>
+export type TaxRateFields = Filter.RangeFilters<'amount', string | number>
+ & Filter.TextFilters<'country_code' | 'name' | 'state_code'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'tax_category_id'>
& Filter.BooleanFilters<'included_in_price'>
-export type VariantFields = Filter.TextFilters<'cost_currency' | 'country_of_origin' | 'hs_code' | 'sku'>
+export type VariantFields = Filter.IdFilters<'carton_package_type_id' | 'id' | 'product_id'>
& Filter.RangeFilters<'carton_weight' | 'cost_price' | 'depth' | 'height' | 'weight' | 'width', string | number>
- & Filter.RangeFilters<'created_at' | 'deleted_at' | 'discontinue_on' | 'updated_at'>
& Filter.RangeFilters<'cartons_per_pallet' | 'minimum_order_quantity' | 'order_multiple' | 'position' | 'units_per_carton', number>
- & Filter.IdFilters<'carton_package_type_id' | 'id' | 'product_id'>
+ & Filter.TextFilters<'cost_currency' | 'country_of_origin' | 'hs_code' | 'sku'>
+ & Filter.RangeFilters<'created_at' | 'deleted_at' | 'discontinue_on' | 'updated_at'>
& Filter.BooleanFilters<'track_inventory'>
& Filter.EnumFilters<'purchase_unit', 'unit' | 'carton'>
-export type WebhookDeliveryFields = Filter.TextFilters<'event_name'>
- & Filter.RangeFilters<'created_at' | 'delivered_at' | 'updated_at'>
+export type WebhookDeliveryFields = Filter.RangeFilters<'created_at' | 'delivered_at' | 'updated_at'>
+ & Filter.TextFilters<'event_name'>
& Filter.RangeFilters<'execution_time' | 'response_code', number>
& Filter.IdFilters<'id'>
& Filter.BooleanFilters<'success'>
-export type WebhookEndpointFields = Filter.TextFilters<'name' | 'url'>
+export type WebhookEndpointFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name' | 'url'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface AddressFilterExtensions {}
export type AddressFilters = AddressFields
@@ -420,7 +419,6 @@ export type AddressFilters = AddressFields
export type AddressSort = Filter.SortKey<'address1' | 'address2' | 'city' | 'company' | 'country_code' | 'created_at' | 'first_name' | 'id' | 'last_name' | 'phone' | 'postal_code' | 'state_code' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface AdminUserFilterExtensions {}
export type AdminUserFilters = AdminUserFields
@@ -430,7 +428,6 @@ export type AdminUserFilters = AdminUserFields
export type AdminUserSort = Filter.SortKey<'created_at' | 'email' | 'first_name' | 'id' | 'last_name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface AllowedOriginFilterExtensions {}
export type AllowedOriginFilters = AllowedOriginFields
@@ -439,7 +436,6 @@ export type AllowedOriginFilters = AllowedOriginFields
export type AllowedOriginSort = Filter.SortKey<'created_at' | 'id' | 'origin' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ApiKeyFilterExtensions {}
export type ApiKeyFilters = ApiKeyFields
@@ -448,7 +444,6 @@ export type ApiKeyFilters = ApiKeyFields
export type ApiKeySort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CatalogFilterExtensions {}
export type CatalogFilters = CatalogFields
@@ -457,7 +452,6 @@ export type CatalogFilters = CatalogFields
export type CatalogSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CatalogOrderMinimumFilterExtensions {}
export type CatalogOrderMinimumFilters = CatalogOrderMinimumFields
@@ -466,7 +460,6 @@ export type CatalogOrderMinimumFilters = CatalogOrderMinimumFields
export type CatalogOrderMinimumSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CategoryFilterExtensions {}
export type CategoryFilters = CategoryFields
@@ -476,7 +469,6 @@ export type CategoryFilters = CategoryFields
export type CategorySort = Filter.SortKey<'automatic' | 'children_count' | 'created_at' | 'depth' | 'id' | 'name' | 'parent_id' | 'permalink' | 'position' | 'pretty_name' | 'products_count' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ChannelFilterExtensions {}
export type ChannelFilters = ChannelFields
@@ -485,7 +477,6 @@ export type ChannelFilters = ChannelFields
export type ChannelSort = Filter.SortKey<'active' | 'code' | 'created_at' | 'default' | 'id' | 'name' | 'store_id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ClaimReasonFilterExtensions {}
export type ClaimReasonFilters = ClaimReasonFields
@@ -494,7 +485,6 @@ export type ClaimReasonFilters = ClaimReasonFields
export type ClaimReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CollectionFilterExtensions {}
export type CollectionFilters = CollectionFields
@@ -503,7 +493,6 @@ export type CollectionFilters = CollectionFields
export type CollectionSort = Filter.SortKey<'automatic' | 'created_at' | 'id' | 'name' | 'permalink' | 'position' | 'products_count' | 'sort_order' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CommissionLineFilterExtensions {}
export type CommissionLineFilters = CommissionLineFields
@@ -514,7 +503,6 @@ export type CommissionLineFilters = CommissionLineFields
export type CommissionLineSort = Filter.SortKey<'amount' | 'created_at' | 'currency' | 'id' | 'kind' | 'order_id' | 'rate' | 'tax_amount' | 'total' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CommissionRateFilterExtensions {}
export type CommissionRateFilters = CommissionRateFields
@@ -524,7 +512,6 @@ export type CommissionRateFilters = CommissionRateFields
export type CommissionRateSort = Filter.SortKey<'code' | 'created_at' | 'enabled' | 'id' | 'include_shipping' | 'kind' | 'name' | 'position' | 'tax_inclusive' | 'updated_at' | 'value'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CompanyFilterExtensions {}
export type CompanyFilters = CompanyFields
@@ -537,7 +524,6 @@ export type CompanyFilters = CompanyFields
export type CompanySort = Filter.SortKey<'created_at' | 'id' | 'kind' | 'name' | 'parent_id' | 'po_number_required' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CompanyMembershipFilterExtensions {}
export type CompanyMembershipFilters = CompanyMembershipFields
@@ -546,7 +532,6 @@ export type CompanyMembershipFilters = CompanyMembershipFields
export type CompanyMembershipSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CouponCodeFilterExtensions {}
export type CouponCodeFilters = CouponCodeFields
@@ -556,7 +541,6 @@ export type CouponCodeFilters = CouponCodeFields
export type CouponCodeSort = Filter.SortKey<'code' | 'created_at' | 'id' | 'promotion_id' | 'state' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CreditCardFilterExtensions {}
export type CreditCardFilters = CreditCardFields
@@ -565,28 +549,6 @@ export type CreditCardFilters = CreditCardFields
export type CreditCardSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
-export interface CustomFieldFilterExtensions {}
-
-export type CustomFieldFilters = CustomFieldFields
- & Filter.OrFilters
- & CustomFieldFilterExtensions
-
-export type CustomFieldSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
-export interface CustomFieldDefinitionFilterExtensions {}
-
-export type CustomFieldDefinitionFilters = CustomFieldDefinitionFields
- & Filter.OrFilters
- & {
- search?: string
- }
- & CustomFieldDefinitionFilterExtensions
-
-export type CustomFieldDefinitionSort = Filter.SortKey<'created_at' | 'field_type' | 'id' | 'key' | 'label' | 'namespace' | 'resource_type' | 'searchable' | 'sortable' | 'storefront_visible' | 'updated_at'>
-
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CustomerFilterExtensions {}
export type CustomerFilters = CustomerFields
@@ -608,7 +570,6 @@ export type CustomerFilters = CustomerFields
export type CustomerSort = Filter.SortKey<'accepts_email_marketing' | 'created_at' | 'email' | 'first_name' | 'id' | 'last_name' | 'phone' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CustomerGroupFilterExtensions {}
export type CustomerGroupFilters = CustomerGroupFields
@@ -617,7 +578,25 @@ export type CustomerGroupFilters = CustomerGroupFields
export type CustomerGroupSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
+export interface CustomFieldFilterExtensions {}
+
+export type CustomFieldFilters = CustomFieldFields
+ & Filter.OrFilters
+ & CustomFieldFilterExtensions
+
+export type CustomFieldSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
+
+export interface CustomFieldDefinitionFilterExtensions {}
+
+export type CustomFieldDefinitionFilters = CustomFieldDefinitionFields
+ & Filter.OrFilters
+ & {
+ search?: string
+ }
+ & CustomFieldDefinitionFilterExtensions
+
+export type CustomFieldDefinitionSort = Filter.SortKey<'created_at' | 'field_type' | 'id' | 'key' | 'label' | 'namespace' | 'resource_type' | 'searchable' | 'sortable' | 'storefront_visible' | 'updated_at'>
+
export interface DeliveryFilterExtensions {}
export type DeliveryFilters = DeliveryFields
@@ -626,7 +605,6 @@ export type DeliveryFilters = DeliveryFields
export type DeliverySort = Filter.SortKey<'carrier' | 'created_at' | 'id' | 'status' | 'tracking_number' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DeliveryMethodFilterExtensions {}
export type DeliveryMethodFilters = DeliveryMethodFields
@@ -636,7 +614,6 @@ export type DeliveryMethodFilters = DeliveryMethodFields
export type DeliveryMethodSort = Filter.SortKey<'available_to_sellers' | 'created_at' | 'id' | 'name' | 'seller_id' | 'storefront_visible' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DeliveryProfileFilterExtensions {}
export type DeliveryProfileFilters = DeliveryProfileFields
@@ -645,7 +622,6 @@ export type DeliveryProfileFilters = DeliveryProfileFields
export type DeliveryProfileSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DiscountFilterExtensions {}
export type DiscountFilters = DiscountFields
@@ -654,7 +630,6 @@ export type DiscountFilters = DiscountFields
export type DiscountSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface EmailTemplateRevisionFilterExtensions {}
export type EmailTemplateRevisionFilters = EmailTemplateRevisionFields
@@ -663,7 +638,6 @@ export type EmailTemplateRevisionFilters = EmailTemplateRevisionFields
export type EmailTemplateRevisionSort = Filter.SortKey<'created_at' | 'id'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ExportFilterExtensions {}
export type ExportFilters = ExportFields
@@ -673,7 +647,6 @@ export type ExportFilters = ExportFields
export type ExportSort = Filter.SortKey<'created_at' | 'format' | 'id' | 'number' | 'seller_id' | 'type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface FulfillmentFilterExtensions {}
export type FulfillmentFilters = FulfillmentFields
@@ -682,7 +655,6 @@ export type FulfillmentFilters = FulfillmentFields
export type FulfillmentSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface GiftCardFilterExtensions {}
export type GiftCardFilters = GiftCardFields
@@ -701,7 +673,6 @@ export type GiftCardFilters = GiftCardFields
export type GiftCardSort = Filter.SortKey<'code' | 'created_at' | 'created_by_id' | 'currency' | 'customer_id' | 'expires_at' | 'gift_card_batch_id' | 'id' | 'state' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface GiftCardBatchFilterExtensions {}
export type GiftCardBatchFilters = GiftCardBatchFields
@@ -710,7 +681,6 @@ export type GiftCardBatchFilters = GiftCardBatchFields
export type GiftCardBatchSort = Filter.SortKey<'created_at' | 'id' | 'prefix' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ImportFilterExtensions {}
export type ImportFilters = ImportFields
@@ -720,7 +690,6 @@ export type ImportFilters = ImportFields
export type ImportSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'seller_id' | 'status' | 'type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ImportRowFilterExtensions {}
export type ImportRowFilters = ImportRowFields
@@ -729,7 +698,6 @@ export type ImportRowFilters = ImportRowFields
export type ImportRowSort = Filter.SortKey<'created_at' | 'id' | 'row_number' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface IntegrationFilterExtensions {}
export type IntegrationFilters = IntegrationFields
@@ -738,7 +706,6 @@ export type IntegrationFilters = IntegrationFields
export type IntegrationSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface InvitationFilterExtensions {}
export type InvitationFilters = InvitationFields
@@ -747,7 +714,6 @@ export type InvitationFilters = InvitationFields
export type InvitationSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface LineItemFilterExtensions {}
export type LineItemFilters = LineItemFields
@@ -759,7 +725,6 @@ export type LineItemFilters = LineItemFields
export type LineItemSort = Filter.SortKey<'additional_tax_total' | 'adjustment_total' | 'cost_price' | 'created_at' | 'discount_total' | 'id' | 'included_tax_total' | 'non_taxable_adjustment_total' | 'order_id' | 'pre_tax_amount' | 'price' | 'quantity' | 'tax_category_id' | 'taxable_adjustment_total' | 'updated_at' | 'variant_id'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface MarketFilterExtensions {}
export type MarketFilters = MarketFields
@@ -768,7 +733,6 @@ export type MarketFilters = MarketFields
export type MarketSort = Filter.SortKey<'created_at' | 'currency' | 'default_locale' | 'id' | 'name' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface MediaFilterExtensions {}
export type MediaFilters = MediaFields
@@ -782,7 +746,6 @@ export type MediaFilters = MediaFields
export type MediaSort = Filter.SortKey<'alt' | 'created_at' | 'id' | 'media_type' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OptionTypeFilterExtensions {}
export type OptionTypeFilters = OptionTypeFields
@@ -794,7 +757,6 @@ export type OptionTypeFilters = OptionTypeFields
export type OptionTypeSort = Filter.SortKey<'created_at' | 'id' | 'kind' | 'label' | 'name' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OrderFilterExtensions {}
export type OrderFilters = OrderFields
@@ -822,7 +784,6 @@ export type OrderFilters = OrderFields
export type OrderSort = Filter.SortKey<'channel_id' | 'completed_at' | 'considered_risky' | 'coupon_code' | 'created_at' | 'currency' | 'customer_id' | 'delivery_total' | 'email' | 'fulfillment_status' | 'id' | 'item_total' | 'number' | 'order_group_id' | 'payment_state' | 'payment_status' | 'po_number' | 'seller_id' | 'shipment_state' | 'status' | 'total' | 'total_quantity' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OrderCancellationReasonFilterExtensions {}
export type OrderCancellationReasonFilters = OrderCancellationReasonFields
@@ -831,7 +792,6 @@ export type OrderCancellationReasonFilters = OrderCancellationReasonFields
export type OrderCancellationReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OrderRoutingRuleFilterExtensions {}
export type OrderRoutingRuleFilters = OrderRoutingRuleFields
@@ -840,7 +800,6 @@ export type OrderRoutingRuleFilters = OrderRoutingRuleFields
export type OrderRoutingRuleSort = Filter.SortKey<'active' | 'channel_id' | 'created_at' | 'id' | 'position' | 'store_id' | 'type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PackageTypeFilterExtensions {}
export type PackageTypeFilters = PackageTypeFields
@@ -850,7 +809,6 @@ export type PackageTypeFilters = PackageTypeFields
export type PackageTypeSort = Filter.SortKey<'created_at' | 'default' | 'id' | 'kind' | 'name' | 'seller_id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PaymentFilterExtensions {}
export type PaymentFilters = PaymentFields
@@ -861,7 +819,6 @@ export type PaymentFilters = PaymentFields
export type PaymentSort = Filter.SortKey<'amount' | 'avs_response' | 'created_at' | 'cvv_response_code' | 'cvv_response_message' | 'id' | 'response_code' | 'state' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PaymentMethodFilterExtensions {}
export type PaymentMethodFilters = PaymentMethodFields
@@ -870,7 +827,6 @@ export type PaymentMethodFilters = PaymentMethodFields
export type PaymentMethodSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'position' | 'storefront_visible' | 'type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PolicyFilterExtensions {}
export type PolicyFilters = PolicyFields
@@ -879,7 +835,6 @@ export type PolicyFilters = PolicyFields
export type PolicySort = Filter.SortKey<'created_at' | 'id' | 'name' | 'owner_id' | 'owner_type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PriceFilterExtensions {}
export type PriceFilters = PriceFields
@@ -893,7 +848,6 @@ export type PriceFilters = PriceFields
export type PriceSort = Filter.SortKey<'amount' | 'compare_at_amount' | 'created_at' | 'currency' | 'id' | 'min_quantity' | 'price_list_id' | 'updated_at' | 'variant_id'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PriceListFilterExtensions {}
export type PriceListFilters = PriceListFields
@@ -902,7 +856,6 @@ export type PriceListFilters = PriceListFields
export type PriceListSort = Filter.SortKey<'catalog_id' | 'created_at' | 'ends_at' | 'id' | 'match_policy' | 'name' | 'position' | 'starts_at' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ProductFilterExtensions {}
export type ProductFilters = ProductFields
@@ -941,7 +894,6 @@ export type ProductFilters = ProductFields
export type ProductSort = Filter.SortKey<'available_on' | 'best_selling' | 'created_at' | 'description' | 'discontinue_on' | 'id' | 'manual' | 'name' | 'price' | 'seller_id' | 'slug' | 'status' | 'updated_at' | `cf_${string}`>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ProductTypeFilterExtensions {}
export type ProductTypeFilters = ProductTypeFields
@@ -951,7 +903,6 @@ export type ProductTypeFilters = ProductTypeFields
export type ProductTypeSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PromotionFilterExtensions {}
export type PromotionFilters = PromotionFields
@@ -961,7 +912,6 @@ export type PromotionFilters = PromotionFields
export type PromotionSort = Filter.SortKey<'code' | 'created_at' | 'expires_at' | 'id' | 'kind' | 'name' | 'path' | 'promotion_category_id' | 'starts_at' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PromotionActionFilterExtensions {}
export type PromotionActionFilters = PromotionActionFields
@@ -970,7 +920,6 @@ export type PromotionActionFilters = PromotionActionFields
export type PromotionActionSort = Filter.SortKey<'created_at' | 'id' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PromotionRuleFilterExtensions {}
export type PromotionRuleFilters = PromotionRuleFields
@@ -979,7 +928,6 @@ export type PromotionRuleFilters = PromotionRuleFields
export type PromotionRuleSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PurchaseOrderFilterExtensions {}
export type PurchaseOrderFilters = PurchaseOrderFields
@@ -997,7 +945,6 @@ export type PurchaseOrderFilters = PurchaseOrderFields
export type PurchaseOrderSort = Filter.SortKey<'cancel_by' | 'closed_short_at' | 'created_at' | 'currency' | 'destination_location_id' | 'expected_at' | 'id' | 'number' | 'ordered_at' | 'received_at' | 'reference' | 'status' | 'supplier_id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface RefundFilterExtensions {}
export type RefundFilters = RefundFields
@@ -1006,7 +953,6 @@ export type RefundFilters = RefundFields
export type RefundSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface RefundReasonFilterExtensions {}
export type RefundReasonFilters = RefundReasonFields
@@ -1015,7 +961,6 @@ export type RefundReasonFilters = RefundReasonFields
export type RefundReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ReturnReasonFilterExtensions {}
export type ReturnReasonFilters = ReturnReasonFields
@@ -1024,7 +969,6 @@ export type ReturnReasonFilters = ReturnReasonFields
export type ReturnReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface RoleFilterExtensions {}
export type RoleFilters = RoleFields
@@ -1033,7 +977,6 @@ export type RoleFilters = RoleFields
export type RoleSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface SellerFilterExtensions {}
export type SellerFilters = SellerFields
@@ -1042,7 +985,6 @@ export type SellerFilters = SellerFields
export type SellerSort = Filter.SortKey<'contact_email' | 'created_at' | 'id' | 'name' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface SellerRequirementFilterExtensions {}
export type SellerRequirementFilters = SellerRequirementFields
@@ -1051,7 +993,6 @@ export type SellerRequirementFilters = SellerRequirementFields
export type SellerRequirementSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ShippingLabelFilterExtensions {}
export type ShippingLabelFilters = ShippingLabelFields
@@ -1060,7 +1001,6 @@ export type ShippingLabelFilters = ShippingLabelFields
export type ShippingLabelSort = Filter.SortKey<'carrier' | 'created_at' | 'id' | 'source' | 'status' | 'tracking_number' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StockLevelFilterExtensions {}
export type StockLevelFilters = StockLevelFields
@@ -1074,7 +1014,6 @@ export type StockLevelFilters = StockLevelFields
export type StockLevelSort = Filter.SortKey<'allocated_count' | 'count_on_hand' | 'created_at' | 'id' | 'incoming_count' | 'reserved_count' | 'stock_location_id' | 'updated_at' | 'variant_id'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StockLocationFilterExtensions {}
export type StockLocationFilters = StockLocationFields
@@ -1084,7 +1023,6 @@ export type StockLocationFilters = StockLocationFields
export type StockLocationSort = Filter.SortKey<'active' | 'country_code' | 'created_at' | 'default' | 'id' | 'kind' | 'name' | 'pickup_enabled' | 'returns_enabled' | 'seller_id' | 'state_code' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StockMovementFilterExtensions {}
export type StockMovementFilters = StockMovementFields
@@ -1094,7 +1032,6 @@ export type StockMovementFilters = StockMovementFields
export type StockMovementSort = Filter.SortKey<'created_at' | 'exchange_id' | 'fulfillment_id' | 'id' | 'kind' | 'order_id' | 'purchase_order_id' | 'quantity' | 'reason' | 'return_id' | 'stock_item_id' | 'stock_level_id' | 'stock_receipt_id' | 'stock_transfer_id' | 'unit_cost' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StockReceiptFilterExtensions {}
export type StockReceiptFilters = StockReceiptFields
@@ -1103,7 +1040,6 @@ export type StockReceiptFilters = StockReceiptFields
export type StockReceiptSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'receivable_id' | 'receivable_type' | 'received_at' | 'received_by_id' | 'received_by_type' | 'reference' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StockTransferFilterExtensions {}
export type StockTransferFilters = StockTransferFields
@@ -1119,7 +1055,6 @@ export type StockTransferFilters = StockTransferFields
export type StockTransferSort = Filter.SortKey<'closed_short_at' | 'created_at' | 'destination_location_id' | 'id' | 'number' | 'received_at' | 'reference' | 'shipped_at' | 'source_location_id' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StoreCreditFilterExtensions {}
export type StoreCreditFilters = StoreCreditFields
@@ -1134,7 +1069,6 @@ export type StoreCreditFilters = StoreCreditFields
export type StoreCreditSort = Filter.SortKey<'amount' | 'created_at' | 'created_by_id' | 'currency' | 'customer_id' | 'id' | 'memo' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StoreCreditEventFilterExtensions {}
export type StoreCreditEventFilters = StoreCreditEventFields
@@ -1143,7 +1077,6 @@ export type StoreCreditEventFilters = StoreCreditEventFields
export type StoreCreditEventSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface SupplierFilterExtensions {}
export type SupplierFilters = SupplierFields
@@ -1152,7 +1085,6 @@ export type SupplierFilters = SupplierFields
export type SupplierSort = Filter.SortKey<'city' | 'contact_name' | 'country_code' | 'created_at' | 'email' | 'id' | 'name' | 'phone' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface TaxExemptionCertificateFilterExtensions {}
export type TaxExemptionCertificateFilters = TaxExemptionCertificateFields
@@ -1161,7 +1093,6 @@ export type TaxExemptionCertificateFilters = TaxExemptionCertificateFields
export type TaxExemptionCertificateSort = Filter.SortKey<'certificate_number' | 'created_at' | 'expires_at' | 'id' | 'reason_code' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface TaxIdentifierFilterExtensions {}
export type TaxIdentifierFilters = TaxIdentifierFields
@@ -1170,7 +1101,6 @@ export type TaxIdentifierFilters = TaxIdentifierFields
export type TaxIdentifierSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface TaxLineFilterExtensions {}
export type TaxLineFilters = TaxLineFields
@@ -1179,7 +1109,6 @@ export type TaxLineFilters = TaxLineFields
export type TaxLineSort = Filter.SortKey<'country_code' | 'created_at' | 'id' | 'included' | 'provider_id' | 'state_code' | 'taxability_reason' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface TaxRateFilterExtensions {}
export type TaxRateFilters = TaxRateFields
@@ -1188,7 +1117,6 @@ export type TaxRateFilters = TaxRateFields
export type TaxRateSort = Filter.SortKey<'amount' | 'country_code' | 'created_at' | 'id' | 'included_in_price' | 'name' | 'state_code' | 'tax_category_id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface VariantFilterExtensions {}
export type VariantFilters = VariantFields
@@ -1208,7 +1136,6 @@ export type VariantFilters = VariantFields
export type VariantSort = Filter.SortKey<'carton_package_type_id' | 'carton_weight' | 'cartons_per_pallet' | 'cost_currency' | 'cost_price' | 'country_of_origin' | 'created_at' | 'deleted_at' | 'depth' | 'discontinue_on' | 'height' | 'hs_code' | 'id' | 'minimum_order_quantity' | 'order_multiple' | 'position' | 'product_id' | 'purchase_unit' | 'sku' | 'track_inventory' | 'units_per_carton' | 'updated_at' | 'weight' | 'width'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface WebhookDeliveryFilterExtensions {}
export type WebhookDeliveryFilters = WebhookDeliveryFields
@@ -1217,7 +1144,6 @@ export type WebhookDeliveryFilters = WebhookDeliveryFields
export type WebhookDeliverySort = Filter.SortKey<'created_at' | 'delivered_at' | 'event_name' | 'execution_time' | 'id' | 'response_code' | 'success' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface WebhookEndpointFilterExtensions {}
export type WebhookEndpointFilters = WebhookEndpointFields
diff --git a/packages/sdk-core/scripts/generate-filters.ts b/packages/sdk-core/scripts/generate-filters.ts
index bbb121c69f..83736a0c2c 100644
--- a/packages/sdk-core/scripts/generate-filters.ts
+++ b/packages/sdk-core/scripts/generate-filters.ts
@@ -77,23 +77,26 @@ const MAX_DEPTH = 2
const HEADER =
'// This file is auto-generated from the filter tables in docs/api-reference by `pnpm generate:filters`. Do not edit directly.\n'
-const VALUE_TYPES: Record<Kind, string> = {
- text: 'string',
- decimal: 'string | number',
- integer: 'number',
- date: 'string',
- datetime: 'string',
- enum: 'string',
- id: 'string',
- type: 'string',
- boolean: 'boolean',
+// Each kind's TypeScript value and the sdk-core building block typing its
+// predicates. Enum attributes carry their values and use `EnumFilters`.
+const KIND_TYPES: Record<Exclude<Kind, 'enum'>, { value: string; block: string }> = {
+ text: { value: 'string', block: 'TextFilters<$names>' },
+ decimal: { value: 'string | number', block: 'RangeFilters<$names, string | number>' },
+ integer: { value: 'number', block: 'RangeFilters<$names, number>' },
+ date: { value: 'string', block: 'RangeFilters<$names>' },
+ datetime: { value: 'string', block: 'RangeFilters<$names>' },
+ id: { value: 'string', block: 'IdFilters<$names>' },
+ type: { value: 'string', block: 'IdFilters<$names>' },
+ boolean: { value: 'boolean', block: 'BooleanFilters<$names>' },
}
+const valueType = (kind: Kind) => (kind === 'enum' ? 'string' : KIND_TYPES[kind].value)
+
const literal = (value: string) => `'${value.replace(/'/g, "\\'")}'`
const union = (values: string[]) => values.map(literal).join(' | ')
function fieldsType(table: FilterTable): string {
- const byKind = new Map<string, string[]>()
+ const byBlock = new Map<string, string[]>()
const enums: string[] = []
for (const [attribute, kind] of Object.entries(table.attributes)) {
@@ -101,30 +104,22 @@ function fieldsType(table: FilterTable): string {
enums.push(`Filter.EnumFilters<${literal(attribute)}, ${union(kind.enum)}>`)
continue
}
- byKind.set(kind, [...(byKind.get(kind) ?? []), attribute])
- }
-
- const parts: string[] = []
- const group = (kinds: Kind[]) => kinds.flatMap((kind) => byKind.get(kind) ?? [])
- const add = (attributes: string[], build: (names: string) => string) => {
- if (attributes.length) parts.push(build(union(attributes)))
+ const block = KIND_TYPES[kind as Exclude<Kind, 'enum'>].block
+ byBlock.set(block, [...(byBlock.get(block) ?? []), attribute])
}
- add(group(['text']), (names) => `Filter.TextFilters<${names}>`)
- add(group(['decimal']), (names) => `Filter.RangeFilters<${names}, string | number>`)
- add(group(['date', 'datetime']), (names) => `Filter.RangeFilters<${names}>`)
- add(group(['integer']), (names) => `Filter.RangeFilters<${names}, number>`)
- add(group(['id', 'type', 'enum']), (names) => `Filter.IdFilters<${names}>`)
- add(group(['boolean']), (names) => `Filter.BooleanFilters<${names}>`)
+ const parts = [...byBlock].map(
+ ([block, names]) => `Filter.${block.replace('$names', union(names))}`,
+ )
parts.push(...enums)
return parts.length ? parts.join('\n & ') : 'Record<never, never>'
}
function scopeValueType(type: ScopeType): string {
- if (Array.isArray(type)) return `[${type.map((kind) => VALUE_TYPES[kind]).join(', ')}]`
- if (typeof type === 'object') return `${VALUE_TYPES[type.list]} | ${VALUE_TYPES[type.list]}[]`
- return VALUE_TYPES[type]
+ if (Array.isArray(type)) return `[${type.map(valueType).join(', ')}]`
+ if (typeof type === 'object') return `${valueType(type.list)} | ${valueType(type.list)}[]`
+ return valueType(type)
}
function scopesType(table: FilterTable): string | null {
@@ -151,7 +146,7 @@ function associationsType(
function render(spec: Spec): string {
checkPredicates(spec.components?.['x-spree-filter-predicates'])
const tables = spec.components?.['x-spree-filter-tables'] ?? {}
- const roots = new Map<string, EndpointFilters>()
+ const roots = new Map<string, Omit<EndpointFilters, 'table'>>()
// Endpoints listing the same records share one type; their sort fields and
// custom-field support combine.
@@ -161,7 +156,6 @@ function render(spec: Spec): string {
const known = roots.get(filters.table)
roots.set(filters.table, {
- table: filters.table,
sortable: [...new Set([...(known?.sortable ?? []), ...filters.sortable])].sort(),
custom_fields: Boolean(known?.custom_fields || filters.custom_fields),
})
@@ -173,8 +167,7 @@ function render(spec: Spec): string {
out.push(`export type ${name}Fields = ${fieldsType(tables[name])}`, '')
}
- for (const name of [...roots.keys()].sort()) {
- const endpoint = roots.get(name) as EndpointFilters
+ for (const [name, endpoint] of [...roots].sort(([a], [b]) => a.localeCompare(b))) {
const table = tables[name]
const parts = [`${name}Fields`, ...associationsType(tables, table, 0), 'Filter.OrFilters']
const scopes = scopesType(table)
@@ -188,7 +181,6 @@ function render(spec: Spec): string {
// Filters an app adds through its own extensions, which the published
// types cannot know about: `declare module` the SDK and add them here.
- out.push(`// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging`)
out.push(`export interface ${name}FilterExtensions {}`, '')
parts.push(`${name}FilterExtensions`)
out.push(`export type ${name}Filters = ${parts.join('\n & ')}`, '')
diff --git a/packages/sdk/src/types/filters.generated.ts b/packages/sdk/src/types/filters.generated.ts
index ef92b6d264..0ef222b9a7 100644
--- a/packages/sdk/src/types/filters.generated.ts
+++ b/packages/sdk/src/types/filters.generated.ts
@@ -6,81 +6,80 @@ export type AddressFields = Filter.TextFilters<'address1' | 'address2' | 'city'
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type CategoryFields = Filter.TextFilters<'name' | 'permalink' | 'pretty_name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type CategoryFields = Filter.BooleanFilters<'automatic'>
& Filter.RangeFilters<'children_count' | 'depth' | 'position' | 'products_count', number>
+ & Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'parent_id'>
- & Filter.BooleanFilters<'automatic'>
+ & Filter.TextFilters<'name' | 'permalink' | 'pretty_name'>
-export type CollectionFields = Filter.TextFilters<'name' | 'permalink'>
+export type CollectionFields = Filter.BooleanFilters<'automatic'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position' | 'products_count', number>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'automatic'>
+ & Filter.TextFilters<'name' | 'permalink'>
+ & Filter.RangeFilters<'position' | 'products_count', number>
& Filter.EnumFilters<'sort_order', 'manual' | 'best_selling' | 'price asc' | 'price desc' | 'available_on desc' | 'available_on asc' | 'name asc' | 'name desc'>
export type CompanyMembershipFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-export type CreditCardFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type CreditCardFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type DataRequestFields = Filter.TextFilters<'email' | 'number'>
- & Filter.RangeFilters<'completed_at' | 'created_at' | 'requested_at' | 'updated_at'>
+export type DataRequestFields = Filter.RangeFilters<'completed_at' | 'created_at' | 'requested_at' | 'updated_at'>
+ & Filter.TextFilters<'email' | 'number'>
& Filter.IdFilters<'id'>
& Filter.EnumFilters<'kind', 'access' | 'erasure'>
& Filter.EnumFilters<'status', 'pending' | 'processing' | 'completed' | 'failed'>
-export type DeliveryMethodFields = Filter.TextFilters<'name'>
+export type DeliveryMethodFields = Filter.BooleanFilters<'available_to_sellers' | 'storefront_visible'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id'>
- & Filter.BooleanFilters<'available_to_sellers' | 'storefront_visible'>
+ & Filter.TextFilters<'name'>
export type GiftCardFields = Filter.TextFilters<'code' | 'currency'>
- & Filter.RangeFilters<'expires_at' | 'created_at' | 'updated_at'>
+ & Filter.RangeFilters<'created_at' | 'expires_at' | 'updated_at'>
& Filter.IdFilters<'created_by_id' | 'customer_id' | 'gift_card_batch_id' | 'id'>
& Filter.EnumFilters<'state', 'active' | 'partially_redeemed' | 'redeemed' | 'canceled'>
& Filter.EnumFilters<'status', 'active' | 'partially_redeemed' | 'redeemed' | 'canceled'>
-export type OrderFields = Filter.TextFilters<'currency' | 'number' | 'po_number'>
- & Filter.RangeFilters<'delivery_total' | 'item_total' | 'total', string | number>
+export type OrderFields = Filter.IdFilters<'channel_id' | 'customer_id' | 'id' | 'order_group_id' | 'seller_id'>
& Filter.RangeFilters<'completed_at' | 'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'number' | 'po_number'>
+ & Filter.RangeFilters<'delivery_total' | 'item_total' | 'total', string | number>
& Filter.RangeFilters<'total_quantity', number>
- & Filter.IdFilters<'channel_id' | 'customer_id' | 'id' | 'order_group_id' | 'seller_id'>
& Filter.EnumFilters<'fulfillment_status', 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped'>
& Filter.EnumFilters<'payment_state', 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | 'balance_due' | 'credit_owed' | 'failed' | 'void'>
& Filter.EnumFilters<'payment_status', 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | 'balance_due' | 'credit_owed' | 'failed' | 'void'>
& Filter.EnumFilters<'shipment_state', 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped'>
& Filter.EnumFilters<'status', 'draft' | 'placed' | 'canceled'>
-export type PolicyFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type PolicyFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'owner_id' | 'owner_type'>
+ & Filter.TextFilters<'name'>
-export type ProductFields = Filter.TextFilters<'description' | 'name' | 'slug'>
- & Filter.RangeFilters<'available_on' | 'created_at' | 'discontinue_on' | 'updated_at'>
+export type ProductFields = Filter.RangeFilters<'available_on' | 'created_at' | 'discontinue_on' | 'updated_at'>
+ & Filter.TextFilters<'description' | 'name' | 'slug'>
& Filter.IdFilters<'id' | 'seller_id'>
& Filter.EnumFilters<'status', 'draft' | 'active' | 'archived' | 'proposed' | 'rejected'>
-export type SellerFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type SellerFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type StoreCreditFields = Filter.TextFilters<'currency'>
- & Filter.RangeFilters<'amount', string | number>
+export type StoreCreditFields = Filter.RangeFilters<'amount', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency'>
& Filter.IdFilters<'customer_id' | 'id'>
-export type TagFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type TagFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type WishlistFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type WishlistFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface AddressFilterExtensions {}
export type AddressFilters = AddressFields
@@ -89,7 +88,6 @@ export type AddressFilters = AddressFields
export type AddressSort = Filter.SortKey<'address1' | 'address2' | 'city' | 'company' | 'country_code' | 'created_at' | 'first_name' | 'id' | 'last_name' | 'phone' | 'postal_code' | 'state_code' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CategoryFilterExtensions {}
export type CategoryFilters = CategoryFields
@@ -98,7 +96,6 @@ export type CategoryFilters = CategoryFields
export type CategorySort = Filter.SortKey<'automatic' | 'children_count' | 'created_at' | 'depth' | 'id' | 'name' | 'parent_id' | 'permalink' | 'position' | 'pretty_name' | 'products_count' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CollectionFilterExtensions {}
export type CollectionFilters = CollectionFields
@@ -107,7 +104,6 @@ export type CollectionFilters = CollectionFields
export type CollectionSort = Filter.SortKey<'automatic' | 'created_at' | 'id' | 'name' | 'permalink' | 'position' | 'products_count' | 'sort_order' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CompanyMembershipFilterExtensions {}
export type CompanyMembershipFilters = CompanyMembershipFields
@@ -116,7 +112,6 @@ export type CompanyMembershipFilters = CompanyMembershipFields
export type CompanyMembershipSort = Filter.SortKey<'created_at' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface CreditCardFilterExtensions {}
export type CreditCardFilters = CreditCardFields
@@ -125,7 +120,6 @@ export type CreditCardFilters = CreditCardFields
export type CreditCardSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DataRequestFilterExtensions {}
export type DataRequestFilters = DataRequestFields
@@ -139,7 +133,6 @@ export type DataRequestFilters = DataRequestFields
export type DataRequestSort = Filter.SortKey<'completed_at' | 'created_at' | 'email' | 'id' | 'kind' | 'number' | 'requested_at' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DeliveryMethodFilterExtensions {}
export type DeliveryMethodFilters = DeliveryMethodFields
@@ -148,7 +141,6 @@ export type DeliveryMethodFilters = DeliveryMethodFields
export type DeliveryMethodSort = Filter.SortKey<'available_to_sellers' | 'created_at' | 'id' | 'name' | 'seller_id' | 'storefront_visible' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface GiftCardFilterExtensions {}
export type GiftCardFilters = GiftCardFields
@@ -163,7 +155,6 @@ export type GiftCardFilters = GiftCardFields
export type GiftCardSort = Filter.SortKey<'code' | 'created_at' | 'created_by_id' | 'currency' | 'customer_id' | 'expires_at' | 'gift_card_batch_id' | 'id' | 'state' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OrderFilterExtensions {}
export type OrderFilters = OrderFields
@@ -178,7 +169,6 @@ export type OrderFilters = OrderFields
export type OrderSort = Filter.SortKey<'channel_id' | 'completed_at' | 'created_at' | 'currency' | 'customer_id' | 'delivery_total' | 'fulfillment_status' | 'id' | 'item_total' | 'number' | 'order_group_id' | 'payment_state' | 'payment_status' | 'po_number' | 'seller_id' | 'shipment_state' | 'status' | 'total' | 'total_quantity' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PolicyFilterExtensions {}
export type PolicyFilters = PolicyFields
@@ -187,7 +177,6 @@ export type PolicyFilters = PolicyFields
export type PolicySort = Filter.SortKey<'created_at' | 'id' | 'name' | 'owner_id' | 'owner_type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ProductFilterExtensions {}
export type ProductFilters = ProductFields
@@ -217,7 +206,6 @@ export type ProductFilters = ProductFields
export type ProductSort = Filter.SortKey<'available_on' | 'best_selling' | 'created_at' | 'description' | 'discontinue_on' | 'id' | 'manual' | 'name' | 'price' | 'seller_id' | 'slug' | 'status' | 'updated_at' | `cf_${string}`>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface SellerFilterExtensions {}
export type SellerFilters = SellerFields
@@ -226,7 +214,6 @@ export type SellerFilters = SellerFields
export type SellerSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StoreCreditFilterExtensions {}
export type StoreCreditFilters = StoreCreditFields
@@ -239,7 +226,6 @@ export type StoreCreditFilters = StoreCreditFields
export type StoreCreditSort = Filter.SortKey<'amount' | 'created_at' | 'currency' | 'customer_id' | 'id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface WishlistFilterExtensions {}
export type WishlistFilters = WishlistFields
diff --git a/packages/seller-sdk/src/types/filters.generated.ts b/packages/seller-sdk/src/types/filters.generated.ts
index 97ee32b164..54d8023a1f 100644
--- a/packages/seller-sdk/src/types/filters.generated.ts
+++ b/packages/seller-sdk/src/types/filters.generated.ts
@@ -2,106 +2,105 @@
import type * as Filter from '@spree/sdk-core'
-export type ClaimFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ClaimFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'number'>
& Filter.EnumFilters<'status', 'open' | 'approved' | 'resolved' | 'denied' | 'canceled'>
-export type ClaimReasonFields = Filter.TextFilters<'name'>
+export type ClaimReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type DeliveryMethodFields = Filter.TextFilters<'name'>
+export type DeliveryMethodFields = Filter.BooleanFilters<'available_to_sellers' | 'storefront_visible'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id'>
- & Filter.BooleanFilters<'available_to_sellers' | 'storefront_visible'>
+ & Filter.TextFilters<'name'>
-export type DeliveryProfileFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.RangeFilters<'position', number>
+export type DeliveryProfileFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
+ & Filter.RangeFilters<'position', number>
-export type DeliveryZoneFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type DeliveryZoneFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'delivery_profile_id' | 'id'>
+ & Filter.TextFilters<'name'>
-export type ExchangeFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ExchangeFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'number'>
& Filter.EnumFilters<'status', 'requested' | 'approved' | 'received' | 'fulfilled' | 'canceled'>
-export type FulfillmentFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type FulfillmentFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'number'>
-export type OrderFields = Filter.TextFilters<'currency' | 'number' | 'po_number'>
- & Filter.RangeFilters<'delivery_total' | 'item_total' | 'total', string | number>
+export type OrderFields = Filter.IdFilters<'channel_id' | 'customer_id' | 'id' | 'order_group_id' | 'seller_id'>
& Filter.RangeFilters<'completed_at' | 'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'number' | 'po_number'>
+ & Filter.RangeFilters<'delivery_total' | 'item_total' | 'total', string | number>
& Filter.RangeFilters<'total_quantity', number>
- & Filter.IdFilters<'channel_id' | 'customer_id' | 'id' | 'order_group_id' | 'seller_id'>
& Filter.EnumFilters<'fulfillment_status', 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped'>
& Filter.EnumFilters<'payment_state', 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | 'balance_due' | 'credit_owed' | 'failed' | 'void'>
& Filter.EnumFilters<'payment_status', 'none' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'overcharged' | 'voided' | 'balance_due' | 'credit_owed' | 'failed' | 'void'>
& Filter.EnumFilters<'shipment_state', 'backorder' | 'canceled' | 'partial' | 'unfulfilled' | 'fulfilled' | 'delivered' | 'pending' | 'ready' | 'shipped'>
& Filter.EnumFilters<'status', 'draft' | 'placed' | 'canceled'>
-export type OrderCancellationReasonFields = Filter.TextFilters<'name'>
+export type OrderCancellationReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type PackageTypeFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
- & Filter.IdFilters<'id' | 'seller_id'>
+export type PackageTypeFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.BooleanFilters<'default'>
+ & Filter.IdFilters<'id' | 'seller_id'>
+ & Filter.TextFilters<'name'>
& Filter.EnumFilters<'kind', 'box' | 'envelope' | 'carton' | 'pallet' | 'container'>
-export type PolicyFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type PolicyFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'owner_id' | 'owner_type'>
+ & Filter.TextFilters<'name'>
-export type ProductFields = Filter.TextFilters<'description' | 'name' | 'slug'>
- & Filter.RangeFilters<'available_on' | 'created_at' | 'discontinue_on' | 'updated_at'>
+export type ProductFields = Filter.RangeFilters<'available_on' | 'created_at' | 'discontinue_on' | 'updated_at'>
+ & Filter.TextFilters<'description' | 'name' | 'slug'>
& Filter.IdFilters<'id' | 'seller_id'>
& Filter.EnumFilters<'status', 'draft' | 'active' | 'archived' | 'proposed' | 'rejected'>
-export type ProductTypeFields = Filter.TextFilters<'name'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ProductTypeFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'name'>
-export type ReturnFields = Filter.TextFilters<'number'>
- & Filter.RangeFilters<'created_at' | 'updated_at'>
+export type ReturnFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
+ & Filter.TextFilters<'number'>
& Filter.EnumFilters<'status', 'requested' | 'approved' | 'received' | 'refunded' | 'canceled'>
-export type ReturnReasonFields = Filter.TextFilters<'name'>
+export type ReturnReasonFields = Filter.BooleanFilters<'active'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
- & Filter.BooleanFilters<'active'>
+ & Filter.TextFilters<'name'>
-export type SellerPayoutFields = Filter.TextFilters<'currency' | 'provider' | 'reference'>
- & Filter.RangeFilters<'amount', string | number>
+export type SellerPayoutFields = Filter.RangeFilters<'amount', string | number>
& Filter.RangeFilters<'created_at' | 'period_end' | 'period_start' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'provider' | 'reference'>
& Filter.IdFilters<'id' | 'seller_id'>
& Filter.EnumFilters<'status', 'pending' | 'processing' | 'completed' | 'failed' | 'unresolved'>
-export type SellerTransferFields = Filter.TextFilters<'currency' | 'provider' | 'reference'>
- & Filter.RangeFilters<'amount', string | number>
+export type SellerTransferFields = Filter.RangeFilters<'amount', string | number>
& Filter.RangeFilters<'created_at' | 'updated_at'>
+ & Filter.TextFilters<'currency' | 'provider' | 'reference'>
& Filter.IdFilters<'id' | 'order_id' | 'payout_id' | 'seller_id'>
& Filter.EnumFilters<'kind', 'earning' | 'refund_reversal'>
& Filter.EnumFilters<'status', 'pending' | 'processing' | 'completed' | 'failed' | 'unresolved'>
-export type StockLocationFields = Filter.TextFilters<'country_code' | 'kind' | 'name' | 'state_code'>
+export type StockLocationFields = Filter.BooleanFilters<'active' | 'default' | 'pickup_enabled' | 'returns_enabled'>
+ & Filter.TextFilters<'country_code' | 'kind' | 'name' | 'state_code'>
& Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id' | 'seller_id'>
- & Filter.BooleanFilters<'active' | 'default' | 'pickup_enabled' | 'returns_enabled'>
export type TaxIdentifierFields = Filter.RangeFilters<'created_at' | 'updated_at'>
& Filter.IdFilters<'id'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ClaimFilterExtensions {}
export type ClaimFilters = ClaimFields
@@ -110,7 +109,6 @@ export type ClaimFilters = ClaimFields
export type ClaimSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ClaimReasonFilterExtensions {}
export type ClaimReasonFilters = ClaimReasonFields
@@ -119,7 +117,6 @@ export type ClaimReasonFilters = ClaimReasonFields
export type ClaimReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DeliveryMethodFilterExtensions {}
export type DeliveryMethodFilters = DeliveryMethodFields
@@ -128,7 +125,6 @@ export type DeliveryMethodFilters = DeliveryMethodFields
export type DeliveryMethodSort = Filter.SortKey<'available_to_sellers' | 'created_at' | 'id' | 'name' | 'seller_id' | 'storefront_visible' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DeliveryProfileFilterExtensions {}
export type DeliveryProfileFilters = DeliveryProfileFields
@@ -137,7 +133,6 @@ export type DeliveryProfileFilters = DeliveryProfileFields
export type DeliveryProfileSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'position' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface DeliveryZoneFilterExtensions {}
export type DeliveryZoneFilters = DeliveryZoneFields
@@ -146,7 +141,6 @@ export type DeliveryZoneFilters = DeliveryZoneFields
export type DeliveryZoneSort = Filter.SortKey<'created_at' | 'delivery_profile_id' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ExchangeFilterExtensions {}
export type ExchangeFilters = ExchangeFields
@@ -155,7 +149,6 @@ export type ExchangeFilters = ExchangeFields
export type ExchangeSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface FulfillmentFilterExtensions {}
export type FulfillmentFilters = FulfillmentFields
@@ -164,7 +157,6 @@ export type FulfillmentFilters = FulfillmentFields
export type FulfillmentSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OrderFilterExtensions {}
export type OrderFilters = OrderFields
@@ -179,7 +171,6 @@ export type OrderFilters = OrderFields
export type OrderSort = Filter.SortKey<'channel_id' | 'completed_at' | 'created_at' | 'currency' | 'customer_id' | 'delivery_total' | 'fulfillment_status' | 'id' | 'item_total' | 'number' | 'order_group_id' | 'payment_state' | 'payment_status' | 'po_number' | 'seller_id' | 'shipment_state' | 'status' | 'total' | 'total_quantity' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface OrderCancellationReasonFilterExtensions {}
export type OrderCancellationReasonFilters = OrderCancellationReasonFields
@@ -188,7 +179,6 @@ export type OrderCancellationReasonFilters = OrderCancellationReasonFields
export type OrderCancellationReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PackageTypeFilterExtensions {}
export type PackageTypeFilters = PackageTypeFields
@@ -197,7 +187,6 @@ export type PackageTypeFilters = PackageTypeFields
export type PackageTypeSort = Filter.SortKey<'created_at' | 'default' | 'id' | 'kind' | 'name' | 'seller_id' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface PolicyFilterExtensions {}
export type PolicyFilters = PolicyFields
@@ -206,7 +195,6 @@ export type PolicyFilters = PolicyFields
export type PolicySort = Filter.SortKey<'created_at' | 'id' | 'name' | 'owner_id' | 'owner_type' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ProductFilterExtensions {}
export type ProductFilters = ProductFields
@@ -232,7 +220,6 @@ export type ProductFilters = ProductFields
export type ProductSort = Filter.SortKey<'available_on' | 'created_at' | 'description' | 'discontinue_on' | 'id' | 'name' | 'seller_id' | 'slug' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ProductTypeFilterExtensions {}
export type ProductTypeFilters = ProductTypeFields
@@ -241,7 +228,6 @@ export type ProductTypeFilters = ProductTypeFields
export type ProductTypeSort = Filter.SortKey<'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ReturnFilterExtensions {}
export type ReturnFilters = ReturnFields
@@ -250,7 +236,6 @@ export type ReturnFilters = ReturnFields
export type ReturnSort = Filter.SortKey<'created_at' | 'id' | 'number' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface ReturnReasonFilterExtensions {}
export type ReturnReasonFilters = ReturnReasonFields
@@ -259,7 +244,6 @@ export type ReturnReasonFilters = ReturnReasonFields
export type ReturnReasonSort = Filter.SortKey<'active' | 'created_at' | 'id' | 'name' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface SellerPayoutFilterExtensions {}
export type SellerPayoutFilters = SellerPayoutFields
@@ -268,7 +252,6 @@ export type SellerPayoutFilters = SellerPayoutFields
export type SellerPayoutSort = Filter.SortKey<'amount' | 'created_at' | 'currency' | 'id' | 'period_end' | 'period_start' | 'provider' | 'reference' | 'seller_id' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface SellerTransferFilterExtensions {}
export type SellerTransferFilters = SellerTransferFields
@@ -277,7 +260,6 @@ export type SellerTransferFilters = SellerTransferFields
export type SellerTransferSort = Filter.SortKey<'amount' | 'created_at' | 'currency' | 'id' | 'kind' | 'order_id' | 'payout_id' | 'provider' | 'reference' | 'seller_id' | 'status' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface StockLocationFilterExtensions {}
export type StockLocationFilters = StockLocationFields
@@ -286,7 +268,6 @@ export type StockLocationFilters = StockLocationFields
export type StockLocationSort = Filter.SortKey<'active' | 'country_code' | 'created_at' | 'default' | 'id' | 'kind' | 'name' | 'pickup_enabled' | 'returns_enabled' | 'seller_id' | 'state_code' | 'updated_at'>
-// biome-ignore lint/suspicious/noEmptyInterface: filled by declaration merging
export interface TaxIdentifierFilterExtensions {}
export type TaxIdentifierFilters = TaxIdentifierFields
diff --git a/spree/api/app/controllers/spree/api/v3/admin/custom_field_definitions_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/custom_field_definitions_controller.rb
index c95f367c49..788d56f7c0 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/custom_field_definitions_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/custom_field_definitions_controller.rb
@@ -39,16 +39,6 @@ module Spree
:searchable, :sortable)
end
- # `resource_type` is a plain column rather than a polymorphic
- # association, so its filter goes through the model's own normalizer.
- def api_type_resolver(attribute)
- case attribute
- when 'resource_type' then ->(api_type) { model_class.normalize_value_for(:resource_type, api_type) }
- when 'field_type' then ->(api_type) { Spree::CustomField::TYPE_TOKENS[api_type] }
- else super
- end
- end
-
# Pure registry discovery — maps to the read scope.
def read_actions
super + %w[resource_types]
diff --git a/spree/api/app/controllers/spree/api/v3/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/resource_controller.rb
index 62a7d12081..4ed5265c38 100644
--- a/spree/api/app/controllers/spree/api/v3/resource_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/resource_controller.rb
@@ -401,13 +401,9 @@ module Spree
# @param attribute [String, nil] a `*type` column of {#model_class}
# @return [Proc, nil] shorthand → stored class name
def api_type_resolver(attribute)
- return if attribute.nil? || !model_class.respond_to?(:api_type_registry)
+ return if attribute.nil? || !model_class.respond_to?(:api_type_resolver)
- if attribute == model_class.inheritance_column && model_class.api_type_registry.any?
- ->(api_type) { model_class.class_name_for_api_type(api_type) }
- elsif model_class.reflect_on_all_associations(:belongs_to).any? { |reflection| reflection.polymorphic? && reflection.foreign_type == attribute }
- ->(api_type) { Spree::Base.polymorphic_type_for(api_type) }
- end
+ model_class.api_type_resolver(attribute)
end
# Matches both prefixed-FK predicates (`product_id_in`, `tax_category_id_eq`)
diff --git a/spree/api/app/services/spree/api/v3/filter_predicates.rb b/spree/api/app/services/spree/api/v3/filter_predicates.rb
index 83ef6999d2..fa2dac3600 100644
--- a/spree/api/app/services/spree/api/v3/filter_predicates.rb
+++ b/spree/api/app/services/spree/api/v3/filter_predicates.rb
@@ -8,6 +8,7 @@ module Spree
EQUALITY = %w[eq not_eq in not_in].freeze
NULLITY = %w[null not_null].freeze
RANGE = (EQUALITY + %w[lt lteq gt gteq] + NULLITY).freeze
+ IDENTITY = (EQUALITY + NULLITY).freeze
BY_KIND = {
'text' => (EQUALITY + %w[cont i_cont not_cont start end] + NULLITY + %w[present blank]).freeze,
@@ -15,26 +16,13 @@ module Spree
'integer' => RANGE,
'date' => RANGE,
'datetime' => RANGE,
- 'enum' => (EQUALITY + NULLITY).freeze,
- 'id' => (EQUALITY + NULLITY).freeze,
- 'type' => (EQUALITY + NULLITY).freeze,
+ 'enum' => IDENTITY,
+ 'id' => IDENTITY,
+ 'type' => IDENTITY,
'boolean' => (EQUALITY + %w[true false null]).freeze
}.freeze
KINDS = BY_KIND.keys.freeze
-
- # Predicates that take a list of values rather than one.
- LIST = %w[in not_in].freeze
-
- # Predicates whose value is a flag rather than a value of the
- # attribute's kind (`q[deleted_at_null]=true`).
- FLAG = %w[null not_null present blank true false].freeze
-
- # @param kind [String] a value kind from {KINDS}
- # @return [Array<String>]
- def self.for(kind)
- BY_KIND.fetch(kind.to_s)
- end
end
end
end
diff --git a/spree/api/app/services/spree/api/v3/filter_table.rb b/spree/api/app/services/spree/api/v3/filter_table.rb
index b6001c5853..b18f5c8bb7 100644
--- a/spree/api/app/services/spree/api/v3/filter_table.rb
+++ b/spree/api/app/services/spree/api/v3/filter_table.rb
@@ -83,10 +83,7 @@ module Spree
# @return [Hash{String => String, Hash}] attribute => value kind, or
# `{ 'enum' => [values] }` for a status
def attributes
- @attributes ||= ransackable_attribute_names.each_with_object({}) do |attribute, kinds|
- kind = attribute_kind(attribute)
- kinds[attribute] = kind unless kind.nil?
- end
+ @attributes ||= kinds.reject { |_, kind| kind == :unclassified }.compact
end
# Declared attributes whose value kind could not be determined; a
@@ -94,7 +91,7 @@ module Spree
#
# @return [Array<String>]
def unclassified_attributes
- ransackable_attribute_names.select { |attribute| attribute_kind(attribute) == :unclassified }
+ kinds.select { |_, kind| kind == :unclassified }.keys
end
# @return [Hash{String => FilterTable}]
@@ -144,7 +141,7 @@ module Spree
# @return [Hash]
def to_h
{
- 'attributes' => attributes.sort.to_h,
+ 'attributes' => attributes,
'associations' => associations.transform_values(&:name),
'scopes' => scopes
}
@@ -152,8 +149,8 @@ module Spree
private
- def ransackable_attribute_names
- @ransackable_attribute_names ||= model.ransackable_attributes(audience).map(&:to_s).uniq.sort
+ def kinds
+ @kinds ||= model.ransackable_attributes(audience).map(&:to_s).uniq.sort.index_with { |attribute| attribute_kind(attribute) }
end
# @return [String, Hash, Symbol, nil] the kind; nil for a default
@@ -196,12 +193,8 @@ module Spree
model.reflect_on_all_associations(:belongs_to).any? { |reflection| reflection.foreign_key.to_s == attribute }
end
- # The STI column of a typed family and polymorphic `*_type` columns
- # carry short names on the wire (see ResourceController#decode_api_type_predicates).
def type_attribute?(attribute)
- return true if attribute == model.inheritance_column && model.respond_to?(:api_type_registry) && model.api_type_registry.any?
-
- model.reflect_on_all_associations(:belongs_to).any? { |reflection| reflection.polymorphic? && reflection.foreign_type.to_s == attribute }
+ model.respond_to?(:api_type_resolver) && model.api_type_resolver(attribute).present?
end
def translated_attribute?(attribute)
@@ -267,7 +260,7 @@ module Spree
# @return [Hash{String => FilterTable}] the tables this endpoint's
# filters reach, keyed by name
def tables
- table.reachable.sort.to_h
+ table.reachable
end
# The `x-spree-filters` extension of the endpoint's OpenAPI operation.
diff --git a/spree/core/app/models/spree/base.rb b/spree/core/app/models/spree/base.rb
index bfa930d3a3..7d3dfe2ec2 100644
--- a/spree/core/app/models/spree/base.rb
+++ b/spree/core/app/models/spree/base.rb
@@ -151,6 +151,22 @@ class Spree::Base < ApplicationRecord
end
end
+ # How a filter on one of this model's columns turns the short name a client
+ # sends (`purchase_order`) into the class name the column stores, or nil
+ # when the column does not store class names. Covers the STI column of a
+ # typed family and polymorphic `*_type` columns; a model with another such
+ # column overrides this.
+ #
+ # @param attribute [String]
+ # @return [Proc, nil] short name → stored class name
+ def self.api_type_resolver(attribute)
+ if attribute == inheritance_column && api_type_registry.any?
+ ->(api_type) { class_name_for_api_type(api_type) }
+ elsif reflect_on_all_associations(:belongs_to).any? { |reflection| reflection.polymorphic? && reflection.foreign_type == attribute }
+ ->(api_type) { Spree::Base.polymorphic_type_for(api_type) }
+ end
+ end
+
# Shorthand for a *polymorphic* `*_type` column (`owner_type`,
# `viewable_type`, …), where the value names an arbitrary model rather than a
# subclass of the serialized one — so `api_type_for`'s registry lookup does
diff --git a/spree/core/app/models/spree/custom_field_definition.rb b/spree/core/app/models/spree/custom_field_definition.rb
index 41f35f771e..16120dee6b 100644
--- a/spree/core/app/models/spree/custom_field_definition.rb
+++ b/spree/core/app/models/spree/custom_field_definition.rb
@@ -53,6 +53,15 @@ module Spree
# Ransack
#
self.whitelisted_ransackable_attributes = %w[key namespace label resource_type field_type storefront_visible searchable sortable]
+
+ # Both columns store class names; filters take the short names clients see.
+ def self.api_type_resolver(attribute)
+ case attribute
+ when 'resource_type' then ->(api_type) { normalize_value_for(:resource_type, api_type) }
+ when 'field_type' then ->(api_type) { Spree::CustomField::TYPE_TOKENS[api_type] }
+ else super
+ end
+ end
self.whitelisted_ransackable_scopes = %w[search]
# API-facing token for the STI subclass name stored in the `field_type`