@shopify/ui-extensions 2025.10.8 → 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 (277) 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 +17 -9
  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/storage-api/storage-api.d.ts +3 -0
  69. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -1
  70. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +11 -1
  71. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -1
  72. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts.map +1 -1
  73. package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +23 -4
  74. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts.map +1 -1
  75. package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +24 -6
  76. package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts.map +1 -1
  77. package/build/ts/surfaces/point-of-sale/components/Box.d.ts +34 -37
  78. package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts.map +1 -1
  79. package/build/ts/surfaces/point-of-sale/components/Button.d.ts +56 -16
  80. package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +14 -2
  81. package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
  82. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +41 -5
  83. package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts.map +1 -1
  84. package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +40 -4
  85. package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map +1 -1
  86. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +42 -6
  87. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
  88. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +42 -6
  89. package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map +1 -1
  90. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +42 -6
  91. package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts.map +1 -1
  92. package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +14 -2
  93. package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map +1 -1
  94. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +43 -7
  95. package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts.map +1 -1
  96. package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +15 -3
  97. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts.map +1 -1
  98. package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +17 -2
  99. package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts.map +1 -1
  100. package/build/ts/surfaces/point-of-sale/components/Image.d.ts +6 -3
  101. package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts.map +1 -1
  102. package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +43 -11
  103. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map +1 -1
  104. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +56 -41
  105. package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts.map +1 -1
  106. package/build/ts/surfaces/point-of-sale/components/Page.d.ts +19 -7
  107. package/build/ts/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.d.ts.map +1 -1
  108. package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +16 -4
  109. package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +14 -2
  110. package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -1
  111. package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +33 -36
  112. package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map +1 -1
  113. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +42 -6
  114. package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts.map +1 -1
  115. package/build/ts/surfaces/point-of-sale/components/Section.d.ts +17 -7
  116. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts.map +1 -1
  117. package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +47 -61
  118. package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts.map +1 -1
  119. package/build/ts/surfaces/point-of-sale/components/Text.d.ts +28 -6
  120. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map +1 -1
  121. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +43 -7
  122. package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map +1 -1
  123. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +43 -7
  124. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts.map +1 -1
  125. package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +40 -4
  126. package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts.map +1 -1
  127. package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +42 -6
  128. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map +1 -1
  129. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +42 -6
  130. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +638 -878
  131. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +1 -1
  132. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
  133. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
  134. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
  135. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +15 -0
  136. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
  137. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +6 -0
  138. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
  139. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +27 -0
  140. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
  141. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +18 -0
  142. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
  143. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +9 -0
  144. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
  145. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +18 -0
  146. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
  147. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +12 -0
  148. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
  149. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +27 -0
  150. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  151. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +17 -0
  152. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
  153. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +135 -0
  154. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
  155. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +43 -0
  156. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
  157. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +227 -31
  158. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  159. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +3 -0
  160. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
  161. package/build/ts/surfaces/point-of-sale/types/device.d.ts +6 -3
  162. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
  163. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +3 -3
  164. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +6 -0
  165. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
  166. package/build/ts/surfaces/point-of-sale/types/money.d.ts +18 -0
  167. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
  168. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -2
  169. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
  170. package/build/ts/surfaces/point-of-sale/types/order.d.ts +18 -0
  171. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
  172. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +2 -3
  173. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
  174. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +15 -0
  175. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
  176. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +36 -16
  177. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -1
  178. package/build/ts/surfaces/point-of-sale/types/product.d.ts +170 -0
  179. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
  180. package/build/ts/surfaces/point-of-sale/types/session.d.ts +7 -5
  181. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
  182. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +32 -0
  183. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
  184. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +13 -11
  185. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  186. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +21 -0
  187. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
  188. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +7 -0
  189. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
  190. package/build/tsconfig.tsbuildinfo +1 -1
  191. package/package.json +6 -1
  192. package/src/shared.ts +7 -7
  193. package/src/surfaces/admin/api/intents/examples/edit-metafield-definition.js +1 -0
  194. package/src/surfaces/admin/api/intents/examples/edit-metaobject-definition.js +1 -1
  195. package/src/surfaces/admin/components/Icon/icon-data.json +9 -0
  196. package/src/surfaces/point-of-sale/api/action-api/action-api.ts +3 -5
  197. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +38 -33
  198. package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +2 -2
  199. package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +6 -4
  200. package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +4 -1
  201. package/src/surfaces/point-of-sale/api/device-api/device-api.ts +4 -4
  202. package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +6 -3
  203. package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +2 -3
  204. package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +17 -9
  205. package/src/surfaces/point-of-sale/api/order-api/order-api.ts +5 -5
  206. package/src/surfaces/point-of-sale/api/pin-pad-api.ts +6 -10
  207. package/src/surfaces/point-of-sale/api/print-api/print-api.ts +10 -11
  208. package/src/surfaces/point-of-sale/api/product-api/product-api.ts +5 -2
  209. package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +24 -10
  210. package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +26 -8
  211. package/src/surfaces/point-of-sale/api/session-api/session-api.ts +3 -6
  212. package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +3 -0
  213. package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +11 -1
  214. package/src/surfaces/point-of-sale/components/Badge.d.ts +23 -4
  215. package/src/surfaces/point-of-sale/components/Banner.d.ts +24 -6
  216. package/src/surfaces/point-of-sale/components/Box.d.ts +34 -37
  217. package/src/surfaces/point-of-sale/components/Button.d.ts +56 -16
  218. package/src/surfaces/point-of-sale/components/Choice.d.ts +14 -2
  219. package/src/surfaces/point-of-sale/components/ChoiceList/examples/composed-choices.jsx +35 -0
  220. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +41 -5
  221. package/src/surfaces/point-of-sale/components/Clickable.d.ts +40 -4
  222. package/src/surfaces/point-of-sale/components/DateField.d.ts +42 -6
  223. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +42 -6
  224. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +42 -6
  225. package/src/surfaces/point-of-sale/components/Divider.d.ts +14 -2
  226. package/src/surfaces/point-of-sale/components/EmailField.d.ts +43 -7
  227. package/src/surfaces/point-of-sale/components/Heading.d.ts +15 -3
  228. package/src/surfaces/point-of-sale/components/Icon.d.ts +17 -2
  229. package/src/surfaces/point-of-sale/components/Image.d.ts +6 -3
  230. package/src/surfaces/point-of-sale/components/Modal.d.ts +43 -11
  231. package/src/surfaces/point-of-sale/components/NumberField.d.ts +56 -41
  232. package/src/surfaces/point-of-sale/components/Page.d.ts +19 -7
  233. package/src/surfaces/point-of-sale/components/PosBlock.d.ts +16 -4
  234. package/src/surfaces/point-of-sale/components/QrCode.d.ts +14 -2
  235. package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +33 -36
  236. package/src/surfaces/point-of-sale/components/SearchField.d.ts +42 -6
  237. package/src/surfaces/point-of-sale/components/Section.d.ts +17 -7
  238. package/src/surfaces/point-of-sale/components/Stack.d.ts +47 -61
  239. package/src/surfaces/point-of-sale/components/Text.d.ts +28 -6
  240. package/src/surfaces/point-of-sale/components/TextArea.d.ts +43 -7
  241. package/src/surfaces/point-of-sale/components/TextField.d.ts +43 -7
  242. package/src/surfaces/point-of-sale/components/Tile.d.ts +40 -4
  243. package/src/surfaces/point-of-sale/components/TimeField.d.ts +42 -6
  244. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +42 -6
  245. package/src/surfaces/point-of-sale/components/components-shared.d.ts +638 -878
  246. package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -1
  247. package/src/surfaces/point-of-sale/components.d.ts +1506 -1537
  248. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
  249. package/src/surfaces/point-of-sale/event/data/BaseData.ts +15 -0
  250. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +6 -0
  251. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +27 -0
  252. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +18 -0
  253. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +9 -0
  254. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +18 -0
  255. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +12 -0
  256. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +27 -0
  257. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +17 -0
  258. package/src/surfaces/point-of-sale/extension-targets.ts +135 -0
  259. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +43 -0
  260. package/src/surfaces/point-of-sale/types/cart.ts +227 -31
  261. package/src/surfaces/point-of-sale/types/country-code.ts +3 -0
  262. package/src/surfaces/point-of-sale/types/device.ts +6 -3
  263. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +3 -3
  264. package/src/surfaces/point-of-sale/types/discount-allocation.ts +6 -0
  265. package/src/surfaces/point-of-sale/types/money.ts +18 -0
  266. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -2
  267. package/src/surfaces/point-of-sale/types/order.ts +18 -1
  268. package/src/surfaces/point-of-sale/types/paginated-result.ts +2 -3
  269. package/src/surfaces/point-of-sale/types/payment.ts +16 -0
  270. package/src/surfaces/point-of-sale/types/pin-pad.ts +32 -14
  271. package/src/surfaces/point-of-sale/types/product.ts +170 -0
  272. package/src/surfaces/point-of-sale/types/session.ts +7 -5
  273. package/src/surfaces/point-of-sale/types/shipping-line.ts +32 -0
  274. package/src/surfaces/point-of-sale/types/storage.ts +13 -11
  275. package/src/surfaces/point-of-sale/types/tax-line.ts +21 -0
  276. package/src/surfaces/point-of-sale/types/transaction-type.ts +7 -0
  277. package/build/ts/surfaces/admin/components/DropZone/DropZone.ab.doc.d.ts.map +0 -1
@@ -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,17 +48,15 @@ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
36
48
  declare const tagName = 's-section';
37
49
  export interface SectionJSXProps extends Pick<SectionProps, 'id'> {
38
50
  /**
39
- * A title that describes the content of the section.
40
- *
41
- * If omitted, and no secondaryActions are provided, the section will be rendered without a header.
51
+ * A title that describes the content of the section. If omitted and no secondary actions are provided, the section will be rendered without a header.
42
52
  */
43
53
  heading?: string;
44
54
  /**
45
- * Button element to display in the section heading. A single button is supported.
55
+ * A button element to display in the section heading. Only a single button is supported. Use the `slot="secondary-actions"` attribute to place action elements that relate to the entire section's content.
46
56
  */
47
57
  secondaryActions?: ComponentChild;
48
58
  /**
49
- * The content of the Section.
59
+ * The child elements to render within this component.
50
60
  */
51
61
  children?: ComponentChildren;
52
62
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Stack.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Stack/Stack.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":"Stack.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Stack/Stack.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA+CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -26,23 +26,38 @@ import type {
26
26
 
27
27
  export type ComponentChildren = any;
28
28
  /**
29
- * Used when an element does not have children.
29
+ * The base props for elements without children, providing key, ref, and slot properties.
30
30
  */
31
31
  export interface BaseElementProps<TClass = HTMLElement> {
32
+ /**
33
+ * A unique identifier for the element in lists. Used by Preact for efficient rendering and reconciliation.
34
+ */
32
35
  key?: Key;
36
+ /**
37
+ * A reference to the underlying DOM element. Commonly used to access the element directly for imperative operations.
38
+ */
33
39
  ref?: Ref<TClass>;
40
+ /**
41
+ * The named [slot](/docs/api/polaris/using-polaris-web-components#slots) this element should be placed in when used within a web component.
42
+ */
34
43
  slot?: Lowercase<string>;
35
44
  }
36
45
  /**
37
- * Used when an element has children.
46
+ * The base props for elements with children, extending `BaseElementProps` with children support.
38
47
  */
39
48
  export interface BaseElementPropsWithChildren<TClass = HTMLElement>
40
49
  extends BaseElementProps<TClass> {
50
+ /**
51
+ * The child elements to render within this component.
52
+ */
41
53
  children?: ComponentChildren;
42
54
  }
43
55
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
44
56
 
45
57
  declare const tagName = 's-stack';
58
+ /**
59
+ * Defines the available padding size options using a semantic scale. Provides consistent spacing values that align with the POS design system.
60
+ */
46
61
  export type PaddingKeyword = SizeKeyword | 'none';
47
62
  export type PickedProps = Pick<
48
63
  StackProps,
@@ -63,173 +78,144 @@ export type PickedProps = Pick<
63
78
  >;
64
79
  export interface StackJSXProps extends PickedProps {
65
80
  /**
66
- * Adjust the padding of all edges.
67
- *
68
- * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
69
- * supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
81
+ * The padding applied to all edges of the 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:
70
82
  *
71
83
  * - 4 values: `block-start inline-end block-end inline-start`
72
84
  * - 3 values: `block-start inline block-end`
73
85
  * - 2 values: `block inline`
74
86
  *
75
87
  * For example:
88
+ *
76
89
  * - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
77
90
  * - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
78
91
  * - `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`.
79
92
  * - `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`.
80
93
  *
81
- * A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
94
+ * An `auto` value inherits the default padding from the closest container that has removed its usual padding.
82
95
  *
83
96
  * @default 'none'
84
97
  */
85
98
  padding?: MaybeAllValuesShorthandProperty<PaddingKeyword>;
86
99
  /**
87
- * Adjust the block-padding.
88
- *
89
- * - `large none` means block-start padding is `large`, block-end padding is `none`.
90
- *
91
- * This overrides the block value of `padding`.
100
+ * The block-axis padding for the container. Overrides the block value of the `padding` property.
92
101
  *
93
102
  * @default '' - meaning no override
94
103
  */
95
104
  paddingBlock?: MaybeTwoValuesShorthandProperty<PaddingKeyword | ''>;
96
105
  /**
97
- * Adjust the block-start padding.
98
- *
99
- * This overrides the block-start value of `paddingBlock`.
106
+ * The block-start padding for the container. Overrides the block-start value of the `paddingBlock` property.
100
107
  *
101
108
  * @default '' - meaning no override
102
109
  */
103
110
  paddingBlockStart?: PaddingKeyword | '';
104
111
  /**
105
- * Adjust the block-end padding.
106
- *
107
- * This overrides the block-end value of `paddingBlock`.
112
+ * The block-end padding for the container. Overrides the block-end value of the `paddingBlock` property.
108
113
  *
109
114
  * @default '' - meaning no override
110
115
  */
111
116
  paddingBlockEnd?: PaddingKeyword | '';
112
117
  /**
113
- * Adjust the inline padding.
114
- *
115
- * - `large none` means inline-start padding is `large`, inline-end padding is `none`.
116
- *
117
- * This overrides the inline value of `padding`.
118
+ * The inline-axis padding for the 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.
118
119
  *
119
120
  * @default '' - meaning no override
120
121
  */
121
122
  paddingInline?: MaybeTwoValuesShorthandProperty<PaddingKeyword | ''>;
122
123
  /**
123
- * Adjust the inline-start padding.
124
- *
125
- * This overrides the inline-start value of `paddingInline`.
124
+ * The inline-start padding for the container. Overrides the inline-start value of the `paddingInline` property.
126
125
  *
127
126
  * @default '' - meaning no override
128
127
  */
129
128
  paddingInlineStart?: PaddingKeyword | '';
130
129
  /**
131
- * Adjust the inline-end padding.
132
- *
130
+ * The inline-end padding for the container.
133
131
  * This overrides the inline-end value of `paddingInline`.
134
132
  *
135
133
  * @default '' - meaning no override
136
134
  */
137
135
  paddingInlineEnd?: PaddingKeyword | '';
138
136
  /**
139
- * Adjust the block size.
140
- * **Mobile surfaces:** Avoid using percentage-based sizes. They do not behave as expected when placed within a scrollable container.
141
- *
142
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size
137
+ * The block size of the `Stack` component. On mobile surfaces, avoid using percentage-based sizes as they don't behave as expected when placed within a scrollable container.
143
138
  *
139
+ * Learn more about [block-size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
144
140
  * @default 'auto'
145
141
  */
146
142
  blockSize?: SizeUnitsOrAuto;
147
143
  /**
148
- * Adjust the maximum block size.
149
- * **Mobile surfaces:** Avoid using percentage-based sizes. They do not behave as expected when placed within a scrollable container.
150
- *
151
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size
144
+ * The maximum block size constraint for the `Stack` component. On mobile surfaces, avoid using percentage-based sizes as they don't behave as expected when placed within a scrollable container.
152
145
  *
146
+ * Learn more about [max-block-size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
153
147
  * @default 'none'
154
148
  */
155
149
  maxBlockSize?: SizeUnitsOrNone;
156
150
  /**
157
- * Adjust the maximum inline size.
158
- * **Mobile surfaces:** Avoid using percentage-based sizes. They do not behave as expected when placed within a scrollable container.
159
- *
160
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size
151
+ * The maximum inline size constraint for the `Stack` component. On mobile surfaces, avoid using percentage-based sizes as they don't behave as expected when placed within a scrollable container.
161
152
  *
153
+ * Learn more about [max-inline-size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
162
154
  * @default 'none'
163
155
  */
164
156
  maxInlineSize?: SizeUnitsOrNone;
165
157
  /**
166
- * Adjust the minimum block size.
167
- * **Mobile surfaces:** Avoid using percentage-based sizes. They do not behave as expected when placed within a scrollable container.
168
- *
169
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size
158
+ * The minimum block size constraint for the `Stack` component. On mobile surfaces, avoid using percentage-based sizes as they don't behave as expected when placed within a scrollable container.
170
159
  *
160
+ * Learn more about [min-block-size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
171
161
  * @default '0'
172
162
  */
173
163
  minBlockSize?: SizeUnits;
174
164
  /**
175
- * Adjust the minimum inline size.
176
- * **Mobile surfaces:** Avoid using percentage-based sizes. They do not behave as expected when placed within a scrollable container.
177
- *
178
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size
165
+ * The minimum inline size constraint for the `Stack` component. On mobile surfaces, avoid using percentage-based sizes as they don't behave as expected when placed within a scrollable container.
179
166
  *
167
+ * Learn more about [min-inline-size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
180
168
  * @default '0'
181
169
  */
182
170
  minInlineSize?: SizeUnits;
183
171
  /**
184
- * Aligns the Stack's children along the cross axis.
172
+ * The alignment of the `Stack` component's children along the cross axis.
185
173
  */
186
174
  alignItems?: AlignItemsKeyword;
187
175
  /**
188
- * Aligns the Stack along the cross axis.
176
+ * The alignment of the `Stack` component along the cross axis.
189
177
  */
190
178
  alignContent?: AlignContentKeyword;
191
179
  /**
192
- * Adjust spacing between elements.
193
- * A single value applies to both axes. A pair of values (eg large-100 large-500) can be used to set the inline and block axes respectively.
180
+ * The spacing between elements. A single value applies to both axes. A pair of values (eg large-100 large-500) can be used to set the inline and block axes respectively.
194
181
  *
195
182
  * @default 'none'
196
183
  */
197
184
  gap?: MaybeTwoValuesShorthandProperty<SpacingKeyword>;
198
185
  /**
199
- * Adjust spacing between elements in the inline axis. This overrides the column value of gap.
186
+ * The spacing between elements in the inline axis. This overrides the column value of gap.
200
187
  *
201
188
  * @default '' - meaning no override
202
189
  */
203
190
  columnGap?: SpacingKeyword | '';
204
191
  /**
205
- * Sets how the children are placed within the Stack. This uses logical properties.
192
+ * The direction in which children are placed within the `Stack` component using logical properties. Use `'block'` for vertical arrangement where children are placed along the block axis (typically top to bottom) without wrapping. Use `'inline'` for horizontal arrangement where children are placed along the inline axis (typically left to right) with automatic wrapping when space is insufficient.
206
193
  *
207
194
  * @default 'block'
208
- * @implementation - the content will wrap if the direction is 'inline', and not wrap if the direction is 'block'
209
195
  */
210
196
  direction?: 'block' | 'inline';
211
197
  /**
212
- * Adjust the inline size.
213
- * @see — https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size
198
+ * The inline size of the `Stack` component.
214
199
  *
200
+ * Learn more about [inline-size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
215
201
  * @default 'auto'
216
202
  */
217
203
  inlineSize?: SizeUnitsOrAuto;
218
204
  /**
219
- * Aligns the Stack along the main axis.
220
- * @see — https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
205
+ * The alignment of the `Stack` component along the main axis.
221
206
  *
207
+ * Learn more about [justify-content on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
222
208
  * @default 'normal'
223
209
  */
224
210
  justifyContent?: JustifyContentKeyword;
225
211
  /**
226
- * Adjust spacing between elements in the block axis. This overrides the row value of gap.
212
+ * The spacing between elements in the block axis. This overrides the row value of gap.
227
213
  *
228
214
  * @default '' - meaning no override
229
215
  */
230
216
  rowGap?: SpacingKeyword | '';
231
217
  /**
232
- * The content of the Stack.
218
+ * The child elements to render within this component.
233
219
  */
234
220
  children?: ComponentChildren;
235
221
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Text.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Text/Text.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":"Text.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Text/Text.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,18 +12,30 @@ import type {TextProps, 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>;
@@ -31,21 +43,31 @@ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
31
43
  declare const tagName = 's-text';
32
44
  export interface TextJSXProps extends Pick<TextProps, 'id'> {
33
45
  /**
34
- * Modify the color to be more or less intense.
46
+ * The color intensity of the text. Controls how prominent or subtle the text appears within the interface.
35
47
  *
36
48
  * @default 'base'
37
49
  */
38
50
  color?: Extract<TextProps['color'], 'base' | 'strong' | 'subdued'>;
39
51
  /**
40
- * Provide semantic meaning and default styling to the text.
52
+ * The semantic meaning and default styling of the text. Other presentation properties override the default styling provided by the type. Available options:
41
53
  *
42
- * Other presentation properties on Text override the default styling.
54
+ * - `'generic'` - The default text type for general content without specific semantic meaning or emphasis.
55
+ * - `'strong'` - A text type that provides emphasis and importance, typically rendered with increased font weight or visual prominence.
56
+ * - `'small'` - A text type for secondary or supplementary content, typically rendered with reduced size for captions, fine print, or less important information.
43
57
  *
44
58
  * @default 'generic'
45
59
  */
46
60
  type?: Extract<TextProps['type'], 'generic' | 'strong' | 'small'>;
47
61
  /**
48
- * Sets the tone of the component, based on the intention of the information being conveyed.
62
+ * Determines the visual appearance and semantic meaning of the text. Available options:
63
+ *
64
+ * - `'auto'` - Lets the system automatically choose the appropriate tone based on context. Use when you want the system to determine the most appropriate styling.
65
+ * - `'neutral'` - Gray styling for general status information that doesn't require emphasis. Use for general status updates and standard information.
66
+ * - `'info'` - Blue styling for informational content and neutral updates. Use for informational content that provides helpful context.
67
+ * - `'success'` - Green styling for positive states, completed actions, and successful operations. Use for positive outcomes and successful processes.
68
+ * - `'caution'` - Yellow styling for situations that need attention but aren't urgent. Use for potential issues that require awareness.
69
+ * - `'warning'` - Orange styling for important notices that require merchant awareness. Use for situations that need attention but aren't critical.
70
+ * - `'critical'` - Red styling for errors, failures, and urgent issues requiring immediate action. Use for urgent issues that need immediate merchant attention.
49
71
  *
50
72
  * @default 'auto'
51
73
  */
@@ -1 +1 @@
1
- {"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAmFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA8GX,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
 
@@ -58,23 +94,23 @@ export interface TextAreaJSXProps
58
94
  | 'rows'
59
95
  > {
60
96
  /**
61
- * Callback when the user makes any changes in the field.
97
+ * A callback function that executes when the user makes any changes in the field.
62
98
  */
63
99
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
64
100
  /**
65
- * Callback after editing completes (typically on blur).
101
+ * A callback function that executes after editing completes, typically on blur.
66
102
  */
67
103
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
68
104
  /**
69
- * Callback when the element loses focus.
105
+ * A callback function that executes when the element loses focus.
70
106
  */
71
107
  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
72
108
  /**
73
- * Callback when the element receives focus.
109
+ * A callback function that executes when the element receives focus.
74
110
  */
75
111
  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
76
112
  /**
77
- * Additional content to be displayed in the field. Commonly used to display clickable text.
113
+ * The additional content to be displayed in the field. Commonly used to display clickable text or action elements. Only `Button` and `Clickable` components are supported in this slot. Use the `slot="accessory"` attribute to place elements in this area.
78
114
  */
79
115
  accessory?: ComponentChild;
80
116
  }
@@ -1 +1 @@
1
- {"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA8GX,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
 
@@ -57,23 +93,23 @@ export interface TextFieldJSXProps
57
93
  | 'maxLength'
58
94
  > {
59
95
  /**
60
- * Callback when the user makes any changes in the field.
96
+ * A callback function that executes when the user makes any changes in the field.
61
97
  */
62
98
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
63
99
  /**
64
- * Callback after editing completes (typically on blur).
100
+ * A callback function that executes after editing completes, typically on blur.
65
101
  */
66
102
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
67
103
  /**
68
- * Callback when the element loses focus.
104
+ * A callback function that executes when the element loses focus.
69
105
  */
70
106
  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
71
107
  /**
72
- * Callback when the element receives focus.
108
+ * A callback function that executes when the element receives focus.
73
109
  */
74
110
  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
75
111
  /**
76
- * Additional content to be displayed in the field. Commonly used to display clickable text.
112
+ * The additional content to be displayed in the field. Commonly used to display clickable text or action elements. Only `Button` and `Clickable` components with text content only are supported in this slot. Use the `slot="accessory"` attribute to place elements in this area.
77
113
  */
78
114
  accessory?: ComponentChild;
79
115
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Tile.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Tile/Tile.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":"Tile.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Tile/Tile.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6DX,CAAC;AAEF,eAAe,IAAI,CAAC"}