@atlaskit/media-client 37.2.37 → 37.3.0

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 (459) hide show
  1. package/CHANGELOG.md +58 -0
  2. package/dist/cjs/client/file-fetcher/FileFetcherError.js +54 -0
  3. package/dist/cjs/client/file-fetcher/error.js +13 -52
  4. package/dist/cjs/client/file-fetcher/index.js +59 -46
  5. package/dist/cjs/client/file-fetcher/isFileFetcherError.js +10 -0
  6. package/dist/cjs/client/media-client.js +4 -4
  7. package/dist/cjs/client/media-store/MediaStore.js +100 -108
  8. package/dist/cjs/client/media-store/MediaStoreError.js +36 -0
  9. package/dist/cjs/client/media-store/cdnFeatureFlag.js +14 -0
  10. package/dist/cjs/client/media-store/decodeJwtToken.js +9 -0
  11. package/dist/cjs/client/media-store/error.js +13 -34
  12. package/dist/cjs/client/media-store/extendImageParams.js +23 -0
  13. package/dist/cjs/client/media-store/getMediaEnvironment.js +11 -0
  14. package/dist/cjs/client/media-store/getMediaRegion.js +11 -0
  15. package/dist/cjs/client/media-store/getValueFromSessionStorage.js +10 -0
  16. package/dist/cjs/client/media-store/isMediaStoreError.js +10 -0
  17. package/dist/cjs/client/media-store/jsonHeaders.js +10 -0
  18. package/dist/cjs/client/media-store/resolveAuth.js +10 -16
  19. package/dist/cjs/client/media-store/resolveInitialAuth.js +13 -0
  20. package/dist/cjs/client/media-store/setKeyValueInSessionStorage.js +19 -0
  21. package/dist/cjs/client/mobile-upload.js +9 -6
  22. package/dist/cjs/identifier.js +20 -15
  23. package/dist/cjs/index.js +60 -37
  24. package/dist/cjs/is-different-identifier.js +16 -0
  25. package/dist/cjs/is-external-image-identifier.js +9 -0
  26. package/dist/cjs/is-file-identifier.js +9 -0
  27. package/dist/cjs/models/artifacts.js +2 -2
  28. package/dist/cjs/models/errors/BaseMediaClientError.js +43 -0
  29. package/dist/cjs/models/errors/CommonMediaClientError.js +32 -0
  30. package/dist/cjs/models/errors/fromCommonMediaClientError.js +28 -0
  31. package/dist/cjs/models/errors/getMediaClientErrorReason.js +10 -0
  32. package/dist/cjs/models/errors/helpers.js +14 -8
  33. package/dist/cjs/models/errors/index.js +37 -96
  34. package/dist/cjs/models/errors/isCommonMediaClientError.js +17 -0
  35. package/dist/cjs/models/errors/isMediaClientError.js +9 -0
  36. package/dist/cjs/models/errors/toCommonMediaClientError.js +13 -0
  37. package/dist/cjs/models/file-state.js +75 -93
  38. package/dist/cjs/models/has-artifacts.js +9 -0
  39. package/dist/cjs/models/is-error-file-state.js +9 -0
  40. package/dist/cjs/models/is-final-file-state.js +9 -0
  41. package/dist/cjs/models/is-image-representation-ready.js +16 -0
  42. package/dist/cjs/models/is-non-error-final-file-state.js +9 -0
  43. package/dist/cjs/models/is-not-found-media-item-details.js +9 -0
  44. package/dist/cjs/models/is-previewable-file-state.js +10 -0
  45. package/dist/cjs/models/is-previewable-type.js +10 -0
  46. package/dist/cjs/models/is-processed-file-state.js +9 -0
  47. package/dist/cjs/models/is-processing-file-state.js +9 -0
  48. package/dist/cjs/models/is-uploading-file-state.js +9 -0
  49. package/dist/cjs/models/map-media-file-to-file-state.js +59 -0
  50. package/dist/cjs/models/map-media-item-to-file-state.js +18 -0
  51. package/dist/cjs/models/media.js +23 -10
  52. package/dist/cjs/uploader/{error.js → UploaderError.js} +2 -6
  53. package/dist/cjs/uploader/index.js +4 -4
  54. package/dist/cjs/uploader/isUploaderError.js +10 -0
  55. package/dist/cjs/utils/addFileAttrsToUrl.js +24 -0
  56. package/dist/cjs/utils/createBatchLoadingFunc.js +127 -0
  57. package/dist/cjs/utils/createFileDataLoader.js +1 -170
  58. package/dist/cjs/utils/createFileDataloader-2.js +15 -0
  59. package/dist/cjs/utils/getAttrsFromUrl.js +41 -0
  60. package/dist/cjs/utils/getItemsFromKeys.js +50 -0
  61. package/dist/cjs/utils/isCDNEnabled.js +15 -0
  62. package/dist/cjs/utils/isMediaBlobUrl.js +10 -0
  63. package/dist/cjs/utils/isPathBasedEnabled.js +14 -0
  64. package/dist/cjs/utils/mapRetryUrlToPathBasedUrl.js +24 -0
  65. package/dist/cjs/utils/mapToMediaCdnUrl.js +38 -0
  66. package/dist/cjs/utils/mapToPathBasedUrl.js +32 -0
  67. package/dist/cjs/utils/mediaCdn.js +2 -40
  68. package/dist/cjs/utils/mediaSubscribable/createMediaSubscribable.js +11 -0
  69. package/dist/cjs/utils/mediaSubscribable/fromObservable.js +13 -5
  70. package/dist/cjs/utils/mobileUpload/{error.js → MobileUploadError.js} +2 -6
  71. package/dist/cjs/utils/mobileUpload/{helpers.js → createMobileDownloadFileStream.js} +8 -18
  72. package/dist/cjs/utils/mobileUpload/createMobileFileStateSubject.js +16 -0
  73. package/dist/cjs/utils/mobileUpload/isMobileUploadError.js +10 -0
  74. package/dist/cjs/utils/mobileUpload/stateMachine/createMobileUploadService.js +10 -0
  75. package/dist/cjs/utils/mobileUpload/stateMachine/{index.js → createMobileUploadStateMachine.js} +8 -12
  76. package/dist/cjs/utils/mobileUpload/stateMachine/states/uploading.js +3 -3
  77. package/dist/cjs/utils/objectToQueryString.js +17 -0
  78. package/dist/cjs/utils/overrideMediaTypeIfUnknown.js +2 -2
  79. package/dist/cjs/utils/pathBasedUrl.js +2 -49
  80. package/dist/cjs/utils/polling/PollingError.js +36 -0
  81. package/dist/cjs/utils/polling/errors.js +13 -34
  82. package/dist/cjs/utils/polling/index.js +11 -6
  83. package/dist/cjs/utils/polling/isPollingError.js +10 -0
  84. package/dist/cjs/utils/rejectTimeout.js +11 -0
  85. package/dist/cjs/utils/request/RequestError.js +56 -0
  86. package/dist/cjs/utils/request/cloneRequestError.js +17 -0
  87. package/dist/cjs/utils/request/createMapResponseToBlob.js +43 -0
  88. package/dist/cjs/utils/request/createMapResponseToJson.js +43 -0
  89. package/dist/cjs/utils/request/createProcessFetchResponse.js +16 -0
  90. package/dist/cjs/utils/request/createRequestErrorFromResponse.js +20 -0
  91. package/dist/cjs/utils/request/createRequestErrorReason.js +30 -0
  92. package/dist/cjs/utils/request/createUrl.js +31 -0
  93. package/dist/cjs/utils/request/defaultShouldRetryError.js +12 -0
  94. package/dist/cjs/utils/request/errors.js +13 -54
  95. package/dist/cjs/utils/request/extendHeaders.js +21 -0
  96. package/dist/cjs/utils/request/extendTraceContext.js +16 -0
  97. package/dist/cjs/utils/request/extractMediaHeaders.js +15 -0
  98. package/dist/cjs/utils/request/fetchRetry.js +120 -0
  99. package/dist/cjs/utils/request/getStatusCode.js +11 -0
  100. package/dist/cjs/utils/request/helpers.js +198 -313
  101. package/dist/cjs/utils/request/index.js +36 -20
  102. package/dist/cjs/utils/request/isAbortedRequestError.js +9 -0
  103. package/dist/cjs/utils/request/isFetchNetworkError.js +10 -0
  104. package/dist/cjs/utils/request/isRateLimitedError.js +11 -0
  105. package/dist/cjs/utils/request/isRequestError.js +10 -0
  106. package/dist/cjs/utils/request/mapAuthToRequestHeaders.js +22 -0
  107. package/dist/cjs/utils/request/waitPromise.js +11 -0
  108. package/dist/cjs/utils/{setTimeoutPromise.js → resolveTimeout.js} +1 -6
  109. package/dist/cjs/utils/url.js +43 -63
  110. package/dist/es2019/client/file-fetcher/FileFetcherError.js +34 -0
  111. package/dist/es2019/client/file-fetcher/error.js +9 -37
  112. package/dist/es2019/client/file-fetcher/index.js +32 -17
  113. package/dist/es2019/client/file-fetcher/isFileFetcherError.js +4 -0
  114. package/dist/es2019/client/media-client.js +1 -1
  115. package/dist/es2019/client/media-store/MediaStore.js +35 -59
  116. package/dist/es2019/client/media-store/MediaStoreError.js +19 -0
  117. package/dist/es2019/client/media-store/cdnFeatureFlag.js +8 -0
  118. package/dist/es2019/client/media-store/decodeJwtToken.js +3 -0
  119. package/dist/es2019/client/media-store/error.js +9 -22
  120. package/dist/es2019/client/media-store/extendImageParams.js +14 -0
  121. package/dist/es2019/client/media-store/getMediaEnvironment.js +5 -0
  122. package/dist/es2019/client/media-store/getMediaRegion.js +5 -0
  123. package/dist/es2019/client/media-store/getValueFromSessionStorage.js +4 -0
  124. package/dist/es2019/client/media-store/isMediaStoreError.js +4 -0
  125. package/dist/es2019/client/media-store/jsonHeaders.js +4 -0
  126. package/dist/es2019/client/media-store/resolveAuth.js +2 -8
  127. package/dist/es2019/client/media-store/resolveInitialAuth.js +7 -0
  128. package/dist/es2019/client/media-store/setKeyValueInSessionStorage.js +13 -0
  129. package/dist/es2019/client/mobile-upload.js +5 -2
  130. package/dist/es2019/identifier.js +14 -14
  131. package/dist/es2019/index.js +31 -8
  132. package/dist/es2019/is-different-identifier.js +9 -0
  133. package/dist/es2019/is-external-image-identifier.js +3 -0
  134. package/dist/es2019/is-file-identifier.js +3 -0
  135. package/dist/es2019/models/artifacts.js +1 -1
  136. package/dist/es2019/models/errors/BaseMediaClientError.js +23 -0
  137. package/dist/es2019/models/errors/CommonMediaClientError.js +13 -0
  138. package/dist/es2019/models/errors/fromCommonMediaClientError.js +20 -0
  139. package/dist/es2019/models/errors/getMediaClientErrorReason.js +4 -0
  140. package/dist/es2019/models/errors/helpers.js +10 -6
  141. package/dist/es2019/models/errors/index.js +27 -72
  142. package/dist/es2019/models/errors/isCommonMediaClientError.js +11 -0
  143. package/dist/es2019/models/errors/isMediaClientError.js +3 -0
  144. package/dist/es2019/models/errors/toCommonMediaClientError.js +8 -0
  145. package/dist/es2019/models/file-state.js +46 -79
  146. package/dist/es2019/models/has-artifacts.js +1 -0
  147. package/dist/es2019/models/is-error-file-state.js +1 -0
  148. package/dist/es2019/models/is-final-file-state.js +1 -0
  149. package/dist/es2019/models/is-image-representation-ready.js +10 -0
  150. package/dist/es2019/models/is-non-error-final-file-state.js +1 -0
  151. package/dist/es2019/models/is-not-found-media-item-details.js +3 -0
  152. package/dist/es2019/models/is-previewable-file-state.js +2 -0
  153. package/dist/es2019/models/is-previewable-type.js +4 -0
  154. package/dist/es2019/models/is-processed-file-state.js +1 -0
  155. package/dist/es2019/models/is-processing-file-state.js +1 -0
  156. package/dist/es2019/models/is-uploading-file-state.js +1 -0
  157. package/dist/es2019/models/map-media-file-to-file-state.js +53 -0
  158. package/dist/es2019/models/map-media-item-to-file-state.js +9 -0
  159. package/dist/es2019/models/media.js +12 -8
  160. package/dist/es2019/uploader/{error.js → UploaderError.js} +1 -4
  161. package/dist/es2019/uploader/index.js +3 -3
  162. package/dist/es2019/uploader/isUploaderError.js +4 -0
  163. package/dist/es2019/utils/addFileAttrsToUrl.js +19 -0
  164. package/dist/es2019/utils/createBatchLoadingFunc.js +74 -0
  165. package/dist/es2019/utils/createFileDataLoader.js +1 -122
  166. package/dist/es2019/utils/createFileDataloader-2.js +8 -0
  167. package/dist/es2019/utils/getAttrsFromUrl.js +35 -0
  168. package/dist/es2019/utils/getItemsFromKeys.js +43 -0
  169. package/dist/es2019/utils/isCDNEnabled.js +9 -0
  170. package/dist/es2019/utils/isMediaBlobUrl.js +4 -0
  171. package/dist/es2019/utils/isPathBasedEnabled.js +7 -0
  172. package/dist/es2019/utils/mapRetryUrlToPathBasedUrl.js +17 -0
  173. package/dist/es2019/utils/mapToMediaCdnUrl.js +32 -0
  174. package/dist/es2019/utils/mapToPathBasedUrl.js +25 -0
  175. package/dist/es2019/utils/mediaCdn.js +1 -37
  176. package/dist/es2019/utils/mediaSubscribable/createMediaSubscribable.js +5 -0
  177. package/dist/es2019/utils/mediaSubscribable/fromObservable.js +7 -4
  178. package/dist/es2019/utils/mobileUpload/{error.js → MobileUploadError.js} +1 -4
  179. package/dist/es2019/utils/mobileUpload/{helpers.js → createMobileDownloadFileStream.js} +3 -11
  180. package/dist/es2019/utils/mobileUpload/createMobileFileStateSubject.js +8 -0
  181. package/dist/es2019/utils/mobileUpload/isMobileUploadError.js +4 -0
  182. package/dist/es2019/utils/mobileUpload/stateMachine/createMobileUploadService.js +4 -0
  183. package/dist/es2019/utils/mobileUpload/stateMachine/{index.js → createMobileUploadStateMachine.js} +7 -10
  184. package/dist/es2019/utils/mobileUpload/stateMachine/states/uploading.js +1 -1
  185. package/dist/es2019/utils/objectToQueryString.js +9 -0
  186. package/dist/es2019/utils/overrideMediaTypeIfUnknown.js +1 -1
  187. package/dist/es2019/utils/pathBasedUrl.js +1 -45
  188. package/dist/es2019/utils/polling/PollingError.js +21 -0
  189. package/dist/es2019/utils/polling/errors.js +9 -24
  190. package/dist/es2019/utils/polling/index.js +10 -2
  191. package/dist/es2019/utils/polling/isPollingError.js +4 -0
  192. package/dist/es2019/utils/rejectTimeout.js +3 -0
  193. package/dist/es2019/utils/request/RequestError.js +39 -0
  194. package/dist/es2019/utils/request/cloneRequestError.js +12 -0
  195. package/dist/es2019/utils/request/createMapResponseToBlob.js +15 -0
  196. package/dist/es2019/utils/request/createMapResponseToJson.js +15 -0
  197. package/dist/es2019/utils/request/createProcessFetchResponse.js +10 -0
  198. package/dist/es2019/utils/request/createRequestErrorFromResponse.js +14 -0
  199. package/dist/es2019/utils/request/createRequestErrorReason.js +24 -0
  200. package/dist/es2019/utils/request/createUrl.js +17 -0
  201. package/dist/es2019/utils/request/defaultShouldRetryError.js +6 -0
  202. package/dist/es2019/utils/request/errors.js +9 -42
  203. package/dist/es2019/utils/request/extendHeaders.js +18 -0
  204. package/dist/es2019/utils/request/extendTraceContext.js +5 -0
  205. package/dist/es2019/utils/request/extractMediaHeaders.js +11 -0
  206. package/dist/es2019/utils/request/fetchRetry.js +54 -0
  207. package/dist/es2019/utils/request/getStatusCode.js +5 -0
  208. package/dist/es2019/utils/request/helpers.js +73 -215
  209. package/dist/es2019/utils/request/index.js +25 -4
  210. package/dist/es2019/utils/request/isAbortedRequestError.js +3 -0
  211. package/dist/es2019/utils/request/isFetchNetworkError.js +4 -0
  212. package/dist/es2019/utils/request/isRateLimitedError.js +5 -0
  213. package/dist/es2019/utils/request/isRequestError.js +4 -0
  214. package/dist/es2019/utils/request/mapAuthToRequestHeaders.js +16 -0
  215. package/dist/es2019/utils/request/waitPromise.js +3 -0
  216. package/dist/es2019/utils/resolveTimeout.js +3 -0
  217. package/dist/es2019/utils/url.js +18 -65
  218. package/dist/esm/client/file-fetcher/FileFetcherError.js +47 -0
  219. package/dist/esm/client/file-fetcher/error.js +9 -50
  220. package/dist/esm/client/file-fetcher/index.js +32 -17
  221. package/dist/esm/client/file-fetcher/isFileFetcherError.js +4 -0
  222. package/dist/esm/client/media-client.js +1 -1
  223. package/dist/esm/client/media-store/MediaStore.js +35 -58
  224. package/dist/esm/client/media-store/MediaStoreError.js +29 -0
  225. package/dist/esm/client/media-store/cdnFeatureFlag.js +8 -0
  226. package/dist/esm/client/media-store/decodeJwtToken.js +3 -0
  227. package/dist/esm/client/media-store/error.js +9 -32
  228. package/dist/esm/client/media-store/extendImageParams.js +16 -0
  229. package/dist/esm/client/media-store/getMediaEnvironment.js +5 -0
  230. package/dist/esm/client/media-store/getMediaRegion.js +5 -0
  231. package/dist/esm/client/media-store/getValueFromSessionStorage.js +4 -0
  232. package/dist/esm/client/media-store/isMediaStoreError.js +4 -0
  233. package/dist/esm/client/media-store/jsonHeaders.js +4 -0
  234. package/dist/esm/client/media-store/resolveAuth.js +3 -9
  235. package/dist/esm/client/media-store/resolveInitialAuth.js +7 -0
  236. package/dist/esm/client/media-store/setKeyValueInSessionStorage.js +13 -0
  237. package/dist/esm/client/mobile-upload.js +5 -2
  238. package/dist/esm/identifier.js +14 -14
  239. package/dist/esm/index.js +31 -8
  240. package/dist/esm/is-different-identifier.js +9 -0
  241. package/dist/esm/is-external-image-identifier.js +3 -0
  242. package/dist/esm/is-file-identifier.js +3 -0
  243. package/dist/esm/models/artifacts.js +1 -1
  244. package/dist/esm/models/errors/BaseMediaClientError.js +36 -0
  245. package/dist/esm/models/errors/CommonMediaClientError.js +25 -0
  246. package/dist/esm/models/errors/fromCommonMediaClientError.js +21 -0
  247. package/dist/esm/models/errors/getMediaClientErrorReason.js +4 -0
  248. package/dist/esm/models/errors/helpers.js +10 -6
  249. package/dist/esm/models/errors/index.js +27 -91
  250. package/dist/esm/models/errors/isCommonMediaClientError.js +11 -0
  251. package/dist/esm/models/errors/isMediaClientError.js +3 -0
  252. package/dist/esm/models/errors/toCommonMediaClientError.js +8 -0
  253. package/dist/esm/models/file-state.js +46 -93
  254. package/dist/esm/models/has-artifacts.js +3 -0
  255. package/dist/esm/models/is-error-file-state.js +3 -0
  256. package/dist/esm/models/is-final-file-state.js +3 -0
  257. package/dist/esm/models/is-image-representation-ready.js +10 -0
  258. package/dist/esm/models/is-non-error-final-file-state.js +3 -0
  259. package/dist/esm/models/is-not-found-media-item-details.js +3 -0
  260. package/dist/esm/models/is-previewable-file-state.js +4 -0
  261. package/dist/esm/models/is-previewable-type.js +4 -0
  262. package/dist/esm/models/is-processed-file-state.js +3 -0
  263. package/dist/esm/models/is-processing-file-state.js +3 -0
  264. package/dist/esm/models/is-uploading-file-state.js +3 -0
  265. package/dist/esm/models/map-media-file-to-file-state.js +52 -0
  266. package/dist/esm/models/map-media-item-to-file-state.js +11 -0
  267. package/dist/esm/models/media.js +12 -8
  268. package/dist/esm/uploader/{error.js → UploaderError.js} +2 -5
  269. package/dist/esm/uploader/index.js +3 -3
  270. package/dist/esm/uploader/isUploaderError.js +4 -0
  271. package/dist/esm/utils/addFileAttrsToUrl.js +17 -0
  272. package/dist/esm/utils/createBatchLoadingFunc.js +121 -0
  273. package/dist/esm/utils/createFileDataLoader.js +1 -166
  274. package/dist/esm/utils/createFileDataloader-2.js +8 -0
  275. package/dist/esm/utils/getAttrsFromUrl.js +35 -0
  276. package/dist/esm/utils/getItemsFromKeys.js +43 -0
  277. package/dist/esm/utils/isCDNEnabled.js +9 -0
  278. package/dist/esm/utils/isMediaBlobUrl.js +4 -0
  279. package/dist/esm/utils/isPathBasedEnabled.js +7 -0
  280. package/dist/esm/utils/mapRetryUrlToPathBasedUrl.js +17 -0
  281. package/dist/esm/utils/mapToMediaCdnUrl.js +32 -0
  282. package/dist/esm/utils/mapToPathBasedUrl.js +25 -0
  283. package/dist/esm/utils/mediaCdn.js +1 -37
  284. package/dist/esm/utils/mediaSubscribable/createMediaSubscribable.js +5 -0
  285. package/dist/esm/utils/mediaSubscribable/fromObservable.js +7 -4
  286. package/dist/esm/utils/mobileUpload/{error.js → MobileUploadError.js} +2 -5
  287. package/dist/esm/utils/mobileUpload/{helpers.js → createMobileDownloadFileStream.js} +3 -13
  288. package/dist/esm/utils/mobileUpload/createMobileFileStateSubject.js +10 -0
  289. package/dist/esm/utils/mobileUpload/isMobileUploadError.js +4 -0
  290. package/dist/esm/utils/mobileUpload/stateMachine/createMobileUploadService.js +4 -0
  291. package/dist/esm/utils/mobileUpload/stateMachine/{index.js → createMobileUploadStateMachine.js} +7 -10
  292. package/dist/esm/utils/mobileUpload/stateMachine/states/uploading.js +1 -1
  293. package/dist/esm/utils/objectToQueryString.js +11 -0
  294. package/dist/esm/utils/overrideMediaTypeIfUnknown.js +1 -1
  295. package/dist/esm/utils/pathBasedUrl.js +1 -45
  296. package/dist/esm/utils/polling/PollingError.js +29 -0
  297. package/dist/esm/utils/polling/errors.js +9 -32
  298. package/dist/esm/utils/polling/index.js +10 -2
  299. package/dist/esm/utils/polling/isPollingError.js +4 -0
  300. package/dist/esm/utils/rejectTimeout.js +5 -0
  301. package/dist/esm/utils/request/RequestError.js +49 -0
  302. package/dist/esm/utils/request/cloneRequestError.js +10 -0
  303. package/dist/esm/utils/request/createMapResponseToBlob.js +36 -0
  304. package/dist/esm/utils/request/createMapResponseToJson.js +36 -0
  305. package/dist/esm/utils/request/createProcessFetchResponse.js +10 -0
  306. package/dist/esm/utils/request/createRequestErrorFromResponse.js +13 -0
  307. package/dist/esm/utils/request/createRequestErrorReason.js +24 -0
  308. package/dist/esm/utils/request/createUrl.js +24 -0
  309. package/dist/esm/utils/request/defaultShouldRetryError.js +6 -0
  310. package/dist/esm/utils/request/errors.js +9 -52
  311. package/dist/esm/utils/request/extendHeaders.js +14 -0
  312. package/dist/esm/utils/request/extendTraceContext.js +9 -0
  313. package/dist/esm/utils/request/extractMediaHeaders.js +9 -0
  314. package/dist/esm/utils/request/fetchRetry.js +113 -0
  315. package/dist/esm/utils/request/getStatusCode.js +5 -0
  316. package/dist/esm/utils/request/helpers.js +73 -295
  317. package/dist/esm/utils/request/index.js +25 -4
  318. package/dist/esm/utils/request/isAbortedRequestError.js +3 -0
  319. package/dist/esm/utils/request/isFetchNetworkError.js +4 -0
  320. package/dist/esm/utils/request/isRateLimitedError.js +5 -0
  321. package/dist/esm/utils/request/isRequestError.js +4 -0
  322. package/dist/esm/utils/request/mapAuthToRequestHeaders.js +16 -0
  323. package/dist/esm/utils/request/waitPromise.js +5 -0
  324. package/dist/esm/utils/{setTimeoutPromise.js → resolveTimeout.js} +0 -5
  325. package/dist/esm/utils/url.js +18 -65
  326. package/dist/types/client/file-fetcher/FileFetcherError.d.ts +32 -0
  327. package/dist/types/client/file-fetcher/error.d.ts +9 -33
  328. package/dist/types/client/file-fetcher/index.d.ts +15 -7
  329. package/dist/types/client/file-fetcher/isFileFetcherError.d.ts +2 -0
  330. package/dist/types/client/media-client.d.ts +4 -3
  331. package/dist/types/client/media-store/MediaStore.d.ts +18 -6
  332. package/dist/types/client/media-store/MediaStoreError.d.ts +14 -0
  333. package/dist/types/client/media-store/cdnFeatureFlag.d.ts +1 -0
  334. package/dist/types/client/media-store/decodeJwtToken.d.ts +3 -0
  335. package/dist/types/client/media-store/error.d.ts +9 -15
  336. package/dist/types/client/media-store/extendImageParams.d.ts +2 -0
  337. package/dist/types/client/media-store/getMediaEnvironment.d.ts +1 -0
  338. package/dist/types/client/media-store/getMediaRegion.d.ts +1 -0
  339. package/dist/types/client/media-store/getValueFromSessionStorage.d.ts +1 -0
  340. package/dist/types/client/media-store/isMediaStoreError.d.ts +2 -0
  341. package/dist/types/client/media-store/jsonHeaders.d.ts +1 -0
  342. package/dist/types/client/media-store/resolveAuth.d.ts +0 -1
  343. package/dist/types/client/media-store/resolveInitialAuth.d.ts +2 -0
  344. package/dist/types/client/media-store/setKeyValueInSessionStorage.d.ts +1 -0
  345. package/dist/types/client/mobile-upload.d.ts +1 -1
  346. package/dist/types/identifier.d.ts +12 -3
  347. package/dist/types/index.d.ts +34 -10
  348. package/dist/types/is-different-identifier.d.ts +2 -0
  349. package/dist/types/is-external-image-identifier.d.ts +2 -0
  350. package/dist/types/is-file-identifier.d.ts +2 -0
  351. package/dist/types/models/errors/BaseMediaClientError.d.ts +11 -0
  352. package/dist/types/models/errors/CommonMediaClientError.d.ts +7 -0
  353. package/dist/types/models/errors/fromCommonMediaClientError.d.ts +4 -0
  354. package/dist/types/models/errors/getMediaClientErrorReason.d.ts +2 -0
  355. package/dist/types/models/errors/helpers.d.ts +8 -5
  356. package/dist/types/models/errors/index.d.ts +26 -21
  357. package/dist/types/models/errors/isCommonMediaClientError.d.ts +3 -0
  358. package/dist/types/models/errors/isMediaClientError.d.ts +4 -0
  359. package/dist/types/models/errors/toCommonMediaClientError.d.ts +4 -0
  360. package/dist/types/models/file-state.d.ts +45 -16
  361. package/dist/types/models/has-artifacts.d.ts +4 -0
  362. package/dist/types/models/is-error-file-state.d.ts +2 -0
  363. package/dist/types/models/is-final-file-state.d.ts +2 -0
  364. package/dist/types/models/is-image-representation-ready.d.ts +2 -0
  365. package/dist/types/models/is-non-error-final-file-state.d.ts +2 -0
  366. package/dist/types/models/is-not-found-media-item-details.d.ts +2 -0
  367. package/dist/types/models/is-previewable-file-state.d.ts +3 -0
  368. package/dist/types/models/is-previewable-type.d.ts +2 -0
  369. package/dist/types/models/is-processed-file-state.d.ts +2 -0
  370. package/dist/types/models/is-processing-file-state.d.ts +2 -0
  371. package/dist/types/models/is-uploading-file-state.d.ts +2 -0
  372. package/dist/types/models/map-media-file-to-file-state.d.ts +4 -0
  373. package/dist/types/models/map-media-item-to-file-state.d.ts +3 -0
  374. package/dist/types/models/media.d.ts +8 -2
  375. package/dist/types/uploader/{error.d.ts → UploaderError.d.ts} +12 -13
  376. package/dist/types/uploader/index.d.ts +1 -1
  377. package/dist/types/uploader/isUploaderError.d.ts +2 -0
  378. package/dist/types/utils/addFileAttrsToUrl.d.ts +2 -0
  379. package/dist/types/utils/createBatchLoadingFunc.d.ts +11 -0
  380. package/dist/types/utils/createCopyIntentRegisterationBatcher.d.ts +1 -1
  381. package/dist/types/utils/createFileDataLoader.d.ts +0 -14
  382. package/dist/types/utils/createFileDataloader-2.d.ts +4 -0
  383. package/dist/types/utils/getAttrsFromUrl.d.ts +2 -0
  384. package/dist/types/utils/getItemsFromKeys.d.ts +3 -0
  385. package/dist/types/utils/imageResizeModeToFileImageMode.d.ts +1 -1
  386. package/dist/types/utils/isCDNEnabled.d.ts +1 -0
  387. package/dist/types/utils/isMediaBlobUrl.d.ts +1 -0
  388. package/dist/types/utils/isPathBasedEnabled.d.ts +1 -0
  389. package/dist/types/utils/mapRetryUrlToPathBasedUrl.d.ts +1 -0
  390. package/dist/types/utils/mapToMediaCdnUrl.d.ts +1 -0
  391. package/dist/types/utils/mapToPathBasedUrl.d.ts +1 -0
  392. package/dist/types/utils/mediaCdn.d.ts +1 -2
  393. package/dist/types/utils/mediaSubscribable/createMediaSubscribable.d.ts +3 -0
  394. package/dist/types/utils/mediaSubscribable/fromObservable.d.ts +4 -1
  395. package/dist/types/utils/mobileUpload/{error.d.ts → MobileUploadError.d.ts} +15 -16
  396. package/dist/types/utils/mobileUpload/createMobileDownloadFileStream.d.ts +5 -0
  397. package/dist/types/utils/mobileUpload/{helpers.d.ts → createMobileFileStateSubject.d.ts} +0 -3
  398. package/dist/types/utils/mobileUpload/isMobileUploadError.d.ts +2 -0
  399. package/dist/types/utils/mobileUpload/stateMachine/createMobileUploadService.d.ts +3 -0
  400. package/dist/types/utils/mobileUpload/stateMachine/{index.d.ts → createMobileUploadStateMachine.d.ts} +2 -3
  401. package/dist/types/utils/objectToQueryString.d.ts +3 -0
  402. package/dist/types/utils/pathBasedUrl.d.ts +1 -3
  403. package/dist/types/utils/polling/PollingError.d.ts +10 -0
  404. package/dist/types/utils/polling/errors.d.ts +8 -11
  405. package/dist/types/utils/polling/index.d.ts +8 -1
  406. package/dist/types/utils/polling/isPollingError.d.ts +2 -0
  407. package/dist/types/utils/{setTimeoutPromise.d.ts → rejectTimeout.d.ts} +0 -1
  408. package/dist/types/utils/request/RequestError.d.ts +21 -0
  409. package/dist/types/utils/request/cloneRequestError.d.ts +3 -0
  410. package/dist/types/utils/request/createMapResponseToBlob.d.ts +2 -0
  411. package/dist/types/utils/request/createMapResponseToJson.d.ts +2 -0
  412. package/dist/types/utils/request/createProcessFetchResponse.d.ts +2 -0
  413. package/dist/types/utils/request/createRequestErrorFromResponse.d.ts +3 -0
  414. package/dist/types/utils/request/createRequestErrorReason.d.ts +2 -0
  415. package/dist/types/utils/request/createUrl.d.ts +2 -0
  416. package/dist/types/utils/request/defaultShouldRetryError.d.ts +1 -0
  417. package/dist/types/utils/request/errors.d.ts +8 -22
  418. package/dist/types/utils/request/extendHeaders.d.ts +4 -0
  419. package/dist/types/utils/request/extendTraceContext.d.ts +2 -0
  420. package/dist/types/utils/request/extractMediaHeaders.d.ts +4 -0
  421. package/dist/types/utils/request/fetchRetry.d.ts +2 -0
  422. package/dist/types/utils/request/getStatusCode.d.ts +1 -0
  423. package/dist/types/utils/request/helpers.d.ts +73 -24
  424. package/dist/types/utils/request/index.d.ts +16 -2
  425. package/dist/types/utils/request/isAbortedRequestError.d.ts +1 -0
  426. package/dist/types/utils/request/isFetchNetworkError.d.ts +1 -0
  427. package/dist/types/utils/request/isRateLimitedError.d.ts +1 -0
  428. package/dist/types/utils/request/isRequestError.d.ts +2 -0
  429. package/dist/types/utils/request/mapAuthToRequestHeaders.d.ts +3 -0
  430. package/dist/types/utils/request/waitPromise.d.ts +1 -0
  431. package/dist/types/utils/resolveTimeout.d.ts +1 -0
  432. package/dist/types/utils/url.d.ts +17 -6
  433. package/example-helpers/CardsWrapper.tsx +15 -0
  434. package/example-helpers/FileInput.tsx +20 -0
  435. package/example-helpers/FileStateWrapper.tsx +15 -0
  436. package/example-helpers/FileWrapper.tsx +22 -0
  437. package/example-helpers/Header.tsx +15 -0
  438. package/example-helpers/ImagePreview.tsx +18 -0
  439. package/example-helpers/MetadataWrapper.tsx +15 -0
  440. package/example-helpers/PreviewWrapper.tsx +15 -0
  441. package/example-helpers/Response.tsx +15 -0
  442. package/example-helpers/Row.tsx +15 -0
  443. package/example-helpers/UploadTouchWrapper.tsx +15 -0
  444. package/example-helpers/Wrapper.tsx +15 -0
  445. package/package.json +2 -2
  446. package/dist/cjs/client/media-store/index.js +0 -37
  447. package/dist/cjs/utils/mediaSubscribable/index.js +0 -25
  448. package/dist/cjs/utils/mobileUpload/index.js +0 -45
  449. package/dist/es2019/client/media-store/index.js +0 -2
  450. package/dist/es2019/utils/mediaSubscribable/index.js +0 -2
  451. package/dist/es2019/utils/mobileUpload/index.js +0 -4
  452. package/dist/es2019/utils/setTimeoutPromise.js +0 -6
  453. package/dist/esm/client/media-store/index.js +0 -2
  454. package/dist/esm/utils/mediaSubscribable/index.js +0 -2
  455. package/dist/esm/utils/mobileUpload/index.js +0 -4
  456. package/dist/types/client/media-store/index.d.ts +0 -4
  457. package/dist/types/utils/mediaSubscribable/index.d.ts +0 -3
  458. package/dist/types/utils/mobileUpload/index.d.ts +0 -5
  459. package/example-helpers/stylesWrapper.tsx +0 -98
@@ -0,0 +1,7 @@
1
+ import { MediaStoreError } from './MediaStoreError';
2
+ export const resolveInitialAuth = auth => {
3
+ if (!auth) {
4
+ throw new MediaStoreError('missingInitialAuth');
5
+ }
6
+ return auth;
7
+ };
@@ -0,0 +1,13 @@
1
+ export const setKeyValueInSessionStorage = (key, value) => {
2
+ // eslint-disable-next-line @atlaskit/platform/no-direct-web-storage-usage -- existing usage
3
+ if (!value || !(window && window.sessionStorage)) {
4
+ return;
5
+ }
6
+
7
+ // eslint-disable-next-line @atlaskit/platform/no-direct-web-storage-usage -- existing usage
8
+ const currentValue = window.sessionStorage.getItem(key);
9
+ if (currentValue !== value) {
10
+ // eslint-disable-next-line @atlaskit/platform/no-direct-web-storage-usage -- existing usage
11
+ window.sessionStorage.setItem(key, value);
12
+ }
13
+ };
@@ -2,8 +2,11 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
2
2
  import { getMediaTypeFromMimeType } from '@atlaskit/media-common';
3
3
  import { mediaStore } from '@atlaskit/media-state/media-store';
4
4
  import { getFileStreamsCache } from '../file-streams-cache';
5
- import { createFileDataloader } from '../utils/createFileDataLoader';
6
- import { createServicesCache, createMobileUploadStateMachine, createMobileUploadService, createMobileFileStateSubject } from '../utils/mobileUpload';
5
+ import { createFileDataloader } from '../utils/createFileDataloader-2';
6
+ import { createMobileFileStateSubject } from '../utils/mobileUpload/createMobileFileStateSubject';
7
+ import { createServicesCache } from '../utils/mobileUpload/servicesCache';
8
+ import { createMobileUploadService } from '../utils/mobileUpload/stateMachine/createMobileUploadService';
9
+ import { createMobileUploadStateMachine } from '../utils/mobileUpload/stateMachine/createMobileUploadStateMachine';
7
10
  export class MobileUploadImpl {
8
11
  constructor(mediaApi, store = mediaStore) {
9
12
  _defineProperty(this, "getErrorFileState", (error, id, occurrenceKey) => typeof error === 'string' ? {
@@ -1,14 +1,14 @@
1
- import deepEqual from 'deep-equal';
2
- export const isFileIdentifier = identifier => {
3
- return identifier.mediaItemType === 'file';
4
- };
5
- export const isExternalImageIdentifier = identifier => {
6
- return identifier.mediaItemType === 'external-image';
7
- };
8
- export const isDifferentIdentifier = (a, b) => {
9
- if (isFileIdentifier(a) && isFileIdentifier(b)) {
10
- return a.id !== b.id || a.collectionName !== b.collectionName || a.occurrenceKey !== b.occurrenceKey;
11
- } else {
12
- return !deepEqual(a, b);
13
- }
14
- };
1
+ /* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
2
+
3
+ /**
4
+ * @deprecated Use `import { isFileIdentifier } from '@atlaskit/media-client'` instead.
5
+ */
6
+ export { isFileIdentifier } from './is-file-identifier';
7
+ /**
8
+ * @deprecated Use `import { isExternalImageIdentifier } from '@atlaskit/media-client'` instead.
9
+ */
10
+ export { isExternalImageIdentifier } from './is-external-image-identifier';
11
+ /**
12
+ * @deprecated Use `import { isDifferentIdentifier } from '@atlaskit/media-client'` instead.
13
+ */
14
+ export { isDifferentIdentifier } from './is-different-identifier';
@@ -1,12 +1,29 @@
1
- export { MediaStore, MediaStoreError, isMediaStoreError, getMediaEnvironment, getMediaRegion } from './client/media-store';
1
+ export { MediaStore } from './client/media-store/MediaStore';
2
+ export { MediaStoreError } from './client/media-store/MediaStoreError';
3
+ export { isMediaStoreError } from './client/media-store/isMediaStoreError';
4
+ export { getMediaRegion } from './client/media-store/getMediaRegion';
5
+ export { getMediaEnvironment } from './client/media-store/getMediaEnvironment';
2
6
  export { UploadController } from './upload-controller';
3
- export { isPreviewableType } from './models/media';
7
+ export { isPreviewableType } from './models/is-previewable-type';
4
8
  export { getArtifactUrl } from './models/artifacts';
5
- export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError } from './models/errors';
6
- export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts } from './models/file-state';
9
+ export { getMediaClientErrorReason, isMediaClientError } from './models/errors';
10
+ export { isCommonMediaClientError } from './models/errors/isCommonMediaClientError';
11
+ export { toCommonMediaClientError } from './models/errors/toCommonMediaClientError';
12
+ export { hasArtifacts } from './models/has-artifacts';
13
+ export { isErrorFileState } from './models/is-error-file-state';
14
+ export { isFinalFileState } from './models/is-final-file-state';
15
+ export { isImageRepresentationReady } from './models/is-image-representation-ready';
16
+ export { isNonErrorFinalFileState } from './models/is-non-error-final-file-state';
17
+ export { isPreviewableFileState } from './models/is-previewable-file-state';
18
+ export { isProcessedFileState } from './models/is-processed-file-state';
19
+ export { isProcessingFileState } from './models/is-processing-file-state';
20
+ export { isUploadingFileState } from './models/is-uploading-file-state';
21
+ export { mapMediaFileToFileState } from './models/map-media-file-to-file-state';
22
+ export { mapMediaItemToFileState } from './models/map-media-item-to-file-state';
7
23
  export { uploadFile } from './uploader';
8
24
  export { request, RequestError, isRequestError, isRateLimitedError, createRequestErrorReason } from './utils/request';
9
- export { isAbortedRequestError, createUrl } from './utils/request/helpers';
25
+ export { createUrl } from './utils/request/createUrl';
26
+ export { isAbortedRequestError } from './utils/request/isAbortedRequestError';
10
27
  export { PollingFunction, isPollingError, PollingError } from './utils/polling';
11
28
  export { imageResizeModeToFileImageMode } from './utils/imageResizeModeToFileImageMode';
12
29
  export { FileFetcherImpl, FileFetcherError, isFileFetcherError } from './client/file-fetcher';
@@ -15,10 +32,16 @@ export { StargateClient } from './client/stargate-client';
15
32
  export { checkWebpSupport } from './utils/checkWebpSupport';
16
33
  export { getDimensionsFromBlob } from './utils/getDimensionsFromBlob';
17
34
  export { createMediaSubject } from './utils/createMediaSubject';
18
- export { isFileIdentifier, isExternalImageIdentifier, isDifferentIdentifier } from './identifier';
35
+ export { isDifferentIdentifier } from './is-different-identifier';
36
+ export { isExternalImageIdentifier } from './is-external-image-identifier';
37
+ export { isFileIdentifier } from './is-file-identifier';
19
38
  export { globalMediaEventEmitter } from './globalMediaEventEmitter';
20
- export { isMediaBlobUrl, getAttrsFromUrl, addFileAttrsToUrl, objectToQueryString } from './utils/url';
21
- export { createMediaSubscribable, fromObservable } from './utils/mediaSubscribable';
39
+ export { addFileAttrsToUrl } from './utils/addFileAttrsToUrl';
40
+ export { getAttrsFromUrl } from './utils/getAttrsFromUrl';
41
+ export { isMediaBlobUrl } from './utils/isMediaBlobUrl';
42
+ export { objectToQueryString } from './utils/objectToQueryString';
43
+ export { fromObservable } from './utils/mediaSubscribable/fromObservable';
44
+ export { createMediaSubscribable } from './utils/mediaSubscribable/createMediaSubscribable';
22
45
  export { RECENTS_COLLECTION, MAX_RESOLUTION } from './constants';
23
46
  export { getFileStreamsCache } from './file-streams-cache';
24
47
  export { ChunkHashAlgorithm } from './media-core';
@@ -0,0 +1,9 @@
1
+ import deepEqual from 'deep-equal';
2
+ import { isFileIdentifier } from './is-file-identifier';
3
+ export const isDifferentIdentifier = (a, b) => {
4
+ if (isFileIdentifier(a) && isFileIdentifier(b)) {
5
+ return a.id !== b.id || a.collectionName !== b.collectionName || a.occurrenceKey !== b.occurrenceKey;
6
+ } else {
7
+ return !deepEqual(a, b);
8
+ }
9
+ };
@@ -0,0 +1,3 @@
1
+ export const isExternalImageIdentifier = identifier => {
2
+ return identifier.mediaItemType === 'external-image';
3
+ };
@@ -0,0 +1,3 @@
1
+ export const isFileIdentifier = identifier => {
2
+ return identifier.mediaItemType === 'file';
3
+ };
@@ -1,4 +1,4 @@
1
- import { isCDNEnabled } from '../utils/mediaCdn';
1
+ import { isCDNEnabled } from '../utils/isCDNEnabled';
2
2
  export const getArtifactUrl = (artifacts, prop) => {
3
3
  var _artifacts$prop, _artifacts$prop3;
4
4
  // eslint-disable-next-line @atlaskit/platform/no-preconditioning
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Base class for media errors
3
+ */
4
+ export class BaseMediaClientError extends Error
5
+ // TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
6
+ {
7
+ constructor(reason, metadata, innerError) {
8
+ super(reason);
9
+
10
+ // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
11
+ this.reason = reason;
12
+ this.metadata = metadata;
13
+ this.innerError = innerError;
14
+ Object.setPrototypeOf(this, new.target.prototype);
15
+
16
+ // https://v8.dev/docs/stack-trace-api
17
+ if ('captureStackTrace' in Error) {
18
+ Error.captureStackTrace(this, new.target);
19
+ }
20
+ }
21
+
22
+ // TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
23
+ }
@@ -0,0 +1,13 @@
1
+ import { BaseMediaClientError } from './BaseMediaClientError';
2
+ // The only reason why this class exists is because BaseMediaClientError is abstract class, so it can't be used to deserialize ErrorFileState. We can refactor and simplify this later.
3
+ /** Generic Media Client Erorr. All errors extending BaseMediaClientError match CommonMediaClientError attributes. Used to deserialize ErrorFileState */
4
+ export class CommonMediaClientError extends BaseMediaClientError {
5
+ constructor(reason, metadata, innerError) {
6
+ super(reason, metadata, innerError);
7
+ }
8
+ get attributes() {
9
+ return {
10
+ reason: this.reason
11
+ };
12
+ }
13
+ }
@@ -0,0 +1,20 @@
1
+ /** Serializer CommonMediaClientError -> ErrorFileState */
2
+ export const fromCommonMediaClientError = (id, occurrenceKey, error) => {
3
+ return {
4
+ status: 'error',
5
+ id,
6
+ occurrenceKey,
7
+ reason: error.reason,
8
+ details: {
9
+ /** Use this attr to translate back into CommonMediaClientError (toCommonMediaClientError) */
10
+ error: {
11
+ reason: error === null || error === void 0 ? void 0 : error.reason,
12
+ metadata: error === null || error === void 0 ? void 0 : error.metadata,
13
+ innerError: error === null || error === void 0 ? void 0 : error.innerError
14
+ },
15
+ // Legacy details
16
+ ...(error === null || error === void 0 ? void 0 : error.attributes)
17
+ },
18
+ message: error === null || error === void 0 ? void 0 : error.message
19
+ };
20
+ };
@@ -0,0 +1,4 @@
1
+ import { isMediaClientError } from './isMediaClientError';
2
+ export function getMediaClientErrorReason(err) {
3
+ return isMediaClientError(err) ? err.attributes.reason : 'unknown';
4
+ }
@@ -1,6 +1,10 @@
1
- export function isMediaClientError(error) {
2
- return error instanceof Object && 'attributes' in error && error.attributes instanceof Object && 'reason' in error.attributes && error instanceof Error;
3
- }
4
- export function getMediaClientErrorReason(err) {
5
- return isMediaClientError(err) ? err.attributes.reason : 'unknown';
6
- }
1
+ /* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
2
+
3
+ /**
4
+ * @deprecated Use `import { isMediaClientError } from '@atlaskit/media-client/errors'` instead.
5
+ */
6
+ export { isMediaClientError } from './isMediaClientError';
7
+ /**
8
+ * @deprecated Use `import { getMediaClientErrorReason } from '@atlaskit/media-client/errors'` instead.
9
+ */
10
+ export { getMediaClientErrorReason } from './getMediaClientErrorReason';
@@ -1,76 +1,31 @@
1
- export { isMediaClientError, getMediaClientErrorReason } from './helpers';
1
+ /* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
2
2
 
3
3
  /**
4
- * Base class for media errors
4
+ * @deprecated Use `import { getMediaClientErrorReason } from '@atlaskit/media-client/errors/helpers'` instead.
5
5
  */
6
- export class BaseMediaClientError extends Error
7
- // TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
8
- {
9
- constructor(reason, metadata, innerError) {
10
- super(reason);
11
-
12
- // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
13
- this.reason = reason;
14
- this.metadata = metadata;
15
- this.innerError = innerError;
16
- Object.setPrototypeOf(this, new.target.prototype);
17
-
18
- // https://v8.dev/docs/stack-trace-api
19
- if ('captureStackTrace' in Error) {
20
- Error.captureStackTrace(this, new.target);
21
- }
22
- }
23
-
24
- // TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
25
- }
26
-
27
- // The only reason why this class exists is because BaseMediaClientError is abstract class, so it can't be used to deserialize ErrorFileState. We can refactor and simplify this later.
28
- /** Generic Media Client Erorr. All errors extending BaseMediaClientError match CommonMediaClientError attributes. Used to deserialize ErrorFileState */
29
- export class CommonMediaClientError extends BaseMediaClientError {
30
- constructor(reason, metadata, innerError) {
31
- super(reason, metadata, innerError);
32
- }
33
- get attributes() {
34
- return {
35
- reason: this.reason
36
- };
37
- }
38
- }
39
- export function isCommonMediaClientError(error) {
40
- if (!error) {
41
- return false;
42
- }
43
- // Check if the error is an instance of Error
44
- if (error instanceof CommonMediaClientError) {
45
- return true;
46
- }
47
- return typeof error.reason === 'string' && ('metadata' in error || error.metadata === undefined) && ('innerError' in error || error.innerError === undefined);
48
- }
49
-
50
- /** Deserializer ErrorFileState -> CommonMediaClientError */
51
- export const toCommonMediaClientError = errorFileState => {
52
- var _errorFileState$detai;
53
- const error = (_errorFileState$detai = errorFileState.details) === null || _errorFileState$detai === void 0 ? void 0 : _errorFileState$detai.error;
54
- return new CommonMediaClientError((error === null || error === void 0 ? void 0 : error.reason) || 'unknown-reason', error === null || error === void 0 ? void 0 : error.metadata, error === null || error === void 0 ? void 0 : error.innerError);
55
- };
6
+ export { getMediaClientErrorReason } from './getMediaClientErrorReason';
7
+ /**
8
+ * @deprecated Use `import { isMediaClientError } from '@atlaskit/media-client/errors/helpers'` instead.
9
+ */
10
+ export { isMediaClientError } from './isMediaClientError';
56
11
 
57
- /** Serializer CommonMediaClientError -> ErrorFileState */
58
- export const fromCommonMediaClientError = (id, occurrenceKey, error) => {
59
- return {
60
- status: 'error',
61
- id,
62
- occurrenceKey,
63
- reason: error.reason,
64
- details: {
65
- /** Use this attr to translate back into CommonMediaClientError (toCommonMediaClientError) */
66
- error: {
67
- reason: error === null || error === void 0 ? void 0 : error.reason,
68
- metadata: error === null || error === void 0 ? void 0 : error.metadata,
69
- innerError: error === null || error === void 0 ? void 0 : error.innerError
70
- },
71
- // Legacy details
72
- ...(error === null || error === void 0 ? void 0 : error.attributes)
73
- },
74
- message: error === null || error === void 0 ? void 0 : error.message
75
- };
76
- };
12
+ /**
13
+ * @deprecated Use `import { BaseMediaClientError } from '@atlaskit/media-client/errors'` instead.
14
+ */
15
+ export { BaseMediaClientError } from './BaseMediaClientError';
16
+ /**
17
+ * @deprecated Use `import { CommonMediaClientError } from '@atlaskit/media-client/errors'` instead.
18
+ */
19
+ export { CommonMediaClientError } from './CommonMediaClientError';
20
+ /**
21
+ * @deprecated Use `import { isCommonMediaClientError } from '@atlaskit/media-client'` instead.
22
+ */
23
+ export { isCommonMediaClientError } from './isCommonMediaClientError';
24
+ /**
25
+ * @deprecated Use `import { toCommonMediaClientError } from '@atlaskit/media-client'` instead.
26
+ */
27
+ export { toCommonMediaClientError } from './toCommonMediaClientError';
28
+ /**
29
+ * @deprecated Use `import { fromCommonMediaClientError } from '@atlaskit/media-client/errors'` instead.
30
+ */
31
+ export { fromCommonMediaClientError } from './fromCommonMediaClientError';
@@ -0,0 +1,11 @@
1
+ import { CommonMediaClientError } from './CommonMediaClientError';
2
+ export function isCommonMediaClientError(error) {
3
+ if (!error) {
4
+ return false;
5
+ }
6
+ // Check if the error is an instance of Error
7
+ if (error instanceof CommonMediaClientError) {
8
+ return true;
9
+ }
10
+ return typeof error.reason === 'string' && ('metadata' in error || error.metadata === undefined) && ('innerError' in error || error.innerError === undefined);
11
+ }
@@ -0,0 +1,3 @@
1
+ export function isMediaClientError(error) {
2
+ return error instanceof Object && 'attributes' in error && error.attributes instanceof Object && 'reason' in error.attributes && error instanceof Error;
3
+ }
@@ -0,0 +1,8 @@
1
+ import { CommonMediaClientError } from './CommonMediaClientError';
2
+
3
+ /** Deserializer ErrorFileState -> CommonMediaClientError */
4
+ export const toCommonMediaClientError = errorFileState => {
5
+ var _errorFileState$detai;
6
+ const error = (_errorFileState$detai = errorFileState.details) === null || _errorFileState$detai === void 0 ? void 0 : _errorFileState$detai.error;
7
+ return new CommonMediaClientError((error === null || error === void 0 ? void 0 : error.reason) || 'unknown-reason', error === null || error === void 0 ? void 0 : error.metadata, error === null || error === void 0 ? void 0 : error.innerError);
8
+ };
@@ -1,79 +1,46 @@
1
- export const isUploadingFileState = fileState => fileState.status === 'uploading';
2
- export const isProcessingFileState = fileState => fileState.status === 'processing';
3
- export const isProcessedFileState = fileState => fileState.status === 'processed';
4
- export const isErrorFileState = fileState => fileState.status === 'error';
5
- export const isPreviewableFileState = fileState => !isErrorFileState(fileState) && !!fileState.preview;
6
- export const isFinalFileState = fileState => ['processed', 'failed-processing', 'error'].includes(fileState.status);
7
- export const isNonErrorFinalFileState = fileState => ['processed', 'failed-processing'].includes(fileState.status);
8
- export const hasArtifacts = fileState => 'artifacts' in fileState && fileState.artifacts !== undefined;
9
- export const isImageRepresentationReady = fileState => {
10
- switch (fileState.status) {
11
- case 'processing':
12
- case 'processed':
13
- case 'failed-processing':
14
- return !!(fileState.representations && fileState.representations.image);
15
- default:
16
- return false;
17
- }
18
- };
19
- export const mapMediaFileToFileState = mediaFile => {
20
- const {
21
- id,
22
- name,
23
- size,
24
- processingStatus,
25
- artifacts,
26
- mediaType,
27
- mimeType,
28
- representations,
29
- createdAt,
30
- metadataTraceContext,
31
- hash,
32
- abuseClassification,
33
- mediaMetadata,
34
- failReason,
35
- previewCdnUrl
36
- } = mediaFile.data;
37
- const baseState = {
38
- id,
39
- name,
40
- size,
41
- mediaType,
42
- mimeType,
43
- artifacts,
44
- representations,
45
- createdAt,
46
- hash,
47
- metadataTraceContext,
48
- abuseClassification,
49
- mediaMetadata,
50
- previewCdnUrl
51
- };
52
- switch (processingStatus) {
53
- case 'pending':
54
- case undefined:
55
- return {
56
- ...baseState,
57
- status: 'processing'
58
- };
59
- case 'succeeded':
60
- return {
61
- ...baseState,
62
- status: 'processed'
63
- };
64
- case 'failed':
65
- return {
66
- ...baseState,
67
- status: 'failed-processing',
68
- failReason
69
- };
70
- }
71
- };
72
- export const mapMediaItemToFileState = (id, item) => {
73
- return mapMediaFileToFileState({
74
- data: {
75
- id,
76
- ...item
77
- }
78
- });
79
- };
1
+ /* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
2
+
3
+ /**
4
+ * @deprecated Use `import { isUploadingFileState } from '@atlaskit/media-client'` instead.
5
+ */
6
+ export { isUploadingFileState } from './is-uploading-file-state';
7
+ /**
8
+ * @deprecated Use `import { isProcessingFileState } from '@atlaskit/media-client'` instead.
9
+ */
10
+ export { isProcessingFileState } from './is-processing-file-state';
11
+ /**
12
+ * @deprecated Use `import { isProcessedFileState } from '@atlaskit/media-client'` instead.
13
+ */
14
+ export { isProcessedFileState } from './is-processed-file-state';
15
+ /**
16
+ * @deprecated Use `import { isErrorFileState } from '@atlaskit/media-client'` instead.
17
+ */
18
+ export { isErrorFileState } from './is-error-file-state';
19
+ /**
20
+ * @deprecated Use `import { isPreviewableFileState } from '@atlaskit/media-client'` instead.
21
+ */
22
+ export { isPreviewableFileState } from './is-previewable-file-state';
23
+ /**
24
+ * @deprecated Use `import { isFinalFileState } from '@atlaskit/media-client'` instead.
25
+ */
26
+ export { isFinalFileState } from './is-final-file-state';
27
+ /**
28
+ * @deprecated Use `import { isNonErrorFinalFileState } from '@atlaskit/media-client'` instead.
29
+ */
30
+ export { isNonErrorFinalFileState } from './is-non-error-final-file-state';
31
+ /**
32
+ * @deprecated Use `import { hasArtifacts } from '@atlaskit/media-client'` instead.
33
+ */
34
+ export { hasArtifacts } from './has-artifacts';
35
+ /**
36
+ * @deprecated Use `import { isImageRepresentationReady } from '@atlaskit/media-client'` instead.
37
+ */
38
+ export { isImageRepresentationReady } from './is-image-representation-ready';
39
+ /**
40
+ * @deprecated Use `import { mapMediaFileToFileState } from '@atlaskit/media-client'` instead.
41
+ */
42
+ export { mapMediaFileToFileState } from './map-media-file-to-file-state';
43
+ /**
44
+ * @deprecated Use `import { mapMediaItemToFileState } from '@atlaskit/media-client'` instead.
45
+ */
46
+ export { mapMediaItemToFileState } from './map-media-item-to-file-state';
@@ -0,0 +1 @@
1
+ export const hasArtifacts = fileState => 'artifacts' in fileState && fileState.artifacts !== undefined;
@@ -0,0 +1 @@
1
+ export const isErrorFileState = fileState => fileState.status === 'error';
@@ -0,0 +1 @@
1
+ export const isFinalFileState = fileState => ['processed', 'failed-processing', 'error'].includes(fileState.status);
@@ -0,0 +1,10 @@
1
+ export const isImageRepresentationReady = fileState => {
2
+ switch (fileState.status) {
3
+ case 'processing':
4
+ case 'processed':
5
+ case 'failed-processing':
6
+ return !!(fileState.representations && fileState.representations.image);
7
+ default:
8
+ return false;
9
+ }
10
+ };
@@ -0,0 +1 @@
1
+ export const isNonErrorFinalFileState = fileState => ['processed', 'failed-processing'].includes(fileState.status);
@@ -0,0 +1,3 @@
1
+ export const isNotFoundMediaItemDetails = itemDetails => {
2
+ return 'type' in itemDetails && itemDetails.type === 'not-found';
3
+ };
@@ -0,0 +1,2 @@
1
+ import { isErrorFileState } from './is-error-file-state';
2
+ export const isPreviewableFileState = fileState => !isErrorFileState(fileState) && !!fileState.preview;
@@ -0,0 +1,4 @@
1
+ export const isPreviewableType = type => {
2
+ const defaultPreviewableTypes = ['audio', 'video', 'image', 'doc'];
3
+ return defaultPreviewableTypes.indexOf(type) > -1;
4
+ };
@@ -0,0 +1 @@
1
+ export const isProcessedFileState = fileState => fileState.status === 'processed';
@@ -0,0 +1 @@
1
+ export const isProcessingFileState = fileState => fileState.status === 'processing';
@@ -0,0 +1 @@
1
+ export const isUploadingFileState = fileState => fileState.status === 'uploading';
@@ -0,0 +1,53 @@
1
+ export const mapMediaFileToFileState = mediaFile => {
2
+ const {
3
+ id,
4
+ name,
5
+ size,
6
+ processingStatus,
7
+ artifacts,
8
+ mediaType,
9
+ mimeType,
10
+ representations,
11
+ createdAt,
12
+ metadataTraceContext,
13
+ hash,
14
+ abuseClassification,
15
+ mediaMetadata,
16
+ failReason,
17
+ previewCdnUrl
18
+ } = mediaFile.data;
19
+ const baseState = {
20
+ id,
21
+ name,
22
+ size,
23
+ mediaType,
24
+ mimeType,
25
+ artifacts,
26
+ representations,
27
+ createdAt,
28
+ hash,
29
+ metadataTraceContext,
30
+ abuseClassification,
31
+ mediaMetadata,
32
+ previewCdnUrl
33
+ };
34
+ switch (processingStatus) {
35
+ case 'pending':
36
+ case undefined:
37
+ return {
38
+ ...baseState,
39
+ status: 'processing'
40
+ };
41
+ case 'succeeded':
42
+ return {
43
+ ...baseState,
44
+ status: 'processed'
45
+ };
46
+ case 'failed':
47
+ return {
48
+ ...baseState,
49
+ status: 'failed-processing',
50
+ failReason
51
+ };
52
+ }
53
+ };
@@ -0,0 +1,9 @@
1
+ import { mapMediaFileToFileState } from './map-media-file-to-file-state';
2
+ export const mapMediaItemToFileState = (id, item) => {
3
+ return mapMediaFileToFileState({
4
+ data: {
5
+ id,
6
+ ...item
7
+ }
8
+ });
9
+ };