@openlup/platform 0.17.0 → 0.19.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 (525) hide show
  1. package/CHANGELOG.md +143 -0
  2. package/README.md +299 -6
  3. package/dist/catalog/activeSkuSelection.d.ts +2 -0
  4. package/dist/catalog/activeSkuSelection.js +20 -0
  5. package/dist/catalog/adminBindings.d.ts +72 -0
  6. package/dist/catalog/adminBindings.js +1 -0
  7. package/dist/catalog/adminBundleHandler.d.ts +26 -0
  8. package/dist/catalog/adminBundleHandler.js +111 -0
  9. package/dist/catalog/adminBundleReadHandler.d.ts +21 -0
  10. package/dist/catalog/adminBundleReadHandler.js +185 -0
  11. package/dist/catalog/adminBundleWritePort.d.ts +85 -0
  12. package/dist/catalog/adminBundleWritePort.js +1 -0
  13. package/dist/catalog/bundleAvailability.d.ts +63 -0
  14. package/dist/catalog/bundleAvailability.js +78 -0
  15. package/dist/catalog/bundleAvailabilityService.d.ts +65 -0
  16. package/dist/catalog/bundleAvailabilityService.js +89 -0
  17. package/dist/catalog/bundleBindings.d.ts +33 -0
  18. package/dist/catalog/bundleBindings.js +1 -0
  19. package/dist/catalog/bundleCatalogQueries.d.ts +28 -0
  20. package/dist/catalog/bundleCatalogQueries.js +84 -0
  21. package/dist/catalog/bundleCatalogReadPort.d.ts +173 -0
  22. package/dist/catalog/bundleCatalogReadPort.js +36 -0
  23. package/dist/catalog/bundleCatalogStore.d.ts +5 -0
  24. package/dist/catalog/bundleCatalogStore.js +156 -0
  25. package/dist/catalog/bundlePriceSelection.d.ts +13 -0
  26. package/dist/catalog/bundlePriceSelection.js +26 -0
  27. package/dist/catalog/bundleRuleCodes.d.ts +41 -0
  28. package/dist/catalog/bundleRuleCodes.js +110 -0
  29. package/dist/catalog/bundleRules.d.ts +69 -0
  30. package/dist/catalog/bundleRules.js +102 -0
  31. package/dist/catalog/catalogDraftStore.d.ts +4 -0
  32. package/dist/catalog/catalogDraftStore.js +63 -0
  33. package/dist/catalog/catalogSkuEnvelope.d.ts +7 -0
  34. package/dist/catalog/catalogSkuEnvelope.js +142 -0
  35. package/dist/catalog/catalogSkuEnvelopeMapper.d.ts +38 -0
  36. package/dist/catalog/catalogSkuEnvelopeMapper.js +88 -0
  37. package/dist/catalog/contracts/bundleAdmin.d.ts +143 -0
  38. package/dist/catalog/contracts/bundleAdmin.js +1 -0
  39. package/dist/catalog/contracts/bundleAvailability.d.ts +61 -0
  40. package/dist/catalog/contracts/bundleAvailability.js +1 -0
  41. package/dist/catalog/contracts/bundleRead.d.ts +241 -0
  42. package/dist/catalog/contracts/bundleRead.js +1 -0
  43. package/dist/catalog/contracts/draft.d.ts +79 -0
  44. package/dist/catalog/contracts/draft.js +47 -0
  45. package/dist/catalog/contracts/foundation.d.ts +78 -0
  46. package/dist/catalog/contracts/foundation.js +53 -0
  47. package/dist/catalog/contracts/index.d.ts +14 -0
  48. package/dist/catalog/contracts/index.js +6 -0
  49. package/dist/catalog/contracts/lifecycle.d.ts +77 -0
  50. package/dist/catalog/contracts/lifecycle.js +1 -0
  51. package/dist/catalog/contracts/productMediaContracts.d.ts +77 -0
  52. package/dist/catalog/contracts/productMediaContracts.js +149 -0
  53. package/dist/catalog/contracts/productTypes.d.ts +54 -0
  54. package/dist/catalog/contracts/productTypes.js +16 -0
  55. package/dist/catalog/contracts/resolveProductMedia.d.ts +3 -0
  56. package/dist/catalog/contracts/resolveProductMedia.js +78 -0
  57. package/dist/catalog/contracts/sellable.d.ts +23 -0
  58. package/dist/catalog/contracts/sellable.js +1 -0
  59. package/dist/catalog/draftHandler.d.ts +25 -0
  60. package/dist/catalog/draftHandler.js +118 -0
  61. package/dist/catalog/draftPorts.d.ts +18 -0
  62. package/dist/catalog/draftPorts.js +8 -0
  63. package/dist/catalog/draftSchemas.d.ts +423 -0
  64. package/dist/catalog/draftSchemas.js +89 -0
  65. package/dist/catalog/draftValidation.d.ts +21 -0
  66. package/dist/catalog/draftValidation.js +125 -0
  67. package/dist/catalog/effectiveBundleCatalogQueries.d.ts +8 -0
  68. package/dist/catalog/effectiveBundleCatalogQueries.js +79 -0
  69. package/dist/catalog/effectiveBundleCatalogStore.d.ts +4 -0
  70. package/dist/catalog/effectiveBundleCatalogStore.js +156 -0
  71. package/dist/catalog/foundationSchemas.d.ts +98 -0
  72. package/dist/catalog/foundationSchemas.js +110 -0
  73. package/dist/catalog/index.d.ts +44 -0
  74. package/dist/catalog/index.js +26 -0
  75. package/dist/catalog/mediaSourcePack.d.ts +51 -0
  76. package/dist/catalog/mediaSourcePack.js +247 -0
  77. package/dist/catalog/productTypeSchemas.d.ts +46 -0
  78. package/dist/catalog/productTypeSchemas.js +72 -0
  79. package/dist/catalog/publicationPorts.d.ts +42 -0
  80. package/dist/catalog/publicationPorts.js +1 -0
  81. package/dist/catalog/readPorts.d.ts +51 -0
  82. package/dist/catalog/readPorts.js +1 -0
  83. package/dist/catalog/referenceCatalogHandler.d.ts +7 -0
  84. package/dist/catalog/referenceCatalogHandler.js +27 -0
  85. package/dist/catalog/resolvedSkuProjection.d.ts +88 -0
  86. package/dist/catalog/resolvedSkuProjection.js +60 -0
  87. package/dist/catalog/sellableBundleHandler.d.ts +46 -0
  88. package/dist/catalog/sellableBundleHandler.js +84 -0
  89. package/dist/catalog/sellableSchemas.d.ts +46 -0
  90. package/dist/catalog/sellableSchemas.js +27 -0
  91. package/dist/catalog/sql.d.ts +46 -0
  92. package/dist/catalog/sql.js +13 -0
  93. package/dist/catalog/validation.d.ts +2 -0
  94. package/dist/catalog/validation.js +3 -0
  95. package/dist/communications/contracts/index.d.ts +1 -0
  96. package/dist/communications/contracts/marketingSync.d.ts +194 -0
  97. package/dist/communications/contracts/marketingSync.js +1 -0
  98. package/dist/communications/index.d.ts +1 -0
  99. package/dist/communications/klaviyo/consentPush.d.ts +51 -0
  100. package/dist/communications/klaviyo/consentPush.js +19 -0
  101. package/dist/communications/klaviyo/index.d.ts +110 -0
  102. package/dist/communications/klaviyo/index.js +860 -0
  103. package/dist/communications/newsletterIntegrationContracts.d.ts +3 -3
  104. package/dist/communications/resend/index.d.ts +40 -0
  105. package/dist/communications/resend/index.js +310 -0
  106. package/dist/composition/catalogContribution.d.ts +18 -0
  107. package/dist/composition/catalogContribution.js +21 -0
  108. package/dist/composition/index.d.ts +3 -0
  109. package/dist/composition/index.js +3 -0
  110. package/dist/composition/inventoryContribution.d.ts +16 -0
  111. package/dist/composition/inventoryContribution.js +17 -0
  112. package/dist/composition/shippingContribution.d.ts +16 -0
  113. package/dist/composition/shippingContribution.js +17 -0
  114. package/dist/identity/customerContracts.d.ts +2 -2
  115. package/dist/inventory/adminInventory.d.ts +13 -0
  116. package/dist/inventory/adminInventory.js +214 -0
  117. package/dist/inventory/bindings.d.ts +35 -0
  118. package/dist/inventory/bindings.js +45 -0
  119. package/dist/inventory/contracts/forecast.d.ts +86 -0
  120. package/dist/inventory/contracts/forecast.js +1 -0
  121. package/dist/inventory/contracts/index.d.ts +4 -0
  122. package/dist/inventory/contracts/index.js +1 -0
  123. package/dist/inventory/contracts/inventory.d.ts +157 -0
  124. package/dist/inventory/contracts/inventory.js +1 -0
  125. package/dist/inventory/contracts/newPurchaseStock.d.ts +20 -0
  126. package/dist/inventory/contracts/newPurchaseStock.js +1 -0
  127. package/dist/inventory/contracts/reservation.d.ts +18 -0
  128. package/dist/inventory/contracts/reservation.js +1 -0
  129. package/dist/inventory/forecast.d.ts +24 -0
  130. package/dist/inventory/forecast.js +200 -0
  131. package/dist/inventory/index.d.ts +14 -0
  132. package/dist/inventory/index.js +11 -0
  133. package/dist/inventory/inventoryHandlers.d.ts +53 -0
  134. package/dist/inventory/inventoryHandlers.js +151 -0
  135. package/dist/inventory/newPurchaseStockAvailability.d.ts +47 -0
  136. package/dist/inventory/newPurchaseStockAvailability.js +75 -0
  137. package/dist/inventory/ports.d.ts +21 -0
  138. package/dist/inventory/ports.js +16 -0
  139. package/dist/inventory/renewalReservation.d.ts +27 -0
  140. package/dist/inventory/renewalReservation.js +61 -0
  141. package/dist/inventory/reservationPolicy.d.ts +6 -0
  142. package/dist/inventory/reservationPolicy.js +19 -0
  143. package/dist/inventory/schemas.d.ts +137 -0
  144. package/dist/inventory/schemas.js +112 -0
  145. package/dist/inventory/sql.d.ts +14 -0
  146. package/dist/inventory/sql.js +5 -0
  147. package/dist/inventory/subscriptionForecastCalculation.d.ts +4 -0
  148. package/dist/inventory/subscriptionForecastCalculation.js +133 -0
  149. package/dist/pricing/acquisitionFinancialPolicy.d.ts +26 -0
  150. package/dist/pricing/acquisitionFinancialPolicy.js +1 -0
  151. package/dist/pricing/acquisitionOfferPricing.d.ts +27 -0
  152. package/dist/pricing/acquisitionOfferPricing.js +25 -0
  153. package/dist/pricing/acquisitionOfferPricingHandler.d.ts +20 -0
  154. package/dist/pricing/acquisitionOfferPricingHandler.js +105 -0
  155. package/dist/pricing/acquisitionOfferPricingSchemas.d.ts +31 -0
  156. package/dist/pricing/acquisitionOfferPricingSchemas.js +33 -0
  157. package/dist/pricing/acquisitionQuoteBinding.d.ts +12 -0
  158. package/dist/pricing/acquisitionQuoteBinding.js +12 -0
  159. package/dist/pricing/acquisitionReadiness.d.ts +31 -0
  160. package/dist/pricing/acquisitionReadiness.js +117 -0
  161. package/dist/pricing/acquisitionTerms.d.ts +19 -0
  162. package/dist/pricing/acquisitionTerms.js +126 -0
  163. package/dist/pricing/acquisitionTermsSchemas.d.ts +59 -0
  164. package/dist/pricing/acquisitionTermsSchemas.js +42 -0
  165. package/dist/pricing/catalogFactsProvenance.d.ts +33 -0
  166. package/dist/pricing/catalogFactsProvenance.js +64 -0
  167. package/dist/pricing/catalogFactsSchemas.d.ts +45 -0
  168. package/dist/pricing/catalogFactsSchemas.js +58 -0
  169. package/dist/pricing/commerceOfferPricing.d.ts +25 -0
  170. package/dist/pricing/commerceOfferPricing.js +139 -0
  171. package/dist/pricing/commerceOfferPricingCache.d.ts +10 -0
  172. package/dist/pricing/commerceOfferPricingCache.js +44 -0
  173. package/dist/pricing/commerceOfferPricingHandler.d.ts +21 -0
  174. package/dist/pricing/commerceOfferPricingHandler.js +78 -0
  175. package/dist/pricing/commercePriceAuthority.d.ts +28 -0
  176. package/dist/pricing/commercePriceAuthority.js +140 -0
  177. package/dist/pricing/commercePricingPolicyErrors.d.ts +40 -0
  178. package/dist/pricing/commercePricingPolicyErrors.js +67 -0
  179. package/dist/pricing/commerceQuoteBatchHandler.d.ts +37 -0
  180. package/dist/pricing/commerceQuoteBatchHandler.js +83 -0
  181. package/dist/pricing/commerceQuoteCatalogReadPort.d.ts +27 -0
  182. package/dist/pricing/commerceQuoteCatalogReadPort.js +8 -0
  183. package/dist/pricing/commerceQuoteHandler.d.ts +35 -0
  184. package/dist/pricing/commerceQuoteHandler.js +122 -0
  185. package/dist/pricing/commerceQuoteSnapshotExpect.d.ts +9 -0
  186. package/dist/pricing/commerceQuoteSnapshotExpect.js +22 -0
  187. package/dist/pricing/contracts/acquisitionTerms.d.ts +32 -0
  188. package/dist/pricing/contracts/acquisitionTerms.js +2 -0
  189. package/dist/pricing/contracts/authority.d.ts +27 -0
  190. package/dist/pricing/contracts/authority.js +1 -0
  191. package/dist/pricing/contracts/evidence.d.ts +33 -0
  192. package/dist/pricing/contracts/evidence.js +1 -0
  193. package/dist/pricing/contracts/index.d.ts +17 -0
  194. package/dist/pricing/contracts/index.js +7 -0
  195. package/dist/pricing/contracts/money.d.ts +27 -0
  196. package/dist/pricing/contracts/money.js +1 -0
  197. package/dist/pricing/contracts/offer.d.ts +52 -0
  198. package/dist/pricing/contracts/offer.js +4 -0
  199. package/dist/pricing/contracts/offerPolicy.d.ts +16 -0
  200. package/dist/pricing/contracts/offerPolicy.js +5 -0
  201. package/dist/pricing/contracts/policy.d.ts +22 -0
  202. package/dist/pricing/contracts/policy.js +3 -0
  203. package/dist/pricing/contracts/provenance.d.ts +24 -0
  204. package/dist/pricing/contracts/provenance.js +2 -0
  205. package/dist/pricing/contracts/quote.d.ts +94 -0
  206. package/dist/pricing/contracts/quote.js +1 -0
  207. package/dist/pricing/dbBackedCommerceQuoteHelpers.d.ts +78 -0
  208. package/dist/pricing/dbBackedCommerceQuoteHelpers.js +146 -0
  209. package/dist/pricing/dbBackedCommerceQuotePort.d.ts +74 -0
  210. package/dist/pricing/dbBackedCommerceQuotePort.js +223 -0
  211. package/dist/pricing/dbBackedCommerceQuoteSnapshotVerifier.d.ts +4 -0
  212. package/dist/pricing/dbBackedCommerceQuoteSnapshotVerifier.js +25 -0
  213. package/dist/pricing/index.d.ts +52 -0
  214. package/dist/pricing/index.js +36 -0
  215. package/dist/pricing/offerPolicyReadiness.d.ts +21 -0
  216. package/dist/pricing/offerPolicyReadiness.js +79 -0
  217. package/dist/pricing/offerPolicySchemas.d.ts +25 -0
  218. package/dist/pricing/offerPolicySchemas.js +15 -0
  219. package/dist/pricing/offerPricingSchemas.d.ts +315 -0
  220. package/dist/pricing/offerPricingSchemas.js +65 -0
  221. package/dist/pricing/ports.d.ts +13 -0
  222. package/dist/pricing/ports.js +9 -0
  223. package/dist/pricing/pricingPolicyToken.d.ts +39 -0
  224. package/dist/pricing/pricingPolicyToken.js +84 -0
  225. package/dist/pricing/quoteAcquisitionTerms.d.ts +2 -0
  226. package/dist/pricing/quoteAcquisitionTerms.js +4 -0
  227. package/dist/pricing/quoteCodeRejectionDetails.d.ts +20 -0
  228. package/dist/pricing/quoteCodeRejectionDetails.js +22 -0
  229. package/dist/pricing/quotePorts.d.ts +30 -0
  230. package/dist/pricing/quotePorts.js +20 -0
  231. package/dist/pricing/quotePrimitives.d.ts +13 -0
  232. package/dist/pricing/quotePrimitives.js +18 -0
  233. package/dist/pricing/quotePromotionEvidence.d.ts +39 -0
  234. package/dist/pricing/quotePromotionEvidence.js +73 -0
  235. package/dist/pricing/quoteSchemas.d.ts +1176 -0
  236. package/dist/pricing/quoteSchemas.js +196 -0
  237. package/dist/pricing/quoteShippingPromotions.d.ts +20 -0
  238. package/dist/pricing/quoteShippingPromotions.js +1 -0
  239. package/dist/pricing/subscriptionPricePolicy.d.ts +52 -0
  240. package/dist/pricing/subscriptionPricePolicy.js +96 -0
  241. package/dist/pricing/taxProfileGuard.d.ts +2 -0
  242. package/dist/pricing/taxProfileGuard.js +24 -0
  243. package/dist/pricing/validation.d.ts +2 -0
  244. package/dist/pricing/validation.js +3 -0
  245. package/dist/promotions/adminBindings.d.ts +72 -0
  246. package/dist/promotions/adminBindings.js +1 -0
  247. package/dist/promotions/adminPromotionCodesContracts.d.ts +498 -0
  248. package/dist/promotions/adminPromotionCodesContracts.js +211 -0
  249. package/dist/promotions/adminPromotionCodesDataPort.d.ts +47 -0
  250. package/dist/promotions/adminPromotionCodesDataPort.js +1 -0
  251. package/dist/promotions/adminPromotionCodesHandler.d.ts +14 -0
  252. package/dist/promotions/adminPromotionCodesHandler.js +194 -0
  253. package/dist/promotions/adminPromotionsContracts.d.ts +235 -0
  254. package/dist/promotions/adminPromotionsContracts.js +99 -0
  255. package/dist/promotions/adminPromotionsDataPort.d.ts +42 -0
  256. package/dist/promotions/adminPromotionsDataPort.js +1 -0
  257. package/dist/promotions/adminPromotionsHandler.d.ts +16 -0
  258. package/dist/promotions/adminPromotionsHandler.js +47 -0
  259. package/dist/promotions/commerceQuoteReadPreparation.d.ts +3 -0
  260. package/dist/promotions/commerceQuoteReadPreparation.js +27 -0
  261. package/dist/promotions/contracts/index.d.ts +387 -0
  262. package/dist/promotions/contracts/index.js +1 -0
  263. package/dist/promotions/index.d.ts +25 -0
  264. package/dist/promotions/index.js +22 -0
  265. package/dist/promotions/promoDataPort.d.ts +47 -0
  266. package/dist/promotions/promoDataPort.js +14 -0
  267. package/dist/promotions/promotionAcceptanceTelemetry.d.ts +29 -0
  268. package/dist/promotions/promotionAcceptanceTelemetry.js +45 -0
  269. package/dist/promotions/promotionBenefitDefinition.d.ts +37 -0
  270. package/dist/promotions/promotionBenefitDefinition.js +33 -0
  271. package/dist/promotions/promotionClaimSweepPort.d.ts +14 -0
  272. package/dist/promotions/promotionClaimSweepPort.js +8 -0
  273. package/dist/promotions/promotionClaims.d.ts +5 -0
  274. package/dist/promotions/promotionClaims.js +57 -0
  275. package/dist/promotions/promotionCodePreview.d.ts +11 -0
  276. package/dist/promotions/promotionCodePreview.js +154 -0
  277. package/dist/promotions/promotionCodeQuotePort.d.ts +25 -0
  278. package/dist/promotions/promotionCodeQuotePort.js +1 -0
  279. package/dist/promotions/promotionQuoteAcceptance.d.ts +70 -0
  280. package/dist/promotions/promotionQuoteAcceptance.js +202 -0
  281. package/dist/promotions/promotionQuoteBinding.d.ts +73 -0
  282. package/dist/promotions/promotionQuoteBinding.js +87 -0
  283. package/dist/promotions/quoteAcquisitionBinding.d.ts +6 -0
  284. package/dist/promotions/quoteAcquisitionBinding.js +1 -0
  285. package/dist/promotions/quoteAutomaticPromotions.d.ts +26 -0
  286. package/dist/promotions/quoteAutomaticPromotions.js +60 -0
  287. package/dist/promotions/quotePromoDiscounts.d.ts +36 -0
  288. package/dist/promotions/quotePromoDiscounts.js +146 -0
  289. package/dist/promotions/quotePromotionCodeAdjustments.d.ts +27 -0
  290. package/dist/promotions/quotePromotionCodeAdjustments.js +223 -0
  291. package/dist/promotions/quotePromotionV2.d.ts +30 -0
  292. package/dist/promotions/quotePromotionV2.js +186 -0
  293. package/dist/promotions/quoteShippingPolicy.d.ts +23 -0
  294. package/dist/promotions/quoteShippingPolicy.js +47 -0
  295. package/dist/promotions/sql.d.ts +14 -0
  296. package/dist/promotions/sql.js +5 -0
  297. package/dist/promotions/validation.d.ts +2 -0
  298. package/dist/promotions/validation.js +3 -0
  299. package/dist/shipping/addressCanonLookupHandler.d.ts +7 -0
  300. package/dist/shipping/addressCanonLookupHandler.js +105 -0
  301. package/dist/shipping/addressCanonical.d.ts +2 -0
  302. package/dist/shipping/addressCanonical.js +26 -0
  303. package/dist/shipping/addressPorts.d.ts +39 -0
  304. package/dist/shipping/addressPorts.js +1 -0
  305. package/dist/shipping/addressSchemas.d.ts +30 -0
  306. package/dist/shipping/addressSchemas.js +1 -0
  307. package/dist/shipping/adminShippingRateHandler.d.ts +4 -0
  308. package/dist/shipping/adminShippingRateHandler.js +64 -0
  309. package/dist/shipping/bindings.d.ts +57 -0
  310. package/dist/shipping/bindings.js +46 -0
  311. package/dist/shipping/contracts/address.d.ts +144 -0
  312. package/dist/shipping/contracts/address.js +1 -0
  313. package/dist/shipping/contracts/delivery.d.ts +110 -0
  314. package/dist/shipping/contracts/delivery.js +1 -0
  315. package/dist/shipping/contracts/index.d.ts +4 -0
  316. package/dist/shipping/contracts/index.js +1 -0
  317. package/dist/shipping/contracts/shippingRate.d.ts +11 -0
  318. package/dist/shipping/contracts/shippingRate.js +1 -0
  319. package/dist/shipping/contracts/threshold.d.ts +22 -0
  320. package/dist/shipping/contracts/threshold.js +1 -0
  321. package/dist/shipping/customerAddressesHandler.d.ts +5 -0
  322. package/dist/shipping/customerAddressesHandler.js +80 -0
  323. package/dist/shipping/customerSelfServiceAddressModels.d.ts +27 -0
  324. package/dist/shipping/customerSelfServiceAddressModels.js +101 -0
  325. package/dist/shipping/deliverySelectionHandler.d.ts +10 -0
  326. package/dist/shipping/deliverySelectionHandler.js +77 -0
  327. package/dist/shipping/deliverySelectionPort.d.ts +8 -0
  328. package/dist/shipping/deliverySelectionPort.js +1 -0
  329. package/dist/shipping/deliverySelectionSummary.d.ts +2 -0
  330. package/dist/shipping/deliverySelectionSummary.js +53 -0
  331. package/dist/shipping/handlerSchemas.d.ts +21 -0
  332. package/dist/shipping/handlerSchemas.js +1 -0
  333. package/dist/shipping/index.d.ts +20 -0
  334. package/dist/shipping/index.js +10 -0
  335. package/dist/shipping/pickupPointSearchPort.d.ts +4 -0
  336. package/dist/shipping/pickupPointSearchPort.js +1 -0
  337. package/dist/shipping/readDeliverySelectionEvidence.d.ts +2 -0
  338. package/dist/shipping/readDeliverySelectionEvidence.js +44 -0
  339. package/dist/shipping/shippingRatePorts.d.ts +52 -0
  340. package/dist/shipping/shippingRatePorts.js +1 -0
  341. package/dist/shipping/thresholdPolicy.d.ts +42 -0
  342. package/dist/shipping/thresholdPolicy.js +60 -0
  343. package/package.json +62 -2
  344. package/release-gates.json +263 -53
  345. package/sql/20260807140000_read_parity_catalog.sql +94 -0
  346. package/sql/20260810120000_storefront_catalog_attributes.sql +51 -0
  347. package/sql/20260812140000_sellable_bundle_catalog.sql +124 -0
  348. package/sql/20260812210000_bundle_operator_write_boundary.sql +567 -0
  349. package/sql/20260814000000_fulfillment_stock_evidence.sql +239 -0
  350. package/sql/20260815120000_automatic_subscription_renewal.sql +1083 -0
  351. package/sql/20260817180000_promotion_claim_lifecycle.sql +591 -0
  352. package/sql/20260817180100_promotion_claim_lifecycle_validation.sql +23 -0
  353. package/sql/20260827220000_catalog_document_revision_foundation.sql +226 -0
  354. package/sql/20260827220001_catalog_document_revision_foundation_validate.sql +10 -0
  355. package/sql/20260908100000_catalog_draft_foundation.sql +217 -0
  356. package/src/catalog/activeSkuSelection.ts +20 -0
  357. package/src/catalog/adminBindings.ts +59 -0
  358. package/src/catalog/adminBundleHandler.ts +165 -0
  359. package/src/catalog/adminBundleReadHandler.ts +263 -0
  360. package/src/catalog/adminBundleWritePort.ts +102 -0
  361. package/src/catalog/bundleAvailability.ts +129 -0
  362. package/src/catalog/bundleAvailabilityService.ts +171 -0
  363. package/src/catalog/bundleBindings.ts +29 -0
  364. package/src/catalog/bundleCatalogQueries.ts +98 -0
  365. package/src/catalog/bundleCatalogReadPort.ts +181 -0
  366. package/src/catalog/bundleCatalogStore.ts +274 -0
  367. package/src/catalog/bundlePriceSelection.ts +25 -0
  368. package/src/catalog/bundleRuleCodes.ts +134 -0
  369. package/src/catalog/bundleRules.ts +153 -0
  370. package/src/catalog/catalogDraftStore.ts +71 -0
  371. package/src/catalog/catalogSkuEnvelope.ts +214 -0
  372. package/src/catalog/catalogSkuEnvelopeMapper.ts +160 -0
  373. package/src/catalog/contracts/bundleAdmin.ts +20 -0
  374. package/src/catalog/contracts/bundleAvailability.ts +5 -0
  375. package/src/catalog/contracts/bundleRead.ts +13 -0
  376. package/src/catalog/contracts/draft.ts +69 -0
  377. package/src/catalog/contracts/foundation.ts +104 -0
  378. package/src/catalog/contracts/index.ts +14 -0
  379. package/src/catalog/contracts/lifecycle.ts +74 -0
  380. package/src/catalog/contracts/productMediaContracts.ts +170 -0
  381. package/src/catalog/contracts/productTypes.ts +35 -0
  382. package/src/catalog/contracts/resolveProductMedia.ts +85 -0
  383. package/src/catalog/contracts/sellable.ts +12 -0
  384. package/src/catalog/draftHandler.ts +105 -0
  385. package/src/catalog/draftPorts.ts +18 -0
  386. package/src/catalog/draftSchemas.ts +88 -0
  387. package/src/catalog/draftValidation.ts +100 -0
  388. package/src/catalog/effectiveBundleCatalogQueries.ts +80 -0
  389. package/src/catalog/effectiveBundleCatalogStore.ts +208 -0
  390. package/src/catalog/foundationSchemas.ts +123 -0
  391. package/src/catalog/index.ts +44 -0
  392. package/src/catalog/mediaSourcePack.ts +219 -0
  393. package/src/catalog/productTypeSchemas.ts +70 -0
  394. package/src/catalog/publicationPorts.ts +44 -0
  395. package/src/catalog/readPorts.ts +61 -0
  396. package/src/catalog/referenceCatalogHandler.ts +39 -0
  397. package/src/catalog/resolvedSkuProjection.ts +76 -0
  398. package/src/catalog/sellableBundleHandler.ts +133 -0
  399. package/src/catalog/sellableSchemas.ts +33 -0
  400. package/src/catalog/sql.ts +14 -0
  401. package/src/catalog/validation.ts +3 -0
  402. package/src/communications/contracts/index.ts +1 -0
  403. package/src/communications/contracts/marketingSync.ts +109 -0
  404. package/src/communications/index.ts +1 -0
  405. package/src/communications/klaviyo/consentPush.ts +19 -0
  406. package/src/communications/klaviyo/index.ts +649 -0
  407. package/src/communications/resend/index.ts +350 -0
  408. package/src/composition/catalogContribution.ts +32 -0
  409. package/src/composition/index.ts +3 -0
  410. package/src/composition/inventoryContribution.ts +24 -0
  411. package/src/composition/shippingContribution.ts +24 -0
  412. package/src/inventory/adminInventory.ts +251 -0
  413. package/src/inventory/bindings.ts +61 -0
  414. package/src/inventory/contracts/forecast.ts +96 -0
  415. package/src/inventory/contracts/index.ts +18 -0
  416. package/src/inventory/contracts/inventory.ts +14 -0
  417. package/src/inventory/contracts/newPurchaseStock.ts +23 -0
  418. package/src/inventory/contracts/reservation.ts +20 -0
  419. package/src/inventory/forecast.ts +239 -0
  420. package/src/inventory/index.ts +22 -0
  421. package/src/inventory/inventoryHandlers.ts +215 -0
  422. package/src/inventory/newPurchaseStockAvailability.ts +120 -0
  423. package/src/inventory/ports.ts +46 -0
  424. package/src/inventory/renewalReservation.ts +88 -0
  425. package/src/inventory/reservationPolicy.ts +27 -0
  426. package/src/inventory/schemas.ts +128 -0
  427. package/src/inventory/sql.ts +5 -0
  428. package/src/inventory/subscriptionForecastCalculation.ts +157 -0
  429. package/src/pricing/acquisitionFinancialPolicy.ts +26 -0
  430. package/src/pricing/acquisitionOfferPricing.ts +38 -0
  431. package/src/pricing/acquisitionOfferPricingHandler.ts +157 -0
  432. package/src/pricing/acquisitionOfferPricingSchemas.ts +35 -0
  433. package/src/pricing/acquisitionQuoteBinding.ts +12 -0
  434. package/src/pricing/acquisitionReadiness.ts +148 -0
  435. package/src/pricing/acquisitionTerms.ts +125 -0
  436. package/src/pricing/acquisitionTermsSchemas.ts +52 -0
  437. package/src/pricing/catalogFactsProvenance.ts +102 -0
  438. package/src/pricing/catalogFactsSchemas.ts +69 -0
  439. package/src/pricing/commerceOfferPricing.ts +224 -0
  440. package/src/pricing/commerceOfferPricingCache.ts +53 -0
  441. package/src/pricing/commerceOfferPricingHandler.ts +137 -0
  442. package/src/pricing/commercePriceAuthority.ts +169 -0
  443. package/src/pricing/commercePricingPolicyErrors.ts +88 -0
  444. package/src/pricing/commerceQuoteBatchHandler.ts +129 -0
  445. package/src/pricing/commerceQuoteCatalogReadPort.ts +42 -0
  446. package/src/pricing/commerceQuoteHandler.ts +199 -0
  447. package/src/pricing/commerceQuoteSnapshotExpect.ts +48 -0
  448. package/src/pricing/contracts/acquisitionTerms.ts +26 -0
  449. package/src/pricing/contracts/authority.ts +44 -0
  450. package/src/pricing/contracts/evidence.ts +25 -0
  451. package/src/pricing/contracts/index.ts +17 -0
  452. package/src/pricing/contracts/money.ts +32 -0
  453. package/src/pricing/contracts/offer.ts +42 -0
  454. package/src/pricing/contracts/offerPolicy.ts +17 -0
  455. package/src/pricing/contracts/policy.ts +26 -0
  456. package/src/pricing/contracts/provenance.ts +19 -0
  457. package/src/pricing/contracts/quote.ts +106 -0
  458. package/src/pricing/dbBackedCommerceQuoteHelpers.ts +256 -0
  459. package/src/pricing/dbBackedCommerceQuotePort.ts +280 -0
  460. package/src/pricing/dbBackedCommerceQuoteSnapshotVerifier.ts +49 -0
  461. package/src/pricing/index.ts +53 -0
  462. package/src/pricing/offerPolicyReadiness.ts +110 -0
  463. package/src/pricing/offerPolicySchemas.ts +23 -0
  464. package/src/pricing/offerPricingSchemas.ts +92 -0
  465. package/src/pricing/ports.ts +17 -0
  466. package/src/pricing/pricingPolicyToken.ts +119 -0
  467. package/src/pricing/quoteAcquisitionTerms.ts +10 -0
  468. package/src/pricing/quoteCodeRejectionDetails.ts +23 -0
  469. package/src/pricing/quotePorts.ts +58 -0
  470. package/src/pricing/quotePrimitives.ts +21 -0
  471. package/src/pricing/quotePromotionEvidence.ts +82 -0
  472. package/src/pricing/quoteSchemas.ts +230 -0
  473. package/src/pricing/quoteShippingPromotions.ts +21 -0
  474. package/src/pricing/subscriptionPricePolicy.ts +113 -0
  475. package/src/pricing/taxProfileGuard.ts +33 -0
  476. package/src/pricing/validation.ts +3 -0
  477. package/src/promotions/adminBindings.ts +53 -0
  478. package/src/promotions/adminPromotionCodesContracts.ts +244 -0
  479. package/src/promotions/adminPromotionCodesDataPort.ts +56 -0
  480. package/src/promotions/adminPromotionCodesHandler.ts +254 -0
  481. package/src/promotions/adminPromotionsContracts.ts +121 -0
  482. package/src/promotions/adminPromotionsDataPort.ts +48 -0
  483. package/src/promotions/adminPromotionsHandler.ts +72 -0
  484. package/src/promotions/commerceQuoteReadPreparation.ts +29 -0
  485. package/src/promotions/contracts/index.ts +387 -0
  486. package/src/promotions/index.ts +25 -0
  487. package/src/promotions/promoDataPort.ts +65 -0
  488. package/src/promotions/promotionAcceptanceTelemetry.ts +73 -0
  489. package/src/promotions/promotionBenefitDefinition.ts +48 -0
  490. package/src/promotions/promotionClaimSweepPort.ts +23 -0
  491. package/src/promotions/promotionClaims.ts +70 -0
  492. package/src/promotions/promotionCodePreview.ts +183 -0
  493. package/src/promotions/promotionCodeQuotePort.ts +35 -0
  494. package/src/promotions/promotionQuoteAcceptance.ts +291 -0
  495. package/src/promotions/promotionQuoteBinding.ts +163 -0
  496. package/src/promotions/quoteAcquisitionBinding.ts +7 -0
  497. package/src/promotions/quoteAutomaticPromotions.ts +84 -0
  498. package/src/promotions/quotePromoDiscounts.ts +194 -0
  499. package/src/promotions/quotePromotionCodeAdjustments.ts +277 -0
  500. package/src/promotions/quotePromotionV2.ts +239 -0
  501. package/src/promotions/quoteShippingPolicy.ts +61 -0
  502. package/src/promotions/sql.ts +5 -0
  503. package/src/promotions/validation.ts +3 -0
  504. package/src/shipping/addressCanonLookupHandler.ts +114 -0
  505. package/src/shipping/addressCanonical.ts +31 -0
  506. package/src/shipping/addressPorts.ts +48 -0
  507. package/src/shipping/addressSchemas.ts +28 -0
  508. package/src/shipping/adminShippingRateHandler.ts +72 -0
  509. package/src/shipping/bindings.ts +74 -0
  510. package/src/shipping/contracts/address.ts +71 -0
  511. package/src/shipping/contracts/delivery.ts +114 -0
  512. package/src/shipping/contracts/index.ts +19 -0
  513. package/src/shipping/contracts/shippingRate.ts +7 -0
  514. package/src/shipping/contracts/threshold.ts +22 -0
  515. package/src/shipping/customerAddressesHandler.ts +100 -0
  516. package/src/shipping/customerSelfServiceAddressModels.ts +124 -0
  517. package/src/shipping/deliverySelectionHandler.ts +94 -0
  518. package/src/shipping/deliverySelectionPort.ts +10 -0
  519. package/src/shipping/deliverySelectionSummary.ts +56 -0
  520. package/src/shipping/handlerSchemas.ts +19 -0
  521. package/src/shipping/index.ts +26 -0
  522. package/src/shipping/pickupPointSearchPort.ts +8 -0
  523. package/src/shipping/readDeliverySelectionEvidence.ts +51 -0
  524. package/src/shipping/shippingRatePorts.ts +36 -0
  525. package/src/shipping/thresholdPolicy.ts +65 -0
@@ -0,0 +1,244 @@
1
+ import { z } from "./validation.js";
2
+
3
+ import { COMMERCE_CONTRACT_VERSION } from "../pricing/index.js";
4
+
5
+ export const PROMOTION_CODE_STATUSES = ["draft", "active", "paused", "archived"] as const;
6
+ export const PROMOTION_CODE_EFFECTIVE_STATUSES = [
7
+ "active",
8
+ "draft",
9
+ "paused",
10
+ "scheduled",
11
+ "expired",
12
+ "archived",
13
+ ] as const;
14
+ export const PROMOTION_CODE_STATUS_FILTERS = [
15
+ ...PROMOTION_CODE_EFFECTIVE_STATUSES,
16
+ "expired_or_archived",
17
+ ] as const;
18
+ export const PROMOTION_CODE_SCOPES = ["one_time", "subscription_initial"] as const;
19
+
20
+ const nullablePositiveInteger = z.number().int().positive().nullable();
21
+ const maximumPromotionFixedMinor = 2_147_483_647;
22
+ const optionalDateTime = z.string().datetime({ offset: true }).nullable();
23
+ const scopesSchema = z
24
+ .array(z.enum(PROMOTION_CODE_SCOPES))
25
+ .min(1)
26
+ .max(2)
27
+ .refine((scopes) => new Set(scopes).size === scopes.length, {
28
+ message: "Purchase scopes must be unique",
29
+ });
30
+
31
+ const productTargetBenefitSchema = z.union([
32
+ z.object({ lane: z.literal("product"), kind: z.literal("target_percentage"), valueBps: z.number().int().min(1).max(9_999) }).strict(),
33
+ z.object({ lane: z.literal("product"), kind: z.literal("fixed_amount"), valueMinor: z.number().int().positive().max(maximumPromotionFixedMinor) }).strict(),
34
+ ]);
35
+ const shippingBenefitSchema = z.union([
36
+ z.object({ lane: z.literal("shipping"), kind: z.literal("percentage"), valueBps: z.number().int().min(1).max(9_999) }).strict(),
37
+ z.object({ lane: z.literal("shipping"), kind: z.literal("fixed_amount"), valueMinor: z.number().int().positive().max(maximumPromotionFixedMinor) }).strict(),
38
+ z.object({ lane: z.literal("shipping"), kind: z.literal("free_shipping") }).strict(),
39
+ ]);
40
+ export const promotionCodeBenefitSchema = z.union([
41
+ productTargetBenefitSchema,
42
+ shippingBenefitSchema,
43
+ z.object({ lane: z.literal("product"), kind: z.literal("percentage"), valueBps: z.number().int().min(0) }).strict(),
44
+ z.object({ lane: z.literal("shipping"), kind: z.literal("percentage"), valueBps: z.number().int().min(0) }).strict(),
45
+ z.object({ lane: z.literal("product"), kind: z.literal("fixed_amount"), valueMinor: z.number().int().nonnegative() }).strict(),
46
+ z.object({ lane: z.literal("shipping"), kind: z.literal("fixed_amount"), valueMinor: z.number().int().nonnegative() }).strict(),
47
+ z.object({
48
+ lane: z.enum(["product", "shipping"]),
49
+ kind: z.enum(["percentage", "fixed_amount"]),
50
+ validationState: z.literal("unsupported_legacy_value"),
51
+ }).strict(),
52
+ ]);
53
+ const createBenefitSchema = z.union([productTargetBenefitSchema, shippingBenefitSchema]);
54
+
55
+ const benefitsSchema = z
56
+ .array(promotionCodeBenefitSchema)
57
+ .min(1)
58
+ .max(2)
59
+ .refine((benefits) => new Set(benefits.map((benefit) => benefit.lane)).size === benefits.length, {
60
+ message: "Only one benefit per adjustment lane is allowed",
61
+ });
62
+ const createBenefitsSchema = z
63
+ .array(createBenefitSchema)
64
+ .min(1)
65
+ .max(2)
66
+ .refine((benefits) => new Set(benefits.map((benefit) => benefit.lane)).size === benefits.length, {
67
+ message: "Only one benefit per adjustment lane is allowed",
68
+ });
69
+
70
+ export const promotionCodePreviewContextSchema = z
71
+ .object({
72
+ referenceProductMinor: z.number().int().positive(),
73
+ oneTimeProductMinor: z.number().int().positive(),
74
+ subscriptionProductMinor: z.number().int().positive(),
75
+ shippingMinor: z.number().int().nonnegative(),
76
+ })
77
+ .strict()
78
+ .refine((value) => value.oneTimeProductMinor <= value.referenceProductMinor, {
79
+ message: "One-time product price cannot exceed the reference price",
80
+ })
81
+ .refine((value) => value.subscriptionProductMinor <= value.referenceProductMinor, {
82
+ message: "Subscription product price cannot exceed the reference price",
83
+ });
84
+
85
+ export const promotionCodePreviewRequestSchema = z
86
+ .object({
87
+ benefits: benefitsSchema,
88
+ scopes: scopesSchema,
89
+ promotionEngineVersion: z.enum(["promotion-engine.v1", "promotion-engine.v2"]).default("promotion-engine.v2"),
90
+ minimumReferenceMinor: z.number().int().nonnegative().default(0),
91
+ context: promotionCodePreviewContextSchema,
92
+ })
93
+ .strict();
94
+
95
+ export const promotionCodePreviewResultSchema = z.object({
96
+ scope: z.enum(PROMOTION_CODE_SCOPES),
97
+ productPayableMinor: z.number().int().nonnegative(),
98
+ shippingPayableMinor: z.number().int().nonnegative(),
99
+ effectiveProductDiscountBps: z.number().int().min(0).max(10_000),
100
+ winner: z.enum(["code", "automatic"]),
101
+ floorApplied: z.boolean(),
102
+ adjustments: z.array(
103
+ z.object({
104
+ lane: z.enum(["product", "shipping"]),
105
+ kind: z.enum(["target_percentage", "percentage", "fixed_amount", "free_shipping"]),
106
+ amountOffMinor: z.number().int().nonnegative(),
107
+ beforeMinor: z.number().int().nonnegative(),
108
+ afterMinor: z.number().int().nonnegative(),
109
+ }),
110
+ ),
111
+ });
112
+
113
+ export const promotionCodePreviewResponseSchema = z.object({
114
+ contractVersion: z.literal(COMMERCE_CONTRACT_VERSION),
115
+ promotionEngineVersion: z.enum(["promotion-engine.v1", "promotion-engine.v2"]),
116
+ previewProof: z.string().regex(/^[A-Za-z0-9_-]{43}$/),
117
+ results: z.array(promotionCodePreviewResultSchema).length(2),
118
+ });
119
+
120
+ export const promotionCodeCreateRequestSchema = z
121
+ .object({
122
+ name: z.string().trim().min(1).max(120),
123
+ description: z.string().trim().max(500).nullable().default(null),
124
+ code: z.discriminatedUnion("kind", [
125
+ z.object({ kind: z.literal("automatic") }).strict(),
126
+ z.object({ kind: z.literal("manual"), value: z.string().trim().min(3).max(64).regex(/^[A-Za-z0-9_-]+$/) }).strict(),
127
+ ]),
128
+ benefits: createBenefitsSchema,
129
+ scopes: scopesSchema,
130
+ validFrom: z.string().datetime({ offset: true }),
131
+ validTo: optionalDateTime,
132
+ minimumReferenceMinor: z.number().int().nonnegative().default(0),
133
+ redemptionLimitGlobal: nullablePositiveInteger.default(null),
134
+ redemptionLimitPerCustomer: nullablePositiveInteger.default(null),
135
+ status: z.enum(["draft", "active"]).default("draft"),
136
+ previewContext: promotionCodePreviewContextSchema.optional(),
137
+ previewProof: z.string().regex(/^[A-Za-z0-9_-]{43}$/).optional(),
138
+ idempotencyKey: z.string().uuid(),
139
+ })
140
+ .strict()
141
+ .refine((value) => value.validTo === null || Date.parse(value.validTo) > Date.parse(value.validFrom), {
142
+ message: "validTo must be after validFrom",
143
+ })
144
+ .refine(
145
+ (value) => value.status !== "active" || Boolean(value.previewContext && value.previewProof),
146
+ { message: "Active codes require a successful backend preview" },
147
+ );
148
+
149
+ export const promotionCodeCreateResponseSchema = z.object({
150
+ contractVersion: z.literal(COMMERCE_CONTRACT_VERSION),
151
+ id: z.string().uuid(),
152
+ code: z.string().min(3).max(64),
153
+ status: z.enum(PROMOTION_CODE_STATUSES),
154
+ revision: z.number().int().positive(),
155
+ idempotent: z.boolean(),
156
+ });
157
+
158
+ export const promotionCodeUpdateRequestSchema = z
159
+ .object({
160
+ id: z.string().uuid(),
161
+ expectedRevision: z.number().int().positive(),
162
+ updates: z
163
+ .object({
164
+ status: z.enum(PROMOTION_CODE_STATUSES).optional(),
165
+ validFrom: z.string().datetime({ offset: true }).optional(),
166
+ validTo: optionalDateTime.optional(),
167
+ redemptionLimitGlobal: nullablePositiveInteger.optional(),
168
+ redemptionLimitPerCustomer: nullablePositiveInteger.optional(),
169
+ })
170
+ .strict()
171
+ .refine((updates) => Object.values(updates).some((value) => value !== undefined), {
172
+ message: "At least one field is required",
173
+ }),
174
+ previewContext: promotionCodePreviewContextSchema.optional(),
175
+ previewProof: z.string().regex(/^[A-Za-z0-9_-]{43}$/).optional(),
176
+ idempotencyKey: z.string().uuid(),
177
+ })
178
+ .strict()
179
+ ;
180
+
181
+ export const promotionCodeUpdateResponseSchema = z.object({
182
+ contractVersion: z.literal(COMMERCE_CONTRACT_VERSION),
183
+ id: z.string().uuid(),
184
+ status: z.enum(PROMOTION_CODE_STATUSES),
185
+ revision: z.number().int().positive(),
186
+ idempotent: z.boolean(),
187
+ });
188
+
189
+ export const promotionCodesListRequestSchema = z
190
+ .object({
191
+ q: z.string().trim().min(1).max(80).optional(),
192
+ status: z.enum([...PROMOTION_CODE_STATUS_FILTERS, "all"]).default("active"),
193
+ scope: z.enum([...PROMOTION_CODE_SCOPES, "both", "shipping", "all"]).default("all"),
194
+ cursor: z.string().max(500).optional(),
195
+ limit: z.coerce.number().int().min(1).max(100).default(25),
196
+ })
197
+ .strict();
198
+
199
+ export const promotionCodeSummarySchema = z.object({
200
+ id: z.string().uuid(),
201
+ code: z.string(),
202
+ name: z.string(),
203
+ description: z.string().nullable(),
204
+ benefits: benefitsSchema,
205
+ promotionEngineVersion: z.enum(["promotion-engine.v1", "promotion-engine.v2"]),
206
+ scopes: scopesSchema,
207
+ status: z.enum(PROMOTION_CODE_STATUSES),
208
+ effectiveStatus: z.enum(PROMOTION_CODE_EFFECTIVE_STATUSES),
209
+ validFrom: z.string(),
210
+ validTo: z.string().nullable(),
211
+ minimumReferenceMinor: z.number().int().nonnegative(),
212
+ redemptionLimitGlobal: z.number().int().positive().nullable(),
213
+ redemptionLimitPerCustomer: z.number().int().positive().nullable(),
214
+ redeemedCount: z.number().int().nonnegative(),
215
+ reservedCount: z.number().int().nonnegative(),
216
+ remainingCount: z.number().int().nonnegative().nullable(),
217
+ createdAt: z.string(),
218
+ revision: z.number().int().positive(),
219
+ });
220
+
221
+ export const promotionCodesListResponseSchema = z.object({
222
+ contractVersion: z.literal(COMMERCE_CONTRACT_VERSION),
223
+ codes: z.array(promotionCodeSummarySchema),
224
+ nextCursor: z.string().nullable(),
225
+ capabilities: z.object({
226
+ mutationsEnabled: z.boolean(),
227
+ }).strict(),
228
+ legacyCompatibility: z.object({
229
+ ready: z.boolean(),
230
+ unprojectedCount: z.number().int().nonnegative(),
231
+ collisionGroupCount: z.number().int().nonnegative(),
232
+ }).strict(),
233
+ });
234
+
235
+ export type PromotionCodeBenefit = z.infer<typeof promotionCodeBenefitSchema>;
236
+ export type PromotionCodePreviewRequest = z.infer<typeof promotionCodePreviewRequestSchema>;
237
+ export type PromotionCodePreviewResponse = z.infer<typeof promotionCodePreviewResponseSchema>;
238
+ export type PromotionCodeCreateRequest = z.infer<typeof promotionCodeCreateRequestSchema>;
239
+ export type PromotionCodeCreateResponse = z.infer<typeof promotionCodeCreateResponseSchema>;
240
+ export type PromotionCodeUpdateRequest = z.infer<typeof promotionCodeUpdateRequestSchema>;
241
+ export type PromotionCodeUpdateResponse = z.infer<typeof promotionCodeUpdateResponseSchema>;
242
+ export type PromotionCodesListRequest = z.infer<typeof promotionCodesListRequestSchema>;
243
+ export type PromotionCodeSummary = z.infer<typeof promotionCodeSummarySchema>;
244
+ export type PromotionCodesListResponse = z.infer<typeof promotionCodesListResponseSchema>;
@@ -0,0 +1,56 @@
1
+ import type {
2
+ PromotionCodeCreateRequest,
3
+ PromotionCodeSummary,
4
+ PromotionCodesListRequest,
5
+ PromotionCodeUpdateRequest,
6
+ } from "./contracts/index.js";
7
+
8
+ export interface PromotionCodesListResult {
9
+ codes: PromotionCodeSummary[];
10
+ nextCursor: string | null;
11
+ legacyCompatibility: {
12
+ ready: boolean;
13
+ unprojectedCount: number;
14
+ collisionGroupCount: number;
15
+ };
16
+ }
17
+
18
+ export interface PromotionCodeCreateResult {
19
+ id: string;
20
+ code: string;
21
+ status: "draft" | "active" | "paused" | "archived";
22
+ idempotent: boolean;
23
+ revision: number;
24
+ }
25
+
26
+ export interface PromotionCodeUpdateResult {
27
+ id: string;
28
+ status: "draft" | "active" | "paused" | "archived";
29
+ idempotent: boolean;
30
+ revision: number;
31
+ }
32
+
33
+ export interface AdminPromotionCodesDataPort {
34
+ list(actorId: string, input: PromotionCodesListRequest): Promise<PromotionCodesListResult>;
35
+ definition(actorId: string, id: string): Promise<{
36
+ benefits: PromotionCodeSummary["benefits"];
37
+ scopes: PromotionCodeCreateRequest["scopes"];
38
+ minimumReferenceMinor: number;
39
+ revision: number;
40
+ status: "draft" | "active" | "paused" | "archived";
41
+ validFrom: string;
42
+ validTo: string | null;
43
+ promotionEngineVersion: "promotion-engine.v1" | "promotion-engine.v2";
44
+ }>;
45
+ create(input: {
46
+ actorId: string;
47
+ request: PromotionCodeCreateRequest;
48
+ resolvedCode: string;
49
+ requestFingerprint: string;
50
+ }): Promise<PromotionCodeCreateResult>;
51
+ update(input: {
52
+ actorId: string;
53
+ request: PromotionCodeUpdateRequest;
54
+ requestFingerprint: string;
55
+ }): Promise<PromotionCodeUpdateResult>;
56
+ }
@@ -0,0 +1,254 @@
1
+ import { createHash } from "node:crypto";
2
+ import {
3
+ promotionCodeCreateRequestSchema,
4
+ promotionCodeCreateResponseSchema,
5
+ promotionCodePreviewRequestSchema,
6
+ promotionCodePreviewResponseSchema,
7
+ promotionCodesListRequestSchema,
8
+ promotionCodesListResponseSchema,
9
+ promotionCodeUpdateRequestSchema,
10
+ promotionCodeUpdateResponseSchema,
11
+ type PromotionCodeCreateRequest,
12
+ type PromotionCodePreviewRequest,
13
+ type PromotionCodesListRequest,
14
+ type PromotionCodeUpdateRequest,
15
+ } from "./adminPromotionCodesContracts.js";
16
+ import { COMMERCE_CONTRACT_VERSION } from "../pricing/index.js";
17
+ import type {
18
+ AgentDomainMutationSpec,
19
+ AgentDomainQuerySpec,
20
+ } from "./adminBindings.js";
21
+ import type { AuthorizeAdmin, PromotionAdminBindings } from "./adminBindings.js";
22
+ import type { HttpRequest as VercelRequest, HttpResponse as VercelResponse } from "../http/index.js";
23
+ import type { AdminPromotionCodesDataPort } from "./adminPromotionCodesDataPort.js";
24
+ export interface AdminPromotionCodesHandlerDeps {
25
+ dataPort: AdminPromotionCodesDataPort;
26
+ authorizeAdmin: AuthorizeAdmin;
27
+ previewSecret: string;
28
+ }
29
+
30
+ export function createAdminPromotionCodesHandlers({ createAdminMutationHandler, createAdminParameterizedReadHandler, mapRpcError, DomainRpcError, resolveAdmin, sendBffError, sendBffSuccess, sendMethodNotAllowed, generatePromotionCode, normalizePromotionCode, previewPromotionCode, verifyPromotionPreviewProof }: Omit<PromotionAdminBindings, "createAdminReadHandler">) {
31
+ /**
32
+ * The Promotion Code Center is a permanent part of the service, so these handlers are unconditional: the
33
+ * `enabled` / `flagName` / `disabledMessage` options of the admin-domain kit are
34
+ * omitted, which the kit reads as "always run the handler". The human-actor gate
35
+ * on create/update below is a security control, not rollout gating, and stays.
36
+ */
37
+ const listSpec: AgentDomainQuerySpec<PromotionCodesListRequest> = {
38
+ key: "list",
39
+ requestSchema: promotionCodesListRequestSchema,
40
+ gate: "read",
41
+ allowedActorKinds: ["human", "machine"],
42
+ };
43
+
44
+ const createSpec: AgentDomainMutationSpec<PromotionCodeCreateRequest> = {
45
+ key: "create",
46
+ requestSchema: promotionCodeCreateRequestSchema,
47
+ gate: "mutation",
48
+ allowedActorKinds: ["human"],
49
+ lifecycleMarkers: [],
50
+ };
51
+
52
+ const updateSpec: AgentDomainMutationSpec<PromotionCodeUpdateRequest> = {
53
+ key: "update",
54
+ requestSchema: promotionCodeUpdateRequestSchema,
55
+ gate: "mutation",
56
+ allowedActorKinds: ["human"],
57
+ lifecycleMarkers: [],
58
+ };
59
+
60
+ function createAdminPromotionCodesListHandler(deps: AdminPromotionCodesHandlerDeps) {
61
+ return createAdminParameterizedReadHandler({
62
+ query: listSpec,
63
+ authorizeAdmin: deps.authorizeAdmin,
64
+ load: (actorId, input) => deps.dataPort.list(actorId, input),
65
+ toResponse: (result) => ({
66
+ contractVersion: COMMERCE_CONTRACT_VERSION,
67
+ ...result,
68
+ // Kept on the wire (constant `true`) so a browser bundle built before the
69
+ // rollout flags were retired still parses this response unchanged.
70
+ capabilities: { mutationsEnabled: true },
71
+ }),
72
+ responseSchema: promotionCodesListResponseSchema,
73
+ invalidRequestMessage: "Invalid promotion code list request",
74
+ invalidResponseMessage: "Invalid promotion code list response",
75
+ failureMessage: "Promotion code list failed",
76
+ mapError: mapPromotionCodeError,
77
+ });
78
+ }
79
+
80
+ function createAdminPromotionCodePreviewHandler(
81
+ deps: Pick<AdminPromotionCodesHandlerDeps, "authorizeAdmin" | "previewSecret">,
82
+ ) {
83
+ return async (req: VercelRequest, res: VercelResponse): Promise<void> => {
84
+ if (req.method !== "POST") return sendMethodNotAllowed(res, ["POST"]);
85
+ if (!(await resolveAdmin(deps.authorizeAdmin, res))) return;
86
+ const parsed = promotionCodePreviewRequestSchema.safeParse(req.body);
87
+ if (!parsed.success) {
88
+ sendBffError(res, "BAD_REQUEST", "Invalid promotion code preview request", {
89
+ details: parsed.error.flatten(),
90
+ });
91
+ return;
92
+ }
93
+ try {
94
+ const result = promotionCodePreviewResponseSchema.parse(
95
+ previewPromotionCode(parsed.data, deps.previewSecret),
96
+ );
97
+ sendBffSuccess(res, result);
98
+ } catch (error) {
99
+ mapPromotionCodeError(res, error, "Promotion code preview failed");
100
+ }
101
+ };
102
+ }
103
+
104
+ function createAdminPromotionCodeCreateHandler(deps: AdminPromotionCodesHandlerDeps) {
105
+ return createAdminMutationHandler({
106
+ mutation: createSpec,
107
+ authorizeAdmin: deps.authorizeAdmin,
108
+ invoke: async (actorId, request) => {
109
+ verifyActivationPreview(request, deps.previewSecret);
110
+ const resolvedCode = normalizePromotionCode(
111
+ request.code.kind === "automatic" ? generatePromotionCode() : request.code.value,
112
+ );
113
+ return deps.dataPort.create({
114
+ actorId,
115
+ request,
116
+ resolvedCode,
117
+ requestFingerprint: mutationFingerprint(request),
118
+ });
119
+ },
120
+ toResponse: (result) => ({ contractVersion: COMMERCE_CONTRACT_VERSION, ...result }),
121
+ responseSchema: promotionCodeCreateResponseSchema,
122
+ invalidRequestMessage: "Invalid promotion code create request",
123
+ invalidResponseMessage: "Invalid promotion code create response",
124
+ failureMessage: "Promotion code create failed",
125
+ mapError: mapPromotionCodeError,
126
+ });
127
+ }
128
+
129
+ function createAdminPromotionCodeUpdateHandler(deps: AdminPromotionCodesHandlerDeps) {
130
+ return createAdminMutationHandler({
131
+ mutation: updateSpec,
132
+ authorizeAdmin: deps.authorizeAdmin,
133
+ invoke: async (actorId, request) => {
134
+ await verifyUpdateLifecycle(deps.dataPort, actorId, request, deps.previewSecret);
135
+ return deps.dataPort.update({
136
+ actorId,
137
+ request,
138
+ requestFingerprint: mutationFingerprint(request),
139
+ });
140
+ },
141
+ toResponse: (result) => ({ contractVersion: COMMERCE_CONTRACT_VERSION, ...result }),
142
+ responseSchema: promotionCodeUpdateResponseSchema,
143
+ invalidRequestMessage: "Invalid promotion code update request",
144
+ invalidResponseMessage: "Invalid promotion code update response",
145
+ failureMessage: "Promotion code update failed",
146
+ mapError: mapPromotionCodeError,
147
+ });
148
+ }
149
+
150
+ function verifyActivationPreview(request: PromotionCodeCreateRequest, secret: string): void {
151
+ if (request.status !== "active") return;
152
+ if (!request.previewContext || !request.previewProof) {
153
+ throw new DomainRpcError("22023", "promotion_preview_required");
154
+ }
155
+ const previewInput: PromotionCodePreviewRequest = {
156
+ benefits: request.benefits,
157
+ scopes: request.scopes,
158
+ promotionEngineVersion: "promotion-engine.v2",
159
+ minimumReferenceMinor: request.minimumReferenceMinor,
160
+ context: request.previewContext,
161
+ };
162
+ previewPromotionCode(previewInput, secret);
163
+ if (!verifyPromotionPreviewProof(previewInput, request.previewProof, secret)) {
164
+ throw new DomainRpcError("22023", "promotion_preview_proof_mismatch");
165
+ }
166
+ }
167
+
168
+ async function verifyUpdateLifecycle(
169
+ dataPort: AdminPromotionCodesDataPort,
170
+ actorId: string,
171
+ request: PromotionCodeUpdateRequest,
172
+ secret: string,
173
+ ): Promise<void> {
174
+ const definition = await dataPort.definition(actorId, request.id);
175
+ if (definition.revision !== request.expectedRevision) {
176
+ // Let the transactional RPC decide between an idempotent replay (whose
177
+ // original revision is now stale by definition) and a genuine 409.
178
+ return;
179
+ }
180
+ const resultingValidFrom = request.updates.validFrom ?? definition.validFrom;
181
+ const resultingValidTo = request.updates.validTo === undefined
182
+ ? definition.validTo
183
+ : request.updates.validTo;
184
+ if (resultingValidTo !== null && Date.parse(resultingValidTo) <= Date.parse(resultingValidFrom)) {
185
+ throw new DomainRpcError("22023", "promotion_code_invalid_validity_window");
186
+ }
187
+ const beforeEffective = isEffectivelyActive(
188
+ definition.status,
189
+ definition.validFrom,
190
+ definition.validTo,
191
+ );
192
+ const afterEffective = isEffectivelyActive(
193
+ request.updates.status ?? definition.status,
194
+ resultingValidFrom,
195
+ resultingValidTo,
196
+ );
197
+ const transitionsToActiveStatus = definition.status !== "active"
198
+ && (request.updates.status ?? definition.status) === "active";
199
+ if (!transitionsToActiveStatus && (beforeEffective || !afterEffective)) return;
200
+ if (!request.previewContext || !request.previewProof) {
201
+ throw new DomainRpcError("22023", "promotion_preview_required");
202
+ }
203
+ const actualPreview = {
204
+ benefits: definition.benefits,
205
+ scopes: definition.scopes,
206
+ promotionEngineVersion: definition.promotionEngineVersion,
207
+ minimumReferenceMinor: definition.minimumReferenceMinor,
208
+ context: request.previewContext,
209
+ };
210
+ previewPromotionCode(actualPreview, secret);
211
+ if (!verifyPromotionPreviewProof(actualPreview, request.previewProof, secret)) {
212
+ throw new DomainRpcError("22023", "promotion_preview_proof_mismatch");
213
+ }
214
+ }
215
+
216
+ function isEffectivelyActive(
217
+ status: "draft" | "active" | "paused" | "archived",
218
+ validFrom: string,
219
+ validTo: string | null,
220
+ now = Date.now(),
221
+ ): boolean {
222
+ return status === "active"
223
+ && Date.parse(validFrom) <= now
224
+ && (validTo === null || Date.parse(validTo) > now);
225
+ }
226
+
227
+ function mapPromotionCodeError(
228
+ res: VercelResponse,
229
+ error: unknown,
230
+ failureMessage: string,
231
+ ): void {
232
+ if (error instanceof DomainRpcError && error.sqlstate === "22023") {
233
+ sendBffError(res, "BAD_REQUEST", error.pgMessage, {
234
+ details: { reason: error.pgMessage },
235
+ });
236
+ return;
237
+ }
238
+ if (error instanceof RangeError) {
239
+ sendBffError(res, "BAD_REQUEST", error.message, {
240
+ details: { reason: error.message },
241
+ });
242
+ return;
243
+ }
244
+ mapRpcError(res, error, failureMessage);
245
+ }
246
+
247
+ function mutationFingerprint(request: PromotionCodeCreateRequest | PromotionCodeUpdateRequest): string {
248
+ const sanitized = "code" in request && request.code.kind === "automatic"
249
+ ? { ...request, code: { kind: "automatic" } }
250
+ : request;
251
+ return createHash("sha256").update(JSON.stringify(sanitized)).digest("hex");
252
+ }
253
+ return { createAdminPromotionCodesListHandler, createAdminPromotionCodePreviewHandler, createAdminPromotionCodeCreateHandler, createAdminPromotionCodeUpdateHandler };
254
+ }
@@ -0,0 +1,121 @@
1
+
2
+ import { z } from "./validation.js";
3
+
4
+ import {
5
+ PROMOTION_APPLIES_TO_KINDS,
6
+ PROMOTION_DISCOUNT_TYPES,
7
+ PROMOTION_STACKING_RULES,
8
+ PROMOTION_TRIGGER_TYPES,
9
+ } from "@openlup/core/promo";
10
+
11
+ import { COMMERCE_CONTRACT_VERSION } from "../pricing/index.js";
12
+
13
+ /** Admin promotion schemas; raw adapter rows never cross this boundary. */
14
+
15
+
16
+ export function createAdminPromotionSchemas({ currencySchema: platformCurrencySchema }: { currencySchema: z.ZodType<string> }) {
17
+ const PROMOTION_STATUSES = ["draft", "active", "paused", "archived"] as const;
18
+
19
+ const jsonObjectSchema = z.record(z.string(), z.unknown());
20
+
21
+ const adminPromotionUnitTargetSchema = z.object({
22
+ variantId: z.string().min(1),
23
+ sku: z.string().nullable(),
24
+ referenceMinor: z.number().int().positive(),
25
+ targetMinor: z.number().int().nonnegative(),
26
+ currency: platformCurrencySchema,
27
+ });
28
+
29
+ const adminPromotionSemanticBenefitSchema = z.discriminatedUnion("kind", [
30
+ z.object({
31
+ kind: z.literal("target_percentage"),
32
+ valueBps: z.number().int().min(1).max(9_999),
33
+ reference: z.literal("catalog_list_price"),
34
+ unitTargets: z.array(adminPromotionUnitTargetSchema),
35
+ }),
36
+ z.object({
37
+ kind: z.literal("percentage"),
38
+ valuePercent: z.number().nonnegative(),
39
+ }),
40
+ z.object({
41
+ kind: z.literal("fixed_amount"),
42
+ valueMinor: z.number().nonnegative(),
43
+ currency: platformCurrencySchema,
44
+ }),
45
+ z.object({ kind: z.literal("free_shipping") }),
46
+ z.object({
47
+ kind: z.literal("unavailable"),
48
+ reason: z.literal("system_managed_metadata_incomplete"),
49
+ }),
50
+ ]);
51
+
52
+ /**
53
+ * Engine-v2 mirror paired to a system-managed legacy row. Exposes only what the
54
+ * deliberate human-operator activation/pause control needs; mirror semantics stay read-only.
55
+ */
56
+ const adminPromotionV2MirrorSchema = z.object({
57
+ id: z.string().min(1),
58
+ status: z.enum(PROMOTION_STATUSES),
59
+ });
60
+
61
+ /** One promotion as shown in the admin editor. */
62
+ const adminPromotionSchema = z.object({
63
+ id: z.string().min(1),
64
+ code: z.string().nullable(),
65
+ name: z.string(),
66
+ triggerType: z.enum(PROMOTION_TRIGGER_TYPES),
67
+ discountType: z.enum(PROMOTION_DISCOUNT_TYPES),
68
+ semanticBenefit: adminPromotionSemanticBenefitSchema,
69
+ systemManaged: z.boolean(),
70
+ readOnly: z.boolean(),
71
+ v2Mirror: adminPromotionV2MirrorSchema.nullable(),
72
+ appliesToKind: z.enum(PROMOTION_APPLIES_TO_KINDS),
73
+ stackingRule: z.enum(PROMOTION_STACKING_RULES),
74
+ eligibility: jsonObjectSchema,
75
+ validFrom: z.string(),
76
+ validTo: z.string().nullable(),
77
+ status: z.enum(PROMOTION_STATUSES),
78
+ regionAvailability: z.array(z.string()),
79
+ redemptionLimitGlobal: z.number().nullable(),
80
+ redemptionLimitPerCustomer: z.number().nullable(),
81
+ });
82
+
83
+ const adminPromotionsListResponseSchema = z.object({
84
+ contractVersion: z.literal(COMMERCE_CONTRACT_VERSION),
85
+ promotions: z.array(adminPromotionSchema),
86
+ });
87
+
88
+ /** Editable fields. Trigger/discount type and code are fixed in v1 (edit, not recreate). */
89
+ const adminPromotionUpdatePayloadSchema = z
90
+ .object({
91
+ name: z.string().trim().min(1).optional(),
92
+ discountValue: z.number().min(0).optional(),
93
+ stackingRule: z.enum(PROMOTION_STACKING_RULES).optional(),
94
+ status: z.enum(PROMOTION_STATUSES).optional(),
95
+ eligibility: jsonObjectSchema.optional(),
96
+ validFrom: z.string().optional(),
97
+ validTo: z.string().nullable().optional(),
98
+ redemptionLimitGlobal: z.number().int().positive().nullable().optional(),
99
+ redemptionLimitPerCustomer: z.number().int().positive().nullable().optional(),
100
+ })
101
+ .strict()
102
+ .refine((updates) => Object.values(updates).some((value) => value !== undefined), {
103
+ message: "At least one promotion field is required",
104
+ });
105
+
106
+ const adminPromotionUpdateRequestSchema = z
107
+ .object({
108
+ id: z.string().trim().min(1),
109
+ updates: adminPromotionUpdatePayloadSchema,
110
+ })
111
+ .strict();
112
+
113
+ const adminPromotionUpdateResponseSchema = z.object({
114
+ contractVersion: z.literal(COMMERCE_CONTRACT_VERSION),
115
+ updated: z.literal(true),
116
+ id: z.string().min(1),
117
+ });
118
+
119
+
120
+ return { PROMOTION_STATUSES, adminPromotionSemanticBenefitSchema, adminPromotionV2MirrorSchema, adminPromotionSchema, adminPromotionsListResponseSchema, adminPromotionUpdatePayloadSchema, adminPromotionUpdateRequestSchema, adminPromotionUpdateResponseSchema };
121
+ }