@antelopejs/dms-media 0.7.2 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. package/README.md +10 -10
  2. package/dist/acl/entries.js +20 -2
  3. package/dist/acl/entries.js.map +1 -1
  4. package/dist/asset-lifecycle.js +5 -1
  5. package/dist/asset-lifecycle.js.map +1 -1
  6. package/dist/bindings.d.ts +1 -0
  7. package/dist/bindings.js +36 -25
  8. package/dist/bindings.js.map +1 -1
  9. package/dist/db/models/mediaAssets.model.d.ts +3 -3
  10. package/dist/db/models/mediaDeclarations.model.d.ts +3 -3
  11. package/dist/db/models/mediaEvents.model.d.ts +3 -3
  12. package/dist/db/models/mediaFavorites.model.d.ts +3 -3
  13. package/dist/db/models/mediaFolders.model.d.ts +3 -3
  14. package/dist/db/models/mediaUploads.model.d.ts +3 -3
  15. package/dist/declared/assets.js +39 -25
  16. package/dist/declared/assets.js.map +1 -1
  17. package/dist/declared/folders.js +27 -14
  18. package/dist/declared/folders.js.map +1 -1
  19. package/dist/declared/records.d.ts +1 -0
  20. package/dist/declared/records.js +18 -1
  21. package/dist/declared/records.js.map +1 -1
  22. package/dist/fixed-id.d.ts +1 -0
  23. package/dist/fixed-id.js +16 -0
  24. package/dist/fixed-id.js.map +1 -0
  25. package/dist/library/folder-stats.d.ts +1 -1
  26. package/dist/library/folder-stats.js.map +1 -1
  27. package/dist/library/listing.d.ts +2 -0
  28. package/dist/library/listing.js +14 -4
  29. package/dist/library/listing.js.map +1 -1
  30. package/dist/routes/media/assets.d.ts +3 -2
  31. package/dist/routes/media/assets.js +15 -10
  32. package/dist/routes/media/assets.js.map +1 -1
  33. package/dist/routes/media/bulk.js +4 -4
  34. package/dist/routes/media/bulk.js.map +1 -1
  35. package/dist/routes/media/folders.js +4 -4
  36. package/dist/routes/media/folders.js.map +1 -1
  37. package/dist/routes/media/library.js +6 -12
  38. package/dist/routes/media/library.js.map +1 -1
  39. package/dist/routes/media/storage-keys.js +10 -1
  40. package/dist/routes/media/storage-keys.js.map +1 -1
  41. package/dist/test/helpers/assets.d.ts +2 -2
  42. package/dist/test/helpers/folders.d.ts +6 -6
  43. package/dist/test/helpers/permissions-world.d.ts +6 -6
  44. package/dist/test/integration/binding-folder-race.test.d.ts +1 -0
  45. package/dist/test/integration/binding-folder-race.test.js +66 -0
  46. package/dist/test/integration/binding-folder-race.test.js.map +1 -0
  47. package/dist/test/integration/declared-asset-race.test.d.ts +1 -0
  48. package/dist/test/integration/declared-asset-race.test.js +78 -0
  49. package/dist/test/integration/declared-asset-race.test.js.map +1 -0
  50. package/dist/test/integration/declared-folder-race.test.d.ts +1 -0
  51. package/dist/test/integration/declared-folder-race.test.js +43 -0
  52. package/dist/test/integration/declared-folder-race.test.js.map +1 -0
  53. package/dist/test/integration/media-activity-overview.test.js +27 -22
  54. package/dist/test/integration/media-activity-overview.test.js.map +1 -1
  55. package/dist/test/integration/media-api.test.js +9 -5
  56. package/dist/test/integration/media-api.test.js.map +1 -1
  57. package/dist/test/integration/media-bindings.test.js +16 -13
  58. package/dist/test/integration/media-bindings.test.js.map +1 -1
  59. package/dist/test/integration/media-cleanup.test.js +14 -5
  60. package/dist/test/integration/media-cleanup.test.js.map +1 -1
  61. package/dist/test/integration/media-declared-content.test.js +107 -91
  62. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  63. package/dist/test/integration/media-delivery-editing.test.js +238 -215
  64. package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
  65. package/dist/test/integration/media-explorer-writes.test.js +131 -112
  66. package/dist/test/integration/media-explorer-writes.test.js.map +1 -1
  67. package/dist/test/integration/media-guards.test.js +38 -37
  68. package/dist/test/integration/media-guards.test.js.map +1 -1
  69. package/dist/test/integration/media-library.test.js +244 -224
  70. package/dist/test/integration/media-library.test.js.map +1 -1
  71. package/dist/test/integration/media-linked-subfolders.test.js +173 -158
  72. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  73. package/dist/test/integration/media-permissions.test.js +31 -11
  74. package/dist/test/integration/media-permissions.test.js.map +1 -1
  75. package/dist/test/integration/media-search-query.test.js +8 -6
  76. package/dist/test/integration/media-search-query.test.js.map +1 -1
  77. package/dist/test/integration/media-search-views.test.js +12 -8
  78. package/dist/test/integration/media-search-views.test.js.map +1 -1
  79. package/dist/test/integration/media-upload-policy.test.js +228 -200
  80. package/dist/test/integration/media-upload-policy.test.js.map +1 -1
  81. package/dist/test/stack-modules.json +5 -5
  82. package/dist/test/unit/acl/entries.test.js +19 -0
  83. package/dist/test/unit/acl/entries.test.js.map +1 -1
  84. package/dist/test/unit/acl/resolver.test.js +9 -1
  85. package/dist/test/unit/acl/resolver.test.js.map +1 -1
  86. package/dist/test/unit/asset-lifecycle.test.d.ts +1 -0
  87. package/dist/test/unit/asset-lifecycle.test.js +18 -0
  88. package/dist/test/unit/asset-lifecycle.test.js.map +1 -0
  89. package/dist/test/unit/library/zip-names.test.js +6 -3
  90. package/dist/test/unit/library/zip-names.test.js.map +1 -1
  91. package/dist/test/unit/routes/storage-keys.test.d.ts +1 -0
  92. package/dist/test/unit/routes/storage-keys.test.js +18 -0
  93. package/dist/test/unit/routes/storage-keys.test.js.map +1 -0
  94. package/dist/test/unit/transform-ops.test.js +19 -0
  95. package/dist/test/unit/transform-ops.test.js.map +1 -1
  96. package/dist/transform-ops.js +25 -1
  97. package/dist/transform-ops.js.map +1 -1
  98. package/dist/validation/declared.schema.d.ts +6 -6
  99. package/dist/validation/library.schema.d.ts +4 -4
  100. package/dist/validation/media.schema.d.ts +5 -5
  101. package/dist/validation/media.schema.js +10 -6
  102. package/dist/validation/media.schema.js.map +1 -1
  103. package/frontend-vue/app/components/Explorer.vue +2 -0
  104. package/frontend-vue/app/components/FileProperties.vue +1 -1
  105. package/frontend-vue/app/components/ImageEditor.vue +5 -5
  106. package/frontend-vue/app/components/RecentFiles.vue +2 -2
  107. package/frontend-vue/app/components/UploadQueue.vue +4 -4
  108. package/frontend-vue/app/components/dialogs/DeleteFilesDialog.vue +1 -1
  109. package/frontend-vue/app/components/dialogs/ShortcutsDialog.vue +1 -1
  110. package/frontend-vue/app/components/dialogs/VisibilityDialog.vue +1 -1
  111. package/frontend-vue/app/components/explorer/ExplorerInspector.vue +1 -1
  112. package/frontend-vue/app/components/explorer/ExplorerSidebar.vue +2 -2
  113. package/frontend-vue/app/components/explorer/FolderStrip.vue +1 -1
  114. package/frontend-vue/app/components/explorer/GridView.vue +1 -1
  115. package/frontend-vue/app/components/shared/AltTextField.vue +2 -2
  116. package/frontend-vue/build/backend-boundary.ts +8 -3
  117. package/frontend-vue/eslint.config.mjs +0 -1
  118. package/frontend-vue/package.json +2 -2
  119. package/frontend-vue/pnpm-lock.yaml +45 -14
  120. package/frontend-vue/tests/backend-boundary.test.ts +6 -4
  121. package/frontend-vue/tests/fixtures/serverRender.ts +3 -3
  122. package/frontend-vue/tests/registration.test.ts +5 -0
  123. package/frontend-vue/tsconfig.json +1 -2
  124. package/package.json +17 -17
  125. package/src/acl/entries.ts +30 -7
  126. package/src/asset-lifecycle.ts +6 -2
  127. package/src/bindings.ts +41 -38
  128. package/src/declared/assets.ts +45 -28
  129. package/src/declared/folders.ts +30 -20
  130. package/src/declared/records.ts +31 -2
  131. package/src/fixed-id.ts +18 -0
  132. package/src/library/folder-stats.ts +1 -1
  133. package/src/library/listing.ts +24 -4
  134. package/src/routes/media/assets.ts +23 -11
  135. package/src/routes/media/bulk.ts +7 -5
  136. package/src/routes/media/folders.ts +9 -5
  137. package/src/routes/media/library.ts +10 -18
  138. package/src/routes/media/storage-keys.ts +14 -2
  139. package/src/test/integration/binding-folder-race.test.ts +82 -0
  140. package/src/test/integration/declared-asset-race.test.ts +115 -0
  141. package/src/test/integration/declared-folder-race.test.ts +50 -0
  142. package/src/test/integration/media-activity-overview.test.ts +40 -27
  143. package/src/test/integration/media-api.test.ts +9 -5
  144. package/src/test/integration/media-bindings.test.ts +17 -13
  145. package/src/test/integration/media-cleanup.test.ts +17 -5
  146. package/src/test/integration/media-declared-content.test.ts +129 -112
  147. package/src/test/integration/media-delivery-editing.test.ts +323 -299
  148. package/src/test/integration/media-explorer-writes.test.ts +161 -135
  149. package/src/test/integration/media-guards.test.ts +40 -38
  150. package/src/test/integration/media-library.test.ts +325 -296
  151. package/src/test/integration/media-linked-subfolders.test.ts +207 -186
  152. package/src/test/integration/media-permissions.test.ts +33 -14
  153. package/src/test/integration/media-search-query.test.ts +24 -8
  154. package/src/test/integration/media-search-views.test.ts +39 -32
  155. package/src/test/integration/media-upload-policy.test.ts +283 -254
  156. package/src/test/stack-modules.json +5 -5
  157. package/src/test/unit/acl/entries.test.ts +23 -0
  158. package/src/test/unit/acl/resolver.test.ts +9 -1
  159. package/src/test/unit/asset-lifecycle.test.ts +21 -0
  160. package/src/test/unit/library/zip-names.test.ts +9 -7
  161. package/src/test/unit/routes/storage-keys.test.ts +23 -0
  162. package/src/test/unit/transform-ops.test.ts +29 -1
  163. package/src/transform-ops.ts +32 -2
  164. package/src/validation/media.schema.ts +14 -15
package/src/bindings.ts CHANGED
@@ -1,8 +1,10 @@
1
1
  import { createHash } from "node:crypto";
2
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
2
3
  import { GetPermissionId } from "@antelopejs/interface-dms/page";
3
4
  import type { AssetBindingConfig } from "@antelopejs/interface-dms-media";
4
5
  import { serializeAcl } from "./acl";
5
6
  import type { MediaFolder, MediaFolderModel } from "./db";
7
+ import { fixedId } from "./fixed-id";
6
8
  import type { AclEntry } from "./types";
7
9
 
8
10
  export const CONTENT_ROOT_BINDING = "dms-media.content-root";
@@ -101,37 +103,39 @@ export function buildBindingAcl(config: AssetBindingConfig): AclEntry[] {
101
103
  ];
102
104
  }
103
105
 
104
- async function ensureContentRoot(
106
+ /**
107
+ * The id of the folder linked to `binding` in a tenant, the content root
108
+ * included, the same in every process: two processes provisioning one tenant
109
+ * at once write one folder instead of two.
110
+ */
111
+ export function bindingFolderId(tenantId: string, binding: string): string {
112
+ return fixedId("dms-media:binding-folder", tenantId, binding);
113
+ }
114
+
115
+ /** Inserts `folder` under its fixed id. False when another process inserted it first. */
116
+ async function insertOnce(
105
117
  folderModel: MediaFolderModel,
106
- foldersByBinding: Map<string, MediaFolder>,
107
- ): Promise<string> {
108
- const existing = foldersByBinding.get(CONTENT_ROOT_BINDING);
109
- if (existing) return existing._id;
110
- const [id] = await folderModel.insert({
111
- name: CONTENT_ROOT_NAME,
112
- path: [],
113
- binding: CONTENT_ROOT_BINDING,
114
- json_acl: EMPTY_ACL,
115
- visibility: "private",
116
- });
117
- return id;
118
+ folder: Parameters<MediaFolderModel["insert"]>[0],
119
+ ): Promise<boolean> {
120
+ try {
121
+ await folderModel.insert(folder);
122
+ return true;
123
+ } catch (error) {
124
+ if (!IsDuplicateKeyError(error)) throw error;
125
+ return false;
126
+ }
118
127
  }
119
128
 
120
129
  async function ensureBindingFolder(
130
+ tenantId: string,
121
131
  folderModel: MediaFolderModel,
122
- foldersByBinding: Map<string, MediaFolder>,
123
132
  contentRootId: string,
124
133
  config: AssetBindingConfig,
125
134
  ): Promise<void> {
135
+ const id = bindingFolderId(tenantId, config.id);
126
136
  const acl = serializeAcl(buildBindingAcl(config)) ?? EMPTY_ACL;
127
- const existing = foldersByBinding.get(config.id);
128
- if (existing) {
129
- if (existing.json_acl !== acl) {
130
- await folderModel.update(existing._id, { json_acl: acl });
131
- }
132
- return;
133
- }
134
- await folderModel.insert({
137
+ const inserted = await insertOnce(folderModel, {
138
+ _id: id,
135
139
  name: config.folderName ?? config.id,
136
140
  parentId: contentRootId,
137
141
  path: [contentRootId],
@@ -139,6 +143,11 @@ async function ensureBindingFolder(
139
143
  json_acl: acl,
140
144
  visibility: "private",
141
145
  });
146
+ if (inserted) return;
147
+ const existing = await folderModel.get(id);
148
+ if (existing && existing.json_acl !== acl) {
149
+ await folderModel.update(id, { json_acl: acl });
150
+ }
142
151
  }
143
152
 
144
153
  async function provisionTenant(
@@ -147,23 +156,17 @@ async function provisionTenant(
147
156
  fingerprint: string,
148
157
  ): Promise<void> {
149
158
  if (registeredBindings.size > 0) {
150
- const folders = await folderModel.getAll();
151
- const foldersByBinding = new Map(
152
- folders.flatMap((folder): [string, MediaFolder][] =>
153
- folder.binding ? [[folder.binding, folder]] : [],
154
- ),
155
- );
156
- const contentRootId = await ensureContentRoot(
157
- folderModel,
158
- foldersByBinding,
159
- );
159
+ const contentRootId = bindingFolderId(tenantId, CONTENT_ROOT_BINDING);
160
+ await insertOnce(folderModel, {
161
+ _id: contentRootId,
162
+ name: CONTENT_ROOT_NAME,
163
+ path: [],
164
+ binding: CONTENT_ROOT_BINDING,
165
+ json_acl: EMPTY_ACL,
166
+ visibility: "private",
167
+ });
160
168
  for (const config of registeredBindings.values()) {
161
- await ensureBindingFolder(
162
- folderModel,
163
- foldersByBinding,
164
- contentRootId,
165
- config,
166
- );
169
+ await ensureBindingFolder(tenantId, folderModel, contentRootId, config);
167
170
  }
168
171
  }
169
172
  provisionedTenants.set(tenantId, fingerprint);
@@ -1,5 +1,6 @@
1
1
  import { randomUUID } from "node:crypto";
2
2
  import { readFile } from "node:fs/promises";
3
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
3
4
  import { DeleteFile } from "@antelopejs/interface-file-storage";
4
5
  import type {
5
6
  MediaAssetDeclaration,
@@ -7,7 +8,7 @@ import type {
7
8
  } from "@antelopejs/interface-dms-media";
8
9
  import { feedingBinding } from "../bindings";
9
10
  import { getMediaConfig } from "../config";
10
- import type { MediaAsset, MediaFolder } from "../db";
11
+ import type { MediaFolder } from "../db";
11
12
  import { uploadStorageBytes } from "../derivatives";
12
13
  import { recordMediaEvent } from "../library/events";
13
14
  import {
@@ -27,6 +28,7 @@ import {
27
28
  import { findBoundFolder, findDeclaredFolder } from "./folders";
28
29
  import {
29
30
  DECLARED_CONTENT_AUTHOR,
31
+ declaredId,
30
32
  type DeclaredModels,
31
33
  declaredModels,
32
34
  MediaDeclarationError,
@@ -146,50 +148,65 @@ function writeFile(
146
148
  );
147
149
  }
148
150
 
151
+ /** Inserts the asset under its fixed id. False when another process inserted it first. */
149
152
  async function insertAsset(
150
153
  { models, declaration, folder }: AssetTarget,
154
+ id: string,
151
155
  file: PreparedFile,
152
156
  storageKey: string,
153
- ): Promise<MediaAsset | undefined> {
154
- const [assetId] = await models.assetModel.insert({
155
- folderId: folder._id,
156
- mediaRevision: randomUUID(),
157
- json_retiredFiles: "[]",
158
- name: declaration.name,
159
- mimetype: file.mimetype,
160
- size: file.bytes.byteLength,
161
- storageKey,
162
- storage: getMediaConfig().storage,
163
- width: file.image.width,
164
- height: file.image.height,
165
- alt: declaration.alt,
166
- visibility: "inherit",
167
- createdBy: DECLARED_CONTENT_AUTHOR._id,
168
- });
169
- return models.assetModel.get(assetId);
157
+ ): Promise<boolean> {
158
+ try {
159
+ await models.assetModel.insert({
160
+ _id: id,
161
+ folderId: folder._id,
162
+ mediaRevision: randomUUID(),
163
+ json_retiredFiles: "[]",
164
+ name: declaration.name,
165
+ mimetype: file.mimetype,
166
+ size: file.bytes.byteLength,
167
+ storageKey,
168
+ storage: getMediaConfig().storage,
169
+ width: file.image.width,
170
+ height: file.image.height,
171
+ alt: declaration.alt,
172
+ visibility: "inherit",
173
+ createdBy: DECLARED_CONTENT_AUTHOR._id,
174
+ });
175
+ return true;
176
+ } catch (error) {
177
+ if (!IsDuplicateKeyError(error)) throw error;
178
+ return false;
179
+ }
170
180
  }
171
181
 
182
+ /**
183
+ * Stores the file and inserts its asset. A process that loses the insert to
184
+ * another one importing the same key deletes its own file and keeps theirs.
185
+ */
172
186
  async function createAsset(
173
187
  target: AssetTarget,
174
188
  file: PreparedFile,
175
- ): Promise<MediaAsset> {
189
+ ): Promise<MediaDeclarationResult> {
190
+ const { models, declaration } = target;
191
+ const id = declaredId(models.tenantId, "asset", declaration.key);
176
192
  const storageKey = await writeFile(target, file);
177
193
  const discardFile = () =>
178
194
  DeleteFile(storageKey, getMediaConfig().storage).catch(() => undefined);
179
- const asset = await insertAsset(target, file, storageKey).catch(
195
+ const inserted = await insertAsset(target, id, file, storageKey).catch(
180
196
  async (error: unknown) => {
181
197
  await discardFile();
182
198
  throw error;
183
199
  },
184
200
  );
185
- if (!asset) {
186
- await discardFile();
201
+ const asset = await models.assetModel.get(id);
202
+ if (!inserted || !asset) await discardFile();
203
+ if (!asset)
187
204
  throw new MediaDeclarationError(
188
205
  "asset",
189
- target.declaration.key,
206
+ declaration.key,
190
207
  "the file could not be created",
191
208
  );
192
- }
209
+ if (!inserted) return { status: "kept", id };
193
210
  await recordMediaEvent(
194
211
  { tenantId: target.models.tenantId, user: DECLARED_CONTENT_AUTHOR },
195
212
  {
@@ -200,7 +217,7 @@ async function createAsset(
200
217
  size: asset.size,
201
218
  },
202
219
  );
203
- return asset;
220
+ return { status: "created", id };
204
221
  }
205
222
 
206
223
  async function applyAssetDeclaration(
@@ -223,9 +240,9 @@ async function applyAssetDeclaration(
223
240
  fieldBinding: await fieldBindingOf(models, folder),
224
241
  };
225
242
  const file = await prepareFile(target, await readSource(declaration, fail));
226
- const asset = await createAsset(target, file);
227
- await rememberDeclaration(models, "asset", declaration.key, asset._id);
228
- return { status: "created", id: asset._id };
243
+ const result = await createAsset(target, file);
244
+ await rememberDeclaration(models, "asset", declaration.key, result.id);
245
+ return result;
229
246
  }
230
247
 
231
248
  /** Implements `ImportMediaAsset`. */
@@ -11,8 +11,10 @@ import {
11
11
  declaredFolderSchema,
12
12
  type DeclaredFolderInput,
13
13
  } from "../validation/declared.schema";
14
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
14
15
  import {
15
16
  DECLARED_CONTENT_AUTHOR,
17
+ declaredId,
16
18
  type DeclaredModels,
17
19
  declaredModels,
18
20
  MediaDeclarationError,
@@ -86,28 +88,36 @@ async function createFolder(
86
88
  models: DeclaredModels,
87
89
  declaration: DeclaredFolderInput,
88
90
  parent: MediaFolder | undefined,
89
- ): Promise<MediaFolder> {
91
+ ): Promise<MediaDeclarationResult> {
92
+ const id = declaredId(models.tenantId, "folder", declaration.key);
93
+ const missing = new MediaDeclarationError(
94
+ "folder",
95
+ declaration.key,
96
+ "the folder could not be created",
97
+ );
90
98
  const folders = await models.folderModel.getAll();
91
- if (hasSiblingNamed(folders, declaration.name, parent?._id))
99
+ if (hasSiblingNamed(folders, declaration.name, parent?._id, id))
92
100
  throw new MediaDeclarationError(
93
101
  "folder",
94
102
  declaration.key,
95
103
  `a folder named '${declaration.name}' already exists there`,
96
104
  );
97
- const [folderId] = await models.folderModel.insert({
98
- name: declaration.name,
99
- parentId: parent?._id,
100
- path: buildChildPath(parent),
101
- visibility: declaration.visibility,
102
- json_acl: serializeAcl(declaration.acl),
103
- });
104
- const folder = await models.folderModel.get(folderId);
105
- if (!folder)
106
- throw new MediaDeclarationError(
107
- "folder",
108
- declaration.key,
109
- "the folder could not be created",
110
- );
105
+ try {
106
+ await models.folderModel.insert({
107
+ _id: id,
108
+ name: declaration.name,
109
+ parentId: parent?._id,
110
+ path: buildChildPath(parent),
111
+ visibility: declaration.visibility,
112
+ json_acl: serializeAcl(declaration.acl),
113
+ });
114
+ } catch (error) {
115
+ if (!IsDuplicateKeyError(error)) throw error;
116
+ if (!(await models.folderModel.get(id))) throw missing;
117
+ return { status: "kept", id };
118
+ }
119
+ const folder = await models.folderModel.get(id);
120
+ if (!folder) throw missing;
111
121
  await recordMediaEvent(
112
122
  { tenantId: models.tenantId, user: DECLARED_CONTENT_AUTHOR },
113
123
  {
@@ -117,7 +127,7 @@ async function createFolder(
117
127
  details: { targetId: folder._id },
118
128
  },
119
129
  );
120
- return folder;
130
+ return { status: "created", id };
121
131
  }
122
132
 
123
133
  async function applyFolderDeclaration(
@@ -135,9 +145,9 @@ async function applyFolderDeclaration(
135
145
  const parent = declaration.parent
136
146
  ? await findParentFolder(models, declaration.parent, fail)
137
147
  : undefined;
138
- const folder = await createFolder(models, declaration, parent);
139
- await rememberDeclaration(models, "folder", declaration.key, folder._id);
140
- return { status: "created", id: folder._id };
148
+ const result = await createFolder(models, declaration, parent);
149
+ await rememberDeclaration(models, "folder", declaration.key, result.id);
150
+ return result;
141
151
  }
142
152
 
143
153
  /** Implements `EnsureMediaFolder`. */
@@ -1,9 +1,11 @@
1
+ import { IsDuplicateKeyError } from "@antelopejs/interface-database";
1
2
  import { GetModel } from "@antelopejs/interface-database-decorators";
2
3
  import type {
3
4
  MediaAssetDeclaration,
4
5
  MediaFolderDeclaration,
5
6
  } from "@antelopejs/interface-dms-media";
6
7
  import type { ZodType, ZodTypeDef } from "zod";
8
+ import { fixedId } from "../fixed-id";
7
9
  import { isObjectLike, isString } from "../guards";
8
10
  import {
9
11
  MediaAssetModel,
@@ -105,12 +107,39 @@ export async function settlePendingDeclaration(
105
107
  await pendingDeclarations.get(lockKey(tenantId, kind, key));
106
108
  }
107
109
 
108
- /** Remembers the folder or file a declaration created, under its kind and key. */
110
+ /**
111
+ * The id of the folder or file declared under `key`, the same in every
112
+ * process: two processes declaring one key at once write one row and one
113
+ * record instead of two. The tenant is part of it because ids are unique
114
+ * across tenant instances.
115
+ */
116
+ export function declaredId(
117
+ tenantId: string,
118
+ kind: MediaDeclarationKind,
119
+ key: string,
120
+ ): string {
121
+ return fixedId(`dms-media:declared-${kind}`, tenantId, key);
122
+ }
123
+
124
+ /**
125
+ * Records the folder or file declared under `key`. The record takes the
126
+ * target's fixed id, so a record another process wrote first is this same
127
+ * record.
128
+ */
109
129
  export async function rememberDeclaration(
110
130
  models: DeclaredModels,
111
131
  kind: MediaDeclarationKind,
112
132
  key: string,
113
133
  targetId: string,
114
134
  ): Promise<void> {
115
- await models.declarationModel.insert({ kind, key, targetId });
135
+ try {
136
+ await models.declarationModel.insert({
137
+ _id: targetId,
138
+ kind,
139
+ key,
140
+ targetId,
141
+ });
142
+ } catch (error) {
143
+ if (!IsDuplicateKeyError(error)) throw error;
144
+ }
116
145
  }
@@ -0,0 +1,18 @@
1
+ import { createHash } from "node:crypto";
2
+
3
+ /**
4
+ * An id derived from `parts`, the same in every process, so two processes
5
+ * writing the row for the same parts write one row. Shaped as a version 8
6
+ * UUID, like the ids the database gives other rows.
7
+ */
8
+ export function fixedId(...parts: string[]): string {
9
+ const hex = createHash("sha256").update(JSON.stringify(parts)).digest("hex");
10
+ const variant = ((Number.parseInt(hex.charAt(16), 16) % 4) + 8).toString(16);
11
+ return [
12
+ hex.slice(0, 8),
13
+ hex.slice(8, 12),
14
+ `8${hex.slice(13, 16)}`,
15
+ `${variant}${hex.slice(17, 20)}`,
16
+ hex.slice(20, 32),
17
+ ].join("-");
18
+ }
@@ -16,7 +16,7 @@ function emptyStats(): FolderStats {
16
16
  /** Recursive file counts and sizes of every folder, from one pass over the assets. */
17
17
  export function computeFolderStats(
18
18
  folders: MediaFolder[],
19
- assets: MediaAsset[],
19
+ assets: Pick<MediaAsset, "folderId" | "size">[],
20
20
  ): Map<string, FolderStats> {
21
21
  const stats = new Map(folders.map((folder) => [folder._id, emptyStats()]));
22
22
  const foldersById = new Map(folders.map((folder) => [folder._id, folder]));
@@ -33,21 +33,41 @@ interface AssetsTableModel {
33
33
  table: MediaAssetModel["table"];
34
34
  }
35
35
 
36
+ /** What the library tree counts of each asset. */
37
+ export type AssetCountFields = Pick<
38
+ MediaAsset,
39
+ "_id" | "folderId" | "size" | "mimetype" | "alt"
40
+ >;
41
+
42
+ function liveAssetsIn(model: AssetsTableModel, folderIds: string[]) {
43
+ return model.table
44
+ .getAll(folderIds.length === 1 ? folderIds[0] : folderIds, "folderId")
45
+ .filter((row) => row.key("isDeleting").default(false).eq(false));
46
+ }
47
+
36
48
  /** Every live asset stored in the given folders. */
37
49
  export async function loadAssetsInFolders(
38
50
  model: AssetsTableModel,
39
51
  folderIds: string[],
40
52
  ): Promise<MediaAsset[]> {
41
53
  if (folderIds.length === 0) return [];
42
- const rows = await model.table
43
- .getAll(folderIds.length === 1 ? folderIds[0] : folderIds, "folderId")
44
- .filter((row) => row.key("isDeleting").default(false).eq(false))
45
- .run();
54
+ const rows = await liveAssetsIn(model, folderIds).run();
46
55
  return rows
47
56
  .map((row) => MediaAssetModel.fromDatabase(row))
48
57
  .filter((row): row is MediaAsset => row !== undefined);
49
58
  }
50
59
 
60
+ /** The fields the tree counts, of every live asset stored in the given folders. */
61
+ export async function loadAssetCountFields(
62
+ model: AssetsTableModel,
63
+ folderIds: string[],
64
+ ): Promise<AssetCountFields[]> {
65
+ if (folderIds.length === 0) return [];
66
+ return liveAssetsIn(model, folderIds)
67
+ .pluck("_id", "folderId", "size", "mimetype", "alt")
68
+ .run();
69
+ }
70
+
51
71
  /** Bytes the tenant's live assets keep in storage, edited originals included. */
52
72
  export async function sumStoredBytes(model: AssetsTableModel): Promise<number> {
53
73
  const total = await model.table
@@ -12,6 +12,7 @@ import {
12
12
  MultiParameter,
13
13
  Parameter,
14
14
  Post,
15
+ type QueryValue,
15
16
  } from "@antelopejs/interface-api";
16
17
  import { assert } from "@antelopejs/interface-api-util";
17
18
  import { CreateReadUrl } from "@antelopejs/interface-file-storage";
@@ -23,7 +24,7 @@ import {
23
24
  assetVisibilitySchema,
24
25
  MEDIA_ERRORS,
25
26
  moveAssetSchema,
26
- parseBody,
27
+ rejectInvalid,
27
28
  previewIdsSchema,
28
29
  updateAssetSchema,
29
30
  } from "../../validation/media.schema";
@@ -41,6 +42,11 @@ const MAX_LISTING_RESULTS = 1000;
41
42
  const THUMB_PRESET_ID = "thumb";
42
43
  const UNCROPPED_PRESET_ID = "preview";
43
44
 
45
+ /** The text of a query value: `?name` and `?name=` give `true`, which reads as empty, like an absent value. */
46
+ function queryText(value: QueryValue): string {
47
+ return value === true ? "" : (value ?? "");
48
+ }
49
+
44
50
  /** The presets library thumbnails are rendered with: the square crop, and an uncropped size when configured. */
45
51
  interface PreviewPresets {
46
52
  thumb: MediaPresetConfig;
@@ -134,7 +140,9 @@ export class MediaAssetsController extends MediaApiController {
134
140
 
135
141
  @Get("/previews")
136
142
  async previews(@MultiParameter("ids", "query") queryIds: string[]) {
137
- const { ids } = parseBody({ ids: queryIds }, previewIdsSchema);
143
+ const { ids } = rejectInvalid(() =>
144
+ previewIdsSchema.parse({ ids: queryIds }),
145
+ );
138
146
  const context = await this.resolveContext();
139
147
  const { presets } = getMediaConfig();
140
148
  const thumb = presets.get(THUMB_PRESET_ID);
@@ -154,11 +162,12 @@ export class MediaAssetsController extends MediaApiController {
154
162
 
155
163
  @Get("/assets/search")
156
164
  async search(
157
- @Parameter("q", "query") q?: string,
158
- @Parameter("mime", "query") mime?: string,
159
- @Parameter("folderId", "query") folderId?: string,
165
+ @Parameter("q", "query") q: QueryValue,
166
+ @Parameter("mime", "query") mime: QueryValue,
167
+ @Parameter("folderId", "query") folderIdQuery: QueryValue,
160
168
  ) {
161
169
  const context = await this.resolveContext();
170
+ const folderId = queryText(folderIdQuery);
162
171
  const searchedFolders = folderId
163
172
  ? [requireFolderRight(context, folderId, "read")._id]
164
173
  : [...context.access.readable];
@@ -167,8 +176,8 @@ export class MediaAssetsController extends MediaApiController {
167
176
  searchedFolders.length === 1 ? searchedFolders[0] : searchedFolders,
168
177
  "folderId",
169
178
  );
170
- const term = (q ?? "").trim().toLowerCase();
171
- const mimePrefix = (mime ?? "").trim().toLowerCase();
179
+ const term = queryText(q).trim().toLowerCase();
180
+ const mimePrefix = queryText(mime).trim().toLowerCase();
172
181
  const assets: ReturnType<typeof buildAssetDto>[] = [];
173
182
  for await (const row of candidates) {
174
183
  const asset = MediaAssetModel.fromDatabase(row);
@@ -189,8 +198,9 @@ export class MediaAssetsController extends MediaApiController {
189
198
  @Get("/assets/:assetId/read-url")
190
199
  async readUrl(
191
200
  @Parameter("assetId", "param") assetId: string,
192
- @Parameter("preset", "query") presetId?: string,
201
+ @Parameter("preset", "query") preset: QueryValue,
193
202
  ) {
203
+ const presetId = queryText(preset);
194
204
  const context = await this.resolveContext();
195
205
  const asset = await requireReadableAsset(context, assetId);
196
206
  let storageKey = asset.storageKey;
@@ -212,7 +222,7 @@ export class MediaAssetsController extends MediaApiController {
212
222
  @Parameter("assetId", "param") assetId: string,
213
223
  @JSONBody() body: unknown,
214
224
  ) {
215
- const changes = parseBody(body, updateAssetSchema);
225
+ const changes = rejectInvalid(() => updateAssetSchema.parse(body));
216
226
  const context = await this.resolveContext();
217
227
  const asset = await requireReadableAsset(context, assetId);
218
228
  await updateAssetDetails(context, asset, changes);
@@ -224,7 +234,7 @@ export class MediaAssetsController extends MediaApiController {
224
234
  @Parameter("assetId", "param") assetId: string,
225
235
  @JSONBody() body: unknown,
226
236
  ) {
227
- const { folderId } = parseBody(body, moveAssetSchema);
237
+ const { folderId } = rejectInvalid(() => moveAssetSchema.parse(body));
228
238
  const context = await this.resolveContext();
229
239
  const asset = await requireReadableAsset(context, assetId);
230
240
  await moveAsset(context, asset, folderId);
@@ -236,7 +246,9 @@ export class MediaAssetsController extends MediaApiController {
236
246
  @Parameter("assetId", "param") assetId: string,
237
247
  @JSONBody() body: unknown,
238
248
  ) {
239
- const { visibility } = parseBody(body, assetVisibilitySchema);
249
+ const { visibility } = rejectInvalid(() =>
250
+ assetVisibilitySchema.parse(body),
251
+ );
240
252
  const context = await this.resolveContext();
241
253
  const asset = await requireReadableAsset(context, assetId);
242
254
  await setAssetVisibility(context, asset, visibility);
@@ -14,7 +14,7 @@ import {
14
14
  bulkMoveSchema,
15
15
  bulkVisibilitySchema,
16
16
  } from "../../validation/library.schema";
17
- import { parseBody } from "../../validation/media.schema";
17
+ import { rejectInvalid } from "../../validation/media.schema";
18
18
  import { moveAsset, removeAsset, setAssetVisibility } from "./asset-actions";
19
19
  import { requireReadableAsset } from "./assets";
20
20
  import { MediaApiController } from "./controller";
@@ -195,7 +195,7 @@ function zipResponse(entries: ZipEntry[], filename: string): HTTPResult {
195
195
  export class MediaBulkController extends MediaApiController {
196
196
  @Post("/assets/bulk/move")
197
197
  async bulkMove(@JSONBody() body: unknown) {
198
- const { ids, folderId } = parseBody(body, bulkMoveSchema);
198
+ const { ids, folderId } = rejectInvalid(() => bulkMoveSchema.parse(body));
199
199
  const context = await this.resolveContext();
200
200
  return applyToEach(context, ids, (ctx, asset) =>
201
201
  moveAsset(ctx, asset, folderId),
@@ -204,7 +204,9 @@ export class MediaBulkController extends MediaApiController {
204
204
 
205
205
  @Post("/assets/bulk/visibility")
206
206
  async bulkVisibility(@JSONBody() body: unknown) {
207
- const { ids, visibility } = parseBody(body, bulkVisibilitySchema);
207
+ const { ids, visibility } = rejectInvalid(() =>
208
+ bulkVisibilitySchema.parse(body),
209
+ );
208
210
  const context = await this.resolveContext();
209
211
  return applyToEach(context, ids, (ctx, asset) =>
210
212
  setAssetVisibility(ctx, asset, visibility),
@@ -213,14 +215,14 @@ export class MediaBulkController extends MediaApiController {
213
215
 
214
216
  @Post("/assets/bulk/delete")
215
217
  async bulkDelete(@JSONBody() body: unknown) {
216
- const { ids } = parseBody(body, bulkIdsSchema);
218
+ const { ids } = rejectInvalid(() => bulkIdsSchema.parse(body));
217
219
  const context = await this.resolveContext();
218
220
  return applyToEach(context, ids, removeAsset);
219
221
  }
220
222
 
221
223
  @Post("/assets/zip")
222
224
  async zip(@JSONBody() body: unknown) {
223
- const { ids } = parseBody(body, bulkIdsSchema);
225
+ const { ids } = rejectInvalid(() => bulkIdsSchema.parse(body));
224
226
  const context = await this.resolveContext();
225
227
  return zipResponse(await loadZipAssets(context, ids), ZIP_FILENAME);
226
228
  }
@@ -11,7 +11,7 @@ import {
11
11
  folderVisibilitySchema,
12
12
  MEDIA_ERRORS,
13
13
  moveFolderSchema,
14
- parseBody,
14
+ rejectInvalid,
15
15
  renameFolderSchema,
16
16
  } from "../../validation/media.schema";
17
17
  import {
@@ -156,7 +156,9 @@ export function isMoveInsideSubtree(
156
156
  export class MediaFoldersController extends MediaApiController {
157
157
  @Post("/folders")
158
158
  async createFolder(@JSONBody() body: unknown) {
159
- const { name, parentId } = parseBody(body, createFolderSchema);
159
+ const { name, parentId } = rejectInvalid(() =>
160
+ createFolderSchema.parse(body),
161
+ );
160
162
  const context = await this.resolveContext();
161
163
  const parent = assertCanPlaceUnder(context, parentId);
162
164
  assertUniqueSiblingName(context, name, parentId);
@@ -180,7 +182,7 @@ export class MediaFoldersController extends MediaApiController {
180
182
  @Parameter("folderId", "param") folderId: string,
181
183
  @JSONBody() body: unknown,
182
184
  ) {
183
- const { name } = parseBody(body, renameFolderSchema);
185
+ const { name } = rejectInvalid(() => renameFolderSchema.parse(body));
184
186
  const context = await this.resolveContext();
185
187
  const folder = requireFolderRight(context, folderId, "manage");
186
188
  assertNotBound(folder);
@@ -205,7 +207,7 @@ export class MediaFoldersController extends MediaApiController {
205
207
  @Parameter("folderId", "param") folderId: string,
206
208
  @JSONBody() body: unknown,
207
209
  ) {
208
- const { parentId } = parseBody(body, moveFolderSchema);
210
+ const { parentId } = rejectInvalid(() => moveFolderSchema.parse(body));
209
211
  const context = await this.resolveContext();
210
212
  const folder = requireFolderRight(context, folderId, "manage");
211
213
  assertNotBound(folder);
@@ -232,7 +234,9 @@ export class MediaFoldersController extends MediaApiController {
232
234
  @Parameter("folderId", "param") folderId: string,
233
235
  @JSONBody() body: unknown,
234
236
  ) {
235
- const { visibility } = parseBody(body, folderVisibilitySchema);
237
+ const { visibility } = rejectInvalid(() =>
238
+ folderVisibilitySchema.parse(body),
239
+ );
236
240
  const context = await this.resolveContext();
237
241
  const folder = requireFolderRight(context, folderId, "manage");
238
242
  assertMediaOwner(context);