@01.software/sdk 0.39.0 → 0.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +52 -20
  2. package/dist/client.cjs +43 -68
  3. package/dist/client.cjs.map +1 -1
  4. package/dist/client.d.cts +6 -6
  5. package/dist/client.d.ts +6 -6
  6. package/dist/client.js +43 -68
  7. package/dist/client.js.map +1 -1
  8. package/dist/{collection-client-CaMgs5KE.d.ts → collection-client-CKFa99C6.d.ts} +3 -3
  9. package/dist/{collection-client-DVfB0Em1.d.cts → collection-client-VYwYi6u6.d.cts} +3 -3
  10. package/dist/const-4BUtUdGU.d.cts +32 -0
  11. package/dist/const-ymprfiPf.d.ts +32 -0
  12. package/dist/{index-BOLQxveo.d.cts → index-Dquv4xTL.d.cts} +3 -3
  13. package/dist/{index-CSwR2HSg.d.ts → index-w36lpSkU.d.ts} +3 -3
  14. package/dist/index.cjs +101 -131
  15. package/dist/index.cjs.map +1 -1
  16. package/dist/index.d.cts +8 -8
  17. package/dist/index.d.ts +8 -8
  18. package/dist/index.js +101 -131
  19. package/dist/index.js.map +1 -1
  20. package/dist/{payload-types-m3jjhxk9.d.cts → payload-types-DC0xzR9i.d.cts} +470 -265
  21. package/dist/{payload-types-m3jjhxk9.d.ts → payload-types-DC0xzR9i.d.ts} +470 -265
  22. package/dist/query.d.cts +5 -5
  23. package/dist/query.d.ts +5 -5
  24. package/dist/realtime.d.cts +2 -2
  25. package/dist/realtime.d.ts +2 -2
  26. package/dist/server.cjs +36 -68
  27. package/dist/server.cjs.map +1 -1
  28. package/dist/server.d.cts +7 -7
  29. package/dist/server.d.ts +7 -7
  30. package/dist/server.js +36 -68
  31. package/dist/server.js.map +1 -1
  32. package/dist/{types-Cmrd1ezc.d.ts → types-Bh2p-EMc.d.ts} +5 -1
  33. package/dist/{types-D0ubzQw0.d.cts → types-BvpjooU-.d.cts} +5 -1
  34. package/dist/{types-CVf8sCZ-.d.ts → types-D5uHrPLr.d.cts} +99 -77
  35. package/dist/{types-BQo7UdI9.d.cts → types-Umd-YTjM.d.ts} +99 -77
  36. package/dist/ui/form.d.cts +1 -1
  37. package/dist/ui/form.d.ts +1 -1
  38. package/dist/ui/video.d.cts +1 -1
  39. package/dist/ui/video.d.ts +1 -1
  40. package/dist/webhook.d.cts +4 -4
  41. package/dist/webhook.d.ts +4 -4
  42. package/package.json +1 -1
  43. package/dist/const-6XHz_jej.d.ts +0 -32
  44. package/dist/const-B5KT72c7.d.cts +0 -32
@@ -60,13 +60,17 @@ interface Config {
60
60
  'order-export-profiles': OrderExportProfile;
61
61
  'shipping-policies': ShippingPolicy;
62
62
  'shipping-zones': ShippingZone;
63
+ 'tenant-commerce-config': TenantCommerceConfig;
63
64
  customers: Customer;
64
65
  'customer-profiles': CustomerProfile;
66
+ 'customer-profile-stats': CustomerProfileStat;
65
67
  'customer-profile-lists': CustomerProfileList;
66
68
  'customer-addresses': CustomerAddress;
67
69
  'customer-groups': CustomerGroup;
68
70
  carts: Cart;
69
71
  'cart-items': CartItem;
72
+ checkouts: Checkout;
73
+ 'checkout-items': CheckoutItem;
70
74
  discounts: Discount;
71
75
  articles: Article;
72
76
  'article-authors': ArticleAuthor;
@@ -169,6 +173,9 @@ interface Config {
169
173
  carts: {
170
174
  items: 'cart-items';
171
175
  };
176
+ checkouts: {
177
+ items: 'checkout-items';
178
+ };
172
179
  'article-authors': {
173
180
  articles: 'articles';
174
181
  };
@@ -243,13 +250,17 @@ interface Config {
243
250
  'order-export-profiles': OrderExportProfilesSelect<false> | OrderExportProfilesSelect<true>;
244
251
  'shipping-policies': ShippingPoliciesSelect<false> | ShippingPoliciesSelect<true>;
245
252
  'shipping-zones': ShippingZonesSelect<false> | ShippingZonesSelect<true>;
253
+ 'tenant-commerce-config': TenantCommerceConfigSelect<false> | TenantCommerceConfigSelect<true>;
246
254
  customers: CustomersSelect<false> | CustomersSelect<true>;
247
255
  'customer-profiles': CustomerProfilesSelect<false> | CustomerProfilesSelect<true>;
256
+ 'customer-profile-stats': CustomerProfileStatsSelect<false> | CustomerProfileStatsSelect<true>;
248
257
  'customer-profile-lists': CustomerProfileListsSelect<false> | CustomerProfileListsSelect<true>;
249
258
  'customer-addresses': CustomerAddressesSelect<false> | CustomerAddressesSelect<true>;
250
259
  'customer-groups': CustomerGroupsSelect<false> | CustomerGroupsSelect<true>;
251
260
  carts: CartsSelect<false> | CartsSelect<true>;
252
261
  'cart-items': CartItemsSelect<false> | CartItemsSelect<true>;
262
+ checkouts: CheckoutsSelect<false> | CheckoutsSelect<true>;
263
+ 'checkout-items': CheckoutItemsSelect<false> | CheckoutItemsSelect<true>;
253
264
  discounts: DiscountsSelect<false> | DiscountsSelect<true>;
254
265
  articles: ArticlesSelect<false> | ArticlesSelect<true>;
255
266
  'article-authors': ArticleAuthorsSelect<false> | ArticleAuthorsSelect<true>;
@@ -892,7 +903,7 @@ interface Order {
892
903
  */
893
904
  returnStatus: 'no_return' | 'return_requested' | 'in_progress' | 'returned';
894
905
  /**
895
- * Display status derived from payment, fulfillment order, shipment, and return state.
906
+ * Combined order-list status derived from payment, preparation, shipment, and return state.
896
907
  */
897
908
  displayStatus?: ('pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned') | null;
898
909
  /**
@@ -977,6 +988,10 @@ interface Order {
977
988
  totalDocs?: number;
978
989
  };
979
990
  confirmationStatus: 'unconfirmed' | 'confirmed';
991
+ /**
992
+ * When the order was first placed (paid). The placed-date basis for sales reporting.
993
+ */
994
+ placedAt?: string | null;
980
995
  confirmedAt?: string | null;
981
996
  cancelReason?: string | null;
982
997
  canceledAt?: string | null;
@@ -1064,18 +1079,6 @@ interface Customer {
1064
1079
  hasNextPage?: boolean;
1065
1080
  totalDocs?: number;
1066
1081
  };
1067
- /**
1068
- * Read-only counter maintained by hooks for community posts authored by this customer.
1069
- */
1070
- postCount?: number | null;
1071
- /**
1072
- * Read-only counter maintained by hooks for community comments authored by this customer.
1073
- */
1074
- commentCount?: number | null;
1075
- /**
1076
- * Read-only counter maintained by hooks for community reactions made by this customer.
1077
- */
1078
- reactionCount?: number | null;
1079
1082
  /**
1080
1083
  * Marks a minor customer. When enabled, guardian consent fields are managed as compliance evidence.
1081
1084
  */
@@ -1256,7 +1259,6 @@ interface CustomerAddress {
1256
1259
  * ISO 3166-1 alpha-2 country code
1257
1260
  */
1258
1261
  country?: string | null;
1259
- isDefault?: boolean | null;
1260
1262
  /**
1261
1263
  * Delivery request preset. Pick "Other" to switch to a free-form deliveryNote.
1262
1264
  */
@@ -1380,23 +1382,19 @@ interface Product {
1380
1382
  */
1381
1383
  subtitle?: string | null;
1382
1384
  /**
1383
- * Summary description used for product detail and search previews.
1385
+ * Summary used for product detail and search.
1384
1386
  */
1385
1387
  description?: string | null;
1386
1388
  /**
1387
- * Product detail gallery images. Order them in storefront display order.
1389
+ * The first image is used as the product featured image.
1388
1390
  */
1389
1391
  images?: (string | Image)[] | null;
1390
- /**
1391
- * Optional primary image pointer from product media pool (images[]).
1392
- */
1393
- primaryMediaItemId?: (string | null) | Image;
1394
1392
  /**
1395
1393
  * Links this content to videos from the Mux-backed videos collection.
1396
1394
  */
1397
1395
  videos?: (string | Video)[] | null;
1398
1396
  /**
1399
- * Product detail body content. Supports images and Iframe/Player/Carousel embed blocks.
1397
+ * Product detail body content.
1400
1398
  */
1401
1399
  content?: {
1402
1400
  root: {
@@ -1426,27 +1424,27 @@ interface Product {
1426
1424
  categories?: (string | ProductCategory)[] | null;
1427
1425
  tags?: (string | ProductTag)[] | null;
1428
1426
  /**
1429
- * Canonical brand used for storefront brand filtering.
1427
+ * Brand used for storefront filtering.
1430
1428
  */
1431
1429
  brand?: (string | null) | Brand;
1432
1430
  /**
1433
- * Shipping policy for this product. When empty on create, the default policy is applied.
1431
+ * Shipping policy for this product.
1434
1432
  */
1435
1433
  shippingPolicy?: (string | null) | ShippingPolicy;
1436
1434
  /**
1437
- * Integer weight in grams. For example, enter 2500 for 2.5 kg.
1435
+ * Enter weight in grams.
1438
1436
  */
1439
1437
  weight?: number | null;
1440
1438
  /**
1441
- * Supplier name imported from external systems, separate from the brand relationship.
1439
+ * Vendor name from external systems.
1442
1440
  */
1443
1441
  vendor?: string | null;
1444
1442
  /**
1445
- * External catalog product type, separate from categories.
1443
+ * Product type from external catalogs.
1446
1444
  */
1447
1445
  productType?: string | null;
1448
1446
  /**
1449
- * Collection memberships for this product. Managed from the collection edit view.
1447
+ * Collections that include this product.
1450
1448
  */
1451
1449
  collectionItems?: {
1452
1450
  docs?: (string | ProductCollectionItem)[];
@@ -1454,50 +1452,32 @@ interface Product {
1454
1452
  totalDocs?: number;
1455
1453
  };
1456
1454
  /**
1457
- * Minimum order quantity for this product.
1455
+ * Minimum order quantity.
1458
1456
  */
1459
1457
  minOrderQuantity?: number | null;
1460
1458
  /**
1461
- * Maximum order quantity for this product.
1459
+ * Maximum order quantity.
1462
1460
  */
1463
1461
  maxOrderQuantity?: number | null;
1464
- /**
1465
- * Automatically computed values for product cards and search.
1466
- */
1467
- listing?: {
1468
- /**
1469
- * Variant prioritized for product cards. Automatically derived.
1470
- */
1471
- selectionHintVariant?: (string | null) | ProductVariant;
1472
- /**
1473
- * Primary image for product cards and search. Automatically derived.
1474
- */
1475
- primaryImage?: (string | null) | Image;
1476
- /**
1477
- * Lowest active variant price. Automatically derived.
1478
- */
1479
- minPrice?: number | null;
1480
- /**
1481
- * Highest active variant price. Automatically derived.
1482
- */
1483
- maxPrice?: number | null;
1484
- /**
1485
- * Lowest compare-at price across active variants. Automatically derived.
1486
- */
1487
- minCompareAtPrice?: number | null;
1488
- /**
1489
- * Highest compare-at price across active variants. Automatically derived.
1490
- */
1491
- maxCompareAtPrice?: number | null;
1492
- /**
1493
- * Automatically enabled when min and max prices differ.
1494
- */
1462
+ priceRange?: {
1463
+ minVariantPrice?: {
1464
+ amount?: number | null;
1465
+ };
1466
+ maxVariantPrice?: {
1467
+ amount?: number | null;
1468
+ };
1495
1469
  isPriceRange?: boolean | null;
1496
- /**
1497
- * Enabled when at least one variant is sellable.
1498
- */
1499
- availableForSale?: boolean | null;
1500
1470
  };
1471
+ compareAtPriceRange?: {
1472
+ minVariantPrice?: {
1473
+ amount?: number | null;
1474
+ };
1475
+ maxVariantPrice?: {
1476
+ amount?: number | null;
1477
+ };
1478
+ };
1479
+ availableForSale?: boolean | null;
1480
+ selectedOrFirstAvailableVariant?: (string | null) | ProductVariant;
1501
1481
  seo?: {
1502
1482
  /**
1503
1483
  * Search result title (falls back to document title)
@@ -1530,29 +1510,29 @@ interface Product {
1530
1510
  image?: (string | null) | Image;
1531
1511
  };
1532
1512
  };
1533
- /**
1534
- * Preferred thumbnail for product lists. Falls back to the first gallery image when empty.
1535
- */
1536
- thumbnail?: (string | null) | Image;
1537
1513
  /**
1538
1514
  * When enabled, the slug will auto-generate from the title field on save and autosave.
1539
1515
  */
1540
1516
  generateSlug?: boolean | null;
1541
1517
  /**
1542
- * Canonical product URL slug. Generated from the title or editable directly.
1518
+ * Slug used in product URLs.
1543
1519
  */
1544
1520
  slug?: string | null;
1545
1521
  /**
1546
- * Draft is hidden, Published is public, and Archived hides without deleting.
1522
+ * Publication status for this product.
1547
1523
  */
1548
1524
  status?: ('draft' | 'published' | 'archived') | null;
1525
+ /**
1526
+ * Controls whether this product appears in listings and detail pages.
1527
+ */
1528
+ storefrontVisibility?: ('listed' | 'unlisted' | 'hidden') | null;
1549
1529
  /**
1550
1530
  * Automatically enabled when no variant is sellable.
1551
1531
  */
1552
1532
  isSoldOut?: boolean | null;
1553
1533
  isFeatured?: boolean | null;
1554
1534
  /**
1555
- * Automatically stamped the first time a draft is published.
1535
+ * Stamped when first published.
1556
1536
  */
1557
1537
  publishedAt?: string | null;
1558
1538
  metadata?: {
@@ -2580,7 +2560,7 @@ interface FulfillmentOrder {
2580
2560
  status: 'open' | 'in_progress' | 'on_hold' | 'canceled' | 'closed';
2581
2561
  holdReason?: string | null;
2582
2562
  /**
2583
- * Warehouse, store, or external location identifier assigned to this fulfillment order.
2563
+ * Warehouse, store, or external location assigned to prepare this shipment.
2584
2564
  */
2585
2565
  assignedLocation?: string | null;
2586
2566
  preparedAt?: string | null;
@@ -2630,11 +2610,11 @@ interface Fulfillment {
2630
2610
  */
2631
2611
  carrier?: string | null;
2632
2612
  /**
2633
- * Carrier tracking number. Used as input for the derived trackingUrl.
2613
+ * Carrier tracking number.
2634
2614
  */
2635
2615
  trackingNumber?: string | null;
2636
2616
  /**
2637
- * Tracking URL (auto-derived from carrier + trackingNumber)
2617
+ * Tracking URL auto-created from the carrier and tracking number.
2638
2618
  */
2639
2619
  trackingUrl?: string | null;
2640
2620
  packedAt?: string | null;
@@ -2988,7 +2968,7 @@ interface Webhook {
2988
2968
  /**
2989
2969
  * Receives create/update events for this collection.
2990
2970
  */
2991
- collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | 'brands' | 'brand-logos' | 'orders' | 'order-items' | 'transactions' | 'fulfillment-orders' | 'fulfillment-order-items' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | 'shipping-policies' | 'shipping-zones' | 'customers' | 'customer-profiles' | 'customer-addresses' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-items' | 'gallery-categories' | 'gallery-tags' | 'links' | 'link-categories' | 'link-tags' | 'forms' | 'form-submissions' | 'articles' | 'article-authors' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'canvases' | 'canvas-node-types' | 'canvas-edge-types' | 'canvas-categories' | 'canvas-tags' | 'canvas-nodes' | 'canvas-edges' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'post-tags' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags';
2971
+ collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | 'brands' | 'brand-logos' | 'orders' | 'order-items' | 'transactions' | 'fulfillment-orders' | 'fulfillment-order-items' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | 'shipping-policies' | 'shipping-zones' | 'customers' | 'customer-profiles' | 'customer-addresses' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-items' | 'gallery-categories' | 'gallery-tags' | 'links' | 'link-categories' | 'link-tags' | 'forms' | 'form-submissions' | 'articles' | 'article-authors' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'canvases' | 'canvas-node-types' | 'canvas-edge-types' | 'canvas-categories' | 'canvas-tags' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'post-tags' | 'customer-profile-stats' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags' | 'canvas-nodes' | 'canvas-edges';
2992
2972
  id?: string | null;
2993
2973
  }[] | null;
2994
2974
  isActive?: boolean | null;
@@ -3147,45 +3127,6 @@ interface TenantMetadatum {
3147
3127
  */
3148
3128
  twitterImage?: (string | null) | Image;
3149
3129
  };
3150
- ecommerceReturnPolicy?: {
3151
- initialShippingRefundMode?: ('full_order_only' | 'never') | null;
3152
- eligibleInitialShippingRefundReasons?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other')[] | null;
3153
- returnShippingFeeDefaultMode?: 'manual_only' | null;
3154
- manualOverrideAllowed?: boolean | null;
3155
- overrideNoteRequired?: boolean | null;
3156
- multiReturnInitialShippingRefund?: 'once_only' | null;
3157
- legacyOrderPolicyMode?: 'shipping_amount_manual_cap' | null;
3158
- };
3159
- /**
3160
- * Reusable option name and value lists for the Product Editor. Up to 20 presets.
3161
- */
3162
- optionPresets?: {
3163
- /**
3164
- * Name to identify this preset (e.g. Basic Clothing Sizes)
3165
- */
3166
- name: string;
3167
- /**
3168
- * Options included in this preset. Up to 10.
3169
- */
3170
- options?: {
3171
- /**
3172
- * Option name (e.g. Color, Size)
3173
- */
3174
- title?: string | null;
3175
- /**
3176
- * Values for this option. Up to 30.
3177
- */
3178
- values?: {
3179
- /**
3180
- * Option value (e.g. Red, S)
3181
- */
3182
- value?: string | null;
3183
- id?: string | null;
3184
- }[] | null;
3185
- id?: string | null;
3186
- }[] | null;
3187
- id?: string | null;
3188
- }[] | null;
3189
3130
  pwa?: {
3190
3131
  /**
3191
3132
  * Short name for PWA (12 characters max)
@@ -3748,8 +3689,16 @@ interface OrderStatusLog {
3748
3689
  interface InventoryReservation {
3749
3690
  id: string;
3750
3691
  tenant?: (string | null) | Tenant;
3751
- order: string | Order;
3752
- orderItem: string | OrderItem;
3692
+ order?: (string | null) | Order;
3693
+ orderItem?: (string | null) | OrderItem;
3694
+ /**
3695
+ * Checkout that owns this pre-payment hold. Re-linked to an order at placement.
3696
+ */
3697
+ checkout?: (string | null) | Checkout;
3698
+ /**
3699
+ * Checkout line item for this pre-payment hold. Re-linked to an order item at placement.
3700
+ */
3701
+ checkoutItem?: (string | null) | CheckoutItem;
3753
3702
  variant: string | ProductVariant;
3754
3703
  quantity: number;
3755
3704
  /**
@@ -3768,6 +3717,184 @@ interface InventoryReservation {
3768
3717
  createdAt: string;
3769
3718
  deletedAt?: string | null;
3770
3719
  }
3720
+ /**
3721
+ * In-progress checkout snapshots. Promoted to an order on payment.
3722
+ *
3723
+ * This interface was referenced by `Config`'s JSON-Schema
3724
+ * via the `definition` "checkouts".
3725
+ */
3726
+ interface Checkout {
3727
+ id: string;
3728
+ tenant?: (string | null) | Tenant;
3729
+ orderNumber: string;
3730
+ /**
3731
+ * Durable checkout identity token. Immutable after creation.
3732
+ */
3733
+ checkoutToken?: string | null;
3734
+ cartToken?: string | null;
3735
+ cart?: (string | null) | Cart;
3736
+ customer?: (string | null) | Customer;
3737
+ customerSnapshot?: {
3738
+ name?: string | null;
3739
+ email?: string | null;
3740
+ phone?: string | null;
3741
+ };
3742
+ shippingAddress?: {
3743
+ recipientName?: string | null;
3744
+ phone?: string | null;
3745
+ postalCode?: string | null;
3746
+ address?: string | null;
3747
+ detailAddress?: string | null;
3748
+ deliveryMessage?: string | null;
3749
+ };
3750
+ items?: {
3751
+ docs?: (string | CheckoutItem)[];
3752
+ hasNextPage?: boolean;
3753
+ totalDocs?: number;
3754
+ };
3755
+ currency?: string | null;
3756
+ subtotalAmount?: number | null;
3757
+ totalAmount?: number | null;
3758
+ shippingAmount?: number | null;
3759
+ discountCode?: string | null;
3760
+ discountAmount?: number | null;
3761
+ returnShippingRefundPolicySnapshot?: {
3762
+ [k: string]: unknown;
3763
+ } | unknown[] | string | number | boolean | null;
3764
+ pgProvider?: string | null;
3765
+ pgPaymentId?: string | null;
3766
+ status: 'open' | 'placed' | 'abandoned';
3767
+ expiresAt?: string | null;
3768
+ abandonedAt?: string | null;
3769
+ /**
3770
+ * Order this checkout was promoted to at placement
3771
+ */
3772
+ placedOrder?: (string | null) | Order;
3773
+ metadata?: {
3774
+ [k: string]: unknown;
3775
+ } | unknown[] | string | number | boolean | null;
3776
+ updatedAt: string;
3777
+ createdAt: string;
3778
+ }
3779
+ /**
3780
+ * This interface was referenced by `Config`'s JSON-Schema
3781
+ * via the `definition` "carts".
3782
+ */
3783
+ interface Cart {
3784
+ id: string;
3785
+ tenant?: (string | null) | Tenant;
3786
+ customer?: (string | null) | Customer;
3787
+ /**
3788
+ * Guest checkout email
3789
+ */
3790
+ email?: string | null;
3791
+ shippingAddress?: {
3792
+ recipientName?: string | null;
3793
+ phone?: string | null;
3794
+ postalCode?: string | null;
3795
+ address?: string | null;
3796
+ detailAddress?: string | null;
3797
+ deliveryMessage?: string | null;
3798
+ };
3799
+ discountCode?: string | null;
3800
+ /**
3801
+ * Customer note
3802
+ */
3803
+ customerNote?: string | null;
3804
+ items?: {
3805
+ docs?: (string | CartItem)[];
3806
+ hasNextPage?: boolean;
3807
+ totalDocs?: number;
3808
+ };
3809
+ status: 'active' | 'completed' | 'abandoned';
3810
+ currency?: string | null;
3811
+ subtotalAmount?: number | null;
3812
+ /**
3813
+ * Amount in KRW (won)
3814
+ */
3815
+ shippingAmount?: number | null;
3816
+ /**
3817
+ * Amount in KRW (won)
3818
+ */
3819
+ discountAmount?: number | null;
3820
+ totalAmount?: number | null;
3821
+ /**
3822
+ * Guest cart identity token. Immutable after creation.
3823
+ */
3824
+ cartToken?: string | null;
3825
+ lastActivityAt?: string | null;
3826
+ abandonedAt?: string | null;
3827
+ expiresAt?: string | null;
3828
+ metadata?: {
3829
+ [k: string]: unknown;
3830
+ } | unknown[] | string | number | boolean | null;
3831
+ updatedAt: string;
3832
+ createdAt: string;
3833
+ }
3834
+ /**
3835
+ * This interface was referenced by `Config`'s JSON-Schema
3836
+ * via the `definition` "cart-items".
3837
+ */
3838
+ interface CartItem {
3839
+ id: string;
3840
+ tenant?: (string | null) | Tenant;
3841
+ cart: string | Cart;
3842
+ product: string | Product;
3843
+ variant?: (string | null) | ProductVariant;
3844
+ quantity: number;
3845
+ /**
3846
+ * Price at the time of adding to cart
3847
+ */
3848
+ unitPrice: number;
3849
+ /**
3850
+ * Minor-unit discount allocated to this line from the header discount. Populated by recalculateCartTotals.
3851
+ */
3852
+ discountAllocation?: number | null;
3853
+ /**
3854
+ * Per-unit price after discount allocation (display). round(discountedTotalPrice / quantity).
3855
+ */
3856
+ discountedUnitPrice?: number | null;
3857
+ /**
3858
+ * Line total after discount allocation (totalPrice - discountAllocation). Populated by recalculateCartTotals.
3859
+ */
3860
+ discountedTotalPrice?: number | null;
3861
+ metadata?: {
3862
+ [k: string]: unknown;
3863
+ } | unknown[] | string | number | boolean | null;
3864
+ updatedAt: string;
3865
+ createdAt: string;
3866
+ }
3867
+ /**
3868
+ * This interface was referenced by `Config`'s JSON-Schema
3869
+ * via the `definition` "checkout-items".
3870
+ */
3871
+ interface CheckoutItem {
3872
+ id: string;
3873
+ tenant?: (string | null) | Tenant;
3874
+ checkout: string | Checkout;
3875
+ product: string | Product;
3876
+ variant?: (string | null) | ProductVariant;
3877
+ quantity: number;
3878
+ productTitle?: string | null;
3879
+ variantTitle?: string | null;
3880
+ sku?: string | null;
3881
+ optionSelection?: {
3882
+ [k: string]: unknown;
3883
+ } | unknown[] | string | number | boolean | null;
3884
+ /**
3885
+ * Unit-price snapshot at checkout time
3886
+ */
3887
+ unitPrice: number;
3888
+ totalPrice: number;
3889
+ discountAllocation?: number | null;
3890
+ discountedUnitPrice?: number | null;
3891
+ discountedTotalPrice?: number | null;
3892
+ metadata?: {
3893
+ [k: string]: unknown;
3894
+ } | unknown[] | string | number | boolean | null;
3895
+ updatedAt: string;
3896
+ createdAt: string;
3897
+ }
3771
3898
  /**
3772
3899
  * Configure order export formats for shipping carriers.
3773
3900
  *
@@ -3813,41 +3940,114 @@ interface OrderExportProfile {
3813
3940
  deletedAt?: string | null;
3814
3941
  }
3815
3942
  /**
3816
- * Manage shippable regions and regional constraints.
3817
- *
3943
+ * Manage shippable regions and regional constraints.
3944
+ *
3945
+ * This interface was referenced by `Config`'s JSON-Schema
3946
+ * via the `definition` "shipping-zones".
3947
+ */
3948
+ interface ShippingZone {
3949
+ id: string;
3950
+ _order?: string | null;
3951
+ tenant?: (string | null) | Tenant;
3952
+ /**
3953
+ * Display name (e.g. Jeju, Remote Islands) for operator reference
3954
+ */
3955
+ title?: string | null;
3956
+ /**
3957
+ * kind=jeju|remote-islands routes surcharge through shipping-policies fields; kind=custom uses this zone's extraAmount.
3958
+ */
3959
+ kind: 'jeju' | 'remote-islands' | 'custom';
3960
+ postalCodePatterns: {
3961
+ /**
3962
+ * Postal code prefix (e.g. 230, 525) or numeric range (e.g. 63000-63644)
3963
+ */
3964
+ pattern: string;
3965
+ id?: string | null;
3966
+ }[];
3967
+ /**
3968
+ * Surcharge applied when kind=custom. Ignored for jeju and remote-islands (those route through shipping-policies).
3969
+ */
3970
+ extraAmount?: number | null;
3971
+ isActive?: boolean | null;
3972
+ metadata?: {
3973
+ [k: string]: unknown;
3974
+ } | unknown[] | string | number | boolean | null;
3975
+ updatedAt: string;
3976
+ createdAt: string;
3977
+ deletedAt?: string | null;
3978
+ }
3979
+ /**
3980
+ * Manage commerce operations settings such as return refund policy and product option presets.
3981
+ *
3982
+ * This interface was referenced by `Config`'s JSON-Schema
3983
+ * via the `definition` "tenant-commerce-config".
3984
+ */
3985
+ interface TenantCommerceConfig {
3986
+ id: string;
3987
+ tenant?: (string | null) | Tenant;
3988
+ ecommerceReturnPolicy?: {
3989
+ initialShippingRefundMode?: ('full_order_only' | 'never') | null;
3990
+ eligibleInitialShippingRefundReasons?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other')[] | null;
3991
+ returnShippingFeeDefaultMode?: 'manual_only' | null;
3992
+ manualOverrideAllowed?: boolean | null;
3993
+ overrideNoteRequired?: boolean | null;
3994
+ multiReturnInitialShippingRefund?: 'once_only' | null;
3995
+ legacyOrderPolicyMode?: 'shipping_amount_manual_cap' | null;
3996
+ };
3997
+ /**
3998
+ * Reusable option name and value lists for the Product Editor. Up to 20 presets.
3999
+ */
4000
+ optionPresets?: {
4001
+ /**
4002
+ * Name to identify this preset (e.g. Basic Clothing Sizes)
4003
+ */
4004
+ name: string;
4005
+ /**
4006
+ * Options included in this preset. Up to 10.
4007
+ */
4008
+ options?: {
4009
+ /**
4010
+ * Option name (e.g. Color, Size)
4011
+ */
4012
+ title?: string | null;
4013
+ /**
4014
+ * Values for this option. Up to 30.
4015
+ */
4016
+ values?: {
4017
+ /**
4018
+ * Option value (e.g. Red, S)
4019
+ */
4020
+ value?: string | null;
4021
+ id?: string | null;
4022
+ }[] | null;
4023
+ id?: string | null;
4024
+ }[] | null;
4025
+ id?: string | null;
4026
+ }[] | null;
4027
+ updatedAt: string;
4028
+ createdAt: string;
4029
+ deletedAt?: string | null;
4030
+ }
4031
+ /**
3818
4032
  * This interface was referenced by `Config`'s JSON-Schema
3819
- * via the `definition` "shipping-zones".
4033
+ * via the `definition` "customer-profile-stats".
3820
4034
  */
3821
- interface ShippingZone {
4035
+ interface CustomerProfileStat {
3822
4036
  id: string;
3823
- _order?: string | null;
3824
4037
  tenant?: (string | null) | Tenant;
4038
+ profile: string | CustomerProfile;
3825
4039
  /**
3826
- * Display name (e.g. Jeju, Remote Islands) for operator reference
4040
+ * Read-only counter maintained by hooks for community posts authored by this public profile.
3827
4041
  */
3828
- title?: string | null;
4042
+ postCount?: number | null;
3829
4043
  /**
3830
- * kind=jeju|remote-islands routes surcharge through shipping-policies fields; kind=custom uses this zone's extraAmount.
4044
+ * Read-only counter maintained by hooks for community comments authored by this public profile.
3831
4045
  */
3832
- kind: 'jeju' | 'remote-islands' | 'custom';
3833
- postalCodePatterns: {
3834
- /**
3835
- * Postal code prefix (e.g. 230, 525) or numeric range (e.g. 63000-63644)
3836
- */
3837
- pattern: string;
3838
- id?: string | null;
3839
- }[];
4046
+ commentCount?: number | null;
3840
4047
  /**
3841
- * Surcharge applied when kind=custom. Ignored for jeju and remote-islands (those route through shipping-policies).
4048
+ * Read-only counter maintained by hooks for community reactions made by this public profile.
3842
4049
  */
3843
- extraAmount?: number | null;
3844
- isActive?: boolean | null;
3845
- metadata?: {
3846
- [k: string]: unknown;
3847
- } | unknown[] | string | number | boolean | null;
3848
- updatedAt: string;
3849
- createdAt: string;
3850
- deletedAt?: string | null;
4050
+ reactionCount?: number | null;
3851
4051
  }
3852
4052
  /**
3853
4053
  * Curate featured community profiles and public profile lists.
@@ -3892,94 +4092,6 @@ interface CustomerProfileList {
3892
4092
  createdAt: string;
3893
4093
  deletedAt?: string | null;
3894
4094
  }
3895
- /**
3896
- * This interface was referenced by `Config`'s JSON-Schema
3897
- * via the `definition` "carts".
3898
- */
3899
- interface Cart {
3900
- id: string;
3901
- tenant?: (string | null) | Tenant;
3902
- customer?: (string | null) | Customer;
3903
- /**
3904
- * Guest checkout email
3905
- */
3906
- email?: string | null;
3907
- shippingAddress?: {
3908
- recipientName?: string | null;
3909
- phone?: string | null;
3910
- postalCode?: string | null;
3911
- address?: string | null;
3912
- detailAddress?: string | null;
3913
- deliveryMessage?: string | null;
3914
- };
3915
- discountCode?: string | null;
3916
- /**
3917
- * Customer note
3918
- */
3919
- customerNote?: string | null;
3920
- items?: {
3921
- docs?: (string | CartItem)[];
3922
- hasNextPage?: boolean;
3923
- totalDocs?: number;
3924
- };
3925
- status: 'active' | 'completed' | 'abandoned';
3926
- currency?: string | null;
3927
- subtotalAmount?: number | null;
3928
- /**
3929
- * Amount in KRW (won)
3930
- */
3931
- shippingAmount?: number | null;
3932
- /**
3933
- * Amount in KRW (won)
3934
- */
3935
- discountAmount?: number | null;
3936
- totalAmount?: number | null;
3937
- /**
3938
- * Guest cart identity token. Immutable after creation.
3939
- */
3940
- cartToken?: string | null;
3941
- lastActivityAt?: string | null;
3942
- abandonedAt?: string | null;
3943
- expiresAt?: string | null;
3944
- metadata?: {
3945
- [k: string]: unknown;
3946
- } | unknown[] | string | number | boolean | null;
3947
- updatedAt: string;
3948
- createdAt: string;
3949
- }
3950
- /**
3951
- * This interface was referenced by `Config`'s JSON-Schema
3952
- * via the `definition` "cart-items".
3953
- */
3954
- interface CartItem {
3955
- id: string;
3956
- tenant?: (string | null) | Tenant;
3957
- cart: string | Cart;
3958
- product: string | Product;
3959
- variant?: (string | null) | ProductVariant;
3960
- quantity: number;
3961
- /**
3962
- * Price at the time of adding to cart
3963
- */
3964
- unitPrice: number;
3965
- /**
3966
- * Minor-unit discount allocated to this line from the header discount. Populated by recalculateCartTotals.
3967
- */
3968
- discountAllocation?: number | null;
3969
- /**
3970
- * Per-unit price after discount allocation (display). round(discountedTotalPrice / quantity).
3971
- */
3972
- discountedUnitPrice?: number | null;
3973
- /**
3974
- * Line total after discount allocation (totalPrice - discountAllocation). Populated by recalculateCartTotals.
3975
- */
3976
- discountedTotalPrice?: number | null;
3977
- metadata?: {
3978
- [k: string]: unknown;
3979
- } | unknown[] | string | number | boolean | null;
3980
- updatedAt: string;
3981
- createdAt: string;
3982
- }
3983
4095
  /**
3984
4096
  * Manage discount codes, eligibility rules, and usage limits.
3985
4097
  *
@@ -6947,27 +7059,6 @@ interface TenantMetadataSelect<T extends boolean = true> {
6947
7059
  twitterDescription?: T;
6948
7060
  twitterImage?: T;
6949
7061
  };
6950
- ecommerceReturnPolicy?: T | {
6951
- initialShippingRefundMode?: T;
6952
- eligibleInitialShippingRefundReasons?: T;
6953
- returnShippingFeeDefaultMode?: T;
6954
- manualOverrideAllowed?: T;
6955
- overrideNoteRequired?: T;
6956
- multiReturnInitialShippingRefund?: T;
6957
- legacyOrderPolicyMode?: T;
6958
- };
6959
- optionPresets?: T | {
6960
- name?: T;
6961
- options?: T | {
6962
- title?: T;
6963
- values?: T | {
6964
- value?: T;
6965
- id?: T;
6966
- };
6967
- id?: T;
6968
- };
6969
- id?: T;
6970
- };
6971
7062
  pwa?: T | {
6972
7063
  shortName?: T;
6973
7064
  backgroundColor?: T;
@@ -7365,7 +7456,6 @@ interface ProductsSelect<T extends boolean = true> {
7365
7456
  subtitle?: T;
7366
7457
  description?: T;
7367
7458
  images?: T;
7368
- primaryMediaItemId?: T;
7369
7459
  videos?: T;
7370
7460
  content?: T;
7371
7461
  variants?: T;
@@ -7380,16 +7470,25 @@ interface ProductsSelect<T extends boolean = true> {
7380
7470
  collectionItems?: T;
7381
7471
  minOrderQuantity?: T;
7382
7472
  maxOrderQuantity?: T;
7383
- listing?: T | {
7384
- selectionHintVariant?: T;
7385
- primaryImage?: T;
7386
- minPrice?: T;
7387
- maxPrice?: T;
7388
- minCompareAtPrice?: T;
7389
- maxCompareAtPrice?: T;
7473
+ priceRange?: T | {
7474
+ minVariantPrice?: T | {
7475
+ amount?: T;
7476
+ };
7477
+ maxVariantPrice?: T | {
7478
+ amount?: T;
7479
+ };
7390
7480
  isPriceRange?: T;
7391
- availableForSale?: T;
7392
7481
  };
7482
+ compareAtPriceRange?: T | {
7483
+ minVariantPrice?: T | {
7484
+ amount?: T;
7485
+ };
7486
+ maxVariantPrice?: T | {
7487
+ amount?: T;
7488
+ };
7489
+ };
7490
+ availableForSale?: T;
7491
+ selectedOrFirstAvailableVariant?: T;
7393
7492
  seo?: T | {
7394
7493
  title?: T;
7395
7494
  description?: T;
@@ -7401,10 +7500,10 @@ interface ProductsSelect<T extends boolean = true> {
7401
7500
  image?: T;
7402
7501
  };
7403
7502
  };
7404
- thumbnail?: T;
7405
7503
  generateSlug?: T;
7406
7504
  slug?: T;
7407
7505
  status?: T;
7506
+ storefrontVisibility?: T;
7408
7507
  isSoldOut?: T;
7409
7508
  isFeatured?: T;
7410
7509
  publishedAt?: T;
@@ -7765,6 +7864,7 @@ interface OrdersSelect<T extends boolean = true> {
7765
7864
  returnShippingRefundPolicySnapshot?: T;
7766
7865
  returns?: T;
7767
7866
  confirmationStatus?: T;
7867
+ placedAt?: T;
7768
7868
  confirmedAt?: T;
7769
7869
  cancelReason?: T;
7770
7870
  canceledAt?: T;
@@ -7886,6 +7986,8 @@ interface InventoryReservationsSelect<T extends boolean = true> {
7886
7986
  tenant?: T;
7887
7987
  order?: T;
7888
7988
  orderItem?: T;
7989
+ checkout?: T;
7990
+ checkoutItem?: T;
7889
7991
  variant?: T;
7890
7992
  quantity?: T;
7891
7993
  status?: T;
@@ -8075,6 +8177,37 @@ interface ShippingZonesSelect<T extends boolean = true> {
8075
8177
  createdAt?: T;
8076
8178
  deletedAt?: T;
8077
8179
  }
8180
+ /**
8181
+ * This interface was referenced by `Config`'s JSON-Schema
8182
+ * via the `definition` "tenant-commerce-config_select".
8183
+ */
8184
+ interface TenantCommerceConfigSelect<T extends boolean = true> {
8185
+ tenant?: T;
8186
+ ecommerceReturnPolicy?: T | {
8187
+ initialShippingRefundMode?: T;
8188
+ eligibleInitialShippingRefundReasons?: T;
8189
+ returnShippingFeeDefaultMode?: T;
8190
+ manualOverrideAllowed?: T;
8191
+ overrideNoteRequired?: T;
8192
+ multiReturnInitialShippingRefund?: T;
8193
+ legacyOrderPolicyMode?: T;
8194
+ };
8195
+ optionPresets?: T | {
8196
+ name?: T;
8197
+ options?: T | {
8198
+ title?: T;
8199
+ values?: T | {
8200
+ value?: T;
8201
+ id?: T;
8202
+ };
8203
+ id?: T;
8204
+ };
8205
+ id?: T;
8206
+ };
8207
+ updatedAt?: T;
8208
+ createdAt?: T;
8209
+ deletedAt?: T;
8210
+ }
8078
8211
  /**
8079
8212
  * This interface was referenced by `Config`'s JSON-Schema
8080
8213
  * via the `definition` "customers_select".
@@ -8104,9 +8237,6 @@ interface CustomersSelect<T extends boolean = true> {
8104
8237
  firstOrderAt?: T;
8105
8238
  lastOrderAt?: T;
8106
8239
  profile?: T;
8107
- postCount?: T;
8108
- commentCount?: T;
8109
- reactionCount?: T;
8110
8240
  isMinor?: T;
8111
8241
  marketingConsent?: T | {
8112
8242
  email?: T | {
@@ -8170,6 +8300,17 @@ interface CustomerProfilesSelect<T extends boolean = true> {
8170
8300
  anonymizedAt?: T;
8171
8301
  metadata?: T;
8172
8302
  }
8303
+ /**
8304
+ * This interface was referenced by `Config`'s JSON-Schema
8305
+ * via the `definition` "customer-profile-stats_select".
8306
+ */
8307
+ interface CustomerProfileStatsSelect<T extends boolean = true> {
8308
+ tenant?: T;
8309
+ profile?: T;
8310
+ postCount?: T;
8311
+ commentCount?: T;
8312
+ reactionCount?: T;
8313
+ }
8173
8314
  /**
8174
8315
  * This interface was referenced by `Config`'s JSON-Schema
8175
8316
  * via the `definition` "customer-profile-lists_select".
@@ -8218,7 +8359,6 @@ interface CustomerAddressesSelect<T extends boolean = true> {
8218
8359
  administrativeArea?: T;
8219
8360
  addressType?: T;
8220
8361
  country?: T;
8221
- isDefault?: T;
8222
8362
  deliveryRequest?: T;
8223
8363
  deliveryNote?: T;
8224
8364
  updatedAt?: T;
@@ -8307,6 +8447,71 @@ interface CartItemsSelect<T extends boolean = true> {
8307
8447
  updatedAt?: T;
8308
8448
  createdAt?: T;
8309
8449
  }
8450
+ /**
8451
+ * This interface was referenced by `Config`'s JSON-Schema
8452
+ * via the `definition` "checkouts_select".
8453
+ */
8454
+ interface CheckoutsSelect<T extends boolean = true> {
8455
+ tenant?: T;
8456
+ orderNumber?: T;
8457
+ checkoutToken?: T;
8458
+ cartToken?: T;
8459
+ cart?: T;
8460
+ customer?: T;
8461
+ customerSnapshot?: T | {
8462
+ name?: T;
8463
+ email?: T;
8464
+ phone?: T;
8465
+ };
8466
+ shippingAddress?: T | {
8467
+ recipientName?: T;
8468
+ phone?: T;
8469
+ postalCode?: T;
8470
+ address?: T;
8471
+ detailAddress?: T;
8472
+ deliveryMessage?: T;
8473
+ };
8474
+ items?: T;
8475
+ currency?: T;
8476
+ subtotalAmount?: T;
8477
+ totalAmount?: T;
8478
+ shippingAmount?: T;
8479
+ discountCode?: T;
8480
+ discountAmount?: T;
8481
+ returnShippingRefundPolicySnapshot?: T;
8482
+ pgProvider?: T;
8483
+ pgPaymentId?: T;
8484
+ status?: T;
8485
+ expiresAt?: T;
8486
+ abandonedAt?: T;
8487
+ placedOrder?: T;
8488
+ metadata?: T;
8489
+ updatedAt?: T;
8490
+ createdAt?: T;
8491
+ }
8492
+ /**
8493
+ * This interface was referenced by `Config`'s JSON-Schema
8494
+ * via the `definition` "checkout-items_select".
8495
+ */
8496
+ interface CheckoutItemsSelect<T extends boolean = true> {
8497
+ tenant?: T;
8498
+ checkout?: T;
8499
+ product?: T;
8500
+ variant?: T;
8501
+ quantity?: T;
8502
+ productTitle?: T;
8503
+ variantTitle?: T;
8504
+ sku?: T;
8505
+ optionSelection?: T;
8506
+ unitPrice?: T;
8507
+ totalPrice?: T;
8508
+ discountAllocation?: T;
8509
+ discountedUnitPrice?: T;
8510
+ discountedTotalPrice?: T;
8511
+ metadata?: T;
8512
+ updatedAt?: T;
8513
+ createdAt?: T;
8514
+ }
8310
8515
  /**
8311
8516
  * This interface was referenced by `Config`'s JSON-Schema
8312
8517
  * via the `definition` "discounts_select".
@@ -9802,4 +10007,4 @@ declare module 'payload' {
9802
10007
  }
9803
10008
  }
9804
10009
 
9805
- export type { Article as A, CustomerProfile as C, Document as D, Form as F, Image as I, Order as O, Product as P, Return as R, Tenant as T, Video as V, Webhook as W, CustomerProfileList as a, ProductCollection as b, Config as c, ArticleAuthor as d, ArticleCategory as e, ArticleTag as f, Cart as g, CartItem as h, Post as i, PostCategory as j, ProductVariant as k, Transaction as l, Fulfillment as m };
10010
+ export type { Article as A, CustomerProfile as C, Document as D, Form as F, Image as I, Order as O, Product as P, Return as R, Tenant as T, Video as V, Webhook as W, CustomerProfileStat as a, CustomerProfileList as b, ProductCollection as c, Config as d, ArticleAuthor as e, ArticleCategory as f, ArticleTag as g, Cart as h, CartItem as i, Post as j, PostCategory as k, ProductVariant as l, Transaction as m, Fulfillment as n };