@flipdish/ui-library 0.31.5 → 0.31.6

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 (438) hide show
  1. package/dist/components/atoms/AppStoreButton/index.cjs +4 -0
  2. package/dist/components/atoms/AppStoreButton/index.cjs.map +1 -1
  3. package/dist/components/atoms/AppStoreButton/index.d.ts +9 -0
  4. package/dist/components/atoms/AppStoreButton/index.d.ts.map +1 -1
  5. package/dist/components/atoms/AppStoreButton/index.js +4 -0
  6. package/dist/components/atoms/AppStoreButton/index.js.map +1 -1
  7. package/dist/components/atoms/Avatar/components/AvatarBase.cjs.map +1 -1
  8. package/dist/components/atoms/Avatar/components/AvatarBase.d.ts +4 -0
  9. package/dist/components/atoms/Avatar/components/AvatarBase.d.ts.map +1 -1
  10. package/dist/components/atoms/Avatar/components/AvatarBase.js.map +1 -1
  11. package/dist/components/atoms/BackgroundPattern/index.cjs +1 -1
  12. package/dist/components/atoms/BackgroundPattern/index.cjs.map +1 -1
  13. package/dist/components/atoms/BackgroundPattern/index.d.ts +5 -1
  14. package/dist/components/atoms/BackgroundPattern/index.d.ts.map +1 -1
  15. package/dist/components/atoms/BackgroundPattern/index.js +1 -1
  16. package/dist/components/atoms/BackgroundPattern/index.js.map +1 -1
  17. package/dist/components/atoms/Badge/index.cjs +6 -0
  18. package/dist/components/atoms/Badge/index.cjs.map +1 -1
  19. package/dist/components/atoms/Badge/index.d.ts +11 -0
  20. package/dist/components/atoms/Badge/index.d.ts.map +1 -1
  21. package/dist/components/atoms/Badge/index.js +6 -0
  22. package/dist/components/atoms/Badge/index.js.map +1 -1
  23. package/dist/components/atoms/Button/index.cjs.map +1 -1
  24. package/dist/components/atoms/Button/index.d.ts +3 -0
  25. package/dist/components/atoms/Button/index.d.ts.map +1 -1
  26. package/dist/components/atoms/Button/index.js.map +1 -1
  27. package/dist/components/atoms/Checkbox/index.cjs +1 -0
  28. package/dist/components/atoms/Checkbox/index.cjs.map +1 -1
  29. package/dist/components/atoms/Checkbox/index.d.ts +11 -0
  30. package/dist/components/atoms/Checkbox/index.d.ts.map +1 -1
  31. package/dist/components/atoms/Checkbox/index.js +1 -0
  32. package/dist/components/atoms/Checkbox/index.js.map +1 -1
  33. package/dist/components/atoms/CloseButton/index.cjs +1 -1
  34. package/dist/components/atoms/CloseButton/index.cjs.map +1 -1
  35. package/dist/components/atoms/CloseButton/index.d.ts +4 -1
  36. package/dist/components/atoms/CloseButton/index.d.ts.map +1 -1
  37. package/dist/components/atoms/CloseButton/index.js +1 -1
  38. package/dist/components/atoms/CloseButton/index.js.map +1 -1
  39. package/dist/components/atoms/Dot/index.cjs.map +1 -1
  40. package/dist/components/atoms/Dot/index.d.ts +1 -0
  41. package/dist/components/atoms/Dot/index.d.ts.map +1 -1
  42. package/dist/components/atoms/Dot/index.js.map +1 -1
  43. package/dist/components/atoms/FeaturedIcon/index.cjs +1 -1
  44. package/dist/components/atoms/FeaturedIcon/index.cjs.map +1 -1
  45. package/dist/components/atoms/FeaturedIcon/index.d.ts +8 -1
  46. package/dist/components/atoms/FeaturedIcon/index.d.ts.map +1 -1
  47. package/dist/components/atoms/FeaturedIcon/index.js +1 -1
  48. package/dist/components/atoms/FeaturedIcon/index.js.map +1 -1
  49. package/dist/components/atoms/Illustration/components/Box.cjs.map +1 -1
  50. package/dist/components/atoms/Illustration/components/Box.d.ts +3 -0
  51. package/dist/components/atoms/Illustration/components/Box.d.ts.map +1 -1
  52. package/dist/components/atoms/Illustration/components/Box.js.map +1 -1
  53. package/dist/components/atoms/Illustration/components/Cloud.cjs.map +1 -1
  54. package/dist/components/atoms/Illustration/components/Cloud.d.ts +3 -0
  55. package/dist/components/atoms/Illustration/components/Cloud.d.ts.map +1 -1
  56. package/dist/components/atoms/Illustration/components/Cloud.js.map +1 -1
  57. package/dist/components/atoms/Illustration/components/CreditCard.cjs.map +1 -1
  58. package/dist/components/atoms/Illustration/components/CreditCard.d.ts +3 -0
  59. package/dist/components/atoms/Illustration/components/CreditCard.d.ts.map +1 -1
  60. package/dist/components/atoms/Illustration/components/CreditCard.js.map +1 -1
  61. package/dist/components/atoms/Illustration/components/Documents.cjs.map +1 -1
  62. package/dist/components/atoms/Illustration/components/Documents.d.ts +3 -0
  63. package/dist/components/atoms/Illustration/components/Documents.d.ts.map +1 -1
  64. package/dist/components/atoms/Illustration/components/Documents.js.map +1 -1
  65. package/dist/components/atoms/Illustration/index.cjs.map +1 -1
  66. package/dist/components/atoms/Illustration/index.d.ts +4 -0
  67. package/dist/components/atoms/Illustration/index.d.ts.map +1 -1
  68. package/dist/components/atoms/Illustration/index.js.map +1 -1
  69. package/dist/components/atoms/Input/index.cjs +2 -0
  70. package/dist/components/atoms/Input/index.cjs.map +1 -1
  71. package/dist/components/atoms/Input/index.d.ts +5 -4
  72. package/dist/components/atoms/Input/index.d.ts.map +1 -1
  73. package/dist/components/atoms/Input/index.js +2 -0
  74. package/dist/components/atoms/Input/index.js.map +1 -1
  75. package/dist/components/atoms/ProgressBar/index.cjs +1 -1
  76. package/dist/components/atoms/ProgressBar/index.d.ts +1 -1
  77. package/dist/components/atoms/ProgressBar/index.js +1 -1
  78. package/dist/components/atoms/QRCode/index.cjs +2 -1
  79. package/dist/components/atoms/QRCode/index.cjs.map +1 -1
  80. package/dist/components/atoms/QRCode/index.d.ts +2 -1
  81. package/dist/components/atoms/QRCode/index.d.ts.map +1 -1
  82. package/dist/components/atoms/QRCode/index.js +2 -1
  83. package/dist/components/atoms/QRCode/index.js.map +1 -1
  84. package/dist/components/atoms/RadioButton/index.cjs +2 -0
  85. package/dist/components/atoms/RadioButton/index.cjs.map +1 -1
  86. package/dist/components/atoms/RadioButton/index.d.ts +11 -0
  87. package/dist/components/atoms/RadioButton/index.d.ts.map +1 -1
  88. package/dist/components/atoms/RadioButton/index.js +2 -0
  89. package/dist/components/atoms/RadioButton/index.js.map +1 -1
  90. package/dist/components/atoms/RatingBadge/index.cjs +1 -0
  91. package/dist/components/atoms/RatingBadge/index.cjs.map +1 -1
  92. package/dist/components/atoms/RatingBadge/index.d.ts +5 -0
  93. package/dist/components/atoms/RatingBadge/index.d.ts.map +1 -1
  94. package/dist/components/atoms/RatingBadge/index.js +1 -0
  95. package/dist/components/atoms/RatingBadge/index.js.map +1 -1
  96. package/dist/components/atoms/RatingStars/index.cjs +1 -0
  97. package/dist/components/atoms/RatingStars/index.cjs.map +1 -1
  98. package/dist/components/atoms/RatingStars/index.d.ts +1 -0
  99. package/dist/components/atoms/RatingStars/index.d.ts.map +1 -1
  100. package/dist/components/atoms/RatingStars/index.js +1 -0
  101. package/dist/components/atoms/RatingStars/index.js.map +1 -1
  102. package/dist/components/atoms/Slider/index.cjs.map +1 -1
  103. package/dist/components/atoms/Slider/index.d.ts +2 -0
  104. package/dist/components/atoms/Slider/index.d.ts.map +1 -1
  105. package/dist/components/atoms/Slider/index.js.map +1 -1
  106. package/dist/components/atoms/SocialButton/index.cjs.map +1 -1
  107. package/dist/components/atoms/SocialButton/index.d.ts +5 -0
  108. package/dist/components/atoms/SocialButton/index.d.ts.map +1 -1
  109. package/dist/components/atoms/SocialButton/index.js.map +1 -1
  110. package/dist/components/atoms/Toggle/index.cjs +1 -0
  111. package/dist/components/atoms/Toggle/index.cjs.map +1 -1
  112. package/dist/components/atoms/Toggle/index.d.ts +5 -0
  113. package/dist/components/atoms/Toggle/index.d.ts.map +1 -1
  114. package/dist/components/atoms/Toggle/index.js +1 -0
  115. package/dist/components/atoms/Toggle/index.js.map +1 -1
  116. package/dist/components/atoms/Tooltip/index.cjs +1 -0
  117. package/dist/components/atoms/Tooltip/index.cjs.map +1 -1
  118. package/dist/components/atoms/Tooltip/index.d.ts +1 -0
  119. package/dist/components/atoms/Tooltip/index.d.ts.map +1 -1
  120. package/dist/components/atoms/Tooltip/index.js +1 -0
  121. package/dist/components/atoms/Tooltip/index.js.map +1 -1
  122. package/dist/components/atoms/UtilityButton/index.cjs +1 -1
  123. package/dist/components/atoms/UtilityButton/index.d.ts +1 -1
  124. package/dist/components/atoms/UtilityButton/index.js +1 -1
  125. package/dist/components/molecules/BadgeGroup/index.cjs +1 -2
  126. package/dist/components/molecules/BadgeGroup/index.cjs.map +1 -1
  127. package/dist/components/molecules/BadgeGroup/index.d.ts +8 -2
  128. package/dist/components/molecules/BadgeGroup/index.d.ts.map +1 -1
  129. package/dist/components/molecules/BadgeGroup/index.js +1 -2
  130. package/dist/components/molecules/BadgeGroup/index.js.map +1 -1
  131. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbAccountItem.cjs.map +1 -1
  132. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbAccountItem.d.ts +3 -0
  133. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbAccountItem.d.ts.map +1 -1
  134. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbAccountItem.js.map +1 -1
  135. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbItem.cjs.map +1 -1
  136. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbItem.d.ts +8 -0
  137. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbItem.d.ts.map +1 -1
  138. package/dist/components/molecules/Breadcrumbs/components/BreadcrumbItem.js.map +1 -1
  139. package/dist/components/molecules/Breadcrumbs/index.cjs +1 -2
  140. package/dist/components/molecules/Breadcrumbs/index.cjs.map +1 -1
  141. package/dist/components/molecules/Breadcrumbs/index.d.ts +5 -2
  142. package/dist/components/molecules/Breadcrumbs/index.d.ts.map +1 -1
  143. package/dist/components/molecules/Breadcrumbs/index.js +1 -2
  144. package/dist/components/molecules/Breadcrumbs/index.js.map +1 -1
  145. package/dist/components/molecules/ButtonGroup/index.cjs.map +1 -1
  146. package/dist/components/molecules/ButtonGroup/index.d.ts +2 -0
  147. package/dist/components/molecules/ButtonGroup/index.d.ts.map +1 -1
  148. package/dist/components/molecules/ButtonGroup/index.js.map +1 -1
  149. package/dist/components/molecules/CodeSnippet/index.cjs.map +1 -1
  150. package/dist/components/molecules/CodeSnippet/index.d.ts +1 -0
  151. package/dist/components/molecules/CodeSnippet/index.d.ts.map +1 -1
  152. package/dist/components/molecules/CodeSnippet/index.js.map +1 -1
  153. package/dist/components/molecules/ContentDivider/index.cjs.map +1 -1
  154. package/dist/components/molecules/ContentDivider/index.d.ts +3 -0
  155. package/dist/components/molecules/ContentDivider/index.d.ts.map +1 -1
  156. package/dist/components/molecules/ContentDivider/index.js.map +1 -1
  157. package/dist/components/molecules/CreditCard/index.cjs +1 -2
  158. package/dist/components/molecules/CreditCard/index.cjs.map +1 -1
  159. package/dist/components/molecules/CreditCard/index.d.ts +8 -2
  160. package/dist/components/molecules/CreditCard/index.d.ts.map +1 -1
  161. package/dist/components/molecules/CreditCard/index.js +1 -2
  162. package/dist/components/molecules/CreditCard/index.js.map +1 -1
  163. package/dist/components/molecules/EmptyState/index.cjs +1 -2
  164. package/dist/components/molecules/EmptyState/index.cjs.map +1 -1
  165. package/dist/components/molecules/EmptyState/index.d.ts +10 -2
  166. package/dist/components/molecules/EmptyState/index.d.ts.map +1 -1
  167. package/dist/components/molecules/EmptyState/index.js +1 -2
  168. package/dist/components/molecules/EmptyState/index.js.map +1 -1
  169. package/dist/components/molecules/Modal/index.cjs +4 -4
  170. package/dist/components/molecules/Modal/index.cjs.map +1 -1
  171. package/dist/components/molecules/Modal/index.d.ts +4 -4
  172. package/dist/components/molecules/Modal/index.d.ts.map +1 -1
  173. package/dist/components/molecules/Modal/index.js +4 -4
  174. package/dist/components/molecules/Modal/index.js.map +1 -1
  175. package/dist/components/molecules/Notification/index.cjs +6 -0
  176. package/dist/components/molecules/Notification/index.cjs.map +1 -1
  177. package/dist/components/molecules/Notification/index.d.ts +16 -0
  178. package/dist/components/molecules/Notification/index.d.ts.map +1 -1
  179. package/dist/components/molecules/Notification/index.js +6 -0
  180. package/dist/components/molecules/Notification/index.js.map +1 -1
  181. package/dist/components/molecules/Pagination/components/PaginationBase.cjs.map +1 -1
  182. package/dist/components/molecules/Pagination/components/PaginationBase.d.ts +1 -0
  183. package/dist/components/molecules/Pagination/components/PaginationBase.d.ts.map +1 -1
  184. package/dist/components/molecules/Pagination/components/PaginationBase.js.map +1 -1
  185. package/dist/components/molecules/Pagination/index.cjs +3 -0
  186. package/dist/components/molecules/Pagination/index.cjs.map +1 -1
  187. package/dist/components/molecules/Pagination/index.d.ts +3 -0
  188. package/dist/components/molecules/Pagination/index.d.ts.map +1 -1
  189. package/dist/components/molecules/Pagination/index.js +3 -0
  190. package/dist/components/molecules/Pagination/index.js.map +1 -1
  191. package/dist/components/molecules/ProgressSteps/index.cjs +1 -2
  192. package/dist/components/molecules/ProgressSteps/index.cjs.map +1 -1
  193. package/dist/components/molecules/ProgressSteps/index.d.ts +1 -2
  194. package/dist/components/molecules/ProgressSteps/index.d.ts.map +1 -1
  195. package/dist/components/molecules/ProgressSteps/index.js +1 -2
  196. package/dist/components/molecules/ProgressSteps/index.js.map +1 -1
  197. package/dist/components/molecules/ProgressSteps/progressSteps.types.d.ts +8 -0
  198. package/dist/components/molecules/ProgressSteps/progressSteps.types.d.ts.map +1 -1
  199. package/dist/components/molecules/RadioGroup/components/RadioGroupAvatar.cjs.map +1 -1
  200. package/dist/components/molecules/RadioGroup/components/RadioGroupAvatar.d.ts +2 -0
  201. package/dist/components/molecules/RadioGroup/components/RadioGroupAvatar.d.ts.map +1 -1
  202. package/dist/components/molecules/RadioGroup/components/RadioGroupAvatar.js.map +1 -1
  203. package/dist/components/molecules/RadioGroup/components/RadioGroupCheckbox.cjs.map +1 -1
  204. package/dist/components/molecules/RadioGroup/components/RadioGroupCheckbox.d.ts +2 -0
  205. package/dist/components/molecules/RadioGroup/components/RadioGroupCheckbox.d.ts.map +1 -1
  206. package/dist/components/molecules/RadioGroup/components/RadioGroupCheckbox.js.map +1 -1
  207. package/dist/components/molecules/RadioGroup/components/RadioGroupIconCard.cjs.map +1 -1
  208. package/dist/components/molecules/RadioGroup/components/RadioGroupIconCard.d.ts +2 -0
  209. package/dist/components/molecules/RadioGroup/components/RadioGroupIconCard.d.ts.map +1 -1
  210. package/dist/components/molecules/RadioGroup/components/RadioGroupIconCard.js.map +1 -1
  211. package/dist/components/molecules/RadioGroup/components/RadioGroupIconSimple.cjs.map +1 -1
  212. package/dist/components/molecules/RadioGroup/components/RadioGroupIconSimple.d.ts +2 -0
  213. package/dist/components/molecules/RadioGroup/components/RadioGroupIconSimple.d.ts.map +1 -1
  214. package/dist/components/molecules/RadioGroup/components/RadioGroupIconSimple.js.map +1 -1
  215. package/dist/components/molecules/RadioGroup/components/RadioGroupPaymentIcon.cjs.map +1 -1
  216. package/dist/components/molecules/RadioGroup/components/RadioGroupPaymentIcon.d.ts +2 -0
  217. package/dist/components/molecules/RadioGroup/components/RadioGroupPaymentIcon.d.ts.map +1 -1
  218. package/dist/components/molecules/RadioGroup/components/RadioGroupPaymentIcon.js.map +1 -1
  219. package/dist/components/molecules/RadioGroup/components/RadioGroupRadioButton.cjs.map +1 -1
  220. package/dist/components/molecules/RadioGroup/components/RadioGroupRadioButton.d.ts +2 -0
  221. package/dist/components/molecules/RadioGroup/components/RadioGroupRadioButton.d.ts.map +1 -1
  222. package/dist/components/molecules/RadioGroup/components/RadioGroupRadioButton.js.map +1 -1
  223. package/dist/components/molecules/SectionFooter/index.cjs.map +1 -1
  224. package/dist/components/molecules/SectionFooter/index.d.ts +1 -0
  225. package/dist/components/molecules/SectionFooter/index.d.ts.map +1 -1
  226. package/dist/components/molecules/SectionFooter/index.js.map +1 -1
  227. package/dist/components/molecules/Select/index.cjs.map +1 -1
  228. package/dist/components/molecules/Select/index.d.ts +4 -0
  229. package/dist/components/molecules/Select/index.d.ts.map +1 -1
  230. package/dist/components/molecules/Select/index.js.map +1 -1
  231. package/dist/components/molecules/Tabs/index.cjs +3 -0
  232. package/dist/components/molecules/Tabs/index.cjs.map +1 -1
  233. package/dist/components/molecules/Tabs/index.d.ts +4 -0
  234. package/dist/components/molecules/Tabs/index.d.ts.map +1 -1
  235. package/dist/components/molecules/Tabs/index.js +3 -0
  236. package/dist/components/molecules/Tabs/index.js.map +1 -1
  237. package/dist/components/molecules/Tags/index.cjs +4 -2
  238. package/dist/components/molecules/Tags/index.cjs.map +1 -1
  239. package/dist/components/molecules/Tags/index.d.ts +6 -2
  240. package/dist/components/molecules/Tags/index.d.ts.map +1 -1
  241. package/dist/components/molecules/Tags/index.js +4 -2
  242. package/dist/components/molecules/Tags/index.js.map +1 -1
  243. package/dist/components/molecules/TextArea/index.cjs +1 -0
  244. package/dist/components/molecules/TextArea/index.cjs.map +1 -1
  245. package/dist/components/molecules/TextArea/index.d.ts +1 -0
  246. package/dist/components/molecules/TextArea/index.d.ts.map +1 -1
  247. package/dist/components/molecules/TextArea/index.js +1 -0
  248. package/dist/components/molecules/TextArea/index.js.map +1 -1
  249. package/dist/components/molecules/VerificationCodeInput/index.cjs.map +1 -1
  250. package/dist/components/molecules/VerificationCodeInput/index.d.ts +4 -0
  251. package/dist/components/molecules/VerificationCodeInput/index.d.ts.map +1 -1
  252. package/dist/components/molecules/VerificationCodeInput/index.js.map +1 -1
  253. package/dist/components/organisms/ActivityFeed/index.cjs.map +1 -1
  254. package/dist/components/organisms/ActivityFeed/index.d.ts +11 -0
  255. package/dist/components/organisms/ActivityFeed/index.d.ts.map +1 -1
  256. package/dist/components/organisms/ActivityFeed/index.js.map +1 -1
  257. package/dist/components/organisms/Calendar/index.cjs.map +1 -1
  258. package/dist/components/organisms/Calendar/index.d.ts +3 -0
  259. package/dist/components/organisms/Calendar/index.d.ts.map +1 -1
  260. package/dist/components/organisms/Calendar/index.js.map +1 -1
  261. package/dist/components/organisms/Charts/components/Metrics.cjs.map +1 -1
  262. package/dist/components/organisms/Charts/components/Metrics.d.ts +8 -0
  263. package/dist/components/organisms/Charts/components/Metrics.d.ts.map +1 -1
  264. package/dist/components/organisms/Charts/components/Metrics.js.map +1 -1
  265. package/dist/components/organisms/ColorPicker/index.cjs +1 -0
  266. package/dist/components/organisms/ColorPicker/index.cjs.map +1 -1
  267. package/dist/components/organisms/ColorPicker/index.d.ts +2 -0
  268. package/dist/components/organisms/ColorPicker/index.d.ts.map +1 -1
  269. package/dist/components/organisms/ColorPicker/index.js +1 -0
  270. package/dist/components/organisms/ColorPicker/index.js.map +1 -1
  271. package/dist/components/organisms/ColorPicker/providers/ColorPicker.provider.cjs.map +1 -1
  272. package/dist/components/organisms/ColorPicker/providers/ColorPicker.provider.d.ts +1 -0
  273. package/dist/components/organisms/ColorPicker/providers/ColorPicker.provider.d.ts.map +1 -1
  274. package/dist/components/organisms/ColorPicker/providers/ColorPicker.provider.js.map +1 -1
  275. package/dist/components/organisms/CommandMenu/index.cjs +5 -0
  276. package/dist/components/organisms/CommandMenu/index.cjs.map +1 -1
  277. package/dist/components/organisms/CommandMenu/index.d.ts +13 -0
  278. package/dist/components/organisms/CommandMenu/index.d.ts.map +1 -1
  279. package/dist/components/organisms/CommandMenu/index.js +5 -0
  280. package/dist/components/organisms/CommandMenu/index.js.map +1 -1
  281. package/dist/components/organisms/DatePicker/components/DateRangePicker.cjs.map +1 -1
  282. package/dist/components/organisms/DatePicker/components/DateRangePicker.d.ts +1 -0
  283. package/dist/components/organisms/DatePicker/components/DateRangePicker.d.ts.map +1 -1
  284. package/dist/components/organisms/DatePicker/components/DateRangePicker.js.map +1 -1
  285. package/dist/components/organisms/DatePicker/components/InputDate.cjs.map +1 -1
  286. package/dist/components/organisms/DatePicker/components/InputDate.d.ts +4 -0
  287. package/dist/components/organisms/DatePicker/components/InputDate.d.ts.map +1 -1
  288. package/dist/components/organisms/DatePicker/components/InputDate.js.map +1 -1
  289. package/dist/components/organisms/DatePicker/index.cjs.map +1 -1
  290. package/dist/components/organisms/DatePicker/index.d.ts +1 -0
  291. package/dist/components/organisms/DatePicker/index.d.ts.map +1 -1
  292. package/dist/components/organisms/DatePicker/index.js.map +1 -1
  293. package/dist/components/organisms/FileUpload/index.cjs +7 -0
  294. package/dist/components/organisms/FileUpload/index.cjs.map +1 -1
  295. package/dist/components/organisms/FileUpload/index.d.ts +7 -0
  296. package/dist/components/organisms/FileUpload/index.d.ts.map +1 -1
  297. package/dist/components/organisms/FileUpload/index.js +7 -0
  298. package/dist/components/organisms/FileUpload/index.js.map +1 -1
  299. package/dist/components/organisms/GradientPicker/providers/GradientPicker.provider.cjs.map +1 -1
  300. package/dist/components/organisms/GradientPicker/providers/GradientPicker.provider.d.ts +1 -0
  301. package/dist/components/organisms/GradientPicker/providers/GradientPicker.provider.d.ts.map +1 -1
  302. package/dist/components/organisms/GradientPicker/providers/GradientPicker.provider.js.map +1 -1
  303. package/dist/components/organisms/ImagePicker/providers/ImagePicker.provider.cjs.map +1 -1
  304. package/dist/components/organisms/ImagePicker/providers/ImagePicker.provider.d.ts +1 -0
  305. package/dist/components/organisms/ImagePicker/providers/ImagePicker.provider.d.ts.map +1 -1
  306. package/dist/components/organisms/ImagePicker/providers/ImagePicker.provider.js.map +1 -1
  307. package/dist/components/organisms/Messaging/index.cjs +1 -0
  308. package/dist/components/organisms/Messaging/index.cjs.map +1 -1
  309. package/dist/components/organisms/Messaging/index.d.ts +3 -0
  310. package/dist/components/organisms/Messaging/index.d.ts.map +1 -1
  311. package/dist/components/organisms/Messaging/index.js +1 -0
  312. package/dist/components/organisms/Messaging/index.js.map +1 -1
  313. package/dist/components/organisms/PageHeader/index.cjs.map +1 -1
  314. package/dist/components/organisms/PageHeader/index.d.ts +1 -0
  315. package/dist/components/organisms/PageHeader/index.d.ts.map +1 -1
  316. package/dist/components/organisms/PageHeader/index.js.map +1 -1
  317. package/dist/components/organisms/SlideoutMenu/index.cjs +3 -0
  318. package/dist/components/organisms/SlideoutMenu/index.cjs.map +1 -1
  319. package/dist/components/organisms/SlideoutMenu/index.d.ts +6 -0
  320. package/dist/components/organisms/SlideoutMenu/index.d.ts.map +1 -1
  321. package/dist/components/organisms/SlideoutMenu/index.js +3 -0
  322. package/dist/components/organisms/SlideoutMenu/index.js.map +1 -1
  323. package/dist/components/organisms/Table/index.cjs +1 -0
  324. package/dist/components/organisms/Table/index.cjs.map +1 -1
  325. package/dist/components/organisms/Table/index.d.ts +2 -0
  326. package/dist/components/organisms/Table/index.d.ts.map +1 -1
  327. package/dist/components/organisms/Table/index.js +1 -0
  328. package/dist/components/organisms/Table/index.js.map +1 -1
  329. package/dist/components/organisms/TextEditor/components/TextEditorButton.cjs.map +1 -1
  330. package/dist/components/organisms/TextEditor/components/TextEditorButton.d.ts +1 -0
  331. package/dist/components/organisms/TextEditor/components/TextEditorButton.d.ts.map +1 -1
  332. package/dist/components/organisms/TextEditor/components/TextEditorButton.js.map +1 -1
  333. package/dist/components/organisms/TextEditor/components/TextEditorToolbar.cjs.map +1 -1
  334. package/dist/components/organisms/TextEditor/components/TextEditorToolbar.d.ts +4 -0
  335. package/dist/components/organisms/TextEditor/components/TextEditorToolbar.d.ts.map +1 -1
  336. package/dist/components/organisms/TextEditor/components/TextEditorToolbar.js.map +1 -1
  337. package/dist/components/organisms/TextEditor/components/TextEditorTooltip.cjs.map +1 -1
  338. package/dist/components/organisms/TextEditor/components/TextEditorTooltip.d.ts +2 -0
  339. package/dist/components/organisms/TextEditor/components/TextEditorTooltip.d.ts.map +1 -1
  340. package/dist/components/organisms/TextEditor/components/TextEditorTooltip.js.map +1 -1
  341. package/dist/components/organisms/TreeView/index.cjs.map +1 -1
  342. package/dist/components/organisms/TreeView/index.d.ts +1 -0
  343. package/dist/components/organisms/TreeView/index.d.ts.map +1 -1
  344. package/dist/components/organisms/TreeView/index.js.map +1 -1
  345. package/dist/components/organisms/VideoPlayer/index.cjs.map +1 -1
  346. package/dist/components/organisms/VideoPlayer/index.d.ts +1 -0
  347. package/dist/components/organisms/VideoPlayer/index.d.ts.map +1 -1
  348. package/dist/components/organisms/VideoPlayer/index.js.map +1 -1
  349. package/dist/hooks/__internal__/useAriaDisclosureAttrs/useAriaDisclosureAttrs.cjs +4 -2
  350. package/dist/hooks/__internal__/useAriaDisclosureAttrs/useAriaDisclosureAttrs.cjs.map +1 -1
  351. package/dist/hooks/__internal__/useAriaDisclosureAttrs/useAriaDisclosureAttrs.d.ts +3 -2
  352. package/dist/hooks/__internal__/useAriaDisclosureAttrs/useAriaDisclosureAttrs.d.ts.map +1 -1
  353. package/dist/hooks/__internal__/useAriaDisclosureAttrs/useAriaDisclosureAttrs.js +4 -2
  354. package/dist/hooks/__internal__/useAriaDisclosureAttrs/useAriaDisclosureAttrs.js.map +1 -1
  355. package/dist/hooks/__internal__/useHotkeyHint/useHotkeyHint.cjs +1 -2
  356. package/dist/hooks/__internal__/useHotkeyHint/useHotkeyHint.cjs.map +1 -1
  357. package/dist/hooks/__internal__/useHotkeyHint/useHotkeyHint.d.ts +1 -2
  358. package/dist/hooks/__internal__/useHotkeyHint/useHotkeyHint.d.ts.map +1 -1
  359. package/dist/hooks/__internal__/useHotkeyHint/useHotkeyHint.js +1 -2
  360. package/dist/hooks/__internal__/useHotkeyHint/useHotkeyHint.js.map +1 -1
  361. package/dist/hooks/__internal__/useKeySequences/useKeySequences.cjs +4 -2
  362. package/dist/hooks/__internal__/useKeySequences/useKeySequences.cjs.map +1 -1
  363. package/dist/hooks/__internal__/useKeySequences/useKeySequences.d.ts +4 -2
  364. package/dist/hooks/__internal__/useKeySequences/useKeySequences.d.ts.map +1 -1
  365. package/dist/hooks/__internal__/useKeySequences/useKeySequences.js +4 -2
  366. package/dist/hooks/__internal__/useKeySequences/useKeySequences.js.map +1 -1
  367. package/dist/native/components/atoms/Avatar/index.d.ts +3 -1
  368. package/dist/native/components/atoms/Avatar/index.d.ts.map +1 -1
  369. package/dist/native/components/atoms/Avatar/index.js +1 -1
  370. package/dist/native/components/atoms/Avatar/index.js.map +1 -1
  371. package/dist/native/components/atoms/Divider/index.d.ts +1 -1
  372. package/dist/native/components/atoms/Divider/index.js +1 -1
  373. package/dist/native/components/atoms/Dot/index.d.ts +1 -0
  374. package/dist/native/components/atoms/Dot/index.d.ts.map +1 -1
  375. package/dist/native/components/atoms/Dot/index.js.map +1 -1
  376. package/dist/native/utilities/__internal__/componentGuardUtils/componentGuard.utils.d.ts +24 -4
  377. package/dist/native/utilities/__internal__/componentGuardUtils/componentGuard.utils.d.ts.map +1 -1
  378. package/dist/native/utilities/__internal__/componentGuardUtils/componentGuard.utils.js +24 -4
  379. package/dist/native/utilities/__internal__/componentGuardUtils/componentGuard.utils.js.map +1 -1
  380. package/dist/providers/ErrorBoundary/index.cjs.map +1 -1
  381. package/dist/providers/ErrorBoundary/index.d.ts +1 -0
  382. package/dist/providers/ErrorBoundary/index.d.ts.map +1 -1
  383. package/dist/providers/ErrorBoundary/index.js.map +1 -1
  384. package/dist/providers/PortalContainer/index.cjs +1 -1
  385. package/dist/providers/PortalContainer/index.cjs.map +1 -1
  386. package/dist/providers/PortalContainer/index.d.ts +2 -1
  387. package/dist/providers/PortalContainer/index.d.ts.map +1 -1
  388. package/dist/providers/PortalContainer/index.js +1 -1
  389. package/dist/providers/PortalContainer/index.js.map +1 -1
  390. package/dist/utilities/__internal__/childrenUtils/children.utils.cjs +4 -0
  391. package/dist/utilities/__internal__/childrenUtils/children.utils.cjs.map +1 -1
  392. package/dist/utilities/__internal__/childrenUtils/children.utils.d.ts +4 -0
  393. package/dist/utilities/__internal__/childrenUtils/children.utils.d.ts.map +1 -1
  394. package/dist/utilities/__internal__/childrenUtils/children.utils.js +4 -0
  395. package/dist/utilities/__internal__/childrenUtils/children.utils.js.map +1 -1
  396. package/dist/utilities/__internal__/componentGuardUtils/componentGuard.utils.cjs +24 -4
  397. package/dist/utilities/__internal__/componentGuardUtils/componentGuard.utils.cjs.map +1 -1
  398. package/dist/utilities/__internal__/componentGuardUtils/componentGuard.utils.d.ts +24 -4
  399. package/dist/utilities/__internal__/componentGuardUtils/componentGuard.utils.d.ts.map +1 -1
  400. package/dist/utilities/__internal__/componentGuardUtils/componentGuard.utils.js +24 -4
  401. package/dist/utilities/__internal__/componentGuardUtils/componentGuard.utils.js.map +1 -1
  402. package/dist/utilities/__internal__/focusUtils/focus.utils.cjs +5 -1
  403. package/dist/utilities/__internal__/focusUtils/focus.utils.cjs.map +1 -1
  404. package/dist/utilities/__internal__/focusUtils/focus.utils.d.ts +5 -1
  405. package/dist/utilities/__internal__/focusUtils/focus.utils.d.ts.map +1 -1
  406. package/dist/utilities/__internal__/focusUtils/focus.utils.js +5 -1
  407. package/dist/utilities/__internal__/focusUtils/focus.utils.js.map +1 -1
  408. package/dist/utilities/__internal__/hotkeysUtils/hotkeys.utils.cjs +65 -1
  409. package/dist/utilities/__internal__/hotkeysUtils/hotkeys.utils.cjs.map +1 -1
  410. package/dist/utilities/__internal__/hotkeysUtils/hotkeys.utils.d.ts +65 -1
  411. package/dist/utilities/__internal__/hotkeysUtils/hotkeys.utils.d.ts.map +1 -1
  412. package/dist/utilities/__internal__/hotkeysUtils/hotkeys.utils.js +65 -1
  413. package/dist/utilities/__internal__/hotkeysUtils/hotkeys.utils.js.map +1 -1
  414. package/dist/utilities/__internal__/logUtils/log.utils.cjs +3 -0
  415. package/dist/utilities/__internal__/logUtils/log.utils.cjs.map +1 -1
  416. package/dist/utilities/__internal__/logUtils/log.utils.d.ts +3 -0
  417. package/dist/utilities/__internal__/logUtils/log.utils.d.ts.map +1 -1
  418. package/dist/utilities/__internal__/logUtils/log.utils.js +3 -0
  419. package/dist/utilities/__internal__/logUtils/log.utils.js.map +1 -1
  420. package/dist/utilities/__internal__/platformUtils/platform.utils.cjs +8 -1
  421. package/dist/utilities/__internal__/platformUtils/platform.utils.cjs.map +1 -1
  422. package/dist/utilities/__internal__/platformUtils/platform.utils.d.ts +8 -1
  423. package/dist/utilities/__internal__/platformUtils/platform.utils.d.ts.map +1 -1
  424. package/dist/utilities/__internal__/platformUtils/platform.utils.js +8 -1
  425. package/dist/utilities/__internal__/platformUtils/platform.utils.js.map +1 -1
  426. package/dist/utilities/__internal__/webStorageUtils/webStorage.utils.cjs +24 -3
  427. package/dist/utilities/__internal__/webStorageUtils/webStorage.utils.cjs.map +1 -1
  428. package/dist/utilities/__internal__/webStorageUtils/webStorage.utils.d.ts +24 -3
  429. package/dist/utilities/__internal__/webStorageUtils/webStorage.utils.d.ts.map +1 -1
  430. package/dist/utilities/__internal__/webStorageUtils/webStorage.utils.js +24 -3
  431. package/dist/utilities/__internal__/webStorageUtils/webStorage.utils.js.map +1 -1
  432. package/dist/utilities/renderUtils/importWithRetry.utils.cjs +3 -0
  433. package/dist/utilities/renderUtils/importWithRetry.utils.cjs.map +1 -1
  434. package/dist/utilities/renderUtils/importWithRetry.utils.d.ts +3 -0
  435. package/dist/utilities/renderUtils/importWithRetry.utils.d.ts.map +1 -1
  436. package/dist/utilities/renderUtils/importWithRetry.utils.js +3 -0
  437. package/dist/utilities/renderUtils/importWithRetry.utils.js.map +1 -1
  438. package/package.json +2 -2
@@ -12,11 +12,45 @@ interface Hotkey extends KeyboardModifiers {
12
12
  description?: string;
13
13
  isSequence: boolean;
14
14
  }
15
+ /**
16
+ * Maps a key name or `KeyboardEvent.code` to the lowercase name the parser matches on (`esc` is `escape`, `KeyK` is `k`).
17
+ *
18
+ * @param key A key name from a hotkey string or a physical key code; surrounding spaces are ignored.
19
+ * @returns The canonical lowercase key name.
20
+ */
15
21
  export declare function mapCode(key: string): string;
22
+ /**
23
+ * Reports whether a parsed key is a modifier rather than a key of its own.
24
+ *
25
+ * @param key A lowercase key name as produced by `mapCode`.
26
+ * @returns `true` for `shift`, `alt`, `meta`, `mod`, `ctrl` and `control`.
27
+ */
16
28
  export declare function isHotkeyModifier(key: string): boolean;
29
+ /**
30
+ * Splits a hook input into its alternative hotkeys (`mod+k,ctrl+k`).
31
+ *
32
+ * @param keys The hotkey string passed to `react-hotkeys-hook`.
33
+ * @param delimiter The character that separates alternatives.
34
+ * @returns Each alternative, lowercased.
35
+ */
17
36
  export declare function parseKeysHookInput(keys: string, delimiter?: string): string[];
37
+ /**
38
+ * Parses one hotkey into its modifier flags and keys, as `react-hotkeys-hook` does before matching.
39
+ *
40
+ * @param hotkey A single alternative, either a combination (`mod+k`) or a sequence (`g>p`).
41
+ * @param splitKey The character joining the keys of a combination.
42
+ * @param sequenceSplitKey The character separating the steps of a sequence; its presence makes the hotkey a sequence.
43
+ * @param useKey Whether matching uses the produced character rather than the physical key; carried through unchanged.
44
+ * @param description Text describing the hotkey; carried through unchanged.
45
+ * @returns The modifier flags, the non-modifier keys, and whether the hotkey is a sequence.
46
+ */
18
47
  export declare function parseHotkey(hotkey: string, splitKey?: string, sequenceSplitKey?: string, useKey?: boolean, description?: string): Hotkey;
19
- /** The character a key name stands for (`slash` is `/`), or the name itself when it is not punctuation. */
48
+ /**
49
+ * The character a key name stands for (`slash` is `/`), or the name itself when it is not punctuation.
50
+ *
51
+ * @param key A lowercase key name in hook format.
52
+ * @returns The punctuation character, or `key` unchanged.
53
+ */
20
54
  export declare const hotkeyCharacter: (key: string) => string;
21
55
  /**
22
56
  * Accepts a hotkey in `react-hotkeys-hook` format (`mod+k`) or the symbol shorthand (`⌘K`, `⌘⇧P`,
@@ -26,6 +60,10 @@ export declare const hotkeyCharacter: (key: string) => string;
26
60
  *
27
61
  * `forDisplay` keeps a shifted symbol as written (`⌘?`). Without it, a shifted symbol in a combination
28
62
  * becomes Shift plus its key (`mod+shift+slash`), which is the form that can be registered.
63
+ *
64
+ * @param hotkey One step of a shortcut in either hook format or symbol shorthand.
65
+ * @param options `forDisplay` keeps shifted symbols as written instead of expanding them to Shift plus a key.
66
+ * @returns The hook-format hotkey with duplicate keys removed, or an empty string when `hotkey` holds no keys.
29
67
  */
30
68
  export declare const normalizeHotkey: (hotkey: string, { forDisplay }?: {
31
69
  forDisplay?: boolean;
@@ -34,6 +72,10 @@ export declare const normalizeHotkey: (hotkey: string, { forDisplay }?: {
34
72
  * Turns an item's `shortcutKeys` into hook-format steps. Each entry is one step (`['⌘e']` is a combination,
35
73
  * `['g', 'p']` is G then P), except that an entry holding only modifiers joins the entry after it, so the
36
74
  * older `['⌘', 'H']` spelling still means ⌘H.
75
+ *
76
+ * @param shortcutKeys The item's shortcut entries, in hook format or symbol shorthand.
77
+ * @param options Passed to `normalizeHotkey` for each entry; `forDisplay` keeps shifted symbols as written.
78
+ * @returns One hook-format hotkey per step; trailing modifiers with no key form a final step of their own.
37
79
  */
38
80
  export declare const toHotkeySteps: (shortcutKeys: string[], options?: {
39
81
  forDisplay?: boolean;
@@ -45,18 +87,29 @@ export type ItemHotkeyKind = 'combination' | 'guarded' | 'typed' | 'unsupported'
45
87
  * - `guarded`: one step that typing could produce (Shift+A) or a named key (F1), so it is ignored in fields.
46
88
  * - `typed`: character keys pressed in turn (`?`, G then P), also ignored in fields.
47
89
  * - `unsupported`: several steps with a modifier or named key, which no handler can match.
90
+ *
91
+ * @param steps Hook-format steps as returned by `toHotkeySteps`.
92
+ * @returns The way the shortcut can be triggered.
48
93
  */
49
94
  export declare const getItemHotkeyKind: (steps: string[]) => ItemHotkeyKind;
50
95
  /**
51
96
  * Whether a key event happened while the user is typing in a field, including one inside a shadow root.
52
97
  * Checks the focused element as well as the event target, because react-aria re-dispatches keys typed
53
98
  * in a combobox onto its list.
99
+ *
100
+ * @param event The key event to check.
101
+ * @returns `true` when the event target or the focused element is editable.
54
102
  */
55
103
  export declare const isTypingInField: (event: KeyboardEvent) => boolean;
56
104
  /**
57
105
  * Feeds one typed key into the keys typed so far and reports whether a sequence is now complete.
58
106
  * Returns the index of the matched sequence and an empty buffer, or the buffer to carry forward:
59
107
  * the longest run of recent keys that still begins some sequence.
108
+ *
109
+ * @param typedKeys The buffer carried forward from the previous call.
110
+ * @param key The character just typed.
111
+ * @param sequences The sequences to match against, each a list of characters pressed in turn.
112
+ * @returns The next buffer, plus the position in `sequences` of the match when one completed.
60
113
  */
61
114
  export declare const advanceKeySequence: (typedKeys: string[], key: string, sequences: string[][]) => {
62
115
  buffer: string[];
@@ -65,6 +118,9 @@ export declare const advanceKeySequence: (typedKeys: string[], key: string, sequ
65
118
  /**
66
119
  * Whether a normalised hotkey is made only of modifiers and real keys. Display props accept any text
67
120
  * (`"Ctrl K"`, `"Hold to talk"`), and formatting text that is not a hotkey would mangle it.
121
+ *
122
+ * @param hotkey A single step already passed through `normalizeHotkey`.
123
+ * @returns `true` when it holds at least one real key and nothing that is neither a key nor a modifier.
68
124
  */
69
125
  export declare const isRecognisedHotkey: (hotkey: string) => boolean;
70
126
  /**
@@ -72,6 +128,10 @@ export declare const isRecognisedHotkey: (hotkey: string) => boolean;
72
128
  * `isMac` says whether `mod` is ⌘. For a `react-hotkeys-hook` key that is macOS only (not iOS).
73
129
  * Formats one hotkey: of several comma-separated alternatives it draws only the first. `formatHotkeyLabel`
74
130
  * is the entry point that draws them all.
131
+ *
132
+ * @param hotkey A hook-format hotkey; only its first comma-separated alternative is drawn.
133
+ * @param isMac Whether to draw macOS symbols (`⌘⇧K`) instead of spelled-out modifiers (`Ctrl Shift K`).
134
+ * @returns The display label for the first alternative.
75
135
  */
76
136
  export declare const formatHotkeyHint: (hotkey: string, isMac: boolean) => string;
77
137
  /**
@@ -79,6 +139,10 @@ export declare const formatHotkeyHint: (hotkey: string, isMac: boolean) => strin
79
139
  * shorthand (`⌘K`) or a shortcut written out (`Ctrl+K`), and draws each distinct comma-separated alternative.
80
140
  * Text that is not a hotkey (`Hold to talk`) is returned exactly as written, so a display prop can take
81
141
  * any label.
142
+ *
143
+ * @param hotkey The shortcut in any accepted form, or arbitrary display text.
144
+ * @param isMac Whether `mod` reads as ⌘ and modifiers are drawn as macOS symbols.
145
+ * @returns The label for every distinct alternative, or `hotkey` unchanged when any part is not a hotkey.
82
146
  */
83
147
  export declare const formatHotkeyLabel: (hotkey: string, isMac: boolean) => string;
84
148
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"hotkeys.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/hotkeysUtils/hotkeys.utils.ts"],"names":[],"mappings":"AAcA,UAAU,iBAAiB;IACzB,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,OAAO,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,MAAO,SAAQ,iBAAiB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB;AAuBD,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,WAE3C;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,SAAM,GAAG,MAAM,EAAE,CAE1E;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,SAAM,EAAE,gBAAgB,SAAM,EAAE,MAAM,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAmChI;AAmDD,2GAA2G;AAC3G,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,KAAG,MAAyC,CAAC;AAExF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,iBAAwB;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAO,KAAG,MAevG,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,cAAc,MAAM,EAAE,EAAE,UAAU;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,KAAG,MAAM,EAiBhG,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,CAAC;AAEjF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,MAAM,EAAE,KAAG,cAUnD,CAAC;AAeF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,aAAa,KAAG,OAC6D,CAAC;AAIrH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,EAAE,EAAE,KAAK,MAAM,EAAE,WAAW,MAAM,EAAE,EAAE,KAAG;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAWhI,CAAC;AAuBF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,QAAQ,MAAM,KAAG,OAMnD,CAAC;AAqBF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,KAAG,MAQjE,CAAC;AAWF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,KAAG,MAIlE,CAAC"}
1
+ {"version":3,"file":"hotkeys.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/hotkeysUtils/hotkeys.utils.ts"],"names":[],"mappings":"AAcA,UAAU,iBAAiB;IACzB,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,OAAO,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,MAAO,SAAQ,iBAAiB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB;AAuBD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,WAE3C;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,SAAM,GAAG,MAAM,EAAE,CAE1E;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,SAAM,EAAE,gBAAgB,SAAM,EAAE,MAAM,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAmChI;AAmDD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,KAAG,MAAyC,CAAC;AAExF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,iBAAwB;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAO,KAAG,MAevG,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GAAI,cAAc,MAAM,EAAE,EAAE,UAAU;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,KAAG,MAAM,EAiBhG,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,CAAC;AAEjF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,MAAM,EAAE,KAAG,cAUnD,CAAC;AAeF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,aAAa,KAAG,OAC6D,CAAC;AAIrH;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,EAAE,EAAE,KAAK,MAAM,EAAE,WAAW,MAAM,EAAE,EAAE,KAAG;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAWhI,CAAC;AAuBF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,QAAQ,MAAM,KAAG,OAMnD,CAAC;AAqBF;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,KAAG,MAQjE,CAAC;AAWF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,KAAG,MAIlE,CAAC"}
@@ -28,15 +28,44 @@ const mappedKeys = {
28
28
  ControlLeft: 'ctrl',
29
29
  ControlRight: 'ctrl',
30
30
  };
31
+ /**
32
+ * Maps a key name or `KeyboardEvent.code` to the lowercase name the parser matches on (`esc` is `escape`, `KeyK` is `k`).
33
+ *
34
+ * @param key A key name from a hotkey string or a physical key code; surrounding spaces are ignored.
35
+ * @returns The canonical lowercase key name.
36
+ */
31
37
  function mapCode(key) {
32
38
  return (mappedKeys[key.trim()] || key.trim()).toLowerCase().replace(/key|digit|numpad/, '');
33
39
  }
40
+ /**
41
+ * Reports whether a parsed key is a modifier rather than a key of its own.
42
+ *
43
+ * @param key A lowercase key name as produced by `mapCode`.
44
+ * @returns `true` for `shift`, `alt`, `meta`, `mod`, `ctrl` and `control`.
45
+ */
34
46
  function isHotkeyModifier(key) {
35
47
  return reservedModifierKeywords.includes(key);
36
48
  }
49
+ /**
50
+ * Splits a hook input into its alternative hotkeys (`mod+k,ctrl+k`).
51
+ *
52
+ * @param keys The hotkey string passed to `react-hotkeys-hook`.
53
+ * @param delimiter The character that separates alternatives.
54
+ * @returns Each alternative, lowercased.
55
+ */
37
56
  function parseKeysHookInput(keys, delimiter = ',') {
38
57
  return keys.toLowerCase().split(delimiter);
39
58
  }
59
+ /**
60
+ * Parses one hotkey into its modifier flags and keys, as `react-hotkeys-hook` does before matching.
61
+ *
62
+ * @param hotkey A single alternative, either a combination (`mod+k`) or a sequence (`g>p`).
63
+ * @param splitKey The character joining the keys of a combination.
64
+ * @param sequenceSplitKey The character separating the steps of a sequence; its presence makes the hotkey a sequence.
65
+ * @param useKey Whether matching uses the produced character rather than the physical key; carried through unchanged.
66
+ * @param description Text describing the hotkey; carried through unchanged.
67
+ * @returns The modifier flags, the non-modifier keys, and whether the hotkey is a sequence.
68
+ */
40
69
  function parseHotkey(hotkey, splitKey = '+', sequenceSplitKey = '>', useKey = false, description) {
41
70
  let keys = [];
42
71
  let isSequence = false;
@@ -113,7 +142,12 @@ const SHIFTED_KEYS = {
113
142
  '(': '9',
114
143
  ')': '0',
115
144
  };
116
- /** The character a key name stands for (`slash` is `/`), or the name itself when it is not punctuation. */
145
+ /**
146
+ * The character a key name stands for (`slash` is `/`), or the name itself when it is not punctuation.
147
+ *
148
+ * @param key A lowercase key name in hook format.
149
+ * @returns The punctuation character, or `key` unchanged.
150
+ */
117
151
  const hotkeyCharacter = (key) => KEY_NAME_CHARACTERS[key] ?? key;
118
152
  /**
119
153
  * Accepts a hotkey in `react-hotkeys-hook` format (`mod+k`) or the symbol shorthand (`⌘K`, `⌘⇧P`,
@@ -123,6 +157,10 @@ const hotkeyCharacter = (key) => KEY_NAME_CHARACTERS[key] ?? key;
123
157
  *
124
158
  * `forDisplay` keeps a shifted symbol as written (`⌘?`). Without it, a shifted symbol in a combination
125
159
  * becomes Shift plus its key (`mod+shift+slash`), which is the form that can be registered.
160
+ *
161
+ * @param hotkey One step of a shortcut in either hook format or symbol shorthand.
162
+ * @param options `forDisplay` keeps shifted symbols as written instead of expanding them to Shift plus a key.
163
+ * @returns The hook-format hotkey with duplicate keys removed, or an empty string when `hotkey` holds no keys.
126
164
  */
127
165
  const normalizeHotkey = (hotkey, { forDisplay = false } = {}) => {
128
166
  const keys = hotkey
@@ -143,6 +181,10 @@ const normalizeHotkey = (hotkey, { forDisplay = false } = {}) => {
143
181
  * Turns an item's `shortcutKeys` into hook-format steps. Each entry is one step (`['⌘e']` is a combination,
144
182
  * `['g', 'p']` is G then P), except that an entry holding only modifiers joins the entry after it, so the
145
183
  * older `['⌘', 'H']` spelling still means ⌘H.
184
+ *
185
+ * @param shortcutKeys The item's shortcut entries, in hook format or symbol shorthand.
186
+ * @param options Passed to `normalizeHotkey` for each entry; `forDisplay` keeps shifted symbols as written.
187
+ * @returns One hook-format hotkey per step; trailing modifiers with no key form a final step of their own.
146
188
  */
147
189
  const toHotkeySteps = (shortcutKeys, options) => {
148
190
  const steps = [];
@@ -166,6 +208,9 @@ const toHotkeySteps = (shortcutKeys, options) => {
166
208
  * - `guarded`: one step that typing could produce (Shift+A) or a named key (F1), so it is ignored in fields.
167
209
  * - `typed`: character keys pressed in turn (`?`, G then P), also ignored in fields.
168
210
  * - `unsupported`: several steps with a modifier or named key, which no handler can match.
211
+ *
212
+ * @param steps Hook-format steps as returned by `toHotkeySteps`.
213
+ * @returns The way the shortcut can be triggered.
169
214
  */
170
215
  const getItemHotkeyKind = (steps) => {
171
216
  const stepKeys = steps.map((step) => step.split('+'));
@@ -194,6 +239,9 @@ const deepActiveElement = () => {
194
239
  * Whether a key event happened while the user is typing in a field, including one inside a shadow root.
195
240
  * Checks the focused element as well as the event target, because react-aria re-dispatches keys typed
196
241
  * in a combobox onto its list.
242
+ *
243
+ * @param event The key event to check.
244
+ * @returns `true` when the event target or the focused element is editable.
197
245
  */
198
246
  const isTypingInField = (event) => isEditable(event.composedPath()[0] ?? event.target) || isEditable(event.target) || isEditable(deepActiveElement());
199
247
  const startsWith = (sequence, prefix) => prefix.every((key, index) => sequence[index] === key);
@@ -201,6 +249,11 @@ const startsWith = (sequence, prefix) => prefix.every((key, index) => sequence[i
201
249
  * Feeds one typed key into the keys typed so far and reports whether a sequence is now complete.
202
250
  * Returns the index of the matched sequence and an empty buffer, or the buffer to carry forward:
203
251
  * the longest run of recent keys that still begins some sequence.
252
+ *
253
+ * @param typedKeys The buffer carried forward from the previous call.
254
+ * @param key The character just typed.
255
+ * @param sequences The sequences to match against, each a list of characters pressed in turn.
256
+ * @returns The next buffer, plus the position in `sequences` of the match when one completed.
204
257
  */
205
258
  const advanceKeySequence = (typedKeys, key, sequences) => {
206
259
  const typed = [...typedKeys, key];
@@ -236,6 +289,9 @@ const FUNCTION_KEY = /^f([1-9]|1\d|2[0-4])$/;
236
289
  /**
237
290
  * Whether a normalised hotkey is made only of modifiers and real keys. Display props accept any text
238
291
  * (`"Ctrl K"`, `"Hold to talk"`), and formatting text that is not a hotkey would mangle it.
292
+ *
293
+ * @param hotkey A single step already passed through `normalizeHotkey`.
294
+ * @returns `true` when it holds at least one real key and nothing that is neither a key nor a modifier.
239
295
  */
240
296
  const isRecognisedHotkey = (hotkey) => {
241
297
  const keys = hotkey.split('+').map(mapCode).filter(Boolean);
@@ -265,6 +321,10 @@ const MODIFIER_ORDER = ['meta', 'mod', 'ctrl', 'control', 'alt', 'shift'];
265
321
  * `isMac` says whether `mod` is ⌘. For a `react-hotkeys-hook` key that is macOS only (not iOS).
266
322
  * Formats one hotkey: of several comma-separated alternatives it draws only the first. `formatHotkeyLabel`
267
323
  * is the entry point that draws them all.
324
+ *
325
+ * @param hotkey A hook-format hotkey; only its first comma-separated alternative is drawn.
326
+ * @param isMac Whether to draw macOS symbols (`⌘⇧K`) instead of spelled-out modifiers (`Ctrl Shift K`).
327
+ * @returns The display label for the first alternative.
268
328
  */
269
329
  const formatHotkeyHint = (hotkey, isMac) => {
270
330
  const modifiers = isMac ? MAC_MODIFIERS : OTHER_MODIFIERS;
@@ -286,6 +346,10 @@ const formatSteps = (hotkey, isMac) => {
286
346
  * shorthand (`⌘K`) or a shortcut written out (`Ctrl+K`), and draws each distinct comma-separated alternative.
287
347
  * Text that is not a hotkey (`Hold to talk`) is returned exactly as written, so a display prop can take
288
348
  * any label.
349
+ *
350
+ * @param hotkey The shortcut in any accepted form, or arbitrary display text.
351
+ * @param isMac Whether `mod` reads as ⌘ and modifiers are drawn as macOS symbols.
352
+ * @returns The label for every distinct alternative, or `hotkey` unchanged when any part is not a hotkey.
289
353
  */
290
354
  const formatHotkeyLabel = (hotkey, isMac) => {
291
355
  const alternatives = hotkey.split(ALTERNATIVE_SEPARATOR).map((alternative) => formatSteps(alternative, isMac));
@@ -1 +1 @@
1
- {"version":3,"file":"hotkeys.utils.js","sources":["../../../../src/utilities/__internal__/hotkeysUtils/hotkeys.utils.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;AAUG;AAoBH,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC;AAEnF,MAAM,UAAU,GAA2B;AACzC,IAAA,GAAG,EAAE,QAAQ;AACb,IAAA,MAAM,EAAE,OAAO;AACf,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,KAAK,EAAE,YAAY;AACnB,IAAA,EAAE,EAAE,SAAS;AACb,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,SAAS,EAAE,OAAO;AAClB,IAAA,UAAU,EAAE,OAAO;AACnB,IAAA,OAAO,EAAE,KAAK;AACd,IAAA,QAAQ,EAAE,KAAK;AACf,IAAA,QAAQ,EAAE,MAAM;AAChB,IAAA,SAAS,EAAE,MAAM;AACjB,IAAA,MAAM,EAAE,MAAM;AACd,IAAA,OAAO,EAAE,MAAM;AACf,IAAA,WAAW,EAAE,MAAM;AACnB,IAAA,YAAY,EAAE,MAAM;CACrB;AAEK,SAAU,OAAO,CAAC,GAAW,EAAA;IACjC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;AAC7F;AAEM,SAAU,gBAAgB,CAAC,GAAW,EAAA;AAC1C,IAAA,OAAO,wBAAwB,CAAC,QAAQ,CAAC,GAAG,CAAC;AAC/C;SAEgB,kBAAkB,CAAC,IAAY,EAAE,SAAS,GAAG,GAAG,EAAA;IAC9D,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;AAC5C;SAEgB,WAAW,CAAC,MAAc,EAAE,QAAQ,GAAG,GAAG,EAAE,gBAAgB,GAAG,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,WAAoB,EAAA;IACtH,IAAI,IAAI,GAAa,EAAE;IACvB,IAAI,UAAU,GAAG,KAAK;AAEtB,IAAA,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;QACrC,UAAU,GAAG,IAAI;AACjB,QAAA,IAAI,GAAG;AACJ,aAAA,iBAAiB;aACjB,KAAK,CAAC,gBAAgB;aACtB,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B;SAAO;AACL,QAAA,IAAI,GAAG;AACJ,aAAA,iBAAiB;aACjB,KAAK,CAAC,QAAQ;aACd,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B;AAEA,IAAA,MAAM,SAAS,GAAsB;AACnC,QAAA,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AACzB,QAAA,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;AACvD,QAAA,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;AAC7B,QAAA,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;AAC3B,QAAA,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,MAAM;KACP;AAED,IAAA,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEhF,OAAO;AACL,QAAA,GAAG,SAAS;QACZ,MAAM;AACN,QAAA,IAAI,EAAE,cAAc;QACpB,WAAW;QACX,UAAU;KACX;AACH;AACA;AAEA;AACA,MAAM,aAAa,GAA2B,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;AACpH,MAAM,eAAe,GAA2B,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE;AAEvI,MAAM,cAAc,GAA2B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE;AAEpG;AACA,MAAM,qBAAqB,GAA2B;AACpD,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,QAAQ;AACb,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,aAAa;AAClB,IAAA,GAAG,EAAE,cAAc;AACnB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,WAAW;CACjB;AACD,MAAM,mBAAmB,GAA2B,MAAM,CAAC,WAAW,CACpE,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CACpF;AAED;AACA,MAAM,YAAY,GAA2B;AAC3C,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,QAAQ;AACb,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,aAAa;AAClB,IAAA,GAAG,EAAE,cAAc;AACnB,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,CAAC,EAAE,OAAO;AACV,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,CAAC,EAAE,GAAG;AACN,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;CACT;AAED;AACO,MAAM,eAAe,GAAG,CAAC,GAAW,KAAa,mBAAmB,CAAC,GAAG,CAAC,IAAI;AAEpF;;;;;;;;AAQG;AACI,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,EAAE,UAAU,GAAG,KAAK,EAAA,GAA+B,EAAE,KAAY;IAC/G,MAAM,IAAI,GAAG;SACV,KAAK,CAAC,GAAG;AACT,SAAA,OAAO,CAAC,CAAC,KAAK,KAAI;QACjB,MAAM,UAAU,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;AACpC,QAAA,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,SAAS,IAAI,cAAc,CAAC,CAAC;QACvF,MAAM,OAAO,GAAG,WAAW,KAAK,EAAE,GAAG,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC;QAClF,MAAM,GAAG,GAAG,WAAW,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5E,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;AAC9G,IAAA,CAAC;SACA,MAAM,CAAC,OAAO,CAAC;;IAElB,MAAM,aAAa,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC;IAEhE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,aAAa,IAAI,GAAG,IAAI,YAAY,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AACrI;AAEA;;;;AAIG;MACU,aAAa,GAAG,CAAC,YAAsB,EAAE,OAAkC,KAAc;IACpG,MAAM,KAAK,GAAa,EAAE;IAC1B,IAAI,gBAAgB,GAAa,EAAE;AAEnC,IAAA,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;QAChC,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;AAClD,QAAA,IAAI,CAAC,UAAU;YAAE;AAEjB,QAAA,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;AACjD,YAAA,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;YACjC;QACF;AACA,QAAA,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,gBAAgB,GAAG,EAAE;IACvB;IAEA,OAAO,gBAAgB,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;AACjF;AAIA;;;;;;AAMG;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAe,KAAoB;AACnE,IAAA,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACrD,IAAA,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE;IAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;;AAG/C,IAAA,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAAE,QAAA,OAAO,aAAa;IAC/E,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,eAAe,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AAAE,QAAA,OAAO,OAAO;AACpG,IAAA,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;AAAE,QAAA,OAAO,aAAa;IAC5C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,KAAK,OAAO,CAAC,GAAG,aAAa,GAAG,SAAS;AACvF;AAEA,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC;AACrD,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,MAAsC,KACxD,MAAM,YAAY,WAAW;KAC5B,MAAM,CAAC,iBAAiB,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAEpI,MAAM,iBAAiB,GAAG,MAAqB;AAC7C,IAAA,IAAI,OAAO,GAAG,QAAQ,CAAC,aAAa;AACpC,IAAA,OAAO,OAAO,EAAE,UAAU,EAAE,aAAa;AAAE,QAAA,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa;AACrF,IAAA,OAAO,OAAO;AAChB,CAAC;AAED;;;;AAIG;AACI,MAAM,eAAe,GAAG,CAAC,KAAoB,KAClD,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,iBAAiB,EAAE;AAEnH,MAAM,UAAU,GAAG,CAAC,QAAkB,EAAE,MAAgB,KAAc,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;AAE3H;;;;AAIG;AACI,MAAM,kBAAkB,GAAG,CAAC,SAAmB,EAAE,GAAW,EAAE,SAAqB,KAA4C;IACpI,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,CAAC;AAEjC,IAAA,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACjD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;QACpC,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,IAAI,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1H,IAAI,OAAO,KAAK,EAAE;AAAE,YAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE;AAClD,QAAA,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAAE,YAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE;IACjG;AAEA,IAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;AACvB;AAEA,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,OAAO;IACP,QAAQ;IACR,KAAK;IACL,OAAO;IACP,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,KAAK;IACL,QAAQ;IACR,UAAU;IACV,SAAS;IACT,WAAW;IACX,WAAW;IACX,YAAY;AACZ,IAAA,GAAG,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC;AACxC,CAAA,CAAC;AAEF,MAAM,YAAY,GAAG,uBAAuB;AAE5C;;;AAGG;AACI,MAAM,kBAAkB,GAAG,CAAC,MAAc,KAAa;AAC5D,IAAA,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AAC3D,IAAA,MAAM,KAAK,GAAG,CAAC,GAAW,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;;IAGrG,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,gBAAgB,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACrF;AAEA,MAAM,UAAU,GAA2B;AACzC,IAAA,MAAM,EAAE,KAAK;AACb,IAAA,OAAO,EAAE,GAAG;AACZ,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,UAAU,EAAE,GAAG;AACf,IAAA,MAAM,EAAE,SAAS;AACjB,IAAA,QAAQ,EAAE,WAAW;CACtB;AAED,MAAM,QAAQ,GAAG,CAAC,GAAW,KAAY;AACvC,IAAA,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC;IACtC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;AAAE,QAAA,OAAO,SAAS,CAAC,WAAW,EAAE;IACpF,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAA,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA,CAAE;AACpE,CAAC;AAED;AACA,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;AAEzE;;;;;AAKG;MACU,gBAAgB,GAAG,CAAC,MAAc,EAAE,KAAc,KAAY;IACzE,MAAM,SAAS,GAAG,KAAK,GAAG,aAAa,GAAG,eAAe;IACzD,MAAM,CAAC,WAAW,GAAG,EAAE,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC;AACrD,IAAA,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;AAC9C,IAAA,MAAM,gBAAgB,GAAG,KAAK,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjJ,OAAO,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,GAAG,CAAC;AACjJ;AAEA;AACA,MAAM,kBAAkB,GAAG,iCAAiC;AAC5D,MAAM,qBAAqB,GAAG,YAAY;AAE1C,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,KAAc,KAAwB;IACzE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;AACzG,IAAA,OAAO,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS;AACrH,CAAC;AAED;;;;;AAKG;MACU,iBAAiB,GAAG,CAAC,MAAc,EAAE,KAAc,KAAY;IAC1E,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,KAAK,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;;AAE9G,IAAA,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,KAAK,WAAW,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM;AACxH;AACA;;"}
1
+ {"version":3,"file":"hotkeys.utils.js","sources":["../../../../src/utilities/__internal__/hotkeysUtils/hotkeys.utils.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;AAUG;AAoBH,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC;AAEnF,MAAM,UAAU,GAA2B;AACzC,IAAA,GAAG,EAAE,QAAQ;AACb,IAAA,MAAM,EAAE,OAAO;AACf,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,KAAK,EAAE,YAAY;AACnB,IAAA,EAAE,EAAE,SAAS;AACb,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,SAAS,EAAE,OAAO;AAClB,IAAA,UAAU,EAAE,OAAO;AACnB,IAAA,OAAO,EAAE,KAAK;AACd,IAAA,QAAQ,EAAE,KAAK;AACf,IAAA,QAAQ,EAAE,MAAM;AAChB,IAAA,SAAS,EAAE,MAAM;AACjB,IAAA,MAAM,EAAE,MAAM;AACd,IAAA,OAAO,EAAE,MAAM;AACf,IAAA,WAAW,EAAE,MAAM;AACnB,IAAA,YAAY,EAAE,MAAM;CACrB;AAED;;;;;AAKG;AACG,SAAU,OAAO,CAAC,GAAW,EAAA;IACjC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;AAC7F;AAEA;;;;;AAKG;AACG,SAAU,gBAAgB,CAAC,GAAW,EAAA;AAC1C,IAAA,OAAO,wBAAwB,CAAC,QAAQ,CAAC,GAAG,CAAC;AAC/C;AAEA;;;;;;AAMG;SACa,kBAAkB,CAAC,IAAY,EAAE,SAAS,GAAG,GAAG,EAAA;IAC9D,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;AAC5C;AAEA;;;;;;;;;AASG;SACa,WAAW,CAAC,MAAc,EAAE,QAAQ,GAAG,GAAG,EAAE,gBAAgB,GAAG,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,WAAoB,EAAA;IACtH,IAAI,IAAI,GAAa,EAAE;IACvB,IAAI,UAAU,GAAG,KAAK;AAEtB,IAAA,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;QACrC,UAAU,GAAG,IAAI;AACjB,QAAA,IAAI,GAAG;AACJ,aAAA,iBAAiB;aACjB,KAAK,CAAC,gBAAgB;aACtB,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B;SAAO;AACL,QAAA,IAAI,GAAG;AACJ,aAAA,iBAAiB;aACjB,KAAK,CAAC,QAAQ;aACd,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B;AAEA,IAAA,MAAM,SAAS,GAAsB;AACnC,QAAA,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AACzB,QAAA,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;AACvD,QAAA,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;AAC7B,QAAA,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;AAC3B,QAAA,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,MAAM;KACP;AAED,IAAA,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEhF,OAAO;AACL,QAAA,GAAG,SAAS;QACZ,MAAM;AACN,QAAA,IAAI,EAAE,cAAc;QACpB,WAAW;QACX,UAAU;KACX;AACH;AACA;AAEA;AACA,MAAM,aAAa,GAA2B,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;AACpH,MAAM,eAAe,GAA2B,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE;AAEvI,MAAM,cAAc,GAA2B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE;AAEpG;AACA,MAAM,qBAAqB,GAA2B;AACpD,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,QAAQ;AACb,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,aAAa;AAClB,IAAA,GAAG,EAAE,cAAc;AACnB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,WAAW;CACjB;AACD,MAAM,mBAAmB,GAA2B,MAAM,CAAC,WAAW,CACpE,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CACpF;AAED;AACA,MAAM,YAAY,GAA2B;AAC3C,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,QAAQ;AACb,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,GAAG,EAAE,OAAO;AACZ,IAAA,GAAG,EAAE,aAAa;AAClB,IAAA,GAAG,EAAE,cAAc;AACnB,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,CAAC,EAAE,OAAO;AACV,IAAA,GAAG,EAAE,WAAW;AAChB,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,CAAC,EAAE,GAAG;AACN,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;AACR,IAAA,GAAG,EAAE,GAAG;CACT;AAED;;;;;AAKG;AACI,MAAM,eAAe,GAAG,CAAC,GAAW,KAAa,mBAAmB,CAAC,GAAG,CAAC,IAAI;AAEpF;;;;;;;;;;;;AAYG;AACI,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,EAAE,UAAU,GAAG,KAAK,EAAA,GAA+B,EAAE,KAAY;IAC/G,MAAM,IAAI,GAAG;SACV,KAAK,CAAC,GAAG;AACT,SAAA,OAAO,CAAC,CAAC,KAAK,KAAI;QACjB,MAAM,UAAU,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;AACpC,QAAA,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,SAAS,IAAI,cAAc,CAAC,CAAC;QACvF,MAAM,OAAO,GAAG,WAAW,KAAK,EAAE,GAAG,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC;QAClF,MAAM,GAAG,GAAG,WAAW,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5E,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;AAC9G,IAAA,CAAC;SACA,MAAM,CAAC,OAAO,CAAC;;IAElB,MAAM,aAAa,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC;IAEhE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,aAAa,IAAI,GAAG,IAAI,YAAY,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AACrI;AAEA;;;;;;;;AAQG;MACU,aAAa,GAAG,CAAC,YAAsB,EAAE,OAAkC,KAAc;IACpG,MAAM,KAAK,GAAa,EAAE;IAC1B,IAAI,gBAAgB,GAAa,EAAE;AAEnC,IAAA,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;QAChC,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;AAClD,QAAA,IAAI,CAAC,UAAU;YAAE;AAEjB,QAAA,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;AACjD,YAAA,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;YACjC;QACF;AACA,QAAA,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,gBAAgB,GAAG,EAAE;IACvB;IAEA,OAAO,gBAAgB,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;AACjF;AAIA;;;;;;;;;AASG;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAe,KAAoB;AACnE,IAAA,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACrD,IAAA,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE;IAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;;AAG/C,IAAA,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAAE,QAAA,OAAO,aAAa;IAC/E,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,eAAe,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AAAE,QAAA,OAAO,OAAO;AACpG,IAAA,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;AAAE,QAAA,OAAO,aAAa;IAC5C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,KAAK,OAAO,CAAC,GAAG,aAAa,GAAG,SAAS;AACvF;AAEA,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC;AACrD,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,MAAsC,KACxD,MAAM,YAAY,WAAW;KAC5B,MAAM,CAAC,iBAAiB,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAEpI,MAAM,iBAAiB,GAAG,MAAqB;AAC7C,IAAA,IAAI,OAAO,GAAG,QAAQ,CAAC,aAAa;AACpC,IAAA,OAAO,OAAO,EAAE,UAAU,EAAE,aAAa;AAAE,QAAA,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa;AACrF,IAAA,OAAO,OAAO;AAChB,CAAC;AAED;;;;;;;AAOG;AACI,MAAM,eAAe,GAAG,CAAC,KAAoB,KAClD,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,iBAAiB,EAAE;AAEnH,MAAM,UAAU,GAAG,CAAC,QAAkB,EAAE,MAAgB,KAAc,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;AAE3H;;;;;;;;;AASG;AACI,MAAM,kBAAkB,GAAG,CAAC,SAAmB,EAAE,GAAW,EAAE,SAAqB,KAA4C;IACpI,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,CAAC;AAEjC,IAAA,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACjD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;QACpC,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,IAAI,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1H,IAAI,OAAO,KAAK,EAAE;AAAE,YAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE;AAClD,QAAA,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAAE,YAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE;IACjG;AAEA,IAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;AACvB;AAEA,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,OAAO;IACP,QAAQ;IACR,KAAK;IACL,OAAO;IACP,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,KAAK;IACL,QAAQ;IACR,UAAU;IACV,SAAS;IACT,WAAW;IACX,WAAW;IACX,YAAY;AACZ,IAAA,GAAG,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC;AACxC,CAAA,CAAC;AAEF,MAAM,YAAY,GAAG,uBAAuB;AAE5C;;;;;;AAMG;AACI,MAAM,kBAAkB,GAAG,CAAC,MAAc,KAAa;AAC5D,IAAA,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AAC3D,IAAA,MAAM,KAAK,GAAG,CAAC,GAAW,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;;IAGrG,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,gBAAgB,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACrF;AAEA,MAAM,UAAU,GAA2B;AACzC,IAAA,MAAM,EAAE,KAAK;AACb,IAAA,OAAO,EAAE,GAAG;AACZ,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,UAAU,EAAE,GAAG;AACf,IAAA,MAAM,EAAE,SAAS;AACjB,IAAA,QAAQ,EAAE,WAAW;CACtB;AAED,MAAM,QAAQ,GAAG,CAAC,GAAW,KAAY;AACvC,IAAA,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC;IACtC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;AAAE,QAAA,OAAO,SAAS,CAAC,WAAW,EAAE;IACpF,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAA,EAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA,CAAE;AACpE,CAAC;AAED;AACA,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;AAEzE;;;;;;;;;AASG;MACU,gBAAgB,GAAG,CAAC,MAAc,EAAE,KAAc,KAAY;IACzE,MAAM,SAAS,GAAG,KAAK,GAAG,aAAa,GAAG,eAAe;IACzD,MAAM,CAAC,WAAW,GAAG,EAAE,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC;AACrD,IAAA,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;AAC9C,IAAA,MAAM,gBAAgB,GAAG,KAAK,GAAG,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjJ,OAAO,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,GAAG,CAAC;AACjJ;AAEA;AACA,MAAM,kBAAkB,GAAG,iCAAiC;AAC5D,MAAM,qBAAqB,GAAG,YAAY;AAE1C,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,KAAc,KAAwB;IACzE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;AACzG,IAAA,OAAO,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS;AACrH,CAAC;AAED;;;;;;;;;AASG;MACU,iBAAiB,GAAG,CAAC,MAAc,EAAE,KAAc,KAAY;IAC1E,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,KAAK,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;;AAE9G,IAAA,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,KAAK,WAAW,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM;AACxH;AACA;;"}
@@ -19,6 +19,9 @@ const seenWarnings = new Set();
19
19
  * href scheme, a missing account id) that must stay visible in production —
20
20
  * error-tracking tools pick console.warn up as breadcrumbs — without flooding
21
21
  * the console on re-renders.
22
+ *
23
+ * @param key Identifies the condition; later calls with the same key are silent.
24
+ * @param message The warning text, shown after the library prefix.
22
25
  */
23
26
  const warnOnce = (key, message) => {
24
27
  if (seenWarnings.has(key)) {
@@ -1 +1 @@
1
- {"version":3,"file":"log.utils.cjs","sources":["../../../../src/utilities/__internal__/logUtils/log.utils.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;;;;;;;;;;AAWG;AAEH,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU;AAEtC;;;;;;AAMG;MACU,QAAQ,GAAG,CAAC,GAAW,EAAE,OAAe,KAAU;AAC7D,IAAA,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzB;IACF;AACA,IAAA,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;AACrB,IAAA,OAAO,CAAC,IAAI,CAAC,0BAA0B,OAAO,CAAA,CAAE,CAAC;AACnD;;"}
1
+ {"version":3,"file":"log.utils.cjs","sources":["../../../../src/utilities/__internal__/logUtils/log.utils.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;;;;;;;;;;AAWG;AAEH,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU;AAEtC;;;;;;;;;AASG;MACU,QAAQ,GAAG,CAAC,GAAW,EAAE,OAAe,KAAU;AAC7D,IAAA,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzB;IACF;AACA,IAAA,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;AACrB,IAAA,OAAO,CAAC,IAAI,CAAC,0BAA0B,OAAO,CAAA,CAAE,CAAC;AACnD;;"}
@@ -16,6 +16,9 @@
16
16
  * href scheme, a missing account id) that must stay visible in production —
17
17
  * error-tracking tools pick console.warn up as breadcrumbs — without flooding
18
18
  * the console on re-renders.
19
+ *
20
+ * @param key Identifies the condition; later calls with the same key are silent.
21
+ * @param message The warning text, shown after the library prefix.
19
22
  */
20
23
  export declare const warnOnce: (key: string, message: string) => void;
21
24
  /** Test-only: clears the once-per-key warning memory. */
@@ -1 +1 @@
1
- {"version":3,"file":"log.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/logUtils/log.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,MAAM,EAAE,SAAS,MAAM,KAAG,IAMvD,CAAC;AAEF,yDAAyD;AACzD,eAAO,MAAM,aAAa,QAAO,IAEhC,CAAC"}
1
+ {"version":3,"file":"log.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/logUtils/log.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,MAAM,EAAE,SAAS,MAAM,KAAG,IAMvD,CAAC;AAEF,yDAAyD;AACzD,eAAO,MAAM,aAAa,QAAO,IAEhC,CAAC"}
@@ -17,6 +17,9 @@ const seenWarnings = new Set();
17
17
  * href scheme, a missing account id) that must stay visible in production —
18
18
  * error-tracking tools pick console.warn up as breadcrumbs — without flooding
19
19
  * the console on re-renders.
20
+ *
21
+ * @param key Identifies the condition; later calls with the same key are silent.
22
+ * @param message The warning text, shown after the library prefix.
20
23
  */
21
24
  const warnOnce = (key, message) => {
22
25
  if (seenWarnings.has(key)) {
@@ -1 +1 @@
1
- {"version":3,"file":"log.utils.js","sources":["../../../../src/utilities/__internal__/logUtils/log.utils.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;;AAWG;AAEH,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU;AAEtC;;;;;;AAMG;MACU,QAAQ,GAAG,CAAC,GAAW,EAAE,OAAe,KAAU;AAC7D,IAAA,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzB;IACF;AACA,IAAA,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;AACrB,IAAA,OAAO,CAAC,IAAI,CAAC,0BAA0B,OAAO,CAAA,CAAE,CAAC;AACnD;;"}
1
+ {"version":3,"file":"log.utils.js","sources":["../../../../src/utilities/__internal__/logUtils/log.utils.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;;AAWG;AAEH,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU;AAEtC;;;;;;;;;AASG;MACU,QAAQ,GAAG,CAAC,GAAW,EAAE,OAAe,KAAU;AAC7D,IAAA,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzB;IACF;AACA,IAAA,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;AACrB,IAAA,OAAO,CAAC,IAAI,CAAC,0BAA0B,OAAO,CAAA,CAAE,CAAC;AACnD;;"}
@@ -4,6 +4,9 @@
4
4
  * Works out the operating system from a user-agent string. Best effort: an iPad in desktop mode
5
5
  * reports itself as a Mac, and ChromeOS reads as Linux. The iOS and Mac tests mirror the rule
6
6
  * `react-hotkeys-hook` uses for `mod`, so `macos` is exactly where ⌘ fires a `mod` hotkey.
7
+ *
8
+ * @param userAgent The browser's user-agent string, usually `navigator.userAgent`.
9
+ * @returns The detected operating system, or `unknown` when no rule matches.
7
10
  */
8
11
  const detectPlatformOs = (userAgent) => {
9
12
  if (/iphone|ipad|ipod/i.test(userAgent))
@@ -18,7 +21,11 @@ const detectPlatformOs = (userAgent) => {
18
21
  return 'linux';
19
22
  return 'unknown';
20
23
  };
21
- /** The operating system of the current device; `unknown` when there is no browser user agent, as on the server. */
24
+ /**
25
+ * The operating system of the current device.
26
+ *
27
+ * @returns The detected operating system; `unknown` when there is no browser user agent, as on the server.
28
+ */
22
29
  const getPlatformOs = () => (typeof navigator === 'undefined' ? 'unknown' : detectPlatformOs(navigator.userAgent ?? ''));
23
30
 
24
31
  exports.detectPlatformOs = detectPlatformOs;
@@ -1 +1 @@
1
- {"version":3,"file":"platform.utils.cjs","sources":["../../../../src/utilities/__internal__/platformUtils/platform.utils.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA;;;;AAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAiB,KAAgB;AAChE,IAAA,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,KAAK;AACrD,IAAA,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AAC1C,IAAA,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAChD,IAAA,IAAI,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAC5D,IAAA,IAAI,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AACzD,IAAA,OAAO,SAAS;AAClB;AAEA;AACO,MAAM,aAAa,GAAG,OAAmB,OAAO,SAAS,KAAK,WAAW,GAAG,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC;;;"}
1
+ {"version":3,"file":"platform.utils.cjs","sources":["../../../../src/utilities/__internal__/platformUtils/platform.utils.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA;;;;;;;AAOG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAiB,KAAgB;AAChE,IAAA,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,KAAK;AACrD,IAAA,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AAC1C,IAAA,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAChD,IAAA,IAAI,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAC5D,IAAA,IAAI,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AACzD,IAAA,OAAO,SAAS;AAClB;AAEA;;;;AAIG;AACI,MAAM,aAAa,GAAG,OAAmB,OAAO,SAAS,KAAK,WAAW,GAAG,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC;;;"}
@@ -3,8 +3,15 @@ export type PlatformOs = 'macos' | 'ios' | 'windows' | 'android' | 'linux' | 'un
3
3
  * Works out the operating system from a user-agent string. Best effort: an iPad in desktop mode
4
4
  * reports itself as a Mac, and ChromeOS reads as Linux. The iOS and Mac tests mirror the rule
5
5
  * `react-hotkeys-hook` uses for `mod`, so `macos` is exactly where ⌘ fires a `mod` hotkey.
6
+ *
7
+ * @param userAgent The browser's user-agent string, usually `navigator.userAgent`.
8
+ * @returns The detected operating system, or `unknown` when no rule matches.
6
9
  */
7
10
  export declare const detectPlatformOs: (userAgent: string) => PlatformOs;
8
- /** The operating system of the current device; `unknown` when there is no browser user agent, as on the server. */
11
+ /**
12
+ * The operating system of the current device.
13
+ *
14
+ * @returns The detected operating system; `unknown` when there is no browser user agent, as on the server.
15
+ */
9
16
  export declare const getPlatformOs: () => PlatformOs;
10
17
  //# sourceMappingURL=platform.utils.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"platform.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/platformUtils/platform.utils.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,MAAM,KAAG,UAOpD,CAAC;AAEF,mHAAmH;AACnH,eAAO,MAAM,aAAa,QAAO,UAA0G,CAAC"}
1
+ {"version":3,"file":"platform.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/platformUtils/platform.utils.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;AAEvF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,MAAM,KAAG,UAOpD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,QAAO,UAA0G,CAAC"}
@@ -2,6 +2,9 @@
2
2
  * Works out the operating system from a user-agent string. Best effort: an iPad in desktop mode
3
3
  * reports itself as a Mac, and ChromeOS reads as Linux. The iOS and Mac tests mirror the rule
4
4
  * `react-hotkeys-hook` uses for `mod`, so `macos` is exactly where ⌘ fires a `mod` hotkey.
5
+ *
6
+ * @param userAgent The browser's user-agent string, usually `navigator.userAgent`.
7
+ * @returns The detected operating system, or `unknown` when no rule matches.
5
8
  */
6
9
  const detectPlatformOs = (userAgent) => {
7
10
  if (/iphone|ipad|ipod/i.test(userAgent))
@@ -16,7 +19,11 @@ const detectPlatformOs = (userAgent) => {
16
19
  return 'linux';
17
20
  return 'unknown';
18
21
  };
19
- /** The operating system of the current device; `unknown` when there is no browser user agent, as on the server. */
22
+ /**
23
+ * The operating system of the current device.
24
+ *
25
+ * @returns The detected operating system; `unknown` when there is no browser user agent, as on the server.
26
+ */
20
27
  const getPlatformOs = () => (typeof navigator === 'undefined' ? 'unknown' : detectPlatformOs(navigator.userAgent ?? ''));
21
28
 
22
29
  export { detectPlatformOs, getPlatformOs };
@@ -1 +1 @@
1
- {"version":3,"file":"platform.utils.js","sources":["../../../../src/utilities/__internal__/platformUtils/platform.utils.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;;AAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAiB,KAAgB;AAChE,IAAA,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,KAAK;AACrD,IAAA,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AAC1C,IAAA,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAChD,IAAA,IAAI,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAC5D,IAAA,IAAI,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AACzD,IAAA,OAAO,SAAS;AAClB;AAEA;AACO,MAAM,aAAa,GAAG,OAAmB,OAAO,SAAS,KAAK,WAAW,GAAG,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC;;"}
1
+ {"version":3,"file":"platform.utils.js","sources":["../../../../src/utilities/__internal__/platformUtils/platform.utils.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;;;;;AAOG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAiB,KAAgB;AAChE,IAAA,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,KAAK;AACrD,IAAA,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AAC1C,IAAA,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAChD,IAAA,IAAI,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,SAAS;AAC5D,IAAA,IAAI,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,OAAO;AACzD,IAAA,OAAO,SAAS;AAClB;AAEA;;;;AAIG;AACI,MAAM,aAAa,GAAG,OAAmB,OAAO,SAAS,KAAK,WAAW,GAAG,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC;;"}
@@ -43,14 +43,28 @@ const safeRemove = (getStorage, key) => {
43
43
  return false;
44
44
  }
45
45
  };
46
- /** Reusable `validate` guard for a boolean item. */
46
+ /**
47
+ * Reusable `validate` guard for a boolean item.
48
+ *
49
+ * @param value The deserialised stored value.
50
+ * @returns `true` when the stored value is a boolean.
51
+ */
47
52
  const isBoolean = (value) => typeof value === 'boolean';
48
- /** Reusable `validate` guard for a string item. */
53
+ /**
54
+ * Reusable `validate` guard for a string item.
55
+ *
56
+ * @param value The deserialised stored value.
57
+ * @returns `true` when the stored value is a string.
58
+ */
49
59
  const isString = (value) => typeof value === 'string';
50
60
  /**
51
61
  * Parse a plain `'true'`/`'false'` string (not JSON) into a boolean; throws
52
62
  * `errorMessage` for anything else so `WebStorageItem.get()` treats it as
53
63
  * invalid data and returns `null`.
64
+ *
65
+ * @param raw The string read from storage.
66
+ * @param errorMessage The message thrown when `raw` is neither `'true'` nor `'false'`.
67
+ * @returns The boolean the string spells.
54
68
  */
55
69
  const parseBooleanString = (raw, errorMessage) => {
56
70
  if (raw === 'true')
@@ -59,7 +73,14 @@ const parseBooleanString = (raw, errorMessage) => {
59
73
  return false;
60
74
  throw new Error(errorMessage);
61
75
  };
62
- /** Build a typed, failure-safe accessor for a single key in the given storage. */
76
+ /**
77
+ * Build a typed, failure-safe accessor for a single key in the given storage.
78
+ *
79
+ * @param getStorage Returns the backing store on each access, so a throwing `window.*Storage` getter is caught.
80
+ * @param key The storage key the item reads and writes.
81
+ * @param options How values are serialised and validated, described on `WebStorageItemOptions`.
82
+ * @returns An accessor whose `get`, `set` and `clear` never throw.
83
+ */
63
84
  const createWebStorageItem = (getStorage, key, options = {}) => {
64
85
  const { serialize = JSON.stringify, deserialize = JSON.parse, validate } = options;
65
86
  return {
@@ -1 +1 @@
1
- {"version":3,"file":"webStorage.utils.cjs","sources":["../../../../src/utilities/__internal__/webStorageUtils/webStorage.utils.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;;;;;;;;;AAUG;AAKH,MAAM,OAAO,GAAG,CAAC,UAA2B,EAAE,GAAW,KAAmB;IAC1E,IAAI,OAAO,MAAM,KAAK,WAAW;AAAE,QAAA,OAAO,IAAI;AAC9C,IAAA,IAAI;AACF,QAAA,OAAO,UAAU,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IAClC;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,IAAI;IACb;AACF,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,UAA2B,EAAE,GAAW,EAAE,KAAa,KAAa;IACnF,IAAI,OAAO,MAAM,KAAK,WAAW;AAAE,QAAA,OAAO,KAAK;AAC/C,IAAA,IAAI;QACF,UAAU,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC;AAChC,QAAA,OAAO,IAAI;IACb;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,KAAK;IACd;AACF,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,UAA2B,EAAE,GAAW,KAAa;IACvE,IAAI,OAAO,MAAM,KAAK,WAAW;AAAE,QAAA,OAAO,KAAK;AAC/C,IAAA,IAAI;AACF,QAAA,UAAU,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;AAC5B,QAAA,OAAO,IAAI;IACb;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,KAAK;IACd;AACF,CAAC;AAoBD;AACO,MAAM,SAAS,GAAG,CAAC,KAAc,KAAuB,OAAO,KAAK,KAAK;AAEhF;AACO,MAAM,QAAQ,GAAG,CAAC,KAAc,KAAsB,OAAO,KAAK,KAAK;AAE9E;;;;AAIG;MACU,kBAAkB,GAAG,CAAC,GAAW,EAAE,YAAoB,KAAa;IAC/E,IAAI,GAAG,KAAK,MAAM;AAAE,QAAA,OAAO,IAAI;IAC/B,IAAI,GAAG,KAAK,OAAO;AAAE,QAAA,OAAO,KAAK;AACjC,IAAA,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC;AAC/B;AAEA;AACO,MAAM,oBAAoB,GAAG,CAAI,UAA2B,EAAE,GAAW,EAAE,OAAA,GAAoC,EAAE,KAAuB;AAC7I,IAAA,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC,KAA2B,EAAE,QAAQ,EAAE,GAAG,OAAO;IAExG,OAAO;QACL,GAAG,GAAA;YACD,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;YACpC,IAAI,GAAG,IAAI,IAAI;AAAE,gBAAA,OAAO,IAAI;AAC5B,YAAA,IAAI;AACF,gBAAA,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC;AAC9B,gBAAA,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AAAE,oBAAA,OAAO,IAAI;AAC7C,gBAAA,OAAO,KAAK;YACd;AAAE,YAAA,MAAM;AACN,gBAAA,OAAO,IAAI;YACb;QACF,CAAC;AACD,QAAA,GAAG,CAAC,KAAK,EAAA;AACP,YAAA,IAAI;AACF,gBAAA,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC;;;;gBAInC,IAAI,OAAO,UAAU,KAAK,QAAQ;oBAAE;AACpC,gBAAA,OAAO,CAAC,UAAU,EAAE,GAAG,EAAE,UAAU,CAAC;YACtC;AAAE,YAAA,MAAM;;;YAGR;QACF,CAAC;QACD,KAAK,GAAA;AACH,YAAA,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC;QAC7B,CAAC;KACF;AACH;;;;;"}
1
+ {"version":3,"file":"webStorage.utils.cjs","sources":["../../../../src/utilities/__internal__/webStorageUtils/webStorage.utils.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;;;;;;;;;AAUG;AAKH,MAAM,OAAO,GAAG,CAAC,UAA2B,EAAE,GAAW,KAAmB;IAC1E,IAAI,OAAO,MAAM,KAAK,WAAW;AAAE,QAAA,OAAO,IAAI;AAC9C,IAAA,IAAI;AACF,QAAA,OAAO,UAAU,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IAClC;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,IAAI;IACb;AACF,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,UAA2B,EAAE,GAAW,EAAE,KAAa,KAAa;IACnF,IAAI,OAAO,MAAM,KAAK,WAAW;AAAE,QAAA,OAAO,KAAK;AAC/C,IAAA,IAAI;QACF,UAAU,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC;AAChC,QAAA,OAAO,IAAI;IACb;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,KAAK;IACd;AACF,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,UAA2B,EAAE,GAAW,KAAa;IACvE,IAAI,OAAO,MAAM,KAAK,WAAW;AAAE,QAAA,OAAO,KAAK;AAC/C,IAAA,IAAI;AACF,QAAA,UAAU,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;AAC5B,QAAA,OAAO,IAAI;IACb;AAAE,IAAA,MAAM;AACN,QAAA,OAAO,KAAK;IACd;AACF,CAAC;AAoBD;;;;;AAKG;AACI,MAAM,SAAS,GAAG,CAAC,KAAc,KAAuB,OAAO,KAAK,KAAK;AAEhF;;;;;AAKG;AACI,MAAM,QAAQ,GAAG,CAAC,KAAc,KAAsB,OAAO,KAAK,KAAK;AAE9E;;;;;;;;AAQG;MACU,kBAAkB,GAAG,CAAC,GAAW,EAAE,YAAoB,KAAa;IAC/E,IAAI,GAAG,KAAK,MAAM;AAAE,QAAA,OAAO,IAAI;IAC/B,IAAI,GAAG,KAAK,OAAO;AAAE,QAAA,OAAO,KAAK;AACjC,IAAA,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC;AAC/B;AAEA;;;;;;;AAOG;AACI,MAAM,oBAAoB,GAAG,CAAI,UAA2B,EAAE,GAAW,EAAE,OAAA,GAAoC,EAAE,KAAuB;AAC7I,IAAA,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC,KAA2B,EAAE,QAAQ,EAAE,GAAG,OAAO;IAExG,OAAO;QACL,GAAG,GAAA;YACD,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;YACpC,IAAI,GAAG,IAAI,IAAI;AAAE,gBAAA,OAAO,IAAI;AAC5B,YAAA,IAAI;AACF,gBAAA,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC;AAC9B,gBAAA,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AAAE,oBAAA,OAAO,IAAI;AAC7C,gBAAA,OAAO,KAAK;YACd;AAAE,YAAA,MAAM;AACN,gBAAA,OAAO,IAAI;YACb;QACF,CAAC;AACD,QAAA,GAAG,CAAC,KAAK,EAAA;AACP,YAAA,IAAI;AACF,gBAAA,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC;;;;gBAInC,IAAI,OAAO,UAAU,KAAK,QAAQ;oBAAE;AACpC,gBAAA,OAAO,CAAC,UAAU,EAAE,GAAG,EAAE,UAAU,CAAC;YACtC;AAAE,YAAA,MAAM;;;YAGR;QACF,CAAC;QACD,KAAK,GAAA;AACH,YAAA,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC;QAC7B,CAAC;KACF;AACH;;;;;"}
@@ -27,17 +27,38 @@ export interface WebStorageItemOptions<T> {
27
27
  /** Optional runtime guard; `get()` returns `null` when it fails. */
28
28
  validate?: (value: unknown) => value is T;
29
29
  }
30
- /** Reusable `validate` guard for a boolean item. */
30
+ /**
31
+ * Reusable `validate` guard for a boolean item.
32
+ *
33
+ * @param value The deserialised stored value.
34
+ * @returns `true` when the stored value is a boolean.
35
+ */
31
36
  export declare const isBoolean: (value: unknown) => value is boolean;
32
- /** Reusable `validate` guard for a string item. */
37
+ /**
38
+ * Reusable `validate` guard for a string item.
39
+ *
40
+ * @param value The deserialised stored value.
41
+ * @returns `true` when the stored value is a string.
42
+ */
33
43
  export declare const isString: (value: unknown) => value is string;
34
44
  /**
35
45
  * Parse a plain `'true'`/`'false'` string (not JSON) into a boolean; throws
36
46
  * `errorMessage` for anything else so `WebStorageItem.get()` treats it as
37
47
  * invalid data and returns `null`.
48
+ *
49
+ * @param raw The string read from storage.
50
+ * @param errorMessage The message thrown when `raw` is neither `'true'` nor `'false'`.
51
+ * @returns The boolean the string spells.
38
52
  */
39
53
  export declare const parseBooleanString: (raw: string, errorMessage: string) => boolean;
40
- /** Build a typed, failure-safe accessor for a single key in the given storage. */
54
+ /**
55
+ * Build a typed, failure-safe accessor for a single key in the given storage.
56
+ *
57
+ * @param getStorage Returns the backing store on each access, so a throwing `window.*Storage` getter is caught.
58
+ * @param key The storage key the item reads and writes.
59
+ * @param options How values are serialised and validated, described on `WebStorageItemOptions`.
60
+ * @returns An accessor whose `get`, `set` and `clear` never throw.
61
+ */
41
62
  export declare const createWebStorageItem: <T>(getStorage: StorageAccessor, key: string, options?: WebStorageItemOptions<T>) => WebStorageItem<T>;
42
63
  export {};
43
64
  //# sourceMappingURL=webStorage.utils.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"webStorage.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/webStorageUtils/webStorage.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,qFAAqF;AACrF,KAAK,eAAe,GAAG,MAAM,OAAO,CAAC;AA+BrC,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,gFAAgF;IAChF,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAChB,wEAAwE;IACxE,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IACpB,mDAAmD;IACnD,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,8DAA8D;IAC9D,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC;IACjC,2DAA2D;IAC3D,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,CAAC;IACjC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;CAC3C;AAED,oDAAoD;AACpD,eAAO,MAAM,SAAS,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAAqC,CAAC;AAE1F,mDAAmD;AACnD,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAmC,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,KAAK,MAAM,EAAE,cAAc,MAAM,KAAG,OAItE,CAAC;AAEF,kFAAkF;AAClF,eAAO,MAAM,oBAAoB,GAAI,CAAC,EAAE,YAAY,eAAe,EAAE,KAAK,MAAM,EAAE,UAAS,qBAAqB,CAAC,CAAC,CAAM,KAAG,cAAc,CAAC,CAAC,CAgC1I,CAAC"}
1
+ {"version":3,"file":"webStorage.utils.d.ts","sourceRoot":"","sources":["../../../../src/utilities/__internal__/webStorageUtils/webStorage.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,qFAAqF;AACrF,KAAK,eAAe,GAAG,MAAM,OAAO,CAAC;AA+BrC,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,gFAAgF;IAChF,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAChB,wEAAwE;IACxE,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IACpB,mDAAmD;IACnD,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,8DAA8D;IAC9D,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC;IACjC,2DAA2D;IAC3D,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,CAAC;IACjC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAAqC,CAAC;AAE1F;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAmC,CAAC;AAEvF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAAI,KAAK,MAAM,EAAE,cAAc,MAAM,KAAG,OAItE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,EAAE,YAAY,eAAe,EAAE,KAAK,MAAM,EAAE,UAAS,qBAAqB,CAAC,CAAC,CAAM,KAAG,cAAc,CAAC,CAAC,CAgC1I,CAAC"}
@@ -41,14 +41,28 @@ const safeRemove = (getStorage, key) => {
41
41
  return false;
42
42
  }
43
43
  };
44
- /** Reusable `validate` guard for a boolean item. */
44
+ /**
45
+ * Reusable `validate` guard for a boolean item.
46
+ *
47
+ * @param value The deserialised stored value.
48
+ * @returns `true` when the stored value is a boolean.
49
+ */
45
50
  const isBoolean = (value) => typeof value === 'boolean';
46
- /** Reusable `validate` guard for a string item. */
51
+ /**
52
+ * Reusable `validate` guard for a string item.
53
+ *
54
+ * @param value The deserialised stored value.
55
+ * @returns `true` when the stored value is a string.
56
+ */
47
57
  const isString = (value) => typeof value === 'string';
48
58
  /**
49
59
  * Parse a plain `'true'`/`'false'` string (not JSON) into a boolean; throws
50
60
  * `errorMessage` for anything else so `WebStorageItem.get()` treats it as
51
61
  * invalid data and returns `null`.
62
+ *
63
+ * @param raw The string read from storage.
64
+ * @param errorMessage The message thrown when `raw` is neither `'true'` nor `'false'`.
65
+ * @returns The boolean the string spells.
52
66
  */
53
67
  const parseBooleanString = (raw, errorMessage) => {
54
68
  if (raw === 'true')
@@ -57,7 +71,14 @@ const parseBooleanString = (raw, errorMessage) => {
57
71
  return false;
58
72
  throw new Error(errorMessage);
59
73
  };
60
- /** Build a typed, failure-safe accessor for a single key in the given storage. */
74
+ /**
75
+ * Build a typed, failure-safe accessor for a single key in the given storage.
76
+ *
77
+ * @param getStorage Returns the backing store on each access, so a throwing `window.*Storage` getter is caught.
78
+ * @param key The storage key the item reads and writes.
79
+ * @param options How values are serialised and validated, described on `WebStorageItemOptions`.
80
+ * @returns An accessor whose `get`, `set` and `clear` never throw.
81
+ */
61
82
  const createWebStorageItem = (getStorage, key, options = {}) => {
62
83
  const { serialize = JSON.stringify, deserialize = JSON.parse, validate } = options;
63
84
  return {