@shopify/ui-extensions 2025.10.8 → 2025.10.10

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
@@ -1 +1 @@
1
- {"version":3,"file":"DateField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateField/DateField.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":"DateField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateField/DateField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,28 +12,64 @@ import type {DateFieldProps, 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>;
42
+ /**
43
+ * 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.
44
+ */
30
45
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
46
+ /**
47
+ * The element that the event listener is attached to.
48
+ */
31
49
  currentTarget: HTMLElementTagNameMap[T];
50
+ /**
51
+ * Whether the event bubbles up through the DOM tree.
52
+ */
32
53
  bubbles?: boolean;
54
+ /**
55
+ * Whether the event can be canceled.
56
+ */
33
57
  cancelable?: boolean;
58
+ /**
59
+ * Whether the event will trigger listeners outside of a shadow root.
60
+ */
34
61
  composed?: boolean;
62
+ /**
63
+ * Additional data associated with the event.
64
+ */
35
65
  detail?: any;
66
+ /**
67
+ * The current phase of the event flow.
68
+ */
36
69
  eventPhase: number;
70
+ /**
71
+ * The element that triggered the event.
72
+ */
37
73
  target: HTMLElementTagNameMap[T] | null;
38
74
  }
39
75
 
@@ -44,19 +80,19 @@ export interface DateFieldJSXProps
44
80
  'id' | 'label' | 'details' | 'value' | 'disabled' | 'error'
45
81
  > {
46
82
  /**
47
- * Callback when the user makes any changes in the field.
83
+ * Called when the user makes any changes in the field.
48
84
  */
49
85
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
50
86
  /**
51
- * Callback after editing completes (typically on blur).
87
+ * Called after editing completes, typically on blur.
52
88
  */
53
89
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
54
90
  /**
55
- * Callback when the element loses focus.
91
+ * Called when the element loses focus.
56
92
  */
57
93
  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
58
94
  /**
59
- * Callback when the element receives focus.
95
+ * Called when the element receives focus.
60
96
  */
61
97
  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
62
98
  }
@@ -1 +1 @@
1
- {"version":3,"file":"DatePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"DatePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,28 +12,64 @@ import type {DatePickerProps, 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>;
42
+ /**
43
+ * 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.
44
+ */
30
45
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
46
+ /**
47
+ * The element that the event listener is attached to.
48
+ */
31
49
  currentTarget: HTMLElementTagNameMap[T];
50
+ /**
51
+ * Whether the event bubbles up through the DOM tree.
52
+ */
32
53
  bubbles?: boolean;
54
+ /**
55
+ * Whether the event can be canceled.
56
+ */
33
57
  cancelable?: boolean;
58
+ /**
59
+ * Whether the event will trigger listeners outside of a shadow root.
60
+ */
34
61
  composed?: boolean;
62
+ /**
63
+ * Additional data associated with the event.
64
+ */
35
65
  detail?: any;
66
+ /**
67
+ * The current phase of the event flow.
68
+ */
36
69
  eventPhase: number;
70
+ /**
71
+ * The element that triggered the event.
72
+ */
37
73
  target: HTMLElementTagNameMap[T] | null;
38
74
  }
39
75
 
@@ -41,19 +77,19 @@ declare const tagName = 's-date-picker';
41
77
  export interface DatePickerJSXProps
42
78
  extends Pick<DatePickerProps, 'id' | 'value'> {
43
79
  /**
44
- * Callback when the user selects a date from the picker.
80
+ * Called when the user selects a date from the picker.
45
81
  */
46
82
  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
47
83
  /**
48
- * Callback when the user selects a date from the picker that is different to the current value.
84
+ * Called when the user selects a date from the picker that is different from the current value.
49
85
  */
50
86
  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
51
87
  /**
52
- * Callback when the date picker is dismissed.
88
+ * Called when the date picker is dismissed or closed.
53
89
  */
54
90
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
55
91
  /**
56
- * Callback when the date picker is revealed.
92
+ * Called when the date picker is revealed or opened.
57
93
  */
58
94
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
59
95
  }
@@ -1 +1 @@
1
- {"version":3,"file":"DateSpinner.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"DateSpinner.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAmFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,28 +12,64 @@ import type {DateSpinnerProps, 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>;
42
+ /**
43
+ * 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.
44
+ */
30
45
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
46
+ /**
47
+ * The element that the event listener is attached to.
48
+ */
31
49
  currentTarget: HTMLElementTagNameMap[T];
50
+ /**
51
+ * Whether the event bubbles up through the DOM tree.
52
+ */
32
53
  bubbles?: boolean;
54
+ /**
55
+ * Whether the event can be canceled.
56
+ */
33
57
  cancelable?: boolean;
58
+ /**
59
+ * Whether the event will trigger listeners outside of a shadow root.
60
+ */
34
61
  composed?: boolean;
62
+ /**
63
+ * Additional data associated with the event.
64
+ */
35
65
  detail?: any;
66
+ /**
67
+ * The current phase of the event flow.
68
+ */
36
69
  eventPhase: number;
70
+ /**
71
+ * The element that triggered the event.
72
+ */
37
73
  target: HTMLElementTagNameMap[T] | null;
38
74
  }
39
75
 
@@ -41,19 +77,19 @@ declare const tagName = 's-date-spinner';
41
77
  export interface DateSpinnerJSXProps
42
78
  extends Pick<DateSpinnerProps, 'id' | 'value'> {
43
79
  /**
44
- * Callback when the user makes a selection.
80
+ * Called when the user makes a selection in the spinner.
45
81
  */
46
82
  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
47
83
  /**
48
- * Callback when the value changes. Only called when a different value is selected.
84
+ * Called when the value changes. Only called when a different value is selected.
49
85
  */
50
86
  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
51
87
  /**
52
- * Callback when the date spinner is dismissed.
88
+ * Called when the date spinner is dismissed or closed.
53
89
  */
54
90
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
55
91
  /**
56
- * Callback when the date spinner is revealed.
92
+ * Called when the date spinner is revealed or opened.
57
93
  */
58
94
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
59
95
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Divider.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Divider/Divider.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":"Divider.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Divider/Divider.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA2CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,18 +12,30 @@ import type {DividerProps, 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":"EmailField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/EmailField/EmailField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"EmailField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/EmailField/EmailField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAiGX,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
+ * 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 EmailFieldJSXProps
57
93
  | 'details'
58
94
  > {
59
95
  /**
60
- * Callback when the user makes any changes in the field.
96
+ * Called 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
+ * Called 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
+ * Called 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
+ * Called 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
+ * 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.
77
113
  */
78
114
  accessory?: ComponentChild;
79
115
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Heading.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Heading/Heading.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"Heading.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Heading/Heading.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,18 +12,30 @@ import type {HeadingProps, 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 content of the heading, typically text that describes the section or page it introduces.
38
+ */
27
39
  children?: ComponentChildren;
28
40
  }
29
41
  export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
@@ -31,7 +43,7 @@ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
31
43
  declare const tagName = 's-heading';
32
44
  export interface HeadingJSXProps extends Pick<HeadingProps, 'id'> {
33
45
  /**
34
- * The content of the Heading.
46
+ * The content of the heading, typically text that describes the section or page it introduces.
35
47
  */
36
48
  children?: ComponentChildren;
37
49
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Icon.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Icon/Icon.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":"Icon.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Icon/Icon.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA+CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -12,23 +12,38 @@ import type {IconProps, 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>;
30
42
 
31
43
  declare const tagName = 's-icon';
44
+ /**
45
+ * Lists all currently supported icon names available for use in the POS interface. Reference this list when selecting icons to ensure compatibility and availability.
46
+ */
32
47
  export type SupportedIconNames = Extract<
33
48
  IconProps['type'],
34
49
  | 'alert-circle'
@@ -1 +1 @@
1
- {"version":3,"file":"Image.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Image/Image.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":"Image.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Image/Image.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -26,10 +26,13 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
- export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
+ export type IntrinsicElementProps<T> = T &
30
+ BaseElementPropsWithChildren<T & HTMLElement>;
31
+ export type HtmlElementTagNameProps<T> = T & HTMLElement;
30
32
 
31
33
  declare const tagName = 's-image';
32
- export interface ImageJSXProps extends Pick<ImageProps, 'id' | 'objectFit'> {
34
+ export interface ImageJSXProps
35
+ extends Pick<ImageProps, 'id' | 'objectFit' | 'alt'> {
33
36
  /**
34
37
  * The displayed inline width of the image.
35
38
  *
@@ -56,7 +59,7 @@ export interface ImageJSXProps extends Pick<ImageProps, 'id' | 'objectFit'> {
56
59
  }
57
60
  declare global {
58
61
  interface HTMLElementTagNameMap {
59
- [tagName]: ImageJSXProps;
62
+ [tagName]: HtmlElementTagNameProps<ImageJSXProps>;
60
63
  }
61
64
  }
62
65
  declare module 'preact' {
@@ -1 +1 @@
1
- {"version":3,"file":"Modal.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Modal/Modal.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"Modal.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Modal/Modal.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -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
  }