@shopify/ui-extensions 2026.1.0-rc.3 → 2026.1.0-rc.5

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 (252) 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/point-of-sale/api/action-api/action-api.d.ts +3 -5
  7. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -1
  8. package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts +54 -0
  9. package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts.map +1 -0
  10. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +38 -33
  11. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
  12. package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +2 -2
  13. package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts +6 -4
  14. package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts.map +1 -1
  15. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +6 -4
  16. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -1
  17. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +4 -1
  18. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -1
  19. package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +4 -4
  20. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +6 -3
  21. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -1
  22. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +2 -3
  23. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -1
  24. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +17 -9
  25. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -1
  26. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +5 -5
  27. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +6 -10
  28. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -1
  29. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +10 -11
  30. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
  31. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +5 -2
  32. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -1
  33. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +24 -10
  34. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -1
  35. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +26 -8
  36. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -1
  37. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +3 -6
  38. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -1
  39. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +2 -1
  40. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
  41. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +3 -0
  42. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -1
  43. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +11 -1
  44. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -1
  45. package/build/ts/surfaces/point-of-sale/api.d.ts +1 -0
  46. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
  47. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts.map +1 -1
  48. package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +23 -4
  49. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts.map +1 -1
  50. package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +24 -6
  51. package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts.map +1 -1
  52. package/build/ts/surfaces/point-of-sale/components/Box.d.ts +34 -37
  53. package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts.map +1 -1
  54. package/build/ts/surfaces/point-of-sale/components/Button.d.ts +56 -16
  55. package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +14 -2
  56. package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
  57. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +41 -5
  58. package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts.map +1 -1
  59. package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +40 -4
  60. package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map +1 -1
  61. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +42 -6
  62. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
  63. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +42 -6
  64. package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map +1 -1
  65. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +42 -6
  66. package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts.map +1 -1
  67. package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +14 -2
  68. package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map +1 -1
  69. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +43 -64
  70. package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts.map +1 -1
  71. package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +15 -3
  72. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts.map +1 -1
  73. package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +17 -2
  74. package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts.map +1 -1
  75. package/build/ts/surfaces/point-of-sale/components/Image.d.ts +18 -16
  76. package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts.map +1 -1
  77. package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +43 -11
  78. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map +1 -1
  79. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +56 -41
  80. package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts.map +1 -1
  81. package/build/ts/surfaces/point-of-sale/components/Page.d.ts +19 -7
  82. package/build/ts/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.d.ts.map +1 -1
  83. package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +16 -4
  84. package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +14 -2
  85. package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -1
  86. package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +33 -36
  87. package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map +1 -1
  88. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +42 -6
  89. package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts.map +1 -1
  90. package/build/ts/surfaces/point-of-sale/components/Section.d.ts +17 -7
  91. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts.map +1 -1
  92. package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +47 -61
  93. package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts.map +1 -1
  94. package/build/ts/surfaces/point-of-sale/components/Text.d.ts +28 -6
  95. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map +1 -1
  96. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +5 -12
  97. package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map +1 -1
  98. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +43 -7
  99. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts.map +1 -1
  100. package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +40 -4
  101. package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts.map +1 -1
  102. package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +42 -6
  103. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map +1 -1
  104. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +42 -6
  105. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +638 -878
  106. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +1 -1
  107. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
  108. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
  109. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
  110. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +15 -0
  111. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
  112. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +6 -0
  113. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
  114. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +27 -0
  115. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
  116. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +18 -0
  117. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
  118. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +9 -0
  119. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
  120. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +18 -0
  121. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
  122. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +12 -0
  123. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
  124. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +27 -0
  125. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  126. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +17 -0
  127. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
  128. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +150 -0
  129. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
  130. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +43 -1
  131. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
  132. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +227 -31
  133. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  134. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +3 -0
  135. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
  136. package/build/ts/surfaces/point-of-sale/types/device.d.ts +6 -3
  137. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
  138. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +3 -3
  139. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +6 -0
  140. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
  141. package/build/ts/surfaces/point-of-sale/types/money.d.ts +18 -0
  142. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
  143. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -2
  144. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
  145. package/build/ts/surfaces/point-of-sale/types/order.d.ts +18 -0
  146. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
  147. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +2 -3
  148. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
  149. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +15 -0
  150. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
  151. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +36 -16
  152. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -1
  153. package/build/ts/surfaces/point-of-sale/types/product.d.ts +170 -0
  154. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
  155. package/build/ts/surfaces/point-of-sale/types/session.d.ts +7 -5
  156. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
  157. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +32 -0
  158. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
  159. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +13 -11
  160. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  161. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +21 -0
  162. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
  163. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +7 -0
  164. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
  165. package/build/tsconfig.tsbuildinfo +1 -1
  166. package/package.json +6 -1
  167. package/src/shared.ts +7 -7
  168. package/src/surfaces/point-of-sale/api/action-api/action-api.ts +3 -5
  169. package/src/surfaces/point-of-sale/api/camera-api/camera-api.ts +56 -0
  170. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +38 -33
  171. package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +2 -2
  172. package/src/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.ts +6 -4
  173. package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +6 -4
  174. package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +4 -1
  175. package/src/surfaces/point-of-sale/api/device-api/device-api.ts +4 -4
  176. package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +6 -3
  177. package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +2 -3
  178. package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +17 -9
  179. package/src/surfaces/point-of-sale/api/order-api/order-api.ts +5 -5
  180. package/src/surfaces/point-of-sale/api/pin-pad-api.ts +6 -10
  181. package/src/surfaces/point-of-sale/api/print-api/print-api.ts +10 -11
  182. package/src/surfaces/point-of-sale/api/product-api/product-api.ts +5 -2
  183. package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +24 -10
  184. package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +26 -8
  185. package/src/surfaces/point-of-sale/api/session-api/session-api.ts +3 -6
  186. package/src/surfaces/point-of-sale/api/standard/standard-api.ts +3 -1
  187. package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +3 -0
  188. package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +11 -1
  189. package/src/surfaces/point-of-sale/api.ts +7 -0
  190. package/src/surfaces/point-of-sale/components/Badge.d.ts +23 -4
  191. package/src/surfaces/point-of-sale/components/Banner.d.ts +24 -6
  192. package/src/surfaces/point-of-sale/components/Box.d.ts +34 -37
  193. package/src/surfaces/point-of-sale/components/Button.d.ts +56 -16
  194. package/src/surfaces/point-of-sale/components/Choice.d.ts +14 -2
  195. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +41 -5
  196. package/src/surfaces/point-of-sale/components/Clickable.d.ts +40 -4
  197. package/src/surfaces/point-of-sale/components/DateField.d.ts +42 -6
  198. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +42 -6
  199. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +42 -6
  200. package/src/surfaces/point-of-sale/components/Divider.d.ts +14 -2
  201. package/src/surfaces/point-of-sale/components/EmailField.d.ts +43 -64
  202. package/src/surfaces/point-of-sale/components/Heading.d.ts +15 -3
  203. package/src/surfaces/point-of-sale/components/Icon.d.ts +17 -2
  204. package/src/surfaces/point-of-sale/components/Image.d.ts +18 -16
  205. package/src/surfaces/point-of-sale/components/Modal.d.ts +43 -11
  206. package/src/surfaces/point-of-sale/components/NumberField.d.ts +56 -41
  207. package/src/surfaces/point-of-sale/components/Page.d.ts +19 -7
  208. package/src/surfaces/point-of-sale/components/PosBlock.d.ts +16 -4
  209. package/src/surfaces/point-of-sale/components/QrCode.d.ts +14 -2
  210. package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +33 -36
  211. package/src/surfaces/point-of-sale/components/SearchField.d.ts +42 -6
  212. package/src/surfaces/point-of-sale/components/Section.d.ts +17 -7
  213. package/src/surfaces/point-of-sale/components/Stack.d.ts +47 -61
  214. package/src/surfaces/point-of-sale/components/Text.d.ts +28 -6
  215. package/src/surfaces/point-of-sale/components/TextArea.d.ts +5 -12
  216. package/src/surfaces/point-of-sale/components/TextField.d.ts +43 -7
  217. package/src/surfaces/point-of-sale/components/Tile.d.ts +40 -4
  218. package/src/surfaces/point-of-sale/components/TimeField.d.ts +42 -6
  219. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +42 -6
  220. package/src/surfaces/point-of-sale/components/components-shared.d.ts +638 -878
  221. package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -1
  222. package/src/surfaces/point-of-sale/components.d.ts +1506 -1537
  223. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
  224. package/src/surfaces/point-of-sale/event/data/BaseData.ts +15 -0
  225. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +6 -0
  226. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +27 -0
  227. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +18 -0
  228. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +9 -0
  229. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +18 -0
  230. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +12 -0
  231. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +27 -0
  232. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +17 -0
  233. package/src/surfaces/point-of-sale/extension-targets.ts +150 -0
  234. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +43 -1
  235. package/src/surfaces/point-of-sale/types/cart.ts +227 -31
  236. package/src/surfaces/point-of-sale/types/country-code.ts +3 -0
  237. package/src/surfaces/point-of-sale/types/device.ts +6 -3
  238. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +3 -3
  239. package/src/surfaces/point-of-sale/types/discount-allocation.ts +6 -0
  240. package/src/surfaces/point-of-sale/types/money.ts +18 -0
  241. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -2
  242. package/src/surfaces/point-of-sale/types/order.ts +18 -1
  243. package/src/surfaces/point-of-sale/types/paginated-result.ts +2 -3
  244. package/src/surfaces/point-of-sale/types/payment.ts +16 -0
  245. package/src/surfaces/point-of-sale/types/pin-pad.ts +32 -14
  246. package/src/surfaces/point-of-sale/types/product.ts +170 -0
  247. package/src/surfaces/point-of-sale/types/session.ts +7 -5
  248. package/src/surfaces/point-of-sale/types/shipping-line.ts +32 -0
  249. package/src/surfaces/point-of-sale/types/storage.ts +13 -11
  250. package/src/surfaces/point-of-sale/types/tax-line.ts +21 -0
  251. package/src/surfaces/point-of-sale/types/transaction-type.ts +7 -0
  252. package/src/surfaces/point-of-sale/components/EmailField/examples/accessory-slot.jsx +0 -9
@@ -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,6BAqEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -8,88 +8,67 @@
8
8
  /* eslint-disable import-x/namespace */
9
9
  // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
10
10
  /// <reference lib="DOM" />
11
- import type {
12
- EmailFieldProps,
13
- Key,
14
- Ref,
15
- ComponentChild,
16
- } from './components-shared.d.ts';
11
+ import type {EmailFieldProps,Key, Ref} from './components-shared.d.ts';
17
12
 
18
13
  export type ComponentChildren = any;
19
14
  /**
20
15
  * Used when an element does not have children.
21
16
  */
22
17
  export interface BaseElementProps<TClass = HTMLElement> {
23
- key?: Key;
24
- ref?: Ref<TClass>;
25
- slot?: Lowercase<string>;
18
+ key?: Key;
19
+ ref?: Ref<TClass>;
20
+ slot?: Lowercase<string>;
26
21
  }
27
22
  /**
28
23
  * Used when an element has children.
29
24
  */
30
- export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
- extends BaseElementProps<TClass> {
32
- children?: ComponentChildren;
25
+ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends BaseElementProps<TClass> {
26
+ children?: ComponentChildren;
33
27
  }
34
- export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
28
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T & HTMLElement>;
29
+ export type HtmlElementTagNameProps<T> = T & HTMLElement;
35
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
36
- currentTarget: HTMLElementTagNameMap[T];
37
- bubbles?: boolean;
38
- cancelable?: boolean;
39
- composed?: boolean;
40
- detail?: any;
41
- eventPhase: number;
42
- target: HTMLElementTagNameMap[T] | null;
31
+ currentTarget: HTMLElementTagNameMap[T];
32
+ bubbles?: boolean;
33
+ cancelable?: boolean;
34
+ composed?: boolean;
35
+ detail?: any;
36
+ eventPhase: number;
37
+ target: HTMLElementTagNameMap[T] | null;
43
38
  }
44
39
 
45
- declare const tagName = 's-email-field';
46
- export interface EmailFieldJSXProps
47
- extends Pick<
48
- EmailFieldProps,
49
- | 'id'
50
- | 'label'
51
- | 'value'
52
- | 'placeholder'
53
- | 'disabled'
54
- | 'error'
55
- | 'required'
56
- | 'maxLength'
57
- | 'details'
58
- > {
59
- /**
60
- * Callback when the user makes any changes in the field.
61
- */
62
- onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
63
- /**
64
- * Callback after editing completes (typically on blur).
65
- */
66
- onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
67
- /**
68
- * Callback when the element loses focus.
69
- */
70
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
71
- /**
72
- * Callback when the element receives focus.
73
- */
74
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
75
- /**
76
- * Additional content to be displayed in the field. Commonly used to display clickable text.
77
- */
78
- accessory?: ComponentChild;
40
+ declare const tagName = "s-email-field";
41
+ export interface EmailFieldJSXProps extends Pick<EmailFieldProps, 'id' | 'label' | 'value' | 'placeholder' | 'disabled' | 'error' | 'required' | 'maxLength' | 'details'> {
42
+ /**
43
+ * Callback when the user makes any changes in the field.
44
+ */
45
+ onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
46
+ /**
47
+ * Callback after editing completes (typically on blur).
48
+ */
49
+ onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
50
+ /**
51
+ * Callback when the element loses focus.
52
+ */
53
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
54
+ /**
55
+ * Callback when the element receives focus.
56
+ */
57
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
79
58
  }
80
- export type ElementProps = Omit<EmailFieldJSXProps, 'accessory'>;
59
+ export type ElementProps = EmailFieldJSXProps;
81
60
  declare global {
82
- interface HTMLElementTagNameMap {
83
- [tagName]: ElementProps;
84
- }
61
+ interface HTMLElementTagNameMap {
62
+ [tagName]: HtmlElementTagNameProps<ElementProps>;
63
+ }
85
64
  }
86
65
  declare module 'preact' {
87
- namespace createElement.JSX {
88
- interface IntrinsicElements {
89
- [tagName]: IntrinsicElementProps<ElementProps>;
66
+ namespace createElement.JSX {
67
+ interface IntrinsicElements {
68
+ [tagName]: IntrinsicElementProps<ElementProps>;
69
+ }
90
70
  }
91
- }
92
71
  }
93
72
 
94
- export {tagName};
95
- export type {EmailFieldJSXProps};
73
+ export { tagName };
74
+ export type { EmailFieldJSXProps };
@@ -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"}
@@ -12,18 +12,30 @@ import type {ImageProps, 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,26 +43,16 @@ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
31
43
  declare const tagName = 's-image';
32
44
  export interface ImageJSXProps extends Pick<ImageProps, 'id' | 'objectFit'> {
33
45
  /**
34
- * The displayed inline width of the image.
35
- *
36
- * - `fill`: the image will takes up 100% of the available inline size.
37
- * - `auto`: the image will be displayed at its natural size.
46
+ * Controls the displayed width of the image. Choose based on your layout requirements. For mobile interfaces, consider using `'fill'` with defined container dimensions to ensure consistent image display, as dynamic container heights can cause layout inconsistencies in scrollable views.
38
47
  *
39
- * **Mobile surfaces:** Always wrap your image in a box with a set width and height.
40
- * ScrollViews on mobile have a dynamic height, which can cause images to appear
41
- * inconsistently without defined dimensions.
48
+ * - `'auto'` - Displays the image at its natural size. The image will not render until it has loaded, and the aspect ratio will be ignored. Use for images where maintaining original dimensions is important.
49
+ * - `'fill'` - Makes the image take up 100% of the available inline size. The aspect ratio will be respected and the image will take the necessary space. Use for responsive layouts and flexible image containers.
42
50
  *
43
51
  * @default 'fill'
44
- *
45
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width
46
52
  */
47
53
  inlineSize?: ImageProps['inlineSize'];
48
54
  /**
49
- * The image source, which should be a remote URL.
50
- *
51
- * When the image is loading or no `src` is provided, a placeholder will be rendered.
52
- *
53
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
55
+ * The image source URL (remote URL or local file resource). When loading or no src is provided, a placeholder is rendered. Ensure URLs are properly formatted and properly formatted.
54
56
  */
55
57
  src?: ImageProps['src'];
56
58
  }
@@ -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"}