@shopify/ui-extensions 2025.7.2 → 2025.7.4

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 (381) hide show
  1. package/build/cjs/surfaces/point-of-sale/render/components/Badge/Badge.js +0 -7
  2. package/build/cjs/surfaces/point-of-sale/render/components/Banner/Banner.js +0 -9
  3. package/build/cjs/surfaces/point-of-sale/render/components/Button/Button.js +0 -8
  4. package/build/cjs/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.js +0 -6
  5. package/build/cjs/surfaces/point-of-sale/render/components/DatePicker/DatePicker.js +0 -8
  6. package/build/cjs/surfaces/point-of-sale/render/components/Dialog/Dialog.js +0 -12
  7. package/build/cjs/surfaces/point-of-sale/render/components/Image/Image.js +7 -2
  8. package/build/cjs/surfaces/point-of-sale/render/components/Navigator/Navigator.js +0 -4
  9. package/build/cjs/surfaces/point-of-sale/render/components/NumberField/NumberField.js +0 -6
  10. package/build/cjs/surfaces/point-of-sale/render/components/POSBlock/POSBlock.js +0 -6
  11. package/build/cjs/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.js +0 -4
  12. package/build/cjs/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.js +0 -5
  13. package/build/cjs/surfaces/point-of-sale/render/components/PinPad/PinPad.js +16 -20
  14. package/build/cjs/surfaces/point-of-sale/render/components/QRCode/QRCode.js +0 -5
  15. package/build/cjs/surfaces/point-of-sale/render/components/Screen/Screen.js +0 -22
  16. package/build/cjs/surfaces/point-of-sale/render/components/Section/Section.js +2 -8
  17. package/build/cjs/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.js +4 -0
  18. package/build/cjs/surfaces/point-of-sale/render/components/Stack/Stack.js +4 -0
  19. package/build/cjs/surfaces/point-of-sale/render/components/Text/Text.js +28 -0
  20. package/build/cjs/surfaces/point-of-sale/render/components/TextArea/TextArea.js +0 -6
  21. package/build/cjs/surfaces/point-of-sale/render/components/Tile/Tile.js +0 -10
  22. package/build/cjs/surfaces/point-of-sale/render/components/TimePicker/TimePicker.js +0 -9
  23. package/build/cjs/surfaces/point-of-sale/types/storage.js +3 -0
  24. package/build/esm/surfaces/point-of-sale/render/components/Badge/Badge.mjs +0 -7
  25. package/build/esm/surfaces/point-of-sale/render/components/Banner/Banner.mjs +0 -9
  26. package/build/esm/surfaces/point-of-sale/render/components/Button/Button.mjs +0 -8
  27. package/build/esm/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.mjs +0 -6
  28. package/build/esm/surfaces/point-of-sale/render/components/DatePicker/DatePicker.mjs +0 -8
  29. package/build/esm/surfaces/point-of-sale/render/components/Dialog/Dialog.mjs +0 -12
  30. package/build/esm/surfaces/point-of-sale/render/components/Image/Image.mjs +7 -2
  31. package/build/esm/surfaces/point-of-sale/render/components/Navigator/Navigator.mjs +0 -4
  32. package/build/esm/surfaces/point-of-sale/render/components/NumberField/NumberField.mjs +0 -6
  33. package/build/esm/surfaces/point-of-sale/render/components/POSBlock/POSBlock.mjs +0 -6
  34. package/build/esm/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.mjs +0 -4
  35. package/build/esm/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.mjs +0 -5
  36. package/build/esm/surfaces/point-of-sale/render/components/PinPad/PinPad.mjs +16 -20
  37. package/build/esm/surfaces/point-of-sale/render/components/QRCode/QRCode.mjs +0 -5
  38. package/build/esm/surfaces/point-of-sale/render/components/Screen/Screen.mjs +0 -22
  39. package/build/esm/surfaces/point-of-sale/render/components/Section/Section.mjs +2 -8
  40. package/build/esm/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.mjs +4 -0
  41. package/build/esm/surfaces/point-of-sale/render/components/Stack/Stack.mjs +4 -0
  42. package/build/esm/surfaces/point-of-sale/render/components/Text/Text.mjs +28 -0
  43. package/build/esm/surfaces/point-of-sale/render/components/TextArea/TextArea.mjs +0 -6
  44. package/build/esm/surfaces/point-of-sale/render/components/Tile/Tile.mjs +0 -10
  45. package/build/esm/surfaces/point-of-sale/render/components/TimePicker/TimePicker.mjs +0 -9
  46. package/build/esm/surfaces/point-of-sale/types/storage.mjs +3 -0
  47. package/build/esnext/surfaces/point-of-sale/render/components/Badge/Badge.esnext +0 -7
  48. package/build/esnext/surfaces/point-of-sale/render/components/Banner/Banner.esnext +0 -9
  49. package/build/esnext/surfaces/point-of-sale/render/components/Button/Button.esnext +0 -8
  50. package/build/esnext/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.esnext +0 -6
  51. package/build/esnext/surfaces/point-of-sale/render/components/DatePicker/DatePicker.esnext +0 -8
  52. package/build/esnext/surfaces/point-of-sale/render/components/Dialog/Dialog.esnext +0 -12
  53. package/build/esnext/surfaces/point-of-sale/render/components/Image/Image.esnext +7 -2
  54. package/build/esnext/surfaces/point-of-sale/render/components/Navigator/Navigator.esnext +0 -4
  55. package/build/esnext/surfaces/point-of-sale/render/components/NumberField/NumberField.esnext +0 -6
  56. package/build/esnext/surfaces/point-of-sale/render/components/POSBlock/POSBlock.esnext +0 -6
  57. package/build/esnext/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.esnext +0 -4
  58. package/build/esnext/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.esnext +0 -5
  59. package/build/esnext/surfaces/point-of-sale/render/components/PinPad/PinPad.esnext +16 -20
  60. package/build/esnext/surfaces/point-of-sale/render/components/QRCode/QRCode.esnext +0 -5
  61. package/build/esnext/surfaces/point-of-sale/render/components/Screen/Screen.esnext +0 -22
  62. package/build/esnext/surfaces/point-of-sale/render/components/Section/Section.esnext +2 -8
  63. package/build/esnext/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.esnext +4 -0
  64. package/build/esnext/surfaces/point-of-sale/render/components/Stack/Stack.esnext +4 -0
  65. package/build/esnext/surfaces/point-of-sale/render/components/Text/Text.esnext +28 -0
  66. package/build/esnext/surfaces/point-of-sale/render/components/TextArea/TextArea.esnext +0 -6
  67. package/build/esnext/surfaces/point-of-sale/render/components/Tile/Tile.esnext +0 -10
  68. package/build/esnext/surfaces/point-of-sale/render/components/TimePicker/TimePicker.esnext +0 -9
  69. package/build/esnext/surfaces/point-of-sale/types/storage.esnext +3 -0
  70. package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.d.ts +4 -0
  71. package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.d.ts.map +1 -0
  72. package/build/ts/surfaces/admin/api/picker/picker.doc.d.ts.map +1 -1
  73. package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.doc.d.ts +4 -0
  74. package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.doc.d.ts.map +1 -0
  75. package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.d.ts +4 -0
  76. package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.d.ts.map +1 -0
  77. package/build/ts/surfaces/admin/api/purchase-options-card-action/purchase-options-card-action.doc.d.ts +4 -0
  78. package/build/ts/surfaces/admin/api/purchase-options-card-action/purchase-options-card-action.doc.d.ts.map +1 -0
  79. package/build/ts/surfaces/admin/api/resource-picker/resource-picker.doc.d.ts.map +1 -1
  80. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +3 -0
  81. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  82. package/build/ts/surfaces/point-of-sale/api.d.ts +1 -1
  83. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
  84. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
  85. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
  86. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +15 -0
  87. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
  88. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +6 -0
  89. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
  90. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +27 -0
  91. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
  92. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +18 -0
  93. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
  94. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +9 -0
  95. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
  96. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +18 -0
  97. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
  98. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +12 -0
  99. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
  100. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +27 -0
  101. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  102. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +14 -0
  103. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
  104. package/build/ts/surfaces/point-of-sale/render/api/action-api/action-api.d.ts +3 -5
  105. package/build/ts/surfaces/point-of-sale/render/api/action-api/action-api.d.ts.map +1 -1
  106. package/build/ts/surfaces/point-of-sale/render/api/cart-api/cart-api.d.ts +37 -31
  107. package/build/ts/surfaces/point-of-sale/render/api/cart-api/cart-api.d.ts.map +1 -1
  108. package/build/ts/surfaces/point-of-sale/render/api/cart-line-item-api/cart-line-item-api.d.ts +2 -2
  109. package/build/ts/surfaces/point-of-sale/render/api/connectivity-api/connectivity-api.d.ts +6 -4
  110. package/build/ts/surfaces/point-of-sale/render/api/connectivity-api/connectivity-api.d.ts.map +1 -1
  111. package/build/ts/surfaces/point-of-sale/render/api/customer-api/customer-api.d.ts +4 -1
  112. package/build/ts/surfaces/point-of-sale/render/api/customer-api/customer-api.d.ts.map +1 -1
  113. package/build/ts/surfaces/point-of-sale/render/api/device-api/device-api.d.ts +8 -4
  114. package/build/ts/surfaces/point-of-sale/render/api/device-api/device-api.d.ts.map +1 -1
  115. package/build/ts/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.d.ts +6 -3
  116. package/build/ts/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.d.ts.map +1 -1
  117. package/build/ts/surfaces/point-of-sale/render/api/locale-api/locale-api.d.ts +3 -4
  118. package/build/ts/surfaces/point-of-sale/render/api/locale-api/locale-api.d.ts.map +1 -1
  119. package/build/ts/surfaces/point-of-sale/render/api/navigation-api/navigation-api.d.ts +9 -7
  120. package/build/ts/surfaces/point-of-sale/render/api/navigation-api/navigation-api.d.ts.map +1 -1
  121. package/build/ts/surfaces/point-of-sale/render/api/order-api/order-api.d.ts +5 -5
  122. package/build/ts/surfaces/point-of-sale/render/api/print-api/print-api.d.ts +7 -12
  123. package/build/ts/surfaces/point-of-sale/render/api/print-api/print-api.d.ts.map +1 -1
  124. package/build/ts/surfaces/point-of-sale/render/api/product-api/product-api.d.ts +5 -2
  125. package/build/ts/surfaces/point-of-sale/render/api/product-api/product-api.d.ts.map +1 -1
  126. package/build/ts/surfaces/point-of-sale/render/api/product-search-api/product-search-api.d.ts +24 -10
  127. package/build/ts/surfaces/point-of-sale/render/api/product-search-api/product-search-api.d.ts.map +1 -1
  128. package/build/ts/surfaces/point-of-sale/render/api/scanner-api/scanner-api.d.ts +22 -10
  129. package/build/ts/surfaces/point-of-sale/render/api/scanner-api/scanner-api.d.ts.map +1 -1
  130. package/build/ts/surfaces/point-of-sale/render/api/session-api/session-api.d.ts +3 -6
  131. package/build/ts/surfaces/point-of-sale/render/api/session-api/session-api.d.ts.map +1 -1
  132. package/build/ts/surfaces/point-of-sale/render/api/storage-api/storage-api.d.ts +7 -0
  133. package/build/ts/surfaces/point-of-sale/render/api/storage-api/storage-api.d.ts.map +1 -1
  134. package/build/ts/surfaces/point-of-sale/render/api/toast-api/toast-api.d.ts +11 -1
  135. package/build/ts/surfaces/point-of-sale/render/api/toast-api/toast-api.d.ts.map +1 -1
  136. package/build/ts/surfaces/point-of-sale/render/components/Badge/Badge.d.ts +12 -9
  137. package/build/ts/surfaces/point-of-sale/render/components/Badge/Badge.d.ts.map +1 -1
  138. package/build/ts/surfaces/point-of-sale/render/components/Banner/Banner.d.ts +13 -14
  139. package/build/ts/surfaces/point-of-sale/render/components/Banner/Banner.d.ts.map +1 -1
  140. package/build/ts/surfaces/point-of-sale/render/components/Button/Button.d.ts +9 -15
  141. package/build/ts/surfaces/point-of-sale/render/components/Button/Button.d.ts.map +1 -1
  142. package/build/ts/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.d.ts +6 -8
  143. package/build/ts/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.d.ts.map +1 -1
  144. package/build/ts/surfaces/point-of-sale/render/components/DatePicker/DatePicker.d.ts +8 -11
  145. package/build/ts/surfaces/point-of-sale/render/components/DatePicker/DatePicker.d.ts.map +1 -1
  146. package/build/ts/surfaces/point-of-sale/render/components/Dialog/Dialog.d.ts +13 -20
  147. package/build/ts/surfaces/point-of-sale/render/components/Dialog/Dialog.d.ts.map +1 -1
  148. package/build/ts/surfaces/point-of-sale/render/components/Icon/Icon.d.ts +10 -8
  149. package/build/ts/surfaces/point-of-sale/render/components/Icon/Icon.d.ts.map +1 -1
  150. package/build/ts/surfaces/point-of-sale/render/components/Image/Image.d.ts +10 -5
  151. package/build/ts/surfaces/point-of-sale/render/components/Image/Image.d.ts.map +1 -1
  152. package/build/ts/surfaces/point-of-sale/render/components/List/List.d.ts +30 -25
  153. package/build/ts/surfaces/point-of-sale/render/components/List/List.d.ts.map +1 -1
  154. package/build/ts/surfaces/point-of-sale/render/components/Navigator/Navigator.d.ts +1 -4
  155. package/build/ts/surfaces/point-of-sale/render/components/Navigator/Navigator.d.ts.map +1 -1
  156. package/build/ts/surfaces/point-of-sale/render/components/NumberField/NumberField.d.ts +7 -7
  157. package/build/ts/surfaces/point-of-sale/render/components/NumberField/NumberField.d.ts.map +1 -1
  158. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlock.d.ts +8 -10
  159. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlock.d.ts.map +1 -1
  160. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.d.ts +1 -4
  161. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.d.ts.map +1 -1
  162. package/build/ts/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.d.ts +0 -4
  163. package/build/ts/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.d.ts.map +1 -1
  164. package/build/ts/surfaces/point-of-sale/render/components/PinPad/PinPad.d.ts +25 -28
  165. package/build/ts/surfaces/point-of-sale/render/components/PinPad/PinPad.d.ts.map +1 -1
  166. package/build/ts/surfaces/point-of-sale/render/components/PrintPreview/PrintPreview.d.ts +1 -11
  167. package/build/ts/surfaces/point-of-sale/render/components/PrintPreview/PrintPreview.d.ts.map +1 -1
  168. package/build/ts/surfaces/point-of-sale/render/components/QRCode/QRCode.d.ts +1 -5
  169. package/build/ts/surfaces/point-of-sale/render/components/QRCode/QRCode.d.ts.map +1 -1
  170. package/build/ts/surfaces/point-of-sale/render/components/RadioButtonList/RadioButtonList.d.ts +7 -5
  171. package/build/ts/surfaces/point-of-sale/render/components/RadioButtonList/RadioButtonList.d.ts.map +1 -1
  172. package/build/ts/surfaces/point-of-sale/render/components/Screen/Screen.d.ts +13 -33
  173. package/build/ts/surfaces/point-of-sale/render/components/Screen/Screen.d.ts.map +1 -1
  174. package/build/ts/surfaces/point-of-sale/render/components/SearchBar/SearchBar.d.ts +7 -7
  175. package/build/ts/surfaces/point-of-sale/render/components/Section/Section.d.ts +6 -11
  176. package/build/ts/surfaces/point-of-sale/render/components/Section/Section.d.ts.map +1 -1
  177. package/build/ts/surfaces/point-of-sale/render/components/SectionHeader/SectionHeader.d.ts +9 -7
  178. package/build/ts/surfaces/point-of-sale/render/components/SectionHeader/SectionHeader.d.ts.map +1 -1
  179. package/build/ts/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.d.ts +9 -6
  180. package/build/ts/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.d.ts.map +1 -1
  181. package/build/ts/surfaces/point-of-sale/render/components/Selectable/Selectable.d.ts +2 -2
  182. package/build/ts/surfaces/point-of-sale/render/components/Stack/Stack.d.ts +22 -22
  183. package/build/ts/surfaces/point-of-sale/render/components/Stack/Stack.d.ts.map +1 -1
  184. package/build/ts/surfaces/point-of-sale/render/components/Stepper/Stepper.d.ts +8 -6
  185. package/build/ts/surfaces/point-of-sale/render/components/Stepper/Stepper.d.ts.map +1 -1
  186. package/build/ts/surfaces/point-of-sale/render/components/Text/Text.d.ts +28 -2
  187. package/build/ts/surfaces/point-of-sale/render/components/Text/Text.d.ts.map +1 -1
  188. package/build/ts/surfaces/point-of-sale/render/components/TextArea/TextArea.d.ts +1 -6
  189. package/build/ts/surfaces/point-of-sale/render/components/TextArea/TextArea.d.ts.map +1 -1
  190. package/build/ts/surfaces/point-of-sale/render/components/TextField/TextField.d.ts +30 -0
  191. package/build/ts/surfaces/point-of-sale/render/components/TextField/TextField.d.ts.map +1 -1
  192. package/build/ts/surfaces/point-of-sale/render/components/Tile/Tile.d.ts +6 -15
  193. package/build/ts/surfaces/point-of-sale/render/components/Tile/Tile.d.ts.map +1 -1
  194. package/build/ts/surfaces/point-of-sale/render/components/TimeField/TimeField.d.ts +2 -1
  195. package/build/ts/surfaces/point-of-sale/render/components/TimeField/TimeField.d.ts.map +1 -1
  196. package/build/ts/surfaces/point-of-sale/render/components/TimePicker/TimePicker.d.ts +10 -14
  197. package/build/ts/surfaces/point-of-sale/render/components/TimePicker/TimePicker.d.ts.map +1 -1
  198. package/build/ts/surfaces/point-of-sale/render/components/shared/BaseTextField.d.ts +6 -14
  199. package/build/ts/surfaces/point-of-sale/render/components/shared/BaseTextField.d.ts.map +1 -1
  200. package/build/ts/surfaces/point-of-sale/render/components/shared/InputField.d.ts +16 -37
  201. package/build/ts/surfaces/point-of-sale/render/components/shared/InputField.d.ts.map +1 -1
  202. package/build/ts/surfaces/point-of-sale/render/components/shared/box.d.ts +31 -42
  203. package/build/ts/surfaces/point-of-sale/render/components/shared/box.d.ts.map +1 -1
  204. package/build/ts/surfaces/point-of-sale/render/components/shared/deprecated-types.d.ts +12 -0
  205. package/build/ts/surfaces/point-of-sale/render/components/shared/deprecated-types.d.ts.map +1 -1
  206. package/build/ts/surfaces/point-of-sale/render/components/shared/inner-layouts.d.ts +13 -7
  207. package/build/ts/surfaces/point-of-sale/render/components/shared/inner-layouts.d.ts.map +1 -1
  208. package/build/ts/surfaces/point-of-sale/render/components/shared/sizes.d.ts +3 -1
  209. package/build/ts/surfaces/point-of-sale/render/components/shared/sizes.d.ts.map +1 -1
  210. package/build/ts/surfaces/point-of-sale/targets.d.ts +135 -0
  211. package/build/ts/surfaces/point-of-sale/targets.d.ts.map +1 -1
  212. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +39 -0
  213. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
  214. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +265 -22
  215. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  216. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +3 -0
  217. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
  218. package/build/ts/surfaces/point-of-sale/types/device.d.ts +6 -3
  219. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
  220. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +3 -3
  221. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +6 -0
  222. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
  223. package/build/ts/surfaces/point-of-sale/types/money.d.ts +18 -0
  224. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
  225. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -2
  226. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
  227. package/build/ts/surfaces/point-of-sale/types/order.d.ts +18 -0
  228. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
  229. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +2 -3
  230. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
  231. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +15 -0
  232. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
  233. package/build/ts/surfaces/point-of-sale/types/product.d.ts +172 -0
  234. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
  235. package/build/ts/surfaces/point-of-sale/types/session.d.ts +7 -5
  236. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
  237. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +32 -0
  238. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
  239. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +13 -11
  240. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  241. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +21 -0
  242. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
  243. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +7 -0
  244. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
  245. package/build/tsconfig.tsbuildinfo +1 -1
  246. package/package.json +6 -1
  247. package/src/surfaces/admin/api/action/action.doc.ts +2 -2
  248. package/src/surfaces/admin/api/block/block.doc.ts +2 -2
  249. package/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts +2 -2
  250. package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts +3 -3
  251. package/src/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.ts +2 -2
  252. package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.ts +21 -0
  253. package/src/surfaces/admin/api/picker/picker.doc.ts +4 -3
  254. package/src/surfaces/admin/api/print-action/print-action.doc.ts +2 -2
  255. package/src/surfaces/admin/api/product-configuration/product-details-configuration.doc.ts +21 -0
  256. package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.ts +21 -0
  257. package/src/surfaces/admin/api/purchase-options-card-action/purchase-options-card-action.doc.ts +21 -0
  258. package/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts +4 -3
  259. package/src/surfaces/admin/api/should-render/should-render.doc.ts +3 -3
  260. package/src/surfaces/admin/api/standard/standard.doc.ts +2 -2
  261. package/src/surfaces/admin/components/AdminAction/AdminAction.doc.ts +2 -2
  262. package/src/surfaces/admin/components/AdminBlock/AdminBlock.doc.ts +2 -2
  263. package/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.doc.ts +2 -2
  264. package/src/surfaces/admin/components/Badge/Badge.doc.ts +2 -2
  265. package/src/surfaces/admin/components/Banner/Banner.doc.ts +2 -2
  266. package/src/surfaces/admin/components/BlockStack/BlockStack.doc.ts +2 -2
  267. package/src/surfaces/admin/components/Box/Box.doc.ts +2 -2
  268. package/src/surfaces/admin/components/Button/Button.doc.ts +1 -1
  269. package/src/surfaces/admin/components/Checkbox/Checkbox.doc.ts +1 -1
  270. package/src/surfaces/admin/components/ChoiceList/ChoiceList.doc.ts +1 -1
  271. package/src/surfaces/admin/components/ColorPicker/ColorPicker.doc.ts +1 -1
  272. package/src/surfaces/admin/components/CustomerSegmentTemplate/CustomerSegmentTemplate.doc.ts +2 -2
  273. package/src/surfaces/admin/components/DateField/DateField.doc.ts +1 -1
  274. package/src/surfaces/admin/components/DatePicker/DatePicker.doc.ts +1 -1
  275. package/src/surfaces/admin/components/Divider/Divider.doc.ts +2 -2
  276. package/src/surfaces/admin/components/EmailField/EmailField.doc.ts +1 -1
  277. package/src/surfaces/admin/components/Form/Form.doc.ts +1 -1
  278. package/src/surfaces/admin/components/FunctionSettings/FunctionSettings.doc.ts +1 -1
  279. package/src/surfaces/admin/components/Heading/Heading.doc.ts +2 -2
  280. package/src/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.ts +2 -2
  281. package/src/surfaces/admin/components/Icon/Icon.doc.ts +2 -2
  282. package/src/surfaces/admin/components/Image/Image.doc.ts +2 -2
  283. package/src/surfaces/admin/components/InlineStack/InlineStack.doc.ts +2 -2
  284. package/src/surfaces/admin/components/Link/Link.doc.ts +1 -1
  285. package/src/surfaces/admin/components/MoneyField/MoneyField.doc.ts +1 -1
  286. package/src/surfaces/admin/components/NumberField/NumberField.doc.ts +1 -1
  287. package/src/surfaces/admin/components/Paragraph/Paragraph.doc.ts +2 -2
  288. package/src/surfaces/admin/components/PasswordField/PasswordField.doc.ts +1 -1
  289. package/src/surfaces/admin/components/Pressable/Pressable.doc.ts +1 -1
  290. package/src/surfaces/admin/components/ProgressIndicator/ProgressIndicator.doc.ts +2 -2
  291. package/src/surfaces/admin/components/Section/Section.doc.ts +2 -2
  292. package/src/surfaces/admin/components/Select/Select.doc.ts +1 -1
  293. package/src/surfaces/admin/components/Text/Text.doc.ts +2 -2
  294. package/src/surfaces/admin/components/TextArea/TextArea.doc.ts +1 -1
  295. package/src/surfaces/admin/components/TextField/TextField.doc.ts +1 -1
  296. package/src/surfaces/admin/components/URLField/URLField.doc.ts +1 -1
  297. package/src/surfaces/checkout/api/standard/standard.ts +3 -0
  298. package/src/surfaces/point-of-sale/api.ts +1 -0
  299. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
  300. package/src/surfaces/point-of-sale/event/data/BaseData.ts +15 -0
  301. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +6 -0
  302. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +27 -0
  303. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +18 -0
  304. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +9 -0
  305. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +18 -0
  306. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +12 -0
  307. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +27 -0
  308. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +14 -0
  309. package/src/surfaces/point-of-sale/render/api/action-api/action-api.ts +3 -5
  310. package/src/surfaces/point-of-sale/render/api/cart-api/cart-api.ts +37 -31
  311. package/src/surfaces/point-of-sale/render/api/cart-line-item-api/cart-line-item-api.ts +2 -2
  312. package/src/surfaces/point-of-sale/render/api/connectivity-api/connectivity-api.ts +6 -4
  313. package/src/surfaces/point-of-sale/render/api/customer-api/customer-api.ts +4 -1
  314. package/src/surfaces/point-of-sale/render/api/device-api/device-api.ts +8 -4
  315. package/src/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.ts +6 -3
  316. package/src/surfaces/point-of-sale/render/api/locale-api/locale-api.ts +3 -4
  317. package/src/surfaces/point-of-sale/render/api/navigation-api/navigation-api.ts +9 -7
  318. package/src/surfaces/point-of-sale/render/api/order-api/order-api.ts +5 -5
  319. package/src/surfaces/point-of-sale/render/api/print-api/print-api.ts +7 -12
  320. package/src/surfaces/point-of-sale/render/api/product-api/product-api.ts +5 -2
  321. package/src/surfaces/point-of-sale/render/api/product-search-api/product-search-api.ts +24 -10
  322. package/src/surfaces/point-of-sale/render/api/scanner-api/scanner-api.ts +22 -10
  323. package/src/surfaces/point-of-sale/render/api/session-api/session-api.ts +3 -6
  324. package/src/surfaces/point-of-sale/render/api/storage-api/storage-api.ts +7 -0
  325. package/src/surfaces/point-of-sale/render/api/toast-api/toast-api.ts +11 -1
  326. package/src/surfaces/point-of-sale/render/components/Badge/Badge.ts +12 -10
  327. package/src/surfaces/point-of-sale/render/components/Banner/Banner.ts +13 -14
  328. package/src/surfaces/point-of-sale/render/components/Button/Button.ts +9 -15
  329. package/src/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.ts +6 -8
  330. package/src/surfaces/point-of-sale/render/components/DatePicker/DatePicker.ts +8 -11
  331. package/src/surfaces/point-of-sale/render/components/Dialog/Dialog.ts +13 -20
  332. package/src/surfaces/point-of-sale/render/components/Icon/Icon.ts +254 -248
  333. package/src/surfaces/point-of-sale/render/components/Image/Image.ts +14 -5
  334. package/src/surfaces/point-of-sale/render/components/List/List.ts +30 -25
  335. package/src/surfaces/point-of-sale/render/components/Navigator/Navigator.ts +1 -4
  336. package/src/surfaces/point-of-sale/render/components/NumberField/NumberField.ts +7 -7
  337. package/src/surfaces/point-of-sale/render/components/POSBlock/POSBlock.ts +5 -9
  338. package/src/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.ts +1 -4
  339. package/src/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.ts +0 -4
  340. package/src/surfaces/point-of-sale/render/components/PinPad/PinPad.ts +25 -28
  341. package/src/surfaces/point-of-sale/render/components/PrintPreview/PrintPreview.ts +1 -11
  342. package/src/surfaces/point-of-sale/render/components/QRCode/QRCode.ts +1 -5
  343. package/src/surfaces/point-of-sale/render/components/RadioButtonList/RadioButtonList.ts +4 -4
  344. package/src/surfaces/point-of-sale/render/components/Screen/Screen.ts +13 -33
  345. package/src/surfaces/point-of-sale/render/components/SearchBar/SearchBar.ts +7 -7
  346. package/src/surfaces/point-of-sale/render/components/Section/Section.ts +6 -11
  347. package/src/surfaces/point-of-sale/render/components/SectionHeader/SectionHeader.ts +6 -6
  348. package/src/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.ts +9 -7
  349. package/src/surfaces/point-of-sale/render/components/Selectable/Selectable.ts +2 -2
  350. package/src/surfaces/point-of-sale/render/components/Stack/Stack.ts +27 -22
  351. package/src/surfaces/point-of-sale/render/components/Stepper/Stepper.ts +8 -6
  352. package/src/surfaces/point-of-sale/render/components/Text/Text.ts +28 -2
  353. package/src/surfaces/point-of-sale/render/components/TextArea/TextArea.ts +1 -6
  354. package/src/surfaces/point-of-sale/render/components/TextField/TextField.ts +30 -0
  355. package/src/surfaces/point-of-sale/render/components/Tile/Tile.ts +6 -15
  356. package/src/surfaces/point-of-sale/render/components/TimeField/TimeField.ts +2 -1
  357. package/src/surfaces/point-of-sale/render/components/TimePicker/TimePicker.ts +10 -14
  358. package/src/surfaces/point-of-sale/render/components/shared/BaseTextField.ts +6 -14
  359. package/src/surfaces/point-of-sale/render/components/shared/InputField.ts +16 -37
  360. package/src/surfaces/point-of-sale/render/components/shared/box.ts +33 -42
  361. package/src/surfaces/point-of-sale/render/components/shared/deprecated-types.ts +12 -0
  362. package/src/surfaces/point-of-sale/render/components/shared/inner-layouts.ts +14 -7
  363. package/src/surfaces/point-of-sale/render/components/shared/sizes.ts +3 -1
  364. package/src/surfaces/point-of-sale/targets.ts +135 -0
  365. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +39 -0
  366. package/src/surfaces/point-of-sale/types/cart.ts +267 -22
  367. package/src/surfaces/point-of-sale/types/country-code.ts +3 -0
  368. package/src/surfaces/point-of-sale/types/device.ts +6 -3
  369. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +3 -3
  370. package/src/surfaces/point-of-sale/types/discount-allocation.ts +6 -0
  371. package/src/surfaces/point-of-sale/types/money.ts +18 -0
  372. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -2
  373. package/src/surfaces/point-of-sale/types/order.ts +18 -0
  374. package/src/surfaces/point-of-sale/types/paginated-result.ts +2 -3
  375. package/src/surfaces/point-of-sale/types/payment.ts +16 -0
  376. package/src/surfaces/point-of-sale/types/product.ts +172 -0
  377. package/src/surfaces/point-of-sale/types/session.ts +7 -5
  378. package/src/surfaces/point-of-sale/types/shipping-line.ts +32 -0
  379. package/src/surfaces/point-of-sale/types/storage.ts +13 -11
  380. package/src/surfaces/point-of-sale/types/tax-line.ts +21 -0
  381. package/src/surfaces/point-of-sale/types/transaction-type.ts +7 -0
@@ -4,13 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property text - The text displayed inside the badge.
9
- * @property variant - The appearance and function of the badge.
10
- * @property status - A circle icon displaying the status of the badge.
11
- * @deprecated status - No longer supported as of POS 10.0.0.
12
- */
13
-
14
7
  const Badge = core.createRemoteComponent('Badge');
15
8
 
16
9
  exports.Badge = Badge;
@@ -4,15 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property title - The title text displayed on the banner.
9
- * @property variant - The variant type of the banner.
10
- * @property action - The text for the action button.
11
- * @property onPress - The callback function executed when the banner is pressed.
12
- * @property hideAction - Whether to hide the action button.
13
- * @property visible - The visibility state of the banner.
14
- */
15
-
16
7
  const Banner = core.createRemoteComponent('Banner');
17
8
 
18
9
  exports.Banner = Banner;
@@ -4,14 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property `title` the text set on the `Button`.
9
- * @property `type` the type of `Button` to render. Determines the appearance of the button.
10
- * @property `onPress` the callback that is executed when the user taps the button.
11
- * @property `isDisabled` sets whether the `Button` can be tapped.
12
- * @property `isLoading` sets whether the `Button` is displaying an animated loading state.
13
- */
14
-
15
7
  const Button = core.createRemoteComponent('Button');
16
8
 
17
9
  exports.Button = Button;
@@ -4,12 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property title - The title of the banner.
9
- * @property variant - The appearance of the banner.
10
- * @property visible - The visibility state of the banner.
11
- */
12
-
13
7
  const CameraScanner = core.createRemoteComponent('CameraScanner');
14
8
 
15
9
  exports.CameraScanner = CameraScanner;
@@ -4,14 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Represents the properties for the DatePicker component.
9
- * @property selected - The selected time.
10
- * @property onChange - A callback for changes.
11
- * @property visibleState - Control the visible state, and a callback to set the visible state as false when the dialog closes.
12
- * @property inputMode - Whether to display the picker in inline (clock) mode or spinner mode.
13
- */
14
-
15
7
  const DatePicker = core.createRemoteComponent('DatePicker');
16
8
 
17
9
  exports.DatePicker = DatePicker;
@@ -4,18 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property title - The text displayed in the title of the dialog.
9
- * @property content - The text displayed in the body of the dialog.
10
- * @property actionText - The text displayed in the primary action button of the dialog.
11
- * @property secondaryActionText - The text displayed in the secondary action section of the dialog.
12
- * @property showSecondaryAction - Whether a secondary action displays.
13
- * @property type - Determines the dialog’s appearance and function.
14
- * @property onAction - A callback that performs when the action is triggered.
15
- * @property onSecondaryAction - A callback that is executed when the secondary action is triggered.
16
- * @property isVisible - Whether the dialog should be presented.
17
- */
18
-
19
7
  const Dialog = core.createRemoteComponent('Dialog');
20
8
 
21
9
  exports.Dialog = Dialog;
@@ -5,9 +5,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
5
5
  var core = require('@remote-ui/core');
6
6
 
7
7
  /**
8
- * FillResizeMode will apply formatting to the image to fill the container.
8
+ * Defines how images are resized and positioned within their containers. Controls image scaling, cropping, and aspect ratio handling.
9
9
  *
10
- * https://reactnative.dev/docs/image#resizemode
10
+ * Available resize modes:
11
+ * - `center`: Centers the image within its container without scaling. The image maintains its original size and is positioned in the center, potentially leaving empty space or being cropped if the container is smaller.
12
+ * - `contain`: Scales the image to fit entirely within the container while maintaining aspect ratio. The entire image will be visible, but there may be empty space if the aspect ratios don't match.
13
+ * - `cover`: Scales the image to fill the entire container while maintaining aspect ratio. Parts of the image may be cropped if the aspect ratios don't match, but the container will be completely filled.
14
+ * - `repeat`: Repeats the image to fill the container. The image maintains its original size and is tiled both horizontally and vertically to cover the entire container area.
15
+ * - `stretch`: Stretches the image to fill the container completely, potentially distorting the aspect ratio. The image will fill the entire container but may appear stretched or compressed.
11
16
  */
12
17
 
13
18
  const Image = core.createRemoteComponent('Image');
@@ -4,10 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property `initialScreenName` sets the initial `Screen` whose `name` matches.
9
- */
10
-
11
7
  const Navigator = core.createRemoteComponent('Navigator');
12
8
 
13
9
  exports.Navigator = Navigator;
@@ -4,12 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Represents the properties for the NumberField component.
9
- * @typedef {Object} NumberFieldProps
10
- * @property {'decimal' | 'numeric'} [inputMode] - The mode of input, can be either 'decimal' or 'numeric'.
11
- */
12
-
13
7
  const NumberField = core.createRemoteComponent('NumberField');
14
8
 
15
9
  exports.NumberField = NumberField;
@@ -4,12 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Renders a `POSBlock`. Note that the text displayed on this `POSBlock`
9
- * is dependent on the description of the extension. A `POSBlock` only
10
- * accepts `POSBlockRow` as children.
11
- */
12
-
13
7
  const POSBlock = core.createRemoteComponent('POSBlock');
14
8
 
15
9
  exports.POSBlock = POSBlock;
@@ -4,10 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Renders a `POSBlockRow` in a `POSBlock`.
9
- */
10
-
11
7
  const POSBlockRow = core.createRemoteComponent('POSBlockRow');
12
8
 
13
9
  exports.POSBlockRow = POSBlockRow;
@@ -4,11 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Renders a `POSReceiptBlock`. A `POSReceiptBlock` only accepts
9
- * `Text` and `QRCode` as children (more to be added in the future).
10
- */
11
-
12
7
  const POSReceiptBlock = core.createRemoteComponent('POSReceiptBlock');
13
8
 
14
9
  exports.POSReceiptBlock = POSReceiptBlock;
@@ -5,32 +5,28 @@ Object.defineProperty(exports, '__esModule', { value: true });
5
5
  var core = require('@remote-ui/core');
6
6
 
7
7
  /**
8
- * Represents the result of the pin pad onSubmit function.
9
- * @typedef {('accept'|'reject')} PinValidationResult
8
+ * Defines the validation result values that the `onSubmit` callback must return to indicate PIN verification status.
9
+ *
10
+ * Available values:
11
+ * - `accept`: A validation result indicating the PIN is correct and authentication was successful.
12
+ * - `reject`: A validation result indicating the PIN is incorrect and authentication failed.
10
13
  */
11
14
 
12
15
  /**
13
- * Represents the allowed lengths of a PIN.
14
- * @typedef {(4|5|6|7|8|9|10)} PinLength
16
+ * Defines the allowed PIN length values that constrain how many digits users can enter.
17
+ *
18
+ * Available lengths:
19
+ * - `4`: A four-digit PIN length, commonly used for basic security codes and quick authentication.
20
+ * - `5`: A five-digit PIN length for moderate security requirements.
21
+ * - `6`: A six-digit PIN length, commonly used for enhanced security codes and verification.
22
+ * - `7`: A seven-digit PIN length for higher security requirements.
23
+ * - `8`: An eight-digit PIN length for strong security and complex authentication scenarios.
24
+ * - `9`: A nine-digit PIN length for very high security requirements.
25
+ * - `10`: A ten-digit PIN length, the maximum supported for highly secure authentication workflows.
15
26
  */
16
27
 
17
28
  /**
18
- * Represents an action type for the PinPad component.
19
- * @typedef {Object} PinPadActionType
20
- * @property {string} label - The label for the action button.
21
- * @property {function(): number[]} onPress - The function to be called when the action button is pressed.
22
- */
23
-
24
- /**
25
- * Represents the properties for the PinPad component.
26
- * @typedef {Object} PinPadProps
27
- * @property {boolean} [masked] - Whether the entered PIN should be masked.
28
- * @property {PinLength} [minPinLength] - The minimum length of the PIN.
29
- * @property {PinLength} [maxPinLength] - The maximum length of the PIN.
30
- * @property {string} [label] - The content for the prompt on the pin pad.
31
- * @property {PinPadActionType} [pinPadAction] - The call to action between the entry view and the keypad, consisting of a label and function that returns the pin.
32
- * @property {function(pin: number[]): Promise<PinValidationResult>} onSubmit - The function to be called when the PIN is submitted.
33
- * @property {function(pin: number[]): void} [onPinEntry] - The function to be called when a PIN is entered.
29
+ * Defines the configuration object for action buttons displayed between the PIN entry view and keypad.
34
30
  */
35
31
 
36
32
  const PinPad = core.createRemoteComponent('PinPad');
@@ -4,11 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * The `QRCode` component renders a QR code in Shopify POS.
9
- * @property `value` the content to be encoded in the QR code.
10
- */
11
-
12
7
  const QRCode = core.createRemoteComponent('QRCode');
13
8
 
14
9
  exports.QRCode = QRCode;
@@ -4,28 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /** Represents the presentation of a screen in the navigation stack.
8
- * @property `sheet` displays the screen from the bottom on `navigate` when `true`.
9
- */
10
-
11
- /** Represents the secondary action button of a screen in the navigation stack.
12
- * @property `text` displays the name of the secondary action in the action bar.
13
- * @property `onPress` triggered when the secondary action button is pressed.
14
- * @property `isEnabled` sets whether the action can be tapped.
15
- */
16
-
17
- /** Represents a screen in the navigation stack.
18
- * @property `name` used to identify this screen as a destination in the navigation stack.
19
- * @property `title` the title of the screen which will be displayed on the UI.
20
- * @property `isLoading` displays a loading indicator when `true`. Set this to `true` when performing an asynchronous task, and then to false when the data becomes available to the UI.
21
- * @property `presentation` dictates how the `Screen` will be presented when navigated to.
22
- * @property `secondaryAction` displays a secondary action button on the screen.
23
- * @property `onNavigate` triggered when the screen is navigated to.
24
- * @property `onNavigateBack` triggered when the user navigates back from this screen. Runs after screen is unmounted.
25
- * @property `overrideNavigateBack` a callback that allows you to override the secondary navigation action. Runs when screen is mounted.
26
- * @property `onReceiveParams` a callback that gets triggered when the navigation event completes and the screen receives the parameters.
27
- */
28
-
29
7
  const Screen = core.createRemoteComponent('Screen');
30
8
 
31
9
  exports.Screen = Screen;
@@ -4,14 +4,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /** Allows the implementation of an action at the top right of a `Section`.
8
- * @property `title` the title describing the action.
9
- * @property `onPress` the callback when the action is tapped by the user.
10
- */
11
-
12
- /** Renders content that is bound by a border, with a title and a call to action at the top.
13
- * @property `title` the title of the section.
14
- * @property `action` the action in the top right of the section that can be triggered by a tap.
7
+ /**
8
+ * Defines the configuration object for the action button displayed within the section header.
15
9
  */
16
10
 
17
11
  const Section = core.createRemoteComponent('Section');
@@ -4,6 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
+ /**
8
+ * Defines the structure and configuration options for individual segments within the `SegmentedControl` component.
9
+ */
10
+
7
11
  const SegmentedControl = core.createRemoteComponent('SegmentedControl');
8
12
 
9
13
  exports.SegmentedControl = SegmentedControl;
@@ -4,6 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
+ /* eslint-disable import/no-deprecated */
8
+
9
+ /* eslint-enable import/no-deprecated */
10
+
7
11
  /**
8
12
  *
9
13
  * @deprecated Use the `block` or `inline` as a value instead.
@@ -4,6 +4,34 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
+ /**
8
+ * Defines the typography hierarchy options for text elements. Each variant provides specific sizing, weight, and styling appropriate for different content types.
9
+ *
10
+ * Available variants:
11
+ * - `sectionHeader`: A section header variant for titles that organize and introduce content sections.
12
+ * - `captionRegular`: A regular caption variant for supplementary text, labels, or secondary information.
13
+ * - `captionRegularTall`: A taller caption variant with increased line height for improved readability in dense layouts.
14
+ * - `captionMedium`: A medium-weight caption variant for slightly emphasized secondary text or important labels.
15
+ * - `body`: The standard body text variant for primary content, descriptions, and general text.
16
+ * - `headingSmall`: A small heading variant for subsection titles and secondary headings.
17
+ * - `headingLarge`: A large heading variant for main section titles and primary headings.
18
+ * - `display`: The largest display variant for prominent titles, hero text, or major interface elements.
19
+ */
20
+
21
+ /**
22
+ * Defines the semantic color options for text elements. Each color conveys specific meaning and intent through visual styling.
23
+ *
24
+ * Available colors:
25
+ * - `TextNeutral`: A neutral text color for general content that doesn't convey specific semantic meaning.
26
+ * - `TextSubdued`: A subdued text color for secondary information, captions, or content that should be less prominent.
27
+ * - `TextDisabled`: A disabled text color for inactive or unavailable content that users can't interact with.
28
+ * - `TextWarning`: A warning text color for cautionary messages or content that requires user attention.
29
+ * - `TextCritical`: A critical text color for errors, failures, or destructive actions that require immediate attention.
30
+ * - `TextSuccess`: A success text color for positive outcomes, confirmations, or completed actions.
31
+ * - `TextInteractive`: An interactive text color for clickable elements, links, or content that users can interact with.
32
+ * - `TextHighlight`: A highlight text color for emphasized content that needs to stand out or draw special attention.
33
+ */
34
+
7
35
  const Text = core.createRemoteComponent('Text');
8
36
 
9
37
  exports.Text = Text;
@@ -4,12 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Represents the properties for the TextField component.
9
- * @typedef {Object} TextAreaProps
10
- * @property {number} [rows] - The initial number of lines to be displayed. Maximum of 8 lines.
11
- */
12
-
13
7
  const TextArea = core.createRemoteComponent('TextArea');
14
8
 
15
9
  exports.TextArea = TextArea;
@@ -4,16 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * @property `title` the text set on the main label of the tile.
9
- * @property `subtitle` the text set on the secondary label of the tile.
10
- * @property `enabled` sets whether or not the tile can be tapped.
11
- * @property `destructive` sets whether or not the tile has a destructive appearance and active state as of POS
12
- * 10.0.0.
13
- * @property `badgeValue` the number value displayed in the top right corner of the tile.
14
- * @property `onPress` the callback that is executed when the tile is tapped.
15
- */
16
-
17
7
  const Tile = core.createRemoteComponent('Tile');
18
8
 
19
9
  exports.Tile = Tile;
@@ -4,15 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var core = require('@remote-ui/core');
6
6
 
7
- /**
8
- * Represents the properties for the TimePicker component.
9
- * @property selected - The selected time.
10
- * @property onChange - A callback for changes.
11
- * @property visibleState - Controls the visible state, and a callback to set the visible state as false when the dialog closes.
12
- * @property is24Hour - (Android only) Whether the clock displays in 24 hour time instead of 12 hour time.
13
- * @property inputMode - Whether to display the picker in inline (clock) mode or spinner mode.
14
- */
15
-
16
7
  const TimePicker = core.createRemoteComponent('TimePicker');
17
8
 
18
9
  exports.TimePicker = TimePicker;
@@ -9,5 +9,8 @@ class StorageError extends Error {
9
9
  this.name = 'StorageError';
10
10
  }
11
11
  }
12
+ /**
13
+ * Defines the storage interface for persisting extension data across sessions.
14
+ */
12
15
 
13
16
  exports.StorageError = StorageError;
@@ -1,12 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * @property text - The text displayed inside the badge.
5
- * @property variant - The appearance and function of the badge.
6
- * @property status - A circle icon displaying the status of the badge.
7
- * @deprecated status - No longer supported as of POS 10.0.0.
8
- */
9
-
10
3
  const Badge = createRemoteComponent('Badge');
11
4
 
12
5
  export { Badge };
@@ -1,14 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * @property title - The title text displayed on the banner.
5
- * @property variant - The variant type of the banner.
6
- * @property action - The text for the action button.
7
- * @property onPress - The callback function executed when the banner is pressed.
8
- * @property hideAction - Whether to hide the action button.
9
- * @property visible - The visibility state of the banner.
10
- */
11
-
12
3
  const Banner = createRemoteComponent('Banner');
13
4
 
14
5
  export { Banner };
@@ -1,13 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * @property `title` the text set on the `Button`.
5
- * @property `type` the type of `Button` to render. Determines the appearance of the button.
6
- * @property `onPress` the callback that is executed when the user taps the button.
7
- * @property `isDisabled` sets whether the `Button` can be tapped.
8
- * @property `isLoading` sets whether the `Button` is displaying an animated loading state.
9
- */
10
-
11
3
  const Button = createRemoteComponent('Button');
12
4
 
13
5
  export { Button };
@@ -1,11 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * @property title - The title of the banner.
5
- * @property variant - The appearance of the banner.
6
- * @property visible - The visibility state of the banner.
7
- */
8
-
9
3
  const CameraScanner = createRemoteComponent('CameraScanner');
10
4
 
11
5
  export { CameraScanner };
@@ -1,13 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * Represents the properties for the DatePicker component.
5
- * @property selected - The selected time.
6
- * @property onChange - A callback for changes.
7
- * @property visibleState - Control the visible state, and a callback to set the visible state as false when the dialog closes.
8
- * @property inputMode - Whether to display the picker in inline (clock) mode or spinner mode.
9
- */
10
-
11
3
  const DatePicker = createRemoteComponent('DatePicker');
12
4
 
13
5
  export { DatePicker };
@@ -1,17 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * @property title - The text displayed in the title of the dialog.
5
- * @property content - The text displayed in the body of the dialog.
6
- * @property actionText - The text displayed in the primary action button of the dialog.
7
- * @property secondaryActionText - The text displayed in the secondary action section of the dialog.
8
- * @property showSecondaryAction - Whether a secondary action displays.
9
- * @property type - Determines the dialog’s appearance and function.
10
- * @property onAction - A callback that performs when the action is triggered.
11
- * @property onSecondaryAction - A callback that is executed when the secondary action is triggered.
12
- * @property isVisible - Whether the dialog should be presented.
13
- */
14
-
15
3
  const Dialog = createRemoteComponent('Dialog');
16
4
 
17
5
  export { Dialog };
@@ -1,9 +1,14 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
3
  /**
4
- * FillResizeMode will apply formatting to the image to fill the container.
4
+ * Defines how images are resized and positioned within their containers. Controls image scaling, cropping, and aspect ratio handling.
5
5
  *
6
- * https://reactnative.dev/docs/image#resizemode
6
+ * Available resize modes:
7
+ * - `center`: Centers the image within its container without scaling. The image maintains its original size and is positioned in the center, potentially leaving empty space or being cropped if the container is smaller.
8
+ * - `contain`: Scales the image to fit entirely within the container while maintaining aspect ratio. The entire image will be visible, but there may be empty space if the aspect ratios don't match.
9
+ * - `cover`: Scales the image to fill the entire container while maintaining aspect ratio. Parts of the image may be cropped if the aspect ratios don't match, but the container will be completely filled.
10
+ * - `repeat`: Repeats the image to fill the container. The image maintains its original size and is tiled both horizontally and vertically to cover the entire container area.
11
+ * - `stretch`: Stretches the image to fill the container completely, potentially distorting the aspect ratio. The image will fill the entire container but may appear stretched or compressed.
7
12
  */
8
13
 
9
14
  const Image = createRemoteComponent('Image');
@@ -1,9 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * @property `initialScreenName` sets the initial `Screen` whose `name` matches.
5
- */
6
-
7
3
  const Navigator = createRemoteComponent('Navigator');
8
4
 
9
5
  export { Navigator };
@@ -1,11 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * Represents the properties for the NumberField component.
5
- * @typedef {Object} NumberFieldProps
6
- * @property {'decimal' | 'numeric'} [inputMode] - The mode of input, can be either 'decimal' or 'numeric'.
7
- */
8
-
9
3
  const NumberField = createRemoteComponent('NumberField');
10
4
 
11
5
  export { NumberField };
@@ -1,11 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * Renders a `POSBlock`. Note that the text displayed on this `POSBlock`
5
- * is dependent on the description of the extension. A `POSBlock` only
6
- * accepts `POSBlockRow` as children.
7
- */
8
-
9
3
  const POSBlock = createRemoteComponent('POSBlock');
10
4
 
11
5
  export { POSBlock };
@@ -1,9 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * Renders a `POSBlockRow` in a `POSBlock`.
5
- */
6
-
7
3
  const POSBlockRow = createRemoteComponent('POSBlockRow');
8
4
 
9
5
  export { POSBlockRow };
@@ -1,10 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * Renders a `POSReceiptBlock`. A `POSReceiptBlock` only accepts
5
- * `Text` and `QRCode` as children (more to be added in the future).
6
- */
7
-
8
3
  const POSReceiptBlock = createRemoteComponent('POSReceiptBlock');
9
4
 
10
5
  export { POSReceiptBlock };
@@ -1,32 +1,28 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
3
  /**
4
- * Represents the result of the pin pad onSubmit function.
5
- * @typedef {('accept'|'reject')} PinValidationResult
4
+ * Defines the validation result values that the `onSubmit` callback must return to indicate PIN verification status.
5
+ *
6
+ * Available values:
7
+ * - `accept`: A validation result indicating the PIN is correct and authentication was successful.
8
+ * - `reject`: A validation result indicating the PIN is incorrect and authentication failed.
6
9
  */
7
10
 
8
11
  /**
9
- * Represents the allowed lengths of a PIN.
10
- * @typedef {(4|5|6|7|8|9|10)} PinLength
12
+ * Defines the allowed PIN length values that constrain how many digits users can enter.
13
+ *
14
+ * Available lengths:
15
+ * - `4`: A four-digit PIN length, commonly used for basic security codes and quick authentication.
16
+ * - `5`: A five-digit PIN length for moderate security requirements.
17
+ * - `6`: A six-digit PIN length, commonly used for enhanced security codes and verification.
18
+ * - `7`: A seven-digit PIN length for higher security requirements.
19
+ * - `8`: An eight-digit PIN length for strong security and complex authentication scenarios.
20
+ * - `9`: A nine-digit PIN length for very high security requirements.
21
+ * - `10`: A ten-digit PIN length, the maximum supported for highly secure authentication workflows.
11
22
  */
12
23
 
13
24
  /**
14
- * Represents an action type for the PinPad component.
15
- * @typedef {Object} PinPadActionType
16
- * @property {string} label - The label for the action button.
17
- * @property {function(): number[]} onPress - The function to be called when the action button is pressed.
18
- */
19
-
20
- /**
21
- * Represents the properties for the PinPad component.
22
- * @typedef {Object} PinPadProps
23
- * @property {boolean} [masked] - Whether the entered PIN should be masked.
24
- * @property {PinLength} [minPinLength] - The minimum length of the PIN.
25
- * @property {PinLength} [maxPinLength] - The maximum length of the PIN.
26
- * @property {string} [label] - The content for the prompt on the pin pad.
27
- * @property {PinPadActionType} [pinPadAction] - The call to action between the entry view and the keypad, consisting of a label and function that returns the pin.
28
- * @property {function(pin: number[]): Promise<PinValidationResult>} onSubmit - The function to be called when the PIN is submitted.
29
- * @property {function(pin: number[]): void} [onPinEntry] - The function to be called when a PIN is entered.
25
+ * Defines the configuration object for action buttons displayed between the PIN entry view and keypad.
30
26
  */
31
27
 
32
28
  const PinPad = createRemoteComponent('PinPad');
@@ -1,10 +1,5 @@
1
1
  import { createRemoteComponent } from '@remote-ui/core';
2
2
 
3
- /**
4
- * The `QRCode` component renders a QR code in Shopify POS.
5
- * @property `value` the content to be encoded in the QR code.
6
- */
7
-
8
3
  const QRCode = createRemoteComponent('QRCode');
9
4
 
10
5
  export { QRCode };