@shopify/ui-extensions 2025.10.7 → 2025.10.9

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 (287) hide show
  1. package/build/cjs/surfaces/point-of-sale/types/storage.js +3 -0
  2. package/build/esm/surfaces/point-of-sale/types/storage.mjs +3 -0
  3. package/build/esnext/surfaces/point-of-sale/types/storage.esnext +3 -0
  4. package/build/ts/shared.d.ts +7 -7
  5. package/build/ts/shared.d.ts.map +1 -1
  6. package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map +1 -1
  7. package/build/ts/surfaces/admin/components/Badge/Badge.doc.d.ts.map +1 -1
  8. package/build/ts/surfaces/admin/components/Banner/Banner.doc.d.ts.map +1 -1
  9. package/build/ts/surfaces/admin/components/Box/Box.doc.d.ts.map +1 -1
  10. package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map +1 -1
  11. package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -1
  12. package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
  13. package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts.map +1 -1
  14. package/build/ts/surfaces/admin/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
  15. package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -1
  16. package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts.map +1 -1
  17. package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts.map +1 -1
  18. package/build/ts/surfaces/admin/components/DateField/DateField.doc.d.ts.map +1 -1
  19. package/build/ts/surfaces/admin/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
  20. package/build/ts/surfaces/admin/components/DropZone/{DropZone.ab.doc.d.ts → DropZone.doc.d.ts} +1 -1
  21. package/build/ts/surfaces/admin/components/DropZone/DropZone.doc.d.ts.map +1 -0
  22. package/build/ts/surfaces/admin/components/Grid/Grid.doc.d.ts.map +1 -1
  23. package/build/ts/surfaces/admin/components/Icon/Icon.doc.d.ts.map +1 -1
  24. package/build/ts/surfaces/admin/components/Image/Image.doc.d.ts.map +1 -1
  25. package/build/ts/surfaces/admin/components/Link/Link.doc.d.ts.map +1 -1
  26. package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts.map +1 -1
  27. package/build/ts/surfaces/admin/components/Modal/Modal.ab.doc.d.ts.map +1 -1
  28. package/build/ts/surfaces/admin/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
  29. package/build/ts/surfaces/admin/components/Page/Page.ab.doc.d.ts.map +1 -1
  30. package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts.map +1 -1
  31. package/build/ts/surfaces/admin/components/SearchField/SearchField.doc.d.ts.map +1 -1
  32. package/build/ts/surfaces/admin/components/Spinner/Spinner.doc.d.ts.map +1 -1
  33. package/build/ts/surfaces/admin/components/Stack/Stack.doc.d.ts.map +1 -1
  34. package/build/ts/surfaces/admin/components/Table/Table.doc.d.ts.map +1 -1
  35. package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map +1 -1
  36. package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map +1 -1
  37. package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts.map +1 -1
  38. package/build/ts/surfaces/admin/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
  39. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts +3 -5
  40. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -1
  41. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +38 -33
  42. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
  43. package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +2 -2
  44. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +6 -4
  45. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -1
  46. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +4 -1
  47. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -1
  48. package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +4 -4
  49. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +6 -3
  50. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -1
  51. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +2 -3
  52. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -1
  53. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +22 -8
  54. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -1
  55. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +5 -5
  56. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +6 -10
  57. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -1
  58. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +10 -11
  59. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
  60. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +5 -2
  61. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -1
  62. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +24 -10
  63. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -1
  64. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +26 -8
  65. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -1
  66. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +3 -6
  67. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -1
  68. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +2 -0
  69. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
  70. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +3 -0
  71. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -1
  72. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +11 -1
  73. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -1
  74. package/build/ts/surfaces/point-of-sale/api.d.ts +1 -1
  75. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
  76. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts.map +1 -1
  77. package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +23 -4
  78. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts.map +1 -1
  79. package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +24 -6
  80. package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts.map +1 -1
  81. package/build/ts/surfaces/point-of-sale/components/Box.d.ts +34 -37
  82. package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts.map +1 -1
  83. package/build/ts/surfaces/point-of-sale/components/Button.d.ts +56 -16
  84. package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +14 -2
  85. package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
  86. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +41 -5
  87. package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts.map +1 -1
  88. package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +40 -4
  89. package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map +1 -1
  90. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +42 -6
  91. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
  92. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +42 -6
  93. package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map +1 -1
  94. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +42 -6
  95. package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts.map +1 -1
  96. package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +14 -2
  97. package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map +1 -1
  98. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +43 -7
  99. package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts.map +1 -1
  100. package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +15 -3
  101. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts.map +1 -1
  102. package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +17 -2
  103. package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts.map +1 -1
  104. package/build/ts/surfaces/point-of-sale/components/Image.d.ts +6 -3
  105. package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts.map +1 -1
  106. package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +43 -11
  107. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map +1 -1
  108. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +56 -41
  109. package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts.map +1 -1
  110. package/build/ts/surfaces/point-of-sale/components/Page.d.ts +19 -7
  111. package/build/ts/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.d.ts.map +1 -1
  112. package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +16 -4
  113. package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +14 -2
  114. package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -1
  115. package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +33 -36
  116. package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map +1 -1
  117. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +42 -6
  118. package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts.map +1 -1
  119. package/build/ts/surfaces/point-of-sale/components/Section.d.ts +17 -7
  120. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts.map +1 -1
  121. package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +47 -61
  122. package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts.map +1 -1
  123. package/build/ts/surfaces/point-of-sale/components/Text.d.ts +28 -6
  124. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map +1 -1
  125. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +43 -7
  126. package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map +1 -1
  127. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +43 -7
  128. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts.map +1 -1
  129. package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +40 -4
  130. package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts.map +1 -1
  131. package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +42 -6
  132. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map +1 -1
  133. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +42 -6
  134. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +638 -878
  135. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +1 -1
  136. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
  137. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
  138. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
  139. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +15 -0
  140. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
  141. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +6 -0
  142. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
  143. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +27 -0
  144. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
  145. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +18 -0
  146. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
  147. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +9 -0
  148. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
  149. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +18 -0
  150. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
  151. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +12 -0
  152. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
  153. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +27 -0
  154. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  155. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +17 -0
  156. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
  157. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +135 -0
  158. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
  159. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +43 -0
  160. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
  161. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +227 -31
  162. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  163. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +3 -0
  164. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
  165. package/build/ts/surfaces/point-of-sale/types/device.d.ts +6 -3
  166. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
  167. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +3 -3
  168. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +6 -0
  169. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
  170. package/build/ts/surfaces/point-of-sale/types/money.d.ts +18 -0
  171. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
  172. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -2
  173. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
  174. package/build/ts/surfaces/point-of-sale/types/order.d.ts +18 -0
  175. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
  176. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +2 -3
  177. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
  178. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +15 -0
  179. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
  180. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +36 -16
  181. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -1
  182. package/build/ts/surfaces/point-of-sale/types/product.d.ts +170 -0
  183. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
  184. package/build/ts/surfaces/point-of-sale/types/session.d.ts +7 -5
  185. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
  186. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +32 -0
  187. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
  188. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +13 -11
  189. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  190. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +21 -0
  191. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
  192. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +7 -0
  193. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
  194. package/build/tsconfig.tsbuildinfo +1 -1
  195. package/package.json +6 -1
  196. package/src/shared.ts +7 -7
  197. package/src/surfaces/admin/api/intents/examples/edit-metafield-definition.js +1 -0
  198. package/src/surfaces/admin/api/intents/examples/edit-metaobject-definition.js +1 -1
  199. package/src/surfaces/admin/components/Icon/icon-data.json +9 -0
  200. package/src/surfaces/admin/components/Page/examples/page-with-breadcrumbs-and-title.html +7 -0
  201. package/src/surfaces/admin/components/Page/examples/page-with-breadcrumbs-and-title.jsx +7 -0
  202. package/src/surfaces/admin/components/Page/examples/page-with-secondary-actions.html +8 -0
  203. package/src/surfaces/admin/components/Page/examples/page-with-secondary-actions.jsx +8 -0
  204. package/src/surfaces/point-of-sale/api/action-api/action-api.ts +3 -5
  205. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +38 -33
  206. package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +2 -2
  207. package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +6 -4
  208. package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +4 -1
  209. package/src/surfaces/point-of-sale/api/device-api/device-api.ts +4 -4
  210. package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +6 -3
  211. package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +2 -3
  212. package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +23 -8
  213. package/src/surfaces/point-of-sale/api/order-api/order-api.ts +5 -5
  214. package/src/surfaces/point-of-sale/api/pin-pad-api.ts +6 -10
  215. package/src/surfaces/point-of-sale/api/print-api/print-api.ts +10 -11
  216. package/src/surfaces/point-of-sale/api/product-api/product-api.ts +5 -2
  217. package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +24 -10
  218. package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +26 -8
  219. package/src/surfaces/point-of-sale/api/session-api/session-api.ts +3 -6
  220. package/src/surfaces/point-of-sale/api/standard/standard-api.ts +2 -0
  221. package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +3 -0
  222. package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +11 -1
  223. package/src/surfaces/point-of-sale/api.ts +1 -0
  224. package/src/surfaces/point-of-sale/components/Badge.d.ts +23 -4
  225. package/src/surfaces/point-of-sale/components/Banner.d.ts +24 -6
  226. package/src/surfaces/point-of-sale/components/Box.d.ts +34 -37
  227. package/src/surfaces/point-of-sale/components/Button.d.ts +56 -16
  228. package/src/surfaces/point-of-sale/components/Choice.d.ts +14 -2
  229. package/src/surfaces/point-of-sale/components/ChoiceList/examples/composed-choices.jsx +35 -0
  230. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +41 -5
  231. package/src/surfaces/point-of-sale/components/Clickable.d.ts +40 -4
  232. package/src/surfaces/point-of-sale/components/DateField.d.ts +42 -6
  233. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +42 -6
  234. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +42 -6
  235. package/src/surfaces/point-of-sale/components/Divider.d.ts +14 -2
  236. package/src/surfaces/point-of-sale/components/EmailField.d.ts +43 -7
  237. package/src/surfaces/point-of-sale/components/Heading.d.ts +15 -3
  238. package/src/surfaces/point-of-sale/components/Icon.d.ts +17 -2
  239. package/src/surfaces/point-of-sale/components/Image.d.ts +6 -3
  240. package/src/surfaces/point-of-sale/components/Modal.d.ts +43 -11
  241. package/src/surfaces/point-of-sale/components/NumberField.d.ts +56 -41
  242. package/src/surfaces/point-of-sale/components/Page.d.ts +19 -7
  243. package/src/surfaces/point-of-sale/components/PosBlock.d.ts +16 -4
  244. package/src/surfaces/point-of-sale/components/QrCode.d.ts +14 -2
  245. package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +33 -36
  246. package/src/surfaces/point-of-sale/components/SearchField.d.ts +42 -6
  247. package/src/surfaces/point-of-sale/components/Section.d.ts +17 -7
  248. package/src/surfaces/point-of-sale/components/Stack.d.ts +47 -61
  249. package/src/surfaces/point-of-sale/components/Text.d.ts +28 -6
  250. package/src/surfaces/point-of-sale/components/TextArea.d.ts +43 -7
  251. package/src/surfaces/point-of-sale/components/TextField.d.ts +43 -7
  252. package/src/surfaces/point-of-sale/components/Tile.d.ts +40 -4
  253. package/src/surfaces/point-of-sale/components/TimeField.d.ts +42 -6
  254. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +42 -6
  255. package/src/surfaces/point-of-sale/components/components-shared.d.ts +638 -878
  256. package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -1
  257. package/src/surfaces/point-of-sale/components.d.ts +1506 -1537
  258. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
  259. package/src/surfaces/point-of-sale/event/data/BaseData.ts +15 -0
  260. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +6 -0
  261. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +27 -0
  262. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +18 -0
  263. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +9 -0
  264. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +18 -0
  265. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +12 -0
  266. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +27 -0
  267. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +17 -0
  268. package/src/surfaces/point-of-sale/extension-targets.ts +135 -0
  269. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +43 -0
  270. package/src/surfaces/point-of-sale/types/cart.ts +227 -31
  271. package/src/surfaces/point-of-sale/types/country-code.ts +3 -0
  272. package/src/surfaces/point-of-sale/types/device.ts +6 -3
  273. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +3 -3
  274. package/src/surfaces/point-of-sale/types/discount-allocation.ts +6 -0
  275. package/src/surfaces/point-of-sale/types/money.ts +18 -0
  276. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -2
  277. package/src/surfaces/point-of-sale/types/order.ts +18 -1
  278. package/src/surfaces/point-of-sale/types/paginated-result.ts +2 -3
  279. package/src/surfaces/point-of-sale/types/payment.ts +16 -0
  280. package/src/surfaces/point-of-sale/types/pin-pad.ts +32 -14
  281. package/src/surfaces/point-of-sale/types/product.ts +170 -0
  282. package/src/surfaces/point-of-sale/types/session.ts +7 -5
  283. package/src/surfaces/point-of-sale/types/shipping-line.ts +32 -0
  284. package/src/surfaces/point-of-sale/types/storage.ts +13 -11
  285. package/src/surfaces/point-of-sale/types/tax-line.ts +21 -0
  286. package/src/surfaces/point-of-sale/types/transaction-type.ts +7 -0
  287. package/build/ts/surfaces/admin/components/DropZone/DropZone.ab.doc.d.ts.map +0 -1
@@ -17,55 +17,87 @@ import type {
17
17
 
18
18
  export type ComponentChildren = any;
19
19
  /**
20
- * Used when an element does not have children.
20
+ * The base props for elements without children, providing key, ref, and slot properties.
21
21
  */
22
22
  export interface BaseElementProps<TClass = HTMLElement> {
23
+ /**
24
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
25
+ */
23
26
  key?: Key;
27
+ /**
28
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
29
+ */
24
30
  ref?: Ref<TClass>;
31
+ /**
32
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
33
+ */
25
34
  slot?: Lowercase<string>;
26
35
  }
27
36
  /**
28
- * Used when an element has children.
37
+ * The base props for elements with children, extending `BaseElementProps` with children support.
29
38
  */
30
39
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
40
  extends BaseElementProps<TClass> {
41
+ /**
42
+ * The child elements to render within this component.
43
+ */
32
44
  children?: ComponentChildren;
33
45
  }
34
46
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
47
+ /**
48
+ * Represents the event object passed to callback functions when interactive events occur. Contains metadata about the event, including the target element, event phase, and propagation behavior.
49
+ */
35
50
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
51
+ /**
52
+ * The element that the event listener is attached to.
53
+ */
36
54
  currentTarget: HTMLElementTagNameMap[T];
55
+ /**
56
+ * Whether the event bubbles up through the DOM tree.
57
+ */
37
58
  bubbles?: boolean;
59
+ /**
60
+ * Whether the event can be canceled.
61
+ */
38
62
  cancelable?: boolean;
63
+ /**
64
+ * Whether the event will trigger listeners outside of a shadow root.
65
+ */
39
66
  composed?: boolean;
67
+ /**
68
+ * Additional data associated with the event.
69
+ */
40
70
  detail?: any;
71
+ /**
72
+ * The current phase of the event flow.
73
+ */
41
74
  eventPhase: number;
75
+ /**
76
+ * The element that triggered the event.
77
+ */
42
78
  target: HTMLElementTagNameMap[T] | null;
43
79
  }
44
80
 
45
81
  declare const tagName = 's-modal';
46
82
  export interface ModalJSXProps extends Pick<ModalProps, 'id' | 'heading'> {
47
83
  /**
48
- * Callback when the modal is hidden.
84
+ * The callback when the modal is hidden. Use this event to perform cleanup tasks, update application state, or trigger other actions when the modal is dismissed or closed.
49
85
  */
50
86
  onHide?: (event: CallbackEvent<typeof tagName>) => void | null;
51
87
  /**
52
- * Callback when the modal is shown.
88
+ * The callback when the modal is shown. Use this event to initialize modal content, focus specific elements, or perform setup tasks when the modal becomes visible.
53
89
  */
54
90
  onShow?: (event: CallbackEvent<typeof tagName>) => void | null;
55
91
  /**
56
- * The primary action button displayed in the modal.
57
- *
58
- * The tone of the button is used to define the tone of the modal.
59
- *
60
- * If omitted, the modal will default to an 'info' tone, and show an 'OK' button, translated according to the user's locale.
92
+ * The primary action button displayed in the modal. The tone of the button is used to define the tone of the modal. If omitted, the modal will default to an `'info'` tone, and show an OK button, translated according to the user's locale.
61
93
  */
62
94
  primaryAction?: ComponentChild;
63
95
  /**
64
- * The secondary action buttons displayed in the modal.
96
+ * The secondary action buttons displayed in the modal. Use this slot to provide alternative actions or cancel options that give users flexibility in how they respond to the modal.
65
97
  */
66
98
  secondaryActions?: ComponentChild;
67
99
  /**
68
- * The content of the Modal.
100
+ * The child elements to render within this component.
69
101
  */
70
102
  children?: ComponentChildren;
71
103
  }
@@ -1 +1 @@
1
- {"version":3,"file":"NumberField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/NumberField/NumberField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAwEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"NumberField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/NumberField/NumberField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAyFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -17,28 +17,64 @@ import type {
17
17
 
18
18
  export type ComponentChildren = any;
19
19
  /**
20
- * Used when an element does not have children.
20
+ * The base props for elements without children, providing key, ref, and slot properties.
21
21
  */
22
22
  export interface BaseElementProps<TClass = HTMLElement> {
23
+ /**
24
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
25
+ */
23
26
  key?: Key;
27
+ /**
28
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
29
+ */
24
30
  ref?: Ref<TClass>;
31
+ /**
32
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
33
+ */
25
34
  slot?: Lowercase<string>;
26
35
  }
27
36
  /**
28
- * Used when an element has children.
37
+ * The base props for elements with children, extending `BaseElementProps` with children support.
29
38
  */
30
39
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
40
  extends BaseElementProps<TClass> {
41
+ /**
42
+ * The child elements to render within this component.
43
+ */
32
44
  children?: ComponentChildren;
33
45
  }
34
46
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
47
+ /**
48
+ * Represents the event object passed to callback functions when interactive events occur. Contains metadata about the event, including the target element, event phase, and propagation behavior.
49
+ */
35
50
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
51
+ /**
52
+ * The element that the event listener is attached to.
53
+ */
36
54
  currentTarget: HTMLElementTagNameMap[T];
55
+ /**
56
+ * Whether the event bubbles up through the DOM tree.
57
+ */
37
58
  bubbles?: boolean;
59
+ /**
60
+ * Whether the event can be canceled.
61
+ */
38
62
  cancelable?: boolean;
63
+ /**
64
+ * Whether the event will trigger listeners outside of a shadow root.
65
+ */
39
66
  composed?: boolean;
67
+ /**
68
+ * The additional data associated with the event.
69
+ */
40
70
  detail?: any;
71
+ /**
72
+ * The current phase of the event flow.
73
+ */
41
74
  eventPhase: number;
75
+ /**
76
+ * The element that triggered the event.
77
+ */
42
78
  target: HTMLElementTagNameMap[T] | null;
43
79
  }
44
80
 
@@ -59,85 +95,64 @@ export interface NumberFieldJSXProps
59
95
  | 'controls'
60
96
  > {
61
97
  /**
62
- * Content to use as the field label.
63
- *
64
- * Label is not supported when using Stepper controls
98
+ * The text content that displays as the field label, describing the numeric information being requested. This property isn't supported when using `stepper` controls.
65
99
  */
66
100
  label?: NumberFieldProps['label'];
67
101
  /**
68
- * Additional text to provide context or guidance for the field.
69
- * This text is displayed along with the field and its label
70
- * to offer more information or instructions to the user.
71
- *
72
- * This will also be exposed to screen reader users.
73
- *
74
- * Details are not supported when using Stepper controls
102
+ * The additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users. This property isn't supported when using `stepper` controls.
75
103
  */
76
104
  details?: NumberFieldProps['details'];
77
105
  /**
78
- * Whether the field needs a value. This requirement adds semantic value
79
- * to the field, but it will not cause an error to appear automatically.
80
- * If you want to present an error when this field is empty, you can do
81
- * so with the `error` property.
106
+ * Whether the field needs a value. This requirement adds semantic value to the field but doesn't cause an error to appear automatically. Use the `error` property to present validation errors. This property isn't supported when using `stepper` controls.
82
107
  *
83
108
  * @default false
84
- *
85
- * Required is not supported when using Stepper controls
86
109
  */
87
110
  required?: NumberFieldProps['required'];
88
111
  /**
89
- * Indicate an error to the user. The field will be given a specific stylistic treatment
90
- * to communicate problems that have to be resolved immediately.
91
- *
92
- * Error is not supported when using Stepper controls
112
+ * An error message that indicates a problem to the user. The field receives specific stylistic treatment to communicate issues that must be resolved immediately. This property isn't supported when using `stepper` controls.
93
113
  */
94
114
  error?: NumberFieldProps['error'];
95
115
  /**
96
- * Sets the virtual keyboard.
116
+ * The virtual keyboard layout that the field displays for numeric input. This property isn't supported when using `stepper` controls.
97
117
  *
98
- * Input mode is not supported when using Stepper controls
118
+ * - `'decimal'` - A keyboard layout that includes decimal point support for entering fractional numbers, prices, or measurements with decimal precision.
119
+ * - `'numeric'` - A keyboard layout optimized for integer-only entry without decimal point support, ideal for quantities, counts, or whole number values.
99
120
  *
100
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
101
121
  * @default 'decimal'
102
122
  */
103
123
  inputMode?: NumberFieldProps['inputMode'];
104
124
  /**
105
- * A short hint that describes the expected value of the field.
106
- *
107
- * Placeholder text is not supported when using Stepper controls due to constrained space for the number field, especially on phones.
125
+ * A short hint that provides guidance about the expected value of the field. This property isn't supported when using `stepper` controls due to constrained space, especially on phones.
108
126
  */
109
127
  placeholder?: NumberFieldProps['placeholder'];
110
128
  /**
111
- * Additional content to be displayed in the field. Commonly used to display clickable text.
112
- *
113
- * > Note: Accessory is not supported when using Stepper controls
129
+ * The additional content to be displayed in the field. Commonly used to display clickable text or action elements. Use the `slot="accessory"` attribute to place elements in this area. This slot isn't supported when using `stepper` controls.
114
130
  */
115
131
  accessory?: ComponentChild;
116
132
  /**
117
- * Sets the type of controls displayed for the field.
133
+ * The type of controls displayed for the field:
118
134
  *
119
- * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Note that in POS
120
- * adding stepper controls simplifies the behaviour of the Number Field itself. The field supports only integer values, is always-populated and automatically
121
- * validates the value to be within the min and max bounds. Validation, label, details and placeholder are not supported when using Stepper controls.
135
+ * - `'auto'` - An automatic setting where the presence of controls depends on the surface and context. The system determines the most appropriate control type based on the usage scenario.
136
+ * - `'stepper'` - Displays increment (+) and decrement (-) buttons for adjusting the numeric value. When `stepper` controls are enabled, the field behavior is constrained: it accepts only integer values, always contains a value (never empty), and automatically validates against `min` and `max` bounds. The `label`, `details`, `placeholder`, `error`, `required`, and `inputMode` properties aren't supported with `stepper` controls.
137
+ * - `'none'` - A control type with no visible controls where users must input the value manually using the keyboard.
122
138
  *
123
- * - `none`: no controls are displayed and users must input the value manually.
124
- * - `auto`: the presence of the controls depends on the surface and context.
139
+ * @default 'auto'
125
140
  */
126
141
  controls?: NumberFieldProps['controls'];
127
142
  /**
128
- * Callback when the user makes any changes in the field.
143
+ * A callback function that executes when the user makes any changes in the field.
129
144
  */
130
145
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
131
146
  /**
132
- * Callback after editing completes (typically on blur).
147
+ * A callback function that executes after editing completes, typically on blur.
133
148
  */
134
149
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
135
150
  /**
136
- * Callback when the element loses focus.
151
+ * A callback function that executes when the element loses focus.
137
152
  */
138
153
  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
139
154
  /**
140
- * Callback when the element receives focus.
155
+ * A callback function that executes when the element receives focus.
141
156
  */
142
157
  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
143
158
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Page.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Page/Page.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"Page.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Page/Page.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA2DX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -17,18 +17,30 @@ import type {
17
17
 
18
18
  export type ComponentChildren = any;
19
19
  /**
20
- * Used when an element does not have children.
20
+ * The base props for elements without children, providing key, ref, and slot properties.
21
21
  */
22
22
  export interface BaseElementProps<TClass = HTMLElement> {
23
+ /**
24
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
25
+ */
23
26
  key?: Key;
27
+ /**
28
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
29
+ */
24
30
  ref?: Ref<TClass>;
31
+ /**
32
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
33
+ */
25
34
  slot?: Lowercase<string>;
26
35
  }
27
36
  /**
28
- * Used when an element has children.
37
+ * The base props for elements with children, extending `BaseElementProps` with children support.
29
38
  */
30
39
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
40
  extends BaseElementProps<TClass> {
41
+ /**
42
+ * The child elements to render within this component.
43
+ */
32
44
  children?: ComponentChildren;
33
45
  }
34
46
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
@@ -36,25 +48,25 @@ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
36
48
  declare const tagName = 's-page';
37
49
  export interface PageJSXProps extends Pick<PageProps, 'id'> {
38
50
  /**
39
- * The main page heading, displayed in the action bar at the top of the page.
51
+ * The main page heading displayed in the action bar at the top of the page.
40
52
  *
41
53
  * @default: ''
42
54
  */
43
55
  heading?: PageProps['heading'];
44
56
  /**
45
- * A secondary page heading, displayed under the main heading in the action bar.
57
+ * A secondary page heading displayed under the main heading in the action bar.
46
58
  */
47
59
  subheading?: PageProps['subheading'];
48
60
  /**
49
- * Button element to display in the action bar. Only a single button is supported.
61
+ * A button element to display in the action bar. Only a single button is supported. Use the `slot="secondary-actions"` attribute to place content in this area.
50
62
  */
51
63
  secondaryActions?: ComponentChild;
52
64
  /**
53
- * Content to display in the page's sidebar.
65
+ * The content to display in the page's sidebar. This area is for content that is tangentially related to the main content, such as navigation or contextual information. Use the `slot="aside"` attribute to place content in this area.
54
66
  */
55
67
  aside?: ComponentChild;
56
68
  /**
57
- * The content of the Page.
69
+ * The child elements to render within this component.
58
70
  */
59
71
  children?: ComponentChildren;
60
72
  }
@@ -1 +1 @@
1
- {"version":3,"file":"PosBlock.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAwCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"PosBlock.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAyDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -17,18 +17,30 @@ import type {
17
17
 
18
18
  export type ComponentChildren = any;
19
19
  /**
20
- * Used when an element does not have children.
20
+ * The base props for elements without children, providing key, ref, and slot properties.
21
21
  */
22
22
  export interface BaseElementProps<TClass = HTMLElement> {
23
+ /**
24
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
25
+ */
23
26
  key?: Key;
27
+ /**
28
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
29
+ */
24
30
  ref?: Ref<TClass>;
31
+ /**
32
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
33
+ */
25
34
  slot?: Lowercase<string>;
26
35
  }
27
36
  /**
28
- * Used when an element has children.
37
+ * The base props for elements with children, extending `BaseElementProps` with children support.
29
38
  */
30
39
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
40
  extends BaseElementProps<TClass> {
41
+ /**
42
+ * The child elements to render within this component.
43
+ */
32
44
  children?: ComponentChildren;
33
45
  }
34
46
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
@@ -37,11 +49,11 @@ declare const tagName = 's-pos-block';
37
49
  export interface PosBlockJSXProps
38
50
  extends Pick<POSBlockProps, 'id' | 'heading'> {
39
51
  /**
40
- * The secondary actions to perform, provided as button or link type elements.
52
+ * The secondary actions to perform, provided as button or link type elements. Use the `slot="secondary-actions"` attribute to place interactive elements that allow users to take actions related to the block's content.
41
53
  */
42
54
  secondaryActions?: ComponentChild;
43
55
  /**
44
- * The content of the Block.
56
+ * The child elements to render within this component.
45
57
  */
46
58
  children?: ComponentChildren;
47
59
  }
@@ -12,18 +12,30 @@ import type {QRCodeProps, Key, Ref} from './components-shared.d.ts';
12
12
 
13
13
  export type ComponentChildren = any;
14
14
  /**
15
- * Used when an element does not have children.
15
+ * The base props for elements without children, providing key, ref, and slot properties.
16
16
  */
17
17
  export interface BaseElementProps<TClass = HTMLElement> {
18
+ /**
19
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
20
+ */
18
21
  key?: Key;
22
+ /**
23
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
24
+ */
19
25
  ref?: Ref<TClass>;
26
+ /**
27
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
28
+ */
20
29
  slot?: Lowercase<string>;
21
30
  }
22
31
  /**
23
- * Used when an element has children.
32
+ * The base props for elements with children, extending `BaseElementProps` with children support.
24
33
  */
25
34
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
35
  extends BaseElementProps<TClass> {
36
+ /**
37
+ * The child elements to render within this component.
38
+ */
27
39
  children?: ComponentChildren;
28
40
  }
29
41
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
@@ -1 +1 @@
1
- {"version":3,"file":"ScrollBox.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"ScrollBox.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA4CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -22,136 +22,133 @@ import type {
22
22
 
23
23
  export type ComponentChildren = any;
24
24
  /**
25
- * Used when an element does not have children.
25
+ * The base props for elements without children, providing key, ref, and slot properties.
26
26
  */
27
27
  export interface BaseElementProps<TClass = HTMLElement> {
28
+ /**
29
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
30
+ */
28
31
  key?: Key;
32
+ /**
33
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
34
+ */
29
35
  ref?: Ref<TClass>;
36
+ /**
37
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
38
+ */
30
39
  slot?: Lowercase<string>;
31
40
  }
32
41
  /**
33
- * Used when an element has children.
42
+ * The base props for elements with children, extending `BaseElementProps` with children support.
34
43
  */
35
44
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
36
45
  extends BaseElementProps<TClass> {
46
+ /**
47
+ * The child elements to render within this component.
48
+ */
37
49
  children?: ComponentChildren;
38
50
  }
39
51
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
40
52
 
53
+ /**
54
+ * Defines the available padding size options using a semantic scale. Provides consistent spacing values that align with the POS design system.
55
+ */
41
56
  export type PaddingKeyword = SizeKeyword | 'none';
42
57
  declare const tagName = 's-scroll-box';
43
58
  export interface ScrollBoxJSXProps extends Pick<ScrollBoxProps, 'id'> {
44
59
  /**
45
- * Adjust the block size.
60
+ * The block size of the scrollable container. Auto automatically sizes based on the container's content and available space.
46
61
  *
47
62
  * @default 'auto'
48
63
  */
49
64
  blockSize?: SizeUnitsOrAuto;
50
65
  /**
51
- * Adjust the inline size.
66
+ * The inline size of the scrollable container. Auto automatically sizes based on the container's content and available space.
52
67
  *
53
68
  * @default 'auto'
54
69
  */
55
70
  inlineSize?: SizeUnitsOrAuto;
56
71
  /**
57
- * Adjust the maximum block size.
72
+ * The maximum block size constraint for the scrollable container.
58
73
  *
59
74
  * @default 'none'
60
75
  */
61
76
  maxBlockSize?: SizeUnitsOrNone;
62
77
  /**
63
- * Adjust the maximum inline size.
78
+ * The maximum inline size constraint for the scrollable container.
64
79
  *
65
80
  * @default 'none'
66
81
  */
67
82
  maxInlineSize?: SizeUnitsOrNone;
68
83
  /**
69
- * Adjust the minimum block size.
84
+ * The minimum block size constraint for the scrollable container.
70
85
  *
71
86
  * @default '0'
72
87
  */
73
88
  minBlockSize?: SizeUnits;
74
89
  /**
75
- * Adjust the minimum inline size.
90
+ * The minimum inline size constraint for the scrollable container.
76
91
  *
77
92
  * @default '0'
78
93
  */
79
94
  minInlineSize?: SizeUnits;
80
95
  /**
81
- * Adjust the padding of all edges.
82
- *
83
- * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
84
- * supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
96
+ * The padding applied to all edges of the scrollable container. Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Cascade/Shorthand_properties#edges_of_a_box) using flow-relative values in the order:
85
97
  *
86
98
  * - 4 values: `block-start inline-end block-end inline-start`
87
99
  * - 3 values: `block-start inline block-end`
88
100
  * - 2 values: `block inline`
89
101
  *
90
102
  * For example:
103
+ *
91
104
  * - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
92
105
  * - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
93
106
  * - `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.
94
107
  * - `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.
95
108
  *
96
- * A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
109
+ * An `auto` value inherits the default padding from the closest container that has removed its usual padding.
97
110
  *
98
111
  * @default 'none'
99
112
  */
100
113
  padding?: MaybeAllValuesShorthandProperty<PaddingKeyword>;
101
114
  /**
102
- * Adjust the block-padding.
103
- *
104
- * - `large none` means block-start padding is `large`, block-end padding is `none`.
105
- *
106
- * This overrides the block value of `padding`.
115
+ * The block-axis padding for the scrollable container. Overrides the block value of the `padding` property.
107
116
  *
108
117
  * @default '' - meaning no override
109
118
  */
110
119
  paddingBlock?: MaybeTwoValuesShorthandProperty<PaddingKeyword> | '';
111
120
  /**
112
- * Adjust the block-start padding.
113
- *
114
- * This overrides the block-start value of `paddingBlock`.
121
+ * The block-start padding for the scrollable container. Overrides the block-start value of the `paddingBlock` property.
115
122
  *
116
123
  * @default '' - meaning no override
117
124
  */
118
125
  paddingBlockStart?: PaddingKeyword | '';
119
126
  /**
120
- * Adjust the block-end padding.
121
- *
122
- * This overrides the block-end value of `paddingBlock`.
127
+ * The block-end padding for the scrollable container. Overrides the block-end value of the `paddingBlock` property.
123
128
  *
124
129
  * @default '' - meaning no override
125
130
  */
126
131
  paddingBlockEnd?: PaddingKeyword | '';
127
132
  /**
128
- * Adjust the inline padding.
129
- *
130
- * - `large none` means inline-start padding is `large`, inline-end padding is `none`.
131
- *
132
- * This overrides the inline value of `padding`.
133
+ * The inline-axis padding for the scrollable container. Supports two-value syntax where `large none` sets inline-start to `large` and inline-end to `none`. Overrides the inline value of the `padding` property.
133
134
  *
134
135
  * @default '' - meaning no override
135
136
  */
136
137
  paddingInline?: MaybeTwoValuesShorthandProperty<PaddingKeyword> | '';
137
138
  /**
138
- * Adjust the inline-start padding.
139
- *
140
- * This overrides the inline-start value of `paddingInline`.
139
+ * The inline-start padding for the scrollable container. Overrides the inline-start value of the `paddingInline` property.
141
140
  *
142
141
  * @default '' - meaning no override
143
142
  */
144
143
  paddingInlineStart?: PaddingKeyword | '';
145
144
  /**
146
- * Adjust the inline-end padding.
147
- *
148
- * This overrides the inline-end value of `paddingInline`.
145
+ * The inline-end padding for the scrollable container. Overrides the inline-end value of the `paddingInline` property.
149
146
  *
150
147
  * @default '' - meaning no override
151
148
  */
152
149
  paddingInlineEnd?: PaddingKeyword | '';
153
150
  /**
154
- * The content of the ScrollBox.
151
+ * The child elements to render within this component.
155
152
  */
156
153
  children?: ComponentChildren;
157
154
  }
@@ -1 +1 @@
1
- {"version":3,"file":"SearchField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/SearchField/SearchField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"SearchField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/SearchField/SearchField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsEX,CAAC;AAEF,eAAe,IAAI,CAAC"}