@antelopejs/dms-media 0.0.1

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 (360) hide show
  1. package/LICENSE +190 -0
  2. package/README.md +114 -0
  3. package/dist/acl/defaults.d.ts +2 -0
  4. package/dist/acl/defaults.js +19 -0
  5. package/dist/acl/defaults.js.map +1 -0
  6. package/dist/acl/entries.d.ts +4 -0
  7. package/dist/acl/entries.js +21 -0
  8. package/dist/acl/entries.js.map +1 -0
  9. package/dist/acl/grantable.d.ts +1 -0
  10. package/dist/acl/grantable.js +11 -0
  11. package/dist/acl/grantable.js.map +1 -0
  12. package/dist/acl/index.d.ts +4 -0
  13. package/dist/acl/index.js +21 -0
  14. package/dist/acl/index.js.map +1 -0
  15. package/dist/acl/resolver.d.ts +15 -0
  16. package/dist/acl/resolver.js +115 -0
  17. package/dist/acl/resolver.js.map +1 -0
  18. package/dist/asset-lifecycle.d.ts +6 -0
  19. package/dist/asset-lifecycle.js +78 -0
  20. package/dist/asset-lifecycle.js.map +1 -0
  21. package/dist/asset-type/asset-type.d.ts +24 -0
  22. package/dist/asset-type/asset-type.js +54 -0
  23. package/dist/asset-type/asset-type.js.map +1 -0
  24. package/dist/asset-type/bindings.d.ts +19 -0
  25. package/dist/asset-type/bindings.js +116 -0
  26. package/dist/asset-type/bindings.js.map +1 -0
  27. package/dist/asset-type/index.d.ts +2 -0
  28. package/dist/asset-type/index.js +19 -0
  29. package/dist/asset-type/index.js.map +1 -0
  30. package/dist/config.d.ts +15 -0
  31. package/dist/config.js +24 -0
  32. package/dist/config.js.map +1 -0
  33. package/dist/constants.d.ts +6 -0
  34. package/dist/constants.js +10 -0
  35. package/dist/constants.js.map +1 -0
  36. package/dist/crons/index.d.ts +3 -0
  37. package/dist/crons/index.js +23 -0
  38. package/dist/crons/index.js.map +1 -0
  39. package/dist/crons/sweep-derivatives.d.ts +6 -0
  40. package/dist/crons/sweep-derivatives.js +63 -0
  41. package/dist/crons/sweep-derivatives.js.map +1 -0
  42. package/dist/db/index.d.ts +2 -0
  43. package/dist/db/index.js +19 -0
  44. package/dist/db/index.js.map +1 -0
  45. package/dist/db/models/index.d.ts +2 -0
  46. package/dist/db/models/index.js +19 -0
  47. package/dist/db/models/index.js.map +1 -0
  48. package/dist/db/models/mediaAssets.model.d.ts +26 -0
  49. package/dist/db/models/mediaAssets.model.js +58 -0
  50. package/dist/db/models/mediaAssets.model.js.map +1 -0
  51. package/dist/db/models/mediaFolders.model.d.ts +25 -0
  52. package/dist/db/models/mediaFolders.model.js +27 -0
  53. package/dist/db/models/mediaFolders.model.js.map +1 -0
  54. package/dist/db/tables/index.d.ts +2 -0
  55. package/dist/db/tables/index.js +19 -0
  56. package/dist/db/tables/index.js.map +1 -0
  57. package/dist/db/tables/mediaAssets.table.d.ts +24 -0
  58. package/dist/db/tables/mediaAssets.table.js +105 -0
  59. package/dist/db/tables/mediaAssets.table.js.map +1 -0
  60. package/dist/db/tables/mediaFolders.table.d.ts +14 -0
  61. package/dist/db/tables/mediaFolders.table.js +65 -0
  62. package/dist/db/tables/mediaFolders.table.js.map +1 -0
  63. package/dist/derivatives.d.ts +12 -0
  64. package/dist/derivatives.js +166 -0
  65. package/dist/derivatives.js.map +1 -0
  66. package/dist/index.d.ts +18 -0
  67. package/dist/index.js +66 -0
  68. package/dist/index.js.map +1 -0
  69. package/dist/pages/index.d.ts +1 -0
  70. package/dist/pages/index.js +18 -0
  71. package/dist/pages/index.js.map +1 -0
  72. package/dist/pages/media.d.ts +10 -0
  73. package/dist/pages/media.js +35 -0
  74. package/dist/pages/media.js.map +1 -0
  75. package/dist/permissions.d.ts +1 -0
  76. package/dist/permissions.js +37 -0
  77. package/dist/permissions.js.map +1 -0
  78. package/dist/presets.d.ts +15 -0
  79. package/dist/presets.js +48 -0
  80. package/dist/presets.js.map +1 -0
  81. package/dist/routes/index.d.ts +1 -0
  82. package/dist/routes/index.js +18 -0
  83. package/dist/routes/index.js.map +1 -0
  84. package/dist/routes/media/assets.d.ts +48 -0
  85. package/dist/routes/media/assets.js +263 -0
  86. package/dist/routes/media/assets.js.map +1 -0
  87. package/dist/routes/media/constants.d.ts +5 -0
  88. package/dist/routes/media/constants.js +12 -0
  89. package/dist/routes/media/constants.js.map +1 -0
  90. package/dist/routes/media/context.d.ts +49 -0
  91. package/dist/routes/media/context.js +95 -0
  92. package/dist/routes/media/context.js.map +1 -0
  93. package/dist/routes/media/delivery.d.ts +14 -0
  94. package/dist/routes/media/delivery.js +123 -0
  95. package/dist/routes/media/delivery.js.map +1 -0
  96. package/dist/routes/media/dto.d.ts +43 -0
  97. package/dist/routes/media/dto.js +66 -0
  98. package/dist/routes/media/dto.js.map +1 -0
  99. package/dist/routes/media/folders.d.ts +46 -0
  100. package/dist/routes/media/folders.js +259 -0
  101. package/dist/routes/media/folders.js.map +1 -0
  102. package/dist/routes/media/index.d.ts +9 -0
  103. package/dist/routes/media/index.js +26 -0
  104. package/dist/routes/media/index.js.map +1 -0
  105. package/dist/routes/media/storage-keys.d.ts +3 -0
  106. package/dist/routes/media/storage-keys.js +19 -0
  107. package/dist/routes/media/storage-keys.js.map +1 -0
  108. package/dist/routes/media/transform.d.ts +21 -0
  109. package/dist/routes/media/transform.js +99 -0
  110. package/dist/routes/media/transform.js.map +1 -0
  111. package/dist/routes/media/upload.d.ts +24 -0
  112. package/dist/routes/media/upload.js +145 -0
  113. package/dist/routes/media/upload.js.map +1 -0
  114. package/dist/test/antelope.test.d.ts +2 -0
  115. package/dist/test/antelope.test.js +202 -0
  116. package/dist/test/antelope.test.js.map +1 -0
  117. package/dist/test/helpers/assets.d.ts +21 -0
  118. package/dist/test/helpers/assets.js +61 -0
  119. package/dist/test/helpers/assets.js.map +1 -0
  120. package/dist/test/helpers/http.d.ts +4 -0
  121. package/dist/test/helpers/http.js +28 -0
  122. package/dist/test/helpers/http.js.map +1 -0
  123. package/dist/test/helpers/members.d.ts +10 -0
  124. package/dist/test/helpers/members.js +57 -0
  125. package/dist/test/helpers/members.js.map +1 -0
  126. package/dist/test/helpers/owner.d.ts +5 -0
  127. package/dist/test/helpers/owner.js +30 -0
  128. package/dist/test/helpers/owner.js.map +1 -0
  129. package/dist/test/integration/derivative-sweep-query.test.d.ts +1 -0
  130. package/dist/test/integration/derivative-sweep-query.test.js +61 -0
  131. package/dist/test/integration/derivative-sweep-query.test.js.map +1 -0
  132. package/dist/test/integration/folder-query.test.d.ts +1 -0
  133. package/dist/test/integration/folder-query.test.js +88 -0
  134. package/dist/test/integration/folder-query.test.js.map +1 -0
  135. package/dist/test/integration/media-api.test.d.ts +1 -0
  136. package/dist/test/integration/media-api.test.js +178 -0
  137. package/dist/test/integration/media-api.test.js.map +1 -0
  138. package/dist/test/integration/media-bindings.test.d.ts +1 -0
  139. package/dist/test/integration/media-bindings.test.js +141 -0
  140. package/dist/test/integration/media-bindings.test.js.map +1 -0
  141. package/dist/test/integration/media-cleanup.test.d.ts +1 -0
  142. package/dist/test/integration/media-cleanup.test.js +282 -0
  143. package/dist/test/integration/media-cleanup.test.js.map +1 -0
  144. package/dist/test/integration/media-delivery.test.d.ts +1 -0
  145. package/dist/test/integration/media-delivery.test.js +108 -0
  146. package/dist/test/integration/media-delivery.test.js.map +1 -0
  147. package/dist/test/integration/media-guards.test.d.ts +1 -0
  148. package/dist/test/integration/media-guards.test.js +128 -0
  149. package/dist/test/integration/media-guards.test.js.map +1 -0
  150. package/dist/test/integration/media-list-query.test.d.ts +1 -0
  151. package/dist/test/integration/media-list-query.test.js +86 -0
  152. package/dist/test/integration/media-list-query.test.js.map +1 -0
  153. package/dist/test/integration/media-permissions.test.d.ts +1 -0
  154. package/dist/test/integration/media-permissions.test.js +549 -0
  155. package/dist/test/integration/media-permissions.test.js.map +1 -0
  156. package/dist/test/integration/media-search-query.test.d.ts +1 -0
  157. package/dist/test/integration/media-search-query.test.js +100 -0
  158. package/dist/test/integration/media-search-query.test.js.map +1 -0
  159. package/dist/test/integration/media-transform.test.d.ts +1 -0
  160. package/dist/test/integration/media-transform.test.js +125 -0
  161. package/dist/test/integration/media-transform.test.js.map +1 -0
  162. package/dist/test/integration/setup.test.d.ts +1 -0
  163. package/dist/test/integration/setup.test.js +32 -0
  164. package/dist/test/integration/setup.test.js.map +1 -0
  165. package/dist/test/unit/acl/entries.test.d.ts +1 -0
  166. package/dist/test/unit/acl/entries.test.js +46 -0
  167. package/dist/test/unit/acl/entries.test.js.map +1 -0
  168. package/dist/test/unit/acl/grantable.test.d.ts +1 -0
  169. package/dist/test/unit/acl/grantable.test.js +41 -0
  170. package/dist/test/unit/acl/grantable.test.js.map +1 -0
  171. package/dist/test/unit/acl/resolver.test.d.ts +1 -0
  172. package/dist/test/unit/acl/resolver.test.js +183 -0
  173. package/dist/test/unit/acl/resolver.test.js.map +1 -0
  174. package/dist/test/unit/asset-type/bindings.test.d.ts +1 -0
  175. package/dist/test/unit/asset-type/bindings.test.js +127 -0
  176. package/dist/test/unit/asset-type/bindings.test.js.map +1 -0
  177. package/dist/test/unit/config.test.d.ts +1 -0
  178. package/dist/test/unit/config.test.js +38 -0
  179. package/dist/test/unit/config.test.js.map +1 -0
  180. package/dist/test/unit/derivatives.test.d.ts +1 -0
  181. package/dist/test/unit/derivatives.test.js +41 -0
  182. package/dist/test/unit/derivatives.test.js.map +1 -0
  183. package/dist/test/unit/routes/dto.test.d.ts +1 -0
  184. package/dist/test/unit/routes/dto.test.js +34 -0
  185. package/dist/test/unit/routes/dto.test.js.map +1 -0
  186. package/dist/test/unit/transform.test.d.ts +1 -0
  187. package/dist/test/unit/transform.test.js +37 -0
  188. package/dist/test/unit/transform.test.js.map +1 -0
  189. package/dist/transform.d.ts +22 -0
  190. package/dist/transform.js +117 -0
  191. package/dist/transform.js.map +1 -0
  192. package/dist/types.d.ts +12 -0
  193. package/dist/types.js +3 -0
  194. package/dist/types.js.map +1 -0
  195. package/dist/validation/media.schema.d.ts +221 -0
  196. package/dist/validation/media.schema.js +94 -0
  197. package/dist/validation/media.schema.js.map +1 -0
  198. package/frontend-vue/.editorconfig +12 -0
  199. package/frontend-vue/.prettierrc +11 -0
  200. package/frontend-vue/app/components/AssetPicker.vue +272 -0
  201. package/frontend-vue/app/components/Library.vue +21 -0
  202. package/frontend-vue/app/components/PickerModal.vue +47 -0
  203. package/frontend-vue/app/components/StorageOverview.vue +105 -0
  204. package/frontend-vue/app/components/finder/Modal.vue +41 -0
  205. package/frontend-vue/app/components/finder/Root.vue +72 -0
  206. package/frontend-vue/app/components/finder/components/DeleteFolderConfirm.vue +55 -0
  207. package/frontend-vue/app/components/finder/components/EditImage.vue +157 -0
  208. package/frontend-vue/app/components/finder/components/Empty.vue +13 -0
  209. package/frontend-vue/app/components/finder/components/FilterMenu.vue +115 -0
  210. package/frontend-vue/app/components/finder/components/Preview.vue +35 -0
  211. package/frontend-vue/app/components/finder/components/search-file.vue +24 -0
  212. package/frontend-vue/app/components/finder/core/panel.vue +132 -0
  213. package/frontend-vue/app/components/finder/core/toolbar.vue +55 -0
  214. package/frontend-vue/app/components/finder/index.vue +87 -0
  215. package/frontend-vue/app/components/finder/layout/Footer.vue +97 -0
  216. package/frontend-vue/app/components/finder/layout/Header.vue +16 -0
  217. package/frontend-vue/app/components/finder/layout/navigation/Breadcrumbs.vue +114 -0
  218. package/frontend-vue/app/components/finder/layout/navigation/index.vue +40 -0
  219. package/frontend-vue/app/components/finder/layout/panel/Details.vue +192 -0
  220. package/frontend-vue/app/components/finder/layout/panel/Shortcuts.vue +265 -0
  221. package/frontend-vue/app/components/finder/layout/panel/Toogle.vue +27 -0
  222. package/frontend-vue/app/components/finder/layout/view/Column.vue +180 -0
  223. package/frontend-vue/app/components/finder/layout/view/Grid.vue +37 -0
  224. package/frontend-vue/app/components/finder/layout/view/List.vue +289 -0
  225. package/frontend-vue/app/components/finder/layout/view/Toggle.vue +27 -0
  226. package/frontend-vue/app/components/finder/layout/view/card/Column.vue +182 -0
  227. package/frontend-vue/app/components/finder/layout/view/card/Ghost.vue +46 -0
  228. package/frontend-vue/app/components/finder/layout/view/card/Grid.vue +219 -0
  229. package/frontend-vue/app/components/finder/layout/view/card/Input.vue +63 -0
  230. package/frontend-vue/app/components/finder/layout/view/card/List.vue +29 -0
  231. package/frontend-vue/app/components/finder/layout/view/index.vue +80 -0
  232. package/frontend-vue/app/components/picker/PickerColumnsView.vue +170 -0
  233. package/frontend-vue/app/components/picker/PickerDeleteConfirm.vue +62 -0
  234. package/frontend-vue/app/components/picker/PickerExplorer.vue +436 -0
  235. package/frontend-vue/app/components/picker/PickerGridView.vue +136 -0
  236. package/frontend-vue/app/components/picker/PickerItemThumb.vue +49 -0
  237. package/frontend-vue/app/components/picker/PickerLightbox.vue +158 -0
  238. package/frontend-vue/app/components/picker/PickerListView.vue +188 -0
  239. package/frontend-vue/app/components/picker/PickerMoveDialog.vue +115 -0
  240. package/frontend-vue/app/components/picker/PickerNameEdit.vue +50 -0
  241. package/frontend-vue/app/components/picker/PickerPreviewBody.vue +109 -0
  242. package/frontend-vue/app/components/picker/PickerPreviewPane.vue +21 -0
  243. package/frontend-vue/app/components/picker/PickerSidebar.vue +87 -0
  244. package/frontend-vue/app/components/picker/PickerToolbar.vue +142 -0
  245. package/frontend-vue/app/composables/finder/actions/useDeselectOnOutsideClick.ts +40 -0
  246. package/frontend-vue/app/composables/finder/actions/useDraggableItem.ts +102 -0
  247. package/frontend-vue/app/composables/finder/actions/useDropTarget.ts +81 -0
  248. package/frontend-vue/app/composables/finder/actions/useFileUpload.ts +45 -0
  249. package/frontend-vue/app/composables/finder/actions/useRowDragState.ts +47 -0
  250. package/frontend-vue/app/composables/finder/actions/useSelectionClick.ts +53 -0
  251. package/frontend-vue/app/composables/finder/api/useMediaApi.ts +135 -0
  252. package/frontend-vue/app/composables/finder/context/useFinderContext.ts +55 -0
  253. package/frontend-vue/app/composables/finder/context/useFinderDragAndDrop.ts +66 -0
  254. package/frontend-vue/app/composables/finder/context/useFinderHooks.ts +93 -0
  255. package/frontend-vue/app/composables/finder/context/useFinderLayout.ts +191 -0
  256. package/frontend-vue/app/composables/finder/context/useFinderNavigation.ts +36 -0
  257. package/frontend-vue/app/composables/finder/context/useFinderPicker.ts +22 -0
  258. package/frontend-vue/app/composables/finder/context/useFinderSelect.ts +72 -0
  259. package/frontend-vue/app/composables/finder/hooks/file.ts +86 -0
  260. package/frontend-vue/app/composables/finder/hooks/finder.ts +25 -0
  261. package/frontend-vue/app/composables/finder/hooks/folder.ts +66 -0
  262. package/frontend-vue/app/composables/finder/hooks/navigation.ts +64 -0
  263. package/frontend-vue/app/composables/finder/hooks/selection.ts +31 -0
  264. package/frontend-vue/app/composables/finder/menu/useContextMenu.ts +180 -0
  265. package/frontend-vue/app/composables/finder/menu/useFinderMenu.ts +41 -0
  266. package/frontend-vue/app/composables/finder/menu/useItemMenu.ts +114 -0
  267. package/frontend-vue/app/composables/finder/shortcuts/finderEscape.ts +9 -0
  268. package/frontend-vue/app/composables/finder/shortcuts/finderShiftA.ts +9 -0
  269. package/frontend-vue/app/composables/finder/sidebar/useFavoritesFolder.ts +110 -0
  270. package/frontend-vue/app/composables/finder/sidebar/useFolderSize.ts +49 -0
  271. package/frontend-vue/app/composables/finder/sidebar/useRecentFile.ts +20 -0
  272. package/frontend-vue/app/composables/finder/store/useFinderStore.ts +354 -0
  273. package/frontend-vue/app/composables/picker/usePickerExplorer.ts +788 -0
  274. package/frontend-vue/app/config/shortcuts-registry.ts +8 -0
  275. package/frontend-vue/app/types/finder.ts +47 -0
  276. package/frontend-vue/app/utils/finder/context.ts +25 -0
  277. package/frontend-vue/app/utils/finder/filegroup.ts +79 -0
  278. package/frontend-vue/app/utils/finder/filesize.ts +15 -0
  279. package/frontend-vue/app/utils/finder/formatter.ts +66 -0
  280. package/frontend-vue/app/utils/finder/helpers.ts +105 -0
  281. package/frontend-vue/app/utils/finder/mime.ts +108 -0
  282. package/frontend-vue/app/utils/finder/models.ts +153 -0
  283. package/frontend-vue/app/utils/finder/shortcuts.ts +29 -0
  284. package/frontend-vue/dms.frontend.ts +45 -0
  285. package/frontend-vue/eslint.config.mjs +16 -0
  286. package/frontend-vue/i18n/locales/media-en-GB.json +191 -0
  287. package/frontend-vue/i18n/locales/media-fr-FR.json +191 -0
  288. package/frontend-vue/package.json +35 -0
  289. package/frontend-vue/pnpm-lock.yaml +6074 -0
  290. package/frontend-vue/pnpm-workspace.yaml +2 -0
  291. package/frontend-vue/tests/registration.test.ts +36 -0
  292. package/frontend-vue/tsconfig.json +13 -0
  293. package/frontend-vue/vitest.config.ts +5 -0
  294. package/package.json +83 -0
  295. package/src/acl/defaults.ts +21 -0
  296. package/src/acl/entries.ts +19 -0
  297. package/src/acl/grantable.ts +11 -0
  298. package/src/acl/index.ts +4 -0
  299. package/src/acl/resolver.ts +159 -0
  300. package/src/asset-lifecycle.ts +100 -0
  301. package/src/asset-type/asset-type.ts +61 -0
  302. package/src/asset-type/bindings.ts +182 -0
  303. package/src/asset-type/index.ts +2 -0
  304. package/src/config.ts +38 -0
  305. package/src/constants.ts +8 -0
  306. package/src/crons/index.ts +8 -0
  307. package/src/crons/sweep-derivatives.ts +68 -0
  308. package/src/db/index.ts +2 -0
  309. package/src/db/models/index.ts +2 -0
  310. package/src/db/models/mediaAssets.model.ts +72 -0
  311. package/src/db/models/mediaFolders.model.ts +28 -0
  312. package/src/db/tables/index.ts +2 -0
  313. package/src/db/tables/mediaAssets.table.ts +83 -0
  314. package/src/db/tables/mediaFolders.table.ts +52 -0
  315. package/src/derivatives.ts +227 -0
  316. package/src/index.ts +52 -0
  317. package/src/pages/index.ts +1 -0
  318. package/src/pages/media.ts +39 -0
  319. package/src/permissions.ts +44 -0
  320. package/src/presets.ts +61 -0
  321. package/src/routes/index.ts +1 -0
  322. package/src/routes/media/assets.ts +278 -0
  323. package/src/routes/media/constants.ts +18 -0
  324. package/src/routes/media/context.ts +181 -0
  325. package/src/routes/media/delivery.ts +174 -0
  326. package/src/routes/media/dto.ts +116 -0
  327. package/src/routes/media/folders.ts +279 -0
  328. package/src/routes/media/index.ts +9 -0
  329. package/src/routes/media/storage-keys.ts +15 -0
  330. package/src/routes/media/transform.ts +96 -0
  331. package/src/routes/media/upload.ts +161 -0
  332. package/src/test/antelope.test.ts +211 -0
  333. package/src/test/helpers/assets.ts +95 -0
  334. package/src/test/helpers/http.ts +23 -0
  335. package/src/test/helpers/members.ts +78 -0
  336. package/src/test/helpers/owner.ts +37 -0
  337. package/src/test/integration/derivative-sweep-query.test.ts +65 -0
  338. package/src/test/integration/folder-query.test.ts +95 -0
  339. package/src/test/integration/media-api.test.ts +232 -0
  340. package/src/test/integration/media-bindings.test.ts +175 -0
  341. package/src/test/integration/media-cleanup.test.ts +320 -0
  342. package/src/test/integration/media-delivery.test.ts +136 -0
  343. package/src/test/integration/media-guards.test.ts +132 -0
  344. package/src/test/integration/media-list-query.test.ts +98 -0
  345. package/src/test/integration/media-permissions.test.ts +914 -0
  346. package/src/test/integration/media-search-query.test.ts +124 -0
  347. package/src/test/integration/media-transform.test.ts +181 -0
  348. package/src/test/integration/setup.test.ts +35 -0
  349. package/src/test/unit/acl/entries.test.ts +58 -0
  350. package/src/test/unit/acl/grantable.test.ts +54 -0
  351. package/src/test/unit/acl/resolver.test.ts +283 -0
  352. package/src/test/unit/asset-type/bindings.test.ts +141 -0
  353. package/src/test/unit/config.test.ts +44 -0
  354. package/src/test/unit/derivatives.test.ts +54 -0
  355. package/src/test/unit/routes/dto.test.ts +65 -0
  356. package/src/test/unit/transform.test.ts +51 -0
  357. package/src/transform.ts +183 -0
  358. package/src/types.ts +17 -0
  359. package/src/validation/media.schema.ts +117 -0
  360. package/tsconfig.json +29 -0
@@ -0,0 +1,183 @@
1
+ import { randomUUID } from "node:crypto";
2
+ import { DeleteFile } from "@antelopejs/interface-file-storage";
3
+ import sharp from "sharp";
4
+ import { cleanupAssetFiles, updateAssetMedia } from "./asset-lifecycle";
5
+ import type { MediaAsset, MediaAssetModel } from "./db";
6
+ import { downloadStorageBytes, uploadStorageBytes } from "./derivatives";
7
+
8
+ export interface CropRegion {
9
+ x: number;
10
+ y: number;
11
+ width: number;
12
+ height: number;
13
+ }
14
+
15
+ export interface ImageTransformOps {
16
+ crop?: CropRegion;
17
+ rotate?: number;
18
+ }
19
+
20
+ const TRANSFORMED_PATH_PREFIX = "media-transformed";
21
+ const MIN_CROP_PIXELS = 1;
22
+ const SINGLE_FRAME_PAGE_COUNT = 1;
23
+
24
+ export class AnimatedImageTransformError extends Error {}
25
+ class MediaAssetChangedError extends Error {}
26
+
27
+ export interface PixelDimensions {
28
+ width: number;
29
+ height: number;
30
+ }
31
+
32
+ function rotatedDimensions(
33
+ dimensions: PixelDimensions,
34
+ rotate: number,
35
+ ): PixelDimensions {
36
+ const swapsAxes = rotate % 180 !== 0;
37
+ return swapsAxes
38
+ ? { width: dimensions.height, height: dimensions.width }
39
+ : dimensions;
40
+ }
41
+
42
+ const EXIF_ORIENTATION_AXIS_SWAP_THRESHOLD = 5;
43
+
44
+ export function cropToPixels(
45
+ crop: CropRegion,
46
+ dimensions: PixelDimensions,
47
+ ): sharp.Region {
48
+ const left = Math.min(
49
+ Math.round(crop.x * dimensions.width),
50
+ dimensions.width - MIN_CROP_PIXELS,
51
+ );
52
+ const top = Math.min(
53
+ Math.round(crop.y * dimensions.height),
54
+ dimensions.height - MIN_CROP_PIXELS,
55
+ );
56
+ const width = Math.max(
57
+ MIN_CROP_PIXELS,
58
+ Math.min(
59
+ Math.round(crop.width * dimensions.width),
60
+ dimensions.width - left,
61
+ ),
62
+ );
63
+ const height = Math.max(
64
+ MIN_CROP_PIXELS,
65
+ Math.min(
66
+ Math.round(crop.height * dimensions.height),
67
+ dimensions.height - top,
68
+ ),
69
+ );
70
+ return { left, top, width, height };
71
+ }
72
+
73
+ function orientedDimensions(metadata: sharp.Metadata): PixelDimensions {
74
+ const width = metadata.width ?? MIN_CROP_PIXELS;
75
+ const height = metadata.height ?? MIN_CROP_PIXELS;
76
+ const swapsAxes =
77
+ metadata.orientation != null &&
78
+ metadata.orientation >= EXIF_ORIENTATION_AXIS_SWAP_THRESHOLD;
79
+ return swapsAxes ? { width: height, height: width } : { width, height };
80
+ }
81
+
82
+ function assertStaticSource(metadata: sharp.Metadata): void {
83
+ if ((metadata.pages ?? SINGLE_FRAME_PAGE_COUNT) <= SINGLE_FRAME_PAGE_COUNT) {
84
+ return;
85
+ }
86
+ throw new AnimatedImageTransformError(
87
+ "Animated images cannot be transformed",
88
+ );
89
+ }
90
+
91
+ async function renderTransform(
92
+ source: Buffer,
93
+ ops: ImageTransformOps,
94
+ ): Promise<Buffer> {
95
+ const metadata = await sharp(source).metadata();
96
+ assertStaticSource(metadata);
97
+ const sourceDimensions = orientedDimensions(metadata);
98
+ let pipeline = sharp(source).autoOrient();
99
+ if (ops.rotate) {
100
+ pipeline = pipeline.rotate(ops.rotate);
101
+ }
102
+ if (ops.crop) {
103
+ const dimensions = rotatedDimensions(sourceDimensions, ops.rotate ?? 0);
104
+ pipeline = pipeline.extract(cropToPixels(ops.crop, dimensions));
105
+ }
106
+ return pipeline.toBuffer();
107
+ }
108
+
109
+ export async function clearDerivatives(
110
+ assetModel: MediaAssetModel,
111
+ asset: MediaAsset,
112
+ ): Promise<void> {
113
+ for (;;) {
114
+ const fresh = await assetModel.get(asset._id);
115
+ if (!fresh || fresh.isDeleting) return;
116
+ if (await updateAssetMedia(assetModel, fresh, { json_derivatives: "" }))
117
+ break;
118
+ }
119
+ await cleanupAssetFiles(assetModel, asset._id);
120
+ }
121
+
122
+ async function commitTransform(
123
+ model: MediaAssetModel,
124
+ asset: MediaAsset,
125
+ patch: Partial<MediaAsset>,
126
+ ): Promise<void> {
127
+ for (;;) {
128
+ const fresh = await model.get(asset._id);
129
+ if (!fresh || fresh.isDeleting || fresh.storageKey !== asset.storageKey) {
130
+ throw new MediaAssetChangedError("Media asset changed during transform");
131
+ }
132
+ if (
133
+ await updateAssetMedia(model, fresh, { ...patch, json_derivatives: "" })
134
+ )
135
+ break;
136
+ }
137
+ await cleanupAssetFiles(model, asset._id);
138
+ }
139
+
140
+ export async function applyImageTransform(
141
+ assetModel: MediaAssetModel,
142
+ asset: MediaAsset,
143
+ ops: ImageTransformOps,
144
+ ): Promise<void> {
145
+ const source = await downloadStorageBytes(asset.storageKey, asset.storage);
146
+ const output = await renderTransform(source, ops);
147
+ const outputMetadata = await sharp(output).metadata();
148
+ const storageKey = await uploadStorageBytes(
149
+ output,
150
+ asset.name,
151
+ asset.mimetype,
152
+ `${TRANSFORMED_PATH_PREFIX}/${asset._id}/${randomUUID()}`,
153
+ asset.storage,
154
+ );
155
+ await commitTransform(assetModel, asset, {
156
+ storageKey,
157
+ originalKey: asset.originalKey || asset.storageKey,
158
+ width: outputMetadata.width,
159
+ height: outputMetadata.height,
160
+ size: output.byteLength,
161
+ }).catch(async (error: unknown) => {
162
+ if (error instanceof MediaAssetChangedError) {
163
+ await DeleteFile(storageKey, asset.storage).catch(() => undefined);
164
+ }
165
+ throw error;
166
+ });
167
+ }
168
+
169
+ export async function revertImageTransform(
170
+ assetModel: MediaAssetModel,
171
+ asset: MediaAsset,
172
+ ): Promise<void> {
173
+ if (!asset.originalKey) return;
174
+ const original = await downloadStorageBytes(asset.originalKey, asset.storage);
175
+ const metadata = await sharp(original).metadata();
176
+ await commitTransform(assetModel, asset, {
177
+ storageKey: asset.originalKey,
178
+ originalKey: "",
179
+ width: metadata.width,
180
+ height: metadata.height,
181
+ size: original.byteLength,
182
+ });
183
+ }
package/src/types.ts ADDED
@@ -0,0 +1,17 @@
1
+ export type AclRight = "read" | "write" | "manage";
2
+
3
+ export type AclSubjectKind = "permission" | "role";
4
+
5
+ export interface AclSubject {
6
+ kind: AclSubjectKind;
7
+ id: string;
8
+ }
9
+
10
+ export interface AclEntry {
11
+ subject: AclSubject;
12
+ rights: AclRight[];
13
+ }
14
+
15
+ export type FolderVisibility = "private" | "public";
16
+
17
+ export type AssetVisibility = "inherit" | "private" | "public";
@@ -0,0 +1,117 @@
1
+ import { z } from "zod";
2
+
3
+ const MAX_NAME_LENGTH = 255;
4
+ const MIN_PRINTABLE_CHAR_CODE = 32;
5
+ const FORBIDDEN_NAME_CHARS = new Set(["/", "\\"]);
6
+
7
+ function isSafeName(value: string): boolean {
8
+ return Array.from(value).every(
9
+ (char) =>
10
+ !FORBIDDEN_NAME_CHARS.has(char) &&
11
+ char.charCodeAt(0) >= MIN_PRINTABLE_CHAR_CODE,
12
+ );
13
+ }
14
+
15
+ const nameSchema = z
16
+ .string()
17
+ .trim()
18
+ .min(1)
19
+ .max(MAX_NAME_LENGTH)
20
+ .refine(isSafeName, {
21
+ message: "Name contains forbidden characters",
22
+ });
23
+
24
+ const aclRightSchema = z.enum(["read", "write", "manage"]);
25
+
26
+ const aclSubjectSchema = z.object({
27
+ kind: z.enum(["permission", "role"]),
28
+ id: z.string().min(1),
29
+ });
30
+
31
+ export const aclEntrySchema = z.object({
32
+ subject: aclSubjectSchema,
33
+ rights: z.array(aclRightSchema).min(1),
34
+ });
35
+
36
+ export const createFolderSchema = z.object({
37
+ name: nameSchema,
38
+ parentId: z.string().min(1).optional(),
39
+ });
40
+
41
+ export const renameFolderSchema = z.object({
42
+ name: nameSchema,
43
+ });
44
+
45
+ export const moveFolderSchema = z.object({
46
+ parentId: z.string().min(1).nullable(),
47
+ });
48
+
49
+ export const folderVisibilitySchema = z.object({
50
+ visibility: z.enum(["private", "public"]),
51
+ });
52
+
53
+ export const folderAclSchema = z.object({
54
+ entries: z.array(aclEntrySchema).nullable(),
55
+ });
56
+
57
+ const MAX_UPLOAD_SIZE_BYTES = 500 * 1024 * 1024;
58
+
59
+ export const presignSchema = z.object({
60
+ folderId: z.string().min(1),
61
+ filename: nameSchema,
62
+ size: z.number().int().positive().max(MAX_UPLOAD_SIZE_BYTES),
63
+ mimetype: z.string().min(1),
64
+ });
65
+
66
+ export const confirmUploadSchema = z.object({
67
+ folderId: z.string().min(1),
68
+ resourceKey: z.string().min(1),
69
+ filename: nameSchema,
70
+ });
71
+
72
+ export const updateAssetSchema = z.object({
73
+ name: nameSchema.optional(),
74
+ alt: z.string().max(MAX_NAME_LENGTH).optional(),
75
+ });
76
+
77
+ export const moveAssetSchema = z.object({
78
+ folderId: z.string().min(1),
79
+ });
80
+
81
+ export const assetVisibilitySchema = z.object({
82
+ visibility: z.enum(["inherit", "private", "public"]),
83
+ });
84
+
85
+ const MAX_PREVIEW_BATCH = 200;
86
+
87
+ export const previewIdsSchema = z.object({
88
+ ids: z.array(z.string().min(1)).max(MAX_PREVIEW_BATCH),
89
+ });
90
+
91
+ const normalizedRatio = z.number().min(0).max(1);
92
+ const ALLOWED_ROTATIONS = [90, 180, 270] as const;
93
+
94
+ const cropSchema = z
95
+ .object({
96
+ x: normalizedRatio,
97
+ y: normalizedRatio,
98
+ width: normalizedRatio.refine((value) => value > 0),
99
+ height: normalizedRatio.refine((value) => value > 0),
100
+ })
101
+ .refine((crop) => crop.x + crop.width <= 1 && crop.y + crop.height <= 1, {
102
+ message: "Crop region exceeds the image bounds",
103
+ });
104
+
105
+ export const transformSchema = z
106
+ .object({
107
+ crop: cropSchema.optional(),
108
+ rotate: z
109
+ .number()
110
+ .refine((value) =>
111
+ ALLOWED_ROTATIONS.includes(value as (typeof ALLOWED_ROTATIONS)[number]),
112
+ )
113
+ .optional(),
114
+ })
115
+ .refine((ops) => ops.crop !== undefined || ops.rotate !== undefined, {
116
+ message: "At least one transform operation is required",
117
+ });
package/tsconfig.json ADDED
@@ -0,0 +1,29 @@
1
+ {
2
+ "compilerOptions": {
3
+ "noEmit": true,
4
+ "moduleResolution": "bundler",
5
+ "target": "esnext",
6
+ "module": "preserve",
7
+ "lib": ["esnext", "dom"],
8
+ "allowJs": true,
9
+ "outDir": "dist",
10
+ "strict": true,
11
+ "noImplicitAny": true,
12
+ "esModuleInterop": true,
13
+ "resolveJsonModule": true,
14
+ "removeComments": true,
15
+ "preserveConstEnums": true,
16
+ "experimentalDecorators": true,
17
+ "emitDecoratorMetadata": true,
18
+ "declaration": true,
19
+ "sourceMap": true,
20
+ "useDefineForClassFields": true,
21
+ "noUnusedLocals": true,
22
+ "noUnusedParameters": true,
23
+ "paths": {
24
+ "@antelopejs/dms-media/*": ["./src/*"]
25
+ },
26
+ "rootDir": "src"
27
+ },
28
+ "include": ["./src/**/*.ts"]
29
+ }