@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,227 @@
1
+ import { randomUUID } from "node:crypto";
2
+ import {
3
+ CreateReadUrl,
4
+ CreateUploadUrl,
5
+ DeleteFile,
6
+ } from "@antelopejs/interface-file-storage";
7
+ import sharp from "sharp";
8
+ import { updateAssetMedia } from "./asset-lifecycle";
9
+ import { ORIGINAL_FILENAME_METADATA_KEY } from "./constants";
10
+ import type { MediaAsset, MediaAssetModel } from "./db";
11
+ import {
12
+ type MediaPresetConfig,
13
+ presetCacheKey,
14
+ presetMimetype,
15
+ RASTERIZED_SVG_FORMAT,
16
+ SVG_MIMETYPE,
17
+ } from "./presets";
18
+ import { parseDerivatives } from "./routes/media/storage-keys";
19
+
20
+ const DERIVATIVES_PATH_PREFIX = "media-derivatives";
21
+ const GENERATION_FAILURE_RETRY_MS = 60_000;
22
+
23
+ const generationLocks = new Map<string, Promise<string>>();
24
+ const generationFailures = new Map<string, number>();
25
+
26
+ export async function downloadStorageBytes(
27
+ storageKey: string,
28
+ storage: string | undefined,
29
+ ): Promise<Buffer> {
30
+ const readUrl = await CreateReadUrl(storageKey, undefined, storage);
31
+ const response = await fetch(readUrl.url);
32
+ if (!response.ok) {
33
+ throw new Error(`Failed to download ${storageKey}: ${response.status}`);
34
+ }
35
+ return Buffer.from(await response.arrayBuffer());
36
+ }
37
+
38
+ export async function uploadStorageBytes(
39
+ bytes: Buffer,
40
+ filename: string,
41
+ mimetype: string,
42
+ path: string,
43
+ storage: string | undefined,
44
+ ): Promise<string> {
45
+ const presigned = await CreateUploadUrl(
46
+ {
47
+ filename,
48
+ size: bytes.byteLength,
49
+ mimetype,
50
+ path,
51
+ metadata: { [ORIGINAL_FILENAME_METADATA_KEY]: filename },
52
+ },
53
+ undefined,
54
+ storage,
55
+ );
56
+ const response = await fetch(presigned.uploadUrl, {
57
+ method: "PUT",
58
+ headers: presigned.headers,
59
+ body: new Uint8Array(bytes),
60
+ });
61
+ if (!response.ok) {
62
+ throw new Error(`Failed to upload ${filename}: ${response.status}`);
63
+ }
64
+ return presigned.resourceKey;
65
+ }
66
+
67
+ export async function transformImage(
68
+ source: Buffer,
69
+ preset: MediaPresetConfig,
70
+ ): Promise<Buffer> {
71
+ let pipeline = sharp(source);
72
+ if (preset.width || preset.height) {
73
+ pipeline = pipeline.resize({
74
+ width: preset.width,
75
+ height: preset.height,
76
+ fit: preset.fit ?? "cover",
77
+ withoutEnlargement: true,
78
+ });
79
+ }
80
+ if (preset.format) {
81
+ pipeline = pipeline.toFormat(preset.format, {
82
+ quality: preset.quality,
83
+ });
84
+ }
85
+ return pipeline.toBuffer();
86
+ }
87
+
88
+ function derivativeExtension(
89
+ asset: MediaAsset,
90
+ preset: MediaPresetConfig,
91
+ ): string {
92
+ if (preset.format) return preset.format;
93
+ if (asset.mimetype === SVG_MIMETYPE) return RASTERIZED_SVG_FORMAT;
94
+ return asset.name.split(".").pop() ?? "bin";
95
+ }
96
+
97
+ function derivativeFilename(
98
+ asset: MediaAsset,
99
+ preset: MediaPresetConfig,
100
+ cacheKey: string,
101
+ ): string {
102
+ const baseName = asset.name.replace(/\.[^.]+$/, "");
103
+ return `${baseName}.${cacheKey}.${derivativeExtension(asset, preset)}`;
104
+ }
105
+
106
+ async function generateDerivative(
107
+ assetModel: MediaAssetModel,
108
+ asset: MediaAsset,
109
+ preset: MediaPresetConfig,
110
+ cacheKey: string,
111
+ ): Promise<string> {
112
+ const source = await downloadStorageBytes(asset.storageKey, asset.storage);
113
+ const output = await transformImage(source, preset);
114
+ const storageKey = await uploadStorageBytes(
115
+ output,
116
+ derivativeFilename(asset, preset, cacheKey),
117
+ presetMimetype(preset, asset.mimetype),
118
+ `${DERIVATIVES_PATH_PREFIX}/${asset._id}/${randomUUID()}`,
119
+ asset.storage,
120
+ );
121
+ const committed = await commitDerivative(
122
+ assetModel,
123
+ asset,
124
+ cacheKey,
125
+ storageKey,
126
+ );
127
+ if (committed !== undefined) return committed;
128
+ const fresh = await assetModel.get(asset._id);
129
+ if (!fresh || fresh.isDeleting) throw new Error("Media asset was deleted");
130
+ return generateDerivative(assetModel, fresh, preset, cacheKey);
131
+ }
132
+
133
+ /** Publishes a new immutable file only while its source asset is still current. */
134
+ export async function commitDerivative(
135
+ assetModel: MediaAssetModel,
136
+ asset: MediaAsset,
137
+ cacheKey: string,
138
+ storageKey: string,
139
+ ): Promise<string | undefined> {
140
+ for (;;) {
141
+ const fresh = await assetModel.get(asset._id);
142
+ if (!fresh || fresh.isDeleting || fresh.storageKey !== asset.storageKey) {
143
+ await DeleteFile(storageKey, asset.storage).catch(() => undefined);
144
+ return undefined;
145
+ }
146
+ const derivatives = parseDerivatives(fresh);
147
+ if (derivatives[cacheKey] === storageKey) return storageKey;
148
+ if (derivatives[cacheKey]) {
149
+ await DeleteFile(storageKey, asset.storage).catch(() => undefined);
150
+ return derivatives[cacheKey];
151
+ }
152
+ if (
153
+ await updateAssetMedia(assetModel, fresh, {
154
+ json_derivatives: JSON.stringify({
155
+ ...derivatives,
156
+ [cacheKey]: storageKey,
157
+ }),
158
+ })
159
+ )
160
+ return storageKey;
161
+ }
162
+ }
163
+
164
+ export interface DerivativePartition {
165
+ fresh: Record<string, string>;
166
+ stale: Record<string, string>;
167
+ }
168
+
169
+ export function partitionDerivatives(
170
+ derivatives: Record<string, string>,
171
+ presets: Iterable<MediaPresetConfig>,
172
+ ): DerivativePartition {
173
+ const validCacheKeys = new Set([...presets].map(presetCacheKey));
174
+ const fresh: Record<string, string> = {};
175
+ const stale: Record<string, string> = {};
176
+ for (const [cacheKey, storageKey] of Object.entries(derivatives)) {
177
+ if (validCacheKeys.has(cacheKey)) {
178
+ fresh[cacheKey] = storageKey;
179
+ } else {
180
+ stale[cacheKey] = storageKey;
181
+ }
182
+ }
183
+ return { fresh, stale };
184
+ }
185
+
186
+ function pruneExpiredGenerationFailures(now: number): void {
187
+ for (const [lockKey, failedAt] of generationFailures) {
188
+ if (now - failedAt >= GENERATION_FAILURE_RETRY_MS) {
189
+ generationFailures.delete(lockKey);
190
+ }
191
+ }
192
+ }
193
+
194
+ function assertNoRecentGenerationFailure(lockKey: string): void {
195
+ pruneExpiredGenerationFailures(Date.now());
196
+ if (!generationFailures.has(lockKey)) return;
197
+ throw new Error(`Derivative generation for ${lockKey} recently failed`);
198
+ }
199
+
200
+ export async function ensureDerivative(
201
+ assetModel: MediaAssetModel,
202
+ asset: MediaAsset,
203
+ preset: MediaPresetConfig,
204
+ ): Promise<string> {
205
+ const fresh = await assetModel.get(asset._id);
206
+ if (!fresh || fresh.isDeleting) throw new Error("Media asset was deleted");
207
+ asset = fresh;
208
+ const cacheKey = presetCacheKey(preset);
209
+ const existing = parseDerivatives(asset)[cacheKey];
210
+ if (existing) return existing;
211
+ const lockKey = `${asset._id}:${asset.storage ?? ""}:${asset.storageKey}:${cacheKey}`;
212
+ assertNoRecentGenerationFailure(lockKey);
213
+ const pending = generationLocks.get(lockKey);
214
+ if (pending) return pending;
215
+ const generation = generateDerivative(assetModel, asset, preset, cacheKey)
216
+ .then((storageKey) => {
217
+ generationFailures.delete(lockKey);
218
+ return storageKey;
219
+ })
220
+ .catch((error: unknown) => {
221
+ generationFailures.set(lockKey, Date.now());
222
+ throw error;
223
+ })
224
+ .finally(() => generationLocks.delete(lockKey));
225
+ generationLocks.set(lockKey, generation);
226
+ return generation;
227
+ }
package/src/index.ts ADDED
@@ -0,0 +1,52 @@
1
+ import path from "node:path";
2
+ import { AddFrontendModule } from "@antelopejs/interface-dms/page";
3
+ import { Logging } from "@antelopejs/interface-core/logging";
4
+ import "./db";
5
+ import "./permissions";
6
+ import type { ScheduledTask } from "node-cron";
7
+ import { type DmsMediaConfig, configureMediaModule } from "./config";
8
+ import { registerMediaCrons } from "./crons";
9
+
10
+ export * from "./acl";
11
+ export * from "./asset-type";
12
+ export * from "./config";
13
+ export * from "./constants";
14
+ export * from "./crons";
15
+ export * from "./db";
16
+ export * from "./derivatives";
17
+ export * from "./pages";
18
+ export * from "./presets";
19
+ export * from "./routes";
20
+ export * from "./transform";
21
+ export * from "./types";
22
+
23
+ let cronTasks: ScheduledTask[] = [];
24
+
25
+ export async function construct(config: DmsMediaConfig = {}): Promise<void> {
26
+ configureMediaModule(config);
27
+ const sourcePath = path.join(__dirname, "../frontend-vue");
28
+
29
+ await AddFrontendModule({
30
+ name: "@antelopejs/dms-media-frontend-vue",
31
+ sourcePath,
32
+ renderer: { name: "vue", version: "3" },
33
+ configKey: "dmsMedia",
34
+ priority: 0,
35
+ });
36
+ }
37
+
38
+ export function start(): void {
39
+ cronTasks = registerMediaCrons();
40
+ }
41
+
42
+ export async function stop(): Promise<void> {
43
+ const teardowns = await Promise.allSettled(
44
+ cronTasks.map(async (task) => task.destroy()),
45
+ );
46
+ for (const teardown of teardowns) {
47
+ if (teardown.status === "rejected") {
48
+ Logging.Error("A cron task failed to stop", teardown.reason);
49
+ }
50
+ }
51
+ cronTasks = [];
52
+ }
@@ -0,0 +1 @@
1
+ export * from "./media";
@@ -0,0 +1,39 @@
1
+ import {
2
+ Category,
3
+ PageController,
4
+ RegisterPage,
5
+ settingsCategory,
6
+ } from "@antelopejs/interface-dms/page";
7
+ import { DefaultLayout } from "@antelopejs/interface-dms/base";
8
+ import { CustomComponent } from "@antelopejs/interface-dms/base/custom";
9
+ import { MEDIA_ACCESS_PERMISSION } from "../constants";
10
+
11
+ const MEDIA_LIBRARY_COMPONENT = "dms-media-library";
12
+
13
+ // Media section of the settings area, mirroring the built-in "User settings"
14
+ // group. `authOnly` keeps the section itself grant-free: pages inside carry
15
+ // the real permissions, and the settings index only shows the group when at
16
+ // least one page in it is accessible.
17
+ export const mediaSettingsCategory = Category("media", {
18
+ category: settingsCategory,
19
+ displayName: "Media",
20
+ icon: "i-ph-images",
21
+ order: 2,
22
+ authOnly: true,
23
+ });
24
+
25
+ // Single entry point to the media library, gated by the media permission.
26
+ @RegisterPage()
27
+ export class SettingsAssetsPage extends PageController(
28
+ "assets",
29
+ {
30
+ displayName: "Assets",
31
+ icon: "i-ph-images",
32
+ category: mediaSettingsCategory,
33
+ description: "Browse and manage the media library",
34
+ permission: { id: MEDIA_ACCESS_PERMISSION },
35
+ },
36
+ DefaultLayout({ fullWidth: true }),
37
+ ) {
38
+ static content = CustomComponent(MEDIA_LIBRARY_COMPONENT);
39
+ }
@@ -0,0 +1,44 @@
1
+ import {
2
+ type Permission,
3
+ RegisterPermission,
4
+ } from "@antelopejs/interface-dms/permissions";
5
+ import {
6
+ MEDIA_ACCESS_PERMISSION,
7
+ MEDIA_FOLDERS_MANAGE_PERMISSION,
8
+ MEDIA_PERMISSIONS_MANAGE_PERMISSION,
9
+ MEDIA_UPLOAD_PERMISSION,
10
+ } from "./constants";
11
+
12
+ const MEDIA_PERMISSIONS: Permission[] = [
13
+ {
14
+ id: MEDIA_ACCESS_PERMISSION,
15
+ title: "Access media library",
16
+ icon: "i-ph-images",
17
+ description: "See the media library and browse readable folders",
18
+ },
19
+ {
20
+ id: MEDIA_UPLOAD_PERMISSION,
21
+ title: "Upload media",
22
+ icon: "i-ph-upload-simple",
23
+ description: "Upload files into writable folders",
24
+ dependencies: [MEDIA_ACCESS_PERMISSION],
25
+ },
26
+ {
27
+ id: MEDIA_FOLDERS_MANAGE_PERMISSION,
28
+ title: "Manage media folders",
29
+ icon: "i-ph-folder-plus",
30
+ description: "Create, rename, move and delete media folders",
31
+ dependencies: [MEDIA_ACCESS_PERMISSION],
32
+ },
33
+ {
34
+ id: MEDIA_PERMISSIONS_MANAGE_PERMISSION,
35
+ title: "Manage media permissions",
36
+ icon: "i-ph-lock-key",
37
+ description: "Edit folder access rules of the media library",
38
+ dependencies: [MEDIA_ACCESS_PERMISSION],
39
+ },
40
+ ];
41
+
42
+ for (const permission of MEDIA_PERMISSIONS) {
43
+ RegisterPermission(permission.id, permission);
44
+ }
package/src/presets.ts ADDED
@@ -0,0 +1,61 @@
1
+ import { createHash } from "node:crypto";
2
+
3
+ export type PresetFit = "cover" | "contain" | "inside";
4
+
5
+ export type PresetFormat = "webp" | "jpeg" | "png" | "avif";
6
+
7
+ export interface MediaPresetConfig {
8
+ id: string;
9
+ width?: number;
10
+ height?: number;
11
+ fit?: PresetFit;
12
+ format?: PresetFormat;
13
+ quality?: number;
14
+ }
15
+
16
+ const CACHE_KEY_HASH_LENGTH = 8;
17
+
18
+ export const SVG_MIMETYPE = "image/svg+xml";
19
+ export const RASTERIZED_SVG_FORMAT: PresetFormat = "png";
20
+
21
+ export const DEFAULT_PRESETS: MediaPresetConfig[] = [
22
+ {
23
+ id: "thumb",
24
+ width: 300,
25
+ height: 300,
26
+ fit: "cover",
27
+ format: "webp",
28
+ quality: 80,
29
+ },
30
+ {
31
+ id: "preview",
32
+ width: 1600,
33
+ fit: "inside",
34
+ format: "webp",
35
+ quality: 82,
36
+ },
37
+ ];
38
+
39
+ export function presetCacheKey(preset: MediaPresetConfig): string {
40
+ const signature = JSON.stringify({
41
+ width: preset.width,
42
+ height: preset.height,
43
+ fit: preset.fit,
44
+ format: preset.format,
45
+ quality: preset.quality,
46
+ });
47
+ const hash = createHash("sha1")
48
+ .update(signature)
49
+ .digest("hex")
50
+ .slice(0, CACHE_KEY_HASH_LENGTH);
51
+ return `${preset.id}.${hash}`;
52
+ }
53
+
54
+ export function presetMimetype(
55
+ preset: MediaPresetConfig,
56
+ sourceMimetype: string,
57
+ ): string {
58
+ if (preset.format) return `image/${preset.format}`;
59
+ if (sourceMimetype === SVG_MIMETYPE) return `image/${RASTERIZED_SVG_FORMAT}`;
60
+ return sourceMimetype;
61
+ }
@@ -0,0 +1 @@
1
+ export * from "./media";