@antelopejs/dms-media 0.4.1 → 0.5.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 (123) hide show
  1. package/README.md +4 -3
  2. package/dist/bindings.d.ts +4 -1
  3. package/dist/bindings.js +21 -0
  4. package/dist/bindings.js.map +1 -1
  5. package/dist/db/models/index.d.ts +1 -0
  6. package/dist/db/models/index.js +1 -0
  7. package/dist/db/models/index.js.map +1 -1
  8. package/dist/db/models/mediaAssets.model.d.ts +1 -0
  9. package/dist/db/models/mediaAssets.model.js +19 -0
  10. package/dist/db/models/mediaAssets.model.js.map +1 -1
  11. package/dist/db/models/mediaDeclarations.model.d.ts +24 -0
  12. package/dist/db/models/mediaDeclarations.model.js +13 -0
  13. package/dist/db/models/mediaDeclarations.model.js.map +1 -0
  14. package/dist/db/models/mediaFolders.model.d.ts +3 -0
  15. package/dist/db/models/mediaFolders.model.js +29 -0
  16. package/dist/db/models/mediaFolders.model.js.map +1 -1
  17. package/dist/db/tables/index.d.ts +1 -0
  18. package/dist/db/tables/index.js +1 -0
  19. package/dist/db/tables/index.js.map +1 -1
  20. package/dist/db/tables/mediaDeclarations.table.d.ts +15 -0
  21. package/dist/db/tables/mediaDeclarations.table.js +65 -0
  22. package/dist/db/tables/mediaDeclarations.table.js.map +1 -0
  23. package/dist/declared/assets.d.ts +4 -0
  24. package/dist/declared/assets.js +269 -0
  25. package/dist/declared/assets.js.map +1 -0
  26. package/dist/declared/folders.d.ts +10 -0
  27. package/dist/declared/folders.js +154 -0
  28. package/dist/declared/folders.js.map +1 -0
  29. package/dist/declared/index.d.ts +5 -0
  30. package/dist/declared/index.js +22 -0
  31. package/dist/declared/index.js.map +1 -0
  32. package/dist/declared/readiness.d.ts +2 -0
  33. package/dist/declared/readiness.js +52 -0
  34. package/dist/declared/readiness.js.map +1 -0
  35. package/dist/declared/records.d.ts +46 -0
  36. package/dist/declared/records.js +94 -0
  37. package/dist/declared/records.js.map +1 -0
  38. package/dist/declared/retire.d.ts +3 -0
  39. package/dist/declared/retire.js +118 -0
  40. package/dist/declared/retire.js.map +1 -0
  41. package/dist/implementations/interface-dms-media/index.d.ts +5 -0
  42. package/dist/implementations/interface-dms-media/index.js +5 -0
  43. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  44. package/dist/library/events.d.ts +2 -1
  45. package/dist/library/events.js.map +1 -1
  46. package/dist/routes/media/assets.js +19 -4
  47. package/dist/routes/media/assets.js.map +1 -1
  48. package/dist/routes/media/context.d.ts +1 -1
  49. package/dist/routes/media/context.js.map +1 -1
  50. package/dist/routes/media/dto.d.ts +1 -0
  51. package/dist/routes/media/dto.js +3 -1
  52. package/dist/routes/media/dto.js.map +1 -1
  53. package/dist/routes/media/folders.d.ts +6 -0
  54. package/dist/routes/media/folders.js +25 -13
  55. package/dist/routes/media/folders.js.map +1 -1
  56. package/dist/routes/media/upload.d.ts +1 -1
  57. package/dist/routes/media/upload.js +26 -58
  58. package/dist/routes/media/upload.js.map +1 -1
  59. package/dist/test/integration/media-declared-content.test.d.ts +1 -0
  60. package/dist/test/integration/media-declared-content.test.js +705 -0
  61. package/dist/test/integration/media-declared-content.test.js.map +1 -0
  62. package/dist/test/integration/media-declared-retire.test.d.ts +1 -0
  63. package/dist/test/integration/media-declared-retire.test.js +186 -0
  64. package/dist/test/integration/media-declared-retire.test.js.map +1 -0
  65. package/dist/test/integration/media-delivery-editing.test.js +26 -0
  66. package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
  67. package/dist/test/integration/media-linked-subfolders.test.d.ts +1 -0
  68. package/dist/test/integration/media-linked-subfolders.test.js +192 -0
  69. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -0
  70. package/dist/test/unit/declared.test.d.ts +1 -0
  71. package/dist/test/unit/declared.test.js +118 -0
  72. package/dist/test/unit/declared.test.js.map +1 -0
  73. package/dist/upload-checks.d.ts +18 -0
  74. package/dist/upload-checks.js +75 -0
  75. package/dist/upload-checks.js.map +1 -0
  76. package/dist/validation/declared.schema.d.ts +187 -0
  77. package/dist/validation/declared.schema.js +78 -0
  78. package/dist/validation/declared.schema.js.map +1 -0
  79. package/dist/validation/media.schema.d.ts +3 -0
  80. package/dist/validation/media.schema.js +12 -12
  81. package/dist/validation/media.schema.js.map +1 -1
  82. package/frontend-vue/app/components/dialogs/DestinationDialog.vue +1 -1
  83. package/frontend-vue/app/components/dialogs/MoveDialog.vue +2 -2
  84. package/frontend-vue/app/components/explorer/ExplorerContent.vue +1 -1
  85. package/frontend-vue/app/components/explorer/ExplorerToolbar.vue +1 -1
  86. package/frontend-vue/app/components/shared/AssetThumb.vue +3 -1
  87. package/frontend-vue/app/composables/library/explorerMenus.ts +1 -1
  88. package/frontend-vue/app/composables/library/useExplorerCommands.ts +1 -1
  89. package/frontend-vue/app/composables/library/useExplorerDrop.ts +1 -1
  90. package/frontend-vue/app/types/media.ts +3 -1
  91. package/frontend-vue/package.json +1 -1
  92. package/frontend-vue/tests/serverRender.test.ts +2 -1
  93. package/package.json +2 -2
  94. package/skills/dms-media/SKILL.md +50 -4
  95. package/src/bindings.ts +28 -0
  96. package/src/db/models/index.ts +1 -0
  97. package/src/db/models/mediaAssets.model.ts +25 -0
  98. package/src/db/models/mediaDeclarations.model.ts +19 -0
  99. package/src/db/models/mediaFolders.model.ts +44 -0
  100. package/src/db/tables/index.ts +1 -0
  101. package/src/db/tables/mediaDeclarations.table.ts +59 -0
  102. package/src/declared/assets.ts +446 -0
  103. package/src/declared/folders.ts +273 -0
  104. package/src/declared/index.ts +5 -0
  105. package/src/declared/readiness.ts +64 -0
  106. package/src/declared/records.ts +185 -0
  107. package/src/declared/retire.ts +206 -0
  108. package/src/implementations/interface-dms-media/index.ts +10 -0
  109. package/src/library/events.ts +4 -1
  110. package/src/routes/media/assets.ts +34 -5
  111. package/src/routes/media/context.ts +1 -1
  112. package/src/routes/media/dto.ts +6 -2
  113. package/src/routes/media/folders.ts +47 -21
  114. package/src/routes/media/upload.ts +50 -121
  115. package/src/test/integration/media-declared-content.test.ts +844 -0
  116. package/src/test/integration/media-declared-retire.test.ts +257 -0
  117. package/src/test/integration/media-delivery-editing.test.ts +45 -0
  118. package/src/test/integration/media-linked-subfolders.test.ts +256 -0
  119. package/src/test/unit/declared.test.ts +158 -0
  120. package/src/upload-checks.ts +126 -0
  121. package/src/validation/declared.schema.ts +104 -0
  122. package/src/validation/media.schema.ts +7 -6
  123. package/frontend-vue/pnpm-workspace.yaml +0 -2
@@ -2,6 +2,7 @@ import { MediaApiController } from "./controller";
2
2
  import { Delete, JSONBody, Parameter, Post } from "@antelopejs/interface-api";
3
3
  import { assert } from "@antelopejs/interface-api-util";
4
4
  import { deleteMediaAsset } from "../../asset-lifecycle";
5
+ import { holdsSubfolders } from "../../bindings";
5
6
  import { forgetFavorites } from "../../library/favorites";
6
7
  import { type MediaFolder } from "../../db";
7
8
  import {
@@ -25,19 +26,29 @@ const HTTP_BAD_REQUEST = 400;
25
26
  const HTTP_FORBIDDEN = 403;
26
27
  const HTTP_CONFLICT = 409;
27
28
 
28
- function assertUniqueSiblingName(
29
- context: MediaRequestContext,
29
+ /** Whether another folder under `parentId` has this name, case and Unicode form aside. */
30
+ export function hasSiblingNamed(
31
+ folders: MediaFolder[],
30
32
  name: string,
31
33
  parentId: string | undefined,
32
34
  ignoredId?: string,
33
- ): void {
35
+ ): boolean {
34
36
  const wanted = comparableName(name);
35
- const clash = context.folders.some(
37
+ return folders.some(
36
38
  (folder) =>
37
39
  folder._id !== ignoredId &&
38
40
  (folder.parentId ?? undefined) === parentId &&
39
41
  comparableName(folder.name) === wanted,
40
42
  );
43
+ }
44
+
45
+ function assertUniqueSiblingName(
46
+ context: MediaRequestContext,
47
+ name: string,
48
+ parentId: string | undefined,
49
+ ignoredId?: string,
50
+ ): void {
51
+ const clash = hasSiblingNamed(context.folders, name, parentId, ignoredId);
41
52
  assert(!clash, HTTP_CONFLICT, MEDIA_ERRORS.folderNameTaken);
42
53
  }
43
54
 
@@ -54,11 +65,11 @@ function assertCanPlaceUnder(
54
65
  return undefined;
55
66
  }
56
67
  const parent = requireFolderRight(context, parentId, "manage");
57
- assert(!parent.binding, HTTP_FORBIDDEN, MEDIA_ERRORS.boundParent);
68
+ assert(holdsSubfolders(parent), HTTP_FORBIDDEN, MEDIA_ERRORS.boundParent);
58
69
  return parent;
59
70
  }
60
71
 
61
- function buildChildPath(parent: MediaFolder | undefined): string[] {
72
+ export function buildChildPath(parent: MediaFolder | undefined): string[] {
62
73
  return parent ? [...parent.path, parent._id] : [];
63
74
  }
64
75
 
@@ -94,22 +105,33 @@ export async function deleteFolderTree(
94
105
  }
95
106
  }
96
107
 
97
- async function applyFolderMove(
98
- context: MediaRequestContext,
108
+ /** Moves a folder and rewrites the materialized path of everything under it. */
109
+ export async function applyFolderMove(
110
+ context: Pick<MediaRequestContext, "folderModel" | "folders">,
99
111
  folder: MediaFolder,
100
112
  newParent: MediaFolder | undefined,
113
+ ): Promise<void> {
114
+ const path = buildChildPath(newParent);
115
+ await context.folderModel.update(folder._id, {
116
+ parentId: newParent?._id,
117
+ path,
118
+ });
119
+ await rewriteDescendantPaths(context, folder, path);
120
+ }
121
+
122
+ /** Rewrites descendant paths after the root move has been accepted. */
123
+ export async function rewriteDescendantPaths(
124
+ context: Pick<MediaRequestContext, "folderModel" | "folders">,
125
+ folder: MediaFolder,
126
+ path: string[],
101
127
  ): Promise<void> {
102
128
  const newPaths = new Map<string, string[]>();
103
- newPaths.set(folder._id, buildChildPath(newParent));
129
+ newPaths.set(folder._id, path);
104
130
  const descendants = getDescendantFolders(context, folder._id);
105
131
  for (const descendant of descendants) {
106
132
  const parentPath = newPaths.get(descendant.parentId ?? "") ?? [];
107
133
  newPaths.set(descendant._id, [...parentPath, descendant.parentId ?? ""]);
108
134
  }
109
- await context.folderModel.update(folder._id, {
110
- parentId: newParent?._id,
111
- path: newPaths.get(folder._id),
112
- });
113
135
  await Promise.all(
114
136
  descendants.map((descendant) =>
115
137
  context.folderModel.update(descendant._id, {
@@ -119,16 +141,16 @@ async function applyFolderMove(
119
141
  );
120
142
  }
121
143
 
122
- function assertMoveTargetOutsideSubtree(
144
+ /** Whether a proposed parent would put a folder inside its own subtree. */
145
+ export function isMoveInsideSubtree(
123
146
  folder: MediaFolder,
124
- targetParentId: string | undefined,
125
147
  newParent: MediaFolder | undefined,
126
- ): void {
127
- const insideItself =
128
- targetParentId === folder._id ||
148
+ ): boolean {
149
+ return (
150
+ newParent?._id === folder._id ||
129
151
  (newParent?.path ?? []).includes(folder._id) ||
130
- newParent?.parentId === folder._id;
131
- assert(!insideItself, HTTP_BAD_REQUEST, "Cannot move a folder inside itself");
152
+ newParent?.parentId === folder._id
153
+ );
132
154
  }
133
155
 
134
156
  export class MediaFoldersController extends MediaApiController {
@@ -189,7 +211,11 @@ export class MediaFoldersController extends MediaApiController {
189
211
  assertNotBound(folder);
190
212
  const targetParentId = parentId ?? undefined;
191
213
  const newParent = assertCanPlaceUnder(context, targetParentId);
192
- assertMoveTargetOutsideSubtree(folder, targetParentId, newParent);
214
+ assert(
215
+ !isMoveInsideSubtree(folder, newParent),
216
+ HTTP_BAD_REQUEST,
217
+ "Cannot move a folder inside itself",
218
+ );
193
219
  assertUniqueSiblingName(context, folder.name, targetParentId, folderId);
194
220
  await applyFolderMove(context, folder, newParent);
195
221
  await this.record(context, {
@@ -12,19 +12,21 @@ import {
12
12
  PromoteFile,
13
13
  } from "@antelopejs/interface-file-storage";
14
14
  import { TenantScopedModel } from "@antelopejs/interface-dms/tenant-scoped-model";
15
- import sharp from "sharp";
16
- import { getRegisteredBindings } from "../../bindings";
15
+ import { feedingBinding } from "../../bindings";
17
16
  import { getMediaConfig } from "../../config";
18
17
  import { ORIGINAL_FILENAME_METADATA_KEY } from "../../constants";
19
18
  import { MediaUploadModel } from "../../db";
20
- import { loadAssetsInFolders, sumStoredBytes } from "../../library/listing";
21
- import { suggestFreeNames } from "../../upload-names";
19
+ import { loadAssetsInFolders } from "../../library/listing";
22
20
  import {
23
- expectedImageFormat,
24
- isUploadTypeAllowed,
25
- mimetypeMatches,
26
- mimetypeOfFormat,
27
- } from "../../upload-policy";
21
+ assertReadableImage,
22
+ assertUploadTypeAllowed,
23
+ assertWithinQuota,
24
+ type ImageProbe,
25
+ probeImageBytes,
26
+ UploadRefusedError,
27
+ } from "../../upload-checks";
28
+ import { suggestFreeNames } from "../../upload-names";
29
+ import { mimetypeOfFormat } from "../../upload-policy";
28
30
  import {
29
31
  confirmUploadSchema,
30
32
  presignSchema,
@@ -36,42 +38,28 @@ import {
36
38
  import { type MediaRequestContext, requireFolderRight } from "./context";
37
39
  import { buildAssetDto } from "./dto";
38
40
 
39
- const HTTP_BAD_REQUEST = 400;
40
- const HTTP_PAYLOAD_TOO_LARGE = 413;
41
- const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
42
- const HTTP_UNPROCESSABLE_ENTITY = 422;
43
- // Dimension probing buffers the file in memory, so skip files too large to
44
- // hold in the heap; they simply stay without width/height metadata.
45
- const MAX_PROBE_SIZE_BYTES = 32 * 1024 * 1024;
46
- const FIRST_SWAPPED_ORIENTATION = 5;
41
+ export type { UploadRefusal } from "../../upload-checks";
47
42
 
48
- /** Why an upload is refused, for the queue to explain it in the member's language. */
49
- export type UploadRefusal =
50
- | "type_not_allowed"
51
- | "field_type"
52
- | "quota"
53
- | "invalid_image";
43
+ const HTTP_BAD_REQUEST = 400;
54
44
 
55
- function refuse(
56
- status: number,
57
- reason: UploadRefusal,
58
- message: string,
59
- details: Record<string, unknown> = {},
60
- ): never {
61
- throw new HTTPResult(status, { reason, message, ...details });
45
+ /** Answers a refused file with its reason, for the queue to explain it. */
46
+ async function answerRefusal<T>(check: () => T | Promise<T>): Promise<T> {
47
+ try {
48
+ return await check();
49
+ } catch (error) {
50
+ if (!(error instanceof UploadRefusedError)) throw error;
51
+ throw new HTTPResult(error.status, {
52
+ reason: error.reason,
53
+ message: error.message,
54
+ ...error.details,
55
+ });
56
+ }
62
57
  }
63
58
 
64
59
  function mediaUploadPath(tenantId: string, folderId: string): string {
65
60
  return `media/${tenantId}/${folderId}`;
66
61
  }
67
62
 
68
- interface ImageProbe {
69
- width?: number;
70
- height?: number;
71
- format?: string;
72
- isReadable: boolean;
73
- }
74
-
75
63
  async function readStoredFile(
76
64
  storageKey: string,
77
65
  storage: string | undefined,
@@ -82,95 +70,34 @@ async function readStoredFile(
82
70
  return Buffer.from(await response.arrayBuffer());
83
71
  }
84
72
 
85
- /** Displayed size: sharp reports stored pixels, EXIF orientations 5-8 swap them. */
86
- function orientedSize(metadata: sharp.Metadata): ImageProbe {
87
- const isSwapped = (metadata.orientation ?? 0) >= FIRST_SWAPPED_ORIENTATION;
88
- return {
89
- width: isSwapped ? metadata.height : metadata.width,
90
- height: isSwapped ? metadata.width : metadata.height,
91
- format: metadata.format,
92
- isReadable: true,
93
- };
94
- }
95
-
96
- async function probeImage(
97
- storageKey: string,
98
- storage: string | undefined,
99
- mimetype: string,
100
- size: number,
101
- ): Promise<ImageProbe> {
102
- if (!mimetype.startsWith("image/") || size > MAX_PROBE_SIZE_BYTES)
103
- return { isReadable: true };
104
- try {
105
- const buffer = await readStoredFile(storageKey, storage);
106
- if (!buffer) return { isReadable: true };
107
- return orientedSize(await sharp(buffer).metadata());
108
- } catch {
109
- return { isReadable: false };
110
- }
111
- }
112
-
113
- function assertTypeAllowed(
114
- context: MediaRequestContext,
115
- folderId: string,
116
- filename: string,
117
- mimetype: string,
118
- ): void {
119
- if (!isUploadTypeAllowed(filename, mimetype))
120
- refuse(
121
- HTTP_UNSUPPORTED_MEDIA_TYPE,
122
- "type_not_allowed",
123
- "This type of file can't be added to the library",
124
- );
125
- const binding = context.foldersById.get(folderId)?.binding;
126
- const accepted = getRegisteredBindings().find(
127
- (config) => config.id === binding,
128
- )?.field?.mimetypes;
129
- if (accepted?.length && !mimetypeMatches(mimetype, accepted))
130
- refuse(
131
- HTTP_UNSUPPORTED_MEDIA_TYPE,
132
- "field_type",
133
- `This folder feeds a field that only accepts ${accepted.join(", ")}`,
134
- { accepted },
135
- );
136
- }
137
-
138
- async function assertWithinQuota(
139
- context: MediaRequestContext,
140
- size: number,
141
- ): Promise<void> {
142
- const quota = getMediaConfig().storageQuotaBytes;
143
- if (!quota) return;
144
- const used = await sumStoredBytes(context.assetModel);
145
- if (used + size > quota)
146
- refuse(
147
- HTTP_PAYLOAD_TOO_LARGE,
148
- "quota",
149
- "The library's storage plan is full",
150
- { remaining: Math.max(quota - used, 0), quota },
151
- );
152
- }
153
-
154
73
  async function readImage(
155
74
  resourceKey: string,
156
75
  metadata: FileMetadata,
157
76
  ): Promise<ImageProbe> {
158
- const probe = await probeImage(
159
- resourceKey,
160
- getMediaConfig().storage,
77
+ const storage = getMediaConfig().storage;
78
+ const probe = await probeImageBytes(
79
+ () => readStoredFile(resourceKey, storage),
161
80
  metadata.mimetype,
162
81
  metadata.size,
163
82
  );
164
- const isDecodable = Boolean(expectedImageFormat(metadata.mimetype));
165
- if (isDecodable && (!probe.isReadable || !probe.format))
166
- refuse(
167
- HTTP_UNPROCESSABLE_ENTITY,
168
- "invalid_image",
169
- "This file is not a readable image",
170
- );
83
+ assertReadableImage(probe, metadata.mimetype);
171
84
  return probe;
172
85
  }
173
86
 
87
+ async function assertUploadAccepted(
88
+ context: MediaRequestContext,
89
+ folderId: string,
90
+ filename: string,
91
+ file: Pick<FileMetadata, "mimetype" | "size">,
92
+ ): Promise<void> {
93
+ assertUploadTypeAllowed(
94
+ feedingBinding(context.foldersById.get(folderId), context.foldersById),
95
+ filename,
96
+ file.mimetype,
97
+ );
98
+ await assertWithinQuota(context.assetModel, file.size);
99
+ }
100
+
174
101
  export class MediaUploadController extends MediaApiController {
175
102
  @TenantScopedModel(MediaUploadModel)
176
103
  declare uploadModel: MediaUploadModel;
@@ -182,8 +109,9 @@ export class MediaUploadController extends MediaApiController {
182
109
  );
183
110
  const context = await this.resolveContext();
184
111
  requireFolderRight(context, folderId, "write");
185
- assertTypeAllowed(context, folderId, filename, mimetype);
186
- await assertWithinQuota(context, size);
112
+ await answerRefusal(() =>
113
+ assertUploadAccepted(context, folderId, filename, { mimetype, size }),
114
+ );
187
115
  const storage = getMediaConfig().storage;
188
116
  const presigned = await CreateUploadUrl(
189
117
  {
@@ -295,9 +223,10 @@ export class MediaUploadController extends MediaApiController {
295
223
  requireFolderRight(context, folderId, "write");
296
224
  const storage = getMediaConfig().storage;
297
225
  const metadata = await GetFileMetadata(resourceKey, storage);
298
- assertTypeAllowed(context, folderId, filename, metadata.mimetype);
299
- await assertWithinQuota(context, metadata.size);
300
- const image = await readImage(resourceKey, metadata);
226
+ const image = await answerRefusal(async () => {
227
+ await assertUploadAccepted(context, folderId, filename, metadata);
228
+ return readImage(resourceKey, metadata);
229
+ });
301
230
  const promoted = await PromoteFile(resourceKey, storage);
302
231
  await this.uploadModel.forgetKey(resourceKey);
303
232
  const [assetId] = await context.assetModel.insert({