@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,182 @@
1
+ import { createHash } from "node:crypto";
2
+ import type { ControllerClass } from "@antelopejs/interface-api";
3
+ import { GetPermissionId } from "@antelopejs/interface-dms/page";
4
+ import { serializeAcl } from "../acl";
5
+ import {
6
+ MEDIA_FOLDERS_MANAGE_PERMISSION,
7
+ MEDIA_PERMISSIONS_MANAGE_PERMISSION,
8
+ } from "../constants";
9
+ import type { MediaFolder, MediaFolderModel } from "../db";
10
+ import type { AclEntry } from "../types";
11
+
12
+ export interface AssetPermissionMapping {
13
+ read?: string[];
14
+ write?: string[];
15
+ }
16
+
17
+ export interface AssetBindingConfig {
18
+ id: string;
19
+ folderName?: string;
20
+ permissionMapping?: AssetPermissionMapping;
21
+ /**
22
+ * Page controller whose effective permission becomes the default read and
23
+ * write mapping of the linked folder. Resolved lazily at provisioning time,
24
+ * so the binding can reference the page class it is declared in. Explicit
25
+ * `permissionMapping` entries take precedence per right: an explicit empty
26
+ * array opts that right out of the page-derived fallback entirely.
27
+ */
28
+ permissionsFromPage?: ControllerClass;
29
+ acl?: AclEntry[];
30
+ }
31
+
32
+ export const CONTENT_ROOT_BINDING = "dms-media.content-root";
33
+ const CONTENT_ROOT_NAME = "Content";
34
+ const EMPTY_ACL = "[]";
35
+
36
+ const registeredBindings = new Map<string, AssetBindingConfig>();
37
+ const provisionedTenants = new Map<string, string>();
38
+ const provisioningLocks = new Map<string, Promise<void>>();
39
+
40
+ export function RegisterAssetBinding(config: AssetBindingConfig): void {
41
+ registeredBindings.set(config.id, config);
42
+ provisionedTenants.clear();
43
+ }
44
+
45
+ export function getRegisteredBindings(): AssetBindingConfig[] {
46
+ return [...registeredBindings.values()];
47
+ }
48
+
49
+ interface BindingFingerprintEntry {
50
+ id: string;
51
+ folderName?: string;
52
+ acl: AclEntry[];
53
+ }
54
+
55
+ function registryFingerprint(): string {
56
+ const entries: BindingFingerprintEntry[] = getRegisteredBindings()
57
+ .sort((a, b) => a.id.localeCompare(b.id))
58
+ .map((config) => ({
59
+ id: config.id,
60
+ folderName: config.folderName,
61
+ acl: buildBindingAcl(config),
62
+ }));
63
+ return createHash("sha1").update(JSON.stringify(entries)).digest("hex");
64
+ }
65
+
66
+ function permissionEntries(
67
+ permissionIds: string[] | undefined,
68
+ rights: AclEntry["rights"],
69
+ ): AclEntry[] {
70
+ return (permissionIds ?? []).map((id) => ({
71
+ subject: { kind: "permission" as const, id },
72
+ rights,
73
+ }));
74
+ }
75
+
76
+ function pagePermissionIds(config: AssetBindingConfig): string[] | undefined {
77
+ if (!config.permissionsFromPage) return undefined;
78
+ const permissionId = GetPermissionId(config.permissionsFromPage);
79
+ return permissionId ? [permissionId] : undefined;
80
+ }
81
+
82
+ export function buildBindingAcl(config: AssetBindingConfig): AclEntry[] {
83
+ if (config.acl) return config.acl;
84
+ const pagePermissions = pagePermissionIds(config);
85
+ return [
86
+ ...permissionEntries(config.permissionMapping?.read ?? pagePermissions, [
87
+ "read",
88
+ ]),
89
+ ...permissionEntries(config.permissionMapping?.write ?? pagePermissions, [
90
+ "write",
91
+ ]),
92
+ ...permissionEntries(
93
+ [MEDIA_FOLDERS_MANAGE_PERMISSION, MEDIA_PERMISSIONS_MANAGE_PERMISSION],
94
+ ["manage"],
95
+ ),
96
+ ];
97
+ }
98
+
99
+ async function ensureContentRoot(
100
+ folderModel: MediaFolderModel,
101
+ foldersByBinding: Map<string, MediaFolder>,
102
+ ): Promise<string> {
103
+ const existing = foldersByBinding.get(CONTENT_ROOT_BINDING);
104
+ if (existing) return existing._id;
105
+ const [id] = await folderModel.insert({
106
+ name: CONTENT_ROOT_NAME,
107
+ path: [],
108
+ binding: CONTENT_ROOT_BINDING,
109
+ json_acl: EMPTY_ACL,
110
+ visibility: "private",
111
+ });
112
+ return id;
113
+ }
114
+
115
+ async function ensureBindingFolder(
116
+ folderModel: MediaFolderModel,
117
+ foldersByBinding: Map<string, MediaFolder>,
118
+ contentRootId: string,
119
+ config: AssetBindingConfig,
120
+ ): Promise<void> {
121
+ const acl = serializeAcl(buildBindingAcl(config)) ?? EMPTY_ACL;
122
+ const existing = foldersByBinding.get(config.id);
123
+ if (existing) {
124
+ if (existing.json_acl !== acl) {
125
+ await folderModel.update(existing._id, { json_acl: acl });
126
+ }
127
+ return;
128
+ }
129
+ await folderModel.insert({
130
+ name: config.folderName ?? config.id,
131
+ parentId: contentRootId,
132
+ path: [contentRootId],
133
+ binding: config.id,
134
+ json_acl: acl,
135
+ visibility: "private",
136
+ });
137
+ }
138
+
139
+ async function provisionTenant(
140
+ tenantId: string,
141
+ folderModel: MediaFolderModel,
142
+ fingerprint: string,
143
+ ): Promise<void> {
144
+ if (registeredBindings.size > 0) {
145
+ const folders = await folderModel.getAll();
146
+ const foldersByBinding = new Map(
147
+ folders
148
+ .filter((folder) => folder.binding)
149
+ .map((folder) => [folder.binding as string, folder]),
150
+ );
151
+ const contentRootId = await ensureContentRoot(
152
+ folderModel,
153
+ foldersByBinding,
154
+ );
155
+ for (const config of registeredBindings.values()) {
156
+ await ensureBindingFolder(
157
+ folderModel,
158
+ foldersByBinding,
159
+ contentRootId,
160
+ config,
161
+ );
162
+ }
163
+ }
164
+ provisionedTenants.set(tenantId, fingerprint);
165
+ }
166
+
167
+ export async function ensureTenantBindings(
168
+ tenantId: string,
169
+ folderModel: MediaFolderModel,
170
+ ): Promise<void> {
171
+ const fingerprint = registryFingerprint();
172
+ if (provisionedTenants.get(tenantId) === fingerprint) return;
173
+ const pending = provisioningLocks.get(tenantId);
174
+ if (pending) return pending;
175
+ const provisioning = provisionTenant(
176
+ tenantId,
177
+ folderModel,
178
+ fingerprint,
179
+ ).finally(() => provisioningLocks.delete(tenantId));
180
+ provisioningLocks.set(tenantId, provisioning);
181
+ return provisioning;
182
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./asset-type";
2
+ export * from "./bindings";
package/src/config.ts ADDED
@@ -0,0 +1,38 @@
1
+ import { DEFAULT_ROOT_ACL } from "./acl/defaults";
2
+ import { DEFAULT_PRESETS, type MediaPresetConfig } from "./presets";
3
+ import type { AclEntry } from "./types";
4
+
5
+ export interface DmsMediaConfig {
6
+ rootAcl?: AclEntry[];
7
+ storage?: string;
8
+ presets?: MediaPresetConfig[];
9
+ }
10
+
11
+ interface ResolvedMediaConfig {
12
+ rootAcl: AclEntry[];
13
+ storage?: string;
14
+ presets: Map<string, MediaPresetConfig>;
15
+ }
16
+
17
+ function buildPresetMap(
18
+ presets: MediaPresetConfig[],
19
+ ): Map<string, MediaPresetConfig> {
20
+ return new Map(presets.map((preset) => [preset.id, preset]));
21
+ }
22
+
23
+ let currentConfig: ResolvedMediaConfig = {
24
+ rootAcl: DEFAULT_ROOT_ACL,
25
+ presets: buildPresetMap(DEFAULT_PRESETS),
26
+ };
27
+
28
+ export function configureMediaModule(config: DmsMediaConfig): void {
29
+ currentConfig = {
30
+ rootAcl: config.rootAcl ?? DEFAULT_ROOT_ACL,
31
+ storage: config.storage,
32
+ presets: buildPresetMap(config.presets ?? DEFAULT_PRESETS),
33
+ };
34
+ }
35
+
36
+ export function getMediaConfig(): ResolvedMediaConfig {
37
+ return currentConfig;
38
+ }
@@ -0,0 +1,8 @@
1
+ export const MEDIA_ACCESS_PERMISSION = "media.access";
2
+ export const MEDIA_UPLOAD_PERMISSION = "media.upload";
3
+ export const MEDIA_FOLDERS_MANAGE_PERMISSION = "media.folders.manage";
4
+ export const MEDIA_PERMISSIONS_MANAGE_PERMISSION = "media.permissions.manage";
5
+
6
+ export const OWNER_WILDCARD_PERMISSION = "*";
7
+
8
+ export const ORIGINAL_FILENAME_METADATA_KEY = "original-filename";
@@ -0,0 +1,8 @@
1
+ import type { ScheduledTask } from "node-cron";
2
+ import { scheduleSweepStaleDerivatives } from "./sweep-derivatives";
3
+
4
+ export * from "./sweep-derivatives";
5
+
6
+ export function registerMediaCrons(): ScheduledTask[] {
7
+ return [scheduleSweepStaleDerivatives()];
8
+ }
@@ -0,0 +1,68 @@
1
+ import { Logging } from "@antelopejs/interface-core/logging";
2
+ import { GetModel } from "@antelopejs/interface-database-decorators";
3
+ import { TenantModel } from "@antelopejs/interface-dms/db";
4
+ import cron, { type ScheduledTask } from "node-cron";
5
+ import { cleanupAssetFiles, updateAssetMedia } from "../asset-lifecycle";
6
+ import { getMediaConfig } from "../config";
7
+ import { type MediaAsset, MediaAssetModel } from "../db";
8
+ import { partitionDerivatives } from "../derivatives";
9
+ import { parseDerivatives } from "../routes/media/storage-keys";
10
+
11
+ export const SWEEP_DERIVATIVES_CRON_NAME = "dms-media-sweep-derivatives";
12
+
13
+ const SWEEP_DERIVATIVES_SCHEDULE = "0 4 * * *";
14
+
15
+ /** Rechecks one asset before detaching obsolete derivatives and replaying cleanup. */
16
+ export async function sweepAssetDerivatives(
17
+ assetModel: MediaAssetModel,
18
+ asset: MediaAsset,
19
+ ): Promise<number> {
20
+ for (;;) {
21
+ const current = await assetModel.get(asset._id);
22
+ if (!current || current.isDeleting) break;
23
+ const { fresh, stale } = partitionDerivatives(
24
+ parseDerivatives(current),
25
+ getMediaConfig().presets.values(),
26
+ );
27
+ if (Object.keys(stale).length === 0) break;
28
+ if (
29
+ await updateAssetMedia(assetModel, current, {
30
+ json_derivatives: Object.keys(fresh).length
31
+ ? JSON.stringify(fresh)
32
+ : "",
33
+ })
34
+ )
35
+ break;
36
+ }
37
+ return cleanupAssetFiles(assetModel, asset._id);
38
+ }
39
+
40
+ async function sweepTenantDerivatives(tenantId: string): Promise<number> {
41
+ const assetModel = GetModel(MediaAssetModel, tenantId);
42
+ let removed = 0;
43
+ for await (const asset of assetModel.table) {
44
+ removed += await sweepAssetDerivatives(assetModel, asset);
45
+ }
46
+ return removed;
47
+ }
48
+
49
+ export async function runSweepStaleDerivatives(): Promise<void> {
50
+ const tenants = GetModel(TenantModel).table;
51
+ let removed = 0;
52
+ let tenantCount = 0;
53
+ for await (const tenant of tenants) {
54
+ tenantCount++;
55
+ removed += await sweepTenantDerivatives(tenant._id);
56
+ }
57
+ Logging.Info(
58
+ `Sweep media derivatives: completed ${removed} file cleanup(s) across ${tenantCount} tenant(s).`,
59
+ );
60
+ }
61
+
62
+ export function scheduleSweepStaleDerivatives(): ScheduledTask {
63
+ return cron.schedule(SWEEP_DERIVATIVES_SCHEDULE, () => {
64
+ void runSweepStaleDerivatives().catch((error: unknown) => {
65
+ Logging.Error(`Cron '${SWEEP_DERIVATIVES_CRON_NAME}' failed:`, error);
66
+ });
67
+ });
68
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./models";
2
+ export * from "./tables";
@@ -0,0 +1,2 @@
1
+ export * from "./mediaAssets.model";
2
+ export * from "./mediaFolders.model";
@@ -0,0 +1,72 @@
1
+ import { randomUUID } from "node:crypto";
2
+ import type { AtomicMutationOutcome } from "@antelopejs/interface-database";
3
+ import { BasicDataModel } from "@antelopejs/interface-database-decorators";
4
+ import { triggerEvent } from "@antelopejs/interface-database-decorators/modifiers/common";
5
+ import { MEDIA_ASSETS_TABLE_NAME, MediaAsset } from "../tables";
6
+
7
+ function mutationApplied(outcome: AtomicMutationOutcome): boolean {
8
+ if (outcome === "unknown")
9
+ throw new Error("Media mutation acknowledgement is unknown");
10
+ return outcome === "applied";
11
+ }
12
+
13
+ export class MediaAssetModel extends BasicDataModel(
14
+ MediaAsset,
15
+ MEDIA_ASSETS_TABLE_NAME,
16
+ ) {
17
+ /** Applies a media transition only to the observed revision, with update modifiers. */
18
+ async compareMedia(
19
+ expected: MediaAsset,
20
+ patch: Partial<MediaAsset>,
21
+ ): Promise<boolean> {
22
+ const instance = MediaAssetModel.fromPlainData(patch);
23
+ triggerEvent(instance, "update");
24
+ const payload = MediaAssetModel.toDatabase(instance);
25
+ const outcome = await this.table
26
+ .atomicMutation(expected._id, {
27
+ type: "update",
28
+ revisionField: "mediaRevision",
29
+ expectedRevision: expected.mediaRevision,
30
+ nextRevision: randomUUID(),
31
+ patch: payload,
32
+ })
33
+ .run();
34
+ return mutationApplied(outcome);
35
+ }
36
+
37
+ /** Removes only the observed terminal tombstone after its file queue is drained. */
38
+ async deleteCleanedAsset(expected: MediaAsset): Promise<boolean> {
39
+ if (!expected.isDeleting || expected.json_retiredFiles !== "[]")
40
+ return false;
41
+ const outcome = await this.table
42
+ .atomicMutation(expected._id, {
43
+ type: "delete",
44
+ revisionField: "mediaRevision",
45
+ expectedRevision: expected.mediaRevision,
46
+ })
47
+ .run();
48
+ return mutationApplied(outcome);
49
+ }
50
+
51
+ /** Returns a bounded prefix of assets belonging to the selected folders. */
52
+ async listByFolders(
53
+ folderIds: string[],
54
+ limit: number,
55
+ ): Promise<MediaAsset[]> {
56
+ if (folderIds.length === 0) return [];
57
+ const rows = await this.table
58
+ .getAll(folderIds.length === 1 ? folderIds[0] : folderIds, "folderId")
59
+ .filter((row) => row.key("isDeleting").default(false).eq(false))
60
+ .slice(0, limit)
61
+ .run();
62
+ return rows
63
+ .map((row) => MediaAssetModel.fromDatabase(row))
64
+ .filter((row): row is MediaAsset => row !== undefined);
65
+ }
66
+
67
+ async getByFolder(folderId: string): Promise<MediaAsset[]> {
68
+ return (await this.getBy("folderId", folderId)).filter(
69
+ (asset) => !asset.isDeleting,
70
+ );
71
+ }
72
+ }
@@ -0,0 +1,28 @@
1
+ import { BasicDataModel } from "@antelopejs/interface-database-decorators";
2
+ import { MEDIA_FOLDERS_TABLE_NAME, MediaFolder } from "../tables";
3
+
4
+ export class MediaFolderModel extends BasicDataModel(
5
+ MediaFolder,
6
+ MEDIA_FOLDERS_TABLE_NAME,
7
+ ) {
8
+ async getChildren(parentId: string): Promise<MediaFolder[]> {
9
+ return this.getBy("parentId", parentId);
10
+ }
11
+
12
+ async getByBinding(binding: string): Promise<MediaFolder | undefined> {
13
+ const folders = await this.table
14
+ .getAll(binding, "binding")
15
+ .slice(0, 1)
16
+ .run();
17
+ return MediaFolderModel.fromDatabase(folders[0]);
18
+ }
19
+
20
+ async getDescendants(folderId: string): Promise<MediaFolder[]> {
21
+ const folders = await this.table
22
+ .filter((folder) => folder.key("path").includes(folderId))
23
+ .run();
24
+ return folders
25
+ .map((folder) => MediaFolderModel.fromDatabase(folder))
26
+ .filter((folder): folder is MediaFolder => folder !== undefined);
27
+ }
28
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./mediaAssets.table";
2
+ export * from "./mediaFolders.table";
@@ -0,0 +1,83 @@
1
+ import {
2
+ CreationTime,
3
+ Field,
4
+ Index,
5
+ RegisterTable,
6
+ Table,
7
+ UpdateTime,
8
+ } from "@antelopejs/interface-database-decorators";
9
+ import { TENANT_SCHEMA_NAME } from "@antelopejs/interface-dms/constants";
10
+ import type { AssetVisibility } from "../../types";
11
+
12
+ export const MEDIA_ASSETS_TABLE_NAME = "media_assets";
13
+
14
+ @RegisterTable(MEDIA_ASSETS_TABLE_NAME, TENANT_SCHEMA_NAME)
15
+ export class MediaAsset extends Table {
16
+ @Field("string")
17
+ declare _id: string;
18
+
19
+ @Index()
20
+ @CreationTime()
21
+ @Field("date")
22
+ declare createdAt: Date;
23
+
24
+ @Index()
25
+ @UpdateTime()
26
+ @Field("date")
27
+ declare updatedAt: Date;
28
+
29
+ @Index()
30
+ @Field("string")
31
+ declare folderId: string;
32
+
33
+ @Index()
34
+ @Field("string")
35
+ declare name: string;
36
+
37
+ @Field("string")
38
+ declare mimetype: string;
39
+
40
+ @Field("number")
41
+ declare size: number;
42
+
43
+ @Field("string")
44
+ declare storageKey: string;
45
+
46
+ /** Named storage of interface-file-storage; absent means the default storage. */
47
+ @Field("string")
48
+ declare storage?: string;
49
+
50
+ @Field("number")
51
+ declare width?: number;
52
+
53
+ @Field("number")
54
+ declare height?: number;
55
+
56
+ @Field("string")
57
+ declare alt?: string;
58
+
59
+ @Field("string")
60
+ declare visibility: AssetVisibility;
61
+
62
+ /** JSON-serialized Record<presetCacheKey, storageKey> of generated derivatives. */
63
+ @Field("string")
64
+ declare json_derivatives?: string;
65
+
66
+ @Field("string")
67
+ declare mediaRevision: string;
68
+
69
+ /** JSON-serialized string[] of storage keys waiting for deletion. */
70
+ @Field("string")
71
+ declare json_retiredFiles: string;
72
+
73
+ @Field("boolean")
74
+ declare isDeleting?: boolean;
75
+
76
+ /** Pre-edit storage key kept to allow reverting a destructive transform. */
77
+ @Field("string")
78
+ declare originalKey?: string;
79
+
80
+ @Index()
81
+ @Field("string")
82
+ declare createdBy: string;
83
+ }
@@ -0,0 +1,52 @@
1
+ import {
2
+ CreationTime,
3
+ Field,
4
+ Index,
5
+ RegisterTable,
6
+ Table,
7
+ UpdateTime,
8
+ } from "@antelopejs/interface-database-decorators";
9
+ import { TENANT_SCHEMA_NAME } from "@antelopejs/interface-dms/constants";
10
+ import type { FolderVisibility } from "../../types";
11
+
12
+ export const MEDIA_FOLDERS_TABLE_NAME = "media_folders";
13
+
14
+ @RegisterTable(MEDIA_FOLDERS_TABLE_NAME, TENANT_SCHEMA_NAME)
15
+ export class MediaFolder extends Table {
16
+ @Field("string")
17
+ declare _id: string;
18
+
19
+ @Index()
20
+ @CreationTime()
21
+ @Field("date")
22
+ declare createdAt: Date;
23
+
24
+ @Index()
25
+ @UpdateTime()
26
+ @Field("date")
27
+ declare updatedAt: Date;
28
+
29
+ @Index()
30
+ @Field("string")
31
+ declare name: string;
32
+
33
+ @Index()
34
+ @Field("string")
35
+ declare parentId?: string;
36
+
37
+ /** Materialized ids of every ancestor, root first. */
38
+ @Field(["string"])
39
+ declare path: string[];
40
+
41
+ /** JSON-serialized AclEntry[]; absent means the folder inherits its parent ACL. */
42
+ @Field("string")
43
+ declare json_acl?: string;
44
+
45
+ /** Consumer id owning this linked folder; also the provisioning idempotency key. */
46
+ @Index()
47
+ @Field("string")
48
+ declare binding?: string;
49
+
50
+ @Field("string")
51
+ declare visibility: FolderVisibility;
52
+ }