@antelopejs/dms-media 0.6.0 → 0.6.2

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 (238) hide show
  1. package/README.md +18 -3
  2. package/dist/acl/entries.js +1 -2
  3. package/dist/acl/entries.js.map +1 -1
  4. package/dist/bindings.js +1 -3
  5. package/dist/bindings.js.map +1 -1
  6. package/dist/db/models/mediaFolders.model.d.ts +0 -3
  7. package/dist/db/models/mediaFolders.model.js +0 -29
  8. package/dist/db/models/mediaFolders.model.js.map +1 -1
  9. package/dist/db/tables/mediaDeclarations.table.d.ts +0 -4
  10. package/dist/db/tables/mediaDeclarations.table.js +0 -16
  11. package/dist/db/tables/mediaDeclarations.table.js.map +1 -1
  12. package/dist/declared/assets.d.ts +0 -2
  13. package/dist/declared/assets.js +12 -140
  14. package/dist/declared/assets.js.map +1 -1
  15. package/dist/declared/folders.d.ts +1 -5
  16. package/dist/declared/folders.js +17 -82
  17. package/dist/declared/folders.js.map +1 -1
  18. package/dist/declared/index.d.ts +0 -2
  19. package/dist/declared/index.js +0 -2
  20. package/dist/declared/index.js.map +1 -1
  21. package/dist/declared/records.d.ts +4 -32
  22. package/dist/declared/records.js +6 -35
  23. package/dist/declared/records.js.map +1 -1
  24. package/dist/derivatives.js +14 -23
  25. package/dist/derivatives.js.map +1 -1
  26. package/dist/guards.d.ts +4 -0
  27. package/dist/guards.js +19 -0
  28. package/dist/guards.js.map +1 -0
  29. package/dist/implementations/interface-dms-media/index.d.ts +1 -3
  30. package/dist/implementations/interface-dms-media/index.js +0 -2
  31. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  32. package/dist/library/activity.js +7 -5
  33. package/dist/library/activity.js.map +1 -1
  34. package/dist/library/batches.js +6 -3
  35. package/dist/library/batches.js.map +1 -1
  36. package/dist/library/events.js +4 -4
  37. package/dist/library/events.js.map +1 -1
  38. package/dist/library/module-readout.js +5 -2
  39. package/dist/library/module-readout.js.map +1 -1
  40. package/dist/library/realtime.js.map +1 -1
  41. package/dist/pages/activity.js +1 -1
  42. package/dist/pages/activity.js.map +1 -1
  43. package/dist/routes/media/assets.d.ts +1 -1
  44. package/dist/routes/media/assets.js +5 -5
  45. package/dist/routes/media/assets.js.map +1 -1
  46. package/dist/routes/media/bulk.js +17 -13
  47. package/dist/routes/media/bulk.js.map +1 -1
  48. package/dist/routes/media/delivery-headers.js +9 -9
  49. package/dist/routes/media/delivery-headers.js.map +1 -1
  50. package/dist/routes/media/delivery-stream.js +7 -21
  51. package/dist/routes/media/delivery-stream.js.map +1 -1
  52. package/dist/routes/media/delivery.js.map +1 -1
  53. package/dist/routes/media/manage.js.map +1 -1
  54. package/dist/routes/media/transform.js +13 -8
  55. package/dist/routes/media/transform.js.map +1 -1
  56. package/dist/routes/media/upload.js +2 -5
  57. package/dist/routes/media/upload.js.map +1 -1
  58. package/dist/test/antelope.test.js +17 -16
  59. package/dist/test/antelope.test.js.map +1 -1
  60. package/dist/test/helpers/folders.d.ts +27 -0
  61. package/dist/test/helpers/folders.js +15 -0
  62. package/dist/test/helpers/folders.js.map +1 -1
  63. package/dist/test/helpers/pages.js +10 -6
  64. package/dist/test/helpers/pages.js.map +1 -1
  65. package/dist/test/helpers/permissions-world.d.ts +98 -0
  66. package/dist/test/helpers/permissions-world.js +205 -0
  67. package/dist/test/helpers/permissions-world.js.map +1 -0
  68. package/dist/test/helpers/prototype.d.ts +1 -0
  69. package/dist/test/helpers/prototype.js +11 -0
  70. package/dist/test/helpers/prototype.js.map +1 -0
  71. package/dist/test/integration/derivative-sweep-query.test.js +13 -16
  72. package/dist/test/integration/derivative-sweep-query.test.js.map +1 -1
  73. package/dist/test/integration/folder-query.test.js +5 -9
  74. package/dist/test/integration/folder-query.test.js.map +1 -1
  75. package/dist/test/integration/media-bindings.test.js +2 -2
  76. package/dist/test/integration/media-bindings.test.js.map +1 -1
  77. package/dist/test/integration/media-cleanup.test.js +14 -17
  78. package/dist/test/integration/media-cleanup.test.js.map +1 -1
  79. package/dist/test/integration/media-declared-content.test.js +19 -318
  80. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  81. package/dist/test/integration/media-delivery-editing.test.js +7 -5
  82. package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
  83. package/dist/test/integration/media-delivery.test.js +19 -5
  84. package/dist/test/integration/media-delivery.test.js.map +1 -1
  85. package/dist/test/integration/media-explorer-writes.test.js +2 -2
  86. package/dist/test/integration/media-explorer-writes.test.js.map +1 -1
  87. package/dist/test/integration/media-guards.test.js +18 -7
  88. package/dist/test/integration/media-guards.test.js.map +1 -1
  89. package/dist/test/integration/media-library.test.js +1 -1
  90. package/dist/test/integration/media-library.test.js.map +1 -1
  91. package/dist/test/integration/media-linked-subfolders.test.js +6 -6
  92. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  93. package/dist/test/integration/media-member-access.test.js +2 -5
  94. package/dist/test/integration/media-member-access.test.js.map +1 -1
  95. package/dist/test/integration/media-permissions.test.js +142 -473
  96. package/dist/test/integration/media-permissions.test.js.map +1 -1
  97. package/dist/test/integration/media-project-field.test.js +3 -5
  98. package/dist/test/integration/media-project-field.test.js.map +1 -1
  99. package/dist/test/integration/media-search-query.test.js +11 -16
  100. package/dist/test/integration/media-search-query.test.js.map +1 -1
  101. package/dist/test/integration/media-storage-origin-unreachable.test.js +80 -0
  102. package/dist/test/integration/media-storage-origin-unreachable.test.js.map +1 -0
  103. package/dist/test/integration/media-upload-policy.test.js +2 -2
  104. package/dist/test/integration/media-upload-policy.test.js.map +1 -1
  105. package/dist/test/integration/permissions-management.d.ts +2 -0
  106. package/dist/test/integration/permissions-management.js +189 -0
  107. package/dist/test/integration/permissions-management.js.map +1 -0
  108. package/dist/test/unit/acl/entries.test.js +2 -1
  109. package/dist/test/unit/acl/entries.test.js.map +1 -1
  110. package/dist/test/unit/acl/resolver.test.js +10 -3
  111. package/dist/test/unit/acl/resolver.test.js.map +1 -1
  112. package/dist/test/unit/declared.test.js +0 -66
  113. package/dist/test/unit/declared.test.js.map +1 -1
  114. package/dist/test/unit/library/fixtures.d.ts +1 -1
  115. package/dist/test/unit/library/fixtures.js +6 -1
  116. package/dist/test/unit/library/fixtures.js.map +1 -1
  117. package/dist/test/unit/library/library.test.js +0 -1
  118. package/dist/test/unit/library/library.test.js.map +1 -1
  119. package/dist/test/unit/library/realtime.test.js +1 -0
  120. package/dist/test/unit/library/realtime.test.js.map +1 -1
  121. package/dist/test/unit/library/search-facets.test.js +2 -2
  122. package/dist/test/unit/library/search-facets.test.js.map +1 -1
  123. package/dist/test/unit/pages/toolbar.test.js +24 -7
  124. package/dist/test/unit/pages/toolbar.test.js.map +1 -1
  125. package/dist/test/unit/routes/dto.test.js +7 -6
  126. package/dist/test/unit/routes/dto.test.js.map +1 -1
  127. package/dist/test/unit/routes/file-page.test.js +5 -7
  128. package/dist/test/unit/routes/file-page.test.js.map +1 -1
  129. package/dist/test/unit/routes/preset-row.test.js +2 -1
  130. package/dist/test/unit/routes/preset-row.test.js.map +1 -1
  131. package/dist/transform.js +6 -6
  132. package/dist/transform.js.map +1 -1
  133. package/dist/upload-checks.d.ts +8 -2
  134. package/dist/upload-checks.js.map +1 -1
  135. package/dist/upload-policy.js +8 -8
  136. package/dist/upload-policy.js.map +1 -1
  137. package/dist/validation/declared.schema.d.ts +7 -36
  138. package/dist/validation/declared.schema.js +15 -20
  139. package/dist/validation/declared.schema.js.map +1 -1
  140. package/dist/validation/media.schema.d.ts +1 -1
  141. package/dist/validation/media.schema.js +2 -2
  142. package/dist/validation/media.schema.js.map +1 -1
  143. package/frontend-vue/app/build/imageEditor/editorShapes.ts +118 -0
  144. package/frontend-vue/app/build/imageEditor/useEditorSaving.ts +86 -0
  145. package/frontend-vue/app/build/library/libraryActions.ts +444 -0
  146. package/frontend-vue/app/build/library/libraryCore.ts +136 -0
  147. package/frontend-vue/app/components/ImageEditor.vue +22 -179
  148. package/frontend-vue/app/composables/library/useMediaLibrary.ts +3 -575
  149. package/frontend-vue/app/composables/useMediaApi.ts +21 -5
  150. package/frontend-vue/build/backend-boundary.ts +122 -0
  151. package/frontend-vue/dms.frontend.build.ts +3 -0
  152. package/frontend-vue/eslint.config.mjs +13 -0
  153. package/frontend-vue/package.json +3 -1
  154. package/frontend-vue/pnpm-lock.yaml +217 -61
  155. package/frontend-vue/tests/backend-boundary.test.ts +203 -0
  156. package/frontend-vue/tests/mediaPreviews.test.ts +39 -0
  157. package/package.json +10 -16
  158. package/skills/dms-media/SKILL.md +12 -24
  159. package/skills/dms-media/cases.json +38 -0
  160. package/src/acl/entries.ts +6 -4
  161. package/src/bindings.ts +3 -3
  162. package/src/db/models/mediaFolders.model.ts +0 -44
  163. package/src/db/tables/mediaDeclarations.table.ts +3 -19
  164. package/src/declared/assets.ts +19 -210
  165. package/src/declared/folders.ts +25 -138
  166. package/src/declared/index.ts +0 -2
  167. package/src/declared/records.ts +17 -90
  168. package/src/derivatives.ts +17 -23
  169. package/src/guards.ts +19 -0
  170. package/src/implementations/interface-dms-media/index.ts +1 -8
  171. package/src/library/activity.ts +17 -9
  172. package/src/library/batches.ts +12 -9
  173. package/src/library/events.ts +7 -4
  174. package/src/library/module-readout.ts +6 -2
  175. package/src/library/realtime.ts +5 -1
  176. package/src/library/zip.ts +1 -1
  177. package/src/pages/activity.ts +6 -2
  178. package/src/routes/media/assets.ts +4 -3
  179. package/src/routes/media/bulk.ts +16 -14
  180. package/src/routes/media/delivery-headers.ts +9 -12
  181. package/src/routes/media/delivery-stream.ts +13 -28
  182. package/src/routes/media/delivery.ts +4 -2
  183. package/src/routes/media/manage.ts +4 -6
  184. package/src/routes/media/transform.ts +27 -23
  185. package/src/routes/media/upload.ts +4 -6
  186. package/src/test/antelope.test.ts +25 -21
  187. package/src/test/helpers/folders.ts +22 -0
  188. package/src/test/helpers/pages.ts +12 -5
  189. package/src/test/helpers/permissions-world.ts +326 -0
  190. package/src/test/helpers/prototype.ts +12 -0
  191. package/src/test/integration/derivative-sweep-query.test.ts +19 -21
  192. package/src/test/integration/folder-query.test.ts +11 -11
  193. package/src/test/integration/media-bindings.test.ts +7 -7
  194. package/src/test/integration/media-cleanup.test.ts +25 -37
  195. package/src/test/integration/media-declared-content.test.ts +35 -379
  196. package/src/test/integration/media-delivery-editing.test.ts +11 -7
  197. package/src/test/integration/media-delivery.test.ts +29 -8
  198. package/src/test/integration/media-explorer-writes.test.ts +2 -7
  199. package/src/test/integration/media-guards.test.ts +21 -7
  200. package/src/test/integration/media-library.test.ts +1 -1
  201. package/src/test/integration/media-linked-subfolders.test.ts +12 -21
  202. package/src/test/integration/media-member-access.test.ts +5 -9
  203. package/src/test/integration/media-permissions.test.ts +56 -570
  204. package/src/test/integration/media-project-field.test.ts +5 -7
  205. package/src/test/integration/media-search-query.test.ts +16 -20
  206. package/src/test/integration/media-storage-origin-unreachable.test.ts +111 -0
  207. package/src/test/integration/media-upload-policy.test.ts +2 -8
  208. package/src/test/integration/permissions-management.ts +292 -0
  209. package/src/test/unit/acl/entries.test.ts +2 -1
  210. package/src/test/unit/acl/resolver.test.ts +19 -7
  211. package/src/test/unit/declared.test.ts +0 -87
  212. package/src/test/unit/library/fixtures.ts +9 -3
  213. package/src/test/unit/library/library.test.ts +1 -7
  214. package/src/test/unit/library/realtime.test.ts +2 -0
  215. package/src/test/unit/library/search-facets.test.ts +2 -2
  216. package/src/test/unit/pages/toolbar.test.ts +42 -17
  217. package/src/test/unit/routes/dto.test.ts +7 -6
  218. package/src/test/unit/routes/file-page.test.ts +10 -9
  219. package/src/test/unit/routes/preset-row.test.ts +2 -2
  220. package/src/transform.ts +6 -6
  221. package/src/upload-checks.ts +12 -3
  222. package/src/upload-policy.ts +8 -8
  223. package/src/validation/declared.schema.ts +17 -25
  224. package/src/validation/media.schema.ts +6 -6
  225. package/dist/declared/readiness.d.ts +0 -2
  226. package/dist/declared/readiness.js +0 -52
  227. package/dist/declared/readiness.js.map +0 -1
  228. package/dist/declared/retire.d.ts +0 -3
  229. package/dist/declared/retire.js +0 -118
  230. package/dist/declared/retire.js.map +0 -1
  231. package/dist/test/integration/media-declared-retire.test.js +0 -186
  232. package/dist/test/integration/media-declared-retire.test.js.map +0 -1
  233. package/frontend-vue/tests/engines.test.ts +0 -20
  234. package/frontend-vue/tests/locales.test.ts +0 -61
  235. package/src/declared/readiness.ts +0 -64
  236. package/src/declared/retire.ts +0 -206
  237. package/src/test/integration/media-declared-retire.test.ts +0 -257
  238. /package/dist/test/integration/{media-declared-retire.test.d.ts → media-storage-origin-unreachable.test.d.ts} +0 -0
@@ -5,10 +5,9 @@ import type {
5
5
  MediaAssetDeclaration,
6
6
  MediaDeclarationResult,
7
7
  } from "@antelopejs/interface-dms-media";
8
- import { cleanupAssetFiles, updateAssetMedia } from "../asset-lifecycle";
9
8
  import { feedingBinding } from "../bindings";
10
9
  import { getMediaConfig } from "../config";
11
- import type { MediaAsset, MediaDeclaration, MediaFolder } from "../db";
10
+ import type { MediaAsset, MediaFolder } from "../db";
12
11
  import { uploadStorageBytes } from "../derivatives";
13
12
  import { recordMediaEvent } from "../library/events";
14
13
  import {
@@ -27,18 +26,13 @@ import {
27
26
  describeDeclarationIssues,
28
27
  } from "../validation/declared.schema";
29
28
  import { findBoundFolder, findDeclaredFolder } from "./folders";
30
- import { waitForTenant, writeWhenReachable } from "./readiness";
31
29
  import {
32
30
  DECLARED_CONTENT_AUTHOR,
33
31
  type DeclaredModels,
34
32
  declaredModels,
35
- hashBytes,
36
- hashState,
37
- judgeDeclaredRow,
38
- judgeMemberChange,
39
33
  MediaDeclarationError,
40
34
  parseDeclaration,
41
- saveDeclaration,
35
+ rememberDeclaration,
42
36
  withDeclarationLock,
43
37
  } from "./records";
44
38
 
@@ -57,38 +51,8 @@ interface PreparedFile {
57
51
  image: ImageProbe;
58
52
  }
59
53
 
60
- interface AssetHashes {
61
- declaredHash: string;
62
- contentHash: string;
63
- }
64
-
65
54
  type Fail = (reason: string) => never;
66
55
 
67
- /** The member-editable state of a file: its name, folder, alt text, visibility and content. */
68
- export function assetStateHash(asset: MediaAsset): string {
69
- return hashState({
70
- name: asset.name,
71
- folderId: asset.folderId,
72
- alt: asset.alt || null,
73
- visibility: asset.visibility,
74
- storageKey: asset.storageKey,
75
- });
76
- }
77
-
78
- function assetHashes(
79
- declaration: DeclaredAssetInput,
80
- contentHash: string,
81
- ): AssetHashes {
82
- const declaredHash = hashState({
83
- name: declaration.name,
84
- folder: declaration.folder,
85
- alt: declaration.alt ?? null,
86
- mimetype: declaration.mimetype,
87
- content: contentHash,
88
- });
89
- return { declaredHash, contentHash };
90
- }
91
-
92
56
  function describeError(error: unknown): string {
93
57
  return error instanceof Error ? error.message : String(error);
94
58
  }
@@ -124,33 +88,6 @@ async function readSource(
124
88
  return bytes;
125
89
  }
126
90
 
127
- /**
128
- * A declared file's bytes, read at most once and only when a decision needs
129
- * them: generating or reading content every boot is what `version` and lazy
130
- * sources let callers avoid.
131
- */
132
- class DeclaredContent {
133
- private bytes?: Promise<Buffer>;
134
-
135
- constructor(
136
- private readonly declaration: DeclaredAssetInput,
137
- private readonly fail: Fail,
138
- ) {}
139
-
140
- read(): Promise<Buffer> {
141
- this.bytes ??= readSource(this.declaration, this.fail);
142
- return this.bytes;
143
- }
144
-
145
- /** The bytes' hash, taken from the last declaration while the caller's version still matches it. */
146
- async hash(record: MediaDeclaration | undefined): Promise<string> {
147
- const { version } = this.declaration;
148
- if (version && record?.contentHash && record.version === version)
149
- return record.contentHash;
150
- return hashBytes(await this.read());
151
- }
152
- }
153
-
154
91
  /** The binding whose field the folder feeds, through its linked ancestors when it has no binding itself. */
155
92
  async function fieldBindingOf(
156
93
  models: DeclaredModels,
@@ -172,23 +109,19 @@ async function findTargetFolder(
172
109
  models: DeclaredModels,
173
110
  declaration: DeclaredAssetInput,
174
111
  fail: Fail,
175
- ): Promise<MediaFolder | undefined> {
112
+ ): Promise<MediaFolder> {
176
113
  const target = declaration.folder;
177
114
  if ("binding" in target) return findBoundFolder(models, target.binding, fail);
178
- return (await findDeclaredFolder(models, target.key, fail)).folder;
115
+ return findDeclaredFolder(models, target.key, fail);
179
116
  }
180
117
 
181
118
  /** The checks of the upload routes: type, field type, quota and image decoding. */
182
119
  async function prepareFile(
183
120
  { models, declaration, fieldBinding }: AssetTarget,
184
121
  bytes: Buffer,
185
- replacedSize: number,
186
122
  ): Promise<PreparedFile> {
187
123
  assertUploadTypeAllowed(fieldBinding, declaration.name, declaration.mimetype);
188
- await assertWithinQuota(
189
- models.assetModel,
190
- Math.max(bytes.byteLength - replacedSize, 0),
191
- );
124
+ await assertWithinQuota(models.assetModel, bytes.byteLength);
192
125
  const image = await probeImageBytes(
193
126
  async () => bytes,
194
127
  declaration.mimetype,
@@ -206,14 +139,12 @@ function writeFile(
206
139
  { models, declaration, folder }: AssetTarget,
207
140
  file: PreparedFile,
208
141
  ): Promise<string> {
209
- return writeWhenReachable(() =>
210
- uploadStorageBytes(
211
- file.bytes,
212
- declaration.name,
213
- file.mimetype,
214
- `media/${models.tenantId}/${folder._id}`,
215
- getMediaConfig().storage,
216
- ),
142
+ return uploadStorageBytes(
143
+ file.bytes,
144
+ declaration.name,
145
+ file.mimetype,
146
+ `media/${models.tenantId}/${folder._id}`,
147
+ getMediaConfig().storage,
217
148
  );
218
149
  }
219
150
 
@@ -274,151 +205,29 @@ async function createAsset(
274
205
  return asset;
275
206
  }
276
207
 
277
- /** Publishes metadata and optional new bytes together, only while the file is untouched. */
278
- async function refreshAsset(
279
- target: AssetTarget,
280
- asset: MediaAsset,
281
- content: DeclaredContent,
282
- isContentChanged: boolean,
283
- ): Promise<MediaAsset | undefined> {
284
- const { models, declaration, folder, fieldBinding } = target;
285
- const { assetModel } = models;
286
- const patch: Partial<MediaAsset> = {
287
- name: declaration.name,
288
- folderId: folder._id,
289
- alt: declaration.alt ?? "",
290
- };
291
- let storageKey: string | undefined;
292
- if (isContentChanged) {
293
- const file = await prepareFile(target, await content.read(), asset.size);
294
- storageKey = await writeFile(target, file);
295
- Object.assign(patch, {
296
- storageKey,
297
- mimetype: file.mimetype,
298
- size: file.bytes.byteLength,
299
- width: file.image.width,
300
- height: file.image.height,
301
- json_derivatives: "",
302
- });
303
- } else {
304
- assertUploadTypeAllowed(fieldBinding, declaration.name, asset.mimetype);
305
- }
306
- for (;;) {
307
- const fresh = await assetModel.get(asset._id);
308
- const isStillAsDeclared =
309
- fresh !== undefined &&
310
- !fresh.isDeleting &&
311
- assetStateHash(fresh) === assetStateHash(asset);
312
- if (!isStillAsDeclared) {
313
- if (storageKey)
314
- await DeleteFile(storageKey, getMediaConfig().storage).catch(
315
- () => undefined,
316
- );
317
- return undefined;
318
- }
319
- if (
320
- await updateAssetMedia(assetModel, fresh, patch, {
321
- preserveDetails: true,
322
- })
323
- )
324
- break;
325
- }
326
- if (storageKey) await cleanupAssetFiles(assetModel, asset._id);
327
- // A concurrent edit after publication must not become our new baseline.
328
- return Object.assign(asset, patch);
329
- }
330
-
331
- function rememberAsset(
332
- target: AssetTarget,
333
- record: MediaDeclaration | undefined,
334
- asset: MediaAsset,
335
- hashes: AssetHashes,
336
- ): Promise<void> {
337
- return saveDeclaration(target.models.declarationModel, record, {
338
- kind: "asset",
339
- key: target.declaration.key,
340
- targetId: asset._id,
341
- appliedHash: assetStateHash(asset),
342
- version: target.declaration.version ?? "",
343
- ...hashes,
344
- });
345
- }
346
-
347
- /** Remembers a new caller version of unchanged bytes, so the next boot does not read them again. */
348
- async function rememberVersion(
349
- models: DeclaredModels,
350
- record: MediaDeclaration,
351
- version: string | undefined,
352
- ): Promise<void> {
353
- if (!version || record.version === version) return;
354
- await models.declarationModel.update(record._id, { version });
355
- }
356
-
357
208
  async function applyAssetDeclaration(
358
209
  declaration: DeclaredAssetInput,
359
210
  ): Promise<MediaDeclarationResult> {
360
- const fail: Fail = (reason) => {
361
- throw new MediaDeclarationError("asset", declaration.key, reason);
362
- };
363
- const content = new DeclaredContent(declaration, fail);
364
- await waitForTenant(declaration.tenantId);
365
211
  const models = declaredModels(declaration.tenantId);
366
212
  const record = await models.declarationModel.findByKey(
367
213
  "asset",
368
214
  declaration.key,
369
215
  );
370
- const stored = record && (await models.assetModel.get(record.targetId));
371
- const asset = stored && !stored.isDeleting ? stored : undefined;
372
- // Deleted or changed by a member: the new content cannot matter, so it is not read.
373
- const change =
374
- record && judgeMemberChange(record, asset, asset && assetStateHash(asset));
375
- if (change) return change;
376
- const hashes = assetHashes(declaration, await content.hash(record));
377
- const verdict =
378
- record &&
379
- judgeDeclaredRow(
380
- record,
381
- asset,
382
- asset && assetStateHash(asset),
383
- hashes.declaredHash,
384
- );
385
- if (verdict) {
386
- if (record) await rememberVersion(models, record, declaration.version);
387
- return verdict;
388
- }
216
+ if (record) return { status: "kept", id: record.targetId };
217
+ const fail: Fail = (reason) => {
218
+ throw new MediaDeclarationError("asset", declaration.key, reason);
219
+ };
389
220
  const folder = await findTargetFolder(models, declaration, fail);
390
- // A file whose declared folder a member deleted went with it, or never came.
391
- if (!folder)
392
- return asset
393
- ? { status: "preserved", id: asset._id }
394
- : { status: "deleted" };
395
221
  const target: AssetTarget = {
396
222
  models,
397
223
  declaration,
398
224
  folder,
399
225
  fieldBinding: await fieldBindingOf(models, folder),
400
226
  };
401
- if (!record || !asset) {
402
- const file = await prepareFile(target, await content.read(), 0);
403
- const created = await createAsset(target, file);
404
- await rememberAsset(target, record, created, hashes);
405
- return { status: "created", id: created._id };
406
- }
407
- const isContentChanged = record.contentHash !== hashes.contentHash;
408
- const refreshed = await refreshAsset(
409
- target,
410
- asset,
411
- content,
412
- isContentChanged,
413
- );
414
- if (!refreshed) {
415
- const current = await models.assetModel.get(asset._id);
416
- return current && !current.isDeleting
417
- ? { status: "preserved", id: asset._id }
418
- : { status: "deleted" };
419
- }
420
- await rememberAsset(target, record, refreshed, hashes);
421
- return { status: "updated", id: refreshed._id };
227
+ const file = await prepareFile(target, await readSource(declaration, fail));
228
+ const asset = await createAsset(target, file);
229
+ await rememberDeclaration(models, "asset", declaration.key, asset._id);
230
+ return { status: "created", id: asset._id };
422
231
  }
423
232
 
424
233
  /** Implements `ImportMediaAsset`. */
@@ -4,82 +4,51 @@ import type {
4
4
  } from "@antelopejs/interface-dms-media";
5
5
  import { serializeAcl } from "../acl";
6
6
  import { bindingHoldsSubfolders, ensureTenantBindings } from "../bindings";
7
- import type { MediaDeclaration, MediaFolder } from "../db";
7
+ import type { MediaFolder } from "../db";
8
8
  import { recordMediaEvent } from "../library/events";
9
- import {
10
- buildChildPath,
11
- hasSiblingNamed,
12
- isMoveInsideSubtree,
13
- rewriteDescendantPaths,
14
- } from "../routes/media/folders";
9
+ import { buildChildPath, hasSiblingNamed } from "../routes/media/folders";
15
10
  import {
16
11
  declaredFolderSchema,
17
12
  type DeclaredFolderInput,
18
13
  } from "../validation/declared.schema";
19
- import { waitForTenant } from "./readiness";
20
14
  import {
21
15
  DECLARED_CONTENT_AUTHOR,
22
16
  type DeclaredModels,
23
17
  declaredModels,
24
- hashState,
25
- judgeDeclaredRow,
26
18
  MediaDeclarationError,
27
19
  parseDeclaration,
28
- saveDeclaration,
20
+ rememberDeclaration,
29
21
  settlePendingDeclaration,
30
22
  withDeclarationLock,
31
23
  } from "./records";
32
-
33
- /** A declared folder looked up by key: absent when a member deleted it. */
34
- export interface DeclaredFolderLookup {
35
- folder?: MediaFolder;
36
- }
37
-
38
- /** The member-editable state of a folder: its name, place, visibility and ACL. */
39
- export function folderStateHash(folder: MediaFolder): string {
40
- return hashState({
41
- name: folder.name,
42
- parentId: folder.parentId || null,
43
- visibility: folder.visibility,
44
- acl: folder.json_acl || null,
45
- });
46
- }
24
+ import { isString } from "../guards";
47
25
 
48
26
  type ParentTarget = NonNullable<DeclaredFolderInput["parent"]>;
49
27
 
50
28
  /** The declared folder key a parent names, written as a string or as `{ key }`. */
51
29
  function parentKeyOf(parent: ParentTarget | undefined): string | undefined {
52
- if (typeof parent === "string") return parent;
30
+ if (isString(parent)) return parent;
53
31
  return parent && "key" in parent ? parent.key : undefined;
54
32
  }
55
33
 
56
- function folderDeclarationHash(declaration: DeclaredFolderInput): string {
57
- const { parent } = declaration;
58
- return hashState({
59
- name: declaration.name,
60
- // Both spellings of a declared parent hash alike: switching between them changes nothing.
61
- parent: parentKeyOf(parent) ?? parent ?? null,
62
- visibility: declaration.visibility,
63
- acl: declaration.acl ?? null,
64
- });
65
- }
66
-
67
34
  /**
68
- * The folder declared under `key`. Throws when no module ever declared it,
69
- * since that is a mistake in the calling code rather than a member's change.
35
+ * The folder declared under `key`. Throws when no module declared it, since
36
+ * that is a mistake in the calling code, or when it was deleted since.
70
37
  */
71
38
  export async function findDeclaredFolder(
72
39
  models: DeclaredModels,
73
40
  key: string,
74
- onUnknown: (reason: string) => never,
75
- ): Promise<DeclaredFolderLookup> {
41
+ fail: (reason: string) => never,
42
+ ): Promise<MediaFolder> {
76
43
  await settlePendingDeclaration(models.tenantId, "folder", key);
77
44
  const record = await models.declarationModel.findByKey("folder", key);
78
45
  if (!record)
79
- onUnknown(
46
+ fail(
80
47
  `'${key}' is not a declared folder: declare it with EnsureMediaFolder first`,
81
48
  );
82
- return { folder: await models.folderModel.get(record.targetId) };
49
+ const folder = await models.folderModel.get(record.targetId);
50
+ if (!folder) fail(`the folder declared as '${key}' was deleted`);
51
+ return folder;
83
52
  }
84
53
 
85
54
  /** The folder bound to an asset field, provisioned like the dashboard does. */
@@ -101,9 +70,8 @@ async function findParentFolder(
101
70
  models: DeclaredModels,
102
71
  parent: ParentTarget,
103
72
  fail: (reason: string) => never,
104
- ): Promise<DeclaredFolderLookup> {
105
- if (typeof parent === "string")
106
- return findDeclaredFolder(models, parent, fail);
73
+ ): Promise<MediaFolder> {
74
+ if (isString(parent)) return findDeclaredFolder(models, parent, fail);
107
75
  if ("key" in parent) return findDeclaredFolder(models, parent.key, fail);
108
76
  const { binding } = parent;
109
77
  const folder = await findBoundFolder(models, binding, fail);
@@ -111,7 +79,7 @@ async function findParentFolder(
111
79
  fail(
112
80
  `the folder linked to '${binding}' cannot hold subfolders: register its binding with subfolders: true`,
113
81
  );
114
- return { folder };
82
+ return folder;
115
83
  }
116
84
 
117
85
  async function createFolder(
@@ -152,105 +120,24 @@ async function createFolder(
152
120
  return folder;
153
121
  }
154
122
 
155
- async function refreshFolder(
156
- models: DeclaredModels,
157
- declaration: DeclaredFolderInput,
158
- folder: MediaFolder,
159
- parent: MediaFolder | undefined,
160
- ): Promise<MediaFolder | undefined> {
161
- if (isMoveInsideSubtree(folder, parent))
162
- throw new MediaDeclarationError(
163
- "folder",
164
- declaration.key,
165
- "Cannot move a folder inside itself",
166
- );
167
- const folders = await models.folderModel.getAll();
168
- if (hasSiblingNamed(folders, declaration.name, parent?._id, folder._id))
169
- throw new MediaDeclarationError(
170
- "folder",
171
- declaration.key,
172
- `a folder named '${declaration.name}' already exists there`,
173
- );
174
- // An empty ACL string reads as no ACL: the folder inherits its parent's.
175
- const patch: Partial<MediaFolder> = {
176
- name: declaration.name,
177
- parentId: parent?._id,
178
- path: buildChildPath(parent),
179
- visibility: declaration.visibility,
180
- json_acl: serializeAcl(declaration.acl) ?? "",
181
- };
182
- if (!(await models.folderModel.compareDeclared(folder, patch)))
183
- return undefined;
184
- if ((folder.parentId || undefined) !== parent?._id) {
185
- await rewriteDescendantPaths(
186
- { folderModel: models.folderModel, folders },
187
- folder,
188
- patch.path ?? [],
189
- );
190
- }
191
- // Remember only our write, not a member's edit made just after it.
192
- return Object.assign(folder, patch);
193
- }
194
-
195
123
  async function applyFolderDeclaration(
196
124
  declaration: DeclaredFolderInput,
197
125
  ): Promise<MediaDeclarationResult> {
198
- await waitForTenant(declaration.tenantId);
199
126
  const models = declaredModels(declaration.tenantId);
127
+ const record = await models.declarationModel.findByKey(
128
+ "folder",
129
+ declaration.key,
130
+ );
131
+ if (record) return { status: "kept", id: record.targetId };
200
132
  const fail = (reason: string): never => {
201
133
  throw new MediaDeclarationError("folder", declaration.key, reason);
202
134
  };
203
- const parentLookup = declaration.parent
135
+ const parent = declaration.parent
204
136
  ? await findParentFolder(models, declaration.parent, fail)
205
137
  : undefined;
206
- const parent = parentLookup?.folder;
207
- const isParentDeleted = Boolean(parentLookup) && !parent;
208
- const record = await models.declarationModel.findByKey(
209
- "folder",
210
- declaration.key,
211
- );
212
- const declaredHash = folderDeclarationHash(declaration);
213
- if (!record) {
214
- // The parent a member deleted takes its declared children with it.
215
- if (isParentDeleted) return { status: "deleted" };
216
- const folder = await createFolder(models, declaration, parent);
217
- await rememberFolder(models, undefined, declaration, folder, declaredHash);
218
- return { status: "created", id: folder._id };
219
- }
220
- const folder = await models.folderModel.get(record.targetId);
221
- const verdict = judgeDeclaredRow(
222
- record,
223
- folder,
224
- folder && folderStateHash(folder),
225
- declaredHash,
226
- );
227
- if (verdict || !folder) return verdict ?? { status: "deleted" };
228
- if (isParentDeleted) return { status: "preserved", id: folder._id };
229
- const refreshed = await refreshFolder(models, declaration, folder, parent);
230
- if (!refreshed) {
231
- const current = await models.folderModel.get(folder._id);
232
- return current
233
- ? { status: "preserved", id: folder._id }
234
- : { status: "deleted" };
235
- }
236
- await rememberFolder(models, record, declaration, refreshed, declaredHash);
237
- return { status: "updated", id: refreshed._id };
238
- }
239
-
240
- function rememberFolder(
241
- models: DeclaredModels,
242
- record: MediaDeclaration | undefined,
243
- declaration: DeclaredFolderInput,
244
- folder: MediaFolder,
245
- declaredHash: string,
246
- ): Promise<void> {
247
- return saveDeclaration(models.declarationModel, record, {
248
- kind: "folder",
249
- key: declaration.key,
250
- targetId: folder._id,
251
- declaredHash,
252
- appliedHash: folderStateHash(folder),
253
- });
138
+ const folder = await createFolder(models, declaration, parent);
139
+ await rememberDeclaration(models, "folder", declaration.key, folder._id);
140
+ return { status: "created", id: folder._id };
254
141
  }
255
142
 
256
143
  /** Implements `EnsureMediaFolder`. */
@@ -1,5 +1,3 @@
1
1
  export * from "./assets";
2
2
  export * from "./folders";
3
- export * from "./readiness";
4
3
  export * from "./records";
5
- export * from "./retire";
@@ -1,10 +1,8 @@
1
- import { createHash } from "node:crypto";
2
1
  import { GetModel } from "@antelopejs/interface-database-decorators";
3
- import type { MediaDeclarationResult } from "@antelopejs/interface-dms-media";
4
- import type { ZodError, ZodType } from "zod";
2
+ import type { ZodType, ZodTypeDef } from "zod";
3
+ import { isObjectLike, isString } from "../guards";
5
4
  import {
6
5
  MediaAssetModel,
7
- type MediaDeclaration,
8
6
  type MediaDeclarationKind,
9
7
  MediaDeclarationModel,
10
8
  MediaFolderModel,
@@ -47,30 +45,19 @@ export function declaredModels(tenantId: string): DeclaredModels {
47
45
  };
48
46
  }
49
47
 
50
- /** Values a declaration compares, built with a fixed key order so equal values hash equally. */
51
- export type HashedState = Record<string, unknown>;
52
-
53
- export function hashState(state: HashedState): string {
54
- return createHash("sha256").update(JSON.stringify(state)).digest("hex");
55
- }
56
-
57
- export function hashBytes(bytes: Uint8Array): string {
58
- return createHash("sha256").update(bytes).digest("hex");
59
- }
60
-
61
48
  /** Validates a declaration, naming every refused field. */
62
- export function parseDeclaration<Schema extends ZodType>(
49
+ export function parseDeclaration<Output>(
63
50
  kind: MediaDeclarationKind,
64
51
  input: unknown,
65
- schema: Schema,
66
- ): ReturnType<Schema["parse"]> {
52
+ schema: ZodType<Output, ZodTypeDef, unknown>,
53
+ ): Output {
67
54
  const parsed = schema.safeParse(input);
68
- if (parsed.success) return parsed.data as ReturnType<Schema["parse"]>;
69
- const key = (input as { key?: unknown } | undefined)?.key;
55
+ if (parsed.success) return parsed.data;
56
+ const key = isObjectLike(input) && "key" in input ? input.key : undefined;
70
57
  throw new MediaDeclarationError(
71
58
  kind,
72
- typeof key === "string" ? key : "?",
73
- describeDeclarationIssues(parsed.error as ZodError),
59
+ isString(key) ? key : "?",
60
+ describeDeclarationIssues(parsed.error),
74
61
  );
75
62
  }
76
63
 
@@ -86,7 +73,7 @@ function lockKey(
86
73
 
87
74
  /**
88
75
  * Runs the declarations of one key one after another, so a key declared twice
89
- * at once (a boot racing a hot reload) still creates a single row.
76
+ * at once (a retried provisioning racing the first) still creates a single row.
90
77
  */
91
78
  export function withDeclarationLock<T>(
92
79
  tenantId: string,
@@ -114,72 +101,12 @@ export async function settlePendingDeclaration(
114
101
  await pendingDeclarations.get(lockKey(tenantId, kind, key));
115
102
  }
116
103
 
117
- export interface AppliedDeclaration {
118
- kind: MediaDeclarationKind;
119
- key: string;
120
- targetId: string;
121
- declaredHash: string;
122
- appliedHash: string;
123
- contentHash?: string;
124
- version?: string;
125
- }
126
-
127
- /** Remembers what was declared and the state it left the row in. */
128
- export async function saveDeclaration(
129
- model: MediaDeclarationModel,
130
- existing: MediaDeclaration | undefined,
131
- applied: AppliedDeclaration,
104
+ /** Remembers the folder or file a declaration created, under its kind and key. */
105
+ export async function rememberDeclaration(
106
+ models: DeclaredModels,
107
+ kind: MediaDeclarationKind,
108
+ key: string,
109
+ targetId: string,
132
110
  ): Promise<void> {
133
- if (existing) {
134
- await model.update(existing._id, applied);
135
- return;
136
- }
137
- await model.insert(applied);
138
- }
139
-
140
- interface DeletedByMember {
141
- status: "deleted";
142
- }
143
-
144
- interface ChangedByMember {
145
- status: "preserved";
146
- id: string;
147
- }
148
-
149
- /** What a member did to declared content: deleted it, or changed it and so keeps it. */
150
- export type MemberChange = DeletedByMember | ChangedByMember;
151
-
152
- /**
153
- * The part of the rule that needs no new declaration: a row deleted since it
154
- * was declared stays deleted, and a row whose editable state no longer hashes
155
- * to what the last declaration left was changed by a member and stays as they
156
- * made it. Returns undefined when the row is still as declared.
157
- */
158
- export function judgeMemberChange(
159
- record: MediaDeclaration,
160
- row: { _id: string } | undefined,
161
- stateHash: string | undefined,
162
- ): MemberChange | undefined {
163
- if (!row) return { status: "deleted" };
164
- if (stateHash !== record.appliedHash)
165
- return { status: "preserved", id: row._id };
166
- return undefined;
167
- }
168
-
169
- /**
170
- * The rule shared by folders and files: `judgeMemberChange`, then a
171
- * declaration equal to the last one leaves the row unchanged. Returns
172
- * undefined when the row may be refreshed.
173
- */
174
- export function judgeDeclaredRow(
175
- record: MediaDeclaration,
176
- row: { _id: string } | undefined,
177
- stateHash: string | undefined,
178
- declaredHash: string,
179
- ): MediaDeclarationResult | undefined {
180
- const change = judgeMemberChange(record, row, stateHash);
181
- if (change || !row) return change;
182
- if (record.declaredHash === declaredHash)
183
- return { status: "unchanged", id: row._id };
184
- return undefined;
111
+ await models.declarationModel.insert({ kind, key, targetId });
185
112
  }